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