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_UNLINK = 1 << 1, /* unlink on close */
242 FIO_FILE_CLOSING = 1 << 2, /* file being closed */
243 FIO_FILE_EXISTS = 1 << 3, /* file there */
244 FIO_FILE_EXTEND = 1 << 4, /* needs extend */
245 FIO_FILE_NOSORT = 1 << 5, /* don't sort verify blocks */
246 FIO_FILE_DONE = 1 << 6, /* io completed to this file */
247 FIO_SIZE_KNOWN = 1 << 7, /* size has been set */
251 * Each thread_data structure has a number of files associated with it,
252 * this structure holds state information for a single file.
255 enum fio_filetype filetype;
258 * A file may not be a file descriptor, let the io engine decide
261 unsigned long file_data;
266 * filename and possible memory mapping
272 * size of the file, offset into file, and io size from that offset
274 unsigned long long real_file_size;
275 unsigned long long file_offset;
276 unsigned long long io_size;
278 unsigned long long last_pos;
279 unsigned long long last_completed_pos;
282 * block map for random io
284 unsigned long *file_map;
285 unsigned int num_maps;
286 unsigned int last_free_lookup;
289 enum fio_file_flags flags;
293 * How many depth levels to log
295 #define FIO_IO_U_MAP_NR 8
296 #define FIO_IO_U_LAT_NR 12
307 struct io_log *slat_log;
308 struct io_log *clat_log;
309 struct io_log *bw_log;
312 * bandwidth and latency stats
314 struct io_stat clat_stat[2]; /* completion latency */
315 struct io_stat slat_stat[2]; /* submission latency */
316 struct io_stat bw_stat[2]; /* bandwidth stats */
318 unsigned long long stat_io_bytes[2];
319 struct timeval stat_sample_time[2];
322 * fio system usage accounting
324 struct rusage ru_start;
325 struct rusage ru_end;
326 unsigned long usr_time;
327 unsigned long sys_time;
331 * IO depth and latency stats
333 unsigned int io_u_map[FIO_IO_U_MAP_NR];
334 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
335 unsigned long total_io_u[2];
336 unsigned long short_io_u[2];
338 unsigned long long io_bytes[2];
339 unsigned long runtime[2];
340 unsigned long total_run_time;
343 struct thread_options {
351 enum td_ddir td_ddir;
352 unsigned int ddir_nr;
353 unsigned int iodepth;
354 unsigned int iodepth_low;
355 unsigned int iodepth_batch;
357 unsigned long long size;
358 unsigned long long file_size_low;
359 unsigned long long file_size_high;
360 unsigned long long start_offset;
363 unsigned int min_bs[2];
364 unsigned int max_bs[2];
366 unsigned int nr_files;
367 unsigned int open_files;
369 unsigned int odirect;
370 unsigned int invalidate_cache;
371 unsigned int create_serialize;
372 unsigned int create_fsync;
373 unsigned int end_fsync;
374 unsigned int sync_io;
376 unsigned int verifysort;
377 unsigned int use_thread;
379 unsigned int do_disk_util;
380 unsigned int override_sync;
381 unsigned int rand_repeatable;
382 unsigned int write_lat_log;
383 unsigned int write_bw_log;
384 unsigned int norandommap;
385 unsigned int bs_unaligned;
386 unsigned int fsync_on_close;
388 unsigned int hugepage_size;
389 unsigned int rw_min_bs;
390 unsigned int thinktime;
391 unsigned int thinktime_spin;
392 unsigned int thinktime_blocks;
393 unsigned int fsync_blocks;
394 unsigned int start_delay;
395 unsigned long timeout;
396 unsigned int overwrite;
397 unsigned int bw_avg_time;
399 unsigned long long zone_size;
400 unsigned long long zone_skip;
401 enum fio_memtype mem_type;
403 unsigned int stonewall;
404 unsigned int new_group;
405 unsigned int numjobs;
406 os_cpu_mask_t cpumask;
408 unsigned int read_iolog;
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;
416 char *read_iolog_file;
417 char *write_iolog_file;
420 * Pre-run and post-run shell
426 unsigned int ratemin;
427 unsigned int ratecycle;
428 unsigned int rate_iops;
429 unsigned int rate_iops_min;
434 * CPU "io" cycle burner
436 unsigned int cpuload;
437 unsigned int cpucycle;
440 #define FIO_VERROR_SIZE 128
443 * This describes a single thread/process executing a fio job.
446 struct thread_options o;
447 char verror[FIO_VERROR_SIZE];
451 struct thread_stat ts;
452 struct fio_file *files;
453 unsigned int files_index;
454 unsigned int nr_open_files;
455 unsigned int nr_done_files;
456 unsigned int nr_normal_files;
458 unsigned int next_file;
459 os_random_state_t next_file_state;
464 size_t orig_buffer_size;
465 volatile int terminate;
466 volatile int runstate;
468 unsigned int last_was_sync;
478 os_random_state_t bsrange_state;
479 os_random_state_t verify_state;
484 * IO engine hooks, contains everything needed to submit an io_u
485 * to any of the available IO engines.
487 struct ioengine_ops *io_ops;
490 * Current IO depth and list of free and busy io_u's.
492 unsigned int cur_depth;
493 struct list_head io_u_freelist;
494 struct list_head io_u_busylist;
495 struct list_head io_u_requeues;
496 unsigned int io_u_queued;
501 unsigned long rate_usec_cycle;
502 long rate_pending_usleep;
503 unsigned long rate_bytes;
504 unsigned long rate_blocks;
505 struct timeval lastrate;
507 unsigned long long total_io_size;
509 unsigned long io_issues[2];
510 unsigned long long io_blocks[2];
511 unsigned long long io_bytes[2];
512 unsigned long long this_io_bytes[2];
513 unsigned long long zone_bytes;
514 struct fio_sem *mutex;
517 * State for random io, a bitmap of blocks done vs not done
519 os_random_state_t random_state;
521 struct timeval start; /* start of this loop */
522 struct timeval epoch; /* time job was started */
523 struct timeval rw_end[2];
524 unsigned int rw_end_set[2];
527 * read/write mixed workload state
529 os_random_state_t rwmix_state;
530 unsigned long long rwmix_bytes;
531 struct timeval rwmix_switch;
532 enum fio_ddir rwmix_ddir;
533 unsigned int ddir_nr;
536 * IO history logs for verification. We use a tree for sorting,
537 * if we are overwriting. Otherwise just use a fifo.
539 struct rb_root io_hist_tree;
540 struct list_head io_hist_list;
545 struct list_head io_log_list;
550 struct timeval timeout_end;
551 struct itimerval timer;
554 * for fileservice, how often to switch to a new file
556 unsigned int file_service_nr;
557 unsigned int file_service_left;
558 struct fio_file *file_service_file;
561 * For generating file sizes
563 os_random_state_t file_size_state;
567 * roundrobin available files, or choose one at random.
570 FIO_FSERVICE_RANDOM = 1,
575 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
576 * the timer on each queue operation.
578 #define IO_U_TIMEOUT_INC 5
579 #define IO_U_TIMEOUT 30
581 #define __td_verror(td, err, msg, func) \
587 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
591 #define td_verror(td, err, func) \
592 __td_verror((td), (err), strerror((err)), (func))
593 #define td_vmsg(td, err, msg, func) \
594 __td_verror((td), (err), (msg), (func))
596 extern int exitall_on_terminate;
597 extern int thread_number;
598 extern int nr_process, nr_thread;
601 extern int terse_output;
604 extern int temp_stall_ts;
605 extern unsigned long long mlock_size;
606 extern unsigned long page_mask, page_size;
608 extern struct thread_data *threads;
610 #define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
611 #define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
612 #define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
613 #define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
615 #define BLOCKS_PER_MAP (8 * sizeof(long))
616 #define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
617 #define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
618 #define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
620 #define MAX_JOBS (1024)
622 static inline int should_fsync(struct thread_data *td)
624 if (td->last_was_sync)
628 if (td_write(td) || td_rw(td) || td->o.override_sync)
635 * Disk utils as read in /sys/block/<dev>/stat
637 struct disk_util_stat {
640 unsigned long long sectors[2];
643 unsigned time_in_queue;
647 * Per-device disk util management
650 struct list_head list;
657 struct disk_util_stat dus;
658 struct disk_util_stat last_dus;
664 #define DISK_UTIL_MSEC (250)
667 #define min(a, b) ((a) < (b) ? (a) : (b))
670 #define max(a, b) ((a) > (b) ? (a) : (b))
676 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
677 extern void write_iolog_put(struct thread_data *, struct io_u *);
678 extern int __must_check init_iolog(struct thread_data *td);
679 extern void log_io_piece(struct thread_data *, struct io_u *);
680 extern void prune_io_piece_log(struct thread_data *);
681 extern void write_iolog_close(struct thread_data *);
686 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
687 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
688 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
689 extern void show_run_stats(void);
690 extern void init_disk_util(struct thread_data *);
691 extern void update_rusage_stat(struct thread_data *);
692 extern void update_io_ticks(void);
693 extern void disk_util_timer_arm(void);
694 extern void setup_log(struct io_log **);
695 extern void finish_log(struct thread_data *, struct io_log *, const char *);
696 extern void __finish_log(struct io_log *, const char *);
697 extern struct io_log *agg_io_log[2];
698 extern int write_bw_log;
699 extern void add_agg_sample(unsigned long, enum fio_ddir);
704 extern unsigned long utime_since(struct timeval *, struct timeval *);
705 extern unsigned long utime_since_now(struct timeval *);
706 extern unsigned long mtime_since(struct timeval *, struct timeval *);
707 extern unsigned long mtime_since_now(struct timeval *);
708 extern unsigned long time_since_now(struct timeval *);
709 extern unsigned long mtime_since_genesis(void);
710 extern void __usec_sleep(unsigned int);
711 extern void usec_sleep(struct thread_data *, unsigned long);
712 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
713 extern void fill_start_time(struct timeval *);
714 extern void fio_gettime(struct timeval *, void *);
715 extern void set_genesis_time(void);
718 * Init/option functions
720 extern int __must_check parse_options(int, char **);
721 extern int fio_option_parse(struct thread_data *, const char *);
722 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
723 extern void fio_fill_default_options(struct thread_data *);
724 extern int fio_show_option_help(const char *);
725 extern void fio_options_dup_and_init(struct option *);
726 extern void options_mem_dupe(struct thread_data *);
727 extern void options_mem_free(struct thread_data *);
728 #define FIO_GETOPT_JOB 0x89988998
729 #define FIO_NR_OPTIONS 128
732 * File setup/shutdown
734 extern void close_files(struct thread_data *);
735 extern int __must_check setup_files(struct thread_data *);
736 extern int __must_check open_files(struct thread_data *);
737 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
738 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
739 extern void generic_close_file(struct thread_data *, struct fio_file *);
740 extern void add_file(struct thread_data *, const char *);
741 extern void get_file(struct fio_file *);
742 extern void put_file(struct thread_data *, struct fio_file *);
743 extern int add_dir_files(struct thread_data *, const char *);
744 extern int init_random_map(struct thread_data *);
745 extern void dup_files(struct thread_data *, struct thread_data *);
750 extern void print_thread_status(void);
751 extern void print_status_init(int);
756 #ifdef FIO_HAVE_DISK_UTIL
757 extern void show_disk_util(void);
758 extern void disk_util_timer_arm(void);
759 extern void init_disk_util(struct thread_data *);
760 extern void update_io_ticks(void);
762 #define show_disk_util()
763 #define disk_util_timer_arm()
764 #define init_disk_util(td)
765 #define update_io_ticks()
769 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
770 * will never back again. It may cycle between running/verififying/fsyncing.
771 * Once the thread reaches TD_EXITED, it is just waiting for the core to
788 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
789 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
790 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
795 extern int __must_check fio_pin_memory(void);
796 extern void fio_unpin_memory(void);
797 extern int __must_check allocate_io_mem(struct thread_data *);
798 extern void free_io_mem(struct thread_data *);
803 #define queue_full(td) list_empty(&(td)->io_u_freelist)
804 extern struct io_u *__get_io_u(struct thread_data *);
805 extern struct io_u *get_io_u(struct thread_data *);
806 extern void put_io_u(struct thread_data *, struct io_u *);
807 extern void requeue_io_u(struct thread_data *, struct io_u **);
808 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
809 extern long __must_check io_u_queued_complete(struct thread_data *, int);
810 extern void io_u_queued(struct thread_data *, struct io_u *);
811 extern void io_u_log_error(struct thread_data *, struct io_u *);
812 extern void io_u_init_timeout(void);
813 extern void io_u_set_timeout(struct thread_data *);
814 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
817 * io engine entry points
819 extern int __must_check td_io_init(struct thread_data *);
820 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
821 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
822 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
823 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
824 extern int __must_check td_io_commit(struct thread_data *);
825 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
826 extern void td_io_close_file(struct thread_data *, struct fio_file *);
829 * If logging output to a file, stderr should go to both stderr and f_err
831 #define log_err(args...) do { \
832 fprintf(f_err, ##args); \
833 if (f_err != stderr) \
834 fprintf(stderr, ##args); \
837 #define log_info(args...) fprintf(f_out, ##args)
839 FILE *get_f_out(void);
840 FILE *get_f_err(void);
842 struct ioengine_ops {
843 struct list_head list;
847 int (*setup)(struct thread_data *);
848 int (*init)(struct thread_data *);
849 int (*prep)(struct thread_data *, struct io_u *);
850 int (*queue)(struct thread_data *, struct io_u *);
851 int (*commit)(struct thread_data *);
852 int (*getevents)(struct thread_data *, int, int, struct timespec *);
853 struct io_u *(*event)(struct thread_data *, int);
854 int (*cancel)(struct thread_data *, struct io_u *);
855 void (*cleanup)(struct thread_data *);
856 int (*open_file)(struct thread_data *, struct fio_file *);
857 void (*close_file)(struct thread_data *, struct fio_file *);
862 #define FIO_IOOPS_VERSION 7
864 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
865 extern void register_ioengine(struct ioengine_ops *);
866 extern void unregister_ioengine(struct ioengine_ops *);
867 extern void close_ioengine(struct thread_data *);
870 * Mark unused variables passed to ops functions as unused, to silence gcc
872 #define fio_unused __attribute((__unused__))
873 #define fio_init __attribute__((constructor))
874 #define fio_exit __attribute__((destructor))
876 #define for_each_td(td, i) \
877 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
878 #define for_each_file(td, f, i) \
879 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
881 #define fio_assert(td, cond) do { \
884 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
885 (td)->runstate = TD_EXITED; \
886 (td)->error = EFAULT; \
891 static inline void clear_error(struct thread_data *td)
894 td->verror[0] = '\0';