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
  15 #include "list.h"
  16 #include "md5.h"
  17 #include "crc32.h"
  18 #include "arch.h"
  19 #include "os.h"
  20
  21 enum fio_ddir {
  22         DDIR_READ = 0,
  23         DDIR_WRITE,
  24         DDIR_SYNC,
  25 };
  26
  27 struct io_stat {
  28         unsigned long max_val;
  29         unsigned long min_val;
  30         unsigned long samples;
  31
  32         double mean;
  33         double S;
  34 };
  35
  36 struct io_sample {
  37         unsigned long time;
  38         unsigned long val;
  39         enum fio_ddir ddir;
  40 };
  41
  42 struct io_log {
  43         unsigned long nr_samples;
  44         unsigned long max_samples;
  45         struct io_sample *log;
  46 };
  47
  48 struct io_piece {
  49         struct list_head list;
  50         struct fio_file *file;
  51         unsigned long long offset;
  52         unsigned int len;
  53         enum fio_ddir ddir;
  54 };
  55
  56 /*
  57  * The io unit
  58  */
  59 struct io_u {
  60         union {
  61 #ifdef FIO_HAVE_LIBAIO
  62                 struct iocb iocb;
  63 #endif
  64 #ifdef FIO_HAVE_POSIXAIO
  65                 struct aiocb aiocb;
  66 #endif
  67 #ifdef FIO_HAVE_SGIO
  68                 struct sg_io_hdr hdr;
  69 #endif
  70         };
  71         struct timeval start_time;
  72         struct timeval issue_time;
  73
  74         void *buf;
  75         unsigned int buflen;
  76         unsigned long long offset;
  77
  78         unsigned int resid;
  79         unsigned int error;
  80
  81         enum fio_ddir ddir;
  82
  83         /*
  84          * io engine private data
  85          */
  86         union {
  87                 unsigned int index;
  88                 unsigned int seen;
  89         };
  90
  91         struct fio_file *file;
  92
  93         struct list_head list;
  94 };
  95
  96 #define FIO_HDR_MAGIC   0xf00baaef
  97
  98 enum {
  99         VERIFY_NONE = 0,
 100         VERIFY_MD5,
 101         VERIFY_CRC32,
 102 };
 103
 104 struct verify_header {
 105         unsigned int fio_magic;
 106         unsigned int len;
 107         unsigned int verify_type;
 108         union {
 109                 char md5_digest[MD5_HASH_WORDS * 4];
 110                 unsigned long crc32;
 111         };
 112 };
 113
 114 struct group_run_stats {
 115         unsigned long long max_run[2], min_run[2];
 116         unsigned long long max_bw[2], min_bw[2];
 117         unsigned long long io_kb[2];
 118         unsigned long long agg[2];
 119 };
 120
 121 /*
 122  * What type of allocation to use for io buffers
 123  */
 124 enum fio_memtype {
 125         MEM_MALLOC = 0, /* ordinary malloc */
 126         MEM_SHM,        /* use shared memory segments */
 127         MEM_SHMHUGE,    /* use shared memory segments with huge pages */
 128         MEM_MMAP,       /* use anonynomous mmap */
 129         MEM_MMAPHUGE,   /* memory mapped huge file */
 130 };
 131
 132 /*
 133  * The type of object we are working on
 134  */
 135 enum fio_filetype {
 136         FIO_TYPE_FILE = 1,
 137         FIO_TYPE_BD,
 138         FIO_TYPE_CHAR,
 139 };
 140
 141 enum fio_ioengine_flags {
 142         FIO_SYNCIO      = 1 << 0,
 143         FIO_CPUIO       = 1 << 1,
 144         FIO_MMAPIO      = 1 << 2,
 145         FIO_RAWIO       = 1 << 3,
 146         FIO_NETIO       = 1 << 4,
 147 };
 148
 149 struct fio_file {
 150         /*
 151          * A file may not be a file descriptor, let the io engine decide
 152          */
 153         union {
 154                 unsigned long file_data;
 155                 int fd;
 156         };
 157         char *file_name;
 158         void *mmap;
 159         unsigned long long file_size;
 160         unsigned long long real_file_size;
 161         unsigned long long file_offset;
 162         unsigned long long last_pos;
 163         unsigned long long last_completed_pos;
 164
 165         unsigned long *file_map;
 166         unsigned int num_maps;
 167
 168         unsigned int unlink;
 169 };
 170
 171 /*
 172  * How many depth levels to log
 173  */
 174 #define FIO_IO_U_MAP_NR 8
 175
 176 /*
 177  * This describes a single thread/process executing a fio job.
 178  */
 179 struct thread_data {
 180         char *description;
 181         char *name;
 182         char *directory;
 183         char *filename;
 184         char verror[80];
 185         pthread_t thread;
 186         int thread_number;
 187         int groupid;
 188         enum fio_filetype filetype;
 189         struct fio_file *files;
 190         unsigned int nr_files;
 191         unsigned int nr_uniq_files;
 192         unsigned int next_file;
 193         int error;
 194         pid_t pid;
 195         char *orig_buffer;
 196         size_t orig_buffer_size;
 197         volatile int terminate;
 198         volatile int runstate;
 199         enum fio_ddir ddir;
 200         unsigned int iomix;
 201         unsigned int ioprio;
 202         unsigned int last_was_sync;
 203
 204         unsigned int sequential;
 205         unsigned int odirect;
 206         unsigned int invalidate_cache;
 207         unsigned int create_serialize;
 208         unsigned int create_fsync;
 209         unsigned int end_fsync;
 210         unsigned int sync_io;
 211         unsigned int verify;
 212         unsigned int use_thread;
 213         unsigned int unlink;
 214         unsigned int do_disk_util;
 215         unsigned int override_sync;
 216         unsigned int rand_repeatable;
 217         unsigned int write_lat_log;
 218         unsigned int write_bw_log;
 219         unsigned int norandommap;
 220         unsigned int bs_unaligned;
 221
 222         unsigned int bs[2];
 223         unsigned int min_bs[2];
 224         unsigned int max_bs[2];
 225         unsigned int hugepage_size;
 226         unsigned int rw_min_bs;
 227         unsigned int thinktime;
 228         unsigned int thinktime_blocks;
 229         unsigned int fsync_blocks;
 230         unsigned int start_delay;
 231         unsigned long timeout;
 232         unsigned int overwrite;
 233         unsigned int bw_avg_time;
 234         unsigned int loops;
 235         unsigned long long zone_size;
 236         unsigned long long zone_skip;
 237         enum fio_memtype mem_type;
 238         char *mmapfile;
 239         int mmapfd;
 240         unsigned int stonewall;
 241         unsigned int numjobs;
 242         unsigned int iodepth;
 243         os_cpu_mask_t cpumask;
 244         unsigned int iolog;
 245         unsigned int read_iolog;
 246         unsigned int rwmixcycle;
 247         unsigned int rwmixread;
 248         unsigned int rwmixwrite;
 249         unsigned int nice;
 250
 251         char *read_iolog_file;
 252         char *write_iolog_file;
 253         void *iolog_buf;
 254         FILE *iolog_f;
 255
 256         char *sysfs_root;
 257         char *ioscheduler;
 258
 259         os_random_state_t bsrange_state;
 260         os_random_state_t verify_state;
 261
 262         int shm_id;
 263
 264         /*
 265          * IO engine hooks, contains everything needed to submit an io_u
 266          * to any of the available IO engines.
 267          */
 268         struct ioengine_ops *io_ops;
 269
 270         /*
 271          * Current IO depth and list of free and busy io_u's.
 272          */
 273         unsigned int cur_depth;
 274         unsigned int io_u_map[FIO_IO_U_MAP_NR];
 275         unsigned long total_io_u;
 276         struct list_head io_u_freelist;
 277         struct list_head io_u_busylist;
 278
 279         /*
 280          * Rate state
 281          */
 282         unsigned int rate;
 283         unsigned int ratemin;
 284         unsigned int ratecycle;
 285         unsigned long rate_usec_cycle;
 286         long rate_pending_usleep;
 287         unsigned long rate_bytes;
 288         struct timeval lastrate;
 289
 290         unsigned long runtime[2];               /* msec */
 291         unsigned long long io_size;
 292         unsigned long long total_file_size;
 293         unsigned long long start_offset;
 294         unsigned long long total_io_size;
 295
 296         unsigned long long io_blocks[2];
 297         unsigned long long io_bytes[2];
 298         unsigned long long zone_bytes;
 299         unsigned long long this_io_bytes[2];
 300         volatile int mutex;
 301
 302         /*
 303          * State for random io, a bitmap of blocks done vs not done
 304          */
 305         os_random_state_t random_state;
 306
 307         /*
 308          * CPU "io" cycle burner
 309          */
 310         unsigned int cpuload;
 311         unsigned int cpucycle;
 312
 313         /*
 314          * bandwidth and latency stats
 315          */
 316         struct io_stat clat_stat[2];            /* completion latency */
 317         struct io_stat slat_stat[2];            /* submission latency */
 318         struct io_stat bw_stat[2];              /* bandwidth stats */
 319
 320         unsigned long long stat_io_bytes[2];
 321         struct timeval stat_sample_time[2];
 322
 323         struct io_log *slat_log;
 324         struct io_log *clat_log;
 325         struct io_log *bw_log;
 326
 327         struct timeval start;   /* start of this loop */
 328         struct timeval epoch;   /* time job was started */
 329         struct timeval end_time;/* time job ended */
 330
 331         /*
 332          * fio system usage accounting
 333          */
 334         struct rusage ru_start;
 335         struct rusage ru_end;
 336         unsigned long usr_time;
 337         unsigned long sys_time;
 338         unsigned long ctx;
 339
 340         /*
 341          * read/write mixed workload state
 342          */
 343         os_random_state_t rwmix_state;
 344         struct timeval rwmix_switch;
 345         enum fio_ddir rwmix_ddir;
 346
 347         /*
 348          * Pre-run and post-run shell
 349          */
 350         char *exec_prerun;
 351         char *exec_postrun;
 352
 353         /*
 354          * IO historic logs
 355          */
 356         struct list_head io_hist_list;
 357         struct list_head io_log_list;
 358 };
 359
 360 #define __td_verror(td, err, msg)                                       \
 361         do {                                                            \
 362                 int e = (err);                                          \
 363                 (td)->error = e;                                        \
 364                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, (msg));        \
 365         } while (0)
 366
 367
 368 #define td_verror(td, err)      __td_verror((td), (err), strerror((err)))
 369 #define td_vmsg(td, err, msg)   __td_verror((td), (err), (msg))
 370
 371 extern int exitall_on_terminate;
 372 extern int thread_number;
 373 extern int shm_id;
 374 extern int groupid;
 375 extern int terse_output;
 376 extern FILE *f_out;
 377 extern FILE *f_err;
 378 extern int temp_stall_ts;
 379 extern unsigned long long mlock_size;
 380
 381 extern struct thread_data *threads;
 382
 383 #define td_read(td)             ((td)->ddir == DDIR_READ)
 384 #define td_write(td)            ((td)->ddir == DDIR_WRITE)
 385 #define td_rw(td)               ((td)->iomix != 0)
 386
 387 #define BLOCKS_PER_MAP          (8 * sizeof(long))
 388 #define TO_MAP_BLOCK(td, f, b)  ((b) - ((f)->file_offset / (td)->rw_min_bs))
 389 #define RAND_MAP_IDX(td, f, b)  (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
 390 #define RAND_MAP_BIT(td, f, b)  (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
 391
 392 #define MAX_JOBS        (1024)
 393
 394 static inline int should_fsync(struct thread_data *td)
 395 {
 396         if (td->last_was_sync)
 397                 return 0;
 398         if (td->odirect)
 399                 return 0;
 400         if (td_write(td) || td_rw(td) || td->override_sync)
 401                 return 1;
 402
 403         return 0;
 404 }
 405
 406 struct disk_util_stat {
 407         unsigned ios[2];
 408         unsigned merges[2];
 409         unsigned long long sectors[2];
 410         unsigned ticks[2];
 411         unsigned io_ticks;
 412         unsigned time_in_queue;
 413 };
 414
 415 struct disk_util {
 416         struct list_head list;
 417
 418         char *name;
 419         char path[256];
 420         dev_t dev;
 421
 422         struct disk_util_stat dus;
 423         struct disk_util_stat last_dus;
 424
 425         unsigned long msec;
 426         struct timeval time;
 427 };
 428
 429 struct io_completion_data {
 430         int nr;                         /* input */
 431
 432         int error;                      /* output */
 433         unsigned long bytes_done[2];    /* output */
 434         struct timeval time;            /* output */
 435 };
 436
 437 #define DISK_UTIL_MSEC  (250)
 438
 439 #ifndef min
 440 #define min(a, b)       ((a) < (b) ? (a) : (b))
 441 #endif
 442 #ifndef max
 443 #define max(a, b)       ((a) > (b) ? (a) : (b))
 444 #endif
 445
 446 /*
 447  * Log exports
 448  */
 449 extern int read_iolog_get(struct thread_data *, struct io_u *);
 450 extern void write_iolog_put(struct thread_data *, struct io_u *);
 451 extern int init_iolog(struct thread_data *td);
 452 extern void log_io_piece(struct thread_data *, struct io_u *);
 453 extern void prune_io_piece_log(struct thread_data *);
 454 extern void write_iolog_close(struct thread_data *);
 455
 456 /*
 457  * Logging
 458  */
 459 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
 460 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
 461 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
 462 extern void show_run_stats(void);
 463 extern void init_disk_util(struct thread_data *);
 464 extern void update_rusage_stat(struct thread_data *);
 465 extern void update_io_ticks(void);
 466 extern void disk_util_timer_arm(void);
 467 extern void setup_log(struct io_log **);
 468 extern void finish_log(struct thread_data *, struct io_log *, const char *);
 469 extern void __finish_log(struct io_log *, const char *);
 470 extern int setup_rate(struct thread_data *);
 471 extern struct io_log *agg_io_log[2];
 472 extern int write_bw_log;
 473 extern void add_agg_sample(unsigned long, enum fio_ddir);
 474
 475 /*
 476  * Time functions
 477  */
 478 extern unsigned long utime_since(struct timeval *, struct timeval *);
 479 extern unsigned long utime_since_now(struct timeval *);
 480 extern unsigned long mtime_since(struct timeval *, struct timeval *);
 481 extern unsigned long mtime_since_now(struct timeval *);
 482 extern unsigned long time_since_now(struct timeval *);
 483 extern unsigned long mtime_since_genesis(void);
 484 extern void __usec_sleep(unsigned int);
 485 extern void usec_sleep(struct thread_data *, unsigned long);
 486 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int, int);
 487 extern void fill_start_time(struct timeval *);
 488 extern void fio_gettime(struct timeval *, void *);
 489
 490 /*
 491  * Init functions
 492  */
 493 extern int parse_options(int, char **);
 494 extern int init_random_state(struct thread_data *);
 495
 496 /*
 497  * File setup/shutdown
 498  */
 499 extern void close_files(struct thread_data *);
 500 extern int setup_files(struct thread_data *);
 501 extern int open_files(struct thread_data *);
 502 extern int file_invalidate_cache(struct thread_data *, struct fio_file *);
 503
 504 /*
 505  * ETA/status stuff
 506  */
 507 extern void print_thread_status(void);
 508 extern void print_status_init(int);
 509
 510 /*
 511  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 512  * will never back again. It may cycle between running/verififying/fsyncing.
 513  * Once the thread reaches TD_EXITED, it is just waiting for the core to
 514  * reap it.
 515  */
 516 enum {
 517         TD_NOT_CREATED = 0,
 518         TD_CREATED,
 519         TD_INITIALIZED,
 520         TD_RUNNING,
 521         TD_VERIFYING,
 522         TD_FSYNCING,
 523         TD_EXITED,
 524         TD_REAPED,
 525 };
 526
 527 /*
 528  * Verify helpers
 529  */
 530 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
 531 extern int get_next_verify(struct thread_data *td, struct io_u *);
 532 extern int do_io_u_verify(struct thread_data *, struct io_u **);
 533
 534 /*
 535  * Memory helpers
 536  */
 537 extern int fio_pin_memory(void);
 538 extern void fio_unpin_memory(void);
 539 extern int allocate_io_mem(struct thread_data *);
 540 extern void free_io_mem(struct thread_data *);
 541
 542 /*
 543  * io unit handling
 544  */
 545 #define queue_full(td)  list_empty(&(td)->io_u_freelist)
 546 extern struct io_u *__get_io_u(struct thread_data *);
 547 extern struct io_u *get_io_u(struct thread_data *, struct fio_file *);
 548 extern void put_io_u(struct thread_data *, struct io_u *);
 549 extern void ios_completed(struct thread_data *, struct io_completion_data *);
 550 extern void io_completed(struct thread_data *, struct io_u *, struct io_completion_data *);
 551
 552 /*
 553  * io engine entry points
 554  */
 555 extern int td_io_init(struct thread_data *);
 556 extern int td_io_prep(struct thread_data *, struct io_u *);
 557 extern int td_io_queue(struct thread_data *, struct io_u *);
 558 extern int td_io_sync(struct thread_data *, struct fio_file *);
 559 extern int td_io_getevents(struct thread_data *, int, int, struct timespec *);
 560
 561 /*
 562  * This is a pretty crappy semaphore implementation, but with the use that fio
 563  * has (just signalling start/go conditions), it doesn't have to be better.
 564  * Naturally this would not work for any type of contended semaphore or
 565  * for real locking.
 566  */
 567 static inline void fio_sem_init(volatile int *sem, int val)
 568 {
 569         *sem = val;
 570 }
 571
 572 static inline void fio_sem_down(volatile int *sem)
 573 {
 574         while (*sem == 0)
 575                 usleep(10000);
 576
 577         (*sem)--;
 578 }
 579
 580 static inline void fio_sem_up(volatile int *sem)
 581 {
 582         (*sem)++;
 583 }
 584
 585 /*
 586  * If logging output to a file, stderr should go to both stderr and f_err
 587  */
 588 #define log_err(args...)        do {            \
 589         fprintf(f_err, ##args);                 \
 590         if (f_err != stderr)                    \
 591                 fprintf(stderr, ##args);        \
 592         } while (0)
 593
 594 struct ioengine_ops {
 595         struct list_head list;
 596         char name[16];
 597         int version;
 598         int flags;
 599         int (*setup)(struct thread_data *);
 600         int (*init)(struct thread_data *);
 601         int (*prep)(struct thread_data *, struct io_u *);
 602         int (*queue)(struct thread_data *, struct io_u *);
 603         int (*getevents)(struct thread_data *, int, int, struct timespec *);
 604         struct io_u *(*event)(struct thread_data *, int);
 605         int (*cancel)(struct thread_data *, struct io_u *);
 606         void (*cleanup)(struct thread_data *);
 607         void *data;
 608         void *dlhandle;
 609 };
 610
 611 #define FIO_IOOPS_VERSION       3
 612
 613 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
 614 extern int register_ioengine(struct ioengine_ops *);
 615 extern void unregister_ioengine(struct ioengine_ops *);
 616 extern void close_ioengine(struct thread_data *);
 617
 618 /*
 619  * Mark unused variables passed to ops functions as unused, to silence gcc
 620  */
 621 #define fio_unused      __attribute((__unused__))
 622 #define fio_init        __attribute__((constructor))
 623 #define fio_exit        __attribute__((destructor))
 624
 625 #define for_each_td(td, i)      \
 626         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
 627 #define for_each_file(td, f, i) \
 628         for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)
 629
 630 #endif