docs: move rate_cycle description
[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,
eb314e70 166 F_ADV_NOREUSE,
ecb2083d
JA
167};
168
2a2804c9
JA
169/*
170 * Per-thread/process specific data. Only used for the network client
171 * for now.
172 */
24660963
JA
173void sk_out_assign(struct sk_out *);
174void sk_out_drop(void);
2a2804c9 175
e0a04ac1
JA
176struct zone_split_index {
177 uint8_t size_perc;
178 uint8_t size_perc_prev;
59466396
JA
179 uint64_t size;
180 uint64_t size_prev;
e0a04ac1
JA
181};
182
2dc1bbeb
JA
183/*
184 * This describes a single thread/process executing a fio job.
185 */
186struct thread_data {
c2292325 187 struct flist_head opt_list;
cf1f424a 188 unsigned long long flags;
d7e9266c 189 struct thread_options o;
de890a1e 190 void *eo;
2dc1bbeb 191 pthread_t thread;
2f122b13 192 unsigned int thread_number;
69bdd6ba 193 unsigned int subjob_number;
2f122b13 194 unsigned int groupid;
b2fcbe01 195 struct thread_stat ts __attribute__ ((aligned(8)));
7b9f733a 196
46bcd498
JA
197 int client_type;
198
7b9f733a
JA
199 struct io_log *slat_log;
200 struct io_log *clat_log;
1e613c9c 201 struct io_log *clat_hist_log;
7b9f733a
JA
202 struct io_log *lat_log;
203 struct io_log *bw_log;
c8eeb9df 204 struct io_log *iops_log;
7b9f733a 205
155f2f02 206 struct workqueue log_compress_wq;
aee2ab67 207
a9da8ab2
JA
208 struct thread_data *parent;
209
6eaf09d6 210 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
8b6a404c 211 struct timespec bw_sample_time;
c8eeb9df 212
6eaf09d6 213 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
8b6a404c 214 struct timespec iops_sample_time;
f0505a14 215
c97f1ad6 216 volatile int update_rusage;
971caeb1 217 struct fio_sem *rusage_sem;
c8aaba19
JA
218 struct rusage ru_start;
219 struct rusage ru_end;
220
126d65c6 221 struct fio_file **files;
d7df1d13 222 unsigned char *file_locks;
dd87b2c9 223 unsigned int files_size;
2dc1bbeb
JA
224 unsigned int files_index;
225 unsigned int nr_open_files;
1020a139 226 unsigned int nr_done_files;
2dc1bbeb
JA
227 union {
228 unsigned int next_file;
d6b72507 229 struct frand_state next_file_state;
2dc1bbeb 230 };
8c07860d
JA
231 union {
232 struct zipf_state next_file_zipf;
233 struct gauss_state next_file_gauss;
234 };
235 union {
236 double zipf_theta;
237 double pareto_h;
238 double gauss_dev;
239 };
a87c90fd 240 double random_center;
2dc1bbeb 241 int error;
a5e371a6 242 int sig;
20e354ef 243 int done;
ca09be4b 244 int stop_io;
2dc1bbeb
JA
245 pid_t pid;
246 char *orig_buffer;
247 size_t orig_buffer_size;
2dc1bbeb 248 volatile int runstate;
2ea93f98
JA
249 volatile bool terminate;
250 bool last_was_sync;
9e144189 251 enum fio_ddir last_ddir;
2dc1bbeb 252
2dc1bbeb
JA
253 int mmapfd;
254
843a7413
JA
255 void *iolog_buf;
256 FILE *iolog_f;
ebac4655 257
9781c080 258 uint64_t rand_seeds[FIO_RAND_NR_OFFS];
5bfc35d7 259
2f282cec 260 struct frand_state bsrange_state[DDIR_RWDIR_CNT];
d6b72507 261 struct frand_state verify_state;
50eaefa5 262 struct frand_state verify_state_last_do_io;
d6b72507
JA
263 struct frand_state trim_state;
264 struct frand_state delay_state;
ebac4655 265
3545a109 266 struct frand_state buf_state;
5c94b008 267 struct frand_state buf_state_prev;
c75f1778 268 struct frand_state buf_state_ret;
5c94b008 269 struct frand_state dedupe_state;
e0a04ac1 270 struct frand_state zone_state;
b2a432bf 271 struct frand_state prio_state;
0d71aa98
BD
272 struct frand_state dedupe_working_set_index_state;
273 struct frand_state *dedupe_working_set_states;
274
275 unsigned long long num_unique_pages;
e0a04ac1
JA
276
277 struct zone_split_index **zone_state_index;
219c662d 278 unsigned int num_open_zones;
3545a109 279
9e144189 280 unsigned int verify_batch;
0d29de83 281 unsigned int trim_batch;
9e144189 282
ca09be4b
JA
283 struct thread_io_list *vstate;
284
ebac4655
JA
285 int shm_id;
286
1437d635
DLM
287 /*
288 * Job default IO priority set with prioclass and prio options.
289 */
290 unsigned int ioprio;
291
e9c047a0
JA
292 /*
293 * IO engine hooks, contains everything needed to submit an io_u
294 * to any of the available IO engines.
295 */
2866c82d 296 struct ioengine_ops *io_ops;
356ef1a1 297 int io_ops_init;
ebac4655 298
565e784d
TK
299 /*
300 * IO engine private data and dlhandle.
301 */
302 void *io_ops_data;
565e784d 303
e9c047a0 304 /*
422f9e4b 305 * Queue depth of io_u's that fio MIGHT do
e9c047a0 306 */
ebac4655 307 unsigned int cur_depth;
422f9e4b
RM
308
309 /*
310 * io_u's about to be committed
311 */
d8005759 312 unsigned int io_u_queued;
422f9e4b
RM
313
314 /*
315 * io_u's submitted but not completed yet
316 */
317 unsigned int io_u_in_flight;
318
319 /*
320 * List of free and busy io_u's
321 */
2ae0b204
JA
322 struct io_u_ring io_u_requeues;
323 struct io_u_queue io_u_freelist;
324 struct io_u_queue io_u_all;
e8462bd8
JA
325 pthread_mutex_t io_u_lock;
326 pthread_cond_t free_cond;
327
328 /*
329 * async verify offload
330 */
331 struct flist_head verify_list;
332 pthread_t *verify_threads;
333 unsigned int nr_verify_threads;
334 pthread_cond_t verify_cond;
335 int verify_thread_exit;
ebac4655 336
e9c047a0
JA
337 /*
338 * Rate state
339 */
bdb6d20a 340 uint64_t rate_bps[DDIR_RWDIR_CNT];
90eff1c9 341 uint64_t rate_next_io_time[DDIR_RWDIR_CNT];
f5204b8a 342 unsigned long long last_rate_check_bytes[DDIR_RWDIR_CNT];
343 unsigned long last_rate_check_blocks[DDIR_RWDIR_CNT];
90eff1c9 344 unsigned long long rate_io_issue_bytes[DDIR_RWDIR_CNT];
f5204b8a 345 struct timespec last_rate_check_time[DDIR_RWDIR_CNT];
6c8611c7
JA
346 int64_t last_usec[DDIR_RWDIR_CNT];
347 struct frand_state poisson_state[DDIR_RWDIR_CNT];
ebac4655 348
a9da8ab2
JA
349 /*
350 * Enforced rate submission/completion workqueue
351 */
352 struct workqueue io_wq;
353
bdb6d20a
JA
354 uint64_t total_io_size;
355 uint64_t fill_device_size;
ebac4655 356
74d6277f
JA
357 /*
358 * Issue side
359 */
ca09be4b 360 uint64_t io_issues[DDIR_RWDIR_CNT];
28921bc0 361 uint64_t verify_read_issues;
74d6277f 362 uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
cf8a46a7 363 uint64_t loops;
74d6277f
JA
364
365 /*
366 * Completions
367 */
bdb6d20a
JA
368 uint64_t io_blocks[DDIR_RWDIR_CNT];
369 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
370 uint64_t io_bytes[DDIR_RWDIR_CNT];
bdb6d20a 371 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
55312f9f 372 uint64_t io_skip_bytes;
bdb6d20a 373 uint64_t zone_bytes;
971caeb1 374 struct fio_sem *sem;
55312f9f 375 uint64_t bytes_done[DDIR_RWDIR_CNT];
191d6634 376 uint64_t bytes_verified;
ebac4655 377
33f42c20 378 uint64_t *thinktime_blocks_counter;
f7942acd 379 struct timespec last_thinktime;
cfc4ad2e 380 int64_t last_thinktime_blocks;
33f42c20 381
e9c047a0
JA
382 /*
383 * State for random io, a bitmap of blocks done vs not done
384 */
d6b72507 385 struct frand_state random_state;
ebac4655 386
8b6a404c
VF
387 struct timespec start; /* start of this loop */
388 struct timespec epoch; /* time job was started */
d5b3cfd4 389 unsigned long long alternate_epoch; /* Time job was started, clock_gettime's clock_id epoch based. */
8b6a404c 390 struct timespec last_issue;
df8fb609 391 long time_offset;
8b6a404c
VF
392 struct timespec ts_cache;
393 struct timespec terminate_time;
394 unsigned int ts_cache_nr;
395 unsigned int ts_cache_mask;
49f3f914 396 bool ramp_time_over;
ebac4655 397
3e260a46
JA
398 /*
399 * Time since last latency_window was started
400 */
8b6a404c 401 struct timespec latency_ts;
3e260a46
JA
402 unsigned int latency_qd;
403 unsigned int latency_qd_high;
404 unsigned int latency_qd_low;
405 unsigned int latency_failed;
e1bcd541 406 unsigned int latency_stable_count;
3e260a46 407 uint64_t latency_ios;
6bb58215 408 int latency_end_run;
3e260a46 409
e9c047a0
JA
410 /*
411 * read/write mixed workload state
412 */
d6b72507 413 struct frand_state rwmix_state;
e4928662 414 unsigned long rwmix_issues;
e9c047a0 415 enum fio_ddir rwmix_ddir;
5736c10d 416 unsigned int ddir_seq_nr;
a6ccc7be 417
211c9b89
JA
418 /*
419 * rand/seq mixed workload state
420 */
d6b72507 421 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
211c9b89 422
e9c047a0 423 /*
8de8f047
JA
424 * IO history logs for verification. We use a tree for sorting,
425 * if we are overwriting. Otherwise just use a fifo.
e9c047a0 426 */
4b87898e 427 struct rb_root io_hist_tree;
01743ee1 428 struct flist_head io_hist_list;
9e144189 429 unsigned long io_hist_len;
8de8f047
JA
430
431 /*
432 * For IO replaying
433 */
01743ee1 434 struct flist_head io_log_list;
98e7161c 435 FILE *io_log_rfile;
b61fdc8a 436 unsigned int io_log_blktrace;
10f74940 437 unsigned int io_log_blktrace_swap;
315bbf01 438 unsigned long long io_log_last_ttime;
e8cf24e5 439 struct timespec io_log_start_time;
98e7161c
AK
440 unsigned int io_log_current;
441 unsigned int io_log_checkmark;
442 unsigned int io_log_highmark;
315bbf01 443 unsigned int io_log_version;
98e7161c 444 struct timespec io_log_highmark_time;
433afcb4 445
0d29de83
JA
446 /*
447 * For tracking/handling discards
448 */
449 struct flist_head trim_list;
450 unsigned long trim_entries;
451
1907dbc6
JA
452 /*
453 * for fileservice, how often to switch to a new file
454 */
455 unsigned int file_service_nr;
456 unsigned int file_service_left;
457 struct fio_file *file_service_file;
9c60ce64 458
44f29692
JA
459 unsigned int sync_file_range_nr;
460
9c60ce64
JA
461 /*
462 * For generating file sizes
463 */
d6b72507 464 struct frand_state file_size_state;
f2bba182
RR
465
466 /*
467 * Error counts
468 */
469 unsigned int total_err_count;
470 int first_error;
15dc1934 471
9e684a49 472 struct fio_flow *flow;
d4e74fda 473 unsigned long long flow_counter;
9e684a49 474
15dc1934
JA
475 /*
476 * Can be overloaded by profiles
477 */
7eb36574 478 struct prof_io_ops prof_io_ops;
58c55ba0 479 void *prof_data;
9a3f1100
JA
480
481 void *pinned_mem;
d7e9266c 482
16e56d25
VF
483 struct steadystate_data ss;
484
d7e9266c 485 char verror[FIO_VERROR_SIZE];
03553853
YR
486
487#ifdef CONFIG_CUDA
488 /*
489 * for GPU memory management
490 */
491 int gpu_dev_cnt;
492 int gpu_dev_id;
493 CUdevice cu_dev;
494 CUcontext cu_ctx;
495 CUdeviceptr dev_mem_ptr;
7a4e480d 496#endif
03553853 497
ebac4655
JA
498};
499
d41647e6
JA
500struct thread_segment {
501 struct thread_data *threads;
502 int shm_id;
2fbe1e19 503 int nr_threads;
d41647e6
JA
504};
505
e592a06b
AC
506/*
507 * when should interactive ETA output be generated
508 */
509enum {
510 FIO_ETA_AUTO,
511 FIO_ETA_ALWAYS,
512 FIO_ETA_NEVER,
513};
514
e1161c32 515#define __td_verror(td, err, msg, func) \
ebac4655 516 do { \
21beb609 517 unsigned int ____e = (err); \
19abcd3d
JA
518 if ((td)->error) \
519 break; \
8271963e 520 (td)->error = ____e; \
f2bba182 521 if (!(td)->first_error) \
b4d2bc70
BVA
522 nowarn_snprintf(td->verror, sizeof(td->verror), \
523 "file:%s:%d, func=%s, error=%s", \
524 __FILE__, __LINE__, (func), (msg)); \
ebac4655
JA
525 } while (0)
526
b990b5c0 527
a9da8ab2
JA
528#define td_clear_error(td) do { \
529 (td)->error = 0; \
530 if ((td)->parent) \
531 (td)->parent->error = 0; \
532} while (0)
533
534#define td_verror(td, err, func) do { \
535 __td_verror((td), (err), strerror((err)), (func)); \
536 if ((td)->parent) \
537 __td_verror((td)->parent, (err), strerror((err)), (func)); \
538} while (0)
539
540#define td_vmsg(td, err, msg, func) do { \
541 __td_verror((td), (err), (msg), (func)); \
542 if ((td)->parent) \
543 __td_verror((td)->parent, (err), (msg), (func)); \
544} while (0)
b990b5c0 545
81179eec
JA
546#define __fio_stringify_1(x) #x
547#define __fio_stringify(x) __fio_stringify_1(x)
548
d41647e6
JA
549#define REAL_MAX_JOBS 4096
550#define JOBS_PER_SEG 8
551#define REAL_MAX_SEG (REAL_MAX_JOBS / JOBS_PER_SEG)
552
f1867a7f 553extern bool exitall_on_terminate;
11e950bd 554extern unsigned int thread_number;
108fea77 555extern unsigned int stat_number;
2fbe1e19
JA
556extern unsigned int nr_segments;
557extern unsigned int cur_segment;
ebac4655 558extern int groupid;
f3afa57e 559extern int output_format;
2b8c71b0 560extern int append_terse_output;
53cdc686 561extern int temp_stall_ts;
7078106d 562extern uintptr_t page_mask, page_size;
f1867a7f 563extern bool read_only;
e592a06b 564extern int eta_print;
e382e661 565extern int eta_new_line;
db37d890 566extern unsigned int eta_interval_msec;
d3eeeabc 567extern unsigned long done_secs;
be4ecfdf
JA
568extern int fio_gtod_offload;
569extern int fio_gtod_cpu;
c223da83 570extern enum fio_cs fio_clock_source;
fa80feae 571extern int fio_clock_source_set;
a9523c6f 572extern int warnings_fatal;
f57a9c59 573extern int terse_version;
f1867a7f
JA
574extern bool is_backend;
575extern bool is_local_backend;
a37f69b7 576extern int nr_clients;
f1867a7f 577extern bool log_syslog;
06464907 578extern int status_interval;
5e726d0a 579extern const char fio_version_string[];
ca09be4b
JA
580extern char *trigger_file;
581extern char *trigger_cmd;
b63efd30 582extern char *trigger_remote_cmd;
ca09be4b 583extern long long trigger_timeout;
d264264a 584extern char *aux_path;
ebac4655 585
d41647e6 586extern struct thread_segment segments[REAL_MAX_SEG];
ebac4655 587
2fbe1e19
JA
588static inline struct thread_data *tnumber_to_td(unsigned int tnumber)
589{
590 struct thread_segment *seg;
591
592 seg = &segments[tnumber / JOBS_PER_SEG];
593 return &seg->threads[tnumber & (JOBS_PER_SEG - 1)];
594}
595
24a97130
LC
596static inline bool is_running_backend(void)
597{
598 return is_backend || is_local_backend;
599}
600
db37d890
JA
601extern bool eta_time_within_slack(unsigned int time);
602
effd6ff0 603static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
7101d9c2 604{
196ccc44
VF
605 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)) &&
606 !(io_u->ddir == DDIR_TRIM && !td_trim(td)));
7101d9c2
JA
607}
608
a3eb1a1e 609static inline bool should_fsync(struct thread_data *td)
87dc1ab1
JA
610{
611 if (td->last_was_sync)
a3eb1a1e 612 return false;
dcf9844e 613 if (td_write(td) || td->o.override_sync)
a3eb1a1e 614 return true;
87dc1ab1 615
a3eb1a1e 616 return false;
87dc1ab1
JA
617}
618
8914a9d8 619/*
214e1eca 620 * Init/option functions
8914a9d8 621 */
0420ba6a 622extern int __must_check fio_init_options(void);
72cb971b 623extern int __must_check parse_options(int, char **);
46bcd498
JA
624extern int parse_jobs_ini(char *, int, int, int);
625extern int parse_cmd_line(int, char **, int);
24660963 626extern int fio_backend(struct sk_out *);
50d16976 627extern void reset_fio_state(void);
ac28d905 628extern void clear_io_state(struct thread_data *, int);
c2292325 629extern int fio_options_parse(struct thread_data *, char **, int);
74929ac2 630extern void fio_keywords_init(void);
af1dc266 631extern void fio_keywords_exit(void);
214e1eca 632extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
de890a1e 633extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
214e1eca
JA
634extern void fio_fill_default_options(struct thread_data *);
635extern int fio_show_option_help(const char *);
de890a1e 636extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
214e1eca 637extern void fio_options_dup_and_init(struct option *);
b4f5e72f 638extern char *fio_option_dup_subs(const char *);
de890a1e 639extern void fio_options_mem_dupe(struct thread_data *);
5bfc35d7 640extern void td_fill_rand_seeds(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
da8f124f
H
756 * Usage:
757 * for_each_td(var_name_for_td) {
758 * << bodoy of your loop >>
759 * Note: internally-scoped loop index availble as __td_index
760 * } end_for_each_td()
79591fa9 761 */
da8f124f
H
762#define for_each_td(td) \
763{ \
764 int __td_index; \
765 struct thread_data *(td); \
766 for (__td_index = 0, (td) = &segments[0].threads[0];\
767 __td_index < (int) thread_number; __td_index++, (td) = tnumber_to_td(__td_index))
768#define for_each_td_index() \
769{ \
770 int __td_index; \
771 for (__td_index = 0; __td_index < (int) thread_number; __td_index++)
772#define end_for_each() }
773
53cdc686 774#define for_each_file(td, f, i) \
691c8fb0
JA
775 if ((td)->files_index) \
776 for ((i) = 0, (f) = (td)->files[0]; \
777 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
778 (i)++)
53cdc686 779
8aa89d70 780static inline bool fio_fill_issue_time(struct thread_data *td)
12d9d841
JA
781{
782 if (td->o.read_iolog_file ||
783 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
8aa89d70 784 return true;
12d9d841 785
8aa89d70 786 return false;
12d9d841
JA
787}
788
5c81ff5e 789static inline bool option_check_rate(struct thread_data *td, enum fio_ddir ddir)
581e7141
JA
790{
791 struct thread_options *o = &td->o;
792
793 /*
794 * If some rate setting was given, we need to check it
795 */
796 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
797 o->rate_iops_min[ddir])
8aa89d70 798 return true;
581e7141 799
8aa89d70 800 return false;
581e7141
JA
801}
802
8aa89d70 803static inline bool should_check_rate(struct thread_data *td)
581e7141 804{
90711edc 805 return (td->flags & TD_F_CHECK_RATE) != 0;
581e7141
JA
806}
807
5fff9543 808static inline unsigned long long td_max_bs(struct thread_data *td)
74f4b020 809{
5fff9543 810 unsigned long long max_bs;
74f4b020
JA
811
812 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
813 return max(td->o.max_bs[DDIR_TRIM], max_bs);
814}
815
5fff9543 816static inline unsigned long long td_min_bs(struct thread_data *td)
8d916c94 817{
5fff9543 818 unsigned long long min_bs;
8d916c94
JA
819
820 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
821 return min(td->o.min_bs[DDIR_TRIM], min_bs);
822}
823
1651e431 824static inline bool td_async_processing(struct thread_data *td)
a9da8ab2
JA
825{
826 return (td->flags & TD_F_NEED_LOCK) != 0;
827}
828
1368d95b
VF
829static inline bool td_offload_overlap(struct thread_data *td)
830{
831 return td->o.serialize_overlap && td->o.io_submit_mode == IO_MODE_OFFLOAD;
832}
833
e8462bd8
JA
834/*
835 * We currently only need to do locking if we have verifier threads
836 * accessing our internal structures too
837 */
26b3a188 838static inline void __td_io_u_lock(struct thread_data *td)
e8462bd8 839{
26b3a188 840 pthread_mutex_lock(&td->io_u_lock);
e8462bd8
JA
841}
842
26b3a188 843static inline void __td_io_u_unlock(struct thread_data *td)
e8462bd8 844{
26b3a188 845 pthread_mutex_unlock(&td->io_u_lock);
e8462bd8
JA
846}
847
848static inline void td_io_u_free_notify(struct thread_data *td)
849{
a9da8ab2 850 if (td_async_processing(td))
e8462bd8
JA
851 pthread_cond_signal(&td->free_cond);
852}
853
1651e431
JA
854static inline void td_flags_clear(struct thread_data *td, unsigned int *flags,
855 unsigned int value)
856{
857 if (!td_async_processing(td))
858 *flags &= ~value;
859 else
860 __sync_fetch_and_and(flags, ~value);
861}
862
863static inline void td_flags_set(struct thread_data *td, unsigned int *flags,
864 unsigned int value)
865{
866 if (!td_async_processing(td))
867 *flags |= value;
868 else
869 __sync_fetch_and_or(flags, value);
870}
871
cca84643
JA
872extern const char *fio_get_arch_string(int);
873extern const char *fio_get_os_string(int);
874
f3afa57e 875enum {
129fb2d4
JA
876 __FIO_OUTPUT_TERSE = 0,
877 __FIO_OUTPUT_JSON = 1,
878 __FIO_OUTPUT_NORMAL = 2,
513e37ee
VF
879 __FIO_OUTPUT_JSON_PLUS = 3,
880 FIO_OUTPUT_NR = 4,
129fb2d4
JA
881
882 FIO_OUTPUT_TERSE = 1U << __FIO_OUTPUT_TERSE,
883 FIO_OUTPUT_JSON = 1U << __FIO_OUTPUT_JSON,
884 FIO_OUTPUT_NORMAL = 1U << __FIO_OUTPUT_NORMAL,
513e37ee 885 FIO_OUTPUT_JSON_PLUS = 1U << __FIO_OUTPUT_JSON_PLUS,
f3afa57e
JA
886};
887
e25839d4
JA
888enum {
889 FIO_RAND_DIST_RANDOM = 0,
890 FIO_RAND_DIST_ZIPF,
925fee33 891 FIO_RAND_DIST_PARETO,
56d9fa4b 892 FIO_RAND_DIST_GAUSS,
e0a04ac1 893 FIO_RAND_DIST_ZONED,
59466396 894 FIO_RAND_DIST_ZONED_ABS,
e25839d4
JA
895};
896
c95f9404
JA
897#define FIO_DEF_ZIPF 1.1
898#define FIO_DEF_PARETO 0.2
899
8055e41d
JA
900enum {
901 FIO_RAND_GEN_TAUSWORTHE = 0,
902 FIO_RAND_GEN_LFSR,
c3546b53 903 FIO_RAND_GEN_TAUSWORTHE64,
8055e41d
JA
904};
905
c2acfbac
JA
906enum {
907 FIO_CPUS_SHARED = 0,
908 FIO_CPUS_SPLIT,
909};
910
ca09be4b
JA
911extern void exec_trigger(const char *);
912extern void check_trigger_file(void);
913
c06379a6
VF
914extern bool in_flight_overlap(struct io_u_queue *q, struct io_u *io_u);
915extern pthread_mutex_t overlap_check;
916
fd745bf3
TK
917static inline void *fio_memalign(size_t alignment, size_t size, bool shared)
918{
919 return __fio_memalign(alignment, size, shared ? smalloc : malloc);
920}
921
922static inline void fio_memfree(void *ptr, size_t size, bool shared)
923{
924 return __fio_memfree(ptr, size, shared ? sfree : free);
925}
926
ebac4655 927#endif