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