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