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