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  * @verify_block: number of blocks that have been verified for this zone
  27  * @mutex: protects the modifiable members in this structure
  28  * @type: zone type (BLK_ZONE_TYPE_*)
  29  * @cond: zone state (BLK_ZONE_COND_*)
  30  * @open: whether or not this zone is currently open. Only relevant if
  31  *              max_open_zones > 0.
  32  * @reset_zone: whether or not this zone should be reset before writing to it
  33  */
  34 struct fio_zone_info {
  35         pthread_mutex_t         mutex;
  36         uint64_t                start;
  37         uint64_t                wp;
  38         uint32_t                verify_block;
  39         enum zbd_zone_type      type:2;
  40         enum zbd_zone_cond      cond:4;
  41         unsigned int            open:1;
  42         unsigned int            reset_zone:1;
  43 };
  44
  45 /**
  46  * zoned_block_device_info - zoned block device characteristics
  47  * @model: Device model.
  48  * @max_open_zones: global limit on the number of simultaneously opened
  49  *      sequential write zones.
  50  * @mutex: Protects the modifiable members in this structure (refcount and
  51  *              num_open_zones).
  52  * @zone_size: size of a single zone in units of 512 bytes
  53  * @sectors_with_data: total size of data in all zones in units of 512 bytes
  54  * @zone_size_log2: log2 of the zone size in bytes if it is a power of 2 or 0
  55  *              if the zone size is not a power of 2.
  56  * @nr_zones: number of zones
  57  * @refcount: number of fio files that share this structure
  58  * @num_open_zones: number of open zones
  59  * @write_cnt: Number of writes since the latest zone reset triggered by
  60  *             the zone_reset_frequency fio job parameter.
  61  * @open_zones: zone numbers of open zones
  62  * @zone_info: description of the individual zones
  63  *
  64  * Only devices for which all zones have the same size are supported.
  65  * Note: if the capacity is not a multiple of the zone size then the last zone
  66  * will be smaller than 'zone_size'.
  67  */
  68 struct zoned_block_device_info {
  69         enum zbd_zoned_model    model;
  70         uint32_t                max_open_zones;
  71         pthread_mutex_t         mutex;
  72         uint64_t                zone_size;
  73         uint64_t                sectors_with_data;
  74         uint32_t                zone_size_log2;
  75         uint32_t                nr_zones;
  76         uint32_t                refcount;
  77         uint32_t                num_open_zones;
  78         uint32_t                write_cnt;
  79         uint32_t                open_zones[ZBD_MAX_OPEN_ZONES];
  80         struct fio_zone_info    zone_info[0];
  81 };
  82
  83 int zbd_setup_files(struct thread_data *td);
  84 void zbd_free_zone_info(struct fio_file *f);
  85 void zbd_file_reset(struct thread_data *td, struct fio_file *f);
  86 bool zbd_unaligned_write(int error_code);
  87 void setup_zbd_zone_mode(struct thread_data *td, struct io_u *io_u);
  88 enum fio_ddir zbd_adjust_ddir(struct thread_data *td, struct io_u *io_u,
  89                               enum fio_ddir ddir);
  90 enum io_u_action zbd_adjust_block(struct thread_data *td, struct io_u *io_u);
  91 char *zbd_write_status(const struct thread_stat *ts);
  92
  93 static inline void zbd_close_file(struct fio_file *f)
  94 {
  95         if (f->zbd_info)
  96                 zbd_free_zone_info(f);
  97 }
  98
  99 static inline void zbd_queue_io_u(struct io_u *io_u, enum fio_q_status status)
 100 {
 101         if (io_u->zbd_queue_io) {
 102                 io_u->zbd_queue_io(io_u, status, io_u->error == 0);
 103                 io_u->zbd_queue_io = NULL;
 104         }
 105 }
 106
 107 static inline void zbd_put_io_u(struct io_u *io_u)
 108 {
 109         if (io_u->zbd_put_io) {
 110                 io_u->zbd_put_io(io_u);
 111                 io_u->zbd_queue_io = NULL;
 112                 io_u->zbd_put_io = NULL;
 113         }
 114 }
 115
 116 #endif /* FIO_ZBD_H */