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