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