Merge branch 'dedupe_bugfix' of https://github.com/bardavid/fio
[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
317b95d0 17#include "compiler/compiler.h"
8062f527 18#include "thread_options.h"
01743ee1 19#include "flist.h"
e2887563 20#include "fifo.h"
317b95d0
JA
21#include "arch/arch.h"
22#include "os/os.h"
a3d741fa
JA
23#include "log.h"
24#include "debug.h"
d6aed795
JA
25#include "file.h"
26#include "io_ddir.h"
618ee94c 27#include "ioengines.h"
5995a6a4 28#include "iolog.h"
c5c8bd5c 29#include "helpers.h"
3d2d14bc 30#include "minmax.h"
07b3232d 31#include "options.h"
7eb36574 32#include "profile.h"
ef3c94b6 33#include "fio_time.h"
a7346816 34#include "gettime.h"
f87cc561 35#include "oslib/getopt.h"
2615cc4b 36#include "lib/rand.h"
7fb6d453 37#include "lib/rbtree.h"
5e746820 38#include "lib/num2str.h"
fd745bf3
TK
39#include "lib/memalign.h"
40#include "smalloc.h"
dd366728 41#include "client.h"
37db14fe 42#include "server.h"
a64e88da 43#include "stat.h"
9e684a49 44#include "flow.h"
8ef89e0b 45#include "io_u.h"
2ae0b204 46#include "io_u_queue.h"
a9da8ab2 47#include "workqueue.h"
0a70e050 48#include "steadystate.h"
734f7d02 49#include "lib/nowarn_snprintf.h"
ebac4655 50
4700b234 51#ifdef CONFIG_SOLARISAIO
417f0068
JA
52#include <sys/asynch.h>
53#endif
54
67bf9823 55#ifdef CONFIG_LIBNUMA
d0b937ed
YR
56#include <linux/mempolicy.h>
57#include <numa.h>
58
59/*
60 * "local" is pseudo-policy
61 */
2048d33f
JN
62#ifndef MPOL_LOCAL
63#define MPOL_LOCAL 4
64#endif
d0b937ed
YR
65#endif
66
03553853
YR
67#ifdef CONFIG_CUDA
68#include <cuda.h>
69#endif
70
971caeb1 71struct fio_sem;
ae626d4e 72
38dad62d
JA
73/*
74 * offset generator types
75 */
76enum {
77 RW_SEQ_SEQ = 0,
78 RW_SEQ_IDENT,
79};
80
d72be545 81enum {
a9f517ae
JA
82 __TD_F_VER_BACKLOG = 0,
83 __TD_F_TRIM_BACKLOG,
84 __TD_F_READ_IOLOG,
85 __TD_F_REFILL_BUFFERS,
86 __TD_F_SCRAMBLE_BUFFERS,
553f9652 87 __TD_F_DO_VERIFY,
a9f517ae
JA
88 __TD_F_PROFILE_OPS,
89 __TD_F_COMPRESS,
90 __TD_F_COMPRESS_LOG,
91 __TD_F_VSTATE_SAVED,
92 __TD_F_NEED_LOCK,
93 __TD_F_CHILD,
94 __TD_F_NO_PROGRESS,
95 __TD_F_REGROW_LOGS,
96 __TD_F_MMAP_KEEP,
f1c71016 97 __TD_F_DIRS_CREATED,
5c81ff5e 98 __TD_F_CHECK_RATE,
9c6f1e75 99 __TD_F_LAST, /* not a real bit, keep last */
a9f517ae
JA
100};
101
102enum {
103 TD_F_VER_BACKLOG = 1U << __TD_F_VER_BACKLOG,
104 TD_F_TRIM_BACKLOG = 1U << __TD_F_TRIM_BACKLOG,
105 TD_F_READ_IOLOG = 1U << __TD_F_READ_IOLOG,
106 TD_F_REFILL_BUFFERS = 1U << __TD_F_REFILL_BUFFERS,
107 TD_F_SCRAMBLE_BUFFERS = 1U << __TD_F_SCRAMBLE_BUFFERS,
553f9652 108 TD_F_DO_VERIFY = 1U << __TD_F_DO_VERIFY,
a9f517ae
JA
109 TD_F_PROFILE_OPS = 1U << __TD_F_PROFILE_OPS,
110 TD_F_COMPRESS = 1U << __TD_F_COMPRESS,
111 TD_F_COMPRESS_LOG = 1U << __TD_F_COMPRESS_LOG,
112 TD_F_VSTATE_SAVED = 1U << __TD_F_VSTATE_SAVED,
113 TD_F_NEED_LOCK = 1U << __TD_F_NEED_LOCK,
114 TD_F_CHILD = 1U << __TD_F_CHILD,
115 TD_F_NO_PROGRESS = 1U << __TD_F_NO_PROGRESS,
116 TD_F_REGROW_LOGS = 1U << __TD_F_REGROW_LOGS,
117 TD_F_MMAP_KEEP = 1U << __TD_F_MMAP_KEEP,
f1c71016 118 TD_F_DIRS_CREATED = 1U << __TD_F_DIRS_CREATED,
5c81ff5e 119 TD_F_CHECK_RATE = 1U << __TD_F_CHECK_RATE,
d72be545
JA
120};
121
d24945f0
JA
122enum {
123 FIO_RAND_BS_OFF = 0,
2f282cec
JA
124 FIO_RAND_BS1_OFF,
125 FIO_RAND_BS2_OFF,
d24945f0
JA
126 FIO_RAND_VER_OFF,
127 FIO_RAND_MIX_OFF,
128 FIO_RAND_FILE_OFF,
129 FIO_RAND_BLOCK_OFF,
130 FIO_RAND_FILE_SIZE_OFF,
131 FIO_RAND_TRIM_OFF,
132 FIO_RAND_BUF_OFF,
d9472271
JA
133 FIO_RAND_SEQ_RAND_READ_OFF,
134 FIO_RAND_SEQ_RAND_WRITE_OFF,
135 FIO_RAND_SEQ_RAND_TRIM_OFF,
23ed19b0 136 FIO_RAND_START_DELAY,
5c94b008 137 FIO_DEDUPE_OFF,
e7b24047 138 FIO_RAND_POISSON_OFF,
e0a04ac1 139 FIO_RAND_ZONE_OFF,
6c8611c7
JA
140 FIO_RAND_POISSON2_OFF,
141 FIO_RAND_POISSON3_OFF,
b2a432bf 142 FIO_RAND_PRIO_CMDS,
d24945f0
JA
143 FIO_RAND_NR_OFFS,
144};
145
a9da8ab2
JA
146enum {
147 IO_MODE_INLINE = 0,
6de65959
JA
148 IO_MODE_OFFLOAD = 1,
149
150 RATE_PROCESS_LINEAR = 0,
151 RATE_PROCESS_POISSON = 1,
33f42c20
HQ
152
153 THINKTIME_BLOCKS_TYPE_COMPLETE = 0,
154 THINKTIME_BLOCKS_TYPE_ISSUE = 1,
a9da8ab2
JA
155};
156
ecb2083d
JA
157enum {
158 F_ADV_NONE = 0,
159 F_ADV_TYPE,
160 F_ADV_RANDOM,
161 F_ADV_SEQUENTIAL,
162};
163
2a2804c9
JA
164/*
165 * Per-thread/process specific data. Only used for the network client
166 * for now.
167 */
24660963
JA
168void sk_out_assign(struct sk_out *);
169void sk_out_drop(void);
2a2804c9 170
e0a04ac1
JA
171struct zone_split_index {
172 uint8_t size_perc;
173 uint8_t size_perc_prev;
59466396
JA
174 uint64_t size;
175 uint64_t size_prev;
e0a04ac1
JA
176};
177
2dc1bbeb
JA
178/*
179 * This describes a single thread/process executing a fio job.
180 */
181struct thread_data {
c2292325 182 struct flist_head opt_list;
d72be545 183 unsigned long flags;
d7e9266c 184 struct thread_options o;
de890a1e 185 void *eo;
2dc1bbeb 186 pthread_t thread;
2f122b13 187 unsigned int thread_number;
69bdd6ba 188 unsigned int subjob_number;
2f122b13 189 unsigned int groupid;
b2fcbe01 190 struct thread_stat ts __attribute__ ((aligned(8)));
7b9f733a 191
46bcd498
JA
192 int client_type;
193
7b9f733a
JA
194 struct io_log *slat_log;
195 struct io_log *clat_log;
1e613c9c 196 struct io_log *clat_hist_log;
7b9f733a
JA
197 struct io_log *lat_log;
198 struct io_log *bw_log;
c8eeb9df 199 struct io_log *iops_log;
7b9f733a 200
155f2f02 201 struct workqueue log_compress_wq;
aee2ab67 202
a9da8ab2
JA
203 struct thread_data *parent;
204
6eaf09d6 205 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
8b6a404c 206 struct timespec bw_sample_time;
c8eeb9df 207
6eaf09d6 208 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
8b6a404c 209 struct timespec iops_sample_time;
f0505a14 210
c97f1ad6 211 volatile int update_rusage;
971caeb1 212 struct fio_sem *rusage_sem;
c8aaba19
JA
213 struct rusage ru_start;
214 struct rusage ru_end;
215
126d65c6 216 struct fio_file **files;
d7df1d13 217 unsigned char *file_locks;
dd87b2c9 218 unsigned int files_size;
2dc1bbeb
JA
219 unsigned int files_index;
220 unsigned int nr_open_files;
1020a139 221 unsigned int nr_done_files;
2dc1bbeb
JA
222 union {
223 unsigned int next_file;
d6b72507 224 struct frand_state next_file_state;
2dc1bbeb 225 };
8c07860d
JA
226 union {
227 struct zipf_state next_file_zipf;
228 struct gauss_state next_file_gauss;
229 };
230 union {
231 double zipf_theta;
232 double pareto_h;
233 double gauss_dev;
234 };
a87c90fd 235 double random_center;
2dc1bbeb 236 int error;
a5e371a6 237 int sig;
20e354ef 238 int done;
ca09be4b 239 int stop_io;
2dc1bbeb
JA
240 pid_t pid;
241 char *orig_buffer;
242 size_t orig_buffer_size;
2dc1bbeb 243 volatile int runstate;
2ea93f98
JA
244 volatile bool terminate;
245 bool last_was_sync;
9e144189 246 enum fio_ddir last_ddir;
2dc1bbeb 247
2dc1bbeb
JA
248 int mmapfd;
249
843a7413
JA
250 void *iolog_buf;
251 FILE *iolog_f;
ebac4655 252
9781c080 253 uint64_t rand_seeds[FIO_RAND_NR_OFFS];
5bfc35d7 254
2f282cec 255 struct frand_state bsrange_state[DDIR_RWDIR_CNT];
d6b72507
JA
256 struct frand_state verify_state;
257 struct frand_state trim_state;
258 struct frand_state delay_state;
ebac4655 259
3545a109 260 struct frand_state buf_state;
5c94b008 261 struct frand_state buf_state_prev;
c75f1778 262 struct frand_state buf_state_ret;
5c94b008 263 struct frand_state dedupe_state;
e0a04ac1 264 struct frand_state zone_state;
b2a432bf 265 struct frand_state prio_state;
e0a04ac1
JA
266
267 struct zone_split_index **zone_state_index;
219c662d 268 unsigned int num_open_zones;
3545a109 269
9e144189 270 unsigned int verify_batch;
0d29de83 271 unsigned int trim_batch;
9e144189 272
ca09be4b
JA
273 struct thread_io_list *vstate;
274
ebac4655
JA
275 int shm_id;
276
e9c047a0
JA
277 /*
278 * IO engine hooks, contains everything needed to submit an io_u
279 * to any of the available IO engines.
280 */
2866c82d 281 struct ioengine_ops *io_ops;
356ef1a1 282 int io_ops_init;
ebac4655 283
565e784d
TK
284 /*
285 * IO engine private data and dlhandle.
286 */
287 void *io_ops_data;
565e784d 288
e9c047a0 289 /*
422f9e4b 290 * Queue depth of io_u's that fio MIGHT do
e9c047a0 291 */
ebac4655 292 unsigned int cur_depth;
422f9e4b
RM
293
294 /*
295 * io_u's about to be committed
296 */
d8005759 297 unsigned int io_u_queued;
422f9e4b
RM
298
299 /*
300 * io_u's submitted but not completed yet
301 */
302 unsigned int io_u_in_flight;
303
304 /*
305 * List of free and busy io_u's
306 */
2ae0b204
JA
307 struct io_u_ring io_u_requeues;
308 struct io_u_queue io_u_freelist;
309 struct io_u_queue io_u_all;
e8462bd8
JA
310 pthread_mutex_t io_u_lock;
311 pthread_cond_t free_cond;
312
313 /*
314 * async verify offload
315 */
316 struct flist_head verify_list;
317 pthread_t *verify_threads;
318 unsigned int nr_verify_threads;
319 pthread_cond_t verify_cond;
320 int verify_thread_exit;
ebac4655 321
e9c047a0
JA
322 /*
323 * Rate state
324 */
bdb6d20a 325 uint64_t rate_bps[DDIR_RWDIR_CNT];
90eff1c9 326 uint64_t rate_next_io_time[DDIR_RWDIR_CNT];
eda99d55 327 unsigned long long rate_bytes[DDIR_RWDIR_CNT];
6eaf09d6 328 unsigned long rate_blocks[DDIR_RWDIR_CNT];
90eff1c9 329 unsigned long long rate_io_issue_bytes[DDIR_RWDIR_CNT];
8b6a404c 330 struct timespec lastrate[DDIR_RWDIR_CNT];
6c8611c7
JA
331 int64_t last_usec[DDIR_RWDIR_CNT];
332 struct frand_state poisson_state[DDIR_RWDIR_CNT];
ebac4655 333
a9da8ab2
JA
334 /*
335 * Enforced rate submission/completion workqueue
336 */
337 struct workqueue io_wq;
338
bdb6d20a
JA
339 uint64_t total_io_size;
340 uint64_t fill_device_size;
ebac4655 341
74d6277f
JA
342 /*
343 * Issue side
344 */
ca09be4b 345 uint64_t io_issues[DDIR_RWDIR_CNT];
74d6277f 346 uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
cf8a46a7 347 uint64_t loops;
74d6277f
JA
348
349 /*
350 * Completions
351 */
bdb6d20a
JA
352 uint64_t io_blocks[DDIR_RWDIR_CNT];
353 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
354 uint64_t io_bytes[DDIR_RWDIR_CNT];
bdb6d20a 355 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
55312f9f 356 uint64_t io_skip_bytes;
bdb6d20a 357 uint64_t zone_bytes;
971caeb1 358 struct fio_sem *sem;
55312f9f 359 uint64_t bytes_done[DDIR_RWDIR_CNT];
ebac4655 360
33f42c20
HQ
361 uint64_t *thinktime_blocks_counter;
362
e9c047a0
JA
363 /*
364 * State for random io, a bitmap of blocks done vs not done
365 */
d6b72507 366 struct frand_state random_state;
ebac4655 367
8b6a404c
VF
368 struct timespec start; /* start of this loop */
369 struct timespec epoch; /* time job was started */
3aea75b1 370 unsigned long long unix_epoch; /* Time job was started, unix epoch based. */
8b6a404c 371 struct timespec last_issue;
df8fb609 372 long time_offset;
8b6a404c
VF
373 struct timespec ts_cache;
374 struct timespec terminate_time;
375 unsigned int ts_cache_nr;
376 unsigned int ts_cache_mask;
49f3f914 377 bool ramp_time_over;
ebac4655 378
3e260a46
JA
379 /*
380 * Time since last latency_window was started
381 */
8b6a404c 382 struct timespec latency_ts;
3e260a46
JA
383 unsigned int latency_qd;
384 unsigned int latency_qd_high;
385 unsigned int latency_qd_low;
386 unsigned int latency_failed;
e1bcd541 387 unsigned int latency_stable_count;
3e260a46 388 uint64_t latency_ios;
6bb58215 389 int latency_end_run;
3e260a46 390
e9c047a0
JA
391 /*
392 * read/write mixed workload state
393 */
d6b72507 394 struct frand_state rwmix_state;
e4928662 395 unsigned long rwmix_issues;
e9c047a0 396 enum fio_ddir rwmix_ddir;
5736c10d 397 unsigned int ddir_seq_nr;
a6ccc7be 398
211c9b89
JA
399 /*
400 * rand/seq mixed workload state
401 */
d6b72507 402 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
211c9b89 403
e9c047a0 404 /*
8de8f047
JA
405 * IO history logs for verification. We use a tree for sorting,
406 * if we are overwriting. Otherwise just use a fifo.
e9c047a0 407 */
4b87898e 408 struct rb_root io_hist_tree;
01743ee1 409 struct flist_head io_hist_list;
9e144189 410 unsigned long io_hist_len;
8de8f047
JA
411
412 /*
413 * For IO replaying
414 */
01743ee1 415 struct flist_head io_log_list;
98e7161c
AK
416 FILE *io_log_rfile;
417 unsigned int io_log_current;
418 unsigned int io_log_checkmark;
419 unsigned int io_log_highmark;
420 struct timespec io_log_highmark_time;
433afcb4 421
0d29de83
JA
422 /*
423 * For tracking/handling discards
424 */
425 struct flist_head trim_list;
426 unsigned long trim_entries;
427
1907dbc6
JA
428 /*
429 * for fileservice, how often to switch to a new file
430 */
431 unsigned int file_service_nr;
432 unsigned int file_service_left;
433 struct fio_file *file_service_file;
9c60ce64 434
44f29692
JA
435 unsigned int sync_file_range_nr;
436
9c60ce64
JA
437 /*
438 * For generating file sizes
439 */
d6b72507 440 struct frand_state file_size_state;
f2bba182
RR
441
442 /*
443 * Error counts
444 */
445 unsigned int total_err_count;
446 int first_error;
15dc1934 447
9e684a49 448 struct fio_flow *flow;
d4e74fda 449 unsigned long long flow_counter;
9e684a49 450
15dc1934
JA
451 /*
452 * Can be overloaded by profiles
453 */
7eb36574 454 struct prof_io_ops prof_io_ops;
58c55ba0 455 void *prof_data;
9a3f1100
JA
456
457 void *pinned_mem;
d7e9266c 458
16e56d25
VF
459 struct steadystate_data ss;
460
d7e9266c 461 char verror[FIO_VERROR_SIZE];
03553853
YR
462
463#ifdef CONFIG_CUDA
464 /*
465 * for GPU memory management
466 */
467 int gpu_dev_cnt;
468 int gpu_dev_id;
469 CUdevice cu_dev;
470 CUcontext cu_ctx;
471 CUdeviceptr dev_mem_ptr;
7a4e480d 472#endif
03553853 473
ebac4655
JA
474};
475
d41647e6
JA
476struct thread_segment {
477 struct thread_data *threads;
478 int shm_id;
2fbe1e19 479 int nr_threads;
d41647e6
JA
480};
481
e592a06b
AC
482/*
483 * when should interactive ETA output be generated
484 */
485enum {
486 FIO_ETA_AUTO,
487 FIO_ETA_ALWAYS,
488 FIO_ETA_NEVER,
489};
490
e1161c32 491#define __td_verror(td, err, msg, func) \
ebac4655 492 do { \
21beb609 493 unsigned int ____e = (err); \
19abcd3d
JA
494 if ((td)->error) \
495 break; \
8271963e 496 (td)->error = ____e; \
f2bba182 497 if (!(td)->first_error) \
b4d2bc70
BVA
498 nowarn_snprintf(td->verror, sizeof(td->verror), \
499 "file:%s:%d, func=%s, error=%s", \
500 __FILE__, __LINE__, (func), (msg)); \
ebac4655
JA
501 } while (0)
502
b990b5c0 503
a9da8ab2
JA
504#define td_clear_error(td) do { \
505 (td)->error = 0; \
506 if ((td)->parent) \
507 (td)->parent->error = 0; \
508} while (0)
509
510#define td_verror(td, err, func) do { \
511 __td_verror((td), (err), strerror((err)), (func)); \
512 if ((td)->parent) \
513 __td_verror((td)->parent, (err), strerror((err)), (func)); \
514} while (0)
515
516#define td_vmsg(td, err, msg, func) do { \
517 __td_verror((td), (err), (msg), (func)); \
518 if ((td)->parent) \
519 __td_verror((td)->parent, (err), (msg), (func)); \
520} while (0)
b990b5c0 521
81179eec
JA
522#define __fio_stringify_1(x) #x
523#define __fio_stringify(x) __fio_stringify_1(x)
524
d41647e6
JA
525#define REAL_MAX_JOBS 4096
526#define JOBS_PER_SEG 8
527#define REAL_MAX_SEG (REAL_MAX_JOBS / JOBS_PER_SEG)
528
f1867a7f 529extern bool exitall_on_terminate;
11e950bd 530extern unsigned int thread_number;
108fea77 531extern unsigned int stat_number;
2fbe1e19
JA
532extern unsigned int nr_segments;
533extern unsigned int cur_segment;
ebac4655 534extern int groupid;
f3afa57e 535extern int output_format;
2b8c71b0 536extern int append_terse_output;
53cdc686 537extern int temp_stall_ts;
7078106d 538extern uintptr_t page_mask, page_size;
f1867a7f 539extern bool read_only;
e592a06b 540extern int eta_print;
e382e661 541extern int eta_new_line;
db37d890 542extern unsigned int eta_interval_msec;
d3eeeabc 543extern unsigned long done_secs;
be4ecfdf
JA
544extern int fio_gtod_offload;
545extern int fio_gtod_cpu;
c223da83 546extern enum fio_cs fio_clock_source;
fa80feae 547extern int fio_clock_source_set;
a9523c6f 548extern int warnings_fatal;
f57a9c59 549extern int terse_version;
f1867a7f
JA
550extern bool is_backend;
551extern bool is_local_backend;
a37f69b7 552extern int nr_clients;
f1867a7f 553extern bool log_syslog;
06464907 554extern int status_interval;
5e726d0a 555extern const char fio_version_string[];
ca09be4b
JA
556extern char *trigger_file;
557extern char *trigger_cmd;
b63efd30 558extern char *trigger_remote_cmd;
ca09be4b 559extern long long trigger_timeout;
d264264a 560extern char *aux_path;
ebac4655 561
d41647e6 562extern struct thread_segment segments[REAL_MAX_SEG];
ebac4655 563
2fbe1e19
JA
564static inline struct thread_data *tnumber_to_td(unsigned int tnumber)
565{
566 struct thread_segment *seg;
567
568 seg = &segments[tnumber / JOBS_PER_SEG];
569 return &seg->threads[tnumber & (JOBS_PER_SEG - 1)];
570}
571
24a97130
LC
572static inline bool is_running_backend(void)
573{
574 return is_backend || is_local_backend;
575}
576
db37d890
JA
577extern bool eta_time_within_slack(unsigned int time);
578
effd6ff0 579static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
7101d9c2 580{
196ccc44
VF
581 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)) &&
582 !(io_u->ddir == DDIR_TRIM && !td_trim(td)));
7101d9c2
JA
583}
584
a3eb1a1e 585static inline bool should_fsync(struct thread_data *td)
87dc1ab1
JA
586{
587 if (td->last_was_sync)
a3eb1a1e 588 return false;
dcf9844e 589 if (td_write(td) || td->o.override_sync)
a3eb1a1e 590 return true;
87dc1ab1 591
a3eb1a1e 592 return false;
87dc1ab1
JA
593}
594
8914a9d8 595/*
214e1eca 596 * Init/option functions
8914a9d8 597 */
0420ba6a 598extern int __must_check fio_init_options(void);
72cb971b 599extern int __must_check parse_options(int, char **);
46bcd498
JA
600extern int parse_jobs_ini(char *, int, int, int);
601extern int parse_cmd_line(int, char **, int);
24660963 602extern int fio_backend(struct sk_out *);
50d16976 603extern void reset_fio_state(void);
ac28d905 604extern void clear_io_state(struct thread_data *, int);
c2292325 605extern int fio_options_parse(struct thread_data *, char **, int);
74929ac2 606extern void fio_keywords_init(void);
af1dc266 607extern void fio_keywords_exit(void);
214e1eca 608extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
de890a1e 609extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
214e1eca
JA
610extern void fio_fill_default_options(struct thread_data *);
611extern int fio_show_option_help(const char *);
de890a1e 612extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
214e1eca 613extern void fio_options_dup_and_init(struct option *);
b4f5e72f 614extern char *fio_option_dup_subs(const char *);
de890a1e 615extern void fio_options_mem_dupe(struct thread_data *);
5bfc35d7 616extern void td_fill_rand_seeds(struct thread_data *);
8f380de2 617extern void td_fill_verify_state_seed(struct thread_data *);
46bcd498 618extern void add_job_opts(const char **, int);
de890a1e 619extern int ioengine_load(struct thread_data *);
8aa89d70 620extern bool parse_dryrun(void);
046395d7 621extern int fio_running_or_pending_io_threads(void);
3a35845f 622extern int fio_set_fd_nonblocking(int, const char *);
d2235e56 623extern void sig_show_status(int sig);
66e19a38 624extern struct thread_data *get_global_options(void);
1ec3d69b 625
a569b45f
JA
626extern uintptr_t page_mask;
627extern uintptr_t page_size;
628extern int initialize_fio(char *envp[]);
af1dc266 629extern void deinitialize_fio(void);
a569b45f 630
de890a1e
SL
631#define FIO_GETOPT_JOB 0x89000000
632#define FIO_GETOPT_IOENGINE 0x98000000
07b3232d 633#define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
8914a9d8 634
263e529f
JA
635/*
636 * ETA/status stuff
637 */
638extern void print_thread_status(void);
639extern void print_status_init(int);
0a428b23 640extern char *fio_uint_to_kmg(unsigned int val);
263e529f
JA
641
642/*
643 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
644 * will never back again. It may cycle between running/verififying/fsyncing.
645 * Once the thread reaches TD_EXITED, it is just waiting for the core to
646 * reap it.
647 */
648enum {
649 TD_NOT_CREATED = 0,
650 TD_CREATED,
651 TD_INITIALIZED,
b29ee5b3 652 TD_RAMP,
36d80bc7 653 TD_SETTING_UP,
263e529f 654 TD_RUNNING,
b0f65863 655 TD_PRE_READING,
263e529f
JA
656 TD_VERIFYING,
657 TD_FSYNCING,
3d434057 658 TD_FINISHING,
263e529f
JA
659 TD_EXITED,
660 TD_REAPED,
6e760cf3 661 TD_LAST,
9b87f09b 662 TD_NR,
263e529f
JA
663};
664
5c81ff5e
JA
665#define TD_ENG_FLAG_SHIFT 17
666#define TD_ENG_FLAG_MASK ((1U << 17) - 1)
9b87f09b 667
9b87f09b
JA
668static inline void td_set_ioengine_flags(struct thread_data *td)
669{
3d92b849
SW
670 td->flags = (~(TD_ENG_FLAG_MASK << TD_ENG_FLAG_SHIFT) & td->flags) |
671 (td->io_ops->flags << TD_ENG_FLAG_SHIFT);
9b87f09b
JA
672}
673
8f6d1311
JA
674static inline bool td_ioengine_flagged(struct thread_data *td,
675 enum fio_ioengine_flags flags)
9b87f09b 676{
8f6d1311 677 return ((td->flags >> TD_ENG_FLAG_SHIFT) & flags) != 0;
9b87f09b
JA
678}
679
b29ee5b3 680extern void td_set_runstate(struct thread_data *, int);
8edd973d
JA
681extern int td_bump_runstate(struct thread_data *, int);
682extern void td_restore_runstate(struct thread_data *, int);
9cc8cb91 683extern const char *runstate_to_name(int runstate);
8edd973d 684
cba5460c
JA
685/*
686 * Allow 60 seconds for a job to quit on its own, otherwise reap with
687 * a vengeance.
688 */
8ecf6df1 689#define FIO_REAP_TIMEOUT 300
cba5460c 690
64402a8a
HW
691enum {
692 TERMINATE_NONE = 0,
693 TERMINATE_GROUP = 1,
694 TERMINATE_STONEWALL = 2,
695 TERMINATE_ALL = -1,
696};
697
698extern void fio_terminate_threads(unsigned int, unsigned int);
ebea2133 699extern void fio_mark_td_terminate(struct thread_data *);
b29ee5b3 700
2f9ade3c
JA
701/*
702 * Memory helpers
703 */
9a3f1100
JA
704extern int __must_check fio_pin_memory(struct thread_data *);
705extern void fio_unpin_memory(struct thread_data *);
b2fdda43 706extern int __must_check allocate_io_mem(struct thread_data *);
2f9ade3c 707extern void free_io_mem(struct thread_data *);
2bb3f0a7 708extern void free_threads_shm(void);
2f9ade3c 709
248c9436
TK
710#ifdef FIO_INTERNAL
711#define PTR_ALIGN(ptr, mask) \
712 (char *) (((uintptr_t) (ptr) + (mask)) & ~(mask))
713#endif
714
b29ee5b3
JA
715/*
716 * Reset stats after ramp time completes
717 */
718extern void reset_all_stats(struct thread_data *);
719
40511301
JA
720extern int io_queue_event(struct thread_data *td, struct io_u *io_u, int *ret,
721 enum fio_ddir ddir, uint64_t *bytes_issued, int from_verify,
8b6a404c 722 struct timespec *comp_time);
40511301 723
3e260a46
JA
724/*
725 * Latency target helpers
726 */
727extern void lat_target_check(struct thread_data *);
728extern void lat_target_init(struct thread_data *);
6bb58215 729extern void lat_target_reset(struct thread_data *);
3e260a46 730
79591fa9
TK
731/*
732 * Iterates all threads/processes within all the defined jobs
733 */
34572e28 734#define for_each_td(td, i) \
2fbe1e19 735 for ((i) = 0, (td) = &segments[0].threads[0]; (i) < (int) thread_number; (i)++, (td) = tnumber_to_td((i)))
53cdc686 736#define for_each_file(td, f, i) \
691c8fb0
JA
737 if ((td)->files_index) \
738 for ((i) = 0, (f) = (td)->files[0]; \
739 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
740 (i)++)
53cdc686 741
8aa89d70 742static inline bool fio_fill_issue_time(struct thread_data *td)
12d9d841
JA
743{
744 if (td->o.read_iolog_file ||
745 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
8aa89d70 746 return true;
12d9d841 747
8aa89d70 748 return false;
12d9d841
JA
749}
750
5c81ff5e 751static inline bool option_check_rate(struct thread_data *td, enum fio_ddir ddir)
581e7141
JA
752{
753 struct thread_options *o = &td->o;
754
755 /*
756 * If some rate setting was given, we need to check it
757 */
758 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
759 o->rate_iops_min[ddir])
8aa89d70 760 return true;
581e7141 761
8aa89d70 762 return false;
581e7141
JA
763}
764
8aa89d70 765static inline bool should_check_rate(struct thread_data *td)
581e7141 766{
90711edc 767 return (td->flags & TD_F_CHECK_RATE) != 0;
581e7141
JA
768}
769
5fff9543 770static inline unsigned long long td_max_bs(struct thread_data *td)
74f4b020 771{
5fff9543 772 unsigned long long max_bs;
74f4b020
JA
773
774 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
775 return max(td->o.max_bs[DDIR_TRIM], max_bs);
776}
777
5fff9543 778static inline unsigned long long td_min_bs(struct thread_data *td)
8d916c94 779{
5fff9543 780 unsigned long long min_bs;
8d916c94
JA
781
782 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
783 return min(td->o.min_bs[DDIR_TRIM], min_bs);
784}
785
1651e431 786static inline bool td_async_processing(struct thread_data *td)
a9da8ab2
JA
787{
788 return (td->flags & TD_F_NEED_LOCK) != 0;
789}
790
1368d95b
VF
791static inline bool td_offload_overlap(struct thread_data *td)
792{
793 return td->o.serialize_overlap && td->o.io_submit_mode == IO_MODE_OFFLOAD;
794}
795
e8462bd8
JA
796/*
797 * We currently only need to do locking if we have verifier threads
798 * accessing our internal structures too
799 */
26b3a188 800static inline void __td_io_u_lock(struct thread_data *td)
e8462bd8 801{
26b3a188 802 pthread_mutex_lock(&td->io_u_lock);
e8462bd8
JA
803}
804
26b3a188 805static inline void __td_io_u_unlock(struct thread_data *td)
e8462bd8 806{
26b3a188 807 pthread_mutex_unlock(&td->io_u_lock);
e8462bd8
JA
808}
809
810static inline void td_io_u_free_notify(struct thread_data *td)
811{
a9da8ab2 812 if (td_async_processing(td))
e8462bd8
JA
813 pthread_cond_signal(&td->free_cond);
814}
815
1651e431
JA
816static inline void td_flags_clear(struct thread_data *td, unsigned int *flags,
817 unsigned int value)
818{
819 if (!td_async_processing(td))
820 *flags &= ~value;
821 else
822 __sync_fetch_and_and(flags, ~value);
823}
824
825static inline void td_flags_set(struct thread_data *td, unsigned int *flags,
826 unsigned int value)
827{
828 if (!td_async_processing(td))
829 *flags |= value;
830 else
831 __sync_fetch_and_or(flags, value);
832}
833
cca84643
JA
834extern const char *fio_get_arch_string(int);
835extern const char *fio_get_os_string(int);
836
f3afa57e 837enum {
129fb2d4
JA
838 __FIO_OUTPUT_TERSE = 0,
839 __FIO_OUTPUT_JSON = 1,
840 __FIO_OUTPUT_NORMAL = 2,
513e37ee
VF
841 __FIO_OUTPUT_JSON_PLUS = 3,
842 FIO_OUTPUT_NR = 4,
129fb2d4
JA
843
844 FIO_OUTPUT_TERSE = 1U << __FIO_OUTPUT_TERSE,
845 FIO_OUTPUT_JSON = 1U << __FIO_OUTPUT_JSON,
846 FIO_OUTPUT_NORMAL = 1U << __FIO_OUTPUT_NORMAL,
513e37ee 847 FIO_OUTPUT_JSON_PLUS = 1U << __FIO_OUTPUT_JSON_PLUS,
f3afa57e
JA
848};
849
e25839d4
JA
850enum {
851 FIO_RAND_DIST_RANDOM = 0,
852 FIO_RAND_DIST_ZIPF,
925fee33 853 FIO_RAND_DIST_PARETO,
56d9fa4b 854 FIO_RAND_DIST_GAUSS,
e0a04ac1 855 FIO_RAND_DIST_ZONED,
59466396 856 FIO_RAND_DIST_ZONED_ABS,
e25839d4
JA
857};
858
c95f9404
JA
859#define FIO_DEF_ZIPF 1.1
860#define FIO_DEF_PARETO 0.2
861
8055e41d
JA
862enum {
863 FIO_RAND_GEN_TAUSWORTHE = 0,
864 FIO_RAND_GEN_LFSR,
c3546b53 865 FIO_RAND_GEN_TAUSWORTHE64,
8055e41d
JA
866};
867
c2acfbac
JA
868enum {
869 FIO_CPUS_SHARED = 0,
870 FIO_CPUS_SPLIT,
871};
872
ca09be4b
JA
873extern void exec_trigger(const char *);
874extern void check_trigger_file(void);
875
c06379a6
VF
876extern bool in_flight_overlap(struct io_u_queue *q, struct io_u *io_u);
877extern pthread_mutex_t overlap_check;
878
fd745bf3
TK
879static inline void *fio_memalign(size_t alignment, size_t size, bool shared)
880{
881 return __fio_memalign(alignment, size, shared ? smalloc : malloc);
882}
883
884static inline void fio_memfree(void *ptr, size_t size, bool shared)
885{
886 return __fio_memfree(ptr, size, shared ? sfree : free);
887}
888
ebac4655 889#endif