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