fio.h

   1 #ifndef FIO_H
   2 #define FIO_H
   3
   4 #include <sched.h>
   5 #include <limits.h>
   6 #include <pthread.h>
   7 #include <sys/time.h>
   8 #include <sys/resource.h>
   9 #include <errno.h>
  10 #include <stdlib.h>
  11 #include <stdio.h>
  12 #include <unistd.h>
  13 #include <string.h>
  14 #include <inttypes.h>
  15 #include <assert.h>
  16
  17 #include "compiler/compiler.h"
  18 #include "flist.h"
  19 #include "fifo.h"
  20 #include "rbtree.h"
  21 #include "arch/arch.h"
  22 #include "os/os.h"
  23 #include "mutex.h"
  24 #include "log.h"
  25 #include "debug.h"
  26 #include "file.h"
  27 #include "io_ddir.h"
  28 #include "ioengine.h"
  29 #include "iolog.h"
  30 #include "helpers.h"
  31 #include "options.h"
  32 #include "profile.h"
  33 #include "time.h"
  34 #include "lib/getopt.h"
  35
  36 #ifdef FIO_HAVE_GUASI
  37 #include <guasi.h>
  38 #endif
  39
  40 #ifdef FIO_HAVE_SOLARISAIO
  41 #include <sys/asynch.h>
  42 #endif
  43
  44 struct group_run_stats {
  45         unsigned long long max_run[2], min_run[2];
  46         unsigned long long max_bw[2], min_bw[2];
  47         unsigned long long io_kb[2];
  48         unsigned long long agg[2];
  49         unsigned int kb_base;
  50 };
  51
  52 /*
  53  * What type of allocation to use for io buffers
  54  */
  55 enum fio_memtype {
  56         MEM_MALLOC = 0, /* ordinary malloc */
  57         MEM_SHM,        /* use shared memory segments */
  58         MEM_SHMHUGE,    /* use shared memory segments with huge pages */
  59         MEM_MMAP,       /* use anonynomous mmap */
  60         MEM_MMAPHUGE,   /* memory mapped huge file */
  61 };
  62
  63 /*
  64  * offset generator types
  65  */
  66 enum {
  67         RW_SEQ_SEQ      = 0,
  68         RW_SEQ_IDENT,
  69 };
  70
  71 /*
  72  * How many depth levels to log
  73  */
  74 #define FIO_IO_U_MAP_NR 7
  75 #define FIO_IO_U_LAT_U_NR 10
  76 #define FIO_IO_U_LAT_M_NR 12
  77
  78 #define MAX_PATTERN_SIZE 512
  79
  80 struct thread_stat {
  81         char *name;
  82         char *verror;
  83         int error;
  84         int groupid;
  85         pid_t pid;
  86         char *description;
  87         int members;
  88
  89         struct io_log *slat_log;
  90         struct io_log *clat_log;
  91         struct io_log *lat_log;
  92         struct io_log *bw_log;
  93
  94         /*
  95          * bandwidth and latency stats
  96          */
  97         struct io_stat clat_stat[2];            /* completion latency */
  98         struct io_stat slat_stat[2];            /* submission latency */
  99         struct io_stat lat_stat[2];             /* total latency */
 100         struct io_stat bw_stat[2];              /* bandwidth stats */
 101
 102         unsigned long long stat_io_bytes[2];
 103         struct timeval stat_sample_time[2];
 104
 105         /*
 106          * fio system usage accounting
 107          */
 108         struct rusage ru_start;
 109         struct rusage ru_end;
 110         unsigned long usr_time;
 111         unsigned long sys_time;
 112         unsigned long ctx;
 113         unsigned long minf, majf;
 114
 115         /*
 116          * IO depth and latency stats
 117          */
 118         unsigned int io_u_map[FIO_IO_U_MAP_NR];
 119         unsigned int io_u_submit[FIO_IO_U_MAP_NR];
 120         unsigned int io_u_complete[FIO_IO_U_MAP_NR];
 121         unsigned int io_u_lat_u[FIO_IO_U_LAT_U_NR];
 122         unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
 123         unsigned long total_io_u[3];
 124         unsigned long short_io_u[3];
 125         unsigned long total_submit;
 126         unsigned long total_complete;
 127
 128         unsigned long long io_bytes[2];
 129         unsigned long runtime[2];
 130         unsigned long total_run_time;
 131
 132         /*
 133          * IO Error related stats
 134          */
 135         unsigned continue_on_error;
 136         unsigned long total_err_count;
 137         int first_error;
 138
 139         unsigned int kb_base;
 140 };
 141
 142 struct bssplit {
 143         unsigned int bs;
 144         unsigned char perc;
 145 };
 146
 147 struct thread_options {
 148         int pad;
 149         char *description;
 150         char *name;
 151         char *directory;
 152         char *filename;
 153         char *opendir;
 154         char *ioengine;
 155         enum td_ddir td_ddir;
 156         unsigned int rw_seq;
 157         unsigned int kb_base;
 158         unsigned int ddir_seq_nr;
 159         unsigned int iodepth;
 160         unsigned int iodepth_low;
 161         unsigned int iodepth_batch;
 162         unsigned int iodepth_batch_complete;
 163
 164         unsigned long long size;
 165         unsigned int fill_device;
 166         unsigned long long file_size_low;
 167         unsigned long long file_size_high;
 168         unsigned long long start_offset;
 169
 170         unsigned int bs[2];
 171         unsigned int ba[2];
 172         unsigned int min_bs[2];
 173         unsigned int max_bs[2];
 174         struct bssplit *bssplit[2];
 175         unsigned int bssplit_nr[2];
 176
 177         unsigned int nr_files;
 178         unsigned int open_files;
 179         enum file_lock_mode file_lock_mode;
 180         unsigned int lockfile_batch;
 181
 182         unsigned int odirect;
 183         unsigned int invalidate_cache;
 184         unsigned int create_serialize;
 185         unsigned int create_fsync;
 186         unsigned int create_on_open;
 187         unsigned int end_fsync;
 188         unsigned int pre_read;
 189         unsigned int sync_io;
 190         unsigned int verify;
 191         unsigned int do_verify;
 192         unsigned int verifysort;
 193         unsigned int verify_interval;
 194         unsigned int verify_offset;
 195         char verify_pattern[MAX_PATTERN_SIZE];
 196         unsigned int verify_pattern_bytes;
 197         unsigned int verify_fatal;
 198         unsigned int verify_async;
 199         unsigned long long verify_backlog;
 200         unsigned int verify_batch;
 201         unsigned int use_thread;
 202         unsigned int unlink;
 203         unsigned int do_disk_util;
 204         unsigned int override_sync;
 205         unsigned int rand_repeatable;
 206         unsigned int write_lat_log;
 207         unsigned int write_bw_log;
 208         unsigned int norandommap;
 209         unsigned int softrandommap;
 210         unsigned int bs_unaligned;
 211         unsigned int fsync_on_close;
 212
 213         unsigned int hugepage_size;
 214         unsigned int rw_min_bs;
 215         unsigned int thinktime;
 216         unsigned int thinktime_spin;
 217         unsigned int thinktime_blocks;
 218         unsigned int fsync_blocks;
 219         unsigned int fdatasync_blocks;
 220         unsigned int barrier_blocks;
 221         unsigned long start_delay;
 222         unsigned long long timeout;
 223         unsigned long long ramp_time;
 224         unsigned int overwrite;
 225         unsigned int bw_avg_time;
 226         unsigned int loops;
 227         unsigned long long zone_size;
 228         unsigned long long zone_skip;
 229         enum fio_memtype mem_type;
 230         unsigned int mem_align;
 231
 232         unsigned int stonewall;
 233         unsigned int new_group;
 234         unsigned int numjobs;
 235         os_cpu_mask_t cpumask;
 236         unsigned int cpumask_set;
 237         os_cpu_mask_t verify_cpumask;
 238         unsigned int verify_cpumask_set;
 239         unsigned int iolog;
 240         unsigned int rwmixcycle;
 241         unsigned int rwmix[2];
 242         unsigned int nice;
 243         unsigned int file_service_type;
 244         unsigned int group_reporting;
 245         unsigned int fadvise_hint;
 246         unsigned int fallocate;
 247         unsigned int zero_buffers;
 248         unsigned int refill_buffers;
 249         unsigned int time_based;
 250         unsigned int disable_lat;
 251         unsigned int disable_clat;
 252         unsigned int disable_slat;
 253         unsigned int disable_bw;
 254         unsigned int gtod_reduce;
 255         unsigned int gtod_cpu;
 256         unsigned int gtod_offload;
 257         enum fio_cs clocksource;
 258         unsigned int no_stall;
 259         unsigned int trim_percentage;
 260         unsigned int trim_batch;
 261         unsigned int trim_zero;
 262         unsigned long long trim_backlog;
 263
 264         char *read_iolog_file;
 265         char *write_iolog_file;
 266         char *bw_log_file;
 267         char *lat_log_file;
 268         char *replay_redirect;
 269
 270         /*
 271          * Pre-run and post-run shell
 272          */
 273         char *exec_prerun;
 274         char *exec_postrun;
 275
 276         unsigned int rate[2];
 277         unsigned int ratemin[2];
 278         unsigned int ratecycle;
 279         unsigned int rate_iops[2];
 280         unsigned int rate_iops_min[2];
 281
 282         char *ioscheduler;
 283
 284         /*
 285          * CPU "io" cycle burner
 286          */
 287         unsigned int cpuload;
 288         unsigned int cpucycle;
 289
 290         /*
 291          * I/O Error handling
 292          */
 293         unsigned int continue_on_error;
 294
 295         /*
 296          * Benchmark profile type
 297          */
 298         char *profile;
 299
 300         /*
 301          * blkio cgroup support
 302          */
 303         char *cgroup;
 304         unsigned int cgroup_weight;
 305         unsigned int cgroup_nodelete;
 306
 307         unsigned int uid;
 308         unsigned int gid;
 309
 310         unsigned int sync_file_range;
 311 };
 312
 313 #define FIO_VERROR_SIZE 128
 314
 315 /*
 316  * This describes a single thread/process executing a fio job.
 317  */
 318 struct thread_data {
 319         struct thread_options o;
 320         char verror[FIO_VERROR_SIZE];
 321         pthread_t thread;
 322         int thread_number;
 323         int groupid;
 324         struct thread_stat ts;
 325         struct fio_file **files;
 326         unsigned int files_size;
 327         unsigned int files_index;
 328         unsigned int nr_open_files;
 329         unsigned int nr_done_files;
 330         unsigned int nr_normal_files;
 331         union {
 332                 unsigned int next_file;
 333                 os_random_state_t next_file_state;
 334         };
 335         int error;
 336         int done;
 337         pid_t pid;
 338         char *orig_buffer;
 339         size_t orig_buffer_size;
 340         volatile int terminate;
 341         volatile int runstate;
 342         unsigned int ioprio;
 343         unsigned int ioprio_set;
 344         unsigned int last_was_sync;
 345         enum fio_ddir last_ddir;
 346
 347         char *mmapfile;
 348         int mmapfd;
 349
 350         void *iolog_buf;
 351         FILE *iolog_f;
 352
 353         char *sysfs_root;
 354
 355         unsigned long rand_seeds[7];
 356
 357         os_random_state_t bsrange_state;
 358         os_random_state_t verify_state;
 359         os_random_state_t trim_state;
 360
 361         unsigned int verify_batch;
 362         unsigned int trim_batch;
 363
 364         int shm_id;
 365
 366         /*
 367          * IO engine hooks, contains everything needed to submit an io_u
 368          * to any of the available IO engines.
 369          */
 370         struct ioengine_ops *io_ops;
 371
 372         /*
 373          * Current IO depth and list of free and busy io_u's.
 374          */
 375         unsigned int cur_depth;
 376         unsigned int io_u_queued;
 377         struct flist_head io_u_freelist;
 378         struct flist_head io_u_busylist;
 379         struct flist_head io_u_requeues;
 380         pthread_mutex_t io_u_lock;
 381         pthread_cond_t free_cond;
 382
 383         /*
 384          * async verify offload
 385          */
 386         struct flist_head verify_list;
 387         pthread_t *verify_threads;
 388         unsigned int nr_verify_threads;
 389         pthread_cond_t verify_cond;
 390         int verify_thread_exit;
 391
 392         /*
 393          * Rate state
 394          */
 395         unsigned long rate_nsec_cycle[2];
 396         long rate_pending_usleep[2];
 397         unsigned long rate_bytes[2];
 398         unsigned long rate_blocks[2];
 399         struct timeval lastrate[2];
 400
 401         unsigned long long total_io_size;
 402         unsigned long long fill_device_size;
 403
 404         unsigned long io_issues[2];
 405         unsigned long long io_blocks[2];
 406         unsigned long long io_bytes[2];
 407         unsigned long long io_skip_bytes;
 408         unsigned long long this_io_bytes[2];
 409         unsigned long long zone_bytes;
 410         struct fio_mutex *mutex;
 411
 412         /*
 413          * State for random io, a bitmap of blocks done vs not done
 414          */
 415         os_random_state_t random_state;
 416
 417         struct timeval start;   /* start of this loop */
 418         struct timeval epoch;   /* time job was started */
 419         struct timeval last_issue;
 420         struct timeval tv_cache;
 421         unsigned int tv_cache_nr;
 422         unsigned int tv_cache_mask;
 423         unsigned int ramp_time_over;
 424
 425         /*
 426          * read/write mixed workload state
 427          */
 428         os_random_state_t rwmix_state;
 429         unsigned long rwmix_issues;
 430         enum fio_ddir rwmix_ddir;
 431         unsigned int ddir_seq_nr;
 432
 433         /*
 434          * IO history logs for verification. We use a tree for sorting,
 435          * if we are overwriting. Otherwise just use a fifo.
 436          */
 437         struct rb_root io_hist_tree;
 438         struct flist_head io_hist_list;
 439         unsigned long io_hist_len;
 440
 441         /*
 442          * For IO replaying
 443          */
 444         struct flist_head io_log_list;
 445
 446         /*
 447          * For tracking/handling discards
 448          */
 449         struct flist_head trim_list;
 450         unsigned long trim_entries;
 451
 452         /*
 453          * for fileservice, how often to switch to a new file
 454          */
 455         unsigned int file_service_nr;
 456         unsigned int file_service_left;
 457         struct fio_file *file_service_file;
 458
 459         unsigned int sync_file_range_nr;
 460
 461         /*
 462          * For generating file sizes
 463          */
 464         os_random_state_t file_size_state;
 465
 466         /*
 467          * Error counts
 468          */
 469         unsigned int total_err_count;
 470         int first_error;
 471
 472         /*
 473          * Can be overloaded by profiles
 474          */
 475         struct prof_io_ops prof_io_ops;
 476         void *prof_data;
 477 };
 478
 479 /*
 480  * when should interactive ETA output be generated
 481  */
 482 enum {
 483         FIO_ETA_AUTO,
 484         FIO_ETA_ALWAYS,
 485         FIO_ETA_NEVER,
 486 };
 487
 488 #define __td_verror(td, err, msg, func)                                 \
 489         do {                                                            \
 490                 if ((td)->error)                                        \
 491                         break;                                          \
 492                 int e = (err);                                          \
 493                 (td)->error = e;                                        \
 494                 if (!(td)->first_error)                                 \
 495                         snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));               \
 496         } while (0)
 497
 498
 499 #define td_clear_error(td)              \
 500         (td)->error = 0;
 501 #define td_verror(td, err, func)        \
 502         __td_verror((td), (err), strerror((err)), (func))
 503 #define td_vmsg(td, err, msg, func)     \
 504         __td_verror((td), (err), (msg), (func))
 505
 506 extern int exitall_on_terminate;
 507 extern int thread_number;
 508 extern int nr_process, nr_thread;
 509 extern int shm_id;
 510 extern int groupid;
 511 extern int terse_output;
 512 extern int temp_stall_ts;
 513 extern unsigned long long mlock_size;
 514 extern unsigned long page_mask, page_size;
 515 extern int read_only;
 516 extern int eta_print;
 517 extern unsigned long done_secs;
 518 extern char *job_section;
 519 extern int fio_gtod_offload;
 520 extern int fio_gtod_cpu;
 521 extern enum fio_cs fio_clock_source;
 522
 523 extern struct thread_data *threads;
 524
 525 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
 526 {
 527         assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
 528 }
 529
 530 #define BLOCKS_PER_MAP          (8 * sizeof(int))
 531 #define TO_MAP_BLOCK(f, b)      (b)
 532 #define RAND_MAP_IDX(f, b)      (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
 533 #define RAND_MAP_BIT(f, b)      (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
 534
 535 #define MAX_JOBS        (1024)
 536
 537 #define td_non_fatal_error(e)   ((e) == EIO || (e) == EILSEQ)
 538
 539 static inline void update_error_count(struct thread_data *td, int err)
 540 {
 541         td->total_err_count++;
 542         if (td->total_err_count == 1)
 543                 td->first_error = err;
 544 }
 545
 546 static inline int should_fsync(struct thread_data *td)
 547 {
 548         if (td->last_was_sync)
 549                 return 0;
 550         if (td->o.odirect)
 551                 return 0;
 552         if (td_write(td) || td_rw(td) || td->o.override_sync)
 553                 return 1;
 554
 555         return 0;
 556 }
 557
 558 /*
 559  * Init/option functions
 560  */
 561 extern int __must_check parse_options(int, char **);
 562 extern int fio_options_parse(struct thread_data *, char **, int);
 563 extern void fio_keywords_init(void);
 564 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
 565 extern void fio_fill_default_options(struct thread_data *);
 566 extern int fio_show_option_help(const char *);
 567 extern void fio_options_dup_and_init(struct option *);
 568 extern void options_mem_dupe(struct thread_data *);
 569 extern void options_mem_free(struct thread_data *);
 570 extern void td_fill_rand_seeds(struct thread_data *);
 571 extern void add_job_opts(const char **);
 572 extern char *num2str(unsigned long, int, int, int);
 573
 574 #define FIO_GETOPT_JOB          0x89988998
 575 #define FIO_NR_OPTIONS          (FIO_MAX_OPTS + 128)
 576
 577 /*
 578  * ETA/status stuff
 579  */
 580 extern void print_thread_status(void);
 581 extern void print_status_init(int);
 582
 583 /*
 584  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 585  * will never back again. It may cycle between running/verififying/fsyncing.
 586  * Once the thread reaches TD_EXITED, it is just waiting for the core to
 587  * reap it.
 588  */
 589 enum {
 590         TD_NOT_CREATED = 0,
 591         TD_CREATED,
 592         TD_INITIALIZED,
 593         TD_RAMP,
 594         TD_RUNNING,
 595         TD_PRE_READING,
 596         TD_VERIFYING,
 597         TD_FSYNCING,
 598         TD_EXITED,
 599         TD_REAPED,
 600 };
 601
 602 extern void td_set_runstate(struct thread_data *, int);
 603
 604 /*
 605  * Memory helpers
 606  */
 607 extern int __must_check fio_pin_memory(void);
 608 extern void fio_unpin_memory(void);
 609 extern int __must_check allocate_io_mem(struct thread_data *);
 610 extern void free_io_mem(struct thread_data *);
 611
 612 /*
 613  * Reset stats after ramp time completes
 614  */
 615 extern void reset_all_stats(struct thread_data *);
 616
 617 /*
 618  * blktrace support
 619  */
 620 #ifdef FIO_HAVE_BLKTRACE
 621 extern int is_blktrace(const char *);
 622 extern int load_blktrace(struct thread_data *, const char *);
 623 #endif
 624
 625 /*
 626  * Mark unused variables passed to ops functions as unused, to silence gcc
 627  */
 628 #define fio_unused      __attribute((__unused__))
 629 #define fio_init        __attribute__((constructor))
 630 #define fio_exit        __attribute__((destructor))
 631
 632 #define for_each_td(td, i)      \
 633         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
 634 #define for_each_file(td, f, i) \
 635         if ((td)->files_index)                                          \
 636                 for ((i) = 0, (f) = (td)->files[0];                     \
 637                  (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
 638                  (i)++)
 639
 640 #define fio_assert(td, cond)    do {    \
 641         if (!(cond)) {                  \
 642                 int *__foo = NULL;      \
 643                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
 644                 (td)->runstate = TD_EXITED;     \
 645                 (td)->error = EFAULT;           \
 646                 *__foo = 0;                     \
 647         }       \
 648 } while (0)
 649
 650 static inline int fio_fill_issue_time(struct thread_data *td)
 651 {
 652         if (td->o.read_iolog_file ||
 653             !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
 654                 return 1;
 655
 656         return 0;
 657 }
 658
 659 static inline int __should_check_rate(struct thread_data *td,
 660                                       enum fio_ddir ddir)
 661 {
 662         struct thread_options *o = &td->o;
 663
 664         /*
 665          * If some rate setting was given, we need to check it
 666          */
 667         if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
 668             o->rate_iops_min[ddir])
 669                 return 1;
 670
 671         return 0;
 672 }
 673
 674 static inline int should_check_rate(struct thread_data *td,
 675                                     unsigned long *bytes_done)
 676 {
 677         int ret = 0;
 678
 679         if (bytes_done[0])
 680                 ret |= __should_check_rate(td, 0);
 681         if (bytes_done[1])
 682                 ret |= __should_check_rate(td, 1);
 683
 684         return ret;
 685 }
 686
 687 static inline int is_power_of_2(unsigned int val)
 688 {
 689         return (val != 0 && ((val & (val - 1)) == 0));
 690 }
 691
 692 /*
 693  * We currently only need to do locking if we have verifier threads
 694  * accessing our internal structures too
 695  */
 696 static inline void td_io_u_lock(struct thread_data *td)
 697 {
 698         if (td->o.verify_async)
 699                 pthread_mutex_lock(&td->io_u_lock);
 700 }
 701
 702 static inline void td_io_u_unlock(struct thread_data *td)
 703 {
 704         if (td->o.verify_async)
 705                 pthread_mutex_unlock(&td->io_u_lock);
 706 }
 707
 708 static inline void td_io_u_free_notify(struct thread_data *td)
 709 {
 710         if (td->o.verify_async)
 711                 pthread_cond_signal(&td->free_cond);
 712 }
 713
 714 #endif