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