NFSTEST_DIO(1)

📦 version 3.2, in debian trixie, fedora 43, fedora 44, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

🌸 NAME 🌸

okay so bestie, meet nfstest_dio(1) — it's the Direct I/O tests page from nfstest_dio 1.5, and we're gonna read it together, no cap 💖

✨ SYNOPSIS ✨

nfstest_dio --server <server> [options]

like literally that's it, that's the whole vibe check 🦋

💫 DESCRIPTION 💫

Functional direct I/O tests are the ones that make sure every single READ/WRITE actually goes to the server instead of the client just being lazy and caching the requests 🙅‍♀️. The client bypasses read ahead by sending the READ with only the requested bytes. Then we verify the client correctly handles the eof marker when reading the whole file. And we verify the client ignores delegation while writing a file. iconic behavior, honestly.

Direct I/O on pNFS tests verify the client sends the READ/WRITE to the correct DS, or to the MDS if it's using a PAGESIZE aligned buffer or not, respectively. yes the "respectively" is doing heavy lifting there, we love her 💅

Direct I/O data correctness tests verify that a file written with buffered I/O is read correctly with direct I/O. And also verify that a file written with direct I/O is read correctly with buffered I/O. it goes both ways, as it should 🫶

Vectored I/O tests verify coalescence of multiple vectors into one READ/WRITE packet when all vectors are PAGESIZE aligned. Vectors with different alignments get sent on separate packets. no merging for the misaligned girlies ✨

Valid for NFSv4.0 and NFSv4.1 including pNFS.

🎀 OPTIONS 🎀

the basics, bestie

  • --version — show the program's version number and exit, bye 👋
  • -h, --help — show this help message and exit 💖
  • -f FILE, --file=FILE — the file where options are specified, besides the system wide file /etc/nfstest, the user wide file $HOME/.nfstest, or the .nfstest file in the current directory 🗂️

🦋 NFS specific options 🦋

  • -s SERVER, --server=SERVER — server name or IP address 📍
  • -e EXPORT, --export=EXPORT — exported file system to mount [default: '/']
  • --nfsversion=NFSVERSION — NFS version, e.g., 3, 4, 4.1, etc. [default: 4.1]
  • -m MTPOINT, --mtpoint=MTPOINT — mount point [default: '/mnt/t']
  • -p PORT, --port=PORT — NFS server port [default: 2049]
  • --proto=PROTO — NFS protocol name [default: 'tcp']
  • --sec=SEC — security flavor [default: 'sys']
  • --nconnect=NCONNECT — multiple TCP connections option [default: '1']
  • -o MTOPTS, --mtopts=MTOPTS — mount options [default: 'hard,intr']
  • --datadir=DATADIR — data directory where files are created; the directory is created on the mount point [default: '']

🌈 Logging options 🌈

  • -v VERBOSE, --verbose=VERBOSE — verbose level for debug messages [default: 'opts|info|dbg1|dbg2|dbg3']
  • --tverbose=TVERBOSE — verbose level for test messages [default: '1']
  • --createlog — create log file 📝
  • --rexeclog — create rexec log files
  • --warnings — display warnings ⚠️
  • --tag=TAG — informational tag, it gets displayed as an INFO message [default: '']
  • --notty — do not use terminal colors on output 🚫🎨
  • --isatty — use terminal colors on output — super useful when running with nohup ✨

🍓 Packet trace options 🍓

  • --createtraces — create a packet trace for each test
  • --tbsize=TBSIZE — capture buffer size for tcpdump [default: 192k]
  • --trcdelay=TRCDELAY — seconds to delay before stopping packet trace [default: 2.0]
  • --keeptraces — do not remove any trace files [default: remove trace files if no errors]
  • --rmtraces — remove trace files [default: remove trace files if no errors]
  • -i INTERFACE, --interface=INTERFACE — device interface [default: automatically selected]

🧚 File options 🧚

  • --nfiles=NFILES — number of files to create [default: 2]
  • --filesize=FILESIZE — file size to use for test files [default: 262144]
  • --rsize=RSIZE — read size to use when reading files [default: 4k]
  • --wsize=WSIZE — write size to use when writing files [default: 4k]
  • --iodelay=IODELAY — seconds to delay I/O operations [default: 0.1]
  • --offset-delta=OFFSET_DELTA — read/write offset delta [default: 4k]

