Linux-man Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] man/statx: Add STATX_ATTR_DAX
@ 2020-05-05  0:20 ira.weiny
  0 siblings, 0 replies; only message in thread
From: ira.weiny @ 2020-05-05  0:20 UTC (permalink / raw)
  To: mtk.manpages
  Cc: Ira Weiny, linux-man, linux-fsdevel, linux-api, linux-xfs,
	linux-kernel, linux-ext4

From: Ira Weiny <ira.weiny@intel.com>

Linux 5.8 is slated to have STATX_ATTR_DAX support.

https://lore.kernel.org/lkml/20200428002142.404144-4-ira.weiny@intel.com/
https://lore.kernel.org/lkml/20200504161352.GA13783@magnolia/

Add the text to the statx man page.

Signed-off-by: Ira Weiny <ira.weiny@intel.com>
---
 man2/statx.2 | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/man2/statx.2 b/man2/statx.2
index 2e90f07dbdbc..14c4ab78e7bd 100644
--- a/man2/statx.2
+++ b/man2/statx.2
@@ -468,6 +468,30 @@ The file has fs-verity enabled.
 It cannot be written to, and all reads from it will be verified
 against a cryptographic hash that covers the
 entire file (e.g., via a Merkle tree).
+.TP
+.BR STATX_ATTR_DAX (since Linux 5.8)
+The file is in the DAX (cpu direct access) state.  DAX state attempts to
+minimize software cache effects for both I/O and memory mappings of this file.
+It requires a file system which has been configured to support DAX.
+.PP
+DAX generally assumes all accesses are via cpu load / store instructions which
+can minimize overhead for small accesses, but may adversely affect cpu
+utilization for large transfers.
+.PP
+File I/O is done directly to/from user-space buffers and memory mapped I/O may
+be performed with direct memory mappings that bypass kernel page cache.
+.PP
+While the DAX property tends to result in data being transferred synchronously,
+it does not give the same guarantees of O_SYNC where data and the necessary
+metadata are transferred together.
+.PP
+A DAX file may support being mapped with the MAP_SYNC flag, which enables a
+program to use CPU cache flush instructions to persist CPU store operations
+without an explicit
+.BR fsync(2).
+See
+.BR mmap(2)
+for more information.
 .SH RETURN VALUE
 On success, zero is returned.
 On error, \-1 is returned, and
-- 
2.25.1


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, back to index

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-05-05  0:20 [PATCH] man/statx: Add STATX_ATTR_DAX ira.weiny

Linux-man Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-man/0 linux-man/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-man linux-man/ https://lore.kernel.org/linux-man \
		linux-man@vger.kernel.org
	public-inbox-index linux-man

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-man


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git