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