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,
85 FIO_RAND_FILE_SIZE_OFF,
88 FIO_RAND_SEQ_RAND_READ_OFF,
89 FIO_RAND_SEQ_RAND_WRITE_OFF,
90 FIO_RAND_SEQ_RAND_TRIM_OFF,
96 * This describes a single thread/process executing a fio job.
99 struct thread_options o;
102 char verror[FIO_VERROR_SIZE];
104 unsigned int thread_number;
105 unsigned int groupid;
106 struct thread_stat ts;
110 struct io_log *slat_log;
111 struct io_log *clat_log;
112 struct io_log *lat_log;
113 struct io_log *bw_log;
114 struct io_log *iops_log;
116 struct tp_data *tp_data;
118 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
119 struct timeval bw_sample_time;
121 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
122 struct timeval iops_sample_time;
124 volatile int update_rusage;
125 struct fio_mutex *rusage_sem;
126 struct rusage ru_start;
127 struct rusage ru_end;
129 struct fio_file **files;
130 unsigned char *file_locks;
131 unsigned int files_size;
132 unsigned int files_index;
133 unsigned int nr_open_files;
134 unsigned int nr_done_files;
135 unsigned int nr_normal_files;
137 unsigned int next_file;
138 os_random_state_t next_file_state;
139 struct frand_state __next_file_state;
146 size_t orig_buffer_size;
147 volatile int terminate;
148 volatile int runstate;
149 unsigned int last_was_sync;
150 enum fio_ddir last_ddir;
159 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
162 os_random_state_t bsrange_state;
163 struct frand_state __bsrange_state;
166 os_random_state_t verify_state;
167 struct frand_state __verify_state;
170 os_random_state_t trim_state;
171 struct frand_state __trim_state;
174 os_random_state_t delay_state;
175 struct frand_state __delay_state;
178 struct frand_state buf_state;
180 unsigned int verify_batch;
181 unsigned int trim_batch;
186 * IO engine hooks, contains everything needed to submit an io_u
187 * to any of the available IO engines.
189 struct ioengine_ops *io_ops;
192 * Queue depth of io_u's that fio MIGHT do
194 unsigned int cur_depth;
197 * io_u's about to be committed
199 unsigned int io_u_queued;
202 * io_u's submitted but not completed yet
204 unsigned int io_u_in_flight;
207 * List of free and busy io_u's
209 struct io_u_ring io_u_requeues;
210 struct io_u_queue io_u_freelist;
211 struct io_u_queue io_u_all;
212 pthread_mutex_t io_u_lock;
213 pthread_cond_t free_cond;
216 * async verify offload
218 struct flist_head verify_list;
219 pthread_t *verify_threads;
220 unsigned int nr_verify_threads;
221 pthread_cond_t verify_cond;
222 int verify_thread_exit;
227 uint64_t rate_bps[DDIR_RWDIR_CNT];
228 long rate_pending_usleep[DDIR_RWDIR_CNT];
229 unsigned long rate_bytes[DDIR_RWDIR_CNT];
230 unsigned long rate_blocks[DDIR_RWDIR_CNT];
231 struct timeval lastrate[DDIR_RWDIR_CNT];
233 uint64_t total_io_size;
234 uint64_t fill_device_size;
236 unsigned long io_issues[DDIR_RWDIR_CNT];
237 uint64_t io_blocks[DDIR_RWDIR_CNT];
238 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
239 uint64_t io_bytes[DDIR_RWDIR_CNT];
240 uint64_t io_skip_bytes;
241 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
243 struct fio_mutex *mutex;
246 * State for random io, a bitmap of blocks done vs not done
249 os_random_state_t random_state;
250 struct frand_state __random_state;
253 struct timeval start; /* start of this loop */
254 struct timeval epoch; /* time job was started */
255 struct timeval last_issue;
256 struct timeval tv_cache;
257 unsigned int tv_cache_nr;
258 unsigned int tv_cache_mask;
259 unsigned int ramp_time_over;
262 * Time since last latency_window was started
264 struct timeval latency_ts;
265 unsigned int latency_qd;
266 unsigned int latency_qd_high;
267 unsigned int latency_qd_low;
268 unsigned int latency_failed;
269 uint64_t latency_ios;
273 * read/write mixed workload state
276 os_random_state_t rwmix_state;
277 struct frand_state __rwmix_state;
279 unsigned long rwmix_issues;
280 enum fio_ddir rwmix_ddir;
281 unsigned int ddir_seq_nr;
284 * rand/seq mixed workload state
287 os_random_state_t seq_rand_state[DDIR_RWDIR_CNT];
288 struct frand_state __seq_rand_state[DDIR_RWDIR_CNT];
292 * IO history logs for verification. We use a tree for sorting,
293 * if we are overwriting. Otherwise just use a fifo.
295 struct rb_root io_hist_tree;
296 struct flist_head io_hist_list;
297 unsigned long io_hist_len;
302 struct flist_head io_log_list;
305 * For tracking/handling discards
307 struct flist_head trim_list;
308 unsigned long trim_entries;
310 struct flist_head next_rand_list;
313 * for fileservice, how often to switch to a new file
315 unsigned int file_service_nr;
316 unsigned int file_service_left;
317 struct fio_file *file_service_file;
319 unsigned int sync_file_range_nr;
322 * For generating file sizes
325 os_random_state_t file_size_state;
326 struct frand_state __file_size_state;
332 unsigned int total_err_count;
335 struct fio_flow *flow;
338 * Can be overloaded by profiles
340 struct prof_io_ops prof_io_ops;
347 * when should interactive ETA output be generated
355 #define __td_verror(td, err, msg, func) \
357 unsigned int ____e = (err); \
360 (td)->error = ____e; \
361 if (!(td)->first_error) \
362 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
366 #define td_clear_error(td) \
368 #define td_verror(td, err, func) \
369 __td_verror((td), (err), strerror((err)), (func))
370 #define td_vmsg(td, err, msg, func) \
371 __td_verror((td), (err), (msg), (func))
373 #define __fio_stringify_1(x) #x
374 #define __fio_stringify(x) __fio_stringify_1(x)
376 extern int exitall_on_terminate;
377 extern unsigned int thread_number;
378 extern unsigned int stat_number;
381 extern int output_format;
382 extern int append_terse_output;
383 extern int temp_stall_ts;
384 extern uintptr_t page_mask, page_size;
385 extern int read_only;
386 extern int eta_print;
387 extern int eta_new_line;
388 extern unsigned long done_secs;
389 extern char *job_section;
390 extern int fio_gtod_offload;
391 extern int fio_gtod_cpu;
392 extern enum fio_cs fio_clock_source;
393 extern int fio_clock_source_set;
394 extern int warnings_fatal;
395 extern int terse_version;
396 extern int is_backend;
397 extern int nr_clients;
398 extern int log_syslog;
399 extern int status_interval;
400 extern const char fio_version_string[];
402 extern struct thread_data *threads;
404 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
406 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
409 #define REAL_MAX_JOBS 2048
411 static inline int should_fsync(struct thread_data *td)
413 if (td->last_was_sync)
415 if (td_write(td) || td_rw(td) || td->o.override_sync)
422 * Init/option functions
424 extern int __must_check fio_init_options(void);
425 extern int __must_check parse_options(int, char **);
426 extern int parse_jobs_ini(char *, int, int, int);
427 extern int parse_cmd_line(int, char **, int);
428 extern int fio_backend(void);
429 extern void reset_fio_state(void);
430 extern void clear_io_state(struct thread_data *);
431 extern int fio_options_parse(struct thread_data *, char **, int, int);
432 extern void fio_keywords_init(void);
433 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
434 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
435 extern void fio_fill_default_options(struct thread_data *);
436 extern int fio_show_option_help(const char *);
437 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
438 extern void fio_options_dup_and_init(struct option *);
439 extern void fio_options_mem_dupe(struct thread_data *);
440 extern void options_mem_dupe(void *data, struct fio_option *options);
441 extern void td_fill_rand_seeds(struct thread_data *);
442 extern void add_job_opts(const char **, int);
443 extern char *num2str(unsigned long, int, int, int, int);
444 extern int ioengine_load(struct thread_data *);
445 extern int parse_dryrun(void);
446 extern int fio_running_or_pending_io_threads(void);
447 extern int fio_set_fd_nonblocking(int, const char *);
449 extern uintptr_t page_mask;
450 extern uintptr_t page_size;
451 extern int initialize_fio(char *envp[]);
453 #define FIO_GETOPT_JOB 0x89000000
454 #define FIO_GETOPT_IOENGINE 0x98000000
455 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
460 extern void print_thread_status(void);
461 extern void print_status_init(int);
462 extern char *fio_uint_to_kmg(unsigned int val);
465 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
466 * will never back again. It may cycle between running/verififying/fsyncing.
467 * Once the thread reaches TD_EXITED, it is just waiting for the core to
485 extern void td_set_runstate(struct thread_data *, int);
486 extern int td_bump_runstate(struct thread_data *, int);
487 extern void td_restore_runstate(struct thread_data *, int);
489 #define TERMINATE_ALL (-1)
490 extern void fio_terminate_threads(int);
495 extern int __must_check fio_pin_memory(struct thread_data *);
496 extern void fio_unpin_memory(struct thread_data *);
497 extern int __must_check allocate_io_mem(struct thread_data *);
498 extern void free_io_mem(struct thread_data *);
499 extern void free_threads_shm(void);
502 * Reset stats after ramp time completes
504 extern void reset_all_stats(struct thread_data *);
509 #ifdef FIO_HAVE_BLKTRACE
510 extern int is_blktrace(const char *, int *);
511 extern int load_blktrace(struct thread_data *, const char *, int);
515 * Latency target helpers
517 extern void lat_target_check(struct thread_data *);
518 extern void lat_target_init(struct thread_data *);
519 extern void lat_target_reset(struct thread_data *);
521 #define for_each_td(td, i) \
522 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
523 #define for_each_file(td, f, i) \
524 if ((td)->files_index) \
525 for ((i) = 0, (f) = (td)->files[0]; \
526 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
529 #define fio_assert(td, cond) do { \
532 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
533 td_set_runstate((td), TD_EXITED); \
534 (td)->error = EFAULT; \
539 static inline int fio_fill_issue_time(struct thread_data *td)
541 if (td->o.read_iolog_file ||
542 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
548 static inline int __should_check_rate(struct thread_data *td,
551 struct thread_options *o = &td->o;
554 * If some rate setting was given, we need to check it
556 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
557 o->rate_iops_min[ddir])
563 static inline int should_check_rate(struct thread_data *td,
564 uint64_t *bytes_done)
568 if (bytes_done[DDIR_READ])
569 ret |= __should_check_rate(td, DDIR_READ);
570 if (bytes_done[DDIR_WRITE])
571 ret |= __should_check_rate(td, DDIR_WRITE);
572 if (bytes_done[DDIR_TRIM])
573 ret |= __should_check_rate(td, DDIR_TRIM);
578 static inline unsigned int td_max_bs(struct thread_data *td)
582 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
583 return max(td->o.max_bs[DDIR_TRIM], max_bs);
586 static inline unsigned int td_min_bs(struct thread_data *td)
590 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
591 return min(td->o.min_bs[DDIR_TRIM], min_bs);
594 static inline int is_power_of_2(unsigned long val)
596 return (val != 0 && ((val & (val - 1)) == 0));
600 * We currently only need to do locking if we have verifier threads
601 * accessing our internal structures too
603 static inline void td_io_u_lock(struct thread_data *td)
605 if (td->o.verify_async)
606 pthread_mutex_lock(&td->io_u_lock);
609 static inline void td_io_u_unlock(struct thread_data *td)
611 if (td->o.verify_async)
612 pthread_mutex_unlock(&td->io_u_lock);
615 static inline void td_io_u_free_notify(struct thread_data *td)
617 if (td->o.verify_async)
618 pthread_cond_signal(&td->free_cond);
621 extern const char *fio_get_arch_string(int);
622 extern const char *fio_get_os_string(int);
625 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
629 FIO_OUTPUT_TERSE = 0,
635 FIO_RAND_DIST_RANDOM = 0,
637 FIO_RAND_DIST_PARETO,
641 FIO_RAND_GEN_TAUSWORTHE = 0,