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