[fio.git] / engines / pmemblk.c

/*
 * pmemblk: IO engine that uses NVML libpmemblk to read and write data
 *
 * Copyright (C) 2016 Hewlett Packard Enterprise Development LP
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License,
 * version 2 as published by the Free Software Foundation..
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the Free
 * Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307 USA
 */

/*
 * pmemblk engine
 *
 * IO engine that uses libpmemblk to read and write data
 *
 * To use:
 *   ioengine=pmemblk
 *
 * Other relevant settings:
 *   iodepth=1
 *   direct=1
 *   thread=1   REQUIRED
 *   unlink=1
 *   filename=/pmem0/fiotestfile,BSIZE,FSIZEMB
 *
 *   thread must be set to 1 for pmemblk as multiple processes cannot
 *     open the same block pool file.
 *
 *   iodepth should be set to 1 as pmemblk is always synchronous.
 *   Use numjobs to scale up.
 *
 *   direct=1 is implied as pmemblk is always direct.
 *
 *   Can set unlink to 1 to remove the block pool file after testing.
 *
 *   When specifying the filename, if the block pool file does not already
 *   exist, then the pmemblk engine can create the pool file if you specify
 *   the block and file sizes.  BSIZE is the block size in bytes.
 *   FSIZEMB is the pool file size in MB.
 *
 *   See examples/pmemblk.fio for more.
 *
 * libpmemblk.so
 *   By default, the pmemblk engine will let the system find the libpmemblk.so
 *   that it uses.  You can use an alternative libpmemblk by setting the
 *   FIO_PMEMBLK_LIB environment variable to the full path to the desired
 *   libpmemblk.so.
 *
 */

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <sys/uio.h>
#include <errno.h>
#include <assert.h>
#include <dlfcn.h>
#include <string.h>

#include "../fio.h"

/*
 * libpmemblk
 */
struct PMEMblkpool_s;
typedef struct PMEMblkpool_s PMEMblkpool;

PMEMblkpool *(*pmemblk_create) (const char *, size_t, size_t, mode_t) = NULL;
PMEMblkpool *(*pmemblk_open) (const char *, size_t) = NULL;
void (*pmemblk_close) (PMEMblkpool *) = NULL;
size_t(*pmemblk_nblock) (PMEMblkpool *) = NULL;
size_t(*pmemblk_bsize) (PMEMblkpool *) = NULL;
int (*pmemblk_read) (PMEMblkpool *, void *, off_t) = NULL;
int (*pmemblk_write) (PMEMblkpool *, const void *, off_t) = NULL;

int load_libpmemblk(const char *path)
{
	void *dl;

	if (NULL == path)
		path = "libpmemblk.so";

	dl = dlopen(path, RTLD_NOW | RTLD_NODELETE);
	if (NULL == dl)
		goto errorout;

	if (NULL == (pmemblk_create = dlsym(dl, "pmemblk_create")))
		goto errorout;
	if (NULL == (pmemblk_open = dlsym(dl, "pmemblk_open")))
		goto errorout;
	if (NULL == (pmemblk_close = dlsym(dl, "pmemblk_close")))
		goto errorout;
	if (NULL == (pmemblk_nblock = dlsym(dl, "pmemblk_nblock")))
		goto errorout;
	if (NULL == (pmemblk_bsize = dlsym(dl, "pmemblk_bsize")))
		goto errorout;
	if (NULL == (pmemblk_read = dlsym(dl, "pmemblk_read")))
		goto errorout;
	if (NULL == (pmemblk_write = dlsym(dl, "pmemblk_write")))
		goto errorout;

	return 0;

errorout:
	log_err("fio: unable to load libpmemblk: %s\n", dlerror());
	if (NULL != dl)
		dlclose(dl);

	return (-1);

}				/* load_libpmemblk() */

typedef struct fio_pmemblk_file *fio_pmemblk_file_t;
struct fio_pmemblk_file {
	fio_pmemblk_file_t pmb_next;
	char *pmb_filename;
	uint64_t pmb_refcnt;
	PMEMblkpool *pmb_pool;
	size_t pmb_bsize;
	size_t pmb_nblocks;
};
#define FIOFILEPMBSET(_f, _v)  do {                 \
	(_f)->engine_data = (uint64_t)(uintptr_t)(_v);  \
} while(0)
#define FIOFILEPMBGET(_f)  ((fio_pmemblk_file_t)((_f)->engine_data))

static fio_pmemblk_file_t Cache = NULL;

static pthread_mutex_t CacheLock = PTHREAD_MUTEX_INITIALIZER;
#define CACHE_LOCK()  \
	(void)pthread_mutex_lock(&CacheLock)
