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