Fixes bug in generic_dir_read()
[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 <ext2fs.h>
16 #include <pmap.h>
17 #include <umem.h>
18 #include <smp.h>
19
20 struct sb_tailq super_blocks = TAILQ_HEAD_INITIALIZER(super_blocks);
21 spinlock_t super_blocks_lock = SPINLOCK_INITIALIZER;
22 struct fs_type_tailq file_systems = TAILQ_HEAD_INITIALIZER(file_systems);
23 struct namespace default_ns;
24
25 struct kmem_cache *dentry_kcache; // not to be confused with the dcache
26 struct kmem_cache *inode_kcache;
27 struct kmem_cache *file_kcache;
28
29 /* Mounts fs from dev_name at mnt_pt in namespace ns.  There could be no mnt_pt,
30  * such as with the root of (the default) namespace.  Not sure how it would work
31  * with multiple namespaces on the same FS yet.  Note if you mount the same FS
32  * multiple times, you only have one FS still (and one SB).  If we ever support
33  * that... */
34 struct vfsmount *__mount_fs(struct fs_type *fs, char *dev_name,
35                             struct dentry *mnt_pt, int flags,
36                             struct namespace *ns)
37 {
38         struct super_block *sb;
39         struct vfsmount *vmnt = kmalloc(sizeof(struct vfsmount), 0);
40
41         /* this first ref is stored in the NS tailq below */
42         kref_init(&vmnt->mnt_kref, fake_release, 1);
43         /* Build the vfsmount, if there is no mnt_pt, mnt is the root vfsmount (for now).
44          * fields related to the actual FS, like the sb and the mnt_root are set in
45          * the fs-specific get_sb() call. */
46         if (!mnt_pt) {
47                 vmnt->mnt_parent = NULL;
48                 vmnt->mnt_mountpoint = NULL;
49         } else { /* common case, but won't be tested til we try to mount another FS */
50                 mnt_pt->d_mount_point = TRUE;
51                 mnt_pt->d_mounted_fs = vmnt;
52                 kref_get(&vmnt->mnt_kref, 1); /* held by mnt_pt */
53                 vmnt->mnt_parent = mnt_pt->d_sb->s_mount;
54                 vmnt->mnt_mountpoint = mnt_pt;
55         }
56         TAILQ_INIT(&vmnt->mnt_child_mounts);
57         vmnt->mnt_flags = flags;
58         vmnt->mnt_devname = dev_name;
59         vmnt->mnt_namespace = ns;
60         kref_get(&ns->kref, 1); /* held by vmnt */
61
62         /* Read in / create the SB */
63         sb = fs->get_sb(fs, flags, dev_name, vmnt);
64         if (!sb)
65                 panic("You're FS sucks");
66
67         /* TODO: consider moving this into get_sb or something, in case the SB
68          * already exists (mounting again) (if we support that) */
69         spin_lock(&super_blocks_lock);
70         TAILQ_INSERT_TAIL(&super_blocks, sb, s_list); /* storing a ref here... */
71         spin_unlock(&super_blocks_lock);
72
73         /* Update holding NS */
74         spin_lock(&ns->lock);
75         TAILQ_INSERT_TAIL(&ns->vfsmounts, vmnt, mnt_list);
76         spin_unlock(&ns->lock);
77         /* note to self: so, right after this point, the NS points to the root FS
78          * mount (we return the mnt, which gets assigned), the root mnt has a dentry
79          * for /, backed by an inode, with a SB prepped and in memory. */
80         return vmnt;
81 }
82
83 void vfs_init(void)
84 {
85         struct fs_type *fs;
86
87         dentry_kcache = kmem_cache_create("dentry", sizeof(struct dentry),
88                                           __alignof__(struct dentry), 0, 0, 0);
89         inode_kcache = kmem_cache_create("inode", sizeof(struct inode),
90                                          __alignof__(struct inode), 0, 0, 0);
91         file_kcache = kmem_cache_create("file", sizeof(struct file),
92                                         __alignof__(struct file), 0, 0, 0);
93         /* default NS never dies, +1 to exist */
94         kref_init(&default_ns.kref, fake_release, 1);
95         spinlock_init(&default_ns.lock);
96         default_ns.root = NULL;
97         TAILQ_INIT(&default_ns.vfsmounts);
98
99         /* build list of all FS's in the system.  put yours here.  if this is ever
100          * done on the fly, we'll need to lock. */
101         TAILQ_INSERT_TAIL(&file_systems, &kfs_fs_type, list);
102 #ifdef __CONFIG_EXT2FS__
103         TAILQ_INSERT_TAIL(&file_systems, &ext2_fs_type, list);
104 #endif
105         TAILQ_FOREACH(fs, &file_systems, list)
106                 printk("Supports the %s Filesystem\n", fs->name);
107
108         /* mounting KFS at the root (/), pending root= parameters */
109         // TODO: linux creates a temp root_fs, then mounts the real root onto that
110         default_ns.root = __mount_fs(&kfs_fs_type, "RAM", NULL, 0, &default_ns);
111
112         printk("vfs_init() completed\n");
113 }
114
115 /* Builds / populates the qstr of a dentry based on its d_iname.  If there is an
116  * l_name, (long), it will use that instead of the inline name.  This will
117  * probably change a bit. */
118 void qstr_builder(struct dentry *dentry, char *l_name)
119 {
120         dentry->d_name.name = l_name ? l_name : dentry->d_iname;
121         // TODO: pending what we actually do in d_hash
122         //dentry->d_name.hash = dentry->d_op->d_hash(dentry, &dentry->d_name); 
123         dentry->d_name.hash = 0xcafebabe;
124         dentry->d_name.len = strnlen(dentry->d_name.name, MAX_FILENAME_SZ);
125 }
126
127 /* Useful little helper - return the string ptr for a given file */
128 char *file_name(struct file *file)
129 {
130         return file->f_dentry->d_name.name;
131 }
132
133 /* Some issues with this, coupled closely to fs_lookup.
134  *
135  * Note the use of __dentry_free, instead of kref_put.  In those cases, we don't
136  * want to treat it like a kref and we have the only reference to it, so it is
137  * okay to do this.  It makes dentry_release() easier too. */
138 static struct dentry *do_lookup(struct dentry *parent, char *name)
139 {
140         struct dentry *result, *query;
141         query = get_dentry(parent->d_sb, parent, name);
142         result = dcache_get(parent->d_sb, query); 
143         if (result) {
144                 __dentry_free(query);
145                 return result;
146         }
147         /* No result, check for negative */
148         if (query->d_flags & DENTRY_NEGATIVE) {
149                 __dentry_free(query);
150                 return 0;
151         }
152         /* not in the dcache at all, need to consult the FS */
153         result = parent->d_inode->i_op->lookup(parent->d_inode, query, 0);
154         if (!result) {
155                 /* Note the USED flag will get turned off when this gets added to the
156                  * LRU in dentry_release().  There's a slight race here that we'll panic
157                  * on, but I want to catch it (in dcache_put()) for now. */
158                 query->d_flags |= DENTRY_NEGATIVE;
159                 dcache_put(parent->d_sb, query);
160                 kref_put(&query->d_kref);
161                 return 0;
162         }
163         dcache_put(parent->d_sb, result);
164         /* This is because KFS doesn't return the same dentry, but ext2 does.  this
165          * is ugly and needs to be fixed. (TODO) */
166         if (result != query)
167                 __dentry_free(query);
168
169         /* TODO: if the following are done by us, how do we know the i_ino?
170          * also need to handle inodes that are already read in!  For now, we're
171          * going to have the FS handle it in it's lookup() method: 
172          * - get a new inode
173          * - read in the inode
174          * - put in the inode cache */
175         return result;
176 }
177
178 /* Update ND such that it represents having followed dentry.  IAW the nd
179  * refcnting rules, we need to decref any references that were in there before
180  * they get clobbered. */
181 static int next_link(struct dentry *dentry, struct nameidata *nd)
182 {
183         assert(nd->dentry && nd->mnt);
184         /* update the dentry */
185         kref_get(&dentry->d_kref, 1);
186         kref_put(&nd->dentry->d_kref);
187         nd->dentry = dentry;
188         /* update the mount, if we need to */
189         if (dentry->d_sb->s_mount != nd->mnt) {
190                 kref_get(&dentry->d_sb->s_mount->mnt_kref, 1);
191                 kref_put(&nd->mnt->mnt_kref);
192                 nd->mnt = dentry->d_sb->s_mount;
193         }
194         return 0;
195 }
196
197 /* Walk up one directory, being careful of mountpoints, namespaces, and the top
198  * of the FS */
199 static int climb_up(struct nameidata *nd)
200 {
201         printd("CLIMB_UP, from %s\n", nd->dentry->d_name.name);
202         /* Top of the world, just return.  Should also check for being at the top of
203          * the current process's namespace (TODO) */
204         if (!nd->dentry->d_parent || (nd->dentry->d_parent == nd->dentry))
205                 return -1;
206         /* Check if we are at the top of a mount, if so, we need to follow
207          * backwards, and then climb_up from that one.  We might need to climb
208          * multiple times if we mount multiple FSs at the same spot (highly
209          * unlikely).  This is completely untested.  Might recurse instead. */
210         while (nd->mnt->mnt_root == nd->dentry) {
211                 if (!nd->mnt->mnt_parent) {
212                         warn("Might have expected a parent vfsmount (dentry had a parent)");
213                         return -1;
214                 }
215                 next_link(nd->mnt->mnt_mountpoint, nd);
216         }
217         /* Backwards walk (no mounts or any other issues now). */
218         next_link(nd->dentry->d_parent, nd);
219         printd("CLIMB_UP, to   %s\n", nd->dentry->d_name.name);
220         return 0;
221 }
222
223 /* nd->dentry might be on a mount point, so we need to move on to the child
224  * mount's root. */
225 static int follow_mount(struct nameidata *nd)
226 {
227         if (!nd->dentry->d_mount_point)
228                 return 0;
229         next_link(nd->dentry->d_mounted_fs->mnt_root, nd);
230         return 0;
231 }
232
233 static int link_path_walk(char *path, struct nameidata *nd);
234
235 /* When nd->dentry is for a symlink, this will recurse and follow that symlink,
236  * so that nd contains the results of following the symlink (dentry and mnt).
237  * Returns when it isn't a symlink, 1 on following a link, and < 0 on error. */
238 static int follow_symlink(struct nameidata *nd)
239 {
240         int retval;
241         char *symname;
242         if (!S_ISLNK(nd->dentry->d_inode->i_mode))
243                 return 0;
244         if (nd->depth > MAX_SYMLINK_DEPTH)
245                 return -ELOOP;
246         printd("Following symlink for dentry %08p %s\n", nd->dentry,
247                nd->dentry->d_name.name);
248         nd->depth++;
249         symname = nd->dentry->d_inode->i_op->readlink(nd->dentry);
250         /* We need to pin in nd->dentry (the dentry of the symlink), since we need
251          * it's symname's storage to stay in memory throughout the upcoming
252          * link_path_walk().  The last_sym gets decreffed when we path_release() or
253          * follow another symlink. */
254         if (nd->last_sym)
255                 kref_put(&nd->last_sym->d_kref);
256         kref_get(&nd->dentry->d_kref, 1);
257         nd->last_sym = nd->dentry;
258         /* If this an absolute path in the symlink, we need to free the old path and
259          * start over, otherwise, we continue from the PARENT of nd (the symlink) */
260         if (symname[0] == '/') {
261                 path_release(nd);
262                 if (!current)
263                         nd->dentry = default_ns.root->mnt_root;
264                 else
265                         nd->dentry = current->fs_env.root;      
266                 nd->mnt = nd->dentry->d_sb->s_mount;
267                 kref_get(&nd->mnt->mnt_kref, 1);
268                 kref_get(&nd->dentry->d_kref, 1);
269         } else {
270                 climb_up(nd);
271         }
272         /* either way, keep on walking in the free world! */
273         retval = link_path_walk(symname, nd);
274         return (retval == 0 ? 1 : retval);
275 }
276
277 /* Little helper, to make it easier to break out of the nested loops.  Will also
278  * '\0' out the first slash if it's slashes all the way down.  Or turtles. */
279 static bool packed_trailing_slashes(char *first_slash)
280 {
281         for (char *i = first_slash; *i == '/'; i++) {
282                 if (*(i + 1) == '\0') {
283                         *first_slash = '\0';
284                         return TRUE;
285                 }
286         }
287         return FALSE;
288 }
289
290 /* Simple helper to set nd to track it's last name to be Name.  Also be careful
291  * with the storage of name.  Don't use and nd's name past the lifetime of the
292  * string used in the path_lookup()/link_path_walk/whatever.  Consider replacing
293  * parts of this with a qstr builder.  Note this uses the dentry's d_op, which
294  * might not be the dentry we care about. */
295 static void stash_nd_name(struct nameidata *nd, char *name)
296 {
297         nd->last.name = name;
298         nd->last.len = strlen(name);
299         nd->last.hash = nd->dentry->d_op->d_hash(nd->dentry, &nd->last);
300 }
301
302 /* Resolves the links in a basic path walk.  0 for success, -EWHATEVER
303  * otherwise.  The final lookup is returned via nd. */
304 static int link_path_walk(char *path, struct nameidata *nd)
305 {
306         struct dentry *link_dentry;
307         struct inode *link_inode, *nd_inode;
308         char *next_slash;
309         char *link = path;
310         int error;
311
312         /* Prevent crazy recursion */
313         if (nd->depth > MAX_SYMLINK_DEPTH)
314                 return -ELOOP;
315         /* skip all leading /'s */
316         while (*link == '/')
317                 link++;
318         /* if there's nothing left (null terminated), we're done.  This should only
319          * happen for "/", which if we wanted a PARENT, should fail (there is no
320          * parent). */
321         if (*link == '\0') {
322                 if (nd->flags & LOOKUP_PARENT) {
323                         set_errno(ENOENT);
324                         return -1;
325                 }
326                 /* o/w, we're good */
327                 return 0;
328         }
329         /* iterate through each intermediate link of the path.  in general, nd
330          * tracks where we are in the path, as far as dentries go.  once we have the
331          * next dentry, we try to update nd based on that dentry.  link is the part
332          * of the path string that we are looking up */
333         while (1) {
334                 nd_inode = nd->dentry->d_inode;
335                 if ((error = check_perms(nd_inode, nd->intent)))
336                         return error;
337                 /* find the next link, break out if it is the end */
338                 next_slash = strchr(link, '/');
339                 if (!next_slash) {
340                         break;
341                 } else {
342                         if (packed_trailing_slashes(next_slash)) {
343                                 nd->flags |= LOOKUP_DIRECTORY;
344                                 break;
345                         }
346                 }
347                 /* skip over any interim ./ */
348                 if (!strncmp("./", link, 2))
349                         goto next_loop;
350                 /* Check for "../", walk up */
351                 if (!strncmp("../", link, 3)) {
352                         climb_up(nd);
353                         goto next_loop;
354                 }
355                 *next_slash = '\0';
356                 link_dentry = do_lookup(nd->dentry, link);
357                 *next_slash = '/';
358                 if (!link_dentry)
359                         return -ENOENT;
360                 /* make link_dentry the current step/answer */
361                 next_link(link_dentry, nd);
362                 kref_put(&link_dentry->d_kref); /* do_lookup gave us a refcnt dentry */
363                 /* we could be on a mountpoint or a symlink - need to follow them */
364                 follow_mount(nd);
365                 if ((error = follow_symlink(nd)) < 0)
366                         return error;
367                 /* Turn off a possible DIRECTORY lookup, which could have been set
368                  * during the follow_symlink (a symlink could have had a directory at
369                  * the end), though it was in the middle of the real path. */
370                 nd->flags &= ~LOOKUP_DIRECTORY;
371                 if (!S_ISDIR(nd->dentry->d_inode->i_mode))
372                         return -ENOTDIR;
373 next_loop:
374                 /* move through the path string to the next entry */
375                 link = next_slash + 1;
376                 /* advance past any other interim slashes.  we know we won't hit the end
377                  * due to the for loop check above */
378                 while (*link == '/')
379                         link++;
380         }
381         /* Now, we're on the last link of the path.  We need to deal with with . and
382          * .. .  This might be weird with PARENT lookups - not sure what semantics
383          * we want exactly.  This will give the parent of whatever the PATH was
384          * supposed to look like.  Note that ND currently points to the parent of
385          * the last item (link). */
386         if (!strcmp(".", link)) {
387                 if (nd->flags & LOOKUP_PARENT) {
388                         assert(nd->dentry->d_name.name);
389                         stash_nd_name(nd, nd->dentry->d_name.name);
390                         climb_up(nd);
391                 }
392                 return 0;
393         }
394         if (!strcmp("..", link)) {
395                 climb_up(nd);
396                 if (nd->flags & LOOKUP_PARENT) {
397                         assert(nd->dentry->d_name.name);
398                         stash_nd_name(nd, nd->dentry->d_name.name);
399                         climb_up(nd);
400                 }
401                 return 0;
402         }
403         /* need to attempt to look it up, in case it's a symlink */
404         link_dentry = do_lookup(nd->dentry, link);
405         if (!link_dentry) {
406                 /* if there's no dentry, we are okay if we are looking for the parent */
407                 if (nd->flags & LOOKUP_PARENT) {
408                         assert(strcmp(link, ""));
409                         stash_nd_name(nd, link);
410                         return 0;
411                 } else {
412                         return -ENOENT;
413                 }
414         }
415         next_link(link_dentry, nd);
416         kref_put(&link_dentry->d_kref); /* do_lookup gave us a refcnt'd dentry */
417         /* at this point, nd is on the final link, but it might be a symlink */
418         if (nd->flags & LOOKUP_FOLLOW) {
419                 error = follow_symlink(nd);
420                 if (error < 0)
421                         return error;
422                 /* if we actually followed a symlink, then nd is set and we're done */
423                 if (error > 0)
424                         return 0;
425         }
426         /* One way or another, nd is on the last element of the path, symlinks and
427          * all.  Now we need to climb up to set nd back on the parent, if that's
428          * what we wanted */
429         if (nd->flags & LOOKUP_PARENT) {
430                 assert(nd->dentry->d_name.name);
431                 stash_nd_name(nd, link_dentry->d_name.name);
432                 climb_up(nd);
433                 return 0;
434         }
435         /* now, we have the dentry set, and don't want the parent, but might be on a
436          * mountpoint still.  FYI: this hasn't been thought through completely. */
437         follow_mount(nd);
438         /* If we wanted a directory, but didn't get one, error out */
439         if ((nd->flags & LOOKUP_DIRECTORY) && !S_ISDIR(nd->dentry->d_inode->i_mode))
440                 return -ENOTDIR;
441         return 0;
442 }
443
444 /* Given path, return the inode for the final dentry.  The ND should be
445  * initialized for the first call - specifically, we need the intent. 
446  * LOOKUP_PARENT and friends go in the flags var, which is not the intent.
447  *
448  * If path_lookup wants a PARENT, but hits the top of the FS (root or
449  * otherwise), we want it to error out.  It's still unclear how we want to
450  * handle processes with roots that aren't root, but at the very least, we don't
451  * want to think we have the parent of /, but have / itself.  Due to the way
452  * link_path_walk works, if that happened, we probably don't have a
453  * nd->last.name.  This needs more thought (TODO).
454  *
455  * Need to be careful too.  While the path has been copied-in to the kernel,
456  * it's still user input.  */
457 int path_lookup(char *path, int flags, struct nameidata *nd)
458 {
459         int retval;
460         printd("Path lookup for %s\n", path);
461         /* we allow absolute lookups with no process context */
462         if (path[0] == '/') {                   /* absolute lookup */
463                 if (!current)
464                         nd->dentry = default_ns.root->mnt_root;
465                 else
466                         nd->dentry = current->fs_env.root;      
467         } else {                                                /* relative lookup */
468                 assert(current);
469                 /* Don't need to lock on the fs_env since we're reading one item */
470                 nd->dentry = current->fs_env.pwd;       
471         }
472         nd->mnt = nd->dentry->d_sb->s_mount;
473         /* Whenever references get put in the nd, incref them.  Whenever they are
474          * removed, decref them. */
475         kref_get(&nd->mnt->mnt_kref, 1);
476         kref_get(&nd->dentry->d_kref, 1);
477         nd->flags = flags;
478         nd->depth = 0;                                  /* used in symlink following */
479         retval =  link_path_walk(path, nd);     
480         /* make sure our PARENT lookup worked */
481         if (!retval && (flags & LOOKUP_PARENT))
482                 assert(nd->last.name);
483         return retval;
484 }
485
486 /* Call this after any use of path_lookup when you are done with its results,
487  * regardless of whether it succeeded or not.  It will free any references */
488 void path_release(struct nameidata *nd)
489 {
490         kref_put(&nd->dentry->d_kref);
491         kref_put(&nd->mnt->mnt_kref);
492         /* Free the last symlink dentry used, if there was one */
493         if (nd->last_sym) {
494                 kref_put(&nd->last_sym->d_kref);
495                 nd->last_sym = 0;                       /* catch reuse bugs */
496         }
497 }
498
499 /* External version of mount, only call this after having a / mount */
500 int mount_fs(struct fs_type *fs, char *dev_name, char *path, int flags)
501 {
502         struct nameidata nd_r = {0}, *nd = &nd_r;
503         int retval = 0;
504         retval = path_lookup(path, LOOKUP_DIRECTORY, nd);
505         if (retval)
506                 goto out;
507         /* taking the namespace of the vfsmount of path */ 
508         if (!__mount_fs(fs, dev_name, nd->dentry, flags, nd->mnt->mnt_namespace))
509                 retval = -EINVAL;
510 out:
511         path_release(nd);
512         return retval;
513 }
514
515 /* Superblock functions */
516
517 /* Dentry "hash" function for the hash table to use.  Since we already have the
518  * hash in the qstr, we don't need to rehash.  Also, note we'll be using the
519  * dentry in question as both the key and the value. */
520 static size_t __dcache_hash(void *k)
521 {
522         return (size_t)((struct dentry*)k)->d_name.hash;
523 }
524
525 /* Dentry cache hashtable equality function.  This means we need to pass in some
526  * minimal dentry when doing a lookup. */
527 static ssize_t __dcache_eq(void *k1, void *k2)
528 {
529         if (((struct dentry*)k1)->d_parent != ((struct dentry*)k2)->d_parent)
530                 return 0;
531         /* TODO: use the FS-specific string comparison */
532         return !strcmp(((struct dentry*)k1)->d_name.name,
533                        ((struct dentry*)k2)->d_name.name);
534 }
535
536 /* Helper to alloc and initialize a generic superblock.  This handles all the
537  * VFS related things, like lists.  Each FS will need to handle its own things
538  * in it's *_get_sb(), usually involving reading off the disc. */
539 struct super_block *get_sb(void)
540 {
541         struct super_block *sb = kmalloc(sizeof(struct super_block), 0);
542         sb->s_dirty = FALSE;
543         spinlock_init(&sb->s_lock);
544         kref_init(&sb->s_kref, fake_release, 1); /* for the ref passed out */
545         TAILQ_INIT(&sb->s_inodes);
546         TAILQ_INIT(&sb->s_dirty_i);
547         TAILQ_INIT(&sb->s_io_wb);
548         TAILQ_INIT(&sb->s_lru_d);
549         TAILQ_INIT(&sb->s_files);
550         sb->s_dcache = create_hashtable(100, __dcache_hash, __dcache_eq);
551         sb->s_icache = create_hashtable(100, __generic_hash, __generic_eq);
552         spinlock_init(&sb->s_lru_lock);
553         spinlock_init(&sb->s_dcache_lock);
554         spinlock_init(&sb->s_icache_lock);
555         sb->s_fs_info = 0; // can override somewhere else
556         return sb;
557 }
558
559 /* Final stages of initializing a super block, including creating and linking
560  * the root dentry, root inode, vmnt, and sb.  The d_op and root_ino are
561  * FS-specific, but otherwise it's FS-independent, tricky, and not worth having
562  * around multiple times.
563  *
564  * Not the world's best interface, so it's subject to change, esp since we're
565  * passing (now 3) FS-specific things. */
566 void init_sb(struct super_block *sb, struct vfsmount *vmnt,
567              struct dentry_operations *d_op, unsigned long root_ino,
568              void *d_fs_info)
569 {
570         /* Build and init the first dentry / inode.  The dentry ref is stored later
571          * by vfsmount's mnt_root.  The parent is dealt with later. */
572         struct dentry *d_root = get_dentry(sb, 0,  "/");        /* probably right */
573
574         /* a lot of here on down is normally done in lookup() or create, since
575          * get_dentry isn't a fully usable dentry.  The two FS-specific settings are
576          * normally inherited from a parent within the same FS in get_dentry, but we
577          * have none here. */
578         d_root->d_op = d_op;
579         d_root->d_fs_info = d_fs_info;
580         struct inode *inode = get_inode(d_root);
581         if (!inode)
582                 panic("This FS sucks!");
583         inode->i_ino = root_ino;
584         /* TODO: add the inode to the appropriate list (off i_list) */
585         /* TODO: do we need to read in the inode?  can we do this on demand? */
586         /* if this FS is already mounted, we'll need to do something different. */
587         sb->s_op->read_inode(inode);
588         icache_put(sb, inode);
589         /* Link the dentry and SB to the VFS mount */
590         vmnt->mnt_root = d_root;                                /* ref comes from get_dentry */
591         vmnt->mnt_sb = sb;
592         /* If there is no mount point, there is no parent.  This is true only for
593          * the rootfs. */
594         if (vmnt->mnt_mountpoint) {
595                 kref_get(&vmnt->mnt_mountpoint->d_kref, 1);     /* held by d_root */
596                 d_root->d_parent = vmnt->mnt_mountpoint;        /* dentry of the root */
597         } else {
598                 d_root->d_parent = d_root;                      /* set root as its own parent */
599         }
600         /* insert the dentry into the dentry cache.  when's the earliest we can?
601          * when's the earliest we should?  what about concurrent accesses to the
602          * same dentry?  should be locking the dentry... */
603         dcache_put(sb, d_root);
604         kref_put(&inode->i_kref);               /* give up the ref from get_inode() */
605 }
606
607 /* Dentry Functions */
608
609 /* Helper to alloc and initialize a generic dentry.  The following needs to be
610  * set still: d_op (if no parent), d_fs_info (opt), d_inode, connect the inode
611  * to the dentry (and up the d_kref again), maybe dcache_put().  The inode
612  * stitching is done in get_inode() or lookup (depending on the FS).
613  * The setting of the d_op might be problematic when dealing with mounts.  Just
614  * overwrite it.
615  *
616  * If the name is longer than the inline name, it will kmalloc a buffer, so
617  * don't worry about the storage for *name after calling this. */
618 struct dentry *get_dentry(struct super_block *sb, struct dentry *parent,
619                           char *name)
620 {
621         assert(name);
622         size_t name_len = strnlen(name, MAX_FILENAME_SZ);       /* not including \0! */
623         struct dentry *dentry = kmem_cache_alloc(dentry_kcache, 0);
624         char *l_name = 0;
625
626         if (!dentry)
627                 return 0;
628         //memset(dentry, 0, sizeof(struct dentry));
629         kref_init(&dentry->d_kref, dentry_release, 1);  /* this ref is returned */
630         spinlock_init(&dentry->d_lock);
631         TAILQ_INIT(&dentry->d_subdirs);
632         dentry->d_time = 0;
633         kref_get(&sb->s_kref, 1);
634         dentry->d_sb = sb;                                      /* storing a ref here... */
635         dentry->d_mount_point = FALSE;
636         dentry->d_mounted_fs = 0;
637         if (parent)     {                                               /* no parent for rootfs mount */
638                 kref_get(&parent->d_kref, 1);
639                 dentry->d_op = parent->d_op;    /* d_op set in init_sb for parentless */
640         }
641         dentry->d_parent = parent;
642         dentry->d_flags = DENTRY_USED;
643         dentry->d_fs_info = 0;
644         if (name_len < DNAME_INLINE_LEN) {
645                 strncpy(dentry->d_iname, name, name_len);
646                 dentry->d_iname[name_len] = '\0';
647                 qstr_builder(dentry, 0);
648         } else {
649                 l_name = kmalloc(name_len + 1, 0);
650                 assert(l_name);
651                 strncpy(l_name, name, name_len);
652                 l_name[name_len] = '\0';
653                 qstr_builder(dentry, l_name);
654         }
655         /* Catch bugs by aggressively zeroing this (o/w we use old stuff) */
656         dentry->d_inode = 0;
657         return dentry;
658 }
659
660 /* Called when the dentry is unreferenced (after kref == 0).  This works closely
661  * with the resurrection in dcache_get().
662  *
663  * The dentry is still in the dcache, but needs to be un-USED and added to the
664  * LRU dentry list.  Even dentries that were used in a failed lookup need to be
665  * cached - they ought to be the negative dentries.  Note that all dentries have
666  * parents, even negative ones (it is needed to find it in the dcache). */
667 void dentry_release(struct kref *kref)
668 {
669         struct dentry *dentry = container_of(kref, struct dentry, d_kref);
670
671         printd("'Releasing' dentry %08p: %s\n", dentry, dentry->d_name.name);
672         /* DYING dentries (recently unlinked / rmdir'd) just get freed */
673         if (dentry->d_flags & DENTRY_DYING) {
674                 __dentry_free(dentry);
675                 return;
676         }
677         /* This lock ensures the USED state and the TAILQ membership is in sync.
678          * Also used to check the refcnt, though that might not be necessary. */
679         spin_lock(&dentry->d_lock);
680         /* While locked, we need to double check the kref, in case someone already
681          * reup'd it.  Re-up? you're crazy!  Reee-up, you're outta yo mind! */
682         if (!kref_refcnt(&dentry->d_kref)) {
683                 /* Note this is where negative dentries get set UNUSED */
684                 if (dentry->d_flags & DENTRY_USED) {
685                         dentry->d_flags &= ~DENTRY_USED;
686                         spin_lock(&dentry->d_sb->s_lru_lock);
687                         TAILQ_INSERT_TAIL(&dentry->d_sb->s_lru_d, dentry, d_lru);
688                         spin_unlock(&dentry->d_sb->s_lru_lock);
689                 } else {
690                         /* and make sure it wasn't USED, then UNUSED again */
691                         /* TODO: think about issues with this */
692                         warn("This should be rare.  Tell brho this happened.");
693                 }
694         }
695         spin_unlock(&dentry->d_lock);
696 }
697
698 /* Called when we really dealloc and get rid of a dentry (like when it is
699  * removed from the dcache, either for memory or correctness reasons)
700  *
701  * This has to handle two types of dentries: full ones (ones that had been used)
702  * and ones that had been just for lookups - hence the check for d_inode.
703  *
704  * Note that dentries pin and kref their inodes.  When all the dentries are
705  * gone, we want the inode to be released via kref.  The inode has internal /
706  * weak references to the dentry, which are not refcounted. */
707 void __dentry_free(struct dentry *dentry)
708 {
709         if (dentry->d_inode)
710                 printk("Freeing dentry %08p: %s\n", dentry, dentry->d_name.name);
711         assert(dentry->d_op);   /* catch bugs.  a while back, some lacked d_op */
712         dentry->d_op->d_release(dentry);
713         /* TODO: check/test the boundaries on this. */
714         if (dentry->d_name.len > DNAME_INLINE_LEN)
715                 kfree((void*)dentry->d_name.name);
716         kref_put(&dentry->d_sb->s_kref);
717         if (dentry->d_parent)
718                 kref_put(&dentry->d_parent->d_kref);
719         if (dentry->d_mounted_fs)
720                 kref_put(&dentry->d_mounted_fs->mnt_kref);
721         if (dentry->d_inode) {
722                 TAILQ_REMOVE(&dentry->d_inode->i_dentry, dentry, d_alias);
723                 kref_put(&dentry->d_inode->i_kref);     /* dentries kref inodes */
724         }
725         kmem_cache_free(dentry_kcache, dentry);
726 }
727
728 /* Looks up the dentry for the given path, returning a refcnt'd dentry (or 0).
729  * Permissions are applied for the current user, which is quite a broken system
730  * at the moment.  Flags are lookup flags. */
731 struct dentry *lookup_dentry(char *path, int flags)
732 {
733         struct dentry *dentry;
734         struct nameidata nd_r = {0}, *nd = &nd_r;
735         int error;
736
737         error = path_lookup(path, flags, nd);
738         if (error) {
739                 path_release(nd);
740                 set_errno(-error);
741                 return 0;
742         }
743         dentry = nd->dentry;
744         kref_get(&dentry->d_kref, 1);
745         path_release(nd);
746         return dentry;
747 }
748
749 /* Get a dentry from the dcache.  At a minimum, we need the name hash and parent
750  * in what_i_want, though most uses will probably be from a get_dentry() call.
751  * We pass in the SB in the off chance that we don't want to use a get'd dentry.
752  *
753  * The unusual variable name (instead of just "key" or something) is named after
754  * ex-SPC Castro's porn folder.  Caller deals with the memory for what_i_want.
755  *
756  * If the dentry is negative, we don't return the actual result - instead, we
757  * set the negative flag in 'what i want'.  The reason is we don't want to
758  * kref_get() and then immediately put (causing dentry_release()).  This also
759  * means that dentry_release() should never get someone who wasn't USED (barring
760  * the race, which it handles).  And we don't need to ever have a dentry set as
761  * USED and NEGATIVE (which is always wrong, but would be needed for a cleaner
762  * dentry_release()).
763  *
764  * This is where we do the "kref resurrection" - we are returning a kref'd
765  * object, even if it wasn't kref'd before.  This means the dcache does NOT hold
766  * krefs (it is a weak/internal ref), but it is a source of kref generation.  We
767  * sync up with the possible freeing of the dentry by locking the table.  See
768  * Doc/kref for more info. */
769 struct dentry *dcache_get(struct super_block *sb, struct dentry *what_i_want)
770 {
771         struct dentry *found;
772         /* This lock protects the hash, as well as ensures the returned object
773          * doesn't get deleted/freed out from under us */
774         spin_lock(&sb->s_dcache_lock);
775         found = hashtable_search(sb->s_dcache, what_i_want);
776         if (found) {
777                 if (found->d_flags & DENTRY_NEGATIVE) {
778                         what_i_want->d_flags |= DENTRY_NEGATIVE;
779                         spin_unlock(&sb->s_dcache_lock);
780                         return 0;
781                 }
782                 spin_lock(&found->d_lock);
783                 __kref_get(&found->d_kref, 1);  /* prob could be done outside the lock*/
784                 /* If we're here (after kreffing) and it is not USED, we are the one who
785                  * should resurrect */
786                 if (!(found->d_flags & DENTRY_USED)) {
787                         found->d_flags |= DENTRY_USED;
788                         spin_lock(&sb->s_lru_lock);
789                         TAILQ_REMOVE(&sb->s_lru_d, found, d_lru);
790                         spin_unlock(&sb->s_lru_lock);
791                 }
792                 spin_unlock(&found->d_lock);
793         }
794         spin_unlock(&sb->s_dcache_lock);
795         return found;
796 }
797
798 /* Adds a dentry to the dcache.  Note the *dentry is both the key and the value.
799  * If the value was already in there (which can happen iff it was negative), for
800  * now we'll remove it and put the new one in there. */
801 void dcache_put(struct super_block *sb, struct dentry *key_val)
802 {
803         struct dentry *old;
804         int retval;
805         spin_lock(&sb->s_dcache_lock);
806         old = hashtable_remove(sb->s_dcache, key_val);
807         if (old) {
808                 assert(old->d_flags & DENTRY_NEGATIVE);
809                 /* This is possible, but rare for now (about to be put on the LRU) */
810                 assert(!(old->d_flags & DENTRY_USED));
811                 assert(!kref_refcnt(&old->d_kref));
812                 spin_lock(&sb->s_lru_lock);
813                 TAILQ_REMOVE(&sb->s_lru_d, old, d_lru);
814                 spin_unlock(&sb->s_lru_lock);
815                 __dentry_free(old);
816         }
817         /* this returns 0 on failure (TODO: Fix this ghetto shit) */
818         retval = hashtable_insert(sb->s_dcache, key_val, key_val);
819         assert(retval);
820         spin_unlock(&sb->s_dcache_lock);
821 }
822
823 /* Will remove and return the dentry.  Caller deallocs the key, but the retval
824  * won't have a reference.  * Returns 0 if it wasn't found.  Callers can't
825  * assume much - they should not use the reference they *get back*, (if they
826  * already had one for key, they can use that).  There may be other users out
827  * there. */
828 struct dentry *dcache_remove(struct super_block *sb, struct dentry *key)
829 {
830         struct dentry *retval;
831         spin_lock(&sb->s_dcache_lock);
832         retval = hashtable_remove(sb->s_dcache, key);
833         spin_unlock(&sb->s_dcache_lock);
834         return retval;
835 }
836
837 /* This will clean out the LRU list, which are the unused dentries of the dentry
838  * cache.  This will optionally only free the negative ones.  Note that we grab
839  * the hash lock for the time we traverse the LRU list - this prevents someone
840  * from getting a kref from the dcache, which could cause us trouble (we rip
841  * someone off the list, who isn't unused, and they try to rip them off the
842  * list). */
843 void dcache_prune(struct super_block *sb, bool negative_only)
844 {
845         struct dentry *d_i, *temp;
846         struct dentry_tailq victims = TAILQ_HEAD_INITIALIZER(victims);
847
848         spin_lock(&sb->s_dcache_lock);
849         spin_lock(&sb->s_lru_lock);
850         TAILQ_FOREACH_SAFE(d_i, &sb->s_lru_d, d_lru, temp) {
851                 if (!(d_i->d_flags & DENTRY_USED)) {
852                         if (negative_only && !(d_i->d_flags & DENTRY_NEGATIVE))
853                                 continue;
854                         /* another place where we'd be better off with tools, not sol'ns */
855                         hashtable_remove(sb->s_dcache, d_i);
856                         TAILQ_REMOVE(&sb->s_lru_d, d_i, d_lru);
857                         TAILQ_INSERT_HEAD(&victims, d_i, d_lru);
858                 }
859         }
860         spin_unlock(&sb->s_lru_lock);
861         spin_unlock(&sb->s_dcache_lock);
862         /* Now do the actual freeing, outside of the hash/LRU list locks.  This is
863          * necessary since __dentry_free() will decref its parent, which may get
864          * released and try to add itself to the LRU. */
865         TAILQ_FOREACH_SAFE(d_i, &victims, d_lru, temp) {
866                 TAILQ_REMOVE(&victims, d_i, d_lru);
867                 assert(!kref_refcnt(&d_i->d_kref));
868                 __dentry_free(d_i);
869         }
870         /* It is possible at this point that there are new items on the LRU.  We
871          * could loop back until that list is empty, if we care about this. */
872 }
873
874 /* Inode Functions */
875
876 /* Creates and initializes a new inode.  Generic fields are filled in.
877  * FS-specific fields are filled in by the callout.  Specific fields are filled
878  * in in read_inode() based on what's on the disk for a given i_no, or when the
879  * inode is created (for new objects).
880  *
881  * i_no is set by the caller.  Note that this means this inode can be for an
882  * inode that is already on disk, or it can be used when creating. */
883 struct inode *get_inode(struct dentry *dentry)
884 {
885         struct super_block *sb = dentry->d_sb;
886         /* FS allocs and sets the following: i_op, i_fop, i_pm.pm_op, and any FS
887          * specific stuff. */
888         struct inode *inode = sb->s_op->alloc_inode(sb);
889         if (!inode) {
890                 set_errno(ENOMEM);
891                 return 0;
892         }
893         TAILQ_INSERT_HEAD(&sb->s_inodes, inode, i_sb_list);             /* weak inode ref */
894         TAILQ_INIT(&inode->i_dentry);
895         TAILQ_INSERT_TAIL(&inode->i_dentry, dentry, d_alias);   /* weak dentry ref*/
896         /* one for the dentry->d_inode, one passed out */
897         kref_init(&inode->i_kref, inode_release, 2);
898         dentry->d_inode = inode;
899         inode->i_ino = 0;                                       /* set by caller later */
900         inode->i_blksize = sb->s_blocksize;
901         spinlock_init(&inode->i_lock);
902         kref_get(&sb->s_kref, 1);                       /* could allow the dentry to pin it */
903         inode->i_sb = sb;
904         inode->i_rdev = 0;                                      /* this has no real meaning yet */
905         inode->i_bdev = sb->s_bdev;                     /* storing an uncounted ref */
906         inode->i_state = 0;                                     /* need real states, like I_NEW */
907         inode->dirtied_when = 0;
908         inode->i_flags = 0;
909         atomic_set(&inode->i_writecount, 0);
910         /* Set up the page_map structures.  Default is to use the embedded one.
911          * Might push some of this back into specific FSs.  For now, the FS tells us
912          * what pm_op they want via i_pm.pm_op, which we set again in pm_init() */
913         inode->i_mapping = &inode->i_pm;
914         pm_init(inode->i_mapping, inode->i_pm.pm_op, inode);
915         return inode;
916 }
917
918 /* Helper: loads/ reads in the inode numbered ino and attaches it to dentry */
919 void load_inode(struct dentry *dentry, unsigned long ino)
920 {
921         struct inode *inode;
922
923         /* look it up in the inode cache first */
924         inode = icache_get(dentry->d_sb, ino);
925         if (inode) {
926                 /* connect the dentry to its inode */
927                 TAILQ_INSERT_TAIL(&inode->i_dentry, dentry, d_alias);
928                 dentry->d_inode = inode;        /* storing the ref we got from icache_get */
929                 return;
930         }
931         /* otherwise, we need to do it manually */
932         inode = get_inode(dentry);
933         inode->i_ino = ino;
934         dentry->d_sb->s_op->read_inode(inode);
935         /* TODO: race here, two creators could miss in the cache, and then get here.
936          * need a way to sync across a blocking call.  needs to be either at this
937          * point in the code or per the ino (dentries could be different) */
938         icache_put(dentry->d_sb, inode);
939         kref_put(&inode->i_kref);
940 }
941
942 /* Helper op, used when creating regular files, directories, symlinks, etc.
943  * Note we make a distinction between the mode and the file type (for now).
944  * After calling this, call the FS specific version (create or mkdir), which
945  * will set the i_ino, the filetype, and do any other FS-specific stuff.  Also
946  * note that a lot of inode stuff was initialized in get_inode/alloc_inode.  The
947  * stuff here is pertinent to the specific creator (user), mode, and time.  Also
948  * note we don't pass this an nd, like Linux does... */
949 static struct inode *create_inode(struct dentry *dentry, int mode)
950 {
951         /* note it is the i_ino that uniquely identifies a file in the specific
952          * filesystem.  there's a diff between creating an inode (even for an in-use
953          * ino) and then filling it in, and vs creating a brand new one.
954          * get_inode() sets it to 0, and it should be filled in later in an
955          * FS-specific manner. */
956         struct inode *inode = get_inode(dentry);
957         if (!inode)
958                 return 0;
959         inode->i_mode = mode & S_PMASK; /* note that after this, we have no type */
960         inode->i_nlink = 1;
961         inode->i_size = 0;
962         inode->i_blocks = 0;
963         inode->i_atime.tv_sec = 0;              /* TODO: now! */
964         inode->i_ctime.tv_sec = 0;
965         inode->i_mtime.tv_sec = 0;
966         inode->i_atime.tv_nsec = 0;             /* are these supposed to be the extra ns? */
967         inode->i_ctime.tv_nsec = 0;
968         inode->i_mtime.tv_nsec = 0;
969         inode->i_bdev = inode->i_sb->s_bdev;
970         /* when we have notions of users, do something here: */
971         inode->i_uid = 0;
972         inode->i_gid = 0;
973         return inode;
974 }
975
976 /* Create a new disk inode in dir associated with dentry, with the given mode.
977  * called when creating a regular file.  dir is the directory/parent.  dentry is
978  * the dentry of the inode we are creating.  Note the lack of the nd... */
979 int create_file(struct inode *dir, struct dentry *dentry, int mode)
980 {
981         struct inode *new_file = create_inode(dentry, mode);
982         if (!new_file)
983                 return -1;
984         dir->i_op->create(dir, dentry, mode, 0);
985         icache_put(new_file->i_sb, new_file);
986         kref_put(&new_file->i_kref);
987         return 0;
988 }
989
990 /* Creates a new inode for a directory associated with dentry in dir with the
991  * given mode. */
992 int create_dir(struct inode *dir, struct dentry *dentry, int mode)
993 {
994         struct inode *new_dir = create_inode(dentry, mode);
995         if (!new_dir)
996                 return -1;
997         dir->i_op->mkdir(dir, dentry, mode);
998         dir->i_nlink++;         /* Directories get a hardlink for every child dir */
999         /* Make sure my parent tracks me.  This is okay, since no directory (dir)
1000          * can have more than one dentry */
1001         struct dentry *parent = TAILQ_FIRST(&dir->i_dentry);
1002         assert(parent && parent == TAILQ_LAST(&dir->i_dentry, dentry_tailq));
1003         /* parent dentry tracks dentry as a subdir, weak reference */
1004         TAILQ_INSERT_TAIL(&parent->d_subdirs, dentry, d_subdirs_link);
1005         icache_put(new_dir->i_sb, new_dir);
1006         kref_put(&new_dir->i_kref);
1007         return 0;
1008 }
1009
1010 /* Creates a new inode for a symlink associated with dentry in dir, containing
1011  * the symlink symname */
1012 int create_symlink(struct inode *dir, struct dentry *dentry,
1013                    const char *symname, int mode)
1014 {
1015         struct inode *new_sym = create_inode(dentry, mode);
1016         if (!new_sym)
1017                 return -1;
1018         dir->i_op->symlink(dir, dentry, symname);
1019         icache_put(new_sym->i_sb, new_sym);
1020         kref_put(&new_sym->i_kref);
1021         return 0;
1022 }
1023
1024 /* Returns 0 if the given mode is acceptable for the inode, and an appropriate
1025  * error code if not.  Needs to be writen, based on some sensible rules, and
1026  * will also probably use 'current' */
1027 int check_perms(struct inode *inode, int access_mode)
1028 {
1029         return 0;       /* anything goes! */
1030 }
1031
1032 /* Called after all external refs are gone to clean up the inode.  Once this is
1033  * called, all dentries pointing here are already done (one of them triggered
1034  * this via kref_put(). */
1035 void inode_release(struct kref *kref)
1036 {
1037         struct inode *inode = container_of(kref, struct inode, i_kref);
1038         TAILQ_REMOVE(&inode->i_sb->s_inodes, inode, i_sb_list);
1039         icache_remove(inode->i_sb, inode->i_ino);
1040         /* Might need to write back or delete the file/inode */
1041         if (inode->i_nlink) {
1042                 if (inode->i_state & I_STATE_DIRTY)
1043                         inode->i_sb->s_op->write_inode(inode, TRUE);
1044         } else {
1045                 inode->i_sb->s_op->delete_inode(inode);
1046         }
1047         /* Either way, we dealloc the in-memory version */
1048         inode->i_sb->s_op->dealloc_inode(inode);        /* FS-specific clean-up */
1049         kref_put(&inode->i_sb->s_kref);
1050         /* TODO: clean this up */
1051         assert(inode->i_mapping == &inode->i_pm);
1052         kmem_cache_free(inode_kcache, inode);
1053         /* TODO: (BDEV) */
1054         // kref_put(inode->i_bdev->kref); /* assuming it's a bdev */
1055 }
1056
1057 /* Fills in kstat with the stat information for the inode */
1058 void stat_inode(struct inode *inode, struct kstat *kstat)
1059 {
1060         kstat->st_dev = inode->i_sb->s_dev;
1061         kstat->st_ino = inode->i_ino;
1062         kstat->st_mode = inode->i_mode;
1063         kstat->st_nlink = inode->i_nlink;
1064         kstat->st_uid = inode->i_uid;
1065         kstat->st_gid = inode->i_gid;
1066         kstat->st_rdev = inode->i_rdev;
1067         kstat->st_size = inode->i_size;
1068         kstat->st_blksize = inode->i_blksize;
1069         kstat->st_blocks = inode->i_blocks;
1070         kstat->st_atime = inode->i_atime;
1071         kstat->st_mtime = inode->i_mtime;
1072         kstat->st_ctime = inode->i_ctime;
1073 }
1074
1075 /* Inode Cache management.  In general, search on the ino, get a refcnt'd value
1076  * back.  Remove does not give you a reference back - it should only be called
1077  * in inode_release(). */
1078 struct inode *icache_get(struct super_block *sb, unsigned long ino)
1079 {
1080         /* This is the same style as in pid2proc, it's the "safely create a strong
1081          * reference from a weak one, so long as other strong ones exist" pattern */
1082         spin_lock(&sb->s_icache_lock);
1083         struct inode *inode = hashtable_search(sb->s_icache, (void*)ino);
1084         if (inode)
1085                 if (!kref_get_not_zero(&inode->i_kref, 1))
1086                         inode = 0;
1087         spin_unlock(&sb->s_icache_lock);
1088         return inode;
1089 }
1090
1091 void icache_put(struct super_block *sb, struct inode *inode)
1092 {
1093         spin_lock(&sb->s_icache_lock);
1094         /* there's a race in load_ino() that could trigger this */
1095         assert(!hashtable_search(sb->s_icache, (void*)inode->i_ino));
1096         hashtable_insert(sb->s_icache, (void*)inode->i_ino, inode);
1097         spin_unlock(&sb->s_icache_lock);
1098 }
1099
1100 struct inode *icache_remove(struct super_block *sb, unsigned long ino)
1101 {
1102         struct inode *inode;
1103         /* Presumably these hashtable removals could be easier since callers
1104          * actually know who they are (same with the pid2proc hash) */
1105         spin_lock(&sb->s_icache_lock);
1106         inode = hashtable_remove(sb->s_icache, (void*)ino);
1107         spin_unlock(&sb->s_icache_lock);
1108         assert(inode && !kref_refcnt(&inode->i_kref));
1109         return inode;
1110 }
1111
1112 /* File functions */
1113
1114 /* Read count bytes from the file into buf, starting at *offset, which is increased
1115  * accordingly, returning the number of bytes transfered.  Most filesystems will
1116  * use this function for their f_op->read.  Note, this uses the page cache.
1117  * Want to try out page remapping later on... */
1118 ssize_t generic_file_read(struct file *file, char *buf, size_t count,
1119                           off_t *offset)
1120 {
1121         struct page *page;
1122         int error;
1123         off_t page_off;
1124         unsigned long first_idx, last_idx;
1125         size_t copy_amt;
1126         char *buf_end;
1127
1128         /* Consider pushing some error checking higher in the VFS */
1129         if (!count)
1130                 return 0;
1131         if (*offset == file->f_dentry->d_inode->i_size)
1132                 return 0; /* EOF */
1133         /* Make sure we don't go past the end of the file */
1134         if (*offset + count > file->f_dentry->d_inode->i_size) {
1135                 count = file->f_dentry->d_inode->i_size - *offset;
1136         }
1137         page_off = *offset & (PGSIZE - 1);
1138         first_idx = *offset >> PGSHIFT;
1139         last_idx = (*offset + count) >> PGSHIFT;
1140         buf_end = buf + count;
1141         /* For each file page, make sure it's in the page cache, then copy it out.
1142          * TODO: will probably need to consider concurrently truncated files here.*/
1143         for (int i = first_idx; i <= last_idx; i++) {
1144                 error = pm_load_page(file->f_mapping, i, &page);
1145                 assert(!error); /* TODO: handle ENOMEM and friends */
1146                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
1147                 /* TODO: (UMEM) think about this.  if it's a user buffer, we're relying
1148                  * on current to detect whose it is (which should work for async calls).
1149                  * Also, need to propagate errors properly...  Probably should do a
1150                  * user_mem_check, then free, and also to make a distinction between
1151                  * when the kernel wants a read/write (TODO: KFOP) */
1152                 if (current) {
1153                         memcpy_to_user(current, buf, page2kva(page) + page_off, copy_amt);
1154                 } else {
1155                         memcpy(buf, page2kva(page) + page_off, copy_amt);
1156                 }
1157                 buf += copy_amt;
1158                 page_off = 0;
1159                 page_decref(page);      /* it's still in the cache, we just don't need it */
1160         }
1161         assert(buf == buf_end);
1162         *offset += count;
1163         return count;
1164 }
1165
1166 /* Write count bytes from buf to the file, starting at *offset, which is increased
1167  * accordingly, returning the number of bytes transfered.  Most filesystems will
1168  * use this function for their f_op->write.  Note, this uses the page cache.
1169  * Changes don't get flushed to disc til there is an fsync, page cache eviction,
1170  * or other means of trying to writeback the pages. */
1171 ssize_t generic_file_write(struct file *file, const char *buf, size_t count,
1172                            off_t *offset)
1173 {
1174         struct page *page;
1175         int error;
1176         off_t page_off;
1177         unsigned long first_idx, last_idx;
1178         size_t copy_amt;
1179         const char *buf_end;
1180
1181         /* Consider pushing some error checking higher in the VFS */
1182         if (!count)
1183                 return 0;
1184         /* Extend the file.  Should put more checks in here, and maybe do this per
1185          * page in the for loop below. */
1186         if (*offset + count > file->f_dentry->d_inode->i_size)
1187                 file->f_dentry->d_inode->i_size = *offset + count;
1188         page_off = *offset & (PGSIZE - 1);
1189         first_idx = *offset >> PGSHIFT;
1190         last_idx = (*offset + count) >> PGSHIFT;
1191         buf_end = buf + count;
1192         /* For each file page, make sure it's in the page cache, then write it.*/
1193         for (int i = first_idx; i <= last_idx; i++) {
1194                 error = pm_load_page(file->f_mapping, i, &page);
1195                 assert(!error); /* TODO: handle ENOMEM and friends */
1196                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
1197                 /* TODO: (UMEM) (KFOP) think about this.  if it's a user buffer, we're
1198                  * relying on current to detect whose it is (which should work for async
1199                  * calls). */
1200                 if (current) {
1201                         memcpy_from_user(current, page2kva(page) + page_off, buf, copy_amt);
1202                 } else {
1203                         memcpy(page2kva(page) + page_off, buf, copy_amt);
1204                 }
1205                 buf += copy_amt;
1206                 page_off = 0;
1207                 page_decref(page);      /* it's still in the cache, we just don't need it */
1208         }
1209         assert(buf == buf_end);
1210         *offset += count;
1211         return count;
1212 }
1213
1214 /* Directories usually use this for their read method, which is the way glibc
1215  * currently expects us to do a readdir (short of doing linux's getdents).  Will
1216  * probably need work, based on whatever real programs want. */
1217 ssize_t generic_dir_read(struct file *file, char *u_buf, size_t count,
1218                          off_t *offset)
1219 {
1220         struct kdirent dir_r = {0}, *dirent = &dir_r;
1221         int retval = 1;
1222         size_t amt_copied = 0;
1223         char *buf_end = u_buf + count;
1224
1225         if (!S_ISDIR(file->f_dentry->d_inode->i_mode)) {
1226                 set_errno(ENOTDIR);
1227                 return -1;
1228         }
1229         if (!count)
1230                 return 0;
1231         /* start readdir from where it left off: */
1232         dirent->d_off = *offset;
1233         for (   ;
1234                 u_buf + sizeof(struct kdirent) <= buf_end;
1235                 u_buf += sizeof(struct kdirent)) {
1236                 /* TODO: UMEM/KFOP (pin the u_buf in the syscall, ditch the local copy,
1237                  * get rid of this memcpy and reliance on current, etc).  Might be
1238                  * tricky with the dirent->d_off and trust issues */
1239                 retval = file->f_op->readdir(file, dirent);
1240                 if (retval < 0) {
1241                         set_errno(-retval);
1242                         break;
1243                 }
1244                 /* Slight info exposure: could be extra crap after the name in the
1245                  * dirent (like the name of a deleted file) */
1246                 if (current) {
1247                         memcpy_to_user(current, u_buf, dirent, sizeof(struct dirent));
1248                 } else {
1249                         memcpy(u_buf, dirent, sizeof(struct dirent));
1250                 }
1251                 amt_copied += sizeof(struct dirent);
1252                 /* 0 signals end of directory */
1253                 if (retval == 0)
1254                         break;
1255         }
1256         /* Next time read is called, we pick up where we left off */
1257         *offset = dirent->d_off;        /* UMEM */
1258         /* important to tell them how much they got.  they often keep going til they
1259          * get 0 back (in the case of ls).  it's also how much has been read, but it
1260          * isn't how much the f_pos has moved (which is opaque to the VFS). */
1261         return amt_copied;
1262 }
1263
1264 /* Opens the file, using permissions from current for lack of a better option.
1265  * It will attempt to create the file if it does not exist and O_CREAT is
1266  * specified.  This will return 0 on failure, and set errno.  TODO: There's some
1267  * stuff that we don't do, esp related file truncating/creation.  flags are for
1268  * opening, the mode is for creating.  The flags related to how to create
1269  * (O_CREAT_FLAGS) are handled in this function, not in create_file().
1270  *
1271  * It's tempting to split this into a do_file_create and a do_file_open, based
1272  * on the O_CREAT flag, but the O_CREAT flag can be ignored if the file exists
1273  * already and O_EXCL isn't specified.  We could have open call create if it
1274  * fails, but for now we'll keep it as is. */
1275 struct file *do_file_open(char *path, int flags, int mode)
1276 {
1277         struct file *file = 0;
1278         struct dentry *file_d;
1279         struct inode *parent_i;
1280         struct nameidata nd_r = {0}, *nd = &nd_r;
1281         int error;
1282
1283         /* The file might exist, lets try to just open it right away */
1284         nd->intent = LOOKUP_OPEN;
1285         error = path_lookup(path, LOOKUP_FOLLOW, nd);
1286         if (!error) {
1287                 /* Still need to make sure we didn't want to O_EXCL create */
1288                 if ((flags & O_CREAT) && (flags & O_EXCL)) {
1289                         set_errno(EEXIST);
1290                         goto out_path_only;
1291                 }
1292                 file_d = nd->dentry;
1293                 kref_get(&file_d->d_kref, 1);
1294                 goto open_the_file;
1295         }
1296         /* So it didn't already exist, release the path from the previous lookup,
1297          * and then we try to create it. */
1298         path_release(nd);       
1299         /* get the parent, following links.  this means you get the parent of the
1300          * final link (which may not be in 'path' in the first place. */
1301         nd->intent = LOOKUP_CREATE;
1302         error = path_lookup(path, LOOKUP_PARENT | LOOKUP_FOLLOW, nd);
1303         if (error) {
1304                 set_errno(-error);
1305                 goto out_path_only;
1306         }
1307         /* see if the target is there (shouldn't be), and handle accordingly */
1308         file_d = do_lookup(nd->dentry, nd->last.name); 
1309         if (!file_d) {
1310                 if (!(flags & O_CREAT)) {
1311                         set_errno(ENOENT);
1312                         goto out_path_only;
1313                 }
1314                 /* Create the inode/file.  get a fresh dentry too: */
1315                 file_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
1316                 parent_i = nd->dentry->d_inode;
1317                 /* Note that the mode technically should only apply to future opens,
1318                  * but we apply it immediately. */
1319                 if (create_file(parent_i, file_d, mode))        /* sets errno */
1320                         goto out_file_d;
1321                 dcache_put(file_d->d_sb, file_d);
1322         } else {        /* something already exists */
1323                 /* this can happen due to concurrent access, but needs to be thought
1324                  * through */
1325                 panic("File shouldn't be here!");
1326                 if ((flags & O_CREAT) && (flags & O_EXCL)) {
1327                         /* wanted to create, not open, bail out */
1328                         set_errno(EEXIST);
1329                         goto out_file_d;
1330                 }
1331         }
1332 open_the_file:
1333         /* now open the file (freshly created or if it already existed).  At this
1334          * point, file_d is a refcnt'd dentry, regardless of which branch we took.*/
1335         if (flags & O_TRUNC)
1336                 warn("File truncation not supported yet.");
1337         file = dentry_open(file_d, flags);                              /* sets errno */
1338         /* Note the fall through to the exit paths.  File is 0 by default and if
1339          * dentry_open fails. */
1340 out_file_d:
1341         kref_put(&file_d->d_kref);
1342 out_path_only:
1343         path_release(nd);
1344         return file;
1345 }
1346
1347 /* Path is the location of the symlink, sometimes called the "new path", and
1348  * symname is who we link to, sometimes called the "old path". */
1349 int do_symlink(char *path, const char *symname, int mode)
1350 {
1351         struct dentry *sym_d;
1352         struct inode *parent_i;
1353         struct nameidata nd_r = {0}, *nd = &nd_r;
1354         int error;
1355         int retval = -1;
1356
1357         nd->intent = LOOKUP_CREATE;
1358         /* get the parent, but don't follow links */
1359         error = path_lookup(path, LOOKUP_PARENT, nd);
1360         if (error) {
1361                 set_errno(-error);
1362                 goto out_path_only;
1363         }
1364         /* see if the target is already there, handle accordingly */
1365         sym_d = do_lookup(nd->dentry, nd->last.name); 
1366         if (sym_d) {
1367                 set_errno(EEXIST);
1368                 goto out_sym_d;
1369         }
1370         /* Doesn't already exist, let's try to make it: */
1371         sym_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
1372         if (!sym_d) {
1373                 set_errno(ENOMEM);
1374                 goto out_path_only;
1375         }
1376         parent_i = nd->dentry->d_inode;
1377         if (create_symlink(parent_i, sym_d, symname, mode))
1378                 goto out_sym_d;
1379         dcache_put(sym_d->d_sb, sym_d);
1380         retval = 0;                             /* Note the fall through to the exit paths */
1381 out_sym_d:
1382         kref_put(&sym_d->d_kref);
1383 out_path_only:
1384         path_release(nd);
1385         return retval;
1386 }
1387
1388 /* Makes a hard link for the file behind old_path to new_path */
1389 int do_link(char *old_path, char *new_path)
1390 {
1391         struct dentry *link_d, *old_d;
1392         struct inode *inode, *parent_dir;
1393         struct nameidata nd_r = {0}, *nd = &nd_r;
1394         int error;
1395         int retval = -1;
1396
1397         nd->intent = LOOKUP_CREATE;
1398         /* get the absolute parent of the new_path */
1399         error = path_lookup(new_path, LOOKUP_PARENT | LOOKUP_FOLLOW, nd);
1400         if (error) {
1401                 set_errno(-error);
1402                 goto out_path_only;
1403         }
1404         parent_dir = nd->dentry->d_inode;
1405         /* see if the new target is already there, handle accordingly */
1406         link_d = do_lookup(nd->dentry, nd->last.name); 
1407         if (link_d) {
1408                 set_errno(EEXIST);
1409                 goto out_link_d;
1410         }
1411         /* Doesn't already exist, let's try to make it.  Still need to stitch it to
1412          * an inode and set its FS-specific stuff after this.*/
1413         link_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
1414         if (!link_d) {
1415                 set_errno(ENOMEM);
1416                 goto out_path_only;
1417         }
1418         /* Now let's get the old_path target */
1419         old_d = lookup_dentry(old_path, LOOKUP_FOLLOW);
1420         if (!old_d)                                     /* errno set by lookup_dentry */
1421                 goto out_link_d;
1422         /* For now, can only link to files */
1423         if (!S_ISREG(old_d->d_inode->i_mode)) {
1424                 set_errno(EPERM);
1425                 goto out_both_ds;
1426         }
1427         /* Must be on the same FS */
1428         if (old_d->d_sb != link_d->d_sb) {
1429                 set_errno(EXDEV);
1430                 goto out_both_ds;
1431         }
1432         /* Do whatever FS specific stuff there is first (which is also a chance to
1433          * bail out). */
1434         error = parent_dir->i_op->link(old_d, parent_dir, link_d);
1435         if (error) {
1436                 set_errno(-error);
1437                 goto out_both_ds;
1438         }
1439         /* Finally stitch it up */
1440         inode = old_d->d_inode;
1441         kref_get(&inode->i_kref, 1);
1442         link_d->d_inode = inode;
1443         inode->i_nlink++;
1444         TAILQ_INSERT_TAIL(&inode->i_dentry, link_d, d_alias);   /* weak ref */
1445         dcache_put(link_d->d_sb, link_d);
1446         retval = 0;                             /* Note the fall through to the exit paths */
1447 out_both_ds:
1448         kref_put(&old_d->d_kref);
1449 out_link_d:
1450         kref_put(&link_d->d_kref);
1451 out_path_only:
1452         path_release(nd);
1453         return retval;
1454 }
1455
1456 /* Unlinks path from the directory tree.  Read the Documentation for more info.
1457  */
1458 int do_unlink(char *path)
1459 {
1460         struct dentry *dentry;
1461         struct inode *parent_dir;
1462         struct nameidata nd_r = {0}, *nd = &nd_r;
1463         int error;
1464         int retval = -1;
1465
1466         /* get the parent of the target, and don't follow a final link */
1467         error = path_lookup(path, LOOKUP_PARENT, nd);
1468         if (error) {
1469                 set_errno(-error);
1470                 goto out_path_only;
1471         }
1472         parent_dir = nd->dentry->d_inode;
1473         /* make sure the target is there */
1474         dentry = do_lookup(nd->dentry, nd->last.name); 
1475         if (!dentry) {
1476                 set_errno(ENOENT);
1477                 goto out_path_only;
1478         }
1479         /* Make sure the target is not a directory */
1480         if (S_ISDIR(dentry->d_inode->i_mode)) {
1481                 set_errno(EISDIR);
1482                 goto out_dentry;
1483         }
1484         /* Remove the dentry from its parent */
1485         error = parent_dir->i_op->unlink(parent_dir, dentry);
1486         if (error) {
1487                 set_errno(-error);
1488                 goto out_dentry;
1489         }
1490         /* Now that our parent doesn't track us, we need to make sure we aren't
1491          * findable via the dentry cache.  DYING, so we will be freed in
1492          * dentry_release() */
1493         dentry->d_flags |= DENTRY_DYING;
1494         dcache_remove(dentry->d_sb, dentry);
1495         dentry->d_inode->i_nlink--;     /* TODO: race here, esp with a decref */
1496         /* At this point, the dentry is unlinked from the FS, and the inode has one
1497          * less link.  When the in-memory objects (dentry, inode) are going to be
1498          * released (after all open files are closed, and maybe after entries are
1499          * evicted from the cache), then nlinks will get checked and the FS-file
1500          * will get removed from the disk */
1501         retval = 0;                             /* Note the fall through to the exit paths */
1502 out_dentry:
1503         kref_put(&dentry->d_kref);
1504 out_path_only:
1505         path_release(nd);
1506         return retval;
1507 }
1508
1509 /* Checks to see if path can be accessed via mode.  Need to actually send the
1510  * mode along somehow, so this doesn't do much now.  This is an example of
1511  * decent error propagation from the lower levels via int retvals. */
1512 int do_access(char *path, int mode)
1513 {
1514         struct nameidata nd_r = {0}, *nd = &nd_r;
1515         int retval = 0;
1516         nd->intent = LOOKUP_ACCESS;
1517         retval = path_lookup(path, 0, nd);
1518         path_release(nd);       
1519         return retval;
1520 }
1521
1522 int do_chmod(char *path, int mode)
1523 {
1524         struct nameidata nd_r = {0}, *nd = &nd_r;
1525         int retval = 0;
1526         retval = path_lookup(path, 0, nd);
1527         if (!retval) {
1528                 #if 0
1529                 /* TODO: when we have notions of uid, check for the proc's uid */
1530                 if (nd->dentry->d_inode->i_uid != UID_OF_ME)
1531                         retval = -EPERM;
1532                 else
1533                 #endif
1534                         nd->dentry->d_inode->i_mode |= mode & S_PMASK;
1535         }
1536         path_release(nd);       
1537         return retval;
1538 }
1539
1540 /* Make a directory at path with mode.  Returns -1 and sets errno on errors */
1541 int do_mkdir(char *path, int mode)
1542 {
1543         struct dentry *dentry;
1544         struct inode *parent_i;
1545         struct nameidata nd_r = {0}, *nd = &nd_r;
1546         int error;
1547         int retval = -1;
1548
1549         nd->intent = LOOKUP_CREATE;
1550         /* get the parent, but don't follow links */
1551         error = path_lookup(path, LOOKUP_PARENT, nd);
1552         if (error) {
1553                 set_errno(-error);
1554                 goto out_path_only;
1555         }
1556         /* see if the target is already there, handle accordingly */
1557         dentry = do_lookup(nd->dentry, nd->last.name); 
1558         if (dentry) {
1559                 set_errno(EEXIST);
1560                 goto out_dentry;
1561         }
1562         /* Doesn't already exist, let's try to make it: */
1563         dentry = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
1564         if (!dentry) {
1565                 set_errno(ENOMEM);
1566                 goto out_path_only;
1567         }
1568         parent_i = nd->dentry->d_inode;
1569         if (create_dir(parent_i, dentry, mode))
1570                 goto out_dentry;
1571         dcache_put(dentry->d_sb, dentry);
1572         retval = 0;                             /* Note the fall through to the exit paths */
1573 out_dentry:
1574         kref_put(&dentry->d_kref);
1575 out_path_only:
1576         path_release(nd);
1577         return retval;
1578 }
1579
1580 int do_rmdir(char *path)
1581 {
1582         struct dentry *dentry;
1583         struct inode *parent_i;
1584         struct nameidata nd_r = {0}, *nd = &nd_r;
1585         int error;
1586         int retval = -1;
1587
1588         /* get the parent, following links (probably want this), and we must get a
1589          * directory.  Note, current versions of path_lookup can't handle both
1590          * PARENT and DIRECTORY, at least, it doesn't check that *path is a
1591          * directory. */
1592         error = path_lookup(path, LOOKUP_PARENT | LOOKUP_FOLLOW | LOOKUP_DIRECTORY,
1593                             nd);
1594         if (error) {
1595                 set_errno(-error);
1596                 goto out_path_only;
1597         }
1598         /* make sure the target is already there, handle accordingly */
1599         dentry = do_lookup(nd->dentry, nd->last.name); 
1600         if (!dentry) {
1601                 set_errno(ENOENT);
1602                 goto out_path_only;
1603         }
1604         if (!S_ISDIR(dentry->d_inode->i_mode)) {
1605                 set_errno(ENOTDIR);
1606                 goto out_dentry;
1607         }
1608         if (dentry->d_mount_point) {
1609                 set_errno(EBUSY);
1610                 goto out_dentry;
1611         }
1612         /* TODO: make sure we aren't a mount or processes root (EBUSY) */
1613         /* Now for the removal.  the FSs will check if they are empty */
1614         parent_i = nd->dentry->d_inode;
1615         error = parent_i->i_op->rmdir(parent_i, dentry);
1616         if (error < 0) {
1617                 set_errno(-error);
1618                 goto out_dentry;
1619         }
1620         /* Now that our parent doesn't track us, we need to make sure we aren't
1621          * findable via the dentry cache.  DYING, so we will be freed in
1622          * dentry_release() */
1623         dentry->d_flags |= DENTRY_DYING;
1624         dcache_remove(dentry->d_sb, dentry);
1625         /* Decref ourselves, so inode_release() knows we are done */
1626         dentry->d_inode->i_nlink--;
1627         TAILQ_REMOVE(&nd->dentry->d_subdirs, dentry, d_subdirs_link);
1628         parent_i->i_nlink--;            /* TODO: race on this, esp since its a decref */
1629         /* we still have d_parent and a kref on our parent, which will go away when
1630          * the in-memory dentry object goes away. */
1631         retval = 0;                             /* Note the fall through to the exit paths */
1632 out_dentry:
1633         kref_put(&dentry->d_kref);
1634 out_path_only:
1635         path_release(nd);
1636         return retval;
1637 }
1638
1639 /* Opens and returns the file specified by dentry */
1640 struct file *dentry_open(struct dentry *dentry, int flags)
1641 {
1642         struct inode *inode;
1643         int desired_mode;
1644         struct file *file = kmem_cache_alloc(file_kcache, 0);
1645         if (!file) {
1646                 set_errno(ENOMEM);
1647                 return 0;
1648         }
1649         inode = dentry->d_inode;
1650         /* Do the mode first, since we can still error out.  f_mode stores how the
1651          * OS file is open, which can be more restrictive than the i_mode */
1652         switch (flags & (O_RDONLY | O_WRONLY | O_RDWR)) {
1653                 case O_RDONLY:
1654                         desired_mode = S_IRUSR;
1655                         break;
1656                 case O_WRONLY:
1657                         desired_mode = S_IWUSR;
1658                         break;
1659                 case O_RDWR:
1660                         desired_mode = S_IRUSR | S_IWUSR;
1661                         break;
1662                 default:
1663                         goto error_access;
1664         }
1665         if (check_perms(inode, desired_mode))
1666                 goto error_access;
1667         file->f_mode = desired_mode;
1668         /* one for the ref passed out, and *none* for the sb TAILQ */
1669         kref_init(&file->f_kref, file_release, 1);
1670         /* Add to the list of all files of this SB */
1671         TAILQ_INSERT_TAIL(&inode->i_sb->s_files, file, f_list);
1672         kref_get(&dentry->d_kref, 1);
1673         file->f_dentry = dentry;
1674         kref_get(&inode->i_sb->s_mount->mnt_kref, 1);
1675         file->f_vfsmnt = inode->i_sb->s_mount;          /* saving a ref to the vmnt...*/
1676         file->f_op = inode->i_fop;
1677         /* Don't store open mode or creation flags */
1678         file->f_flags = flags & ~(O_ACCMODE | O_CREAT_FLAGS);
1679         file->f_pos = 0;
1680         file->f_uid = inode->i_uid;
1681         file->f_gid = inode->i_gid;
1682         file->f_error = 0;
1683 //      struct event_poll_tailq         f_ep_links;
1684         spinlock_init(&file->f_ep_lock);
1685         file->f_fs_info = 0;                                            /* prob overriden by the fs */
1686         file->f_mapping = inode->i_mapping;
1687         file->f_op->open(inode, file);
1688         return file;
1689 error_access:
1690         set_errno(EACCES);
1691         kmem_cache_free(file_kcache, file);
1692         return 0;
1693 }
1694
1695 /* Closes a file, fsync, whatever else is necessary.  Called when the kref hits
1696  * 0.  Note that the file is not refcounted on the s_files list, nor is the
1697  * f_mapping refcounted (it is pinned by the i_mapping). */
1698 void file_release(struct kref *kref)
1699 {
1700         struct file *file = container_of(kref, struct file, f_kref);
1701
1702         struct super_block *sb = file->f_dentry->d_sb;
1703         spin_lock(&sb->s_lock);
1704         TAILQ_REMOVE(&sb->s_files, file, f_list);
1705         spin_unlock(&sb->s_lock);
1706
1707         /* TODO: fsync (BLK).  also, we may want to parallelize the blocking that
1708          * could happen in here (spawn kernel threads)... */
1709         file->f_op->release(file->f_dentry->d_inode, file);
1710         /* Clean up the other refs we hold */
1711         kref_put(&file->f_dentry->d_kref);
1712         kref_put(&file->f_vfsmnt->mnt_kref);
1713         kmem_cache_free(file_kcache, file);
1714 }
1715
1716 /* Process-related File management functions */
1717
1718 /* Given any FD, get the appropriate file, 0 o/w */
1719 struct file *get_file_from_fd(struct files_struct *open_files, int file_desc)
1720 {
1721         struct file *retval = 0;
1722         if (file_desc < 0)
1723                 return 0;
1724         spin_lock(&open_files->lock);
1725         if (file_desc < open_files->max_fdset) {
1726                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
1727                         /* while max_files and max_fdset might not line up, we should never
1728                          * have a valid fdset higher than files */
1729                         assert(file_desc < open_files->max_files);
1730                         retval = open_files->fd[file_desc].fd_file;
1731                         assert(retval);
1732                         kref_get(&retval->f_kref, 1);
1733                 }
1734         }
1735         spin_unlock(&open_files->lock);
1736         return retval;
1737 }
1738
1739 /* Remove FD from the open files, if it was there, and return f.  Currently,
1740  * this decref's f, so the return value is not consumable or even usable.  This
1741  * hasn't been thought through yet. */
1742 struct file *put_file_from_fd(struct files_struct *open_files, int file_desc)
1743 {
1744         struct file *file = 0;
1745         if (file_desc < 0)
1746                 return 0;
1747         spin_lock(&open_files->lock);
1748         if (file_desc < open_files->max_fdset) {
1749                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
1750                         /* while max_files and max_fdset might not line up, we should never
1751                          * have a valid fdset higher than files */
1752                         assert(file_desc < open_files->max_files);
1753                         file = open_files->fd[file_desc].fd_file;
1754                         open_files->fd[file_desc].fd_file = 0;
1755                         assert(file);
1756                         kref_put(&file->f_kref);
1757                         CLR_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc);
1758                 }
1759         }
1760         spin_unlock(&open_files->lock);
1761         return file;
1762 }
1763
1764 /* Inserts the file in the files_struct, returning the corresponding new file
1765  * descriptor, or an error code.  We start looking for open fds from low_fd. */
1766 int insert_file(struct files_struct *open_files, struct file *file, int low_fd)
1767 {
1768         int slot = -1;
1769         if ((low_fd < 0) || (low_fd > NR_FILE_DESC_MAX))
1770                 return -EINVAL;
1771         spin_lock(&open_files->lock);
1772         for (int i = low_fd; i < open_files->max_fdset; i++) {
1773                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, i))
1774                         continue;
1775                 slot = i;
1776                 SET_BITMASK_BIT(open_files->open_fds->fds_bits, slot);
1777                 assert(slot < open_files->max_files &&
1778                        open_files->fd[slot].fd_file == 0);
1779                 kref_get(&file->f_kref, 1);
1780                 open_files->fd[slot].fd_file = file;
1781                 open_files->fd[slot].fd_flags = 0;
1782                 if (slot >= open_files->next_fd)
1783                         open_files->next_fd = slot + 1;
1784                 break;
1785         }
1786         if (slot == -1) /* should expand the FD array and fd_set */
1787                 warn("Ran out of file descriptors, deal with me!");
1788         spin_unlock(&open_files->lock);
1789         return slot;
1790 }
1791
1792 /* Closes all open files.  Mostly just a "put" for all files.  If cloexec, it
1793  * will only close files that are opened with O_CLOEXEC. */
1794 void close_all_files(struct files_struct *open_files, bool cloexec)
1795 {
1796         struct file *file;
1797         spin_lock(&open_files->lock);
1798         for (int i = 0; i < open_files->max_fdset; i++) {
1799                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, i)) {
1800                         /* while max_files and max_fdset might not line up, we should never
1801                          * have a valid fdset higher than files */
1802                         assert(i < open_files->max_files);
1803                         file = open_files->fd[i].fd_file;
1804                         if (cloexec && !(open_files->fd[i].fd_flags & O_CLOEXEC))
1805                                 continue;
1806                         /* Actually close the file */
1807                         open_files->fd[i].fd_file = 0;
1808                         assert(file);
1809                         kref_put(&file->f_kref);
1810                         CLR_BITMASK_BIT(open_files->open_fds->fds_bits, i);
1811                 }
1812         }
1813         spin_unlock(&open_files->lock);
1814 }
1815
1816 /* Inserts all of the files from src into dst, used by sys_fork(). */
1817 void clone_files(struct files_struct *src, struct files_struct *dst)
1818 {
1819         struct file *file;
1820         spin_lock(&src->lock);
1821         spin_lock(&dst->lock);
1822         for (int i = 0; i < src->max_fdset; i++) {
1823                 if (GET_BITMASK_BIT(src->open_fds->fds_bits, i)) {
1824                         /* while max_files and max_fdset might not line up, we should never
1825                          * have a valid fdset higher than files */
1826                         assert(i < src->max_files);
1827                         file = src->fd[i].fd_file;
1828                         assert(i < dst->max_files && dst->fd[i].fd_file == 0);
1829                         SET_BITMASK_BIT(dst->open_fds->fds_bits, i);
1830                         dst->fd[i].fd_file = file;
1831                         assert(file);
1832                         kref_get(&file->f_kref, 1);
1833                         if (i >= dst->next_fd)
1834                                 dst->next_fd = i + 1;
1835                 }
1836         }
1837         spin_unlock(&dst->lock);
1838         spin_unlock(&src->lock);
1839 }
1840
1841 /* Change the working directory of the given fs env (one per process, at this
1842  * point).  Returns 0 for success, -ERROR for whatever error. */
1843 int do_chdir(struct fs_struct *fs_env, char *path)
1844 {
1845         struct nameidata nd_r = {0}, *nd = &nd_r;
1846         int retval;
1847         retval = path_lookup(path, LOOKUP_DIRECTORY, nd);
1848         if (!retval) {
1849                 /* nd->dentry is the place we want our PWD to be */
1850                 kref_get(&nd->dentry->d_kref, 1);
1851                 kref_put(&fs_env->pwd->d_kref);
1852                 fs_env->pwd = nd->dentry;
1853         }
1854         path_release(nd);
1855         return retval;
1856 }
1857
1858 /* Returns a null-terminated string of up to length cwd_l containing the
1859  * absolute path of fs_env, (up to fs_env's root).  Be sure to kfree the char*
1860  * "kfree_this" when you are done with it.  We do this since it's easier to
1861  * build this string going backwards.  Note cwd_l is not a strlen, it's an
1862  * absolute size. */
1863 char *do_getcwd(struct fs_struct *fs_env, char **kfree_this, size_t cwd_l)
1864 {
1865         struct dentry *dentry = fs_env->pwd;
1866         size_t link_len;
1867         char *path_start, *kbuf;
1868
1869         if (cwd_l < 2) {
1870                 set_errno(ERANGE);
1871                 return 0;
1872         }
1873         kbuf = kmalloc(cwd_l, 0);
1874         if (!kbuf) {
1875                 set_errno(ENOMEM);
1876                 return 0;
1877         }
1878         *kfree_this = kbuf;
1879         kbuf[cwd_l - 1] = '\0';
1880         kbuf[cwd_l - 2] = '/';
1881         /* for each dentry in the path, all the way back to the root of fs_env, we
1882          * grab the dentry name, push path_start back enough, and write in the name,
1883          * using /'s to terminate.  We skip the root, since we don't want it's
1884          * actual name, just "/", which is set before each loop. */
1885         path_start = kbuf + cwd_l - 2;  /* the last byte written */
1886         while (dentry != fs_env->root) {
1887                 link_len = dentry->d_name.len;          /* this does not count the \0 */
1888                 if (path_start - (link_len + 2) < kbuf) {
1889                         kfree(kbuf);
1890                         set_errno(ERANGE);
1891                         return 0;
1892                 }
1893                 path_start -= link_len + 1;     /* the 1 is for the \0 */
1894                 strncpy(path_start, dentry->d_name.name, link_len);
1895                 path_start--;
1896                 *path_start = '/';
1897                 dentry = dentry->d_parent;      
1898         }
1899         return path_start;
1900 }
1901
1902 static void print_dir(struct dentry *dentry, char *buf, int depth)
1903 {
1904         struct dentry *child_d;
1905         struct dirent next = {0};
1906         struct file *dir;
1907         int retval;
1908
1909         if (!S_ISDIR(dentry->d_inode->i_mode)) {
1910                 warn("Thought this was only directories!!");
1911                 return;
1912         }
1913         /* Print this dentry */
1914         printk("%s%s/ nlink: %d\n", buf, dentry->d_name.name,
1915                dentry->d_inode->i_nlink);
1916         if (dentry->d_mount_point) {
1917                 dentry = dentry->d_mounted_fs->mnt_root;
1918         }
1919         if (depth >= 32)
1920                 return;
1921         /* Set buffer for our kids */
1922         buf[depth] = '\t';
1923         dir = dentry_open(dentry, 0);
1924         if (!dir)
1925                 panic("Filesystem seems inconsistent - unable to open a dir!");
1926         /* Process every child, recursing on directories */
1927         while (1) {
1928                 retval = dir->f_op->readdir(dir, &next);
1929                 if (retval >= 0) {
1930                         /* Skip .., ., and empty entries */
1931                         if (!strcmp("..", next.d_name) || !strcmp(".", next.d_name) ||
1932                             next.d_ino == 0)
1933                                 goto loop_next;
1934                         /* there is an entry, now get its dentry */
1935                         child_d = do_lookup(dentry, next.d_name);
1936                         if (!child_d)
1937                                 panic("Inconsistent FS, dirent doesn't have a dentry!");
1938                         /* Recurse for directories, or just print the name for others */
1939                         switch (child_d->d_inode->i_mode & __S_IFMT) {
1940                                 case (__S_IFDIR):
1941                                         print_dir(child_d, buf, depth + 1);
1942                                         break;
1943                                 case (__S_IFREG):
1944                                         printk("%s%s size(B): %d nlink: %d\n", buf, next.d_name,
1945                                                child_d->d_inode->i_size, child_d->d_inode->i_nlink);
1946                                         break;
1947                                 case (__S_IFLNK):
1948                                         printk("%s%s -> %s\n", buf, next.d_name,
1949                                                child_d->d_inode->i_op->readlink(child_d));
1950                                         break;
1951                                 case (__S_IFCHR):
1952                                         printk("%s%s (char device) nlink: %d\n", buf, next.d_name,
1953                                                child_d->d_inode->i_nlink);
1954                                         break;
1955                                 case (__S_IFBLK):
1956                                         printk("%s%s (block device) nlink: %d\n", buf, next.d_name,
1957                                                child_d->d_inode->i_nlink);
1958                                         break;
1959                                 default:
1960                                         warn("Look around you!  Unknown filetype!");
1961                         }
1962                         kref_put(&child_d->d_kref);     
1963                 }
1964 loop_next:
1965                 if (retval <= 0)
1966                         break;
1967         }
1968         /* Reset buffer to the way it was */
1969         buf[depth] = '\0';
1970         kref_put(&dir->f_kref);
1971 }
1972
1973 /* Debugging */
1974 int ls_dash_r(char *path)
1975 {
1976         struct nameidata nd_r = {0}, *nd = &nd_r;
1977         int error;
1978         char buf[32] = {0};
1979
1980         error = path_lookup(path, LOOKUP_ACCESS | LOOKUP_DIRECTORY, nd);
1981         if (error) {
1982                 path_release(nd);
1983                 return error;
1984         }
1985         print_dir(nd->dentry, buf, 0);
1986         path_release(nd);
1987         return 0;
1988 }