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