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