8 #include <sys/resource.h>
17 #include "compiler/compiler.h"
18 #include "thread_options.h"
21 #include "arch/arch.h"
35 #include "lib/getopt.h"
37 #include "lib/rbtree.h"
42 #include "io_u_queue.h"
43 #include "workqueue.h"
45 #ifdef CONFIG_SOLARISAIO
46 #include <sys/asynch.h>
50 #include <linux/mempolicy.h>
54 * "local" is pseudo-policy
56 #define MPOL_LOCAL MPOL_MAX
60 * offset generator types
69 TD_F_TRIM_BACKLOG = 2,
71 TD_F_REFILL_BUFFERS = 8,
72 TD_F_SCRAMBLE_BUFFERS = 16,
74 TD_F_PROFILE_OPS = 64,
77 TD_F_COMPRESS_LOG = 512,
78 TD_F_VSTATE_SAVED = 1024,
79 TD_F_NEED_LOCK = 2048,
89 FIO_RAND_FILE_SIZE_OFF,
92 FIO_RAND_SEQ_RAND_READ_OFF,
93 FIO_RAND_SEQ_RAND_WRITE_OFF,
94 FIO_RAND_SEQ_RAND_TRIM_OFF,
106 * This describes a single thread/process executing a fio job.
109 struct thread_options o;
112 char verror[FIO_VERROR_SIZE];
114 unsigned int thread_number;
115 unsigned int subjob_number;
116 unsigned int groupid;
117 struct thread_stat ts;
121 struct io_log *slat_log;
122 struct io_log *clat_log;
123 struct io_log *lat_log;
124 struct io_log *bw_log;
125 struct io_log *iops_log;
127 struct tp_data *tp_data;
129 struct thread_data *parent;
131 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
132 struct timeval bw_sample_time;
134 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
135 struct timeval iops_sample_time;
138 * Tracks the last iodepth number of completed writes, if data
139 * verification is enabled
141 uint64_t *last_write_comp;
142 unsigned int last_write_idx;
144 volatile int update_rusage;
145 struct fio_mutex *rusage_sem;
146 struct rusage ru_start;
147 struct rusage ru_end;
149 struct fio_file **files;
150 unsigned char *file_locks;
151 unsigned int files_size;
152 unsigned int files_index;
153 unsigned int nr_open_files;
154 unsigned int nr_done_files;
155 unsigned int nr_normal_files;
157 unsigned int next_file;
158 struct frand_state next_file_state;
166 size_t orig_buffer_size;
167 volatile int terminate;
168 volatile int runstate;
169 unsigned int last_was_sync;
170 enum fio_ddir last_ddir;
179 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
181 struct frand_state bsrange_state;
182 struct frand_state verify_state;
183 struct frand_state trim_state;
184 struct frand_state delay_state;
186 struct frand_state buf_state;
187 struct frand_state buf_state_prev;
188 struct frand_state dedupe_state;
190 unsigned int verify_batch;
191 unsigned int trim_batch;
193 struct thread_io_list *vstate;
198 * IO engine hooks, contains everything needed to submit an io_u
199 * to any of the available IO engines.
201 struct ioengine_ops *io_ops;
204 * Queue depth of io_u's that fio MIGHT do
206 unsigned int cur_depth;
209 * io_u's about to be committed
211 unsigned int io_u_queued;
214 * io_u's submitted but not completed yet
216 unsigned int io_u_in_flight;
219 * List of free and busy io_u's
221 struct io_u_ring io_u_requeues;
222 struct io_u_queue io_u_freelist;
223 struct io_u_queue io_u_all;
224 pthread_mutex_t io_u_lock;
225 pthread_cond_t free_cond;
228 * async verify offload
230 struct flist_head verify_list;
231 pthread_t *verify_threads;
232 unsigned int nr_verify_threads;
233 pthread_cond_t verify_cond;
234 int verify_thread_exit;
239 uint64_t rate_bps[DDIR_RWDIR_CNT];
240 long rate_pending_usleep[DDIR_RWDIR_CNT];
241 unsigned long rate_bytes[DDIR_RWDIR_CNT];
242 unsigned long rate_blocks[DDIR_RWDIR_CNT];
243 struct timeval lastrate[DDIR_RWDIR_CNT];
246 * Enforced rate submission/completion workqueue
248 struct workqueue io_wq;
250 uint64_t total_io_size;
251 uint64_t fill_device_size;
256 uint64_t io_issues[DDIR_RWDIR_CNT];
257 uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
263 uint64_t io_blocks[DDIR_RWDIR_CNT];
264 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
265 uint64_t io_bytes[DDIR_RWDIR_CNT];
266 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
267 uint64_t io_skip_bytes;
269 struct fio_mutex *mutex;
270 uint64_t bytes_done[DDIR_RWDIR_CNT];
273 * State for random io, a bitmap of blocks done vs not done
275 struct frand_state random_state;
277 struct timeval start; /* start of this loop */
278 struct timeval epoch; /* time job was started */
279 struct timeval last_issue;
281 struct timeval tv_cache;
282 struct timeval terminate_time;
283 unsigned int tv_cache_nr;
284 unsigned int tv_cache_mask;
285 unsigned int ramp_time_over;
288 * Time since last latency_window was started
290 struct timeval latency_ts;
291 unsigned int latency_qd;
292 unsigned int latency_qd_high;
293 unsigned int latency_qd_low;
294 unsigned int latency_failed;
295 uint64_t latency_ios;
299 * read/write mixed workload state
301 struct frand_state rwmix_state;
302 unsigned long rwmix_issues;
303 enum fio_ddir rwmix_ddir;
304 unsigned int ddir_seq_nr;
307 * rand/seq mixed workload state
309 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
312 * IO history logs for verification. We use a tree for sorting,
313 * if we are overwriting. Otherwise just use a fifo.
315 struct rb_root io_hist_tree;
316 struct flist_head io_hist_list;
317 unsigned long io_hist_len;
322 struct flist_head io_log_list;
325 * For tracking/handling discards
327 struct flist_head trim_list;
328 unsigned long trim_entries;
330 struct flist_head next_rand_list;
333 * for fileservice, how often to switch to a new file
335 unsigned int file_service_nr;
336 unsigned int file_service_left;
337 struct fio_file *file_service_file;
339 unsigned int sync_file_range_nr;
342 * For generating file sizes
344 struct frand_state file_size_state;
349 unsigned int total_err_count;
352 struct fio_flow *flow;
355 * Can be overloaded by profiles
357 struct prof_io_ops prof_io_ops;
364 * when should interactive ETA output be generated
372 #define __td_verror(td, err, msg, func) \
374 unsigned int ____e = (err); \
377 (td)->error = ____e; \
378 if (!(td)->first_error) \
379 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
383 #define td_clear_error(td) do { \
386 (td)->parent->error = 0; \
389 #define td_verror(td, err, func) do { \
390 __td_verror((td), (err), strerror((err)), (func)); \
392 __td_verror((td)->parent, (err), strerror((err)), (func)); \
395 #define td_vmsg(td, err, msg, func) do { \
396 __td_verror((td), (err), (msg), (func)); \
398 __td_verror((td)->parent, (err), (msg), (func)); \
401 #define __fio_stringify_1(x) #x
402 #define __fio_stringify(x) __fio_stringify_1(x)
404 extern int exitall_on_terminate;
405 extern unsigned int thread_number;
406 extern unsigned int stat_number;
409 extern int output_format;
410 extern int append_terse_output;
411 extern int temp_stall_ts;
412 extern uintptr_t page_mask, page_size;
413 extern int read_only;
414 extern int eta_print;
415 extern int eta_new_line;
416 extern unsigned long done_secs;
417 extern char *job_section;
418 extern int fio_gtod_offload;
419 extern int fio_gtod_cpu;
420 extern enum fio_cs fio_clock_source;
421 extern int fio_clock_source_set;
422 extern int warnings_fatal;
423 extern int terse_version;
424 extern int is_backend;
425 extern int nr_clients;
426 extern int log_syslog;
427 extern int status_interval;
428 extern const char fio_version_string[];
429 extern int helper_do_stat;
430 extern pthread_cond_t helper_cond;
431 extern char *trigger_file;
432 extern char *trigger_cmd;
433 extern char *trigger_remote_cmd;
434 extern long long trigger_timeout;
436 extern struct thread_data *threads;
438 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
440 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
443 #define REAL_MAX_JOBS 2048
445 static inline int should_fsync(struct thread_data *td)
447 if (td->last_was_sync)
449 if (td_write(td) || td_rw(td) || td->o.override_sync)
456 * Init/option functions
458 extern int __must_check fio_init_options(void);
459 extern int __must_check parse_options(int, char **);
460 extern int parse_jobs_ini(char *, int, int, int);
461 extern int parse_cmd_line(int, char **, int);
462 extern int fio_backend(void);
463 extern void reset_fio_state(void);
464 extern void clear_io_state(struct thread_data *);
465 extern int fio_options_parse(struct thread_data *, char **, int, int);
466 extern void fio_keywords_init(void);
467 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
468 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
469 extern void fio_fill_default_options(struct thread_data *);
470 extern int fio_show_option_help(const char *);
471 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
472 extern void fio_options_dup_and_init(struct option *);
473 extern void fio_options_mem_dupe(struct thread_data *);
474 extern void options_mem_dupe(void *data, struct fio_option *options);
475 extern void td_fill_rand_seeds(struct thread_data *);
476 extern void add_job_opts(const char **, int);
477 extern char *num2str(uint64_t, int, int, int, int);
478 extern int ioengine_load(struct thread_data *);
479 extern int parse_dryrun(void);
480 extern int fio_running_or_pending_io_threads(void);
481 extern int fio_set_fd_nonblocking(int, const char *);
483 extern uintptr_t page_mask;
484 extern uintptr_t page_size;
485 extern int initialize_fio(char *envp[]);
487 #define FIO_GETOPT_JOB 0x89000000
488 #define FIO_GETOPT_IOENGINE 0x98000000
489 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
494 extern void print_thread_status(void);
495 extern void print_status_init(int);
496 extern char *fio_uint_to_kmg(unsigned int val);
499 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
500 * will never back again. It may cycle between running/verififying/fsyncing.
501 * Once the thread reaches TD_EXITED, it is just waiting for the core to
519 extern void td_set_runstate(struct thread_data *, int);
520 extern int td_bump_runstate(struct thread_data *, int);
521 extern void td_restore_runstate(struct thread_data *, int);
524 * Allow 60 seconds for a job to quit on its own, otherwise reap with
527 #define FIO_REAP_TIMEOUT 60
529 #define TERMINATE_ALL (-1)
530 extern void fio_terminate_threads(int);
531 extern void fio_mark_td_terminate(struct thread_data *);
536 extern int __must_check fio_pin_memory(struct thread_data *);
537 extern void fio_unpin_memory(struct thread_data *);
538 extern int __must_check allocate_io_mem(struct thread_data *);
539 extern void free_io_mem(struct thread_data *);
540 extern void free_threads_shm(void);
543 * Reset stats after ramp time completes
545 extern void reset_all_stats(struct thread_data *);
550 #ifdef FIO_HAVE_BLKTRACE
551 extern int is_blktrace(const char *, int *);
552 extern int load_blktrace(struct thread_data *, const char *, int);
556 * Latency target helpers
558 extern void lat_target_check(struct thread_data *);
559 extern void lat_target_init(struct thread_data *);
560 extern void lat_target_reset(struct thread_data *);
562 #define for_each_td(td, i) \
563 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
564 #define for_each_file(td, f, i) \
565 if ((td)->files_index) \
566 for ((i) = 0, (f) = (td)->files[0]; \
567 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
570 #define fio_assert(td, cond) do { \
573 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
574 td_set_runstate((td), TD_EXITED); \
575 (td)->error = EFAULT; \
580 static inline int fio_fill_issue_time(struct thread_data *td)
582 if (td->o.read_iolog_file ||
583 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
589 static inline int __should_check_rate(struct thread_data *td,
592 struct thread_options *o = &td->o;
595 * If some rate setting was given, we need to check it
597 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
598 o->rate_iops_min[ddir])
604 static inline int should_check_rate(struct thread_data *td)
608 if (td->bytes_done[DDIR_READ])
609 ret |= __should_check_rate(td, DDIR_READ);
610 if (td->bytes_done[DDIR_WRITE])
611 ret |= __should_check_rate(td, DDIR_WRITE);
612 if (td->bytes_done[DDIR_TRIM])
613 ret |= __should_check_rate(td, DDIR_TRIM);
618 static inline unsigned int td_max_bs(struct thread_data *td)
622 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
623 return max(td->o.max_bs[DDIR_TRIM], max_bs);
626 static inline unsigned int td_min_bs(struct thread_data *td)
630 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
631 return min(td->o.min_bs[DDIR_TRIM], min_bs);
634 static inline int td_async_processing(struct thread_data *td)
636 return (td->flags & TD_F_NEED_LOCK) != 0;
640 * We currently only need to do locking if we have verifier threads
641 * accessing our internal structures too
643 static inline void td_io_u_lock(struct thread_data *td)
645 if (td_async_processing(td))
646 pthread_mutex_lock(&td->io_u_lock);
649 static inline void td_io_u_unlock(struct thread_data *td)
651 if (td_async_processing(td))
652 pthread_mutex_unlock(&td->io_u_lock);
655 static inline void td_io_u_free_notify(struct thread_data *td)
657 if (td_async_processing(td))
658 pthread_cond_signal(&td->free_cond);
661 extern const char *fio_get_arch_string(int);
662 extern const char *fio_get_os_string(int);
665 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
669 FIO_OUTPUT_TERSE = 0,
675 FIO_RAND_DIST_RANDOM = 0,
677 FIO_RAND_DIST_PARETO,
681 #define FIO_DEF_ZIPF 1.1
682 #define FIO_DEF_PARETO 0.2
685 FIO_RAND_GEN_TAUSWORTHE = 0,
694 extern void exec_trigger(const char *);
695 extern void check_trigger_file(void);