mergerfs/mkdocs/docs/config
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
..
branches-mount-timeout.md Spawn "mount" on branches when waiting for mounts enabled 2025-06-08 15:09:47 -05:00
branches.md Spawn "mount" on branches when waiting for mounts enabled 2025-06-08 15:09:47 -05:00
cache.md Update fuse-msg-size docs (#1552) 2025-10-24 23:34:28 -05:00
deprecated_options.md Restore splice zero-copy I/O as runtime options 2026-09-07 11:24:16 -04:00
export-support.md Add config option to control default_permissions 2025-04-25 16:34:39 -05:00
flush-on-close.md Rework mkdocs based documentation 2025-01-03 12:17:26 -06:00
follow-symlinks.md Rework mkdocs based documentation 2025-01-03 12:17:26 -06:00
func_readdir.md Config options docs updates (#1551) 2025-10-24 22:31:04 -05:00
functions_categories_policies.md Add LUP policy (#1601) 2025-12-14 00:36:12 -06:00
fuse-msg-size.md Update fuse-msg-size docs (#1552) 2025-10-24 23:34:28 -05:00
inodecalc.md Add details to docs about FreeBSD limitations 2025-05-09 21:18:20 -05:00
kernel-permissions-check.md idmap mount support (#1523) 2025-09-18 00:07:28 -05:00
lazy-umount-mountpoint.md Add lazy-umount-mountpoint page and mount -a FAQ (#1573) 2025-11-12 12:19:00 -06:00
link-cow.md Config options docs updates (#1551) 2025-10-24 22:31:04 -05:00
link-exdev.md Rework mkdocs based documentation 2025-01-03 12:17:26 -06:00
minfreespace.md Add doc pages for minfreespace and moveonenospc + other misc updates 2025-04-10 22:59:49 -05:00
moveonenospc.md Fix typo in moveonenospc.md (#1527) 2025-09-21 11:42:15 -05:00
nfsopenhack.md Rework mkdocs based documentation 2025-01-03 12:17:26 -06:00
nullrw.md Rework mkdocs based documentation 2025-01-03 12:17:26 -06:00
options.md Restore splice zero-copy I/O as runtime options 2026-09-07 11:24:16 -04:00
passthrough.md Config options docs updates (#1551) 2025-10-24 22:31:04 -05:00
pin-threads.md Rework mkdocs based documentation 2025-01-03 12:17:26 -06:00
pipe-max-size.md Restore splice zero-copy I/O as runtime options 2026-09-07 11:24:16 -04:00
proxy-ioprio.md Rework config, centralize fuse config (#1547) 2025-10-24 08:20:29 -05:00
readahead.md Config options docs updates (#1551) 2025-10-24 22:31:04 -05:00
rename-exdev.md Rework mkdocs based documentation 2025-01-03 12:17:26 -06:00
rename_and_link.md Fix broken doc links (#1525) 2025-09-19 19:25:31 -05:00
splice.md Restore splice zero-copy I/O as runtime options 2026-09-07 11:24:16 -04:00
statfs.md Rework mkdocs based documentation 2025-01-03 12:17:26 -06:00
symlinkify.md Rework mkdocs based documentation 2025-01-03 12:17:26 -06:00
threads.md Rework thread pool for increased stability + config and doc updates (#1453) 2025-05-05 18:28:49 -05:00
xattr.md Rework mkdocs based documentation 2025-01-03 12:17:26 -06:00