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