1NFSTEST_CACHE(1) nfstest_cache 1.0.1 NFSTEST_CACHE(1)
2
3
4
6 nfstest_cache - NFS client side caching tests
7
9 nfstest_cache --server <server> --client <client> [options]
10
12 Verify consistency of attribute caching by varying acregmin, acregmax,
13 acdirmin, acdirmax and actimo. Verify consistency of data caching by
14 varying acregmin, acregmax, acdirmin, acdirmax and actimo.
15
16 Valid for any version of NFS.
17
18
19
21 --version
22 show program's version number and exit
23
24 -h, --help
25 show this help message and exit
26
27 -f FILE, --file=FILE
28 File where options are specified besides the system wide file
29 /etc/nfstest, user wide file $HOME/.nfstest or in the current
30 directory .nfstest file
31
32
33 NFS specific options:
34 -s SERVER, --server=SERVER
35 Server name or IP address
36
37 -e EXPORT, --export=EXPORT
38 Exported file system to mount [default: '/']
39
40 --nfsversion=NFSVERSION
41 NFS version, e.g., 3, 4, 4.1, etc. [default: 4.1]
42
43 -m MTPOINT, --mtpoint=MTPOINT
44 Mount point [default: '/mnt/t']
45
46 -p PORT, --port=PORT
47 NFS server port [default: 2049]
48
49 --proto=PROTO
50 NFS protocol name [default: 'tcp']
51
52 --sec=SEC
53 Security flavor [default: 'sys']
54
55 --nconnect=NCONNECT
56 Multiple TCP connections option [default: '1']
57
58 -o MTOPTS, --mtopts=MTOPTS
59 Mount options [default: 'hard,rsize=4096,wsize=4096']
60
61 --datadir=DATADIR
62 Data directory where files are created, directory is created on
63 the mount point [default: '']
64
65
66 Logging options:
67 -v VERBOSE, --verbose=VERBOSE
68 Verbose level for debug messages [default:
69 'opts|info|dbg1|dbg2|dbg3']
70
71 --tverbose=TVERBOSE
72 Verbose level for test messages [default: '1']
73
74 --createlog
75 Create log file
76
77 --rexeclog
78 Create rexec log files
79
80 --warnings
81 Display warnings
82
83 --tag=TAG
84 Informational tag, it is displayed as an INFO message [default:
85 '']
86
87 --notty
88 Do not use terminal colors on output
89
90 --isatty
91 Use terminal colors on output -- useful when running with nohup
92
93
94 Packet trace options:
95 --createtraces
96 Create a packet trace for each test
97
98 --tbsize=TBSIZE
99 Capture buffer size for tcpdump [default: 192k]
100
101 --trcdelay=TRCDELAY
102 Seconds to delay before stopping packet trace [default: 2.0]
103
104 --keeptraces
105 Do not remove any trace files [default: remove trace files if no
106 errors]
107
108 --rmtraces
109 Remove trace files [default: remove trace files if no errors]
110
111 -i INTERFACE, --interface=INTERFACE
112 Device interface [default: automatically selected]
113
114
115 File options:
116 --nfiles=NFILES
117 Number of files to create [default: 2]
118
119 --filesize=FILESIZE
120 File size to use for test files [default: 32]
121
122 --rsize=RSIZE
123 Read size to use when reading files [default: 4k]
124
125 --wsize=WSIZE
126 Write size to use when writing files [default: 4k]
127
128 --iodelay=IODELAY
129 Seconds to delay I/O operations [default: 0.1]
130
131 --offset-delta=OFFSET_DELTA
132 Read/Write offset delta [default: 4k]
133
134
135 Path options:
136 --sudo=SUDO
137 Full path of binary for sudo [default: '/usr/bin/sudo']
138
139 --kill=KILL
140 Full path of binary for kill [default: '/usr/bin/kill']
141
142 --nfsstat=NFSSTAT
143 Full path of binary for nfsstat [default: '/usr/sbin/nfsstat']
144
145 --tcpdump=TCPDUMP
146 Full path of binary for tcpdump [default: '/usr/sbin/tcpdump']
147
148 --iptables=IPTABLES
149 Full path of binary for iptables [default: '/usr/sbin/iptables']
150
151 --messages=MESSAGES
152 Full path of log messages file [default: '/var/log/messages']
153
154 --trcevents=TRCEVENTS
155 Full path of tracing events directory [default: '/sys/kernel/de‐
156 bug/tracing/events']
157
158 --trcpipe=TRCPIPE
159 Full path of trace pipe file [default: '/sys/kernel/debug/trac‐
160 ing/trace_pipe']
161
162 --tmpdir=TMPDIR
163 Temporary directory [default: '/tmp']
164
165
166 Debug options:
167 --nocleanup
168 Do not cleanup created files
169
170 --notimestamps
171 Do not display timestamps in debug messages
172
173 --bugmsgs=BUGMSGS
174 File containing test messages to mark as bugs if they failed
175
176 --nomount
177 Do not mount server and run the tests on local disk space
178
179 --basename=BASENAME
180 Base name for all files and logs [default: automatically gener‐
181 ated]
182
183 --nfsdebug=NFSDEBUG
184 Set NFS kernel debug flags and save log messages [default: '']
185
186 --rpcdebug=RPCDEBUG
187 Set RPC kernel debug flags and save log messages [default: '']
188
189 --tracepoints=TRACEPOINTS
190 List of trace points modules to enable [default: '']
191
192 --nfsstats
193 Get NFS stats [default: 'False']
194
195 --pktdisp
196 Display main packets related to the given test
197
198 --nfserrors
199 Fail every NFS error found in the packet trace
200
201 --client-ipaddr=CLIENT_IPADDR
202 IP address of localhost
203
204
205 Reporting options:
206 --xunit-report
207 Generate xUnit compatible test report
208
209 --xunit-report-file=XUNIT_REPORT_FILE
210 Path to xout report file
211
212
213 Test options:
214 --runtest=RUNTEST
215 Comma separated list of tests to run, if list starts with a '^'
216 then all tests are run except the ones listed [default: 'all']
217
218 --client=CLIENT
219 Remote NFS client
220
221 --justbefore=JUSTBEFORE
222 Time in seconds to test a condition just before it is expected
223 to come true [default: 2]
224
225 --acmin=ACMIN
226 Comma separated values to use for acregmin/acdirmin/actimeo [de‐
227 fault: 10]
228
229 --acmax=ACMAX
230 Comma separated values to use for acregmax/acdirmax, first value
231 of acmin will be used as acregmin/acdirmin [default: 20]
232
234 acregmin_attr
235 Verify consistency of attribute caching by varying the
236 acregmin NFS option.
237
238 The cached information is assumed to be valid for attrtimeo
239 which starts at acregmin.
240
241 acregmax_attr
242 Verify consistency of attribute caching by varying the
243 acregmax NFS option.
244
245 The cached information is assumed to be valid for attrtimeo which
246 starts at acregmin. An attribute revalidation to the server
247 that shows no attribute change doubles attrtimeo up to acregmax.
248 An attribute revalidation to the server that shows a change has
249 occurred resets it to acregmin.
250
251 acdirmin_attr
252 Verify consistency of attribute caching by varying the
253 acdirmin NFS option.
254
255 The cached information is assumed to be valid for attrtimeo
256 which starts at acdirmin. Test that this is so.
257
258 acdirmax_attr
259 Verify consistency of attribute caching by varying the
260 acdirmax NFS option.
261
262 The cached information is assumed to be valid for attrtimeo which
263 starts at acdirmin. An attribute revalidation to the server
264 that shows no attribute change doubles attrtimeo up to acdirmax.
265 An attribute revalidation to the server that shows a change has
266 occurred resets it to acdirmin.
267
268 actimeo_attr
269 Verify consistency of attribute caching by varying the
270 actimeo NFS option.
271
272 The cached information is assumed to be valid for attrtimeo
273 which starts and ends at actimeo.
274
275 acregmin_data
276 Verify consistency of data caching by varying the
277 acregmin NFS option.
278
279 acregmax_data
280 Verify consistency of data caching by varying the
281 acregmax NFS option.
282
283 The cached information is assumed to be valid for attrtimeo which
284 starts at acregmin. An attribute revalidation to the server
285 that shows no attribute change doubles attrtimeo up to acregmax.
286 An attribute revalidation to the server that shows a change has
287 occurred resets it to acregmin.
288
289 acdirmin_data
290 Verify consistency of data caching by varying the
291 acdirmin NFS option.
292
293 The cached information is assumed to be valid for attrtimeo
294 which starts at acdirmin. Test that this is so.
295
296 acdirmax_data
297 Verify consistency of data caching by varying the
298 acdirmax NFS option.
299
300 The cached information is assumed to be valid for attrtimeo which
301 starts at acdirmin. An attribute revalidation to the server
302 that shows no attribute change doubles attrtimeo up to acdirmax.
303 An attribute revalidation to the server that shows a change has
304 occurred resets it to acdirmin.
305
306 actimeo_data
307 Verify consistency of data caching by varying the
308 actimeo NFS option.
309
310 The cached information is assumed to be valid for attrtimeo
311 which starts and ends at actimeo.
312
313 all
314 Run all tests: acregmin_attr, acregmax_attr, acdirmin_attr,
315 acdirmax_attr, actimeo_attr, acregmin_data, acregmax_data,
316 acdirmin_data, acdirmax_data, actimeo_data
317
319 Required options are --server and --client
320 $ nfstest_cache --server 192.168.0.11 --client 192.168.0.20
321
322 Testing with different values of --acmin and --acmax (this takes a long
323 time)
324 $ nfstest_cache --server 192.168.0.11 --client 192.168.0.20 --acmin
325 10,20 --acmax 20,30,60,80
326
328 The user id in the local host and the host specified by --client must
329 have access to run commands as root using the 'sudo' command without
330 the need for a password.
331
332 The user id must be able to 'ssh' to remote host without the need for a
333 password.
334
336 nfstest.test_util(3), nfstest_alloc(1), nfstest_delegation(1), nf‐
337 stest_dio(1), nfstest_fcmp(1), nfstest_file(1), nfstest_interop(1), nf‐
338 stest_io(1), nfstest_lock(1), nfstest_pkt(1), nfstest_pnfs(1), nf‐
339 stest_posix(1), nfstest_rdma(1), nfstest_sparse(1), nfstest_ssc(1), nf‐
340 stest_xattr(1), nfstest_xid(1)
341
342
344 No known bugs.
345
347 Jorge Mora (mora@netapp.com)
348
349
350
351NFStest 3.2 21 March 2023 NFSTEST_CACHE(1)