[fio.git] / engines / mmap.c

/*
 * mmap engine
 *
 * IO engine that reads/writes from files by doing memcpy to/from
 * a memory mapped region of the file.
 *
 */
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <errno.h>
#include <sys/mman.h>

#include "../fio.h"

static int fio_mmapio_queue(struct thread_data *td, struct io_u *io_u)
{
	struct fio_file *f = io_u->file;
	unsigned long long real_off = io_u->offset - f->file_offset;

	fio_ro_check(td, io_u);

	if (io_u->ddir == DDIR_READ)
		memcpy(io_u->xfer_buf, f->mmap + real_off, io_u->xfer_buflen);
	else if (io_u->ddir == DDIR_WRITE)
		memcpy(f->mmap + real_off, io_u->xfer_buf, io_u->xfer_buflen);
	else if (io_u->ddir == DDIR_SYNC) {
		size_t len = (f->io_size + page_size - 1) & ~page_mask;

		if (msync(f->mmap, len, MS_SYNC)) {
			io_u->error = errno;
			td_verror(td, io_u->error, "msync");
		}
	}

	/*
	 * not really direct, but should drop the pages from the cache
	 */
	if (td->o.odirect && io_u->ddir != DDIR_SYNC) {
		size_t len = (io_u->xfer_buflen + page_size - 1) & ~page_mask;
		unsigned long long off = real_off & ~page_mask;

		if (msync(f->mmap + off, len, MS_SYNC) < 0) {
			io_u->error = errno;
			td_verror(td, io_u->error, "msync");
		}
		if (madvise(f->mmap + off, len,  MADV_DONTNEED) < 0) {
			io_u->error = errno;
			td_verror(td, io_u->error, "madvise");
		}
	}

	return FIO_Q_COMPLETED;
}

static int fio_mmapio_open(struct thread_data *td, struct fio_file *f)
{
	int ret, flags;

	ret = generic_open_file(td, f);
	if (ret)
		return ret;

	/*
	 * for size checkup, don't mmap anything.
	 */
	if (!f->io_size)
		return 0;

	if (td_rw(td))
		flags = PROT_READ | PROT_WRITE;
	else if (td_write(td)) {
		flags = PROT_WRITE;

		if (td->o.verify != VERIFY_NONE)
			flags |= PROT_READ;
	} else
		flags = PROT_READ;

	f->mmap = mmap(NULL, f->io_size, flags, MAP_SHARED, f->fd, f->file_offset);
	if (f->mmap == MAP_FAILED) {
		f->mmap = NULL;
		td_verror(td, errno, "mmap");
		goto err;
	}

	if (file_invalidate_cache(td, f))
		goto err;

	if (!td_random(td)) {
		if (madvise(f->mmap, f->io_size, MADV_SEQUENTIAL) < 0) {
			td_verror(td, errno, "madvise");
			goto err;
		}
	} else {
		if (madvise(f->mmap, f->io_size, MADV_RANDOM) < 0) {
			td_verror(td, errno, "madvise");
			goto err;
		}
	}

	return 0;

err:
	td->io_ops->close_file(td, f);
	return 1;
}

static int fio_mmapio_close(struct thread_data fio_unused *td,
			    struct fio_file *f)
{
	int ret = 0, ret2;

	if (f->mmap) {
		if (munmap(f->mmap, f->io_size) < 0)
			ret = errno;

		f->mmap = NULL;
	}

	ret2 = generic_close_file(td, f);
	if (!ret && ret2)
		ret = ret2;

	return ret;
}

static struct ioengine_ops ioengine = {
	.name		= "mmap",
	.version	= FIO_IOOPS_VERSION,
	.queue		= fio_mmapio_queue,
	.open_file	= fio_mmapio_open,
	.close_file	= fio_mmapio_close,
	.flags		= FIO_SYNCIO | FIO_NOEXTEND,
};

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

static void fio_exit fio_mmapio_unregister(void)
{
	unregister_ioengine(&ioengine);
}
Commit	Line	Data
2866c82d	1	/*
da751ca9 JA	2	* mmap engine
	3	*
	4	* IO engine that reads/writes from files by doing memcpy to/from
	5	* a memory mapped region of the file.
2866c82d JA	6	*
	7	*/
	8	#include <stdio.h>
	9	#include <stdlib.h>
	10	#include <unistd.h>
	11	#include <errno.h>
