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