[fio.git] / memory.c

/*
 * Memory helpers
 */
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <sys/shm.h>
#include <sys/mman.h>

#include "fio.h"

static void *pinned_mem;

void fio_unpin_memory(void)
{
	if (pinned_mem) {
		dprint(FD_MEM, "unpinning %llu bytes\n", mlock_size);
		if (munlock(pinned_mem, mlock_size) < 0)
			perror("munlock");
		munmap(pinned_mem, mlock_size);
		pinned_mem = NULL;
	}
}

int fio_pin_memory(void)
{
	unsigned long long phys_mem;

	if (!mlock_size)
		return 0;

	dprint(FD_MEM, "pinning %llu bytes\n", mlock_size);

	/*
	 * Don't allow mlock of more than real_mem-128MB
	 */
	phys_mem = os_phys_mem();
	if (phys_mem) {
		if ((mlock_size + 128 * 1024 * 1024) > phys_mem) {
			mlock_size = phys_mem - 128 * 1024 * 1024;
			log_info("fio: limiting mlocked memory to %lluMiB\n",
							mlock_size >> 20);
		}
	}

	pinned_mem = mmap(NULL, mlock_size, PROT_READ | PROT_WRITE,
				MAP_PRIVATE | OS_MAP_ANON, -1, 0);
	if (pinned_mem == MAP_FAILED) {
		perror("malloc locked mem");
		pinned_mem = NULL;
		return 1;
	}
	if (mlock(pinned_mem, mlock_size) < 0) {
		perror("mlock");
		munmap(pinned_mem, mlock_size);
		pinned_mem = NULL;
		return 1;
	}

	return 0;
}

static int alloc_mem_shm(struct thread_data *td)
{
	int flags = IPC_CREAT | SHM_R | SHM_W;

	if (td->o.mem_type == MEM_SHMHUGE)
		flags |= SHM_HUGETLB;

	td->shm_id = shmget(IPC_PRIVATE, td->orig_buffer_size, flags);
	dprint(FD_MEM, "shmget %zu, %d\n", td->orig_buffer_size, td->shm_id);
	if (td->shm_id < 0) {
		td_verror(td, errno, "shmget");
		if (geteuid() != 0 && errno == ENOMEM)
			log_err("fio: you may need to run this job as root\n");
		if (td->o.mem_type == MEM_SHMHUGE) {
			if (errno == EINVAL) {
				log_err("fio: check that you have free huge"
					" pages and that hugepage-size is"
					" correct.\n");
			} else if (errno == ENOSYS) {
				log_err("fio: your system does not appear to"
					" support huge pages.\n");
			} else if (errno == ENOMEM) {
				log_err("fio: no huge pages available, do you"
					" need to alocate some? See HOWTO.\n");
			}
		}

		return 1;
	}

	td->orig_buffer = shmat(td->shm_id, NULL, 0);
	dprint(FD_MEM, "shmat %d, %p\n", td->shm_id, td->orig_buffer);
	if (td->orig_buffer == (void *) -1) {
		td_verror(td, errno, "shmat");
		td->orig_buffer = NULL;
		return 1;
	}

	return 0;
}

static int alloc_mem_mmap(struct thread_data *td)
{
	int flags = MAP_PRIVATE;

	td->mmapfd = 1;

	if (td->mmapfile) {
		td->mmapfd = open(td->mmapfile, O_RDWR|O_CREAT, 0644);

		if (td->mmapfd < 0) {
			td_verror(td, errno, "open mmap file");
			td->orig_buffer = NULL;
			return 1;
		}
		if (ftruncate(td->mmapfd, td->orig_buffer_size) < 0) {
			td_verror(td, errno, "truncate mmap file");
			td->orig_buffer = NULL;
			return 1;
		}
	} else
		flags |= OS_MAP_ANON;

	td->orig_buffer = mmap(NULL, td->orig_buffer_size,
				PROT_READ | PROT_WRITE, flags, td->mmapfd, 0);
	dprint(FD_MEM, "mmap %zu/%d %p\n", td->orig_buffer_size, td->mmapfd,
							td->orig_buffer);
	if (td->orig_buffer == MAP_FAILED) {
		td_verror(td, errno, "mmap");
		td->orig_buffer = NULL;
		if (td->mmapfd) {
			close(td->mmapfd);
			unlink(td->mmapfile);
		}

		return 1;
	}

	return 0;
}

