Merge branch 'patch-1' of https://github.com/avlasov-mos-de/fio
[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.
219 test6() {
220     local size
221
222     size=$((4 * zone_size))
223     write_and_run_one_fio_job \
224             $((first_sequential_zone_sector * 512)) "${size}" \
225             --offset=$((first_sequential_zone_sector * 512)) \
226             --size="${size}" --zonemode=zbd --zonesize="${zone_size}" \
227             "$(ioengine "psync")" --iodepth=1 --rw=read \
228             --bs="$(max $((zone_size / 64)) "$logical_block_size")" \
229             >>"${logfile}.${test_number}" 2>&1 || return $?
230     check_read $size || return $?
231 }
232
233 # Random write to sequential zones, libaio, queue depth 1.
234 test7() {
235     local size=$((zone_size))
236
237     run_fio_on_seq "$(ioengine "libaio")" --iodepth=1 --rw=randwrite    \
238                    --bs="$(min 16384 "${zone_size}")"                   \
239                    --do_verify=1 --verify=md5 --size="$size"            \
240                    >>"${logfile}.${test_number}" 2>&1 || return $?
241     check_written $size || return $?
242     check_read $size || return $?
243 }
244
245 # Random write to sequential zones, libaio, queue depth 64.
246 test8() {
247     local size
248
249     size=$((4 * zone_size))
250     run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite   \
251                    --bs="$(min 16384 "${zone_size}")"                   \
252                    --do_verify=1 --verify=md5                           \
253                    >>"${logfile}.${test_number}" 2>&1 || return $?
254     check_written $size || return $?
255     check_read $size || return $?
256 }
257
258 # Random write to sequential zones, sg, queue depth 1.
259 test9() {
260     local size
261
262     if ! is_scsi_device "$dev"; then
263         echo "$dev is not a SCSI device" >>"${logfile}.${test_number}"
264         return 0
265     fi
266
267     size=$((4 * zone_size))
268     run_fio_on_seq --ioengine=sg                                        \
269                    --iodepth=1 --rw=randwrite --bs=16K                  \
270                    --do_verify=1 --verify=md5                           \
271                    >>"${logfile}.${test_number}" 2>&1 || return $?
272     check_written $size || return $?
273     check_read $size || return $?
274 }
275
276 # Random write to sequential zones, sg, queue depth 64.
277 test10() {
278     local size
279
280     if ! is_scsi_device "$dev"; then
281         echo "$dev is not a SCSI device" >>"${logfile}.${test_number}"
282         return 0
283     fi
284
285     size=$((4 * zone_size))
286     run_fio_on_seq --ioengine=sg                                        \
287                    --iodepth=64 --rw=randwrite --bs=16K                 \
288                    --do_verify=1 --verify=md5                           \
289                    >>"${logfile}.${test_number}" 2>&1 || return $?
290     check_written $size || return $?
291     check_read $size || return $?
292 }
293
294 # Random write to sequential zones, libaio, queue depth 64, random block size.
295 test11() {
296     local size
297
298     size=$((4 * zone_size))
299     run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite   \
300                    --bsrange=4K-64K --do_verify=1 --verify=md5          \
301                    --debug=zbd >>"${logfile}.${test_number}" 2>&1 || return $?
302     check_written $size || return $?
303     check_read $size || return $?
304 }
305
306 # Random write to sequential zones, libaio, queue depth 64, max 1 open zone.
307 test12() {
308     local size
309
310     size=$((8 * zone_size))
311     run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=16K \
312                    --max_open_zones=1 --size=$size --do_verify=1 --verify=md5 \
313                    --debug=zbd >>"${logfile}.${test_number}" 2>&1 || return $?
314     check_written $size || return $?
315     check_read $size || return $?
316 }
317
318 # Random write to sequential zones, libaio, queue depth 64, max 4 open zones.
319 test13() {
320     local size
321
322     size=$((8 * zone_size))
323     run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=16K \
324                    --max_open_zones=4 --size=$size --do_verify=1 --verify=md5 \
325                    --debug=zbd                                                \
326                    >>"${logfile}.${test_number}" 2>&1 || return $?
327     check_written $size || return $?
328     check_read $size || return $?
329 }
330
331 # Random write to conventional zones.
332 test14() {
333     local size
334
335     size=$((16 * 2**20)) # 20 MB
336     if [ $size -gt $((first_sequential_zone_sector * 512)) ]; then
337         echo "$dev does not have enough sequential zones" \
338              >>"${logfile}.${test_number}"
339         return 0
340     fi
341     run_one_fio_job "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=16K \
342                     --zonemode=zbd --zonesize="${zone_size}" --do_verify=1 \
343                     --verify=md5 --size=$size                              \
344                     >>"${logfile}.${test_number}" 2>&1 || return $?
345     check_written $((size)) || return $?
346     check_read $((size)) || return $?
347 }
348
349 # Sequential read on a mix of empty and full zones.
350 test15() {
351     local i off size
352     local w_off w_size
353
354     for ((i=0;i<4;i++)); do
355         [ -n "$is_zbd" ] &&
356             reset_zone "$dev" $((first_sequential_zone_sector +
357                                  i*sectors_per_zone))
358     done
359     w_off=$(((first_sequential_zone_sector + 2 * sectors_per_zone) * 512))
360     w_size=$((2 * zone_size))
361     off=$((first_sequential_zone_sector * 512))
362     size=$((4 * zone_size))
363     write_and_run_one_fio_job "${w_off}" "${w_size}" \
364                     "$(ioengine "psync")" --rw=read --bs=$((zone_size / 16)) \
365                     --zonemode=zbd --zonesize="${zone_size}" --offset=$off \
366                     --size=$((size)) >>"${logfile}.${test_number}" 2>&1 ||
367         return $?
368     check_written $((w_size)) || return $?
369     check_read $((size / 2))
370 }
371
372 # Random read on a mix of empty and full zones.
373 test16() {
374     local off size
375     local i w_off w_size
376
377     for ((i=0;i<4;i++)); do
378         [ -n "$is_zbd" ] &&
379             reset_zone "$dev" $((first_sequential_zone_sector +
380                                  i*sectors_per_zone))
381     done
382     w_off=$(((first_sequential_zone_sector + 2 * sectors_per_zone) * 512))
383     w_size=$((2 * zone_size))
384     off=$((first_sequential_zone_sector * 512))
385     size=$((4 * zone_size))
386     write_and_run_one_fio_job "${w_off}" "${w_size}" \
387                     "$(ioengine "libaio")" --iodepth=64 --rw=randread --bs=16K \
388                     --zonemode=zbd --zonesize="${zone_size}" --offset=$off \
389                     --size=$size >>"${logfile}.${test_number}" 2>&1 || return $?
390     check_written $w_size || return $?
391     check_read $size || return $?
392 }
393
394 # Random reads and writes in the last zone.
395 test17() {
396     local io off read size written
397
398     off=$(((disk_size / zone_size - 1) * zone_size))
399     size=$((disk_size - off))
400     if [ -n "$is_zbd" ]; then
401         reset_zone "$dev" $((off / 512)) || return $?
402     fi
403     run_one_fio_job "$(ioengine "libaio")" --iodepth=8 --rw=randrw --bs=4K \
404                     --zonemode=zbd --zonesize="${zone_size}"            \
405                     --offset=$off --loops=2 --norandommap=1\
406                     >>"${logfile}.${test_number}" 2>&1 || return $?
407     written=$(fio_written <"${logfile}.${test_number}")
408     read=$(fio_read <"${logfile}.${test_number}")
409     io=$((written + read))
410     echo "Total number of bytes read and written: $io <> $size" \
411          >>"${logfile}.${test_number}"
412     [ $io = $((size * 2)) ];
413 }
414
415 # Out-of-range zone reset threshold and frequency parameters.
416 test18() {
417     run_fio_on_seq --zone_reset_threshold=-1 |&
418         tee -a "${logfile}.${test_number}"   |
419             grep -q 'value out of range' || return $?
420 }
421
422 test19() {
423     run_fio_on_seq --zone_reset_threshold=2  |&
424         tee -a "${logfile}.${test_number}"   |
425         grep -q 'value out of range' || return $?
426 }
427
428 test20() {
429     run_fio_on_seq --zone_reset_threshold=.4:.6 |&
430         tee -a "${logfile}.${test_number}"   |
431         grep -q 'the list exceeding max length' || return $?
432 }
433
434 test21() {
435     run_fio_on_seq --zone_reset_frequency=-1 |&
436         tee -a "${logfile}.${test_number}"   |
437         grep -q 'value out of range' || return $?
438 }
439
440 test22() {
441     run_fio_on_seq --zone_reset_frequency=2  |&
442         tee -a "${logfile}.${test_number}"   |
443         grep -q 'value out of range' || return $?
444 }
445
446 test23() {
447     run_fio_on_seq --zone_reset_frequency=.4:.6  |&
448         tee -a "${logfile}.${test_number}"   |
449         grep -q 'the list exceeding max length' || return $?
450 }
451
452 test24() {
453     local bs loops=9 size=$((zone_size))
454
455     bs=$(min $((256*1024)) "$zone_size")
456     run_fio_on_seq "$(ioengine "psync")" --rw=write --bs="$bs"          \
457                    --size=$size --loops=$loops                          \
458                    --zone_reset_frequency=.01 --zone_reset_threshold=.90 \
459                    >> "${logfile}.${test_number}" 2>&1 || return $?
460     check_written $((size * loops)) || return $?
461     check_reset_count -eq 8 ||
462         check_reset_count -eq 9 ||
463         check_reset_count -eq 10 || return $?
464 }
465
466 # Multiple non-overlapping sequential write jobs for the same drive.
467 test25() {
468     local i opts=()
469
470     for ((i=0;i<16;i++)); do
471         [ -n "$is_zbd" ] &&
472             reset_zone "$dev" $((first_sequential_zone_sector + i*sectors_per_zone))
473     done
474     for ((i=0;i<16;i++)); do
475         opts+=("--name=job$i" "--filename=$dev" "--thread=1" "--direct=1")
476         opts+=("--offset=$((first_sequential_zone_sector*512 + zone_size*i))")
477         opts+=("--size=$zone_size" "$(ioengine "psync")" "--rw=write" "--bs=16K")
478         opts+=("--zonemode=zbd" "--zonesize=${zone_size}" "--group_reporting=1")
479         opts+=(${var_opts[@]})
480     done
481     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
482 }
483
484 write_to_first_seq_zone() {
485     local loops=4 r
486
487     r=$(((RANDOM << 16) | RANDOM))
488     run_fio --name="$dev" --filename="$dev" "$(ioengine "psync")" --rw="$1" \
489             --thread=1 --do_verify=1 --verify=md5 --direct=1 --bs=4K    \
490             --offset=$((first_sequential_zone_sector * 512))            \
491             "--size=$zone_size" --loops=$loops --randseed="$r"          \
492             --zonemode=zbd --zonesize="${zone_size}" --group_reporting=1        \
493             --gtod_reduce=1 >> "${logfile}.${test_number}" 2>&1 || return $?
494     check_written $((loops * zone_size)) || return $?
495 }
496
497 # Overwrite the first sequential zone four times sequentially.
498 test26() {
499     write_to_first_seq_zone write
500 }
501
502 # Overwrite the first sequential zone four times using random writes.
503 test27() {
504     write_to_first_seq_zone randwrite
505 }
506
507 # Multiple overlapping random write jobs for the same drive.
508 test28() {
509     local i jobs=16 off opts
510
511     off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
512     [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
513     opts=("--debug=zbd")
514     for ((i=0;i<jobs;i++)); do
515         opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
516         opts+=("--size=$zone_size" "$(ioengine "psync")" "--rw=randwrite")
517         opts+=("--thread=1" "--direct=1" "--zonemode=zbd")
518         opts+=("--zonesize=${zone_size}" "--group_reporting=1")
519         opts+=(${var_opts[@]})
520     done
521     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
522     check_written $((jobs * zone_size)) || return $?
523     check_reset_count -eq $jobs ||
524         check_reset_count -eq $((jobs - 1)) ||
525         return $?
526 }
527
528 # Multiple overlapping random write jobs for the same drive and with a limited
529 # number of open zones.
530 test29() {
531     local i jobs=16 off opts=()
532
533     off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
534     size=$((16*zone_size))
535     [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
536     opts=("--debug=zbd")
537     for ((i=0;i<jobs;i++)); do
538         opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
539         opts+=("--size=$size" "--io_size=$zone_size" "--thread=1")
540         opts+=("$(ioengine "psync")" "--rw=randwrite" "--direct=1")
541         opts+=("--max_open_zones=4" "--group_reporting=1")
542         opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
543         opts+=(${var_opts[@]})
544     done
545     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
546     check_written $((jobs * zone_size)) || return $?
547 }
548
549 # Random reads and writes across the entire disk for 30s.
550 test30() {
551     local off
552
553     off=$((first_sequential_zone_sector * 512))
554     run_one_fio_job "$(ioengine "libaio")" --iodepth=8 --rw=randrw      \
555                     --bs="$(max $((zone_size / 128)) "$logical_block_size")"\
556                     --zonemode=zbd --zonesize="${zone_size}" --offset=$off\
557                     --loops=2 --time_based --runtime=30s --norandommap=1\
558                     >>"${logfile}.${test_number}" 2>&1
559 }
560
561 # Random reads across all sequential zones for 30s. This is not only a fio
562 # test but also allows to verify the performance of a drive.
563 test31() {
564     local bs inc nz off opts size
565
566     # Start with writing 128 KB to 128 sequential zones.
567     bs=128K
568     nz=128
569     # shellcheck disable=SC2017
570     inc=$(((disk_size - (first_sequential_zone_sector * 512)) / (nz * zone_size)
571            * zone_size))
572     opts=()
573     for ((off = first_sequential_zone_sector * 512; off < disk_size;
574           off += inc)); do
575         opts+=("--name=$dev" "--filename=$dev" "--offset=$off" "--io_size=$bs")
576         opts+=("--bs=$bs" "--size=$zone_size" "$(ioengine "libaio")")
577         opts+=("--rw=write" "--direct=1" "--thread=1" "--stats=0")
578         opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
579         opts+=(${var_opts[@]})
580     done
581     "$(dirname "$0")/../../fio" "${opts[@]}" >> "${logfile}.${test_number}" 2>&1
582     # Next, run the test.
583     off=$((first_sequential_zone_sector * 512))
584     size=$((disk_size - off))
585     opts=("--name=$dev" "--filename=$dev" "--offset=$off" "--size=$size")
586     opts+=("--bs=$bs" "$(ioengine "psync")" "--rw=randread" "--direct=1")
587     opts+=("--thread=1" "--time_based" "--runtime=30" "--zonemode=zbd")
588     opts+=("--zonesize=${zone_size}")
589     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
590 }
591
592 # Random writes across all sequential zones. This is not only a fio test but
593 # also allows to verify the performance of a drive.
594 test32() {
595     local off opts=() size
596
597     off=$((first_sequential_zone_sector * 512))
598     size=$((disk_size - off))
599     opts+=("--name=$dev" "--filename=$dev" "--offset=$off" "--size=$size")
600     opts+=("--bs=128K" "$(ioengine "psync")" "--rw=randwrite" "--direct=1")
601     opts+=("--thread=1" "--time_based" "--runtime=30")
602     opts+=("--max_open_zones=$max_open_zones" "--zonemode=zbd")
603     opts+=("--zonesize=${zone_size}")
604     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
605 }
606
607 # Write to sequential zones with a block size that is not a divisor of the
608 # zone size.
609 test33() {
610     local bs io_size size
611
612     size=$((2 * zone_size))
613     io_size=$((5 * zone_size))
614     bs=$((3 * zone_size / 4))
615     run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=write \
616                    --size=$size --io_size=$io_size --bs=$bs     \
617                    >> "${logfile}.${test_number}" 2>&1 || return $?
618     check_written $(((io_size + bs - 1) / bs * bs)) || return $?
619 }
620
621 # Write to sequential zones with a block size that is not a divisor of the
622 # zone size and with data verification enabled.
623 test34() {
624     local size
625
626     size=$((2 * zone_size))
627     run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=write --size=$size \
628                    --do_verify=1 --verify=md5 --bs=$((3 * zone_size / 4)) \
629                    >> "${logfile}.${test_number}" 2>&1 && return 1
630     grep -q 'not a divisor of' "${logfile}.${test_number}"
631 }
632
633 # Test 1/4 for the I/O boundary rounding code: $size < $zone_size.
634 test35() {
635     local bs off io_size size
636
637     off=$(((first_sequential_zone_sector + 1) * 512))
638     size=$((zone_size - 2 * 512))
639     bs=$((zone_size / 4))
640     run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")"    \
641                     --iodepth=1 --rw=write --do_verify=1 --verify=md5   \
642                     --bs=$bs --zonemode=zbd --zonesize="${zone_size}"   \
643                     >> "${logfile}.${test_number}" 2>&1 && return 1
644     grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
645 }
646
647 # Test 2/4 for the I/O boundary rounding code: $size < $zone_size.
648 test36() {
649     local bs off io_size size
650
651     off=$(((first_sequential_zone_sector) * 512))
652     size=$((zone_size - 512))
653     bs=$((zone_size / 4))
654     run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")"    \
655                     --iodepth=1 --rw=write --do_verify=1 --verify=md5   \
656                     --bs=$bs --zonemode=zbd --zonesize="${zone_size}"   \
657                     >> "${logfile}.${test_number}" 2>&1 && return 1
658     grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
659 }
660
661 # Test 3/4 for the I/O boundary rounding code: $size > $zone_size.
662 test37() {
663     local bs off size
664
665     if [ "$first_sequential_zone_sector" = 0 ]; then
666         off=0
667     else
668         off=$(((first_sequential_zone_sector - 1) * 512))
669     fi
670     size=$((zone_size + 2 * 512))
671     bs=$((zone_size / 4))
672     run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")"    \
673                     --iodepth=1 --rw=write --do_verify=1 --verify=md5   \
674                     --bs=$bs --zonemode=zbd --zonesize="${zone_size}"   \
675                     >> "${logfile}.${test_number}" 2>&1
676     check_written $((zone_size)) || return $?
677 }
678
679 # Test 4/4 for the I/O boundary rounding code: $offset > $disk_size - $zone_size
680 test38() {
681     local bs off size
682
683     size=$((logical_block_size))
684     off=$((disk_size - logical_block_size))
685     bs=$((logical_block_size))
686     run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")"    \
687                     --iodepth=1 --rw=write --do_verify=1 --verify=md5   \
688                     --bs=$bs --zonemode=zbd --zonesize="${zone_size}"   \
689                     >> "${logfile}.${test_number}" 2>&1 && return 1
690     grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
691 }
692
693 # Read one block from a block device.
694 read_one_block() {
695     local bs
696
697     bs=$((logical_block_size))
698     run_one_fio_job --rw=read "$(ioengine "psync")" --bs=$bs --size=$bs "$@" 2>&1 |
699         tee -a "${logfile}.${test_number}"
700 }
701
702 # Check whether fio accepts --zonemode=none for zoned block devices.
703 test39() {
704     [ -n "$is_zbd" ] || return 0
705     read_one_block --zonemode=none >/dev/null || return $?
706     check_read $((logical_block_size)) || return $?
707 }
708
709 # Check whether fio accepts --zonemode=strided for zoned block devices.
710 test40() {
711     local bs
712
713     bs=$((logical_block_size))
714     [ -n "$is_zbd" ] || return 0
715     read_one_block --zonemode=strided |
716         grep -q 'fio: --zonesize must be specified when using --zonemode=strided' ||
717         return $?
718     read_one_block --zonemode=strided --zonesize=$bs >/dev/null || return $?
719     check_read $bs || return $?
720 }
721
722 # Check whether fio checks the zone size for zoned block devices.
723 test41() {
724     [ -n "$is_zbd" ] || return 0
725     read_one_block --zonemode=zbd --zonesize=$((2 * zone_size)) |
726         grep -q 'job parameter zonesize.*does not match disk zone size'
727 }
728
729 # Check whether fio handles --zonesize=0 correctly for regular block devices.
730 test42() {
731     [ -n "$is_zbd" ] && return 0
732     read_one_block --zonemode=zbd --zonesize=0 |
733         grep -q 'Specifying the zone size is mandatory for regular block devices with --zonemode=zbd'
734 }
735
736 # Check whether fio handles --zonesize=1 correctly for regular block devices.
737 test43() {
738     [ -n "$is_zbd" ] && return 0
739     read_one_block --zonemode=zbd --zonesize=1 |
740         grep -q 'zone size must be at least 512 bytes for --zonemode=zbd'
741 }
742
743 # Check whether fio handles --zonemode=none --zonesize=1 correctly.
744 test44() {
745     read_one_block --zonemode=none --zonesize=1 |
746         grep -q 'fio: --zonemode=none and --zonesize are not compatible'
747 }
748
749 test45() {
750     local bs i
751
752     [ -z "$is_zbd" ] && return 0
753     bs=$((logical_block_size))
754     run_one_fio_job "$(ioengine "psync")" --iodepth=1 --rw=randwrite --bs=$bs\
755                     --offset=$((first_sequential_zone_sector * 512)) \
756                     --size="$zone_size" --do_verify=1 --verify=md5 2>&1 |
757         tee -a "${logfile}.${test_number}" |
758         grep -q "fio: first I/O failed. If .* is a zoned block device, consider --zonemode=zbd"
759 }
760
761 # Random write to sequential zones, libaio, 8 jobs, queue depth 64 per job
762 test46() {
763     local size
764
765     size=$((4 * zone_size))
766     run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=4K \
767                    --group_reporting=1 --numjobs=8 \
768                    >> "${logfile}.${test_number}" 2>&1 || return $?
769     check_written $((size * 8)) || return $?
770 }
771
772 # Check whether fio handles --zonemode=zbd --zoneskip=1 correctly.
773 test47() {
774     local bs
775
776     bs=$((logical_block_size))
777     run_fio_on_seq "$(ioengine "psync")" --rw=write --bs=$bs --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