fio.h

   1 #ifndef FIO_H
   2 #define FIO_H
   3
   4 #include <sched.h>
   5 #include <limits.h>
   6 #include <pthread.h>
   7 #include <sys/time.h>
   8 #include <sys/resource.h>
   9 #include <errno.h>
  10 #include <stdlib.h>
  11 #include <stdio.h>
  12 #include <unistd.h>
  13 #include <string.h>
  14 #include <getopt.h>
  15 #include <inttypes.h>
  16 #include <assert.h>
  17
  18 #include "compiler/compiler.h"
  19 #include "list.h"
  20 #include "fifo.h"
  21 #include "rbtree.h"
  22 #include "arch/arch.h"
  23 #include "os/os.h"
  24 #include "mutex.h"
  25
  26 #ifdef FIO_HAVE_SYSLET
  27 #include "syslet.h"
  28 #endif
  29
  30 #ifdef FIO_HAVE_GUASI
  31 #include <guasi.h>
  32 #endif
  33
  34 enum fio_ddir {
  35         DDIR_READ = 0,
  36         DDIR_WRITE,
  37         DDIR_SYNC,
  38         DDIR_INVAL = -1,
  39 };
  40
  41 enum td_ddir {
  42         TD_DDIR_READ            = 1 << 0,
  43         TD_DDIR_WRITE           = 1 << 1,
  44         TD_DDIR_RAND            = 1 << 2,
  45         TD_DDIR_RW              = TD_DDIR_READ | TD_DDIR_WRITE,
  46         TD_DDIR_RANDREAD        = TD_DDIR_READ | TD_DDIR_RAND,
  47         TD_DDIR_RANDWRITE       = TD_DDIR_WRITE | TD_DDIR_RAND,
  48         TD_DDIR_RANDRW          = TD_DDIR_RW | TD_DDIR_RAND,
  49 };
  50
  51 /*
  52  * Use for maintaining statistics
  53  */
  54 struct io_stat {
  55         unsigned long max_val;
  56         unsigned long min_val;
  57         unsigned long samples;
  58
  59         double mean;
  60         double S;
  61 };
  62
  63 /*
  64  * A single data sample
  65  */
  66 struct io_sample {
  67         unsigned long time;
  68         unsigned long val;
  69         enum fio_ddir ddir;
  70 };
  71
  72 /*
  73  * Dynamically growing data sample log
  74  */
  75 struct io_log {
  76         unsigned long nr_samples;
  77         unsigned long max_samples;
  78         struct io_sample *log;
  79 };
  80
  81 /*
  82  * When logging io actions, this matches a single sent io_u
  83  */
  84 struct io_piece {
  85         union {
  86                 struct rb_node rb_node;
  87                 struct list_head list;
  88         };
  89         union {
  90                 int fileno;
  91                 struct fio_file *file;
  92         };
  93         unsigned long long offset;
  94         unsigned long len;
  95         enum fio_ddir ddir;
  96         union {
  97                 unsigned long delay;
  98                 unsigned int file_action;
  99         };
 100 };
 101
 102 #ifdef FIO_HAVE_SYSLET
 103 struct syslet_req {
 104         struct syslet_uatom atom;       /* the atom to submit */
 105         struct syslet_uatom *head;      /* head of the sequence */
 106         long ret;                       /* syscall return value */
 107 };
 108 #endif
 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_SYSLET
 132                 struct syslet_req req;
 133 #endif
 134 #ifdef FIO_HAVE_GUASI
 135                 guasi_req_t greq;
 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         };
 168
 169         unsigned int flags;
 170
 171         struct fio_file *file;
 172
 173         struct list_head list;
 174
 175         /*
 176          * Callback for io completion
 177          */
 178         int (*end_io)(struct thread_data *, struct io_u *);
 179 };
 180
 181 /*
 182  * io_ops->queue() return values
 183  */
 184 enum {
 185         FIO_Q_COMPLETED = 0,            /* completed sync */
 186         FIO_Q_QUEUED    = 1,            /* queued, will complete async */
 187         FIO_Q_BUSY      = 2,            /* no more room, call ->commit() */
 188 };
 189
 190 #define FIO_HDR_MAGIC   0xf00baaef
 191
 192 enum {
 193         VERIFY_NONE = 0,                /* no verification */
 194         VERIFY_MD5,                     /* md5 sum data blocks */
 195         VERIFY_CRC64,                   /* crc64 sum data blocks */
 196         VERIFY_CRC32,                   /* crc32 sum data blocks */
 197         VERIFY_CRC16,                   /* crc16 sum data blocks */
 198         VERIFY_CRC7,                    /* crc7 sum data blocks */
 199         VERIFY_SHA256,                  /* sha256 sum data blocks */
 200         VERIFY_SHA512,                  /* sha512 sum data blocks */
 201         VERIFY_META,                    /* block_num, timestamp etc. */
 202         VERIFY_PATTERN,                 /* verify a specific pattern */
 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 };
 282
 283 enum fio_file_flags {
 284         FIO_FILE_OPEN           = 1 << 0,       /* file is open */
 285         FIO_FILE_CLOSING        = 1 << 1,       /* file being closed */
 286         FIO_FILE_EXISTS         = 1 << 2,       /* file there */
 287         FIO_FILE_EXTEND         = 1 << 3,       /* needs extend */
 288         FIO_FILE_NOSORT         = 1 << 4,       /* don't sort verify blocks */
 289         FIO_FILE_DONE           = 1 << 5,       /* io completed to this file */
 290         FIO_SIZE_KNOWN          = 1 << 6,       /* size has been set */
 291 };
 292
 293 /*
 294  * Each thread_data structure has a number of files associated with it,
 295  * this structure holds state information for a single file.
 296  */
 297 struct fio_file {
 298         enum fio_filetype filetype;
 299
 300         /*
 301          * A file may not be a file descriptor, let the io engine decide
 302          */
 303         union {
 304                 unsigned long file_data;
 305                 int fd;
 306         };
 307
 308         /*
 309          * filename and possible memory mapping
 310          */
 311         char *file_name;
 312         void *mmap;
 313         unsigned int major, minor;
 314
 315         /*
 316          * size of the file, offset into file, and io size from that offset
 317          */
 318         unsigned long long real_file_size;
 319         unsigned long long file_offset;
 320         unsigned long long io_size;
 321
 322         unsigned long long last_pos;
 323         unsigned long long last_completed_pos;
 324
 325         /*
 326          * block map for random io
 327          */
 328         unsigned long *file_map;
 329         unsigned int num_maps;
 330         unsigned int last_free_lookup;
 331
 332         int references;
 333         enum fio_file_flags flags;
 334 };
 335
 336 /*
 337  * How many depth levels to log
 338  */
 339 #define FIO_IO_U_MAP_NR 8
 340 #define FIO_IO_U_LAT_U_NR 10
 341 #define FIO_IO_U_LAT_M_NR 12
 342
 343 struct thread_stat {
 344         char *name;
 345         char *verror;
 346         int error;
 347         int groupid;
 348         pid_t pid;
 349         char *description;
 350         int members;
 351
 352         struct io_log *slat_log;
 353         struct io_log *clat_log;
 354         struct io_log *bw_log;
 355
 356         /*
 357          * bandwidth and latency stats
 358          */
 359         struct io_stat clat_stat[2];            /* completion latency */
 360         struct io_stat slat_stat[2];            /* submission latency */
 361         struct io_stat bw_stat[2];              /* bandwidth stats */
 362
 363         unsigned long long stat_io_bytes[2];
 364         struct timeval stat_sample_time[2];
 365
 366         /*
 367          * fio system usage accounting
 368          */
 369         struct rusage ru_start;
 370         struct rusage ru_end;
 371         unsigned long usr_time;
 372         unsigned long sys_time;
 373         unsigned long ctx;
 374         unsigned long minf, majf;
 375
 376         /*
 377          * IO depth and latency stats
 378          */
 379         unsigned int io_u_map[FIO_IO_U_MAP_NR];
 380         unsigned int io_u_lat_u[FIO_IO_U_LAT_U_NR];
 381         unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
 382         unsigned long total_io_u[2];
 383         unsigned long short_io_u[2];
 384
 385         unsigned long long io_bytes[2];
 386         unsigned long runtime[2];
 387         unsigned long total_run_time;
 388 };
 389
 390 struct thread_options {
 391         int pad;
 392         char *description;
 393         char *name;
 394         char *directory;
 395         char *filename;
 396         char *opendir;
 397         char *ioengine;
 398         enum td_ddir td_ddir;
 399         unsigned int ddir_nr;
 400         unsigned int iodepth;
 401         unsigned int iodepth_low;
 402         unsigned int iodepth_batch;
 403
 404         unsigned long long size;
 405         unsigned long long file_size_low;
 406         unsigned long long file_size_high;
 407         unsigned long long start_offset;
 408
 409         unsigned int bs[2];
 410         unsigned int min_bs[2];
 411         unsigned int max_bs[2];
 412
 413         unsigned int nr_files;
 414         unsigned int open_files;
 415
 416         unsigned int odirect;
 417         unsigned int invalidate_cache;
 418         unsigned int create_serialize;
 419         unsigned int create_fsync;
 420         unsigned int end_fsync;
 421         unsigned int sync_io;
 422         unsigned int verify;
 423         unsigned int do_verify;
 424         unsigned int verifysort;
 425         unsigned int verify_interval;
 426         unsigned int verify_offset;
 427         unsigned int verify_pattern;
 428         unsigned int verify_pattern_bytes;
 429         unsigned int verify_fatal;
 430         unsigned int use_thread;
 431         unsigned int unlink;
 432         unsigned int do_disk_util;
 433         unsigned int override_sync;
 434         unsigned int rand_repeatable;
 435         unsigned int write_lat_log;
 436         unsigned int write_bw_log;
 437         unsigned int norandommap;
 438         unsigned int bs_unaligned;
 439         unsigned int fsync_on_close;
 440
 441         unsigned int hugepage_size;
 442         unsigned int rw_min_bs;
 443         unsigned int thinktime;
 444         unsigned int thinktime_spin;
 445         unsigned int thinktime_blocks;
 446         unsigned int fsync_blocks;
 447         unsigned int start_delay;
 448         unsigned long long timeout;
 449         unsigned int overwrite;
 450         unsigned int bw_avg_time;
 451         unsigned int loops;
 452         unsigned long long zone_size;
 453         unsigned long long zone_skip;
 454         enum fio_memtype mem_type;
 455
 456         unsigned int stonewall;
 457         unsigned int new_group;
 458         unsigned int numjobs;
 459         os_cpu_mask_t cpumask;
 460         unsigned int cpumask_set;
 461         unsigned int iolog;
 462         unsigned int rwmixcycle;
 463         unsigned int rwmix[2];
 464         unsigned int nice;
 465         unsigned int file_service_type;
 466         unsigned int group_reporting;
 467         unsigned int fadvise_hint;
 468         unsigned int zero_buffers;
 469         unsigned int time_based;
 470
 471         char *read_iolog_file;
 472         char *write_iolog_file;
 473
 474         /*
 475          * Pre-run and post-run shell
 476          */
 477         char *exec_prerun;
 478         char *exec_postrun;
 479
 480         unsigned int rate;
 481         unsigned int ratemin;
 482         unsigned int ratecycle;
 483         unsigned int rate_iops;
 484         unsigned int rate_iops_min;
 485
 486         char *ioscheduler;
 487
 488         /*
 489          * CPU "io" cycle burner
 490          */
 491         unsigned int cpuload;
 492         unsigned int cpucycle;
 493 };
 494
 495 #define FIO_VERROR_SIZE 128
 496
 497 /*
 498  * This describes a single thread/process executing a fio job.
 499  */
 500 struct thread_data {
 501         struct thread_options o;
 502         char verror[FIO_VERROR_SIZE];
 503         pthread_t thread;
 504         int thread_number;
 505         int groupid;
 506         struct thread_stat ts;
 507         struct fio_file *files;
 508         unsigned int files_index;
 509         unsigned int nr_open_files;
 510         unsigned int nr_done_files;
 511         unsigned int nr_normal_files;
 512         union {
 513                 unsigned int next_file;
 514                 os_random_state_t next_file_state;
 515         };
 516         int error;
 517         int done;
 518         pid_t pid;
 519         char *orig_buffer;
 520         size_t orig_buffer_size;
 521         volatile int terminate;
 522         volatile int runstate;
 523         unsigned int ioprio;
 524         unsigned int last_was_sync;
 525
 526         char *mmapfile;
 527         int mmapfd;
 528
 529         void *iolog_buf;
 530         FILE *iolog_f;
 531
 532         char *sysfs_root;
 533
 534         os_random_state_t bsrange_state;
 535         os_random_state_t verify_state;
 536
 537         int shm_id;
 538
 539         /*
 540          * IO engine hooks, contains everything needed to submit an io_u
 541          * to any of the available IO engines.
 542          */
 543         struct ioengine_ops *io_ops;
 544
 545         /*
 546          * Current IO depth and list of free and busy io_u's.
 547          */
 548         unsigned int cur_depth;
 549         struct list_head io_u_freelist;
 550         struct list_head io_u_busylist;
 551         struct list_head io_u_requeues;
 552         unsigned int io_u_queued;
 553
 554         /*
 555          * Rate state
 556          */
 557         unsigned long rate_usec_cycle;
 558         long rate_pending_usleep;
 559         unsigned long rate_bytes;
 560         unsigned long rate_blocks;
 561         struct timeval lastrate;
 562
 563         unsigned long long total_io_size;
 564
 565         unsigned long io_issues[2];
 566         unsigned long long io_blocks[2];
 567         unsigned long long io_bytes[2];
 568         unsigned long long io_skip_bytes;
 569         unsigned long long this_io_bytes[2];
 570         unsigned long long zone_bytes;
 571         struct fio_sem *mutex;
 572
 573         /*
 574          * State for random io, a bitmap of blocks done vs not done
 575          */
 576         os_random_state_t random_state;
 577
 578         struct timeval start;   /* start of this loop */
 579         struct timeval epoch;   /* time job was started */
 580         struct timeval rw_end[2];
 581         struct timeval last_issue;
 582         unsigned int rw_end_set[2];
 583
 584         /*
 585          * read/write mixed workload state
 586          */
 587         os_random_state_t rwmix_state;
 588         unsigned long long rwmix_bytes;
 589         struct timeval rwmix_switch;
 590         enum fio_ddir rwmix_ddir;
 591         unsigned int ddir_nr;
 592
 593         /*
 594          * IO history logs for verification. We use a tree for sorting,
 595          * if we are overwriting. Otherwise just use a fifo.
 596          */
 597         struct rb_root io_hist_tree;
 598         struct list_head io_hist_list;
 599
 600         /*
 601          * For IO replaying
 602          */
 603         struct list_head io_log_list;
 604
 605         /*
 606          * timeout handling
 607          */
 608         struct timeval timeout_end;
 609         struct itimerval timer;
 610
 611         /*
 612          * for fileservice, how often to switch to a new file
 613          */
 614         unsigned int file_service_nr;
 615         unsigned int file_service_left;
 616         struct fio_file *file_service_file;
 617
 618         /*
 619          * For generating file sizes
 620          */
 621         os_random_state_t file_size_state;
 622 };
 623
 624 /*
 625  * roundrobin available files, or choose one at random.
 626  */
 627 enum {
 628         FIO_FSERVICE_RANDOM     = 1,
 629         FIO_FSERVICE_RR         = 2,
 630 };
 631
 632 /*
 633  * when should interactive ETA output be generated
 634  */
 635 enum {
 636         FIO_ETA_AUTO,
 637         FIO_ETA_ALWAYS,
 638         FIO_ETA_NEVER,
 639 };
 640
 641 /*
 642  * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
 643  * the timer on each queue operation.
 644  */
 645 #define IO_U_TIMEOUT_INC        5
 646 #define IO_U_TIMEOUT            30
 647
 648 #define __td_verror(td, err, msg, func)                                 \
 649         do {                                                            \
 650                 if ((td)->error)                                        \
 651                         break;                                          \
 652                 int e = (err);                                          \
 653                 (td)->error = e;                                        \
 654                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));       \
 655         } while (0)
 656
 657
 658 #define td_verror(td, err, func)        \
 659         __td_verror((td), (err), strerror((err)), (func))
 660 #define td_vmsg(td, err, msg, func)     \
 661         __td_verror((td), (err), (msg), (func))
 662
 663 extern int exitall_on_terminate;
 664 extern int thread_number;
 665 extern int nr_process, nr_thread;
 666 extern int shm_id;
 667 extern int groupid;
 668 extern int terse_output;
 669 extern FILE *f_out;
 670 extern FILE *f_err;
 671 extern int temp_stall_ts;
 672 extern unsigned long long mlock_size;
 673 extern unsigned long page_mask, page_size;
 674 extern int read_only;
 675 extern int eta_print;
 676
 677 extern struct thread_data *threads;
 678
 679 #define td_read(td)             ((td)->o.td_ddir & TD_DDIR_READ)
 680 #define td_write(td)            ((td)->o.td_ddir & TD_DDIR_WRITE)
 681 #define td_rw(td)               (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
 682 #define td_random(td)           ((td)->o.td_ddir & TD_DDIR_RAND)
 683
 684 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
 685 {
 686         assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
 687 }
 688
 689 #define BLOCKS_PER_MAP          (8 * sizeof(long))
 690 #define TO_MAP_BLOCK(td, f, b)  ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
 691 #define RAND_MAP_IDX(td, f, b)  (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
 692 #define RAND_MAP_BIT(td, f, b)  (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
 693
 694 #define MAX_JOBS        (1024)
 695
 696 static inline int should_fsync(struct thread_data *td)
 697 {
 698         if (td->last_was_sync)
 699                 return 0;
 700         if (td->o.odirect)
 701                 return 0;
 702         if (td_write(td) || td_rw(td) || td->o.override_sync)
 703                 return 1;
 704
 705         return 0;
 706 }
 707
 708 /*
 709  * Disk utils as read in /sys/block/<dev>/stat
 710  */
 711 struct disk_util_stat {
 712         unsigned ios[2];
 713         unsigned merges[2];
 714         unsigned long long sectors[2];
 715         unsigned ticks[2];
 716         unsigned io_ticks;
 717         unsigned time_in_queue;
 718 };
 719
 720 /*
 721  * Per-device disk util management
 722  */
 723 struct disk_util {
 724         struct list_head list;
 725
 726         char *name;
 727         char *sysfs_root;
 728         char path[256];
 729         int major, minor;
 730
 731         struct disk_util_stat dus;
 732         struct disk_util_stat last_dus;
 733
 734         unsigned long msec;
 735         struct timeval time;
 736 };
 737
 738 #define DISK_UTIL_MSEC  (250)
 739
 740 /*
 741  * Log exports
 742  */
 743 enum file_log_act {
 744         FIO_LOG_ADD_FILE,
 745         FIO_LOG_OPEN_FILE,
 746         FIO_LOG_CLOSE_FILE,
 747 };
 748
 749 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
 750 extern void log_io_u(struct thread_data *, struct io_u *);
 751 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
 752 extern int __must_check init_iolog(struct thread_data *td);
 753 extern void log_io_piece(struct thread_data *, struct io_u *);
 754 extern void prune_io_piece_log(struct thread_data *);
 755 extern void write_iolog_close(struct thread_data *);
 756
 757 /*
 758  * Logging
 759  */
 760 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
 761 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
 762 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
 763 extern void show_run_stats(void);
 764 extern void init_disk_util(struct thread_data *);
 765 extern void update_rusage_stat(struct thread_data *);
 766 extern void update_io_ticks(void);
 767 extern void disk_util_timer_arm(void);
 768 extern void setup_log(struct io_log **);
 769 extern void finish_log(struct thread_data *, struct io_log *, const char *);
 770 extern void __finish_log(struct io_log *, const char *);
 771 extern struct io_log *agg_io_log[2];
 772 extern int write_bw_log;
 773 extern void add_agg_sample(unsigned long, enum fio_ddir);
 774
 775 /*
 776  * Time functions
 777  */
 778 extern unsigned long utime_since(struct timeval *, struct timeval *);
 779 extern unsigned long utime_since_now(struct timeval *);
 780 extern unsigned long mtime_since(struct timeval *, struct timeval *);
 781 extern unsigned long mtime_since_now(struct timeval *);
 782 extern unsigned long time_since_now(struct timeval *);
 783 extern unsigned long mtime_since_genesis(void);
 784 extern void __usec_sleep(unsigned int);
 785 extern void usec_sleep(struct thread_data *, unsigned long);
 786 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
 787 extern void fill_start_time(struct timeval *);
 788 extern void fio_gettime(struct timeval *, void *);
 789 extern void set_genesis_time(void);
 790
 791 /*
 792  * Init/option functions
 793  */
 794 extern int __must_check parse_options(int, char **);
 795 extern int fio_option_parse(struct thread_data *, const char *);
 796 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
 797 extern void fio_fill_default_options(struct thread_data *);
 798 extern int fio_show_option_help(const char *);
 799 extern void fio_options_dup_and_init(struct option *);
 800 extern void options_mem_dupe(struct thread_data *);
 801 extern void options_mem_free(struct thread_data *);
 802 #define FIO_GETOPT_JOB          0x89988998
 803 #define FIO_NR_OPTIONS          128
 804
 805 /*
 806  * File setup/shutdown
 807  */
 808 extern void close_files(struct thread_data *);
 809 extern int __must_check setup_files(struct thread_data *);
 810 extern int __must_check open_files(struct thread_data *);
 811 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
 812 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
 813 extern void generic_close_file(struct thread_data *, struct fio_file *);
 814 extern int add_file(struct thread_data *, const char *);
 815 extern void get_file(struct fio_file *);
 816 extern void put_file(struct thread_data *, struct fio_file *);
 817 extern int add_dir_files(struct thread_data *, const char *);
 818 extern int init_random_map(struct thread_data *);
 819 extern void dup_files(struct thread_data *, struct thread_data *);
 820 extern int get_fileno(struct thread_data *, const char *);
 821 extern void free_release_files(struct thread_data *);
 822
 823 /*
 824  * ETA/status stuff
 825  */
 826 extern void print_thread_status(void);
 827 extern void print_status_init(int);
 828
 829 /*
 830  * disk util stuff
 831  */
 832 #ifdef FIO_HAVE_DISK_UTIL
 833 extern void show_disk_util(void);
 834 extern void disk_util_timer_arm(void);
 835 extern void init_disk_util(struct thread_data *);
 836 extern void update_io_ticks(void);
 837 #else
 838 #define show_disk_util()
 839 #define disk_util_timer_arm()
 840 #define init_disk_util(td)
 841 #define update_io_ticks()
 842 #endif
 843
 844 /*
 845  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 846  * will never back again. It may cycle between running/verififying/fsyncing.
 847  * Once the thread reaches TD_EXITED, it is just waiting for the core to
 848  * reap it.
 849  */
 850 enum {
 851         TD_NOT_CREATED = 0,
 852         TD_CREATED,
 853         TD_INITIALIZED,
 854         TD_RUNNING,
 855         TD_VERIFYING,
 856         TD_FSYNCING,
 857         TD_EXITED,
 858         TD_REAPED,
 859 };
 860
 861 /*
 862  * Verify helpers
 863  */
 864 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
 865 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
 866 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
 867
 868 /*
 869  * Memory helpers
 870  */
 871 extern int __must_check fio_pin_memory(void);
 872 extern void fio_unpin_memory(void);
 873 extern int __must_check allocate_io_mem(struct thread_data *);
 874 extern void free_io_mem(struct thread_data *);
 875
 876 /*
 877  * io unit handling
 878  */
 879 #define queue_full(td)  list_empty(&(td)->io_u_freelist)
 880 extern struct io_u *__get_io_u(struct thread_data *);
 881 extern struct io_u *get_io_u(struct thread_data *);
 882 extern void put_io_u(struct thread_data *, struct io_u *);
 883 extern void requeue_io_u(struct thread_data *, struct io_u **);
 884 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
 885 extern long __must_check io_u_queued_complete(struct thread_data *, int);
 886 extern void io_u_queued(struct thread_data *, struct io_u *);
 887 extern void io_u_log_error(struct thread_data *, struct io_u *);
 888 extern void io_u_init_timeout(void);
 889 extern void io_u_set_timeout(struct thread_data *);
 890 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
 891
 892 /*
 893  * io engine entry points
 894  */
 895 extern int __must_check td_io_init(struct thread_data *);
 896 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
 897 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
 898 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
 899 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
 900 extern int __must_check td_io_commit(struct thread_data *);
 901 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
 902 extern void td_io_close_file(struct thread_data *, struct fio_file *);
 903
 904 /*
 905  * blktrace support
 906  */
 907 #ifdef FIO_HAVE_BLKTRACE
 908 extern int is_blktrace(const char *);
 909 extern int load_blktrace(struct thread_data *, const char *);
 910 #endif
 911
 912 /*
 913  * If logging output to a file, stderr should go to both stderr and f_err
 914  */
 915 #define log_err(args...)        do {            \
 916         fprintf(f_err, ##args);                 \
 917         if (f_err != stderr)                    \
 918                 fprintf(stderr, ##args);        \
 919         } while (0)
 920
 921 #define log_info(args...)       fprintf(f_out, ##args)
 922
 923 FILE *get_f_out(void);
 924 FILE *get_f_err(void);
 925
 926 struct ioengine_ops {
 927         struct list_head list;
 928         char name[16];
 929         int version;
 930         int flags;
 931         int (*setup)(struct thread_data *);
 932         int (*init)(struct thread_data *);
 933         int (*prep)(struct thread_data *, struct io_u *);
 934         int (*queue)(struct thread_data *, struct io_u *);
 935         int (*commit)(struct thread_data *);
 936         int (*getevents)(struct thread_data *, int, int, struct timespec *);
 937         struct io_u *(*event)(struct thread_data *, int);
 938         int (*cancel)(struct thread_data *, struct io_u *);
 939         void (*cleanup)(struct thread_data *);
 940         int (*open_file)(struct thread_data *, struct fio_file *);
 941         void (*close_file)(struct thread_data *, struct fio_file *);
 942         void *data;
 943         void *dlhandle;
 944 };
 945
 946 #define FIO_IOOPS_VERSION       7
 947
 948 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
 949 extern void register_ioengine(struct ioengine_ops *);
 950 extern void unregister_ioengine(struct ioengine_ops *);
 951 extern void close_ioengine(struct thread_data *);
 952
 953 /*
 954  * Mark unused variables passed to ops functions as unused, to silence gcc
 955  */
 956 #define fio_unused      __attribute((__unused__))
 957 #define fio_init        __attribute__((constructor))
 958 #define fio_exit        __attribute__((destructor))
 959
 960 #define for_each_td(td, i)      \
 961         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
 962 #define for_each_file(td, f, i) \
 963         for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
 964
 965 #define fio_assert(td, cond)    do {    \
 966         if (!(cond)) {                  \
 967                 int *__foo = NULL;      \
 968                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
 969                 (td)->runstate = TD_EXITED;     \
 970                 (td)->error = EFAULT;           \
 971                 *__foo = 0;                     \
 972         }       \
 973 } while (0)
 974
 975 static inline void clear_error(struct thread_data *td)
 976 {
 977         td->error = 0;
 978         td->verror[0] = '\0';
 979 }
 980
 981 #endif