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