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