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 struct thread_data;
  18
  19 #include "compiler/compiler.h"
  20 #include "flist.h"
  21 #include "fifo.h"
  22 #include "rbtree.h"
  23 #include "arch/arch.h"
  24 #include "os/os.h"
  25 #include "mutex.h"
  26 #include "log.h"
  27 #include "debug.h"
  28 #include "file.h"
  29 #include "io_ddir.h"
  30 #include "ioengine.h"
  31 #include "iolog.h"
  32 #include "helpers.h"
  33 #include "options.h"
  34 #include "profile.h"
  35 #include "time.h"
  36 #include "lib/getopt.h"
  37 #include "lib/rand.h"
  38 #include "server.h"
  39
  40 #ifdef FIO_HAVE_GUASI
  41 #include <guasi.h>
  42 #endif
  43
  44 #ifdef FIO_HAVE_SOLARISAIO
  45 #include <sys/asynch.h>
  46 #endif
  47
  48 struct group_run_stats {
  49         uint64_t max_run[2], min_run[2];
  50         uint64_t max_bw[2], min_bw[2];
  51         uint64_t io_kb[2];
  52         uint64_t agg[2];
  53         uint32_t kb_base;
  54 };
  55
  56 /*
  57  * What type of allocation to use for io buffers
  58  */
  59 enum fio_memtype {
  60         MEM_MALLOC = 0, /* ordinary malloc */
  61         MEM_SHM,        /* use shared memory segments */
  62         MEM_SHMHUGE,    /* use shared memory segments with huge pages */
  63         MEM_MMAP,       /* use anonynomous mmap */
  64         MEM_MMAPHUGE,   /* memory mapped huge file */
  65 };
  66
  67 /*
  68  * offset generator types
  69  */
  70 enum {
  71         RW_SEQ_SEQ      = 0,
  72         RW_SEQ_IDENT,
  73 };
  74
  75 /*
  76  * How many depth levels to log
  77  */
  78 #define FIO_IO_U_MAP_NR 7
  79 #define FIO_IO_U_LAT_U_NR 10
  80 #define FIO_IO_U_LAT_M_NR 12
  81
  82 /*
  83  * Aggregate clat samples to report percentile(s) of them.
  84  *
  85  * EXECUTIVE SUMMARY
  86  *
  87  * FIO_IO_U_PLAT_BITS determines the maximum statistical error on the
  88  * value of resulting percentiles. The error will be approximately
  89  * 1/2^(FIO_IO_U_PLAT_BITS+1) of the value.
  90  *
  91  * FIO_IO_U_PLAT_GROUP_NR and FIO_IO_U_PLAT_BITS determine the maximum
  92  * range being tracked for latency samples. The maximum value tracked
  93  * accurately will be 2^(GROUP_NR + PLAT_BITS -1) microseconds.
  94  *
  95  * FIO_IO_U_PLAT_GROUP_NR and FIO_IO_U_PLAT_BITS determine the memory
  96  * requirement of storing those aggregate counts. The memory used will
  97  * be (FIO_IO_U_PLAT_GROUP_NR * 2^FIO_IO_U_PLAT_BITS) * sizeof(int)
  98  * bytes.
  99  *
 100  * FIO_IO_U_PLAT_NR is the total number of buckets.
 101  *
 102  * DETAILS
 103  *
 104  * Suppose the clat varies from 0 to 999 (usec), the straightforward
 105  * method is to keep an array of (999 + 1) buckets, in which a counter
 106  * keeps the count of samples which fall in the bucket, e.g.,
 107  * {[0],[1],...,[999]}. However this consumes a huge amount of space,
 108  * and can be avoided if an approximation is acceptable.
 109  *
 110  * One such method is to let the range of the bucket to be greater
 111  * than one. This method has low accuracy when the value is small. For
 112  * example, let the buckets be {[0,99],[100,199],...,[900,999]}, and
 113  * the represented value of each bucket be the mean of the range. Then
 114  * a value 0 has an round-off error of 49.5. To improve on this, we
 115  * use buckets with non-uniform ranges, while bounding the error of
 116  * each bucket within a ratio of the sample value. A simple example
 117  * would be when error_bound = 0.005, buckets are {
 118  * {[0],[1],...,[99]}, {[100,101],[102,103],...,[198,199]},..,
 119  * {[900,909],[910,919]...}  }. The total range is partitioned into
 120  * groups with different ranges, then buckets with uniform ranges. An
 121  * upper bound of the error is (range_of_bucket/2)/value_of_bucket
 122  *
 123  * For better efficiency, we implement this using base two. We group
 124  * samples by their Most Significant Bit (MSB), extract the next M bit
 125  * of them as an index within the group, and discard the rest of the
 126  * bits.
 127  *
 128  * E.g., assume a sample 'x' whose MSB is bit n (starting from bit 0),
 129  * and use M bit for indexing
 130  *
 131  *        | n |    M bits   | bit (n-M-1) ... bit 0 |
 132  *
 133  * Because x is at least 2^n, and bit 0 to bit (n-M-1) is at most
 134  * (2^(n-M) - 1), discarding bit 0 to (n-M-1) makes the round-off
 135  * error
 136  *
 137  *           2^(n-M)-1    2^(n-M)    1
 138  *      e <= --------- <= ------- = ---
 139  *             2^n          2^n     2^M
 140  *
 141  * Furthermore, we use "mean" of the range to represent the bucket,
 142  * the error e can be lowered by half to 1 / 2^(M+1). By using M bits
 143  * as the index, each group must contains 2^M buckets.
 144  *
 145  * E.g. Let M (FIO_IO_U_PLAT_BITS) be 6
 146  *      Error bound is 1/2^(6+1) = 0.0078125 (< 1%)
 147  *
 148  *      Group   MSB     #discarded      range of                #buckets
 149  *                      error_bits      value
 150  *      ----------------------------------------------------------------
 151  *      0*      0~5     0               [0,63]                  64
 152  *      1*      6       0               [64,127]                64
 153  *      2       7       1               [128,255]               64
 154  *      3       8       2               [256,511]               64
 155  *      4       9       3               [512,1023]              64
 156  *      ...     ...     ...             [...,...]               ...
 157  *      18      23      17              [8838608,+inf]**        64
 158  *
 159  *  * Special cases: when n < (M-1) or when n == (M-1), in both cases,
 160  *    the value cannot be rounded off. Use all bits of the sample as
 161  *    index.
 162  *
 163  *  ** If a sample's MSB is greater than 23, it will be counted as 23.
 164  */
 165
 166 #define FIO_IO_U_PLAT_BITS 6
 167 #define FIO_IO_U_PLAT_VAL (1 << FIO_IO_U_PLAT_BITS)
 168 #define FIO_IO_U_PLAT_GROUP_NR 19
 169 #define FIO_IO_U_PLAT_NR (FIO_IO_U_PLAT_GROUP_NR * FIO_IO_U_PLAT_VAL)
 170 #define FIO_IO_U_LIST_MAX_LEN 20 /* The size of the default and user-specified
 171                                         list of percentiles */
 172
 173 #define MAX_PATTERN_SIZE 512
 174
 175 struct thread_stat {
 176         char *name;
 177         char *verror;
 178         int32_t error;
 179         int32_t groupid;
 180         uint32_t pid;
 181         char *description;
 182         uint32_t members;
 183
 184         /*
 185          * bandwidth and latency stats
 186          */
 187         struct io_stat clat_stat[2];            /* completion latency */
 188         struct io_stat slat_stat[2];            /* submission latency */
 189         struct io_stat lat_stat[2];             /* total latency */
 190         struct io_stat bw_stat[2];              /* bandwidth stats */
 191
 192         uint64_t stat_io_bytes[2];
 193         struct timeval stat_sample_time[2];
 194
 195         /*
 196          * fio system usage accounting
 197          */
 198         struct rusage ru_start;
 199         struct rusage ru_end;
 200         uint64_t usr_time;
 201         uint64_t sys_time;
 202         uint64_t ctx;
 203         uint64_t minf, majf;
 204
 205         /*
 206          * IO depth and latency stats
 207          */
 208         uint64_t clat_percentiles;
 209         double *percentile_list;
 210
 211         uint32_t io_u_map[FIO_IO_U_MAP_NR];
 212         uint32_t io_u_submit[FIO_IO_U_MAP_NR];
 213         uint32_t io_u_complete[FIO_IO_U_MAP_NR];
 214         uint32_t io_u_lat_u[FIO_IO_U_LAT_U_NR];
 215         uint32_t io_u_lat_m[FIO_IO_U_LAT_M_NR];
 216         uint32_t io_u_plat[2][FIO_IO_U_PLAT_NR];
 217         uint64_t total_io_u[3];
 218         uint64_t short_io_u[3];
 219         uint64_t total_submit;
 220         uint64_t total_complete;
 221
 222         uint64_t io_bytes[2];
 223         uint64_t runtime[2];
 224         uint64_t total_run_time;
 225
 226         /*
 227          * IO Error related stats
 228          */
 229         uint16_t continue_on_error;
 230         uint64_t total_err_count;
 231         int32_t first_error;
 232
 233         uint32_t kb_base;
 234 };
 235
 236 struct bssplit {
 237         unsigned int bs;
 238         unsigned char perc;
 239 };
 240
 241 struct thread_options {
 242         int pad;
 243         char *description;
 244         char *name;
 245         char *directory;
 246         char *filename;
 247         char *opendir;
 248         char *ioengine;
 249         enum td_ddir td_ddir;
 250         unsigned int rw_seq;
 251         unsigned int kb_base;
 252         unsigned int ddir_seq_nr;
 253         long ddir_seq_add;
 254         unsigned int iodepth;
 255         unsigned int iodepth_low;
 256         unsigned int iodepth_batch;
 257         unsigned int iodepth_batch_complete;
 258
 259         unsigned long long size;
 260         unsigned int size_percent;
 261         unsigned int fill_device;
 262         unsigned long long file_size_low;
 263         unsigned long long file_size_high;
 264         unsigned long long start_offset;
 265
 266         unsigned int bs[2];
 267         unsigned int ba[2];
 268         unsigned int min_bs[2];
 269         unsigned int max_bs[2];
 270         struct bssplit *bssplit[2];
 271         unsigned int bssplit_nr[2];
 272
 273         unsigned int nr_files;
 274         unsigned int open_files;
 275         enum file_lock_mode file_lock_mode;
 276         unsigned int lockfile_batch;
 277
 278         unsigned int odirect;
 279         unsigned int invalidate_cache;
 280         unsigned int create_serialize;
 281         unsigned int create_fsync;
 282         unsigned int create_on_open;
 283         unsigned int end_fsync;
 284         unsigned int pre_read;
 285         unsigned int sync_io;
 286         unsigned int verify;
 287         unsigned int do_verify;
 288         unsigned int verifysort;
 289         unsigned int verify_interval;
 290         unsigned int verify_offset;
 291         char verify_pattern[MAX_PATTERN_SIZE];
 292         unsigned int verify_pattern_bytes;
 293         unsigned int verify_fatal;
 294         unsigned int verify_dump;
 295         unsigned int verify_async;
 296         unsigned long long verify_backlog;
 297         unsigned int verify_batch;
 298         unsigned int use_thread;
 299         unsigned int unlink;
 300         unsigned int do_disk_util;
 301         unsigned int override_sync;
 302         unsigned int rand_repeatable;
 303         unsigned int use_os_rand;
 304         unsigned int write_lat_log;
 305         unsigned int write_bw_log;
 306         unsigned int norandommap;
 307         unsigned int softrandommap;
 308         unsigned int bs_unaligned;
 309         unsigned int fsync_on_close;
 310
 311         unsigned int hugepage_size;
 312         unsigned int rw_min_bs;
 313         unsigned int thinktime;
 314         unsigned int thinktime_spin;
 315         unsigned int thinktime_blocks;
 316         unsigned int fsync_blocks;
 317         unsigned int fdatasync_blocks;
 318         unsigned int barrier_blocks;
 319         unsigned long long start_delay;
 320         unsigned long long timeout;
 321         unsigned long long ramp_time;
 322         unsigned int overwrite;
 323         unsigned int bw_avg_time;
 324         unsigned int loops;
 325         unsigned long long zone_size;
 326         unsigned long long zone_skip;
 327         enum fio_memtype mem_type;
 328         unsigned int mem_align;
 329
 330         unsigned int stonewall;
 331         unsigned int new_group;
 332         unsigned int numjobs;
 333         os_cpu_mask_t cpumask;
 334         unsigned int cpumask_set;
 335         os_cpu_mask_t verify_cpumask;
 336         unsigned int verify_cpumask_set;
 337         unsigned int iolog;
 338         unsigned int rwmixcycle;
 339         unsigned int rwmix[2];
 340         unsigned int nice;
 341         unsigned int file_service_type;
 342         unsigned int group_reporting;
 343         unsigned int fadvise_hint;
 344         enum fio_fallocate_mode fallocate_mode;
 345         unsigned int zero_buffers;
 346         unsigned int refill_buffers;
 347         unsigned int scramble_buffers;
 348         unsigned int time_based;
 349         unsigned int disable_lat;
 350         unsigned int disable_clat;
 351         unsigned int disable_slat;
 352         unsigned int disable_bw;
 353         unsigned int gtod_reduce;
 354         unsigned int gtod_cpu;
 355         unsigned int gtod_offload;
 356         enum fio_cs clocksource;
 357         unsigned int no_stall;
 358         unsigned int trim_percentage;
 359         unsigned int trim_batch;
 360         unsigned int trim_zero;
 361         unsigned long long trim_backlog;
 362         unsigned int clat_percentiles;
 363         unsigned int overwrite_plist;
 364         double percentile_list[FIO_IO_U_LIST_MAX_LEN];
 365
 366         char *read_iolog_file;
 367         char *write_iolog_file;
 368         char *bw_log_file;
 369         char *lat_log_file;
 370         char *replay_redirect;
 371
 372         /*
 373          * Pre-run and post-run shell
 374          */
 375         char *exec_prerun;
 376         char *exec_postrun;
 377
 378         unsigned int rate[2];
 379         unsigned int ratemin[2];
 380         unsigned int ratecycle;
 381         unsigned int rate_iops[2];
 382         unsigned int rate_iops_min[2];
 383
 384         char *ioscheduler;
 385
 386         /*
 387          * CPU "io" cycle burner
 388          */
 389         unsigned int cpuload;
 390         unsigned int cpucycle;
 391
 392         /*
 393          * I/O Error handling
 394          */
 395         unsigned int continue_on_error;
 396
 397         /*
 398          * Benchmark profile type
 399          */
 400         char *profile;
 401
 402         /*
 403          * blkio cgroup support
 404          */
 405         char *cgroup;
 406         unsigned int cgroup_weight;
 407         unsigned int cgroup_nodelete;
 408
 409         unsigned int uid;
 410         unsigned int gid;
 411
 412         unsigned int sync_file_range;
 413
 414         unsigned int userspace_libaio_reap;
 415 };
 416
 417 #define FIO_VERROR_SIZE 128
 418
 419 /*
 420  * This describes a single thread/process executing a fio job.
 421  */
 422 struct thread_data {
 423         struct thread_options o;
 424         char verror[FIO_VERROR_SIZE];
 425         pthread_t thread;
 426         int thread_number;
 427         int groupid;
 428         struct thread_stat ts;
 429
 430         struct io_log *slat_log;
 431         struct io_log *clat_log;
 432         struct io_log *lat_log;
 433         struct io_log *bw_log;
 434
 435         struct fio_file **files;
 436         unsigned int files_size;
 437         unsigned int files_index;
 438         unsigned int nr_open_files;
 439         unsigned int nr_done_files;
 440         unsigned int nr_normal_files;
 441         union {
 442                 unsigned int next_file;
 443                 os_random_state_t next_file_state;
 444                 struct frand_state __next_file_state;
 445         };
 446         int error;
 447         int done;
 448         pid_t pid;
 449         char *orig_buffer;
 450         size_t orig_buffer_size;
 451         volatile int terminate;
 452         volatile int runstate;
 453         unsigned int ioprio;
 454         unsigned int ioprio_set;
 455         unsigned int last_was_sync;
 456         enum fio_ddir last_ddir;
 457
 458         char *mmapfile;
 459         int mmapfd;
 460
 461         void *iolog_buf;
 462         FILE *iolog_f;
 463
 464         char *sysfs_root;
 465
 466         unsigned long rand_seeds[8];
 467
 468         union {
 469                 os_random_state_t bsrange_state;
 470                 struct frand_state __bsrange_state;
 471         };
 472         union {
 473                 os_random_state_t verify_state;
 474                 struct frand_state __verify_state;
 475         };
 476         union {
 477                 os_random_state_t trim_state;
 478                 struct frand_state __trim_state;
 479         };
 480
 481         struct frand_state buf_state;
 482
 483         unsigned int verify_batch;
 484         unsigned int trim_batch;
 485
 486         int shm_id;
 487
 488         /*
 489          * IO engine hooks, contains everything needed to submit an io_u
 490          * to any of the available IO engines.
 491          */
 492         struct ioengine_ops *io_ops;
 493
 494         /*
 495          * Current IO depth and list of free and busy io_u's.
 496          */
 497         unsigned int cur_depth;
 498         unsigned int io_u_queued;
 499         struct flist_head io_u_freelist;
 500         struct flist_head io_u_busylist;
 501         struct flist_head io_u_requeues;
 502         pthread_mutex_t io_u_lock;
 503         pthread_cond_t free_cond;
 504
 505         /*
 506          * async verify offload
 507          */
 508         struct flist_head verify_list;
 509         pthread_t *verify_threads;
 510         unsigned int nr_verify_threads;
 511         pthread_cond_t verify_cond;
 512         int verify_thread_exit;
 513
 514         /*
 515          * Rate state
 516          */
 517         unsigned long rate_nsec_cycle[2];
 518         long rate_pending_usleep[2];
 519         unsigned long rate_bytes[2];
 520         unsigned long rate_blocks[2];
 521         struct timeval lastrate[2];
 522
 523         unsigned long long total_io_size;
 524         unsigned long long fill_device_size;
 525
 526         unsigned long io_issues[2];
 527         unsigned long long io_blocks[2];
 528         unsigned long long io_bytes[2];
 529         unsigned long long io_skip_bytes;
 530         unsigned long long this_io_bytes[2];
 531         unsigned long long zone_bytes;
 532         struct fio_mutex *mutex;
 533
 534         /*
 535          * State for random io, a bitmap of blocks done vs not done
 536          */
 537         union {
 538                 os_random_state_t random_state;
 539                 struct frand_state __random_state;
 540         };
 541
 542         struct timeval start;   /* start of this loop */
 543         struct timeval epoch;   /* time job was started */
 544         struct timeval last_issue;
 545         struct timeval tv_cache;
 546         unsigned int tv_cache_nr;
 547         unsigned int tv_cache_mask;
 548         unsigned int ramp_time_over;
 549
 550         /*
 551          * read/write mixed workload state
 552          */
 553         union {
 554                 os_random_state_t rwmix_state;
 555                 struct frand_state __rwmix_state;
 556         };
 557         unsigned long rwmix_issues;
 558         enum fio_ddir rwmix_ddir;
 559         unsigned int ddir_seq_nr;
 560
 561         /*
 562          * IO history logs for verification. We use a tree for sorting,
 563          * if we are overwriting. Otherwise just use a fifo.
 564          */
 565         struct rb_root io_hist_tree;
 566         struct flist_head io_hist_list;
 567         unsigned long io_hist_len;
 568
 569         /*
 570          * For IO replaying
 571          */
 572         struct flist_head io_log_list;
 573
 574         /*
 575          * For tracking/handling discards
 576          */
 577         struct flist_head trim_list;
 578         unsigned long trim_entries;
 579
 580         /*
 581          * for fileservice, how often to switch to a new file
 582          */
 583         unsigned int file_service_nr;
 584         unsigned int file_service_left;
 585         struct fio_file *file_service_file;
 586
 587         unsigned int sync_file_range_nr;
 588
 589         /*
 590          * For generating file sizes
 591          */
 592         union {
 593                 os_random_state_t file_size_state;
 594                 struct frand_state __file_size_state;
 595         };
 596
 597         /*
 598          * Error counts
 599          */
 600         unsigned int total_err_count;
 601         int first_error;
 602
 603         /*
 604          * Can be overloaded by profiles
 605          */
 606         struct prof_io_ops prof_io_ops;
 607         void *prof_data;
 608 };
 609
 610 /*
 611  * when should interactive ETA output be generated
 612  */
 613 enum {
 614         FIO_ETA_AUTO,
 615         FIO_ETA_ALWAYS,
 616         FIO_ETA_NEVER,
 617 };
 618
 619 #define __td_verror(td, err, msg, func)                                 \
 620         do {                                                            \
 621                 if ((td)->error)                                        \
 622                         break;                                          \
 623                 int e = (err);                                          \
 624                 (td)->error = e;                                        \
 625                 if (!(td)->first_error)                                 \
 626                         snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));               \
 627         } while (0)
 628
 629
 630 #define td_clear_error(td)              \
 631         (td)->error = 0;
 632 #define td_verror(td, err, func)        \
 633         __td_verror((td), (err), strerror((err)), (func))
 634 #define td_vmsg(td, err, msg, func)     \
 635         __td_verror((td), (err), (msg), (func))
 636
 637 extern int exitall_on_terminate;
 638 extern int thread_number;
 639 extern int nr_process, nr_thread;
 640 extern int shm_id;
 641 extern int groupid;
 642 extern int terse_output;
 643 extern int temp_stall_ts;
 644 extern unsigned long long mlock_size;
 645 extern unsigned long page_mask, page_size;
 646 extern int read_only;
 647 extern int eta_print;
 648 extern unsigned long done_secs;
 649 extern char *job_section;
 650 extern int fio_gtod_offload;
 651 extern int fio_gtod_cpu;
 652 extern enum fio_cs fio_clock_source;
 653 extern int warnings_fatal;
 654 extern int terse_version;
 655 extern int is_backend;
 656 extern int nr_clients;
 657 extern int log_syslog;
 658
 659 extern struct thread_data *threads;
 660
 661 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
 662 {
 663         assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
 664 }
 665
 666 #define BLOCKS_PER_MAP          (8 * sizeof(unsigned long))
 667 #define TO_MAP_BLOCK(f, b)      (b)
 668 #define RAND_MAP_IDX(f, b)      (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
 669 #define RAND_MAP_BIT(f, b)      (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
 670
 671 #define REAL_MAX_JOBS           2048
 672
 673 #define td_non_fatal_error(e)   ((e) == EIO || (e) == EILSEQ)
 674
 675 static inline void update_error_count(struct thread_data *td, int err)
 676 {
 677         td->total_err_count++;
 678         if (td->total_err_count == 1)
 679                 td->first_error = err;
 680 }
 681
 682 static inline int should_fsync(struct thread_data *td)
 683 {
 684         if (td->last_was_sync)
 685                 return 0;
 686         if (td->o.odirect)
 687                 return 0;
 688         if (td_write(td) || td_rw(td) || td->o.override_sync)
 689                 return 1;
 690
 691         return 0;
 692 }
 693
 694 /*
 695  * Init/option functions
 696  */
 697 extern int __must_check parse_options(int, char **);
 698 extern int parse_jobs_ini(char *, int, int);
 699 extern int exec_run(void);
 700 extern void reset_fio_state(void);
 701 extern int fio_options_parse(struct thread_data *, char **, int);
 702 extern void fio_keywords_init(void);
 703 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
 704 extern void fio_fill_default_options(struct thread_data *);
 705 extern int fio_show_option_help(const char *);
 706 extern void fio_options_dup_and_init(struct option *);
 707 extern void options_mem_dupe(struct thread_data *);
 708 extern void options_mem_free(struct thread_data *);
 709 extern void td_fill_rand_seeds(struct thread_data *);
 710 extern void add_job_opts(const char **);
 711 extern char *num2str(unsigned long, int, int, int);
 712
 713 #define FIO_GETOPT_JOB          0x89988998
 714 #define FIO_NR_OPTIONS          (FIO_MAX_OPTS + 128)
 715
 716 /*
 717  * ETA/status stuff
 718  */
 719 extern void print_thread_status(void);
 720 extern void print_status_init(int);
 721
 722 /*
 723  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 724  * will never back again. It may cycle between running/verififying/fsyncing.
 725  * Once the thread reaches TD_EXITED, it is just waiting for the core to
 726  * reap it.
 727  */
 728 enum {
 729         TD_NOT_CREATED = 0,
 730         TD_CREATED,
 731         TD_INITIALIZED,
 732         TD_RAMP,
 733         TD_RUNNING,
 734         TD_PRE_READING,
 735         TD_VERIFYING,
 736         TD_FSYNCING,
 737         TD_EXITED,
 738         TD_REAPED,
 739 };
 740
 741 extern void td_set_runstate(struct thread_data *, int);
 742
 743 /*
 744  * Memory helpers
 745  */
 746 extern int __must_check fio_pin_memory(void);
 747 extern void fio_unpin_memory(void);
 748 extern int __must_check allocate_io_mem(struct thread_data *);
 749 extern void free_io_mem(struct thread_data *);
 750
 751 /*
 752  * Reset stats after ramp time completes
 753  */
 754 extern void reset_all_stats(struct thread_data *);
 755
 756 /*
 757  * blktrace support
 758  */
 759 #ifdef FIO_HAVE_BLKTRACE
 760 extern int is_blktrace(const char *);
 761 extern int load_blktrace(struct thread_data *, const char *);
 762 #endif
 763
 764 /*
 765  * Mark unused variables passed to ops functions as unused, to silence gcc
 766  */
 767 #define fio_unused      __attribute((__unused__))
 768 #define fio_init        __attribute__((constructor))
 769 #define fio_exit        __attribute__((destructor))
 770
 771 #define for_each_td(td, i)      \
 772         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
 773 #define for_each_file(td, f, i) \
 774         if ((td)->files_index)                                          \
 775                 for ((i) = 0, (f) = (td)->files[0];                     \
 776                  (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
 777                  (i)++)
 778
 779 #define fio_assert(td, cond)    do {    \
 780         if (!(cond)) {                  \
 781                 int *__foo = NULL;      \
 782                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
 783                 td_set_runstate((td), TD_EXITED);       \
 784                 (td)->error = EFAULT;           \
 785                 *__foo = 0;                     \
 786         }       \
 787 } while (0)
 788
 789 static inline int fio_fill_issue_time(struct thread_data *td)
 790 {
 791         if (td->o.read_iolog_file ||
 792             !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
 793                 return 1;
 794
 795         return 0;
 796 }
 797
 798 static inline int __should_check_rate(struct thread_data *td,
 799                                       enum fio_ddir ddir)
 800 {
 801         struct thread_options *o = &td->o;
 802
 803         /*
 804          * If some rate setting was given, we need to check it
 805          */
 806         if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
 807             o->rate_iops_min[ddir])
 808                 return 1;
 809
 810         return 0;
 811 }
 812
 813 static inline int should_check_rate(struct thread_data *td,
 814                                     unsigned long *bytes_done)
 815 {
 816         int ret = 0;
 817
 818         if (bytes_done[0])
 819                 ret |= __should_check_rate(td, 0);
 820         if (bytes_done[1])
 821                 ret |= __should_check_rate(td, 1);
 822
 823         return ret;
 824 }
 825
 826 static inline int is_power_of_2(unsigned int val)
 827 {
 828         return (val != 0 && ((val & (val - 1)) == 0));
 829 }
 830
 831 /*
 832  * We currently only need to do locking if we have verifier threads
 833  * accessing our internal structures too
 834  */
 835 static inline void td_io_u_lock(struct thread_data *td)
 836 {
 837         if (td->o.verify_async)
 838                 pthread_mutex_lock(&td->io_u_lock);
 839 }
 840
 841 static inline void td_io_u_unlock(struct thread_data *td)
 842 {
 843         if (td->o.verify_async)
 844                 pthread_mutex_unlock(&td->io_u_lock);
 845 }
 846
 847 static inline void td_io_u_free_notify(struct thread_data *td)
 848 {
 849         if (td->o.verify_async)
 850                 pthread_cond_signal(&td->free_cond);
 851 }
 852
 853 #endif