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