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