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