8 #include <sys/resource.h>
18 #include "compiler/compiler.h"
22 #include "arch/arch.h"
38 TD_DDIR_READ = 1 << 0,
39 TD_DDIR_WRITE = 1 << 1,
40 TD_DDIR_RAND = 1 << 2,
41 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
42 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
43 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
44 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
48 * Use for maintaining statistics
51 unsigned long max_val;
52 unsigned long min_val;
53 unsigned long samples;
60 * A single data sample
69 * Dynamically growing data sample log
72 unsigned long nr_samples;
73 unsigned long max_samples;
74 struct io_sample *log;
78 * When logging io actions, this matches a single sent io_u
82 struct rb_node rb_node;
83 struct list_head list;
87 struct fio_file *file;
89 unsigned long long offset;
94 unsigned int file_action;
100 IO_U_F_FLIGHT = 1 << 1,
110 #ifdef FIO_HAVE_LIBAIO
113 #ifdef FIO_HAVE_POSIXAIO
117 struct sg_io_hdr hdr;
119 #ifdef FIO_HAVE_GUASI
123 struct timeval start_time;
124 struct timeval issue_time;
127 * Allocated/set buffer and length
130 unsigned long buflen;
131 unsigned long long offset;
132 unsigned long long endpos;
135 * IO engine state, may be different from above when we get
136 * partial transfers / residual data counts
139 unsigned long xfer_buflen;
147 * io engine private data
156 struct fio_file *file;
158 struct list_head list;
161 * Callback for io completion
163 int (*end_io)(struct thread_data *, struct io_u *);
167 * io_ops->queue() return values
170 FIO_Q_COMPLETED = 0, /* completed sync */
171 FIO_Q_QUEUED = 1, /* queued, will complete async */
172 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
175 #define FIO_HDR_MAGIC 0xf00baaef
178 VERIFY_NONE = 0, /* no verification */
179 VERIFY_MD5, /* md5 sum data blocks */
180 VERIFY_CRC64, /* crc64 sum data blocks */
181 VERIFY_CRC32, /* crc32 sum data blocks */
182 VERIFY_CRC16, /* crc16 sum data blocks */
183 VERIFY_CRC7, /* crc7 sum data blocks */
184 VERIFY_SHA256, /* sha256 sum data blocks */
185 VERIFY_SHA512, /* sha512 sum data blocks */
186 VERIFY_META, /* block_num, timestamp etc. */
187 VERIFY_PATTERN, /* verify a specific pattern */
188 VERIFY_NULL, /* pretend to verify */
192 * A header structure associated with each checksummed data block. It is
193 * followed by a checksum specific header that contains the verification
196 struct verify_header {
197 unsigned int fio_magic;
199 unsigned int verify_type;
203 uint32_t md5_digest[16];
225 unsigned char thread;
226 unsigned short numberio;
227 unsigned long time_sec;
228 unsigned long time_usec;
231 struct group_run_stats {
232 unsigned long long max_run[2], min_run[2];
233 unsigned long long max_bw[2], min_bw[2];
234 unsigned long long io_kb[2];
235 unsigned long long agg[2];
239 * What type of allocation to use for io buffers
242 MEM_MALLOC = 0, /* ordinary malloc */
243 MEM_SHM, /* use shared memory segments */
244 MEM_SHMHUGE, /* use shared memory segments with huge pages */
245 MEM_MMAP, /* use anonynomous mmap */
246 MEM_MMAPHUGE, /* memory mapped huge file */
250 * The type of object we are working on
253 FIO_TYPE_FILE = 1, /* plain file */
254 FIO_TYPE_BD, /* block device */
255 FIO_TYPE_CHAR, /* character device */
256 FIO_TYPE_PIPE, /* pipe */
259 enum fio_ioengine_flags {
260 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
261 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
262 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
263 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
264 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
265 FIO_UNIDIR = 1 << 5, /* engine is uni-directional */
266 FIO_NOIO = 1 << 6, /* thread does only pseudo IO */
269 enum fio_file_flags {
270 FIO_FILE_OPEN = 1 << 0, /* file is open */
271 FIO_FILE_CLOSING = 1 << 1, /* file being closed */
272 FIO_FILE_EXISTS = 1 << 2, /* file there */
273 FIO_FILE_EXTEND = 1 << 3, /* needs extend */
274 FIO_FILE_NOSORT = 1 << 4, /* don't sort verify blocks */
275 FIO_FILE_DONE = 1 << 5, /* io completed to this file */
276 FIO_SIZE_KNOWN = 1 << 6, /* size has been set */
280 * Each thread_data structure has a number of files associated with it,
281 * this structure holds state information for a single file.
284 enum fio_filetype filetype;
287 * A file may not be a file descriptor, let the io engine decide
290 unsigned long file_data;
295 * filename and possible memory mapping
299 unsigned int major, minor;
302 * size of the file, offset into file, and io size from that offset
304 unsigned long long real_file_size;
305 unsigned long long file_offset;
306 unsigned long long io_size;
308 unsigned long long last_pos;
309 unsigned long long last_completed_pos;
312 * block map for random io
314 unsigned long *file_map;
315 unsigned int num_maps;
316 unsigned int last_free_lookup;
319 enum fio_file_flags flags;
323 * How many depth levels to log
325 #define FIO_IO_U_MAP_NR 8
326 #define FIO_IO_U_LAT_U_NR 10
327 #define FIO_IO_U_LAT_M_NR 12
338 struct io_log *slat_log;
339 struct io_log *clat_log;
340 struct io_log *bw_log;
343 * bandwidth and latency stats
345 struct io_stat clat_stat[2]; /* completion latency */
346 struct io_stat slat_stat[2]; /* submission latency */
347 struct io_stat bw_stat[2]; /* bandwidth stats */
349 unsigned long long stat_io_bytes[2];
350 struct timeval stat_sample_time[2];
353 * fio system usage accounting
355 struct rusage ru_start;
356 struct rusage ru_end;
357 unsigned long usr_time;
358 unsigned long sys_time;
360 unsigned long minf, majf;
363 * IO depth and latency stats
365 unsigned int io_u_map[FIO_IO_U_MAP_NR];
366 unsigned int io_u_lat_u[FIO_IO_U_LAT_U_NR];
367 unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
368 unsigned long total_io_u[2];
369 unsigned long short_io_u[2];
371 unsigned long long io_bytes[2];
372 unsigned long runtime[2];
373 unsigned long total_run_time;
376 struct thread_options {
384 enum td_ddir td_ddir;
385 unsigned int ddir_nr;
386 unsigned int iodepth;
387 unsigned int iodepth_low;
388 unsigned int iodepth_batch;
390 unsigned long long size;
391 unsigned long long file_size_low;
392 unsigned long long file_size_high;
393 unsigned long long start_offset;
396 unsigned int min_bs[2];
397 unsigned int max_bs[2];
399 unsigned int nr_files;
400 unsigned int open_files;
402 unsigned int odirect;
403 unsigned int invalidate_cache;
404 unsigned int create_serialize;
405 unsigned int create_fsync;
406 unsigned int end_fsync;
407 unsigned int sync_io;
409 unsigned int do_verify;
410 unsigned int verifysort;
411 unsigned int verify_interval;
412 unsigned int verify_offset;
413 unsigned int verify_pattern;
414 unsigned int verify_pattern_bytes;
415 unsigned int verify_fatal;
416 unsigned int use_thread;
418 unsigned int do_disk_util;
419 unsigned int override_sync;
420 unsigned int rand_repeatable;
421 unsigned int write_lat_log;
422 unsigned int write_bw_log;
423 unsigned int norandommap;
424 unsigned int bs_unaligned;
425 unsigned int fsync_on_close;
427 unsigned int hugepage_size;
428 unsigned int rw_min_bs;
429 unsigned int thinktime;
430 unsigned int thinktime_spin;
431 unsigned int thinktime_blocks;
432 unsigned int fsync_blocks;
433 unsigned int start_delay;
434 unsigned long long timeout;
435 unsigned int overwrite;
436 unsigned int bw_avg_time;
438 unsigned long long zone_size;
439 unsigned long long zone_skip;
440 enum fio_memtype mem_type;
442 unsigned int stonewall;
443 unsigned int new_group;
444 unsigned int numjobs;
445 os_cpu_mask_t cpumask;
446 unsigned int cpumask_set;
448 unsigned int rwmixcycle;
449 unsigned int rwmix[2];
451 unsigned int file_service_type;
452 unsigned int group_reporting;
453 unsigned int fadvise_hint;
454 unsigned int zero_buffers;
455 unsigned int time_based;
457 char *read_iolog_file;
458 char *write_iolog_file;
461 * Pre-run and post-run shell
467 unsigned int ratemin;
468 unsigned int ratecycle;
469 unsigned int rate_iops;
470 unsigned int rate_iops_min;
475 * CPU "io" cycle burner
477 unsigned int cpuload;
478 unsigned int cpucycle;
481 #define FIO_VERROR_SIZE 128
484 * This describes a single thread/process executing a fio job.
487 struct thread_options o;
488 char verror[FIO_VERROR_SIZE];
492 struct thread_stat ts;
493 struct fio_file *files;
494 unsigned int files_index;
495 unsigned int nr_open_files;
496 unsigned int nr_done_files;
497 unsigned int nr_normal_files;
499 unsigned int next_file;
500 os_random_state_t next_file_state;
506 size_t orig_buffer_size;
507 volatile int terminate;
508 volatile int runstate;
510 unsigned int ioprio_set;
511 unsigned int last_was_sync;
521 os_random_state_t bsrange_state;
522 os_random_state_t verify_state;
527 * IO engine hooks, contains everything needed to submit an io_u
528 * to any of the available IO engines.
530 struct ioengine_ops *io_ops;
533 * Current IO depth and list of free and busy io_u's.
535 unsigned int cur_depth;
536 struct list_head io_u_freelist;
537 struct list_head io_u_busylist;
538 struct list_head io_u_requeues;
539 unsigned int io_u_queued;
544 unsigned long rate_usec_cycle;
545 long rate_pending_usleep;
546 unsigned long rate_bytes;
547 unsigned long rate_blocks;
548 struct timeval lastrate;
550 unsigned long long total_io_size;
552 unsigned long io_issues[2];
553 unsigned long long io_blocks[2];
554 unsigned long long io_bytes[2];
555 unsigned long long io_skip_bytes;
556 unsigned long long this_io_bytes[2];
557 unsigned long long zone_bytes;
558 struct fio_sem *mutex;
561 * State for random io, a bitmap of blocks done vs not done
563 os_random_state_t random_state;
565 struct timeval start; /* start of this loop */
566 struct timeval epoch; /* time job was started */
567 struct timeval rw_end[2];
568 struct timeval last_issue;
569 unsigned int rw_end_set[2];
572 * read/write mixed workload state
574 os_random_state_t rwmix_state;
575 unsigned long long rwmix_bytes;
576 struct timeval rwmix_switch;
577 enum fio_ddir rwmix_ddir;
578 unsigned int ddir_nr;
581 * IO history logs for verification. We use a tree for sorting,
582 * if we are overwriting. Otherwise just use a fifo.
584 struct rb_root io_hist_tree;
585 struct list_head io_hist_list;
590 struct list_head io_log_list;
595 struct timeval timeout_end;
596 struct itimerval timer;
599 * for fileservice, how often to switch to a new file
601 unsigned int file_service_nr;
602 unsigned int file_service_left;
603 struct fio_file *file_service_file;
606 * For generating file sizes
608 os_random_state_t file_size_state;
612 * roundrobin available files, or choose one at random.
615 FIO_FSERVICE_RANDOM = 1,
620 * when should interactive ETA output be generated
629 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
630 * the timer on each queue operation.
632 #define IO_U_TIMEOUT_INC 5
633 #define IO_U_TIMEOUT 30
635 #define __td_verror(td, err, msg, func) \
641 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
645 #define td_verror(td, err, func) \
646 __td_verror((td), (err), strerror((err)), (func))
647 #define td_vmsg(td, err, msg, func) \
648 __td_verror((td), (err), (msg), (func))
650 extern int exitall_on_terminate;
651 extern int thread_number;
652 extern int nr_process, nr_thread;
655 extern int terse_output;
658 extern int temp_stall_ts;
659 extern unsigned long long mlock_size;
660 extern unsigned long page_mask, page_size;
661 extern int read_only;
662 extern int eta_print;
664 extern struct thread_data *threads;
666 #define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
667 #define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
668 #define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
669 #define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
671 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
673 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
676 #define BLOCKS_PER_MAP (8 * sizeof(long))
677 #define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
678 #define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
679 #define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
681 #define MAX_JOBS (1024)
683 static inline int should_fsync(struct thread_data *td)
685 if (td->last_was_sync)
689 if (td_write(td) || td_rw(td) || td->o.override_sync)
696 * Disk utils as read in /sys/block/<dev>/stat
698 struct disk_util_stat {
701 unsigned long long sectors[2];
704 unsigned time_in_queue;
708 * Per-device disk util management
711 struct list_head list;
718 struct disk_util_stat dus;
719 struct disk_util_stat last_dus;
725 #define DISK_UTIL_MSEC (250)
736 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
737 extern void log_io_u(struct thread_data *, struct io_u *);
738 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
739 extern int __must_check init_iolog(struct thread_data *td);
740 extern void log_io_piece(struct thread_data *, struct io_u *);
741 extern void prune_io_piece_log(struct thread_data *);
742 extern void write_iolog_close(struct thread_data *);
747 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
748 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
749 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
750 extern void show_run_stats(void);
751 extern void init_disk_util(struct thread_data *);
752 extern void update_rusage_stat(struct thread_data *);
753 extern void update_io_ticks(void);
754 extern void disk_util_timer_arm(void);
755 extern void setup_log(struct io_log **);
756 extern void finish_log(struct thread_data *, struct io_log *, const char *);
757 extern void __finish_log(struct io_log *, const char *);
758 extern struct io_log *agg_io_log[2];
759 extern int write_bw_log;
760 extern void add_agg_sample(unsigned long, enum fio_ddir);
765 extern unsigned long long utime_since(struct timeval *, struct timeval *);
766 extern unsigned long long utime_since_now(struct timeval *);
767 extern unsigned long mtime_since(struct timeval *, struct timeval *);
768 extern unsigned long mtime_since_now(struct timeval *);
769 extern unsigned long time_since_now(struct timeval *);
770 extern unsigned long mtime_since_genesis(void);
771 extern void __usec_sleep(unsigned int);
772 extern void usec_sleep(struct thread_data *, unsigned long);
773 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
774 extern void fill_start_time(struct timeval *);
775 extern void fio_gettime(struct timeval *, void *);
776 extern void set_genesis_time(void);
779 * Init/option functions
781 extern int __must_check parse_options(int, char **);
782 extern int fio_option_parse(struct thread_data *, const char *);
783 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
784 extern void fio_fill_default_options(struct thread_data *);
785 extern int fio_show_option_help(const char *);
786 extern void fio_options_dup_and_init(struct option *);
787 extern void options_mem_dupe(struct thread_data *);
788 extern void options_mem_free(struct thread_data *);
789 #define FIO_GETOPT_JOB 0x89988998
790 #define FIO_NR_OPTIONS 128
793 * File setup/shutdown
795 extern void close_files(struct thread_data *);
796 extern int __must_check setup_files(struct thread_data *);
797 extern int __must_check open_files(struct thread_data *);
798 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
799 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
800 extern void generic_close_file(struct thread_data *, struct fio_file *);
801 extern int add_file(struct thread_data *, const char *);
802 extern void get_file(struct fio_file *);
803 extern void put_file(struct thread_data *, struct fio_file *);
804 extern int add_dir_files(struct thread_data *, const char *);
805 extern int init_random_map(struct thread_data *);
806 extern void dup_files(struct thread_data *, struct thread_data *);
807 extern int get_fileno(struct thread_data *, const char *);
808 extern void free_release_files(struct thread_data *);
813 extern void print_thread_status(void);
814 extern void print_status_init(int);
819 #ifdef FIO_HAVE_DISK_UTIL
820 extern void show_disk_util(void);
821 extern void disk_util_timer_arm(void);
822 extern void init_disk_util(struct thread_data *);
823 extern void update_io_ticks(void);
825 #define show_disk_util()
826 #define disk_util_timer_arm()
827 #define init_disk_util(td)
828 #define update_io_ticks()
832 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
833 * will never back again. It may cycle between running/verififying/fsyncing.
834 * Once the thread reaches TD_EXITED, it is just waiting for the core to
851 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
852 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
853 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
858 extern int __must_check fio_pin_memory(void);
859 extern void fio_unpin_memory(void);
860 extern int __must_check allocate_io_mem(struct thread_data *);
861 extern void free_io_mem(struct thread_data *);
866 #define queue_full(td) list_empty(&(td)->io_u_freelist)
867 extern struct io_u *__get_io_u(struct thread_data *);
868 extern struct io_u *get_io_u(struct thread_data *);
869 extern void put_io_u(struct thread_data *, struct io_u *);
870 extern void requeue_io_u(struct thread_data *, struct io_u **);
871 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
872 extern long __must_check io_u_queued_complete(struct thread_data *, int);
873 extern void io_u_queued(struct thread_data *, struct io_u *);
874 extern void io_u_log_error(struct thread_data *, struct io_u *);
875 extern void io_u_init_timeout(void);
876 extern void io_u_set_timeout(struct thread_data *);
877 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
880 * io engine entry points
882 extern int __must_check td_io_init(struct thread_data *);
883 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
884 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
885 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
886 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
887 extern int __must_check td_io_commit(struct thread_data *);
888 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
889 extern void td_io_close_file(struct thread_data *, struct fio_file *);
894 #ifdef FIO_HAVE_BLKTRACE
895 extern int is_blktrace(const char *);
896 extern int load_blktrace(struct thread_data *, const char *);
900 * If logging output to a file, stderr should go to both stderr and f_err
902 #define log_err(args...) do { \
903 fprintf(f_err, ##args); \
904 if (f_err != stderr) \
905 fprintf(stderr, ##args); \
908 #define log_info(args...) fprintf(f_out, ##args)
910 FILE *get_f_out(void);
911 FILE *get_f_err(void);
913 struct ioengine_ops {
914 struct list_head list;
918 int (*setup)(struct thread_data *);
919 int (*init)(struct thread_data *);
920 int (*prep)(struct thread_data *, struct io_u *);
921 int (*queue)(struct thread_data *, struct io_u *);
922 int (*commit)(struct thread_data *);
923 int (*getevents)(struct thread_data *, int, int, struct timespec *);
924 struct io_u *(*event)(struct thread_data *, int);
925 int (*cancel)(struct thread_data *, struct io_u *);
926 void (*cleanup)(struct thread_data *);
927 int (*open_file)(struct thread_data *, struct fio_file *);
928 void (*close_file)(struct thread_data *, struct fio_file *);
933 #define FIO_IOOPS_VERSION 7
935 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
936 extern void register_ioengine(struct ioengine_ops *);
937 extern void unregister_ioengine(struct ioengine_ops *);
938 extern void close_ioengine(struct thread_data *);
941 * Mark unused variables passed to ops functions as unused, to silence gcc
943 #define fio_unused __attribute((__unused__))
944 #define fio_init __attribute__((constructor))
945 #define fio_exit __attribute__((destructor))
947 #define for_each_td(td, i) \
948 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
949 #define for_each_file(td, f, i) \
950 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
952 #define fio_assert(td, cond) do { \
955 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
956 (td)->runstate = TD_EXITED; \
957 (td)->error = EFAULT; \
962 static inline void clear_error(struct thread_data *td)
965 td->verror[0] = '\0';