File opening revisited
[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 <arch/bitmask.h>
19 #include <kref.h>
20 #include <timing.h>
21 #include <radix.h>
22
23 /* ghetto preprocessor hacks (since proc includes vfs) */
24 struct page;
25 struct vm_region;
26
27 // TODO: temp typedefs, etc.  remove when we support this stuff.
28 typedef int dev_t;
29 typedef int kdev_t;
30 typedef int ino_t;
31 typedef long off_t; // out there in other .h's, but not in the kernel yet
32 struct block_device     {int x;};
33 struct io_writeback     {int x;};
34 struct event_poll {int x;};
35 struct poll_table_struct {int x;};
36 // end temp typedefs
37
38 struct page_map;        /* analagous to linux's address_space object */
39 struct page_map_operations;
40 struct super_block;
41 struct super_operations;
42 struct dentry;
43 struct dentry_operations;
44 struct inode;
45 struct inode_operations;
46 struct file;
47 struct file_operations;
48 struct fs_type;
49 struct vfsmount;
50
51 /* part of the kernel interface, ripped from man pages, ought to work. */
52 // TODO: eventually move this to ros/fs.h or something.
53 #define MAX_FILENAME_SZ 255
54 struct dirent { // or maybe something else to not conflict with userspace
55         ino_t          d_ino;       /* inode number */
56         off_t          d_off;       /* offset to the next dirent */
57         unsigned short d_reclen;    /* length of this record */
58         char           d_name[MAX_FILENAME_SZ + 1]; /* filename */
59 };
60
61 struct iovec {
62     void *iov_base;
63     size_t iov_len;
64 };
65
66 /* List def's we need */
67 TAILQ_HEAD(sb_tailq, super_block);
68 TAILQ_HEAD(dentry_tailq, dentry);
69 SLIST_HEAD(dentry_slist, dentry);
70 TAILQ_HEAD(inode_tailq, inode);
71 SLIST_HEAD(inode_slist, inode);
72 TAILQ_HEAD(file_tailq, file);
73 TAILQ_HEAD(io_wb_tailq, io_writeback);
74 TAILQ_HEAD(event_poll_tailq, event_poll);
75 TAILQ_HEAD(vfsmount_tailq, vfsmount);
76 TAILQ_HEAD(fs_type_tailq, fs_type);
77
78 /* Linux's quickstring - saves recomputing the hash and length.  Note the length
79  * is the non-null-terminated length, as you'd get from strlen(). (for now) */
80 struct qstr {
81     unsigned int hash;
82     unsigned int len;
83     char *name;
84 };
85
86 /* Helpful structure to pass around during lookup operations.  At each point,
87  * it tracks the the answer, the name of the previous, how deep the symlink
88  * following has gone, and the symlink pathnames.  *dentry and *mnt up the
89  * refcnt of those objects too, so whoever 'receives; this will need to decref.
90  * This is meant to be pinning only the 'answer' to a path_lookup, and not the
91  * intermediate steps.  The intermediates get pinned due to the existence of
92  * their children in memory.  Internally, the VFS will refcnt any item whenever
93  * it is in this struct. */
94 #define MAX_SYMLINK_DEPTH 6 // arbitrary.
95 struct nameidata {
96         struct dentry                           *dentry;                /* dentry of the obj */
97         struct vfsmount                         *mnt;                   /* its mount pt */
98         struct qstr                                     last;                   /* last component in search */
99         int                                                     flags;                  /* lookup flags */
100         int                                                     last_type;              /* type of last component */
101         unsigned int                            depth;                  /* search's symlink depth */
102         char                                            *saved_names[MAX_SYMLINK_DEPTH];
103         int                                                     intent;                 /* access type for the file */
104 };
105
106 /* nameidata lookup flags and access type fields */
107 #define LOOKUP_FOLLOW           0x01    /* if the last is a symlink, follow */
108 #define LOOKUP_DIRECTORY        0x02    /* last component must be a directory */
109 #define LOOKUP_CONTINUE         0x04    /* still filenames to go */
110 #define LOOKUP_PARENT           0x08    /* lookup the dir that includes the item */
111 #define LOOKUP_OPEN             0x10    /* intent is to open a file */
112 #define LOOKUP_CREATE           0x11    /* create a file if it doesn't exist */
113 #define LOOKUP_ACCESS           0x12    /* access / check user permissions */
114
115 /* TODO: make our own versions (fucking octal) and put it in fcntl.h */
116 /* File access modes for `open' and `fcntl'.  */
117 #define O_RDONLY    0   /* Open read-only.  */
118 #define O_WRONLY    1   /* Open write-only.  */
119 #define O_RDWR      2   /* Open read/write.  */
120 #define O_ACCMODE   3
121
122 /* Bits OR'd into the second argument to open.  */
123 #define O_CREAT        0100 /* not fcntl */
124 #define O_EXCL         0200 /* not fcntl */
125 #define O_NOCTTY       0400 /* not fcntl */
126 #define O_TRUNC       01000 /* not fcntl */
127 #define O_APPEND      02000
128 #define O_NONBLOCK    04000
129 #define O_SYNC       010000
130 #define O_FSYNC      O_SYNC
131 #define O_ASYNC      020000
132
133 /* Every object that has pages, like an inode or the swap (or even direct block
134  * devices) has a page_map, tracking which of its pages are currently in memory.
135  * It is a map, per object, from index to physical page frame. */
136 struct page_map {
137         struct inode                            *pm_host;               /* inode of the owner, if any */
138         struct radix_tree                       pm_tree;                /* tracks present pages */
139         spinlock_t                                      pm_tree_lock;   /* spinlock => we can't block */
140         unsigned long                           pm_num_pages;   /* how many pages are present */
141         struct page_map_operations      *pm_op;
142         unsigned int                            pm_flags;
143         /*... and private lists, backing block dev info, other mappings, etc. */
144 };
145
146 /* Operations performed on a page_map.  These are usually FS specific, which
147  * get assigned when the inode is created.
148  * Will fill these in as they are created/needed/used. */
149 struct page_map_operations {
150         int (*readpage) (struct file *, struct page *); /* read from backing store*/
151 /*      readpages: read a list of pages
152         writepage: write from a page to its backing store
153         writepages: write a list of pages
154         sync_page: start the IO of already scheduled ops
155         set_page_dirty: mark the given page dirty
156         prepare_write: prepare to write (disk backed pages)
157         commit_write: complete a write (disk backed pages)
158         bmap: get a logical block number from a file block index
159         invalidate page: invalidate, part of truncating
160         release page: prepare to release 
161         direct_io: bypass the page cache */
162 };
163
164 /* Superblock: Specific instance of a mounted filesystem.  All synchronization
165  * is done with the one spinlock. */
166
167 struct super_block {
168         TAILQ_ENTRY(super_block)        s_list;                 /* list of all sbs */
169         dev_t                                           s_dev;                  /* id */
170         unsigned long                           s_blocksize;
171         bool                                            s_dirty;
172         unsigned long long                      s_maxbytes;             /* max file size */
173         struct fs_type                          *s_type;
174         struct super_operations         *s_op;
175         unsigned long                           s_flags;
176         unsigned long                           s_magic;
177         struct vfsmount                         *s_mount;               /* vfsmount point */
178         spinlock_t                                      s_lock;                 /* used for all sync */
179         struct kref                                     s_kref;
180         bool                                            s_syncing;              /* currently syncing metadata */
181         struct inode_tailq                      s_inodes;               /* all inodes */
182         struct inode_tailq                      s_dirty_i;              /* dirty inodes */
183         struct io_wb_tailq                      s_io_wb;                /* writebacks */
184         struct dentry_slist                     s_anon_d;               /* anonymous dentries */
185         struct file_tailq                       s_files;                /* assigned files */
186         struct block_device                     *s_bdev;
187         TAILQ_ENTRY(super_block)        s_instances;    /* list of sbs of this fs type*/
188         char                                            s_name[32];
189         void                                            *s_fs_info;
190 };
191
192 struct super_operations {
193         struct inode *(*alloc_inode) (struct super_block *sb);
194         void (*destroy_inode) (struct inode *);         /* dealloc.  might need more */
195         void (*read_inode) (struct inode *);
196         void (*dirty_inode) (struct inode *);
197         void (*write_inode) (struct inode *, bool);
198         void (*put_inode) (struct inode *);                     /* when decreffed */
199         void (*drop_inode) (struct inode *);            /* when about to destroy */
200         void (*delete_inode) (struct inode *);          /* deleted from disk */
201         void (*put_super) (struct super_block *);       /* releases sb */
202         void (*write_super) (struct super_block *);     /* sync with sb on disk */
203         int (*sync_fs) (struct super_block *, bool);
204         int (*remount_fs) (struct super_block *, int, char *);
205         void (*umount_begin) (struct super_block *);/* called by NFS */
206 };
207
208 #define FS_I_FILE                               0x01
209 #define FS_I_DIR                                0x02
210
211 /* Inode: represents a specific file */
212 struct inode {
213         SLIST_ENTRY(inode)                      i_hash;                 /* inclusion in a hash table */
214         TAILQ_ENTRY(inode)                      i_sb_list;              /* all inodes in the FS */
215         TAILQ_ENTRY(inode)                      i_list;                 /* describes state (dirty) */
216         struct dentry_tailq                     i_dentry;               /* all dentries pointing here*/
217         unsigned long                           i_ino;
218         struct kref                                     i_kref;
219         int                                                     i_mode;                 /* access mode */
220         unsigned short                          i_type;                 /* file type */
221         unsigned int                            i_nlink;                /* hard links */
222         uid_t                                           i_uid;
223         gid_t                                           i_gid;
224         kdev_t                                          i_rdev;                 /* real device node */
225         size_t                                          i_size;
226         unsigned long                           i_blksize;
227         unsigned long                           i_blocks;               /* filesize in blocks */
228         struct timespec                         i_atime;
229         struct timespec                         i_mtime;
230         struct timespec                         i_ctime;
231         spinlock_t                                      i_lock;
232         struct inode_operations         *i_op;
233         struct file_operations          *i_fop;
234         struct super_block                      *i_sb;
235         struct page_map                         *i_mapping;             /* usually points to i_data */
236         struct page_map                         i_pm;                   /* this inode's page cache */
237         union {
238                 struct pipe_inode_info          *i_pipe;
239                 struct block_device                     *i_bdev;
240                 struct char_device                      *i_cdev;
241         };
242         unsigned long                           i_state;
243         unsigned long                           dirtied_when;   /* in jiffies */
244         unsigned int                            i_flags;                /* filesystem mount flags */
245         bool                                            i_socket;
246         atomic_t                                        i_writecount;   /* number of writers */
247         void                                            *i_fs_info;
248 };
249
250 struct inode_operations {
251         int (*create) (struct inode *, struct dentry *, int, struct nameidata *);
252         struct dentry *(*lookup) (struct inode *, struct dentry *,
253                                   struct nameidata *);
254         int (*link) (struct dentry *, struct inode *, struct dentry *);
255         int (*unlink) (struct inode *, struct dentry *);
256         int (*symlink) (struct inode *, struct dentry *, const char *);
257         int (*mkdir) (struct inode *, struct dentry *, int);
258         int (*rmdir) (struct inode *, struct dentry *);
259         int (*mknod) (struct inode *, struct dentry *, int, dev_t);
260         int (*rename) (struct inode *, struct dentry *,
261                        struct inode *, struct dentry *);
262         int (*readlink) (struct dentry *, char *, size_t);
263         int (*follow_link) (struct dentry *, struct nameidata *);
264         int (*put_link) (struct dentry *, struct nameidata *);
265         void (*truncate) (struct inode *);                      /* set i_size before calling */
266         int (*permission) (struct inode *, int, struct nameidata *);
267 };
268
269 #define DNAME_INLINE_LEN 32
270 /* Dentry: in memory object, corresponding to an element of a path.  E.g. /,
271  * usr, bin, and vim are all dentries.  All have inodes.  Vim happens to be a
272  * file instead of a directory.
273  * They can be used (valid inode, currently in use), unused (valid, not used),
274  * or negative (not a valid inode (deleted or bad path), but kept to resolve
275  * requests quickly.  If none of these, dealloc it back to the slab cache.
276  * Unused and negatives go in the LRU list. */
277 struct dentry {
278         struct kref                                     d_kref;                 /* don't discard when 0 */
279         unsigned long                           d_flags;                /* dentry cache flags */
280         spinlock_t                                      d_lock;
281         struct inode                            *d_inode;
282         TAILQ_ENTRY(dentry)                     d_lru;                  /* unused list */
283         TAILQ_ENTRY(dentry)                     d_alias;                /* linkage for i_dentry */
284         struct dentry_tailq                     d_subdirs;
285         TAILQ_ENTRY(dentry)                     d_subdirs_link;
286         unsigned long                           d_time;                 /* revalidate time (jiffies)*/
287         struct dentry_operations        *d_op;
288         struct super_block                      *d_sb;
289         bool                                            d_mount_point;  /* is an FS mounted over here */
290         struct vfsmount                         *d_mounted_fs;  /* fs mounted here */
291         struct dentry                           *d_parent;
292         struct qstr                                     d_name;                 /* pts to iname and holds hash*/
293         SLIST_ENTRY(dentry)                     d_hash;                 /* link for the dcache */
294         struct dentry_slist                     d_bucket;               /* hash bucket of this dentry */
295         char                                            d_iname[DNAME_INLINE_LEN];
296         void                                            *d_fs_info;
297 };
298
299 /* not sure yet if we want to call delete when refcnt == 0 (move it to LRU) or
300  * when its time to remove it from the dcache. */
301 struct dentry_operations {
302         int (*d_revalidate) (struct dentry *, struct nameidata *);
303         int (*d_hash) (struct dentry *, struct qstr *);
304         int (*d_compare) (struct dentry *, struct qstr *, struct qstr *);
305         int (*d_delete) (struct dentry *);
306         int (*d_release) (struct dentry *);
307         void (*d_iput) (struct dentry *, struct inode *);
308 };
309
310 /* Yanked from glibc-2.11.1/posix/unistd.h */
311 #define SEEK_SET   0   /* Seek from beginning of file.  */
312 #define SEEK_CUR   1   /* Seek from current position.  */
313 #define SEEK_END   2   /* Seek from end of file.  */
314
315 /* File: represents a file opened by a process. */
316 struct file {
317         TAILQ_ENTRY(file)                       f_list;                 /* list of all files */
318         struct dentry                           *f_dentry;              /* definitely not inode.  =( */
319         struct vfsmount                         *f_vfsmnt;
320         struct file_operations          *f_op;
321         struct kref                                     f_kref;
322         unsigned int                            f_flags;                /* O_APPEND, etc */
323         int                                                     f_mode;                 /* O_RDONLY, etc */
324         off_t                                           f_pos;                  /* offset / file pointer */
325         unsigned int                            f_uid;
326         unsigned int                            f_gid;
327         int                                                     f_error;
328         struct event_poll_tailq         f_ep_links;
329         spinlock_t                                      f_ep_lock;
330         void                                            *f_fs_info;             /* tty driver hook */
331         struct page_map                         *f_mapping;             /* page cache mapping */
332
333         /* Ghetto appserver support */
334         int fd; // all it contains is an appserver fd (for pid 0, aka kernel)
335         int refcnt;
336         spinlock_t lock;
337 };
338
339 struct file_operations {
340         off_t (*llseek) (struct file *, off_t, int);
341         ssize_t (*read) (struct file *, char *, size_t, off_t *);
342         ssize_t (*write) (struct file *, const char *, size_t, off_t *);
343         int (*readdir) (struct file *, struct dirent *);
344         int (*mmap) (struct file *, struct vm_region *);
345         int (*open) (struct inode *, struct file *);
346         int (*flush) (struct file *);
347         int (*release) (struct inode *, struct file *);
348         int (*fsync) (struct file *, struct dentry *, int);
349         unsigned int (*poll) (struct file *, struct poll_table_struct *);
350         ssize_t (*readv) (struct file *, const struct iovec *, unsigned long,
351                           off_t *);
352         ssize_t (*writev) (struct file *, const struct iovec *, unsigned long,
353                           off_t *);
354         ssize_t (*sendpage) (struct file *, struct page *, int, size_t, off_t, int);
355         int (*check_flags) (int flags);                         /* most FS's ignore this */
356 };
357
358 /* FS structs.  One of these per FS (e.g., ext2) */
359 struct fs_type {
360         const char                                      *name;
361         int                                                     fs_flags;
362         struct super_block                      *(*get_sb) (struct fs_type *, int,
363                                                 char *, struct vfsmount *);
364         void                                            (*kill_sb) (struct super_block *);
365         TAILQ_ENTRY(fs_type)            list;
366         struct sb_tailq                         fs_supers;              /* all of this FS's sbs */
367 };
368
369 /* A mount point: more focused on the mounting, and solely in memory, compared
370  * to the SB which is focused on FS definitions (and exists on disc). */
371 struct vfsmount {
372         TAILQ_ENTRY(vfsmount)           mnt_list;
373         struct vfsmount                         *mnt_parent;
374         struct dentry                           *mnt_mountpoint;/* parent dentry where mnted */
375         struct dentry                           *mnt_root;              /* dentry of root of this fs */
376         struct super_block                      *mnt_sb;
377         struct vfsmount_tailq           mnt_child_mounts;
378         TAILQ_ENTRY(vfsmount)           mnt_child_link;
379         struct kref                                     mnt_kref;
380         int                                                     mnt_flags;
381         char                                            *mnt_devname;
382         struct namespace                        *mnt_namespace;
383 };
384
385 /* Per-process structs */
386 #define NR_OPEN_FILES_DEFAULT 32
387 #define NR_FILE_DESC_DEFAULT 32
388 #define NR_FILE_DESC_MAX 1024
389
390 /* Bitmask for file descriptors, big for when we exceed the initial small.  We
391  * could just use the fd_array to check for openness instead of the bitmask,
392  * but eventually we might want to use the bitmasks for other things (like
393  * which files are close_on_exec. */
394 struct fd_set {
395     uint8_t fds_bits[BYTES_FOR_BITMASK(NR_FILE_DESC_MAX)];
396 };
397 struct small_fd_set {
398     uint8_t fds_bits[BYTES_FOR_BITMASK(NR_FILE_DESC_DEFAULT)];
399 };
400
401 /* All open files for a process */
402 struct files_struct {
403         spinlock_t                                      lock;
404         int                                                     max_files;              /* max files ptd to by fd */
405         int                                                     max_fdset;              /* max of the current fd_set */
406         int                                                     next_fd;                /* next number available */
407         struct file                                     **fd;                   /* initially pts to fd_array */
408         struct fd_set                           *open_fds;              /* init, pts to open_fds_init */
409         struct small_fd_set                     open_fds_init;
410         struct file                                     *fd_array[NR_OPEN_FILES_DEFAULT];
411 };
412
413 /* Process specific filesysten info */
414 struct fs_struct {
415         spinlock_t                                      lock;
416         int                                                     umask;
417         struct dentry                           *root;
418         struct dentry                           *pwd;
419 };
420
421 /* Each process can have its own (eventually), but default to the same NS */
422 struct namespace {
423         struct kref                                     kref;
424         spinlock_t                                      lock;
425         struct vfsmount                         *root;
426         struct vfsmount_tailq           vfsmounts;      /* all vfsmounts in this ns */
427 };
428
429 /* Global Structs */
430 extern struct sb_tailq super_blocks;                    /* list of all sbs */
431 extern spinlock_t super_blocks_lock;
432 extern struct fs_type_tailq file_systems;               /* lock this if it's dynamic */
433 extern struct namespace default_ns;
434 // TODO: should have a dentry_htable or something.  we have the structs built
435 // in to the dentry right now (linux style).
436 extern struct dentry_slist dcache;
437 extern spinlock_t dcache_lock;
438
439 /* Slab caches for common objects */
440 extern struct kmem_cache *dentry_kcache;
441 extern struct kmem_cache *inode_kcache;
442 extern struct kmem_cache *file_kcache;
443
444 /* Misc VFS functions */
445 void vfs_init(void);
446 void qstr_builder(struct dentry *dentry, char *l_name);
447 char *file_name(struct file *file);
448 int path_lookup(char *path, int flags, struct nameidata *nd);
449 void path_release(struct nameidata *nd);
450
451 /* Superblock functions */
452 struct super_block *get_sb(void);
453 void init_sb(struct super_block *sb, struct vfsmount *vmnt,
454              struct dentry_operations *d_op, unsigned long root_ino,
455              void *d_fs_info);
456
457 /* Dentry Functions */
458 struct dentry *get_dentry(struct super_block *sb, struct dentry *parent,
459                           char *name);
460 void dcache_put(struct dentry *dentry);
461 void dentry_release(struct kref *kref);
462
463 /* Inode Functions */
464 int check_perms(struct inode *inode, int access_mode);
465 void inode_release(struct kref *kref);
466
467 /* File functions */
468 ssize_t generic_file_read(struct file *file, char *buf, size_t count,
469                           off_t *offset);
470 ssize_t generic_file_write(struct file *file, const char *buf, size_t count,
471                            off_t *offset);
472 struct file *do_file_open(char *path, int flags, int mode);
473 struct file *dentry_open(struct dentry *dentry);
474 void file_release(struct kref *kref);
475
476 /* Page cache functions */
477 struct page *pm_find_page(struct page_map *pm, unsigned long index);
478 int pm_insert_page(struct page_map *pm, unsigned long index, struct page *page);
479 int pm_remove_page(struct page_map *pm, struct page *page);
480 int file_load_page(struct file *file, unsigned long index, struct page **pp);
481
482 /* Process-related File management functions */
483 struct file *get_file_from_fd(struct files_struct *open_files, int fd);
484 struct file *put_file_from_fd(struct files_struct *open_files, int file_desc);
485 int insert_file(struct files_struct *open_files, struct file *file);
486 void close_all_files(struct files_struct *open_files);
487
488 #endif /* ROS_KERN_VFS_H */