8 #include <sys/resource.h>
16 #include "compiler/compiler.h"
23 #include "arch/arch.h"
27 #ifdef FIO_HAVE_SYSLET
43 TD_DDIR_READ = 1 << 0,
44 TD_DDIR_WRITE = 1 << 1,
45 TD_DDIR_RAND = 1 << 2,
46 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
47 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
48 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
49 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
53 * Use for maintaining statistics
56 unsigned long max_val;
57 unsigned long min_val;
58 unsigned long samples;
65 * A single data sample
74 * Dynamically growing data sample log
77 unsigned long nr_samples;
78 unsigned long max_samples;
79 struct io_sample *log;
83 * When logging io actions, this matches a single sent io_u
87 struct rb_node rb_node;
88 struct list_head list;
92 struct fio_file *file;
94 unsigned long long offset;
99 unsigned int file_action;
103 #ifdef FIO_HAVE_SYSLET
105 struct syslet_uatom atom; /* the atom to submit */
106 struct syslet_uatom *head; /* head of the sequence */
107 long ret; /* syscall return value */
112 IO_U_F_FREE = 1 << 0,
113 IO_U_F_FLIGHT = 1 << 1,
123 #ifdef FIO_HAVE_LIBAIO
126 #ifdef FIO_HAVE_POSIXAIO
130 struct sg_io_hdr hdr;
132 #ifdef FIO_HAVE_SYSLET
133 struct syslet_req req;
135 #ifdef FIO_HAVE_GUASI
139 struct timeval start_time;
140 struct timeval issue_time;
143 * Allocated/set buffer and length
146 unsigned long buflen;
147 unsigned long long offset;
148 unsigned long long endpos;
151 * IO engine state, may be different from above when we get
152 * partial transfers / residual data counts
155 unsigned long xfer_buflen;
163 * io engine private data
172 struct fio_file *file;
174 struct list_head list;
177 * Callback for io completion
179 int (*end_io)(struct thread_data *, struct io_u *);
183 * io_ops->queue() return values
186 FIO_Q_COMPLETED = 0, /* completed sync */
187 FIO_Q_QUEUED = 1, /* queued, will complete async */
188 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
191 #define FIO_HDR_MAGIC 0xf00baaef
194 VERIFY_NONE = 0, /* no verification */
195 VERIFY_MD5, /* md5 sum data blocks */
196 VERIFY_CRC32, /* crc32 sum data blocks */
197 VERIFY_CRC16, /* crc16 sum data blocks */
198 VERIFY_NULL, /* pretend to verify */
202 * A header structure associated with each checksummed data block
204 struct verify_header {
205 unsigned int fio_magic;
207 unsigned int verify_type;
209 char md5_digest[MD5_HASH_WORDS * 4];
211 unsigned short crc16;
215 struct group_run_stats {
216 unsigned long long max_run[2], min_run[2];
217 unsigned long long max_bw[2], min_bw[2];
218 unsigned long long io_kb[2];
219 unsigned long long agg[2];
223 * What type of allocation to use for io buffers
226 MEM_MALLOC = 0, /* ordinary malloc */
227 MEM_SHM, /* use shared memory segments */
228 MEM_SHMHUGE, /* use shared memory segments with huge pages */
229 MEM_MMAP, /* use anonynomous mmap */
230 MEM_MMAPHUGE, /* memory mapped huge file */
234 * The type of object we are working on
237 FIO_TYPE_FILE = 1, /* plain file */
238 FIO_TYPE_BD, /* block device */
239 FIO_TYPE_CHAR, /* character device */
240 FIO_TYPE_PIPE, /* pipe */
243 enum fio_ioengine_flags {
244 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
245 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
246 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
247 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
248 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
249 FIO_UNIDIR = 1 << 5, /* engine is uni-directional */
252 enum fio_file_flags {
253 FIO_FILE_OPEN = 1 << 0, /* file is open */
254 FIO_FILE_CLOSING = 1 << 1, /* file being closed */
255 FIO_FILE_EXISTS = 1 << 2, /* file there */
256 FIO_FILE_EXTEND = 1 << 3, /* needs extend */
257 FIO_FILE_NOSORT = 1 << 4, /* don't sort verify blocks */
258 FIO_FILE_DONE = 1 << 5, /* io completed to this file */
259 FIO_SIZE_KNOWN = 1 << 6, /* size has been set */
263 * Each thread_data structure has a number of files associated with it,
264 * this structure holds state information for a single file.
267 enum fio_filetype filetype;
270 * A file may not be a file descriptor, let the io engine decide
273 unsigned long file_data;
278 * filename and possible memory mapping
282 unsigned int major, minor;
285 * size of the file, offset into file, and io size from that offset
287 unsigned long long real_file_size;
288 unsigned long long file_offset;
289 unsigned long long io_size;
291 unsigned long long last_pos;
292 unsigned long long last_completed_pos;
295 * block map for random io
297 unsigned long *file_map;
298 unsigned int num_maps;
299 unsigned int last_free_lookup;
302 enum fio_file_flags flags;
306 * How many depth levels to log
308 #define FIO_IO_U_MAP_NR 8
309 #define FIO_IO_U_LAT_U_NR 10
310 #define FIO_IO_U_LAT_M_NR 12
321 struct io_log *slat_log;
322 struct io_log *clat_log;
323 struct io_log *bw_log;
326 * bandwidth and latency stats
328 struct io_stat clat_stat[2]; /* completion latency */
329 struct io_stat slat_stat[2]; /* submission latency */
330 struct io_stat bw_stat[2]; /* bandwidth stats */
332 unsigned long long stat_io_bytes[2];
333 struct timeval stat_sample_time[2];
336 * fio system usage accounting
338 struct rusage ru_start;
339 struct rusage ru_end;
340 unsigned long usr_time;
341 unsigned long sys_time;
345 * IO depth and latency stats
347 unsigned int io_u_map[FIO_IO_U_MAP_NR];
348 unsigned int io_u_lat_u[FIO_IO_U_LAT_U_NR];
349 unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
350 unsigned long total_io_u[2];
351 unsigned long short_io_u[2];
353 unsigned long long io_bytes[2];
354 unsigned long runtime[2];
355 unsigned long total_run_time;
358 struct thread_options {
366 enum td_ddir td_ddir;
367 unsigned int ddir_nr;
368 unsigned int iodepth;
369 unsigned int iodepth_low;
370 unsigned int iodepth_batch;
372 unsigned long long size;
373 unsigned long long file_size_low;
374 unsigned long long file_size_high;
375 unsigned long long start_offset;
378 unsigned int min_bs[2];
379 unsigned int max_bs[2];
381 unsigned int nr_files;
382 unsigned int open_files;
384 unsigned int odirect;
385 unsigned int invalidate_cache;
386 unsigned int create_serialize;
387 unsigned int create_fsync;
388 unsigned int end_fsync;
389 unsigned int sync_io;
391 unsigned int verifysort;
392 unsigned int use_thread;
394 unsigned int do_disk_util;
395 unsigned int override_sync;
396 unsigned int rand_repeatable;
397 unsigned int write_lat_log;
398 unsigned int write_bw_log;
399 unsigned int norandommap;
400 unsigned int bs_unaligned;
401 unsigned int fsync_on_close;
403 unsigned int hugepage_size;
404 unsigned int rw_min_bs;
405 unsigned int thinktime;
406 unsigned int thinktime_spin;
407 unsigned int thinktime_blocks;
408 unsigned int fsync_blocks;
409 unsigned int start_delay;
410 unsigned long long timeout;
411 unsigned int overwrite;
412 unsigned int bw_avg_time;
414 unsigned long long zone_size;
415 unsigned long long zone_skip;
416 enum fio_memtype mem_type;
418 unsigned int stonewall;
419 unsigned int new_group;
420 unsigned int numjobs;
421 os_cpu_mask_t cpumask;
422 unsigned int cpumask_set;
424 unsigned int rwmixcycle;
425 unsigned int rwmix[2];
427 unsigned int file_service_type;
428 unsigned int group_reporting;
429 unsigned int fadvise_hint;
430 unsigned int zero_buffers;
431 unsigned int time_based;
433 char *read_iolog_file;
434 char *write_iolog_file;
437 * Pre-run and post-run shell
443 unsigned int ratemin;
444 unsigned int ratecycle;
445 unsigned int rate_iops;
446 unsigned int rate_iops_min;
451 * CPU "io" cycle burner
453 unsigned int cpuload;
454 unsigned int cpucycle;
457 #define FIO_VERROR_SIZE 128
460 * This describes a single thread/process executing a fio job.
463 struct thread_options o;
464 char verror[FIO_VERROR_SIZE];
468 struct thread_stat ts;
469 struct fio_file *files;
470 unsigned int files_index;
471 unsigned int nr_open_files;
472 unsigned int nr_done_files;
473 unsigned int nr_normal_files;
475 unsigned int next_file;
476 os_random_state_t next_file_state;
482 size_t orig_buffer_size;
483 volatile int terminate;
484 volatile int runstate;
486 unsigned int last_was_sync;
496 os_random_state_t bsrange_state;
497 os_random_state_t verify_state;
502 * IO engine hooks, contains everything needed to submit an io_u
503 * to any of the available IO engines.
505 struct ioengine_ops *io_ops;
508 * Current IO depth and list of free and busy io_u's.
510 unsigned int cur_depth;
511 struct list_head io_u_freelist;
512 struct list_head io_u_busylist;
513 struct list_head io_u_requeues;
514 unsigned int io_u_queued;
519 unsigned long rate_usec_cycle;
520 long rate_pending_usleep;
521 unsigned long rate_bytes;
522 unsigned long rate_blocks;
523 struct timeval lastrate;
525 unsigned long long total_io_size;
527 unsigned long io_issues[2];
528 unsigned long long io_blocks[2];
529 unsigned long long io_bytes[2];
530 unsigned long long io_skip_bytes;
531 unsigned long long this_io_bytes[2];
532 unsigned long long zone_bytes;
533 struct fio_sem *mutex;
536 * State for random io, a bitmap of blocks done vs not done
538 os_random_state_t random_state;
540 struct timeval start; /* start of this loop */
541 struct timeval epoch; /* time job was started */
542 struct timeval rw_end[2];
543 struct timeval last_issue;
544 unsigned int rw_end_set[2];
547 * read/write mixed workload state
549 os_random_state_t rwmix_state;
550 unsigned long long rwmix_bytes;
551 struct timeval rwmix_switch;
552 enum fio_ddir rwmix_ddir;
553 unsigned int ddir_nr;
556 * IO history logs for verification. We use a tree for sorting,
557 * if we are overwriting. Otherwise just use a fifo.
559 struct rb_root io_hist_tree;
560 struct list_head io_hist_list;
565 struct list_head io_log_list;
570 struct timeval timeout_end;
571 struct itimerval timer;
574 * for fileservice, how often to switch to a new file
576 unsigned int file_service_nr;
577 unsigned int file_service_left;
578 struct fio_file *file_service_file;
581 * For generating file sizes
583 os_random_state_t file_size_state;
587 * roundrobin available files, or choose one at random.
590 FIO_FSERVICE_RANDOM = 1,
595 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
596 * the timer on each queue operation.
598 #define IO_U_TIMEOUT_INC 5
599 #define IO_U_TIMEOUT 30
601 #define __td_verror(td, err, msg, func) \
607 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
611 #define td_verror(td, err, func) \
612 __td_verror((td), (err), strerror((err)), (func))
613 #define td_vmsg(td, err, msg, func) \
614 __td_verror((td), (err), (msg), (func))
616 extern int exitall_on_terminate;
617 extern int thread_number;
618 extern int nr_process, nr_thread;
621 extern int terse_output;
624 extern int temp_stall_ts;
625 extern unsigned long long mlock_size;
626 extern unsigned long page_mask, page_size;
628 extern struct thread_data *threads;
630 #define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
631 #define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
632 #define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
633 #define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
635 #define BLOCKS_PER_MAP (8 * sizeof(long))
636 #define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
637 #define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
638 #define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
640 #define MAX_JOBS (1024)
642 static inline int should_fsync(struct thread_data *td)
644 if (td->last_was_sync)
648 if (td_write(td) || td_rw(td) || td->o.override_sync)
655 * Disk utils as read in /sys/block/<dev>/stat
657 struct disk_util_stat {
660 unsigned long long sectors[2];
663 unsigned time_in_queue;
667 * Per-device disk util management
670 struct list_head list;
677 struct disk_util_stat dus;
678 struct disk_util_stat last_dus;
684 #define DISK_UTIL_MSEC (250)
695 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
696 extern void log_io_u(struct thread_data *, struct io_u *);
697 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
698 extern int __must_check init_iolog(struct thread_data *td);
699 extern void log_io_piece(struct thread_data *, struct io_u *);
700 extern void prune_io_piece_log(struct thread_data *);
701 extern void write_iolog_close(struct thread_data *);
706 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
707 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
708 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
709 extern void show_run_stats(void);
710 extern void init_disk_util(struct thread_data *);
711 extern void update_rusage_stat(struct thread_data *);
712 extern void update_io_ticks(void);
713 extern void disk_util_timer_arm(void);
714 extern void setup_log(struct io_log **);
715 extern void finish_log(struct thread_data *, struct io_log *, const char *);
716 extern void __finish_log(struct io_log *, const char *);
717 extern struct io_log *agg_io_log[2];
718 extern int write_bw_log;
719 extern void add_agg_sample(unsigned long, enum fio_ddir);
724 extern unsigned long utime_since(struct timeval *, struct timeval *);
725 extern unsigned long utime_since_now(struct timeval *);
726 extern unsigned long mtime_since(struct timeval *, struct timeval *);
727 extern unsigned long mtime_since_now(struct timeval *);
728 extern unsigned long time_since_now(struct timeval *);
729 extern unsigned long mtime_since_genesis(void);
730 extern void __usec_sleep(unsigned int);
731 extern void usec_sleep(struct thread_data *, unsigned long);
732 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
733 extern void fill_start_time(struct timeval *);
734 extern void fio_gettime(struct timeval *, void *);
735 extern void set_genesis_time(void);
738 * Init/option functions
740 extern int __must_check parse_options(int, char **);
741 extern int fio_option_parse(struct thread_data *, const char *);
742 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
743 extern void fio_fill_default_options(struct thread_data *);
744 extern int fio_show_option_help(const char *);
745 extern void fio_options_dup_and_init(struct option *);
746 extern void options_mem_dupe(struct thread_data *);
747 extern void options_mem_free(struct thread_data *);
748 #define FIO_GETOPT_JOB 0x89988998
749 #define FIO_NR_OPTIONS 128
752 * File setup/shutdown
754 extern void close_files(struct thread_data *);
755 extern int __must_check setup_files(struct thread_data *);
756 extern int __must_check open_files(struct thread_data *);
757 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
758 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
759 extern void generic_close_file(struct thread_data *, struct fio_file *);
760 extern int add_file(struct thread_data *, const char *);
761 extern void get_file(struct fio_file *);
762 extern void put_file(struct thread_data *, struct fio_file *);
763 extern int add_dir_files(struct thread_data *, const char *);
764 extern int init_random_map(struct thread_data *);
765 extern void dup_files(struct thread_data *, struct thread_data *);
766 extern int get_fileno(struct thread_data *, const char *);
767 extern void free_release_files(struct thread_data *);
772 extern void print_thread_status(void);
773 extern void print_status_init(int);
778 #ifdef FIO_HAVE_DISK_UTIL
779 extern void show_disk_util(void);
780 extern void disk_util_timer_arm(void);
781 extern void init_disk_util(struct thread_data *);
782 extern void update_io_ticks(void);
784 #define show_disk_util()
785 #define disk_util_timer_arm()
786 #define init_disk_util(td)
787 #define update_io_ticks()
791 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
792 * will never back again. It may cycle between running/verififying/fsyncing.
793 * Once the thread reaches TD_EXITED, it is just waiting for the core to
810 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
811 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
812 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
817 extern int __must_check fio_pin_memory(void);
818 extern void fio_unpin_memory(void);
819 extern int __must_check allocate_io_mem(struct thread_data *);
820 extern void free_io_mem(struct thread_data *);
825 #define queue_full(td) list_empty(&(td)->io_u_freelist)
826 extern struct io_u *__get_io_u(struct thread_data *);
827 extern struct io_u *get_io_u(struct thread_data *);
828 extern void put_io_u(struct thread_data *, struct io_u *);
829 extern void requeue_io_u(struct thread_data *, struct io_u **);
830 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
831 extern long __must_check io_u_queued_complete(struct thread_data *, int);
832 extern void io_u_queued(struct thread_data *, struct io_u *);
833 extern void io_u_log_error(struct thread_data *, struct io_u *);
834 extern void io_u_init_timeout(void);
835 extern void io_u_set_timeout(struct thread_data *);
836 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
839 * io engine entry points
841 extern int __must_check td_io_init(struct thread_data *);
842 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
843 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
844 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
845 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
846 extern int __must_check td_io_commit(struct thread_data *);
847 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
848 extern void td_io_close_file(struct thread_data *, struct fio_file *);
853 #ifdef FIO_HAVE_BLKTRACE
854 extern int is_blktrace(const char *);
855 extern int load_blktrace(struct thread_data *, const char *);
859 * If logging output to a file, stderr should go to both stderr and f_err
861 #define log_err(args...) do { \
862 fprintf(f_err, ##args); \
863 if (f_err != stderr) \
864 fprintf(stderr, ##args); \
867 #define log_info(args...) fprintf(f_out, ##args)
869 FILE *get_f_out(void);
870 FILE *get_f_err(void);
872 struct ioengine_ops {
873 struct list_head list;
877 int (*setup)(struct thread_data *);
878 int (*init)(struct thread_data *);
879 int (*prep)(struct thread_data *, struct io_u *);
880 int (*queue)(struct thread_data *, struct io_u *);
881 int (*commit)(struct thread_data *);
882 int (*getevents)(struct thread_data *, int, int, struct timespec *);
883 struct io_u *(*event)(struct thread_data *, int);
884 int (*cancel)(struct thread_data *, struct io_u *);
885 void (*cleanup)(struct thread_data *);
886 int (*open_file)(struct thread_data *, struct fio_file *);
887 void (*close_file)(struct thread_data *, struct fio_file *);
892 #define FIO_IOOPS_VERSION 7
894 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
895 extern void register_ioengine(struct ioengine_ops *);
896 extern void unregister_ioengine(struct ioengine_ops *);
897 extern void close_ioengine(struct thread_data *);
900 * Mark unused variables passed to ops functions as unused, to silence gcc
902 #define fio_unused __attribute((__unused__))
903 #define fio_init __attribute__((constructor))
904 #define fio_exit __attribute__((destructor))
906 #define for_each_td(td, i) \
907 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
908 #define for_each_file(td, f, i) \
909 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
911 #define fio_assert(td, cond) do { \
914 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
915 (td)->runstate = TD_EXITED; \
916 (td)->error = EFAULT; \
921 static inline void clear_error(struct thread_data *td)
924 td->verror[0] = '\0';