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