8 #include <sys/resource.h>
19 #include "compiler/compiler.h"
23 #include "arch/arch.h"
36 #include "lib/getopt.h"
45 #ifdef FIO_HAVE_SOLARISAIO
46 #include <sys/asynch.h>
50 * What type of allocation to use for io buffers
53 MEM_MALLOC = 0, /* ordinary malloc */
54 MEM_SHM, /* use shared memory segments */
55 MEM_SHMHUGE, /* use shared memory segments with huge pages */
56 MEM_MMAP, /* use anonynomous mmap */
57 MEM_MMAPHUGE, /* memory mapped huge file */
61 * offset generator types
69 * What type of errors to continue on when continue_on_error is used
73 ERROR_TYPE_READ = 1 << 0,
74 ERROR_TYPE_WRITE = 1 << 1,
75 ERROR_TYPE_VERIFY = 1 << 2,
76 ERROR_TYPE_ANY = 0xffff,
84 struct thread_options {
95 unsigned int ddir_seq_nr;
98 unsigned int iodepth_low;
99 unsigned int iodepth_batch;
100 unsigned int iodepth_batch_complete;
102 unsigned long long size;
103 unsigned int size_percent;
104 unsigned int fill_device;
105 unsigned long long file_size_low;
106 unsigned long long file_size_high;
107 unsigned long long start_offset;
111 unsigned int min_bs[2];
112 unsigned int max_bs[2];
113 struct bssplit *bssplit[2];
114 unsigned int bssplit_nr[2];
116 unsigned int nr_files;
117 unsigned int open_files;
118 enum file_lock_mode file_lock_mode;
119 unsigned int lockfile_batch;
121 unsigned int odirect;
122 unsigned int invalidate_cache;
123 unsigned int create_serialize;
124 unsigned int create_fsync;
125 unsigned int create_on_open;
126 unsigned int end_fsync;
127 unsigned int pre_read;
128 unsigned int sync_io;
130 unsigned int do_verify;
131 unsigned int verifysort;
132 unsigned int verify_interval;
133 unsigned int verify_offset;
134 char verify_pattern[MAX_PATTERN_SIZE];
135 unsigned int verify_pattern_bytes;
136 unsigned int verify_fatal;
137 unsigned int verify_dump;
138 unsigned int verify_async;
139 unsigned long long verify_backlog;
140 unsigned int verify_batch;
141 unsigned int use_thread;
143 unsigned int do_disk_util;
144 unsigned int override_sync;
145 unsigned int rand_repeatable;
146 unsigned int use_os_rand;
147 unsigned int write_lat_log;
148 unsigned int write_bw_log;
149 unsigned int write_iops_log;
150 unsigned int log_avg_msec;
151 unsigned int norandommap;
152 unsigned int softrandommap;
153 unsigned int bs_unaligned;
154 unsigned int fsync_on_close;
156 unsigned int hugepage_size;
157 unsigned int rw_min_bs;
158 unsigned int thinktime;
159 unsigned int thinktime_spin;
160 unsigned int thinktime_blocks;
161 unsigned int fsync_blocks;
162 unsigned int fdatasync_blocks;
163 unsigned int barrier_blocks;
164 unsigned long long start_delay;
165 unsigned long long timeout;
166 unsigned long long ramp_time;
167 unsigned int overwrite;
168 unsigned int bw_avg_time;
169 unsigned int iops_avg_time;
171 unsigned long long zone_range;
172 unsigned long long zone_size;
173 unsigned long long zone_skip;
174 enum fio_memtype mem_type;
175 unsigned int mem_align;
177 unsigned int stonewall;
178 unsigned int new_group;
179 unsigned int numjobs;
180 os_cpu_mask_t cpumask;
181 unsigned int cpumask_set;
182 os_cpu_mask_t verify_cpumask;
183 unsigned int verify_cpumask_set;
185 unsigned int rwmixcycle;
186 unsigned int rwmix[2];
188 unsigned int file_service_type;
189 unsigned int group_reporting;
190 unsigned int fadvise_hint;
191 enum fio_fallocate_mode fallocate_mode;
192 unsigned int zero_buffers;
193 unsigned int refill_buffers;
194 unsigned int scramble_buffers;
195 unsigned int time_based;
196 unsigned int disable_lat;
197 unsigned int disable_clat;
198 unsigned int disable_slat;
199 unsigned int disable_bw;
200 unsigned int gtod_reduce;
201 unsigned int gtod_cpu;
202 unsigned int gtod_offload;
203 enum fio_cs clocksource;
204 unsigned int no_stall;
205 unsigned int trim_percentage;
206 unsigned int trim_batch;
207 unsigned int trim_zero;
208 unsigned long long trim_backlog;
209 unsigned int clat_percentiles;
210 unsigned int overwrite_plist;
211 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
213 char *read_iolog_file;
214 char *write_iolog_file;
218 char *replay_redirect;
221 * Pre-run and post-run shell
226 unsigned int rate[2];
227 unsigned int ratemin[2];
228 unsigned int ratecycle;
229 unsigned int rate_iops[2];
230 unsigned int rate_iops_min[2];
235 * CPU "io" cycle burner
237 unsigned int cpuload;
238 unsigned int cpucycle;
243 enum error_type continue_on_error;
246 * Benchmark profile type
251 * blkio cgroup support
254 unsigned int cgroup_weight;
255 unsigned int cgroup_nodelete;
260 unsigned int sync_file_range;
264 * This describes a single thread/process executing a fio job.
267 struct thread_options o;
269 char verror[FIO_VERROR_SIZE];
273 struct thread_stat ts;
275 struct io_log *slat_log;
276 struct io_log *clat_log;
277 struct io_log *lat_log;
278 struct io_log *bw_log;
279 struct io_log *iops_log;
281 uint64_t stat_io_bytes[2];
282 struct timeval bw_sample_time;
284 uint64_t stat_io_blocks[2];
285 struct timeval iops_sample_time;
287 struct rusage ru_start;
288 struct rusage ru_end;
290 struct fio_file **files;
291 unsigned int files_size;
292 unsigned int files_index;
293 unsigned int nr_open_files;
294 unsigned int nr_done_files;
295 unsigned int nr_normal_files;
297 unsigned int next_file;
298 os_random_state_t next_file_state;
299 struct frand_state __next_file_state;
305 size_t orig_buffer_size;
306 volatile int terminate;
307 volatile int runstate;
309 unsigned int ioprio_set;
310 unsigned int last_was_sync;
311 enum fio_ddir last_ddir;
321 unsigned long rand_seeds[8];
324 os_random_state_t bsrange_state;
325 struct frand_state __bsrange_state;
328 os_random_state_t verify_state;
329 struct frand_state __verify_state;
332 os_random_state_t trim_state;
333 struct frand_state __trim_state;
336 struct frand_state buf_state;
338 unsigned int verify_batch;
339 unsigned int trim_batch;
344 * IO engine hooks, contains everything needed to submit an io_u
345 * to any of the available IO engines.
347 struct ioengine_ops *io_ops;
350 * Queue depth of io_u's that fio MIGHT do
352 unsigned int cur_depth;
355 * io_u's about to be committed
357 unsigned int io_u_queued;
360 * io_u's submitted but not completed yet
362 unsigned int io_u_in_flight;
365 * List of free and busy io_u's
367 struct flist_head io_u_freelist;
368 struct flist_head io_u_busylist;
369 struct flist_head io_u_requeues;
370 pthread_mutex_t io_u_lock;
371 pthread_cond_t free_cond;
374 * async verify offload
376 struct flist_head verify_list;
377 pthread_t *verify_threads;
378 unsigned int nr_verify_threads;
379 pthread_cond_t verify_cond;
380 int verify_thread_exit;
385 unsigned long long rate_bps[2];
386 long rate_pending_usleep[2];
387 unsigned long rate_bytes[2];
388 unsigned long rate_blocks[2];
389 struct timeval lastrate[2];
391 unsigned long long total_io_size;
392 unsigned long long fill_device_size;
394 unsigned long io_issues[2];
395 unsigned long long io_blocks[2];
396 unsigned long long this_io_blocks[2];
397 unsigned long long io_bytes[2];
398 unsigned long long io_skip_bytes;
399 unsigned long long this_io_bytes[2];
400 unsigned long long zone_bytes;
401 struct fio_mutex *mutex;
404 * State for random io, a bitmap of blocks done vs not done
407 os_random_state_t random_state;
408 struct frand_state __random_state;
411 struct timeval start; /* start of this loop */
412 struct timeval epoch; /* time job was started */
413 struct timeval last_issue;
414 struct timeval tv_cache;
415 unsigned int tv_cache_nr;
416 unsigned int tv_cache_mask;
417 unsigned int ramp_time_over;
420 * read/write mixed workload state
423 os_random_state_t rwmix_state;
424 struct frand_state __rwmix_state;
426 unsigned long rwmix_issues;
427 enum fio_ddir rwmix_ddir;
428 unsigned int ddir_seq_nr;
431 * IO history logs for verification. We use a tree for sorting,
432 * if we are overwriting. Otherwise just use a fifo.
434 struct rb_root io_hist_tree;
435 struct flist_head io_hist_list;
436 unsigned long io_hist_len;
441 struct flist_head io_log_list;
444 * For tracking/handling discards
446 struct flist_head trim_list;
447 unsigned long trim_entries;
450 * for fileservice, how often to switch to a new file
452 unsigned int file_service_nr;
453 unsigned int file_service_left;
454 struct fio_file *file_service_file;
456 unsigned int sync_file_range_nr;
459 * For generating file sizes
462 os_random_state_t file_size_state;
463 struct frand_state __file_size_state;
469 unsigned int total_err_count;
473 * Can be overloaded by profiles
475 struct prof_io_ops prof_io_ops;
480 * when should interactive ETA output be generated
488 #define __td_verror(td, err, msg, func) \
494 if (!(td)->first_error) \
495 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
499 #define td_clear_error(td) \
501 #define td_verror(td, err, func) \
502 __td_verror((td), (err), strerror((err)), (func))
503 #define td_vmsg(td, err, msg, func) \
504 __td_verror((td), (err), (msg), (func))
506 #define __fio_stringify_1(x) #x
507 #define __fio_stringify(x) __fio_stringify_1(x)
509 extern int exitall_on_terminate;
510 extern unsigned int thread_number;
511 extern unsigned int nr_process, nr_thread;
514 extern int terse_output;
515 extern int temp_stall_ts;
516 extern unsigned long long mlock_size;
517 extern unsigned long page_mask, page_size;
518 extern int read_only;
519 extern int eta_print;
520 extern unsigned long done_secs;
521 extern char *job_section;
522 extern int fio_gtod_offload;
523 extern int fio_gtod_cpu;
524 extern enum fio_cs fio_clock_source;
525 extern int warnings_fatal;
526 extern int terse_version;
527 extern int is_backend;
528 extern int nr_clients;
529 extern int log_syslog;
530 extern const char fio_version_string[];
531 extern const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN];
533 extern struct thread_data *threads;
535 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
537 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
540 #define BLOCKS_PER_MAP (8 * sizeof(unsigned long))
541 #define TO_MAP_BLOCK(f, b) (b)
542 #define RAND_MAP_IDX(f, b) (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
543 #define RAND_MAP_BIT(f, b) (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
545 #define REAL_MAX_JOBS 2048
547 #define td_non_fatal_error(e) ((e) == EIO || (e) == EILSEQ)
549 static inline enum error_type td_error_type(enum fio_ddir ddir, int err)
552 return ERROR_TYPE_VERIFY;
553 if (ddir == DDIR_READ)
554 return ERROR_TYPE_READ;
555 return ERROR_TYPE_WRITE;
558 static inline void update_error_count(struct thread_data *td, int err)
560 td->total_err_count++;
561 if (td->total_err_count == 1)
562 td->first_error = err;
565 static inline int should_fsync(struct thread_data *td)
567 if (td->last_was_sync)
571 if (td_write(td) || td_rw(td) || td->o.override_sync)
578 * Init/option functions
580 extern int __must_check parse_options(int, char **);
581 extern int parse_jobs_ini(char *, int, int);
582 extern int parse_cmd_line(int, char **);
583 extern int exec_run(void);
584 extern void reset_fio_state(void);
585 extern int fio_options_parse(struct thread_data *, char **, int);
586 extern void fio_keywords_init(void);
587 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
588 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
589 extern void fio_fill_default_options(struct thread_data *);
590 extern int fio_show_option_help(const char *);
591 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
592 extern void fio_options_dup_and_init(struct option *);
593 extern void fio_options_mem_dupe(struct thread_data *);
594 extern void options_mem_dupe(void *data, struct fio_option *options);
595 extern void td_fill_rand_seeds(struct thread_data *);
596 extern void add_job_opts(const char **);
597 extern char *num2str(unsigned long, int, int, int);
598 extern int ioengine_load(struct thread_data *);
600 #define FIO_GETOPT_JOB 0x89000000
601 #define FIO_GETOPT_IOENGINE 0x98000000
602 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
607 extern void print_thread_status(void);
608 extern void print_status_init(int);
611 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
612 * will never back again. It may cycle between running/verififying/fsyncing.
613 * Once the thread reaches TD_EXITED, it is just waiting for the core to
629 extern void td_set_runstate(struct thread_data *, int);
630 #define TERMINATE_ALL (-1)
631 extern void fio_terminate_threads(int);
636 extern int __must_check fio_pin_memory(void);
637 extern void fio_unpin_memory(void);
638 extern int __must_check allocate_io_mem(struct thread_data *);
639 extern void free_io_mem(struct thread_data *);
642 * Reset stats after ramp time completes
644 extern void reset_all_stats(struct thread_data *);
649 #ifdef FIO_HAVE_BLKTRACE
650 extern int is_blktrace(const char *);
651 extern int load_blktrace(struct thread_data *, const char *);
655 * Mark unused variables passed to ops functions as unused, to silence gcc
657 #define fio_unused __attribute((__unused__))
658 #define fio_init __attribute__((constructor))
659 #define fio_exit __attribute__((destructor))
661 #define for_each_td(td, i) \
662 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
663 #define for_each_file(td, f, i) \
664 if ((td)->files_index) \
665 for ((i) = 0, (f) = (td)->files[0]; \
666 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
669 #define fio_assert(td, cond) do { \
672 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
673 td_set_runstate((td), TD_EXITED); \
674 (td)->error = EFAULT; \
679 static inline int fio_fill_issue_time(struct thread_data *td)
681 if (td->o.read_iolog_file ||
682 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
688 static inline int __should_check_rate(struct thread_data *td,
691 struct thread_options *o = &td->o;
694 * If some rate setting was given, we need to check it
696 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
697 o->rate_iops_min[ddir])
703 static inline int should_check_rate(struct thread_data *td,
704 unsigned long *bytes_done)
709 ret |= __should_check_rate(td, 0);
711 ret |= __should_check_rate(td, 1);
716 static inline int is_power_of_2(unsigned int val)
718 return (val != 0 && ((val & (val - 1)) == 0));
722 * We currently only need to do locking if we have verifier threads
723 * accessing our internal structures too
725 static inline void td_io_u_lock(struct thread_data *td)
727 if (td->o.verify_async)
728 pthread_mutex_lock(&td->io_u_lock);
731 static inline void td_io_u_unlock(struct thread_data *td)
733 if (td->o.verify_async)
734 pthread_mutex_unlock(&td->io_u_lock);
737 static inline void td_io_u_free_notify(struct thread_data *td)
739 if (td->o.verify_async)
740 pthread_cond_signal(&td->free_cond);
743 extern const char *fio_get_arch_string(int);
744 extern const char *fio_get_os_string(int);