8 #include <sys/resource.h>
19 #include "compiler/compiler.h"
23 #include "arch/arch.h"
36 #include "lib/getopt.h"
44 #ifdef FIO_HAVE_SOLARISAIO
45 #include <sys/asynch.h>
48 struct group_run_stats {
49 uint64_t max_run[2], min_run[2];
50 uint64_t max_bw[2], min_bw[2];
57 * What type of allocation to use for io buffers
60 MEM_MALLOC = 0, /* ordinary malloc */
61 MEM_SHM, /* use shared memory segments */
62 MEM_SHMHUGE, /* use shared memory segments with huge pages */
63 MEM_MMAP, /* use anonynomous mmap */
64 MEM_MMAPHUGE, /* memory mapped huge file */
68 * offset generator types
76 * How many depth levels to log
78 #define FIO_IO_U_MAP_NR 7
79 #define FIO_IO_U_LAT_U_NR 10
80 #define FIO_IO_U_LAT_M_NR 12
83 * Aggregate clat samples to report percentile(s) of them.
87 * FIO_IO_U_PLAT_BITS determines the maximum statistical error on the
88 * value of resulting percentiles. The error will be approximately
89 * 1/2^(FIO_IO_U_PLAT_BITS+1) of the value.
91 * FIO_IO_U_PLAT_GROUP_NR and FIO_IO_U_PLAT_BITS determine the maximum
92 * range being tracked for latency samples. The maximum value tracked
93 * accurately will be 2^(GROUP_NR + PLAT_BITS -1) microseconds.
95 * FIO_IO_U_PLAT_GROUP_NR and FIO_IO_U_PLAT_BITS determine the memory
96 * requirement of storing those aggregate counts. The memory used will
97 * be (FIO_IO_U_PLAT_GROUP_NR * 2^FIO_IO_U_PLAT_BITS) * sizeof(int)
100 * FIO_IO_U_PLAT_NR is the total number of buckets.
104 * Suppose the clat varies from 0 to 999 (usec), the straightforward
105 * method is to keep an array of (999 + 1) buckets, in which a counter
106 * keeps the count of samples which fall in the bucket, e.g.,
107 * {[0],[1],...,[999]}. However this consumes a huge amount of space,
108 * and can be avoided if an approximation is acceptable.
110 * One such method is to let the range of the bucket to be greater
111 * than one. This method has low accuracy when the value is small. For
112 * example, let the buckets be {[0,99],[100,199],...,[900,999]}, and
113 * the represented value of each bucket be the mean of the range. Then
114 * a value 0 has an round-off error of 49.5. To improve on this, we
115 * use buckets with non-uniform ranges, while bounding the error of
116 * each bucket within a ratio of the sample value. A simple example
117 * would be when error_bound = 0.005, buckets are {
118 * {[0],[1],...,[99]}, {[100,101],[102,103],...,[198,199]},..,
119 * {[900,909],[910,919]...} }. The total range is partitioned into
120 * groups with different ranges, then buckets with uniform ranges. An
121 * upper bound of the error is (range_of_bucket/2)/value_of_bucket
123 * For better efficiency, we implement this using base two. We group
124 * samples by their Most Significant Bit (MSB), extract the next M bit
125 * of them as an index within the group, and discard the rest of the
128 * E.g., assume a sample 'x' whose MSB is bit n (starting from bit 0),
129 * and use M bit for indexing
131 * | n | M bits | bit (n-M-1) ... bit 0 |
133 * Because x is at least 2^n, and bit 0 to bit (n-M-1) is at most
134 * (2^(n-M) - 1), discarding bit 0 to (n-M-1) makes the round-off
137 * 2^(n-M)-1 2^(n-M) 1
138 * e <= --------- <= ------- = ---
141 * Furthermore, we use "mean" of the range to represent the bucket,
142 * the error e can be lowered by half to 1 / 2^(M+1). By using M bits
143 * as the index, each group must contains 2^M buckets.
145 * E.g. Let M (FIO_IO_U_PLAT_BITS) be 6
146 * Error bound is 1/2^(6+1) = 0.0078125 (< 1%)
148 * Group MSB #discarded range of #buckets
150 * ----------------------------------------------------------------
155 * 4 9 3 [512,1023] 64
156 * ... ... ... [...,...] ...
157 * 18 23 17 [8838608,+inf]** 64
159 * * Special cases: when n < (M-1) or when n == (M-1), in both cases,
160 * the value cannot be rounded off. Use all bits of the sample as
163 * ** If a sample's MSB is greater than 23, it will be counted as 23.
166 #define FIO_IO_U_PLAT_BITS 6
167 #define FIO_IO_U_PLAT_VAL (1 << FIO_IO_U_PLAT_BITS)
168 #define FIO_IO_U_PLAT_GROUP_NR 19
169 #define FIO_IO_U_PLAT_NR (FIO_IO_U_PLAT_GROUP_NR * FIO_IO_U_PLAT_VAL)
170 #define FIO_IO_U_LIST_MAX_LEN 20 /* The size of the default and user-specified
171 list of percentiles */
173 #define MAX_PATTERN_SIZE 512
174 #define FIO_JOBNAME_SIZE 128
175 #define FIO_VERROR_SIZE 128
178 char name[FIO_JOBNAME_SIZE];
179 char verror[FIO_VERROR_SIZE];
183 char description[FIO_JOBNAME_SIZE];
187 * bandwidth and latency stats
189 struct io_stat clat_stat[2]; /* completion latency */
190 struct io_stat slat_stat[2]; /* submission latency */
191 struct io_stat lat_stat[2]; /* total latency */
192 struct io_stat bw_stat[2]; /* bandwidth stats */
195 * fio system usage accounting
203 * IO depth and latency stats
205 uint64_t clat_percentiles;
206 double *percentile_list;
208 uint32_t io_u_map[FIO_IO_U_MAP_NR];
209 uint32_t io_u_submit[FIO_IO_U_MAP_NR];
210 uint32_t io_u_complete[FIO_IO_U_MAP_NR];
211 uint32_t io_u_lat_u[FIO_IO_U_LAT_U_NR];
212 uint32_t io_u_lat_m[FIO_IO_U_LAT_M_NR];
213 uint32_t io_u_plat[2][FIO_IO_U_PLAT_NR];
214 uint64_t total_io_u[3];
215 uint64_t short_io_u[3];
216 uint64_t total_submit;
217 uint64_t total_complete;
219 uint64_t io_bytes[2];
221 uint64_t total_run_time;
224 * IO Error related stats
226 uint16_t continue_on_error;
227 uint64_t total_err_count;
238 struct thread_options {
246 enum td_ddir td_ddir;
248 unsigned int kb_base;
249 unsigned int ddir_seq_nr;
251 unsigned int iodepth;
252 unsigned int iodepth_low;
253 unsigned int iodepth_batch;
254 unsigned int iodepth_batch_complete;
256 unsigned long long size;
257 unsigned int size_percent;
258 unsigned int fill_device;
259 unsigned long long file_size_low;
260 unsigned long long file_size_high;
261 unsigned long long start_offset;
265 unsigned int min_bs[2];
266 unsigned int max_bs[2];
267 struct bssplit *bssplit[2];
268 unsigned int bssplit_nr[2];
270 unsigned int nr_files;
271 unsigned int open_files;
272 enum file_lock_mode file_lock_mode;
273 unsigned int lockfile_batch;
275 unsigned int odirect;
276 unsigned int invalidate_cache;
277 unsigned int create_serialize;
278 unsigned int create_fsync;
279 unsigned int create_on_open;
280 unsigned int end_fsync;
281 unsigned int pre_read;
282 unsigned int sync_io;
284 unsigned int do_verify;
285 unsigned int verifysort;
286 unsigned int verify_interval;
287 unsigned int verify_offset;
288 char verify_pattern[MAX_PATTERN_SIZE];
289 unsigned int verify_pattern_bytes;
290 unsigned int verify_fatal;
291 unsigned int verify_dump;
292 unsigned int verify_async;
293 unsigned long long verify_backlog;
294 unsigned int verify_batch;
295 unsigned int use_thread;
297 unsigned int do_disk_util;
298 unsigned int override_sync;
299 unsigned int rand_repeatable;
300 unsigned int use_os_rand;
301 unsigned int write_lat_log;
302 unsigned int write_bw_log;
303 unsigned int norandommap;
304 unsigned int softrandommap;
305 unsigned int bs_unaligned;
306 unsigned int fsync_on_close;
308 unsigned int hugepage_size;
309 unsigned int rw_min_bs;
310 unsigned int thinktime;
311 unsigned int thinktime_spin;
312 unsigned int thinktime_blocks;
313 unsigned int fsync_blocks;
314 unsigned int fdatasync_blocks;
315 unsigned int barrier_blocks;
316 unsigned long long start_delay;
317 unsigned long long timeout;
318 unsigned long long ramp_time;
319 unsigned int overwrite;
320 unsigned int bw_avg_time;
322 unsigned long long zone_size;
323 unsigned long long zone_skip;
324 enum fio_memtype mem_type;
325 unsigned int mem_align;
327 unsigned int stonewall;
328 unsigned int new_group;
329 unsigned int numjobs;
330 os_cpu_mask_t cpumask;
331 unsigned int cpumask_set;
332 os_cpu_mask_t verify_cpumask;
333 unsigned int verify_cpumask_set;
335 unsigned int rwmixcycle;
336 unsigned int rwmix[2];
338 unsigned int file_service_type;
339 unsigned int group_reporting;
340 unsigned int fadvise_hint;
341 enum fio_fallocate_mode fallocate_mode;
342 unsigned int zero_buffers;
343 unsigned int refill_buffers;
344 unsigned int scramble_buffers;
345 unsigned int time_based;
346 unsigned int disable_lat;
347 unsigned int disable_clat;
348 unsigned int disable_slat;
349 unsigned int disable_bw;
350 unsigned int gtod_reduce;
351 unsigned int gtod_cpu;
352 unsigned int gtod_offload;
353 enum fio_cs clocksource;
354 unsigned int no_stall;
355 unsigned int trim_percentage;
356 unsigned int trim_batch;
357 unsigned int trim_zero;
358 unsigned long long trim_backlog;
359 unsigned int clat_percentiles;
360 unsigned int overwrite_plist;
361 double percentile_list[FIO_IO_U_LIST_MAX_LEN];
363 char *read_iolog_file;
364 char *write_iolog_file;
367 char *replay_redirect;
370 * Pre-run and post-run shell
375 unsigned int rate[2];
376 unsigned int ratemin[2];
377 unsigned int ratecycle;
378 unsigned int rate_iops[2];
379 unsigned int rate_iops_min[2];
384 * CPU "io" cycle burner
386 unsigned int cpuload;
387 unsigned int cpucycle;
392 unsigned int continue_on_error;
395 * Benchmark profile type
400 * blkio cgroup support
403 unsigned int cgroup_weight;
404 unsigned int cgroup_nodelete;
409 unsigned int sync_file_range;
411 unsigned int userspace_libaio_reap;
415 * This describes a single thread/process executing a fio job.
418 struct thread_options o;
419 char verror[FIO_VERROR_SIZE];
423 struct thread_stat ts;
425 struct io_log *slat_log;
426 struct io_log *clat_log;
427 struct io_log *lat_log;
428 struct io_log *bw_log;
430 uint64_t stat_io_bytes[2];
431 struct timeval stat_sample_time[2];
433 struct rusage ru_start;
434 struct rusage ru_end;
436 struct fio_file **files;
437 unsigned int files_size;
438 unsigned int files_index;
439 unsigned int nr_open_files;
440 unsigned int nr_done_files;
441 unsigned int nr_normal_files;
443 unsigned int next_file;
444 os_random_state_t next_file_state;
445 struct frand_state __next_file_state;
451 size_t orig_buffer_size;
452 volatile int terminate;
453 volatile int runstate;
455 unsigned int ioprio_set;
456 unsigned int last_was_sync;
457 enum fio_ddir last_ddir;
467 unsigned long rand_seeds[8];
470 os_random_state_t bsrange_state;
471 struct frand_state __bsrange_state;
474 os_random_state_t verify_state;
475 struct frand_state __verify_state;
478 os_random_state_t trim_state;
479 struct frand_state __trim_state;
482 struct frand_state buf_state;
484 unsigned int verify_batch;
485 unsigned int trim_batch;
490 * IO engine hooks, contains everything needed to submit an io_u
491 * to any of the available IO engines.
493 struct ioengine_ops *io_ops;
496 * Current IO depth and list of free and busy io_u's.
498 unsigned int cur_depth;
499 unsigned int io_u_queued;
500 struct flist_head io_u_freelist;
501 struct flist_head io_u_busylist;
502 struct flist_head io_u_requeues;
503 pthread_mutex_t io_u_lock;
504 pthread_cond_t free_cond;
507 * async verify offload
509 struct flist_head verify_list;
510 pthread_t *verify_threads;
511 unsigned int nr_verify_threads;
512 pthread_cond_t verify_cond;
513 int verify_thread_exit;
518 unsigned long rate_nsec_cycle[2];
519 long rate_pending_usleep[2];
520 unsigned long rate_bytes[2];
521 unsigned long rate_blocks[2];
522 struct timeval lastrate[2];
524 unsigned long long total_io_size;
525 unsigned long long fill_device_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_mutex *mutex;
536 * State for random io, a bitmap of blocks done vs not done
539 os_random_state_t random_state;
540 struct frand_state __random_state;
543 struct timeval start; /* start of this loop */
544 struct timeval epoch; /* time job was started */
545 struct timeval last_issue;
546 struct timeval tv_cache;
547 unsigned int tv_cache_nr;
548 unsigned int tv_cache_mask;
549 unsigned int ramp_time_over;
552 * read/write mixed workload state
555 os_random_state_t rwmix_state;
556 struct frand_state __rwmix_state;
558 unsigned long rwmix_issues;
559 enum fio_ddir rwmix_ddir;
560 unsigned int ddir_seq_nr;
563 * IO history logs for verification. We use a tree for sorting,
564 * if we are overwriting. Otherwise just use a fifo.
566 struct rb_root io_hist_tree;
567 struct flist_head io_hist_list;
568 unsigned long io_hist_len;
573 struct flist_head io_log_list;
576 * For tracking/handling discards
578 struct flist_head trim_list;
579 unsigned long trim_entries;
582 * for fileservice, how often to switch to a new file
584 unsigned int file_service_nr;
585 unsigned int file_service_left;
586 struct fio_file *file_service_file;
588 unsigned int sync_file_range_nr;
591 * For generating file sizes
594 os_random_state_t file_size_state;
595 struct frand_state __file_size_state;
601 unsigned int total_err_count;
605 * Can be overloaded by profiles
607 struct prof_io_ops prof_io_ops;
612 * when should interactive ETA output be generated
620 #define __td_verror(td, err, msg, func) \
626 if (!(td)->first_error) \
627 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
631 #define td_clear_error(td) \
633 #define td_verror(td, err, func) \
634 __td_verror((td), (err), strerror((err)), (func))
635 #define td_vmsg(td, err, msg, func) \
636 __td_verror((td), (err), (msg), (func))
638 extern int exitall_on_terminate;
639 extern int thread_number;
640 extern int nr_process, nr_thread;
643 extern int terse_output;
644 extern int temp_stall_ts;
645 extern unsigned long long mlock_size;
646 extern unsigned long page_mask, page_size;
647 extern int read_only;
648 extern int eta_print;
649 extern unsigned long done_secs;
650 extern char *job_section;
651 extern int fio_gtod_offload;
652 extern int fio_gtod_cpu;
653 extern enum fio_cs fio_clock_source;
654 extern int warnings_fatal;
655 extern int terse_version;
656 extern int is_backend;
657 extern int nr_clients;
658 extern int log_syslog;
660 extern struct thread_data *threads;
662 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
664 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
667 #define BLOCKS_PER_MAP (8 * sizeof(unsigned long))
668 #define TO_MAP_BLOCK(f, b) (b)
669 #define RAND_MAP_IDX(f, b) (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
670 #define RAND_MAP_BIT(f, b) (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
672 #define REAL_MAX_JOBS 2048
674 #define td_non_fatal_error(e) ((e) == EIO || (e) == EILSEQ)
676 static inline void update_error_count(struct thread_data *td, int err)
678 td->total_err_count++;
679 if (td->total_err_count == 1)
680 td->first_error = err;
683 static inline int should_fsync(struct thread_data *td)
685 if (td->last_was_sync)
689 if (td_write(td) || td_rw(td) || td->o.override_sync)
696 * Init/option functions
698 extern int __must_check parse_options(int, char **);
699 extern int parse_jobs_ini(char *, int, int);
700 extern int exec_run(void);
701 extern void reset_fio_state(void);
702 extern int fio_options_parse(struct thread_data *, char **, int);
703 extern void fio_keywords_init(void);
704 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
705 extern void fio_fill_default_options(struct thread_data *);
706 extern int fio_show_option_help(const char *);
707 extern void fio_options_dup_and_init(struct option *);
708 extern void options_mem_dupe(struct thread_data *);
709 extern void options_mem_free(struct thread_data *);
710 extern void td_fill_rand_seeds(struct thread_data *);
711 extern void add_job_opts(const char **);
712 extern char *num2str(unsigned long, int, int, int);
714 #define FIO_GETOPT_JOB 0x89988998
715 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
720 extern void print_thread_status(void);
721 extern void print_status_init(int);
724 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
725 * will never back again. It may cycle between running/verififying/fsyncing.
726 * Once the thread reaches TD_EXITED, it is just waiting for the core to
742 extern void td_set_runstate(struct thread_data *, int);
747 extern int __must_check fio_pin_memory(void);
748 extern void fio_unpin_memory(void);
749 extern int __must_check allocate_io_mem(struct thread_data *);
750 extern void free_io_mem(struct thread_data *);
753 * Reset stats after ramp time completes
755 extern void reset_all_stats(struct thread_data *);
760 #ifdef FIO_HAVE_BLKTRACE
761 extern int is_blktrace(const char *);
762 extern int load_blktrace(struct thread_data *, const char *);
766 * Mark unused variables passed to ops functions as unused, to silence gcc
768 #define fio_unused __attribute((__unused__))
769 #define fio_init __attribute__((constructor))
770 #define fio_exit __attribute__((destructor))
772 #define for_each_td(td, i) \
773 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
774 #define for_each_file(td, f, i) \
775 if ((td)->files_index) \
776 for ((i) = 0, (f) = (td)->files[0]; \
777 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
780 #define fio_assert(td, cond) do { \
783 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
784 td_set_runstate((td), TD_EXITED); \
785 (td)->error = EFAULT; \
790 static inline int fio_fill_issue_time(struct thread_data *td)
792 if (td->o.read_iolog_file ||
793 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
799 static inline int __should_check_rate(struct thread_data *td,
802 struct thread_options *o = &td->o;
805 * If some rate setting was given, we need to check it
807 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
808 o->rate_iops_min[ddir])
814 static inline int should_check_rate(struct thread_data *td,
815 unsigned long *bytes_done)
820 ret |= __should_check_rate(td, 0);
822 ret |= __should_check_rate(td, 1);
827 static inline int is_power_of_2(unsigned int val)
829 return (val != 0 && ((val & (val - 1)) == 0));
833 * We currently only need to do locking if we have verifier threads
834 * accessing our internal structures too
836 static inline void td_io_u_lock(struct thread_data *td)
838 if (td->o.verify_async)
839 pthread_mutex_lock(&td->io_u_lock);
842 static inline void td_io_u_unlock(struct thread_data *td)
844 if (td->o.verify_async)
845 pthread_mutex_unlock(&td->io_u_lock);
848 static inline void td_io_u_free_notify(struct thread_data *td)
850 if (td->o.verify_async)
851 pthread_cond_signal(&td->free_cond);