Add FD tap infrastructure (XCC)
[akaros.git] / kern / include / vfs.h
1 /* Barret Rhoden <brho@cs.berkeley.edu>
2  *
3  * VFS, based on the Linux VFS as described in LKD 2nd Ed (Robert Love) and in
4  * UTLK (Bovet/Cesati) , which was probably written by Linus.  A lot of it was
5  * changed (reduced) to handle what ROS will need, at least initially.
6  * Hopefully it'll be similar enough to interface with ext2 and other Linux
7  * FSs.
8  *
9  * struct qstr came directly from Linux.
10  * Lawyers can sort out the copyrights and whatnot with these interfaces and
11  * structures. */
12
13 #ifndef ROS_KERN_VFS_H
14 #define ROS_KERN_VFS_H
15
16 #include <ros/common.h>
17 #include <sys/queue.h>
18 #include <sys/uio.h>
19 #include <bitmask.h>
20 #include <kref.h>
21 #include <time.h>
22 #include <radix.h>
23 #include <hashtable.h>
24 #include <pagemap.h>
25 #include <blockdev.h>
26 #include <fdtap.h>
27
28 /* ghetto preprocessor hacks (since proc includes vfs) */
29 struct page;
30 struct vm_region;
31
32 // TODO: temp typedefs, etc.  remove when we support this stuff.
33 typedef int dev_t;
34 typedef int kdev_t;
35 typedef int ino_t;
36 struct io_writeback     {int x;};
37 struct event_poll {int x;};
38 struct poll_table_struct {int x;};
39 // end temp typedefs.  note ino and off_t are needed in the next include
40
41 #include <ros/fs.h>
42
43 struct super_block;
44 struct super_operations;
45 struct dentry;
46 struct dentry_operations;
47 struct inode;
48 struct inode_operations;
49 struct file;
50 struct file_operations;
51 struct fs_type;
52 struct vfsmount;
53 struct pipe_inode_info;
54
55 /* List def's we need */
56 TAILQ_HEAD(sb_tailq, super_block);
57 TAILQ_HEAD(dentry_tailq, dentry);
58 SLIST_HEAD(dentry_slist, dentry);
59 TAILQ_HEAD(inode_tailq, inode);
60 SLIST_HEAD(inode_slist, inode);
61 TAILQ_HEAD(file_tailq, file);
62 TAILQ_HEAD(io_wb_tailq, io_writeback);
63 TAILQ_HEAD(event_poll_tailq, event_poll);
64 TAILQ_HEAD(vfsmount_tailq, vfsmount);
65 TAILQ_HEAD(fs_type_tailq, fs_type); 
66
67 /* Linux's quickstring - saves recomputing the hash and length.  Note the length
68  * is the non-null-terminated length, as you'd get from strlen(). (for now) */
69 struct qstr {
70     unsigned int hash;
71     unsigned int len;
72     char *name;
73 };
74
75 /* Helpful structure to pass around during lookup operations.  At each point,
76  * it tracks the the answer, the name of the previous, how deep the symlink
77  * following has gone, and the symlink pathnames.  *dentry and *mnt up the
78  * refcnt of those objects too, so whoever 'receives; this will need to decref.
79  * This is meant to be pinning only the 'answer' to a path_lookup, and not the
80  * intermediate steps.  The intermediates get pinned due to the existence of
81  * their children in memory.  Internally, the VFS will refcnt any item whenever
82  * it is in this struct.  The last_sym is needed to pin the dentry (and thus the
83  * inode and char* storage for the symname) for the duration of a lookup.  When
84  * you resolve a pathname, you need to keep its string in memory. */
85 #define MAX_SYMLINK_DEPTH 6 // arbitrary.
86 struct nameidata {
87         struct dentry                           *dentry;                /* dentry of the obj */
88         struct vfsmount                         *mnt;                   /* its mount pt */
89         struct qstr                                     last;                   /* last component in search */
90         int                                                     flags;                  /* lookup flags */
91         int                                                     last_type;              /* type of last component */
92         unsigned int                            depth;                  /* search's symlink depth */
93         int                                                     intent;                 /* access type for the file */
94         struct dentry                           *last_sym;              /* pins the symname */
95 };
96
97 /* nameidata lookup flags and access type fields */
98 #define LOOKUP_FOLLOW           0x01    /* if the last is a symlink, follow */
99 #define LOOKUP_DIRECTORY        0x02    /* last component must be a directory */
100 #define LOOKUP_CONTINUE         0x04    /* still filenames to go */
101 #define LOOKUP_PARENT           0x08    /* lookup the dir that includes the item */
102 /* These are the nd's intent */
103 #define LOOKUP_OPEN             0x10    /* intent is to open a file */
104 #define LOOKUP_CREATE           0x11    /* create a file if it doesn't exist */
105 #define LOOKUP_ACCESS           0x12    /* access / check user permissions */
106
107 /* Superblock: Specific instance of a mounted filesystem.  All synchronization
108  * is done with the one spinlock. */
109
110 struct super_block {
111         TAILQ_ENTRY(super_block)        s_list;                 /* list of all sbs */
112         dev_t                                           s_dev;                  /* id */
113         unsigned long                           s_blocksize;
114         bool                                            s_dirty;
115         unsigned long long                      s_maxbytes;             /* max file size */
116         struct fs_type                          *s_type;
117         struct super_operations         *s_op;
118         unsigned long                           s_flags;
119         unsigned long                           s_magic;
120         struct vfsmount                         *s_mount;               /* vfsmount point */
121         spinlock_t                                      s_lock;                 /* used for all sync */
122         struct kref                                     s_kref;
123         bool                                            s_syncing;              /* currently syncing metadata */
124         struct inode_tailq                      s_inodes;               /* all inodes */
125         struct inode_tailq                      s_dirty_i;              /* dirty inodes */
126         struct io_wb_tailq                      s_io_wb;                /* writebacks */
127         struct file_tailq                       s_files;                /* assigned files */
128         struct dentry_tailq                     s_lru_d;                /* unused dentries (in dcache)*/
129         spinlock_t                                      s_lru_lock;
130         struct hashtable                        *s_dcache;              /* dentry cache */
131         spinlock_t                                      s_dcache_lock;
132         struct hashtable                        *s_icache;              /* inode cache */
133         spinlock_t                                      s_icache_lock;
134         struct block_device                     *s_bdev;
135         TAILQ_ENTRY(super_block)        s_instances;    /* list of sbs of this fs type*/
136         char                                            s_name[32];
137         void                                            *s_fs_info;
138 };
139
140 struct super_operations {
141         struct inode *(*alloc_inode) (struct super_block *sb);
142         void (*dealloc_inode) (struct inode *);
143         void (*read_inode) (struct inode *);
144         void (*dirty_inode) (struct inode *);
145         void (*write_inode) (struct inode *, bool);
146         void (*put_inode) (struct inode *);                     /* when decreffed */
147         void (*drop_inode) (struct inode *);            /* when about to destroy */
148         void (*delete_inode) (struct inode *);          /* deleted from disk */
149         void (*put_super) (struct super_block *);       /* releases sb */
150         void (*write_super) (struct super_block *);     /* sync with sb on disk */
151         int (*sync_fs) (struct super_block *, bool);
152         int (*remount_fs) (struct super_block *, int, char *);
153         void (*umount_begin) (struct super_block *);/* called by NFS */
154 };
155
156 /* Sets the type of file, IAW the bits in ros/fs.h */
157 #define SET_FTYPE(mode, type) ((mode) = ((mode) & ~__S_IFMT) | (type))
158
159 /* Will need a bunch of states/flags for an inode.  TBD */
160 #define I_STATE_DIRTY                   0x001
161
162 /* Inode: represents a specific file */
163 struct inode {
164         SLIST_ENTRY(inode)                      i_hash;                 /* inclusion in a hash table */
165         TAILQ_ENTRY(inode)                      i_sb_list;              /* all inodes in the FS */
166         TAILQ_ENTRY(inode)                      i_list;                 /* describes state (dirty) */
167         struct dentry_tailq                     i_dentry;               /* all dentries pointing here*/
168         unsigned long                           i_ino;
169         struct kref                                     i_kref;
170         int                                                     i_mode;                 /* access mode and file type */
171         unsigned int                            i_nlink;                /* hard links */
172         uid_t                                           i_uid;
173         gid_t                                           i_gid;
174         kdev_t                                          i_rdev;                 /* real device node */
175         size_t                                          i_size;
176         unsigned long                           i_blksize;
177         unsigned long                           i_blocks;               /* filesize in blocks */
178         struct timespec                         i_atime;
179         struct timespec                         i_mtime;
180         struct timespec                         i_ctime;
181         spinlock_t                                      i_lock;
182         struct inode_operations         *i_op;
183         struct file_operations          *i_fop;
184         struct super_block                      *i_sb;
185         struct page_map                         *i_mapping;             /* usually points to i_pm */
186         struct page_map                         i_pm;                   /* this inode's page cache */
187         union {
188                 struct pipe_inode_info          *i_pipe;
189                 struct block_device                     *i_bdev;
190                 struct char_device                      *i_cdev;
191         };
192         unsigned long                           i_state;
193         unsigned long                           dirtied_when;   /* in jiffies */
194         unsigned int                            i_flags;                /* filesystem mount flags */
195         bool                                            i_socket;
196         atomic_t                                        i_writecount;   /* number of writers */
197         void                                            *i_fs_info;
198 };
199
200 struct inode_operations {
201         int (*create) (struct inode *, struct dentry *, int, struct nameidata *);
202         struct dentry *(*lookup) (struct inode *, struct dentry *,
203                                   struct nameidata *);
204         int (*link) (struct dentry *, struct inode *, struct dentry *);
205         int (*unlink) (struct inode *, struct dentry *);
206         int (*symlink) (struct inode *, struct dentry *, const char *);
207         int (*mkdir) (struct inode *, struct dentry *, int);
208         int (*rmdir) (struct inode *, struct dentry *);
209         int (*mknod) (struct inode *, struct dentry *, int, dev_t);
210         int (*rename) (struct inode *, struct dentry *,
211                        struct inode *, struct dentry *);
212         char *(*readlink) (struct dentry *);
213         void (*truncate) (struct inode *);                      /* set i_size before calling */
214         int (*permission) (struct inode *, int, struct nameidata *);
215 };
216
217 #define DNAME_INLINE_LEN 32
218
219 /* Dentry flags.  All negatives are also unused. */
220 #define DENTRY_USED                     0x01    /* has a kref > 0 */
221 #define DENTRY_NEGATIVE         0x02    /* cache of a failed lookup */
222 #define DENTRY_DYING            0x04    /* should be freed on release */
223
224 /* Dentry: in memory object, corresponding to an element of a path.  E.g. /,
225  * usr, bin, and vim are all dentries.  All have inodes.  Vim happens to be a
226  * file instead of a directory.
227  * They can be used (valid inode, currently in use), unused (valid, not used),
228  * or negative (not a valid inode (deleted or bad path), but kept to resolve
229  * requests quickly.  If none of these, dealloc it back to the slab cache.
230  * Unused and negatives go in the LRU list. */
231 struct dentry {
232         struct kref                                     d_kref;                 /* don't discard when 0 */
233         unsigned long                           d_flags;                /* dentry cache flags */
234         spinlock_t                                      d_lock;
235         struct inode                            *d_inode;
236         TAILQ_ENTRY(dentry)                     d_lru;                  /* unused list */
237         TAILQ_ENTRY(dentry)                     d_alias;                /* linkage for i_dentry */
238         struct dentry_tailq                     d_subdirs;
239         TAILQ_ENTRY(dentry)                     d_subdirs_link;
240         unsigned long                           d_time;                 /* revalidate time (jiffies)*/
241         struct dentry_operations        *d_op;
242         struct super_block                      *d_sb;
243         bool                                            d_mount_point;  /* is an FS mounted over here */
244         struct vfsmount                         *d_mounted_fs;  /* fs mounted here */
245         struct dentry                           *d_parent;
246         struct qstr                                     d_name;                 /* pts to iname and holds hash*/
247         char                                            d_iname[DNAME_INLINE_LEN];
248         void                                            *d_fs_info;
249 };
250
251 /* not sure yet if we want to call delete when refcnt == 0 (move it to LRU) or
252  * when its time to remove it from the dcache. */
253 struct dentry_operations {
254         int (*d_revalidate) (struct dentry *, struct nameidata *);
255         int (*d_hash) (struct dentry *, struct qstr *);
256         int (*d_compare) (struct dentry *, struct qstr *, struct qstr *);
257         int (*d_delete) (struct dentry *);
258         int (*d_release) (struct dentry *);
259         void (*d_iput) (struct dentry *, struct inode *);
260 };
261
262 /* Yanked from glibc-2.11.1/posix/unistd.h */
263 #define SEEK_SET   0   /* Seek from beginning of file.  */
264 #define SEEK_CUR   1   /* Seek from current position.  */
265 #define SEEK_END   2   /* Seek from end of file.  */
266
267 /* File: represents a file opened by a process. */
268 struct file {
269         TAILQ_ENTRY(file)                       f_list;                 /* list of all files */
270         struct dentry                           *f_dentry;              /* definitely not inode.  =( */
271         struct vfsmount                         *f_vfsmnt;
272         struct file_operations          *f_op;
273         struct kref                                     f_kref;
274         unsigned int                            f_flags;                /* O_APPEND, etc */
275         int                                                     f_mode;                 /* O_RDONLY, etc */
276         off64_t                                         f_pos;                  /* offset / file pointer */
277         unsigned int                            f_uid;
278         unsigned int                            f_gid;
279         int                                                     f_error;
280         struct event_poll_tailq         f_ep_links;
281         spinlock_t                                      f_ep_lock;
282         void                                            *f_privdata;    /* tty/socket driver hook */
283         struct page_map                         *f_mapping;             /* page cache mapping */
284
285         /* Ghetto appserver support */
286         int fd; // all it contains is an appserver fd (for pid 0, aka kernel)
287         int refcnt;
288         spinlock_t lock;
289 };
290
291 struct file_operations {
292         int (*llseek) (struct file *, off64_t, off64_t *, int);
293         ssize_t (*read) (struct file *, char *, size_t, off64_t *);
294         ssize_t (*write) (struct file *, const char *, size_t, off64_t *);
295         int (*readdir) (struct file *, struct dirent *);
296         int (*mmap) (struct file *, struct vm_region *);
297         int (*open) (struct inode *, struct file *);
298         int (*flush) (struct file *);
299         int (*release) (struct inode *, struct file *);
300         int (*fsync) (struct file *, struct dentry *, int);
301         unsigned int (*poll) (struct file *, struct poll_table_struct *);
302         ssize_t (*readv) (struct file *, const struct iovec *, unsigned long,
303                           off64_t *);
304         ssize_t (*writev) (struct file *, const struct iovec *, unsigned long,
305                           off64_t *);
306         ssize_t (*sendpage) (struct file *, struct page *, int, size_t, off64_t,
307                              int);
308         int (*check_flags) (int flags);                         /* most FS's ignore this */
309 };
310
311 /* FS structs.  One of these per FS (e.g., ext2) */
312 struct fs_type {
313         const char                                      *name;
314         int                                                     fs_flags;
315         struct super_block                      *(*get_sb) (struct fs_type *, int,
316                                                 char *, struct vfsmount *);
317         void                                            (*kill_sb) (struct super_block *);
318         TAILQ_ENTRY(fs_type)            list;
319         struct sb_tailq                         fs_supers;              /* all of this FS's sbs */
320 };
321
322 /* A mount point: more focused on the mounting, and solely in memory, compared
323  * to the SB which is focused on FS definitions (and exists on disc). */
324 struct vfsmount {
325         TAILQ_ENTRY(vfsmount)           mnt_list;
326         struct vfsmount                         *mnt_parent;
327         struct dentry                           *mnt_mountpoint;/* parent dentry where mnted */
328         struct dentry                           *mnt_root;              /* dentry of root of this fs */
329         struct super_block                      *mnt_sb;
330         struct vfsmount_tailq           mnt_child_mounts;
331         TAILQ_ENTRY(vfsmount)           mnt_child_link;
332         struct kref                                     mnt_kref;
333         int                                                     mnt_flags;
334         char                                            *mnt_devname;
335         struct namespace                        *mnt_namespace;
336 };
337
338 struct pipe_inode_info
339 {
340         char                                            *p_buf;
341         size_t                                          p_rd_off;
342         size_t                                          p_wr_off;
343         unsigned int                            p_nr_readers;
344         unsigned int                            p_nr_writers;
345         struct cond_var                         p_cv;
346 };
347
348 /* Per-process structs */
349 #define NR_OPEN_FILES_DEFAULT 32
350 #define NR_FILE_DESC_DEFAULT 32
351 /* this is not in sync with glibc, sysdeps/ros/bits/typesizes.h */
352 #define NR_FILE_DESC_MAX (512 * 1024)
353
354 /* Bitmask for file descriptors, big for when we exceed the initial small.  We
355  * could just use the fd_array to check for openness instead of the bitmask,
356  * but eventually we might want to use the bitmasks for other things (like
357  * which files are close_on_exec. */
358
359 typedef struct fd_set {
360     uint8_t fds_bits[BYTES_FOR_BITMASK(NR_FILE_DESC_MAX)];
361 } fd_set;
362
363
364 struct small_fd_set {
365     uint8_t fds_bits[BYTES_FOR_BITMASK(NR_FILE_DESC_DEFAULT)];
366 };
367
368 /* Helper macros to manage fd_sets */
369 #define FD_SET(n, p)  ((p)->fds_bits[(n)/8] |=  (1 << ((n) & 7)))
370 #define FD_CLR(n, p)  ((p)->fds_bits[(n)/8] &= ~(1 << ((n) & 7)))
371 #define FD_ISSET(n,p) ((p)->fds_bits[(n)/8] &   (1 << ((n) & 7)))
372 #define FD_ZERO(p)    memset((void*)(p),0,sizeof(*(p)))
373
374 /* Describes an open file.  We need this, since the FD flags are supposed to be
375  * per file descriptor, not per file (like the file status flags). */
376 struct chan;    /* from 9ns */
377 struct file_desc {
378         struct file                                     *fd_file;
379         struct chan                                     *fd_chan;
380         unsigned int                            fd_flags;
381         struct fd_tap                           *fd_tap;
382 };
383
384 /* All open files for a process */
385 struct fd_table {
386         spinlock_t                                      lock;
387         bool                                            closed;
388         int                                                     max_files;              /* max files ptd to by fd */
389         int                                                     max_fdset;              /* max of the current fd_set */
390         int                                                     hint_min_fd;    /* <= min available fd */
391         struct file_desc                        *fd;                    /* initially pts to fd_array */
392         struct fd_set                           *open_fds;              /* init, pts to open_fds_init */
393         struct small_fd_set                     open_fds_init;
394         struct file_desc                        fd_array[NR_OPEN_FILES_DEFAULT];
395 };
396
397 /* Process specific filesystem info */
398 struct fs_struct {
399         spinlock_t                                      lock;
400         int                                                     umask;
401         struct dentry                           *root;
402         struct dentry                           *pwd;
403 };
404
405 /* Each process can have its own (eventually), but default to the same NS */
406 struct namespace {
407         struct kref                                     kref;
408         spinlock_t                                      lock;
409         struct vfsmount                         *root;
410         struct vfsmount_tailq           vfsmounts;      /* all vfsmounts in this ns */
411 };
412
413 /* Global Structs */
414 extern struct sb_tailq super_blocks;                    /* list of all sbs */
415 extern spinlock_t super_blocks_lock;
416 extern struct fs_type_tailq file_systems;               /* lock this if it's dynamic */
417 extern struct namespace default_ns;
418
419 /* Slab caches for common objects */
420 extern struct kmem_cache *dentry_kcache;
421 extern struct kmem_cache *inode_kcache;
422 extern struct kmem_cache *file_kcache;
423
424 /* Misc VFS functions */
425 void vfs_init(void);
426 void qstr_builder(struct dentry *dentry, char *l_name);
427 char *file_name(struct file *file);
428 int path_lookup(char *path, int flags, struct nameidata *nd);
429 void path_release(struct nameidata *nd);
430 int mount_fs(struct fs_type *fs, char *dev_name, char *path, int flags);
431
432 /* Superblock functions */
433 struct super_block *get_sb(void);
434 void init_sb(struct super_block *sb, struct vfsmount *vmnt,
435              struct dentry_operations *d_op, unsigned long root_ino,
436              void *d_fs_info);
437
438 /* Dentry Functions */
439 struct dentry *get_dentry_with_ops(struct super_block *sb,
440                                    struct dentry *parent, char *name,
441                                    struct dentry_operations *d_op);
442 struct dentry *get_dentry(struct super_block *sb, struct dentry *parent,
443                           char *name);
444 void dentry_release(struct kref *kref);
445 void __dentry_free(struct dentry *dentry);
446 struct dentry *lookup_dentry(char *path, int flags);
447 struct dentry *dcache_get(struct super_block *sb, struct dentry *what_i_want);
448 void dcache_put(struct super_block *sb, struct dentry *key_val);
449 struct dentry *dcache_remove(struct super_block *sb, struct dentry *key);
450 void dcache_prune(struct super_block *sb, bool negative_only);
451 int generic_dentry_hash(struct dentry *dentry, struct qstr *qstr);
452
453 /* Inode Functions */
454 struct inode *get_inode(struct dentry *dentry);
455 void load_inode(struct dentry *dentry, unsigned long ino);
456 int create_file(struct inode *dir, struct dentry *dentry, int mode);
457 int create_dir(struct inode *dir, struct dentry *dentry, int mode);
458 int create_symlink(struct inode *dir, struct dentry *dentry,
459                    const char *symname, int mode);
460 int check_perms(struct inode *inode, int access_mode);
461 void inode_release(struct kref *kref);
462 void stat_inode(struct inode *inode, struct kstat *kstat);
463 struct inode *icache_get(struct super_block *sb, unsigned long ino);
464 void icache_put(struct super_block *sb, struct inode *inode);
465 struct inode *icache_remove(struct super_block *sb, unsigned long ino);
466
467 /* File-ish functions */
468 ssize_t generic_file_read(struct file *file, char *buf, size_t count,
469                           off64_t *offset);
470 ssize_t generic_file_write(struct file *file, const char *buf, size_t count,
471                            off64_t *offset);
472 ssize_t generic_dir_read(struct file *file, char *u_buf, size_t count,
473                          off64_t *offset);
474 struct file *alloc_file(void);
475 struct file *do_file_open(char *path, int flags, int mode);
476 int do_symlink(char *path, const char *symname, int mode);
477 int do_link(char *old_path, char *new_path);
478 int do_unlink(char *path);
479 int do_access(char *path, int mode);
480 int do_file_chmod(struct file *file, int mode);
481 int do_mkdir(char *path, int mode);
482 int do_rmdir(char *path);
483 int do_pipe(struct file **pipe_files, int flags);
484 int do_rename(char *old_path, char *new_path);
485 int do_truncate(struct inode *inode, off64_t len);
486 struct file *dentry_open(struct dentry *dentry, int flags);
487 void file_release(struct kref *kref);
488 ssize_t kread_file(struct file *file, void *buf, size_t sz);
489 void *kread_whole_file(struct file *file);
490
491 /* Process-related File management functions */
492 void *lookup_fd(struct fd_table *fdt, int fd, bool incref, bool vfs);
493 int insert_obj_fdt(struct fd_table *fdt, void *obj, int low_fd, int fd_flags,
494                    bool must_use_low, bool vfs);
495 bool close_fd(struct fd_table *fdt, int fd);
496 void close_fdt(struct fd_table *open_files, bool cloexec);
497 void clone_fdt(struct fd_table *src, struct fd_table *dst);
498
499 struct file *get_file_from_fd(struct fd_table *open_files, int fd);
500 void put_file_from_fd(struct fd_table *open_files, int file_desc);
501 int insert_file(struct fd_table *open_files, struct file *file, int low_fd,
502                 bool must, bool cloexec);
503 int do_chdir(struct fs_struct *fs_env, char *path);
504 int do_fchdir(struct fs_struct *fs_env, struct file *file);
505 char *do_getcwd(struct fs_struct *fs_env, char **kfree_this, size_t cwd_l);
506
507 /* Debugging */
508 void print_kstat(struct kstat *kstat);
509 int ls_dash_r(char *path);
510 extern struct inode_operations dummy_i_op;
511 extern struct dentry_operations dummy_d_op;
512
513 #endif /* ROS_KERN_VFS_H */