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