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