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