sys_chdir()
[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.  Also, if i_nlink == 0, never cache it.
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_parent)
595                 kref_put(&dentry->d_parent->d_kref);
596         if (dentry->d_mounted_fs)
597                 kref_put(&dentry->d_mounted_fs->mnt_kref);
598         if (dentry->d_inode) {
599                 TAILQ_REMOVE(&dentry->d_inode->i_dentry, dentry, d_alias);
600                 kref_put(&dentry->d_inode->i_kref);     /* dentries kref inodes */
601         }
602         kmem_cache_free(dentry_kcache, dentry);
603 }
604
605 /* Looks up the dentry for the given path, returning a refcnt'd dentry (or 0).
606  * Permissions are applied for the current user, which is quite a broken system
607  * at the moment.  Flags are lookup flags. */
608 struct dentry *lookup_dentry(char *path, int flags)
609 {
610         struct dentry *dentry;
611         struct nameidata nd_r = {0}, *nd = &nd_r;
612         int error;
613
614         error = path_lookup(path, flags, nd);
615         if (error) {
616                 path_release(nd);
617                 set_errno(-error);
618                 return 0;
619         }
620         dentry = nd->dentry;
621         kref_get(&dentry->d_kref, 1);
622         path_release(nd);
623         return dentry;
624 }
625
626 /* Inode Functions */
627
628 /* Creates and initializes a new inode.  Generic fields are filled in.
629  * FS-specific fields are filled in by the callout.  Specific fields are filled
630  * in in read_inode() based on what's on the disk for a given i_no, or when the
631  * inode is created (for new objects).
632  *
633  * i_no is set by the caller.  Note that this means this inode can be for an
634  * inode that is already on disk, or it can be used when creating. */
635 struct inode *get_inode(struct dentry *dentry)
636 {
637         struct super_block *sb = dentry->d_sb;
638         /* FS allocs and sets the following: i_op, i_fop, i_pm.pm_op, and any FS
639          * specific stuff. */
640         struct inode *inode = sb->s_op->alloc_inode(sb);
641         if (!inode) {
642                 set_errno(ENOMEM);
643                 return 0;
644         }
645         TAILQ_INSERT_HEAD(&sb->s_inodes, inode, i_sb_list);             /* weak inode ref */
646         TAILQ_INIT(&inode->i_dentry);
647         TAILQ_INSERT_TAIL(&inode->i_dentry, dentry, d_alias);   /* weak dentry ref*/
648         /* one for the dentry->d_inode, one passed out */
649         kref_init(&inode->i_kref, inode_release, 2);
650         dentry->d_inode = inode;
651         inode->i_ino = 0;                                       /* set by caller later */
652         inode->i_blksize = sb->s_blocksize;
653         spinlock_init(&inode->i_lock);
654         inode->i_sb = sb;
655         inode->i_state = 0;                                     /* need real states, like I_NEW */
656         inode->dirtied_when = 0;
657         inode->i_flags = 0;
658         atomic_set(&inode->i_writecount, 0);
659         /* Set up the page_map structures.  Default is to use the embedded one.
660          * Might push some of this back into specific FSs.  For now, the FS tells us
661          * what pm_op they want via i_pm.pm_op, which we use when we point i_mapping
662          * to i_pm. */
663         inode->i_mapping = &inode->i_pm;
664         inode->i_mapping->pm_host = inode;
665         radix_tree_init(&inode->i_mapping->pm_tree);
666         spinlock_init(&inode->i_mapping->pm_tree_lock);
667         inode->i_mapping->pm_flags = 0;
668         return inode;
669 }
670
671 /* Helper op, used when creating regular files, directories, symlinks, etc.
672  * Note we make a distinction between the mode and the file type (for now).
673  * After calling this, call the FS specific version (create or mkdir), which
674  * will set the i_ino, the filetype, and do any other FS-specific stuff.  Also
675  * note that a lot of inode stuff was initialized in get_inode/alloc_inode.  The
676  * stuff here is pertinent to the specific creator (user), mode, and time.  Also
677  * note we don't pass this an nd, like Linux does... */
678 static struct inode *create_inode(struct dentry *dentry, int mode)
679 {
680         /* note it is the i_ino that uniquely identifies a file in the system.
681          * there's a diff between creating an inode (even for an in-use ino) and
682          * then filling it in, and vs creating a brand new one */
683         struct inode *inode = get_inode(dentry);
684         if (!inode)
685                 return 0;
686         inode->i_mode = mode;
687         inode->i_nlink = 1;
688         inode->i_size = 0;
689         inode->i_blocks = 0;
690         inode->i_atime.tv_sec = 0;              /* TODO: now! */
691         inode->i_ctime.tv_sec = 0;
692         inode->i_mtime.tv_sec = 0;
693         inode->i_atime.tv_nsec = 0;             /* are these supposed to be the extra ns? */
694         inode->i_ctime.tv_nsec = 0;
695         inode->i_mtime.tv_nsec = 0;
696         inode->i_bdev = inode->i_sb->s_bdev;
697         /* when we have notions of users, do something here: */
698         inode->i_uid = 0;
699         inode->i_gid = 0;
700         return inode;
701 }
702
703 /* Create a new disk inode in dir associated with dentry, with the given mode.
704  * called when creating a regular file.  dir is the directory/parent.  dentry is
705  * the dentry of the inode we are creating.  Note the lack of the nd... */
706 int create_file(struct inode *dir, struct dentry *dentry, int mode)
707 {
708         struct inode *new_file = create_inode(dentry, mode);
709         if (!new_file)
710                 return -1;
711         dir->i_op->create(dir, dentry, mode, 0);
712         kref_put(&new_file->i_kref);
713         return 0;
714 }
715
716 /* Creates a new inode for a directory associated with dentry in dir with the
717  * given mode. */
718 int create_dir(struct inode *dir, struct dentry *dentry, int mode)
719 {
720         struct inode *new_dir = create_inode(dentry, mode);
721         if (!new_dir)
722                 return -1;
723         dir->i_op->mkdir(dir, dentry, mode);
724         /* Make sure my parent tracks me.  This is okay, since no directory (dir)
725          * can have more than one dentry */
726         struct dentry *parent = TAILQ_FIRST(&dir->i_dentry);
727         assert(parent && parent == TAILQ_LAST(&dir->i_dentry, dentry_tailq));
728         /* parent dentry tracks dentry as a subdir, weak reference */
729         TAILQ_INSERT_TAIL(&parent->d_subdirs, dentry, d_subdirs_link);
730         kref_put(&new_dir->i_kref);
731         return 0;
732 }
733
734 /* Creates a new inode for a symlink associated with dentry in dir, containing
735  * the symlink symname */
736 int create_symlink(struct inode *dir, struct dentry *dentry,
737                    const char *symname, int mode)
738 {
739         struct inode *new_sym = create_inode(dentry, mode);
740         if (!new_sym)
741                 return -1;
742         dir->i_op->symlink(dir, dentry, symname);
743         kref_put(&new_sym->i_kref);
744         return 0;
745 }
746
747 /* Returns 0 if the given mode is acceptable for the inode, and an appropriate
748  * error code if not.  Needs to be writen, based on some sensible rules, and
749  * will also probably use 'current' */
750 int check_perms(struct inode *inode, int access_mode)
751 {
752         return 0;       /* anything goes! */
753 }
754
755 /* Called after all external refs are gone to clean up the inode.  Once this is
756  * called, all dentries pointing here are already done (one of them triggered
757  * this via kref_put(). */
758 void inode_release(struct kref *kref)
759 {
760         struct inode *inode = container_of(kref, struct inode, i_kref);
761         /* If we still have links, just dealloc the in-memory inode.  if we have no
762          * links, we need to delete it too (which calls destroy). */
763         if (inode->i_nlink)
764                 inode->i_sb->s_op->dealloc_inode(inode);
765         else
766                 inode->i_sb->s_op->delete_inode(inode);
767         kref_put(&inode->i_sb->s_kref);
768         assert(inode->i_mapping == &inode->i_pm);
769         kmem_cache_free(inode_kcache, inode);
770         /* TODO: (BDEV) */
771         // kref_put(inode->i_bdev->kref); /* assuming it's a bdev */
772 }
773
774 /* Fills in kstat with the stat information for the inode */
775 void stat_inode(struct inode *inode, struct kstat *kstat)
776 {
777         kstat->st_dev = inode->i_sb->s_dev;
778         kstat->st_ino = inode->i_ino;
779         kstat->st_mode = inode->i_mode;
780         kstat->st_nlink = inode->i_nlink;
781         kstat->st_uid = inode->i_uid;
782         kstat->st_gid = inode->i_gid;
783         kstat->st_rdev = inode->i_rdev;
784         kstat->st_size = inode->i_size;
785         kstat->st_blksize = inode->i_blksize;
786         kstat->st_blocks = inode->i_blocks;
787         kstat->st_atime = inode->i_atime;
788         kstat->st_mtime = inode->i_mtime;
789         kstat->st_ctime = inode->i_ctime;
790 }
791
792 /* File functions */
793
794 /* Read count bytes from the file into buf, starting at *offset, which is increased
795  * accordingly, returning the number of bytes transfered.  Most filesystems will
796  * use this function for their f_op->read.  Note, this uses the page cache.
797  * Want to try out page remapping later on... */
798 ssize_t generic_file_read(struct file *file, char *buf, size_t count,
799                           off_t *offset)
800 {
801         struct page *page;
802         int error;
803         off_t page_off;
804         unsigned long first_idx, last_idx;
805         size_t copy_amt;
806         char *buf_end;
807
808         /* Consider pushing some error checking higher in the VFS */
809         if (!count)
810                 return 0;
811         if (*offset == file->f_dentry->d_inode->i_size)
812                 return 0; /* EOF */
813         /* Make sure we don't go past the end of the file */
814         if (*offset + count > file->f_dentry->d_inode->i_size) {
815                 count = file->f_dentry->d_inode->i_size - *offset;
816         }
817         page_off = *offset & (PGSIZE - 1);
818         first_idx = *offset >> PGSHIFT;
819         last_idx = (*offset + count) >> PGSHIFT;
820         buf_end = buf + count;
821         /* For each file page, make sure it's in the page cache, then copy it out.
822          * TODO: will probably need to consider concurrently truncated files here.*/
823         for (int i = first_idx; i <= last_idx; i++) {
824                 error = file_load_page(file, i, &page);
825                 assert(!error); /* TODO: handle ENOMEM and friends */
826                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
827                 /* TODO: (UMEM) think about this.  if it's a user buffer, we're relying
828                  * on current to detect whose it is (which should work for async calls).
829                  * Also, need to propagate errors properly...  Probably should do a
830                  * user_mem_check, then free, and also to make a distinction between
831                  * when the kernel wants a read/write (TODO: KFOP) */
832                 if (current) {
833                         memcpy_to_user(current, buf, page2kva(page) + page_off, copy_amt);
834                 } else {
835                         memcpy(buf, page2kva(page) + page_off, copy_amt);
836                 }
837                 buf += copy_amt;
838                 page_off = 0;
839                 page_decref(page);      /* it's still in the cache, we just don't need it */
840         }
841         assert(buf == buf_end);
842         *offset += count;
843         return count;
844 }
845
846 /* Write count bytes from buf to the file, starting at *offset, which is increased
847  * accordingly, returning the number of bytes transfered.  Most filesystems will
848  * use this function for their f_op->write.  Note, this uses the page cache.
849  * Changes don't get flushed to disc til there is an fsync, page cache eviction,
850  * or other means of trying to writeback the pages. */
851 ssize_t generic_file_write(struct file *file, const char *buf, size_t count,
852                            off_t *offset)
853 {
854         struct page *page;
855         int error;
856         off_t page_off;
857         unsigned long first_idx, last_idx;
858         size_t copy_amt;
859         const char *buf_end;
860
861         /* Consider pushing some error checking higher in the VFS */
862         if (!count)
863                 return 0;
864         /* Extend the file.  Should put more checks in here, and maybe do this per
865          * page in the for loop below. */
866         if (*offset + count > file->f_dentry->d_inode->i_size)
867                 file->f_dentry->d_inode->i_size = *offset + count;
868         page_off = *offset & (PGSIZE - 1);
869         first_idx = *offset >> PGSHIFT;
870         last_idx = (*offset + count) >> PGSHIFT;
871         buf_end = buf + count;
872         /* For each file page, make sure it's in the page cache, then write it.*/
873         for (int i = first_idx; i <= last_idx; i++) {
874                 error = file_load_page(file, i, &page);
875                 assert(!error); /* TODO: handle ENOMEM and friends */
876                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
877                 /* TODO: (UMEM) (KFOP) think about this.  if it's a user buffer, we're
878                  * relying on current to detect whose it is (which should work for async
879                  * calls). */
880                 if (current) {
881                         memcpy_from_user(current, page2kva(page) + page_off, buf, copy_amt);
882                 } else {
883                         memcpy(page2kva(page) + page_off, buf, copy_amt);
884                 }
885                 buf += copy_amt;
886                 page_off = 0;
887                 page_decref(page);      /* it's still in the cache, we just don't need it */
888         }
889         assert(buf == buf_end);
890         *offset += count;
891         return count;
892 }
893
894 /* Directories usually use this for their read method, which is the way glibc
895  * currently expects us to do a readdir (short of doing linux's getdents).  Will
896  * probably need work, based on whatever real programs want. */
897 ssize_t generic_dir_read(struct file *file, char *u_buf, size_t count,
898                          off_t *offset)
899 {
900         struct kdirent dir_r = {0}, *dirent = &dir_r;
901         unsigned int num_dirents = count / sizeof(struct kdirent);
902         int retval = 1;
903         size_t amt_copied = 0;
904         char *buf_end = u_buf + count;
905
906         if (!count)
907                 return 0;
908         if (*offset % sizeof(struct kdirent)) {
909                 printk("[kernel] the f_pos for a directory should be dirent-aligned\n");
910                 set_errno(EINVAL);
911                 return -1;
912         }
913         /* for now, we need to tell readdir which dirent we want */
914         dirent->d_off = *offset / sizeof(struct kdirent);
915         for (; (u_buf < buf_end) && (retval == 1); u_buf += sizeof(struct kdirent)){
916                 /* TODO: UMEM/KFOP (pin the u_buf in the syscall, ditch the local copy,
917                  * get rid of this memcpy and reliance on current, etc).  Might be
918                  * tricky with the dirent->d_off */
919                 retval = file->f_op->readdir(file, dirent);
920                 if (retval < 0)
921                         break;
922                 if (current) {
923                         memcpy_to_user(current, u_buf, dirent, sizeof(struct dirent));
924                 } else {
925                         memcpy(u_buf, dirent, sizeof(struct dirent));
926                 }
927                 amt_copied += sizeof(struct dirent);
928                 dirent->d_off++;
929         }
930         *offset += amt_copied;
931         return amt_copied;
932 }
933
934 /* Opens the file, using permissions from current for lack of a better option.
935  * It will attempt to create the file if it does not exist and O_CREAT is
936  * specified.  This will return 0 on failure, and set errno.  TODO: There's some
937  * stuff that we don't do, esp related file truncating/creation.  flags are for
938  * opening, the mode is for creating.  The flags related to how to create
939  * (O_CREAT_FLAGS) are handled in this function, not in create_file().
940  *
941  * It's tempting to split this into a do_file_create and a do_file_open, based
942  * on the O_CREAT flag, but the O_CREAT flag can be ignored if the file exists
943  * already and O_EXCL isn't specified.  We could have open call create if it
944  * fails, but for now we'll keep it as is. */
945 struct file *do_file_open(char *path, int flags, int mode)
946 {
947         struct file *file = 0;
948         struct dentry *file_d;
949         struct inode *parent_i;
950         struct nameidata nd_r = {0}, *nd = &nd_r;
951         int error;
952
953         /* this isn't quite right, due to the nature of O_CREAT */
954         if (flags & O_CREAT)
955                 nd->intent = LOOKUP_CREATE;
956         else
957                 nd->intent = LOOKUP_OPEN;
958         /* get the parent, following links.  this means you get the parent of the
959          * final link (which may not be in 'path' in the first place. */
960         error = path_lookup(path, LOOKUP_PARENT | LOOKUP_FOLLOW, nd);
961         if (error) {
962                 path_release(nd);
963                 set_errno(-error);
964                 return 0;
965         }
966         /* see if the target is there, handle accordingly */
967         file_d = do_lookup(nd->dentry, nd->last.name); 
968         if (!file_d) {
969                 if (!(flags & O_CREAT)) {
970                         path_release(nd);
971                         set_errno(ENOENT);
972                         return 0;
973                 }
974                 /* Create the inode/file.  get a fresh dentry too: */
975                 file_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
976                 parent_i = nd->dentry->d_inode;
977                 /* TODO: mode should be & ~umask.  Note that mode technically should
978                  * only apply to future opens, though we apply it immediately. */
979                 if (create_file(parent_i, file_d, mode)) {
980                         kref_put(&file_d->d_kref);
981                         path_release(nd);
982                         return 0;
983                 }
984                 dcache_put(file_d);
985         } else {        /* something already exists (might be a dir) */
986                 if ((flags & O_CREAT) && (flags & O_EXCL)) {
987                         /* wanted to create, not open, bail out */
988                         kref_put(&file_d->d_kref);
989                         path_release(nd);
990                         set_errno(EEXIST);
991                         return 0;
992                 }
993         }
994         /* now open the file (freshly created or if it already existed).  At this
995          * point, file_d is a refcnt'd dentry, regardless of which branch we took.*/
996         if (flags & O_TRUNC)
997                 warn("File truncation not supported yet.");
998         file = dentry_open(file_d, flags);              /* sets errno */
999         if (!file) {
1000                 kref_put(&file_d->d_kref);
1001                 path_release(nd);
1002                 return 0;
1003         }
1004         kref_put(&file_d->d_kref);
1005         path_release(nd);
1006         return file;
1007 }
1008
1009 /* Path is the location of the symlink, sometimes called the "new path", and
1010  * symname is who we link to, sometimes called the "old path". */
1011 int do_symlink(char *path, const char *symname, int mode)
1012 {
1013         struct dentry *sym_d;
1014         struct inode *parent_i;
1015         struct nameidata nd_r = {0}, *nd = &nd_r;
1016         int error;
1017
1018         nd->intent = LOOKUP_CREATE;
1019         /* get the parent, but don't follow links */
1020         error = path_lookup(path, LOOKUP_PARENT, nd);
1021         if (error) {
1022                 set_errno(-error);
1023                 path_release(nd);
1024                 return -1;
1025         }
1026         /* see if the target is already there, handle accordingly */
1027         sym_d = do_lookup(nd->dentry, nd->last.name); 
1028         if (sym_d) {
1029                 set_errno(EEXIST);
1030                 kref_put(&sym_d->d_kref);
1031                 path_release(nd);
1032                 return -1;
1033         }
1034         /* Doesn't already exist, let's try to make it: */
1035         sym_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
1036         if (!sym_d) {
1037                 set_errno(ENOMEM);
1038                 path_release(nd);
1039                 return -1;
1040         }
1041         parent_i = nd->dentry->d_inode;
1042         /* TODO: mode should be & ~umask. */
1043         if (create_symlink(parent_i, sym_d, symname, mode)) {
1044                 kref_put(&sym_d->d_kref);
1045                 path_release(nd);
1046                 return -1;
1047         }
1048         dcache_put(sym_d);
1049         kref_put(&sym_d->d_kref);
1050         path_release(nd);
1051         return 0;
1052 }
1053
1054 /* Makes a hard link for the file behind old_path to new_path */
1055 int do_link(char *old_path, char *new_path)
1056 {
1057         struct dentry *link_d, *old_d;
1058         struct inode *inode, *parent_dir;
1059         struct nameidata nd_r = {0}, *nd = &nd_r;
1060         int error;
1061         int retval = -1;
1062
1063         nd->intent = LOOKUP_CREATE;
1064         /* get the absolute parent of the new_path */
1065         error = path_lookup(new_path, LOOKUP_PARENT | LOOKUP_FOLLOW, nd);
1066         if (error) {
1067                 set_errno(-error);
1068                 goto out_path_only;
1069         }
1070         parent_dir = nd->dentry->d_inode;
1071         /* see if the new target is already there, handle accordingly */
1072         link_d = do_lookup(nd->dentry, nd->last.name); 
1073         if (link_d) {
1074                 set_errno(EEXIST);
1075                 goto out_link_d;
1076         }
1077         /* Doesn't already exist, let's try to make it.  Still need to stitch it to
1078          * an inode and set its FS-specific stuff after this.*/
1079         link_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
1080         if (!link_d) {
1081                 set_errno(ENOMEM);
1082                 goto out_path_only;
1083         }
1084         /* Now let's get the old_path target */
1085         old_d = lookup_dentry(old_path, LOOKUP_FOLLOW);
1086         if (!old_d)                                     /* errno set by lookup_dentry */
1087                 goto out_link_d;
1088         /* For now, can only link to files */
1089         if (old_d->d_inode->i_type != FS_I_FILE) {
1090                 set_errno(EPERM);
1091                 goto out_both_ds;
1092         }
1093         /* Must be on the same FS */
1094         if (old_d->d_sb != link_d->d_sb) {
1095                 set_errno(EXDEV);
1096                 goto out_both_ds;
1097         }
1098         /* Do whatever FS specific stuff there is first (which is also a chance to
1099          * bail out). */
1100         error = parent_dir->i_op->link(old_d, parent_dir, link_d);
1101         if (error) {
1102                 set_errno(-error);
1103                 goto out_both_ds;
1104         }
1105         /* Finally stitch it up */
1106         inode = old_d->d_inode;
1107         kref_get(&inode->i_kref, 1);
1108         link_d->d_inode = inode;
1109         inode->i_nlink++;
1110         TAILQ_INSERT_TAIL(&inode->i_dentry, link_d, d_alias);   /* weak ref */
1111         dcache_put(link_d);
1112         retval = 0;                             /* Note the fall through to the exit paths */
1113 out_both_ds:
1114         kref_put(&old_d->d_kref);
1115 out_link_d:
1116         kref_put(&link_d->d_kref);
1117 out_path_only:
1118         path_release(nd);
1119         return retval;
1120 }
1121
1122 int do_unlink(char *path)
1123 {
1124         struct dentry *dentry;
1125         struct inode *parent_dir;
1126         struct nameidata nd_r = {0}, *nd = &nd_r;
1127         int error;
1128         int retval = -1;
1129
1130         /* get the parent of the target, and don't follow a final link */
1131         error = path_lookup(path, LOOKUP_PARENT, nd);
1132         if (error) {
1133                 set_errno(-error);
1134                 goto out_path_only;
1135         }
1136         parent_dir = nd->dentry->d_inode;
1137         /* make sure the target is there */
1138         dentry = do_lookup(nd->dentry, nd->last.name); 
1139         if (!dentry) {
1140                 set_errno(ENOENT);
1141                 goto out_path_only;
1142         }
1143         /* Make sure the target is not a directory */
1144         if (dentry->d_inode->i_type == FS_I_DIR) {
1145                 set_errno(EISDIR);
1146                 goto out_dentry;
1147         }
1148         /* Remove the dentry from its parent */
1149         error = parent_dir->i_op->unlink(parent_dir, dentry);
1150         if (error) {
1151                 set_errno(-error);
1152                 goto out_dentry;
1153         }
1154         kref_put(&dentry->d_parent->d_kref);
1155         dentry->d_parent = 0;           /* so we don't double-decref it later */
1156         dentry->d_inode->i_nlink--;     /* TODO: race here */
1157         /* At this point, the dentry is unlinked from the FS, and the inode has one
1158          * less link.  When the in-memory objects (dentry, inode) are going to be
1159          * released (after all open files are closed, and maybe after entries are
1160          * evicted from the cache), then nlinks will get checked and the FS-file
1161          * will get removed from the disk */
1162         retval = 0;                             /* Note the fall through to the exit paths */
1163 out_dentry:
1164         kref_put(&dentry->d_kref);
1165 out_path_only:
1166         path_release(nd);
1167         return retval;
1168 }
1169
1170 /* Checks to see if path can be accessed via mode.  Doesn't do much now.  This
1171  * is an example of decent error propagation from the lower levels via int
1172  * retvals. */
1173 int do_file_access(char *path, int mode)
1174 {
1175         struct nameidata nd_r = {0}, *nd = &nd_r;
1176         int retval = 0;
1177         nd->intent = LOOKUP_ACCESS;
1178         retval = path_lookup(path, 0, nd);
1179         path_release(nd);       
1180         return retval;
1181 }
1182
1183 /* Opens and returns the file specified by dentry */
1184 struct file *dentry_open(struct dentry *dentry, int flags)
1185 {
1186         struct inode *inode;
1187         int desired_mode;
1188         struct file *file = kmem_cache_alloc(file_kcache, 0);
1189         if (!file) {
1190                 set_errno(ENOMEM);
1191                 return 0;
1192         }
1193         inode = dentry->d_inode;
1194         /* Do the mode first, since we can still error out.  f_mode stores how the
1195          * OS file is open, which can be more restrictive than the i_mode */
1196         switch (flags & (O_RDONLY | O_WRONLY | O_RDWR)) {
1197                 case O_RDONLY:
1198                         desired_mode = S_IRUSR;
1199                         break;
1200                 case O_WRONLY:
1201                         desired_mode = S_IWUSR;
1202                         break;
1203                 case O_RDWR:
1204                         desired_mode = S_IRUSR | S_IWUSR;
1205                         break;
1206                 default:
1207                         goto error_access;
1208         }
1209         if (check_perms(inode, desired_mode))
1210                 goto error_access;
1211         file->f_mode = desired_mode;
1212         /* one for the ref passed out, and *none* for the sb TAILQ */
1213         kref_init(&file->f_kref, file_release, 1);
1214         /* Add to the list of all files of this SB */
1215         TAILQ_INSERT_TAIL(&inode->i_sb->s_files, file, f_list);
1216         kref_get(&dentry->d_kref, 1);
1217         file->f_dentry = dentry;
1218         kref_get(&inode->i_sb->s_mount->mnt_kref, 1);
1219         file->f_vfsmnt = inode->i_sb->s_mount;          /* saving a ref to the vmnt...*/
1220         file->f_op = inode->i_fop;
1221         /* Don't store open mode or creation flags */
1222         file->f_flags = flags & ~(O_ACCMODE | O_CREAT_FLAGS);
1223         file->f_pos = 0;
1224         file->f_uid = inode->i_uid;
1225         file->f_gid = inode->i_gid;
1226         file->f_error = 0;
1227 //      struct event_poll_tailq         f_ep_links;
1228         spinlock_init(&file->f_ep_lock);
1229         file->f_fs_info = 0;                                            /* prob overriden by the fs */
1230         file->f_mapping = inode->i_mapping;
1231         file->f_op->open(inode, file);
1232         return file;
1233 error_access:
1234         set_errno(EACCES);
1235         kmem_cache_free(file_kcache, file);
1236         return 0;
1237 }
1238
1239 /* Closes a file, fsync, whatever else is necessary.  Called when the kref hits
1240  * 0.  Note that the file is not refcounted on the s_files list, nor is the
1241  * f_mapping refcounted (it is pinned by the i_mapping). */
1242 void file_release(struct kref *kref)
1243 {
1244         struct file *file = container_of(kref, struct file, f_kref);
1245
1246         struct super_block *sb = file->f_dentry->d_sb;
1247         spin_lock(&sb->s_lock);
1248         TAILQ_REMOVE(&sb->s_files, file, f_list);
1249         spin_unlock(&sb->s_lock);
1250
1251         /* TODO: fsync (BLK).  also, we may want to parallelize the blocking that
1252          * could happen in here (spawn kernel threads)... */
1253         file->f_op->release(file->f_dentry->d_inode, file);
1254         /* Clean up the other refs we hold */
1255         kref_put(&file->f_dentry->d_kref);
1256         kref_put(&file->f_vfsmnt->mnt_kref);
1257         kmem_cache_free(file_kcache, file);
1258 }
1259
1260 /* Page cache functions */
1261
1262 /* Looks up the index'th page in the page map, returning an incref'd reference,
1263  * or 0 if it was not in the map. */
1264 struct page *pm_find_page(struct page_map *pm, unsigned long index)
1265 {
1266         spin_lock(&pm->pm_tree_lock);
1267         struct page *page = (struct page*)radix_lookup(&pm->pm_tree, index);
1268         if (page)
1269                 page_incref(page);
1270         spin_unlock(&pm->pm_tree_lock);
1271         return page;
1272 }
1273
1274 /* Attempts to insert the page into the page_map, returns 0 for success, or an
1275  * error code if there was one already (EEXIST) or we ran out of memory
1276  * (ENOMEM).  On success, this will preemptively lock the page, and will also
1277  * store a reference to the page in the pm. */
1278 int pm_insert_page(struct page_map *pm, unsigned long index, struct page *page)
1279 {
1280         int error = 0;
1281         spin_lock(&pm->pm_tree_lock);
1282         error = radix_insert(&pm->pm_tree, index, page);
1283         if (!error) {
1284                 page_incref(page);
1285                 page->pg_flags |= PG_LOCKED;
1286                 page->pg_mapping = pm;
1287                 page->pg_index = index;
1288                 pm->pm_num_pages++;
1289         }
1290         spin_unlock(&pm->pm_tree_lock);
1291         return error;
1292 }
1293
1294 /* Removes the page, including its reference.  Not sure yet what interface we
1295  * want to this (pm and index or page), and this has never been used.  There are
1296  * also issues with when you want to call this, since a page in the cache may be
1297  * mmap'd by someone else. */
1298 int pm_remove_page(struct page_map *pm, struct page *page)
1299 {
1300         void *retval;
1301         warn("pm_remove_page() hasn't been thought through or tested.");
1302         spin_lock(&pm->pm_tree_lock);
1303         retval = radix_delete(&pm->pm_tree, page->pg_index);
1304         spin_unlock(&pm->pm_tree_lock);
1305         assert(retval == (void*)page);
1306         page_decref(page);
1307         page->pg_mapping = 0;
1308         page->pg_index = 0;
1309         pm->pm_num_pages--;
1310         return 0;
1311 }
1312
1313 /* Makes sure the index'th page from file is loaded in the page cache and
1314  * returns its location via **pp.  Note this will give you a refcnt'd reference.
1315  * This may block! TODO: (BLK) */
1316 int file_load_page(struct file *file, unsigned long index, struct page **pp)
1317 {
1318         struct page_map *pm = file->f_mapping;
1319         struct page *page;
1320         int error;
1321         bool page_was_mapped = TRUE;
1322
1323         page = pm_find_page(pm, index);
1324         while (!page) {
1325                 /* kpage_alloc, since we want the page to persist after the proc
1326                  * dies (can be used by others, until the inode shuts down). */
1327                 if (kpage_alloc(&page))
1328                         return -ENOMEM;
1329                 /* might want to initialize other things, perhaps in page_alloc() */
1330                 page->pg_flags = 0;
1331                 error = pm_insert_page(pm, index, page);
1332                 switch (error) {
1333                         case 0:
1334                                 page_was_mapped = FALSE;
1335                                 break;
1336                         case -EEXIST:
1337                                 /* the page was mapped already (benign race), just get rid of
1338                                  * our page and try again (the only case that uses the while) */
1339                                 page_decref(page);
1340                                 page = pm_find_page(pm, index);
1341                                 break;
1342                         default:
1343                                 /* something is wrong, bail out! */
1344                                 page_decref(page);
1345                                 return error;
1346                 }
1347         }
1348         *pp = page;
1349         /* if the page was in the map, we need to do some checks, and might have to
1350          * read in the page later.  If the page was freshly inserted to the pm by
1351          * us, we skip this since we are the one doing the readpage(). */
1352         if (page_was_mapped) {
1353                 /* is it already here and up to date?  if so, we're done */
1354                 if (page->pg_flags & PG_UPTODATE)
1355                         return 0;
1356                 /* if not, try to lock the page (could BLOCK) */
1357                 lock_page(page);
1358                 /* we got it, is our page still in the cache?  check the mapping.  if
1359                  * not, start over, perhaps with EAGAIN and outside support */
1360                 if (!page->pg_mapping)
1361                         panic("Page is not in the mapping!  Haven't implemented this!");
1362                 /* double check, are we up to date?  if so, we're done */
1363                 if (page->pg_flags & PG_UPTODATE) {
1364                         unlock_page(page);
1365                         return 0;
1366                 }
1367         }
1368         /* if we're here, the page is locked by us, and it needs to be read in */
1369         assert(page->pg_mapping == pm);
1370         error = pm->pm_op->readpage(file, page);
1371         assert(!error);
1372         /* Try to sleep on the IO.  The page will be unlocked when the IO is done */
1373         lock_page(page);
1374         unlock_page(page);
1375         assert(page->pg_flags & PG_UPTODATE);
1376         return 0;
1377 }
1378
1379 /* Process-related File management functions */
1380
1381 /* Given any FD, get the appropriate file, 0 o/w */
1382 struct file *get_file_from_fd(struct files_struct *open_files, int file_desc)
1383 {
1384         struct file *retval = 0;
1385         if (file_desc < 0)
1386                 return 0;
1387         spin_lock(&open_files->lock);
1388         if (file_desc < open_files->max_fdset) {
1389                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
1390                         /* while max_files and max_fdset might not line up, we should never
1391                          * have a valid fdset higher than files */
1392                         assert(file_desc < open_files->max_files);
1393                         retval = open_files->fd[file_desc];
1394                         assert(retval);
1395                         kref_get(&retval->f_kref, 1);
1396                 }
1397         }
1398         spin_unlock(&open_files->lock);
1399         return retval;
1400 }
1401
1402 /* Remove FD from the open files, if it was there, and return f.  Currently,
1403  * this decref's f, so the return value is not consumable or even usable.  This
1404  * hasn't been thought through yet. */
1405 struct file *put_file_from_fd(struct files_struct *open_files, int file_desc)
1406 {
1407         struct file *file = 0;
1408         if (file_desc < 0)
1409                 return 0;
1410         spin_lock(&open_files->lock);
1411         if (file_desc < open_files->max_fdset) {
1412                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
1413                         /* while max_files and max_fdset might not line up, we should never
1414                          * have a valid fdset higher than files */
1415                         assert(file_desc < open_files->max_files);
1416                         file = open_files->fd[file_desc];
1417                         open_files->fd[file_desc] = 0;
1418                         CLR_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc);
1419                         /* the if case is due to files (stdin) without a *file yet */
1420                         if (file)
1421                                 kref_put(&file->f_kref);
1422                 }
1423         }
1424         spin_unlock(&open_files->lock);
1425         return file;
1426 }
1427
1428 /* Inserts the file in the files_struct, returning the corresponding new file
1429  * descriptor, or an error code.  We currently grab the first open FD. */
1430 int insert_file(struct files_struct *open_files, struct file *file)
1431 {
1432         int slot = -1;
1433         spin_lock(&open_files->lock);
1434         for (int i = 0; i < open_files->max_fdset; i++) {
1435                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, i))
1436                         continue;
1437                 slot = i;
1438                 SET_BITMASK_BIT(open_files->open_fds->fds_bits, slot);
1439                 assert(slot < open_files->max_files && open_files->fd[slot] == 0);
1440                 kref_get(&file->f_kref, 1);
1441                 open_files->fd[slot] = file;
1442                 if (slot >= open_files->next_fd)
1443                         open_files->next_fd = slot + 1;
1444                 break;
1445         }
1446         if (slot == -1) /* should expand the FD array and fd_set */
1447                 warn("Ran out of file descriptors, deal with me!");
1448         spin_unlock(&open_files->lock);
1449         return slot;
1450 }
1451
1452 /* Closes all open files.  Mostly just a "put" for all files.  If cloexec, it
1453  * will only close files that are opened with O_CLOEXEC. */
1454 void close_all_files(struct files_struct *open_files, bool cloexec)
1455 {
1456         struct file *file;
1457         spin_lock(&open_files->lock);
1458         for (int i = 0; i < open_files->max_fdset; i++) {
1459                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, i)) {
1460                         /* while max_files and max_fdset might not line up, we should never
1461                          * have a valid fdset higher than files */
1462                         assert(i < open_files->max_files);
1463                         file = open_files->fd[i];
1464                         if (cloexec && !(file->f_flags | O_CLOEXEC))
1465                                 continue;
1466                         open_files->fd[i] = 0;
1467                         /* the if case is due to files (stdin) without a *file yet */
1468                         if (file)
1469                                 kref_put(&file->f_kref);
1470                         CLR_BITMASK_BIT(open_files->open_fds->fds_bits, i);
1471                 }
1472         }
1473         spin_unlock(&open_files->lock);
1474 }
1475
1476 /* Inserts all of the files from src into dst, used by sys_fork(). */
1477 void clone_files(struct files_struct *src, struct files_struct *dst)
1478 {
1479         struct file *file;
1480         spin_lock(&src->lock);
1481         spin_lock(&dst->lock);
1482         for (int i = 0; i < src->max_fdset; i++) {
1483                 if (GET_BITMASK_BIT(src->open_fds->fds_bits, i)) {
1484                         /* while max_files and max_fdset might not line up, we should never
1485                          * have a valid fdset higher than files */
1486                         assert(i < src->max_files);
1487                         file = src->fd[i];
1488                         SET_BITMASK_BIT(dst->open_fds->fds_bits, i);
1489                         assert(i < dst->max_files && dst->fd[i] == 0);
1490                         dst->fd[i] = file;
1491                         /* the if case is due to files (stdin) without a *file yet */
1492                         if (file)
1493                                 kref_get(&file->f_kref, 1);
1494                 }
1495         }
1496         spin_unlock(&dst->lock);
1497         spin_unlock(&src->lock);
1498 }
1499
1500 /* Change the working directory of the given fs env (one per process, at this
1501  * point).  Returns 0 for success, -ERROR for whatever error. */
1502 int do_chdir(struct fs_struct *fs_env, char *path)
1503 {
1504         struct nameidata nd_r = {0}, *nd = &nd_r;
1505         int retval;
1506         retval = path_lookup(path, LOOKUP_DIRECTORY, nd);
1507         if (!retval) {
1508                 /* nd->dentry is the place we want our PWD to be */
1509                 kref_get(&nd->dentry->d_kref, 1);
1510                 kref_put(&fs_env->pwd->d_kref);
1511                 fs_env->pwd = nd->dentry;
1512         }
1513         path_release(nd);
1514         return retval;
1515 }
1516
1517 static void print_dir(struct dentry *dentry, char *buf, int depth)
1518 {
1519         struct dentry *child_d;
1520         struct dirent next;
1521         struct file *dir;
1522         int retval;
1523         int child_num = 0;
1524
1525         if (!dentry->d_inode->i_type & FS_I_DIR) {
1526                 warn("Thought this was only directories!!");
1527                 return;
1528         }
1529         /* Print this dentry */
1530         printk("%s%s/\n", buf, dentry->d_name.name);
1531         if (depth >= 32)
1532                 return;
1533         /* Set buffer for our kids */
1534         buf[depth] = '\t';
1535         dir = dentry_open(dentry, 0);
1536         if (!dir)
1537                 panic("Filesystem seems inconsistent - unable to open a dir!");
1538         /* Process every child, recursing on directories */
1539         while (1) {
1540                 next.d_off = child_num++;
1541                 retval = dir->f_op->readdir(dir, &next);
1542                 if (retval >= 0) {
1543                         /* there is an entry, now get its dentry */
1544                         child_d = do_lookup(dentry, next.d_name);
1545                         if (!child_d)
1546                                 panic("Inconsistent FS, dirent doesn't have a dentry!");
1547                         /* Recurse for directories, or just print the name for others */
1548                         switch (child_d->d_inode->i_type) {
1549                                 case (FS_I_DIR):
1550                                         print_dir(child_d, buf, depth + 1);
1551                                         break;
1552                                 case (FS_I_FILE):
1553                                         printk("%s%s size(B): %d nlink: %d\n", buf, next.d_name,
1554                                                child_d->d_inode->i_size, child_d->d_inode->i_nlink);
1555                                         break;
1556                                 case (FS_I_SYMLINK):
1557                                         printk("%s%s -> %s\n", buf, next.d_name,
1558                                                child_d->d_inode->i_op->readlink(child_d));
1559                                         break;
1560                                 default:
1561                                         warn("Look around you!  Unknown filetype!");
1562                         }
1563                         kref_put(&child_d->d_kref);     
1564                 }
1565                 if (retval <= 0)
1566                         break;
1567         }
1568         /* Reset buffer to the way it was */
1569         buf[depth] = '\0';
1570         kref_put(&dir->f_kref);
1571 }
1572
1573 /* Debugging */
1574 int ls_dash_r(char *path)
1575 {
1576         struct nameidata nd_r = {0}, *nd = &nd_r;
1577         int error;
1578         char buf[32] = {0};
1579
1580         error = path_lookup(path, LOOKUP_ACCESS | LOOKUP_DIRECTORY, nd);
1581         if (error) {
1582                 path_release(nd);
1583                 return error;
1584         }
1585         print_dir(nd->dentry, buf, 0);
1586         path_release(nd);
1587         return 0;
1588 }