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