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 "mutex.h"
  24 #include "log.h"
  25 #include "debug.h"
  26 #include "file.h"
  27 #include "io_ddir.h"
  28 #include "ioengine.h"
  29 #include "iolog.h"
  30 #include "helpers.h"
  31 #include "options.h"
  32 #include "profile.h"
  33 #include "fio_time.h"
  34 #include "gettime.h"
  35 #include "lib/getopt.h"
  36 #include "lib/rand.h"
  37 #include "lib/rbtree.h"
  38 #include "client.h"
  39 #include "server.h"
  40 #include "stat.h"
  41 #include "flow.h"
  42 #include "io_u_queue.h"
  43 #include "workqueue.h"
  44
  45 #ifdef CONFIG_SOLARISAIO
  46 #include <sys/asynch.h>
  47 #endif
  48
  49 #ifdef CONFIG_LIBNUMA
  50 #include <linux/mempolicy.h>
  51 #include <numa.h>
  52
  53 /*
  54  * "local" is pseudo-policy
  55  */
  56 #define MPOL_LOCAL MPOL_MAX
  57 #endif
  58
  59 /*
  60  * offset generator types
  61  */
  62 enum {
  63         RW_SEQ_SEQ      = 0,
  64         RW_SEQ_IDENT,
  65 };
  66
  67 enum {
  68         TD_F_VER_BACKLOG        = 1U << 0,
  69         TD_F_TRIM_BACKLOG       = 1U << 1,
  70         TD_F_READ_IOLOG         = 1U << 2,
  71         TD_F_REFILL_BUFFERS     = 1U << 3,
  72         TD_F_SCRAMBLE_BUFFERS   = 1U << 4,
  73         TD_F_VER_NONE           = 1U << 5,
  74         TD_F_PROFILE_OPS        = 1U << 6,
  75         TD_F_COMPRESS           = 1U << 7,
  76         TD_F_NOIO               = 1U << 8,
  77         TD_F_COMPRESS_LOG       = 1U << 9,
  78         TD_F_VSTATE_SAVED       = 1U << 10,
  79         TD_F_NEED_LOCK          = 1U << 11,
  80         TD_F_CHILD              = 1U << 12,
  81         TD_F_NO_PROGRESS        = 1U << 13,
  82 };
  83
  84 enum {
  85         FIO_RAND_BS_OFF         = 0,
  86         FIO_RAND_VER_OFF,
  87         FIO_RAND_MIX_OFF,
  88         FIO_RAND_FILE_OFF,
  89         FIO_RAND_BLOCK_OFF,
  90         FIO_RAND_FILE_SIZE_OFF,
  91         FIO_RAND_TRIM_OFF,
  92         FIO_RAND_BUF_OFF,
  93         FIO_RAND_SEQ_RAND_READ_OFF,
  94         FIO_RAND_SEQ_RAND_WRITE_OFF,
  95         FIO_RAND_SEQ_RAND_TRIM_OFF,
  96         FIO_RAND_START_DELAY,
  97         FIO_DEDUPE_OFF,
  98         FIO_RAND_NR_OFFS,
  99 };
 100
 101 enum {
 102         IO_MODE_INLINE = 0,
 103         IO_MODE_OFFLOAD,
 104 };
 105
 106 /*
 107  * This describes a single thread/process executing a fio job.
 108  */
 109 struct thread_data {
 110         struct thread_options o;
 111         unsigned long flags;
 112         void *eo;
 113         char verror[FIO_VERROR_SIZE];
 114         pthread_t thread;
 115         unsigned int thread_number;
 116         unsigned int subjob_number;
 117         unsigned int groupid;
 118         struct thread_stat ts;
 119
 120         int client_type;
 121
 122         struct io_log *slat_log;
 123         struct io_log *clat_log;
 124         struct io_log *lat_log;
 125         struct io_log *bw_log;
 126         struct io_log *iops_log;
 127
 128         struct tp_data *tp_data;
 129
 130         struct thread_data *parent;
 131
 132         uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
 133         struct timeval bw_sample_time;
 134
 135         uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
 136         struct timeval iops_sample_time;
 137
 138         /*
 139          * Tracks the last iodepth number of completed writes, if data
 140          * verification is enabled
 141          */
 142         uint64_t *last_write_comp;
 143         unsigned int last_write_idx;
 144
 145         volatile int update_rusage;
 146         struct fio_mutex *rusage_sem;
 147         struct rusage ru_start;
 148         struct rusage ru_end;
 149
 150         struct fio_file **files;
 151         unsigned char *file_locks;
 152         unsigned int files_size;
 153         unsigned int files_index;
 154         unsigned int nr_open_files;
 155         unsigned int nr_done_files;
 156         unsigned int nr_normal_files;
 157         union {
 158                 unsigned int next_file;
 159                 struct frand_state next_file_state;
 160         };
 161         int error;
 162         int sig;
 163         int done;
 164         int stop_io;
 165         pid_t pid;
 166         char *orig_buffer;
 167         size_t orig_buffer_size;
 168         volatile int terminate;
 169         volatile int runstate;
 170         unsigned int last_was_sync;
 171         enum fio_ddir last_ddir;
 172
 173         int mmapfd;
 174
 175         void *iolog_buf;
 176         FILE *iolog_f;
 177
 178         char *sysfs_root;
 179
 180         unsigned long rand_seeds[FIO_RAND_NR_OFFS];
 181
 182         struct frand_state bsrange_state;
 183         struct frand_state verify_state;
 184         struct frand_state trim_state;
 185         struct frand_state delay_state;
 186
 187         struct frand_state buf_state;
 188         struct frand_state buf_state_prev;
 189         struct frand_state dedupe_state;
 190
 191         unsigned int verify_batch;
 192         unsigned int trim_batch;
 193
 194         struct thread_io_list *vstate;
 195
 196         int shm_id;
 197
 198         /*
 199          * IO engine hooks, contains everything needed to submit an io_u
 200          * to any of the available IO engines.
 201          */
 202         struct ioengine_ops *io_ops;
 203
 204         /*
 205          * Queue depth of io_u's that fio MIGHT do
 206          */
 207         unsigned int cur_depth;
 208
 209         /*
 210          * io_u's about to be committed
 211          */
 212         unsigned int io_u_queued;
 213
 214         /*
 215          * io_u's submitted but not completed yet
 216          */
 217         unsigned int io_u_in_flight;
 218
 219         /*
 220          * List of free and busy io_u's
 221          */
 222         struct io_u_ring io_u_requeues;
 223         struct io_u_queue io_u_freelist;
 224         struct io_u_queue io_u_all;
 225         pthread_mutex_t io_u_lock;
 226         pthread_cond_t free_cond;
 227
 228         /*
 229          * async verify offload
 230          */
 231         struct flist_head verify_list;
 232         pthread_t *verify_threads;
 233         unsigned int nr_verify_threads;
 234         pthread_cond_t verify_cond;
 235         int verify_thread_exit;
 236
 237         /*
 238          * Rate state
 239          */
 240         uint64_t rate_bps[DDIR_RWDIR_CNT];
 241         long rate_pending_usleep[DDIR_RWDIR_CNT];
 242         unsigned long rate_bytes[DDIR_RWDIR_CNT];
 243         unsigned long rate_blocks[DDIR_RWDIR_CNT];
 244         struct timeval lastrate[DDIR_RWDIR_CNT];
 245
 246         /*
 247          * Enforced rate submission/completion workqueue
 248          */
 249         struct workqueue io_wq;
 250
 251         uint64_t total_io_size;
 252         uint64_t fill_device_size;
 253
 254         /*
 255          * Issue side
 256          */
 257         uint64_t io_issues[DDIR_RWDIR_CNT];
 258         uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
 259         uint64_t loops;
 260
 261         /*
 262          * Completions
 263          */
 264         uint64_t io_blocks[DDIR_RWDIR_CNT];
 265         uint64_t this_io_blocks[DDIR_RWDIR_CNT];
 266         uint64_t io_bytes[DDIR_RWDIR_CNT];
 267         uint64_t this_io_bytes[DDIR_RWDIR_CNT];
 268         uint64_t io_skip_bytes;
 269         uint64_t zone_bytes;
 270         struct fio_mutex *mutex;
 271         uint64_t bytes_done[DDIR_RWDIR_CNT];
 272
 273         /*
 274          * State for random io, a bitmap of blocks done vs not done
 275          */
 276         struct frand_state random_state;
 277
 278         struct timeval start;   /* start of this loop */
 279         struct timeval epoch;   /* time job was started */
 280         struct timeval last_issue;
 281         long time_offset;
 282         struct timeval tv_cache;
 283         struct timeval terminate_time;
 284         unsigned int tv_cache_nr;
 285         unsigned int tv_cache_mask;
 286         unsigned int ramp_time_over;
 287
 288         /*
 289          * Time since last latency_window was started
 290          */
 291         struct timeval latency_ts;
 292         unsigned int latency_qd;
 293         unsigned int latency_qd_high;
 294         unsigned int latency_qd_low;
 295         unsigned int latency_failed;
 296         uint64_t latency_ios;
 297         int latency_end_run;
 298
 299         /*
 300          * read/write mixed workload state
 301          */
 302         struct frand_state rwmix_state;
 303         unsigned long rwmix_issues;
 304         enum fio_ddir rwmix_ddir;
 305         unsigned int ddir_seq_nr;
 306
 307         /*
 308          * rand/seq mixed workload state
 309          */
 310         struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
 311
 312         /*
 313          * IO history logs for verification. We use a tree for sorting,
 314          * if we are overwriting. Otherwise just use a fifo.
 315          */
 316         struct rb_root io_hist_tree;
 317         struct flist_head io_hist_list;
 318         unsigned long io_hist_len;
 319
 320         /*
 321          * For IO replaying
 322          */
 323         struct flist_head io_log_list;
 324
 325         /*
 326          * For tracking/handling discards
 327          */
 328         struct flist_head trim_list;
 329         unsigned long trim_entries;
 330
 331         struct flist_head next_rand_list;
 332
 333         /*
 334          * for fileservice, how often to switch to a new file
 335          */
 336         unsigned int file_service_nr;
 337         unsigned int file_service_left;
 338         struct fio_file *file_service_file;
 339
 340         unsigned int sync_file_range_nr;
 341
 342         /*
 343          * For generating file sizes
 344          */
 345         struct frand_state file_size_state;
 346
 347         /*
 348          * Error counts
 349          */
 350         unsigned int total_err_count;
 351         int first_error;
 352
 353         struct fio_flow *flow;
 354
 355         /*
 356          * Can be overloaded by profiles
 357          */
 358         struct prof_io_ops prof_io_ops;
 359         void *prof_data;
 360
 361         void *pinned_mem;
 362 };
 363
 364 /*
 365  * when should interactive ETA output be generated
 366  */
 367 enum {
 368         FIO_ETA_AUTO,
 369         FIO_ETA_ALWAYS,
 370         FIO_ETA_NEVER,
 371 };
 372
 373 #define __td_verror(td, err, msg, func)                                 \
 374         do {                                                            \
 375                 unsigned int ____e = (err);                             \
 376                 if ((td)->error)                                        \
 377                         break;                                          \
 378                 (td)->error = ____e;                                    \
 379                 if (!(td)->first_error)                                 \
 380                         snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));           \
 381         } while (0)
 382
 383
 384 #define td_clear_error(td)              do {            \
 385         (td)->error = 0;                                \
 386         if ((td)->parent)                               \
 387                 (td)->parent->error = 0;                \
 388 } while (0)
 389
 390 #define td_verror(td, err, func)        do {                    \
 391         __td_verror((td), (err), strerror((err)), (func));      \
 392         if ((td)->parent)                                       \
 393                 __td_verror((td)->parent, (err), strerror((err)), (func)); \
 394 } while (0)
 395
 396 #define td_vmsg(td, err, msg, func)     do {                    \
 397         __td_verror((td), (err), (msg), (func));                \
 398         if ((td)->parent)                                       \
 399                 __td_verror((td)->parent, (err), (msg), (func));        \
 400 } while (0)
 401
 402 #define __fio_stringify_1(x)    #x
 403 #define __fio_stringify(x)      __fio_stringify_1(x)
 404
 405 extern int exitall_on_terminate;
 406 extern unsigned int thread_number;
 407 extern unsigned int stat_number;
 408 extern int shm_id;
 409 extern int groupid;
 410 extern int output_format;
 411 extern int append_terse_output;
 412 extern int temp_stall_ts;
 413 extern uintptr_t page_mask, page_size;
 414 extern int read_only;
 415 extern int eta_print;
 416 extern int eta_new_line;
 417 extern unsigned long done_secs;
 418 extern char *job_section;
 419 extern int fio_gtod_offload;
 420 extern int fio_gtod_cpu;
 421 extern enum fio_cs fio_clock_source;
 422 extern int fio_clock_source_set;
 423 extern int warnings_fatal;
 424 extern int terse_version;
 425 extern int is_backend;
 426 extern int nr_clients;
 427 extern int log_syslog;
 428 extern int status_interval;
 429 extern const char fio_version_string[];
 430 extern int helper_do_stat;
 431 extern pthread_cond_t helper_cond;
 432 extern char *trigger_file;
 433 extern char *trigger_cmd;
 434 extern char *trigger_remote_cmd;
 435 extern long long trigger_timeout;
 436
 437 extern struct thread_data *threads;
 438
 439 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
 440 {
 441         assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
 442 }
 443
 444 #define REAL_MAX_JOBS           2048
 445
 446 static inline int should_fsync(struct thread_data *td)
 447 {
 448         if (td->last_was_sync)
 449                 return 0;
 450         if (td_write(td) || td_rw(td) || td->o.override_sync)
 451                 return 1;
 452
 453         return 0;
 454 }
 455
 456 /*
 457  * Init/option functions
 458  */
 459 extern int __must_check fio_init_options(void);
 460 extern int __must_check parse_options(int, char **);
 461 extern int parse_jobs_ini(char *, int, int, int);
 462 extern int parse_cmd_line(int, char **, int);
 463 extern int fio_backend(void);
 464 extern void reset_fio_state(void);
 465 extern void clear_io_state(struct thread_data *);
 466 extern int fio_options_parse(struct thread_data *, char **, int, int);
 467 extern void fio_keywords_init(void);
 468 extern void fio_keywords_exit(void);
 469 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
 470 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
 471 extern void fio_fill_default_options(struct thread_data *);
 472 extern int fio_show_option_help(const char *);
 473 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
 474 extern void fio_options_dup_and_init(struct option *);
 475 extern void fio_options_mem_dupe(struct thread_data *);
 476 extern void options_mem_dupe(void *data, struct fio_option *options);
 477 extern void td_fill_rand_seeds(struct thread_data *);
 478 extern void add_job_opts(const char **, int);
 479 extern char *num2str(uint64_t, int, int, int, int);
 480 extern int ioengine_load(struct thread_data *);
 481 extern int parse_dryrun(void);
 482 extern int fio_running_or_pending_io_threads(void);
 483 extern int fio_set_fd_nonblocking(int, const char *);
 484
 485 extern uintptr_t page_mask;
 486 extern uintptr_t page_size;
 487 extern int initialize_fio(char *envp[]);
 488 extern void deinitialize_fio(void);
 489
 490 #define FIO_GETOPT_JOB          0x89000000
 491 #define FIO_GETOPT_IOENGINE     0x98000000
 492 #define FIO_NR_OPTIONS          (FIO_MAX_OPTS + 128)
 493
 494 /*
 495  * ETA/status stuff
 496  */
 497 extern void print_thread_status(void);
 498 extern void print_status_init(int);
 499 extern char *fio_uint_to_kmg(unsigned int val);
 500
 501 /*
 502  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 503  * will never back again. It may cycle between running/verififying/fsyncing.
 504  * Once the thread reaches TD_EXITED, it is just waiting for the core to
 505  * reap it.
 506  */
 507 enum {
 508         TD_NOT_CREATED = 0,
 509         TD_CREATED,
 510         TD_INITIALIZED,
 511         TD_RAMP,
 512         TD_SETTING_UP,
 513         TD_RUNNING,
 514         TD_PRE_READING,
 515         TD_VERIFYING,
 516         TD_FSYNCING,
 517         TD_FINISHING,
 518         TD_EXITED,
 519         TD_REAPED,
 520 };
 521
 522 extern void td_set_runstate(struct thread_data *, int);
 523 extern int td_bump_runstate(struct thread_data *, int);
 524 extern void td_restore_runstate(struct thread_data *, int);
 525
 526 /*
 527  * Allow 60 seconds for a job to quit on its own, otherwise reap with
 528  * a vengeance.
 529  */
 530 #define FIO_REAP_TIMEOUT        60
 531
 532 #define TERMINATE_ALL           (-1)
 533 extern void fio_terminate_threads(int);
 534 extern void fio_mark_td_terminate(struct thread_data *);
 535
 536 /*
 537  * Memory helpers
 538  */
 539 extern int __must_check fio_pin_memory(struct thread_data *);
 540 extern void fio_unpin_memory(struct thread_data *);
 541 extern int __must_check allocate_io_mem(struct thread_data *);
 542 extern void free_io_mem(struct thread_data *);
 543 extern void free_threads_shm(void);
 544
 545 /*
 546  * Reset stats after ramp time completes
 547  */
 548 extern void reset_all_stats(struct thread_data *);
 549
 550 /*
 551  * blktrace support
 552  */
 553 #ifdef FIO_HAVE_BLKTRACE
 554 extern int is_blktrace(const char *, int *);
 555 extern int load_blktrace(struct thread_data *, const char *, int);
 556 #endif
 557
 558 /*
 559  * Latency target helpers
 560  */
 561 extern void lat_target_check(struct thread_data *);
 562 extern void lat_target_init(struct thread_data *);
 563 extern void lat_target_reset(struct thread_data *);
 564
 565 #define for_each_td(td, i)      \
 566         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
 567 #define for_each_file(td, f, i) \
 568         if ((td)->files_index)                                          \
 569                 for ((i) = 0, (f) = (td)->files[0];                     \
 570                  (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
 571                  (i)++)
 572
 573 #define fio_assert(td, cond)    do {    \
 574         if (!(cond)) {                  \
 575                 int *__foo = NULL;      \
 576                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
 577                 td_set_runstate((td), TD_EXITED);       \
 578                 (td)->error = EFAULT;           \
 579                 *__foo = 0;                     \
 580         }       \
 581 } while (0)
 582
 583 static inline int fio_fill_issue_time(struct thread_data *td)
 584 {
 585         if (td->o.read_iolog_file ||
 586             !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
 587                 return 1;
 588
 589         return 0;
 590 }
 591
 592 static inline int __should_check_rate(struct thread_data *td,
 593                                       enum fio_ddir ddir)
 594 {
 595         struct thread_options *o = &td->o;
 596
 597         /*
 598          * If some rate setting was given, we need to check it
 599          */
 600         if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
 601             o->rate_iops_min[ddir])
 602                 return 1;
 603
 604         return 0;
 605 }
 606
 607 static inline int should_check_rate(struct thread_data *td)
 608 {
 609         int ret = 0;
 610
 611         if (td->bytes_done[DDIR_READ])
 612                 ret |= __should_check_rate(td, DDIR_READ);
 613         if (td->bytes_done[DDIR_WRITE])
 614                 ret |= __should_check_rate(td, DDIR_WRITE);
 615         if (td->bytes_done[DDIR_TRIM])
 616                 ret |= __should_check_rate(td, DDIR_TRIM);
 617
 618         return ret;
 619 }
 620
 621 static inline unsigned int td_max_bs(struct thread_data *td)
 622 {
 623         unsigned int max_bs;
 624
 625         max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
 626         return max(td->o.max_bs[DDIR_TRIM], max_bs);
 627 }
 628
 629 static inline unsigned int td_min_bs(struct thread_data *td)
 630 {
 631         unsigned int min_bs;
 632
 633         min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
 634         return min(td->o.min_bs[DDIR_TRIM], min_bs);
 635 }
 636
 637 static inline int td_async_processing(struct thread_data *td)
 638 {
 639         return (td->flags & TD_F_NEED_LOCK) != 0;
 640 }
 641
 642 /*
 643  * We currently only need to do locking if we have verifier threads
 644  * accessing our internal structures too
 645  */
 646 static inline void td_io_u_lock(struct thread_data *td)
 647 {
 648         if (td_async_processing(td))
 649                 pthread_mutex_lock(&td->io_u_lock);
 650 }
 651
 652 static inline void td_io_u_unlock(struct thread_data *td)
 653 {
 654         if (td_async_processing(td))
 655                 pthread_mutex_unlock(&td->io_u_lock);
 656 }
 657
 658 static inline void td_io_u_free_notify(struct thread_data *td)
 659 {
 660         if (td_async_processing(td))
 661                 pthread_cond_signal(&td->free_cond);
 662 }
 663
 664 extern const char *fio_get_arch_string(int);
 665 extern const char *fio_get_os_string(int);
 666
 667 #ifdef FIO_INTERNAL
 668 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
 669 #endif
 670
 671 enum {
 672         FIO_OUTPUT_TERSE        = 0,
 673         FIO_OUTPUT_JSON,
 674         FIO_OUTPUT_NORMAL,
 675 };
 676
 677 enum {
 678         FIO_RAND_DIST_RANDOM    = 0,
 679         FIO_RAND_DIST_ZIPF,
 680         FIO_RAND_DIST_PARETO,
 681         FIO_RAND_DIST_GAUSS,
 682 };
 683
 684 #define FIO_DEF_ZIPF            1.1
 685 #define FIO_DEF_PARETO          0.2
 686
 687 enum {
 688         FIO_RAND_GEN_TAUSWORTHE = 0,
 689         FIO_RAND_GEN_LFSR,
 690         FIO_RAND_GEN_TAUSWORTHE64,
 691 };
 692
 693 enum {
 694         FIO_CPUS_SHARED         = 0,
 695         FIO_CPUS_SPLIT,
 696 };
 697
 698 extern void exec_trigger(const char *);
 699 extern void check_trigger_file(void);
 700
 701 #endif