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