Add WASI support

Cargo.toml

@@ -22,13 +22,17 @@ libc = "0.2.104"
 log = {version = "0.4.17", optional = true }
 pyo3 = {version = "0.18.0", features=["extension-module", "abi3-py37"], optional = true }
 
+# These are actually test dependencies
 [dev-dependencies]
+rand = "0.8"
+tempfile = "3.5.0"
+
+# These are actually benchmarking dependencies
+[target.'cfg(not(target_os = "wasi"))'.dev-dependencies]
 ctrlc = "3.2.3"
 fastrand = "1.9.0"
-rand = "0.8"
 lmdb-rkv = "0.14.0"
 sanakirja = "1.3.3"
-tempfile = "3.5.0"
 sled = "0.34.7"
 rocksdb = "0.21.0"
 libc = "0.2.99"
@@ -43,6 +47,8 @@ python = ["pyo3"]
 logging = ["log"]
 # Enable cache hit metrics
 cache_metrics = []
+# Enable experimental wasi support (requires nightly and has no file locking!)
+wasi = []
 
 [profile.bench]
 debug = true

src/db.rs

@@ -650,7 +650,7 @@ impl Builder {
     /// Set the amount of memory (in bytes) used for caching data
     pub fn set_cache_size(&mut self, bytes: usize) -> &mut Self {
         // TODO: allow dynamic expansion of the read/write cache
-        self.read_cache_size_bytes = bytes * 9 / 10;
+        self.read_cache_size_bytes = bytes / 10 * 9;
         self.write_cache_size_bytes = bytes / 10;
         self
     }
@@ -710,13 +710,11 @@ impl std::fmt::Debug for Database {
 
 #[cfg(test)]
 mod test {
-    use tempfile::NamedTempFile;
-
     use crate::{Database, Durability, Error, ReadableTable, TableDefinition};
 
     #[test]
     fn small_pages() {
-        let tmpfile: NamedTempFile = NamedTempFile::new().unwrap();
+        let tmpfile = crate::create_tempfile();
 
         let db = Database::builder()
             .set_page_size(512)
@@ -733,7 +731,7 @@ mod test {
 
     #[test]
     fn small_pages2() {
-        let tmpfile: NamedTempFile = NamedTempFile::new().unwrap();
+        let tmpfile = crate::create_tempfile();
 
         let db = Database::builder()
             .set_page_size(512)
@@ -827,7 +825,7 @@ mod test {
 
     #[test]
     fn small_pages3() {
-        let tmpfile: NamedTempFile = NamedTempFile::new().unwrap();
+        let tmpfile = crate::create_tempfile();
 
         let db = Database::builder()
             .set_page_size(1024)
@@ -860,7 +858,7 @@ mod test {
 
     #[test]
     fn small_pages4() {
-        let tmpfile: NamedTempFile = NamedTempFile::new().unwrap();
+        let tmpfile = crate::create_tempfile();
 
         let db = Database::builder()
             .set_cache_size(1024 * 1024)
@@ -897,7 +895,7 @@ mod test {
 
     #[test]
     fn crash_regression1() {
-        let tmpfile: NamedTempFile = NamedTempFile::new().unwrap();
+        let tmpfile = crate::create_tempfile();
 
         let db = Database::builder()
             .set_cache_size(1024 * 1024)
@@ -920,7 +918,7 @@ mod test {
 
     #[test]
     fn dynamic_shrink() {
-        let tmpfile: NamedTempFile = NamedTempFile::new().unwrap();
+        let tmpfile = crate::create_tempfile();
         let table_definition: TableDefinition<u64, &[u8]> = TableDefinition::new("x");
         let big_value = vec![0u8; 1024];
 

src/lib.rs

@@ -5,6 +5,13 @@
     clippy::cast_precision_loss,
     clippy::cast_sign_loss
 )]
+// TODO remove these (and the "wasi" Cargo feature) once wasi no longer requires nightly
+#![cfg_attr(feature = "wasi", feature(wasi_ext))]
+#[cfg(all(target_os = "wasi", not(feature = "wasi")))]
+compile_error!(
+    r"To compile to WASI, you must enable the 'wasi' feature for now!
+See redb's Cargo.toml for why; this restriction will be lifted in the future."
+);
 
 pub use db::{
     Builder, Database, MultimapTableDefinition, MultimapTableHandle, TableDefinition, TableHandle,
@@ -36,3 +43,12 @@ mod transactions;
 mod tree_store;
 mod tuple_types;
 mod types;
+
+#[cfg(test)]
+fn create_tempfile() -> tempfile::NamedTempFile {
+    if cfg!(target_os = "wasi") {
+        tempfile::NamedTempFile::new_in("").unwrap()
+    } else {
+        tempfile::NamedTempFile::new().unwrap()
+    }
+}

src/tree_store/page_store/file_lock/mod.rs

@@ -1,6 +1,6 @@
-#[cfg(unix)]
+#[cfg(any(unix, target_os = "wasi"))]
 mod unix;
-#[cfg(unix)]
+#[cfg(any(unix, target_os = "wasi"))]
 pub(super) use unix::LockedFile;
 
 #[cfg(windows)]

src/tree_store/page_store/file_lock/unix.rs

@@ -1,14 +1,33 @@
+// TODO once Rust's libc has flock implemented for WASI, this file needs to be revisited.
+// What needs to be changed is commented below.
+// See also: https://github.com/WebAssembly/wasi-filesystem/issues/2
+
+// Remove this line once wasi-libc has flock
+#![cfg_attr(feature = "wasi", allow(unused_imports))]
+
 use crate::{Error, Result};
 use std::fs::File;
 use std::io;
-use std::os::unix::fs::FileExt;
-use std::os::unix::io::AsRawFd;
+
+#[cfg(unix)]
+use std::os::unix::{fs::FileExt, io::AsRawFd};
+
+#[cfg(target_os = "wasi")]
+use std::os::wasi::{fs::FileExt, io::AsRawFd};
 
 pub(crate) struct LockedFile {
     file: File,
 }
 
 impl LockedFile {
+    // This is a no-op until we get flock in wasi-libc.
+    // Delete this function when we get flock.
+    #[cfg(target_os = "wasi")]
+    pub(crate) fn new(file: File) -> Result<Self> {
+        Ok(Self { file })
+    }
+
+    #[cfg(unix)] // remove this line when wasi-libc gets flock
     pub(crate) fn new(file: File) -> Result<Self> {
         let fd = file.as_raw_fd();
         let result = unsafe { libc::flock(fd, libc::LOCK_EX | libc::LOCK_NB) };
@@ -41,6 +60,7 @@ impl LockedFile {
     }
 }
 
+#[cfg(unix)] // remove this line when wasi-libc gets flock
 impl Drop for LockedFile {
     fn drop(&mut self) {
         unsafe { libc::flock(self.file.as_raw_fd(), libc::LOCK_UN) };