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