zbd.h

   1 /*
   2  * Copyright (C) 2018 Western Digital Corporation or its affiliates.
   3  *
   4  * This file is released under the GPL.
   5  */
   6
   7 #ifndef FIO_ZBD_H
   8 #define FIO_ZBD_H
   9
  10 #include "io_u.h"
  11 #include "ioengines.h"
  12 #include "oslib/blkzoned.h"
  13 #include "zbd_types.h"
  14
  15 struct fio_file;
  16
  17 enum io_u_action {
  18         io_u_accept     = 0,
  19         io_u_eof        = 1,
  20 };
  21
  22 /**
  23  * struct fio_zone_info - information about a single ZBD zone
  24  * @start: zone start location (bytes)
  25  * @wp: zone write pointer location (bytes)
  26  * @capacity: maximum size usable from the start of a zone (bytes)
  27  * @verify_block: number of blocks that have been verified for this zone
  28  * @mutex: protects the modifiable members in this structure
  29  * @type: zone type (BLK_ZONE_TYPE_*)
  30  * @cond: zone state (BLK_ZONE_COND_*)
  31  * @has_wp: whether or not this zone can have a valid write pointer
  32  * @open: whether or not this zone is currently open. Only relevant if
  33  *              max_open_zones > 0.
  34  * @reset_zone: whether or not this zone should be reset before writing to it
  35  */
  36 struct fio_zone_info {
  37         pthread_mutex_t         mutex;
  38         uint64_t                start;
  39         uint64_t                wp;
  40         uint64_t                capacity;
  41         uint32_t                verify_block;
  42         enum zbd_zone_type      type:2;
  43         enum zbd_zone_cond      cond:4;
  44         unsigned int            has_wp:1;
  45         unsigned int            open:1;
  46         unsigned int            reset_zone:1;
  47 };
  48
  49 /**
  50  * zoned_block_device_info - zoned block device characteristics
  51  * @model: Device model.
  52  * @max_open_zones: global limit on the number of simultaneously opened
  53  *      sequential write zones. A zero value means unlimited open zones,
  54  *      and that open zones will not be tracked in the open_zones array.
  55  * @mutex: Protects the modifiable members in this structure (refcount and
  56  *              num_open_zones).
  57  * @zone_size: size of a single zone in bytes.
  58  * @sectors_with_data: total size of data in all zones in units of 512 bytes
  59  * @wp_sectors_with_data: total size of data in zones with write pointers in
  60  *                        units of 512 bytes
  61  * @zone_size_log2: log2 of the zone size in bytes if it is a power of 2 or 0
  62  *              if the zone size is not a power of 2.
  63  * @nr_zones: number of zones
  64  * @refcount: number of fio files that share this structure
  65  * @num_open_zones: number of open zones
  66  * @write_cnt: Number of writes since the latest zone reset triggered by
  67  *             the zone_reset_frequency fio job parameter.
  68  * @open_zones: zone numbers of open zones
  69  * @zone_info: description of the individual zones
  70  *
  71  * Only devices for which all zones have the same size are supported.
  72  * Note: if the capacity is not a multiple of the zone size then the last zone
  73  * will be smaller than 'zone_size'.
  74  */
  75 struct zoned_block_device_info {
  76         enum zbd_zoned_model    model;
  77         uint32_t                max_open_zones;
  78         pthread_mutex_t         mutex;
  79         uint64_t                zone_size;
  80         uint64_t                sectors_with_data;
  81         uint64_t                wp_sectors_with_data;
  82         uint32_t                zone_size_log2;
  83         uint32_t                nr_zones;
  84         uint32_t                refcount;
  85         uint32_t                num_open_zones;
  86         uint32_t                write_cnt;
  87         uint32_t                open_zones[ZBD_MAX_OPEN_ZONES];
  88         struct fio_zone_info    zone_info[0];
  89 };
  90
  91 int zbd_init_files(struct thread_data *td);
  92 void zbd_recalc_options_with_zone_granularity(struct thread_data *td);
  93 int zbd_setup_files(struct thread_data *td);
  94 void zbd_free_zone_info(struct fio_file *f);
  95 void zbd_file_reset(struct thread_data *td, struct fio_file *f);
  96 bool zbd_unaligned_write(int error_code);
  97 void setup_zbd_zone_mode(struct thread_data *td, struct io_u *io_u);
  98 enum fio_ddir zbd_adjust_ddir(struct thread_data *td, struct io_u *io_u,
  99                               enum fio_ddir ddir);
 100 enum io_u_action zbd_adjust_block(struct thread_data *td, struct io_u *io_u);
 101 char *zbd_write_status(const struct thread_stat *ts);
 102
 103 static inline void zbd_close_file(struct fio_file *f)
 104 {
 105         if (f->zbd_info)
 106                 zbd_free_zone_info(f);
 107 }
 108
 109 static inline void zbd_queue_io_u(struct thread_data *td, struct io_u *io_u,
 110                                   enum fio_q_status status)
 111 {
 112         if (io_u->zbd_queue_io) {
 113                 io_u->zbd_queue_io(td, io_u, status, io_u->error == 0);
 114                 io_u->zbd_queue_io = NULL;
 115         }
 116 }
 117
 118 static inline void zbd_put_io_u(struct thread_data *td, struct io_u *io_u)
 119 {
 120         if (io_u->zbd_put_io) {
 121                 io_u->zbd_put_io(td, io_u);
 122                 io_u->zbd_queue_io = NULL;
 123                 io_u->zbd_put_io = NULL;
 124         }
 125 }
 126
 127 #endif /* FIO_ZBD_H */