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