8 #include <sys/resource.h>
21 #ifdef FIO_HAVE_SYSLET
32 TD_DDIR_READ = 1 << 0,
33 TD_DDIR_WRITE = 1 << 1,
34 TD_DDIR_RAND = 1 << 2,
35 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
36 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
37 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
38 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
42 * Use for maintaining statistics
45 unsigned long max_val;
46 unsigned long min_val;
47 unsigned long samples;
54 * A single data sample
63 * Dynamically growing data sample log
66 unsigned long nr_samples;
67 unsigned long max_samples;
68 struct io_sample *log;
72 * When logging io actions, this matches a single sent io_u
75 struct list_head list;
76 struct fio_file *file;
77 unsigned long long offset;
82 #ifdef FIO_HAVE_SYSLET
84 struct syslet_uatom atom; /* the atom to submit */
85 struct syslet_uatom *head; /* head of the sequence */
86 long ret; /* syscall return value */
92 IO_U_F_FLIGHT = 1 << 1,
100 #ifdef FIO_HAVE_LIBAIO
103 #ifdef FIO_HAVE_POSIXAIO
107 struct sg_io_hdr hdr;
109 #ifdef FIO_HAVE_SYSLET
110 struct syslet_req req;
113 struct timeval start_time;
114 struct timeval issue_time;
117 * Allocated/set buffer and length
120 unsigned long buflen;
121 unsigned long long offset;
124 * IO engine state, may be different from above when we get
125 * partial transfers / residual data counts
128 unsigned long xfer_buflen;
136 * io engine private data
145 struct fio_file *file;
147 struct list_head list;
150 * Callback for io completion
152 int (*end_io)(struct io_u *);
156 * io_ops->queue() return values
159 FIO_Q_COMPLETED = 0, /* completed sync */
160 FIO_Q_QUEUED = 1, /* queued, will complete async */
161 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
164 #define FIO_HDR_MAGIC 0xf00baaef
167 VERIFY_NONE = 0, /* no verification */
168 VERIFY_MD5, /* md5 sum data blocks */
169 VERIFY_CRC32, /* crc32 sum data blocks */
173 * A header structure associated with each checksummed data block
175 struct verify_header {
176 unsigned int fio_magic;
178 unsigned int verify_type;
180 char md5_digest[MD5_HASH_WORDS * 4];
185 struct group_run_stats {
186 unsigned long long max_run[2], min_run[2];
187 unsigned long long max_bw[2], min_bw[2];
188 unsigned long long io_kb[2];
189 unsigned long long agg[2];
193 * What type of allocation to use for io buffers
196 MEM_MALLOC = 0, /* ordinary malloc */
197 MEM_SHM, /* use shared memory segments */
198 MEM_SHMHUGE, /* use shared memory segments with huge pages */
199 MEM_MMAP, /* use anonynomous mmap */
200 MEM_MMAPHUGE, /* memory mapped huge file */
204 * The type of object we are working on
207 FIO_TYPE_FILE = 1, /* plain file */
208 FIO_TYPE_BD, /* block device */
209 FIO_TYPE_CHAR, /* character device */
212 enum fio_ioengine_flags {
213 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
214 FIO_CPUIO = 1 << 1, /* cpu burner, doesn't do real io */
215 FIO_RAWIO = 1 << 2, /* some sort of direct/raw io */
216 FIO_DISKLESSIO = 1 << 3, /* no disk involved */
220 * Each thread_data structure has a number of files associated with it,
221 * this structure holds state information for a single file.
225 * A file may not be a file descriptor, let the io engine decide
228 unsigned long file_data;
233 unsigned long long file_size;
234 unsigned long long real_file_size;
235 unsigned long long file_offset;
236 unsigned long long last_pos;
237 unsigned long long last_completed_pos;
240 * block map for random io
242 unsigned long *file_map;
243 unsigned int num_maps;
244 unsigned int last_free_lookup;
251 * How many depth levels to log
253 #define FIO_IO_U_MAP_NR 8
254 #define FIO_IO_U_LAT_NR 12
265 struct io_log *slat_log;
266 struct io_log *clat_log;
267 struct io_log *bw_log;
270 * bandwidth and latency stats
272 struct io_stat clat_stat[2]; /* completion latency */
273 struct io_stat slat_stat[2]; /* submission latency */
274 struct io_stat bw_stat[2]; /* bandwidth stats */
276 unsigned long long stat_io_bytes[2];
277 struct timeval stat_sample_time[2];
280 * fio system usage accounting
282 struct rusage ru_start;
283 struct rusage ru_end;
284 unsigned long usr_time;
285 unsigned long sys_time;
289 * IO depth and latency stats
291 unsigned int io_u_map[FIO_IO_U_MAP_NR];
292 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
293 unsigned long total_io_u;
295 unsigned long long io_bytes[2];
296 unsigned long runtime[2];
297 unsigned long total_run_time;
301 * This describes a single thread/process executing a fio job.
313 struct thread_stat ts;
314 enum fio_filetype filetype;
315 struct fio_file *files;
316 unsigned int nr_files;
317 unsigned int nr_open_files;
318 unsigned int nr_uniq_files;
320 unsigned int next_file;
321 os_random_state_t next_file_state;
326 size_t orig_buffer_size;
327 volatile int terminate;
328 volatile int runstate;
329 enum td_ddir td_ddir;
331 unsigned int last_was_sync;
333 unsigned int odirect;
334 unsigned int invalidate_cache;
335 unsigned int create_serialize;
336 unsigned int create_fsync;
337 unsigned int end_fsync;
338 unsigned int sync_io;
340 unsigned int use_thread;
342 unsigned int do_disk_util;
343 unsigned int override_sync;
344 unsigned int rand_repeatable;
345 unsigned int write_lat_log;
346 unsigned int write_bw_log;
347 unsigned int norandommap;
348 unsigned int bs_unaligned;
351 unsigned int min_bs[2];
352 unsigned int max_bs[2];
353 unsigned int hugepage_size;
354 unsigned int rw_min_bs;
355 unsigned int thinktime;
356 unsigned int thinktime_spin;
357 unsigned int thinktime_blocks;
358 unsigned int fsync_blocks;
359 unsigned int start_delay;
360 unsigned long timeout;
361 unsigned int overwrite;
362 unsigned int bw_avg_time;
364 unsigned long long zone_size;
365 unsigned long long zone_skip;
366 enum fio_memtype mem_type;
369 unsigned int stonewall;
370 unsigned int numjobs;
371 unsigned int iodepth;
372 unsigned int iodepth_low;
373 unsigned int iodepth_batch;
374 os_cpu_mask_t cpumask;
376 unsigned int read_iolog;
377 unsigned int rwmixcycle;
378 unsigned int rwmixread;
379 unsigned int rwmixwrite;
381 unsigned int file_service_type;
382 unsigned int group_reporting;
383 unsigned int open_files;
385 char *read_iolog_file;
386 char *write_iolog_file;
393 os_random_state_t bsrange_state;
394 os_random_state_t verify_state;
399 * IO engine hooks, contains everything needed to submit an io_u
400 * to any of the available IO engines.
402 struct ioengine_ops *io_ops;
405 * Current IO depth and list of free and busy io_u's.
407 unsigned int cur_depth;
408 struct list_head io_u_freelist;
409 struct list_head io_u_busylist;
410 struct list_head io_u_requeues;
411 unsigned int io_u_queued;
417 unsigned int ratemin;
418 unsigned int ratecycle;
419 unsigned long rate_usec_cycle;
420 long rate_pending_usleep;
421 unsigned long rate_bytes;
422 struct timeval lastrate;
424 unsigned long long io_size;
425 unsigned long long total_file_size;
426 unsigned long long start_offset;
427 unsigned long long total_io_size;
429 unsigned long io_issues[2];
430 unsigned long long io_blocks[2];
431 unsigned long long io_bytes[2];
432 unsigned long long this_io_bytes[2];
433 unsigned long long zone_bytes;
437 * State for random io, a bitmap of blocks done vs not done
439 os_random_state_t random_state;
442 * CPU "io" cycle burner
444 unsigned int cpuload;
445 unsigned int cpucycle;
447 struct timeval start; /* start of this loop */
448 struct timeval epoch; /* time job was started */
451 * read/write mixed workload state
453 os_random_state_t rwmix_state;
454 struct timeval rwmix_switch;
455 enum fio_ddir rwmix_ddir;
458 * Pre-run and post-run shell
466 struct list_head io_hist_list;
467 struct list_head io_log_list;
472 struct timeval timeout_end;
473 struct itimerval timer;
477 * roundrobin available files, or choose one at random.
480 FIO_FSERVICE_RANDOM = 1,
485 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
486 * the timer on each queue operation.
488 #define IO_U_TIMEOUT_INC 5
489 #define IO_U_TIMEOUT 30
491 #define __td_verror(td, err, msg, func) \
497 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
501 #define td_verror(td, err, func) \
502 __td_verror((td), (err), strerror((err)), (func))
503 #define td_vmsg(td, err, msg, func) \
504 __td_verror((td), (err), (msg), (func))
506 extern int exitall_on_terminate;
507 extern int thread_number;
510 extern int terse_output;
513 extern int temp_stall_ts;
514 extern unsigned long long mlock_size;
516 extern struct thread_data *threads;
518 #define td_read(td) ((td)->td_ddir & TD_DDIR_READ)
519 #define td_write(td) ((td)->td_ddir & TD_DDIR_WRITE)
520 #define td_rw(td) (((td)->td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
521 #define td_random(td) ((td)->td_ddir & TD_DDIR_RAND)
523 #define BLOCKS_PER_MAP (8 * sizeof(long))
524 #define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->rw_min_bs))
525 #define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
526 #define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
528 #define MAX_JOBS (1024)
530 static inline int should_fsync(struct thread_data *td)
532 if (td->last_was_sync)
536 if (td_write(td) || td_rw(td) || td->override_sync)
543 * Disk utils as read in /sys/block/<dev>/stat
545 struct disk_util_stat {
548 unsigned long long sectors[2];
551 unsigned time_in_queue;
555 * Per-device disk util management
558 struct list_head list;
564 struct disk_util_stat dus;
565 struct disk_util_stat last_dus;
571 #define DISK_UTIL_MSEC (250)
574 #define min(a, b) ((a) < (b) ? (a) : (b))
577 #define max(a, b) ((a) > (b) ? (a) : (b))
583 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
584 extern void write_iolog_put(struct thread_data *, struct io_u *);
585 extern int __must_check init_iolog(struct thread_data *td);
586 extern void log_io_piece(struct thread_data *, struct io_u *);
587 extern void prune_io_piece_log(struct thread_data *);
588 extern void write_iolog_close(struct thread_data *);
593 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
594 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
595 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
596 extern void show_run_stats(void);
597 extern void init_disk_util(struct thread_data *);
598 extern void update_rusage_stat(struct thread_data *);
599 extern void update_io_ticks(void);
600 extern void disk_util_timer_arm(void);
601 extern void setup_log(struct io_log **);
602 extern void finish_log(struct thread_data *, struct io_log *, const char *);
603 extern void __finish_log(struct io_log *, const char *);
604 extern int setup_rate(struct thread_data *);
605 extern struct io_log *agg_io_log[2];
606 extern int write_bw_log;
607 extern void add_agg_sample(unsigned long, enum fio_ddir);
612 extern unsigned long utime_since(struct timeval *, struct timeval *);
613 extern unsigned long utime_since_now(struct timeval *);
614 extern unsigned long mtime_since(struct timeval *, struct timeval *);
615 extern unsigned long mtime_since_now(struct timeval *);
616 extern unsigned long time_since_now(struct timeval *);
617 extern unsigned long mtime_since_genesis(void);
618 extern void __usec_sleep(unsigned int);
619 extern void usec_sleep(struct thread_data *, unsigned long);
620 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
621 extern void fill_start_time(struct timeval *);
622 extern void fio_gettime(struct timeval *, void *);
623 extern void set_genesis_time(void);
628 extern int __must_check parse_options(int, char **);
629 extern int __must_check init_random_state(struct thread_data *);
632 * File setup/shutdown
634 extern void close_files(struct thread_data *);
635 extern int __must_check setup_files(struct thread_data *);
636 extern int __must_check open_files(struct thread_data *);
637 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
638 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
639 extern void generic_close_file(struct thread_data *, struct fio_file *);
644 extern void print_thread_status(void);
645 extern void print_status_init(int);
648 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
649 * will never back again. It may cycle between running/verififying/fsyncing.
650 * Once the thread reaches TD_EXITED, it is just waiting for the core to
667 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
668 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
669 extern int __must_check verify_io_u(struct io_u *);
674 extern int __must_check fio_pin_memory(void);
675 extern void fio_unpin_memory(void);
676 extern int __must_check allocate_io_mem(struct thread_data *);
677 extern void free_io_mem(struct thread_data *);
682 #define queue_full(td) list_empty(&(td)->io_u_freelist)
683 extern struct io_u *__get_io_u(struct thread_data *);
684 extern struct io_u *get_io_u(struct thread_data *);
685 extern void put_io_u(struct thread_data *, struct io_u *);
686 extern void requeue_io_u(struct thread_data *, struct io_u **);
687 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
688 extern long __must_check io_u_queued_complete(struct thread_data *, int);
689 extern void io_u_queued(struct thread_data *, struct io_u *);
690 extern void io_u_log_error(struct thread_data *, struct io_u *);
691 extern void io_u_init_timeout(void);
692 extern void io_u_set_timeout(struct thread_data *);
695 * io engine entry points
697 extern int __must_check td_io_init(struct thread_data *);
698 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
699 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
700 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
701 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
702 extern int __must_check td_io_commit(struct thread_data *);
703 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
704 extern void td_io_close_file(struct thread_data *, struct fio_file *);
707 * This is a pretty crappy semaphore implementation, but with the use that fio
708 * has (just signalling start/go conditions), it doesn't have to be better.
709 * Naturally this would not work for any type of contended semaphore or
712 static inline void fio_sem_init(volatile int *sem, int val)
717 static inline void fio_sem_down(volatile int *sem)
725 static inline void fio_sem_up(volatile int *sem)
731 * If logging output to a file, stderr should go to both stderr and f_err
733 #define log_err(args...) do { \
734 fprintf(f_err, ##args); \
735 if (f_err != stderr) \
736 fprintf(stderr, ##args); \
739 FILE *get_f_out(void);
740 FILE *get_f_err(void);
742 struct ioengine_ops {
743 struct list_head list;
747 int (*setup)(struct thread_data *);
748 int (*init)(struct thread_data *);
749 int (*prep)(struct thread_data *, struct io_u *);
750 int (*queue)(struct thread_data *, struct io_u *);
751 int (*commit)(struct thread_data *);
752 int (*getevents)(struct thread_data *, int, int, struct timespec *);
753 struct io_u *(*event)(struct thread_data *, int);
754 int (*cancel)(struct thread_data *, struct io_u *);
755 void (*cleanup)(struct thread_data *);
756 int (*open_file)(struct thread_data *, struct fio_file *);
757 void (*close_file)(struct thread_data *, struct fio_file *);
762 #define FIO_IOOPS_VERSION 6
764 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
765 extern void register_ioengine(struct ioengine_ops *);
766 extern void unregister_ioengine(struct ioengine_ops *);
767 extern void close_ioengine(struct thread_data *);
770 * Mark unused variables passed to ops functions as unused, to silence gcc
772 #define fio_unused __attribute((__unused__))
773 #define fio_init __attribute__((constructor))
774 #define fio_exit __attribute__((destructor))
776 #define for_each_td(td, i) \
777 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
778 #define for_each_file(td, f, i) \
779 for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->open_files; (i)++, (f)++)
781 #define fio_assert(td, cond) do { \
784 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
785 (td)->runstate = TD_EXITED; \
786 (td)->error = EFAULT; \