support mkdir (#8)

* update fuser version

* remove type extension

* fix lookup bug

* fix mkdir not working

* cleanup

* update docs

* fix markdown syntax

* fix md syntax

* add pr template

Author: jobala

.github/pull_request_template.md

@@ -0,0 +1,3 @@
+## overview
+
+## testing instructions

.vscode/launch.json

@@ -0,0 +1,45 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "lldb",
+      "request": "launch",
+      "name": "Debug executable 'tinyFS'",
+      "cargo": {
+        "args": [
+          "build",
+          "--bin=tinyFS",
+          "--package=tinyFS"
+        ],
+        "filter": {
+          "name": "tinyFS",
+          "kind": "bin"
+        }
+      },
+      "args": [],
+      "cwd": "${workspaceFolder}"
+    },
+    {
+      "type": "lldb",
+      "request": "launch",
+      "name": "Debug unit tests in executable 'tinyFS'",
+      "cargo": {
+        "args": [
+          "test",
+          "--no-run",
+          "--bin=tinyFS",
+          "--package=tinyFS"
+        ],
+        "filter": {
+          "name": "tinyFS",
+          "kind": "bin"
+        }
+      },
+      "args": [],
+      "cwd": "${workspaceFolder}"
+    }
+  ]
+}

Cargo.lock

@@ -4,9 +4,8 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
-fuse = "0.3.1"
+fuser = "0.15.1"
 bincode = "1.3.3"
 bitvec = "1"
 serde = { version = "1", features = ["derive"] }
-time = "0.1"
 libc = "0.2.169"

Cargo.toml

@@ -1,3 +1,3 @@
 run:
-	sudo fusermount -u /tmp/tiny > /dev/null 2>&1
+	- sudo fusermount -u /tmp/tiny > /dev/null 2>&1
 	cargo run

Makefile

@@ -9,7 +9,7 @@ TinyFS is a little filesystem with no big plans.
 
 ## Running
 
-1. To start **tinyFS** run `cargo run` in this project's root dir
+1. To start **tinyFS** run `make run` in this project's root dir
 2. To interact with tinyFS, open another terminal and perform file operations on `/tmp/tiny` ie `stat /tmp/tiny`
 
 ## Resources
@@ -18,16 +18,13 @@ TinyFS is a little filesystem with no big plans.
 - [To FUSE or Not To Fuse](https://libfuse.github.io/doxygen/fast17-vangoor.pdf)
 - [Fuse Filesystems](https://zsiciarz.github.io/24daysofrust/book/vol1/day15.html)
 
-## Design Docs
-
-- [tinyfs intro](./design/tinyfs.md)
-- [format disk](./design/mkfs.md)
-- [initialize filesystem](./design/fs_init.md)
-- [stat](./design/stat.md)
-- [ls](./design/ls.md)
-- [mkdir]() Not Implemented
-- [rmdir]() Not Implemented
-- [create]() Not Implemented
-- [read]() Not Implemented
-- [write]() Not Implemented
-- [unlink]() Not Implemented
+## Supported
+
+- [x] stat
+- [x] ls
+- [x] mkdir
+- [ ] rmdir
+- [ ] create
+- [ ] read
+- [ ] write
+- [ ] unlink

README.md

@@ -0,0 +1,7 @@
+## ls
+
+## Goals
+
+## Non-Goals
+
+## Design

design/ls.md

@@ -0,0 +1,23 @@
+## Support mkdir
+
+The `mkdir` command is used to create directories.
+
+## Goals
+
+- Support mkdir
+
+## Non-Goals
+
+## Design
+
+Directory creation is handled by the `mkdir` FUSE function. The method signature specifies the **parent** directory, the
+directory **name** and **mode** -- permissions.
+
+```rust
+  fn mkdir(&mut self, _req: &fuse::Request, parent: u64, name: &std::ffi::OsStr, mode: u32, reply: fuse::ReplyEntry)
+```
+
+1. Load the parent inode from disk
+2. Load the parent's dir data
+3. Create a new Inode for the new directory
+4. Update the parent's dir data with a new entry based on the new Inode's data

design/mkdir.md

@@ -13,14 +13,7 @@ fn main() {
 
     let mount_path = "/tmp/tiny";
 
-    fuse::mount(
-        TinyFS {
-            disk: load_disk(path),
-        },
-        &mount_path,
-        &[],
-    )
-    .expect("expected filesytem to mount");
+    fuser::mount2(TinyFS { disk: load_disk(path) }, &mount_path, &[]).expect("expected filesytem to mount");
 }
 
 fn load_disk(path: &Path) -> Disk {

src/main.rs

@@ -20,11 +20,8 @@ pub fn make(path: &str) {
         .expect("superblock to have been serialized");
 
     let mut bitmap = Bitmap::new();
-    bitmap
-        .save_to(&disk)
-        .expect("bitmap to have been serialized");
+    bitmap.save_to(&disk).expect("bitmap to have been serialized");
 
     buf.flush().expect("buffer to have been flushed");
-    disk.set_len(64 * BLOCK_SIZE as u64)
-        .expect("to have set file size");
+    disk.set_len(64 * BLOCK_SIZE as u64).expect("to have set file size");
 }