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