8 #include <sys/resource.h>
17 #include "compiler/compiler.h"
18 #include "thread_options.h"
21 #include "arch/arch.h"
35 #include "oslib/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,
82 TD_F_REGROW_LOGS = 1U << 14,
91 FIO_RAND_FILE_SIZE_OFF,
94 FIO_RAND_SEQ_RAND_READ_OFF,
95 FIO_RAND_SEQ_RAND_WRITE_OFF,
96 FIO_RAND_SEQ_RAND_TRIM_OFF,
108 RATE_PROCESS_LINEAR = 0,
109 RATE_PROCESS_POISSON = 1,
113 * Per-thread/process specific data. Only used for the network client
117 void sk_out_assign(struct sk_out *);
118 void sk_out_drop(void);
120 struct zone_split_index {
122 uint8_t size_perc_prev;
126 * This describes a single thread/process executing a fio job.
129 struct thread_options o;
130 struct flist_head opt_list;
133 char verror[FIO_VERROR_SIZE];
135 unsigned int thread_number;
136 unsigned int subjob_number;
137 unsigned int groupid;
138 struct thread_stat ts;
142 struct io_log *slat_log;
143 struct io_log *clat_log;
144 struct io_log *lat_log;
145 struct io_log *bw_log;
146 struct io_log *iops_log;
148 struct workqueue log_compress_wq;
150 struct thread_data *parent;
152 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
153 struct timeval bw_sample_time;
155 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
156 struct timeval iops_sample_time;
158 volatile int update_rusage;
159 struct fio_mutex *rusage_sem;
160 struct rusage ru_start;
161 struct rusage ru_end;
163 struct fio_file **files;
164 unsigned char *file_locks;
165 unsigned int files_size;
166 unsigned int files_index;
167 unsigned int nr_open_files;
168 unsigned int nr_done_files;
169 unsigned int nr_normal_files;
171 unsigned int next_file;
172 struct frand_state next_file_state;
175 struct zipf_state next_file_zipf;
176 struct gauss_state next_file_gauss;
189 size_t orig_buffer_size;
190 volatile int terminate;
191 volatile int runstate;
192 unsigned int last_was_sync;
193 enum fio_ddir last_ddir;
202 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
204 struct frand_state bsrange_state;
205 struct frand_state verify_state;
206 struct frand_state trim_state;
207 struct frand_state delay_state;
209 struct frand_state buf_state;
210 struct frand_state buf_state_prev;
211 struct frand_state dedupe_state;
212 struct frand_state zone_state;
214 struct zone_split_index **zone_state_index;
216 unsigned int verify_batch;
217 unsigned int trim_batch;
219 struct thread_io_list *vstate;
224 * IO engine hooks, contains everything needed to submit an io_u
225 * to any of the available IO engines.
227 struct ioengine_ops *io_ops;
230 * IO engine private data and dlhandle.
233 void *io_ops_dlhandle;
236 * Queue depth of io_u's that fio MIGHT do
238 unsigned int cur_depth;
241 * io_u's about to be committed
243 unsigned int io_u_queued;
246 * io_u's submitted but not completed yet
248 unsigned int io_u_in_flight;
251 * List of free and busy io_u's
253 struct io_u_ring io_u_requeues;
254 struct io_u_queue io_u_freelist;
255 struct io_u_queue io_u_all;
256 pthread_mutex_t io_u_lock;
257 pthread_cond_t free_cond;
260 * async verify offload
262 struct flist_head verify_list;
263 pthread_t *verify_threads;
264 unsigned int nr_verify_threads;
265 pthread_cond_t verify_cond;
266 int verify_thread_exit;
271 uint64_t rate_bps[DDIR_RWDIR_CNT];
272 unsigned long rate_next_io_time[DDIR_RWDIR_CNT];
273 unsigned long rate_bytes[DDIR_RWDIR_CNT];
274 unsigned long rate_blocks[DDIR_RWDIR_CNT];
275 unsigned long rate_io_issue_bytes[DDIR_RWDIR_CNT];
276 struct timeval lastrate[DDIR_RWDIR_CNT];
278 struct frand_state poisson_state;
281 * Enforced rate submission/completion workqueue
283 struct workqueue io_wq;
285 uint64_t total_io_size;
286 uint64_t fill_device_size;
291 uint64_t io_issues[DDIR_RWDIR_CNT];
292 uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
298 uint64_t io_blocks[DDIR_RWDIR_CNT];
299 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
300 uint64_t io_bytes[DDIR_RWDIR_CNT];
301 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
302 uint64_t io_skip_bytes;
304 struct fio_mutex *mutex;
305 uint64_t bytes_done[DDIR_RWDIR_CNT];
308 * State for random io, a bitmap of blocks done vs not done
310 struct frand_state random_state;
312 struct timeval start; /* start of this loop */
313 struct timeval epoch; /* time job was started */
314 struct timeval last_issue;
316 struct timeval tv_cache;
317 struct timeval terminate_time;
318 unsigned int tv_cache_nr;
319 unsigned int tv_cache_mask;
320 unsigned int ramp_time_over;
323 * Time since last latency_window was started
325 struct timeval latency_ts;
326 unsigned int latency_qd;
327 unsigned int latency_qd_high;
328 unsigned int latency_qd_low;
329 unsigned int latency_failed;
330 uint64_t latency_ios;
334 * read/write mixed workload state
336 struct frand_state rwmix_state;
337 unsigned long rwmix_issues;
338 enum fio_ddir rwmix_ddir;
339 unsigned int ddir_seq_nr;
342 * rand/seq mixed workload state
344 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
347 * IO history logs for verification. We use a tree for sorting,
348 * if we are overwriting. Otherwise just use a fifo.
350 struct rb_root io_hist_tree;
351 struct flist_head io_hist_list;
352 unsigned long io_hist_len;
357 struct flist_head io_log_list;
360 * For tracking/handling discards
362 struct flist_head trim_list;
363 unsigned long trim_entries;
365 struct flist_head next_rand_list;
368 * for fileservice, how often to switch to a new file
370 unsigned int file_service_nr;
371 unsigned int file_service_left;
372 struct fio_file *file_service_file;
374 unsigned int sync_file_range_nr;
377 * For generating file sizes
379 struct frand_state file_size_state;
384 unsigned int total_err_count;
387 struct fio_flow *flow;
390 * Can be overloaded by profiles
392 struct prof_io_ops prof_io_ops;
399 * when should interactive ETA output be generated
407 #define __td_verror(td, err, msg, func) \
409 unsigned int ____e = (err); \
412 (td)->error = ____e; \
413 if (!(td)->first_error) \
414 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
418 #define td_clear_error(td) do { \
421 (td)->parent->error = 0; \
424 #define td_verror(td, err, func) do { \
425 __td_verror((td), (err), strerror((err)), (func)); \
427 __td_verror((td)->parent, (err), strerror((err)), (func)); \
430 #define td_vmsg(td, err, msg, func) do { \
431 __td_verror((td), (err), (msg), (func)); \
433 __td_verror((td)->parent, (err), (msg), (func)); \
436 #define __fio_stringify_1(x) #x
437 #define __fio_stringify(x) __fio_stringify_1(x)
439 extern int exitall_on_terminate;
440 extern unsigned int thread_number;
441 extern unsigned int stat_number;
444 extern int output_format;
445 extern int append_terse_output;
446 extern int temp_stall_ts;
447 extern uintptr_t page_mask, page_size;
448 extern int read_only;
449 extern int eta_print;
450 extern int eta_new_line;
451 extern unsigned long done_secs;
452 extern char *job_section;
453 extern int fio_gtod_offload;
454 extern int fio_gtod_cpu;
455 extern enum fio_cs fio_clock_source;
456 extern int fio_clock_source_set;
457 extern int warnings_fatal;
458 extern int terse_version;
459 extern int is_backend;
460 extern int nr_clients;
461 extern int log_syslog;
462 extern int status_interval;
463 extern const char fio_version_string[];
464 extern char *trigger_file;
465 extern char *trigger_cmd;
466 extern char *trigger_remote_cmd;
467 extern long long trigger_timeout;
468 extern char *aux_path;
470 extern struct thread_data *threads;
472 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
474 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
477 #define REAL_MAX_JOBS 2048
479 static inline int should_fsync(struct thread_data *td)
481 if (td->last_was_sync)
483 if (td_write(td) || td_rw(td) || td->o.override_sync)
490 * Init/option functions
492 extern int __must_check fio_init_options(void);
493 extern int __must_check parse_options(int, char **);
494 extern int parse_jobs_ini(char *, int, int, int);
495 extern int parse_cmd_line(int, char **, int);
496 extern int fio_backend(struct sk_out *);
497 extern void reset_fio_state(void);
498 extern void clear_io_state(struct thread_data *, int);
499 extern int fio_options_parse(struct thread_data *, char **, int);
500 extern void fio_keywords_init(void);
501 extern void fio_keywords_exit(void);
502 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
503 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
504 extern void fio_fill_default_options(struct thread_data *);
505 extern int fio_show_option_help(const char *);
506 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
507 extern void fio_options_dup_and_init(struct option *);
508 extern void fio_options_mem_dupe(struct thread_data *);
509 extern void options_mem_dupe(void *data, struct fio_option *options);
510 extern void td_fill_rand_seeds(struct thread_data *);
511 extern void td_fill_verify_state_seed(struct thread_data *);
512 extern void add_job_opts(const char **, int);
513 extern char *num2str(uint64_t, int, int, int, int);
514 extern int ioengine_load(struct thread_data *);
515 extern int parse_dryrun(void);
516 extern int fio_running_or_pending_io_threads(void);
517 extern int fio_set_fd_nonblocking(int, const char *);
518 extern void sig_show_status(int sig);
519 extern struct thread_data *get_global_options(void);
521 extern uintptr_t page_mask;
522 extern uintptr_t page_size;
523 extern int initialize_fio(char *envp[]);
524 extern void deinitialize_fio(void);
526 #define FIO_GETOPT_JOB 0x89000000
527 #define FIO_GETOPT_IOENGINE 0x98000000
528 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
533 extern void print_thread_status(void);
534 extern void print_status_init(int);
535 extern char *fio_uint_to_kmg(unsigned int val);
538 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
539 * will never back again. It may cycle between running/verififying/fsyncing.
540 * Once the thread reaches TD_EXITED, it is just waiting for the core to
559 extern void td_set_runstate(struct thread_data *, int);
560 extern int td_bump_runstate(struct thread_data *, int);
561 extern void td_restore_runstate(struct thread_data *, int);
562 extern const char *runstate_to_name(int runstate);
565 * Allow 60 seconds for a job to quit on its own, otherwise reap with
568 #define FIO_REAP_TIMEOUT 60
570 #define TERMINATE_ALL (-1U)
571 extern void fio_terminate_threads(unsigned int);
572 extern void fio_mark_td_terminate(struct thread_data *);
577 extern int __must_check fio_pin_memory(struct thread_data *);
578 extern void fio_unpin_memory(struct thread_data *);
579 extern int __must_check allocate_io_mem(struct thread_data *);
580 extern void free_io_mem(struct thread_data *);
581 extern void free_threads_shm(void);
584 * Reset stats after ramp time completes
586 extern void reset_all_stats(struct thread_data *);
591 #ifdef FIO_HAVE_BLKTRACE
592 extern int is_blktrace(const char *, int *);
593 extern int load_blktrace(struct thread_data *, const char *, int);
596 extern int io_queue_event(struct thread_data *td, struct io_u *io_u, int *ret,
597 enum fio_ddir ddir, uint64_t *bytes_issued, int from_verify,
598 struct timeval *comp_time);
601 * Latency target helpers
603 extern void lat_target_check(struct thread_data *);
604 extern void lat_target_init(struct thread_data *);
605 extern void lat_target_reset(struct thread_data *);
607 #define for_each_td(td, i) \
608 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
609 #define for_each_file(td, f, i) \
610 if ((td)->files_index) \
611 for ((i) = 0, (f) = (td)->files[0]; \
612 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
615 #define fio_assert(td, cond) do { \
618 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
619 td_set_runstate((td), TD_EXITED); \
620 (td)->error = EFAULT; \
625 static inline int fio_fill_issue_time(struct thread_data *td)
627 if (td->o.read_iolog_file ||
628 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
634 static inline int __should_check_rate(struct thread_data *td,
637 struct thread_options *o = &td->o;
640 * If some rate setting was given, we need to check it
642 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
643 o->rate_iops_min[ddir])
649 static inline int should_check_rate(struct thread_data *td)
653 if (td->bytes_done[DDIR_READ])
654 ret |= __should_check_rate(td, DDIR_READ);
655 if (td->bytes_done[DDIR_WRITE])
656 ret |= __should_check_rate(td, DDIR_WRITE);
657 if (td->bytes_done[DDIR_TRIM])
658 ret |= __should_check_rate(td, DDIR_TRIM);
663 static inline unsigned int td_max_bs(struct thread_data *td)
667 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
668 return max(td->o.max_bs[DDIR_TRIM], max_bs);
671 static inline unsigned int td_min_bs(struct thread_data *td)
675 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
676 return min(td->o.min_bs[DDIR_TRIM], min_bs);
679 static inline int td_async_processing(struct thread_data *td)
681 return (td->flags & TD_F_NEED_LOCK) != 0;
685 * We currently only need to do locking if we have verifier threads
686 * accessing our internal structures too
688 static inline void td_io_u_lock(struct thread_data *td)
690 if (td_async_processing(td))
691 pthread_mutex_lock(&td->io_u_lock);
694 static inline void td_io_u_unlock(struct thread_data *td)
696 if (td_async_processing(td))
697 pthread_mutex_unlock(&td->io_u_lock);
700 static inline void td_io_u_free_notify(struct thread_data *td)
702 if (td_async_processing(td))
703 pthread_cond_signal(&td->free_cond);
706 extern const char *fio_get_arch_string(int);
707 extern const char *fio_get_os_string(int);
710 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
711 #define FIELD_SIZE(s, f) (sizeof(((typeof(s))0)->f))
715 __FIO_OUTPUT_TERSE = 0,
716 __FIO_OUTPUT_JSON = 1,
717 __FIO_OUTPUT_NORMAL = 2,
718 __FIO_OUTPUT_JSON_PLUS = 3,
721 FIO_OUTPUT_TERSE = 1U << __FIO_OUTPUT_TERSE,
722 FIO_OUTPUT_JSON = 1U << __FIO_OUTPUT_JSON,
723 FIO_OUTPUT_NORMAL = 1U << __FIO_OUTPUT_NORMAL,
724 FIO_OUTPUT_JSON_PLUS = 1U << __FIO_OUTPUT_JSON_PLUS,
728 FIO_RAND_DIST_RANDOM = 0,
730 FIO_RAND_DIST_PARETO,
735 #define FIO_DEF_ZIPF 1.1
736 #define FIO_DEF_PARETO 0.2
739 FIO_RAND_GEN_TAUSWORTHE = 0,
741 FIO_RAND_GEN_TAUSWORTHE64,
749 extern void exec_trigger(const char *);
750 extern void check_trigger_file(void);