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