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