generic_file_write() and file holes
[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. */
148 struct inode *kfs_alloc_inode(struct super_block *sb)
149 {
150         /* arguably, we can avoid some of this init by using the slab/cache */
151         struct inode *inode = kmem_cache_alloc(inode_kcache, 0);
152         memset(inode, 0, sizeof(struct inode));
153         TAILQ_INSERT_HEAD(&sb->s_inodes, inode, i_sb_list);
154         TAILQ_INIT(&inode->i_dentry);
155         inode->i_ino = 0;                                       /* set by caller later */
156         atomic_set(&inode->i_refcnt, 1);
157         inode->i_blksize = 1;                           /* keep in sync with get_sb() */
158         spinlock_init(&inode->i_lock);
159         inode->i_op = &kfs_i_op;
160         inode->i_fop = &kfs_f_op;
161         inode->i_sb = sb;
162         inode->i_state = 0;                                     /* need real states, want I_NEW */
163         inode->dirtied_when = 0;
164         atomic_set(&inode->i_writecount, 0);
165         inode->i_fs_info = kmem_cache_alloc(kfs_i_kcache, 0);
166         TAILQ_INIT(&((struct kfs_i_info*)inode->i_fs_info)->children);
167         ((struct kfs_i_info*)inode->i_fs_info)->filestart = 0;
168         /* Set up the page_map structures.  Default is to use the embedded one. */
169         inode->i_mapping = &inode->i_pm;
170         inode->i_mapping->pm_host = inode;
171         radix_tree_init(&inode->i_mapping->pm_tree);
172         spinlock_init(&inode->i_mapping->pm_tree_lock);
173         inode->i_mapping->pm_op = &kfs_pm_op;
174         inode->i_mapping->pm_flags = 0;
175         return inode;
176         /* caller sets i_ino, i_list set when applicable */
177 }
178
179 /* deallocs and cleans up after an inode. */
180 void kfs_destroy_inode(struct inode *inode)
181 {
182         kmem_cache_free(kfs_i_kcache, inode->i_fs_info);
183         kmem_cache_free(inode_kcache, inode);
184 }
185
186 /* reads the inode data on disk specified by inode->i_ino into the inode.
187  * basically, it's a "make this inode the one for i_ino (i number)" */
188 void kfs_read_inode(struct inode *inode)
189 {
190         /* need to do something to link this inode/file to the actual "blocks" on
191          * "disk". */
192
193         /* TODO: what does it mean to ask for an inode->i_ino that doesn't exist?
194          *      possibly a bug, since these inos come from directories */
195         if (inode->i_ino == 1) {
196                 inode->i_mode = 0x777;                  /* TODO: use something appropriate */
197                 inode->i_nlink = 1;                             /* assuming only one hardlink */
198                 inode->i_uid = 0;
199                 inode->i_gid = 0;
200                 inode->i_rdev = 0;
201                 inode->i_size = 0;                              /* make sense for KFS? */
202                 inode->i_atime.tv_sec = 0;
203                 inode->i_atime.tv_nsec = 0;
204                 inode->i_mtime.tv_sec = 0;
205                 inode->i_mtime.tv_nsec = 0;
206                 inode->i_ctime.tv_sec = 0;
207                 inode->i_ctime.tv_nsec = 0;
208                 inode->i_blocks = 0;
209                 inode->i_bdev = 0;                              /* assuming blockdev? */
210                 inode->i_flags = FS_I_DIR;
211                 inode->i_socket = FALSE;
212         } else {
213                 panic("Not implemented");
214         }
215         /* TODO: unused: inode->i_hash add to hash (saves on disc reading) */
216 }
217
218 /* called when an inode in memory is modified (journalling FS's care) */
219 void kfs_dirty_inode(struct inode *inode)
220 {       // KFS doesn't care
221 }
222
223 /* write the inode to disk (specifically, to inode inode->i_ino), synchronously
224  * if we're asked to wait */
225 void kfs_write_inode(struct inode *inode, bool wait)
226 {       // KFS doesn't care
227 }
228
229 /* called when an inode is decref'd, to do any FS specific work */
230 void kfs_put_inode(struct inode *inode)
231 {       // KFS doesn't care
232 }
233
234 /* called when an inode is about to be destroyed.  the generic version ought to
235  * remove every reference to the inode from the VFS, and if the inode isn't in
236  * any directory, calls delete_inode */
237 void kfs_drop_inode(struct inode *inode)
238 { // TODO: should call a generic one instead.  or at least do something...
239         // remove from lists
240 }
241
242 /* delete the inode from disk (all data) and deallocs the in memory inode */
243 void kfs_delete_inode(struct inode *inode)
244 {
245         // would remove from "disk" here
246         kfs_destroy_inode(inode);
247 }
248
249 /* unmount and release the super block */
250 void kfs_put_super(struct super_block *sb)
251 {
252         panic("Shazbot! KFS can't be unmounted yet!");
253 }
254
255 /* updates the on-disk SB with the in-memory SB */
256 void kfs_write_super(struct super_block *sb)
257 {       // KFS doesn't care
258 }
259
260 /* syncs FS metadata with the disc, synchronously if we're waiting.  this info
261  * also includes anything pointed to by s_fs_info. */
262 int kfs_sync_fs(struct super_block *sb, bool wait)
263 {
264         return 0;
265 }
266
267 /* remount the FS with the new flags */
268 int kfs_remount_fs(struct super_block *sb, int flags, char *data)
269 {
270         warn("KFS will not remount.");
271         return -1; // can't remount
272 }
273
274 /* interrupts a mount operation - used by NFS and friends */
275 void kfs_umount_begin(struct super_block *sb)
276 {
277         panic("Cannot abort a KFS mount, and why would you?");
278 }
279
280 /* inode_operations */
281
282 /* Helper op, used when creating regular files (kfs_create()) and when making
283  * directories (kfs_mkdir()).  References are a bit ugly.  We're passing out a
284  * ref that is already stored/accounted for.  Might change that...  Also, this
285  * needs to handle having nd == 0. */
286 struct inode *kfs_create_generic(struct inode *dir, struct dentry *dentry,
287                                  int mode, struct nameidata *nd)
288 {
289         /* note it is the i_ino that uniquely identifies a file in the system.
290          * there's a diff between creating an inode (even for an in-use ino) and
291          * then filling it in, and vs creating a brand new one */
292         struct inode *inode = kfs_alloc_inode(dentry->d_sb);
293         dentry->d_inode = inode;                /* inode ref stored here */
294         TAILQ_INSERT_TAIL(&inode->i_dentry, dentry, d_alias); /* stored dentry ref*/
295         inode->i_mode = mode;
296         inode->i_ino = kfs_get_free_ino();
297         inode->i_nlink = 1;
298         inode->i_atime.tv_sec = 0;              /* TODO: now! */
299         inode->i_ctime.tv_sec = 0;              /* TODO: now! */
300         inode->i_mtime.tv_sec = 0;              /* TODO: now! */
301         inode->i_atime.tv_nsec = 0;             /* are these supposed to be the extra ns? */
302         inode->i_ctime.tv_nsec = 0;
303         inode->i_mtime.tv_nsec = 0;
304         return inode;
305 }
306
307 /* Create a new disk inode in dir associated with dentry, with the given mode.
308  * called when creating a regular file.  dir is the directory/parent.  dentry is
309  * the dentry of the inode we are creating. */
310 int kfs_create(struct inode *dir, struct dentry *dentry, int mode,
311                struct nameidata *nd)
312 {
313         struct inode *inode = kfs_create_generic(dir, dentry, mode, nd);        
314         if (!inode)
315                 return -1;
316         inode->i_flags = FS_I_FILE;
317         /* our parent dentry's inode tracks our dentry info.  We do this
318          * since it's all in memory and we aren't using the dcache yet.
319          * We're reusing the subdirs link, which is used by the VFS when
320          * we're a directory.  But since we're a file, it's okay to reuse
321          * it. */
322         TAILQ_INSERT_TAIL(&((struct kfs_i_info*)dir->i_fs_info)->children,
323                           dentry, d_subdirs_link);
324         /* fs_info->filestart is set by the caller, or else when first written (for
325          * new files.  it was set to 0 in alloc_inode(). */
326         return 0;
327 }
328
329 /* Searches the directory for the filename in the dentry, filling in the dentry
330  * with the FS specific info of this file.  If it succeeds, it will pass back
331  * the *dentry you should use.  If this fails, it will return 0 and will take
332  * the ref to the dentry for you.  Either way, you shouldn't use the ref you
333  * passed in anymore.
334  *
335  * Callers, make sure you alloc and fill out the name parts of the dentry, and
336  * an initialized nameidata.
337  *
338  * Doesn't yet handle symlinks, . or .., so don't fuck it up.  It might not need
339  * to handle the . or .., which could be handled by the VFS.  Some of the other
340  * ugliness is because KFS is exclusively using dentries to track subdirs,
341  * instead of putting it all in the inode/dir file.
342  *
343  * Because of the way KFS currently works, if there is ever a dentry, it's
344  * already in memory, along with its inode (all path's pinned).  So we just find
345  * it and return it, freeing the one that came in. */
346 struct dentry *kfs_lookup(struct inode *dir, struct dentry *dentry,
347                           struct nameidata *nd)
348 {
349         struct kfs_i_info *k_i_info = (struct kfs_i_info*)dir->i_fs_info;
350         struct dentry *dir_dent = TAILQ_FIRST(&dir->i_dentry);
351         struct dentry *d_i;
352
353         assert(dir_dent && dir_dent == TAILQ_LAST(&dir->i_dentry, dentry_tailq));
354         assert(dir->i_flags & FS_I_DIR);
355
356         TAILQ_FOREACH(d_i, &dir_dent->d_subdirs, 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                          * can free the one that came in and return the real one */
360                         kmem_cache_free(dentry_kcache, dentry);
361                         return d_i;
362                 }
363         }
364         TAILQ_FOREACH(d_i, &k_i_info->children, d_subdirs_link) {
365                 if (!strcmp(d_i->d_name.name, dentry->d_name.name)) {
366                         /* since this dentry is already in memory (that's how KFS works), we
367                          * can free the one that came in and return the real one */
368                         kmem_cache_free(dentry_kcache, dentry);
369                         return d_i;
370                 }
371         }
372         /* no match, consider caching the negative result, freeing the
373          * dentry, etc */
374         printk("Not Found %s!!\n", dentry->d_name.name);
375         /* TODO: Cache, negatively... */
376         //dcache_put(dentry);                   /* TODO: should set a d_flag too */
377         return 0;
378 }
379
380 /* Hard link to old_dentry in directory dir with a name specified by new_dentry.
381  * TODO: should this also make the dentry linkage, or just discard everything?*/
382 int kfs_link(struct dentry *old_dentry, struct inode *dir,
383              struct dentry *new_dentry)
384 {
385         return -1;
386 }
387
388 /* Removes the link from the dentry in the directory */
389 int kfs_unlink(struct inode *dir, struct dentry *dentry)
390 {
391         return -1;
392 }
393
394 /* Creates a new inode for a symlink named symname in dir, and links to dentry.
395  * */
396 int kfs_symlink(struct inode *dir, struct dentry *dentry, const char *symname)
397 {
398         return -1;
399 }
400
401 /* Creates a new inode for a directory associated with dentry in dir with the
402  * given mode.  Note, we might (later) need to track subdirs within the parent
403  * inode, like we do with regular files.  I'd rather not, so we'll see if we
404  * need it. */
405 int kfs_mkdir(struct inode *dir, struct dentry *dentry, int mode)
406 {
407         struct inode *inode = kfs_create_generic(dir, dentry, mode, 0); 
408         if (!inode)
409                 return -1;
410         struct dentry *parent = TAILQ_FIRST(&dir->i_dentry);
411         assert(parent && parent == TAILQ_LAST(&dir->i_dentry, dentry_tailq));
412         inode->i_flags = FS_I_DIR;
413         /* parent dentry tracks dentry as a subdir */
414         TAILQ_INSERT_TAIL(&parent->d_subdirs, dentry, d_subdirs_link);
415         atomic_inc(&dentry->d_refcnt);
416         /* get ready to have our own kids */
417         TAILQ_INIT(&((struct kfs_i_info*)inode->i_fs_info)->children);
418         ((struct kfs_i_info*)inode->i_fs_info)->filestart = 0;
419         return 0;
420 }
421
422 /* Removes from dir the directory specified by the name in dentry. */
423 // TODO: note this isn't necessarily the same dentry, just using it for the
424 // naming (which seems to be a common way of doing things, like in lookup() -
425 // can work either way.
426 int kfs_rmdir(struct inode *dir, struct dentry *dentry)
427 {
428         return -1;
429 }
430
431 /* Used to make a generic file, based on the type and the major/minor numbers
432  * (in rdev), with the given mode.  As with others, this creates a new disk
433  * inode for the file */
434 int kfs_mknod(struct inode *dir, struct dentry *dentry, int mode, dev_t rdev)
435 {
436         return -1;
437 }
438
439 /* Moves old_dentry from old_dir to new_dentry in new_dir */
440 int kfs_rename(struct inode *old_dir, struct dentry *old_dentry,
441                struct inode *new_dir, struct dentry *new_dentry)
442 {
443         return -1;
444 }
445
446 /* Copies to the userspace buffer the file pathname corresponding to the symlink
447  * specified by dentry. */
448 int kfs_readlink(struct dentry *dentry, char *buffer, size_t buflen)
449 {
450         return -1;
451 }
452
453 /* Translates the symlink specified by sym and puts the result in nd. */
454 int kfs_follow_link(struct dentry *sym, struct nameidata *nd)
455 {
456         return -1;
457 }
458
459 /* Cleans up after follow_link (decrefs the nameidata business) */
460 int kfs_put_link(struct dentry *sym, struct nameidata *nd)
461 {
462         return -1;
463 }
464
465 /* Modifies the size of the file of inode to whatever its i_size is set to */
466 void kfs_truncate(struct inode *inode)
467 {
468 }
469
470 /* Checks whether the the access mode is allowed for the file belonging to the
471  * inode.  Implies that the permissions are on the file, and not the hardlink */
472 int kfs_permission(struct inode *inode, int mode, struct nameidata *nd)
473 {
474         return -1;
475 }
476
477
478 /* dentry_operations */
479 /* Determines if the dentry is still valid before using it to translate a path.
480  * Network FS's need to deal with this. */
481 int kfs_d_revalidate(struct dentry *dir, struct nameidata *nd)
482 { // default, nothing
483         return -1;
484 }
485
486 /* Produces the hash to lookup this dentry from the dcache */
487 int kfs_d_hash(struct dentry *dentry, struct qstr *name)
488 {
489         return -1;
490 }
491
492 /* Compares name1 and name2.  name1 should be a member of dir. */
493 int kfs_d_compare(struct dentry *dir, struct qstr *name1, struct qstr *name2)
494 { // default, string comp (case sensitive)
495         return -1;
496 }
497
498 /* Called when the last ref is deleted (refcnt == 0) */
499 int kfs_d_delete(struct dentry *dentry)
500 { // default, nothin
501         return -1;
502 }
503
504 /* Called when it's about to be slab-freed */
505 int kfs_d_release(struct dentry *dentry)
506 {
507         /* TODO: check the boundaries on this. */
508         if (dentry->d_name.len > DNAME_INLINE_LEN)
509                 kfree((void*)dentry->d_name.name);
510         return -1;
511 }
512
513 /* Called when the dentry loses it's inode (becomes "negative") */
514 void kfs_d_iput(struct dentry *dentry, struct inode *inode)
515 { // default, call i_put to release the inode object
516 }
517
518
519 /* file_operations */
520
521 /* Updates the file pointer.  KFS doesn't let you go past the end of a file
522  * yet, so it won't let you seek past either.  TODO: think about locking. */
523 off_t kfs_llseek(struct file *file, off_t offset, int whence)
524 {
525         off_t temp_off = 0;
526         switch (whence) {
527                 case SEEK_SET:
528                         temp_off = offset;
529                         break;
530                 case SEEK_CUR:
531                         temp_off = file->f_pos + offset;
532                         break;
533                 case SEEK_END:
534                         temp_off = file->f_inode->i_size + offset;
535                         break;
536                 default:
537                         warn("Unknown 'whence' in llseek()!\n");
538         }
539         /* make sure the f_pos isn't outside the limits of the existing file */
540         temp_off = MAX(MIN(temp_off, file->f_inode->i_size), 0);
541         file->f_pos = temp_off;
542         return temp_off;
543 }
544
545 /* Fills in the next directory entry (dirent), starting with d_off.  Like with
546  * read and write, there will be issues with userspace and the *dirent buf.
547  * TODO: we don't really do anything with userspace concerns here, in part
548  * because memcpy_to doesn't work well.  When we fix how we want to handle the
549  * userbuffers, we can write this accordingly.  */
550 int kfs_readdir(struct file *dir, struct dirent *dirent)
551 {
552         int count = 0;
553         bool found = FALSE;
554         struct dentry *subent;
555         struct dentry *dir_d = TAILQ_FIRST(&dir->f_inode->i_dentry);
556         struct kfs_i_info *k_i_info = (struct kfs_i_info*)dir->f_inode->i_fs_info;
557
558         /* how we check inside the for loops below.  moderately ghetto. */
559         void check_entry(void)
560         {
561                 if (count++ == dirent->d_off) {
562                         dirent->d_ino = subent->d_inode->i_ino;
563                         dirent->d_reclen = subent->d_name.len;
564                         /* d_name.name is null terminated, the byte after d_name.len */
565                         assert(subent->d_name.len <= MAX_FILENAME_SZ);
566                         strncpy(dirent->d_name, subent->d_name.name, subent->d_name.len +1);
567                         found = TRUE;
568                 }
569         }
570         /* some of this error handling can be done by the VFS.  The syscall should
571          * handle EBADF, EFAULT, and EINVAL (TODO, memory related). */
572         if (!(dir->f_inode->i_flags & FS_I_DIR)) {
573                 set_errno(current_tf, ENOTDIR);
574                 return -1;
575         }
576
577         /* need to check the sub-dirs as well as the sub-"files" */
578         TAILQ_FOREACH(subent, &dir_d->d_subdirs, d_subdirs_link)
579                 check_entry();
580         TAILQ_FOREACH(subent, &k_i_info->children, d_subdirs_link)
581                 check_entry();
582
583         if (!found) {
584                 set_errno(current_tf, ENOENT);
585                 return -1;
586         }
587         if (count - 1 == dirent->d_off)         /* found the last dir in the list */
588                 return 0;
589         return 1;                                                       /* normal success for readdir */
590 }
591
592 /* This is called when a VMR is mapping a particular file.  The FS needs to do
593  * whatever it needs so that faults can be handled by read_page(), and handle all
594  * of the cases of MAP_SHARED, MAP_PRIVATE, whatever.  It also needs to ensure
595  * the file is not being mmaped in a way that conflicts with the manner in which
596  * the file was opened. */
597 int kfs_mmap(struct file *file, struct vm_region *vmr)
598 {
599         /* the file is not page-aligned yet, so we need to copy it to fresh pages.
600          * this should only be done once per SHARED file (inode), so only make fresh
601          * copies if people want new ones.  Also note that MAP_PRIVATE does not get
602          * carried through to the underlying file. */
603
604         return -1;
605 }
606
607 /* Opens the file specified by the inode, creating and filling in the file */
608 /* TODO: fill out the other // entries, sort vmnt refcnting */
609 int kfs_open(struct inode *inode, struct file *file)
610 {
611         /* This is mostly FS-agnostic, consider a helper */
612         //file = kmem_cache_alloc(file_kcache, 0); /* done in the VFS */
613         /* Add to the list of all files of this SB */
614         TAILQ_INSERT_TAIL(&inode->i_sb->s_files, file, f_list);
615         file->f_inode = inode;
616         atomic_inc(&inode->i_refcnt);
617         file->f_vfsmnt = inode->i_sb->s_mount;          /* saving a ref to the vmnt...*/
618         file->f_op = &kfs_f_op;
619         atomic_set(&file->f_refcnt, 1);                         /* ref passed out */
620         file->f_flags = inode->i_flags;                         /* just taking the inode vals */
621         file->f_mode = inode->i_mode;
622         file->f_pos = 0;
623         file->f_uid = inode->i_uid;
624         file->f_gid = inode->i_gid;
625         file->f_error = 0;
626 //      struct event_poll_tailq         f_ep_links;
627         spinlock_init(&file->f_ep_lock);
628         file->f_fs_info = 0;
629         file->f_mapping = inode->i_mapping;
630         return 0;
631 }
632
633 /* Called when a file descriptor is closed. */
634 int kfs_flush(struct file *file)
635 {
636         return -1;
637 }
638
639 /* Called when the file refcnt == 0 */
640 int kfs_release(struct inode *inode, struct file *file)
641 {
642         kmem_cache_free(file_kcache, file);
643         return -1;
644 }
645
646 /* Flushes the file's dirty contents to disc */
647 int kfs_fsync(struct file *file, struct dentry *dentry, int datasync)
648 {
649         return -1;
650 }
651
652 /* Traditionally, sleeps until there is file activity.  We probably won't
653  * support this, or we'll handle it differently. */
654 unsigned int kfs_poll(struct file *file, struct poll_table_struct *poll_table)
655 {
656         return -1;
657 }
658
659 /* Reads count bytes from a file, starting from (and modifiying) offset, and
660  * putting the bytes into buffers described by vector */
661 ssize_t kfs_readv(struct file *file, const struct iovec *vector,
662                   unsigned long count, off_t *offset)
663 {
664         return -1;
665 }
666
667 /* Writes count bytes to a file, starting from (and modifiying) offset, and
668  * taking the bytes from buffers described by vector */
669 ssize_t kfs_writev(struct file *file, const struct iovec *vector,
670                   unsigned long count, off_t *offset)
671 {
672         return -1;
673 }
674
675 /* Write the contents of file to the page.  Will sort the params later */
676 ssize_t kfs_sendpage(struct file *file, struct page *page, int offset,
677                      size_t size, off_t pos, int more)
678 {
679         return -1;
680 }
681
682 /* Checks random FS flags.  Used by NFS. */
683 int kfs_check_flags(int flags)
684 { // default, nothing
685         return -1;
686 }
687
688 /* Redeclaration and initialization of the FS ops structures */
689 struct page_map_operations kfs_pm_op = {
690         kfs_readpage,
691 };
692
693 struct super_operations kfs_s_op = {
694         kfs_alloc_inode,
695         kfs_destroy_inode,
696         kfs_read_inode,
697         kfs_dirty_inode,
698         kfs_write_inode,
699         kfs_put_inode,
700         kfs_drop_inode,
701         kfs_delete_inode,
702         kfs_put_super,
703         kfs_write_super,
704         kfs_sync_fs,
705         kfs_remount_fs,
706         kfs_umount_begin,
707 };
708
709 struct inode_operations kfs_i_op = {
710         kfs_create,
711         kfs_lookup,
712         kfs_link,
713         kfs_unlink,
714         kfs_symlink,
715         kfs_mkdir,
716         kfs_rmdir,
717         kfs_mknod,
718         kfs_rename,
719         kfs_readlink,
720         kfs_follow_link,
721         kfs_put_link,
722         kfs_truncate,
723         kfs_permission,
724 };
725
726 struct dentry_operations kfs_d_op = {
727         kfs_d_revalidate,
728         kfs_d_hash,
729         kfs_d_compare,
730         kfs_d_delete,
731         kfs_d_release,
732         kfs_d_iput,
733 };
734
735 struct file_operations kfs_f_op = {
736         kfs_llseek,
737         generic_file_read,
738         generic_file_write,
739         kfs_readdir,
740         kfs_mmap,
741         kfs_open,
742         kfs_flush,
743         kfs_release,
744         kfs_fsync,
745         kfs_poll,
746         kfs_readv,
747         kfs_writev,
748         kfs_sendpage,
749         kfs_check_flags,
750 };
751
752 /* KFS Specific Internal Functions */
753
754 /* For obj files compiled with the kernel */
755 #define DECL_PROG(x) \
756     extern uint8_t (COUNT(sizeof(size_t)) _binary_obj_tests_##x##_size)[],\
757         (COUNT(_binary_obj_user_apps_##x##_size)_binary_obj_tests_##x##_start)[];
758
759 #define KFS_PENTRY(x) {#x, _binary_obj_tests_##x##_start, (size_t) _binary_obj_tests_##x##_size},
760
761 /*
762  * Hardcode the files included in the KFS.  PROGs need to be in sync with the
763  * userapps in kern/src/Makefrag.  Files need to be in kern/kfs/
764  * Make sure to declare it, and add an entry.  Keep MAX_KFS_FILES big enough too
765  * Note that files with a . in their name will have an _ instead.
766  */
767 #ifdef __CONFIG_KFS__
768 DECL_PROG(tlstest);
769 DECL_PROG(fp_test);
770 DECL_PROG(mproctests);
771 DECL_PROG(hello);
772 DECL_PROG(mhello);
773 DECL_PROG(pthread_test);
774 DECL_PROG(pthread_barrier_test);
775 DECL_PROG(idle);
776 DECL_PROG(tsc_spitter);
777 DECL_PROG(msr_get_cores);
778 DECL_PROG(msr_get_singlecore);
779 DECL_PROG(msr_dumb_while);
780 DECL_PROG(msr_nice_while);
781 DECL_PROG(msr_single_while);
782 DECL_PROG(msr_cycling_vcores);
783 #endif
784
785 struct kfs_entry kfs[MAX_KFS_FILES] = {
786 #ifdef __CONFIG_KFS__
787         KFS_PENTRY(tlstest)
788         KFS_PENTRY(fp_test)
789         KFS_PENTRY(mproctests)
790         KFS_PENTRY(hello)
791         KFS_PENTRY(mhello)
792         KFS_PENTRY(pthread_test)
793         KFS_PENTRY(pthread_barrier_test)
794         KFS_PENTRY(idle)
795         KFS_PENTRY(tsc_spitter)
796         KFS_PENTRY(msr_get_cores)
797         KFS_PENTRY(msr_get_singlecore)
798         KFS_PENTRY(msr_dumb_while)
799         KFS_PENTRY(msr_nice_while)
800         KFS_PENTRY(msr_single_while)
801         KFS_PENTRY(msr_cycling_vcores)
802 #endif
803 };
804
805 ssize_t kfs_lookup_path(char* path)
806 {
807         for (int i = 0; i < MAX_KFS_FILES; i++)
808                 // need to think about how to copy-in something of unknown length
809                 if (!strncmp(kfs[i].name, path, strlen(path)))
810                         return i;
811         return -EINVAL;
812 }
813
814 /*
815  * Creates a process from the file pointed to by the KFS inode (index)
816  * This should take a real inode or something to point to the real location,
817  * and proc_create shouldn't assume everything is contiguous
818  */
819 struct proc *kfs_proc_create(int kfs_inode)
820 {
821         if (kfs_inode < 0 || kfs_inode >= MAX_KFS_FILES)
822                 panic("Invalid kfs_inode.  Check you error codes!");
823         return proc_create(kfs[kfs_inode].start, kfs[kfs_inode].size);
824 }
825
826 /* Dumps the contents of the KFS file to the console.  Not meant to be taken
827  * too seriously - just dumps each char. */
828 void kfs_cat(int kfs_inode)
829 {
830         if (kfs_inode < 0 || kfs_inode >= MAX_KFS_FILES)
831                 panic("Invalid kfs_inode.  Check you error codes!");
832         uint8_t *end = kfs[kfs_inode].start + kfs[kfs_inode].size;
833         for (uint8_t *ptr = kfs[kfs_inode].start; ptr < end; ptr++)
834                 cputchar(*ptr);
835 }
836
837 /* Need to pass path separately, since we'll recurse on it.  TODO: this recurses,
838  * and takes up a lot of stack space (~270 bytes).  Core 0's KSTACK is 8 pages,
839  * which can handle about 120 levels deep...  Other cores are not so fortunate.
840  * Can rework this if it becomes an issue. */
841 static int __add_kfs_entry(struct dentry *parent, char *path,
842                            struct cpio_bin_hdr *c_bhdr)
843 {
844         char *first_slash = strchr(path, '/');  
845         char dir[MAX_FILENAME_SZ + 1];  /* room for the \0 */
846         size_t dirname_sz;                              /* not counting the \0 */
847         struct dentry *dentry = 0;
848         struct nameidata nd = {0};
849         struct inode *inode;
850
851         if (first_slash) {
852                 /* get the first part, find that dentry, pass in the second part,
853                  * recurse.  this isn't being smart about extra slashes, dots, or
854                  * anything like that. */
855                 dirname_sz = first_slash - path;
856                 assert(dirname_sz <= MAX_FILENAME_SZ);
857                 strncpy(dir, path, dirname_sz);
858                 dir[dirname_sz] = '\0';
859                 printd("Finding DIR %s in dentry %s (start: %p, size %d)\n", dir,
860                        parent->d_name.name, c_bhdr->c_filestart, c_bhdr->c_filesize);
861                 /* Need to create a dentry for the lookup, and fill in the basic nd */
862                 dentry = get_dentry(parent->d_sb, parent, dir);
863                 nd.dentry = dentry;
864                 nd.mnt = dentry->d_sb->s_mount;
865                 //nd.flags = 0;                 /* TODO: once we have lookup flags */
866                 //nd.last_type = 0;             /* TODO: should be a DIR */
867                 //nd.intent = 0;                /* TODO: RW, prob irrelevant*/
868                 /* TODO: use a VFS lookup instead, to use the dcache, thought its not a
869                  * big deal since KFS currently pins all metadata. */
870                 dentry = kfs_lookup(parent->d_inode, dentry, &nd);
871                 if (!dentry) {
872                         printk("Missing dir in CPIO archive or something, aborting.\n");
873                         return -1;
874                 }
875                 return __add_kfs_entry(dentry, first_slash + 1, c_bhdr);
876         } else {
877                 /* no directories left in the path.  add the 'file' to the dentry */
878                 printd("Adding file/dir %s to dentry %s (start: %p, size %d)\n", path,
879                        parent->d_name.name, c_bhdr->c_filestart, c_bhdr->c_filesize);
880                 /* Init the dentry for this path */
881                 dentry = get_dentry(parent->d_sb, parent, path);
882                 dentry->d_op = &kfs_d_op;
883                 dcache_put(dentry);                     /* TODO: should set a d_flag too */
884                 /* build the inode */
885                 if (!c_bhdr->c_filesize) {
886                         /* we are a directory.  Note that fifos might look like dirs... */
887                         kfs_mkdir(parent->d_inode, dentry, c_bhdr->c_mode);
888                         inode = dentry->d_inode;
889                 } else {
890                         /* we are a file */
891                         kfs_create(parent->d_inode, dentry, c_bhdr->c_mode, 0);
892                         inode = dentry->d_inode;
893                         ((struct kfs_i_info*)inode->i_fs_info)->filestart =
894                                                                 c_bhdr->c_filestart;
895                         ((struct kfs_i_info*)inode->i_fs_info)->init_size =
896                                                                 c_bhdr->c_filesize;
897                 }
898                 /* Set other info from the CPIO entry */
899                 inode->i_uid = c_bhdr->c_uid;
900                 inode->i_gid = c_bhdr->c_gid;
901                 inode->i_atime.tv_sec = c_bhdr->c_mtime;
902                 inode->i_ctime.tv_sec = c_bhdr->c_mtime;
903                 inode->i_mtime.tv_sec = c_bhdr->c_mtime;
904                 inode->i_size = c_bhdr->c_filesize;
905                 //inode->i_XXX = c_bhdr->c_dev;                 /* and friends */
906                 inode->i_bdev = 0;                                              /* assuming blockdev? */
907                 inode->i_socket = FALSE;
908                 inode->i_blocks = c_bhdr->c_filesize;   /* blocksize == 1 */
909         }
910         return 0;
911 }
912
913 /* Adds an entry (from a CPIO archive) to KFS.  This will put all the FS
914  * metadata in memory, instead of having to reparse the entire archive each time
915  * we need to traverse.
916  *
917  * The other option is to just maintain a LL of {FN, FS}, and O(n) scan it.
918  *
919  * The path is a complete path, interpreted from the root of the mount point.
920  * Directories have a size of 0.  so do symlinks, but we don't handle those yet.
921  *
922  * If a directory does not exist for a file, this will return an error.  Don't
923  * use the -depth flag to find when building the CPIO archive, and this won't be
924  * a problem.  (Maybe) */
925 static int add_kfs_entry(struct super_block *sb, struct cpio_bin_hdr *c_bhdr)
926 {
927         char *path = c_bhdr->c_filename;
928         /* Root of the FS, already part of KFS */
929         if (!strcmp(path, "."))
930                 return 0;
931         return __add_kfs_entry(sb->s_mount->mnt_root, path, c_bhdr);
932 }
933
934 void parse_cpio_entries(struct super_block *sb, void *cpio_b)
935 {
936         struct cpio_newc_header *c_hdr = (struct cpio_newc_header*)cpio_b;
937
938         char buf[9] = {0};      /* temp space for strol conversions */
939         size_t namesize = 0;
940         int offset = 0;         /* offset in the cpio archive */
941         struct cpio_bin_hdr *c_bhdr = kmalloc(sizeof(*c_bhdr), 0);
942         memset(c_bhdr, 0, sizeof(*c_bhdr));
943
944         /* read all files and paths */
945         for (; ; c_hdr = (struct cpio_newc_header*)(cpio_b + offset)) {
946                 offset += sizeof(*c_hdr);
947                 if (strncmp(c_hdr->c_magic, "070701", 6)) {
948                         printk("Invalid magic number in CPIO header, aborting.\n");
949                         return;
950                 }
951                 c_bhdr->c_filename = (char*)c_hdr + sizeof(*c_hdr);
952                 namesize = cpio_strntol(buf, c_hdr->c_namesize, 8);
953                 printd("Namesize: %d\n", size);
954                 if (!strcmp(c_bhdr->c_filename, "TRAILER!!!"))
955                         break;
956                 c_bhdr->c_ino = cpio_strntol(buf, c_hdr->c_ino, 8);
957                 c_bhdr->c_mode = (int)cpio_strntol(buf, c_hdr->c_mode, 8);
958                 c_bhdr->c_uid = cpio_strntol(buf, c_hdr->c_uid, 8);
959                 c_bhdr->c_gid = cpio_strntol(buf, c_hdr->c_gid, 8);
960                 c_bhdr->c_nlink = (unsigned int)cpio_strntol(buf, c_hdr->c_nlink, 8);
961                 c_bhdr->c_mtime = cpio_strntol(buf, c_hdr->c_mtime, 8);
962                 c_bhdr->c_filesize = cpio_strntol(buf, c_hdr->c_filesize, 8);
963                 c_bhdr->c_dev_maj = cpio_strntol(buf, c_hdr->c_dev_maj, 8);
964                 c_bhdr->c_dev_min = cpio_strntol(buf, c_hdr->c_dev_min, 8);
965                 c_bhdr->c_rdev_maj = cpio_strntol(buf, c_hdr->c_rdev_maj, 8);
966                 c_bhdr->c_rdev_min = cpio_strntol(buf, c_hdr->c_rdev_min, 8);
967                 printd("File: %s: %d Bytes\n", c_bhdr->c_filename, c_bhdr->c_filesize);
968                 offset += namesize;
969                 /* header + name will be padded out to 4-byte alignment */
970                 offset = ROUNDUP(offset, 4);
971                 c_bhdr->c_filestart = cpio_b + offset;
972                 /* make this a function pointer or something */
973                 if (add_kfs_entry(sb, c_bhdr)) {
974                         printk("Failed to add an entry to KFS!\n");
975                         break;
976                 }
977                 offset += c_bhdr->c_filesize;
978                 offset = ROUNDUP(offset, 4);
979                 //printk("offset is %d bytes\n", offset);
980                 c_hdr = (struct cpio_newc_header*)(cpio_b + offset);
981         }
982         kfree(c_bhdr);
983 }
984
985 /* Debugging */
986 void print_dir_tree(struct dentry *dentry, int depth)
987 {
988         struct inode *inode = dentry->d_inode;
989         struct kfs_i_info *k_i_info = (struct kfs_i_info*)inode->i_fs_info;
990         struct dentry *d_i;
991         assert(dentry && inode && inode->i_flags & FS_I_DIR);
992         char buf[32] = {0};
993
994         for (int i = 0; i < depth; i++)
995                 buf[i] = '\t';
996
997         TAILQ_FOREACH(d_i, &dentry->d_subdirs, d_subdirs_link) {
998                 printk("%sDir %s has child dir: %s\n", buf, dentry->d_name.name,
999                        d_i->d_name.name);
1000                 print_dir_tree(d_i, depth + 1);
1001         }
1002         TAILQ_FOREACH(d_i, &k_i_info->children, d_subdirs_link) {
1003                 printk("%sDir %s has child file: %s ", buf, dentry->d_name.name,
1004                        d_i->d_name.name);
1005                 printk("file starts at: %p\n",
1006                        ((struct kfs_i_info*)d_i->d_inode->i_fs_info)->filestart);
1007         }
1008 }