7aab4217b310bdf923cc7671788eb32cad8824de
[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
18 struct sb_tailq super_blocks = TAILQ_HEAD_INITIALIZER(super_blocks);
19 spinlock_t super_blocks_lock = SPINLOCK_INITIALIZER;
20 struct fs_type_tailq file_systems = TAILQ_HEAD_INITIALIZER(file_systems);
21 struct namespace default_ns;
22 // TODO: temp dcache, holds all dentries ever for now
23 struct dentry_slist dcache = SLIST_HEAD_INITIALIZER(dcache);
24 spinlock_t dcache_lock = SPINLOCK_INITIALIZER;
25
26 struct kmem_cache *dentry_kcache; // not to be confused with the dcache
27 struct kmem_cache *inode_kcache;
28 struct kmem_cache *file_kcache;
29
30 /* Mounts fs from dev_name at mnt_pt in namespace ns.  There could be no mnt_pt,
31  * such as with the root of (the default) namespace.  Not sure how it would work
32  * with multiple namespaces on the same FS yet.  Note if you mount the same FS
33  * multiple times, you only have one FS still (and one SB).  If we ever support
34  * that... */
35 struct vfsmount *mount_fs(struct fs_type *fs, char *dev_name,
36                           struct dentry *mnt_pt, int flags,
37                           struct namespace *ns)
38 {
39         struct super_block *sb;
40         struct vfsmount *vmnt = kmalloc(sizeof(struct vfsmount), 0);
41
42         /* Build the vfsmount, if there is no mnt_pt, mnt is the root vfsmount (for now).
43          * fields related to the actual FS, like the sb and the mnt_root are set in
44          * the fs-specific get_sb() call. */
45         if (!mnt_pt) {
46                 vmnt->mnt_parent = NULL;
47                 vmnt->mnt_mountpoint = NULL;
48         } else { /* common case, but won't be tested til we try to mount another FS */
49                 mnt_pt->d_mount_point = TRUE;
50                 mnt_pt->d_mounted_fs = vmnt;
51                 atomic_inc(&vmnt->mnt_refcnt); /* held by mnt_pt */
52                 vmnt->mnt_parent = mnt_pt->d_sb->s_mount;
53                 vmnt->mnt_mountpoint = mnt_pt;
54         }
55         TAILQ_INIT(&vmnt->mnt_child_mounts);
56         vmnt->mnt_flags = flags;
57         vmnt->mnt_devname = dev_name;
58         vmnt->mnt_namespace = ns;
59         atomic_inc(&ns->refcnt); /* held by vmnt */
60         atomic_set(&vmnt->mnt_refcnt, 1); /* for the ref in the NS tailq below */
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
94         atomic_set(&default_ns.refcnt, 1); // default NS never dies, +1 to exist
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_FOREACH(fs, &file_systems, list)
103                 printk("Supports the %s Filesystem\n", fs->name);
104
105         /* mounting KFS at the root (/), pending root= parameters */
106         // TODO: linux creates a temp root_fs, then mounts the real root onto that
107         default_ns.root = mount_fs(&kfs_fs_type, "RAM", NULL, 0, &default_ns);
108
109         printk("vfs_init() completed\n");
110         /*
111         put structs and friends in struct proc, and init in proc init
112         */
113         // LOOKUP: follow_mount, follow_link, etc
114         // pains in the ass for having .. or . in the middle of the path
115 }
116
117 /* Builds / populates the qstr of a dentry based on its d_iname.  If there is an
118  * l_name, (long), it will use that instead of the inline name.  This will
119  * probably change a bit. */
120 void qstr_builder(struct dentry *dentry, char *l_name)
121 {
122         dentry->d_name.name = l_name ? l_name : dentry->d_iname;
123         // TODO: pending what we actually do in d_hash
124         //dentry->d_name.hash = dentry->d_op->d_hash(dentry, &dentry->d_name); 
125         dentry->d_name.hash = 0xcafebabe;
126         dentry->d_name.len = strnlen(dentry->d_name.name, MAX_FILENAME_SZ);
127 }
128
129 /* Useful little helper - return the string ptr for a given file */
130 char *file_name(struct file *file)
131 {
132         return (char*)TAILQ_FIRST(&file->f_inode->i_dentry)->d_name.name;
133 }
134
135 /* Some issues with this, coupled closely to fs_lookup.  This assumes that
136  * negative dentries are not returned (might differ from linux) */
137 static struct dentry *do_lookup(struct dentry *parent, char *name)
138 {
139         struct dentry *dentry;
140         /* TODO: look up in the dentry cache first */
141         dentry = get_dentry(parent->d_sb, parent, name);
142         dentry = parent->d_inode->i_op->lookup(parent->d_inode, dentry, 0);
143         /* insert in dentry cache */
144         /* TODO: if the following are done by us, how do we know the i_ino?
145          * also need to handle inodes that are already read in!  For now, we're
146          * going to have the FS handle it in it's lookup() method: 
147          * - get a new inode
148          * - read in the inode
149          * - put in the inode cache */
150         return dentry;
151 }
152
153 /* Walk up one directory, being careful of mountpoints, namespaces, and the top
154  * of the FS */
155 static int climb_up(struct nameidata *nd)
156 {
157         // TODO
158         warn("Climbing up (../) in path lookup not supported yet!");
159         return 0;
160 }
161
162 /* Update ND such that it represents having followed dentry.  IAW the nd
163  * refcnting rules, we need to decref any references that were in there before
164  * they get clobbered. */
165 static int next_link(struct dentry *dentry, struct nameidata *nd)
166 {
167         assert(nd->dentry && nd->mnt);
168         atomic_dec(&nd->dentry->d_refcnt);
169         atomic_dec(&nd->mnt->mnt_refcnt);
170         nd->dentry = dentry;
171         nd->mnt = dentry->d_sb->s_mount;
172         return 0;
173 }
174
175 static int follow_mount(struct nameidata *nd)
176 {
177         /* Detect mount, follow, etc... (TODO!) */
178         return 0;
179 }
180
181 static int follow_symlink(struct nameidata *nd)
182 {
183         /* Detect symlink, LOOKUP_FOLLOW, follow it, etc... (TODO!) */
184         return 0;
185 }
186
187 /* Resolves the links in a basic path walk.  0 for success, -EWHATEVER
188  * otherwise.  The final lookup is returned via nd. */
189 static int link_path_walk(char *path, struct nameidata *nd)
190 {
191         struct dentry *link_dentry;
192         struct inode *link_inode, *nd_inode;
193         char *next_slash;
194         char *link = path;
195         int error;
196
197         /* skip all leading /'s */
198         while (*link == '/')
199                 link++;
200         /* if there's nothing left (null terminated), we're done */
201         if (*link == '\0')
202                 return 0;
203         /* TODO: deal with depth and LOOKUP_FOLLOW, important for symlinks */
204
205         /* iterate through each intermediate link of the path.  in general, nd
206          * tracks where we are in the path, as far as dentries go.  once we have the
207          * next dentry, we try to update nd based on that dentry.  link is the part
208          * of the path string that we are looking up */
209         while (1) {
210                 nd_inode = nd->dentry->d_inode;
211                 if ((error = check_perms(nd_inode, nd->intent)))
212                         return error;
213                 /* find the next link, break out if it is the end */
214                 next_slash = strchr(link, '/');
215                 if (!next_slash)
216                         break;
217                 else
218                         if (*(next_slash + 1) == '\0') {
219                                 /* trailing slash on the path meant the target is a dir */
220                                 nd->flags |= LOOKUP_DIRECTORY;
221                                 *next_slash = '\0';
222                                 break;
223                         }
224                 /* skip over any interim ./ */
225                 if (!strncmp("./", link, 2)) {
226                         link = next_slash + 1;
227                         continue;
228                 }
229                 /* Check for "../", walk up */
230                 if (!strncmp("../", link, 3)) {
231                         climb_up(nd);
232                         link = next_slash + 2;
233                         continue;
234                 }
235                 *next_slash = '\0';
236                 link_dentry = do_lookup(nd->dentry, link);
237                 *next_slash = '/';
238                 if (!link_dentry)
239                         return -ENOENT;
240                 /* make link_dentry the current step/answer */
241                 next_link(link_dentry, nd);
242                 /* we could be on a mountpoint or a symlink - need to follow them */
243                 follow_mount(nd);
244                 follow_symlink(nd);
245                 if (!(nd->dentry->d_inode->i_type & FS_I_DIR))
246                         return -ENOTDIR;
247                 /* move through the path string to the next entry */
248                 link = next_slash + 1;
249         }
250         /* now, we're on the last link of the path */
251         /* if we just want the parent, leave now.  linux does some stuff with saving
252          * the name of the link (last) and the type (last_type), which we'll do once
253          * i see the need for it. */
254         if (nd->flags & LOOKUP_PARENT)
255                 return 0;
256         /* deal with some weird cases with . and .. (completely untested) */
257         if (!strcmp(".", link))
258                 return 0;
259         if (!strcmp("..", link))
260                 return climb_up(nd);
261         link_dentry = do_lookup(nd->dentry, link);
262         if (!link_dentry)
263                 return -ENOENT;
264         next_link(link_dentry, nd);
265         follow_mount(nd);
266         follow_symlink(nd);
267         /* If we wanted a directory, but didn't get one, error out */
268         if ((nd->flags & LOOKUP_DIRECTORY) &&
269            !(nd->dentry->d_inode->i_type & FS_I_DIR))
270                 return -ENOTDIR;
271         return 0;
272 }
273
274 /* Given path, return the inode for the final dentry.  The ND should be
275  * initialized for the first call - specifically, we need the intent and
276  * potentially a LOOKUP_PARENT.
277  *
278  * Need to be careful too.  While the path has been copied-in to the kernel,
279  * it's still user input.  */
280 int path_lookup(char *path, int flags, struct nameidata *nd)
281 {
282         /* we allow absolute lookups with no process context */
283         if (path[0] == '/') {                   /* absolute lookup */
284                 if (!current)
285                         nd->dentry = default_ns.root->mnt_root;
286                 else
287                         nd->dentry = current->fs_env.root;      
288         } else {                                                /* relative lookup */
289                 assert(current);
290                 /* Don't need to lock on the fs_env since we're reading one item */
291                 nd->dentry = current->fs_env.pwd;       
292         }
293         nd->mnt = nd->dentry->d_sb->s_mount;
294         /* Whenever references get put in the nd, incref them.  Whenever they are
295          * removed, decref them. */
296         atomic_inc(&nd->mnt->mnt_refcnt);
297         atomic_inc(&nd->dentry->d_refcnt);
298         nd->flags = flags;
299         nd->depth = 0;                                  /* used in symlink following */
300         return link_path_walk(path, nd);        
301 }
302
303 /* Call this after any use of path_lookup when you are done with its results,
304  * regardless of whether it succeeded or not.  It will free any references */
305 void path_release(struct nameidata *nd)
306 {
307         /* TODO: (REF), do something when we hit 0, etc... */
308         atomic_dec(&nd->dentry->d_refcnt);
309         atomic_dec(&nd->mnt->mnt_refcnt);
310 }
311
312 /* Seems convenient: Given a path, return the appropriate file.  The reference
313  * returned is refcounted (which is done by open()). */
314 struct file *path_to_file(char *path)
315 {
316         struct file *f = 0;
317         struct nameidata nd = {0};
318         if (path_lookup(path, 0, &nd))
319                 return 0;
320         f = kmem_cache_alloc(file_kcache, 0);
321         if (!f) {
322                 path_release(&nd);
323                 return 0;
324         }
325         if (nd.dentry->d_inode->i_fop->open(nd.dentry->d_inode, f)) {
326                 path_release(&nd);
327                 kmem_cache_free(file_kcache, f);
328                 return 0;
329         }
330         path_release(&nd);
331         return f;
332 }
333
334 /* Superblock functions */
335
336 /* Helper to alloc and initialize a generic superblock.  This handles all the
337  * VFS related things, like lists.  Each FS will need to handle its own things
338  * in it's *_get_sb(), usually involving reading off the disc. */
339 struct super_block *get_sb(void)
340 {
341         struct super_block *sb = kmalloc(sizeof(struct super_block), 0);
342         sb->s_dirty = FALSE;
343         spinlock_init(&sb->s_lock);
344         atomic_set(&sb->s_refcnt, 1); // for the ref passed out
345         TAILQ_INIT(&sb->s_inodes);
346         TAILQ_INIT(&sb->s_dirty_i);
347         TAILQ_INIT(&sb->s_io_wb);
348         SLIST_INIT(&sb->s_anon_d);
349         TAILQ_INIT(&sb->s_files);
350         sb->s_fs_info = 0; // can override somewhere else
351         return sb;
352 }
353
354 /* Final stages of initializing a super block, including creating and linking
355  * the root dentry, root inode, vmnt, and sb.  The d_op and root_ino are
356  * FS-specific, but otherwise it's FS-independent, tricky, and not worth having
357  * around multiple times.
358  *
359  * Not the world's best interface, so it's subject to change, esp since we're
360  * passing (now 3) FS-specific things. */
361 void init_sb(struct super_block *sb, struct vfsmount *vmnt,
362              struct dentry_operations *d_op, unsigned long root_ino,
363              void *d_fs_info)
364 {
365         /* Build and init the first dentry / inode.  The dentry ref is stored later
366          * by vfsmount's mnt_root.  The parent is dealt with later. */
367         struct dentry *d_root = get_dentry(sb, 0,  "/");        /* probably right */
368
369         /* a lot of here on down is normally done in lookup() */
370         d_root->d_op = d_op;
371         d_root->d_fs_info = d_fs_info;
372         struct inode *inode = sb->s_op->alloc_inode(sb);
373         if (!inode)
374                 panic("This FS sucks!");
375         d_root->d_inode = inode;
376         TAILQ_INSERT_TAIL(&inode->i_dentry, d_root, d_alias);
377         atomic_inc(&d_root->d_refcnt);                  /* held by the inode */
378         inode->i_ino = root_ino;
379         /* TODO: add the inode to the appropriate list (off i_list) */
380         /* TODO: do we need to read in the inode?  can we do this on demand? */
381         /* if this FS is already mounted, we'll need to do something different. */
382         sb->s_op->read_inode(inode);
383         /* Link the dentry and SB to the VFS mount */
384         vmnt->mnt_root = d_root;                                /* refcnt'd above */
385         vmnt->mnt_sb = sb;
386         /* If there is no mount point, there is no parent.  This is true only for
387          * the rootfs. */
388         if (vmnt->mnt_mountpoint) {
389                 d_root->d_parent = vmnt->mnt_mountpoint;        /* dentry of the root */
390                 atomic_inc(&vmnt->mnt_mountpoint->d_refcnt);/* held by d_root */
391         }
392         /* insert the dentry into the dentry cache.  when's the earliest we can?
393          * when's the earliest we should?  what about concurrent accesses to the
394          * same dentry?  should be locking the dentry... */
395         dcache_put(d_root); // TODO: should set a d_flag too
396 }
397
398 /* Dentry Functions */
399
400 /* Helper to alloc and initialize a generic dentry.
401  *
402  * If the name is longer than the inline name, it will kmalloc a buffer, so
403  * don't worry about the storage for *name after calling this. */
404 struct dentry *get_dentry(struct super_block *sb, struct dentry *parent,
405                           char *name)
406 {
407         assert(name);
408         size_t name_len = strnlen(name, MAX_FILENAME_SZ);       /* not including \0! */
409         struct dentry *dentry = kmem_cache_alloc(dentry_kcache, 0);
410         char *l_name = 0;
411
412         //memset(dentry, 0, sizeof(struct dentry));
413         atomic_set(&dentry->d_refcnt, 1);       /* this ref is returned */
414         spinlock_init(&dentry->d_lock);
415         TAILQ_INIT(&dentry->d_subdirs);
416         dentry->d_time = 0;
417         dentry->d_sb = sb;                                      /* storing a ref here... */
418         dentry->d_mount_point = FALSE;
419         dentry->d_mounted_fs = 0;
420         dentry->d_parent = parent;
421         if (parent)                                                     /* no parent for rootfs mount */
422                 atomic_inc(&parent->d_refcnt);
423         dentry->d_flags = 0;                            /* related to its dcache state */
424         dentry->d_fs_info = 0;
425         SLIST_INIT(&dentry->d_bucket);
426         if (name_len < DNAME_INLINE_LEN) {
427                 strncpy(dentry->d_iname, name, name_len);
428                 dentry->d_iname[name_len] = '\0';
429                 qstr_builder(dentry, 0);
430         } else {
431                 l_name = kmalloc(name_len + 1, 0);
432                 assert(l_name);
433                 strncpy(l_name, name, name_len);
434                 l_name[name_len] = '\0';
435                 qstr_builder(dentry, l_name);
436         }
437         return dentry;
438 }
439
440 /* Adds a dentry to the dcache. */
441 void dcache_put(struct dentry *dentry)
442 {
443         // TODO: prob should do something with the dentry flags
444         spin_lock(&dcache_lock);
445         SLIST_INSERT_HEAD(&dcache, dentry, d_hash);
446         spin_unlock(&dcache_lock);
447 }
448
449 /* Inode Functions */
450
451 /* Returns 0 if the given mode is acceptable for the inode, and an appropriate
452  * error code if not.  Needs to be writen, based on some sensible rules, and
453  * will also probably use 'current' */
454 int check_perms(struct inode *inode, int access_mode)
455 {
456         return 0;       /* anything goes! */
457 }
458
459 /* File functions */
460
461 /* Read count bytes from the file into buf, starting at *offset, which is increased
462  * accordingly, returning the number of bytes transfered.  Most filesystems will
463  * use this function for their f_op->read.  Note, this uses the page cache.
464  * Want to try out page remapping later on... */
465 ssize_t generic_file_read(struct file *file, char *buf, size_t count,
466                           off_t *offset)
467 {
468         struct page *page;
469         int error;
470         off_t page_off;
471         unsigned long first_idx, last_idx;
472         size_t copy_amt;
473         char *buf_end;
474
475         /* Consider pushing some error checking higher in the VFS */
476         if (!count)
477                 return 0;
478         if (*offset == file->f_inode->i_size)
479                 return 0; /* EOF */
480         /* Make sure we don't go past the end of the file */
481         if (*offset + count > file->f_inode->i_size) {
482                 count = file->f_inode->i_size - *offset;
483         }
484         page_off = *offset & (PGSIZE - 1);
485         first_idx = *offset >> PGSHIFT;
486         last_idx = (*offset + count) >> PGSHIFT;
487         buf_end = buf + count;
488         /* For each file page, make sure it's in the page cache, then copy it out.
489          * TODO: will probably need to consider concurrently truncated files here.*/
490         for (int i = first_idx; i <= last_idx; i++) {
491                 error = file_load_page(file, i, &page);
492                 assert(!error); /* TODO: handle ENOMEM and friends */
493                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
494                 /* TODO: think about this.  if it's a user buffer, we're relying on
495                  * current to detect whose it is (which should work for async calls). */
496                 if (current) {
497                         memcpy_to_user(current, buf, page2kva(page) + page_off, copy_amt);
498                 } else {
499                         memcpy(buf, page2kva(page) + page_off, copy_amt);
500                 }
501                 buf += copy_amt;
502                 page_off = 0;
503                 page_decref(page);      /* it's still in the cache, we just don't need it */
504         }
505         assert(buf == buf_end);
506         *offset += count;
507         return count;
508 }
509
510 /* Write count bytes from buf to the file, starting at *offset, which is increased
511  * accordingly, returning the number of bytes transfered.  Most filesystems will
512  * use this function for their f_op->write.  Note, this uses the page cache.
513  * Changes don't get flushed to disc til there is an fsync, page cache eviction,
514  * or other means of trying to writeback the pages. */
515 ssize_t generic_file_write(struct file *file, const char *buf, size_t count,
516                            off_t *offset)
517 {
518         struct page *page;
519         int error;
520         off_t page_off;
521         unsigned long first_idx, last_idx;
522         size_t copy_amt;
523         const char *buf_end;
524
525         /* Consider pushing some error checking higher in the VFS */
526         if (!count)
527                 return 0;
528         /* Extend the file.  Should put more checks in here, and maybe do this per
529          * page in the for loop below. */
530         if (*offset + count > file->f_inode->i_size)
531                 file->f_inode->i_size = *offset + count;
532         page_off = *offset & (PGSIZE - 1);
533         first_idx = *offset >> PGSHIFT;
534         last_idx = (*offset + count) >> PGSHIFT;
535         buf_end = buf + count;
536         /* For each file page, make sure it's in the page cache, then write it.*/
537         for (int i = first_idx; i <= last_idx; i++) {
538                 error = file_load_page(file, i, &page);
539                 assert(!error); /* TODO: handle ENOMEM and friends */
540                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
541                 /* TODO: think about this.  if it's a user buffer, we're relying on
542                  * current to detect whose it is (which should work for async calls). */
543                 if (current) {
544                         memcpy_to_user(current, page2kva(page) + page_off, buf, copy_amt);
545                 } else {
546                         memcpy(page2kva(page) + page_off, buf, copy_amt);
547                 }
548                 buf += copy_amt;
549                 page_off = 0;
550                 page_decref(page);      /* it's still in the cache, we just don't need it */
551         }
552         assert(buf == buf_end);
553         *offset += count;
554         return count;
555 }
556
557 /* Page cache functions */
558
559 /* Looks up the index'th page in the page map, returning an incref'd reference,
560  * or 0 if it was not in the map. */
561 struct page *pm_find_page(struct page_map *pm, unsigned long index)
562 {
563         spin_lock(&pm->pm_tree_lock);
564         struct page *page = (struct page*)radix_lookup(&pm->pm_tree, index);
565         if (page)
566                 page_incref(page);
567         spin_unlock(&pm->pm_tree_lock);
568         return page;
569 }
570
571 /* Attempts to insert the page into the page_map, returns 0 for success, or an
572  * error code if there was one already (EEXIST) or we ran out of memory
573  * (ENOMEM).  On success, this will preemptively lock the page, and will also
574  * store a reference to the page in the pm. */
575 int pm_insert_page(struct page_map *pm, unsigned long index, struct page *page)
576 {
577         int error = 0;
578         spin_lock(&pm->pm_tree_lock);
579         error = radix_insert(&pm->pm_tree, index, page);
580         if (!error) {
581                 page_incref(page);
582                 page->pg_flags |= PG_LOCKED;
583                 page->pg_mapping = pm;
584                 page->pg_index = index;
585                 pm->pm_num_pages++;
586         }
587         spin_unlock(&pm->pm_tree_lock);
588         return error;
589 }
590
591 /* Removes the page, including its reference.  Not sure yet what interface we
592  * want to this (pm and index or page), and this has never been used.  There are
593  * also issues with when you want to call this, since a page in the cache may be
594  * mmap'd by someone else. */
595 int pm_remove_page(struct page_map *pm, struct page *page)
596 {
597         void *retval;
598         warn("pm_remove_page() hasn't been thought through or tested.");
599         spin_lock(&pm->pm_tree_lock);
600         retval = radix_delete(&pm->pm_tree, page->pg_index);
601         spin_unlock(&pm->pm_tree_lock);
602         assert(retval == (void*)page);
603         page_decref(page);
604         page->pg_mapping = 0;
605         page->pg_index = 0;
606         pm->pm_num_pages--;
607         return 0;
608 }
609
610 /* Makes sure the index'th page from file is loaded in the page cache and
611  * returns its location via **pp.  Note this will give you a refcnt'd reference.
612  * This may block! TODO: (BLK) */
613 int file_load_page(struct file *file, unsigned long index, struct page **pp)
614 {
615         struct page_map *pm = file->f_mapping;
616         struct page *page;
617         int error;
618         bool page_was_mapped = TRUE;
619
620         page = pm_find_page(pm, index);
621         while (!page) {
622                 /* kpage_alloc, since we want the page to persist after the proc
623                  * dies (can be used by others, until the inode shuts down). */
624                 if (kpage_alloc(&page))
625                         return -ENOMEM;
626                 /* might want to initialize other things, perhaps in page_alloc() */
627                 page->pg_flags = 0;
628                 error = pm_insert_page(pm, index, page);
629                 switch (error) {
630                         case 0:
631                                 page_was_mapped = FALSE;
632                                 break;
633                         case -EEXIST:
634                                 /* the page was mapped already (benign race), just get rid of
635                                  * our page and try again (the only case that uses the while) */
636                                 page_decref(page);
637                                 page = pm_find_page(pm, index);
638                                 break;
639                         default:
640                                 /* something is wrong, bail out! */
641                                 page_decref(page);
642                                 return error;
643                 }
644         }
645         *pp = page;
646         /* if the page was in the map, we need to do some checks, and might have to
647          * read in the page later.  If the page was freshly inserted to the pm by
648          * us, we skip this since we are the one doing the readpage(). */
649         if (page_was_mapped) {
650                 /* is it already here and up to date?  if so, we're done */
651                 if (page->pg_flags & PG_UPTODATE)
652                         return 0;
653                 /* if not, try to lock the page (could BLOCK) */
654                 lock_page(page);
655                 /* we got it, is our page still in the cache?  check the mapping.  if
656                  * not, start over, perhaps with EAGAIN and outside support */
657                 if (!page->pg_mapping)
658                         panic("Page is not in the mapping!  Haven't implemented this!");
659                 /* double check, are we up to date?  if so, we're done */
660                 if (page->pg_flags & PG_UPTODATE) {
661                         unlock_page(page);
662                         return 0;
663                 }
664         }
665         /* if we're here, the page is locked by us, and it needs to be read in */
666         assert(page->pg_mapping == pm);
667         error = pm->pm_op->readpage(file, page);
668         assert(!error);
669         /* Try to sleep on the IO.  The page will be unlocked when the IO is done */
670         lock_page(page);
671         unlock_page(page);
672         assert(page->pg_flags & PG_UPTODATE);
673         return 0;
674 }
675
676 /* Process-related File management functions */
677
678 /* Given any FD, get the appropriate file, 0 o/w */
679 struct file *get_file_from_fd(struct files_struct *open_files, int file_desc)
680 {
681         struct file *retval = 0;
682         spin_lock(&open_files->lock);
683         if (file_desc < open_files->max_fdset) {
684                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
685                         /* while max_files and max_fdset might not line up, we should never
686                          * have a valid fdset higher than files */
687                         assert(file_desc < open_files->max_files);
688                         retval = open_files->fd[file_desc];
689                         assert(retval);
690                         atomic_inc(&retval->f_refcnt);
691                 }
692         }
693         spin_unlock(&open_files->lock);
694         return retval;
695 }
696
697 /* Remove FD from the open files, if it was there, and return f.  Currently,
698  * this decref's f, so the return value is not consumable or even usable.  This
699  * hasn't been thought through yet. */
700 struct file *put_file_from_fd(struct files_struct *open_files, int file_desc)
701 {
702         struct file *f = 0;
703         spin_lock(&open_files->lock);
704         if (file_desc < open_files->max_fdset) {
705                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
706                         /* while max_files and max_fdset might not line up, we should never
707                          * have a valid fdset higher than files */
708                         assert(file_desc < open_files->max_files);
709                         f = open_files->fd[file_desc];
710                         open_files->fd[file_desc] = 0;
711                         /* TODO: (REF) need to make sure we free if we hit 0 (might do this
712                          * in the caller */
713                         if (f)
714                                 atomic_dec(&f->f_refcnt);
715                         // if 0, drop, decref from higher, sync, whatever
716                 }
717         }
718         spin_unlock(&open_files->lock);
719         return f;
720 }
721
722 /* Inserts the file in the files_struct, returning the corresponding new file
723  * descriptor, or an error code.  We currently grab the first open FD. */
724 int insert_file(struct files_struct *open_files, struct file *file)
725 {
726         int slot = -1;
727         spin_lock(&open_files->lock);
728         for (int i = 0; i < open_files->max_fdset; i++) {
729                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, i))
730                         continue;
731                 slot = i;
732                 SET_BITMASK_BIT(open_files->open_fds->fds_bits, slot);
733                 assert(slot < open_files->max_files && open_files->fd[slot] == 0);
734                 open_files->fd[slot] = file;
735                 atomic_inc(&file->f_refcnt);
736                 if (slot >= open_files->next_fd)
737                         open_files->next_fd = slot + 1;
738                 break;
739         }
740         if (slot == -1) /* should expand the FD array and fd_set */
741                 warn("Ran out of file descriptors, deal with me!");
742         spin_unlock(&open_files->lock);
743         return slot;
744 }