8 #include <sys/resource.h>
19 #include "compiler/compiler.h"
20 #include "thread_options.h"
23 #include "lib/rbtree.h"
24 #include "arch/arch.h"
38 #include "lib/getopt.h"
45 #ifdef FIO_HAVE_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 struct rusage ru_start;
117 struct rusage ru_end;
119 struct fio_file **files;
120 unsigned int files_size;
121 unsigned int files_index;
122 unsigned int nr_open_files;
123 unsigned int nr_done_files;
124 unsigned int nr_normal_files;
126 unsigned int next_file;
127 os_random_state_t next_file_state;
128 struct frand_state __next_file_state;
135 size_t orig_buffer_size;
136 volatile int terminate;
137 volatile int runstate;
138 unsigned int last_was_sync;
139 enum fio_ddir last_ddir;
148 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
151 os_random_state_t bsrange_state;
152 struct frand_state __bsrange_state;
155 os_random_state_t verify_state;
156 struct frand_state __verify_state;
159 os_random_state_t trim_state;
160 struct frand_state __trim_state;
163 struct frand_state buf_state;
165 unsigned int verify_batch;
166 unsigned int trim_batch;
171 * IO engine hooks, contains everything needed to submit an io_u
172 * to any of the available IO engines.
174 struct ioengine_ops *io_ops;
177 * Queue depth of io_u's that fio MIGHT do
179 unsigned int cur_depth;
182 * io_u's about to be committed
184 unsigned int io_u_queued;
187 * io_u's submitted but not completed yet
189 unsigned int io_u_in_flight;
192 * List of free and busy io_u's
194 struct flist_head io_u_freelist;
195 struct flist_head io_u_busylist;
196 struct flist_head io_u_requeues;
197 pthread_mutex_t io_u_lock;
198 pthread_cond_t free_cond;
201 * async verify offload
203 struct flist_head verify_list;
204 pthread_t *verify_threads;
205 unsigned int nr_verify_threads;
206 pthread_cond_t verify_cond;
207 int verify_thread_exit;
212 unsigned long long rate_bps[DDIR_RWDIR_CNT];
213 long rate_pending_usleep[DDIR_RWDIR_CNT];
214 unsigned long rate_bytes[DDIR_RWDIR_CNT];
215 unsigned long rate_blocks[DDIR_RWDIR_CNT];
216 struct timeval lastrate[DDIR_RWDIR_CNT];
218 unsigned long long total_io_size;
219 unsigned long long fill_device_size;
221 unsigned long io_issues[DDIR_RWDIR_CNT];
222 unsigned long long io_blocks[DDIR_RWDIR_CNT];
223 unsigned long long this_io_blocks[DDIR_RWDIR_CNT];
224 unsigned long long io_bytes[DDIR_RWDIR_CNT];
225 unsigned long long io_skip_bytes;
226 unsigned long long this_io_bytes[DDIR_RWDIR_CNT];
227 unsigned long long zone_bytes;
228 struct fio_mutex *mutex;
231 * State for random io, a bitmap of blocks done vs not done
234 os_random_state_t random_state;
235 struct frand_state __random_state;
238 struct timeval start; /* start of this loop */
239 struct timeval epoch; /* time job was started */
240 struct timeval last_issue;
241 struct timeval tv_cache;
242 unsigned int tv_cache_nr;
243 unsigned int tv_cache_mask;
244 unsigned int ramp_time_over;
247 * read/write mixed workload state
250 os_random_state_t rwmix_state;
251 struct frand_state __rwmix_state;
253 unsigned long rwmix_issues;
254 enum fio_ddir rwmix_ddir;
255 unsigned int ddir_seq_nr;
258 * IO history logs for verification. We use a tree for sorting,
259 * if we are overwriting. Otherwise just use a fifo.
261 struct rb_root io_hist_tree;
262 struct flist_head io_hist_list;
263 unsigned long io_hist_len;
268 struct flist_head io_log_list;
271 * For tracking/handling discards
273 struct flist_head trim_list;
274 unsigned long trim_entries;
276 struct flist_head next_rand_list;
279 * for fileservice, how often to switch to a new file
281 unsigned int file_service_nr;
282 unsigned int file_service_left;
283 struct fio_file *file_service_file;
285 unsigned int sync_file_range_nr;
288 * For generating file sizes
291 os_random_state_t file_size_state;
292 struct frand_state __file_size_state;
298 unsigned int total_err_count;
301 struct fio_flow *flow;
304 * Can be overloaded by profiles
306 struct prof_io_ops prof_io_ops;
313 * when should interactive ETA output be generated
321 #define __td_verror(td, err, msg, func) \
327 if (!(td)->first_error) \
328 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
332 #define td_clear_error(td) \
334 #define td_verror(td, err, func) \
335 __td_verror((td), (err), strerror((err)), (func))
336 #define td_vmsg(td, err, msg, func) \
337 __td_verror((td), (err), (msg), (func))
339 #define __fio_stringify_1(x) #x
340 #define __fio_stringify(x) __fio_stringify_1(x)
342 extern int exitall_on_terminate;
343 extern unsigned int thread_number;
344 extern unsigned int stat_number;
347 extern int output_format;
348 extern int temp_stall_ts;
349 extern uintptr_t page_mask, page_size;
350 extern int read_only;
351 extern int eta_print;
352 extern unsigned long done_secs;
353 extern char *job_section;
354 extern int fio_gtod_offload;
355 extern int fio_gtod_cpu;
356 extern enum fio_cs fio_clock_source;
357 extern int fio_clock_source_set;
358 extern int warnings_fatal;
359 extern int terse_version;
360 extern int is_backend;
361 extern int nr_clients;
362 extern int log_syslog;
363 extern const char fio_version_string[];
364 extern const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN];
366 extern struct thread_data *threads;
368 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
370 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
373 #define REAL_MAX_JOBS 2048
375 static inline enum error_type_bit td_error_type(enum fio_ddir ddir, int err)
378 return ERROR_TYPE_VERIFY_BIT;
379 if (ddir == DDIR_READ)
380 return ERROR_TYPE_READ_BIT;
381 return ERROR_TYPE_WRITE_BIT;
384 static int __NON_FATAL_ERR[] = {EIO, EILSEQ};
385 static inline int td_non_fatal_error(struct thread_data *td,
386 enum error_type_bit etype, int err)
389 if (!td->o.ignore_error[etype]) {
390 td->o.ignore_error[etype] = __NON_FATAL_ERR;
391 td->o.ignore_error_nr[etype] = sizeof(__NON_FATAL_ERR)
395 if (!(td->o.continue_on_error & (1 << etype)))
397 for (i = 0; i < td->o.ignore_error_nr[etype]; i++)
398 if (td->o.ignore_error[etype][i] == err)
403 static inline void update_error_count(struct thread_data *td, int err)
405 td->total_err_count++;
406 if (td->total_err_count == 1)
407 td->first_error = err;
410 static inline int should_fsync(struct thread_data *td)
412 if (td->last_was_sync)
416 if (td_write(td) || td_rw(td) || td->o.override_sync)
423 * Init/option functions
425 extern int __must_check fio_init_options(void);
426 extern int __must_check parse_options(int, char **);
427 extern int parse_jobs_ini(char *, int, int, int);
428 extern int parse_cmd_line(int, char **, int);
429 extern int fio_backend(void);
430 extern void reset_fio_state(void);
431 extern void clear_io_state(struct thread_data *);
432 extern int fio_options_parse(struct thread_data *, char **, int);
433 extern void fio_keywords_init(void);
434 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
435 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
436 extern void fio_fill_default_options(struct thread_data *);
437 extern int fio_show_option_help(const char *);
438 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
439 extern void fio_options_dup_and_init(struct option *);
440 extern void fio_options_mem_dupe(struct thread_data *);
441 extern void options_mem_dupe(void *data, struct fio_option *options);
442 extern void td_fill_rand_seeds(struct thread_data *);
443 extern void add_job_opts(const char **, int);
444 extern char *num2str(unsigned long, int, int, int);
445 extern int ioengine_load(struct thread_data *);
447 extern unsigned long page_mask;
448 extern unsigned long 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
482 extern void td_set_runstate(struct thread_data *, int);
483 #define TERMINATE_ALL (-1)
484 extern void fio_terminate_threads(int);
489 extern int __must_check fio_pin_memory(struct thread_data *);
490 extern void fio_unpin_memory(struct thread_data *);
491 extern int __must_check allocate_io_mem(struct thread_data *);
492 extern void free_io_mem(struct thread_data *);
493 extern void free_threads_shm(void);
496 * Reset stats after ramp time completes
498 extern void reset_all_stats(struct thread_data *);
503 #ifdef FIO_HAVE_BLKTRACE
504 extern int is_blktrace(const char *);
505 extern int load_blktrace(struct thread_data *, const char *);
509 * Mark unused variables passed to ops functions as unused, to silence gcc
511 #define fio_unused __attribute((__unused__))
512 #define fio_init __attribute__((constructor))
513 #define fio_exit __attribute__((destructor))
515 #define for_each_td(td, i) \
516 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
517 #define for_each_file(td, f, i) \
518 if ((td)->files_index) \
519 for ((i) = 0, (f) = (td)->files[0]; \
520 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
523 #define fio_assert(td, cond) do { \
526 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
527 td_set_runstate((td), TD_EXITED); \
528 (td)->error = EFAULT; \
533 static inline int fio_fill_issue_time(struct thread_data *td)
535 if (td->o.read_iolog_file ||
536 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
542 static inline int __should_check_rate(struct thread_data *td,
545 struct thread_options *o = &td->o;
548 * If some rate setting was given, we need to check it
550 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
551 o->rate_iops_min[ddir])
557 static inline int should_check_rate(struct thread_data *td,
558 uint64_t *bytes_done)
562 if (bytes_done[DDIR_READ])
563 ret |= __should_check_rate(td, DDIR_READ);
564 if (bytes_done[DDIR_WRITE])
565 ret |= __should_check_rate(td, DDIR_WRITE);
566 if (bytes_done[DDIR_TRIM])
567 ret |= __should_check_rate(td, DDIR_TRIM);
572 static inline int is_power_of_2(unsigned int val)
574 return (val != 0 && ((val & (val - 1)) == 0));
578 * We currently only need to do locking if we have verifier threads
579 * accessing our internal structures too
581 static inline void td_io_u_lock(struct thread_data *td)
583 if (td->o.verify_async)
584 pthread_mutex_lock(&td->io_u_lock);
587 static inline void td_io_u_unlock(struct thread_data *td)
589 if (td->o.verify_async)
590 pthread_mutex_unlock(&td->io_u_lock);
593 static inline void td_io_u_free_notify(struct thread_data *td)
595 if (td->o.verify_async)
596 pthread_cond_signal(&td->free_cond);
599 extern const char *fio_get_arch_string(int);
600 extern const char *fio_get_os_string(int);
602 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
605 FIO_OUTPUT_TERSE = 0,
611 FIO_RAND_DIST_RANDOM = 0,
613 FIO_RAND_DIST_PARETO,
617 FIO_RAND_GEN_TAUSWORTHE = 0,