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