8 #include <sys/resource.h>
17 #include "compiler/compiler.h"
18 #include "thread_options.h"
21 #include "arch/arch.h"
28 #include "ioengines.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,
103 FIO_RAND_POISSON2_OFF,
104 FIO_RAND_POISSON3_OFF,
112 RATE_PROCESS_LINEAR = 0,
113 RATE_PROCESS_POISSON = 1,
124 * Per-thread/process specific data. Only used for the network client
127 void sk_out_assign(struct sk_out *);
128 void sk_out_drop(void);
130 struct zone_split_index {
132 uint8_t size_perc_prev;
136 * This describes a single thread/process executing a fio job.
139 struct flist_head opt_list;
141 struct thread_options o;
144 unsigned int thread_number;
145 unsigned int subjob_number;
146 unsigned int groupid;
147 struct thread_stat ts;
151 struct io_log *slat_log;
152 struct io_log *clat_log;
153 struct io_log *clat_hist_log;
154 struct io_log *lat_log;
155 struct io_log *bw_log;
156 struct io_log *iops_log;
158 struct workqueue log_compress_wq;
160 struct thread_data *parent;
162 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
163 struct timeval bw_sample_time;
165 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
166 struct timeval iops_sample_time;
168 volatile int update_rusage;
169 struct fio_mutex *rusage_sem;
170 struct rusage ru_start;
171 struct rusage ru_end;
173 struct fio_file **files;
174 unsigned char *file_locks;
175 unsigned int files_size;
176 unsigned int files_index;
177 unsigned int nr_open_files;
178 unsigned int nr_done_files;
179 unsigned int nr_normal_files;
181 unsigned int next_file;
182 struct frand_state next_file_state;
185 struct zipf_state next_file_zipf;
186 struct gauss_state next_file_gauss;
199 size_t orig_buffer_size;
200 volatile int terminate;
201 volatile int runstate;
202 unsigned int last_was_sync;
203 enum fio_ddir last_ddir;
210 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
212 struct frand_state bsrange_state;
213 struct frand_state verify_state;
214 struct frand_state trim_state;
215 struct frand_state delay_state;
217 struct frand_state buf_state;
218 struct frand_state buf_state_prev;
219 struct frand_state dedupe_state;
220 struct frand_state zone_state;
222 struct zone_split_index **zone_state_index;
224 unsigned int verify_batch;
225 unsigned int trim_batch;
227 struct thread_io_list *vstate;
232 * IO engine hooks, contains everything needed to submit an io_u
233 * to any of the available IO engines.
235 struct ioengine_ops *io_ops;
239 * IO engine private data and dlhandle.
242 void *io_ops_dlhandle;
245 * Queue depth of io_u's that fio MIGHT do
247 unsigned int cur_depth;
250 * io_u's about to be committed
252 unsigned int io_u_queued;
255 * io_u's submitted but not completed yet
257 unsigned int io_u_in_flight;
260 * List of free and busy io_u's
262 struct io_u_ring io_u_requeues;
263 struct io_u_queue io_u_freelist;
264 struct io_u_queue io_u_all;
265 pthread_mutex_t io_u_lock;
266 pthread_cond_t free_cond;
269 * async verify offload
271 struct flist_head verify_list;
272 pthread_t *verify_threads;
273 unsigned int nr_verify_threads;
274 pthread_cond_t verify_cond;
275 int verify_thread_exit;
280 uint64_t rate_bps[DDIR_RWDIR_CNT];
281 uint64_t rate_next_io_time[DDIR_RWDIR_CNT];
282 unsigned long rate_bytes[DDIR_RWDIR_CNT];
283 unsigned long rate_blocks[DDIR_RWDIR_CNT];
284 unsigned long long rate_io_issue_bytes[DDIR_RWDIR_CNT];
285 struct timeval lastrate[DDIR_RWDIR_CNT];
286 int64_t last_usec[DDIR_RWDIR_CNT];
287 struct frand_state poisson_state[DDIR_RWDIR_CNT];
290 * Enforced rate submission/completion workqueue
292 struct workqueue io_wq;
294 uint64_t total_io_size;
295 uint64_t fill_device_size;
300 uint64_t io_issues[DDIR_RWDIR_CNT];
301 uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
307 uint64_t io_blocks[DDIR_RWDIR_CNT];
308 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
309 uint64_t io_bytes[DDIR_RWDIR_CNT];
310 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
311 uint64_t io_skip_bytes;
313 struct fio_mutex *mutex;
314 uint64_t bytes_done[DDIR_RWDIR_CNT];
317 * State for random io, a bitmap of blocks done vs not done
319 struct frand_state random_state;
321 struct timeval start; /* start of this loop */
322 struct timeval epoch; /* time job was started */
323 unsigned long long unix_epoch; /* Time job was started, unix epoch based. */
324 struct timeval last_issue;
326 struct timeval tv_cache;
327 struct timeval terminate_time;
328 unsigned int tv_cache_nr;
329 unsigned int tv_cache_mask;
330 unsigned int ramp_time_over;
333 * Time since last latency_window was started
335 struct timeval latency_ts;
336 unsigned int latency_qd;
337 unsigned int latency_qd_high;
338 unsigned int latency_qd_low;
339 unsigned int latency_failed;
340 uint64_t latency_ios;
344 * read/write mixed workload state
346 struct frand_state rwmix_state;
347 unsigned long rwmix_issues;
348 enum fio_ddir rwmix_ddir;
349 unsigned int ddir_seq_nr;
352 * rand/seq mixed workload state
354 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
357 * IO history logs for verification. We use a tree for sorting,
358 * if we are overwriting. Otherwise just use a fifo.
360 struct rb_root io_hist_tree;
361 struct flist_head io_hist_list;
362 unsigned long io_hist_len;
367 struct flist_head io_log_list;
370 * For tracking/handling discards
372 struct flist_head trim_list;
373 unsigned long trim_entries;
375 struct flist_head next_rand_list;
378 * for fileservice, how often to switch to a new file
380 unsigned int file_service_nr;
381 unsigned int file_service_left;
382 struct fio_file *file_service_file;
384 unsigned int sync_file_range_nr;
387 * For generating file sizes
389 struct frand_state file_size_state;
394 unsigned int total_err_count;
397 struct fio_flow *flow;
400 * Can be overloaded by profiles
402 struct prof_io_ops prof_io_ops;
407 struct steadystate_data ss;
409 char verror[FIO_VERROR_SIZE];
413 * when should interactive ETA output be generated
421 #define __td_verror(td, err, msg, func) \
423 unsigned int ____e = (err); \
426 (td)->error = ____e; \
427 if (!(td)->first_error) \
428 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
432 #define td_clear_error(td) do { \
435 (td)->parent->error = 0; \
438 #define td_verror(td, err, func) do { \
439 __td_verror((td), (err), strerror((err)), (func)); \
441 __td_verror((td)->parent, (err), strerror((err)), (func)); \
444 #define td_vmsg(td, err, msg, func) do { \
445 __td_verror((td), (err), (msg), (func)); \
447 __td_verror((td)->parent, (err), (msg), (func)); \
450 #define __fio_stringify_1(x) #x
451 #define __fio_stringify(x) __fio_stringify_1(x)
453 extern int exitall_on_terminate;
454 extern unsigned int thread_number;
455 extern unsigned int stat_number;
458 extern int output_format;
459 extern int append_terse_output;
460 extern int temp_stall_ts;
461 extern uintptr_t page_mask, page_size;
462 extern int read_only;
463 extern int eta_print;
464 extern int eta_new_line;
465 extern unsigned long done_secs;
466 extern int fio_gtod_offload;
467 extern int fio_gtod_cpu;
468 extern enum fio_cs fio_clock_source;
469 extern int fio_clock_source_set;
470 extern int warnings_fatal;
471 extern int terse_version;
472 extern int is_backend;
473 extern int nr_clients;
474 extern int log_syslog;
475 extern int status_interval;
476 extern const char fio_version_string[];
477 extern char *trigger_file;
478 extern char *trigger_cmd;
479 extern char *trigger_remote_cmd;
480 extern long long trigger_timeout;
481 extern char *aux_path;
483 extern struct thread_data *threads;
485 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
487 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
490 #define REAL_MAX_JOBS 4096
492 static inline int should_fsync(struct thread_data *td)
494 if (td->last_was_sync)
496 if (td_write(td) || td->o.override_sync)
503 * Init/option functions
505 extern int __must_check fio_init_options(void);
506 extern int __must_check parse_options(int, char **);
507 extern int parse_jobs_ini(char *, int, int, int);
508 extern int parse_cmd_line(int, char **, int);
509 extern int fio_backend(struct sk_out *);
510 extern void reset_fio_state(void);
511 extern void clear_io_state(struct thread_data *, int);
512 extern int fio_options_parse(struct thread_data *, char **, int);
513 extern void fio_keywords_init(void);
514 extern void fio_keywords_exit(void);
515 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
516 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
517 extern void fio_fill_default_options(struct thread_data *);
518 extern int fio_show_option_help(const char *);
519 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
520 extern void fio_options_dup_and_init(struct option *);
521 extern void fio_options_mem_dupe(struct thread_data *);
522 extern void td_fill_rand_seeds(struct thread_data *);
523 extern void td_fill_verify_state_seed(struct thread_data *);
524 extern void add_job_opts(const char **, int);
525 extern char *num2str(uint64_t, int, int, int, int);
526 extern int ioengine_load(struct thread_data *);
527 extern bool parse_dryrun(void);
528 extern int fio_running_or_pending_io_threads(void);
529 extern int fio_set_fd_nonblocking(int, const char *);
530 extern void sig_show_status(int sig);
531 extern struct thread_data *get_global_options(void);
533 extern uintptr_t page_mask;
534 extern uintptr_t page_size;
535 extern int initialize_fio(char *envp[]);
536 extern void deinitialize_fio(void);
539 #define N2S_BITPERSEC 1 /* match unit_base for bit rates */
543 #define N2S_BYTEPERSEC 8 /* match unit_base for byte rates */
545 #define FIO_GETOPT_JOB 0x89000000
546 #define FIO_GETOPT_IOENGINE 0x98000000
547 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
552 extern void print_thread_status(void);
553 extern void print_status_init(int);
554 extern char *fio_uint_to_kmg(unsigned int val);
557 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
558 * will never back again. It may cycle between running/verififying/fsyncing.
559 * Once the thread reaches TD_EXITED, it is just waiting for the core to
579 #define TD_ENG_FLAG_SHIFT 16
580 #define TD_ENG_FLAG_MASK ((1U << 16) - 1)
582 static inline enum fio_ioengine_flags td_ioengine_flags(struct thread_data *td)
584 return (enum fio_ioengine_flags)
585 ((td->flags >> TD_ENG_FLAG_SHIFT) & TD_ENG_FLAG_MASK);
588 static inline void td_set_ioengine_flags(struct thread_data *td)
590 td->flags |= (td->io_ops->flags << TD_ENG_FLAG_SHIFT);
593 static inline bool td_ioengine_flagged(struct thread_data *td,
594 enum fio_ioengine_flags flags)
596 return ((td->flags >> TD_ENG_FLAG_SHIFT) & flags) != 0;
599 extern void td_set_runstate(struct thread_data *, int);
600 extern int td_bump_runstate(struct thread_data *, int);
601 extern void td_restore_runstate(struct thread_data *, int);
602 extern const char *runstate_to_name(int runstate);
605 * Allow 60 seconds for a job to quit on its own, otherwise reap with
608 #define FIO_REAP_TIMEOUT 300
610 #define TERMINATE_ALL (-1U)
611 extern void fio_terminate_threads(unsigned int);
612 extern void fio_mark_td_terminate(struct thread_data *);
617 extern int __must_check fio_pin_memory(struct thread_data *);
618 extern void fio_unpin_memory(struct thread_data *);
619 extern int __must_check allocate_io_mem(struct thread_data *);
620 extern void free_io_mem(struct thread_data *);
621 extern void free_threads_shm(void);
624 #define PTR_ALIGN(ptr, mask) \
625 (char *) (((uintptr_t) (ptr) + (mask)) & ~(mask))
629 * Reset stats after ramp time completes
631 extern void reset_all_stats(struct thread_data *);
636 #ifdef FIO_HAVE_BLKTRACE
637 extern int is_blktrace(const char *, int *);
638 extern int load_blktrace(struct thread_data *, const char *, int);
641 extern int io_queue_event(struct thread_data *td, struct io_u *io_u, int *ret,
642 enum fio_ddir ddir, uint64_t *bytes_issued, int from_verify,
643 struct timeval *comp_time);
646 * Latency target helpers
648 extern void lat_target_check(struct thread_data *);
649 extern void lat_target_init(struct thread_data *);
650 extern void lat_target_reset(struct thread_data *);
653 * Iterates all threads/processes within all the defined jobs
655 #define for_each_td(td, i) \
656 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
657 #define for_each_file(td, f, i) \
658 if ((td)->files_index) \
659 for ((i) = 0, (f) = (td)->files[0]; \
660 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
663 #define fio_assert(td, cond) do { \
666 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
667 td_set_runstate((td), TD_EXITED); \
668 (td)->error = EFAULT; \
673 static inline bool fio_fill_issue_time(struct thread_data *td)
675 if (td->o.read_iolog_file ||
676 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
682 static inline bool __should_check_rate(struct thread_data *td,
685 struct thread_options *o = &td->o;
688 * If some rate setting was given, we need to check it
690 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
691 o->rate_iops_min[ddir])
697 static inline bool should_check_rate(struct thread_data *td)
699 if (td->bytes_done[DDIR_READ] && __should_check_rate(td, DDIR_READ))
701 if (td->bytes_done[DDIR_WRITE] && __should_check_rate(td, DDIR_WRITE))
703 if (td->bytes_done[DDIR_TRIM] && __should_check_rate(td, DDIR_TRIM))
709 static inline unsigned int td_max_bs(struct thread_data *td)
713 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
714 return max(td->o.max_bs[DDIR_TRIM], max_bs);
717 static inline unsigned int td_min_bs(struct thread_data *td)
721 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
722 return min(td->o.min_bs[DDIR_TRIM], min_bs);
725 static inline bool td_async_processing(struct thread_data *td)
727 return (td->flags & TD_F_NEED_LOCK) != 0;
731 * We currently only need to do locking if we have verifier threads
732 * accessing our internal structures too
734 static inline void td_io_u_lock(struct thread_data *td)
736 if (td_async_processing(td))
737 pthread_mutex_lock(&td->io_u_lock);
740 static inline void td_io_u_unlock(struct thread_data *td)
742 if (td_async_processing(td))
743 pthread_mutex_unlock(&td->io_u_lock);
746 static inline void td_io_u_free_notify(struct thread_data *td)
748 if (td_async_processing(td))
749 pthread_cond_signal(&td->free_cond);
752 static inline void td_flags_clear(struct thread_data *td, unsigned int *flags,
755 if (!td_async_processing(td))
758 __sync_fetch_and_and(flags, ~value);
761 static inline void td_flags_set(struct thread_data *td, unsigned int *flags,
764 if (!td_async_processing(td))
767 __sync_fetch_and_or(flags, value);
770 extern const char *fio_get_arch_string(int);
771 extern const char *fio_get_os_string(int);
774 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
775 #define FIELD_SIZE(s, f) (sizeof(((typeof(s))0)->f))
779 __FIO_OUTPUT_TERSE = 0,
780 __FIO_OUTPUT_JSON = 1,
781 __FIO_OUTPUT_NORMAL = 2,
782 __FIO_OUTPUT_JSON_PLUS = 3,
785 FIO_OUTPUT_TERSE = 1U << __FIO_OUTPUT_TERSE,
786 FIO_OUTPUT_JSON = 1U << __FIO_OUTPUT_JSON,
787 FIO_OUTPUT_NORMAL = 1U << __FIO_OUTPUT_NORMAL,
788 FIO_OUTPUT_JSON_PLUS = 1U << __FIO_OUTPUT_JSON_PLUS,
792 FIO_RAND_DIST_RANDOM = 0,
794 FIO_RAND_DIST_PARETO,
799 #define FIO_DEF_ZIPF 1.1
800 #define FIO_DEF_PARETO 0.2
803 FIO_RAND_GEN_TAUSWORTHE = 0,
805 FIO_RAND_GEN_TAUSWORTHE64,
813 extern void exec_trigger(const char *);
814 extern void check_trigger_file(void);