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