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