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 struct thread_data;
  18
  19 #include "compiler/compiler.h"
  20 #include "flist.h"
  21 #include "fifo.h"
  22 #include "rbtree.h"
  23 #include "arch/arch.h"
  24 #include "os/os.h"
  25 #include "mutex.h"
  26 #include "log.h"
  27 #include "debug.h"
  28 #include "file.h"
  29 #include "io_ddir.h"
  30 #include "ioengine.h"
  31 #include "iolog.h"
  32 #include "helpers.h"
  33 #include "options.h"
  34 #include "profile.h"
  35 #include "time.h"
  36 #include "lib/getopt.h"
  37
  38 #ifdef FIO_HAVE_GUASI
  39 #include <guasi.h>
  40 #endif
  41
  42 #ifdef FIO_HAVE_SOLARISAIO
  43 #include <sys/asynch.h>
  44 #endif
  45
  46 struct group_run_stats {
  47         unsigned long long max_run[2], min_run[2];
  48         unsigned long long max_bw[2], min_bw[2];
  49         unsigned long long io_kb[2];
  50         unsigned long long agg[2];
  51         unsigned int kb_base;
  52 };
  53
  54 /*
  55  * What type of allocation to use for io buffers
  56  */
  57 enum fio_memtype {
  58         MEM_MALLOC = 0, /* ordinary malloc */
  59         MEM_SHM,        /* use shared memory segments */
  60         MEM_SHMHUGE,    /* use shared memory segments with huge pages */
  61         MEM_MMAP,       /* use anonynomous mmap */
  62         MEM_MMAPHUGE,   /* memory mapped huge file */
  63 };
  64
  65 /*
  66  * offset generator types
  67  */
  68 enum {
  69         RW_SEQ_SEQ      = 0,
  70         RW_SEQ_IDENT,
  71 };
  72
  73 /*
  74  * How many depth levels to log
  75  */
  76 #define FIO_IO_U_MAP_NR 7
  77 #define FIO_IO_U_LAT_U_NR 10
  78 #define FIO_IO_U_LAT_M_NR 12
  79
  80 #define MAX_PATTERN_SIZE 512
  81
  82 struct thread_stat {
  83         char *name;
  84         char *verror;
  85         int error;
  86         int groupid;
  87         pid_t pid;
  88         char *description;
  89         int members;
  90
  91         struct io_log *slat_log;
  92         struct io_log *clat_log;
  93         struct io_log *lat_log;
  94         struct io_log *bw_log;
  95
  96         /*
  97          * bandwidth and latency stats
  98          */
  99         struct io_stat clat_stat[2];            /* completion latency */
 100         struct io_stat slat_stat[2];            /* submission latency */
 101         struct io_stat lat_stat[2];             /* total latency */
 102         struct io_stat bw_stat[2];              /* bandwidth stats */
 103
 104         unsigned long long stat_io_bytes[2];
 105         struct timeval stat_sample_time[2];
 106
 107         /*
 108          * fio system usage accounting
 109          */
 110         struct rusage ru_start;
 111         struct rusage ru_end;
 112         unsigned long usr_time;
 113         unsigned long sys_time;
 114         unsigned long ctx;
 115         unsigned long minf, majf;
 116
 117         /*
 118          * IO depth and latency stats
 119          */
 120         unsigned int io_u_map[FIO_IO_U_MAP_NR];
 121         unsigned int io_u_submit[FIO_IO_U_MAP_NR];
 122         unsigned int io_u_complete[FIO_IO_U_MAP_NR];
 123         unsigned int io_u_lat_u[FIO_IO_U_LAT_U_NR];
 124         unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
 125         unsigned long total_io_u[3];
 126         unsigned long short_io_u[3];
 127         unsigned long total_submit;
 128         unsigned long total_complete;
 129
 130         unsigned long long io_bytes[2];
 131         unsigned long long runtime[2];
 132         unsigned long total_run_time;
 133
 134         /*
 135          * IO Error related stats
 136          */
 137         unsigned continue_on_error;
 138         unsigned long total_err_count;
 139         int first_error;
 140
 141         unsigned int kb_base;
 142 };
 143
 144 struct bssplit {
 145         unsigned int bs;
 146         unsigned char perc;
 147 };
 148
 149 struct thread_options {
 150         int pad;
 151         char *description;
 152         char *name;
 153         char *directory;
 154         char *filename;
 155         char *opendir;
 156         char *ioengine;
 157         enum td_ddir td_ddir;
 158         unsigned int rw_seq;
 159         unsigned int kb_base;
 160         unsigned int ddir_seq_nr;
 161         unsigned int iodepth;
 162         unsigned int iodepth_low;
 163         unsigned int iodepth_batch;
 164         unsigned int iodepth_batch_complete;
 165
 166         unsigned long long size;
 167         unsigned int fill_device;
 168         unsigned long long file_size_low;
 169         unsigned long long file_size_high;
 170         unsigned long long start_offset;
 171
 172         unsigned int bs[2];
 173         unsigned int ba[2];
 174         unsigned int min_bs[2];
 175         unsigned int max_bs[2];
 176         struct bssplit *bssplit[2];
 177         unsigned int bssplit_nr[2];
 178
 179         unsigned int nr_files;
 180         unsigned int open_files;
 181         enum file_lock_mode file_lock_mode;
 182         unsigned int lockfile_batch;
 183
 184         unsigned int odirect;
 185         unsigned int invalidate_cache;
 186         unsigned int create_serialize;
 187         unsigned int create_fsync;
 188         unsigned int create_on_open;
 189         unsigned int end_fsync;
 190         unsigned int pre_read;
 191         unsigned int sync_io;
 192         unsigned int verify;
 193         unsigned int do_verify;
 194         unsigned int verifysort;
 195         unsigned int verify_interval;
 196         unsigned int verify_offset;
 197         char verify_pattern[MAX_PATTERN_SIZE];
 198         unsigned int verify_pattern_bytes;
 199         unsigned int verify_fatal;
 200         unsigned int verify_async;
 201         unsigned long long verify_backlog;
 202         unsigned int verify_batch;
 203         unsigned int use_thread;
 204         unsigned int unlink;
 205         unsigned int do_disk_util;
 206         unsigned int override_sync;
 207         unsigned int rand_repeatable;
 208         unsigned int write_lat_log;
 209         unsigned int write_bw_log;
 210         unsigned int norandommap;
 211         unsigned int softrandommap;
 212         unsigned int bs_unaligned;
 213         unsigned int fsync_on_close;
 214
 215         unsigned int hugepage_size;
 216         unsigned int rw_min_bs;
 217         unsigned int thinktime;
 218         unsigned int thinktime_spin;
 219         unsigned int thinktime_blocks;
 220         unsigned int fsync_blocks;
 221         unsigned int fdatasync_blocks;
 222         unsigned int barrier_blocks;
 223         unsigned long start_delay;
 224         unsigned long long timeout;
 225         unsigned long long ramp_time;
 226         unsigned int overwrite;
 227         unsigned int bw_avg_time;
 228         unsigned int loops;
 229         unsigned long long zone_size;
 230         unsigned long long zone_skip;
 231         enum fio_memtype mem_type;
 232         unsigned int mem_align;
 233
 234         unsigned int stonewall;
 235         unsigned int new_group;
 236         unsigned int numjobs;
 237         os_cpu_mask_t cpumask;
 238         unsigned int cpumask_set;
 239         os_cpu_mask_t verify_cpumask;
 240         unsigned int verify_cpumask_set;
 241         unsigned int iolog;
 242         unsigned int rwmixcycle;
 243         unsigned int rwmix[2];
 244         unsigned int nice;
 245         unsigned int file_service_type;
 246         unsigned int group_reporting;
 247         unsigned int fadvise_hint;
 248         unsigned int fallocate;
 249         unsigned int zero_buffers;
 250         unsigned int refill_buffers;
 251         unsigned int time_based;
 252         unsigned int disable_lat;
 253         unsigned int disable_clat;
 254         unsigned int disable_slat;
 255         unsigned int disable_bw;
 256         unsigned int gtod_reduce;
 257         unsigned int gtod_cpu;
 258         unsigned int gtod_offload;
 259         enum fio_cs clocksource;
 260         unsigned int no_stall;
 261         unsigned int trim_percentage;
 262         unsigned int trim_batch;
 263         unsigned int trim_zero;
 264         unsigned long long trim_backlog;
 265
 266         char *read_iolog_file;
 267         char *write_iolog_file;
 268         char *bw_log_file;
 269         char *lat_log_file;
 270         char *replay_redirect;
 271
 272         /*
 273          * Pre-run and post-run shell
 274          */
 275         char *exec_prerun;
 276         char *exec_postrun;
 277
 278         unsigned int rate[2];
 279         unsigned int ratemin[2];
 280         unsigned int ratecycle;
 281         unsigned int rate_iops[2];
 282         unsigned int rate_iops_min[2];
 283
 284         char *ioscheduler;
 285
 286         /*
 287          * CPU "io" cycle burner
 288          */
 289         unsigned int cpuload;
 290         unsigned int cpucycle;
 291
 292         /*
 293          * I/O Error handling
 294          */
 295         unsigned int continue_on_error;
 296
 297         /*
 298          * Benchmark profile type
 299          */
 300         char *profile;
 301
 302         /*
 303          * blkio cgroup support
 304          */
 305         char *cgroup;
 306         unsigned int cgroup_weight;
 307         unsigned int cgroup_nodelete;
 308
 309         unsigned int uid;
 310         unsigned int gid;
 311
 312         unsigned int sync_file_range;
 313 };
 314
 315 #define FIO_VERROR_SIZE 128
 316
 317 /*
 318  * This describes a single thread/process executing a fio job.
 319  */
 320 struct thread_data {
 321         struct thread_options o;
 322         char verror[FIO_VERROR_SIZE];
 323         pthread_t thread;
 324         int thread_number;
 325         int groupid;
 326         struct thread_stat ts;
 327         struct fio_file **files;
 328         unsigned int files_size;
 329         unsigned int files_index;
 330         unsigned int nr_open_files;
 331         unsigned int nr_done_files;
 332         unsigned int nr_normal_files;
 333         union {
 334                 unsigned int next_file;
 335                 os_random_state_t next_file_state;
 336         };
 337         int error;
 338         int done;
 339         pid_t pid;
 340         char *orig_buffer;
 341         size_t orig_buffer_size;
 342         volatile int terminate;
 343         volatile int runstate;
 344         unsigned int ioprio;
 345         unsigned int ioprio_set;
 346         unsigned int last_was_sync;
 347         enum fio_ddir last_ddir;
 348
 349         char *mmapfile;
 350         int mmapfd;
 351
 352         void *iolog_buf;
 353         FILE *iolog_f;
 354
 355         char *sysfs_root;
 356
 357         unsigned long rand_seeds[7];
 358
 359         os_random_state_t bsrange_state;
 360         os_random_state_t verify_state;
 361         os_random_state_t trim_state;
 362
 363         unsigned int verify_batch;
 364         unsigned int trim_batch;
 365
 366         int shm_id;
 367
 368         /*
 369          * IO engine hooks, contains everything needed to submit an io_u
 370          * to any of the available IO engines.
 371          */
 372         struct ioengine_ops *io_ops;
 373
 374         /*
 375          * Current IO depth and list of free and busy io_u's.
 376          */
 377         unsigned int cur_depth;
 378         unsigned int io_u_queued;
 379         struct flist_head io_u_freelist;
 380         struct flist_head io_u_busylist;
 381         struct flist_head io_u_requeues;
 382         pthread_mutex_t io_u_lock;
 383         pthread_cond_t free_cond;
 384
 385         /*
 386          * async verify offload
 387          */
 388         struct flist_head verify_list;
 389         pthread_t *verify_threads;
 390         unsigned int nr_verify_threads;
 391         pthread_cond_t verify_cond;
 392         int verify_thread_exit;
 393
 394         /*
 395          * Rate state
 396          */
 397         unsigned long rate_nsec_cycle[2];
 398         long rate_pending_usleep[2];
 399         unsigned long rate_bytes[2];
 400         unsigned long rate_blocks[2];
 401         struct timeval lastrate[2];
 402
 403         unsigned long long total_io_size;
 404         unsigned long long fill_device_size;
 405
 406         unsigned long io_issues[2];
 407         unsigned long long io_blocks[2];
 408         unsigned long long io_bytes[2];
 409         unsigned long long io_skip_bytes;
 410         unsigned long long this_io_bytes[2];
 411         unsigned long long zone_bytes;
 412         struct fio_mutex *mutex;
 413
 414         /*
 415          * State for random io, a bitmap of blocks done vs not done
 416          */
 417         os_random_state_t random_state;
 418
 419         struct timeval start;   /* start of this loop */
 420         struct timeval epoch;   /* time job was started */
 421         struct timeval last_issue;
 422         struct timeval tv_cache;
 423         unsigned int tv_cache_nr;
 424         unsigned int tv_cache_mask;
 425         unsigned int ramp_time_over;
 426
 427         /*
 428          * read/write mixed workload state
 429          */
 430         os_random_state_t rwmix_state;
 431         unsigned long rwmix_issues;
 432         enum fio_ddir rwmix_ddir;
 433         unsigned int ddir_seq_nr;
 434
 435         /*
 436          * IO history logs for verification. We use a tree for sorting,
 437          * if we are overwriting. Otherwise just use a fifo.
 438          */
 439         struct rb_root io_hist_tree;
 440         struct flist_head io_hist_list;
 441         unsigned long io_hist_len;
 442
 443         /*
 444          * For IO replaying
 445          */
 446         struct flist_head io_log_list;
 447
 448         /*
 449          * For tracking/handling discards
 450          */
 451         struct flist_head trim_list;
 452         unsigned long trim_entries;
 453
 454         /*
 455          * for fileservice, how often to switch to a new file
 456          */
 457         unsigned int file_service_nr;
 458         unsigned int file_service_left;
 459         struct fio_file *file_service_file;
 460
 461         unsigned int sync_file_range_nr;
 462
 463         /*
 464          * For generating file sizes
 465          */
 466         os_random_state_t file_size_state;
 467
 468         /*
 469          * Error counts
 470          */
 471         unsigned int total_err_count;
 472         int first_error;
 473
 474         /*
 475          * Can be overloaded by profiles
 476          */
 477         struct prof_io_ops prof_io_ops;
 478         void *prof_data;
 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                 if ((td)->error)                                        \
 493                         break;                                          \
 494                 int e = (err);                                          \
 495                 (td)->error = e;                                        \
 496                 if (!(td)->first_error)                                 \
 497                         snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));               \
 498         } while (0)
 499
 500
 501 #define td_clear_error(td)              \
 502         (td)->error = 0;
 503 #define td_verror(td, err, func)        \
 504         __td_verror((td), (err), strerror((err)), (func))
 505 #define td_vmsg(td, err, msg, func)     \
 506         __td_verror((td), (err), (msg), (func))
 507
 508 extern int exitall_on_terminate;
 509 extern int thread_number;
 510 extern int nr_process, nr_thread;
 511 extern int shm_id;
 512 extern int groupid;
 513 extern int terse_output;
 514 extern int temp_stall_ts;
 515 extern unsigned long long mlock_size;
 516 extern unsigned long page_mask, page_size;
 517 extern int read_only;
 518 extern int eta_print;
 519 extern unsigned long done_secs;
 520 extern char *job_section;
 521 extern int fio_gtod_offload;
 522 extern int fio_gtod_cpu;
 523 extern enum fio_cs fio_clock_source;
 524
 525 extern struct thread_data *threads;
 526
 527 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
 528 {
 529         assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
 530 }
 531
 532 #define BLOCKS_PER_MAP          (8 * sizeof(int))
 533 #define TO_MAP_BLOCK(f, b)      (b)
 534 #define RAND_MAP_IDX(f, b)      (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
 535 #define RAND_MAP_BIT(f, b)      (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
 536
 537 #define MAX_JOBS        (1024)
 538
 539 #define td_non_fatal_error(e)   ((e) == EIO || (e) == EILSEQ)
 540
 541 static inline void update_error_count(struct thread_data *td, int err)
 542 {
 543         td->total_err_count++;
 544         if (td->total_err_count == 1)
 545                 td->first_error = err;
 546 }
 547
 548 static inline int should_fsync(struct thread_data *td)
 549 {
 550         if (td->last_was_sync)
 551                 return 0;
 552         if (td->o.odirect)
 553                 return 0;
 554         if (td_write(td) || td_rw(td) || td->o.override_sync)
 555                 return 1;
 556
 557         return 0;
 558 }
 559
 560 /*
 561  * Init/option functions
 562  */
 563 extern int __must_check parse_options(int, char **);
 564 extern int fio_options_parse(struct thread_data *, char **, int);
 565 extern void fio_keywords_init(void);
 566 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
 567 extern void fio_fill_default_options(struct thread_data *);
 568 extern int fio_show_option_help(const char *);
 569 extern void fio_options_dup_and_init(struct option *);
 570 extern void options_mem_dupe(struct thread_data *);
 571 extern void options_mem_free(struct thread_data *);
 572 extern void td_fill_rand_seeds(struct thread_data *);
 573 extern void add_job_opts(const char **);
 574 extern char *num2str(unsigned long, int, int, int);
 575
 576 #define FIO_GETOPT_JOB          0x89988998
 577 #define FIO_NR_OPTIONS          (FIO_MAX_OPTS + 128)
 578
 579 /*
 580  * ETA/status stuff
 581  */
 582 extern void print_thread_status(void);
 583 extern void print_status_init(int);
 584
 585 /*
 586  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 587  * will never back again. It may cycle between running/verififying/fsyncing.
 588  * Once the thread reaches TD_EXITED, it is just waiting for the core to
 589  * reap it.
 590  */
 591 enum {
 592         TD_NOT_CREATED = 0,
 593         TD_CREATED,
 594         TD_INITIALIZED,
 595         TD_RAMP,
 596         TD_RUNNING,
 597         TD_PRE_READING,
 598         TD_VERIFYING,
 599         TD_FSYNCING,
 600         TD_EXITED,
 601         TD_REAPED,
 602 };
 603
 604 extern void td_set_runstate(struct thread_data *, int);
 605
 606 /*
 607  * Memory helpers
 608  */
 609 extern int __must_check fio_pin_memory(void);
 610 extern void fio_unpin_memory(void);
 611 extern int __must_check allocate_io_mem(struct thread_data *);
 612 extern void free_io_mem(struct thread_data *);
 613
 614 /*
 615  * Reset stats after ramp time completes
 616  */
 617 extern void reset_all_stats(struct thread_data *);
 618
 619 /*
 620  * blktrace support
 621  */
 622 #ifdef FIO_HAVE_BLKTRACE
 623 extern int is_blktrace(const char *);
 624 extern int load_blktrace(struct thread_data *, const char *);
 625 #endif
 626
 627 /*
 628  * Mark unused variables passed to ops functions as unused, to silence gcc
 629  */
 630 #define fio_unused      __attribute((__unused__))
 631 #define fio_init        __attribute__((constructor))
 632 #define fio_exit        __attribute__((destructor))
 633
 634 #define for_each_td(td, i)      \
 635         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
 636 #define for_each_file(td, f, i) \
 637         if ((td)->files_index)                                          \
 638                 for ((i) = 0, (f) = (td)->files[0];                     \
 639                  (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
 640                  (i)++)
 641
 642 #define fio_assert(td, cond)    do {    \
 643         if (!(cond)) {                  \
 644                 int *__foo = NULL;      \
 645                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
 646                 (td)->runstate = TD_EXITED;     \
 647                 (td)->error = EFAULT;           \
 648                 *__foo = 0;                     \
 649         }       \
 650 } while (0)
 651
 652 static inline int fio_fill_issue_time(struct thread_data *td)
 653 {
 654         if (td->o.read_iolog_file ||
 655             !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
 656                 return 1;
 657
 658         return 0;
 659 }
 660
 661 static inline int __should_check_rate(struct thread_data *td,
 662                                       enum fio_ddir ddir)
 663 {
 664         struct thread_options *o = &td->o;
 665
 666         /*
 667          * If some rate setting was given, we need to check it
 668          */
 669         if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
 670             o->rate_iops_min[ddir])
 671                 return 1;
 672
 673         return 0;
 674 }
 675
 676 static inline int should_check_rate(struct thread_data *td,
 677                                     unsigned long *bytes_done)
 678 {
 679         int ret = 0;
 680
 681         if (bytes_done[0])
 682                 ret |= __should_check_rate(td, 0);
 683         if (bytes_done[1])
 684                 ret |= __should_check_rate(td, 1);
 685
 686         return ret;
 687 }
 688
 689 static inline int is_power_of_2(unsigned int val)
 690 {
 691         return (val != 0 && ((val & (val - 1)) == 0));
 692 }
 693
 694 /*
 695  * We currently only need to do locking if we have verifier threads
 696  * accessing our internal structures too
 697  */
 698 static inline void td_io_u_lock(struct thread_data *td)
 699 {
 700         if (td->o.verify_async)
 701                 pthread_mutex_lock(&td->io_u_lock);
 702 }
 703
 704 static inline void td_io_u_unlock(struct thread_data *td)
 705 {
 706         if (td->o.verify_async)
 707                 pthread_mutex_unlock(&td->io_u_lock);
 708 }
 709
 710 static inline void td_io_u_free_notify(struct thread_data *td)
 711 {
 712         if (td->o.verify_async)
 713                 pthread_cond_signal(&td->free_cond);
 714 }
 715
 716 #endif