8 #include <sys/resource.h>
19 #include "compiler/compiler.h"
23 #include "arch/arch.h"
37 #include "lib/getopt.h"
47 #ifdef FIO_HAVE_SOLARISAIO
48 #include <sys/asynch.h>
52 * What type of allocation to use for io buffers
55 MEM_MALLOC = 0, /* ordinary malloc */
56 MEM_SHM, /* use shared memory segments */
57 MEM_SHMHUGE, /* use shared memory segments with huge pages */
58 MEM_MMAP, /* use anonynomous mmap */
59 MEM_MMAPHUGE, /* memory mapped huge file */
63 * offset generator types
71 * What type of errors to continue on when continue_on_error is used
75 ERROR_TYPE_READ = 1 << 0,
76 ERROR_TYPE_WRITE = 1 << 1,
77 ERROR_TYPE_VERIFY = 1 << 2,
78 ERROR_TYPE_ANY = 0xffff,
86 struct thread_options {
97 unsigned int ddir_seq_nr;
100 unsigned int iodepth_low;
101 unsigned int iodepth_batch;
102 unsigned int iodepth_batch_complete;
104 unsigned long long size;
105 unsigned int size_percent;
106 unsigned int fill_device;
107 unsigned long long file_size_low;
108 unsigned long long file_size_high;
109 unsigned long long start_offset;
113 unsigned int min_bs[2];
114 unsigned int max_bs[2];
115 struct bssplit *bssplit[2];
116 unsigned int bssplit_nr[2];
118 unsigned int nr_files;
119 unsigned int open_files;
120 enum file_lock_mode file_lock_mode;
121 unsigned int lockfile_batch;
123 unsigned int odirect;
124 unsigned int invalidate_cache;
125 unsigned int create_serialize;
126 unsigned int create_fsync;
127 unsigned int create_on_open;
128 unsigned int end_fsync;
129 unsigned int pre_read;
130 unsigned int sync_io;
132 unsigned int do_verify;
133 unsigned int verifysort;
134 unsigned int verify_interval;
135 unsigned int verify_offset;
136 char verify_pattern[MAX_PATTERN_SIZE];
137 unsigned int verify_pattern_bytes;
138 unsigned int verify_fatal;
139 unsigned int verify_dump;
140 unsigned int verify_async;
141 unsigned long long verify_backlog;
142 unsigned int verify_batch;
143 unsigned int use_thread;
145 unsigned int do_disk_util;
146 unsigned int override_sync;
147 unsigned int rand_repeatable;
148 unsigned int use_os_rand;
149 unsigned int write_lat_log;
150 unsigned int write_bw_log;
151 unsigned int write_iops_log;
152 unsigned int log_avg_msec;
153 unsigned int norandommap;
154 unsigned int softrandommap;
155 unsigned int bs_unaligned;
156 unsigned int fsync_on_close;
158 unsigned int hugepage_size;
159 unsigned int rw_min_bs;
160 unsigned int thinktime;
161 unsigned int thinktime_spin;
162 unsigned int thinktime_blocks;
163 unsigned int fsync_blocks;
164 unsigned int fdatasync_blocks;
165 unsigned int barrier_blocks;
166 unsigned long long start_delay;
167 unsigned long long timeout;
168 unsigned long long ramp_time;
169 unsigned int overwrite;
170 unsigned int bw_avg_time;
171 unsigned int iops_avg_time;
173 unsigned long long zone_range;
174 unsigned long long zone_size;
175 unsigned long long zone_skip;
176 enum fio_memtype mem_type;
177 unsigned int mem_align;
179 unsigned int stonewall;
180 unsigned int new_group;
181 unsigned int numjobs;
182 os_cpu_mask_t cpumask;
183 unsigned int cpumask_set;
184 os_cpu_mask_t verify_cpumask;
185 unsigned int verify_cpumask_set;
187 unsigned int rwmixcycle;
188 unsigned int rwmix[2];
190 unsigned int file_service_type;
191 unsigned int group_reporting;
192 unsigned int fadvise_hint;
193 enum fio_fallocate_mode fallocate_mode;
194 unsigned int zero_buffers;
195 unsigned int refill_buffers;
196 unsigned int scramble_buffers;
197 unsigned int time_based;
198 unsigned int disable_lat;
199 unsigned int disable_clat;
200 unsigned int disable_slat;
201 unsigned int disable_bw;
202 unsigned int gtod_reduce;
203 unsigned int gtod_cpu;
204 unsigned int gtod_offload;
205 enum fio_cs clocksource;
206 unsigned int no_stall;
207 unsigned int trim_percentage;
208 unsigned int trim_batch;
209 unsigned int trim_zero;
210 unsigned long long trim_backlog;
211 unsigned int clat_percentiles;
212 unsigned int overwrite_plist;
213 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
215 char *read_iolog_file;
216 char *write_iolog_file;
220 char *replay_redirect;
223 * Pre-run and post-run shell
228 unsigned int rate[2];
229 unsigned int ratemin[2];
230 unsigned int ratecycle;
231 unsigned int rate_iops[2];
232 unsigned int rate_iops_min[2];
237 * CPU "io" cycle burner
239 unsigned int cpuload;
240 unsigned int cpucycle;
245 enum error_type continue_on_error;
248 * Benchmark profile type
253 * blkio cgroup support
256 unsigned int cgroup_weight;
257 unsigned int cgroup_nodelete;
265 unsigned int flow_sleep;
267 unsigned int sync_file_range;
271 * This describes a single thread/process executing a fio job.
274 struct thread_options o;
276 char verror[FIO_VERROR_SIZE];
280 struct thread_stat ts;
282 struct io_log *slat_log;
283 struct io_log *clat_log;
284 struct io_log *lat_log;
285 struct io_log *bw_log;
286 struct io_log *iops_log;
288 uint64_t stat_io_bytes[2];
289 struct timeval bw_sample_time;
291 uint64_t stat_io_blocks[2];
292 struct timeval iops_sample_time;
294 struct rusage ru_start;
295 struct rusage ru_end;
297 struct fio_file **files;
298 unsigned int files_size;
299 unsigned int files_index;
300 unsigned int nr_open_files;
301 unsigned int nr_done_files;
302 unsigned int nr_normal_files;
304 unsigned int next_file;
305 os_random_state_t next_file_state;
306 struct frand_state __next_file_state;
312 size_t orig_buffer_size;
313 volatile int terminate;
314 volatile int runstate;
316 unsigned int ioprio_set;
317 unsigned int last_was_sync;
318 enum fio_ddir last_ddir;
328 unsigned long rand_seeds[8];
331 os_random_state_t bsrange_state;
332 struct frand_state __bsrange_state;
335 os_random_state_t verify_state;
336 struct frand_state __verify_state;
339 os_random_state_t trim_state;
340 struct frand_state __trim_state;
343 struct frand_state buf_state;
345 unsigned int verify_batch;
346 unsigned int trim_batch;
351 * IO engine hooks, contains everything needed to submit an io_u
352 * to any of the available IO engines.
354 struct ioengine_ops *io_ops;
357 * Queue depth of io_u's that fio MIGHT do
359 unsigned int cur_depth;
362 * io_u's about to be committed
364 unsigned int io_u_queued;
367 * io_u's submitted but not completed yet
369 unsigned int io_u_in_flight;
372 * List of free and busy io_u's
374 struct flist_head io_u_freelist;
375 struct flist_head io_u_busylist;
376 struct flist_head io_u_requeues;
377 pthread_mutex_t io_u_lock;
378 pthread_cond_t free_cond;
381 * async verify offload
383 struct flist_head verify_list;
384 pthread_t *verify_threads;
385 unsigned int nr_verify_threads;
386 pthread_cond_t verify_cond;
387 int verify_thread_exit;
392 unsigned long long rate_bps[2];
393 long rate_pending_usleep[2];
394 unsigned long rate_bytes[2];
395 unsigned long rate_blocks[2];
396 struct timeval lastrate[2];
398 unsigned long long total_io_size;
399 unsigned long long fill_device_size;
401 unsigned long io_issues[2];
402 unsigned long long io_blocks[2];
403 unsigned long long this_io_blocks[2];
404 unsigned long long io_bytes[2];
405 unsigned long long io_skip_bytes;
406 unsigned long long this_io_bytes[2];
407 unsigned long long zone_bytes;
408 struct fio_mutex *mutex;
411 * State for random io, a bitmap of blocks done vs not done
414 os_random_state_t random_state;
415 struct frand_state __random_state;
418 struct timeval start; /* start of this loop */
419 struct timeval epoch; /* time job was started */
420 struct timeval last_issue;
421 struct timeval tv_cache;
422 unsigned int tv_cache_nr;
423 unsigned int tv_cache_mask;
424 unsigned int ramp_time_over;
427 * read/write mixed workload state
430 os_random_state_t rwmix_state;
431 struct frand_state __rwmix_state;
433 unsigned long rwmix_issues;
434 enum fio_ddir rwmix_ddir;
435 unsigned int ddir_seq_nr;
438 * IO history logs for verification. We use a tree for sorting,
439 * if we are overwriting. Otherwise just use a fifo.
441 struct rb_root io_hist_tree;
442 struct flist_head io_hist_list;
443 unsigned long io_hist_len;
448 struct flist_head io_log_list;
451 * For tracking/handling discards
453 struct flist_head trim_list;
454 unsigned long trim_entries;
457 * for fileservice, how often to switch to a new file
459 unsigned int file_service_nr;
460 unsigned int file_service_left;
461 struct fio_file *file_service_file;
463 unsigned int sync_file_range_nr;
466 * For generating file sizes
469 os_random_state_t file_size_state;
470 struct frand_state __file_size_state;
476 unsigned int total_err_count;
479 struct fio_flow *flow;
482 * Can be overloaded by profiles
484 struct prof_io_ops prof_io_ops;
489 * when should interactive ETA output be generated
497 #define __td_verror(td, err, msg, func) \
503 if (!(td)->first_error) \
504 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
508 #define td_clear_error(td) \
510 #define td_verror(td, err, func) \
511 __td_verror((td), (err), strerror((err)), (func))
512 #define td_vmsg(td, err, msg, func) \
513 __td_verror((td), (err), (msg), (func))
515 #define __fio_stringify_1(x) #x
516 #define __fio_stringify(x) __fio_stringify_1(x)
518 extern int exitall_on_terminate;
519 extern unsigned int thread_number;
520 extern unsigned int nr_process, nr_thread;
523 extern int terse_output;
524 extern int temp_stall_ts;
525 extern unsigned long long mlock_size;
526 extern unsigned long page_mask, page_size;
527 extern int read_only;
528 extern int eta_print;
529 extern unsigned long done_secs;
530 extern char *job_section;
531 extern int fio_gtod_offload;
532 extern int fio_gtod_cpu;
533 extern enum fio_cs fio_clock_source;
534 extern int warnings_fatal;
535 extern int terse_version;
536 extern int is_backend;
537 extern int nr_clients;
538 extern int log_syslog;
539 extern const char fio_version_string[];
540 extern const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN];
542 extern struct thread_data *threads;
544 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
546 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
549 #define BLOCKS_PER_MAP (8 * sizeof(unsigned long))
550 #define TO_MAP_BLOCK(f, b) (b)
551 #define RAND_MAP_IDX(f, b) (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
552 #define RAND_MAP_BIT(f, b) (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
554 #define REAL_MAX_JOBS 2048
556 #define td_non_fatal_error(e) ((e) == EIO || (e) == EILSEQ)
558 static inline enum error_type td_error_type(enum fio_ddir ddir, int err)
561 return ERROR_TYPE_VERIFY;
562 if (ddir == DDIR_READ)
563 return ERROR_TYPE_READ;
564 return ERROR_TYPE_WRITE;
567 static inline void update_error_count(struct thread_data *td, int err)
569 td->total_err_count++;
570 if (td->total_err_count == 1)
571 td->first_error = err;
574 static inline int should_fsync(struct thread_data *td)
576 if (td->last_was_sync)
580 if (td_write(td) || td_rw(td) || td->o.override_sync)
587 * Init/option functions
589 extern int __must_check parse_options(int, char **);
590 extern int parse_jobs_ini(char *, int, int);
591 extern int parse_cmd_line(int, char **);
592 extern int fio_backend(void);
593 extern void reset_fio_state(void);
594 extern void clear_io_state(struct thread_data *);
595 extern int fio_options_parse(struct thread_data *, char **, int);
596 extern void fio_keywords_init(void);
597 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
598 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
599 extern void fio_fill_default_options(struct thread_data *);
600 extern int fio_show_option_help(const char *);
601 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
602 extern void fio_options_dup_and_init(struct option *);
603 extern void fio_options_mem_dupe(struct thread_data *);
604 extern void options_mem_dupe(void *data, struct fio_option *options);
605 extern void td_fill_rand_seeds(struct thread_data *);
606 extern void add_job_opts(const char **);
607 extern char *num2str(unsigned long, int, int, int);
608 extern int ioengine_load(struct thread_data *);
610 #define FIO_GETOPT_JOB 0x89000000
611 #define FIO_GETOPT_IOENGINE 0x98000000
612 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
617 extern void print_thread_status(void);
618 extern void print_status_init(int);
621 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
622 * will never back again. It may cycle between running/verififying/fsyncing.
623 * Once the thread reaches TD_EXITED, it is just waiting for the core to
639 extern void td_set_runstate(struct thread_data *, int);
640 #define TERMINATE_ALL (-1)
641 extern void fio_terminate_threads(int);
646 extern int __must_check fio_pin_memory(void);
647 extern void fio_unpin_memory(void);
648 extern int __must_check allocate_io_mem(struct thread_data *);
649 extern void free_io_mem(struct thread_data *);
652 * Reset stats after ramp time completes
654 extern void reset_all_stats(struct thread_data *);
659 #ifdef FIO_HAVE_BLKTRACE
660 extern int is_blktrace(const char *);
661 extern int load_blktrace(struct thread_data *, const char *);
665 * Mark unused variables passed to ops functions as unused, to silence gcc
667 #define fio_unused __attribute((__unused__))
668 #define fio_init __attribute__((constructor))
669 #define fio_exit __attribute__((destructor))
671 #define for_each_td(td, i) \
672 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
673 #define for_each_file(td, f, i) \
674 if ((td)->files_index) \
675 for ((i) = 0, (f) = (td)->files[0]; \
676 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
679 #define fio_assert(td, cond) do { \
682 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
683 td_set_runstate((td), TD_EXITED); \
684 (td)->error = EFAULT; \
689 static inline int fio_fill_issue_time(struct thread_data *td)
691 if (td->o.read_iolog_file ||
692 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
698 static inline int __should_check_rate(struct thread_data *td,
701 struct thread_options *o = &td->o;
704 * If some rate setting was given, we need to check it
706 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
707 o->rate_iops_min[ddir])
713 static inline int should_check_rate(struct thread_data *td,
714 unsigned long *bytes_done)
719 ret |= __should_check_rate(td, 0);
721 ret |= __should_check_rate(td, 1);
726 static inline int is_power_of_2(unsigned int val)
728 return (val != 0 && ((val & (val - 1)) == 0));
732 * We currently only need to do locking if we have verifier threads
733 * accessing our internal structures too
735 static inline void td_io_u_lock(struct thread_data *td)
737 if (td->o.verify_async)
738 pthread_mutex_lock(&td->io_u_lock);
741 static inline void td_io_u_unlock(struct thread_data *td)
743 if (td->o.verify_async)
744 pthread_mutex_unlock(&td->io_u_lock);
747 static inline void td_io_u_free_notify(struct thread_data *td)
749 if (td->o.verify_async)
750 pthread_cond_signal(&td->free_cond);
753 extern const char *fio_get_arch_string(int);
754 extern const char *fio_get_os_string(int);