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
68 TD_F_VER_BACKLOG = 1U << 0,
69 TD_F_TRIM_BACKLOG = 1U << 1,
70 TD_F_READ_IOLOG = 1U << 2,
71 TD_F_REFILL_BUFFERS = 1U << 3,
72 TD_F_SCRAMBLE_BUFFERS = 1U << 4,
73 TD_F_VER_NONE = 1U << 5,
74 TD_F_PROFILE_OPS = 1U << 6,
75 TD_F_COMPRESS = 1U << 7,
77 TD_F_COMPRESS_LOG = 1U << 9,
78 TD_F_VSTATE_SAVED = 1U << 10,
79 TD_F_NEED_LOCK = 1U << 11,
80 TD_F_CHILD = 1U << 12,
81 TD_F_NO_PROGRESS = 1U << 13,
90 FIO_RAND_FILE_SIZE_OFF,
93 FIO_RAND_SEQ_RAND_READ_OFF,
94 FIO_RAND_SEQ_RAND_WRITE_OFF,
95 FIO_RAND_SEQ_RAND_TRIM_OFF,
106 RATE_PROCESS_LINEAR = 0,
107 RATE_PROCESS_POISSON = 1,
111 * This describes a single thread/process executing a fio job.
114 struct thread_options o;
117 char verror[FIO_VERROR_SIZE];
119 unsigned int thread_number;
120 unsigned int subjob_number;
121 unsigned int groupid;
122 struct thread_stat ts;
126 struct io_log *slat_log;
127 struct io_log *clat_log;
128 struct io_log *lat_log;
129 struct io_log *bw_log;
130 struct io_log *iops_log;
132 struct tp_data *tp_data;
134 struct thread_data *parent;
136 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
137 struct timeval bw_sample_time;
139 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
140 struct timeval iops_sample_time;
143 * Tracks the last iodepth number of completed writes, if data
144 * verification is enabled
146 uint64_t *last_write_comp;
147 unsigned int last_write_idx;
149 volatile int update_rusage;
150 struct fio_mutex *rusage_sem;
151 struct rusage ru_start;
152 struct rusage ru_end;
154 struct fio_file **files;
155 unsigned char *file_locks;
156 unsigned int files_size;
157 unsigned int files_index;
158 unsigned int nr_open_files;
159 unsigned int nr_done_files;
160 unsigned int nr_normal_files;
162 unsigned int next_file;
163 struct frand_state next_file_state;
171 size_t orig_buffer_size;
172 volatile int terminate;
173 volatile int runstate;
174 unsigned int last_was_sync;
175 enum fio_ddir last_ddir;
184 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
186 struct frand_state bsrange_state;
187 struct frand_state verify_state;
188 struct frand_state trim_state;
189 struct frand_state delay_state;
191 struct frand_state buf_state;
192 struct frand_state buf_state_prev;
193 struct frand_state dedupe_state;
195 unsigned int verify_batch;
196 unsigned int trim_batch;
198 struct thread_io_list *vstate;
203 * IO engine hooks, contains everything needed to submit an io_u
204 * to any of the available IO engines.
206 struct ioengine_ops *io_ops;
209 * Queue depth of io_u's that fio MIGHT do
211 unsigned int cur_depth;
214 * io_u's about to be committed
216 unsigned int io_u_queued;
219 * io_u's submitted but not completed yet
221 unsigned int io_u_in_flight;
224 * List of free and busy io_u's
226 struct io_u_ring io_u_requeues;
227 struct io_u_queue io_u_freelist;
228 struct io_u_queue io_u_all;
229 pthread_mutex_t io_u_lock;
230 pthread_cond_t free_cond;
233 * async verify offload
235 struct flist_head verify_list;
236 pthread_t *verify_threads;
237 unsigned int nr_verify_threads;
238 pthread_cond_t verify_cond;
239 int verify_thread_exit;
244 uint64_t rate_bps[DDIR_RWDIR_CNT];
245 unsigned long rate_next_io_time[DDIR_RWDIR_CNT];
246 unsigned long rate_bytes[DDIR_RWDIR_CNT];
247 unsigned long rate_blocks[DDIR_RWDIR_CNT];
248 unsigned long rate_io_issue_bytes[DDIR_RWDIR_CNT];
249 struct timeval lastrate[DDIR_RWDIR_CNT];
251 struct frand_state poisson_state;
254 * Enforced rate submission/completion workqueue
256 struct workqueue io_wq;
258 uint64_t total_io_size;
259 uint64_t fill_device_size;
264 uint64_t io_issues[DDIR_RWDIR_CNT];
265 uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
271 uint64_t io_blocks[DDIR_RWDIR_CNT];
272 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
273 uint64_t io_bytes[DDIR_RWDIR_CNT];
274 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
275 uint64_t io_skip_bytes;
277 struct fio_mutex *mutex;
278 uint64_t bytes_done[DDIR_RWDIR_CNT];
281 * State for random io, a bitmap of blocks done vs not done
283 struct frand_state random_state;
285 struct timeval start; /* start of this loop */
286 struct timeval epoch; /* time job was started */
287 struct timeval last_issue;
289 struct timeval tv_cache;
290 struct timeval terminate_time;
291 unsigned int tv_cache_nr;
292 unsigned int tv_cache_mask;
293 unsigned int ramp_time_over;
296 * Time since last latency_window was started
298 struct timeval latency_ts;
299 unsigned int latency_qd;
300 unsigned int latency_qd_high;
301 unsigned int latency_qd_low;
302 unsigned int latency_failed;
303 uint64_t latency_ios;
307 * read/write mixed workload state
309 struct frand_state rwmix_state;
310 unsigned long rwmix_issues;
311 enum fio_ddir rwmix_ddir;
312 unsigned int ddir_seq_nr;
315 * rand/seq mixed workload state
317 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
320 * IO history logs for verification. We use a tree for sorting,
321 * if we are overwriting. Otherwise just use a fifo.
323 struct rb_root io_hist_tree;
324 struct flist_head io_hist_list;
325 unsigned long io_hist_len;
330 struct flist_head io_log_list;
333 * For tracking/handling discards
335 struct flist_head trim_list;
336 unsigned long trim_entries;
338 struct flist_head next_rand_list;
341 * for fileservice, how often to switch to a new file
343 unsigned int file_service_nr;
344 unsigned int file_service_left;
345 struct fio_file *file_service_file;
347 unsigned int sync_file_range_nr;
350 * For generating file sizes
352 struct frand_state file_size_state;
357 unsigned int total_err_count;
360 struct fio_flow *flow;
363 * Can be overloaded by profiles
365 struct prof_io_ops prof_io_ops;
372 * when should interactive ETA output be generated
380 #define __td_verror(td, err, msg, func) \
382 unsigned int ____e = (err); \
385 (td)->error = ____e; \
386 if (!(td)->first_error) \
387 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
391 #define td_clear_error(td) do { \
394 (td)->parent->error = 0; \
397 #define td_verror(td, err, func) do { \
398 __td_verror((td), (err), strerror((err)), (func)); \
400 __td_verror((td)->parent, (err), strerror((err)), (func)); \
403 #define td_vmsg(td, err, msg, func) do { \
404 __td_verror((td), (err), (msg), (func)); \
406 __td_verror((td)->parent, (err), (msg), (func)); \
409 #define __fio_stringify_1(x) #x
410 #define __fio_stringify(x) __fio_stringify_1(x)
412 extern int exitall_on_terminate;
413 extern unsigned int thread_number;
414 extern unsigned int stat_number;
417 extern int output_format;
418 extern int append_terse_output;
419 extern int temp_stall_ts;
420 extern uintptr_t page_mask, page_size;
421 extern int read_only;
422 extern int eta_print;
423 extern int eta_new_line;
424 extern unsigned long done_secs;
425 extern char *job_section;
426 extern int fio_gtod_offload;
427 extern int fio_gtod_cpu;
428 extern enum fio_cs fio_clock_source;
429 extern int fio_clock_source_set;
430 extern int warnings_fatal;
431 extern int terse_version;
432 extern int is_backend;
433 extern int nr_clients;
434 extern int log_syslog;
435 extern int status_interval;
436 extern const char fio_version_string[];
437 extern int helper_do_stat;
438 extern pthread_cond_t helper_cond;
439 extern char *trigger_file;
440 extern char *trigger_cmd;
441 extern char *trigger_remote_cmd;
442 extern long long trigger_timeout;
443 extern char *aux_path;
445 extern struct thread_data *threads;
447 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
449 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
452 #define REAL_MAX_JOBS 2048
454 static inline int should_fsync(struct thread_data *td)
456 if (td->last_was_sync)
458 if (td_write(td) || td_rw(td) || td->o.override_sync)
465 * Init/option functions
467 extern int __must_check fio_init_options(void);
468 extern int __must_check parse_options(int, char **);
469 extern int parse_jobs_ini(char *, int, int, int);
470 extern int parse_cmd_line(int, char **, int);
471 extern int fio_backend(void);
472 extern void reset_fio_state(void);
473 extern void clear_io_state(struct thread_data *, int);
474 extern int fio_options_parse(struct thread_data *, char **, int, int);
475 extern void fio_keywords_init(void);
476 extern void fio_keywords_exit(void);
477 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
478 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
479 extern void fio_fill_default_options(struct thread_data *);
480 extern int fio_show_option_help(const char *);
481 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
482 extern void fio_options_dup_and_init(struct option *);
483 extern void fio_options_mem_dupe(struct thread_data *);
484 extern void options_mem_dupe(void *data, struct fio_option *options);
485 extern void td_fill_rand_seeds(struct thread_data *);
486 extern void add_job_opts(const char **, int);
487 extern char *num2str(uint64_t, int, int, int, int);
488 extern int ioengine_load(struct thread_data *);
489 extern int parse_dryrun(void);
490 extern int fio_running_or_pending_io_threads(void);
491 extern int fio_set_fd_nonblocking(int, const char *);
492 extern void sig_show_status(int sig);
494 extern uintptr_t page_mask;
495 extern uintptr_t page_size;
496 extern int initialize_fio(char *envp[]);
497 extern void deinitialize_fio(void);
499 #define FIO_GETOPT_JOB 0x89000000
500 #define FIO_GETOPT_IOENGINE 0x98000000
501 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
506 extern void print_thread_status(void);
507 extern void print_status_init(int);
508 extern char *fio_uint_to_kmg(unsigned int val);
511 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
512 * will never back again. It may cycle between running/verififying/fsyncing.
513 * Once the thread reaches TD_EXITED, it is just waiting for the core to
532 extern void td_set_runstate(struct thread_data *, int);
533 extern int td_bump_runstate(struct thread_data *, int);
534 extern void td_restore_runstate(struct thread_data *, int);
537 * Allow 60 seconds for a job to quit on its own, otherwise reap with
540 #define FIO_REAP_TIMEOUT 60
542 #define TERMINATE_ALL (-1U)
543 extern void fio_terminate_threads(unsigned int);
544 extern void fio_mark_td_terminate(struct thread_data *);
549 extern int __must_check fio_pin_memory(struct thread_data *);
550 extern void fio_unpin_memory(struct thread_data *);
551 extern int __must_check allocate_io_mem(struct thread_data *);
552 extern void free_io_mem(struct thread_data *);
553 extern void free_threads_shm(void);
556 * Reset stats after ramp time completes
558 extern void reset_all_stats(struct thread_data *);
563 #ifdef FIO_HAVE_BLKTRACE
564 extern int is_blktrace(const char *, int *);
565 extern int load_blktrace(struct thread_data *, const char *, int);
569 * Latency target helpers
571 extern void lat_target_check(struct thread_data *);
572 extern void lat_target_init(struct thread_data *);
573 extern void lat_target_reset(struct thread_data *);
575 #define for_each_td(td, i) \
576 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
577 #define for_each_file(td, f, i) \
578 if ((td)->files_index) \
579 for ((i) = 0, (f) = (td)->files[0]; \
580 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
583 #define fio_assert(td, cond) do { \
586 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
587 td_set_runstate((td), TD_EXITED); \
588 (td)->error = EFAULT; \
593 static inline int fio_fill_issue_time(struct thread_data *td)
595 if (td->o.read_iolog_file ||
596 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
602 static inline int __should_check_rate(struct thread_data *td,
605 struct thread_options *o = &td->o;
608 * If some rate setting was given, we need to check it
610 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
611 o->rate_iops_min[ddir])
617 static inline int should_check_rate(struct thread_data *td)
621 if (td->bytes_done[DDIR_READ])
622 ret |= __should_check_rate(td, DDIR_READ);
623 if (td->bytes_done[DDIR_WRITE])
624 ret |= __should_check_rate(td, DDIR_WRITE);
625 if (td->bytes_done[DDIR_TRIM])
626 ret |= __should_check_rate(td, DDIR_TRIM);
631 static inline unsigned int td_max_bs(struct thread_data *td)
635 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
636 return max(td->o.max_bs[DDIR_TRIM], max_bs);
639 static inline unsigned int td_min_bs(struct thread_data *td)
643 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
644 return min(td->o.min_bs[DDIR_TRIM], min_bs);
647 static inline int td_async_processing(struct thread_data *td)
649 return (td->flags & TD_F_NEED_LOCK) != 0;
653 * We currently only need to do locking if we have verifier threads
654 * accessing our internal structures too
656 static inline void td_io_u_lock(struct thread_data *td)
658 if (td_async_processing(td))
659 pthread_mutex_lock(&td->io_u_lock);
662 static inline void td_io_u_unlock(struct thread_data *td)
664 if (td_async_processing(td))
665 pthread_mutex_unlock(&td->io_u_lock);
668 static inline void td_io_u_free_notify(struct thread_data *td)
670 if (td_async_processing(td))
671 pthread_cond_signal(&td->free_cond);
674 extern const char *fio_get_arch_string(int);
675 extern const char *fio_get_os_string(int);
678 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
679 #define FIELD_SIZE(s, f) (sizeof(((typeof(s))0)->f))
683 __FIO_OUTPUT_TERSE = 0,
684 __FIO_OUTPUT_JSON = 1,
685 __FIO_OUTPUT_NORMAL = 2,
686 __FIO_OUTPUT_JSON_PLUS = 3,
689 FIO_OUTPUT_TERSE = 1U << __FIO_OUTPUT_TERSE,
690 FIO_OUTPUT_JSON = 1U << __FIO_OUTPUT_JSON,
691 FIO_OUTPUT_NORMAL = 1U << __FIO_OUTPUT_NORMAL,
692 FIO_OUTPUT_JSON_PLUS = 1U << __FIO_OUTPUT_JSON_PLUS,
696 FIO_RAND_DIST_RANDOM = 0,
698 FIO_RAND_DIST_PARETO,
702 #define FIO_DEF_ZIPF 1.1
703 #define FIO_DEF_PARETO 0.2
706 FIO_RAND_GEN_TAUSWORTHE = 0,
708 FIO_RAND_GEN_TAUSWORTHE64,
716 extern void exec_trigger(const char *);
717 extern void check_trigger_file(void);