8 #include <sys/resource.h>
22 #ifdef FIO_HAVE_SYSLET
33 TD_DDIR_READ = 1 << 0,
34 TD_DDIR_WRITE = 1 << 1,
35 TD_DDIR_RAND = 1 << 2,
36 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
37 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
38 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
39 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
43 * Use for maintaining statistics
46 unsigned long max_val;
47 unsigned long min_val;
48 unsigned long samples;
55 * A single data sample
64 * Dynamically growing data sample log
67 unsigned long nr_samples;
68 unsigned long max_samples;
69 struct io_sample *log;
73 * When logging io actions, this matches a single sent io_u
76 struct list_head list;
77 struct fio_file *file;
78 unsigned long long offset;
83 #ifdef FIO_HAVE_SYSLET
85 struct syslet_uatom atom; /* the atom to submit */
86 struct syslet_uatom *head; /* head of the sequence */
87 long ret; /* syscall return value */
93 IO_U_F_FLIGHT = 1 << 1,
101 #ifdef FIO_HAVE_LIBAIO
104 #ifdef FIO_HAVE_POSIXAIO
108 struct sg_io_hdr hdr;
110 #ifdef FIO_HAVE_SYSLET
111 struct syslet_req req;
114 struct timeval start_time;
115 struct timeval issue_time;
118 * Allocated/set buffer and length
121 unsigned long buflen;
122 unsigned long long offset;
125 * IO engine state, may be different from above when we get
126 * partial transfers / residual data counts
129 unsigned long xfer_buflen;
137 * io engine private data
146 struct fio_file *file;
148 struct list_head list;
151 * Callback for io completion
153 int (*end_io)(struct io_u *);
157 * io_ops->queue() return values
160 FIO_Q_COMPLETED = 0, /* completed sync */
161 FIO_Q_QUEUED = 1, /* queued, will complete async */
162 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
165 #define FIO_HDR_MAGIC 0xf00baaef
168 VERIFY_NONE = 0, /* no verification */
169 VERIFY_MD5, /* md5 sum data blocks */
170 VERIFY_CRC32, /* crc32 sum data blocks */
174 * A header structure associated with each checksummed data block
176 struct verify_header {
177 unsigned int fio_magic;
179 unsigned int verify_type;
181 char md5_digest[MD5_HASH_WORDS * 4];
186 struct group_run_stats {
187 unsigned long long max_run[2], min_run[2];
188 unsigned long long max_bw[2], min_bw[2];
189 unsigned long long io_kb[2];
190 unsigned long long agg[2];
194 * What type of allocation to use for io buffers
197 MEM_MALLOC = 0, /* ordinary malloc */
198 MEM_SHM, /* use shared memory segments */
199 MEM_SHMHUGE, /* use shared memory segments with huge pages */
200 MEM_MMAP, /* use anonynomous mmap */
201 MEM_MMAPHUGE, /* memory mapped huge file */
205 * The type of object we are working on
208 FIO_TYPE_FILE = 1, /* plain file */
209 FIO_TYPE_BD, /* block device */
210 FIO_TYPE_CHAR, /* character device */
213 enum fio_ioengine_flags {
214 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
215 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
216 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
217 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
218 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
222 * Each thread_data structure has a number of files associated with it,
223 * this structure holds state information for a single file.
226 enum fio_filetype filetype;
229 * A file may not be a file descriptor, let the io engine decide
232 unsigned long file_data;
235 const char *file_name;
237 unsigned long long file_size;
238 unsigned long long real_file_size;
239 unsigned long long file_offset;
240 unsigned long long last_pos;
241 unsigned long long last_completed_pos;
244 * block map for random io
246 unsigned long *file_map;
247 unsigned int num_maps;
248 unsigned int last_free_lookup;
255 * How many depth levels to log
257 #define FIO_IO_U_MAP_NR 8
258 #define FIO_IO_U_LAT_NR 12
269 struct io_log *slat_log;
270 struct io_log *clat_log;
271 struct io_log *bw_log;
274 * bandwidth and latency stats
276 struct io_stat clat_stat[2]; /* completion latency */
277 struct io_stat slat_stat[2]; /* submission latency */
278 struct io_stat bw_stat[2]; /* bandwidth stats */
280 unsigned long long stat_io_bytes[2];
281 struct timeval stat_sample_time[2];
284 * fio system usage accounting
286 struct rusage ru_start;
287 struct rusage ru_end;
288 unsigned long usr_time;
289 unsigned long sys_time;
293 * IO depth and latency stats
295 unsigned int io_u_map[FIO_IO_U_MAP_NR];
296 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
297 unsigned long total_io_u[2];
299 unsigned long long io_bytes[2];
300 unsigned long runtime[2];
301 unsigned long total_run_time;
305 * This describes a single thread/process executing a fio job.
318 struct thread_stat ts;
319 struct fio_file *files;
320 unsigned int nr_files;
321 unsigned int nr_open_files;
322 unsigned int nr_uniq_files;
324 unsigned int next_file;
325 os_random_state_t next_file_state;
330 size_t orig_buffer_size;
331 volatile int terminate;
332 volatile int runstate;
333 enum td_ddir td_ddir;
335 unsigned int last_was_sync;
337 unsigned int odirect;
338 unsigned int invalidate_cache;
339 unsigned int create_serialize;
340 unsigned int create_fsync;
341 unsigned int end_fsync;
342 unsigned int sync_io;
344 unsigned int use_thread;
346 unsigned int do_disk_util;
347 unsigned int override_sync;
348 unsigned int rand_repeatable;
349 unsigned int write_lat_log;
350 unsigned int write_bw_log;
351 unsigned int norandommap;
352 unsigned int bs_unaligned;
355 unsigned int min_bs[2];
356 unsigned int max_bs[2];
357 unsigned int hugepage_size;
358 unsigned int rw_min_bs;
359 unsigned int thinktime;
360 unsigned int thinktime_spin;
361 unsigned int thinktime_blocks;
362 unsigned int fsync_blocks;
363 unsigned int start_delay;
364 unsigned long timeout;
365 unsigned int overwrite;
366 unsigned int bw_avg_time;
368 unsigned long long zone_size;
369 unsigned long long zone_skip;
370 enum fio_memtype mem_type;
373 unsigned int stonewall;
374 unsigned int numjobs;
375 unsigned int iodepth;
376 unsigned int iodepth_low;
377 unsigned int iodepth_batch;
378 os_cpu_mask_t cpumask;
380 unsigned int read_iolog;
381 unsigned int rwmixcycle;
382 unsigned int rwmixread;
383 unsigned int rwmixwrite;
385 unsigned int file_service_type;
386 unsigned int group_reporting;
387 unsigned int open_files;
389 char *read_iolog_file;
390 char *write_iolog_file;
397 os_random_state_t bsrange_state;
398 os_random_state_t verify_state;
403 * IO engine hooks, contains everything needed to submit an io_u
404 * to any of the available IO engines.
406 struct ioengine_ops *io_ops;
409 * Current IO depth and list of free and busy io_u's.
411 unsigned int cur_depth;
412 struct list_head io_u_freelist;
413 struct list_head io_u_busylist;
414 struct list_head io_u_requeues;
415 unsigned int io_u_queued;
421 unsigned int ratemin;
422 unsigned int ratecycle;
423 unsigned long rate_usec_cycle;
424 long rate_pending_usleep;
425 unsigned long rate_bytes;
426 struct timeval lastrate;
428 unsigned long long io_size;
429 unsigned long long total_file_size;
430 unsigned long long start_offset;
431 unsigned long long total_io_size;
433 unsigned long io_issues[2];
434 unsigned long long io_blocks[2];
435 unsigned long long io_bytes[2];
436 unsigned long long this_io_bytes[2];
437 unsigned long long zone_bytes;
438 struct fio_sem *mutex;
441 * State for random io, a bitmap of blocks done vs not done
443 os_random_state_t random_state;
446 * CPU "io" cycle burner
448 unsigned int cpuload;
449 unsigned int cpucycle;
451 struct timeval start; /* start of this loop */
452 struct timeval epoch; /* time job was started */
455 * read/write mixed workload state
457 os_random_state_t rwmix_state;
458 struct timeval rwmix_switch;
459 enum fio_ddir rwmix_ddir;
462 * Pre-run and post-run shell
470 struct list_head io_hist_list;
471 struct list_head io_log_list;
476 struct timeval timeout_end;
477 struct itimerval timer;
480 * for fileservice, how often to switch to a new file
482 unsigned int file_service_nr;
483 unsigned int file_service_left;
484 struct fio_file *file_service_file;
488 * roundrobin available files, or choose one at random.
491 FIO_FSERVICE_RANDOM = 1,
496 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
497 * the timer on each queue operation.
499 #define IO_U_TIMEOUT_INC 5
500 #define IO_U_TIMEOUT 30
502 #define __td_verror(td, err, msg, func) \
508 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
512 #define td_verror(td, err, func) \
513 __td_verror((td), (err), strerror((err)), (func))
514 #define td_vmsg(td, err, msg, func) \
515 __td_verror((td), (err), (msg), (func))
517 extern int exitall_on_terminate;
518 extern int thread_number;
519 extern int nr_process, nr_thread;
522 extern int terse_output;
525 extern int temp_stall_ts;
526 extern unsigned long long mlock_size;
528 extern struct thread_data *threads;
530 #define td_read(td) ((td)->td_ddir & TD_DDIR_READ)
531 #define td_write(td) ((td)->td_ddir & TD_DDIR_WRITE)
532 #define td_rw(td) (((td)->td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
533 #define td_random(td) ((td)->td_ddir & TD_DDIR_RAND)
535 #define BLOCKS_PER_MAP (8 * sizeof(long))
536 #define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->rw_min_bs))
537 #define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
538 #define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
540 #define MAX_JOBS (1024)
542 static inline int should_fsync(struct thread_data *td)
544 if (td->last_was_sync)
548 if (td_write(td) || td_rw(td) || td->override_sync)
555 * Disk utils as read in /sys/block/<dev>/stat
557 struct disk_util_stat {
560 unsigned long long sectors[2];
563 unsigned time_in_queue;
567 * Per-device disk util management
570 struct list_head list;
576 struct disk_util_stat dus;
577 struct disk_util_stat last_dus;
583 #define DISK_UTIL_MSEC (250)
586 #define min(a, b) ((a) < (b) ? (a) : (b))
589 #define max(a, b) ((a) > (b) ? (a) : (b))
595 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
596 extern void write_iolog_put(struct thread_data *, struct io_u *);
597 extern int __must_check init_iolog(struct thread_data *td);
598 extern void log_io_piece(struct thread_data *, struct io_u *);
599 extern void prune_io_piece_log(struct thread_data *);
600 extern void write_iolog_close(struct thread_data *);
605 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
606 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
607 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
608 extern void show_run_stats(void);
609 extern void init_disk_util(struct thread_data *);
610 extern void update_rusage_stat(struct thread_data *);
611 extern void update_io_ticks(void);
612 extern void disk_util_timer_arm(void);
613 extern void setup_log(struct io_log **);
614 extern void finish_log(struct thread_data *, struct io_log *, const char *);
615 extern void __finish_log(struct io_log *, const char *);
616 extern int setup_rate(struct thread_data *);
617 extern struct io_log *agg_io_log[2];
618 extern int write_bw_log;
619 extern void add_agg_sample(unsigned long, enum fio_ddir);
624 extern unsigned long utime_since(struct timeval *, struct timeval *);
625 extern unsigned long utime_since_now(struct timeval *);
626 extern unsigned long mtime_since(struct timeval *, struct timeval *);
627 extern unsigned long mtime_since_now(struct timeval *);
628 extern unsigned long time_since_now(struct timeval *);
629 extern unsigned long mtime_since_genesis(void);
630 extern void __usec_sleep(unsigned int);
631 extern void usec_sleep(struct thread_data *, unsigned long);
632 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
633 extern void fill_start_time(struct timeval *);
634 extern void fio_gettime(struct timeval *, void *);
635 extern void set_genesis_time(void);
640 extern int __must_check parse_options(int, char **);
641 extern int __must_check init_random_state(struct thread_data *);
644 * File setup/shutdown
646 extern void close_files(struct thread_data *);
647 extern int __must_check setup_files(struct thread_data *);
648 extern int __must_check open_files(struct thread_data *);
649 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
650 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
651 extern void generic_close_file(struct thread_data *, struct fio_file *);
652 extern void add_file(struct thread_data *, const char *);
657 extern void print_thread_status(void);
658 extern void print_status_init(int);
661 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
662 * will never back again. It may cycle between running/verififying/fsyncing.
663 * Once the thread reaches TD_EXITED, it is just waiting for the core to
680 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
681 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
682 extern int __must_check verify_io_u(struct io_u *);
687 extern int __must_check fio_pin_memory(void);
688 extern void fio_unpin_memory(void);
689 extern int __must_check allocate_io_mem(struct thread_data *);
690 extern void free_io_mem(struct thread_data *);
695 #define queue_full(td) list_empty(&(td)->io_u_freelist)
696 extern struct io_u *__get_io_u(struct thread_data *);
697 extern struct io_u *get_io_u(struct thread_data *);
698 extern void put_io_u(struct thread_data *, struct io_u *);
699 extern void requeue_io_u(struct thread_data *, struct io_u **);
700 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
701 extern long __must_check io_u_queued_complete(struct thread_data *, int);
702 extern void io_u_queued(struct thread_data *, struct io_u *);
703 extern void io_u_log_error(struct thread_data *, struct io_u *);
704 extern void io_u_init_timeout(void);
705 extern void io_u_set_timeout(struct thread_data *);
706 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
709 * io engine entry points
711 extern int __must_check td_io_init(struct thread_data *);
712 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
713 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
714 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
715 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
716 extern int __must_check td_io_commit(struct thread_data *);
717 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
718 extern void td_io_close_file(struct thread_data *, struct fio_file *);
721 * If logging output to a file, stderr should go to both stderr and f_err
723 #define log_err(args...) do { \
724 fprintf(f_err, ##args); \
725 if (f_err != stderr) \
726 fprintf(stderr, ##args); \
729 FILE *get_f_out(void);
730 FILE *get_f_err(void);
732 struct ioengine_ops {
733 struct list_head list;
737 int (*setup)(struct thread_data *);
738 int (*init)(struct thread_data *);
739 int (*prep)(struct thread_data *, struct io_u *);
740 int (*queue)(struct thread_data *, struct io_u *);
741 int (*commit)(struct thread_data *);
742 int (*getevents)(struct thread_data *, int, int, struct timespec *);
743 struct io_u *(*event)(struct thread_data *, int);
744 int (*cancel)(struct thread_data *, struct io_u *);
745 void (*cleanup)(struct thread_data *);
746 int (*open_file)(struct thread_data *, struct fio_file *);
747 void (*close_file)(struct thread_data *, struct fio_file *);
752 #define FIO_IOOPS_VERSION 6
754 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
755 extern void register_ioengine(struct ioengine_ops *);
756 extern void unregister_ioengine(struct ioengine_ops *);
757 extern void close_ioengine(struct thread_data *);
760 * Mark unused variables passed to ops functions as unused, to silence gcc
762 #define fio_unused __attribute((__unused__))
763 #define fio_init __attribute__((constructor))
764 #define fio_exit __attribute__((destructor))
766 #define for_each_td(td, i) \
767 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
768 #define for_each_file(td, f, i) \
769 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->open_files; (i)++, (f)++)
771 #define fio_assert(td, cond) do { \
774 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
775 (td)->runstate = TD_EXITED; \
776 (td)->error = EFAULT; \