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 <getopt.h>
  15 #include <inttypes.h>
  16
  17 #include "compiler/compiler.h"
  18 #include "list.h"
  19 #include "fifo.h"
  20 #include "rbtree.h"
  21 #include "arch/arch.h"
  22 #include "os/os.h"
  23 #include "mutex.h"
  24
  25 #ifdef FIO_HAVE_SYSLET
  26 #include "syslet.h"
  27 #endif
  28
  29 #ifdef FIO_HAVE_GUASI
  30 #include <guasi.h>
  31 #endif
  32
  33 enum fio_ddir {
  34         DDIR_READ = 0,
  35         DDIR_WRITE,
  36         DDIR_SYNC,
  37         DDIR_INVAL = -1,
  38 };
  39
  40 enum td_ddir {
  41         TD_DDIR_READ            = 1 << 0,
  42         TD_DDIR_WRITE           = 1 << 1,
  43         TD_DDIR_RAND            = 1 << 2,
  44         TD_DDIR_RW              = TD_DDIR_READ | TD_DDIR_WRITE,
  45         TD_DDIR_RANDREAD        = TD_DDIR_READ | TD_DDIR_RAND,
  46         TD_DDIR_RANDWRITE       = TD_DDIR_WRITE | TD_DDIR_RAND,
  47         TD_DDIR_RANDRW          = TD_DDIR_RW | TD_DDIR_RAND,
  48 };
  49
  50 /*
  51  * Use for maintaining statistics
  52  */
  53 struct io_stat {
  54         unsigned long max_val;
  55         unsigned long min_val;
  56         unsigned long samples;
  57
  58         double mean;
  59         double S;
  60 };
  61
  62 /*
  63  * A single data sample
  64  */
  65 struct io_sample {
  66         unsigned long time;
  67         unsigned long val;
  68         enum fio_ddir ddir;
  69 };
  70
  71 /*
  72  * Dynamically growing data sample log
  73  */
  74 struct io_log {
  75         unsigned long nr_samples;
  76         unsigned long max_samples;
  77         struct io_sample *log;
  78 };
  79
  80 /*
  81  * When logging io actions, this matches a single sent io_u
  82  */
  83 struct io_piece {
  84         union {
  85                 struct rb_node rb_node;
  86                 struct list_head list;
  87         };
  88         union {
  89                 int fileno;
  90                 struct fio_file *file;
  91         };
  92         unsigned long long offset;
  93         unsigned long len;
  94         enum fio_ddir ddir;
  95         union {
  96                 unsigned long delay;
  97                 unsigned int file_action;
  98         };
  99 };
 100
 101 #ifdef FIO_HAVE_SYSLET
 102 struct syslet_req {
 103         struct syslet_uatom atom;       /* the atom to submit */
 104         struct syslet_uatom *head;      /* head of the sequence */
 105         long ret;                       /* syscall return value */
 106 };
 107 #endif
 108
 109 enum {
 110         IO_U_F_FREE     = 1 << 0,
 111         IO_U_F_FLIGHT   = 1 << 1,
 112 };
 113
 114 struct thread_data;
 115
 116 /*
 117  * The io unit
 118  */
 119 struct io_u {
 120         union {
 121 #ifdef FIO_HAVE_LIBAIO
 122                 struct iocb iocb;
 123 #endif
 124 #ifdef FIO_HAVE_POSIXAIO
 125                 struct aiocb aiocb;
 126 #endif
 127 #ifdef FIO_HAVE_SGIO
 128                 struct sg_io_hdr hdr;
 129 #endif
 130 #ifdef FIO_HAVE_SYSLET
 131                 struct syslet_req req;
 132 #endif
 133 #ifdef FIO_HAVE_GUASI
 134                 guasi_req_t greq;
 135 #endif
 136         };
 137         struct timeval start_time;
 138         struct timeval issue_time;
 139
 140         /*
 141          * Allocated/set buffer and length
 142          */
 143         void *buf;
 144         unsigned long buflen;
 145         unsigned long long offset;
 146         unsigned long long endpos;
 147
 148         /*
 149          * IO engine state, may be different from above when we get
 150          * partial transfers / residual data counts
 151          */
 152         void *xfer_buf;
 153         unsigned long xfer_buflen;
 154
 155         unsigned int resid;
 156         unsigned int error;
 157
 158         enum fio_ddir ddir;
 159
 160         /*
 161          * io engine private data
 162          */
 163         union {
 164                 unsigned int index;
 165                 unsigned int seen;
 166         };
 167
 168         unsigned int flags;
 169
 170         struct fio_file *file;
 171
 172         struct list_head list;
 173
 174         /*
 175          * Callback for io completion
 176          */
 177         int (*end_io)(struct thread_data *, struct io_u *);
 178 };
 179
 180 /*
 181  * io_ops->queue() return values
 182  */
 183 enum {
 184         FIO_Q_COMPLETED = 0,            /* completed sync */
 185         FIO_Q_QUEUED    = 1,            /* queued, will complete async */
 186         FIO_Q_BUSY      = 2,            /* no more room, call ->commit() */
 187 };
 188
 189 #define FIO_HDR_MAGIC   0xf00baaef
 190
 191 enum {
 192         VERIFY_NONE = 0,                /* no verification */
 193         VERIFY_MD5,                     /* md5 sum data blocks */
 194         VERIFY_CRC64,                   /* crc64 sum data blocks */
 195         VERIFY_CRC32,                   /* crc32 sum data blocks */
 196         VERIFY_CRC16,                   /* crc16 sum data blocks */
 197         VERIFY_CRC7,                    /* crc7 sum data blocks */
 198         VERIFY_SHA256,                  /* sha256 sum data blocks */
 199         VERIFY_SHA512,                  /* sha512 sum data blocks */
 200         VERIFY_NULL,                    /* pretend to verify */
 201 };
 202
 203 /*
 204  * A header structure associated with each checksummed data block. It is
 205  * followed by a checksum specific header that contains the verification
 206  * data.
 207  */
 208 struct verify_header {
 209         unsigned int fio_magic;
 210         unsigned int len;
 211         unsigned int verify_type;
 212 };
 213
 214 struct vhdr_md5 {
 215         uint32_t md5_digest[16];
 216 };
 217 struct vhdr_sha512 {
 218         uint8_t sha512[128];
 219 };
 220 struct vhdr_sha256 {
 221         uint8_t sha256[128];
 222 };
 223 struct vhdr_crc64 {
 224         uint64_t crc64;
 225 };
 226 struct vhdr_crc32 {
 227         uint32_t crc32;
 228 };
 229 struct vhdr_crc16 {
 230         uint16_t crc16;
 231 };
 232 struct vhdr_crc7 {
 233         uint8_t crc7;
 234 };
 235
 236 struct group_run_stats {
 237         unsigned long long max_run[2], min_run[2];
 238         unsigned long long max_bw[2], min_bw[2];
 239         unsigned long long io_kb[2];
 240         unsigned long long agg[2];
 241 };
 242
 243 /*
 244  * What type of allocation to use for io buffers
 245  */
 246 enum fio_memtype {
 247         MEM_MALLOC = 0, /* ordinary malloc */
 248         MEM_SHM,        /* use shared memory segments */
 249         MEM_SHMHUGE,    /* use shared memory segments with huge pages */
 250         MEM_MMAP,       /* use anonynomous mmap */
 251         MEM_MMAPHUGE,   /* memory mapped huge file */
 252 };
 253
 254 /*
 255  * The type of object we are working on
 256  */
 257 enum fio_filetype {
 258         FIO_TYPE_FILE = 1,              /* plain file */
 259         FIO_TYPE_BD,                    /* block device */
 260         FIO_TYPE_CHAR,                  /* character device */
 261         FIO_TYPE_PIPE,                  /* pipe */
 262 };
 263
 264 enum fio_ioengine_flags {
 265         FIO_SYNCIO      = 1 << 0,       /* io engine has synchronous ->queue */
 266         FIO_RAWIO       = 1 << 1,       /* some sort of direct/raw io */
 267         FIO_DISKLESSIO  = 1 << 2,       /* no disk involved */
 268         FIO_NOEXTEND    = 1 << 3,       /* engine can't extend file */
 269         FIO_NODISKUTIL  = 1 << 4,       /* diskutil can't handle filename */
 270         FIO_UNIDIR      = 1 << 5,       /* engine is uni-directional */
 271 };
 272
 273 enum fio_file_flags {
 274         FIO_FILE_OPEN           = 1 << 0,       /* file is open */
 275         FIO_FILE_CLOSING        = 1 << 1,       /* file being closed */
 276         FIO_FILE_EXISTS         = 1 << 2,       /* file there */
 277         FIO_FILE_EXTEND         = 1 << 3,       /* needs extend */
 278         FIO_FILE_NOSORT         = 1 << 4,       /* don't sort verify blocks */
 279         FIO_FILE_DONE           = 1 << 5,       /* io completed to this file */
 280         FIO_SIZE_KNOWN          = 1 << 6,       /* size has been set */
 281 };
 282
 283 /*
 284  * Each thread_data structure has a number of files associated with it,
 285  * this structure holds state information for a single file.
 286  */
 287 struct fio_file {
 288         enum fio_filetype filetype;
 289
 290         /*
 291          * A file may not be a file descriptor, let the io engine decide
 292          */
 293         union {
 294                 unsigned long file_data;
 295                 int fd;
 296         };
 297
 298         /*
 299          * filename and possible memory mapping
 300          */
 301         char *file_name;
 302         void *mmap;
 303         unsigned int major, minor;
 304
 305         /*
 306          * size of the file, offset into file, and io size from that offset
 307          */
 308         unsigned long long real_file_size;
 309         unsigned long long file_offset;
 310         unsigned long long io_size;
 311
 312         unsigned long long last_pos;
 313         unsigned long long last_completed_pos;
 314
 315         /*
 316          * block map for random io
 317          */
 318         unsigned long *file_map;
 319         unsigned int num_maps;
 320         unsigned int last_free_lookup;
 321
 322         int references;
 323         enum fio_file_flags flags;
 324 };
 325
 326 /*
 327  * How many depth levels to log
 328  */
 329 #define FIO_IO_U_MAP_NR 8
 330 #define FIO_IO_U_LAT_U_NR 10
 331 #define FIO_IO_U_LAT_M_NR 12
 332
 333 struct thread_stat {
 334         char *name;
 335         char *verror;
 336         int error;
 337         int groupid;
 338         pid_t pid;
 339         char *description;
 340         int members;
 341
 342         struct io_log *slat_log;
 343         struct io_log *clat_log;
 344         struct io_log *bw_log;
 345
 346         /*
 347          * bandwidth and latency stats
 348          */
 349         struct io_stat clat_stat[2];            /* completion latency */
 350         struct io_stat slat_stat[2];            /* submission latency */
 351         struct io_stat bw_stat[2];              /* bandwidth stats */
 352
 353         unsigned long long stat_io_bytes[2];
 354         struct timeval stat_sample_time[2];
 355
 356         /*
 357          * fio system usage accounting
 358          */
 359         struct rusage ru_start;
 360         struct rusage ru_end;
 361         unsigned long usr_time;
 362         unsigned long sys_time;
 363         unsigned long ctx;
 364
 365         /*
 366          * IO depth and latency stats
 367          */
 368         unsigned int io_u_map[FIO_IO_U_MAP_NR];
 369         unsigned int io_u_lat_u[FIO_IO_U_LAT_U_NR];
 370         unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
 371         unsigned long total_io_u[2];
 372         unsigned long short_io_u[2];
 373
 374         unsigned long long io_bytes[2];
 375         unsigned long runtime[2];
 376         unsigned long total_run_time;
 377 };
 378
 379 struct thread_options {
 380         int pad;
 381         char *description;
 382         char *name;
 383         char *directory;
 384         char *filename;
 385         char *opendir;
 386         char *ioengine;
 387         enum td_ddir td_ddir;
 388         unsigned int ddir_nr;
 389         unsigned int iodepth;
 390         unsigned int iodepth_low;
 391         unsigned int iodepth_batch;
 392
 393         unsigned long long size;
 394         unsigned long long file_size_low;
 395         unsigned long long file_size_high;
 396         unsigned long long start_offset;
 397
 398         unsigned int bs[2];
 399         unsigned int min_bs[2];
 400         unsigned int max_bs[2];
 401
 402         unsigned int nr_files;
 403         unsigned int open_files;
 404
 405         unsigned int odirect;
 406         unsigned int invalidate_cache;
 407         unsigned int create_serialize;
 408         unsigned int create_fsync;
 409         unsigned int end_fsync;
 410         unsigned int sync_io;
 411         unsigned int verify;
 412         unsigned int verifysort;
 413         unsigned int verify_interval;
 414         unsigned int verify_offset;
 415         unsigned int verify_pattern;
 416         unsigned int verify_pattern_bytes;
 417         unsigned int use_thread;
 418         unsigned int unlink;
 419         unsigned int do_disk_util;
 420         unsigned int override_sync;
 421         unsigned int rand_repeatable;
 422         unsigned int write_lat_log;
 423         unsigned int write_bw_log;
 424         unsigned int norandommap;
 425         unsigned int bs_unaligned;
 426         unsigned int fsync_on_close;
 427
 428         unsigned int hugepage_size;
 429         unsigned int rw_min_bs;
 430         unsigned int thinktime;
 431         unsigned int thinktime_spin;
 432         unsigned int thinktime_blocks;
 433         unsigned int fsync_blocks;
 434         unsigned int start_delay;
 435         unsigned long long timeout;
 436         unsigned int overwrite;
 437         unsigned int bw_avg_time;
 438         unsigned int loops;
 439         unsigned long long zone_size;
 440         unsigned long long zone_skip;
 441         enum fio_memtype mem_type;
 442
 443         unsigned int stonewall;
 444         unsigned int new_group;
 445         unsigned int numjobs;
 446         os_cpu_mask_t cpumask;
 447         unsigned int cpumask_set;
 448         unsigned int iolog;
 449         unsigned int rwmixcycle;
 450         unsigned int rwmix[2];
 451         unsigned int nice;
 452         unsigned int file_service_type;
 453         unsigned int group_reporting;
 454         unsigned int fadvise_hint;
 455         unsigned int zero_buffers;
 456         unsigned int time_based;
 457
 458         char *read_iolog_file;
 459         char *write_iolog_file;
 460
 461         /*
 462          * Pre-run and post-run shell
 463          */
 464         char *exec_prerun;
 465         char *exec_postrun;
 466
 467         unsigned int rate;
 468         unsigned int ratemin;
 469         unsigned int ratecycle;
 470         unsigned int rate_iops;
 471         unsigned int rate_iops_min;
 472
 473         char *ioscheduler;
 474
 475         /*
 476          * CPU "io" cycle burner
 477          */
 478         unsigned int cpuload;
 479         unsigned int cpucycle;
 480 };
 481
 482 #define FIO_VERROR_SIZE 128
 483
 484 /*
 485  * This describes a single thread/process executing a fio job.
 486  */
 487 struct thread_data {
 488         struct thread_options o;
 489         char verror[FIO_VERROR_SIZE];
 490         pthread_t thread;
 491         int thread_number;
 492         int groupid;
 493         struct thread_stat ts;
 494         struct fio_file *files;
 495         unsigned int files_index;
 496         unsigned int nr_open_files;
 497         unsigned int nr_done_files;
 498         unsigned int nr_normal_files;
 499         union {
 500                 unsigned int next_file;
 501                 os_random_state_t next_file_state;
 502         };
 503         int error;
 504         int done;
 505         pid_t pid;
 506         char *orig_buffer;
 507         size_t orig_buffer_size;
 508         volatile int terminate;
 509         volatile int runstate;
 510         unsigned int ioprio;
 511         unsigned int last_was_sync;
 512
 513         char *mmapfile;
 514         int mmapfd;
 515
 516         void *iolog_buf;
 517         FILE *iolog_f;
 518
 519         char *sysfs_root;
 520
 521         os_random_state_t bsrange_state;
 522         os_random_state_t verify_state;
 523
 524         int shm_id;
 525
 526         /*
 527          * IO engine hooks, contains everything needed to submit an io_u
 528          * to any of the available IO engines.
 529          */
 530         struct ioengine_ops *io_ops;
 531
 532         /*
 533          * Current IO depth and list of free and busy io_u's.
 534          */
 535         unsigned int cur_depth;
 536         struct list_head io_u_freelist;
 537         struct list_head io_u_busylist;
 538         struct list_head io_u_requeues;
 539         unsigned int io_u_queued;
 540
 541         /*
 542          * Rate state
 543          */
 544         unsigned long rate_usec_cycle;
 545         long rate_pending_usleep;
 546         unsigned long rate_bytes;
 547         unsigned long rate_blocks;
 548         struct timeval lastrate;
 549
 550         unsigned long long total_io_size;
 551
 552         unsigned long io_issues[2];
 553         unsigned long long io_blocks[2];
 554         unsigned long long io_bytes[2];
 555         unsigned long long io_skip_bytes;
 556         unsigned long long this_io_bytes[2];
 557         unsigned long long zone_bytes;
 558         struct fio_sem *mutex;
 559
 560         /*
 561          * State for random io, a bitmap of blocks done vs not done
 562          */
 563         os_random_state_t random_state;
 564
 565         struct timeval start;   /* start of this loop */
 566         struct timeval epoch;   /* time job was started */
 567         struct timeval rw_end[2];
 568         struct timeval last_issue;
 569         unsigned int rw_end_set[2];
 570
 571         /*
 572          * read/write mixed workload state
 573          */
 574         os_random_state_t rwmix_state;
 575         unsigned long long rwmix_bytes;
 576         struct timeval rwmix_switch;
 577         enum fio_ddir rwmix_ddir;
 578         unsigned int ddir_nr;
 579
 580         /*
 581          * IO history logs for verification. We use a tree for sorting,
 582          * if we are overwriting. Otherwise just use a fifo.
 583          */
 584         struct rb_root io_hist_tree;
 585         struct list_head io_hist_list;
 586
 587         /*
 588          * For IO replaying
 589          */
 590         struct list_head io_log_list;
 591
 592         /*
 593          * timeout handling
 594          */
 595         struct timeval timeout_end;
 596         struct itimerval timer;
 597
 598         /*
 599          * for fileservice, how often to switch to a new file
 600          */
 601         unsigned int file_service_nr;
 602         unsigned int file_service_left;
 603         struct fio_file *file_service_file;
 604
 605         /*
 606          * For generating file sizes
 607          */
 608         os_random_state_t file_size_state;
 609 };
 610
 611 /*
 612  * roundrobin available files, or choose one at random.
 613  */
 614 enum {
 615         FIO_FSERVICE_RANDOM     = 1,
 616         FIO_FSERVICE_RR         = 2,
 617 };
 618
 619 /*
 620  * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
 621  * the timer on each queue operation.
 622  */
 623 #define IO_U_TIMEOUT_INC        5
 624 #define IO_U_TIMEOUT            30
 625
 626 #define __td_verror(td, err, msg, func)                                 \
 627         do {                                                            \
 628                 if ((td)->error)                                        \
 629                         break;                                          \
 630                 int e = (err);                                          \
 631                 (td)->error = e;                                        \
 632                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));       \
 633         } while (0)
 634
 635
 636 #define td_verror(td, err, func)        \
 637         __td_verror((td), (err), strerror((err)), (func))
 638 #define td_vmsg(td, err, msg, func)     \
 639         __td_verror((td), (err), (msg), (func))
 640
 641 extern int exitall_on_terminate;
 642 extern int thread_number;
 643 extern int nr_process, nr_thread;
 644 extern int shm_id;
 645 extern int groupid;
 646 extern int terse_output;
 647 extern FILE *f_out;
 648 extern FILE *f_err;
 649 extern int temp_stall_ts;
 650 extern unsigned long long mlock_size;
 651 extern unsigned long page_mask, page_size;
 652
 653 extern struct thread_data *threads;
 654
 655 #define td_read(td)             ((td)->o.td_ddir & TD_DDIR_READ)
 656 #define td_write(td)            ((td)->o.td_ddir & TD_DDIR_WRITE)
 657 #define td_rw(td)               (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
 658 #define td_random(td)           ((td)->o.td_ddir & TD_DDIR_RAND)
 659
 660 #define BLOCKS_PER_MAP          (8 * sizeof(long))
 661 #define TO_MAP_BLOCK(td, f, b)  ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
 662 #define RAND_MAP_IDX(td, f, b)  (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
 663 #define RAND_MAP_BIT(td, f, b)  (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
 664
 665 #define MAX_JOBS        (1024)
 666
 667 static inline int should_fsync(struct thread_data *td)
 668 {
 669         if (td->last_was_sync)
 670                 return 0;
 671         if (td->o.odirect)
 672                 return 0;
 673         if (td_write(td) || td_rw(td) || td->o.override_sync)
 674                 return 1;
 675
 676         return 0;
 677 }
 678
 679 /*
 680  * Disk utils as read in /sys/block/<dev>/stat
 681  */
 682 struct disk_util_stat {
 683         unsigned ios[2];
 684         unsigned merges[2];
 685         unsigned long long sectors[2];
 686         unsigned ticks[2];
 687         unsigned io_ticks;
 688         unsigned time_in_queue;
 689 };
 690
 691 /*
 692  * Per-device disk util management
 693  */
 694 struct disk_util {
 695         struct list_head list;
 696
 697         char *name;
 698         char *sysfs_root;
 699         char path[256];
 700         int major, minor;
 701
 702         struct disk_util_stat dus;
 703         struct disk_util_stat last_dus;
 704
 705         unsigned long msec;
 706         struct timeval time;
 707 };
 708
 709 #define DISK_UTIL_MSEC  (250)
 710
 711 /*
 712  * Log exports
 713  */
 714 enum file_log_act {
 715         FIO_LOG_ADD_FILE,
 716         FIO_LOG_OPEN_FILE,
 717         FIO_LOG_CLOSE_FILE,
 718 };
 719
 720 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
 721 extern void log_io_u(struct thread_data *, struct io_u *);
 722 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
 723 extern int __must_check init_iolog(struct thread_data *td);
 724 extern void log_io_piece(struct thread_data *, struct io_u *);
 725 extern void prune_io_piece_log(struct thread_data *);
 726 extern void write_iolog_close(struct thread_data *);
 727
 728 /*
 729  * Logging
 730  */
 731 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
 732 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
 733 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
 734 extern void show_run_stats(void);
 735 extern void init_disk_util(struct thread_data *);
 736 extern void update_rusage_stat(struct thread_data *);
 737 extern void update_io_ticks(void);
 738 extern void disk_util_timer_arm(void);
 739 extern void setup_log(struct io_log **);
 740 extern void finish_log(struct thread_data *, struct io_log *, const char *);
 741 extern void __finish_log(struct io_log *, const char *);
 742 extern struct io_log *agg_io_log[2];
 743 extern int write_bw_log;
 744 extern void add_agg_sample(unsigned long, enum fio_ddir);
 745
 746 /*
 747  * Time functions
 748  */
 749 extern unsigned long utime_since(struct timeval *, struct timeval *);
 750 extern unsigned long utime_since_now(struct timeval *);
 751 extern unsigned long mtime_since(struct timeval *, struct timeval *);
 752 extern unsigned long mtime_since_now(struct timeval *);
 753 extern unsigned long time_since_now(struct timeval *);
 754 extern unsigned long mtime_since_genesis(void);
 755 extern void __usec_sleep(unsigned int);
 756 extern void usec_sleep(struct thread_data *, unsigned long);
 757 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
 758 extern void fill_start_time(struct timeval *);
 759 extern void fio_gettime(struct timeval *, void *);
 760 extern void set_genesis_time(void);
 761
 762 /*
 763  * Init/option functions
 764  */
 765 extern int __must_check parse_options(int, char **);
 766 extern int fio_option_parse(struct thread_data *, const char *);
 767 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
 768 extern void fio_fill_default_options(struct thread_data *);
 769 extern int fio_show_option_help(const char *);
 770 extern void fio_options_dup_and_init(struct option *);
 771 extern void options_mem_dupe(struct thread_data *);
 772 extern void options_mem_free(struct thread_data *);
 773 #define FIO_GETOPT_JOB          0x89988998
 774 #define FIO_NR_OPTIONS          128
 775
 776 /*
 777  * File setup/shutdown
 778  */
 779 extern void close_files(struct thread_data *);
 780 extern int __must_check setup_files(struct thread_data *);
 781 extern int __must_check open_files(struct thread_data *);
 782 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
 783 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
 784 extern void generic_close_file(struct thread_data *, struct fio_file *);
 785 extern int add_file(struct thread_data *, const char *);
 786 extern void get_file(struct fio_file *);
 787 extern void put_file(struct thread_data *, struct fio_file *);
 788 extern int add_dir_files(struct thread_data *, const char *);
 789 extern int init_random_map(struct thread_data *);
 790 extern void dup_files(struct thread_data *, struct thread_data *);
 791 extern int get_fileno(struct thread_data *, const char *);
 792 extern void free_release_files(struct thread_data *);
 793
 794 /*
 795  * ETA/status stuff
 796  */
 797 extern void print_thread_status(void);
 798 extern void print_status_init(int);
 799
 800 /*
 801  * disk util stuff
 802  */
 803 #ifdef FIO_HAVE_DISK_UTIL
 804 extern void show_disk_util(void);
 805 extern void disk_util_timer_arm(void);
 806 extern void init_disk_util(struct thread_data *);
 807 extern void update_io_ticks(void);
 808 #else
 809 #define show_disk_util()
 810 #define disk_util_timer_arm()
 811 #define init_disk_util(td)
 812 #define update_io_ticks()
 813 #endif
 814
 815 /*
 816  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 817  * will never back again. It may cycle between running/verififying/fsyncing.
 818  * Once the thread reaches TD_EXITED, it is just waiting for the core to
 819  * reap it.
 820  */
 821 enum {
 822         TD_NOT_CREATED = 0,
 823         TD_CREATED,
 824         TD_INITIALIZED,
 825         TD_RUNNING,
 826         TD_VERIFYING,
 827         TD_FSYNCING,
 828         TD_EXITED,
 829         TD_REAPED,
 830 };
 831
 832 /*
 833  * Verify helpers
 834  */
 835 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
 836 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
 837 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
 838
 839 /*
 840  * Memory helpers
 841  */
 842 extern int __must_check fio_pin_memory(void);
 843 extern void fio_unpin_memory(void);
 844 extern int __must_check allocate_io_mem(struct thread_data *);
 845 extern void free_io_mem(struct thread_data *);
 846
 847 /*
 848  * io unit handling
 849  */
 850 #define queue_full(td)  list_empty(&(td)->io_u_freelist)
 851 extern struct io_u *__get_io_u(struct thread_data *);
 852 extern struct io_u *get_io_u(struct thread_data *);
 853 extern void put_io_u(struct thread_data *, struct io_u *);
 854 extern void requeue_io_u(struct thread_data *, struct io_u **);
 855 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
 856 extern long __must_check io_u_queued_complete(struct thread_data *, int);
 857 extern void io_u_queued(struct thread_data *, struct io_u *);
 858 extern void io_u_log_error(struct thread_data *, struct io_u *);
 859 extern void io_u_init_timeout(void);
 860 extern void io_u_set_timeout(struct thread_data *);
 861 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
 862
 863 /*
 864  * io engine entry points
 865  */
 866 extern int __must_check td_io_init(struct thread_data *);
 867 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
 868 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
 869 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
 870 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
 871 extern int __must_check td_io_commit(struct thread_data *);
 872 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
 873 extern void td_io_close_file(struct thread_data *, struct fio_file *);
 874
 875 /*
 876  * blktrace support
 877  */
 878 #ifdef FIO_HAVE_BLKTRACE
 879 extern int is_blktrace(const char *);
 880 extern int load_blktrace(struct thread_data *, const char *);
 881 #endif
 882
 883 /*
 884  * If logging output to a file, stderr should go to both stderr and f_err
 885  */
 886 #define log_err(args...)        do {            \
 887         fprintf(f_err, ##args);                 \
 888         if (f_err != stderr)                    \
 889                 fprintf(stderr, ##args);        \
 890         } while (0)
 891
 892 #define log_info(args...)       fprintf(f_out, ##args)
 893
 894 FILE *get_f_out(void);
 895 FILE *get_f_err(void);
 896
 897 struct ioengine_ops {
 898         struct list_head list;
 899         char name[16];
 900         int version;
 901         int flags;
 902         int (*setup)(struct thread_data *);
 903         int (*init)(struct thread_data *);
 904         int (*prep)(struct thread_data *, struct io_u *);
 905         int (*queue)(struct thread_data *, struct io_u *);
 906         int (*commit)(struct thread_data *);
 907         int (*getevents)(struct thread_data *, int, int, struct timespec *);
 908         struct io_u *(*event)(struct thread_data *, int);
 909         int (*cancel)(struct thread_data *, struct io_u *);
 910         void (*cleanup)(struct thread_data *);
 911         int (*open_file)(struct thread_data *, struct fio_file *);
 912         void (*close_file)(struct thread_data *, struct fio_file *);
 913         void *data;
 914         void *dlhandle;
 915 };
 916
 917 #define FIO_IOOPS_VERSION       7
 918
 919 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
 920 extern void register_ioengine(struct ioengine_ops *);
 921 extern void unregister_ioengine(struct ioengine_ops *);
 922 extern void close_ioengine(struct thread_data *);
 923
 924 /*
 925  * Mark unused variables passed to ops functions as unused, to silence gcc
 926  */
 927 #define fio_unused      __attribute((__unused__))
 928 #define fio_init        __attribute__((constructor))
 929 #define fio_exit        __attribute__((destructor))
 930
 931 #define for_each_td(td, i)      \
 932         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
 933 #define for_each_file(td, f, i) \
 934         for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
 935
 936 #define fio_assert(td, cond)    do {    \
 937         if (!(cond)) {                  \
 938                 int *__foo = NULL;      \
 939                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
 940                 (td)->runstate = TD_EXITED;     \
 941                 (td)->error = EFAULT;           \
 942                 *__foo = 0;                     \
 943         }       \
 944 } while (0)
 945
 946 static inline void clear_error(struct thread_data *td)
 947 {
 948         td->error = 0;
 949         td->verror[0] = '\0';
 950 }
 951
 952 #endif