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         unsigned int num_open_zones;
 264
 265         unsigned int verify_batch;
 266         unsigned int trim_batch;
 267
 268         struct thread_io_list *vstate;
 269
 270         int shm_id;
 271
 272         /*
 273          * IO engine hooks, contains everything needed to submit an io_u
 274          * to any of the available IO engines.
 275          */
 276         struct ioengine_ops *io_ops;
 277         int io_ops_init;
 278
 279         /*
 280          * IO engine private data and dlhandle.
 281          */
 282         void *io_ops_data;
 283         void *io_ops_dlhandle;
 284
 285         /*
 286          * Queue depth of io_u's that fio MIGHT do
 287          */
 288         unsigned int cur_depth;
 289
 290         /*
 291          * io_u's about to be committed
 292          */
 293         unsigned int io_u_queued;
 294
 295         /*
 296          * io_u's submitted but not completed yet
 297          */
 298         unsigned int io_u_in_flight;
 299
 300         /*
 301          * List of free and busy io_u's
 302          */
 303         struct io_u_ring io_u_requeues;
 304         struct io_u_queue io_u_freelist;
 305         struct io_u_queue io_u_all;
 306         pthread_mutex_t io_u_lock;
 307         pthread_cond_t free_cond;
 308
 309         /*
 310          * async verify offload
 311          */
 312         struct flist_head verify_list;
 313         pthread_t *verify_threads;
 314         unsigned int nr_verify_threads;
 315         pthread_cond_t verify_cond;
 316         int verify_thread_exit;
 317
 318         /*
 319          * Rate state
 320          */
 321         uint64_t rate_bps[DDIR_RWDIR_CNT];
 322         uint64_t rate_next_io_time[DDIR_RWDIR_CNT];
 323         unsigned long long rate_bytes[DDIR_RWDIR_CNT];
 324         unsigned long rate_blocks[DDIR_RWDIR_CNT];
 325         unsigned long long rate_io_issue_bytes[DDIR_RWDIR_CNT];
 326         struct timespec lastrate[DDIR_RWDIR_CNT];
 327         int64_t last_usec[DDIR_RWDIR_CNT];
 328         struct frand_state poisson_state[DDIR_RWDIR_CNT];
 329
 330         /*
 331          * Enforced rate submission/completion workqueue
 332          */
 333         struct workqueue io_wq;
 334
 335         uint64_t total_io_size;
 336         uint64_t fill_device_size;
 337
 338         /*
 339          * Issue side
 340          */
 341         uint64_t io_issues[DDIR_RWDIR_CNT];
 342         uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
 343         uint64_t loops;
 344
 345         /*
 346          * Completions
 347          */
 348         uint64_t io_blocks[DDIR_RWDIR_CNT];
 349         uint64_t this_io_blocks[DDIR_RWDIR_CNT];
 350         uint64_t io_bytes[DDIR_RWDIR_CNT];
 351         uint64_t this_io_bytes[DDIR_RWDIR_CNT];
 352         uint64_t io_skip_bytes;
 353         uint64_t zone_bytes;
 354         struct fio_sem *sem;
 355         uint64_t bytes_done[DDIR_RWDIR_CNT];
 356
 357         /*
 358          * State for random io, a bitmap of blocks done vs not done
 359          */
 360         struct frand_state random_state;
 361
 362         struct timespec start;  /* start of this loop */
 363         struct timespec epoch;  /* time job was started */
 364         unsigned long long unix_epoch; /* Time job was started, unix epoch based. */
 365         struct timespec last_issue;
 366         long time_offset;
 367         struct timespec ts_cache;
 368         struct timespec terminate_time;
 369         unsigned int ts_cache_nr;
 370         unsigned int ts_cache_mask;
 371         bool ramp_time_over;
 372
 373         /*
 374          * Time since last latency_window was started
 375          */
 376         struct timespec latency_ts;
 377         unsigned int latency_qd;
 378         unsigned int latency_qd_high;
 379         unsigned int latency_qd_low;
 380         unsigned int latency_failed;
 381         unsigned int latency_stable_count;
 382         uint64_t latency_ios;
 383         int latency_end_run;
 384
 385         /*
 386          * read/write mixed workload state
 387          */
 388         struct frand_state rwmix_state;
 389         unsigned long rwmix_issues;
 390         enum fio_ddir rwmix_ddir;
 391         unsigned int ddir_seq_nr;
 392
 393         /*
 394          * rand/seq mixed workload state
 395          */
 396         struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
 397
 398         /*
 399          * IO history logs for verification. We use a tree for sorting,
 400          * if we are overwriting. Otherwise just use a fifo.
 401          */
 402         struct rb_root io_hist_tree;
 403         struct flist_head io_hist_list;
 404         unsigned long io_hist_len;
 405
 406         /*
 407          * For IO replaying
 408          */
 409         struct flist_head io_log_list;
 410         FILE *io_log_rfile;
 411         unsigned int io_log_current;
 412         unsigned int io_log_checkmark;
 413         unsigned int io_log_highmark;
 414         struct timespec io_log_highmark_time;
 415
 416         /*
 417          * For tracking/handling discards
 418          */
 419         struct flist_head trim_list;
 420         unsigned long trim_entries;
 421
 422         /*
 423          * for fileservice, how often to switch to a new file
 424          */
 425         unsigned int file_service_nr;
 426         unsigned int file_service_left;
 427         struct fio_file *file_service_file;
 428
 429         unsigned int sync_file_range_nr;
 430
 431         /*
 432          * For generating file sizes
 433          */
 434         struct frand_state file_size_state;
 435
 436         /*
 437          * Error counts
 438          */
 439         unsigned int total_err_count;
 440         int first_error;
 441
 442         struct fio_flow *flow;
 443
 444         /*
 445          * Can be overloaded by profiles
 446          */
 447         struct prof_io_ops prof_io_ops;
 448         void *prof_data;
 449
 450         void *pinned_mem;
 451
 452         struct steadystate_data ss;
 453
 454         char verror[FIO_VERROR_SIZE];
 455
 456 #ifdef CONFIG_CUDA
 457         /*
 458          * for GPU memory management
 459          */
 460         int gpu_dev_cnt;
 461         int gpu_dev_id;
 462         CUdevice  cu_dev;
 463         CUcontext cu_ctx;
 464         CUdeviceptr dev_mem_ptr;
 465 #endif
 466
 467 };
 468
 469 /*
 470  * when should interactive ETA output be generated
 471  */
 472 enum {
 473         FIO_ETA_AUTO,
 474         FIO_ETA_ALWAYS,
 475         FIO_ETA_NEVER,
 476 };
 477
 478 #define __td_verror(td, err, msg, func)                                 \
 479         do {                                                            \
 480                 unsigned int ____e = (err);                             \
 481                 if ((td)->error)                                        \
 482                         break;                                          \
 483                 (td)->error = ____e;                                    \
 484                 if (!(td)->first_error)                                 \
 485                         nowarn_snprintf(td->verror, sizeof(td->verror), \
 486                                         "file:%s:%d, func=%s, error=%s", \
 487                                         __FILE__, __LINE__, (func), (msg)); \
 488         } while (0)
 489
 490
 491 #define td_clear_error(td)              do {            \
 492         (td)->error = 0;                                \
 493         if ((td)->parent)                               \
 494                 (td)->parent->error = 0;                \
 495 } while (0)
 496
 497 #define td_verror(td, err, func)        do {                    \
 498         __td_verror((td), (err), strerror((err)), (func));      \
 499         if ((td)->parent)                                       \
 500                 __td_verror((td)->parent, (err), strerror((err)), (func)); \
 501 } while (0)
 502
 503 #define td_vmsg(td, err, msg, func)     do {                    \
 504         __td_verror((td), (err), (msg), (func));                \
 505         if ((td)->parent)                                       \
 506                 __td_verror((td)->parent, (err), (msg), (func));        \
 507 } while (0)
 508
 509 #define __fio_stringify_1(x)    #x
 510 #define __fio_stringify(x)      __fio_stringify_1(x)
 511
 512 extern bool exitall_on_terminate;
 513 extern unsigned int thread_number;
 514 extern unsigned int stat_number;
 515 extern int shm_id;
 516 extern int groupid;
 517 extern int output_format;
 518 extern int append_terse_output;
 519 extern int temp_stall_ts;
 520 extern uintptr_t page_mask, page_size;
 521 extern bool read_only;
 522 extern int eta_print;
 523 extern int eta_new_line;
 524 extern unsigned int eta_interval_msec;
 525 extern unsigned long done_secs;
 526 extern int fio_gtod_offload;
 527 extern int fio_gtod_cpu;
 528 extern enum fio_cs fio_clock_source;
 529 extern int fio_clock_source_set;
 530 extern int warnings_fatal;
 531 extern int terse_version;
 532 extern bool is_backend;
 533 extern bool is_local_backend;
 534 extern int nr_clients;
 535 extern bool log_syslog;
 536 extern int status_interval;
 537 extern const char fio_version_string[];
 538 extern char *trigger_file;
 539 extern char *trigger_cmd;
 540 extern char *trigger_remote_cmd;
 541 extern long long trigger_timeout;
 542 extern char *aux_path;
 543
 544 extern struct thread_data *threads;
 545
 546 static inline bool is_running_backend(void)
 547 {
 548         return is_backend || is_local_backend;
 549 }
 550
 551 extern bool eta_time_within_slack(unsigned int time);
 552
 553 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
 554 {
 555         assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)) &&
 556                !(io_u->ddir == DDIR_TRIM && !td_trim(td)));
 557 }
 558
 559 #define REAL_MAX_JOBS           4096
 560
 561 static inline bool should_fsync(struct thread_data *td)
 562 {
 563         if (td->last_was_sync)
 564                 return false;
 565         if (td_write(td) || td->o.override_sync)
 566                 return true;
 567
 568         return false;
 569 }
 570
 571 /*
 572  * Init/option functions
 573  */
 574 extern int __must_check fio_init_options(void);
 575 extern int __must_check parse_options(int, char **);
 576 extern int parse_jobs_ini(char *, int, int, int);
 577 extern int parse_cmd_line(int, char **, int);
 578 extern int fio_backend(struct sk_out *);
 579 extern void reset_fio_state(void);
 580 extern void clear_io_state(struct thread_data *, int);
 581 extern int fio_options_parse(struct thread_data *, char **, int);
 582 extern void fio_keywords_init(void);
 583 extern void fio_keywords_exit(void);
 584 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
 585 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
 586 extern void fio_fill_default_options(struct thread_data *);
 587 extern int fio_show_option_help(const char *);
 588 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
 589 extern void fio_options_dup_and_init(struct option *);
 590 extern char *fio_option_dup_subs(const char *);
 591 extern void fio_options_mem_dupe(struct thread_data *);
 592 extern void td_fill_rand_seeds(struct thread_data *);
 593 extern void td_fill_verify_state_seed(struct thread_data *);
 594 extern void add_job_opts(const char **, int);
 595 extern int ioengine_load(struct thread_data *);
 596 extern bool parse_dryrun(void);
 597 extern int fio_running_or_pending_io_threads(void);
 598 extern int fio_set_fd_nonblocking(int, const char *);
 599 extern void sig_show_status(int sig);
 600 extern struct thread_data *get_global_options(void);
 601
 602 extern uintptr_t page_mask;
 603 extern uintptr_t page_size;
 604 extern int initialize_fio(char *envp[]);
 605 extern void deinitialize_fio(void);
 606
 607 #define FIO_GETOPT_JOB          0x89000000
 608 #define FIO_GETOPT_IOENGINE     0x98000000
 609 #define FIO_NR_OPTIONS          (FIO_MAX_OPTS + 128)
 610
 611 /*
 612  * ETA/status stuff
 613  */
 614 extern void print_thread_status(void);
 615 extern void print_status_init(int);
 616 extern char *fio_uint_to_kmg(unsigned int val);
 617
 618 /*
 619  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 620  * will never back again. It may cycle between running/verififying/fsyncing.
 621  * Once the thread reaches TD_EXITED, it is just waiting for the core to
 622  * reap it.
 623  */
 624 enum {
 625         TD_NOT_CREATED = 0,
 626         TD_CREATED,
 627         TD_INITIALIZED,
 628         TD_RAMP,
 629         TD_SETTING_UP,
 630         TD_RUNNING,
 631         TD_PRE_READING,
 632         TD_VERIFYING,
 633         TD_FSYNCING,
 634         TD_FINISHING,
 635         TD_EXITED,
 636         TD_REAPED,
 637         TD_LAST,
 638         TD_NR,
 639 };
 640
 641 #define TD_ENG_FLAG_SHIFT       17
 642 #define TD_ENG_FLAG_MASK        ((1U << 17) - 1)
 643
 644 static inline void td_set_ioengine_flags(struct thread_data *td)
 645 {
 646         td->flags = (~(TD_ENG_FLAG_MASK << TD_ENG_FLAG_SHIFT) & td->flags) |
 647                     (td->io_ops->flags << TD_ENG_FLAG_SHIFT);
 648 }
 649
 650 static inline bool td_ioengine_flagged(struct thread_data *td,
 651                                        enum fio_ioengine_flags flags)
 652 {
 653         return ((td->flags >> TD_ENG_FLAG_SHIFT) & flags) != 0;
 654 }
 655
 656 extern void td_set_runstate(struct thread_data *, int);
 657 extern int td_bump_runstate(struct thread_data *, int);
 658 extern void td_restore_runstate(struct thread_data *, int);
 659 extern const char *runstate_to_name(int runstate);
 660
 661 /*
 662  * Allow 60 seconds for a job to quit on its own, otherwise reap with
 663  * a vengeance.
 664  */
 665 #define FIO_REAP_TIMEOUT        300
 666
 667 enum {
 668         TERMINATE_NONE = 0,
 669         TERMINATE_GROUP = 1,
 670         TERMINATE_STONEWALL = 2,
 671         TERMINATE_ALL = -1,
 672 };
 673
 674 extern void fio_terminate_threads(unsigned int, unsigned int);
 675 extern void fio_mark_td_terminate(struct thread_data *);
 676
 677 /*
 678  * Memory helpers
 679  */
 680 extern int __must_check fio_pin_memory(struct thread_data *);
 681 extern void fio_unpin_memory(struct thread_data *);
 682 extern int __must_check allocate_io_mem(struct thread_data *);
 683 extern void free_io_mem(struct thread_data *);
 684 extern void free_threads_shm(void);
 685
 686 #ifdef FIO_INTERNAL
 687 #define PTR_ALIGN(ptr, mask)    \
 688         (char *) (((uintptr_t) (ptr) + (mask)) & ~(mask))
 689 #endif
 690
 691 /*
 692  * Reset stats after ramp time completes
 693  */
 694 extern void reset_all_stats(struct thread_data *);
 695
 696 extern int io_queue_event(struct thread_data *td, struct io_u *io_u, int *ret,
 697                    enum fio_ddir ddir, uint64_t *bytes_issued, int from_verify,
 698                    struct timespec *comp_time);
 699
 700 /*
 701  * Latency target helpers
 702  */
 703 extern void lat_target_check(struct thread_data *);
 704 extern void lat_target_init(struct thread_data *);
 705 extern void lat_target_reset(struct thread_data *);
 706
 707 /*
 708  * Iterates all threads/processes within all the defined jobs
 709  */
 710 #define for_each_td(td, i)      \
 711         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
 712 #define for_each_file(td, f, i) \
 713         if ((td)->files_index)                                          \
 714                 for ((i) = 0, (f) = (td)->files[0];                     \
 715                  (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
 716                  (i)++)
 717
 718 static inline bool fio_fill_issue_time(struct thread_data *td)
 719 {
 720         if (td->o.read_iolog_file ||
 721             !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
 722                 return true;
 723
 724         return false;
 725 }
 726
 727 static inline bool option_check_rate(struct thread_data *td, enum fio_ddir ddir)
 728 {
 729         struct thread_options *o = &td->o;
 730
 731         /*
 732          * If some rate setting was given, we need to check it
 733          */
 734         if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
 735             o->rate_iops_min[ddir])
 736                 return true;
 737
 738         return false;
 739 }
 740
 741 static inline bool __should_check_rate(struct thread_data *td)
 742 {
 743         return (td->flags & TD_F_CHECK_RATE) != 0;
 744 }
 745
 746 static inline bool should_check_rate(struct thread_data *td)
 747 {
 748         if (!__should_check_rate(td))
 749                 return false;
 750
 751         return ddir_rw_sum(td->bytes_done) != 0;
 752 }
 753
 754 static inline unsigned long long td_max_bs(struct thread_data *td)
 755 {
 756         unsigned long long max_bs;
 757
 758         max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
 759         return max(td->o.max_bs[DDIR_TRIM], max_bs);
 760 }
 761
 762 static inline unsigned long long td_min_bs(struct thread_data *td)
 763 {
 764         unsigned long long min_bs;
 765
 766         min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
 767         return min(td->o.min_bs[DDIR_TRIM], min_bs);
 768 }
 769
 770 static inline bool td_async_processing(struct thread_data *td)
 771 {
 772         return (td->flags & TD_F_NEED_LOCK) != 0;
 773 }
 774
 775 static inline bool td_offload_overlap(struct thread_data *td)
 776 {
 777         return td->o.serialize_overlap && td->o.io_submit_mode == IO_MODE_OFFLOAD;
 778 }
 779
 780 /*
 781  * We currently only need to do locking if we have verifier threads
 782  * accessing our internal structures too
 783  */
 784 static inline void __td_io_u_lock(struct thread_data *td)
 785 {
 786         pthread_mutex_lock(&td->io_u_lock);
 787 }
 788
 789 static inline void __td_io_u_unlock(struct thread_data *td)
 790 {
 791         pthread_mutex_unlock(&td->io_u_lock);
 792 }
 793
 794 static inline void td_io_u_free_notify(struct thread_data *td)
 795 {
 796         if (td_async_processing(td))
 797                 pthread_cond_signal(&td->free_cond);
 798 }
 799
 800 static inline void td_flags_clear(struct thread_data *td, unsigned int *flags,
 801                                   unsigned int value)
 802 {
 803         if (!td_async_processing(td))
 804                 *flags &= ~value;
 805         else
 806                 __sync_fetch_and_and(flags, ~value);
 807 }
 808
 809 static inline void td_flags_set(struct thread_data *td, unsigned int *flags,
 810                                 unsigned int value)
 811 {
 812         if (!td_async_processing(td))
 813                 *flags |= value;
 814         else
 815                 __sync_fetch_and_or(flags, value);
 816 }
 817
 818 extern const char *fio_get_arch_string(int);
 819 extern const char *fio_get_os_string(int);
 820
 821 enum {
 822         __FIO_OUTPUT_TERSE      = 0,
 823         __FIO_OUTPUT_JSON       = 1,
 824         __FIO_OUTPUT_NORMAL     = 2,
 825         __FIO_OUTPUT_JSON_PLUS  = 3,
 826         FIO_OUTPUT_NR           = 4,
 827
 828         FIO_OUTPUT_TERSE        = 1U << __FIO_OUTPUT_TERSE,
 829         FIO_OUTPUT_JSON         = 1U << __FIO_OUTPUT_JSON,
 830         FIO_OUTPUT_NORMAL       = 1U << __FIO_OUTPUT_NORMAL,
 831         FIO_OUTPUT_JSON_PLUS    = 1U << __FIO_OUTPUT_JSON_PLUS,
 832 };
 833
 834 enum {
 835         FIO_RAND_DIST_RANDOM    = 0,
 836         FIO_RAND_DIST_ZIPF,
 837         FIO_RAND_DIST_PARETO,
 838         FIO_RAND_DIST_GAUSS,
 839         FIO_RAND_DIST_ZONED,
 840         FIO_RAND_DIST_ZONED_ABS,
 841 };
 842
 843 #define FIO_DEF_ZIPF            1.1
 844 #define FIO_DEF_PARETO          0.2
 845
 846 enum {
 847         FIO_RAND_GEN_TAUSWORTHE = 0,
 848         FIO_RAND_GEN_LFSR,
 849         FIO_RAND_GEN_TAUSWORTHE64,
 850 };
 851
 852 enum {
 853         FIO_CPUS_SHARED         = 0,
 854         FIO_CPUS_SPLIT,
 855 };
 856
 857 extern void exec_trigger(const char *);
 858 extern void check_trigger_file(void);
 859
 860 extern bool in_flight_overlap(struct io_u_queue *q, struct io_u *io_u);
 861 extern pthread_mutex_t overlap_check;
 862
 863 static inline void *fio_memalign(size_t alignment, size_t size, bool shared)
 864 {
 865         return __fio_memalign(alignment, size, shared ? smalloc : malloc);
 866 }
 867
 868 static inline void fio_memfree(void *ptr, size_t size, bool shared)
 869 {
 870         return __fio_memfree(ptr, size, shared ? sfree : free);
 871 }
 872
 873 #endif