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,
106 RATE_PROCESS_LINEAR = 0,
107 RATE_PROCESS_POISSON = 1,
111 * Per-thread/process specific data. Only used for the network client
114 struct backend_data {
120 * This describes a single thread/process executing a fio job.
123 struct thread_options o;
126 char verror[FIO_VERROR_SIZE];
128 unsigned int thread_number;
129 unsigned int subjob_number;
130 unsigned int groupid;
131 struct thread_stat ts;
135 struct io_log *slat_log;
136 struct io_log *clat_log;
137 struct io_log *lat_log;
138 struct io_log *bw_log;
139 struct io_log *iops_log;
141 struct workqueue log_compress_wq;
143 struct thread_data *parent;
145 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
146 struct timeval bw_sample_time;
148 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
149 struct timeval iops_sample_time;
152 * Tracks the last iodepth number of completed writes, if data
153 * verification is enabled
155 uint64_t *last_write_comp;
156 unsigned int last_write_idx;
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;
180 size_t orig_buffer_size;
181 volatile int terminate;
182 volatile int runstate;
183 unsigned int last_was_sync;
184 enum fio_ddir last_ddir;
193 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
195 struct frand_state bsrange_state;
196 struct frand_state verify_state;
197 struct frand_state trim_state;
198 struct frand_state delay_state;
200 struct frand_state buf_state;
201 struct frand_state buf_state_prev;
202 struct frand_state dedupe_state;
204 unsigned int verify_batch;
205 unsigned int trim_batch;
207 struct thread_io_list *vstate;
212 * IO engine hooks, contains everything needed to submit an io_u
213 * to any of the available IO engines.
215 struct ioengine_ops *io_ops;
218 * Queue depth of io_u's that fio MIGHT do
220 unsigned int cur_depth;
223 * io_u's about to be committed
225 unsigned int io_u_queued;
228 * io_u's submitted but not completed yet
230 unsigned int io_u_in_flight;
233 * List of free and busy io_u's
235 struct io_u_ring io_u_requeues;
236 struct io_u_queue io_u_freelist;
237 struct io_u_queue io_u_all;
238 pthread_mutex_t io_u_lock;
239 pthread_cond_t free_cond;
242 * async verify offload
244 struct flist_head verify_list;
245 pthread_t *verify_threads;
246 unsigned int nr_verify_threads;
247 pthread_cond_t verify_cond;
248 int verify_thread_exit;
253 uint64_t rate_bps[DDIR_RWDIR_CNT];
254 unsigned long rate_next_io_time[DDIR_RWDIR_CNT];
255 unsigned long rate_bytes[DDIR_RWDIR_CNT];
256 unsigned long rate_blocks[DDIR_RWDIR_CNT];
257 unsigned long rate_io_issue_bytes[DDIR_RWDIR_CNT];
258 struct timeval lastrate[DDIR_RWDIR_CNT];
260 struct frand_state poisson_state;
263 * Enforced rate submission/completion workqueue
265 struct workqueue io_wq;
267 uint64_t total_io_size;
268 uint64_t fill_device_size;
273 uint64_t io_issues[DDIR_RWDIR_CNT];
274 uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
280 uint64_t io_blocks[DDIR_RWDIR_CNT];
281 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
282 uint64_t io_bytes[DDIR_RWDIR_CNT];
283 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
284 uint64_t io_skip_bytes;
286 struct fio_mutex *mutex;
287 uint64_t bytes_done[DDIR_RWDIR_CNT];
290 * State for random io, a bitmap of blocks done vs not done
292 struct frand_state random_state;
294 struct timeval start; /* start of this loop */
295 struct timeval epoch; /* time job was started */
296 struct timeval last_issue;
298 struct timeval tv_cache;
299 struct timeval terminate_time;
300 unsigned int tv_cache_nr;
301 unsigned int tv_cache_mask;
302 unsigned int ramp_time_over;
305 * Time since last latency_window was started
307 struct timeval latency_ts;
308 unsigned int latency_qd;
309 unsigned int latency_qd_high;
310 unsigned int latency_qd_low;
311 unsigned int latency_failed;
312 uint64_t latency_ios;
316 * read/write mixed workload state
318 struct frand_state rwmix_state;
319 unsigned long rwmix_issues;
320 enum fio_ddir rwmix_ddir;
321 unsigned int ddir_seq_nr;
324 * rand/seq mixed workload state
326 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
329 * IO history logs for verification. We use a tree for sorting,
330 * if we are overwriting. Otherwise just use a fifo.
332 struct rb_root io_hist_tree;
333 struct flist_head io_hist_list;
334 unsigned long io_hist_len;
339 struct flist_head io_log_list;
342 * For tracking/handling discards
344 struct flist_head trim_list;
345 unsigned long trim_entries;
347 struct flist_head next_rand_list;
350 * for fileservice, how often to switch to a new file
352 unsigned int file_service_nr;
353 unsigned int file_service_left;
354 struct fio_file *file_service_file;
356 unsigned int sync_file_range_nr;
359 * For generating file sizes
361 struct frand_state file_size_state;
366 unsigned int total_err_count;
369 struct fio_flow *flow;
372 * Can be overloaded by profiles
374 struct prof_io_ops prof_io_ops;
381 * when should interactive ETA output be generated
389 #define __td_verror(td, err, msg, func) \
391 unsigned int ____e = (err); \
394 (td)->error = ____e; \
395 if (!(td)->first_error) \
396 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
400 #define td_clear_error(td) do { \
403 (td)->parent->error = 0; \
406 #define td_verror(td, err, func) do { \
407 __td_verror((td), (err), strerror((err)), (func)); \
409 __td_verror((td)->parent, (err), strerror((err)), (func)); \
412 #define td_vmsg(td, err, msg, func) do { \
413 __td_verror((td), (err), (msg), (func)); \
415 __td_verror((td)->parent, (err), (msg), (func)); \
418 #define __fio_stringify_1(x) #x
419 #define __fio_stringify(x) __fio_stringify_1(x)
421 extern int exitall_on_terminate;
422 extern unsigned int thread_number;
423 extern unsigned int stat_number;
426 extern int output_format;
427 extern int append_terse_output;
428 extern int temp_stall_ts;
429 extern uintptr_t page_mask, page_size;
430 extern int read_only;
431 extern int eta_print;
432 extern int eta_new_line;
433 extern unsigned long done_secs;
434 extern char *job_section;
435 extern int fio_gtod_offload;
436 extern int fio_gtod_cpu;
437 extern enum fio_cs fio_clock_source;
438 extern int fio_clock_source_set;
439 extern int warnings_fatal;
440 extern int terse_version;
441 extern int is_backend;
442 extern int nr_clients;
443 extern int log_syslog;
444 extern int status_interval;
445 extern const char fio_version_string[];
446 extern int helper_do_stat;
447 extern pthread_cond_t helper_cond;
448 extern char *trigger_file;
449 extern char *trigger_cmd;
450 extern char *trigger_remote_cmd;
451 extern long long trigger_timeout;
452 extern char *aux_path;
454 extern struct thread_data *threads;
456 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
458 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
461 #define REAL_MAX_JOBS 2048
463 static inline int should_fsync(struct thread_data *td)
465 if (td->last_was_sync)
467 if (td_write(td) || td_rw(td) || td->o.override_sync)
474 * Init/option functions
476 extern int __must_check fio_init_options(void);
477 extern int __must_check parse_options(int, char **);
478 extern int parse_jobs_ini(char *, int, int, int);
479 extern int parse_cmd_line(int, char **, int);
480 extern int fio_backend(struct backend_data *);
481 extern void reset_fio_state(void);
482 extern void clear_io_state(struct thread_data *, int);
483 extern int fio_options_parse(struct thread_data *, char **, int, int);
484 extern void fio_keywords_init(void);
485 extern void fio_keywords_exit(void);
486 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
487 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
488 extern void fio_fill_default_options(struct thread_data *);
489 extern int fio_show_option_help(const char *);
490 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
491 extern void fio_options_dup_and_init(struct option *);
492 extern void fio_options_mem_dupe(struct thread_data *);
493 extern void options_mem_dupe(void *data, struct fio_option *options);
494 extern void td_fill_rand_seeds(struct thread_data *);
495 extern void add_job_opts(const char **, int);
496 extern char *num2str(uint64_t, int, int, int, int);
497 extern int ioengine_load(struct thread_data *);
498 extern int parse_dryrun(void);
499 extern int fio_running_or_pending_io_threads(void);
500 extern int fio_set_fd_nonblocking(int, const char *);
501 extern void sig_show_status(int sig);
503 extern uintptr_t page_mask;
504 extern uintptr_t page_size;
505 extern int initialize_fio(char *envp[]);
506 extern void deinitialize_fio(void);
508 #define FIO_GETOPT_JOB 0x89000000
509 #define FIO_GETOPT_IOENGINE 0x98000000
510 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
515 extern void print_thread_status(void);
516 extern void print_status_init(int);
517 extern char *fio_uint_to_kmg(unsigned int val);
520 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
521 * will never back again. It may cycle between running/verififying/fsyncing.
522 * Once the thread reaches TD_EXITED, it is just waiting for the core to
541 extern void td_set_runstate(struct thread_data *, int);
542 extern int td_bump_runstate(struct thread_data *, int);
543 extern void td_restore_runstate(struct thread_data *, int);
546 * Allow 60 seconds for a job to quit on its own, otherwise reap with
549 #define FIO_REAP_TIMEOUT 60
551 #define TERMINATE_ALL (-1U)
552 extern void fio_terminate_threads(unsigned int);
553 extern void fio_mark_td_terminate(struct thread_data *);
558 extern int __must_check fio_pin_memory(struct thread_data *);
559 extern void fio_unpin_memory(struct thread_data *);
560 extern int __must_check allocate_io_mem(struct thread_data *);
561 extern void free_io_mem(struct thread_data *);
562 extern void free_threads_shm(void);
565 * Reset stats after ramp time completes
567 extern void reset_all_stats(struct thread_data *);
572 #ifdef FIO_HAVE_BLKTRACE
573 extern int is_blktrace(const char *, int *);
574 extern int load_blktrace(struct thread_data *, const char *, int);
577 extern int io_queue_event(struct thread_data *td, struct io_u *io_u, int *ret,
578 enum fio_ddir ddir, uint64_t *bytes_issued, int from_verify,
579 struct timeval *comp_time);
582 * Latency target helpers
584 extern void lat_target_check(struct thread_data *);
585 extern void lat_target_init(struct thread_data *);
586 extern void lat_target_reset(struct thread_data *);
588 #define for_each_td(td, i) \
589 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
590 #define for_each_file(td, f, i) \
591 if ((td)->files_index) \
592 for ((i) = 0, (f) = (td)->files[0]; \
593 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
596 #define fio_assert(td, cond) do { \
599 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
600 td_set_runstate((td), TD_EXITED); \
601 (td)->error = EFAULT; \
606 static inline int fio_fill_issue_time(struct thread_data *td)
608 if (td->o.read_iolog_file ||
609 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
615 static inline int __should_check_rate(struct thread_data *td,
618 struct thread_options *o = &td->o;
621 * If some rate setting was given, we need to check it
623 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
624 o->rate_iops_min[ddir])
630 static inline int should_check_rate(struct thread_data *td)
634 if (td->bytes_done[DDIR_READ])
635 ret |= __should_check_rate(td, DDIR_READ);
636 if (td->bytes_done[DDIR_WRITE])
637 ret |= __should_check_rate(td, DDIR_WRITE);
638 if (td->bytes_done[DDIR_TRIM])
639 ret |= __should_check_rate(td, DDIR_TRIM);
644 static inline unsigned int td_max_bs(struct thread_data *td)
648 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
649 return max(td->o.max_bs[DDIR_TRIM], max_bs);
652 static inline unsigned int td_min_bs(struct thread_data *td)
656 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
657 return min(td->o.min_bs[DDIR_TRIM], min_bs);
660 static inline int td_async_processing(struct thread_data *td)
662 return (td->flags & TD_F_NEED_LOCK) != 0;
666 * We currently only need to do locking if we have verifier threads
667 * accessing our internal structures too
669 static inline void td_io_u_lock(struct thread_data *td)
671 if (td_async_processing(td))
672 pthread_mutex_lock(&td->io_u_lock);
675 static inline void td_io_u_unlock(struct thread_data *td)
677 if (td_async_processing(td))
678 pthread_mutex_unlock(&td->io_u_lock);
681 static inline void td_io_u_free_notify(struct thread_data *td)
683 if (td_async_processing(td))
684 pthread_cond_signal(&td->free_cond);
687 extern const char *fio_get_arch_string(int);
688 extern const char *fio_get_os_string(int);
691 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
692 #define FIELD_SIZE(s, f) (sizeof(((typeof(s))0)->f))
696 __FIO_OUTPUT_TERSE = 0,
697 __FIO_OUTPUT_JSON = 1,
698 __FIO_OUTPUT_NORMAL = 2,
699 __FIO_OUTPUT_JSON_PLUS = 3,
702 FIO_OUTPUT_TERSE = 1U << __FIO_OUTPUT_TERSE,
703 FIO_OUTPUT_JSON = 1U << __FIO_OUTPUT_JSON,
704 FIO_OUTPUT_NORMAL = 1U << __FIO_OUTPUT_NORMAL,
705 FIO_OUTPUT_JSON_PLUS = 1U << __FIO_OUTPUT_JSON_PLUS,
709 FIO_RAND_DIST_RANDOM = 0,
711 FIO_RAND_DIST_PARETO,
715 #define FIO_DEF_ZIPF 1.1
716 #define FIO_DEF_PARETO 0.2
719 FIO_RAND_GEN_TAUSWORTHE = 0,
721 FIO_RAND_GEN_TAUSWORTHE64,
729 extern void exec_trigger(const char *);
730 extern void check_trigger_file(void);