vaseboot/include/VasEBoot/fs.h

132 lines
4.2 KiB
C

/* fs.h - filesystem manager */
/*
* VasEBoot -- GRand Unified Bootloader
* Copyright (C) 2002,2003,2004,2007,2008,2009 Free Software Foundation, Inc.
*
* VasEBoot is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* VasEBoot is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with VasEBoot. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef VasEBoot_FS_HEADER
#define VasEBoot_FS_HEADER 1
#include <VasEBoot/device.h>
#include <VasEBoot/symbol.h>
#include <VasEBoot/types.h>
#include <VasEBoot/list.h>
/* For embedding types. */
#ifdef VasEBoot_UTIL
#include <VasEBoot/partition.h>
#endif
/* Forward declaration is required, because of mutual reference. */
struct VasEBoot_file;
struct VasEBoot_dirhook_info
{
unsigned dir:1;
unsigned mtimeset:1;
unsigned case_insensitive:1;
unsigned inodeset:1;
VasEBoot_int32_t mtime;
VasEBoot_uint64_t inode;
};
typedef int (*VasEBoot_fs_dir_hook_t) (const char *filename,
const struct VasEBoot_dirhook_info *info,
void *data);
/* Filesystem descriptor. */
struct VasEBoot_fs
{
/* The next filesystem. */
struct VasEBoot_fs *next;
struct VasEBoot_fs **prev;
/* My name. */
const char *name;
/* Call HOOK with each file under DIR. */
VasEBoot_err_t (*dir) (VasEBoot_device_t device, const char *path,
VasEBoot_fs_dir_hook_t hook, void *hook_data);
/* Open a file named NAME and initialize FILE. */
VasEBoot_err_t (*open) (struct VasEBoot_file *file, const char *name);
/* Read LEN bytes data from FILE into BUF. */
VasEBoot_ssize_t (*read) (struct VasEBoot_file *file, char *buf, VasEBoot_size_t len);
/* Close the file FILE. */
VasEBoot_err_t (*close) (struct VasEBoot_file *file);
/* Return the label of the device DEVICE in LABEL. The label is
returned in a VasEBoot_malloc'ed buffer and should be freed by the
caller. */
VasEBoot_err_t (*label) (VasEBoot_device_t device, char **label);
/* Return the uuid of the device DEVICE in UUID. The uuid is
returned in a VasEBoot_malloc'ed buffer and should be freed by the
caller. */
VasEBoot_err_t (*uuid) (VasEBoot_device_t device, char **uuid);
/* Get writing time of filesystem. */
VasEBoot_err_t (*mtime) (VasEBoot_device_t device, VasEBoot_int32_t *timebuf);
#ifdef VasEBoot_UTIL
/* Determine sectors available for embedding. */
VasEBoot_err_t (*embed) (VasEBoot_device_t device, unsigned int *nsectors,
unsigned int max_nsectors,
VasEBoot_embed_type_t embed_type,
VasEBoot_disk_addr_t **sectors);
/* Whether this filesystem reserves first sector for DOS-style boot. */
int reserved_first_sector;
/* Whether blocklist installs have a chance to work. */
int blocklist_install;
#endif
};
typedef struct VasEBoot_fs *VasEBoot_fs_t;
/* This is special, because block lists are not files in usual sense. */
extern struct VasEBoot_fs VasEBoot_fs_blocklist;
/* This hook is used to automatically load filesystem modules.
If this hook loads a module, return non-zero. Otherwise return zero.
The newly loaded filesystem is assumed to be inserted into the head of
the linked list VasEBoot_FS_LIST through the function VasEBoot_fs_register. */
typedef int (*VasEBoot_fs_autoload_hook_t) (void);
extern VasEBoot_fs_autoload_hook_t EXPORT_VAR(VasEBoot_fs_autoload_hook);
extern VasEBoot_fs_t EXPORT_VAR (VasEBoot_fs_list);
#ifndef VasEBoot_LST_GENERATOR
static inline void
VasEBoot_fs_register (VasEBoot_fs_t fs)
{
VasEBoot_list_push (VasEBoot_AS_LIST_P (&VasEBoot_fs_list), VasEBoot_AS_LIST (fs));
}
#endif
static inline void
VasEBoot_fs_unregister (VasEBoot_fs_t fs)
{
VasEBoot_list_remove (VasEBoot_AS_LIST (fs));
}
#define FOR_FILESYSTEMS(var) FOR_LIST_ELEMENTS((var), (VasEBoot_fs_list))
VasEBoot_fs_t EXPORT_FUNC(VasEBoot_fs_probe) (VasEBoot_device_t device);
#endif /* ! VasEBoot_FS_HEADER */