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