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