42487780ca77e5cf7f67665545f47c856bbd2919
[fio.git] / zbd.c
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>
16 #include "file.h"
17 #include "fio.h"
18 #include "lib/pow2.h"
19 #include "log.h"
20 #include "smalloc.h"
21 #include "verify.h"
22 #include "zbd.h"
23
24 /**
25  * zbd_zone_idx - convert an offset into a zone number
26  * @f: file pointer.
27  * @offset: offset in bytes. If this offset is in the first zone_size bytes
28  *          past the disk size then the index of the sentinel is returned.
29  */
30 static uint32_t zbd_zone_idx(const struct fio_file *f, uint64_t offset)
31 {
32         uint32_t zone_idx;
33
34         if (f->zbd_info->zone_size_log2)
35                 zone_idx = offset >> f->zbd_info->zone_size_log2;
36         else
37                 zone_idx = (offset >> 9) / f->zbd_info->zone_size;
38
39         return min(zone_idx, f->zbd_info->nr_zones);
40 }
41
42 /**
43  * zbd_zone_full - verify whether a minimum number of bytes remain in a zone
44  * @f: file pointer.
45  * @z: zone info pointer.
46  * @required: minimum number of bytes that must remain in a zone.
47  *
48  * The caller must hold z->mutex.
49  */
50 static bool zbd_zone_full(const struct fio_file *f, struct fio_zone_info *z,
51                           uint64_t required)
52 {
53         assert((required & 511) == 0);
54
55         return z->type == BLK_ZONE_TYPE_SEQWRITE_REQ &&
56                 z->wp + (required >> 9) > z->start + f->zbd_info->zone_size;
57 }
58
59 static bool is_valid_offset(const struct fio_file *f, uint64_t offset)
60 {
61         return (uint64_t)(offset - f->file_offset) < f->io_size;
62 }
63
64 /* Verify whether direct I/O is used for all host-managed zoned drives. */
65 static bool zbd_using_direct_io(void)
66 {
67         struct thread_data *td;
68         struct fio_file *f;
69         int i, j;
70
71         for_each_td(td, i) {
72                 if (td->o.odirect || !(td->o.td_ddir & TD_DDIR_WRITE))
73                         continue;
74                 for_each_file(td, f, j) {
75                         if (f->zbd_info &&
76                             f->zbd_info->model == ZBD_DM_HOST_MANAGED)
77                                 return false;
78                 }
79         }
80
81         return true;
82 }
83
84 /* Whether or not the I/O range for f includes one or more sequential zones */
85 static bool zbd_is_seq_job(struct fio_file *f)
86 {
87         uint32_t zone_idx, zone_idx_b, zone_idx_e;
88
89         assert(f->zbd_info);
90         if (f->io_size == 0)
91                 return false;
92         zone_idx_b = zbd_zone_idx(f, f->file_offset);
93         zone_idx_e = zbd_zone_idx(f, f->file_offset + f->io_size - 1);
94         for (zone_idx = zone_idx_b; zone_idx <= zone_idx_e; zone_idx++)
95                 if (f->zbd_info->zone_info[zone_idx].type ==
96                     BLK_ZONE_TYPE_SEQWRITE_REQ)
97                         return true;
98
99         return false;
100 }
101
102 /*
103  * Verify whether offset and size parameters are aligned with zone boundaries.
104  */
105 static bool zbd_verify_sizes(void)
106 {
107         const struct fio_zone_info *z;
108         struct thread_data *td;
109         struct fio_file *f;
110         uint64_t new_offset, new_end;
111         uint32_t zone_idx;
112         int i, j;
113
114         for_each_td(td, i) {
115                 for_each_file(td, f, j) {
116                         if (!f->zbd_info)
117                                 continue;
118                         if (f->file_offset >= f->real_file_size)
119                                 continue;
120                         if (!zbd_is_seq_job(f))
121                                 continue;
122                         zone_idx = zbd_zone_idx(f, f->file_offset);
123                         z = &f->zbd_info->zone_info[zone_idx];
124                         if (f->file_offset != (z->start << 9)) {
125                                 new_offset = (z+1)->start << 9;
126                                 if (new_offset >= f->file_offset + f->io_size) {
127                                         log_info("%s: io_size must be at least one zone\n",
128                                                  f->file_name);
129                                         return false;
130                                 }
131                                 log_info("%s: rounded up offset from %lu to %lu\n",
132                                          f->file_name, f->file_offset,
133                                          new_offset);
134                                 f->io_size -= (new_offset - f->file_offset);
135                                 f->file_offset = new_offset;
136                         }
137                         zone_idx = zbd_zone_idx(f, f->file_offset + f->io_size);
138                         z = &f->zbd_info->zone_info[zone_idx];
139                         new_end = z->start << 9;
140                         if (f->file_offset + f->io_size != new_end) {
141                                 if (new_end <= f->file_offset) {
142                                         log_info("%s: io_size must be at least one zone\n",
143                                                  f->file_name);
144                                         return false;
145                                 }
146                                 log_info("%s: rounded down io_size from %lu to %lu\n",
147                                          f->file_name, f->io_size,
148                                          new_end - f->file_offset);
149                                 f->io_size = new_end - f->file_offset;
150                         }
151                 }
152         }
153
154         return true;
155 }
156
157 static bool zbd_verify_bs(void)
158 {
159         struct thread_data *td;
160         struct fio_file *f;
161         uint32_t zone_size;
162         int i, j, k;
163
164         for_each_td(td, i) {
165                 for_each_file(td, f, j) {
166                         if (!f->zbd_info)
167                                 continue;
168                         zone_size = f->zbd_info->zone_size;
169                         for (k = 0; k < ARRAY_SIZE(td->o.bs); k++) {
170                                 if (td->o.verify != VERIFY_NONE &&
171                                     (zone_size << 9) % td->o.bs[k] != 0) {
172                                         log_info("%s: block size %llu is not a divisor of the zone size %d\n",
173                                                  f->file_name, td->o.bs[k],
174                                                  zone_size << 9);
175                                         return false;
176                                 }
177                         }
178                 }
179         }
180         return true;
181 }
182
183 /*
184  * Read zone information into @buf starting from sector @start_sector.
185  * @fd is a file descriptor that refers to a block device and @bufsz is the
186  * size of @buf.
187  *
188  * Returns 0 upon success and a negative error code upon failure.
189  */
190 static int read_zone_info(int fd, uint64_t start_sector,
191                           void *buf, unsigned int bufsz)
192 {
193         struct blk_zone_report *hdr = buf;
194
195         if (bufsz < sizeof(*hdr))
196                 return -EINVAL;
197
198         memset(hdr, 0, sizeof(*hdr));
199
200         hdr->nr_zones = (bufsz - sizeof(*hdr)) / sizeof(struct blk_zone);
201         hdr->sector = start_sector;
202         return ioctl(fd, BLKREPORTZONE, hdr) >= 0 ? 0 : -errno;
203 }
204
205 /*
206  * Read up to 255 characters from the first line of a file. Strip the trailing
207  * newline.
208  */
209 static char *read_file(const char *path)
210 {
211         char line[256], *p = line;
212         FILE *f;
213
214         f = fopen(path, "rb");
215         if (!f)
216                 return NULL;
217         if (!fgets(line, sizeof(line), f))
218                 line[0] = '\0';
219         strsep(&p, "\n");
220         fclose(f);
221
222         return strdup(line);
223 }
224
225 static enum blk_zoned_model get_zbd_model(const char *file_name)
226 {
227         enum blk_zoned_model model = ZBD_DM_NONE;
228         char *zoned_attr_path = NULL;
229         char *model_str = NULL;
230         struct stat statbuf;
231
232         if (stat(file_name, &statbuf) < 0)
233                 goto out;
234         if (asprintf(&zoned_attr_path, "/sys/dev/block/%d:%d/queue/zoned",
235                      major(statbuf.st_rdev), minor(statbuf.st_rdev)) < 0)
236                 goto out;
237         model_str = read_file(zoned_attr_path);
238         if (!model_str)
239                 goto out;
240         dprint(FD_ZBD, "%s: zbd model string: %s\n", file_name, model_str);
241         if (strcmp(model_str, "host-aware") == 0)
242                 model = ZBD_DM_HOST_AWARE;
243         else if (strcmp(model_str, "host-managed") == 0)
244                 model = ZBD_DM_HOST_MANAGED;
245
246 out:
247         free(model_str);
248         free(zoned_attr_path);
249         return model;
250 }
251
252 static int ilog2(uint64_t i)
253 {
254         int log = -1;
255
256         while (i) {
257                 i >>= 1;
258                 log++;
259         }
260         return log;
261 }
262
263 /*
264  * Initialize f->zbd_info for devices that are not zoned block devices. This
265  * allows to execute a ZBD workload against a non-ZBD device.
266  */
267 static int init_zone_info(struct thread_data *td, struct fio_file *f)
268 {
269         uint32_t nr_zones;
270         struct fio_zone_info *p;
271         uint64_t zone_size;
272         struct zoned_block_device_info *zbd_info = NULL;
273         pthread_mutexattr_t attr;
274         int i;
275
276         zone_size = td->o.zone_size >> 9;
277         assert(zone_size);
278         nr_zones = ((f->real_file_size >> 9) + zone_size - 1) / zone_size;
279         zbd_info = scalloc(1, sizeof(*zbd_info) +
280                            (nr_zones + 1) * sizeof(zbd_info->zone_info[0]));
281         if (!zbd_info)
282                 return -ENOMEM;
283
284         pthread_mutexattr_init(&attr);
285         pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);
286         pthread_mutexattr_setpshared(&attr, true);
287         pthread_mutex_init(&zbd_info->mutex, &attr);
288         zbd_info->refcount = 1;
289         p = &zbd_info->zone_info[0];
290         for (i = 0; i < nr_zones; i++, p++) {
291                 pthread_mutex_init(&p->mutex, &attr);
292                 p->start = i * zone_size;
293                 p->wp = p->start + zone_size;
294                 p->type = BLK_ZONE_TYPE_SEQWRITE_REQ;
295                 p->cond = BLK_ZONE_COND_EMPTY;
296         }
297         /* a sentinel */
298         p->start = nr_zones * zone_size;
299
300         f->zbd_info = zbd_info;
301         f->zbd_info->zone_size = zone_size;
302         f->zbd_info->zone_size_log2 = is_power_of_2(zone_size) ?
303                 ilog2(zone_size) + 9 : -1;
304         f->zbd_info->nr_zones = nr_zones;
305         pthread_mutexattr_destroy(&attr);
306         return 0;
307 }
308
309 /*
310  * Parse the BLKREPORTZONE output and store it in f->zbd_info. Must be called
311  * only for devices that support this ioctl, namely zoned block devices.
312  */
313 static int parse_zone_info(struct thread_data *td, struct fio_file *f)
314 {
315         const unsigned int bufsz = sizeof(struct blk_zone_report) +
316                 4096 * sizeof(struct blk_zone);
317         uint32_t nr_zones;
318         struct blk_zone_report *hdr;
319         const struct blk_zone *z;
320         struct fio_zone_info *p;
321         uint64_t zone_size, start_sector;
322         struct zoned_block_device_info *zbd_info = NULL;
323         pthread_mutexattr_t attr;
324         void *buf;
325         int fd, i, j, ret = 0;
326
327         pthread_mutexattr_init(&attr);
328         pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);
329         pthread_mutexattr_setpshared(&attr, true);
330
331         buf = malloc(bufsz);
332         if (!buf)
333                 goto out;
334
335         fd = open(f->file_name, O_RDONLY | O_LARGEFILE);
336         if (fd < 0) {
337                 ret = -errno;
338                 goto free;
339         }
340
341         ret = read_zone_info(fd, 0, buf, bufsz);
342         if (ret < 0) {
343                 log_info("fio: BLKREPORTZONE(%lu) failed for %s (%d).\n",
344                          0UL, f->file_name, -ret);
345                 goto close;
346         }
347         hdr = buf;
348         if (hdr->nr_zones < 1) {
349                 log_info("fio: %s has invalid zone information.\n",
350                          f->file_name);
351                 goto close;
352         }
353         z = (void *)(hdr + 1);
354         zone_size = z->len;
355         nr_zones = ((f->real_file_size >> 9) + zone_size - 1) / zone_size;
356
357         if (td->o.zone_size == 0) {
358                 td->o.zone_size = zone_size << 9;
359         } else if (td->o.zone_size != zone_size << 9) {
360                 log_info("fio: %s job parameter zonesize %lld does not match disk zone size %ld.\n",
361                          f->file_name, td->o.zone_size, zone_size << 9);
362                 ret = -EINVAL;
363                 goto close;
364         }
365
366         dprint(FD_ZBD, "Device %s has %d zones of size %lu KB\n", f->file_name,
367                nr_zones, zone_size / 2);
368
369         zbd_info = scalloc(1, sizeof(*zbd_info) +
370                            (nr_zones + 1) * sizeof(zbd_info->zone_info[0]));
371         ret = -ENOMEM;
372         if (!zbd_info)
373                 goto close;
374         pthread_mutex_init(&zbd_info->mutex, &attr);
375         zbd_info->refcount = 1;
376         p = &zbd_info->zone_info[0];
377         for (start_sector = 0, j = 0; j < nr_zones;) {
378                 z = (void *)(hdr + 1);
379                 for (i = 0; i < hdr->nr_zones; i++, j++, z++, p++) {
380                         pthread_mutex_init(&p->mutex, &attr);
381                         p->start = z->start;
382                         switch (z->cond) {
383                         case BLK_ZONE_COND_NOT_WP:
384                                 p->wp = z->start;
385                                 break;
386                         case BLK_ZONE_COND_FULL:
387                                 p->wp = z->start + zone_size;
388                                 break;
389                         default:
390                                 assert(z->start <= z->wp);
391                                 assert(z->wp <= z->start + zone_size);
392                                 p->wp = z->wp;
393                                 break;
394                         }
395                         p->type = z->type;
396                         p->cond = z->cond;
397                         if (j > 0 && p->start != p[-1].start + zone_size) {
398                                 log_info("%s: invalid zone data\n",
399                                          f->file_name);
400                                 ret = -EINVAL;
401                                 goto close;
402                         }
403                 }
404                 z--;
405                 start_sector = z->start + z->len;
406                 if (j >= nr_zones)
407                         break;
408                 ret = read_zone_info(fd, start_sector, buf, bufsz);
409                 if (ret < 0) {
410                         log_info("fio: BLKREPORTZONE(%lu) failed for %s (%d).\n",
411                                  start_sector, f->file_name, -ret);
412                         goto close;
413                 }
414         }
415         /* a sentinel */
416         zbd_info->zone_info[nr_zones].start = start_sector;
417
418         f->zbd_info = zbd_info;
419         f->zbd_info->zone_size = zone_size;
420         f->zbd_info->zone_size_log2 = is_power_of_2(zone_size) ?
421                 ilog2(zone_size) + 9 : -1;
422         f->zbd_info->nr_zones = nr_zones;
423         zbd_info = NULL;
424         ret = 0;
425
426 close:
427         sfree(zbd_info);
428         close(fd);
429 free:
430         free(buf);
431 out:
432         pthread_mutexattr_destroy(&attr);
433         return ret;
434 }
435
436 /*
437  * Allocate zone information and store it into f->zbd_info if zonemode=zbd.
438  *
439  * Returns 0 upon success and a negative error code upon failure.
440  */
441 int zbd_create_zone_info(struct thread_data *td, struct fio_file *f)
442 {
443         enum blk_zoned_model zbd_model;
444         int ret = 0;
445
446         assert(td->o.zone_mode == ZONE_MODE_ZBD);
447
448         zbd_model = get_zbd_model(f->file_name);
449         switch (zbd_model) {
450         case ZBD_DM_HOST_AWARE:
451         case ZBD_DM_HOST_MANAGED:
452                 ret = parse_zone_info(td, f);
453                 break;
454         case ZBD_DM_NONE:
455                 ret = init_zone_info(td, f);
456                 break;
457         }
458         if (ret == 0)
459                 f->zbd_info->model = zbd_model;
460         return ret;
461 }
462
463 void zbd_free_zone_info(struct fio_file *f)
464 {
465         uint32_t refcount;
466
467         if (!f->zbd_info)
468                 return;
469
470         pthread_mutex_lock(&f->zbd_info->mutex);
471         refcount = --f->zbd_info->refcount;
472         pthread_mutex_unlock(&f->zbd_info->mutex);
473
474         assert((int32_t)refcount >= 0);
475         if (refcount == 0)
476                 sfree(f->zbd_info);
477         f->zbd_info = NULL;
478 }
479
480 /*
481  * Initialize f->zbd_info.
482  *
483  * Returns 0 upon success and a negative error code upon failure.
484  *
485  * Note: this function can only work correctly if it is called before the first
486  * fio fork() call.
487  */
488 static int zbd_init_zone_info(struct thread_data *td, struct fio_file *file)
489 {
490         struct thread_data *td2;
491         struct fio_file *f2;
492         int i, j, ret;
493
494         for_each_td(td2, i) {
495                 for_each_file(td2, f2, j) {
496                         if (td2 == td && f2 == file)
497                                 continue;
498                         if (!f2->zbd_info ||
499                             strcmp(f2->file_name, file->file_name) != 0)
500                                 continue;
501                         file->zbd_info = f2->zbd_info;
502                         file->zbd_info->refcount++;
503                         return 0;
504                 }
505         }
506
507         ret = zbd_create_zone_info(td, file);
508         if (ret < 0)
509                 td_verror(td, -ret, "BLKREPORTZONE failed");
510         return ret;
511 }
512
513 int zbd_init(struct thread_data *td)
514 {
515         struct fio_file *f;
516         int i;
517
518         for_each_file(td, f, i) {
519                 if (f->filetype != FIO_TYPE_BLOCK)
520                         continue;
521                 if (td->o.zone_size && td->o.zone_size < 512) {
522                         log_err("%s: zone size must be at least 512 bytes for --zonemode=zbd\n\n",
523                                 f->file_name);
524                         return 1;
525                 }
526                 if (td->o.zone_size == 0 &&
527                     get_zbd_model(f->file_name) == ZBD_DM_NONE) {
528                         log_err("%s: Specifying the zone size is mandatory for regular block devices with --zonemode=zbd\n\n",
529                                 f->file_name);
530                         return 1;
531                 }
532                 zbd_init_zone_info(td, f);
533         }
534
535         if (!zbd_using_direct_io()) {
536                 log_err("Using direct I/O is mandatory for writing to ZBD drives\n\n");
537                 return 1;
538         }
539
540         if (!zbd_verify_sizes())
541                 return 1;
542
543         if (!zbd_verify_bs())
544                 return 1;
545
546         return 0;
547 }
548
549 /**
550  * zbd_reset_range - reset zones for a range of sectors
551  * @td: FIO thread data.
552  * @f: Fio file for which to reset zones
553  * @sector: Starting sector in units of 512 bytes
554  * @nr_sectors: Number of sectors in units of 512 bytes
555  *
556  * Returns 0 upon success and a negative error code upon failure.
557  */
558 static int zbd_reset_range(struct thread_data *td, const struct fio_file *f,
559                            uint64_t sector, uint64_t nr_sectors)
560 {
561         struct blk_zone_range zr = {
562                 .sector         = sector,
563                 .nr_sectors     = nr_sectors,
564         };
565         uint32_t zone_idx_b, zone_idx_e;
566         struct fio_zone_info *zb, *ze, *z;
567         int ret = 0;
568
569         assert(f->fd != -1);
570         assert(is_valid_offset(f, ((sector + nr_sectors) << 9) - 1));
571         switch (f->zbd_info->model) {
572         case ZBD_DM_HOST_AWARE:
573         case ZBD_DM_HOST_MANAGED:
574                 ret = ioctl(f->fd, BLKRESETZONE, &zr);
575                 if (ret < 0) {
576                         td_verror(td, errno, "resetting wp failed");
577                         log_err("%s: resetting wp for %llu sectors at sector %llu failed (%d).\n",
578                                 f->file_name, zr.nr_sectors, zr.sector, errno);
579                         return ret;
580                 }
581                 break;
582         case ZBD_DM_NONE:
583                 break;
584         }
585
586         zone_idx_b = zbd_zone_idx(f, sector << 9);
587         zb = &f->zbd_info->zone_info[zone_idx_b];
588         zone_idx_e = zbd_zone_idx(f, (sector + nr_sectors) << 9);
589         ze = &f->zbd_info->zone_info[zone_idx_e];
590         for (z = zb; z < ze; z++) {
591                 pthread_mutex_lock(&z->mutex);
592                 z->wp = z->start;
593                 z->verify_block = 0;
594                 pthread_mutex_unlock(&z->mutex);
595         }
596
597         return ret;
598 }
599
600 /**
601  * zbd_reset_zone - reset the write pointer of a single zone
602  * @td: FIO thread data.
603  * @f: FIO file associated with the disk for which to reset a write pointer.
604  * @z: Zone to reset.
605  *
606  * Returns 0 upon success and a negative error code upon failure.
607  */
608 static int zbd_reset_zone(struct thread_data *td, const struct fio_file *f,
609                           struct fio_zone_info *z)
610 {
611         int ret;
612
613         dprint(FD_ZBD, "%s: resetting wp of zone %lu.\n", f->file_name,
614                z - f->zbd_info->zone_info);
615         ret = zbd_reset_range(td, f, z->start, (z+1)->start - z->start);
616         return ret;
617 }
618
619 /*
620  * Reset a range of zones. Returns 0 upon success and 1 upon failure.
621  * @td: fio thread data.
622  * @f: fio file for which to reset zones
623  * @zb: first zone to reset.
624  * @ze: first zone not to reset.
625  * @all_zones: whether to reset all zones or only those zones for which the
626  *      write pointer is not a multiple of td->o.min_bs[DDIR_WRITE].
627  */
628 static int zbd_reset_zones(struct thread_data *td, struct fio_file *f,
629                            struct fio_zone_info *const zb,
630                            struct fio_zone_info *const ze, bool all_zones)
631 {
632         struct fio_zone_info *z, *start_z = ze;
633         const uint32_t min_bs = td->o.min_bs[DDIR_WRITE] >> 9;
634         bool reset_wp;
635         int res = 0;
636
637         dprint(FD_ZBD, "%s: examining zones %lu .. %lu\n", f->file_name,
638                zb - f->zbd_info->zone_info, ze - f->zbd_info->zone_info);
639         assert(f->fd != -1);
640         for (z = zb; z < ze; z++) {
641                 pthread_mutex_lock(&z->mutex);
642                 switch (z->type) {
643                 case BLK_ZONE_TYPE_SEQWRITE_REQ:
644                         reset_wp = all_zones ? z->wp != z->start :
645                                         (td->o.td_ddir & TD_DDIR_WRITE) &&
646                                         z->wp % min_bs != 0;
647                         if (start_z == ze && reset_wp) {
648                                 start_z = z;
649                         } else if (start_z < ze && !reset_wp) {
650                                 dprint(FD_ZBD,
651                                        "%s: resetting zones %lu .. %lu\n",
652                                        f->file_name,
653                                        start_z - f->zbd_info->zone_info,
654                                        z - f->zbd_info->zone_info);
655                                 if (zbd_reset_range(td, f, start_z->start,
656                                                 z->start - start_z->start) < 0)
657                                         res = 1;
658                                 start_z = ze;
659                         }
660                         break;
661                 default:
662                         if (start_z == ze)
663                                 break;
664                         dprint(FD_ZBD, "%s: resetting zones %lu .. %lu\n",
665                                f->file_name, start_z - f->zbd_info->zone_info,
666                                z - f->zbd_info->zone_info);
667                         if (zbd_reset_range(td, f, start_z->start,
668                                             z->start - start_z->start) < 0)
669                                 res = 1;
670                         start_z = ze;
671                         break;
672                 }
673         }
674         if (start_z < ze) {
675                 dprint(FD_ZBD, "%s: resetting zones %lu .. %lu\n", f->file_name,
676                        start_z - f->zbd_info->zone_info,
677                        z - f->zbd_info->zone_info);
678                 if (zbd_reset_range(td, f, start_z->start,
679                                     z->start - start_z->start) < 0)
680                         res = 1;
681         }
682         for (z = zb; z < ze; z++)
683                 pthread_mutex_unlock(&z->mutex);
684
685         return res;
686 }
687
688 void zbd_file_reset(struct thread_data *td, struct fio_file *f)
689 {
690         struct fio_zone_info *zb, *ze;
691         uint32_t zone_idx_e;
692
693         if (!f->zbd_info)
694                 return;
695
696         zb = &f->zbd_info->zone_info[zbd_zone_idx(f, f->file_offset)];
697         zone_idx_e = zbd_zone_idx(f, f->file_offset + f->io_size);
698         ze = &f->zbd_info->zone_info[zone_idx_e];
699         /*
700          * If data verification is enabled reset the affected zones before
701          * writing any data to avoid that a zone reset has to be issued while
702          * writing data, which causes data loss.
703          */
704         zbd_reset_zones(td, f, zb, ze, td->o.verify != VERIFY_NONE &&
705                         (td->o.td_ddir & TD_DDIR_WRITE) &&
706                         td->runstate != TD_VERIFYING);
707 }
708
709 /* The caller must hold z->mutex. */
710 static void zbd_replay_write_order(struct thread_data *td, struct io_u *io_u,
711                                    struct fio_zone_info *z)
712 {
713         const struct fio_file *f = io_u->file;
714         const uint32_t min_bs = td->o.min_bs[DDIR_WRITE];
715
716         if (z->verify_block * min_bs >= f->zbd_info->zone_size)
717                 log_err("%s: %d * %d >= %ld\n", f->file_name, z->verify_block,
718                         min_bs, f->zbd_info->zone_size);
719         io_u->offset = (z->start << 9) + z->verify_block++ * min_bs;
720 }
721
722 /*
723  * Find another zone for which @io_u fits below the write pointer. Start
724  * searching in zones @zb + 1 .. @zl and continue searching in zones
725  * @zf .. @zb - 1.
726  *
727  * Either returns NULL or returns a zone pointer and holds the mutex for that
728  * zone.
729  */
730 static struct fio_zone_info *
731 zbd_find_zone(struct thread_data *td, struct io_u *io_u,
732               struct fio_zone_info *zb, struct fio_zone_info *zl)
733 {
734         const uint32_t min_bs = td->o.min_bs[io_u->ddir];
735         const struct fio_file *f = io_u->file;
736         struct fio_zone_info *z1, *z2;
737         const struct fio_zone_info *const zf =
738                 &f->zbd_info->zone_info[zbd_zone_idx(f, f->file_offset)];
739
740         /*
741          * Skip to the next non-empty zone in case of sequential I/O and to
742          * the nearest non-empty zone in case of random I/O.
743          */
744         for (z1 = zb + 1, z2 = zb - 1; z1 < zl || z2 >= zf; z1++, z2--) {
745                 if (z1 < zl && z1->cond != BLK_ZONE_COND_OFFLINE) {
746                         pthread_mutex_lock(&z1->mutex);
747                         if (z1->start + (min_bs >> 9) <= z1->wp)
748                                 return z1;
749                         pthread_mutex_unlock(&z1->mutex);
750                 } else if (!td_random(td)) {
751                         break;
752                 }
753                 if (td_random(td) && z2 >= zf &&
754                     z2->cond != BLK_ZONE_COND_OFFLINE) {
755                         pthread_mutex_lock(&z2->mutex);
756                         if (z2->start + (min_bs >> 9) <= z2->wp)
757                                 return z2;
758                         pthread_mutex_unlock(&z2->mutex);
759                 }
760         }
761         dprint(FD_ZBD, "%s: adjusting random read offset failed\n",
762                f->file_name);
763         return NULL;
764 }
765
766
767 /**
768  * zbd_post_submit - update the write pointer and unlock the zone lock
769  * @io_u: I/O unit
770  * @success: Whether or not the I/O unit has been executed successfully
771  *
772  * For write and trim operations, update the write pointer of all affected
773  * zones.
774  */
775 static void zbd_post_submit(const struct io_u *io_u, bool success)
776 {
777         struct zoned_block_device_info *zbd_info;
778         struct fio_zone_info *z;
779         uint32_t zone_idx;
780         uint64_t end, zone_end;
781
782         zbd_info = io_u->file->zbd_info;
783         if (!zbd_info)
784                 return;
785
786         zone_idx = zbd_zone_idx(io_u->file, io_u->offset);
787         end = (io_u->offset + io_u->buflen) >> 9;
788         z = &zbd_info->zone_info[zone_idx];
789         assert(zone_idx < zbd_info->nr_zones);
790         if (z->type != BLK_ZONE_TYPE_SEQWRITE_REQ)
791                 return;
792         if (!success)
793                 goto unlock;
794         switch (io_u->ddir) {
795         case DDIR_WRITE:
796                 zone_end = min(end, (z + 1)->start);
797                 z->wp = zone_end;
798                 break;
799         case DDIR_TRIM:
800                 assert(z->wp == z->start);
801                 break;
802         default:
803                 break;
804         }
805 unlock:
806         pthread_mutex_unlock(&z->mutex);
807 }
808
809 bool zbd_unaligned_write(int error_code)
810 {
811         switch (error_code) {
812         case EIO:
813         case EREMOTEIO:
814                 return true;
815         }
816         return false;
817 }
818
819 /**
820  * zbd_adjust_block - adjust the offset and length as necessary for ZBD drives
821  * @td: FIO thread data.
822  * @io_u: FIO I/O unit.
823  *
824  * Locking strategy: returns with z->mutex locked if and only if z refers
825  * to a sequential zone and if io_u_accept is returned. z is the zone that
826  * corresponds to io_u->offset at the end of this function.
827  */
828 enum io_u_action zbd_adjust_block(struct thread_data *td, struct io_u *io_u)
829 {
830         const struct fio_file *f = io_u->file;
831         uint32_t zone_idx_b;
832         struct fio_zone_info *zb, *zl;
833         uint32_t orig_len = io_u->buflen;
834         uint32_t min_bs = td->o.min_bs[io_u->ddir];
835         uint64_t new_len;
836         int64_t range;
837
838         if (!f->zbd_info)
839                 return io_u_accept;
840
841         assert(is_valid_offset(f, io_u->offset));
842         assert(io_u->buflen);
843         zone_idx_b = zbd_zone_idx(f, io_u->offset);
844         zb = &f->zbd_info->zone_info[zone_idx_b];
845
846         /* Accept the I/O offset for conventional zones. */
847         if (zb->type == BLK_ZONE_TYPE_CONVENTIONAL)
848                 return io_u_accept;
849
850         /*
851          * Accept the I/O offset for reads if reading beyond the write pointer
852          * is enabled.
853          */
854         if (zb->cond != BLK_ZONE_COND_OFFLINE &&
855             io_u->ddir == DDIR_READ && td->o.read_beyond_wp)
856                 return io_u_accept;
857
858         pthread_mutex_lock(&zb->mutex);
859         switch (io_u->ddir) {
860         case DDIR_READ:
861                 if (td->runstate == TD_VERIFYING) {
862                         zbd_replay_write_order(td, io_u, zb);
863                         goto accept;
864                 }
865                 /*
866                  * Avoid reads past the write pointer because such reads do not
867                  * hit the medium.
868                  */
869                 range = zb->cond != BLK_ZONE_COND_OFFLINE ?
870                         ((zb->wp - zb->start) << 9) - io_u->buflen : 0;
871                 if (td_random(td) && range >= 0) {
872                         io_u->offset = (zb->start << 9) +
873                                 ((io_u->offset - (zb->start << 9)) %
874                                  (range + 1)) / min_bs * min_bs;
875                         assert(zb->start << 9 <= io_u->offset);
876                         assert(io_u->offset + io_u->buflen <= zb->wp << 9);
877                         goto accept;
878                 }
879                 if (zb->cond == BLK_ZONE_COND_OFFLINE ||
880                     (io_u->offset + io_u->buflen) >> 9 > zb->wp) {
881                         pthread_mutex_unlock(&zb->mutex);
882                         zl = &f->zbd_info->zone_info[zbd_zone_idx(f,
883                                                 f->file_offset + f->io_size)];
884                         zb = zbd_find_zone(td, io_u, zb, zl);
885                         if (!zb) {
886                                 dprint(FD_ZBD,
887                                        "%s: zbd_find_zone(%lld, %llu) failed\n",
888                                        f->file_name, io_u->offset,
889                                        io_u->buflen);
890                                 goto eof;
891                         }
892                         io_u->offset = zb->start << 9;
893                 }
894                 if ((io_u->offset + io_u->buflen) >> 9 > zb->wp) {
895                         dprint(FD_ZBD, "%s: %lld + %lld > %" PRIu64 "\n",
896                                f->file_name, io_u->offset, io_u->buflen,
897                                zb->wp);
898                         goto eof;
899                 }
900                 goto accept;
901         case DDIR_WRITE:
902                 if (io_u->buflen > (f->zbd_info->zone_size << 9))
903                         goto eof;
904                 /* Reset the zone pointer if necessary */
905                 if (zb->reset_zone || zbd_zone_full(f, zb, min_bs)) {
906                         assert(td->o.verify == VERIFY_NONE);
907                         /*
908                          * Since previous write requests may have been submitted
909                          * asynchronously and since we will submit the zone
910                          * reset synchronously, wait until previously submitted
911                          * write requests have completed before issuing a
912                          * zone reset.
913                          */
914                         io_u_quiesce(td);
915                         zb->reset_zone = 0;
916                         if (zbd_reset_zone(td, f, zb) < 0)
917                                 goto eof;
918                 }
919                 /* Make writes occur at the write pointer */
920                 assert(!zbd_zone_full(f, zb, min_bs));
921                 io_u->offset = zb->wp << 9;
922                 if (!is_valid_offset(f, io_u->offset)) {
923                         dprint(FD_ZBD, "Dropped request with offset %llu\n",
924                                io_u->offset);
925                         goto eof;
926                 }
927                 /*
928                  * Make sure that the buflen is a multiple of the minimal
929                  * block size. Give up if shrinking would make the request too
930                  * small.
931                  */
932                 new_len = min((unsigned long long)io_u->buflen,
933                               ((zb + 1)->start << 9) - io_u->offset);
934                 new_len = new_len / min_bs * min_bs;
935                 if (new_len == io_u->buflen)
936                         goto accept;
937                 if (new_len >= min_bs) {
938                         io_u->buflen = new_len;
939                         dprint(FD_IO, "Changed length from %u into %llu\n",
940                                orig_len, io_u->buflen);
941                         goto accept;
942                 }
943                 log_err("Zone remainder %lld smaller than minimum block size %d\n",
944                         (((zb + 1)->start << 9) - io_u->offset),
945                         min_bs);
946                 goto eof;
947         case DDIR_TRIM:
948                 /* fall-through */
949         case DDIR_SYNC:
950         case DDIR_DATASYNC:
951         case DDIR_SYNC_FILE_RANGE:
952         case DDIR_WAIT:
953         case DDIR_LAST:
954         case DDIR_INVAL:
955                 goto accept;
956         }
957
958         assert(false);
959
960 accept:
961         assert(zb);
962         assert(zb->cond != BLK_ZONE_COND_OFFLINE);
963         assert(!io_u->post_submit);
964         io_u->post_submit = zbd_post_submit;
965         return io_u_accept;
966
967 eof:
968         if (zb)
969                 pthread_mutex_unlock(&zb->mutex);
970         return io_u_eof;
971 }