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 "thread_options.h"
  19 #include "flist.h"
  20 #include "fifo.h"
  21 #include "arch/arch.h"
  22 #include "os/os.h"
  23 #include "log.h"
  24 #include "debug.h"
  25 #include "file.h"
  26 #include "io_ddir.h"
  27 #include "ioengines.h"
  28 #include "iolog.h"
  29 #include "helpers.h"
  30 #include "minmax.h"
  31 #include "options.h"
  32 #include "profile.h"
  33 #include "fio_time.h"
  34 #include "gettime.h"
  35 #include "oslib/getopt.h"
  36 #include "lib/rand.h"
  37 #include "lib/rbtree.h"
  38 #include "lib/num2str.h"
  39 #include "client.h"
  40 #include "server.h"
  41 #include "stat.h"
  42 #include "flow.h"
  43 #include "io_u.h"
  44 #include "io_u_queue.h"
  45 #include "workqueue.h"
  46 #include "steadystate.h"
  47 #include "lib/nowarn_snprintf.h"
  48
  49 #ifdef CONFIG_SOLARISAIO
  50 #include <sys/asynch.h>
  51 #endif
  52
  53 #ifdef CONFIG_LIBNUMA
  54 #include <linux/mempolicy.h>
  55 #include <numa.h>
  56
  57 /*
  58  * "local" is pseudo-policy
  59  */
  60 #define MPOL_LOCAL MPOL_MAX
  61 #endif
  62
  63 #ifdef CONFIG_CUDA
  64 #include <cuda.h>
  65 #endif
  66
  67 struct fio_sem;
  68
  69 /*
  70  * offset generator types
  71  */
  72 enum {
  73         RW_SEQ_SEQ      = 0,
  74         RW_SEQ_IDENT,
  75 };
  76
  77 enum {
  78         __TD_F_VER_BACKLOG      = 0,
  79         __TD_F_TRIM_BACKLOG,
  80         __TD_F_READ_IOLOG,
  81         __TD_F_REFILL_BUFFERS,
  82         __TD_F_SCRAMBLE_BUFFERS,
  83         __TD_F_DO_VERIFY,
  84         __TD_F_PROFILE_OPS,
  85         __TD_F_COMPRESS,
  86         __TD_F_COMPRESS_LOG,
  87         __TD_F_VSTATE_SAVED,
  88         __TD_F_NEED_LOCK,
  89         __TD_F_CHILD,
  90         __TD_F_NO_PROGRESS,
  91         __TD_F_REGROW_LOGS,
  92         __TD_F_MMAP_KEEP,
  93         __TD_F_DIRS_CREATED,
  94         __TD_F_CHECK_RATE,
  95         __TD_F_LAST,            /* not a real bit, keep last */
  96 };
  97
  98 enum {
  99         TD_F_VER_BACKLOG        = 1U << __TD_F_VER_BACKLOG,
 100         TD_F_TRIM_BACKLOG       = 1U << __TD_F_TRIM_BACKLOG,
 101         TD_F_READ_IOLOG         = 1U << __TD_F_READ_IOLOG,
 102         TD_F_REFILL_BUFFERS     = 1U << __TD_F_REFILL_BUFFERS,
 103         TD_F_SCRAMBLE_BUFFERS   = 1U << __TD_F_SCRAMBLE_BUFFERS,
 104         TD_F_DO_VERIFY          = 1U << __TD_F_DO_VERIFY,
 105         TD_F_PROFILE_OPS        = 1U << __TD_F_PROFILE_OPS,
 106         TD_F_COMPRESS           = 1U << __TD_F_COMPRESS,
 107         TD_F_COMPRESS_LOG       = 1U << __TD_F_COMPRESS_LOG,
 108         TD_F_VSTATE_SAVED       = 1U << __TD_F_VSTATE_SAVED,
 109         TD_F_NEED_LOCK          = 1U << __TD_F_NEED_LOCK,
 110         TD_F_CHILD              = 1U << __TD_F_CHILD,
 111         TD_F_NO_PROGRESS        = 1U << __TD_F_NO_PROGRESS,
 112         TD_F_REGROW_LOGS        = 1U << __TD_F_REGROW_LOGS,
 113         TD_F_MMAP_KEEP          = 1U << __TD_F_MMAP_KEEP,
 114         TD_F_DIRS_CREATED       = 1U << __TD_F_DIRS_CREATED,
 115         TD_F_CHECK_RATE         = 1U << __TD_F_CHECK_RATE,
 116 };
 117
 118 enum {
 119         FIO_RAND_BS_OFF         = 0,
 120         FIO_RAND_BS1_OFF,
 121         FIO_RAND_BS2_OFF,
 122         FIO_RAND_VER_OFF,
 123         FIO_RAND_MIX_OFF,
 124         FIO_RAND_FILE_OFF,
 125         FIO_RAND_BLOCK_OFF,
 126         FIO_RAND_FILE_SIZE_OFF,
 127         FIO_RAND_TRIM_OFF,
 128         FIO_RAND_BUF_OFF,
 129         FIO_RAND_SEQ_RAND_READ_OFF,
 130         FIO_RAND_SEQ_RAND_WRITE_OFF,
 131         FIO_RAND_SEQ_RAND_TRIM_OFF,
 132         FIO_RAND_START_DELAY,
 133         FIO_DEDUPE_OFF,
 134         FIO_RAND_POISSON_OFF,
 135         FIO_RAND_ZONE_OFF,
 136         FIO_RAND_POISSON2_OFF,
 137         FIO_RAND_POISSON3_OFF,
 138         FIO_RAND_NR_OFFS,
 139 };
 140
 141 enum {
 142         IO_MODE_INLINE = 0,
 143         IO_MODE_OFFLOAD = 1,
 144
 145         RATE_PROCESS_LINEAR = 0,
 146         RATE_PROCESS_POISSON = 1,
 147 };
 148
 149 enum {
 150         F_ADV_NONE = 0,
 151         F_ADV_TYPE,
 152         F_ADV_RANDOM,
 153         F_ADV_SEQUENTIAL,
 154 };
 155
 156 /*
 157  * Per-thread/process specific data. Only used for the network client
 158  * for now.
 159  */
 160 void sk_out_assign(struct sk_out *);
 161 void sk_out_drop(void);
 162
 163 struct zone_split_index {
 164         uint8_t size_perc;
 165         uint8_t size_perc_prev;
 166         uint64_t size;
 167         uint64_t size_prev;
 168 };
 169
 170 /*
 171  * This describes a single thread/process executing a fio job.
 172  */
 173 struct thread_data {
 174         struct flist_head opt_list;
 175         unsigned long flags;
 176         struct thread_options o;
 177         void *eo;
 178         pthread_t thread;
 179         unsigned int thread_number;
 180         unsigned int subjob_number;
 181         unsigned int groupid;
 182         struct thread_stat ts __attribute__ ((aligned(8)));
 183
 184         int client_type;
 185
 186         struct io_log *slat_log;
 187         struct io_log *clat_log;
 188         struct io_log *clat_hist_log;
 189         struct io_log *lat_log;
 190         struct io_log *bw_log;
 191         struct io_log *iops_log;
 192
 193         struct workqueue log_compress_wq;
 194
 195         struct thread_data *parent;
 196
 197         uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
 198         struct timespec bw_sample_time;
 199
 200         uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
 201         struct timespec iops_sample_time;
 202
 203         volatile int update_rusage;
 204         struct fio_sem *rusage_sem;
 205         struct rusage ru_start;
 206         struct rusage ru_end;
 207
 208         struct fio_file **files;
 209         unsigned char *file_locks;
 210         unsigned int files_size;
 211         unsigned int files_index;
 212         unsigned int nr_open_files;
 213         unsigned int nr_done_files;
 214         union {
 215                 unsigned int next_file;
 216                 struct frand_state next_file_state;
 217         };
 218         union {
 219                 struct zipf_state next_file_zipf;
 220                 struct gauss_state next_file_gauss;
 221         };
 222         union {
 223                 double zipf_theta;
 224                 double pareto_h;
 225                 double gauss_dev;
 226         };
 227         int error;
 228         int sig;
 229         int done;
 230         int stop_io;
 231         pid_t pid;
 232         char *orig_buffer;
 233         size_t orig_buffer_size;
 234         volatile int runstate;
 235         volatile bool terminate;
 236         bool last_was_sync;
 237         enum fio_ddir last_ddir;
 238
 239         int mmapfd;
 240
 241         void *iolog_buf;
 242         FILE *iolog_f;
 243
 244         unsigned long rand_seeds[FIO_RAND_NR_OFFS];
 245
 246         struct frand_state bsrange_state[DDIR_RWDIR_CNT];
 247         struct frand_state verify_state;
 248         struct frand_state trim_state;
 249         struct frand_state delay_state;
 250
 251         struct frand_state buf_state;
 252         struct frand_state buf_state_prev;
 253         struct frand_state dedupe_state;
 254         struct frand_state zone_state;
 255
 256         struct zone_split_index **zone_state_index;
 257
 258         unsigned int verify_batch;
 259         unsigned int trim_batch;
 260
 261         struct thread_io_list *vstate;
 262
 263         int shm_id;
 264
 265         /*
 266          * IO engine hooks, contains everything needed to submit an io_u
 267          * to any of the available IO engines.
 268          */
 269         struct ioengine_ops *io_ops;
 270         int io_ops_init;
 271
 272         /*
 273          * IO engine private data and dlhandle.
 274          */
 275         void *io_ops_data;
 276         void *io_ops_dlhandle;
 277
 278         /*
 279          * Queue depth of io_u's that fio MIGHT do
 280          */
 281         unsigned int cur_depth;
 282
 283         /*
 284          * io_u's about to be committed
 285          */
 286         unsigned int io_u_queued;
 287
 288         /*
 289          * io_u's submitted but not completed yet
 290          */
 291         unsigned int io_u_in_flight;
 292
 293         /*
 294          * List of free and busy io_u's
 295          */
 296         struct io_u_ring io_u_requeues;
 297         struct io_u_queue io_u_freelist;
 298         struct io_u_queue io_u_all;
 299         pthread_mutex_t io_u_lock;
 300         pthread_cond_t free_cond;
 301
 302         /*
 303          * async verify offload
 304          */
 305         struct flist_head verify_list;
 306         pthread_t *verify_threads;
 307         unsigned int nr_verify_threads;
 308         pthread_cond_t verify_cond;
 309         int verify_thread_exit;
 310
 311         /*
 312          * Rate state
 313          */
 314         uint64_t rate_bps[DDIR_RWDIR_CNT];
 315         uint64_t rate_next_io_time[DDIR_RWDIR_CNT];
 316         unsigned long rate_bytes[DDIR_RWDIR_CNT];
 317         unsigned long rate_blocks[DDIR_RWDIR_CNT];
 318         unsigned long long rate_io_issue_bytes[DDIR_RWDIR_CNT];
 319         struct timespec lastrate[DDIR_RWDIR_CNT];
 320         int64_t last_usec[DDIR_RWDIR_CNT];
 321         struct frand_state poisson_state[DDIR_RWDIR_CNT];
 322
 323         /*
 324          * Enforced rate submission/completion workqueue
 325          */
 326         struct workqueue io_wq;
 327
 328         uint64_t total_io_size;
 329         uint64_t fill_device_size;
 330
 331         /*
 332          * Issue side
 333          */
 334         uint64_t io_issues[DDIR_RWDIR_CNT];
 335         uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
 336         uint64_t loops;
 337
 338         /*
 339          * Completions
 340          */
 341         uint64_t io_blocks[DDIR_RWDIR_CNT];
 342         uint64_t this_io_blocks[DDIR_RWDIR_CNT];
 343         uint64_t io_bytes[DDIR_RWDIR_CNT];
 344         uint64_t this_io_bytes[DDIR_RWDIR_CNT];
 345         uint64_t io_skip_bytes;
 346         uint64_t zone_bytes;
 347         struct fio_sem *sem;
 348         uint64_t bytes_done[DDIR_RWDIR_CNT];
 349
 350         /*
 351          * State for random io, a bitmap of blocks done vs not done
 352          */
 353         struct frand_state random_state;
 354
 355         struct timespec start;  /* start of this loop */
 356         struct timespec epoch;  /* time job was started */
 357         unsigned long long unix_epoch; /* Time job was started, unix epoch based. */
 358         struct timespec last_issue;
 359         long time_offset;
 360         struct timespec ts_cache;
 361         struct timespec terminate_time;
 362         unsigned int ts_cache_nr;
 363         unsigned int ts_cache_mask;
 364         bool ramp_time_over;
 365
 366         /*
 367          * Time since last latency_window was started
 368          */
 369         struct timespec latency_ts;
 370         unsigned int latency_qd;
 371         unsigned int latency_qd_high;
 372         unsigned int latency_qd_low;
 373         unsigned int latency_failed;
 374         uint64_t latency_ios;
 375         int latency_end_run;
 376
 377         /*
 378          * read/write mixed workload state
 379          */
 380         struct frand_state rwmix_state;
 381         unsigned long rwmix_issues;
 382         enum fio_ddir rwmix_ddir;
 383         unsigned int ddir_seq_nr;
 384
 385         /*
 386          * rand/seq mixed workload state
 387          */
 388         struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
 389
 390         /*
 391          * IO history logs for verification. We use a tree for sorting,
 392          * if we are overwriting. Otherwise just use a fifo.
 393          */
 394         struct rb_root io_hist_tree;
 395         struct flist_head io_hist_list;
 396         unsigned long io_hist_len;
 397
 398         /*
 399          * For IO replaying
 400          */
 401         struct flist_head io_log_list;
 402         FILE *io_log_rfile;
 403         unsigned int io_log_current;
 404         unsigned int io_log_checkmark;
 405         unsigned int io_log_highmark;
 406         struct timespec io_log_highmark_time;
 407
 408         /*
 409          * For tracking/handling discards
 410          */
 411         struct flist_head trim_list;
 412         unsigned long trim_entries;
 413
 414         /*
 415          * for fileservice, how often to switch to a new file
 416          */
 417         unsigned int file_service_nr;
 418         unsigned int file_service_left;
 419         struct fio_file *file_service_file;
 420
 421         unsigned int sync_file_range_nr;
 422
 423         /*
 424          * For generating file sizes
 425          */
 426         struct frand_state file_size_state;
 427
 428         /*
 429          * Error counts
 430          */
 431         unsigned int total_err_count;
 432         int first_error;
 433
 434         struct fio_flow *flow;
 435
 436         /*
 437          * Can be overloaded by profiles
 438          */
 439         struct prof_io_ops prof_io_ops;
 440         void *prof_data;
 441
 442         void *pinned_mem;
 443
 444         struct steadystate_data ss;
 445
 446         char verror[FIO_VERROR_SIZE];
 447
 448 #ifdef CONFIG_CUDA
 449         /*
 450          * for GPU memory management
 451          */
 452         int gpu_dev_cnt;
 453         int gpu_dev_id;
 454         CUdevice  cu_dev;
 455         CUcontext cu_ctx;
 456         CUdeviceptr dev_mem_ptr;
 457 #endif
 458
 459 };
 460
 461 /*
 462  * when should interactive ETA output be generated
 463  */
 464 enum {
 465         FIO_ETA_AUTO,
 466         FIO_ETA_ALWAYS,
 467         FIO_ETA_NEVER,
 468 };
 469
 470 #define __td_verror(td, err, msg, func)                                 \
 471         do {                                                            \
 472                 unsigned int ____e = (err);                             \
 473                 if ((td)->error)                                        \
 474                         break;                                          \
 475                 (td)->error = ____e;                                    \
 476                 if (!(td)->first_error)                                 \
 477                         nowarn_snprintf(td->verror, sizeof(td->verror), \
 478                                         "file:%s:%d, func=%s, error=%s", \
 479                                         __FILE__, __LINE__, (func), (msg)); \
 480         } while (0)
 481
 482
 483 #define td_clear_error(td)              do {            \
 484         (td)->error = 0;                                \
 485         if ((td)->parent)                               \
 486                 (td)->parent->error = 0;                \
 487 } while (0)
 488
 489 #define td_verror(td, err, func)        do {                    \
 490         __td_verror((td), (err), strerror((err)), (func));      \
 491         if ((td)->parent)                                       \
 492                 __td_verror((td)->parent, (err), strerror((err)), (func)); \
 493 } while (0)
 494
 495 #define td_vmsg(td, err, msg, func)     do {                    \
 496         __td_verror((td), (err), (msg), (func));                \
 497         if ((td)->parent)                                       \
 498                 __td_verror((td)->parent, (err), (msg), (func));        \
 499 } while (0)
 500
 501 #define __fio_stringify_1(x)    #x
 502 #define __fio_stringify(x)      __fio_stringify_1(x)
 503
 504 extern int exitall_on_terminate;
 505 extern unsigned int thread_number;
 506 extern unsigned int stat_number;
 507 extern int shm_id;
 508 extern int groupid;
 509 extern int output_format;
 510 extern int append_terse_output;
 511 extern int temp_stall_ts;
 512 extern uintptr_t page_mask, page_size;
 513 extern int read_only;
 514 extern int eta_print;
 515 extern int eta_new_line;
 516 extern unsigned int eta_interval_msec;
 517 extern unsigned long done_secs;
 518 extern int fio_gtod_offload;
 519 extern int fio_gtod_cpu;
 520 extern enum fio_cs fio_clock_source;
 521 extern int fio_clock_source_set;
 522 extern int warnings_fatal;
 523 extern int terse_version;
 524 extern int is_backend;
 525 extern int is_local_backend;
 526 extern int nr_clients;
 527 extern int log_syslog;
 528 extern int status_interval;
 529 extern const char fio_version_string[];
 530 extern char *trigger_file;
 531 extern char *trigger_cmd;
 532 extern char *trigger_remote_cmd;
 533 extern long long trigger_timeout;
 534 extern char *aux_path;
 535
 536 extern struct thread_data *threads;
 537
 538 static inline bool is_running_backend(void)
 539 {
 540         return is_backend || is_local_backend;
 541 }
 542
 543 extern bool eta_time_within_slack(unsigned int time);
 544
 545 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
 546 {
 547         assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)) &&
 548                !(io_u->ddir == DDIR_TRIM && !td_trim(td)));
 549 }
 550
 551 #define REAL_MAX_JOBS           4096
 552
 553 static inline bool should_fsync(struct thread_data *td)
 554 {
 555         if (td->last_was_sync)
 556                 return false;
 557         if (td_write(td) || td->o.override_sync)
 558                 return true;
 559
 560         return false;
 561 }
 562
 563 /*
 564  * Init/option functions
 565  */
 566 extern int __must_check fio_init_options(void);
 567 extern int __must_check parse_options(int, char **);
 568 extern int parse_jobs_ini(char *, int, int, int);
 569 extern int parse_cmd_line(int, char **, int);
 570 extern int fio_backend(struct sk_out *);
 571 extern void reset_fio_state(void);
 572 extern void clear_io_state(struct thread_data *, int);
 573 extern int fio_options_parse(struct thread_data *, char **, int);
 574 extern void fio_keywords_init(void);
 575 extern void fio_keywords_exit(void);
 576 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
 577 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
 578 extern void fio_fill_default_options(struct thread_data *);
 579 extern int fio_show_option_help(const char *);
 580 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
 581 extern void fio_options_dup_and_init(struct option *);
 582 extern char *fio_option_dup_subs(const char *);
 583 extern void fio_options_mem_dupe(struct thread_data *);
 584 extern void td_fill_rand_seeds(struct thread_data *);
 585 extern void td_fill_verify_state_seed(struct thread_data *);
 586 extern void add_job_opts(const char **, int);
 587 extern int ioengine_load(struct thread_data *);
 588 extern bool parse_dryrun(void);
 589 extern int fio_running_or_pending_io_threads(void);
 590 extern int fio_set_fd_nonblocking(int, const char *);
 591 extern void sig_show_status(int sig);
 592 extern struct thread_data *get_global_options(void);
 593
 594 extern uintptr_t page_mask;
 595 extern uintptr_t page_size;
 596 extern int initialize_fio(char *envp[]);
 597 extern void deinitialize_fio(void);
 598
 599 #define FIO_GETOPT_JOB          0x89000000
 600 #define FIO_GETOPT_IOENGINE     0x98000000
 601 #define FIO_NR_OPTIONS          (FIO_MAX_OPTS + 128)
 602
 603 /*
 604  * ETA/status stuff
 605  */
 606 extern void print_thread_status(void);
 607 extern void print_status_init(int);
 608 extern char *fio_uint_to_kmg(unsigned int val);
 609
 610 /*
 611  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 612  * will never back again. It may cycle between running/verififying/fsyncing.
 613  * Once the thread reaches TD_EXITED, it is just waiting for the core to
 614  * reap it.
 615  */
 616 enum {
 617         TD_NOT_CREATED = 0,
 618         TD_CREATED,
 619         TD_INITIALIZED,
 620         TD_RAMP,
 621         TD_SETTING_UP,
 622         TD_RUNNING,
 623         TD_PRE_READING,
 624         TD_VERIFYING,
 625         TD_FSYNCING,
 626         TD_FINISHING,
 627         TD_EXITED,
 628         TD_REAPED,
 629         TD_LAST,
 630         TD_NR,
 631 };
 632
 633 #define TD_ENG_FLAG_SHIFT       17
 634 #define TD_ENG_FLAG_MASK        ((1U << 17) - 1)
 635
 636 static inline void td_set_ioengine_flags(struct thread_data *td)
 637 {
 638         td->flags = (~(TD_ENG_FLAG_MASK << TD_ENG_FLAG_SHIFT) & td->flags) |
 639                     (td->io_ops->flags << TD_ENG_FLAG_SHIFT);
 640 }
 641
 642 static inline bool td_ioengine_flagged(struct thread_data *td,
 643                                        enum fio_ioengine_flags flags)
 644 {
 645         return ((td->flags >> TD_ENG_FLAG_SHIFT) & flags) != 0;
 646 }
 647
 648 extern void td_set_runstate(struct thread_data *, int);
 649 extern int td_bump_runstate(struct thread_data *, int);
 650 extern void td_restore_runstate(struct thread_data *, int);
 651 extern const char *runstate_to_name(int runstate);
 652
 653 /*
 654  * Allow 60 seconds for a job to quit on its own, otherwise reap with
 655  * a vengeance.
 656  */
 657 #define FIO_REAP_TIMEOUT        300
 658
 659 #define TERMINATE_ALL           (-1U)
 660 extern void fio_terminate_threads(unsigned int);
 661 extern void fio_mark_td_terminate(struct thread_data *);
 662
 663 /*
 664  * Memory helpers
 665  */
 666 extern int __must_check fio_pin_memory(struct thread_data *);
 667 extern void fio_unpin_memory(struct thread_data *);
 668 extern int __must_check allocate_io_mem(struct thread_data *);
 669 extern void free_io_mem(struct thread_data *);
 670 extern void free_threads_shm(void);
 671
 672 #ifdef FIO_INTERNAL
 673 #define PTR_ALIGN(ptr, mask)    \
 674         (char *) (((uintptr_t) (ptr) + (mask)) & ~(mask))
 675 #endif
 676
 677 /*
 678  * Reset stats after ramp time completes
 679  */
 680 extern void reset_all_stats(struct thread_data *);
 681
 682 extern int io_queue_event(struct thread_data *td, struct io_u *io_u, int *ret,
 683                    enum fio_ddir ddir, uint64_t *bytes_issued, int from_verify,
 684                    struct timespec *comp_time);
 685
 686 /*
 687  * Latency target helpers
 688  */
 689 extern void lat_target_check(struct thread_data *);
 690 extern void lat_target_init(struct thread_data *);
 691 extern void lat_target_reset(struct thread_data *);
 692
 693 /*
 694  * Iterates all threads/processes within all the defined jobs
 695  */
 696 #define for_each_td(td, i)      \
 697         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
 698 #define for_each_file(td, f, i) \
 699         if ((td)->files_index)                                          \
 700                 for ((i) = 0, (f) = (td)->files[0];                     \
 701                  (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
 702                  (i)++)
 703
 704 #define fio_assert(td, cond)    do {    \
 705         if (!(cond)) {                  \
 706                 int *__foo = NULL;      \
 707                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
 708                 td_set_runstate((td), TD_EXITED);       \
 709                 (td)->error = EFAULT;           \
 710                 *__foo = 0;                     \
 711         }       \
 712 } while (0)
 713
 714 static inline bool fio_fill_issue_time(struct thread_data *td)
 715 {
 716         if (td->o.read_iolog_file ||
 717             !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
 718                 return true;
 719
 720         return false;
 721 }
 722
 723 static inline bool option_check_rate(struct thread_data *td, enum fio_ddir ddir)
 724 {
 725         struct thread_options *o = &td->o;
 726
 727         /*
 728          * If some rate setting was given, we need to check it
 729          */
 730         if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
 731             o->rate_iops_min[ddir])
 732                 return true;
 733
 734         return false;
 735 }
 736
 737 static inline bool __should_check_rate(struct thread_data *td)
 738 {
 739         return (td->flags & TD_F_CHECK_RATE) != 0;
 740 }
 741
 742 static inline bool should_check_rate(struct thread_data *td)
 743 {
 744         if (!__should_check_rate(td))
 745                 return false;
 746
 747         return ddir_rw_sum(td->bytes_done) != 0;
 748 }
 749
 750 static inline unsigned long long td_max_bs(struct thread_data *td)
 751 {
 752         unsigned long long max_bs;
 753
 754         max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
 755         return max(td->o.max_bs[DDIR_TRIM], max_bs);
 756 }
 757
 758 static inline unsigned long long td_min_bs(struct thread_data *td)
 759 {
 760         unsigned long long min_bs;
 761
 762         min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
 763         return min(td->o.min_bs[DDIR_TRIM], min_bs);
 764 }
 765
 766 static inline bool td_async_processing(struct thread_data *td)
 767 {
 768         return (td->flags & TD_F_NEED_LOCK) != 0;
 769 }
 770
 771 /*
 772  * We currently only need to do locking if we have verifier threads
 773  * accessing our internal structures too
 774  */
 775 static inline void td_io_u_lock(struct thread_data *td)
 776 {
 777         if (td_async_processing(td))
 778                 pthread_mutex_lock(&td->io_u_lock);
 779 }
 780
 781 static inline void td_io_u_unlock(struct thread_data *td)
 782 {
 783         if (td_async_processing(td))
 784                 pthread_mutex_unlock(&td->io_u_lock);
 785 }
 786
 787 static inline void td_io_u_free_notify(struct thread_data *td)
 788 {
 789         if (td_async_processing(td))
 790                 pthread_cond_signal(&td->free_cond);
 791 }
 792
 793 static inline void td_flags_clear(struct thread_data *td, unsigned int *flags,
 794                                   unsigned int value)
 795 {
 796         if (!td_async_processing(td))
 797                 *flags &= ~value;
 798         else
 799                 __sync_fetch_and_and(flags, ~value);
 800 }
 801
 802 static inline void td_flags_set(struct thread_data *td, unsigned int *flags,
 803                                 unsigned int value)
 804 {
 805         if (!td_async_processing(td))
 806                 *flags |= value;
 807         else
 808                 __sync_fetch_and_or(flags, value);
 809 }
 810
 811 extern const char *fio_get_arch_string(int);
 812 extern const char *fio_get_os_string(int);
 813
 814 enum {
 815         __FIO_OUTPUT_TERSE      = 0,
 816         __FIO_OUTPUT_JSON       = 1,
 817         __FIO_OUTPUT_NORMAL     = 2,
 818         __FIO_OUTPUT_JSON_PLUS  = 3,
 819         FIO_OUTPUT_NR           = 4,
 820
 821         FIO_OUTPUT_TERSE        = 1U << __FIO_OUTPUT_TERSE,
 822         FIO_OUTPUT_JSON         = 1U << __FIO_OUTPUT_JSON,
 823         FIO_OUTPUT_NORMAL       = 1U << __FIO_OUTPUT_NORMAL,
 824         FIO_OUTPUT_JSON_PLUS    = 1U << __FIO_OUTPUT_JSON_PLUS,
 825 };
 826
 827 enum {
 828         FIO_RAND_DIST_RANDOM    = 0,
 829         FIO_RAND_DIST_ZIPF,
 830         FIO_RAND_DIST_PARETO,
 831         FIO_RAND_DIST_GAUSS,
 832         FIO_RAND_DIST_ZONED,
 833         FIO_RAND_DIST_ZONED_ABS,
 834 };
 835
 836 #define FIO_DEF_ZIPF            1.1
 837 #define FIO_DEF_PARETO          0.2
 838
 839 enum {
 840         FIO_RAND_GEN_TAUSWORTHE = 0,
 841         FIO_RAND_GEN_LFSR,
 842         FIO_RAND_GEN_TAUSWORTHE64,
 843 };
 844
 845 enum {
 846         FIO_CPUS_SHARED         = 0,
 847         FIO_CPUS_SPLIT,
 848 };
 849
 850 extern void exec_trigger(const char *);
 851 extern void check_trigger_file(void);
 852
 853 #endif