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