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