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