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