NFSTEST_DELEGATION(1)

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

💖 NFSTEST_DELEGATION 💖

okay bestie, welcome to nfstest_delegation — it's the nfstest_delegation 1.8 manual page and it is so much, but I got you. this is part 1 of 2 so buckle up, we're not even done yet ✨

🌸 NAME 🌸

nfstest_delegation — Delegation tests 🦋

✨ SYNOPSIS ✨

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

💅 DESCRIPTION 💅

okay so first up we got the basic delegation tests and they verify that a correct delegation is granted when you open a file for reading or writing. also, like, another OPEN should not be sent for the same file when the client is holding a delegation, periodt. then we verify that the stateid of all I/O operations should be the delegation stateid — no cap. reads from a different process on the same file should not cause the client to send additional READ packets when the client is holding a read delegation. and furthermore 💅, a LOCK packet should not be sent to the server when the client is holding a delegation.

then we get to the recall delegation tests 🫶 and these verify the delegation is recalled when a conflicting operation is sent to the server from a different client. the conflicting operations are: reading, writing, removing, renaming, and changing the permissions on the same file. note bestie: reading a file from a different client can only recall a write delegation. removing the delegated file from a different client recalls the delegation and the server may or may not allow any more writes from the client after the delegation has been returned. renaming either the delegated file (as source) or into the delegated file (as target) recalls the delegation. in the case where the delegated file is the target of rename, the existing target is removed before the rename occurs, therefore the server may or may not allow any more writes from the client after the delegation has been removed — just like in the case when removing the delegated file. it's giving the same energy fr fr 😭

also ✨, verify that a read delegation is not recalled when a different client is granted a read delegation. after a delegation is recalled, the client may send an OPEN with CLAIM_DELEGATE_CUR before returning the delegation, specially when there is an open pending on the client. in addition, the stateid returned by the new open should be the same as the original OPEN stateid. also, a delegation should not be granted when re-opening the file before returning the delegation. the client may flush all written data before returning the WRITE delegation. the LOCK should be sent as well before returning a delegation which has been recalled. finally, a delegation should not be granted on the second client who caused the delegation recall on the first client. iconic behavior honestly 👑

🎀 OPTIONS 🎀

  • --version — show the program's version number and dip out 🫡
  • -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,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']
  • --client=CLIENT — remote NFS client and options used for recall delegation tests. clients are separated by a ',' and each client definition is a list of arguments separated by a ':', given in the following order if positional arguments is used (see examples):
clientname:server:export:nfsversion:port:proto:sec:mtpoint

[default: 'nfsversion=3:proto=tcp:port=2049']

  • --client-nfsvers=CLIENT_NFSVERS — comma separated list of valid NFS versions to use in the --client option. an NFS version from this list, which is different than that given by --nfsversion, is selected and included in the --client option [default: 4.0,4.1]
  • --lock-offset=LOCK_OFFSET — starting offset for lock [default: 0]
  • --lock-poffset=LOCK_POFFSET — starting offset for lock on pending open [default: 8192]
  • --lock-len=LOCK_LEN — number of bytes to lock [default: 4096]
  • --truncate — truncate file when writing from the second file for the recall tests
  • --setup-delay=SETUP_DELAY — seconds to delay after setup so all opens are released [default: 4.0]
bestie this is only part 1 😭 more manual page incoming, don't go anywhere 💖

🧪 TESTS 🧪

