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