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