#define CACHE_UNLOCK()  \
	(void)pthread_mutex_unlock(&CacheLock)

#define PMB_CREATE   (0x0001)	/* should create file */

fio_pmemblk_file_t fio_pmemblk_cache_lookup(const char *filename)
{
	fio_pmemblk_file_t i;

	for (i = Cache; i != NULL; i = i->pmb_next)
		if (0 == strcmp(filename, i->pmb_filename))
			return i;

	return NULL;

}				/* fio_pmemblk_cache_lookup() */

static void fio_pmemblk_cache_insert(fio_pmemblk_file_t pmb)
{
	pmb->pmb_next = Cache;
	Cache = pmb;

	return;

}				/* fio_pmemblk_cache_insert() */

static void fio_pmemblk_cache_remove(fio_pmemblk_file_t pmb)
{
	fio_pmemblk_file_t i;

	if (pmb == Cache) {
		Cache = Cache->pmb_next;
		pmb->pmb_next = NULL;
		return;
	}

	for (i = Cache; i != NULL; i = i->pmb_next)
		if (pmb == i->pmb_next) {
			i->pmb_next = i->pmb_next->pmb_next;
			pmb->pmb_next = NULL;
			return;
		}

	return;

}				/* fio_pmemblk_cache_remove() */

/*
 * to control block size and gross file size at the libpmemblk
 * level, we allow the block size and file size to be appended
 * to the file name:
 *
 *   path[,bsize,fsizemb]
 *
 * note that we do not use the fio option "filesize" to dictate
 * the file size because we can only give libpmemblk the gross
 * file size, which is different from the net or usable file
 * size (which is probably what fio wants).
 *
 * the final path without the parameters is returned in ppath.
 * the block size and file size are returned in pbsize and fsize.
 *
 * note that the user should specify the file size in MiB, but
 * we return bytes from here.
 */
static void
pmb_parse_path(const char *pathspec,
	       char **ppath, uint64_t * pbsize, uint64_t * pfsize)
{
	char *path;
	char *s;
	uint64_t bsize;
	uint64_t fsizemb;

	path = strdup(pathspec);
	if (NULL == path) {
		*ppath = NULL;
		return;
	}

	/* extract sizes, if given */
	s = strrchr(path, ',');
	if (s && (fsizemb = strtoull(s + 1, NULL, 10))) {
		*s = 0;
		s = strrchr(path, ',');
		if (s && (bsize = strtoull(s + 1, NULL, 10))) {
			*s = 0;
			*ppath = path;
			*pbsize = bsize;
			*pfsize = fsizemb << 20;
			return;
		}
	}

	/* size specs not found */
	strcpy(path, pathspec);
	*ppath = path;
	*pbsize = 0;
	*pfsize = 0;
	return;

}				/* pmb_parse_path() */

static
 fio_pmemblk_file_t pmb_open(const char *pathspec, int flags)
{
	fio_pmemblk_file_t pmb;
	char *path = NULL;
	uint64_t bsize = 0;
	uint64_t fsize = 0;

	pmb_parse_path(pathspec, &path, &bsize, &fsize);
	if (NULL == path)
		return NULL;

	CACHE_LOCK();

	pmb = fio_pmemblk_cache_lookup(path);

	if (NULL == pmb) {
		/* load libpmemblk if needed */
		if (NULL == pmemblk_open)
			if (0 != load_libpmemblk(getenv("FIO_PMEMBLK_LIB")))
				goto error;

		pmb = malloc(sizeof(*pmb));
		if (NULL == pmb)
			goto error;

		/* try opening existing first, create it if needed */
		pmb->pmb_pool = pmemblk_open(path, bsize);
		if ((NULL == pmb->pmb_pool) &&
		    (ENOENT == errno) &&
		    (flags & PMB_CREATE) && (0 < fsize) && (0 < bsize)) {
			pmb->pmb_pool =
			    pmemblk_create(path, bsize, fsize, 0644);
		}
		if (NULL == pmb->pmb_pool) {
			log_err
			    ("fio: enable to open pmemblk pool file (errno %d)\n",
			     errno);
			goto error;
		}

		pmb->pmb_filename = path;
		pmb->pmb_next = NULL;
		pmb->pmb_refcnt = 0;
		pmb->pmb_bsize = pmemblk_bsize(pmb->pmb_pool);
		pmb->pmb_nblocks = pmemblk_nblock(pmb->pmb_pool);

		fio_pmemblk_cache_insert(pmb);
	}

	pmb->pmb_refcnt += 1;

	CACHE_UNLOCK();

	return pmb;

error:
	if (NULL != pmb) {
		if (NULL != pmb->pmb_pool)
			pmemblk_close(pmb->pmb_pool);
		pmb->pmb_pool = NULL;
		pmb->pmb_filename = NULL;
		free(pmb);
	}
	if (NULL != path)
		free(path);
	CACHE_UNLOCK();
	return NULL;

}				/* pmb_open() */