static int alloc_mem_malloc(struct thread_data *td)
{
	unsigned int bsize = td->orig_buffer_size;

	if (td->o.odirect)
		bsize += page_mask;

	td->orig_buffer = malloc(bsize);
	dprint(FD_MEM, "malloc %u %p\n", bsize, td->orig_buffer);
	if (td->orig_buffer)
		return 0;

	return 1;
}

/*
 * Setup the buffer area we need for io.
 */
int allocate_io_mem(struct thread_data *td)
{
	int ret = 0;

	if (td->io_ops->flags & FIO_NOIO)
		return 0;

	if (td->o.mem_type == MEM_MALLOC)
		ret = alloc_mem_malloc(td);
	else if (td->o.mem_type == MEM_SHM || td->o.mem_type == MEM_SHMHUGE)
		ret = alloc_mem_shm(td);
	else if (td->o.mem_type == MEM_MMAP || td->o.mem_type == MEM_MMAPHUGE)
		ret = alloc_mem_mmap(td);
	else {
		log_err("fio: bad mem type: %d\n", td->o.mem_type);
		ret = 1;
	}

	if (ret)
		td_verror(td, ENOMEM, "iomem allocation");

	return ret;
}

void free_io_mem(struct thread_data *td)
{
	if (td->o.mem_type == MEM_MALLOC) {
		dprint(FD_MEM, "free mem %p\n", td->orig_buffer);
		free(td->orig_buffer);
	} else if (td->o.mem_type == MEM_SHM || td->o.mem_type == MEM_SHMHUGE) {
		struct shmid_ds sbuf;

		dprint(FD_MEM, "shmdt/ctl %d %p\n", td->shm_id,
							td->orig_buffer);
		shmdt(td->orig_buffer);
		shmctl(td->shm_id, IPC_RMID, &sbuf);
	} else if (td->o.mem_type == MEM_MMAP ||
		   td->o.mem_type == MEM_MMAPHUGE) {
		dprint(FD_MEM, "munmap %zu %p\n", td->orig_buffer_size,
							td->orig_buffer);
		munmap(td->orig_buffer, td->orig_buffer_size);
		if (td->mmapfile) {
			close(td->mmapfd);
			unlink(td->mmapfile);
			free(td->mmapfile);
		}
	} else
		log_err("Bad memory type %u\n", td->o.mem_type);

	td->orig_buffer = NULL;
}
Commit	Line	Data
2f9ade3c JA	1	/*
	2	* Memory helpers
	3	*/
5921e80c JA	4	#include <sys/types.h>
	5	#include <sys/stat.h>
	6	#include <fcntl.h>
2f9ade3c JA	7	#include <unistd.h>
	8	#include <sys/shm.h>
	9	#include <sys/mman.h>
	10
	11	#include "fio.h"
2f9ade3c	12
2f9ade3c JA	13	static void *pinned_mem;
	14
	15	void fio_unpin_memory(void)
	16	{
	17	if (pinned_mem) {
ee56ad50	18	dprint(FD_MEM, "unpinning %llu bytes\n", mlock_size);
2f9ade3c JA	19	if (munlock(pinned_mem, mlock_size) < 0)
	20	perror("munlock");
	21	munmap(pinned_mem, mlock_size);
	22	pinned_mem = NULL;
	23	}
	24	}
	25
	26	int fio_pin_memory(void)
	27	{
	28	unsigned long long phys_mem;
	29
	30	if (!mlock_size)
	31	return 0;
	32
ee56ad50 JA	33	dprint(FD_MEM, "pinning %llu bytes\n", mlock_size);
ee56ad50 JA	34
2f9ade3c JA	35	/*
	36	* Don't allow mlock of more than real_mem-128MB
	37	*/
	38	phys_mem = os_phys_mem();
	39	if (phys_mem) {
	40	if ((mlock_size + 128 * 1024 * 1024) > phys_mem) {
	41	mlock_size = phys_mem - 128 * 1024 * 1024;
5ec10eaa JA	42	log_info("fio: limiting mlocked memory to %lluMiB\n",
5ec10eaa JA	43	mlock_size >> 20);
2f9ade3c JA	44	}
	45	}
	46
5ec10eaa	47	pinned_mem = mmap(NULL, mlock_size, PROT_READ \| PROT_WRITE,
a55820db	48	MAP_PRIVATE \| OS_MAP_ANON, -1, 0);
2f9ade3c JA	49	if (pinned_mem == MAP_FAILED) {
	50	perror("malloc locked mem");
	51	pinned_mem = NULL;
	52	return 1;
	53	}
	54	if (mlock(pinned_mem, mlock_size) < 0) {
	55	perror("mlock");
	56	munmap(pinned_mem, mlock_size);
	57	pinned_mem = NULL;
	58	return 1;
	59	}
	60
	61	return 0;
	62	}
	63