2866c82d	12	#include <sys/mman.h>
5f350952 JA	13
5f350952 JA	14	#include "../fio.h"
2866c82d	15
2866c82d JA	16	static int fio_mmapio_queue(struct thread_data td, struct io_u io_u)
2866c82d JA	17	{
53cdc686 JA	18	struct fio_file *f = io_u->file;
53cdc686 JA	19	unsigned long long real_off = io_u->offset - f->file_offset;
2866c82d	20
7101d9c2 JA	21	fio_ro_check(td, io_u);
7101d9c2 JA	22
2866c82d	23	if (io_u->ddir == DDIR_READ)
cec6b55d	24	memcpy(io_u->xfer_buf, f->mmap + real_off, io_u->xfer_buflen);
87dc1ab1	25	else if (io_u->ddir == DDIR_WRITE)
cec6b55d	26	memcpy(f->mmap + real_off, io_u->xfer_buf, io_u->xfer_buflen);
b907a5b5	27	else if (io_u->ddir == DDIR_SYNC) {
7bb48f84	28	size_t len = (f->io_size + page_size - 1) & ~page_mask;
cfc99db7 JA	29
cfc99db7 JA	30	if (msync(f->mmap, len, MS_SYNC)) {
b907a5b5	31	io_u->error = errno;
cfc99db7 JA	32	td_verror(td, io_u->error, "msync");
cfc99db7 JA	33	}
b907a5b5	34	}
2866c82d JA	35
	36	/*
	37	* not really direct, but should drop the pages from the cache
	38	*/
2dc1bbeb	39	if (td->o.odirect && io_u->ddir != DDIR_SYNC) {
cfc99db7 JA	40	size_t len = (io_u->xfer_buflen + page_size - 1) & ~page_mask;
	41	unsigned long long off = real_off & ~page_mask;
	42
	43	if (msync(f->mmap + off, len, MS_SYNC) < 0) {
2866c82d	44	io_u->error = errno;
cfc99db7 JA	45	td_verror(td, io_u->error, "msync");
	46	}
	47	if (madvise(f->mmap + off, len, MADV_DONTNEED) < 0) {
2866c82d	48	io_u->error = errno;
cfc99db7 JA	49	td_verror(td, io_u->error, "madvise");
cfc99db7 JA	50	}
2866c82d JA	51	}
2866c82d JA	52
36167d82	53	return FIO_Q_COMPLETED;
2866c82d JA	54	}
2866c82d JA	55
b5af8293 JA	56	static int fio_mmapio_open(struct thread_data td, struct fio_file f)
	57	{
	58	int ret, flags;
	59
	60	ret = generic_open_file(td, f);
	61	if (ret)
	62	return ret;
	63
c97d8369 JA	64	/*
	65	* for size checkup, don't mmap anything.
	66	*/
	67	if (!f->io_size)
	68	return 0;
	69
b5af8293 JA	70	if (td_rw(td))
	71	flags = PROT_READ \| PROT_WRITE;
	72	else if (td_write(td)) {
	73	flags = PROT_WRITE;
	74
2dc1bbeb	75	if (td->o.verify != VERIFY_NONE)
b5af8293 JA	76	flags \|= PROT_READ;
	77	} else
	78	flags = PROT_READ;
	79
7bb48f84	80	f->mmap = mmap(NULL, f->io_size, flags, MAP_SHARED, f->fd, f->file_offset);
b5af8293 JA	81	if (f->mmap == MAP_FAILED) {
	82	f->mmap = NULL;
	83	td_verror(td, errno, "mmap");
	84	goto err;
	85	}
	86
	87	if (file_invalidate_cache(td, f))
	88	goto err;
	89
	90	if (!td_random(td)) {
7bb48f84	91	if (madvise(f->mmap, f->io_size, MADV_SEQUENTIAL) < 0) {
b5af8293 JA	92	td_verror(td, errno, "madvise");
	93	goto err;
	94	}
	95	} else {
7bb48f84	96	if (madvise(f->mmap, f->io_size, MADV_RANDOM) < 0) {
b5af8293 JA	97	td_verror(td, errno, "madvise");
	98	goto err;
	99	}
	100	}
	101
	102	return 0;
	103
	104	err:
0263882a	105	td->io_ops->close_file(td, f);
b5af8293 JA	106	return 1;
	107	}
	108
6977bcd0 JA	109	static int fio_mmapio_close(struct thread_data fio_unused *td,
6977bcd0 JA	110	struct fio_file *f)
b5af8293	111	{
6977bcd0 JA	112	int ret = 0, ret2;
6977bcd0 JA	113
b5af8293	114	if (f->mmap) {
6977bcd0 JA	115	if (munmap(f->mmap, f->io_size) < 0)
	116	ret = errno;
	117
b5af8293 JA	118	f->mmap = NULL;
b5af8293 JA	119	}
6977bcd0 JA	120
	121	ret2 = generic_close_file(td, f);
	122	if (!ret && ret2)
	123	ret = ret2;
	124
	125	return ret;
b5af8293 JA	126	}
b5af8293 JA	127
5f350952	128	static struct ioengine_ops ioengine = {
2866c82d JA	129	.name = "mmap",
2866c82d JA	130	.version = FIO_IOOPS_VERSION,
2866c82d	131	.queue = fio_mmapio_queue,
b5af8293 JA	132	.open_file = fio_mmapio_open,
b5af8293 JA	133	.close_file = fio_mmapio_close,
0263882a	134	.flags = FIO_SYNCIO \| FIO_NOEXTEND,
2866c82d	135	};
5f350952 JA	136
	137	static void fio_init fio_mmapio_register(void)
	138	{
	139	register_ioengine(&ioengine);
	140	}
	141
	142	static void fio_exit fio_mmapio_unregister(void)
	143	{
	144	unregister_ioengine(&ioengine);
	145	}