fchdir() (XCC)
[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
44          * now).  fields related to the actual FS, like the sb and the mnt_root are
45          * set in the fs-specific get_sb() call. */
46         if (!mnt_pt) {
47                 vmnt->mnt_parent = NULL;
48                 vmnt->mnt_mountpoint = NULL;
49         } else { /* common case, but won't be tested til we try to mount another FS */
50                 mnt_pt->d_mount_point = TRUE;
51                 mnt_pt->d_mounted_fs = vmnt;
52                 kref_get(&vmnt->mnt_kref, 1); /* held by mnt_pt */
53                 vmnt->mnt_parent = mnt_pt->d_sb->s_mount;
54                 vmnt->mnt_mountpoint = mnt_pt;
55         }
56         TAILQ_INIT(&vmnt->mnt_child_mounts);
57         vmnt->mnt_flags = flags;
58         vmnt->mnt_devname = dev_name;
59         vmnt->mnt_namespace = ns;
60         kref_get(&ns->kref, 1); /* held by vmnt */
61
62         /* Read in / create the SB */
63         sb = fs->get_sb(fs, flags, dev_name, vmnt);
64         if (!sb)
65                 panic("You're FS sucks");
66
67         /* TODO: consider moving this into get_sb or something, in case the SB
68          * already exists (mounting again) (if we support that) */
69         spin_lock(&super_blocks_lock);
70         TAILQ_INSERT_TAIL(&super_blocks, sb, s_list); /* storing a ref here... */
71         spin_unlock(&super_blocks_lock);
72
73         /* Update holding NS */
74         spin_lock(&ns->lock);
75         TAILQ_INSERT_TAIL(&ns->vfsmounts, vmnt, mnt_list);
76         spin_unlock(&ns->lock);
77         /* note to self: so, right after this point, the NS points to the root FS
78          * mount (we return the mnt, which gets assigned), the root mnt has a dentry
79          * for /, backed by an inode, with a SB prepped and in memory. */
80         return vmnt;
81 }
82
83 void vfs_init(void)
84 {
85         struct fs_type *fs;
86
87         dentry_kcache = kmem_cache_create("dentry", sizeof(struct dentry),
88                                           __alignof__(struct dentry), 0, 0, 0);
89         inode_kcache = kmem_cache_create("inode", sizeof(struct inode),
90                                          __alignof__(struct inode), 0, 0, 0);
91         file_kcache = kmem_cache_create("file", sizeof(struct file),
92                                         __alignof__(struct file), 0, 0, 0);
93         /* default NS never dies, +1 to exist */
94         kref_init(&default_ns.kref, fake_release, 1);
95         spinlock_init(&default_ns.lock);
96         default_ns.root = NULL;
97         TAILQ_INIT(&default_ns.vfsmounts);
98
99         /* build list of all FS's in the system.  put yours here.  if this is ever
100          * done on the fly, we'll need to lock. */
101         TAILQ_INSERT_TAIL(&file_systems, &kfs_fs_type, list);
102 #ifdef CONFIG_EXT2FS
103         TAILQ_INSERT_TAIL(&file_systems, &ext2_fs_type, list);
104 #endif
105         TAILQ_FOREACH(fs, &file_systems, list)
106                 printk("Supports the %s Filesystem\n", fs->name);
107
108         /* mounting KFS at the root (/), pending root= parameters */
109         // TODO: linux creates a temp root_fs, then mounts the real root onto that
110         default_ns.root = __mount_fs(&kfs_fs_type, "RAM", NULL, 0, &default_ns);
111
112         printk("vfs_init() completed\n");
113 }
114
115 /* Builds / populates the qstr of a dentry based on its d_iname.  If there is an
116  * l_name, (long), it will use that instead of the inline name.  This will
117  * probably change a bit. */
118 void qstr_builder(struct dentry *dentry, char *l_name)
119 {
120         dentry->d_name.name = l_name ? l_name : dentry->d_iname;
121         // TODO: pending what we actually do in d_hash
122         //dentry->d_name.hash = dentry->d_op->d_hash(dentry, &dentry->d_name); 
123         dentry->d_name.hash = 0xcafebabe;
124         dentry->d_name.len = strnlen(dentry->d_name.name, MAX_FILENAME_SZ);
125 }
126
127 /* Useful little helper - return the string ptr for a given file */
128 char *file_name(struct file *file)
129 {
130         return file->f_dentry->d_name.name;
131 }
132
133 /* Some issues with this, coupled closely to fs_lookup.
134  *
135  * Note the use of __dentry_free, instead of kref_put.  In those cases, we don't
136  * want to treat it like a kref and we have the only reference to it, so it is
137  * okay to do this.  It makes dentry_release() easier too. */
138 static struct dentry *do_lookup(struct dentry *parent, char *name)
139 {
140         struct dentry *result, *query;
141         query = get_dentry(parent->d_sb, parent, name);
142         if (!query) {
143                 warn("OOM in do_lookup(), probably wasn't expected\n");
144                 return 0;
145         }
146         result = dcache_get(parent->d_sb, query); 
147         if (result) {
148                 __dentry_free(query);
149                 return result;
150         }
151         /* No result, check for negative */
152         if (query->d_flags & DENTRY_NEGATIVE) {
153                 __dentry_free(query);
154                 return 0;
155         }
156         /* not in the dcache at all, need to consult the FS */
157         result = parent->d_inode->i_op->lookup(parent->d_inode, query, 0);
158         if (!result) {
159                 /* Note the USED flag will get turned off when this gets added to the
160                  * LRU in dentry_release().  There's a slight race here that we'll panic
161                  * on, but I want to catch it (in dcache_put()) for now. */
162                 query->d_flags |= DENTRY_NEGATIVE;
163                 dcache_put(parent->d_sb, query);
164                 kref_put(&query->d_kref);
165                 return 0;
166         }
167         dcache_put(parent->d_sb, result);
168         /* This is because KFS doesn't return the same dentry, but ext2 does.  this
169          * is ugly and needs to be fixed. (TODO) */
170         if (result != query)
171                 __dentry_free(query);
172
173         /* TODO: if the following are done by us, how do we know the i_ino?
174          * also need to handle inodes that are already read in!  For now, we're
175          * going to have the FS handle it in it's lookup() method: 
176          * - get a new inode
177          * - read in the inode
178          * - put in the inode cache */
179         return result;
180 }
181
182 /* Update ND such that it represents having followed dentry.  IAW the nd
183  * refcnting rules, we need to decref any references that were in there before
184  * they get clobbered. */
185 static int next_link(struct dentry *dentry, struct nameidata *nd)
186 {
187         assert(nd->dentry && nd->mnt);
188         /* update the dentry */
189         kref_get(&dentry->d_kref, 1);
190         kref_put(&nd->dentry->d_kref);
191         nd->dentry = dentry;
192         /* update the mount, if we need to */
193         if (dentry->d_sb->s_mount != nd->mnt) {
194                 kref_get(&dentry->d_sb->s_mount->mnt_kref, 1);
195                 kref_put(&nd->mnt->mnt_kref);
196                 nd->mnt = dentry->d_sb->s_mount;
197         }
198         return 0;
199 }
200
201 /* Walk up one directory, being careful of mountpoints, namespaces, and the top
202  * of the FS */
203 static int climb_up(struct nameidata *nd)
204 {
205         printd("CLIMB_UP, from %s\n", nd->dentry->d_name.name);
206         /* Top of the world, just return.  Should also check for being at the top of
207          * the current process's namespace (TODO) */
208         if (!nd->dentry->d_parent || (nd->dentry->d_parent == nd->dentry))
209                 return -1;
210         /* Check if we are at the top of a mount, if so, we need to follow
211          * backwards, and then climb_up from that one.  We might need to climb
212          * multiple times if we mount multiple FSs at the same spot (highly
213          * unlikely).  This is completely untested.  Might recurse instead. */
214         while (nd->mnt->mnt_root == nd->dentry) {
215                 if (!nd->mnt->mnt_parent) {
216                         warn("Might have expected a parent vfsmount (dentry had a parent)");
217                         return -1;
218                 }
219                 next_link(nd->mnt->mnt_mountpoint, nd);
220         }
221         /* Backwards walk (no mounts or any other issues now). */
222         next_link(nd->dentry->d_parent, nd);
223         printd("CLIMB_UP, to   %s\n", nd->dentry->d_name.name);
224         return 0;
225 }
226
227 /* nd->dentry might be on a mount point, so we need to move on to the child
228  * mount's root. */
229 static int follow_mount(struct nameidata *nd)
230 {
231         if (!nd->dentry->d_mount_point)
232                 return 0;
233         next_link(nd->dentry->d_mounted_fs->mnt_root, nd);
234         return 0;
235 }
236
237 static int link_path_walk(char *path, struct nameidata *nd);
238
239 /* When nd->dentry is for a symlink, this will recurse and follow that symlink,
240  * so that nd contains the results of following the symlink (dentry and mnt).
241  * Returns when it isn't a symlink, 1 on following a link, and < 0 on error. */
242 static int follow_symlink(struct nameidata *nd)
243 {
244         int retval;
245         char *symname;
246         if (!S_ISLNK(nd->dentry->d_inode->i_mode))
247                 return 0;
248         if (nd->depth > MAX_SYMLINK_DEPTH)
249                 return -ELOOP;
250         printd("Following symlink for dentry %p %s\n", nd->dentry,
251                nd->dentry->d_name.name);
252         nd->depth++;
253         symname = nd->dentry->d_inode->i_op->readlink(nd->dentry);
254         /* We need to pin in nd->dentry (the dentry of the symlink), since we need
255          * it's symname's storage to stay in memory throughout the upcoming
256          * link_path_walk().  The last_sym gets decreffed when we path_release() or
257          * follow another symlink. */
258         if (nd->last_sym)
259                 kref_put(&nd->last_sym->d_kref);
260         kref_get(&nd->dentry->d_kref, 1);
261         nd->last_sym = nd->dentry;
262         /* If this an absolute path in the symlink, we need to free the old path and
263          * start over, otherwise, we continue from the PARENT of nd (the symlink) */
264         if (symname[0] == '/') {
265                 path_release(nd);
266                 if (!current)
267                         nd->dentry = default_ns.root->mnt_root;
268                 else
269                         nd->dentry = current->fs_env.root;      
270                 nd->mnt = nd->dentry->d_sb->s_mount;
271                 kref_get(&nd->mnt->mnt_kref, 1);
272                 kref_get(&nd->dentry->d_kref, 1);
273         } else {
274                 climb_up(nd);
275         }
276         /* either way, keep on walking in the free world! */
277         retval = link_path_walk(symname, nd);
278         return (retval == 0 ? 1 : retval);
279 }
280
281 /* Little helper, to make it easier to break out of the nested loops.  Will also
282  * '\0' out the first slash if it's slashes all the way down.  Or turtles. */
283 static bool packed_trailing_slashes(char *first_slash)
284 {
285         for (char *i = first_slash; *i == '/'; i++) {
286                 if (*(i + 1) == '\0') {
287                         *first_slash = '\0';
288                         return TRUE;
289                 }
290         }
291         return FALSE;
292 }
293
294 /* Simple helper to set nd to track it's last name to be Name.  Also be careful
295  * with the storage of name.  Don't use and nd's name past the lifetime of the
296  * string used in the path_lookup()/link_path_walk/whatever.  Consider replacing
297  * parts of this with a qstr builder.  Note this uses the dentry's d_op, which
298  * might not be the dentry we care about. */
299 static void stash_nd_name(struct nameidata *nd, char *name)
300 {
301         nd->last.name = name;
302         nd->last.len = strlen(name);
303         nd->last.hash = nd->dentry->d_op->d_hash(nd->dentry, &nd->last);
304 }
305
306 /* Resolves the links in a basic path walk.  0 for success, -EWHATEVER
307  * otherwise.  The final lookup is returned via nd. */
308 static int link_path_walk(char *path, struct nameidata *nd)
309 {
310         struct dentry *link_dentry;
311         struct inode *link_inode, *nd_inode;
312         char *next_slash;
313         char *link = path;
314         int error;
315
316         /* Prevent crazy recursion */
317         if (nd->depth > MAX_SYMLINK_DEPTH)
318                 return -ELOOP;
319         /* skip all leading /'s */
320         while (*link == '/')
321                 link++;
322         /* if there's nothing left (null terminated), we're done.  This should only
323          * happen for "/", which if we wanted a PARENT, should fail (there is no
324          * parent). */
325         if (*link == '\0') {
326                 if (nd->flags & LOOKUP_PARENT) {
327                         set_errno(ENOENT);
328                         return -1;
329                 }
330                 /* o/w, we're good */
331                 return 0;
332         }
333         /* iterate through each intermediate link of the path.  in general, nd
334          * tracks where we are in the path, as far as dentries go.  once we have the
335          * next dentry, we try to update nd based on that dentry.  link is the part
336          * of the path string that we are looking up */
337         while (1) {
338                 nd_inode = nd->dentry->d_inode;
339                 if ((error = check_perms(nd_inode, nd->intent)))
340                         return error;
341                 /* find the next link, break out if it is the end */
342                 next_slash = strchr(link, '/');
343                 if (!next_slash) {
344                         break;
345                 } else {
346                         if (packed_trailing_slashes(next_slash)) {
347                                 nd->flags |= LOOKUP_DIRECTORY;
348                                 break;
349                         }
350                 }
351                 /* skip over any interim ./ */
352                 if (!strncmp("./", link, 2))
353                         goto next_loop;
354                 /* Check for "../", walk up */
355                 if (!strncmp("../", link, 3)) {
356                         climb_up(nd);
357                         goto next_loop;
358                 }
359                 *next_slash = '\0';
360                 link_dentry = do_lookup(nd->dentry, link);
361                 *next_slash = '/';
362                 if (!link_dentry)
363                         return -ENOENT;
364                 /* make link_dentry the current step/answer */
365                 next_link(link_dentry, nd);
366                 kref_put(&link_dentry->d_kref); /* do_lookup gave us a refcnt dentry */
367                 /* we could be on a mountpoint or a symlink - need to follow them */
368                 follow_mount(nd);
369                 if ((error = follow_symlink(nd)) < 0)
370                         return error;
371                 /* Turn off a possible DIRECTORY lookup, which could have been set
372                  * during the follow_symlink (a symlink could have had a directory at
373                  * the end), though it was in the middle of the real path. */
374                 nd->flags &= ~LOOKUP_DIRECTORY;
375                 if (!S_ISDIR(nd->dentry->d_inode->i_mode))
376                         return -ENOTDIR;
377 next_loop:
378                 /* move through the path string to the next entry */
379                 link = next_slash + 1;
380                 /* advance past any other interim slashes.  we know we won't hit the end
381                  * due to the for loop check above */
382                 while (*link == '/')
383                         link++;
384         }
385         /* Now, we're on the last link of the path.  We need to deal with with . and
386          * .. .  This might be weird with PARENT lookups - not sure what semantics
387          * we want exactly.  This will give the parent of whatever the PATH was
388          * supposed to look like.  Note that ND currently points to the parent of
389          * the last item (link). */
390         if (!strcmp(".", link)) {
391                 if (nd->flags & LOOKUP_PARENT) {
392                         assert(nd->dentry->d_name.name);
393                         stash_nd_name(nd, nd->dentry->d_name.name);
394                         climb_up(nd);
395                 }
396                 return 0;
397         }
398         if (!strcmp("..", link)) {
399                 climb_up(nd);
400                 if (nd->flags & LOOKUP_PARENT) {
401                         assert(nd->dentry->d_name.name);
402                         stash_nd_name(nd, nd->dentry->d_name.name);
403                         climb_up(nd);
404                 }
405                 return 0;
406         }
407         /* need to attempt to look it up, in case it's a symlink */
408         link_dentry = do_lookup(nd->dentry, link);
409         if (!link_dentry) {
410                 /* if there's no dentry, we are okay if we are looking for the parent */
411                 if (nd->flags & LOOKUP_PARENT) {
412                         assert(strcmp(link, ""));
413                         stash_nd_name(nd, link);
414                         return 0;
415                 } else {
416                         return -ENOENT;
417                 }
418         }
419         next_link(link_dentry, nd);
420         kref_put(&link_dentry->d_kref); /* do_lookup gave us a refcnt'd dentry */
421         /* at this point, nd is on the final link, but it might be a symlink */
422         if (nd->flags & LOOKUP_FOLLOW) {
423                 error = follow_symlink(nd);
424                 if (error < 0)
425                         return error;
426                 /* if we actually followed a symlink, then nd is set and we're done */
427                 if (error > 0)
428                         return 0;
429         }
430         /* One way or another, nd is on the last element of the path, symlinks and
431          * all.  Now we need to climb up to set nd back on the parent, if that's
432          * what we wanted */
433         if (nd->flags & LOOKUP_PARENT) {
434                 assert(nd->dentry->d_name.name);
435                 stash_nd_name(nd, link_dentry->d_name.name);
436                 climb_up(nd);
437                 return 0;
438         }
439         /* now, we have the dentry set, and don't want the parent, but might be on a
440          * mountpoint still.  FYI: this hasn't been thought through completely. */
441         follow_mount(nd);
442         /* If we wanted a directory, but didn't get one, error out */
443         if ((nd->flags & LOOKUP_DIRECTORY) && !S_ISDIR(nd->dentry->d_inode->i_mode))
444                 return -ENOTDIR;
445         return 0;
446 }
447
448 /* Given path, return the inode for the final dentry.  The ND should be
449  * initialized for the first call - specifically, we need the intent. 
450  * LOOKUP_PARENT and friends go in the flags var, which is not the intent.
451  *
452  * If path_lookup wants a PARENT, but hits the top of the FS (root or
453  * otherwise), we want it to error out.  It's still unclear how we want to
454  * handle processes with roots that aren't root, but at the very least, we don't
455  * want to think we have the parent of /, but have / itself.  Due to the way
456  * link_path_walk works, if that happened, we probably don't have a
457  * nd->last.name.  This needs more thought (TODO).
458  *
459  * Need to be careful too.  While the path has been copied-in to the kernel,
460  * it's still user input.  */
461 int path_lookup(char *path, int flags, struct nameidata *nd)
462 {
463         int retval;
464         printd("Path lookup for %s\n", path);
465         /* we allow absolute lookups with no process context */
466         /* TODO: RCU read lock on pwd or kref_not_zero in a loop.  concurrent chdir
467          * could decref nd->dentry before we get to incref it below. */
468         if (path[0] == '/') {                   /* absolute lookup */
469                 if (!current)
470                         nd->dentry = default_ns.root->mnt_root;
471                 else
472                         nd->dentry = current->fs_env.root;      
473         } else {                                                /* relative lookup */
474                 assert(current);
475                 /* Don't need to lock on the fs_env since we're reading one item */
476                 nd->dentry = current->fs_env.pwd;       
477         }
478         nd->mnt = nd->dentry->d_sb->s_mount;
479         /* Whenever references get put in the nd, incref them.  Whenever they are
480          * removed, decref them. */
481         kref_get(&nd->mnt->mnt_kref, 1);
482         kref_get(&nd->dentry->d_kref, 1);
483         nd->flags = flags;
484         nd->depth = 0;                                  /* used in symlink following */
485         retval =  link_path_walk(path, nd);     
486         /* make sure our PARENT lookup worked */
487         if (!retval && (flags & LOOKUP_PARENT))
488                 assert(nd->last.name);
489         return retval;
490 }
491
492 /* Call this after any use of path_lookup when you are done with its results,
493  * regardless of whether it succeeded or not.  It will free any references */
494 void path_release(struct nameidata *nd)
495 {
496         kref_put(&nd->dentry->d_kref);
497         kref_put(&nd->mnt->mnt_kref);
498         /* Free the last symlink dentry used, if there was one */
499         if (nd->last_sym) {
500                 kref_put(&nd->last_sym->d_kref);
501                 nd->last_sym = 0;                       /* catch reuse bugs */
502         }
503 }
504
505 /* External version of mount, only call this after having a / mount */
506 int mount_fs(struct fs_type *fs, char *dev_name, char *path, int flags)
507 {
508         struct nameidata nd_r = {0}, *nd = &nd_r;
509         int retval = 0;
510         retval = path_lookup(path, LOOKUP_DIRECTORY, nd);
511         if (retval)
512                 goto out;
513         /* taking the namespace of the vfsmount of path */ 
514         if (!__mount_fs(fs, dev_name, nd->dentry, flags, nd->mnt->mnt_namespace))
515                 retval = -EINVAL;
516 out:
517         path_release(nd);
518         return retval;
519 }
520
521 /* Superblock functions */
522
523 /* Dentry "hash" function for the hash table to use.  Since we already have the
524  * hash in the qstr, we don't need to rehash.  Also, note we'll be using the
525  * dentry in question as both the key and the value. */
526 static size_t __dcache_hash(void *k)
527 {
528         return (size_t)((struct dentry*)k)->d_name.hash;
529 }
530
531 /* Dentry cache hashtable equality function.  This means we need to pass in some
532  * minimal dentry when doing a lookup. */
533 static ssize_t __dcache_eq(void *k1, void *k2)
534 {
535         if (((struct dentry*)k1)->d_parent != ((struct dentry*)k2)->d_parent)
536                 return 0;
537         /* TODO: use the FS-specific string comparison */
538         return !strcmp(((struct dentry*)k1)->d_name.name,
539                        ((struct dentry*)k2)->d_name.name);
540 }
541
542 /* Helper to alloc and initialize a generic superblock.  This handles all the
543  * VFS related things, like lists.  Each FS will need to handle its own things
544  * in it's *_get_sb(), usually involving reading off the disc. */
545 struct super_block *get_sb(void)
546 {
547         struct super_block *sb = kmalloc(sizeof(struct super_block), 0);
548         sb->s_dirty = FALSE;
549         spinlock_init(&sb->s_lock);
550         kref_init(&sb->s_kref, fake_release, 1); /* for the ref passed out */
551         TAILQ_INIT(&sb->s_inodes);
552         TAILQ_INIT(&sb->s_dirty_i);
553         TAILQ_INIT(&sb->s_io_wb);
554         TAILQ_INIT(&sb->s_lru_d);
555         TAILQ_INIT(&sb->s_files);
556         sb->s_dcache = create_hashtable(100, __dcache_hash, __dcache_eq);
557         sb->s_icache = create_hashtable(100, __generic_hash, __generic_eq);
558         spinlock_init(&sb->s_lru_lock);
559         spinlock_init(&sb->s_dcache_lock);
560         spinlock_init(&sb->s_icache_lock);
561         sb->s_fs_info = 0; // can override somewhere else
562         return sb;
563 }
564
565 /* Final stages of initializing a super block, including creating and linking
566  * the root dentry, root inode, vmnt, and sb.  The d_op and root_ino are
567  * FS-specific, but otherwise it's FS-independent, tricky, and not worth having
568  * around multiple times.
569  *
570  * Not the world's best interface, so it's subject to change, esp since we're
571  * passing (now 3) FS-specific things. */
572 void init_sb(struct super_block *sb, struct vfsmount *vmnt,
573              struct dentry_operations *d_op, unsigned long root_ino,
574              void *d_fs_info)
575 {
576         /* Build and init the first dentry / inode.  The dentry ref is stored later
577          * by vfsmount's mnt_root.  The parent is dealt with later. */
578         struct dentry *d_root = get_dentry(sb, 0,  "/");        /* probably right */
579
580         if (!d_root)
581                 panic("OOM!  init_sb() can't fail yet!");
582         /* a lot of here on down is normally done in lookup() or create, since
583          * get_dentry isn't a fully usable dentry.  The two FS-specific settings are
584          * normally inherited from a parent within the same FS in get_dentry, but we
585          * have none here. */
586         d_root->d_op = d_op;
587         d_root->d_fs_info = d_fs_info;
588         struct inode *inode = get_inode(d_root);
589         if (!inode)
590                 panic("This FS sucks!");
591         inode->i_ino = root_ino;
592         /* TODO: add the inode to the appropriate list (off i_list) */
593         /* TODO: do we need to read in the inode?  can we do this on demand? */
594         /* if this FS is already mounted, we'll need to do something different. */
595         sb->s_op->read_inode(inode);
596         icache_put(sb, inode);
597         /* Link the dentry and SB to the VFS mount */
598         vmnt->mnt_root = d_root;                                /* ref comes from get_dentry */
599         vmnt->mnt_sb = sb;
600         /* If there is no mount point, there is no parent.  This is true only for
601          * the rootfs. */
602         if (vmnt->mnt_mountpoint) {
603                 kref_get(&vmnt->mnt_mountpoint->d_kref, 1);     /* held by d_root */
604                 d_root->d_parent = vmnt->mnt_mountpoint;        /* dentry of the root */
605         } else {
606                 d_root->d_parent = d_root;                      /* set root as its own parent */
607         }
608         /* insert the dentry into the dentry cache.  when's the earliest we can?
609          * when's the earliest we should?  what about concurrent accesses to the
610          * same dentry?  should be locking the dentry... */
611         dcache_put(sb, d_root);
612         kref_put(&inode->i_kref);               /* give up the ref from get_inode() */
613 }
614
615 /* Dentry Functions */
616
617 /* Helper to alloc and initialize a generic dentry.  The following needs to be
618  * set still: d_op (if no parent), d_fs_info (opt), d_inode, connect the inode
619  * to the dentry (and up the d_kref again), maybe dcache_put().  The inode
620  * stitching is done in get_inode() or lookup (depending on the FS).
621  * The setting of the d_op might be problematic when dealing with mounts.  Just
622  * overwrite it.
623  *
624  * If the name is longer than the inline name, it will kmalloc a buffer, so
625  * don't worry about the storage for *name after calling this. */
626 struct dentry *get_dentry(struct super_block *sb, struct dentry *parent,
627                           char *name)
628 {
629         assert(name);
630         size_t name_len = strnlen(name, MAX_FILENAME_SZ);       /* not including \0! */
631         struct dentry *dentry = kmem_cache_alloc(dentry_kcache, 0);
632         char *l_name = 0;
633
634         if (!dentry) {
635                 set_errno(ENOMEM);
636                 return 0;
637         }
638         //memset(dentry, 0, sizeof(struct dentry));
639         kref_init(&dentry->d_kref, dentry_release, 1);  /* this ref is returned */
640         spinlock_init(&dentry->d_lock);
641         TAILQ_INIT(&dentry->d_subdirs);
642         dentry->d_time = 0;
643         kref_get(&sb->s_kref, 1);
644         dentry->d_sb = sb;                                      /* storing a ref here... */
645         dentry->d_mount_point = FALSE;
646         dentry->d_mounted_fs = 0;
647         if (parent)     {                                               /* no parent for rootfs mount */
648                 kref_get(&parent->d_kref, 1);
649                 dentry->d_op = parent->d_op;    /* d_op set in init_sb for parentless */
650         }
651         dentry->d_parent = parent;
652         dentry->d_flags = DENTRY_USED;
653         dentry->d_fs_info = 0;
654         if (name_len < DNAME_INLINE_LEN) {
655                 strncpy(dentry->d_iname, name, name_len);
656                 dentry->d_iname[name_len] = '\0';
657                 qstr_builder(dentry, 0);
658         } else {
659                 l_name = kmalloc(name_len + 1, 0);
660                 assert(l_name);
661                 strncpy(l_name, name, name_len);
662                 l_name[name_len] = '\0';
663                 qstr_builder(dentry, l_name);
664         }
665         /* Catch bugs by aggressively zeroing this (o/w we use old stuff) */
666         dentry->d_inode = 0;
667         return dentry;
668 }
669
670 /* Called when the dentry is unreferenced (after kref == 0).  This works closely
671  * with the resurrection in dcache_get().
672  *
673  * The dentry is still in the dcache, but needs to be un-USED and added to the
674  * LRU dentry list.  Even dentries that were used in a failed lookup need to be
675  * cached - they ought to be the negative dentries.  Note that all dentries have
676  * parents, even negative ones (it is needed to find it in the dcache). */
677 void dentry_release(struct kref *kref)
678 {
679         struct dentry *dentry = container_of(kref, struct dentry, d_kref);
680
681         printd("'Releasing' dentry %p: %s\n", dentry, dentry->d_name.name);
682         /* DYING dentries (recently unlinked / rmdir'd) just get freed */
683         if (dentry->d_flags & DENTRY_DYING) {
684                 __dentry_free(dentry);
685                 return;
686         }
687         /* This lock ensures the USED state and the TAILQ membership is in sync.
688          * Also used to check the refcnt, though that might not be necessary. */
689         spin_lock(&dentry->d_lock);
690         /* While locked, we need to double check the kref, in case someone already
691          * reup'd it.  Re-up? you're crazy!  Reee-up, you're outta yo mind! */
692         if (!kref_refcnt(&dentry->d_kref)) {
693                 /* Note this is where negative dentries get set UNUSED */
694                 if (dentry->d_flags & DENTRY_USED) {
695                         dentry->d_flags &= ~DENTRY_USED;
696                         spin_lock(&dentry->d_sb->s_lru_lock);
697                         TAILQ_INSERT_TAIL(&dentry->d_sb->s_lru_d, dentry, d_lru);
698                         spin_unlock(&dentry->d_sb->s_lru_lock);
699                 } else {
700                         /* and make sure it wasn't USED, then UNUSED again */
701                         /* TODO: think about issues with this */
702                         warn("This should be rare.  Tell brho this happened.");
703                 }
704         }
705         spin_unlock(&dentry->d_lock);
706 }
707
708 /* Called when we really dealloc and get rid of a dentry (like when it is
709  * removed from the dcache, either for memory or correctness reasons)
710  *
711  * This has to handle two types of dentries: full ones (ones that had been used)
712  * and ones that had been just for lookups - hence the check for d_inode.
713  *
714  * Note that dentries pin and kref their inodes.  When all the dentries are
715  * gone, we want the inode to be released via kref.  The inode has internal /
716  * weak references to the dentry, which are not refcounted. */
717 void __dentry_free(struct dentry *dentry)
718 {
719         if (dentry->d_inode)
720                 printd("Freeing dentry %p: %s\n", dentry, dentry->d_name.name);
721         assert(dentry->d_op);   /* catch bugs.  a while back, some lacked d_op */
722         dentry->d_op->d_release(dentry);
723         /* TODO: check/test the boundaries on this. */
724         if (dentry->d_name.len > DNAME_INLINE_LEN)
725                 kfree((void*)dentry->d_name.name);
726         kref_put(&dentry->d_sb->s_kref);
727         if (dentry->d_parent)
728                 kref_put(&dentry->d_parent->d_kref);
729         if (dentry->d_mounted_fs)
730                 kref_put(&dentry->d_mounted_fs->mnt_kref);
731         if (dentry->d_inode) {
732                 TAILQ_REMOVE(&dentry->d_inode->i_dentry, dentry, d_alias);
733                 kref_put(&dentry->d_inode->i_kref);     /* dentries kref inodes */
734         }
735         kmem_cache_free(dentry_kcache, dentry);
736 }
737
738 /* Looks up the dentry for the given path, returning a refcnt'd dentry (or 0).
739  * Permissions are applied for the current user, which is quite a broken system
740  * at the moment.  Flags are lookup flags. */
741 struct dentry *lookup_dentry(char *path, int flags)
742 {
743         struct dentry *dentry;
744         struct nameidata nd_r = {0}, *nd = &nd_r;
745         int error;
746
747         error = path_lookup(path, flags, nd);
748         if (error) {
749                 path_release(nd);
750                 set_errno(-error);
751                 return 0;
752         }
753         dentry = nd->dentry;
754         kref_get(&dentry->d_kref, 1);
755         path_release(nd);
756         return dentry;
757 }
758
759 /* Get a dentry from the dcache.  At a minimum, we need the name hash and parent
760  * in what_i_want, though most uses will probably be from a get_dentry() call.
761  * We pass in the SB in the off chance that we don't want to use a get'd dentry.
762  *
763  * The unusual variable name (instead of just "key" or something) is named after
764  * ex-SPC Castro's porn folder.  Caller deals with the memory for what_i_want.
765  *
766  * If the dentry is negative, we don't return the actual result - instead, we
767  * set the negative flag in 'what i want'.  The reason is we don't want to
768  * kref_get() and then immediately put (causing dentry_release()).  This also
769  * means that dentry_release() should never get someone who wasn't USED (barring
770  * the race, which it handles).  And we don't need to ever have a dentry set as
771  * USED and NEGATIVE (which is always wrong, but would be needed for a cleaner
772  * dentry_release()).
773  *
774  * This is where we do the "kref resurrection" - we are returning a kref'd
775  * object, even if it wasn't kref'd before.  This means the dcache does NOT hold
776  * krefs (it is a weak/internal ref), but it is a source of kref generation.  We
777  * sync up with the possible freeing of the dentry by locking the table.  See
778  * Doc/kref for more info. */
779 struct dentry *dcache_get(struct super_block *sb, struct dentry *what_i_want)
780 {
781         struct dentry *found;
782         /* This lock protects the hash, as well as ensures the returned object
783          * doesn't get deleted/freed out from under us */
784         spin_lock(&sb->s_dcache_lock);
785         found = hashtable_search(sb->s_dcache, what_i_want);
786         if (found) {
787                 if (found->d_flags & DENTRY_NEGATIVE) {
788                         what_i_want->d_flags |= DENTRY_NEGATIVE;
789                         spin_unlock(&sb->s_dcache_lock);
790                         return 0;
791                 }
792                 spin_lock(&found->d_lock);
793                 __kref_get(&found->d_kref, 1);  /* prob could be done outside the lock*/
794                 /* If we're here (after kreffing) and it is not USED, we are the one who
795                  * should resurrect */
796                 if (!(found->d_flags & DENTRY_USED)) {
797                         found->d_flags |= DENTRY_USED;
798                         spin_lock(&sb->s_lru_lock);
799                         TAILQ_REMOVE(&sb->s_lru_d, found, d_lru);
800                         spin_unlock(&sb->s_lru_lock);
801                 }
802                 spin_unlock(&found->d_lock);
803         }
804         spin_unlock(&sb->s_dcache_lock);
805         return found;
806 }
807
808 /* Adds a dentry to the dcache.  Note the *dentry is both the key and the value.
809  * If the value was already in there (which can happen iff it was negative), for
810  * now we'll remove it and put the new one in there. */
811 void dcache_put(struct super_block *sb, struct dentry *key_val)
812 {
813         struct dentry *old;
814         int retval;
815         spin_lock(&sb->s_dcache_lock);
816         old = hashtable_remove(sb->s_dcache, key_val);
817         /* if it is old and non-negative, our caller lost a race with someone else
818          * adding the dentry.  but since we yanked it out, like a bunch of idiots,
819          * we still have to put it back.  should be fairly rare. */
820         if (old && (old->d_flags & DENTRY_NEGATIVE)) {
821                 /* This is possible, but rare for now (about to be put on the LRU) */
822                 assert(!(old->d_flags & DENTRY_USED));
823                 assert(!kref_refcnt(&old->d_kref));
824                 spin_lock(&sb->s_lru_lock);
825                 TAILQ_REMOVE(&sb->s_lru_d, old, d_lru);
826                 spin_unlock(&sb->s_lru_lock);
827                 __dentry_free(old);
828         }
829         /* this returns 0 on failure (TODO: Fix this ghetto shit) */
830         retval = hashtable_insert(sb->s_dcache, key_val, key_val);
831         assert(retval);
832         spin_unlock(&sb->s_dcache_lock);
833 }
834
835 /* Will remove and return the dentry.  Caller deallocs the key, but the retval
836  * won't have a reference.  * Returns 0 if it wasn't found.  Callers can't
837  * assume much - they should not use the reference they *get back*, (if they
838  * already had one for key, they can use that).  There may be other users out
839  * there. */
840 struct dentry *dcache_remove(struct super_block *sb, struct dentry *key)
841 {
842         struct dentry *retval;
843         spin_lock(&sb->s_dcache_lock);
844         retval = hashtable_remove(sb->s_dcache, key);
845         spin_unlock(&sb->s_dcache_lock);
846         return retval;
847 }
848
849 /* This will clean out the LRU list, which are the unused dentries of the dentry
850  * cache.  This will optionally only free the negative ones.  Note that we grab
851  * the hash lock for the time we traverse the LRU list - this prevents someone
852  * from getting a kref from the dcache, which could cause us trouble (we rip
853  * someone off the list, who isn't unused, and they try to rip them off the
854  * list). */
855 void dcache_prune(struct super_block *sb, bool negative_only)
856 {
857         struct dentry *d_i, *temp;
858         struct dentry_tailq victims = TAILQ_HEAD_INITIALIZER(victims);
859
860         spin_lock(&sb->s_dcache_lock);
861         spin_lock(&sb->s_lru_lock);
862         TAILQ_FOREACH_SAFE(d_i, &sb->s_lru_d, d_lru, temp) {
863                 if (!(d_i->d_flags & DENTRY_USED)) {
864                         if (negative_only && !(d_i->d_flags & DENTRY_NEGATIVE))
865                                 continue;
866                         /* another place where we'd be better off with tools, not sol'ns */
867                         hashtable_remove(sb->s_dcache, d_i);
868                         TAILQ_REMOVE(&sb->s_lru_d, d_i, d_lru);
869                         TAILQ_INSERT_HEAD(&victims, d_i, d_lru);
870                 }
871         }
872         spin_unlock(&sb->s_lru_lock);
873         spin_unlock(&sb->s_dcache_lock);
874         /* Now do the actual freeing, outside of the hash/LRU list locks.  This is
875          * necessary since __dentry_free() will decref its parent, which may get
876          * released and try to add itself to the LRU. */
877         TAILQ_FOREACH_SAFE(d_i, &victims, d_lru, temp) {
878                 TAILQ_REMOVE(&victims, d_i, d_lru);
879                 assert(!kref_refcnt(&d_i->d_kref));
880                 __dentry_free(d_i);
881         }
882         /* It is possible at this point that there are new items on the LRU.  We
883          * could loop back until that list is empty, if we care about this. */
884 }
885
886 /* Inode Functions */
887
888 /* Creates and initializes a new inode.  Generic fields are filled in.
889  * FS-specific fields are filled in by the callout.  Specific fields are filled
890  * in in read_inode() based on what's on the disk for a given i_no, or when the
891  * inode is created (for new objects).
892  *
893  * i_no is set by the caller.  Note that this means this inode can be for an
894  * inode that is already on disk, or it can be used when creating. */
895 struct inode *get_inode(struct dentry *dentry)
896 {
897         struct super_block *sb = dentry->d_sb;
898         /* FS allocs and sets the following: i_op, i_fop, i_pm.pm_op, and any FS
899          * specific stuff. */
900         struct inode *inode = sb->s_op->alloc_inode(sb);
901         if (!inode) {
902                 set_errno(ENOMEM);
903                 return 0;
904         }
905         TAILQ_INSERT_HEAD(&sb->s_inodes, inode, i_sb_list);             /* weak inode ref */
906         TAILQ_INIT(&inode->i_dentry);
907         TAILQ_INSERT_TAIL(&inode->i_dentry, dentry, d_alias);   /* weak dentry ref*/
908         /* one for the dentry->d_inode, one passed out */
909         kref_init(&inode->i_kref, inode_release, 2);
910         dentry->d_inode = inode;
911         inode->i_ino = 0;                                       /* set by caller later */
912         inode->i_blksize = sb->s_blocksize;
913         spinlock_init(&inode->i_lock);
914         kref_get(&sb->s_kref, 1);                       /* could allow the dentry to pin it */
915         inode->i_sb = sb;
916         inode->i_rdev = 0;                                      /* this has no real meaning yet */
917         inode->i_bdev = sb->s_bdev;                     /* storing an uncounted ref */
918         inode->i_state = 0;                                     /* need real states, like I_NEW */
919         inode->dirtied_when = 0;
920         inode->i_flags = 0;
921         atomic_set(&inode->i_writecount, 0);
922         /* Set up the page_map structures.  Default is to use the embedded one.
923          * Might push some of this back into specific FSs.  For now, the FS tells us
924          * what pm_op they want via i_pm.pm_op, which we set again in pm_init() */
925         inode->i_mapping = &inode->i_pm;
926         pm_init(inode->i_mapping, inode->i_pm.pm_op, inode);
927         return inode;
928 }
929
930 /* Helper: loads/ reads in the inode numbered ino and attaches it to dentry */
931 void load_inode(struct dentry *dentry, unsigned long ino)
932 {
933         struct inode *inode;
934
935         /* look it up in the inode cache first */
936         inode = icache_get(dentry->d_sb, ino);
937         if (inode) {
938                 /* connect the dentry to its inode */
939                 TAILQ_INSERT_TAIL(&inode->i_dentry, dentry, d_alias);
940                 dentry->d_inode = inode;        /* storing the ref we got from icache_get */
941                 return;
942         }
943         /* otherwise, we need to do it manually */
944         inode = get_inode(dentry);
945         inode->i_ino = ino;
946         dentry->d_sb->s_op->read_inode(inode);
947         /* TODO: race here, two creators could miss in the cache, and then get here.
948          * need a way to sync across a blocking call.  needs to be either at this
949          * point in the code or per the ino (dentries could be different) */
950         icache_put(dentry->d_sb, inode);
951         kref_put(&inode->i_kref);
952 }
953
954 /* Helper op, used when creating regular files, directories, symlinks, etc.
955  * Note we make a distinction between the mode and the file type (for now).
956  * After calling this, call the FS specific version (create or mkdir), which
957  * will set the i_ino, the filetype, and do any other FS-specific stuff.  Also
958  * note that a lot of inode stuff was initialized in get_inode/alloc_inode.  The
959  * stuff here is pertinent to the specific creator (user), mode, and time.  Also
960  * note we don't pass this an nd, like Linux does... */
961 static struct inode *create_inode(struct dentry *dentry, int mode)
962 {
963         uint64_t now = epoch_seconds();
964         /* note it is the i_ino that uniquely identifies a file in the specific
965          * filesystem.  there's a diff between creating an inode (even for an in-use
966          * ino) and then filling it in, and vs creating a brand new one.
967          * get_inode() sets it to 0, and it should be filled in later in an
968          * FS-specific manner. */
969         struct inode *inode = get_inode(dentry);
970         if (!inode)
971                 return 0;
972         inode->i_mode = mode & S_PMASK; /* note that after this, we have no type */
973         inode->i_nlink = 1;
974         inode->i_size = 0;
975         inode->i_blocks = 0;
976         inode->i_atime.tv_sec = now;
977         inode->i_ctime.tv_sec = now;
978         inode->i_mtime.tv_sec = now;
979         inode->i_atime.tv_nsec = 0;
980         inode->i_ctime.tv_nsec = 0;
981         inode->i_mtime.tv_nsec = 0;
982         inode->i_bdev = inode->i_sb->s_bdev;
983         /* when we have notions of users, do something here: */
984         inode->i_uid = 0;
985         inode->i_gid = 0;
986         return inode;
987 }
988
989 /* Create a new disk inode in dir associated with dentry, with the given mode.
990  * called when creating a regular file.  dir is the directory/parent.  dentry is
991  * the dentry of the inode we are creating.  Note the lack of the nd... */
992 int create_file(struct inode *dir, struct dentry *dentry, int mode)
993 {
994         struct inode *new_file = create_inode(dentry, mode);
995         if (!new_file)
996                 return -1;
997         dir->i_op->create(dir, dentry, mode, 0);
998         icache_put(new_file->i_sb, new_file);
999         kref_put(&new_file->i_kref);
1000         return 0;
1001 }
1002
1003 /* Creates a new inode for a directory associated with dentry in dir with the
1004  * given mode. */
1005 int create_dir(struct inode *dir, struct dentry *dentry, int mode)
1006 {
1007         struct inode *new_dir = create_inode(dentry, mode);
1008         if (!new_dir)
1009                 return -1;
1010         dir->i_op->mkdir(dir, dentry, mode);
1011         dir->i_nlink++;         /* Directories get a hardlink for every child dir */
1012         /* Make sure my parent tracks me.  This is okay, since no directory (dir)
1013          * can have more than one dentry */
1014         struct dentry *parent = TAILQ_FIRST(&dir->i_dentry);
1015         assert(parent && parent == TAILQ_LAST(&dir->i_dentry, dentry_tailq));
1016         /* parent dentry tracks dentry as a subdir, weak reference */
1017         TAILQ_INSERT_TAIL(&parent->d_subdirs, dentry, d_subdirs_link);
1018         icache_put(new_dir->i_sb, new_dir);
1019         kref_put(&new_dir->i_kref);
1020         return 0;
1021 }
1022
1023 /* Creates a new inode for a symlink associated with dentry in dir, containing
1024  * the symlink symname */
1025 int create_symlink(struct inode *dir, struct dentry *dentry,
1026                    const char *symname, int mode)
1027 {
1028         struct inode *new_sym = create_inode(dentry, mode);
1029         if (!new_sym)
1030                 return -1;
1031         dir->i_op->symlink(dir, dentry, symname);
1032         icache_put(new_sym->i_sb, new_sym);
1033         kref_put(&new_sym->i_kref);
1034         return 0;
1035 }
1036
1037 /* Returns 0 if the given mode is acceptable for the inode, and an appropriate
1038  * error code if not.  Needs to be writen, based on some sensible rules, and
1039  * will also probably use 'current' */
1040 int check_perms(struct inode *inode, int access_mode)
1041 {
1042         return 0;       /* anything goes! */
1043 }
1044
1045 /* Called after all external refs are gone to clean up the inode.  Once this is
1046  * called, all dentries pointing here are already done (one of them triggered
1047  * this via kref_put(). */
1048 void inode_release(struct kref *kref)
1049 {
1050         struct inode *inode = container_of(kref, struct inode, i_kref);
1051         TAILQ_REMOVE(&inode->i_sb->s_inodes, inode, i_sb_list);
1052         icache_remove(inode->i_sb, inode->i_ino);
1053         /* Might need to write back or delete the file/inode */
1054         if (inode->i_nlink) {
1055                 if (inode->i_state & I_STATE_DIRTY)
1056                         inode->i_sb->s_op->write_inode(inode, TRUE);
1057         } else {
1058                 inode->i_sb->s_op->delete_inode(inode);
1059         }
1060         if (S_ISFIFO(inode->i_mode)) {
1061                 page_decref(kva2page(inode->i_pipe->p_buf));
1062                 kfree(inode->i_pipe);
1063         }
1064         /* TODO: (BDEV) */
1065         // kref_put(inode->i_bdev->kref); /* assuming it's a bdev, could be a pipe*/
1066         /* Either way, we dealloc the in-memory version */
1067         inode->i_sb->s_op->dealloc_inode(inode);        /* FS-specific clean-up */
1068         kref_put(&inode->i_sb->s_kref);
1069         /* TODO: clean this up */
1070         assert(inode->i_mapping == &inode->i_pm);
1071         kmem_cache_free(inode_kcache, inode);
1072 }
1073
1074 /* Fills in kstat with the stat information for the inode */
1075 void stat_inode(struct inode *inode, struct kstat *kstat)
1076 {
1077         kstat->st_dev = inode->i_sb->s_dev;
1078         kstat->st_ino = inode->i_ino;
1079         kstat->st_mode = inode->i_mode;
1080         kstat->st_nlink = inode->i_nlink;
1081         kstat->st_uid = inode->i_uid;
1082         kstat->st_gid = inode->i_gid;
1083         kstat->st_rdev = inode->i_rdev;
1084         kstat->st_size = inode->i_size;
1085         kstat->st_blksize = inode->i_blksize;
1086         kstat->st_blocks = inode->i_blocks;
1087         kstat->st_atime = inode->i_atime;
1088         kstat->st_mtime = inode->i_mtime;
1089         kstat->st_ctime = inode->i_ctime;
1090 }
1091
1092 void print_kstat(struct kstat *kstat)
1093 {
1094         printk("kstat info for %p:\n", kstat);
1095         printk("\tst_dev    : %p\n", kstat->st_dev);
1096         printk("\tst_ino    : %p\n", kstat->st_ino);
1097         printk("\tst_mode   : %p\n", kstat->st_mode);
1098         printk("\tst_nlink  : %p\n", kstat->st_nlink);
1099         printk("\tst_uid    : %p\n", kstat->st_uid);
1100         printk("\tst_gid    : %p\n", kstat->st_gid);
1101         printk("\tst_rdev   : %p\n", kstat->st_rdev);
1102         printk("\tst_size   : %p\n", kstat->st_size);
1103         printk("\tst_blksize: %p\n", kstat->st_blksize);
1104         printk("\tst_blocks : %p\n", kstat->st_blocks);
1105         printk("\tst_atime  : %p\n", kstat->st_atime);
1106         printk("\tst_mtime  : %p\n", kstat->st_mtime);
1107         printk("\tst_ctime  : %p\n", kstat->st_ctime);
1108 }
1109
1110 /* Inode Cache management.  In general, search on the ino, get a refcnt'd value
1111  * back.  Remove does not give you a reference back - it should only be called
1112  * in inode_release(). */
1113 struct inode *icache_get(struct super_block *sb, unsigned long ino)
1114 {
1115         /* This is the same style as in pid2proc, it's the "safely create a strong
1116          * reference from a weak one, so long as other strong ones exist" pattern */
1117         spin_lock(&sb->s_icache_lock);
1118         struct inode *inode = hashtable_search(sb->s_icache, (void*)ino);
1119         if (inode)
1120                 if (!kref_get_not_zero(&inode->i_kref, 1))
1121                         inode = 0;
1122         spin_unlock(&sb->s_icache_lock);
1123         return inode;
1124 }
1125
1126 void icache_put(struct super_block *sb, struct inode *inode)
1127 {
1128         spin_lock(&sb->s_icache_lock);
1129         /* there's a race in load_ino() that could trigger this */
1130         assert(!hashtable_search(sb->s_icache, (void*)inode->i_ino));
1131         hashtable_insert(sb->s_icache, (void*)inode->i_ino, inode);
1132         spin_unlock(&sb->s_icache_lock);
1133 }
1134
1135 struct inode *icache_remove(struct super_block *sb, unsigned long ino)
1136 {
1137         struct inode *inode;
1138         /* Presumably these hashtable removals could be easier since callers
1139          * actually know who they are (same with the pid2proc hash) */
1140         spin_lock(&sb->s_icache_lock);
1141         inode = hashtable_remove(sb->s_icache, (void*)ino);
1142         spin_unlock(&sb->s_icache_lock);
1143         assert(inode && !kref_refcnt(&inode->i_kref));
1144         return inode;
1145 }
1146
1147 /* File functions */
1148
1149 /* Read count bytes from the file into buf, starting at *offset, which is
1150  * increased accordingly, returning the number of bytes transfered.  Most
1151  * filesystems will use this function for their f_op->read.
1152  * Note, this uses the page cache. */
1153 ssize_t generic_file_read(struct file *file, char *buf, size_t count,
1154                           off64_t *offset)
1155 {
1156         struct page *page;
1157         int error;
1158         off64_t page_off;
1159         unsigned long first_idx, last_idx;
1160         size_t copy_amt;
1161         char *buf_end;
1162         /* read in offset, in case of a concurrent reader/writer, so we don't screw
1163          * up our math for count, the idxs, etc. */
1164         off64_t orig_off = ACCESS_ONCE(*offset);
1165
1166         /* Consider pushing some error checking higher in the VFS */
1167         if (!count)
1168                 return 0;
1169         if (orig_off >= file->f_dentry->d_inode->i_size)
1170                 return 0; /* EOF */
1171         /* Make sure we don't go past the end of the file */
1172         if (orig_off + count > file->f_dentry->d_inode->i_size) {
1173                 count = file->f_dentry->d_inode->i_size - orig_off;
1174         }
1175         assert((long)count > 0);
1176         page_off = orig_off & (PGSIZE - 1);
1177         first_idx = orig_off >> PGSHIFT;
1178         last_idx = (orig_off + count) >> PGSHIFT;
1179         buf_end = buf + count;
1180         /* For each file page, make sure it's in the page cache, then copy it out.
1181          * TODO: will probably need to consider concurrently truncated files here.*/
1182         for (int i = first_idx; i <= last_idx; i++) {
1183                 error = pm_load_page(file->f_mapping, i, &page);
1184                 assert(!error); /* TODO: handle ENOMEM and friends */
1185                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
1186                 /* TODO: (UMEM) think about this.  if it's a user buffer, we're relying
1187                  * on current to detect whose it is (which should work for async calls).
1188                  * Also, need to propagate errors properly...  Probably should do a
1189                  * user_mem_check, then free, and also to make a distinction between
1190                  * when the kernel wants a read/write (TODO: KFOP) */
1191                 if (current) {
1192                         memcpy_to_user(current, buf, page2kva(page) + page_off, copy_amt);
1193                 } else {
1194                         memcpy(buf, page2kva(page) + page_off, copy_amt);
1195                 }
1196                 buf += copy_amt;
1197                 page_off = 0;
1198                 pm_put_page(page);      /* it's still in the cache, we just don't need it */
1199         }
1200         assert(buf == buf_end);
1201         /* could have concurrent file ops that screw with offset, so userspace isn't
1202          * safe.  but at least it'll be a value that one of the concurrent ops could
1203          * have produced (compared to *offset_changed_concurrently += count. */
1204         *offset = orig_off + count;
1205         return count;
1206 }
1207
1208 /* Write count bytes from buf to the file, starting at *offset, which is
1209  * increased accordingly, returning the number of bytes transfered.  Most
1210  * filesystems will use this function for their f_op->write.  Note, this uses
1211  * the page cache.
1212  *
1213  * Changes don't get flushed to disc til there is an fsync, page cache eviction,
1214  * or other means of trying to writeback the pages. */
1215 ssize_t generic_file_write(struct file *file, const char *buf, size_t count,
1216                            off64_t *offset)
1217 {
1218         struct page *page;
1219         int error;
1220         off64_t page_off;
1221         unsigned long first_idx, last_idx;
1222         size_t copy_amt;
1223         const char *buf_end;
1224         off64_t orig_off = ACCESS_ONCE(*offset);
1225
1226         /* Consider pushing some error checking higher in the VFS */
1227         if (!count)
1228                 return 0;
1229         /* Extend the file.  Should put more checks in here, and maybe do this per
1230          * page in the for loop below. */
1231         if (orig_off + count > file->f_dentry->d_inode->i_size)
1232                 file->f_dentry->d_inode->i_size = orig_off + count;
1233         page_off = orig_off & (PGSIZE - 1);
1234         first_idx = orig_off >> PGSHIFT;
1235         last_idx = (orig_off + count) >> PGSHIFT;
1236         buf_end = buf + count;
1237         /* For each file page, make sure it's in the page cache, then write it.*/
1238         for (int i = first_idx; i <= last_idx; i++) {
1239                 error = pm_load_page(file->f_mapping, i, &page);
1240                 assert(!error); /* TODO: handle ENOMEM and friends */
1241                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
1242                 /* TODO: (UMEM) (KFOP) think about this.  if it's a user buffer, we're
1243                  * relying on current to detect whose it is (which should work for async
1244                  * calls). */
1245                 if (current) {
1246                         memcpy_from_user(current, page2kva(page) + page_off, buf, copy_amt);
1247                 } else {
1248                         memcpy(page2kva(page) + page_off, buf, copy_amt);
1249                 }
1250                 buf += copy_amt;
1251                 page_off = 0;
1252                 atomic_or(&page->pg_flags, PG_DIRTY);
1253                 pm_put_page(page);      /* it's still in the cache, we just don't need it */
1254         }
1255         assert(buf == buf_end);
1256         *offset = orig_off + count;
1257         return count;
1258 }
1259
1260 /* Directories usually use this for their read method, which is the way glibc
1261  * currently expects us to do a readdir (short of doing linux's getdents).  Will
1262  * probably need work, based on whatever real programs want. */
1263 ssize_t generic_dir_read(struct file *file, char *u_buf, size_t count,
1264                          off64_t *offset)
1265 {
1266         struct kdirent dir_r = {0}, *dirent = &dir_r;
1267         int retval = 1;
1268         size_t amt_copied = 0;
1269         char *buf_end = u_buf + count;
1270
1271         if (!S_ISDIR(file->f_dentry->d_inode->i_mode)) {
1272                 set_errno(ENOTDIR);
1273                 return -1;
1274         }
1275         if (!count)
1276                 return 0;
1277         /* start readdir from where it left off: */
1278         dirent->d_off = *offset;
1279         for (   ;
1280                 u_buf + sizeof(struct kdirent) <= buf_end;
1281                 u_buf += sizeof(struct kdirent)) {
1282                 /* TODO: UMEM/KFOP (pin the u_buf in the syscall, ditch the local copy,
1283                  * get rid of this memcpy and reliance on current, etc).  Might be
1284                  * tricky with the dirent->d_off and trust issues */
1285                 retval = file->f_op->readdir(file, dirent);
1286                 if (retval < 0) {
1287                         set_errno(-retval);
1288                         break;
1289                 }
1290                 /* Slight info exposure: could be extra crap after the name in the
1291                  * dirent (like the name of a deleted file) */
1292                 if (current) {
1293                         memcpy_to_user(current, u_buf, dirent, sizeof(struct dirent));
1294                 } else {
1295                         memcpy(u_buf, dirent, sizeof(struct dirent));
1296                 }
1297                 amt_copied += sizeof(struct dirent);
1298                 /* 0 signals end of directory */
1299                 if (retval == 0)
1300                         break;
1301         }
1302         /* Next time read is called, we pick up where we left off */
1303         *offset = dirent->d_off;        /* UMEM */
1304         /* important to tell them how much they got.  they often keep going til they
1305          * get 0 back (in the case of ls).  it's also how much has been read, but it
1306          * isn't how much the f_pos has moved (which is opaque to the VFS). */
1307         return amt_copied;
1308 }
1309
1310 /* Opens the file, using permissions from current for lack of a better option.
1311  * It will attempt to create the file if it does not exist and O_CREAT is
1312  * specified.  This will return 0 on failure, and set errno.  TODO: There's some
1313  * stuff that we don't do, esp related file truncating/creation.  flags are for
1314  * opening, the mode is for creating.  The flags related to how to create
1315  * (O_CREAT_FLAGS) are handled in this function, not in create_file().
1316  *
1317  * It's tempting to split this into a do_file_create and a do_file_open, based
1318  * on the O_CREAT flag, but the O_CREAT flag can be ignored if the file exists
1319  * already and O_EXCL isn't specified.  We could have open call create if it
1320  * fails, but for now we'll keep it as is. */
1321 struct file *do_file_open(char *path, int flags, int mode)
1322 {
1323         struct file *file = 0;
1324         struct dentry *file_d;
1325         struct inode *parent_i;
1326         struct nameidata nd_r = {0}, *nd = &nd_r;
1327         int error;
1328
1329         /* The file might exist, lets try to just open it right away */
1330         nd->intent = LOOKUP_OPEN;
1331         error = path_lookup(path, LOOKUP_FOLLOW, nd);
1332         if (!error) {
1333                 /* Still need to make sure we didn't want to O_EXCL create */
1334                 if ((flags & O_CREAT) && (flags & O_EXCL)) {
1335                         set_errno(EEXIST);
1336                         goto out_path_only;
1337                 }
1338                 file_d = nd->dentry;
1339                 kref_get(&file_d->d_kref, 1);
1340                 goto open_the_file;
1341         }
1342         /* So it didn't already exist, release the path from the previous lookup,
1343          * and then we try to create it. */
1344         path_release(nd);       
1345         /* get the parent, following links.  this means you get the parent of the
1346          * final link (which may not be in 'path' in the first place. */
1347         nd->intent = LOOKUP_CREATE;
1348         error = path_lookup(path, LOOKUP_PARENT | LOOKUP_FOLLOW, nd);
1349         if (error) {
1350                 set_errno(-error);
1351                 goto out_path_only;
1352         }
1353         /* see if the target is there (shouldn't be), and handle accordingly */
1354         file_d = do_lookup(nd->dentry, nd->last.name); 
1355         if (!file_d) {
1356                 if (!(flags & O_CREAT)) {
1357                         set_errno(ENOENT);
1358                         goto out_path_only;
1359                 }
1360                 /* Create the inode/file.  get a fresh dentry too: */
1361                 file_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
1362                 if (!file_d)
1363                         goto out_path_only;
1364                 parent_i = nd->dentry->d_inode;
1365                 /* Note that the mode technically should only apply to future opens,
1366                  * but we apply it immediately. */
1367                 if (create_file(parent_i, file_d, mode))        /* sets errno */
1368                         goto out_file_d;
1369                 dcache_put(file_d->d_sb, file_d);
1370         } else {        /* something already exists */
1371                 /* this can happen due to concurrent access, but needs to be thought
1372                  * through */
1373                 panic("File shouldn't be here!");
1374                 if ((flags & O_CREAT) && (flags & O_EXCL)) {
1375                         /* wanted to create, not open, bail out */
1376                         set_errno(EEXIST);
1377                         goto out_file_d;
1378                 }
1379         }
1380 open_the_file:
1381         /* now open the file (freshly created or if it already existed).  At this
1382          * point, file_d is a refcnt'd dentry, regardless of which branch we took.*/
1383         if (flags & O_TRUNC) {
1384                 file_d->d_inode->i_size = 0;
1385                 /* TODO: probably should remove the garbage pages from the page map */
1386         }
1387         file = dentry_open(file_d, flags);                              /* sets errno */
1388         /* Note the fall through to the exit paths.  File is 0 by default and if
1389          * dentry_open fails. */
1390 out_file_d:
1391         kref_put(&file_d->d_kref);
1392 out_path_only:
1393         path_release(nd);
1394         return file;
1395 }
1396
1397 /* Path is the location of the symlink, sometimes called the "new path", and
1398  * symname is who we link to, sometimes called the "old path". */
1399 int do_symlink(char *path, const char *symname, int mode)
1400 {
1401         struct dentry *sym_d;
1402         struct inode *parent_i;
1403         struct nameidata nd_r = {0}, *nd = &nd_r;
1404         int error;
1405         int retval = -1;
1406
1407         nd->intent = LOOKUP_CREATE;
1408         /* get the parent, but don't follow links */
1409         error = path_lookup(path, LOOKUP_PARENT, nd);
1410         if (error) {
1411                 set_errno(-error);
1412                 goto out_path_only;
1413         }
1414         /* see if the target is already there, handle accordingly */
1415         sym_d = do_lookup(nd->dentry, nd->last.name); 
1416         if (sym_d) {
1417                 set_errno(EEXIST);
1418                 goto out_sym_d;
1419         }
1420         /* Doesn't already exist, let's try to make it: */
1421         sym_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
1422         if (!sym_d)
1423                 goto out_path_only;
1424         parent_i = nd->dentry->d_inode;
1425         if (create_symlink(parent_i, sym_d, symname, mode))
1426                 goto out_sym_d;
1427         dcache_put(sym_d->d_sb, sym_d);
1428         retval = 0;                             /* Note the fall through to the exit paths */
1429 out_sym_d:
1430         kref_put(&sym_d->d_kref);
1431 out_path_only:
1432         path_release(nd);
1433         return retval;
1434 }
1435
1436 /* Makes a hard link for the file behind old_path to new_path */
1437 int do_link(char *old_path, char *new_path)
1438 {
1439         struct dentry *link_d, *old_d;
1440         struct inode *inode, *parent_dir;
1441         struct nameidata nd_r = {0}, *nd = &nd_r;
1442         int error;
1443         int retval = -1;
1444
1445         nd->intent = LOOKUP_CREATE;
1446         /* get the absolute parent of the new_path */
1447         error = path_lookup(new_path, LOOKUP_PARENT | LOOKUP_FOLLOW, nd);
1448         if (error) {
1449                 set_errno(-error);
1450                 goto out_path_only;
1451         }
1452         parent_dir = nd->dentry->d_inode;
1453         /* see if the new target is already there, handle accordingly */
1454         link_d = do_lookup(nd->dentry, nd->last.name); 
1455         if (link_d) {
1456                 set_errno(EEXIST);
1457                 goto out_link_d;
1458         }
1459         /* Doesn't already exist, let's try to make it.  Still need to stitch it to
1460          * an inode and set its FS-specific stuff after this.*/
1461         link_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
1462         if (!link_d)
1463                 goto out_path_only;
1464         /* Now let's get the old_path target */
1465         old_d = lookup_dentry(old_path, LOOKUP_FOLLOW);
1466         if (!old_d)                                     /* errno set by lookup_dentry */
1467                 goto out_link_d;
1468         /* For now, can only link to files */
1469         if (!S_ISREG(old_d->d_inode->i_mode)) {
1470                 set_errno(EPERM);
1471                 goto out_both_ds;
1472         }
1473         /* Must be on the same FS */
1474         if (old_d->d_sb != link_d->d_sb) {
1475                 set_errno(EXDEV);
1476                 goto out_both_ds;
1477         }
1478         /* Do whatever FS specific stuff there is first (which is also a chance to
1479          * bail out). */
1480         error = parent_dir->i_op->link(old_d, parent_dir, link_d);
1481         if (error) {
1482                 set_errno(-error);
1483                 goto out_both_ds;
1484         }
1485         /* Finally stitch it up */
1486         inode = old_d->d_inode;
1487         kref_get(&inode->i_kref, 1);
1488         link_d->d_inode = inode;
1489         inode->i_nlink++;
1490         TAILQ_INSERT_TAIL(&inode->i_dentry, link_d, d_alias);   /* weak ref */
1491         dcache_put(link_d->d_sb, link_d);
1492         retval = 0;                             /* Note the fall through to the exit paths */
1493 out_both_ds:
1494         kref_put(&old_d->d_kref);
1495 out_link_d:
1496         kref_put(&link_d->d_kref);
1497 out_path_only:
1498         path_release(nd);
1499         return retval;
1500 }
1501
1502 /* Unlinks path from the directory tree.  Read the Documentation for more info.
1503  */
1504 int do_unlink(char *path)
1505 {
1506         struct dentry *dentry;
1507         struct inode *parent_dir;
1508         struct nameidata nd_r = {0}, *nd = &nd_r;
1509         int error;
1510         int retval = -1;
1511
1512         /* get the parent of the target, and don't follow a final link */
1513         error = path_lookup(path, LOOKUP_PARENT, nd);
1514         if (error) {
1515                 set_errno(-error);
1516                 goto out_path_only;
1517         }
1518         parent_dir = nd->dentry->d_inode;
1519         /* make sure the target is there */
1520         dentry = do_lookup(nd->dentry, nd->last.name); 
1521         if (!dentry) {
1522                 set_errno(ENOENT);
1523                 goto out_path_only;
1524         }
1525         /* Make sure the target is not a directory */
1526         if (S_ISDIR(dentry->d_inode->i_mode)) {
1527                 set_errno(EISDIR);
1528                 goto out_dentry;
1529         }
1530         /* Remove the dentry from its parent */
1531         error = parent_dir->i_op->unlink(parent_dir, dentry);
1532         if (error) {
1533                 set_errno(-error);
1534                 goto out_dentry;
1535         }
1536         /* Now that our parent doesn't track us, we need to make sure we aren't
1537          * findable via the dentry cache.  DYING, so we will be freed in
1538          * dentry_release() */
1539         dentry->d_flags |= DENTRY_DYING;
1540         dcache_remove(dentry->d_sb, dentry);
1541         dentry->d_inode->i_nlink--;     /* TODO: race here, esp with a decref */
1542         /* At this point, the dentry is unlinked from the FS, and the inode has one
1543          * less link.  When the in-memory objects (dentry, inode) are going to be
1544          * released (after all open files are closed, and maybe after entries are
1545          * evicted from the cache), then nlinks will get checked and the FS-file
1546          * will get removed from the disk */
1547         retval = 0;                             /* Note the fall through to the exit paths */
1548 out_dentry:
1549         kref_put(&dentry->d_kref);
1550 out_path_only:
1551         path_release(nd);
1552         return retval;
1553 }
1554
1555 /* Checks to see if path can be accessed via mode.  Need to actually send the
1556  * mode along somehow, so this doesn't do much now.  This is an example of
1557  * decent error propagation from the lower levels via int retvals. */
1558 int do_access(char *path, int mode)
1559 {
1560         struct nameidata nd_r = {0}, *nd = &nd_r;
1561         int retval = 0;
1562         nd->intent = LOOKUP_ACCESS;
1563         retval = path_lookup(path, 0, nd);
1564         path_release(nd);       
1565         return retval;
1566 }
1567
1568 int do_file_chmod(struct file *file, int mode)
1569 {
1570         int old_mode_ftype = file->f_dentry->d_inode->i_mode & __S_IFMT;
1571         #if 0
1572         /* TODO: when we have notions of uid, check for the proc's uid */
1573         if (file->f_dentry->d_inode->i_uid != UID_OF_ME)
1574                 retval = -EPERM;
1575         else
1576         #endif
1577                 file->f_dentry->d_inode->i_mode = (mode & S_PMASK) | old_mode_ftype;
1578         return 0;
1579 }
1580
1581 /* Make a directory at path with mode.  Returns -1 and sets errno on errors */
1582 int do_mkdir(char *path, int mode)
1583 {
1584         struct dentry *dentry;
1585         struct inode *parent_i;
1586         struct nameidata nd_r = {0}, *nd = &nd_r;
1587         int error;
1588         int retval = -1;
1589
1590         nd->intent = LOOKUP_CREATE;
1591         /* get the parent, but don't follow links */
1592         error = path_lookup(path, LOOKUP_PARENT, nd);
1593         if (error) {
1594                 set_errno(-error);
1595                 goto out_path_only;
1596         }
1597         /* see if the target is already there, handle accordingly */
1598         dentry = do_lookup(nd->dentry, nd->last.name); 
1599         if (dentry) {
1600                 set_errno(EEXIST);
1601                 goto out_dentry;
1602         }
1603         /* Doesn't already exist, let's try to make it: */
1604         dentry = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
1605         if (!dentry)
1606                 goto out_path_only;
1607         parent_i = nd->dentry->d_inode;
1608         if (create_dir(parent_i, dentry, mode))
1609                 goto out_dentry;
1610         dcache_put(dentry->d_sb, dentry);
1611         retval = 0;                             /* Note the fall through to the exit paths */
1612 out_dentry:
1613         kref_put(&dentry->d_kref);
1614 out_path_only:
1615         path_release(nd);
1616         return retval;
1617 }
1618
1619 int do_rmdir(char *path)
1620 {
1621         struct dentry *dentry;
1622         struct inode *parent_i;
1623         struct nameidata nd_r = {0}, *nd = &nd_r;
1624         int error;
1625         int retval = -1;
1626
1627         /* get the parent, following links (probably want this), and we must get a
1628          * directory.  Note, current versions of path_lookup can't handle both
1629          * PARENT and DIRECTORY, at least, it doesn't check that *path is a
1630          * directory. */
1631         error = path_lookup(path, LOOKUP_PARENT | LOOKUP_FOLLOW | LOOKUP_DIRECTORY,
1632                             nd);
1633         if (error) {
1634                 set_errno(-error);
1635                 goto out_path_only;
1636         }
1637         /* make sure the target is already there, handle accordingly */
1638         dentry = do_lookup(nd->dentry, nd->last.name); 
1639         if (!dentry) {
1640                 set_errno(ENOENT);
1641                 goto out_path_only;
1642         }
1643         if (!S_ISDIR(dentry->d_inode->i_mode)) {
1644                 set_errno(ENOTDIR);
1645                 goto out_dentry;
1646         }
1647         if (dentry->d_mount_point) {
1648                 set_errno(EBUSY);
1649                 goto out_dentry;
1650         }
1651         /* TODO: make sure we aren't a mount or processes root (EBUSY) */
1652         /* Now for the removal.  the FSs will check if they are empty */
1653         parent_i = nd->dentry->d_inode;
1654         error = parent_i->i_op->rmdir(parent_i, dentry);
1655         if (error < 0) {
1656                 set_errno(-error);
1657                 goto out_dentry;
1658         }
1659         /* Now that our parent doesn't track us, we need to make sure we aren't
1660          * findable via the dentry cache.  DYING, so we will be freed in
1661          * dentry_release() */
1662         dentry->d_flags |= DENTRY_DYING;
1663         dcache_remove(dentry->d_sb, dentry);
1664         /* Decref ourselves, so inode_release() knows we are done */
1665         dentry->d_inode->i_nlink--;
1666         TAILQ_REMOVE(&nd->dentry->d_subdirs, dentry, d_subdirs_link);
1667         parent_i->i_nlink--;            /* TODO: race on this, esp since its a decref */
1668         /* we still have d_parent and a kref on our parent, which will go away when
1669          * the in-memory dentry object goes away. */
1670         retval = 0;                             /* Note the fall through to the exit paths */
1671 out_dentry:
1672         kref_put(&dentry->d_kref);
1673 out_path_only:
1674         path_release(nd);
1675         return retval;
1676 }
1677
1678 /* Pipes: Doing a simple buffer with reader and writer offsets.  Size is power
1679  * of two, so we can easily compute its status and whatnot. */
1680
1681 #define PIPE_SZ                                 (1 << PGSHIFT)
1682
1683 static size_t pipe_get_rd_idx(struct pipe_inode_info *pii)
1684 {
1685         return pii->p_rd_off & (PIPE_SZ - 1);
1686 }
1687
1688 static size_t pipe_get_wr_idx(struct pipe_inode_info *pii)
1689 {
1690
1691         return pii->p_wr_off & (PIPE_SZ - 1);
1692 }
1693
1694 static bool pipe_is_empty(struct pipe_inode_info *pii)
1695 {
1696         return __ring_empty(pii->p_wr_off, pii->p_rd_off);
1697 }
1698
1699 static bool pipe_is_full(struct pipe_inode_info *pii)
1700 {
1701         return __ring_full(PIPE_SZ, pii->p_wr_off, pii->p_rd_off);
1702 }
1703
1704 static size_t pipe_nr_full(struct pipe_inode_info *pii)
1705 {
1706         return __ring_nr_full(pii->p_wr_off, pii->p_rd_off);
1707 }
1708
1709 static size_t pipe_nr_empty(struct pipe_inode_info *pii)
1710 {
1711         return __ring_nr_empty(PIPE_SZ, pii->p_wr_off, pii->p_rd_off);
1712 }
1713
1714 ssize_t pipe_file_read(struct file *file, char *buf, size_t count,
1715                        off64_t *offset)
1716 {
1717         struct pipe_inode_info *pii = file->f_dentry->d_inode->i_pipe;
1718         size_t copy_amt, amt_copied = 0;
1719
1720         cv_lock(&pii->p_cv);
1721         while (pipe_is_empty(pii)) {
1722                 /* We wait til the pipe is drained before sending EOF if there are no
1723                  * writers (instead of aborting immediately) */
1724                 if (!pii->p_nr_writers) {
1725                         cv_unlock(&pii->p_cv);
1726                         return 0;
1727                 }
1728                 if (file->f_flags & O_NONBLOCK) {
1729                         cv_unlock(&pii->p_cv);
1730                         set_errno(EAGAIN);
1731                         return -1;
1732                 }
1733                 cv_wait(&pii->p_cv);
1734                 cpu_relax();
1735         }
1736         /* We might need to wrap-around with our copy, so we'll do the copy in two
1737          * passes.  This will copy up to the end of the buffer, then on the next
1738          * pass will copy the rest to the beginning of the buffer (if necessary) */
1739         for (int i = 0; i < 2; i++) {
1740                 copy_amt = MIN(PIPE_SZ - pipe_get_rd_idx(pii),
1741                                MIN(pipe_nr_full(pii), count));
1742                 assert(current);        /* shouldn't pipe from the kernel */
1743                 memcpy_to_user(current, buf, pii->p_buf + pipe_get_rd_idx(pii),
1744                                copy_amt);
1745                 buf += copy_amt;
1746                 count -= copy_amt;
1747                 pii->p_rd_off += copy_amt;
1748                 amt_copied += copy_amt;
1749         }
1750         /* Just using one CV for both readers and writers.  We should rarely have
1751          * multiple readers or writers. */
1752         if (amt_copied)
1753                 __cv_broadcast(&pii->p_cv);
1754         cv_unlock(&pii->p_cv);
1755         return amt_copied;
1756 }
1757
1758 /* Note: we're not dealing with PIPE_BUF and minimum atomic chunks, unless I
1759  * have to later. */
1760 ssize_t pipe_file_write(struct file *file, const char *buf, size_t count,
1761                         off64_t *offset)
1762 {
1763         struct pipe_inode_info *pii = file->f_dentry->d_inode->i_pipe;
1764         size_t copy_amt, amt_copied = 0;
1765
1766         cv_lock(&pii->p_cv);
1767         /* Write aborts right away if there are no readers, regardless of pipe
1768          * status. */
1769         if (!pii->p_nr_readers) {
1770                 cv_unlock(&pii->p_cv);
1771                 set_errno(EPIPE);
1772                 return -1;
1773         }
1774         while (pipe_is_full(pii)) {
1775                 if (file->f_flags & O_NONBLOCK) {
1776                         cv_unlock(&pii->p_cv);
1777                         set_errno(EAGAIN);
1778                         return -1;
1779                 }
1780                 cv_wait(&pii->p_cv);
1781                 cpu_relax();
1782                 /* Still need to check in the loop, in case the last reader left while
1783                  * we slept. */
1784                 if (!pii->p_nr_readers) {
1785                         cv_unlock(&pii->p_cv);
1786                         set_errno(EPIPE);
1787                         return -1;
1788                 }
1789         }
1790         /* We might need to wrap-around with our copy, so we'll do the copy in two
1791          * passes.  This will copy up to the end of the buffer, then on the next
1792          * pass will copy the rest to the beginning of the buffer (if necessary) */
1793         for (int i = 0; i < 2; i++) {
1794                 copy_amt = MIN(PIPE_SZ - pipe_get_wr_idx(pii),
1795                                MIN(pipe_nr_empty(pii), count));
1796                 assert(current);        /* shouldn't pipe from the kernel */
1797                 memcpy_from_user(current, pii->p_buf + pipe_get_wr_idx(pii), buf,
1798                                  copy_amt);
1799                 buf += copy_amt;
1800                 count -= copy_amt;
1801                 pii->p_wr_off += copy_amt;
1802                 amt_copied += copy_amt;
1803         }
1804         /* Just using one CV for both readers and writers.  We should rarely have
1805          * multiple readers or writers. */
1806         if (amt_copied)
1807                 __cv_broadcast(&pii->p_cv);
1808         cv_unlock(&pii->p_cv);
1809         return amt_copied;
1810 }
1811
1812 /* In open and release, we need to track the number of readers and writers,
1813  * which we can differentiate by the file flags. */
1814 int pipe_open(struct inode *inode, struct file *file)
1815 {
1816         struct pipe_inode_info *pii = inode->i_pipe;
1817         cv_lock(&pii->p_cv);
1818         /* Ugliness due to not using flags for O_RDONLY and friends... */
1819         if (file->f_mode == S_IRUSR) {
1820                 pii->p_nr_readers++;
1821         } else if (file->f_mode == S_IWUSR) {
1822                 pii->p_nr_writers++;
1823         } else {
1824                 warn("Bad pipe file flags 0x%x\n", file->f_flags);
1825         }
1826         cv_unlock(&pii->p_cv);
1827         return 0;
1828 }
1829
1830 int pipe_release(struct inode *inode, struct file *file)
1831 {
1832         struct pipe_inode_info *pii = inode->i_pipe;
1833         cv_lock(&pii->p_cv);
1834         /* Ugliness due to not using flags for O_RDONLY and friends... */
1835         if (file->f_mode == S_IRUSR) {
1836                 pii->p_nr_readers--;
1837         } else if (file->f_mode == S_IWUSR) {
1838                 pii->p_nr_writers--;
1839         } else {
1840                 warn("Bad pipe file flags 0x%x\n", file->f_flags);
1841         }
1842         /* need to wake up any sleeping readers/writers, since we might be done */
1843         __cv_broadcast(&pii->p_cv);
1844         cv_unlock(&pii->p_cv);
1845         return 0;
1846 }
1847
1848 struct file_operations pipe_f_op = {
1849         .read = pipe_file_read,
1850         .write = pipe_file_write,
1851         .open = pipe_open,
1852         .release = pipe_release,
1853         0
1854 };
1855
1856 void pipe_debug(struct file *f)
1857 {
1858         struct pipe_inode_info *pii = f->f_dentry->d_inode->i_pipe;
1859         assert(pii);
1860         printk("PIPE %p\n", pii);
1861         printk("\trdoff %p\n", pii->p_rd_off);
1862         printk("\twroff %p\n", pii->p_wr_off);
1863         printk("\tnr_rds %d\n", pii->p_nr_readers);
1864         printk("\tnr_wrs %d\n", pii->p_nr_writers);
1865         printk("\tcv waiters %d\n", pii->p_cv.nr_waiters);
1866
1867 }
1868
1869 /* General plan: get a dentry/inode to represent the pipe.  We'll alloc it from
1870  * the default_ns SB, but won't actually link it anywhere.  It'll only be held
1871  * alive by the krefs, til all the FDs are closed. */
1872 int do_pipe(struct file **pipe_files, int flags)
1873 {
1874         struct dentry *pipe_d;
1875         struct inode *pipe_i;
1876         struct file *pipe_f_read, *pipe_f_write;
1877         struct super_block *def_sb = default_ns.root->mnt_sb;
1878         struct pipe_inode_info *pii;
1879
1880         pipe_d = get_dentry(def_sb, 0, "pipe");
1881         if (!pipe_d)
1882                 return -1;
1883         pipe_d->d_op = &dummy_d_op;
1884         pipe_i = get_inode(pipe_d);
1885         if (!pipe_i)
1886                 goto error_post_dentry;
1887         /* preemptively mark the dentry for deletion.  we have an unlinked dentry
1888          * right off the bat, held in only by the kref chain (pipe_d is the ref). */
1889         pipe_d->d_flags |= DENTRY_DYING;
1890         /* pipe_d->d_inode still has one ref to pipe_i, keeping the inode alive */
1891         kref_put(&pipe_i->i_kref);
1892         /* init inode fields.  note we're using the dummy ops for i_op and d_op */
1893         pipe_i->i_mode = S_IRWXU | S_IRWXG | S_IRWXO;
1894         SET_FTYPE(pipe_i->i_mode, __S_IFIFO);   /* using type == FIFO */
1895         pipe_i->i_nlink = 1;                    /* one for the dentry */
1896         pipe_i->i_uid = 0;
1897         pipe_i->i_gid = 0;
1898         pipe_i->i_size = PGSIZE;
1899         pipe_i->i_blocks = 0;
1900         pipe_i->i_atime.tv_sec = 0;
1901         pipe_i->i_atime.tv_nsec = 0;
1902         pipe_i->i_mtime.tv_sec = 0;
1903         pipe_i->i_mtime.tv_nsec = 0;
1904         pipe_i->i_ctime.tv_sec = 0;
1905         pipe_i->i_ctime.tv_nsec = 0;
1906         pipe_i->i_fs_info = 0;
1907         pipe_i->i_op = &dummy_i_op;
1908         pipe_i->i_fop = &pipe_f_op;
1909         pipe_i->i_socket = FALSE;
1910         /* Actually build the pipe.  We're using one page, hanging off the
1911          * pipe_inode_info struct.  When we release the inode, we free the pipe
1912          * memory too */
1913         pipe_i->i_pipe = kmalloc(sizeof(struct pipe_inode_info), KMALLOC_WAIT);
1914         pii = pipe_i->i_pipe;
1915         if (!pii) {
1916                 set_errno(ENOMEM);
1917                 goto error_kmalloc;
1918         }
1919         pii->p_buf = kpage_zalloc_addr();
1920         if (!pii->p_buf) {
1921                 set_errno(ENOMEM);
1922                 goto error_kpage;
1923         }
1924         pii->p_rd_off = 0;
1925         pii->p_wr_off = 0;
1926         pii->p_nr_readers = 0;
1927         pii->p_nr_writers = 0;
1928         cv_init(&pii->p_cv);    /* must do this before dentry_open / pipe_open */
1929         /* Now we have an inode for the pipe.  We need two files for the read and
1930          * write ends of the pipe. */
1931         flags &= ~(O_ACCMODE);  /* avoid user bugs */
1932         pipe_f_read = dentry_open(pipe_d, flags | O_RDONLY);
1933         if (!pipe_f_read)
1934                 goto error_f_read;
1935         pipe_f_write = dentry_open(pipe_d, flags | O_WRONLY);
1936         if (!pipe_f_write)
1937                 goto error_f_write;
1938         pipe_files[0] = pipe_f_read;
1939         pipe_files[1] = pipe_f_write;
1940         return 0;
1941
1942 error_f_write:
1943         kref_put(&pipe_f_read->f_kref);
1944 error_f_read:
1945         page_decref(kva2page(pii->p_buf));
1946 error_kpage:
1947         kfree(pipe_i->i_pipe);
1948 error_kmalloc:
1949         /* We don't need to free the pipe_i; putting the dentry will free it */
1950 error_post_dentry:
1951         /* Note we only free the dentry on failure. */
1952         kref_put(&pipe_d->d_kref);
1953         return -1;
1954 }
1955
1956 struct file *alloc_file(void)
1957 {
1958         struct file *file = kmem_cache_alloc(file_kcache, 0);
1959         if (!file) {
1960                 set_errno(ENOMEM);
1961                 return 0;
1962         }
1963         /* one for the ref passed out*/
1964         kref_init(&file->f_kref, file_release, 1);
1965         return file;
1966 }
1967
1968 /* Opens and returns the file specified by dentry */
1969 struct file *dentry_open(struct dentry *dentry, int flags)
1970 {
1971         struct inode *inode;
1972         struct file *file;
1973         int desired_mode;
1974         inode = dentry->d_inode;
1975         /* Do the mode first, since we can still error out.  f_mode stores how the
1976          * OS file is open, which can be more restrictive than the i_mode */
1977         switch (flags & (O_RDONLY | O_WRONLY | O_RDWR)) {
1978                 case O_RDONLY:
1979                         desired_mode = S_IRUSR;
1980                         break;
1981                 case O_WRONLY:
1982                         desired_mode = S_IWUSR;
1983                         break;
1984                 case O_RDWR:
1985                         desired_mode = S_IRUSR | S_IWUSR;
1986                         break;
1987                 default:
1988                         goto error_access;
1989         }
1990         if (check_perms(inode, desired_mode))
1991                 goto error_access;
1992         file = alloc_file();
1993         if (!file)
1994                 return 0;
1995         file->f_mode = desired_mode;
1996         /* Add to the list of all files of this SB */
1997         TAILQ_INSERT_TAIL(&inode->i_sb->s_files, file, f_list);
1998         kref_get(&dentry->d_kref, 1);
1999         file->f_dentry = dentry;
2000         kref_get(&inode->i_sb->s_mount->mnt_kref, 1);
2001         file->f_vfsmnt = inode->i_sb->s_mount;          /* saving a ref to the vmnt...*/
2002         file->f_op = inode->i_fop;
2003         /* Don't store creation flags */
2004         file->f_flags = flags & ~O_CREAT_FLAGS;
2005         file->f_pos = 0;
2006         file->f_uid = inode->i_uid;
2007         file->f_gid = inode->i_gid;
2008         file->f_error = 0;
2009 //      struct event_poll_tailq         f_ep_links;
2010         spinlock_init(&file->f_ep_lock);
2011         file->f_privdata = 0;                                           /* prob overriden by the fs */
2012         file->f_mapping = inode->i_mapping;
2013         file->f_op->open(inode, file);
2014         return file;
2015 error_access:
2016         set_errno(EACCES);
2017         return 0;
2018 }
2019
2020 /* Closes a file, fsync, whatever else is necessary.  Called when the kref hits
2021  * 0.  Note that the file is not refcounted on the s_files list, nor is the
2022  * f_mapping refcounted (it is pinned by the i_mapping). */
2023 void file_release(struct kref *kref)
2024 {
2025         struct file *file = container_of(kref, struct file, f_kref);
2026
2027         struct super_block *sb = file->f_dentry->d_sb;
2028         spin_lock(&sb->s_lock);
2029         TAILQ_REMOVE(&sb->s_files, file, f_list);
2030         spin_unlock(&sb->s_lock);
2031
2032         /* TODO: fsync (BLK).  also, we may want to parallelize the blocking that
2033          * could happen in here (spawn kernel threads)... */
2034         file->f_op->release(file->f_dentry->d_inode, file);
2035         /* Clean up the other refs we hold */
2036         kref_put(&file->f_dentry->d_kref);
2037         kref_put(&file->f_vfsmnt->mnt_kref);
2038         kmem_cache_free(file_kcache, file);
2039 }
2040
2041 /* Process-related File management functions */
2042
2043 /* Given any FD, get the appropriate file, 0 o/w */
2044 struct file *get_file_from_fd(struct files_struct *open_files, int file_desc)
2045 {
2046         struct file *retval = 0;
2047         if (file_desc < 0)
2048                 return 0;
2049         spin_lock(&open_files->lock);
2050         if (open_files->closed) {
2051                 spin_unlock(&open_files->lock);
2052                 return 0;
2053         }
2054         if (file_desc < open_files->max_fdset) {
2055                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
2056                         /* while max_files and max_fdset might not line up, we should never
2057                          * have a valid fdset higher than files */
2058                         assert(file_desc < open_files->max_files);
2059                         retval = open_files->fd[file_desc].fd_file;
2060                         /* 9ns might be using this one, in which case file == 0 */
2061                         if (retval)
2062                                 kref_get(&retval->f_kref, 1);
2063                 }
2064         }
2065         spin_unlock(&open_files->lock);
2066         return retval;
2067 }
2068
2069 /* Grow the vfs fd set */
2070 static int grow_fd_set(struct files_struct *open_files) {
2071         int n;
2072         struct file_desc *nfd, *ofd;
2073
2074         /* Only update open_fds once. If currently pointing to open_fds_init, then
2075          * update it to point to a newly allocated fd_set with space for
2076          * NR_FILE_DESC_MAX */
2077         if (open_files->open_fds == (struct fd_set*)&open_files->open_fds_init) {
2078                 open_files->open_fds = kzmalloc(sizeof(struct fd_set), 0);
2079                 memmove(open_files->open_fds, &open_files->open_fds_init,
2080                         sizeof(struct small_fd_set));
2081         }
2082
2083         /* Grow the open_files->fd array in increments of NR_OPEN_FILES_DEFAULT */
2084         n = open_files->max_files + NR_OPEN_FILES_DEFAULT;
2085         if (n > NR_FILE_DESC_MAX)
2086                 n = NR_FILE_DESC_MAX;
2087         nfd = kzmalloc(n * sizeof(struct file_desc), 0);
2088         if (nfd == NULL)
2089                 return -1;
2090
2091         /* Move the old array on top of the new one */
2092         ofd = open_files->fd;
2093         memmove(nfd, ofd, open_files->max_files * sizeof(struct file_desc));
2094
2095         /* Update the array and the maxes for both max_files and max_fdset */
2096         open_files->fd = nfd;
2097         open_files->max_files = n;
2098         open_files->max_fdset = n;
2099
2100         /* Only free the old one if it wasn't pointing to open_files->fd_array */
2101         if (ofd != open_files->fd_array)
2102                 kfree(ofd);
2103         return 0;
2104 }
2105
2106 /* Free the vfs fd set if necessary */
2107 static void free_fd_set(struct files_struct *open_files) {
2108         if (open_files->open_fds != (struct fd_set*)&open_files->open_fds_init) {
2109                 kfree(open_files->open_fds);
2110                 assert(open_files->fd != open_files->fd_array);
2111                 kfree(open_files->fd);
2112         }
2113 }
2114
2115 /* 9ns: puts back an FD from the VFS-FD-space. */
2116 int put_fd(struct files_struct *open_files, int file_desc)
2117 {
2118         if (file_desc < 0) {
2119                 warn("Negative FD!\n");
2120                 return 0;
2121         }
2122         spin_lock(&open_files->lock);
2123         if (file_desc < open_files->max_fdset) {
2124                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
2125                         /* while max_files and max_fdset might not line up, we should never
2126                          * have a valid fdset higher than files */
2127                         assert(file_desc < open_files->max_files);
2128                         CLR_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc);
2129                 }
2130         }
2131         spin_unlock(&open_files->lock);
2132         return 0;
2133 }
2134
2135 /* Remove FD from the open files, if it was there, and return f.  Currently,
2136  * this decref's f, so the return value is not consumable or even usable.  This
2137  * hasn't been thought through yet. */
2138 struct file *put_file_from_fd(struct files_struct *open_files, int file_desc)
2139 {
2140         struct file *file = 0;
2141         if (file_desc < 0)
2142                 return 0;
2143         spin_lock(&open_files->lock);
2144         if (file_desc < open_files->max_fdset) {
2145                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
2146                         /* while max_files and max_fdset might not line up, we should never
2147                          * have a valid fdset higher than files */
2148                         assert(file_desc < open_files->max_files);
2149                         file = open_files->fd[file_desc].fd_file;
2150                         open_files->fd[file_desc].fd_file = 0;
2151                         assert(file);   /* 9ns shouldn't call this put */
2152                         kref_put(&file->f_kref);
2153                         CLR_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc);
2154                 }
2155         }
2156         spin_unlock(&open_files->lock);
2157         return file;
2158 }
2159
2160 static int __get_fd(struct files_struct *open_files, int low_fd)
2161 {
2162         int slot = -1;
2163         if ((low_fd < 0) || (low_fd > NR_FILE_DESC_MAX))
2164                 return -EINVAL;
2165         if (open_files->closed)
2166                 return -EINVAL; /* won't matter, they are dying */
2167
2168         /* Loop until we have a valid slot (we grow the fd_array at the bottom of
2169          * the loop if we haven't found a slot in the current array */
2170         while (slot == -1) {
2171                 for (low_fd; low_fd < open_files->max_fdset; low_fd++) {
2172                         if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, low_fd))
2173                                 continue;
2174                         slot = low_fd;
2175                         SET_BITMASK_BIT(open_files->open_fds->fds_bits, slot);
2176                         assert(slot < open_files->max_files &&
2177                                open_files->fd[slot].fd_file == 0);
2178                         if (slot >= open_files->next_fd)
2179                                 open_files->next_fd = slot + 1;
2180                         break;
2181                 }
2182                 if (slot == -1) {
2183                         /* Expand the FD array and fd_set */
2184                         if (grow_fd_set(open_files) == -1)
2185                                 return -ENOMEM;
2186                         /* loop after growing */
2187                 }
2188         }
2189         return slot;
2190 }
2191
2192 /* Gets and claims a free FD, used by 9ns.  < 0 == error. */
2193 int get_fd(struct files_struct *open_files, int low_fd)
2194 {
2195         int slot;
2196         spin_lock(&open_files->lock);
2197         slot = __get_fd(open_files, low_fd);
2198         spin_unlock(&open_files->lock);
2199         return slot;
2200 }
2201
2202 static int __claim_fd(struct files_struct *open_files, int file_desc)
2203 {
2204         if ((file_desc < 0) || (file_desc > NR_FILE_DESC_MAX))
2205                 return -EINVAL;
2206         if (open_files->closed)
2207                 return -EINVAL; /* won't matter, they are dying */
2208
2209         /* Grow the open_files->fd_set until the file_desc can fit inside it */
2210         while(file_desc >= open_files->max_files) {
2211                 grow_fd_set(open_files);
2212                 cpu_relax();
2213         }
2214
2215         /* If we haven't grown, this could be a problem, so check for it */
2216         if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc))
2217                 return -ENFILE; /* Should never really happen. Here to catch bugs. */
2218
2219         SET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc);
2220         assert(file_desc < open_files->max_files && open_files->fd[0].fd_file == 0);
2221         if (file_desc >= open_files->next_fd)
2222                 open_files->next_fd = file_desc + 1;
2223         return 0;
2224 }
2225
2226 /* Claims a specific FD when duping FDs. used by 9ns.  < 0 == error. */
2227 int claim_fd(struct files_struct *open_files, int file_desc)
2228 {
2229         int ret;
2230         spin_lock(&open_files->lock);
2231         ret = __claim_fd(open_files, file_desc);
2232         spin_unlock(&open_files->lock);
2233         return ret;
2234 }
2235
2236 /* Inserts the file in the files_struct, returning the corresponding new file
2237  * descriptor, or an error code.  We start looking for open fds from low_fd. */
2238 int insert_file(struct files_struct *open_files, struct file *file, int low_fd)
2239 {
2240         int slot;
2241         spin_lock(&open_files->lock);
2242         slot = __get_fd(open_files, low_fd);
2243         if (slot < 0) {
2244                 spin_unlock(&open_files->lock);
2245                 return slot;
2246         }
2247         assert(slot < open_files->max_files &&
2248                open_files->fd[slot].fd_file == 0);
2249         kref_get(&file->f_kref, 1);
2250         open_files->fd[slot].fd_file = file;
2251         open_files->fd[slot].fd_flags = 0;
2252         spin_unlock(&open_files->lock);
2253         return slot;
2254 }
2255
2256 /* Closes all open files.  Mostly just a "put" for all files.  If cloexec, it
2257  * will only close files that are opened with O_CLOEXEC. */
2258 void close_all_files(struct files_struct *open_files, bool cloexec)
2259 {
2260         struct file *file;
2261         spin_lock(&open_files->lock);
2262         if (open_files->closed) {
2263                 spin_unlock(&open_files->lock);
2264                 return;
2265         }
2266         for (int i = 0; i < open_files->max_fdset; i++) {
2267                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, i)) {
2268                         /* while max_files and max_fdset might not line up, we should never
2269                          * have a valid fdset higher than files */
2270                         assert(i < open_files->max_files);
2271                         file = open_files->fd[i].fd_file;
2272                         /* no file == 9ns uses the FD.  they will deal with it */
2273                         if (!file)
2274                                 continue;
2275                         if (cloexec && !(open_files->fd[i].fd_flags & O_CLOEXEC))
2276                                 continue;
2277                         /* Actually close the file */
2278                         open_files->fd[i].fd_file = 0;
2279                         assert(file);
2280                         kref_put(&file->f_kref);
2281                         CLR_BITMASK_BIT(open_files->open_fds->fds_bits, i);
2282                 }
2283         }
2284         if (!cloexec) {
2285                 free_fd_set(open_files);
2286                 open_files->closed = TRUE;
2287         }
2288         spin_unlock(&open_files->lock);
2289 }
2290
2291 /* Inserts all of the files from src into dst, used by sys_fork(). */
2292 void clone_files(struct files_struct *src, struct files_struct *dst)
2293 {
2294         struct file *file;
2295         spin_lock(&src->lock);
2296         if (src->closed) {
2297                 spin_unlock(&src->lock);
2298                 return;
2299         }
2300         spin_lock(&dst->lock);
2301         if (dst->closed) {
2302                 warn("Destination closed before it opened");
2303                 spin_unlock(&dst->lock);
2304                 spin_unlock(&src->lock);
2305                 return;
2306         }
2307         for (int i = 0; i < src->max_fdset; i++) {
2308                 if (GET_BITMASK_BIT(src->open_fds->fds_bits, i)) {
2309                         /* while max_files and max_fdset might not line up, we should never
2310                          * have a valid fdset higher than files */
2311                         assert(i < src->max_files);
2312                         file = src->fd[i].fd_file;
2313                         assert(i < dst->max_files && dst->fd[i].fd_file == 0);
2314                         SET_BITMASK_BIT(dst->open_fds->fds_bits, i);
2315                         dst->fd[i].fd_file = file;
2316                         /* no file means 9ns is using it, they clone separately */
2317                         if (file)
2318                                 kref_get(&file->f_kref, 1);
2319                         if (i >= dst->next_fd)
2320                                 dst->next_fd = i + 1;
2321                 }
2322         }
2323         spin_unlock(&dst->lock);
2324         spin_unlock(&src->lock);
2325 }
2326
2327 static void __chpwd(struct fs_struct *fs_env, struct dentry *new_pwd)
2328 {
2329         struct dentry *old_pwd;
2330         kref_get(&new_pwd->d_kref, 1);
2331         /* writer lock, make sure we replace pwd with ours.  could also CAS.
2332          * readers don't lock at all, so they need to either loop, or we need to
2333          * delay releasing old_pwd til an RCU grace period. */
2334         spin_lock(&fs_env->lock);
2335         old_pwd = fs_env->pwd;
2336         fs_env->pwd = new_pwd;
2337         spin_unlock(&fs_env->lock);
2338         kref_put(&old_pwd->d_kref);
2339 }
2340
2341 /* Change the working directory of the given fs env (one per process, at this
2342  * point).  Returns 0 for success, -ERROR for whatever error. */
2343 int do_chdir(struct fs_struct *fs_env, char *path)
2344 {
2345         struct nameidata nd_r = {0}, *nd = &nd_r;
2346         int retval;
2347         retval = path_lookup(path, LOOKUP_DIRECTORY, nd);
2348         if (!retval) {
2349                 /* nd->dentry is the place we want our PWD to be */
2350                 __chpwd(fs_env, nd->dentry);
2351         }
2352         path_release(nd);
2353         return retval;
2354 }
2355
2356 int do_fchdir(struct fs_struct *fs_env, struct file *file)
2357 {
2358         if ((file->f_dentry->d_inode->i_mode & __S_IFMT) != __S_IFDIR) {
2359                 set_errno(ENOTDIR);
2360                 return -1;
2361         }
2362         __chpwd(fs_env, file->f_dentry);
2363         return 0;
2364 }
2365
2366 /* Returns a null-terminated string of up to length cwd_l containing the
2367  * absolute path of fs_env, (up to fs_env's root).  Be sure to kfree the char*
2368  * "kfree_this" when you are done with it.  We do this since it's easier to
2369  * build this string going backwards.  Note cwd_l is not a strlen, it's an
2370  * absolute size. */
2371 char *do_getcwd(struct fs_struct *fs_env, char **kfree_this, size_t cwd_l)
2372 {
2373         struct dentry *dentry = fs_env->pwd;
2374         size_t link_len;
2375         char *path_start, *kbuf;
2376
2377         if (cwd_l < 2) {
2378                 set_errno(ERANGE);
2379                 return 0;
2380         }
2381         kbuf = kmalloc(cwd_l, 0);
2382         if (!kbuf) {
2383                 set_errno(ENOMEM);
2384                 return 0;
2385         }
2386         *kfree_this = kbuf;
2387         kbuf[cwd_l - 1] = '\0';
2388         kbuf[cwd_l - 2] = '/';
2389         /* for each dentry in the path, all the way back to the root of fs_env, we
2390          * grab the dentry name, push path_start back enough, and write in the name,
2391          * using /'s to terminate.  We skip the root, since we don't want it's
2392          * actual name, just "/", which is set before each loop. */
2393         path_start = kbuf + cwd_l - 2;  /* the last byte written */
2394         while (dentry != fs_env->root) {
2395                 link_len = dentry->d_name.len;          /* this does not count the \0 */
2396                 if (path_start - (link_len + 2) < kbuf) {
2397                         kfree(kbuf);
2398                         set_errno(ERANGE);
2399                         return 0;
2400                 }
2401                 path_start -= link_len;
2402                 strncpy(path_start, dentry->d_name.name, link_len);
2403                 path_start--;
2404                 *path_start = '/';
2405                 dentry = dentry->d_parent;      
2406         }
2407         return path_start;
2408 }
2409
2410 static void print_dir(struct dentry *dentry, char *buf, int depth)
2411 {
2412         struct dentry *child_d;
2413         struct dirent next = {0};
2414         struct file *dir;
2415         int retval;
2416
2417         if (!S_ISDIR(dentry->d_inode->i_mode)) {
2418                 warn("Thought this was only directories!!");
2419                 return;
2420         }
2421         /* Print this dentry */
2422         printk("%s%s/ nlink: %d\n", buf, dentry->d_name.name,
2423                dentry->d_inode->i_nlink);
2424         if (dentry->d_mount_point) {
2425                 dentry = dentry->d_mounted_fs->mnt_root;
2426         }
2427         if (depth >= 32)
2428                 return;
2429         /* Set buffer for our kids */
2430         buf[depth] = '\t';
2431         dir = dentry_open(dentry, 0);
2432         if (!dir)
2433                 panic("Filesystem seems inconsistent - unable to open a dir!");
2434         /* Process every child, recursing on directories */
2435         while (1) {
2436                 retval = dir->f_op->readdir(dir, &next);
2437                 if (retval >= 0) {
2438                         /* Skip .., ., and empty entries */
2439                         if (!strcmp("..", next.d_name) || !strcmp(".", next.d_name) ||
2440                             next.d_ino == 0)
2441                                 goto loop_next;
2442                         /* there is an entry, now get its dentry */
2443                         child_d = do_lookup(dentry, next.d_name);
2444                         if (!child_d)
2445                                 panic("Inconsistent FS, dirent doesn't have a dentry!");
2446                         /* Recurse for directories, or just print the name for others */
2447                         switch (child_d->d_inode->i_mode & __S_IFMT) {
2448                                 case (__S_IFDIR):
2449                                         print_dir(child_d, buf, depth + 1);
2450                                         break;
2451                                 case (__S_IFREG):
2452                                         printk("%s%s size(B): %d nlink: %d\n", buf, next.d_name,
2453                                                child_d->d_inode->i_size, child_d->d_inode->i_nlink);
2454                                         break;
2455                                 case (__S_IFLNK):
2456                                         printk("%s%s -> %s\n", buf, next.d_name,
2457                                                child_d->d_inode->i_op->readlink(child_d));
2458                                         break;
2459                                 case (__S_IFCHR):
2460                                         printk("%s%s (char device) nlink: %d\n", buf, next.d_name,
2461                                                child_d->d_inode->i_nlink);
2462                                         break;
2463                                 case (__S_IFBLK):
2464                                         printk("%s%s (block device) nlink: %d\n", buf, next.d_name,
2465                                                child_d->d_inode->i_nlink);
2466                                         break;
2467                                 default:
2468                                         warn("Look around you!  Unknown filetype!");
2469                         }
2470                         kref_put(&child_d->d_kref);     
2471                 }
2472 loop_next:
2473                 if (retval <= 0)
2474                         break;
2475         }
2476         /* Reset buffer to the way it was */
2477         buf[depth] = '\0';
2478         kref_put(&dir->f_kref);
2479 }
2480
2481 /* Debugging */
2482 int ls_dash_r(char *path)
2483 {
2484         struct nameidata nd_r = {0}, *nd = &nd_r;
2485         int error;
2486         char buf[32] = {0};
2487
2488         error = path_lookup(path, LOOKUP_ACCESS | LOOKUP_DIRECTORY, nd);
2489         if (error) {
2490                 path_release(nd);
2491                 return error;
2492         }
2493         print_dir(nd->dentry, buf, 0);
2494         path_release(nd);
2495         return 0;
2496 }
2497
2498 /* Dummy ops, to catch weird operations we weren't expecting */
2499 int dummy_create(struct inode *dir, struct dentry *dentry, int mode,
2500                  struct nameidata *nd)
2501 {
2502         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2503         return -1;
2504 }
2505
2506 struct dentry *dummy_lookup(struct inode *dir, struct dentry *dentry,
2507                           struct nameidata *nd)
2508 {
2509         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2510         return 0;
2511 }
2512
2513 int dummy_link(struct dentry *old_dentry, struct inode *dir,
2514              struct dentry *new_dentry)
2515 {
2516         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2517         return -1;
2518 }
2519
2520 int dummy_unlink(struct inode *dir, struct dentry *dentry)
2521 {
2522         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2523         return -1;
2524 }
2525
2526 int dummy_symlink(struct inode *dir, struct dentry *dentry, const char *symname)
2527 {
2528         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2529         return -1;
2530 }
2531
2532 int dummy_mkdir(struct inode *dir, struct dentry *dentry, int mode)
2533 {
2534         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2535         return -1;
2536 }
2537
2538 int dummy_rmdir(struct inode *dir, struct dentry *dentry)
2539 {
2540         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2541         return -1;
2542 }
2543
2544 int dummy_mknod(struct inode *dir, struct dentry *dentry, int mode, dev_t rdev)
2545 {
2546         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2547         return -1;
2548 }
2549
2550 int dummy_rename(struct inode *old_dir, struct dentry *old_dentry,
2551                struct inode *new_dir, struct dentry *new_dentry)
2552 {
2553         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2554         return -1;
2555 }
2556
2557 char *dummy_readlink(struct dentry *dentry)
2558 {
2559         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2560         return 0;
2561 }
2562
2563 void dummy_truncate(struct inode *inode)
2564 {
2565         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2566 }
2567
2568 int dummy_permission(struct inode *inode, int mode, struct nameidata *nd)
2569 {
2570         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2571         return -1;
2572 }
2573
2574 int dummy_d_revalidate(struct dentry *dir, struct nameidata *nd)
2575 {
2576         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2577         return -1;
2578 }
2579
2580 int dummy_d_hash(struct dentry *dentry, struct qstr *name)
2581 {
2582         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2583         return -1;
2584 }
2585
2586 int dummy_d_compare(struct dentry *dir, struct qstr *name1, struct qstr *name2)
2587 {
2588         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2589         return -1;
2590 }
2591
2592 int dummy_d_delete(struct dentry *dentry)
2593 {
2594         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2595         return -1;
2596 }
2597
2598 int dummy_d_release(struct dentry *dentry)
2599 {
2600         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2601         return -1;
2602 }
2603
2604 void dummy_d_iput(struct dentry *dentry, struct inode *inode)
2605 {
2606         printk("Dummy VFS function %s called!\n", __FUNCTION__);
2607 }
2608
2609 struct inode_operations dummy_i_op = {
2610         dummy_create,
2611         dummy_lookup,
2612         dummy_link,
2613         dummy_unlink,
2614         dummy_symlink,
2615         dummy_mkdir,
2616         dummy_rmdir,
2617         dummy_mknod,
2618         dummy_rename,
2619         dummy_readlink,
2620         dummy_truncate,
2621         dummy_permission,
2622 };
2623
2624 struct dentry_operations dummy_d_op = {
2625         dummy_d_revalidate,
2626         dummy_d_hash,
2627         dummy_d_compare,
2628         dummy_d_delete,
2629         dummy_d_release,
2630         dummy_d_iput,
2631 };