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