8 #include <sys/resource.h>
19 #include "compiler/compiler.h"
23 #include "arch/arch.h"
37 #include "lib/getopt.h"
43 #ifdef FIO_HAVE_SOLARISAIO
44 #include <sys/asynch.h>
48 #include <linux/mempolicy.h>
52 * "local" is pseudo-policy
54 #define MPOL_LOCAL MPOL_MAX
58 * What type of allocation to use for io buffers
61 MEM_MALLOC = 0, /* ordinary malloc */
62 MEM_SHM, /* use shared memory segments */
63 MEM_SHMHUGE, /* use shared memory segments with huge pages */
64 MEM_MMAP, /* use anonynomous mmap */
65 MEM_MMAPHUGE, /* memory mapped huge file */
69 * offset generator types
77 * What type of errors to continue on when continue_on_error is used
80 ERROR_TYPE_READ_BIT = 0,
81 ERROR_TYPE_WRITE_BIT = 1,
82 ERROR_TYPE_VERIFY_BIT = 2,
88 ERROR_TYPE_READ = 1 << ERROR_TYPE_READ_BIT,
89 ERROR_TYPE_WRITE = 1 << ERROR_TYPE_WRITE_BIT,
90 ERROR_TYPE_VERIFY = 1 << ERROR_TYPE_VERIFY_BIT,
91 ERROR_TYPE_ANY = 0xffff,
99 struct thread_options {
107 enum td_ddir td_ddir;
109 unsigned int kb_base;
110 unsigned int ddir_seq_nr;
112 unsigned int iodepth;
113 unsigned int iodepth_low;
114 unsigned int iodepth_batch;
115 unsigned int iodepth_batch_complete;
117 unsigned long long size;
118 unsigned int size_percent;
119 unsigned int fill_device;
120 unsigned long long file_size_low;
121 unsigned long long file_size_high;
122 unsigned long long start_offset;
124 unsigned int bs[DDIR_RWDIR_CNT];
125 unsigned int ba[DDIR_RWDIR_CNT];
126 unsigned int min_bs[DDIR_RWDIR_CNT];
127 unsigned int max_bs[DDIR_RWDIR_CNT];
128 struct bssplit *bssplit[DDIR_RWDIR_CNT];
129 unsigned int bssplit_nr[DDIR_RWDIR_CNT];
131 int *ignore_error[ERROR_TYPE_CNT];
132 unsigned int ignore_error_nr[ERROR_TYPE_CNT];
133 unsigned int error_dump;
135 unsigned int nr_files;
136 unsigned int open_files;
137 enum file_lock_mode file_lock_mode;
138 unsigned int lockfile_batch;
140 unsigned int odirect;
141 unsigned int invalidate_cache;
142 unsigned int create_serialize;
143 unsigned int create_fsync;
144 unsigned int create_on_open;
145 unsigned int create_only;
146 unsigned int end_fsync;
147 unsigned int pre_read;
148 unsigned int sync_io;
150 unsigned int do_verify;
151 unsigned int verifysort;
152 unsigned int verifysort_nr;
153 unsigned int verify_interval;
154 unsigned int verify_offset;
155 char verify_pattern[MAX_PATTERN_SIZE];
156 unsigned int verify_pattern_bytes;
157 unsigned int verify_fatal;
158 unsigned int verify_dump;
159 unsigned int verify_async;
160 unsigned long long verify_backlog;
161 unsigned int verify_batch;
162 unsigned int use_thread;
164 unsigned int do_disk_util;
165 unsigned int override_sync;
166 unsigned int rand_repeatable;
167 unsigned int use_os_rand;
168 unsigned int write_lat_log;
169 unsigned int write_bw_log;
170 unsigned int write_iops_log;
171 unsigned int log_avg_msec;
172 unsigned int norandommap;
173 unsigned int softrandommap;
174 unsigned int bs_unaligned;
175 unsigned int fsync_on_close;
177 unsigned int random_distribution;
181 unsigned int random_generator;
183 unsigned int hugepage_size;
184 unsigned int rw_min_bs;
185 unsigned int thinktime;
186 unsigned int thinktime_spin;
187 unsigned int thinktime_blocks;
188 unsigned int fsync_blocks;
189 unsigned int fdatasync_blocks;
190 unsigned int barrier_blocks;
191 unsigned long long start_delay;
192 unsigned long long timeout;
193 unsigned long long ramp_time;
194 unsigned int overwrite;
195 unsigned int bw_avg_time;
196 unsigned int iops_avg_time;
198 unsigned long long zone_range;
199 unsigned long long zone_size;
200 unsigned long long zone_skip;
201 enum fio_memtype mem_type;
202 unsigned int mem_align;
204 unsigned int max_latency;
206 unsigned int stonewall;
207 unsigned int new_group;
208 unsigned int numjobs;
209 os_cpu_mask_t cpumask;
210 unsigned int cpumask_set;
211 os_cpu_mask_t verify_cpumask;
212 unsigned int verify_cpumask_set;
213 #ifdef CONFIG_LIBNUMA
214 struct bitmask *numa_cpunodesmask;
215 unsigned int numa_cpumask_set;
216 unsigned short numa_mem_mode;
217 unsigned int numa_mem_prefer_node;
218 struct bitmask *numa_memnodesmask;
219 unsigned int numa_memmask_set;
222 unsigned int rwmixcycle;
223 unsigned int rwmix[2];
225 unsigned int file_service_type;
226 unsigned int group_reporting;
227 unsigned int fadvise_hint;
228 enum fio_fallocate_mode fallocate_mode;
229 unsigned int zero_buffers;
230 unsigned int refill_buffers;
231 unsigned int scramble_buffers;
232 unsigned int compress_percentage;
233 unsigned int compress_chunk;
234 unsigned int time_based;
235 unsigned int disable_lat;
236 unsigned int disable_clat;
237 unsigned int disable_slat;
238 unsigned int disable_bw;
239 unsigned int gtod_reduce;
240 unsigned int gtod_cpu;
241 unsigned int gtod_offload;
242 enum fio_cs clocksource;
243 unsigned int no_stall;
244 unsigned int trim_percentage;
245 unsigned int trim_batch;
246 unsigned int trim_zero;
247 unsigned long long trim_backlog;
248 unsigned int clat_percentiles;
249 unsigned int overwrite_plist;
250 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
252 char *read_iolog_file;
253 char *write_iolog_file;
257 char *replay_redirect;
260 * Pre-run and post-run shell
265 unsigned int rate[DDIR_RWDIR_CNT];
266 unsigned int ratemin[DDIR_RWDIR_CNT];
267 unsigned int ratecycle;
268 unsigned int rate_iops[DDIR_RWDIR_CNT];
269 unsigned int rate_iops_min[DDIR_RWDIR_CNT];
274 * CPU "io" cycle burner
276 unsigned int cpuload;
277 unsigned int cpucycle;
282 enum error_type continue_on_error;
285 * Benchmark profile type
290 * blkio cgroup support
293 unsigned int cgroup_weight;
294 unsigned int cgroup_nodelete;
302 unsigned int flow_sleep;
304 unsigned long long offset_increment;
306 unsigned int sync_file_range;
310 TD_F_VER_BACKLOG = 1,
311 TD_F_TRIM_BACKLOG = 2,
313 TD_F_REFILL_BUFFERS = 8,
314 TD_F_SCRAMBLE_BUFFERS = 16,
316 TD_F_PROFILE_OPS = 64,
325 FIO_RAND_FILE_SIZE_OFF,
332 * This describes a single thread/process executing a fio job.
335 struct thread_options o;
338 char verror[FIO_VERROR_SIZE];
342 struct thread_stat ts;
344 struct io_log *slat_log;
345 struct io_log *clat_log;
346 struct io_log *lat_log;
347 struct io_log *bw_log;
348 struct io_log *iops_log;
350 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
351 struct timeval bw_sample_time;
353 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
354 struct timeval iops_sample_time;
356 struct rusage ru_start;
357 struct rusage ru_end;
359 struct fio_file **files;
360 unsigned int files_size;
361 unsigned int files_index;
362 unsigned int nr_open_files;
363 unsigned int nr_done_files;
364 unsigned int nr_normal_files;
366 unsigned int next_file;
367 os_random_state_t next_file_state;
368 struct frand_state __next_file_state;
375 size_t orig_buffer_size;
376 volatile int terminate;
377 volatile int runstate;
379 unsigned int ioprio_set;
380 unsigned int last_was_sync;
381 enum fio_ddir last_ddir;
391 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
394 os_random_state_t bsrange_state;
395 struct frand_state __bsrange_state;
398 os_random_state_t verify_state;
399 struct frand_state __verify_state;
402 os_random_state_t trim_state;
403 struct frand_state __trim_state;
406 struct frand_state buf_state;
408 unsigned int verify_batch;
409 unsigned int trim_batch;
414 * IO engine hooks, contains everything needed to submit an io_u
415 * to any of the available IO engines.
417 struct ioengine_ops *io_ops;
420 * Queue depth of io_u's that fio MIGHT do
422 unsigned int cur_depth;
425 * io_u's about to be committed
427 unsigned int io_u_queued;
430 * io_u's submitted but not completed yet
432 unsigned int io_u_in_flight;
435 * List of free and busy io_u's
437 struct flist_head io_u_freelist;
438 struct flist_head io_u_busylist;
439 struct flist_head io_u_requeues;
440 pthread_mutex_t io_u_lock;
441 pthread_cond_t free_cond;
444 * async verify offload
446 struct flist_head verify_list;
447 pthread_t *verify_threads;
448 unsigned int nr_verify_threads;
449 pthread_cond_t verify_cond;
450 int verify_thread_exit;
455 unsigned long long rate_bps[DDIR_RWDIR_CNT];
456 long rate_pending_usleep[DDIR_RWDIR_CNT];
457 unsigned long rate_bytes[DDIR_RWDIR_CNT];
458 unsigned long rate_blocks[DDIR_RWDIR_CNT];
459 struct timeval lastrate[DDIR_RWDIR_CNT];
461 unsigned long long total_io_size;
462 unsigned long long fill_device_size;
464 unsigned long io_issues[DDIR_RWDIR_CNT];
465 unsigned long long io_blocks[DDIR_RWDIR_CNT];
466 unsigned long long this_io_blocks[DDIR_RWDIR_CNT];
467 unsigned long long io_bytes[DDIR_RWDIR_CNT];
468 unsigned long long io_skip_bytes;
469 unsigned long long this_io_bytes[DDIR_RWDIR_CNT];
470 unsigned long long zone_bytes;
471 struct fio_mutex *mutex;
474 * State for random io, a bitmap of blocks done vs not done
477 os_random_state_t random_state;
478 struct frand_state __random_state;
481 struct timeval start; /* start of this loop */
482 struct timeval epoch; /* time job was started */
483 struct timeval last_issue;
484 struct timeval tv_cache;
485 unsigned int tv_cache_nr;
486 unsigned int tv_cache_mask;
487 unsigned int ramp_time_over;
490 * read/write mixed workload state
493 os_random_state_t rwmix_state;
494 struct frand_state __rwmix_state;
496 unsigned long rwmix_issues;
497 enum fio_ddir rwmix_ddir;
498 unsigned int ddir_seq_nr;
501 * IO history logs for verification. We use a tree for sorting,
502 * if we are overwriting. Otherwise just use a fifo.
504 struct rb_root io_hist_tree;
505 struct flist_head io_hist_list;
506 unsigned long io_hist_len;
511 struct flist_head io_log_list;
514 * For tracking/handling discards
516 struct flist_head trim_list;
517 unsigned long trim_entries;
519 struct flist_head next_rand_list;
522 * for fileservice, how often to switch to a new file
524 unsigned int file_service_nr;
525 unsigned int file_service_left;
526 struct fio_file *file_service_file;
528 unsigned int sync_file_range_nr;
531 * For generating file sizes
534 os_random_state_t file_size_state;
535 struct frand_state __file_size_state;
541 unsigned int total_err_count;
544 struct fio_flow *flow;
547 * Can be overloaded by profiles
549 struct prof_io_ops prof_io_ops;
554 * when should interactive ETA output be generated
562 #define __td_verror(td, err, msg, func) \
568 if (!(td)->first_error) \
569 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
573 #define td_clear_error(td) \
575 #define td_verror(td, err, func) \
576 __td_verror((td), (err), strerror((err)), (func))
577 #define td_vmsg(td, err, msg, func) \
578 __td_verror((td), (err), (msg), (func))
580 #define __fio_stringify_1(x) #x
581 #define __fio_stringify(x) __fio_stringify_1(x)
583 extern int exitall_on_terminate;
584 extern unsigned int thread_number;
585 extern unsigned int stat_number;
586 extern unsigned int nr_process, nr_thread;
589 extern int output_format;
590 extern int temp_stall_ts;
591 extern unsigned long long mlock_size;
592 extern uintptr_t page_mask, page_size;
593 extern int read_only;
594 extern int eta_print;
595 extern unsigned long done_secs;
596 extern char *job_section;
597 extern int fio_gtod_offload;
598 extern int fio_gtod_cpu;
599 extern enum fio_cs fio_clock_source;
600 extern int fio_clock_source_set;
601 extern int warnings_fatal;
602 extern int terse_version;
603 extern int is_backend;
604 extern int nr_clients;
605 extern int log_syslog;
606 extern const char fio_version_string[];
607 extern const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN];
609 extern struct thread_data *threads;
611 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
613 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
616 #define REAL_MAX_JOBS 2048
618 static inline enum error_type_bit td_error_type(enum fio_ddir ddir, int err)
621 return ERROR_TYPE_VERIFY_BIT;
622 if (ddir == DDIR_READ)
623 return ERROR_TYPE_READ_BIT;
624 return ERROR_TYPE_WRITE_BIT;
627 static int __NON_FATAL_ERR[] = {EIO, EILSEQ};
628 static inline int td_non_fatal_error(struct thread_data *td,
629 enum error_type_bit etype, int err)
632 if (!td->o.ignore_error[etype]) {
633 td->o.ignore_error[etype] = __NON_FATAL_ERR;
634 td->o.ignore_error_nr[etype] = sizeof(__NON_FATAL_ERR)
638 if (!(td->o.continue_on_error & (1 << etype)))
640 for (i = 0; i < td->o.ignore_error_nr[etype]; i++)
641 if (td->o.ignore_error[etype][i] == err)
646 static inline void update_error_count(struct thread_data *td, int err)
648 td->total_err_count++;
649 if (td->total_err_count == 1)
650 td->first_error = err;
653 static inline int should_fsync(struct thread_data *td)
655 if (td->last_was_sync)
659 if (td_write(td) || td_rw(td) || td->o.override_sync)
666 * Init/option functions
668 extern int __must_check parse_options(int, char **);
669 extern int parse_jobs_ini(char *, int, int);
670 extern int parse_cmd_line(int, char **);
671 extern int fio_backend(void);
672 extern void reset_fio_state(void);
673 extern void clear_io_state(struct thread_data *);
674 extern int fio_options_parse(struct thread_data *, char **, int);
675 extern void fio_keywords_init(void);
676 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
677 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
678 extern void fio_fill_default_options(struct thread_data *);
679 extern int fio_show_option_help(const char *);
680 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
681 extern void fio_options_dup_and_init(struct option *);
682 extern void fio_options_mem_dupe(struct thread_data *);
683 extern void options_mem_dupe(void *data, struct fio_option *options);
684 extern void td_fill_rand_seeds(struct thread_data *);
685 extern void add_job_opts(const char **);
686 extern char *num2str(unsigned long, int, int, int);
687 extern int ioengine_load(struct thread_data *);
689 #define FIO_GETOPT_JOB 0x89000000
690 #define FIO_GETOPT_IOENGINE 0x98000000
691 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
696 extern void print_thread_status(void);
697 extern void print_status_init(int);
700 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
701 * will never back again. It may cycle between running/verififying/fsyncing.
702 * Once the thread reaches TD_EXITED, it is just waiting for the core to
719 extern void td_set_runstate(struct thread_data *, int);
720 #define TERMINATE_ALL (-1)
721 extern void fio_terminate_threads(int);
726 extern int __must_check fio_pin_memory(void);
727 extern void fio_unpin_memory(void);
728 extern int __must_check allocate_io_mem(struct thread_data *);
729 extern void free_io_mem(struct thread_data *);
732 * Reset stats after ramp time completes
734 extern void reset_all_stats(struct thread_data *);
739 #ifdef FIO_HAVE_BLKTRACE
740 extern int is_blktrace(const char *);
741 extern int load_blktrace(struct thread_data *, const char *);
745 * Mark unused variables passed to ops functions as unused, to silence gcc
747 #define fio_unused __attribute((__unused__))
748 #define fio_init __attribute__((constructor))
749 #define fio_exit __attribute__((destructor))
751 #define for_each_td(td, i) \
752 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
753 #define for_each_file(td, f, i) \
754 if ((td)->files_index) \
755 for ((i) = 0, (f) = (td)->files[0]; \
756 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
759 #define fio_assert(td, cond) do { \
762 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
763 td_set_runstate((td), TD_EXITED); \
764 (td)->error = EFAULT; \
769 static inline int fio_fill_issue_time(struct thread_data *td)
771 if (td->o.read_iolog_file ||
772 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
778 static inline int __should_check_rate(struct thread_data *td,
781 struct thread_options *o = &td->o;
784 * If some rate setting was given, we need to check it
786 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
787 o->rate_iops_min[ddir])
793 static inline int should_check_rate(struct thread_data *td,
794 unsigned long *bytes_done)
798 if (bytes_done[DDIR_READ])
799 ret |= __should_check_rate(td, DDIR_READ);
800 if (bytes_done[DDIR_WRITE])
801 ret |= __should_check_rate(td, DDIR_WRITE);
802 if (bytes_done[DDIR_TRIM])
803 ret |= __should_check_rate(td, DDIR_TRIM);
808 static inline int is_power_of_2(unsigned int val)
810 return (val != 0 && ((val & (val - 1)) == 0));
814 * We currently only need to do locking if we have verifier threads
815 * accessing our internal structures too
817 static inline void td_io_u_lock(struct thread_data *td)
819 if (td->o.verify_async)
820 pthread_mutex_lock(&td->io_u_lock);
823 static inline void td_io_u_unlock(struct thread_data *td)
825 if (td->o.verify_async)
826 pthread_mutex_unlock(&td->io_u_lock);
829 static inline void td_io_u_free_notify(struct thread_data *td)
831 if (td->o.verify_async)
832 pthread_cond_signal(&td->free_cond);
835 extern const char *fio_get_arch_string(int);
836 extern const char *fio_get_os_string(int);
839 FIO_OUTPUT_TERSE = 0,
845 FIO_RAND_DIST_RANDOM = 0,
847 FIO_RAND_DIST_PARETO,
851 FIO_RAND_GEN_TAUSWORTHE = 0,