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