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