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