[fio.git] / engines / libaio.c

/*
 * libaio engine
 *
 * IO engine using the Linux native aio interface.
 *
 */
#include <stdlib.h>
#include <unistd.h>
#include <errno.h>
#include <libaio.h>

#include "../fio.h"
#include "../lib/pow2.h"
#include "../optgroup.h"

static int fio_libaio_commit(struct thread_data *td);

struct libaio_data {
	io_context_t aio_ctx;
	struct io_event *aio_events;
	struct iocb **iocbs;
	struct io_u **io_us;

	/*
	 * Basic ring buffer. 'head' is incremented in _queue(), and
	 * 'tail' is incremented in _commit(). We keep 'queued' so
	 * that we know if the ring is full or empty, when
	 * 'head' == 'tail'. 'entries' is the ring size, and
	 * 'is_pow2' is just an optimization to use AND instead of
	 * modulus to get the remainder on ring increment.
	 */
	int is_pow2;
	unsigned int entries;
	unsigned int queued;
	unsigned int head;
	unsigned int tail;
};

struct libaio_options {
	void *pad;
	unsigned int userspace_reap;
};

static struct fio_option options[] = {
	{
		.name	= "userspace_reap",
		.lname	= "Libaio userspace reaping",
		.type	= FIO_OPT_STR_SET,
		.off1	= offsetof(struct libaio_options, userspace_reap),
		.help	= "Use alternative user-space reap implementation",
		.category = FIO_OPT_C_ENGINE,
		.group	= FIO_OPT_G_LIBAIO,
	},
	{
		.name	= NULL,
	},
};

static inline void ring_inc(struct libaio_data *ld, unsigned int *val,
			    unsigned int add)
{
	if (ld->is_pow2)
		*val = (*val + add) & (ld->entries - 1);
	else
		*val = (*val + add) % ld->entries;
}

