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