mirror of
https://github.com/trapexit/mergerfs.git
synced 2026-10-26 19:01:56 -04:00
Reinstate the splice read/write/move paths removed in 84592a9f, now
gated behind runtime options with negotiated pipe sizing and fallback
logging.
- Transport: msgbuf-piped splice receive, fd-referenced splice reply
(vmsplice + splice), splice-move pipe-bounce, and restored
fuse_buf_copy/fuse_buf_flags plumbing for copy fallbacks
- Negotiation: new pipe-max-size option (auto-raised at INIT when
possible; the sysctl read/write is factored into src/pipe_max_size.cpp
so fuse_init.cpp and option_parser.cpp share one implementation);
fuse-msg-size clamped to what the pipe can hold; splice is disabled
at INIT with a warning if the sysctl can't fit even the minimum,
retracting the FUSE_CAP_SPLICE_* bits already advertised to the
kernel in that case
- Read replies and splice-move are gated at 128 KiB (below that the
syscalls cost more than the copy they avoid); every fallback path
degrades to the copy path and logs once per process via SysLog
- msgbuf pipe cache is process-global and mutex-guarded (mutex_lockguard)
so pipes can move between read and worker threads under
process-thread mode
- API simplified after review: collapsed the three per-axis options
(splice-read/write/move) into a single splice boolean (default on);
no-splice-read/write/move and the bare splice-read/write/move
spellings stay registered as accepted no-ops so existing mount
options don't fail the mount, but they do NOT alter the splice
knob - upgraders with no-splice-* in their config get splice
enabled and must set splice=false explicitly (see
deprecated_options.md)
- Fixed several correctness issues found in parallel review: a
dropped write_buf registration that silently corrupted writes, a
dirty-pipe reuse bug in msgbuf_free, an iov double-send in
fuse_reply_data's splice-move fallback, and pipe-capacity math that
assumed a 4096-byte page size
- Modernized the transport/negotiation code to this codebase's C++
style: RAII (unique_ptr/DEFER) instead of malloc/free and manual fd
close(), std::from_chars/to_chars instead of stoul/snprintf,
_ReplyPipe's pipe ops as methods instead of free functions closing
over a thread_local global, and vendored/libfuse/lib/buffer.cpp (a
near-verbatim port of upstream's buffer.c) brought in line with the
rest of the fork
- Documented splice and pipe-max-size options (mkdocs, FAQ,
deprecated-options list); added tools/bench-splice.sh
- Benchmarked on tmpfs: seq_write +21%, seq_read +52%, small_write
+5%, small_read +12%; validated with a 1h soak (~271 GiB
hash-verified I/O, zero integrity failures), a live-mount round-trip
of I/O above the splice threshold, and the existing unit/smoke
suites at their pre-existing baseline
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
# splice
|
|
|
|
* type: `BOOL`
|
|
* default: `true`
|
|
* example: `splice=false`
|
|
|
|
Controls whether mergerfs uses the kernel's
|
|
[splice](https://man7.org/linux/man-pages/man2/splice.2.html) syscall
|
|
to move data between `/dev/fuse` and the underlying filesystems
|
|
without copying it through user space memory.
|
|
|
|
When enabled, `read` and `write` requests can be serviced with zero
|
|
copies: the kernel moves pages directly between the branch
|
|
filesystem's page cache and the FUSE device through pipes. This can
|
|
significantly improve sequential throughput on modern hardware.
|
|
|
|
Due to the extra syscall overhead for small requests, splice replies
|
|
to `read` requests are only used for requests of 128KiB or larger;
|
|
smaller read replies use the traditional write path. `write` requests
|
|
of any size stage their payload into the receive pipe and splice it
|
|
to the branch when possible.
|
|
|
|
If the filesystem or kernel does not support the needed
|
|
functionality mergerfs will automatically fall back to the
|
|
traditional read/write behavior.
|
|
|
|
Historical note: splice support was previously removed from
|
|
mergerfs's own vendored libfuse (see the
|
|
[FAQ](../faq/technical_behavior_and_limitations.md) for why), and
|
|
the `no-splice-read`, `no-splice-write`, and `no-splice-move`
|
|
spellings were accepted as no-ops during that period. They remain
|
|
accepted as no-ops for backward compatibility; use `splice=false`
|
|
instead.
|