static void pmb_close(fio_pmemblk_file_t pmb, const int keep)
{
	CACHE_LOCK();

	pmb->pmb_refcnt--;

	if (!keep && (0 == pmb->pmb_refcnt)) {
		pmemblk_close(pmb->pmb_pool);
		pmb->pmb_pool = NULL;
		free(pmb->pmb_filename);
		pmb->pmb_filename = NULL;
		fio_pmemblk_cache_remove(pmb);
		free(pmb);
	}

	CACHE_UNLOCK();

}				/* pmb_close() */

static int pmb_get_flags(struct thread_data *td, uint64_t * pflags)
{
	static int thread_warned = 0;
	static int odirect_warned = 0;

	uint64_t flags = 0;

	if (!td->o.use_thread) {
		if (!thread_warned) {
			thread_warned = 1;
			log_err("fio: must set thread=1 for pmemblk engine\n");
		}
		return 1;
	}

	if (!td->o.odirect && !odirect_warned) {
		odirect_warned = 1;
		log_info("fio: direct == 0, but pmemblk is always direct\n");
	}

	if (td->o.allow_create)
		flags |= PMB_CREATE;

	(*pflags) = flags;
	return 0;

}				/* pmb_get_flags() */

static int fio_pmemblk_open_file(struct thread_data *td, struct fio_file *f)
{
	uint64_t flags = 0;
	fio_pmemblk_file_t pmb;

	if (0 != pmb_get_flags(td, &flags))
		return 1;

	pmb = pmb_open(f->file_name, flags);
	if (NULL == pmb)
		return 1;

	FIOFILEPMBSET(f, pmb);

	return 0;

}				/* fio_pmemblk_open_file() */

static int
fio_pmemblk_close_file(struct thread_data fio_unused * td, struct fio_file *f)
{
	fio_pmemblk_file_t pmb = FIOFILEPMBGET(f);

	if (pmb)
		pmb_close(pmb, 0);

	FIOFILEPMBSET(f, NULL);

	return 0;

}				/* fio_pmemblk_close_file() */

static int fio_pmemblk_get_file_size(struct thread_data *td, struct fio_file *f)
{
	uint64_t flags = 0;
	fio_pmemblk_file_t pmb = FIOFILEPMBGET(f);

	if (fio_file_size_known(f))
		return 0;

	if (NULL == pmb) {
		if (0 != pmb_get_flags(td, &flags))
			return 1;
		pmb = pmb_open(f->file_name, flags);
		if (NULL == pmb)
			return 1;
	}

	f->real_file_size = pmb->pmb_bsize * pmb->pmb_nblocks;

	fio_file_set_size_known(f);

	if (NULL == FIOFILEPMBGET(f))
		pmb_close(pmb, 1);

	return 0;

}				/* fio_pmemblk_get_file_size() */

static int fio_pmemblk_queue(struct thread_data *td, struct io_u *io_u)
{
	struct fio_file *f = io_u->file;
	fio_pmemblk_file_t pmb = FIOFILEPMBGET(f);

	unsigned long long off;
	unsigned long len;
	void *buf;
	int (*blkop) (PMEMblkpool *, void *, off_t) = (void *)pmemblk_write;

	fio_ro_check(td, io_u);

	switch (io_u->ddir) {
	case DDIR_READ:
		blkop = pmemblk_read;
		/* fall through */
	case DDIR_WRITE:
		off = io_u->offset;
		len = io_u->xfer_buflen;

		io_u->error = EINVAL;
		if (0 != (off % pmb->pmb_bsize))
			break;
		if (0 != (len % pmb->pmb_bsize))
			break;
		if ((off + len) / pmb->pmb_bsize > pmb->pmb_nblocks)
			break;

		io_u->error = 0;
		buf = io_u->xfer_buf;
		off /= pmb->pmb_bsize;
		len /= pmb->pmb_bsize;
		while (0 < len) {
			if (0 != blkop(pmb->pmb_pool, buf, off)) {
				io_u->error = errno;
				break;
			}
			buf += pmb->pmb_bsize;
			off++;
			len--;
		}
		off *= pmb->pmb_bsize;
		len *= pmb->pmb_bsize;
		io_u->resid = io_u->xfer_buflen - (off - io_u->offset);
		break;
	case DDIR_SYNC:
	case DDIR_DATASYNC:
	case DDIR_SYNC_FILE_RANGE:
		/* we're always sync'd */
		io_u->error = 0;
		break;
	default:
		io_u->error = EINVAL;
		break;
	}

	return FIO_Q_COMPLETED;

}				/* fio_pmemblk_queue() */

