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