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_CPUIO = 1 << 1, /* cpu burner, doesn't do real io */
216 FIO_RAWIO = 1 << 2, /* some sort of direct/raw io */
217 FIO_DISKLESSIO = 1 << 3, /* no disk involved */
221 * Each thread_data structure has a number of files associated with it,
222 * this structure holds state information for a single file.
226 * A file may not be a file descriptor, let the io engine decide
229 unsigned long file_data;
234 unsigned long long file_size;
235 unsigned long long real_file_size;
236 unsigned long long file_offset;
237 unsigned long long last_pos;
238 unsigned long long last_completed_pos;
241 * block map for random io
243 unsigned long *file_map;
244 unsigned int num_maps;
245 unsigned int last_free_lookup;
252 * How many depth levels to log
254 #define FIO_IO_U_MAP_NR 8
255 #define FIO_IO_U_LAT_NR 12
266 struct io_log *slat_log;
267 struct io_log *clat_log;
268 struct io_log *bw_log;
271 * bandwidth and latency stats
273 struct io_stat clat_stat[2]; /* completion latency */
274 struct io_stat slat_stat[2]; /* submission latency */
275 struct io_stat bw_stat[2]; /* bandwidth stats */
277 unsigned long long stat_io_bytes[2];
278 struct timeval stat_sample_time[2];
281 * fio system usage accounting
283 struct rusage ru_start;
284 struct rusage ru_end;
285 unsigned long usr_time;
286 unsigned long sys_time;
290 * IO depth and latency stats
292 unsigned int io_u_map[FIO_IO_U_MAP_NR];
293 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
294 unsigned long total_io_u;
296 unsigned long long io_bytes[2];
297 unsigned long runtime[2];
298 unsigned long total_run_time;
302 * This describes a single thread/process executing a fio job.
314 struct thread_stat ts;
315 enum fio_filetype filetype;
316 struct fio_file *files;
317 unsigned int nr_files;
318 unsigned int nr_open_files;
319 unsigned int nr_uniq_files;
321 unsigned int next_file;
322 os_random_state_t next_file_state;
327 size_t orig_buffer_size;
328 volatile int terminate;
329 volatile int runstate;
330 enum td_ddir td_ddir;
332 unsigned int last_was_sync;
334 unsigned int odirect;
335 unsigned int invalidate_cache;
336 unsigned int create_serialize;
337 unsigned int create_fsync;
338 unsigned int end_fsync;
339 unsigned int sync_io;
341 unsigned int use_thread;
343 unsigned int do_disk_util;
344 unsigned int override_sync;
345 unsigned int rand_repeatable;
346 unsigned int write_lat_log;
347 unsigned int write_bw_log;
348 unsigned int norandommap;
349 unsigned int bs_unaligned;
352 unsigned int min_bs[2];
353 unsigned int max_bs[2];
354 unsigned int hugepage_size;
355 unsigned int rw_min_bs;
356 unsigned int thinktime;
357 unsigned int thinktime_spin;
358 unsigned int thinktime_blocks;
359 unsigned int fsync_blocks;
360 unsigned int start_delay;
361 unsigned long timeout;
362 unsigned int overwrite;
363 unsigned int bw_avg_time;
365 unsigned long long zone_size;
366 unsigned long long zone_skip;
367 enum fio_memtype mem_type;
370 unsigned int stonewall;
371 unsigned int numjobs;
372 unsigned int iodepth;
373 unsigned int iodepth_low;
374 unsigned int iodepth_batch;
375 os_cpu_mask_t cpumask;
377 unsigned int read_iolog;
378 unsigned int rwmixcycle;
379 unsigned int rwmixread;
380 unsigned int rwmixwrite;
382 unsigned int file_service_type;
383 unsigned int group_reporting;
384 unsigned int open_files;
386 char *read_iolog_file;
387 char *write_iolog_file;
394 os_random_state_t bsrange_state;
395 os_random_state_t verify_state;
400 * IO engine hooks, contains everything needed to submit an io_u
401 * to any of the available IO engines.
403 struct ioengine_ops *io_ops;
406 * Current IO depth and list of free and busy io_u's.
408 unsigned int cur_depth;
409 struct list_head io_u_freelist;
410 struct list_head io_u_busylist;
411 struct list_head io_u_requeues;
412 unsigned int io_u_queued;
418 unsigned int ratemin;
419 unsigned int ratecycle;
420 unsigned long rate_usec_cycle;
421 long rate_pending_usleep;
422 unsigned long rate_bytes;
423 struct timeval lastrate;
425 unsigned long long io_size;
426 unsigned long long total_file_size;
427 unsigned long long start_offset;
428 unsigned long long total_io_size;
430 unsigned long io_issues[2];
431 unsigned long long io_blocks[2];
432 unsigned long long io_bytes[2];
433 unsigned long long this_io_bytes[2];
434 unsigned long long zone_bytes;
435 struct fio_sem *mutex;
438 * State for random io, a bitmap of blocks done vs not done
440 os_random_state_t random_state;
443 * CPU "io" cycle burner
445 unsigned int cpuload;
446 unsigned int cpucycle;
448 struct timeval start; /* start of this loop */
449 struct timeval epoch; /* time job was started */
452 * read/write mixed workload state
454 os_random_state_t rwmix_state;
455 struct timeval rwmix_switch;
456 enum fio_ddir rwmix_ddir;
459 * Pre-run and post-run shell
467 struct list_head io_hist_list;
468 struct list_head io_log_list;
473 struct timeval timeout_end;
474 struct itimerval timer;
478 * roundrobin available files, or choose one at random.
481 FIO_FSERVICE_RANDOM = 1,
486 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
487 * the timer on each queue operation.
489 #define IO_U_TIMEOUT_INC 5
490 #define IO_U_TIMEOUT 30
492 #define __td_verror(td, err, msg, func) \
498 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
502 #define td_verror(td, err, func) \
503 __td_verror((td), (err), strerror((err)), (func))
504 #define td_vmsg(td, err, msg, func) \
505 __td_verror((td), (err), (msg), (func))
507 extern int exitall_on_terminate;
508 extern int thread_number;
511 extern int terse_output;
514 extern int temp_stall_ts;
515 extern unsigned long long mlock_size;
517 extern struct thread_data *threads;
519 #define td_read(td) ((td)->td_ddir & TD_DDIR_READ)
520 #define td_write(td) ((td)->td_ddir & TD_DDIR_WRITE)
521 #define td_rw(td) (((td)->td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
522 #define td_random(td) ((td)->td_ddir & TD_DDIR_RAND)
524 #define BLOCKS_PER_MAP (8 * sizeof(long))
525 #define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->rw_min_bs))
526 #define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
527 #define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
529 #define MAX_JOBS (1024)
531 static inline int should_fsync(struct thread_data *td)
533 if (td->last_was_sync)
537 if (td_write(td) || td_rw(td) || td->override_sync)
544 * Disk utils as read in /sys/block/<dev>/stat
546 struct disk_util_stat {
549 unsigned long long sectors[2];
552 unsigned time_in_queue;
556 * Per-device disk util management
559 struct list_head list;
565 struct disk_util_stat dus;
566 struct disk_util_stat last_dus;
572 #define DISK_UTIL_MSEC (250)
575 #define min(a, b) ((a) < (b) ? (a) : (b))
578 #define max(a, b) ((a) > (b) ? (a) : (b))
584 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
585 extern void write_iolog_put(struct thread_data *, struct io_u *);
586 extern int __must_check init_iolog(struct thread_data *td);
587 extern void log_io_piece(struct thread_data *, struct io_u *);
588 extern void prune_io_piece_log(struct thread_data *);
589 extern void write_iolog_close(struct thread_data *);
594 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
595 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
596 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
597 extern void show_run_stats(void);
598 extern void init_disk_util(struct thread_data *);
599 extern void update_rusage_stat(struct thread_data *);
600 extern void update_io_ticks(void);
601 extern void disk_util_timer_arm(void);
602 extern void setup_log(struct io_log **);
603 extern void finish_log(struct thread_data *, struct io_log *, const char *);
604 extern void __finish_log(struct io_log *, const char *);
605 extern int setup_rate(struct thread_data *);
606 extern struct io_log *agg_io_log[2];
607 extern int write_bw_log;
608 extern void add_agg_sample(unsigned long, enum fio_ddir);
613 extern unsigned long utime_since(struct timeval *, struct timeval *);
614 extern unsigned long utime_since_now(struct timeval *);
615 extern unsigned long mtime_since(struct timeval *, struct timeval *);
616 extern unsigned long mtime_since_now(struct timeval *);
617 extern unsigned long time_since_now(struct timeval *);
618 extern unsigned long mtime_since_genesis(void);
619 extern void __usec_sleep(unsigned int);
620 extern void usec_sleep(struct thread_data *, unsigned long);
621 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
622 extern void fill_start_time(struct timeval *);
623 extern void fio_gettime(struct timeval *, void *);
624 extern void set_genesis_time(void);
629 extern int __must_check parse_options(int, char **);
630 extern int __must_check init_random_state(struct thread_data *);
633 * File setup/shutdown
635 extern void close_files(struct thread_data *);
636 extern int __must_check setup_files(struct thread_data *);
637 extern int __must_check open_files(struct thread_data *);
638 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
639 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
640 extern void generic_close_file(struct thread_data *, struct fio_file *);
645 extern void print_thread_status(void);
646 extern void print_status_init(int);
649 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
650 * will never back again. It may cycle between running/verififying/fsyncing.
651 * Once the thread reaches TD_EXITED, it is just waiting for the core to
668 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
669 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
670 extern int __must_check verify_io_u(struct io_u *);
675 extern int __must_check fio_pin_memory(void);
676 extern void fio_unpin_memory(void);
677 extern int __must_check allocate_io_mem(struct thread_data *);
678 extern void free_io_mem(struct thread_data *);
683 #define queue_full(td) list_empty(&(td)->io_u_freelist)
684 extern struct io_u *__get_io_u(struct thread_data *);
685 extern struct io_u *get_io_u(struct thread_data *);
686 extern void put_io_u(struct thread_data *, struct io_u *);
687 extern void requeue_io_u(struct thread_data *, struct io_u **);
688 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
689 extern long __must_check io_u_queued_complete(struct thread_data *, int);
690 extern void io_u_queued(struct thread_data *, struct io_u *);
691 extern void io_u_log_error(struct thread_data *, struct io_u *);
692 extern void io_u_init_timeout(void);
693 extern void io_u_set_timeout(struct thread_data *);
696 * io engine entry points
698 extern int __must_check td_io_init(struct thread_data *);
699 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
700 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
701 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
702 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
703 extern int __must_check td_io_commit(struct thread_data *);
704 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
705 extern void td_io_close_file(struct thread_data *, struct fio_file *);
708 * If logging output to a file, stderr should go to both stderr and f_err
710 #define log_err(args...) do { \
711 fprintf(f_err, ##args); \
712 if (f_err != stderr) \
713 fprintf(stderr, ##args); \
716 FILE *get_f_out(void);
717 FILE *get_f_err(void);
719 struct ioengine_ops {
720 struct list_head list;
724 int (*setup)(struct thread_data *);
725 int (*init)(struct thread_data *);
726 int (*prep)(struct thread_data *, struct io_u *);
727 int (*queue)(struct thread_data *, struct io_u *);
728 int (*commit)(struct thread_data *);
729 int (*getevents)(struct thread_data *, int, int, struct timespec *);
730 struct io_u *(*event)(struct thread_data *, int);
731 int (*cancel)(struct thread_data *, struct io_u *);
732 void (*cleanup)(struct thread_data *);
733 int (*open_file)(struct thread_data *, struct fio_file *);
734 void (*close_file)(struct thread_data *, struct fio_file *);
739 #define FIO_IOOPS_VERSION 6
741 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
742 extern void register_ioengine(struct ioengine_ops *);
743 extern void unregister_ioengine(struct ioengine_ops *);
744 extern void close_ioengine(struct thread_data *);
747 * Mark unused variables passed to ops functions as unused, to silence gcc
749 #define fio_unused __attribute((__unused__))
750 #define fio_init __attribute__((constructor))
751 #define fio_exit __attribute__((destructor))
753 #define for_each_td(td, i) \
754 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
755 #define for_each_file(td, f, i) \
756 for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->open_files; (i)++, (f)++)
758 #define fio_assert(td, cond) do { \
761 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
762 (td)->runstate = TD_EXITED; \
763 (td)->error = EFAULT; \