ext2_dealloc_inode(), clarifies dealloc vs delete
[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 and will take
308  * the ref to the dentry for you.  Either way, you shouldn't use the ref you
309  * passed in anymore.  Still, there are issues with refcnting with this.
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                          * can free the one that came in and return the real one */
332                         kref_put(&dentry->d_kref);
333                         kref_get(&d_i->d_kref, 1);
334                         return d_i;
335                 }
336         }
337         TAILQ_FOREACH(d_i, &k_i_info->children, d_subdirs_link) {
338                 if (!strcmp(d_i->d_name.name, dentry->d_name.name)) {
339                         /* since this dentry is already in memory (that's how KFS works), we
340                          * can free the one that came in and return the real one */
341                         kref_put(&dentry->d_kref);
342                         kref_get(&d_i->d_kref, 1);
343                         return d_i;
344                 }
345         }
346         /* no match, consider caching the negative result, freeing the
347          * dentry, etc */
348         printd("Not Found %s!!\n", dentry->d_name.name);
349         kref_put(&dentry->d_kref);
350         return 0;
351 }
352
353 /* Hard link to old_dentry in directory dir with a name specified by new_dentry.
354  * At the very least, set the new_dentry's FS-specific fields. */
355 int kfs_link(struct dentry *old_dentry, struct inode *dir,
356              struct dentry *new_dentry)
357 {
358         assert(new_dentry->d_op = &kfs_d_op);
359         kref_get(&new_dentry->d_kref, 1);               /* pin the dentry, KFS-style */
360         /* KFS-style directory-tracking-of-kids */
361         TAILQ_INSERT_TAIL(&((struct kfs_i_info*)dir->i_fs_info)->children,
362                           new_dentry, d_subdirs_link);
363         return 0;
364 }
365
366 /* Removes the link from the dentry in the directory */
367 int kfs_unlink(struct inode *dir, struct dentry *dentry)
368 {
369         /* Stop tracking our child */
370         TAILQ_REMOVE(&((struct kfs_i_info*)dir->i_fs_info)->children, dentry,
371                      d_subdirs_link);
372         return 0;
373 }
374
375 /* Creates a new inode for a symlink dir, linking to / containing the name
376  * symname.  dentry is the controlling dentry of the inode. */
377 int kfs_symlink(struct inode *dir, struct dentry *dentry, const char *symname)
378 {
379         struct inode *inode = dentry->d_inode;
380         struct kfs_i_info *k_i_info = (struct kfs_i_info*)inode->i_fs_info;
381         size_t len = strlen(symname);
382         char *string = kmalloc(len + 1, 0);
383
384         kfs_init_inode(dir, dentry);
385         SET_FTYPE(inode->i_mode, __S_IFLNK);
386         inode->i_fop = &kfs_f_op_sym;
387         strncpy(string, symname, len);
388         string[len] = '\0';             /* symname should be \0d anyway, but just in case */
389         k_i_info->filestart = string;   /* reusing this void* to hold the char* */
390         return 0;
391 }
392
393 /* Called when creating a new inode for a directory associated with dentry in
394  * dir with the given mode.  Note, we might (later) need to track subdirs within
395  * the parent inode, like we do with regular files.  I'd rather not, so we'll
396  * see if we need it. */
397 int kfs_mkdir(struct inode *dir, struct dentry *dentry, int mode)
398 {
399         struct inode *inode = dentry->d_inode;
400         kref_get(&dentry->d_kref, 1);   /* to pin the dentry in RAM, KFS-style... */
401         inode->i_ino = kfs_get_free_ino();
402         SET_FTYPE(inode->i_mode, __S_IFDIR);
403         inode->i_fop = &kfs_f_op_dir;
404         /* get ready to have our own kids */
405         TAILQ_INIT(&((struct kfs_i_info*)inode->i_fs_info)->children);
406         ((struct kfs_i_info*)inode->i_fs_info)->filestart = 0;
407         return 0;
408 }
409
410 /* Removes from dir the directory 'dentry.'  KFS doesn't store anything in the
411  * inode for which children it has.  It probably should, but since everything is
412  * pinned, it just relies on the dentry connections. */
413 int kfs_rmdir(struct inode *dir, struct dentry *dentry)
414 {
415         struct kfs_i_info *d_info = (struct kfs_i_info*)dentry->d_inode->i_fs_info;
416         struct dentry *d_i;
417         bool empty = TRUE;
418         /* Check if we are empty.  If not, error out, need to check the sub-dirs as
419          * well as the sub-"files" */
420         TAILQ_FOREACH(d_i, &dentry->d_subdirs, d_subdirs_link) {
421                 empty = FALSE;
422                 break;
423         }
424         TAILQ_FOREACH(d_i, &d_info->children, d_subdirs_link) {
425                 empty = FALSE;
426                 break;
427         }
428         if (!empty)
429                 return -ENOTEMPTY;
430         return 0;
431 }
432
433 /* Used to make a generic file, based on the type and the major/minor numbers
434  * (in rdev), with the given mode.  As with others, this creates a new disk
435  * inode for the file */
436 int kfs_mknod(struct inode *dir, struct dentry *dentry, int mode, dev_t rdev)
437 {
438         return -1;
439 }
440
441 /* Moves old_dentry from old_dir to new_dentry in new_dir */
442 int kfs_rename(struct inode *old_dir, struct dentry *old_dentry,
443                struct inode *new_dir, struct dentry *new_dentry)
444 {
445         return -1;
446 }
447
448 /* Returns the char* for the symname for the given dentry.  The VFS code that
449  * calls this for real FS's might assume it's already read in, so if the char *
450  * isn't already in memory, we'd need to read it in here.  Regarding the char*
451  * storage, the char* only will last as long as the dentry and inode are in
452  * memory. */
453 char *kfs_readlink(struct dentry *dentry)
454 {
455         struct inode *inode = dentry->d_inode;
456         struct kfs_i_info *k_i_info = (struct kfs_i_info*)inode->i_fs_info;
457         if (!S_ISLNK(inode->i_mode))
458                 return 0;
459         return k_i_info->filestart;
460 }
461
462 /* Modifies the size of the file of inode to whatever its i_size is set to */
463 void kfs_truncate(struct inode *inode)
464 {
465 }
466
467 /* Checks whether the the access mode is allowed for the file belonging to the
468  * inode.  Implies that the permissions are on the file, and not the hardlink */
469 int kfs_permission(struct inode *inode, int mode, struct nameidata *nd)
470 {
471         return -1;
472 }
473
474
475 /* dentry_operations */
476 /* Determines if the dentry is still valid before using it to translate a path.
477  * Network FS's need to deal with this. */
478 int kfs_d_revalidate(struct dentry *dir, struct nameidata *nd)
479 { // default, nothing
480         return -1;
481 }
482
483 /* Produces the hash to lookup this dentry from the dcache */
484 int kfs_d_hash(struct dentry *dentry, struct qstr *name)
485 {
486         return -1;
487 }
488
489 /* Compares name1 and name2.  name1 should be a member of dir. */
490 int kfs_d_compare(struct dentry *dir, struct qstr *name1, struct qstr *name2)
491 { // default, string comp (case sensitive)
492         return -1;
493 }
494
495 /* Called when the last ref is deleted (refcnt == 0) */
496 int kfs_d_delete(struct dentry *dentry)
497 { // default, nothin
498         return -1;
499 }
500
501 /* Called when it's about to be slab-freed */
502 int kfs_d_release(struct dentry *dentry)
503 {
504         return -1;
505 }
506
507 /* Called when the dentry loses it's inode (becomes "negative") */
508 void kfs_d_iput(struct dentry *dentry, struct inode *inode)
509 { // default, call i_put to release the inode object
510 }
511
512
513 /* file_operations */
514
515 /* Updates the file pointer.  KFS doesn't let you go past the end of a file
516  * yet, so it won't let you seek past either.  TODO: think about locking. */
517 off_t kfs_llseek(struct file *file, off_t offset, int whence)
518 {
519         off_t temp_off = 0;
520         switch (whence) {
521                 case SEEK_SET:
522                         temp_off = offset;
523                         break;
524                 case SEEK_CUR:
525                         temp_off = file->f_pos + offset;
526                         break;
527                 case SEEK_END:
528                         temp_off = file->f_dentry->d_inode->i_size + offset;
529                         break;
530                 default:
531                         set_errno(EINVAL);
532                         warn("Unknown 'whence' in llseek()!\n");
533                         return -1;
534         }
535         /* make sure the f_pos isn't outside the limits of the existing file.
536          * techincally, if they go too far, we should return EINVAL */
537         temp_off = MAX(MIN(temp_off, file->f_dentry->d_inode->i_size), 0);
538         file->f_pos = temp_off;
539         return temp_off;
540 }
541
542 /* Fills in the next directory entry (dirent), starting with d_off.  KFS treats
543  * the size of each dirent as 1 byte, which we can get away with since the d_off
544  * is a way of communicating with future calls to readdir (FS-specific).
545  *
546  * Like with read and write, there will be issues with userspace and the *dirent
547  * buf.  TODO: we don't really do anything with userspace concerns here, in part
548  * because memcpy_to doesn't work well.  When we fix how we want to handle the
549  * userbuffers, we can write this accordingly. (UMEM)  */
550 int kfs_readdir(struct file *dir, struct dirent *dirent)
551 {
552         int count = 2;  /* total num dirents, gets incremented in check_entry() */
553         int desired_file = dirent->d_off;
554         bool found = FALSE;
555         struct dentry *subent;
556         struct dentry *dir_d = dir->f_dentry;
557         struct kfs_i_info *k_i_info = (struct kfs_i_info*)dir_d->d_inode->i_fs_info;
558
559         /* how we check inside the for loops below.  moderately ghetto. */
560         void check_entry(void)
561         {
562                 if (count++ == desired_file) {
563                         dirent->d_ino = subent->d_inode->i_ino;
564                         dirent->d_off = count;
565                         dirent->d_reclen = subent->d_name.len;
566                         /* d_name.name is null terminated, the byte after d_name.len */
567                         assert(subent->d_name.len <= MAX_FILENAME_SZ);
568                         strncpy(dirent->d_name, subent->d_name.name, subent->d_name.len +1);
569                         found = TRUE;
570                 }
571         }
572
573         /* Handle . and .. (first two dirents) */
574         if (desired_file == 0) {
575                 dirent->d_ino = dir_d->d_inode->i_ino;
576                 dirent->d_off = 1;
577                 dirent->d_reclen = 1;
578                 strncpy(dirent->d_name, ".", 2);        /* the extra is for the null term */
579                 found = TRUE;
580         } else if (desired_file == 1) {
581                 dirent->d_ino = dir_d->d_parent->d_inode->i_ino;
582                 dirent->d_off = 2;
583                 dirent->d_reclen = 2;
584                 strncpy(dirent->d_name, "..", 3);       /* the extra is for the null term */
585                 found = TRUE;
586         }
587         /* need to check the sub-dirs as well as the sub-"files".  The main
588          * ghetto-ness with this is that we check even though we have our result,
589          * simply to figure out how big our directory is.  It's just not worth
590          * changing at this point. */
591         TAILQ_FOREACH(subent, &dir_d->d_subdirs, d_subdirs_link)
592                 check_entry();
593         TAILQ_FOREACH(subent, &k_i_info->children, d_subdirs_link)
594                 check_entry();
595         if (!found)
596                 return -ENOENT;
597         if (count - 1 == desired_file)          /* found the last dir in the list */
598                 return 0;
599         return 1;                                                       /* normal success for readdir */
600 }
601
602 /* This is called when a VMR is mapping a particular file.  The FS needs to do
603  * whatever it needs so that faults can be handled by read_page(), and handle all
604  * of the cases of MAP_SHARED, MAP_PRIVATE, whatever.  It also needs to ensure
605  * the file is not being mmaped in a way that conflicts with the manner in which
606  * the file was opened or the file type. */
607 int kfs_mmap(struct file *file, struct vm_region *vmr)
608 {
609         if (S_ISREG(file->f_dentry->d_inode->i_mode))
610                 return 0;
611         return -1;
612 }
613
614 /* Called by the VFS while opening the file, which corresponds to inode,  for
615  * the FS to do whatever it needs. */
616 int kfs_open(struct inode *inode, struct file *file)
617 {
618         return 0;
619 }
620
621 /* Called when a file descriptor is closed. */
622 int kfs_flush(struct file *file)
623 {
624         return -1;
625 }
626
627 /* Called when the file is about to be closed (file obj freed) */
628 int kfs_release(struct inode *inode, struct file *file)
629 {
630         return 0;
631 }
632
633 /* Flushes the file's dirty contents to disc */
634 int kfs_fsync(struct file *file, struct dentry *dentry, int datasync)
635 {
636         return -1;
637 }
638
639 /* Traditionally, sleeps until there is file activity.  We probably won't
640  * support this, or we'll handle it differently. */
641 unsigned int kfs_poll(struct file *file, struct poll_table_struct *poll_table)
642 {
643         return -1;
644 }
645
646 /* Reads count bytes from a file, starting from (and modifiying) offset, and
647  * putting the bytes into buffers described by vector */
648 ssize_t kfs_readv(struct file *file, const struct iovec *vector,
649                   unsigned long count, off_t *offset)
650 {
651         return -1;
652 }
653
654 /* Writes count bytes to a file, starting from (and modifiying) offset, and
655  * taking the bytes from buffers described by vector */
656 ssize_t kfs_writev(struct file *file, const struct iovec *vector,
657                   unsigned long count, off_t *offset)
658 {
659         return -1;
660 }
661
662 /* Write the contents of file to the page.  Will sort the params later */
663 ssize_t kfs_sendpage(struct file *file, struct page *page, int offset,
664                      size_t size, off_t pos, int more)
665 {
666         return -1;
667 }
668
669 /* Checks random FS flags.  Used by NFS. */
670 int kfs_check_flags(int flags)
671 { // default, nothing
672         return -1;
673 }
674
675 /* Redeclaration and initialization of the FS ops structures */
676 struct page_map_operations kfs_pm_op = {
677         kfs_readpage,
678 };
679
680 struct super_operations kfs_s_op = {
681         kfs_alloc_inode,
682         kfs_dealloc_inode,
683         kfs_read_inode,
684         kfs_dirty_inode,
685         kfs_write_inode,
686         kfs_put_inode,
687         kfs_drop_inode,
688         kfs_delete_inode,
689         kfs_put_super,
690         kfs_write_super,
691         kfs_sync_fs,
692         kfs_remount_fs,
693         kfs_umount_begin,
694 };
695
696 struct inode_operations kfs_i_op = {
697         kfs_create,
698         kfs_lookup,
699         kfs_link,
700         kfs_unlink,
701         kfs_symlink,
702         kfs_mkdir,
703         kfs_rmdir,
704         kfs_mknod,
705         kfs_rename,
706         kfs_readlink,
707         kfs_truncate,
708         kfs_permission,
709 };
710
711 struct dentry_operations kfs_d_op = {
712         kfs_d_revalidate,
713         kfs_d_hash,
714         kfs_d_compare,
715         kfs_d_delete,
716         kfs_d_release,
717         kfs_d_iput,
718 };
719
720 struct file_operations kfs_f_op_file = {
721         kfs_llseek,
722         generic_file_read,
723         generic_file_write,
724         kfs_readdir,
725         kfs_mmap,
726         kfs_open,
727         kfs_flush,
728         kfs_release,
729         kfs_fsync,
730         kfs_poll,
731         kfs_readv,
732         kfs_writev,
733         kfs_sendpage,
734         kfs_check_flags,
735 };
736
737 struct file_operations kfs_f_op_dir = {
738         kfs_llseek,
739         generic_dir_read,
740         0,
741         kfs_readdir,
742         kfs_mmap,
743         kfs_open,
744         kfs_flush,
745         kfs_release,
746         kfs_fsync,
747         kfs_poll,
748         kfs_readv,
749         kfs_writev,
750         kfs_sendpage,
751         kfs_check_flags,
752 };
753
754 struct file_operations kfs_f_op_sym = {
755         kfs_llseek,
756         generic_file_read,
757         generic_file_write,
758         kfs_readdir,
759         kfs_mmap,
760         kfs_open,
761         kfs_flush,
762         kfs_release,
763         kfs_fsync,
764         kfs_poll,
765         kfs_readv,
766         kfs_writev,
767         kfs_sendpage,
768         kfs_check_flags,
769 };
770
771 /* KFS Specific Internal Functions */
772
773 /* Need to pass path separately, since we'll recurse on it.  TODO: this recurses,
774  * and takes up a lot of stack space (~270 bytes).  Core 0's KSTACK is 8 pages,
775  * which can handle about 120 levels deep...  Other cores are not so fortunate.
776  * Can rework this if it becomes an issue. */
777 static int __add_kfs_entry(struct dentry *parent, char *path,
778                            struct cpio_bin_hdr *c_bhdr)
779 {
780         char *first_slash = strchr(path, '/');  
781         char dir[MAX_FILENAME_SZ + 1];  /* room for the \0 */
782         size_t dirname_sz;                              /* not counting the \0 */
783         struct dentry *dentry = 0;
784         struct inode *inode;
785         int err;
786         char *symname, old_end;                 /* for symlink manipulation */
787
788         if (first_slash) {
789                 /* get the first part, find that dentry, pass in the second part,
790                  * recurse.  this isn't being smart about extra slashes, dots, or
791                  * anything like that. */
792                 dirname_sz = first_slash - path;
793                 assert(dirname_sz <= MAX_FILENAME_SZ);
794                 strncpy(dir, path, dirname_sz);
795                 dir[dirname_sz] = '\0';
796                 printd("Finding DIR %s in dentry %s (start: %p, size %d)\n", dir,
797                        parent->d_name.name, c_bhdr->c_filestart, c_bhdr->c_filesize);
798                 /* Need to create a dentry for the lookup, and fill in the basic nd */
799                 dentry = get_dentry(parent->d_sb, parent, dir);
800                 /* TODO: use a VFS lookup instead, to use the dcache, thought its not a
801                  * big deal since KFS currently pins all metadata. */
802                 dentry = kfs_lookup(parent->d_inode, dentry, 0);
803                 if (!dentry) {
804                         printk("Missing dir in CPIO archive or something, aborting.\n");
805                         return -1;
806                 }
807                 return __add_kfs_entry(dentry, first_slash + 1, c_bhdr);
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                 dcache_put(dentry);                     /* TODO: should set a d_flag too */
815                 /* build the inode */
816                 switch (c_bhdr->c_mode & CPIO_FILE_MASK) {
817                         case (CPIO_DIRECTORY):
818                                 err = create_dir(parent->d_inode, dentry, c_bhdr->c_mode);
819                                 assert(!err);
820                                 break;
821                         case (CPIO_SYMLINK):
822                                 /* writing the '\0' is safe since the next entry is always still
823                                  * in the CPIO (and we are processing sequentially). */
824                                 symname = c_bhdr->c_filestart;
825                                 old_end = symname[c_bhdr->c_filesize];
826                                 symname[c_bhdr->c_filesize] = '\0';
827                                 err = create_symlink(parent->d_inode, dentry, symname,
828                                                      c_bhdr->c_mode & CPIO_PERM_MASK);
829                                 assert(!err);
830                                 symname[c_bhdr->c_filesize] = old_end;
831                                 break;
832                         case (CPIO_REG_FILE):
833                                 err = create_file(parent->d_inode, dentry,
834                                                   c_bhdr->c_mode & CPIO_PERM_MASK);
835                                 assert(!err);
836                                 ((struct kfs_i_info*)dentry->d_inode->i_fs_info)->filestart =
837                                                                                                                 c_bhdr->c_filestart;
838                                 ((struct kfs_i_info*)dentry->d_inode->i_fs_info)->init_size =
839                                                                                                                 c_bhdr->c_filesize;
840                                 break;
841                         default:
842                                 printk("Unknown file type %d in the CPIO!",
843                                        c_bhdr->c_mode & CPIO_FILE_MASK);
844                                 return -1;
845                 }
846                 inode = dentry->d_inode;
847                 /* Set other info from the CPIO entry */
848                 inode->i_uid = c_bhdr->c_uid;
849                 inode->i_gid = c_bhdr->c_gid;
850                 inode->i_atime.tv_sec = c_bhdr->c_mtime;
851                 inode->i_ctime.tv_sec = c_bhdr->c_mtime;
852                 inode->i_mtime.tv_sec = c_bhdr->c_mtime;
853                 inode->i_size = c_bhdr->c_filesize;
854                 //inode->i_XXX = c_bhdr->c_dev;                 /* and friends */
855                 inode->i_bdev = 0;                                              /* assuming blockdev? */
856                 inode->i_socket = FALSE;
857                 inode->i_blocks = c_bhdr->c_filesize;   /* blocksize == 1 */
858         }
859         return 0;
860 }
861
862 /* Adds an entry (from a CPIO archive) to KFS.  This will put all the FS
863  * metadata in memory, instead of having to reparse the entire archive each time
864  * we need to traverse.
865  *
866  * The other option is to just maintain a LL of {FN, FS}, and O(n) scan it.
867  *
868  * The path is a complete path, interpreted from the root of the mount point.
869  * Directories have a size of 0.  so do symlinks, but we don't handle those yet.
870  *
871  * If a directory does not exist for a file, this will return an error.  Don't
872  * use the -depth flag to find when building the CPIO archive, and this won't be
873  * a problem.  (Maybe) */
874 static int add_kfs_entry(struct super_block *sb, struct cpio_bin_hdr *c_bhdr)
875 {
876         char *path = c_bhdr->c_filename;
877         /* Root of the FS, already part of KFS */
878         if (!strcmp(path, "."))
879                 return 0;
880         return __add_kfs_entry(sb->s_mount->mnt_root, path, c_bhdr);
881 }
882
883 void parse_cpio_entries(struct super_block *sb, void *cpio_b)
884 {
885         struct cpio_newc_header *c_hdr = (struct cpio_newc_header*)cpio_b;
886
887         char buf[9] = {0};      /* temp space for strol conversions */
888         size_t namesize = 0;
889         int offset = 0;         /* offset in the cpio archive */
890         struct cpio_bin_hdr *c_bhdr = kmalloc(sizeof(*c_bhdr), 0);
891         memset(c_bhdr, 0, sizeof(*c_bhdr));
892
893         /* read all files and paths */
894         for (; ; c_hdr = (struct cpio_newc_header*)(cpio_b + offset)) {
895                 offset += sizeof(*c_hdr);
896                 if (strncmp(c_hdr->c_magic, "070701", 6)) {
897                         printk("Invalid magic number in CPIO header, aborting.\n");
898                         return;
899                 }
900                 c_bhdr->c_filename = (char*)c_hdr + sizeof(*c_hdr);
901                 namesize = cpio_strntol(buf, c_hdr->c_namesize, 8);
902                 printd("Namesize: %d\n", size);
903                 if (!strcmp(c_bhdr->c_filename, "TRAILER!!!"))
904                         break;
905                 c_bhdr->c_ino = cpio_strntol(buf, c_hdr->c_ino, 8);
906                 c_bhdr->c_mode = (int)cpio_strntol(buf, c_hdr->c_mode, 8);
907                 c_bhdr->c_uid = cpio_strntol(buf, c_hdr->c_uid, 8);
908                 c_bhdr->c_gid = cpio_strntol(buf, c_hdr->c_gid, 8);
909                 c_bhdr->c_nlink = (unsigned int)cpio_strntol(buf, c_hdr->c_nlink, 8);
910                 c_bhdr->c_mtime = cpio_strntol(buf, c_hdr->c_mtime, 8);
911                 c_bhdr->c_filesize = cpio_strntol(buf, c_hdr->c_filesize, 8);
912                 c_bhdr->c_dev_maj = cpio_strntol(buf, c_hdr->c_dev_maj, 8);
913                 c_bhdr->c_dev_min = cpio_strntol(buf, c_hdr->c_dev_min, 8);
914                 c_bhdr->c_rdev_maj = cpio_strntol(buf, c_hdr->c_rdev_maj, 8);
915                 c_bhdr->c_rdev_min = cpio_strntol(buf, c_hdr->c_rdev_min, 8);
916                 printd("File: %s: %d Bytes\n", c_bhdr->c_filename, c_bhdr->c_filesize);
917                 offset += namesize;
918                 /* header + name will be padded out to 4-byte alignment */
919                 offset = ROUNDUP(offset, 4);
920                 c_bhdr->c_filestart = cpio_b + offset;
921                 /* make this a function pointer or something */
922                 if (add_kfs_entry(sb, c_bhdr)) {
923                         printk("Failed to add an entry to KFS!\n");
924                         break;
925                 }
926                 offset += c_bhdr->c_filesize;
927                 offset = ROUNDUP(offset, 4);
928                 //printk("offset is %d bytes\n", offset);
929                 c_hdr = (struct cpio_newc_header*)(cpio_b + offset);
930         }
931         kfree(c_bhdr);
932 }