.\" DO NOT MODIFY THIS FILE!  It was generated by setup.py 1.2.
.TH NFSTEST_DELEGATION 1 "21 March 2023" "NFStest 3.2" "nfstest_delegation 1.8"
.SH NAME
nfstest_delegation - Delegation tests
.SH SYNOPSIS
nfstest_delegation --server <server> [--client <client>] [options]
.SH DESCRIPTION
Basic delegation tests verify that a correct delegation is granted when
opening a file for reading or writing. Also, another OPEN should not be
sent for the same file when the client is holding a delegation. Verify
that the stateid of all I/O operations should be the delegation stateid.
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.
Furthermore, a LOCK packet should not be sent to the server when the client
is holding a delegation.

Recall delegation tests verify the delegation is recalled when a conflicting
operation is sent to the server from a different client. Conflicting operations
are reading, writing, removing, renaming and changing the permissions on the
same file. Note that 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 nay more writes from the client after the delegation has
been removed just like in the case when removing the delegated file.

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 a 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
cause the delegation recall on the first client.


.SH OPTIONS
.IP "--version"
show program's version number and exit
.IP "-h, --help"
show this help message and exit
.IP "-f FILE, --file=FILE"
File where options are specified besides the system wide file
/etc/nfstest, user wide file $HOME/.nfstest or in the current
directory .nfstest file

.SS NFS specific options:

.IP "-s SERVER, --server=SERVER"
Server name or IP address
.IP "-e EXPORT, --export=EXPORT"
Exported file system to mount [default: '/']
.IP "--nfsversion=NFSVERSION"
NFS version, e.g., 3, 4, 4.1, etc. [default: 4.1]
.IP "-m MTPOINT, --mtpoint=MTPOINT"
Mount point [default: '/mnt/t']
.IP "-p PORT, --port=PORT"
NFS server port [default: 2049]
.IP "--proto=PROTO"
NFS protocol name [default: 'tcp']
.IP "--sec=SEC"
Security flavor [default: 'sys']
.IP "--nconnect=NCONNECT"
Multiple TCP connections option [default: '1']
.IP "-o MTOPTS, --mtopts=MTOPTS"
Mount options [default: 'hard,rsize=4096,wsize=4096']
.IP "--datadir=DATADIR"
Data directory where files are created, directory is created on the
mount point [default: '']

.SS Logging options:

.IP "-v VERBOSE, --verbose=VERBOSE"
Verbose level for debug messages [default:
\t'opts|info|dbg1|dbg2|dbg3']
.IP "--tverbose=TVERBOSE"
Verbose level for test messages [default: '1']
.IP "--createlog"
Create log file
.IP "--rexeclog"
Create rexec log files
.IP "--warnings"
Display warnings
.IP "--tag=TAG"
Informational tag, it is displayed as an INFO message [default: '']
.IP "--notty"
Do not use terminal colors on output
.IP "--isatty"
Use terminal colors on output -- useful when running with nohup

.SS Packet trace options:

.IP "--createtraces"
Create a packet trace for each test
.IP "--tbsize=TBSIZE"
Capture buffer size for tcpdump [default: 192k]
.IP "--trcdelay=TRCDELAY"
Seconds to delay before stopping packet trace [default: 2.0]
.IP "--keeptraces"
Do not remove any trace files [default: remove trace files if no
errors]
.IP "--rmtraces"
Remove trace files [default: remove trace files if no errors]
.IP "-i INTERFACE, --interface=INTERFACE"
Device interface [default: automatically selected]

.SS File options:

.IP "--nfiles=NFILES"
Number of files to create [default: 2]
.IP "--filesize=FILESIZE"
File size to use for test files [default: 64k]
.IP "--rsize=RSIZE"
Read size to use when reading files [default: 4k]
.IP "--wsize=WSIZE"
Write size to use when writing files [default: 4k]
.IP "--iodelay=IODELAY"
Seconds to delay I/O operations [default: 0.1]
.IP "--offset-delta=OFFSET_DELTA"
Read/Write offset delta [default: 4k]

.SS Path options:

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

.SS Debug options:

.IP "--nocleanup"
Do not cleanup created files
.IP "--notimestamps"
Do not display timestamps in debug messages
.IP "--bugmsgs=BUGMSGS"
File containing test messages to mark as bugs if they failed
.IP "--nomount"
Do not mount server and run the tests on local disk space
.IP "--basename=BASENAME"
Base name for all files and logs [default: automatically generated]
.IP "--nfsdebug=NFSDEBUG"
Set NFS kernel debug flags and save log messages [default: '']
.IP "--rpcdebug=RPCDEBUG"
Set RPC kernel debug flags and save log messages [default: '']
.IP "--tracepoints=TRACEPOINTS"
List of trace points modules to enable [default: '']
.IP "--nfsstats"
Get NFS stats [default: 'False']
.IP "--pktdisp"
Display main packets related to the given test
.IP "--nfserrors"
Fail every NFS error found in the packet trace
.IP "--client-ipaddr=CLIENT_IPADDR"
IP address of localhost

