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         FIO_SIZE_KNOWN          = 1 << 7,       /* size has been set */
 245 };
 246
 247 /*
 248  * Each thread_data structure has a number of files associated with it,
 249  * this structure holds state information for a single file.
 250  */
 251 struct fio_file {
 252         enum fio_filetype filetype;
 253
 254         /*
 255          * A file may not be a file descriptor, let the io engine decide
 256          */
 257         union {
 258                 unsigned long file_data;
 259                 int fd;
 260         };
 261
 262         /*
 263          * filename and possible memory mapping
 264          */
 265         char *file_name;
 266         void *mmap;
 267
 268         /*
 269          * size of the file, offset into file, and io size from that offset
 270          */
 271         unsigned long long real_file_size;
 272         unsigned long long file_offset;
 273         unsigned long long io_size;
 274
 275         unsigned long long last_pos;
 276         unsigned long long last_completed_pos;
 277
 278         /*
 279          * block map for random io
 280          */
 281         unsigned long *file_map;
 282         unsigned int num_maps;
 283         unsigned int last_free_lookup;
 284
 285         int references;
 286         enum fio_file_flags flags;
 287 };
 288
 289 /*
 290  * How many depth levels to log
 291  */
 292 #define FIO_IO_U_MAP_NR 8
 293 #define FIO_IO_U_LAT_NR 12
 294
 295 struct thread_stat {
 296         char *name;
 297         char *verror;
 298         int error;
 299         int groupid;
 300         pid_t pid;
 301         char *description;
 302         int members;
 303
 304         struct io_log *slat_log;
 305         struct io_log *clat_log;
 306         struct io_log *bw_log;
 307
 308         /*
 309          * bandwidth and latency stats
 310          */
 311         struct io_stat clat_stat[2];            /* completion latency */
 312         struct io_stat slat_stat[2];            /* submission latency */
 313         struct io_stat bw_stat[2];              /* bandwidth stats */
 314
 315         unsigned long long stat_io_bytes[2];
 316         struct timeval stat_sample_time[2];
 317
 318         /*
 319          * fio system usage accounting
 320          */
 321         struct rusage ru_start;
 322         struct rusage ru_end;
 323         unsigned long usr_time;
 324         unsigned long sys_time;
 325         unsigned long ctx;
 326
 327         /*
 328          * IO depth and latency stats
 329          */
 330         unsigned int io_u_map[FIO_IO_U_MAP_NR];
 331         unsigned int io_u_lat[FIO_IO_U_LAT_NR];
 332         unsigned long total_io_u[2];
 333
 334         unsigned long long io_bytes[2];
 335         unsigned long runtime[2];
 336         unsigned long total_run_time;
 337 };
 338
 339 struct thread_options {
 340         int pad;
 341         char *description;
 342         char *name;
 343         char *directory;
 344         char *filename;
 345         char *opendir;
 346         char *ioengine;
 347         enum td_ddir td_ddir;
 348         unsigned int ddir_nr;
 349         unsigned int iodepth;
 350         unsigned int iodepth_low;
 351         unsigned int iodepth_batch;
 352
 353         unsigned long long size;
 354         unsigned long long file_size_low;
 355         unsigned long long file_size_high;
 356         unsigned long long start_offset;
 357
 358         unsigned int bs[2];
 359         unsigned int min_bs[2];
 360         unsigned int max_bs[2];
 361
 362         unsigned int nr_files;
 363         unsigned int open_files;
 364
 365         unsigned int odirect;
 366         unsigned int invalidate_cache;
 367         unsigned int create_serialize;
 368         unsigned int create_fsync;
 369         unsigned int end_fsync;
 370         unsigned int sync_io;
 371         unsigned int verify;
 372         unsigned int verifysort;
 373         unsigned int use_thread;
 374         unsigned int unlink;
 375         unsigned int do_disk_util;
 376         unsigned int override_sync;
 377         unsigned int rand_repeatable;
 378         unsigned int write_lat_log;
 379         unsigned int write_bw_log;
 380         unsigned int norandommap;
 381         unsigned int bs_unaligned;
 382         unsigned int fsync_on_close;
 383
 384         unsigned int hugepage_size;
 385         unsigned int rw_min_bs;
 386         unsigned int thinktime;
 387         unsigned int thinktime_spin;
 388         unsigned int thinktime_blocks;
 389         unsigned int fsync_blocks;
 390         unsigned int start_delay;
 391         unsigned long timeout;
 392         unsigned int overwrite;
 393         unsigned int bw_avg_time;
 394         unsigned int loops;
 395         unsigned long long zone_size;
 396         unsigned long long zone_skip;
 397         enum fio_memtype mem_type;
 398
 399         unsigned int stonewall;
 400         unsigned int new_group;
 401         unsigned int numjobs;
 402         os_cpu_mask_t cpumask;
 403         unsigned int iolog;
 404         unsigned int read_iolog;
 405         unsigned int rwmixcycle;
 406         unsigned int rwmix[2];
 407         unsigned int nice;
 408         unsigned int file_service_type;
 409         unsigned int group_reporting;
 410         unsigned int fadvise_hint;
 411
 412         char *read_iolog_file;
 413         char *write_iolog_file;
 414
 415         /*
 416          * Pre-run and post-run shell
 417          */
 418         char *exec_prerun;
 419         char *exec_postrun;
 420
 421         unsigned int rate;
 422         unsigned int ratemin;
 423         unsigned int ratecycle;
 424         unsigned int rate_iops;
 425         unsigned int rate_iops_min;
 426
 427         char *ioscheduler;
 428
 429         /*
 430          * CPU "io" cycle burner
 431          */
 432         unsigned int cpuload;
 433         unsigned int cpucycle;
 434 };
 435
 436 #define FIO_VERROR_SIZE 128
 437
 438 /*
 439  * This describes a single thread/process executing a fio job.
 440  */
 441 struct thread_data {
 442         struct thread_options o;
 443         char verror[FIO_VERROR_SIZE];
 444         pthread_t thread;
 445         int thread_number;
 446         int groupid;
 447         struct thread_stat ts;
 448         struct fio_file *files;
 449         unsigned int files_index;
 450         unsigned int nr_open_files;
 451         unsigned int nr_normal_files;
 452         union {
 453                 unsigned int next_file;
 454                 os_random_state_t next_file_state;
 455         };
 456         int error;
 457         pid_t pid;
 458         char *orig_buffer;
 459         size_t orig_buffer_size;
 460         volatile int terminate;
 461         volatile int runstate;
 462         unsigned int ioprio;
 463         unsigned int last_was_sync;
 464
 465         char *mmapfile;
 466         int mmapfd;
 467
 468         void *iolog_buf;
 469         FILE *iolog_f;
 470
 471         char *sysfs_root;
 472
 473         os_random_state_t bsrange_state;
 474         os_random_state_t verify_state;
 475
 476         int shm_id;
 477
 478         /*
 479          * IO engine hooks, contains everything needed to submit an io_u
 480          * to any of the available IO engines.
 481          */
 482         struct ioengine_ops *io_ops;
 483
 484         /*
 485          * Current IO depth and list of free and busy io_u's.
 486          */
 487         unsigned int cur_depth;
 488         struct list_head io_u_freelist;
 489         struct list_head io_u_busylist;
 490         struct list_head io_u_requeues;
 491         unsigned int io_u_queued;
 492
 493         /*
 494          * Rate state
 495          */
 496         unsigned long rate_usec_cycle;
 497         long rate_pending_usleep;
 498         unsigned long rate_bytes;
 499         unsigned long rate_blocks;
 500         struct timeval lastrate;
 501
 502         unsigned long long total_io_size;
 503
 504         unsigned long io_issues[2];
 505         unsigned long long io_blocks[2];
 506         unsigned long long io_bytes[2];
 507         unsigned long long this_io_bytes[2];
 508         unsigned long long zone_bytes;
 509         struct fio_sem *mutex;
 510
 511         /*
 512          * State for random io, a bitmap of blocks done vs not done
 513          */
 514         os_random_state_t random_state;
 515
 516         struct timeval start;   /* start of this loop */
 517         struct timeval epoch;   /* time job was started */
 518         struct timeval rw_end[2];
 519         unsigned int rw_end_set[2];
 520
 521         /*
 522          * read/write mixed workload state
 523          */
 524         os_random_state_t rwmix_state;
 525         unsigned long long rwmix_bytes;
 526         struct timeval rwmix_switch;
 527         enum fio_ddir rwmix_ddir;
 528         unsigned int ddir_nr;
 529
 530         /*
 531          * IO history logs for verification. We use a tree for sorting,
 532          * if we are overwriting. Otherwise just use a fifo.
 533          */
 534         struct rb_root io_hist_tree;
 535         struct list_head io_hist_list;
 536
 537         /*
 538          * For IO replaying
 539          */
 540         struct list_head io_log_list;
 541
 542         /*
 543          * timeout handling
 544          */
 545         struct timeval timeout_end;
 546         struct itimerval timer;
 547
 548         /*
 549          * for fileservice, how often to switch to a new file
 550          */
 551         unsigned int file_service_nr;
 552         unsigned int file_service_left;
 553         struct fio_file *file_service_file;
 554
 555         /*
 556          * For generating file sizes
 557          */
 558         os_random_state_t file_size_state;
 559 };
 560
 561 /*
 562  * roundrobin available files, or choose one at random.
 563  */
 564 enum {
 565         FIO_FSERVICE_RANDOM     = 1,
 566         FIO_FSERVICE_RR         = 2,
 567 };
 568
 569 /*
 570  * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
 571  * the timer on each queue operation.
 572  */
 573 #define IO_U_TIMEOUT_INC        5
 574 #define IO_U_TIMEOUT            30
 575
 576 #define __td_verror(td, err, msg, func)                                 \
 577         do {                                                            \
 578                 if ((td)->error)                                        \
 579                         break;                                          \
 580                 int e = (err);                                          \
 581                 (td)->error = e;                                        \
 582                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));       \
 583         } while (0)
 584
 585
 586 #define td_verror(td, err, func)        \
 587         __td_verror((td), (err), strerror((err)), (func))
 588 #define td_vmsg(td, err, msg, func)     \
 589         __td_verror((td), (err), (msg), (func))
 590
 591 extern int exitall_on_terminate;
 592 extern int thread_number;
 593 extern int nr_process, nr_thread;
 594 extern int shm_id;
 595 extern int groupid;
 596 extern int terse_output;
 597 extern FILE *f_out;
 598 extern FILE *f_err;
 599 extern int temp_stall_ts;
 600 extern unsigned long long mlock_size;
 601 extern unsigned long page_mask, page_size;
 602
 603 extern struct thread_data *threads;
 604
 605 #define td_read(td)             ((td)->o.td_ddir & TD_DDIR_READ)
 606 #define td_write(td)            ((td)->o.td_ddir & TD_DDIR_WRITE)
 607 #define td_rw(td)               (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
 608 #define td_random(td)           ((td)->o.td_ddir & TD_DDIR_RAND)
 609
 610 #define BLOCKS_PER_MAP          (8 * sizeof(long))
 611 #define TO_MAP_BLOCK(td, f, b)  ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
 612 #define RAND_MAP_IDX(td, f, b)  (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
 613 #define RAND_MAP_BIT(td, f, b)  (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
 614
 615 #define MAX_JOBS        (1024)
 616
 617 static inline int should_fsync(struct thread_data *td)
 618 {
 619         if (td->last_was_sync)
 620                 return 0;
 621         if (td->o.odirect)
 622                 return 0;
 623         if (td_write(td) || td_rw(td) || td->o.override_sync)
 624                 return 1;
 625
 626         return 0;
 627 }
 628
 629 /*
 630  * Disk utils as read in /sys/block/<dev>/stat
 631  */
 632 struct disk_util_stat {
 633         unsigned ios[2];
 634         unsigned merges[2];
 635         unsigned long long sectors[2];
 636         unsigned ticks[2];
 637         unsigned io_ticks;
 638         unsigned time_in_queue;
 639 };
 640
 641 /*
 642  * Per-device disk util management
 643  */
 644 struct disk_util {
 645         struct list_head list;
 646
 647         char *name;
 648         char path[256];
 649         dev_t dev;
 650
 651         struct disk_util_stat dus;
 652         struct disk_util_stat last_dus;
 653
 654         unsigned long msec;
 655         struct timeval time;
 656 };
 657
 658 #define DISK_UTIL_MSEC  (250)
 659
 660 #ifndef min
 661 #define min(a, b)       ((a) < (b) ? (a) : (b))
 662 #endif
 663 #ifndef max
 664 #define max(a, b)       ((a) > (b) ? (a) : (b))
 665 #endif
 666
 667 /*
 668  * Log exports
 669  */
 670 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
 671 extern void write_iolog_put(struct thread_data *, struct io_u *);
 672 extern int __must_check init_iolog(struct thread_data *td);
 673 extern void log_io_piece(struct thread_data *, struct io_u *);
 674 extern void prune_io_piece_log(struct thread_data *);
 675 extern void write_iolog_close(struct thread_data *);
 676
 677 /*
 678  * Logging
 679  */
 680 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
 681 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
 682 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
 683 extern void show_run_stats(void);
 684 extern void init_disk_util(struct thread_data *);
 685 extern void update_rusage_stat(struct thread_data *);
 686 extern void update_io_ticks(void);
 687 extern void disk_util_timer_arm(void);
 688 extern void setup_log(struct io_log **);
 689 extern void finish_log(struct thread_data *, struct io_log *, const char *);
 690 extern void __finish_log(struct io_log *, const char *);
 691 extern struct io_log *agg_io_log[2];
 692 extern int write_bw_log;
 693 extern void add_agg_sample(unsigned long, enum fio_ddir);
 694
 695 /*
 696  * Time functions
 697  */
 698 extern unsigned long utime_since(struct timeval *, struct timeval *);
 699 extern unsigned long utime_since_now(struct timeval *);
 700 extern unsigned long mtime_since(struct timeval *, struct timeval *);
 701 extern unsigned long mtime_since_now(struct timeval *);
 702 extern unsigned long time_since_now(struct timeval *);
 703 extern unsigned long mtime_since_genesis(void);
 704 extern void __usec_sleep(unsigned int);
 705 extern void usec_sleep(struct thread_data *, unsigned long);
 706 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
 707 extern void fill_start_time(struct timeval *);
 708 extern void fio_gettime(struct timeval *, void *);
 709 extern void set_genesis_time(void);
 710
 711 /*
 712  * Init/option functions
 713  */
 714 extern int __must_check parse_options(int, char **);
 715 extern int fio_option_parse(struct thread_data *, const char *);
 716 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
 717 extern void fio_fill_default_options(struct thread_data *);
 718 extern int fio_show_option_help(const char *);
 719 extern void fio_options_dup_and_init(struct option *);
 720 extern void options_mem_dupe(struct thread_data *);
 721 extern void options_mem_free(struct thread_data *);
 722 #define FIO_GETOPT_JOB          0x89988998
 723 #define FIO_NR_OPTIONS          128
 724
 725 /*
 726  * File setup/shutdown
 727  */
 728 extern void close_files(struct thread_data *);
 729 extern int __must_check setup_files(struct thread_data *);
 730 extern int __must_check open_files(struct thread_data *);
 731 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
 732 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
 733 extern void generic_close_file(struct thread_data *, struct fio_file *);
 734 extern void add_file(struct thread_data *, const char *);
 735 extern void get_file(struct fio_file *);
 736 extern void put_file(struct thread_data *, struct fio_file *);
 737 extern int add_dir_files(struct thread_data *, const char *);
 738 extern int init_random_map(struct thread_data *);
 739 extern void dup_files(struct thread_data *, struct thread_data *);
 740
 741 /*
 742  * ETA/status stuff
 743  */
 744 extern void print_thread_status(void);
 745 extern void print_status_init(int);
 746
 747 /*
 748  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 749  * will never back again. It may cycle between running/verififying/fsyncing.
 750  * Once the thread reaches TD_EXITED, it is just waiting for the core to
 751  * reap it.
 752  */
 753 enum {
 754         TD_NOT_CREATED = 0,
 755         TD_CREATED,
 756         TD_INITIALIZED,
 757         TD_RUNNING,
 758         TD_VERIFYING,
 759         TD_FSYNCING,
 760         TD_EXITED,
 761         TD_REAPED,
 762 };
 763
 764 /*
 765  * Verify helpers
 766  */
 767 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
 768 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
 769 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
 770
 771 /*
 772  * Memory helpers
 773  */
 774 extern int __must_check fio_pin_memory(void);
 775 extern void fio_unpin_memory(void);
 776 extern int __must_check allocate_io_mem(struct thread_data *);
 777 extern void free_io_mem(struct thread_data *);
 778
 779 /*
 780  * io unit handling
 781  */
 782 #define queue_full(td)  list_empty(&(td)->io_u_freelist)
 783 extern struct io_u *__get_io_u(struct thread_data *);
 784 extern struct io_u *get_io_u(struct thread_data *);
 785 extern void put_io_u(struct thread_data *, struct io_u *);
 786 extern void requeue_io_u(struct thread_data *, struct io_u **);
 787 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
 788 extern long __must_check io_u_queued_complete(struct thread_data *, int);
 789 extern void io_u_queued(struct thread_data *, struct io_u *);
 790 extern void io_u_log_error(struct thread_data *, struct io_u *);
 791 extern void io_u_init_timeout(void);
 792 extern void io_u_set_timeout(struct thread_data *);
 793 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
 794
 795 /*
 796  * io engine entry points
 797  */
 798 extern int __must_check td_io_init(struct thread_data *);
 799 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
 800 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
 801 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
 802 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
 803 extern int __must_check td_io_commit(struct thread_data *);
 804 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
 805 extern void td_io_close_file(struct thread_data *, struct fio_file *);
 806
 807 /*
 808  * If logging output to a file, stderr should go to both stderr and f_err
 809  */
 810 #define log_err(args...)        do {            \
 811         fprintf(f_err, ##args);                 \
 812         if (f_err != stderr)                    \
 813                 fprintf(stderr, ##args);        \
 814         } while (0)
 815
 816 #define log_info(args...)       fprintf(f_out, ##args)
 817
 818 FILE *get_f_out(void);
 819 FILE *get_f_err(void);
 820
 821 struct ioengine_ops {
 822         struct list_head list;
 823         char name[16];
 824         int version;
 825         int flags;
 826         int (*setup)(struct thread_data *);
 827         int (*init)(struct thread_data *);
 828         int (*prep)(struct thread_data *, struct io_u *);
 829         int (*queue)(struct thread_data *, struct io_u *);
 830         int (*commit)(struct thread_data *);
 831         int (*getevents)(struct thread_data *, int, int, struct timespec *);
 832         struct io_u *(*event)(struct thread_data *, int);
 833         int (*cancel)(struct thread_data *, struct io_u *);
 834         void (*cleanup)(struct thread_data *);
 835         int (*open_file)(struct thread_data *, struct fio_file *);
 836         void (*close_file)(struct thread_data *, struct fio_file *);
 837         void *data;
 838         void *dlhandle;
 839 };
 840
 841 #define FIO_IOOPS_VERSION       7
 842
 843 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
 844 extern void register_ioengine(struct ioengine_ops *);
 845 extern void unregister_ioengine(struct ioengine_ops *);
 846 extern void close_ioengine(struct thread_data *);
 847
 848 /*
 849  * Mark unused variables passed to ops functions as unused, to silence gcc
 850  */
 851 #define fio_unused      __attribute((__unused__))
 852 #define fio_init        __attribute__((constructor))
 853 #define fio_exit        __attribute__((destructor))
 854
 855 #define for_each_td(td, i)      \
 856         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
 857 #define for_each_file(td, f, i) \
 858         for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
 859
 860 #define fio_assert(td, cond)    do {    \
 861         if (!(cond)) {                  \
 862                 int *__foo = NULL;      \
 863                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
 864                 (td)->runstate = TD_EXITED;     \
 865                 (td)->error = EFAULT;           \
 866                 *__foo = 0;                     \
 867         }       \
 868 } while (0)
 869
 870 static inline void clear_error(struct thread_data *td)
 871 {
 872         td->error = 0;
 873         td->verror[0] = '\0';
 874 }
 875
 876 #endif