8 #include <sys/resource.h>
16 #include "compiler/compiler.h"
22 #include "arch/arch.h"
26 #ifdef FIO_HAVE_SYSLET
41 TD_DDIR_READ = 1 << 0,
42 TD_DDIR_WRITE = 1 << 1,
43 TD_DDIR_RAND = 1 << 2,
44 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
45 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
46 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
47 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
51 * Use for maintaining statistics
54 unsigned long max_val;
55 unsigned long min_val;
56 unsigned long samples;
63 * A single data sample
72 * Dynamically growing data sample log
75 unsigned long nr_samples;
76 unsigned long max_samples;
77 struct io_sample *log;
81 * When logging io actions, this matches a single sent io_u
85 struct rb_node rb_node;
86 struct list_head list;
88 struct fio_file *file;
89 unsigned long long offset;
95 #ifdef FIO_HAVE_SYSLET
97 struct syslet_uatom atom; /* the atom to submit */
98 struct syslet_uatom *head; /* head of the sequence */
99 long ret; /* syscall return value */
104 IO_U_F_FREE = 1 << 0,
105 IO_U_F_FLIGHT = 1 << 1,
115 #ifdef FIO_HAVE_LIBAIO
118 #ifdef FIO_HAVE_POSIXAIO
122 struct sg_io_hdr hdr;
124 #ifdef FIO_HAVE_SYSLET
125 struct syslet_req req;
127 #ifdef FIO_HAVE_GUASI
131 struct timeval start_time;
132 struct timeval issue_time;
135 * Allocated/set buffer and length
138 unsigned long buflen;
139 unsigned long long offset;
140 unsigned long long endpos;
143 * IO engine state, may be different from above when we get
144 * partial transfers / residual data counts
147 unsigned long xfer_buflen;
155 * io engine private data
164 struct fio_file *file;
166 struct list_head list;
169 * Callback for io completion
171 int (*end_io)(struct thread_data *, struct io_u *);
175 * io_ops->queue() return values
178 FIO_Q_COMPLETED = 0, /* completed sync */
179 FIO_Q_QUEUED = 1, /* queued, will complete async */
180 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
183 #define FIO_HDR_MAGIC 0xf00baaef
186 VERIFY_NONE = 0, /* no verification */
187 VERIFY_MD5, /* md5 sum data blocks */
188 VERIFY_CRC32, /* crc32 sum data blocks */
189 VERIFY_NULL, /* pretend to verify */
193 * A header structure associated with each checksummed data block
195 struct verify_header {
196 unsigned int fio_magic;
198 unsigned int verify_type;
200 char md5_digest[MD5_HASH_WORDS * 4];
205 struct group_run_stats {
206 unsigned long long max_run[2], min_run[2];
207 unsigned long long max_bw[2], min_bw[2];
208 unsigned long long io_kb[2];
209 unsigned long long agg[2];
213 * What type of allocation to use for io buffers
216 MEM_MALLOC = 0, /* ordinary malloc */
217 MEM_SHM, /* use shared memory segments */
218 MEM_SHMHUGE, /* use shared memory segments with huge pages */
219 MEM_MMAP, /* use anonynomous mmap */
220 MEM_MMAPHUGE, /* memory mapped huge file */
224 * The type of object we are working on
227 FIO_TYPE_FILE = 1, /* plain file */
228 FIO_TYPE_BD, /* block device */
229 FIO_TYPE_CHAR, /* character device */
230 FIO_TYPE_PIPE, /* pipe */
233 enum fio_ioengine_flags {
234 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
235 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
236 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
237 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
238 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
241 enum fio_file_flags {
242 FIO_FILE_OPEN = 1 << 0, /* file is open */
243 FIO_FILE_CLOSING = 1 << 1, /* file being closed */
244 FIO_FILE_EXISTS = 1 << 2, /* file there */
245 FIO_FILE_EXTEND = 1 << 3, /* needs extend */
246 FIO_FILE_NOSORT = 1 << 4, /* don't sort verify blocks */
247 FIO_FILE_DONE = 1 << 5, /* io completed to this file */
248 FIO_SIZE_KNOWN = 1 << 6, /* size has been set */
252 * Each thread_data structure has a number of files associated with it,
253 * this structure holds state information for a single file.
256 enum fio_filetype filetype;
259 * A file may not be a file descriptor, let the io engine decide
262 unsigned long file_data;
267 * filename and possible memory mapping
273 * size of the file, offset into file, and io size from that offset
275 unsigned long long real_file_size;
276 unsigned long long file_offset;
277 unsigned long long io_size;
279 unsigned long long last_pos;
280 unsigned long long last_completed_pos;
283 * block map for random io
285 unsigned long *file_map;
286 unsigned int num_maps;
287 unsigned int last_free_lookup;
290 enum fio_file_flags flags;
294 * How many depth levels to log
296 #define FIO_IO_U_MAP_NR 8
297 #define FIO_IO_U_LAT_NR 12
308 struct io_log *slat_log;
309 struct io_log *clat_log;
310 struct io_log *bw_log;
313 * bandwidth and latency stats
315 struct io_stat clat_stat[2]; /* completion latency */
316 struct io_stat slat_stat[2]; /* submission latency */
317 struct io_stat bw_stat[2]; /* bandwidth stats */
319 unsigned long long stat_io_bytes[2];
320 struct timeval stat_sample_time[2];
323 * fio system usage accounting
325 struct rusage ru_start;
326 struct rusage ru_end;
327 unsigned long usr_time;
328 unsigned long sys_time;
332 * IO depth and latency stats
334 unsigned int io_u_map[FIO_IO_U_MAP_NR];
335 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
336 unsigned long total_io_u[2];
337 unsigned long short_io_u[2];
339 unsigned long long io_bytes[2];
340 unsigned long runtime[2];
341 unsigned long total_run_time;
344 struct thread_options {
352 enum td_ddir td_ddir;
353 unsigned int ddir_nr;
354 unsigned int iodepth;
355 unsigned int iodepth_low;
356 unsigned int iodepth_batch;
358 unsigned long long size;
359 unsigned long long file_size_low;
360 unsigned long long file_size_high;
361 unsigned long long start_offset;
364 unsigned int min_bs[2];
365 unsigned int max_bs[2];
367 unsigned int nr_files;
368 unsigned int open_files;
370 unsigned int odirect;
371 unsigned int invalidate_cache;
372 unsigned int create_serialize;
373 unsigned int create_fsync;
374 unsigned int end_fsync;
375 unsigned int sync_io;
377 unsigned int verifysort;
378 unsigned int use_thread;
380 unsigned int do_disk_util;
381 unsigned int override_sync;
382 unsigned int rand_repeatable;
383 unsigned int write_lat_log;
384 unsigned int write_bw_log;
385 unsigned int norandommap;
386 unsigned int bs_unaligned;
387 unsigned int fsync_on_close;
389 unsigned int hugepage_size;
390 unsigned int rw_min_bs;
391 unsigned int thinktime;
392 unsigned int thinktime_spin;
393 unsigned int thinktime_blocks;
394 unsigned int fsync_blocks;
395 unsigned int start_delay;
396 unsigned long long timeout;
397 unsigned int overwrite;
398 unsigned int bw_avg_time;
400 unsigned long long zone_size;
401 unsigned long long zone_skip;
402 enum fio_memtype mem_type;
404 unsigned int stonewall;
405 unsigned int new_group;
406 unsigned int numjobs;
407 os_cpu_mask_t cpumask;
409 unsigned int rwmixcycle;
410 unsigned int rwmix[2];
412 unsigned int file_service_type;
413 unsigned int group_reporting;
414 unsigned int fadvise_hint;
415 unsigned int zero_buffers;
416 unsigned int time_based;
418 char *read_iolog_file;
419 char *write_iolog_file;
422 * Pre-run and post-run shell
428 unsigned int ratemin;
429 unsigned int ratecycle;
430 unsigned int rate_iops;
431 unsigned int rate_iops_min;
436 * CPU "io" cycle burner
438 unsigned int cpuload;
439 unsigned int cpucycle;
442 #define FIO_VERROR_SIZE 128
445 * This describes a single thread/process executing a fio job.
448 struct thread_options o;
449 char verror[FIO_VERROR_SIZE];
453 struct thread_stat ts;
454 struct fio_file *files;
455 unsigned int files_index;
456 unsigned int nr_open_files;
457 unsigned int nr_done_files;
458 unsigned int nr_normal_files;
460 unsigned int next_file;
461 os_random_state_t next_file_state;
466 size_t orig_buffer_size;
467 volatile int terminate;
468 volatile int runstate;
470 unsigned int last_was_sync;
480 os_random_state_t bsrange_state;
481 os_random_state_t verify_state;
486 * IO engine hooks, contains everything needed to submit an io_u
487 * to any of the available IO engines.
489 struct ioengine_ops *io_ops;
492 * Current IO depth and list of free and busy io_u's.
494 unsigned int cur_depth;
495 struct list_head io_u_freelist;
496 struct list_head io_u_busylist;
497 struct list_head io_u_requeues;
498 unsigned int io_u_queued;
503 unsigned long rate_usec_cycle;
504 long rate_pending_usleep;
505 unsigned long rate_bytes;
506 unsigned long rate_blocks;
507 struct timeval lastrate;
509 unsigned long long total_io_size;
511 unsigned long io_issues[2];
512 unsigned long long io_blocks[2];
513 unsigned long long io_bytes[2];
514 unsigned long long this_io_bytes[2];
515 unsigned long long zone_bytes;
516 struct fio_sem *mutex;
519 * State for random io, a bitmap of blocks done vs not done
521 os_random_state_t random_state;
523 struct timeval start; /* start of this loop */
524 struct timeval epoch; /* time job was started */
525 struct timeval rw_end[2];
526 struct timeval last_issue;
527 unsigned int rw_end_set[2];
530 * read/write mixed workload state
532 os_random_state_t rwmix_state;
533 unsigned long long rwmix_bytes;
534 struct timeval rwmix_switch;
535 enum fio_ddir rwmix_ddir;
536 unsigned int ddir_nr;
539 * IO history logs for verification. We use a tree for sorting,
540 * if we are overwriting. Otherwise just use a fifo.
542 struct rb_root io_hist_tree;
543 struct list_head io_hist_list;
548 struct list_head io_log_list;
553 struct timeval timeout_end;
554 struct itimerval timer;
557 * for fileservice, how often to switch to a new file
559 unsigned int file_service_nr;
560 unsigned int file_service_left;
561 struct fio_file *file_service_file;
564 * For generating file sizes
566 os_random_state_t file_size_state;
570 * roundrobin available files, or choose one at random.
573 FIO_FSERVICE_RANDOM = 1,
578 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
579 * the timer on each queue operation.
581 #define IO_U_TIMEOUT_INC 5
582 #define IO_U_TIMEOUT 30
584 #define __td_verror(td, err, msg, func) \
590 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
594 #define td_verror(td, err, func) \
595 __td_verror((td), (err), strerror((err)), (func))
596 #define td_vmsg(td, err, msg, func) \
597 __td_verror((td), (err), (msg), (func))
599 extern int exitall_on_terminate;
600 extern int thread_number;
601 extern int nr_process, nr_thread;
604 extern int terse_output;
607 extern int temp_stall_ts;
608 extern unsigned long long mlock_size;
609 extern unsigned long page_mask, page_size;
611 extern struct thread_data *threads;
613 #define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
614 #define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
615 #define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
616 #define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
618 #define BLOCKS_PER_MAP (8 * sizeof(long))
619 #define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
620 #define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
621 #define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
623 #define MAX_JOBS (1024)
625 static inline int should_fsync(struct thread_data *td)
627 if (td->last_was_sync)
631 if (td_write(td) || td_rw(td) || td->o.override_sync)
638 * Disk utils as read in /sys/block/<dev>/stat
640 struct disk_util_stat {
643 unsigned long long sectors[2];
646 unsigned time_in_queue;
650 * Per-device disk util management
653 struct list_head list;
660 struct disk_util_stat dus;
661 struct disk_util_stat last_dus;
667 #define DISK_UTIL_MSEC (250)
672 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
673 extern void write_iolog_put(struct thread_data *, struct io_u *);
674 extern int __must_check init_iolog(struct thread_data *td);
675 extern void log_io_piece(struct thread_data *, struct io_u *);
676 extern void prune_io_piece_log(struct thread_data *);
677 extern void write_iolog_close(struct thread_data *);
682 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
683 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
684 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
685 extern void show_run_stats(void);
686 extern void init_disk_util(struct thread_data *);
687 extern void update_rusage_stat(struct thread_data *);
688 extern void update_io_ticks(void);
689 extern void disk_util_timer_arm(void);
690 extern void setup_log(struct io_log **);
691 extern void finish_log(struct thread_data *, struct io_log *, const char *);
692 extern void __finish_log(struct io_log *, const char *);
693 extern struct io_log *agg_io_log[2];
694 extern int write_bw_log;
695 extern void add_agg_sample(unsigned long, enum fio_ddir);
700 extern unsigned long utime_since(struct timeval *, struct timeval *);
701 extern unsigned long utime_since_now(struct timeval *);
702 extern unsigned long mtime_since(struct timeval *, struct timeval *);
703 extern unsigned long mtime_since_now(struct timeval *);
704 extern unsigned long time_since_now(struct timeval *);
705 extern unsigned long mtime_since_genesis(void);
706 extern void __usec_sleep(unsigned int);
707 extern void usec_sleep(struct thread_data *, unsigned long);
708 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
709 extern void fill_start_time(struct timeval *);
710 extern void fio_gettime(struct timeval *, void *);
711 extern void set_genesis_time(void);
714 * Init/option functions
716 extern int __must_check parse_options(int, char **);
717 extern int fio_option_parse(struct thread_data *, const char *);
718 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
719 extern void fio_fill_default_options(struct thread_data *);
720 extern int fio_show_option_help(const char *);
721 extern void fio_options_dup_and_init(struct option *);
722 extern void options_mem_dupe(struct thread_data *);
723 extern void options_mem_free(struct thread_data *);
724 #define FIO_GETOPT_JOB 0x89988998
725 #define FIO_NR_OPTIONS 128
728 * File setup/shutdown
730 extern void close_files(struct thread_data *);
731 extern int __must_check setup_files(struct thread_data *);
732 extern int __must_check open_files(struct thread_data *);
733 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
734 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
735 extern void generic_close_file(struct thread_data *, struct fio_file *);
736 extern void add_file(struct thread_data *, const char *);
737 extern void get_file(struct fio_file *);
738 extern void put_file(struct thread_data *, struct fio_file *);
739 extern int add_dir_files(struct thread_data *, const char *);
740 extern int init_random_map(struct thread_data *);
741 extern void dup_files(struct thread_data *, struct thread_data *);
746 extern void print_thread_status(void);
747 extern void print_status_init(int);
752 #ifdef FIO_HAVE_DISK_UTIL
753 extern void show_disk_util(void);
754 extern void disk_util_timer_arm(void);
755 extern void init_disk_util(struct thread_data *);
756 extern void update_io_ticks(void);
758 #define show_disk_util()
759 #define disk_util_timer_arm()
760 #define init_disk_util(td)
761 #define update_io_ticks()
765 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
766 * will never back again. It may cycle between running/verififying/fsyncing.
767 * Once the thread reaches TD_EXITED, it is just waiting for the core to
784 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
785 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
786 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
791 extern int __must_check fio_pin_memory(void);
792 extern void fio_unpin_memory(void);
793 extern int __must_check allocate_io_mem(struct thread_data *);
794 extern void free_io_mem(struct thread_data *);
799 #define queue_full(td) list_empty(&(td)->io_u_freelist)
800 extern struct io_u *__get_io_u(struct thread_data *);
801 extern struct io_u *get_io_u(struct thread_data *);
802 extern void put_io_u(struct thread_data *, struct io_u *);
803 extern void requeue_io_u(struct thread_data *, struct io_u **);
804 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
805 extern long __must_check io_u_queued_complete(struct thread_data *, int);
806 extern void io_u_queued(struct thread_data *, struct io_u *);
807 extern void io_u_log_error(struct thread_data *, struct io_u *);
808 extern void io_u_init_timeout(void);
809 extern void io_u_set_timeout(struct thread_data *);
810 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
813 * io engine entry points
815 extern int __must_check td_io_init(struct thread_data *);
816 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
817 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
818 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
819 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
820 extern int __must_check td_io_commit(struct thread_data *);
821 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
822 extern void td_io_close_file(struct thread_data *, struct fio_file *);
827 extern int is_blktrace(const char *);
828 extern int load_blktrace(struct thread_data *, const char *);
831 * If logging output to a file, stderr should go to both stderr and f_err
833 #define log_err(args...) do { \
834 fprintf(f_err, ##args); \
835 if (f_err != stderr) \
836 fprintf(stderr, ##args); \
839 #define log_info(args...) fprintf(f_out, ##args)
841 FILE *get_f_out(void);
842 FILE *get_f_err(void);
844 struct ioengine_ops {
845 struct list_head list;
849 int (*setup)(struct thread_data *);
850 int (*init)(struct thread_data *);
851 int (*prep)(struct thread_data *, struct io_u *);
852 int (*queue)(struct thread_data *, struct io_u *);
853 int (*commit)(struct thread_data *);
854 int (*getevents)(struct thread_data *, int, int, struct timespec *);
855 struct io_u *(*event)(struct thread_data *, int);
856 int (*cancel)(struct thread_data *, struct io_u *);
857 void (*cleanup)(struct thread_data *);
858 int (*open_file)(struct thread_data *, struct fio_file *);
859 void (*close_file)(struct thread_data *, struct fio_file *);
864 #define FIO_IOOPS_VERSION 7
866 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
867 extern void register_ioengine(struct ioengine_ops *);
868 extern void unregister_ioengine(struct ioengine_ops *);
869 extern void close_ioengine(struct thread_data *);
872 * Mark unused variables passed to ops functions as unused, to silence gcc
874 #define fio_unused __attribute((__unused__))
875 #define fio_init __attribute__((constructor))
876 #define fio_exit __attribute__((destructor))
878 #define for_each_td(td, i) \
879 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
880 #define for_each_file(td, f, i) \
881 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
883 #define fio_assert(td, cond) do { \
886 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
887 (td)->runstate = TD_EXITED; \
888 (td)->error = EFAULT; \
893 static inline void clear_error(struct thread_data *td)
896 td->verror[0] = '\0';