blob: 0373d2af0fedef8fd9783e45720168d0644af518 [file] [log] [blame]
Jens Axboeebac4652005-12-08 15:25:21 +01001#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>
Jens Axboe3c39a372006-06-06 20:56:12 +02009#include <errno.h>
10#include <stdlib.h>
11#include <stdio.h>
Jens Axboe6d6f0312006-06-07 21:39:13 +020012#include <unistd.h>
Jens Axboe34cfcda2006-11-03 14:00:45 +010013#include <string.h>
Jens Axboe214e1ec2007-03-15 10:48:13 +010014#include <getopt.h>
Jens Axboecd14cc12007-07-30 10:59:33 +020015#include <inttypes.h>
Jens Axboeebac4652005-12-08 15:25:21 +010016
Jens Axboe317b95d2007-04-02 21:36:44 +020017#include "compiler/compiler.h"
Jens Axboeebac4652005-12-08 15:25:21 +010018#include "list.h"
Jens Axboee2887562007-05-16 09:25:09 +020019#include "fifo.h"
Jens Axboe4b878982007-03-26 09:32:22 +020020#include "rbtree.h"
Jens Axboe317b95d2007-04-02 21:36:44 +020021#include "arch/arch.h"
22#include "os/os.h"
Jens Axboe07739b52007-03-08 20:25:46 +010023#include "mutex.h"
Jens Axboeebac4652005-12-08 15:25:21 +010024
Jens Axboeb6959b52007-02-14 21:40:27 +000025#ifdef FIO_HAVE_SYSLET
Jens Axboea4f4fdd2007-02-14 01:16:39 +010026#include "syslet.h"
Jens Axboeb6959b52007-02-14 21:40:27 +000027#endif
Jens Axboea4f4fdd2007-02-14 01:16:39 +010028
Davide Libenzi609342f2007-03-21 08:46:18 +010029#ifdef FIO_HAVE_GUASI
30#include <guasi.h>
31#endif
32
Jens Axboe1e97cce2006-12-05 11:44:16 +010033enum fio_ddir {
34 DDIR_READ = 0,
35 DDIR_WRITE,
36 DDIR_SYNC,
Jens Axboef29b25a2007-07-23 08:56:43 +020037 DDIR_INVAL = -1,
Jens Axboe1e97cce2006-12-05 11:44:16 +010038};
39
Jens Axboe413dd452007-02-23 09:26:09 +010040enum td_ddir {
Jens Axboeb1ec1da2007-02-23 10:29:16 +010041 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,
Joel Becker7ff1c142007-03-03 12:03:29 +010046 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
Jens Axboeb1ec1da2007-02-23 10:29:16 +010047 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
Jens Axboe413dd452007-02-23 09:26:09 +010048};
49
Jens Axboe1c9e06e2007-02-11 04:07:57 +010050/*
51 * Use for maintaining statistics
52 */
Jens Axboeebac4652005-12-08 15:25:21 +010053struct io_stat {
Jens Axboeebac4652005-12-08 15:25:21 +010054 unsigned long max_val;
55 unsigned long min_val;
56 unsigned long samples;
Jens Axboe68704082007-01-10 19:56:37 +010057
58 double mean;
59 double S;
Jens Axboeebac4652005-12-08 15:25:21 +010060};
61
Jens Axboe1c9e06e2007-02-11 04:07:57 +010062/*
63 * A single data sample
64 */
Jens Axboeebac4652005-12-08 15:25:21 +010065struct io_sample {
66 unsigned long time;
67 unsigned long val;
Jens Axboe1e97cce2006-12-05 11:44:16 +010068 enum fio_ddir ddir;
Jens Axboeebac4652005-12-08 15:25:21 +010069};
70
Jens Axboe1c9e06e2007-02-11 04:07:57 +010071/*
72 * Dynamically growing data sample log
73 */
Jens Axboeebac4652005-12-08 15:25:21 +010074struct io_log {
75 unsigned long nr_samples;
76 unsigned long max_samples;
77 struct io_sample *log;
78};
79
Jens Axboe1c9e06e2007-02-11 04:07:57 +010080/*
81 * When logging io actions, this matches a single sent io_u
82 */
Jens Axboeebac4652005-12-08 15:25:21 +010083struct io_piece {
Jens Axboe4b878982007-03-26 09:32:22 +020084 union {
85 struct rb_node rb_node;
86 struct list_head list;
87 };
Jens Axboef29b25a2007-07-23 08:56:43 +020088 union {
89 int fileno;
90 struct fio_file *file;
91 };
Jens Axboeebac4652005-12-08 15:25:21 +010092 unsigned long long offset;
Jens Axboea4f4fdd2007-02-14 01:16:39 +010093 unsigned long len;
Jens Axboe1e97cce2006-12-05 11:44:16 +010094 enum fio_ddir ddir;
Jens Axboef29b25a2007-07-23 08:56:43 +020095 union {
96 unsigned long delay;
97 unsigned int file_action;
98 };
Jens Axboeebac4652005-12-08 15:25:21 +010099};
100
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100101#ifdef FIO_HAVE_SYSLET
102struct syslet_req {
Jens Axboe5b38ee82007-02-26 10:44:22 +0100103 struct syslet_uatom atom; /* the atom to submit */
104 struct syslet_uatom *head; /* head of the sequence */
105 long ret; /* syscall return value */
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100106};
107#endif
108
Jens Axboe0c6e7512007-02-22 11:19:39 +0100109enum {
110 IO_U_F_FREE = 1 << 0,
111 IO_U_F_FLIGHT = 1 << 1,
112};
113
Jens Axboe36690c92007-03-26 10:23:34 +0200114struct thread_data;
115
Jens Axboeebac4652005-12-08 15:25:21 +0100116/*
117 * The io unit
118 */
119struct io_u {
120 union {
121#ifdef FIO_HAVE_LIBAIO
122 struct iocb iocb;
123#endif
124#ifdef FIO_HAVE_POSIXAIO
125 struct aiocb aiocb;
126#endif
127#ifdef FIO_HAVE_SGIO
128 struct sg_io_hdr hdr;
129#endif
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100130#ifdef FIO_HAVE_SYSLET
Jens Axboea2e1b082007-02-14 08:06:19 +0100131 struct syslet_req req;
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100132#endif
Davide Libenzi609342f2007-03-21 08:46:18 +0100133#ifdef FIO_HAVE_GUASI
134 guasi_req_t greq;
135#endif
Jens Axboeebac4652005-12-08 15:25:21 +0100136 };
137 struct timeval start_time;
138 struct timeval issue_time;
139
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100140 /*
141 * Allocated/set buffer and length
142 */
Jens Axboe6b9cea22006-10-30 17:00:24 +0100143 void *buf;
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100144 unsigned long buflen;
Jens Axboeebac4652005-12-08 15:25:21 +0100145 unsigned long long offset;
Jens Axboed460eb32007-04-16 21:39:33 +0200146 unsigned long long endpos;
Jens Axboeebac4652005-12-08 15:25:21 +0100147
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100148 /*
149 * IO engine state, may be different from above when we get
150 * partial transfers / residual data counts
151 */
Jens Axboecec6b552007-02-06 20:15:38 +0100152 void *xfer_buf;
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100153 unsigned long xfer_buflen;
Jens Axboecec6b552007-02-06 20:15:38 +0100154
Jens Axboeebac4652005-12-08 15:25:21 +0100155 unsigned int resid;
156 unsigned int error;
157
Jens Axboe1e97cce2006-12-05 11:44:16 +0100158 enum fio_ddir ddir;
Jens Axboeebac4652005-12-08 15:25:21 +0100159
Jens Axboedfd7bc22006-10-24 12:17:57 +0200160 /*
161 * io engine private data
162 */
163 union {
164 unsigned int index;
165 unsigned int seen;
166 };
167
Jens Axboe0c6e7512007-02-22 11:19:39 +0100168 unsigned int flags;
169
Jens Axboe53cdc682006-10-18 11:50:58 +0200170 struct fio_file *file;
171
Jens Axboeebac4652005-12-08 15:25:21 +0100172 struct list_head list;
Jens Axboed7762cf2007-02-23 12:34:57 +0100173
174 /*
175 * Callback for io completion
176 */
Jens Axboe36690c92007-03-26 10:23:34 +0200177 int (*end_io)(struct thread_data *, struct io_u *);
Jens Axboeebac4652005-12-08 15:25:21 +0100178};
179
Jens Axboe36167d82007-02-18 05:41:31 +0100180/*
181 * io_ops->queue() return values
182 */
183enum {
184 FIO_Q_COMPLETED = 0, /* completed sync */
185 FIO_Q_QUEUED = 1, /* queued, will complete async */
Jens Axboe755200a2007-02-19 13:08:12 +0100186 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
Jens Axboe36167d82007-02-18 05:41:31 +0100187};
188
Jens Axboeebac4652005-12-08 15:25:21 +0100189#define FIO_HDR_MAGIC 0xf00baaef
190
191enum {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100192 VERIFY_NONE = 0, /* no verification */
193 VERIFY_MD5, /* md5 sum data blocks */
Jens Axboed77a7af2007-07-27 15:35:06 +0200194 VERIFY_CRC64, /* crc64 sum data blocks */
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100195 VERIFY_CRC32, /* crc32 sum data blocks */
Jens Axboe969f7ed2007-07-27 09:07:17 +0200196 VERIFY_CRC16, /* crc16 sum data blocks */
Jens Axboe1e154bd2007-07-27 09:52:40 +0200197 VERIFY_CRC7, /* crc7 sum data blocks */
Jens Axboecd14cc12007-07-30 10:59:33 +0200198 VERIFY_SHA256, /* sha256 sum data blocks */
199 VERIFY_SHA512, /* sha512 sum data blocks */
Shawn Lewis7437ee82007-08-02 21:05:58 +0200200 VERIFY_META, /* block_num, timestamp etc. */
Jens Axboe36690c92007-03-26 10:23:34 +0200201 VERIFY_NULL, /* pretend to verify */
Jens Axboeebac4652005-12-08 15:25:21 +0100202};
203
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100204/*
Jens Axboe546dfd92007-07-30 12:23:05 +0200205 * A header structure associated with each checksummed data block. It is
206 * followed by a checksum specific header that contains the verification
207 * data.
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100208 */
Jens Axboeebac4652005-12-08 15:25:21 +0100209struct verify_header {
210 unsigned int fio_magic;
211 unsigned int len;
212 unsigned int verify_type;
Jens Axboe546dfd92007-07-30 12:23:05 +0200213};
214
215struct vhdr_md5 {
216 uint32_t md5_digest[16];
217};
218struct vhdr_sha512 {
219 uint8_t sha512[128];
220};
221struct vhdr_sha256 {
222 uint8_t sha256[128];
223};
224struct vhdr_crc64 {
225 uint64_t crc64;
226};
227struct vhdr_crc32 {
228 uint32_t crc32;
229};
230struct vhdr_crc16 {
231 uint16_t crc16;
232};
233struct vhdr_crc7 {
234 uint8_t crc7;
Jens Axboeebac4652005-12-08 15:25:21 +0100235};
Shawn Lewis7437ee82007-08-02 21:05:58 +0200236struct vhdr_meta {
237 uint64_t offset;
238 unsigned char thread;
239 unsigned short numberio;
240 unsigned long time_sec;
241 unsigned long time_usec;
242};
Jens Axboeebac4652005-12-08 15:25:21 +0100243
244struct group_run_stats {
Jens Axboe9104f872005-12-28 23:50:45 +0100245 unsigned long long max_run[2], min_run[2];
246 unsigned long long max_bw[2], min_bw[2];
Jens Axboee9b2a3f2006-06-06 15:38:33 +0200247 unsigned long long io_kb[2];
Jens Axboe9104f872005-12-28 23:50:45 +0100248 unsigned long long agg[2];
Jens Axboeebac4652005-12-08 15:25:21 +0100249};
250
Jens Axboee9c047a2006-06-07 21:13:04 +0200251/*
252 * What type of allocation to use for io buffers
253 */
254enum fio_memtype {
255 MEM_MALLOC = 0, /* ordinary malloc */
256 MEM_SHM, /* use shared memory segments */
Jens Axboe74b025b2006-12-19 15:18:14 +0100257 MEM_SHMHUGE, /* use shared memory segments with huge pages */
Jens Axboee9c047a2006-06-07 21:13:04 +0200258 MEM_MMAP, /* use anonynomous mmap */
Jens Axboed0bdaf42006-12-20 14:40:44 +0100259 MEM_MMAPHUGE, /* memory mapped huge file */
Jens Axboee9c047a2006-06-07 21:13:04 +0200260};
261
262/*
263 * The type of object we are working on
264 */
265enum fio_filetype {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100266 FIO_TYPE_FILE = 1, /* plain file */
267 FIO_TYPE_BD, /* block device */
268 FIO_TYPE_CHAR, /* character device */
Jens Axboeb5605e92007-04-16 20:42:33 +0200269 FIO_TYPE_PIPE, /* pipe */
Jens Axboee9c047a2006-06-07 21:13:04 +0200270};
271
Jens Axboe2866c822006-10-09 15:57:48 +0200272enum fio_ioengine_flags {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100273 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
Jens Axboeba0fbe12007-03-09 14:34:23 +0100274 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
275 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
Jens Axboe02638822007-03-12 09:25:55 +0100276 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
Jens Axboe62d984e2007-03-13 08:15:18 +0100277 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
Jens Axboeb67740d2007-07-26 12:22:30 +0200278 FIO_UNIDIR = 1 << 5, /* engine is uni-directional */
Jens Axboee9c047a2006-06-07 21:13:04 +0200279};
280
Jens Axboef11bd942007-03-13 10:16:34 +0100281enum fio_file_flags {
Jens Axboe0ad920e2007-03-13 11:06:45 +0100282 FIO_FILE_OPEN = 1 << 0, /* file is open */
Jens Axboea9b7b302007-04-19 16:31:16 +0200283 FIO_FILE_CLOSING = 1 << 1, /* file being closed */
284 FIO_FILE_EXISTS = 1 << 2, /* file there */
285 FIO_FILE_EXTEND = 1 << 3, /* needs extend */
286 FIO_FILE_NOSORT = 1 << 4, /* don't sort verify blocks */
287 FIO_FILE_DONE = 1 << 5, /* io completed to this file */
288 FIO_SIZE_KNOWN = 1 << 6, /* size has been set */
Jens Axboef11bd942007-03-13 10:16:34 +0100289};
290
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100291/*
292 * Each thread_data structure has a number of files associated with it,
293 * this structure holds state information for a single file.
294 */
Jens Axboe53cdc682006-10-18 11:50:58 +0200295struct fio_file {
Jens Axboeaf52b342007-03-13 10:07:47 +0100296 enum fio_filetype filetype;
297
Jens Axboe53cdc682006-10-18 11:50:58 +0200298 /*
299 * A file may not be a file descriptor, let the io engine decide
300 */
301 union {
302 unsigned long file_data;
Jens Axboee26f8f72007-02-17 04:39:54 +0100303 int fd;
Jens Axboe53cdc682006-10-18 11:50:58 +0200304 };
Jens Axboe7bb48f82007-03-27 15:30:28 +0200305
306 /*
307 * filename and possible memory mapping
308 */
Jens Axboe1315a682007-03-13 11:25:07 +0100309 char *file_name;
Jens Axboe53cdc682006-10-18 11:50:58 +0200310 void *mmap;
Jens Axboe5e6c2062007-05-16 14:40:29 +0200311 unsigned int major, minor;
Jens Axboe7bb48f82007-03-27 15:30:28 +0200312
313 /*
314 * size of the file, offset into file, and io size from that offset
315 */
Jens Axboe53cdc682006-10-18 11:50:58 +0200316 unsigned long long real_file_size;
317 unsigned long long file_offset;
Jens Axboe7bb48f82007-03-27 15:30:28 +0200318 unsigned long long io_size;
319
Jens Axboe53cdc682006-10-18 11:50:58 +0200320 unsigned long long last_pos;
Jens Axboe02bcaa82006-11-24 10:42:00 +0100321 unsigned long long last_completed_pos;
Jens Axboe53cdc682006-10-18 11:50:58 +0200322
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100323 /*
324 * block map for random io
325 */
Jens Axboe53cdc682006-10-18 11:50:58 +0200326 unsigned long *file_map;
327 unsigned int num_maps;
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100328 unsigned int last_free_lookup;
Jens Axboe9b031dc2006-12-15 16:01:54 +0100329
Jens Axboe0ad920e2007-03-13 11:06:45 +0100330 int references;
Jens Axboef11bd942007-03-13 10:16:34 +0100331 enum fio_file_flags flags;
Jens Axboe53cdc682006-10-18 11:50:58 +0200332};
333
Jens Axboeb2560f32007-03-06 12:43:03 +0100334/*
335 * How many depth levels to log
336 */
337#define FIO_IO_U_MAP_NR 8
Jens Axboea9a18a32007-07-06 14:09:49 +0200338#define FIO_IO_U_LAT_U_NR 10
339#define FIO_IO_U_LAT_M_NR 12
Jens Axboeb2560f32007-03-06 12:43:03 +0100340
Jens Axboe079ad092007-02-20 13:58:20 +0100341struct thread_stat {
Jens Axboe756867b2007-03-06 15:19:24 +0100342 char *name;
343 char *verror;
344 int error;
345 int groupid;
346 pid_t pid;
347 char *description;
Jens Axboe6586ee82007-03-06 19:46:09 +0100348 int members;
Jens Axboe756867b2007-03-06 15:19:24 +0100349
Jens Axboe079ad092007-02-20 13:58:20 +0100350 struct io_log *slat_log;
351 struct io_log *clat_log;
352 struct io_log *bw_log;
353
354 /*
355 * bandwidth and latency stats
356 */
357 struct io_stat clat_stat[2]; /* completion latency */
358 struct io_stat slat_stat[2]; /* submission latency */
359 struct io_stat bw_stat[2]; /* bandwidth stats */
360
361 unsigned long long stat_io_bytes[2];
362 struct timeval stat_sample_time[2];
363
364 /*
365 * fio system usage accounting
366 */
367 struct rusage ru_start;
368 struct rusage ru_end;
369 unsigned long usr_time;
370 unsigned long sys_time;
371 unsigned long ctx;
Jens Axboe079ad092007-02-20 13:58:20 +0100372
Jens Axboeb2560f32007-03-06 12:43:03 +0100373 /*
374 * IO depth and latency stats
375 */
376 unsigned int io_u_map[FIO_IO_U_MAP_NR];
Jens Axboe04a0fea2007-06-19 12:48:41 +0200377 unsigned int io_u_lat_u[FIO_IO_U_LAT_U_NR];
378 unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
Jens Axboeb3605062007-03-12 14:19:47 +0100379 unsigned long total_io_u[2];
Jens Axboe30061b92007-04-17 13:31:34 +0200380 unsigned long short_io_u[2];
Jens Axboe756867b2007-03-06 15:19:24 +0100381
382 unsigned long long io_bytes[2];
383 unsigned long runtime[2];
384 unsigned long total_run_time;
Jens Axboeb2560f32007-03-06 12:43:03 +0100385};
Jens Axboe71619dc2007-01-13 23:56:33 +0100386
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100387struct thread_options {
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100388 int pad;
Jens Axboe61697c32007-02-05 15:04:46 +0100389 char *description;
Jens Axboeb4692822006-10-27 13:43:22 +0200390 char *name;
Jens Axboeef899b62006-06-06 09:31:00 +0200391 char *directory;
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200392 char *filename;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100393 char *opendir;
Jens Axboe09629a92007-03-09 09:00:06 +0100394 char *ioengine;
Jens Axboe413dd452007-02-23 09:26:09 +0100395 enum td_ddir td_ddir;
Jens Axboe211097b2007-03-22 18:56:45 +0100396 unsigned int ddir_nr;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100397 unsigned int iodepth;
398 unsigned int iodepth_low;
399 unsigned int iodepth_batch;
400
401 unsigned long long size;
402 unsigned long long file_size_low;
403 unsigned long long file_size_high;
404 unsigned long long start_offset;
405
406 unsigned int bs[2];
407 unsigned int min_bs[2];
408 unsigned int max_bs[2];
409
410 unsigned int nr_files;
411 unsigned int open_files;
Jens Axboee9c047a2006-06-07 21:13:04 +0200412
Jens Axboe9158d2f2006-10-27 14:27:39 +0200413 unsigned int odirect;
414 unsigned int invalidate_cache;
415 unsigned int create_serialize;
416 unsigned int create_fsync;
417 unsigned int end_fsync;
418 unsigned int sync_io;
419 unsigned int verify;
Shawn Lewise84c73a2007-08-02 22:19:32 +0200420 unsigned int do_verify;
Jens Axboe160b9662007-03-27 10:59:49 +0200421 unsigned int verifysort;
Jens Axboea59e1702007-07-30 08:53:27 +0200422 unsigned int verify_interval;
423 unsigned int verify_offset;
Jens Axboe90059d62007-07-30 09:33:12 +0200424 unsigned int verify_pattern;
425 unsigned int verify_pattern_bytes;
Jens Axboe9158d2f2006-10-27 14:27:39 +0200426 unsigned int use_thread;
427 unsigned int unlink;
428 unsigned int do_disk_util;
429 unsigned int override_sync;
430 unsigned int rand_repeatable;
431 unsigned int write_lat_log;
432 unsigned int write_bw_log;
Jens Axboebb8895e2006-10-30 15:14:48 +0100433 unsigned int norandommap;
Jens Axboe690adba2006-10-30 15:25:09 +0100434 unsigned int bs_unaligned;
Jens Axboeebb14152007-03-13 14:42:15 +0100435 unsigned int fsync_on_close;
Jens Axboee9c047a2006-06-07 21:13:04 +0200436
Jens Axboe56bb17f2006-12-20 20:27:36 +0100437 unsigned int hugepage_size;
Jens Axboea00735e2006-11-03 08:58:08 +0100438 unsigned int rw_min_bs;
Jens Axboeebac4652005-12-08 15:25:21 +0100439 unsigned int thinktime;
Jens Axboe48097d52007-02-17 06:30:44 +0100440 unsigned int thinktime_spin;
Jens Axboe9c1f7432007-01-03 20:43:19 +0100441 unsigned int thinktime_blocks;
Jens Axboeebac4652005-12-08 15:25:21 +0100442 unsigned int fsync_blocks;
443 unsigned int start_delay;
Jens Axboe0db26792007-05-16 08:59:27 +0200444 unsigned long long timeout;
Jens Axboeebac4652005-12-08 15:25:21 +0100445 unsigned int overwrite;
Jens Axboeebac4652005-12-08 15:25:21 +0100446 unsigned int bw_avg_time;
Jens Axboeebac4652005-12-08 15:25:21 +0100447 unsigned int loops;
Jens Axboe20dc95c2005-12-09 10:29:35 +0100448 unsigned long long zone_size;
449 unsigned long long zone_skip;
Jens Axboee9c047a2006-06-07 21:13:04 +0200450 enum fio_memtype mem_type;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100451
Jens Axboeebac4652005-12-08 15:25:21 +0100452 unsigned int stonewall;
Jens Axboeb3d62a72007-03-20 14:23:26 +0100453 unsigned int new_group;
Jens Axboeebac4652005-12-08 15:25:21 +0100454 unsigned int numjobs;
Jens Axboeebac4652005-12-08 15:25:21 +0100455 os_cpu_mask_t cpumask;
Jens Axboe375b2692007-05-22 09:13:02 +0200456 unsigned int cpumask_set;
Jens Axboeaea47d42006-05-26 19:27:29 +0200457 unsigned int iolog;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200458 unsigned int rwmixcycle;
Jens Axboee47f7992007-03-21 14:05:39 +0100459 unsigned int rwmix[2];
Jens Axboeb6f4d882006-06-02 10:32:51 +0200460 unsigned int nice;
Jens Axboe0aabe162007-02-23 08:45:55 +0100461 unsigned int file_service_type;
Jens Axboeb2560f32007-03-06 12:43:03 +0100462 unsigned int group_reporting;
Jens Axboed2f3ac32007-03-22 19:24:09 +0100463 unsigned int fadvise_hint;
Jens Axboee9459e52007-04-17 15:46:32 +0200464 unsigned int zero_buffers;
Jens Axboecf4464c2007-04-17 20:14:42 +0200465 unsigned int time_based;
Jens Axboeaea47d42006-05-26 19:27:29 +0200466
Jens Axboe076efc72006-10-27 11:24:25 +0200467 char *read_iolog_file;
468 char *write_iolog_file;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100469
470 /*
471 * Pre-run and post-run shell
472 */
473 char *exec_prerun;
474 char *exec_postrun;
475
476 unsigned int rate;
477 unsigned int ratemin;
478 unsigned int ratecycle;
479 unsigned int rate_iops;
480 unsigned int rate_iops_min;
481
482 char *ioscheduler;
483
484 /*
485 * CPU "io" cycle burner
486 */
487 unsigned int cpuload;
488 unsigned int cpucycle;
489};
490
Jens Axboee4e33252007-03-21 13:07:54 +0100491#define FIO_VERROR_SIZE 128
492
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100493/*
494 * This describes a single thread/process executing a fio job.
495 */
496struct thread_data {
497 struct thread_options o;
Jens Axboee4e33252007-03-21 13:07:54 +0100498 char verror[FIO_VERROR_SIZE];
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100499 pthread_t thread;
500 int thread_number;
501 int groupid;
502 struct thread_stat ts;
503 struct fio_file *files;
504 unsigned int files_index;
505 unsigned int nr_open_files;
Jens Axboe1020a132007-03-29 11:15:06 +0200506 unsigned int nr_done_files;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100507 unsigned int nr_normal_files;
508 union {
509 unsigned int next_file;
510 os_random_state_t next_file_state;
511 };
512 int error;
Jens Axboe20e354e2007-07-23 14:36:16 +0200513 int done;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100514 pid_t pid;
515 char *orig_buffer;
516 size_t orig_buffer_size;
517 volatile int terminate;
518 volatile int runstate;
519 unsigned int ioprio;
520 unsigned int last_was_sync;
521
522 char *mmapfile;
523 int mmapfd;
524
Jens Axboe843a7412006-06-01 21:14:21 -0700525 void *iolog_buf;
526 FILE *iolog_f;
Jens Axboeebac4652005-12-08 15:25:21 +0100527
Jens Axboeda867742006-06-06 10:39:10 -0700528 char *sysfs_root;
Jens Axboeda867742006-06-06 10:39:10 -0700529
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200530 os_random_state_t bsrange_state;
531 os_random_state_t verify_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100532
533 int shm_id;
534
Jens Axboee9c047a2006-06-07 21:13:04 +0200535 /*
536 * IO engine hooks, contains everything needed to submit an io_u
537 * to any of the available IO engines.
538 */
Jens Axboe2866c822006-10-09 15:57:48 +0200539 struct ioengine_ops *io_ops;
Jens Axboeebac4652005-12-08 15:25:21 +0100540
Jens Axboee9c047a2006-06-07 21:13:04 +0200541 /*
542 * Current IO depth and list of free and busy io_u's.
543 */
Jens Axboeebac4652005-12-08 15:25:21 +0100544 unsigned int cur_depth;
545 struct list_head io_u_freelist;
546 struct list_head io_u_busylist;
Jens Axboe755200a2007-02-19 13:08:12 +0100547 struct list_head io_u_requeues;
Jens Axboecb5ab512007-02-26 12:57:09 +0100548 unsigned int io_u_queued;
Jens Axboeebac4652005-12-08 15:25:21 +0100549
Jens Axboee9c047a2006-06-07 21:13:04 +0200550 /*
551 * Rate state
552 */
Jens Axboeebac4652005-12-08 15:25:21 +0100553 unsigned long rate_usec_cycle;
554 long rate_pending_usleep;
555 unsigned long rate_bytes;
Jens Axboe4e991c22007-03-15 11:41:11 +0100556 unsigned long rate_blocks;
Jens Axboeebac4652005-12-08 15:25:21 +0100557 struct timeval lastrate;
558
Jens Axboeebac4652005-12-08 15:25:21 +0100559 unsigned long long total_io_size;
560
Jens Axboe755200a2007-02-19 13:08:12 +0100561 unsigned long io_issues[2];
Jens Axboe9104f872005-12-28 23:50:45 +0100562 unsigned long long io_blocks[2];
563 unsigned long long io_bytes[2];
Jens Axboe48f5abd2007-07-20 13:25:04 +0200564 unsigned long long io_skip_bytes;
Jens Axboe9104f872005-12-28 23:50:45 +0100565 unsigned long long this_io_bytes[2];
Jens Axboe079ad092007-02-20 13:58:20 +0100566 unsigned long long zone_bytes;
Jens Axboe07739b52007-03-08 20:25:46 +0100567 struct fio_sem *mutex;
Jens Axboeebac4652005-12-08 15:25:21 +0100568
Jens Axboee9c047a2006-06-07 21:13:04 +0200569 /*
570 * State for random io, a bitmap of blocks done vs not done
571 */
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200572 os_random_state_t random_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100573
Jens Axboeebac4652005-12-08 15:25:21 +0100574 struct timeval start; /* start of this loop */
575 struct timeval epoch; /* time job was started */
Jens Axboe38d77ca2007-03-21 14:20:20 +0100576 struct timeval rw_end[2];
Jens Axboea61edde2007-05-15 14:29:58 +0200577 struct timeval last_issue;
Jens Axboe38d77ca2007-03-21 14:20:20 +0100578 unsigned int rw_end_set[2];
Jens Axboeebac4652005-12-08 15:25:21 +0100579
Jens Axboee9c047a2006-06-07 21:13:04 +0200580 /*
Jens Axboee9c047a2006-06-07 21:13:04 +0200581 * read/write mixed workload state
582 */
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200583 os_random_state_t rwmix_state;
Jens Axboeafe24a52007-03-16 20:27:27 +0100584 unsigned long long rwmix_bytes;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200585 struct timeval rwmix_switch;
Jens Axboee9c047a2006-06-07 21:13:04 +0200586 enum fio_ddir rwmix_ddir;
Jens Axboe211097b2007-03-22 18:56:45 +0100587 unsigned int ddir_nr;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200588
Jens Axboe4e0ba8a2006-06-06 09:36:28 +0200589 /*
Jens Axboe8de8f042007-03-27 10:36:12 +0200590 * IO history logs for verification. We use a tree for sorting,
591 * if we are overwriting. Otherwise just use a fifo.
Jens Axboee9c047a2006-06-07 21:13:04 +0200592 */
Jens Axboe4b878982007-03-26 09:32:22 +0200593 struct rb_root io_hist_tree;
Jens Axboe8de8f042007-03-27 10:36:12 +0200594 struct list_head io_hist_list;
595
596 /*
597 * For IO replaying
598 */
Jens Axboeaea47d42006-05-26 19:27:29 +0200599 struct list_head io_log_list;
Jens Axboe433afcb2007-02-22 10:39:01 +0100600
601 /*
602 * timeout handling
603 */
604 struct timeval timeout_end;
605 struct itimerval timer;
Jens Axboe1907dbc2007-03-12 11:44:28 +0100606
607 /*
608 * for fileservice, how often to switch to a new file
609 */
610 unsigned int file_service_nr;
611 unsigned int file_service_left;
612 struct fio_file *file_service_file;
Jens Axboe9c60ce62007-03-15 09:14:47 +0100613
614 /*
615 * For generating file sizes
616 */
617 os_random_state_t file_size_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100618};
619
Jens Axboe433afcb2007-02-22 10:39:01 +0100620/*
Jens Axboe0aabe162007-02-23 08:45:55 +0100621 * roundrobin available files, or choose one at random.
622 */
623enum {
624 FIO_FSERVICE_RANDOM = 1,
625 FIO_FSERVICE_RR = 2,
626};
627
628/*
Jens Axboe433afcb2007-02-22 10:39:01 +0100629 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
630 * the timer on each queue operation.
631 */
632#define IO_U_TIMEOUT_INC 5
633#define IO_U_TIMEOUT 30
634
Jens Axboee1161c32007-02-22 19:36:48 +0100635#define __td_verror(td, err, msg, func) \
Jens Axboeebac4652005-12-08 15:25:21 +0100636 do { \
Jens Axboe19abcd32007-02-21 20:14:33 +0100637 if ((td)->error) \
638 break; \
Jens Axboeebac4652005-12-08 15:25:21 +0100639 int e = (err); \
640 (td)->error = e; \
Jens Axboee1161c32007-02-22 19:36:48 +0100641 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
Jens Axboeebac4652005-12-08 15:25:21 +0100642 } while (0)
643
Jens Axboeb990b5c2006-09-14 09:48:22 +0200644
Jens Axboee1161c32007-02-22 19:36:48 +0100645#define td_verror(td, err, func) \
646 __td_verror((td), (err), strerror((err)), (func))
647#define td_vmsg(td, err, msg, func) \
648 __td_verror((td), (err), (msg), (func))
Jens Axboeb990b5c2006-09-14 09:48:22 +0200649
Jens Axboeebac4652005-12-08 15:25:21 +0100650extern int exitall_on_terminate;
651extern int thread_number;
Jens Axboe9cedf162007-03-12 11:29:30 +0100652extern int nr_process, nr_thread;
Jens Axboeebac4652005-12-08 15:25:21 +0100653extern int shm_id;
654extern int groupid;
Jens Axboec6ae0a52006-06-12 11:04:44 +0200655extern int terse_output;
Jens Axboeeb8bbf42006-06-08 21:40:11 +0200656extern FILE *f_out;
657extern FILE *f_err;
Jens Axboe53cdc682006-10-18 11:50:58 +0200658extern int temp_stall_ts;
Jens Axboe1e97cce2006-12-05 11:44:16 +0100659extern unsigned long long mlock_size;
Jens Axboecfc99db2007-03-14 10:34:47 +0100660extern unsigned long page_mask, page_size;
Jens Axboeebac4652005-12-08 15:25:21 +0100661
662extern struct thread_data *threads;
663
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100664#define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
665#define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
666#define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
667#define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
Jens Axboeebac4652005-12-08 15:25:21 +0100668
669#define BLOCKS_PER_MAP (8 * sizeof(long))
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100670#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
Jens Axboe53cdc682006-10-18 11:50:58 +0200671#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
672#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
Jens Axboeebac4652005-12-08 15:25:21 +0100673
674#define MAX_JOBS (1024)
675
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200676static inline int should_fsync(struct thread_data *td)
677{
678 if (td->last_was_sync)
679 return 0;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100680 if (td->o.odirect)
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200681 return 0;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100682 if (td_write(td) || td_rw(td) || td->o.override_sync)
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200683 return 1;
684
685 return 0;
686}
687
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100688/*
689 * Disk utils as read in /sys/block/<dev>/stat
690 */
Jens Axboeebac4652005-12-08 15:25:21 +0100691struct disk_util_stat {
692 unsigned ios[2];
693 unsigned merges[2];
694 unsigned long long sectors[2];
695 unsigned ticks[2];
696 unsigned io_ticks;
697 unsigned time_in_queue;
698};
699
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100700/*
701 * Per-device disk util management
702 */
Jens Axboeebac4652005-12-08 15:25:21 +0100703struct disk_util {
704 struct list_head list;
705
706 char *name;
Jens Axboee11c4102007-04-03 16:33:04 -0700707 char *sysfs_root;
Jens Axboeebac4652005-12-08 15:25:21 +0100708 char path[256];
Jens Axboe07e5b262007-04-02 14:46:07 +0200709 int major, minor;
Jens Axboeebac4652005-12-08 15:25:21 +0100710
711 struct disk_util_stat dus;
712 struct disk_util_stat last_dus;
713
714 unsigned long msec;
715 struct timeval time;
716};
717
Jens Axboeebac4652005-12-08 15:25:21 +0100718#define DISK_UTIL_MSEC (250)
719
Jens Axboe67962092006-06-07 08:45:01 +0200720/*
721 * Log exports
722 */
Jens Axboef29b25a2007-07-23 08:56:43 +0200723enum file_log_act {
724 FIO_LOG_ADD_FILE,
725 FIO_LOG_OPEN_FILE,
726 FIO_LOG_CLOSE_FILE,
727};
728
Jens Axboe72cb9712007-02-20 20:54:45 +0100729extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
Jens Axboef29b25a2007-07-23 08:56:43 +0200730extern void log_io_u(struct thread_data *, struct io_u *);
731extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
Jens Axboe72cb9712007-02-20 20:54:45 +0100732extern int __must_check init_iolog(struct thread_data *td);
Jens Axboe67962092006-06-07 08:45:01 +0200733extern void log_io_piece(struct thread_data *, struct io_u *);
734extern void prune_io_piece_log(struct thread_data *);
735extern void write_iolog_close(struct thread_data *);
736
737/*
738 * Logging
739 */
Jens Axboe1e97cce2006-12-05 11:44:16 +0100740extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
741extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
742extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
Jens Axboe67962092006-06-07 08:45:01 +0200743extern void show_run_stats(void);
744extern void init_disk_util(struct thread_data *);
745extern void update_rusage_stat(struct thread_data *);
746extern void update_io_ticks(void);
747extern void disk_util_timer_arm(void);
Jens Axboe8914a9d2006-06-07 11:14:56 +0200748extern void setup_log(struct io_log **);
749extern void finish_log(struct thread_data *, struct io_log *, const char *);
Jens Axboebb3884d2007-01-17 17:23:11 +1100750extern void __finish_log(struct io_log *, const char *);
Jens Axboebb3884d2007-01-17 17:23:11 +1100751extern struct io_log *agg_io_log[2];
752extern int write_bw_log;
753extern void add_agg_sample(unsigned long, enum fio_ddir);
Jens Axboe67962092006-06-07 08:45:01 +0200754
755/*
756 * Time functions
757 */
758extern unsigned long utime_since(struct timeval *, struct timeval *);
Jens Axboe69008992006-11-24 13:12:56 +0100759extern unsigned long utime_since_now(struct timeval *);
Jens Axboe67962092006-06-07 08:45:01 +0200760extern unsigned long mtime_since(struct timeval *, struct timeval *);
761extern unsigned long mtime_since_now(struct timeval *);
762extern unsigned long time_since_now(struct timeval *);
Jens Axboe263e5292006-10-18 15:37:01 +0200763extern unsigned long mtime_since_genesis(void);
Jens Axboeb990b5c2006-09-14 09:48:22 +0200764extern void __usec_sleep(unsigned int);
Jens Axboe67962092006-06-07 08:45:01 +0200765extern void usec_sleep(struct thread_data *, unsigned long);
Jens Axboe413dd452007-02-23 09:26:09 +0100766extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
Jens Axboe6043c572006-11-03 11:37:47 +0100767extern void fill_start_time(struct timeval *);
Jens Axboe02bcaa82006-11-24 10:42:00 +0100768extern void fio_gettime(struct timeval *, void *);
Jens Axboea2f77c92007-02-22 11:53:00 +0100769extern void set_genesis_time(void);
Jens Axboe67962092006-06-07 08:45:01 +0200770
Jens Axboe8914a9d2006-06-07 11:14:56 +0200771/*
Jens Axboe214e1ec2007-03-15 10:48:13 +0100772 * Init/option functions
Jens Axboe8914a9d2006-06-07 11:14:56 +0200773 */
Jens Axboe72cb9712007-02-20 20:54:45 +0100774extern int __must_check parse_options(int, char **);
Jens Axboe214e1ec2007-03-15 10:48:13 +0100775extern int fio_option_parse(struct thread_data *, const char *);
776extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
777extern void fio_fill_default_options(struct thread_data *);
778extern int fio_show_option_help(const char *);
779extern void fio_options_dup_and_init(struct option *);
Jens Axboed23bb322007-03-23 15:57:56 +0100780extern void options_mem_dupe(struct thread_data *);
781extern void options_mem_free(struct thread_data *);
Jens Axboe214e1ec2007-03-15 10:48:13 +0100782#define FIO_GETOPT_JOB 0x89988998
783#define FIO_NR_OPTIONS 128
Jens Axboe8914a9d2006-06-07 11:14:56 +0200784
Jens Axboebbfd6b02006-06-07 19:42:54 +0200785/*
Jens Axboe53cdc682006-10-18 11:50:58 +0200786 * File setup/shutdown
787 */
788extern void close_files(struct thread_data *);
Jens Axboeb2fdda42007-02-20 20:52:51 +0100789extern int __must_check setup_files(struct thread_data *);
790extern int __must_check open_files(struct thread_data *);
791extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
Jens Axboeb5af8292007-03-08 12:43:13 +0100792extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
793extern void generic_close_file(struct thread_data *, struct fio_file *);
Jens Axboef29b25a2007-07-23 08:56:43 +0200794extern int add_file(struct thread_data *, const char *);
Jens Axboe0ad920e2007-03-13 11:06:45 +0100795extern void get_file(struct fio_file *);
796extern void put_file(struct thread_data *, struct fio_file *);
Jens Axboebbf6b542007-03-13 15:28:55 +0100797extern int add_dir_files(struct thread_data *, const char *);
Jens Axboe68727072007-03-15 20:49:25 +0100798extern int init_random_map(struct thread_data *);
Jens Axboecade3ef2007-03-23 15:29:45 +0100799extern void dup_files(struct thread_data *, struct thread_data *);
Jens Axboef29b25a2007-07-23 08:56:43 +0200800extern int get_fileno(struct thread_data *, const char *);
801extern void free_release_files(struct thread_data *);
Jens Axboe53cdc682006-10-18 11:50:58 +0200802
803/*
Jens Axboe263e5292006-10-18 15:37:01 +0200804 * ETA/status stuff
805 */
806extern void print_thread_status(void);
807extern void print_status_init(int);
808
809/*
Jens Axboe9f8f2062007-04-02 15:08:01 +0200810 * disk util stuff
811 */
812#ifdef FIO_HAVE_DISK_UTIL
813extern void show_disk_util(void);
814extern void disk_util_timer_arm(void);
815extern void init_disk_util(struct thread_data *);
816extern void update_io_ticks(void);
817#else
818#define show_disk_util()
819#define disk_util_timer_arm()
820#define init_disk_util(td)
821#define update_io_ticks()
822#endif
823
824/*
Jens Axboe263e5292006-10-18 15:37:01 +0200825 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
826 * will never back again. It may cycle between running/verififying/fsyncing.
827 * Once the thread reaches TD_EXITED, it is just waiting for the core to
828 * reap it.
829 */
830enum {
831 TD_NOT_CREATED = 0,
832 TD_CREATED,
833 TD_INITIALIZED,
834 TD_RUNNING,
835 TD_VERIFYING,
836 TD_FSYNCING,
837 TD_EXITED,
838 TD_REAPED,
839};
840
841/*
Jens Axboee29d1b72006-10-18 15:43:15 +0200842 * Verify helpers
843 */
844extern void populate_verify_io_u(struct thread_data *, struct io_u *);
Jens Axboeb2fdda42007-02-20 20:52:51 +0100845extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
Jens Axboe36690c92007-03-26 10:23:34 +0200846extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
Jens Axboee29d1b72006-10-18 15:43:15 +0200847
848/*
Jens Axboe2f9ade32006-10-20 11:25:52 +0200849 * Memory helpers
850 */
Jens Axboeb2fdda42007-02-20 20:52:51 +0100851extern int __must_check fio_pin_memory(void);
Jens Axboe2f9ade32006-10-20 11:25:52 +0200852extern void fio_unpin_memory(void);
Jens Axboeb2fdda42007-02-20 20:52:51 +0100853extern int __must_check allocate_io_mem(struct thread_data *);
Jens Axboe2f9ade32006-10-20 11:25:52 +0200854extern void free_io_mem(struct thread_data *);
855
856/*
Jens Axboe10ba5352006-10-20 11:39:27 +0200857 * io unit handling
858 */
859#define queue_full(td) list_empty(&(td)->io_u_freelist)
860extern struct io_u *__get_io_u(struct thread_data *);
Jens Axboe3d7c3912007-02-19 13:16:12 +0100861extern struct io_u *get_io_u(struct thread_data *);
Jens Axboe10ba5352006-10-20 11:39:27 +0200862extern void put_io_u(struct thread_data *, struct io_u *);
Jens Axboe755200a2007-02-19 13:08:12 +0100863extern void requeue_io_u(struct thread_data *, struct io_u **);
Jens Axboed7762cf2007-02-23 12:34:57 +0100864extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
865extern long __must_check io_u_queued_complete(struct thread_data *, int);
Jens Axboe7e77dd02007-02-20 10:57:34 +0100866extern void io_u_queued(struct thread_data *, struct io_u *);
Jens Axboe54517922007-03-05 10:06:06 +0100867extern void io_u_log_error(struct thread_data *, struct io_u *);
Jens Axboe433afcb2007-02-22 10:39:01 +0100868extern void io_u_init_timeout(void);
869extern void io_u_set_timeout(struct thread_data *);
Jens Axboeb3605062007-03-12 14:19:47 +0100870extern void io_u_mark_depth(struct thread_data *, struct io_u *);
Jens Axboe10ba5352006-10-20 11:39:27 +0200871
872/*
873 * io engine entry points
874 */
Jens Axboeb2fdda42007-02-20 20:52:51 +0100875extern int __must_check td_io_init(struct thread_data *);
876extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
877extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
878extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
879extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
880extern int __must_check td_io_commit(struct thread_data *);
Jens Axboeb5af8292007-03-08 12:43:13 +0100881extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
882extern void td_io_close_file(struct thread_data *, struct fio_file *);
Jens Axboe10ba5352006-10-20 11:39:27 +0200883
884/*
Jens Axboefb7b71a2007-05-15 08:44:04 +0200885 * blktrace support
886 */
Jens Axboe5e62c222007-05-22 13:27:30 +0200887#ifdef FIO_HAVE_BLKTRACE
Jens Axboefb7b71a2007-05-15 08:44:04 +0200888extern int is_blktrace(const char *);
889extern int load_blktrace(struct thread_data *, const char *);
Jens Axboe5e62c222007-05-22 13:27:30 +0200890#endif
Jens Axboefb7b71a2007-05-15 08:44:04 +0200891
892/*
Jens Axboe3b70d7e2006-06-08 21:48:46 +0200893 * If logging output to a file, stderr should go to both stderr and f_err
894 */
895#define log_err(args...) do { \
896 fprintf(f_err, ##args); \
897 if (f_err != stderr) \
898 fprintf(stderr, ##args); \
899 } while (0)
900
Jens Axboe9c60ce62007-03-15 09:14:47 +0100901#define log_info(args...) fprintf(f_out, ##args)
902
Joel Becker9728ce32007-03-01 08:24:39 +0100903FILE *get_f_out(void);
904FILE *get_f_err(void);
905
Jens Axboe2866c822006-10-09 15:57:48 +0200906struct ioengine_ops {
Jens Axboe5f350952006-11-07 15:20:59 +0100907 struct list_head list;
Jens Axboe2866c822006-10-09 15:57:48 +0200908 char name[16];
909 int version;
910 int flags;
Jens Axboeea2877a2006-10-10 08:30:24 +0200911 int (*setup)(struct thread_data *);
Jens Axboe2866c822006-10-09 15:57:48 +0200912 int (*init)(struct thread_data *);
913 int (*prep)(struct thread_data *, struct io_u *);
914 int (*queue)(struct thread_data *, struct io_u *);
Jens Axboe755200a2007-02-19 13:08:12 +0100915 int (*commit)(struct thread_data *);
Jens Axboe2866c822006-10-09 15:57:48 +0200916 int (*getevents)(struct thread_data *, int, int, struct timespec *);
917 struct io_u *(*event)(struct thread_data *, int);
918 int (*cancel)(struct thread_data *, struct io_u *);
919 void (*cleanup)(struct thread_data *);
Jens Axboeb5af8292007-03-08 12:43:13 +0100920 int (*open_file)(struct thread_data *, struct fio_file *);
921 void (*close_file)(struct thread_data *, struct fio_file *);
Jens Axboe2866c822006-10-09 15:57:48 +0200922 void *data;
923 void *dlhandle;
924};
925
Jens Axboe2c187c02007-03-27 15:57:19 +0200926#define FIO_IOOPS_VERSION 7
Jens Axboe2866c822006-10-09 15:57:48 +0200927
Jens Axboeb4692822006-10-27 13:43:22 +0200928extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
Jens Axboeb2fdda42007-02-20 20:52:51 +0100929extern void register_ioengine(struct ioengine_ops *);
Jens Axboe5f350952006-11-07 15:20:59 +0100930extern void unregister_ioengine(struct ioengine_ops *);
Jens Axboe2866c822006-10-09 15:57:48 +0200931extern void close_ioengine(struct thread_data *);
932
933/*
934 * Mark unused variables passed to ops functions as unused, to silence gcc
935 */
936#define fio_unused __attribute((__unused__))
Jens Axboe5f350952006-11-07 15:20:59 +0100937#define fio_init __attribute__((constructor))
938#define fio_exit __attribute__((destructor))
Jens Axboe2866c822006-10-09 15:57:48 +0200939
Jens Axboe34572e22006-10-20 09:33:18 +0200940#define for_each_td(td, i) \
941 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
Jens Axboe53cdc682006-10-18 11:50:58 +0200942#define for_each_file(td, f, i) \
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100943 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
Jens Axboe53cdc682006-10-18 11:50:58 +0200944
Jens Axboe0032bf92007-02-13 17:39:56 +0100945#define fio_assert(td, cond) do { \
946 if (!(cond)) { \
Jens Axboe340fd242007-02-13 20:09:10 +0100947 int *__foo = NULL; \
Jens Axboe0032bf92007-02-13 17:39:56 +0100948 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
949 (td)->runstate = TD_EXITED; \
Jens Axboe437c9b72007-02-13 18:20:37 +0100950 (td)->error = EFAULT; \
Jens Axboe340fd242007-02-13 20:09:10 +0100951 *__foo = 0; \
Jens Axboe0032bf92007-02-13 17:39:56 +0100952 } \
953} while (0)
954
Jens Axboe9bf27b42007-03-27 19:49:31 +0200955static inline void clear_error(struct thread_data *td)
956{
957 td->error = 0;
958 td->verror[0] = '\0';
959}
960
Jens Axboeebac4652005-12-08 15:25:21 +0100961#endif