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