File <-> file descriptor management
[akaros.git] / kern / src / vfs.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  * Default implementations and global values for the VFS. */
6
7 #include <vfs.h> // keep this first
8 #include <sys/queue.h>
9 #include <assert.h>
10 #include <stdio.h>
11 #include <atomic.h>
12 #include <slab.h>
13 #include <kmalloc.h>
14 #include <kfs.h>
15 #include <pmap.h>
16
17 struct sb_tailq super_blocks = TAILQ_HEAD_INITIALIZER(super_blocks);
18 spinlock_t super_blocks_lock = SPINLOCK_INITIALIZER;
19 struct fs_type_tailq file_systems = TAILQ_HEAD_INITIALIZER(file_systems);
20 struct namespace default_ns;
21 // TODO: temp dcache, holds all dentries ever for now
22 struct dentry_slist dcache = SLIST_HEAD_INITIALIZER(dcache);
23 spinlock_t dcache_lock = SPINLOCK_INITIALIZER;
24
25 struct kmem_cache *dentry_kcache; // not to be confused with the dcache
26 struct kmem_cache *inode_kcache;
27 struct kmem_cache *file_kcache;
28
29 /* Mounts fs from dev_name at mnt_pt in namespace ns.  There could be no mnt_pt,
30  * such as with the root of (the default) namespace.  Not sure how it would work
31  * with multiple namespaces on the same FS yet.  Note if you mount the same FS
32  * multiple times, you only have one FS still (and one SB).  If we ever support
33  * that... */
34 struct vfsmount *mount_fs(struct fs_type *fs, char *dev_name,
35                           struct dentry *mnt_pt, int flags,
36                           struct namespace *ns)
37 {
38         struct super_block *sb;
39         struct vfsmount *vmnt = kmalloc(sizeof(struct vfsmount), 0);
40
41         /* Build the vfsmount, if there is no mnt_pt, mnt is the root vfsmount (for now).
42          * fields related to the actual FS, like the sb and the mnt_root are set in
43          * the fs-specific get_sb() call. */
44         if (!mnt_pt) {
45                 vmnt->mnt_parent = NULL;
46                 vmnt->mnt_mountpoint = NULL;
47         } else { /* common case, but won't be tested til we try to mount another FS */
48                 mnt_pt->d_mount_point = TRUE;
49                 mnt_pt->d_mounted_fs = vmnt;
50                 atomic_inc(&vmnt->mnt_refcnt); /* held by mnt_pt */
51                 vmnt->mnt_parent = mnt_pt->d_sb->s_mount;
52                 vmnt->mnt_mountpoint = mnt_pt;
53         }
54         TAILQ_INIT(&vmnt->mnt_child_mounts);
55         vmnt->mnt_flags = flags;
56         vmnt->mnt_devname = dev_name;
57         vmnt->mnt_namespace = ns;
58         atomic_inc(&ns->refcnt); /* held by vmnt */
59         atomic_set(&vmnt->mnt_refcnt, 1); /* for the ref in the NS tailq below */
60
61         /* Read in / create the SB */
62         sb = fs->get_sb(fs, flags, dev_name, vmnt);
63         if (!sb)
64                 panic("You're FS sucks");
65
66         /* TODO: consider moving this into get_sb or something, in case the SB
67          * already exists (mounting again) (if we support that) */
68         spin_lock(&super_blocks_lock);
69         TAILQ_INSERT_TAIL(&super_blocks, sb, s_list); /* storing a ref here... */
70         spin_unlock(&super_blocks_lock);
71
72         /* Update holding NS */
73         spin_lock(&ns->lock);
74         TAILQ_INSERT_TAIL(&ns->vfsmounts, vmnt, mnt_list);
75         spin_unlock(&ns->lock);
76         /* note to self: so, right after this point, the NS points to the root FS
77          * mount (we return the mnt, which gets assigned), the root mnt has a dentry
78          * for /, backed by an inode, with a SB prepped and in memory. */
79         return vmnt;
80 }
81
82 void vfs_init(void)
83 {
84         struct fs_type *fs;
85
86         dentry_kcache = kmem_cache_create("dentry", sizeof(struct dentry),
87                                           __alignof__(struct dentry), 0, 0, 0);
88         inode_kcache = kmem_cache_create("inode", sizeof(struct inode),
89                                          __alignof__(struct inode), 0, 0, 0);
90         file_kcache = kmem_cache_create("file", sizeof(struct file),
91                                         __alignof__(struct file), 0, 0, 0);
92
93         atomic_set(&default_ns.refcnt, 1); // default NS never dies, +1 to exist
94         spinlock_init(&default_ns.lock);
95         default_ns.root = NULL;
96         TAILQ_INIT(&default_ns.vfsmounts);
97
98         /* build list of all FS's in the system.  put yours here.  if this is ever
99          * done on the fly, we'll need to lock. */
100         TAILQ_INSERT_TAIL(&file_systems, &kfs_fs_type, list);
101         TAILQ_FOREACH(fs, &file_systems, list)
102                 printk("Supports the %s Filesystem\n", fs->name);
103
104         /* mounting KFS at the root (/), pending root= parameters */
105         // TODO: linux creates a temp root_fs, then mounts the real root onto that
106         default_ns.root = mount_fs(&kfs_fs_type, "RAM", NULL, 0, &default_ns);
107
108         printk("vfs_init() completed\n");
109         /*
110         put structs and friends in struct proc, and init in proc init
111         */
112         // LOOKUP: follow_mount, follow_link, etc
113         // pains in the ass for having .. or . in the middle of the path
114 }
115
116 /* Builds / populates the qstr of a dentry based on its d_iname.  If there is an
117  * l_name, (long), it will use that instead of the inline name.  This will
118  * probably change a bit. */
119 void qstr_builder(struct dentry *dentry, char *l_name)
120 {
121         dentry->d_name.name = l_name ? l_name : dentry->d_iname;
122         // TODO: pending what we actually do in d_hash
123         //dentry->d_name.hash = dentry->d_op->d_hash(dentry, &dentry->d_name); 
124         dentry->d_name.hash = 0xcafebabe;
125         dentry->d_name.len = strnlen(dentry->d_name.name, MAX_FILENAME_SZ);
126 }
127
128 /* Superblock functions */
129
130 /* Helper to alloc and initialize a generic superblock.  This handles all the
131  * VFS related things, like lists.  Each FS will need to handle its own things
132  * in it's *_get_sb(), usually involving reading off the disc. */
133 struct super_block *get_sb(void)
134 {
135         struct super_block *sb = kmalloc(sizeof(struct super_block), 0);
136         sb->s_dirty = FALSE;
137         spinlock_init(&sb->s_lock);
138         atomic_set(&sb->s_refcnt, 1); // for the ref passed out
139         TAILQ_INIT(&sb->s_inodes);
140         TAILQ_INIT(&sb->s_dirty_i);
141         TAILQ_INIT(&sb->s_io_wb);
142         SLIST_INIT(&sb->s_anon_d);
143         TAILQ_INIT(&sb->s_files);
144         sb->s_fs_info = 0; // can override somewhere else
145         return sb;
146 }
147
148 /* Final stages of initializing a super block, including creating and linking
149  * the root dentry, root inode, vmnt, and sb.  The d_op and root_ino are
150  * FS-specific, but otherwise it's FS-independent, tricky, and not worth having
151  * around multiple times.
152  *
153  * Not the world's best interface, so it's subject to change, esp since we're
154  * passing (now 3) FS-specific things. */
155 void init_sb(struct super_block *sb, struct vfsmount *vmnt,
156              struct dentry_operations *d_op, unsigned long root_ino,
157              void *d_fs_info)
158 {
159         /* Build and init the first dentry / inode.  The dentry ref is stored later
160          * by vfsmount's mnt_root.  The parent is dealt with later. */
161         struct dentry *d_root = get_dentry(sb, 0,  "/");        /* probably right */
162
163         /* a lot of here on down is normally done in lookup() */
164         d_root->d_op = d_op;
165         d_root->d_fs_info = d_fs_info;
166         struct inode *inode = sb->s_op->alloc_inode(sb);
167         if (!inode)
168                 panic("This FS sucks!");
169         d_root->d_inode = inode;
170         TAILQ_INSERT_TAIL(&inode->i_dentry, d_root, d_alias);
171         atomic_inc(&d_root->d_refcnt);                  /* held by the inode */
172         inode->i_ino = root_ino;
173         /* TODO: add the inode to the appropriate list (off i_list) */
174         /* TODO: do we need to read in the inode?  can we do this on demand? */
175         /* if this FS is already mounted, we'll need to do something different. */
176         sb->s_op->read_inode(inode);
177         /* Link the dentry and SB to the VFS mount */
178         vmnt->mnt_root = d_root;                                /* refcnt'd above */
179         vmnt->mnt_sb = sb;
180         /* If there is no mount point, there is no parent.  This is true only for
181          * the rootfs. */
182         if (vmnt->mnt_mountpoint) {
183                 d_root->d_parent = vmnt->mnt_mountpoint;        /* dentry of the root */
184                 atomic_inc(&vmnt->mnt_mountpoint->d_refcnt);/* held by d_root */
185         }
186         /* insert the dentry into the dentry cache.  when's the earliest we can?
187          * when's the earliest we should?  what about concurrent accesses to the
188          * same dentry?  should be locking the dentry... */
189         dcache_put(d_root); // TODO: should set a d_flag too
190 }
191
192 /* Dentry Functions */
193
194 /* Helper to alloc and initialize a generic dentry.
195  *
196  * If the name is longer than the inline name, it will kmalloc a buffer, so
197  * don't worry about the storage for *name after calling this. */
198 struct dentry *get_dentry(struct super_block *sb, struct dentry *parent,
199                           char *name)
200 {
201         assert(name);
202         size_t name_len = strnlen(name, MAX_FILENAME_SZ);       /* not including \0! */
203         struct dentry *dentry = kmem_cache_alloc(dentry_kcache, 0);
204         char *l_name = 0;
205
206         //memset(dentry, 0, sizeof(struct dentry));
207         atomic_set(&dentry->d_refcnt, 1);       /* this ref is returned */
208         spinlock_init(&dentry->d_lock);
209         TAILQ_INIT(&dentry->d_subdirs);
210         dentry->d_time = 0;
211         dentry->d_sb = sb;                                      /* storing a ref here... */
212         dentry->d_mount_point = FALSE;
213         dentry->d_mounted_fs = 0;
214         dentry->d_parent = parent;
215         if (parent)                                                     /* no parent for rootfs mount */
216                 atomic_inc(&parent->d_refcnt);
217         dentry->d_flags = 0;                            /* related to its dcache state */
218         dentry->d_fs_info = 0;
219         SLIST_INIT(&dentry->d_bucket);
220         if (name_len < DNAME_INLINE_LEN) {
221                 strncpy(dentry->d_iname, name, name_len);
222                 dentry->d_iname[name_len] = '\0';
223                 qstr_builder(dentry, 0);
224         } else {
225                 l_name = kmalloc(name_len + 1, 0);
226                 assert(l_name);
227                 strncpy(l_name, name, name_len);
228                 l_name[name_len] = '\0';
229                 qstr_builder(dentry, l_name);
230         }
231         return dentry;
232 }
233
234 /* Adds a dentry to the dcache. */
235 void dcache_put(struct dentry *dentry)
236 {
237         // TODO: prob should do something with the dentry flags
238         spin_lock(&dcache_lock);
239         SLIST_INSERT_HEAD(&dcache, dentry, d_hash);
240         spin_unlock(&dcache_lock);
241 }
242
243 /* File functions */
244
245 /* Read count bytes from the file into buf, starting at *offset, which is increased
246  * accordingly, returning the number of bytes transfered.  Most filesystems will
247  * use this function for their f_op->read.  Note, this uses the page cache.
248  * Want to try out page remapping later on... */
249 ssize_t generic_file_read(struct file *file, char *buf, size_t count,
250                           off_t *offset)
251 {
252         struct page *page;
253         int error;
254         off_t page_off;
255         unsigned long first_idx, last_idx;
256         size_t copy_amt;
257         char *buf_end;
258
259         /* Consider pushing some error checking higher in the VFS */
260         if (!count)
261                 return 0;
262         if (*offset == file->f_inode->i_size)
263                 return 0; /* EOF */
264         /* Make sure we don't go past the end of the file */
265         if (*offset + count > file->f_inode->i_size) {
266                 count = file->f_inode->i_size - *offset;
267         }
268         page_off = *offset & (PGSIZE - 1);
269         first_idx = *offset >> PGSHIFT;
270         last_idx = (*offset + count) >> PGSHIFT;
271         buf_end = buf + count;
272         /* For each file page, make sure it's in the page cache, then copy it out.
273          * TODO: will probably need to consider concurrently truncated files here.*/
274         for (int i = first_idx; i <= last_idx; i++) {
275                 error = file_load_page(file, i, &page);
276                 assert(!error); /* TODO: handle ENOMEM and friends */
277                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
278                 /* TODO: think about this.  if it's a user buffer, we're relying on
279                  * current to detect whose it is (which should work for async calls). */
280                 if (current) {
281                         memcpy_to_user(current, buf, page2kva(page) + page_off, copy_amt);
282                 } else {
283                         memcpy(buf, page2kva(page) + page_off, copy_amt);
284                 }
285                 buf += copy_amt;
286                 page_off = 0;
287                 page_decref(page);      /* it's still in the cache, we just don't need it */
288         }
289         assert(buf == buf_end);
290         *offset += count;
291         return count;
292 }
293
294 /* Write count bytes from buf to the file, starting at *offset, which is increased
295  * accordingly, returning the number of bytes transfered.  Most filesystems will
296  * use this function for their f_op->write.  Note, this uses the page cache.
297  * Changes don't get flushed to disc til there is an fsync, page cache eviction,
298  * or other means of trying to writeback the pages. */
299 ssize_t generic_file_write(struct file *file, const char *buf, size_t count,
300                            off_t *offset)
301 {
302         struct page *page;
303         int error;
304         off_t page_off;
305         unsigned long first_idx, last_idx;
306         size_t copy_amt;
307         const char *buf_end;
308
309         /* Consider pushing some error checking higher in the VFS */
310         if (!count)
311                 return 0;
312         /* Extend the file.  Should put more checks in here, and maybe do this per
313          * page in the for loop below. */
314         if (*offset + count > file->f_inode->i_size)
315                 file->f_inode->i_size = *offset + count;
316         page_off = *offset & (PGSIZE - 1);
317         first_idx = *offset >> PGSHIFT;
318         last_idx = (*offset + count) >> PGSHIFT;
319         buf_end = buf + count;
320         /* For each file page, make sure it's in the page cache, then write it.*/
321         for (int i = first_idx; i <= last_idx; i++) {
322                 error = file_load_page(file, i, &page);
323                 assert(!error); /* TODO: handle ENOMEM and friends */
324                 copy_amt = MIN(PGSIZE - page_off, buf_end - buf);
325                 /* TODO: think about this.  if it's a user buffer, we're relying on
326                  * current to detect whose it is (which should work for async calls). */
327                 if (current) {
328                         memcpy_to_user(current, page2kva(page) + page_off, buf, copy_amt);
329                 } else {
330                         memcpy(page2kva(page) + page_off, buf, copy_amt);
331                 }
332                 buf += copy_amt;
333                 page_off = 0;
334                 page_decref(page);      /* it's still in the cache, we just don't need it */
335         }
336         assert(buf == buf_end);
337         *offset += count;
338         return count;
339 }
340
341 /* Page cache functions */
342
343 /* Looks up the index'th page in the page map, returning an incref'd reference,
344  * or 0 if it was not in the map. */
345 struct page *pm_find_page(struct page_map *pm, unsigned long index)
346 {
347         spin_lock(&pm->pm_tree_lock);
348         struct page *page = (struct page*)radix_lookup(&pm->pm_tree, index);
349         if (page)
350                 page_incref(page);
351         spin_unlock(&pm->pm_tree_lock);
352         return page;
353 }
354
355 /* Attempts to insert the page into the page_map, returns 0 for success, or an
356  * error code if there was one already (EEXIST) or we ran out of memory
357  * (ENOMEM).  On success, this will preemptively lock the page, and will also
358  * store a reference to the page in the pm. */
359 int pm_insert_page(struct page_map *pm, unsigned long index, struct page *page)
360 {
361         int error = 0;
362         spin_lock(&pm->pm_tree_lock);
363         error = radix_insert(&pm->pm_tree, index, page);
364         if (!error) {
365                 page_incref(page);
366                 page->pg_flags |= PG_LOCKED;
367                 page->pg_mapping = pm;
368                 page->pg_index = index;
369                 pm->pm_num_pages++;
370         }
371         spin_unlock(&pm->pm_tree_lock);
372         return error;
373 }
374
375 /* Removes the page, including its reference.  Not sure yet what interface we
376  * want to this (pm and index or page), and this has never been used.  There are
377  * also issues with when you want to call this, since a page in the cache may be
378  * mmap'd by someone else. */
379 int pm_remove_page(struct page_map *pm, struct page *page)
380 {
381         void *retval;
382         warn("pm_remove_page() hasn't been thought through or tested.");
383         spin_lock(&pm->pm_tree_lock);
384         retval = radix_delete(&pm->pm_tree, page->pg_index);
385         spin_unlock(&pm->pm_tree_lock);
386         assert(retval == (void*)page);
387         page_decref(page);
388         page->pg_mapping = 0;
389         page->pg_index = 0;
390         pm->pm_num_pages--;
391         return 0;
392 }
393
394 /* Makes sure the index'th page from file is loaded in the page cache and
395  * returns its location via **pp.  Note this will give you a refcnt'd reference.
396  * This may block! TODO: (BLK) */
397 int file_load_page(struct file *file, unsigned long index, struct page **pp)
398 {
399         struct page_map *pm = file->f_mapping;
400         struct page *page;
401         int error;
402         bool page_was_mapped = TRUE;
403
404         page = pm_find_page(pm, index);
405         while (!page) {
406                 /* kpage_alloc, since we want the page to persist after the proc
407                  * dies (can be used by others, until the inode shuts down). */
408                 if (kpage_alloc(&page))
409                         return -ENOMEM;
410                 /* might want to initialize other things, perhaps in page_alloc() */
411                 page->pg_flags = 0;
412                 error = pm_insert_page(pm, index, page);
413                 switch (error) {
414                         case 0:
415                                 page_was_mapped = FALSE;
416                                 break;
417                         case -EEXIST:
418                                 /* the page was mapped already (benign race), just get rid of
419                                  * our page and try again (the only case that uses the while) */
420                                 page_decref(page);
421                                 page = pm_find_page(pm, index);
422                                 break;
423                         default:
424                                 /* something is wrong, bail out! */
425                                 page_decref(page);
426                                 return error;
427                 }
428         }
429         *pp = page;
430         /* if the page was in the map, we need to do some checks, and might have to
431          * read in the page later.  If the page was freshly inserted to the pm by
432          * us, we skip this since we are the one doing the readpage(). */
433         if (page_was_mapped) {
434                 /* is it already here and up to date?  if so, we're done */
435                 if (page->pg_flags & PG_UPTODATE)
436                         return 0;
437                 /* if not, try to lock the page (could BLOCK) */
438                 lock_page(page);
439                 /* we got it, is our page still in the cache?  check the mapping.  if
440                  * not, start over, perhaps with EAGAIN and outside support */
441                 if (!page->pg_mapping)
442                         panic("Page is not in the mapping!  Haven't implemented this!");
443                 /* double check, are we up to date?  if so, we're done */
444                 if (page->pg_flags & PG_UPTODATE) {
445                         unlock_page(page);
446                         return 0;
447                 }
448         }
449         /* if we're here, the page is locked by us, and it needs to be read in */
450         assert(page->pg_mapping == pm);
451         error = pm->pm_op->readpage(file, page);
452         assert(!error);
453         /* Try to sleep on the IO.  The page will be unlocked when the IO is done */
454         lock_page(page);
455         unlock_page(page);
456         assert(page->pg_flags & PG_UPTODATE);
457         return 0;
458 }
459
460 /* Process-related File management functions */
461
462 /* Given any FD, get the appropriate file, 0 o/w */
463 struct file *get_file_from_fd(struct files_struct *open_files, int file_desc)
464 {
465         struct file *retval = 0;
466         spin_lock(&open_files->lock);
467         if (file_desc < open_files->max_fdset) {
468                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
469                         /* while max_files and max_fdset might not line up, we should never
470                          * have a valid fdset higher than files */
471                         assert(file_desc < open_files->max_files);
472                         retval = open_files->fd[file_desc];
473                         assert(retval);
474                         atomic_inc(&retval->f_refcnt);
475                 }
476         }
477         spin_unlock(&open_files->lock);
478         return retval;
479 }
480
481 /* Remove FD from the open files, if it was there, and return f.  Currently,
482  * this decref's f, so the return value is not consumable or even usable.  This
483  * hasn't been thought through yet. */
484 struct file *put_file_from_fd(struct files_struct *open_files, int file_desc)
485 {
486         struct file *f = 0;
487         spin_lock(&open_files->lock);
488         if (file_desc < open_files->max_fdset) {
489                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, file_desc)) {
490                         /* while max_files and max_fdset might not line up, we should never
491                          * have a valid fdset higher than files */
492                         assert(file_desc < open_files->max_files);
493                         f = open_files->fd[file_desc];
494                         open_files->fd[file_desc] = 0;
495                         /* TODO: (REF) need to make sure we free if we hit 0 (might do this
496                          * in the caller */
497                         if (f)
498                                 atomic_dec(&f->f_refcnt);
499                         // if 0, drop, decref from higher, sync, whatever
500                 }
501         }
502         spin_unlock(&open_files->lock);
503         return f;
504 }
505
506 /* Inserts the file in the files_struct, returning the corresponding new file
507  * descriptor, or an error code.  We currently grab the first open FD. */
508 int insert_file(struct files_struct *open_files, struct file *file)
509 {
510         int slot = -1;
511         spin_lock(&open_files->lock);
512         for (int i = 0; i < open_files->max_fdset; i++) {
513                 if (GET_BITMASK_BIT(open_files->open_fds->fds_bits, i))
514                         continue;
515                 slot = i;
516                 SET_BITMASK_BIT(open_files->open_fds->fds_bits, slot);
517                 assert(slot < open_files->max_files && open_files->fd[slot] == 0);
518                 open_files->fd[slot] = file;
519                 atomic_inc(&file->f_refcnt);
520                 if (slot >= open_files->next_fd)
521                         open_files->next_fd = slot + 1;
522                 break;
523         }
524         if (slot == -1) /* should expand the FD array and fd_set */
525                 warn("Ran out of file descriptors, deal with me!");
526         spin_unlock(&open_files->lock);
527         return slot;
528 }