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