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