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