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