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