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