8 #include <sys/resource.h>
16 #include "compiler/compiler.h"
21 #include "arch/arch.h"
25 #ifdef FIO_HAVE_SYSLET
40 TD_DDIR_READ = 1 << 0,
41 TD_DDIR_WRITE = 1 << 1,
42 TD_DDIR_RAND = 1 << 2,
43 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
44 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
45 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
46 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
50 * Use for maintaining statistics
53 unsigned long max_val;
54 unsigned long min_val;
55 unsigned long samples;
62 * A single data sample
71 * Dynamically growing data sample log
74 unsigned long nr_samples;
75 unsigned long max_samples;
76 struct io_sample *log;
80 * When logging io actions, this matches a single sent io_u
84 struct rb_node rb_node;
85 struct list_head list;
87 struct fio_file *file;
88 unsigned long long offset;
93 #ifdef FIO_HAVE_SYSLET
95 struct syslet_uatom atom; /* the atom to submit */
96 struct syslet_uatom *head; /* head of the sequence */
97 long ret; /* syscall return value */
102 IO_U_F_FREE = 1 << 0,
103 IO_U_F_FLIGHT = 1 << 1,
113 #ifdef FIO_HAVE_LIBAIO
116 #ifdef FIO_HAVE_POSIXAIO
120 struct sg_io_hdr hdr;
122 #ifdef FIO_HAVE_SYSLET
123 struct syslet_req req;
125 #ifdef FIO_HAVE_GUASI
129 struct timeval start_time;
130 struct timeval issue_time;
133 * Allocated/set buffer and length
136 unsigned long buflen;
137 unsigned long long offset;
138 unsigned long long endpos;
141 * IO engine state, may be different from above when we get
142 * partial transfers / residual data counts
145 unsigned long xfer_buflen;
153 * io engine private data
162 struct fio_file *file;
164 struct list_head list;
167 * Callback for io completion
169 int (*end_io)(struct thread_data *, struct io_u *);
173 * io_ops->queue() return values
176 FIO_Q_COMPLETED = 0, /* completed sync */
177 FIO_Q_QUEUED = 1, /* queued, will complete async */
178 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
181 #define FIO_HDR_MAGIC 0xf00baaef
184 VERIFY_NONE = 0, /* no verification */
185 VERIFY_MD5, /* md5 sum data blocks */
186 VERIFY_CRC32, /* crc32 sum data blocks */
187 VERIFY_NULL, /* pretend to verify */
191 * A header structure associated with each checksummed data block
193 struct verify_header {
194 unsigned int fio_magic;
196 unsigned int verify_type;
198 char md5_digest[MD5_HASH_WORDS * 4];
203 struct group_run_stats {
204 unsigned long long max_run[2], min_run[2];
205 unsigned long long max_bw[2], min_bw[2];
206 unsigned long long io_kb[2];
207 unsigned long long agg[2];
211 * What type of allocation to use for io buffers
214 MEM_MALLOC = 0, /* ordinary malloc */
215 MEM_SHM, /* use shared memory segments */
216 MEM_SHMHUGE, /* use shared memory segments with huge pages */
217 MEM_MMAP, /* use anonynomous mmap */
218 MEM_MMAPHUGE, /* memory mapped huge file */
222 * The type of object we are working on
225 FIO_TYPE_FILE = 1, /* plain file */
226 FIO_TYPE_BD, /* block device */
227 FIO_TYPE_CHAR, /* character device */
228 FIO_TYPE_PIPE, /* pipe */
231 enum fio_ioengine_flags {
232 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
233 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
234 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
235 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
236 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
239 enum fio_file_flags {
240 FIO_FILE_OPEN = 1 << 0, /* file is open */
241 FIO_FILE_CLOSING = 1 << 1, /* file being closed */
242 FIO_FILE_EXISTS = 1 << 2, /* file there */
243 FIO_FILE_EXTEND = 1 << 3, /* needs extend */
244 FIO_FILE_NOSORT = 1 << 4, /* don't sort verify blocks */
245 FIO_FILE_DONE = 1 << 5, /* io completed to this file */
246 FIO_SIZE_KNOWN = 1 << 6, /* size has been set */
250 * Each thread_data structure has a number of files associated with it,
251 * this structure holds state information for a single file.
254 enum fio_filetype filetype;
257 * A file may not be a file descriptor, let the io engine decide
260 unsigned long file_data;
265 * filename and possible memory mapping
271 * size of the file, offset into file, and io size from that offset
273 unsigned long long real_file_size;
274 unsigned long long file_offset;
275 unsigned long long io_size;
277 unsigned long long last_pos;
278 unsigned long long last_completed_pos;
281 * block map for random io
283 unsigned long *file_map;
284 unsigned int num_maps;
285 unsigned int last_free_lookup;
288 enum fio_file_flags flags;
292 * How many depth levels to log
294 #define FIO_IO_U_MAP_NR 8
295 #define FIO_IO_U_LAT_NR 12
306 struct io_log *slat_log;
307 struct io_log *clat_log;
308 struct io_log *bw_log;
311 * bandwidth and latency stats
313 struct io_stat clat_stat[2]; /* completion latency */
314 struct io_stat slat_stat[2]; /* submission latency */
315 struct io_stat bw_stat[2]; /* bandwidth stats */
317 unsigned long long stat_io_bytes[2];
318 struct timeval stat_sample_time[2];
321 * fio system usage accounting
323 struct rusage ru_start;
324 struct rusage ru_end;
325 unsigned long usr_time;
326 unsigned long sys_time;
330 * IO depth and latency stats
332 unsigned int io_u_map[FIO_IO_U_MAP_NR];
333 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
334 unsigned long total_io_u[2];
335 unsigned long short_io_u[2];
337 unsigned long long io_bytes[2];
338 unsigned long runtime[2];
339 unsigned long total_run_time;
342 struct thread_options {
350 enum td_ddir td_ddir;
351 unsigned int ddir_nr;
352 unsigned int iodepth;
353 unsigned int iodepth_low;
354 unsigned int iodepth_batch;
356 unsigned long long size;
357 unsigned long long file_size_low;
358 unsigned long long file_size_high;
359 unsigned long long start_offset;
362 unsigned int min_bs[2];
363 unsigned int max_bs[2];
365 unsigned int nr_files;
366 unsigned int open_files;
368 unsigned int odirect;
369 unsigned int invalidate_cache;
370 unsigned int create_serialize;
371 unsigned int create_fsync;
372 unsigned int end_fsync;
373 unsigned int sync_io;
375 unsigned int verifysort;
376 unsigned int use_thread;
378 unsigned int do_disk_util;
379 unsigned int override_sync;
380 unsigned int rand_repeatable;
381 unsigned int write_lat_log;
382 unsigned int write_bw_log;
383 unsigned int norandommap;
384 unsigned int bs_unaligned;
385 unsigned int fsync_on_close;
387 unsigned int hugepage_size;
388 unsigned int rw_min_bs;
389 unsigned int thinktime;
390 unsigned int thinktime_spin;
391 unsigned int thinktime_blocks;
392 unsigned int fsync_blocks;
393 unsigned int start_delay;
394 unsigned long timeout;
395 unsigned int overwrite;
396 unsigned int bw_avg_time;
398 unsigned long long zone_size;
399 unsigned long long zone_skip;
400 enum fio_memtype mem_type;
402 unsigned int stonewall;
403 unsigned int new_group;
404 unsigned int numjobs;
405 os_cpu_mask_t cpumask;
407 unsigned int read_iolog;
408 unsigned int rwmixcycle;
409 unsigned int rwmix[2];
411 unsigned int file_service_type;
412 unsigned int group_reporting;
413 unsigned int fadvise_hint;
414 unsigned int zero_buffers;
415 unsigned int time_based;
417 char *read_iolog_file;
418 char *write_iolog_file;
421 * Pre-run and post-run shell
427 unsigned int ratemin;
428 unsigned int ratecycle;
429 unsigned int rate_iops;
430 unsigned int rate_iops_min;
435 * CPU "io" cycle burner
437 unsigned int cpuload;
438 unsigned int cpucycle;
441 #define FIO_VERROR_SIZE 128
444 * This describes a single thread/process executing a fio job.
447 struct thread_options o;
448 char verror[FIO_VERROR_SIZE];
452 struct thread_stat ts;
453 struct fio_file *files;
454 unsigned int files_index;
455 unsigned int nr_open_files;
456 unsigned int nr_done_files;
457 unsigned int nr_normal_files;
459 unsigned int next_file;
460 os_random_state_t next_file_state;
465 size_t orig_buffer_size;
466 volatile int terminate;
467 volatile int runstate;
469 unsigned int last_was_sync;
479 os_random_state_t bsrange_state;
480 os_random_state_t verify_state;
485 * IO engine hooks, contains everything needed to submit an io_u
486 * to any of the available IO engines.
488 struct ioengine_ops *io_ops;
491 * Current IO depth and list of free and busy io_u's.
493 unsigned int cur_depth;
494 struct list_head io_u_freelist;
495 struct list_head io_u_busylist;
496 struct list_head io_u_requeues;
497 unsigned int io_u_queued;
502 unsigned long rate_usec_cycle;
503 long rate_pending_usleep;
504 unsigned long rate_bytes;
505 unsigned long rate_blocks;
506 struct timeval lastrate;
508 unsigned long long total_io_size;
510 unsigned long io_issues[2];
511 unsigned long long io_blocks[2];
512 unsigned long long io_bytes[2];
513 unsigned long long this_io_bytes[2];
514 unsigned long long zone_bytes;
515 struct fio_sem *mutex;
518 * State for random io, a bitmap of blocks done vs not done
520 os_random_state_t random_state;
522 struct timeval start; /* start of this loop */
523 struct timeval epoch; /* time job was started */
524 struct timeval rw_end[2];
525 unsigned int rw_end_set[2];
528 * read/write mixed workload state
530 os_random_state_t rwmix_state;
531 unsigned long long rwmix_bytes;
532 struct timeval rwmix_switch;
533 enum fio_ddir rwmix_ddir;
534 unsigned int ddir_nr;
537 * IO history logs for verification. We use a tree for sorting,
538 * if we are overwriting. Otherwise just use a fifo.
540 struct rb_root io_hist_tree;
541 struct list_head io_hist_list;
546 struct list_head io_log_list;
551 struct timeval timeout_end;
552 struct itimerval timer;
555 * for fileservice, how often to switch to a new file
557 unsigned int file_service_nr;
558 unsigned int file_service_left;
559 struct fio_file *file_service_file;
562 * For generating file sizes
564 os_random_state_t file_size_state;
568 * roundrobin available files, or choose one at random.
571 FIO_FSERVICE_RANDOM = 1,
576 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
577 * the timer on each queue operation.
579 #define IO_U_TIMEOUT_INC 5
580 #define IO_U_TIMEOUT 30
582 #define __td_verror(td, err, msg, func) \
588 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
592 #define td_verror(td, err, func) \
593 __td_verror((td), (err), strerror((err)), (func))
594 #define td_vmsg(td, err, msg, func) \
595 __td_verror((td), (err), (msg), (func))
597 extern int exitall_on_terminate;
598 extern int thread_number;
599 extern int nr_process, nr_thread;
602 extern int terse_output;
605 extern int temp_stall_ts;
606 extern unsigned long long mlock_size;
607 extern unsigned long page_mask, page_size;
609 extern struct thread_data *threads;
611 #define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
612 #define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
613 #define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
614 #define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
616 #define BLOCKS_PER_MAP (8 * sizeof(long))
617 #define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
618 #define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
619 #define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
621 #define MAX_JOBS (1024)
623 static inline int should_fsync(struct thread_data *td)
625 if (td->last_was_sync)
629 if (td_write(td) || td_rw(td) || td->o.override_sync)
636 * Disk utils as read in /sys/block/<dev>/stat
638 struct disk_util_stat {
641 unsigned long long sectors[2];
644 unsigned time_in_queue;
648 * Per-device disk util management
651 struct list_head list;
658 struct disk_util_stat dus;
659 struct disk_util_stat last_dus;
665 #define DISK_UTIL_MSEC (250)
668 #define min(a, b) ((a) < (b) ? (a) : (b))
671 #define max(a, b) ((a) > (b) ? (a) : (b))
677 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
678 extern void write_iolog_put(struct thread_data *, struct io_u *);
679 extern int __must_check init_iolog(struct thread_data *td);
680 extern void log_io_piece(struct thread_data *, struct io_u *);
681 extern void prune_io_piece_log(struct thread_data *);
682 extern void write_iolog_close(struct thread_data *);
687 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
688 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
689 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
690 extern void show_run_stats(void);
691 extern void init_disk_util(struct thread_data *);
692 extern void update_rusage_stat(struct thread_data *);
693 extern void update_io_ticks(void);
694 extern void disk_util_timer_arm(void);
695 extern void setup_log(struct io_log **);
696 extern void finish_log(struct thread_data *, struct io_log *, const char *);
697 extern void __finish_log(struct io_log *, const char *);
698 extern struct io_log *agg_io_log[2];
699 extern int write_bw_log;
700 extern void add_agg_sample(unsigned long, enum fio_ddir);
705 extern unsigned long utime_since(struct timeval *, struct timeval *);
706 extern unsigned long utime_since_now(struct timeval *);
707 extern unsigned long mtime_since(struct timeval *, struct timeval *);
708 extern unsigned long mtime_since_now(struct timeval *);
709 extern unsigned long time_since_now(struct timeval *);
710 extern unsigned long mtime_since_genesis(void);
711 extern void __usec_sleep(unsigned int);
712 extern void usec_sleep(struct thread_data *, unsigned long);
713 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
714 extern void fill_start_time(struct timeval *);
715 extern void fio_gettime(struct timeval *, void *);
716 extern void set_genesis_time(void);
719 * Init/option functions
721 extern int __must_check parse_options(int, char **);
722 extern int fio_option_parse(struct thread_data *, const char *);
723 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
724 extern void fio_fill_default_options(struct thread_data *);
725 extern int fio_show_option_help(const char *);
726 extern void fio_options_dup_and_init(struct option *);
727 extern void options_mem_dupe(struct thread_data *);
728 extern void options_mem_free(struct thread_data *);
729 #define FIO_GETOPT_JOB 0x89988998
730 #define FIO_NR_OPTIONS 128
733 * File setup/shutdown
735 extern void close_files(struct thread_data *);
736 extern int __must_check setup_files(struct thread_data *);
737 extern int __must_check open_files(struct thread_data *);
738 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
739 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
740 extern void generic_close_file(struct thread_data *, struct fio_file *);
741 extern void add_file(struct thread_data *, const char *);
742 extern void get_file(struct fio_file *);
743 extern void put_file(struct thread_data *, struct fio_file *);
744 extern int add_dir_files(struct thread_data *, const char *);
745 extern int init_random_map(struct thread_data *);
746 extern void dup_files(struct thread_data *, struct thread_data *);
751 extern void print_thread_status(void);
752 extern void print_status_init(int);
757 #ifdef FIO_HAVE_DISK_UTIL
758 extern void show_disk_util(void);
759 extern void disk_util_timer_arm(void);
760 extern void init_disk_util(struct thread_data *);
761 extern void update_io_ticks(void);
763 #define show_disk_util()
764 #define disk_util_timer_arm()
765 #define init_disk_util(td)
766 #define update_io_ticks()
770 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
771 * will never back again. It may cycle between running/verififying/fsyncing.
772 * Once the thread reaches TD_EXITED, it is just waiting for the core to
789 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
790 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
791 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
796 extern int __must_check fio_pin_memory(void);
797 extern void fio_unpin_memory(void);
798 extern int __must_check allocate_io_mem(struct thread_data *);
799 extern void free_io_mem(struct thread_data *);
804 #define queue_full(td) list_empty(&(td)->io_u_freelist)
805 extern struct io_u *__get_io_u(struct thread_data *);
806 extern struct io_u *get_io_u(struct thread_data *);
807 extern void put_io_u(struct thread_data *, struct io_u *);
808 extern void requeue_io_u(struct thread_data *, struct io_u **);
809 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
810 extern long __must_check io_u_queued_complete(struct thread_data *, int);
811 extern void io_u_queued(struct thread_data *, struct io_u *);
812 extern void io_u_log_error(struct thread_data *, struct io_u *);
813 extern void io_u_init_timeout(void);
814 extern void io_u_set_timeout(struct thread_data *);
815 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
818 * io engine entry points
820 extern int __must_check td_io_init(struct thread_data *);
821 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
822 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
823 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
824 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
825 extern int __must_check td_io_commit(struct thread_data *);
826 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
827 extern void td_io_close_file(struct thread_data *, struct fio_file *);
830 * If logging output to a file, stderr should go to both stderr and f_err
832 #define log_err(args...) do { \
833 fprintf(f_err, ##args); \
834 if (f_err != stderr) \
835 fprintf(stderr, ##args); \
838 #define log_info(args...) fprintf(f_out, ##args)
840 FILE *get_f_out(void);
841 FILE *get_f_err(void);
843 struct ioengine_ops {
844 struct list_head list;
848 int (*setup)(struct thread_data *);
849 int (*init)(struct thread_data *);
850 int (*prep)(struct thread_data *, struct io_u *);
851 int (*queue)(struct thread_data *, struct io_u *);
852 int (*commit)(struct thread_data *);
853 int (*getevents)(struct thread_data *, int, int, struct timespec *);
854 struct io_u *(*event)(struct thread_data *, int);
855 int (*cancel)(struct thread_data *, struct io_u *);
856 void (*cleanup)(struct thread_data *);
857 int (*open_file)(struct thread_data *, struct fio_file *);
858 void (*close_file)(struct thread_data *, struct fio_file *);
863 #define FIO_IOOPS_VERSION 7
865 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
866 extern void register_ioengine(struct ioengine_ops *);
867 extern void unregister_ioengine(struct ioengine_ops *);
868 extern void close_ioengine(struct thread_data *);
871 * Mark unused variables passed to ops functions as unused, to silence gcc
873 #define fio_unused __attribute((__unused__))
874 #define fio_init __attribute__((constructor))
875 #define fio_exit __attribute__((destructor))
877 #define for_each_td(td, i) \
878 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
879 #define for_each_file(td, f, i) \
880 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
882 #define fio_assert(td, cond) do { \
885 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
886 (td)->runstate = TD_EXITED; \
887 (td)->error = EFAULT; \
892 static inline void clear_error(struct thread_data *td)
895 td->verror[0] = '\0';