Add check for pipe/fifo files
[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
317b95d0 16#include "compiler/compiler.h"
ebac4655 17#include "list.h"
4b87898e 18#include "rbtree.h"
ebac4655
JA
19#include "md5.h"
20#include "crc32.h"
317b95d0
JA
21#include "arch/arch.h"
22#include "os/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 */
b5605e9d 227 FIO_TYPE_PIPE, /* pipe */
e9c047a0
JA
228};
229
2866c82d 230enum fio_ioengine_flags {
1c9e06ee 231 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
ba0fbe10
JA
232 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
233 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
0263882a 234 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
62d984e2 235 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
e9c047a0
JA
236};
237
f11bd94d 238enum fio_file_flags {
0ad920e7
JA
239 FIO_FILE_OPEN = 1 << 0, /* file is open */
240 FIO_FILE_UNLINK = 1 << 1, /* unlink on close */
241 FIO_FILE_CLOSING = 1 << 2, /* file being closed */
7bb48f84
JA
242 FIO_FILE_EXISTS = 1 << 3, /* file there */
243 FIO_FILE_EXTEND = 1 << 4, /* needs extend */
244 FIO_FILE_NOSORT = 1 << 5, /* don't sort verify blocks */
059e63c0 245 FIO_FILE_DONE = 1 << 6, /* io completed to this file */
409b3417 246 FIO_SIZE_KNOWN = 1 << 7, /* size has been set */
f11bd94d
JA
247};
248
1c9e06ee
JA
249/*
250 * Each thread_data structure has a number of files associated with it,
251 * this structure holds state information for a single file.
252 */
53cdc686 253struct fio_file {
af52b345
JA
254 enum fio_filetype filetype;
255
53cdc686
JA
256 /*
257 * A file may not be a file descriptor, let the io engine decide
258 */
259 union {
260 unsigned long file_data;
e26f8f7a 261 int fd;
53cdc686 262 };
7bb48f84
JA
263
264 /*
265 * filename and possible memory mapping
266 */
1315a68a 267 char *file_name;
53cdc686 268 void *mmap;
7bb48f84
JA
269
270 /*
271 * size of the file, offset into file, and io size from that offset
272 */
53cdc686
JA
273 unsigned long long real_file_size;
274 unsigned long long file_offset;
7bb48f84
JA
275 unsigned long long io_size;
276
53cdc686 277 unsigned long long last_pos;
02bcaa8c 278 unsigned long long last_completed_pos;
53cdc686 279
1c9e06ee
JA
280 /*
281 * block map for random io
282 */
53cdc686
JA
283 unsigned long *file_map;
284 unsigned int num_maps;
1c9e06ee 285 unsigned int last_free_lookup;
9b031dc8 286
0ad920e7 287 int references;
f11bd94d 288 enum fio_file_flags flags;
53cdc686
JA
289};
290
b2560f3c
JA
291/*
292 * How many depth levels to log
293 */
294#define FIO_IO_U_MAP_NR 8
295#define FIO_IO_U_LAT_NR 12
296
079ad09b 297struct thread_stat {
756867bd
JA
298 char *name;
299 char *verror;
300 int error;
301 int groupid;
302 pid_t pid;
303 char *description;
6586ee89 304 int members;
756867bd 305
079ad09b
JA
306 struct io_log *slat_log;
307 struct io_log *clat_log;
308 struct io_log *bw_log;
309
310 /*
311 * bandwidth and latency stats
312 */
313 struct io_stat clat_stat[2]; /* completion latency */
314 struct io_stat slat_stat[2]; /* submission latency */
315 struct io_stat bw_stat[2]; /* bandwidth stats */
316
317 unsigned long long stat_io_bytes[2];
318 struct timeval stat_sample_time[2];
319
320 /*
321 * fio system usage accounting
322 */
323 struct rusage ru_start;
324 struct rusage ru_end;
325 unsigned long usr_time;
326 unsigned long sys_time;
327 unsigned long ctx;
079ad09b 328
b2560f3c
JA
329 /*
330 * IO depth and latency stats
331 */
332 unsigned int io_u_map[FIO_IO_U_MAP_NR];
333 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
b3605062 334 unsigned long total_io_u[2];
756867bd
JA
335
336 unsigned long long io_bytes[2];
337 unsigned long runtime[2];
338 unsigned long total_run_time;
b2560f3c 339};
71619dc2 340
2dc1bbeb 341struct thread_options {
b1ec1da6 342 int pad;
61697c37 343 char *description;
b4692828 344 char *name;
ef899b63 345 char *directory;
13f8e2d2 346 char *filename;
2dc1bbeb 347 char *opendir;
09629a90 348 char *ioengine;
413dd459 349 enum td_ddir td_ddir;
211097b2 350 unsigned int ddir_nr;
2dc1bbeb
JA
351 unsigned int iodepth;
352 unsigned int iodepth_low;
353 unsigned int iodepth_batch;
354
355 unsigned long long size;
356 unsigned long long file_size_low;
357 unsigned long long file_size_high;
358 unsigned long long start_offset;
359
360 unsigned int bs[2];
361 unsigned int min_bs[2];
362 unsigned int max_bs[2];
363
364 unsigned int nr_files;
365 unsigned int open_files;
e9c047a0 366
9158d2f7
JA
367 unsigned int odirect;
368 unsigned int invalidate_cache;
369 unsigned int create_serialize;
370 unsigned int create_fsync;
371 unsigned int end_fsync;
372 unsigned int sync_io;
373 unsigned int verify;
160b966d 374 unsigned int verifysort;
9158d2f7
JA
375 unsigned int use_thread;
376 unsigned int unlink;
377 unsigned int do_disk_util;
378 unsigned int override_sync;
379 unsigned int rand_repeatable;
380 unsigned int write_lat_log;
381 unsigned int write_bw_log;
bb8895e0 382 unsigned int norandommap;
690adba3 383 unsigned int bs_unaligned;
ebb1415f 384 unsigned int fsync_on_close;
e9c047a0 385
56bb17f2 386 unsigned int hugepage_size;
a00735e6 387 unsigned int rw_min_bs;
ebac4655 388 unsigned int thinktime;
48097d5c 389 unsigned int thinktime_spin;
9c1f7434 390 unsigned int thinktime_blocks;
ebac4655
JA
391 unsigned int fsync_blocks;
392 unsigned int start_delay;
906c8d75 393 unsigned long timeout;
ebac4655 394 unsigned int overwrite;
ebac4655 395 unsigned int bw_avg_time;
ebac4655 396 unsigned int loops;
20dc95c4
JA
397 unsigned long long zone_size;
398 unsigned long long zone_skip;
e9c047a0 399 enum fio_memtype mem_type;
2dc1bbeb 400
ebac4655 401 unsigned int stonewall;
b3d62a75 402 unsigned int new_group;
ebac4655 403 unsigned int numjobs;
ebac4655 404 os_cpu_mask_t cpumask;
aea47d44 405 unsigned int iolog;
843a7413 406 unsigned int read_iolog;
a6ccc7be 407 unsigned int rwmixcycle;
e47f799f 408 unsigned int rwmix[2];
b6f4d880 409 unsigned int nice;
0aabe160 410 unsigned int file_service_type;
b2560f3c 411 unsigned int group_reporting;
d2f3ac35 412 unsigned int fadvise_hint;
aea47d44 413
076efc7c
JA
414 char *read_iolog_file;
415 char *write_iolog_file;
2dc1bbeb
JA
416
417 /*
418 * Pre-run and post-run shell
419 */
420 char *exec_prerun;
421 char *exec_postrun;
422
423 unsigned int rate;
424 unsigned int ratemin;
425 unsigned int ratecycle;
426 unsigned int rate_iops;
427 unsigned int rate_iops_min;
428
429 char *ioscheduler;
430
431 /*
432 * CPU "io" cycle burner
433 */
434 unsigned int cpuload;
435 unsigned int cpucycle;
436};
437
e4e33258
JA
438#define FIO_VERROR_SIZE 128
439
2dc1bbeb
JA
440/*
441 * This describes a single thread/process executing a fio job.
442 */
443struct thread_data {
444 struct thread_options o;
e4e33258 445 char verror[FIO_VERROR_SIZE];
2dc1bbeb
JA
446 pthread_t thread;
447 int thread_number;
448 int groupid;
449 struct thread_stat ts;
450 struct fio_file *files;
451 unsigned int files_index;
452 unsigned int nr_open_files;
1020a139 453 unsigned int nr_done_files;
2dc1bbeb
JA
454 unsigned int nr_normal_files;
455 union {
456 unsigned int next_file;
457 os_random_state_t next_file_state;
458 };
459 int error;
460 pid_t pid;
461 char *orig_buffer;
462 size_t orig_buffer_size;
463 volatile int terminate;
464 volatile int runstate;
465 unsigned int ioprio;
466 unsigned int last_was_sync;
467
468 char *mmapfile;
469 int mmapfd;
470
843a7413
JA
471 void *iolog_buf;
472 FILE *iolog_f;
ebac4655 473
da86774e 474 char *sysfs_root;
da86774e 475
6dfd46b9
JA
476 os_random_state_t bsrange_state;
477 os_random_state_t verify_state;
ebac4655
JA
478
479 int shm_id;
480
e9c047a0
JA
481 /*
482 * IO engine hooks, contains everything needed to submit an io_u
483 * to any of the available IO engines.
484 */
2866c82d 485 struct ioengine_ops *io_ops;
ebac4655 486
e9c047a0
JA
487 /*
488 * Current IO depth and list of free and busy io_u's.
489 */
ebac4655
JA
490 unsigned int cur_depth;
491 struct list_head io_u_freelist;
492 struct list_head io_u_busylist;
755200a3 493 struct list_head io_u_requeues;
cb5ab512 494 unsigned int io_u_queued;
ebac4655 495
e9c047a0
JA
496 /*
497 * Rate state
498 */
ebac4655
JA
499 unsigned long rate_usec_cycle;
500 long rate_pending_usleep;
501 unsigned long rate_bytes;
4e991c23 502 unsigned long rate_blocks;
ebac4655
JA
503 struct timeval lastrate;
504
ebac4655
JA
505 unsigned long long total_io_size;
506
755200a3 507 unsigned long io_issues[2];
9104f874
JA
508 unsigned long long io_blocks[2];
509 unsigned long long io_bytes[2];
9104f874 510 unsigned long long this_io_bytes[2];
079ad09b 511 unsigned long long zone_bytes;
07739b57 512 struct fio_sem *mutex;
ebac4655 513
e9c047a0
JA
514 /*
515 * State for random io, a bitmap of blocks done vs not done
516 */
6dfd46b9 517 os_random_state_t random_state;
ebac4655 518
ebac4655
JA
519 struct timeval start; /* start of this loop */
520 struct timeval epoch; /* time job was started */
38d77cae
JA
521 struct timeval rw_end[2];
522 unsigned int rw_end_set[2];
ebac4655 523
e9c047a0
JA
524 /*
525 * read/write mixed workload state
526 */
6dfd46b9 527 os_random_state_t rwmix_state;
afe24a5a 528 unsigned long long rwmix_bytes;
a6ccc7be 529 struct timeval rwmix_switch;
e9c047a0 530 enum fio_ddir rwmix_ddir;
211097b2 531 unsigned int ddir_nr;
a6ccc7be 532
e9c047a0 533 /*
8de8f047
JA
534 * IO history logs for verification. We use a tree for sorting,
535 * if we are overwriting. Otherwise just use a fifo.
e9c047a0 536 */
4b87898e 537 struct rb_root io_hist_tree;
8de8f047
JA
538 struct list_head io_hist_list;
539
540 /*
541 * For IO replaying
542 */
aea47d44 543 struct list_head io_log_list;
433afcb4
JA
544
545 /*
546 * timeout handling
547 */
548 struct timeval timeout_end;
549 struct itimerval timer;
1907dbc6
JA
550
551 /*
552 * for fileservice, how often to switch to a new file
553 */
554 unsigned int file_service_nr;
555 unsigned int file_service_left;
556 struct fio_file *file_service_file;
9c60ce64
JA
557
558 /*
559 * For generating file sizes
560 */
561 os_random_state_t file_size_state;
ebac4655
JA
562};
563
0aabe160
JA
564/*
565 * roundrobin available files, or choose one at random.
566 */
567enum {
568 FIO_FSERVICE_RANDOM = 1,
569 FIO_FSERVICE_RR = 2,
570};
571
433afcb4
JA
572/*
573 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
574 * the timer on each queue operation.
575 */
576#define IO_U_TIMEOUT_INC 5
577#define IO_U_TIMEOUT 30
578
e1161c32 579#define __td_verror(td, err, msg, func) \
ebac4655 580 do { \
19abcd3d
JA
581 if ((td)->error) \
582 break; \
ebac4655
JA
583 int e = (err); \
584 (td)->error = e; \
e1161c32 585 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
ebac4655
JA
586 } while (0)
587
b990b5c0 588
e1161c32
JA
589#define td_verror(td, err, func) \
590 __td_verror((td), (err), strerror((err)), (func))
591#define td_vmsg(td, err, msg, func) \
592 __td_verror((td), (err), (msg), (func))
b990b5c0 593
ebac4655
JA
594extern int exitall_on_terminate;
595extern int thread_number;
9cedf167 596extern int nr_process, nr_thread;
ebac4655
JA
597extern int shm_id;
598extern int groupid;
c6ae0a5b 599extern int terse_output;
eb8bbf48
JA
600extern FILE *f_out;
601extern FILE *f_err;
53cdc686 602extern int temp_stall_ts;
1e97cce9 603extern unsigned long long mlock_size;
cfc99db7 604extern unsigned long page_mask, page_size;
ebac4655
JA
605
606extern struct thread_data *threads;
607
2dc1bbeb
JA
608#define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
609#define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
610#define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
611#define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
ebac4655
JA
612
613#define BLOCKS_PER_MAP (8 * sizeof(long))
2dc1bbeb 614#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
53cdc686
JA
615#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
616#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
ebac4655
JA
617
618#define MAX_JOBS (1024)
619
87dc1ab1
JA
620static inline int should_fsync(struct thread_data *td)
621{
622 if (td->last_was_sync)
623 return 0;
2dc1bbeb 624 if (td->o.odirect)
87dc1ab1 625 return 0;
2dc1bbeb 626 if (td_write(td) || td_rw(td) || td->o.override_sync)
87dc1ab1
JA
627 return 1;
628
629 return 0;
630}
631
1c9e06ee
JA
632/*
633 * Disk utils as read in /sys/block/<dev>/stat
634 */
ebac4655
JA
635struct disk_util_stat {
636 unsigned ios[2];
637 unsigned merges[2];
638 unsigned long long sectors[2];
639 unsigned ticks[2];
640 unsigned io_ticks;
641 unsigned time_in_queue;
642};
643
1c9e06ee
JA
644/*
645 * Per-device disk util management
646 */
ebac4655
JA
647struct disk_util {
648 struct list_head list;
649
650 char *name;
e11c410c 651 char *sysfs_root;
ebac4655 652 char path[256];
07e5b264 653 int major, minor;
ebac4655
JA
654
655 struct disk_util_stat dus;
656 struct disk_util_stat last_dus;
657
658 unsigned long msec;
659 struct timeval time;
660};
661
ebac4655
JA
662#define DISK_UTIL_MSEC (250)
663
6a0106a0
JA
664#ifndef min
665#define min(a, b) ((a) < (b) ? (a) : (b))
666#endif
a00735e6
JA
667#ifndef max
668#define max(a, b) ((a) > (b) ? (a) : (b))
669#endif
6a0106a0 670
6796209a
JA
671/*
672 * Log exports
673 */
72cb971b 674extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
6796209a 675extern void write_iolog_put(struct thread_data *, struct io_u *);
72cb971b 676extern int __must_check init_iolog(struct thread_data *td);
6796209a
JA
677extern void log_io_piece(struct thread_data *, struct io_u *);
678extern void prune_io_piece_log(struct thread_data *);
679extern void write_iolog_close(struct thread_data *);
680
681/*
682 * Logging
683 */
1e97cce9
JA
684extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
685extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
686extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
6796209a
JA
687extern void show_run_stats(void);
688extern void init_disk_util(struct thread_data *);
689extern void update_rusage_stat(struct thread_data *);
690extern void update_io_ticks(void);
691extern void disk_util_timer_arm(void);
8914a9d8
JA
692extern void setup_log(struct io_log **);
693extern void finish_log(struct thread_data *, struct io_log *, const char *);
bb3884d8 694extern void __finish_log(struct io_log *, const char *);
bb3884d8
JA
695extern struct io_log *agg_io_log[2];
696extern int write_bw_log;
697extern void add_agg_sample(unsigned long, enum fio_ddir);
6796209a
JA
698
699/*
700 * Time functions
701 */
702extern unsigned long utime_since(struct timeval *, struct timeval *);
69008999 703extern unsigned long utime_since_now(struct timeval *);
6796209a
JA
704extern unsigned long mtime_since(struct timeval *, struct timeval *);
705extern unsigned long mtime_since_now(struct timeval *);
706extern unsigned long time_since_now(struct timeval *);
263e529f 707extern unsigned long mtime_since_genesis(void);
b990b5c0 708extern void __usec_sleep(unsigned int);
6796209a 709extern void usec_sleep(struct thread_data *, unsigned long);
413dd459 710extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
6043c579 711extern void fill_start_time(struct timeval *);
02bcaa8c 712extern void fio_gettime(struct timeval *, void *);
a2f77c9f 713extern void set_genesis_time(void);
6796209a 714
8914a9d8 715/*
214e1eca 716 * Init/option functions
8914a9d8 717 */
72cb971b 718extern int __must_check parse_options(int, char **);
214e1eca
JA
719extern int fio_option_parse(struct thread_data *, const char *);
720extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
721extern void fio_fill_default_options(struct thread_data *);
722extern int fio_show_option_help(const char *);
723extern void fio_options_dup_and_init(struct option *);
d23bb327
JA
724extern void options_mem_dupe(struct thread_data *);
725extern void options_mem_free(struct thread_data *);
214e1eca
JA
726#define FIO_GETOPT_JOB 0x89988998
727#define FIO_NR_OPTIONS 128
8914a9d8 728
53cdc686
JA
729/*
730 * File setup/shutdown
731 */
732extern void close_files(struct thread_data *);
b2fdda43
JA
733extern int __must_check setup_files(struct thread_data *);
734extern int __must_check open_files(struct thread_data *);
735extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
b5af8293
JA
736extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
737extern void generic_close_file(struct thread_data *, struct fio_file *);
af52b345 738extern void add_file(struct thread_data *, const char *);
0ad920e7
JA
739extern void get_file(struct fio_file *);
740extern void put_file(struct thread_data *, struct fio_file *);
bbf6b540 741extern int add_dir_files(struct thread_data *, const char *);
68727076 742extern int init_random_map(struct thread_data *);
cade3ef4 743extern void dup_files(struct thread_data *, struct thread_data *);
53cdc686 744
263e529f
JA
745/*
746 * ETA/status stuff
747 */
748extern void print_thread_status(void);
749extern void print_status_init(int);
750
9f8f2064
JA
751/*
752 * disk util stuff
753 */
754#ifdef FIO_HAVE_DISK_UTIL
755extern void show_disk_util(void);
756extern void disk_util_timer_arm(void);
757extern void init_disk_util(struct thread_data *);
758extern void update_io_ticks(void);
759#else
760#define show_disk_util()
761#define disk_util_timer_arm()
762#define init_disk_util(td)
763#define update_io_ticks()
764#endif
765
263e529f
JA
766/*
767 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
768 * will never back again. It may cycle between running/verififying/fsyncing.
769 * Once the thread reaches TD_EXITED, it is just waiting for the core to
770 * reap it.
771 */
772enum {
773 TD_NOT_CREATED = 0,
774 TD_CREATED,
775 TD_INITIALIZED,
776 TD_RUNNING,
777 TD_VERIFYING,
778 TD_FSYNCING,
779 TD_EXITED,
780 TD_REAPED,
781};
782
e29d1b70
JA
783/*
784 * Verify helpers
785 */
786extern void populate_verify_io_u(struct thread_data *, struct io_u *);
b2fdda43 787extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
36690c9b 788extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
e29d1b70 789
2f9ade3c
JA
790/*
791 * Memory helpers
792 */
b2fdda43 793extern int __must_check fio_pin_memory(void);
2f9ade3c 794extern void fio_unpin_memory(void);
b2fdda43 795extern int __must_check allocate_io_mem(struct thread_data *);
2f9ade3c
JA
796extern void free_io_mem(struct thread_data *);
797
10ba535a
JA
798/*
799 * io unit handling
800 */
801#define queue_full(td) list_empty(&(td)->io_u_freelist)
802extern struct io_u *__get_io_u(struct thread_data *);
3d7c391d 803extern struct io_u *get_io_u(struct thread_data *);
10ba535a 804extern void put_io_u(struct thread_data *, struct io_u *);
755200a3 805extern void requeue_io_u(struct thread_data *, struct io_u **);
d7762cf8
JA
806extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
807extern long __must_check io_u_queued_complete(struct thread_data *, int);
7e77dd02 808extern void io_u_queued(struct thread_data *, struct io_u *);
5451792e 809extern void io_u_log_error(struct thread_data *, struct io_u *);
433afcb4
JA
810extern void io_u_init_timeout(void);
811extern void io_u_set_timeout(struct thread_data *);
b3605062 812extern void io_u_mark_depth(struct thread_data *, struct io_u *);
10ba535a
JA
813
814/*
815 * io engine entry points
816 */
b2fdda43
JA
817extern int __must_check td_io_init(struct thread_data *);
818extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
819extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
820extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
821extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
822extern int __must_check td_io_commit(struct thread_data *);
b5af8293
JA
823extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
824extern void td_io_close_file(struct thread_data *, struct fio_file *);
10ba535a 825
3b70d7e5
JA
826/*
827 * If logging output to a file, stderr should go to both stderr and f_err
828 */
829#define log_err(args...) do { \
830 fprintf(f_err, ##args); \
831 if (f_err != stderr) \
832 fprintf(stderr, ##args); \
833 } while (0)
834
9c60ce64
JA
835#define log_info(args...) fprintf(f_out, ##args)
836
9728ce37
JB
837FILE *get_f_out(void);
838FILE *get_f_err(void);
839
2866c82d 840struct ioengine_ops {
5f350952 841 struct list_head list;
2866c82d
JA
842 char name[16];
843 int version;
844 int flags;
ea2877a4 845 int (*setup)(struct thread_data *);
2866c82d
JA
846 int (*init)(struct thread_data *);
847 int (*prep)(struct thread_data *, struct io_u *);
848 int (*queue)(struct thread_data *, struct io_u *);
755200a3 849 int (*commit)(struct thread_data *);
2866c82d
JA
850 int (*getevents)(struct thread_data *, int, int, struct timespec *);
851 struct io_u *(*event)(struct thread_data *, int);
852 int (*cancel)(struct thread_data *, struct io_u *);
853 void (*cleanup)(struct thread_data *);
b5af8293
JA
854 int (*open_file)(struct thread_data *, struct fio_file *);
855 void (*close_file)(struct thread_data *, struct fio_file *);
2866c82d
JA
856 void *data;
857 void *dlhandle;
858};
859
2c187c0f 860#define FIO_IOOPS_VERSION 7
2866c82d 861
b4692828 862extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
b2fdda43 863extern void register_ioengine(struct ioengine_ops *);
5f350952 864extern void unregister_ioengine(struct ioengine_ops *);
2866c82d
JA
865extern void close_ioengine(struct thread_data *);
866
867/*
868 * Mark unused variables passed to ops functions as unused, to silence gcc
869 */
870#define fio_unused __attribute((__unused__))
5f350952
JA
871#define fio_init __attribute__((constructor))
872#define fio_exit __attribute__((destructor))
2866c82d 873
34572e28
JA
874#define for_each_td(td, i) \
875 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
53cdc686 876#define for_each_file(td, f, i) \
2dc1bbeb 877 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
53cdc686 878
0032bf9f
JA
879#define fio_assert(td, cond) do { \
880 if (!(cond)) { \
340fd243 881 int *__foo = NULL; \
0032bf9f
JA
882 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
883 (td)->runstate = TD_EXITED; \
437c9b71 884 (td)->error = EFAULT; \
340fd243 885 *__foo = 0; \
0032bf9f
JA
886 } \
887} while (0)
888
9bf27b45
JA
889static inline void clear_error(struct thread_data *td)
890{
891 td->error = 0;
892 td->verror[0] = '\0';
893}
894
ebac4655 895#endif