diff options
-rw-r--r-- | README.md | 16 | ||||
-rw-r--r-- | src/kernel/include/vfs.h | 31 | ||||
-rw-r--r-- | src/kernel/user/nullfs.c | 4 | ||||
-rw-r--r-- | src/kernel/user/vfs.c | 146 |
4 files changed, 158 insertions, 39 deletions
@@ -90,15 +90,25 @@ running the tests): src/apps/ userspace binaries src/tests/ test suite -## Important TODOs +## Roadmap + +### Plans for soon + +* Implement syscalls +* Write device drivers : VGA, keyboard, ATA, FAT, VESA + +### Important TODOs not to overlook -* The VFS code is not thread-safe ! Very dangerous, must be taken care of soon. - (important design considerations not to be overlooked) * How does a process exit, what does it do, how do processes synchronize ? +* Timers, workers, sleeping * Have several threads in a single process * Better handling of errors (rather than panicing) ; userspace apps should not have the possibility of crashing the system +### Things not sure + +* VFS thread safety : is the design correct ? (probably) + ## Licence None of the source files have a licence header because it's cumbersome. All the diff --git a/src/kernel/include/vfs.h b/src/kernel/include/vfs.h index af94b2a..37b28b9 100644 --- a/src/kernel/include/vfs.h +++ b/src/kernel/include/vfs.h @@ -2,7 +2,9 @@ #include <stdbool.h> #include <malloc.h> + #include <hashtbl.h> +#include <mutex.h> #include <fs.h> // common header @@ -16,6 +18,15 @@ // some data managed by the underlying filesystem. The following types are aliases to void*, // but are used to disambiguate the different types of void* : fs_handle_ptr, fs_node_ptr, fs_ptr +// About thread safety : +// - The VFS implements a locking mechanism on handles so that only one operation is executed +// at the same time on a given handle +// - Same for FS nodes +// - The VFS does not lock nodes that have a handle open to them : it is the FS code's responsibility +// to refuse some commands if neccessary on a node that is open. +// - The VFS does not implement any locking mechanism on filesystems themselves (e.g. the add_source +// implementation must have its own locking system) + typedef void* fs_handle_ptr; typedef void* fs_node_ptr; typedef void* fs_ptr; @@ -36,10 +47,12 @@ typedef struct { } fs_handle_ops_t; typedef struct fs_handle { - // These two field are filled by the VFS's generic open() code + // These field are filled by the VFS's generic open() code struct fs *fs; struct fs_node *node; + int refs; + mutex_t lock; // These fields are filled by the FS's specific open() code fs_handle_ops_t *ops; @@ -59,6 +72,7 @@ typedef struct fs_handle { // - delete() is expected to unlink the node from its parent (make it inaccessible) and delete // the corresponding data. It is guaranteed that delete() is never called on a node that // is currently in use. (different from posix semantics !) +// - move() may be called on a node that is currently in use // - the root node of a filesystem is created when the filesystem is created // - dispose() is not called on the root node when a filesystem is shutdown // - delete() is not expected to delete recursively : it should fail on a non-empty directory @@ -76,12 +90,13 @@ typedef struct { typedef struct fs_node { // These fields are filled by the VFS's generic walk() code - struct fs *fs; int refs; + mutex_t lock; + + char* name; // name in parent + struct fs *fs; hashtbl_t *children; // not all children, only those in memory - struct fs_node *parent; - char* name; // name in parent // These fields are filled by the FS's specific walk() code fs_node_ops_t *ops; @@ -92,7 +107,7 @@ typedef struct fs_node { // Structure defining a filesystem typedef struct { - bool (*add_source)(fs_ptr fs, fs_handle_t* source); + bool (*add_source)(fs_ptr fs, fs_handle_t* source, const char* opts); void (*shutdown)(fs_ptr fs); } fs_ops_t; @@ -110,7 +125,7 @@ typedef struct fs { // Structure defining a filesystem driver typedef struct { - bool (*make)(fs_handle_t *source, char* opts, fs_t *d); + bool (*make)(fs_handle_t *source, const char* opts, fs_t *d); bool (*detect)(fs_handle_t *source); } fs_driver_ops_t; @@ -133,8 +148,8 @@ fs_node_t* fs_walk_path_except_last(fs_node_t* from, const char *p, char* last_f void register_fs_driver(const char* name, fs_driver_ops_t *ops); -fs_t* make_fs(const char* driver, fs_handle_t *source, char* opts); -bool fs_add_source(fs_t *fs, fs_handle_t *source); +fs_t* make_fs(const char* driver, fs_handle_t *source, const char* opts); +bool fs_add_source(fs_t *fs, fs_handle_t *source, const char* opts); void ref_fs(fs_t *fs); void unref_fs(fs_t *fs); diff --git a/src/kernel/user/nullfs.c b/src/kernel/user/nullfs.c index 989c0c6..3065192 100644 --- a/src/kernel/user/nullfs.c +++ b/src/kernel/user/nullfs.c @@ -6,7 +6,7 @@ #include <nullfs.h> // nullfs driver -static bool nullfs_fs_make(fs_handle_t *source, char* opts, fs_t *d); +static bool nullfs_fs_make(fs_handle_t *source, const char* opts, fs_t *d); // nullfs fs_t static void nullfs_fs_shutdown(fs_ptr fs); @@ -132,7 +132,7 @@ void register_nullfs_driver() { register_fs_driver("nullfs", &nullfs_driver_ops); } -bool nullfs_fs_make(fs_handle_t *source, char* opts, fs_t *fs_s) { +bool nullfs_fs_make(fs_handle_t *source, const char* opts, fs_t *fs_s) { nullfs_t *fs = (nullfs_t*)malloc(sizeof(nullfs_t)); if (fs == 0) return false; diff --git a/src/kernel/user/vfs.c b/src/kernel/user/vfs.c index 1f7bacd..a5d56ef 100644 --- a/src/kernel/user/vfs.c +++ b/src/kernel/user/vfs.c @@ -28,7 +28,7 @@ void register_fs_driver(const char* name, fs_driver_ops_t *ops) { // CREATING AND DELETING FILE SYSTEMS // // ================================== // -fs_t *make_fs(const char* drv_name, fs_handle_t *source, char* opts) { +fs_t *make_fs(const char* drv_name, fs_handle_t *source, const char* opts) { // Look for driver fs_driver_t *d = 0; for(fs_driver_t *i = drivers; i != 0; i = i->next) { @@ -56,8 +56,8 @@ fs_t *make_fs(const char* drv_name, fs_handle_t *source, char* opts) { } } -bool fs_add_source(fs_t *fs, fs_handle_t *source) { - return fs->ops->add_source && fs->ops->add_source(fs->data, source); +bool fs_add_source(fs_t *fs, fs_handle_t *source, const char* opts) { + return fs->ops->add_source && fs->ops->add_source(fs->data, source, opts); } void ref_fs(fs_t *fs) { @@ -78,19 +78,23 @@ void unref_fs(fs_t *fs) { // WALKING IN THE FILE SYSTEM CREATING AND DELETING NODES // void ref_fs_node(fs_node_t *n) { + mutex_lock(&n->lock); n->refs++; + mutex_unlock(&n->lock); } void unref_fs_node(fs_node_t *n) { + mutex_lock(&n->lock); n->refs--; if (n->refs == 0) { ASSERT(n != &n->fs->root); ASSERT(n->parent != 0); ASSERT(n->name != 0); + mutex_lock(&n->parent->lock); hashtbl_remove(n->parent->children, n->name); - if (n->ops->dispose) n->ops->dispose(n->data); + mutex_unlock(&n->parent->lock); unref_fs_node(n->parent); unref_fs(n->fs); @@ -98,14 +102,19 @@ void unref_fs_node(fs_node_t *n) { if (n->children != 0) delete_hashtbl(n->children); free(n->name); free(n); + } else { + mutex_unlock(&n->lock); } } fs_node_t* fs_walk_one(fs_node_t* from, const char* file) { + mutex_lock(&from->lock); + if (from->children != 0) { fs_node_t *n = (fs_node_t*)hashtbl_find(from->children, file); if (n != 0) { ref_fs_node(n); + mutex_unlock(&from->lock); return n; } } @@ -113,10 +122,11 @@ fs_node_t* fs_walk_one(fs_node_t* from, const char* file) { bool walk_ok = false, add_ok = false; fs_node_t *n = (fs_node_t*)malloc(sizeof(fs_node_t)); - if (n == 0) return 0; + if (n == 0) goto error; n->fs = from->fs; n->refs = 1; + n->lock = MUTEX_UNLOCKED; n->parent = from; n->children = 0; n->name = strdup(file); @@ -133,6 +143,8 @@ fs_node_t* fs_walk_one(fs_node_t* from, const char* file) { add_ok = hashtbl_add(from->children, n->name, n); if (!add_ok) goto error; + mutex_unlock(&from->lock); + ref_fs_node(n->parent); ref_fs(n->fs); @@ -140,8 +152,9 @@ fs_node_t* fs_walk_one(fs_node_t* from, const char* file) { error: if (walk_ok) n->ops->dispose(n->data); - if (n->name != 0) free(n->name); - free(n); + if (n != 0 && n->name != 0) free(n->name); + if (n != 0) free(n); + mutex_unlock(&from->lock); return 0; } @@ -241,7 +254,10 @@ bool fs_create(fs_t *fs, const char* file, int type) { fs_node_t *n = fs_walk_path_except_last(&fs->root, file, name); if (n == 0) return false; + mutex_lock(&n->lock); bool ret = n->ops->create && n->ops->create(n->data, name, type); + mutex_unlock(&n->lock); + unref_fs_node(n); return ret; } @@ -257,7 +273,10 @@ bool fs_delete(fs_t *fs, const char* file) { if (x != 0) return false; } + mutex_lock(&n->lock); bool ret = n->ops->delete && n->ops->delete(n->data, name); + mutex_unlock(&n->lock); + unref_fs_node(n); return ret; } @@ -274,8 +293,50 @@ bool fs_move(fs_t *fs, const char* from, const char* to) { return false; } - bool ret = old_parent->ops->move && old_parent->ops->move(old_parent->data, old_name, new_parent, new_name); + bool ret = false; + if (!old_parent->ops->move) goto end; + + mutex_lock(&old_parent->lock); + mutex_lock(&new_parent->lock); + + fs_node_t *the_node = (old_parent->children != 0 ? + (fs_node_t*)hashtbl_find(old_parent->children, old_name) : 0); + if (the_node) { + mutex_lock(&the_node->lock); + + char* new_name_dup = strdup(new_name); + if (new_name_dup == 0) goto unlock_end; // we failed + + bool add_ok = hashtbl_add(new_parent->children, new_name_dup, the_node); + if (!add_ok) { + free(new_name_dup); + goto unlock_end; + } + + ret = old_parent->ops->move(old_parent->data, old_name, new_parent, new_name); + + if (ret) { + // adjust node parameters + hashtbl_remove(old_parent->children, old_name); + free(the_node->name); + the_node->name = new_name_dup; + the_node->parent = new_parent; + } else { + hashtbl_remove(new_parent->children, new_name_dup); + free(new_name_dup); + } + + unlock_end: + mutex_unlock(&the_node->lock); + } else { + ret = old_parent->ops->move(old_parent->data, old_name, new_parent, new_name); + } + + mutex_unlock(&old_parent->lock); + mutex_unlock(&new_parent->lock); + +end: unref_fs_node(old_parent); unref_fs_node(new_parent); return ret; @@ -285,7 +346,10 @@ bool fs_stat(fs_t *fs, const char* file, stat_t *st) { fs_node_t* n = fs_walk_path(&fs->root, file); if (n == 0) return false; + mutex_lock(&n->lock); bool ret = n->ops->stat && n->ops->stat(n->data, st); + mutex_unlock(&n->lock); + unref_fs_node(n); return ret; } @@ -294,7 +358,10 @@ int fs_ioctl(fs_t *fs, const char* file, int command, void* data) { fs_node_t* n = fs_walk_path(&fs->root, file); if (n == 0) return false; + mutex_lock(&n->lock); int ret = (n->ops->ioctl ? n->ops->ioctl(n->data, command, data) : -1); + mutex_unlock(&n->lock); + unref_fs_node(n); return ret; } @@ -310,42 +377,51 @@ fs_handle_t* fs_open(fs_t *fs, const char* file, int mode) { n = fs_walk_path(&fs->root, file); } } - if (n == 0) return false; + if (n == 0) return 0; + + mutex_lock(&n->lock); mode &= ~FM_CREATE; fs_handle_t *h = (fs_handle_t*)malloc(sizeof(fs_handle_t)); - if (h == 0) { - unref_fs_node(n); - return 0; - } + if (h == 0) goto error; h->refs = 1; + h->lock = MUTEX_UNLOCKED; h->fs = fs; h->node = n; - if (n->ops->open(n->data, mode, h)) { - // our reference to node n is transferred to the file handle - ref_fs(fs); - return h; - } else { - unref_fs_node(n); - free(h); - return 0; - } + bool open_ok = n->ops->open(n->data, mode, h); + if (!open_ok) goto error; + + // our reference to node n is transferred to the file handle + mutex_unlock(&n->lock); + ref_fs(fs); + return h; + +error: + mutex_unlock(&n->lock); + unref_fs_node(n); + if (h != 0) free(h); + return 0; } void ref_file(fs_handle_t *file) { + mutex_lock(&file->lock); file->refs++; + mutex_unlock(&file->lock); } void unref_file(fs_handle_t *file) { + mutex_lock(&file->lock); file->refs--; if (file->refs == 0) { file->ops->close(file->data); unref_fs_node(file->node); unref_fs(file->fs); free(file); + } else { + mutex_unlock(&file->lock); } } @@ -357,24 +433,42 @@ size_t file_read(fs_handle_t *f, size_t offset, size_t len, char* buf) { if (!(f->mode & FM_READ)) return 0; if (f->ops->read == 0) return 0; - return f->ops->read(f->data, offset, len, buf); + + mutex_lock(&f->lock); + size_t ret = f->ops->read(f->data, offset, len, buf); + mutex_unlock(&f->lock); + + return ret; } size_t file_write(fs_handle_t *f, size_t offset, size_t len, const char* buf) { if (!(f->mode & FM_WRITE)) return 0; if (f->ops->write == 0) return 0; - return f->ops->write(f->data, offset, len, buf); + + mutex_lock(&f->lock); + size_t ret = f->ops->write(f->data, offset, len, buf); + mutex_unlock(&f->lock); + + return ret; } bool file_stat(fs_handle_t *f, stat_t *st) { - return f->node->ops->stat && f->node->ops->stat(f->node->data, st); + mutex_lock(&f->node->lock); + bool ret = f->node->ops->stat && f->node->ops->stat(f->node->data, st); + mutex_unlock(&f->node->lock); + + return ret; } bool file_readdir(fs_handle_t *f, dirent_t *d) { if (!(f->mode & FM_READDIR)) return 0; - return f->ops->readdir && f->ops->readdir(f->data, d); + mutex_lock(&f->lock); + bool ret = f->ops->readdir && f->ops->readdir(f->data, d); + mutex_unlock(&f->lock); + + return ret; } /* vim: set ts=4 sw=4 tw=0 noet :*/ |