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