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. Must be run after test15.
 373 test16() {
 374     local off size
 375
 376     off=$((first_sequential_zone_sector * 512))
 377     size=$((4 * zone_size))
 378     run_one_fio_job "$(ioengine "libaio")" --iodepth=64 --rw=randread --bs=16K \
 379                     --zonemode=zbd --zonesize="${zone_size}" --offset=$off \
 380                     --size=$size >>"${logfile}.${test_number}" 2>&1 || return $?
 381     check_read $size || return $?
 382 }
 383
 384 # Random reads and writes in the last zone.
 385 test17() {
 386     local io off read size written
 387
 388     off=$(((disk_size / zone_size - 1) * zone_size))
 389     size=$((disk_size - off))
 390     # Overwrite the last zone to avoid that reading from that zone fails.
 391     if [ -n "$is_zbd" ]; then
 392         reset_zone "$dev" $((off / 512)) || return $?
 393     fi
 394     run_one_fio_job "$(ioengine "psync")" --rw=write --offset="$off"    \
 395                     --zonemode=zbd --zonesize="${zone_size}"            \
 396                     --bs="$zone_size" --size="$zone_size"               \
 397                     >>"${logfile}.${test_number}" 2>&1 || return $?
 398     check_written "$zone_size" || return $?
 399     run_one_fio_job "$(ioengine "libaio")" --iodepth=8 --rw=randrw --bs=4K \
 400                     --zonemode=zbd --zonesize="${zone_size}"            \
 401                     --offset=$off --loops=2 --norandommap=1\
 402                     >>"${logfile}.${test_number}" 2>&1 || return $?
 403     written=$(fio_written <"${logfile}.${test_number}")
 404     read=$(fio_read <"${logfile}.${test_number}")
 405     io=$((written + read))
 406     echo "Total number of bytes read and written: $io <> $size" \
 407          >>"${logfile}.${test_number}"
 408     [ $io = $((size * 2)) ];
 409 }
 410
 411 # Out-of-range zone reset threshold and frequency parameters.
 412 test18() {
 413     run_fio_on_seq --zone_reset_threshold=-1 |&
 414         tee -a "${logfile}.${test_number}"   |
 415             grep -q 'value out of range' || return $?
 416 }
 417
 418 test19() {
 419     run_fio_on_seq --zone_reset_threshold=2  |&
 420         tee -a "${logfile}.${test_number}"   |
 421         grep -q 'value out of range' || return $?
 422 }
 423
 424 test20() {
 425     run_fio_on_seq --zone_reset_threshold=.4:.6 |&
 426         tee -a "${logfile}.${test_number}"   |
 427         grep -q 'the list exceeding max length' || return $?
 428 }
 429
 430 test21() {
 431     run_fio_on_seq --zone_reset_frequency=-1 |&
 432         tee -a "${logfile}.${test_number}"   |
 433         grep -q 'value out of range' || return $?
 434 }
 435
 436 test22() {
 437     run_fio_on_seq --zone_reset_frequency=2  |&
 438         tee -a "${logfile}.${test_number}"   |
 439         grep -q 'value out of range' || return $?
 440 }
 441
 442 test23() {
 443     run_fio_on_seq --zone_reset_frequency=.4:.6  |&
 444         tee -a "${logfile}.${test_number}"   |
 445         grep -q 'the list exceeding max length' || return $?
 446 }
 447
 448 test24() {
 449     local bs loops=9 size=$((zone_size))
 450
 451     bs=$(min $((256*1024)) "$zone_size")
 452     run_fio_on_seq "$(ioengine "psync")" --rw=write --bs="$bs"          \
 453                    --size=$size --loops=$loops                          \
 454                    --zone_reset_frequency=.01 --zone_reset_threshold=.90 \
 455                    >> "${logfile}.${test_number}" 2>&1 || return $?
 456     check_written $((size * loops)) || return $?
 457     check_reset_count -eq 8 ||
 458         check_reset_count -eq 9 ||
 459         check_reset_count -eq 10 || return $?
 460 }
 461
 462 # Multiple non-overlapping sequential write jobs for the same drive.
 463 test25() {
 464     local i opts=()
 465
 466     for ((i=0;i<16;i++)); do
 467         [ -n "$is_zbd" ] &&
 468             reset_zone "$dev" $((first_sequential_zone_sector + i*sectors_per_zone))
 469     done
 470     for ((i=0;i<16;i++)); do
 471         opts+=("--name=job$i" "--filename=$dev" "--thread=1" "--direct=1")
 472         opts+=("--offset=$((first_sequential_zone_sector*512 + zone_size*i))")
 473         opts+=("--size=$zone_size" "$(ioengine "psync")" "--rw=write" "--bs=16K")
 474         opts+=("--zonemode=zbd" "--zonesize=${zone_size}" "--group_reporting=1")
 475         opts+=(${var_opts[@]})
 476     done
 477     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
 478 }
 479
 480 write_to_first_seq_zone() {
 481     local loops=4 r
 482
 483     r=$(((RANDOM << 16) | RANDOM))
 484     run_fio --name="$dev" --filename="$dev" "$(ioengine "psync")" --rw="$1" \
 485             --thread=1 --do_verify=1 --verify=md5 --direct=1 --bs=4K    \
 486             --offset=$((first_sequential_zone_sector * 512))            \
 487             "--size=$zone_size" --loops=$loops --randseed="$r"          \
 488             --zonemode=zbd --zonesize="${zone_size}" --group_reporting=1        \
 489             --gtod_reduce=1 >> "${logfile}.${test_number}" 2>&1 || return $?
 490     check_written $((loops * zone_size)) || return $?
 491 }
 492
 493 # Overwrite the first sequential zone four times sequentially.
 494 test26() {
 495     write_to_first_seq_zone write
 496 }
 497
 498 # Overwrite the first sequential zone four times using random writes.
 499 test27() {
 500     write_to_first_seq_zone randwrite
 501 }
 502
 503 # Multiple overlapping random write jobs for the same drive.
 504 test28() {
 505     local i jobs=16 off opts
 506
 507     off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
 508     [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
 509     opts=("--debug=zbd")
 510     for ((i=0;i<jobs;i++)); do
 511         opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
 512         opts+=("--size=$zone_size" "$(ioengine "psync")" "--rw=randwrite")
 513         opts+=("--thread=1" "--direct=1" "--zonemode=zbd")
 514         opts+=("--zonesize=${zone_size}" "--group_reporting=1")
 515         opts+=(${var_opts[@]})
 516     done
 517     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
 518     check_written $((jobs * zone_size)) || return $?
 519     check_reset_count -eq $jobs ||
 520         check_reset_count -eq $((jobs - 1)) ||
 521         return $?
 522 }
 523
 524 # Multiple overlapping random write jobs for the same drive and with a limited
 525 # number of open zones.
 526 test29() {
 527     local i jobs=16 off opts=()
 528
 529     off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
 530     size=$((16*zone_size))
 531     [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
 532     opts=("--debug=zbd")
 533     for ((i=0;i<jobs;i++)); do
 534         opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
 535         opts+=("--size=$size" "--io_size=$zone_size" "--thread=1")
 536         opts+=("$(ioengine "psync")" "--rw=randwrite" "--direct=1")
 537         opts+=("--max_open_zones=4" "--group_reporting=1")
 538         opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
 539         opts+=(${var_opts[@]})
 540     done
 541     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
 542     check_written $((jobs * zone_size)) || return $?
 543 }
 544
 545 # Random reads and writes across the entire disk for 30s.
 546 test30() {
 547     local off
 548
 549     off=$((first_sequential_zone_sector * 512))
 550     run_one_fio_job "$(ioengine "libaio")" --iodepth=8 --rw=randrw      \
 551                     --bs="$(max $((zone_size / 128)) "$logical_block_size")"\
 552                     --zonemode=zbd --zonesize="${zone_size}" --offset=$off\
 553                     --loops=2 --time_based --runtime=30s --norandommap=1\
 554                     >>"${logfile}.${test_number}" 2>&1
 555 }
 556
 557 # Random reads across all sequential zones for 30s. This is not only a fio
 558 # test but also allows to verify the performance of a drive.
 559 test31() {
 560     local bs inc nz off opts size
 561
 562     # Start with writing 128 KB to 128 sequential zones.
 563     bs=128K
 564     nz=128
 565     # shellcheck disable=SC2017
 566     inc=$(((disk_size - (first_sequential_zone_sector * 512)) / (nz * zone_size)
 567            * zone_size))
 568     opts=()
 569     for ((off = first_sequential_zone_sector * 512; off < disk_size;
 570           off += inc)); do
 571         opts+=("--name=$dev" "--filename=$dev" "--offset=$off" "--io_size=$bs")
 572         opts+=("--bs=$bs" "--size=$zone_size" "$(ioengine "libaio")")
 573         opts+=("--rw=write" "--direct=1" "--thread=1" "--stats=0")
 574         opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
 575         opts+=(${var_opts[@]})
 576     done
 577     "$(dirname "$0")/../../fio" "${opts[@]}" >> "${logfile}.${test_number}" 2>&1
 578     # Next, run the test.
 579     off=$((first_sequential_zone_sector * 512))
 580     size=$((disk_size - off))
 581     opts=("--name=$dev" "--filename=$dev" "--offset=$off" "--size=$size")
 582     opts+=("--bs=$bs" "$(ioengine "psync")" "--rw=randread" "--direct=1")
 583     opts+=("--thread=1" "--time_based" "--runtime=30" "--zonemode=zbd")
 584     opts+=("--zonesize=${zone_size}")
 585     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
 586 }
 587
 588 # Random writes across all sequential zones. This is not only a fio test but
 589 # also allows to verify the performance of a drive.
 590 test32() {
 591     local off opts=() size
 592
 593     off=$((first_sequential_zone_sector * 512))
 594     size=$((disk_size - off))
 595     opts+=("--name=$dev" "--filename=$dev" "--offset=$off" "--size=$size")
 596     opts+=("--bs=128K" "$(ioengine "psync")" "--rw=randwrite" "--direct=1")
 597     opts+=("--thread=1" "--time_based" "--runtime=30")
 598     opts+=("--max_open_zones=$max_open_zones" "--zonemode=zbd")
 599     opts+=("--zonesize=${zone_size}")
 600     run_fio "${opts[@]}" >> "${logfile}.${test_number}" 2>&1 || return $?
 601 }
 602
 603 # Write to sequential zones with a block size that is not a divisor of the
 604 # zone size.
 605 test33() {
 606     local bs io_size size
 607
 608     size=$((2 * zone_size))
 609     io_size=$((5 * zone_size))
 610     bs=$((3 * zone_size / 4))
 611     run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=write \
 612                    --size=$size --io_size=$io_size --bs=$bs     \
 613                    >> "${logfile}.${test_number}" 2>&1 || return $?
 614     check_written $(((io_size + bs - 1) / bs * bs)) || return $?
 615 }
 616
 617 # Write to sequential zones with a block size that is not a divisor of the
 618 # zone size and with data verification enabled.
 619 test34() {
 620     local size
 621
 622     size=$((2 * zone_size))
 623     run_fio_on_seq "$(ioengine "psync")" --iodepth=1 --rw=write --size=$size \
 624                    --do_verify=1 --verify=md5 --bs=$((3 * zone_size / 4)) \
 625                    >> "${logfile}.${test_number}" 2>&1 && return 1
 626     grep -q 'not a divisor of' "${logfile}.${test_number}"
 627 }
 628
 629 # Test 1/4 for the I/O boundary rounding code: $size < $zone_size.
 630 test35() {
 631     local bs off io_size size
 632
 633     off=$(((first_sequential_zone_sector + 1) * 512))
 634     size=$((zone_size - 2 * 512))
 635     bs=$((zone_size / 4))
 636     run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")"    \
 637                     --iodepth=1 --rw=write --do_verify=1 --verify=md5   \
 638                     --bs=$bs --zonemode=zbd --zonesize="${zone_size}"   \
 639                     >> "${logfile}.${test_number}" 2>&1 && return 1
 640     grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
 641 }
 642
 643 # Test 2/4 for the I/O boundary rounding code: $size < $zone_size.
 644 test36() {
 645     local bs off io_size size
 646
 647     off=$(((first_sequential_zone_sector) * 512))
 648     size=$((zone_size - 512))
 649     bs=$((zone_size / 4))
 650     run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")"    \
 651                     --iodepth=1 --rw=write --do_verify=1 --verify=md5   \
 652                     --bs=$bs --zonemode=zbd --zonesize="${zone_size}"   \
 653                     >> "${logfile}.${test_number}" 2>&1 && return 1
 654     grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
 655 }
 656
 657 # Test 3/4 for the I/O boundary rounding code: $size > $zone_size.
 658 test37() {
 659     local bs off size
 660
 661     if [ "$first_sequential_zone_sector" = 0 ]; then
 662         off=0
 663     else
 664         off=$(((first_sequential_zone_sector - 1) * 512))
 665     fi
 666     size=$((zone_size + 2 * 512))
 667     bs=$((zone_size / 4))
 668     run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")"    \
 669                     --iodepth=1 --rw=write --do_verify=1 --verify=md5   \
 670                     --bs=$bs --zonemode=zbd --zonesize="${zone_size}"   \
 671                     >> "${logfile}.${test_number}" 2>&1
 672     check_written $((zone_size)) || return $?
 673 }
 674
 675 # Test 4/4 for the I/O boundary rounding code: $offset > $disk_size - $zone_size
 676 test38() {
 677     local bs off size
 678
 679     size=$((logical_block_size))
 680     off=$((disk_size - logical_block_size))
 681     bs=$((logical_block_size))
 682     run_one_fio_job --offset=$off --size=$size "$(ioengine "psync")"    \
 683                     --iodepth=1 --rw=write --do_verify=1 --verify=md5   \
 684                     --bs=$bs --zonemode=zbd --zonesize="${zone_size}"   \
 685                     >> "${logfile}.${test_number}" 2>&1 && return 1
 686     grep -q 'io_size must be at least one zone' "${logfile}.${test_number}"
 687 }
 688
 689 # Read one block from a block device.
 690 read_one_block() {
 691     local bs
 692
 693     bs=$((logical_block_size))
 694     run_one_fio_job --rw=read "$(ioengine "psync")" --bs=$bs --size=$bs "$@" 2>&1 |
 695         tee -a "${logfile}.${test_number}"
 696 }
 697
 698 # Check whether fio accepts --zonemode=none for zoned block devices.
 699 test39() {
 700     [ -n "$is_zbd" ] || return 0
 701     read_one_block --zonemode=none >/dev/null || return $?
 702     check_read $((logical_block_size)) || return $?
 703 }
 704
 705 # Check whether fio accepts --zonemode=strided for zoned block devices.
 706 test40() {
 707     local bs
 708
 709     bs=$((logical_block_size))
 710     [ -n "$is_zbd" ] || return 0
 711     read_one_block --zonemode=strided |
 712         grep -q 'fio: --zonesize must be specified when using --zonemode=strided' ||
 713         return $?
 714     read_one_block --zonemode=strided --zonesize=$bs >/dev/null || return $?
 715     check_read $bs || return $?
 716 }
 717
 718 # Check whether fio checks the zone size for zoned block devices.
 719 test41() {
 720     [ -n "$is_zbd" ] || return 0
 721     read_one_block --zonemode=zbd --zonesize=$((2 * zone_size)) |
 722         grep -q 'job parameter zonesize.*does not match disk zone size'
 723 }
 724
 725 # Check whether fio handles --zonesize=0 correctly for regular block devices.
 726 test42() {
 727     [ -n "$is_zbd" ] && return 0
 728     read_one_block --zonemode=zbd --zonesize=0 |
 729         grep -q 'Specifying the zone size is mandatory for regular block devices with --zonemode=zbd'
 730 }
 731
 732 # Check whether fio handles --zonesize=1 correctly for regular block devices.
 733 test43() {
 734     [ -n "$is_zbd" ] && return 0
 735     read_one_block --zonemode=zbd --zonesize=1 |
 736         grep -q 'zone size must be at least 512 bytes for --zonemode=zbd'
 737 }
 738
 739 # Check whether fio handles --zonemode=none --zonesize=1 correctly.
 740 test44() {
 741     read_one_block --zonemode=none --zonesize=1 |
 742         grep -q 'fio: --zonemode=none and --zonesize are not compatible'
 743 }
 744
 745 test45() {
 746     local bs i
 747
 748     [ -z "$is_zbd" ] && return 0
 749     bs=$((logical_block_size))
 750     run_one_fio_job "$(ioengine "psync")" --iodepth=1 --rw=randwrite --bs=$bs\
 751                     --offset=$((first_sequential_zone_sector * 512)) \
 752                     --size="$zone_size" --do_verify=1 --verify=md5 2>&1 |
 753         tee -a "${logfile}.${test_number}" |
 754         grep -q "fio: first I/O failed. If .* is a zoned block device, consider --zonemode=zbd"
 755 }
 756
 757 # Random write to sequential zones, libaio, 8 jobs, queue depth 64 per job
 758 test46() {
 759     local size
 760
 761     size=$((4 * zone_size))
 762     run_fio_on_seq "$(ioengine "libaio")" --iodepth=64 --rw=randwrite --bs=4K \
 763                    --group_reporting=1 --numjobs=8 \
 764                    >> "${logfile}.${test_number}" 2>&1 || return $?
 765     check_written $((size * 8)) || return $?
 766 }
 767
 768 # Check whether fio handles --zonemode=zbd --zoneskip=1 correctly.
 769 test47() {
 770     local bs
 771
 772     [ -z "$is_zbd" ] && return 0
 773     bs=$((logical_block_size))
 774     run_one_fio_job "$(ioengine "psync")" --rw=write --bs=$bs \
 775                     --zonemode=zbd --zoneskip=1          \
 776                     >> "${logfile}.${test_number}" 2>&1 && return 1
 777     grep -q 'zoneskip 1 is not a multiple of the device zone size' "${logfile}.${test_number}"
 778 }
 779
 780 # Multiple overlapping random write jobs for the same drive and with a
 781 # limited number of open zones. This is similar to test29, but uses libaio
 782 # to stress test zone locking.
 783 test48() {
 784     local i jobs=16 off opts=()
 785
 786     off=$((first_sequential_zone_sector * 512 + 64 * zone_size))
 787     size=$((16*zone_size))
 788     [ -n "$is_zbd" ] && reset_zone "$dev" $((off / 512))
 789     opts=("--aux-path=/tmp" "--allow_file_create=0" "--significant_figures=10")
 790     opts+=("--debug=zbd")
 791     opts+=("$(ioengine "libaio")" "--rw=randwrite" "--direct=1")
 792     opts+=("--time_based" "--runtime=30")
 793     opts+=("--zonemode=zbd" "--zonesize=${zone_size}")
 794     opts+=("--max_open_zones=4")
 795     for ((i=0;i<jobs;i++)); do
 796         opts+=("--name=job$i" "--filename=$dev" "--offset=$off" "--bs=16K")
 797         opts+=("--io_size=$zone_size" "--iodepth=256" "--thread=1")
 798         opts+=("--group_reporting=1")
 799     done
 800
 801     fio=$(dirname "$0")/../../fio
 802
 803     { echo; echo "fio ${opts[*]}"; echo; } >>"${logfile}.${test_number}"
 804
 805     timeout -v -s KILL 45s \
 806             "${dynamic_analyzer[@]}" "$fio" "${opts[@]}" \
 807             >> "${logfile}.${test_number}" 2>&1 || return $?
 808 }
 809
 810 tests=()
 811 dynamic_analyzer=()
 812 reset_all_zones=
 813 use_libzbc=
 814 zbd_debug=
 815
 816 while [ "${1#-}" != "$1" ]; do
 817   case "$1" in
 818     -d) dynamic_analyzer=(valgrind "--read-var-info=yes" "--tool=drd"
 819                           "--show-confl-seg=no");
 820         shift;;
 821     -e) dynamic_analyzer=(valgrind "--read-var-info=yes" "--tool=helgrind");
 822         shift;;
 823     -l) use_libzbc=1; shift;;
 824     -r) reset_all_zones=1; shift;;
 825     -t) tests+=("$2"); shift; shift;;
 826     -v) dynamic_analyzer=(valgrind "--read-var-info=yes");
 827         shift;;
 828     -z) zbd_debug=1; shift;;
 829     --) shift; break;;
 830   esac
 831 done
 832
 833 if [ $# != 1 ]; then
 834     usage
 835     exit 1
 836 fi
 837
 838 # shellcheck source=functions
 839 source "$(dirname "$0")/functions" || exit $?
 840
 841 var_opts=()
 842 if [ -n "$zbd_debug" ]; then
 843     var_opts+=("--debug=zbd")
 844 fi
 845 dev=$1
 846 realdev=$(readlink -f "$dev")
 847 basename=$(basename "$realdev")
 848
 849 if [[ -b "$realdev" ]]; then
 850         major=$((0x$(stat -L -c '%t' "$realdev"))) || exit $?
 851         minor=$((0x$(stat -L -c '%T' "$realdev"))) || exit $?
 852         disk_size=$(($(<"/sys/dev/block/$major:$minor/size")*512))
 853
 854         # When the target is a partition device, get basename of its
 855         # holder device to access sysfs path of the holder device
 856         if [[ -r "/sys/dev/block/$major:$minor/partition" ]]; then
 857                 realsysfs=$(readlink "/sys/dev/block/$major:$minor")
 858                 basename=$(basename "${realsysfs%/*}")
 859         fi
 860         logical_block_size=$(<"/sys/block/$basename/queue/logical_block_size")
 861         case "$(<"/sys/class/block/$basename/queue/zoned")" in
 862         host-managed|host-aware)
 863                 is_zbd=true
 864                 if ! result=($(first_sequential_zone "$dev")); then
 865                         echo "Failed to determine first sequential zone"
 866                         exit 1
 867                 fi
 868                 first_sequential_zone_sector=${result[0]}
 869                 sectors_per_zone=${result[1]}
 870                 zone_size=$((sectors_per_zone * 512))
 871                 if ! max_open_zones=$(max_open_zones "$dev"); then
 872                         echo "Failed to determine maximum number of open zones"
 873                         exit 1
 874                 fi
 875                 set_io_scheduler "$basename" deadline || exit $?
 876                 if [ -n "$reset_all_zones" ]; then
 877                         reset_zone "$dev" -1
 878                 fi
 879                 ;;
 880         *)
 881                 first_sequential_zone_sector=$(((disk_size / 2) &
 882                                                 (logical_block_size - 1)))
 883                 zone_size=$(max 65536 "$logical_block_size")
 884                 sectors_per_zone=$((zone_size / 512))
 885                 max_open_zones=128
 886                 set_io_scheduler "$basename" none || exit $?
 887                 ;;
 888         esac
 889 elif [[ -c "$realdev" ]]; then
 890         # For an SG node, we must have libzbc option specified
 891         if [[ ! -n "$use_libzbc" ]]; then
 892                 echo "Character device files can only be used with -l (libzbc) option"
 893                 exit 1
 894         fi
 895
 896         if ! $(is_zbc "$dev"); then
 897                 echo "Device is not a ZBC disk"
 898                 exit 1
 899         fi
 900         is_zbd=true
 901
 902         if ! disk_size=($(( $(zbc_disk_sectors "$dev") * 512))); then
 903                 echo "Failed to determine disk size"
 904                 exit 1
 905         fi
 906         if ! logical_block_size=($(zbc_logical_block_size "$dev")); then
 907                 echo "Failed to determine logical block size"
 908                 exit 1
 909         fi
 910         if ! result=($(first_sequential_zone "$dev")); then
 911                 echo "Failed to determine first sequential zone"
 912                 exit 1
 913         fi
 914         first_sequential_zone_sector=${result[0]}
 915         sectors_per_zone=${result[1]}
 916         zone_size=$((sectors_per_zone * 512))
 917         if ! max_open_zones=$(max_open_zones "$dev"); then
 918                 echo "Failed to determine maximum number of open zones"
 919                 exit 1
 920         fi
 921         if [ -n "$reset_all_zones" ]; then
 922                 reset_zone "$dev" -1
 923         fi
 924 fi
 925
 926 echo -n "First sequential zone starts at sector $first_sequential_zone_sector;"
 927 echo " zone size: $((zone_size >> 20)) MB"
 928
 929 if [ "${#tests[@]}" = 0 ]; then
 930     readarray -t tests < <(declare -F | grep "test[0-9]*" | \
 931                                    tr -c -d "[:digit:]\n" | sort -n)
 932 fi
 933
 934 logfile=$0.log
 935
 936 passed=0
 937 failed=0
 938 if [ -t 1 ]; then
 939     red="\e[1;31m"
 940     green="\e[1;32m"
 941     end="\e[m"
 942 else
 943     red=""
 944     green=""
 945     end=""
 946 fi
 947 rc=0
 948
 949 intr=0
 950 trap 'intr=1' SIGINT
 951
 952 for test_number in "${tests[@]}"; do
 953     rm -f "${logfile}.${test_number}"
 954     echo -n "Running test $(printf "%02d" $test_number) ... "
 955     if eval "test$test_number"; then
 956         status="PASS"
 957         cc_status="${green}${status}${end}"
 958         ((passed++))
 959     else
 960         status="FAIL"
 961         cc_status="${red}${status}${end}"
 962         ((failed++))
 963         rc=1
 964     fi
 965     echo -e "$cc_status"
 966     echo "$status" >> "${logfile}.${test_number}"
 967     [ $intr -ne 0 ] && exit 1
 968 done
 969
 970 echo "$passed tests passed"
 971 if [ $failed -gt 0 ]; then
 972     echo " and $failed tests failed"
 973 fi
 974 exit $rc