core/include/fs.h

   1 #ifndef FS_H
   2 #define FS_H
   3
   4 #include <stddef.h>
   5 #include <stdbool.h>
   6 #include <string.h>
   7 #include <com32.h>
   8 #include <stdio.h>
   9 #include <sys/dirent.h>
  10 #include "core.h"
  11 #include "disk.h"
  12
  13 /*
  14  * Maximum number of open files.  This is *currently* constrained by the
  15  * fact that PXE needs to be able to fit all its packet buffers into a
  16  * 64K segment; this should be fixed by moving the packet buffers to high
  17  * memory.
  18  */
  19 #define MAX_OPEN_LG2    5
  20 #define MAX_OPEN        (1 << MAX_OPEN_LG2)
  21
  22 #define FILENAME_MAX_LG2 8
  23 #define FILENAME_MAX     (1 << FILENAME_MAX_LG2)
  24
  25 #define CURRENTDIR_MAX  FILENAME_MAX
  26
  27 #define BLOCK_SIZE(fs)   ((fs)->block_size)
  28 #define BLOCK_SHIFT(fs)  ((fs)->block_shift)
  29 #define SECTOR_SIZE(fs)  ((fs)->sector_size)
  30 #define SECTOR_SHIFT(fs) ((fs)->sector_shift)
  31
  32 struct fs_info {
  33     const struct fs_ops *fs_ops;
  34     struct device *fs_dev;
  35     void *fs_info;             /* The fs-specific information */
  36     int sector_shift, sector_size;
  37     int block_shift, block_size;
  38     struct inode *root, *cwd;           /* Root and current directories */
  39     char cwd_name[CURRENTDIR_MAX];      /* Current directory by name */
  40 };
  41
  42 extern struct fs_info *this_fs;
  43
  44 struct dirent;                  /* Directory entry structure */
  45 struct file;
  46 enum fs_flags {
  47     FS_NODEV   = 1 << 0,
  48     FS_USEMEM  = 1 << 1,        /* If we need a malloc routine, set it */
  49     FS_THISIND = 1 << 2,        /* Set cwd based on config file location */
  50 };
  51
  52 struct fs_ops {
  53     /* in fact, we use fs_ops structure to find the right fs */
  54     const char *fs_name;
  55     enum fs_flags fs_flags;
  56
  57     int      (*fs_init)(struct fs_info *);
  58     void     (*searchdir)(const char *, struct file *);
  59     uint32_t (*getfssec)(struct file *, char *, int, bool *);
  60     void     (*close_file)(struct file *);
  61     void     (*mangle_name)(char *, const char *);
  62     size_t   (*realpath)(struct fs_info *, char *, const char *, size_t);
  63     int      (*chdir)(struct fs_info *, const char *);
  64     int      (*load_config)(void);
  65
  66     struct inode * (*iget_root)(struct fs_info *);
  67     struct inode * (*iget)(const char *, struct inode *);
  68     int      (*readlink)(struct inode *, char *);
  69
  70     /* the _dir_ stuff */
  71     int      (*readdir)(struct file *, struct dirent *);
  72
  73     int      (*next_extent)(struct inode *, uint32_t);
  74 };
  75
  76 /*
  77  * Extent structure: contains the mapping of some chunk of a file
  78  * that is contiguous on disk.
  79  */
  80 struct extent {
  81     sector_t    pstart;         /* Physical start sector */
  82     uint32_t    lstart;         /* Logical start sector */
  83     uint32_t    len;            /* Number of contiguous sectors */
  84 };
  85
  86 /* Special sector numbers used for struct extent.pstart */
  87 #define EXTENT_ZERO     ((sector_t)-1) /* All-zero extent */
  88 #define EXTENT_VOID     ((sector_t)-2) /* Invalid information */
  89
  90 #define EXTENT_SPECIAL(x)       ((x) >= EXTENT_VOID)
  91
  92 /*
  93  * The inode structure, including the detail file information
  94  */
  95 struct inode {
  96     struct fs_info *fs;  /* The filesystem this inode is associated with */
  97     struct inode *parent;       /* Parent directory, if any */
  98     const char *name;           /* Name, valid for generic path search only */
  99     int          refcnt;
 100     int          mode;   /* FILE , DIR or SYMLINK */
 101     uint32_t     size;
 102     uint32_t     blocks; /* How many blocks the file take */
 103     uint32_t     ino;    /* Inode number */
 104     uint32_t     atime;  /* Access time */
 105     uint32_t     mtime;  /* Modify time */
 106     uint32_t     ctime;  /* Create time */
 107     uint32_t     dtime;  /* Delete time */
 108     uint32_t     flags;
 109     uint32_t     file_acl;
 110     struct extent this_extent, next_extent;
 111     char         pvt[0]; /* Private filesystem data */
 112 };
 113
 114 struct file {
 115     struct fs_info *fs;
 116     uint32_t offset;            /* for next read */
 117     struct inode *inode;        /* The file-specific information */
 118 };
 119
 120 /*
 121  * Struct device contains:
 122  *     the pointer points to the disk structure,
 123  *     the cache stuff.
 124  */
 125 struct cache;
 126
 127 struct device {
 128     struct disk *disk;
 129
 130     /* the cache stuff */
 131     char *cache_data;
 132     struct cache *cache_head;
 133     uint16_t cache_block_size;
 134     uint16_t cache_entries;
 135     uint32_t cache_size;
 136 };
 137
 138 /*
 139  * Our definition of "not whitespace"
 140  */
 141 static inline bool not_whitespace(char c)
 142 {
 143   return (unsigned char)c > ' ';
 144 }
 145
 146 /*
 147  * Inode allocator/deallocator
 148  */
 149 struct inode *alloc_inode(struct fs_info *fs, uint32_t ino, size_t data);
 150 static inline void free_inode(struct inode * inode)
 151 {
 152     free(inode);
 153 }
 154
 155 static inline struct inode *get_inode(struct inode *inode)
 156 {
 157     inode->refcnt++;
 158     return inode;
 159 }
 160
 161 void put_inode(struct inode *inode);
 162
 163 static inline void malloc_error(char *obj)
 164 {
 165         printf("Out of memory: can't allocate memory for %s\n", obj);
 166         kaboom();
 167 }
 168
 169 /*
 170  * File handle conversion functions
 171  */
 172 extern struct file files[];
 173 static inline uint16_t file_to_handle(struct file *file)
 174 {
 175     return file ? (file - files)+1 : 0;
 176 }
 177 static inline struct file *handle_to_file(uint16_t handle)
 178 {
 179     return handle ? &files[handle-1] : NULL;
 180 }
 181
 182 /* fs.c */
 183 void pm_mangle_name(com32sys_t *);
 184 void pm_searchdir(com32sys_t *);
 185 void mangle_name(char *, const char *);
 186 int searchdir(const char *name);
 187 void _close_file(struct file *);
 188 size_t pmapi_read_file(uint16_t *handle, void *buf, size_t sectors);
 189 int open_file(const char *name, struct com32_filedata *filedata);
 190 void pm_open_file(com32sys_t *);
 191 void close_file(uint16_t handle);
 192 void pm_close_file(com32sys_t *);
 193
 194 /* chdir.c */
 195 void pm_realpath(com32sys_t *regs);
 196 size_t realpath(char *dst, const char *src, size_t bufsize);
 197 int chdir(const char *src);
 198
 199 /* readdir.c */
 200 DIR *opendir(const char *pathname);
 201 struct dirent *readdir(DIR *dir);
 202 int closedir(DIR *dir);
 203
 204 /* getcwd.c */
 205 char *getcwd(char *buf, size_t size);
 206
 207 /*
 208  * Generic functions that filesystem drivers may choose to use
 209  */
 210
 211 /* mangle.c */
 212 void generic_mangle_name(char *, const char *);
 213
 214 /* loadconfig.c */
 215 int search_config(const char *search_directores[], const char *filenames[]);
 216 int generic_load_config(void);
 217
 218 /* close.c */
 219 void generic_close_file(struct file *file);
 220
 221 /* getfssec.c */
 222 uint32_t generic_getfssec(struct file *file, char *buf,
 223                           int sectors, bool *have_more);
 224
 225 /* nonextextent.c */
 226 int no_next_extent(struct inode *, uint32_t);
 227
 228 #endif /* FS_H */