t/zbd: Add write_and_run_one_fio_job() helper function
[fio.git] / t / zbd / test-zbd-support
1 #!/bin/bash
2 #
3 # Copyright (C) 2018 Western Digital Corporation or its affiliates.
4 #
5 # This file is released under the GPL.
6
7 usage() {
8     echo "Usage: $(basename "$0") [-d] [-e] [-l] [-r] [-v] [-t <test>] [-z] <SMR drive device node>"
9 }
10
11 max() {
12     if [ "$1" -gt "$2" ]; then
13         echo "$1"
14     else
15         echo "$2"
16     fi
17 }
18
19 min() {
20     if [ "$1" -lt "$2" ]; then
21         echo "$1"
22     else
23         echo "$2"
24     fi
25 }
26
27 ioengine() {
28         if [ -n "$use_libzbc" ]; then
29                 echo -n "--ioengine=libzbc"
30         else
31                 echo -n "--ioengine=$1"
32         fi
33 }
34
35 set_io_scheduler() {
36     local dev=$1 sched=$2
37
38     [ -e "/sys/block/$dev" ] || return $?
39     if [ -e "/sys/block/$dev/mq" ]; then
40         case "$sched" in
41             noop)        sched=none;;
42             deadline)    sched=mq-deadline;;
43         esac
44     else
45         case "$sched" in
46             none)        sched=noop;;
47             mq-deadline) sched=deadline;;
48         esac
49     fi
50
51     echo "$sched" >"/sys/block/$dev/queue/scheduler"
52 }
53
54 check_read() {
55     local read
56
57     read=$(fio_read <"${logfile}.${test_number}")
58     echo "read: $read <> $1" >> "${logfile}.${test_number}"
59     [ "$read" = "$1" ]
60 }
61
62 check_written() {
63     local written
64
65     written=$(fio_written <"${logfile}.${test_number}")
66     echo "written: $written <> $1" >> "${logfile}.${test_number}"
67     [ "$written" = "$1" ]
68 }
69
70 # Compare the reset count from the log file with reset count $2 using operator
71 # $1 (=, -ge, -gt, -le, -lt).
72 check_reset_count() {
73     local reset_count
74
75     reset_count=$(fio_reset_count <"${logfile}.${test_number}")
76     echo "reset_count: test $reset_count $1 $2" >> "${logfile}.${test_number}"
77     eval "[ '$reset_count' '$1' '$2' ]"
78 }
79
80 # Whether or not $1 (/dev/...) is a SCSI device.
81 is_scsi_device() {
82     local d f
83
84     d=$(basename "$dev")
85     for f in /sys/class/scsi_device/*/device/block/"$d"; do
86         [ -e "$f" ] && return 0
87     done
88     return 1
89 }
90
91 run_fio() {
92     local fio opts
93
94     fio=$(dirname "$0")/../../fio
95
96     opts=("--max-jobs=16" "--aux-path=/tmp" "--allow_file_create=0" \
97           "--significant_figures=10" "$@")
98     opts+=(${var_opts[@]})
99     { echo; echo "fio ${opts[*]}"; echo; } >>"${logfile}.${test_number}"
100
101     "${dynamic_analyzer[@]}" "$fio" "${opts[@]}"
102 }
103
104 run_one_fio_job() {
105     local r
106
107     r=$(((RANDOM << 16) | RANDOM))
108     run_fio --name="$dev" --filename="$dev" "$@" --randseed="$r"        \
109             --thread=1 --direct=1
110 }
111
112 write_and_run_one_fio_job() {
113     local r
114     local write_offset="${1}"
115     local write_size="${2}"
116
117     shift 2
118     r=$(((RANDOM << 16) | RANDOM))
119     run_fio --filename="$dev" --randseed="$r"  --name="write_job" --rw=write \
120             "$(ioengine "psync")" --bs="${logical_block_size}" \
121             --zonemode=zbd --zonesize="${zone_size}" --thread=1 --direct=1 \
122             --offset="${write_offset}" --size="${write_size}" \
123             --name="$dev" --wait_for="write_job" "$@" --thread=1 --direct=1
124 }
125
126 # Run fio on the first four sequential zones of the disk.
127 run_fio_on_seq() {
128     local opts=()
129
130     opts+=("--offset=$((first_sequential_zone_sector * 512))")
131     opts+=("--size=$((4 * zone_size))" "--zonemode=zbd")
132     if [ -z "$is_zbd" ]; then
133         opts+=("--zonesize=${zone_size}")
134     fi
135     run_one_fio_job "${opts[@]}" "$@"
136 }
137
138 # Check whether buffered writes are refused.
139 test1() {
140     run_fio --name=job1 --filename="$dev" --rw=write --direct=0 --bs=4K \
141             "$(ioengine "psync")" --size="${zone_size}" --thread=1      \
142             --zonemode=zbd --zonesize="${zone_size}" 2>&1 |
143         tee -a "${logfile}.${test_number}" |
144         grep -q 'Using direct I/O is mandatory for writing to ZBD drives'
145     local fio_rc=${PIPESTATUS[0]} grep_rc=${PIPESTATUS[2]}
146     case "$fio_rc" in
147         0|1) ;;
148         *)   return "$fio_rc"
149     esac
150     if [ -n "$is_zbd" ]; then
151         [ "$grep_rc" = 0 ]
152     else
153         [ "$grep_rc" != 0 ]
154     fi
155 }
156
157 # Block size exceeds zone size.
158 test2() {
159     local bs off opts=() rc
160
161     off=$(((first_sequential_zone_sector + 2 * sectors_per_zone) * 512))
162     bs=$((2 * zone_size))
163     opts+=("$(ioengine "psync")")
164     opts+=("--name=job1" "--filename=$dev" "--rw=write" "--direct=1")
165     opts+=("--zonemode=zbd" "--offset=$off" "--bs=$bs" "--size=$bs")
166     if [ -z "$is_zbd" ]; then
167         opts+=("--zonesize=${zone_size}")
168     fi
169     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
170     ! grep -q 'WRITE:' "${logfile}.${test_number}"
171 }
172
173 # Run fio against an empty zone. This causes fio to report "No I/O performed".
174 test3() {
175     local off opts=() rc
176
177     off=$((first_sequential_zone_sector * 512 + 128 * zone_size))
178     size=$((zone_size))
179     [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
180     opts+=("--name=$dev" "--filename=$dev" "--offset=$off" "--bs=4K")
181     opts+=("--size=$size" "--zonemode=zbd")
182     opts+=("$(ioengine "psync")" "--rw=read" "--direct=1" "--thread=1")
183     if [ -z "$is_zbd" ]; then
184         opts+=("--zonesize=${zone_size}")
185     fi
186     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
187     ! grep -q 'READ:' "${logfile}.${test_number}"
188 }
189
190 # Run fio with --read_beyond_wp=1 against an empty zone.
191 test4() {
192     local off opts=()
193
194     off=$((first_sequential_zone_sector * 512 + 129 * zone_size))
195     size=$((zone_size))
196     [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
197     opts+=("--name=$dev" "--filename=$dev" "--offset=$off" "--bs=$size")
198     opts+=("--size=$size" "--thread=1" "--read_beyond_wp=1")
199     opts+=("$(ioengine "psync")" "--rw=read" "--direct=1" "--disable_lat=1")
200     opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
201     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
202     check_read $size || return $?
203 }
204
205 # Sequential write to sequential zones.
206 test5() {
207     local size
208
209     size=$((4 * zone_size))
210     run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=write \
211                    --bs="$(max $((zone_size / 64)) "$logical_block_size")"\
212                    --do_verify=1 --verify=md5                           \
213                    >>"${logfile}.${test_number}" 2>&1 || return $?
214     check_written $size || return $?
215     check_read $size || return $?
216 }
217
218 # Sequential read from sequential zones. Must be run after test5.
219 test6() {
220     local size
221
222     size=$((4 * zone_size))
223     run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=read  \
224                    --bs="$(max $((zone_size / 64)) "$logical_block_size")"\
225                    >>"${logfile}.${test_number}" 2>&1 || return $?
226     check_read $size || return $?
227 }
228
229 # Random write to sequential zones, libaio, queue depth 1.
230 test7() {
231     local size=$((zone_size))
232
233     run_fio_on_seq "$(ioengine "libaio")" --iodepth=1 --rw=randwrite    \
234                    --bs="$(min 16384 "${zone_size}")"                   \
235                    --do_verify=1 --verify=md5 --size="$size"            \
236                    >>"${logfile}.${test_number}" 2>&1 || return $?
237     check_written $size || return $?
238     check_read $size || return $?
239 }
240
241 # Random write to sequential zones, libaio, queue depth 64.
242 test8() {
243     local size
244
245     size=$((4 * zone_size))
246     run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite   \
247                    --bs="$(min 16384 "${zone_size}")"                   \
248                    --do_verify=1 --verify=md5                           \
249                    >>"${logfile}.${test_number}" 2>&1 || return $?
250     check_written $size || return $?
251     check_read $size || return $?
252 }
253
254 # Random write to sequential zones, sg, queue depth 1.
255 test9() {
256     local size
257
258     if ! is_scsi_device "$dev"; then
259         echo "$dev is not a SCSI device" >>"${logfile}.${test_number}"
260         return 0
261     fi
262
263     size=$((4 * zone_size))
264     run_fio_on_seq --ioengine=sg                                        \
265                    --iodepth=1 --rw=randwrite --bs=16K                  \
266                    --do_verify=1 --verify=md5                           \
267                    >>"${logfile}.${test_number}" 2>&1 || return $?
268     check_written $size || return $?
269     check_read $size || return $?
270 }
271
272 # Random write to sequential zones, sg, queue depth 64.
273 test10() {
274     local size
275
276     if ! is_scsi_device "$dev"; then
277         echo "$dev is not a SCSI device" >>"${logfile}.${test_number}"
278         return 0
279     fi
280
281     size=$((4 * zone_size))
282     run_fio_on_seq --ioengine=sg                                        \
283                    --iodepth=64 --rw=randwrite --bs=16K                 \
284                    --do_verify=1 --verify=md5                           \
285                    >>"${logfile}.${test_number}" 2>&1 || return $?
286     check_written $size || return $?
287     check_read $size || return $?
288 }
289
290 # Random write to sequential zones, libaio, queue depth 64, random block size.
291 test11() {
292     local size
293
294     size=$((4 * zone_size))
295     run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite   \
296                    --bsrange=4K-64K --do_verify=1 --verify=md5          \
297                    --debug=zbd >>"${logfile}.${test_number}" 2>&1 || return $?
298     check_written $size || return $?
299     check_read $size || return $?
300 }
301
302 # Random write to sequential zones, libaio, queue depth 64, max 1 open zone.
303 test12() {
304     local size
305
306     size=$((8 * zone_size))
307     run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=16K \
308                    --max_open_zones=1 --size=$size --do_verify=1 --verify=md5 \
309                    --debug=zbd >>"${logfile}.${test_number}" 2>&1 || return $?
310     check_written $size || return $?
311     check_read $size || return $?
312 }
313
314 # Random write to sequential zones, libaio, queue depth 64, max 4 open zones.
315 test13() {
316     local size
317
318     size=$((8 * zone_size))
319     run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=16K \
320                    --max_open_zones=4 --size=$size --do_verify=1 --verify=md5 \
321                    --debug=zbd                                                \
322                    >>"${logfile}.${test_number}" 2>&1 || return $?
323     check_written $size || return $?
324     check_read $size || return $?
325 }
326
327 # Random write to conventional zones.
328 test14() {
329     local size
330
331     size=$((16 * 2**20)) # 20 MB
332     if [ $size -gt $((first_sequential_zone_sector * 512)) ]; then
333         echo "$dev does not have enough sequential zones" \
334              >>"${logfile}.${test_number}"
335         return 0
336     fi
337     run_one_fio_job "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=16K \
338                     --zonemode=zbd --zonesize="${zone_size}" --do_verify=1 \
339                     --verify=md5 --size=$size                              \
340                     >>"${logfile}.${test_number}" 2>&1 || return $?
341     check_written $((size)) || return $?
342     check_read $((size)) || return $?
343 }
344
345 # Sequential read on a mix of empty and full zones.
346 test15() {
347     local i off size
348
349     for ((i=0;i<4;i++)); do
350         [ -n "$is_zbd" ] &&
351             reset_zone "$dev" $((first_sequential_zone_sector +
352                                  i*sectors_per_zone))
353     done
354     off=$(((first_sequential_zone_sector + 2 * sectors_per_zone) * 512))
355     size=$((2 * zone_size))
356     run_one_fio_job "$(ioengine "psync")" --rw=write --bs=$((zone_size / 16))\
357                     --zonemode=zbd --zonesize="${zone_size}" --offset=$off \
358                     --size=$size >>"${logfile}.${test_number}" 2>&1 ||
359         return $?
360     check_written $size || return $?
361     off=$((first_sequential_zone_sector * 512))
362     size=$((4 * zone_size))
363     run_one_fio_job "$(ioengine "psync")" --rw=read --bs=$((zone_size / 16)) \
364                     --zonemode=zbd --zonesize="${zone_size}" --offset=$off \
365                     --size=$((size)) >>"${logfile}.${test_number}" 2>&1 ||
366         return $?
367     if [ -n "$is_zbd" ]; then
368         check_read $((size / 2))
369     else
370         check_read $size
371     fi
372 }
373
374 # Random read on a mix of empty and full zones. Must be run after test15.
375 test16() {
376     local off size
377
378     off=$((first_sequential_zone_sector * 512))
379     size=$((4 * zone_size))
380     run_one_fio_job "$(ioengine "libaio")" --iodepth=64 --rw=randread --bs=16K \
381                     --zonemode=zbd --zonesize="${zone_size}" --offset=$off \
382                     --size=$size >>"${logfile}.${test_number}" 2>&1 || return $?
383     check_read $size || return $?
384 }
385
386 # Random reads and writes in the last zone.
387 test17() {
388     local io off read size written
389
390     off=$(((disk_size / zone_size - 1) * zone_size))
391     size=$((disk_size - off))
392     # Overwrite the last zone to avoid that reading from that zone fails.
393     if [ -n "$is_zbd" ]; then
394         reset_zone "$dev" $((off / 512)) || return $?
395     fi
396     run_one_fio_job "$(ioengine "psync")" --rw=write --offset="$off"    \
397                     --zonemode=zbd --zonesize="${zone_size}"            \
398                     --bs="$zone_size" --size="$zone_size"               \
399                     >>"${logfile}.${test_number}" 2>&1 || return $?
400     check_written "$zone_size" || return $?
401     run_one_fio_job "$(ioengine "libaio")" --iodepth=8 --rw=randrw --bs=4K \
402                     --zonemode=zbd --zonesize="${zone_size}"            \
403                     --offset=$off --loops=2 --norandommap=1\
404                     >>"${logfile}.${test_number}" 2>&1 || return $?
405     written=$(fio_written <"${logfile}.${test_number}")
406     read=$(fio_read <"${logfile}.${test_number}")
407     io=$((written + read))
408     echo "Total number of bytes read and written: $io <> $size" \
409          >>"${logfile}.${test_number}"
410     [ $io = $((size * 2)) ];
411 }
412
413 # Out-of-range zone reset threshold and frequency parameters.
414 test18() {
415     run_fio_on_seq --zone_reset_threshold=-1 |&
416         tee -a "${logfile}.${test_number}"   |
417             grep -q 'value out of range' || return $?
418 }
419
420 test19() {
421     run_fio_on_seq --zone_reset_threshold=2  |&
422         tee -a "${logfile}.${test_number}"   |
423         grep -q 'value out of range' || return $?
424 }
425
426 test20() {
427     run_fio_on_seq --zone_reset_threshold=.4:.6 |&
428         tee -a "${logfile}.${test_number}"   |
429         grep -q 'the list exceeding max length' || return $?
430 }
431
432 test21() {
433     run_fio_on_seq --zone_reset_frequency=-1 |&
434         tee -a "${logfile}.${test_number}"   |
435         grep -q 'value out of range' || return $?
436 }
437
438 test22() {
439     run_fio_on_seq --zone_reset_frequency=2  |&
440         tee -a "${logfile}.${test_number}"   |
441         grep -q 'value out of range' || return $?
442 }
443
444 test23() {
445     run_fio_on_seq --zone_reset_frequency=.4:.6  |&
446         tee -a "${logfile}.${test_number}"   |
447         grep -q 'the list exceeding max length' || return $?
448 }
449
450 test24() {
451     local bs loops=9 size=$((zone_size))
452
453     bs=$(min $((256*1024)) "$zone_size")
454     run_fio_on_seq "$(ioengine "psync")" --rw=write --bs="$bs"          \
455                    --size=$size --loops=$loops                          \
456                    --zone_reset_frequency=.01 --zone_reset_threshold=.90 \
457                    >> "${logfile}.${test_number}" 2>&1 || return $?
458     check_written $((size * loops)) || return $?
459     check_reset_count -eq 8 ||
460         check_reset_count -eq 9 ||
461         check_reset_count -eq 10 || return $?
462 }
463
464 # Multiple non-overlapping sequential write jobs for the same drive.
465 test25() {
466     local i opts=()
467
468     for ((i=0;i<16;i++)); do
469         [ -n "$is_zbd" ] &&
470             reset_zone "$dev" $((first_sequential_zone_sector + i*sectors_per_zone))
471     done
472     for ((i=0;i<16;i++)); do
473         opts+=("--name=job$i" "--filename=$dev" "--thread=1" "--direct=1")
474         opts+=("--offset=$((first_sequential_zone_sector*512 + zone_size*i))")
475         opts+=("--size=$zone_size" "$(ioengine "psync")" "--rw=write" "--bs=16K")
476         opts+=("--zonemode=zbd" "--zonesize=${zone_size}" "--group_reporting=1")
477         opts+=(${var_opts[@]})
478     done
479     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
480 }
481
482 write_to_first_seq_zone() {
483     local loops=4 r
484
485     r=$(((RANDOM << 16) | RANDOM))
486     run_fio --name="$dev" --filename="$dev" "$(ioengine "psync")" --rw="$1" \
487             --thread=1 --do_verify=1 --verify=md5 --direct=1 --bs=4K    \
488             --offset=$((first_sequential_zone_sector * 512))            \
489             "--size=$zone_size" --loops=$loops --randseed="$r"          \
490             --zonemode=zbd --zonesize="${zone_size}" --group_reporting=1        \
491             --gtod_reduce=1 >> "${logfile}.${test_number}" 2>&1 || return $?
492     check_written $((loops * zone_size)) || return $?
493 }
494
495 # Overwrite the first sequential zone four times sequentially.
496 test26() {
497     write_to_first_seq_zone write
498 }
499
500 # Overwrite the first sequential zone four times using random writes.
501 test27() {
502     write_to_first_seq_zone randwrite
503 }
504
505 # Multiple overlapping random write jobs for the same drive.
506 test28() {
507     local i jobs=16 off opts
508
509     off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
510     [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
511     opts=("--debug=zbd")
512     for ((i=0;i<jobs;i++)); do
513         opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
514         opts+=("--size=$zone_size" "$(ioengine "psync")" "--rw=randwrite")
515         opts+=("--thread=1" "--direct=1" "--zonemode=zbd")
516         opts+=("--zonesize=${zone_size}" "--group_reporting=1")
517         opts+=(${var_opts[@]})
518     done
519     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
520     check_written $((jobs * zone_size)) || return $?
521     check_reset_count -eq $jobs ||
522         check_reset_count -eq $((jobs - 1)) ||
523         return $?
524 }
525
526 # Multiple overlapping random write jobs for the same drive and with a limited
527 # number of open zones.
528 test29() {
529     local i jobs=16 off opts=()
530
531     off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
532     size=$((16*zone_size))
533     [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
534     opts=("--debug=zbd")
535     for ((i=0;i<jobs;i++)); do
536         opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
537         opts+=("--size=$size" "--io_size=$zone_size" "--thread=1")
538         opts+=("$(ioengine "psync")" "--rw=randwrite" "--direct=1")
539         opts+=("--max_open_zones=4" "--group_reporting=1")
540         opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
541         opts+=(${var_opts[@]})
542     done
543     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
544     check_written $((jobs * zone_size)) || return $?
545 }
546
547 # Random reads and writes across the entire disk for 30s.
548 test30() {
549     local off
550
551     off=$((first_sequential_zone_sector * 512))
552     run_one_fio_job "$(ioengine "libaio")" --iodepth=8 --rw=randrw      \
553                     --bs="$(max $((zone_size / 128)) "$logical_block_size")"\
554                     --zonemode=zbd --zonesize="${zone_size}" --offset=$off\
555                     --loops=2 --time_based --runtime=30s --norandommap=1\
556                     >>"${logfile}.${test_number}" 2>&1
557 }
558
559 # Random reads across all sequential zones for 30s. This is not only a fio
560 # test but also allows to verify the performance of a drive.
561 test31() {
562     local bs inc nz off opts size
563
564     # Start with writing 128 KB to 128 sequential zones.
565     bs=128K
566     nz=128
567     # shellcheck disable=SC2017
568     inc=$(((disk_size - (first_sequential_zone_sector * 512)) / (nz * zone_size)
569            * zone_size))
570     opts=()
571     for ((off = first_sequential_zone_sector * 512; off < disk_size;
572           off += inc)); do
573         opts+=("--name=$dev" "--filename=$dev" "--offset=$off" "--io_size=$bs")
574         opts+=("--bs=$bs" "--size=$zone_size" "$(ioengine "libaio")")
575         opts+=("--rw=write" "--direct=1" "--thread=1" "--stats=0")
576         opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
577         opts+=(${var_opts[@]})
578     done
579     "$(dirname "$0")/../../fio" "${opts[@]}" >> "${logfile}.${test_number}" 2>&1
580     # Next, run the test.
581     off=$((first_sequential_zone_sector * 512))
582     size=$((disk_size - off))
583     opts=("--name=$dev" "--filename=$dev" "--offset=$off" "--size=$size")
584     opts+=("--bs=$bs" "$(ioengine "psync")" "--rw=randread" "--direct=1")
585     opts+=("--thread=1" "--time_based" "--runtime=30" "--zonemode=zbd")
586     opts+=("--zonesize=${zone_size}")
587     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
588 }
589
590 # Random writes across all sequential zones. This is not only a fio test but
591 # also allows to verify the performance of a drive.
592 test32() {
593     local off opts=() size
594
595     off=$((first_sequential_zone_sector * 512))
596     size=$((disk_size - off))
597     opts+=("--name=$dev" "--filename=$dev" "--offset=$off" "--size=$size")
598     opts+=("--bs=128K" "$(ioengine "psync")" "--rw=randwrite" "--direct=1")
599     opts+=("--thread=1" "--time_based" "--runtime=30")
600     opts+=("--max_open_zones=$max_open_zones" "--zonemode=zbd")
601     opts+=("--zonesize=${zone_size}")
602     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
603 }
604
605 # Write to sequential zones with a block size that is not a divisor of the
606 # zone size.
607 test33() {
608     local bs io_size size
609
610     size=$((2 * zone_size))
611     io_size=$((5 * zone_size))
612     bs=$((3 * zone_size / 4))
613     run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=write \
614                    --size=$size --io_size=$io_size --bs=$bs     \
615                    >> "${logfile}.${test_number}" 2>&1 || return $?
616     check_written $(((io_size + bs - 1) / bs * bs)) || return $?
617 }
618
619 # Write to sequential zones with a block size that is not a divisor of the
620 # zone size and with data verification enabled.
621 test34() {
622     local size
623
624     size=$((2 * zone_size))
625     run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=write --size=$size \
626                    --do_verify=1 --verify=md5 --bs=$((3 * zone_size / 4)) \
627                    >> "${logfile}.${test_number}" 2>&1 && return 1
628     grep -q 'not a divisor of' "${logfile}.${test_number}"
629 }
630
631 # Test 1/4 for the I/O boundary rounding code: $size < $zone_size.
632 test35() {
633     local bs off io_size size
634
635     off=$(((first_sequential_zone_sector + 1) * 512))
636     size=$((zone_size - 2 * 512))
637     bs=$((zone_size / 4))
638     run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")"    \
639                     --iodepth=1 --rw=write --do_verify=1 --verify=md5   \
640                     --bs=$bs --zonemode=zbd --zonesize="${zone_size}"   \
641                     >> "${logfile}.${test_number}" 2>&1 && return 1
642     grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
643 }
644
645 # Test 2/4 for the I/O boundary rounding code: $size < $zone_size.
646 test36() {
647     local bs off io_size size
648
649     off=$(((first_sequential_zone_sector) * 512))
650     size=$((zone_size - 512))
651     bs=$((zone_size / 4))
652     run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")"    \
653                     --iodepth=1 --rw=write --do_verify=1 --verify=md5   \
654                     --bs=$bs --zonemode=zbd --zonesize="${zone_size}"   \
655                     >> "${logfile}.${test_number}" 2>&1 && return 1
656     grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
657 }
658
659 # Test 3/4 for the I/O boundary rounding code: $size > $zone_size.
660 test37() {
661     local bs off size
662
663     if [ "$first_sequential_zone_sector" = 0 ]; then
664         off=0
665     else
666         off=$(((first_sequential_zone_sector - 1) * 512))
667     fi
668     size=$((zone_size + 2 * 512))
669     bs=$((zone_size / 4))
670     run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")"    \
671                     --iodepth=1 --rw=write --do_verify=1 --verify=md5   \
672                     --bs=$bs --zonemode=zbd --zonesize="${zone_size}"   \
673                     >> "${logfile}.${test_number}" 2>&1
674     check_written $((zone_size)) || return $?
675 }
676
677 # Test 4/4 for the I/O boundary rounding code: $offset > $disk_size - $zone_size
678 test38() {
679     local bs off size
680
681     size=$((logical_block_size))
682     off=$((disk_size - logical_block_size))
683     bs=$((logical_block_size))
684     run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")"    \
685                     --iodepth=1 --rw=write --do_verify=1 --verify=md5   \
686                     --bs=$bs --zonemode=zbd --zonesize="${zone_size}"   \
687                     >> "${logfile}.${test_number}" 2>&1 && return 1
688     grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
689 }
690
691 # Read one block from a block device.
692 read_one_block() {
693     local bs
694
695     bs=$((logical_block_size))
696     run_one_fio_job --rw=read "$(ioengine "psync")" --bs=$bs --size=$bs "$@" 2>&1 |
697         tee -a "${logfile}.${test_number}"
698 }
699
700 # Check whether fio accepts --zonemode=none for zoned block devices.
701 test39() {
702     [ -n "$is_zbd" ] || return 0
703     read_one_block --zonemode=none >/dev/null || return $?
704     check_read $((logical_block_size)) || return $?
705 }
706
707 # Check whether fio accepts --zonemode=strided for zoned block devices.
708 test40() {
709     local bs
710
711     bs=$((logical_block_size))
712     [ -n "$is_zbd" ] || return 0
713     read_one_block --zonemode=strided |
714         grep -q 'fio: --zonesize must be specified when using --zonemode=strided' ||
715         return $?
716     read_one_block --zonemode=strided --zonesize=$bs >/dev/null || return $?
717     check_read $bs || return $?
718 }
719
720 # Check whether fio checks the zone size for zoned block devices.
721 test41() {
722     [ -n "$is_zbd" ] || return 0
723     read_one_block --zonemode=zbd --zonesize=$((2 * zone_size)) |
724         grep -q 'job parameter zonesize.*does not match disk zone size'
725 }
726
727 # Check whether fio handles --zonesize=0 correctly for regular block devices.
728 test42() {
729     [ -n "$is_zbd" ] && return 0
730     read_one_block --zonemode=zbd --zonesize=0 |
731         grep -q 'Specifying the zone size is mandatory for regular block devices with --zonemode=zbd'
732 }
733
734 # Check whether fio handles --zonesize=1 correctly for regular block devices.
735 test43() {
736     [ -n "$is_zbd" ] && return 0
737     read_one_block --zonemode=zbd --zonesize=1 |
738         grep -q 'zone size must be at least 512 bytes for --zonemode=zbd'
739 }
740
741 # Check whether fio handles --zonemode=none --zonesize=1 correctly.
742 test44() {
743     read_one_block --zonemode=none --zonesize=1 |
744         grep -q 'fio: --zonemode=none and --zonesize are not compatible'
745 }
746
747 test45() {
748     local bs i
749
750     [ -z "$is_zbd" ] && return 0
751     bs=$((logical_block_size))
752     run_one_fio_job "$(ioengine "psync")" --iodepth=1 --rw=randwrite --bs=$bs\
753                     --offset=$((first_sequential_zone_sector * 512)) \
754                     --size="$zone_size" --do_verify=1 --verify=md5 2>&1 |
755         tee -a "${logfile}.${test_number}" |
756         grep -q "fio: first I/O failed. If .* is a zoned block device, consider --zonemode=zbd"
757 }
758
759 # Random write to sequential zones, libaio, 8 jobs, queue depth 64 per job
760 test46() {
761     local size
762
763     size=$((4 * zone_size))
764     run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=4K \
765                    --group_reporting=1 --numjobs=8 \
766                    >> "${logfile}.${test_number}" 2>&1 || return $?
767     check_written $((size * 8)) || return $?
768 }
769
770 # Check whether fio handles --zonemode=zbd --zoneskip=1 correctly.
771 test47() {
772     local bs
773
774     [ -z "$is_zbd" ] && return 0
775     bs=$((logical_block_size))
776     run_one_fio_job "$(ioengine "psync")" --rw=write --bs=$bs \
777                     --zonemode=zbd --zoneskip=1          \
778                     >> "${logfile}.${test_number}" 2>&1 && return 1
779     grep -q 'zoneskip 1 is not a multiple of the device zone size' "${logfile}.${test_number}"
780 }
781
782 # Multiple overlapping random write jobs for the same drive and with a
783 # limited number of open zones. This is similar to test29, but uses libaio
784 # to stress test zone locking.
785 test48() {
786     local i jobs=16 off opts=()
787
788     off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
789     size=$((16*zone_size))
790     [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
791     opts=("--aux-path=/tmp" "--allow_file_create=0" "--significant_figures=10")
792     opts+=("--debug=zbd")
793     opts+=("$(ioengine "libaio")" "--rw=randwrite" "--direct=1")
794     opts+=("--time_based" "--runtime=30")
795     opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
796     opts+=("--max_open_zones=4")
797     for ((i=0;i<jobs;i++)); do
798         opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
799         opts+=("--io_size=$zone_size" "--iodepth=256" "--thread=1")
800         opts+=("--group_reporting=1")
801     done
802
803     fio=$(dirname "$0")/../../fio
804
805     { echo; echo "fio ${opts[*]}"; echo; } >>"${logfile}.${test_number}"
806
807     timeout -v -s KILL 45s \
808             "${dynamic_analyzer[@]}" "$fio" "${opts[@]}" \
809             >> "${logfile}.${test_number}" 2>&1 || return $?
810 }
811
812 tests=()
813 dynamic_analyzer=()
814 reset_all_zones=
815 use_libzbc=
816 zbd_debug=
817
818 while [ "${1#-}" != "$1" ]; do
819   case "$1" in
820     -d) dynamic_analyzer=(valgrind "--read-var-info=yes" "--tool=drd"
821                           "--show-confl-seg=no");
822         shift;;
823     -e) dynamic_analyzer=(valgrind "--read-var-info=yes" "--tool=helgrind");
824         shift;;
825     -l) use_libzbc=1; shift;;
826     -r) reset_all_zones=1; shift;;
827     -t) tests+=("$2"); shift; shift;;
828     -v) dynamic_analyzer=(valgrind "--read-var-info=yes");
829         shift;;
830     -z) zbd_debug=1; shift;;
831     --) shift; break;;
832   esac
833 done
834
835 if [ $# != 1 ]; then
836     usage
837     exit 1
838 fi
839
840 # shellcheck source=functions
841 source "$(dirname "$0")/functions" || exit $?
842
843 var_opts=()
844 if [ -n "$zbd_debug" ]; then
845     var_opts+=("--debug=zbd")
846 fi
847 dev=$1
848 realdev=$(readlink -f "$dev")
849 basename=$(basename "$realdev")
850
851 if [[ -b "$realdev" ]]; then
852         major=$((0x$(stat -L -c '%t' "$realdev"))) || exit $?
853         minor=$((0x$(stat -L -c '%T' "$realdev"))) || exit $?
854         disk_size=$(($(<"/sys/dev/block/$major:$minor/size")*512))
855
856         # When the target is a partition device, get basename of its
857         # holder device to access sysfs path of the holder device
858         if [[ -r "/sys/dev/block/$major:$minor/partition" ]]; then
859                 realsysfs=$(readlink "/sys/dev/block/$major:$minor")
860                 basename=$(basename "${realsysfs%/*}")
861         fi
862         logical_block_size=$(<"/sys/block/$basename/queue/logical_block_size")
863         case "$(<"/sys/class/block/$basename/queue/zoned")" in
864         host-managed|host-aware)
865                 is_zbd=true
866                 if ! result=($(first_sequential_zone "$dev")); then
867                         echo "Failed to determine first sequential zone"
868                         exit 1
869                 fi
870                 first_sequential_zone_sector=${result[0]}
871                 sectors_per_zone=${result[1]}
872                 zone_size=$((sectors_per_zone * 512))
873                 if ! max_open_zones=$(max_open_zones "$dev"); then
874                         echo "Failed to determine maximum number of open zones"
875                         exit 1
876                 fi
877                 set_io_scheduler "$basename" deadline || exit $?
878                 if [ -n "$reset_all_zones" ]; then
879                         reset_zone "$dev" -1
880                 fi
881                 ;;
882         *)
883                 first_sequential_zone_sector=$(((disk_size / 2) &
884                                                 (logical_block_size - 1)))
885                 zone_size=$(max 65536 "$logical_block_size")
886                 sectors_per_zone=$((zone_size / 512))
887                 max_open_zones=128
888                 set_io_scheduler "$basename" none || exit $?
889                 ;;
890         esac
891 elif [[ -c "$realdev" ]]; then
892         # For an SG node, we must have libzbc option specified
893         if [[ ! -n "$use_libzbc" ]]; then
894                 echo "Character device files can only be used with -l (libzbc) option"
895                 exit 1
896         fi
897
898         if ! $(is_zbc "$dev"); then
899                 echo "Device is not a ZBC disk"
900                 exit 1
901         fi
902         is_zbd=true
903
904         if ! disk_size=($(( $(zbc_disk_sectors "$dev") * 512))); then
905                 echo "Failed to determine disk size"
906                 exit 1
907         fi
908         if ! logical_block_size=($(zbc_logical_block_size "$dev")); then
909                 echo "Failed to determine logical block size"
910                 exit 1
911         fi
912         if ! result=($(first_sequential_zone "$dev")); then
913                 echo "Failed to determine first sequential zone"
914                 exit 1
915         fi
916         first_sequential_zone_sector=${result[0]}
917         sectors_per_zone=${result[1]}
918         zone_size=$((sectors_per_zone * 512))
919         if ! max_open_zones=$(max_open_zones "$dev"); then
920                 echo "Failed to determine maximum number of open zones"
921                 exit 1
922         fi
923         if [ -n "$reset_all_zones" ]; then
924                 reset_zone "$dev" -1
925         fi
926 fi
927
928 echo -n "First sequential zone starts at sector $first_sequential_zone_sector;"
929 echo " zone size: $((zone_size >> 20)) MB"
930
931 if [ "${#tests[@]}" = 0 ]; then
932     readarray -t tests < <(declare -F | grep "test[0-9]*" | \
933                                    tr -c -d "[:digit:]\n" | sort -n)
934 fi
935
936 logfile=$0.log
937
938 passed=0
939 failed=0
940 if [ -t 1 ]; then
941     red="\e[1;31m"
942     green="\e[1;32m"
943     end="\e[m"
944 else
945     red=""
946     green=""
947     end=""
948 fi
949 rc=0
950
951 intr=0
952 trap 'intr=1' SIGINT
953
954 for test_number in "${tests[@]}"; do
955     rm -f "${logfile}.${test_number}"
956     echo -n "Running test $(printf "%02d" $test_number) ... "
957     if eval "test$test_number"; then
958         status="PASS"
959         cc_status="${green}${status}${end}"
960         ((passed++))
961     else
962         status="FAIL"
963         cc_status="${red}${status}${end}"
964         ((failed++))
965         rc=1
966     fi
967     echo -e "$cc_status"
968     echo "$status" >> "${logfile}.${test_number}"
969     [ $intr -ne 0 ] && exit 1
970 done
971
972 echo "$passed tests passed"
973 if [ $failed -gt 0 ]; then
974     echo " and $failed tests failed"
975 fi
976 exit $rc