static int fio_pmemblk_unlink_file(struct thread_data *td, struct fio_file *f)
{
	char *path = NULL;
	uint64_t bsize = 0;
	uint64_t fsize = 0;

	/*
	 * we need our own unlink in case the user has specified
	 * the block and file sizes in the path name.  we parse
	 * the file_name to determine the file name we actually used.
	 */

	pmb_parse_path(f->file_name, &path, &bsize, &fsize);
	if (NULL == path)
		return 1;

	unlink(path);
	free(path);

	return 0;

}				/* fio_pmemblk_unlink_file() */

struct ioengine_ops ioengine = {
	.name = "pmemblk",
	.version = FIO_IOOPS_VERSION,
	.queue = fio_pmemblk_queue,
	.open_file = fio_pmemblk_open_file,
	.close_file = fio_pmemblk_close_file,
	.get_file_size = fio_pmemblk_get_file_size,
	.unlink_file = fio_pmemblk_unlink_file,
	.flags = FIO_SYNCIO | FIO_DISKLESSIO | FIO_NOEXTEND | FIO_NODISKUTIL,
};

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

static void
fio_exit fio_pmemblk_unregister(void)
{
	unregister_ioengine(&ioengine);
}
Commit	Line	Data
43f3cec2 BB	1	/*
	2	* pmemblk: IO engine that uses NVML libpmemblk to read and write data
	3	*
	4	* Copyright (C) 2016 Hewlett Packard Enterprise Development LP
	5	*
	6	* This program is free software; you can redistribute it and/or
	7	* modify it under the terms of the GNU General Public License,
	8	* version 2 as published by the Free Software Foundation..
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*
	15	* You should have received a copy of the GNU General Public
	16	* License along with this program; if not, write to the Free
	17	* Software Foundation, Inc., 59 Temple Place, Suite 330,
	18	* Boston, MA 02111-1307 USA
	19	*/
	20
43f3cec2 BB	21	/*
	22	* pmemblk engine
	23	*
	24	* IO engine that uses libpmemblk to read and write data
	25	*
f1d85c6e BB	26	* To use:
f1d85c6e BB	27	* ioengine=pmemblk
43f3cec2 BB	28	*
	29	* Other relevant settings:
	30	* iodepth=1
	31	* direct=1
	32	* thread=1 REQUIRED
	33	* unlink=1
	34	* filename=/pmem0/fiotestfile,BSIZE,FSIZEMB
	35	*
	36	* thread must be set to 1 for pmemblk as multiple processes cannot
	37	* open the same block pool file.
	38	*
	39	* iodepth should be set to 1 as pmemblk is always synchronous.
	40	* Use numjobs to scale up.
	41	*
	42	* direct=1 is implied as pmemblk is always direct.
	43	*
	44	* Can set unlink to 1 to remove the block pool file after testing.
	45	*
	46	* When specifying the filename, if the block pool file does not already
	47	* exist, then the pmemblk engine can create the pool file if you specify
	48	* the block and file sizes. BSIZE is the block size in bytes.
	49	* FSIZEMB is the pool file size in MB.
	50	*
f1d85c6e BB	51	* See examples/pmemblk.fio for more.
f1d85c6e BB	52	*
43f3cec2 BB	53	* libpmemblk.so
	54	* By default, the pmemblk engine will let the system find the libpmemblk.so
	55	* that it uses. You can use an alternative libpmemblk by setting the
	56	* FIO_PMEMBLK_LIB environment variable to the full path to the desired
	57	* libpmemblk.so.
	58	*
	59	*/
	60
	61	#include <stdio.h>
	62	#include <stdlib.h>
	63	#include <unistd.h>
	64	#include <sys/uio.h>
	65	#include <errno.h>
	66	#include <assert.h>
	67	#include <dlfcn.h>
	68	#include <string.h>
	69
	70	#include "../fio.h"
	71
43f3cec2 BB	72	/*
	73	* libpmemblk
	74	*/
	75	struct PMEMblkpool_s;
	76	typedef struct PMEMblkpool_s PMEMblkpool;
	77
c086b314 JA	78	PMEMblkpool (pmemblk_create) (const char *, size_t, size_t, mode_t) = NULL;
	79	PMEMblkpool (pmemblk_open) (const char *, size_t) = NULL;
	80	void (pmemblk_close) (PMEMblkpool ) = NULL;
	81	size_t(pmemblk_nblock) (PMEMblkpool ) = NULL;
	82	size_t(pmemblk_bsize) (PMEMblkpool ) = NULL;
	83	int (pmemblk_read) (PMEMblkpool , void *, off_t) = NULL;
	84	int (pmemblk_write) (PMEMblkpool , const void *, off_t) = NULL;
	85
	86	int load_libpmemblk(const char *path)
43f3cec2	87	{
c086b314	88	void *dl;
43f3cec2 BB	89
	90	if (NULL == path)
	91	path = "libpmemblk.so";
	92
	93	dl = dlopen(path, RTLD_NOW \| RTLD_NODELETE);
	94	if (NULL == dl)
	95	goto errorout;
	96
dfec8168	97	if (NULL == (pmemblk_create = dlsym(dl, "pmemblk_create")))
43f3cec2	98	goto errorout;
dfec8168	99	if (NULL == (pmemblk_open = dlsym(dl, "pmemblk_open")))
43f3cec2	100	goto errorout;
dfec8168	101	if (NULL == (pmemblk_close = dlsym(dl, "pmemblk_close")))
43f3cec2	102	goto errorout;
dfec8168	103	if (NULL == (pmemblk_nblock = dlsym(dl, "pmemblk_nblock")))
43f3cec2	104	goto errorout;
dfec8168	105	if (NULL == (pmemblk_bsize = dlsym(dl, "pmemblk_bsize")))
43f3cec2	106	goto errorout;
dfec8168	107	if (NULL == (pmemblk_read = dlsym(dl, "pmemblk_read")))
43f3cec2	108	goto errorout;
dfec8168	109	if (NULL == (pmemblk_write = dlsym(dl, "pmemblk_write")))
43f3cec2	110	goto errorout;
c086b314	111
43f3cec2 BB	112	return 0;
	113
	114	errorout:
	115	log_err("fio: unable to load libpmemblk: %s\n", dlerror());
	116	if (NULL != dl)
	117	dlclose(dl);
	118
	119	return (-1);
43f3cec2	120
c086b314	121	} /* load_libpmemblk() */
43f3cec2	122
c086b314	123	typedef struct fio_pmemblk_file *fio_pmemblk_file_t;
43f3cec2	124	struct fio_pmemblk_file {
c086b314 JA	125	fio_pmemblk_file_t pmb_next;
	126	char *pmb_filename;
	127	uint64_t pmb_refcnt;
	128	PMEMblkpool *pmb_pool;
	129	size_t pmb_bsize;
	130	size_t pmb_nblocks;
43f3cec2 BB	131	};
	132	#define FIOFILEPMBSET(_f, _v) do { \
	133	(_f)->engine_data = (uint64_t)(uintptr_t)(_v); \
	134	} while(0)
	135	#define FIOFILEPMBGET(_f) ((fio_pmemblk_file_t)((_f)->engine_data))
	136
c086b314	137	static fio_pmemblk_file_t Cache = NULL;
43f3cec2	138
c086b314	139	static pthread_mutex_t CacheLock = PTHREAD_MUTEX_INITIALIZER;
43f3cec2 BB	140	#define CACHE_LOCK() \
	141	(void)pthread_mutex_lock(&CacheLock)
	142	#define CACHE_UNLOCK() \
	143	(void)pthread_mutex_unlock(&CacheLock)
	144
c086b314	145	#define PMB_CREATE (0x0001) /* should create file */
43f3cec2	146
c086b314	147	fio_pmemblk_file_t fio_pmemblk_cache_lookup(const char *filename)
43f3cec2	148	{
c086b314	149	fio_pmemblk_file_t i;
43f3cec2 BB	150
	151	for (i = Cache; i != NULL; i = i->pmb_next)
	152	if (0 == strcmp(filename, i->pmb_filename))
	153	return i;
	154
	155	return NULL;
	156
c086b314	157	} /* fio_pmemblk_cache_lookup() */
43f3cec2	158
c086b314	159	static void fio_pmemblk_cache_insert(fio_pmemblk_file_t pmb)
43f3cec2 BB	160	{
	161	pmb->pmb_next = Cache;
	162	Cache = pmb;
	163
	164	return;
	165
c086b314	166	} /* fio_pmemblk_cache_insert() */
43f3cec2	167
c086b314	168	static void fio_pmemblk_cache_remove(fio_pmemblk_file_t pmb)
43f3cec2	169	{
c086b314	170	fio_pmemblk_file_t i;
43f3cec2 BB	171
	172	if (pmb == Cache) {
	173	Cache = Cache->pmb_next;
	174	pmb->pmb_next = NULL;
	175	return;
	176	}
	177
	178	for (i = Cache; i != NULL; i = i->pmb_next)
	179	if (pmb == i->pmb_next) {
	180	i->pmb_next = i->pmb_next->pmb_next;
	181	pmb->pmb_next = NULL;
	182	return;
	183	}
	184
	185	return;
	186
c086b314	187	} /* fio_pmemblk_cache_remove() */
43f3cec2 BB	188
	189	/*
	190	* to control block size and gross file size at the libpmemblk
	191	* level, we allow the block size and file size to be appended
	192	* to the file name:
	193	*
	194	* path[,bsize,fsizemb]
	195	*
	196	* note that we do not use the fio option "filesize" to dictate
	197	* the file size because we can only give libpmemblk the gross
	198	* file size, which is different from the net or usable file
	199	* size (which is probably what fio wants).
	200	*
	201	* the final path without the parameters is returned in ppath.
	202	* the block size and file size are returned in pbsize and fsize.
	203	*
	204	* note that the user should specify the file size in MiB, but
	205	* we return bytes from here.
	206	*/
	207	static void
