vfs support - ready for full review to merge

.gitignore

@@ -1,4 +1,7 @@
 target/
 *.db
-
+*.cdtor.c
+*.res
+*.cdtor.o
+rustc*/
 wasm/

Cargo.toml

@@ -15,15 +15,17 @@ sqlite-loadable-macros={version="0.0.3", path="./sqlite-loadable-macros"}
 serde = {version="1.0.147", features = ["derive"]}
 serde_json = "1.0.87"
 bitflags = "1.3.2"
-libsqlite3-sys = {version="0.26.0", optional=true, features=["bundled"]}
+libsqlite3-sys = {version="^0.26", optional=true, features=["bundled"]}
 
 [dev-dependencies]
 rusqlite = "0.29.0"
-libsqlite3-sys = {version="0.26.0", default-features = false, features=["bundled"]}
+libsqlite3-sys = {version="^0.26", default-features = false, features=["bundled"]}
 
 [features]
 static = ["libsqlite3-sys"]
 exec = []
+vfs_syscall = []
+vfs_loadext = []
 
 [lib]
 doctest = false
@@ -47,3 +49,7 @@ crate-type = ["cdylib"]
 [[example]]
 name = "load_permanent"
 crate-type = ["cdylib"]
+
+[[example]]
+name = "mem_vfs"
+crate-type = ["cdylib"]

Dockerfile

@@ -0,0 +1,35 @@
+# kernel 6.1
+FROM debian:bookworm-slim
+
+RUN apt-get update
+
+# development
+RUN apt-get install -y curl valgrind build-essential clang pahole git
+
+# connect with vs code remote via ssh
+RUN apt install -y openssh-server
+
+# project
+RUN apt-get install -y libsqlite3-dev sqlite3 liburing-dev
+
+# upgrade kernel to 6.1
+RUN apt upgrade -y linux-image-arm64
+
+# rust
+ENV RUST_VERSION=stable
+RUN curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain=$RUST_VERSION
+
+# Install cargo-valgrind
+RUN /bin/bash -c "source /root/.cargo/env && cargo install cargo-valgrind"
+
+# Check sqlite compile options:
+RUN echo "PRAGMA compile_options;" | sqlite3
+
+RUN sed -i 's/#PermitRootLogin prohibit-password/PermitRootLogin yes/' /etc/ssh/sshd_config
+
+EXPOSE 22
+
+ENTRYPOINT service ssh start && bash
+
+# on visual code studio
+# install "remote development" "remote - ssh" "rust-analyzer"

README.md

@@ -132,6 +132,20 @@ select * from xxx;
 
 Some real-world non-Rust examples of traditional virtual tables in SQLite include the [CSV virtual table](https://www.sqlite.org/csv.html), the full-text search [fts5 extension](https://www.sqlite.org/fts5.html#fts5_table_creation_and_initialization), and the [R-Tree extension](https://www.sqlite.org/rtree.html#creating_an_r_tree_index).
 
+### Virtual file system
+
+There are two examples of how to apply this library to create your own vfs.
+1. [io_uring_vfs](./benchmarks/vfs/io_uring/)
+2. [mem_vfs](./examples/mem_vfs.rs)
+
+In summary, you need to extend two traits "SqliteIoMethods" and "SqliteVfs", then attach those together
+in the open function in SqliteVfs.
+
+You can load the custom vfs in a compiled sqlite3 binary, by  doing the following:
+* In Cargo.toml, make sure the feature "static" is disabled: sqlite-loadable = {path="..."}
+* Load the dynamic object, e.g.: sqlite3 -cmd '.load ./target/debug/lib_myvfs'
+* in SQL: ATTACH 'file:my.db?vfs=myvfs' as myvfs
+
 ## Examples
 
 The [`examples/`](./examples/) directory has a few bare-bones examples of extensions, which you can build with:
@@ -243,7 +257,7 @@ A hello world extension in C is `17KB`, while one in Rust is `469k`. It's still
 - [ ] Stabilize virtual table interface
 - [ ] Support [aggregate window functions](https://www.sqlite.org/windowfunctions.html#udfwinfunc) ([#1](https://github.com/asg017/sqlite-loadable-rs/issues/1))
 - [ ] Support [collating sequences](https://www.sqlite.org/c3ref/create_collation.html) ([#2](https://github.com/asg017/sqlite-loadable-rs/issues/2))
-- [ ] Support [virtual file systems](sqlite.org/vfs.html) ([#3](https://github.com/asg017/sqlite-loadable-rs/issues/3))
+- [x] Support [virtual file systems](sqlite.org/vfs.html) ([#3](https://github.com/asg017/sqlite-loadable-rs/issues/3))
 
 ## Supporting
 

benchmarks/vfs/io_uring/.gitignore

@@ -0,0 +1,6 @@
+*.db
+*-journal
+sqlite3
+leaky.txt
+db/**
+md/**