* [PATCH] nfs/localio: remove the localio_O_DIRECT_semantics documentation
@ 2026-11-11 23:01 Mike Snitzer
0 siblings, 0 replies; only message in thread
From: Mike Snitzer @ 2026-11-11 23:01 UTC (permalink / raw)
To: Anna Schumaker; +Cc: Trond Myklebust, linux-nfs
Commit 25ba2b84c38f ("nfs/localio: avoid issuing misaligned IO using
O_DIRECT") removed the localio_O_DIRECT_semantics module parameter.
LOCALIO now issues an application's O_DIRECT to the underlying local
filesystem. It issues IO that is not DIO-aligned as buffered IO, so
that misaligned IO does not fail. But localio.rst still documents the
parameter, in its description of how the client issues IO and in its
list of module parameters.
Remove the parameter from both places, and say what LOCALIO does with
O_DIRECT now.
Fixes: 25ba2b84c38f ("nfs/localio: avoid issuing misaligned IO using O_DIRECT")
Signed-off-by: Mike Snitzer <snitzer@kernel.org>
---
Documentation/filesystems/nfs/localio.rst | 24 ++++-------------------
1 file changed, 4 insertions(+), 20 deletions(-)
diff --git a/Documentation/filesystems/nfs/localio.rst b/Documentation/filesystems/nfs/localio.rst
index 45c6981da0d89..9f1eb2a3c2db6 100644
--- a/Documentation/filesystems/nfs/localio.rst
+++ b/Documentation/filesystems/nfs/localio.rst
@@ -272,21 +272,10 @@ is issuing IO to the underlying local filesystem that it is sharing with
the NFS server. See: fs/nfs/localio.c:nfs_local_doio() and
fs/nfs/localio.c:nfs_local_commit().
-With normal NFS that makes use of RPC to issue IO to the server, if an
-application uses O_DIRECT the NFS client will bypass the pagecache but
-the NFS server will not. The NFS server's use of buffered IO affords
-applications to be less precise with their alignment when issuing IO to
-the NFS client. But if all applications properly align their IO, LOCALIO
-can be configured to use end-to-end O_DIRECT semantics from the NFS
-client to the underlying local filesystem, that it is sharing with
-the NFS server, by setting the 'localio_O_DIRECT_semantics' nfs module
-parameter to Y, e.g.:
-
- echo Y > /sys/module/nfs/parameters/localio_O_DIRECT_semantics
-
-Once enabled, it will cause LOCALIO to use end-to-end O_DIRECT semantics
-(but again, this may cause IO to fail if applications do not properly
-align their IO).
+With LOCALIO, an application's O_DIRECT extends down to the underlying
+local filesystem. LOCALIO issues DIO-aligned IO as O_DIRECT. It issues
+IO that is not DIO-aligned as buffered IO, so misaligned application IO
+does not fail.
Security
========
@@ -325,11 +314,6 @@ LOCALIO. The mount's timeouts do not apply to the probe. Set to 0, the
probe uses the mount's timeouts instead, as an NFS RPC would. A change
applies to the next probe.
-/sys/module/nfs/parameters/localio_O_DIRECT_semantics (bool)
-controls if O_DIRECT extends down to the underlying filesystem, defaults
-to N. Application IO must be logical blocksize aligned, otherwise
-O_DIRECT will fail.
-
/sys/module/nfsv3/parameters/nfs3_localio_probe_throttle (uint)
controls if NFSv3 read and write IOs will trigger (re)enabling of
LOCALIO every N (nfs3_localio_probe_throttle) IOs, defaults to 0
base-commit: 5e810a57a1cf2fc785d89e711ff40f1112f6404c
--
2.52.0
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2026-11-11 23:01 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-11-11 23:01 [PATCH] nfs/localio: remove the localio_O_DIRECT_semantics documentation Mike Snitzer
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox