/*
- * pmemblk: IO engine that uses NVML libpmemblk to read and write data
+ * pmemblk: IO engine that uses PMDK libpmemblk to read and write data
*
* Copyright (C) 2016 Hewlett Packard Enterprise Development LP
*
*
* 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
+ * Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
/*
* ioengine=pmemblk
*
* Other relevant settings:
+ * thread=1 REQUIRED
* iodepth=1
* direct=1
- * thread=1 REQUIRED
* unlink=1
- * filename=/pmem0/fiotestfile,BSIZE,FSIZEMB
+ * filename=/mnt/pmem0/fiotestfile,BSIZE,FSIZEMiB
*
* 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.
+ * direct=1 is implied as pmemblk is always direct. A warning message
+ * is printed if this is not specified.
+ *
+ * unlink=1 removes the block pool file after testing, and is optional.
+ *
+ * The pmem device must have a DAX-capable filesystem and be mounted
+ * with DAX enabled. filename must point to a file on that filesystem.
*
- * Can set unlink to 1 to remove the block pool file after testing.
+ * Example:
+ * mkfs.xfs /dev/pmem0
+ * mkdir /mnt/pmem0
+ * mount -o dax /dev/pmem0 /mnt/pmem0
*
* 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
+ * exist, then the pmemblk engine creates 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.
+ * FSIZEMB is the pool file size in MiB.
*
* See examples/pmemblk.fio for more.
*
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;
* level, we allow the block size and file size to be appended
* to the file name:
*
- * path[,bsize,fsizemb]
+ * path[,bsize,fsizemib]
*
* note that we do not use the fio option "filesize" to dictate
* the file size because we can only give libpmemblk the gross
* 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
+ * note that the user specifies the file size in MiB, but
* we return bytes from here.
*/
static void pmb_parse_path(const char *pathspec, char **ppath, uint64_t *pbsize,
char *path;
char *s;
uint64_t bsize;
- uint64_t fsizemb;
+ uint64_t fsizemib;
path = strdup(pathspec);
if (!path) {
/* extract sizes, if given */
s = strrchr(path, ',');
- if (s && (fsizemb = strtoull(s + 1, NULL, 10))) {
+ if (s && (fsizemib = 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;
+ *pfsize = fsizemib << 20;
return;
}
}
pmb->pmb_nblocks = pmemblk_nblock(pmb->pmb_pool);
fio_pmemblk_cache_insert(pmb);
+ } else {
+ free(path);
}
pmb->pmb_refcnt += 1;
if (!pmb)
return 1;
- FIOFILEPMBSET(f, pmb);
+ FILE_SET_ENG_DATA(f, pmb);
return 0;
}
static int fio_pmemblk_close_file(struct thread_data fio_unused *td,
struct fio_file *f)
{
- fio_pmemblk_file_t pmb = FIOFILEPMBGET(f);
+ fio_pmemblk_file_t pmb = FILE_ENG_DATA(f);
if (pmb)
pmb_close(pmb, false);
- FIOFILEPMBSET(f, NULL);
+ FILE_SET_ENG_DATA(f, NULL);
return 0;
}
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);
+ fio_pmemblk_file_t pmb = FILE_ENG_DATA(f);
if (fio_file_size_known(f))
return 0;
fio_file_set_size_known(f);
- if (!FIOFILEPMBGET(f))
+ if (!FILE_ENG_DATA(f))
pmb_close(pmb, true);
return 0;
}
-static int fio_pmemblk_queue(struct thread_data *td, struct io_u *io_u)
+static enum fio_q_status 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);
+ fio_pmemblk_file_t pmb = FILE_ENG_DATA(f);
unsigned long long off;
unsigned long len;
off /= pmb->pmb_bsize;
len /= pmb->pmb_bsize;
while (0 < len) {
- if (io_u->ddir == DDIR_READ &&
- 0 != pmemblk_read(pmb->pmb_pool, buf, off)) {
- io_u->error = errno;
- break;
+ if (io_u->ddir == DDIR_READ) {
+ if (0 != pmemblk_read(pmb->pmb_pool, buf, off)) {
+ io_u->error = errno;
+ break;
+ }
} else if (0 != pmemblk_write(pmb->pmb_pool, buf, off)) {
io_u->error = errno;
break;
return 0;
}
-static struct ioengine_ops ioengine = {
+FIO_STATIC struct ioengine_ops ioengine = {
.name = "pmemblk",
.version = FIO_IOOPS_VERSION,
.queue = fio_pmemblk_queue,