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 verify_interval;
 399         unsigned int verify_offset;
 400         unsigned int verify_pattern;
 401         unsigned int verify_pattern_bytes;
 402         unsigned int use_thread;
 403         unsigned int unlink;
 404         unsigned int do_disk_util;
 405         unsigned int override_sync;
 406         unsigned int rand_repeatable;
 407         unsigned int write_lat_log;
 408         unsigned int write_bw_log;
 409         unsigned int norandommap;
 410         unsigned int bs_unaligned;
 411         unsigned int fsync_on_close;
 412
 413         unsigned int hugepage_size;
 414         unsigned int rw_min_bs;
 415         unsigned int thinktime;
 416         unsigned int thinktime_spin;
 417         unsigned int thinktime_blocks;
 418         unsigned int fsync_blocks;
 419         unsigned int start_delay;
 420         unsigned long long timeout;
 421         unsigned int overwrite;
 422         unsigned int bw_avg_time;
 423         unsigned int loops;
 424         unsigned long long zone_size;
 425         unsigned long long zone_skip;
 426         enum fio_memtype mem_type;
 427
 428         unsigned int stonewall;
 429         unsigned int new_group;
 430         unsigned int numjobs;
 431         os_cpu_mask_t cpumask;
 432         unsigned int cpumask_set;
 433         unsigned int iolog;
 434         unsigned int rwmixcycle;
 435         unsigned int rwmix[2];
 436         unsigned int nice;
 437         unsigned int file_service_type;
 438         unsigned int group_reporting;
 439         unsigned int fadvise_hint;
 440         unsigned int zero_buffers;
 441         unsigned int time_based;
 442
 443         char *read_iolog_file;
 444         char *write_iolog_file;
 445
 446         /*
 447          * Pre-run and post-run shell
 448          */
 449         char *exec_prerun;
 450         char *exec_postrun;
 451
 452         unsigned int rate;
 453         unsigned int ratemin;
 454         unsigned int ratecycle;
 455         unsigned int rate_iops;
 456         unsigned int rate_iops_min;
 457
 458         char *ioscheduler;
 459
 460         /*
 461          * CPU "io" cycle burner
 462          */
 463         unsigned int cpuload;
 464         unsigned int cpucycle;
 465 };
 466
 467 #define FIO_VERROR_SIZE 128
 468
 469 /*
 470  * This describes a single thread/process executing a fio job.
 471  */
 472 struct thread_data {
 473         struct thread_options o;
 474         char verror[FIO_VERROR_SIZE];
 475         pthread_t thread;
 476         int thread_number;
 477         int groupid;
 478         struct thread_stat ts;
 479         struct fio_file *files;
 480         unsigned int files_index;
 481         unsigned int nr_open_files;
 482         unsigned int nr_done_files;
 483         unsigned int nr_normal_files;
 484         union {
 485                 unsigned int next_file;
 486                 os_random_state_t next_file_state;
 487         };
 488         int error;
 489         int done;
 490         pid_t pid;
 491         char *orig_buffer;
 492         size_t orig_buffer_size;
 493         volatile int terminate;
 494         volatile int runstate;
 495         unsigned int ioprio;
 496         unsigned int last_was_sync;
 497
 498         char *mmapfile;
 499         int mmapfd;
 500
 501         void *iolog_buf;
 502         FILE *iolog_f;
 503
 504         char *sysfs_root;
 505
 506         os_random_state_t bsrange_state;
 507         os_random_state_t verify_state;
 508
 509         int shm_id;
 510
 511         /*
 512          * IO engine hooks, contains everything needed to submit an io_u
 513          * to any of the available IO engines.
 514          */
 515         struct ioengine_ops *io_ops;
 516
 517         /*
 518          * Current IO depth and list of free and busy io_u's.
 519          */
 520         unsigned int cur_depth;
 521         struct list_head io_u_freelist;
 522         struct list_head io_u_busylist;
 523         struct list_head io_u_requeues;
 524         unsigned int io_u_queued;
 525
 526         /*
 527          * Rate state
 528          */
 529         unsigned long rate_usec_cycle;
 530         long rate_pending_usleep;
 531         unsigned long rate_bytes;
 532         unsigned long rate_blocks;
 533         struct timeval lastrate;
 534
 535         unsigned long long total_io_size;
 536
 537         unsigned long io_issues[2];
 538         unsigned long long io_blocks[2];
 539         unsigned long long io_bytes[2];
 540         unsigned long long io_skip_bytes;
 541         unsigned long long this_io_bytes[2];
 542         unsigned long long zone_bytes;
 543         struct fio_sem *mutex;
 544
 545         /*
 546          * State for random io, a bitmap of blocks done vs not done
 547          */
 548         os_random_state_t random_state;
 549
 550         struct timeval start;   /* start of this loop */
 551         struct timeval epoch;   /* time job was started */
 552         struct timeval rw_end[2];
 553         struct timeval last_issue;
 554         unsigned int rw_end_set[2];
 555
 556         /*
 557          * read/write mixed workload state
 558          */
 559         os_random_state_t rwmix_state;
 560         unsigned long long rwmix_bytes;
 561         struct timeval rwmix_switch;
 562         enum fio_ddir rwmix_ddir;
 563         unsigned int ddir_nr;
 564
 565         /*
 566          * IO history logs for verification. We use a tree for sorting,
 567          * if we are overwriting. Otherwise just use a fifo.
 568          */
 569         struct rb_root io_hist_tree;
 570         struct list_head io_hist_list;
 571
 572         /*
 573          * For IO replaying
 574          */
 575         struct list_head io_log_list;
 576
 577         /*
 578          * timeout handling
 579          */
 580         struct timeval timeout_end;
 581         struct itimerval timer;
 582
 583         /*
 584          * for fileservice, how often to switch to a new file
 585          */
 586         unsigned int file_service_nr;
 587         unsigned int file_service_left;
 588         struct fio_file *file_service_file;
 589
 590         /*
 591          * For generating file sizes
 592          */
 593         os_random_state_t file_size_state;
 594 };
 595
 596 /*
 597  * roundrobin available files, or choose one at random.
 598  */
 599 enum {
 600         FIO_FSERVICE_RANDOM     = 1,
 601         FIO_FSERVICE_RR         = 2,
 602 };
 603
 604 /*
 605  * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
 606  * the timer on each queue operation.
 607  */
 608 #define IO_U_TIMEOUT_INC        5
 609 #define IO_U_TIMEOUT            30
 610
 611 #define __td_verror(td, err, msg, func)                                 \
 612         do {                                                            \
 613                 if ((td)->error)                                        \
 614                         break;                                          \
 615                 int e = (err);                                          \
 616                 (td)->error = e;                                        \
 617                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));       \
 618         } while (0)
 619
 620
 621 #define td_verror(td, err, func)        \
 622         __td_verror((td), (err), strerror((err)), (func))
 623 #define td_vmsg(td, err, msg, func)     \
 624         __td_verror((td), (err), (msg), (func))
 625
 626 extern int exitall_on_terminate;
 627 extern int thread_number;
 628 extern int nr_process, nr_thread;
 629 extern int shm_id;
 630 extern int groupid;
 631 extern int terse_output;
 632 extern FILE *f_out;
 633 extern FILE *f_err;
 634 extern int temp_stall_ts;
 635 extern unsigned long long mlock_size;
 636 extern unsigned long page_mask, page_size;
 637
 638 extern struct thread_data *threads;
 639
 640 #define td_read(td)             ((td)->o.td_ddir & TD_DDIR_READ)
 641 #define td_write(td)            ((td)->o.td_ddir & TD_DDIR_WRITE)
 642 #define td_rw(td)               (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
 643 #define td_random(td)           ((td)->o.td_ddir & TD_DDIR_RAND)
 644
 645 #define BLOCKS_PER_MAP          (8 * sizeof(long))
 646 #define TO_MAP_BLOCK(td, f, b)  ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
 647 #define RAND_MAP_IDX(td, f, b)  (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
 648 #define RAND_MAP_BIT(td, f, b)  (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
 649
 650 #define MAX_JOBS        (1024)
 651
 652 static inline int should_fsync(struct thread_data *td)
 653 {
 654         if (td->last_was_sync)
 655                 return 0;
 656         if (td->o.odirect)
 657                 return 0;
 658         if (td_write(td) || td_rw(td) || td->o.override_sync)
 659                 return 1;
 660
 661         return 0;
 662 }
 663
 664 /*
 665  * Disk utils as read in /sys/block/<dev>/stat
 666  */
 667 struct disk_util_stat {
 668         unsigned ios[2];
 669         unsigned merges[2];
 670         unsigned long long sectors[2];
 671         unsigned ticks[2];
 672         unsigned io_ticks;
 673         unsigned time_in_queue;
 674 };
 675
 676 /*
 677  * Per-device disk util management
 678  */
 679 struct disk_util {
 680         struct list_head list;
 681
 682         char *name;
 683         char *sysfs_root;
 684         char path[256];
 685         int major, minor;
 686
 687         struct disk_util_stat dus;
 688         struct disk_util_stat last_dus;
 689
 690         unsigned long msec;
 691         struct timeval time;
 692 };
 693
 694 #define DISK_UTIL_MSEC  (250)
 695
 696 /*
 697  * Log exports
 698  */
 699 enum file_log_act {
 700         FIO_LOG_ADD_FILE,
 701         FIO_LOG_OPEN_FILE,
 702         FIO_LOG_CLOSE_FILE,
 703 };
 704
 705 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
 706 extern void log_io_u(struct thread_data *, struct io_u *);
 707 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
 708 extern int __must_check init_iolog(struct thread_data *td);
 709 extern void log_io_piece(struct thread_data *, struct io_u *);
 710 extern void prune_io_piece_log(struct thread_data *);
 711 extern void write_iolog_close(struct thread_data *);
 712
 713 /*
 714  * Logging
 715  */
 716 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
 717 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
 718 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
 719 extern void show_run_stats(void);
 720 extern void init_disk_util(struct thread_data *);
 721 extern void update_rusage_stat(struct thread_data *);
 722 extern void update_io_ticks(void);
 723 extern void disk_util_timer_arm(void);
 724 extern void setup_log(struct io_log **);
 725 extern void finish_log(struct thread_data *, struct io_log *, const char *);
 726 extern void __finish_log(struct io_log *, const char *);
 727 extern struct io_log *agg_io_log[2];
 728 extern int write_bw_log;
 729 extern void add_agg_sample(unsigned long, enum fio_ddir);
 730
 731 /*
 732  * Time functions
 733  */
 734 extern unsigned long utime_since(struct timeval *, struct timeval *);
 735 extern unsigned long utime_since_now(struct timeval *);
 736 extern unsigned long mtime_since(struct timeval *, struct timeval *);
 737 extern unsigned long mtime_since_now(struct timeval *);
 738 extern unsigned long time_since_now(struct timeval *);
 739 extern unsigned long mtime_since_genesis(void);
 740 extern void __usec_sleep(unsigned int);
 741 extern void usec_sleep(struct thread_data *, unsigned long);
 742 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
 743 extern void fill_start_time(struct timeval *);
 744 extern void fio_gettime(struct timeval *, void *);
 745 extern void set_genesis_time(void);
 746
 747 /*
 748  * Init/option functions
 749  */
 750 extern int __must_check parse_options(int, char **);
 751 extern int fio_option_parse(struct thread_data *, const char *);
 752 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
 753 extern void fio_fill_default_options(struct thread_data *);
 754 extern int fio_show_option_help(const char *);
 755 extern void fio_options_dup_and_init(struct option *);
 756 extern void options_mem_dupe(struct thread_data *);
 757 extern void options_mem_free(struct thread_data *);
 758 #define FIO_GETOPT_JOB          0x89988998
 759 #define FIO_NR_OPTIONS          128
 760
 761 /*
 762  * File setup/shutdown
 763  */
 764 extern void close_files(struct thread_data *);
 765 extern int __must_check setup_files(struct thread_data *);
 766 extern int __must_check open_files(struct thread_data *);
 767 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
 768 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
 769 extern void generic_close_file(struct thread_data *, struct fio_file *);
 770 extern int add_file(struct thread_data *, const char *);
 771 extern void get_file(struct fio_file *);
 772 extern void put_file(struct thread_data *, struct fio_file *);
 773 extern int add_dir_files(struct thread_data *, const char *);
 774 extern int init_random_map(struct thread_data *);
 775 extern void dup_files(struct thread_data *, struct thread_data *);
 776 extern int get_fileno(struct thread_data *, const char *);
 777 extern void free_release_files(struct thread_data *);
 778
 779 /*
 780  * ETA/status stuff
 781  */
 782 extern void print_thread_status(void);
 783 extern void print_status_init(int);
 784
 785 /*
 786  * disk util stuff
 787  */
 788 #ifdef FIO_HAVE_DISK_UTIL
 789 extern void show_disk_util(void);
 790 extern void disk_util_timer_arm(void);
 791 extern void init_disk_util(struct thread_data *);
 792 extern void update_io_ticks(void);
 793 #else
 794 #define show_disk_util()
 795 #define disk_util_timer_arm()
 796 #define init_disk_util(td)
 797 #define update_io_ticks()
 798 #endif
 799
 800 /*
 801  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 802  * will never back again. It may cycle between running/verififying/fsyncing.
 803  * Once the thread reaches TD_EXITED, it is just waiting for the core to
 804  * reap it.
 805  */
 806 enum {
 807         TD_NOT_CREATED = 0,
 808         TD_CREATED,
 809         TD_INITIALIZED,
 810         TD_RUNNING,
 811         TD_VERIFYING,
 812         TD_FSYNCING,
 813         TD_EXITED,
 814         TD_REAPED,
 815 };
 816
 817 /*
 818  * Verify helpers
 819  */
 820 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
 821 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
 822 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
 823
 824 /*
 825  * Memory helpers
 826  */
 827 extern int __must_check fio_pin_memory(void);
 828 extern void fio_unpin_memory(void);
 829 extern int __must_check allocate_io_mem(struct thread_data *);
 830 extern void free_io_mem(struct thread_data *);
 831
 832 /*
 833  * io unit handling
 834  */
 835 #define queue_full(td)  list_empty(&(td)->io_u_freelist)
 836 extern struct io_u *__get_io_u(struct thread_data *);
 837 extern struct io_u *get_io_u(struct thread_data *);
 838 extern void put_io_u(struct thread_data *, struct io_u *);
 839 extern void requeue_io_u(struct thread_data *, struct io_u **);
 840 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
 841 extern long __must_check io_u_queued_complete(struct thread_data *, int);
 842 extern void io_u_queued(struct thread_data *, struct io_u *);
 843 extern void io_u_log_error(struct thread_data *, struct io_u *);
 844 extern void io_u_init_timeout(void);
 845 extern void io_u_set_timeout(struct thread_data *);
 846 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
 847
 848 /*
 849  * io engine entry points
 850  */
 851 extern int __must_check td_io_init(struct thread_data *);
 852 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
 853 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
 854 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
 855 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
 856 extern int __must_check td_io_commit(struct thread_data *);
 857 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
 858 extern void td_io_close_file(struct thread_data *, struct fio_file *);
 859
 860 /*
 861  * blktrace support
 862  */
 863 #ifdef FIO_HAVE_BLKTRACE
 864 extern int is_blktrace(const char *);
 865 extern int load_blktrace(struct thread_data *, const char *);
 866 #endif
 867
 868 /*
 869  * If logging output to a file, stderr should go to both stderr and f_err
 870  */
 871 #define log_err(args...)        do {            \
 872         fprintf(f_err, ##args);                 \
 873         if (f_err != stderr)                    \
 874                 fprintf(stderr, ##args);        \
 875         } while (0)
 876
 877 #define log_info(args...)       fprintf(f_out, ##args)
 878
 879 FILE *get_f_out(void);
 880 FILE *get_f_err(void);
 881
 882 struct ioengine_ops {
 883         struct list_head list;
 884         char name[16];
 885         int version;
 886         int flags;
 887         int (*setup)(struct thread_data *);
 888         int (*init)(struct thread_data *);
 889         int (*prep)(struct thread_data *, struct io_u *);
 890         int (*queue)(struct thread_data *, struct io_u *);
 891         int (*commit)(struct thread_data *);
 892         int (*getevents)(struct thread_data *, int, int, struct timespec *);
 893         struct io_u *(*event)(struct thread_data *, int);
 894         int (*cancel)(struct thread_data *, struct io_u *);
 895         void (*cleanup)(struct thread_data *);
 896         int (*open_file)(struct thread_data *, struct fio_file *);
 897         void (*close_file)(struct thread_data *, struct fio_file *);
 898         void *data;
 899         void *dlhandle;
 900 };
 901
 902 #define FIO_IOOPS_VERSION       7
 903
 904 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
 905 extern void register_ioengine(struct ioengine_ops *);
 906 extern void unregister_ioengine(struct ioengine_ops *);
 907 extern void close_ioengine(struct thread_data *);
 908
 909 /*
 910  * Mark unused variables passed to ops functions as unused, to silence gcc
 911  */
 912 #define fio_unused      __attribute((__unused__))
 913 #define fio_init        __attribute__((constructor))
 914 #define fio_exit        __attribute__((destructor))
 915
 916 #define for_each_td(td, i)      \
 917         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
 918 #define for_each_file(td, f, i) \
 919         for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
 920
 921 #define fio_assert(td, cond)    do {    \
 922         if (!(cond)) {                  \
 923                 int *__foo = NULL;      \
 924                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
 925                 (td)->runstate = TD_EXITED;     \
 926                 (td)->error = EFAULT;           \
 927                 *__foo = 0;                     \
 928         }       \
 929 } while (0)
 930
 931 static inline void clear_error(struct thread_data *td)
 932 {
 933         td->error = 0;
 934         td->verror[0] = '\0';
 935 }
 936
 937 #endif