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