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