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