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