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