NFSTEST_CACHE(1)

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

💖 NFSTEST_CACHE 💖 (section 1 of the manual, bestie)

okay so this is nfstest_cache, version 1.0.1 — it's part of the nfstest family and it's the girl for NFS client side caching tests. let's get into it ✨

🌸 NAME 🌸

nfstest_cache — NFS client side caching tests. that's it, that's the whole vibe. 🦋

✨ SYNOPSIS ✨

nfstest_cache --server <server> --client <client> [options]

💅 DESCRIPTION 💅

so what we're doing here is verifying consistency of attribute caching by messing with acregmin, acregmax, acdirmin, acdirmax and actimo. and then we do the same little dance for data caching — varying acregmin, acregmax, acdirmin, acdirmax and actimo again. 💖

valid for any version of NFS. periodt.

🎀 OPTIONS 🎀

  • --version — shows the program's version number and then dips out. 👋
  • -h, --help — shows this help message and exits. iconic behavior honestly.
  • -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. three whole places, she's thorough. 📁

🌈 NFS specific options

  • -s SERVER, --server=SERVER — server name or IP address. yes you need this one bestie.
  • -e EXPORT, --export=EXPORT — exported file system to mount [default: '/']
  • --nfsversion=NFSVERSION — NFS version, like 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,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's displayed as an INFO message [default: '']
  • --notty — do not use terminal colors on output. sad but valid. 😭
  • --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: 32]
  • --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']
  • --client=CLIENT — remote NFS client
  • --justbefore=JUSTBEFORE — time in seconds to test a condition just before it is expected to come true [default: 2]
  • --acmin=ACMIN — comma separated values to use for acregmin/acdirmin/actimeo [default: 10]
  • --acmax=ACMAX — comma separated values to use for acregmax/acdirmax; the first value of acmin will be used as acregmin/acdirmin [default: 20]

🔥 TESTS 🔥

acregmin_attr

verify consistency of attribute caching by varying the acregmin NFS option.

the cached information is assumed to be valid for attrtimeo which starts at acregmin.

acregmax_attr

verify consistency of attribute caching by varying the acregmax NFS option.

the cached information is assumed to be valid for attrtimeo which starts at acregmin. an attribute revalidation to the server that shows no attribute change doubles attrtimeo up to acregmax. an attribute revalidation to the server that shows a change has occurred resets it to acregmin.

acdirmin_attr

verify consistency of attribute caching by varying the acdirmin NFS option.

the cached information is assumed to be valid for attrtimeo which starts at acdirmin. test that this is so.

acdirmax_attr

verify consistency of attribute caching by varying the acdirmax NFS option.

the cached information is assumed to be valid for attrtimeo which starts at acdirmin. an attribute revalidation to the server that shows no attribute change doubles attrtimeo up to acdirmax. an attribute revalidation to the server that shows a change has occurred resets it to acdirmin.

actimeo_attr

verify consistency of attribute caching by varying the actimeo NFS option.

the cached information is assumed to be valid for attrtimeo which starts and ends at actimeo.

acregmin_data

verify consistency of data caching by varying the acregmin NFS option.

acregmax_data

verify consistency of data caching by varying the acregmax NFS option.

the cached information is assumed to be valid for attrtimeo which starts at acregmin. an attribute revalidation to the server that shows no attribute change doubles attrtimeo up to acregmax. an attribute revalidation to the server that shows a change has occurred resets it to acregmin.

acdirmin_data

verify consistency of data caching by varying the acdirmin NFS option.

the cached information is assumed to be valid for attrtimeo which starts at acdirmin. test that this is so.

acdirmax_data

verify consistency of data caching by varying the acdirmax NFS option.

the cached information is assumed to be valid for attrtimeo which starts at acdirmin. an attribute revalidation to the server that shows no attribute change doubles attrtimeo up to acdirmax. an attribute revalidation to the server that shows a change has occurred resets it to acdirmin.

actimeo_data

verify consistency of data caching by varying the actimeo NFS option.

the cached information is assumed to be valid for attrtimeo which starts and ends at actimeo.

all

run all tests: acregmin_attr, acregmax_attr, acdirmin_attr, acdirmax_attr, actimeo_attr, acregmin_data, acregmax_data, acdirmin_data, acdirmax_data, actimeo_data

🍓 EXAMPLES 🍓

required options are --server and --client

$ nfstest_cache --server 192.168.0.11 --client 192.168.0.20

testing with different values of --acmin and --acmax (this takes a long time ⏳)

$ nfstest_cache --server 192.168.0.11 --client 192.168.0.20 --acmin
10,20 --acmax 20,30,60,80

🙈 NOTES 🙈

the user id in the local host and the host specified by --client must have access to run commands as root using the 'sudo' command without the need for a password. no password prompts allowed, she's not waiting around. 🔐

the user id must be able to 'ssh' to remote host without the need for a password.

bestie, this is not optional. if you can't sudo and ssh password-free on both boxes, the whole thing just does not go. 💀

💖 SEE ALSO 💖

nfstest.test_util(3), nfstest_alloc(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_sparse(1), nfstest_ssc(1), nfstest_xattr(1), nfstest_xid(1)

🌈 BUGS 🌈

no known bugs. she ate and left no crumbs. 👑

💜 AUTHOR 💜

Jorge Mora (mora@netapp.com) — shoutout to the author, legend behavior honestly 🫶

and that's the whole page bestie!! ✨ this was NFStest 3.2, dated 21 March 2023, and it lives in section 1 of the manual — NFSTEST_CACHE(1) fr fr. go run some caching tests and slay 💅💖🎀

📦 where this page comes from