[fio.git] / zbd.h

/*
 * Copyright (C) 2018 Western Digital Corporation or its affiliates.
 *
 * This file is released under the GPL.
 */

#ifndef FIO_ZBD_H
#define FIO_ZBD_H

#include "io_u.h"
#include "ioengines.h"
#include "oslib/blkzoned.h"
#include "zbd_types.h"

struct fio_file;

enum io_u_action {
	io_u_accept	= 0,
	io_u_eof	= 1,
	io_u_completed  = 2,
};

/**
 * struct fio_zone_info - information about a single ZBD zone
 * @start: zone start location (bytes)
 * @wp: zone write pointer location (bytes)
 * @capacity: maximum size usable from the start of a zone (bytes)
 * @mutex: protects the modifiable members in this structure
 * @type: zone type (BLK_ZONE_TYPE_*)
 * @cond: zone state (BLK_ZONE_COND_*)
 * @has_wp: whether or not this zone can have a valid write pointer
 * @open: whether or not this zone is currently open. Only relevant if
 *		max_open_zones > 0.
 * @reset_zone: whether or not this zone should be reset before writing to it
 */
struct fio_zone_info {
	pthread_mutex_t		mutex;
	uint64_t		start;
	uint64_t		wp;
	uint64_t		capacity;
	enum zbd_zone_type	type:2;
	enum zbd_zone_cond	cond:4;
	unsigned int		has_wp:1;
	unsigned int		open:1;
	unsigned int		reset_zone:1;
};

/**
 * zoned_block_device_info - zoned block device characteristics
 * @model: Device model.
 * @max_open_zones: global limit on the number of simultaneously opened
 *	sequential write zones. A zero value means unlimited open zones,
 *	and that open zones will not be tracked in the open_zones array.
 * @mutex: Protects the modifiable members in this structure (refcount and
 *		num_open_zones).
 * @zone_size: size of a single zone in bytes.
 * @wp_valid_data_bytes: total size of data in zones with write pointers
 * @write_min_zone: Minimum zone index of all job's write ranges. Inclusive.
 * @write_max_zone: Maximum zone index of all job's write ranges. Exclusive.
 * @zone_size_log2: log2 of the zone size in bytes if it is a power of 2 or 0
 *		if the zone size is not a power of 2.
 * @nr_zones: number of zones
 * @refcount: number of fio files that share this structure
 * @num_open_zones: number of open zones
 * @write_cnt: Number of writes since the latest zone reset triggered by
 *	       the zone_reset_frequency fio job parameter.
 * @open_zones: zone numbers of open zones
 * @zone_info: description of the individual zones
 *
 * Only devices for which all zones have the same size are supported.
 * Note: if the capacity is not a multiple of the zone size then the last zone
 * will be smaller than 'zone_size'.
 */
struct zoned_block_device_info {
	enum zbd_zoned_model	model;
	uint32_t		max_open_zones;
	pthread_mutex_t		mutex;
	uint64_t		zone_size;
	uint64_t		wp_valid_data_bytes;
	uint32_t		write_min_zone;
	uint32_t		write_max_zone;
	uint32_t		zone_size_log2;
	uint32_t		nr_zones;
	uint32_t		refcount;
	uint32_t		num_open_zones;
	uint32_t		write_cnt;
	uint32_t		open_zones[ZBD_MAX_OPEN_ZONES];
	struct fio_zone_info	zone_info[0];
};

int zbd_init_files(struct thread_data *td);
void zbd_recalc_options_with_zone_granularity(struct thread_data *td);
int zbd_setup_files(struct thread_data *td);
void zbd_free_zone_info(struct fio_file *f);
void zbd_file_reset(struct thread_data *td, struct fio_file *f);
bool zbd_unaligned_write(int error_code);
void setup_zbd_zone_mode(struct thread_data *td, struct io_u *io_u);
enum fio_ddir zbd_adjust_ddir(struct thread_data *td, struct io_u *io_u,
			      enum fio_ddir ddir);
