engines/libaio.c

   1 /*
   2  * libaio engine
   3  *
   4  * IO engine using the Linux native aio interface.
   5  *
   6  */
   7 #include <stdlib.h>
   8 #include <unistd.h>
   9 #include <errno.h>
  10 #include <libaio.h>
  11 #include <sys/time.h>
  12 #include <sys/resource.h>
  13
  14 #include "../fio.h"
  15 #include "../lib/pow2.h"
  16 #include "../optgroup.h"
  17 #include "../lib/memalign.h"
  18 #include "cmdprio.h"
  19
  20 /* Should be defined in newest aio_abi.h */
  21 #ifndef IOCB_FLAG_IOPRIO
  22 #define IOCB_FLAG_IOPRIO    (1 << 1)
  23 #endif
  24
  25 /* Hack for libaio < 0.3.111 */
  26 #ifndef CONFIG_LIBAIO_RW_FLAGS
  27 #define aio_rw_flags __pad2
  28 #endif
  29
  30 static int fio_libaio_commit(struct thread_data *td);
  31 static int fio_libaio_init(struct thread_data *td);
  32
  33 struct libaio_data {
  34         io_context_t aio_ctx;
  35         struct io_event *aio_events;
  36         struct iocb **iocbs;
  37         struct io_u **io_us;
  38
  39         struct io_u **io_u_index;
  40
  41         /*
  42          * Basic ring buffer. 'head' is incremented in _queue(), and
  43          * 'tail' is incremented in _commit(). We keep 'queued' so
  44          * that we know if the ring is full or empty, when
  45          * 'head' == 'tail'. 'entries' is the ring size, and
  46          * 'is_pow2' is just an optimization to use AND instead of
  47          * modulus to get the remainder on ring increment.
  48          */
  49         int is_pow2;
  50         unsigned int entries;
  51         unsigned int queued;
  52         unsigned int head;
  53         unsigned int tail;
  54
  55         struct cmdprio cmdprio;
  56 };
  57
  58 struct libaio_options {
  59         struct thread_data *td;
  60         unsigned int userspace_reap;
  61         struct cmdprio_options cmdprio_options;
  62         unsigned int nowait;
  63 };
  64
  65 static struct fio_option options[] = {
  66         {
  67                 .name   = "userspace_reap",
  68                 .lname  = "Libaio userspace reaping",
  69                 .type   = FIO_OPT_STR_SET,
  70                 .off1   = offsetof(struct libaio_options, userspace_reap),
  71                 .help   = "Use alternative user-space reap implementation",
  72                 .category = FIO_OPT_C_ENGINE,
  73                 .group  = FIO_OPT_G_LIBAIO,
  74         },
  75 #ifdef FIO_HAVE_IOPRIO_CLASS
  76         {
  77                 .name   = "cmdprio_percentage",
  78                 .lname  = "high priority percentage",
  79                 .type   = FIO_OPT_INT,
  80                 .off1   = offsetof(struct libaio_options,
  81                                    cmdprio_options.percentage[DDIR_READ]),
  82                 .off2   = offsetof(struct libaio_options,
  83                                    cmdprio_options.percentage[DDIR_WRITE]),
  84                 .minval = 0,
  85                 .maxval = 100,
  86                 .help   = "Send high priority I/O this percentage of the time",
  87                 .category = FIO_OPT_C_ENGINE,
  88                 .group  = FIO_OPT_G_LIBAIO,
  89         },
  90         {
  91                 .name   = "cmdprio_class",
  92                 .lname  = "Asynchronous I/O priority class",
  93                 .type   = FIO_OPT_INT,
  94                 .off1   = offsetof(struct libaio_options,
  95                                    cmdprio_options.class[DDIR_READ]),
  96                 .off2   = offsetof(struct libaio_options,
  97                                    cmdprio_options.class[DDIR_WRITE]),
  98                 .help   = "Set asynchronous IO priority class",
  99                 .minval = IOPRIO_MIN_PRIO_CLASS + 1,
 100                 .maxval = IOPRIO_MAX_PRIO_CLASS,
 101                 .interval = 1,
 102                 .category = FIO_OPT_C_ENGINE,
 103                 .group  = FIO_OPT_G_LIBAIO,
 104         },
 105         {
 106                 .name   = "cmdprio",
 107                 .lname  = "Asynchronous I/O priority level",
 108                 .type   = FIO_OPT_INT,
 109                 .off1   = offsetof(struct libaio_options,
 110                                    cmdprio_options.level[DDIR_READ]),
 111                 .off2   = offsetof(struct libaio_options,
 112                                    cmdprio_options.level[DDIR_WRITE]),
 113                 .help   = "Set asynchronous IO priority level",
 114                 .minval = IOPRIO_MIN_PRIO,
 115                 .maxval = IOPRIO_MAX_PRIO,
 116                 .interval = 1,
 117                 .category = FIO_OPT_C_ENGINE,
 118                 .group  = FIO_OPT_G_LIBAIO,
 119         },
 120         {
 121                 .name   = "cmdprio_bssplit",
 122                 .lname  = "Priority percentage block size split",
 123                 .type   = FIO_OPT_STR_STORE,
 124                 .off1   = offsetof(struct libaio_options,
 125                                    cmdprio_options.bssplit_str),
 126                 .help   = "Set priority percentages for different block sizes",
 127                 .category = FIO_OPT_C_ENGINE,
 128                 .group  = FIO_OPT_G_LIBAIO,
 129         },
 130 #else
 131         {
 132                 .name   = "cmdprio_percentage",
 133                 .lname  = "high priority percentage",
 134                 .type   = FIO_OPT_UNSUPPORTED,
 135                 .help   = "Your platform does not support I/O priority classes",
 136         },
 137         {
 138                 .name   = "cmdprio_class",
 139                 .lname  = "Asynchronous I/O priority class",
 140                 .type   = FIO_OPT_UNSUPPORTED,
 141                 .help   = "Your platform does not support I/O priority classes",
 142         },
 143         {
 144                 .name   = "cmdprio",
 145                 .lname  = "Asynchronous I/O priority level",
 146                 .type   = FIO_OPT_UNSUPPORTED,
 147                 .help   = "Your platform does not support I/O priority classes",
 148         },
 149         {
 150                 .name   = "cmdprio_bssplit",
 151                 .lname  = "Priority percentage block size split",
 152                 .type   = FIO_OPT_UNSUPPORTED,
 153                 .help   = "Your platform does not support I/O priority classes",
 154         },
 155 #endif
 156         {
 157                 .name   = "nowait",
 158                 .lname  = "RWF_NOWAIT",
 159                 .type   = FIO_OPT_BOOL,
 160                 .off1   = offsetof(struct libaio_options, nowait),
 161                 .help   = "Set RWF_NOWAIT for reads/writes",
 162                 .category = FIO_OPT_C_ENGINE,
 163                 .group  = FIO_OPT_G_LIBAIO,
 164         },
 165         {
 166                 .name   = NULL,
 167         },
 168 };
 169
 170 static inline void ring_inc(struct libaio_data *ld, unsigned int *val,
 171                             unsigned int add)
 172 {
 173         if (ld->is_pow2)
 174                 *val = (*val + add) & (ld->entries - 1);
 175         else
 176                 *val = (*val + add) % ld->entries;
 177 }
 178
 179 static int fio_libaio_prep(struct thread_data *td, struct io_u *io_u)
 180 {
 181         struct libaio_options *o = td->eo;
 182         struct fio_file *f = io_u->file;
 183         struct iocb *iocb = &io_u->iocb;
 184
 185         if (io_u->ddir == DDIR_READ) {
 186                 io_prep_pread(iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
 187                 if (o->nowait)
 188                         iocb->aio_rw_flags |= RWF_NOWAIT;
 189         } else if (io_u->ddir == DDIR_WRITE) {
 190                 io_prep_pwrite(iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
 191                 if (o->nowait)
 192                         iocb->aio_rw_flags |= RWF_NOWAIT;
 193         } else if (ddir_sync(io_u->ddir))
 194                 io_prep_fsync(iocb, f->fd);
 195
 196         return 0;
 197 }
 198
 199 static inline void fio_libaio_cmdprio_prep(struct thread_data *td,
 200                                            struct io_u *io_u)
 201 {
 202         struct libaio_data *ld = td->io_ops_data;
 203         struct cmdprio *cmdprio = &ld->cmdprio;
 204
 205         if (fio_cmdprio_set_ioprio(td, cmdprio, io_u)) {
 206                 io_u->iocb.aio_reqprio = io_u->ioprio;
 207                 io_u->iocb.u.c.flags |= IOCB_FLAG_IOPRIO;
 208         }
 209 }
 210
 211 static struct io_u *fio_libaio_event(struct thread_data *td, int event)
 212 {
 213         struct libaio_data *ld = td->io_ops_data;
 214         struct io_event *ev;
 215         struct io_u *io_u;
 216
 217         ev = ld->aio_events + event;
 218         io_u = container_of(ev->obj, struct io_u, iocb);
 219
 220         if (ev->res != io_u->xfer_buflen) {
 221                 if (ev->res > io_u->xfer_buflen)
 222                         io_u->error = -ev->res;
 223                 else
 224                         io_u->resid = io_u->xfer_buflen - ev->res;
 225         } else
 226                 io_u->error = 0;
 227
 228         return io_u;
 229 }
 230
 231 struct aio_ring {
 232         unsigned id;             /** kernel internal index number */
 233         unsigned nr;             /** number of io_events */
 234         unsigned head;
 235         unsigned tail;
 236
 237         unsigned magic;
 238         unsigned compat_features;
 239         unsigned incompat_features;
 240         unsigned header_length; /** size of aio_ring */
 241
 242         struct io_event events[0];
 243 };
 244
 245 #define AIO_RING_MAGIC  0xa10a10a1
 246
 247 static int user_io_getevents(io_context_t aio_ctx, unsigned int max,
 248                              struct io_event *events)
 249 {
 250         long i = 0;
 251         unsigned head;
 252         struct aio_ring *ring = (struct aio_ring*) aio_ctx;
 253
 254         while (i < max) {
 255                 head = ring->head;
 256
 257                 if (head == ring->tail) {
 258                         /* There are no more completions */
 259                         break;
 260                 } else {
 261                         /* There is another completion to reap */
 262                         events[i] = ring->events[head];
 263                         atomic_store_release(&ring->head,
 264                                              (head + 1) % ring->nr);
 265                         i++;
 266                 }
 267         }
 268
 269         return i;
 270 }
 271
 272 static int fio_libaio_getevents(struct thread_data *td, unsigned int min,
 273                                 unsigned int max, const struct timespec *t)
 274 {
 275         struct libaio_data *ld = td->io_ops_data;
 276         struct libaio_options *o = td->eo;
 277         unsigned actual_min = td->o.iodepth_batch_complete_min == 0 ? 0 : min;
 278         struct timespec __lt, *lt = NULL;
 279         int r, events = 0;
 280
 281         if (t) {
 282                 __lt = *t;
 283                 lt = &__lt;
 284         }
 285
 286         do {
 287                 if (o->userspace_reap == 1
 288                     && actual_min == 0
 289                     && ((struct aio_ring *)(ld->aio_ctx))->magic
 290                                 == AIO_RING_MAGIC) {
 291                         r = user_io_getevents(ld->aio_ctx, max,
 292                                 ld->aio_events + events);
 293                 } else {
 294                         r = io_getevents(ld->aio_ctx, actual_min,
 295                                 max, ld->aio_events + events, lt);
 296                 }
 297                 if (r > 0)
 298                         events += r;
 299                 else if ((min && r == 0) || r == -EAGAIN) {
 300                         fio_libaio_commit(td);
 301                         if (actual_min)
 302                                 usleep(10);
 303                 } else if (r != -EINTR)
 304                         break;
 305         } while (events < min);
 306
 307         return r < 0 ? r : events;
 308 }
 309
 310 static enum fio_q_status fio_libaio_queue(struct thread_data *td,
 311                                           struct io_u *io_u)
 312 {
 313         struct libaio_data *ld = td->io_ops_data;
 314
 315         fio_ro_check(td, io_u);
 316
 317         if (ld->queued == td->o.iodepth)
 318                 return FIO_Q_BUSY;
 319
 320         /*
 321          * fsync is tricky, since it can fail and we need to do it
 322          * serialized with other io. the reason is that linux doesn't
 323          * support aio fsync yet. So return busy for the case where we
 324          * have pending io, to let fio complete those first.
 325          */
 326         if (ddir_sync(io_u->ddir)) {
 327                 if (ld->queued)
 328                         return FIO_Q_BUSY;
 329
 330                 do_io_u_sync(td, io_u);
 331                 return FIO_Q_COMPLETED;
 332         }
 333
 334         if (io_u->ddir == DDIR_TRIM) {
 335                 if (ld->queued)
 336                         return FIO_Q_BUSY;
 337
 338                 do_io_u_trim(td, io_u);
 339                 io_u_mark_submit(td, 1);
 340                 io_u_mark_complete(td, 1);
 341                 return FIO_Q_COMPLETED;
 342         }
 343
 344         if (ld->cmdprio.mode != CMDPRIO_MODE_NONE)
 345                 fio_libaio_cmdprio_prep(td, io_u);
 346
 347         ld->iocbs[ld->head] = &io_u->iocb;
 348         ld->io_us[ld->head] = io_u;
 349         ring_inc(ld, &ld->head, 1);
 350         ld->queued++;
 351         return FIO_Q_QUEUED;
 352 }
 353
 354 static void fio_libaio_queued(struct thread_data *td, struct io_u **io_us,
 355                               unsigned int nr)
 356 {
 357         struct timespec now;
 358         unsigned int i;
 359
 360         if (!fio_fill_issue_time(td))
 361                 return;
 362
 363         fio_gettime(&now, NULL);
 364
 365         for (i = 0; i < nr; i++) {
 366                 struct io_u *io_u = io_us[i];
 367
 368                 memcpy(&io_u->issue_time, &now, sizeof(now));
 369                 io_u_queued(td, io_u);
 370         }
 371
 372         /*
 373          * only used for iolog
 374          */
 375         if (td->o.read_iolog_file)
 376                 memcpy(&td->last_issue, &now, sizeof(now));
 377 }
 378
 379 static int fio_libaio_commit(struct thread_data *td)
 380 {
 381         struct libaio_data *ld = td->io_ops_data;
 382         struct iocb **iocbs;
 383         struct io_u **io_us;
 384         struct timespec ts;
 385         int ret, wait_start = 0;
 386
 387         if (!ld->queued)
 388                 return 0;
 389
 390         do {
 391                 long nr = ld->queued;
 392
 393                 nr = min((unsigned int) nr, ld->entries - ld->tail);
 394                 io_us = ld->io_us + ld->tail;
 395                 iocbs = ld->iocbs + ld->tail;
 396
 397                 ret = io_submit(ld->aio_ctx, nr, iocbs);
 398                 if (ret > 0) {
 399                         fio_libaio_queued(td, io_us, ret);
 400                         io_u_mark_submit(td, ret);
 401
 402                         ld->queued -= ret;
 403                         ring_inc(ld, &ld->tail, ret);
 404                         ret = 0;
 405                         wait_start = 0;
 406                 } else if (ret == -EINTR || !ret) {
 407                         if (!ret)
 408                                 io_u_mark_submit(td, ret);
 409                         wait_start = 0;
 410                         continue;
 411                 } else if (ret == -EAGAIN) {
 412                         /*
 413                          * If we get EAGAIN, we should break out without
 414                          * error and let the upper layer reap some
 415                          * events for us. If we have no queued IO, we
 416                          * must loop here. If we loop for more than 30s,
 417                          * just error out, something must be buggy in the
 418                          * IO path.
 419                          */
 420                         if (ld->queued) {
 421                                 ret = 0;
 422                                 break;
 423                         }
 424                         if (!wait_start) {
 425                                 fio_gettime(&ts, NULL);
 426                                 wait_start = 1;
 427                         } else if (mtime_since_now(&ts) > 30000) {
 428                                 log_err("fio: aio appears to be stalled, giving up\n");
 429                                 break;
 430                         }
 431                         usleep(1);
 432                         continue;
 433                 } else if (ret == -ENOMEM) {
 434                         /*
 435                          * If we get -ENOMEM, reap events if we can. If
 436                          * we cannot, treat it as a fatal event since there's
 437                          * nothing we can do about it.
 438                          */
 439                         if (ld->queued)
 440                                 ret = 0;
 441                         break;
 442                 } else
 443                         break;
 444         } while (ld->queued);
 445
 446         return ret;
 447 }
 448
 449 static int fio_libaio_cancel(struct thread_data *td, struct io_u *io_u)
 450 {
 451         struct libaio_data *ld = td->io_ops_data;
 452
 453         return io_cancel(ld->aio_ctx, &io_u->iocb, ld->aio_events);
 454 }
 455
 456 static void fio_libaio_cleanup(struct thread_data *td)
 457 {
 458         struct libaio_data *ld = td->io_ops_data;
 459
 460         if (ld) {
 461                 /*
 462                  * Work-around to avoid huge RCU stalls at exit time. If we
 463                  * don't do this here, then it'll be torn down by exit_aio().
 464                  * But for that case we can parallellize the freeing, thus
 465                  * speeding it up a lot.
 466                  */
 467                 if (!(td->flags & TD_F_CHILD))
 468                         io_destroy(ld->aio_ctx);
 469
 470                 fio_cmdprio_cleanup(&ld->cmdprio);
 471                 free(ld->aio_events);
 472                 free(ld->iocbs);
 473                 free(ld->io_us);
 474                 free(ld);
 475         }
 476 }
 477
 478 static int fio_libaio_post_init(struct thread_data *td)
 479 {
 480         struct libaio_data *ld = td->io_ops_data;
 481         int err;
 482
 483         err = io_queue_init(td->o.iodepth, &ld->aio_ctx);
 484         if (err) {
 485                 td_verror(td, -err, "io_queue_init");
 486                 return 1;
 487         }
 488
 489         return 0;
 490 }
 491
 492 static int fio_libaio_init(struct thread_data *td)
 493 {
 494         struct libaio_data *ld;
 495         struct libaio_options *o = td->eo;
 496         int ret;
 497
 498         ld = calloc(1, sizeof(*ld));
 499
 500         ld->entries = td->o.iodepth;
 501         ld->is_pow2 = is_power_of_2(ld->entries);
 502         ld->aio_events = calloc(ld->entries, sizeof(struct io_event));
 503         ld->iocbs = calloc(ld->entries, sizeof(struct iocb *));
 504         ld->io_us = calloc(ld->entries, sizeof(struct io_u *));
 505
 506         td->io_ops_data = ld;
 507
 508         ret = fio_cmdprio_init(td, &ld->cmdprio, &o->cmdprio_options);
 509         if (ret) {
 510                 td_verror(td, EINVAL, "fio_libaio_init");
 511                 return 1;
 512         }
 513
 514         return 0;
 515 }
 516
 517 FIO_STATIC struct ioengine_ops ioengine = {
 518         .name                   = "libaio",
 519         .version                = FIO_IOOPS_VERSION,
 520         .flags                  = FIO_ASYNCIO_SYNC_TRIM |
 521                                         FIO_ASYNCIO_SETS_ISSUE_TIME,
 522         .init                   = fio_libaio_init,
 523         .post_init              = fio_libaio_post_init,
 524         .prep                   = fio_libaio_prep,
 525         .queue                  = fio_libaio_queue,
 526         .commit                 = fio_libaio_commit,
 527         .cancel                 = fio_libaio_cancel,
 528         .getevents              = fio_libaio_getevents,
 529         .event                  = fio_libaio_event,
 530         .cleanup                = fio_libaio_cleanup,
 531         .open_file              = generic_open_file,
 532         .close_file             = generic_close_file,
 533         .get_file_size          = generic_get_file_size,
 534         .options                = options,
 535         .option_struct_size     = sizeof(struct libaio_options),
 536 };
 537
 538 static void fio_init fio_libaio_register(void)
 539 {
 540         register_ioengine(&ioengine);
 541 }
 542
 543 static void fio_exit fio_libaio_unregister(void)
 544 {
 545         unregister_ioengine(&ioengine);
 546 }