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"
44 #include "steadystate.h"
46 #ifdef CONFIG_SOLARISAIO
47 #include <sys/asynch.h>
51 #include <linux/mempolicy.h>
55 * "local" is pseudo-policy
57 #define MPOL_LOCAL MPOL_MAX
61 * offset generator types
69 TD_F_VER_BACKLOG = 1U << 0,
70 TD_F_TRIM_BACKLOG = 1U << 1,
71 TD_F_READ_IOLOG = 1U << 2,
72 TD_F_REFILL_BUFFERS = 1U << 3,
73 TD_F_SCRAMBLE_BUFFERS = 1U << 4,
74 TD_F_VER_NONE = 1U << 5,
75 TD_F_PROFILE_OPS = 1U << 6,
76 TD_F_COMPRESS = 1U << 7,
78 TD_F_COMPRESS_LOG = 1U << 9,
79 TD_F_VSTATE_SAVED = 1U << 10,
80 TD_F_NEED_LOCK = 1U << 11,
81 TD_F_CHILD = 1U << 12,
82 TD_F_NO_PROGRESS = 1U << 13,
83 TD_F_REGROW_LOGS = 1U << 14,
92 FIO_RAND_FILE_SIZE_OFF,
95 FIO_RAND_SEQ_RAND_READ_OFF,
96 FIO_RAND_SEQ_RAND_WRITE_OFF,
97 FIO_RAND_SEQ_RAND_TRIM_OFF,
100 FIO_RAND_POISSON_OFF,
109 RATE_PROCESS_LINEAR = 0,
110 RATE_PROCESS_POISSON = 1,
121 * 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;
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;
238 * IO engine private data and dlhandle.
241 void *io_ops_dlhandle;
244 * Queue depth of io_u's that fio MIGHT do
246 unsigned int cur_depth;
249 * io_u's about to be committed
251 unsigned int io_u_queued;
254 * io_u's submitted but not completed yet
256 unsigned int io_u_in_flight;
259 * List of free and busy io_u's
261 struct io_u_ring io_u_requeues;
262 struct io_u_queue io_u_freelist;
263 struct io_u_queue io_u_all;
264 pthread_mutex_t io_u_lock;
265 pthread_cond_t free_cond;
268 * async verify offload
270 struct flist_head verify_list;
271 pthread_t *verify_threads;
272 unsigned int nr_verify_threads;
273 pthread_cond_t verify_cond;
274 int verify_thread_exit;
279 uint64_t rate_bps[DDIR_RWDIR_CNT];
280 uint64_t rate_next_io_time[DDIR_RWDIR_CNT];
281 unsigned long rate_bytes[DDIR_RWDIR_CNT];
282 unsigned long rate_blocks[DDIR_RWDIR_CNT];
283 unsigned long long rate_io_issue_bytes[DDIR_RWDIR_CNT];
284 struct timeval lastrate[DDIR_RWDIR_CNT];
286 struct frand_state poisson_state;
289 * Enforced rate submission/completion workqueue
291 struct workqueue io_wq;
293 uint64_t total_io_size;
294 uint64_t fill_device_size;
299 uint64_t io_issues[DDIR_RWDIR_CNT];
300 uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
306 uint64_t io_blocks[DDIR_RWDIR_CNT];
307 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
308 uint64_t io_bytes[DDIR_RWDIR_CNT];
309 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
310 uint64_t io_skip_bytes;
312 struct fio_mutex *mutex;
313 uint64_t bytes_done[DDIR_RWDIR_CNT];
316 * State for random io, a bitmap of blocks done vs not done
318 struct frand_state random_state;
320 struct timeval start; /* start of this loop */
321 struct timeval epoch; /* time job was started */
322 unsigned long long unix_epoch; /* Time job was started, unix epoch based. */
323 struct timeval last_issue;
325 struct timeval tv_cache;
326 struct timeval terminate_time;
327 unsigned int tv_cache_nr;
328 unsigned int tv_cache_mask;
329 unsigned int ramp_time_over;
332 * Time since last latency_window was started
334 struct timeval latency_ts;
335 unsigned int latency_qd;
336 unsigned int latency_qd_high;
337 unsigned int latency_qd_low;
338 unsigned int latency_failed;
339 uint64_t latency_ios;
343 * read/write mixed workload state
345 struct frand_state rwmix_state;
346 unsigned long rwmix_issues;
347 enum fio_ddir rwmix_ddir;
348 unsigned int ddir_seq_nr;
351 * rand/seq mixed workload state
353 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
356 * IO history logs for verification. We use a tree for sorting,
357 * if we are overwriting. Otherwise just use a fifo.
359 struct rb_root io_hist_tree;
360 struct flist_head io_hist_list;
361 unsigned long io_hist_len;
366 struct flist_head io_log_list;
369 * For tracking/handling discards
371 struct flist_head trim_list;
372 unsigned long trim_entries;
374 struct flist_head next_rand_list;
377 * for fileservice, how often to switch to a new file
379 unsigned int file_service_nr;
380 unsigned int file_service_left;
381 struct fio_file *file_service_file;
383 unsigned int sync_file_range_nr;
386 * For generating file sizes
388 struct frand_state file_size_state;
393 unsigned int total_err_count;
396 struct fio_flow *flow;
399 * Can be overloaded by profiles
401 struct prof_io_ops prof_io_ops;
406 struct steadystate_data ss;
408 char verror[FIO_VERROR_SIZE];
412 * when should interactive ETA output be generated
420 #define __td_verror(td, err, msg, func) \
422 unsigned int ____e = (err); \
425 (td)->error = ____e; \
426 if (!(td)->first_error) \
427 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
431 #define td_clear_error(td) do { \
434 (td)->parent->error = 0; \
437 #define td_verror(td, err, func) do { \
438 __td_verror((td), (err), strerror((err)), (func)); \
440 __td_verror((td)->parent, (err), strerror((err)), (func)); \
443 #define td_vmsg(td, err, msg, func) do { \
444 __td_verror((td), (err), (msg), (func)); \
446 __td_verror((td)->parent, (err), (msg), (func)); \
449 #define __fio_stringify_1(x) #x
450 #define __fio_stringify(x) __fio_stringify_1(x)
452 extern int exitall_on_terminate;
453 extern unsigned int thread_number;
454 extern unsigned int stat_number;
457 extern int output_format;
458 extern int append_terse_output;
459 extern int temp_stall_ts;
460 extern uintptr_t page_mask, page_size;
461 extern int read_only;
462 extern int eta_print;
463 extern int eta_new_line;
464 extern unsigned long done_secs;
465 extern int fio_gtod_offload;
466 extern int fio_gtod_cpu;
467 extern enum fio_cs fio_clock_source;
468 extern int fio_clock_source_set;
469 extern int warnings_fatal;
470 extern int terse_version;
471 extern int is_backend;
472 extern int nr_clients;
473 extern int log_syslog;
474 extern int status_interval;
475 extern const char fio_version_string[];
476 extern char *trigger_file;
477 extern char *trigger_cmd;
478 extern char *trigger_remote_cmd;
479 extern long long trigger_timeout;
480 extern char *aux_path;
482 extern struct thread_data *threads;
484 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
486 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
489 #define REAL_MAX_JOBS 4096
491 static inline int should_fsync(struct thread_data *td)
493 if (td->last_was_sync)
495 if (td_write(td) || td_rw(td) || td->o.override_sync)
502 * Init/option functions
504 extern int __must_check fio_init_options(void);
505 extern int __must_check parse_options(int, char **);
506 extern int parse_jobs_ini(char *, int, int, int);
507 extern int parse_cmd_line(int, char **, int);
508 extern int fio_backend(struct sk_out *);
509 extern void reset_fio_state(void);
510 extern void clear_io_state(struct thread_data *, int);
511 extern int fio_options_parse(struct thread_data *, char **, int);
512 extern void fio_keywords_init(void);
513 extern void fio_keywords_exit(void);
514 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
515 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
516 extern void fio_fill_default_options(struct thread_data *);
517 extern int fio_show_option_help(const char *);
518 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
519 extern void fio_options_dup_and_init(struct option *);
520 extern void fio_options_mem_dupe(struct thread_data *);
521 extern void options_mem_dupe(void *data, struct fio_option *options);
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 * Reset stats after ramp time completes
626 extern void reset_all_stats(struct thread_data *);
631 #ifdef FIO_HAVE_BLKTRACE
632 extern int is_blktrace(const char *, int *);
633 extern int load_blktrace(struct thread_data *, const char *, int);
636 extern int io_queue_event(struct thread_data *td, struct io_u *io_u, int *ret,
637 enum fio_ddir ddir, uint64_t *bytes_issued, int from_verify,
638 struct timeval *comp_time);
641 * Latency target helpers
643 extern void lat_target_check(struct thread_data *);
644 extern void lat_target_init(struct thread_data *);
645 extern void lat_target_reset(struct thread_data *);
647 #define for_each_td(td, i) \
648 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
649 #define for_each_file(td, f, i) \
650 if ((td)->files_index) \
651 for ((i) = 0, (f) = (td)->files[0]; \
652 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
655 #define fio_assert(td, cond) do { \
658 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
659 td_set_runstate((td), TD_EXITED); \
660 (td)->error = EFAULT; \
665 static inline bool fio_fill_issue_time(struct thread_data *td)
667 if (td->o.read_iolog_file ||
668 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
674 static inline bool __should_check_rate(struct thread_data *td,
677 struct thread_options *o = &td->o;
680 * If some rate setting was given, we need to check it
682 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
683 o->rate_iops_min[ddir])
689 static inline bool should_check_rate(struct thread_data *td)
691 if (td->bytes_done[DDIR_READ] && __should_check_rate(td, DDIR_READ))
693 if (td->bytes_done[DDIR_WRITE] && __should_check_rate(td, DDIR_WRITE))
695 if (td->bytes_done[DDIR_TRIM] && __should_check_rate(td, DDIR_TRIM))
701 static inline unsigned int td_max_bs(struct thread_data *td)
705 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
706 return max(td->o.max_bs[DDIR_TRIM], max_bs);
709 static inline unsigned int td_min_bs(struct thread_data *td)
713 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
714 return min(td->o.min_bs[DDIR_TRIM], min_bs);
717 static inline bool td_async_processing(struct thread_data *td)
719 return (td->flags & TD_F_NEED_LOCK) != 0;
723 * We currently only need to do locking if we have verifier threads
724 * accessing our internal structures too
726 static inline void td_io_u_lock(struct thread_data *td)
728 if (td_async_processing(td))
729 pthread_mutex_lock(&td->io_u_lock);
732 static inline void td_io_u_unlock(struct thread_data *td)
734 if (td_async_processing(td))
735 pthread_mutex_unlock(&td->io_u_lock);
738 static inline void td_io_u_free_notify(struct thread_data *td)
740 if (td_async_processing(td))
741 pthread_cond_signal(&td->free_cond);
744 static inline void td_flags_clear(struct thread_data *td, unsigned int *flags,
747 if (!td_async_processing(td))
750 __sync_fetch_and_and(flags, ~value);
753 static inline void td_flags_set(struct thread_data *td, unsigned int *flags,
756 if (!td_async_processing(td))
759 __sync_fetch_and_or(flags, value);
762 extern const char *fio_get_arch_string(int);
763 extern const char *fio_get_os_string(int);
766 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
767 #define FIELD_SIZE(s, f) (sizeof(((typeof(s))0)->f))
771 __FIO_OUTPUT_TERSE = 0,
772 __FIO_OUTPUT_JSON = 1,
773 __FIO_OUTPUT_NORMAL = 2,
774 __FIO_OUTPUT_JSON_PLUS = 3,
777 FIO_OUTPUT_TERSE = 1U << __FIO_OUTPUT_TERSE,
778 FIO_OUTPUT_JSON = 1U << __FIO_OUTPUT_JSON,
779 FIO_OUTPUT_NORMAL = 1U << __FIO_OUTPUT_NORMAL,
780 FIO_OUTPUT_JSON_PLUS = 1U << __FIO_OUTPUT_JSON_PLUS,
784 FIO_RAND_DIST_RANDOM = 0,
786 FIO_RAND_DIST_PARETO,
791 #define FIO_DEF_ZIPF 1.1
792 #define FIO_DEF_PARETO 0.2
795 FIO_RAND_GEN_TAUSWORTHE = 0,
797 FIO_RAND_GEN_TAUSWORTHE64,
805 extern void exec_trigger(const char *);
806 extern void check_trigger_file(void);