sys_open() and sys_close()
[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
28 #define KFS_MAX_FILE_SIZE 1024*1024*128
29 #define KFS_MAGIC 0xdead0001
30
31 /* VFS required Functions */
32 /* These structs are declared again and initialized farther down */
33 struct page_map_operations kfs_pm_op;
34 struct super_operations kfs_s_op;
35 struct inode_operations kfs_i_op;
36 struct dentry_operations kfs_d_op;
37 struct file_operations kfs_f_op;
38
39 /* TODO: something more better.  Prob something like the vmem cache, for this,
40  * pids, etc.  Good enough for now.  This also means we can only have one
41  * KFS instance, and we also aren't synchronizing access. */
42 static unsigned long kfs_get_free_ino(void)
43 {
44         static unsigned long last_ino = 1;       /* 1 is reserved for the root */
45         last_ino++;
46         if (!last_ino)
47                 panic("Out of inos in KFS!");
48         return last_ino;
49 }
50
51 /* Slabs for KFS specific info chunks */
52 struct kmem_cache *kfs_i_kcache;
53
54 static void kfs_init(void)
55 {
56         kfs_i_kcache = kmem_cache_create("kfs_ino_info", sizeof(struct kfs_i_info),
57                                          __alignof__(struct kfs_i_info), 0, 0, 0);
58 }
59
60 /* Creates the SB (normally would read in from disc and create).  Ups the refcnt
61  * for whoever consumes this.  Returns 0 on failure.
62  * TODO: consider pulling out more of the FS-independent stuff, if possible.
63  * There are only two things, but the pain in the ass is that you'd need to read
64  * the disc to get that first inode, and it's a FS-specific thing. */
65 struct super_block *kfs_get_sb(struct fs_type *fs, int flags,
66                                char *dev_name, struct vfsmount *vmnt)
67 {
68         /* Ought to check that dev_name has our FS on it.  in this case, it's
69          * irrelevant. */
70         //if (something_bad)
71         //      return 0;
72         static bool ran_once = FALSE;
73         if (!ran_once) {
74                 ran_once = TRUE;
75                 kfs_init();
76         }
77
78         /* Build and init the SB.  No need to read off disc. */
79         struct super_block *sb = get_sb();
80         sb->s_dev = 0;
81         sb->s_blocksize = 1;
82         sb->s_maxbytes = KFS_MAX_FILE_SIZE;
83         sb->s_type = &kfs_fs_type;
84         sb->s_op = &kfs_s_op;
85         sb->s_flags = flags;
86         sb->s_magic = KFS_MAGIC;
87         sb->s_mount = vmnt;
88         sb->s_syncing = FALSE;
89         sb->s_bdev = 0;
90         strlcpy(sb->s_name, "KFS", 32);
91         /* store the location of the CPIO archive.  make this more generic later. */
92         extern uint8_t _binary_obj_kern_initramfs_cpio_size[];
93         extern uint8_t _binary_obj_kern_initramfs_cpio_start[];
94         sb->s_fs_info = (void*)_binary_obj_kern_initramfs_cpio_start;
95
96         /* Final stages of initializing the sb, mostly FS-independent */
97         /* 1 is the KFS root ino (inode number) */
98         init_sb(sb, vmnt, &kfs_d_op, 1, 0);
99         /* Parses the CPIO entries and builds the in-memory KFS tree. */
100         parse_cpio_entries(sb, sb->s_fs_info);
101         printk("KFS superblock loaded\n");
102         return sb;
103 }
104
105 void kfs_kill_sb(struct super_block *sb)
106 {
107         panic("Killing KFS is not supported!");
108 }
109
110 /* Every FS must have a static FS Type, with which the VFS code can bootstrap */
111 struct fs_type kfs_fs_type = {"KFS", 0, kfs_get_sb, kfs_kill_sb, {0, 0},
112                TAILQ_HEAD_INITIALIZER(kfs_fs_type.fs_supers)};
113
114 /* Page Map Operations */
115
116 /* Fills page with its contents from its backing store file.  Note that we do
117  * the zero padding here, instead of higher in the VFS.  Might change in the
118  * future. */
119 int kfs_readpage(struct file *file, struct page *page)
120 {
121         size_t pg_idx_byte = page->pg_index * PGSIZE;
122         struct kfs_i_info *k_i_info = (struct kfs_i_info*)file->f_inode->i_fs_info;
123         uintptr_t begin = (size_t)k_i_info->filestart + pg_idx_byte;
124         /* If we're beyond the initial start point, we just need a zero page.  This
125          * is for a hole or for extending a file (even though it won't be saved).
126          * Otherwise, we want the data from KFS, being careful to not copy from
127          * beyond the original EOF (and zero padding anything extra). */
128         if (pg_idx_byte >= k_i_info->init_size) {
129                 memset(page2kva(page), 0, PGSIZE);
130         } else {
131                 size_t copy_amt = MIN(PGSIZE, k_i_info->init_size - pg_idx_byte);
132                 memcpy(page2kva(page), (void*)begin, copy_amt);
133                 memset(page2kva(page) + copy_amt, 0, PGSIZE - copy_amt);
134         }
135         /* This is supposed to be done in the IO system when the operation is
136          * complete.  Since we aren't doing a real IO request, and it is already
137          * done, we can do it here. */
138         page->pg_flags |= PG_UPTODATE;
139         unlock_page(page);
140         return 0;
141 }
142
143 /* Super Operations */
144
145 /* creates and initializes a new inode.  generic fields are filled in.  specific
146  * fields are filled in in read_inode() based on what's on the disk for a given
147  * i_no.  i_no is set by the caller.  Note that this means this inode can be for
148  * an inode that is already on disk, or it can be used when creating. */
149 struct inode *kfs_alloc_inode(struct super_block *sb)
150 {
151         /* arguably, we can avoid some of this init by using the slab/cache */
152         struct inode *inode = kmem_cache_alloc(inode_kcache, 0);
153         memset(inode, 0, sizeof(struct inode));
154         TAILQ_INSERT_HEAD(&sb->s_inodes, inode, i_sb_list);
155         TAILQ_INIT(&inode->i_dentry);
156         inode->i_ino = 0;                                       /* set by caller later */
157         atomic_set(&inode->i_refcnt, 1);
158         inode->i_blksize = 1;                           /* keep in sync with get_sb() */
159         spinlock_init(&inode->i_lock);
160         inode->i_op = &kfs_i_op;
161         inode->i_fop = &kfs_f_op;
162         inode->i_sb = sb;
163         inode->i_state = 0;                                     /* need real states, want I_NEW */
164         inode->dirtied_when = 0;
165         atomic_set(&inode->i_writecount, 0);
166         inode->i_fs_info = kmem_cache_alloc(kfs_i_kcache, 0);
167         TAILQ_INIT(&((struct kfs_i_info*)inode->i_fs_info)->children);
168         ((struct kfs_i_info*)inode->i_fs_info)->filestart = 0;
169         /* Set up the page_map structures.  Default is to use the embedded one. */
170         inode->i_mapping = &inode->i_pm;
171         inode->i_mapping->pm_host = inode;
172         radix_tree_init(&inode->i_mapping->pm_tree);
173         spinlock_init(&inode->i_mapping->pm_tree_lock);
174         inode->i_mapping->pm_op = &kfs_pm_op;
175         inode->i_mapping->pm_flags = 0;
176         return inode;
177         /* caller sets i_ino, i_list set when applicable */
178 }
179
180 /* deallocs and cleans up after an inode. */
181 void kfs_destroy_inode(struct inode *inode)
182 {
183         kmem_cache_free(kfs_i_kcache, inode->i_fs_info);
184         kmem_cache_free(inode_kcache, inode);
185 }
186
187 /* reads the inode data on disk specified by inode->i_ino into the inode.
188  * basically, it's a "make this inode the one for i_ino (i number)" */
189 void kfs_read_inode(struct inode *inode)
190 {
191         /* need to do something to link this inode/file to the actual "blocks" on
192          * "disk". */
193
194         /* TODO: what does it mean to ask for an inode->i_ino that doesn't exist?
195          *      possibly a bug, since these inos come from directories */
196         if (inode->i_ino == 1) {
197                 inode->i_mode = 0x777;                  /* TODO: use something appropriate */
198                 inode->i_type = FS_I_DIR;
199                 inode->i_nlink = 1;                             /* assuming only one hardlink */
200                 inode->i_uid = 0;
201                 inode->i_gid = 0;
202                 inode->i_rdev = 0;
203                 inode->i_size = 0;                              /* make sense for KFS? */
204                 inode->i_atime.tv_sec = 0;
205                 inode->i_atime.tv_nsec = 0;
206                 inode->i_mtime.tv_sec = 0;
207                 inode->i_mtime.tv_nsec = 0;
208                 inode->i_ctime.tv_sec = 0;
209                 inode->i_ctime.tv_nsec = 0;
210                 inode->i_blocks = 0;
211                 inode->i_bdev = 0;                              /* assuming blockdev? */
212                 inode->i_flags = 0;
213                 inode->i_socket = FALSE;
214         } else {
215                 panic("Not implemented");
216         }
217         /* TODO: unused: inode->i_hash add to hash (saves on disc reading) */
218 }
219
220 /* called when an inode in memory is modified (journalling FS's care) */
221 void kfs_dirty_inode(struct inode *inode)
222 {       // KFS doesn't care
223 }
224
225 /* write the inode to disk (specifically, to inode inode->i_ino), synchronously
226  * if we're asked to wait */
227 void kfs_write_inode(struct inode *inode, bool wait)
228 {       // KFS doesn't care
229 }
230
231 /* called when an inode is decref'd, to do any FS specific work */
232 void kfs_put_inode(struct inode *inode)
233 {       // KFS doesn't care
234 }
235
236 /* called when an inode is about to be destroyed.  the generic version ought to
237  * remove every reference to the inode from the VFS, and if the inode isn't in
238  * any directory, calls delete_inode */
239 void kfs_drop_inode(struct inode *inode)
240 { // TODO: should call a generic one instead.  or at least do something...
241         // remove from lists
242 }
243
244 /* delete the inode from disk (all data) and deallocs the in memory inode */
245 void kfs_delete_inode(struct inode *inode)
246 {
247         // would remove from "disk" here
248         kfs_destroy_inode(inode);
249 }
250
251 /* unmount and release the super block */
252 void kfs_put_super(struct super_block *sb)
253 {
254         panic("Shazbot! KFS can't be unmounted yet!");
255 }
256
257 /* updates the on-disk SB with the in-memory SB */
258 void kfs_write_super(struct super_block *sb)
259 {       // KFS doesn't care
260 }
261
262 /* syncs FS metadata with the disc, synchronously if we're waiting.  this info
263  * also includes anything pointed to by s_fs_info. */
264 int kfs_sync_fs(struct super_block *sb, bool wait)
265 {
266         return 0;
267 }
268
269 /* remount the FS with the new flags */
270 int kfs_remount_fs(struct super_block *sb, int flags, char *data)
271 {
272         warn("KFS will not remount.");
273         return -1; // can't remount
274 }
275
276 /* interrupts a mount operation - used by NFS and friends */
277 void kfs_umount_begin(struct super_block *sb)
278 {
279         panic("Cannot abort a KFS mount, and why would you?");
280 }
281
282 /* inode_operations */
283
284 /* Helper op, used when creating regular files (kfs_create()) and when making
285  * directories (kfs_mkdir()).  References are a bit ugly.  We're passing out a
286  * ref that is already stored/accounted for.  Might change that...  Also, this
287  * needs to handle having nd == 0.  Note we make a distinction between the mode
288  * and the file type (for now).  The caller of this should set the filetype. */
289 struct inode *kfs_create_generic(struct inode *dir, struct dentry *dentry,
290                                  int mode, struct nameidata *nd)
291 {
292         /* note it is the i_ino that uniquely identifies a file in the system.
293          * there's a diff between creating an inode (even for an in-use ino) and
294          * then filling it in, and vs creating a brand new one */
295         struct inode *inode = kfs_alloc_inode(dentry->d_sb);
296         dentry->d_inode = inode;                /* inode ref stored here */
297         TAILQ_INSERT_TAIL(&inode->i_dentry, dentry, d_alias); /* stored dentry ref*/
298         atomic_inc(&dentry->d_refcnt);  /* TODO: REF/KREF */
299         /* Need to finish the dentry */
300         dentry->d_op = &kfs_d_op;
301         dentry->d_fs_info = 0;
302         inode->i_mode = mode;
303         inode->i_ino = kfs_get_free_ino();
304         inode->i_nlink = 1;
305         inode->i_size = 0;
306         inode->i_blocks = 0;
307         inode->i_atime.tv_sec = 0;              /* TODO: now! */
308         inode->i_ctime.tv_sec = 0;              /* TODO: now! */
309         inode->i_mtime.tv_sec = 0;              /* TODO: now! */
310         inode->i_atime.tv_nsec = 0;             /* are these supposed to be the extra ns? */
311         inode->i_ctime.tv_nsec = 0;
312         inode->i_mtime.tv_nsec = 0;
313         inode->i_bdev = inode->i_sb->s_bdev;
314         return inode;
315 }
316
317 /* Create a new disk inode in dir associated with dentry, with the given mode.
318  * called when creating a regular file.  dir is the directory/parent.  dentry is
319  * the dentry of the inode we are creating. */
320 int kfs_create(struct inode *dir, struct dentry *dentry, int mode,
321                struct nameidata *nd)
322 {
323         struct inode *inode = kfs_create_generic(dir, dentry, mode, nd);        
324         if (!inode)
325                 return -1;
326         inode->i_type = FS_I_FILE;
327         /* our parent dentry's inode tracks our dentry info.  We do this
328          * since it's all in memory and we aren't using the dcache yet.
329          * We're reusing the subdirs link, which is used by the VFS when
330          * we're a directory.  But since we're a file, it's okay to reuse
331          * it. */
332         TAILQ_INSERT_TAIL(&((struct kfs_i_info*)dir->i_fs_info)->children,
333                           dentry, d_subdirs_link);
334         /* fs_info->filestart is set by the caller, or else when first written (for
335          * new files.  it was set to 0 in alloc_inode(). */
336         return 0;
337 }
338
339 /* Searches the directory for the filename in the dentry, filling in the dentry
340  * with the FS specific info of this file.  If it succeeds, it will pass back
341  * the *dentry you should use.  If this fails, it will return 0 and will take
342  * the ref to the dentry for you.  Either way, you shouldn't use the ref you
343  * passed in anymore.  Still, there are issues with refcnting with this.
344  *
345  * Callers, make sure you alloc and fill out the name parts of the dentry, and
346  * an initialized nameidata. TODO: not sure why we need an ND.  Don't use it in
347  * a fs_lookup for now!
348  *
349  * Because of the way KFS currently works, if there is ever a dentry, it's
350  * already in memory, along with its inode (all path's pinned).  So we just find
351  * it and return it, freeing the one that came in. */
352 struct dentry *kfs_lookup(struct inode *dir, struct dentry *dentry,
353                           struct nameidata *nd)
354 {
355         struct kfs_i_info *k_i_info = (struct kfs_i_info*)dir->i_fs_info;
356         struct dentry *dir_dent = TAILQ_FIRST(&dir->i_dentry);
357         struct dentry *d_i;
358
359         assert(dir_dent && dir_dent == TAILQ_LAST(&dir->i_dentry, dentry_tailq));
360         assert(dir->i_type & FS_I_DIR);
361
362         TAILQ_FOREACH(d_i, &dir_dent->d_subdirs, d_subdirs_link) {
363                 if (!strcmp(d_i->d_name.name, dentry->d_name.name)) {
364                         /* since this dentry is already in memory (that's how KFS works), we
365                          * can free the one that came in and return the real one */
366                         kmem_cache_free(dentry_kcache, dentry);
367                         return d_i;
368                 }
369         }
370         TAILQ_FOREACH(d_i, &k_i_info->children, d_subdirs_link) {
371                 if (!strcmp(d_i->d_name.name, dentry->d_name.name)) {
372                         /* since this dentry is already in memory (that's how KFS works), we
373                          * can free the one that came in and return the real one */
374                         kmem_cache_free(dentry_kcache, dentry);
375                         return d_i;
376                 }
377         }
378         /* no match, consider caching the negative result, freeing the
379          * dentry, etc */
380         printd("Not Found %s!!\n", dentry->d_name.name);
381         free_dentry(dentry);
382         return 0;
383 }
384
385 /* Hard link to old_dentry in directory dir with a name specified by new_dentry.
386  * TODO: should this also make the dentry linkage, or just discard everything?*/
387 int kfs_link(struct dentry *old_dentry, struct inode *dir,
388              struct dentry *new_dentry)
389 {
390         return -1;
391 }
392
393 /* Removes the link from the dentry in the directory */
394 int kfs_unlink(struct inode *dir, struct dentry *dentry)
395 {
396         return -1;
397 }
398
399 /* Creates a new inode for a symlink named symname in dir, and links to dentry.
400  * */
401 int kfs_symlink(struct inode *dir, struct dentry *dentry, const char *symname)
402 {
403         return -1;
404 }
405
406 /* Creates a new inode for a directory associated with dentry in dir with the
407  * given mode.  Note, we might (later) need to track subdirs within the parent
408  * inode, like we do with regular files.  I'd rather not, so we'll see if we
409  * need it. */
410 int kfs_mkdir(struct inode *dir, struct dentry *dentry, int mode)
411 {
412         struct inode *inode = kfs_create_generic(dir, dentry, mode, 0); 
413         if (!inode)
414                 return -1;
415         struct dentry *parent = TAILQ_FIRST(&dir->i_dentry);
416         assert(parent && parent == TAILQ_LAST(&dir->i_dentry, dentry_tailq));
417         inode->i_type = FS_I_DIR;
418         /* parent dentry tracks dentry as a subdir */
419         TAILQ_INSERT_TAIL(&parent->d_subdirs, dentry, d_subdirs_link);
420         atomic_inc(&dentry->d_refcnt);
421         /* get ready to have our own kids */
422         TAILQ_INIT(&((struct kfs_i_info*)inode->i_fs_info)->children);
423         ((struct kfs_i_info*)inode->i_fs_info)->filestart = 0;
424         return 0;
425 }
426
427 /* Removes from dir the directory specified by the name in dentry. */
428 // TODO: note this isn't necessarily the same dentry, just using it for the
429 // naming (which seems to be a common way of doing things, like in lookup() -
430 // can work either way.
431 int kfs_rmdir(struct inode *dir, struct dentry *dentry)
432 {
433         return -1;
434 }
435
436 /* Used to make a generic file, based on the type and the major/minor numbers
437  * (in rdev), with the given mode.  As with others, this creates a new disk
438  * inode for the file */
439 int kfs_mknod(struct inode *dir, struct dentry *dentry, int mode, dev_t rdev)
440 {
441         return -1;
442 }
443
444 /* Moves old_dentry from old_dir to new_dentry in new_dir */
445 int kfs_rename(struct inode *old_dir, struct dentry *old_dentry,
446                struct inode *new_dir, struct dentry *new_dentry)
447 {
448         return -1;
449 }
450
451 /* Copies to the userspace buffer the file pathname corresponding to the symlink
452  * specified by dentry. */
453 int kfs_readlink(struct dentry *dentry, char *buffer, size_t buflen)
454 {
455         return -1;
456 }
457
458 /* Translates the symlink specified by sym and puts the result in nd. */
459 int kfs_follow_link(struct dentry *sym, struct nameidata *nd)
460 {
461         return -1;
462 }
463
464 /* Cleans up after follow_link (decrefs the nameidata business) */
465 int kfs_put_link(struct dentry *sym, struct nameidata *nd)
466 {
467         return -1;
468 }
469
470 /* Modifies the size of the file of inode to whatever its i_size is set to */
471 void kfs_truncate(struct inode *inode)
472 {
473 }
474
475 /* Checks whether the the access mode is allowed for the file belonging to the
476  * inode.  Implies that the permissions are on the file, and not the hardlink */
477 int kfs_permission(struct inode *inode, int mode, struct nameidata *nd)
478 {
479         return -1;
480 }
481
482
483 /* dentry_operations */
484 /* Determines if the dentry is still valid before using it to translate a path.
485  * Network FS's need to deal with this. */
486 int kfs_d_revalidate(struct dentry *dir, struct nameidata *nd)
487 { // default, nothing
488         return -1;
489 }
490
491 /* Produces the hash to lookup this dentry from the dcache */
492 int kfs_d_hash(struct dentry *dentry, struct qstr *name)
493 {
494         return -1;
495 }
496
497 /* Compares name1 and name2.  name1 should be a member of dir. */
498 int kfs_d_compare(struct dentry *dir, struct qstr *name1, struct qstr *name2)
499 { // default, string comp (case sensitive)
500         return -1;
501 }
502
503 /* Called when the last ref is deleted (refcnt == 0) */
504 int kfs_d_delete(struct dentry *dentry)
505 { // default, nothin
506         return -1;
507 }
508
509 /* Called when it's about to be slab-freed */
510 int kfs_d_release(struct dentry *dentry)
511 {
512         return -1;
513 }
514
515 /* Called when the dentry loses it's inode (becomes "negative") */
516 void kfs_d_iput(struct dentry *dentry, struct inode *inode)
517 { // default, call i_put to release the inode object
518 }
519
520
521 /* file_operations */
522
523 /* Updates the file pointer.  KFS doesn't let you go past the end of a file
524  * yet, so it won't let you seek past either.  TODO: think about locking. */
525 off_t kfs_llseek(struct file *file, off_t offset, int whence)
526 {
527         off_t temp_off = 0;
528         switch (whence) {
529                 case SEEK_SET:
530                         temp_off = offset;
531                         break;
532                 case SEEK_CUR:
533                         temp_off = file->f_pos + offset;
534                         break;
535                 case SEEK_END:
536                         temp_off = file->f_inode->i_size + offset;
537                         break;
538                 default:
539                         warn("Unknown 'whence' in llseek()!\n");
540         }
541         /* make sure the f_pos isn't outside the limits of the existing file */
542         temp_off = MAX(MIN(temp_off, file->f_inode->i_size), 0);
543         file->f_pos = temp_off;
544         return temp_off;
545 }
546
547 /* Fills in the next directory entry (dirent), starting with d_off.  Like with
548  * read and write, there will be issues with userspace and the *dirent buf.
549  * TODO: we don't really do anything with userspace concerns here, in part
550  * because memcpy_to doesn't work well.  When we fix how we want to handle the
551  * userbuffers, we can write this accordingly.  */
552 int kfs_readdir(struct file *dir, struct dirent *dirent)
553 {
554         int count = 0;
555         bool found = FALSE;
556         struct dentry *subent;
557         struct dentry *dir_d = TAILQ_FIRST(&dir->f_inode->i_dentry);
558         struct kfs_i_info *k_i_info = (struct kfs_i_info*)dir->f_inode->i_fs_info;
559
560         /* how we check inside the for loops below.  moderately ghetto. */
561         void check_entry(void)
562         {
563                 if (count++ == dirent->d_off) {
564                         dirent->d_ino = subent->d_inode->i_ino;
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         /* some of this error handling can be done by the VFS.  The syscall should
573          * handle EBADF, EFAULT, and EINVAL (TODO, memory related). */
574         if (!(dir->f_inode->i_type & FS_I_DIR)) {
575                 set_errno(current_tf, ENOTDIR);
576                 return -1;
577         }
578
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(current_tf, ENOENT);
587                 return -1;
588         }
589         if (count - 1 == 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 (file->f_inode->i_type & FS_I_FILE)
602                 return 0;
603         return -1;
604 }
605
606 /* Opens the file specified by the inode, creating and filling in the file */
607 /* TODO: fill out the other // entries, sort vmnt refcnting */
608 int kfs_open(struct inode *inode, struct file *file)
609 {
610         /* This is mostly FS-agnostic, consider a helper */
611         //file = kmem_cache_alloc(file_kcache, 0); /* done in the VFS */
612         /* Add to the list of all files of this SB */
613         TAILQ_INSERT_TAIL(&inode->i_sb->s_files, file, f_list);
614         file->f_inode = inode;
615         atomic_inc(&inode->i_refcnt);
616         file->f_vfsmnt = inode->i_sb->s_mount;          /* saving a ref to the vmnt...*/
617         file->f_op = &kfs_f_op;
618         atomic_set(&file->f_refcnt, 1);                         /* ref passed out */
619         file->f_flags = inode->i_flags;                         /* just taking the inode vals */
620         file->f_mode = inode->i_mode;
621         file->f_pos = 0;
622         file->f_uid = inode->i_uid;
623         file->f_gid = inode->i_gid;
624         file->f_error = 0;
625 //      struct event_poll_tailq         f_ep_links;
626         spinlock_init(&file->f_ep_lock);
627         file->f_fs_info = 0;
628         file->f_mapping = inode->i_mapping;
629         return 0;
630 }
631
632 /* Called when a file descriptor is closed. */
633 int kfs_flush(struct file *file)
634 {
635         return -1;
636 }
637
638 /* Called when the file refcnt == 0 */
639 int kfs_release(struct inode *inode, struct file *file)
640 {
641         TAILQ_REMOVE(&inode->i_sb->s_files, file, f_list);
642         /* TODO: (REF) need to dealloc when this hits 0, atomic/concurrent/etc */
643         atomic_dec(&inode->i_refcnt);
644         /* TODO: clean up the inode if it was the last and we don't want it around
645          */
646         kmem_cache_free(file_kcache, file);
647         return 0;
648 }
649
650 /* Flushes the file's dirty contents to disc */
651 int kfs_fsync(struct file *file, struct dentry *dentry, int datasync)
652 {
653         return -1;
654 }
655
656 /* Traditionally, sleeps until there is file activity.  We probably won't
657  * support this, or we'll handle it differently. */
658 unsigned int kfs_poll(struct file *file, struct poll_table_struct *poll_table)
659 {
660         return -1;
661 }
662
663 /* Reads count bytes from a file, starting from (and modifiying) offset, and
664  * putting the bytes into buffers described by vector */
665 ssize_t kfs_readv(struct file *file, const struct iovec *vector,
666                   unsigned long count, off_t *offset)
667 {
668         return -1;
669 }
670
671 /* Writes count bytes to a file, starting from (and modifiying) offset, and
672  * taking the bytes from buffers described by vector */
673 ssize_t kfs_writev(struct file *file, const struct iovec *vector,
674                   unsigned long count, off_t *offset)
675 {
676         return -1;
677 }
678
679 /* Write the contents of file to the page.  Will sort the params later */
680 ssize_t kfs_sendpage(struct file *file, struct page *page, int offset,
681                      size_t size, off_t pos, int more)
682 {
683         return -1;
684 }
685
686 /* Checks random FS flags.  Used by NFS. */
687 int kfs_check_flags(int flags)
688 { // default, nothing
689         return -1;
690 }
691
692 /* Redeclaration and initialization of the FS ops structures */
693 struct page_map_operations kfs_pm_op = {
694         kfs_readpage,
695 };
696
697 struct super_operations kfs_s_op = {
698         kfs_alloc_inode,
699         kfs_destroy_inode,
700         kfs_read_inode,
701         kfs_dirty_inode,
702         kfs_write_inode,
703         kfs_put_inode,
704         kfs_drop_inode,
705         kfs_delete_inode,
706         kfs_put_super,
707         kfs_write_super,
708         kfs_sync_fs,
709         kfs_remount_fs,
710         kfs_umount_begin,
711 };
712
713 struct inode_operations kfs_i_op = {
714         kfs_create,
715         kfs_lookup,
716         kfs_link,
717         kfs_unlink,
718         kfs_symlink,
719         kfs_mkdir,
720         kfs_rmdir,
721         kfs_mknod,
722         kfs_rename,
723         kfs_readlink,
724         kfs_follow_link,
725         kfs_put_link,
726         kfs_truncate,
727         kfs_permission,
728 };
729
730 struct dentry_operations kfs_d_op = {
731         kfs_d_revalidate,
732         kfs_d_hash,
733         kfs_d_compare,
734         kfs_d_delete,
735         kfs_d_release,
736         kfs_d_iput,
737 };
738
739 struct file_operations kfs_f_op = {
740         kfs_llseek,
741         generic_file_read,
742         generic_file_write,
743         kfs_readdir,
744         kfs_mmap,
745         kfs_open,
746         kfs_flush,
747         kfs_release,
748         kfs_fsync,
749         kfs_poll,
750         kfs_readv,
751         kfs_writev,
752         kfs_sendpage,
753         kfs_check_flags,
754 };
755
756 /* KFS Specific Internal Functions */
757
758 /* Need to pass path separately, since we'll recurse on it.  TODO: this recurses,
759  * and takes up a lot of stack space (~270 bytes).  Core 0's KSTACK is 8 pages,
760  * which can handle about 120 levels deep...  Other cores are not so fortunate.
761  * Can rework this if it becomes an issue. */
762 static int __add_kfs_entry(struct dentry *parent, char *path,
763                            struct cpio_bin_hdr *c_bhdr)
764 {
765         char *first_slash = strchr(path, '/');  
766         char dir[MAX_FILENAME_SZ + 1];  /* room for the \0 */
767         size_t dirname_sz;                              /* not counting the \0 */
768         struct dentry *dentry = 0;
769         struct nameidata nd = {0};
770         struct inode *inode;
771
772         if (first_slash) {
773                 /* get the first part, find that dentry, pass in the second part,
774                  * recurse.  this isn't being smart about extra slashes, dots, or
775                  * anything like that. */
776                 dirname_sz = first_slash - path;
777                 assert(dirname_sz <= MAX_FILENAME_SZ);
778                 strncpy(dir, path, dirname_sz);
779                 dir[dirname_sz] = '\0';
780                 printd("Finding DIR %s in dentry %s (start: %p, size %d)\n", dir,
781                        parent->d_name.name, c_bhdr->c_filestart, c_bhdr->c_filesize);
782                 /* Need to create a dentry for the lookup, and fill in the basic nd */
783                 dentry = get_dentry(parent->d_sb, parent, dir);
784                 nd.dentry = dentry;
785                 nd.mnt = dentry->d_sb->s_mount;
786                 //nd.flags = 0;                 /* TODO: once we have lookup flags */
787                 //nd.last_type = 0;             /* TODO: should be a DIR */
788                 //nd.intent = 0;                /* TODO: RW, prob irrelevant*/
789                 /* TODO: use a VFS lookup instead, to use the dcache, thought its not a
790                  * big deal since KFS currently pins all metadata. */
791                 dentry = kfs_lookup(parent->d_inode, dentry, &nd);
792                 if (!dentry) {
793                         printk("Missing dir in CPIO archive or something, aborting.\n");
794                         return -1;
795                 }
796                 return __add_kfs_entry(dentry, first_slash + 1, c_bhdr);
797         } else {
798                 /* no directories left in the path.  add the 'file' to the dentry */
799                 printd("Adding file/dir %s to dentry %s (start: %p, size %d)\n", path,
800                        parent->d_name.name, c_bhdr->c_filestart, c_bhdr->c_filesize);
801                 /* Init the dentry for this path */
802                 dentry = get_dentry(parent->d_sb, parent, path);
803                 dcache_put(dentry);                     /* TODO: should set a d_flag too */
804                 /* build the inode */
805                 /* XXX: note we use an unrefcnt'd inode here (grabbing the dentry's) */
806                 if (!c_bhdr->c_filesize) {
807                         /* we are a directory.  Note that fifos might look like dirs... */
808                         kfs_mkdir(parent->d_inode, dentry, c_bhdr->c_mode);
809                         inode = dentry->d_inode;
810                 } else {
811                         /* we are a file */
812                         kfs_create(parent->d_inode, dentry, c_bhdr->c_mode, 0);
813                         inode = dentry->d_inode;
814                         ((struct kfs_i_info*)inode->i_fs_info)->filestart =
815                                                                 c_bhdr->c_filestart;
816                         ((struct kfs_i_info*)inode->i_fs_info)->init_size =
817                                                                 c_bhdr->c_filesize;
818                 }
819                 /* Set other info from the CPIO entry */
820                 inode->i_uid = c_bhdr->c_uid;
821                 inode->i_gid = c_bhdr->c_gid;
822                 inode->i_atime.tv_sec = c_bhdr->c_mtime;
823                 inode->i_ctime.tv_sec = c_bhdr->c_mtime;
824                 inode->i_mtime.tv_sec = c_bhdr->c_mtime;
825                 inode->i_size = c_bhdr->c_filesize;
826                 //inode->i_XXX = c_bhdr->c_dev;                 /* and friends */
827                 inode->i_bdev = 0;                                              /* assuming blockdev? */
828                 inode->i_socket = FALSE;
829                 inode->i_blocks = c_bhdr->c_filesize;   /* blocksize == 1 */
830         }
831         return 0;
832 }
833
834 /* Adds an entry (from a CPIO archive) to KFS.  This will put all the FS
835  * metadata in memory, instead of having to reparse the entire archive each time
836  * we need to traverse.
837  *
838  * The other option is to just maintain a LL of {FN, FS}, and O(n) scan it.
839  *
840  * The path is a complete path, interpreted from the root of the mount point.
841  * Directories have a size of 0.  so do symlinks, but we don't handle those yet.
842  *
843  * If a directory does not exist for a file, this will return an error.  Don't
844  * use the -depth flag to find when building the CPIO archive, and this won't be
845  * a problem.  (Maybe) */
846 static int add_kfs_entry(struct super_block *sb, struct cpio_bin_hdr *c_bhdr)
847 {
848         char *path = c_bhdr->c_filename;
849         /* Root of the FS, already part of KFS */
850         if (!strcmp(path, "."))
851                 return 0;
852         return __add_kfs_entry(sb->s_mount->mnt_root, path, c_bhdr);
853 }
854
855 void parse_cpio_entries(struct super_block *sb, void *cpio_b)
856 {
857         struct cpio_newc_header *c_hdr = (struct cpio_newc_header*)cpio_b;
858
859         char buf[9] = {0};      /* temp space for strol conversions */
860         size_t namesize = 0;
861         int offset = 0;         /* offset in the cpio archive */
862         struct cpio_bin_hdr *c_bhdr = kmalloc(sizeof(*c_bhdr), 0);
863         memset(c_bhdr, 0, sizeof(*c_bhdr));
864
865         /* read all files and paths */
866         for (; ; c_hdr = (struct cpio_newc_header*)(cpio_b + offset)) {
867                 offset += sizeof(*c_hdr);
868                 if (strncmp(c_hdr->c_magic, "070701", 6)) {
869                         printk("Invalid magic number in CPIO header, aborting.\n");
870                         return;
871                 }
872                 c_bhdr->c_filename = (char*)c_hdr + sizeof(*c_hdr);
873                 namesize = cpio_strntol(buf, c_hdr->c_namesize, 8);
874                 printd("Namesize: %d\n", size);
875                 if (!strcmp(c_bhdr->c_filename, "TRAILER!!!"))
876                         break;
877                 c_bhdr->c_ino = cpio_strntol(buf, c_hdr->c_ino, 8);
878                 c_bhdr->c_mode = (int)cpio_strntol(buf, c_hdr->c_mode, 8);
879                 c_bhdr->c_uid = cpio_strntol(buf, c_hdr->c_uid, 8);
880                 c_bhdr->c_gid = cpio_strntol(buf, c_hdr->c_gid, 8);
881                 c_bhdr->c_nlink = (unsigned int)cpio_strntol(buf, c_hdr->c_nlink, 8);
882                 c_bhdr->c_mtime = cpio_strntol(buf, c_hdr->c_mtime, 8);
883                 c_bhdr->c_filesize = cpio_strntol(buf, c_hdr->c_filesize, 8);
884                 c_bhdr->c_dev_maj = cpio_strntol(buf, c_hdr->c_dev_maj, 8);
885                 c_bhdr->c_dev_min = cpio_strntol(buf, c_hdr->c_dev_min, 8);
886                 c_bhdr->c_rdev_maj = cpio_strntol(buf, c_hdr->c_rdev_maj, 8);
887                 c_bhdr->c_rdev_min = cpio_strntol(buf, c_hdr->c_rdev_min, 8);
888                 printd("File: %s: %d Bytes\n", c_bhdr->c_filename, c_bhdr->c_filesize);
889                 offset += namesize;
890                 /* header + name will be padded out to 4-byte alignment */
891                 offset = ROUNDUP(offset, 4);
892                 c_bhdr->c_filestart = cpio_b + offset;
893                 /* make this a function pointer or something */
894                 if (add_kfs_entry(sb, c_bhdr)) {
895                         printk("Failed to add an entry to KFS!\n");
896                         break;
897                 }
898                 offset += c_bhdr->c_filesize;
899                 offset = ROUNDUP(offset, 4);
900                 //printk("offset is %d bytes\n", offset);
901                 c_hdr = (struct cpio_newc_header*)(cpio_b + offset);
902         }
903         kfree(c_bhdr);
904 }
905
906 /* Debugging */
907 void print_dir_tree(struct dentry *dentry, int depth)
908 {
909         struct inode *inode = dentry->d_inode;
910         struct kfs_i_info *k_i_info = (struct kfs_i_info*)inode->i_fs_info;
911         struct dentry *d_i;
912         assert(dentry && inode && inode->i_type & FS_I_DIR);
913         char buf[32] = {0};
914
915         for (int i = 0; i < depth; i++)
916                 buf[i] = '\t';
917
918         TAILQ_FOREACH(d_i, &dentry->d_subdirs, d_subdirs_link) {
919                 printk("%sDir %s has child dir: %s\n", buf, dentry->d_name.name,
920                        d_i->d_name.name);
921                 print_dir_tree(d_i, depth + 1);
922         }
923         TAILQ_FOREACH(d_i, &k_i_info->children, d_subdirs_link) {
924                 printk("%sDir %s has child file: %s ", buf, dentry->d_name.name,
925                        d_i->d_name.name);
926                 printk("file starts at: %p\n",
927                        ((struct kfs_i_info*)d_i->d_inode->i_fs_info)->filestart);
928         }
929 }