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