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