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