3 # Copyright (C) 2018 Western Digital Corporation or its affiliates.
5 # This file is released under the GPL.
8 echo "Usage: $(basename "$0") [OPTIONS] <test target device file>"
10 echo -e "\t-d Run fio with valgrind using DRD tool"
11 echo -e "\t-e Run fio with valgrind using helgrind tool"
12 echo -e "\t-v Run fio with valgrind --read-var-info option"
13 echo -e "\t-l Test with libzbc ioengine"
14 echo -e "\t-r Reset all zones before test start"
15 echo -e "\t-o <max_open_zones> Run fio with max_open_zones limit"
16 echo -e "\t-t <test #> Run only a single test case with specified number"
17 echo -e "\t-q Quit the test run after any failed test"
18 echo -e "\t-z Run fio with debug=zbd option"
22 if [ "$1" -gt "$2" ]; then
30 if [ "$1" -lt "$2" ]; then
38 if [ -n "$use_libzbc" ]; then
39 echo -n "--ioengine=libzbc"
41 echo -n "--ioengine=$1"
48 [ -e "/sys/block/$dev" ] || return $?
49 if [ -e "/sys/block/$dev/mq" ]; then
52 deadline) sched=mq-deadline;;
57 mq-deadline) sched=deadline;;
61 echo "$sched" >"/sys/block/$dev/queue/scheduler"
67 read=$(fio_read <"${logfile}.${test_number}")
68 echo "read: $read <> $1" >> "${logfile}.${test_number}"
75 written=$(fio_written <"${logfile}.${test_number}")
76 echo "written: $written <> $1" >> "${logfile}.${test_number}"
80 # Compare the reset count from the log file with reset count $2 using operator
81 # $1 (=, -ge, -gt, -le, -lt).
85 reset_count=$(fio_reset_count <"${logfile}.${test_number}")
86 echo "reset_count: test $reset_count $1 $2" >> "${logfile}.${test_number}"
87 eval "[ '$reset_count' '$1' '$2' ]"
90 # Check log for failed assertions and crashes. Without these checks,
91 # a test can succeed even when these events happen, but it must fail.
93 [ ! -f "${logfile}.${1}" ] && return 0
94 ! grep -q -e "Assertion " -e "Aborted " "${logfile}.${1}"
97 # Whether or not $1 (/dev/...) is a SCSI device.
102 for f in /sys/class/scsi_device/*/device/block/"$d"; do
103 [ -e "$f" ] && return 0
108 job_var_opts_exclude() {
112 for o in "${job_var_opts[@]}"; do
113 if [[ ${o} =~ "${ex_key}" ]]; then
120 has_max_open_zones() {
122 if [[ ${1} =~ "--max_open_zones" ]]; then
133 fio=$(dirname "$0")/../../fio
135 opts=(${global_var_opts[@]})
136 opts+=("--max-jobs=16" "--aux-path=/tmp" "--allow_file_create=0" \
137 "--significant_figures=10" "$@")
138 # When max_open_zones option is specified to this test script, add
139 # max_open_zones option to fio command unless the test case already add it.
140 if [[ -n ${max_open_zones_opt} ]] && ! has_max_open_zones "${opts[@]}"; then
141 opts+=("--max_open_zones=${max_open_zones_opt}")
143 { echo; echo "fio ${opts[*]}"; echo; } >>"${logfile}.${test_number}"
145 "${dynamic_analyzer[@]}" "$fio" "${opts[@]}"
151 r=$(((RANDOM << 16) | RANDOM))
152 run_fio --name="$dev" --filename="$dev" "$@" --randseed="$r" \
153 --thread=1 --direct=1
156 write_and_run_one_fio_job() {
158 local write_offset="${1}"
159 local write_size="${2}"
163 r=$(((RANDOM << 16) | RANDOM))
164 write_opts=(--name="write_job" --rw=write "$(ioengine "psync")" \
165 --bs="${logical_block_size}" --zonemode=zbd \
166 --zonesize="${zone_size}" --thread=1 --direct=1 \
167 --offset="${write_offset}" --size="${write_size}")
168 write_opts+=("${job_var_opts[@]}")
169 run_fio --filename="$dev" --randseed="$r" "${write_opts[@]}" \
170 --name="$dev" --wait_for="write_job" "$@" --thread=1 --direct=1
173 # Run fio on the first four sequential zones of the disk.
177 opts+=("--offset=$((first_sequential_zone_sector * 512))")
178 opts+=("--size=$((4 * zone_size))" "--zonemode=zbd")
179 if [ -z "$is_zbd" ]; then
180 opts+=("--zonesize=${zone_size}")
182 run_one_fio_job "${opts[@]}" "$@"
185 # Prepare for write test by resetting zones. When max_open_zones option is
186 # specified, reset all zones of the test target to ensure that zones out of the
187 # test target range do not have open zones. This allows the write test to the
188 # target range to be able to open zones up to max_open_zones.
190 [[ -n "${max_open_zones_opt}" && -n "${is_zbd}" ]] &&
191 reset_zone "${dev}" -1
197 if ! is_scsi_device "$dev"; then
198 SKIP_REASON="$dev is not a SCSI device"
204 require_conv_zone_bytes() {
207 if ((req_bytes > first_sequential_zone_sector * 512)); then
208 SKIP_REASON="$dev does not have enough conventional zones"
215 if [[ -z ${is_zbd} ]]; then
216 SKIP_REASON="$dev is not a zoned block device"
222 require_regular_block_dev() {
223 if [[ -n ${is_zbd} ]]; then
224 SKIP_REASON="$dev is not a regular block device"
230 require_seq_zones() {
231 local req_seq_zones=${1}
232 local seq_bytes=$((disk_size - first_sequential_zone_sector * 512))
234 if ((req_seq_zones > seq_bytes / zone_size)); then
235 SKIP_REASON="$dev does not have $req_seq_zones sequential zones"
241 require_conv_zones() {
242 local req_c_zones=${1}
243 local conv_bytes=$((first_sequential_zone_sector * 512))
245 if ((req_c_zones > conv_bytes / zone_size)); then
246 SKIP_REASON="$dev does not have $req_c_zones conventional zones"
252 # Check whether buffered writes are refused.
254 run_fio --name=job1 --filename="$dev" --rw=write --direct=0 --bs=4K \
255 "$(ioengine "psync")" --size="${zone_size}" --thread=1 \
256 --zonemode=zbd --zonesize="${zone_size}" 2>&1 |
257 tee -a "${logfile}.${test_number}" |
258 grep -q 'Using direct I/O is mandatory for writing to ZBD drives'
259 local fio_rc=${PIPESTATUS[0]} grep_rc=${PIPESTATUS[2]}
264 if [ -n "$is_zbd" ]; then
271 # Block size exceeds zone size.
273 local bs off opts=() rc
275 off=$(((first_sequential_zone_sector + 2 * sectors_per_zone) * 512))
276 bs=$((2 * zone_size))
277 opts+=("$(ioengine "psync")")
278 opts+=("--name=job1" "--filename=$dev" "--rw=write" "--direct=1")
279 opts+=("--zonemode=zbd" "--offset=$off" "--bs=$bs" "--size=$bs")
280 if [ -z "$is_zbd" ]; then
281 opts+=("--zonesize=${zone_size}")
283 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 && return 1
284 grep -q 'buflen exceeds zone size' "${logfile}.${test_number}"
287 # Run fio against an empty zone. This causes fio to report "No I/O performed".
291 require_seq_zones 129 || return $SKIP_TESTCASE
292 off=$((first_sequential_zone_sector * 512 + 128 * zone_size))
294 [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
295 opts+=("--name=$dev" "--filename=$dev" "--offset=$off" "--bs=4K")
296 opts+=("--size=$size" "--zonemode=zbd")
297 opts+=("$(ioengine "psync")" "--rw=read" "--direct=1" "--thread=1")
298 if [ -z "$is_zbd" ]; then
299 opts+=("--zonesize=${zone_size}")
301 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
302 ! grep -q 'READ:' "${logfile}.${test_number}"
305 # Run fio with --read_beyond_wp=1 against an empty zone.
309 require_seq_zones 130 || return $SKIP_TESTCASE
310 off=$((first_sequential_zone_sector * 512 + 129 * zone_size))
312 [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
313 opts+=("--name=$dev" "--filename=$dev" "--offset=$off" "--bs=$size")
314 opts+=("--size=$size" "--thread=1" "--read_beyond_wp=1")
315 opts+=("$(ioengine "psync")" "--rw=read" "--direct=1" "--disable_lat=1")
316 opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
317 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
318 check_read $size || return $?
321 # Sequential write to sequential zones.
323 local size off capacity
326 off=$((first_sequential_zone_sector * 512))
327 capacity=$(total_zone_capacity 4 $off $dev)
328 size=$((4 * zone_size))
329 run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=write \
330 --bs="$(max $((zone_size / 64)) "$logical_block_size")"\
331 --do_verify=1 --verify=md5 \
332 >>"${logfile}.${test_number}" 2>&1 || return $?
333 check_written $capacity || return $?
334 check_read $capacity || return $?
337 # Sequential read from sequential zones.
339 local size off capacity
342 off=$((first_sequential_zone_sector * 512))
343 capacity=$(total_zone_capacity 4 $off $dev)
344 size=$((4 * zone_size))
345 write_and_run_one_fio_job \
346 $((first_sequential_zone_sector * 512)) "${size}" \
348 --size="${size}" --zonemode=zbd --zonesize="${zone_size}" \
349 "$(ioengine "psync")" --iodepth=1 --rw=read \
350 --bs="$(max $((zone_size / 64)) "$logical_block_size")" \
351 >>"${logfile}.${test_number}" 2>&1 || return $?
352 check_read $capacity || return $?
355 # Random write to sequential zones, libaio, queue depth 1.
357 local size=$((zone_size))
361 off=$((first_sequential_zone_sector * 512))
362 capacity=$(total_zone_capacity 1 $off $dev)
363 run_fio_on_seq "$(ioengine "libaio")" --iodepth=1 --rw=randwrite \
364 --bs="$(min 16384 "${zone_size}")" \
365 --do_verify=1 --verify=md5 --size="$size" \
366 >>"${logfile}.${test_number}" 2>&1 || return $?
367 check_written $capacity || return $?
368 check_read $capacity || return $?
371 # Random write to sequential zones, libaio, queue depth 64.
373 local size off capacity
376 size=$((4 * zone_size))
377 off=$((first_sequential_zone_sector * 512))
378 capacity=$(total_zone_capacity 4 $off $dev)
379 run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite \
380 --bs="$(min 16384 "${zone_size}")" \
381 --do_verify=1 --verify=md5 \
382 >>"${logfile}.${test_number}" 2>&1 || return $?
383 check_written $capacity || return $?
384 check_read $capacity || return $?
387 # Random write to sequential zones, sg, queue depth 1.
391 require_scsi_dev || return $SKIP_TESTCASE
394 size=$((4 * zone_size))
395 run_fio_on_seq --ioengine=sg \
396 --iodepth=1 --rw=randwrite --bs=16K \
397 --do_verify=1 --verify=md5 \
398 >>"${logfile}.${test_number}" 2>&1 || return $?
399 check_written $size || return $?
400 check_read $size || return $?
403 # Random write to sequential zones, sg, queue depth 64.
407 require_scsi_dev || return $SKIP_TESTCASE
410 size=$((4 * zone_size))
411 run_fio_on_seq --ioengine=sg \
412 --iodepth=64 --rw=randwrite --bs=16K \
413 --do_verify=1 --verify=md5 \
414 >>"${logfile}.${test_number}" 2>&1 || return $?
415 check_written $size || return $?
416 check_read $size || return $?
419 # Random write to sequential zones, libaio, queue depth 64, random block size.
421 local size off capacity
424 size=$((4 * zone_size))
425 off=$((first_sequential_zone_sector * 512))
426 capacity=$(total_zone_capacity 4 $off $dev)
427 run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite \
428 --bsrange=4K-64K --do_verify=1 --verify=md5 \
429 --debug=zbd >>"${logfile}.${test_number}" 2>&1 || return $?
430 check_written $capacity || return $?
431 check_read $capacity || return $?
434 # Random write to sequential zones, libaio, queue depth 64, max 1 open zone.
436 local size off capacity
439 size=$((8 * zone_size))
440 off=$((first_sequential_zone_sector * 512))
441 capacity=$(total_zone_capacity 8 $off $dev)
442 run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=16K \
443 --max_open_zones=1 --size=$size --do_verify=1 --verify=md5 \
444 --debug=zbd >>"${logfile}.${test_number}" 2>&1 || return $?
445 check_written $capacity || return $?
446 check_read $capacity || return $?
449 # Random write to sequential zones, libaio, queue depth 64, max 4 open zones.
451 local size off capacity
454 size=$((8 * zone_size))
455 off=$((first_sequential_zone_sector * 512))
456 capacity=$(total_zone_capacity 8 $off $dev)
457 run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=16K \
458 --max_open_zones=4 --size=$size --do_verify=1 --verify=md5 \
460 >>"${logfile}.${test_number}" 2>&1 || return $?
461 check_written $capacity || return $?
462 check_read $capacity || return $?
465 # Random write to conventional zones.
469 if ! result=($(first_online_zone "$dev")); then
470 echo "Failed to determine first online zone"
475 size=$((16 * 2**20)) # 20 MB
476 require_conv_zone_bytes "${size}" || return $SKIP_TESTCASE
478 run_one_fio_job "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=16K \
479 --zonemode=zbd --zonesize="${zone_size}" --do_verify=1 \
480 --verify=md5 --offset=$off --size=$size\
481 >>"${logfile}.${test_number}" 2>&1 || return $?
482 check_written $((size)) || return $?
483 check_read $((size)) || return $?
486 # Sequential read on a mix of empty and full zones.
489 local w_off w_size w_capacity
491 for ((i=0;i<4;i++)); do
493 reset_zone "$dev" $((first_sequential_zone_sector +
497 w_off=$(((first_sequential_zone_sector + 2 * sectors_per_zone) * 512))
498 w_size=$((2 * zone_size))
499 w_capacity=$(total_zone_capacity 2 $w_off $dev)
500 off=$((first_sequential_zone_sector * 512))
501 size=$((4 * zone_size))
502 write_and_run_one_fio_job "${w_off}" "${w_size}" \
503 "$(ioengine "psync")" --rw=read --bs=$((zone_size / 16)) \
504 --zonemode=zbd --zonesize="${zone_size}" --offset=$off \
505 --size=$((size)) >>"${logfile}.${test_number}" 2>&1 ||
507 check_written $((w_capacity)) || return $?
508 check_read $((w_capacity))
511 # Random read on a mix of empty and full zones.
514 local i w_off w_size w_capacity
516 for ((i=0;i<4;i++)); do
518 reset_zone "$dev" $((first_sequential_zone_sector +
522 w_off=$(((first_sequential_zone_sector + 2 * sectors_per_zone) * 512))
523 w_size=$((2 * zone_size))
524 w_capacity=$(total_zone_capacity 2 $w_off $dev)
525 off=$((first_sequential_zone_sector * 512))
526 size=$((4 * zone_size))
527 write_and_run_one_fio_job "${w_off}" "${w_size}" \
528 "$(ioengine "libaio")" --iodepth=64 --rw=randread --bs=16K \
529 --zonemode=zbd --zonesize="${zone_size}" --offset=$off \
530 --size=$size >>"${logfile}.${test_number}" 2>&1 || return $?
531 check_written $w_capacity || return $?
532 check_read $size || return $?
535 # Random reads and writes in the last zone.
537 local io off last read size written
539 off=$(((disk_size / zone_size - 1) * zone_size))
540 size=$((disk_size - off))
541 if ! last=($(last_online_zone "$dev")); then
542 echo "Failed to determine last online zone"
545 if [[ "$((last * 512))" -lt "$off" ]]; then
549 if [ -n "$is_zbd" ]; then
550 reset_zone "$dev" $((off / 512)) || return $?
553 run_one_fio_job "$(ioengine "libaio")" --iodepth=8 --rw=randrw --bs=4K \
554 --zonemode=zbd --zonesize="${zone_size}" \
555 --offset=$off --loops=2 --norandommap=1 \
557 >>"${logfile}.${test_number}" 2>&1 || return $?
558 written=$(fio_written <"${logfile}.${test_number}")
559 read=$(fio_read <"${logfile}.${test_number}")
560 io=$((written + read))
561 echo "Total number of bytes read and written: $io <> $size" \
562 >>"${logfile}.${test_number}"
563 [ $io = $((size * 2)) ];
566 # Out-of-range zone reset threshold and frequency parameters.
568 run_fio_on_seq --zone_reset_threshold=-1 |&
569 tee -a "${logfile}.${test_number}" |
570 grep -q 'value out of range' || return $?
574 run_fio_on_seq --zone_reset_threshold=2 |&
575 tee -a "${logfile}.${test_number}" |
576 grep -q 'value out of range' || return $?
580 run_fio_on_seq --zone_reset_threshold=.4:.6 |&
581 tee -a "${logfile}.${test_number}" |
582 grep -q 'the list exceeding max length' || return $?
586 run_fio_on_seq --zone_reset_frequency=-1 |&
587 tee -a "${logfile}.${test_number}" |
588 grep -q 'value out of range' || return $?
592 run_fio_on_seq --zone_reset_frequency=2 |&
593 tee -a "${logfile}.${test_number}" |
594 grep -q 'value out of range' || return $?
598 run_fio_on_seq --zone_reset_frequency=.4:.6 |&
599 tee -a "${logfile}.${test_number}" |
600 grep -q 'the list exceeding max length' || return $?
604 local bs loops=9 size=$((zone_size))
608 off=$((first_sequential_zone_sector * 512))
609 capacity=$(total_zone_capacity 1 $off $dev)
611 bs=$(min $((256*1024)) "$zone_size")
612 run_fio_on_seq "$(ioengine "psync")" --rw=write --bs="$bs" \
613 --size=$size --loops=$loops \
614 --zone_reset_frequency=.01 --zone_reset_threshold=.90 \
615 >> "${logfile}.${test_number}" 2>&1 || return $?
616 check_written $((capacity * loops)) || return $?
617 check_reset_count -eq 8 ||
618 check_reset_count -eq 9 ||
619 check_reset_count -eq 10 || return $?
622 # Multiple non-overlapping sequential write jobs for the same drive.
626 for ((i=0;i<16;i++)); do
628 reset_zone "$dev" $((first_sequential_zone_sector + i*sectors_per_zone))
631 for ((i=0;i<16;i++)); do
632 opts+=("--name=job$i" "--filename=$dev" "--thread=1" "--direct=1")
633 opts+=("--offset=$((first_sequential_zone_sector*512 + zone_size*i))")
634 opts+=("--size=$zone_size" "$(ioengine "psync")" "--rw=write" "--bs=16K")
635 opts+=("--zonemode=zbd" "--zonesize=${zone_size}" "--group_reporting=1")
636 opts+=(${job_var_opts[@]})
638 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
641 write_to_first_seq_zone() {
646 off=$((first_sequential_zone_sector * 512))
647 capacity=$(total_zone_capacity 1 $off $dev)
649 r=$(((RANDOM << 16) | RANDOM))
650 run_fio --name="$dev" --filename="$dev" "$(ioengine "psync")" --rw="$1" \
651 --thread=1 --do_verify=1 --verify=md5 --direct=1 --bs=4K \
653 --size=$zone_size --loops=$loops --randseed="$r" \
654 --zonemode=zbd --zonesize="${zone_size}" --group_reporting=1 \
655 --gtod_reduce=1 >> "${logfile}.${test_number}" 2>&1 || return $?
656 check_written $((loops * capacity)) || return $?
659 # Overwrite the first sequential zone four times sequentially.
661 write_to_first_seq_zone write
664 # Overwrite the first sequential zone four times using random writes.
666 write_to_first_seq_zone randwrite
669 # Multiple overlapping random write jobs for the same drive.
671 local i jobs=16 off opts
673 require_seq_zones 65 || return $SKIP_TESTCASE
674 off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
675 [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
678 capacity=$(total_zone_capacity 1 $off $dev)
679 for ((i=0;i<jobs;i++)); do
680 opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
681 opts+=("--size=$zone_size" "--io_size=$capacity" "$(ioengine "psync")" "--rw=randwrite")
682 opts+=("--thread=1" "--direct=1" "--zonemode=zbd")
683 opts+=("--zonesize=${zone_size}" "--group_reporting=1")
684 opts+=(${job_var_opts[@]})
686 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
687 check_written $((jobs * $capacity)) || return $?
688 check_reset_count -eq $jobs ||
689 check_reset_count -eq $((jobs - 1)) ||
693 # Multiple overlapping random write jobs for the same drive and with a limited
694 # number of open zones.
696 local i jobs=16 off opts=()
698 require_seq_zones 80 || return $SKIP_TESTCASE
699 off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
700 size=$((16*zone_size))
703 for ((i=0;i<jobs;i++)); do
704 opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
705 opts+=("--size=$size" "--io_size=$zone_size" "--thread=1")
706 opts+=("$(ioengine "psync")" "--rw=randwrite" "--direct=1")
707 opts+=("--max_open_zones=4" "--group_reporting=1")
708 opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
709 # max_open_zones is already specified
710 opts+=($(job_var_opts_exclude "--max_open_zones"))
712 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
713 check_written $((jobs * zone_size)) || return $?
716 # Random reads and writes across the entire disk for 30s.
721 off=$((first_sequential_zone_sector * 512))
722 run_one_fio_job "$(ioengine "libaio")" --iodepth=8 --rw=randrw \
723 --bs="$(max $((zone_size / 128)) "$logical_block_size")"\
724 --zonemode=zbd --zonesize="${zone_size}" --offset=$off\
725 --loops=2 --time_based --runtime=30s --norandommap=1\
726 >>"${logfile}.${test_number}" 2>&1
729 # Random reads across all sequential zones for 30s. This is not only a fio
730 # test but also allows to verify the performance of a drive.
732 local bs inc nz off opts size
735 # Start with writing 128 KB to max_open_zones sequential zones.
737 nz=$((max_open_zones))
738 if [[ $nz -eq 0 ]]; then
741 # shellcheck disable=SC2017
742 inc=$(((disk_size - (first_sequential_zone_sector * 512)) / (nz * zone_size)
744 if [ "$inc" -eq 0 ]; then
745 require_seq_zones $nz || return $SKIP_TESTCASE
748 for ((off = first_sequential_zone_sector * 512; off < disk_size;
750 opts+=("--name=$dev" "--filename=$dev" "--offset=$off" "--io_size=$bs")
751 opts+=("--bs=$bs" "--size=$zone_size" "$(ioengine "libaio")")
752 opts+=("--rw=write" "--direct=1" "--thread=1" "--stats=0")
753 opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
754 opts+=(${job_var_opts[@]})
756 "$(dirname "$0")/../../fio" "${opts[@]}" >> "${logfile}.${test_number}" 2>&1
757 # Next, run the test.
758 off=$((first_sequential_zone_sector * 512))
759 size=$((disk_size - off))
760 opts=("--name=$dev" "--filename=$dev" "--offset=$off" "--size=$size")
761 opts+=("--bs=$bs" "$(ioengine "psync")" "--rw=randread" "--direct=1")
762 opts+=("--thread=1" "--time_based" "--runtime=30" "--zonemode=zbd")
763 opts+=("--zonesize=${zone_size}")
764 opts+=(${job_var_opts[@]})
765 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
768 # Random writes across all sequential zones. This is not only a fio test but
769 # also allows to verify the performance of a drive.
771 local off opts=() size
773 require_zbd || return $SKIP_TESTCASE
776 off=$((first_sequential_zone_sector * 512))
777 size=$((disk_size - off))
778 opts+=("--name=$dev" "--filename=$dev" "--offset=$off" "--size=$size")
779 opts+=("--bs=128K" "$(ioengine "psync")" "--rw=randwrite" "--direct=1")
780 opts+=("--thread=1" "--time_based" "--runtime=30")
781 opts+=("--max_open_zones=$max_open_zones" "--zonemode=zbd")
782 opts+=("--zonesize=${zone_size}")
783 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
786 # Write to sequential zones with a block size that is not a divisor of the
789 local bs io_size size
790 local off capacity=0;
793 off=$((first_sequential_zone_sector * 512))
794 capacity=$(total_zone_capacity 1 $off $dev)
795 size=$((2 * zone_size))
796 io_size=$((5 * capacity))
797 bs=$((3 * capacity / 4))
798 run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=write \
799 --size=$size --io_size=$io_size --bs=$bs \
800 >> "${logfile}.${test_number}" 2>&1 || return $?
801 check_written $(((io_size + bs - 1) / bs * bs)) || return $?
804 # Write to sequential zones with a block size that is not a divisor of the
805 # zone size and with data verification enabled.
810 size=$((2 * zone_size))
811 run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=write --size=$size \
812 --do_verify=1 --verify=md5 --bs=$((3 * zone_size / 4)) \
813 >> "${logfile}.${test_number}" 2>&1 && return 1
814 grep -q 'not a divisor of' "${logfile}.${test_number}"
817 # Test 1/4 for the I/O boundary rounding code: $size < $zone_size.
819 local bs off io_size size
822 off=$(((first_sequential_zone_sector + 1) * 512))
823 size=$((zone_size - 2 * 512))
824 bs=$((zone_size / 4))
825 run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")" \
826 --iodepth=1 --rw=write --do_verify=1 --verify=md5 \
827 --bs=$bs --zonemode=zbd --zonesize="${zone_size}" \
828 >> "${logfile}.${test_number}" 2>&1 && return 1
829 grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
832 # Test 2/4 for the I/O boundary rounding code: $size < $zone_size.
834 local bs off io_size size
837 off=$(((first_sequential_zone_sector) * 512))
838 size=$((zone_size - 512))
839 bs=$((zone_size / 4))
840 run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")" \
841 --iodepth=1 --rw=write --do_verify=1 --verify=md5 \
842 --bs=$bs --zonemode=zbd --zonesize="${zone_size}" \
843 >> "${logfile}.${test_number}" 2>&1 && return 1
844 grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
847 # Test 3/4 for the I/O boundary rounding code: $size > $zone_size.
849 local bs off size capacity
852 capacity=$(total_zone_capacity 1 $((first_sequential_zone_sector*512)) $dev)
853 if [ "$first_sequential_zone_sector" = 0 ]; then
856 off=$(((first_sequential_zone_sector - 1) * 512))
858 size=$((zone_size + 2 * 512))
859 bs=$((zone_size / 4))
860 run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")" \
861 --iodepth=1 --rw=write --do_verify=1 --verify=md5 \
862 --bs=$bs --zonemode=zbd --zonesize="${zone_size}" \
863 >> "${logfile}.${test_number}" 2>&1
864 check_written $capacity || return $?
867 # Test 4/4 for the I/O boundary rounding code: $offset > $disk_size - $zone_size
872 size=$((logical_block_size))
873 off=$((disk_size - logical_block_size))
874 bs=$((logical_block_size))
875 run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")" \
876 --iodepth=1 --rw=write --do_verify=1 --verify=md5 \
877 --bs=$bs --zonemode=zbd --zonesize="${zone_size}" \
878 >> "${logfile}.${test_number}" 2>&1 && return 1
879 grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
882 # Read one block from a block device.
887 if ! result=($(first_online_zone "$dev")); then
888 echo "Failed to determine first online zone"
892 bs=$((logical_block_size))
893 run_one_fio_job --rw=read "$(ioengine "psync")" --offset=$off --bs=$bs \
894 --size=$bs "$@" 2>&1 |
895 tee -a "${logfile}.${test_number}"
898 # Check whether fio accepts --zonemode=none for zoned block devices.
900 require_zbd || return $SKIP_TESTCASE
901 read_one_block --zonemode=none >/dev/null || return $?
902 check_read $((logical_block_size)) || return $?
905 # Check whether fio accepts --zonemode=strided for zoned block devices.
909 bs=$((logical_block_size))
910 require_zbd || return $SKIP_TESTCASE
911 read_one_block --zonemode=strided |
912 grep -q 'fio: --zonesize must be specified when using --zonemode=strided' ||
914 read_one_block --zonemode=strided --zonesize=$bs >/dev/null || return $?
915 check_read $bs || return $?
918 # Check whether fio checks the zone size for zoned block devices.
920 require_zbd || return $SKIP_TESTCASE
921 read_one_block --zonemode=zbd --zonesize=$((2 * zone_size)) |
922 grep -q 'job parameter zonesize.*does not match disk zone size'
925 # Check whether fio handles --zonesize=0 correctly for regular block devices.
927 require_regular_block_dev || return $SKIP_TESTCASE
928 read_one_block --zonemode=zbd --zonesize=0 |
929 grep -q 'Specifying the zone size is mandatory for regular block devices with --zonemode=zbd'
932 # Check whether fio handles --zonesize=1 correctly for regular block devices.
934 require_regular_block_dev || return $SKIP_TESTCASE
935 read_one_block --zonemode=zbd --zonesize=1 |
936 grep -q 'zone size must be at least 512 bytes for --zonemode=zbd'
939 # Check whether fio handles --zonemode=none --zonesize=1 correctly.
941 read_one_block --zonemode=none --zonesize=1 |
942 grep -q 'fio: --zonemode=none and --zonesize are not compatible'
948 require_zbd || return $SKIP_TESTCASE
950 bs=$((logical_block_size))
951 run_one_fio_job "$(ioengine "psync")" --iodepth=1 --rw=randwrite --bs=$bs\
952 --offset=$((first_sequential_zone_sector * 512)) \
953 --size="$zone_size" --do_verify=1 --verify=md5 2>&1 |
954 tee -a "${logfile}.${test_number}" |
955 grep -q "fio: first I/O failed. If .* is a zoned block device, consider --zonemode=zbd"
958 # Random write to sequential zones, libaio, 8 jobs, queue depth 64 per job
963 size=$((4 * zone_size))
964 run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=4K \
965 --group_reporting=1 --numjobs=8 \
966 >> "${logfile}.${test_number}" 2>&1 || return $?
967 check_written $((size * 8)) || return $?
970 # Check whether fio handles --zonemode=zbd --zoneskip=1 correctly.
975 bs=$((logical_block_size))
976 run_fio_on_seq "$(ioengine "psync")" --rw=write --bs=$bs --zoneskip=1 \
977 >> "${logfile}.${test_number}" 2>&1 && return 1
978 grep -q 'zoneskip 1 is not a multiple of the device zone size' "${logfile}.${test_number}"
981 # Multiple overlapping random write jobs for the same drive and with a
982 # limited number of open zones. This is similar to test29, but uses libaio
983 # to stress test zone locking.
985 local i jobs=16 off opts=()
987 require_zbd || return $SKIP_TESTCASE
988 require_seq_zones 80 || return $SKIP_TESTCASE
990 off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
991 size=$((16*zone_size))
993 opts=("--aux-path=/tmp" "--allow_file_create=0" "--significant_figures=10")
994 opts+=("--debug=zbd")
995 opts+=("$(ioengine "libaio")" "--rw=randwrite" "--direct=1")
996 opts+=("--time_based" "--runtime=30")
997 opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
998 opts+=("--max_open_zones=4")
999 for ((i=0;i<jobs;i++)); do
1000 opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
1001 opts+=("--io_size=$zone_size" "--iodepth=256" "--thread=1")
1002 opts+=("--size=$size" "--group_reporting=1")
1003 # max_open_zones is already specified
1004 opts+=($(job_var_opts_exclude "--max_open_zones"))
1007 fio=$(dirname "$0")/../../fio
1009 { echo; echo "fio ${opts[*]}"; echo; } >>"${logfile}.${test_number}"
1011 timeout -v -s KILL 180s \
1012 "${dynamic_analyzer[@]}" "$fio" "${opts[@]}" \
1013 >> "${logfile}.${test_number}" 2>&1 || return $?
1016 # Check if fio handles --zonecapacity on a normal block device correctly
1019 require_regular_block_dev || return $SKIP_TESTCASE
1021 size=$((2 * zone_size))
1022 capacity=$((zone_size * 3 / 4))
1024 run_one_fio_job "$(ioengine "psync")" --rw=write \
1025 --zonemode=zbd --zonesize="${zone_size}" \
1026 --zonecapacity=${capacity} \
1027 --verify=md5 --size=${size} >>"${logfile}.${test_number}" 2>&1 ||
1029 check_written $((capacity * 2)) || return $?
1030 check_read $((capacity * 2)) || return $?
1033 # Verify that conv zones are not locked and only seq zones are locked during
1034 # random read on conv-seq mixed zones.
1038 require_zbd || return $SKIP_TESTCASE
1039 require_conv_zones 8 || return $SKIP_TESTCASE
1040 require_seq_zones 8 || return $SKIP_TESTCASE
1042 reset_zone "${dev}" -1
1044 off=$((first_sequential_zone_sector * 512 - 8 * zone_size))
1045 run_fio --name=job --filename=${dev} --offset=${off} --bs=64K \
1046 --size=$((16 * zone_size)) "$(ioengine "libaio")" --rw=randread\
1047 --time_based --runtime=3 --zonemode=zbd --zonesize=${zone_size}\
1048 --direct=1 --group_reporting=1 ${job_var_opts[@]} \
1049 >> "${logfile}.${test_number}" 2>&1 || return $?
1052 # Verify that conv zones are neither locked nor opened during random write on
1053 # conv-seq mixed zones. Zone lock and zone open shall happen only on seq zones.
1058 require_zbd || return $SKIP_TESTCASE
1059 require_conv_zones 8 || return $SKIP_TESTCASE
1060 require_seq_zones 8 || return $SKIP_TESTCASE
1064 off=$((first_sequential_zone_sector * 512 - 8 * zone_size))
1065 opts+=("--size=$((16 * zone_size))" "$(ioengine "libaio")")
1066 opts+=("--zonemode=zbd" "--direct=1" "--zonesize=${zone_size}")
1067 opts+=("--max_open_zones=2" "--offset=$off")
1068 opts+=("--thread=1" "--group_reporting=1")
1069 opts+=("--time_based" "--runtime=30" "--rw=randwrite")
1070 for ((i=0;i<jobs;i++)); do
1071 opts+=("--name=job${i}" "--filename=$dev")
1072 opts+=("--bs=$(((i+1)*16))K")
1073 opts+=($(job_var_opts_exclude "--max_open_zones"))
1075 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
1078 # Verify that zone_reset_threshold only takes logical blocks from seq
1079 # zones into account, and logical blocks of conv zones are not counted.
1083 require_zbd || return $SKIP_TESTCASE
1084 require_conv_zones 8 || return $SKIP_TESTCASE
1085 require_seq_zones 8 || return $SKIP_TESTCASE
1087 reset_zone "${dev}" -1
1089 # Total I/O size is 1/8 = 0.125 of the I/O range of cont + seq zones.
1090 # Set zone_reset_threshold as 0.1. The threshold size is less than
1091 # 0.125, then, reset count zero is expected.
1092 # On the other hand, half of the I/O range is covered by conv zones.
1093 # If fio would count the conv zones for zone_reset_threshold, the ratio
1094 # were more than 0.5 and would trigger zone resets.
1096 off=$((first_sequential_zone_sector * 512 - 8 * zone_size))
1097 io_size=$((zone_size * 16 / 8))
1098 run_fio --name=job --filename=$dev --rw=randwrite --bs=$((zone_size/16))\
1099 --size=$((zone_size * 16)) --softrandommap=1 \
1100 --io_size=$((io_size)) "$(ioengine "psync")" --offset=$off \
1101 --zonemode=zbd --direct=1 --zonesize=${zone_size} \
1102 --zone_reset_threshold=.1 --zone_reset_frequency=1.0 \
1103 ${job_var_opts[@]} --debug=zbd \
1104 >> "${logfile}.${test_number}" 2>&1 || return $?
1106 check_written ${io_size} || return $?
1107 check_reset_count -eq 0 || return $?
1110 # Check both reads and writes are executed by random I/O to conventional zones.
1112 local off capacity io read_b=0 written_b=0
1114 require_zbd || return $SKIP_TESTCASE
1115 require_conv_zones 4 || return $SKIP_TESTCASE
1117 off=$((first_sequential_zone_sector * 512 - 4 * zone_size))
1118 capacity=$(total_zone_capacity 4 $off $dev)
1119 run_fio --name=job --filename=${dev} --rw=randrw --bs=64K \
1120 --size=$((4 * zone_size)) "$(ioengine "psync")" --offset=${off}\
1121 --zonemode=zbd --direct=1 --zonesize=${zone_size} \
1122 ${job_var_opts[@]} \
1123 >> "${logfile}.${test_number}" 2>&1 || return $?
1125 written_b=$(fio_written <"${logfile}.${test_number}")
1126 read_b=$(fio_read <"${logfile}.${test_number}")
1127 io=$((written_b + read_b))
1128 echo "Number of bytes read: $read_b" >>"${logfile}.${test_number}"
1129 echo "Number of bytes written: $written_b" >>"${logfile}.${test_number}"
1130 echo "Total number of bytes read and written: $io <> $capacity" \
1131 >>"${logfile}.${test_number}"
1132 if ((io==capacity && written_b != 0 && read_b != 0)); then
1138 # Test read/write mix with verify.
1140 require_zbd || return $SKIP_TESTCASE
1141 require_seq_zones 8 || return $SKIP_TESTCASE
1143 run_fio --name=job --filename=${dev} "$(ioengine "libaio")" \
1144 --time_based=1 --runtime=30s --continue_on_error=0 \
1145 --offset=$((first_sequential_zone_sector * 512)) \
1146 --size=$((8*zone_size)) --direct=1 --iodepth=1 \
1147 --rw=randrw:2 --rwmixwrite=25 --bsrange=4k-${zone_size} \
1148 --zonemode=zbd --zonesize=${zone_size} \
1149 --verify=crc32c --do_verify=1 --verify_backlog=2 \
1150 --experimental_verify=1 \
1151 --alloc-size=65536 --random_generator=tausworthe64 \
1152 ${job_var_opts[@]} --debug=zbd \
1153 >> "${logfile}.${test_number}" 2>&1 || return $?
1156 # test 'z' suffix parsing only
1159 bs=$((logical_block_size))
1161 require_zbd || return $SKIP_TESTCASE
1162 # offset=1z + offset_increment=10z + size=2z
1163 require_seq_zones 13 || return $SKIP_TESTCASE
1168 "$(ioengine "psync")" \
1170 --zonesize=${zone_size} \
1174 --offset_increment=10z \
1178 ${job_var_opts[@]} --debug=zbd \
1179 >> "${logfile}.${test_number}" 2>&1 || return $?
1182 # test 'z' suffix parsing only
1185 bs=$((logical_block_size))
1187 require_regular_block_dev || return $SKIP_TESTCASE
1188 require_seq_zones 10 || return $SKIP_TESTCASE
1193 "$(ioengine "psync")" \
1194 --zonemode=strided \
1195 --zonesize=${zone_size} \
1200 ${job_var_opts[@]} --debug=zbd \
1201 >> "${logfile}.${test_number}" 2>&1 || return $?
1204 # Test that repeated async write job does not cause zone reset during writes
1205 # in-flight, when the block size is not a divisor of the zone size.
1209 require_zbd || return $SKIP_TESTCASE
1212 off=$((first_sequential_zone_sector * 512))
1214 run_fio --name=job --filename="${dev}" --rw=randwrite --bs="${bs}" \
1215 --offset="${off}" --size=$((4 * zone_size)) --iodepth=256 \
1216 "$(ioengine "libaio")" --time_based=1 --runtime=30s \
1217 --zonemode=zbd --direct=1 --zonesize="${zone_size}" \
1218 ${job_var_opts[@]} \
1219 >> "${logfile}.${test_number}" 2>&1 || return $?
1231 while [ "${1#-}" != "$1" ]; do
1233 -d) dynamic_analyzer=(valgrind "--read-var-info=yes" "--tool=drd"
1234 "--show-confl-seg=no");
1236 -e) dynamic_analyzer=(valgrind "--read-var-info=yes" "--tool=helgrind");
1238 -l) use_libzbc=1; shift;;
1239 -r) reset_all_zones=1; shift;;
1240 -t) tests+=("$2"); shift; shift;;
1241 -o) max_open_zones_opt="${2}"; shift; shift;;
1242 -v) dynamic_analyzer=(valgrind "--read-var-info=yes");
1244 -q) quit_on_err=1; shift;;
1245 -z) zbd_debug=1; shift;;
1251 if [ $# != 1 ]; then
1256 # shellcheck source=functions
1257 source "$(dirname "$0")/functions" || exit $?
1261 if [ -n "$zbd_debug" ]; then
1262 global_var_opts+=("--debug=zbd")
1265 realdev=$(readlink -f "$dev")
1266 basename=$(basename "$realdev")
1268 if [[ -b "$realdev" ]]; then
1269 major=$((0x$(stat -L -c '%t' "$realdev"))) || exit $?
1270 minor=$((0x$(stat -L -c '%T' "$realdev"))) || exit $?
1271 disk_size=$(($(<"/sys/dev/block/$major:$minor/size")*512))
1273 # When the target is a partition device, get basename of its
1274 # holder device to access sysfs path of the holder device
1275 if [[ -r "/sys/dev/block/$major:$minor/partition" ]]; then
1276 realsysfs=$(readlink "/sys/dev/block/$major:$minor")
1277 basename=$(basename "${realsysfs%/*}")
1279 logical_block_size=$(<"/sys/block/$basename/queue/logical_block_size")
1280 case "$(<"/sys/class/block/$basename/queue/zoned")" in
1281 host-managed|host-aware)
1283 if ! check_blkzone "${dev}"; then
1286 if ! result=($(first_sequential_zone "$dev")); then
1287 echo "Failed to determine first sequential zone"
1290 first_sequential_zone_sector=${result[0]}
1291 sectors_per_zone=${result[1]}
1292 zone_size=$((sectors_per_zone * 512))
1293 if ! max_open_zones=$(max_open_zones "$dev"); then
1294 echo "Failed to determine maximum number of open zones"
1297 set_io_scheduler "$basename" deadline || exit $?
1298 if [ -n "$reset_all_zones" ]; then
1299 reset_zone "$dev" -1
1303 first_sequential_zone_sector=$(((disk_size / 2) &
1304 (logical_block_size - 1)))
1305 zone_size=$(max 65536 "$logical_block_size")
1306 sectors_per_zone=$((zone_size / 512))
1308 set_io_scheduler "$basename" none || exit $?
1311 elif [[ -c "$realdev" ]]; then
1312 # For an SG node, we must have libzbc option specified
1313 if [[ ! -n "$use_libzbc" ]]; then
1314 echo "Character device files can only be used with -l (libzbc) option"
1318 if ! $(is_zbc "$dev"); then
1319 echo "Device is not a ZBC disk"
1324 if ! disk_size=($(( $(zbc_disk_sectors "$dev") * 512))); then
1325 echo "Failed to determine disk size"
1328 if ! logical_block_size=($(zbc_logical_block_size "$dev")); then
1329 echo "Failed to determine logical block size"
1332 if ! result=($(first_sequential_zone "$dev")); then
1333 echo "Failed to determine first sequential zone"
1336 first_sequential_zone_sector=${result[0]}
1337 sectors_per_zone=${result[1]}
1338 zone_size=$((sectors_per_zone * 512))
1339 if ! max_open_zones=$(max_open_zones "$dev"); then
1340 echo "Failed to determine maximum number of open zones"
1343 if [ -n "$reset_all_zones" ]; then
1344 reset_zone "$dev" -1
1348 if [[ -n ${max_open_zones_opt} ]]; then
1349 # Override max_open_zones with the script option value
1350 max_open_zones="${max_open_zones_opt}"
1351 global_var_opts+=("--ignore_zone_limits=1")
1352 job_var_opts+=("--max_open_zones=${max_open_zones_opt}")
1355 echo -n "First sequential zone starts at sector $first_sequential_zone_sector;"
1356 echo " zone size: $((zone_size >> 20)) MB"
1358 if [ "${#tests[@]}" = 0 ]; then
1359 readarray -t tests < <(declare -F | grep "test[0-9]*" | \
1360 tr -c -d "[:digit:]\n" | sort -n)
1381 trap 'intr=1' SIGINT
1384 for test_number in "${tests[@]}"; do
1385 rm -f "${logfile}.${test_number}"
1387 echo -n "Running test $(printf "%02d" $test_number) ... "
1388 eval "test$test_number"
1390 if ((!ret)) && check_log $test_number; then
1392 cc_status="${green}${status}${end}"
1394 elif ((ret==SKIP_TESTCASE)); then
1396 echo "${SKIP_REASON}" >> "${logfile}.${test_number}"
1397 cc_status="${cyan}${status}${end} ${SKIP_REASON}"
1401 cc_status="${red}${status}${end}"
1405 echo -e "$cc_status"
1406 echo "$status" >> "${logfile}.${test_number}"
1407 [ $intr -ne 0 ] && exit 1
1408 [ -n "$quit_on_err" -a "$rc" -ne 0 ] && exit 1
1411 echo "$passed tests passed"
1412 if [ $skipped -gt 0 ]; then
1413 echo " $skipped tests skipped"
1415 if [ $failed -gt 0 ]; then
1416 echo " $failed tests failed"
1418 echo "Run time: $(TZ=UTC0 printf "%(%H:%M:%S)T\n" $(( SECONDS )) )"