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