💜 Path options 💜

  • --sudo=SUDO — full path of binary for sudo [default: '/usr/bin/sudo']
  • --kill=KILL — full path of binary for kill [default: '/usr/bin/kill']
  • --nfsstat=NFSSTAT — full path of binary for nfsstat [default: '/usr/sbin/nfsstat']
  • --tcpdump=TCPDUMP — full path of binary for tcpdump [default: '/usr/sbin/tcpdump']
  • --iptables=IPTABLES — full path of binary for iptables [default: '/usr/sbin/iptables']
  • --messages=MESSAGES — full path of log messages file [default: '/var/log/messages']
  • --trcevents=TRCEVENTS — full path of tracing events directory [default: '/sys/kernel/debug/tracing/events']
  • --trcpipe=TRCPIPE — full path of trace pipe file [default: '/sys/kernel/debug/tracing/trace_pipe']
  • --tmpdir=TMPDIR — temporary directory [default: '/tmp']

👑 Debug options 👑

  • --nocleanup — do not cleanup created files 🧹❌
  • --notimestamps — do not display timestamps in debug messages
  • --bugmsgs=BUGMSGS — file containing test messages to mark as bugs if they failed
  • --nomount — do not mount server and run the tests on local disk space
  • --basename=BASENAME — base name for all files and logs [default: automatically generated]
  • --nfsdebug=NFSDEBUG — set NFS kernel debug flags and save log messages [default: '']
  • --rpcdebug=RPCDEBUG — set RPC kernel debug flags and save log messages [default: '']
  • --tracepoints=TRACEPOINTS — list of trace points modules to enable [default: '']
  • --nfsstats — get NFS stats [default: 'False']
  • --pktdisp — display main packets related to the given test
  • --nfserrors — fail every NFS error found in the packet trace 💀
  • --client-ipaddr=CLIENT_IPADDR — IP address of localhost

⭐ Reporting options ⭐

  • --xunit-report — generate xUnit compatible test report
  • --xunit-report-file=XUNIT_REPORT_FILE — path to xout report file

🔥 Test options 🔥

  • --runtest=RUNTEST — comma separated list of tests to run; if the list starts with a '^' then all tests are run except the ones listed [default: 'all']
  • --iotype=IOTYPE — list of I/O types to test [default: 'read,write']
  • --biotype=BIOTYPE — list of buffered I/O types to test [default: 'none,read,write']
  • --withdeleg=WITHDELEG — use delegation on tests [default: both without and with delegation]

💖 TESTS 💖

eof

Verify the eof marker is handled correctly when reading the end of the file. 🫶

correctness

Verify data correctness when reading/writing using direct I/O. A file created with buffered I/O is read correctly with direct I/O. A file created with direct I/O is read correctly with buffered I/O. ✨

fstat

Verify fstat() gets the correct file size after writing. 📏

read

Verify READ is sent after writing when the file is open for both read and write.

read_ahead

Verify READ is sent with only the requested bytes, bypassing read ahead. 🏃‍♀️

basic

Verify a packet is sent for each I/O request. one packet, one request, periodt 💅

rsize

Verify multiple READ packets are sent for each read request having request size > rsize.

wsize

Verify multiple WRITE packets are sent for each write request having request size > wsize

aligned

Verify the packet is sent to the correct DS server when using a memory which is PAGESIZE aligned. ✅

nonaligned

Verify the packet is sent to the MDS when using a memory which is not PAGESIZE aligned.

diffalign

Verify packets are sent to both the MDS and the correct DS on the same open, using buffers with different alignments. 🌈

stripesize

Verify multiple packets are sent for each request having the request size greater than stripe size.

vectored_io

Verify vectored I/O functionality.

all

Run all tests: eof, correctness, fstat, read, read_ahead, basic, rsize, wsize, aligned, nonaligned, diffalign, stripesize, vectored_io 👑

🌟 EXAMPLES 🌟

The only required option is --server, bestie. that's the whole assignment 🎀

$ nfstest_dio --server 192.168.0.11

🙈 NOTES 🙈

The user id in the local host must have access to run commands as root using the 'sudo' command without the need for a password. so like, set that up first, or you're gonna have a bad time 😭

🦄 SEE ALSO 🦄

formatstr(3), nfstest.test_util(3), nfstest_alloc(1), nfstest_cache(1), nfstest_delegation(1), nfstest_fcmp(1), nfstest_file(1), nfstest_interop(1), nfstest_io(1), nfstest_lock(1), nfstest_pkt(1), nfstest_pnfs(1), nfstest_posix(1), nfstest_rdma(1), nfstest_sparse(1), nfstest_ssc(1), nfstest_xattr(1), nfstest_xid(1), packet.nfs.nfs3_const(3), packet.nfs.nfs4_const(3)

go read those too, iykyk 📚💜

💀 BUGS 💀

No known bugs. we ate and left no crumbs, fr fr ✨

💅 AUTHOR 💅

Jorge Mora (mora@netapp.com) — ty for your service king 🫶

and that's the whole page bestie!! this was NFStest 3.2, dated 21 March 2023 — slay, iconic, no notes 💖✨🎀

📦 where this page comes from