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"
44 #ifdef CONFIG_SOLARISAIO
45 #include <sys/asynch.h>
49 #include <linux/mempolicy.h>
53 * "local" is pseudo-policy
55 #define MPOL_LOCAL MPOL_MAX
59 * offset generator types
68 TD_F_TRIM_BACKLOG = 2,
70 TD_F_REFILL_BUFFERS = 8,
71 TD_F_SCRAMBLE_BUFFERS = 16,
73 TD_F_PROFILE_OPS = 64,
76 TD_F_COMPRESS_LOG = 512,
77 TD_F_VSTATE_SAVED = 1024,
86 FIO_RAND_FILE_SIZE_OFF,
89 FIO_RAND_SEQ_RAND_READ_OFF,
90 FIO_RAND_SEQ_RAND_WRITE_OFF,
91 FIO_RAND_SEQ_RAND_TRIM_OFF,
98 * This describes a single thread/process executing a fio job.
101 struct thread_options o;
104 char verror[FIO_VERROR_SIZE];
106 unsigned int thread_number;
107 unsigned int subjob_number;
108 unsigned int groupid;
109 struct thread_stat ts;
113 struct io_log *slat_log;
114 struct io_log *clat_log;
115 struct io_log *lat_log;
116 struct io_log *bw_log;
117 struct io_log *iops_log;
119 struct tp_data *tp_data;
121 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
122 struct timeval bw_sample_time;
124 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
125 struct timeval iops_sample_time;
128 * Tracks the last iodepth number of completed writes, if data
129 * verification is enabled
131 uint64_t *last_write_comp;
132 unsigned int last_write_idx;
134 volatile int update_rusage;
135 struct fio_mutex *rusage_sem;
136 struct rusage ru_start;
137 struct rusage ru_end;
139 struct fio_file **files;
140 unsigned char *file_locks;
141 unsigned int files_size;
142 unsigned int files_index;
143 unsigned int nr_open_files;
144 unsigned int nr_done_files;
145 unsigned int nr_normal_files;
147 unsigned int next_file;
148 struct frand_state next_file_state;
156 size_t orig_buffer_size;
157 volatile int terminate;
158 volatile int runstate;
159 unsigned int last_was_sync;
160 enum fio_ddir last_ddir;
169 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
171 struct frand_state bsrange_state;
172 struct frand_state verify_state;
173 struct frand_state trim_state;
174 struct frand_state delay_state;
176 struct frand_state buf_state;
177 struct frand_state buf_state_prev;
178 struct frand_state dedupe_state;
180 unsigned int verify_batch;
181 unsigned int trim_batch;
183 struct thread_io_list *vstate;
188 * IO engine hooks, contains everything needed to submit an io_u
189 * to any of the available IO engines.
191 struct ioengine_ops *io_ops;
194 * Queue depth of io_u's that fio MIGHT do
196 unsigned int cur_depth;
199 * io_u's about to be committed
201 unsigned int io_u_queued;
204 * io_u's submitted but not completed yet
206 unsigned int io_u_in_flight;
209 * List of free and busy io_u's
211 struct io_u_ring io_u_requeues;
212 struct io_u_queue io_u_freelist;
213 struct io_u_queue io_u_all;
214 pthread_mutex_t io_u_lock;
215 pthread_cond_t free_cond;
218 * async verify offload
220 struct flist_head verify_list;
221 pthread_t *verify_threads;
222 unsigned int nr_verify_threads;
223 pthread_cond_t verify_cond;
224 int verify_thread_exit;
229 uint64_t rate_bps[DDIR_RWDIR_CNT];
230 long rate_pending_usleep[DDIR_RWDIR_CNT];
231 unsigned long rate_bytes[DDIR_RWDIR_CNT];
232 unsigned long rate_blocks[DDIR_RWDIR_CNT];
233 struct timeval lastrate[DDIR_RWDIR_CNT];
235 uint64_t total_io_size;
236 uint64_t fill_device_size;
238 uint64_t io_issues[DDIR_RWDIR_CNT];
239 uint64_t io_blocks[DDIR_RWDIR_CNT];
240 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
241 uint64_t io_bytes[DDIR_RWDIR_CNT];
242 uint64_t io_skip_bytes;
243 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
245 struct fio_mutex *mutex;
248 * State for random io, a bitmap of blocks done vs not done
250 struct frand_state random_state;
252 struct timeval start; /* start of this loop */
253 struct timeval epoch; /* time job was started */
254 struct timeval last_issue;
256 struct timeval tv_cache;
257 struct timeval terminate_time;
258 unsigned int tv_cache_nr;
259 unsigned int tv_cache_mask;
260 unsigned int ramp_time_over;
263 * Time since last latency_window was started
265 struct timeval latency_ts;
266 unsigned int latency_qd;
267 unsigned int latency_qd_high;
268 unsigned int latency_qd_low;
269 unsigned int latency_failed;
270 uint64_t latency_ios;
274 * read/write mixed workload state
276 struct frand_state rwmix_state;
277 unsigned long rwmix_issues;
278 enum fio_ddir rwmix_ddir;
279 unsigned int ddir_seq_nr;
282 * rand/seq mixed workload state
284 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
287 * IO history logs for verification. We use a tree for sorting,
288 * if we are overwriting. Otherwise just use a fifo.
290 struct rb_root io_hist_tree;
291 struct flist_head io_hist_list;
292 unsigned long io_hist_len;
297 struct flist_head io_log_list;
300 * For tracking/handling discards
302 struct flist_head trim_list;
303 unsigned long trim_entries;
305 struct flist_head next_rand_list;
308 * for fileservice, how often to switch to a new file
310 unsigned int file_service_nr;
311 unsigned int file_service_left;
312 struct fio_file *file_service_file;
314 unsigned int sync_file_range_nr;
317 * For generating file sizes
319 struct frand_state file_size_state;
324 unsigned int total_err_count;
327 struct fio_flow *flow;
330 * Can be overloaded by profiles
332 struct prof_io_ops prof_io_ops;
339 * when should interactive ETA output be generated
347 #define __td_verror(td, err, msg, func) \
349 unsigned int ____e = (err); \
352 (td)->error = ____e; \
353 if (!(td)->first_error) \
354 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
358 #define td_clear_error(td) \
360 #define td_verror(td, err, func) \
361 __td_verror((td), (err), strerror((err)), (func))
362 #define td_vmsg(td, err, msg, func) \
363 __td_verror((td), (err), (msg), (func))
365 #define __fio_stringify_1(x) #x
366 #define __fio_stringify(x) __fio_stringify_1(x)
368 extern int exitall_on_terminate;
369 extern unsigned int thread_number;
370 extern unsigned int stat_number;
373 extern int output_format;
374 extern int append_terse_output;
375 extern int temp_stall_ts;
376 extern uintptr_t page_mask, page_size;
377 extern int read_only;
378 extern int eta_print;
379 extern int eta_new_line;
380 extern unsigned long done_secs;
381 extern char *job_section;
382 extern int fio_gtod_offload;
383 extern int fio_gtod_cpu;
384 extern enum fio_cs fio_clock_source;
385 extern int fio_clock_source_set;
386 extern int warnings_fatal;
387 extern int terse_version;
388 extern int is_backend;
389 extern int nr_clients;
390 extern int log_syslog;
391 extern int status_interval;
392 extern const char fio_version_string[];
393 extern int helper_do_stat;
394 extern pthread_cond_t helper_cond;
395 extern char *trigger_file;
396 extern char *trigger_cmd;
397 extern char *trigger_remote_cmd;
398 extern long long trigger_timeout;
400 extern struct thread_data *threads;
402 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
404 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
407 #define REAL_MAX_JOBS 2048
409 static inline int should_fsync(struct thread_data *td)
411 if (td->last_was_sync)
413 if (td_write(td) || td_rw(td) || td->o.override_sync)
420 * Init/option functions
422 extern int __must_check fio_init_options(void);
423 extern int __must_check parse_options(int, char **);
424 extern int parse_jobs_ini(char *, int, int, int);
425 extern int parse_cmd_line(int, char **, int);
426 extern int fio_backend(void);
427 extern void reset_fio_state(void);
428 extern void clear_io_state(struct thread_data *);
429 extern int fio_options_parse(struct thread_data *, char **, int, int);
430 extern void fio_keywords_init(void);
431 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
432 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
433 extern void fio_fill_default_options(struct thread_data *);
434 extern int fio_show_option_help(const char *);
435 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
436 extern void fio_options_dup_and_init(struct option *);
437 extern void fio_options_mem_dupe(struct thread_data *);
438 extern void options_mem_dupe(void *data, struct fio_option *options);
439 extern void td_fill_rand_seeds(struct thread_data *);
440 extern void add_job_opts(const char **, int);
441 extern char *num2str(uint64_t, int, int, int, int);
442 extern int ioengine_load(struct thread_data *);
443 extern int parse_dryrun(void);
444 extern int fio_running_or_pending_io_threads(void);
445 extern int fio_set_fd_nonblocking(int, const char *);
447 extern uintptr_t page_mask;
448 extern uintptr_t page_size;
449 extern int initialize_fio(char *envp[]);
451 #define FIO_GETOPT_JOB 0x89000000
452 #define FIO_GETOPT_IOENGINE 0x98000000
453 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
458 extern void print_thread_status(void);
459 extern void print_status_init(int);
460 extern char *fio_uint_to_kmg(unsigned int val);
463 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
464 * will never back again. It may cycle between running/verififying/fsyncing.
465 * Once the thread reaches TD_EXITED, it is just waiting for the core to
483 extern void td_set_runstate(struct thread_data *, int);
484 extern int td_bump_runstate(struct thread_data *, int);
485 extern void td_restore_runstate(struct thread_data *, int);
488 * Allow 60 seconds for a job to quit on its own, otherwise reap with
491 #define FIO_REAP_TIMEOUT 60
493 #define TERMINATE_ALL (-1)
494 extern void fio_terminate_threads(int);
495 extern void fio_mark_td_terminate(struct thread_data *);
500 extern int __must_check fio_pin_memory(struct thread_data *);
501 extern void fio_unpin_memory(struct thread_data *);
502 extern int __must_check allocate_io_mem(struct thread_data *);
503 extern void free_io_mem(struct thread_data *);
504 extern void free_threads_shm(void);
507 * Reset stats after ramp time completes
509 extern void reset_all_stats(struct thread_data *);
514 #ifdef FIO_HAVE_BLKTRACE
515 extern int is_blktrace(const char *, int *);
516 extern int load_blktrace(struct thread_data *, const char *, int);
520 * Latency target helpers
522 extern void lat_target_check(struct thread_data *);
523 extern void lat_target_init(struct thread_data *);
524 extern void lat_target_reset(struct thread_data *);
526 #define for_each_td(td, i) \
527 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
528 #define for_each_file(td, f, i) \
529 if ((td)->files_index) \
530 for ((i) = 0, (f) = (td)->files[0]; \
531 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
534 #define fio_assert(td, cond) do { \
537 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
538 td_set_runstate((td), TD_EXITED); \
539 (td)->error = EFAULT; \
544 static inline int fio_fill_issue_time(struct thread_data *td)
546 if (td->o.read_iolog_file ||
547 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
553 static inline int __should_check_rate(struct thread_data *td,
556 struct thread_options *o = &td->o;
559 * If some rate setting was given, we need to check it
561 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
562 o->rate_iops_min[ddir])
568 static inline int should_check_rate(struct thread_data *td,
569 uint64_t *bytes_done)
573 if (bytes_done[DDIR_READ])
574 ret |= __should_check_rate(td, DDIR_READ);
575 if (bytes_done[DDIR_WRITE])
576 ret |= __should_check_rate(td, DDIR_WRITE);
577 if (bytes_done[DDIR_TRIM])
578 ret |= __should_check_rate(td, DDIR_TRIM);
583 static inline unsigned int td_max_bs(struct thread_data *td)
587 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
588 return max(td->o.max_bs[DDIR_TRIM], max_bs);
591 static inline unsigned int td_min_bs(struct thread_data *td)
595 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
596 return min(td->o.min_bs[DDIR_TRIM], min_bs);
599 static inline int is_power_of_2(uint64_t val)
601 return (val != 0 && ((val & (val - 1)) == 0));
605 * We currently only need to do locking if we have verifier threads
606 * accessing our internal structures too
608 static inline void td_io_u_lock(struct thread_data *td)
610 if (td->o.verify_async)
611 pthread_mutex_lock(&td->io_u_lock);
614 static inline void td_io_u_unlock(struct thread_data *td)
616 if (td->o.verify_async)
617 pthread_mutex_unlock(&td->io_u_lock);
620 static inline void td_io_u_free_notify(struct thread_data *td)
622 if (td->o.verify_async)
623 pthread_cond_signal(&td->free_cond);
626 extern const char *fio_get_arch_string(int);
627 extern const char *fio_get_os_string(int);
630 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
634 FIO_OUTPUT_TERSE = 0,
640 FIO_RAND_DIST_RANDOM = 0,
642 FIO_RAND_DIST_PARETO,
645 #define FIO_DEF_ZIPF 1.1
646 #define FIO_DEF_PARETO 0.2
649 FIO_RAND_GEN_TAUSWORTHE = 0,
658 extern void exec_trigger(const char *);
659 extern void check_trigger_file(void);