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