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