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