NFSTEST_SPARSE(1)

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

✨ nfstest_sparse ✨

okay bestie, pull up a chair 🫶 this is the manual for nfstest_sparse (version 1.0, from the nfstest_sparse 1.0 fam) — it's a whole vibe and it's literally here to make NFSv4.2 sparse files behave.

🌸 NAME 🌸

nfstest_sparse — sparse file tests 💖

🦋 SYNOPSIS 🦋

nfstest_sparse --server <server> [options]

✨ DESCRIPTION ✨

So the whole point of this icon is to verify that sparse files are doing what they're supposed to do. And what is a sparse file, you ask? It's a file that has unallocated or uninitialized data blocks chillin' in there as holes. The new NFSv4.2 operation SEEK is what we use to search for the next hole or data segment in a file. 🔍

The basic tests verify that SEEK returns the correct offset of the next hole or data, with respect to the starting offset that got handed to the seek system call. We also verify that the SEEK operation is sent to the server with the correct stateid, as a READ call. And here's a fun lil fact: all files have a virtual hole at the end of the file, so when you're searching for the next hole — even if the file literally has no hole — it returns the size of the file. no cap. 🌈

Some tests go full protocol-level on you: they take a packet trace and inspect the actual packets sent to the server. yes ma'am, we're reading the mail. 💅

Negative tests include trying to SEEK starting from an offset beyond the end of the file. 💀

🎀 OPTIONS 🎀

  • --version — show the program's version number and exit ✨
  • -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.2]
  • -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,rsize=4096,wsize=4096']
  • --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 is displayed as an INFO message [default: '']
  • --notty — do not use terminal colors on output
  • --isatty — use terminal colors on output — 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: 64k]
  • --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']

👑 TESTS 👑

seek

Run all SEEK tests: seek01, seek02, seek03, seek04

seek01

Verify SEEK succeeds searching for the next data

seek02

Verify SEEK succeeds searching for the next hole

seek03

Verify SEEK searching for next data fails with ENXIO when offset is beyond the end of the file

seek04

Verify SEEK searching for next hole fails with ENXIO when offset is beyond the end of the file

all

Run all tests: seek01, seek02, seek03, seek04

💖 EXAMPLES 💖

The only required option is --server

$ nfstest_sparse --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.

Valid only for NFS version 4.2 and above. ⚠️

🔥 SEE ALSO 🔥

nfstest.test_util(3), nfstest.utils(3), nfstest_alloc(1), nfstest_cache(1), nfstest_delegation(1), nfstest_dio(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_ssc(1), nfstest_xattr(1), nfstest_xid(1), packet.nfs.nfs4_const(3)

💀 BUGS 💀

No known bugs. (we ate and left no crumbs, fr fr 🫶)

🌟 AUTHOR 🌟

Jorge Mora (mora@netapp.com)

and that's a wrap bestie!! this page is from NFStest 3.2, dated 21 March 2023 — go forth and seek those holes, ily, mwah 💖🎀🦋

📦 where this page comes from