enum io_u_action zbd_adjust_block(struct thread_data *td, struct io_u *io_u);
char *zbd_write_status(const struct thread_stat *ts);
int zbd_do_io_u_trim(const struct thread_data *td, struct io_u *io_u);

static inline void zbd_close_file(struct fio_file *f)
{
	if (f->zbd_info)
		zbd_free_zone_info(f);
}

static inline void zbd_queue_io_u(struct thread_data *td, struct io_u *io_u,
				  enum fio_q_status status)
{
	if (io_u->zbd_queue_io) {
		io_u->zbd_queue_io(td, io_u, status, io_u->error == 0);
		io_u->zbd_queue_io = NULL;
	}
}

static inline void zbd_put_io_u(struct thread_data *td, struct io_u *io_u)
{
	if (io_u->zbd_put_io) {
		io_u->zbd_put_io(td, io_u);
		io_u->zbd_queue_io = NULL;
		io_u->zbd_put_io = NULL;
	}
}

#endif /* FIO_ZBD_H */
Commit	Line	Data
	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	* @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	enum zbd_zone_type type:2;
	42	enum zbd_zone_cond cond:4;
	43	unsigned int has_wp:1;
	44	unsigned int open:1;
	45	unsigned int reset_zone:1;
	46	};
	47
	48	/**
	49	* zoned_block_device_info - zoned block device characteristics
	50	* @model: Device model.
	51	* @max_open_zones: global limit on the number of simultaneously opened
	52	* sequential write zones. A zero value means unlimited open zones,
	53	* and that open zones will not be tracked in the open_zones array.
	54	* @mutex: Protects the modifiable members in this structure (refcount and
	55	* num_open_zones).
	56	* @zone_size: size of a single zone in bytes.
	57	* @wp_valid_data_bytes: total size of data in zones with write pointers
	58	* @write_min_zone: Minimum zone index of all job's write ranges. Inclusive.
	59	* @write_max_zone: Maximum zone index of all job's write ranges. Exclusive.
	60	* @zone_size_log2: log2 of the zone size in bytes if it is a power of 2 or 0
	61	* if the zone size is not a power of 2.
	62	* @nr_zones: number of zones
	63	* @refcount: number of fio files that share this structure
	64	* @num_open_zones: number of open zones
	65	* @write_cnt: Number of writes since the latest zone reset triggered by
	66	* the zone_reset_frequency fio job parameter.
	67	* @open_zones: zone numbers of open zones
	68	* @zone_info: description of the individual zones
	69	*
	70	* Only devices for which all zones have the same size are supported.
	71	* Note: if the capacity is not a multiple of the zone size then the last zone
	72	* will be smaller than 'zone_size'.
	73	*/
	74	struct zoned_block_device_info {
	75	enum zbd_zoned_model model;
	76	uint32_t max_open_zones;
	77	pthread_mutex_t mutex;
	78	uint64_t zone_size;
	79	uint64_t wp_valid_data_bytes;
	80	uint32_t write_min_zone;
	81	uint32_t write_max_zone;
	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	int zbd_do_io_u_trim(const struct thread_data td, struct io_u io_u);
	103
	104	static inline void zbd_close_file(struct fio_file *f)
	105	{
	106	if (f->zbd_info)
	107	zbd_free_zone_info(f);
	108	}
	109
	110	static inline void zbd_queue_io_u(struct thread_data td, struct io_u io_u,
	111	enum fio_q_status status)
	112	{
	113	if (io_u->zbd_queue_io) {
	114	io_u->zbd_queue_io(td, io_u, status, io_u->error == 0);
	115	io_u->zbd_queue_io = NULL;
	116	}
	117	}
	118
	119	static inline void zbd_put_io_u(struct thread_data td, struct io_u io_u)
	120	{
	121	if (io_u->zbd_put_io) {
	122	io_u->zbd_put_io(td, io_u);
	123	io_u->zbd_queue_io = NULL;
	124	io_u->zbd_put_io = NULL;
	125	}
	126	}
	127
	128	#endif /* FIO_ZBD_H */