[fio.git] / ioengines.c

/*
 * The io parts of the fio tool, includes workers for sync and mmap'ed
 * io, as well as both posix and linux libaio support.
 *
 * sync io is implemented on top of aio.
 *
 * This is not really specific to fio, if the get_io_u/put_io_u and
 * structures was pulled into this as well it would be a perfectly
 * generic io engine that could be used for other projects.
 *
 */
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <dlfcn.h>
#include <assert.h>

#include "fio.h"

static LIST_HEAD(engine_list);

static int check_engine_ops(struct ioengine_ops *ops)
{
	if (ops->version != FIO_IOOPS_VERSION) {
		log_err("bad ioops version %d (want %d)\n", ops->version, FIO_IOOPS_VERSION);
		return 1;
	}

	if (!ops->queue) {
		log_err("%s: no queue handler\n", ops->name);
		return 1;
	}

	/*
	 * sync engines only need a ->queue()
	 */
	if (ops->flags & FIO_SYNCIO)
		return 0;
	
	if (!ops->event) {
		log_err("%s: no event handler\n", ops->name);
		return 1;
	}
	if (!ops->getevents) {
		log_err("%s: no getevents handler\n", ops->name);
		return 1;
	}
	if (!ops->queue) {
		log_err("%s: no queue handler\n", ops->name);
		return 1;
	}
		
	return 0;
}

void unregister_ioengine(struct ioengine_ops *ops)
{
	list_del(&ops->list);
	INIT_LIST_HEAD(&ops->list);
}

void register_ioengine(struct ioengine_ops *ops)
{
	INIT_LIST_HEAD(&ops->list);
	list_add_tail(&ops->list, &engine_list);
}

static struct ioengine_ops *find_ioengine(const char *name)
{
	struct ioengine_ops *ops;
	struct list_head *entry;

	list_for_each(entry, &engine_list) {
		ops = list_entry(entry, struct ioengine_ops, list);
		if (!strcmp(name, ops->name))
			return ops;
	}

	return NULL;
}

static struct ioengine_ops *dlopen_ioengine(struct thread_data *td,
					    const char *engine_lib)
{
	struct ioengine_ops *ops;
	void *dlhandle;

	dlerror();
	dlhandle = dlopen(engine_lib, RTLD_LAZY);
	if (!dlhandle) {
		td_vmsg(td, -1, dlerror(), "dlopen");
		return NULL;
	}

	/*
	 * Unlike the included modules, external engines should have a
	 * non-static ioengine structure that we can reference.
	 */
	ops = dlsym(dlhandle, "ioengine");
	if (!ops) {
		td_vmsg(td, -1, dlerror(), "dlsym");
		dlclose(dlhandle);
		return NULL;
	}

	ops->dlhandle = dlhandle;
	return ops;
}

struct ioengine_ops *load_ioengine(struct thread_data *td, const char *name)
{
	struct ioengine_ops *ops, *ret;
	char engine[16];

	strncpy(engine, name, sizeof(engine) - 1);

	/*
	 * linux libaio has alias names, so convert to what we want
	 */
	if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3))
		strcpy(engine, "libaio");

	ops = find_ioengine(engine);
	if (!ops)
		ops = dlopen_ioengine(td, name);

	if (!ops) {
		log_err("fio: engine %s not loadable\n", name);
		return NULL;
	}

	/*
	 * Check that the required methods are there.
	 */
	if (check_engine_ops(ops))
		return NULL;

	ret = malloc(sizeof(*ret));
	memcpy(ret, ops, sizeof(*ret));
	ret->data = NULL;

	return ret;
}

void close_ioengine(struct thread_data *td)
{
	if (td->io_ops->cleanup)
		td->io_ops->cleanup(td);

	if (td->io_ops->dlhandle)
		dlclose(td->io_ops->dlhandle);

	free(td->io_ops);
	td->io_ops = NULL;
}

int td_io_prep(struct thread_data *td, struct io_u *io_u)
{
	if (td->io_ops->prep)
		return td->io_ops->prep(td, io_u);

	return 0;
}

