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