Rewrite

Cargo.toml

@@ -1,37 +1,32 @@
 [package]
-name    = "stored"
-version = "0.1.0"
-authors = ["Thomas de Zeeuw <[email protected]>"]
-edition = "2018"
-publish = false
+name        = "stored"
+description = "Store*d* (pronounced store-daemon, or just stored) is a distributed immutable blob store. Stored is not a key-value store, as the key isn't the decided by the user but by the SHA-512 checksum of the stored blob."
+version     = "0.2.0-dev"
+publish     = false # In development.
+authors     = ["Thomas de Zeeuw <[email protected]>"]
+license     = "MIT"
+repository  = "https://github.com/Thomasdezeeuw/stored"
+readme      = "README.md"
+edition     = "2021"
 
 [dependencies]
-chrono            = { version = "0.4.19", default-features = false, features = ["clock"] }
-crossbeam-channel = { version = "0.5.0", default-features = false, features = ["std"] }
-futures-io        = { version = "0.3.6", default-features = false, features = ["std"] }
-futures-util      = { version = "0.3.6", default-features = false, features = ["io", "std", "write-all-vectored"] }
-fxhash            = { version = "0.2.1", default-features = false }
-getrandom         = { version = "0.2.0", default-features = false }
-# TODO: replace with published crate.
-heph              = { git = "https://github.com/Thomasdezeeuw/heph", rev = "00640b2a5d1759b572a2c9e9e13b06df4f3e40c5" }
-libc              = { version = "0.2.74", default-features = false }
-log               = { version = "0.4.11", default-features = false, features = ["release_max_level_info"] }
-num_cpus          = { version = "1.13.0", default-features = false }
-ring              = { version = "0.16.19", default-features = false, features = ["std"] }
-# Need the `std` feature as it implements `Error` for `httparse::Error`.
-httparse          = { version = "1.3.4", default-features = false, features = ["std"] }
-human-size        = { version = "0.4.1", default-features = false, features = ["enable-serde"] }
-parking_lot       = { version = "0.11.0", default-features = false, features = ["nightly"] }
-serde             = { version = "1.0.116", default-features = false, features = ["derive"] }
-serde_json        = { version = "1.0.58", default-features = false, features = ["std"] }
-toml              = { version = "0.5.6", default-features = false }
-
-[dev-dependencies]
-http        = { version = "0.2.1", default-features = false }
-lazy_static = { version = "1.4.0", default-features = false }
-mio         = { version = "0.7.0", default-features = false, features = ["os-poll"] }
-mio-pipe    = { version = "0.1.1", default-features = false }
-serde_test  = { version = "1.0.116", default-features = false }
+basic-toml        = { version = "0.1.9", default-features = false }
+# TODO: replace with published crates.
+left-right        = { git = "https://github.com/Thomasdezeeuw/left-right", rev = "4408ba0bb23ea0090b420ebfc0561780a44c533f", default-features = false }
+heph              = { git = "https://github.com/Thomasdezeeuw/heph", rev = "daf3a2f7118d1e05c3433455db27a1dabc073e16", default-features = false }
+heph-rt           = { git = "https://github.com/Thomasdezeeuw/heph", rev = "daf3a2f7118d1e05c3433455db27a1dabc073e16", default-features = false }
+heph-http         = { git = "https://github.com/Thomasdezeeuw/heph", rev = "daf3a2f7118d1e05c3433455db27a1dabc073e16", default-features = false }
+itoa              = { version = "1.0.4", default-features = false }
+libc              = { version = "0.2.151", default-features = false }
+log               = { version = "0.4.21", default-features = false, features = ["kv_std", "release_max_level_info"] }
+ring              = { version = "0.17", default-features = false }
+serde             = { version = "1.0.197", default-features = false }
+std-logger        = { version = "0.5.3", default-features = false, features = ["timestamp", "log-panic", "nightly"] }
+
+[dev-dependencies.heph-rt]
+git = "https://github.com/Thomasdezeeuw/heph"
+rev = "daf3a2f7118d1e05c3433455db27a1dabc073e16"
+features = ["test"]
 
 [profile.release]
 opt-level        = 3
@@ -44,25 +39,6 @@ incremental      = false
 codegen-units    = 1
 rpath            = false
 
-[[bin]]
-name = "store"
-path = "src/bin/store.rs"
-
-[[bin]]
-name = "retrieve"
-path = "src/bin/retrieve.rs"
-
-[[bin]]
-name = "remove"
-path = "src/bin/remove.rs"
-
 [[bin]]
 name = "stored"
 path = "src/bin/server.rs"
-
-[[bin]]
-name = "validate_store"
-path = "src/bin/validate.rs"
-
-[workspace]
-members = ["bench/hashmap_hash"]

Makefile

@@ -1,41 +1,91 @@
-# NOTE: note exporting the following two variables as they interfere with
-# incremental compilation (not setting the flag, e.g. outside of running Make
-# will cause recompilation).
-RUSTFLAGS                ?= -C target-cpu=native
-MACOSX_DEPLOYMENT_TARGET ?= 10.15
-GIT_SHORT_HASH            = $(shell git rev-parse --short HEAD)
-# Either " modified" or empty if on a clean branch.
-GIT_MODIFIED              = $(shell git diff --quiet --ignore-submodules HEAD 2> /dev/null || echo " modified")
-export COMMIT_VERSION     = $(GIT_SHORT_HASH)$(GIT_MODIFIED)
+# Test options.
+# You can also use `TEST_FLAGS` to set additonal flags, e.g. `--release`.
+TEST_OPTS = -- --quiet -Z unstable-options --shuffle
+# Command to run in `dev` target, e.g. `make RUN=check dev`.
+RUN ?= test
 
 build:
