Commit graph

43 commits

Author SHA1 Message Date
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
shyney7
89b4046d11 docs/faq: add SELinux relabeling entry 2026-05-17 10:14:21 -05:00
Antonio SJ Musumeci
1a8eb326af Tweak docs on NFS and identity management 2026-04-21 13:20:07 -05:00
Antonio SJ Musumeci
9e2e1afafa Update docs on limiting drive spinup
Some checks failed
mkdocs / deploy (push) Has been cancelled
2026-04-06 14:01:20 -05:00
Antonio SJ Musumeci
ecee84b323 Improve proj comparisons + new SnapRAID details 2026-03-31 19:51:28 -04:00
Antonio SJ Musumeci
2ea6290e4b Update limiting drive spinup doc
Some checks failed
mkdocs / deploy (push) Has been cancelled
2026-03-04 11:05:55 -05:00
trapexit
2ae57642f4
Misc documentation updates (#1612) 2026-01-27 07:00:22 -06:00
trapexit
965e26989c
Misc documentation updates (#1605)
Some checks failed
mkdocs / deploy (push) Has been cancelled
2025-12-23 23:25:39 -06:00
trapexit
9b046d9a34
Rework credential handling to support chroot & idmap (#1595)
Some checks are pending
mkdocs / deploy (push) Waiting to run
Run in an elevated credential mode (root) and let the kernel manage
entitlements. Will result in slightly different behavior but should
not be noticed by most.
2025-12-05 21:03:48 -06:00
trapexit
f7e86d90ce
Add FAQ about lack of create policies about file size (#1578)
Some checks are pending
CodeQL / Analyze (push) Waiting to run
mkdocs / deploy (push) Waiting to run
2025-11-16 23:44:24 -06:00
trapexit
3bacaa6f7f
Add lazy-umount-mountpoint page and mount -a FAQ (#1573) 2025-11-12 12:19:00 -06:00
trapexit
077484323c
Fix variable names of fuse-msg-size and posix-acl (#1553)
Some checks failed
CodeQL / Analyze (push) Has been cancelled
mkdocs / deploy (push) Has been cancelled
2025-10-25 17:00:16 -05:00
trapexit
727c522fb8
Rework config, centralize fuse config (#1547)
Some checks are pending
CodeQL / Analyze (push) Waiting to run
mkdocs / deploy (push) Waiting to run
2025-10-24 08:20:29 -05:00
trapexit
00e5467e99
Misc docs updates (#1544)
Some checks failed
CodeQL / Analyze (push) Has been cancelled
mkdocs / deploy (push) Has been cancelled
2025-10-13 11:44:53 -05:00
trapexit
1707dc27e3
Misc doc updates (#1531)
Some checks are pending
CodeQL / Analyze (push) Waiting to run
mkdocs / deploy (push) Waiting to run
2025-09-21 14:25:24 -05:00
trapexit
b3656a0243
Fix broken doc links (#1525)
Some checks failed
CodeQL / Analyze (push) Has been cancelled
mkdocs / deploy (push) Has been cancelled
2025-09-19 19:25:31 -05:00
trapexit
41b40b94fa
Misc docs updates (#1524) 2025-09-19 19:20:28 -05:00
trapexit
ca59ae53a5
idmap mount support (#1523)
Some checks failed
CodeQL / Analyze (push) Has been cancelled
mkdocs / deploy (push) Has been cancelled
* Add idmap mount support

* Further replacement of std::filesystem::path to fs::path

* Update docs regarding idmap support
2025-09-18 00:07:28 -05:00
trapexit
2101ef5bcc
Updates to docs, add nonraid, more intro to fs details (#1512)
Some checks are pending
CodeQL / Analyze (push) Waiting to run
mkdocs / deploy (push) Waiting to run
2025-08-21 15:09:04 -05:00
trapexit
6ae9641bcc
Misc documentation updates (#1505) 2025-08-10 17:23:55 -05:00
trapexit
2b500f194a
Rework of runtime interface (#1498)
Some checks failed
CodeQL / Analyze (push) Has been cancelled
mkdocs / deploy (push) Has been cancelled
Also have special error handling for when branches are invalid and
ENOENT would be returned for getattr and readdir so users understand
what is going on and the runtime interface can still be used to fix
the problem.
2025-07-21 18:18:59 -05:00
trapexit
1b167d34d8
Spawn "mount" on branches when waiting for mounts enabled
Some checks are pending
CodeQL / Analyze (push) Waiting to run
mkdocs / deploy (push) Waiting to run
2025-06-08 15:09:47 -05:00
trapexit
923d9608e8
Add details to docs about FreeBSD limitations 2025-05-09 21:18:20 -05:00
Antonio SJ Musumeci
de2a82800a Improve mount waiting + misc doc improvements
Adds user.mergerfs.branch and user.mergerfs.branch_mounts_here
Adds .mergerfs.branch and .mergerfs.branch_mounts_here files.
2025-04-23 15:58:36 -05:00
Antonio SJ Musumeci
9dac54f223 Misc doc updates + add logo 2025-04-19 22:44:08 -05:00
Antonio SJ Musumeci
54681e885a Add FAQ entry regarding OS support 2025-04-15 23:40:42 -05:00
Antonio SJ Musumeci
c769e959e8 Add doc pages for minfreespace and moveonenospc + other misc updates 2025-04-10 22:59:49 -05:00
Antonio SJ Musumeci
95732222d9 Update docs regarding error handling 2025-04-04 18:41:58 -05:00
Antonio SJ Musumeci
b7f7f7fa97 Change misc defaults
* category.create=pfrd
* moveonenospc=pfrd
* cache.files=off
* parallel-direct-writes=true

These changes were made to match the recommended settings for most
users to reduce confusion.
2025-03-30 17:22:38 -05:00
Antonio SJ Musumeci
579690f411 Add links to options docs page to individual pages 2025-03-27 19:47:37 -05:00
Antonio SJ Musumeci
2d86ed946a Update docs on default create policy 2025-03-26 14:33:11 -05:00
Antonio SJ Musumeci
a4fdbae1ca Misc doc updates 2025-03-12 18:29:38 -05:00
Antonio SJ Musumeci
6472ac51e9 Misc doc updates 2025-03-08 22:02:34 -06:00
trapexit
d3770802b1
Merge pull request #1423 from trapexit/docs-inotify
Add FAQ entry regarding inotify
2025-03-05 16:59:45 -06:00
Antonio SJ Musumeci
bcbff5c82e Add FAQ entry regarding inotify 2025-03-05 16:58:27 -06:00
Antonio SJ Musumeci
3a33a6db2b Add FAQ section on common perceived problems 2025-02-22 22:25:39 -06:00
Antonio SJ Musumeci
ef9074ab4a Update docs on out-of-band usage 2025-02-19 14:13:06 -06:00
Antonio SJ Musumeci
1c44ef7967 Rework questions on what settings and policies to use 2025-02-11 19:46:33 -06:00
Antonio SJ Musumeci
f18719ced2 Add details about user namespacing and root squashing 2025-01-25 13:54:06 -06:00
Antonio SJ Musumeci
1729835b8c Misc doc updates 2025-01-25 13:00:00 -06:00
Antonio SJ Musumeci
19509e33d2 Doc and mover script updates 2025-01-20 01:43:58 -06:00
Antonio SJ Musumeci
b83bd5fd14 Improve FreeBSD compatibility
First draft. Need to investigate why upstream patches include certain
function that appear to exist in FreeBSD 14.2.
2025-01-15 22:10:02 -06:00
Antonio SJ Musumeci
75d7a93724 Rework mkdocs based documentation
Lots of restructoring and extra information.
2025-01-03 12:17:26 -06:00