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