mergerfs/mkdocs/docs
Antonio S. Musumeci 8eed256747 Restore splice zero-copy I/O as runtime options
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>
2026-09-07 11:24:16 -04:00
..
config Restore splice zero-copy I/O as runtime options 2026-09-07 11:24:16 -04:00
faq Restore splice zero-copy I/O as runtime options 2026-09-07 11:24:16 -04:00
setup Include Docker Compose setup for mergerfs 2026-07-31 08:13:59 -05:00
benchmarking.md Update docs; add nofs, policyfs and greyhole 2026-03-27 22:54:39 -05:00
error_handling_and_logging.md Update docs; add nofs, policyfs and greyhole 2026-03-27 22:54:39 -05:00
extended_usage_patterns.md Misc docs updates (#1549) 2025-10-24 20:47:33 -05:00
index.md Misc documentation updates (#1612) 2026-01-27 07:00:22 -06:00
intro_to_filesystems.md Misc updates of docs (#1518) 2025-09-01 20:58:58 -05:00
known_issues_bugs.md Document advisory locking limitation and update deprecated options 2026-05-06 20:49:46 -04:00
logo.png Misc doc updates + add logo 2025-04-19 22:44:08 -05:00
media_and_publicity.md Update docs for logging changes + new video (#1618) 2026-02-12 23:21:43 -06:00
performance.md Misc documentation updates (#1605) 2025-12-23 23:25:39 -06:00
project_comparisons.md Add more details to project comparisons 2026-04-04 02:17:06 -05:00
quickstart.md Update docs; add nofs, policyfs and greyhole 2026-03-27 22:54:39 -05:00
related_projects.md Add MOS to projects and update misc links (#1614) 2026-01-27 11:25:32 -06:00
remote_filesystems.md Remove timed node removal 2026-05-06 20:49:46 -04:00
resource_usage.md Remove timed node removal 2026-05-06 20:49:46 -04:00
runtime_interface.md Update docs; add nofs, policyfs and greyhole 2026-03-27 22:54:39 -05:00
sponsorship_and_donations.md Add container image details (#1569) 2025-11-08 20:28:10 -06:00
support.md Fixup debug output (#1617) 2026-02-12 22:50:38 -06:00
terminology.md Update terminology.md 2025-02-19 07:04:11 +02:00
tips_notes.md Misc documentation updates (#1605) 2025-12-23 23:25:39 -06:00
tooling.md Update docs; add nofs, policyfs and greyhole 2026-03-27 22:54:39 -05:00