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