b6f9676e	64	static int alloc_mem_shm(struct thread_data *td)
2f9ade3c	65	{
b6f9676e JA	66	int flags = IPC_CREAT \| SHM_R \| SHM_W;
	67
	68	if (td->o.mem_type == MEM_SHMHUGE)
	69	flags \|= SHM_HUGETLB;
	70
	71	td->shm_id = shmget(IPC_PRIVATE, td->orig_buffer_size, flags);
ee56ad50	72	dprint(FD_MEM, "shmget %zu, %d\n", td->orig_buffer_size, td->shm_id);
b6f9676e JA	73	if (td->shm_id < 0) {
	74	td_verror(td, errno, "shmget");
	75	if (geteuid() != 0 && errno == ENOMEM)
	76	log_err("fio: you may need to run this job as root\n");
886b878a	77	if (td->o.mem_type == MEM_SHMHUGE) {
5ec10eaa JA	78	if (errno == EINVAL) {
	79	log_err("fio: check that you have free huge"
	80	" pages and that hugepage-size is"
	81	" correct.\n");
	82	} else if (errno == ENOSYS) {
	83	log_err("fio: your system does not appear to"
	84	" support huge pages.\n");
	85	} else if (errno == ENOMEM) {
	86	log_err("fio: no huge pages available, do you"
	87	" need to alocate some? See HOWTO.\n");
	88	}
d8602dd0	89	}
5ec10eaa	90
b6f9676e JA	91	return 1;
b6f9676e JA	92	}
2f9ade3c	93
b6f9676e	94	td->orig_buffer = shmat(td->shm_id, NULL, 0);
ee56ad50	95	dprint(FD_MEM, "shmat %d, %p\n", td->shm_id, td->orig_buffer);
b6f9676e JA	96	if (td->orig_buffer == (void *) -1) {
	97	td_verror(td, errno, "shmat");
	98	td->orig_buffer = NULL;
	99	return 1;
	100	}
	101
	102	return 0;
	103	}
	104
	105	static int alloc_mem_mmap(struct thread_data *td)
	106	{
	107	int flags = MAP_PRIVATE;
	108
a55820db	109	td->mmapfd = 1;
b6f9676e JA	110
	111	if (td->mmapfile) {
	112	td->mmapfd = open(td->mmapfile, O_RDWR\|O_CREAT, 0644);
	113
	114	if (td->mmapfd < 0) {
	115	td_verror(td, errno, "open mmap file");
2f9ade3c JA	116	td->orig_buffer = NULL;
	117	return 1;
	118	}
b6f9676e JA	119	if (ftruncate(td->mmapfd, td->orig_buffer_size) < 0) {
b6f9676e JA	120	td_verror(td, errno, "truncate mmap file");
2f9ade3c JA	121	td->orig_buffer = NULL;
	122	return 1;
	123	}
b6f9676e JA	124	} else
	125	flags \|= OS_MAP_ANON;
	126
5ec10eaa JA	127	td->orig_buffer = mmap(NULL, td->orig_buffer_size,
5ec10eaa JA	128	PROT_READ \| PROT_WRITE, flags, td->mmapfd, 0);
ee56ad50 JA	129	dprint(FD_MEM, "mmap %zu/%d %p\n", td->orig_buffer_size, td->mmapfd,
ee56ad50 JA	130	td->orig_buffer);
b6f9676e JA	131	if (td->orig_buffer == MAP_FAILED) {
	132	td_verror(td, errno, "mmap");
	133	td->orig_buffer = NULL;
	134	if (td->mmapfd) {
	135	close(td->mmapfd);
	136	unlink(td->mmapfile);
	137	}
5ec10eaa	138
b6f9676e	139	return 1;
2f9ade3c JA	140	}
	141
	142	return 0;
	143	}
	144
