arch/all-pc/boot/grub2-aros/include/grub/fshelp.h

   1 /* fshelp.h -- Filesystem helper functions */
   2 /*
   3  *  GRUB  --  GRand Unified Bootloader
   4  *  Copyright (C) 2004,2005,2006,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_FSHELP_HEADER
  21 #define GRUB_FSHELP_HEADER      1
  22
  23 #include <grub/types.h>
  24 #include <grub/symbol.h>
  25 #include <grub/err.h>
  26 #include <grub/disk.h>
  27
  28 typedef struct grub_fshelp_node *grub_fshelp_node_t;
  29
  30 #define GRUB_FSHELP_CASE_INSENSITIVE    0x100
  31 #define GRUB_FSHELP_TYPE_MASK   0xff
  32 #define GRUB_FSHELP_FLAGS_MASK  0x100
  33
  34 enum grub_fshelp_filetype
  35   {
  36     GRUB_FSHELP_UNKNOWN,
  37     GRUB_FSHELP_REG,
  38     GRUB_FSHELP_DIR,
  39     GRUB_FSHELP_SYMLINK
  40   };
  41
  42 typedef int (*grub_fshelp_iterate_dir_hook_t) (const char *filename,
  43                                                enum grub_fshelp_filetype filetype,
  44                                                grub_fshelp_node_t node,
  45                                                void *data);
  46
  47 /* Lookup the node PATH.  The node ROOTNODE describes the root of the
  48    directory tree.  The node found is returned in FOUNDNODE, which is
  49    either a ROOTNODE or a new malloc'ed node.  ITERATE_DIR is used to
  50    iterate over all directory entries in the current node.
  51    READ_SYMLINK is used to read the symlink if a node is a symlink.
  52    EXPECTTYPE is the type node that is expected by the called, an
  53    error is generated if the node is not of the expected type.  */
  54 grub_err_t
  55 EXPORT_FUNC(grub_fshelp_find_file) (const char *path,
  56                                     grub_fshelp_node_t rootnode,
  57                                     grub_fshelp_node_t *foundnode,
  58                                     int (*iterate_dir) (grub_fshelp_node_t dir,
  59                                                         grub_fshelp_iterate_dir_hook_t hook,
  60                                                         void *hook_data),
  61                                     char *(*read_symlink) (grub_fshelp_node_t node),
  62                                     enum grub_fshelp_filetype expect);
  63
  64
  65 /* Read LEN bytes from the file NODE on disk DISK into the buffer BUF,
  66    beginning with the block POS.  READ_HOOK should be set before
  67    reading a block from the file.  GET_BLOCK is used to translate file
  68    blocks to disk blocks.  The file is FILESIZE bytes big and the
  69    blocks have a size of LOG2BLOCKSIZE (in log2).  */
  70 grub_ssize_t
  71 EXPORT_FUNC(grub_fshelp_read_file) (grub_disk_t disk, grub_fshelp_node_t node,
  72                                     grub_disk_read_hook_t read_hook,
  73                                     void *read_hook_data,
  74                                     grub_off_t pos, grub_size_t len, char *buf,
  75                                     grub_disk_addr_t (*get_block) (grub_fshelp_node_t node,
  76                                                                    grub_disk_addr_t block),
  77                                     grub_off_t filesize, int log2blocksize,
  78                                     grub_disk_addr_t blocks_start);
  79
  80 #endif /* ! GRUB_FSHELP_HEADER */