Token-based flow control
[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
ecc314ba
BC
17struct thread_data;
18
317b95d0 19#include "compiler/compiler.h"
01743ee1 20#include "flist.h"
e2887563 21#include "fifo.h"
4b87898e 22#include "rbtree.h"
317b95d0
JA
23#include "arch/arch.h"
24#include "os/os.h"
07739b57 25#include "mutex.h"
a3d741fa
JA
26#include "log.h"
27#include "debug.h"
d6aed795
JA
28#include "file.h"
29#include "io_ddir.h"
dcefb588 30#include "ioengine.h"
5995a6a4 31#include "iolog.h"
c5c8bd5c 32#include "helpers.h"
07b3232d 33#include "options.h"
7eb36574 34#include "profile.h"
c223da83 35#include "time.h"
a7346816 36#include "gettime.h"
bf2e821a 37#include "lib/getopt.h"
2615cc4b 38#include "lib/rand.h"
37db14fe 39#include "server.h"
a64e88da 40#include "stat.h"
9e684a49 41#include "flow.h"
ebac4655 42
609342ff
DL
43#ifdef FIO_HAVE_GUASI
44#include <guasi.h>
45#endif
46
417f0068
JA
47#ifdef FIO_HAVE_SOLARISAIO
48#include <sys/asynch.h>
49#endif
50
e9c047a0
JA
51/*
52 * What type of allocation to use for io buffers
53 */
54enum fio_memtype {
55 MEM_MALLOC = 0, /* ordinary malloc */
56 MEM_SHM, /* use shared memory segments */
74b025b0 57 MEM_SHMHUGE, /* use shared memory segments with huge pages */
e9c047a0 58 MEM_MMAP, /* use anonynomous mmap */
d0bdaf49 59 MEM_MMAPHUGE, /* memory mapped huge file */
e9c047a0
JA
60};
61
38dad62d
JA
62/*
63 * offset generator types
64 */
65enum {
66 RW_SEQ_SEQ = 0,
67 RW_SEQ_IDENT,
68};
69
06842027
SL
70/*
71 * What type of errors to continue on when continue_on_error is used
72 */
73enum error_type {
74 ERROR_TYPE_NONE = 0,
75 ERROR_TYPE_READ = 1 << 0,
76 ERROR_TYPE_WRITE = 1 << 1,
77 ERROR_TYPE_VERIFY = 1 << 2,
78 ERROR_TYPE_ANY = 0xffff,
79};
80
564ca972
JA
81struct bssplit {
82 unsigned int bs;
83 unsigned char perc;
84};
85
2dc1bbeb 86struct thread_options {
b1ec1da6 87 int pad;
61697c37 88 char *description;
b4692828 89 char *name;
ef899b63 90 char *directory;
13f8e2d2 91 char *filename;
2dc1bbeb 92 char *opendir;
09629a90 93 char *ioengine;
413dd459 94 enum td_ddir td_ddir;
38dad62d 95 unsigned int rw_seq;
90fef2d1 96 unsigned int kb_base;
5736c10d 97 unsigned int ddir_seq_nr;
a66da7a2 98 long ddir_seq_add;
2dc1bbeb
JA
99 unsigned int iodepth;
100 unsigned int iodepth_low;
101 unsigned int iodepth_batch;
4950421a 102 unsigned int iodepth_batch_complete;
2dc1bbeb
JA
103
104 unsigned long long size;
7bb59102 105 unsigned int size_percent;
aa31f1f1 106 unsigned int fill_device;
2dc1bbeb
JA
107 unsigned long long file_size_low;
108 unsigned long long file_size_high;
109 unsigned long long start_offset;
110
111 unsigned int bs[2];
2b7a01d0 112 unsigned int ba[2];
2dc1bbeb
JA
113 unsigned int min_bs[2];
114 unsigned int max_bs[2];
720e84ad
JA
115 struct bssplit *bssplit[2];
116 unsigned int bssplit_nr[2];
2dc1bbeb
JA
117
118 unsigned int nr_files;
119 unsigned int open_files;
4d4e80f2 120 enum file_lock_mode file_lock_mode;
29c1349f 121 unsigned int lockfile_batch;
e9c047a0 122
9158d2f7
JA
123 unsigned int odirect;
124 unsigned int invalidate_cache;
125 unsigned int create_serialize;
126 unsigned int create_fsync;
814452bd 127 unsigned int create_on_open;
9158d2f7 128 unsigned int end_fsync;
afad68f7 129 unsigned int pre_read;
9158d2f7
JA
130 unsigned int sync_io;
131 unsigned int verify;
e84c73a8 132 unsigned int do_verify;
160b966d 133 unsigned int verifysort;
a59e170d
JA
134 unsigned int verify_interval;
135 unsigned int verify_offset;
0e92f873 136 char verify_pattern[MAX_PATTERN_SIZE];
90059d65 137 unsigned int verify_pattern_bytes;
a12a3b4d 138 unsigned int verify_fatal;
b463e936 139 unsigned int verify_dump;
e8462bd8 140 unsigned int verify_async;
9e144189
JA
141 unsigned long long verify_backlog;
142 unsigned int verify_batch;
9158d2f7
JA
143 unsigned int use_thread;
144 unsigned int unlink;
145 unsigned int do_disk_util;
146 unsigned int override_sync;
147 unsigned int rand_repeatable;
2615cc4b 148 unsigned int use_os_rand;
9158d2f7
JA
149 unsigned int write_lat_log;
150 unsigned int write_bw_log;
c8eeb9df 151 unsigned int write_iops_log;
b8bc8cba 152 unsigned int log_avg_msec;
bb8895e0 153 unsigned int norandommap;
2b386d25 154 unsigned int softrandommap;
690adba3 155 unsigned int bs_unaligned;
ebb1415f 156 unsigned int fsync_on_close;
e9c047a0 157
56bb17f2 158 unsigned int hugepage_size;
a00735e6 159 unsigned int rw_min_bs;
ebac4655 160 unsigned int thinktime;
48097d5c 161 unsigned int thinktime_spin;
9c1f7434 162 unsigned int thinktime_blocks;
ebac4655 163 unsigned int fsync_blocks;
5f9099ea 164 unsigned int fdatasync_blocks;
1ef2b6be 165 unsigned int barrier_blocks;
dce8b847 166 unsigned long long start_delay;
0db26797 167 unsigned long long timeout;
721938ae 168 unsigned long long ramp_time;
ebac4655 169 unsigned int overwrite;
ebac4655 170 unsigned int bw_avg_time;
c8eeb9df 171 unsigned int iops_avg_time;
ebac4655 172 unsigned int loops;
ed335855 173 unsigned long long zone_range;
20dc95c4
JA
174 unsigned long long zone_size;
175 unsigned long long zone_skip;
e9c047a0 176 enum fio_memtype mem_type;
d529ee19 177 unsigned int mem_align;
2dc1bbeb 178
ebac4655 179 unsigned int stonewall;
b3d62a75 180 unsigned int new_group;
ebac4655 181 unsigned int numjobs;
ebac4655 182 os_cpu_mask_t cpumask;
375b2695 183 unsigned int cpumask_set;
e8462bd8
JA
184 os_cpu_mask_t verify_cpumask;
185 unsigned int verify_cpumask_set;
aea47d44 186 unsigned int iolog;
a6ccc7be 187 unsigned int rwmixcycle;
e47f799f 188 unsigned int rwmix[2];
b6f4d880 189 unsigned int nice;
0aabe160 190 unsigned int file_service_type;
b2560f3c 191 unsigned int group_reporting;
d2f3ac35 192 unsigned int fadvise_hint;
a596f047 193 enum fio_fallocate_mode fallocate_mode;
e9459e5a 194 unsigned int zero_buffers;
5973cafb 195 unsigned int refill_buffers;
fd68418e 196 unsigned int scramble_buffers;
cf4464ca 197 unsigned int time_based;
02af0988 198 unsigned int disable_lat;
9520ebb9
JA
199 unsigned int disable_clat;
200 unsigned int disable_slat;
201 unsigned int disable_bw;
993bf48b 202 unsigned int gtod_reduce;
be4ecfdf
JA
203 unsigned int gtod_cpu;
204 unsigned int gtod_offload;
c223da83 205 enum fio_cs clocksource;
64bbb865 206 unsigned int no_stall;
0d29de83
JA
207 unsigned int trim_percentage;
208 unsigned int trim_batch;
209 unsigned int trim_zero;
210 unsigned long long trim_backlog;
83349190
YH
211 unsigned int clat_percentiles;
212 unsigned int overwrite_plist;
802ad4a8 213 fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
aea47d44 214
076efc7c
JA
215 char *read_iolog_file;
216 char *write_iolog_file;
e3cedca7
JA
217 char *bw_log_file;
218 char *lat_log_file;
c8eeb9df 219 char *iops_log_file;
d1c46c04 220 char *replay_redirect;
2dc1bbeb
JA
221
222 /*
223 * Pre-run and post-run shell
224 */
225 char *exec_prerun;
226 char *exec_postrun;
227
581e7141
JA
228 unsigned int rate[2];
229 unsigned int ratemin[2];
2dc1bbeb 230 unsigned int ratecycle;
581e7141
JA
231 unsigned int rate_iops[2];
232 unsigned int rate_iops_min[2];
2dc1bbeb
JA
233
234 char *ioscheduler;
235
236 /*
237 * CPU "io" cycle burner
238 */
239 unsigned int cpuload;
240 unsigned int cpucycle;
f2bba182
RR
241
242 /*
243 * I/O Error handling
244 */
06842027 245 enum error_type continue_on_error;
9ac8a797
JA
246
247 /*
248 * Benchmark profile type
249 */
79d16311 250 char *profile;
a696fa2a
JA
251
252 /*
253 * blkio cgroup support
254 */
a696fa2a
JA
255 char *cgroup;
256 unsigned int cgroup_weight;
7de87099 257 unsigned int cgroup_nodelete;
e0b0d892
JA
258
259 unsigned int uid;
260 unsigned int gid;
44f29692 261
9e684a49
DE
262 int flow_id;
263 int flow;
264 int flow_watermark;
265 unsigned int flow_sleep;
266
44f29692 267 unsigned int sync_file_range;
2dc1bbeb
JA
268};
269
270/*
271 * This describes a single thread/process executing a fio job.
272 */
273struct thread_data {
274 struct thread_options o;
de890a1e 275 void *eo;
e4e33258 276 char verror[FIO_VERROR_SIZE];
2dc1bbeb
JA
277 pthread_t thread;
278 int thread_number;
279 int groupid;
280 struct thread_stat ts;
7b9f733a
JA
281
282 struct io_log *slat_log;
283 struct io_log *clat_log;
284 struct io_log *lat_log;
285 struct io_log *bw_log;
c8eeb9df 286 struct io_log *iops_log;
7b9f733a 287
f0505a14 288 uint64_t stat_io_bytes[2];
c8eeb9df
JA
289 struct timeval bw_sample_time;
290
291 uint64_t stat_io_blocks[2];
292 struct timeval iops_sample_time;
f0505a14 293
c8aaba19
JA
294 struct rusage ru_start;
295 struct rusage ru_end;
296
126d65c6 297 struct fio_file **files;
dd87b2c9 298 unsigned int files_size;
2dc1bbeb
JA
299 unsigned int files_index;
300 unsigned int nr_open_files;
1020a139 301 unsigned int nr_done_files;
2dc1bbeb
JA
302 unsigned int nr_normal_files;
303 union {
304 unsigned int next_file;
305 os_random_state_t next_file_state;
4c07ad86 306 struct frand_state __next_file_state;
2dc1bbeb
JA
307 };
308 int error;
20e354ef 309 int done;
2dc1bbeb
JA
310 pid_t pid;
311 char *orig_buffer;
312 size_t orig_buffer_size;
313 volatile int terminate;
314 volatile int runstate;
315 unsigned int ioprio;
ac684785 316 unsigned int ioprio_set;
2dc1bbeb 317 unsigned int last_was_sync;
9e144189 318 enum fio_ddir last_ddir;
2dc1bbeb
JA
319
320 char *mmapfile;
321 int mmapfd;
322
843a7413
JA
323 void *iolog_buf;
324 FILE *iolog_f;
ebac4655 325
da86774e 326 char *sysfs_root;
da86774e 327
3545a109 328 unsigned long rand_seeds[8];
5bfc35d7 329
4c07ad86
JA
330 union {
331 os_random_state_t bsrange_state;
332 struct frand_state __bsrange_state;
333 };
334 union {
335 os_random_state_t verify_state;
336 struct frand_state __verify_state;
337 };
338 union {
339 os_random_state_t trim_state;
340 struct frand_state __trim_state;
341 };
ebac4655 342
3545a109
JA
343 struct frand_state buf_state;
344
9e144189 345 unsigned int verify_batch;
0d29de83 346 unsigned int trim_batch;
9e144189 347
ebac4655
JA
348 int shm_id;
349
e9c047a0
JA
350 /*
351 * IO engine hooks, contains everything needed to submit an io_u
352 * to any of the available IO engines.
353 */
2866c82d 354 struct ioengine_ops *io_ops;
ebac4655 355
e9c047a0 356 /*
422f9e4b 357 * Queue depth of io_u's that fio MIGHT do
e9c047a0 358 */
ebac4655 359 unsigned int cur_depth;
422f9e4b
RM
360
361 /*
362 * io_u's about to be committed
363 */
d8005759 364 unsigned int io_u_queued;
422f9e4b
RM
365
366 /*
367 * io_u's submitted but not completed yet
368 */
369 unsigned int io_u_in_flight;
370
371 /*
372 * List of free and busy io_u's
373 */
01743ee1
JA
374 struct flist_head io_u_freelist;
375 struct flist_head io_u_busylist;
376 struct flist_head io_u_requeues;
e8462bd8
JA
377 pthread_mutex_t io_u_lock;
378 pthread_cond_t free_cond;
379
380 /*
381 * async verify offload
382 */
383 struct flist_head verify_list;
384 pthread_t *verify_threads;
385 unsigned int nr_verify_threads;
386 pthread_cond_t verify_cond;
387 int verify_thread_exit;
ebac4655 388
e9c047a0
JA
389 /*
390 * Rate state
391 */
1b8dbf25 392 unsigned long long rate_bps[2];
581e7141
JA
393 long rate_pending_usleep[2];
394 unsigned long rate_bytes[2];
395 unsigned long rate_blocks[2];
396 struct timeval lastrate[2];
ebac4655 397
ebac4655 398 unsigned long long total_io_size;
2e3bd4c2 399 unsigned long long fill_device_size;
ebac4655 400
755200a3 401 unsigned long io_issues[2];
9104f874 402 unsigned long long io_blocks[2];
c8eeb9df 403 unsigned long long this_io_blocks[2];
9104f874 404 unsigned long long io_bytes[2];
48f5abd3 405 unsigned long long io_skip_bytes;
9104f874 406 unsigned long long this_io_bytes[2];
079ad09b 407 unsigned long long zone_bytes;
cdd18ad8 408 struct fio_mutex *mutex;
ebac4655 409
e9c047a0
JA
410 /*
411 * State for random io, a bitmap of blocks done vs not done
412 */
4c07ad86
JA
413 union {
414 os_random_state_t random_state;
415 struct frand_state __random_state;
416 };
ebac4655 417
ebac4655
JA
418 struct timeval start; /* start of this loop */
419 struct timeval epoch; /* time job was started */
a61eddec 420 struct timeval last_issue;
993bf48b
JA
421 struct timeval tv_cache;
422 unsigned int tv_cache_nr;
423 unsigned int tv_cache_mask;
721938ae 424 unsigned int ramp_time_over;
ebac4655 425
e9c047a0
JA
426 /*
427 * read/write mixed workload state
428 */
4c07ad86
JA
429 union {
430 os_random_state_t rwmix_state;
431 struct frand_state __rwmix_state;
432 };
e4928662 433 unsigned long rwmix_issues;
e9c047a0 434 enum fio_ddir rwmix_ddir;
5736c10d 435 unsigned int ddir_seq_nr;
a6ccc7be 436
e9c047a0 437 /*
8de8f047
JA
438 * IO history logs for verification. We use a tree for sorting,
439 * if we are overwriting. Otherwise just use a fifo.
e9c047a0 440 */
4b87898e 441 struct rb_root io_hist_tree;
01743ee1 442 struct flist_head io_hist_list;
9e144189 443 unsigned long io_hist_len;
8de8f047
JA
444
445 /*
446 * For IO replaying
447 */
01743ee1 448 struct flist_head io_log_list;
433afcb4 449
0d29de83
JA
450 /*
451 * For tracking/handling discards
452 */
453 struct flist_head trim_list;
454 unsigned long trim_entries;
455
1907dbc6
JA
456 /*
457 * for fileservice, how often to switch to a new file
458 */
459 unsigned int file_service_nr;
460 unsigned int file_service_left;
461 struct fio_file *file_service_file;
9c60ce64 462
44f29692
JA
463 unsigned int sync_file_range_nr;
464
9c60ce64
JA
465 /*
466 * For generating file sizes
467 */
4c07ad86
JA
468 union {
469 os_random_state_t file_size_state;
470 struct frand_state __file_size_state;
471 };
f2bba182
RR
472
473 /*
474 * Error counts
475 */
476 unsigned int total_err_count;
477 int first_error;
15dc1934 478
9e684a49
DE
479 struct fio_flow *flow;
480
15dc1934
JA
481 /*
482 * Can be overloaded by profiles
483 */
7eb36574 484 struct prof_io_ops prof_io_ops;
58c55ba0 485 void *prof_data;
ebac4655
JA
486};
487
e592a06b
AC
488/*
489 * when should interactive ETA output be generated
490 */
491enum {
492 FIO_ETA_AUTO,
493 FIO_ETA_ALWAYS,
494 FIO_ETA_NEVER,
495};
496
e1161c32 497#define __td_verror(td, err, msg, func) \
ebac4655 498 do { \
19abcd3d
JA
499 if ((td)->error) \
500 break; \
ebac4655
JA
501 int e = (err); \
502 (td)->error = e; \
f2bba182
RR
503 if (!(td)->first_error) \
504 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
ebac4655
JA
505 } while (0)
506
b990b5c0 507
f2bba182
RR
508#define td_clear_error(td) \
509 (td)->error = 0;
e1161c32
JA
510#define td_verror(td, err, func) \
511 __td_verror((td), (err), strerror((err)), (func))
512#define td_vmsg(td, err, msg, func) \
513 __td_verror((td), (err), (msg), (func))
b990b5c0 514
81179eec
JA
515#define __fio_stringify_1(x) #x
516#define __fio_stringify(x) __fio_stringify_1(x)
517
ebac4655 518extern int exitall_on_terminate;
11e950bd
JA
519extern unsigned int thread_number;
520extern unsigned int nr_process, nr_thread;
ebac4655
JA
521extern int shm_id;
522extern int groupid;
c6ae0a5b 523extern int terse_output;
53cdc686 524extern int temp_stall_ts;
1e97cce9 525extern unsigned long long mlock_size;
cfc99db7 526extern unsigned long page_mask, page_size;
4241ea8f 527extern int read_only;
e592a06b 528extern int eta_print;
d3eeeabc 529extern unsigned long done_secs;
01f06b63 530extern char *job_section;
be4ecfdf
JA
531extern int fio_gtod_offload;
532extern int fio_gtod_cpu;
c223da83 533extern enum fio_cs fio_clock_source;
a9523c6f 534extern int warnings_fatal;
f57a9c59 535extern int terse_version;
5c341e9a 536extern int is_backend;
a37f69b7 537extern int nr_clients;
e46d8091 538extern int log_syslog;
5e726d0a 539extern const char fio_version_string[];
802ad4a8 540extern const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN];
ebac4655
JA
541
542extern struct thread_data *threads;
543
7101d9c2
JA
544static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
545{
546 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
547}
548
0ce8b119 549#define BLOCKS_PER_MAP (8 * sizeof(unsigned long))
aec2de20
JA
550#define TO_MAP_BLOCK(f, b) (b)
551#define RAND_MAP_IDX(f, b) (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
552#define RAND_MAP_BIT(f, b) (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
ebac4655 553
fca70358 554#define REAL_MAX_JOBS 2048
ebac4655 555
1ec99eea 556#define td_non_fatal_error(e) ((e) == EIO || (e) == EILSEQ)
f2bba182 557
06842027
SL
558static inline enum error_type td_error_type(enum fio_ddir ddir, int err)
559{
560 if (err == EILSEQ)
561 return ERROR_TYPE_VERIFY;
562 if (ddir == DDIR_READ)
563 return ERROR_TYPE_READ;
564 return ERROR_TYPE_WRITE;
565}
566
f2bba182
RR
567static inline void update_error_count(struct thread_data *td, int err)
568{
569 td->total_err_count++;
570 if (td->total_err_count == 1)
571 td->first_error = err;
572}
573
87dc1ab1
JA
574static inline int should_fsync(struct thread_data *td)
575{
576 if (td->last_was_sync)
577 return 0;
2dc1bbeb 578 if (td->o.odirect)
87dc1ab1 579 return 0;
2dc1bbeb 580 if (td_write(td) || td_rw(td) || td->o.override_sync)
87dc1ab1
JA
581 return 1;
582
583 return 0;
584}
585
8914a9d8 586/*
214e1eca 587 * Init/option functions
8914a9d8 588 */
72cb971b 589extern int __must_check parse_options(int, char **);
50d16976 590extern int parse_jobs_ini(char *, int, int);
81179eec 591extern int parse_cmd_line(int, char **);
2e1df07d 592extern int fio_backend(void);
50d16976 593extern void reset_fio_state(void);
2e1df07d 594extern void clear_io_state(struct thread_data *);
3b8b7135 595extern int fio_options_parse(struct thread_data *, char **, int);
74929ac2 596extern void fio_keywords_init(void);
214e1eca 597extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
de890a1e 598extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
214e1eca
JA
599extern void fio_fill_default_options(struct thread_data *);
600extern int fio_show_option_help(const char *);
de890a1e 601extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
214e1eca 602extern void fio_options_dup_and_init(struct option *);
de890a1e
SL
603extern void fio_options_mem_dupe(struct thread_data *);
604extern void options_mem_dupe(void *data, struct fio_option *options);
5bfc35d7 605extern void td_fill_rand_seeds(struct thread_data *);
79d16311 606extern void add_job_opts(const char **);
1ec3d69b 607extern char *num2str(unsigned long, int, int, int);
de890a1e 608extern int ioengine_load(struct thread_data *);
1ec3d69b 609
de890a1e
SL
610#define FIO_GETOPT_JOB 0x89000000
611#define FIO_GETOPT_IOENGINE 0x98000000
07b3232d 612#define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
8914a9d8 613
263e529f
JA
614/*
615 * ETA/status stuff
616 */
617extern void print_thread_status(void);
618extern void print_status_init(int);
619
620/*
621 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
622 * will never back again. It may cycle between running/verififying/fsyncing.
623 * Once the thread reaches TD_EXITED, it is just waiting for the core to
624 * reap it.
625 */
626enum {
627 TD_NOT_CREATED = 0,
628 TD_CREATED,
629 TD_INITIALIZED,
b29ee5b3 630 TD_RAMP,
263e529f 631 TD_RUNNING,
b0f65863 632 TD_PRE_READING,
263e529f
JA
633 TD_VERIFYING,
634 TD_FSYNCING,
635 TD_EXITED,
636 TD_REAPED,
637};
638
b29ee5b3 639extern void td_set_runstate(struct thread_data *, int);
cc0df00a
JA
640#define TERMINATE_ALL (-1)
641extern void fio_terminate_threads(int);
b29ee5b3 642
2f9ade3c
JA
643/*
644 * Memory helpers
645 */
b2fdda43 646extern int __must_check fio_pin_memory(void);
2f9ade3c 647extern void fio_unpin_memory(void);
b2fdda43 648extern int __must_check allocate_io_mem(struct thread_data *);
2f9ade3c
JA
649extern void free_io_mem(struct thread_data *);
650
b29ee5b3
JA
651/*
652 * Reset stats after ramp time completes
653 */
654extern void reset_all_stats(struct thread_data *);
655
fb7b71a3
JA
656/*
657 * blktrace support
658 */
5e62c22a 659#ifdef FIO_HAVE_BLKTRACE
fb7b71a3
JA
660extern int is_blktrace(const char *);
661extern int load_blktrace(struct thread_data *, const char *);
5e62c22a 662#endif
fb7b71a3 663
2866c82d
JA
664/*
665 * Mark unused variables passed to ops functions as unused, to silence gcc
666 */
667#define fio_unused __attribute((__unused__))
5f350952
JA
668#define fio_init __attribute__((constructor))
669#define fio_exit __attribute__((destructor))
2866c82d 670
34572e28
JA
671#define for_each_td(td, i) \
672 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
53cdc686 673#define for_each_file(td, f, i) \
691c8fb0
JA
674 if ((td)->files_index) \
675 for ((i) = 0, (f) = (td)->files[0]; \
676 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
677 (i)++)
53cdc686 678
0032bf9f
JA
679#define fio_assert(td, cond) do { \
680 if (!(cond)) { \
340fd243 681 int *__foo = NULL; \
0032bf9f 682 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
ac18ea38 683 td_set_runstate((td), TD_EXITED); \
437c9b71 684 (td)->error = EFAULT; \
340fd243 685 *__foo = 0; \
0032bf9f
JA
686 } \
687} while (0)
688
12d9d841
JA
689static inline int fio_fill_issue_time(struct thread_data *td)
690{
691 if (td->o.read_iolog_file ||
692 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
693 return 1;
694
695 return 0;
696}
697
581e7141
JA
698static inline int __should_check_rate(struct thread_data *td,
699 enum fio_ddir ddir)
700{
701 struct thread_options *o = &td->o;
702
703 /*
704 * If some rate setting was given, we need to check it
705 */
706 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
707 o->rate_iops_min[ddir])
708 return 1;
709
710 return 0;
711}
712
713static inline int should_check_rate(struct thread_data *td,
714 unsigned long *bytes_done)
715{
716 int ret = 0;
717
718 if (bytes_done[0])
719 ret |= __should_check_rate(td, 0);
720 if (bytes_done[1])
721 ret |= __should_check_rate(td, 1);
722
723 return ret;
724}
725
d529ee19
JA
726static inline int is_power_of_2(unsigned int val)
727{
728 return (val != 0 && ((val & (val - 1)) == 0));
729}
730
e8462bd8
JA
731/*
732 * We currently only need to do locking if we have verifier threads
733 * accessing our internal structures too
734 */
735static inline void td_io_u_lock(struct thread_data *td)
736{
737 if (td->o.verify_async)
738 pthread_mutex_lock(&td->io_u_lock);
739}
740
741static inline void td_io_u_unlock(struct thread_data *td)
742{
743 if (td->o.verify_async)
744 pthread_mutex_unlock(&td->io_u_lock);
745}
746
747static inline void td_io_u_free_notify(struct thread_data *td)
748{
749 if (td->o.verify_async)
750 pthread_cond_signal(&td->free_cond);
751}
752
cca84643
JA
753extern const char *fio_get_arch_string(int);
754extern const char *fio_get_os_string(int);
755
ebac4655 756#endif