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