zbd: use zone_lock to lock a zone
[fio.git] / zbd.c
CommitLineData
bfbdd35b
BVA
1/*
2 * Copyright (C) 2018 Western Digital Corporation or its affiliates.
3 *
4 * This file is released under the GPL.
5 */
6
7#include <errno.h>
8#include <string.h>
9#include <stdlib.h>
10#include <dirent.h>
11#include <fcntl.h>
12#include <sys/ioctl.h>
13#include <sys/stat.h>
14#include <unistd.h>
15#include <linux/blkzoned.h>
f5bff36e 16
bfbdd35b
BVA
17#include "file.h"
18#include "fio.h"
19#include "lib/pow2.h"
20#include "log.h"
f5bff36e 21#include "oslib/asprintf.h"
bfbdd35b
BVA
22#include "smalloc.h"
23#include "verify.h"
24#include "zbd.h"
25
26/**
27 * zbd_zone_idx - convert an offset into a zone number
28 * @f: file pointer.
29 * @offset: offset in bytes. If this offset is in the first zone_size bytes
30 * past the disk size then the index of the sentinel is returned.
31 */
32static uint32_t zbd_zone_idx(const struct fio_file *f, uint64_t offset)
33{
34 uint32_t zone_idx;
35
cd775e06 36 if (f->zbd_info->zone_size_log2 > 0)
bfbdd35b
BVA
37 zone_idx = offset >> f->zbd_info->zone_size_log2;
38 else
ee3696bd 39 zone_idx = offset / f->zbd_info->zone_size;
bfbdd35b
BVA
40
41 return min(zone_idx, f->zbd_info->nr_zones);
42}
43
44/**
45 * zbd_zone_full - verify whether a minimum number of bytes remain in a zone
46 * @f: file pointer.
47 * @z: zone info pointer.
48 * @required: minimum number of bytes that must remain in a zone.
49 *
50 * The caller must hold z->mutex.
51 */
52static bool zbd_zone_full(const struct fio_file *f, struct fio_zone_info *z,
53 uint64_t required)
54{
55 assert((required & 511) == 0);
56
57 return z->type == BLK_ZONE_TYPE_SEQWRITE_REQ &&
ee3696bd 58 z->wp + required > z->start + f->zbd_info->zone_size;
bfbdd35b
BVA
59}
60
61static bool is_valid_offset(const struct fio_file *f, uint64_t offset)
62{
63 return (uint64_t)(offset - f->file_offset) < f->io_size;
64}
65
66/* Verify whether direct I/O is used for all host-managed zoned drives. */
67static bool zbd_using_direct_io(void)
68{
69 struct thread_data *td;
70 struct fio_file *f;
71 int i, j;
72
73 for_each_td(td, i) {
74 if (td->o.odirect || !(td->o.td_ddir & TD_DDIR_WRITE))
75 continue;
76 for_each_file(td, f, j) {
77 if (f->zbd_info &&
78 f->zbd_info->model == ZBD_DM_HOST_MANAGED)
79 return false;
80 }
81 }
82
83 return true;
84}
85
86/* Whether or not the I/O range for f includes one or more sequential zones */
87static bool zbd_is_seq_job(struct fio_file *f)
88{
89 uint32_t zone_idx, zone_idx_b, zone_idx_e;
90
91 assert(f->zbd_info);
92 if (f->io_size == 0)
93 return false;
94 zone_idx_b = zbd_zone_idx(f, f->file_offset);
95 zone_idx_e = zbd_zone_idx(f, f->file_offset + f->io_size - 1);
96 for (zone_idx = zone_idx_b; zone_idx <= zone_idx_e; zone_idx++)
97 if (f->zbd_info->zone_info[zone_idx].type ==
98 BLK_ZONE_TYPE_SEQWRITE_REQ)
99 return true;
100
101 return false;
102}
103
104/*
105 * Verify whether offset and size parameters are aligned with zone boundaries.
106 */
107static bool zbd_verify_sizes(void)
108{
109 const struct fio_zone_info *z;
110 struct thread_data *td;
111 struct fio_file *f;
112 uint64_t new_offset, new_end;
113 uint32_t zone_idx;
114 int i, j;
115
116 for_each_td(td, i) {
117 for_each_file(td, f, j) {
118 if (!f->zbd_info)
119 continue;
120 if (f->file_offset >= f->real_file_size)
121 continue;
122 if (!zbd_is_seq_job(f))
123 continue;
4d37720a 124
fc52e449
DLM
125 if (!td->o.zone_size) {
126 td->o.zone_size = f->zbd_info->zone_size;
127 if (!td->o.zone_size) {
128 log_err("%s: invalid 0 zone size\n",
129 f->file_name);
130 return false;
131 }
971d6a22
DLM
132 } else if (td->o.zone_size != f->zbd_info->zone_size) {
133 log_err("%s: job parameter zonesize %llu does not match disk zone size %llu.\n",
134 f->file_name, (unsigned long long) td->o.zone_size,
135 (unsigned long long) f->zbd_info->zone_size);
136 return false;
fc52e449
DLM
137 }
138
4d37720a
DLM
139 if (td->o.zone_skip &&
140 (td->o.zone_skip < td->o.zone_size ||
141 td->o.zone_skip % td->o.zone_size)) {
142 log_err("%s: zoneskip %llu is not a multiple of the device zone size %llu.\n",
143 f->file_name, (unsigned long long) td->o.zone_skip,
144 (unsigned long long) td->o.zone_size);
145 return false;
146 }
147
bfbdd35b
BVA
148 zone_idx = zbd_zone_idx(f, f->file_offset);
149 z = &f->zbd_info->zone_info[zone_idx];
ee3696bd
DLM
150 if (f->file_offset != z->start) {
151 new_offset = (z+1)->start;
bfbdd35b
BVA
152 if (new_offset >= f->file_offset + f->io_size) {
153 log_info("%s: io_size must be at least one zone\n",
154 f->file_name);
155 return false;
156 }
a0c84dd4
JA
157 log_info("%s: rounded up offset from %llu to %llu\n",
158 f->file_name, (unsigned long long) f->file_offset,
159 (unsigned long long) new_offset);
bfbdd35b
BVA
160 f->io_size -= (new_offset - f->file_offset);
161 f->file_offset = new_offset;
162 }
163 zone_idx = zbd_zone_idx(f, f->file_offset + f->io_size);
164 z = &f->zbd_info->zone_info[zone_idx];
ee3696bd 165 new_end = z->start;
bfbdd35b
BVA
166 if (f->file_offset + f->io_size != new_end) {
167 if (new_end <= f->file_offset) {
168 log_info("%s: io_size must be at least one zone\n",
169 f->file_name);
170 return false;
171 }
a0c84dd4
JA
172 log_info("%s: rounded down io_size from %llu to %llu\n",
173 f->file_name, (unsigned long long) f->io_size,
174 (unsigned long long) new_end - f->file_offset);
bfbdd35b
BVA
175 f->io_size = new_end - f->file_offset;
176 }
177 }
178 }
179
180 return true;
181}
182
183static bool zbd_verify_bs(void)
184{
185 struct thread_data *td;
186 struct fio_file *f;
187 uint32_t zone_size;
188 int i, j, k;
189
190 for_each_td(td, i) {
191 for_each_file(td, f, j) {
192 if (!f->zbd_info)
193 continue;
194 zone_size = f->zbd_info->zone_size;
195 for (k = 0; k < ARRAY_SIZE(td->o.bs); k++) {
196 if (td->o.verify != VERIFY_NONE &&
ee3696bd 197 zone_size % td->o.bs[k] != 0) {
bfbdd35b
BVA
198 log_info("%s: block size %llu is not a divisor of the zone size %d\n",
199 f->file_name, td->o.bs[k],
ee3696bd 200 zone_size);
bfbdd35b
BVA
201 return false;
202 }
203 }
204 }
205 }
206 return true;
207}
208
209/*
210 * Read zone information into @buf starting from sector @start_sector.
211 * @fd is a file descriptor that refers to a block device and @bufsz is the
212 * size of @buf.
213 *
214 * Returns 0 upon success and a negative error code upon failure.
7f125e7f
DLM
215 * If the zone report is empty, always assume an error (device problem) and
216 * return -EIO.
bfbdd35b
BVA
217 */
218static int read_zone_info(int fd, uint64_t start_sector,
219 void *buf, unsigned int bufsz)
220{
221 struct blk_zone_report *hdr = buf;
7f125e7f 222 int ret;
bfbdd35b
BVA
223
224 if (bufsz < sizeof(*hdr))
225 return -EINVAL;
226
227 memset(hdr, 0, sizeof(*hdr));
228
229 hdr->nr_zones = (bufsz - sizeof(*hdr)) / sizeof(struct blk_zone);
230 hdr->sector = start_sector;
7f125e7f
DLM
231 ret = ioctl(fd, BLKREPORTZONE, hdr);
232 if (ret)
233 return -errno;
234 if (!hdr->nr_zones)
235 return -EIO;
236 return 0;
bfbdd35b
BVA
237}
238
239/*
240 * Read up to 255 characters from the first line of a file. Strip the trailing
241 * newline.
242 */
243static char *read_file(const char *path)
244{
245 char line[256], *p = line;
246 FILE *f;
247
248 f = fopen(path, "rb");
249 if (!f)
250 return NULL;
251 if (!fgets(line, sizeof(line), f))
252 line[0] = '\0';
253 strsep(&p, "\n");
254 fclose(f);
255
256 return strdup(line);
257}
258
259static enum blk_zoned_model get_zbd_model(const char *file_name)
260{
261 enum blk_zoned_model model = ZBD_DM_NONE;
262 char *zoned_attr_path = NULL;
263 char *model_str = NULL;
264 struct stat statbuf;
63e3e40d
SK
265 char *sys_devno_path = NULL;
266 char *part_attr_path = NULL;
267 char *part_str = NULL;
268 char sys_path[PATH_MAX];
269 ssize_t sz;
270 char *delim = NULL;
bfbdd35b
BVA
271
272 if (stat(file_name, &statbuf) < 0)
273 goto out;
63e3e40d
SK
274
275 if (asprintf(&sys_devno_path, "/sys/dev/block/%d:%d",
bfbdd35b
BVA
276 major(statbuf.st_rdev), minor(statbuf.st_rdev)) < 0)
277 goto out;
63e3e40d
SK
278
279 sz = readlink(sys_devno_path, sys_path, sizeof(sys_path) - 1);
280 if (sz < 0)
281 goto out;
282 sys_path[sz] = '\0';
283
284 /*
285 * If the device is a partition device, cut the device name in the
286 * canonical sysfs path to obtain the sysfs path of the holder device.
287 * e.g.: /sys/devices/.../sda/sda1 -> /sys/devices/.../sda
288 */
289 if (asprintf(&part_attr_path, "/sys/dev/block/%s/partition",
290 sys_path) < 0)
291 goto out;
292 part_str = read_file(part_attr_path);
293 if (part_str && *part_str == '1') {
294 delim = strrchr(sys_path, '/');
295 if (!delim)
296 goto out;
297 *delim = '\0';
298 }
299
300 if (asprintf(&zoned_attr_path,
301 "/sys/dev/block/%s/queue/zoned", sys_path) < 0)
302 goto out;
303
bfbdd35b
BVA
304 model_str = read_file(zoned_attr_path);
305 if (!model_str)
306 goto out;
307 dprint(FD_ZBD, "%s: zbd model string: %s\n", file_name, model_str);
308 if (strcmp(model_str, "host-aware") == 0)
309 model = ZBD_DM_HOST_AWARE;
310 else if (strcmp(model_str, "host-managed") == 0)
311 model = ZBD_DM_HOST_MANAGED;
312
313out:
314 free(model_str);
315 free(zoned_attr_path);
63e3e40d
SK
316 free(part_str);
317 free(part_attr_path);
318 free(sys_devno_path);
bfbdd35b
BVA
319 return model;
320}
321
322static int ilog2(uint64_t i)
323{
324 int log = -1;
325
326 while (i) {
327 i >>= 1;
328 log++;
329 }
330 return log;
331}
332
333/*
334 * Initialize f->zbd_info for devices that are not zoned block devices. This
335 * allows to execute a ZBD workload against a non-ZBD device.
336 */
337static int init_zone_info(struct thread_data *td, struct fio_file *f)
338{
339 uint32_t nr_zones;
340 struct fio_zone_info *p;
a4b7f12b 341 uint64_t zone_size = td->o.zone_size;
bfbdd35b
BVA
342 struct zoned_block_device_info *zbd_info = NULL;
343 pthread_mutexattr_t attr;
344 int i;
345
a4b7f12b
DLM
346 if (zone_size == 0) {
347 log_err("%s: Specifying the zone size is mandatory for regular block devices with --zonemode=zbd\n\n",
348 f->file_name);
349 return 1;
350 }
351
352 if (zone_size < 512) {
353 log_err("%s: zone size must be at least 512 bytes for --zonemode=zbd\n\n",
354 f->file_name);
355 return 1;
356 }
357
ee3696bd 358 nr_zones = (f->real_file_size + zone_size - 1) / zone_size;
bfbdd35b
BVA
359 zbd_info = scalloc(1, sizeof(*zbd_info) +
360 (nr_zones + 1) * sizeof(zbd_info->zone_info[0]));
361 if (!zbd_info)
362 return -ENOMEM;
363
364 pthread_mutexattr_init(&attr);
365 pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);
366 pthread_mutexattr_setpshared(&attr, true);
367 pthread_mutex_init(&zbd_info->mutex, &attr);
368 zbd_info->refcount = 1;
369 p = &zbd_info->zone_info[0];
370 for (i = 0; i < nr_zones; i++, p++) {
371 pthread_mutex_init(&p->mutex, &attr);
372 p->start = i * zone_size;
373 p->wp = p->start + zone_size;
374 p->type = BLK_ZONE_TYPE_SEQWRITE_REQ;
375 p->cond = BLK_ZONE_COND_EMPTY;
376 }
377 /* a sentinel */
378 p->start = nr_zones * zone_size;
379
380 f->zbd_info = zbd_info;
381 f->zbd_info->zone_size = zone_size;
382 f->zbd_info->zone_size_log2 = is_power_of_2(zone_size) ?
ee3696bd 383 ilog2(zone_size) : -1;
bfbdd35b
BVA
384 f->zbd_info->nr_zones = nr_zones;
385 pthread_mutexattr_destroy(&attr);
386 return 0;
387}
388
389/*
390 * Parse the BLKREPORTZONE output and store it in f->zbd_info. Must be called
391 * only for devices that support this ioctl, namely zoned block devices.
392 */
393static int parse_zone_info(struct thread_data *td, struct fio_file *f)
394{
395 const unsigned int bufsz = sizeof(struct blk_zone_report) +
396 4096 * sizeof(struct blk_zone);
397 uint32_t nr_zones;
398 struct blk_zone_report *hdr;
399 const struct blk_zone *z;
400 struct fio_zone_info *p;
401 uint64_t zone_size, start_sector;
402 struct zoned_block_device_info *zbd_info = NULL;
403 pthread_mutexattr_t attr;
404 void *buf;
405 int fd, i, j, ret = 0;
406
407 pthread_mutexattr_init(&attr);
408 pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);
409 pthread_mutexattr_setpshared(&attr, true);
410
411 buf = malloc(bufsz);
412 if (!buf)
413 goto out;
414
415 fd = open(f->file_name, O_RDONLY | O_LARGEFILE);
416 if (fd < 0) {
417 ret = -errno;
418 goto free;
419 }
420
421 ret = read_zone_info(fd, 0, buf, bufsz);
422 if (ret < 0) {
423 log_info("fio: BLKREPORTZONE(%lu) failed for %s (%d).\n",
424 0UL, f->file_name, -ret);
425 goto close;
426 }
427 hdr = buf;
428 if (hdr->nr_zones < 1) {
429 log_info("fio: %s has invalid zone information.\n",
430 f->file_name);
431 goto close;
432 }
433 z = (void *)(hdr + 1);
ee3696bd
DLM
434 zone_size = z->len << 9;
435 nr_zones = (f->real_file_size + zone_size - 1) / zone_size;
bfbdd35b
BVA
436
437 if (td->o.zone_size == 0) {
ee3696bd
DLM
438 td->o.zone_size = zone_size;
439 } else if (td->o.zone_size != zone_size) {
4580ff92
DLM
440 log_err("fio: %s job parameter zonesize %llu does not match disk zone size %llu.\n",
441 f->file_name, (unsigned long long) td->o.zone_size,
a0c84dd4 442 (unsigned long long) zone_size);
bfbdd35b
BVA
443 ret = -EINVAL;
444 goto close;
445 }
446
a0c84dd4
JA
447 dprint(FD_ZBD, "Device %s has %d zones of size %llu KB\n", f->file_name,
448 nr_zones, (unsigned long long) zone_size / 1024);
bfbdd35b
BVA
449
450 zbd_info = scalloc(1, sizeof(*zbd_info) +
451 (nr_zones + 1) * sizeof(zbd_info->zone_info[0]));
452 ret = -ENOMEM;
453 if (!zbd_info)
454 goto close;
455 pthread_mutex_init(&zbd_info->mutex, &attr);
456 zbd_info->refcount = 1;
457 p = &zbd_info->zone_info[0];
458 for (start_sector = 0, j = 0; j < nr_zones;) {
459 z = (void *)(hdr + 1);
460 for (i = 0; i < hdr->nr_zones; i++, j++, z++, p++) {
461 pthread_mutex_init(&p->mutex, &attr);
ee3696bd 462 p->start = z->start << 9;
bfbdd35b
BVA
463 switch (z->cond) {
464 case BLK_ZONE_COND_NOT_WP:
bfbdd35b 465 case BLK_ZONE_COND_FULL:
ee3696bd 466 p->wp = p->start + zone_size;
bfbdd35b
BVA
467 break;
468 default:
469 assert(z->start <= z->wp);
ee3696bd
DLM
470 assert(z->wp <= z->start + (zone_size >> 9));
471 p->wp = z->wp << 9;
bfbdd35b
BVA
472 break;
473 }
474 p->type = z->type;
475 p->cond = z->cond;
476 if (j > 0 && p->start != p[-1].start + zone_size) {
477 log_info("%s: invalid zone data\n",
478 f->file_name);
479 ret = -EINVAL;
480 goto close;
481 }
482 }
483 z--;
484 start_sector = z->start + z->len;
485 if (j >= nr_zones)
486 break;
487 ret = read_zone_info(fd, start_sector, buf, bufsz);
488 if (ret < 0) {
a0c84dd4
JA
489 log_info("fio: BLKREPORTZONE(%llu) failed for %s (%d).\n",
490 (unsigned long long) start_sector, f->file_name, -ret);
bfbdd35b
BVA
491 goto close;
492 }
493 }
494 /* a sentinel */
ee3696bd 495 zbd_info->zone_info[nr_zones].start = start_sector << 9;
bfbdd35b
BVA
496
497 f->zbd_info = zbd_info;
498 f->zbd_info->zone_size = zone_size;
499 f->zbd_info->zone_size_log2 = is_power_of_2(zone_size) ?
ee3696bd 500 ilog2(zone_size) : -1;
bfbdd35b
BVA
501 f->zbd_info->nr_zones = nr_zones;
502 zbd_info = NULL;
503 ret = 0;
504
505close:
506 sfree(zbd_info);
507 close(fd);
508free:
509 free(buf);
510out:
511 pthread_mutexattr_destroy(&attr);
512 return ret;
513}
514
515/*
516 * Allocate zone information and store it into f->zbd_info if zonemode=zbd.
517 *
518 * Returns 0 upon success and a negative error code upon failure.
519 */
379e5f09 520static int zbd_create_zone_info(struct thread_data *td, struct fio_file *f)
bfbdd35b
BVA
521{
522 enum blk_zoned_model zbd_model;
523 int ret = 0;
524
525 assert(td->o.zone_mode == ZONE_MODE_ZBD);
526
527 zbd_model = get_zbd_model(f->file_name);
528 switch (zbd_model) {
529 case ZBD_DM_HOST_AWARE:
530 case ZBD_DM_HOST_MANAGED:
531 ret = parse_zone_info(td, f);
532 break;
533 case ZBD_DM_NONE:
534 ret = init_zone_info(td, f);
535 break;
536 }
537 if (ret == 0)
538 f->zbd_info->model = zbd_model;
539 return ret;
540}
541
542void zbd_free_zone_info(struct fio_file *f)
543{
544 uint32_t refcount;
545
546 if (!f->zbd_info)
547 return;
548
549 pthread_mutex_lock(&f->zbd_info->mutex);
550 refcount = --f->zbd_info->refcount;
551 pthread_mutex_unlock(&f->zbd_info->mutex);
552
553 assert((int32_t)refcount >= 0);
554 if (refcount == 0)
555 sfree(f->zbd_info);
556 f->zbd_info = NULL;
557}
558
559/*
560 * Initialize f->zbd_info.
561 *
562 * Returns 0 upon success and a negative error code upon failure.
563 *
564 * Note: this function can only work correctly if it is called before the first
565 * fio fork() call.
566 */
567static int zbd_init_zone_info(struct thread_data *td, struct fio_file *file)
568{
569 struct thread_data *td2;
570 struct fio_file *f2;
571 int i, j, ret;
572
573 for_each_td(td2, i) {
574 for_each_file(td2, f2, j) {
575 if (td2 == td && f2 == file)
576 continue;
577 if (!f2->zbd_info ||
578 strcmp(f2->file_name, file->file_name) != 0)
579 continue;
580 file->zbd_info = f2->zbd_info;
581 file->zbd_info->refcount++;
582 return 0;
583 }
584 }
585
586 ret = zbd_create_zone_info(td, file);
587 if (ret < 0)
c5837eec 588 td_verror(td, -ret, "zbd_create_zone_info() failed");
bfbdd35b
BVA
589 return ret;
590}
591
592int zbd_init(struct thread_data *td)
593{
594 struct fio_file *f;
595 int i;
596
597 for_each_file(td, f, i) {
598 if (f->filetype != FIO_TYPE_BLOCK)
599 continue;
a4b7f12b 600 if (zbd_init_zone_info(td, f))
bfbdd35b 601 return 1;
bfbdd35b
BVA
602 }
603
604 if (!zbd_using_direct_io()) {
605 log_err("Using direct I/O is mandatory for writing to ZBD drives\n\n");
606 return 1;
607 }
608
609 if (!zbd_verify_sizes())
610 return 1;
611
612 if (!zbd_verify_bs())
613 return 1;
614
615 return 0;
616}
617
618/**
619 * zbd_reset_range - reset zones for a range of sectors
620 * @td: FIO thread data.
621 * @f: Fio file for which to reset zones
622 * @sector: Starting sector in units of 512 bytes
623 * @nr_sectors: Number of sectors in units of 512 bytes
624 *
625 * Returns 0 upon success and a negative error code upon failure.
626 */
627static int zbd_reset_range(struct thread_data *td, const struct fio_file *f,
ee3696bd 628 uint64_t offset, uint64_t length)
bfbdd35b
BVA
629{
630 struct blk_zone_range zr = {
ee3696bd
DLM
631 .sector = offset >> 9,
632 .nr_sectors = length >> 9,
bfbdd35b
BVA
633 };
634 uint32_t zone_idx_b, zone_idx_e;
635 struct fio_zone_info *zb, *ze, *z;
636 int ret = 0;
637
638 assert(f->fd != -1);
ee3696bd 639 assert(is_valid_offset(f, offset + length - 1));
bfbdd35b
BVA
640 switch (f->zbd_info->model) {
641 case ZBD_DM_HOST_AWARE:
642 case ZBD_DM_HOST_MANAGED:
643 ret = ioctl(f->fd, BLKRESETZONE, &zr);
644 if (ret < 0) {
645 td_verror(td, errno, "resetting wp failed");
646 log_err("%s: resetting wp for %llu sectors at sector %llu failed (%d).\n",
647 f->file_name, zr.nr_sectors, zr.sector, errno);
648 return ret;
649 }
650 break;
651 case ZBD_DM_NONE:
652 break;
653 }
654
ee3696bd 655 zone_idx_b = zbd_zone_idx(f, offset);
bfbdd35b 656 zb = &f->zbd_info->zone_info[zone_idx_b];
ee3696bd 657 zone_idx_e = zbd_zone_idx(f, offset + length);
bfbdd35b
BVA
658 ze = &f->zbd_info->zone_info[zone_idx_e];
659 for (z = zb; z < ze; z++) {
660 pthread_mutex_lock(&z->mutex);
a7c2b6fc
BVA
661 pthread_mutex_lock(&f->zbd_info->mutex);
662 f->zbd_info->sectors_with_data -= z->wp - z->start;
663 pthread_mutex_unlock(&f->zbd_info->mutex);
bfbdd35b
BVA
664 z->wp = z->start;
665 z->verify_block = 0;
666 pthread_mutex_unlock(&z->mutex);
667 }
668
fd5d733f
BVA
669 td->ts.nr_zone_resets += ze - zb;
670
bfbdd35b
BVA
671 return ret;
672}
673
a0c84dd4
JA
674static unsigned int zbd_zone_nr(struct zoned_block_device_info *zbd_info,
675 struct fio_zone_info *zone)
676{
089ddd95 677 return zone - zbd_info->zone_info;
a0c84dd4
JA
678}
679
bfbdd35b
BVA
680/**
681 * zbd_reset_zone - reset the write pointer of a single zone
682 * @td: FIO thread data.
683 * @f: FIO file associated with the disk for which to reset a write pointer.
684 * @z: Zone to reset.
685 *
686 * Returns 0 upon success and a negative error code upon failure.
687 */
688static int zbd_reset_zone(struct thread_data *td, const struct fio_file *f,
689 struct fio_zone_info *z)
690{
a0c84dd4
JA
691 dprint(FD_ZBD, "%s: resetting wp of zone %u.\n", f->file_name,
692 zbd_zone_nr(f->zbd_info, z));
d60be7d5
DLM
693
694 return zbd_reset_range(td, f, z->start, (z+1)->start - z->start);
bfbdd35b
BVA
695}
696
697/*
698 * Reset a range of zones. Returns 0 upon success and 1 upon failure.
699 * @td: fio thread data.
700 * @f: fio file for which to reset zones
701 * @zb: first zone to reset.
702 * @ze: first zone not to reset.
703 * @all_zones: whether to reset all zones or only those zones for which the
704 * write pointer is not a multiple of td->o.min_bs[DDIR_WRITE].
705 */
706static int zbd_reset_zones(struct thread_data *td, struct fio_file *f,
707 struct fio_zone_info *const zb,
708 struct fio_zone_info *const ze, bool all_zones)
709{
4803b841 710 struct fio_zone_info *z;
ee3696bd 711 const uint32_t min_bs = td->o.min_bs[DDIR_WRITE];
bfbdd35b
BVA
712 bool reset_wp;
713 int res = 0;
714
a0c84dd4
JA
715 dprint(FD_ZBD, "%s: examining zones %u .. %u\n", f->file_name,
716 zbd_zone_nr(f->zbd_info, zb), zbd_zone_nr(f->zbd_info, ze));
bfbdd35b
BVA
717 assert(f->fd != -1);
718 for (z = zb; z < ze; z++) {
719 pthread_mutex_lock(&z->mutex);
4803b841 720 if (z->type == BLK_ZONE_TYPE_SEQWRITE_REQ) {
bfbdd35b
BVA
721 reset_wp = all_zones ? z->wp != z->start :
722 (td->o.td_ddir & TD_DDIR_WRITE) &&
723 z->wp % min_bs != 0;
4803b841
NA
724 if (reset_wp) {
725 dprint(FD_ZBD, "%s: resetting zone %u\n",
bfbdd35b 726 f->file_name,
4803b841
NA
727 zbd_zone_nr(f->zbd_info, z));
728 if (zbd_reset_zone(td, f, z) < 0)
bfbdd35b 729 res = 1;
bfbdd35b 730 }
bfbdd35b 731 }
bfbdd35b 732 pthread_mutex_unlock(&z->mutex);
4803b841 733 }
bfbdd35b
BVA
734
735 return res;
736}
737
a7c2b6fc
BVA
738/*
739 * Reset zbd_info.write_cnt, the counter that counts down towards the next
740 * zone reset.
741 */
742static void zbd_reset_write_cnt(const struct thread_data *td,
743 const struct fio_file *f)
744{
745 assert(0 <= td->o.zrf.u.f && td->o.zrf.u.f <= 1);
746
747 pthread_mutex_lock(&f->zbd_info->mutex);
748 f->zbd_info->write_cnt = td->o.zrf.u.f ?
749 min(1.0 / td->o.zrf.u.f, 0.0 + UINT_MAX) : UINT_MAX;
750 pthread_mutex_unlock(&f->zbd_info->mutex);
751}
752
753static bool zbd_dec_and_reset_write_cnt(const struct thread_data *td,
754 const struct fio_file *f)
755{
756 uint32_t write_cnt = 0;
757
758 pthread_mutex_lock(&f->zbd_info->mutex);
759 assert(f->zbd_info->write_cnt);
760 if (f->zbd_info->write_cnt)
761 write_cnt = --f->zbd_info->write_cnt;
762 if (write_cnt == 0)
763 zbd_reset_write_cnt(td, f);
764 pthread_mutex_unlock(&f->zbd_info->mutex);
765
766 return write_cnt == 0;
767}
768
91d25131
BVA
769enum swd_action {
770 CHECK_SWD,
771 SET_SWD,
772};
773
774/* Calculate the number of sectors with data (swd) and perform action 'a' */
775static uint64_t zbd_process_swd(const struct fio_file *f, enum swd_action a)
615555bb 776{
615555bb
BVA
777 struct fio_zone_info *zb, *ze, *z;
778 uint64_t swd = 0;
779
780 zb = &f->zbd_info->zone_info[zbd_zone_idx(f, f->file_offset)];
781 ze = &f->zbd_info->zone_info[zbd_zone_idx(f, f->file_offset +
782 f->io_size)];
783 for (z = zb; z < ze; z++) {
784 pthread_mutex_lock(&z->mutex);
785 swd += z->wp - z->start;
786 }
787 pthread_mutex_lock(&f->zbd_info->mutex);
91d25131
BVA
788 switch (a) {
789 case CHECK_SWD:
790 assert(f->zbd_info->sectors_with_data == swd);
791 break;
792 case SET_SWD:
793 f->zbd_info->sectors_with_data = swd;
794 break;
795 }
615555bb
BVA
796 pthread_mutex_unlock(&f->zbd_info->mutex);
797 for (z = zb; z < ze; z++)
798 pthread_mutex_unlock(&z->mutex);
91d25131
BVA
799
800 return swd;
801}
802
803/*
804 * The swd check is useful for debugging but takes too much time to leave
805 * it enabled all the time. Hence it is disabled by default.
806 */
807static const bool enable_check_swd = false;
808
809/* Check whether the value of zbd_info.sectors_with_data is correct. */
810static void zbd_check_swd(const struct fio_file *f)
811{
812 if (!enable_check_swd)
813 return;
814
815 zbd_process_swd(f, CHECK_SWD);
816}
817
818static void zbd_init_swd(struct fio_file *f)
819{
820 uint64_t swd;
821
409a4f29
NA
822 if (!enable_check_swd)
823 return;
824
91d25131
BVA
825 swd = zbd_process_swd(f, SET_SWD);
826 dprint(FD_ZBD, "%s(%s): swd = %" PRIu64 "\n", __func__, f->file_name,
827 swd);
615555bb
BVA
828}
829
bfbdd35b
BVA
830void zbd_file_reset(struct thread_data *td, struct fio_file *f)
831{
91d25131 832 struct fio_zone_info *zb, *ze;
bfbdd35b
BVA
833 uint32_t zone_idx_e;
834
835 if (!f->zbd_info)
836 return;
837
838 zb = &f->zbd_info->zone_info[zbd_zone_idx(f, f->file_offset)];
839 zone_idx_e = zbd_zone_idx(f, f->file_offset + f->io_size);
840 ze = &f->zbd_info->zone_info[zone_idx_e];
91d25131 841 zbd_init_swd(f);
bfbdd35b
BVA
842 /*
843 * If data verification is enabled reset the affected zones before
844 * writing any data to avoid that a zone reset has to be issued while
845 * writing data, which causes data loss.
846 */
847 zbd_reset_zones(td, f, zb, ze, td->o.verify != VERIFY_NONE &&
848 (td->o.td_ddir & TD_DDIR_WRITE) &&
849 td->runstate != TD_VERIFYING);
a7c2b6fc 850 zbd_reset_write_cnt(td, f);
bfbdd35b
BVA
851}
852
59b07544
BVA
853/* The caller must hold f->zbd_info->mutex. */
854static bool is_zone_open(const struct thread_data *td, const struct fio_file *f,
855 unsigned int zone_idx)
856{
857 struct zoned_block_device_info *zbdi = f->zbd_info;
858 int i;
859
860 assert(td->o.max_open_zones <= ARRAY_SIZE(zbdi->open_zones));
861 assert(zbdi->num_open_zones <= td->o.max_open_zones);
862
863 for (i = 0; i < zbdi->num_open_zones; i++)
864 if (zbdi->open_zones[i] == zone_idx)
865 return true;
866
867 return false;
868}
869
870/*
871 * Open a ZBD zone if it was not yet open. Returns true if either the zone was
872 * already open or if opening a new zone is allowed. Returns false if the zone
873 * was not yet open and opening a new zone would cause the zone limit to be
874 * exceeded.
875 */
876static bool zbd_open_zone(struct thread_data *td, const struct io_u *io_u,
877 uint32_t zone_idx)
878{
879 const uint32_t min_bs = td->o.min_bs[DDIR_WRITE];
880 const struct fio_file *f = io_u->file;
881 struct fio_zone_info *z = &f->zbd_info->zone_info[zone_idx];
882 bool res = true;
883
884 if (z->cond == BLK_ZONE_COND_OFFLINE)
885 return false;
886
887 /*
888 * Skip full zones with data verification enabled because resetting a
889 * zone causes data loss and hence causes verification to fail.
890 */
891 if (td->o.verify != VERIFY_NONE && zbd_zone_full(f, z, min_bs))
892 return false;
893
894 /* Zero means no limit */
895 if (!td->o.max_open_zones)
896 return true;
897
898 pthread_mutex_lock(&f->zbd_info->mutex);
899 if (is_zone_open(td, f, zone_idx))
900 goto out;
901 res = false;
902 if (f->zbd_info->num_open_zones >= td->o.max_open_zones)
903 goto out;
904 dprint(FD_ZBD, "%s: opening zone %d\n", f->file_name, zone_idx);
905 f->zbd_info->open_zones[f->zbd_info->num_open_zones++] = zone_idx;
906 z->open = 1;
907 res = true;
908
909out:
910 pthread_mutex_unlock(&f->zbd_info->mutex);
911 return res;
912}
913
914/* The caller must hold f->zbd_info->mutex */
915static void zbd_close_zone(struct thread_data *td, const struct fio_file *f,
916 unsigned int open_zone_idx)
917{
918 uint32_t zone_idx;
919
920 assert(open_zone_idx < f->zbd_info->num_open_zones);
921 zone_idx = f->zbd_info->open_zones[open_zone_idx];
922 memmove(f->zbd_info->open_zones + open_zone_idx,
923 f->zbd_info->open_zones + open_zone_idx + 1,
924 (FIO_MAX_OPEN_ZBD_ZONES - (open_zone_idx + 1)) *
925 sizeof(f->zbd_info->open_zones[0]));
926 f->zbd_info->num_open_zones--;
927 f->zbd_info->zone_info[zone_idx].open = 0;
928}
929
b27aef6a
NA
930static void zone_lock(struct thread_data *td, struct fio_zone_info *z)
931{
932 /*
933 * Lock the io_u target zone. The zone will be unlocked if io_u offset
934 * is changed or when io_u completes and zbd_put_io() executed.
935 * To avoid multiple jobs doing asynchronous I/Os from deadlocking each
936 * other waiting for zone locks when building an io_u batch, first
937 * only trylock the zone. If the zone is already locked by another job,
938 * process the currently queued I/Os so that I/O progress is made and
939 * zones unlocked.
940 */
941 if (pthread_mutex_trylock(&z->mutex) != 0) {
942 if (!td_ioengine_flagged(td, FIO_SYNCIO))
943 io_u_quiesce(td);
944 pthread_mutex_lock(&z->mutex);
945 }
946}
947
59b07544
BVA
948/*
949 * Modify the offset of an I/O unit that does not refer to an open zone such
950 * that it refers to an open zone. Close an open zone and open a new zone if
951 * necessary. This algorithm can only work correctly if all write pointers are
952 * a multiple of the fio block size. The caller must neither hold z->mutex
953 * nor f->zbd_info->mutex. Returns with z->mutex held upon success.
954 */
379e5f09
BVA
955static struct fio_zone_info *zbd_convert_to_open_zone(struct thread_data *td,
956 struct io_u *io_u)
59b07544
BVA
957{
958 const uint32_t min_bs = td->o.min_bs[io_u->ddir];
959 const struct fio_file *f = io_u->file;
960 struct fio_zone_info *z;
961 unsigned int open_zone_idx = -1;
962 uint32_t zone_idx, new_zone_idx;
963 int i;
964
965 assert(is_valid_offset(f, io_u->offset));
966
967 if (td->o.max_open_zones) {
968 /*
969 * This statement accesses f->zbd_info->open_zones[] on purpose
970 * without locking.
971 */
972 zone_idx = f->zbd_info->open_zones[(io_u->offset -
973 f->file_offset) *
974 f->zbd_info->num_open_zones / f->io_size];
975 } else {
976 zone_idx = zbd_zone_idx(f, io_u->offset);
977 }
978 dprint(FD_ZBD, "%s(%s): starting from zone %d (offset %lld, buflen %lld)\n",
979 __func__, f->file_name, zone_idx, io_u->offset, io_u->buflen);
980
981 /*
982 * Since z->mutex is the outer lock and f->zbd_info->mutex the inner
983 * lock it can happen that the state of the zone with index zone_idx
984 * has changed after 'z' has been assigned and before f->zbd_info->mutex
985 * has been obtained. Hence the loop.
986 */
987 for (;;) {
988 z = &f->zbd_info->zone_info[zone_idx];
989
b27aef6a 990 zone_lock(td, z);
59b07544
BVA
991 pthread_mutex_lock(&f->zbd_info->mutex);
992 if (td->o.max_open_zones == 0)
993 goto examine_zone;
994 if (f->zbd_info->num_open_zones == 0) {
995 pthread_mutex_unlock(&f->zbd_info->mutex);
996 pthread_mutex_unlock(&z->mutex);
997 dprint(FD_ZBD, "%s(%s): no zones are open\n",
998 __func__, f->file_name);
999 return NULL;
1000 }
1001 open_zone_idx = (io_u->offset - f->file_offset) *
1002 f->zbd_info->num_open_zones / f->io_size;
1003 assert(open_zone_idx < f->zbd_info->num_open_zones);
1004 new_zone_idx = f->zbd_info->open_zones[open_zone_idx];
1005 if (new_zone_idx == zone_idx)
1006 break;
1007 zone_idx = new_zone_idx;
1008 pthread_mutex_unlock(&f->zbd_info->mutex);
1009 pthread_mutex_unlock(&z->mutex);
1010 }
1011
1012 /* Both z->mutex and f->zbd_info->mutex are held. */
1013
1014examine_zone:
ee3696bd 1015 if (z->wp + min_bs <= (z+1)->start) {
59b07544
BVA
1016 pthread_mutex_unlock(&f->zbd_info->mutex);
1017 goto out;
1018 }
1019 dprint(FD_ZBD, "%s(%s): closing zone %d\n", __func__, f->file_name,
1020 zone_idx);
1021 if (td->o.max_open_zones)
1022 zbd_close_zone(td, f, open_zone_idx);
1023 pthread_mutex_unlock(&f->zbd_info->mutex);
1024
1025 /* Only z->mutex is held. */
1026
1027 /* Zone 'z' is full, so try to open a new zone. */
1028 for (i = f->io_size / f->zbd_info->zone_size; i > 0; i--) {
1029 zone_idx++;
1030 pthread_mutex_unlock(&z->mutex);
1031 z++;
ee3696bd 1032 if (!is_valid_offset(f, z->start)) {
59b07544
BVA
1033 /* Wrap-around. */
1034 zone_idx = zbd_zone_idx(f, f->file_offset);
1035 z = &f->zbd_info->zone_info[zone_idx];
1036 }
ee3696bd 1037 assert(is_valid_offset(f, z->start));
b27aef6a 1038 zone_lock(td, z);
59b07544
BVA
1039 if (z->open)
1040 continue;
1041 if (zbd_open_zone(td, io_u, zone_idx))
1042 goto out;
1043 }
1044
1045 /* Only z->mutex is held. */
1046
1047 /* Check whether the write fits in any of the already opened zones. */
1048 pthread_mutex_lock(&f->zbd_info->mutex);
1049 for (i = 0; i < f->zbd_info->num_open_zones; i++) {
1050 zone_idx = f->zbd_info->open_zones[i];
1051 pthread_mutex_unlock(&f->zbd_info->mutex);
1052 pthread_mutex_unlock(&z->mutex);
1053
1054 z = &f->zbd_info->zone_info[zone_idx];
1055
b27aef6a 1056 zone_lock(td, z);
ee3696bd 1057 if (z->wp + min_bs <= (z+1)->start)
59b07544
BVA
1058 goto out;
1059 pthread_mutex_lock(&f->zbd_info->mutex);
1060 }
1061 pthread_mutex_unlock(&f->zbd_info->mutex);
1062 pthread_mutex_unlock(&z->mutex);
1063 dprint(FD_ZBD, "%s(%s): did not open another zone\n", __func__,
1064 f->file_name);
1065 return NULL;
1066
1067out:
1068 dprint(FD_ZBD, "%s(%s): returning zone %d\n", __func__, f->file_name,
1069 zone_idx);
ee3696bd 1070 io_u->offset = z->start;
59b07544
BVA
1071 return z;
1072}
1073
bfbdd35b 1074/* The caller must hold z->mutex. */
59b07544
BVA
1075static struct fio_zone_info *zbd_replay_write_order(struct thread_data *td,
1076 struct io_u *io_u,
1077 struct fio_zone_info *z)
bfbdd35b
BVA
1078{
1079 const struct fio_file *f = io_u->file;
1080 const uint32_t min_bs = td->o.min_bs[DDIR_WRITE];
1081
59b07544
BVA
1082 if (!zbd_open_zone(td, io_u, z - f->zbd_info->zone_info)) {
1083 pthread_mutex_unlock(&z->mutex);
1084 z = zbd_convert_to_open_zone(td, io_u);
1085 assert(z);
1086 }
1087
bfbdd35b 1088 if (z->verify_block * min_bs >= f->zbd_info->zone_size)
a0c84dd4
JA
1089 log_err("%s: %d * %d >= %llu\n", f->file_name, z->verify_block,
1090 min_bs, (unsigned long long) f->zbd_info->zone_size);
ee3696bd 1091 io_u->offset = z->start + z->verify_block++ * min_bs;
59b07544 1092 return z;
bfbdd35b
BVA
1093}
1094
1095/*
1096 * Find another zone for which @io_u fits below the write pointer. Start
1097 * searching in zones @zb + 1 .. @zl and continue searching in zones
1098 * @zf .. @zb - 1.
1099 *
1100 * Either returns NULL or returns a zone pointer and holds the mutex for that
1101 * zone.
1102 */
1103static struct fio_zone_info *
1104zbd_find_zone(struct thread_data *td, struct io_u *io_u,
1105 struct fio_zone_info *zb, struct fio_zone_info *zl)
1106{
1107 const uint32_t min_bs = td->o.min_bs[io_u->ddir];
1108 const struct fio_file *f = io_u->file;
1109 struct fio_zone_info *z1, *z2;
1110 const struct fio_zone_info *const zf =
1111 &f->zbd_info->zone_info[zbd_zone_idx(f, f->file_offset)];
1112
1113 /*
1114 * Skip to the next non-empty zone in case of sequential I/O and to
1115 * the nearest non-empty zone in case of random I/O.
1116 */
1117 for (z1 = zb + 1, z2 = zb - 1; z1 < zl || z2 >= zf; z1++, z2--) {
1118 if (z1 < zl && z1->cond != BLK_ZONE_COND_OFFLINE) {
1119 pthread_mutex_lock(&z1->mutex);
ee3696bd 1120 if (z1->start + min_bs <= z1->wp)
bfbdd35b
BVA
1121 return z1;
1122 pthread_mutex_unlock(&z1->mutex);
1123 } else if (!td_random(td)) {
1124 break;
1125 }
1126 if (td_random(td) && z2 >= zf &&
1127 z2->cond != BLK_ZONE_COND_OFFLINE) {
1128 pthread_mutex_lock(&z2->mutex);
ee3696bd 1129 if (z2->start + min_bs <= z2->wp)
bfbdd35b
BVA
1130 return z2;
1131 pthread_mutex_unlock(&z2->mutex);
1132 }
1133 }
1134 dprint(FD_ZBD, "%s: adjusting random read offset failed\n",
1135 f->file_name);
1136 return NULL;
1137}
1138
bfbdd35b 1139/**
d9ed3e63 1140 * zbd_queue_io - update the write pointer of a sequential zone
bfbdd35b 1141 * @io_u: I/O unit
d9ed3e63
DLM
1142 * @success: Whether or not the I/O unit has been queued successfully
1143 * @q: queueing status (busy, completed or queued).
bfbdd35b 1144 *
d9ed3e63
DLM
1145 * For write and trim operations, update the write pointer of the I/O unit
1146 * target zone.
bfbdd35b 1147 */
d9ed3e63 1148static void zbd_queue_io(struct io_u *io_u, int q, bool success)
bfbdd35b 1149{
d9ed3e63
DLM
1150 const struct fio_file *f = io_u->file;
1151 struct zoned_block_device_info *zbd_info = f->zbd_info;
bfbdd35b
BVA
1152 struct fio_zone_info *z;
1153 uint32_t zone_idx;
d9ed3e63 1154 uint64_t zone_end;
bfbdd35b 1155
bfbdd35b
BVA
1156 if (!zbd_info)
1157 return;
1158
d9ed3e63 1159 zone_idx = zbd_zone_idx(f, io_u->offset);
bfbdd35b 1160 assert(zone_idx < zbd_info->nr_zones);
d9ed3e63
DLM
1161 z = &zbd_info->zone_info[zone_idx];
1162
bfbdd35b
BVA
1163 if (z->type != BLK_ZONE_TYPE_SEQWRITE_REQ)
1164 return;
d9ed3e63 1165
bfbdd35b
BVA
1166 if (!success)
1167 goto unlock;
d9ed3e63
DLM
1168
1169 dprint(FD_ZBD,
1170 "%s: queued I/O (%lld, %llu) for zone %u\n",
1171 f->file_name, io_u->offset, io_u->buflen, zone_idx);
1172
bfbdd35b
BVA
1173 switch (io_u->ddir) {
1174 case DDIR_WRITE:
d9ed3e63
DLM
1175 zone_end = min((uint64_t)(io_u->offset + io_u->buflen),
1176 (z + 1)->start);
a7c2b6fc
BVA
1177 pthread_mutex_lock(&zbd_info->mutex);
1178 /*
1179 * z->wp > zone_end means that one or more I/O errors
1180 * have occurred.
1181 */
1182 if (z->wp <= zone_end)
1183 zbd_info->sectors_with_data += zone_end - z->wp;
1184 pthread_mutex_unlock(&zbd_info->mutex);
bfbdd35b
BVA
1185 z->wp = zone_end;
1186 break;
1187 case DDIR_TRIM:
1188 assert(z->wp == z->start);
1189 break;
1190 default:
1191 break;
1192 }
d9ed3e63 1193
bfbdd35b 1194unlock:
d9ed3e63
DLM
1195 if (!success || q != FIO_Q_QUEUED) {
1196 /* BUSY or COMPLETED: unlock the zone */
1197 pthread_mutex_unlock(&z->mutex);
1198 io_u->zbd_put_io = NULL;
1199 }
1200}
1201
1202/**
1203 * zbd_put_io - Unlock an I/O unit target zone lock
1204 * @io_u: I/O unit
1205 */
1206static void zbd_put_io(const struct io_u *io_u)
1207{
1208 const struct fio_file *f = io_u->file;
1209 struct zoned_block_device_info *zbd_info = f->zbd_info;
1210 struct fio_zone_info *z;
1211 uint32_t zone_idx;
1212
1213 if (!zbd_info)
1214 return;
615555bb 1215
d9ed3e63
DLM
1216 zone_idx = zbd_zone_idx(f, io_u->offset);
1217 assert(zone_idx < zbd_info->nr_zones);
1218 z = &zbd_info->zone_info[zone_idx];
1219
1220 if (z->type != BLK_ZONE_TYPE_SEQWRITE_REQ)
1221 return;
1222
1223 dprint(FD_ZBD,
1224 "%s: terminate I/O (%lld, %llu) for zone %u\n",
1225 f->file_name, io_u->offset, io_u->buflen, zone_idx);
1226
1227 assert(pthread_mutex_unlock(&z->mutex) == 0);
1228 zbd_check_swd(f);
bfbdd35b
BVA
1229}
1230
1231bool zbd_unaligned_write(int error_code)
1232{
1233 switch (error_code) {
1234 case EIO:
1235 case EREMOTEIO:
1236 return true;
1237 }
1238 return false;
1239}
1240
4d37720a
DLM
1241/**
1242 * setup_zbd_zone_mode - handle zoneskip as necessary for ZBD drives
1243 * @td: FIO thread data.
1244 * @io_u: FIO I/O unit.
1245 *
1246 * For sequential workloads, change the file offset to skip zoneskip bytes when
1247 * no more IO can be performed in the current zone.
1248 * - For read workloads, zoneskip is applied when the io has reached the end of
1249 * the zone or the zone write position (when td->o.read_beyond_wp is false).
1250 * - For write workloads, zoneskip is applied when the zone is full.
1251 * This applies only to read and write operations.
1252 */
1253void setup_zbd_zone_mode(struct thread_data *td, struct io_u *io_u)
1254{
1255 struct fio_file *f = io_u->file;
1256 enum fio_ddir ddir = io_u->ddir;
1257 struct fio_zone_info *z;
1258 uint32_t zone_idx;
1259
1260 assert(td->o.zone_mode == ZONE_MODE_ZBD);
1261 assert(td->o.zone_size);
1262
1263 /*
1264 * zone_skip is valid only for sequential workloads.
1265 */
1266 if (td_random(td) || !td->o.zone_skip)
1267 return;
1268
1269 /*
1270 * It is time to switch to a new zone if:
1271 * - zone_bytes == zone_size bytes have already been accessed
1272 * - The last position reached the end of the current zone.
1273 * - For reads with td->o.read_beyond_wp == false, the last position
1274 * reached the zone write pointer.
1275 */
1276 zone_idx = zbd_zone_idx(f, f->last_pos[ddir]);
1277 z = &f->zbd_info->zone_info[zone_idx];
1278
1279 if (td->zone_bytes >= td->o.zone_size ||
1280 f->last_pos[ddir] >= (z+1)->start ||
1281 (ddir == DDIR_READ &&
1282 (!td->o.read_beyond_wp) && f->last_pos[ddir] >= z->wp)) {
1283 /*
1284 * Skip zones.
1285 */
1286 td->zone_bytes = 0;
1287 f->file_offset += td->o.zone_size + td->o.zone_skip;
1288
1289 /*
1290 * Wrap from the beginning, if we exceed the file size
1291 */
1292 if (f->file_offset >= f->real_file_size)
1293 f->file_offset = get_start_offset(td, f);
1294
1295 f->last_pos[ddir] = f->file_offset;
1296 td->io_skip_bytes += td->o.zone_skip;
1297 }
1298}
1299
bfbdd35b
BVA
1300/**
1301 * zbd_adjust_block - adjust the offset and length as necessary for ZBD drives
1302 * @td: FIO thread data.
1303 * @io_u: FIO I/O unit.
1304 *
1305 * Locking strategy: returns with z->mutex locked if and only if z refers
1306 * to a sequential zone and if io_u_accept is returned. z is the zone that
1307 * corresponds to io_u->offset at the end of this function.
1308 */
1309enum io_u_action zbd_adjust_block(struct thread_data *td, struct io_u *io_u)
1310{
1311 const struct fio_file *f = io_u->file;
1312 uint32_t zone_idx_b;
de65f7b7 1313 struct fio_zone_info *zb, *zl, *orig_zb;
bfbdd35b
BVA
1314 uint32_t orig_len = io_u->buflen;
1315 uint32_t min_bs = td->o.min_bs[io_u->ddir];
1316 uint64_t new_len;
1317 int64_t range;
1318
1319 if (!f->zbd_info)
1320 return io_u_accept;
1321
1322 assert(is_valid_offset(f, io_u->offset));
1323 assert(io_u->buflen);
1324 zone_idx_b = zbd_zone_idx(f, io_u->offset);
1325 zb = &f->zbd_info->zone_info[zone_idx_b];
de65f7b7 1326 orig_zb = zb;
bfbdd35b
BVA
1327
1328 /* Accept the I/O offset for conventional zones. */
1329 if (zb->type == BLK_ZONE_TYPE_CONVENTIONAL)
1330 return io_u_accept;
1331
1332 /*
1333 * Accept the I/O offset for reads if reading beyond the write pointer
1334 * is enabled.
1335 */
1336 if (zb->cond != BLK_ZONE_COND_OFFLINE &&
1337 io_u->ddir == DDIR_READ && td->o.read_beyond_wp)
1338 return io_u_accept;
1339
615555bb
BVA
1340 zbd_check_swd(f);
1341
b27aef6a 1342 zone_lock(td, zb);
6f0c6085 1343
bfbdd35b
BVA
1344 switch (io_u->ddir) {
1345 case DDIR_READ:
1346 if (td->runstate == TD_VERIFYING) {
59b07544 1347 zb = zbd_replay_write_order(td, io_u, zb);
bfbdd35b
BVA
1348 goto accept;
1349 }
1350 /*
de65f7b7
DLM
1351 * Check that there is enough written data in the zone to do an
1352 * I/O of at least min_bs B. If there isn't, find a new zone for
1353 * the I/O.
bfbdd35b
BVA
1354 */
1355 range = zb->cond != BLK_ZONE_COND_OFFLINE ?
ee3696bd 1356 zb->wp - zb->start : 0;
de65f7b7 1357 if (range < min_bs ||
ee3696bd 1358 ((!td_random(td)) && (io_u->offset + min_bs > zb->wp))) {
bfbdd35b
BVA
1359 pthread_mutex_unlock(&zb->mutex);
1360 zl = &f->zbd_info->zone_info[zbd_zone_idx(f,
1361 f->file_offset + f->io_size)];
1362 zb = zbd_find_zone(td, io_u, zb, zl);
1363 if (!zb) {
1364 dprint(FD_ZBD,
1365 "%s: zbd_find_zone(%lld, %llu) failed\n",
1366 f->file_name, io_u->offset,
1367 io_u->buflen);
1368 goto eof;
1369 }
de65f7b7
DLM
1370 /*
1371 * zbd_find_zone() returned a zone with a range of at
1372 * least min_bs.
1373 */
ee3696bd 1374 range = zb->wp - zb->start;
de65f7b7
DLM
1375 assert(range >= min_bs);
1376
1377 if (!td_random(td))
ee3696bd 1378 io_u->offset = zb->start;
bfbdd35b 1379 }
de65f7b7
DLM
1380 /*
1381 * Make sure the I/O is within the zone valid data range while
1382 * maximizing the I/O size and preserving randomness.
1383 */
1384 if (range <= io_u->buflen)
ee3696bd 1385 io_u->offset = zb->start;
de65f7b7 1386 else if (td_random(td))
ee3696bd
DLM
1387 io_u->offset = zb->start +
1388 ((io_u->offset - orig_zb->start) %
de65f7b7
DLM
1389 (range - io_u->buflen)) / min_bs * min_bs;
1390 /*
1391 * Make sure the I/O does not cross over the zone wp position.
1392 */
1393 new_len = min((unsigned long long)io_u->buflen,
ee3696bd 1394 (unsigned long long)(zb->wp - io_u->offset));
de65f7b7
DLM
1395 new_len = new_len / min_bs * min_bs;
1396 if (new_len < io_u->buflen) {
1397 io_u->buflen = new_len;
1398 dprint(FD_IO, "Changed length from %u into %llu\n",
1399 orig_len, io_u->buflen);
bfbdd35b 1400 }
ee3696bd
DLM
1401 assert(zb->start <= io_u->offset);
1402 assert(io_u->offset + io_u->buflen <= zb->wp);
bfbdd35b
BVA
1403 goto accept;
1404 case DDIR_WRITE:
ee3696bd 1405 if (io_u->buflen > f->zbd_info->zone_size)
bfbdd35b 1406 goto eof;
59b07544
BVA
1407 if (!zbd_open_zone(td, io_u, zone_idx_b)) {
1408 pthread_mutex_unlock(&zb->mutex);
1409 zb = zbd_convert_to_open_zone(td, io_u);
1410 if (!zb)
1411 goto eof;
1412 zone_idx_b = zb - f->zbd_info->zone_info;
1413 }
a7c2b6fc
BVA
1414 /* Check whether the zone reset threshold has been exceeded */
1415 if (td->o.zrf.u.f) {
ee3696bd 1416 if (f->zbd_info->sectors_with_data >=
a7c2b6fc
BVA
1417 f->io_size * td->o.zrt.u.f &&
1418 zbd_dec_and_reset_write_cnt(td, f)) {
1419 zb->reset_zone = 1;
1420 }
1421 }
bfbdd35b
BVA
1422 /* Reset the zone pointer if necessary */
1423 if (zb->reset_zone || zbd_zone_full(f, zb, min_bs)) {
1424 assert(td->o.verify == VERIFY_NONE);
1425 /*
1426 * Since previous write requests may have been submitted
1427 * asynchronously and since we will submit the zone
1428 * reset synchronously, wait until previously submitted
1429 * write requests have completed before issuing a
1430 * zone reset.
1431 */
1432 io_u_quiesce(td);
1433 zb->reset_zone = 0;
1434 if (zbd_reset_zone(td, f, zb) < 0)
1435 goto eof;
1436 }
1437 /* Make writes occur at the write pointer */
1438 assert(!zbd_zone_full(f, zb, min_bs));
ee3696bd 1439 io_u->offset = zb->wp;
bfbdd35b
BVA
1440 if (!is_valid_offset(f, io_u->offset)) {
1441 dprint(FD_ZBD, "Dropped request with offset %llu\n",
1442 io_u->offset);
1443 goto eof;
1444 }
1445 /*
1446 * Make sure that the buflen is a multiple of the minimal
1447 * block size. Give up if shrinking would make the request too
1448 * small.
1449 */
1450 new_len = min((unsigned long long)io_u->buflen,
ee3696bd 1451 (zb + 1)->start - io_u->offset);
bfbdd35b
BVA
1452 new_len = new_len / min_bs * min_bs;
1453 if (new_len == io_u->buflen)
1454 goto accept;
1455 if (new_len >= min_bs) {
1456 io_u->buflen = new_len;
1457 dprint(FD_IO, "Changed length from %u into %llu\n",
1458 orig_len, io_u->buflen);
1459 goto accept;
1460 }
1461 log_err("Zone remainder %lld smaller than minimum block size %d\n",
ee3696bd 1462 ((zb + 1)->start - io_u->offset),
bfbdd35b
BVA
1463 min_bs);
1464 goto eof;
1465 case DDIR_TRIM:
1466 /* fall-through */
1467 case DDIR_SYNC:
1468 case DDIR_DATASYNC:
1469 case DDIR_SYNC_FILE_RANGE:
1470 case DDIR_WAIT:
1471 case DDIR_LAST:
1472 case DDIR_INVAL:
1473 goto accept;
1474 }
1475
1476 assert(false);
1477
1478accept:
1479 assert(zb);
1480 assert(zb->cond != BLK_ZONE_COND_OFFLINE);
d9ed3e63
DLM
1481 assert(!io_u->zbd_queue_io);
1482 assert(!io_u->zbd_put_io);
1483 io_u->zbd_queue_io = zbd_queue_io;
1484 io_u->zbd_put_io = zbd_put_io;
bfbdd35b
BVA
1485 return io_u_accept;
1486
1487eof:
1488 if (zb)
1489 pthread_mutex_unlock(&zb->mutex);
1490 return io_u_eof;
1491}
fd5d733f
BVA
1492
1493/* Return a string with ZBD statistics */
1494char *zbd_write_status(const struct thread_stat *ts)
1495{
1496 char *res;
1497
a0c84dd4 1498 if (asprintf(&res, "; %llu zone resets", (unsigned long long) ts->nr_zone_resets) < 0)
fd5d733f
BVA
1499 return NULL;
1500 return res;
1501}