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