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