4 * IO engine using libblkio to access various block I/O interfaces:
5 * https://gitlab.com/libblkio/libblkio
19 #include "../optgroup.h"
20 #include "../options.h"
23 /* per-thread state */
24 struct fio_blkio_data {
28 bool has_mem_region; /* whether mem_region is valid */
29 struct blkio_mem_region mem_region; /* only if allocated by libblkio */
31 struct blkio_completion *completions;
34 struct fio_blkio_options {
35 void *pad; /* option fields must not have offset 0 */
38 char *pre_connect_props;
39 char *pre_start_props;
42 static struct fio_option options[] = {
44 .name = "libblkio_driver",
45 .lname = "libblkio driver name",
46 .type = FIO_OPT_STR_STORE,
47 .off1 = offsetof(struct fio_blkio_options, driver),
48 .help = "Name of the driver to be used by libblkio",
49 .category = FIO_OPT_C_ENGINE,
50 .group = FIO_OPT_G_LIBBLKIO,
53 .name = "libblkio_pre_connect_props",
54 .lname = "Properties to be set before blkio_connect()",
55 .type = FIO_OPT_STR_STORE,
56 .off1 = offsetof(struct fio_blkio_options, pre_connect_props),
58 .category = FIO_OPT_C_ENGINE,
59 .group = FIO_OPT_G_LIBBLKIO,
62 .name = "libblkio_pre_start_props",
63 .lname = "Properties to be set before blkio_start()",
64 .type = FIO_OPT_STR_STORE,
65 .off1 = offsetof(struct fio_blkio_options, pre_start_props),
67 .category = FIO_OPT_C_ENGINE,
68 .group = FIO_OPT_G_LIBBLKIO,
75 static int fio_blkio_set_props_from_str(struct blkio *b, const char *opt_name,
78 char *new_str, *name, *value;
83 /* iteration can mutate string, so copy it */
84 new_str = strdup(str);
86 log_err("fio: strdup() failed\n");
90 /* iterate over property name-value pairs */
91 while ((name = get_next_str(&new_str))) {
92 /* split into property name and value */
93 value = strchr(name, '=');
95 log_err("fio: missing '=' in option %s\n", opt_name);
103 /* strip whitespace from property name */
104 strip_blank_front(&name);
105 strip_blank_end(name);
107 if (name[0] == '\0') {
108 log_err("fio: empty property name in option %s\n",
114 /* strip whitespace from property value */
115 strip_blank_front(&value);
116 strip_blank_end(value);
119 if (blkio_set_str(b, name, value) != 0) {
120 log_err("fio: error setting property '%s' to '%s': %s\n",
121 name, value, blkio_get_error_msg());
132 * Log the failure of a libblkio function.
134 * `(void)func` is to ensure `func` exists and prevent typos
136 #define fio_blkio_log_err(func) \
139 log_err("fio: %s() failed: %s\n", #func, \
140 blkio_get_error_msg()); \
143 static int fio_blkio_create_and_connect(struct thread_data *td,
144 struct blkio **out_blkio)
146 const struct fio_blkio_options *options = td->eo;
150 if (!options->driver) {
151 log_err("fio: engine libblkio requires option libblkio_driver to be set\n");
155 if (blkio_create(options->driver, &b) != 0) {
156 fio_blkio_log_err(blkio_create);
160 /* don't fail if driver doesn't have a "direct" property */
161 ret = blkio_set_bool(b, "direct", td->o.odirect);
162 if (ret != 0 && ret != -ENOENT) {
163 fio_blkio_log_err(blkio_set_bool);
164 goto err_blkio_destroy;
167 if (blkio_set_bool(b, "read-only", read_only) != 0) {
168 fio_blkio_log_err(blkio_set_bool);
169 goto err_blkio_destroy;
172 if (fio_blkio_set_props_from_str(b, "libblkio_pre_connect_props",
173 options->pre_connect_props) != 0)
174 goto err_blkio_destroy;
176 if (blkio_connect(b) != 0) {
177 fio_blkio_log_err(blkio_connect);
178 goto err_blkio_destroy;
181 if (fio_blkio_set_props_from_str(b, "libblkio_pre_start_props",
182 options->pre_start_props) != 0)
183 goto err_blkio_destroy;
194 * This callback determines the device/file size, so it creates and connects a
195 * blkio instance. But it is invoked from the main thread in the original fio
196 * process, not from the processes in which jobs will actually run. It thus
197 * subsequently destroys the blkio, which is recreated in the init() callback.
199 static int fio_blkio_setup(struct thread_data *td)
205 assert(td->files_index == 1);
207 if (fio_blkio_create_and_connect(td, &b) != 0)
210 if (blkio_get_uint64(b, "capacity", &capacity) != 0) {
211 fio_blkio_log_err(blkio_get_uint64);
213 goto out_blkio_destroy;
216 td->files[0]->real_file_size = capacity;
217 fio_file_set_size_known(td->files[0]);
224 static int fio_blkio_init(struct thread_data *td)
226 struct fio_blkio_data *data;
229 * Request enqueueing is fast, and it's not possible to know exactly
230 * when a request is submitted, so never report submission latencies.
232 td->o.disable_slat = 1;
234 data = calloc(1, sizeof(*data));
236 log_err("fio: calloc() failed\n");
240 data->completions = calloc(td->o.iodepth, sizeof(data->completions[0]));
241 if (!data->completions) {
242 log_err("fio: calloc() failed\n");
246 if (fio_blkio_create_and_connect(td, &data->b) != 0)
249 if (blkio_set_int(data->b, "num-queues", 1) != 0) {
250 fio_blkio_log_err(blkio_set_int);
251 goto err_blkio_destroy;
254 if (blkio_start(data->b) != 0) {
255 fio_blkio_log_err(blkio_start);
256 goto err_blkio_destroy;
259 data->q = blkio_get_queue(data->b, 0);
261 /* Set data last so cleanup() does nothing if init() fails. */
262 td->io_ops_data = data;
267 blkio_destroy(&data->b);
269 free(data->completions);
274 static int fio_blkio_post_init(struct thread_data *td)
276 struct fio_blkio_data *data = td->io_ops_data;
278 if (!data->has_mem_region) {
280 * Memory was allocated by the fio core and not iomem_alloc(),
281 * so we need to register it as a memory region here.
283 * `td->orig_buffer_size` is computed like `len` below, but then
284 * fio can add some padding to it to make sure it is
285 * sufficiently aligned to the page size and the mem_align
286 * option. However, this can make it become unaligned to the
287 * "mem-region-alignment" property in ways that the user can't
288 * control, so we essentially recompute `td->orig_buffer_size`
289 * here but without adding that padding.
292 unsigned long long max_block_size;
293 struct blkio_mem_region region;
295 max_block_size = max(td->o.max_bs[DDIR_READ],
296 max(td->o.max_bs[DDIR_WRITE],
297 td->o.max_bs[DDIR_TRIM]));
299 region = (struct blkio_mem_region) {
300 .addr = td->orig_buffer,
301 .len = (size_t)max_block_size *
302 (size_t)td->o.iodepth,
306 if (blkio_map_mem_region(data->b, ®ion) != 0) {
307 fio_blkio_log_err(blkio_map_mem_region);
315 static void fio_blkio_cleanup(struct thread_data *td)
317 struct fio_blkio_data *data = td->io_ops_data;
320 blkio_destroy(&data->b);
321 free(data->completions);
326 #define align_up(x, y) ((((x) + (y) - 1) / (y)) * (y))
328 static int fio_blkio_iomem_alloc(struct thread_data *td, size_t size)
330 struct fio_blkio_data *data = td->io_ops_data;
332 uint64_t mem_region_alignment;
334 if (blkio_get_uint64(data->b, "mem-region-alignment",
335 &mem_region_alignment) != 0) {
336 fio_blkio_log_err(blkio_get_uint64);
340 /* round up size to satisfy mem-region-alignment */
341 size = align_up(size, (size_t)mem_region_alignment);
343 if (blkio_alloc_mem_region(data->b, &data->mem_region, size) != 0) {
344 fio_blkio_log_err(blkio_alloc_mem_region);
349 if (blkio_map_mem_region(data->b, &data->mem_region) != 0) {
350 fio_blkio_log_err(blkio_map_mem_region);
355 td->orig_buffer = data->mem_region.addr;
356 data->has_mem_region = true;
362 blkio_free_mem_region(data->b, &data->mem_region);
367 static void fio_blkio_iomem_free(struct thread_data *td)
369 struct fio_blkio_data *data = td->io_ops_data;
371 if (data && data->has_mem_region) {
372 blkio_unmap_mem_region(data->b, &data->mem_region);
373 blkio_free_mem_region(data->b, &data->mem_region);
375 data->has_mem_region = false;
379 static int fio_blkio_open_file(struct thread_data *td, struct fio_file *f)
384 static enum fio_q_status fio_blkio_queue(struct thread_data *td,
387 struct fio_blkio_data *data = td->io_ops_data;
389 fio_ro_check(td, io_u);
391 switch (io_u->ddir) {
393 blkioq_read(data->q, io_u->offset, io_u->xfer_buf,
394 (size_t)io_u->xfer_buflen, io_u, 0);
397 blkioq_write(data->q, io_u->offset, io_u->xfer_buf,
398 (size_t)io_u->xfer_buflen, io_u, 0);
401 blkioq_discard(data->q, io_u->offset, io_u->xfer_buflen,
406 blkioq_flush(data->q, io_u, 0);
409 io_u->error = ENOTSUP;
410 io_u_log_error(td, io_u);
411 return FIO_Q_COMPLETED;
417 static int fio_blkio_getevents(struct thread_data *td, unsigned int min,
418 unsigned int max, const struct timespec *t)
420 struct fio_blkio_data *data = td->io_ops_data;
423 n = blkioq_do_io(data->q, data->completions, (int)min, (int)max, NULL);
425 fio_blkio_log_err(blkioq_do_io);
432 static struct io_u *fio_blkio_event(struct thread_data *td, int event)
434 struct fio_blkio_data *data = td->io_ops_data;
435 struct blkio_completion *completion = &data->completions[event];
436 struct io_u *io_u = completion->user_data;
438 io_u->error = -completion->ret;
443 FIO_STATIC struct ioengine_ops ioengine = {
445 .version = FIO_IOOPS_VERSION,
446 .flags = FIO_DISKLESSIO | FIO_NOEXTEND |
447 FIO_NO_OFFLOAD | FIO_SKIPPABLE_IOMEM_ALLOC,
449 .setup = fio_blkio_setup,
450 .init = fio_blkio_init,
451 .post_init = fio_blkio_post_init,
452 .cleanup = fio_blkio_cleanup,
454 .iomem_alloc = fio_blkio_iomem_alloc,
455 .iomem_free = fio_blkio_iomem_free,
457 .open_file = fio_blkio_open_file,
459 .queue = fio_blkio_queue,
460 .getevents = fio_blkio_getevents,
461 .event = fio_blkio_event,
464 .option_struct_size = sizeof(struct fio_blkio_options),
467 static void fio_init fio_blkio_register(void)
469 register_ioengine(&ioengine);
472 static void fio_exit fio_blkio_unregister(void)
474 unregister_ioengine(&ioengine);