8 #include <sys/resource.h>
19 #include "compiler/compiler.h"
20 #include "thread_options.h"
23 #include "arch/arch.h"
37 #include "lib/getopt.h"
39 #include "lib/rbtree.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
69 TD_F_TRIM_BACKLOG = 2,
71 TD_F_REFILL_BUFFERS = 8,
72 TD_F_SCRAMBLE_BUFFERS = 16,
74 TD_F_PROFILE_OPS = 64,
83 FIO_RAND_FILE_SIZE_OFF,
90 * This describes a single thread/process executing a fio job.
93 struct thread_options o;
96 char verror[FIO_VERROR_SIZE];
98 unsigned int thread_number;
100 struct thread_stat ts;
104 struct io_log *slat_log;
105 struct io_log *clat_log;
106 struct io_log *lat_log;
107 struct io_log *bw_log;
108 struct io_log *iops_log;
110 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
111 struct timeval bw_sample_time;
113 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
114 struct timeval iops_sample_time;
116 volatile int update_rusage;
117 struct fio_mutex *rusage_sem;
118 struct rusage ru_start;
119 struct rusage ru_end;
121 struct fio_file **files;
122 unsigned char *file_locks;
123 unsigned int files_size;
124 unsigned int files_index;
125 unsigned int nr_open_files;
126 unsigned int nr_done_files;
127 unsigned int nr_normal_files;
129 unsigned int next_file;
130 os_random_state_t next_file_state;
131 struct frand_state __next_file_state;
138 size_t orig_buffer_size;
139 volatile int terminate;
140 volatile int runstate;
141 unsigned int last_was_sync;
142 enum fio_ddir last_ddir;
151 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
154 os_random_state_t bsrange_state;
155 struct frand_state __bsrange_state;
158 os_random_state_t verify_state;
159 struct frand_state __verify_state;
162 os_random_state_t trim_state;
163 struct frand_state __trim_state;
166 struct frand_state buf_state;
168 unsigned int verify_batch;
169 unsigned int trim_batch;
174 * IO engine hooks, contains everything needed to submit an io_u
175 * to any of the available IO engines.
177 struct ioengine_ops *io_ops;
180 * Queue depth of io_u's that fio MIGHT do
182 unsigned int cur_depth;
185 * io_u's about to be committed
187 unsigned int io_u_queued;
190 * io_u's submitted but not completed yet
192 unsigned int io_u_in_flight;
195 * List of free and busy io_u's
197 struct flist_head io_u_freelist;
198 struct flist_head io_u_busylist;
199 struct flist_head io_u_requeues;
200 pthread_mutex_t io_u_lock;
201 pthread_cond_t free_cond;
204 * async verify offload
206 struct flist_head verify_list;
207 pthread_t *verify_threads;
208 unsigned int nr_verify_threads;
209 pthread_cond_t verify_cond;
210 int verify_thread_exit;
215 uint64_t rate_bps[DDIR_RWDIR_CNT];
216 long rate_pending_usleep[DDIR_RWDIR_CNT];
217 unsigned long rate_bytes[DDIR_RWDIR_CNT];
218 unsigned long rate_blocks[DDIR_RWDIR_CNT];
219 struct timeval lastrate[DDIR_RWDIR_CNT];
221 uint64_t total_io_size;
222 uint64_t fill_device_size;
224 unsigned long io_issues[DDIR_RWDIR_CNT];
225 uint64_t io_blocks[DDIR_RWDIR_CNT];
226 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
227 uint64_t io_bytes[DDIR_RWDIR_CNT];
228 uint64_t io_skip_bytes;
229 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
231 struct fio_mutex *mutex;
234 * State for random io, a bitmap of blocks done vs not done
237 os_random_state_t random_state;
238 struct frand_state __random_state;
241 struct timeval start; /* start of this loop */
242 struct timeval epoch; /* time job was started */
243 struct timeval last_issue;
244 struct timeval tv_cache;
245 unsigned int tv_cache_nr;
246 unsigned int tv_cache_mask;
247 unsigned int ramp_time_over;
250 * read/write mixed workload state
253 os_random_state_t rwmix_state;
254 struct frand_state __rwmix_state;
256 unsigned long rwmix_issues;
257 enum fio_ddir rwmix_ddir;
258 unsigned int ddir_seq_nr;
261 * IO history logs for verification. We use a tree for sorting,
262 * if we are overwriting. Otherwise just use a fifo.
264 struct rb_root io_hist_tree;
265 struct flist_head io_hist_list;
266 unsigned long io_hist_len;
271 struct flist_head io_log_list;
274 * For tracking/handling discards
276 struct flist_head trim_list;
277 unsigned long trim_entries;
279 struct flist_head next_rand_list;
282 * for fileservice, how often to switch to a new file
284 unsigned int file_service_nr;
285 unsigned int file_service_left;
286 struct fio_file *file_service_file;
288 unsigned int sync_file_range_nr;
291 * For generating file sizes
294 os_random_state_t file_size_state;
295 struct frand_state __file_size_state;
301 unsigned int total_err_count;
304 struct fio_flow *flow;
307 * Can be overloaded by profiles
309 struct prof_io_ops prof_io_ops;
316 * when should interactive ETA output be generated
324 #define __td_verror(td, err, msg, func) \
330 if (!(td)->first_error) \
331 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
335 #define td_clear_error(td) \
337 #define td_verror(td, err, func) \
338 __td_verror((td), (err), strerror((err)), (func))
339 #define td_vmsg(td, err, msg, func) \
340 __td_verror((td), (err), (msg), (func))
342 #define __fio_stringify_1(x) #x
343 #define __fio_stringify(x) __fio_stringify_1(x)
345 extern int exitall_on_terminate;
346 extern unsigned int thread_number;
347 extern unsigned int stat_number;
350 extern int output_format;
351 extern int temp_stall_ts;
352 extern uintptr_t page_mask, page_size;
353 extern int read_only;
354 extern int eta_print;
355 extern int eta_new_line;
356 extern unsigned long done_secs;
357 extern char *job_section;
358 extern int fio_gtod_offload;
359 extern int fio_gtod_cpu;
360 extern enum fio_cs fio_clock_source;
361 extern int fio_clock_source_set;
362 extern int warnings_fatal;
363 extern int terse_version;
364 extern int is_backend;
365 extern int nr_clients;
366 extern int log_syslog;
367 extern const char fio_version_string[];
369 extern struct thread_data *threads;
371 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
373 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
376 #define REAL_MAX_JOBS 2048
378 static inline enum error_type_bit td_error_type(enum fio_ddir ddir, int err)
381 return ERROR_TYPE_VERIFY_BIT;
382 if (ddir == DDIR_READ)
383 return ERROR_TYPE_READ_BIT;
384 return ERROR_TYPE_WRITE_BIT;
387 static int __NON_FATAL_ERR[] = {EIO, EILSEQ};
388 static inline int td_non_fatal_error(struct thread_data *td,
389 enum error_type_bit etype, int err)
393 if (!td->o.ignore_error[etype]) {
394 td->o.ignore_error[etype] = __NON_FATAL_ERR;
395 td->o.ignore_error_nr[etype] = sizeof(__NON_FATAL_ERR)
399 if (!(td->o.continue_on_error & (1 << etype)))
401 for (i = 0; i < td->o.ignore_error_nr[etype]; i++)
402 if (td->o.ignore_error[etype][i] == err)
407 static inline void update_error_count(struct thread_data *td, int err)
409 td->total_err_count++;
410 if (td->total_err_count == 1)
411 td->first_error = err;
414 static inline int should_fsync(struct thread_data *td)
416 if (td->last_was_sync)
418 if (td_write(td) || td_rw(td) || td->o.override_sync)
425 * Init/option functions
427 extern int __must_check fio_init_options(void);
428 extern int __must_check parse_options(int, char **);
429 extern int parse_jobs_ini(char *, int, int, int);
430 extern int parse_cmd_line(int, char **, int);
431 extern int fio_backend(void);
432 extern void reset_fio_state(void);
433 extern void clear_io_state(struct thread_data *);
434 extern int fio_options_parse(struct thread_data *, char **, int);
435 extern void fio_keywords_init(void);
436 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
437 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
438 extern void fio_fill_default_options(struct thread_data *);
439 extern int fio_show_option_help(const char *);
440 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
441 extern void fio_options_dup_and_init(struct option *);
442 extern void fio_options_mem_dupe(struct thread_data *);
443 extern void options_mem_dupe(void *data, struct fio_option *options);
444 extern void td_fill_rand_seeds(struct thread_data *);
445 extern void add_job_opts(const char **, int);
446 extern char *num2str(unsigned long, int, int, int, int);
447 extern int ioengine_load(struct thread_data *);
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
484 extern void td_set_runstate(struct thread_data *, int);
485 #define TERMINATE_ALL (-1)
486 extern void fio_terminate_threads(int);
491 extern int __must_check fio_pin_memory(struct thread_data *);
492 extern void fio_unpin_memory(struct thread_data *);
493 extern int __must_check allocate_io_mem(struct thread_data *);
494 extern void free_io_mem(struct thread_data *);
495 extern void free_threads_shm(void);
498 * Reset stats after ramp time completes
500 extern void reset_all_stats(struct thread_data *);
505 #ifdef FIO_HAVE_BLKTRACE
506 extern int is_blktrace(const char *);
507 extern int load_blktrace(struct thread_data *, const char *);
511 * Mark unused variables passed to ops functions as unused, to silence gcc
513 #define fio_unused __attribute((__unused__))
514 #define fio_init __attribute__((constructor))
515 #define fio_exit __attribute__((destructor))
517 #define for_each_td(td, i) \
518 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
519 #define for_each_file(td, f, i) \
520 if ((td)->files_index) \
521 for ((i) = 0, (f) = (td)->files[0]; \
522 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
525 #define fio_assert(td, cond) do { \
528 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
529 td_set_runstate((td), TD_EXITED); \
530 (td)->error = EFAULT; \
535 static inline int fio_fill_issue_time(struct thread_data *td)
537 if (td->o.read_iolog_file ||
538 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
544 static inline int __should_check_rate(struct thread_data *td,
547 struct thread_options *o = &td->o;
550 * If some rate setting was given, we need to check it
552 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
553 o->rate_iops_min[ddir])
559 static inline int should_check_rate(struct thread_data *td,
560 uint64_t *bytes_done)
564 if (bytes_done[DDIR_READ])
565 ret |= __should_check_rate(td, DDIR_READ);
566 if (bytes_done[DDIR_WRITE])
567 ret |= __should_check_rate(td, DDIR_WRITE);
568 if (bytes_done[DDIR_TRIM])
569 ret |= __should_check_rate(td, DDIR_TRIM);
574 static inline unsigned int td_max_bs(struct thread_data *td)
578 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
579 return max(td->o.max_bs[DDIR_TRIM], max_bs);
582 static inline int is_power_of_2(unsigned int val)
584 return (val != 0 && ((val & (val - 1)) == 0));
588 * We currently only need to do locking if we have verifier threads
589 * accessing our internal structures too
591 static inline void td_io_u_lock(struct thread_data *td)
593 if (td->o.verify_async)
594 pthread_mutex_lock(&td->io_u_lock);
597 static inline void td_io_u_unlock(struct thread_data *td)
599 if (td->o.verify_async)
600 pthread_mutex_unlock(&td->io_u_lock);
603 static inline void td_io_u_free_notify(struct thread_data *td)
605 if (td->o.verify_async)
606 pthread_cond_signal(&td->free_cond);
609 extern const char *fio_get_arch_string(int);
610 extern const char *fio_get_os_string(int);
612 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
615 FIO_OUTPUT_TERSE = 0,
621 FIO_RAND_DIST_RANDOM = 0,
623 FIO_RAND_DIST_PARETO,
627 FIO_RAND_GEN_TAUSWORTHE = 0,