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