io_u.c

   1 #include <unistd.h>
   2 #include <fcntl.h>
   3 #include <string.h>
   4 #include <signal.h>
   5 #include <time.h>
   6 #include <assert.h>
   7
   8 #include "fio.h"
   9 #include "os.h"
  10
  11 /*
  12  * Change this define to play with the timeout handling
  13  */
  14 #undef FIO_USE_TIMEOUT
  15
  16 struct io_completion_data {
  17         int nr;                         /* input */
  18
  19         int error;                      /* output */
  20         unsigned long bytes_done[2];    /* output */
  21         struct timeval time;            /* output */
  22 };
  23
  24 /*
  25  * The ->file_map[] contains a map of blocks we have or have not done io
  26  * to yet. Used to make sure we cover the entire range in a fair fashion.
  27  */
  28 static int random_map_free(struct thread_data *td, struct fio_file *f,
  29                            unsigned long long block)
  30 {
  31         unsigned int idx = RAND_MAP_IDX(td, f, block);
  32         unsigned int bit = RAND_MAP_BIT(td, f, block);
  33
  34         return (f->file_map[idx] & (1UL << bit)) == 0;
  35 }
  36
  37 /*
  38  * Mark a given offset as used in the map.
  39  */
  40 static void mark_random_map(struct thread_data *td, struct io_u *io_u)
  41 {
  42         unsigned int min_bs = td->rw_min_bs;
  43         struct fio_file *f = io_u->file;
  44         unsigned long long block;
  45         unsigned int blocks;
  46         unsigned int nr_blocks;
  47
  48         block = io_u->offset / (unsigned long long) min_bs;
  49         blocks = 0;
  50         nr_blocks = (io_u->buflen + min_bs - 1) / min_bs;
  51
  52         while (blocks < nr_blocks) {
  53                 unsigned int idx, bit;
  54
  55                 if (!random_map_free(td, f, block))
  56                         break;
  57
  58                 idx = RAND_MAP_IDX(td, f, block);
  59                 bit = RAND_MAP_BIT(td, f, block);
  60
  61                 fio_assert(td, idx < f->num_maps);
  62
  63                 f->file_map[idx] |= (1UL << bit);
  64                 block++;
  65                 blocks++;
  66         }
  67
  68         if ((blocks * min_bs) < io_u->buflen)
  69                 io_u->buflen = blocks * min_bs;
  70 }
  71
  72 /*
  73  * Return the next free block in the map.
  74  */
  75 static int get_next_free_block(struct thread_data *td, struct fio_file *f,
  76                                unsigned long long *b)
  77 {
  78         int i;
  79
  80         i = f->last_free_lookup;
  81         *b = (i * BLOCKS_PER_MAP);
  82         while ((*b) * td->rw_min_bs < f->real_file_size) {
  83                 if (f->file_map[i] != -1UL) {
  84                         *b += ffz(f->file_map[i]);
  85                         f->last_free_lookup = i;
  86                         return 0;
  87                 }
  88
  89                 *b += BLOCKS_PER_MAP;
  90                 i++;
  91         }
  92
  93         return 1;
  94 }
  95
  96 /*
  97  * For random io, generate a random new block and see if it's used. Repeat
  98  * until we find a free one. For sequential io, just return the end of
  99  * the last io issued.
 100  */
 101 static int get_next_offset(struct thread_data *td, struct io_u *io_u)
 102 {
 103         struct fio_file *f = io_u->file;
 104         const int ddir = io_u->ddir;
 105         unsigned long long b, rb;
 106         long r;
 107
 108         if (td_random(td)) {
 109                 unsigned long long max_blocks = f->file_size / td->min_bs[ddir];
 110                 int loops = 5;
 111
 112                 do {
 113                         r = os_random_long(&td->random_state);
 114                         b = ((max_blocks - 1) * r / (unsigned long long) (RAND_MAX+1.0));
 115                         if (td->norandommap)
 116                                 break;
 117                         rb = b + (f->file_offset / td->min_bs[ddir]);
 118                         loops--;
 119                 } while (!random_map_free(td, f, rb) && loops);
 120
 121                 /*
 122                  * if we failed to retrieve a truly random offset within
 123                  * the loops assigned, see if there are free ones left at all
 124                  */
 125                 if (!loops && get_next_free_block(td, f, &b))
 126                         return 1;
 127         } else
 128                 b = f->last_pos / td->min_bs[ddir];
 129
 130         io_u->offset = (b * td->min_bs[ddir]) + f->file_offset;
 131         if (io_u->offset >= f->real_file_size)
 132                 return 1;
 133
 134         return 0;
 135 }
 136
 137 static unsigned int get_next_buflen(struct thread_data *td, struct io_u *io_u)
 138 {
 139         struct fio_file *f = io_u->file;
 140         const int ddir = io_u->ddir;
 141         unsigned int buflen;
 142         long r;
 143
 144         if (td->min_bs[ddir] == td->max_bs[ddir])
 145                 buflen = td->min_bs[ddir];
 146         else {
 147                 r = os_random_long(&td->bsrange_state);
 148                 buflen = (unsigned int) (1 + (double) (td->max_bs[ddir] - 1) * r / (RAND_MAX + 1.0));
 149                 if (!td->bs_unaligned)
 150                         buflen = (buflen + td->min_bs[ddir] - 1) & ~(td->min_bs[ddir] - 1);
 151         }
 152
 153         while (buflen + io_u->offset > f->real_file_size) {
 154                 if (buflen == td->min_bs[ddir])
 155                         return 0;
 156
 157                 buflen = td->min_bs[ddir];
 158         }
 159
 160         return buflen;
 161 }
 162
 163 /*
 164  * Return the data direction for the next io_u. If the job is a
 165  * mixed read/write workload, check the rwmix cycle and switch if
 166  * necessary.
 167  */
 168 static enum fio_ddir get_rw_ddir(struct thread_data *td)
 169 {
 170         if (td_rw(td)) {
 171                 struct timeval now;
 172                 unsigned long elapsed;
 173
 174                 fio_gettime(&now, NULL);
 175                 elapsed = mtime_since_now(&td->rwmix_switch);
 176
 177                 /*
 178                  * Check if it's time to seed a new data direction.
 179                  */
 180                 if (elapsed >= td->rwmixcycle) {
 181                         unsigned int v;
 182                         long r;
 183
 184                         r = os_random_long(&td->rwmix_state);
 185                         v = 1 + (int) (100.0 * (r / (RAND_MAX + 1.0)));
 186                         if (v < td->rwmixread)
 187                                 td->rwmix_ddir = DDIR_READ;
 188                         else
 189                                 td->rwmix_ddir = DDIR_WRITE;
 190                         memcpy(&td->rwmix_switch, &now, sizeof(now));
 191                 }
 192                 return td->rwmix_ddir;
 193         } else if (td_read(td))
 194                 return DDIR_READ;
 195         else
 196                 return DDIR_WRITE;
 197 }
 198
 199 void put_io_u(struct thread_data *td, struct io_u *io_u)
 200 {
 201         assert((io_u->flags & IO_U_F_FREE) == 0);
 202         io_u->flags |= IO_U_F_FREE;
 203
 204         io_u->file = NULL;
 205         list_del(&io_u->list);
 206         list_add(&io_u->list, &td->io_u_freelist);
 207         td->cur_depth--;
 208 }
 209
 210 void requeue_io_u(struct thread_data *td, struct io_u **io_u)
 211 {
 212         struct io_u *__io_u = *io_u;
 213
 214         __io_u->flags |= IO_U_F_FREE;
 215         __io_u->flags &= ~IO_U_F_FLIGHT;
 216
 217         list_del(&__io_u->list);
 218         list_add_tail(&__io_u->list, &td->io_u_requeues);
 219         td->cur_depth--;
 220         *io_u = NULL;
 221 }
 222
 223 static int fill_io_u(struct thread_data *td, struct io_u *io_u)
 224 {
 225         /*
 226          * If using an iolog, grab next piece if any available.
 227          */
 228         if (td->read_iolog)
 229                 return read_iolog_get(td, io_u);
 230
 231         /*
 232          * see if it's time to sync
 233          */
 234         if (td->fsync_blocks && !(td->io_issues[DDIR_WRITE] % td->fsync_blocks)
 235             && td->io_issues[DDIR_WRITE] && should_fsync(td)) {
 236                 io_u->ddir = DDIR_SYNC;
 237                 return 0;
 238         }
 239
 240         io_u->ddir = get_rw_ddir(td);
 241
 242         /*
 243          * No log, let the seq/rand engine retrieve the next buflen and
 244          * position.
 245          */
 246         if (get_next_offset(td, io_u))
 247                 return 1;
 248
 249         io_u->buflen = get_next_buflen(td, io_u);
 250         if (!io_u->buflen)
 251                 return 1;
 252
 253         /*
 254          * mark entry before potentially trimming io_u
 255          */
 256         if (!td->read_iolog && td_random(td) && !td->norandommap)
 257                 mark_random_map(td, io_u);
 258
 259         /*
 260          * If using a write iolog, store this entry.
 261          */
 262         if (td->write_iolog_file)
 263                 write_iolog_put(td, io_u);
 264
 265         return 0;
 266 }
 267
 268 static void io_u_mark_depth(struct thread_data *td)
 269 {
 270         int index = 0;
 271
 272         switch (td->cur_depth) {
 273         default:
 274                 index++;
 275         case 32 ... 63:
 276                 index++;
 277         case 16 ... 31:
 278                 index++;
 279         case 8 ... 15:
 280                 index++;
 281         case 4 ... 7:
 282                 index++;
 283         case 2 ... 3:
 284                 index++;
 285         case 1:
 286                 break;
 287         }
 288
 289         td->ts.io_u_map[index]++;
 290         td->ts.total_io_u++;
 291 }
 292
 293 static void io_u_mark_latency(struct thread_data *td, unsigned long msec)
 294 {
 295         int index = 0;
 296
 297         switch (msec) {
 298         default:
 299                 index++;
 300         case 1000 ... 1999:
 301                 index++;
 302         case 750 ... 999:
 303                 index++;
 304         case 500 ... 749:
 305                 index++;
 306         case 250 ... 499:
 307                 index++;
 308         case 100 ... 249:
 309                 index++;
 310         case 50 ... 99:
 311                 index++;
 312         case 20 ... 49:
 313                 index++;
 314         case 10 ... 19:
 315                 index++;
 316         case 4 ... 9:
 317                 index++;
 318         case 2 ... 3:
 319                 index++;
 320         case 0 ... 1:
 321                 break;
 322         }
 323
 324         td->ts.io_u_lat[index]++;
 325 }
 326
 327 /*
 328  * Get next file to service by choosing one at random
 329  */
 330 static struct fio_file *get_next_file_rand(struct thread_data *td)
 331 {
 332         unsigned int fileno;
 333         struct fio_file *f;
 334
 335         do {
 336                 long r = os_random_long(&td->next_file_state);
 337
 338                 fileno = (unsigned int) ((double) (td->open_files * r) / (RAND_MAX + 1.0));
 339                 f = &td->files[fileno];
 340                 if (f->open)
 341                         return f;
 342         } while (1);
 343 }
 344
 345 /*
 346  * Get next file to service by doing round robin between all available ones
 347  */
 348 static struct fio_file *get_next_file_rr(struct thread_data *td)
 349 {
 350         unsigned int old_next_file = td->next_file;
 351         struct fio_file *f;
 352
 353         do {
 354                 f = &td->files[td->next_file];
 355
 356                 td->next_file++;
 357                 if (td->next_file >= td->open_files)
 358                         td->next_file = 0;
 359
 360                 if (f->open)
 361                         break;
 362
 363                 f = NULL;
 364         } while (td->next_file != old_next_file);
 365
 366         return f;
 367 }
 368
 369 static struct fio_file *get_next_file(struct thread_data *td)
 370 {
 371         if (!td->nr_open_files)
 372                 return NULL;
 373
 374         if (td->file_service_type == FIO_FSERVICE_RR)
 375                 return get_next_file_rr(td);
 376         else
 377                 return get_next_file_rand(td);
 378 }
 379
 380 struct io_u *__get_io_u(struct thread_data *td)
 381 {
 382         struct io_u *io_u = NULL;
 383
 384         if (!list_empty(&td->io_u_requeues))
 385                 io_u = list_entry(td->io_u_requeues.next, struct io_u, list);
 386         else if (!queue_full(td)) {
 387                 io_u = list_entry(td->io_u_freelist.next, struct io_u, list);
 388
 389                 io_u->buflen = 0;
 390                 io_u->resid = 0;
 391                 io_u->file = NULL;
 392                 io_u->end_io = NULL;
 393         }
 394
 395         if (io_u) {
 396                 assert(io_u->flags & IO_U_F_FREE);
 397                 io_u->flags &= ~IO_U_F_FREE;
 398
 399                 io_u->error = 0;
 400                 list_del(&io_u->list);
 401                 list_add(&io_u->list, &td->io_u_busylist);
 402                 td->cur_depth++;
 403                 io_u_mark_depth(td);
 404         }
 405
 406         return io_u;
 407 }
 408
 409 /*
 410  * Return an io_u to be processed. Gets a buflen and offset, sets direction,
 411  * etc. The returned io_u is fully ready to be prepped and submitted.
 412  */
 413 struct io_u *get_io_u(struct thread_data *td)
 414 {
 415         struct fio_file *f;
 416         struct io_u *io_u;
 417
 418         io_u = __get_io_u(td);
 419         if (!io_u)
 420                 return NULL;
 421
 422         /*
 423          * from a requeue, io_u already setup
 424          */
 425         if (io_u->file)
 426                 goto out;
 427
 428         do {
 429                 f = get_next_file(td);
 430                 if (!f) {
 431                         put_io_u(td, io_u);
 432                         return NULL;
 433                 }
 434
 435                 io_u->file = f;
 436
 437                 if (!fill_io_u(td, io_u))
 438                         break;
 439
 440                 /*
 441                  * No more to do for this file, close it
 442                  */
 443                 io_u->file = NULL;
 444                 td_io_close_file(td, f);
 445
 446                 /*
 447                  * probably not the right place to do this, but see
 448                  * if we need to open a new file
 449                  */
 450                 if (td->nr_open_files < td->nr_files &&
 451                     td->open_files != td->nr_files) {
 452                         int ret = td_io_open_file(td, f);
 453
 454                         if (ret) {
 455                                 put_io_u(td, io_u);
 456                                 return NULL;
 457                         }
 458                 }
 459         } while (1);
 460
 461         if (td->zone_bytes >= td->zone_size) {
 462                 td->zone_bytes = 0;
 463                 f->last_pos += td->zone_skip;
 464         }
 465
 466         if (io_u->buflen + io_u->offset > f->real_file_size) {
 467                 if (td->io_ops->flags & FIO_RAWIO) {
 468                         put_io_u(td, io_u);
 469                         return NULL;
 470                 }
 471
 472                 io_u->buflen = f->real_file_size - io_u->offset;
 473         }
 474
 475         if (io_u->ddir != DDIR_SYNC) {
 476                 if (!io_u->buflen) {
 477                         put_io_u(td, io_u);
 478                         return NULL;
 479                 }
 480
 481                 f->last_pos = io_u->offset + io_u->buflen;
 482
 483                 if (td->verify != VERIFY_NONE)
 484                         populate_verify_io_u(td, io_u);
 485         }
 486
 487         /*
 488          * Set io data pointers.
 489          */
 490 out:
 491         io_u->xfer_buf = io_u->buf;
 492         io_u->xfer_buflen = io_u->buflen;
 493
 494         if (td_io_prep(td, io_u)) {
 495                 put_io_u(td, io_u);
 496                 return NULL;
 497         }
 498
 499         fio_gettime(&io_u->start_time, NULL);
 500         return io_u;
 501 }
 502
 503 void io_u_log_error(struct thread_data *td, struct io_u *io_u)
 504 {
 505         const char *msg[] = { "read", "write", "sync" };
 506
 507         log_err("fio: io_u error");
 508
 509         if (io_u->file)
 510                 log_err(" on file %s", io_u->file->file_name);
 511
 512         log_err(": %s\n", strerror(io_u->error));
 513
 514         log_err("     %s offset=%llu, buflen=%lu\n", msg[io_u->ddir], io_u->offset, io_u->xfer_buflen);
 515
 516         if (!td->error)
 517                 td_verror(td, io_u->error, "io_u error");
 518 }
 519
 520 static void io_completed(struct thread_data *td, struct io_u *io_u,
 521                          struct io_completion_data *icd)
 522 {
 523         unsigned long msec;
 524
 525         assert(io_u->flags & IO_U_F_FLIGHT);
 526         io_u->flags &= ~IO_U_F_FLIGHT;
 527
 528         if (io_u->ddir == DDIR_SYNC) {
 529                 td->last_was_sync = 1;
 530                 return;
 531         }
 532
 533         td->last_was_sync = 0;
 534
 535         if (!io_u->error) {
 536                 unsigned int bytes = io_u->buflen - io_u->resid;
 537                 const enum fio_ddir idx = io_u->ddir;
 538                 int ret;
 539
 540                 td->io_blocks[idx]++;
 541                 td->io_bytes[idx] += bytes;
 542                 td->zone_bytes += bytes;
 543                 td->this_io_bytes[idx] += bytes;
 544
 545                 io_u->file->last_completed_pos = io_u->offset + io_u->buflen;
 546
 547                 msec = mtime_since(&io_u->issue_time, &icd->time);
 548
 549                 add_clat_sample(td, idx, msec);
 550                 add_bw_sample(td, idx, &icd->time);
 551                 io_u_mark_latency(td, msec);
 552
 553                 if ((td_rw(td) || td_write(td)) && idx == DDIR_WRITE)
 554                         log_io_piece(td, io_u);
 555
 556                 icd->bytes_done[idx] += bytes;
 557
 558                 if (io_u->end_io) {
 559                         ret = io_u->end_io(io_u);
 560                         if (ret && !icd->error)
 561                                 icd->error = ret;
 562                 }
 563         } else {
 564                 icd->error = io_u->error;
 565                 io_u_log_error(td, io_u);
 566         }
 567 }
 568
 569 static void init_icd(struct io_completion_data *icd, int nr)
 570 {
 571         fio_gettime(&icd->time, NULL);
 572
 573         icd->nr = nr;
 574
 575         icd->error = 0;
 576         icd->bytes_done[0] = icd->bytes_done[1] = 0;
 577 }
 578
 579 static void ios_completed(struct thread_data *td,
 580                           struct io_completion_data *icd)
 581 {
 582         struct io_u *io_u;
 583         int i;
 584
 585         for (i = 0; i < icd->nr; i++) {
 586                 io_u = td->io_ops->event(td, i);
 587
 588                 io_completed(td, io_u, icd);
 589                 put_io_u(td, io_u);
 590         }
 591 }
 592
 593 /*
 594  * Complete a single io_u for the sync engines.
 595  */
 596 long io_u_sync_complete(struct thread_data *td, struct io_u *io_u)
 597 {
 598         struct io_completion_data icd;
 599
 600         init_icd(&icd, 1);
 601         io_completed(td, io_u, &icd);
 602         put_io_u(td, io_u);
 603
 604         if (!icd.error)
 605                 return icd.bytes_done[0] + icd.bytes_done[1];
 606
 607         td_verror(td, icd.error, "io_u_sync_complete");
 608         return -1;
 609 }
 610
 611 /*
 612  * Called to complete min_events number of io for the async engines.
 613  */
 614 long io_u_queued_complete(struct thread_data *td, int min_events)
 615 {
 616         struct io_completion_data icd;
 617         struct timespec *tvp = NULL;
 618         int ret;
 619
 620         if (!min_events) {
 621                 struct timespec ts = { .tv_sec = 0, .tv_nsec = 0, };
 622
 623                 tvp = &ts;
 624         }
 625
 626         ret = td_io_getevents(td, min_events, td->cur_depth, tvp);
 627         if (ret < 0) {
 628                 td_verror(td, -ret, "td_io_getevents");
 629                 return ret;
 630         } else if (!ret)
 631                 return ret;
 632
 633         init_icd(&icd, ret);
 634         ios_completed(td, &icd);
 635         if (!icd.error)
 636                 return icd.bytes_done[0] + icd.bytes_done[1];
 637
 638         td_verror(td, icd.error, "io_u_queued_complete");
 639         return -1;
 640 }
 641
 642 /*
 643  * Call when io_u is really queued, to update the submission latency.
 644  */
 645 void io_u_queued(struct thread_data *td, struct io_u *io_u)
 646 {
 647         unsigned long slat_time;
 648
 649         slat_time = mtime_since(&io_u->start_time, &io_u->issue_time);
 650         add_slat_sample(td, io_u->ddir, slat_time);
 651 }
 652
 653 #ifdef FIO_USE_TIMEOUT
 654 void io_u_set_timeout(struct thread_data *td)
 655 {
 656         assert(td->cur_depth);
 657
 658         td->timer.it_interval.tv_sec = 0;
 659         td->timer.it_interval.tv_usec = 0;
 660         td->timer.it_value.tv_sec = IO_U_TIMEOUT + IO_U_TIMEOUT_INC;
 661         td->timer.it_value.tv_usec = 0;
 662         setitimer(ITIMER_REAL, &td->timer, NULL);
 663         fio_gettime(&td->timeout_end, NULL);
 664 }
 665
 666 static void io_u_dump(struct io_u *io_u)
 667 {
 668         unsigned long t_start = mtime_since_now(&io_u->start_time);
 669         unsigned long t_issue = mtime_since_now(&io_u->issue_time);
 670
 671         log_err("io_u=%p, t_start=%lu, t_issue=%lu\n", io_u, t_start, t_issue);
 672         log_err("  buf=%p/%p, len=%lu/%lu, offset=%llu\n", io_u->buf, io_u->xfer_buf, io_u->buflen, io_u->xfer_buflen, io_u->offset);
 673         log_err("  ddir=%d, fname=%s\n", io_u->ddir, io_u->file->file_name);
 674 }
 675 #else
 676 void io_u_set_timeout(struct thread_data fio_unused *td)
 677 {
 678 }
 679 #endif
 680
 681 #ifdef FIO_USE_TIMEOUT
 682 static void io_u_timeout_handler(int fio_unused sig)
 683 {
 684         struct thread_data *td, *__td;
 685         pid_t pid = getpid();
 686         struct list_head *entry;
 687         struct io_u *io_u;
 688         int i;
 689
 690         log_err("fio: io_u timeout\n");
 691
 692         /*
 693          * TLS would be nice...
 694          */
 695         td = NULL;
 696         for_each_td(__td, i) {
 697                 if (__td->pid == pid) {
 698                         td = __td;
 699                         break;
 700                 }
 701         }
 702
 703         if (!td) {
 704                 log_err("fio: io_u timeout, can't find job\n");
 705                 exit(1);
 706         }
 707
 708         if (!td->cur_depth) {
 709                 log_err("fio: timeout without pending work?\n");
 710                 return;
 711         }
 712
 713         log_err("fio: io_u timeout: job=%s, pid=%d\n", td->name, td->pid);
 714
 715         list_for_each(entry, &td->io_u_busylist) {
 716                 io_u = list_entry(entry, struct io_u, list);
 717
 718                 io_u_dump(io_u);
 719         }
 720
 721         td_verror(td, ETIMEDOUT, "io_u timeout");
 722         exit(1);
 723 }
 724 #endif
 725
 726 void io_u_init_timeout(void)
 727 {
 728 #ifdef FIO_USE_TIMEOUT
 729         signal(SIGALRM, io_u_timeout_handler);
 730 #endif
 731 }