parse: don't print min/max option ranges if posval[] is set
[fio.git] / fio.h
CommitLineData
ebac4655
JA
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>
3c39a379
JA
9#include <errno.h>
10#include <stdlib.h>
11#include <stdio.h>
6d6f031f 12#include <unistd.h>
34cfcdaf 13#include <string.h>
cd14cc10 14#include <inttypes.h>
7101d9c2 15#include <assert.h>
ebac4655 16
ecc314ba
BC
17struct thread_data;
18
317b95d0 19#include "compiler/compiler.h"
01743ee1 20#include "flist.h"
e2887563 21#include "fifo.h"
4b87898e 22#include "rbtree.h"
317b95d0
JA
23#include "arch/arch.h"
24#include "os/os.h"
07739b57 25#include "mutex.h"
a3d741fa
JA
26#include "log.h"
27#include "debug.h"
d6aed795
JA
28#include "file.h"
29#include "io_ddir.h"
dcefb588 30#include "ioengine.h"
5995a6a4 31#include "iolog.h"
c5c8bd5c 32#include "helpers.h"
07b3232d 33#include "options.h"
7eb36574 34#include "profile.h"
c223da83 35#include "time.h"
a7346816 36#include "gettime.h"
bf2e821a 37#include "lib/getopt.h"
2615cc4b 38#include "lib/rand.h"
37db14fe 39#include "server.h"
a64e88da 40#include "stat.h"
9e684a49 41#include "flow.h"
ebac4655 42
4700b234 43#ifdef CONFIG_SOLARISAIO
417f0068
JA
44#include <sys/asynch.h>
45#endif
46
67bf9823 47#ifdef CONFIG_LIBNUMA
d0b937ed
YR
48#include <linux/mempolicy.h>
49#include <numa.h>
50
51/*
52 * "local" is pseudo-policy
53 */
54#define MPOL_LOCAL MPOL_MAX
55#endif
56
e9c047a0
JA
57/*
58 * What type of allocation to use for io buffers
59 */
60enum fio_memtype {
61 MEM_MALLOC = 0, /* ordinary malloc */
62 MEM_SHM, /* use shared memory segments */
74b025b0 63 MEM_SHMHUGE, /* use shared memory segments with huge pages */
e9c047a0 64 MEM_MMAP, /* use anonynomous mmap */
d0bdaf49 65 MEM_MMAPHUGE, /* memory mapped huge file */
e9c047a0
JA
66};
67
38dad62d
JA
68/*
69 * offset generator types
70 */
71enum {
72 RW_SEQ_SEQ = 0,
73 RW_SEQ_IDENT,
74};
75
06842027
SL
76/*
77 * What type of errors to continue on when continue_on_error is used
78 */
8b28bd41
DM
79enum error_type_bit {
80 ERROR_TYPE_READ_BIT = 0,
81 ERROR_TYPE_WRITE_BIT = 1,
82 ERROR_TYPE_VERIFY_BIT = 2,
83 ERROR_TYPE_CNT = 3,
84};
85
06842027
SL
86enum error_type {
87 ERROR_TYPE_NONE = 0,
8b28bd41
DM
88 ERROR_TYPE_READ = 1 << ERROR_TYPE_READ_BIT,
89 ERROR_TYPE_WRITE = 1 << ERROR_TYPE_WRITE_BIT,
90 ERROR_TYPE_VERIFY = 1 << ERROR_TYPE_VERIFY_BIT,
06842027
SL
91 ERROR_TYPE_ANY = 0xffff,
92};
93
564ca972
JA
94struct bssplit {
95 unsigned int bs;
96 unsigned char perc;
97};
98
2dc1bbeb 99struct thread_options {
b1ec1da6 100 int pad;
61697c37 101 char *description;
b4692828 102 char *name;
ef899b63 103 char *directory;
13f8e2d2 104 char *filename;
de98bd30 105 char *filename_format;
2dc1bbeb 106 char *opendir;
09629a90 107 char *ioengine;
413dd459 108 enum td_ddir td_ddir;
38dad62d 109 unsigned int rw_seq;
90fef2d1 110 unsigned int kb_base;
ad705bcb 111 unsigned int unit_base;
5736c10d 112 unsigned int ddir_seq_nr;
a66da7a2 113 long ddir_seq_add;
2dc1bbeb
JA
114 unsigned int iodepth;
115 unsigned int iodepth_low;
116 unsigned int iodepth_batch;
4950421a 117 unsigned int iodepth_batch_complete;
2dc1bbeb
JA
118
119 unsigned long long size;
7bb59102 120 unsigned int size_percent;
aa31f1f1 121 unsigned int fill_device;
2dc1bbeb
JA
122 unsigned long long file_size_low;
123 unsigned long long file_size_high;
124 unsigned long long start_offset;
125
6eaf09d6
SL
126 unsigned int bs[DDIR_RWDIR_CNT];
127 unsigned int ba[DDIR_RWDIR_CNT];
128 unsigned int min_bs[DDIR_RWDIR_CNT];
129 unsigned int max_bs[DDIR_RWDIR_CNT];
130 struct bssplit *bssplit[DDIR_RWDIR_CNT];
131 unsigned int bssplit_nr[DDIR_RWDIR_CNT];
2dc1bbeb 132
8b28bd41
DM
133 int *ignore_error[ERROR_TYPE_CNT];
134 unsigned int ignore_error_nr[ERROR_TYPE_CNT];
135 unsigned int error_dump;
136
2dc1bbeb
JA
137 unsigned int nr_files;
138 unsigned int open_files;
4d4e80f2 139 enum file_lock_mode file_lock_mode;
e9c047a0 140
9158d2f7
JA
141 unsigned int odirect;
142 unsigned int invalidate_cache;
143 unsigned int create_serialize;
144 unsigned int create_fsync;
814452bd 145 unsigned int create_on_open;
25460cf6 146 unsigned int create_only;
9158d2f7 147 unsigned int end_fsync;
afad68f7 148 unsigned int pre_read;
9158d2f7
JA
149 unsigned int sync_io;
150 unsigned int verify;
e84c73a8 151 unsigned int do_verify;
160b966d 152 unsigned int verifysort;
1ae83d45 153 unsigned int verifysort_nr;
a59e170d
JA
154 unsigned int verify_interval;
155 unsigned int verify_offset;
0e92f873 156 char verify_pattern[MAX_PATTERN_SIZE];
90059d65 157 unsigned int verify_pattern_bytes;
a12a3b4d 158 unsigned int verify_fatal;
b463e936 159 unsigned int verify_dump;
e8462bd8 160 unsigned int verify_async;
9e144189
JA
161 unsigned long long verify_backlog;
162 unsigned int verify_batch;
44cbc6da 163 unsigned int experimental_verify;
9158d2f7
JA
164 unsigned int use_thread;
165 unsigned int unlink;
166 unsigned int do_disk_util;
167 unsigned int override_sync;
168 unsigned int rand_repeatable;
2615cc4b 169 unsigned int use_os_rand;
9158d2f7
JA
170 unsigned int write_lat_log;
171 unsigned int write_bw_log;
c8eeb9df 172 unsigned int write_iops_log;
b8bc8cba 173 unsigned int log_avg_msec;
bb8895e0 174 unsigned int norandommap;
2b386d25 175 unsigned int softrandommap;
690adba3 176 unsigned int bs_unaligned;
ebb1415f 177 unsigned int fsync_on_close;
e9c047a0 178
e25839d4
JA
179 unsigned int random_distribution;
180 double zipf_theta;
925fee33 181 double pareto_h;
e25839d4 182
8055e41d
JA
183 unsigned int random_generator;
184
56bb17f2 185 unsigned int hugepage_size;
a00735e6 186 unsigned int rw_min_bs;
ebac4655 187 unsigned int thinktime;
48097d5c 188 unsigned int thinktime_spin;
9c1f7434 189 unsigned int thinktime_blocks;
ebac4655 190 unsigned int fsync_blocks;
5f9099ea 191 unsigned int fdatasync_blocks;
1ef2b6be 192 unsigned int barrier_blocks;
dce8b847 193 unsigned long long start_delay;
0db26797 194 unsigned long long timeout;
721938ae 195 unsigned long long ramp_time;
ebac4655 196 unsigned int overwrite;
ebac4655 197 unsigned int bw_avg_time;
c8eeb9df 198 unsigned int iops_avg_time;
ebac4655 199 unsigned int loops;
ed335855 200 unsigned long long zone_range;
20dc95c4
JA
201 unsigned long long zone_size;
202 unsigned long long zone_skip;
e9c047a0 203 enum fio_memtype mem_type;
d529ee19 204 unsigned int mem_align;
2dc1bbeb 205
15501535
JA
206 unsigned int max_latency;
207
ebac4655 208 unsigned int stonewall;
b3d62a75 209 unsigned int new_group;
ebac4655 210 unsigned int numjobs;
ebac4655 211 os_cpu_mask_t cpumask;
375b2695 212 unsigned int cpumask_set;
e8462bd8
JA
213 os_cpu_mask_t verify_cpumask;
214 unsigned int verify_cpumask_set;
67bf9823 215#ifdef CONFIG_LIBNUMA
d0b937ed
YR
216 struct bitmask *numa_cpunodesmask;
217 unsigned int numa_cpumask_set;
218 unsigned short numa_mem_mode;
219 unsigned int numa_mem_prefer_node;
220 struct bitmask *numa_memnodesmask;
221 unsigned int numa_memmask_set;
222#endif
aea47d44 223 unsigned int iolog;
a6ccc7be 224 unsigned int rwmixcycle;
e47f799f 225 unsigned int rwmix[2];
b6f4d880 226 unsigned int nice;
0aabe160 227 unsigned int file_service_type;
b2560f3c 228 unsigned int group_reporting;
d2f3ac35 229 unsigned int fadvise_hint;
a596f047 230 enum fio_fallocate_mode fallocate_mode;
e9459e5a 231 unsigned int zero_buffers;
5973cafb 232 unsigned int refill_buffers;
fd68418e 233 unsigned int scramble_buffers;
9c42684e 234 unsigned int compress_percentage;
f97a43a1 235 unsigned int compress_chunk;
cf4464ca 236 unsigned int time_based;
02af0988 237 unsigned int disable_lat;
9520ebb9
JA
238 unsigned int disable_clat;
239 unsigned int disable_slat;
240 unsigned int disable_bw;
771e58be 241 unsigned int unified_rw_rep;
993bf48b 242 unsigned int gtod_reduce;
be4ecfdf
JA
243 unsigned int gtod_cpu;
244 unsigned int gtod_offload;
c223da83 245 enum fio_cs clocksource;
64bbb865 246 unsigned int no_stall;
0d29de83
JA
247 unsigned int trim_percentage;
248 unsigned int trim_batch;
249 unsigned int trim_zero;
250 unsigned long long trim_backlog;
83349190 251 unsigned int clat_percentiles;
435d195a 252 unsigned int percentile_precision; /* digits after decimal for percentiles */
802ad4a8 253 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
aea47d44 254
076efc7c
JA
255 char *read_iolog_file;
256 char *write_iolog_file;
e3cedca7
JA
257 char *bw_log_file;
258 char *lat_log_file;
c8eeb9df 259 char *iops_log_file;
d1c46c04 260 char *replay_redirect;
2dc1bbeb
JA
261
262 /*
263 * Pre-run and post-run shell
264 */
265 char *exec_prerun;
266 char *exec_postrun;
267
6eaf09d6
SL
268 unsigned int rate[DDIR_RWDIR_CNT];
269 unsigned int ratemin[DDIR_RWDIR_CNT];
2dc1bbeb 270 unsigned int ratecycle;
6eaf09d6
SL
271 unsigned int rate_iops[DDIR_RWDIR_CNT];
272 unsigned int rate_iops_min[DDIR_RWDIR_CNT];
2dc1bbeb
JA
273
274 char *ioscheduler;
275
276 /*
277 * CPU "io" cycle burner
278 */
279 unsigned int cpuload;
280 unsigned int cpucycle;
f2bba182
RR
281
282 /*
283 * I/O Error handling
284 */
06842027 285 enum error_type continue_on_error;
9ac8a797
JA
286
287 /*
288 * Benchmark profile type
289 */
79d16311 290 char *profile;
a696fa2a
JA
291
292 /*
293 * blkio cgroup support
294 */
a696fa2a
JA
295 char *cgroup;
296 unsigned int cgroup_weight;
7de87099 297 unsigned int cgroup_nodelete;
e0b0d892
JA
298
299 unsigned int uid;
300 unsigned int gid;
44f29692 301
9e684a49
DE
302 int flow_id;
303 int flow;
304 int flow_watermark;
305 unsigned int flow_sleep;
306
214ac7e0
DE
307 unsigned long long offset_increment;
308
44f29692 309 unsigned int sync_file_range;
2dc1bbeb
JA
310};
311
d72be545
JA
312enum {
313 TD_F_VER_BACKLOG = 1,
314 TD_F_TRIM_BACKLOG = 2,
315 TD_F_READ_IOLOG = 4,
316 TD_F_REFILL_BUFFERS = 8,
317 TD_F_SCRAMBLE_BUFFERS = 16,
318 TD_F_VER_NONE = 32,
319 TD_F_PROFILE_OPS = 64,
320};
321
d24945f0
JA
322enum {
323 FIO_RAND_BS_OFF = 0,
324 FIO_RAND_VER_OFF,
325 FIO_RAND_MIX_OFF,
326 FIO_RAND_FILE_OFF,
327 FIO_RAND_BLOCK_OFF,
328 FIO_RAND_FILE_SIZE_OFF,
329 FIO_RAND_TRIM_OFF,
330 FIO_RAND_BUF_OFF,
331 FIO_RAND_NR_OFFS,
332};
333
2dc1bbeb
JA
334/*
335 * This describes a single thread/process executing a fio job.
336 */
337struct thread_data {
338 struct thread_options o;
d72be545 339 unsigned long flags;
de890a1e 340 void *eo;
e4e33258 341 char verror[FIO_VERROR_SIZE];
2dc1bbeb
JA
342 pthread_t thread;
343 int thread_number;
344 int groupid;
345 struct thread_stat ts;
7b9f733a
JA
346
347 struct io_log *slat_log;
348 struct io_log *clat_log;
349 struct io_log *lat_log;
350 struct io_log *bw_log;
c8eeb9df 351 struct io_log *iops_log;
7b9f733a 352
6eaf09d6 353 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
c8eeb9df
JA
354 struct timeval bw_sample_time;
355
6eaf09d6 356 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
c8eeb9df 357 struct timeval iops_sample_time;
f0505a14 358
c97f1ad6
JA
359 volatile int update_rusage;
360 struct fio_mutex *rusage_sem;
c8aaba19
JA
361 struct rusage ru_start;
362 struct rusage ru_end;
363
126d65c6 364 struct fio_file **files;
d7df1d13 365 unsigned char *file_locks;
dd87b2c9 366 unsigned int files_size;
2dc1bbeb
JA
367 unsigned int files_index;
368 unsigned int nr_open_files;
1020a139 369 unsigned int nr_done_files;
2dc1bbeb
JA
370 unsigned int nr_normal_files;
371 union {
372 unsigned int next_file;
373 os_random_state_t next_file_state;
4c07ad86 374 struct frand_state __next_file_state;
2dc1bbeb
JA
375 };
376 int error;
a5e371a6 377 int sig;
20e354ef 378 int done;
2dc1bbeb
JA
379 pid_t pid;
380 char *orig_buffer;
381 size_t orig_buffer_size;
382 volatile int terminate;
383 volatile int runstate;
384 unsigned int ioprio;
ac684785 385 unsigned int ioprio_set;
2dc1bbeb 386 unsigned int last_was_sync;
9e144189 387 enum fio_ddir last_ddir;
2dc1bbeb
JA
388
389 char *mmapfile;
390 int mmapfd;
391
843a7413
JA
392 void *iolog_buf;
393 FILE *iolog_f;
ebac4655 394
da86774e 395 char *sysfs_root;
da86774e 396
d24945f0 397 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
5bfc35d7 398
4c07ad86
JA
399 union {
400 os_random_state_t bsrange_state;
401 struct frand_state __bsrange_state;
402 };
403 union {
404 os_random_state_t verify_state;
405 struct frand_state __verify_state;
406 };
407 union {
408 os_random_state_t trim_state;
409 struct frand_state __trim_state;
410 };
ebac4655 411
3545a109
JA
412 struct frand_state buf_state;
413
9e144189 414 unsigned int verify_batch;
0d29de83 415 unsigned int trim_batch;
9e144189 416
ebac4655
JA
417 int shm_id;
418
e9c047a0
JA
419 /*
420 * IO engine hooks, contains everything needed to submit an io_u
421 * to any of the available IO engines.
422 */
2866c82d 423 struct ioengine_ops *io_ops;
ebac4655 424
e9c047a0 425 /*
422f9e4b 426 * Queue depth of io_u's that fio MIGHT do
e9c047a0 427 */
ebac4655 428 unsigned int cur_depth;
422f9e4b
RM
429
430 /*
431 * io_u's about to be committed
432 */
d8005759 433 unsigned int io_u_queued;
422f9e4b
RM
434
435 /*
436 * io_u's submitted but not completed yet
437 */
438 unsigned int io_u_in_flight;
439
440 /*
441 * List of free and busy io_u's
442 */
01743ee1
JA
443 struct flist_head io_u_freelist;
444 struct flist_head io_u_busylist;
445 struct flist_head io_u_requeues;
e8462bd8
JA
446 pthread_mutex_t io_u_lock;
447 pthread_cond_t free_cond;
448
449 /*
450 * async verify offload
451 */
452 struct flist_head verify_list;
453 pthread_t *verify_threads;
454 unsigned int nr_verify_threads;
455 pthread_cond_t verify_cond;
456 int verify_thread_exit;
ebac4655 457
e9c047a0
JA
458 /*
459 * Rate state
460 */
bdb6d20a 461 uint64_t rate_bps[DDIR_RWDIR_CNT];
6eaf09d6
SL
462 long rate_pending_usleep[DDIR_RWDIR_CNT];
463 unsigned long rate_bytes[DDIR_RWDIR_CNT];
464 unsigned long rate_blocks[DDIR_RWDIR_CNT];
465 struct timeval lastrate[DDIR_RWDIR_CNT];
ebac4655 466
bdb6d20a
JA
467 uint64_t total_io_size;
468 uint64_t fill_device_size;
ebac4655 469
6eaf09d6 470 unsigned long io_issues[DDIR_RWDIR_CNT];
bdb6d20a
JA
471 uint64_t io_blocks[DDIR_RWDIR_CNT];
472 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
473 uint64_t io_bytes[DDIR_RWDIR_CNT];
474 uint64_t io_skip_bytes;
475 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
476 uint64_t zone_bytes;
cdd18ad8 477 struct fio_mutex *mutex;
ebac4655 478
e9c047a0
JA
479 /*
480 * State for random io, a bitmap of blocks done vs not done
481 */
4c07ad86
JA
482 union {
483 os_random_state_t random_state;
484 struct frand_state __random_state;
485 };
ebac4655 486
ebac4655
JA
487 struct timeval start; /* start of this loop */
488 struct timeval epoch; /* time job was started */
a61eddec 489 struct timeval last_issue;
993bf48b
JA
490 struct timeval tv_cache;
491 unsigned int tv_cache_nr;
492 unsigned int tv_cache_mask;
721938ae 493 unsigned int ramp_time_over;
ebac4655 494
e9c047a0
JA
495 /*
496 * read/write mixed workload state
497 */
4c07ad86
JA
498 union {
499 os_random_state_t rwmix_state;
500 struct frand_state __rwmix_state;
501 };
e4928662 502 unsigned long rwmix_issues;
e9c047a0 503 enum fio_ddir rwmix_ddir;
5736c10d 504 unsigned int ddir_seq_nr;
a6ccc7be 505
e9c047a0 506 /*
8de8f047
JA
507 * IO history logs for verification. We use a tree for sorting,
508 * if we are overwriting. Otherwise just use a fifo.
e9c047a0 509 */
4b87898e 510 struct rb_root io_hist_tree;
01743ee1 511 struct flist_head io_hist_list;
9e144189 512 unsigned long io_hist_len;
8de8f047
JA
513
514 /*
515 * For IO replaying
516 */
01743ee1 517 struct flist_head io_log_list;
433afcb4 518
0d29de83
JA
519 /*
520 * For tracking/handling discards
521 */
522 struct flist_head trim_list;
523 unsigned long trim_entries;
524
1ae83d45
JA
525 struct flist_head next_rand_list;
526
1907dbc6
JA
527 /*
528 * for fileservice, how often to switch to a new file
529 */
530 unsigned int file_service_nr;
531 unsigned int file_service_left;
532 struct fio_file *file_service_file;
9c60ce64 533
44f29692
JA
534 unsigned int sync_file_range_nr;
535
9c60ce64
JA
536 /*
537 * For generating file sizes
538 */
4c07ad86
JA
539 union {
540 os_random_state_t file_size_state;
541 struct frand_state __file_size_state;
542 };
f2bba182
RR
543
544 /*
545 * Error counts
546 */
547 unsigned int total_err_count;
548 int first_error;
15dc1934 549
9e684a49
DE
550 struct fio_flow *flow;
551
15dc1934
JA
552 /*
553 * Can be overloaded by profiles
554 */
7eb36574 555 struct prof_io_ops prof_io_ops;
58c55ba0 556 void *prof_data;
ebac4655
JA
557};
558
e592a06b
AC
559/*
560 * when should interactive ETA output be generated
561 */
562enum {
563 FIO_ETA_AUTO,
564 FIO_ETA_ALWAYS,
565 FIO_ETA_NEVER,
566};
567
e1161c32 568#define __td_verror(td, err, msg, func) \
ebac4655 569 do { \
19abcd3d
JA
570 if ((td)->error) \
571 break; \
ebac4655
JA
572 int e = (err); \
573 (td)->error = e; \
f2bba182 574 if (!(td)->first_error) \
98ffb8f3 575 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
ebac4655
JA
576 } while (0)
577
b990b5c0 578
f2bba182
RR
579#define td_clear_error(td) \
580 (td)->error = 0;
e1161c32
JA
581#define td_verror(td, err, func) \
582 __td_verror((td), (err), strerror((err)), (func))
583#define td_vmsg(td, err, msg, func) \
584 __td_verror((td), (err), (msg), (func))
b990b5c0 585
81179eec
JA
586#define __fio_stringify_1(x) #x
587#define __fio_stringify(x) __fio_stringify_1(x)
588
ebac4655 589extern int exitall_on_terminate;
11e950bd 590extern unsigned int thread_number;
108fea77 591extern unsigned int stat_number;
11e950bd 592extern unsigned int nr_process, nr_thread;
ebac4655
JA
593extern int shm_id;
594extern int groupid;
f3afa57e 595extern int output_format;
53cdc686 596extern int temp_stall_ts;
1e97cce9 597extern unsigned long long mlock_size;
7078106d 598extern uintptr_t page_mask, page_size;
4241ea8f 599extern int read_only;
e592a06b 600extern int eta_print;
e382e661 601extern int eta_new_line;
d3eeeabc 602extern unsigned long done_secs;
01f06b63 603extern char *job_section;
be4ecfdf
JA
604extern int fio_gtod_offload;
605extern int fio_gtod_cpu;
c223da83 606extern enum fio_cs fio_clock_source;
fa80feae 607extern int fio_clock_source_set;
a9523c6f 608extern int warnings_fatal;
f57a9c59 609extern int terse_version;
5c341e9a 610extern int is_backend;
a37f69b7 611extern int nr_clients;
e46d8091 612extern int log_syslog;
5e726d0a 613extern const char fio_version_string[];
ebac4655
JA
614
615extern struct thread_data *threads;
616
7101d9c2
JA
617static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
618{
619 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
620}
621
fca70358 622#define REAL_MAX_JOBS 2048
ebac4655 623
4373e97a 624static inline enum error_type_bit td_error_type(enum fio_ddir ddir, int err)
06842027
SL
625{
626 if (err == EILSEQ)
8b28bd41 627 return ERROR_TYPE_VERIFY_BIT;
06842027 628 if (ddir == DDIR_READ)
8b28bd41
DM
629 return ERROR_TYPE_READ_BIT;
630 return ERROR_TYPE_WRITE_BIT;
631}
632
633static int __NON_FATAL_ERR[] = {EIO, EILSEQ};
634static inline int td_non_fatal_error(struct thread_data *td,
635 enum error_type_bit etype, int err)
636{
637 int i;
638 if (!td->o.ignore_error[etype]) {
639 td->o.ignore_error[etype] = __NON_FATAL_ERR;
640 td->o.ignore_error_nr[etype] = sizeof(__NON_FATAL_ERR)
641 / sizeof(int);
642 }
643
644 if (!(td->o.continue_on_error & (1 << etype)))
645 return 0;
646 for (i = 0; i < td->o.ignore_error_nr[etype]; i++)
647 if (td->o.ignore_error[etype][i] == err)
648 return 1;
649 return 0;
06842027
SL
650}
651
f2bba182
RR
652static inline void update_error_count(struct thread_data *td, int err)
653{
654 td->total_err_count++;
655 if (td->total_err_count == 1)
656 td->first_error = err;
657}
658
87dc1ab1
JA
659static inline int should_fsync(struct thread_data *td)
660{
661 if (td->last_was_sync)
662 return 0;
2dc1bbeb 663 if (td_write(td) || td_rw(td) || td->o.override_sync)
87dc1ab1
JA
664 return 1;
665
666 return 0;
667}
668
8914a9d8 669/*
214e1eca 670 * Init/option functions
8914a9d8 671 */
72cb971b 672extern int __must_check parse_options(int, char **);
50d16976 673extern int parse_jobs_ini(char *, int, int);
81179eec 674extern int parse_cmd_line(int, char **);
2e1df07d 675extern int fio_backend(void);
50d16976 676extern void reset_fio_state(void);
2e1df07d 677extern void clear_io_state(struct thread_data *);
3b8b7135 678extern int fio_options_parse(struct thread_data *, char **, int);
74929ac2 679extern void fio_keywords_init(void);
214e1eca 680extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
de890a1e 681extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
214e1eca
JA
682extern void fio_fill_default_options(struct thread_data *);
683extern int fio_show_option_help(const char *);
de890a1e 684extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
214e1eca 685extern void fio_options_dup_and_init(struct option *);
de890a1e
SL
686extern void fio_options_mem_dupe(struct thread_data *);
687extern void options_mem_dupe(void *data, struct fio_option *options);
5bfc35d7 688extern void td_fill_rand_seeds(struct thread_data *);
79d16311 689extern void add_job_opts(const char **);
73798eb2 690extern char *num2str(unsigned long, int, int, int, int);
de890a1e 691extern int ioengine_load(struct thread_data *);
1ec3d69b 692
de890a1e
SL
693#define FIO_GETOPT_JOB 0x89000000
694#define FIO_GETOPT_IOENGINE 0x98000000
07b3232d 695#define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
8914a9d8 696
263e529f
JA
697/*
698 * ETA/status stuff
699 */
700extern void print_thread_status(void);
701extern void print_status_init(int);
702
703/*
704 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
705 * will never back again. It may cycle between running/verififying/fsyncing.
706 * Once the thread reaches TD_EXITED, it is just waiting for the core to
707 * reap it.
708 */
709enum {
710 TD_NOT_CREATED = 0,
711 TD_CREATED,
712 TD_INITIALIZED,
b29ee5b3 713 TD_RAMP,
36d80bc7 714 TD_SETTING_UP,
263e529f 715 TD_RUNNING,
b0f65863 716 TD_PRE_READING,
263e529f
JA
717 TD_VERIFYING,
718 TD_FSYNCING,
719 TD_EXITED,
720 TD_REAPED,
721};
722
b29ee5b3 723extern void td_set_runstate(struct thread_data *, int);
cc0df00a
JA
724#define TERMINATE_ALL (-1)
725extern void fio_terminate_threads(int);
b29ee5b3 726
2f9ade3c
JA
727/*
728 * Memory helpers
729 */
b2fdda43 730extern int __must_check fio_pin_memory(void);
2f9ade3c 731extern void fio_unpin_memory(void);
b2fdda43 732extern int __must_check allocate_io_mem(struct thread_data *);
2f9ade3c
JA
733extern void free_io_mem(struct thread_data *);
734
b29ee5b3
JA
735/*
736 * Reset stats after ramp time completes
737 */
738extern void reset_all_stats(struct thread_data *);
739
fb7b71a3
JA
740/*
741 * blktrace support
742 */
5e62c22a 743#ifdef FIO_HAVE_BLKTRACE
fb7b71a3
JA
744extern int is_blktrace(const char *);
745extern int load_blktrace(struct thread_data *, const char *);
5e62c22a 746#endif
fb7b71a3 747
2866c82d
JA
748/*
749 * Mark unused variables passed to ops functions as unused, to silence gcc
750 */
751#define fio_unused __attribute((__unused__))
5f350952
JA
752#define fio_init __attribute__((constructor))
753#define fio_exit __attribute__((destructor))
2866c82d 754
34572e28
JA
755#define for_each_td(td, i) \
756 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
53cdc686 757#define for_each_file(td, f, i) \
691c8fb0
JA
758 if ((td)->files_index) \
759 for ((i) = 0, (f) = (td)->files[0]; \
760 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
761 (i)++)
53cdc686 762
0032bf9f
JA
763#define fio_assert(td, cond) do { \
764 if (!(cond)) { \
340fd243 765 int *__foo = NULL; \
0032bf9f 766 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
ac18ea38 767 td_set_runstate((td), TD_EXITED); \
437c9b71 768 (td)->error = EFAULT; \
340fd243 769 *__foo = 0; \
0032bf9f
JA
770 } \
771} while (0)
772
12d9d841
JA
773static inline int fio_fill_issue_time(struct thread_data *td)
774{
775 if (td->o.read_iolog_file ||
776 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
777 return 1;
778
779 return 0;
780}
781
581e7141
JA
782static inline int __should_check_rate(struct thread_data *td,
783 enum fio_ddir ddir)
784{
785 struct thread_options *o = &td->o;
786
787 /*
788 * If some rate setting was given, we need to check it
789 */
790 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
791 o->rate_iops_min[ddir])
792 return 1;
793
794 return 0;
795}
796
797static inline int should_check_rate(struct thread_data *td,
aa83321f 798 uint64_t *bytes_done)
581e7141
JA
799{
800 int ret = 0;
801
6eaf09d6
SL
802 if (bytes_done[DDIR_READ])
803 ret |= __should_check_rate(td, DDIR_READ);
804 if (bytes_done[DDIR_WRITE])
805 ret |= __should_check_rate(td, DDIR_WRITE);
806 if (bytes_done[DDIR_TRIM])
807 ret |= __should_check_rate(td, DDIR_TRIM);
581e7141
JA
808
809 return ret;
810}
811
74f4b020
JA
812static inline unsigned int td_max_bs(struct thread_data *td)
813{
814 unsigned int max_bs;
815
816 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
817 return max(td->o.max_bs[DDIR_TRIM], max_bs);
818}
819
d529ee19
JA
820static inline int is_power_of_2(unsigned int val)
821{
822 return (val != 0 && ((val & (val - 1)) == 0));
823}
824
e8462bd8
JA
825/*
826 * We currently only need to do locking if we have verifier threads
827 * accessing our internal structures too
828 */
829static inline void td_io_u_lock(struct thread_data *td)
830{
831 if (td->o.verify_async)
832 pthread_mutex_lock(&td->io_u_lock);
833}
834
835static inline void td_io_u_unlock(struct thread_data *td)
836{
837 if (td->o.verify_async)
838 pthread_mutex_unlock(&td->io_u_lock);
839}
840
841static inline void td_io_u_free_notify(struct thread_data *td)
842{
843 if (td->o.verify_async)
844 pthread_cond_signal(&td->free_cond);
845}
846
cca84643
JA
847extern const char *fio_get_arch_string(int);
848extern const char *fio_get_os_string(int);
849
f3afa57e
JA
850enum {
851 FIO_OUTPUT_TERSE = 0,
852 FIO_OUTPUT_JSON,
853 FIO_OUTPUT_NORMAL,
854};
855
e25839d4
JA
856enum {
857 FIO_RAND_DIST_RANDOM = 0,
858 FIO_RAND_DIST_ZIPF,
925fee33 859 FIO_RAND_DIST_PARETO,
e25839d4
JA
860};
861
8055e41d
JA
862enum {
863 FIO_RAND_GEN_TAUSWORTHE = 0,
864 FIO_RAND_GEN_LFSR,
865};
866
ebac4655 867#endif