Skip to content

feat: add file_clone (reflink/CoW) mode for the local disk cache #2739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Skory wants to merge 1 commit into
base: main
Choose a base branch
from
+3,793 −103
Open

feat: add file_clone (reflink/CoW) mode for the local disk cache #2739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 150 additions & 14 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ object = "0.37"
opendal = { version = "0.55.0", optional = true, default-features = false }
openssl = { version = "0.10.75", optional = true }
rand = "0.8.4"
reflink-copy = "0.1.24"
regex = "1.10.3"
reqsign = { version = "0.18.0", optional = true }
reqwest = { version = "0.12", features = [
Expand Down
6 changes: 6 additions & 0 deletions docs/Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ key_prefix = ""
[cache.disk]
dir = "/tmp/.cache/sccache"
size = 7516192768 # 7 GiBytes
# Store cache entries uncompressed and restore them with filesystem reflinks
# (copy-on-write). Near-instant, near-zero-disk cache hits when the cache dir and
# the build dir share one CoW filesystem (Btrfs/XFS/APFS/ReFS); falls back to
# plain copies elsewhere. Default: false. See docs/FileClone.md.
file_clone = false

# See the local docs on more explanations about this mode
[cache.disk.preprocessor_cache_mode]
Expand Down Expand Up @@ -224,6 +229,7 @@ export SCCACHE_MULTILEVEL_WRITE_ERROR_POLICY="all"
* `SCCACHE_CACHE_SIZE` maximum size of the local on disk cache i.e. `2G` - default is 10G
* `SCCACHE_DIRECT` enable/disable preprocessor caching (see [the local doc](Local.md))
* `SCCACHE_LOCAL_RW_MODE` the mode that the cache will operate in (`READ_ONLY` or `READ_WRITE`)
* `SCCACHE_FILE_CLONE` set to `true`/`on`/`1` to enable uncompressed, reflink (copy-on-write) cache storage (see [the file_clone doc](FileClone.md)). Default is `false`.

#### s3 compatible

Expand Down
Loading
Loading