Fix build/compile for non-blktrace platforms
[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"
e2887563 18#include "fifo.h"
4b87898e 19#include "rbtree.h"
ebac4655
JA
20#include "md5.h"
21#include "crc32.h"
317b95d0
JA
22#include "arch/arch.h"
23#include "os/os.h"
07739b57 24#include "mutex.h"
ebac4655 25
b6959b55 26#ifdef FIO_HAVE_SYSLET
a4f4fdd7 27#include "syslet.h"
b6959b55 28#endif
a4f4fdd7 29
609342ff
DL
30#ifdef FIO_HAVE_GUASI
31#include <guasi.h>
32#endif
33
1e97cce9
JA
34enum fio_ddir {
35 DDIR_READ = 0,
36 DDIR_WRITE,
37 DDIR_SYNC,
38};
39
413dd459 40enum td_ddir {
b1ec1da6
JA
41 TD_DDIR_READ = 1 << 0,
42 TD_DDIR_WRITE = 1 << 1,
43 TD_DDIR_RAND = 1 << 2,
44 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
45 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
7ff1c14b 46 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
b1ec1da6 47 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
413dd459
JA
48};
49
1c9e06ee
JA
50/*
51 * Use for maintaining statistics
52 */
ebac4655 53struct io_stat {
ebac4655
JA
54 unsigned long max_val;
55 unsigned long min_val;
56 unsigned long samples;
68704084
JA
57
58 double mean;
59 double S;
ebac4655
JA
60};
61
1c9e06ee
JA
62/*
63 * A single data sample
64 */
ebac4655
JA
65struct io_sample {
66 unsigned long time;
67 unsigned long val;
1e97cce9 68 enum fio_ddir ddir;
ebac4655
JA
69};
70
1c9e06ee
JA
71/*
72 * Dynamically growing data sample log
73 */
ebac4655
JA
74struct io_log {
75 unsigned long nr_samples;
76 unsigned long max_samples;
77 struct io_sample *log;
78};
79
1c9e06ee
JA
80/*
81 * When logging io actions, this matches a single sent io_u
82 */
ebac4655 83struct io_piece {
4b87898e
JA
84 union {
85 struct rb_node rb_node;
86 struct list_head list;
87 };
53cdc686 88 struct fio_file *file;
ebac4655 89 unsigned long long offset;
a4f4fdd7 90 unsigned long len;
1e97cce9 91 enum fio_ddir ddir;
8c1fdf04 92 unsigned long delay;
ebac4655
JA
93};
94
a4f4fdd7
JA
95#ifdef FIO_HAVE_SYSLET
96struct syslet_req {
5b38ee84
JA
97 struct syslet_uatom atom; /* the atom to submit */
98 struct syslet_uatom *head; /* head of the sequence */
99 long ret; /* syscall return value */
a4f4fdd7
JA
100};
101#endif
102
0c6e7517
JA
103enum {
104 IO_U_F_FREE = 1 << 0,
105 IO_U_F_FLIGHT = 1 << 1,
106};
107
36690c9b
JA
108struct thread_data;
109
ebac4655
JA
110/*
111 * The io unit
112 */
113struct io_u {
114 union {
115#ifdef FIO_HAVE_LIBAIO
116 struct iocb iocb;
117#endif
118#ifdef FIO_HAVE_POSIXAIO
119 struct aiocb aiocb;
120#endif
121#ifdef FIO_HAVE_SGIO
122 struct sg_io_hdr hdr;
a4f4fdd7
JA
123#endif
124#ifdef FIO_HAVE_SYSLET
a2e1b08a 125 struct syslet_req req;
609342ff
DL
126#endif
127#ifdef FIO_HAVE_GUASI
128 guasi_req_t greq;
ebac4655
JA
129#endif
130 };
131 struct timeval start_time;
132 struct timeval issue_time;
133
1c9e06ee
JA
134 /*
135 * Allocated/set buffer and length
136 */
6b9cea23 137 void *buf;
a4f4fdd7 138 unsigned long buflen;
ebac4655 139 unsigned long long offset;
d460eb31 140 unsigned long long endpos;
ebac4655 141
1c9e06ee
JA
142 /*
143 * IO engine state, may be different from above when we get
144 * partial transfers / residual data counts
145 */
cec6b55d 146 void *xfer_buf;
a4f4fdd7 147 unsigned long xfer_buflen;
cec6b55d 148
ebac4655
JA
149 unsigned int resid;
150 unsigned int error;
151
1e97cce9 152 enum fio_ddir ddir;
ebac4655 153
dfd7bc2c
JA
154 /*
155 * io engine private data
156 */
157 union {
158 unsigned int index;
159 unsigned int seen;
160 };
161
0c6e7517
JA
162 unsigned int flags;
163
53cdc686
JA
164 struct fio_file *file;
165
ebac4655 166 struct list_head list;
d7762cf8
JA
167
168 /*
169 * Callback for io completion
170 */
36690c9b 171 int (*end_io)(struct thread_data *, struct io_u *);
ebac4655
JA
172};
173
36167d82
JA
174/*
175 * io_ops->queue() return values
176 */
177enum {
178 FIO_Q_COMPLETED = 0, /* completed sync */
179 FIO_Q_QUEUED = 1, /* queued, will complete async */
755200a3 180 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
36167d82
JA
181};
182
ebac4655
JA
183#define FIO_HDR_MAGIC 0xf00baaef
184
185enum {
1c9e06ee
JA
186 VERIFY_NONE = 0, /* no verification */
187 VERIFY_MD5, /* md5 sum data blocks */
188 VERIFY_CRC32, /* crc32 sum data blocks */
36690c9b 189 VERIFY_NULL, /* pretend to verify */
ebac4655
JA
190};
191
1c9e06ee
JA
192/*
193 * A header structure associated with each checksummed data block
194 */
ebac4655
JA
195struct verify_header {
196 unsigned int fio_magic;
197 unsigned int len;
198 unsigned int verify_type;
199 union {
200 char md5_digest[MD5_HASH_WORDS * 4];
201 unsigned long crc32;
202 };
203};
204
205struct group_run_stats {
9104f874
JA
206 unsigned long long max_run[2], min_run[2];
207 unsigned long long max_bw[2], min_bw[2];
e9b2a3fa 208 unsigned long long io_kb[2];
9104f874 209 unsigned long long agg[2];
ebac4655
JA
210};
211
e9c047a0
JA
212/*
213 * What type of allocation to use for io buffers
214 */
215enum fio_memtype {
216 MEM_MALLOC = 0, /* ordinary malloc */
217 MEM_SHM, /* use shared memory segments */
74b025b0 218 MEM_SHMHUGE, /* use shared memory segments with huge pages */
e9c047a0 219 MEM_MMAP, /* use anonynomous mmap */
d0bdaf49 220 MEM_MMAPHUGE, /* memory mapped huge file */
e9c047a0
JA
221};
222
223/*
224 * The type of object we are working on
225 */
226enum fio_filetype {
1c9e06ee
JA
227 FIO_TYPE_FILE = 1, /* plain file */
228 FIO_TYPE_BD, /* block device */
229 FIO_TYPE_CHAR, /* character device */
b5605e9d 230 FIO_TYPE_PIPE, /* pipe */
e9c047a0
JA
231};
232
2866c82d 233enum fio_ioengine_flags {
1c9e06ee 234 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
ba0fbe10
JA
235 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
236 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
0263882a 237 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
62d984e2 238 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
e9c047a0
JA
239};
240
f11bd94d 241enum fio_file_flags {
0ad920e7 242 FIO_FILE_OPEN = 1 << 0, /* file is open */
a9b7b305
JA
243 FIO_FILE_CLOSING = 1 << 1, /* file being closed */
244 FIO_FILE_EXISTS = 1 << 2, /* file there */
245 FIO_FILE_EXTEND = 1 << 3, /* needs extend */
246 FIO_FILE_NOSORT = 1 << 4, /* don't sort verify blocks */
247 FIO_FILE_DONE = 1 << 5, /* io completed to this file */
248 FIO_SIZE_KNOWN = 1 << 6, /* size has been set */
f11bd94d
JA
249};
250
1c9e06ee
JA
251/*
252 * Each thread_data structure has a number of files associated with it,
253 * this structure holds state information for a single file.
254 */
53cdc686 255struct fio_file {
af52b345
JA
256 enum fio_filetype filetype;
257
53cdc686
JA
258 /*
259 * A file may not be a file descriptor, let the io engine decide
260 */
261 union {
262 unsigned long file_data;
e26f8f7a 263 int fd;
53cdc686 264 };
7bb48f84
JA
265
266 /*
267 * filename and possible memory mapping
268 */
1315a68a 269 char *file_name;
53cdc686 270 void *mmap;
5e6c2067 271 unsigned int major, minor;
7bb48f84
JA
272
273 /*
274 * size of the file, offset into file, and io size from that offset
275 */
53cdc686
JA
276 unsigned long long real_file_size;
277 unsigned long long file_offset;
7bb48f84
JA
278 unsigned long long io_size;
279
53cdc686 280 unsigned long long last_pos;
02bcaa8c 281 unsigned long long last_completed_pos;
53cdc686 282
1c9e06ee
JA
283 /*
284 * block map for random io
285 */
53cdc686
JA
286 unsigned long *file_map;
287 unsigned int num_maps;
1c9e06ee 288 unsigned int last_free_lookup;
9b031dc8 289
0ad920e7 290 int references;
f11bd94d 291 enum fio_file_flags flags;
53cdc686
JA
292};
293
b2560f3c
JA
294/*
295 * How many depth levels to log
296 */
297#define FIO_IO_U_MAP_NR 8
298#define FIO_IO_U_LAT_NR 12
299
079ad09b 300struct thread_stat {
756867bd
JA
301 char *name;
302 char *verror;
303 int error;
304 int groupid;
305 pid_t pid;
306 char *description;
6586ee89 307 int members;
756867bd 308
079ad09b
JA
309 struct io_log *slat_log;
310 struct io_log *clat_log;
311 struct io_log *bw_log;
312
313 /*
314 * bandwidth and latency stats
315 */
316 struct io_stat clat_stat[2]; /* completion latency */
317 struct io_stat slat_stat[2]; /* submission latency */
318 struct io_stat bw_stat[2]; /* bandwidth stats */
319
320 unsigned long long stat_io_bytes[2];
321 struct timeval stat_sample_time[2];
322
323 /*
324 * fio system usage accounting
325 */
326 struct rusage ru_start;
327 struct rusage ru_end;
328 unsigned long usr_time;
329 unsigned long sys_time;
330 unsigned long ctx;
079ad09b 331
b2560f3c
JA
332 /*
333 * IO depth and latency stats
334 */
335 unsigned int io_u_map[FIO_IO_U_MAP_NR];
336 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
b3605062 337 unsigned long total_io_u[2];
30061b97 338 unsigned long short_io_u[2];
756867bd
JA
339
340 unsigned long long io_bytes[2];
341 unsigned long runtime[2];
342 unsigned long total_run_time;
b2560f3c 343};
71619dc2 344
2dc1bbeb 345struct thread_options {
b1ec1da6 346 int pad;
61697c37 347 char *description;
b4692828 348 char *name;
ef899b63 349 char *directory;
13f8e2d2 350 char *filename;
2dc1bbeb 351 char *opendir;
09629a90 352 char *ioengine;
413dd459 353 enum td_ddir td_ddir;
211097b2 354 unsigned int ddir_nr;
2dc1bbeb
JA
355 unsigned int iodepth;
356 unsigned int iodepth_low;
357 unsigned int iodepth_batch;
358
359 unsigned long long size;
360 unsigned long long file_size_low;
361 unsigned long long file_size_high;
362 unsigned long long start_offset;
363
364 unsigned int bs[2];
365 unsigned int min_bs[2];
366 unsigned int max_bs[2];
367
368 unsigned int nr_files;
369 unsigned int open_files;
e9c047a0 370
9158d2f7
JA
371 unsigned int odirect;
372 unsigned int invalidate_cache;
373 unsigned int create_serialize;
374 unsigned int create_fsync;
375 unsigned int end_fsync;
376 unsigned int sync_io;
377 unsigned int verify;
160b966d 378 unsigned int verifysort;
9158d2f7
JA
379 unsigned int use_thread;
380 unsigned int unlink;
381 unsigned int do_disk_util;
382 unsigned int override_sync;
383 unsigned int rand_repeatable;
384 unsigned int write_lat_log;
385 unsigned int write_bw_log;
bb8895e0 386 unsigned int norandommap;
690adba3 387 unsigned int bs_unaligned;
ebb1415f 388 unsigned int fsync_on_close;
e9c047a0 389
56bb17f2 390 unsigned int hugepage_size;
a00735e6 391 unsigned int rw_min_bs;
ebac4655 392 unsigned int thinktime;
48097d5c 393 unsigned int thinktime_spin;
9c1f7434 394 unsigned int thinktime_blocks;
ebac4655
JA
395 unsigned int fsync_blocks;
396 unsigned int start_delay;
0db26797 397 unsigned long long timeout;
ebac4655 398 unsigned int overwrite;
ebac4655 399 unsigned int bw_avg_time;
ebac4655 400 unsigned int loops;
20dc95c4
JA
401 unsigned long long zone_size;
402 unsigned long long zone_skip;
e9c047a0 403 enum fio_memtype mem_type;
2dc1bbeb 404
ebac4655 405 unsigned int stonewall;
b3d62a75 406 unsigned int new_group;
ebac4655 407 unsigned int numjobs;
ebac4655 408 os_cpu_mask_t cpumask;
375b2695 409 unsigned int cpumask_set;
aea47d44 410 unsigned int iolog;
a6ccc7be 411 unsigned int rwmixcycle;
e47f799f 412 unsigned int rwmix[2];
b6f4d880 413 unsigned int nice;
0aabe160 414 unsigned int file_service_type;
b2560f3c 415 unsigned int group_reporting;
d2f3ac35 416 unsigned int fadvise_hint;
e9459e5a 417 unsigned int zero_buffers;
cf4464ca 418 unsigned int time_based;
aea47d44 419
076efc7c
JA
420 char *read_iolog_file;
421 char *write_iolog_file;
2dc1bbeb
JA
422
423 /*
424 * Pre-run and post-run shell
425 */
426 char *exec_prerun;
427 char *exec_postrun;
428
429 unsigned int rate;
430 unsigned int ratemin;
431 unsigned int ratecycle;
432 unsigned int rate_iops;
433 unsigned int rate_iops_min;
434
435 char *ioscheduler;
436
437 /*
438 * CPU "io" cycle burner
439 */
440 unsigned int cpuload;
441 unsigned int cpucycle;
442};
443
e4e33258
JA
444#define FIO_VERROR_SIZE 128
445
2dc1bbeb
JA
446/*
447 * This describes a single thread/process executing a fio job.
448 */
449struct thread_data {
450 struct thread_options o;
e4e33258 451 char verror[FIO_VERROR_SIZE];
2dc1bbeb
JA
452 pthread_t thread;
453 int thread_number;
454 int groupid;
455 struct thread_stat ts;
456 struct fio_file *files;
457 unsigned int files_index;
458 unsigned int nr_open_files;
1020a139 459 unsigned int nr_done_files;
2dc1bbeb
JA
460 unsigned int nr_normal_files;
461 union {
462 unsigned int next_file;
463 os_random_state_t next_file_state;
464 };
465 int error;
466 pid_t pid;
467 char *orig_buffer;
468 size_t orig_buffer_size;
469 volatile int terminate;
470 volatile int runstate;
471 unsigned int ioprio;
472 unsigned int last_was_sync;
473
474 char *mmapfile;
475 int mmapfd;
476
843a7413
JA
477 void *iolog_buf;
478 FILE *iolog_f;
ebac4655 479
da86774e 480 char *sysfs_root;
da86774e 481
6dfd46b9
JA
482 os_random_state_t bsrange_state;
483 os_random_state_t verify_state;
ebac4655
JA
484
485 int shm_id;
486
e9c047a0
JA
487 /*
488 * IO engine hooks, contains everything needed to submit an io_u
489 * to any of the available IO engines.
490 */
2866c82d 491 struct ioengine_ops *io_ops;
ebac4655 492
e9c047a0
JA
493 /*
494 * Current IO depth and list of free and busy io_u's.
495 */
ebac4655
JA
496 unsigned int cur_depth;
497 struct list_head io_u_freelist;
498 struct list_head io_u_busylist;
755200a3 499 struct list_head io_u_requeues;
cb5ab512 500 unsigned int io_u_queued;
ebac4655 501
e9c047a0
JA
502 /*
503 * Rate state
504 */
ebac4655
JA
505 unsigned long rate_usec_cycle;
506 long rate_pending_usleep;
507 unsigned long rate_bytes;
4e991c23 508 unsigned long rate_blocks;
ebac4655
JA
509 struct timeval lastrate;
510
ebac4655
JA
511 unsigned long long total_io_size;
512
755200a3 513 unsigned long io_issues[2];
9104f874
JA
514 unsigned long long io_blocks[2];
515 unsigned long long io_bytes[2];
9104f874 516 unsigned long long this_io_bytes[2];
079ad09b 517 unsigned long long zone_bytes;
07739b57 518 struct fio_sem *mutex;
ebac4655 519
e9c047a0
JA
520 /*
521 * State for random io, a bitmap of blocks done vs not done
522 */
6dfd46b9 523 os_random_state_t random_state;
ebac4655 524
ebac4655
JA
525 struct timeval start; /* start of this loop */
526 struct timeval epoch; /* time job was started */
38d77cae 527 struct timeval rw_end[2];
a61eddec 528 struct timeval last_issue;
38d77cae 529 unsigned int rw_end_set[2];
ebac4655 530
e9c047a0
JA
531 /*
532 * read/write mixed workload state
533 */
6dfd46b9 534 os_random_state_t rwmix_state;
afe24a5a 535 unsigned long long rwmix_bytes;
a6ccc7be 536 struct timeval rwmix_switch;
e9c047a0 537 enum fio_ddir rwmix_ddir;
211097b2 538 unsigned int ddir_nr;
a6ccc7be 539
e9c047a0 540 /*
8de8f047
JA
541 * IO history logs for verification. We use a tree for sorting,
542 * if we are overwriting. Otherwise just use a fifo.
e9c047a0 543 */
4b87898e 544 struct rb_root io_hist_tree;
8de8f047
JA
545 struct list_head io_hist_list;
546
547 /*
548 * For IO replaying
549 */
aea47d44 550 struct list_head io_log_list;
433afcb4
JA
551
552 /*
553 * timeout handling
554 */
555 struct timeval timeout_end;
556 struct itimerval timer;
1907dbc6
JA
557
558 /*
559 * for fileservice, how often to switch to a new file
560 */
561 unsigned int file_service_nr;
562 unsigned int file_service_left;
563 struct fio_file *file_service_file;
9c60ce64
JA
564
565 /*
566 * For generating file sizes
567 */
568 os_random_state_t file_size_state;
ebac4655
JA
569};
570
0aabe160
JA
571/*
572 * roundrobin available files, or choose one at random.
573 */
574enum {
575 FIO_FSERVICE_RANDOM = 1,
576 FIO_FSERVICE_RR = 2,
577};
578
433afcb4
JA
579/*
580 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
581 * the timer on each queue operation.
582 */
583#define IO_U_TIMEOUT_INC 5
584#define IO_U_TIMEOUT 30
585
e1161c32 586#define __td_verror(td, err, msg, func) \
ebac4655 587 do { \
19abcd3d
JA
588 if ((td)->error) \
589 break; \
ebac4655
JA
590 int e = (err); \
591 (td)->error = e; \
e1161c32 592 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
ebac4655
JA
593 } while (0)
594
b990b5c0 595
e1161c32
JA
596#define td_verror(td, err, func) \
597 __td_verror((td), (err), strerror((err)), (func))
598#define td_vmsg(td, err, msg, func) \
599 __td_verror((td), (err), (msg), (func))
b990b5c0 600
ebac4655
JA
601extern int exitall_on_terminate;
602extern int thread_number;
9cedf167 603extern int nr_process, nr_thread;
ebac4655
JA
604extern int shm_id;
605extern int groupid;
c6ae0a5b 606extern int terse_output;
eb8bbf48
JA
607extern FILE *f_out;
608extern FILE *f_err;
53cdc686 609extern int temp_stall_ts;
1e97cce9 610extern unsigned long long mlock_size;
cfc99db7 611extern unsigned long page_mask, page_size;
ebac4655
JA
612
613extern struct thread_data *threads;
614
2dc1bbeb
JA
615#define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
616#define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
617#define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
618#define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
ebac4655
JA
619
620#define BLOCKS_PER_MAP (8 * sizeof(long))
2dc1bbeb 621#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
53cdc686
JA
622#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
623#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
ebac4655
JA
624
625#define MAX_JOBS (1024)
626
87dc1ab1
JA
627static inline int should_fsync(struct thread_data *td)
628{
629 if (td->last_was_sync)
630 return 0;
2dc1bbeb 631 if (td->o.odirect)
87dc1ab1 632 return 0;
2dc1bbeb 633 if (td_write(td) || td_rw(td) || td->o.override_sync)
87dc1ab1
JA
634 return 1;
635
636 return 0;
637}
638
1c9e06ee
JA
639/*
640 * Disk utils as read in /sys/block/<dev>/stat
641 */
ebac4655
JA
642struct disk_util_stat {
643 unsigned ios[2];
644 unsigned merges[2];
645 unsigned long long sectors[2];
646 unsigned ticks[2];
647 unsigned io_ticks;
648 unsigned time_in_queue;
649};
650
1c9e06ee
JA
651/*
652 * Per-device disk util management
653 */
ebac4655
JA
654struct disk_util {
655 struct list_head list;
656
657 char *name;
e11c410c 658 char *sysfs_root;
ebac4655 659 char path[256];
07e5b264 660 int major, minor;
ebac4655
JA
661
662 struct disk_util_stat dus;
663 struct disk_util_stat last_dus;
664
665 unsigned long msec;
666 struct timeval time;
667};
668
ebac4655
JA
669#define DISK_UTIL_MSEC (250)
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
fb7b71a3
JA
826/*
827 * blktrace support
828 */
5e62c22a 829#ifdef FIO_HAVE_BLKTRACE
fb7b71a3
JA
830extern int is_blktrace(const char *);
831extern int load_blktrace(struct thread_data *, const char *);
5e62c22a 832#endif
fb7b71a3 833
3b70d7e5
JA
834/*
835 * If logging output to a file, stderr should go to both stderr and f_err
836 */
837#define log_err(args...) do { \
838 fprintf(f_err, ##args); \
839 if (f_err != stderr) \
840 fprintf(stderr, ##args); \
841 } while (0)
842
9c60ce64
JA
843#define log_info(args...) fprintf(f_out, ##args)
844
9728ce37
JB
845FILE *get_f_out(void);
846FILE *get_f_err(void);
847
2866c82d 848struct ioengine_ops {
5f350952 849 struct list_head list;
2866c82d
JA
850 char name[16];
851 int version;
852 int flags;
ea2877a4 853 int (*setup)(struct thread_data *);
2866c82d
JA
854 int (*init)(struct thread_data *);
855 int (*prep)(struct thread_data *, struct io_u *);
856 int (*queue)(struct thread_data *, struct io_u *);
755200a3 857 int (*commit)(struct thread_data *);
2866c82d
JA
858 int (*getevents)(struct thread_data *, int, int, struct timespec *);
859 struct io_u *(*event)(struct thread_data *, int);
860 int (*cancel)(struct thread_data *, struct io_u *);
861 void (*cleanup)(struct thread_data *);
b5af8293
JA
862 int (*open_file)(struct thread_data *, struct fio_file *);
863 void (*close_file)(struct thread_data *, struct fio_file *);
2866c82d
JA
864 void *data;
865 void *dlhandle;
866};
867
2c187c0f 868#define FIO_IOOPS_VERSION 7
2866c82d 869
b4692828 870extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
b2fdda43 871extern void register_ioengine(struct ioengine_ops *);
5f350952 872extern void unregister_ioengine(struct ioengine_ops *);
2866c82d
JA
873extern void close_ioengine(struct thread_data *);
874
875/*
876 * Mark unused variables passed to ops functions as unused, to silence gcc
877 */
878#define fio_unused __attribute((__unused__))
5f350952
JA
879#define fio_init __attribute__((constructor))
880#define fio_exit __attribute__((destructor))
2866c82d 881
34572e28
JA
882#define for_each_td(td, i) \
883 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
53cdc686 884#define for_each_file(td, f, i) \
2dc1bbeb 885 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
53cdc686 886
0032bf9f
JA
887#define fio_assert(td, cond) do { \
888 if (!(cond)) { \
340fd243 889 int *__foo = NULL; \
0032bf9f
JA
890 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
891 (td)->runstate = TD_EXITED; \
437c9b71 892 (td)->error = EFAULT; \
340fd243 893 *__foo = 0; \
0032bf9f
JA
894 } \
895} while (0)
896
9bf27b45
JA
897static inline void clear_error(struct thread_data *td)
898{
899 td->error = 0;
900 td->verror[0] = '\0';
901}
902
ebac4655 903#endif