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