Fixes icache_put on creation and KFS refcounting
[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 #include <smp.h>
28
29 #define KFS_MAX_FILE_SIZE 1024*1024*128
30 #define KFS_MAGIC 0xdead0001
31
32 /* VFS required Functions */
33 /* These structs are declared again and initialized farther down */
34 struct page_map_operations kfs_pm_op;
35 struct super_operations kfs_s_op;
36 struct inode_operations kfs_i_op;
37 struct dentry_operations kfs_d_op;
38 struct file_operations kfs_f_op_file;
39 struct file_operations kfs_f_op_dir;
40 struct file_operations kfs_f_op_sym;
41
42 /* TODO: something more better.  Prob something like the vmem cache, for this,
43  * pids, etc.  Good enough for now.  This also means we can only have one
44  * KFS instance, and we also aren't synchronizing access. */
45 static unsigned long kfs_get_free_ino(void)
46 {
47         static unsigned long last_ino = 1;       /* 1 is reserved for the root */
48         last_ino++;
49         if (!last_ino)
50                 panic("Out of inos in KFS!");
51         return last_ino;
52 }
53
54 /* Slabs for KFS specific info chunks */
55 struct kmem_cache *kfs_i_kcache;
56
57 static void kfs_init(void)
58 {
59         kfs_i_kcache = kmem_cache_create("kfs_ino_info", sizeof(struct kfs_i_info),
60                                          __alignof__(struct kfs_i_info), 0, 0, 0);
61 }
62
63 /* Creates the SB (normally would read in from disc and create).  Passes it's
64  * ref out to whoever consumes this.  Returns 0 on failure.
65  * TODO: consider pulling out more of the FS-independent stuff, if possible.
66  * There are only two things, but the pain in the ass is that you'd need to read
67  * the disc to get that first inode, and it's a FS-specific thing. */
68 struct super_block *kfs_get_sb(struct fs_type *fs, int flags,
69                                char *dev_name, struct vfsmount *vmnt)
70 {
71         /* Ought to check that dev_name has our FS on it.  in this case, it's
72          * irrelevant. */
73         //if (something_bad)
74         //      return 0;
75         static bool ran_once = FALSE;
76         if (!ran_once) {
77                 ran_once = TRUE;
78                 kfs_init();
79         }
80
81         /* Build and init the SB.  No need to read off disc. */
82         struct super_block *sb = get_sb();
83         sb->s_dev = 0;
84         sb->s_blocksize = 1;
85         sb->s_maxbytes = KFS_MAX_FILE_SIZE;
86         sb->s_type = &kfs_fs_type;
87         sb->s_op = &kfs_s_op;
88         sb->s_flags = flags;
89         sb->s_magic = KFS_MAGIC;
90         sb->s_mount = vmnt;
91         sb->s_syncing = FALSE;
92         sb->s_bdev = 0;
93         strlcpy(sb->s_name, "KFS", 32);
94         /* store the location of the CPIO archive.  make this more generic later. */
95         extern uint8_t _binary_obj_kern_initramfs_cpio_size[];
96         extern uint8_t _binary_obj_kern_initramfs_cpio_start[];
97         sb->s_fs_info = (void*)_binary_obj_kern_initramfs_cpio_start;
98
99         /* Final stages of initializing the sb, mostly FS-independent */
100         /* 1 is the KFS root ino (inode number) */
101         init_sb(sb, vmnt, &kfs_d_op, 1, 0);
102         /* Parses the CPIO entries and builds the in-memory KFS tree. */
103         parse_cpio_entries(sb, sb->s_fs_info);
104         printk("KFS superblock loaded\n");
105         return sb;
106 }
107
108 void kfs_kill_sb(struct super_block *sb)
109 {
110         panic("Killing KFS is not supported!");
111 }
112
113 /* Every FS must have a static FS Type, with which the VFS code can bootstrap */
114 struct fs_type kfs_fs_type = {"KFS", 0, kfs_get_sb, kfs_kill_sb, {0, 0},
115                TAILQ_HEAD_INITIALIZER(kfs_fs_type.fs_supers)};
116
117 /* Page Map Operations */
118
119 /* Fills page with its contents from its backing store file.  Note that we do
120  * the zero padding here, instead of higher in the VFS.  Might change in the
121  * future. */
122 int kfs_readpage(struct file *file, struct page *page)
123 {
124         size_t pg_idx_byte = page->pg_index * PGSIZE;
125         struct kfs_i_info *k_i_info = (struct kfs_i_info*)
126                                       file->f_dentry->d_inode->i_fs_info;
127         uintptr_t begin = (size_t)k_i_info->filestart + pg_idx_byte;
128         /* If we're beyond the initial start point, we just need a zero page.  This
129          * is for a hole or for extending a file (even though it won't be saved).
130          * Otherwise, we want the data from KFS, being careful to not copy from
131          * beyond the original EOF (and zero padding anything extra). */
132         if (pg_idx_byte >= k_i_info->init_size) {
133                 memset(page2kva(page), 0, PGSIZE);
134         } else {
135                 size_t copy_amt = MIN(PGSIZE, k_i_info->init_size - pg_idx_byte);
136                 memcpy(page2kva(page), (void*)begin, copy_amt);
137                 memset(page2kva(page) + copy_amt, 0, PGSIZE - copy_amt);
138         }
139         /* This is supposed to be done in the IO system when the operation is
140          * complete.  Since we aren't doing a real IO request, and it is already
141          * done, we can do it here. */
142         page->pg_flags |= PG_UPTODATE;
143         unlock_page(page);
144         return 0;
145 }
146
147 /* Super Operations */
148
149 /* Creates and initializes a new inode.  FS specific, yet inode-generic fields
150  * are filled in.  inode-specific fields are filled in in read_inode() based on
151  * what's on the disk for a given i_no.  i_no and i_fop are set by the caller.
152  *
153  * Note that this means this inode can be for an inode that is already on disk,
154  * or it can be used when creating.  The i_fop depends on the type of file
155  * (file, directory, symlink, etc). */
156 struct inode *kfs_alloc_inode(struct super_block *sb)
157 {
158         struct inode *inode = kmem_cache_alloc(inode_kcache, 0);
159         memset(inode, 0, sizeof(struct inode));
160         inode->i_op = &kfs_i_op;
161         inode->i_pm.pm_op = &kfs_pm_op;
162         inode->i_fs_info = kmem_cache_alloc(kfs_i_kcache, 0);
163         TAILQ_INIT(&((struct kfs_i_info*)inode->i_fs_info)->children);
164         ((struct kfs_i_info*)inode->i_fs_info)->filestart = 0;
165         return inode;
166 }
167
168 /* FS-specific clean up when an inode is dealloced.  this is just cleaning up
169  * the in-memory version, and only the FS-specific parts.  whether or not the
170  * inode is still on disc is irrelevant. */
171 void kfs_dealloc_inode(struct inode *inode)
172 {
173         /* If we're a symlink, give up our storage for the symname */
174         if (S_ISLNK(inode->i_mode))
175                 kfree(((struct kfs_i_info*)inode->i_fs_info)->filestart);
176         kmem_cache_free(kfs_i_kcache, inode->i_fs_info);
177 }
178
179 /* reads the inode data on disk specified by inode->i_ino into the inode.
180  * basically, it's a "make this inode the one for i_ino (i number)" */
181 void kfs_read_inode(struct inode *inode)
182 {
183         /* need to do something to link this inode/file to the actual "blocks" on
184          * "disk". */
185
186         /* TODO: what does it mean to ask for an inode->i_ino that doesn't exist?
187          *      possibly a bug, since these inos come from directories */
188         if (inode->i_ino == 1) {
189                 inode->i_mode = S_IRWXU | S_IRWXG | S_IRWXO;
190                 SET_FTYPE(inode->i_mode, __S_IFDIR);
191                 inode->i_fop = &kfs_f_op_dir;
192                 inode->i_nlink = 1;                             /* assuming only one hardlink */
193                 inode->i_uid = 0;
194                 inode->i_gid = 0;
195                 inode->i_size = 0;                              /* make sense for KFS? */
196                 inode->i_atime.tv_sec = 0;
197                 inode->i_atime.tv_nsec = 0;
198                 inode->i_mtime.tv_sec = 0;
199                 inode->i_mtime.tv_nsec = 0;
200                 inode->i_ctime.tv_sec = 0;
201                 inode->i_ctime.tv_nsec = 0;
202                 inode->i_blocks = 0;
203                 inode->i_flags = 0;
204                 inode->i_socket = FALSE;
205         } else {
206                 panic("Not implemented");
207         }
208         /* TODO: unused: inode->i_hash add to hash (saves on disc reading) */
209 }
210
211 /* called when an inode in memory is modified (journalling FS's care) */
212 void kfs_dirty_inode(struct inode *inode)
213 {       // KFS doesn't care
214 }
215
216 /* write the inode to disk (specifically, to inode inode->i_ino), synchronously
217  * if we're asked to wait */
218 void kfs_write_inode(struct inode *inode, bool wait)
219 {       // KFS doesn't care
220 }
221
222 /* called when an inode is decref'd, to do any FS specific work */
223 void kfs_put_inode(struct inode *inode)
224 {       // KFS doesn't care
225 }
226
227 /* called when an inode is about to be destroyed.  the generic version ought to
228  * remove every reference to the inode from the VFS, and if the inode isn't in
229  * any directory, calls delete_inode */
230 void kfs_drop_inode(struct inode *inode)
231 { // TODO: should call a generic one instead.  or at least do something...
232         // remove from lists
233 }
234
235 /* delete the inode from disk (all data) */
236 void kfs_delete_inode(struct inode *inode)
237 {
238         // would remove from "disk" here
239         /* TODO: give up our i_ino */
240 }
241
242 /* unmount and release the super block */
243 void kfs_put_super(struct super_block *sb)
244 {
245         panic("Shazbot! KFS can't be unmounted yet!");
246 }
247
248 /* updates the on-disk SB with the in-memory SB */
249 void kfs_write_super(struct super_block *sb)
250 {       // KFS doesn't care
251 }
252
253 /* syncs FS metadata with the disc, synchronously if we're waiting.  this info
254  * also includes anything pointed to by s_fs_info. */
255 int kfs_sync_fs(struct super_block *sb, bool wait)
256 {
257         return 0;
258 }
259
260 /* remount the FS with the new flags */
261 int kfs_remount_fs(struct super_block *sb, int flags, char *data)
262 {
263         warn("KFS will not remount.");
264         return -1; // can't remount
265 }
266
267 /* interrupts a mount operation - used by NFS and friends */
268 void kfs_umount_begin(struct super_block *sb)
269 {
270         panic("Cannot abort a KFS mount, and why would you?");
271 }
272
273 /* inode_operations */
274
275 /* Little helper, used for initializing new inodes for file-like objects (files,
276  * symlinks, etc).  We pass the dentry, since we need to up it. */
277 static void kfs_init_inode(struct inode *dir, struct dentry *dentry)
278 {
279         struct inode *inode = dentry->d_inode;
280         kref_get(&dentry->d_kref, 1);   /* to pin the dentry in RAM, KFS-style... */
281         inode->i_ino = kfs_get_free_ino();
282         /* our parent dentry's inode tracks our dentry info.  We do this
283          * since it's all in memory and we aren't using the dcache yet.
284          * We're reusing the subdirs link, which is used by the VFS when
285          * we're a directory.  But since we're a file, it's okay to reuse
286          * it. */
287         TAILQ_INSERT_TAIL(&((struct kfs_i_info*)dir->i_fs_info)->children,
288                           dentry, d_subdirs_link);
289 }
290
291 /* Called when creating a new disk inode in dir associated with dentry.  We need
292  * to fill out the i_ino, set the type, and do whatever else we need */
293 int kfs_create(struct inode *dir, struct dentry *dentry, int mode,
294                struct nameidata *nd)
295 {
296         struct inode *inode = dentry->d_inode;
297         kfs_init_inode(dir, dentry);
298         SET_FTYPE(inode->i_mode, __S_IFREG);
299         inode->i_fop = &kfs_f_op_file;
300         /* fs_info->filestart is set by the caller, or else when first written (for
301          * new files.  it was set to 0 in alloc_inode(). */
302         return 0;
303 }
304
305 /* Searches the directory for the filename in the dentry, filling in the dentry
306  * with the FS specific info of this file.  If it succeeds, it will pass back
307  * the *dentry you should use.  If this fails, it will return 0.  It will NOT
308  * take your dentry ref (it used to).  It probably will not be the same dentry
309  * you passed in.  This is ugly.
310  *
311  * Callers, make sure you alloc and fill out the name parts of the dentry, and
312  * an initialized nameidata. TODO: not sure why we need an ND.  Don't use it in
313  * a fs_lookup for now!
314  *
315  * Because of the way KFS currently works, if there is ever a dentry, it's
316  * already in memory, along with its inode (all path's pinned).  So we just find
317  * it and return it, freeing the one that came in. */
318 struct dentry *kfs_lookup(struct inode *dir, struct dentry *dentry,
319                           struct nameidata *nd)
320 {
321         struct kfs_i_info *k_i_info = (struct kfs_i_info*)dir->i_fs_info;
322         struct dentry *dir_dent = TAILQ_FIRST(&dir->i_dentry);
323         struct dentry *d_i;
324
325         assert(dir_dent && dir_dent == TAILQ_LAST(&dir->i_dentry, dentry_tailq));
326         assert(S_ISDIR(dir->i_mode));
327         assert(kref_refcnt(&dentry->d_kref) == 1);
328         TAILQ_FOREACH(d_i, &dir_dent->d_subdirs, d_subdirs_link) {
329                 if (!strcmp(d_i->d_name.name, dentry->d_name.name)) {
330                         /* since this dentry is already in memory (that's how KFS works), we
331                          * just return the real one (with another refcnt) */
332                         kref_get(&d_i->d_kref, 1);
333                         return d_i;
334                 }
335         }
336         TAILQ_FOREACH(d_i, &k_i_info->children, d_subdirs_link) {
337                 if (!strcmp(d_i->d_name.name, dentry->d_name.name)) {
338                         /* since this dentry is already in memory (that's how KFS works), we
339                          * just return the real one (with another refcnt) */
340                         kref_get(&d_i->d_kref, 1);
341                         return d_i;
342                 }
343         }
344         printd("Not Found %s!!\n", dentry->d_name.name);
345         return 0;
346 }
347
348 /* Hard link to old_dentry in directory dir with a name specified by new_dentry.
349  * At the very least, set the new_dentry's FS-specific fields. */
350 int kfs_link(struct dentry *old_dentry, struct inode *dir,
351              struct dentry *new_dentry)
352 {
353         assert(new_dentry->d_op = &kfs_d_op);
354         kref_get(&new_dentry->d_kref, 1);               /* pin the dentry, KFS-style */
355         /* KFS-style directory-tracking-of-kids */
356         TAILQ_INSERT_TAIL(&((struct kfs_i_info*)dir->i_fs_info)->children,
357                           new_dentry, d_subdirs_link);
358         return 0;
359 }
360
361 /* Removes the link from the dentry in the directory */
362 int kfs_unlink(struct inode *dir, struct dentry *dentry)
363 {
364         /* Stop tracking our child */
365         TAILQ_REMOVE(&((struct kfs_i_info*)dir->i_fs_info)->children, dentry,
366                      d_subdirs_link);
367         kref_put(&dentry->d_kref);                              /* unpin the dentry, KFS-style */
368         return 0;
369 }
370
371 /* Creates a new inode for a symlink dir, linking to / containing the name
372  * symname.  dentry is the controlling dentry of the inode. */
373 int kfs_symlink(struct inode *dir, struct dentry *dentry, const char *symname)
374 {
375         struct inode *inode = dentry->d_inode;
376         struct kfs_i_info *k_i_info = (struct kfs_i_info*)inode->i_fs_info;
377         size_t len = strlen(symname);
378         char *string = kmalloc(len + 1, 0);
379
380         kfs_init_inode(dir, dentry);
381         SET_FTYPE(inode->i_mode, __S_IFLNK);
382         inode->i_fop = &kfs_f_op_sym;
383         strncpy(string, symname, len);
384         string[len] = '\0';             /* symname should be \0d anyway, but just in case */
385         k_i_info->filestart = string;   /* reusing this void* to hold the char* */
386         return 0;
387 }
388
389 /* Called when creating a new inode for a directory associated with dentry in
390  * dir with the given mode.  Note, we might (later) need to track subdirs within
391  * the parent inode, like we do with regular files.  I'd rather not, so we'll
392  * see if we need it. */
393 int kfs_mkdir(struct inode *dir, struct dentry *dentry, int mode)
394 {
395         struct inode *inode = dentry->d_inode;
396         kref_get(&dentry->d_kref, 1);   /* to pin the dentry in RAM, KFS-style... */
397         inode->i_ino = kfs_get_free_ino();
398         SET_FTYPE(inode->i_mode, __S_IFDIR);
399         inode->i_fop = &kfs_f_op_dir;
400         /* get ready to have our own kids */
401         TAILQ_INIT(&((struct kfs_i_info*)inode->i_fs_info)->children);
402         ((struct kfs_i_info*)inode->i_fs_info)->filestart = 0;
403         return 0;
404 }
405
406 /* Removes from dir the directory 'dentry.'  KFS doesn't store anything in the
407  * inode for which children it has.  It probably should, but since everything is
408  * pinned, it just relies on the dentry connections. */
409 int kfs_rmdir(struct inode *dir, struct dentry *dentry)
410 {
411         struct kfs_i_info *d_info = (struct kfs_i_info*)dentry->d_inode->i_fs_info;
412         struct dentry *d_i;
413         bool empty = TRUE;
414         /* Check if we are empty.  If not, error out, need to check the sub-dirs as
415          * well as the sub-"files" */
416         TAILQ_FOREACH(d_i, &dentry->d_subdirs, d_subdirs_link) {
417                 empty = FALSE;
418                 break;
419         }
420         TAILQ_FOREACH(d_i, &d_info->children, d_subdirs_link) {
421                 empty = FALSE;
422                 break;
423         }
424         if (!empty)
425                 return -ENOTEMPTY;
426         kref_put(&dentry->d_kref);                              /* unpin the dentry, KFS-style */
427         printk("DENTRY %s REFCNT %d\n", dentry->d_name.name, kref_refcnt(&dentry->d_kref));
428         return 0;
429 }
430
431 /* Used to make a generic file, based on the type and the major/minor numbers
432  * (in rdev), with the given mode.  As with others, this creates a new disk
433  * inode for the file */
434 int kfs_mknod(struct inode *dir, struct dentry *dentry, int mode, dev_t rdev)
435 {
436         return -1;
437 }
438
439 /* Moves old_dentry from old_dir to new_dentry in new_dir */
440 int kfs_rename(struct inode *old_dir, struct dentry *old_dentry,
441                struct inode *new_dir, struct dentry *new_dentry)
442 {
443         return -1;
444 }
445
446 /* Returns the char* for the symname for the given dentry.  The VFS code that
447  * calls this for real FS's might assume it's already read in, so if the char *
448  * isn't already in memory, we'd need to read it in here.  Regarding the char*
449  * storage, the char* only will last as long as the dentry and inode are in
450  * memory. */
451 char *kfs_readlink(struct dentry *dentry)
452 {
453         struct inode *inode = dentry->d_inode;
454         struct kfs_i_info *k_i_info = (struct kfs_i_info*)inode->i_fs_info;
455         if (!S_ISLNK(inode->i_mode))
456                 return 0;
457         return k_i_info->filestart;
458 }
459
460 /* Modifies the size of the file of inode to whatever its i_size is set to */
461 void kfs_truncate(struct inode *inode)
462 {
463 }
464
465 /* Checks whether the the access mode is allowed for the file belonging to the
466  * inode.  Implies that the permissions are on the file, and not the hardlink */
467 int kfs_permission(struct inode *inode, int mode, struct nameidata *nd)
468 {
469         return -1;
470 }
471
472
473 /* dentry_operations */
474 /* Determines if the dentry is still valid before using it to translate a path.
475  * Network FS's need to deal with this. */
476 int kfs_d_revalidate(struct dentry *dir, struct nameidata *nd)
477 { // default, nothing
478         return -1;
479 }
480
481 /* Produces the hash to lookup this dentry from the dcache */
482 int kfs_d_hash(struct dentry *dentry, struct qstr *name)
483 {
484         return -1;
485 }
486
487 /* Compares name1 and name2.  name1 should be a member of dir. */
488 int kfs_d_compare(struct dentry *dir, struct qstr *name1, struct qstr *name2)
489 { // default, string comp (case sensitive)
490         return -1;
491 }
492
493 /* Called when the last ref is deleted (refcnt == 0) */
494 int kfs_d_delete(struct dentry *dentry)
495 { // default, nothin
496         return -1;
497 }
498
499 /* Called when it's about to be slab-freed */
500 int kfs_d_release(struct dentry *dentry)
501 {
502         return -1;
503 }
504
505 /* Called when the dentry loses it's inode (becomes "negative") */
506 void kfs_d_iput(struct dentry *dentry, struct inode *inode)
507 { // default, call i_put to release the inode object
508 }
509
510
511 /* file_operations */
512
513 /* Updates the file pointer.  KFS doesn't let you go past the end of a file
514  * yet, so it won't let you seek past either.  TODO: think about locking. */
515 off_t kfs_llseek(struct file *file, off_t offset, int whence)
516 {
517         off_t temp_off = 0;
518         switch (whence) {
519                 case SEEK_SET:
520                         temp_off = offset;
521                         break;
522                 case SEEK_CUR:
523                         temp_off = file->f_pos + offset;
524                         break;
525                 case SEEK_END:
526                         temp_off = file->f_dentry->d_inode->i_size + offset;
527                         break;
528                 default:
529                         set_errno(EINVAL);
530                         warn("Unknown 'whence' in llseek()!\n");
531                         return -1;
532         }
533         /* make sure the f_pos isn't outside the limits of the existing file.
534          * techincally, if they go too far, we should return EINVAL */
535         temp_off = MAX(MIN(temp_off, file->f_dentry->d_inode->i_size), 0);
536         file->f_pos = temp_off;
537         return temp_off;
538 }
539
540 /* Fills in the next directory entry (dirent), starting with d_off.  KFS treats
541  * the size of each dirent as 1 byte, which we can get away with since the d_off
542  * is a way of communicating with future calls to readdir (FS-specific).
543  *
544  * Like with read and write, there will be issues with userspace and the *dirent
545  * buf.  TODO: we don't really do anything with userspace concerns here, in part
546  * because memcpy_to doesn't work well.  When we fix how we want to handle the
547  * userbuffers, we can write this accordingly. (UMEM)  */
548 int kfs_readdir(struct file *dir, struct dirent *dirent)
549 {
550         int count = 2;  /* total num dirents, gets incremented in check_entry() */
551         int desired_file = dirent->d_off;
552         bool found = FALSE;
553         struct dentry *subent;
554         struct dentry *dir_d = dir->f_dentry;
555         struct kfs_i_info *k_i_info = (struct kfs_i_info*)dir_d->d_inode->i_fs_info;
556
557         /* how we check inside the for loops below.  moderately ghetto. */
558         void check_entry(void)
559         {
560                 if (count++ == desired_file) {
561                         dirent->d_ino = subent->d_inode->i_ino;
562                         dirent->d_off = count;
563                         dirent->d_reclen = subent->d_name.len;
564                         /* d_name.name is null terminated, the byte after d_name.len */
565                         assert(subent->d_name.len <= MAX_FILENAME_SZ);
566                         strncpy(dirent->d_name, subent->d_name.name, subent->d_name.len +1);
567                         found = TRUE;
568                 }
569         }
570
571         /* Handle . and .. (first two dirents) */
572         if (desired_file == 0) {
573                 dirent->d_ino = dir_d->d_inode->i_ino;
574                 dirent->d_off = 1;
575                 dirent->d_reclen = 1;
576                 strncpy(dirent->d_name, ".", 2);        /* the extra is for the null term */
577                 found = TRUE;
578         } else if (desired_file == 1) {
579                 dirent->d_ino = dir_d->d_parent->d_inode->i_ino;
580                 dirent->d_off = 2;
581                 dirent->d_reclen = 2;
582                 strncpy(dirent->d_name, "..", 3);       /* the extra is for the null term */
583                 found = TRUE;
584         }
585         /* need to check the sub-dirs as well as the sub-"files".  The main
586          * ghetto-ness with this is that we check even though we have our result,
587          * simply to figure out how big our directory is.  It's just not worth
588          * changing at this point. */
589         TAILQ_FOREACH(subent, &dir_d->d_subdirs, d_subdirs_link)
590                 check_entry();
591         TAILQ_FOREACH(subent, &k_i_info->children, d_subdirs_link)
592                 check_entry();
593         if (!found)
594                 return -ENOENT;
595         if (count - 1 == desired_file)          /* found the last dir in the list */
596                 return 0;
597         return 1;                                                       /* normal success for readdir */
598 }
599
600 /* This is called when a VMR is mapping a particular file.  The FS needs to do
601  * whatever it needs so that faults can be handled by read_page(), and handle all
602  * of the cases of MAP_SHARED, MAP_PRIVATE, whatever.  It also needs to ensure
603  * the file is not being mmaped in a way that conflicts with the manner in which
604  * the file was opened or the file type. */
605 int kfs_mmap(struct file *file, struct vm_region *vmr)
606 {
607         if (S_ISREG(file->f_dentry->d_inode->i_mode))
608                 return 0;
609         return -1;
610 }
611
612 /* Called by the VFS while opening the file, which corresponds to inode,  for
613  * the FS to do whatever it needs. */
614 int kfs_open(struct inode *inode, struct file *file)
615 {
616         return 0;
617 }
618
619 /* Called when a file descriptor is closed. */
620 int kfs_flush(struct file *file)
621 {
622         return -1;
623 }
624
625 /* Called when the file is about to be closed (file obj freed) */
626 int kfs_release(struct inode *inode, struct file *file)
627 {
628         return 0;
629 }
630
631 /* Flushes the file's dirty contents to disc */
632 int kfs_fsync(struct file *file, struct dentry *dentry, int datasync)
633 {
634         return -1;
635 }
636
637 /* Traditionally, sleeps until there is file activity.  We probably won't
638  * support this, or we'll handle it differently. */
639 unsigned int kfs_poll(struct file *file, struct poll_table_struct *poll_table)
640 {
641         return -1;
642 }
643
644 /* Reads count bytes from a file, starting from (and modifiying) offset, and
645  * putting the bytes into buffers described by vector */
646 ssize_t kfs_readv(struct file *file, const struct iovec *vector,
647                   unsigned long count, off_t *offset)
648 {
649         return -1;
650 }
651
652 /* Writes count bytes to a file, starting from (and modifiying) offset, and
653  * taking the bytes from buffers described by vector */
654 ssize_t kfs_writev(struct file *file, const struct iovec *vector,
655                   unsigned long count, off_t *offset)
656 {
657         return -1;
658 }
659
660 /* Write the contents of file to the page.  Will sort the params later */
661 ssize_t kfs_sendpage(struct file *file, struct page *page, int offset,
662                      size_t size, off_t pos, int more)
663 {
664         return -1;
665 }
666
667 /* Checks random FS flags.  Used by NFS. */
668 int kfs_check_flags(int flags)
669 { // default, nothing
670         return -1;
671 }
672
673 /* Redeclaration and initialization of the FS ops structures */
674 struct page_map_operations kfs_pm_op = {
675         kfs_readpage,
676 };
677
678 struct super_operations kfs_s_op = {
679         kfs_alloc_inode,
680         kfs_dealloc_inode,
681         kfs_read_inode,
682         kfs_dirty_inode,
683         kfs_write_inode,
684         kfs_put_inode,
685         kfs_drop_inode,
686         kfs_delete_inode,
687         kfs_put_super,
688         kfs_write_super,
689         kfs_sync_fs,
690         kfs_remount_fs,
691         kfs_umount_begin,
692 };
693
694 struct inode_operations kfs_i_op = {
695         kfs_create,
696         kfs_lookup,
697         kfs_link,
698         kfs_unlink,
699         kfs_symlink,
700         kfs_mkdir,
701         kfs_rmdir,
702         kfs_mknod,
703         kfs_rename,
704         kfs_readlink,
705         kfs_truncate,
706         kfs_permission,
707 };
708
709 struct dentry_operations kfs_d_op = {
710         kfs_d_revalidate,
711         kfs_d_hash,
712         kfs_d_compare,
713         kfs_d_delete,
714         kfs_d_release,
715         kfs_d_iput,
716 };
717
718 struct file_operations kfs_f_op_file = {
719         kfs_llseek,
720         generic_file_read,
721         generic_file_write,
722         kfs_readdir,
723         kfs_mmap,
724         kfs_open,
725         kfs_flush,
726         kfs_release,
727         kfs_fsync,
728         kfs_poll,
729         kfs_readv,
730         kfs_writev,
731         kfs_sendpage,
732         kfs_check_flags,
733 };
734
735 struct file_operations kfs_f_op_dir = {
736         kfs_llseek,
737         generic_dir_read,
738         0,
739         kfs_readdir,
740         kfs_mmap,
741         kfs_open,
742         kfs_flush,
743         kfs_release,
744         kfs_fsync,
745         kfs_poll,
746         kfs_readv,
747         kfs_writev,
748         kfs_sendpage,
749         kfs_check_flags,
750 };
751
752 struct file_operations kfs_f_op_sym = {
753         kfs_llseek,
754         generic_file_read,
755         generic_file_write,
756         kfs_readdir,
757         kfs_mmap,
758         kfs_open,
759         kfs_flush,
760         kfs_release,
761         kfs_fsync,
762         kfs_poll,
763         kfs_readv,
764         kfs_writev,
765         kfs_sendpage,
766         kfs_check_flags,
767 };
768
769 /* KFS Specific Internal Functions */
770
771 /* Need to pass path separately, since we'll recurse on it.  TODO: this recurses,
772  * and takes up a lot of stack space (~270 bytes).  Core 0's KSTACK is 8 pages,
773  * which can handle about 120 levels deep...  Other cores are not so fortunate.
774  * Can rework this if it becomes an issue. */
775 static int __add_kfs_entry(struct dentry *parent, char *path,
776                            struct cpio_bin_hdr *c_bhdr)
777 {
778         char *first_slash = strchr(path, '/');  
779         char dir[MAX_FILENAME_SZ + 1];  /* room for the \0 */
780         size_t dirname_sz;                              /* not counting the \0 */
781         struct dentry *dentry = 0;
782         struct inode *inode;
783         int err, retval;
784         char *symname, old_end;                 /* for symlink manipulation */
785
786         if (first_slash) {
787                 /* get the first part, find that dentry, pass in the second part,
788                  * recurse.  this isn't being smart about extra slashes, dots, or
789                  * anything like that. */
790                 dirname_sz = first_slash - path;
791                 assert(dirname_sz <= MAX_FILENAME_SZ);
792                 strncpy(dir, path, dirname_sz);
793                 dir[dirname_sz] = '\0';
794                 printd("Finding DIR %s in dentry %s (start: %p, size %d)\n", dir,
795                        parent->d_name.name, c_bhdr->c_filestart, c_bhdr->c_filesize);
796                 /* Need to create a dentry for the lookup, and fill in the basic nd */
797                 dentry = get_dentry(parent->d_sb, parent, dir);
798                 /* TODO: use a VFS lookup instead, to use the dcache, thought its not a
799                  * big deal since KFS currently pins all metadata. */
800                 dentry = kfs_lookup(parent->d_inode, dentry, 0);
801                 if (!dentry) {
802                         printk("Missing dir in CPIO archive or something, aborting.\n");
803                         return -1;
804                 }
805                 retval = __add_kfs_entry(dentry, first_slash + 1, c_bhdr);
806                 kref_put(&dentry->d_kref);
807                 return retval;
808         } else {
809                 /* no directories left in the path.  add the 'file' to the dentry */
810                 printd("Adding file/dir %s to dentry %s (start: %p, size %d)\n", path,
811                        parent->d_name.name, c_bhdr->c_filestart, c_bhdr->c_filesize);
812                 /* Init the dentry for this path */
813                 dentry = get_dentry(parent->d_sb, parent, path);
814                 // want to test the regular/natural dentry caching paths
815                 //dcache_put(dentry->d_sb, dentry);
816                 /* build the inode */
817                 switch (c_bhdr->c_mode & CPIO_FILE_MASK) {
818                         case (CPIO_DIRECTORY):
819                                 err = create_dir(parent->d_inode, dentry, c_bhdr->c_mode);
820                                 assert(!err);
821                                 break;
822                         case (CPIO_SYMLINK):
823                                 /* writing the '\0' is safe since the next entry is always still
824                                  * in the CPIO (and we are processing sequentially). */
825                                 symname = c_bhdr->c_filestart;
826                                 old_end = symname[c_bhdr->c_filesize];
827                                 symname[c_bhdr->c_filesize] = '\0';
828                                 err = create_symlink(parent->d_inode, dentry, symname,
829                                                      c_bhdr->c_mode & CPIO_PERM_MASK);
830                                 assert(!err);
831                                 symname[c_bhdr->c_filesize] = old_end;
832                                 break;
833                         case (CPIO_REG_FILE):
834                                 err = create_file(parent->d_inode, dentry,
835                                                   c_bhdr->c_mode & CPIO_PERM_MASK);
836                                 assert(!err);
837                                 ((struct kfs_i_info*)dentry->d_inode->i_fs_info)->filestart =
838                                                                                                                 c_bhdr->c_filestart;
839                                 ((struct kfs_i_info*)dentry->d_inode->i_fs_info)->init_size =
840                                                                                                                 c_bhdr->c_filesize;
841                                 break;
842                         default:
843                                 printk("Unknown file type %d in the CPIO!",
844                                        c_bhdr->c_mode & CPIO_FILE_MASK);
845                                 kref_put(&dentry->d_kref);
846                                 return -1;
847                 }
848                 inode = dentry->d_inode;
849                 /* Set other info from the CPIO entry */
850                 inode->i_uid = c_bhdr->c_uid;
851                 inode->i_gid = c_bhdr->c_gid;
852                 inode->i_atime.tv_sec = c_bhdr->c_mtime;
853                 inode->i_ctime.tv_sec = c_bhdr->c_mtime;
854                 inode->i_mtime.tv_sec = c_bhdr->c_mtime;
855                 inode->i_size = c_bhdr->c_filesize;
856                 //inode->i_XXX = c_bhdr->c_dev;                 /* and friends */
857                 inode->i_bdev = 0;                                              /* assuming blockdev? */
858                 inode->i_socket = FALSE;
859                 inode->i_blocks = c_bhdr->c_filesize;   /* blocksize == 1 */
860                 kref_put(&dentry->d_kref);
861         }
862         return 0;
863 }
864
865 /* Adds an entry (from a CPIO archive) to KFS.  This will put all the FS
866  * metadata in memory, instead of having to reparse the entire archive each time
867  * we need to traverse.
868  *
869  * The other option is to just maintain a LL of {FN, FS}, and O(n) scan it.
870  *
871  * The path is a complete path, interpreted from the root of the mount point.
872  * Directories have a size of 0.  so do symlinks, but we don't handle those yet.
873  *
874  * If a directory does not exist for a file, this will return an error.  Don't
875  * use the -depth flag to find when building the CPIO archive, and this won't be
876  * a problem.  (Maybe) */
877 static int add_kfs_entry(struct super_block *sb, struct cpio_bin_hdr *c_bhdr)
878 {
879         char *path = c_bhdr->c_filename;
880         /* Root of the FS, already part of KFS */
881         if (!strcmp(path, "."))
882                 return 0;
883         return __add_kfs_entry(sb->s_mount->mnt_root, path, c_bhdr);
884 }
885
886 void parse_cpio_entries(struct super_block *sb, void *cpio_b)
887 {
888         struct cpio_newc_header *c_hdr = (struct cpio_newc_header*)cpio_b;
889
890         char buf[9] = {0};      /* temp space for strol conversions */
891         size_t namesize = 0;
892         int offset = 0;         /* offset in the cpio archive */
893         struct cpio_bin_hdr *c_bhdr = kmalloc(sizeof(*c_bhdr), 0);
894         memset(c_bhdr, 0, sizeof(*c_bhdr));
895
896         /* read all files and paths */
897         for (; ; c_hdr = (struct cpio_newc_header*)(cpio_b + offset)) {
898                 offset += sizeof(*c_hdr);
899                 if (strncmp(c_hdr->c_magic, "070701", 6)) {
900                         printk("Invalid magic number in CPIO header, aborting.\n");
901                         return;
902                 }
903                 c_bhdr->c_filename = (char*)c_hdr + sizeof(*c_hdr);
904                 namesize = cpio_strntol(buf, c_hdr->c_namesize, 8);
905                 printd("Namesize: %d\n", size);
906                 if (!strcmp(c_bhdr->c_filename, "TRAILER!!!"))
907                         break;
908                 c_bhdr->c_ino = cpio_strntol(buf, c_hdr->c_ino, 8);
909                 c_bhdr->c_mode = (int)cpio_strntol(buf, c_hdr->c_mode, 8);
910                 c_bhdr->c_uid = cpio_strntol(buf, c_hdr->c_uid, 8);
911                 c_bhdr->c_gid = cpio_strntol(buf, c_hdr->c_gid, 8);
912                 c_bhdr->c_nlink = (unsigned int)cpio_strntol(buf, c_hdr->c_nlink, 8);
913                 c_bhdr->c_mtime = cpio_strntol(buf, c_hdr->c_mtime, 8);
914                 c_bhdr->c_filesize = cpio_strntol(buf, c_hdr->c_filesize, 8);
915                 c_bhdr->c_dev_maj = cpio_strntol(buf, c_hdr->c_dev_maj, 8);
916                 c_bhdr->c_dev_min = cpio_strntol(buf, c_hdr->c_dev_min, 8);
917                 c_bhdr->c_rdev_maj = cpio_strntol(buf, c_hdr->c_rdev_maj, 8);
918                 c_bhdr->c_rdev_min = cpio_strntol(buf, c_hdr->c_rdev_min, 8);
919                 printd("File: %s: %d Bytes\n", c_bhdr->c_filename, c_bhdr->c_filesize);
920                 offset += namesize;
921                 /* header + name will be padded out to 4-byte alignment */
922                 offset = ROUNDUP(offset, 4);
923                 c_bhdr->c_filestart = cpio_b + offset;
924                 /* make this a function pointer or something */
925                 if (add_kfs_entry(sb, c_bhdr)) {
926                         printk("Failed to add an entry to KFS!\n");
927                         break;
928                 }
929                 offset += c_bhdr->c_filesize;
930                 offset = ROUNDUP(offset, 4);
931                 //printk("offset is %d bytes\n", offset);
932                 c_hdr = (struct cpio_newc_header*)(cpio_b + offset);
933         }
934         kfree(c_bhdr);
935 }