int td_io_getevents(struct thread_data *td, int min, int max,
		    struct timespec *t)
{
	if (min > 0 && td->io_ops->commit) {
		int r = td->io_ops->commit(td);

		if (r < 0)
			return r;
	}
	if (td->io_ops->getevents)
		return td->io_ops->getevents(td, min, max, t);

	return 0;
}

int td_io_queue(struct thread_data *td, struct io_u *io_u)
{
	int ret;

	assert((io_u->flags & IO_U_F_FLIGHT) == 0);
	io_u->flags |= IO_U_F_FLIGHT;

	assert(io_u->file->flags & FIO_FILE_OPEN);

	io_u->error = 0;
	io_u->resid = 0;

	if (td->io_ops->flags & FIO_SYNCIO) {
		fio_gettime(&io_u->issue_time, NULL);

		/*
		 * for a sync engine, set the timeout upfront
		 */
		if (mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
			io_u_set_timeout(td);
	}

	if (io_u->ddir != DDIR_SYNC)
		td->io_issues[io_u->ddir]++;

	io_u_mark_depth(td, io_u);

	ret = td->io_ops->queue(td, io_u);

	if (ret == FIO_Q_QUEUED || ret == FIO_Q_COMPLETED)
		get_file(io_u->file);

	if (ret == FIO_Q_QUEUED) {
		int r;

		td->io_u_queued++;
		if (td->io_u_queued > td->o.iodepth_batch) {
			r = td_io_commit(td);
			if (r < 0)
				return r;
		}
	}

	if ((td->io_ops->flags & FIO_SYNCIO) == 0) {
		fio_gettime(&io_u->issue_time, NULL);

		/*
		 * async engine, set the timeout here
		 */
		if (ret == FIO_Q_QUEUED &&
		    mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
			io_u_set_timeout(td);
	}

	return ret;
}

int td_io_init(struct thread_data *td)
{
	int ret = 0;

	if (td->io_ops->init) {
		ret = td->io_ops->init(td);
		if (ret && td->o.iodepth > 1)
			log_err("fio: io engine init failed. Perhaps try reducing io dpeth?\n");
	}

	return ret;
}

int td_io_commit(struct thread_data *td)
{
	if (!td->cur_depth)
		return 0;

	td->io_u_queued = 0;
	if (td->io_ops->commit)
		return td->io_ops->commit(td);

	return 0;
}

int td_io_open_file(struct thread_data *td, struct fio_file *f)
{
	if (td->io_ops->open_file(td, f)) {
		if (td->error == EINVAL && td->o.odirect)
			log_err("fio: destination does not support O_DIRECT\n");
		if (td->error == EMFILE)
			log_err("fio: try reducing/setting openfiles (failed at %u of %u)\n", td->nr_open_files, td->o.nr_files);

		return 1;
	}

	f->last_free_lookup = 0;
	f->last_completed_pos = 0;
	f->last_pos = 0;
	f->flags |= FIO_FILE_OPEN;
	f->flags &= ~FIO_FILE_CLOSING;

	if (td->io_ops->flags & FIO_DISKLESSIO)
		goto done;

	if (td->o.invalidate_cache && file_invalidate_cache(td, f))
		goto err;

	if (td->o.fadvise_hint) {
		int flags;

		if (td_random(td))
			flags = POSIX_FADV_RANDOM;
		else
			flags = POSIX_FADV_SEQUENTIAL;

		if (fadvise(f->fd, f->file_offset, f->io_size, flags) < 0) {
			td_verror(td, errno, "fadvise");
			goto err;
		}
	}

	if (f->file_map)
		memset(f->file_map, 0, f->num_maps * sizeof(long));

done:
	td->nr_open_files++;
	get_file(f);
	return 0;
err:
	if (td->io_ops->close_file)
		td->io_ops->close_file(td, f);
	return 1;
}

void td_io_close_file(struct thread_data *td, struct fio_file *f)
{
	/*
	 * mark as closing, do real close when last io on it has completed
	 */
	f->flags |= FIO_FILE_CLOSING;

	put_file(td, f);
}
Commit	Line	Data
ebac4655 JA	1	/*
	2	* The io parts of the fio tool, includes workers for sync and mmap'ed
	3	* io, as well as both posix and linux libaio support.
	4	*
	5	* sync io is implemented on top of aio.
	6	*
	7	* This is not really specific to fio, if the get_io_u/put_io_u and
	8	* structures was pulled into this as well it would be a perfectly
	9	* generic io engine that could be used for other projects.
	10	*
	11	*/
	12	#include <stdio.h>
	13	#include <stdlib.h>
	14	#include <unistd.h>
5c4e1dbc	15	#include <string.h>
2866c82d	16	#include <dlfcn.h>
0c6e7517	17	#include <assert.h>
8c16d840	18
ebac4655	19	#include "fio.h"
ebac4655	20
5f350952 JA	21	static LIST_HEAD(engine_list);
5f350952 JA	22
8c16d840 JA	23	static int check_engine_ops(struct ioengine_ops *ops)
8c16d840 JA	24	{
5f350952 JA	25	if (ops->version != FIO_IOOPS_VERSION) {
	26	log_err("bad ioops version %d (want %d)\n", ops->version, FIO_IOOPS_VERSION);
	27	return 1;
	28	}
	29
36167d82 JA	30	if (!ops->queue) {
	31	log_err("%s: no queue handler\n", ops->name);
	32	return 1;
	33	}
	34
	35	/*
	36	* sync engines only need a ->queue()
	37	*/
	38	if (ops->flags & FIO_SYNCIO)
	39	return 0;
	40
8c16d840	41	if (!ops->event) {
36167d82	42	log_err("%s: no event handler\n", ops->name);
8c16d840 JA	43	return 1;
	44	}
	45	if (!ops->getevents) {
36167d82	46	log_err("%s: no getevents handler\n", ops->name);
8c16d840 JA	47	return 1;
	48	}
	49	if (!ops->queue) {
36167d82	50	log_err("%s: no queue handler\n", ops->name);
8c16d840 JA	51	return 1;
	52	}
	53
	54	return 0;
	55	}
	56
5f350952	57	void unregister_ioengine(struct ioengine_ops *ops)
ebac4655	58	{
5f350952 JA	59	list_del(&ops->list);
	60	INIT_LIST_HEAD(&ops->list);
	61	}
	62
b2fdda43	63	void register_ioengine(struct ioengine_ops *ops)
5f350952	64	{
5f350952 JA	65	INIT_LIST_HEAD(&ops->list);
5f350952 JA	66	list_add_tail(&ops->list, &engine_list);
5f350952 JA	67	}
	68
	69	static struct ioengine_ops find_ioengine(const char name)
	70	{
	71	struct ioengine_ops *ops;
	72	struct list_head *entry;
ebac4655	73
5f350952 JA	74	list_for_each(entry, &engine_list) {
5f350952 JA	75	ops = list_entry(entry, struct ioengine_ops, list);
bc5b77a8	76	if (!strcmp(name, ops->name))
5f350952 JA	77	return ops;
	78	}
	79
	80	return NULL;
	81	}
	82
	83	static struct ioengine_ops dlopen_ioengine(struct thread_data td,
	84	const char *engine_lib)
	85	{
	86	struct ioengine_ops *ops;
	87	void *dlhandle;
	88
2866c82d JA	89	dlerror();
2866c82d JA	90	dlhandle = dlopen(engine_lib, RTLD_LAZY);
d4dbaaa8	91	if (!dlhandle) {
e1161c32	92	td_vmsg(td, -1, dlerror(), "dlopen");
d4dbaaa8 JA	93	return NULL;
d4dbaaa8 JA	94	}
8756e4d4	95
da51c050 JA	96	/*
	97	* Unlike the included modules, external engines should have a
	98	* non-static ioengine structure that we can reference.
	99	*/
2866c82d	100	ops = dlsym(dlhandle, "ioengine");
d4dbaaa8	101	if (!ops) {
e1161c32	102	td_vmsg(td, -1, dlerror(), "dlsym");
d4dbaaa8 JA	103	dlclose(dlhandle);
	104	return NULL;
	105	}
8756e4d4	106
5f350952 JA	107	ops->dlhandle = dlhandle;
	108	return ops;
	109	}
	110
	111	struct ioengine_ops load_ioengine(struct thread_data td, const char *name)
	112	{
	113	struct ioengine_ops ops, ret;
	114	char engine[16];
	115
	116	strncpy(engine, name, sizeof(engine) - 1);
	117
	118	/*
	119	* linux libaio has alias names, so convert to what we want
	120	*/
	121	if (!strncmp(engine, "linuxaio", 8) \|\| !strncmp(engine, "aio", 3))
	122	strcpy(engine, "libaio");
	123
	124	ops = find_ioengine(engine);
	125	if (!ops)
	126	ops = dlopen_ioengine(td, name);
	127
	128	if (!ops) {
	129	log_err("fio: engine %s not loadable\n", name);
b902ceb5 JA	130	return NULL;
	131	}
	132
8c16d840 JA	133	/*
	134	* Check that the required methods are there.
	135	*/
5f350952	136	if (check_engine_ops(ops))
8c16d840	137	return NULL;
8c16d840	138
84585003 JA	139	ret = malloc(sizeof(*ret));
	140	memcpy(ret, ops, sizeof(*ret));
	141	ret->data = NULL;
84585003 JA	142
84585003 JA	143	return ret;
8756e4d4 JA	144	}
8756e4d4 JA	145
2866c82d	146	void close_ioengine(struct thread_data *td)
8756e4d4	147	{
2866c82d JA	148	if (td->io_ops->cleanup)
2866c82d JA	149	td->io_ops->cleanup(td);
b990b5c0	150
5f350952 JA	151	if (td->io_ops->dlhandle)
	152	dlclose(td->io_ops->dlhandle);
	153
84585003 JA	154	free(td->io_ops);
84585003 JA	155	td->io_ops = NULL;
b990b5c0	156	}
10ba535a JA	157
	158	int td_io_prep(struct thread_data td, struct io_u io_u)
	159	{
36167d82 JA	160	if (td->io_ops->prep)
36167d82 JA	161	return td->io_ops->prep(td, io_u);
10ba535a JA	162
	163	return 0;
	164	}
	165
10ba535a JA	166	int td_io_getevents(struct thread_data *td, int min, int max,
	167	struct timespec *t)
	168	{
face81b2 JA	169	if (min > 0 && td->io_ops->commit) {
	170	int r = td->io_ops->commit(td);
	171
	172	if (r < 0)
	173	return r;
	174	}
36167d82 JA	175	if (td->io_ops->getevents)
	176	return td->io_ops->getevents(td, min, max, t);
	177
	178	return 0;
10ba535a JA	179	}
	180
	181	int td_io_queue(struct thread_data td, struct io_u io_u)
	182	{
7e77dd02 JA	183	int ret;
7e77dd02 JA	184
0c6e7517 JA	185	assert((io_u->flags & IO_U_F_FLIGHT) == 0);
	186	io_u->flags \|= IO_U_F_FLIGHT;
	187
3d7b485f JA	188	assert(io_u->file->flags & FIO_FILE_OPEN);
3d7b485f JA	189
11786802 JA	190	io_u->error = 0;
	191	io_u->resid = 0;
	192
433afcb4	193	if (td->io_ops->flags & FIO_SYNCIO) {
5aeb77df	194	fio_gettime(&io_u->issue_time, NULL);
10ba535a	195
433afcb4 JA	196	/*
	197	* for a sync engine, set the timeout upfront
	198	*/
	199	if (mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
	200	io_u_set_timeout(td);
	201	}
	202
755200a3 JA	203	if (io_u->ddir != DDIR_SYNC)
	204	td->io_issues[io_u->ddir]++;
	205
b3605062 JA	206	io_u_mark_depth(td, io_u);
b3605062 JA	207
7e77dd02	208	ret = td->io_ops->queue(td, io_u);
5aeb77df	209
0ad920e7 JA	210	if (ret == FIO_Q_QUEUED \|\| ret == FIO_Q_COMPLETED)
	211	get_file(io_u->file);
	212
eb7c8ae2 JA	213	if (ret == FIO_Q_QUEUED) {
	214	int r;
	215
cb5ab512	216	td->io_u_queued++;
2dc1bbeb	217	if (td->io_u_queued > td->o.iodepth_batch) {
eb7c8ae2 JA	218	r = td_io_commit(td);
	219	if (r < 0)
	220	return r;
	221	}
	222	}
cb5ab512	223
433afcb4	224	if ((td->io_ops->flags & FIO_SYNCIO) == 0) {
5aeb77df JA	225	fio_gettime(&io_u->issue_time, NULL);
5aeb77df JA	226
433afcb4 JA	227	/*
	228	* async engine, set the timeout here
	229	*/
	230	if (ret == FIO_Q_QUEUED &&
	231	mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
	232	io_u_set_timeout(td);
	233	}
	234
7e77dd02	235	return ret;
10ba535a	236	}
8c16d840 JA	237
	238	int td_io_init(struct thread_data *td)
	239	{
eeb12160	240	int ret = 0;
8c16d840	241
eeb12160 JA	242	if (td->io_ops->init) {
	243	ret = td->io_ops->init(td);
	244	if (ret && td->o.iodepth > 1)
	245	log_err("fio: io engine init failed. Perhaps try reducing io dpeth?\n");
	246	}
	247
	248	return ret;
8c16d840	249	}
755200a3 JA	250
	251	int td_io_commit(struct thread_data *td)
	252	{
e1161c32 JA	253	if (!td->cur_depth)
e1161c32 JA	254	return 0;
cb5ab512 JA	255
cb5ab512 JA	256	td->io_u_queued = 0;
755200a3 JA	257	if (td->io_ops->commit)
	258	return td->io_ops->commit(td);
	259
	260	return 0;
	261	}
b5af8293 JA	262
	263	int td_io_open_file(struct thread_data td, struct fio_file f)
	264	{
413d6693 JA	265	if (td->io_ops->open_file(td, f)) {
	266	if (td->error == EINVAL && td->o.odirect)
	267	log_err("fio: destination does not support O_DIRECT\n");
	268	if (td->error == EMFILE)
	269	log_err("fio: try reducing/setting openfiles (failed at %u of %u)\n", td->nr_open_files, td->o.nr_files);
	270
	271	return 1;
	272	}
	273
	274	f->last_free_lookup = 0;
	275	f->last_completed_pos = 0;
	276	f->last_pos = 0;
	277	f->flags \|= FIO_FILE_OPEN;
	278	f->flags &= ~FIO_FILE_CLOSING;
	279
	280	if (td->io_ops->flags & FIO_DISKLESSIO)
	281	goto done;
	282
	283	if (td->o.invalidate_cache && file_invalidate_cache(td, f))
	284	goto err;
	285
	286	if (td->o.fadvise_hint) {
	287	int flags;
	288
	289	if (td_random(td))
	290	flags = POSIX_FADV_RANDOM;
	291	else
	292	flags = POSIX_FADV_SEQUENTIAL;
	293
	294	if (fadvise(f->fd, f->file_offset, f->io_size, flags) < 0) {
	295	td_verror(td, errno, "fadvise");
	296	goto err;
	297	}
7bb48f84	298	}
a978ba68	299
413d6693 JA	300	if (f->file_map)
413d6693 JA	301	memset(f->file_map, 0, f->num_maps * sizeof(long));
a978ba68	302
413d6693 JA	303	done:
	304	td->nr_open_files++;
	305	get_file(f);
	306	return 0;
	307	err:
b284075a JA	308	if (td->io_ops->close_file)
b284075a JA	309	td->io_ops->close_file(td, f);
7bb48f84	310	return 1;
b5af8293 JA	311	}
	312
	313	void td_io_close_file(struct thread_data td, struct fio_file f)
	314	{
0ad920e7 JA	315	/*
	316	* mark as closing, do real close when last io on it has completed
	317	*/
	318	f->flags \|= FIO_FILE_CLOSING;
	319
	320	put_file(td, f);
b5af8293	321	}