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