c086b314 JA	208	pmb_parse_path(const char *pathspec,
c086b314 JA	209	char *ppath, uint64_t pbsize, uint64_t * pfsize)
43f3cec2	210	{
c086b314 JA	211	char *path;
	212	char *s;
	213	uint64_t bsize;
	214	uint64_t fsizemb;
43f3cec2 BB	215
	216	path = strdup(pathspec);
	217	if (NULL == path) {
	218	*ppath = NULL;
	219	return;
	220	}
	221
	222	/* extract sizes, if given */
	223	s = strrchr(path, ',');
c086b314	224	if (s && (fsizemb = strtoull(s + 1, NULL, 10))) {
43f3cec2 BB	225	*s = 0;
43f3cec2 BB	226	s = strrchr(path, ',');
c086b314	227	if (s && (bsize = strtoull(s + 1, NULL, 10))) {
43f3cec2	228	*s = 0;
c086b314	229	*ppath = path;
43f3cec2 BB	230	*pbsize = bsize;
	231	*pfsize = fsizemb << 20;
	232	return;
	233	}
	234	}
	235
	236	/* size specs not found */
	237	strcpy(path, pathspec);
c086b314	238	*ppath = path;
43f3cec2 BB	239	*pbsize = 0;
	240	*pfsize = 0;
	241	return;
	242
c086b314	243	} /* pmb_parse_path() */
43f3cec2 BB	244
43f3cec2 BB	245	static
c086b314	246	fio_pmemblk_file_t pmb_open(const char *pathspec, int flags)
43f3cec2	247	{
c086b314 JA	248	fio_pmemblk_file_t pmb;
	249	char *path = NULL;
	250	uint64_t bsize = 0;
	251	uint64_t fsize = 0;
43f3cec2 BB	252
	253	pmb_parse_path(pathspec, &path, &bsize, &fsize);
	254	if (NULL == path)
	255	return NULL;
	256
	257	CACHE_LOCK();
	258
	259	pmb = fio_pmemblk_cache_lookup(path);
	260
	261	if (NULL == pmb) {
	262	/* load libpmemblk if needed */
	263	if (NULL == pmemblk_open)
	264	if (0 != load_libpmemblk(getenv("FIO_PMEMBLK_LIB")))
	265	goto error;
	266
	267	pmb = malloc(sizeof(*pmb));
	268	if (NULL == pmb)
	269	goto error;
	270
	271	/* try opening existing first, create it if needed */
	272	pmb->pmb_pool = pmemblk_open(path, bsize);
	273	if ((NULL == pmb->pmb_pool) &&
	274	(ENOENT == errno) &&
c086b314 JA	275	(flags & PMB_CREATE) && (0 < fsize) && (0 < bsize)) {
	276	pmb->pmb_pool =
	277	pmemblk_create(path, bsize, fsize, 0644);
43f3cec2 BB	278	}
43f3cec2 BB	279	if (NULL == pmb->pmb_pool) {
c086b314 JA	280	log_err
	281	("fio: enable to open pmemblk pool file (errno %d)\n",
	282	errno);
43f3cec2 BB	283	goto error;
	284	}
	285
	286	pmb->pmb_filename = path;
c086b314 JA	287	pmb->pmb_next = NULL;
	288	pmb->pmb_refcnt = 0;
	289	pmb->pmb_bsize = pmemblk_bsize(pmb->pmb_pool);
	290	pmb->pmb_nblocks = pmemblk_nblock(pmb->pmb_pool);
43f3cec2 BB	291
	292	fio_pmemblk_cache_insert(pmb);
	293	}
	294
	295	pmb->pmb_refcnt += 1;
	296
	297	CACHE_UNLOCK();
c086b314	298
43f3cec2 BB	299	return pmb;
	300
	301	error:
	302	if (NULL != pmb) {
	303	if (NULL != pmb->pmb_pool)
	304	pmemblk_close(pmb->pmb_pool);
c086b314	305	pmb->pmb_pool = NULL;
43f3cec2 BB	306	pmb->pmb_filename = NULL;
	307	free(pmb);
	308	}
	309	if (NULL != path)
	310	free(path);
	311	CACHE_UNLOCK();
	312	return NULL;
	313
c086b314	314	} /* pmb_open() */
43f3cec2	315
c086b314	316	static void pmb_close(fio_pmemblk_file_t pmb, const int keep)
43f3cec2 BB	317	{
	318	CACHE_LOCK();
	319
	320	pmb->pmb_refcnt--;
	321
	322	if (!keep && (0 == pmb->pmb_refcnt)) {
	323	pmemblk_close(pmb->pmb_pool);
	324	pmb->pmb_pool = NULL;
	325	free(pmb->pmb_filename);
	326	pmb->pmb_filename = NULL;
	327	fio_pmemblk_cache_remove(pmb);
	328	free(pmb);
	329	}
	330
	331	CACHE_UNLOCK();
	332
c086b314	333	} /* pmb_close() */
43f3cec2	334
c086b314	335	static int pmb_get_flags(struct thread_data td, uint64_t pflags)
43f3cec2	336	{
c086b314	337	static int thread_warned = 0;
43f3cec2 BB	338	static int odirect_warned = 0;
43f3cec2 BB	339
c086b314	340	uint64_t flags = 0;
43f3cec2 BB	341
	342	if (!td->o.use_thread) {
	343	if (!thread_warned) {
	344	thread_warned = 1;
	345	log_err("fio: must set thread=1 for pmemblk engine\n");
	346	}
	347	return 1;
	348	}
	349
	350	if (!td->o.odirect && !odirect_warned) {
	351	odirect_warned = 1;
	352	log_info("fio: direct == 0, but pmemblk is always direct\n");
	353	}
	354
	355	if (td->o.allow_create)
	356	flags \|= PMB_CREATE;
	357
	358	(*pflags) = flags;
	359	return 0;
	360
c086b314	361	} /* pmb_get_flags() */
43f3cec2	362
c086b314	363	static int fio_pmemblk_open_file(struct thread_data td, struct fio_file f)
43f3cec2	364	{
c086b314 JA	365	uint64_t flags = 0;
c086b314 JA	366	fio_pmemblk_file_t pmb;
43f3cec2 BB	367
	368	if (0 != pmb_get_flags(td, &flags))
	369	return 1;
	370
	371	pmb = pmb_open(f->file_name, flags);
	372	if (NULL == pmb)
	373	return 1;
	374
	375	FIOFILEPMBSET(f, pmb);
	376
	377	return 0;
	378
c086b314	379	} /* fio_pmemblk_open_file() */
43f3cec2 BB	380
43f3cec2 BB	381	static int
c086b314	382	fio_pmemblk_close_file(struct thread_data fio_unused * td, struct fio_file *f)
43f3cec2	383	{
c086b314	384	fio_pmemblk_file_t pmb = FIOFILEPMBGET(f);
43f3cec2 BB	385
	386	if (pmb)
	387	pmb_close(pmb, 0);
	388
	389	FIOFILEPMBSET(f, NULL);
	390
	391	return 0;
	392
c086b314	393	} /* fio_pmemblk_close_file() */
43f3cec2	394
c086b314	395	static int fio_pmemblk_get_file_size(struct thread_data td, struct fio_file f)
43f3cec2	396	{
c086b314 JA	397	uint64_t flags = 0;
c086b314 JA	398	fio_pmemblk_file_t pmb = FIOFILEPMBGET(f);
43f3cec2 BB	399
	400	if (fio_file_size_known(f))
	401	return 0;
	402
	403	if (NULL == pmb) {
	404	if (0 != pmb_get_flags(td, &flags))
	405	return 1;
	406	pmb = pmb_open(f->file_name, flags);
	407	if (NULL == pmb)
	408	return 1;
	409	}
	410
	411	f->real_file_size = pmb->pmb_bsize * pmb->pmb_nblocks;
	412
	413	fio_file_set_size_known(f);
	414
	415	if (NULL == FIOFILEPMBGET(f))
	416	pmb_close(pmb, 1);
	417
	418	return 0;
	419
c086b314	420	} /* fio_pmemblk_get_file_size() */
43f3cec2	421
c086b314	422	static int fio_pmemblk_queue(struct thread_data td, struct io_u io_u)
43f3cec2	423	{
c086b314 JA	424	struct fio_file *f = io_u->file;
c086b314 JA	425	fio_pmemblk_file_t pmb = FIOFILEPMBGET(f);
43f3cec2	426
c086b314 JA	427	unsigned long long off;
	428	unsigned long len;
	429	void *buf;
	430	int (blkop) (PMEMblkpool , void , off_t) = (void )pmemblk_write;
43f3cec2 BB	431
	432	fio_ro_check(td, io_u);
	433
	434	switch (io_u->ddir) {
	435	case DDIR_READ:
	436	blkop = pmemblk_read;
	437	/* fall through */
	438	case DDIR_WRITE:
	439	off = io_u->offset;
	440	len = io_u->xfer_buflen;
	441
	442	io_u->error = EINVAL;
	443	if (0 != (off % pmb->pmb_bsize))
	444	break;
	445	if (0 != (len % pmb->pmb_bsize))
	446	break;
	447	if ((off + len) / pmb->pmb_bsize > pmb->pmb_nblocks)
	448	break;
	449
	450	io_u->error = 0;
	451	buf = io_u->xfer_buf;
	452	off /= pmb->pmb_bsize;
	453	len /= pmb->pmb_bsize;
	454	while (0 < len) {
	455	if (0 != blkop(pmb->pmb_pool, buf, off)) {
	456	io_u->error = errno;
	457	break;
	458	}
	459	buf += pmb->pmb_bsize;
	460	off++;
	461	len--;
	462	}
	463	off *= pmb->pmb_bsize;
	464	len *= pmb->pmb_bsize;
	465	io_u->resid = io_u->xfer_buflen - (off - io_u->offset);
	466	break;
	467	case DDIR_SYNC:
	468	case DDIR_DATASYNC:
	469	case DDIR_SYNC_FILE_RANGE:
	470	/* we're always sync'd */
	471	io_u->error = 0;
	472	break;
	473	default:
	474	io_u->error = EINVAL;
	475	break;
	476	}
	477
	478	return FIO_Q_COMPLETED;
	479
c086b314	480	} /* fio_pmemblk_queue() */
43f3cec2	481
c086b314	482	static int fio_pmemblk_unlink_file(struct thread_data td, struct fio_file f)
43f3cec2	483	{
c086b314 JA	484	char *path = NULL;
	485	uint64_t bsize = 0;
	486	uint64_t fsize = 0;
43f3cec2 BB	487
	488	/*
	489	* we need our own unlink in case the user has specified
	490	* the block and file sizes in the path name. we parse
	491	* the file_name to determine the file name we actually used.
	492	*/
	493
	494	pmb_parse_path(f->file_name, &path, &bsize, &fsize);
	495	if (NULL == path)
	496	return 1;
	497
	498	unlink(path);
	499	free(path);
	500
	501	return 0;
	502
c086b314	503	} /* fio_pmemblk_unlink_file() */
43f3cec2 BB	504
43f3cec2 BB	505	struct ioengine_ops ioengine = {
c086b314 JA	506	.name = "pmemblk",
	507	.version = FIO_IOOPS_VERSION,
	508	.queue = fio_pmemblk_queue,
	509	.open_file = fio_pmemblk_open_file,
	510	.close_file = fio_pmemblk_close_file,
	511	.get_file_size = fio_pmemblk_get_file_size,
	512	.unlink_file = fio_pmemblk_unlink_file,
	513	.flags = FIO_SYNCIO \| FIO_DISKLESSIO \| FIO_NOEXTEND \| FIO_NODISKUTIL,
43f3cec2 BB	514	};
43f3cec2 BB	515
43f3cec2 BB	516	static void
	517	fio_init fio_pmemblk_register(void)
	518	{
	519	register_ioengine(&ioengine);
	520	}
	521
43f3cec2 BB	522	static void
	523	fio_exit fio_pmemblk_unregister(void)
	524	{
	525	unregister_ioengine(&ioengine);
	526	}