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