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