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