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         struct disk_util *du;
 348 };
 349
 350 /*
 351  * How many depth levels to log
 352  */
 353 #define FIO_IO_U_MAP_NR 8
 354 #define FIO_IO_U_LAT_U_NR 10
 355 #define FIO_IO_U_LAT_M_NR 12
 356
 357 struct thread_stat {
 358         char *name;
 359         char *verror;
 360         int error;
 361         int groupid;
 362         pid_t pid;
 363         char *description;
 364         int members;
 365
 366         struct io_log *slat_log;
 367         struct io_log *clat_log;
 368         struct io_log *bw_log;
 369
 370         /*
 371          * bandwidth and latency stats
 372          */
 373         struct io_stat clat_stat[2];            /* completion latency */
 374         struct io_stat slat_stat[2];            /* submission latency */
 375         struct io_stat bw_stat[2];              /* bandwidth stats */
 376
 377         unsigned long long stat_io_bytes[2];
 378         struct timeval stat_sample_time[2];
 379
 380         /*
 381          * fio system usage accounting
 382          */
 383         struct rusage ru_start;
 384         struct rusage ru_end;
 385         unsigned long usr_time;
 386         unsigned long sys_time;
 387         unsigned long ctx;
 388         unsigned long minf, majf;
 389
 390         /*
 391          * IO depth and latency stats
 392          */
 393         unsigned int io_u_map[FIO_IO_U_MAP_NR];
 394         unsigned int io_u_submit[FIO_IO_U_MAP_NR];
 395         unsigned int io_u_complete[FIO_IO_U_MAP_NR];
 396         unsigned int io_u_lat_u[FIO_IO_U_LAT_U_NR];
 397         unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
 398         unsigned long total_io_u[2];
 399         unsigned long short_io_u[2];
 400         unsigned long total_submit;
 401         unsigned long total_complete;
 402
 403         unsigned long long io_bytes[2];
 404         unsigned long runtime[2];
 405         unsigned long total_run_time;
 406 };
 407
 408 struct bssplit {
 409         unsigned int bs;
 410         unsigned char perc;
 411 };
 412
 413 struct thread_options {
 414         int pad;
 415         char *description;
 416         char *name;
 417         char *directory;
 418         char *filename;
 419         char *opendir;
 420         char *ioengine;
 421         enum td_ddir td_ddir;
 422         unsigned int ddir_nr;
 423         unsigned int iodepth;
 424         unsigned int iodepth_low;
 425         unsigned int iodepth_batch;
 426         unsigned int iodepth_batch_complete;
 427
 428         unsigned long long size;
 429         unsigned int fill_device;
 430         unsigned long long file_size_low;
 431         unsigned long long file_size_high;
 432         unsigned long long start_offset;
 433
 434         unsigned int bs[2];
 435         unsigned int ba[2];
 436         unsigned int min_bs[2];
 437         unsigned int max_bs[2];
 438         struct bssplit *bssplit[2];
 439         unsigned int bssplit_nr[2];
 440
 441         unsigned int nr_files;
 442         unsigned int open_files;
 443         enum file_lock_mode file_lock_mode;
 444         unsigned int lockfile_batch;
 445
 446         unsigned int odirect;
 447         unsigned int invalidate_cache;
 448         unsigned int create_serialize;
 449         unsigned int create_fsync;
 450         unsigned int create_on_open;
 451         unsigned int end_fsync;
 452         unsigned int pre_read;
 453         unsigned int sync_io;
 454         unsigned int verify;
 455         unsigned int do_verify;
 456         unsigned int verifysort;
 457         unsigned int verify_interval;
 458         unsigned int verify_offset;
 459         unsigned int verify_pattern;
 460         unsigned int verify_pattern_bytes;
 461         unsigned int verify_fatal;
 462         unsigned int use_thread;
 463         unsigned int unlink;
 464         unsigned int do_disk_util;
 465         unsigned int override_sync;
 466         unsigned int rand_repeatable;
 467         unsigned int write_lat_log;
 468         unsigned int write_bw_log;
 469         unsigned int norandommap;
 470         unsigned int softrandommap;
 471         unsigned int bs_unaligned;
 472         unsigned int fsync_on_close;
 473
 474         unsigned int hugepage_size;
 475         unsigned int rw_min_bs;
 476         unsigned int thinktime;
 477         unsigned int thinktime_spin;
 478         unsigned int thinktime_blocks;
 479         unsigned int fsync_blocks;
 480         unsigned int start_delay;
 481         unsigned long long timeout;
 482         unsigned long long ramp_time;
 483         unsigned int overwrite;
 484         unsigned int bw_avg_time;
 485         unsigned int loops;
 486         unsigned long long zone_size;
 487         unsigned long long zone_skip;
 488         enum fio_memtype mem_type;
 489
 490         unsigned int stonewall;
 491         unsigned int new_group;
 492         unsigned int numjobs;
 493         os_cpu_mask_t cpumask;
 494         unsigned int cpumask_set;
 495         unsigned int iolog;
 496         unsigned int rwmixcycle;
 497         unsigned int rwmix[2];
 498         unsigned int nice;
 499         unsigned int file_service_type;
 500         unsigned int group_reporting;
 501         unsigned int fadvise_hint;
 502         unsigned int zero_buffers;
 503         unsigned int refill_buffers;
 504         unsigned int time_based;
 505         unsigned int disable_clat;
 506         unsigned int disable_slat;
 507         unsigned int disable_bw;
 508         unsigned int gtod_reduce;
 509         unsigned int gtod_cpu;
 510         unsigned int gtod_offload;
 511
 512         char *read_iolog_file;
 513         char *write_iolog_file;
 514         char *bw_log_file;
 515         char *lat_log_file;
 516
 517         /*
 518          * Pre-run and post-run shell
 519          */
 520         char *exec_prerun;
 521         char *exec_postrun;
 522
 523         unsigned int rate;
 524         unsigned int ratemin;
 525         unsigned int ratecycle;
 526         unsigned int rate_iops;
 527         unsigned int rate_iops_min;
 528
 529         char *ioscheduler;
 530
 531         /*
 532          * CPU "io" cycle burner
 533          */
 534         unsigned int cpuload;
 535         unsigned int cpucycle;
 536 };
 537
 538 #define FIO_VERROR_SIZE 128
 539
 540 /*
 541  * This describes a single thread/process executing a fio job.
 542  */
 543 struct thread_data {
 544         struct thread_options o;
 545         char verror[FIO_VERROR_SIZE];
 546         pthread_t thread;
 547         int thread_number;
 548         int groupid;
 549         struct thread_stat ts;
 550         struct fio_file **files;
 551         unsigned int files_size;
 552         unsigned int files_index;
 553         unsigned int nr_open_files;
 554         unsigned int nr_done_files;
 555         unsigned int nr_normal_files;
 556         union {
 557                 unsigned int next_file;
 558                 os_random_state_t next_file_state;
 559         };
 560         int error;
 561         int done;
 562         pid_t pid;
 563         char *orig_buffer;
 564         size_t orig_buffer_size;
 565         volatile int terminate;
 566         volatile int runstate;
 567         unsigned int ioprio;
 568         unsigned int ioprio_set;
 569         unsigned int last_was_sync;
 570
 571         char *mmapfile;
 572         int mmapfd;
 573
 574         void *iolog_buf;
 575         FILE *iolog_f;
 576
 577         char *sysfs_root;
 578
 579         unsigned long rand_seeds[6];
 580
 581         os_random_state_t bsrange_state;
 582         os_random_state_t verify_state;
 583
 584         int shm_id;
 585
 586         /*
 587          * IO engine hooks, contains everything needed to submit an io_u
 588          * to any of the available IO engines.
 589          */
 590         struct ioengine_ops *io_ops;
 591
 592         /*
 593          * Current IO depth and list of free and busy io_u's.
 594          */
 595         unsigned int cur_depth;
 596         unsigned int io_u_queued;
 597         struct flist_head io_u_freelist;
 598         struct flist_head io_u_busylist;
 599         struct flist_head io_u_requeues;
 600
 601         /*
 602          * Rate state
 603          */
 604         unsigned long rate_usec_cycle;
 605         long rate_pending_usleep;
 606         unsigned long rate_bytes;
 607         unsigned long rate_blocks;
 608         struct timeval lastrate;
 609
 610         unsigned long long total_io_size;
 611
 612         unsigned long io_issues[2];
 613         unsigned long long io_blocks[2];
 614         unsigned long long io_bytes[2];
 615         unsigned long long io_skip_bytes;
 616         unsigned long long this_io_bytes[2];
 617         unsigned long long zone_bytes;
 618         struct fio_mutex *mutex;
 619
 620         /*
 621          * State for random io, a bitmap of blocks done vs not done
 622          */
 623         os_random_state_t random_state;
 624
 625         struct timeval start;   /* start of this loop */
 626         struct timeval epoch;   /* time job was started */
 627         struct timeval rw_end[2];
 628         struct timeval last_issue;
 629         struct timeval tv_cache;
 630         unsigned int tv_cache_nr;
 631         unsigned int tv_cache_mask;
 632         unsigned int rw_end_set[2];
 633         unsigned int ramp_time_over;
 634
 635         /*
 636          * read/write mixed workload state
 637          */
 638         os_random_state_t rwmix_state;
 639         unsigned long rwmix_issues;
 640         enum fio_ddir rwmix_ddir;
 641         unsigned int ddir_nr;
 642
 643         /*
 644          * IO history logs for verification. We use a tree for sorting,
 645          * if we are overwriting. Otherwise just use a fifo.
 646          */
 647         struct rb_root io_hist_tree;
 648         struct flist_head io_hist_list;
 649
 650         /*
 651          * For IO replaying
 652          */
 653         struct flist_head io_log_list;
 654
 655         /*
 656          * for fileservice, how often to switch to a new file
 657          */
 658         unsigned int file_service_nr;
 659         unsigned int file_service_left;
 660         struct fio_file *file_service_file;
 661
 662         /*
 663          * For generating file sizes
 664          */
 665         os_random_state_t file_size_state;
 666 };
 667
 668 /*
 669  * roundrobin available files, or choose one at random, or do each one
 670  * serially.
 671  */
 672 enum {
 673         FIO_FSERVICE_RANDOM     = 1,
 674         FIO_FSERVICE_RR         = 2,
 675         FIO_FSERVICE_SEQ        = 3,
 676 };
 677
 678 /*
 679  * when should interactive ETA output be generated
 680  */
 681 enum {
 682         FIO_ETA_AUTO,
 683         FIO_ETA_ALWAYS,
 684         FIO_ETA_NEVER,
 685 };
 686
 687 #define __td_verror(td, err, msg, func)                                 \
 688         do {                                                            \
 689                 if ((td)->error)                                        \
 690                         break;                                          \
 691                 int e = (err);                                          \
 692                 (td)->error = e;                                        \
 693                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));       \
 694         } while (0)
 695
 696
 697 #define td_verror(td, err, func)        \
 698         __td_verror((td), (err), strerror((err)), (func))
 699 #define td_vmsg(td, err, msg, func)     \
 700         __td_verror((td), (err), (msg), (func))
 701
 702 extern int exitall_on_terminate;
 703 extern int thread_number;
 704 extern int nr_process, nr_thread;
 705 extern int shm_id;
 706 extern int groupid;
 707 extern int terse_output;
 708 extern int temp_stall_ts;
 709 extern unsigned long long mlock_size;
 710 extern unsigned long page_mask, page_size;
 711 extern int read_only;
 712 extern int eta_print;
 713 extern unsigned long done_secs;
 714 extern char *job_section;
 715 extern int fio_gtod_offload;
 716 extern int fio_gtod_cpu;
 717
 718 extern struct thread_data *threads;
 719
 720 #define td_read(td)             ((td)->o.td_ddir & TD_DDIR_READ)
 721 #define td_write(td)            ((td)->o.td_ddir & TD_DDIR_WRITE)
 722 #define td_rw(td)               (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
 723 #define td_random(td)           ((td)->o.td_ddir & TD_DDIR_RAND)
 724 #define file_randommap(td, f)   (!(td)->o.norandommap && (f)->file_map)
 725
 726 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
 727 {
 728         assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
 729 }
 730
 731 #define BLOCKS_PER_MAP          (8 * sizeof(int))
 732 #define TO_MAP_BLOCK(f, b)      (b)
 733 #define RAND_MAP_IDX(f, b)      (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
 734 #define RAND_MAP_BIT(f, b)      (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
 735
 736 #define MAX_JOBS        (1024)
 737
 738 static inline int should_fsync(struct thread_data *td)
 739 {
 740         if (td->last_was_sync)
 741                 return 0;
 742         if (td->o.odirect)
 743                 return 0;
 744         if (td_write(td) || td_rw(td) || td->o.override_sync)
 745                 return 1;
 746
 747         return 0;
 748 }
 749
 750 /*
 751  * Disk utils as read in /sys/block/<dev>/stat
 752  */
 753 struct disk_util_stat {
 754         unsigned ios[2];
 755         unsigned merges[2];
 756         unsigned long long sectors[2];
 757         unsigned ticks[2];
 758         unsigned io_ticks;
 759         unsigned time_in_queue;
 760 };
 761
 762 /*
 763  * Per-device disk util management
 764  */
 765 struct disk_util {
 766         struct flist_head list;
 767         /* If this disk is a slave, hook it into the master's
 768          * list using this head.
 769          */
 770         struct flist_head slavelist;
 771
 772         char *name;
 773         char *sysfs_root;
 774         char path[256];
 775         int major, minor;
 776
 777         struct disk_util_stat dus;
 778         struct disk_util_stat last_dus;
 779
 780         /* For software raids, this entry maintains pointers to the
 781          * entries for the slave devices. The disk_util entries for
 782          * the slaves devices should primarily be maintained through
 783          * the disk_list list, i.e. for memory allocation and
 784          * de-allocation, etc. Whereas this list should be used only
 785          * for aggregating a software RAID's disk util figures.
 786          */
 787         struct flist_head slaves;
 788
 789         unsigned long msec;
 790         struct timeval time;
 791
 792         struct fio_mutex *lock;
 793         unsigned long users;
 794 };
 795
 796 static inline void disk_util_inc(struct disk_util *du)
 797 {
 798         if (du) {
 799                 fio_mutex_down(du->lock);
 800                 du->users++;
 801                 fio_mutex_up(du->lock);
 802         }
 803 }
 804
 805 static inline void disk_util_dec(struct disk_util *du)
 806 {
 807         if (du) {
 808                 fio_mutex_down(du->lock);
 809                 du->users--;
 810                 fio_mutex_up(du->lock);
 811         }
 812 }
 813
 814 #define DISK_UTIL_MSEC  (250)
 815
 816 /*
 817  * Log exports
 818  */
 819 enum file_log_act {
 820         FIO_LOG_ADD_FILE,
 821         FIO_LOG_OPEN_FILE,
 822         FIO_LOG_CLOSE_FILE,
 823         FIO_LOG_UNLINK_FILE,
 824 };
 825
 826 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
 827 extern void log_io_u(struct thread_data *, struct io_u *);
 828 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
 829 extern int __must_check init_iolog(struct thread_data *td);
 830 extern void log_io_piece(struct thread_data *, struct io_u *);
 831 extern void queue_io_piece(struct thread_data *, struct io_piece *);
 832 extern void prune_io_piece_log(struct thread_data *);
 833 extern void write_iolog_close(struct thread_data *);
 834
 835 /*
 836  * Logging
 837  */
 838 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long,
 839                                 unsigned int);
 840 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
 841                                 unsigned int);
 842 extern void add_bw_sample(struct thread_data *, enum fio_ddir, unsigned int,
 843                                 struct timeval *);
 844 extern void show_run_stats(void);
 845 extern void init_disk_util(struct thread_data *);
 846 extern void update_rusage_stat(struct thread_data *);
 847 extern void update_io_ticks(void);
 848 extern void setup_log(struct io_log **);
 849 extern void finish_log(struct thread_data *, struct io_log *, const char *);
 850 extern void finish_log_named(struct thread_data *, struct io_log *, const char *, const char *);
 851 extern void __finish_log(struct io_log *, const char *);
 852 extern struct io_log *agg_io_log[2];
 853 extern int write_bw_log;
 854 extern void add_agg_sample(unsigned long, enum fio_ddir, unsigned int);
 855
 856 /*
 857  * Time functions
 858  */
 859 extern unsigned long long utime_since(struct timeval *, struct timeval *);
 860 extern unsigned long long utime_since_now(struct timeval *);
 861 extern unsigned long mtime_since(struct timeval *, struct timeval *);
 862 extern unsigned long mtime_since_now(struct timeval *);
 863 extern unsigned long time_since_now(struct timeval *);
 864 extern unsigned long mtime_since_genesis(void);
 865 extern void usec_spin(unsigned int);
 866 extern void usec_sleep(struct thread_data *, unsigned long);
 867 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
 868 extern void fill_start_time(struct timeval *);
 869 extern void fio_gettime(struct timeval *, void *);
 870 extern void fio_gtod_init(void);
 871 extern void fio_gtod_update(void);
 872 extern void set_genesis_time(void);
 873 extern int ramp_time_over(struct thread_data *);
 874 extern int in_ramp_time(struct thread_data *);
 875
 876 /*
 877  * Init/option functions
 878  */
 879 extern int __must_check parse_options(int, char **);
 880 extern int fio_options_parse(struct thread_data *, char **, int);
 881 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
 882 extern void fio_fill_default_options(struct thread_data *);
 883 extern int fio_show_option_help(const char *);
 884 extern void fio_options_dup_and_init(struct option *);
 885 extern void options_mem_dupe(struct thread_data *);
 886 extern void options_mem_free(struct thread_data *);
 887 extern void td_fill_rand_seeds(struct thread_data *);
 888 #define FIO_GETOPT_JOB          0x89988998
 889 #define FIO_NR_OPTIONS          128
 890
 891 /*
 892  * File setup/shutdown
 893  */
 894 extern void close_files(struct thread_data *);
 895 extern void close_and_free_files(struct thread_data *);
 896 extern int __must_check setup_files(struct thread_data *);
 897 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
 898 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
 899 extern int __must_check generic_close_file(struct thread_data *, struct fio_file *);
 900 extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *);
 901 extern int __must_check pre_read_files(struct thread_data *);
 902 extern int add_file(struct thread_data *, const char *);
 903 extern void get_file(struct fio_file *);
 904 extern int __must_check put_file(struct thread_data *, struct fio_file *);
 905 extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
 906 extern void unlock_file(struct thread_data *, struct fio_file *);
 907 extern void unlock_file_all(struct thread_data *, struct fio_file *);
 908 extern int add_dir_files(struct thread_data *, const char *);
 909 extern int init_random_map(struct thread_data *);
 910 extern void dup_files(struct thread_data *, struct thread_data *);
 911 extern int get_fileno(struct thread_data *, const char *);
 912 extern void free_release_files(struct thread_data *);
 913
 914 /*
 915  * ETA/status stuff
 916  */
 917 extern void print_thread_status(void);
 918 extern void print_status_init(int);
 919
 920 /*
 921  * disk util stuff
 922  */
 923 #ifdef FIO_HAVE_DISK_UTIL
 924 extern void show_disk_util(void);
 925 extern void init_disk_util(struct thread_data *);
 926 extern void update_io_ticks(void);
 927 #else
 928 #define show_disk_util()
 929 #define init_disk_util(td)
 930 #define update_io_ticks()
 931 #endif
 932
 933 /*
 934  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 935  * will never back again. It may cycle between running/verififying/fsyncing.
 936  * Once the thread reaches TD_EXITED, it is just waiting for the core to
 937  * reap it.
 938  */
 939 enum {
 940         TD_NOT_CREATED = 0,
 941         TD_CREATED,
 942         TD_INITIALIZED,
 943         TD_RAMP,
 944         TD_RUNNING,
 945         TD_PRE_READING,
 946         TD_VERIFYING,
 947         TD_FSYNCING,
 948         TD_EXITED,
 949         TD_REAPED,
 950 };
 951
 952 extern void td_set_runstate(struct thread_data *, int);
 953
 954 /*
 955  * Verify helpers
 956  */
 957 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
 958 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
 959 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
 960
 961 /*
 962  * Memory helpers
 963  */
 964 extern int __must_check fio_pin_memory(void);
 965 extern void fio_unpin_memory(void);
 966 extern int __must_check allocate_io_mem(struct thread_data *);
 967 extern void free_io_mem(struct thread_data *);
 968
 969 /*
 970  * io unit handling
 971  */
 972 #define queue_full(td)  flist_empty(&(td)->io_u_freelist)
 973 extern struct io_u *__get_io_u(struct thread_data *);
 974 extern struct io_u *get_io_u(struct thread_data *);
 975 extern void put_io_u(struct thread_data *, struct io_u *);
 976 extern void requeue_io_u(struct thread_data *, struct io_u **);
 977 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
 978 extern long __must_check io_u_queued_complete(struct thread_data *, int);
 979 extern void io_u_queued(struct thread_data *, struct io_u *);
 980 extern void io_u_log_error(struct thread_data *, struct io_u *);
 981 extern void io_u_mark_depth(struct thread_data *, unsigned int);
 982 extern void io_u_fill_buffer(struct thread_data *td, struct io_u *, unsigned int);
 983 void io_u_mark_complete(struct thread_data *, unsigned int);
 984 void io_u_mark_submit(struct thread_data *, unsigned int);
 985
 986 /*
 987  * Reset stats after ramp time completes
 988  */
 989 extern void reset_all_stats(struct thread_data *);
 990
 991 /*
 992  * io engine entry points
 993  */
 994 extern int __must_check td_io_init(struct thread_data *);
 995 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
 996 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
 997 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
 998 extern int __must_check td_io_getevents(struct thread_data *, unsigned int, unsigned int, struct timespec *);
 999 extern int __must_check td_io_commit(struct thread_data *);
