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