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