.\" DO NOT MODIFY THIS FILE!  It was generated by setup.py 1.2.
.TH NFSTEST_ALLOC 1 "21 March 2023" "NFStest 3.2" "nfstest_alloc 1.3"
.SH NAME
nfstest_alloc - Space reservation tests
.SH SYNOPSIS
nfstest_alloc --server <server> [options]
.SH DESCRIPTION
Verify correct functionality of space reservations so applications are
able to reserve or unreserve space for a file. The system call fallocate
is used to manipulate the allocated disk space for a file, either to
preallocate or deallocate it. For filesystems which support the fallocate
system call, preallocation is done quickly by allocating blocks and
marking them as uninitialized, requiring no I/O to the data blocks.
This is much faster than creating a file and filling it with zeros.

Basic allocate tests verify the disk space is actually preallocated or
reserved for the given range by filling up the device after the allocation
and make sure data can be written to the allocated range without any
problems. Also, any data written outside the allocated range will fail
with NFS4ERR_NOSPC when there is no more space left on the device.
On the other hand, deallocating space will give the disk space back
so it can be used by either the same file on regions not already
preallocated or by different files without the risk of getting
a no space error.

Performance testing using ALLOCATE versus initializing a file to all
zeros is also included. The performance comparison is done with different
file sizes.

Some tests include testing at the protocol level by taking a packet trace
and inspecting the actual packets sent to the server or servers.

Negative testing is included whenever possible since some testing cannot
be done at the protocol level because the fallocate system call does some
error checking of its own and the NFS client won't even send an ALLOCATE
or DEALLOCATE operation to the server letting the server deal with the
error. Negative tests include trying to allocate an invalid range, having
an invalid value for either the offset or the length, trying to allocate
or deallocate a region on a file opened as read only or the file is a
non-regular file type.


.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.2]
.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 "--free-blocks=FREE_BLOCKS"
Number of free blocks to use when trying to allocate all available
space [default: 64]
.IP "--perf-fsize=PERF_FSIZE"
Starting file size for the perf01 test [default: 1MB]
.IP "--perf-mult=PERF_MULT"
File size multiplier for the perf01 test, the tests are performed
for a file size which is a multiple of the previous test file size
[default: 4]
.IP "--perf-time=PERF_TIME"
Run the performance test perf01 until the sub-test for the current
file size executes for more than this time [default: 15]
.SH TESTS
.SS alloc
.nf
Run all ALLOCATE tests: alloc01, alloc02, alloc03, alloc04, alloc05,
alloc06
.fi
.SS alloc01
.nf
Verify ALLOCATE succeeds on files opened as write only
.fi
.SS alloc02
.nf
Verify ALLOCATE succeeds on files opened as read and write
.fi
.SS alloc03
.nf
Verify ALLOCATE fails on files opened as read only
.fi
.SS alloc04
.nf
Verify ALLOCATE fails with EINVAL for invalid offset or length
.fi
.SS alloc05
.nf
Verify ALLOCATE fails with ESPIPE when using a named pipe file handle
.fi
.SS alloc06
.nf
Verify ALLOCATE reserves the disk space
.fi
.SS dealloc
.nf
Run all DEALLOCATE tests: dealloc01, dealloc02, dealloc03, dealloc04,
dealloc05, dealloc06
.fi
.SS dealloc01
.nf
Verify DEALLOCATE succeeds on files opened as write only
.fi
.SS dealloc02
.nf
Verify DEALLOCATE succeeds on files opened as read and write
.fi
.SS dealloc03
.nf
Verify DEALLOCATE fails on files opened as read only
.fi
.SS dealloc04
.nf
Verify DEALLOCATE fails with EINVAL for invalid offset or length
.fi
.SS dealloc05
.nf
Verify DEALLOCATE fails with ESPIPE when using a named pipe file handle
.fi
.SS dealloc06
.nf
Verify DEALLOCATE unreserves the disk space
.fi
.SS perf01
.nf
Verify ALLOCATE outperforms initializing the file to all zeros
.fi
.SS all
.nf
Run all tests: alloc01, alloc02, alloc03, alloc04, alloc05, alloc06,
dealloc01, dealloc02, dealloc03, dealloc04, dealloc05, dealloc06, perf01
.fi
.SH EXAMPLES
The only required option is --server
.br
$ nfstest_alloc --server 192.168.0.11
.SH 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.

Tests which require filling up all the disk space on the mounted device
should have exclusive access to the device.

Valid only for NFS version 4.2 and above.
.SH SEE ALSO
.BR formatstr(3),
.BR nfstest.test_util(3),
.BR nfstest.utils(3),
.BR nfstest_cache(1),
.BR nfstest_delegation(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.nfs4_const(3)

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