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