KFS initrd supports symlinks
[akaros.git] / kern / src / kfs.c
1 /* Copyright (c) 2009, 2010 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Implementation of the KFS file system.  It is a RAM based, read-only FS
6  * consisting of files that are added to the kernel binary image.  Might turn
7  * this into a read/write FS with directories someday. */
8
9 #ifdef __SHARC__
10 #pragma nosharc
11 #endif
12
13 #ifdef __DEPUTY__
14 #pragma nodeputy
15 #endif
16
17 #include <vfs.h>
18 #include <kfs.h>
19 #include <slab.h>
20 #include <kmalloc.h>
21 #include <string.h>
22 #include <stdio.h>
23 #include <assert.h>
24 #include <error.h>
25 #include <cpio.h>
26 #include <pmap.h>
27 #include <smp.h>
28
29 #define KFS_MAX_FILE_SIZE 1024*1024*128
30 #define KFS_MAGIC 0xdead0001
31
32 /* VFS required Functions */
33 /* These structs are declared again and initialized farther down */
34 struct page_map_operations kfs_pm_op;
35 struct super_operations kfs_s_op;
36 struct inode_operations kfs_i_op;
37 struct dentry_operations kfs_d_op;
38 struct file_operations kfs_f_op;
39
40 /* TODO: something more better.  Prob something like the vmem cache, for this,
41  * pids, etc.  Good enough for now.  This also means we can only have one
42  * KFS instance, and we also aren't synchronizing access. */
43 static unsigned long kfs_get_free_ino(void)
44 {
45         static unsigned long last_ino = 1;       /* 1 is reserved for the root */
46         last_ino++;
47         if (!last_ino)
48                 panic("Out of inos in KFS!");
49         return last_ino;
50 }
51
52 /* Slabs for KFS specific info chunks */
53 struct kmem_cache *kfs_i_kcache;
54
55 static void kfs_init(void)
56 {
57         kfs_i_kcache = kmem_cache_create("kfs_ino_info", sizeof(struct kfs_i_info),
58                                          __alignof__(struct kfs_i_info), 0, 0, 0);
59 }
60
61 /* Creates the SB (normally would read in from disc and create).  Passes it's
62  * ref out to whoever consumes this.  Returns 0 on failure.
63  * TODO: consider pulling out more of the FS-independent stuff, if possible.
64  * There are only two things, but the pain in the ass is that you'd need to read
65  * the disc to get that first inode, and it's a FS-specific thing. */
66 struct super_block *kfs_get_sb(struct fs_type *fs, int flags,
67                                char *dev_name, struct vfsmount *vmnt)
68 {
69         /* Ought to check that dev_name has our FS on it.  in this case, it's
70          * irrelevant. */
71         //if (something_bad)
72         //      return 0;
73         static bool ran_once = FALSE;
74         if (!ran_once) {
75                 ran_once = TRUE;
76                 kfs_init();
77         }
78
79         /* Build and init the SB.  No need to read off disc. */
80         struct super_block *sb = get_sb();
81         sb->s_dev = 0;
82         sb->s_blocksize = 1;
83         sb->s_maxbytes = KFS_MAX_FILE_SIZE;
84         sb->s_type = &kfs_fs_type;
85         sb->s_op = &kfs_s_op;
86         sb->s_flags = flags;
87         sb->s_magic = KFS_MAGIC;
88         sb->s_mount = vmnt;
89         sb->s_syncing = FALSE;
90         sb->s_bdev = 0;
91         strlcpy(sb->s_name, "KFS", 32);
92         /* store the location of the CPIO archive.  make this more generic later. */
93         extern uint8_t _binary_obj_kern_initramfs_cpio_size[];
94         extern uint8_t _binary_obj_kern_initramfs_cpio_start[];
95         sb->s_fs_info = (void*)_binary_obj_kern_initramfs_cpio_start;
96
97         /* Final stages of initializing the sb, mostly FS-independent */
98         /* 1 is the KFS root ino (inode number) */
99         init_sb(sb, vmnt, &kfs_d_op, 1, 0);
100         /* Parses the CPIO entries and builds the in-memory KFS tree. */
101         parse_cpio_entries(sb, sb->s_fs_info);
102         printk("KFS superblock loaded\n");
103         return sb;
104 }
105
106 void kfs_kill_sb(struct super_block *sb)
107 {
108         panic("Killing KFS is not supported!");
109 }
110
111 /* Every FS must have a static FS Type, with which the VFS code can bootstrap */
112 struct fs_type kfs_fs_type = {"KFS", 0, kfs_get_sb, kfs_kill_sb, {0, 0},
113                TAILQ_HEAD_INITIALIZER(kfs_fs_type.fs_supers)};
114
115 /* Page Map Operations */
116
117 /* Fills page with its contents from its backing store file.  Note that we do
118  * the zero padding here, instead of higher in the VFS.  Might change in the
119  * future. */
120 int kfs_readpage(struct file *file, struct page *page)
121 {
122         size_t pg_idx_byte = page->pg_index * PGSIZE;
123         struct kfs_i_info *k_i_info = (struct kfs_i_info*)
124                                       file->f_dentry->d_inode->i_fs_info;
125         uintptr_t begin = (size_t)k_i_info->filestart + pg_idx_byte;
126         /* If we're beyond the initial start point, we just need a zero page.  This
127          * is for a hole or for extending a file (even though it won't be saved).
128          * Otherwise, we want the data from KFS, being careful to not copy from
129          * beyond the original EOF (and zero padding anything extra). */
130         if (pg_idx_byte >= k_i_info->init_size) {
131                 memset(page2kva(page), 0, PGSIZE);
132         } else {
133                 size_t copy_amt = MIN(PGSIZE, k_i_info->init_size - pg_idx_byte);
134                 memcpy(page2kva(page), (void*)begin, copy_amt);
135                 memset(page2kva(page) + copy_amt, 0, PGSIZE - copy_amt);
136         }
137         /* This is supposed to be done in the IO system when the operation is
138          * complete.  Since we aren't doing a real IO request, and it is already
139          * done, we can do it here. */
140         page->pg_flags |= PG_UPTODATE;
141         unlock_page(page);
142         return 0;
143 }
144
145 /* Super Operations */
146
147 /* creates and initializes a new inode.  generic fields are filled in.  specific
148  * fields are filled in in read_inode() based on what's on the disk for a given
149  * i_no.  i_no is set by the caller.  Note that this means this inode can be for
150  * an inode that is already on disk, or it can be used when creating. */
151 struct inode *kfs_alloc_inode(struct super_block *sb)
152 {
153         struct inode *inode = kmem_cache_alloc(inode_kcache, 0);
154         memset(inode, 0, sizeof(struct inode));
155         inode->i_op = &kfs_i_op;
156         inode->i_fop = &kfs_f_op;
157         inode->i_pm.pm_op = &kfs_pm_op;
158         inode->i_fs_info = kmem_cache_alloc(kfs_i_kcache, 0);
159         TAILQ_INIT(&((struct kfs_i_info*)inode->i_fs_info)->children);
160         ((struct kfs_i_info*)inode->i_fs_info)->filestart = 0;
161         return inode;
162 }
163
164 /* deallocs and cleans up after an inode. */
165 void kfs_destroy_inode(struct inode *inode)
166 {
167         kmem_cache_free(kfs_i_kcache, inode->i_fs_info);
168 }
169
170 /* reads the inode data on disk specified by inode->i_ino into the inode.
171  * basically, it's a "make this inode the one for i_ino (i number)" */
172 void kfs_read_inode(struct inode *inode)
173 {
174         /* need to do something to link this inode/file to the actual "blocks" on
175          * "disk". */
176
177         /* TODO: what does it mean to ask for an inode->i_ino that doesn't exist?
178          *      possibly a bug, since these inos come from directories */
179         if (inode->i_ino == 1) {
180                 inode->i_mode = S_IRWXU | S_IRWXG | S_IRWXO;
181                 inode->i_type = FS_I_DIR;
182                 inode->i_nlink = 1;                             /* assuming only one hardlink */
183                 inode->i_uid = 0;
184                 inode->i_gid = 0;
185                 inode->i_rdev = 0;
186                 inode->i_size = 0;                              /* make sense for KFS? */
187                 inode->i_atime.tv_sec = 0;
188                 inode->i_atime.tv_nsec = 0;
189                 inode->i_mtime.tv_sec = 0;
190                 inode->i_mtime.tv_nsec = 0;
191                 inode->i_ctime.tv_sec = 0;
192                 inode->i_ctime.tv_nsec = 0;
193                 inode->i_blocks = 0;
194                 inode->i_bdev = 0;                              /* assuming blockdev? */
195                 inode->i_flags = 0;
196                 inode->i_socket = FALSE;
197         } else {
198                 panic("Not implemented");
199         }
200         /* TODO: unused: inode->i_hash add to hash (saves on disc reading) */
201 }
202
203 /* called when an inode in memory is modified (journalling FS's care) */
204 void kfs_dirty_inode(struct inode *inode)
205 {       // KFS doesn't care
206 }
207
208 /* write the inode to disk (specifically, to inode inode->i_ino), synchronously
209  * if we're asked to wait */
210 void kfs_write_inode(struct inode *inode, bool wait)
211 {       // KFS doesn't care
212 }
213
214 /* called when an inode is decref'd, to do any FS specific work */
215 void kfs_put_inode(struct inode *inode)
216 {       // KFS doesn't care
217 }
218
219 /* called when an inode is about to be destroyed.  the generic version ought to
220  * remove every reference to the inode from the VFS, and if the inode isn't in
221  * any directory, calls delete_inode */
222 void kfs_drop_inode(struct inode *inode)
223 { // TODO: should call a generic one instead.  or at least do something...
224         // remove from lists
225 }
226
227 /* delete the inode from disk (all data) and deallocs the in memory inode */
228 void kfs_delete_inode(struct inode *inode)
229 {
230         // would remove from "disk" here
231         kfs_destroy_inode(inode);
232 }
233
234 /* unmount and release the super block */
235 void kfs_put_super(struct super_block *sb)
236 {
237         panic("Shazbot! KFS can't be unmounted yet!");
238 }
239
240 /* updates the on-disk SB with the in-memory SB */
241 void kfs_write_super(struct super_block *sb)
242 {       // KFS doesn't care
243 }
244
245 /* syncs FS metadata with the disc, synchronously if we're waiting.  this info
246  * also includes anything pointed to by s_fs_info. */
247 int kfs_sync_fs(struct super_block *sb, bool wait)
248 {
249         return 0;
250 }
251
252 /* remount the FS with the new flags */
253 int kfs_remount_fs(struct super_block *sb, int flags, char *data)
254 {
255         warn("KFS will not remount.");
256         return -1; // can't remount
257 }
258
259 /* interrupts a mount operation - used by NFS and friends */
260 void kfs_umount_begin(struct super_block *sb)
261 {
262         panic("Cannot abort a KFS mount, and why would you?");
263 }
264
265 /* inode_operations */
266
267 /* Little helper, used for initializing new inodes for file-like objects (files,
268  * symlinks, etc).  We pass the dentry, since we need to up it. */
269 static void kfs_init_inode(struct inode *dir, struct dentry *dentry)
270 {
271         struct inode *inode = dentry->d_inode;
272         kref_get(&dentry->d_kref, 1);   /* to pin the dentry in RAM, KFS-style... */
273         inode->i_ino = kfs_get_free_ino();
274         /* our parent dentry's inode tracks our dentry info.  We do this
275          * since it's all in memory and we aren't using the dcache yet.
276          * We're reusing the subdirs link, which is used by the VFS when
277          * we're a directory.  But since we're a file, it's okay to reuse
278          * it. */
279         TAILQ_INSERT_TAIL(&((struct kfs_i_info*)dir->i_fs_info)->children,
280                           dentry, d_subdirs_link);
281 }
282
283 /* Called when creating a new disk inode in dir associated with dentry.  We need
284  * to fill out the i_ino, set the type, and do whatever else we need */
285 int kfs_create(struct inode *dir, struct dentry *dentry, int mode,
286                struct nameidata *nd)
287 {
288         struct inode *inode = dentry->d_inode;
289         kfs_init_inode(dir, dentry);
290         inode->i_type = FS_I_FILE;
291         /* fs_info->filestart is set by the caller, or else when first written (for
292          * new files.  it was set to 0 in alloc_inode(). */
293         return 0;
294 }
295
296 /* Searches the directory for the filename in the dentry, filling in the dentry
297  * with the FS specific info of this file.  If it succeeds, it will pass back
298  * the *dentry you should use.  If this fails, it will return 0 and will take
299  * the ref to the dentry for you.  Either way, you shouldn't use the ref you
300  * passed in anymore.  Still, there are issues with refcnting with this.
301  *
302  * Callers, make sure you alloc and fill out the name parts of the dentry, and
303  * an initialized nameidata. TODO: not sure why we need an ND.  Don't use it in
304  * a fs_lookup for now!
305  *
306  * Because of the way KFS currently works, if there is ever a dentry, it's
307  * already in memory, along with its inode (all path's pinned).  So we just find
308  * it and return it, freeing the one that came in. */
309 struct dentry *kfs_lookup(struct inode *dir, struct dentry *dentry,
310                           struct nameidata *nd)
311 {
312         struct kfs_i_info *k_i_info = (struct kfs_i_info*)dir->i_fs_info;
313         struct dentry *dir_dent = TAILQ_FIRST(&dir->i_dentry);
314         struct dentry *d_i;
315
316         assert(dir_dent && dir_dent == TAILQ_LAST(&dir->i_dentry, dentry_tailq));
317         assert(dir->i_type & FS_I_DIR);
318         assert(kref_refcnt(&dentry->d_kref) == 1);
319         TAILQ_FOREACH(d_i, &dir_dent->d_subdirs, d_subdirs_link) {
320                 if (!strcmp(d_i->d_name.name, dentry->d_name.name)) {
321                         /* since this dentry is already in memory (that's how KFS works), we
322                          * can free the one that came in and return the real one */
323                         kref_put(&dentry->d_kref);
324                         kref_get(&d_i->d_kref, 1);
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                         kref_put(&dentry->d_kref);
333                         kref_get(&d_i->d_kref, 1);
334                         return d_i;
335                 }
336         }
337         /* no match, consider caching the negative result, freeing the
338          * dentry, etc */
339         printd("Not Found %s!!\n", dentry->d_name.name);
340         kref_put(&dentry->d_kref);
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 dir, linking to / containing the name
359  * symname.  dentry is the controlling dentry of the inode. */
360 int kfs_symlink(struct inode *dir, struct dentry *dentry, const char *symname)
361 {
362         struct inode *inode = dentry->d_inode;
363         struct kfs_i_info *k_i_info = (struct kfs_i_info*)inode->i_fs_info;
364         size_t len = strlen(symname);
365         char *string = kmalloc(len + 1, 0);
366
367         kfs_init_inode(dir, dentry);
368         inode->i_type = FS_I_SYMLINK;
369         strncpy(string, symname, len);
370         string[len] = '\0';             /* symname should be \0d anyway, but just in case */
371         k_i_info->filestart = string;   /* reusing this void* to hold the char* */
372         return 0;
373 }
374
375 /* Called when creating a new inode for a directory associated with dentry in
376  * dir with the given mode.  Note, we might (later) need to track subdirs within
377  * the parent inode, like we do with regular files.  I'd rather not, so we'll
378  * see if we need it. */
379 int kfs_mkdir(struct inode *dir, struct dentry *dentry, int mode)
380 {
381         struct inode *inode = dentry->d_inode;
382         kref_get(&dentry->d_kref, 1);   /* to pin the dentry in RAM, KFS-style... */
383         inode->i_ino = kfs_get_free_ino();
384         inode->i_type = FS_I_DIR;               /* this might be FS specific in the future */
385         /* get ready to have our own kids */
386         TAILQ_INIT(&((struct kfs_i_info*)inode->i_fs_info)->children);
387         ((struct kfs_i_info*)inode->i_fs_info)->filestart = 0;
388         return 0;
389 }
390
391 /* Removes from dir the directory specified by the name in dentry. */
392 // TODO: note this isn't necessarily the same dentry, just using it for the
393 // naming (which seems to be a common way of doing things, like in lookup() -
394 // can work either way.
395 int kfs_rmdir(struct inode *dir, struct dentry *dentry)
396 {
397         return -1;
398 }
399
400 /* Used to make a generic file, based on the type and the major/minor numbers
401  * (in rdev), with the given mode.  As with others, this creates a new disk
402  * inode for the file */
403 int kfs_mknod(struct inode *dir, struct dentry *dentry, int mode, dev_t rdev)
404 {
405         return -1;
406 }
407
408 /* Moves old_dentry from old_dir to new_dentry in new_dir */
409 int kfs_rename(struct inode *old_dir, struct dentry *old_dentry,
410                struct inode *new_dir, struct dentry *new_dentry)
411 {
412         return -1;
413 }
414
415 /* Returns the char* for the symname for the given dentry.  The VFS code that
416  * calls this for real FS's might assume it's already read in, so if the char *
417  * isn't already in memory, we'd need to read it in here.  Regarding the char*
418  * storage, the char* only will last as long as the dentry and inode are in
419  * memory. */
420 char *kfs_readlink(struct dentry *dentry)
421 {
422         struct inode *inode = dentry->d_inode;
423         struct kfs_i_info *k_i_info = (struct kfs_i_info*)inode->i_fs_info;
424         if (inode->i_type != FS_I_SYMLINK)
425                 return 0;
426         return k_i_info->filestart;
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         return -1;
472 }
473
474 /* Called when the dentry loses it's inode (becomes "negative") */
475 void kfs_d_iput(struct dentry *dentry, struct inode *inode)
476 { // default, call i_put to release the inode object
477 }
478
479
480 /* file_operations */
481
482 /* Updates the file pointer.  KFS doesn't let you go past the end of a file
483  * yet, so it won't let you seek past either.  TODO: think about locking. */
484 off_t kfs_llseek(struct file *file, off_t offset, int whence)
485 {
486         off_t temp_off = 0;
487         switch (whence) {
488                 case SEEK_SET:
489                         temp_off = offset;
490                         break;
491                 case SEEK_CUR:
492                         temp_off = file->f_pos + offset;
493                         break;
494                 case SEEK_END:
495                         temp_off = file->f_dentry->d_inode->i_size + offset;
496                         break;
497                 default:
498                         set_errno(EINVAL);
499                         warn("Unknown 'whence' in llseek()!\n");
500                         return -1;
501         }
502         /* make sure the f_pos isn't outside the limits of the existing file.
503          * techincally, if they go too far, we should return EINVAL */
504         temp_off = MAX(MIN(temp_off, file->f_dentry->d_inode->i_size), 0);
505         file->f_pos = temp_off;
506         return temp_off;
507 }
508
509 /* Fills in the next directory entry (dirent), starting with d_off.  Like with
510  * read and write, there will be issues with userspace and the *dirent buf.
511  * TODO: we don't really do anything with userspace concerns here, in part
512  * because memcpy_to doesn't work well.  When we fix how we want to handle the
513  * userbuffers, we can write this accordingly. (UMEM)  */
514 int kfs_readdir(struct file *dir, struct dirent *dirent)
515 {
516         int count = 0;
517         bool found = FALSE;
518         struct dentry *subent;
519         struct dentry *dir_d = dir->f_dentry;
520         struct kfs_i_info *k_i_info = (struct kfs_i_info*)dir_d->d_inode->i_fs_info;
521
522         /* how we check inside the for loops below.  moderately ghetto. */
523         void check_entry(void)
524         {
525                 if (count++ == dirent->d_off) {
526                         dirent->d_ino = subent->d_inode->i_ino;
527                         dirent->d_reclen = subent->d_name.len;
528                         /* d_name.name is null terminated, the byte after d_name.len */
529                         assert(subent->d_name.len <= MAX_FILENAME_SZ);
530                         strncpy(dirent->d_name, subent->d_name.name, subent->d_name.len +1);
531                         found = TRUE;
532                 }
533         }
534         /* some of this error handling can be done by the VFS.  The syscall should
535          * handle EBADF, EFAULT, and EINVAL (TODO, memory related). */
536         if (!(dir_d->d_inode->i_type & FS_I_DIR)) {
537                 set_errno(ENOTDIR);
538                 return -1;
539         }
540
541         /* need to check the sub-dirs as well as the sub-"files" */
542         TAILQ_FOREACH(subent, &dir_d->d_subdirs, d_subdirs_link)
543                 check_entry();
544         TAILQ_FOREACH(subent, &k_i_info->children, d_subdirs_link)
545                 check_entry();
546
547         if (!found) {
548                 set_errno(ENOENT);
549                 return -1;
550         }
551         if (count - 1 == dirent->d_off)         /* found the last dir in the list */
552                 return 0;
553         return 1;                                                       /* normal success for readdir */
554 }
555
556 /* This is called when a VMR is mapping a particular file.  The FS needs to do
557  * whatever it needs so that faults can be handled by read_page(), and handle all
558  * of the cases of MAP_SHARED, MAP_PRIVATE, whatever.  It also needs to ensure
559  * the file is not being mmaped in a way that conflicts with the manner in which
560  * the file was opened or the file type. */
561 int kfs_mmap(struct file *file, struct vm_region *vmr)
562 {
563         if (file->f_dentry->d_inode->i_type & FS_I_FILE)
564                 return 0;
565         return -1;
566 }
567
568 /* Called by the VFS while opening the file, which corresponds to inode,  for
569  * the FS to do whatever it needs. */
570 int kfs_open(struct inode *inode, struct file *file)
571 {
572         return 0;
573 }
574
575 /* Called when a file descriptor is closed. */
576 int kfs_flush(struct file *file)
577 {
578         return -1;
579 }
580
581 /* Called when the file is about to be closed (file obj freed) */
582 int kfs_release(struct inode *inode, struct file *file)
583 {
584         return 0;
585 }
586
587 /* Flushes the file's dirty contents to disc */
588 int kfs_fsync(struct file *file, struct dentry *dentry, int datasync)
589 {
590         return -1;
591 }
592
593 /* Traditionally, sleeps until there is file activity.  We probably won't
594  * support this, or we'll handle it differently. */
595 unsigned int kfs_poll(struct file *file, struct poll_table_struct *poll_table)
596 {
597         return -1;
598 }
599
600 /* Reads count bytes from a file, starting from (and modifiying) offset, and
601  * putting the bytes into buffers described by vector */
602 ssize_t kfs_readv(struct file *file, const struct iovec *vector,
603                   unsigned long count, off_t *offset)
604 {
605         return -1;
606 }
607
608 /* Writes count bytes to a file, starting from (and modifiying) offset, and
609  * taking the bytes from buffers described by vector */
610 ssize_t kfs_writev(struct file *file, const struct iovec *vector,
611                   unsigned long count, off_t *offset)
612 {
613         return -1;
614 }
615
616 /* Write the contents of file to the page.  Will sort the params later */
617 ssize_t kfs_sendpage(struct file *file, struct page *page, int offset,
618                      size_t size, off_t pos, int more)
619 {
620         return -1;
621 }
622
623 /* Checks random FS flags.  Used by NFS. */
624 int kfs_check_flags(int flags)
625 { // default, nothing
626         return -1;
627 }
628
629 /* Redeclaration and initialization of the FS ops structures */
630 struct page_map_operations kfs_pm_op = {
631         kfs_readpage,
632 };
633
634 struct super_operations kfs_s_op = {
635         kfs_alloc_inode,
636         kfs_destroy_inode,
637         kfs_read_inode,
638         kfs_dirty_inode,
639         kfs_write_inode,
640         kfs_put_inode,
641         kfs_drop_inode,
642         kfs_delete_inode,
643         kfs_put_super,
644         kfs_write_super,
645         kfs_sync_fs,
646         kfs_remount_fs,
647         kfs_umount_begin,
648 };
649
650 struct inode_operations kfs_i_op = {
651         kfs_create,
652         kfs_lookup,
653         kfs_link,
654         kfs_unlink,
655         kfs_symlink,
656         kfs_mkdir,
657         kfs_rmdir,
658         kfs_mknod,
659         kfs_rename,
660         kfs_readlink,
661         kfs_truncate,
662         kfs_permission,
663 };
664
665 struct dentry_operations kfs_d_op = {
666         kfs_d_revalidate,
667         kfs_d_hash,
668         kfs_d_compare,
669         kfs_d_delete,
670         kfs_d_release,
671         kfs_d_iput,
672 };
673
674 struct file_operations kfs_f_op = {
675         kfs_llseek,
676         generic_file_read,
677         generic_file_write,
678         kfs_readdir,
679         kfs_mmap,
680         kfs_open,
681         kfs_flush,
682         kfs_release,
683         kfs_fsync,
684         kfs_poll,
685         kfs_readv,
686         kfs_writev,
687         kfs_sendpage,
688         kfs_check_flags,
689 };
690
691 /* KFS Specific Internal Functions */
692
693 /* Need to pass path separately, since we'll recurse on it.  TODO: this recurses,
694  * and takes up a lot of stack space (~270 bytes).  Core 0's KSTACK is 8 pages,
695  * which can handle about 120 levels deep...  Other cores are not so fortunate.
696  * Can rework this if it becomes an issue. */
697 static int __add_kfs_entry(struct dentry *parent, char *path,
698                            struct cpio_bin_hdr *c_bhdr)
699 {
700         char *first_slash = strchr(path, '/');  
701         char dir[MAX_FILENAME_SZ + 1];  /* room for the \0 */
702         size_t dirname_sz;                              /* not counting the \0 */
703         struct dentry *dentry = 0;
704         struct inode *inode;
705         int err;
706         char *symname, old_end;                 /* for symlink manipulation */
707
708         if (first_slash) {
709                 /* get the first part, find that dentry, pass in the second part,
710                  * recurse.  this isn't being smart about extra slashes, dots, or
711                  * anything like that. */
712                 dirname_sz = first_slash - path;
713                 assert(dirname_sz <= MAX_FILENAME_SZ);
714                 strncpy(dir, path, dirname_sz);
715                 dir[dirname_sz] = '\0';
716                 printd("Finding DIR %s in dentry %s (start: %p, size %d)\n", dir,
717                        parent->d_name.name, c_bhdr->c_filestart, c_bhdr->c_filesize);
718                 /* Need to create a dentry for the lookup, and fill in the basic nd */
719                 dentry = get_dentry(parent->d_sb, parent, dir);
720                 /* TODO: use a VFS lookup instead, to use the dcache, thought its not a
721                  * big deal since KFS currently pins all metadata. */
722                 dentry = kfs_lookup(parent->d_inode, dentry, 0);
723                 if (!dentry) {
724                         printk("Missing dir in CPIO archive or something, aborting.\n");
725                         return -1;
726                 }
727                 return __add_kfs_entry(dentry, first_slash + 1, c_bhdr);
728         } else {
729                 /* no directories left in the path.  add the 'file' to the dentry */
730                 printd("Adding file/dir %s to dentry %s (start: %p, size %d)\n", path,
731                        parent->d_name.name, c_bhdr->c_filestart, c_bhdr->c_filesize);
732                 /* Init the dentry for this path */
733                 dentry = get_dentry(parent->d_sb, parent, path);
734                 dcache_put(dentry);                     /* TODO: should set a d_flag too */
735                 /* build the inode */
736                 switch (c_bhdr->c_mode & CPIO_FILE_MASK) {
737                         case (CPIO_DIRECTORY):
738                                 err = create_dir(parent->d_inode, dentry, c_bhdr->c_mode);
739                                 assert(!err);
740                                 break;
741                         case (CPIO_SYMLINK):
742                                 /* writing the '\0' is safe since the next entry is always still
743                                  * in the CPIO (and we are processing sequentially). */
744                                 symname = c_bhdr->c_filestart;
745                                 old_end = symname[c_bhdr->c_filesize];
746                                 symname[c_bhdr->c_filesize] = '\0';
747                                 err = create_symlink(parent->d_inode, dentry, symname,
748                                                      c_bhdr->c_mode & CPIO_PERM_MASK);
749                                 assert(!err);
750                                 symname[c_bhdr->c_filesize] = old_end;
751                                 break;
752                         case (CPIO_REG_FILE):
753                                 err = create_file(parent->d_inode, dentry,
754                                                   c_bhdr->c_mode & CPIO_PERM_MASK);
755                                 assert(!err);
756                                 ((struct kfs_i_info*)dentry->d_inode->i_fs_info)->filestart =
757                                                                                                                 c_bhdr->c_filestart;
758                                 ((struct kfs_i_info*)dentry->d_inode->i_fs_info)->init_size =
759                                                                                                                 c_bhdr->c_filesize;
760                                 break;
761                         default:
762                                 printk("Unknown file type %d in the CPIO!",
763                                        c_bhdr->c_mode & CPIO_FILE_MASK);
764                                 return -1;
765                 }
766                 inode = dentry->d_inode;
767                 /* Set other info from the CPIO entry */
768                 inode->i_uid = c_bhdr->c_uid;
769                 inode->i_gid = c_bhdr->c_gid;
770                 inode->i_atime.tv_sec = c_bhdr->c_mtime;
771                 inode->i_ctime.tv_sec = c_bhdr->c_mtime;
772                 inode->i_mtime.tv_sec = c_bhdr->c_mtime;
773                 inode->i_size = c_bhdr->c_filesize;
774                 //inode->i_XXX = c_bhdr->c_dev;                 /* and friends */
775                 inode->i_bdev = 0;                                              /* assuming blockdev? */
776                 inode->i_socket = FALSE;
777                 inode->i_blocks = c_bhdr->c_filesize;   /* blocksize == 1 */
778         }
779         return 0;
780 }
781
782 /* Adds an entry (from a CPIO archive) to KFS.  This will put all the FS
783  * metadata in memory, instead of having to reparse the entire archive each time
784  * we need to traverse.
785  *
786  * The other option is to just maintain a LL of {FN, FS}, and O(n) scan it.
787  *
788  * The path is a complete path, interpreted from the root of the mount point.
789  * Directories have a size of 0.  so do symlinks, but we don't handle those yet.
790  *
791  * If a directory does not exist for a file, this will return an error.  Don't
792  * use the -depth flag to find when building the CPIO archive, and this won't be
793  * a problem.  (Maybe) */
794 static int add_kfs_entry(struct super_block *sb, struct cpio_bin_hdr *c_bhdr)
795 {
796         char *path = c_bhdr->c_filename;
797         /* Root of the FS, already part of KFS */
798         if (!strcmp(path, "."))
799                 return 0;
800         return __add_kfs_entry(sb->s_mount->mnt_root, path, c_bhdr);
801 }
802
803 void parse_cpio_entries(struct super_block *sb, void *cpio_b)
804 {
805         struct cpio_newc_header *c_hdr = (struct cpio_newc_header*)cpio_b;
806
807         char buf[9] = {0};      /* temp space for strol conversions */
808         size_t namesize = 0;
809         int offset = 0;         /* offset in the cpio archive */
810         struct cpio_bin_hdr *c_bhdr = kmalloc(sizeof(*c_bhdr), 0);
811         memset(c_bhdr, 0, sizeof(*c_bhdr));
812
813         /* read all files and paths */
814         for (; ; c_hdr = (struct cpio_newc_header*)(cpio_b + offset)) {
815                 offset += sizeof(*c_hdr);
816                 if (strncmp(c_hdr->c_magic, "070701", 6)) {
817                         printk("Invalid magic number in CPIO header, aborting.\n");
818                         return;
819                 }
820                 c_bhdr->c_filename = (char*)c_hdr + sizeof(*c_hdr);
821                 namesize = cpio_strntol(buf, c_hdr->c_namesize, 8);
822                 printd("Namesize: %d\n", size);
823                 if (!strcmp(c_bhdr->c_filename, "TRAILER!!!"))
824                         break;
825                 c_bhdr->c_ino = cpio_strntol(buf, c_hdr->c_ino, 8);
826                 c_bhdr->c_mode = (int)cpio_strntol(buf, c_hdr->c_mode, 8);
827                 c_bhdr->c_uid = cpio_strntol(buf, c_hdr->c_uid, 8);
828                 c_bhdr->c_gid = cpio_strntol(buf, c_hdr->c_gid, 8);
829                 c_bhdr->c_nlink = (unsigned int)cpio_strntol(buf, c_hdr->c_nlink, 8);
830                 c_bhdr->c_mtime = cpio_strntol(buf, c_hdr->c_mtime, 8);
831                 c_bhdr->c_filesize = cpio_strntol(buf, c_hdr->c_filesize, 8);
832                 c_bhdr->c_dev_maj = cpio_strntol(buf, c_hdr->c_dev_maj, 8);
833                 c_bhdr->c_dev_min = cpio_strntol(buf, c_hdr->c_dev_min, 8);
834                 c_bhdr->c_rdev_maj = cpio_strntol(buf, c_hdr->c_rdev_maj, 8);
835                 c_bhdr->c_rdev_min = cpio_strntol(buf, c_hdr->c_rdev_min, 8);
836                 printd("File: %s: %d Bytes\n", c_bhdr->c_filename, c_bhdr->c_filesize);
837                 offset += namesize;
838                 /* header + name will be padded out to 4-byte alignment */
839                 offset = ROUNDUP(offset, 4);
840                 c_bhdr->c_filestart = cpio_b + offset;
841                 /* make this a function pointer or something */
842                 if (add_kfs_entry(sb, c_bhdr)) {
843                         printk("Failed to add an entry to KFS!\n");
844                         break;
845                 }
846                 offset += c_bhdr->c_filesize;
847                 offset = ROUNDUP(offset, 4);
848                 //printk("offset is %d bytes\n", offset);
849                 c_hdr = (struct cpio_newc_header*)(cpio_b + offset);
850         }
851         kfree(c_bhdr);
852 }