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