lib/vfs/xdirentry.h

   1
   2 /**
   3  * \file
   4  * \brief Header: Virtual File System directory structure
   5  */
   6
   7
   8 #ifndef MC__VFS_XDIRENTRY_H
   9 #define MC__VFS_XDIRENTRY_H
  10
  11 #include <stdio.h>
  12 #include <sys/types.h>
  13
  14 #include "lib/global.h"         /* GList */
  15 #include "lib/vfs/path.h"       /* vfs_path_t */
  16
  17 /*** typedefs(not structures) and defined constants **********************************************/
  18
  19 #define LINK_FOLLOW 15
  20 #define LINK_NO_FOLLOW -1
  21
  22 /* For vfs_s_find_entry */
  23 #define FL_NONE 0
  24 #define FL_MKDIR 1
  25 #define FL_MKFILE 2
  26 #define FL_DIR 4
  27
  28 /* For open_super */
  29 #define FL_NO_OPEN 1
  30
  31 /* For vfs_s_entry_from_path */
  32 #define FL_FOLLOW 1
  33 #define FL_DIR 4
  34
  35 #define ERRNOR(a, b) do { me->verrno = a; return b; } while (0)
  36
  37 #define MEDATA ((struct vfs_s_subclass *) me->data)
  38
  39 #define VFSDATA(a) ((a->class != NULL) ? (struct vfs_s_subclass *) a->class->data : NULL)
  40
  41 #define FH ((vfs_file_handler_t *) fh)
  42 #define FH_SUPER FH->ino->super
  43
  44 #define LS_NOT_LINEAR 0
  45 #define LS_LINEAR_CLOSED 1
  46 #define LS_LINEAR_OPEN 2
  47 #define LS_LINEAR_PREOPEN 3
  48
  49 /*** enums ***************************************************************************************/
  50
  51 /* For vfs_s_subclass->flags */
  52 typedef enum
  53 {
  54     VFS_S_REMOTE = 1L << 0,
  55     VFS_S_READONLY = 1L << 1,
  56     VFS_S_USETMP = 1L << 2,
  57 } vfs_subclass_flags_t;
  58
  59 /*** structures declarations (and typedefs of structures)*****************************************/
  60
  61 /* Single connection or archive */
  62 struct vfs_s_super
  63 {
  64     struct vfs_class *me;
  65     struct vfs_s_inode *root;
  66     char *name;                 /* My name, whatever it means */
  67     int fd_usage;               /* Number of open files */
  68     int ino_usage;              /* Usage count of this superblock */
  69     int want_stale;             /* If set, we do not flush cache properly */
  70 #ifdef ENABLE_VFS_NET
  71     vfs_path_element_t *path_element;
  72 #endif                          /* ENABLE_VFS_NET */
  73
  74     void *data;                 /* This is for filesystem-specific use */
  75 };
  76
  77 /*
  78  * Single virtual file - directory entry.  The same inode can have many
  79  * entries (i.e. hard links), but usually has only one.
  80  */
  81 struct vfs_s_entry
  82 {
  83     struct vfs_s_inode *dir;    /* Directory we are in, i.e. our parent */
  84     char *name;                 /* Name of this entry */
  85     struct vfs_s_inode *ino;    /* ... and its inode */
  86 };
  87
  88 /* Single virtual file - inode */
  89 struct vfs_s_inode
  90 {
  91     struct vfs_s_super *super;  /* Archive the file is on */
  92     struct vfs_s_entry *ent;    /* Our entry in the parent directory -
  93                                    use only for directories because they
  94                                    cannot be hardlinked */
  95     GList *subdir;              /* If this is a directory, its entry. List of vfs_s_entry */
  96     struct stat st;             /* Parameters of this inode */
  97     char *linkname;             /* Symlink's contents */
  98     char *localname;            /* Filename of local file, if we have one */
  99     struct timeval timestamp;   /* Subclass specific */
 100     off_t data_offset;          /* Subclass specific */
 101 };
 102
 103 /* Data associated with an open file */
 104 typedef struct
 105 {
 106     struct vfs_s_inode *ino;
 107     off_t pos;                  /* This is for module's use */
 108     int handle;                 /* This is for module's use, but if != -1, will be mc_close()d */
 109     int changed;                /* Did this file change? */
 110     int linear;                 /* Is that file open with O_LINEAR? */
 111     void *data;                 /* This is for filesystem-specific use */
 112 } vfs_file_handler_t;
 113
 114 /*
 115  * One of our subclasses (tar, cpio, fish, ftpfs) with data and methods.
 116  * Extends vfs_class.  Stored in the "data" field of vfs_class.
 117  */
 118 struct vfs_s_subclass
 119 {
 120     GList *supers;
 121     int inode_counter;
 122     vfs_subclass_flags_t flags; /* whether the subclass is remove, read-only etc */
 123     dev_t rdev;
 124     FILE *logfile;
 125     int flush;                  /* if set to 1, invalidate directory cache */
 126
 127     /* *INDENT-OFF* */
 128     int (*init_inode) (struct vfs_class * me, struct vfs_s_inode * ino);        /* optional */
 129     void (*free_inode) (struct vfs_class * me, struct vfs_s_inode * ino);       /* optional */
 130     int (*init_entry) (struct vfs_class * me, struct vfs_s_entry * entry);      /* optional */
 131
 132     void *(*archive_check) (const vfs_path_t * vpath);  /* optional */
 133     int (*archive_same) (const vfs_path_element_t * vpath_element, struct vfs_s_super * psup,
 134                          const vfs_path_t * vpath, void *cookie);
 135     int (*open_archive) (struct vfs_s_super * psup,
 136                          const vfs_path_t * vpath, const vfs_path_element_t * vpath_element);
 137     void (*free_archive) (struct vfs_class * me, struct vfs_s_super * psup);
 138
 139     int (*fh_open) (struct vfs_class * me, vfs_file_handler_t * fh, int flags, mode_t mode);
 140     int (*fh_close) (struct vfs_class * me, vfs_file_handler_t * fh);
 141     void (*fh_free_data) (vfs_file_handler_t * fh);
 142
 143     struct vfs_s_entry *(*find_entry) (struct vfs_class * me,
 144                                        struct vfs_s_inode * root,
 145                                        const char *path, int follow, int flags);
 146     int (*dir_load) (struct vfs_class * me, struct vfs_s_inode * ino, char *path);
 147     int (*dir_uptodate) (struct vfs_class * me, struct vfs_s_inode * ino);
 148     int (*file_store) (struct vfs_class * me, vfs_file_handler_t * fh, char *path, char *localname);
 149
 150     int (*linear_start) (struct vfs_class * me, vfs_file_handler_t * fh, off_t from);
 151     ssize_t (*linear_read) (struct vfs_class * me, vfs_file_handler_t * fh, void *buf, size_t len);
 152     void (*linear_close) (struct vfs_class * me, vfs_file_handler_t * fh);
 153     /* *INDENT-ON* */
 154 };
 155
 156 /*** global variables defined in .c file *********************************************************/
 157
 158 /*** declarations of public functions ************************************************************/
 159
 160 /* entries and inodes */
 161 struct vfs_s_inode *vfs_s_new_inode (struct vfs_class *me,
 162                                      struct vfs_s_super *super, struct stat *initstat);
 163 void vfs_s_free_inode (struct vfs_class *me, struct vfs_s_inode *ino);
 164
 165 struct vfs_s_entry *vfs_s_new_entry (struct vfs_class *me, const char *name,
 166                                      struct vfs_s_inode *inode);
 167 void vfs_s_free_entry (struct vfs_class *me, struct vfs_s_entry *ent);
 168 void vfs_s_insert_entry (struct vfs_class *me, struct vfs_s_inode *dir, struct vfs_s_entry *ent);
 169 struct stat *vfs_s_default_stat (struct vfs_class *me, mode_t mode);
 170
 171 struct vfs_s_entry *vfs_s_generate_entry (struct vfs_class *me, const char *name,
 172                                           struct vfs_s_inode *parent, mode_t mode);
 173 struct vfs_s_inode *vfs_s_find_inode (struct vfs_class *me,
 174                                       const struct vfs_s_super *super,
 175                                       const char *path, int follow, int flags);
 176 struct vfs_s_inode *vfs_s_find_root (struct vfs_class *me, struct vfs_s_entry *entry);
 177
 178 /* outside interface */
 179 void vfs_s_init_class (struct vfs_class *vclass, struct vfs_s_subclass *sub);
 180 const char *vfs_s_get_path (const vfs_path_t * vpath, struct vfs_s_super **archive, int flags);
 181 struct vfs_s_super *vfs_get_super_by_vpath (const vfs_path_t * vpath);
 182
 183 void vfs_s_invalidate (struct vfs_class *me, struct vfs_s_super *super);
 184 char *vfs_s_fullpath (struct vfs_class *me, struct vfs_s_inode *ino);
 185
 186 /* network filesystems support */
 187 int vfs_s_select_on_two (int fd1, int fd2);
 188 int vfs_s_get_line (struct vfs_class *me, int sock, char *buf, int buf_len, char term);
 189 int vfs_s_get_line_interruptible (struct vfs_class *me, char *buffer, int size, int fd);
 190 /* misc */
 191 int vfs_s_retrieve_file (struct vfs_class *me, struct vfs_s_inode *ino);
 192
 193 void vfs_s_normalize_filename_leading_spaces (struct vfs_s_inode *root_inode, size_t final_filepos);
 194
 195 /*** inline functions ****************************************************************************/
 196
 197 static inline void
 198 vfs_s_store_filename_leading_spaces (struct vfs_s_entry *entry, size_t position)
 199 {
 200     entry->ino->data_offset = (off_t) position;
 201 }
 202
 203 #endif