projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Kill off -Wshadow again
[fio.git] / fio.h
... / ...
CommitLineData
1#ifndef FIO_H
2#define FIO_H
3
4#include <sched.h>
5#include <limits.h>
6#include <pthread.h>
7#include <sys/time.h>
8#include <sys/resource.h>
9#include <errno.h>
10#include <stdlib.h>
11#include <stdio.h>
12#include <unistd.h>
13#include <string.h>
14#include <inttypes.h>
15#include <assert.h>
16
17#include "compiler/compiler.h"
18#include "thread_options.h"
19#include "flist.h"
20#include "fifo.h"
21#include "arch/arch.h"
22#include "os/os.h"
23#include "mutex.h"
24#include "log.h"
25#include "debug.h"
26#include "file.h"
27#include "io_ddir.h"
28#include "ioengine.h"
29#include "iolog.h"
30#include "helpers.h"
31#include "options.h"
32#include "profile.h"
33#include "fio_time.h"
34#include "gettime.h"
35#include "lib/getopt.h"
36#include "lib/rand.h"
37#include "lib/rbtree.h"
38#include "client.h"
39#include "server.h"
40#include "stat.h"
41#include "flow.h"
42#include "io_u_queue.h"
43
44#ifdef CONFIG_SOLARISAIO
45#include <sys/asynch.h>
46#endif
47
48#ifdef CONFIG_LIBNUMA
49#include <linux/mempolicy.h>
50#include <numa.h>
51
52/*
53 * "local" is pseudo-policy
54 */
55#define MPOL_LOCAL MPOL_MAX
56#endif
57
58/*
59 * offset generator types
60 */
61enum {
62 RW_SEQ_SEQ = 0,
63 RW_SEQ_IDENT,
64};
65
66enum {
67 TD_F_VER_BACKLOG = 1,
68 TD_F_TRIM_BACKLOG = 2,
69 TD_F_READ_IOLOG = 4,
70 TD_F_REFILL_BUFFERS = 8,
71 TD_F_SCRAMBLE_BUFFERS = 16,
72 TD_F_VER_NONE = 32,
73 TD_F_PROFILE_OPS = 64,
74 TD_F_COMPRESS = 128,
75 TD_F_NOIO = 256,
76 TD_F_COMPRESS_LOG = 512,
77 TD_F_VSTATE_SAVED = 1024,
78};
79
80enum {
81 FIO_RAND_BS_OFF = 0,
82 FIO_RAND_VER_OFF,
83 FIO_RAND_MIX_OFF,
84 FIO_RAND_FILE_OFF,
85 FIO_RAND_BLOCK_OFF,
86 FIO_RAND_FILE_SIZE_OFF,
87 FIO_RAND_TRIM_OFF,
88 FIO_RAND_BUF_OFF,
89 FIO_RAND_SEQ_RAND_READ_OFF,
90 FIO_RAND_SEQ_RAND_WRITE_OFF,
91 FIO_RAND_SEQ_RAND_TRIM_OFF,
92 FIO_RAND_START_DELAY,
93 FIO_DEDUPE_OFF,
94 FIO_RAND_NR_OFFS,
95};
96
97/*
98 * This describes a single thread/process executing a fio job.
99 */
100struct thread_data {
101 struct thread_options o;
102 unsigned long flags;
103 void *eo;
104 char verror[FIO_VERROR_SIZE];
105 pthread_t thread;
106 unsigned int thread_number;
107 unsigned int subjob_number;
108 unsigned int groupid;
109 struct thread_stat ts;
110
111 int client_type;
112
113 struct io_log *slat_log;
114 struct io_log *clat_log;
115 struct io_log *lat_log;
116 struct io_log *bw_log;
117 struct io_log *iops_log;
118
119 struct tp_data *tp_data;
120
121 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
122 struct timeval bw_sample_time;
123
124 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
125 struct timeval iops_sample_time;
126
127 /*
128 * Tracks the last iodepth number of completed writes, if data
129 * verification is enabled
130 */
131 uint64_t *last_write_comp;
132 unsigned int last_write_idx;
133
134 volatile int update_rusage;
135 struct fio_mutex *rusage_sem;
136 struct rusage ru_start;
137 struct rusage ru_end;
138
139 struct fio_file **files;
140 unsigned char *file_locks;
141 unsigned int files_size;
142 unsigned int files_index;
143 unsigned int nr_open_files;
144 unsigned int nr_done_files;
145 unsigned int nr_normal_files;
146 union {
147 unsigned int next_file;
148 struct frand_state next_file_state;
149 };
150 int error;
151 int sig;
152 int done;
153 int stop_io;
154 pid_t pid;
155 char *orig_buffer;
156 size_t orig_buffer_size;
157 volatile int terminate;
158 volatile int runstate;
159 unsigned int last_was_sync;
160 enum fio_ddir last_ddir;
161
162 int mmapfd;
163
164 void *iolog_buf;
165 FILE *iolog_f;
166
167 char *sysfs_root;
168
169 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
170
171 struct frand_state bsrange_state;
172 struct frand_state verify_state;
173 struct frand_state trim_state;
174 struct frand_state delay_state;
175
176 struct frand_state buf_state;
177 struct frand_state buf_state_prev;
178 struct frand_state dedupe_state;
179
180 unsigned int verify_batch;
181 unsigned int trim_batch;
182
183 struct thread_io_list *vstate;
184
185 int shm_id;
186
187 /*
188 * IO engine hooks, contains everything needed to submit an io_u
189 * to any of the available IO engines.
190 */
191 struct ioengine_ops *io_ops;
192
193 /*
194 * Queue depth of io_u's that fio MIGHT do
195 */
196 unsigned int cur_depth;
197
198 /*
199 * io_u's about to be committed
200 */
201 unsigned int io_u_queued;
202
203 /*
204 * io_u's submitted but not completed yet
205 */
206 unsigned int io_u_in_flight;
207
208 /*
209 * List of free and busy io_u's
210 */
211 struct io_u_ring io_u_requeues;
212 struct io_u_queue io_u_freelist;
213 struct io_u_queue io_u_all;
214 pthread_mutex_t io_u_lock;
215 pthread_cond_t free_cond;
216
217 /*
218 * async verify offload
219 */
220 struct flist_head verify_list;
221 pthread_t *verify_threads;
222 unsigned int nr_verify_threads;
223 pthread_cond_t verify_cond;
224 int verify_thread_exit;
225
226 /*
227 * Rate state
228 */
229 uint64_t rate_bps[DDIR_RWDIR_CNT];
230 long rate_pending_usleep[DDIR_RWDIR_CNT];
231 unsigned long rate_bytes[DDIR_RWDIR_CNT];
232 unsigned long rate_blocks[DDIR_RWDIR_CNT];
233 struct timeval lastrate[DDIR_RWDIR_CNT];
234
235 uint64_t total_io_size;
236 uint64_t fill_device_size;
237
238 uint64_t io_issues[DDIR_RWDIR_CNT];
239 uint64_t io_blocks[DDIR_RWDIR_CNT];
240 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
241 uint64_t io_bytes[DDIR_RWDIR_CNT];
242 uint64_t io_skip_bytes;
243 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
244 uint64_t zone_bytes;
245 struct fio_mutex *mutex;
246
247 /*
248 * State for random io, a bitmap of blocks done vs not done
249 */
250 struct frand_state random_state;
251
252 struct timeval start; /* start of this loop */
253 struct timeval epoch; /* time job was started */
254 struct timeval last_issue;
255 struct timeval tv_cache;
256 struct timeval terminate_time;
257 unsigned int tv_cache_nr;
258 unsigned int tv_cache_mask;
259 unsigned int ramp_time_over;
260
261 /*
262 * Time since last latency_window was started
263 */
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;
270 int latency_end_run;
271
272 /*
273 * read/write mixed workload state
274 */
275 struct frand_state rwmix_state;
276 unsigned long rwmix_issues;
277 enum fio_ddir rwmix_ddir;
278 unsigned int ddir_seq_nr;
279
280 /*
281 * rand/seq mixed workload state
282 */
283 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
284
285 /*
286 * IO history logs for verification. We use a tree for sorting,
287 * if we are overwriting. Otherwise just use a fifo.
288 */
289 struct rb_root io_hist_tree;
290 struct flist_head io_hist_list;
291 unsigned long io_hist_len;
292
293 /*
294 * For IO replaying
295 */
296 struct flist_head io_log_list;
297
298 /*
299 * For tracking/handling discards
300 */
301 struct flist_head trim_list;
302 unsigned long trim_entries;
303
304 struct flist_head next_rand_list;
305
306 /*
307 * for fileservice, how often to switch to a new file
308 */
309 unsigned int file_service_nr;
310 unsigned int file_service_left;
311 struct fio_file *file_service_file;
312
313 unsigned int sync_file_range_nr;
314
315 /*
316 * For generating file sizes
317 */
318 struct frand_state file_size_state;
319
320 /*
321 * Error counts
322 */
323 unsigned int total_err_count;
324 int first_error;
325
326 struct fio_flow *flow;
327
328 /*
329 * Can be overloaded by profiles
330 */
331 struct prof_io_ops prof_io_ops;
332 void *prof_data;
333
334 void *pinned_mem;
335};
336
337/*
338 * when should interactive ETA output be generated
339 */
340enum {
341 FIO_ETA_AUTO,
342 FIO_ETA_ALWAYS,
343 FIO_ETA_NEVER,
344};
345
346#define __td_verror(td, err, msg, func) \
347 do { \
348 unsigned int ____e = (err); \
349 if ((td)->error) \
350 break; \
351 (td)->error = ____e; \
352 if (!(td)->first_error) \
353 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
354 } while (0)
355
356
357#define td_clear_error(td) \
358 (td)->error = 0;
359#define td_verror(td, err, func) \
360 __td_verror((td), (err), strerror((err)), (func))
361#define td_vmsg(td, err, msg, func) \
362 __td_verror((td), (err), (msg), (func))
363
364#define __fio_stringify_1(x) #x
365#define __fio_stringify(x) __fio_stringify_1(x)
366
367extern int exitall_on_terminate;
368extern unsigned int thread_number;
369extern unsigned int stat_number;
370extern int shm_id;
371extern int groupid;
372extern int output_format;
373extern int append_terse_output;
374extern int temp_stall_ts;
375extern uintptr_t page_mask, page_size;
376extern int read_only;
377extern int eta_print;
378extern int eta_new_line;
379extern unsigned long done_secs;
380extern char *job_section;
381extern int fio_gtod_offload;
382extern int fio_gtod_cpu;
383extern enum fio_cs fio_clock_source;
384extern int fio_clock_source_set;
385extern int warnings_fatal;
386extern int terse_version;
387extern int is_backend;
388extern int nr_clients;
389extern int log_syslog;
390extern int status_interval;
391extern const char fio_version_string[];
392extern int helper_do_stat;
393extern pthread_cond_t helper_cond;
394extern char *trigger_file;
395extern char *trigger_cmd;
396extern long long trigger_timeout;
397
398extern struct thread_data *threads;
399
400static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
401{
402 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
403}
404
405#define REAL_MAX_JOBS 2048
406
407static inline int should_fsync(struct thread_data *td)
408{
409 if (td->last_was_sync)
410 return 0;
411 if (td_write(td) || td_rw(td) || td->o.override_sync)
412 return 1;
413
414 return 0;
415}
416
417/*
418 * Init/option functions
419 */
420extern int __must_check fio_init_options(void);
421extern int __must_check parse_options(int, char **);
422extern int parse_jobs_ini(char *, int, int, int);
423extern int parse_cmd_line(int, char **, int);
424extern int fio_backend(void);
425extern void reset_fio_state(void);
426extern void clear_io_state(struct thread_data *);
427extern int fio_options_parse(struct thread_data *, char **, int, int);
428extern void fio_keywords_init(void);
429extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
430extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
431extern void fio_fill_default_options(struct thread_data *);
432extern int fio_show_option_help(const char *);
433extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
434extern void fio_options_dup_and_init(struct option *);
435extern void fio_options_mem_dupe(struct thread_data *);
436extern void options_mem_dupe(void *data, struct fio_option *options);
437extern void td_fill_rand_seeds(struct thread_data *);
438extern void add_job_opts(const char **, int);
439extern char *num2str(uint64_t, int, int, int, int);
440extern int ioengine_load(struct thread_data *);
441extern int parse_dryrun(void);
442extern int fio_running_or_pending_io_threads(void);
443extern int fio_set_fd_nonblocking(int, const char *);
444
445extern uintptr_t page_mask;
446extern uintptr_t page_size;
447extern int initialize_fio(char *envp[]);
448
449#define FIO_GETOPT_JOB 0x89000000
450#define FIO_GETOPT_IOENGINE 0x98000000
451#define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
452
453/*
454 * ETA/status stuff
455 */
456extern void print_thread_status(void);
457extern void print_status_init(int);
458extern char *fio_uint_to_kmg(unsigned int val);
459
460/*
461 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
462 * will never back again. It may cycle between running/verififying/fsyncing.
463 * Once the thread reaches TD_EXITED, it is just waiting for the core to
464 * reap it.
465 */
466enum {
467 TD_NOT_CREATED = 0,
468 TD_CREATED,
469 TD_INITIALIZED,
470 TD_RAMP,
471 TD_SETTING_UP,
472 TD_RUNNING,
473 TD_PRE_READING,
474 TD_VERIFYING,
475 TD_FSYNCING,
476 TD_FINISHING,
477 TD_EXITED,
478 TD_REAPED,
479};
480
481extern void td_set_runstate(struct thread_data *, int);
482extern int td_bump_runstate(struct thread_data *, int);
483extern void td_restore_runstate(struct thread_data *, int);
484
485/*
486 * Allow 60 seconds for a job to quit on its own, otherwise reap with
487 * a vengeance.
488 */
489#define FIO_REAP_TIMEOUT 60
490
491#define TERMINATE_ALL (-1)
492extern void fio_terminate_threads(int);
493extern void fio_mark_td_terminate(struct thread_data *);
494
495/*
496 * Memory helpers
497 */
498extern int __must_check fio_pin_memory(struct thread_data *);
499extern void fio_unpin_memory(struct thread_data *);
500extern int __must_check allocate_io_mem(struct thread_data *);
501extern void free_io_mem(struct thread_data *);
502extern void free_threads_shm(void);
503
504/*
505 * Reset stats after ramp time completes
506 */
507extern void reset_all_stats(struct thread_data *);
508
509/*
510 * blktrace support
511 */
512#ifdef FIO_HAVE_BLKTRACE
513extern int is_blktrace(const char *, int *);
514extern int load_blktrace(struct thread_data *, const char *, int);
515#endif
516
517/*
518 * Latency target helpers
519 */
520extern void lat_target_check(struct thread_data *);
521extern void lat_target_init(struct thread_data *);
522extern void lat_target_reset(struct thread_data *);
523
524#define for_each_td(td, i) \
525 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
526#define for_each_file(td, f, i) \
527 if ((td)->files_index) \
528 for ((i) = 0, (f) = (td)->files[0]; \
529 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
530 (i)++)
531
532#define fio_assert(td, cond) do { \
533 if (!(cond)) { \
534 int *__foo = NULL; \
535 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
536 td_set_runstate((td), TD_EXITED); \
537 (td)->error = EFAULT; \
538 *__foo = 0; \
539 } \
540} while (0)
541
542static inline int fio_fill_issue_time(struct thread_data *td)
543{
544 if (td->o.read_iolog_file ||
545 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
546 return 1;
547
548 return 0;
549}
550
551static inline int __should_check_rate(struct thread_data *td,
552 enum fio_ddir ddir)
553{
554 struct thread_options *o = &td->o;
555
556 /*
557 * If some rate setting was given, we need to check it
558 */
559 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
560 o->rate_iops_min[ddir])
561 return 1;
562
563 return 0;
564}
565
566static inline int should_check_rate(struct thread_data *td,
567 uint64_t *bytes_done)
568{
569 int ret = 0;
570
571 if (bytes_done[DDIR_READ])
572 ret |= __should_check_rate(td, DDIR_READ);
573 if (bytes_done[DDIR_WRITE])
574 ret |= __should_check_rate(td, DDIR_WRITE);
575 if (bytes_done[DDIR_TRIM])
576 ret |= __should_check_rate(td, DDIR_TRIM);
577
578 return ret;
579}
580
581static inline unsigned int td_max_bs(struct thread_data *td)
582{
583 unsigned int max_bs;
584
585 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
586 return max(td->o.max_bs[DDIR_TRIM], max_bs);
587}
588
589static inline unsigned int td_min_bs(struct thread_data *td)
590{
591 unsigned int min_bs;
592
593 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
594 return min(td->o.min_bs[DDIR_TRIM], min_bs);
595}
596
597static inline int is_power_of_2(uint64_t val)
598{
599 return (val != 0 && ((val & (val - 1)) == 0));
600}
601
602/*
603 * We currently only need to do locking if we have verifier threads
604 * accessing our internal structures too
605 */
606static inline void td_io_u_lock(struct thread_data *td)
607{
608 if (td->o.verify_async)
609 pthread_mutex_lock(&td->io_u_lock);
610}
611
612static inline void td_io_u_unlock(struct thread_data *td)
613{
614 if (td->o.verify_async)
615 pthread_mutex_unlock(&td->io_u_lock);
616}
617
618static inline void td_io_u_free_notify(struct thread_data *td)
619{
620 if (td->o.verify_async)
621 pthread_cond_signal(&td->free_cond);
622}
623
624extern const char *fio_get_arch_string(int);
625extern const char *fio_get_os_string(int);
626
627#ifdef FIO_INTERNAL
628#define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
629#endif
630
631enum {
632 FIO_OUTPUT_TERSE = 0,
633 FIO_OUTPUT_JSON,
634 FIO_OUTPUT_NORMAL,
635};
636
637enum {
638 FIO_RAND_DIST_RANDOM = 0,
639 FIO_RAND_DIST_ZIPF,
640 FIO_RAND_DIST_PARETO,
641};
642
643enum {
644 FIO_RAND_GEN_TAUSWORTHE = 0,
645 FIO_RAND_GEN_LFSR,
646};
647
648enum {
649 FIO_CPUS_SHARED = 0,
650 FIO_CPUS_SPLIT,
651};
652
653extern void exec_trigger(const char *);
654extern void check_trigger_file(void);
655
656#endif
fio - Flexible IO Tester