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