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,
107 * This describes a single thread/process executing a fio job.
110 struct thread_options o;
113 char verror[FIO_VERROR_SIZE];
115 unsigned int thread_number;
116 unsigned int subjob_number;
117 unsigned int groupid;
118 struct thread_stat ts;
122 struct io_log *slat_log;
123 struct io_log *clat_log;
124 struct io_log *lat_log;
125 struct io_log *bw_log;
126 struct io_log *iops_log;
128 struct tp_data *tp_data;
130 struct thread_data *parent;
132 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
133 struct timeval bw_sample_time;
135 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
136 struct timeval iops_sample_time;
139 * Tracks the last iodepth number of completed writes, if data
140 * verification is enabled
142 uint64_t *last_write_comp;
143 unsigned int last_write_idx;
145 volatile int update_rusage;
146 struct fio_mutex *rusage_sem;
147 struct rusage ru_start;
148 struct rusage ru_end;
150 struct fio_file **files;
151 unsigned char *file_locks;
152 unsigned int files_size;
153 unsigned int files_index;
154 unsigned int nr_open_files;
155 unsigned int nr_done_files;
156 unsigned int nr_normal_files;
158 unsigned int next_file;
159 struct frand_state next_file_state;
167 size_t orig_buffer_size;
168 volatile int terminate;
169 volatile int runstate;
170 unsigned int last_was_sync;
171 enum fio_ddir last_ddir;
180 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
182 struct frand_state bsrange_state;
183 struct frand_state verify_state;
184 struct frand_state trim_state;
185 struct frand_state delay_state;
187 struct frand_state buf_state;
188 struct frand_state buf_state_prev;
189 struct frand_state dedupe_state;
191 unsigned int verify_batch;
192 unsigned int trim_batch;
194 struct thread_io_list *vstate;
199 * IO engine hooks, contains everything needed to submit an io_u
200 * to any of the available IO engines.
202 struct ioengine_ops *io_ops;
205 * Queue depth of io_u's that fio MIGHT do
207 unsigned int cur_depth;
210 * io_u's about to be committed
212 unsigned int io_u_queued;
215 * io_u's submitted but not completed yet
217 unsigned int io_u_in_flight;
220 * List of free and busy io_u's
222 struct io_u_ring io_u_requeues;
223 struct io_u_queue io_u_freelist;
224 struct io_u_queue io_u_all;
225 pthread_mutex_t io_u_lock;
226 pthread_cond_t free_cond;
229 * async verify offload
231 struct flist_head verify_list;
232 pthread_t *verify_threads;
233 unsigned int nr_verify_threads;
234 pthread_cond_t verify_cond;
235 int verify_thread_exit;
240 uint64_t rate_bps[DDIR_RWDIR_CNT];
241 unsigned long rate_next_io_time[DDIR_RWDIR_CNT];
242 unsigned long rate_bytes[DDIR_RWDIR_CNT];
243 unsigned long rate_blocks[DDIR_RWDIR_CNT];
244 unsigned long rate_io_issue_bytes[DDIR_RWDIR_CNT];
245 struct timeval lastrate[DDIR_RWDIR_CNT];
248 * Enforced rate submission/completion workqueue
250 struct workqueue io_wq;
252 uint64_t total_io_size;
253 uint64_t fill_device_size;
258 uint64_t io_issues[DDIR_RWDIR_CNT];
259 uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
265 uint64_t io_blocks[DDIR_RWDIR_CNT];
266 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
267 uint64_t io_bytes[DDIR_RWDIR_CNT];
268 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
269 uint64_t io_skip_bytes;
271 struct fio_mutex *mutex;
272 uint64_t bytes_done[DDIR_RWDIR_CNT];
275 * State for random io, a bitmap of blocks done vs not done
277 struct frand_state random_state;
279 struct timeval start; /* start of this loop */
280 struct timeval epoch; /* time job was started */
281 struct timeval last_issue;
283 struct timeval tv_cache;
284 struct timeval terminate_time;
285 unsigned int tv_cache_nr;
286 unsigned int tv_cache_mask;
287 unsigned int ramp_time_over;
290 * Time since last latency_window was started
292 struct timeval latency_ts;
293 unsigned int latency_qd;
294 unsigned int latency_qd_high;
295 unsigned int latency_qd_low;
296 unsigned int latency_failed;
297 uint64_t latency_ios;
301 * read/write mixed workload state
303 struct frand_state rwmix_state;
304 unsigned long rwmix_issues;
305 enum fio_ddir rwmix_ddir;
306 unsigned int ddir_seq_nr;
309 * rand/seq mixed workload state
311 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
314 * IO history logs for verification. We use a tree for sorting,
315 * if we are overwriting. Otherwise just use a fifo.
317 struct rb_root io_hist_tree;
318 struct flist_head io_hist_list;
319 unsigned long io_hist_len;
324 struct flist_head io_log_list;
327 * For tracking/handling discards
329 struct flist_head trim_list;
330 unsigned long trim_entries;
332 struct flist_head next_rand_list;
335 * for fileservice, how often to switch to a new file
337 unsigned int file_service_nr;
338 unsigned int file_service_left;
339 struct fio_file *file_service_file;
341 unsigned int sync_file_range_nr;
344 * For generating file sizes
346 struct frand_state file_size_state;
351 unsigned int total_err_count;
354 struct fio_flow *flow;
357 * Can be overloaded by profiles
359 struct prof_io_ops prof_io_ops;
366 * when should interactive ETA output be generated
374 #define __td_verror(td, err, msg, func) \
376 unsigned int ____e = (err); \
379 (td)->error = ____e; \
380 if (!(td)->first_error) \
381 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
385 #define td_clear_error(td) do { \
388 (td)->parent->error = 0; \
391 #define td_verror(td, err, func) do { \
392 __td_verror((td), (err), strerror((err)), (func)); \
394 __td_verror((td)->parent, (err), strerror((err)), (func)); \
397 #define td_vmsg(td, err, msg, func) do { \
398 __td_verror((td), (err), (msg), (func)); \
400 __td_verror((td)->parent, (err), (msg), (func)); \
403 #define __fio_stringify_1(x) #x
404 #define __fio_stringify(x) __fio_stringify_1(x)
406 extern int exitall_on_terminate;
407 extern unsigned int thread_number;
408 extern unsigned int stat_number;
411 extern int output_format;
412 extern int append_terse_output;
413 extern int temp_stall_ts;
414 extern uintptr_t page_mask, page_size;
415 extern int read_only;
416 extern int eta_print;
417 extern int eta_new_line;
418 extern unsigned long done_secs;
419 extern char *job_section;
420 extern int fio_gtod_offload;
421 extern int fio_gtod_cpu;
422 extern enum fio_cs fio_clock_source;
423 extern int fio_clock_source_set;
424 extern int warnings_fatal;
425 extern int terse_version;
426 extern int is_backend;
427 extern int nr_clients;
428 extern int log_syslog;
429 extern int status_interval;
430 extern const char fio_version_string[];
431 extern int helper_do_stat;
432 extern pthread_cond_t helper_cond;
433 extern char *trigger_file;
434 extern char *trigger_cmd;
435 extern char *trigger_remote_cmd;
436 extern long long trigger_timeout;
437 extern char *aux_path;
439 extern struct thread_data *threads;
441 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
443 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
446 #define REAL_MAX_JOBS 2048
448 static inline int should_fsync(struct thread_data *td)
450 if (td->last_was_sync)
452 if (td_write(td) || td_rw(td) || td->o.override_sync)
459 * Init/option functions
461 extern int __must_check fio_init_options(void);
462 extern int __must_check parse_options(int, char **);
463 extern int parse_jobs_ini(char *, int, int, int);
464 extern int parse_cmd_line(int, char **, int);
465 extern int fio_backend(void);
466 extern void reset_fio_state(void);
467 extern void clear_io_state(struct thread_data *, int);
468 extern int fio_options_parse(struct thread_data *, char **, int, int);
469 extern void fio_keywords_init(void);
470 extern void fio_keywords_exit(void);
471 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
472 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
473 extern void fio_fill_default_options(struct thread_data *);
474 extern int fio_show_option_help(const char *);
475 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
476 extern void fio_options_dup_and_init(struct option *);
477 extern void fio_options_mem_dupe(struct thread_data *);
478 extern void options_mem_dupe(void *data, struct fio_option *options);
479 extern void td_fill_rand_seeds(struct thread_data *);
480 extern void add_job_opts(const char **, int);
481 extern char *num2str(uint64_t, int, int, int, int);
482 extern int ioengine_load(struct thread_data *);
483 extern int parse_dryrun(void);
484 extern int fio_running_or_pending_io_threads(void);
485 extern int fio_set_fd_nonblocking(int, const char *);
486 extern void sig_show_status(int sig);
488 extern uintptr_t page_mask;
489 extern uintptr_t page_size;
490 extern int initialize_fio(char *envp[]);
491 extern void deinitialize_fio(void);
493 #define FIO_GETOPT_JOB 0x89000000
494 #define FIO_GETOPT_IOENGINE 0x98000000
495 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
500 extern void print_thread_status(void);
501 extern void print_status_init(int);
502 extern char *fio_uint_to_kmg(unsigned int val);
505 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
506 * will never back again. It may cycle between running/verififying/fsyncing.
507 * Once the thread reaches TD_EXITED, it is just waiting for the core to
526 extern void td_set_runstate(struct thread_data *, int);
527 extern int td_bump_runstate(struct thread_data *, int);
528 extern void td_restore_runstate(struct thread_data *, int);
531 * Allow 60 seconds for a job to quit on its own, otherwise reap with
534 #define FIO_REAP_TIMEOUT 60
536 #define TERMINATE_ALL (-1)
537 extern void fio_terminate_threads(int);
538 extern void fio_mark_td_terminate(struct thread_data *);
543 extern int __must_check fio_pin_memory(struct thread_data *);
544 extern void fio_unpin_memory(struct thread_data *);
545 extern int __must_check allocate_io_mem(struct thread_data *);
546 extern void free_io_mem(struct thread_data *);
547 extern void free_threads_shm(void);
550 * Reset stats after ramp time completes
552 extern void reset_all_stats(struct thread_data *);
557 #ifdef FIO_HAVE_BLKTRACE
558 extern int is_blktrace(const char *, int *);
559 extern int load_blktrace(struct thread_data *, const char *, int);
563 * Latency target helpers
565 extern void lat_target_check(struct thread_data *);
566 extern void lat_target_init(struct thread_data *);
567 extern void lat_target_reset(struct thread_data *);
569 #define for_each_td(td, i) \
570 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
571 #define for_each_file(td, f, i) \
572 if ((td)->files_index) \
573 for ((i) = 0, (f) = (td)->files[0]; \
574 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
577 #define fio_assert(td, cond) do { \
580 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
581 td_set_runstate((td), TD_EXITED); \
582 (td)->error = EFAULT; \
587 static inline int fio_fill_issue_time(struct thread_data *td)
589 if (td->o.read_iolog_file ||
590 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
596 static inline int __should_check_rate(struct thread_data *td,
599 struct thread_options *o = &td->o;
602 * If some rate setting was given, we need to check it
604 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
605 o->rate_iops_min[ddir])
611 static inline int should_check_rate(struct thread_data *td)
615 if (td->bytes_done[DDIR_READ])
616 ret |= __should_check_rate(td, DDIR_READ);
617 if (td->bytes_done[DDIR_WRITE])
618 ret |= __should_check_rate(td, DDIR_WRITE);
619 if (td->bytes_done[DDIR_TRIM])
620 ret |= __should_check_rate(td, DDIR_TRIM);
625 static inline unsigned int td_max_bs(struct thread_data *td)
629 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
630 return max(td->o.max_bs[DDIR_TRIM], max_bs);
633 static inline unsigned int td_min_bs(struct thread_data *td)
637 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
638 return min(td->o.min_bs[DDIR_TRIM], min_bs);
641 static inline int td_async_processing(struct thread_data *td)
643 return (td->flags & TD_F_NEED_LOCK) != 0;
647 * We currently only need to do locking if we have verifier threads
648 * accessing our internal structures too
650 static inline void td_io_u_lock(struct thread_data *td)
652 if (td_async_processing(td))
653 pthread_mutex_lock(&td->io_u_lock);
656 static inline void td_io_u_unlock(struct thread_data *td)
658 if (td_async_processing(td))
659 pthread_mutex_unlock(&td->io_u_lock);
662 static inline void td_io_u_free_notify(struct thread_data *td)
664 if (td_async_processing(td))
665 pthread_cond_signal(&td->free_cond);
668 extern const char *fio_get_arch_string(int);
669 extern const char *fio_get_os_string(int);
672 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
673 #define FIELD_SIZE(s, f) (sizeof(((typeof(s))0)->f))
677 __FIO_OUTPUT_TERSE = 0,
678 __FIO_OUTPUT_JSON = 1,
679 __FIO_OUTPUT_NORMAL = 2,
682 FIO_OUTPUT_TERSE = 1U << __FIO_OUTPUT_TERSE,
683 FIO_OUTPUT_JSON = 1U << __FIO_OUTPUT_JSON,
684 FIO_OUTPUT_NORMAL = 1U << __FIO_OUTPUT_NORMAL,
688 FIO_RAND_DIST_RANDOM = 0,
690 FIO_RAND_DIST_PARETO,
694 #define FIO_DEF_ZIPF 1.1
695 #define FIO_DEF_PARETO 0.2
698 FIO_RAND_GEN_TAUSWORTHE = 0,
700 FIO_RAND_GEN_TAUSWORTHE64,
708 extern void exec_trigger(const char *);
709 extern void check_trigger_file(void);