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