include/grub/fs.h

   1 /* fs.h - filesystem manager */
   2 /*
   3  *  GRUB  --  GRand Unified Bootloader
   4  *  Copyright (C) 2002,2003,2004,2007,2008  Free Software Foundation, Inc.
   5  *
   6  *  GRUB is free software: you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation, either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  GRUB is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef GRUB_FS_HEADER
  21 #define GRUB_FS_HEADER  1
  22
  23 #include <grub/device.h>
  24 #include <grub/symbol.h>
  25 #include <grub/types.h>
  26
  27 /* Forward declaration is required, because of mutual reference.  */
  28 struct grub_file;
  29
  30 struct grub_dirhook_info
  31 {
  32   int dir:1;
  33   int mtimeset:1;
  34   int case_insensitive:1;
  35   grub_int32_t mtime;
  36 };
  37
  38 /* Filesystem descriptor.  */
  39 struct grub_fs
  40 {
  41   /* My name.  */
  42   const char *name;
  43
  44   /* Call HOOK with each file under DIR.  */
  45   grub_err_t (*dir) (grub_device_t device, const char *path,
  46                      int (*hook) (const char *filename,
  47                                   const struct grub_dirhook_info *info));
  48
  49   /* Open a file named NAME and initialize FILE.  */
  50   grub_err_t (*open) (struct grub_file *file, const char *name);
  51
  52   /* Read LEN bytes data from FILE into BUF.  */
  53   grub_ssize_t (*read) (struct grub_file *file, char *buf, grub_size_t len);
  54
  55   /* Close the file FILE.  */
  56   grub_err_t (*close) (struct grub_file *file);
  57
  58   /* Return the label of the device DEVICE in LABEL.  The label is
  59      returned in a grub_malloc'ed buffer and should be freed by the
  60      caller.  */
  61   grub_err_t (*label) (grub_device_t device, char **label);
  62
  63   /* Return the uuid of the device DEVICE in UUID.  The uuid is
  64      returned in a grub_malloc'ed buffer and should be freed by the
  65      caller.  */
  66   grub_err_t (*uuid) (grub_device_t device, char **uuid);
  67
  68   /* Get writing time of filesystem. */
  69   grub_err_t (*mtime) (grub_device_t device, grub_int32_t *timebuf);
  70
  71 #ifdef GRUB_UTIL
  72   /* Whether this filesystem reserves first sector for DOS-style boot.  */
  73   int reserved_first_sector;
  74 #endif
  75
  76   /* The next filesystem.  */
  77   struct grub_fs *next;
  78 };
  79 typedef struct grub_fs *grub_fs_t;
  80
  81 /* This is special, because block lists are not files in usual sense.  */
  82 extern struct grub_fs grub_fs_blocklist;
  83
  84 /* This hook is used to automatically load filesystem modules.
  85    If this hook loads a module, return non-zero. Otherwise return zero.
  86    The newly loaded filesystem is assumed to be inserted into the head of
  87    the linked list GRUB_FS_LIST through the function grub_fs_register.  */
  88 typedef int (*grub_fs_autoload_hook_t) (void);
  89 extern grub_fs_autoload_hook_t EXPORT_VAR(grub_fs_autoload_hook);
  90
  91 void EXPORT_FUNC(grub_fs_register) (grub_fs_t fs);
  92 void EXPORT_FUNC(grub_fs_unregister) (grub_fs_t fs);
  93 void EXPORT_FUNC(grub_fs_iterate) (int (*hook) (const grub_fs_t fs));
  94 grub_fs_t EXPORT_FUNC(grub_fs_probe) (grub_device_t device);
  95
  96 #endif /* ! GRUB_FS_HEADER */