8 #include <sys/resource.h>
24 #ifdef FIO_HAVE_SYSLET
39 TD_DDIR_READ = 1 << 0,
40 TD_DDIR_WRITE = 1 << 1,
41 TD_DDIR_RAND = 1 << 2,
42 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
43 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
44 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
45 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
49 * Use for maintaining statistics
52 unsigned long max_val;
53 unsigned long min_val;
54 unsigned long samples;
61 * A single data sample
70 * Dynamically growing data sample log
73 unsigned long nr_samples;
74 unsigned long max_samples;
75 struct io_sample *log;
79 * When logging io actions, this matches a single sent io_u
83 struct rb_node rb_node;
84 struct list_head list;
86 struct fio_file *file;
87 unsigned long long offset;
92 #ifdef FIO_HAVE_SYSLET
94 struct syslet_uatom atom; /* the atom to submit */
95 struct syslet_uatom *head; /* head of the sequence */
96 long ret; /* syscall return value */
101 IO_U_F_FREE = 1 << 0,
102 IO_U_F_FLIGHT = 1 << 1,
112 #ifdef FIO_HAVE_LIBAIO
115 #ifdef FIO_HAVE_POSIXAIO
119 struct sg_io_hdr hdr;
121 #ifdef FIO_HAVE_SYSLET
122 struct syslet_req req;
124 #ifdef FIO_HAVE_GUASI
128 struct timeval start_time;
129 struct timeval issue_time;
132 * Allocated/set buffer and length
135 unsigned long buflen;
136 unsigned long long offset;
139 * IO engine state, may be different from above when we get
140 * partial transfers / residual data counts
143 unsigned long xfer_buflen;
151 * io engine private data
160 struct fio_file *file;
162 struct list_head list;
165 * Callback for io completion
167 int (*end_io)(struct thread_data *, struct io_u *);
171 * io_ops->queue() return values
174 FIO_Q_COMPLETED = 0, /* completed sync */
175 FIO_Q_QUEUED = 1, /* queued, will complete async */
176 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
179 #define FIO_HDR_MAGIC 0xf00baaef
182 VERIFY_NONE = 0, /* no verification */
183 VERIFY_MD5, /* md5 sum data blocks */
184 VERIFY_CRC32, /* crc32 sum data blocks */
185 VERIFY_NULL, /* pretend to verify */
189 * A header structure associated with each checksummed data block
191 struct verify_header {
192 unsigned int fio_magic;
194 unsigned int verify_type;
196 char md5_digest[MD5_HASH_WORDS * 4];
201 struct group_run_stats {
202 unsigned long long max_run[2], min_run[2];
203 unsigned long long max_bw[2], min_bw[2];
204 unsigned long long io_kb[2];
205 unsigned long long agg[2];
209 * What type of allocation to use for io buffers
212 MEM_MALLOC = 0, /* ordinary malloc */
213 MEM_SHM, /* use shared memory segments */
214 MEM_SHMHUGE, /* use shared memory segments with huge pages */
215 MEM_MMAP, /* use anonynomous mmap */
216 MEM_MMAPHUGE, /* memory mapped huge file */
220 * The type of object we are working on
223 FIO_TYPE_FILE = 1, /* plain file */
224 FIO_TYPE_BD, /* block device */
225 FIO_TYPE_CHAR, /* character device */
228 enum fio_ioengine_flags {
229 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
230 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
231 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
232 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
233 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
236 enum fio_file_flags {
237 FIO_FILE_OPEN = 1 << 0, /* file is open */
238 FIO_FILE_UNLINK = 1 << 1, /* unlink on close */
239 FIO_FILE_CLOSING = 1 << 2, /* file being closed */
240 FIO_FILE_EXISTS = 1 << 3, /* file there */
241 FIO_FILE_EXTEND = 1 << 4, /* needs extend */
242 FIO_FILE_NOSORT = 1 << 5, /* don't sort verify blocks */
246 * Each thread_data structure has a number of files associated with it,
247 * this structure holds state information for a single file.
250 enum fio_filetype filetype;
253 * A file may not be a file descriptor, let the io engine decide
256 unsigned long file_data;
261 * filename and possible memory mapping
267 * size of the file, offset into file, and io size from that offset
269 unsigned long long real_file_size;
270 unsigned long long file_offset;
271 unsigned long long io_size;
273 unsigned long long last_pos;
274 unsigned long long last_completed_pos;
277 * block map for random io
279 unsigned long *file_map;
280 unsigned int num_maps;
281 unsigned int last_free_lookup;
284 enum fio_file_flags flags;
288 * How many depth levels to log
290 #define FIO_IO_U_MAP_NR 8
291 #define FIO_IO_U_LAT_NR 12
302 struct io_log *slat_log;
303 struct io_log *clat_log;
304 struct io_log *bw_log;
307 * bandwidth and latency stats
309 struct io_stat clat_stat[2]; /* completion latency */
310 struct io_stat slat_stat[2]; /* submission latency */
311 struct io_stat bw_stat[2]; /* bandwidth stats */
313 unsigned long long stat_io_bytes[2];
314 struct timeval stat_sample_time[2];
317 * fio system usage accounting
319 struct rusage ru_start;
320 struct rusage ru_end;
321 unsigned long usr_time;
322 unsigned long sys_time;
326 * IO depth and latency stats
328 unsigned int io_u_map[FIO_IO_U_MAP_NR];
329 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
330 unsigned long total_io_u[2];
332 unsigned long long io_bytes[2];
333 unsigned long runtime[2];
334 unsigned long total_run_time;
337 struct thread_options {
345 enum td_ddir td_ddir;
346 unsigned int ddir_nr;
347 unsigned int iodepth;
348 unsigned int iodepth_low;
349 unsigned int iodepth_batch;
351 unsigned long long size;
352 unsigned long long file_size_low;
353 unsigned long long file_size_high;
354 unsigned long long start_offset;
357 unsigned int min_bs[2];
358 unsigned int max_bs[2];
360 unsigned int nr_files;
361 unsigned int open_files;
363 unsigned int odirect;
364 unsigned int invalidate_cache;
365 unsigned int create_serialize;
366 unsigned int create_fsync;
367 unsigned int end_fsync;
368 unsigned int sync_io;
370 unsigned int verifysort;
371 unsigned int use_thread;
373 unsigned int do_disk_util;
374 unsigned int override_sync;
375 unsigned int rand_repeatable;
376 unsigned int write_lat_log;
377 unsigned int write_bw_log;
378 unsigned int norandommap;
379 unsigned int bs_unaligned;
380 unsigned int fsync_on_close;
382 unsigned int hugepage_size;
383 unsigned int rw_min_bs;
384 unsigned int thinktime;
385 unsigned int thinktime_spin;
386 unsigned int thinktime_blocks;
387 unsigned int fsync_blocks;
388 unsigned int start_delay;
389 unsigned long timeout;
390 unsigned int overwrite;
391 unsigned int bw_avg_time;
393 unsigned long long zone_size;
394 unsigned long long zone_skip;
395 enum fio_memtype mem_type;
397 unsigned int stonewall;
398 unsigned int new_group;
399 unsigned int numjobs;
400 os_cpu_mask_t cpumask;
402 unsigned int read_iolog;
403 unsigned int rwmixcycle;
404 unsigned int rwmix[2];
406 unsigned int file_service_type;
407 unsigned int group_reporting;
408 unsigned int fadvise_hint;
410 char *read_iolog_file;
411 char *write_iolog_file;
414 * Pre-run and post-run shell
420 unsigned int ratemin;
421 unsigned int ratecycle;
422 unsigned int rate_iops;
423 unsigned int rate_iops_min;
428 * CPU "io" cycle burner
430 unsigned int cpuload;
431 unsigned int cpucycle;
434 #define FIO_VERROR_SIZE 128
437 * This describes a single thread/process executing a fio job.
440 struct thread_options o;
441 char verror[FIO_VERROR_SIZE];
445 struct thread_stat ts;
446 struct fio_file *files;
447 unsigned int files_index;
448 unsigned int nr_open_files;
449 unsigned int nr_normal_files;
451 unsigned int next_file;
452 os_random_state_t next_file_state;
457 size_t orig_buffer_size;
458 volatile int terminate;
459 volatile int runstate;
461 unsigned int last_was_sync;
471 os_random_state_t bsrange_state;
472 os_random_state_t verify_state;
477 * IO engine hooks, contains everything needed to submit an io_u
478 * to any of the available IO engines.
480 struct ioengine_ops *io_ops;
483 * Current IO depth and list of free and busy io_u's.
485 unsigned int cur_depth;
486 struct list_head io_u_freelist;
487 struct list_head io_u_busylist;
488 struct list_head io_u_requeues;
489 unsigned int io_u_queued;
494 unsigned long rate_usec_cycle;
495 long rate_pending_usleep;
496 unsigned long rate_bytes;
497 unsigned long rate_blocks;
498 struct timeval lastrate;
500 unsigned long long total_io_size;
502 unsigned long io_issues[2];
503 unsigned long long io_blocks[2];
504 unsigned long long io_bytes[2];
505 unsigned long long this_io_bytes[2];
506 unsigned long long zone_bytes;
507 struct fio_sem *mutex;
510 * State for random io, a bitmap of blocks done vs not done
512 os_random_state_t random_state;
514 struct timeval start; /* start of this loop */
515 struct timeval epoch; /* time job was started */
516 struct timeval rw_end[2];
517 unsigned int rw_end_set[2];
520 * read/write mixed workload state
522 os_random_state_t rwmix_state;
523 unsigned long long rwmix_bytes;
524 struct timeval rwmix_switch;
525 enum fio_ddir rwmix_ddir;
526 unsigned int ddir_nr;
529 * IO history logs for verification. We use a tree for sorting,
530 * if we are overwriting. Otherwise just use a fifo.
532 struct rb_root io_hist_tree;
533 struct list_head io_hist_list;
538 struct list_head io_log_list;
543 struct timeval timeout_end;
544 struct itimerval timer;
547 * for fileservice, how often to switch to a new file
549 unsigned int file_service_nr;
550 unsigned int file_service_left;
551 struct fio_file *file_service_file;
554 * For generating file sizes
556 os_random_state_t file_size_state;
560 * roundrobin available files, or choose one at random.
563 FIO_FSERVICE_RANDOM = 1,
568 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
569 * the timer on each queue operation.
571 #define IO_U_TIMEOUT_INC 5
572 #define IO_U_TIMEOUT 30
574 #define __td_verror(td, err, msg, func) \
580 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
584 #define td_verror(td, err, func) \
585 __td_verror((td), (err), strerror((err)), (func))
586 #define td_vmsg(td, err, msg, func) \
587 __td_verror((td), (err), (msg), (func))
589 extern int exitall_on_terminate;
590 extern int thread_number;
591 extern int nr_process, nr_thread;
594 extern int terse_output;
597 extern int temp_stall_ts;
598 extern unsigned long long mlock_size;
599 extern unsigned long page_mask, page_size;
601 extern struct thread_data *threads;
603 #define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
604 #define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
605 #define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
606 #define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
608 #define BLOCKS_PER_MAP (8 * sizeof(long))
609 #define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
610 #define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
611 #define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
613 #define MAX_JOBS (1024)
615 static inline int should_fsync(struct thread_data *td)
617 if (td->last_was_sync)
621 if (td_write(td) || td_rw(td) || td->o.override_sync)
628 * Disk utils as read in /sys/block/<dev>/stat
630 struct disk_util_stat {
633 unsigned long long sectors[2];
636 unsigned time_in_queue;
640 * Per-device disk util management
643 struct list_head list;
649 struct disk_util_stat dus;
650 struct disk_util_stat last_dus;
656 #define DISK_UTIL_MSEC (250)
659 #define min(a, b) ((a) < (b) ? (a) : (b))
662 #define max(a, b) ((a) > (b) ? (a) : (b))
668 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
669 extern void write_iolog_put(struct thread_data *, struct io_u *);
670 extern int __must_check init_iolog(struct thread_data *td);
671 extern void log_io_piece(struct thread_data *, struct io_u *);
672 extern void prune_io_piece_log(struct thread_data *);
673 extern void write_iolog_close(struct thread_data *);
678 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
679 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
680 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
681 extern void show_run_stats(void);
682 extern void init_disk_util(struct thread_data *);
683 extern void update_rusage_stat(struct thread_data *);
684 extern void update_io_ticks(void);
685 extern void disk_util_timer_arm(void);
686 extern void setup_log(struct io_log **);
687 extern void finish_log(struct thread_data *, struct io_log *, const char *);
688 extern void __finish_log(struct io_log *, const char *);
689 extern struct io_log *agg_io_log[2];
690 extern int write_bw_log;
691 extern void add_agg_sample(unsigned long, enum fio_ddir);
696 extern unsigned long utime_since(struct timeval *, struct timeval *);
697 extern unsigned long utime_since_now(struct timeval *);
698 extern unsigned long mtime_since(struct timeval *, struct timeval *);
699 extern unsigned long mtime_since_now(struct timeval *);
700 extern unsigned long time_since_now(struct timeval *);
701 extern unsigned long mtime_since_genesis(void);
702 extern void __usec_sleep(unsigned int);
703 extern void usec_sleep(struct thread_data *, unsigned long);
704 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
705 extern void fill_start_time(struct timeval *);
706 extern void fio_gettime(struct timeval *, void *);
707 extern void set_genesis_time(void);
710 * Init/option functions
712 extern int __must_check parse_options(int, char **);
713 extern int fio_option_parse(struct thread_data *, const char *);
714 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
715 extern void fio_fill_default_options(struct thread_data *);
716 extern int fio_show_option_help(const char *);
717 extern void fio_options_dup_and_init(struct option *);
718 extern void options_mem_dupe(struct thread_data *);
719 extern void options_mem_free(struct thread_data *);
720 #define FIO_GETOPT_JOB 0x89988998
721 #define FIO_NR_OPTIONS 128
724 * File setup/shutdown
726 extern void close_files(struct thread_data *);
727 extern int __must_check setup_files(struct thread_data *);
728 extern int __must_check open_files(struct thread_data *);
729 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
730 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
731 extern void generic_close_file(struct thread_data *, struct fio_file *);
732 extern void add_file(struct thread_data *, const char *);
733 extern void get_file(struct fio_file *);
734 extern void put_file(struct thread_data *, struct fio_file *);
735 extern int add_dir_files(struct thread_data *, const char *);
736 extern int init_random_map(struct thread_data *);
737 extern void dup_files(struct thread_data *, struct thread_data *);
742 extern void print_thread_status(void);
743 extern void print_status_init(int);
746 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
747 * will never back again. It may cycle between running/verififying/fsyncing.
748 * Once the thread reaches TD_EXITED, it is just waiting for the core to
765 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
766 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
767 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
772 extern int __must_check fio_pin_memory(void);
773 extern void fio_unpin_memory(void);
774 extern int __must_check allocate_io_mem(struct thread_data *);
775 extern void free_io_mem(struct thread_data *);
780 #define queue_full(td) list_empty(&(td)->io_u_freelist)
781 extern struct io_u *__get_io_u(struct thread_data *);
782 extern struct io_u *get_io_u(struct thread_data *);
783 extern void put_io_u(struct thread_data *, struct io_u *);
784 extern void requeue_io_u(struct thread_data *, struct io_u **);
785 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
786 extern long __must_check io_u_queued_complete(struct thread_data *, int);
787 extern void io_u_queued(struct thread_data *, struct io_u *);
788 extern void io_u_log_error(struct thread_data *, struct io_u *);
789 extern void io_u_init_timeout(void);
790 extern void io_u_set_timeout(struct thread_data *);
791 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
794 * io engine entry points
796 extern int __must_check td_io_init(struct thread_data *);
797 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
798 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
799 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
800 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
801 extern int __must_check td_io_commit(struct thread_data *);
802 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
803 extern void td_io_close_file(struct thread_data *, struct fio_file *);
806 * If logging output to a file, stderr should go to both stderr and f_err
808 #define log_err(args...) do { \
809 fprintf(f_err, ##args); \
810 if (f_err != stderr) \
811 fprintf(stderr, ##args); \
814 #define log_info(args...) fprintf(f_out, ##args)
816 FILE *get_f_out(void);
817 FILE *get_f_err(void);
819 struct ioengine_ops {
820 struct list_head list;
824 int (*setup)(struct thread_data *);
825 int (*init)(struct thread_data *);
826 int (*prep)(struct thread_data *, struct io_u *);
827 int (*queue)(struct thread_data *, struct io_u *);
828 int (*commit)(struct thread_data *);
829 int (*getevents)(struct thread_data *, int, int, struct timespec *);
830 struct io_u *(*event)(struct thread_data *, int);
831 int (*cancel)(struct thread_data *, struct io_u *);
832 void (*cleanup)(struct thread_data *);
833 int (*open_file)(struct thread_data *, struct fio_file *);
834 void (*close_file)(struct thread_data *, struct fio_file *);
839 #define FIO_IOOPS_VERSION 7
841 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
842 extern void register_ioengine(struct ioengine_ops *);
843 extern void unregister_ioengine(struct ioengine_ops *);
844 extern void close_ioengine(struct thread_data *);
847 * Mark unused variables passed to ops functions as unused, to silence gcc
849 #define fio_unused __attribute((__unused__))
850 #define fio_init __attribute__((constructor))
851 #define fio_exit __attribute__((destructor))
853 #define for_each_td(td, i) \
854 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
855 #define for_each_file(td, f, i) \
856 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
858 #define fio_assert(td, cond) do { \
861 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
862 (td)->runstate = TD_EXITED; \
863 (td)->error = EFAULT; \
868 static inline void clear_error(struct thread_data *td)
871 td->verror[0] = '\0';