rand: make randX_upto() do the end value increment
[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
2dc1bbeb
JA
170/*
171 * This describes a single thread/process executing a fio job.
172 */
173struct thread_data {
c2292325 174 struct flist_head opt_list;
d72be545 175 unsigned long flags;
d7e9266c 176 struct thread_options o;
de890a1e 177 void *eo;
2dc1bbeb 178 pthread_t thread;
2f122b13 179 unsigned int thread_number;
69bdd6ba 180 unsigned int subjob_number;
2f122b13 181 unsigned int groupid;
b2fcbe01 182 struct thread_stat ts __attribute__ ((aligned(8)));
7b9f733a 183
46bcd498
JA
184 int client_type;
185
7b9f733a
JA
186 struct io_log *slat_log;
187 struct io_log *clat_log;
1e613c9c 188 struct io_log *clat_hist_log;
7b9f733a
JA
189 struct io_log *lat_log;
190 struct io_log *bw_log;
c8eeb9df 191 struct io_log *iops_log;
7b9f733a 192
155f2f02 193 struct workqueue log_compress_wq;
aee2ab67 194
a9da8ab2
JA
195 struct thread_data *parent;
196
6eaf09d6 197 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
8b6a404c 198 struct timespec bw_sample_time;
c8eeb9df 199
6eaf09d6 200 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
8b6a404c 201 struct timespec iops_sample_time;
f0505a14 202
c97f1ad6 203 volatile int update_rusage;
971caeb1 204 struct fio_sem *rusage_sem;
c8aaba19
JA
205 struct rusage ru_start;
206 struct rusage ru_end;
207
126d65c6 208 struct fio_file **files;
d7df1d13 209 unsigned char *file_locks;
dd87b2c9 210 unsigned int files_size;
2dc1bbeb
JA
211 unsigned int files_index;
212 unsigned int nr_open_files;
1020a139 213 unsigned int nr_done_files;
2dc1bbeb
JA
214 union {
215 unsigned int next_file;
d6b72507 216 struct frand_state next_file_state;
2dc1bbeb 217 };
8c07860d
JA
218 union {
219 struct zipf_state next_file_zipf;
220 struct gauss_state next_file_gauss;
221 };
222 union {
223 double zipf_theta;
224 double pareto_h;
225 double gauss_dev;
226 };
2dc1bbeb 227 int error;
a5e371a6 228 int sig;
20e354ef 229 int done;
ca09be4b 230 int stop_io;
2dc1bbeb
JA
231 pid_t pid;
232 char *orig_buffer;
233 size_t orig_buffer_size;
2dc1bbeb 234 volatile int runstate;
2ea93f98
JA
235 volatile bool terminate;
236 bool last_was_sync;
9e144189 237 enum fio_ddir last_ddir;
2dc1bbeb 238
2dc1bbeb
JA
239 int mmapfd;
240
843a7413
JA
241 void *iolog_buf;
242 FILE *iolog_f;
ebac4655 243
d24945f0 244 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
5bfc35d7 245
2f282cec 246 struct frand_state bsrange_state[DDIR_RWDIR_CNT];
d6b72507
JA
247 struct frand_state verify_state;
248 struct frand_state trim_state;
249 struct frand_state delay_state;
ebac4655 250
3545a109 251 struct frand_state buf_state;
5c94b008
JA
252 struct frand_state buf_state_prev;
253 struct frand_state dedupe_state;
e0a04ac1
JA
254 struct frand_state zone_state;
255
256 struct zone_split_index **zone_state_index;
3545a109 257
9e144189 258 unsigned int verify_batch;
0d29de83 259 unsigned int trim_batch;
9e144189 260
ca09be4b
JA
261 struct thread_io_list *vstate;
262
ebac4655
JA
263 int shm_id;
264
e9c047a0
JA
265 /*
266 * IO engine hooks, contains everything needed to submit an io_u
267 * to any of the available IO engines.
268 */
2866c82d 269 struct ioengine_ops *io_ops;
356ef1a1 270 int io_ops_init;
ebac4655 271
565e784d
TK
272 /*
273 * IO engine private data and dlhandle.
274 */
275 void *io_ops_data;
276 void *io_ops_dlhandle;
277
e9c047a0 278 /*
422f9e4b 279 * Queue depth of io_u's that fio MIGHT do
e9c047a0 280 */
ebac4655 281 unsigned int cur_depth;
422f9e4b
RM
282
283 /*
284 * io_u's about to be committed
285 */
d8005759 286 unsigned int io_u_queued;
422f9e4b
RM
287
288 /*
289 * io_u's submitted but not completed yet
290 */
291 unsigned int io_u_in_flight;
292
293 /*
294 * List of free and busy io_u's
295 */
2ae0b204
JA
296 struct io_u_ring io_u_requeues;
297 struct io_u_queue io_u_freelist;
298 struct io_u_queue io_u_all;
e8462bd8
JA
299 pthread_mutex_t io_u_lock;
300 pthread_cond_t free_cond;
301
302 /*
303 * async verify offload
304 */
305 struct flist_head verify_list;
306 pthread_t *verify_threads;
307 unsigned int nr_verify_threads;
308 pthread_cond_t verify_cond;
309 int verify_thread_exit;
ebac4655 310
e9c047a0
JA
311 /*
312 * Rate state
313 */
bdb6d20a 314 uint64_t rate_bps[DDIR_RWDIR_CNT];
90eff1c9 315 uint64_t rate_next_io_time[DDIR_RWDIR_CNT];
6eaf09d6
SL
316 unsigned long rate_bytes[DDIR_RWDIR_CNT];
317 unsigned long rate_blocks[DDIR_RWDIR_CNT];
90eff1c9 318 unsigned long long rate_io_issue_bytes[DDIR_RWDIR_CNT];
8b6a404c 319 struct timespec lastrate[DDIR_RWDIR_CNT];
6c8611c7
JA
320 int64_t last_usec[DDIR_RWDIR_CNT];
321 struct frand_state poisson_state[DDIR_RWDIR_CNT];
ebac4655 322
a9da8ab2
JA
323 /*
324 * Enforced rate submission/completion workqueue
325 */
326 struct workqueue io_wq;
327
bdb6d20a
JA
328 uint64_t total_io_size;
329 uint64_t fill_device_size;
ebac4655 330
74d6277f
JA
331 /*
332 * Issue side
333 */
ca09be4b 334 uint64_t io_issues[DDIR_RWDIR_CNT];
74d6277f 335 uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
cf8a46a7 336 uint64_t loops;
74d6277f
JA
337
338 /*
339 * Completions
340 */
bdb6d20a
JA
341 uint64_t io_blocks[DDIR_RWDIR_CNT];
342 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
343 uint64_t io_bytes[DDIR_RWDIR_CNT];
bdb6d20a 344 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
55312f9f 345 uint64_t io_skip_bytes;
bdb6d20a 346 uint64_t zone_bytes;
971caeb1 347 struct fio_sem *sem;
55312f9f 348 uint64_t bytes_done[DDIR_RWDIR_CNT];
ebac4655 349
e9c047a0
JA
350 /*
351 * State for random io, a bitmap of blocks done vs not done
352 */
d6b72507 353 struct frand_state random_state;
ebac4655 354
8b6a404c
VF
355 struct timespec start; /* start of this loop */
356 struct timespec epoch; /* time job was started */
3aea75b1 357 unsigned long long unix_epoch; /* Time job was started, unix epoch based. */
8b6a404c 358 struct timespec last_issue;
df8fb609 359 long time_offset;
8b6a404c
VF
360 struct timespec ts_cache;
361 struct timespec terminate_time;
362 unsigned int ts_cache_nr;
363 unsigned int ts_cache_mask;
49f3f914 364 bool ramp_time_over;
ebac4655 365
3e260a46
JA
366 /*
367 * Time since last latency_window was started
368 */
8b6a404c 369 struct timespec latency_ts;
3e260a46
JA
370 unsigned int latency_qd;
371 unsigned int latency_qd_high;
372 unsigned int latency_qd_low;
373 unsigned int latency_failed;
374 uint64_t latency_ios;
6bb58215 375 int latency_end_run;
3e260a46 376
e9c047a0
JA
377 /*
378 * read/write mixed workload state
379 */
d6b72507 380 struct frand_state rwmix_state;
e4928662 381 unsigned long rwmix_issues;
e9c047a0 382 enum fio_ddir rwmix_ddir;
5736c10d 383 unsigned int ddir_seq_nr;
a6ccc7be 384
211c9b89
JA
385 /*
386 * rand/seq mixed workload state
387 */
d6b72507 388 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
211c9b89 389
e9c047a0 390 /*
8de8f047
JA
391 * IO history logs for verification. We use a tree for sorting,
392 * if we are overwriting. Otherwise just use a fifo.
e9c047a0 393 */
4b87898e 394 struct rb_root io_hist_tree;
01743ee1 395 struct flist_head io_hist_list;
9e144189 396 unsigned long io_hist_len;
8de8f047
JA
397
398 /*
399 * For IO replaying
400 */
01743ee1 401 struct flist_head io_log_list;
433afcb4 402
0d29de83
JA
403 /*
404 * For tracking/handling discards
405 */
406 struct flist_head trim_list;
407 unsigned long trim_entries;
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) \
b4d2bc70
BVA
472 nowarn_snprintf(td->verror, sizeof(td->verror), \
473 "file:%s:%d, func=%s, error=%s", \
474 __FILE__, __LINE__, (func), (msg)); \
ebac4655
JA
475 } while (0)
476
b990b5c0 477
a9da8ab2
JA
478#define td_clear_error(td) do { \
479 (td)->error = 0; \
480 if ((td)->parent) \
481 (td)->parent->error = 0; \
482} while (0)
483
484#define td_verror(td, err, func) do { \
485 __td_verror((td), (err), strerror((err)), (func)); \
486 if ((td)->parent) \
487 __td_verror((td)->parent, (err), strerror((err)), (func)); \
488} while (0)
489
490#define td_vmsg(td, err, msg, func) do { \
491 __td_verror((td), (err), (msg), (func)); \
492 if ((td)->parent) \
493 __td_verror((td)->parent, (err), (msg), (func)); \
494} while (0)
b990b5c0 495
81179eec
JA
496#define __fio_stringify_1(x) #x
497#define __fio_stringify(x) __fio_stringify_1(x)
498
ebac4655 499extern int exitall_on_terminate;
11e950bd 500extern unsigned int thread_number;
108fea77 501extern unsigned int stat_number;
ebac4655
JA
502extern int shm_id;
503extern int groupid;
f3afa57e 504extern int output_format;
2b8c71b0 505extern int append_terse_output;
53cdc686 506extern int temp_stall_ts;
7078106d 507extern uintptr_t page_mask, page_size;
4241ea8f 508extern int read_only;
e592a06b 509extern int eta_print;
e382e661 510extern int eta_new_line;
db37d890 511extern unsigned int eta_interval_msec;
d3eeeabc 512extern unsigned long done_secs;
be4ecfdf
JA
513extern int fio_gtod_offload;
514extern int fio_gtod_cpu;
c223da83 515extern enum fio_cs fio_clock_source;
fa80feae 516extern int fio_clock_source_set;
a9523c6f 517extern int warnings_fatal;
f57a9c59 518extern int terse_version;
5c341e9a 519extern int is_backend;
a37f69b7 520extern int nr_clients;
e46d8091 521extern int log_syslog;
06464907 522extern int status_interval;
5e726d0a 523extern const char fio_version_string[];
ca09be4b
JA
524extern char *trigger_file;
525extern char *trigger_cmd;
b63efd30 526extern char *trigger_remote_cmd;
ca09be4b 527extern long long trigger_timeout;
d264264a 528extern char *aux_path;
ebac4655
JA
529
530extern struct thread_data *threads;
531
db37d890
JA
532extern bool eta_time_within_slack(unsigned int time);
533
effd6ff0 534static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
7101d9c2
JA
535{
536 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
537}
538
cab2472e 539#define REAL_MAX_JOBS 4096
ebac4655 540
87dc1ab1
JA
541static inline int should_fsync(struct thread_data *td)
542{
543 if (td->last_was_sync)
544 return 0;
dcf9844e 545 if (td_write(td) || td->o.override_sync)
87dc1ab1
JA
546 return 1;
547
548 return 0;
549}
550
8914a9d8 551/*
214e1eca 552 * Init/option functions
8914a9d8 553 */
0420ba6a 554extern int __must_check fio_init_options(void);
72cb971b 555extern int __must_check parse_options(int, char **);
46bcd498
JA
556extern int parse_jobs_ini(char *, int, int, int);
557extern int parse_cmd_line(int, char **, int);
24660963 558extern int fio_backend(struct sk_out *);
50d16976 559extern void reset_fio_state(void);
ac28d905 560extern void clear_io_state(struct thread_data *, int);
c2292325 561extern int fio_options_parse(struct thread_data *, char **, int);
74929ac2 562extern void fio_keywords_init(void);
af1dc266 563extern void fio_keywords_exit(void);
214e1eca 564extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
de890a1e 565extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
214e1eca
JA
566extern void fio_fill_default_options(struct thread_data *);
567extern int fio_show_option_help(const char *);
de890a1e 568extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
214e1eca 569extern void fio_options_dup_and_init(struct option *);
de890a1e 570extern void fio_options_mem_dupe(struct thread_data *);
5bfc35d7 571extern void td_fill_rand_seeds(struct thread_data *);
8f380de2 572extern void td_fill_verify_state_seed(struct thread_data *);
46bcd498 573extern void add_job_opts(const char **, int);
de890a1e 574extern int ioengine_load(struct thread_data *);
8aa89d70 575extern bool parse_dryrun(void);
046395d7 576extern int fio_running_or_pending_io_threads(void);
3a35845f 577extern int fio_set_fd_nonblocking(int, const char *);
d2235e56 578extern void sig_show_status(int sig);
66e19a38 579extern struct thread_data *get_global_options(void);
1ec3d69b 580
a569b45f
JA
581extern uintptr_t page_mask;
582extern uintptr_t page_size;
583extern int initialize_fio(char *envp[]);
af1dc266 584extern void deinitialize_fio(void);
a569b45f 585
de890a1e
SL
586#define FIO_GETOPT_JOB 0x89000000
587#define FIO_GETOPT_IOENGINE 0x98000000
07b3232d 588#define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
8914a9d8 589
263e529f
JA
590/*
591 * ETA/status stuff
592 */
593extern void print_thread_status(void);
594extern void print_status_init(int);
0a428b23 595extern char *fio_uint_to_kmg(unsigned int val);
263e529f
JA
596
597/*
598 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
599 * will never back again. It may cycle between running/verififying/fsyncing.
600 * Once the thread reaches TD_EXITED, it is just waiting for the core to
601 * reap it.
602 */
603enum {
604 TD_NOT_CREATED = 0,
605 TD_CREATED,
606 TD_INITIALIZED,
b29ee5b3 607 TD_RAMP,
36d80bc7 608 TD_SETTING_UP,
263e529f 609 TD_RUNNING,
b0f65863 610 TD_PRE_READING,
263e529f
JA
611 TD_VERIFYING,
612 TD_FSYNCING,
3d434057 613 TD_FINISHING,
263e529f
JA
614 TD_EXITED,
615 TD_REAPED,
6e760cf3 616 TD_LAST,
9b87f09b 617 TD_NR,
263e529f
JA
618};
619
5c81ff5e
JA
620#define TD_ENG_FLAG_SHIFT 17
621#define TD_ENG_FLAG_MASK ((1U << 17) - 1)
9b87f09b 622
9b87f09b
JA
623static inline void td_set_ioengine_flags(struct thread_data *td)
624{
3d92b849
SW
625 td->flags = (~(TD_ENG_FLAG_MASK << TD_ENG_FLAG_SHIFT) & td->flags) |
626 (td->io_ops->flags << TD_ENG_FLAG_SHIFT);
9b87f09b
JA
627}
628
8f6d1311
JA
629static inline bool td_ioengine_flagged(struct thread_data *td,
630 enum fio_ioengine_flags flags)
9b87f09b 631{
8f6d1311 632 return ((td->flags >> TD_ENG_FLAG_SHIFT) & flags) != 0;
9b87f09b
JA
633}
634
b29ee5b3 635extern void td_set_runstate(struct thread_data *, int);
8edd973d
JA
636extern int td_bump_runstate(struct thread_data *, int);
637extern void td_restore_runstate(struct thread_data *, int);
9cc8cb91 638extern const char *runstate_to_name(int runstate);
8edd973d 639
cba5460c
JA
640/*
641 * Allow 60 seconds for a job to quit on its own, otherwise reap with
642 * a vengeance.
643 */
8ecf6df1 644#define FIO_REAP_TIMEOUT 300
cba5460c 645
d883efbd
JA
646#define TERMINATE_ALL (-1U)
647extern void fio_terminate_threads(unsigned int);
ebea2133 648extern void fio_mark_td_terminate(struct thread_data *);
b29ee5b3 649
2f9ade3c
JA
650/*
651 * Memory helpers
652 */
9a3f1100
JA
653extern int __must_check fio_pin_memory(struct thread_data *);
654extern void fio_unpin_memory(struct thread_data *);
b2fdda43 655extern int __must_check allocate_io_mem(struct thread_data *);
2f9ade3c 656extern void free_io_mem(struct thread_data *);
2bb3f0a7 657extern void free_threads_shm(void);
2f9ade3c 658
248c9436
TK
659#ifdef FIO_INTERNAL
660#define PTR_ALIGN(ptr, mask) \
661 (char *) (((uintptr_t) (ptr) + (mask)) & ~(mask))
662#endif
663
b29ee5b3
JA
664/*
665 * Reset stats after ramp time completes
666 */
667extern void reset_all_stats(struct thread_data *);
668
40511301
JA
669extern int io_queue_event(struct thread_data *td, struct io_u *io_u, int *ret,
670 enum fio_ddir ddir, uint64_t *bytes_issued, int from_verify,
8b6a404c 671 struct timespec *comp_time);
40511301 672
3e260a46
JA
673/*
674 * Latency target helpers
675 */
676extern void lat_target_check(struct thread_data *);
677extern void lat_target_init(struct thread_data *);
6bb58215 678extern void lat_target_reset(struct thread_data *);
3e260a46 679
79591fa9
TK
680/*
681 * Iterates all threads/processes within all the defined jobs
682 */
34572e28
JA
683#define for_each_td(td, i) \
684 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
53cdc686 685#define for_each_file(td, f, i) \
691c8fb0
JA
686 if ((td)->files_index) \
687 for ((i) = 0, (f) = (td)->files[0]; \
688 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
689 (i)++)
53cdc686 690
0032bf9f
JA
691#define fio_assert(td, cond) do { \
692 if (!(cond)) { \
340fd243 693 int *__foo = NULL; \
0032bf9f 694 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
ac18ea38 695 td_set_runstate((td), TD_EXITED); \
437c9b71 696 (td)->error = EFAULT; \
340fd243 697 *__foo = 0; \
0032bf9f
JA
698 } \
699} while (0)
700
8aa89d70 701static inline bool fio_fill_issue_time(struct thread_data *td)
12d9d841
JA
702{
703 if (td->o.read_iolog_file ||
704 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
8aa89d70 705 return true;
12d9d841 706
8aa89d70 707 return false;
12d9d841
JA
708}
709
5c81ff5e 710static inline bool option_check_rate(struct thread_data *td, enum fio_ddir ddir)
581e7141
JA
711{
712 struct thread_options *o = &td->o;
713
714 /*
715 * If some rate setting was given, we need to check it
716 */
717 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
718 o->rate_iops_min[ddir])
8aa89d70 719 return true;
581e7141 720
8aa89d70 721 return false;
581e7141
JA
722}
723
46960d0d 724static inline bool __should_check_rate(struct thread_data *td)
5c81ff5e
JA
725{
726 return (td->flags & TD_F_CHECK_RATE) != 0;
727}
728
8aa89d70 729static inline bool should_check_rate(struct thread_data *td)
581e7141 730{
46960d0d
JA
731 if (!__should_check_rate(td))
732 return false;
8aa89d70 733
46960d0d 734 return ddir_rw_sum(td->bytes_done) != 0;
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
f3afa57e 801enum {
129fb2d4
JA
802 __FIO_OUTPUT_TERSE = 0,
803 __FIO_OUTPUT_JSON = 1,
804 __FIO_OUTPUT_NORMAL = 2,
513e37ee
VF
805 __FIO_OUTPUT_JSON_PLUS = 3,
806 FIO_OUTPUT_NR = 4,
129fb2d4
JA
807
808 FIO_OUTPUT_TERSE = 1U << __FIO_OUTPUT_TERSE,
809 FIO_OUTPUT_JSON = 1U << __FIO_OUTPUT_JSON,
810 FIO_OUTPUT_NORMAL = 1U << __FIO_OUTPUT_NORMAL,
513e37ee 811 FIO_OUTPUT_JSON_PLUS = 1U << __FIO_OUTPUT_JSON_PLUS,
f3afa57e
JA
812};
813
e25839d4
JA
814enum {
815 FIO_RAND_DIST_RANDOM = 0,
816 FIO_RAND_DIST_ZIPF,
925fee33 817 FIO_RAND_DIST_PARETO,
56d9fa4b 818 FIO_RAND_DIST_GAUSS,
e0a04ac1 819 FIO_RAND_DIST_ZONED,
59466396 820 FIO_RAND_DIST_ZONED_ABS,
e25839d4
JA
821};
822
c95f9404
JA
823#define FIO_DEF_ZIPF 1.1
824#define FIO_DEF_PARETO 0.2
825
8055e41d
JA
826enum {
827 FIO_RAND_GEN_TAUSWORTHE = 0,
828 FIO_RAND_GEN_LFSR,
c3546b53 829 FIO_RAND_GEN_TAUSWORTHE64,
8055e41d
JA
830};
831
c2acfbac
JA
832enum {
833 FIO_CPUS_SHARED = 0,
834 FIO_CPUS_SPLIT,
835};
836
ca09be4b
JA
837extern void exec_trigger(const char *);
838extern void check_trigger_file(void);
839
ebac4655 840#endif