Page cache for memory mapped files
[akaros.git] / kern / src / kfs.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  * Implementation of the KFS file system.  It is a RAM based, read-only FS
6  * consisting of files that are added to the kernel binary image.  Might turn
7  * this into a read/write FS with directories someday. */
8
9 #ifdef __SHARC__
10 #pragma nosharc
11 #endif
12
13 #ifdef __DEPUTY__
14 #pragma nodeputy
15 #endif
16
17 #include <vfs.h>
18 #include <kfs.h>
19 #include <slab.h>
20 #include <kmalloc.h>
21 #include <string.h>
22 #include <stdio.h>
23 #include <assert.h>
24 #include <error.h>
25 #include <cpio.h>
26 #include <pmap.h>
27
28 #define KFS_MAX_FILE_SIZE 1024*1024*128
29 #define KFS_MAGIC 0xdead0001
30
31 /* VFS required Functions */
32 /* These structs are declared again and initialized farther down */
33 struct page_map_operations kfs_pm_op;
34 struct super_operations kfs_s_op;
35 struct inode_operations kfs_i_op;
36 struct dentry_operations kfs_d_op;
37 struct file_operations kfs_f_op;
38
39 /* TODO: something more better.  Prob something like the vmem cache, for this,
40  * pids, etc.  Good enough for now.  This also means we can only have one
41  * KFS instance, and we also aren't synchronizing access. */
42 static unsigned long kfs_get_free_ino(void)
43 {
44         static unsigned long last_ino = 1;       /* 1 is reserved for the root */
45         last_ino++;
46         if (!last_ino)
47                 panic("Out of inos in KFS!");
48         return last_ino;
49 }
50
51 /* Slabs for KFS specific info chunks */
52 struct kmem_cache *kfs_i_kcache;
53
54 static void kfs_init(void)
55 {
56         kfs_i_kcache = kmem_cache_create("kfs_ino_info", sizeof(struct kfs_i_info),
57                                          __alignof__(struct kfs_i_info), 0, 0, 0);
58 }
59
60 /* Creates the SB (normally would read in from disc and create).  Ups the refcnt
61  * for whoever consumes this.  Returns 0 on failure.
62  * TODO: consider pulling out more of the FS-independent stuff, if possible.
63  * There are only two things, but the pain in the ass is that you'd need to read
64  * the disc to get that first inode, and it's a FS-specific thing. */
65 struct super_block *kfs_get_sb(struct fs_type *fs, int flags,
66                                char *dev_name, struct vfsmount *vmnt)
67 {
68         /* Ought to check that dev_name has our FS on it.  in this case, it's
69          * irrelevant. */
70         //if (something_bad)
71         //      return 0;
72         static bool ran_once = FALSE;
73         if (!ran_once) {
74                 ran_once = TRUE;
75                 kfs_init();
76         }
77
78         /* Build and init the SB.  No need to read off disc. */
79         struct super_block *sb = get_sb();
80         sb->s_dev = 0;
81         sb->s_blocksize = 1;
82         sb->s_maxbytes = KFS_MAX_FILE_SIZE;
83         sb->s_type = &kfs_fs_type;
84         sb->s_op = &kfs_s_op;
85         sb->s_flags = flags;
86         sb->s_magic = KFS_MAGIC;
87         sb->s_mount = vmnt;
88         sb->s_syncing = FALSE;
89         sb->s_bdev = 0;
90         strlcpy(sb->s_name, "KFS", 32);
91         /* store the location of the CPIO archive.  make this more generic later. */
92         extern uint8_t _binary_obj_kern_initramfs_cpio_size[];
93         extern uint8_t _binary_obj_kern_initramfs_cpio_start[];
94         sb->s_fs_info = (void*)_binary_obj_kern_initramfs_cpio_start;
95
96         /* Final stages of initializing the sb, mostly FS-independent */
97         /* 1 is the KFS root ino (inode number) */
98         init_sb(sb, vmnt, &kfs_d_op, 1, 0);
99         /* Parses the CPIO entries and builds the in-memory KFS tree. */
100         parse_cpio_entries(sb, sb->s_fs_info);
101         printk("KFS superblock loaded\n");
102         return sb;
103 }
104
105 void kfs_kill_sb(struct super_block *sb)
106 {
107         panic("Killing KFS is not supported!");
108 }
109
110 /* Every FS must have a static FS Type, with which the VFS code can bootstrap */
111 struct fs_type kfs_fs_type = {"KFS", 0, kfs_get_sb, kfs_kill_sb, {0, 0},
112                TAILQ_HEAD_INITIALIZER(kfs_fs_type.fs_supers)};
113
114 /* Page Map Operations */
115
116 /* Fills page with its contents from its backing store file.  Note that we do
117  * the zero padding here, instead of higher in the VFS.  Might change in the
118  * future. */
119 int kfs_readpage(struct file *file, struct page *page)
120 {
121         struct kfs_i_info *k_i_info = (struct kfs_i_info*)file->f_inode->i_fs_info;
122         uintptr_t begin = (size_t)k_i_info->filestart + page->pg_index * PGSIZE;
123         /* Need to be careful we don't copy beyond the EOF, and that we zero out
124          * whatever is left over.  The memset is a noop when copy_amt == PGSIZE. */
125         size_t copy_amt = MIN(PGSIZE, file->f_inode->i_size - begin);
126         memcpy(page2kva(page), (void*)begin, copy_amt);
127         memset(page2kva(page) + copy_amt, 0, PGSIZE - copy_amt);
128         /* This is supposed to be done in the IO system when the operation is
129          * complete.  Since we aren't doing a real IO request, and it is already
130          * done, we can do it here. */
131         page->pg_flags |= PG_UPTODATE;
132         unlock_page(page);
133         return 0;
134 }
135
136 /* Super Operations */
137
138 /* creates and initializes a new inode.  generic fields are filled in.  specific
139  * fields are filled in in read_inode() based on what's on the disk for a given
140  * i_no.  i_no is set by the caller. */
141 struct inode *kfs_alloc_inode(struct super_block *sb)
142 {
143         /* arguably, we can avoid some of this init by using the slab/cache */
144         struct inode *inode = kmem_cache_alloc(inode_kcache, 0);
145         memset(inode, 0, sizeof(struct inode));
146         TAILQ_INSERT_HEAD(&sb->s_inodes, inode, i_sb_list);
147         TAILQ_INIT(&inode->i_dentry);
148         inode->i_ino = 0;                                       /* set by caller later */
149         atomic_set(&inode->i_refcnt, 1);
150         inode->i_blksize = 1;                           /* keep in sync with get_sb() */
151         spinlock_init(&inode->i_lock);
152         inode->i_op = &kfs_i_op;
153         inode->i_fop = &kfs_f_op;
154         inode->i_sb = sb;
155         inode->i_state = 0;                                     /* need real states, want I_NEW */
156         inode->dirtied_when = 0;
157         atomic_set(&inode->i_writecount, 0);
158         inode->i_fs_info = kmem_cache_alloc(kfs_i_kcache, 0);
159         TAILQ_INIT(&((struct kfs_i_info*)inode->i_fs_info)->children);
160         ((struct kfs_i_info*)inode->i_fs_info)->filestart = 0;
161         /* Set up the page_map structures.  Default is to use the embedded one. */
162         inode->i_mapping = &inode->i_pm;
163         inode->i_mapping->pm_host = inode;
164         radix_tree_init(&inode->i_mapping->pm_tree);
165         spinlock_init(&inode->i_mapping->pm_tree_lock);
166         inode->i_mapping->pm_op = &kfs_pm_op;
167         inode->i_mapping->pm_flags = 0;
168         return inode;
169         /* caller sets i_ino, i_list set when applicable */
170 }
171
172 /* deallocs and cleans up after an inode. */
173 void kfs_destroy_inode(struct inode *inode)
174 {
175         kmem_cache_free(kfs_i_kcache, inode->i_fs_info);
176         kmem_cache_free(inode_kcache, inode);
177 }
178
179 /* reads the inode data on disk specified by inode->i_ino into the inode.
180  * basically, it's a "make this inode the one for i_ino (i number)" */
181 void kfs_read_inode(struct inode *inode)
182 {
183         /* need to do something to link this inode/file to the actual "blocks" on
184          * "disk". */
185
186         /* TODO: what does it mean to ask for an inode->i_ino that doesn't exist?
187          *      possibly a bug, since these inos come from directories */
188         if (inode->i_ino == 1) {
189                 inode->i_mode = 0x777;                  /* TODO: use something appropriate */
190                 inode->i_nlink = 1;                             /* assuming only one hardlink */
191                 inode->i_uid = 0;
192                 inode->i_gid = 0;
193                 inode->i_rdev = 0;
194                 inode->i_size = 0;                              /* make sense for KFS? */
195                 inode->i_atime.tv_sec = 0;
196                 inode->i_atime.tv_nsec = 0;
197                 inode->i_mtime.tv_sec = 0;
198                 inode->i_mtime.tv_nsec = 0;
199                 inode->i_ctime.tv_sec = 0;
200                 inode->i_ctime.tv_nsec = 0;
201                 inode->i_blocks = 0;
202                 inode->i_bdev = 0;                              /* assuming blockdev? */
203                 inode->i_flags = FS_I_DIR;
204                 inode->i_socket = FALSE;
205         } else {
206                 panic("Not implemented");
207         }
208         /* TODO: unused: inode->i_hash add to hash (saves on disc reading) */
209 }
210
211 /* called when an inode in memory is modified (journalling FS's care) */
212 void kfs_dirty_inode(struct inode *inode)
213 {       // KFS doesn't care
214 }
215
216 /* write the inode to disk (specifically, to inode inode->i_ino), synchronously
217  * if we're asked to wait */
218 void kfs_write_inode(struct inode *inode, bool wait)
219 {       // KFS doesn't care
220 }
221
222 /* called when an inode is decref'd, to do any FS specific work */
223 void kfs_put_inode(struct inode *inode)
224 {       // KFS doesn't care
225 }
226
227 /* called when an inode is about to be destroyed.  the generic version ought to
228  * remove every reference to the inode from the VFS, and if the inode isn't in
229  * any directory, calls delete_inode */
230 void kfs_drop_inode(struct inode *inode)
231 { // TODO: should call a generic one instead.  or at least do something...
232         // remove from lists
233 }
234
235 /* delete the inode from disk (all data) and deallocs the in memory inode */
236 void kfs_delete_inode(struct inode *inode)
237 {
238         // would remove from "disk" here
239         kfs_destroy_inode(inode);
240 }
241
242 /* unmount and release the super block */
243 void kfs_put_super(struct super_block *sb)
244 {
245         panic("Shazbot! KFS can't be unmounted yet!");
246 }
247
248 /* updates the on-disk SB with the in-memory SB */
249 void kfs_write_super(struct super_block *sb)
250 {       // KFS doesn't care
251 }
252
253 /* syncs FS metadata with the disc, synchronously if we're waiting.  this info
254  * also includes anything pointed to by s_fs_info. */
255 int kfs_sync_fs(struct super_block *sb, bool wait)
256 {
257         return 0;
258 }
259
260 /* remount the FS with the new flags */
261 int kfs_remount_fs(struct super_block *sb, int flags, char *data)
262 {
263         warn("KFS will not remount.");
264         return -1; // can't remount
265 }
266
267 /* interrupts a mount operation - used by NFS and friends */
268 void kfs_umount_begin(struct super_block *sb)
269 {
270         panic("Cannot abort a KFS mount, and why would you?");
271 }
272
273 /* inode_operations */
274
275 /* Helper op, used when creating regular files (kfs_create()) and when making
276  * directories (kfs_mkdir()).  References are a bit ugly.  We're passing out a
277  * ref that is already stored/accounted for.  Might change that...  Also, this
278  * needs to handle having nd == 0. */
279 struct inode *kfs_create_generic(struct inode *dir, struct dentry *dentry,
280                                  int mode, struct nameidata *nd)
281 {
282         /* note it is the i_ino that uniquely identifies a file in the system.
283          * there's a diff between creating an inode (even for an in-use ino) and
284          * then filling it in, and vs creating a brand new one */
285         struct inode *inode = kfs_alloc_inode(dentry->d_sb);
286         dentry->d_inode = inode;                /* inode ref stored here */
287         TAILQ_INSERT_TAIL(&inode->i_dentry, dentry, d_alias); /* stored dentry ref*/
288         inode->i_mode = mode;
289         inode->i_ino = kfs_get_free_ino();
290         inode->i_nlink = 1;
291         inode->i_atime.tv_sec = 0;              /* TODO: now! */
292         inode->i_ctime.tv_sec = 0;              /* TODO: now! */
293         inode->i_mtime.tv_sec = 0;              /* TODO: now! */
294         inode->i_atime.tv_nsec = 0;             /* are these supposed to be the extra ns? */
295         inode->i_ctime.tv_nsec = 0;
296         inode->i_mtime.tv_nsec = 0;
297         return inode;
298 }
299
300 /* Create a new disk inode in dir associated with dentry, with the given mode.
301  * called when creating a regular file.  dir is the directory/parent.  dentry is
302  * the dentry of the inode we are creating. */
303 int kfs_create(struct inode *dir, struct dentry *dentry, int mode,
304                struct nameidata *nd)
305 {
306         struct inode *inode = kfs_create_generic(dir, dentry, mode, nd);        
307         if (!inode)
308                 return -1;
309         inode->i_flags = FS_I_FILE;
310         /* our parent dentry's inode tracks our dentry info.  We do this
311          * since it's all in memory and we aren't using the dcache yet.
312          * We're reusing the subdirs link, which is used by the VFS when
313          * we're a directory.  But since we're a file, it's okay to reuse
314          * it. */
315         TAILQ_INSERT_TAIL(&((struct kfs_i_info*)dir->i_fs_info)->children,
316                           dentry, d_subdirs_link);
317         /* fs_info->filestart is set by the caller, or else when first written (for
318          * new files.  it was set to 0 in alloc_inode(). */
319         return 0;
320 }
321
322 /* Searches the directory for the filename in the dentry, filling in the dentry
323  * with the FS specific info of this file.  If it succeeds, it will pass back
324  * the *dentry you should use.  If this fails, it will return 0 and will take
325  * the ref to the dentry for you.  Either way, you shouldn't use the ref you
326  * passed in anymore.
327  *
328  * Callers, make sure you alloc and fill out the name parts of the dentry, and
329  * an initialized nameidata.
330  *
331  * Doesn't yet handle symlinks, . or .., so don't fuck it up.  It might not need
332  * to handle the . or .., which could be handled by the VFS.  Some of the other
333  * ugliness is because KFS is exclusively using dentries to track subdirs,
334  * instead of putting it all in the inode/dir file.
335  *
336  * Because of the way KFS currently works, if there is ever a dentry, it's
337  * already in memory, along with its inode (all path's pinned).  So we just find
338  * it and return it, freeing the one that came in. */
339 struct dentry *kfs_lookup(struct inode *dir, struct dentry *dentry,
340                           struct nameidata *nd)
341 {
342         struct kfs_i_info *k_i_info = (struct kfs_i_info*)dir->i_fs_info;
343         struct dentry *dir_dent = TAILQ_FIRST(&dir->i_dentry);
344         struct dentry *d_i;
345
346         assert(dir_dent && dir_dent == TAILQ_LAST(&dir->i_dentry, dentry_tailq));
347         assert(dir->i_flags & FS_I_DIR);
348
349         TAILQ_FOREACH(d_i, &dir_dent->d_subdirs, d_subdirs_link) {
350                 if (!strcmp(d_i->d_name.name, dentry->d_name.name)) {
351                         /* since this dentry is already in memory (that's how KFS works), we
352                          * can free the one that came in and return the real one */
353                         kmem_cache_free(dentry_kcache, dentry);
354                         return d_i;
355                 }
356         }
357         TAILQ_FOREACH(d_i, &k_i_info->children, d_subdirs_link) {
358                 if (!strcmp(d_i->d_name.name, dentry->d_name.name)) {
359                         /* since this dentry is already in memory (that's how KFS works), we
360                          * can free the one that came in and return the real one */
361                         kmem_cache_free(dentry_kcache, dentry);
362                         return d_i;
363                 }
364         }
365         /* no match, consider caching the negative result, freeing the
366          * dentry, etc */
367         printk("Not Found %s!!\n", dentry->d_name.name);
368         /* TODO: Cache, negatively... */
369         //dcache_put(dentry);                   /* TODO: should set a d_flag too */
370         return 0;
371 }
372
373 /* Hard link to old_dentry in directory dir with a name specified by new_dentry.
374  * TODO: should this also make the dentry linkage, or just discard everything?*/
375 int kfs_link(struct dentry *old_dentry, struct inode *dir,
376              struct dentry *new_dentry)
377 {
378         return -1;
379 }
380
381 /* Removes the link from the dentry in the directory */
382 int kfs_unlink(struct inode *dir, struct dentry *dentry)
383 {
384         return -1;
385 }
386
387 /* Creates a new inode for a symlink named symname in dir, and links to dentry.
388  * */
389 int kfs_symlink(struct inode *dir, struct dentry *dentry, const char *symname)
390 {
391         return -1;
392 }
393
394 /* Creates a new inode for a directory associated with dentry in dir with the
395  * given mode.  Note, we might (later) need to track subdirs within the parent
396  * inode, like we do with regular files.  I'd rather not, so we'll see if we
397  * need it. */
398 int kfs_mkdir(struct inode *dir, struct dentry *dentry, int mode)
399 {
400         struct inode *inode = kfs_create_generic(dir, dentry, mode, 0); 
401         if (!inode)
402                 return -1;
403         struct dentry *parent = TAILQ_FIRST(&dir->i_dentry);
404         assert(parent && parent == TAILQ_LAST(&dir->i_dentry, dentry_tailq));
405         inode->i_flags = FS_I_DIR;
406         /* parent dentry tracks dentry as a subdir */
407         TAILQ_INSERT_TAIL(&parent->d_subdirs, dentry, d_subdirs_link);
408         atomic_inc(&dentry->d_refcnt);
409         /* get ready to have our own kids */
410         TAILQ_INIT(&((struct kfs_i_info*)inode->i_fs_info)->children);
411         ((struct kfs_i_info*)inode->i_fs_info)->filestart = 0;
412         return 0;
413 }
414
415 /* Removes from dir the directory specified by the name in dentry. */
416 // TODO: note this isn't necessarily the same dentry, just using it for the
417 // naming (which seems to be a common way of doing things, like in lookup() -
418 // can work either way.
419 int kfs_rmdir(struct inode *dir, struct dentry *dentry)
420 {
421         return -1;
422 }
423
424 /* Used to make a generic file, based on the type and the major/minor numbers
425  * (in rdev), with the given mode.  As with others, this creates a new disk
426  * inode for the file */
427 int kfs_mknod(struct inode *dir, struct dentry *dentry, int mode, dev_t rdev)
428 {
429         return -1;
430 }
431
432 /* Moves old_dentry from old_dir to new_dentry in new_dir */
433 int kfs_rename(struct inode *old_dir, struct dentry *old_dentry,
434                struct inode *new_dir, struct dentry *new_dentry)
435 {
436         return -1;
437 }
438
439 /* Copies to the userspace buffer the file pathname corresponding to the symlink
440  * specified by dentry. */
441 int kfs_readlink(struct dentry *dentry, char *buffer, size_t buflen)
442 {
443         return -1;
444 }
445
446 /* Translates the symlink specified by sym and puts the result in nd. */
447 int kfs_follow_link(struct dentry *sym, struct nameidata *nd)
448 {
449         return -1;
450 }
451
452 /* Cleans up after follow_link (decrefs the nameidata business) */
453 int kfs_put_link(struct dentry *sym, struct nameidata *nd)
454 {
455         return -1;
456 }
457
458 /* Modifies the size of the file of inode to whatever its i_size is set to */
459 void kfs_truncate(struct inode *inode)
460 {
461 }
462
463 /* Checks whether the the access mode is allowed for the file belonging to the
464  * inode.  Implies that the permissions are on the file, and not the hardlink */
465 int kfs_permission(struct inode *inode, int mode, struct nameidata *nd)
466 {
467         return -1;
468 }
469
470
471 /* dentry_operations */
472 /* Determines if the dentry is still valid before using it to translate a path.
473  * Network FS's need to deal with this. */
474 int kfs_d_revalidate(struct dentry *dir, struct nameidata *nd)
475 { // default, nothing
476         return -1;
477 }
478
479 /* Produces the hash to lookup this dentry from the dcache */
480 int kfs_d_hash(struct dentry *dentry, struct qstr *name)
481 {
482         return -1;
483 }
484
485 /* Compares name1 and name2.  name1 should be a member of dir. */
486 int kfs_d_compare(struct dentry *dir, struct qstr *name1, struct qstr *name2)
487 { // default, string comp (case sensitive)
488         return -1;
489 }
490
491 /* Called when the last ref is deleted (refcnt == 0) */
492 int kfs_d_delete(struct dentry *dentry)
493 { // default, nothin
494         return -1;
495 }
496
497 /* Called when it's about to be slab-freed */
498 int kfs_d_release(struct dentry *dentry)
499 {
500         /* TODO: check the boundaries on this. */
501         if (dentry->d_name.len > DNAME_INLINE_LEN)
502                 kfree((void*)dentry->d_name.name);
503         return -1;
504 }
505
506 /* Called when the dentry loses it's inode (becomes "negative") */
507 void kfs_d_iput(struct dentry *dentry, struct inode *inode)
508 { // default, call i_put to release the inode object
509 }
510
511
512 /* file_operations */
513
514 /* Updates the file pointer.  KFS doesn't let you go past the end of a file
515  * yet, so it won't let you seek past either.  TODO: think about locking. */
516 off_t kfs_llseek(struct file *file, off_t offset, int whence)
517 {
518         off_t temp_off = 0;
519         switch (whence) {
520                 case SEEK_SET:
521                         temp_off = offset;
522                         break;
523                 case SEEK_CUR:
524                         temp_off = file->f_pos + offset;
525                         break;
526                 case SEEK_END:
527                         temp_off = file->f_inode->i_size + offset;
528                         break;
529                 default:
530                         warn("Unknown 'whence' in llseek()!\n");
531         }
532         /* make sure the f_pos isn't outside the limits of the existing file */
533         temp_off = MAX(MIN(temp_off, file->f_inode->i_size), 0);
534         file->f_pos = temp_off;
535         return temp_off;
536 }
537
538 /* Read count bytes from the file into buf, starting at *offset, which is increased
539  * accordingly. */
540 ssize_t kfs_read(struct file *file, char *buf, size_t count, off_t *offset)
541 {
542         struct kfs_i_info *k_i_info = (struct kfs_i_info*)file->f_inode->i_fs_info;
543         void *begin, *end;
544
545         /* TODO: handle this higher up in the VFS */
546         if (!count)
547                 return 0;
548         if (*offset == file->f_inode->i_size)
549                 return 0; /* EOF */
550
551         /* Make sure we don't go past the end of the file */
552         if (*offset + count > file->f_inode->i_size) {
553                 count = file->f_inode->i_size - *offset;
554         }
555         begin = k_i_info->filestart + *offset;
556         end = begin + count;
557         if ((begin < k_i_info->filestart) ||
558             (end > k_i_info->filestart + file->f_inode->i_size) ||
559             (end < begin)) {
560                 set_errno(current_tf, EINVAL);
561                 return -1;
562         }
563
564         /* TODO: think about this.  if it's a user buffer, we're relying on current
565          * to detect whose it is (which should work for async calls).  Consider
566          * pushing this up the VFS stack. */
567         if (current) {
568                 memcpy_to_user(current, buf, begin, count);
569         } else {
570                 memcpy(buf, begin, count);
571         }
572         *offset += count;
573         return count;
574 }
575
576 /* Writes count bytes from buf to the file, starting at *offset, which is
577  * increased accordingly */
578 ssize_t kfs_write(struct file *file, const char *buf, size_t count,
579                   off_t *offset)
580 {
581         struct kfs_i_info *k_i_info = (struct kfs_i_info*)file->f_inode->i_fs_info;
582         void *begin, *end;
583
584         /* TODO: handle this higher up in the VFS */
585         if (!count)
586                 return 0;
587         if (*offset == file->f_inode->i_size)
588                 return 0; /* EOF */
589
590         /* Make sure we don't go past the end of the file */
591         if (*offset + count > file->f_inode->i_size) {
592                 count = file->f_inode->i_size - *offset;
593         }
594         begin = k_i_info->filestart + *offset;
595         end = begin + count;
596         if ((begin < k_i_info->filestart) ||
597             (end > k_i_info->filestart + file->f_inode->i_size) ||
598             (end < begin)) {
599                 set_errno(current_tf, EINVAL);
600                 return -1;
601         }
602
603         /* TODO: think about this.  if it's a user buffer, we're relying on current
604          * to detect whose it is (which should work for async calls).  Consider
605          * pushing this up the VFS stack. */
606         if (current) {
607                 memcpy_from_user(current, begin, buf, count);
608         } else {
609                 memcpy(begin, buf, count);
610         }
611         *offset += count;
612         return count;
613 }
614
615 /* Fills in the next directory entry (dirent), starting with d_off.  Like with
616  * read and write, there will be issues with userspace and the *dirent buf.
617  * TODO: we don't really do anything with userspace concerns here, in part
618  * because memcpy_to doesn't work well.  When we fix how we want to handle the
619  * userbuffers, we can write this accordingly.  */
620 int kfs_readdir(struct file *dir, struct dirent *dirent)
621 {
622         int count = 0;
623         bool found = FALSE;
624         struct dentry *subent;
625         struct dentry *dir_d = TAILQ_FIRST(&dir->f_inode->i_dentry);
626         struct kfs_i_info *k_i_info = (struct kfs_i_info*)dir->f_inode->i_fs_info;
627
628         /* how we check inside the for loops below.  moderately ghetto. */
629         void check_entry(void)
630         {
631                 if (count++ == dirent->d_off) {
632                         dirent->d_ino = subent->d_inode->i_ino;
633                         dirent->d_reclen = subent->d_name.len;
634                         /* d_name.name is null terminated, the byte after d_name.len */
635                         assert(subent->d_name.len <= MAX_FILENAME_SZ);
636                         strncpy(dirent->d_name, subent->d_name.name, subent->d_name.len +1);
637                         found = TRUE;
638                 }
639         }
640         /* some of this error handling can be done by the VFS.  The syscall should
641          * handle EBADF, EFAULT, and EINVAL (TODO, memory related). */
642         if (!(dir->f_inode->i_flags & FS_I_DIR)) {
643                 set_errno(current_tf, ENOTDIR);
644                 return -1;
645         }
646
647         /* need to check the sub-dirs as well as the sub-"files" */
648         TAILQ_FOREACH(subent, &dir_d->d_subdirs, d_subdirs_link)
649                 check_entry();
650         TAILQ_FOREACH(subent, &k_i_info->children, d_subdirs_link)
651                 check_entry();
652
653         if (!found) {
654                 set_errno(current_tf, ENOENT);
655                 return -1;
656         }
657         if (count - 1 == dirent->d_off)         /* found the last dir in the list */
658                 return 0;
659         return 1;                                                       /* normal success for readdir */
660 }
661
662 /* This is called when a VMR is mapping a particular file.  The FS needs to do
663  * whatever it needs so that faults can be handled by read_page(), and handle all
664  * of the cases of MAP_SHARED, MAP_PRIVATE, whatever.  It also needs to ensure
665  * the file is not being mmaped in a way that conflicts with the manner in which
666  * the file was opened. */
667 int kfs_mmap(struct file *file, struct vm_region *vmr)
668 {
669         /* the file is not page-aligned yet, so we need to copy it to fresh pages.
670          * this should only be done once per SHARED file (inode), so only make fresh
671          * copies if people want new ones.  Also note that MAP_PRIVATE does not get
672          * carried through to the underlying file. */
673
674         return -1;
675 }
676
677 /* Opens the file specified by the inode, creating and filling in the file */
678 /* TODO: fill out the other // entries, sort vmnt refcnting */
679 int kfs_open(struct inode *inode, struct file *file)
680 {
681         /* This is mostly FS-agnostic, consider a helper */
682         //file = kmem_cache_alloc(file_kcache, 0); /* done in the VFS */
683         /* Add to the list of all files of this SB */
684         TAILQ_INSERT_TAIL(&inode->i_sb->s_files, file, f_list);
685         file->f_inode = inode;
686         atomic_inc(&inode->i_refcnt);
687         file->f_vfsmnt = inode->i_sb->s_mount;          /* saving a ref to the vmnt...*/
688         file->f_op = &kfs_f_op;
689         atomic_set(&file->f_refcnt, 1);                         /* ref passed out */
690         file->f_flags = inode->i_flags;                         /* just taking the inode vals */
691         file->f_mode = inode->i_mode;
692         file->f_pos = 0;
693         file->f_uid = inode->i_uid;
694         file->f_gid = inode->i_gid;
695         file->f_error = 0;
696 //      struct event_poll_tailq         f_ep_links;
697         spinlock_init(&file->f_ep_lock);
698         file->f_fs_info = 0;
699         file->f_mapping = inode->i_mapping;
700         return 0;
701 }
702
703 /* Called when a file descriptor is closed. */
704 int kfs_flush(struct file *file)
705 {
706         return -1;
707 }
708
709 /* Called when the file refcnt == 0 */
710 int kfs_release(struct inode *inode, struct file *file)
711 {
712         kmem_cache_free(file_kcache, file);
713         return -1;
714 }
715
716 /* Flushes the file's dirty contents to disc */
717 int kfs_fsync(struct file *file, struct dentry *dentry, int datasync)
718 {
719         return -1;
720 }
721
722 /* Traditionally, sleeps until there is file activity.  We probably won't
723  * support this, or we'll handle it differently. */
724 unsigned int kfs_poll(struct file *file, struct poll_table_struct *poll_table)
725 {
726         return -1;
727 }
728
729 /* Reads count bytes from a file, starting from (and modifiying) offset, and
730  * putting the bytes into buffers described by vector */
731 ssize_t kfs_readv(struct file *file, const struct iovec *vector,
732                   unsigned long count, off_t *offset)
733 {
734         return -1;
735 }
736
737 /* Writes count bytes to a file, starting from (and modifiying) offset, and
738  * taking the bytes from buffers described by vector */
739 ssize_t kfs_writev(struct file *file, const struct iovec *vector,
740                   unsigned long count, off_t *offset)
741 {
742         return -1;
743 }
744
745 /* Write the contents of file to the page.  Will sort the params later */
746 ssize_t kfs_sendpage(struct file *file, struct page *page, int offset,
747                      size_t size, off_t pos, int more)
748 {
749         return -1;
750 }
751
752 /* Checks random FS flags.  Used by NFS. */
753 int kfs_check_flags(int flags)
754 { // default, nothing
755         return -1;
756 }
757
758 /* Redeclaration and initialization of the FS ops structures */
759 struct page_map_operations kfs_pm_op = {
760         kfs_readpage,
761 };
762
763 struct super_operations kfs_s_op = {
764         kfs_alloc_inode,
765         kfs_destroy_inode,
766         kfs_read_inode,
767         kfs_dirty_inode,
768         kfs_write_inode,
769         kfs_put_inode,
770         kfs_drop_inode,
771         kfs_delete_inode,
772         kfs_put_super,
773         kfs_write_super,
774         kfs_sync_fs,
775         kfs_remount_fs,
776         kfs_umount_begin,
777 };
778
779 struct inode_operations kfs_i_op = {
780         kfs_create,
781         kfs_lookup,
782         kfs_link,
783         kfs_unlink,
784         kfs_symlink,
785         kfs_mkdir,
786         kfs_rmdir,
787         kfs_mknod,
788         kfs_rename,
789         kfs_readlink,
790         kfs_follow_link,
791         kfs_put_link,
792         kfs_truncate,
793         kfs_permission,
794 };
795
796 struct dentry_operations kfs_d_op = {
797         kfs_d_revalidate,
798         kfs_d_hash,
799         kfs_d_compare,
800         kfs_d_delete,
801         kfs_d_release,
802         kfs_d_iput,
803 };
804
805 struct file_operations kfs_f_op = {
806         kfs_llseek,
807         kfs_read,
808         kfs_write,
809         kfs_readdir,
810         kfs_mmap,
811         kfs_open,
812         kfs_flush,
813         kfs_release,
814         kfs_fsync,
815         kfs_poll,
816         kfs_readv,
817         kfs_writev,
818         kfs_sendpage,
819         kfs_check_flags,
820 };
821
822 /* KFS Specific Internal Functions */
823
824 /* For obj files compiled with the kernel */
825 #define DECL_PROG(x) \
826     extern uint8_t (COUNT(sizeof(size_t)) _binary_obj_tests_##x##_size)[],\
827         (COUNT(_binary_obj_user_apps_##x##_size)_binary_obj_tests_##x##_start)[];
828
829 #define KFS_PENTRY(x) {#x, _binary_obj_tests_##x##_start, (size_t) _binary_obj_tests_##x##_size},
830
831 /*
832  * Hardcode the files included in the KFS.  PROGs need to be in sync with the
833  * userapps in kern/src/Makefrag.  Files need to be in kern/kfs/
834  * Make sure to declare it, and add an entry.  Keep MAX_KFS_FILES big enough too
835  * Note that files with a . in their name will have an _ instead.
836  */
837 #ifdef __CONFIG_KFS__
838 DECL_PROG(tlstest);
839 DECL_PROG(fp_test);
840 DECL_PROG(mproctests);
841 DECL_PROG(hello);
842 DECL_PROG(mhello);
843 DECL_PROG(pthread_test);
844 DECL_PROG(pthread_barrier_test);
845 DECL_PROG(idle);
846 DECL_PROG(tsc_spitter);
847 DECL_PROG(msr_get_cores);
848 DECL_PROG(msr_get_singlecore);
849 DECL_PROG(msr_dumb_while);
850 DECL_PROG(msr_nice_while);
851 DECL_PROG(msr_single_while);
852 DECL_PROG(msr_cycling_vcores);
853 #endif
854
855 struct kfs_entry kfs[MAX_KFS_FILES] = {
856 #ifdef __CONFIG_KFS__
857         KFS_PENTRY(tlstest)
858         KFS_PENTRY(fp_test)
859         KFS_PENTRY(mproctests)
860         KFS_PENTRY(hello)
861         KFS_PENTRY(mhello)
862         KFS_PENTRY(pthread_test)
863         KFS_PENTRY(pthread_barrier_test)
864         KFS_PENTRY(idle)
865         KFS_PENTRY(tsc_spitter)
866         KFS_PENTRY(msr_get_cores)
867         KFS_PENTRY(msr_get_singlecore)
868         KFS_PENTRY(msr_dumb_while)
869         KFS_PENTRY(msr_nice_while)
870         KFS_PENTRY(msr_single_while)
871         KFS_PENTRY(msr_cycling_vcores)
872 #endif
873 };
874
875 ssize_t kfs_lookup_path(char* path)
876 {
877         for (int i = 0; i < MAX_KFS_FILES; i++)
878                 // need to think about how to copy-in something of unknown length
879                 if (!strncmp(kfs[i].name, path, strlen(path)))
880                         return i;
881         return -EINVAL;
882 }
883
884 /*
885  * Creates a process from the file pointed to by the KFS inode (index)
886  * This should take a real inode or something to point to the real location,
887  * and proc_create shouldn't assume everything is contiguous
888  */
889 struct proc *kfs_proc_create(int kfs_inode)
890 {
891         if (kfs_inode < 0 || kfs_inode >= MAX_KFS_FILES)
892                 panic("Invalid kfs_inode.  Check you error codes!");
893         return proc_create(kfs[kfs_inode].start, kfs[kfs_inode].size);
894 }
895
896 /* Dumps the contents of the KFS file to the console.  Not meant to be taken
897  * too seriously - just dumps each char. */
898 void kfs_cat(int kfs_inode)
899 {
900         if (kfs_inode < 0 || kfs_inode >= MAX_KFS_FILES)
901                 panic("Invalid kfs_inode.  Check you error codes!");
902         uint8_t *end = kfs[kfs_inode].start + kfs[kfs_inode].size;
903         for (uint8_t *ptr = kfs[kfs_inode].start; ptr < end; ptr++)
904                 cputchar(*ptr);
905 }
906
907 /* Need to pass path separately, since we'll recurse on it.  TODO: this recurses,
908  * and takes up a lot of stack space (~270 bytes).  Core 0's KSTACK is 8 pages,
909  * which can handle about 120 levels deep...  Other cores are not so fortunate.
910  * Can rework this if it becomes an issue. */
911 static int __add_kfs_entry(struct dentry *parent, char *path,
912                            struct cpio_bin_hdr *c_bhdr)
913 {
914         char *first_slash = strchr(path, '/');  
915         char dir[MAX_FILENAME_SZ + 1];  /* room for the \0 */
916         size_t dirname_sz;                              /* not counting the \0 */
917         struct dentry *dentry = 0;
918         struct nameidata nd = {0};
919         struct inode *inode;
920
921         if (first_slash) {
922                 /* get the first part, find that dentry, pass in the second part,
923                  * recurse.  this isn't being smart about extra slashes, dots, or
924                  * anything like that. */
925                 dirname_sz = first_slash - path;
926                 assert(dirname_sz <= MAX_FILENAME_SZ);
927                 strncpy(dir, path, dirname_sz);
928                 dir[dirname_sz] = '\0';
929                 printd("Finding DIR %s in dentry %s (start: %p, size %d)\n", dir,
930                        parent->d_name.name, c_bhdr->c_filestart, c_bhdr->c_filesize);
931                 /* Need to create a dentry for the lookup, and fill in the basic nd */
932                 dentry = get_dentry(parent->d_sb, parent, dir);
933                 nd.dentry = dentry;
934                 nd.mnt = dentry->d_sb->s_mount;
935                 //nd.flags = 0;                 /* TODO: once we have lookup flags */
936                 //nd.last_type = 0;             /* TODO: should be a DIR */
937                 //nd.intent = 0;                /* TODO: RW, prob irrelevant*/
938                 /* TODO: use a VFS lookup instead, to use the dcache, thought its not a
939                  * big deal since KFS currently pins all metadata. */
940                 dentry = kfs_lookup(parent->d_inode, dentry, &nd);
941                 if (!dentry) {
942                         printk("Missing dir in CPIO archive or something, aborting.\n");
943                         return -1;
944                 }
945                 return __add_kfs_entry(dentry, first_slash + 1, c_bhdr);
946         } else {
947                 /* no directories left in the path.  add the 'file' to the dentry */
948                 printd("Adding file/dir %s to dentry %s (start: %p, size %d)\n", path,
949                        parent->d_name.name, c_bhdr->c_filestart, c_bhdr->c_filesize);
950                 /* Init the dentry for this path */
951                 dentry = get_dentry(parent->d_sb, parent, path);
952                 dentry->d_op = &kfs_d_op;
953                 dcache_put(dentry);                     /* TODO: should set a d_flag too */
954                 /* build the inode */
955                 if (!c_bhdr->c_filesize) {
956                         /* we are a directory.  Note that fifos might look like dirs... */
957                         kfs_mkdir(parent->d_inode, dentry, c_bhdr->c_mode);
958                         inode = dentry->d_inode;
959                 } else {
960                         /* we are a file */
961                         kfs_create(parent->d_inode, dentry, c_bhdr->c_mode, 0);
962                         inode = dentry->d_inode;
963                         ((struct kfs_i_info*)inode->i_fs_info)->filestart =
964                                                                 c_bhdr->c_filestart;
965                 }
966                 /* Set other info from the CPIO entry */
967                 inode->i_uid = c_bhdr->c_uid;
968                 inode->i_gid = c_bhdr->c_gid;
969                 inode->i_atime.tv_sec = c_bhdr->c_mtime;
970                 inode->i_ctime.tv_sec = c_bhdr->c_mtime;
971                 inode->i_mtime.tv_sec = c_bhdr->c_mtime;
972                 inode->i_size = c_bhdr->c_filesize;
973                 //inode->i_XXX = c_bhdr->c_dev;                 /* and friends */
974                 inode->i_bdev = 0;                                              /* assuming blockdev? */
975                 inode->i_socket = FALSE;
976                 inode->i_blocks = c_bhdr->c_filesize;   /* blocksize == 1 */
977         }
978         return 0;
979 }
980
981 /* Adds an entry (from a CPIO archive) to KFS.  This will put all the FS
982  * metadata in memory, instead of having to reparse the entire archive each time
983  * we need to traverse.
984  *
985  * The other option is to just maintain a LL of {FN, FS}, and O(n) scan it.
986  *
987  * The path is a complete path, interpreted from the root of the mount point.
988  * Directories have a size of 0.  so do symlinks, but we don't handle those yet.
989  *
990  * If a directory does not exist for a file, this will return an error.  Don't
991  * use the -depth flag to find when building the CPIO archive, and this won't be
992  * a problem.  (Maybe) */
993 static int add_kfs_entry(struct super_block *sb, struct cpio_bin_hdr *c_bhdr)
994 {
995         char *path = c_bhdr->c_filename;
996         /* Root of the FS, already part of KFS */
997         if (!strcmp(path, "."))
998                 return 0;
999         return __add_kfs_entry(sb->s_mount->mnt_root, path, c_bhdr);
1000 }
1001
1002 void parse_cpio_entries(struct super_block *sb, void *cpio_b)
1003 {
1004         struct cpio_newc_header *c_hdr = (struct cpio_newc_header*)cpio_b;
1005
1006         char buf[9] = {0};      /* temp space for strol conversions */
1007         size_t namesize = 0;
1008         int offset = 0;         /* offset in the cpio archive */
1009         struct cpio_bin_hdr *c_bhdr = kmalloc(sizeof(*c_bhdr), 0);
1010         memset(c_bhdr, 0, sizeof(*c_bhdr));
1011
1012         /* read all files and paths */
1013         for (; ; c_hdr = (struct cpio_newc_header*)(cpio_b + offset)) {
1014                 offset += sizeof(*c_hdr);
1015                 if (strncmp(c_hdr->c_magic, "070701", 6)) {
1016                         printk("Invalid magic number in CPIO header, aborting.\n");
1017                         return;
1018                 }
1019                 c_bhdr->c_filename = (char*)c_hdr + sizeof(*c_hdr);
1020                 namesize = cpio_strntol(buf, c_hdr->c_namesize, 8);
1021                 printd("Namesize: %d\n", size);
1022                 if (!strcmp(c_bhdr->c_filename, "TRAILER!!!"))
1023                         break;
1024                 c_bhdr->c_ino = cpio_strntol(buf, c_hdr->c_ino, 8);
1025                 c_bhdr->c_mode = (int)cpio_strntol(buf, c_hdr->c_mode, 8);
1026                 c_bhdr->c_uid = cpio_strntol(buf, c_hdr->c_uid, 8);
1027                 c_bhdr->c_gid = cpio_strntol(buf, c_hdr->c_gid, 8);
1028                 c_bhdr->c_nlink = (unsigned int)cpio_strntol(buf, c_hdr->c_nlink, 8);
1029                 c_bhdr->c_mtime = cpio_strntol(buf, c_hdr->c_mtime, 8);
1030                 c_bhdr->c_filesize = cpio_strntol(buf, c_hdr->c_filesize, 8);
1031                 c_bhdr->c_dev_maj = cpio_strntol(buf, c_hdr->c_dev_maj, 8);
1032                 c_bhdr->c_dev_min = cpio_strntol(buf, c_hdr->c_dev_min, 8);
1033                 c_bhdr->c_rdev_maj = cpio_strntol(buf, c_hdr->c_rdev_maj, 8);
1034                 c_bhdr->c_rdev_min = cpio_strntol(buf, c_hdr->c_rdev_min, 8);
1035                 printd("File: %s: %d Bytes\n", c_bhdr->c_filename, c_bhdr->c_filesize);
1036                 offset += namesize;
1037                 /* header + name will be padded out to 4-byte alignment */
1038                 offset = ROUNDUP(offset, 4);
1039                 c_bhdr->c_filestart = cpio_b + offset;
1040                 /* make this a function pointer or something */
1041                 if (add_kfs_entry(sb, c_bhdr)) {
1042                         printk("Failed to add an entry to KFS!\n");
1043                         break;
1044                 }
1045                 offset += c_bhdr->c_filesize;
1046                 offset = ROUNDUP(offset, 4);
1047                 //printk("offset is %d bytes\n", offset);
1048                 c_hdr = (struct cpio_newc_header*)(cpio_b + offset);
1049         }
1050         kfree(c_bhdr);
1051 }
1052
1053 /* Debugging */
1054 void print_dir_tree(struct dentry *dentry, int depth)
1055 {
1056         struct inode *inode = dentry->d_inode;
1057         struct kfs_i_info *k_i_info = (struct kfs_i_info*)inode->i_fs_info;
1058         struct dentry *d_i;
1059         assert(dentry && inode && inode->i_flags & FS_I_DIR);
1060         char buf[32] = {0};
1061
1062         for (int i = 0; i < depth; i++)
1063                 buf[i] = '\t';
1064
1065         TAILQ_FOREACH(d_i, &dentry->d_subdirs, d_subdirs_link) {
1066                 printk("%sDir %s has child dir: %s\n", buf, dentry->d_name.name,
1067                        d_i->d_name.name);
1068                 print_dir_tree(d_i, depth + 1);
1069         }
1070         TAILQ_FOREACH(d_i, &k_i_info->children, d_subdirs_link) {
1071                 printk("%sDir %s has child file: %s ", buf, dentry->d_name.name,
1072                        d_i->d_name.name);
1073                 printk("file starts at: %p\n",
1074                        ((struct kfs_i_info*)d_i->d_inode->i_fs_info)->filestart);
1075         }
1076 }