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 "thread_options.h"
  21 #include "flist.h"
  22 #include "fifo.h"
  23 #include "lib/rbtree.h"
  24 #include "arch/arch.h"
  25 #include "os/os.h"
  26 #include "mutex.h"
  27 #include "log.h"
  28 #include "debug.h"
  29 #include "file.h"
  30 #include "io_ddir.h"
  31 #include "ioengine.h"
  32 #include "iolog.h"
  33 #include "helpers.h"
  34 #include "options.h"
  35 #include "profile.h"
  36 #include "time.h"
  37 #include "gettime.h"
  38 #include "lib/getopt.h"
  39 #include "lib/rand.h"
  40 #include "client.h"
  41 #include "server.h"
  42 #include "stat.h"
  43 #include "flow.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        = 1,
  69         TD_F_TRIM_BACKLOG       = 2,
  70         TD_F_READ_IOLOG         = 4,
  71         TD_F_REFILL_BUFFERS     = 8,
  72         TD_F_SCRAMBLE_BUFFERS   = 16,
  73         TD_F_VER_NONE           = 32,
  74         TD_F_PROFILE_OPS        = 64,
  75 };
  76
  77 enum {
  78         FIO_RAND_BS_OFF         = 0,
  79         FIO_RAND_VER_OFF,
  80         FIO_RAND_MIX_OFF,
  81         FIO_RAND_FILE_OFF,
  82         FIO_RAND_BLOCK_OFF,
  83         FIO_RAND_FILE_SIZE_OFF,
  84         FIO_RAND_TRIM_OFF,
  85         FIO_RAND_BUF_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 flist_head io_u_freelist;
 198         struct flist_head io_u_busylist;
 199         struct flist_head io_u_requeues;
 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          * IO history logs for verification. We use a tree for sorting,
 262          * if we are overwriting. Otherwise just use a fifo.
 263          */
 264         struct rb_root io_hist_tree;
 265         struct flist_head io_hist_list;
 266         unsigned long io_hist_len;
 267
 268         /*
 269          * For IO replaying
 270          */
 271         struct flist_head io_log_list;
 272
 273         /*
 274          * For tracking/handling discards
 275          */
 276         struct flist_head trim_list;
 277         unsigned long trim_entries;
 278
 279         struct flist_head next_rand_list;
 280
 281         /*
 282          * for fileservice, how often to switch to a new file
 283          */
 284         unsigned int file_service_nr;
 285         unsigned int file_service_left;
 286         struct fio_file *file_service_file;
 287
 288         unsigned int sync_file_range_nr;
 289
 290         /*
 291          * For generating file sizes
 292          */
 293         union {
 294                 os_random_state_t file_size_state;
 295                 struct frand_state __file_size_state;
 296         };
 297
 298         /*
 299          * Error counts
 300          */
 301         unsigned int total_err_count;
 302         int first_error;
 303
 304         struct fio_flow *flow;
 305
 306         /*
 307          * Can be overloaded by profiles
 308          */
 309         struct prof_io_ops prof_io_ops;
 310         void *prof_data;
 311
 312         void *pinned_mem;
 313 };
 314
 315 /*
 316  * when should interactive ETA output be generated
 317  */
 318 enum {
 319         FIO_ETA_AUTO,
 320         FIO_ETA_ALWAYS,
 321         FIO_ETA_NEVER,
 322 };
 323
 324 #define __td_verror(td, err, msg, func)                                 \
 325         do {                                                            \
 326                 if ((td)->error)                                        \
 327                         break;                                          \
 328                 int e = (err);                                          \
 329                 (td)->error = e;                                        \
 330                 if (!(td)->first_error)                                 \
 331                         snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));           \
 332         } while (0)
 333
 334
 335 #define td_clear_error(td)              \
 336         (td)->error = 0;
 337 #define td_verror(td, err, func)        \
 338         __td_verror((td), (err), strerror((err)), (func))
 339 #define td_vmsg(td, err, msg, func)     \
 340         __td_verror((td), (err), (msg), (func))
 341
 342 #define __fio_stringify_1(x)    #x
 343 #define __fio_stringify(x)      __fio_stringify_1(x)
 344
 345 extern int exitall_on_terminate;
 346 extern unsigned int thread_number;
 347 extern unsigned int stat_number;
 348 extern int shm_id;
 349 extern int groupid;
 350 extern int output_format;
 351 extern int temp_stall_ts;
 352 extern uintptr_t page_mask, page_size;
 353 extern int read_only;
 354 extern int eta_print;
 355 extern int eta_new_line;
 356 extern unsigned long done_secs;
 357 extern char *job_section;
 358 extern int fio_gtod_offload;
 359 extern int fio_gtod_cpu;
 360 extern enum fio_cs fio_clock_source;
 361 extern int fio_clock_source_set;
 362 extern int warnings_fatal;
 363 extern int terse_version;
 364 extern int is_backend;
 365 extern int nr_clients;
 366 extern int log_syslog;
 367 extern const char fio_version_string[];
 368
 369 extern struct thread_data *threads;
 370
 371 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
 372 {
 373         assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
 374 }
 375
 376 #define REAL_MAX_JOBS           2048
 377
 378 static inline enum error_type_bit td_error_type(enum fio_ddir ddir, int err)
 379 {
 380         if (err == EILSEQ)
 381                 return ERROR_TYPE_VERIFY_BIT;
 382         if (ddir == DDIR_READ)
 383                 return ERROR_TYPE_READ_BIT;
 384         return ERROR_TYPE_WRITE_BIT;
 385 }
 386
 387 static int __NON_FATAL_ERR[] = {EIO, EILSEQ};
 388 static inline int td_non_fatal_error(struct thread_data *td,
 389                                      enum error_type_bit etype, int err)
 390 {
 391         int i;
 392         if (!td->o.ignore_error[etype]) {
 393                 td->o.ignore_error[etype] = __NON_FATAL_ERR;
 394                 td->o.ignore_error_nr[etype] = sizeof(__NON_FATAL_ERR)
 395                         / sizeof(int);
 396         }
 397
 398         if (!(td->o.continue_on_error & (1 << etype)))
 399                 return 0;
 400         for (i = 0; i < td->o.ignore_error_nr[etype]; i++)
 401                 if (td->o.ignore_error[etype][i] == err)
 402                         return 1;
 403         return 0;
 404 }
 405
 406 static inline void update_error_count(struct thread_data *td, int err)
 407 {
 408         td->total_err_count++;
 409         if (td->total_err_count == 1)
 410                 td->first_error = err;
 411 }
 412
 413 static inline int should_fsync(struct thread_data *td)
 414 {
 415         if (td->last_was_sync)
 416                 return 0;
 417         if (td_write(td) || td_rw(td) || td->o.override_sync)
 418                 return 1;
 419
 420         return 0;
 421 }
 422
 423 /*
 424  * Init/option functions
 425  */
 426 extern int __must_check fio_init_options(void);
 427 extern int __must_check parse_options(int, char **);
 428 extern int parse_jobs_ini(char *, int, int, int);
 429 extern int parse_cmd_line(int, char **, int);
 430 extern int fio_backend(void);
 431 extern void reset_fio_state(void);
 432 extern void clear_io_state(struct thread_data *);
 433 extern int fio_options_parse(struct thread_data *, char **, int);
 434 extern void fio_keywords_init(void);
 435 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
 436 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
 437 extern void fio_fill_default_options(struct thread_data *);
 438 extern int fio_show_option_help(const char *);
 439 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
 440 extern void fio_options_dup_and_init(struct option *);
 441 extern void fio_options_mem_dupe(struct thread_data *);
 442 extern void options_mem_dupe(void *data, struct fio_option *options);
 443 extern void td_fill_rand_seeds(struct thread_data *);
 444 extern void add_job_opts(const char **, int);
 445 extern char *num2str(unsigned long, int, int, int);
 446 extern int ioengine_load(struct thread_data *);
 447
 448 extern unsigned long page_mask;
 449 extern unsigned long page_size;
 450 extern int initialize_fio(char *envp[]);
 451
 452 #define FIO_GETOPT_JOB          0x89000000
 453 #define FIO_GETOPT_IOENGINE     0x98000000
 454 #define FIO_NR_OPTIONS          (FIO_MAX_OPTS + 128)
 455
 456 /*
 457  * ETA/status stuff
 458  */
 459 extern void print_thread_status(void);
 460 extern void print_status_init(int);
 461 extern char *fio_uint_to_kmg(unsigned int val);
 462
 463 /*
 464  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 465  * will never back again. It may cycle between running/verififying/fsyncing.
 466  * Once the thread reaches TD_EXITED, it is just waiting for the core to
 467  * reap it.
 468  */
 469 enum {
 470         TD_NOT_CREATED = 0,
 471         TD_CREATED,
 472         TD_INITIALIZED,
 473         TD_RAMP,
 474         TD_SETTING_UP,
 475         TD_RUNNING,
 476         TD_PRE_READING,
 477         TD_VERIFYING,
 478         TD_FSYNCING,
 479         TD_EXITED,
 480         TD_REAPED,
 481 };
 482
 483 extern void td_set_runstate(struct thread_data *, int);
 484 #define TERMINATE_ALL           (-1)
 485 extern void fio_terminate_threads(int);
 486
 487 /*
 488  * Memory helpers
 489  */
 490 extern int __must_check fio_pin_memory(struct thread_data *);
 491 extern void fio_unpin_memory(struct thread_data *);
 492 extern int __must_check allocate_io_mem(struct thread_data *);
 493 extern void free_io_mem(struct thread_data *);
 494 extern void free_threads_shm(void);
 495
 496 /*
 497  * Reset stats after ramp time completes
 498  */
 499 extern void reset_all_stats(struct thread_data *);
 500
 501 /*
 502  * blktrace support
 503  */
 504 #ifdef FIO_HAVE_BLKTRACE
 505 extern int is_blktrace(const char *);
 506 extern int load_blktrace(struct thread_data *, const char *);
 507 #endif
 508
 509 /*
 510  * Mark unused variables passed to ops functions as unused, to silence gcc
 511  */
 512 #define fio_unused      __attribute((__unused__))
 513 #define fio_init        __attribute__((constructor))
 514 #define fio_exit        __attribute__((destructor))
 515
 516 #define for_each_td(td, i)      \
 517         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
 518 #define for_each_file(td, f, i) \
 519         if ((td)->files_index)                                          \
 520                 for ((i) = 0, (f) = (td)->files[0];                     \
 521                  (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
 522                  (i)++)
 523
 524 #define fio_assert(td, cond)    do {    \
 525         if (!(cond)) {                  \
 526                 int *__foo = NULL;      \
 527                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
 528                 td_set_runstate((td), TD_EXITED);       \
 529                 (td)->error = EFAULT;           \
 530                 *__foo = 0;                     \
 531         }       \
 532 } while (0)
 533
 534 static inline int fio_fill_issue_time(struct thread_data *td)
 535 {
 536         if (td->o.read_iolog_file ||
 537             !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
 538                 return 1;
 539
 540         return 0;
 541 }
 542
 543 static inline int __should_check_rate(struct thread_data *td,
 544                                       enum fio_ddir ddir)
 545 {
 546         struct thread_options *o = &td->o;
 547
 548         /*
 549          * If some rate setting was given, we need to check it
 550          */
 551         if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
 552             o->rate_iops_min[ddir])
 553                 return 1;
 554
 555         return 0;
 556 }
 557
 558 static inline int should_check_rate(struct thread_data *td,
 559                                     uint64_t *bytes_done)
 560 {
 561         int ret = 0;
 562
 563         if (bytes_done[DDIR_READ])
 564                 ret |= __should_check_rate(td, DDIR_READ);
 565         if (bytes_done[DDIR_WRITE])
 566                 ret |= __should_check_rate(td, DDIR_WRITE);
 567         if (bytes_done[DDIR_TRIM])
 568                 ret |= __should_check_rate(td, DDIR_TRIM);
 569
 570         return ret;
 571 }
 572
 573 static inline unsigned int td_max_bs(struct thread_data *td)
 574 {
 575         unsigned int max_bs;
 576
 577         max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
 578         return max(td->o.max_bs[DDIR_TRIM], max_bs);
 579 }
 580
 581 static inline int is_power_of_2(unsigned int val)
 582 {
 583         return (val != 0 && ((val & (val - 1)) == 0));
 584 }
 585
 586 /*
 587  * We currently only need to do locking if we have verifier threads
 588  * accessing our internal structures too
 589  */
 590 static inline void td_io_u_lock(struct thread_data *td)
 591 {
 592         if (td->o.verify_async)
 593                 pthread_mutex_lock(&td->io_u_lock);
 594 }
 595
 596 static inline void td_io_u_unlock(struct thread_data *td)
 597 {
 598         if (td->o.verify_async)
 599                 pthread_mutex_unlock(&td->io_u_lock);
 600 }
 601
 602 static inline void td_io_u_free_notify(struct thread_data *td)
 603 {
 604         if (td->o.verify_async)
 605                 pthread_cond_signal(&td->free_cond);
 606 }
 607
 608 extern const char *fio_get_arch_string(int);
 609 extern const char *fio_get_os_string(int);
 610
 611 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
 612
 613 enum {
 614         FIO_OUTPUT_TERSE        = 0,
 615         FIO_OUTPUT_JSON,
 616         FIO_OUTPUT_NORMAL,
 617 };
 618
 619 enum {
 620         FIO_RAND_DIST_RANDOM    = 0,
 621         FIO_RAND_DIST_ZIPF,
 622         FIO_RAND_DIST_PARETO,
 623 };
 624
 625 enum {
 626         FIO_RAND_GEN_TAUSWORTHE = 0,
 627         FIO_RAND_GEN_LFSR,
 628 };
 629
 630 #endif