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