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