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