static int fio_libaio_prep(struct thread_data fio_unused *td, struct io_u *io_u)
{
	struct fio_file *f = io_u->file;

	if (io_u->ddir == DDIR_READ)
		io_prep_pread(&io_u->iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
	else if (io_u->ddir == DDIR_WRITE)
		io_prep_pwrite(&io_u->iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
	else if (ddir_sync(io_u->ddir))
		io_prep_fsync(&io_u->iocb, f->fd);

	return 0;
}

static struct io_u *fio_libaio_event(struct thread_data *td, int event)
{
	struct libaio_data *ld = td->io_ops_data;
	struct io_event *ev;
	struct io_u *io_u;

	ev = ld->aio_events + event;
	io_u = container_of(ev->obj, struct io_u, iocb);

	if (ev->res != io_u->xfer_buflen) {
		if (ev->res > io_u->xfer_buflen)
			io_u->error = -ev->res;
		else
			io_u->resid = io_u->xfer_buflen - ev->res;
	} else
		io_u->error = 0;

	return io_u;
}

struct aio_ring {
	unsigned id;		 /** kernel internal index number */
	unsigned nr;		 /** number of io_events */
	unsigned head;
	unsigned tail;

	unsigned magic;
	unsigned compat_features;
	unsigned incompat_features;
	unsigned header_length;	/** size of aio_ring */

	struct io_event events[0];
};

#define AIO_RING_MAGIC	0xa10a10a1

static int user_io_getevents(io_context_t aio_ctx, unsigned int max,
			     struct io_event *events)
{
	long i = 0;
	unsigned head;
	struct aio_ring *ring = (struct aio_ring*) aio_ctx;

	while (i < max) {
		head = ring->head;

		if (head == ring->tail) {
			/* There are no more completions */
			break;
		} else {
			/* There is another completion to reap */
			events[i] = ring->events[head];
			read_barrier();
			ring->head = (head + 1) % ring->nr;
			i++;
		}
	}

	return i;
}

static int fio_libaio_getevents(struct thread_data *td, unsigned int min,
				unsigned int max, const struct timespec *t)
{
	struct libaio_data *ld = td->io_ops_data;
	struct libaio_options *o = td->eo;
	unsigned actual_min = td->o.iodepth_batch_complete_min == 0 ? 0 : min;
	struct timespec __lt, *lt = NULL;
	int r, events = 0;

	if (t) {
		__lt = *t;
		lt = &__lt;
	}

	do {
		if (o->userspace_reap == 1
		    && actual_min == 0
		    && ((struct aio_ring *)(ld->aio_ctx))->magic
				== AIO_RING_MAGIC) {
			r = user_io_getevents(ld->aio_ctx, max,
				ld->aio_events + events);
		} else {
			r = io_getevents(ld->aio_ctx, actual_min,
				max, ld->aio_events + events, lt);
		}
		if (r > 0)
			events += r;
		else if ((min && r == 0) || r == -EAGAIN) {
			fio_libaio_commit(td);
			if (actual_min)
				usleep(10);
		} else if (r != -EINTR)
			break;
	} while (events < min);

	return r < 0 ? r : events;
}

static enum fio_q_status fio_libaio_queue(struct thread_data *td,
					  struct io_u *io_u)
{
	struct libaio_data *ld = td->io_ops_data;

	fio_ro_check(td, io_u);

	if (ld->queued == td->o.iodepth)
		return FIO_Q_BUSY;

	/*
	 * fsync is tricky, since it can fail and we need to do it
	 * serialized with other io. the reason is that linux doesn't
	 * support aio fsync yet. So return busy for the case where we
	 * have pending io, to let fio complete those first.
	 */
	if (ddir_sync(io_u->ddir)) {
		if (ld->queued)
			return FIO_Q_BUSY;

		do_io_u_sync(td, io_u);
		return FIO_Q_COMPLETED;
	}

	if (io_u->ddir == DDIR_TRIM) {
		if (ld->queued)
			return FIO_Q_BUSY;

		do_io_u_trim(td, io_u);
		io_u_mark_submit(td, 1);
		io_u_mark_complete(td, 1);
		return FIO_Q_COMPLETED;
	}

	ld->iocbs[ld->head] = &io_u->iocb;
	ld->io_us[ld->head] = io_u;
	ring_inc(ld, &ld->head, 1);
	ld->queued++;
	return FIO_Q_QUEUED;
}

static void fio_libaio_queued(struct thread_data *td, struct io_u **io_us,
			      unsigned int nr)
{
	struct timespec now;
	unsigned int i;

	if (!fio_fill_issue_time(td))
		return;

	fio_gettime(&now, NULL);

	for (i = 0; i < nr; i++) {
		struct io_u *io_u = io_us[i];

		memcpy(&io_u->issue_time, &now, sizeof(now));
		io_u_queued(td, io_u);
	}
}

static int fio_libaio_commit(struct thread_data *td)
{
	struct libaio_data *ld = td->io_ops_data;
	struct iocb **iocbs;
	struct io_u **io_us;
	struct timespec ts;
	int ret, wait_start = 0;

	if (!ld->queued)
		return 0;

	do {
		long nr = ld->queued;

		nr = min((unsigned int) nr, ld->entries - ld->tail);
		io_us = ld->io_us + ld->tail;
		iocbs = ld->iocbs + ld->tail;

		ret = io_submit(ld->aio_ctx, nr, iocbs);
		if (ret > 0) {
			fio_libaio_queued(td, io_us, ret);
			io_u_mark_submit(td, ret);

			ld->queued -= ret;
			ring_inc(ld, &ld->tail, ret);
			ret = 0;
			wait_start = 0;
		} else if (ret == -EINTR || !ret) {
			if (!ret)
				io_u_mark_submit(td, ret);
			wait_start = 0;
			continue;
		} else if (ret == -EAGAIN) {
			/*
			 * If we get EAGAIN, we should break out without
			 * error and let the upper layer reap some
			 * events for us. If we have no queued IO, we
			 * must loop here. If we loop for more than 30s,
			 * just error out, something must be buggy in the
			 * IO path.
			 */
			if (ld->queued) {
				ret = 0;
				break;
			}
			if (!wait_start) {
				fio_gettime(&ts, NULL);
				wait_start = 1;
			} else if (mtime_since_now(&ts) > 30000) {
				log_err("fio: aio appears to be stalled, giving up\n");
				break;
			}
			usleep(1);
			continue;
		} else if (ret == -ENOMEM) {
			/*
			 * If we get -ENOMEM, reap events if we can. If
			 * we cannot, treat it as a fatal event since there's
			 * nothing we can do about it.
			 */
			if (ld->queued)
				ret = 0;
			break;
		} else
			break;
	} while (ld->queued);

	return ret;
}

static int fio_libaio_cancel(struct thread_data *td, struct io_u *io_u)
{
	struct libaio_data *ld = td->io_ops_data;

	return io_cancel(ld->aio_ctx, &io_u->iocb, ld->aio_events);
}

static void fio_libaio_cleanup(struct thread_data *td)
{
	struct libaio_data *ld = td->io_ops_data;

	if (ld) {
		/*
		 * Work-around to avoid huge RCU stalls at exit time. If we
		 * don't do this here, then it'll be torn down by exit_aio().
		 * But for that case we can parallellize the freeing, thus
		 * speeding it up a lot.
		 */
		if (!(td->flags & TD_F_CHILD))
			io_destroy(ld->aio_ctx);
		free(ld->aio_events);
		free(ld->iocbs);
		free(ld->io_us);
		free(ld);
	}
}

static int fio_libaio_init(struct thread_data *td)
{
	struct libaio_options *o = td->eo;
	struct libaio_data *ld;
	int err = 0;

	ld = calloc(1, sizeof(*ld));

	/*
	 * First try passing in 0 for queue depth, since we don't
	 * care about the user ring. If that fails, the kernel is too old
	 * and we need the right depth.
	 */
	if (!o->userspace_reap)
		err = io_queue_init(INT_MAX, &ld->aio_ctx);
	if (o->userspace_reap || err == -EINVAL)
		err = io_queue_init(td->o.iodepth, &ld->aio_ctx);
	if (err) {
		td_verror(td, -err, "io_queue_init");
		log_err("fio: check /proc/sys/fs/aio-max-nr\n");
		free(ld);
		return 1;
	}

	ld->entries = td->o.iodepth;
	ld->is_pow2 = is_power_of_2(ld->entries);
	ld->aio_events = calloc(ld->entries, sizeof(struct io_event));
	ld->iocbs = calloc(ld->entries, sizeof(struct iocb *));
	ld->io_us = calloc(ld->entries, sizeof(struct io_u *));

	td->io_ops_data = ld;
	return 0;
}

static struct ioengine_ops ioengine = {
	.name			= "libaio",
	.version		= FIO_IOOPS_VERSION,
	.init			= fio_libaio_init,
	.prep			= fio_libaio_prep,
	.queue			= fio_libaio_queue,
	.commit			= fio_libaio_commit,
	.cancel			= fio_libaio_cancel,
	.getevents		= fio_libaio_getevents,
	.event			= fio_libaio_event,
	.cleanup		= fio_libaio_cleanup,
	.open_file		= generic_open_file,
	.close_file		= generic_close_file,
	.get_file_size		= generic_get_file_size,
	.options		= options,
	.option_struct_size	= sizeof(struct libaio_options),
};

static void fio_init fio_libaio_register(void)
{
	register_ioengine(&ioengine);
}

static void fio_exit fio_libaio_unregister(void)
{
	unregister_ioengine(&ioengine);
}
Commit	Line	Data
	1	/*
	2	* libaio engine
	3	*
	4	* IO engine using the Linux native aio interface.
	5	*
	6	*/
	7	#include <stdlib.h>
	8	#include <unistd.h>
	9	#include <errno.h>
	10	#include <libaio.h>
	11
	12	#include "../fio.h"
	13	#include "../lib/pow2.h"
	14	#include "../optgroup.h"
	15
	16	static int fio_libaio_commit(struct thread_data *td);
	17
	18	struct libaio_data {
	19	io_context_t aio_ctx;
	20	struct io_event *aio_events;
	21	struct iocb **iocbs;
	22	struct io_u **io_us;
	23
	24	/*
	25	* Basic ring buffer. 'head' is incremented in _queue(), and
	26	* 'tail' is incremented in _commit(). We keep 'queued' so
	27	* that we know if the ring is full or empty, when
	28	* 'head' == 'tail'. 'entries' is the ring size, and
	29	* 'is_pow2' is just an optimization to use AND instead of
	30	* modulus to get the remainder on ring increment.
	31	*/
	32	int is_pow2;
	33	unsigned int entries;
	34	unsigned int queued;
	35	unsigned int head;
	36	unsigned int tail;
	37	};
	38
	39	struct libaio_options {
	40	void *pad;
	41	unsigned int userspace_reap;
	42	};
	43
	44	static struct fio_option options[] = {
	45	{
	46	.name = "userspace_reap",
	47	.lname = "Libaio userspace reaping",
	48	.type = FIO_OPT_STR_SET,
	49	.off1 = offsetof(struct libaio_options, userspace_reap),
	50	.help = "Use alternative user-space reap implementation",
	51	.category = FIO_OPT_C_ENGINE,
	52	.group = FIO_OPT_G_LIBAIO,
	53	},
	54	{
	55	.name = NULL,
	56	},
	57	};
	58
	59	static inline void ring_inc(struct libaio_data ld, unsigned int val,
	60	unsigned int add)
	61	{
	62	if (ld->is_pow2)
	63	val = (val + add) & (ld->entries - 1);
	64	else
	65	val = (val + add) % ld->entries;
	66	}
	67
	68	static int fio_libaio_prep(struct thread_data fio_unused td, struct io_u io_u)
	69	{
	70	struct fio_file *f = io_u->file;
	71
	72	if (io_u->ddir == DDIR_READ)
	73	io_prep_pread(&io_u->iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
	74	else if (io_u->ddir == DDIR_WRITE)
	75	io_prep_pwrite(&io_u->iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
	76	else if (ddir_sync(io_u->ddir))
	77	io_prep_fsync(&io_u->iocb, f->fd);
	78
	79	return 0;
	80	}
	81
	82	static struct io_u fio_libaio_event(struct thread_data td, int event)
	83	{
	84	struct libaio_data *ld = td->io_ops_data;
	85	struct io_event *ev;
	86	struct io_u *io_u;
	87
	88	ev = ld->aio_events + event;
	89	io_u = container_of(ev->obj, struct io_u, iocb);
	90
	91	if (ev->res != io_u->xfer_buflen) {
	92	if (ev->res > io_u->xfer_buflen)
	93	io_u->error = -ev->res;
	94	else
	95	io_u->resid = io_u->xfer_buflen - ev->res;
	96	} else
	97	io_u->error = 0;
	98
	99	return io_u;
	100	}
	101
	102	struct aio_ring {
	103	unsigned id; /** kernel internal index number */
	104	unsigned nr; /** number of io_events */
	105	unsigned head;
	106	unsigned tail;
	107
	108	unsigned magic;
	109	unsigned compat_features;
	110	unsigned incompat_features;
	111	unsigned header_length; /** size of aio_ring */
	112
	113	struct io_event events[0];
	114	};
	115
	116	#define AIO_RING_MAGIC 0xa10a10a1
	117
	118	static int user_io_getevents(io_context_t aio_ctx, unsigned int max,
	119	struct io_event *events)
	120	{
	121	long i = 0;
	122	unsigned head;
	123	struct aio_ring ring = (struct aio_ring) aio_ctx;
	124
	125	while (i < max) {
	126	head = ring->head;
	127
	128	if (head == ring->tail) {
	129	/* There are no more completions */
	130	break;
	131	} else {
	132	/* There is another completion to reap */
	133	events[i] = ring->events[head];
	134	read_barrier();
	135	ring->head = (head + 1) % ring->nr;
	136	i++;
	137	}
	138	}
	139
	140	return i;
	141	}
	142
	143	static int fio_libaio_getevents(struct thread_data *td, unsigned int min,
	144	unsigned int max, const struct timespec *t)
	145	{
	146	struct libaio_data *ld = td->io_ops_data;
	147	struct libaio_options *o = td->eo;
	148	unsigned actual_min = td->o.iodepth_batch_complete_min == 0 ? 0 : min;
	149	struct timespec __lt, *lt = NULL;
	150	int r, events = 0;
	151
	152	if (t) {
	153	__lt = *t;
	154	lt = &__lt;
	155	}
	156
	157	do {
	158	if (o->userspace_reap == 1
	159	&& actual_min == 0
	160	&& ((struct aio_ring *)(ld->aio_ctx))->magic
	161	== AIO_RING_MAGIC) {
	162	r = user_io_getevents(ld->aio_ctx, max,
	163	ld->aio_events + events);
	164	} else {
	165	r = io_getevents(ld->aio_ctx, actual_min,
	166	max, ld->aio_events + events, lt);
	167	}
	168	if (r > 0)
	169	events += r;
	170	else if ((min && r == 0) \|\| r == -EAGAIN) {
	171	fio_libaio_commit(td);
	172	if (actual_min)
	173	usleep(10);
	174	} else if (r != -EINTR)
	175	break;
	176	} while (events < min);
	177
	178	return r < 0 ? r : events;
	179	}
	180
	181	static enum fio_q_status fio_libaio_queue(struct thread_data *td,
	182	struct io_u *io_u)
	183	{
	184	struct libaio_data *ld = td->io_ops_data;
	185
	186	fio_ro_check(td, io_u);
	187
	188	if (ld->queued == td->o.iodepth)
	189	return FIO_Q_BUSY;
	190
	191	/*
	192	* fsync is tricky, since it can fail and we need to do it
	193	* serialized with other io. the reason is that linux doesn't
	194	* support aio fsync yet. So return busy for the case where we
	195	* have pending io, to let fio complete those first.
	196	*/
	197	if (ddir_sync(io_u->ddir)) {
	198	if (ld->queued)
	199	return FIO_Q_BUSY;
	200
	201	do_io_u_sync(td, io_u);
	202	return FIO_Q_COMPLETED;
	203	}
	204
	205	if (io_u->ddir == DDIR_TRIM) {
	206	if (ld->queued)
	207	return FIO_Q_BUSY;
	208
	209	do_io_u_trim(td, io_u);
	210	io_u_mark_submit(td, 1);
	211	io_u_mark_complete(td, 1);
	212	return FIO_Q_COMPLETED;
	213	}
	214
	215	ld->iocbs[ld->head] = &io_u->iocb;
	216	ld->io_us[ld->head] = io_u;
	217	ring_inc(ld, &ld->head, 1);
	218	ld->queued++;
	219	return FIO_Q_QUEUED;
	220	}
	221
	222	static void fio_libaio_queued(struct thread_data td, struct io_u *io_us,
	223	unsigned int nr)
	224	{
	225	struct timespec now;
	226	unsigned int i;
	227
	228	if (!fio_fill_issue_time(td))
	229	return;
	230
	231	fio_gettime(&now, NULL);
	232
	233	for (i = 0; i < nr; i++) {
	234	struct io_u *io_u = io_us[i];
	235
	236	memcpy(&io_u->issue_time, &now, sizeof(now));
	237	io_u_queued(td, io_u);
	238	}
	239	}
	240
	241	static int fio_libaio_commit(struct thread_data *td)
	242	{
	243	struct libaio_data *ld = td->io_ops_data;
	244	struct iocb **iocbs;
	245	struct io_u **io_us;
	246	struct timespec ts;
	247	int ret, wait_start = 0;
	248
	249	if (!ld->queued)
	250	return 0;
	251
	252	do {
	253	long nr = ld->queued;
	254
	255	nr = min((unsigned int) nr, ld->entries - ld->tail);
	256	io_us = ld->io_us + ld->tail;
	257	iocbs = ld->iocbs + ld->tail;
	258
	259	ret = io_submit(ld->aio_ctx, nr, iocbs);
	260	if (ret > 0) {
	261	fio_libaio_queued(td, io_us, ret);
	262	io_u_mark_submit(td, ret);
	263
	264	ld->queued -= ret;
	265	ring_inc(ld, &ld->tail, ret);
	266	ret = 0;
	267	wait_start = 0;
	268	} else if (ret == -EINTR \|\| !ret) {
	269	if (!ret)
	270	io_u_mark_submit(td, ret);
	271	wait_start = 0;
	272	continue;
	273	} else if (ret == -EAGAIN) {
	274	/*
	275	* If we get EAGAIN, we should break out without
	276	* error and let the upper layer reap some
	277	* events for us. If we have no queued IO, we
	278	* must loop here. If we loop for more than 30s,
	279	* just error out, something must be buggy in the
	280	* IO path.
	281	*/
	282	if (ld->queued) {
	283	ret = 0;
	284	break;
	285	}
	286	if (!wait_start) {
	287	fio_gettime(&ts, NULL);
	288	wait_start = 1;
	289	} else if (mtime_since_now(&ts) > 30000) {
	290	log_err("fio: aio appears to be stalled, giving up\n");
	291	break;
	292	}
	293	usleep(1);
	294	continue;
	295	} else if (ret == -ENOMEM) {
	296	/*
	297	* If we get -ENOMEM, reap events if we can. If
	298	* we cannot, treat it as a fatal event since there's
	299	* nothing we can do about it.
	300	*/
	301	if (ld->queued)
	302	ret = 0;
	303	break;
	304	} else
	305	break;
	306	} while (ld->queued);
	307
	308	return ret;
	309	}
	310
	311	static int fio_libaio_cancel(struct thread_data td, struct io_u io_u)
	312	{
	313	struct libaio_data *ld = td->io_ops_data;
	314
	315	return io_cancel(ld->aio_ctx, &io_u->iocb, ld->aio_events);
	316	}
	317
	318	static void fio_libaio_cleanup(struct thread_data *td)
	319	{
	320	struct libaio_data *ld = td->io_ops_data;
	321
	322	if (ld) {
	323	/*
	324	* Work-around to avoid huge RCU stalls at exit time. If we
	325	* don't do this here, then it'll be torn down by exit_aio().
	326	* But for that case we can parallellize the freeing, thus
	327	* speeding it up a lot.
	328	*/
	329	if (!(td->flags & TD_F_CHILD))
	330	io_destroy(ld->aio_ctx);
	331	free(ld->aio_events);
	332	free(ld->iocbs);
	333	free(ld->io_us);
	334	free(ld);
	335	}
	336	}
	337
	338	static int fio_libaio_init(struct thread_data *td)
	339	{
	340	struct libaio_options *o = td->eo;
	341	struct libaio_data *ld;
	342	int err = 0;
	343
	344	ld = calloc(1, sizeof(*ld));
	345
	346	/*
	347	* First try passing in 0 for queue depth, since we don't
	348	* care about the user ring. If that fails, the kernel is too old
	349	* and we need the right depth.
	350	*/
	351	if (!o->userspace_reap)
	352	err = io_queue_init(INT_MAX, &ld->aio_ctx);
	353	if (o->userspace_reap \|\| err == -EINVAL)
	354	err = io_queue_init(td->o.iodepth, &ld->aio_ctx);
	355	if (err) {
	356	td_verror(td, -err, "io_queue_init");
	357	log_err("fio: check /proc/sys/fs/aio-max-nr\n");
	358	free(ld);
	359	return 1;
	360	}
	361
	362	ld->entries = td->o.iodepth;
	363	ld->is_pow2 = is_power_of_2(ld->entries);
	364	ld->aio_events = calloc(ld->entries, sizeof(struct io_event));
	365	ld->iocbs = calloc(ld->entries, sizeof(struct iocb *));
	366	ld->io_us = calloc(ld->entries, sizeof(struct io_u *));
	367
	368	td->io_ops_data = ld;
	369	return 0;
	370	}
	371
	372	static struct ioengine_ops ioengine = {
	373	.name = "libaio",
	374	.version = FIO_IOOPS_VERSION,
	375	.init = fio_libaio_init,
	376	.prep = fio_libaio_prep,
	377	.queue = fio_libaio_queue,
	378	.commit = fio_libaio_commit,
	379	.cancel = fio_libaio_cancel,
	380	.getevents = fio_libaio_getevents,
	381	.event = fio_libaio_event,
	382	.cleanup = fio_libaio_cleanup,
	383	.open_file = generic_open_file,
	384	.close_file = generic_close_file,
	385	.get_file_size = generic_get_file_size,
	386	.options = options,
	387	.option_struct_size = sizeof(struct libaio_options),
	388	};
	389
	390	static void fio_init fio_libaio_register(void)
	391	{
	392	register_ioengine(&ioengine);
	393	}
	394
	395	static void fio_exit fio_libaio_unregister(void)
	396	{
	397	unregister_ioengine(&ioengine);
	398	}