zbd: allow an unlimited global max open zones limit
[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 <fcntl.h>
11 #include <sys/stat.h>
12 #include <unistd.h>
13
14 #include "os/os.h"
15 #include "file.h"
16 #include "fio.h"
17 #include "lib/pow2.h"
18 #include "log.h"
19 #include "oslib/asprintf.h"
20 #include "smalloc.h"
21 #include "verify.h"
22 #include "pshared.h"
23 #include "zbd.h"
24
25 /**
26  * zbd_get_zoned_model - Get a device zoned model
27  * @td: FIO thread data
28  * @f: FIO file for which to get model information
29  */
30 int zbd_get_zoned_model(struct thread_data *td, struct fio_file *f,
31                         enum zbd_zoned_model *model)
32 {
33         int ret;
34
35         if (f->filetype == FIO_TYPE_PIPE) {
36                 log_err("zonemode=zbd does not support pipes\n");
37                 return -EINVAL;
38         }
39
40         /* If regular file, always emulate zones inside the file. */
41         if (f->filetype == FIO_TYPE_FILE) {
42                 *model = ZBD_NONE;
43                 return 0;
44         }
45
46         if (td->io_ops && td->io_ops->get_zoned_model)
47                 ret = td->io_ops->get_zoned_model(td, f, model);
48         else
49                 ret = blkzoned_get_zoned_model(td, f, model);
50         if (ret < 0) {
51                 td_verror(td, errno, "get zoned model failed");
52                 log_err("%s: get zoned model failed (%d).\n",
53                         f->file_name, errno);
54         }
55
56         return ret;
57 }
58
59 /**
60  * zbd_report_zones - Get zone information
61  * @td: FIO thread data.
62  * @f: FIO file for which to get zone information
63  * @offset: offset from which to report zones
64  * @zones: Array of struct zbd_zone
65  * @nr_zones: Size of @zones array
66  *
67  * Get zone information into @zones starting from the zone at offset @offset
68  * for the device specified by @f.
69  *
70  * Returns the number of zones reported upon success and a negative error code
71  * upon failure. If the zone report is empty, always assume an error (device
72  * problem) and return -EIO.
73  */
74 int zbd_report_zones(struct thread_data *td, struct fio_file *f,
75                      uint64_t offset, struct zbd_zone *zones,
76                      unsigned int nr_zones)
77 {
78         int ret;
79
80         if (td->io_ops && td->io_ops->report_zones)
81                 ret = td->io_ops->report_zones(td, f, offset, zones, nr_zones);
82         else
83                 ret = blkzoned_report_zones(td, f, offset, zones, nr_zones);
84         if (ret < 0) {
85                 td_verror(td, errno, "report zones failed");
86                 log_err("%s: report zones from sector %llu failed (%d).\n",
87                         f->file_name, (unsigned long long)offset >> 9, errno);
88         } else if (ret == 0) {
89                 td_verror(td, errno, "Empty zone report");
90                 log_err("%s: report zones from sector %llu is empty.\n",
91                         f->file_name, (unsigned long long)offset >> 9);
92                 ret = -EIO;
93         }
94
95         return ret;
96 }
97
98 /**
99  * zbd_reset_wp - reset the write pointer of a range of zones
100  * @td: FIO thread data.
101  * @f: FIO file for which to reset zones
102  * @offset: Starting offset of the first zone to reset
103  * @length: Length of the range of zones to reset
104  *
105  * Reset the write pointer of all zones in the range @offset...@offset+@length.
106  * Returns 0 upon success and a negative error code upon failure.
107  */
108 int zbd_reset_wp(struct thread_data *td, struct fio_file *f,
109                  uint64_t offset, uint64_t length)
110 {
111         int ret;
112
113         if (td->io_ops && td->io_ops->reset_wp)
114                 ret = td->io_ops->reset_wp(td, f, offset, length);
115         else
116                 ret = blkzoned_reset_wp(td, f, offset, length);
117         if (ret < 0) {
118                 td_verror(td, errno, "resetting wp failed");
119                 log_err("%s: resetting wp for %llu sectors at sector %llu failed (%d).\n",
120                         f->file_name, (unsigned long long)length >> 9,
121                         (unsigned long long)offset >> 9, errno);
122         }
123
124         return ret;
125 }
126
127 /**
128  * zbd_get_max_open_zones - Get the maximum number of open zones
129  * @td: FIO thread data
130  * @f: FIO file for which to get max open zones
131  * @max_open_zones: Upon success, result will be stored here.
132  *
133  * A @max_open_zones value set to zero means no limit.
134  *
135  * Returns 0 upon success and a negative error code upon failure.
136  */
137 int zbd_get_max_open_zones(struct thread_data *td, struct fio_file *f,
138                            unsigned int *max_open_zones)
139 {
140         int ret;
141
142         if (td->io_ops && td->io_ops->get_max_open_zones)
143                 ret = td->io_ops->get_max_open_zones(td, f, max_open_zones);
144         else
145                 ret = blkzoned_get_max_open_zones(td, f, max_open_zones);
146         if (ret < 0) {
147                 td_verror(td, errno, "get max open zones failed");
148                 log_err("%s: get max open zones failed (%d).\n",
149                         f->file_name, errno);
150         }
151
152         return ret;
153 }
154
155 /**
156  * zbd_zone_idx - convert an offset into a zone number
157  * @f: file pointer.
158  * @offset: offset in bytes. If this offset is in the first zone_size bytes
159  *          past the disk size then the index of the sentinel is returned.
160  */
161 static uint32_t zbd_zone_idx(const struct fio_file *f, uint64_t offset)
162 {
163         uint32_t zone_idx;
164
165         if (f->zbd_info->zone_size_log2 > 0)
166                 zone_idx = offset >> f->zbd_info->zone_size_log2;
167         else
168                 zone_idx = offset / f->zbd_info->zone_size;
169
170         return min(zone_idx, f->zbd_info->nr_zones);
171 }
172
173 /**
174  * zbd_zone_end - Return zone end location
175  * @z: zone info pointer.
176  */
177 static inline uint64_t zbd_zone_end(const struct fio_zone_info *z)
178 {
179         return (z+1)->start;
180 }
181
182 /**
183  * zbd_zone_capacity_end - Return zone capacity limit end location
184  * @z: zone info pointer.
185  */
186 static inline uint64_t zbd_zone_capacity_end(const struct fio_zone_info *z)
187 {
188         return z->start + z->capacity;
189 }
190
191 /**
192  * zbd_zone_full - verify whether a minimum number of bytes remain in a zone
193  * @f: file pointer.
194  * @z: zone info pointer.
195  * @required: minimum number of bytes that must remain in a zone.
196  *
197  * The caller must hold z->mutex.
198  */
199 static bool zbd_zone_full(const struct fio_file *f, struct fio_zone_info *z,
200                           uint64_t required)
201 {
202         assert((required & 511) == 0);
203
204         return z->has_wp &&
205                 z->wp + required > zbd_zone_capacity_end(z);
206 }
207
208 static void zone_lock(struct thread_data *td, const struct fio_file *f,
209                       struct fio_zone_info *z)
210 {
211         struct zoned_block_device_info *zbd = f->zbd_info;
212         uint32_t nz = z - zbd->zone_info;
213
214         /* A thread should never lock zones outside its working area. */
215         assert(f->min_zone <= nz && nz < f->max_zone);
216
217         assert(z->has_wp);
218
219         /*
220          * Lock the io_u target zone. The zone will be unlocked if io_u offset
221          * is changed or when io_u completes and zbd_put_io() executed.
222          * To avoid multiple jobs doing asynchronous I/Os from deadlocking each
223          * other waiting for zone locks when building an io_u batch, first
224          * only trylock the zone. If the zone is already locked by another job,
225          * process the currently queued I/Os so that I/O progress is made and
226          * zones unlocked.
227          */
228         if (pthread_mutex_trylock(&z->mutex) != 0) {
229                 if (!td_ioengine_flagged(td, FIO_SYNCIO))
230                         io_u_quiesce(td);
231                 pthread_mutex_lock(&z->mutex);
232         }
233 }
234
235 static inline void zone_unlock(struct fio_zone_info *z)
236 {
237         int ret;
238
239         assert(z->has_wp);
240         ret = pthread_mutex_unlock(&z->mutex);
241         assert(!ret);
242 }
243
244 static bool is_valid_offset(const struct fio_file *f, uint64_t offset)
245 {
246         return (uint64_t)(offset - f->file_offset) < f->io_size;
247 }
248
249 static inline struct fio_zone_info *get_zone(const struct fio_file *f,
250                                              unsigned int zone_nr)
251 {
252         return &f->zbd_info->zone_info[zone_nr];
253 }
254
255 /* Verify whether direct I/O is used for all host-managed zoned drives. */
256 static bool zbd_using_direct_io(void)
257 {
258         struct thread_data *td;
259         struct fio_file *f;
260         int i, j;
261
262         for_each_td(td, i) {
263                 if (td->o.odirect || !(td->o.td_ddir & TD_DDIR_WRITE))
264                         continue;
265                 for_each_file(td, f, j) {
266                         if (f->zbd_info &&
267                             f->zbd_info->model == ZBD_HOST_MANAGED)
268                                 return false;
269                 }
270         }
271
272         return true;
273 }
274
275 /* Whether or not the I/O range for f includes one or more sequential zones */
276 static bool zbd_is_seq_job(struct fio_file *f)
277 {
278         uint32_t zone_idx, zone_idx_b, zone_idx_e;
279
280         assert(f->zbd_info);
281         if (f->io_size == 0)
282                 return false;
283         zone_idx_b = zbd_zone_idx(f, f->file_offset);
284         zone_idx_e = zbd_zone_idx(f, f->file_offset + f->io_size - 1);
285         for (zone_idx = zone_idx_b; zone_idx <= zone_idx_e; zone_idx++)
286                 if (get_zone(f, zone_idx)->has_wp)
287                         return true;
288
289         return false;
290 }
291
292 /*
293  * Verify whether offset and size parameters are aligned with zone boundaries.
294  */
295 static bool zbd_verify_sizes(void)
296 {
297         const struct fio_zone_info *z;
298         struct thread_data *td;
299         struct fio_file *f;
300         uint64_t new_offset, new_end;
301         uint32_t zone_idx;
302         int i, j;
303
304         for_each_td(td, i) {
305                 for_each_file(td, f, j) {
306                         if (!f->zbd_info)
307                                 continue;
308                         if (f->file_offset >= f->real_file_size)
309                                 continue;
310                         if (!zbd_is_seq_job(f))
311                                 continue;
312
313                         if (!td->o.zone_size) {
314                                 td->o.zone_size = f->zbd_info->zone_size;
315                                 if (!td->o.zone_size) {
316                                         log_err("%s: invalid 0 zone size\n",
317                                                 f->file_name);
318                                         return false;
319                                 }
320                         } else if (td->o.zone_size != f->zbd_info->zone_size) {
321                                 log_err("%s: job parameter zonesize %llu does not match disk zone size %llu.\n",
322                                         f->file_name, (unsigned long long) td->o.zone_size,
323                                         (unsigned long long) f->zbd_info->zone_size);
324                                 return false;
325                         }
326
327                         if (td->o.zone_skip % td->o.zone_size) {
328                                 log_err("%s: zoneskip %llu is not a multiple of the device zone size %llu.\n",
329                                         f->file_name, (unsigned long long) td->o.zone_skip,
330                                         (unsigned long long) td->o.zone_size);
331                                 return false;
332                         }
333
334                         zone_idx = zbd_zone_idx(f, f->file_offset);
335                         z = get_zone(f, zone_idx);
336                         if ((f->file_offset != z->start) &&
337                             (td->o.td_ddir != TD_DDIR_READ)) {
338                                 new_offset = zbd_zone_end(z);
339                                 if (new_offset >= f->file_offset + f->io_size) {
340                                         log_info("%s: io_size must be at least one zone\n",
341                                                  f->file_name);
342                                         return false;
343                                 }
344                                 log_info("%s: rounded up offset from %llu to %llu\n",
345                                          f->file_name, (unsigned long long) f->file_offset,
346                                          (unsigned long long) new_offset);
347                                 f->io_size -= (new_offset - f->file_offset);
348                                 f->file_offset = new_offset;
349                         }
350                         zone_idx = zbd_zone_idx(f, f->file_offset + f->io_size);
351                         z = get_zone(f, zone_idx);
352                         new_end = z->start;
353                         if ((td->o.td_ddir != TD_DDIR_READ) &&
354                             (f->file_offset + f->io_size != new_end)) {
355                                 if (new_end <= f->file_offset) {
356                                         log_info("%s: io_size must be at least one zone\n",
357                                                  f->file_name);
358                                         return false;
359                                 }
360                                 log_info("%s: rounded down io_size from %llu to %llu\n",
361                                          f->file_name, (unsigned long long) f->io_size,
362                                          (unsigned long long) new_end - f->file_offset);
363                                 f->io_size = new_end - f->file_offset;
364                         }
365                 }
366         }
367
368         return true;
369 }
370
371 static bool zbd_verify_bs(void)
372 {
373         struct thread_data *td;
374         struct fio_file *f;
375         int i, j, k;
376
377         for_each_td(td, i) {
378                 for_each_file(td, f, j) {
379                         uint64_t zone_size;
380
381                         if (!f->zbd_info)
382                                 continue;
383                         zone_size = f->zbd_info->zone_size;
384                         for (k = 0; k < FIO_ARRAY_SIZE(td->o.bs); k++) {
385                                 if (td->o.verify != VERIFY_NONE &&
386                                     zone_size % td->o.bs[k] != 0) {
387                                         log_info("%s: block size %llu is not a divisor of the zone size %llu\n",
388                                                  f->file_name, td->o.bs[k],
389                                                  (unsigned long long)zone_size);
390                                         return false;
391                                 }
392                         }
393                 }
394         }
395         return true;
396 }
397
398 static int ilog2(uint64_t i)
399 {
400         int log = -1;
401
402         while (i) {
403                 i >>= 1;
404                 log++;
405         }
406         return log;
407 }
408
409 /*
410  * Initialize f->zbd_info for devices that are not zoned block devices. This
411  * allows to execute a ZBD workload against a non-ZBD device.
412  */
413 static int init_zone_info(struct thread_data *td, struct fio_file *f)
414 {
415         uint32_t nr_zones;
416         struct fio_zone_info *p;
417         uint64_t zone_size = td->o.zone_size;
418         uint64_t zone_capacity = td->o.zone_capacity;
419         struct zoned_block_device_info *zbd_info = NULL;
420         int i;
421
422         if (zone_size == 0) {
423                 log_err("%s: Specifying the zone size is mandatory for regular file/block device with --zonemode=zbd\n\n",
424                         f->file_name);
425                 return 1;
426         }
427
428         if (zone_size < 512) {
429                 log_err("%s: zone size must be at least 512 bytes for --zonemode=zbd\n\n",
430                         f->file_name);
431                 return 1;
432         }
433
434         if (zone_capacity == 0)
435                 zone_capacity = zone_size;
436
437         if (zone_capacity > zone_size) {
438                 log_err("%s: job parameter zonecapacity %llu is larger than zone size %llu\n",
439                         f->file_name, (unsigned long long) td->o.zone_capacity,
440                         (unsigned long long) td->o.zone_size);
441                 return 1;
442         }
443
444         if (f->real_file_size < zone_size) {
445                 log_err("%s: file/device size %"PRIu64" is smaller than zone size %"PRIu64"\n",
446                         f->file_name, f->real_file_size, zone_size);
447                 return -EINVAL;
448         }
449
450         nr_zones = (f->real_file_size + zone_size - 1) / zone_size;
451         zbd_info = scalloc(1, sizeof(*zbd_info) +
452                            (nr_zones + 1) * sizeof(zbd_info->zone_info[0]));
453         if (!zbd_info)
454                 return -ENOMEM;
455
456         mutex_init_pshared(&zbd_info->mutex);
457         zbd_info->refcount = 1;
458         p = &zbd_info->zone_info[0];
459         for (i = 0; i < nr_zones; i++, p++) {
460                 mutex_init_pshared_with_type(&p->mutex,
461                                              PTHREAD_MUTEX_RECURSIVE);
462                 p->start = i * zone_size;
463                 p->wp = p->start;
464                 p->type = ZBD_ZONE_TYPE_SWR;
465                 p->cond = ZBD_ZONE_COND_EMPTY;
466                 p->capacity = zone_capacity;
467                 p->has_wp = 1;
468         }
469         /* a sentinel */
470         p->start = nr_zones * zone_size;
471
472         f->zbd_info = zbd_info;
473         f->zbd_info->zone_size = zone_size;
474         f->zbd_info->zone_size_log2 = is_power_of_2(zone_size) ?
475                 ilog2(zone_size) : 0;
476         f->zbd_info->nr_zones = nr_zones;
477         return 0;
478 }
479
480 /*
481  * Maximum number of zones to report in one operation.
482  */
483 #define ZBD_REPORT_MAX_ZONES    8192U
484
485 /*
486  * Parse the device zone report and store it in f->zbd_info. Must be called
487  * only for devices that are zoned, namely those with a model != ZBD_NONE.
488  */
489 static int parse_zone_info(struct thread_data *td, struct fio_file *f)
490 {
491         int nr_zones, nrz;
492         struct zbd_zone *zones, *z;
493         struct fio_zone_info *p;
494         uint64_t zone_size, offset;
495         struct zoned_block_device_info *zbd_info = NULL;
496         int i, j, ret = -ENOMEM;
497
498         zones = calloc(ZBD_REPORT_MAX_ZONES, sizeof(struct zbd_zone));
499         if (!zones)
500                 goto out;
501
502         nrz = zbd_report_zones(td, f, 0, zones, ZBD_REPORT_MAX_ZONES);
503         if (nrz < 0) {
504                 ret = nrz;
505                 log_info("fio: report zones (offset 0) failed for %s (%d).\n",
506                          f->file_name, -ret);
507                 goto out;
508         }
509
510         zone_size = zones[0].len;
511         nr_zones = (f->real_file_size + zone_size - 1) / zone_size;
512
513         if (td->o.zone_size == 0) {
514                 td->o.zone_size = zone_size;
515         } else if (td->o.zone_size != zone_size) {
516                 log_err("fio: %s job parameter zonesize %llu does not match disk zone size %llu.\n",
517                         f->file_name, (unsigned long long) td->o.zone_size,
518                         (unsigned long long) zone_size);
519                 ret = -EINVAL;
520                 goto out;
521         }
522
523         dprint(FD_ZBD, "Device %s has %d zones of size %llu KB\n", f->file_name,
524                nr_zones, (unsigned long long) zone_size / 1024);
525
526         zbd_info = scalloc(1, sizeof(*zbd_info) +
527                            (nr_zones + 1) * sizeof(zbd_info->zone_info[0]));
528         if (!zbd_info)
529                 goto out;
530         mutex_init_pshared(&zbd_info->mutex);
531         zbd_info->refcount = 1;
532         p = &zbd_info->zone_info[0];
533         for (offset = 0, j = 0; j < nr_zones;) {
534                 z = &zones[0];
535                 for (i = 0; i < nrz; i++, j++, z++, p++) {
536                         mutex_init_pshared_with_type(&p->mutex,
537                                                      PTHREAD_MUTEX_RECURSIVE);
538                         p->start = z->start;
539                         p->capacity = z->capacity;
540                         switch (z->cond) {
541                         case ZBD_ZONE_COND_NOT_WP:
542                         case ZBD_ZONE_COND_FULL:
543                                 p->wp = p->start + p->capacity;
544                                 break;
545                         default:
546                                 assert(z->start <= z->wp);
547                                 assert(z->wp <= z->start + zone_size);
548                                 p->wp = z->wp;
549                                 break;
550                         }
551
552                         switch (z->type) {
553                         case ZBD_ZONE_TYPE_SWR:
554                                 p->has_wp = 1;
555                                 break;
556                         default:
557                                 p->has_wp = 0;
558                         }
559                         p->type = z->type;
560                         p->cond = z->cond;
561
562                         if (j > 0 && p->start != p[-1].start + zone_size) {
563                                 log_info("%s: invalid zone data\n",
564                                          f->file_name);
565                                 ret = -EINVAL;
566                                 goto out;
567                         }
568                 }
569                 z--;
570                 offset = z->start + z->len;
571                 if (j >= nr_zones)
572                         break;
573                 nrz = zbd_report_zones(td, f, offset, zones,
574                                        min((uint32_t)(nr_zones - j),
575                                            ZBD_REPORT_MAX_ZONES));
576                 if (nrz < 0) {
577                         ret = nrz;
578                         log_info("fio: report zones (offset %llu) failed for %s (%d).\n",
579                                  (unsigned long long)offset,
580                                  f->file_name, -ret);
581                         goto out;
582                 }
583         }
584
585         /* a sentinel */
586         zbd_info->zone_info[nr_zones].start = offset;
587
588         f->zbd_info = zbd_info;
589         f->zbd_info->zone_size = zone_size;
590         f->zbd_info->zone_size_log2 = is_power_of_2(zone_size) ?
591                 ilog2(zone_size) : 0;
592         f->zbd_info->nr_zones = nr_zones;
593         zbd_info = NULL;
594         ret = 0;
595
596 out:
597         sfree(zbd_info);
598         free(zones);
599         return ret;
600 }
601
602 static int zbd_set_max_open_zones(struct thread_data *td, struct fio_file *f)
603 {
604         struct zoned_block_device_info *zbd = f->zbd_info;
605         unsigned int max_open_zones;
606         int ret;
607
608         if (zbd->model != ZBD_HOST_MANAGED || td->o.ignore_zone_limits) {
609                 /* Only host-managed devices have a max open limit */
610                 zbd->max_open_zones = td->o.max_open_zones;
611                 goto out;
612         }
613
614         /* If host-managed, get the max open limit */
615         ret = zbd_get_max_open_zones(td, f, &max_open_zones);
616         if (ret)
617                 return ret;
618
619         if (!max_open_zones) {
620                 /* No device limit */
621                 zbd->max_open_zones = td->o.max_open_zones;
622         } else if (!td->o.max_open_zones) {
623                 /* No user limit. Set limit to device limit */
624                 zbd->max_open_zones = max_open_zones;
625         } else if (td->o.max_open_zones <= max_open_zones) {
626                 /* Both user limit and dev limit. User limit not too large */
627                 zbd->max_open_zones = td->o.max_open_zones;
628         } else {
629                 /* Both user limit and dev limit. User limit too large */
630                 td_verror(td, EINVAL,
631                           "Specified --max_open_zones is too large");
632                 log_err("Specified --max_open_zones (%d) is larger than max (%u)\n",
633                         td->o.max_open_zones, max_open_zones);
634                 return -EINVAL;
635         }
636
637 out:
638         /* Ensure that the limit is not larger than FIO's internal limit */
639         if (zbd->max_open_zones > ZBD_MAX_OPEN_ZONES) {
640                 td_verror(td, EINVAL, "'max_open_zones' value is too large");
641                 log_err("'max_open_zones' value is larger than %u\n", ZBD_MAX_OPEN_ZONES);
642                 return -EINVAL;
643         }
644
645         dprint(FD_ZBD, "%s: using max open zones limit: %"PRIu32"\n",
646                f->file_name, zbd->max_open_zones);
647
648         return 0;
649 }
650
651 /*
652  * Allocate zone information and store it into f->zbd_info if zonemode=zbd.
653  *
654  * Returns 0 upon success and a negative error code upon failure.
655  */
656 static int zbd_create_zone_info(struct thread_data *td, struct fio_file *f)
657 {
658         enum zbd_zoned_model zbd_model;
659         int ret;
660
661         assert(td->o.zone_mode == ZONE_MODE_ZBD);
662
663         ret = zbd_get_zoned_model(td, f, &zbd_model);
664         if (ret)
665                 return ret;
666
667         switch (zbd_model) {
668         case ZBD_HOST_AWARE:
669         case ZBD_HOST_MANAGED:
670                 ret = parse_zone_info(td, f);
671                 if (ret)
672                         return ret;
673                 break;
674         case ZBD_NONE:
675                 ret = init_zone_info(td, f);
676                 if (ret)
677                         return ret;
678                 break;
679         default:
680                 td_verror(td, EINVAL, "Unsupported zoned model");
681                 log_err("Unsupported zoned model\n");
682                 return -EINVAL;
683         }
684
685         assert(f->zbd_info);
686         f->zbd_info->model = zbd_model;
687
688         ret = zbd_set_max_open_zones(td, f);
689         if (ret) {
690                 zbd_free_zone_info(f);
691                 return ret;
692         }
693
694         return 0;
695 }
696
697 void zbd_free_zone_info(struct fio_file *f)
698 {
699         uint32_t refcount;
700
701         assert(f->zbd_info);
702
703         pthread_mutex_lock(&f->zbd_info->mutex);
704         refcount = --f->zbd_info->refcount;
705         pthread_mutex_unlock(&f->zbd_info->mutex);
706
707         assert((int32_t)refcount >= 0);
708         if (refcount == 0)
709                 sfree(f->zbd_info);
710         f->zbd_info = NULL;
711 }
712
713 /*
714  * Initialize f->zbd_info.
715  *
716  * Returns 0 upon success and a negative error code upon failure.
717  *
718  * Note: this function can only work correctly if it is called before the first
719  * fio fork() call.
720  */
721 static int zbd_init_zone_info(struct thread_data *td, struct fio_file *file)
722 {
723         struct thread_data *td2;
724         struct fio_file *f2;
725         int i, j, ret;
726
727         for_each_td(td2, i) {
728                 for_each_file(td2, f2, j) {
729                         if (td2 == td && f2 == file)
730                                 continue;
731                         if (!f2->zbd_info ||
732                             strcmp(f2->file_name, file->file_name) != 0)
733                                 continue;
734                         file->zbd_info = f2->zbd_info;
735                         file->zbd_info->refcount++;
736                         return 0;
737                 }
738         }
739
740         ret = zbd_create_zone_info(td, file);
741         if (ret < 0)
742                 td_verror(td, -ret, "zbd_create_zone_info() failed");
743         return ret;
744 }
745
746 static bool zbd_open_zone(struct thread_data *td, const struct fio_file *f,
747                           uint32_t zone_idx);
748 static int zbd_reset_zone(struct thread_data *td, struct fio_file *f,
749                           struct fio_zone_info *z);
750
751 int zbd_init_files(struct thread_data *td)
752 {
753         struct fio_file *f;
754         int i;
755
756         for_each_file(td, f, i) {
757                 if (zbd_init_zone_info(td, f))
758                         return 1;
759         }
760         return 0;
761 }
762
763 void zbd_recalc_options_with_zone_granularity(struct thread_data *td)
764 {
765         struct fio_file *f;
766         int i;
767
768         for_each_file(td, f, i) {
769                 struct zoned_block_device_info *zbd = f->zbd_info;
770                 // zonemode=strided doesn't get per-file zone size.
771                 uint64_t zone_size = zbd ? zbd->zone_size : td->o.zone_size;
772
773                 if (zone_size == 0)
774                         continue;
775
776                 if (td->o.size_nz > 0) {
777                         td->o.size = td->o.size_nz * zone_size;
778                 }
779                 if (td->o.io_size_nz > 0) {
780                         td->o.io_size = td->o.io_size_nz * zone_size;
781                 }
782                 if (td->o.start_offset_nz > 0) {
783                         td->o.start_offset = td->o.start_offset_nz * zone_size;
784                 }
785                 if (td->o.offset_increment_nz > 0) {
786                         td->o.offset_increment = td->o.offset_increment_nz * zone_size;
787                 }
788                 if (td->o.zone_skip_nz > 0) {
789                         td->o.zone_skip = td->o.zone_skip_nz * zone_size;
790                 }
791         }
792 }
793
794 int zbd_setup_files(struct thread_data *td)
795 {
796         struct fio_file *f;
797         int i;
798
799         if (!zbd_using_direct_io()) {
800                 log_err("Using direct I/O is mandatory for writing to ZBD drives\n\n");
801                 return 1;
802         }
803
804         if (!zbd_verify_sizes())
805                 return 1;
806
807         if (!zbd_verify_bs())
808                 return 1;
809
810         for_each_file(td, f, i) {
811                 struct zoned_block_device_info *zbd = f->zbd_info;
812                 struct fio_zone_info *z;
813                 int zi;
814
815                 assert(zbd);
816
817                 f->min_zone = zbd_zone_idx(f, f->file_offset);
818                 f->max_zone = zbd_zone_idx(f, f->file_offset + f->io_size);
819
820                 /*
821                  * When all zones in the I/O range are conventional, io_size
822                  * can be smaller than zone size, making min_zone the same
823                  * as max_zone. This is why the assert below needs to be made
824                  * conditional.
825                  */
826                 if (zbd_is_seq_job(f))
827                         assert(f->min_zone < f->max_zone);
828
829                 if (td->o.max_open_zones > 0 &&
830                     zbd->max_open_zones != td->o.max_open_zones) {
831                         log_err("Different 'max_open_zones' values\n");
832                         return 1;
833                 }
834
835                 /*
836                  * The per job max open zones limit cannot be used without a
837                  * global max open zones limit. (As the tracking of open zones
838                  * is disabled when there is no global max open zones limit.)
839                  */
840                 if (td->o.job_max_open_zones && !zbd->max_open_zones) {
841                         log_err("'job_max_open_zones' cannot be used without a global open zones limit\n");
842                         return 1;
843                 }
844
845                 for (zi = f->min_zone; zi < f->max_zone; zi++) {
846                         z = &zbd->zone_info[zi];
847                         if (z->cond != ZBD_ZONE_COND_IMP_OPEN &&
848                             z->cond != ZBD_ZONE_COND_EXP_OPEN)
849                                 continue;
850                         if (zbd_open_zone(td, f, zi))
851                                 continue;
852                         /*
853                          * If the number of open zones exceeds specified limits,
854                          * reset all extra open zones.
855                          */
856                         if (zbd_reset_zone(td, f, z) < 0) {
857                                 log_err("Failed to reest zone %d\n", zi);
858                                 return 1;
859                         }
860                 }
861         }
862
863         return 0;
864 }
865
866 static inline unsigned int zbd_zone_nr(const struct fio_file *f,
867                                        struct fio_zone_info *zone)
868 {
869         return zone - f->zbd_info->zone_info;
870 }
871
872 /**
873  * zbd_reset_zone - reset the write pointer of a single zone
874  * @td: FIO thread data.
875  * @f: FIO file associated with the disk for which to reset a write pointer.
876  * @z: Zone to reset.
877  *
878  * Returns 0 upon success and a negative error code upon failure.
879  *
880  * The caller must hold z->mutex.
881  */
882 static int zbd_reset_zone(struct thread_data *td, struct fio_file *f,
883                           struct fio_zone_info *z)
884 {
885         uint64_t offset = z->start;
886         uint64_t length = (z+1)->start - offset;
887         uint64_t data_in_zone = z->wp - z->start;
888         int ret = 0;
889
890         if (!data_in_zone)
891                 return 0;
892
893         assert(is_valid_offset(f, offset + length - 1));
894
895         dprint(FD_ZBD, "%s: resetting wp of zone %u.\n", f->file_name,
896                 zbd_zone_nr(f, z));
897         switch (f->zbd_info->model) {
898         case ZBD_HOST_AWARE:
899         case ZBD_HOST_MANAGED:
900                 ret = zbd_reset_wp(td, f, offset, length);
901                 if (ret < 0)
902                         return ret;
903                 break;
904         default:
905                 break;
906         }
907
908         pthread_mutex_lock(&f->zbd_info->mutex);
909         f->zbd_info->sectors_with_data -= data_in_zone;
910         f->zbd_info->wp_sectors_with_data -= data_in_zone;
911         pthread_mutex_unlock(&f->zbd_info->mutex);
912         z->wp = z->start;
913         z->verify_block = 0;
914
915         td->ts.nr_zone_resets++;
916
917         return ret;
918 }
919
920 /* The caller must hold f->zbd_info->mutex */
921 static void zbd_close_zone(struct thread_data *td, const struct fio_file *f,
922                            unsigned int zone_idx)
923 {
924         uint32_t open_zone_idx = 0;
925
926         for (; open_zone_idx < f->zbd_info->num_open_zones; open_zone_idx++) {
927                 if (f->zbd_info->open_zones[open_zone_idx] == zone_idx)
928                         break;
929         }
930         if (open_zone_idx == f->zbd_info->num_open_zones)
931                 return;
932
933         dprint(FD_ZBD, "%s: closing zone %d\n", f->file_name, zone_idx);
934         memmove(f->zbd_info->open_zones + open_zone_idx,
935                 f->zbd_info->open_zones + open_zone_idx + 1,
936                 (ZBD_MAX_OPEN_ZONES - (open_zone_idx + 1)) *
937                 sizeof(f->zbd_info->open_zones[0]));
938         f->zbd_info->num_open_zones--;
939         td->num_open_zones--;
940         get_zone(f, zone_idx)->open = 0;
941 }
942
943 /*
944  * Reset a range of zones. Returns 0 upon success and 1 upon failure.
945  * @td: fio thread data.
946  * @f: fio file for which to reset zones
947  * @zb: first zone to reset.
948  * @ze: first zone not to reset.
949  */
950 static int zbd_reset_zones(struct thread_data *td, struct fio_file *f,
951                            struct fio_zone_info *const zb,
952                            struct fio_zone_info *const ze)
953 {
954         struct fio_zone_info *z;
955         const uint32_t min_bs = td->o.min_bs[DDIR_WRITE];
956         int res = 0;
957
958         assert(min_bs);
959
960         dprint(FD_ZBD, "%s: examining zones %u .. %u\n", f->file_name,
961                 zbd_zone_nr(f, zb), zbd_zone_nr(f, ze));
962         for (z = zb; z < ze; z++) {
963                 uint32_t nz = zbd_zone_nr(f, z);
964
965                 if (!z->has_wp)
966                         continue;
967                 zone_lock(td, f, z);
968                 pthread_mutex_lock(&f->zbd_info->mutex);
969                 zbd_close_zone(td, f, nz);
970                 pthread_mutex_unlock(&f->zbd_info->mutex);
971                 if (z->wp != z->start) {
972                         dprint(FD_ZBD, "%s: resetting zone %u\n",
973                                f->file_name, zbd_zone_nr(f, z));
974                         if (zbd_reset_zone(td, f, z) < 0)
975                                 res = 1;
976                 }
977                 zone_unlock(z);
978         }
979
980         return res;
981 }
982
983 /*
984  * Reset zbd_info.write_cnt, the counter that counts down towards the next
985  * zone reset.
986  */
987 static void _zbd_reset_write_cnt(const struct thread_data *td,
988                                  const struct fio_file *f)
989 {
990         assert(0 <= td->o.zrf.u.f && td->o.zrf.u.f <= 1);
991
992         f->zbd_info->write_cnt = td->o.zrf.u.f ?
993                 min(1.0 / td->o.zrf.u.f, 0.0 + UINT_MAX) : UINT_MAX;
994 }
995
996 static void zbd_reset_write_cnt(const struct thread_data *td,
997                                 const struct fio_file *f)
998 {
999         pthread_mutex_lock(&f->zbd_info->mutex);
1000         _zbd_reset_write_cnt(td, f);
1001         pthread_mutex_unlock(&f->zbd_info->mutex);
1002 }
1003
1004 static bool zbd_dec_and_reset_write_cnt(const struct thread_data *td,
1005                                         const struct fio_file *f)
1006 {
1007         uint32_t write_cnt = 0;
1008
1009         pthread_mutex_lock(&f->zbd_info->mutex);
1010         assert(f->zbd_info->write_cnt);
1011         if (f->zbd_info->write_cnt)
1012                 write_cnt = --f->zbd_info->write_cnt;
1013         if (write_cnt == 0)
1014                 _zbd_reset_write_cnt(td, f);
1015         pthread_mutex_unlock(&f->zbd_info->mutex);
1016
1017         return write_cnt == 0;
1018 }
1019
1020 enum swd_action {
1021         CHECK_SWD,
1022         SET_SWD,
1023 };
1024
1025 /* Calculate the number of sectors with data (swd) and perform action 'a' */
1026 static uint64_t zbd_process_swd(struct thread_data *td,
1027                                 const struct fio_file *f, enum swd_action a)
1028 {
1029         struct fio_zone_info *zb, *ze, *z;
1030         uint64_t swd = 0;
1031         uint64_t wp_swd = 0;
1032
1033         zb = get_zone(f, f->min_zone);
1034         ze = get_zone(f, f->max_zone);
1035         for (z = zb; z < ze; z++) {
1036                 if (z->has_wp) {
1037                         zone_lock(td, f, z);
1038                         wp_swd += z->wp - z->start;
1039                 }
1040                 swd += z->wp - z->start;
1041         }
1042         pthread_mutex_lock(&f->zbd_info->mutex);
1043         switch (a) {
1044         case CHECK_SWD:
1045                 assert(f->zbd_info->sectors_with_data == swd);
1046                 assert(f->zbd_info->wp_sectors_with_data == wp_swd);
1047                 break;
1048         case SET_SWD:
1049                 f->zbd_info->sectors_with_data = swd;
1050                 f->zbd_info->wp_sectors_with_data = wp_swd;
1051                 break;
1052         }
1053         pthread_mutex_unlock(&f->zbd_info->mutex);
1054         for (z = zb; z < ze; z++)
1055                 if (z->has_wp)
1056                         zone_unlock(z);
1057
1058         return swd;
1059 }
1060
1061 /*
1062  * The swd check is useful for debugging but takes too much time to leave
1063  * it enabled all the time. Hence it is disabled by default.
1064  */
1065 static const bool enable_check_swd = false;
1066
1067 /* Check whether the values of zbd_info.*sectors_with_data are correct. */
1068 static void zbd_check_swd(struct thread_data *td, const struct fio_file *f)
1069 {
1070         if (!enable_check_swd)
1071                 return;
1072
1073         zbd_process_swd(td, f, CHECK_SWD);
1074 }
1075
1076 void zbd_file_reset(struct thread_data *td, struct fio_file *f)
1077 {
1078         struct fio_zone_info *zb, *ze;
1079         uint64_t swd;
1080
1081         if (!f->zbd_info || !td_write(td))
1082                 return;
1083
1084         zb = get_zone(f, f->min_zone);
1085         ze = get_zone(f, f->max_zone);
1086         swd = zbd_process_swd(td, f, SET_SWD);
1087         dprint(FD_ZBD, "%s(%s): swd = %" PRIu64 "\n", __func__, f->file_name,
1088                swd);
1089         /*
1090          * If data verification is enabled reset the affected zones before
1091          * writing any data to avoid that a zone reset has to be issued while
1092          * writing data, which causes data loss.
1093          */
1094         if (td->o.verify != VERIFY_NONE && td->runstate != TD_VERIFYING)
1095                 zbd_reset_zones(td, f, zb, ze);
1096         zbd_reset_write_cnt(td, f);
1097 }
1098
1099 /* The caller must hold f->zbd_info->mutex. */
1100 static bool is_zone_open(const struct thread_data *td, const struct fio_file *f,
1101                          unsigned int zone_idx)
1102 {
1103         struct zoned_block_device_info *zbdi = f->zbd_info;
1104         int i;
1105
1106         /* This function should never be called when zbdi->max_open_zones == 0 */
1107         assert(zbdi->max_open_zones);
1108         assert(td->o.job_max_open_zones == 0 || td->num_open_zones <= td->o.job_max_open_zones);
1109         assert(td->o.job_max_open_zones <= zbdi->max_open_zones);
1110         assert(zbdi->num_open_zones <= zbdi->max_open_zones);
1111
1112         for (i = 0; i < zbdi->num_open_zones; i++)
1113                 if (zbdi->open_zones[i] == zone_idx)
1114                         return true;
1115
1116         return false;
1117 }
1118
1119 /*
1120  * Open a ZBD zone if it was not yet open. Returns true if either the zone was
1121  * already open or if opening a new zone is allowed. Returns false if the zone
1122  * was not yet open and opening a new zone would cause the zone limit to be
1123  * exceeded.
1124  */
1125 static bool zbd_open_zone(struct thread_data *td, const struct fio_file *f,
1126                           uint32_t zone_idx)
1127 {
1128         const uint32_t min_bs = td->o.min_bs[DDIR_WRITE];
1129         struct zoned_block_device_info *zbdi = f->zbd_info;
1130         struct fio_zone_info *z = get_zone(f, zone_idx);
1131         bool res = true;
1132
1133         if (z->cond == ZBD_ZONE_COND_OFFLINE)
1134                 return false;
1135
1136         /*
1137          * Skip full zones with data verification enabled because resetting a
1138          * zone causes data loss and hence causes verification to fail.
1139          */
1140         if (td->o.verify != VERIFY_NONE && zbd_zone_full(f, z, min_bs))
1141                 return false;
1142
1143         /*
1144          * zbdi->max_open_zones == 0 means that there is no limit on the maximum
1145          * number of open zones. In this case, do no track open zones in
1146          * zbdi->open_zones array.
1147          */
1148         if (!zbdi->max_open_zones)
1149                 return true;
1150
1151         pthread_mutex_lock(&zbdi->mutex);
1152         if (is_zone_open(td, f, zone_idx)) {
1153                 /*
1154                  * If the zone is already open and going to be full by writes
1155                  * in-flight, handle it as a full zone instead of an open zone.
1156                  */
1157                 if (z->wp >= zbd_zone_capacity_end(z))
1158                         res = false;
1159                 goto out;
1160         }
1161         res = false;
1162         /* Zero means no limit */
1163         if (td->o.job_max_open_zones > 0 &&
1164             td->num_open_zones >= td->o.job_max_open_zones)
1165                 goto out;
1166         if (zbdi->num_open_zones >= zbdi->max_open_zones)
1167                 goto out;
1168         dprint(FD_ZBD, "%s: opening zone %d\n", f->file_name, zone_idx);
1169         zbdi->open_zones[zbdi->num_open_zones++] = zone_idx;
1170         td->num_open_zones++;
1171         z->open = 1;
1172         res = true;
1173
1174 out:
1175         pthread_mutex_unlock(&zbdi->mutex);
1176         return res;
1177 }
1178
1179 /* Anything goes as long as it is not a constant. */
1180 static uint32_t pick_random_zone_idx(const struct fio_file *f,
1181                                      const struct io_u *io_u)
1182 {
1183         return io_u->offset * f->zbd_info->num_open_zones / f->real_file_size;
1184 }
1185
1186 /*
1187  * Modify the offset of an I/O unit that does not refer to an open zone such
1188  * that it refers to an open zone. Close an open zone and open a new zone if
1189  * necessary. The open zone is searched across sequential zones.
1190  * This algorithm can only work correctly if all write pointers are
1191  * a multiple of the fio block size. The caller must neither hold z->mutex
1192  * nor f->zbd_info->mutex. Returns with z->mutex held upon success.
1193  */
1194 static struct fio_zone_info *zbd_convert_to_open_zone(struct thread_data *td,
1195                                                       struct io_u *io_u)
1196 {
1197         const uint32_t min_bs = td->o.min_bs[io_u->ddir];
1198         struct fio_file *f = io_u->file;
1199         struct zoned_block_device_info *zbdi = f->zbd_info;
1200         struct fio_zone_info *z;
1201         unsigned int open_zone_idx = -1;
1202         uint32_t zone_idx, new_zone_idx;
1203         int i;
1204         bool wait_zone_close;
1205
1206         assert(is_valid_offset(f, io_u->offset));
1207
1208         if (td->o.max_open_zones || td->o.job_max_open_zones) {
1209                 /*
1210                  * This statement accesses zbdi->open_zones[] on purpose
1211                  * without locking.
1212                  */
1213                 zone_idx = zbdi->open_zones[pick_random_zone_idx(f, io_u)];
1214         } else {
1215                 zone_idx = zbd_zone_idx(f, io_u->offset);
1216         }
1217         if (zone_idx < f->min_zone)
1218                 zone_idx = f->min_zone;
1219         else if (zone_idx >= f->max_zone)
1220                 zone_idx = f->max_zone - 1;
1221         dprint(FD_ZBD, "%s(%s): starting from zone %d (offset %lld, buflen %lld)\n",
1222                __func__, f->file_name, zone_idx, io_u->offset, io_u->buflen);
1223
1224         /*
1225          * Since z->mutex is the outer lock and zbdi->mutex the inner
1226          * lock it can happen that the state of the zone with index zone_idx
1227          * has changed after 'z' has been assigned and before zbdi->mutex
1228          * has been obtained. Hence the loop.
1229          */
1230         for (;;) {
1231                 uint32_t tmp_idx;
1232
1233                 z = get_zone(f, zone_idx);
1234                 if (z->has_wp)
1235                         zone_lock(td, f, z);
1236                 pthread_mutex_lock(&zbdi->mutex);
1237                 if (z->has_wp) {
1238                         if (z->cond != ZBD_ZONE_COND_OFFLINE &&
1239                             td->o.max_open_zones == 0 && td->o.job_max_open_zones == 0)
1240                                 goto examine_zone;
1241                         if (zbdi->num_open_zones == 0) {
1242                                 dprint(FD_ZBD, "%s(%s): no zones are open\n",
1243                                        __func__, f->file_name);
1244                                 goto open_other_zone;
1245                         }
1246                 }
1247
1248                 /*
1249                  * List of opened zones is per-device, shared across all threads.
1250                  * Start with quasi-random candidate zone.
1251                  * Ignore zones which don't belong to thread's offset/size area.
1252                  */
1253                 open_zone_idx = pick_random_zone_idx(f, io_u);
1254                 assert(!open_zone_idx ||
1255                        open_zone_idx < zbdi->num_open_zones);
1256                 tmp_idx = open_zone_idx;
1257                 for (i = 0; i < zbdi->num_open_zones; i++) {
1258                         uint32_t tmpz;
1259
1260                         if (tmp_idx >= zbdi->num_open_zones)
1261                                 tmp_idx = 0;
1262                         tmpz = zbdi->open_zones[tmp_idx];
1263                         if (f->min_zone <= tmpz && tmpz < f->max_zone) {
1264                                 open_zone_idx = tmp_idx;
1265                                 goto found_candidate_zone;
1266                         }
1267
1268                         tmp_idx++;
1269                 }
1270
1271                 dprint(FD_ZBD, "%s(%s): no candidate zone\n",
1272                         __func__, f->file_name);
1273                 pthread_mutex_unlock(&zbdi->mutex);
1274                 if (z->has_wp)
1275                         zone_unlock(z);
1276                 return NULL;
1277
1278 found_candidate_zone:
1279                 new_zone_idx = zbdi->open_zones[open_zone_idx];
1280                 if (new_zone_idx == zone_idx)
1281                         break;
1282                 zone_idx = new_zone_idx;
1283                 pthread_mutex_unlock(&zbdi->mutex);
1284                 if (z->has_wp)
1285                         zone_unlock(z);
1286         }
1287
1288         /* Both z->mutex and zbdi->mutex are held. */
1289
1290 examine_zone:
1291         if (z->wp + min_bs <= zbd_zone_capacity_end(z)) {
1292                 pthread_mutex_unlock(&zbdi->mutex);
1293                 goto out;
1294         }
1295
1296 open_other_zone:
1297         /* Check if number of open zones reaches one of limits. */
1298         wait_zone_close =
1299                 zbdi->num_open_zones == f->max_zone - f->min_zone ||
1300                 (td->o.max_open_zones &&
1301                  zbdi->num_open_zones == td->o.max_open_zones) ||
1302                 (td->o.job_max_open_zones &&
1303                  td->num_open_zones == td->o.job_max_open_zones);
1304
1305         pthread_mutex_unlock(&zbdi->mutex);
1306
1307         /* Only z->mutex is held. */
1308
1309         /*
1310          * When number of open zones reaches to one of limits, wait for
1311          * zone close before opening a new zone.
1312          */
1313         if (wait_zone_close) {
1314                 dprint(FD_ZBD, "%s(%s): quiesce to allow open zones to close\n",
1315                        __func__, f->file_name);
1316                 io_u_quiesce(td);
1317         }
1318
1319         /* Zone 'z' is full, so try to open a new zone. */
1320         for (i = f->io_size / zbdi->zone_size; i > 0; i--) {
1321                 zone_idx++;
1322                 if (z->has_wp)
1323                         zone_unlock(z);
1324                 z++;
1325                 if (!is_valid_offset(f, z->start)) {
1326                         /* Wrap-around. */
1327                         zone_idx = f->min_zone;
1328                         z = get_zone(f, zone_idx);
1329                 }
1330                 assert(is_valid_offset(f, z->start));
1331                 if (!z->has_wp)
1332                         continue;
1333                 zone_lock(td, f, z);
1334                 if (z->open)
1335                         continue;
1336                 if (zbd_open_zone(td, f, zone_idx))
1337                         goto out;
1338         }
1339
1340         /* Only z->mutex is held. */
1341
1342         /* Check whether the write fits in any of the already opened zones. */
1343         pthread_mutex_lock(&zbdi->mutex);
1344         for (i = 0; i < zbdi->num_open_zones; i++) {
1345                 zone_idx = zbdi->open_zones[i];
1346                 if (zone_idx < f->min_zone || zone_idx >= f->max_zone)
1347                         continue;
1348                 pthread_mutex_unlock(&zbdi->mutex);
1349                 zone_unlock(z);
1350
1351                 z = get_zone(f, zone_idx);
1352
1353                 zone_lock(td, f, z);
1354                 if (z->wp + min_bs <= zbd_zone_capacity_end(z))
1355                         goto out;
1356                 pthread_mutex_lock(&zbdi->mutex);
1357         }
1358         pthread_mutex_unlock(&zbdi->mutex);
1359         zone_unlock(z);
1360         dprint(FD_ZBD, "%s(%s): did not open another zone\n", __func__,
1361                f->file_name);
1362         return NULL;
1363
1364 out:
1365         dprint(FD_ZBD, "%s(%s): returning zone %d\n", __func__, f->file_name,
1366                zone_idx);
1367         io_u->offset = z->start;
1368         assert(z->has_wp);
1369         assert(z->cond != ZBD_ZONE_COND_OFFLINE);
1370         return z;
1371 }
1372
1373 /* The caller must hold z->mutex. */
1374 static struct fio_zone_info *zbd_replay_write_order(struct thread_data *td,
1375                                                     struct io_u *io_u,
1376                                                     struct fio_zone_info *z)
1377 {
1378         const struct fio_file *f = io_u->file;
1379         const uint32_t min_bs = td->o.min_bs[DDIR_WRITE];
1380
1381         if (!zbd_open_zone(td, f, zbd_zone_nr(f, z))) {
1382                 zone_unlock(z);
1383                 z = zbd_convert_to_open_zone(td, io_u);
1384                 assert(z);
1385         }
1386
1387         if (z->verify_block * min_bs >= z->capacity) {
1388                 log_err("%s: %d * %d >= %llu\n", f->file_name, z->verify_block,
1389                         min_bs, (unsigned long long)z->capacity);
1390                 /*
1391                  * If the assertion below fails during a test run, adding
1392                  * "--experimental_verify=1" to the command line may help.
1393                  */
1394                 assert(false);
1395         }
1396         io_u->offset = z->start + z->verify_block * min_bs;
1397         if (io_u->offset + io_u->buflen >= zbd_zone_capacity_end(z)) {
1398                 log_err("%s: %llu + %llu >= %llu\n", f->file_name, io_u->offset,
1399                         io_u->buflen, (unsigned long long) zbd_zone_capacity_end(z));
1400                 assert(false);
1401         }
1402         z->verify_block += io_u->buflen / min_bs;
1403
1404         return z;
1405 }
1406
1407 /*
1408  * Find another zone for which @io_u fits in the readable data in the zone.
1409  * Search in zones @zb + 1 .. @zl. For random workload, also search in zones
1410  * @zb - 1 .. @zf.
1411  *
1412  * Either returns NULL or returns a zone pointer. When the zone has write
1413  * pointer, hold the mutex for the zone.
1414  */
1415 static struct fio_zone_info *
1416 zbd_find_zone(struct thread_data *td, struct io_u *io_u,
1417               struct fio_zone_info *zb, struct fio_zone_info *zl)
1418 {
1419         const uint32_t min_bs = td->o.min_bs[io_u->ddir];
1420         struct fio_file *f = io_u->file;
1421         struct fio_zone_info *z1, *z2;
1422         const struct fio_zone_info *const zf = get_zone(f, f->min_zone);
1423
1424         /*
1425          * Skip to the next non-empty zone in case of sequential I/O and to
1426          * the nearest non-empty zone in case of random I/O.
1427          */
1428         for (z1 = zb + 1, z2 = zb - 1; z1 < zl || z2 >= zf; z1++, z2--) {
1429                 if (z1 < zl && z1->cond != ZBD_ZONE_COND_OFFLINE) {
1430                         if (z1->has_wp)
1431                                 zone_lock(td, f, z1);
1432                         if (z1->start + min_bs <= z1->wp)
1433                                 return z1;
1434                         if (z1->has_wp)
1435                                 zone_unlock(z1);
1436                 } else if (!td_random(td)) {
1437                         break;
1438                 }
1439                 if (td_random(td) && z2 >= zf &&
1440                     z2->cond != ZBD_ZONE_COND_OFFLINE) {
1441                         if (z2->has_wp)
1442                                 zone_lock(td, f, z2);
1443                         if (z2->start + min_bs <= z2->wp)
1444                                 return z2;
1445                         if (z2->has_wp)
1446                                 zone_unlock(z2);
1447                 }
1448         }
1449         dprint(FD_ZBD, "%s: adjusting random read offset failed\n",
1450                f->file_name);
1451         return NULL;
1452 }
1453
1454 /**
1455  * zbd_end_zone_io - update zone status at command completion
1456  * @io_u: I/O unit
1457  * @z: zone info pointer
1458  *
1459  * If the write command made the zone full, close it.
1460  *
1461  * The caller must hold z->mutex.
1462  */
1463 static void zbd_end_zone_io(struct thread_data *td, const struct io_u *io_u,
1464                             struct fio_zone_info *z)
1465 {
1466         const struct fio_file *f = io_u->file;
1467
1468         if (io_u->ddir == DDIR_WRITE &&
1469             io_u->offset + io_u->buflen >= zbd_zone_capacity_end(z)) {
1470                 pthread_mutex_lock(&f->zbd_info->mutex);
1471                 zbd_close_zone(td, f, zbd_zone_nr(f, z));
1472                 pthread_mutex_unlock(&f->zbd_info->mutex);
1473         }
1474 }
1475
1476 /**
1477  * zbd_queue_io - update the write pointer of a sequential zone
1478  * @io_u: I/O unit
1479  * @success: Whether or not the I/O unit has been queued successfully
1480  * @q: queueing status (busy, completed or queued).
1481  *
1482  * For write and trim operations, update the write pointer of the I/O unit
1483  * target zone.
1484  */
1485 static void zbd_queue_io(struct thread_data *td, struct io_u *io_u, int q,
1486                          bool success)
1487 {
1488         const struct fio_file *f = io_u->file;
1489         struct zoned_block_device_info *zbd_info = f->zbd_info;
1490         struct fio_zone_info *z;
1491         uint32_t zone_idx;
1492         uint64_t zone_end;
1493
1494         assert(zbd_info);
1495
1496         zone_idx = zbd_zone_idx(f, io_u->offset);
1497         assert(zone_idx < zbd_info->nr_zones);
1498         z = get_zone(f, zone_idx);
1499
1500         assert(z->has_wp);
1501
1502         if (!success)
1503                 goto unlock;
1504
1505         dprint(FD_ZBD,
1506                "%s: queued I/O (%lld, %llu) for zone %u\n",
1507                f->file_name, io_u->offset, io_u->buflen, zone_idx);
1508
1509         switch (io_u->ddir) {
1510         case DDIR_WRITE:
1511                 zone_end = min((uint64_t)(io_u->offset + io_u->buflen),
1512                                zbd_zone_capacity_end(z));
1513                 pthread_mutex_lock(&zbd_info->mutex);
1514                 /*
1515                  * z->wp > zone_end means that one or more I/O errors
1516                  * have occurred.
1517                  */
1518                 if (z->wp <= zone_end) {
1519                         zbd_info->sectors_with_data += zone_end - z->wp;
1520                         zbd_info->wp_sectors_with_data += zone_end - z->wp;
1521                 }
1522                 pthread_mutex_unlock(&zbd_info->mutex);
1523                 z->wp = zone_end;
1524                 break;
1525         case DDIR_TRIM:
1526                 assert(z->wp == z->start);
1527                 break;
1528         default:
1529                 break;
1530         }
1531
1532         if (q == FIO_Q_COMPLETED && !io_u->error)
1533                 zbd_end_zone_io(td, io_u, z);
1534
1535 unlock:
1536         if (!success || q != FIO_Q_QUEUED) {
1537                 /* BUSY or COMPLETED: unlock the zone */
1538                 zone_unlock(z);
1539                 io_u->zbd_put_io = NULL;
1540         }
1541 }
1542
1543 /**
1544  * zbd_put_io - Unlock an I/O unit target zone lock
1545  * @io_u: I/O unit
1546  */
1547 static void zbd_put_io(struct thread_data *td, const struct io_u *io_u)
1548 {
1549         const struct fio_file *f = io_u->file;
1550         struct zoned_block_device_info *zbd_info = f->zbd_info;
1551         struct fio_zone_info *z;
1552         uint32_t zone_idx;
1553
1554         assert(zbd_info);
1555
1556         zone_idx = zbd_zone_idx(f, io_u->offset);
1557         assert(zone_idx < zbd_info->nr_zones);
1558         z = get_zone(f, zone_idx);
1559
1560         assert(z->has_wp);
1561
1562         dprint(FD_ZBD,
1563                "%s: terminate I/O (%lld, %llu) for zone %u\n",
1564                f->file_name, io_u->offset, io_u->buflen, zone_idx);
1565
1566         zbd_end_zone_io(td, io_u, z);
1567
1568         zone_unlock(z);
1569         zbd_check_swd(td, f);
1570 }
1571
1572 /*
1573  * Windows and MacOS do not define this.
1574  */
1575 #ifndef EREMOTEIO
1576 #define EREMOTEIO       121     /* POSIX value */
1577 #endif
1578
1579 bool zbd_unaligned_write(int error_code)
1580 {
1581         switch (error_code) {
1582         case EIO:
1583         case EREMOTEIO:
1584                 return true;
1585         }
1586         return false;
1587 }
1588
1589 /**
1590  * setup_zbd_zone_mode - handle zoneskip as necessary for ZBD drives
1591  * @td: FIO thread data.
1592  * @io_u: FIO I/O unit.
1593  *
1594  * For sequential workloads, change the file offset to skip zoneskip bytes when
1595  * no more IO can be performed in the current zone.
1596  * - For read workloads, zoneskip is applied when the io has reached the end of
1597  *   the zone or the zone write position (when td->o.read_beyond_wp is false).
1598  * - For write workloads, zoneskip is applied when the zone is full.
1599  * This applies only to read and write operations.
1600  */
1601 void setup_zbd_zone_mode(struct thread_data *td, struct io_u *io_u)
1602 {
1603         struct fio_file *f = io_u->file;
1604         enum fio_ddir ddir = io_u->ddir;
1605         struct fio_zone_info *z;
1606         uint32_t zone_idx;
1607
1608         assert(td->o.zone_mode == ZONE_MODE_ZBD);
1609         assert(td->o.zone_size);
1610         assert(f->zbd_info);
1611
1612         zone_idx = zbd_zone_idx(f, f->last_pos[ddir]);
1613         z = get_zone(f, zone_idx);
1614
1615         /*
1616          * When the zone capacity is smaller than the zone size and the I/O is
1617          * sequential write, skip to zone end if the latest position is at the
1618          * zone capacity limit.
1619          */
1620         if (z->capacity < f->zbd_info->zone_size && !td_random(td) &&
1621             ddir == DDIR_WRITE &&
1622             f->last_pos[ddir] >= zbd_zone_capacity_end(z)) {
1623                 dprint(FD_ZBD,
1624                        "%s: Jump from zone capacity limit to zone end:"
1625                        " (%llu -> %llu) for zone %u (%llu)\n",
1626                        f->file_name, (unsigned long long) f->last_pos[ddir],
1627                        (unsigned long long) zbd_zone_end(z), zone_idx,
1628                        (unsigned long long) z->capacity);
1629                 td->io_skip_bytes += zbd_zone_end(z) - f->last_pos[ddir];
1630                 f->last_pos[ddir] = zbd_zone_end(z);
1631         }
1632
1633         /*
1634          * zone_skip is valid only for sequential workloads.
1635          */
1636         if (td_random(td) || !td->o.zone_skip)
1637                 return;
1638
1639         /*
1640          * It is time to switch to a new zone if:
1641          * - zone_bytes == zone_size bytes have already been accessed
1642          * - The last position reached the end of the current zone.
1643          * - For reads with td->o.read_beyond_wp == false, the last position
1644          *   reached the zone write pointer.
1645          */
1646         if (td->zone_bytes >= td->o.zone_size ||
1647             f->last_pos[ddir] >= zbd_zone_end(z) ||
1648             (ddir == DDIR_READ &&
1649              (!td->o.read_beyond_wp) && f->last_pos[ddir] >= z->wp)) {
1650                 /*
1651                  * Skip zones.
1652                  */
1653                 td->zone_bytes = 0;
1654                 f->file_offset += td->o.zone_size + td->o.zone_skip;
1655
1656                 /*
1657                  * Wrap from the beginning, if we exceed the file size
1658                  */
1659                 if (f->file_offset >= f->real_file_size)
1660                         f->file_offset = get_start_offset(td, f);
1661
1662                 f->last_pos[ddir] = f->file_offset;
1663                 td->io_skip_bytes += td->o.zone_skip;
1664         }
1665 }
1666
1667 /**
1668  * zbd_adjust_ddir - Adjust an I/O direction for zonemode=zbd.
1669  *
1670  * @td: FIO thread data.
1671  * @io_u: FIO I/O unit.
1672  * @ddir: I/O direction before adjustment.
1673  *
1674  * Return adjusted I/O direction.
1675  */
1676 enum fio_ddir zbd_adjust_ddir(struct thread_data *td, struct io_u *io_u,
1677                               enum fio_ddir ddir)
1678 {
1679         /*
1680          * In case read direction is chosen for the first random I/O, fio with
1681          * zonemode=zbd stops because no data can be read from zoned block
1682          * devices with all empty zones. Overwrite the first I/O direction as
1683          * write to make sure data to read exists.
1684          */
1685         assert(io_u->file->zbd_info);
1686         if (ddir != DDIR_READ || !td_rw(td))
1687                 return ddir;
1688
1689         if (io_u->file->zbd_info->sectors_with_data ||
1690             td->o.read_beyond_wp)
1691                 return DDIR_READ;
1692
1693         return DDIR_WRITE;
1694 }
1695
1696 /**
1697  * zbd_adjust_block - adjust the offset and length as necessary for ZBD drives
1698  * @td: FIO thread data.
1699  * @io_u: FIO I/O unit.
1700  *
1701  * Locking strategy: returns with z->mutex locked if and only if z refers
1702  * to a sequential zone and if io_u_accept is returned. z is the zone that
1703  * corresponds to io_u->offset at the end of this function.
1704  */
1705 enum io_u_action zbd_adjust_block(struct thread_data *td, struct io_u *io_u)
1706 {
1707         struct fio_file *f = io_u->file;
1708         struct zoned_block_device_info *zbdi = f->zbd_info;
1709         uint32_t zone_idx_b;
1710         struct fio_zone_info *zb, *zl, *orig_zb;
1711         uint32_t orig_len = io_u->buflen;
1712         uint32_t min_bs = td->o.min_bs[io_u->ddir];
1713         uint64_t new_len;
1714         int64_t range;
1715
1716         assert(zbdi);
1717         assert(min_bs);
1718         assert(is_valid_offset(f, io_u->offset));
1719         assert(io_u->buflen);
1720         zone_idx_b = zbd_zone_idx(f, io_u->offset);
1721         zb = get_zone(f, zone_idx_b);
1722         orig_zb = zb;
1723
1724         if (!zb->has_wp) {
1725                 /* Accept non-write I/Os for conventional zones. */
1726                 if (io_u->ddir != DDIR_WRITE)
1727                         return io_u_accept;
1728                 /*
1729                  * Make sure that writes to conventional zones
1730                  * don't cross over to any sequential zones.
1731                  */
1732                 if (!(zb + 1)->has_wp ||
1733                     io_u->offset + io_u->buflen <= (zb + 1)->start)
1734                         return io_u_accept;
1735
1736                 if (io_u->offset + min_bs > (zb + 1)->start) {
1737                         dprint(FD_IO,
1738                                "%s: off=%llu + min_bs=%u > next zone %llu\n",
1739                                f->file_name, io_u->offset,
1740                                min_bs, (unsigned long long) (zb + 1)->start);
1741                         io_u->offset = zb->start + (zb + 1)->start - io_u->offset;
1742                         new_len = min(io_u->buflen, (zb + 1)->start - io_u->offset);
1743                 } else {
1744                         new_len = (zb + 1)->start - io_u->offset;
1745                 }
1746                 io_u->buflen = new_len / min_bs * min_bs;
1747                 return io_u_accept;
1748         }
1749
1750         /*
1751          * Accept the I/O offset for reads if reading beyond the write pointer
1752          * is enabled.
1753          */
1754         if (zb->cond != ZBD_ZONE_COND_OFFLINE &&
1755             io_u->ddir == DDIR_READ && td->o.read_beyond_wp)
1756                 return io_u_accept;
1757
1758         zbd_check_swd(td, f);
1759
1760         zone_lock(td, f, zb);
1761
1762         switch (io_u->ddir) {
1763         case DDIR_READ:
1764                 if (td->runstate == TD_VERIFYING && td_write(td)) {
1765                         zb = zbd_replay_write_order(td, io_u, zb);
1766                         goto accept;
1767                 }
1768                 /*
1769                  * Check that there is enough written data in the zone to do an
1770                  * I/O of at least min_bs B. If there isn't, find a new zone for
1771                  * the I/O.
1772                  */
1773                 range = zb->cond != ZBD_ZONE_COND_OFFLINE ?
1774                         zb->wp - zb->start : 0;
1775                 if (range < min_bs ||
1776                     ((!td_random(td)) && (io_u->offset + min_bs > zb->wp))) {
1777                         zone_unlock(zb);
1778                         zl = get_zone(f, f->max_zone);
1779                         zb = zbd_find_zone(td, io_u, zb, zl);
1780                         if (!zb) {
1781                                 dprint(FD_ZBD,
1782                                        "%s: zbd_find_zone(%lld, %llu) failed\n",
1783                                        f->file_name, io_u->offset,
1784                                        io_u->buflen);
1785                                 goto eof;
1786                         }
1787                         /*
1788                          * zbd_find_zone() returned a zone with a range of at
1789                          * least min_bs.
1790                          */
1791                         range = zb->wp - zb->start;
1792                         assert(range >= min_bs);
1793
1794                         if (!td_random(td))
1795                                 io_u->offset = zb->start;
1796                 }
1797                 /*
1798                  * Make sure the I/O is within the zone valid data range while
1799                  * maximizing the I/O size and preserving randomness.
1800                  */
1801                 if (range <= io_u->buflen)
1802                         io_u->offset = zb->start;
1803                 else if (td_random(td))
1804                         io_u->offset = zb->start +
1805                                 ((io_u->offset - orig_zb->start) %
1806                                  (range - io_u->buflen)) / min_bs * min_bs;
1807                 /*
1808                  * When zbd_find_zone() returns a conventional zone,
1809                  * we can simply accept the new i/o offset here.
1810                  */
1811                 if (!zb->has_wp)
1812                         return io_u_accept;
1813                 /*
1814                  * Make sure the I/O does not cross over the zone wp position.
1815                  */
1816                 new_len = min((unsigned long long)io_u->buflen,
1817                               (unsigned long long)(zb->wp - io_u->offset));
1818                 new_len = new_len / min_bs * min_bs;
1819                 if (new_len < io_u->buflen) {
1820                         io_u->buflen = new_len;
1821                         dprint(FD_IO, "Changed length from %u into %llu\n",
1822                                orig_len, io_u->buflen);
1823                 }
1824                 assert(zb->start <= io_u->offset);
1825                 assert(io_u->offset + io_u->buflen <= zb->wp);
1826                 goto accept;
1827         case DDIR_WRITE:
1828                 if (io_u->buflen > zbdi->zone_size) {
1829                         td_verror(td, EINVAL, "I/O buflen exceeds zone size");
1830                         dprint(FD_IO,
1831                                "%s: I/O buflen %llu exceeds zone size %llu\n",
1832                                f->file_name, io_u->buflen,
1833                                (unsigned long long) zbdi->zone_size);
1834                         goto eof;
1835                 }
1836                 if (!zbd_open_zone(td, f, zone_idx_b)) {
1837                         zone_unlock(zb);
1838                         zb = zbd_convert_to_open_zone(td, io_u);
1839                         if (!zb) {
1840                                 dprint(FD_IO, "%s: can't convert to open zone",
1841                                        f->file_name);
1842                                 goto eof;
1843                         }
1844                         zone_idx_b = zbd_zone_nr(f, zb);
1845                 }
1846                 /* Check whether the zone reset threshold has been exceeded */
1847                 if (td->o.zrf.u.f) {
1848                         if (zbdi->wp_sectors_with_data >=
1849                             f->io_size * td->o.zrt.u.f &&
1850                             zbd_dec_and_reset_write_cnt(td, f)) {
1851                                 zb->reset_zone = 1;
1852                         }
1853                 }
1854                 /* Reset the zone pointer if necessary */
1855                 if (zb->reset_zone || zbd_zone_full(f, zb, min_bs)) {
1856                         assert(td->o.verify == VERIFY_NONE);
1857                         /*
1858                          * Since previous write requests may have been submitted
1859                          * asynchronously and since we will submit the zone
1860                          * reset synchronously, wait until previously submitted
1861                          * write requests have completed before issuing a
1862                          * zone reset.
1863                          */
1864                         io_u_quiesce(td);
1865                         zb->reset_zone = 0;
1866                         if (zbd_reset_zone(td, f, zb) < 0)
1867                                 goto eof;
1868
1869                         if (zb->capacity < min_bs) {
1870                                 td_verror(td, EINVAL, "ZCAP is less min_bs");
1871                                 log_err("zone capacity %llu smaller than minimum block size %d\n",
1872                                         (unsigned long long)zb->capacity,
1873                                         min_bs);
1874                                 goto eof;
1875                         }
1876                 }
1877                 /* Make writes occur at the write pointer */
1878                 assert(!zbd_zone_full(f, zb, min_bs));
1879                 io_u->offset = zb->wp;
1880                 if (!is_valid_offset(f, io_u->offset)) {
1881                         td_verror(td, EINVAL, "invalid WP value");
1882                         dprint(FD_ZBD, "%s: dropped request with offset %llu\n",
1883                                f->file_name, io_u->offset);
1884                         goto eof;
1885                 }
1886                 /*
1887                  * Make sure that the buflen is a multiple of the minimal
1888                  * block size. Give up if shrinking would make the request too
1889                  * small.
1890                  */
1891                 new_len = min((unsigned long long)io_u->buflen,
1892                               zbd_zone_capacity_end(zb) - io_u->offset);
1893                 new_len = new_len / min_bs * min_bs;
1894                 if (new_len == io_u->buflen)
1895                         goto accept;
1896                 if (new_len >= min_bs) {
1897                         io_u->buflen = new_len;
1898                         dprint(FD_IO, "Changed length from %u into %llu\n",
1899                                orig_len, io_u->buflen);
1900                         goto accept;
1901                 }
1902                 td_verror(td, EIO, "zone remainder too small");
1903                 log_err("zone remainder %lld smaller than min block size %d\n",
1904                         (zbd_zone_capacity_end(zb) - io_u->offset), min_bs);
1905                 goto eof;
1906         case DDIR_TRIM:
1907                 /* fall-through */
1908         case DDIR_SYNC:
1909         case DDIR_DATASYNC:
1910         case DDIR_SYNC_FILE_RANGE:
1911         case DDIR_WAIT:
1912         case DDIR_LAST:
1913         case DDIR_INVAL:
1914                 goto accept;
1915         }
1916
1917         assert(false);
1918
1919 accept:
1920         assert(zb->has_wp);
1921         assert(zb->cond != ZBD_ZONE_COND_OFFLINE);
1922         assert(!io_u->zbd_queue_io);
1923         assert(!io_u->zbd_put_io);
1924         io_u->zbd_queue_io = zbd_queue_io;
1925         io_u->zbd_put_io = zbd_put_io;
1926         /*
1927          * Since we return with the zone lock still held,
1928          * add an annotation to let Coverity know that it
1929          * is intentional.
1930          */
1931         /* coverity[missing_unlock] */
1932         return io_u_accept;
1933
1934 eof:
1935         if (zb && zb->has_wp)
1936                 zone_unlock(zb);
1937         return io_u_eof;
1938 }
1939
1940 /* Return a string with ZBD statistics */
1941 char *zbd_write_status(const struct thread_stat *ts)
1942 {
1943         char *res;
1944
1945         if (asprintf(&res, "; %llu zone resets", (unsigned long long) ts->nr_zone_resets) < 0)
1946                 return NULL;
1947         return res;
1948 }