.SS Reporting options:

.IP "--xunit-report"
Generate xUnit compatible test report
.IP "--xunit-report-file=XUNIT_REPORT_FILE"
Path to xout report file

.SS Test options:

.IP "--runtest=RUNTEST"
Comma separated list of tests to run, if list starts with a '^' then
all tests are run except the ones listed [default: 'all']
.IP "--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:
\t'nfsversion=3:proto=tcp:port=2049']
.IP "--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]
.IP "--lock-offset=LOCK_OFFSET"
Starting offset for lock [default: 0]
.IP "--lock-poffset=LOCK_POFFSET"
Starting offset for lock on pending open [default: 8192]
.IP "--lock-len=LOCK_LEN"
Number of bytes to lock [default: 4096]
.IP "--truncate"
Truncate file when writing from the second file for the recall tests
.IP "--setup-delay=SETUP_DELAY"
Seconds to delay after setup so all opens are released [default:
4.0]
.SH TESTS
.SS basic
.nf
Run all basic delegation tests: basic01, basic02, basic03, basic04,
basic05, basic06, basic07, basic08, basic09, basic10, basic11, basic12
.fi
.SS stat
.nf
Run all basic delegation tests with file stat: basic03, basic04,
basic09, basic10
.fi
.SS lock
.nf
Run all basic delegation tests with file lock: basic05, basic06,
basic11, basic12
.fi
.SS basic01
.nf
Basic read delegation test
.fi
.SS basic02
.nf
Basic write delegation test
.fi
.SS basic03
.nf
Basic read delegation test with file stat
.fi
.SS basic04
.nf
Basic write delegation test with file stat
.fi
.SS basic05
.nf
Basic read delegation test with file lock
.fi
.SS basic06
.nf
Basic write delegation test with file lock
.fi
.SS basic07
.nf
Basic write delegation test using RDWR open while reading
.fi
.SS basic08
.nf
Basic write delegation test using RDWR open while writing
.fi
.SS basic09
.nf
Basic write delegation test using RDWR open while reading with file stat
.fi
.SS basic10
.nf
Basic write delegation test using RDWR open while writing with file stat
.fi
.SS basic11
.nf
Basic write delegation test using RDWR open while reading with file lock
.fi
.SS basic12
.nf
Basic write delegation test using RDWR open while writing with file lock
.fi
.SS recall
.nf
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
.fi
.SS setattr
.nf
Run all tests using SETATTR to recall the delegation: recall07,
recall08, recall09, recall10, recall35, recall36, recall37, recall38
.fi
.SS remove
.nf
Run all tests recalling the delegation by removing the delegated file:
recall11, recall12, recall13, recall14, recall39, recall40, recall41,
recall42
.fi
.SS rename
.nf
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
.fi
.SS pending
.nf
Run all recall delegation tests having a pending open: recall23,
recall24, recall25, recall26, recall51, recall52, recall53, recall54
.fi
.SS recall01
.nf
Recall read delegation by writing from a second client
.fi
.SS recall02
.nf
Recall write delegation by writing from a second client
.fi
.SS recall03
.nf
Recall read delegation by writing from a second client with file lock
.fi
.SS recall04
.nf
Recall write delegation by writing from a second client with file lock
.fi
.SS recall05
.nf
Recall write delegation by reading from a second client
.fi
.SS recall06
.nf
Recall write delegation by reading from a second client with file lock
.fi
.SS recall07
.nf
Recall read delegation by changing the permissions to the file
.fi
.SS recall08
.nf
Recall write delegation by changing the permissions to the file
.fi
.SS recall09
.nf
Recall read delegation by changing the permissions to the file with file lock
.fi
.SS recall10
.nf
Recall write delegation by changing the permissions to the file with file lock
.fi
.SS recall11
.nf
Recall read delegation by removing the file
.fi
.SS recall12
.nf
Recall write delegation by removing the file
.fi
.SS recall13
.nf
Recall read delegation by removing the file with file lock
.fi
.SS recall14
.nf
Recall write delegation by removing the file with file lock
.fi
.SS recall15
.nf
Recall read delegation by renaming the file
.fi
.SS recall16
.nf
Recall write delegation by renaming the file
.fi
.SS recall17
.nf
Recall read delegation by renaming the file with file lock
.fi
.SS recall18
.nf
Recall write delegation by renaming the file with file lock
.fi
.SS recall19
.nf
Recall read delegation by renaming into the file
.fi
.SS recall20
.nf
Recall write delegation by renaming into the file
.fi
.SS recall21
.nf
Recall read delegation by renaming into the file with file lock
.fi
.SS recall22
.nf
Recall write delegation by renaming into the file with file lock
.fi
.SS recall23
.nf
Recall read delegation by writing from a second client with file lock,
having a pending read open
.fi
.SS recall24
.nf
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
.fi
.SS recall25
.nf
Recall write delegation by writing from a second client with file lock,
having a pending read open
.fi
.SS recall26
.nf
Recall write delegation by writing from a second client with file lock,
having a pending write open
.fi
.SS recall27
.nf
Recall write delegation by reading from a second client using RDWR
open while reading
.fi
.SS recall28
.nf
Recall write delegation by reading from a second client using RDWR
open while writing
.fi
.SS recall29
.nf
Recall write delegation by writing from a second client using RDWR
open while reading
.fi
.SS recall30
.nf
Recall write delegation by writing from a second client using RDWR
open while writing
.fi
.SS recall31
.nf
Recall write delegation by reading from a second client using RDWR
open while reading with file lock
.fi
.SS recall32
.nf
Recall write delegation by reading from a second client using RDWR
open while writing with file lock
.fi
.SS recall33
.nf
Recall write delegation by writing from a second client using RDWR
open while reading with file lock
.fi
.SS recall34
.nf
Recall write delegation by writing from a second client using RDWR
open while writing with file lock
.fi
.SS recall35
.nf
Recall write delegation by changing the permissions to the file
from a second client using RDWR open while reading
.fi
.SS recall36
.nf
Recall write delegation by changing the permissions to the file
from a second client using RDWR open while writing
.fi
.SS recall37
.nf
Recall write delegation by changing the permissions to the file
from a second client using RDWR open while reading with file lock
.fi
.SS recall38
.nf
Recall write delegation by changing the permissions to the file
from a second client using RDWR open while writing with file lock
.fi
.SS recall39
.nf
Recall write delegation by removing the file from a second client
using RDWR open while reading
.fi
.SS recall40
.nf
Recall write delegation by removing the file from a second client
using RDWR open while writing
.fi
.SS recall41
.nf
Recall write delegation by removing the file from a second client
using RDWR open while reading with file lock
.fi
.SS recall42
.nf
Recall write delegation by removing the file from a second client
using RDWR open while writing with file lock
.fi
.SS recall43
.nf
Recall write delegation by renaming the file from a second client
using RDWR open while reading
.fi
.SS recall44
.nf
Recall write delegation by renaming the file from a second client
using RDWR open while writing
.fi
.SS recall45
.nf
Recall write delegation by renaming the file from a second client
using RDWR open while reading with file lock
.fi
.SS recall46
.nf
Recall write delegation by renaming the file from a second client
using RDWR open while writing with file lock
.fi
.SS recall47
.nf
Recall write delegation by renaming the file from a second client
using RDWR open while reading
.fi
.SS recall48
.nf
Recall write delegation by renaming the file from a second client
using RDWR open while writing
.fi
.SS recall49
.nf
Recall write delegation by renaming the file from a second client
using RDWR open while reading with file lock
.fi
.SS recall50
.nf
Recall write delegation by renaming the file from a second client
using RDWR open while writing with file lock
.fi
.SS recall51
.nf
Recall write delegation by writing from a second client using RDWR
open while reading with file lock, having a pending read open
.fi
.SS recall52
.nf
Recall write delegation by writing from a second client using RDWR
open while reading with file lock, having a pending write open
.fi
.SS recall53
.nf
Recall write delegation by writing from a second client using RDWR
open while writing with file lock, having a pending read open
.fi
.SS recall54
.nf
Recall write delegation by writing from a second client using RDWR
open while writing with file lock, having a pending write open
.fi
.SS read_deleg
.nf
Run all read delegation tests: basic01, basic03, basic05, recall01,
recall03, recall07, recall09, recall11, recall13, recall15, recall17,
recall19, recall21, recall23, recall24
.fi
.SS write_deleg
.nf
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
.fi
.SS all
.nf
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
.fi
.SH EXAMPLES
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
.SH 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.
.SH SEE ALSO
.BR nfstest.test_util(3),
.BR nfstest_alloc(1),
.BR nfstest_cache(1),
.BR nfstest_dio(1),
.BR nfstest_fcmp(1),
.BR nfstest_file(1),
.BR nfstest_interop(1),
.BR nfstest_io(1),
.BR nfstest_lock(1),
.BR nfstest_pkt(1),
.BR nfstest_pnfs(1),
.BR nfstest_posix(1),
.BR nfstest_rdma(1),
.BR nfstest_sparse(1),
.BR nfstest_ssc(1),
.BR nfstest_xattr(1),
.BR nfstest_xid(1),
.BR packet.nfs.nfs3_const(3),
.BR packet.nfs.nfs4_const(3)

.SH BUGS
No known bugs.
.SH AUTHOR
Jorge Mora (mora@netapp.com)