2 * pmemblk: IO engine that uses NVML libpmemblk to read and write data
4 * Copyright (C) 2016 Hewlett Packard Enterprise Development LP
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..
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.
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
24 * IO engine that uses libpmemblk to read and write data
29 * Other relevant settings:
34 * filename=/pmem0/fiotestfile,BSIZE,FSIZEMB
36 * thread must be set to 1 for pmemblk as multiple processes cannot
37 * open the same block pool file.
39 * iodepth should be set to 1 as pmemblk is always synchronous.
40 * Use numjobs to scale up.
42 * direct=1 is implied as pmemblk is always direct.
44 * Can set unlink to 1 to remove the block pool file after testing.
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.
51 * See examples/pmemblk.fio for more.
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
76 typedef struct PMEMblkpool_s PMEMblkpool;
78 static PMEMblkpool *(*pmemblk_create) (const char *, size_t, size_t, mode_t);
79 static PMEMblkpool *(*pmemblk_open) (const char *, size_t);
80 static void (*pmemblk_close) (PMEMblkpool *);
81 static size_t(*pmemblk_nblock) (PMEMblkpool *);
82 static size_t(*pmemblk_bsize) (PMEMblkpool *);
83 static int (*pmemblk_read) (PMEMblkpool *, void *, off_t);
84 static int (*pmemblk_write) (PMEMblkpool *, const void *, off_t);
86 int load_libpmemblk(const char *path)
91 path = "libpmemblk.so";
93 dl = dlopen(path, RTLD_NOW | RTLD_NODELETE);
97 pmemblk_create = dlsym(dl, "pmemblk_create");
100 pmemblk_open = dlsym(dl, "pmemblk_open");
103 pmemblk_close = dlsym(dl, "pmemblk_close");
106 pmemblk_nblock = dlsym(dl, "pmemblk_nblock");
109 pmemblk_bsize = dlsym(dl, "pmemblk_bsize");
112 pmemblk_read = dlsym(dl, "pmemblk_read");
115 pmemblk_write = dlsym(dl, "pmemblk_write");
122 log_err("fio: unable to load libpmemblk: %s\n", dlerror());
129 typedef struct fio_pmemblk_file *fio_pmemblk_file_t;
131 struct fio_pmemblk_file {
132 fio_pmemblk_file_t pmb_next;
135 PMEMblkpool *pmb_pool;
139 #define FIOFILEPMBSET(_f, _v) do { \
140 (_f)->engine_data = (uint64_t)(uintptr_t)(_v); \
142 #define FIOFILEPMBGET(_f) ((fio_pmemblk_file_t)((_f)->engine_data))
144 static fio_pmemblk_file_t Cache;
146 static pthread_mutex_t CacheLock = PTHREAD_MUTEX_INITIALIZER;
148 #define PMB_CREATE (0x0001) /* should create file */
150 fio_pmemblk_file_t fio_pmemblk_cache_lookup(const char *filename)
152 fio_pmemblk_file_t i;
154 for (i = Cache; i != NULL; i = i->pmb_next)
155 if (!strcmp(filename, i->pmb_filename))
161 static void fio_pmemblk_cache_insert(fio_pmemblk_file_t pmb)
163 pmb->pmb_next = Cache;
167 static void fio_pmemblk_cache_remove(fio_pmemblk_file_t pmb)
169 fio_pmemblk_file_t i;
172 Cache = Cache->pmb_next;
173 pmb->pmb_next = NULL;
177 for (i = Cache; i != NULL; i = i->pmb_next)
178 if (pmb == i->pmb_next) {
179 i->pmb_next = i->pmb_next->pmb_next;
180 pmb->pmb_next = NULL;
186 * to control block size and gross file size at the libpmemblk
187 * level, we allow the block size and file size to be appended
190 * path[,bsize,fsizemb]
192 * note that we do not use the fio option "filesize" to dictate
193 * the file size because we can only give libpmemblk the gross
194 * file size, which is different from the net or usable file
195 * size (which is probably what fio wants).
197 * the final path without the parameters is returned in ppath.
198 * the block size and file size are returned in pbsize and fsize.
200 * note that the user should specify the file size in MiB, but
201 * we return bytes from here.
203 static void pmb_parse_path(const char *pathspec, char **ppath, uint64_t *pbsize,
211 path = strdup(pathspec);
217 /* extract sizes, if given */
218 s = strrchr(path, ',');
219 if (s && (fsizemb = strtoull(s + 1, NULL, 10))) {
221 s = strrchr(path, ',');
222 if (s && (bsize = strtoull(s + 1, NULL, 10))) {
226 *pfsize = fsizemb << 20;
231 /* size specs not found */
232 strcpy(path, pathspec);
238 static fio_pmemblk_file_t pmb_open(const char *pathspec, int flags)
240 fio_pmemblk_file_t pmb;
245 pmb_parse_path(pathspec, &path, &bsize, &fsize);
249 pthread_mutex_lock(&CacheLock);
251 pmb = fio_pmemblk_cache_lookup(path);
253 /* load libpmemblk if needed */
255 if (load_libpmemblk(getenv("FIO_PMEMBLK_LIB")))
258 pmb = malloc(sizeof(*pmb));
262 /* try opening existing first, create it if needed */
263 pmb->pmb_pool = pmemblk_open(path, bsize);
264 if (!pmb->pmb_pool && (errno == ENOENT) &&
265 (flags & PMB_CREATE) && (0 < fsize) && (0 < bsize)) {
267 pmemblk_create(path, bsize, fsize, 0644);
269 if (!pmb->pmb_pool) {
271 ("fio: enable to open pmemblk pool file (errno %d)\n",
276 pmb->pmb_filename = path;
277 pmb->pmb_next = NULL;
279 pmb->pmb_bsize = pmemblk_bsize(pmb->pmb_pool);
280 pmb->pmb_nblocks = pmemblk_nblock(pmb->pmb_pool);
282 fio_pmemblk_cache_insert(pmb);
285 pmb->pmb_refcnt += 1;
287 pthread_mutex_unlock(&CacheLock);
294 pmemblk_close(pmb->pmb_pool);
295 pmb->pmb_pool = NULL;
296 pmb->pmb_filename = NULL;
302 pthread_mutex_unlock(&CacheLock);
306 static void pmb_close(fio_pmemblk_file_t pmb, const bool keep)
308 pthread_mutex_lock(&CacheLock);
312 if (!keep && !pmb->pmb_refcnt) {
313 pmemblk_close(pmb->pmb_pool);
314 pmb->pmb_pool = NULL;
315 free(pmb->pmb_filename);
316 pmb->pmb_filename = NULL;
317 fio_pmemblk_cache_remove(pmb);
321 pthread_mutex_unlock(&CacheLock);
324 static int pmb_get_flags(struct thread_data *td, uint64_t *pflags)
326 static int thread_warned = 0;
327 static int odirect_warned = 0;
331 if (!td->o.use_thread) {
332 if (!thread_warned) {
334 log_err("fio: must set thread=1 for pmemblk engine\n");
339 if (!td->o.odirect && !odirect_warned) {
341 log_info("fio: direct == 0, but pmemblk is always direct\n");
344 if (td->o.allow_create)
351 static int fio_pmemblk_open_file(struct thread_data *td, struct fio_file *f)
354 fio_pmemblk_file_t pmb;
356 if (pmb_get_flags(td, &flags))
359 pmb = pmb_open(f->file_name, flags);
363 FIOFILEPMBSET(f, pmb);
367 static int fio_pmemblk_close_file(struct thread_data fio_unused *td,
370 fio_pmemblk_file_t pmb = FIOFILEPMBGET(f);
373 pmb_close(pmb, false);
375 FIOFILEPMBSET(f, NULL);
379 static int fio_pmemblk_get_file_size(struct thread_data *td, struct fio_file *f)
382 fio_pmemblk_file_t pmb = FIOFILEPMBGET(f);
384 if (fio_file_size_known(f))
388 if (pmb_get_flags(td, &flags))
390 pmb = pmb_open(f->file_name, flags);
395 f->real_file_size = pmb->pmb_bsize * pmb->pmb_nblocks;
397 fio_file_set_size_known(f);
399 if (!FIOFILEPMBGET(f))
400 pmb_close(pmb, true);
405 static int fio_pmemblk_queue(struct thread_data *td, struct io_u *io_u)
407 struct fio_file *f = io_u->file;
408 fio_pmemblk_file_t pmb = FIOFILEPMBGET(f);
410 unsigned long long off;
413 int (*blkop) (PMEMblkpool *, void *, off_t) = (void *)pmemblk_write;
415 fio_ro_check(td, io_u);
417 switch (io_u->ddir) {
419 blkop = pmemblk_read;
423 len = io_u->xfer_buflen;
425 io_u->error = EINVAL;
426 if (off % pmb->pmb_bsize)
428 if (len % pmb->pmb_bsize)
430 if ((off + len) / pmb->pmb_bsize > pmb->pmb_nblocks)
434 buf = io_u->xfer_buf;
435 off /= pmb->pmb_bsize;
436 len /= pmb->pmb_bsize;
438 if (0 != blkop(pmb->pmb_pool, buf, off)) {
442 buf += pmb->pmb_bsize;
446 off *= pmb->pmb_bsize;
447 len *= pmb->pmb_bsize;
448 io_u->resid = io_u->xfer_buflen - (off - io_u->offset);
452 case DDIR_SYNC_FILE_RANGE:
453 /* we're always sync'd */
457 io_u->error = EINVAL;
461 return FIO_Q_COMPLETED;
464 static int fio_pmemblk_unlink_file(struct thread_data *td, struct fio_file *f)
471 * we need our own unlink in case the user has specified
472 * the block and file sizes in the path name. we parse
473 * the file_name to determine the file name we actually used.
476 pmb_parse_path(f->file_name, &path, &bsize, &fsize);
485 struct ioengine_ops ioengine = {
487 .version = FIO_IOOPS_VERSION,
488 .queue = fio_pmemblk_queue,
489 .open_file = fio_pmemblk_open_file,
490 .close_file = fio_pmemblk_close_file,
491 .get_file_size = fio_pmemblk_get_file_size,
492 .unlink_file = fio_pmemblk_unlink_file,
493 .flags = FIO_SYNCIO | FIO_DISKLESSIO | FIO_NOEXTEND | FIO_NODISKUTIL,
496 static void fio_init fio_pmemblk_register(void)
498 register_ioengine(&ioengine);
501 static void fio_exit fio_pmemblk_unregister(void)
503 unregister_ioengine(&ioengine);