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"
43 #include "io_u_queue.h"
44 #include "workqueue.h"
45 #include "steadystate.h"
47 #ifdef CONFIG_SOLARISAIO
48 #include <sys/asynch.h>
52 #include <linux/mempolicy.h>
56 * "local" is pseudo-policy
58 #define MPOL_LOCAL MPOL_MAX
62 * offset generator types
70 TD_F_VER_BACKLOG = 1U << 0,
71 TD_F_TRIM_BACKLOG = 1U << 1,
72 TD_F_READ_IOLOG = 1U << 2,
73 TD_F_REFILL_BUFFERS = 1U << 3,
74 TD_F_SCRAMBLE_BUFFERS = 1U << 4,
75 TD_F_VER_NONE = 1U << 5,
76 TD_F_PROFILE_OPS = 1U << 6,
77 TD_F_COMPRESS = 1U << 7,
78 TD_F_RESERVED = 1U << 8, /* not used */
79 TD_F_COMPRESS_LOG = 1U << 9,
80 TD_F_VSTATE_SAVED = 1U << 10,
81 TD_F_NEED_LOCK = 1U << 11,
82 TD_F_CHILD = 1U << 12,
83 TD_F_NO_PROGRESS = 1U << 13,
84 TD_F_REGROW_LOGS = 1U << 14,
93 FIO_RAND_FILE_SIZE_OFF,
96 FIO_RAND_SEQ_RAND_READ_OFF,
97 FIO_RAND_SEQ_RAND_WRITE_OFF,
98 FIO_RAND_SEQ_RAND_TRIM_OFF,
101 FIO_RAND_POISSON_OFF,
110 RATE_PROCESS_LINEAR = 0,
111 RATE_PROCESS_POISSON = 1,
122 * Per-thread/process specific data. Only used for the network client
125 void sk_out_assign(struct sk_out *);
126 void sk_out_drop(void);
128 struct zone_split_index {
130 uint8_t size_perc_prev;
134 * This describes a single thread/process executing a fio job.
137 struct flist_head opt_list;
139 struct thread_options o;
142 unsigned int thread_number;
143 unsigned int subjob_number;
144 unsigned int groupid;
145 struct thread_stat ts;
149 struct io_log *slat_log;
150 struct io_log *clat_log;
151 struct io_log *clat_hist_log;
152 struct io_log *lat_log;
153 struct io_log *bw_log;
154 struct io_log *iops_log;
156 struct workqueue log_compress_wq;
158 struct thread_data *parent;
160 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
161 struct timeval bw_sample_time;
163 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
164 struct timeval iops_sample_time;
166 volatile int update_rusage;
167 struct fio_mutex *rusage_sem;
168 struct rusage ru_start;
169 struct rusage ru_end;
171 struct fio_file **files;
172 unsigned char *file_locks;
173 unsigned int files_size;
174 unsigned int files_index;
175 unsigned int nr_open_files;
176 unsigned int nr_done_files;
177 unsigned int nr_normal_files;
179 unsigned int next_file;
180 struct frand_state next_file_state;
183 struct zipf_state next_file_zipf;
184 struct gauss_state next_file_gauss;
197 size_t orig_buffer_size;
198 volatile int terminate;
199 volatile int runstate;
200 unsigned int last_was_sync;
201 enum fio_ddir last_ddir;
208 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
210 struct frand_state bsrange_state;
211 struct frand_state verify_state;
212 struct frand_state trim_state;
213 struct frand_state delay_state;
215 struct frand_state buf_state;
216 struct frand_state buf_state_prev;
217 struct frand_state dedupe_state;
218 struct frand_state zone_state;
220 struct zone_split_index **zone_state_index;
222 unsigned int verify_batch;
223 unsigned int trim_batch;
225 struct thread_io_list *vstate;
230 * IO engine hooks, contains everything needed to submit an io_u
231 * to any of the available IO engines.
233 struct ioengine_ops *io_ops;
237 * IO engine private data and dlhandle.
240 void *io_ops_dlhandle;
243 * Queue depth of io_u's that fio MIGHT do
245 unsigned int cur_depth;
248 * io_u's about to be committed
250 unsigned int io_u_queued;
253 * io_u's submitted but not completed yet
255 unsigned int io_u_in_flight;
258 * List of free and busy io_u's
260 struct io_u_ring io_u_requeues;
261 struct io_u_queue io_u_freelist;
262 struct io_u_queue io_u_all;
263 pthread_mutex_t io_u_lock;
264 pthread_cond_t free_cond;
267 * async verify offload
269 struct flist_head verify_list;
270 pthread_t *verify_threads;
271 unsigned int nr_verify_threads;
272 pthread_cond_t verify_cond;
273 int verify_thread_exit;
278 uint64_t rate_bps[DDIR_RWDIR_CNT];
279 uint64_t rate_next_io_time[DDIR_RWDIR_CNT];
280 unsigned long rate_bytes[DDIR_RWDIR_CNT];
281 unsigned long rate_blocks[DDIR_RWDIR_CNT];
282 unsigned long long rate_io_issue_bytes[DDIR_RWDIR_CNT];
283 struct timeval lastrate[DDIR_RWDIR_CNT];
285 struct frand_state poisson_state;
288 * Enforced rate submission/completion workqueue
290 struct workqueue io_wq;
292 uint64_t total_io_size;
293 uint64_t fill_device_size;
298 uint64_t io_issues[DDIR_RWDIR_CNT];
299 uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
305 uint64_t io_blocks[DDIR_RWDIR_CNT];
306 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
307 uint64_t io_bytes[DDIR_RWDIR_CNT];
308 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
309 uint64_t io_skip_bytes;
311 struct fio_mutex *mutex;
312 uint64_t bytes_done[DDIR_RWDIR_CNT];
315 * State for random io, a bitmap of blocks done vs not done
317 struct frand_state random_state;
319 struct timeval start; /* start of this loop */
320 struct timeval epoch; /* time job was started */
321 unsigned long long unix_epoch; /* Time job was started, unix epoch based. */
322 struct timeval last_issue;
324 struct timeval tv_cache;
325 struct timeval terminate_time;
326 unsigned int tv_cache_nr;
327 unsigned int tv_cache_mask;
328 unsigned int ramp_time_over;
331 * Time since last latency_window was started
333 struct timeval latency_ts;
334 unsigned int latency_qd;
335 unsigned int latency_qd_high;
336 unsigned int latency_qd_low;
337 unsigned int latency_failed;
338 uint64_t latency_ios;
342 * read/write mixed workload state
344 struct frand_state rwmix_state;
345 unsigned long rwmix_issues;
346 enum fio_ddir rwmix_ddir;
347 unsigned int ddir_seq_nr;
350 * rand/seq mixed workload state
352 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
355 * IO history logs for verification. We use a tree for sorting,
356 * if we are overwriting. Otherwise just use a fifo.
358 struct rb_root io_hist_tree;
359 struct flist_head io_hist_list;
360 unsigned long io_hist_len;
365 struct flist_head io_log_list;
368 * For tracking/handling discards
370 struct flist_head trim_list;
371 unsigned long trim_entries;
373 struct flist_head next_rand_list;
376 * for fileservice, how often to switch to a new file
378 unsigned int file_service_nr;
379 unsigned int file_service_left;
380 struct fio_file *file_service_file;
382 unsigned int sync_file_range_nr;
385 * For generating file sizes
387 struct frand_state file_size_state;
392 unsigned int total_err_count;
395 struct fio_flow *flow;
398 * Can be overloaded by profiles
400 struct prof_io_ops prof_io_ops;
405 struct steadystate_data ss;
407 char verror[FIO_VERROR_SIZE];
411 * when should interactive ETA output be generated
419 #define __td_verror(td, err, msg, func) \
421 unsigned int ____e = (err); \
424 (td)->error = ____e; \
425 if (!(td)->first_error) \
426 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
430 #define td_clear_error(td) do { \
433 (td)->parent->error = 0; \
436 #define td_verror(td, err, func) do { \
437 __td_verror((td), (err), strerror((err)), (func)); \
439 __td_verror((td)->parent, (err), strerror((err)), (func)); \
442 #define td_vmsg(td, err, msg, func) do { \
443 __td_verror((td), (err), (msg), (func)); \
445 __td_verror((td)->parent, (err), (msg), (func)); \
448 #define __fio_stringify_1(x) #x
449 #define __fio_stringify(x) __fio_stringify_1(x)
451 extern int exitall_on_terminate;
452 extern unsigned int thread_number;
453 extern unsigned int stat_number;
456 extern int output_format;
457 extern int append_terse_output;
458 extern int temp_stall_ts;
459 extern uintptr_t page_mask, page_size;
460 extern int read_only;
461 extern int eta_print;
462 extern int eta_new_line;
463 extern unsigned long done_secs;
464 extern int fio_gtod_offload;
465 extern int fio_gtod_cpu;
466 extern enum fio_cs fio_clock_source;
467 extern int fio_clock_source_set;
468 extern int warnings_fatal;
469 extern int terse_version;
470 extern int is_backend;
471 extern int nr_clients;
472 extern int log_syslog;
473 extern int status_interval;
474 extern const char fio_version_string[];
475 extern char *trigger_file;
476 extern char *trigger_cmd;
477 extern char *trigger_remote_cmd;
478 extern long long trigger_timeout;
479 extern char *aux_path;
481 extern struct thread_data *threads;
483 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
485 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
488 #define REAL_MAX_JOBS 4096
490 static inline int should_fsync(struct thread_data *td)
492 if (td->last_was_sync)
494 if (td_write(td) || td->o.override_sync)
501 * Init/option functions
503 extern int __must_check fio_init_options(void);
504 extern int __must_check parse_options(int, char **);
505 extern int parse_jobs_ini(char *, int, int, int);
506 extern int parse_cmd_line(int, char **, int);
507 extern int fio_backend(struct sk_out *);
508 extern void reset_fio_state(void);
509 extern void clear_io_state(struct thread_data *, int);
510 extern int fio_options_parse(struct thread_data *, char **, int);
511 extern void fio_keywords_init(void);
512 extern void fio_keywords_exit(void);
513 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
514 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
515 extern void fio_fill_default_options(struct thread_data *);
516 extern int fio_show_option_help(const char *);
517 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
518 extern void fio_options_dup_and_init(struct option *);
519 extern void fio_options_mem_dupe(struct thread_data *);
520 extern void td_fill_rand_seeds(struct thread_data *);
521 extern void td_fill_verify_state_seed(struct thread_data *);
522 extern void add_job_opts(const char **, int);
523 extern char *num2str(uint64_t, int, int, int, int);
524 extern int ioengine_load(struct thread_data *);
525 extern bool parse_dryrun(void);
526 extern int fio_running_or_pending_io_threads(void);
527 extern int fio_set_fd_nonblocking(int, const char *);
528 extern void sig_show_status(int sig);
529 extern struct thread_data *get_global_options(void);
531 extern uintptr_t page_mask;
532 extern uintptr_t page_size;
533 extern int initialize_fio(char *envp[]);
534 extern void deinitialize_fio(void);
537 #define N2S_BITPERSEC 1 /* match unit_base for bit rates */
541 #define N2S_BYTEPERSEC 8 /* match unit_base for byte rates */
543 #define FIO_GETOPT_JOB 0x89000000
544 #define FIO_GETOPT_IOENGINE 0x98000000
545 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
550 extern void print_thread_status(void);
551 extern void print_status_init(int);
552 extern char *fio_uint_to_kmg(unsigned int val);
555 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
556 * will never back again. It may cycle between running/verififying/fsyncing.
557 * Once the thread reaches TD_EXITED, it is just waiting for the core to
577 #define TD_ENG_FLAG_SHIFT 16
578 #define TD_ENG_FLAG_MASK ((1U << 16) - 1)
580 static inline enum fio_ioengine_flags td_ioengine_flags(struct thread_data *td)
582 return (enum fio_ioengine_flags)
583 ((td->flags >> TD_ENG_FLAG_SHIFT) & TD_ENG_FLAG_MASK);
586 static inline void td_set_ioengine_flags(struct thread_data *td)
588 td->flags |= (td->io_ops->flags << TD_ENG_FLAG_SHIFT);
591 static inline bool td_ioengine_flagged(struct thread_data *td,
592 enum fio_ioengine_flags flags)
594 return ((td->flags >> TD_ENG_FLAG_SHIFT) & flags) != 0;
597 extern void td_set_runstate(struct thread_data *, int);
598 extern int td_bump_runstate(struct thread_data *, int);
599 extern void td_restore_runstate(struct thread_data *, int);
600 extern const char *runstate_to_name(int runstate);
603 * Allow 60 seconds for a job to quit on its own, otherwise reap with
606 #define FIO_REAP_TIMEOUT 300
608 #define TERMINATE_ALL (-1U)
609 extern void fio_terminate_threads(unsigned int);
610 extern void fio_mark_td_terminate(struct thread_data *);
615 extern int __must_check fio_pin_memory(struct thread_data *);
616 extern void fio_unpin_memory(struct thread_data *);
617 extern int __must_check allocate_io_mem(struct thread_data *);
618 extern void free_io_mem(struct thread_data *);
619 extern void free_threads_shm(void);
622 #define PTR_ALIGN(ptr, mask) \
623 (char *) (((uintptr_t) (ptr) + (mask)) & ~(mask))
627 * Reset stats after ramp time completes
629 extern void reset_all_stats(struct thread_data *);
634 #ifdef FIO_HAVE_BLKTRACE
635 extern int is_blktrace(const char *, int *);
636 extern int load_blktrace(struct thread_data *, const char *, int);
639 extern int io_queue_event(struct thread_data *td, struct io_u *io_u, int *ret,
640 enum fio_ddir ddir, uint64_t *bytes_issued, int from_verify,
641 struct timeval *comp_time);
644 * Latency target helpers
646 extern void lat_target_check(struct thread_data *);
647 extern void lat_target_init(struct thread_data *);
648 extern void lat_target_reset(struct thread_data *);
651 * Iterates all threads/processes within all the defined jobs
653 #define for_each_td(td, i) \
654 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
655 #define for_each_file(td, f, i) \
656 if ((td)->files_index) \
657 for ((i) = 0, (f) = (td)->files[0]; \
658 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
661 #define fio_assert(td, cond) do { \
664 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
665 td_set_runstate((td), TD_EXITED); \
666 (td)->error = EFAULT; \
671 static inline bool fio_fill_issue_time(struct thread_data *td)
673 if (td->o.read_iolog_file ||
674 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
680 static inline bool __should_check_rate(struct thread_data *td,
683 struct thread_options *o = &td->o;
686 * If some rate setting was given, we need to check it
688 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
689 o->rate_iops_min[ddir])
695 static inline bool should_check_rate(struct thread_data *td)
697 if (td->bytes_done[DDIR_READ] && __should_check_rate(td, DDIR_READ))
699 if (td->bytes_done[DDIR_WRITE] && __should_check_rate(td, DDIR_WRITE))
701 if (td->bytes_done[DDIR_TRIM] && __should_check_rate(td, DDIR_TRIM))
707 static inline unsigned int td_max_bs(struct thread_data *td)
711 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
712 return max(td->o.max_bs[DDIR_TRIM], max_bs);
715 static inline unsigned int td_min_bs(struct thread_data *td)
719 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
720 return min(td->o.min_bs[DDIR_TRIM], min_bs);
723 static inline bool td_async_processing(struct thread_data *td)
725 return (td->flags & TD_F_NEED_LOCK) != 0;
729 * We currently only need to do locking if we have verifier threads
730 * accessing our internal structures too
732 static inline void td_io_u_lock(struct thread_data *td)
734 if (td_async_processing(td))
735 pthread_mutex_lock(&td->io_u_lock);
738 static inline void td_io_u_unlock(struct thread_data *td)
740 if (td_async_processing(td))
741 pthread_mutex_unlock(&td->io_u_lock);
744 static inline void td_io_u_free_notify(struct thread_data *td)
746 if (td_async_processing(td))
747 pthread_cond_signal(&td->free_cond);
750 static inline void td_flags_clear(struct thread_data *td, unsigned int *flags,
753 if (!td_async_processing(td))
756 __sync_fetch_and_and(flags, ~value);
759 static inline void td_flags_set(struct thread_data *td, unsigned int *flags,
762 if (!td_async_processing(td))
765 __sync_fetch_and_or(flags, value);
768 extern const char *fio_get_arch_string(int);
769 extern const char *fio_get_os_string(int);
772 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
773 #define FIELD_SIZE(s, f) (sizeof(((typeof(s))0)->f))
777 __FIO_OUTPUT_TERSE = 0,
778 __FIO_OUTPUT_JSON = 1,
779 __FIO_OUTPUT_NORMAL = 2,
780 __FIO_OUTPUT_JSON_PLUS = 3,
783 FIO_OUTPUT_TERSE = 1U << __FIO_OUTPUT_TERSE,
784 FIO_OUTPUT_JSON = 1U << __FIO_OUTPUT_JSON,
785 FIO_OUTPUT_NORMAL = 1U << __FIO_OUTPUT_NORMAL,
786 FIO_OUTPUT_JSON_PLUS = 1U << __FIO_OUTPUT_JSON_PLUS,
790 FIO_RAND_DIST_RANDOM = 0,
792 FIO_RAND_DIST_PARETO,
797 #define FIO_DEF_ZIPF 1.1
798 #define FIO_DEF_PARETO 0.2
801 FIO_RAND_GEN_TAUSWORTHE = 0,
803 FIO_RAND_GEN_TAUSWORTHE64,
811 extern void exec_trigger(const char *);
812 extern void check_trigger_file(void);