NFSTEST_ALLOC(1) nfstest_alloc 1.3 NFSTEST_ALLOC(1)

nfstest_alloc - Space reservation tests

nfstest_alloc --server <server> [options]

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.

show program's version number and exit
show this help message and exit
File where options are specified besides the system wide file /etc/nfstest, user wide file $HOME/.nfstest or in the current directory .nfstest file

Server name or IP address
Exported file system to mount [default: '/']
NFS version, e.g., 3, 4, 4.1, etc. [default: 4.2]
Mount point [default: '/mnt/t']
NFS server port [default: 2049]
NFS protocol name [default: 'tcp']
Security flavor [default: 'sys']
Multiple TCP connections option [default: '1']
Mount options [default: 'hard,rsize=4096,wsize=4096']
Data directory where files are created, directory is created on the mount point [default: '']

Verbose level for debug messages [default: 'opts|info|dbg1|dbg2|dbg3']
Verbose level for test messages [default: '1']
Create log file
Create rexec log files
Display warnings
Informational tag, it is displayed as an INFO message [default: '']
Do not use terminal colors on output
Use terminal colors on output -- useful when running with nohup

Create a packet trace for each test
Capture buffer size for tcpdump [default: 192k]
Seconds to delay before stopping packet trace [default: 2.0]
Do not remove any trace files [default: remove trace files if no errors]
Remove trace files [default: remove trace files if no errors]
Device interface [default: automatically selected]

Number of files to create [default: 2]
File size to use for test files [default: 64k]
Read size to use when reading files [default: 4k]
Write size to use when writing files [default: 4k]
Seconds to delay I/O operations [default: 0.1]
Read/Write offset delta [default: 4k]

Full path of binary for sudo [default: '/usr/bin/sudo']
Full path of binary for kill [default: '/usr/bin/kill']
Full path of binary for nfsstat [default: '/usr/sbin/nfsstat']
Full path of binary for tcpdump [default: '/usr/sbin/tcpdump']
Full path of binary for iptables [default: '/usr/sbin/iptables']
Full path of log messages file [default: '/var/log/messages']
Full path of tracing events directory [default: '/sys/kernel/debug/tracing/events']
Full path of trace pipe file [default: '/sys/kernel/debug/tracing/trace_pipe']
Temporary directory [default: '/tmp']

Do not cleanup created files
Do not display timestamps in debug messages
File containing test messages to mark as bugs if they failed
Do not mount server and run the tests on local disk space
Base name for all files and logs [default: automatically generated]
Set NFS kernel debug flags and save log messages [default: '']
Set RPC kernel debug flags and save log messages [default: '']
List of trace points modules to enable [default: '']
Get NFS stats [default: 'False']
Display main packets related to the given test
Fail every NFS error found in the packet trace
IP address of localhost

Generate xUnit compatible test report
Path to xout report file

Comma separated list of tests to run, if list starts with a '^' then all tests are run except the ones listed [default: 'all']
Number of free blocks to use when trying to allocate all available space [default: 64]
Starting file size for the perf01 test [default: 1MB]
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]
Run the performance test perf01 until the sub-test for the current file size executes for more than this time [default: 15]

Run all ALLOCATE tests: alloc01, alloc02, alloc03, alloc04, alloc05,
alloc06

Verify ALLOCATE succeeds on files opened as write only

Verify ALLOCATE succeeds on files opened as read and write

Verify ALLOCATE fails on files opened as read only

Verify ALLOCATE fails with EINVAL for invalid offset or length

Verify ALLOCATE fails with ESPIPE when using a named pipe file handle

Verify ALLOCATE reserves the disk space

Run all DEALLOCATE tests: dealloc01, dealloc02, dealloc03, dealloc04,
dealloc05, dealloc06

Verify DEALLOCATE succeeds on files opened as write only

Verify DEALLOCATE succeeds on files opened as read and write

Verify DEALLOCATE fails on files opened as read only

Verify DEALLOCATE fails with EINVAL for invalid offset or length

Verify DEALLOCATE fails with ESPIPE when using a named pipe file handle

Verify DEALLOCATE unreserves the disk space

Verify ALLOCATE outperforms initializing the file to all zeros

Run all tests: alloc01, alloc02, alloc03, alloc04, alloc05, alloc06,
dealloc01, dealloc02, dealloc03, dealloc04, dealloc05, dealloc06, perf01

The only required option is --server
$ nfstest_alloc --server 192.168.0.11

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.

formatstr(3), nfstest.test_util(3), nfstest.utils(3), 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_sparse(1), nfstest_ssc(1), nfstest_xattr(1), nfstest_xid(1), packet.nfs.nfs4_const(3)

No known bugs.

Jorge Mora (mora@netapp.com)

21 March 2023 NFStest 3.2