fio.h

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