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