File opening revisited
[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         /* this first ref is stored in the NS tailq below */
43         kref_init(&vmnt->mnt_kref, fake_release, 1);
44         /* Build the vfsmount, if there is no mnt_pt, mnt is the root vfsmount (for now).
45          * fields related to the actual FS, like the sb and the mnt_root are set in
46          * the fs-specific get_sb() call. */
47         if (!mnt_pt) {
48                 vmnt->mnt_parent = NULL;
49                 vmnt->mnt_mountpoint = NULL;
50         } else { /* common case, but won't be tested til we try to mount another FS */
51                 mnt_pt->d_mount_point = TRUE;
52                 mnt_pt->d_mounted_fs = vmnt;
53                 kref_get(&vmnt->mnt_kref, 1); /* held by mnt_pt */
54                 vmnt->mnt_parent = mnt_pt->d_sb->s_mount;
55                 vmnt->mnt_mountpoint = mnt_pt;
56         }
57         TAILQ_INIT(&vmnt->mnt_child_mounts);
58         vmnt->mnt_flags = flags;
59         vmnt->mnt_devname = dev_name;
60         vmnt->mnt_namespace = ns;
61         kref_get(&ns->kref, 1); /* held by vmnt */
62
63         /* Read in / create the SB */
64         sb = fs->get_sb(fs, flags, dev_name, vmnt);
65         if (!sb)
66                 panic("You're FS sucks");
67
68         /* TODO: consider moving this into get_sb or something, in case the SB
69          * already exists (mounting again) (if we support that) */
70         spin_lock(&super_blocks_lock);
71         TAILQ_INSERT_TAIL(&super_blocks, sb, s_list); /* storing a ref here... */
72         spin_unlock(&super_blocks_lock);
73
74         /* Update holding NS */
75         spin_lock(&ns->lock);
76         TAILQ_INSERT_TAIL(&ns->vfsmounts, vmnt, mnt_list);
77         spin_unlock(&ns->lock);
78         /* note to self: so, right after this point, the NS points to the root FS
79          * mount (we return the mnt, which gets assigned), the root mnt has a dentry
80          * for /, backed by an inode, with a SB prepped and in memory. */
81         return vmnt;
82 }
83
84 void vfs_init(void)
85 {
86         struct fs_type *fs;
87
88         dentry_kcache = kmem_cache_create("dentry", sizeof(struct dentry),
89                                           __alignof__(struct dentry), 0, 0, 0);
90         inode_kcache = kmem_cache_create("inode", sizeof(struct inode),
91                                          __alignof__(struct inode), 0, 0, 0);
92         file_kcache = kmem_cache_create("file", sizeof(struct file),
93                                         __alignof__(struct file), 0, 0, 0);
94         /* default NS never dies, +1 to exist */
95         kref_init(&default_ns.kref, fake_release, 1);
96         spinlock_init(&default_ns.lock);
97         default_ns.root = NULL;
98         TAILQ_INIT(&default_ns.vfsmounts);
99
100         /* build list of all FS's in the system.  put yours here.  if this is ever
101          * done on the fly, we'll need to lock. */
102         TAILQ_INSERT_TAIL(&file_systems, &kfs_fs_type, list);
103         TAILQ_FOREACH(fs, &file_systems, list)
104                 printk("Supports the %s Filesystem\n", fs->name);
105
106         /* mounting KFS at the root (/), pending root= parameters */
107         // TODO: linux creates a temp root_fs, then mounts the real root onto that
108         default_ns.root = mount_fs(&kfs_fs_type, "RAM", NULL, 0, &default_ns);
109
110         printk("vfs_init() completed\n");
111 }
112
113 /* Builds / populates the qstr of a dentry based on its d_iname.  If there is an
114  * l_name, (long), it will use that instead of the inline name.  This will
115  * probably change a bit. */
116 void qstr_builder(struct dentry *dentry, char *l_name)
117 {
118         dentry->d_name.name = l_name ? l_name : dentry->d_iname;
119         // TODO: pending what we actually do in d_hash
120         //dentry->d_name.hash = dentry->d_op->d_hash(dentry, &dentry->d_name); 
121         dentry->d_name.hash = 0xcafebabe;
122         dentry->d_name.len = strnlen(dentry->d_name.name, MAX_FILENAME_SZ);
123 }
124
125 /* Useful little helper - return the string ptr for a given file */
126 char *file_name(struct file *file)
127 {
128         return file->f_dentry->d_name.name;
129 }
130
131 /* Some issues with this, coupled closely to fs_lookup.  This assumes that
132  * negative dentries are not returned (might differ from linux) */
133 static struct dentry *do_lookup(struct dentry *parent, char *name)
134 {
135         struct dentry *dentry;
136         /* TODO: look up in the dentry cache first */
137         dentry = get_dentry(parent->d_sb, parent, name);
138         dentry = parent->d_inode->i_op->lookup(parent->d_inode, dentry, 0);
139         /* insert in dentry cache */
140         /* TODO: if the following are done by us, how do we know the i_ino?
141          * also need to handle inodes that are already read in!  For now, we're
142          * going to have the FS handle it in it's lookup() method: 
143          * - get a new inode
144          * - read in the inode
145          * - put in the inode cache */
146         return dentry;
147 }
148
149 /* Walk up one directory, being careful of mountpoints, namespaces, and the top
150  * of the FS */
151 static int climb_up(struct nameidata *nd)
152 {
153         // TODO
154         warn("Climbing up (../) in path lookup not supported yet!");
155         return 0;
156 }
157
158 /* Update ND such that it represents having followed dentry.  IAW the nd
159  * refcnting rules, we need to decref any references that were in there before
160  * they get clobbered. */
161 static int next_link(struct dentry *dentry, struct nameidata *nd)
162 {
163         assert(nd->dentry && nd->mnt);
164         /* update the dentry */
165         kref_get(&dentry->d_kref, 1);
166         kref_put(&nd->dentry->d_kref);
167         nd->dentry = dentry;
168         /* update the mount, if we need to */
169         if (dentry->d_sb->s_mount != nd->mnt) {
170                 kref_get(&dentry->d_sb->s_mount->mnt_kref, 1);
171                 kref_put(&nd->mnt->mnt_kref);
172                 nd->mnt = dentry->d_sb->s_mount;
173         }
174         return 0;
175 }
176
177 static int follow_mount(struct nameidata *nd)
178 {
179         /* Detect mount, follow, etc... (TODO!) */
180         return 0;
181 }
182
183 static int follow_symlink(struct nameidata *nd)
184 {
185         /* Detect symlink, LOOKUP_FOLLOW, follow it, etc... (TODO!) */
186         return 0;
187 }
188
189 /* Resolves the links in a basic path walk.  0 for success, -EWHATEVER
190  * otherwise.  The final lookup is returned via nd. */
191 static int link_path_walk(char *path, struct nameidata *nd)
192 {
193         struct dentry *link_dentry;
194         struct inode *link_inode, *nd_inode;
195         char *next_slash;
196         char *link = path;
197         int error;
198
199         /* skip all leading /'s */
200         while (*link == '/')
201                 link++;
202         /* if there's nothing left (null terminated), we're done */
203         if (*link == '\0')
204                 return 0;
205         /* TODO: deal with depth and LOOKUP_FOLLOW, important for symlinks */
206
207         /* iterate through each intermediate link of the path.  in general, nd
208          * tracks where we are in the path, as far as dentries go.  once we have the
209          * next dentry, we try to update nd based on that dentry.  link is the part
210          * of the path string that we are looking up */
211         while (1) {
212                 nd_inode = nd->dentry->d_inode;
213                 if ((error = check_perms(nd_inode, nd->intent)))
214                         return error;
215                 /* find the next link, break out if it is the end */
216                 next_slash = strchr(link, '/');
217                 if (!next_slash)
218                         break;
219                 else
220                         if (*(next_slash + 1) == '\0') {
221                                 /* trailing slash on the path meant the target is a dir */
222                                 nd->flags |= LOOKUP_DIRECTORY;
223                                 *next_slash = '\0';
224                                 break;
225                         }
226                 /* skip over any interim ./ */
227                 if (!strncmp("./", link, 2)) {
228                         link = next_slash + 1;
229                         continue;
230                 }
231                 /* Check for "../", walk up */
232                 if (!strncmp("../", link, 3)) {
233                         climb_up(nd);
234                         link = next_slash + 2;
235                         continue;
236                 }
237                 *next_slash = '\0';
238                 link_dentry = do_lookup(nd->dentry, link);
239                 *next_slash = '/';
240                 if (!link_dentry)
241                         return -ENOENT;
242                 /* make link_dentry the current step/answer */
243                 next_link(link_dentry, nd);
244                 kref_put(&link_dentry->d_kref); /* do_lookup gave us a refcnt dentry */
245                 /* we could be on a mountpoint or a symlink - need to follow them */
246                 follow_mount(nd);
247                 follow_symlink(nd);
248                 if (!(nd->dentry->d_inode->i_type & FS_I_DIR))
249                         return -ENOTDIR;
250                 /* move through the path string to the next entry */
251                 link = next_slash + 1;
252         }
253         /* now, we're on the last link of the path */
254         /* if we just want the parent, leave now.  and save the name of the link
255          * (last) and the type (last_type).  Note that using the qstr in this manner
256          * only allows us to use the qstr as long as the path is a valid string. */
257         if (nd->flags & LOOKUP_PARENT) {
258                 /* consider using a slimmer qstr_builder for this */
259                 nd->last.name = link;
260                 nd->last.len = strlen(link);
261                 nd->last.hash = nd->dentry->d_op->d_hash(nd->dentry, &nd->last);
262                 return 0;
263         }
264         /* deal with some weird cases with . and .. (completely untested) */
265         if (!strcmp(".", link))
266                 return 0;
267         if (!strcmp("..", link))
268                 return climb_up(nd);
269         link_dentry = do_lookup(nd->dentry, link);
270         if (!link_dentry)
271                 return -ENOENT;
272         next_link(link_dentry, nd);
273         kref_put(&link_dentry->d_kref); /* do_lookup gave us a refcnt dentry */
274         follow_mount(nd);
275         follow_symlink(nd);
276         /* If we wanted a directory, but didn't get one, error out */
277         if ((nd->flags & LOOKUP_DIRECTORY) &&
278            !(nd->dentry->d_inode->i_type & FS_I_DIR))
279                 return -ENOTDIR;
280         return 0;
281 }
282
283 /* Given path, return the inode for the final dentry.  The ND should be
284  * initialized for the first call - specifically, we need the intent. 
285  * LOOKUP_PARENT and friends go in this flags var.
286  *
287  * TODO: this should consider the intent.  Note that creating requires writing
288  * to the last directory.
289  *
290  * Need to be careful too.  While the path has been copied-in to the kernel,
291  * it's still user input.  */
292 int path_lookup(char *path, int flags, struct nameidata *nd)
293 {
294         printd("Path lookup for %s\n", path);
295         /* we allow absolute lookups with no process context */
296         if (path[0] == '/') {                   /* absolute lookup */
297                 if (!current)
298                         nd->dentry = default_ns.root->mnt_root;
299                 else
300                         nd->dentry = current->fs_env.root;      
301         } else {                                                /* relative lookup */
302                 assert(current);
303                 /* Don't need to lock on the fs_env since we're reading one item */
304                 nd->dentry = current->fs_env.pwd;       
305         }
306         nd->mnt = nd->dentry->d_sb->s_mount;
307         /* Whenever references get put in the nd, incref them.  Whenever they are
308          * removed, decref them. */
309         kref_get(&nd->mnt->mnt_kref, 1);
310         kref_get(&nd->dentry->d_kref, 1);
311         nd->flags = flags;
312         nd->depth = 0;                                  /* used in symlink following */
313         return link_path_walk(path, nd);        
314 }
315
316 /* Call this after any use of path_lookup when you are done with its results,
317  * regardless of whether it succeeded or not.  It will free any references */
318 void path_release(struct nameidata *nd)
319 {
320         kref_put(&nd->dentry->d_kref);
321         kref_put(&nd->mnt->mnt_kref);
322 }
323
324 /* Superblock functions */
325
326 /* Helper to alloc and initialize a generic superblock.  This handles all the
327  * VFS related things, like lists.  Each FS will need to handle its own things
328  * in it's *_get_sb(), usually involving reading off the disc. */
329 struct super_block *get_sb(void)
330 {
331         struct super_block *sb = kmalloc(sizeof(struct super_block), 0);
332         sb->s_dirty = FALSE;
333         spinlock_init(&sb->s_lock);
334         kref_init(&sb->s_kref, fake_release, 1); /* for the ref passed out */
335         TAILQ_INIT(&sb->s_inodes);
336         TAILQ_INIT(&sb->s_dirty_i);
337         TAILQ_INIT(&sb->s_io_wb);
338         SLIST_INIT(&sb->s_anon_d);
339         TAILQ_INIT(&sb->s_files);
340         sb->s_fs_info = 0; // can override somewhere else
341         return sb;
342 }
343
344 /* Final stages of initializing a super block, including creating and linking
345  * the root dentry, root inode, vmnt, and sb.  The d_op and root_ino are
346  * FS-specific, but otherwise it's FS-independent, tricky, and not worth having
347  * around multiple times.
348  *
349  * Not the world's best interface, so it's subject to change, esp since we're
350  * passing (now 3) FS-specific things. */
351 void init_sb(struct super_block *sb, struct vfsmount *vmnt,
352              struct dentry_operations *d_op, unsigned long root_ino,
353              void *d_fs_info)
354 {
355         /* Build and init the first dentry / inode.  The dentry ref is stored later
356          * by vfsmount's mnt_root.  The parent is dealt with later. */
357         struct dentry *d_root = get_dentry(sb, 0,  "/");        /* probably right */
358
359         /* a lot of here on down is normally done in lookup() */
360         d_root->d_op = d_op;
361         d_root->d_fs_info = d_fs_info;
362         struct inode *inode = sb->s_op->alloc_inode(sb);
363         if (!inode)
364                 panic("This FS sucks!");
365         d_root->d_inode = inode;                                /* storing the inode's kref here */
366         TAILQ_INSERT_TAIL(&inode->i_dentry, d_root, d_alias);   /* weak ref */
367         inode->i_ino = root_ino;
368         /* TODO: add the inode to the appropriate list (off i_list) */
369         /* TODO: do we need to read in the inode?  can we do this on demand? */
370         /* if this FS is already mounted, we'll need to do something different. */
371         sb->s_op->read_inode(inode);
372         /* Link the dentry and SB to the VFS mount */
373         vmnt->mnt_root = d_root;                                /* ref comes from get_dentry */
374         vmnt->mnt_sb = sb;
375         /* If there is no mount point, there is no parent.  This is true only for
376          * the rootfs. */
377         if (vmnt->mnt_mountpoint) {
378                 kref_get(&vmnt->mnt_mountpoint->d_kref, 1);     /* held by d_root */
379                 d_root->d_parent = vmnt->mnt_mountpoint;        /* dentry of the root */
380         }
381         /* insert the dentry into the dentry cache.  when's the earliest we can?
382          * when's the earliest we should?  what about concurrent accesses to the
383          * same dentry?  should be locking the dentry... */
384         dcache_put(d_root); // TODO: should set a d_flag too
385 }
386
387 /* Dentry Functions */
388
389 /* Helper to alloc and initialize a generic dentry.  The following needs to be
390  * set still: d_op, d_fs_info (opt), d_inode, connect the inode to the dentry
391  * (and up the d_kref again), maybe dcache_put().  The FS related things need to
392  * be done in fs_create and fs_mkdir.
393  *
394  * If the name is longer than the inline name, it will kmalloc a buffer, so
395  * don't worry about the storage for *name after calling this. */
396 struct dentry *get_dentry(struct super_block *sb, struct dentry *parent,
397                           char *name)
398 {
399         assert(name);
400         size_t name_len = strnlen(name, MAX_FILENAME_SZ);       /* not including \0! */
401         struct dentry *dentry = kmem_cache_alloc(dentry_kcache, 0);
402         char *l_name = 0;
403
404         //memset(dentry, 0, sizeof(struct dentry));
405         kref_init(&dentry->d_kref, dentry_release, 1);  /* this ref is returned */
406         spinlock_init(&dentry->d_lock);
407         TAILQ_INIT(&dentry->d_subdirs);
408         dentry->d_time = 0;
409         kref_get(&sb->s_kref, 1);
410         dentry->d_sb = sb;                                      /* storing a ref here... */
411         dentry->d_mount_point = FALSE;
412         dentry->d_mounted_fs = 0;
413         if (parent)                                                     /* no parent for rootfs mount */
414                 kref_get(&parent->d_kref, 1);
415         dentry->d_parent = parent;
416         dentry->d_flags = 0;                            /* related to its dcache state */
417         dentry->d_fs_info = 0;
418         SLIST_INIT(&dentry->d_bucket);
419         if (name_len < DNAME_INLINE_LEN) {
420                 strncpy(dentry->d_iname, name, name_len);
421                 dentry->d_iname[name_len] = '\0';
422                 qstr_builder(dentry, 0);
423         } else {
424                 l_name = kmalloc(name_len + 1, 0);
425                 assert(l_name);
426                 strncpy(l_name, name, name_len);
427                 l_name[name_len] = '\0';
428                 qstr_builder(dentry, l_name);
429         }
430         /* Catch bugs by aggressively zeroing this (o/w we use old stuff) */
431         dentry->d_op = 0;
432         dentry->d_fs_info = 0;
433         dentry->d_inode = 0;
434         return dentry;
435 }
436
437 /* Adds a dentry to the dcache. */
438 void dcache_put(struct dentry *dentry)
439 {
440 #if 0 /* pending a more thorough review of the dcache */
441         /* TODO: should set a d_flag too */
442         spin_lock(&dcache_lock);
443         SLIST_INSERT_HEAD(&dcache, dentry, d_hash);
444         spin_unlock(&dcache_lock);
445 #endif
446 }
447
448 /* Cleans up the dentry (after ref == 0).  We still may want it, and this is
449  * where we should add it to the dentry cache.  (TODO).  For now, we do nothing,
450  * since we don't have a dcache.
451  * 
452  * This has to handle two types of dentries: full ones (ones that had been used)
453  * and ones that had been just for lookups - hence the checks for d_op and
454  * d_inode.
455  *
456  * Note that dentries pin and kref their inodes.  When all the dentries are
457  * gone, we want the inode to be released via kref.  The inode has internal /
458  * weak references to the dentry, which are not refcounted. */
459 void dentry_release(struct kref *kref)
460 {
461         struct dentry *dentry = container_of(kref, struct dentry, d_kref);
462         printd("Freeing dentry %08p: %s\n", dentry, dentry->d_name.name);
463         /* Might not have a d_op, if it was involved in a failed operation */
464         if (dentry->d_op && dentry->d_op->d_release)
465                 dentry->d_op->d_release(dentry);
466         /* TODO: check/test the boundaries on this. */
467         if (dentry->d_name.len > DNAME_INLINE_LEN)
468                 kfree((void*)dentry->d_name.name);
469         kref_put(&dentry->d_sb->s_kref);
470         if (dentry->d_mounted_fs)
471                 kref_put(&dentry->d_mounted_fs->mnt_kref);
472         if (dentry->d_inode) {
473                 TAILQ_REMOVE(&dentry->d_inode->i_dentry, dentry, d_alias);
474                 kref_put(&dentry->d_inode->i_kref);     /* but dentries kref inodes */
475         }
476         kmem_cache_free(dentry_kcache, dentry);
477 }
478
479 /* Inode Functions */
480
481 /* Returns 0 if the given mode is acceptable for the inode, and an appropriate
482  * error code if not.  Needs to be writen, based on some sensible rules, and
483  * will also probably use 'current' */
484 int check_perms(struct inode *inode, int access_mode)
485 {
486         return 0;       /* anything goes! */
487 }
488
489 /* Called after all external refs are gone to clean up the inode.  Once this is
490  * called, all dentries pointing here are already done (one of them triggered
491  * this via kref_put(). */
492 void inode_release(struct kref *kref)
493 {
494         struct inode *inode = container_of(kref, struct inode, i_kref);
495         inode->i_sb->s_op->destroy_inode(inode);
496         kref_put(&inode->i_sb->s_kref);
497         assert(inode->i_mapping == &inode->i_pm);
498         /* TODO: (BDEV) */
499         // kref_put(inode->i_bdev->kref); /* assuming it's a bdev */
500 }
501
502 /* File functions */
503
504 /* Read count bytes from the file into buf, starting at *offset, which is increased
505  * accordingly, returning the number of bytes transfered.  Most filesystems will
506  * use this function for their f_op->read.  Note, this uses the page cache.
507  * Want to try out page remapping later on... */
508 ssize_t generic_file_read(struct file *file, char *buf, size_t count,
509                           off_t *offset)
510 {
511         struct page *page;
512         int error;
513         off_t page_off;
514         unsigned long first_idx, last_idx;
515         size_t copy_amt;
516         char *buf_end;
517
518         /* Consider pushing some error checking higher in the VFS */
519         if (!count)
520                 return 0;
521         if (*offset == file->f_dentry->d_inode->i_size)
522                 return 0; /* EOF */
523         /* Make sure we don't go past the end of the file */
524         if (*offset + count > file->f_dentry->d_inode->i_size) {
525                 count = file->f_dentry->d_inode->i_size - *offset;
526         }
527         page_off = *offset & (PGSIZE - 1);
528         first_idx = *offset >> PGSHIFT;
529         last_idx = (*offset + count) >> PGSHIFT;
530         buf_end = buf + count;
531         /* For each file page, make sure it's in the page cache, then copy it out.
532          * TODO: will probably need to consider concurrently truncated files here.*/
533         for (int i = first_idx; i <= last_idx; i++) {
534                 error = file_load_page(file, i, &page);
535                 assert(!error); /* TODO: handle ENOMEM and friends */
536                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
537                 /* TODO: think about this.  if it's a user buffer, we're relying on
538                  * current to detect whose it is (which should work for async calls).
539                  * Also, need to propagate errors properly...  Probably should do a
540                  * user_mem_check, then free, and also to make a distinction between
541                  * when the kernel wants a read/write (TODO: KFOP) */
542                 if (current) {
543                         memcpy_to_user(current, buf, page2kva(page) + page_off, copy_amt);
544                 } else {
545                         memcpy(buf, page2kva(page) + page_off, copy_amt);
546                 }
547                 buf += copy_amt;
548                 page_off = 0;
549                 page_decref(page);      /* it's still in the cache, we just don't need it */
550         }
551         assert(buf == buf_end);
552         *offset += count;
553         return count;
554 }
555
556 /* Write count bytes from buf to the file, starting at *offset, which is increased
557  * accordingly, returning the number of bytes transfered.  Most filesystems will
558  * use this function for their f_op->write.  Note, this uses the page cache.
559  * Changes don't get flushed to disc til there is an fsync, page cache eviction,
560  * or other means of trying to writeback the pages. */
561 ssize_t generic_file_write(struct file *file, const char *buf, size_t count,
562                            off_t *offset)
563 {
564         struct page *page;
565         int error;
566         off_t page_off;
567         unsigned long first_idx, last_idx;
568         size_t copy_amt;
569         const char *buf_end;
570
571         /* Consider pushing some error checking higher in the VFS */
572         if (!count)
573                 return 0;
574         /* Extend the file.  Should put more checks in here, and maybe do this per
575          * page in the for loop below. */
576         if (*offset + count > file->f_dentry->d_inode->i_size)
577                 file->f_dentry->d_inode->i_size = *offset + count;
578         page_off = *offset & (PGSIZE - 1);
579         first_idx = *offset >> PGSHIFT;
580         last_idx = (*offset + count) >> PGSHIFT;
581         buf_end = buf + count;
582         /* For each file page, make sure it's in the page cache, then write it.*/
583         for (int i = first_idx; i <= last_idx; i++) {
584                 error = file_load_page(file, i, &page);
585                 assert(!error); /* TODO: handle ENOMEM and friends */
586                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
587                 /* TODO: think about this.  if it's a user buffer, we're relying on
588                  * current to detect whose it is (which should work for async calls). */
589                 if (current) {
590                         memcpy_to_user(current, page2kva(page) + page_off, buf, copy_amt);
591                 } else {
592                         memcpy(page2kva(page) + page_off, buf, copy_amt);
593                 }
594                 buf += copy_amt;
595                 page_off = 0;
596                 page_decref(page);      /* it's still in the cache, we just don't need it */
597         }
598         assert(buf == buf_end);
599         *offset += count;
600         return count;
601 }
602
603 /* Opens the file, using permissions from current for lack of a better option.
604  * It will attempt to create the file if it does not exist and O_CREAT is
605  * specified.  This will return 0 on failure, and set errno.
606  * TODO: There's a lot of stuff that we don't do, esp related to permission
607  * checking and file truncating.  Create should set errno and propagate it up.*/
608 struct file *do_file_open(char *path, int flags, int mode)
609 {
610         struct file *file = 0;
611         struct dentry *file_d;
612         struct inode *parent_i;
613         struct nameidata nd_r = {0}, *nd = &nd_r;
614         int lookup_flags = LOOKUP_PARENT;
615         int error = 0;
616
617         /* lookup the parent */
618         nd->intent = flags & (O_RDONLY|O_WRONLY|O_RDWR);
619         if (flags & O_CREAT)
620                 lookup_flags |= LOOKUP_CREATE;
621         error = path_lookup(path, lookup_flags, nd);
622         if (error) {
623                 set_errno(current_tf, -error);
624                 return 0;
625         }
626         /* see if the target is there, handle accordingly */
627         file_d = do_lookup(nd->dentry, nd->last.name); 
628         if (!file_d) {
629                 if (!(flags & O_CREAT)) {
630                         path_release(nd);
631                         set_errno(current_tf, ENOENT);
632                         return 0;
633                 }
634                 /* Create the inode/file.  get a fresh dentry too: */
635                 file_d = get_dentry(nd->dentry->d_sb, nd->dentry, nd->last.name);
636                 parent_i = nd->dentry->d_inode;
637                 /* TODO: mode should be & ~umask.  Note that mode only applies to future
638                  * opens. */
639                 if (parent_i->i_op->create(parent_i, file_d, mode, nd)) {
640                         kref_put(&file_d->d_kref);
641                         path_release(nd);
642                         set_errno(current_tf, EFAULT);
643                         return 0;
644                 }
645                 /* when we have notions of users, do something here: */
646                 file_d->d_inode->i_uid = 0;
647                 file_d->d_inode->i_gid = 0;
648                 file_d->d_inode->i_flags = flags & ~(O_CREAT|O_TRUNC|O_EXCL|O_NOCTTY);
649                 dcache_put(file_d);
650         } else {        /* the file exists */
651                 if ((flags & O_CREAT) && (flags & O_EXCL)) {
652                         /* wanted to create, not open, bail out */
653                         kref_put(&file_d->d_kref);
654                         path_release(nd);
655                         set_errno(current_tf, EACCES);
656                         return 0;
657                 }
658         }
659         /* now open the file (freshly created or if it already existed).  At this
660          * point, file_d is a refcnt'd dentry, regardless of which branch we took.*/
661         if (flags & O_TRUNC)
662                 warn("File truncation not supported yet.");
663         file = dentry_open(file_d);             /* sets errno */
664         if (!file) {
665                 kref_put(&file_d->d_kref);
666                 path_release(nd);
667                 return 0;
668         }
669         /* TODO: check the inode's mode (S_XXX) against the flags O_RDWR */
670         /* f_mode stores how the FILE is open, regardless of the mode */
671         file->f_mode = flags & (O_RDONLY|O_WRONLY|O_RDWR);
672         kref_put(&file_d->d_kref);
673         path_release(nd);
674         return file;
675 }
676
677 /* Opens and returns the file specified by dentry */
678 struct file *dentry_open(struct dentry *dentry)
679 {
680         struct inode *inode;
681         struct file *file = kmem_cache_alloc(file_kcache, 0);
682         if (!file) {
683                 set_errno(current_tf, ENOMEM);
684                 return 0;
685         }
686         inode = dentry->d_inode;
687         /* one for the ref passed out, and *none* for the sb TAILQ */
688         kref_init(&file->f_kref, file_release, 1);
689         /* Add to the list of all files of this SB */
690         TAILQ_INSERT_TAIL(&inode->i_sb->s_files, file, f_list);
691         kref_get(&dentry->d_kref, 1);
692         file->f_dentry = dentry;
693         kref_get(&inode->i_sb->s_mount->mnt_kref, 1);
694         file->f_vfsmnt = inode->i_sb->s_mount;          /* saving a ref to the vmnt...*/
695         file->f_op = inode->i_fop;
696         file->f_flags = inode->i_flags;                         /* just taking the inode vals */
697         file->f_mode = inode->i_mode;
698         file->f_pos = 0;
699         file->f_uid = inode->i_uid;
700         file->f_gid = inode->i_gid;
701         file->f_error = 0;
702 //      struct event_poll_tailq         f_ep_links;
703         spinlock_init(&file->f_ep_lock);
704         file->f_fs_info = 0;                                            /* prob overriden by the fs */
705         file->f_mapping = inode->i_mapping;
706         file->f_op->open(inode, file);
707         return file;
708 }
709
710 /* Closes a file, fsync, whatever else is necessary.  Called when the kref hits
711  * 0.  Note that the file is not refcounted on the s_files list, nor is the
712  * f_mapping refcounted (it is pinned by the i_mapping). */
713 void file_release(struct kref *kref)
714 {
715         struct file *file = container_of(kref, struct file, f_kref);
716
717         struct super_block *sb = file->f_dentry->d_sb;
718         spin_lock(&sb->s_lock);
719         TAILQ_REMOVE(&sb->s_files, file, f_list);
720         spin_unlock(&sb->s_lock);
721
722         /* TODO: fsync (BLK).  also, we may want to parallelize the blocking that
723          * could happen in here (spawn kernel threads)... */
724         file->f_op->release(file->f_dentry->d_inode, file);
725         /* Clean up the other refs we hold */
726         kref_put(&file->f_dentry->d_kref);
727         kref_put(&file->f_vfsmnt->mnt_kref);
728         kmem_cache_free(file_kcache, file);
729 }
730
731 /* Page cache functions */
732
733 /* Looks up the index'th page in the page map, returning an incref'd reference,
734  * or 0 if it was not in the map. */
735 struct page *pm_find_page(struct page_map *pm, unsigned long index)
736 {
737         spin_lock(&pm->pm_tree_lock);
738         struct page *page = (struct page*)radix_lookup(&pm->pm_tree, index);
739         if (page)
740                 page_incref(page);
741         spin_unlock(&pm->pm_tree_lock);
742         return page;
743 }
744
745 /* Attempts to insert the page into the page_map, returns 0 for success, or an
746  * error code if there was one already (EEXIST) or we ran out of memory
747  * (ENOMEM).  On success, this will preemptively lock the page, and will also
748  * store a reference to the page in the pm. */
749 int pm_insert_page(struct page_map *pm, unsigned long index, struct page *page)
750 {
751         int error = 0;
752         spin_lock(&pm->pm_tree_lock);
753         error = radix_insert(&pm->pm_tree, index, page);
754         if (!error) {
755                 page_incref(page);
756                 page->pg_flags |= PG_LOCKED;
757                 page->pg_mapping = pm;
758                 page->pg_index = index;
759                 pm->pm_num_pages++;
760         }
761         spin_unlock(&pm->pm_tree_lock);
762         return error;
763 }
764
765 /* Removes the page, including its reference.  Not sure yet what interface we
766  * want to this (pm and index or page), and this has never been used.  There are
767  * also issues with when you want to call this, since a page in the cache may be
768  * mmap'd by someone else. */
769 int pm_remove_page(struct page_map *pm, struct page *page)
770 {
771         void *retval;
772         warn("pm_remove_page() hasn't been thought through or tested.");
773         spin_lock(&pm->pm_tree_lock);
774         retval = radix_delete(&pm->pm_tree, page->pg_index);
775         spin_unlock(&pm->pm_tree_lock);
776         assert(retval == (void*)page);
777         page_decref(page);
778         page->pg_mapping = 0;
779         page->pg_index = 0;
780         pm->pm_num_pages--;
781         return 0;
782 }
783
784 /* Makes sure the index'th page from file is loaded in the page cache and
785  * returns its location via **pp.  Note this will give you a refcnt'd reference.
786  * This may block! TODO: (BLK) */
787 int file_load_page(struct file *file, unsigned long index, struct page **pp)
788 {
789         struct page_map *pm = file->f_mapping;
790         struct page *page;
791         int error;
792         bool page_was_mapped = TRUE;
793
794         page = pm_find_page(pm, index);
795         while (!page) {
796                 /* kpage_alloc, since we want the page to persist after the proc
797                  * dies (can be used by others, until the inode shuts down). */
798                 if (kpage_alloc(&page))
799                         return -ENOMEM;
800                 /* might want to initialize other things, perhaps in page_alloc() */
801                 page->pg_flags = 0;
802                 error = pm_insert_page(pm, index, page);
803                 switch (error) {
804                         case 0:
805                                 page_was_mapped = FALSE;
806                                 break;
807                         case -EEXIST:
808                                 /* the page was mapped already (benign race), just get rid of
809                                  * our page and try again (the only case that uses the while) */
810                                 page_decref(page);
811                                 page = pm_find_page(pm, index);
812                                 break;
813                         default:
814                                 /* something is wrong, bail out! */
815                                 page_decref(page);
816                                 return error;
817                 }
818         }
819         *pp = page;
820         /* if the page was in the map, we need to do some checks, and might have to
821          * read in the page later.  If the page was freshly inserted to the pm by
822          * us, we skip this since we are the one doing the readpage(). */
823         if (page_was_mapped) {
824                 /* is it already here and up to date?  if so, we're done */
825                 if (page->pg_flags & PG_UPTODATE)
826                         return 0;
827                 /* if not, try to lock the page (could BLOCK) */
828                 lock_page(page);
829                 /* we got it, is our page still in the cache?  check the mapping.  if
830                  * not, start over, perhaps with EAGAIN and outside support */
831                 if (!page->pg_mapping)
832                         panic("Page is not in the mapping!  Haven't implemented this!");
833                 /* double check, are we up to date?  if so, we're done */
834                 if (page->pg_flags & PG_UPTODATE) {
835                         unlock_page(page);
836                         return 0;
837                 }
838         }
839         /* if we're here, the page is locked by us, and it needs to be read in */
840         assert(page->pg_mapping == pm);
841         error = pm->pm_op->readpage(file, page);
842         assert(!error);
843         /* Try to sleep on the IO.  The page will be unlocked when the IO is done */
844         lock_page(page);
845         unlock_page(page);
846         assert(page->pg_flags & PG_UPTODATE);
847         return 0;
848 }
849
850 /* Process-related File management functions */
851
852 /* Given any FD, get the appropriate file, 0 o/w */
853 struct file *get_file_from_fd(struct files_struct *open_files, int file_desc)
854 {
855         struct file *retval = 0;
856         spin_lock(&open_files->lock);
857         if (file_desc < open_files->max_fdset) {
858                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
859                         /* while max_files and max_fdset might not line up, we should never
860                          * have a valid fdset higher than files */
861                         assert(file_desc < open_files->max_files);
862                         retval = open_files->fd[file_desc];
863                         assert(retval);
864                         kref_get(&retval->f_kref, 1);
865                 }
866         }
867         spin_unlock(&open_files->lock);
868         return retval;
869 }
870
871 /* Remove FD from the open files, if it was there, and return f.  Currently,
872  * this decref's f, so the return value is not consumable or even usable.  This
873  * hasn't been thought through yet. */
874 struct file *put_file_from_fd(struct files_struct *open_files, int file_desc)
875 {
876         struct file *file = 0;
877         spin_lock(&open_files->lock);
878         if (file_desc < open_files->max_fdset) {
879                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
880                         /* while max_files and max_fdset might not line up, we should never
881                          * have a valid fdset higher than files */
882                         assert(file_desc < open_files->max_files);
883                         file = open_files->fd[file_desc];
884                         open_files->fd[file_desc] = 0;
885                         CLR_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc);
886                         /* the if case is due to files (stdin) without a *file yet */
887                         if (file)
888                                 kref_put(&file->f_kref);
889                 }
890         }
891         spin_unlock(&open_files->lock);
892         return file;
893 }
894
895 /* Inserts the file in the files_struct, returning the corresponding new file
896  * descriptor, or an error code.  We currently grab the first open FD. */
897 int insert_file(struct files_struct *open_files, struct file *file)
898 {
899         int slot = -1;
900         spin_lock(&open_files->lock);
901         for (int i = 0; i < open_files->max_fdset; i++) {
902                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, i))
903                         continue;
904                 slot = i;
905                 SET_BITMASK_BIT(open_files->open_fds->fds_bits, slot);
906                 assert(slot < open_files->max_files && open_files->fd[slot] == 0);
907                 kref_get(&file->f_kref, 1);
908                 open_files->fd[slot] = file;
909                 if (slot >= open_files->next_fd)
910                         open_files->next_fd = slot + 1;
911                 break;
912         }
913         if (slot == -1) /* should expand the FD array and fd_set */
914                 warn("Ran out of file descriptors, deal with me!");
915         spin_unlock(&open_files->lock);
916         return slot;
917 }
918
919 /* Closes all open files.  Mostly just a "put" for all files. */
920 void close_all_files(struct files_struct *open_files)
921 {
922         struct file *file;
923         spin_lock(&open_files->lock);
924         for (int i = 0; i < open_files->max_fdset; i++) {
925                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, i)) {
926                         /* while max_files and max_fdset might not line up, we should never
927                          * have a valid fdset higher than files */
928                         assert(i < open_files->max_files);
929                         file = open_files->fd[i];
930                         open_files->fd[i] = 0;
931                         /* the if case is due to files (stdin) without a *file yet */
932                         if (file)
933                                 kref_put(&file->f_kref);
934                         CLR_BITMASK_BIT(open_files->open_fds->fds_bits, i);
935                 }
936         }
937         spin_unlock(&open_files->lock);
938 }