8 #include <sys/resource.h>
19 #include "compiler/compiler.h"
20 #include "thread_options.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];
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;
109 unsigned int ioprio_set;
110 unsigned int last_was_sync;
111 enum fio_ddir last_ddir;
121 unsigned long rand_seeds[8];
124 os_random_state_t bsrange_state;
125 struct frand_state __bsrange_state;
128 os_random_state_t verify_state;
129 struct frand_state __verify_state;
132 os_random_state_t trim_state;
133 struct frand_state __trim_state;
136 struct frand_state buf_state;
138 unsigned int verify_batch;
139 unsigned int trim_batch;
144 * IO engine hooks, contains everything needed to submit an io_u
145 * to any of the available IO engines.
147 struct ioengine_ops *io_ops;
150 * Queue depth of io_u's that fio MIGHT do
152 unsigned int cur_depth;
155 * io_u's about to be committed
157 unsigned int io_u_queued;
160 * io_u's submitted but not completed yet
162 unsigned int io_u_in_flight;
165 * List of free and busy io_u's
167 struct flist_head io_u_freelist;
168 struct flist_head io_u_busylist;
169 struct flist_head io_u_requeues;
170 pthread_mutex_t io_u_lock;
171 pthread_cond_t free_cond;
174 * async verify offload
176 struct flist_head verify_list;
177 pthread_t *verify_threads;
178 unsigned int nr_verify_threads;
179 pthread_cond_t verify_cond;
180 int verify_thread_exit;
185 unsigned long long rate_bps[2];
186 long rate_pending_usleep[2];
187 unsigned long rate_bytes[2];
188 unsigned long rate_blocks[2];
189 struct timeval lastrate[2];
191 unsigned long long total_io_size;
192 unsigned long long fill_device_size;
194 unsigned long io_issues[2];
195 unsigned long long io_blocks[2];
196 unsigned long long this_io_blocks[2];
197 unsigned long long io_bytes[2];
198 unsigned long long io_skip_bytes;
199 unsigned long long this_io_bytes[2];
200 unsigned long long zone_bytes;
201 struct fio_mutex *mutex;
204 * State for random io, a bitmap of blocks done vs not done
207 os_random_state_t random_state;
208 struct frand_state __random_state;
211 struct timeval start; /* start of this loop */
212 struct timeval epoch; /* time job was started */
213 struct timeval last_issue;
214 struct timeval tv_cache;
215 unsigned int tv_cache_nr;
216 unsigned int tv_cache_mask;
217 unsigned int ramp_time_over;
220 * read/write mixed workload state
223 os_random_state_t rwmix_state;
224 struct frand_state __rwmix_state;
226 unsigned long rwmix_issues;
227 enum fio_ddir rwmix_ddir;
228 unsigned int ddir_seq_nr;
231 * IO history logs for verification. We use a tree for sorting,
232 * if we are overwriting. Otherwise just use a fifo.
234 struct rb_root io_hist_tree;
235 struct flist_head io_hist_list;
236 unsigned long io_hist_len;
241 struct flist_head io_log_list;
244 * For tracking/handling discards
246 struct flist_head trim_list;
247 unsigned long trim_entries;
250 * for fileservice, how often to switch to a new file
252 unsigned int file_service_nr;
253 unsigned int file_service_left;
254 struct fio_file *file_service_file;
256 unsigned int sync_file_range_nr;
259 * For generating file sizes
262 os_random_state_t file_size_state;
263 struct frand_state __file_size_state;
269 unsigned int total_err_count;
272 struct fio_flow *flow;
275 * Can be overloaded by profiles
277 struct prof_io_ops prof_io_ops;
282 * when should interactive ETA output be generated
290 #define __td_verror(td, err, msg, func) \
296 if (!(td)->first_error) \
297 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
301 #define td_clear_error(td) \
303 #define td_verror(td, err, func) \
304 __td_verror((td), (err), strerror((err)), (func))
305 #define td_vmsg(td, err, msg, func) \
306 __td_verror((td), (err), (msg), (func))
308 #define __fio_stringify_1(x) #x
309 #define __fio_stringify(x) __fio_stringify_1(x)
311 extern int exitall_on_terminate;
312 extern unsigned int thread_number;
313 extern unsigned int nr_process, nr_thread;
316 extern int terse_output;
317 extern int temp_stall_ts;
318 extern unsigned long long mlock_size;
319 extern unsigned long page_mask, page_size;
320 extern int read_only;
321 extern int eta_print;
322 extern unsigned long done_secs;
323 extern char *job_section;
324 extern int fio_gtod_offload;
325 extern int fio_gtod_cpu;
326 extern enum fio_cs fio_clock_source;
327 extern int warnings_fatal;
328 extern int terse_version;
329 extern int is_backend;
330 extern int nr_clients;
331 extern int log_syslog;
332 extern const char fio_version_string[];
333 extern const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN];
335 extern struct thread_data *threads;
337 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
339 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
342 #define BLOCKS_PER_MAP (8 * sizeof(unsigned long))
343 #define TO_MAP_BLOCK(f, b) (b)
344 #define RAND_MAP_IDX(f, b) (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
345 #define RAND_MAP_BIT(f, b) (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
347 #define REAL_MAX_JOBS 2048
349 #define td_non_fatal_error(e) ((e) == EIO || (e) == EILSEQ)
351 static inline enum error_type td_error_type(enum fio_ddir ddir, int err)
354 return ERROR_TYPE_VERIFY;
355 if (ddir == DDIR_READ)
356 return ERROR_TYPE_READ;
357 return ERROR_TYPE_WRITE;
360 static inline void update_error_count(struct thread_data *td, int err)
362 td->total_err_count++;
363 if (td->total_err_count == 1)
364 td->first_error = err;
367 static inline int should_fsync(struct thread_data *td)
369 if (td->last_was_sync)
373 if (td_write(td) || td_rw(td) || td->o.override_sync)
380 * Init/option functions
382 extern int __must_check fio_init_options(void);
383 extern int __must_check parse_options(int, char **);
384 extern int parse_jobs_ini(char *, int, int, int);
385 extern int parse_cmd_line(int, char **, int);
386 extern int fio_backend(void);
387 extern void reset_fio_state(void);
388 extern void clear_io_state(struct thread_data *);
389 extern int fio_options_parse(struct thread_data *, char **, int);
390 extern void fio_keywords_init(void);
391 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
392 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
393 extern void fio_fill_default_options(struct thread_data *);
394 extern int fio_show_option_help(const char *);
395 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
396 extern void fio_options_dup_and_init(struct option *);
397 extern void fio_options_mem_dupe(struct thread_data *);
398 extern void options_mem_dupe(void *data, struct fio_option *options);
399 extern void td_fill_rand_seeds(struct thread_data *);
400 extern void add_job_opts(const char **, int);
401 extern char *num2str(unsigned long, int, int, int);
402 extern int ioengine_load(struct thread_data *);
404 extern unsigned long page_mask;
405 extern unsigned long page_size;
406 extern int initialize_fio(char *envp[]);
408 #define FIO_GETOPT_JOB 0x89000000
409 #define FIO_GETOPT_IOENGINE 0x98000000
410 #define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
415 extern void print_thread_status(void);
416 extern void print_status_init(int);
419 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
420 * will never back again. It may cycle between running/verififying/fsyncing.
421 * Once the thread reaches TD_EXITED, it is just waiting for the core to
437 extern void td_set_runstate(struct thread_data *, int);
438 #define TERMINATE_ALL (-1)
439 extern void fio_terminate_threads(int);
444 extern int __must_check fio_pin_memory(void);
445 extern void fio_unpin_memory(void);
446 extern int __must_check allocate_io_mem(struct thread_data *);
447 extern void free_io_mem(struct thread_data *);
450 * Reset stats after ramp time completes
452 extern void reset_all_stats(struct thread_data *);
457 #ifdef FIO_HAVE_BLKTRACE
458 extern int is_blktrace(const char *);
459 extern int load_blktrace(struct thread_data *, const char *);
463 * Mark unused variables passed to ops functions as unused, to silence gcc
465 #define fio_unused __attribute((__unused__))
466 #define fio_init __attribute__((constructor))
467 #define fio_exit __attribute__((destructor))
469 #define for_each_td(td, i) \
470 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
471 #define for_each_file(td, f, i) \
472 if ((td)->files_index) \
473 for ((i) = 0, (f) = (td)->files[0]; \
474 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
477 #define fio_assert(td, cond) do { \
480 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
481 td_set_runstate((td), TD_EXITED); \
482 (td)->error = EFAULT; \
487 static inline int fio_fill_issue_time(struct thread_data *td)
489 if (td->o.read_iolog_file ||
490 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
496 static inline int __should_check_rate(struct thread_data *td,
499 struct thread_options *o = &td->o;
502 * If some rate setting was given, we need to check it
504 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
505 o->rate_iops_min[ddir])
511 static inline int should_check_rate(struct thread_data *td,
512 unsigned long *bytes_done)
517 ret |= __should_check_rate(td, 0);
519 ret |= __should_check_rate(td, 1);
524 static inline int is_power_of_2(unsigned int val)
526 return (val != 0 && ((val & (val - 1)) == 0));
530 * We currently only need to do locking if we have verifier threads
531 * accessing our internal structures too
533 static inline void td_io_u_lock(struct thread_data *td)
535 if (td->o.verify_async)
536 pthread_mutex_lock(&td->io_u_lock);
539 static inline void td_io_u_unlock(struct thread_data *td)
541 if (td->o.verify_async)
542 pthread_mutex_unlock(&td->io_u_lock);
545 static inline void td_io_u_free_notify(struct thread_data *td)
547 if (td->o.verify_async)
548 pthread_cond_signal(&td->free_cond);
551 extern const char *fio_get_arch_string(int);
552 extern const char *fio_get_os_string(int);