Include http:// git url location
[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"
bf2e821a 36#include "lib/getopt.h"
2615cc4b 37#include "lib/rand.h"
ebac4655 38
609342ff
DL
39#ifdef FIO_HAVE_GUASI
40#include <guasi.h>
41#endif
42
417f0068
JA
43#ifdef FIO_HAVE_SOLARISAIO
44#include <sys/asynch.h>
45#endif
46
ebac4655 47struct group_run_stats {
9104f874
JA
48 unsigned long long max_run[2], min_run[2];
49 unsigned long long max_bw[2], min_bw[2];
e9b2a3fa 50 unsigned long long io_kb[2];
9104f874 51 unsigned long long agg[2];
90fef2d1 52 unsigned int kb_base;
ebac4655
JA
53};
54
e9c047a0
JA
55/*
56 * What type of allocation to use for io buffers
57 */
58enum fio_memtype {
59 MEM_MALLOC = 0, /* ordinary malloc */
60 MEM_SHM, /* use shared memory segments */
74b025b0 61 MEM_SHMHUGE, /* use shared memory segments with huge pages */
e9c047a0 62 MEM_MMAP, /* use anonynomous mmap */
d0bdaf49 63 MEM_MMAPHUGE, /* memory mapped huge file */
e9c047a0
JA
64};
65
38dad62d
JA
66/*
67 * offset generator types
68 */
69enum {
70 RW_SEQ_SEQ = 0,
71 RW_SEQ_IDENT,
72};
73
b2560f3c
JA
74/*
75 * How many depth levels to log
76 */
bb067558 77#define FIO_IO_U_MAP_NR 7
a9a18a3f
JA
78#define FIO_IO_U_LAT_U_NR 10
79#define FIO_IO_U_LAT_M_NR 12
b2560f3c 80
83349190
YH
81/*
82 * Aggregate clat samples to report percentile(s) of them.
83 *
84 * EXECUTIVE SUMMARY
85 *
86 * FIO_IO_U_PLAT_BITS determines the maximum statistical error on the
87 * value of resulting percentiles. The error will be approximately
88 * 1/2^(FIO_IO_U_PLAT_BITS+1) of the value.
89 *
90 * FIO_IO_U_PLAT_GROUP_NR and FIO_IO_U_PLAT_BITS determine the maximum
91 * range being tracked for latency samples. The maximum value tracked
92 * accurately will be 2^(GROUP_NR + PLAT_BITS -1) microseconds.
93 *
94 * FIO_IO_U_PLAT_GROUP_NR and FIO_IO_U_PLAT_BITS determine the memory
95 * requirement of storing those aggregate counts. The memory used will
96 * be (FIO_IO_U_PLAT_GROUP_NR * 2^FIO_IO_U_PLAT_BITS) * sizeof(int)
97 * bytes.
98 *
99 * FIO_IO_U_PLAT_NR is the total number of buckets.
100 *
101 * DETAILS
102 *
103 * Suppose the clat varies from 0 to 999 (usec), the straightforward
104 * method is to keep an array of (999 + 1) buckets, in which a counter
105 * keeps the count of samples which fall in the bucket, e.g.,
106 * {[0],[1],...,[999]}. However this consumes a huge amount of space,
107 * and can be avoided if an approximation is acceptable.
108 *
109 * One such method is to let the range of the bucket to be greater
110 * than one. This method has low accuracy when the value is small. For
111 * example, let the buckets be {[0,99],[100,199],...,[900,999]}, and
112 * the represented value of each bucket be the mean of the range. Then
113 * a value 0 has an round-off error of 49.5. To improve on this, we
114 * use buckets with non-uniform ranges, while bounding the error of
115 * each bucket within a ratio of the sample value. A simple example
116 * would be when error_bound = 0.005, buckets are {
117 * {[0],[1],...,[99]}, {[100,101],[102,103],...,[198,199]},..,
118 * {[900,909],[910,919]...} }. The total range is partitioned into
119 * groups with different ranges, then buckets with uniform ranges. An
120 * upper bound of the error is (range_of_bucket/2)/value_of_bucket
121 *
122 * For better efficiency, we implement this using base two. We group
123 * samples by their Most Significant Bit (MSB), extract the next M bit
124 * of them as an index within the group, and discard the rest of the
125 * bits.
126 *
127 * E.g., assume a sample 'x' whose MSB is bit n (starting from bit 0),
128 * and use M bit for indexing
129 *
130 * | n | M bits | bit (n-M-1) ... bit 0 |
131 *
132 * Because x is at least 2^n, and bit 0 to bit (n-M-1) is at most
133 * (2^(n-M) - 1), discarding bit 0 to (n-M-1) makes the round-off
134 * error
135 *
136 * 2^(n-M)-1 2^(n-M) 1
137 * e <= --------- <= ------- = ---
138 * 2^n 2^n 2^M
139 *
140 * Furthermore, we use "mean" of the range to represent the bucket,
141 * the error e can be lowered by half to 1 / 2^(M+1). By using M bits
142 * as the index, each group must contains 2^M buckets.
143 *
144 * E.g. Let M (FIO_IO_U_PLAT_BITS) be 6
145 * Error bound is 1/2^(6+1) = 0.0078125 (< 1%)
146 *
147 * Group MSB #discarded range of #buckets
148 * error_bits value
149 * ----------------------------------------------------------------
150 * 0* 0~5 0 [0,63] 64
151 * 1* 6 0 [64,127] 64
152 * 2 7 1 [128,255] 64
153 * 3 8 2 [256,511] 64
154 * 4 9 3 [512,1023] 64
155 * ... ... ... [...,...] ...
156 * 18 23 17 [8838608,+inf]** 64
157 *
158 * * Special cases: when n < (M-1) or when n == (M-1), in both cases,
159 * the value cannot be rounded off. Use all bits of the sample as
160 * index.
161 *
162 * ** If a sample's MSB is greater than 23, it will be counted as 23.
163 */
164
165#define FIO_IO_U_PLAT_BITS 6
166#define FIO_IO_U_PLAT_VAL (1 << FIO_IO_U_PLAT_BITS)
167#define FIO_IO_U_PLAT_GROUP_NR 19
168#define FIO_IO_U_PLAT_NR (FIO_IO_U_PLAT_GROUP_NR * FIO_IO_U_PLAT_VAL)
169#define FIO_IO_U_LIST_MAX_LEN 20 /* The size of the default and user-specified
170 list of percentiles */
171
0e92f873
RR
172#define MAX_PATTERN_SIZE 512
173
079ad09b 174struct thread_stat {
756867bd
JA
175 char *name;
176 char *verror;
177 int error;
178 int groupid;
179 pid_t pid;
180 char *description;
6586ee89 181 int members;
756867bd 182
079ad09b
JA
183 struct io_log *slat_log;
184 struct io_log *clat_log;
02af0988 185 struct io_log *lat_log;
079ad09b
JA
186 struct io_log *bw_log;
187
188 /*
189 * bandwidth and latency stats
190 */
191 struct io_stat clat_stat[2]; /* completion latency */
192 struct io_stat slat_stat[2]; /* submission latency */
02af0988 193 struct io_stat lat_stat[2]; /* total latency */
079ad09b
JA
194 struct io_stat bw_stat[2]; /* bandwidth stats */
195
196 unsigned long long stat_io_bytes[2];
197 struct timeval stat_sample_time[2];
198
199 /*
200 * fio system usage accounting
201 */
202 struct rusage ru_start;
203 struct rusage ru_end;
204 unsigned long usr_time;
205 unsigned long sys_time;
206 unsigned long ctx;
81887d5d 207 unsigned long minf, majf;
079ad09b 208
b2560f3c
JA
209 /*
210 * IO depth and latency stats
211 */
83349190
YH
212 unsigned int clat_percentiles;
213 double* percentile_list;
214
b2560f3c 215 unsigned int io_u_map[FIO_IO_U_MAP_NR];
838bc709
JA
216 unsigned int io_u_submit[FIO_IO_U_MAP_NR];
217 unsigned int io_u_complete[FIO_IO_U_MAP_NR];
04a0feae
JA
218 unsigned int io_u_lat_u[FIO_IO_U_LAT_U_NR];
219 unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
0a7d7f9e 220 unsigned int io_u_plat[2][FIO_IO_U_PLAT_NR];
0d29de83
JA
221 unsigned long total_io_u[3];
222 unsigned long short_io_u[3];
838bc709
JA
223 unsigned long total_submit;
224 unsigned long total_complete;
756867bd
JA
225
226 unsigned long long io_bytes[2];
cda99fa0 227 unsigned long long runtime[2];
756867bd 228 unsigned long total_run_time;
f2bba182
RR
229
230 /*
231 * IO Error related stats
232 */
233 unsigned continue_on_error;
234 unsigned long total_err_count;
235 int first_error;
90fef2d1
JA
236
237 unsigned int kb_base;
b2560f3c 238};
71619dc2 239
564ca972
JA
240struct bssplit {
241 unsigned int bs;
242 unsigned char perc;
243};
244
2dc1bbeb 245struct thread_options {
b1ec1da6 246 int pad;
61697c37 247 char *description;
b4692828 248 char *name;
ef899b63 249 char *directory;
13f8e2d2 250 char *filename;
2dc1bbeb 251 char *opendir;
09629a90 252 char *ioengine;
413dd459 253 enum td_ddir td_ddir;
38dad62d 254 unsigned int rw_seq;
90fef2d1 255 unsigned int kb_base;
5736c10d 256 unsigned int ddir_seq_nr;
a66da7a2 257 long ddir_seq_add;
2dc1bbeb
JA
258 unsigned int iodepth;
259 unsigned int iodepth_low;
260 unsigned int iodepth_batch;
4950421a 261 unsigned int iodepth_batch_complete;
2dc1bbeb
JA
262
263 unsigned long long size;
7bb59102 264 unsigned int size_percent;
aa31f1f1 265 unsigned int fill_device;
2dc1bbeb
JA
266 unsigned long long file_size_low;
267 unsigned long long file_size_high;
268 unsigned long long start_offset;
269
270 unsigned int bs[2];
2b7a01d0 271 unsigned int ba[2];
2dc1bbeb
JA
272 unsigned int min_bs[2];
273 unsigned int max_bs[2];
720e84ad
JA
274 struct bssplit *bssplit[2];
275 unsigned int bssplit_nr[2];
2dc1bbeb
JA
276
277 unsigned int nr_files;
278 unsigned int open_files;
4d4e80f2 279 enum file_lock_mode file_lock_mode;
29c1349f 280 unsigned int lockfile_batch;
e9c047a0 281
9158d2f7
JA
282 unsigned int odirect;
283 unsigned int invalidate_cache;
284 unsigned int create_serialize;
285 unsigned int create_fsync;
814452bd 286 unsigned int create_on_open;
9158d2f7 287 unsigned int end_fsync;
afad68f7 288 unsigned int pre_read;
9158d2f7
JA
289 unsigned int sync_io;
290 unsigned int verify;
e84c73a8 291 unsigned int do_verify;
160b966d 292 unsigned int verifysort;
a59e170d
JA
293 unsigned int verify_interval;
294 unsigned int verify_offset;
0e92f873 295 char verify_pattern[MAX_PATTERN_SIZE];
90059d65 296 unsigned int verify_pattern_bytes;
a12a3b4d 297 unsigned int verify_fatal;
b463e936 298 unsigned int verify_dump;
e8462bd8 299 unsigned int verify_async;
9e144189
JA
300 unsigned long long verify_backlog;
301 unsigned int verify_batch;
9158d2f7
JA
302 unsigned int use_thread;
303 unsigned int unlink;
304 unsigned int do_disk_util;
305 unsigned int override_sync;
306 unsigned int rand_repeatable;
2615cc4b 307 unsigned int use_os_rand;
9158d2f7
JA
308 unsigned int write_lat_log;
309 unsigned int write_bw_log;
bb8895e0 310 unsigned int norandommap;
2b386d25 311 unsigned int softrandommap;
690adba3 312 unsigned int bs_unaligned;
ebb1415f 313 unsigned int fsync_on_close;
e9c047a0 314
56bb17f2 315 unsigned int hugepage_size;
a00735e6 316 unsigned int rw_min_bs;
ebac4655 317 unsigned int thinktime;
48097d5c 318 unsigned int thinktime_spin;
9c1f7434 319 unsigned int thinktime_blocks;
ebac4655 320 unsigned int fsync_blocks;
5f9099ea 321 unsigned int fdatasync_blocks;
1ef2b6be 322 unsigned int barrier_blocks;
dce8b847 323 unsigned long long start_delay;
0db26797 324 unsigned long long timeout;
721938ae 325 unsigned long long ramp_time;
ebac4655 326 unsigned int overwrite;
ebac4655 327 unsigned int bw_avg_time;
ebac4655 328 unsigned int loops;
20dc95c4
JA
329 unsigned long long zone_size;
330 unsigned long long zone_skip;
e9c047a0 331 enum fio_memtype mem_type;
d529ee19 332 unsigned int mem_align;
2dc1bbeb 333
ebac4655 334 unsigned int stonewall;
b3d62a75 335 unsigned int new_group;
ebac4655 336 unsigned int numjobs;
ebac4655 337 os_cpu_mask_t cpumask;
375b2695 338 unsigned int cpumask_set;
e8462bd8
JA
339 os_cpu_mask_t verify_cpumask;
340 unsigned int verify_cpumask_set;
aea47d44 341 unsigned int iolog;
a6ccc7be 342 unsigned int rwmixcycle;
e47f799f 343 unsigned int rwmix[2];
b6f4d880 344 unsigned int nice;
0aabe160 345 unsigned int file_service_type;
b2560f3c 346 unsigned int group_reporting;
d2f3ac35 347 unsigned int fadvise_hint;
a596f047 348 enum fio_fallocate_mode fallocate_mode;
e9459e5a 349 unsigned int zero_buffers;
5973cafb 350 unsigned int refill_buffers;
fd68418e 351 unsigned int scramble_buffers;
cf4464ca 352 unsigned int time_based;
02af0988 353 unsigned int disable_lat;
9520ebb9
JA
354 unsigned int disable_clat;
355 unsigned int disable_slat;
356 unsigned int disable_bw;
993bf48b 357 unsigned int gtod_reduce;
be4ecfdf
JA
358 unsigned int gtod_cpu;
359 unsigned int gtod_offload;
c223da83 360 enum fio_cs clocksource;
64bbb865 361 unsigned int no_stall;
0d29de83
JA
362 unsigned int trim_percentage;
363 unsigned int trim_batch;
364 unsigned int trim_zero;
365 unsigned long long trim_backlog;
83349190
YH
366 unsigned int clat_percentiles;
367 unsigned int overwrite_plist;
368 double percentile_list[FIO_IO_U_LIST_MAX_LEN];
aea47d44 369
076efc7c
JA
370 char *read_iolog_file;
371 char *write_iolog_file;
e3cedca7
JA
372 char *bw_log_file;
373 char *lat_log_file;
d1c46c04 374 char *replay_redirect;
2dc1bbeb
JA
375
376 /*
377 * Pre-run and post-run shell
378 */
379 char *exec_prerun;
380 char *exec_postrun;
381
581e7141
JA
382 unsigned int rate[2];
383 unsigned int ratemin[2];
2dc1bbeb 384 unsigned int ratecycle;
581e7141
JA
385 unsigned int rate_iops[2];
386 unsigned int rate_iops_min[2];
2dc1bbeb
JA
387
388 char *ioscheduler;
389
390 /*
391 * CPU "io" cycle burner
392 */
393 unsigned int cpuload;
394 unsigned int cpucycle;
f2bba182
RR
395
396 /*
397 * I/O Error handling
398 */
399 unsigned int continue_on_error;
9ac8a797
JA
400
401 /*
402 * Benchmark profile type
403 */
79d16311 404 char *profile;
a696fa2a
JA
405
406 /*
407 * blkio cgroup support
408 */
a696fa2a
JA
409 char *cgroup;
410 unsigned int cgroup_weight;
7de87099 411 unsigned int cgroup_nodelete;
e0b0d892
JA
412
413 unsigned int uid;
414 unsigned int gid;
44f29692
JA
415
416 unsigned int sync_file_range;
675012f0
DE
417
418 unsigned int userspace_libaio_reap;
2dc1bbeb
JA
419};
420
e4e33258
JA
421#define FIO_VERROR_SIZE 128
422
2dc1bbeb
JA
423/*
424 * This describes a single thread/process executing a fio job.
425 */
426struct thread_data {
427 struct thread_options o;
e4e33258 428 char verror[FIO_VERROR_SIZE];
2dc1bbeb
JA
429 pthread_t thread;
430 int thread_number;
431 int groupid;
432 struct thread_stat ts;
126d65c6 433 struct fio_file **files;
dd87b2c9 434 unsigned int files_size;
2dc1bbeb
JA
435 unsigned int files_index;
436 unsigned int nr_open_files;
1020a139 437 unsigned int nr_done_files;
2dc1bbeb
JA
438 unsigned int nr_normal_files;
439 union {
440 unsigned int next_file;
441 os_random_state_t next_file_state;
4c07ad86 442 struct frand_state __next_file_state;
2dc1bbeb
JA
443 };
444 int error;
20e354ef 445 int done;
2dc1bbeb
JA
446 pid_t pid;
447 char *orig_buffer;
448 size_t orig_buffer_size;
449 volatile int terminate;
450 volatile int runstate;
451 unsigned int ioprio;
ac684785 452 unsigned int ioprio_set;
2dc1bbeb 453 unsigned int last_was_sync;
9e144189 454 enum fio_ddir last_ddir;
2dc1bbeb
JA
455
456 char *mmapfile;
457 int mmapfd;
458
843a7413
JA
459 void *iolog_buf;
460 FILE *iolog_f;
ebac4655 461
da86774e 462 char *sysfs_root;
da86774e 463
3545a109 464 unsigned long rand_seeds[8];
5bfc35d7 465
4c07ad86
JA
466 union {
467 os_random_state_t bsrange_state;
468 struct frand_state __bsrange_state;
469 };
470 union {
471 os_random_state_t verify_state;
472 struct frand_state __verify_state;
473 };
474 union {
475 os_random_state_t trim_state;
476 struct frand_state __trim_state;
477 };
ebac4655 478
3545a109
JA
479 struct frand_state buf_state;
480
9e144189 481 unsigned int verify_batch;
0d29de83 482 unsigned int trim_batch;
9e144189 483
ebac4655
JA
484 int shm_id;
485
e9c047a0
JA
486 /*
487 * IO engine hooks, contains everything needed to submit an io_u
488 * to any of the available IO engines.
489 */
2866c82d 490 struct ioengine_ops *io_ops;
ebac4655 491
e9c047a0
JA
492 /*
493 * Current IO depth and list of free and busy io_u's.
494 */
ebac4655 495 unsigned int cur_depth;
d8005759 496 unsigned int io_u_queued;
01743ee1
JA
497 struct flist_head io_u_freelist;
498 struct flist_head io_u_busylist;
499 struct flist_head io_u_requeues;
e8462bd8
JA
500 pthread_mutex_t io_u_lock;
501 pthread_cond_t free_cond;
502
503 /*
504 * async verify offload
505 */
506 struct flist_head verify_list;
507 pthread_t *verify_threads;
508 unsigned int nr_verify_threads;
509 pthread_cond_t verify_cond;
510 int verify_thread_exit;
ebac4655 511
e9c047a0
JA
512 /*
513 * Rate state
514 */
ba3e4e0c 515 unsigned long rate_nsec_cycle[2];
581e7141
JA
516 long rate_pending_usleep[2];
517 unsigned long rate_bytes[2];
518 unsigned long rate_blocks[2];
519 struct timeval lastrate[2];
ebac4655 520
ebac4655 521 unsigned long long total_io_size;
2e3bd4c2 522 unsigned long long fill_device_size;
ebac4655 523
755200a3 524 unsigned long io_issues[2];
9104f874
JA
525 unsigned long long io_blocks[2];
526 unsigned long long io_bytes[2];
48f5abd3 527 unsigned long long io_skip_bytes;
9104f874 528 unsigned long long this_io_bytes[2];
079ad09b 529 unsigned long long zone_bytes;
cdd18ad8 530 struct fio_mutex *mutex;
ebac4655 531
e9c047a0
JA
532 /*
533 * State for random io, a bitmap of blocks done vs not done
534 */
4c07ad86
JA
535 union {
536 os_random_state_t random_state;
537 struct frand_state __random_state;
538 };
ebac4655 539
ebac4655
JA
540 struct timeval start; /* start of this loop */
541 struct timeval epoch; /* time job was started */
a61eddec 542 struct timeval last_issue;
993bf48b
JA
543 struct timeval tv_cache;
544 unsigned int tv_cache_nr;
545 unsigned int tv_cache_mask;
721938ae 546 unsigned int ramp_time_over;
ebac4655 547
e9c047a0
JA
548 /*
549 * read/write mixed workload state
550 */
4c07ad86
JA
551 union {
552 os_random_state_t rwmix_state;
553 struct frand_state __rwmix_state;
554 };
e4928662 555 unsigned long rwmix_issues;
e9c047a0 556 enum fio_ddir rwmix_ddir;
5736c10d 557 unsigned int ddir_seq_nr;
a6ccc7be 558
e9c047a0 559 /*
8de8f047
JA
560 * IO history logs for verification. We use a tree for sorting,
561 * if we are overwriting. Otherwise just use a fifo.
e9c047a0 562 */
4b87898e 563 struct rb_root io_hist_tree;
01743ee1 564 struct flist_head io_hist_list;
9e144189 565 unsigned long io_hist_len;
8de8f047
JA
566
567 /*
568 * For IO replaying
569 */
01743ee1 570 struct flist_head io_log_list;
433afcb4 571
0d29de83
JA
572 /*
573 * For tracking/handling discards
574 */
575 struct flist_head trim_list;
576 unsigned long trim_entries;
577
1907dbc6
JA
578 /*
579 * for fileservice, how often to switch to a new file
580 */
581 unsigned int file_service_nr;
582 unsigned int file_service_left;
583 struct fio_file *file_service_file;
9c60ce64 584
44f29692
JA
585 unsigned int sync_file_range_nr;
586
9c60ce64
JA
587 /*
588 * For generating file sizes
589 */
4c07ad86
JA
590 union {
591 os_random_state_t file_size_state;
592 struct frand_state __file_size_state;
593 };
f2bba182
RR
594
595 /*
596 * Error counts
597 */
598 unsigned int total_err_count;
599 int first_error;
15dc1934
JA
600
601 /*
602 * Can be overloaded by profiles
603 */
7eb36574 604 struct prof_io_ops prof_io_ops;
58c55ba0 605 void *prof_data;
ebac4655
JA
606};
607
e592a06b
AC
608/*
609 * when should interactive ETA output be generated
610 */
611enum {
612 FIO_ETA_AUTO,
613 FIO_ETA_ALWAYS,
614 FIO_ETA_NEVER,
615};
616
e1161c32 617#define __td_verror(td, err, msg, func) \
ebac4655 618 do { \
19abcd3d
JA
619 if ((td)->error) \
620 break; \
ebac4655
JA
621 int e = (err); \
622 (td)->error = e; \
f2bba182
RR
623 if (!(td)->first_error) \
624 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
ebac4655
JA
625 } while (0)
626
b990b5c0 627
f2bba182
RR
628#define td_clear_error(td) \
629 (td)->error = 0;
e1161c32
JA
630#define td_verror(td, err, func) \
631 __td_verror((td), (err), strerror((err)), (func))
632#define td_vmsg(td, err, msg, func) \
633 __td_verror((td), (err), (msg), (func))
b990b5c0 634
ebac4655
JA
635extern int exitall_on_terminate;
636extern int thread_number;
9cedf167 637extern int nr_process, nr_thread;
ebac4655
JA
638extern int shm_id;
639extern int groupid;
c6ae0a5b 640extern int terse_output;
53cdc686 641extern int temp_stall_ts;
1e97cce9 642extern unsigned long long mlock_size;
cfc99db7 643extern unsigned long page_mask, page_size;
4241ea8f 644extern int read_only;
e592a06b 645extern int eta_print;
d3eeeabc 646extern unsigned long done_secs;
01f06b63 647extern char *job_section;
be4ecfdf
JA
648extern int fio_gtod_offload;
649extern int fio_gtod_cpu;
c223da83 650extern enum fio_cs fio_clock_source;
a9523c6f 651extern int warnings_fatal;
f57a9c59 652extern int terse_version;
ebac4655
JA
653
654extern struct thread_data *threads;
655
7101d9c2
JA
656static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
657{
658 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
659}
660
0ce8b119 661#define BLOCKS_PER_MAP (8 * sizeof(unsigned long))
aec2de20
JA
662#define TO_MAP_BLOCK(f, b) (b)
663#define RAND_MAP_IDX(f, b) (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
664#define RAND_MAP_BIT(f, b) (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
ebac4655 665
fca70358 666#define REAL_MAX_JOBS 2048
ebac4655 667
1ec99eea 668#define td_non_fatal_error(e) ((e) == EIO || (e) == EILSEQ)
f2bba182
RR
669
670static inline void update_error_count(struct thread_data *td, int err)
671{
672 td->total_err_count++;
673 if (td->total_err_count == 1)
674 td->first_error = err;
675}
676
87dc1ab1
JA
677static inline int should_fsync(struct thread_data *td)
678{
679 if (td->last_was_sync)
680 return 0;
2dc1bbeb 681 if (td->o.odirect)
87dc1ab1 682 return 0;
2dc1bbeb 683 if (td_write(td) || td_rw(td) || td->o.override_sync)
87dc1ab1
JA
684 return 1;
685
686 return 0;
687}
688
8914a9d8 689/*
214e1eca 690 * Init/option functions
8914a9d8 691 */
72cb971b 692extern int __must_check parse_options(int, char **);
3b8b7135 693extern int fio_options_parse(struct thread_data *, char **, int);
74929ac2 694extern void fio_keywords_init(void);
214e1eca
JA
695extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
696extern void fio_fill_default_options(struct thread_data *);
697extern int fio_show_option_help(const char *);
698extern void fio_options_dup_and_init(struct option *);
d23bb327
JA
699extern void options_mem_dupe(struct thread_data *);
700extern void options_mem_free(struct thread_data *);
5bfc35d7 701extern void td_fill_rand_seeds(struct thread_data *);
79d16311 702extern void add_job_opts(const char **);
1ec3d69b
JA
703extern char *num2str(unsigned long, int, int, int);
704
214e1eca 705#define FIO_GETOPT_JOB 0x89988998
07b3232d 706#define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
8914a9d8 707
263e529f
JA
708/*
709 * ETA/status stuff
710 */
711extern void print_thread_status(void);
712extern void print_status_init(int);
713
714/*
715 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
716 * will never back again. It may cycle between running/verififying/fsyncing.
717 * Once the thread reaches TD_EXITED, it is just waiting for the core to
718 * reap it.
719 */
720enum {
721 TD_NOT_CREATED = 0,
722 TD_CREATED,
723 TD_INITIALIZED,
b29ee5b3 724 TD_RAMP,
263e529f 725 TD_RUNNING,
b0f65863 726 TD_PRE_READING,
263e529f
JA
727 TD_VERIFYING,
728 TD_FSYNCING,
729 TD_EXITED,
730 TD_REAPED,
731};
732
b29ee5b3
JA
733extern void td_set_runstate(struct thread_data *, int);
734
2f9ade3c
JA
735/*
736 * Memory helpers
737 */
b2fdda43 738extern int __must_check fio_pin_memory(void);
2f9ade3c 739extern void fio_unpin_memory(void);
b2fdda43 740extern int __must_check allocate_io_mem(struct thread_data *);
2f9ade3c
JA
741extern void free_io_mem(struct thread_data *);
742
b29ee5b3
JA
743/*
744 * Reset stats after ramp time completes
745 */
746extern void reset_all_stats(struct thread_data *);
747
fb7b71a3
JA
748/*
749 * blktrace support
750 */
5e62c22a 751#ifdef FIO_HAVE_BLKTRACE
fb7b71a3
JA
752extern int is_blktrace(const char *);
753extern int load_blktrace(struct thread_data *, const char *);
5e62c22a 754#endif
fb7b71a3 755
2866c82d
JA
756/*
757 * Mark unused variables passed to ops functions as unused, to silence gcc
758 */
759#define fio_unused __attribute((__unused__))
5f350952
JA
760#define fio_init __attribute__((constructor))
761#define fio_exit __attribute__((destructor))
2866c82d 762
34572e28
JA
763#define for_each_td(td, i) \
764 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
53cdc686 765#define for_each_file(td, f, i) \
691c8fb0
JA
766 if ((td)->files_index) \
767 for ((i) = 0, (f) = (td)->files[0]; \
768 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
769 (i)++)
53cdc686 770
0032bf9f
JA
771#define fio_assert(td, cond) do { \
772 if (!(cond)) { \
340fd243 773 int *__foo = NULL; \
0032bf9f 774 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
ac18ea38 775 td_set_runstate((td), TD_EXITED); \
437c9b71 776 (td)->error = EFAULT; \
340fd243 777 *__foo = 0; \
0032bf9f
JA
778 } \
779} while (0)
780
12d9d841
JA
781static inline int fio_fill_issue_time(struct thread_data *td)
782{
783 if (td->o.read_iolog_file ||
784 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
785 return 1;
786
787 return 0;
788}
789
581e7141
JA
790static inline int __should_check_rate(struct thread_data *td,
791 enum fio_ddir ddir)
792{
793 struct thread_options *o = &td->o;
794
795 /*
796 * If some rate setting was given, we need to check it
797 */
798 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
799 o->rate_iops_min[ddir])
800 return 1;
801
802 return 0;
803}
804
805static inline int should_check_rate(struct thread_data *td,
806 unsigned long *bytes_done)
807{
808 int ret = 0;
809
810 if (bytes_done[0])
811 ret |= __should_check_rate(td, 0);
812 if (bytes_done[1])
813 ret |= __should_check_rate(td, 1);
814
815 return ret;
816}
817
d529ee19
JA
818static inline int is_power_of_2(unsigned int val)
819{
820 return (val != 0 && ((val & (val - 1)) == 0));
821}
822
e8462bd8
JA
823/*
824 * We currently only need to do locking if we have verifier threads
825 * accessing our internal structures too
826 */
827static inline void td_io_u_lock(struct thread_data *td)
828{
829 if (td->o.verify_async)
830 pthread_mutex_lock(&td->io_u_lock);
831}
832
833static inline void td_io_u_unlock(struct thread_data *td)
834{
835 if (td->o.verify_async)
836 pthread_mutex_unlock(&td->io_u_lock);
837}
838
839static inline void td_io_u_free_notify(struct thread_data *td)
840{
841 if (td->o.verify_async)
842 pthread_cond_signal(&td->free_cond);
843}
844
ebac4655 845#endif