okay bestie, this is the whole test menu — every single test you can run, and what it does. no skipping, we're doing all of them 💅

  • basic — Run all basic delegation tests: basic01, basic02, basic03, basic04, basic05, basic06, basic07, basic08, basic09, basic10, basic11, basic12
  • stat — Run all basic delegation tests with file stat: basic03, basic04, basic09, basic10
  • lock — Run all basic delegation tests with file lock: basic05, basic06, basic11, basic12
  • basic01 — Basic read delegation test
  • basic02 — Basic write delegation test
  • basic03 — Basic read delegation test with file stat
  • basic04 — Basic write delegation test with file stat
  • basic05 — Basic read delegation test with file lock
  • basic06 — Basic write delegation test with file lock
  • basic07 — Basic write delegation test using RDWR open while reading
  • basic08 — Basic write delegation test using RDWR open while writing
  • basic09 — Basic write delegation test using RDWR open while reading with file stat
  • basic10 — Basic write delegation test using RDWR open while writing with file stat
  • basic11 — Basic write delegation test using RDWR open while reading with file lock
  • basic12 — Basic write delegation test using RDWR open while writing with file lock
  • recall — Run all recall delegation tests: recall01, recall02, recall03, recall04, recall05, recall06, recall07, recall08, recall09, recall10, recall11, recall12, recall13, recall14, recall15, recall16, recall17, recall18, recall19, recall20, recall21, recall22, recall23, recall24, recall25, recall26, recall27, recall28, recall29, recall30, recall31, recall32, recall33, recall34, recall35, recall36, recall37, recall38, recall39, recall40, recall41, recall42, recall43, recall44, recall45, recall46, recall47, recall48, recall49, recall50, recall51, recall52, recall53, recall54
  • setattr — Run all tests using SETATTR to recall the delegation: recall07, recall08, recall09, recall10, recall35, recall36, recall37, recall38
  • remove — Run all tests recalling the delegation by removing the delegated file: recall11, recall12, recall13, recall14, recall39, recall40, recall41, recall42
  • rename — Run all tests recalling the delegation by renaming the delegated file: recall15, recall16, recall17, recall18, recall19, recall20, recall21, recall22, recall43, recall44, recall45, recall46, recall47, recall48, recall49, recall50
  • pending — Run all recall delegation tests having a pending open: recall23, recall24, recall25, recall26, recall51, recall52, recall53, recall54
  • recall01 — Recall read delegation by writing from a second client
  • recall02 — Recall write delegation by writing from a second client
  • recall03 — Recall read delegation by writing from a second client with file lock
  • recall04 — Recall write delegation by writing from a second client with file lock
  • recall05 — Recall write delegation by reading from a second client
  • recall06 — Recall write delegation by reading from a second client with file lock
  • recall07 — Recall read delegation by changing the permissions to the file
  • recall08 — Recall write delegation by changing the permissions to the file
  • recall09 — Recall read delegation by changing the permissions to the file with file lock
  • recall10 — Recall write delegation by changing the permissions to the file with file lock
  • recall11 — Recall read delegation by removing the file
  • recall12 — Recall write delegation by removing the file
  • recall13 — Recall read delegation by removing the file with file lock
  • recall14 — Recall write delegation by removing the file with file lock
  • recall15 — Recall read delegation by renaming the file
  • recall16 — Recall write delegation by renaming the file
  • recall17 — Recall read delegation by renaming the file with file lock
  • recall18 — Recall write delegation by renaming the file with file lock
  • recall19 — Recall read delegation by renaming into the file
  • recall20 — Recall write delegation by renaming into the file
  • recall21 — Recall read delegation by renaming into the file with file lock
  • recall22 — Recall write delegation by renaming into the file with file lock
  • recall23 — Recall read delegation by writing from a second client with file lock, having a pending read open
  • recall24 — Recall read delegation by writing from a second client with file lock, having a pending write open. Delegation is returned by the client when the second open is done so there is no delegation recall
  • recall25 — Recall write delegation by writing from a second client with file lock, having a pending read open
  • recall26 — Recall write delegation by writing from a second client with file lock, having a pending write open
  • recall27 — Recall write delegation by reading from a second client using RDWR open while reading
  • recall28 — Recall write delegation by reading from a second client using RDWR open while writing
  • recall29 — Recall write delegation by writing from a second client using RDWR open while reading
  • recall30 — Recall write delegation by writing from a second client using RDWR open while writing
  • recall31 — Recall write delegation by reading from a second client using RDWR open while reading with file lock
  • recall32 — Recall write delegation by reading from a second client using RDWR open while writing with file lock
  • recall33 — Recall write delegation by writing from a second client using RDWR open while reading with file lock
  • recall34 — Recall write delegation by writing from a second client using RDWR open while writing with file lock
  • recall35 — Recall write delegation by changing the permissions to the file from a second client using RDWR open while reading
  • recall36 — Recall write delegation by changing the permissions to the file from a second client using RDWR open while writing
  • recall37 — Recall write delegation by changing the permissions to the file from a second client using RDWR open while reading with file lock
  • recall38 — Recall write delegation by changing the permissions to the file from a second client using RDWR open while writing with file lock
  • recall39 — Recall write delegation by removing the file from a second client using RDWR open while reading
  • recall40 — Recall write delegation by removing the file from a second client using RDWR open while writing
  • recall41 — Recall write delegation by removing the file from a second client using RDWR open while reading with file lock
  • recall42 — Recall write delegation by removing the file from a second client using RDWR open while writing with file lock
  • recall43 — Recall write delegation by renaming the file from a second client using RDWR open while reading
  • recall44 — Recall write delegation by renaming the file from a second client using RDWR open while writing
  • recall45 — Recall write delegation by renaming the file from a second client using RDWR open while reading with file lock
  • recall46 — Recall write delegation by renaming the file from a second client using RDWR open while writing with file lock
  • recall47 — Recall write delegation by renaming the file from a second client using RDWR open while reading
  • recall48 — Recall write delegation by renaming the file from a second client using RDWR open while writing
  • recall49 — Recall write delegation by renaming the file from a second client using RDWR open while reading with file lock
  • recall50 — Recall write delegation by renaming the file from a second client using RDWR open while writing with file lock
  • recall51 — Recall write delegation by writing from a second client using RDWR open while reading with file lock, having a pending read open
  • recall52 — Recall write delegation by writing from a second client using RDWR open while reading with file lock, having a pending write open
  • recall53 — Recall write delegation by writing from a second client using RDWR open while writing with file lock, having a pending read open
  • recall54 — Recall write delegation by writing from a second client using RDWR open while writing with file lock, having a pending write open
  • read_deleg — Run all read delegation tests: basic01, basic03, basic05, recall01, recall03, recall07, recall09, recall11, recall13, recall15, recall17, recall19, recall21, recall23, recall24
  • write_deleg — Run all write delegation tests: basic02, basic04, basic06, basic07, basic08, basic09, basic10, basic11, basic12, recall02, recall04, recall05, recall06, recall08, recall10, recall12, recall14, recall16, recall18, recall20, recall22, recall25, recall26, recall27, recall28, recall29, recall30, recall31, recall32, recall33, recall34, recall35, recall36, recall37, recall38, recall39, recall40, recall41, recall42, recall43, recall44, recall45, recall46, recall47, recall48, recall49, recall50, recall51, recall52, recall53, recall54
  • all — Run all tests: basic01, basic02, basic03, basic04, basic05, basic06, basic07, basic08, basic09, basic10, basic11, basic12, recall01, recall02, recall03, recall04, recall05, recall06, recall07, recall08, recall09, recall10, recall11, recall12, recall13, recall14, recall15, recall16, recall17, recall18, recall19, recall20, recall21, recall22, recall23, recall24, recall25, recall26, recall27, recall28, recall29, recall30, recall31, recall32, recall33, recall34, recall35, recall36, recall37, recall38, recall39, recall40, recall41, recall42, recall43, recall44, recall45, recall46, recall47, recall48, recall49, recall50, recall51, recall52, recall53, recall54

📚 EXAMPLES 📚

okay so here's how you actually run this thing, bestie 💖

Run the basic delegation tests (no client option):

nfstest_delegation --server 192.168.0.2 --export /exports

Use short options instead:

nfstest_delegation -s 192.168.0.2 -e /exports

Run both the basic and recall tests using positional arguments with nfsversion=3 for the second client:

nfstest_delegation -s 192.168.0.2 -e /exports --client 192.168.0.10:::3

Use named arguments instead:

nfstest_delegation -s 192.168.0.2 -e /exports --client 192.168.0.10:nfsversion=3

📝 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.

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

no cap, those two things are non-negotiable — set up your ssh keys and passwordless sudo first or you're gonna have a bad time 😭

👀 SEE ALSO 👀

🐛 BUGS 🐛

No known bugs.

periodt. flawless behavior only 💅

👑 AUTHOR 👑

Jorge Mora (mora@netapp.com)

and that's a wrap on this whole page, bestie! this was NFStest 3.2, dated 21 March 2023 — go forth and delegate like the main character you are 🦋✨

📦 where this page comes from