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