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