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"
49 #ifdef FIO_HAVE_SOLARISAIO
50 #include <sys/asynch.h>
54 * offset generator types
62 * This describes a single thread/process executing a fio job.
65 struct thread_options o;
67 char verror[FIO_VERROR_SIZE];
69 unsigned int thread_number;
71 struct thread_stat ts;
75 struct io_log *slat_log;
76 struct io_log *clat_log;
77 struct io_log *lat_log;
78 struct io_log *bw_log;
79 struct io_log *iops_log;
81 uint64_t stat_io_bytes[2];
82 struct timeval bw_sample_time;
84 uint64_t stat_io_blocks[2];
85 struct timeval iops_sample_time;
87 struct rusage ru_start;
90 struct fio_file **files;
91 unsigned int files_size;
92 unsigned int files_index;
93 unsigned int nr_open_files;
94 unsigned int nr_done_files;
95 unsigned int nr_normal_files;
97 unsigned int next_file;
98 os_random_state_t next_file_state;
99 struct frand_state __next_file_state;
105 size_t orig_buffer_size;
106 volatile int terminate;
107 volatile int runstate;
108 unsigned int last_was_sync;
109 enum fio_ddir last_ddir;
118 unsigned long rand_seeds[8];
121 os_random_state_t bsrange_state;
122 struct frand_state __bsrange_state;
125 os_random_state_t verify_state;
126 struct frand_state __verify_state;
129 os_random_state_t trim_state;
130 struct frand_state __trim_state;
133 struct frand_state buf_state;
135 unsigned int verify_batch;
136 unsigned int trim_batch;
141 * IO engine hooks, contains everything needed to submit an io_u
142 * to any of the available IO engines.
144 struct ioengine_ops *io_ops;
147 * Queue depth of io_u's that fio MIGHT do
149 unsigned int cur_depth;
152 * io_u's about to be committed
154 unsigned int io_u_queued;
157 * io_u's submitted but not completed yet
159 unsigned int io_u_in_flight;
162 * List of free and busy io_u's
164 struct flist_head io_u_freelist;
165 struct flist_head io_u_busylist;
166 struct flist_head io_u_requeues;
167 pthread_mutex_t io_u_lock;
168 pthread_cond_t free_cond;
171 * async verify offload
173 struct flist_head verify_list;
174 pthread_t *verify_threads;
175 unsigned int nr_verify_threads;
176 pthread_cond_t verify_cond;
177 int verify_thread_exit;
182 unsigned long long rate_bps[2];
183 long rate_pending_usleep[2];
184 unsigned long rate_bytes[2];
185 unsigned long rate_blocks[2];
186 struct timeval lastrate[2];
188 unsigned long long total_io_size;
189 unsigned long long fill_device_size;
191 unsigned long io_issues[2];
192 unsigned long long io_blocks[2];
193 unsigned long long this_io_blocks[2];
194 unsigned long long io_bytes[2];
195 unsigned long long io_skip_bytes;
196 unsigned long long this_io_bytes[2];
197 unsigned long long zone_bytes;
198 struct fio_mutex *mutex;
201 * State for random io, a bitmap of blocks done vs not done
204 os_random_state_t random_state;
205 struct frand_state __random_state;
208 struct timeval start; /* start of this loop */
209 struct timeval epoch; /* time job was started */
210 struct timeval last_issue;
211 struct timeval tv_cache;
212 unsigned int tv_cache_nr;
213 unsigned int tv_cache_mask;
214 unsigned int ramp_time_over;
217 * read/write mixed workload state
220 os_random_state_t rwmix_state;
221 struct frand_state __rwmix_state;
223 unsigned long rwmix_issues;
224 enum fio_ddir rwmix_ddir;
225 unsigned int ddir_seq_nr;
228 * IO history logs for verification. We use a tree for sorting,
229 * if we are overwriting. Otherwise just use a fifo.
231 struct rb_root io_hist_tree;
232 struct flist_head io_hist_list;
233 unsigned long io_hist_len;
238 struct flist_head io_log_list;
241 * For tracking/handling discards
243 struct flist_head trim_list;
244 unsigned long trim_entries;
247 * for fileservice, how often to switch to a new file
249 unsigned int file_service_nr;
250 unsigned int file_service_left;
251 struct fio_file *file_service_file;
253 unsigned int sync_file_range_nr;
256 * For generating file sizes
259 os_random_state_t file_size_state;
260 struct frand_state __file_size_state;
266 unsigned int total_err_count;
269 struct fio_flow *flow;
272 * Can be overloaded by profiles
274 struct prof_io_ops prof_io_ops;
281 * when should interactive ETA output be generated
289 #define __td_verror(td, err, msg, func) \
295 if (!(td)->first_error) \
296 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
300 #define td_clear_error(td) \
302 #define td_verror(td, err, func) \
303 __td_verror((td), (err), strerror((err)), (func))
304 #define td_vmsg(td, err, msg, func) \
305 __td_verror((td), (err), (msg), (func))
307 #define __fio_stringify_1(x) #x
308 #define __fio_stringify(x) __fio_stringify_1(x)
310 extern int exitall_on_terminate;
311 extern unsigned int thread_number;
314 extern int terse_output;
315 extern int temp_stall_ts;
316 extern unsigned long page_mask, page_size;
317 extern int read_only;
318 extern int eta_print;
319 extern unsigned long done_secs;
320 extern char *job_section;
321 extern int fio_gtod_offload;
322 extern int fio_gtod_cpu;
323 extern enum fio_cs fio_clock_source;
324 extern int warnings_fatal;
325 extern int terse_version;
326 extern int is_backend;
327 extern int nr_clients;
328 extern int log_syslog;
329 extern const char fio_version_string[];
330 extern const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN];
332 extern struct thread_data *threads;
334 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
336 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
339 #define BLOCKS_PER_MAP (8 * sizeof(unsigned long))
340 #define TO_MAP_BLOCK(f, b) (b)
341 #define RAND_MAP_IDX(f, b) (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
342 #define RAND_MAP_BIT(f, b) (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
344 #define REAL_MAX_JOBS 2048
346 #define td_non_fatal_error(e) ((e) == EIO || (e) == EILSEQ)
348 static inline enum error_type td_error_type(enum fio_ddir ddir, int err)
351 return ERROR_TYPE_VERIFY;
352 if (ddir == DDIR_READ)
353 return ERROR_TYPE_READ;
354 return ERROR_TYPE_WRITE;
357 static inline void update_error_count(struct thread_data *td, int err)
359 td->total_err_count++;
360 if (td->total_err_count == 1)
361 td->first_error = err;
364 static inline int should_fsync(struct thread_data *td)
366 if (td->last_was_sync)
370 if (td_write(td) || td_rw(td) || td->o.override_sync)
377 * Init/option functions
379 extern int __must_check fio_init_options(void);
380 extern int __must_check parse_options(int, char **);
381 extern int parse_jobs_ini(char *, int, int, int);
382 extern int parse_cmd_line(int, char **, int);
383 extern int fio_backend(void);
384 extern void reset_fio_state(void);
385 extern void clear_io_state(struct thread_data *);
386 extern int fio_options_parse(struct thread_data *, char **, int);
387 extern void fio_keywords_init(void);
388 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
389 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
390 extern void fio_fill_default_options(struct thread_data *);
391 extern int fio_show_option_help(const char *);
392 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
393 extern void fio_options_dup_and_init(struct option *);
394 extern void fio_options_mem_dupe(struct thread_data *);
395 extern void options_mem_dupe(void *data, struct fio_option *options);
396 extern void td_fill_rand_seeds(struct thread_data *);
397 extern void add_job_opts(const char **, int);
398 extern char *num2str(unsigned long, int, int, int);
399 extern int ioengine_load(struct thread_data *);
401 extern unsigned long page_mask;
402 extern unsigned long page_size;
403 extern int initialize_fio(char *envp[]);
405 #define FIO_GETOPT_JOB 0x89000000
406 #define FIO_GETOPT_IOENGINE 0x98000000
407 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
412 extern void print_thread_status(void);
413 extern void print_status_init(int);
414 extern char *fio_uint_to_kmg(unsigned int val);
417 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
418 * will never back again. It may cycle between running/verififying/fsyncing.
419 * Once the thread reaches TD_EXITED, it is just waiting for the core to
435 extern void td_set_runstate(struct thread_data *, int);
436 #define TERMINATE_ALL (-1)
437 extern void fio_terminate_threads(int);
442 extern int __must_check fio_pin_memory(struct thread_data *);
443 extern void fio_unpin_memory(struct thread_data *);
444 extern int __must_check allocate_io_mem(struct thread_data *);
445 extern void free_io_mem(struct thread_data *);
446 extern void free_threads_shm(void);
449 * Reset stats after ramp time completes
451 extern void reset_all_stats(struct thread_data *);
456 #ifdef FIO_HAVE_BLKTRACE
457 extern int is_blktrace(const char *);
458 extern int load_blktrace(struct thread_data *, const char *);
462 * Mark unused variables passed to ops functions as unused, to silence gcc
464 #define fio_unused __attribute((__unused__))
465 #define fio_init __attribute__((constructor))
466 #define fio_exit __attribute__((destructor))
468 #define for_each_td(td, i) \
469 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
470 #define for_each_file(td, f, i) \
471 if ((td)->files_index) \
472 for ((i) = 0, (f) = (td)->files[0]; \
473 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
476 #define fio_assert(td, cond) do { \
479 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
480 td_set_runstate((td), TD_EXITED); \
481 (td)->error = EFAULT; \
486 static inline int fio_fill_issue_time(struct thread_data *td)
488 if (td->o.read_iolog_file ||
489 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
495 static inline int __should_check_rate(struct thread_data *td,
498 struct thread_options *o = &td->o;
501 * If some rate setting was given, we need to check it
503 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
504 o->rate_iops_min[ddir])
510 static inline int should_check_rate(struct thread_data *td,
511 unsigned long *bytes_done)
516 ret |= __should_check_rate(td, 0);
518 ret |= __should_check_rate(td, 1);
523 static inline int is_power_of_2(unsigned int val)
525 return (val != 0 && ((val & (val - 1)) == 0));
529 * We currently only need to do locking if we have verifier threads
530 * accessing our internal structures too
532 static inline void td_io_u_lock(struct thread_data *td)
534 if (td->o.verify_async)
535 pthread_mutex_lock(&td->io_u_lock);
538 static inline void td_io_u_unlock(struct thread_data *td)
540 if (td->o.verify_async)
541 pthread_mutex_unlock(&td->io_u_lock);
544 static inline void td_io_u_free_notify(struct thread_data *td)
546 if (td->o.verify_async)
547 pthread_cond_signal(&td->free_cond);
550 extern const char *fio_get_arch_string(int);
551 extern const char *fio_get_os_string(int);
553 #define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))