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