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