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