9b10dcf8d5671f62fcb7d09562d515122e39f02c
[akaros.git] / kern / src / vfs.c
1 /* Copyright (c) 2009, 2010 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Default implementations and global values for the VFS. */
6
7 #include <vfs.h> // keep this first
8 #include <sys/queue.h>
9 #include <assert.h>
10 #include <stdio.h>
11 #include <atomic.h>
12 #include <slab.h>
13 #include <kmalloc.h>
14 #include <kfs.h>
15 #include <pmap.h>
16 #include <umem.h>
17
18 struct sb_tailq super_blocks = TAILQ_HEAD_INITIALIZER(super_blocks);
19 spinlock_t super_blocks_lock = SPINLOCK_INITIALIZER;
20 struct fs_type_tailq file_systems = TAILQ_HEAD_INITIALIZER(file_systems);
21 struct namespace default_ns;
22 // TODO: temp dcache, holds all dentries ever for now
23 struct dentry_slist dcache = SLIST_HEAD_INITIALIZER(dcache);
24 spinlock_t dcache_lock = SPINLOCK_INITIALIZER;
25
26 struct kmem_cache *dentry_kcache; // not to be confused with the dcache
27 struct kmem_cache *inode_kcache;
28 struct kmem_cache *file_kcache;
29
30 /* Mounts fs from dev_name at mnt_pt in namespace ns.  There could be no mnt_pt,
31  * such as with the root of (the default) namespace.  Not sure how it would work
32  * with multiple namespaces on the same FS yet.  Note if you mount the same FS
33  * multiple times, you only have one FS still (and one SB).  If we ever support
34  * that... */
35 struct vfsmount *mount_fs(struct fs_type *fs, char *dev_name,
36                           struct dentry *mnt_pt, int flags,
37                           struct namespace *ns)
38 {
39         struct super_block *sb;
40         struct vfsmount *vmnt = kmalloc(sizeof(struct vfsmount), 0);
41
42         /* this first ref is stored in the NS tailq below */
43         kref_init(&vmnt->mnt_kref, fake_release, 1);
44         /* Build the vfsmount, if there is no mnt_pt, mnt is the root vfsmount (for now).
45          * fields related to the actual FS, like the sb and the mnt_root are set in
46          * the fs-specific get_sb() call. */
47         if (!mnt_pt) {
48                 vmnt->mnt_parent = NULL;
49                 vmnt->mnt_mountpoint = NULL;
50         } else { /* common case, but won't be tested til we try to mount another FS */
51                 mnt_pt->d_mount_point = TRUE;
52                 mnt_pt->d_mounted_fs = vmnt;
53                 kref_get(&vmnt->mnt_kref, 1); /* held by mnt_pt */
54                 vmnt->mnt_parent = mnt_pt->d_sb->s_mount;
55                 vmnt->mnt_mountpoint = mnt_pt;
56         }
57         TAILQ_INIT(&vmnt->mnt_child_mounts);
58         vmnt->mnt_flags = flags;
59         vmnt->mnt_devname = dev_name;
60         vmnt->mnt_namespace = ns;
61         kref_get(&ns->kref, 1); /* held by vmnt */
62
63         /* Read in / create the SB */
64         sb = fs->get_sb(fs, flags, dev_name, vmnt);
65         if (!sb)
66                 panic("You're FS sucks");
67
68         /* TODO: consider moving this into get_sb or something, in case the SB
69          * already exists (mounting again) (if we support that) */
70         spin_lock(&super_blocks_lock);
71         TAILQ_INSERT_TAIL(&super_blocks, sb, s_list); /* storing a ref here... */
72         spin_unlock(&super_blocks_lock);
73
74         /* Update holding NS */
75         spin_lock(&ns->lock);
76         TAILQ_INSERT_TAIL(&ns->vfsmounts, vmnt, mnt_list);
77         spin_unlock(&ns->lock);
78         /* note to self: so, right after this point, the NS points to the root FS
79          * mount (we return the mnt, which gets assigned), the root mnt has a dentry
80          * for /, backed by an inode, with a SB prepped and in memory. */
81         return vmnt;
82 }
83
84 void vfs_init(void)
85 {
86         struct fs_type *fs;
87
88         dentry_kcache = kmem_cache_create("dentry", sizeof(struct dentry),
89                                           __alignof__(struct dentry), 0, 0, 0);
90         inode_kcache = kmem_cache_create("inode", sizeof(struct inode),
91                                          __alignof__(struct inode), 0, 0, 0);
92         file_kcache = kmem_cache_create("file", sizeof(struct file),
93                                         __alignof__(struct file), 0, 0, 0);
94         /* default NS never dies, +1 to exist */
95         kref_init(&default_ns.kref, fake_release, 1);
96         spinlock_init(&default_ns.lock);
97         default_ns.root = NULL;
98         TAILQ_INIT(&default_ns.vfsmounts);
99
100         /* build list of all FS's in the system.  put yours here.  if this is ever
101          * done on the fly, we'll need to lock. */
102         TAILQ_INSERT_TAIL(&file_systems, &kfs_fs_type, list);
103         TAILQ_FOREACH(fs, &file_systems, list)
104                 printk("Supports the %s Filesystem\n", fs->name);
105
106         /* mounting KFS at the root (/), pending root= parameters */
107         // TODO: linux creates a temp root_fs, then mounts the real root onto that
108         default_ns.root = mount_fs(&kfs_fs_type, "RAM", NULL, 0, &default_ns);
109
110         printk("vfs_init() completed\n");
111 }
112
113 /* Builds / populates the qstr of a dentry based on its d_iname.  If there is an
114  * l_name, (long), it will use that instead of the inline name.  This will
115  * probably change a bit. */
116 void qstr_builder(struct dentry *dentry, char *l_name)
117 {
118         dentry->d_name.name = l_name ? l_name : dentry->d_iname;
119         // TODO: pending what we actually do in d_hash
120         //dentry->d_name.hash = dentry->d_op->d_hash(dentry, &dentry->d_name); 
121         dentry->d_name.hash = 0xcafebabe;
122         dentry->d_name.len = strnlen(dentry->d_name.name, MAX_FILENAME_SZ);
123 }
124
125 /* Useful little helper - return the string ptr for a given file */
126 char *file_name(struct file *file)
127 {
128         return file->f_dentry->d_name.name;
129 }
130
131 /* Some issues with this, coupled closely to fs_lookup.  This assumes that
132  * negative dentries are not returned (might differ from linux) */
133 static struct dentry *do_lookup(struct dentry *parent, char *name)
134 {
135         struct dentry *dentry;
136         /* TODO: look up in the dentry cache first */
137         dentry = get_dentry(parent->d_sb, parent, name);
138         dentry = parent->d_inode->i_op->lookup(parent->d_inode, dentry, 0);
139         /* insert in dentry cache */
140         /* TODO: if the following are done by us, how do we know the i_ino?
141          * also need to handle inodes that are already read in!  For now, we're
142          * going to have the FS handle it in it's lookup() method: 
143          * - get a new inode
144          * - read in the inode
145          * - put in the inode cache */
146         return dentry;
147 }
148
149 /* Walk up one directory, being careful of mountpoints, namespaces, and the top
150  * of the FS */
151 static int climb_up(struct nameidata *nd)
152 {
153         // TODO
154         warn("Climbing up (../) in path lookup not supported yet!");
155         return 0;
156 }
157
158 /* Update ND such that it represents having followed dentry.  IAW the nd
159  * refcnting rules, we need to decref any references that were in there before
160  * they get clobbered. */
161 static int next_link(struct dentry *dentry, struct nameidata *nd)
162 {
163         assert(nd->dentry && nd->mnt);
164         /* update the dentry */
165         kref_get(&dentry->d_kref, 1);
166         kref_put(&nd->dentry->d_kref);
167         nd->dentry = dentry;
168         /* update the mount, if we need to */
169         if (dentry->d_sb->s_mount != nd->mnt) {
170                 kref_get(&dentry->d_sb->s_mount->mnt_kref, 1);
171                 kref_put(&nd->mnt->mnt_kref);
172                 nd->mnt = dentry->d_sb->s_mount;
173         }
174         return 0;
175 }
176
177 static int follow_mount(struct nameidata *nd)
178 {
179         /* Detect mount, follow, etc... (TODO!) */
180         return 0;
181 }
182
183 static int follow_symlink(struct nameidata *nd)
184 {
185         /* Detect symlink, LOOKUP_FOLLOW, follow it, etc... (TODO!) */
186         return 0;
187 }
188
189 /* Resolves the links in a basic path walk.  0 for success, -EWHATEVER
190  * otherwise.  The final lookup is returned via nd. */
191 static int link_path_walk(char *path, struct nameidata *nd)
192 {
193         struct dentry *link_dentry;
194         struct inode *link_inode, *nd_inode;
195         char *next_slash;
196         char *link = path;
197         int error;
198
199         /* skip all leading /'s */
200         while (*link == '/')
201                 link++;
202         /* if there's nothing left (null terminated), we're done */
203         if (*link == '\0')
204                 return 0;
205         /* TODO: deal with depth and LOOKUP_FOLLOW, important for symlinks */
206
207         /* iterate through each intermediate link of the path.  in general, nd
208          * tracks where we are in the path, as far as dentries go.  once we have the
209          * next dentry, we try to update nd based on that dentry.  link is the part
210          * of the path string that we are looking up */
211         while (1) {
212                 nd_inode = nd->dentry->d_inode;
213                 if ((error = check_perms(nd_inode, nd->intent)))
214                         return error;
215                 /* find the next link, break out if it is the end */
216                 next_slash = strchr(link, '/');
217                 if (!next_slash)
218                         break;
219                 else
220                         if (*(next_slash + 1) == '\0') {
221                                 /* trailing slash on the path meant the target is a dir */
222                                 nd->flags |= LOOKUP_DIRECTORY;
223                                 *next_slash = '\0';
224                                 break;
225                         }
226                 /* skip over any interim ./ */
227                 if (!strncmp("./", link, 2)) {
228                         link = next_slash + 1;
229                         continue;
230                 }
231                 /* Check for "../", walk up */
232                 if (!strncmp("../", link, 3)) {
233                         climb_up(nd);
234                         link = next_slash + 2;
235                         continue;
236                 }
237                 *next_slash = '\0';
238                 link_dentry = do_lookup(nd->dentry, link);
239                 *next_slash = '/';
240                 if (!link_dentry)
241                         return -ENOENT;
242                 /* make link_dentry the current step/answer */
243                 next_link(link_dentry, nd);
244                 kref_put(&link_dentry->d_kref); /* do_lookup gave us a refcnt dentry */
245                 /* we could be on a mountpoint or a symlink - need to follow them */
246                 follow_mount(nd);
247                 follow_symlink(nd);
248                 if (!(nd->dentry->d_inode->i_type & FS_I_DIR))
249                         return -ENOTDIR;
250                 /* move through the path string to the next entry */
251                 link = next_slash + 1;
252         }
253         /* now, we're on the last link of the path */
254         /* if we just want the parent, leave now.  and save the name of the link
255          * (last) and the type (last_type).  Note that using the qstr in this manner
256          * only allows us to use the qstr as long as the path is a valid string. */
257         if (nd->flags & LOOKUP_PARENT) {
258                 /* consider using a slimmer qstr_builder for this */
259                 nd->last.name = link;
260                 nd->last.len = strlen(link);
261                 nd->last.hash = nd->dentry->d_op->d_hash(nd->dentry, &nd->last);
262                 return 0;
263         }
264         /* deal with some weird cases with . and .. (completely untested) */
265         if (!strcmp(".", link))
266                 return 0;
267         if (!strcmp("..", link))
268                 return climb_up(nd);
269         link_dentry = do_lookup(nd->dentry, link);
270         if (!link_dentry)
271                 return -ENOENT;
272         next_link(link_dentry, nd);
273         kref_put(&link_dentry->d_kref); /* do_lookup gave us a refcnt dentry */
274         follow_mount(nd);
275         follow_symlink(nd);
276         /* If we wanted a directory, but didn't get one, error out */
277         if ((nd->flags & LOOKUP_DIRECTORY) &&
278            !(nd->dentry->d_inode->i_type & FS_I_DIR))
279                 return -ENOTDIR;
280         return 0;
281 }
282
283 /* Given path, return the inode for the final dentry.  The ND should be
284  * initialized for the first call - specifically, we need the intent. 
285  * LOOKUP_PARENT and friends go in this flags var.
286  *
287  * TODO: this should consider the intent.  Note that creating requires writing
288  * to the last directory.
289  *
290  * Need to be careful too.  While the path has been copied-in to the kernel,
291  * it's still user input.  */
292 int path_lookup(char *path, int flags, struct nameidata *nd)
293 {
294         printd("Path lookup for %s\n", path);
295         /* we allow absolute lookups with no process context */
296         if (path[0] == '/') {                   /* absolute lookup */
297                 if (!current)
298                         nd->dentry = default_ns.root->mnt_root;
299                 else
300                         nd->dentry = current->fs_env.root;      
301         } else {                                                /* relative lookup */
302                 assert(current);
303                 /* Don't need to lock on the fs_env since we're reading one item */
304                 nd->dentry = current->fs_env.pwd;       
305         }
306         nd->mnt = nd->dentry->d_sb->s_mount;
307         /* Whenever references get put in the nd, incref them.  Whenever they are
308          * removed, decref them. */
309         kref_get(&nd->mnt->mnt_kref, 1);
310         kref_get(&nd->dentry->d_kref, 1);
311         nd->flags = flags;
312         nd->depth = 0;                                  /* used in symlink following */
313         return link_path_walk(path, nd);        
314 }
315
316 /* Call this after any use of path_lookup when you are done with its results,
317  * regardless of whether it succeeded or not.  It will free any references */
318 void path_release(struct nameidata *nd)
319 {
320         kref_put(&nd->dentry->d_kref);
321         kref_put(&nd->mnt->mnt_kref);
322 }
323
324 /* Seems convenient: Given a path, return the appropriate file.  The reference
325  * returned is refcounted (which is done by open()).  TODO: make sure the called
326  * functions do error checking and propagate errno. */
327 struct file *path_to_file(char *path)
328 {
329         struct file *f = 0;
330         struct nameidata nd = {0};
331         if (path_lookup(path, 0, &nd))
332                 return 0;
333         f = kmem_cache_alloc(file_kcache, 0);
334         if (!f) {
335                 path_release(&nd);
336                 return 0;
337         }
338         if (nd.dentry->d_inode->i_fop->open(nd.dentry->d_inode, f)) {
339                 path_release(&nd);
340                 kmem_cache_free(file_kcache, f);
341                 return 0;
342         }
343         path_release(&nd);
344         assert(kref_refcnt(&f->f_kref) == 1);
345         return f;
346 }
347
348 /* Superblock functions */
349
350 /* Helper to alloc and initialize a generic superblock.  This handles all the
351  * VFS related things, like lists.  Each FS will need to handle its own things
352  * in it's *_get_sb(), usually involving reading off the disc. */
353 struct super_block *get_sb(void)
354 {
355         struct super_block *sb = kmalloc(sizeof(struct super_block), 0);
356         sb->s_dirty = FALSE;
357         spinlock_init(&sb->s_lock);
358         kref_init(&sb->s_kref, fake_release, 1); /* for the ref passed out */
359         TAILQ_INIT(&sb->s_inodes);
360         TAILQ_INIT(&sb->s_dirty_i);
361         TAILQ_INIT(&sb->s_io_wb);
362         SLIST_INIT(&sb->s_anon_d);
363         TAILQ_INIT(&sb->s_files);
364         sb->s_fs_info = 0; // can override somewhere else
365         return sb;
366 }
367
368 /* Final stages of initializing a super block, including creating and linking
369  * the root dentry, root inode, vmnt, and sb.  The d_op and root_ino are
370  * FS-specific, but otherwise it's FS-independent, tricky, and not worth having
371  * around multiple times.
372  *
373  * Not the world's best interface, so it's subject to change, esp since we're
374  * passing (now 3) FS-specific things. */
375 void init_sb(struct super_block *sb, struct vfsmount *vmnt,
376              struct dentry_operations *d_op, unsigned long root_ino,
377              void *d_fs_info)
378 {
379         /* Build and init the first dentry / inode.  The dentry ref is stored later
380          * by vfsmount's mnt_root.  The parent is dealt with later. */
381         struct dentry *d_root = get_dentry(sb, 0,  "/");        /* probably right */
382
383         /* a lot of here on down is normally done in lookup() */
384         d_root->d_op = d_op;
385         d_root->d_fs_info = d_fs_info;
386         struct inode *inode = sb->s_op->alloc_inode(sb);
387         if (!inode)
388                 panic("This FS sucks!");
389         d_root->d_inode = inode;                                /* storing the inode's kref here */
390         TAILQ_INSERT_TAIL(&inode->i_dentry, d_root, d_alias);   /* weak ref */
391         inode->i_ino = root_ino;
392         /* TODO: add the inode to the appropriate list (off i_list) */
393         /* TODO: do we need to read in the inode?  can we do this on demand? */
394         /* if this FS is already mounted, we'll need to do something different. */
395         sb->s_op->read_inode(inode);
396         /* Link the dentry and SB to the VFS mount */
397         vmnt->mnt_root = d_root;                                /* ref comes from get_dentry */
398         vmnt->mnt_sb = sb;
399         /* If there is no mount point, there is no parent.  This is true only for
400          * the rootfs. */
401         if (vmnt->mnt_mountpoint) {
402                 kref_get(&vmnt->mnt_mountpoint->d_kref, 1);     /* held by d_root */
403                 d_root->d_parent = vmnt->mnt_mountpoint;        /* dentry of the root */
404         }
405         /* insert the dentry into the dentry cache.  when's the earliest we can?
406          * when's the earliest we should?  what about concurrent accesses to the
407          * same dentry?  should be locking the dentry... */
408         dcache_put(d_root); // TODO: should set a d_flag too
409 }
410
411 /* Dentry Functions */
412
413 /* Helper to alloc and initialize a generic dentry.  The following needs to be
414  * set still: d_op, d_fs_info (opt), d_inode, connect the inode to the dentry
415  * (and up the d_kref again), maybe dcache_put().  The FS related things need to
416  * be done in fs_create and fs_mkdir.
417  *
418  * If the name is longer than the inline name, it will kmalloc a buffer, so
419  * don't worry about the storage for *name after calling this. */
420 struct dentry *get_dentry(struct super_block *sb, struct dentry *parent,
421                           char *name)
422 {
423         assert(name);
424         size_t name_len = strnlen(name, MAX_FILENAME_SZ);       /* not including \0! */
425         struct dentry *dentry = kmem_cache_alloc(dentry_kcache, 0);
426         char *l_name = 0;
427
428         //memset(dentry, 0, sizeof(struct dentry));
429         kref_init(&dentry->d_kref, dentry_release, 1);  /* this ref is returned */
430         spinlock_init(&dentry->d_lock);
431         TAILQ_INIT(&dentry->d_subdirs);
432         dentry->d_time = 0;
433         kref_get(&sb->s_kref, 1);
434         dentry->d_sb = sb;                                      /* storing a ref here... */
435         dentry->d_mount_point = FALSE;
436         dentry->d_mounted_fs = 0;
437         if (parent)                                                     /* no parent for rootfs mount */
438                 kref_get(&parent->d_kref, 1);
439         dentry->d_parent = parent;
440         dentry->d_flags = 0;                            /* related to its dcache state */
441         dentry->d_fs_info = 0;
442         SLIST_INIT(&dentry->d_bucket);
443         if (name_len < DNAME_INLINE_LEN) {
444                 strncpy(dentry->d_iname, name, name_len);
445                 dentry->d_iname[name_len] = '\0';
446                 qstr_builder(dentry, 0);
447         } else {
448                 l_name = kmalloc(name_len + 1, 0);
449                 assert(l_name);
450                 strncpy(l_name, name, name_len);
451                 l_name[name_len] = '\0';
452                 qstr_builder(dentry, l_name);
453         }
454         /* Catch bugs by aggressively zeroing this (o/w we use old stuff) */
455         dentry->d_op = 0;
456         dentry->d_fs_info = 0;
457         dentry->d_inode = 0;
458         return dentry;
459 }
460
461 /* Adds a dentry to the dcache. */
462 void dcache_put(struct dentry *dentry)
463 {
464 #if 0 /* pending a more thorough review of the dcache */
465         /* TODO: should set a d_flag too */
466         spin_lock(&dcache_lock);
467         SLIST_INSERT_HEAD(&dcache, dentry, d_hash);
468         spin_unlock(&dcache_lock);
469 #endif
470 }
471
472 /* Cleans up the dentry (after ref == 0).  We still may want it, and this is
473  * where we should add it to the dentry cache.  (TODO).  For now, we do nothing,
474  * since we don't have a dcache.
475  * 
476  * This has to handle two types of dentries: full ones (ones that had been used)
477  * and ones that had been just for lookups - hence the checks for d_op and
478  * d_inode.
479  *
480  * Note that dentries pin and kref their inodes.  When all the dentries are
481  * gone, we want the inode to be released via kref.  The inode has internal /
482  * weak references to the dentry, which are not refcounted. */
483 void dentry_release(struct kref *kref)
484 {
485         struct dentry *dentry = container_of(kref, struct dentry, d_kref);
486         printd("Freeing dentry %08p: %s\n", dentry, dentry->d_name.name);
487         /* Might not have a d_op, if it was involved in a failed operation */
488         if (dentry->d_op && dentry->d_op->d_release)
489                 dentry->d_op->d_release(dentry);
490         /* TODO: check/test the boundaries on this. */
491         if (dentry->d_name.len > DNAME_INLINE_LEN)
492                 kfree((void*)dentry->d_name.name);
493         kref_put(&dentry->d_sb->s_kref);
494         if (dentry->d_mounted_fs)
495                 kref_put(&dentry->d_mounted_fs->mnt_kref);
496         if (dentry->d_inode) {
497                 TAILQ_REMOVE(&dentry->d_inode->i_dentry, dentry, d_alias);
498                 kref_put(&dentry->d_inode->i_kref);     /* but dentries kref inodes */
499         }
500         kmem_cache_free(dentry_kcache, dentry);
501 }
502
503 /* Inode Functions */
504
505 /* Returns 0 if the given mode is acceptable for the inode, and an appropriate
506  * error code if not.  Needs to be writen, based on some sensible rules, and
507  * will also probably use 'current' */
508 int check_perms(struct inode *inode, int access_mode)
509 {
510         return 0;       /* anything goes! */
511 }
512
513 /* Called after all external refs are gone to clean up the inode.  Once this is
514  * called, all dentries pointing here are already done (one of them triggered
515  * this via kref_put(). */
516 void inode_release(struct kref *kref)
517 {
518         struct inode *inode = container_of(kref, struct inode, i_kref);
519         inode->i_sb->s_op->destroy_inode(inode);
520         kref_put(&inode->i_sb->s_kref);
521         assert(inode->i_mapping == &inode->i_pm);
522         /* TODO: (BDEV) */
523         // kref_put(inode->i_bdev->kref); /* assuming it's a bdev */
524 }
525
526 /* File functions */
527
528 /* Read count bytes from the file into buf, starting at *offset, which is increased
529  * accordingly, returning the number of bytes transfered.  Most filesystems will
530  * use this function for their f_op->read.  Note, this uses the page cache.
531  * Want to try out page remapping later on... */
532 ssize_t generic_file_read(struct file *file, char *buf, size_t count,
533                           off_t *offset)
534 {
535         struct page *page;
536         int error;
537         off_t page_off;
538         unsigned long first_idx, last_idx;
539         size_t copy_amt;
540         char *buf_end;
541
542         /* Consider pushing some error checking higher in the VFS */
543         if (!count)
544                 return 0;
545         if (*offset == file->f_dentry->d_inode->i_size)
546                 return 0; /* EOF */
547         /* Make sure we don't go past the end of the file */
548         if (*offset + count > file->f_dentry->d_inode->i_size) {
549                 count = file->f_dentry->d_inode->i_size - *offset;
550         }
551         page_off = *offset & (PGSIZE - 1);
552         first_idx = *offset >> PGSHIFT;
553         last_idx = (*offset + count) >> PGSHIFT;
554         buf_end = buf + count;
555         /* For each file page, make sure it's in the page cache, then copy it out.
556          * TODO: will probably need to consider concurrently truncated files here.*/
557         for (int i = first_idx; i <= last_idx; i++) {
558                 error = file_load_page(file, i, &page);
559                 assert(!error); /* TODO: handle ENOMEM and friends */
560                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
561                 /* TODO: think about this.  if it's a user buffer, we're relying on
562                  * current to detect whose it is (which should work for async calls).
563                  * Also, need to propagate errors properly...  Probably should do a
564                  * user_mem_check, then free, and also to make a distinction between
565                  * when the kernel wants a read/write (TODO: KFOP) */
566                 if (current) {
567                         memcpy_to_user(current, buf, page2kva(page) + page_off, copy_amt);
568                 } else {
569                         memcpy(buf, page2kva(page) + page_off, copy_amt);
570                 }
571                 buf += copy_amt;
572                 page_off = 0;
573                 page_decref(page);      /* it's still in the cache, we just don't need it */
574         }
575         assert(buf == buf_end);
576         *offset += count;
577         return count;
578 }
579
580 /* Write count bytes from buf to the file, starting at *offset, which is increased
581  * accordingly, returning the number of bytes transfered.  Most filesystems will
582  * use this function for their f_op->write.  Note, this uses the page cache.
583  * Changes don't get flushed to disc til there is an fsync, page cache eviction,
584  * or other means of trying to writeback the pages. */
585 ssize_t generic_file_write(struct file *file, const char *buf, size_t count,
586                            off_t *offset)
587 {
588         struct page *page;
589         int error;
590         off_t page_off;
591         unsigned long first_idx, last_idx;
592         size_t copy_amt;
593         const char *buf_end;
594
595         /* Consider pushing some error checking higher in the VFS */
596         if (!count)
597                 return 0;
598         /* Extend the file.  Should put more checks in here, and maybe do this per
599          * page in the for loop below. */
600         if (*offset + count > file->f_dentry->d_inode->i_size)
601                 file->f_dentry->d_inode->i_size = *offset + count;
602         page_off = *offset & (PGSIZE - 1);
603         first_idx = *offset >> PGSHIFT;
604         last_idx = (*offset + count) >> PGSHIFT;
605         buf_end = buf + count;
606         /* For each file page, make sure it's in the page cache, then write it.*/
607         for (int i = first_idx; i <= last_idx; i++) {
608                 error = file_load_page(file, i, &page);
609                 assert(!error); /* TODO: handle ENOMEM and friends */
610                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
611                 /* TODO: think about this.  if it's a user buffer, we're relying on
612                  * current to detect whose it is (which should work for async calls). */
613                 if (current) {
614                         memcpy_to_user(current, page2kva(page) + page_off, buf, copy_amt);
615                 } else {
616                         memcpy(page2kva(page) + page_off, buf, copy_amt);
617                 }
618                 buf += copy_amt;
619                 page_off = 0;
620                 page_decref(page);      /* it's still in the cache, we just don't need it */
621         }
622         assert(buf == buf_end);
623         *offset += count;
624         return count;
625 }
626
627 /* Opens the file, using permissions from current for lack of a better option.
628  * Called by sys_open.  This will return 0 on failure, and set errno.
629  * There's a lot of stuff that we don't do, esp related to permission checking
630  * and file truncating.
631  * TODO: open and create should set errno and propagate it up. */
632 struct file *do_file_open(char *path, int flags, int mode)
633 {
634         struct file *file = 0;
635         struct dentry *file_d;
636         struct inode *parent_i;
637         struct nameidata nd_r = {0}, *nd = &nd_r;
638         int lookup_flags = LOOKUP_PARENT;
639         int error = 0;
640
641         /* lookup the parent */
642         nd->intent = flags & (O_RDONLY|O_WRONLY|O_RDWR);
643         if (flags & O_CREAT)
644                 lookup_flags |= LOOKUP_CREATE;
645         error = path_lookup(path, lookup_flags, nd);
646         if (error) {
647                 set_errno(current_tf, -error);
648                 return 0;
649         }
650         /* see if the target is there, handle accordingly */
651         file_d = do_lookup(nd->dentry, nd->last.name); 
652         if (!file_d) {
653                 if (!(flags & O_CREAT)) {
654                         path_release(nd);
655                         set_errno(current_tf, EACCES);
656                         return 0;
657                 }
658                 /* Create the inode/file.  get a fresh dentry too: */
659                 file_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
660                 parent_i = nd->dentry->d_inode;
661                 /* TODO: mode should be & ~umask.  Note that mode only applies to future
662                  * opens. */
663                 if (parent_i->i_op->create(parent_i, file_d, mode, nd)) {
664                         kref_put(&file_d->d_kref);
665                         path_release(nd);
666                         set_errno(current_tf, EFAULT);
667                         return 0;
668                 }
669                 /* when we have notions of users, do something here: */
670                 file_d->d_inode->i_uid = 0;
671                 file_d->d_inode->i_gid = 0;
672                 file_d->d_inode->i_flags = flags & ~(O_CREAT|O_TRUNC|O_EXCL|O_NOCTTY);
673                 dcache_put(file_d);
674         } else {        /* the file exists */
675                 if ((flags & O_CREAT) && (flags & O_EXCL)) {
676                         /* wanted to create, not open, bail out */
677                         kref_put(&file_d->d_kref);
678                         path_release(nd);
679                         set_errno(current_tf, EACCES);
680                         return 0;
681                 }
682         }
683         /* now open the file (freshly created or if it already existed).  At this
684          * point, file_d is a refcnt'd dentry, regardless of which branch we took.*/
685         file = kmem_cache_alloc(file_kcache, 0);
686         if (!file) {
687                 kref_put(&file_d->d_kref);
688                 path_release(nd);
689                 set_errno(current_tf, ENOMEM);
690                 return 0;
691         }
692         if (flags & O_TRUNC)
693                 warn("File truncation not supported yet.");
694         if (file_d->d_inode->i_fop->open(file_d->d_inode, file)) {
695                 kref_put(&file_d->d_kref);
696                 path_release(nd);
697                 kmem_cache_free(file_kcache, file);
698                 set_errno(current_tf, ENOENT);
699                 return 0;
700         }
701         /* TODO: check the inode's mode (S_XXX) against the flags O_RDWR */
702         /* f_mode stores how the FILE is open, regardless of the mode */
703         file->f_mode = flags & (O_RDONLY|O_WRONLY|O_RDWR);
704         kref_put(&file_d->d_kref);
705         path_release(nd);
706         return file;
707 }
708
709 /* Closes a file, fsync, whatever else is necessary.  Called when the kref hits
710  * 0.  Note that the file is not refcounted on the s_files list, nor is the
711  * f_mapping refcounted (it is pinned by the i_mapping). */
712 void file_release(struct kref *kref)
713 {
714         struct file *file = container_of(kref, struct file, f_kref);
715
716         struct super_block *sb = file->f_dentry->d_sb;
717         spin_lock(&sb->s_lock);
718         TAILQ_REMOVE(&sb->s_files, file, f_list);
719         spin_unlock(&sb->s_lock);
720
721         /* TODO: fsync (BLK).  also, we may want to parallelize the blocking that
722          * could happen in here (spawn kernel threads)... */
723         file->f_op->release(file->f_dentry->d_inode, file);
724         /* Clean up the other refs we hold */
725         kref_put(&file->f_dentry->d_kref);
726         kref_put(&file->f_vfsmnt->mnt_kref);
727         kmem_cache_free(file_kcache, file);
728 }
729
730 /* Page cache functions */
731
732 /* Looks up the index'th page in the page map, returning an incref'd reference,
733  * or 0 if it was not in the map. */
734 struct page *pm_find_page(struct page_map *pm, unsigned long index)
735 {
736         spin_lock(&pm->pm_tree_lock);
737         struct page *page = (struct page*)radix_lookup(&pm->pm_tree, index);
738         if (page)
739                 page_incref(page);
740         spin_unlock(&pm->pm_tree_lock);
741         return page;
742 }
743
744 /* Attempts to insert the page into the page_map, returns 0 for success, or an
745  * error code if there was one already (EEXIST) or we ran out of memory
746  * (ENOMEM).  On success, this will preemptively lock the page, and will also
747  * store a reference to the page in the pm. */
748 int pm_insert_page(struct page_map *pm, unsigned long index, struct page *page)
749 {
750         int error = 0;
751         spin_lock(&pm->pm_tree_lock);
752         error = radix_insert(&pm->pm_tree, index, page);
753         if (!error) {
754                 page_incref(page);
755                 page->pg_flags |= PG_LOCKED;
756                 page->pg_mapping = pm;
757                 page->pg_index = index;
758                 pm->pm_num_pages++;
759         }
760         spin_unlock(&pm->pm_tree_lock);
761         return error;
762 }
763
764 /* Removes the page, including its reference.  Not sure yet what interface we
765  * want to this (pm and index or page), and this has never been used.  There are
766  * also issues with when you want to call this, since a page in the cache may be
767  * mmap'd by someone else. */
768 int pm_remove_page(struct page_map *pm, struct page *page)
769 {
770         void *retval;
771         warn("pm_remove_page() hasn't been thought through or tested.");
772         spin_lock(&pm->pm_tree_lock);
773         retval = radix_delete(&pm->pm_tree, page->pg_index);
774         spin_unlock(&pm->pm_tree_lock);
775         assert(retval == (void*)page);
776         page_decref(page);
777         page->pg_mapping = 0;
778         page->pg_index = 0;
779         pm->pm_num_pages--;
780         return 0;
781 }
782
783 /* Makes sure the index'th page from file is loaded in the page cache and
784  * returns its location via **pp.  Note this will give you a refcnt'd reference.
785  * This may block! TODO: (BLK) */
786 int file_load_page(struct file *file, unsigned long index, struct page **pp)
787 {
788         struct page_map *pm = file->f_mapping;
789         struct page *page;
790         int error;
791         bool page_was_mapped = TRUE;
792
793         page = pm_find_page(pm, index);
794         while (!page) {
795                 /* kpage_alloc, since we want the page to persist after the proc
796                  * dies (can be used by others, until the inode shuts down). */
797                 if (kpage_alloc(&page))
798                         return -ENOMEM;
799                 /* might want to initialize other things, perhaps in page_alloc() */
800                 page->pg_flags = 0;
801                 error = pm_insert_page(pm, index, page);
802                 switch (error) {
803                         case 0:
804                                 page_was_mapped = FALSE;
805                                 break;
806                         case -EEXIST:
807                                 /* the page was mapped already (benign race), just get rid of
808                                  * our page and try again (the only case that uses the while) */
809                                 page_decref(page);
810                                 page = pm_find_page(pm, index);
811                                 break;
812                         default:
813                                 /* something is wrong, bail out! */
814                                 page_decref(page);
815                                 return error;
816                 }
817         }
818         *pp = page;
819         /* if the page was in the map, we need to do some checks, and might have to
820          * read in the page later.  If the page was freshly inserted to the pm by
821          * us, we skip this since we are the one doing the readpage(). */
822         if (page_was_mapped) {
823                 /* is it already here and up to date?  if so, we're done */
824                 if (page->pg_flags & PG_UPTODATE)
825                         return 0;
826                 /* if not, try to lock the page (could BLOCK) */
827                 lock_page(page);
828                 /* we got it, is our page still in the cache?  check the mapping.  if
829                  * not, start over, perhaps with EAGAIN and outside support */
830                 if (!page->pg_mapping)
831                         panic("Page is not in the mapping!  Haven't implemented this!");
832                 /* double check, are we up to date?  if so, we're done */
833                 if (page->pg_flags & PG_UPTODATE) {
834                         unlock_page(page);
835                         return 0;
836                 }
837         }
838         /* if we're here, the page is locked by us, and it needs to be read in */
839         assert(page->pg_mapping == pm);
840         error = pm->pm_op->readpage(file, page);
841         assert(!error);
842         /* Try to sleep on the IO.  The page will be unlocked when the IO is done */
843         lock_page(page);
844         unlock_page(page);
845         assert(page->pg_flags & PG_UPTODATE);
846         return 0;
847 }
848
849 /* Process-related File management functions */
850
851 /* Given any FD, get the appropriate file, 0 o/w */
852 struct file *get_file_from_fd(struct files_struct *open_files, int file_desc)
853 {
854         struct file *retval = 0;
855         spin_lock(&open_files->lock);
856         if (file_desc < open_files->max_fdset) {
857                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
858                         /* while max_files and max_fdset might not line up, we should never
859                          * have a valid fdset higher than files */
860                         assert(file_desc < open_files->max_files);
861                         retval = open_files->fd[file_desc];
862                         assert(retval);
863                         kref_get(&retval->f_kref, 1);
864                 }
865         }
866         spin_unlock(&open_files->lock);
867         return retval;
868 }
869
870 /* Remove FD from the open files, if it was there, and return f.  Currently,
871  * this decref's f, so the return value is not consumable or even usable.  This
872  * hasn't been thought through yet. */
873 struct file *put_file_from_fd(struct files_struct *open_files, int file_desc)
874 {
875         struct file *file = 0;
876         spin_lock(&open_files->lock);
877         if (file_desc < open_files->max_fdset) {
878                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
879                         /* while max_files and max_fdset might not line up, we should never
880                          * have a valid fdset higher than files */
881                         assert(file_desc < open_files->max_files);
882                         file = open_files->fd[file_desc];
883                         open_files->fd[file_desc] = 0;
884                         CLR_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc);
885                         /* the if case is due to files (stdin) without a *file yet */
886                         if (file)
887                                 kref_put(&file->f_kref);
888                 }
889         }
890         spin_unlock(&open_files->lock);
891         return file;
892 }
893
894 /* Inserts the file in the files_struct, returning the corresponding new file
895  * descriptor, or an error code.  We currently grab the first open FD. */
896 int insert_file(struct files_struct *open_files, struct file *file)
897 {
898         int slot = -1;
899         spin_lock(&open_files->lock);
900         for (int i = 0; i < open_files->max_fdset; i++) {
901                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, i))
902                         continue;
903                 slot = i;
904                 SET_BITMASK_BIT(open_files->open_fds->fds_bits, slot);
905                 assert(slot < open_files->max_files && open_files->fd[slot] == 0);
906                 kref_get(&file->f_kref, 1);
907                 open_files->fd[slot] = file;
908                 if (slot >= open_files->next_fd)
909                         open_files->next_fd = slot + 1;
910                 break;
911         }
912         if (slot == -1) /* should expand the FD array and fd_set */
913                 warn("Ran out of file descriptors, deal with me!");
914         spin_unlock(&open_files->lock);
915         return slot;
916 }
917
918 /* Closes all open files.  Mostly just a "put" for all files. */
919 void close_all_files(struct files_struct *open_files)
920 {
921         struct file *file;
922         spin_lock(&open_files->lock);
923         for (int i = 0; i < open_files->max_fdset; i++) {
924                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, i)) {
925                         /* while max_files and max_fdset might not line up, we should never
926                          * have a valid fdset higher than files */
927                         assert(i < open_files->max_files);
928                         file = open_files->fd[i];
929                         open_files->fd[i] = 0;
930                         /* the if case is due to files (stdin) without a *file yet */
931                         if (file)
932                                 kref_put(&file->f_kref);
933                         CLR_BITMASK_BIT(open_files->open_fds->fds_bits, i);
934                 }
935         }
936         spin_unlock(&open_files->lock);
937 }