b6f9676e JA	145	static int alloc_mem_malloc(struct thread_data *td)
b6f9676e JA	146	{
d87612ac JA	147	unsigned int bsize = td->orig_buffer_size;
	148
	149	if (td->o.odirect)
	150	bsize += page_mask;
5ec10eaa	151
d87612ac	152	td->orig_buffer = malloc(bsize);
ee56ad50	153	dprint(FD_MEM, "malloc %u %p\n", bsize, td->orig_buffer);
b6f9676e JA	154	if (td->orig_buffer)
	155	return 0;
	156
	157	return 1;
	158	}
	159
	160	/*
	161	* Setup the buffer area we need for io.
	162	*/
	163	int allocate_io_mem(struct thread_data *td)
	164	{
	165	int ret = 0;
	166
b4c5e1ac JA	167	if (td->io_ops->flags & FIO_NOIO)
	168	return 0;
	169
b6f9676e JA	170	if (td->o.mem_type == MEM_MALLOC)
	171	ret = alloc_mem_malloc(td);
	172	else if (td->o.mem_type == MEM_SHM \|\| td->o.mem_type == MEM_SHMHUGE)
	173	ret = alloc_mem_shm(td);
	174	else if (td->o.mem_type == MEM_MMAP \|\| td->o.mem_type == MEM_MMAPHUGE)
	175	ret = alloc_mem_mmap(td);
	176	else {
	177	log_err("fio: bad mem type: %d\n", td->o.mem_type);
	178	ret = 1;
	179	}
	180
3deb3101 JA	181	if (ret)
	182	td_verror(td, ENOMEM, "iomem allocation");
	183
b6f9676e JA	184	return ret;
	185	}
	186
2f9ade3c JA	187	void free_io_mem(struct thread_data *td)
2f9ade3c JA	188	{
ee56ad50 JA	189	if (td->o.mem_type == MEM_MALLOC) {
ee56ad50 JA	190	dprint(FD_MEM, "free mem %p\n", td->orig_buffer);
2f9ade3c	191	free(td->orig_buffer);
ee56ad50	192	} else if (td->o.mem_type == MEM_SHM \|\| td->o.mem_type == MEM_SHMHUGE) {
2f9ade3c JA	193	struct shmid_ds sbuf;
2f9ade3c JA	194
5ec10eaa JA	195	dprint(FD_MEM, "shmdt/ctl %d %p\n", td->shm_id,
5ec10eaa JA	196	td->orig_buffer);
2f9ade3c JA	197	shmdt(td->orig_buffer);
2f9ade3c JA	198	shmctl(td->shm_id, IPC_RMID, &sbuf);
2dc1bbeb JA	199	} else if (td->o.mem_type == MEM_MMAP \|\|
2dc1bbeb JA	200	td->o.mem_type == MEM_MMAPHUGE) {
ee56ad50 JA	201	dprint(FD_MEM, "munmap %zu %p\n", td->orig_buffer_size,
ee56ad50 JA	202	td->orig_buffer);
2f9ade3c	203	munmap(td->orig_buffer, td->orig_buffer_size);
313cb206 JA	204	if (td->mmapfile) {
	205	close(td->mmapfd);
	206	unlink(td->mmapfile);
	207	free(td->mmapfile);
d0bdaf49 JA	208	}
d0bdaf49 JA	209	} else
2dc1bbeb	210	log_err("Bad memory type %u\n", td->o.mem_type);
2f9ade3c JA	211
	212	td->orig_buffer = NULL;
	213	}