summaryrefslogtreecommitdiffstats
path: root/include/grub/fs.h
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--include/grub/fs.h131
1 files changed, 131 insertions, 0 deletions
diff --git a/include/grub/fs.h b/include/grub/fs.h
new file mode 100644
index 0000000..026bc3b
--- /dev/null
+++ b/include/grub/fs.h
@@ -0,0 +1,131 @@
+/* fs.h - filesystem manager */
+/*
+ * GRUB -- GRand Unified Bootloader
+ * Copyright (C) 2002,2003,2004,2007,2008,2009 Free Software Foundation, Inc.
+ *
+ * GRUB 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.
+ *
+ * GRUB 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 GRUB. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef GRUB_FS_HEADER
+#define GRUB_FS_HEADER 1
+
+#include <grub/device.h>
+#include <grub/symbol.h>
+#include <grub/types.h>
+
+#include <grub/list.h>
+/* For embedding types. */
+#ifdef GRUB_UTIL
+#include <grub/partition.h>
+#endif
+
+/* Forward declaration is required, because of mutual reference. */
+struct grub_file;
+
+struct grub_dirhook_info
+{
+ unsigned dir:1;
+ unsigned mtimeset:1;
+ unsigned case_insensitive:1;
+ unsigned inodeset:1;
+ grub_int64_t mtime;
+ grub_uint64_t inode;
+};
+
+typedef int (*grub_fs_dir_hook_t) (const char *filename,
+ const struct grub_dirhook_info *info,
+ void *data);
+
+/* Filesystem descriptor. */
+struct grub_fs
+{
+ /* The next filesystem. */
+ struct grub_fs *next;
+ struct grub_fs **prev;
+
+ /* My name. */
+ const char *name;
+
+ /* Call HOOK with each file under DIR. */
+ grub_err_t (*fs_dir) (grub_device_t device, const char *path,
+ grub_fs_dir_hook_t hook, void *hook_data);
+
+ /* Open a file named NAME and initialize FILE. */
+ grub_err_t (*fs_open) (struct grub_file *file, const char *name);
+
+ /* Read LEN bytes data from FILE into BUF. */
+ grub_ssize_t (*fs_read) (struct grub_file *file, char *buf, grub_size_t len);
+
+ /* Close the file FILE. */
+ grub_err_t (*fs_close) (struct grub_file *file);
+
+ /* Return the label of the device DEVICE in LABEL. The label is
+ returned in a grub_malloc'ed buffer and should be freed by the
+ caller. */
+ grub_err_t (*fs_label) (grub_device_t device, char **label);
+
+ /* Return the uuid of the device DEVICE in UUID. The uuid is
+ returned in a grub_malloc'ed buffer and should be freed by the
+ caller. */
+ grub_err_t (*fs_uuid) (grub_device_t device, char **uuid);
+
+ /* Get writing time of filesystem. */
+ grub_err_t (*fs_mtime) (grub_device_t device, grub_int64_t *timebuf);
+
+#ifdef GRUB_UTIL
+ /* Determine sectors available for embedding. */
+ grub_err_t (*fs_embed) (grub_device_t device, unsigned int *nsectors,
+ unsigned int max_nsectors,
+ grub_embed_type_t embed_type,
+ grub_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 grub_fs *grub_fs_t;
+
+/* This is special, because block lists are not files in usual sense. */
+extern struct grub_fs grub_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 GRUB_FS_LIST through the function grub_fs_register. */
+typedef int (*grub_fs_autoload_hook_t) (void);
+extern grub_fs_autoload_hook_t EXPORT_VAR(grub_fs_autoload_hook);
+extern grub_fs_t EXPORT_VAR (grub_fs_list);
+
+#ifndef GRUB_LST_GENERATOR
+static inline void
+grub_fs_register (grub_fs_t fs)
+{
+ grub_list_push (GRUB_AS_LIST_P (&grub_fs_list), GRUB_AS_LIST (fs));
+}
+#endif
+
+static inline void
+grub_fs_unregister (grub_fs_t fs)
+{
+ grub_list_remove (GRUB_AS_LIST (fs));
+}
+
+#define FOR_FILESYSTEMS(var) FOR_LIST_ELEMENTS((var), (grub_fs_list))
+
+grub_fs_t EXPORT_FUNC(grub_fs_probe) (grub_device_t device);
+
+#endif /* ! GRUB_FS_HEADER */