8 #include <sys/resource.h>
16 #include "compiler/compiler.h"
22 #include "arch/arch.h"
26 #ifdef FIO_HAVE_SYSLET
42 TD_DDIR_READ = 1 << 0,
43 TD_DDIR_WRITE = 1 << 1,
44 TD_DDIR_RAND = 1 << 2,
45 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
46 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
47 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
48 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
52 * Use for maintaining statistics
55 unsigned long max_val;
56 unsigned long min_val;
57 unsigned long samples;
64 * A single data sample
73 * Dynamically growing data sample log
76 unsigned long nr_samples;
77 unsigned long max_samples;
78 struct io_sample *log;
82 * When logging io actions, this matches a single sent io_u
86 struct rb_node rb_node;
87 struct list_head list;
91 struct fio_file *file;
93 unsigned long long offset;
98 unsigned int file_action;
102 #ifdef FIO_HAVE_SYSLET
104 struct syslet_uatom atom; /* the atom to submit */
105 struct syslet_uatom *head; /* head of the sequence */
106 long ret; /* syscall return value */
111 IO_U_F_FREE = 1 << 0,
112 IO_U_F_FLIGHT = 1 << 1,
122 #ifdef FIO_HAVE_LIBAIO
125 #ifdef FIO_HAVE_POSIXAIO
129 struct sg_io_hdr hdr;
131 #ifdef FIO_HAVE_SYSLET
132 struct syslet_req req;
134 #ifdef FIO_HAVE_GUASI
138 struct timeval start_time;
139 struct timeval issue_time;
142 * Allocated/set buffer and length
145 unsigned long buflen;
146 unsigned long long offset;
147 unsigned long long endpos;
150 * IO engine state, may be different from above when we get
151 * partial transfers / residual data counts
154 unsigned long xfer_buflen;
162 * io engine private data
171 struct fio_file *file;
173 struct list_head list;
176 * Callback for io completion
178 int (*end_io)(struct thread_data *, struct io_u *);
182 * io_ops->queue() return values
185 FIO_Q_COMPLETED = 0, /* completed sync */
186 FIO_Q_QUEUED = 1, /* queued, will complete async */
187 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
190 #define FIO_HDR_MAGIC 0xf00baaef
193 VERIFY_NONE = 0, /* no verification */
194 VERIFY_MD5, /* md5 sum data blocks */
195 VERIFY_CRC32, /* crc32 sum data blocks */
196 VERIFY_NULL, /* pretend to verify */
200 * A header structure associated with each checksummed data block
202 struct verify_header {
203 unsigned int fio_magic;
205 unsigned int verify_type;
207 char md5_digest[MD5_HASH_WORDS * 4];
212 struct group_run_stats {
213 unsigned long long max_run[2], min_run[2];
214 unsigned long long max_bw[2], min_bw[2];
215 unsigned long long io_kb[2];
216 unsigned long long agg[2];
220 * What type of allocation to use for io buffers
223 MEM_MALLOC = 0, /* ordinary malloc */
224 MEM_SHM, /* use shared memory segments */
225 MEM_SHMHUGE, /* use shared memory segments with huge pages */
226 MEM_MMAP, /* use anonynomous mmap */
227 MEM_MMAPHUGE, /* memory mapped huge file */
231 * The type of object we are working on
234 FIO_TYPE_FILE = 1, /* plain file */
235 FIO_TYPE_BD, /* block device */
236 FIO_TYPE_CHAR, /* character device */
237 FIO_TYPE_PIPE, /* pipe */
240 enum fio_ioengine_flags {
241 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
242 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
243 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
244 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
245 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
246 FIO_UNIDIR = 1 << 5, /* engine is uni-directional */
249 enum fio_file_flags {
250 FIO_FILE_OPEN = 1 << 0, /* file is open */
251 FIO_FILE_CLOSING = 1 << 1, /* file being closed */
252 FIO_FILE_EXISTS = 1 << 2, /* file there */
253 FIO_FILE_EXTEND = 1 << 3, /* needs extend */
254 FIO_FILE_NOSORT = 1 << 4, /* don't sort verify blocks */
255 FIO_FILE_DONE = 1 << 5, /* io completed to this file */
256 FIO_SIZE_KNOWN = 1 << 6, /* size has been set */
260 * Each thread_data structure has a number of files associated with it,
261 * this structure holds state information for a single file.
264 enum fio_filetype filetype;
267 * A file may not be a file descriptor, let the io engine decide
270 unsigned long file_data;
275 * filename and possible memory mapping
279 unsigned int major, minor;
282 * size of the file, offset into file, and io size from that offset
284 unsigned long long real_file_size;
285 unsigned long long file_offset;
286 unsigned long long io_size;
288 unsigned long long last_pos;
289 unsigned long long last_completed_pos;
292 * block map for random io
294 unsigned long *file_map;
295 unsigned int num_maps;
296 unsigned int last_free_lookup;
299 enum fio_file_flags flags;
303 * How many depth levels to log
305 #define FIO_IO_U_MAP_NR 8
306 #define FIO_IO_U_LAT_U_NR 10
307 #define FIO_IO_U_LAT_M_NR 12
318 struct io_log *slat_log;
319 struct io_log *clat_log;
320 struct io_log *bw_log;
323 * bandwidth and latency stats
325 struct io_stat clat_stat[2]; /* completion latency */
326 struct io_stat slat_stat[2]; /* submission latency */
327 struct io_stat bw_stat[2]; /* bandwidth stats */
329 unsigned long long stat_io_bytes[2];
330 struct timeval stat_sample_time[2];
333 * fio system usage accounting
335 struct rusage ru_start;
336 struct rusage ru_end;
337 unsigned long usr_time;
338 unsigned long sys_time;
342 * IO depth and latency stats
344 unsigned int io_u_map[FIO_IO_U_MAP_NR];
345 unsigned int io_u_lat_u[FIO_IO_U_LAT_U_NR];
346 unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
347 unsigned long total_io_u[2];
348 unsigned long short_io_u[2];
350 unsigned long long io_bytes[2];
351 unsigned long runtime[2];
352 unsigned long total_run_time;
355 struct thread_options {
363 enum td_ddir td_ddir;
364 unsigned int ddir_nr;
365 unsigned int iodepth;
366 unsigned int iodepth_low;
367 unsigned int iodepth_batch;
369 unsigned long long size;
370 unsigned long long file_size_low;
371 unsigned long long file_size_high;
372 unsigned long long start_offset;
375 unsigned int min_bs[2];
376 unsigned int max_bs[2];
378 unsigned int nr_files;
379 unsigned int open_files;
381 unsigned int odirect;
382 unsigned int invalidate_cache;
383 unsigned int create_serialize;
384 unsigned int create_fsync;
385 unsigned int end_fsync;
386 unsigned int sync_io;
388 unsigned int verifysort;
389 unsigned int use_thread;
391 unsigned int do_disk_util;
392 unsigned int override_sync;
393 unsigned int rand_repeatable;
394 unsigned int write_lat_log;
395 unsigned int write_bw_log;
396 unsigned int norandommap;
397 unsigned int bs_unaligned;
398 unsigned int fsync_on_close;
400 unsigned int hugepage_size;
401 unsigned int rw_min_bs;
402 unsigned int thinktime;
403 unsigned int thinktime_spin;
404 unsigned int thinktime_blocks;
405 unsigned int fsync_blocks;
406 unsigned int start_delay;
407 unsigned long long timeout;
408 unsigned int overwrite;
409 unsigned int bw_avg_time;
411 unsigned long long zone_size;
412 unsigned long long zone_skip;
413 enum fio_memtype mem_type;
415 unsigned int stonewall;
416 unsigned int new_group;
417 unsigned int numjobs;
418 os_cpu_mask_t cpumask;
419 unsigned int cpumask_set;
421 unsigned int rwmixcycle;
422 unsigned int rwmix[2];
424 unsigned int file_service_type;
425 unsigned int group_reporting;
426 unsigned int fadvise_hint;
427 unsigned int zero_buffers;
428 unsigned int time_based;
430 char *read_iolog_file;
431 char *write_iolog_file;
434 * Pre-run and post-run shell
440 unsigned int ratemin;
441 unsigned int ratecycle;
442 unsigned int rate_iops;
443 unsigned int rate_iops_min;
448 * CPU "io" cycle burner
450 unsigned int cpuload;
451 unsigned int cpucycle;
454 #define FIO_VERROR_SIZE 128
457 * This describes a single thread/process executing a fio job.
460 struct thread_options o;
461 char verror[FIO_VERROR_SIZE];
465 struct thread_stat ts;
466 struct fio_file *files;
467 unsigned int files_index;
468 unsigned int nr_open_files;
469 unsigned int nr_done_files;
470 unsigned int nr_normal_files;
472 unsigned int next_file;
473 os_random_state_t next_file_state;
479 size_t orig_buffer_size;
480 volatile int terminate;
481 volatile int runstate;
483 unsigned int last_was_sync;
493 os_random_state_t bsrange_state;
494 os_random_state_t verify_state;
499 * IO engine hooks, contains everything needed to submit an io_u
500 * to any of the available IO engines.
502 struct ioengine_ops *io_ops;
505 * Current IO depth and list of free and busy io_u's.
507 unsigned int cur_depth;
508 struct list_head io_u_freelist;
509 struct list_head io_u_busylist;
510 struct list_head io_u_requeues;
511 unsigned int io_u_queued;
516 unsigned long rate_usec_cycle;
517 long rate_pending_usleep;
518 unsigned long rate_bytes;
519 unsigned long rate_blocks;
520 struct timeval lastrate;
522 unsigned long long total_io_size;
524 unsigned long io_issues[2];
525 unsigned long long io_blocks[2];
526 unsigned long long io_bytes[2];
527 unsigned long long io_skip_bytes;
528 unsigned long long this_io_bytes[2];
529 unsigned long long zone_bytes;
530 struct fio_sem *mutex;
533 * State for random io, a bitmap of blocks done vs not done
535 os_random_state_t random_state;
537 struct timeval start; /* start of this loop */
538 struct timeval epoch; /* time job was started */
539 struct timeval rw_end[2];
540 struct timeval last_issue;
541 unsigned int rw_end_set[2];
544 * read/write mixed workload state
546 os_random_state_t rwmix_state;
547 unsigned long long rwmix_bytes;
548 struct timeval rwmix_switch;
549 enum fio_ddir rwmix_ddir;
550 unsigned int ddir_nr;
553 * IO history logs for verification. We use a tree for sorting,
554 * if we are overwriting. Otherwise just use a fifo.
556 struct rb_root io_hist_tree;
557 struct list_head io_hist_list;
562 struct list_head io_log_list;
567 struct timeval timeout_end;
568 struct itimerval timer;
571 * for fileservice, how often to switch to a new file
573 unsigned int file_service_nr;
574 unsigned int file_service_left;
575 struct fio_file *file_service_file;
578 * For generating file sizes
580 os_random_state_t file_size_state;
584 * roundrobin available files, or choose one at random.
587 FIO_FSERVICE_RANDOM = 1,
592 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
593 * the timer on each queue operation.
595 #define IO_U_TIMEOUT_INC 5
596 #define IO_U_TIMEOUT 30
598 #define __td_verror(td, err, msg, func) \
604 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
608 #define td_verror(td, err, func) \
609 __td_verror((td), (err), strerror((err)), (func))
610 #define td_vmsg(td, err, msg, func) \
611 __td_verror((td), (err), (msg), (func))
613 extern int exitall_on_terminate;
614 extern int thread_number;
615 extern int nr_process, nr_thread;
618 extern int terse_output;
621 extern int temp_stall_ts;
622 extern unsigned long long mlock_size;
623 extern unsigned long page_mask, page_size;
625 extern struct thread_data *threads;
627 #define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
628 #define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
629 #define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
630 #define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
632 #define BLOCKS_PER_MAP (8 * sizeof(long))
633 #define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
634 #define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
635 #define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
637 #define MAX_JOBS (1024)
639 static inline int should_fsync(struct thread_data *td)
641 if (td->last_was_sync)
645 if (td_write(td) || td_rw(td) || td->o.override_sync)
652 * Disk utils as read in /sys/block/<dev>/stat
654 struct disk_util_stat {
657 unsigned long long sectors[2];
660 unsigned time_in_queue;
664 * Per-device disk util management
667 struct list_head list;
674 struct disk_util_stat dus;
675 struct disk_util_stat last_dus;
681 #define DISK_UTIL_MSEC (250)
692 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
693 extern void log_io_u(struct thread_data *, struct io_u *);
694 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
695 extern int __must_check init_iolog(struct thread_data *td);
696 extern void log_io_piece(struct thread_data *, struct io_u *);
697 extern void prune_io_piece_log(struct thread_data *);
698 extern void write_iolog_close(struct thread_data *);
703 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
704 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
705 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
706 extern void show_run_stats(void);
707 extern void init_disk_util(struct thread_data *);
708 extern void update_rusage_stat(struct thread_data *);
709 extern void update_io_ticks(void);
710 extern void disk_util_timer_arm(void);
711 extern void setup_log(struct io_log **);
712 extern void finish_log(struct thread_data *, struct io_log *, const char *);
713 extern void __finish_log(struct io_log *, const char *);
714 extern struct io_log *agg_io_log[2];
715 extern int write_bw_log;
716 extern void add_agg_sample(unsigned long, enum fio_ddir);
721 extern unsigned long utime_since(struct timeval *, struct timeval *);
722 extern unsigned long utime_since_now(struct timeval *);
723 extern unsigned long mtime_since(struct timeval *, struct timeval *);
724 extern unsigned long mtime_since_now(struct timeval *);
725 extern unsigned long time_since_now(struct timeval *);
726 extern unsigned long mtime_since_genesis(void);
727 extern void __usec_sleep(unsigned int);
728 extern void usec_sleep(struct thread_data *, unsigned long);
729 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
730 extern void fill_start_time(struct timeval *);
731 extern void fio_gettime(struct timeval *, void *);
732 extern void set_genesis_time(void);
735 * Init/option functions
737 extern int __must_check parse_options(int, char **);
738 extern int fio_option_parse(struct thread_data *, const char *);
739 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
740 extern void fio_fill_default_options(struct thread_data *);
741 extern int fio_show_option_help(const char *);
742 extern void fio_options_dup_and_init(struct option *);
743 extern void options_mem_dupe(struct thread_data *);
744 extern void options_mem_free(struct thread_data *);
745 #define FIO_GETOPT_JOB 0x89988998
746 #define FIO_NR_OPTIONS 128
749 * File setup/shutdown
751 extern void close_files(struct thread_data *);
752 extern int __must_check setup_files(struct thread_data *);
753 extern int __must_check open_files(struct thread_data *);
754 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
755 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
756 extern void generic_close_file(struct thread_data *, struct fio_file *);
757 extern int add_file(struct thread_data *, const char *);
758 extern void get_file(struct fio_file *);
759 extern void put_file(struct thread_data *, struct fio_file *);
760 extern int add_dir_files(struct thread_data *, const char *);
761 extern int init_random_map(struct thread_data *);
762 extern void dup_files(struct thread_data *, struct thread_data *);
763 extern int get_fileno(struct thread_data *, const char *);
764 extern void free_release_files(struct thread_data *);
769 extern void print_thread_status(void);
770 extern void print_status_init(int);
775 #ifdef FIO_HAVE_DISK_UTIL
776 extern void show_disk_util(void);
777 extern void disk_util_timer_arm(void);
778 extern void init_disk_util(struct thread_data *);
779 extern void update_io_ticks(void);
781 #define show_disk_util()
782 #define disk_util_timer_arm()
783 #define init_disk_util(td)
784 #define update_io_ticks()
788 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
789 * will never back again. It may cycle between running/verififying/fsyncing.
790 * Once the thread reaches TD_EXITED, it is just waiting for the core to
807 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
808 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
809 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
814 extern int __must_check fio_pin_memory(void);
815 extern void fio_unpin_memory(void);
816 extern int __must_check allocate_io_mem(struct thread_data *);
817 extern void free_io_mem(struct thread_data *);
822 #define queue_full(td) list_empty(&(td)->io_u_freelist)
823 extern struct io_u *__get_io_u(struct thread_data *);
824 extern struct io_u *get_io_u(struct thread_data *);
825 extern void put_io_u(struct thread_data *, struct io_u *);
826 extern void requeue_io_u(struct thread_data *, struct io_u **);
827 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
828 extern long __must_check io_u_queued_complete(struct thread_data *, int);
829 extern void io_u_queued(struct thread_data *, struct io_u *);
830 extern void io_u_log_error(struct thread_data *, struct io_u *);
831 extern void io_u_init_timeout(void);
832 extern void io_u_set_timeout(struct thread_data *);
833 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
836 * io engine entry points
838 extern int __must_check td_io_init(struct thread_data *);
839 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
840 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
841 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
842 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
843 extern int __must_check td_io_commit(struct thread_data *);
844 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
845 extern void td_io_close_file(struct thread_data *, struct fio_file *);
850 #ifdef FIO_HAVE_BLKTRACE
851 extern int is_blktrace(const char *);
852 extern int load_blktrace(struct thread_data *, const char *);
856 * If logging output to a file, stderr should go to both stderr and f_err
858 #define log_err(args...) do { \
859 fprintf(f_err, ##args); \
860 if (f_err != stderr) \
861 fprintf(stderr, ##args); \
864 #define log_info(args...) fprintf(f_out, ##args)
866 FILE *get_f_out(void);
867 FILE *get_f_err(void);
869 struct ioengine_ops {
870 struct list_head list;
874 int (*setup)(struct thread_data *);
875 int (*init)(struct thread_data *);
876 int (*prep)(struct thread_data *, struct io_u *);
877 int (*queue)(struct thread_data *, struct io_u *);
878 int (*commit)(struct thread_data *);
879 int (*getevents)(struct thread_data *, int, int, struct timespec *);
880 struct io_u *(*event)(struct thread_data *, int);
881 int (*cancel)(struct thread_data *, struct io_u *);
882 void (*cleanup)(struct thread_data *);
883 int (*open_file)(struct thread_data *, struct fio_file *);
884 void (*close_file)(struct thread_data *, struct fio_file *);
889 #define FIO_IOOPS_VERSION 7
891 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
892 extern void register_ioengine(struct ioengine_ops *);
893 extern void unregister_ioengine(struct ioengine_ops *);
894 extern void close_ioengine(struct thread_data *);
897 * Mark unused variables passed to ops functions as unused, to silence gcc
899 #define fio_unused __attribute((__unused__))
900 #define fio_init __attribute__((constructor))
901 #define fio_exit __attribute__((destructor))
903 #define for_each_td(td, i) \
904 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
905 #define for_each_file(td, f, i) \
906 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
908 #define fio_assert(td, cond) do { \
911 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
912 (td)->runstate = TD_EXITED; \
913 (td)->error = EFAULT; \
918 static inline void clear_error(struct thread_data *td)
921 td->verror[0] = '\0';