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")
314 opts+=(--bs="$(min $((logical_block_size * 256)) $size)")
315 opts+=("--size=$size" "--thread=1" "--read_beyond_wp=1")
316 opts+=("$(ioengine "psync")" "--rw=read" "--direct=1" "--disable_lat=1")
317 opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
318 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
319 check_read $size || return $?
322 # Sequential write to sequential zones.
324 local size off capacity
327 off=$((first_sequential_zone_sector * 512))
328 capacity=$(total_zone_capacity 4 $off $dev)
329 size=$((4 * zone_size))
330 run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=write \
331 --bs="$(max $((zone_size / 64)) "$logical_block_size")"\
332 --do_verify=1 --verify=md5 \
333 >>"${logfile}.${test_number}" 2>&1 || return $?
334 check_written $capacity || return $?
335 check_read $capacity || return $?
338 # Sequential read from sequential zones.
340 local size off capacity
343 off=$((first_sequential_zone_sector * 512))
344 capacity=$(total_zone_capacity 4 $off $dev)
345 size=$((4 * zone_size))
346 write_and_run_one_fio_job \
347 $((first_sequential_zone_sector * 512)) "${size}" \
349 --size="${size}" --zonemode=zbd --zonesize="${zone_size}" \
350 "$(ioengine "psync")" --iodepth=1 --rw=read \
351 --bs="$(max $((zone_size / 64)) "$logical_block_size")" \
352 >>"${logfile}.${test_number}" 2>&1 || return $?
353 check_read $capacity || return $?
356 # Random write to sequential zones, libaio, queue depth 1.
358 local size=$((zone_size))
362 off=$((first_sequential_zone_sector * 512))
363 capacity=$(total_zone_capacity 1 $off $dev)
364 run_fio_on_seq "$(ioengine "libaio")" --iodepth=1 --rw=randwrite \
365 --bs="$(min 16384 "${zone_size}")" \
366 --do_verify=1 --verify=md5 --size="$size" \
367 >>"${logfile}.${test_number}" 2>&1 || return $?
368 check_written $capacity || return $?
369 check_read $capacity || return $?
372 # Random write to sequential zones, libaio, queue depth 64.
374 local size off capacity
377 size=$((4 * zone_size))
378 off=$((first_sequential_zone_sector * 512))
379 capacity=$(total_zone_capacity 4 $off $dev)
380 run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite \
381 --bs="$(min 16384 "${zone_size}")" \
382 --do_verify=1 --verify=md5 \
383 >>"${logfile}.${test_number}" 2>&1 || return $?
384 check_written $capacity || return $?
385 check_read $capacity || return $?
388 # Random write to sequential zones, sg, queue depth 1.
392 require_scsi_dev || return $SKIP_TESTCASE
395 size=$((4 * zone_size))
396 run_fio_on_seq --ioengine=sg \
397 --iodepth=1 --rw=randwrite --bs=16K \
398 --do_verify=1 --verify=md5 \
399 >>"${logfile}.${test_number}" 2>&1 || return $?
400 check_written $size || return $?
401 check_read $size || return $?
404 # Random write to sequential zones, sg, queue depth 64.
408 require_scsi_dev || return $SKIP_TESTCASE
411 size=$((4 * zone_size))
412 run_fio_on_seq --ioengine=sg \
413 --iodepth=64 --rw=randwrite --bs=16K \
414 --do_verify=1 --verify=md5 \
415 >>"${logfile}.${test_number}" 2>&1 || return $?
416 check_written $size || return $?
417 check_read $size || return $?
420 # Random write to sequential zones, libaio, queue depth 64, random block size.
422 local size off capacity
425 size=$((4 * zone_size))
426 off=$((first_sequential_zone_sector * 512))
427 capacity=$(total_zone_capacity 4 $off $dev)
428 run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite \
429 --bsrange=4K-64K --do_verify=1 --verify=md5 \
430 --debug=zbd >>"${logfile}.${test_number}" 2>&1 || return $?
431 check_written $capacity || return $?
432 check_read $capacity || return $?
435 # Random write to sequential zones, libaio, queue depth 64, max 1 open zone.
437 local size off capacity
440 size=$((8 * zone_size))
441 off=$((first_sequential_zone_sector * 512))
442 capacity=$(total_zone_capacity 8 $off $dev)
443 run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=16K \
444 --max_open_zones=1 --size=$size --do_verify=1 --verify=md5 \
445 --debug=zbd >>"${logfile}.${test_number}" 2>&1 || return $?
446 check_written $capacity || return $?
447 check_read $capacity || return $?
450 # Random write to sequential zones, libaio, queue depth 64, max 4 open zones.
452 local size off capacity
455 size=$((8 * zone_size))
456 off=$((first_sequential_zone_sector * 512))
457 capacity=$(total_zone_capacity 8 $off $dev)
458 run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=16K \
459 --max_open_zones=4 --size=$size --do_verify=1 --verify=md5 \
461 >>"${logfile}.${test_number}" 2>&1 || return $?
462 check_written $capacity || return $?
463 check_read $capacity || return $?
466 # Random write to conventional zones.
470 if ! result=($(first_online_zone "$dev")); then
471 echo "Failed to determine first online zone"
476 size=$((16 * 2**20)) # 20 MB
477 require_conv_zone_bytes "${size}" || return $SKIP_TESTCASE
479 run_one_fio_job "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=16K \
480 --zonemode=zbd --zonesize="${zone_size}" --do_verify=1 \
481 --verify=md5 --offset=$off --size=$size\
482 >>"${logfile}.${test_number}" 2>&1 || return $?
483 check_written $((size)) || return $?
484 check_read $((size)) || return $?
487 # Sequential read on a mix of empty and full zones.
490 local w_off w_size w_capacity
492 for ((i=0;i<4;i++)); do
494 reset_zone "$dev" $((first_sequential_zone_sector +
498 w_off=$(((first_sequential_zone_sector + 2 * sectors_per_zone) * 512))
499 w_size=$((2 * zone_size))
500 w_capacity=$(total_zone_capacity 2 $w_off $dev)
501 off=$((first_sequential_zone_sector * 512))
502 size=$((4 * zone_size))
503 write_and_run_one_fio_job "${w_off}" "${w_size}" \
504 "$(ioengine "psync")" --rw=read --bs=$((zone_size / 16)) \
505 --zonemode=zbd --zonesize="${zone_size}" --offset=$off \
506 --size=$((size)) >>"${logfile}.${test_number}" 2>&1 ||
508 check_written $((w_capacity)) || return $?
509 check_read $((w_capacity))
512 # Random read on a mix of empty and full zones.
515 local i w_off w_size w_capacity
517 for ((i=0;i<4;i++)); do
519 reset_zone "$dev" $((first_sequential_zone_sector +
523 w_off=$(((first_sequential_zone_sector + 2 * sectors_per_zone) * 512))
524 w_size=$((2 * zone_size))
525 w_capacity=$(total_zone_capacity 2 $w_off $dev)
526 off=$((first_sequential_zone_sector * 512))
527 size=$((4 * zone_size))
528 write_and_run_one_fio_job "${w_off}" "${w_size}" \
529 "$(ioengine "libaio")" --iodepth=64 --rw=randread --bs=16K \
530 --zonemode=zbd --zonesize="${zone_size}" --offset=$off \
531 --size=$size >>"${logfile}.${test_number}" 2>&1 || return $?
532 check_written $w_capacity || return $?
533 check_read $size || return $?
536 # Random reads and writes in the last zone.
538 local io off last read size written
540 off=$(((disk_size / zone_size - 1) * zone_size))
541 size=$((disk_size - off))
542 if ! last=($(last_online_zone "$dev")); then
543 echo "Failed to determine last online zone"
546 if [[ "$((last * 512))" -lt "$off" ]]; then
550 if [ -n "$is_zbd" ]; then
551 reset_zone "$dev" $((off / 512)) || return $?
554 run_one_fio_job "$(ioengine "libaio")" --iodepth=8 --rw=randrw --bs=4K \
555 --zonemode=zbd --zonesize="${zone_size}" \
556 --offset=$off --loops=2 --norandommap=1 \
558 >>"${logfile}.${test_number}" 2>&1 || return $?
559 written=$(fio_written <"${logfile}.${test_number}")
560 read=$(fio_read <"${logfile}.${test_number}")
561 io=$((written + read))
562 echo "Total number of bytes read and written: $io <> $size" \
563 >>"${logfile}.${test_number}"
564 [ $io = $((size * 2)) ];
567 # Out-of-range zone reset threshold and frequency parameters.
569 run_fio_on_seq --zone_reset_threshold=-1 |&
570 tee -a "${logfile}.${test_number}" |
571 grep -q 'value out of range' || return $?
575 run_fio_on_seq --zone_reset_threshold=2 |&
576 tee -a "${logfile}.${test_number}" |
577 grep -q 'value out of range' || return $?
581 run_fio_on_seq --zone_reset_threshold=.4:.6 |&
582 tee -a "${logfile}.${test_number}" |
583 grep -q 'the list exceeding max length' || return $?
587 run_fio_on_seq --zone_reset_frequency=-1 |&
588 tee -a "${logfile}.${test_number}" |
589 grep -q 'value out of range' || return $?
593 run_fio_on_seq --zone_reset_frequency=2 |&
594 tee -a "${logfile}.${test_number}" |
595 grep -q 'value out of range' || return $?
599 run_fio_on_seq --zone_reset_frequency=.4:.6 |&
600 tee -a "${logfile}.${test_number}" |
601 grep -q 'the list exceeding max length' || return $?
605 local bs loops=9 size=$((zone_size))
609 off=$((first_sequential_zone_sector * 512))
610 capacity=$(total_zone_capacity 1 $off $dev)
612 bs=$(min $((256*1024)) "$zone_size")
613 run_fio_on_seq "$(ioengine "psync")" --rw=write --bs="$bs" \
614 --size=$size --loops=$loops \
615 --zone_reset_frequency=.01 --zone_reset_threshold=.90 \
616 >> "${logfile}.${test_number}" 2>&1 || return $?
617 check_written $((capacity * loops)) || return $?
618 check_reset_count -eq 8 ||
619 check_reset_count -eq 9 ||
620 check_reset_count -eq 10 || return $?
623 # Multiple non-overlapping sequential write jobs for the same drive.
627 for ((i=0;i<16;i++)); do
629 reset_zone "$dev" $((first_sequential_zone_sector + i*sectors_per_zone))
632 for ((i=0;i<16;i++)); do
633 opts+=("--name=job$i" "--filename=$dev" "--thread=1" "--direct=1")
634 opts+=("--offset=$((first_sequential_zone_sector*512 + zone_size*i))")
635 opts+=("--size=$zone_size" "$(ioengine "psync")" "--rw=write" "--bs=16K")
636 opts+=("--zonemode=zbd" "--zonesize=${zone_size}" "--group_reporting=1")
637 opts+=(${job_var_opts[@]})
639 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
642 write_to_first_seq_zone() {
647 off=$((first_sequential_zone_sector * 512))
648 capacity=$(total_zone_capacity 1 $off $dev)
650 r=$(((RANDOM << 16) | RANDOM))
651 run_fio --name="$dev" --filename="$dev" "$(ioengine "psync")" --rw="$1" \
652 --thread=1 --do_verify=1 --verify=md5 --direct=1 --bs=4K \
654 --size=$zone_size --loops=$loops --randseed="$r" \
655 --zonemode=zbd --zonesize="${zone_size}" --group_reporting=1 \
656 --gtod_reduce=1 >> "${logfile}.${test_number}" 2>&1 || return $?
657 check_written $((loops * capacity)) || return $?
660 # Overwrite the first sequential zone four times sequentially.
662 write_to_first_seq_zone write
665 # Overwrite the first sequential zone four times using random writes.
667 write_to_first_seq_zone randwrite
670 # Multiple overlapping random write jobs for the same drive.
672 local i jobs=16 off opts
674 require_seq_zones 65 || return $SKIP_TESTCASE
675 off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
676 [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
679 capacity=$(total_zone_capacity 1 $off $dev)
680 for ((i=0;i<jobs;i++)); do
681 opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
682 opts+=("--size=$zone_size" "--io_size=$capacity" "$(ioengine "psync")" "--rw=randwrite")
683 opts+=("--thread=1" "--direct=1" "--zonemode=zbd")
684 opts+=("--zonesize=${zone_size}" "--group_reporting=1")
685 opts+=(${job_var_opts[@]})
687 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
688 check_written $((jobs * $capacity)) || return $?
689 check_reset_count -eq $jobs ||
690 check_reset_count -eq $((jobs - 1)) ||
694 # Multiple overlapping random write jobs for the same drive and with a limited
695 # number of open zones.
697 local i jobs=16 off opts=()
699 require_seq_zones 80 || return $SKIP_TESTCASE
700 off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
701 size=$((16*zone_size))
704 for ((i=0;i<jobs;i++)); do
705 opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
706 opts+=("--size=$size" "--io_size=$zone_size" "--thread=1")
707 opts+=("$(ioengine "psync")" "--rw=randwrite" "--direct=1")
708 opts+=("--max_open_zones=4" "--group_reporting=1")
709 opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
710 # max_open_zones is already specified
711 opts+=($(job_var_opts_exclude "--max_open_zones"))
713 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
714 check_written $((jobs * zone_size)) || return $?
717 # Random reads and writes across the entire disk for 30s.
722 off=$((first_sequential_zone_sector * 512))
723 run_one_fio_job "$(ioengine "libaio")" --iodepth=8 --rw=randrw \
724 --bs="$(max $((zone_size / 128)) "$logical_block_size")"\
725 --zonemode=zbd --zonesize="${zone_size}" --offset=$off\
726 --loops=2 --time_based --runtime=30s --norandommap=1\
727 >>"${logfile}.${test_number}" 2>&1
730 # Random reads across all sequential zones for 30s. This is not only a fio
731 # test but also allows to verify the performance of a drive.
733 local bs inc nz off opts size
735 [ -n "$is_zbd" ] && reset_zone "$dev" -1
737 # As preparation, write 128 KB to sequential write required zones. Limit
738 # write target zones up to max_open_zones to keep test time reasonable.
739 # To distribute the write target zones evenly, skip certain zones for every
740 # write. Utilize zonemode strided for such write patterns.
742 nz=$((max_open_zones))
743 if [[ $nz -eq 0 ]]; then
746 off=$((first_sequential_zone_sector * 512))
747 size=$((disk_size - off))
748 inc=$(((size / nz / zone_size) * zone_size))
749 opts=("--name=$dev" "--filename=$dev" "--rw=write" "--bs=${bs}")
750 opts+=("--offset=$off" "--size=$((inc * nz))" "--io_size=$((bs * nz))")
751 opts+=("--zonemode=strided" "--zonesize=${bs}" "--zonerange=${inc}")
753 echo "fio ${opts[@]}" >> "${logfile}.${test_number}"
754 "$(dirname "$0")/../../fio" "${opts[@]}" >> "${logfile}.${test_number}" 2>&1
756 # Next, run the test.
757 opts=("--name=$dev" "--filename=$dev" "--offset=$off" "--size=$size")
758 opts+=("--bs=$bs" "$(ioengine "psync")" "--rw=randread" "--direct=1")
759 opts+=("--thread=1" "--time_based" "--runtime=30" "--zonemode=zbd")
760 opts+=("--zonesize=${zone_size}")
761 opts+=(${job_var_opts[@]})
762 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
765 # Random writes across all sequential zones. This is not only a fio test but
766 # also allows to verify the performance of a drive.
768 local off opts=() size
770 require_zbd || return $SKIP_TESTCASE
773 off=$((first_sequential_zone_sector * 512))
774 size=$((disk_size - off))
775 opts+=("--name=$dev" "--filename=$dev" "--offset=$off" "--size=$size")
776 opts+=("--bs=128K" "$(ioengine "psync")" "--rw=randwrite" "--direct=1")
777 opts+=("--thread=1" "--time_based" "--runtime=30")
778 opts+=("--max_open_zones=$max_open_zones" "--zonemode=zbd")
779 opts+=("--zonesize=${zone_size}")
780 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
783 # Write to sequential zones with a block size that is not a divisor of the
786 local bs io_size size
787 local off capacity=0;
790 off=$((first_sequential_zone_sector * 512))
791 capacity=$(total_zone_capacity 1 $off $dev)
792 size=$((2 * zone_size))
793 io_size=$((5 * capacity))
794 bs=$((3 * capacity / 4))
795 run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=write \
796 --size=$size --io_size=$io_size --bs=$bs \
797 >> "${logfile}.${test_number}" 2>&1 || return $?
798 check_written $(((io_size + bs - 1) / bs * bs)) || return $?
801 # Write to sequential zones with a block size that is not a divisor of the
802 # zone size and with data verification enabled.
807 size=$((2 * zone_size))
808 run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=write --size=$size \
809 --do_verify=1 --verify=md5 --bs=$((3 * zone_size / 4)) \
810 >> "${logfile}.${test_number}" 2>&1 && return 1
811 grep -q 'not a divisor of' "${logfile}.${test_number}"
814 # Test 1/4 for the I/O boundary rounding code: $size < $zone_size.
816 local bs off io_size size
819 off=$(((first_sequential_zone_sector + 1) * 512))
820 size=$((zone_size - 2 * 512))
821 bs=$((zone_size / 4))
822 run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")" \
823 --iodepth=1 --rw=write --do_verify=1 --verify=md5 \
824 --bs=$bs --zonemode=zbd --zonesize="${zone_size}" \
825 >> "${logfile}.${test_number}" 2>&1 && return 1
826 grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
829 # Test 2/4 for the I/O boundary rounding code: $size < $zone_size.
831 local bs off io_size size
834 off=$(((first_sequential_zone_sector) * 512))
835 size=$((zone_size - 512))
836 bs=$((zone_size / 4))
837 run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")" \
838 --iodepth=1 --rw=write --do_verify=1 --verify=md5 \
839 --bs=$bs --zonemode=zbd --zonesize="${zone_size}" \
840 >> "${logfile}.${test_number}" 2>&1 && return 1
841 grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
844 # Test 3/4 for the I/O boundary rounding code: $size > $zone_size.
846 local bs off size capacity
849 capacity=$(total_zone_capacity 1 $((first_sequential_zone_sector*512)) $dev)
850 if [ "$first_sequential_zone_sector" = 0 ]; then
853 off=$(((first_sequential_zone_sector - 1) * 512))
855 size=$((zone_size + 2 * 512))
856 bs=$((zone_size / 4))
857 run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")" \
858 --iodepth=1 --rw=write --do_verify=1 --verify=md5 \
859 --bs=$bs --zonemode=zbd --zonesize="${zone_size}" \
860 >> "${logfile}.${test_number}" 2>&1
861 check_written $capacity || return $?
864 # Test 4/4 for the I/O boundary rounding code: $offset > $disk_size - $zone_size
869 size=$((logical_block_size))
870 off=$((disk_size - logical_block_size))
871 bs=$((logical_block_size))
872 run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")" \
873 --iodepth=1 --rw=write --do_verify=1 --verify=md5 \
874 --bs=$bs --zonemode=zbd --zonesize="${zone_size}" \
875 >> "${logfile}.${test_number}" 2>&1 && return 1
876 grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
879 # Read one block from a block device.
884 if ! result=($(first_online_zone "$dev")); then
885 echo "Failed to determine first online zone"
889 bs=$((logical_block_size))
890 run_one_fio_job --rw=read "$(ioengine "psync")" --offset=$off --bs=$bs \
891 --size=$bs "$@" 2>&1 |
892 tee -a "${logfile}.${test_number}"
895 # Check whether fio accepts --zonemode=none for zoned block devices.
897 require_zbd || return $SKIP_TESTCASE
898 read_one_block --zonemode=none >/dev/null || return $?
899 check_read $((logical_block_size)) || return $?
902 # Check whether fio accepts --zonemode=strided for zoned block devices.
906 bs=$((logical_block_size))
907 require_zbd || return $SKIP_TESTCASE
908 read_one_block --zonemode=strided |
909 grep -q 'fio: --zonesize must be specified when using --zonemode=strided' ||
911 read_one_block --zonemode=strided --zonesize=$bs >/dev/null || return $?
912 check_read $bs || return $?
915 # Check whether fio checks the zone size for zoned block devices.
917 require_zbd || return $SKIP_TESTCASE
918 read_one_block --zonemode=zbd --zonesize=$((2 * zone_size)) |
919 grep -q 'job parameter zonesize.*does not match disk zone size'
922 # Check whether fio handles --zonesize=0 correctly for regular block devices.
924 require_regular_block_dev || return $SKIP_TESTCASE
925 read_one_block --zonemode=zbd --zonesize=0 |
926 grep -q 'Specifying the zone size is mandatory for regular file/block device with --zonemode=zbd'
929 # Check whether fio handles --zonesize=1 correctly for regular block devices.
931 require_regular_block_dev || return $SKIP_TESTCASE
932 read_one_block --zonemode=zbd --zonesize=1 |
933 grep -q 'zone size must be at least 512 bytes for --zonemode=zbd'
936 # Check whether fio handles --zonemode=none --zonesize=1 correctly.
938 read_one_block --zonemode=none --zonesize=1 |
939 grep -q 'fio: --zonemode=none and --zonesize are not compatible'
945 require_zbd || return $SKIP_TESTCASE
947 bs=$((logical_block_size))
948 run_one_fio_job "$(ioengine "psync")" --iodepth=1 --rw=randwrite --bs=$bs\
949 --offset=$((first_sequential_zone_sector * 512)) \
950 --size="$zone_size" --do_verify=1 --verify=md5 2>&1 |
951 tee -a "${logfile}.${test_number}" |
952 grep -q "fio: first I/O failed. If .* is a zoned block device, consider --zonemode=zbd"
955 # Random write to sequential zones, libaio, 8 jobs, queue depth 64 per job
960 size=$((4 * zone_size))
961 run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=4K \
962 --group_reporting=1 --numjobs=8 \
963 >> "${logfile}.${test_number}" 2>&1 || return $?
964 check_written $((size * 8)) || return $?
967 # Check whether fio handles --zonemode=zbd --zoneskip=1 correctly.
972 bs=$((logical_block_size))
973 run_fio_on_seq "$(ioengine "psync")" --rw=write --bs=$bs --zoneskip=1 \
974 >> "${logfile}.${test_number}" 2>&1 && return 1
975 grep -q 'zoneskip 1 is not a multiple of the device zone size' "${logfile}.${test_number}"
978 # Multiple overlapping random write jobs for the same drive and with a
979 # limited number of open zones. This is similar to test29, but uses libaio
980 # to stress test zone locking.
982 local i jobs=16 off opts=()
984 require_zbd || return $SKIP_TESTCASE
985 require_seq_zones 80 || return $SKIP_TESTCASE
987 off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
988 size=$((16*zone_size))
990 opts=("--aux-path=/tmp" "--allow_file_create=0" "--significant_figures=10")
991 opts+=("--debug=zbd")
992 opts+=("$(ioengine "libaio")" "--rw=randwrite" "--direct=1")
993 opts+=("--time_based" "--runtime=30")
994 opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
995 opts+=("--max_open_zones=4")
996 for ((i=0;i<jobs;i++)); do
997 opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
998 opts+=("--io_size=$zone_size" "--iodepth=256" "--thread=1")
999 opts+=("--size=$size" "--group_reporting=1")
1000 # max_open_zones is already specified
1001 opts+=($(job_var_opts_exclude "--max_open_zones"))
1004 fio=$(dirname "$0")/../../fio
1006 { echo; echo "fio ${opts[*]}"; echo; } >>"${logfile}.${test_number}"
1008 timeout -v -s KILL 180s \
1009 "${dynamic_analyzer[@]}" "$fio" "${opts[@]}" \
1010 >> "${logfile}.${test_number}" 2>&1 || return $?
1013 # Check if fio handles --zonecapacity on a normal block device correctly
1016 require_regular_block_dev || return $SKIP_TESTCASE
1018 size=$((2 * zone_size))
1019 capacity=$((zone_size * 3 / 4))
1021 run_one_fio_job "$(ioengine "psync")" --rw=write \
1022 --zonemode=zbd --zonesize="${zone_size}" \
1023 --zonecapacity=${capacity} \
1024 --verify=md5 --size=${size} >>"${logfile}.${test_number}" 2>&1 ||
1026 check_written $((capacity * 2)) || return $?
1027 check_read $((capacity * 2)) || return $?
1030 # Verify that conv zones are not locked and only seq zones are locked during
1031 # random read on conv-seq mixed zones.
1035 require_zbd || return $SKIP_TESTCASE
1036 require_conv_zones 8 || return $SKIP_TESTCASE
1037 require_seq_zones 8 || return $SKIP_TESTCASE
1039 reset_zone "${dev}" -1
1041 off=$((first_sequential_zone_sector * 512 - 8 * zone_size))
1042 run_fio --name=job --filename=${dev} --offset=${off} --bs=64K \
1043 --size=$((16 * zone_size)) "$(ioengine "libaio")" --rw=randread\
1044 --time_based --runtime=3 --zonemode=zbd --zonesize=${zone_size}\
1045 --direct=1 --group_reporting=1 ${job_var_opts[@]} \
1046 >> "${logfile}.${test_number}" 2>&1 || return $?
1049 # Verify that conv zones are neither locked nor opened during random write on
1050 # conv-seq mixed zones. Zone lock and zone open shall happen only on seq zones.
1055 require_zbd || return $SKIP_TESTCASE
1056 require_conv_zones 8 || return $SKIP_TESTCASE
1057 require_seq_zones 8 || return $SKIP_TESTCASE
1061 off=$((first_sequential_zone_sector * 512 - 8 * zone_size))
1062 opts+=("--size=$((16 * zone_size))" "$(ioengine "libaio")")
1063 opts+=("--zonemode=zbd" "--direct=1" "--zonesize=${zone_size}")
1064 opts+=("--max_open_zones=2" "--offset=$off")
1065 opts+=("--thread=1" "--group_reporting=1")
1066 opts+=("--time_based" "--runtime=30" "--rw=randwrite")
1067 for ((i=0;i<jobs;i++)); do
1068 opts+=("--name=job${i}" "--filename=$dev")
1069 opts+=("--bs=$(((i+1)*16))K")
1070 opts+=($(job_var_opts_exclude "--max_open_zones"))
1072 run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
1075 # Verify that zone_reset_threshold only takes logical blocks from seq
1076 # zones into account, and logical blocks of conv zones are not counted.
1080 require_zbd || return $SKIP_TESTCASE
1081 require_conv_zones 8 || return $SKIP_TESTCASE
1082 require_seq_zones 8 || return $SKIP_TESTCASE
1084 reset_zone "${dev}" -1
1086 # Total I/O size is 1/8 = 0.125 of the I/O range of cont + seq zones.
1087 # Set zone_reset_threshold as 0.1. The threshold size is less than
1088 # 0.125, then, reset count zero is expected.
1089 # On the other hand, half of the I/O range is covered by conv zones.
1090 # If fio would count the conv zones for zone_reset_threshold, the ratio
1091 # were more than 0.5 and would trigger zone resets.
1093 off=$((first_sequential_zone_sector * 512 - 8 * zone_size))
1094 io_size=$((zone_size * 16 / 8))
1095 run_fio --name=job --filename=$dev --rw=randwrite --bs=$((zone_size/16))\
1096 --size=$((zone_size * 16)) --softrandommap=1 \
1097 --io_size=$((io_size)) "$(ioengine "psync")" --offset=$off \
1098 --zonemode=zbd --direct=1 --zonesize=${zone_size} \
1099 --zone_reset_threshold=.1 --zone_reset_frequency=1.0 \
1100 ${job_var_opts[@]} --debug=zbd \
1101 >> "${logfile}.${test_number}" 2>&1 || return $?
1103 check_written ${io_size} || return $?
1104 check_reset_count -eq 0 || return $?
1107 # Check both reads and writes are executed by random I/O to conventional zones.
1109 local off capacity io read_b=0 written_b=0
1111 require_zbd || return $SKIP_TESTCASE
1112 require_conv_zones 4 || return $SKIP_TESTCASE
1114 off=$((first_sequential_zone_sector * 512 - 4 * zone_size))
1115 capacity=$(total_zone_capacity 4 $off $dev)
1116 run_fio --name=job --filename=${dev} --rw=randrw --bs=64K \
1117 --size=$((4 * zone_size)) "$(ioengine "psync")" --offset=${off}\
1118 --zonemode=zbd --direct=1 --zonesize=${zone_size} \
1119 ${job_var_opts[@]} \
1120 >> "${logfile}.${test_number}" 2>&1 || return $?
1122 written_b=$(fio_written <"${logfile}.${test_number}")
1123 read_b=$(fio_read <"${logfile}.${test_number}")
1124 io=$((written_b + read_b))
1125 echo "Number of bytes read: $read_b" >>"${logfile}.${test_number}"
1126 echo "Number of bytes written: $written_b" >>"${logfile}.${test_number}"
1127 echo "Total number of bytes read and written: $io <> $capacity" \
1128 >>"${logfile}.${test_number}"
1129 if ((io==capacity && written_b != 0 && read_b != 0)); then
1135 # Test read/write mix with verify.
1137 require_zbd || return $SKIP_TESTCASE
1138 require_seq_zones 8 || return $SKIP_TESTCASE
1140 run_fio --name=job --filename=${dev} "$(ioengine "libaio")" \
1141 --time_based=1 --runtime=30s --continue_on_error=0 \
1142 --offset=$((first_sequential_zone_sector * 512)) \
1143 --size=$((8*zone_size)) --direct=1 --iodepth=1 \
1144 --rw=randrw:2 --rwmixwrite=25 --bsrange=4k-${zone_size} \
1145 --zonemode=zbd --zonesize=${zone_size} \
1146 --verify=crc32c --do_verify=1 --verify_backlog=2 \
1147 --experimental_verify=1 \
1148 --alloc-size=65536 --random_generator=tausworthe64 \
1149 ${job_var_opts[@]} --debug=zbd \
1150 >> "${logfile}.${test_number}" 2>&1 || return $?
1153 # test 'z' suffix parsing only
1156 bs=$((logical_block_size))
1158 require_zbd || return $SKIP_TESTCASE
1159 # offset=1z + offset_increment=10z + size=2z
1160 require_seq_zones 13 || return $SKIP_TESTCASE
1165 "$(ioengine "psync")" \
1167 --zonesize=${zone_size} \
1171 --offset_increment=10z \
1175 ${job_var_opts[@]} --debug=zbd \
1176 >> "${logfile}.${test_number}" 2>&1 || return $?
1179 # test 'z' suffix parsing only
1182 bs=$((logical_block_size))
1184 require_regular_block_dev || return $SKIP_TESTCASE
1185 require_seq_zones 10 || return $SKIP_TESTCASE
1190 "$(ioengine "psync")" \
1191 --zonemode=strided \
1192 --zonesize=${zone_size} \
1197 ${job_var_opts[@]} --debug=zbd \
1198 >> "${logfile}.${test_number}" 2>&1 || return $?
1201 # Test that repeated async write job does not cause zone reset during writes
1202 # in-flight, when the block size is not a divisor of the zone size.
1206 require_zbd || return $SKIP_TESTCASE
1209 off=$((first_sequential_zone_sector * 512))
1211 run_fio --name=job --filename="${dev}" --rw=randwrite --bs="${bs}" \
1212 --offset="${off}" --size=$((4 * zone_size)) --iodepth=256 \
1213 "$(ioengine "libaio")" --time_based=1 --runtime=30s \
1214 --zonemode=zbd --direct=1 --zonesize="${zone_size}" \
1215 ${job_var_opts[@]} \
1216 >> "${logfile}.${test_number}" 2>&1 || return $?
1219 # Random writes and random trims to sequential write required zones for 30s.
1223 require_seq_zones 128 || return $SKIP_TESTCASE
1225 size=$((zone_size * 128))
1226 bs="$(max $((zone_size / 128)) "$logical_block_size")"
1228 off=$((first_sequential_zone_sector * 512))
1229 run_fio --zonemode=zbd --direct=1 --zonesize="${zone_size}" --thread=1 \
1230 --filename="${dev}" --norandommap=1 \
1231 --name="precondition" --rw=write "$(ioengine "psync")" \
1232 --offset="${off}" --size=$((zone_size * 16)) --bs="${bs}" \
1233 "${job_var_opts[@]}" \
1234 --name=wjob --wait_for="precondition" --rw=randwrite \
1235 "$(ioengine "libaio")" --iodepth=8 \
1236 --offset="${off}" --size="${size}" --bs="${bs}" \
1237 --time_based --runtime=30s --flow=128 "${job_var_opts[@]}" \
1238 --name=trimjob --wait_for="precondition" --rw=randtrim \
1239 "$(ioengine "psync")" \
1240 --offset="${off}" --size="${size}" --bs="${zone_size}" \
1241 --time_based --runtime=30s --flow=1 "${job_var_opts[@]}" \
1242 >>"${logfile}.${test_number}" 2>&1
1254 while [ "${1#-}" != "$1" ]; do
1256 -d) dynamic_analyzer=(valgrind "--read-var-info=yes" "--tool=drd"
1257 "--show-confl-seg=no");
1259 -e) dynamic_analyzer=(valgrind "--read-var-info=yes" "--tool=helgrind");
1261 -l) use_libzbc=1; shift;;
1262 -r) reset_all_zones=1; shift;;
1263 -t) tests+=("$2"); shift; shift;;
1264 -o) max_open_zones_opt="${2}"; shift; shift;;
1265 -v) dynamic_analyzer=(valgrind "--read-var-info=yes");
1267 -q) quit_on_err=1; shift;;
1268 -z) zbd_debug=1; shift;;
1274 if [ $# != 1 ]; then
1279 # shellcheck source=functions
1280 source "$(dirname "$0")/functions" || exit $?
1284 if [ -n "$zbd_debug" ]; then
1285 global_var_opts+=("--debug=zbd")
1288 realdev=$(readlink -f "$dev")
1289 basename=$(basename "$realdev")
1291 if [[ -b "$realdev" ]]; then
1292 major=$((0x$(stat -L -c '%t' "$realdev"))) || exit $?
1293 minor=$((0x$(stat -L -c '%T' "$realdev"))) || exit $?
1294 disk_size=$(($(<"/sys/dev/block/$major:$minor/size")*512))
1296 # When the target is a partition device, get basename of its
1297 # holder device to access sysfs path of the holder device
1298 if [[ -r "/sys/dev/block/$major:$minor/partition" ]]; then
1299 realsysfs=$(readlink "/sys/dev/block/$major:$minor")
1300 basename=$(basename "${realsysfs%/*}")
1302 logical_block_size=$(<"/sys/block/$basename/queue/logical_block_size")
1303 case "$(<"/sys/class/block/$basename/queue/zoned")" in
1304 host-managed|host-aware)
1306 if ! check_blkzone "${dev}"; then
1309 if ! result=($(first_sequential_zone "$dev")); then
1310 echo "Failed to determine first sequential zone"
1313 first_sequential_zone_sector=${result[0]}
1314 sectors_per_zone=${result[1]}
1315 zone_size=$((sectors_per_zone * 512))
1316 if ! max_open_zones=$(max_open_zones "$dev"); then
1317 echo "Failed to determine maximum number of open zones"
1320 set_io_scheduler "$basename" deadline || exit $?
1321 if [ -n "$reset_all_zones" ]; then
1322 reset_zone "$dev" -1
1326 first_sequential_zone_sector=$(((disk_size / 2) &
1327 (logical_block_size - 1)))
1328 zone_size=$(max 65536 "$logical_block_size")
1329 sectors_per_zone=$((zone_size / 512))
1331 set_io_scheduler "$basename" none || exit $?
1334 elif [[ -c "$realdev" ]]; then
1335 # For an SG node, we must have libzbc option specified
1336 if [[ ! -n "$use_libzbc" ]]; then
1337 echo "Character device files can only be used with -l (libzbc) option"
1341 if ! $(is_zbc "$dev"); then
1342 echo "Device is not a ZBC disk"
1347 if ! disk_size=($(( $(zbc_disk_sectors "$dev") * 512))); then
1348 echo "Failed to determine disk size"
1351 if ! logical_block_size=($(zbc_logical_block_size "$dev")); then
1352 echo "Failed to determine logical block size"
1355 if ! result=($(first_sequential_zone "$dev")); then
1356 echo "Failed to determine first sequential zone"
1359 first_sequential_zone_sector=${result[0]}
1360 sectors_per_zone=${result[1]}
1361 zone_size=$((sectors_per_zone * 512))
1362 if ! max_open_zones=$(max_open_zones "$dev"); then
1363 echo "Failed to determine maximum number of open zones"
1366 if [ -n "$reset_all_zones" ]; then
1367 reset_zone "$dev" -1
1371 if [[ -n ${max_open_zones_opt} ]]; then
1372 # Override max_open_zones with the script option value
1373 max_open_zones="${max_open_zones_opt}"
1374 global_var_opts+=("--ignore_zone_limits=1")
1375 job_var_opts+=("--max_open_zones=${max_open_zones_opt}")
1378 echo -n "First sequential zone starts at sector $first_sequential_zone_sector;"
1379 echo " zone size: $((zone_size >> 20)) MB"
1381 if [ "${#tests[@]}" = 0 ]; then
1382 readarray -t tests < <(declare -F | grep "test[0-9]*" | \
1383 tr -c -d "[:digit:]\n" | sort -n)
1404 trap 'intr=1' SIGINT
1407 for test_number in "${tests[@]}"; do
1408 rm -f "${logfile}.${test_number}"
1410 echo -n "Running test $(printf "%02d" $test_number) ... "
1411 eval "test$test_number"
1413 if ((!ret)) && check_log $test_number; then
1415 cc_status="${green}${status}${end}"
1417 elif ((ret==SKIP_TESTCASE)); then
1419 echo "${SKIP_REASON}" >> "${logfile}.${test_number}"
1420 cc_status="${cyan}${status}${end} ${SKIP_REASON}"
1424 cc_status="${red}${status}${end}"
1428 echo -e "$cc_status"
1429 echo "$status" >> "${logfile}.${test_number}"
1430 [ $intr -ne 0 ] && exit 1
1431 [ -n "$quit_on_err" -a "$rc" -ne 0 ] && exit 1
1434 echo "$passed tests passed"
1435 if [ $skipped -gt 0 ]; then
1436 echo " $skipped tests skipped"
1438 if [ $failed -gt 0 ]; then
1439 echo " $failed tests failed"
1441 echo "Run time: $(TZ=UTC0 printf "%(%H:%M:%S)T\n" $(( SECONDS )) )"