1000 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
1001 extern int td_io_close_file(struct thread_data *, struct fio_file *);
1002 extern int __must_check td_io_get_file_size(struct thread_data *, struct fio_file *);
1003
1004 /*
1005  * blktrace support
1006  */
1007 #ifdef FIO_HAVE_BLKTRACE
1008 extern int is_blktrace(const char *);
1009 extern int load_blktrace(struct thread_data *, const char *);
1010 #endif
1011
1012 struct ioengine_ops {
1013         struct flist_head list;
1014         char name[16];
1015         int version;
1016         int flags;
1017         int (*setup)(struct thread_data *);
1018         int (*init)(struct thread_data *);
1019         int (*prep)(struct thread_data *, struct io_u *);
1020         int (*queue)(struct thread_data *, struct io_u *);
1021         int (*commit)(struct thread_data *);
1022         int (*getevents)(struct thread_data *, unsigned int, unsigned int, struct timespec *);
1023         struct io_u *(*event)(struct thread_data *, int);
1024         int (*cancel)(struct thread_data *, struct io_u *);
1025         void (*cleanup)(struct thread_data *);
1026         int (*open_file)(struct thread_data *, struct fio_file *);
1027         int (*close_file)(struct thread_data *, struct fio_file *);
1028         int (*get_file_size)(struct thread_data *, struct fio_file *);
1029         void *data;
1030         void *dlhandle;
1031 };
1032
1033 #define FIO_IOOPS_VERSION       10
1034
1035 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
1036 extern void register_ioengine(struct ioengine_ops *);
1037 extern void unregister_ioengine(struct ioengine_ops *);
1038 extern void close_ioengine(struct thread_data *);
1039
1040 /*
1041  * Mark unused variables passed to ops functions as unused, to silence gcc
1042  */
1043 #define fio_unused      __attribute((__unused__))
1044 #define fio_init        __attribute__((constructor))
1045 #define fio_exit        __attribute__((destructor))
1046
1047 #define for_each_td(td, i)      \
1048         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
1049 #define for_each_file(td, f, i) \
1050         if ((td)->files_index)                                          \
1051                 for ((i) = 0, (f) = (td)->files[0];                     \
1052                  (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
1053                  (i)++)
1054
1055 #define fio_assert(td, cond)    do {    \
1056         if (!(cond)) {                  \
1057                 int *__foo = NULL;      \
1058                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
1059                 (td)->runstate = TD_EXITED;     \
1060                 (td)->error = EFAULT;           \
1061                 *__foo = 0;                     \
1062         }       \
1063 } while (0)
1064
1065 static inline void fio_file_reset(struct fio_file *f)
1066 {
1067         f->last_free_lookup = 0;
1068         f->last_pos = f->file_offset;
1069         if (f->file_map)
1070                 memset(f->file_map, 0, f->num_maps * sizeof(int));
1071 }
1072
1073 static inline void clear_error(struct thread_data *td)
1074 {
1075         td->error = 0;
1076         td->verror[0] = '\0';
1077 }
1078
1079 #ifdef FIO_INC_DEBUG
1080 static inline void dprint_io_u(struct io_u *io_u, const char *p)
1081 {
1082         struct fio_file *f = io_u->file;
1083
1084         dprint(FD_IO, "%s: io_u %p: off=%llu/len=%lu/ddir=%d", p, io_u,
1085                                         (unsigned long long) io_u->offset,
1086                                         io_u->buflen, io_u->ddir);
1087         if (fio_debug & (1 << FD_IO)) {
1088                 if (f)
1089                         log_info("/%s", f->file_name);
1090
1091                 log_info("\n");
1092         }
1093 }
1094 #else
1095 #define dprint_io_u(io_u, p)
1096 #endif
1097
1098 static inline int fio_fill_issue_time(struct thread_data *td)
1099 {
1100         if (td->o.read_iolog_file ||
1101             !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
1102                 return 1;
1103
1104         return 0;
1105 }
1106
1107 #endif