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