33e8396db584ce79a4aa0ded54c34e2a99533a92
[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 #include <smp.h>
18
19 struct sb_tailq super_blocks = TAILQ_HEAD_INITIALIZER(super_blocks);
20 spinlock_t super_blocks_lock = SPINLOCK_INITIALIZER;
21 struct fs_type_tailq file_systems = TAILQ_HEAD_INITIALIZER(file_systems);
22 struct namespace default_ns;
23 // TODO: temp dcache, holds all dentries ever for now
24 struct dentry_slist dcache = SLIST_HEAD_INITIALIZER(dcache);
25 spinlock_t dcache_lock = SPINLOCK_INITIALIZER;
26
27 struct kmem_cache *dentry_kcache; // not to be confused with the dcache
28 struct kmem_cache *inode_kcache;
29 struct kmem_cache *file_kcache;
30
31 /* Mounts fs from dev_name at mnt_pt in namespace ns.  There could be no mnt_pt,
32  * such as with the root of (the default) namespace.  Not sure how it would work
33  * with multiple namespaces on the same FS yet.  Note if you mount the same FS
34  * multiple times, you only have one FS still (and one SB).  If we ever support
35  * that... */
36 struct vfsmount *mount_fs(struct fs_type *fs, char *dev_name,
37                           struct dentry *mnt_pt, int flags,
38                           struct namespace *ns)
39 {
40         struct super_block *sb;
41         struct vfsmount *vmnt = kmalloc(sizeof(struct vfsmount), 0);
42
43         /* this first ref is stored in the NS tailq below */
44         kref_init(&vmnt->mnt_kref, fake_release, 1);
45         /* Build the vfsmount, if there is no mnt_pt, mnt is the root vfsmount (for now).
46          * fields related to the actual FS, like the sb and the mnt_root are set in
47          * the fs-specific get_sb() call. */
48         if (!mnt_pt) {
49                 vmnt->mnt_parent = NULL;
50                 vmnt->mnt_mountpoint = NULL;
51         } else { /* common case, but won't be tested til we try to mount another FS */
52                 mnt_pt->d_mount_point = TRUE;
53                 mnt_pt->d_mounted_fs = vmnt;
54                 kref_get(&vmnt->mnt_kref, 1); /* held by mnt_pt */
55                 vmnt->mnt_parent = mnt_pt->d_sb->s_mount;
56                 vmnt->mnt_mountpoint = mnt_pt;
57         }
58         TAILQ_INIT(&vmnt->mnt_child_mounts);
59         vmnt->mnt_flags = flags;
60         vmnt->mnt_devname = dev_name;
61         vmnt->mnt_namespace = ns;
62         kref_get(&ns->kref, 1); /* held by vmnt */
63
64         /* Read in / create the SB */
65         sb = fs->get_sb(fs, flags, dev_name, vmnt);
66         if (!sb)
67                 panic("You're FS sucks");
68
69         /* TODO: consider moving this into get_sb or something, in case the SB
70          * already exists (mounting again) (if we support that) */
71         spin_lock(&super_blocks_lock);
72         TAILQ_INSERT_TAIL(&super_blocks, sb, s_list); /* storing a ref here... */
73         spin_unlock(&super_blocks_lock);
74
75         /* Update holding NS */
76         spin_lock(&ns->lock);
77         TAILQ_INSERT_TAIL(&ns->vfsmounts, vmnt, mnt_list);
78         spin_unlock(&ns->lock);
79         /* note to self: so, right after this point, the NS points to the root FS
80          * mount (we return the mnt, which gets assigned), the root mnt has a dentry
81          * for /, backed by an inode, with a SB prepped and in memory. */
82         return vmnt;
83 }
84
85 void vfs_init(void)
86 {
87         struct fs_type *fs;
88
89         dentry_kcache = kmem_cache_create("dentry", sizeof(struct dentry),
90                                           __alignof__(struct dentry), 0, 0, 0);
91         inode_kcache = kmem_cache_create("inode", sizeof(struct inode),
92                                          __alignof__(struct inode), 0, 0, 0);
93         file_kcache = kmem_cache_create("file", sizeof(struct file),
94                                         __alignof__(struct file), 0, 0, 0);
95         /* default NS never dies, +1 to exist */
96         kref_init(&default_ns.kref, fake_release, 1);
97         spinlock_init(&default_ns.lock);
98         default_ns.root = NULL;
99         TAILQ_INIT(&default_ns.vfsmounts);
100
101         /* build list of all FS's in the system.  put yours here.  if this is ever
102          * done on the fly, we'll need to lock. */
103         TAILQ_INSERT_TAIL(&file_systems, &kfs_fs_type, list);
104         TAILQ_FOREACH(fs, &file_systems, list)
105                 printk("Supports the %s Filesystem\n", fs->name);
106
107         /* mounting KFS at the root (/), pending root= parameters */
108         // TODO: linux creates a temp root_fs, then mounts the real root onto that
109         default_ns.root = mount_fs(&kfs_fs_type, "RAM", NULL, 0, &default_ns);
110
111         printk("vfs_init() completed\n");
112 }
113
114 /* Builds / populates the qstr of a dentry based on its d_iname.  If there is an
115  * l_name, (long), it will use that instead of the inline name.  This will
116  * probably change a bit. */
117 void qstr_builder(struct dentry *dentry, char *l_name)
118 {
119         dentry->d_name.name = l_name ? l_name : dentry->d_iname;
120         // TODO: pending what we actually do in d_hash
121         //dentry->d_name.hash = dentry->d_op->d_hash(dentry, &dentry->d_name); 
122         dentry->d_name.hash = 0xcafebabe;
123         dentry->d_name.len = strnlen(dentry->d_name.name, MAX_FILENAME_SZ);
124 }
125
126 /* Useful little helper - return the string ptr for a given file */
127 char *file_name(struct file *file)
128 {
129         return file->f_dentry->d_name.name;
130 }
131
132 /* Some issues with this, coupled closely to fs_lookup.  This assumes that
133  * negative dentries are not returned (might differ from linux) */
134 static struct dentry *do_lookup(struct dentry *parent, char *name)
135 {
136         struct dentry *dentry;
137         /* TODO: look up in the dentry cache first */
138         dentry = get_dentry(parent->d_sb, parent, name);
139         dentry = parent->d_inode->i_op->lookup(parent->d_inode, dentry, 0);
140         /* insert in dentry cache */
141         /* TODO: if the following are done by us, how do we know the i_ino?
142          * also need to handle inodes that are already read in!  For now, we're
143          * going to have the FS handle it in it's lookup() method: 
144          * - get a new inode
145          * - read in the inode
146          * - put in the inode cache */
147         return dentry;
148 }
149
150 /* Update ND such that it represents having followed dentry.  IAW the nd
151  * refcnting rules, we need to decref any references that were in there before
152  * they get clobbered. */
153 static int next_link(struct dentry *dentry, struct nameidata *nd)
154 {
155         assert(nd->dentry && nd->mnt);
156         /* update the dentry */
157         kref_get(&dentry->d_kref, 1);
158         kref_put(&nd->dentry->d_kref);
159         nd->dentry = dentry;
160         /* update the mount, if we need to */
161         if (dentry->d_sb->s_mount != nd->mnt) {
162                 kref_get(&dentry->d_sb->s_mount->mnt_kref, 1);
163                 kref_put(&nd->mnt->mnt_kref);
164                 nd->mnt = dentry->d_sb->s_mount;
165         }
166         return 0;
167 }
168
169 /* Walk up one directory, being careful of mountpoints, namespaces, and the top
170  * of the FS */
171 static int climb_up(struct nameidata *nd)
172 {
173         printd("CLIMB_UP, from %s\n", nd->dentry->d_name.name);
174         /* Top of the world, just return.  Should also check for being at the top of
175          * the current process's namespace (TODO) */
176         if (!nd->dentry->d_parent)
177                 return -1;
178         /* Check if we are at the top of a mount, if so, we need to follow
179          * backwards, and then climb_up from that one.  We might need to climb
180          * multiple times if we mount multiple FSs at the same spot (highly
181          * unlikely).  This is completely untested.  Might recurse instead. */
182         while (nd->mnt->mnt_root == nd->dentry) {
183                 if (!nd->mnt->mnt_parent) {
184                         warn("Might have expected a parent vfsmount (dentry had a parent)");
185                         return -1;
186                 }
187                 next_link(nd->mnt->mnt_mountpoint, nd);
188         }
189         /* Backwards walk (no mounts or any other issues now). */
190         next_link(nd->dentry->d_parent, nd);
191         printd("CLIMB_UP, to   %s\n", nd->dentry->d_name.name);
192         return 0;
193 }
194
195 static int follow_mount(struct nameidata *nd)
196 {
197         /* Detect mount, follow, etc... (TODO!) */
198         return 0;
199 }
200
201 static int link_path_walk(char *path, struct nameidata *nd);
202
203 /* When nd->dentry is for a symlink, this will recurse and follow that symlink,
204  * so that nd contains the results of following the symlink (dentry and mnt).
205  * Returns when it isn't a symlink, 1 on following a link, and < 0 on error. */
206 static int follow_symlink(struct nameidata *nd)
207 {
208         int retval;
209         char *symname;
210         if (nd->dentry->d_inode->i_type != FS_I_SYMLINK)
211                 return 0;
212         if (nd->depth > MAX_SYMLINK_DEPTH)
213                 return -ELOOP;
214         printd("Following symlink for dentry %08p %s\n", nd->dentry,
215                nd->dentry->d_name.name);
216         nd->depth++;
217         symname = nd->dentry->d_inode->i_op->readlink(nd->dentry);
218         /* We need to pin in nd->dentry (the dentry of the symlink), since we need
219          * it's symname's storage to stay in memory throughout the upcoming
220          * link_path_walk().  The last_sym gets decreffed when we path_release() or
221          * follow another symlink. */
222         if (nd->last_sym)
223                 kref_put(&nd->last_sym->d_kref);
224         kref_get(&nd->dentry->d_kref, 1);
225         nd->last_sym = nd->dentry;
226         /* If this an absolute path in the symlink, we need to free the old path and
227          * start over, otherwise, we continue from the PARENT of nd (the symlink) */
228         if (symname[0] == '/') {
229                 path_release(nd);
230                 if (!current)
231                         nd->dentry = default_ns.root->mnt_root;
232                 else
233                         nd->dentry = current->fs_env.root;      
234                 nd->mnt = nd->dentry->d_sb->s_mount;
235                 kref_get(&nd->mnt->mnt_kref, 1);
236                 kref_get(&nd->dentry->d_kref, 1);
237         } else {
238                 climb_up(nd);
239         }
240         /* either way, keep on walking in the free world! */
241         retval = link_path_walk(symname, nd);
242         return (retval == 0 ? 1 : retval);
243 }
244
245 /* Little helper, to make it easier to break out of the nested loops.  Will also
246  * '\0' out the first slash if it's slashes all the way down.  Or turtles. */
247 static bool packed_trailing_slashes(char *first_slash)
248 {
249         for (char *i = first_slash; *i == '/'; i++) {
250                 if (*(i + 1) == '\0') {
251                         *first_slash = '\0';
252                         return TRUE;
253                 }
254         }
255         return FALSE;
256 }
257
258 /* Simple helper to set nd to track it's last name to be Name.  Also be careful
259  * with the storage of name.  Don't use and nd's name past the lifetime of the
260  * string used in the path_lookup()/link_path_walk/whatever.  Consider replacing
261  * parts of this with a qstr builder.  Note this uses the dentry's d_op, which
262  * might not be the dentry we care about. */
263 static void stash_nd_name(struct nameidata *nd, char *name)
264 {
265         nd->last.name = name;
266         nd->last.len = strlen(name);
267         nd->last.hash = nd->dentry->d_op->d_hash(nd->dentry, &nd->last);
268 }
269
270 /* Resolves the links in a basic path walk.  0 for success, -EWHATEVER
271  * otherwise.  The final lookup is returned via nd. */
272 static int link_path_walk(char *path, struct nameidata *nd)
273 {
274         struct dentry *link_dentry;
275         struct inode *link_inode, *nd_inode;
276         char *next_slash;
277         char *link = path;
278         int error;
279
280         /* Prevent crazy recursion */
281         if (nd->depth > MAX_SYMLINK_DEPTH)
282                 return -ELOOP;
283         /* skip all leading /'s */
284         while (*link == '/')
285                 link++;
286         /* if there's nothing left (null terminated), we're done */
287         if (*link == '\0')
288                 return 0;
289         /* iterate through each intermediate link of the path.  in general, nd
290          * tracks where we are in the path, as far as dentries go.  once we have the
291          * next dentry, we try to update nd based on that dentry.  link is the part
292          * of the path string that we are looking up */
293         while (1) {
294                 nd_inode = nd->dentry->d_inode;
295                 if ((error = check_perms(nd_inode, nd->intent)))
296                         return error;
297                 /* find the next link, break out if it is the end */
298                 next_slash = strchr(link, '/');
299                 if (!next_slash) {
300                         break;
301                 } else {
302                         if (packed_trailing_slashes(next_slash)) {
303                                 nd->flags |= LOOKUP_DIRECTORY;
304                                 break;
305                         }
306                 }
307                 /* skip over any interim ./ */
308                 if (!strncmp("./", link, 2))
309                         goto next_loop;
310                 /* Check for "../", walk up */
311                 if (!strncmp("../", link, 3)) {
312                         climb_up(nd);
313                         goto next_loop;
314                 }
315                 *next_slash = '\0';
316                 link_dentry = do_lookup(nd->dentry, link);
317                 *next_slash = '/';
318                 if (!link_dentry)
319                         return -ENOENT;
320                 /* make link_dentry the current step/answer */
321                 next_link(link_dentry, nd);
322                 kref_put(&link_dentry->d_kref); /* do_lookup gave us a refcnt dentry */
323                 /* we could be on a mountpoint or a symlink - need to follow them */
324                 follow_mount(nd);
325                 if ((error = follow_symlink(nd)) < 0)
326                         return error;
327                 /* Turn off a possible DIRECTORY lookup, which could have been set
328                  * during the follow_symlink (a symlink could have had a directory at
329                  * the end), though it was in the middle of the real path. */
330                 nd->flags &= ~LOOKUP_DIRECTORY;
331                 if (!(nd->dentry->d_inode->i_type & FS_I_DIR))
332                         return -ENOTDIR;
333 next_loop:
334                 /* move through the path string to the next entry */
335                 link = next_slash + 1;
336                 /* advance past any other interim slashes.  we know we won't hit the end
337                  * due to the for loop check above */
338                 while (*link == '/')
339                         link++;
340         }
341         /* Now, we're on the last link of the path.  We need to deal with with . and
342          * .. .  This might be weird with PARENT lookups - not sure what semantics
343          * we want exactly.  This will give the parent of whatever the PATH was
344          * supposed to look like.  Note that ND currently points to the parent of
345          * the last item (link). */
346         if (!strcmp(".", link)) {
347                 if (nd->flags & LOOKUP_PARENT) {
348                         stash_nd_name(nd, nd->dentry->d_name.name);
349                         climb_up(nd);
350                 }
351                 return 0;
352         }
353         if (!strcmp("..", link)) {
354                 climb_up(nd);
355                 if (nd->flags & LOOKUP_PARENT) {
356                         stash_nd_name(nd, nd->dentry->d_name.name);
357                         climb_up(nd);
358                 }
359                 return 0;
360         }
361         /* need to attempt to look it up, in case it's a symlink */
362         link_dentry = do_lookup(nd->dentry, link);
363         if (!link_dentry) {
364                 /* if there's no dentry, we are okay if we are looking for the parent */
365                 if (nd->flags & LOOKUP_PARENT) {
366                         stash_nd_name(nd, link);
367                         return 0;
368                 } else {
369                         return -ENOENT;
370                 }
371         }
372         next_link(link_dentry, nd);
373         kref_put(&link_dentry->d_kref); /* do_lookup gave us a refcnt'd dentry */
374         /* at this point, nd is on the final link, but it might be a symlink */
375         if (nd->flags & LOOKUP_FOLLOW) {
376                 error = follow_symlink(nd);
377                 if (error < 0)
378                         return error;
379                 /* if we actually followed a symlink, then nd is set and we're done */
380                 if (error > 0)
381                         return 0;
382         }
383         /* One way or another, nd is on the last element of the path, symlinks and
384          * all.  Now we need to climb up to set nd back on the parent, if that's
385          * what we wanted */
386         if (nd->flags & LOOKUP_PARENT) {
387                 stash_nd_name(nd, link_dentry->d_name.name);
388                 climb_up(nd);
389                 return 0;
390         }
391         /* now, we have the dentry set, and don't want the parent, but might be on a
392          * mountpoint still.  FYI: this hasn't been thought through completely. */
393         follow_mount(nd);
394         /* If we wanted a directory, but didn't get one, error out */
395         if ((nd->flags & LOOKUP_DIRECTORY) &&
396            !(nd->dentry->d_inode->i_type & FS_I_DIR))
397                 return -ENOTDIR;
398         return 0;
399 }
400
401 /* Given path, return the inode for the final dentry.  The ND should be
402  * initialized for the first call - specifically, we need the intent. 
403  * LOOKUP_PARENT and friends go in the flags var, which is not the intent.
404  *
405  * Need to be careful too.  While the path has been copied-in to the kernel,
406  * it's still user input.  */
407 int path_lookup(char *path, int flags, struct nameidata *nd)
408 {
409         printd("Path lookup for %s\n", path);
410         /* we allow absolute lookups with no process context */
411         if (path[0] == '/') {                   /* absolute lookup */
412                 if (!current)
413                         nd->dentry = default_ns.root->mnt_root;
414                 else
415                         nd->dentry = current->fs_env.root;      
416         } else {                                                /* relative lookup */
417                 assert(current);
418                 /* Don't need to lock on the fs_env since we're reading one item */
419                 nd->dentry = current->fs_env.pwd;       
420         }
421         nd->mnt = nd->dentry->d_sb->s_mount;
422         /* Whenever references get put in the nd, incref them.  Whenever they are
423          * removed, decref them. */
424         kref_get(&nd->mnt->mnt_kref, 1);
425         kref_get(&nd->dentry->d_kref, 1);
426         nd->flags = flags;
427         nd->depth = 0;                                  /* used in symlink following */
428         return link_path_walk(path, nd);        
429 }
430
431 /* Call this after any use of path_lookup when you are done with its results,
432  * regardless of whether it succeeded or not.  It will free any references */
433 void path_release(struct nameidata *nd)
434 {
435         kref_put(&nd->dentry->d_kref);
436         kref_put(&nd->mnt->mnt_kref);
437         /* Free the last symlink dentry used, if there was one */
438         if (nd->last_sym) {
439                 kref_put(&nd->last_sym->d_kref);
440                 nd->last_sym = 0;                       /* catch reuse bugs */
441         }
442 }
443
444 /* Superblock functions */
445
446 /* Helper to alloc and initialize a generic superblock.  This handles all the
447  * VFS related things, like lists.  Each FS will need to handle its own things
448  * in it's *_get_sb(), usually involving reading off the disc. */
449 struct super_block *get_sb(void)
450 {
451         struct super_block *sb = kmalloc(sizeof(struct super_block), 0);
452         sb->s_dirty = FALSE;
453         spinlock_init(&sb->s_lock);
454         kref_init(&sb->s_kref, fake_release, 1); /* for the ref passed out */
455         TAILQ_INIT(&sb->s_inodes);
456         TAILQ_INIT(&sb->s_dirty_i);
457         TAILQ_INIT(&sb->s_io_wb);
458         SLIST_INIT(&sb->s_anon_d);
459         TAILQ_INIT(&sb->s_files);
460         sb->s_fs_info = 0; // can override somewhere else
461         return sb;
462 }
463
464 /* Final stages of initializing a super block, including creating and linking
465  * the root dentry, root inode, vmnt, and sb.  The d_op and root_ino are
466  * FS-specific, but otherwise it's FS-independent, tricky, and not worth having
467  * around multiple times.
468  *
469  * Not the world's best interface, so it's subject to change, esp since we're
470  * passing (now 3) FS-specific things. */
471 void init_sb(struct super_block *sb, struct vfsmount *vmnt,
472              struct dentry_operations *d_op, unsigned long root_ino,
473              void *d_fs_info)
474 {
475         /* Build and init the first dentry / inode.  The dentry ref is stored later
476          * by vfsmount's mnt_root.  The parent is dealt with later. */
477         struct dentry *d_root = get_dentry(sb, 0,  "/");        /* probably right */
478
479         /* a lot of here on down is normally done in lookup() or create, since
480          * get_dentry isn't a fully usable dentry.  The two FS-specific settings are
481          * normally inherited from a parent within the same FS in get_dentry, but we
482          * have none here. */
483         d_root->d_op = d_op;
484         d_root->d_fs_info = d_fs_info;
485         struct inode *inode = get_inode(d_root);
486         if (!inode)
487                 panic("This FS sucks!");
488         inode->i_ino = root_ino;
489         /* TODO: add the inode to the appropriate list (off i_list) */
490         /* TODO: do we need to read in the inode?  can we do this on demand? */
491         /* if this FS is already mounted, we'll need to do something different. */
492         sb->s_op->read_inode(inode);
493         /* Link the dentry and SB to the VFS mount */
494         vmnt->mnt_root = d_root;                                /* ref comes from get_dentry */
495         vmnt->mnt_sb = sb;
496         /* If there is no mount point, there is no parent.  This is true only for
497          * the rootfs. */
498         if (vmnt->mnt_mountpoint) {
499                 kref_get(&vmnt->mnt_mountpoint->d_kref, 1);     /* held by d_root */
500                 d_root->d_parent = vmnt->mnt_mountpoint;        /* dentry of the root */
501         }
502         /* insert the dentry into the dentry cache.  when's the earliest we can?
503          * when's the earliest we should?  what about concurrent accesses to the
504          * same dentry?  should be locking the dentry... */
505         dcache_put(d_root); // TODO: should set a d_flag too
506         kref_put(&inode->i_kref);               /* give up the ref from get_inode() */
507 }
508
509 /* Dentry Functions */
510
511 /* Helper to alloc and initialize a generic dentry.  The following needs to be
512  * set still: d_op (if no parent), d_fs_info (opt), d_inode, connect the inode
513  * to the dentry (and up the d_kref again), maybe dcache_put().  The inode
514  * stitching is done in get_inode() or lookup (depending on the FS).
515  * The setting of the d_op might be problematic when dealing with mounts.  Just
516  * overwrite it.
517  *
518  * If the name is longer than the inline name, it will kmalloc a buffer, so
519  * don't worry about the storage for *name after calling this. */
520 struct dentry *get_dentry(struct super_block *sb, struct dentry *parent,
521                           char *name)
522 {
523         assert(name);
524         size_t name_len = strnlen(name, MAX_FILENAME_SZ);       /* not including \0! */
525         struct dentry *dentry = kmem_cache_alloc(dentry_kcache, 0);
526         char *l_name = 0;
527
528         if (!dentry)
529                 return 0;
530         //memset(dentry, 0, sizeof(struct dentry));
531         kref_init(&dentry->d_kref, dentry_release, 1);  /* this ref is returned */
532         spinlock_init(&dentry->d_lock);
533         TAILQ_INIT(&dentry->d_subdirs);
534         dentry->d_time = 0;
535         kref_get(&sb->s_kref, 1);
536         dentry->d_sb = sb;                                      /* storing a ref here... */
537         dentry->d_mount_point = FALSE;
538         dentry->d_mounted_fs = 0;
539         if (parent)     {                                               /* no parent for rootfs mount */
540                 kref_get(&parent->d_kref, 1);
541                 dentry->d_op = parent->d_op;    /* d_op set in init_sb for parentless */
542         }
543         dentry->d_parent = parent;
544         dentry->d_flags = 0;                            /* related to its dcache state */
545         dentry->d_fs_info = 0;
546         SLIST_INIT(&dentry->d_bucket);
547         if (name_len < DNAME_INLINE_LEN) {
548                 strncpy(dentry->d_iname, name, name_len);
549                 dentry->d_iname[name_len] = '\0';
550                 qstr_builder(dentry, 0);
551         } else {
552                 l_name = kmalloc(name_len + 1, 0);
553                 assert(l_name);
554                 strncpy(l_name, name, name_len);
555                 l_name[name_len] = '\0';
556                 qstr_builder(dentry, l_name);
557         }
558         /* Catch bugs by aggressively zeroing this (o/w we use old stuff) */
559         dentry->d_inode = 0;
560         return dentry;
561 }
562
563 /* Adds a dentry to the dcache. */
564 void dcache_put(struct dentry *dentry)
565 {
566 #if 0 /* pending a more thorough review of the dcache */
567         /* TODO: should set a d_flag too */
568         spin_lock(&dcache_lock);
569         SLIST_INSERT_HEAD(&dcache, dentry, d_hash);
570         spin_unlock(&dcache_lock);
571 #endif
572 }
573
574 /* Cleans up the dentry (after ref == 0).  We still may want it, and this is
575  * where we should add it to the dentry cache.  (TODO).  For now, we do nothing,
576  * since we don't have a dcache.
577  * 
578  * This has to handle two types of dentries: full ones (ones that had been used)
579  * and ones that had been just for lookups - hence the check for d_inode.
580  *
581  * Note that dentries pin and kref their inodes.  When all the dentries are
582  * gone, we want the inode to be released via kref.  The inode has internal /
583  * weak references to the dentry, which are not refcounted. */
584 void dentry_release(struct kref *kref)
585 {
586         struct dentry *dentry = container_of(kref, struct dentry, d_kref);
587         printd("Freeing dentry %08p: %s\n", dentry, dentry->d_name.name);
588         assert(dentry->d_op);   /* catch bugs.  a while back, some lacked d_op */
589         dentry->d_op->d_release(dentry);
590         /* TODO: check/test the boundaries on this. */
591         if (dentry->d_name.len > DNAME_INLINE_LEN)
592                 kfree((void*)dentry->d_name.name);
593         kref_put(&dentry->d_sb->s_kref);
594         if (dentry->d_mounted_fs)
595                 kref_put(&dentry->d_mounted_fs->mnt_kref);
596         if (dentry->d_inode) {
597                 TAILQ_REMOVE(&dentry->d_inode->i_dentry, dentry, d_alias);
598                 kref_put(&dentry->d_inode->i_kref);     /* but dentries kref inodes */
599         }
600         kmem_cache_free(dentry_kcache, dentry);
601 }
602
603 /* Looks up the dentry for the given path, returning a refcnt'd dentry (or 0).
604  * Permissions are applied for the current user, which is quite a broken system
605  * at the moment.  Flags are lookup flags. */
606 struct dentry *lookup_dentry(char *path, int flags)
607 {
608         struct dentry *dentry;
609         struct nameidata nd_r = {0}, *nd = &nd_r;
610         int error;
611
612         error = path_lookup(path, flags, nd);
613         if (error) {
614                 path_release(nd);
615                 set_errno(-error);
616                 return 0;
617         }
618         dentry = nd->dentry;
619         kref_get(&dentry->d_kref, 1);
620         path_release(nd);
621         return dentry;
622 }
623
624 /* Inode Functions */
625
626 /* Creates and initializes a new inode.  Generic fields are filled in.
627  * FS-specific fields are filled in by the callout.  Specific fields are filled
628  * in in read_inode() based on what's on the disk for a given i_no, or when the
629  * inode is created (for new objects).
630  *
631  * i_no is set by the caller.  Note that this means this inode can be for an
632  * inode that is already on disk, or it can be used when creating. */
633 struct inode *get_inode(struct dentry *dentry)
634 {
635         struct super_block *sb = dentry->d_sb;
636         /* FS allocs and sets the following: i_op, i_fop, i_pm.pm_op, and any FS
637          * specific stuff. */
638         struct inode *inode = sb->s_op->alloc_inode(sb);
639         if (!inode) {
640                 set_errno(ENOMEM);
641                 return 0;
642         }
643         TAILQ_INSERT_HEAD(&sb->s_inodes, inode, i_sb_list);             /* weak inode ref */
644         TAILQ_INIT(&inode->i_dentry);
645         TAILQ_INSERT_TAIL(&inode->i_dentry, dentry, d_alias);   /* weak dentry ref*/
646         /* one for the dentry->d_inode, one passed out */
647         kref_init(&inode->i_kref, inode_release, 2);
648         dentry->d_inode = inode;
649         inode->i_ino = 0;                                       /* set by caller later */
650         inode->i_blksize = sb->s_blocksize;
651         spinlock_init(&inode->i_lock);
652         inode->i_sb = sb;
653         inode->i_state = 0;                                     /* need real states, like I_NEW */
654         inode->dirtied_when = 0;
655         inode->i_flags = 0;
656         atomic_set(&inode->i_writecount, 0);
657         /* Set up the page_map structures.  Default is to use the embedded one.
658          * Might push some of this back into specific FSs.  For now, the FS tells us
659          * what pm_op they want via i_pm.pm_op, which we use when we point i_mapping
660          * to i_pm. */
661         inode->i_mapping = &inode->i_pm;
662         inode->i_mapping->pm_host = inode;
663         radix_tree_init(&inode->i_mapping->pm_tree);
664         spinlock_init(&inode->i_mapping->pm_tree_lock);
665         inode->i_mapping->pm_flags = 0;
666         return inode;
667 }
668
669 /* Helper op, used when creating regular files, directories, symlinks, etc.
670  * Note we make a distinction between the mode and the file type (for now).
671  * After calling this, call the FS specific version (create or mkdir), which
672  * will set the i_ino, the filetype, and do any other FS-specific stuff.  Also
673  * note that a lot of inode stuff was initialized in get_inode/alloc_inode.  The
674  * stuff here is pertinent to the specific creator (user), mode, and time.  Also
675  * note we don't pass this an nd, like Linux does... */
676 static struct inode *create_inode(struct dentry *dentry, int mode)
677 {
678         /* note it is the i_ino that uniquely identifies a file in the system.
679          * there's a diff between creating an inode (even for an in-use ino) and
680          * then filling it in, and vs creating a brand new one */
681         struct inode *inode = get_inode(dentry);
682         if (!inode)
683                 return 0;
684         inode->i_mode = mode;
685         inode->i_nlink = 1;
686         inode->i_size = 0;
687         inode->i_blocks = 0;
688         inode->i_atime.tv_sec = 0;              /* TODO: now! */
689         inode->i_ctime.tv_sec = 0;
690         inode->i_mtime.tv_sec = 0;
691         inode->i_atime.tv_nsec = 0;             /* are these supposed to be the extra ns? */
692         inode->i_ctime.tv_nsec = 0;
693         inode->i_mtime.tv_nsec = 0;
694         inode->i_bdev = inode->i_sb->s_bdev;
695         /* when we have notions of users, do something here: */
696         inode->i_uid = 0;
697         inode->i_gid = 0;
698         return inode;
699 }
700
701 /* Create a new disk inode in dir associated with dentry, with the given mode.
702  * called when creating a regular file.  dir is the directory/parent.  dentry is
703  * the dentry of the inode we are creating.  Note the lack of the nd... */
704 int create_file(struct inode *dir, struct dentry *dentry, int mode)
705 {
706         struct inode *new_file = create_inode(dentry, mode);
707         if (!new_file)
708                 return -1;
709         dir->i_op->create(dir, dentry, mode, 0);
710         kref_put(&new_file->i_kref);
711         return 0;
712 }
713
714 /* Creates a new inode for a directory associated with dentry in dir with the
715  * given mode. */
716 int create_dir(struct inode *dir, struct dentry *dentry, int mode)
717 {
718         struct inode *new_dir = create_inode(dentry, mode);
719         if (!new_dir)
720                 return -1;
721         dir->i_op->mkdir(dir, dentry, mode);
722         /* Make sure my parent tracks me.  This is okay, since no directory (dir)
723          * can have more than one dentry */
724         struct dentry *parent = TAILQ_FIRST(&dir->i_dentry);
725         assert(parent && parent == TAILQ_LAST(&dir->i_dentry, dentry_tailq));
726         /* parent dentry tracks dentry as a subdir, weak reference */
727         TAILQ_INSERT_TAIL(&parent->d_subdirs, dentry, d_subdirs_link);
728         kref_put(&new_dir->i_kref);
729         return 0;
730 }
731
732 /* Creates a new inode for a symlink associated with dentry in dir, containing
733  * the symlink symname */
734 int create_symlink(struct inode *dir, struct dentry *dentry,
735                    const char *symname, int mode)
736 {
737         struct inode *new_sym = create_inode(dentry, mode);
738         if (!new_sym)
739                 return -1;
740         dir->i_op->symlink(dir, dentry, symname);
741         kref_put(&new_sym->i_kref);
742         return 0;
743 }
744
745 /* Returns 0 if the given mode is acceptable for the inode, and an appropriate
746  * error code if not.  Needs to be writen, based on some sensible rules, and
747  * will also probably use 'current' */
748 int check_perms(struct inode *inode, int access_mode)
749 {
750         return 0;       /* anything goes! */
751 }
752
753 /* Called after all external refs are gone to clean up the inode.  Once this is
754  * called, all dentries pointing here are already done (one of them triggered
755  * this via kref_put(). */
756 void inode_release(struct kref *kref)
757 {
758         struct inode *inode = container_of(kref, struct inode, i_kref);
759         inode->i_sb->s_op->destroy_inode(inode);
760         kref_put(&inode->i_sb->s_kref);
761         assert(inode->i_mapping == &inode->i_pm);
762         kmem_cache_free(inode_kcache, inode);
763         /* TODO: (BDEV) */
764         // kref_put(inode->i_bdev->kref); /* assuming it's a bdev */
765 }
766
767 /* Fills in kstat with the stat information for the inode */
768 void stat_inode(struct inode *inode, struct kstat *kstat)
769 {
770         kstat->st_dev = inode->i_sb->s_dev;
771         kstat->st_ino = inode->i_ino;
772         kstat->st_mode = inode->i_mode;
773         kstat->st_nlink = inode->i_nlink;
774         kstat->st_uid = inode->i_uid;
775         kstat->st_gid = inode->i_gid;
776         kstat->st_rdev = inode->i_rdev;
777         kstat->st_size = inode->i_size;
778         kstat->st_blksize = inode->i_blksize;
779         kstat->st_blocks = inode->i_blocks;
780         kstat->st_atime = inode->i_atime;
781         kstat->st_mtime = inode->i_mtime;
782         kstat->st_ctime = inode->i_ctime;
783 }
784
785 /* File functions */
786
787 /* Read count bytes from the file into buf, starting at *offset, which is increased
788  * accordingly, returning the number of bytes transfered.  Most filesystems will
789  * use this function for their f_op->read.  Note, this uses the page cache.
790  * Want to try out page remapping later on... */
791 ssize_t generic_file_read(struct file *file, char *buf, size_t count,
792                           off_t *offset)
793 {
794         struct page *page;
795         int error;
796         off_t page_off;
797         unsigned long first_idx, last_idx;
798         size_t copy_amt;
799         char *buf_end;
800
801         /* Consider pushing some error checking higher in the VFS */
802         if (!count)
803                 return 0;
804         if (*offset == file->f_dentry->d_inode->i_size)
805                 return 0; /* EOF */
806         /* Make sure we don't go past the end of the file */
807         if (*offset + count > file->f_dentry->d_inode->i_size) {
808                 count = file->f_dentry->d_inode->i_size - *offset;
809         }
810         page_off = *offset & (PGSIZE - 1);
811         first_idx = *offset >> PGSHIFT;
812         last_idx = (*offset + count) >> PGSHIFT;
813         buf_end = buf + count;
814         /* For each file page, make sure it's in the page cache, then copy it out.
815          * TODO: will probably need to consider concurrently truncated files here.*/
816         for (int i = first_idx; i <= last_idx; i++) {
817                 error = file_load_page(file, i, &page);
818                 assert(!error); /* TODO: handle ENOMEM and friends */
819                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
820                 /* TODO: (UMEM) think about this.  if it's a user buffer, we're relying
821                  * on current to detect whose it is (which should work for async calls).
822                  * Also, need to propagate errors properly...  Probably should do a
823                  * user_mem_check, then free, and also to make a distinction between
824                  * when the kernel wants a read/write (TODO: KFOP) */
825                 if (current) {
826                         memcpy_to_user(current, buf, page2kva(page) + page_off, copy_amt);
827                 } else {
828                         memcpy(buf, page2kva(page) + page_off, copy_amt);
829                 }
830                 buf += copy_amt;
831                 page_off = 0;
832                 page_decref(page);      /* it's still in the cache, we just don't need it */
833         }
834         assert(buf == buf_end);
835         *offset += count;
836         return count;
837 }
838
839 /* Write count bytes from buf to the file, starting at *offset, which is increased
840  * accordingly, returning the number of bytes transfered.  Most filesystems will
841  * use this function for their f_op->write.  Note, this uses the page cache.
842  * Changes don't get flushed to disc til there is an fsync, page cache eviction,
843  * or other means of trying to writeback the pages. */
844 ssize_t generic_file_write(struct file *file, const char *buf, size_t count,
845                            off_t *offset)
846 {
847         struct page *page;
848         int error;
849         off_t page_off;
850         unsigned long first_idx, last_idx;
851         size_t copy_amt;
852         const char *buf_end;
853
854         /* Consider pushing some error checking higher in the VFS */
855         if (!count)
856                 return 0;
857         /* Extend the file.  Should put more checks in here, and maybe do this per
858          * page in the for loop below. */
859         if (*offset + count > file->f_dentry->d_inode->i_size)
860                 file->f_dentry->d_inode->i_size = *offset + count;
861         page_off = *offset & (PGSIZE - 1);
862         first_idx = *offset >> PGSHIFT;
863         last_idx = (*offset + count) >> PGSHIFT;
864         buf_end = buf + count;
865         /* For each file page, make sure it's in the page cache, then write it.*/
866         for (int i = first_idx; i <= last_idx; i++) {
867                 error = file_load_page(file, i, &page);
868                 assert(!error); /* TODO: handle ENOMEM and friends */
869                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
870                 /* TODO: (UMEM) (KFOP) think about this.  if it's a user buffer, we're
871                  * relying on current to detect whose it is (which should work for async
872                  * calls). */
873                 if (current) {
874                         memcpy_from_user(current, page2kva(page) + page_off, buf, copy_amt);
875                 } else {
876                         memcpy(page2kva(page) + page_off, buf, copy_amt);
877                 }
878                 buf += copy_amt;
879                 page_off = 0;
880                 page_decref(page);      /* it's still in the cache, we just don't need it */
881         }
882         assert(buf == buf_end);
883         *offset += count;
884         return count;
885 }
886
887 /* Directories usually use this for their read method, which is the way glibc
888  * currently expects us to do a readdir (short of doing linux's getdents).  Will
889  * probably need work, based on whatever real programs want. */
890 ssize_t generic_dir_read(struct file *file, char *u_buf, size_t count,
891                          off_t *offset)
892 {
893         struct kdirent dir_r = {0}, *dirent = &dir_r;
894         unsigned int num_dirents = count / sizeof(struct kdirent);
895         int retval = 1;
896         size_t amt_copied = 0;
897         char *buf_end = u_buf + count;
898
899         if (!count)
900                 return 0;
901         if (*offset % sizeof(struct kdirent)) {
902                 printk("[kernel] the f_pos for a directory should be dirent-aligned\n");
903                 set_errno(EINVAL);
904                 return -1;
905         }
906         /* for now, we need to tell readdir which dirent we want */
907         dirent->d_off = *offset / sizeof(struct kdirent);
908         for (; (u_buf < buf_end) && (retval == 1); u_buf += sizeof(struct kdirent)){
909                 /* TODO: UMEM/KFOP (pin the u_buf in the syscall, ditch the local copy,
910                  * get rid of this memcpy and reliance on current, etc).  Might be
911                  * tricky with the dirent->d_off */
912                 retval = file->f_op->readdir(file, dirent);
913                 if (retval < 0)
914                         break;
915                 if (current) {
916                         memcpy_to_user(current, u_buf, dirent, sizeof(struct dirent));
917                 } else {
918                         memcpy(u_buf, dirent, sizeof(struct dirent));
919                 }
920                 amt_copied += sizeof(struct dirent);
921                 dirent->d_off++;
922         }
923         *offset += amt_copied;
924         return amt_copied;
925 }
926
927 /* Opens the file, using permissions from current for lack of a better option.
928  * It will attempt to create the file if it does not exist and O_CREAT is
929  * specified.  This will return 0 on failure, and set errno.  TODO: There's some
930  * stuff that we don't do, esp related file truncating/creation.  flags are for
931  * opening, the mode is for creating.  The flags related to how to create
932  * (O_CREAT_FLAGS) are handled in this function, not in create_file().
933  *
934  * It's tempting to split this into a do_file_create and a do_file_open, based
935  * on the O_CREAT flag, but the O_CREAT flag can be ignored if the file exists
936  * already and O_EXCL isn't specified.  We could have open call create if it
937  * fails, but for now we'll keep it as is. */
938 struct file *do_file_open(char *path, int flags, int mode)
939 {
940         struct file *file = 0;
941         struct dentry *file_d;
942         struct inode *parent_i;
943         struct nameidata nd_r = {0}, *nd = &nd_r;
944         int error;
945
946         /* this isn't quite right, due to the nature of O_CREAT */
947         if (flags & O_CREAT)
948                 nd->intent = LOOKUP_CREATE;
949         else
950                 nd->intent = LOOKUP_OPEN;
951         /* get the parent, following links.  this means you get the parent of the
952          * final link (which may not be in 'path' in the first place. */
953         error = path_lookup(path, LOOKUP_PARENT | LOOKUP_FOLLOW, nd);
954         if (error) {
955                 path_release(nd);
956                 set_errno(-error);
957                 return 0;
958         }
959         /* see if the target is there, handle accordingly */
960         file_d = do_lookup(nd->dentry, nd->last.name); 
961         if (!file_d) {
962                 if (!(flags & O_CREAT)) {
963                         path_release(nd);
964                         set_errno(ENOENT);
965                         return 0;
966                 }
967                 /* Create the inode/file.  get a fresh dentry too: */
968                 file_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
969                 parent_i = nd->dentry->d_inode;
970                 /* TODO: mode should be & ~umask.  Note that mode technically should
971                  * only apply to future opens, though we apply it immediately. */
972                 if (create_file(parent_i, file_d, mode)) {
973                         kref_put(&file_d->d_kref);
974                         path_release(nd);
975                         return 0;
976                 }
977                 dcache_put(file_d);
978         } else {        /* something already exists (might be a dir) */
979                 if ((flags & O_CREAT) && (flags & O_EXCL)) {
980                         /* wanted to create, not open, bail out */
981                         kref_put(&file_d->d_kref);
982                         path_release(nd);
983                         set_errno(EEXIST);
984                         return 0;
985                 }
986         }
987         /* now open the file (freshly created or if it already existed).  At this
988          * point, file_d is a refcnt'd dentry, regardless of which branch we took.*/
989         if (flags & O_TRUNC)
990                 warn("File truncation not supported yet.");
991         file = dentry_open(file_d, flags);              /* sets errno */
992         if (!file) {
993                 kref_put(&file_d->d_kref);
994                 path_release(nd);
995                 return 0;
996         }
997         kref_put(&file_d->d_kref);
998         path_release(nd);
999         return file;
1000 }
1001
1002 /* Path is the location of the symlink, sometimes called the "new path", and
1003  * symname is who we link to, sometimes called the "old path". */
1004 int do_symlink(char *path, const char *symname, int mode)
1005 {
1006         struct dentry *sym_d;
1007         struct inode *parent_i;
1008         struct nameidata nd_r = {0}, *nd = &nd_r;
1009         int error;
1010
1011         nd->intent = LOOKUP_CREATE;
1012         /* get the parent, but don't follow links */
1013         error = path_lookup(path, LOOKUP_PARENT, nd);
1014         if (error) {
1015                 set_errno(-error);
1016                 path_release(nd);
1017                 return -1;
1018         }
1019         /* see if the target is already there, handle accordingly */
1020         sym_d = do_lookup(nd->dentry, nd->last.name); 
1021         if (sym_d) {
1022                 set_errno(EEXIST);
1023                 kref_put(&sym_d->d_kref);
1024                 path_release(nd);
1025                 return -1;
1026         }
1027         /* Doesn't already exist, let's try to make it: */
1028         sym_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
1029         if (!sym_d) {
1030                 set_errno(ENOMEM);
1031                 path_release(nd);
1032                 return -1;
1033         }
1034         parent_i = nd->dentry->d_inode;
1035         /* TODO: mode should be & ~umask. */
1036         if (create_symlink(parent_i, sym_d, symname, mode)) {
1037                 kref_put(&sym_d->d_kref);
1038                 path_release(nd);
1039                 return -1;
1040         }
1041         dcache_put(sym_d);
1042         kref_put(&sym_d->d_kref);
1043         path_release(nd);
1044         return 0;
1045 }
1046
1047 /* Makes a hard link for the file behind old_path to new_path */
1048 int do_link(char *old_path, char *new_path)
1049 {
1050         struct dentry *link_d, *old_d;
1051         struct inode *inode, *parent_dir;
1052         struct nameidata nd_r = {0}, *nd = &nd_r;
1053         int error;
1054         int retval = -1;
1055
1056         nd->intent = LOOKUP_CREATE;
1057         /* get the absolute parent of the new_path */
1058         error = path_lookup(new_path, LOOKUP_PARENT | LOOKUP_FOLLOW, nd);
1059         if (error) {
1060                 set_errno(-error);
1061                 goto out_path_only;
1062         }
1063         parent_dir = nd->dentry->d_inode;
1064         /* see if the new target is already there, handle accordingly */
1065         link_d = do_lookup(nd->dentry, nd->last.name); 
1066         if (link_d) {
1067                 set_errno(EEXIST);
1068                 goto out_link_d;
1069         }
1070         /* Doesn't already exist, let's try to make it.  Still need to stitch it to
1071          * an inode and set its FS-specific stuff after this.*/
1072         link_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
1073         if (!link_d) {
1074                 set_errno(ENOMEM);
1075                 goto out_path_only;
1076         }
1077         /* Now let's get the old_path target */
1078         old_d = lookup_dentry(old_path, LOOKUP_FOLLOW);
1079         if (!old_d)                                     /* errno set by lookup_dentry */
1080                 goto out_link_d;
1081         /* For now, can only link to files */
1082         if (old_d->d_inode->i_type != FS_I_FILE) {
1083                 set_errno(EPERM);
1084                 goto out_both_ds;
1085         }
1086         /* Must be on the same FS */
1087         if (old_d->d_sb != link_d->d_sb) {
1088                 set_errno(EXDEV);
1089                 goto out_both_ds;
1090         }
1091         /* Do whatever FS specific stuff there is first (which is also a chance to
1092          * bail out). */
1093         error = parent_dir->i_op->link(old_d, parent_dir, link_d);
1094         if (error) {
1095                 set_errno(-error);
1096                 goto out_both_ds;
1097         }
1098         /* Finally stitch it up */
1099         inode = old_d->d_inode;
1100         kref_get(&inode->i_kref, 1);
1101         link_d->d_inode = inode;
1102         inode->i_nlink++;
1103         TAILQ_INSERT_TAIL(&inode->i_dentry, link_d, d_alias);   /* weak ref */
1104         dcache_put(link_d);
1105         retval = 0;                             /* Note the fall through to the exit paths */
1106 out_both_ds:
1107         kref_put(&old_d->d_kref);
1108 out_link_d:
1109         kref_put(&link_d->d_kref);
1110 out_path_only:
1111         path_release(nd);
1112         return retval;
1113 }
1114
1115 /* Checks to see if path can be accessed via mode.  Doesn't do much now.  This
1116  * is an example of decent error propagation from the lower levels via int
1117  * retvals. */
1118 int do_file_access(char *path, int mode)
1119 {
1120         struct nameidata nd_r = {0}, *nd = &nd_r;
1121         int retval = 0;
1122         nd->intent = LOOKUP_ACCESS;
1123         retval = path_lookup(path, 0, nd);
1124         path_release(nd);       
1125         return retval;
1126 }
1127
1128 /* Opens and returns the file specified by dentry */
1129 struct file *dentry_open(struct dentry *dentry, int flags)
1130 {
1131         struct inode *inode;
1132         int desired_mode;
1133         struct file *file = kmem_cache_alloc(file_kcache, 0);
1134         if (!file) {
1135                 set_errno(ENOMEM);
1136                 return 0;
1137         }
1138         inode = dentry->d_inode;
1139         /* Do the mode first, since we can still error out.  f_mode stores how the
1140          * OS file is open, which can be more restrictive than the i_mode */
1141         switch (flags & (O_RDONLY | O_WRONLY | O_RDWR)) {
1142                 case O_RDONLY:
1143                         desired_mode = S_IRUSR;
1144                         break;
1145                 case O_WRONLY:
1146                         desired_mode = S_IWUSR;
1147                         break;
1148                 case O_RDWR:
1149                         desired_mode = S_IRUSR | S_IWUSR;
1150                         break;
1151                 default:
1152                         goto error_access;
1153         }
1154         if (check_perms(inode, desired_mode))
1155                 goto error_access;
1156         file->f_mode = desired_mode;
1157         /* one for the ref passed out, and *none* for the sb TAILQ */
1158         kref_init(&file->f_kref, file_release, 1);
1159         /* Add to the list of all files of this SB */
1160         TAILQ_INSERT_TAIL(&inode->i_sb->s_files, file, f_list);
1161         kref_get(&dentry->d_kref, 1);
1162         file->f_dentry = dentry;
1163         kref_get(&inode->i_sb->s_mount->mnt_kref, 1);
1164         file->f_vfsmnt = inode->i_sb->s_mount;          /* saving a ref to the vmnt...*/
1165         file->f_op = inode->i_fop;
1166         /* Don't store open mode or creation flags */
1167         file->f_flags = flags & ~(O_ACCMODE | O_CREAT_FLAGS);
1168         file->f_pos = 0;
1169         file->f_uid = inode->i_uid;
1170         file->f_gid = inode->i_gid;
1171         file->f_error = 0;
1172 //      struct event_poll_tailq         f_ep_links;
1173         spinlock_init(&file->f_ep_lock);
1174         file->f_fs_info = 0;                                            /* prob overriden by the fs */
1175         file->f_mapping = inode->i_mapping;
1176         file->f_op->open(inode, file);
1177         return file;
1178 error_access:
1179         set_errno(EACCES);
1180         kmem_cache_free(file_kcache, file);
1181         return 0;
1182 }
1183
1184 /* Closes a file, fsync, whatever else is necessary.  Called when the kref hits
1185  * 0.  Note that the file is not refcounted on the s_files list, nor is the
1186  * f_mapping refcounted (it is pinned by the i_mapping). */
1187 void file_release(struct kref *kref)
1188 {
1189         struct file *file = container_of(kref, struct file, f_kref);
1190
1191         struct super_block *sb = file->f_dentry->d_sb;
1192         spin_lock(&sb->s_lock);
1193         TAILQ_REMOVE(&sb->s_files, file, f_list);
1194         spin_unlock(&sb->s_lock);
1195
1196         /* TODO: fsync (BLK).  also, we may want to parallelize the blocking that
1197          * could happen in here (spawn kernel threads)... */
1198         file->f_op->release(file->f_dentry->d_inode, file);
1199         /* Clean up the other refs we hold */
1200         kref_put(&file->f_dentry->d_kref);
1201         kref_put(&file->f_vfsmnt->mnt_kref);
1202         kmem_cache_free(file_kcache, file);
1203 }
1204
1205 /* Page cache functions */
1206
1207 /* Looks up the index'th page in the page map, returning an incref'd reference,
1208  * or 0 if it was not in the map. */
1209 struct page *pm_find_page(struct page_map *pm, unsigned long index)
1210 {
1211         spin_lock(&pm->pm_tree_lock);
1212         struct page *page = (struct page*)radix_lookup(&pm->pm_tree, index);
1213         if (page)
1214                 page_incref(page);
1215         spin_unlock(&pm->pm_tree_lock);
1216         return page;
1217 }
1218
1219 /* Attempts to insert the page into the page_map, returns 0 for success, or an
1220  * error code if there was one already (EEXIST) or we ran out of memory
1221  * (ENOMEM).  On success, this will preemptively lock the page, and will also
1222  * store a reference to the page in the pm. */
1223 int pm_insert_page(struct page_map *pm, unsigned long index, struct page *page)
1224 {
1225         int error = 0;
1226         spin_lock(&pm->pm_tree_lock);
1227         error = radix_insert(&pm->pm_tree, index, page);
1228         if (!error) {
1229                 page_incref(page);
1230                 page->pg_flags |= PG_LOCKED;
1231                 page->pg_mapping = pm;
1232                 page->pg_index = index;
1233                 pm->pm_num_pages++;
1234         }
1235         spin_unlock(&pm->pm_tree_lock);
1236         return error;
1237 }
1238
1239 /* Removes the page, including its reference.  Not sure yet what interface we
1240  * want to this (pm and index or page), and this has never been used.  There are
1241  * also issues with when you want to call this, since a page in the cache may be
1242  * mmap'd by someone else. */
1243 int pm_remove_page(struct page_map *pm, struct page *page)
1244 {
1245         void *retval;
1246         warn("pm_remove_page() hasn't been thought through or tested.");
1247         spin_lock(&pm->pm_tree_lock);
1248         retval = radix_delete(&pm->pm_tree, page->pg_index);
1249         spin_unlock(&pm->pm_tree_lock);
1250         assert(retval == (void*)page);
1251         page_decref(page);
1252         page->pg_mapping = 0;
1253         page->pg_index = 0;
1254         pm->pm_num_pages--;
1255         return 0;
1256 }
1257
1258 /* Makes sure the index'th page from file is loaded in the page cache and
1259  * returns its location via **pp.  Note this will give you a refcnt'd reference.
1260  * This may block! TODO: (BLK) */
1261 int file_load_page(struct file *file, unsigned long index, struct page **pp)
1262 {
1263         struct page_map *pm = file->f_mapping;
1264         struct page *page;
1265         int error;
1266         bool page_was_mapped = TRUE;
1267
1268         page = pm_find_page(pm, index);
1269         while (!page) {
1270                 /* kpage_alloc, since we want the page to persist after the proc
1271                  * dies (can be used by others, until the inode shuts down). */
1272                 if (kpage_alloc(&page))
1273                         return -ENOMEM;
1274                 /* might want to initialize other things, perhaps in page_alloc() */
1275                 page->pg_flags = 0;
1276                 error = pm_insert_page(pm, index, page);
1277                 switch (error) {
1278                         case 0:
1279                                 page_was_mapped = FALSE;
1280                                 break;
1281                         case -EEXIST:
1282                                 /* the page was mapped already (benign race), just get rid of
1283                                  * our page and try again (the only case that uses the while) */
1284                                 page_decref(page);
1285                                 page = pm_find_page(pm, index);
1286                                 break;
1287                         default:
1288                                 /* something is wrong, bail out! */
1289                                 page_decref(page);
1290                                 return error;
1291                 }
1292         }
1293         *pp = page;
1294         /* if the page was in the map, we need to do some checks, and might have to
1295          * read in the page later.  If the page was freshly inserted to the pm by
1296          * us, we skip this since we are the one doing the readpage(). */
1297         if (page_was_mapped) {
1298                 /* is it already here and up to date?  if so, we're done */
1299                 if (page->pg_flags & PG_UPTODATE)
1300                         return 0;
1301                 /* if not, try to lock the page (could BLOCK) */
1302                 lock_page(page);
1303                 /* we got it, is our page still in the cache?  check the mapping.  if
1304                  * not, start over, perhaps with EAGAIN and outside support */
1305                 if (!page->pg_mapping)
1306                         panic("Page is not in the mapping!  Haven't implemented this!");
1307                 /* double check, are we up to date?  if so, we're done */
1308                 if (page->pg_flags & PG_UPTODATE) {
1309                         unlock_page(page);
1310                         return 0;
1311                 }
1312         }
1313         /* if we're here, the page is locked by us, and it needs to be read in */
1314         assert(page->pg_mapping == pm);
1315         error = pm->pm_op->readpage(file, page);
1316         assert(!error);
1317         /* Try to sleep on the IO.  The page will be unlocked when the IO is done */
1318         lock_page(page);
1319         unlock_page(page);
1320         assert(page->pg_flags & PG_UPTODATE);
1321         return 0;
1322 }
1323
1324 /* Process-related File management functions */
1325
1326 /* Given any FD, get the appropriate file, 0 o/w */
1327 struct file *get_file_from_fd(struct files_struct *open_files, int file_desc)
1328 {
1329         struct file *retval = 0;
1330         if (file_desc < 0)
1331                 return 0;
1332         spin_lock(&open_files->lock);
1333         if (file_desc < open_files->max_fdset) {
1334                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
1335                         /* while max_files and max_fdset might not line up, we should never
1336                          * have a valid fdset higher than files */
1337                         assert(file_desc < open_files->max_files);
1338                         retval = open_files->fd[file_desc];
1339                         assert(retval);
1340                         kref_get(&retval->f_kref, 1);
1341                 }
1342         }
1343         spin_unlock(&open_files->lock);
1344         return retval;
1345 }
1346
1347 /* Remove FD from the open files, if it was there, and return f.  Currently,
1348  * this decref's f, so the return value is not consumable or even usable.  This
1349  * hasn't been thought through yet. */
1350 struct file *put_file_from_fd(struct files_struct *open_files, int file_desc)
1351 {
1352         struct file *file = 0;
1353         if (file_desc < 0)
1354                 return 0;
1355         spin_lock(&open_files->lock);
1356         if (file_desc < open_files->max_fdset) {
1357                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
1358                         /* while max_files and max_fdset might not line up, we should never
1359                          * have a valid fdset higher than files */
1360                         assert(file_desc < open_files->max_files);
1361                         file = open_files->fd[file_desc];
1362                         open_files->fd[file_desc] = 0;
1363                         CLR_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc);
1364                         /* the if case is due to files (stdin) without a *file yet */
1365                         if (file)
1366                                 kref_put(&file->f_kref);
1367                 }
1368         }
1369         spin_unlock(&open_files->lock);
1370         return file;
1371 }
1372
1373 /* Inserts the file in the files_struct, returning the corresponding new file
1374  * descriptor, or an error code.  We currently grab the first open FD. */
1375 int insert_file(struct files_struct *open_files, struct file *file)
1376 {
1377         int slot = -1;
1378         spin_lock(&open_files->lock);
1379         for (int i = 0; i < open_files->max_fdset; i++) {
1380                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, i))
1381                         continue;
1382                 slot = i;
1383                 SET_BITMASK_BIT(open_files->open_fds->fds_bits, slot);
1384                 assert(slot < open_files->max_files && open_files->fd[slot] == 0);
1385                 kref_get(&file->f_kref, 1);
1386                 open_files->fd[slot] = file;
1387                 if (slot >= open_files->next_fd)
1388                         open_files->next_fd = slot + 1;
1389                 break;
1390         }
1391         if (slot == -1) /* should expand the FD array and fd_set */
1392                 warn("Ran out of file descriptors, deal with me!");
1393         spin_unlock(&open_files->lock);
1394         return slot;
1395 }
1396
1397 /* Closes all open files.  Mostly just a "put" for all files.  If cloexec, it
1398  * will only close files that are opened with O_CLOEXEC. */
1399 void close_all_files(struct files_struct *open_files, bool cloexec)
1400 {
1401         struct file *file;
1402         spin_lock(&open_files->lock);
1403         for (int i = 0; i < open_files->max_fdset; i++) {
1404                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, i)) {
1405                         /* while max_files and max_fdset might not line up, we should never
1406                          * have a valid fdset higher than files */
1407                         assert(i < open_files->max_files);
1408                         file = open_files->fd[i];
1409                         if (cloexec && !(file->f_flags | O_CLOEXEC))
1410                                 continue;
1411                         open_files->fd[i] = 0;
1412                         /* the if case is due to files (stdin) without a *file yet */
1413                         if (file)
1414                                 kref_put(&file->f_kref);
1415                         CLR_BITMASK_BIT(open_files->open_fds->fds_bits, i);
1416                 }
1417         }
1418         spin_unlock(&open_files->lock);
1419 }
1420
1421 /* Inserts all of the files from src into dst, used by sys_fork(). */
1422 void clone_files(struct files_struct *src, struct files_struct *dst)
1423 {
1424         struct file *file;
1425         spin_lock(&src->lock);
1426         spin_lock(&dst->lock);
1427         for (int i = 0; i < src->max_fdset; i++) {
1428                 if (GET_BITMASK_BIT(src->open_fds->fds_bits, i)) {
1429                         /* while max_files and max_fdset might not line up, we should never
1430                          * have a valid fdset higher than files */
1431                         assert(i < src->max_files);
1432                         file = src->fd[i];
1433                         SET_BITMASK_BIT(dst->open_fds->fds_bits, i);
1434                         assert(i < dst->max_files && dst->fd[i] == 0);
1435                         dst->fd[i] = file;
1436                         /* the if case is due to files (stdin) without a *file yet */
1437                         if (file)
1438                                 kref_get(&file->f_kref, 1);
1439                 }
1440         }
1441         spin_unlock(&dst->lock);
1442         spin_unlock(&src->lock);
1443 }
1444
1445 static void print_dir(struct dentry *dentry, char *buf, int depth)
1446 {
1447         struct dentry *child_d;
1448         struct dirent next;
1449         struct file *dir;
1450         int retval;
1451         int child_num = 0;
1452
1453         if (!dentry->d_inode->i_type & FS_I_DIR) {
1454                 warn("Thought this was only directories!!");
1455                 return;
1456         }
1457         /* Print this dentry */
1458         printk("%s%s/\n", buf, dentry->d_name.name);
1459         if (depth >= 32)
1460                 return;
1461         /* Set buffer for our kids */
1462         buf[depth] = '\t';
1463         dir = dentry_open(dentry, 0);
1464         if (!dir)
1465                 panic("Filesystem seems inconsistent - unable to open a dir!");
1466         /* Process every child, recursing on directories */
1467         while (1) {
1468                 next.d_off = child_num++;
1469                 retval = dir->f_op->readdir(dir, &next);
1470                 if (retval >= 0) {
1471                         /* there is an entry, now get its dentry */
1472                         child_d = do_lookup(dentry, next.d_name);
1473                         if (!child_d)
1474                                 panic("Inconsistent FS, dirent doesn't have a dentry!");
1475                         /* Recurse for directories, or just print the name for others */
1476                         switch (child_d->d_inode->i_type) {
1477                                 case (FS_I_DIR):
1478                                         print_dir(child_d, buf, depth + 1);
1479                                         break;
1480                                 case (FS_I_FILE):
1481                                         printk("%s%s size(B): %d nlink: %d\n", buf, next.d_name,
1482                                                child_d->d_inode->i_size, child_d->d_inode->i_nlink);
1483                                         break;
1484                                 case (FS_I_SYMLINK):
1485                                         printk("%s%s -> %s\n", buf, next.d_name,
1486                                                child_d->d_inode->i_op->readlink(child_d));
1487                                         break;
1488                                 default:
1489                                         warn("Look around you!  Unknown filetype!");
1490                         }
1491                         kref_put(&child_d->d_kref);     
1492                 }
1493                 if (retval <= 0)
1494                         break;
1495         }
1496         /* Reset buffer to the way it was */
1497         buf[depth] = '\0';
1498         kref_put(&dir->f_kref);
1499 }
1500
1501 /* Debugging */
1502 int ls_dash_r(char *path)
1503 {
1504         struct nameidata nd_r = {0}, *nd = &nd_r;
1505         int error;
1506         char buf[32] = {0};
1507
1508         error = path_lookup(path, LOOKUP_ACCESS | LOOKUP_DIRECTORY, nd);
1509         if (error) {
1510                 path_release(nd);
1511                 return error;
1512         }
1513         print_dir(nd->dentry, buf, 0);
1514         path_release(nd);
1515         return 0;
1516 }