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