Fix memory overflow with > 64 byte options
[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>
214e1eca 14#include <getopt.h>
ebac4655 15
4fee8096 16#include "compiler.h"
ebac4655 17#include "list.h"
4b87898e 18#include "rbtree.h"
ebac4655
JA
19#include "md5.h"
20#include "crc32.h"
21#include "arch.h"
22#include "os.h"
07739b57 23#include "mutex.h"
ebac4655 24
b6959b55 25#ifdef FIO_HAVE_SYSLET
a4f4fdd7 26#include "syslet.h"
b6959b55 27#endif
a4f4fdd7 28
609342ff
DL
29#ifdef FIO_HAVE_GUASI
30#include <guasi.h>
31#endif
32
1e97cce9
JA
33enum fio_ddir {
34 DDIR_READ = 0,
35 DDIR_WRITE,
36 DDIR_SYNC,
37};
38
413dd459 39enum td_ddir {
b1ec1da6
JA
40 TD_DDIR_READ = 1 << 0,
41 TD_DDIR_WRITE = 1 << 1,
42 TD_DDIR_RAND = 1 << 2,
43 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
44 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
7ff1c14b 45 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
b1ec1da6 46 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
413dd459
JA
47};
48
1c9e06ee
JA
49/*
50 * Use for maintaining statistics
51 */
ebac4655 52struct io_stat {
ebac4655
JA
53 unsigned long max_val;
54 unsigned long min_val;
55 unsigned long samples;
68704084
JA
56
57 double mean;
58 double S;
ebac4655
JA
59};
60
1c9e06ee
JA
61/*
62 * A single data sample
63 */
ebac4655
JA
64struct io_sample {
65 unsigned long time;
66 unsigned long val;
1e97cce9 67 enum fio_ddir ddir;
ebac4655
JA
68};
69
1c9e06ee
JA
70/*
71 * Dynamically growing data sample log
72 */
ebac4655
JA
73struct io_log {
74 unsigned long nr_samples;
75 unsigned long max_samples;
76 struct io_sample *log;
77};
78
1c9e06ee
JA
79/*
80 * When logging io actions, this matches a single sent io_u
81 */
ebac4655 82struct io_piece {
4b87898e
JA
83 union {
84 struct rb_node rb_node;
85 struct list_head list;
86 };
53cdc686 87 struct fio_file *file;
ebac4655 88 unsigned long long offset;
a4f4fdd7 89 unsigned long len;
1e97cce9 90 enum fio_ddir ddir;
ebac4655
JA
91};
92
a4f4fdd7
JA
93#ifdef FIO_HAVE_SYSLET
94struct syslet_req {
5b38ee84
JA
95 struct syslet_uatom atom; /* the atom to submit */
96 struct syslet_uatom *head; /* head of the sequence */
97 long ret; /* syscall return value */
a4f4fdd7
JA
98};
99#endif
100
0c6e7517
JA
101enum {
102 IO_U_F_FREE = 1 << 0,
103 IO_U_F_FLIGHT = 1 << 1,
104};
105
36690c9b
JA
106struct thread_data;
107
ebac4655
JA
108/*
109 * The io unit
110 */
111struct io_u {
112 union {
113#ifdef FIO_HAVE_LIBAIO
114 struct iocb iocb;
115#endif
116#ifdef FIO_HAVE_POSIXAIO
117 struct aiocb aiocb;
118#endif
119#ifdef FIO_HAVE_SGIO
120 struct sg_io_hdr hdr;
a4f4fdd7
JA
121#endif
122#ifdef FIO_HAVE_SYSLET
a2e1b08a 123 struct syslet_req req;
609342ff
DL
124#endif
125#ifdef FIO_HAVE_GUASI
126 guasi_req_t greq;
ebac4655
JA
127#endif
128 };
129 struct timeval start_time;
130 struct timeval issue_time;
131
1c9e06ee
JA
132 /*
133 * Allocated/set buffer and length
134 */
6b9cea23 135 void *buf;
a4f4fdd7 136 unsigned long buflen;
ebac4655
JA
137 unsigned long long offset;
138
1c9e06ee
JA
139 /*
140 * IO engine state, may be different from above when we get
141 * partial transfers / residual data counts
142 */
cec6b55d 143 void *xfer_buf;
a4f4fdd7 144 unsigned long xfer_buflen;
cec6b55d 145
ebac4655
JA
146 unsigned int resid;
147 unsigned int error;
148
1e97cce9 149 enum fio_ddir ddir;
ebac4655 150
dfd7bc2c
JA
151 /*
152 * io engine private data
153 */
154 union {
155 unsigned int index;
156 unsigned int seen;
157 };
158
0c6e7517
JA
159 unsigned int flags;
160
53cdc686
JA
161 struct fio_file *file;
162
ebac4655 163 struct list_head list;
d7762cf8
JA
164
165 /*
166 * Callback for io completion
167 */
36690c9b 168 int (*end_io)(struct thread_data *, struct io_u *);
ebac4655
JA
169};
170
36167d82
JA
171/*
172 * io_ops->queue() return values
173 */
174enum {
175 FIO_Q_COMPLETED = 0, /* completed sync */
176 FIO_Q_QUEUED = 1, /* queued, will complete async */
755200a3 177 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
36167d82
JA
178};
179
ebac4655
JA
180#define FIO_HDR_MAGIC 0xf00baaef
181
182enum {
1c9e06ee
JA
183 VERIFY_NONE = 0, /* no verification */
184 VERIFY_MD5, /* md5 sum data blocks */
185 VERIFY_CRC32, /* crc32 sum data blocks */
36690c9b 186 VERIFY_NULL, /* pretend to verify */
ebac4655
JA
187};
188
1c9e06ee
JA
189/*
190 * A header structure associated with each checksummed data block
191 */
ebac4655
JA
192struct verify_header {
193 unsigned int fio_magic;
194 unsigned int len;
195 unsigned int verify_type;
196 union {
197 char md5_digest[MD5_HASH_WORDS * 4];
198 unsigned long crc32;
199 };
200};
201
202struct group_run_stats {
9104f874
JA
203 unsigned long long max_run[2], min_run[2];
204 unsigned long long max_bw[2], min_bw[2];
e9b2a3fa 205 unsigned long long io_kb[2];
9104f874 206 unsigned long long agg[2];
ebac4655
JA
207};
208
e9c047a0
JA
209/*
210 * What type of allocation to use for io buffers
211 */
212enum fio_memtype {
213 MEM_MALLOC = 0, /* ordinary malloc */
214 MEM_SHM, /* use shared memory segments */
74b025b0 215 MEM_SHMHUGE, /* use shared memory segments with huge pages */
e9c047a0 216 MEM_MMAP, /* use anonynomous mmap */
d0bdaf49 217 MEM_MMAPHUGE, /* memory mapped huge file */
e9c047a0
JA
218};
219
220/*
221 * The type of object we are working on
222 */
223enum fio_filetype {
1c9e06ee
JA
224 FIO_TYPE_FILE = 1, /* plain file */
225 FIO_TYPE_BD, /* block device */
226 FIO_TYPE_CHAR, /* character device */
e9c047a0
JA
227};
228
2866c82d 229enum fio_ioengine_flags {
1c9e06ee 230 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
ba0fbe10
JA
231 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
232 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
0263882a 233 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
62d984e2 234 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
e9c047a0
JA
235};
236
f11bd94d 237enum fio_file_flags {
0ad920e7
JA
238 FIO_FILE_OPEN = 1 << 0, /* file is open */
239 FIO_FILE_UNLINK = 1 << 1, /* unlink on close */
240 FIO_FILE_CLOSING = 1 << 2, /* file being closed */
7bb48f84
JA
241 FIO_FILE_EXISTS = 1 << 3, /* file there */
242 FIO_FILE_EXTEND = 1 << 4, /* needs extend */
243 FIO_FILE_NOSORT = 1 << 5, /* don't sort verify blocks */
059e63c0 244 FIO_FILE_DONE = 1 << 6, /* io completed to this file */
409b3417 245 FIO_SIZE_KNOWN = 1 << 7, /* size has been set */
f11bd94d
JA
246};
247
1c9e06ee
JA
248/*
249 * Each thread_data structure has a number of files associated with it,
250 * this structure holds state information for a single file.
251 */
53cdc686 252struct fio_file {
af52b345
JA
253 enum fio_filetype filetype;
254
53cdc686
JA
255 /*
256 * A file may not be a file descriptor, let the io engine decide
257 */
258 union {
259 unsigned long file_data;
e26f8f7a 260 int fd;
53cdc686 261 };
7bb48f84
JA
262
263 /*
264 * filename and possible memory mapping
265 */
1315a68a 266 char *file_name;
53cdc686 267 void *mmap;
7bb48f84
JA
268
269 /*
270 * size of the file, offset into file, and io size from that offset
271 */
53cdc686
JA
272 unsigned long long real_file_size;
273 unsigned long long file_offset;
7bb48f84
JA
274 unsigned long long io_size;
275
53cdc686 276 unsigned long long last_pos;
02bcaa8c 277 unsigned long long last_completed_pos;
53cdc686 278
1c9e06ee
JA
279 /*
280 * block map for random io
281 */
53cdc686
JA
282 unsigned long *file_map;
283 unsigned int num_maps;
1c9e06ee 284 unsigned int last_free_lookup;
9b031dc8 285
0ad920e7 286 int references;
f11bd94d 287 enum fio_file_flags flags;
53cdc686
JA
288};
289
b2560f3c
JA
290/*
291 * How many depth levels to log
292 */
293#define FIO_IO_U_MAP_NR 8
294#define FIO_IO_U_LAT_NR 12
295
079ad09b 296struct thread_stat {
756867bd
JA
297 char *name;
298 char *verror;
299 int error;
300 int groupid;
301 pid_t pid;
302 char *description;
6586ee89 303 int members;
756867bd 304
079ad09b
JA
305 struct io_log *slat_log;
306 struct io_log *clat_log;
307 struct io_log *bw_log;
308
309 /*
310 * bandwidth and latency stats
311 */
312 struct io_stat clat_stat[2]; /* completion latency */
313 struct io_stat slat_stat[2]; /* submission latency */
314 struct io_stat bw_stat[2]; /* bandwidth stats */
315
316 unsigned long long stat_io_bytes[2];
317 struct timeval stat_sample_time[2];
318
319 /*
320 * fio system usage accounting
321 */
322 struct rusage ru_start;
323 struct rusage ru_end;
324 unsigned long usr_time;
325 unsigned long sys_time;
326 unsigned long ctx;
079ad09b 327
b2560f3c
JA
328 /*
329 * IO depth and latency stats
330 */
331 unsigned int io_u_map[FIO_IO_U_MAP_NR];
332 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
b3605062 333 unsigned long total_io_u[2];
756867bd
JA
334
335 unsigned long long io_bytes[2];
336 unsigned long runtime[2];
337 unsigned long total_run_time;
b2560f3c 338};
71619dc2 339
2dc1bbeb 340struct thread_options {
b1ec1da6 341 int pad;
61697c37 342 char *description;
b4692828 343 char *name;
ef899b63 344 char *directory;
13f8e2d2 345 char *filename;
2dc1bbeb 346 char *opendir;
09629a90 347 char *ioengine;
413dd459 348 enum td_ddir td_ddir;
211097b2 349 unsigned int ddir_nr;
2dc1bbeb
JA
350 unsigned int iodepth;
351 unsigned int iodepth_low;
352 unsigned int iodepth_batch;
353
354 unsigned long long size;
355 unsigned long long file_size_low;
356 unsigned long long file_size_high;
357 unsigned long long start_offset;
358
359 unsigned int bs[2];
360 unsigned int min_bs[2];
361 unsigned int max_bs[2];
362
363 unsigned int nr_files;
364 unsigned int open_files;
e9c047a0 365
9158d2f7
JA
366 unsigned int odirect;
367 unsigned int invalidate_cache;
368 unsigned int create_serialize;
369 unsigned int create_fsync;
370 unsigned int end_fsync;
371 unsigned int sync_io;
372 unsigned int verify;
160b966d 373 unsigned int verifysort;
9158d2f7
JA
374 unsigned int use_thread;
375 unsigned int unlink;
376 unsigned int do_disk_util;
377 unsigned int override_sync;
378 unsigned int rand_repeatable;
379 unsigned int write_lat_log;
380 unsigned int write_bw_log;
bb8895e0 381 unsigned int norandommap;
690adba3 382 unsigned int bs_unaligned;
ebb1415f 383 unsigned int fsync_on_close;
e9c047a0 384
56bb17f2 385 unsigned int hugepage_size;
a00735e6 386 unsigned int rw_min_bs;
ebac4655 387 unsigned int thinktime;
48097d5c 388 unsigned int thinktime_spin;
9c1f7434 389 unsigned int thinktime_blocks;
ebac4655
JA
390 unsigned int fsync_blocks;
391 unsigned int start_delay;
906c8d75 392 unsigned long timeout;
ebac4655 393 unsigned int overwrite;
ebac4655 394 unsigned int bw_avg_time;
ebac4655 395 unsigned int loops;
20dc95c4
JA
396 unsigned long long zone_size;
397 unsigned long long zone_skip;
e9c047a0 398 enum fio_memtype mem_type;
2dc1bbeb 399
ebac4655 400 unsigned int stonewall;
b3d62a75 401 unsigned int new_group;
ebac4655 402 unsigned int numjobs;
ebac4655 403 os_cpu_mask_t cpumask;
aea47d44 404 unsigned int iolog;
843a7413 405 unsigned int read_iolog;
a6ccc7be 406 unsigned int rwmixcycle;
e47f799f 407 unsigned int rwmix[2];
b6f4d880 408 unsigned int nice;
0aabe160 409 unsigned int file_service_type;
b2560f3c 410 unsigned int group_reporting;
d2f3ac35 411 unsigned int fadvise_hint;
aea47d44 412
076efc7c
JA
413 char *read_iolog_file;
414 char *write_iolog_file;
2dc1bbeb
JA
415
416 /*
417 * Pre-run and post-run shell
418 */
419 char *exec_prerun;
420 char *exec_postrun;
421
422 unsigned int rate;
423 unsigned int ratemin;
424 unsigned int ratecycle;
425 unsigned int rate_iops;
426 unsigned int rate_iops_min;
427
428 char *ioscheduler;
429
430 /*
431 * CPU "io" cycle burner
432 */
433 unsigned int cpuload;
434 unsigned int cpucycle;
435};
436
e4e33258
JA
437#define FIO_VERROR_SIZE 128
438
2dc1bbeb
JA
439/*
440 * This describes a single thread/process executing a fio job.
441 */
442struct thread_data {
443 struct thread_options o;
e4e33258 444 char verror[FIO_VERROR_SIZE];
2dc1bbeb
JA
445 pthread_t thread;
446 int thread_number;
447 int groupid;
448 struct thread_stat ts;
449 struct fio_file *files;
450 unsigned int files_index;
451 unsigned int nr_open_files;
452 unsigned int nr_normal_files;
453 union {
454 unsigned int next_file;
455 os_random_state_t next_file_state;
456 };
457 int error;
458 pid_t pid;
459 char *orig_buffer;
460 size_t orig_buffer_size;
461 volatile int terminate;
462 volatile int runstate;
463 unsigned int ioprio;
464 unsigned int last_was_sync;
465
466 char *mmapfile;
467 int mmapfd;
468
843a7413
JA
469 void *iolog_buf;
470 FILE *iolog_f;
ebac4655 471
da86774e 472 char *sysfs_root;
da86774e 473
6dfd46b9
JA
474 os_random_state_t bsrange_state;
475 os_random_state_t verify_state;
ebac4655
JA
476
477 int shm_id;
478
e9c047a0
JA
479 /*
480 * IO engine hooks, contains everything needed to submit an io_u
481 * to any of the available IO engines.
482 */
2866c82d 483 struct ioengine_ops *io_ops;
ebac4655 484
e9c047a0
JA
485 /*
486 * Current IO depth and list of free and busy io_u's.
487 */
ebac4655
JA
488 unsigned int cur_depth;
489 struct list_head io_u_freelist;
490 struct list_head io_u_busylist;
755200a3 491 struct list_head io_u_requeues;
cb5ab512 492 unsigned int io_u_queued;
ebac4655 493
e9c047a0
JA
494 /*
495 * Rate state
496 */
ebac4655
JA
497 unsigned long rate_usec_cycle;
498 long rate_pending_usleep;
499 unsigned long rate_bytes;
4e991c23 500 unsigned long rate_blocks;
ebac4655
JA
501 struct timeval lastrate;
502
ebac4655
JA
503 unsigned long long total_io_size;
504
755200a3 505 unsigned long io_issues[2];
9104f874
JA
506 unsigned long long io_blocks[2];
507 unsigned long long io_bytes[2];
9104f874 508 unsigned long long this_io_bytes[2];
079ad09b 509 unsigned long long zone_bytes;
07739b57 510 struct fio_sem *mutex;
ebac4655 511
e9c047a0
JA
512 /*
513 * State for random io, a bitmap of blocks done vs not done
514 */
6dfd46b9 515 os_random_state_t random_state;
ebac4655 516
ebac4655
JA
517 struct timeval start; /* start of this loop */
518 struct timeval epoch; /* time job was started */
38d77cae
JA
519 struct timeval rw_end[2];
520 unsigned int rw_end_set[2];
ebac4655 521
e9c047a0
JA
522 /*
523 * read/write mixed workload state
524 */
6dfd46b9 525 os_random_state_t rwmix_state;
afe24a5a 526 unsigned long long rwmix_bytes;
a6ccc7be 527 struct timeval rwmix_switch;
e9c047a0 528 enum fio_ddir rwmix_ddir;
211097b2 529 unsigned int ddir_nr;
a6ccc7be 530
e9c047a0 531 /*
8de8f047
JA
532 * IO history logs for verification. We use a tree for sorting,
533 * if we are overwriting. Otherwise just use a fifo.
e9c047a0 534 */
4b87898e 535 struct rb_root io_hist_tree;
8de8f047
JA
536 struct list_head io_hist_list;
537
538 /*
539 * For IO replaying
540 */
aea47d44 541 struct list_head io_log_list;
433afcb4
JA
542
543 /*
544 * timeout handling
545 */
546 struct timeval timeout_end;
547 struct itimerval timer;
1907dbc6
JA
548
549 /*
550 * for fileservice, how often to switch to a new file
551 */
552 unsigned int file_service_nr;
553 unsigned int file_service_left;
554 struct fio_file *file_service_file;
9c60ce64
JA
555
556 /*
557 * For generating file sizes
558 */
559 os_random_state_t file_size_state;
ebac4655
JA
560};
561
0aabe160
JA
562/*
563 * roundrobin available files, or choose one at random.
564 */
565enum {
566 FIO_FSERVICE_RANDOM = 1,
567 FIO_FSERVICE_RR = 2,
568};
569
433afcb4
JA
570/*
571 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
572 * the timer on each queue operation.
573 */
574#define IO_U_TIMEOUT_INC 5
575#define IO_U_TIMEOUT 30
576
e1161c32 577#define __td_verror(td, err, msg, func) \
ebac4655 578 do { \
19abcd3d
JA
579 if ((td)->error) \
580 break; \
ebac4655
JA
581 int e = (err); \
582 (td)->error = e; \
e1161c32 583 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
ebac4655
JA
584 } while (0)
585
b990b5c0 586
e1161c32
JA
587#define td_verror(td, err, func) \
588 __td_verror((td), (err), strerror((err)), (func))
589#define td_vmsg(td, err, msg, func) \
590 __td_verror((td), (err), (msg), (func))
b990b5c0 591
ebac4655
JA
592extern int exitall_on_terminate;
593extern int thread_number;
9cedf167 594extern int nr_process, nr_thread;
ebac4655
JA
595extern int shm_id;
596extern int groupid;
c6ae0a5b 597extern int terse_output;
eb8bbf48
JA
598extern FILE *f_out;
599extern FILE *f_err;
53cdc686 600extern int temp_stall_ts;
1e97cce9 601extern unsigned long long mlock_size;
cfc99db7 602extern unsigned long page_mask, page_size;
ebac4655
JA
603
604extern struct thread_data *threads;
605
2dc1bbeb
JA
606#define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
607#define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
608#define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
609#define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
ebac4655
JA
610
611#define BLOCKS_PER_MAP (8 * sizeof(long))
2dc1bbeb 612#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
53cdc686
JA
613#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
614#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
ebac4655
JA
615
616#define MAX_JOBS (1024)
617
87dc1ab1
JA
618static inline int should_fsync(struct thread_data *td)
619{
620 if (td->last_was_sync)
621 return 0;
2dc1bbeb 622 if (td->o.odirect)
87dc1ab1 623 return 0;
2dc1bbeb 624 if (td_write(td) || td_rw(td) || td->o.override_sync)
87dc1ab1
JA
625 return 1;
626
627 return 0;
628}
629
1c9e06ee
JA
630/*
631 * Disk utils as read in /sys/block/<dev>/stat
632 */
ebac4655
JA
633struct disk_util_stat {
634 unsigned ios[2];
635 unsigned merges[2];
636 unsigned long long sectors[2];
637 unsigned ticks[2];
638 unsigned io_ticks;
639 unsigned time_in_queue;
640};
641
1c9e06ee
JA
642/*
643 * Per-device disk util management
644 */
ebac4655
JA
645struct disk_util {
646 struct list_head list;
647
648 char *name;
649 char path[256];
650 dev_t dev;
651
652 struct disk_util_stat dus;
653 struct disk_util_stat last_dus;
654
655 unsigned long msec;
656 struct timeval time;
657};
658
ebac4655
JA
659#define DISK_UTIL_MSEC (250)
660
6a0106a0
JA
661#ifndef min
662#define min(a, b) ((a) < (b) ? (a) : (b))
663#endif
a00735e6
JA
664#ifndef max
665#define max(a, b) ((a) > (b) ? (a) : (b))
666#endif
6a0106a0 667
6796209a
JA
668/*
669 * Log exports
670 */
72cb971b 671extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
6796209a 672extern void write_iolog_put(struct thread_data *, struct io_u *);
72cb971b 673extern int __must_check init_iolog(struct thread_data *td);
6796209a
JA
674extern void log_io_piece(struct thread_data *, struct io_u *);
675extern void prune_io_piece_log(struct thread_data *);
676extern void write_iolog_close(struct thread_data *);
677
678/*
679 * Logging
680 */
1e97cce9
JA
681extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
682extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
683extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
6796209a
JA
684extern void show_run_stats(void);
685extern void init_disk_util(struct thread_data *);
686extern void update_rusage_stat(struct thread_data *);
687extern void update_io_ticks(void);
688extern void disk_util_timer_arm(void);
8914a9d8
JA
689extern void setup_log(struct io_log **);
690extern void finish_log(struct thread_data *, struct io_log *, const char *);
bb3884d8 691extern void __finish_log(struct io_log *, const char *);
bb3884d8
JA
692extern struct io_log *agg_io_log[2];
693extern int write_bw_log;
694extern void add_agg_sample(unsigned long, enum fio_ddir);
6796209a
JA
695
696/*
697 * Time functions
698 */
699extern unsigned long utime_since(struct timeval *, struct timeval *);
69008999 700extern unsigned long utime_since_now(struct timeval *);
6796209a
JA
701extern unsigned long mtime_since(struct timeval *, struct timeval *);
702extern unsigned long mtime_since_now(struct timeval *);
703extern unsigned long time_since_now(struct timeval *);
263e529f 704extern unsigned long mtime_since_genesis(void);
b990b5c0 705extern void __usec_sleep(unsigned int);
6796209a 706extern void usec_sleep(struct thread_data *, unsigned long);
413dd459 707extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
6043c579 708extern void fill_start_time(struct timeval *);
02bcaa8c 709extern void fio_gettime(struct timeval *, void *);
a2f77c9f 710extern void set_genesis_time(void);
6796209a 711
8914a9d8 712/*
214e1eca 713 * Init/option functions
8914a9d8 714 */
72cb971b 715extern int __must_check parse_options(int, char **);
214e1eca
JA
716extern int fio_option_parse(struct thread_data *, const char *);
717extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
718extern void fio_fill_default_options(struct thread_data *);
719extern int fio_show_option_help(const char *);
720extern void fio_options_dup_and_init(struct option *);
d23bb327
JA
721extern void options_mem_dupe(struct thread_data *);
722extern void options_mem_free(struct thread_data *);
214e1eca
JA
723#define FIO_GETOPT_JOB 0x89988998
724#define FIO_NR_OPTIONS 128
8914a9d8 725
53cdc686
JA
726/*
727 * File setup/shutdown
728 */
729extern void close_files(struct thread_data *);
b2fdda43
JA
730extern int __must_check setup_files(struct thread_data *);
731extern int __must_check open_files(struct thread_data *);
732extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
b5af8293
JA
733extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
734extern void generic_close_file(struct thread_data *, struct fio_file *);
af52b345 735extern void add_file(struct thread_data *, const char *);
0ad920e7
JA
736extern void get_file(struct fio_file *);
737extern void put_file(struct thread_data *, struct fio_file *);
bbf6b540 738extern int add_dir_files(struct thread_data *, const char *);
68727076 739extern int init_random_map(struct thread_data *);
cade3ef4 740extern void dup_files(struct thread_data *, struct thread_data *);
53cdc686 741
263e529f
JA
742/*
743 * ETA/status stuff
744 */
745extern void print_thread_status(void);
746extern void print_status_init(int);
747
748/*
749 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
750 * will never back again. It may cycle between running/verififying/fsyncing.
751 * Once the thread reaches TD_EXITED, it is just waiting for the core to
752 * reap it.
753 */
754enum {
755 TD_NOT_CREATED = 0,
756 TD_CREATED,
757 TD_INITIALIZED,
758 TD_RUNNING,
759 TD_VERIFYING,
760 TD_FSYNCING,
761 TD_EXITED,
762 TD_REAPED,
763};
764
e29d1b70
JA
765/*
766 * Verify helpers
767 */
768extern void populate_verify_io_u(struct thread_data *, struct io_u *);
b2fdda43 769extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
36690c9b 770extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
e29d1b70 771
2f9ade3c
JA
772/*
773 * Memory helpers
774 */
b2fdda43 775extern int __must_check fio_pin_memory(void);
2f9ade3c 776extern void fio_unpin_memory(void);
b2fdda43 777extern int __must_check allocate_io_mem(struct thread_data *);
2f9ade3c
JA
778extern void free_io_mem(struct thread_data *);
779
10ba535a
JA
780/*
781 * io unit handling
782 */
783#define queue_full(td) list_empty(&(td)->io_u_freelist)
784extern struct io_u *__get_io_u(struct thread_data *);
3d7c391d 785extern struct io_u *get_io_u(struct thread_data *);
10ba535a 786extern void put_io_u(struct thread_data *, struct io_u *);
755200a3 787extern void requeue_io_u(struct thread_data *, struct io_u **);
d7762cf8
JA
788extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
789extern long __must_check io_u_queued_complete(struct thread_data *, int);
7e77dd02 790extern void io_u_queued(struct thread_data *, struct io_u *);
5451792e 791extern void io_u_log_error(struct thread_data *, struct io_u *);
433afcb4
JA
792extern void io_u_init_timeout(void);
793extern void io_u_set_timeout(struct thread_data *);
b3605062 794extern void io_u_mark_depth(struct thread_data *, struct io_u *);
10ba535a
JA
795
796/*
797 * io engine entry points
798 */
b2fdda43
JA
799extern int __must_check td_io_init(struct thread_data *);
800extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
801extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
802extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
803extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
804extern int __must_check td_io_commit(struct thread_data *);
b5af8293
JA
805extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
806extern void td_io_close_file(struct thread_data *, struct fio_file *);
10ba535a 807
3b70d7e5
JA
808/*
809 * If logging output to a file, stderr should go to both stderr and f_err
810 */
811#define log_err(args...) do { \
812 fprintf(f_err, ##args); \
813 if (f_err != stderr) \
814 fprintf(stderr, ##args); \
815 } while (0)
816
9c60ce64
JA
817#define log_info(args...) fprintf(f_out, ##args)
818
9728ce37
JB
819FILE *get_f_out(void);
820FILE *get_f_err(void);
821
2866c82d 822struct ioengine_ops {
5f350952 823 struct list_head list;
2866c82d
JA
824 char name[16];
825 int version;
826 int flags;
ea2877a4 827 int (*setup)(struct thread_data *);
2866c82d
JA
828 int (*init)(struct thread_data *);
829 int (*prep)(struct thread_data *, struct io_u *);
830 int (*queue)(struct thread_data *, struct io_u *);
755200a3 831 int (*commit)(struct thread_data *);
2866c82d
JA
832 int (*getevents)(struct thread_data *, int, int, struct timespec *);
833 struct io_u *(*event)(struct thread_data *, int);
834 int (*cancel)(struct thread_data *, struct io_u *);
835 void (*cleanup)(struct thread_data *);
b5af8293
JA
836 int (*open_file)(struct thread_data *, struct fio_file *);
837 void (*close_file)(struct thread_data *, struct fio_file *);
2866c82d
JA
838 void *data;
839 void *dlhandle;
840};
841
2c187c0f 842#define FIO_IOOPS_VERSION 7
2866c82d 843
b4692828 844extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
b2fdda43 845extern void register_ioengine(struct ioengine_ops *);
5f350952 846extern void unregister_ioengine(struct ioengine_ops *);
2866c82d
JA
847extern void close_ioengine(struct thread_data *);
848
849/*
850 * Mark unused variables passed to ops functions as unused, to silence gcc
851 */
852#define fio_unused __attribute((__unused__))
5f350952
JA
853#define fio_init __attribute__((constructor))
854#define fio_exit __attribute__((destructor))
2866c82d 855
34572e28
JA
856#define for_each_td(td, i) \
857 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
53cdc686 858#define for_each_file(td, f, i) \
2dc1bbeb 859 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
53cdc686 860
0032bf9f
JA
861#define fio_assert(td, cond) do { \
862 if (!(cond)) { \
340fd243 863 int *__foo = NULL; \
0032bf9f
JA
864 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
865 (td)->runstate = TD_EXITED; \
437c9b71 866 (td)->error = EFAULT; \
340fd243 867 *__foo = 0; \
0032bf9f
JA
868 } \
869} while (0)
870
9bf27b45
JA
871static inline void clear_error(struct thread_data *td)
872{
873 td->error = 0;
874 td->verror[0] = '\0';
875}
876
ebac4655 877#endif