.\" DO NOT MODIFY THIS FILE! It was generated by setup.py 1.2. .TH NFSTEST_DIO 1 "21 March 2023" "NFStest 3.2" "nfstest_dio 1.5" .SH NAME nfstest_dio - Direct I/O tests .SH SYNOPSIS nfstest_dio --server [options] .SH DESCRIPTION Functional direct I/O tests verify that every READ/WRITE is sent to the server instead of the client caching the requests. Client bypasses read ahead by sending the READ with only the requested bytes. Verify the client correctly handles eof marker when reading the whole file. Verify client ignores delegation while writing a file. Direct I/O on pNFS tests verify the client sends the READ/WRITE to the correct DS or the MDS if using a PAGESIZE aligned buffer or not, respectively. Direct I/O data correctness tests verify that a file written with buffered I/O is read correctly with direct I/O. Verify that a file written with direct I/O is read correctly with buffered I/O. Vectored I/O tests verify coalescence of multiple vectors into one READ/WRITE packet when all vectors are PAGESIZE aligned. Vectors with different alignments are sent on separate packets. Valid for NFSv4.0 and NFSv4.1 including pNFS. .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,intr'] .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: 262144] .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 "--iotype=IOTYPE" List of I/O types to test [default: 'read,write'] .IP "--biotype=BIOTYPE" List of buffered I/O types to test [default: 'none,read,write'] .IP "--withdeleg=WITHDELEG" Use delegation on tests [default: both without and with delegation] .SH TESTS .SS eof .nf Verify eof marker is handled correctly when reading the end of the file. .fi .SS correctness .nf Verify data correctness when reading/writing using direct I/O. File created with buffered I/O is read correctly with direct I/O. File created with direct I/O is read correctly with buffered I/O. .fi .SS fstat .nf Verify fstat() gets correct file size after writing. .fi .SS read .nf Verify READ is sent after writing when the file is open for both read and write. .fi .SS read_ahead .nf Verify READ is sent with only the requested bytes bypassing read ahead. .fi .SS basic .nf Verify a packet is sent for each I/O request. .fi .SS rsize .nf Verify multiple READ packets are sent for each read request having request size > rsize. .fi .SS wsize .nf Verify multiple WRITE packets are sent for each write request having request size > wsize .fi .SS aligned .nf Verify packet is sent to correct DS server when using a memory which is PAGESIZE aligned. .fi .SS nonaligned .nf Verify packet is sent to the MDS when using a memory which is not PAGESIZE aligned. .fi .SS diffalign .nf Verify packets are sent to both the MDS and correct DS on same open using buffers with different alignments. .fi .SS stripesize .nf Verify multiple packets are sent for each request having the request size greater than stripe size. .fi .SS vectored_io .nf Verify vectored I/O functionality. .fi .SS all .nf Run all tests: eof, correctness, fstat, read, read_ahead, basic, rsize, wsize, aligned, nonaligned, diffalign, stripesize, vectored_io .fi .SH EXAMPLES The only required option is --server .br $ nfstest_dio --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. .SH SEE ALSO .BR formatstr(3), .BR nfstest.test_util(3), .BR nfstest_alloc(1), .BR nfstest_cache(1), .BR nfstest_delegation(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)