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