8 #include <sys/resource.h>
18 #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_CRC64, /* crc64 sum data blocks */
196 VERIFY_CRC32, /* crc32 sum data blocks */
197 VERIFY_CRC16, /* crc16 sum data blocks */
198 VERIFY_CRC7, /* crc7 sum data blocks */
199 VERIFY_SHA256, /* sha256 sum data blocks */
200 VERIFY_SHA512, /* sha512 sum data blocks */
201 VERIFY_META, /* block_num, timestamp etc. */
202 VERIFY_PATTERN, /* verify a specific pattern */
203 VERIFY_NULL, /* pretend to verify */
207 * A header structure associated with each checksummed data block. It is
208 * followed by a checksum specific header that contains the verification
211 struct verify_header {
212 unsigned int fio_magic;
214 unsigned int verify_type;
218 uint32_t md5_digest[16];
240 unsigned char thread;
241 unsigned short numberio;
242 unsigned long time_sec;
243 unsigned long time_usec;
246 struct group_run_stats {
247 unsigned long long max_run[2], min_run[2];
248 unsigned long long max_bw[2], min_bw[2];
249 unsigned long long io_kb[2];
250 unsigned long long agg[2];
254 * What type of allocation to use for io buffers
257 MEM_MALLOC = 0, /* ordinary malloc */
258 MEM_SHM, /* use shared memory segments */
259 MEM_SHMHUGE, /* use shared memory segments with huge pages */
260 MEM_MMAP, /* use anonynomous mmap */
261 MEM_MMAPHUGE, /* memory mapped huge file */
265 * The type of object we are working on
268 FIO_TYPE_FILE = 1, /* plain file */
269 FIO_TYPE_BD, /* block device */
270 FIO_TYPE_CHAR, /* character device */
271 FIO_TYPE_PIPE, /* pipe */
274 enum fio_ioengine_flags {
275 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
276 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
277 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
278 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
279 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
280 FIO_UNIDIR = 1 << 5, /* engine is uni-directional */
283 enum fio_file_flags {
284 FIO_FILE_OPEN = 1 << 0, /* file is open */
285 FIO_FILE_CLOSING = 1 << 1, /* file being closed */
286 FIO_FILE_EXISTS = 1 << 2, /* file there */
287 FIO_FILE_EXTEND = 1 << 3, /* needs extend */
288 FIO_FILE_NOSORT = 1 << 4, /* don't sort verify blocks */
289 FIO_FILE_DONE = 1 << 5, /* io completed to this file */
290 FIO_SIZE_KNOWN = 1 << 6, /* size has been set */
294 * Each thread_data structure has a number of files associated with it,
295 * this structure holds state information for a single file.
298 enum fio_filetype filetype;
301 * A file may not be a file descriptor, let the io engine decide
304 unsigned long file_data;
309 * filename and possible memory mapping
313 unsigned int major, minor;
316 * size of the file, offset into file, and io size from that offset
318 unsigned long long real_file_size;
319 unsigned long long file_offset;
320 unsigned long long io_size;
322 unsigned long long last_pos;
323 unsigned long long last_completed_pos;
326 * block map for random io
328 unsigned long *file_map;
329 unsigned int num_maps;
330 unsigned int last_free_lookup;
333 enum fio_file_flags flags;
337 * How many depth levels to log
339 #define FIO_IO_U_MAP_NR 8
340 #define FIO_IO_U_LAT_U_NR 10
341 #define FIO_IO_U_LAT_M_NR 12
352 struct io_log *slat_log;
353 struct io_log *clat_log;
354 struct io_log *bw_log;
357 * bandwidth and latency stats
359 struct io_stat clat_stat[2]; /* completion latency */
360 struct io_stat slat_stat[2]; /* submission latency */
361 struct io_stat bw_stat[2]; /* bandwidth stats */
363 unsigned long long stat_io_bytes[2];
364 struct timeval stat_sample_time[2];
367 * fio system usage accounting
369 struct rusage ru_start;
370 struct rusage ru_end;
371 unsigned long usr_time;
372 unsigned long sys_time;
374 unsigned long minf, majf;
377 * IO depth and latency stats
379 unsigned int io_u_map[FIO_IO_U_MAP_NR];
380 unsigned int io_u_lat_u[FIO_IO_U_LAT_U_NR];
381 unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
382 unsigned long total_io_u[2];
383 unsigned long short_io_u[2];
385 unsigned long long io_bytes[2];
386 unsigned long runtime[2];
387 unsigned long total_run_time;
390 struct thread_options {
398 enum td_ddir td_ddir;
399 unsigned int ddir_nr;
400 unsigned int iodepth;
401 unsigned int iodepth_low;
402 unsigned int iodepth_batch;
404 unsigned long long size;
405 unsigned long long file_size_low;
406 unsigned long long file_size_high;
407 unsigned long long start_offset;
410 unsigned int min_bs[2];
411 unsigned int max_bs[2];
413 unsigned int nr_files;
414 unsigned int open_files;
416 unsigned int odirect;
417 unsigned int invalidate_cache;
418 unsigned int create_serialize;
419 unsigned int create_fsync;
420 unsigned int end_fsync;
421 unsigned int sync_io;
423 unsigned int do_verify;
424 unsigned int verifysort;
425 unsigned int verify_interval;
426 unsigned int verify_offset;
427 unsigned int verify_pattern;
428 unsigned int verify_pattern_bytes;
429 unsigned int verify_fatal;
430 unsigned int use_thread;
432 unsigned int do_disk_util;
433 unsigned int override_sync;
434 unsigned int rand_repeatable;
435 unsigned int write_lat_log;
436 unsigned int write_bw_log;
437 unsigned int norandommap;
438 unsigned int bs_unaligned;
439 unsigned int fsync_on_close;
441 unsigned int hugepage_size;
442 unsigned int rw_min_bs;
443 unsigned int thinktime;
444 unsigned int thinktime_spin;
445 unsigned int thinktime_blocks;
446 unsigned int fsync_blocks;
447 unsigned int start_delay;
448 unsigned long long timeout;
449 unsigned int overwrite;
450 unsigned int bw_avg_time;
452 unsigned long long zone_size;
453 unsigned long long zone_skip;
454 enum fio_memtype mem_type;
456 unsigned int stonewall;
457 unsigned int new_group;
458 unsigned int numjobs;
459 os_cpu_mask_t cpumask;
460 unsigned int cpumask_set;
462 unsigned int rwmixcycle;
463 unsigned int rwmix[2];
465 unsigned int file_service_type;
466 unsigned int group_reporting;
467 unsigned int fadvise_hint;
468 unsigned int zero_buffers;
469 unsigned int time_based;
471 char *read_iolog_file;
472 char *write_iolog_file;
475 * Pre-run and post-run shell
481 unsigned int ratemin;
482 unsigned int ratecycle;
483 unsigned int rate_iops;
484 unsigned int rate_iops_min;
489 * CPU "io" cycle burner
491 unsigned int cpuload;
492 unsigned int cpucycle;
495 #define FIO_VERROR_SIZE 128
498 * This describes a single thread/process executing a fio job.
501 struct thread_options o;
502 char verror[FIO_VERROR_SIZE];
506 struct thread_stat ts;
507 struct fio_file *files;
508 unsigned int files_index;
509 unsigned int nr_open_files;
510 unsigned int nr_done_files;
511 unsigned int nr_normal_files;
513 unsigned int next_file;
514 os_random_state_t next_file_state;
520 size_t orig_buffer_size;
521 volatile int terminate;
522 volatile int runstate;
524 unsigned int last_was_sync;
534 os_random_state_t bsrange_state;
535 os_random_state_t verify_state;
540 * IO engine hooks, contains everything needed to submit an io_u
541 * to any of the available IO engines.
543 struct ioengine_ops *io_ops;
546 * Current IO depth and list of free and busy io_u's.
548 unsigned int cur_depth;
549 struct list_head io_u_freelist;
550 struct list_head io_u_busylist;
551 struct list_head io_u_requeues;
552 unsigned int io_u_queued;
557 unsigned long rate_usec_cycle;
558 long rate_pending_usleep;
559 unsigned long rate_bytes;
560 unsigned long rate_blocks;
561 struct timeval lastrate;
563 unsigned long long total_io_size;
565 unsigned long io_issues[2];
566 unsigned long long io_blocks[2];
567 unsigned long long io_bytes[2];
568 unsigned long long io_skip_bytes;
569 unsigned long long this_io_bytes[2];
570 unsigned long long zone_bytes;
571 struct fio_sem *mutex;
574 * State for random io, a bitmap of blocks done vs not done
576 os_random_state_t random_state;
578 struct timeval start; /* start of this loop */
579 struct timeval epoch; /* time job was started */
580 struct timeval rw_end[2];
581 struct timeval last_issue;
582 unsigned int rw_end_set[2];
585 * read/write mixed workload state
587 os_random_state_t rwmix_state;
588 unsigned long long rwmix_bytes;
589 struct timeval rwmix_switch;
590 enum fio_ddir rwmix_ddir;
591 unsigned int ddir_nr;
594 * IO history logs for verification. We use a tree for sorting,
595 * if we are overwriting. Otherwise just use a fifo.
597 struct rb_root io_hist_tree;
598 struct list_head io_hist_list;
603 struct list_head io_log_list;
608 struct timeval timeout_end;
609 struct itimerval timer;
612 * for fileservice, how often to switch to a new file
614 unsigned int file_service_nr;
615 unsigned int file_service_left;
616 struct fio_file *file_service_file;
619 * For generating file sizes
621 os_random_state_t file_size_state;
625 * roundrobin available files, or choose one at random.
628 FIO_FSERVICE_RANDOM = 1,
633 * when should interactive ETA output be generated
642 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
643 * the timer on each queue operation.
645 #define IO_U_TIMEOUT_INC 5
646 #define IO_U_TIMEOUT 30
648 #define __td_verror(td, err, msg, func) \
654 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
658 #define td_verror(td, err, func) \
659 __td_verror((td), (err), strerror((err)), (func))
660 #define td_vmsg(td, err, msg, func) \
661 __td_verror((td), (err), (msg), (func))
663 extern int exitall_on_terminate;
664 extern int thread_number;
665 extern int nr_process, nr_thread;
668 extern int terse_output;
671 extern int temp_stall_ts;
672 extern unsigned long long mlock_size;
673 extern unsigned long page_mask, page_size;
674 extern int read_only;
675 extern int eta_print;
677 extern struct thread_data *threads;
679 #define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
680 #define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
681 #define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
682 #define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
684 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
686 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
689 #define BLOCKS_PER_MAP (8 * sizeof(long))
690 #define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
691 #define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
692 #define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
694 #define MAX_JOBS (1024)
696 static inline int should_fsync(struct thread_data *td)
698 if (td->last_was_sync)
702 if (td_write(td) || td_rw(td) || td->o.override_sync)
709 * Disk utils as read in /sys/block/<dev>/stat
711 struct disk_util_stat {
714 unsigned long long sectors[2];
717 unsigned time_in_queue;
721 * Per-device disk util management
724 struct list_head list;
731 struct disk_util_stat dus;
732 struct disk_util_stat last_dus;
738 #define DISK_UTIL_MSEC (250)
749 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
750 extern void log_io_u(struct thread_data *, struct io_u *);
751 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
752 extern int __must_check init_iolog(struct thread_data *td);
753 extern void log_io_piece(struct thread_data *, struct io_u *);
754 extern void prune_io_piece_log(struct thread_data *);
755 extern void write_iolog_close(struct thread_data *);
760 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
761 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
762 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
763 extern void show_run_stats(void);
764 extern void init_disk_util(struct thread_data *);
765 extern void update_rusage_stat(struct thread_data *);
766 extern void update_io_ticks(void);
767 extern void disk_util_timer_arm(void);
768 extern void setup_log(struct io_log **);
769 extern void finish_log(struct thread_data *, struct io_log *, const char *);
770 extern void __finish_log(struct io_log *, const char *);
771 extern struct io_log *agg_io_log[2];
772 extern int write_bw_log;
773 extern void add_agg_sample(unsigned long, enum fio_ddir);
778 extern unsigned long utime_since(struct timeval *, struct timeval *);
779 extern unsigned long utime_since_now(struct timeval *);
780 extern unsigned long mtime_since(struct timeval *, struct timeval *);
781 extern unsigned long mtime_since_now(struct timeval *);
782 extern unsigned long time_since_now(struct timeval *);
783 extern unsigned long mtime_since_genesis(void);
784 extern void __usec_sleep(unsigned int);
785 extern void usec_sleep(struct thread_data *, unsigned long);
786 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
787 extern void fill_start_time(struct timeval *);
788 extern void fio_gettime(struct timeval *, void *);
789 extern void set_genesis_time(void);
792 * Init/option functions
794 extern int __must_check parse_options(int, char **);
795 extern int fio_option_parse(struct thread_data *, const char *);
796 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
797 extern void fio_fill_default_options(struct thread_data *);
798 extern int fio_show_option_help(const char *);
799 extern void fio_options_dup_and_init(struct option *);
800 extern void options_mem_dupe(struct thread_data *);
801 extern void options_mem_free(struct thread_data *);
802 #define FIO_GETOPT_JOB 0x89988998
803 #define FIO_NR_OPTIONS 128
806 * File setup/shutdown
808 extern void close_files(struct thread_data *);
809 extern int __must_check setup_files(struct thread_data *);
810 extern int __must_check open_files(struct thread_data *);
811 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
812 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
813 extern void generic_close_file(struct thread_data *, struct fio_file *);
814 extern int add_file(struct thread_data *, const char *);
815 extern void get_file(struct fio_file *);
816 extern void put_file(struct thread_data *, struct fio_file *);
817 extern int add_dir_files(struct thread_data *, const char *);
818 extern int init_random_map(struct thread_data *);
819 extern void dup_files(struct thread_data *, struct thread_data *);
820 extern int get_fileno(struct thread_data *, const char *);
821 extern void free_release_files(struct thread_data *);
826 extern void print_thread_status(void);
827 extern void print_status_init(int);
832 #ifdef FIO_HAVE_DISK_UTIL
833 extern void show_disk_util(void);
834 extern void disk_util_timer_arm(void);
835 extern void init_disk_util(struct thread_data *);
836 extern void update_io_ticks(void);
838 #define show_disk_util()
839 #define disk_util_timer_arm()
840 #define init_disk_util(td)
841 #define update_io_ticks()
845 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
846 * will never back again. It may cycle between running/verififying/fsyncing.
847 * Once the thread reaches TD_EXITED, it is just waiting for the core to
864 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
865 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
866 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
871 extern int __must_check fio_pin_memory(void);
872 extern void fio_unpin_memory(void);
873 extern int __must_check allocate_io_mem(struct thread_data *);
874 extern void free_io_mem(struct thread_data *);
879 #define queue_full(td) list_empty(&(td)->io_u_freelist)
880 extern struct io_u *__get_io_u(struct thread_data *);
881 extern struct io_u *get_io_u(struct thread_data *);
882 extern void put_io_u(struct thread_data *, struct io_u *);
883 extern void requeue_io_u(struct thread_data *, struct io_u **);
884 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
885 extern long __must_check io_u_queued_complete(struct thread_data *, int);
886 extern void io_u_queued(struct thread_data *, struct io_u *);
887 extern void io_u_log_error(struct thread_data *, struct io_u *);
888 extern void io_u_init_timeout(void);
889 extern void io_u_set_timeout(struct thread_data *);
890 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
893 * io engine entry points
895 extern int __must_check td_io_init(struct thread_data *);
896 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
897 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
898 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
899 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
900 extern int __must_check td_io_commit(struct thread_data *);
901 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
902 extern void td_io_close_file(struct thread_data *, struct fio_file *);
907 #ifdef FIO_HAVE_BLKTRACE
908 extern int is_blktrace(const char *);
909 extern int load_blktrace(struct thread_data *, const char *);
913 * If logging output to a file, stderr should go to both stderr and f_err
915 #define log_err(args...) do { \
916 fprintf(f_err, ##args); \
917 if (f_err != stderr) \
918 fprintf(stderr, ##args); \
921 #define log_info(args...) fprintf(f_out, ##args)
923 FILE *get_f_out(void);
924 FILE *get_f_err(void);
926 struct ioengine_ops {
927 struct list_head list;
931 int (*setup)(struct thread_data *);
932 int (*init)(struct thread_data *);
933 int (*prep)(struct thread_data *, struct io_u *);
934 int (*queue)(struct thread_data *, struct io_u *);
935 int (*commit)(struct thread_data *);
936 int (*getevents)(struct thread_data *, int, int, struct timespec *);
937 struct io_u *(*event)(struct thread_data *, int);
938 int (*cancel)(struct thread_data *, struct io_u *);
939 void (*cleanup)(struct thread_data *);
940 int (*open_file)(struct thread_data *, struct fio_file *);
941 void (*close_file)(struct thread_data *, struct fio_file *);
946 #define FIO_IOOPS_VERSION 7
948 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
949 extern void register_ioengine(struct ioengine_ops *);
950 extern void unregister_ioengine(struct ioengine_ops *);
951 extern void close_ioengine(struct thread_data *);
954 * Mark unused variables passed to ops functions as unused, to silence gcc
956 #define fio_unused __attribute((__unused__))
957 #define fio_init __attribute__((constructor))
958 #define fio_exit __attribute__((destructor))
960 #define for_each_td(td, i) \
961 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
962 #define for_each_file(td, f, i) \
963 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
965 #define fio_assert(td, cond) do { \
968 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
969 (td)->runstate = TD_EXITED; \
970 (td)->error = EFAULT; \
975 static inline void clear_error(struct thread_data *td)
978 td->verror[0] = '\0';