Some more bits of blktrace support
[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 137 unsigned long long offset;
d460eb31 138 unsigned long long endpos;
ebac4655 139
1c9e06ee
JA
140 /*
141 * IO engine state, may be different from above when we get
142 * partial transfers / residual data counts
143 */
cec6b55d 144 void *xfer_buf;
a4f4fdd7 145 unsigned long xfer_buflen;
cec6b55d 146
ebac4655
JA
147 unsigned int resid;
148 unsigned int error;
149
1e97cce9 150 enum fio_ddir ddir;
ebac4655 151
dfd7bc2c
JA
152 /*
153 * io engine private data
154 */
155 union {
156 unsigned int index;
157 unsigned int seen;
158 };
159
0c6e7517
JA
160 unsigned int flags;
161
53cdc686
JA
162 struct fio_file *file;
163
ebac4655 164 struct list_head list;
d7762cf8
JA
165
166 /*
167 * Callback for io completion
168 */
36690c9b 169 int (*end_io)(struct thread_data *, struct io_u *);
ebac4655
JA
170};
171
36167d82
JA
172/*
173 * io_ops->queue() return values
174 */
175enum {
176 FIO_Q_COMPLETED = 0, /* completed sync */
177 FIO_Q_QUEUED = 1, /* queued, will complete async */
755200a3 178 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
36167d82
JA
179};
180
ebac4655
JA
181#define FIO_HDR_MAGIC 0xf00baaef
182
183enum {
1c9e06ee
JA
184 VERIFY_NONE = 0, /* no verification */
185 VERIFY_MD5, /* md5 sum data blocks */
186 VERIFY_CRC32, /* crc32 sum data blocks */
36690c9b 187 VERIFY_NULL, /* pretend to verify */
ebac4655
JA
188};
189
1c9e06ee
JA
190/*
191 * A header structure associated with each checksummed data block
192 */
ebac4655
JA
193struct verify_header {
194 unsigned int fio_magic;
195 unsigned int len;
196 unsigned int verify_type;
197 union {
198 char md5_digest[MD5_HASH_WORDS * 4];
199 unsigned long crc32;
200 };
201};
202
203struct group_run_stats {
9104f874
JA
204 unsigned long long max_run[2], min_run[2];
205 unsigned long long max_bw[2], min_bw[2];
e9b2a3fa 206 unsigned long long io_kb[2];
9104f874 207 unsigned long long agg[2];
ebac4655
JA
208};
209
e9c047a0
JA
210/*
211 * What type of allocation to use for io buffers
212 */
213enum fio_memtype {
214 MEM_MALLOC = 0, /* ordinary malloc */
215 MEM_SHM, /* use shared memory segments */
74b025b0 216 MEM_SHMHUGE, /* use shared memory segments with huge pages */
e9c047a0 217 MEM_MMAP, /* use anonynomous mmap */
d0bdaf49 218 MEM_MMAPHUGE, /* memory mapped huge file */
e9c047a0
JA
219};
220
221/*
222 * The type of object we are working on
223 */
224enum fio_filetype {
1c9e06ee
JA
225 FIO_TYPE_FILE = 1, /* plain file */
226 FIO_TYPE_BD, /* block device */
227 FIO_TYPE_CHAR, /* character device */
b5605e9d 228 FIO_TYPE_PIPE, /* pipe */
e9c047a0
JA
229};
230
2866c82d 231enum fio_ioengine_flags {
1c9e06ee 232 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
ba0fbe10
JA
233 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
234 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
0263882a 235 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
62d984e2 236 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
e9c047a0
JA
237};
238
f11bd94d 239enum fio_file_flags {
0ad920e7 240 FIO_FILE_OPEN = 1 << 0, /* file is open */
a9b7b305
JA
241 FIO_FILE_CLOSING = 1 << 1, /* file being closed */
242 FIO_FILE_EXISTS = 1 << 2, /* file there */
243 FIO_FILE_EXTEND = 1 << 3, /* needs extend */
244 FIO_FILE_NOSORT = 1 << 4, /* don't sort verify blocks */
245 FIO_FILE_DONE = 1 << 5, /* io completed to this file */
246 FIO_SIZE_KNOWN = 1 << 6, /* 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];
30061b97 335 unsigned long short_io_u[2];
756867bd
JA
336
337 unsigned long long io_bytes[2];
338 unsigned long runtime[2];
339 unsigned long total_run_time;
b2560f3c 340};
71619dc2 341
2dc1bbeb 342struct thread_options {
b1ec1da6 343 int pad;
61697c37 344 char *description;
b4692828 345 char *name;
ef899b63 346 char *directory;
13f8e2d2 347 char *filename;
2dc1bbeb 348 char *opendir;
09629a90 349 char *ioengine;
413dd459 350 enum td_ddir td_ddir;
211097b2 351 unsigned int ddir_nr;
2dc1bbeb
JA
352 unsigned int iodepth;
353 unsigned int iodepth_low;
354 unsigned int iodepth_batch;
355
356 unsigned long long size;
357 unsigned long long file_size_low;
358 unsigned long long file_size_high;
359 unsigned long long start_offset;
360
361 unsigned int bs[2];
362 unsigned int min_bs[2];
363 unsigned int max_bs[2];
364
365 unsigned int nr_files;
366 unsigned int open_files;
e9c047a0 367
9158d2f7
JA
368 unsigned int odirect;
369 unsigned int invalidate_cache;
370 unsigned int create_serialize;
371 unsigned int create_fsync;
372 unsigned int end_fsync;
373 unsigned int sync_io;
374 unsigned int verify;
160b966d 375 unsigned int verifysort;
9158d2f7
JA
376 unsigned int use_thread;
377 unsigned int unlink;
378 unsigned int do_disk_util;
379 unsigned int override_sync;
380 unsigned int rand_repeatable;
381 unsigned int write_lat_log;
382 unsigned int write_bw_log;
bb8895e0 383 unsigned int norandommap;
690adba3 384 unsigned int bs_unaligned;
ebb1415f 385 unsigned int fsync_on_close;
e9c047a0 386
56bb17f2 387 unsigned int hugepage_size;
a00735e6 388 unsigned int rw_min_bs;
ebac4655 389 unsigned int thinktime;
48097d5c 390 unsigned int thinktime_spin;
9c1f7434 391 unsigned int thinktime_blocks;
ebac4655
JA
392 unsigned int fsync_blocks;
393 unsigned int start_delay;
906c8d75 394 unsigned long timeout;
ebac4655 395 unsigned int overwrite;
ebac4655 396 unsigned int bw_avg_time;
ebac4655 397 unsigned int loops;
20dc95c4
JA
398 unsigned long long zone_size;
399 unsigned long long zone_skip;
e9c047a0 400 enum fio_memtype mem_type;
2dc1bbeb 401
ebac4655 402 unsigned int stonewall;
b3d62a75 403 unsigned int new_group;
ebac4655 404 unsigned int numjobs;
ebac4655 405 os_cpu_mask_t cpumask;
aea47d44 406 unsigned int 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;
e9459e5a 413 unsigned int zero_buffers;
cf4464ca 414 unsigned int time_based;
aea47d44 415
076efc7c
JA
416 char *read_iolog_file;
417 char *write_iolog_file;
2dc1bbeb
JA
418
419 /*
420 * Pre-run and post-run shell
421 */
422 char *exec_prerun;
423 char *exec_postrun;
424
425 unsigned int rate;
426 unsigned int ratemin;
427 unsigned int ratecycle;
428 unsigned int rate_iops;
429 unsigned int rate_iops_min;
430
431 char *ioscheduler;
432
433 /*
434 * CPU "io" cycle burner
435 */
436 unsigned int cpuload;
437 unsigned int cpucycle;
438};
439
e4e33258
JA
440#define FIO_VERROR_SIZE 128
441
2dc1bbeb
JA
442/*
443 * This describes a single thread/process executing a fio job.
444 */
445struct thread_data {
446 struct thread_options o;
e4e33258 447 char verror[FIO_VERROR_SIZE];
2dc1bbeb
JA
448 pthread_t thread;
449 int thread_number;
450 int groupid;
451 struct thread_stat ts;
452 struct fio_file *files;
453 unsigned int files_index;
454 unsigned int nr_open_files;
1020a139 455 unsigned int nr_done_files;
2dc1bbeb
JA
456 unsigned int nr_normal_files;
457 union {
458 unsigned int next_file;
459 os_random_state_t next_file_state;
460 };
461 int error;
462 pid_t pid;
463 char *orig_buffer;
464 size_t orig_buffer_size;
465 volatile int terminate;
466 volatile int runstate;
467 unsigned int ioprio;
468 unsigned int last_was_sync;
469
470 char *mmapfile;
471 int mmapfd;
472
843a7413
JA
473 void *iolog_buf;
474 FILE *iolog_f;
ebac4655 475
da86774e 476 char *sysfs_root;
da86774e 477
6dfd46b9
JA
478 os_random_state_t bsrange_state;
479 os_random_state_t verify_state;
ebac4655
JA
480
481 int shm_id;
482
e9c047a0
JA
483 /*
484 * IO engine hooks, contains everything needed to submit an io_u
485 * to any of the available IO engines.
486 */
2866c82d 487 struct ioengine_ops *io_ops;
ebac4655 488
e9c047a0
JA
489 /*
490 * Current IO depth and list of free and busy io_u's.
491 */
ebac4655
JA
492 unsigned int cur_depth;
493 struct list_head io_u_freelist;
494 struct list_head io_u_busylist;
755200a3 495 struct list_head io_u_requeues;
cb5ab512 496 unsigned int io_u_queued;
ebac4655 497
e9c047a0
JA
498 /*
499 * Rate state
500 */
ebac4655
JA
501 unsigned long rate_usec_cycle;
502 long rate_pending_usleep;
503 unsigned long rate_bytes;
4e991c23 504 unsigned long rate_blocks;
ebac4655
JA
505 struct timeval lastrate;
506
ebac4655
JA
507 unsigned long long total_io_size;
508
755200a3 509 unsigned long io_issues[2];
9104f874
JA
510 unsigned long long io_blocks[2];
511 unsigned long long io_bytes[2];
9104f874 512 unsigned long long this_io_bytes[2];
079ad09b 513 unsigned long long zone_bytes;
07739b57 514 struct fio_sem *mutex;
ebac4655 515
e9c047a0
JA
516 /*
517 * State for random io, a bitmap of blocks done vs not done
518 */
6dfd46b9 519 os_random_state_t random_state;
ebac4655 520
ebac4655
JA
521 struct timeval start; /* start of this loop */
522 struct timeval epoch; /* time job was started */
38d77cae
JA
523 struct timeval rw_end[2];
524 unsigned int rw_end_set[2];
ebac4655 525
e9c047a0
JA
526 /*
527 * read/write mixed workload state
528 */
6dfd46b9 529 os_random_state_t rwmix_state;
afe24a5a 530 unsigned long long rwmix_bytes;
a6ccc7be 531 struct timeval rwmix_switch;
e9c047a0 532 enum fio_ddir rwmix_ddir;
211097b2 533 unsigned int ddir_nr;
a6ccc7be 534
e9c047a0 535 /*
8de8f047
JA
536 * IO history logs for verification. We use a tree for sorting,
537 * if we are overwriting. Otherwise just use a fifo.
e9c047a0 538 */
4b87898e 539 struct rb_root io_hist_tree;
8de8f047
JA
540 struct list_head io_hist_list;
541
542 /*
543 * For IO replaying
544 */
aea47d44 545 struct list_head io_log_list;
433afcb4
JA
546
547 /*
548 * timeout handling
549 */
550 struct timeval timeout_end;
551 struct itimerval timer;
1907dbc6
JA
552
553 /*
554 * for fileservice, how often to switch to a new file
555 */
556 unsigned int file_service_nr;
557 unsigned int file_service_left;
558 struct fio_file *file_service_file;
9c60ce64
JA
559
560 /*
561 * For generating file sizes
562 */
563 os_random_state_t file_size_state;
ebac4655
JA
564};
565
0aabe160
JA
566/*
567 * roundrobin available files, or choose one at random.
568 */
569enum {
570 FIO_FSERVICE_RANDOM = 1,
571 FIO_FSERVICE_RR = 2,
572};
573
433afcb4
JA
574/*
575 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
576 * the timer on each queue operation.
577 */
578#define IO_U_TIMEOUT_INC 5
579#define IO_U_TIMEOUT 30
580
e1161c32 581#define __td_verror(td, err, msg, func) \
ebac4655 582 do { \
19abcd3d
JA
583 if ((td)->error) \
584 break; \
ebac4655
JA
585 int e = (err); \
586 (td)->error = e; \
e1161c32 587 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
ebac4655
JA
588 } while (0)
589
b990b5c0 590
e1161c32
JA
591#define td_verror(td, err, func) \
592 __td_verror((td), (err), strerror((err)), (func))
593#define td_vmsg(td, err, msg, func) \
594 __td_verror((td), (err), (msg), (func))
b990b5c0 595
ebac4655
JA
596extern int exitall_on_terminate;
597extern int thread_number;
9cedf167 598extern int nr_process, nr_thread;
ebac4655
JA
599extern int shm_id;
600extern int groupid;
c6ae0a5b 601extern int terse_output;
eb8bbf48
JA
602extern FILE *f_out;
603extern FILE *f_err;
53cdc686 604extern int temp_stall_ts;
1e97cce9 605extern unsigned long long mlock_size;
cfc99db7 606extern unsigned long page_mask, page_size;
ebac4655
JA
607
608extern struct thread_data *threads;
609
2dc1bbeb
JA
610#define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
611#define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
612#define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
613#define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
ebac4655
JA
614
615#define BLOCKS_PER_MAP (8 * sizeof(long))
2dc1bbeb 616#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
53cdc686
JA
617#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
618#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
ebac4655
JA
619
620#define MAX_JOBS (1024)
621
87dc1ab1
JA
622static inline int should_fsync(struct thread_data *td)
623{
624 if (td->last_was_sync)
625 return 0;
2dc1bbeb 626 if (td->o.odirect)
87dc1ab1 627 return 0;
2dc1bbeb 628 if (td_write(td) || td_rw(td) || td->o.override_sync)
87dc1ab1
JA
629 return 1;
630
631 return 0;
632}
633
1c9e06ee
JA
634/*
635 * Disk utils as read in /sys/block/<dev>/stat
636 */
ebac4655
JA
637struct disk_util_stat {
638 unsigned ios[2];
639 unsigned merges[2];
640 unsigned long long sectors[2];
641 unsigned ticks[2];
642 unsigned io_ticks;
643 unsigned time_in_queue;
644};
645
1c9e06ee
JA
646/*
647 * Per-device disk util management
648 */
ebac4655
JA
649struct disk_util {
650 struct list_head list;
651
652 char *name;
e11c410c 653 char *sysfs_root;
ebac4655 654 char path[256];
07e5b264 655 int major, minor;
ebac4655
JA
656
657 struct disk_util_stat dus;
658 struct disk_util_stat last_dus;
659
660 unsigned long msec;
661 struct timeval time;
662};
663
ebac4655
JA
664#define DISK_UTIL_MSEC (250)
665
6a0106a0
JA
666#ifndef min
667#define min(a, b) ((a) < (b) ? (a) : (b))
668#endif
a00735e6
JA
669#ifndef max
670#define max(a, b) ((a) > (b) ? (a) : (b))
671#endif
6a0106a0 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 */
831extern int is_blktrace(const char *);
832extern int load_blktrace(struct thread_data *, const char *);
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