-	RUSTFLAGS="$(RUSTFLAGS)" MACOSX_DEPLOYMENT_TARGET="$(MACOSX_DEPLOYMENT_TARGET)" cargo build --release
+	RUSTFLAGS='-C target-cpu=native' cargo build --release
+
+# Development loop, runs $RUN whenever a source file changes.
+dev:
+	find src/ tests/ examples/ Makefile Cargo.toml | entr -d -c $(MAKE) $(RUN)
 
 test:
-	(cargo test \
-		&& (killall -u $$(whoami) -KILL stored || true)) || \
-		(killall -u $$(whoami) -KILL stored && exit 1)
+	cargo test --all-features $(TEST_FLAGS) $(TEST_OPTS)
 
-# NOTE: when using this command you might want to change the `test` target to
-# only run a subset of the tests you're actively working on.
-dev:
-	find src/ tests/ Makefile Cargo.toml | RUST_BACKTRACE=0 entr -d -c $(MAKE) test
-
-lint:
-	cargo clippy --all-targets -- --warn warnings \
-		--warn clippy::correctness \
-		--warn clippy::style \
-		--warn clippy::complexity \
-		--warn clippy::perf \
-		--allow clippy::assertions_on_constants \
-		--allow clippy::borrow_interior_mutable_const \
-		--allow clippy::enum_variant_names \
-		--allow clippy::len_without_is_empty \
-		--allow clippy::needless_lifetimes \
+test_sanitizers:
+	$(MAKE) test_sanitizer sanitizer=address
+	$(MAKE) test_sanitizer sanitizer=leak
+	$(MAKE) test_sanitizer sanitizer=memory
+	$(MAKE) test_sanitizer sanitizer=thread
+
+# Run with `make test_sanitizer sanitizer=$sanitizer`, or use `test_sanitizers`.
+test_sanitizer:
+	RUSTDOCFLAGS=-Zsanitizer=$(sanitizer) RUSTFLAGS=-Zsanitizer=$(sanitizer) \
+	cargo test -Zbuild-std --all-features --target x86_64-unknown-linux-gnu $(TEST_FLAGS) $(TEST_OPTS)
+
+# TODO: add TEST_OPTS to this, currently this doesn't work with miri.
+test_miri:
+	cargo miri test --all-features $(TEST_FLAGS)
+
+check:
+	cargo check --all-features --all-targets
+
+# Reasons to allow lints:
+# `cargo-common-metadata`: for `benches` and `tools`.
+# `doc-markdown`: too many false positives.
+# `equatable-if-let`: bad lint.
+# `future-not-send`: we don't want to require all generic parameters to be `Send`.
+# `if-not-else`: let the logic speak for itself.
+# `match-bool`: often less lines of code and I find that use `match` generally
+# strictly better then `if`s.
+# `missing-const-for-fn`: See https://github.com/rust-lang/rust-clippy/issues/4979.
+# `module-name-repetitions`: we re-export various names.
+# `needless-lifetimes`: lifetime serves as documentation.
+# `option-if-let-else`: not idiomatic at all.
+# `use-self`: this is a bad lint.
+#
+# Could fix:
+# `cast-possible-truncation`.
+lint: clippy
+clippy:
+	cargo clippy --all-features -- \
+		--deny clippy::all \
+		--deny clippy::correctness \
+		--deny clippy::style \
+		--deny clippy::complexity \
+		--deny clippy::perf \
+		--deny clippy::pedantic \
+		--deny clippy::nursery \
+		--deny clippy::cargo \
+		--allow clippy::cargo-common-metadata \
+		--allow clippy::cast-possible-truncation \
+		--allow clippy::doc-markdown \
+		--allow clippy::equatable-if-let \
+		--allow clippy::future-not-send \
+		--allow clippy::if-not-else \
+		--allow clippy::len-without-is-empty \
+		--allow clippy::match-bool \
+		--allow clippy::match-same-arms \
+		--allow clippy::missing-const-for-fn \
+		--allow clippy::missing-errors-doc \
+		--allow clippy::missing-panics-doc \
+		--allow clippy::module-name-repetitions \
+		--allow clippy::must-use-candidate \
+		--allow clippy::needless-lifetimes \
 		--allow clippy::new-without-default \
-		--allow clippy::partialeq_ne_impl
+		--allow clippy::option-if-let-else \
+		--allow clippy::struct-field-names \
+		--allow clippy::use-self \
+
+doc:
+	cargo doc --all-features
+
+doc_private:
+	cargo doc --all-features --document-private-items
 
 clean:
 	cargo clean
 
-.PHONY: build test dev lint clean
+.PHONY: dev test test_sanitizers test_sanitizer test_miri check lint clippy doc doc_private clean

README.md

@@ -3,19 +3,19 @@
 **Store*d* is an experimental prototype not to be used in production!**
 
 Store*d* (pronounced store-daemon, or just stored) is a distributed immutable
-blob store. Stored is not a key-value store, as the key isn't the decided by the
+blob store. Store*d* is not a key-value store, as the key isn't the decided by the
 user but by the SHA-512 checksum of the stored blob.
 
 It supports three operations: storing, retrieving and removing blobs. As the key
 of a blob is its checksum it is not possible to modify blobs. If a blob needs to
 be modified a new blob simply needs to be stored and the new key used. The
 client can validate the correct delivery of the blob by using the returned key
-(checksum). The blob themselves are unchanged by Stored.
+(checksum). The blob themselves are unchanged by Store*d*.
 
 
 ## Operations
 
-Stored supports three operations; storing values, retrieving values and removing
+Store*d* supports three operations; storing values, retrieving values and removing
 values. But first we need to start the server.