blob: 63cfaa7ae3cf9f6cd52dba96b68ed35cc126e17a [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 Axboeebac4652005-12-08 15:25:21 +010015
Jens Axboe317b95d2007-04-02 21:36:44 +020016#include "compiler/compiler.h"
Jens Axboeebac4652005-12-08 15:25:21 +010017#include "list.h"
Jens Axboee2887562007-05-16 09:25:09 +020018#include "fifo.h"
Jens Axboe4b878982007-03-26 09:32:22 +020019#include "rbtree.h"
Jens Axboeebac4652005-12-08 15:25:21 +010020#include "md5.h"
21#include "crc32.h"
Jens Axboe969f7ed2007-07-27 09:07:17 +020022#include "crc16.h"
Jens Axboe1e154bd2007-07-27 09:52:40 +020023#include "crc7.h"
Jens Axboe317b95d2007-04-02 21:36:44 +020024#include "arch/arch.h"
25#include "os/os.h"
Jens Axboe07739b52007-03-08 20:25:46 +010026#include "mutex.h"
Jens Axboeebac4652005-12-08 15:25:21 +010027
Jens Axboeb6959b52007-02-14 21:40:27 +000028#ifdef FIO_HAVE_SYSLET
Jens Axboea4f4fdd2007-02-14 01:16:39 +010029#include "syslet.h"
Jens Axboeb6959b52007-02-14 21:40:27 +000030#endif
Jens Axboea4f4fdd2007-02-14 01:16:39 +010031
Davide Libenzi609342f2007-03-21 08:46:18 +010032#ifdef FIO_HAVE_GUASI
33#include <guasi.h>
34#endif
35
Jens Axboe1e97cce2006-12-05 11:44:16 +010036enum fio_ddir {
37 DDIR_READ = 0,
38 DDIR_WRITE,
39 DDIR_SYNC,
Jens Axboef29b25a2007-07-23 08:56:43 +020040 DDIR_INVAL = -1,
Jens Axboe1e97cce2006-12-05 11:44:16 +010041};
42
Jens Axboe413dd452007-02-23 09:26:09 +010043enum td_ddir {
Jens Axboeb1ec1da2007-02-23 10:29:16 +010044 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,
Joel Becker7ff1c142007-03-03 12:03:29 +010049 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
Jens Axboeb1ec1da2007-02-23 10:29:16 +010050 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
Jens Axboe413dd452007-02-23 09:26:09 +010051};
52
Jens Axboe1c9e06e2007-02-11 04:07:57 +010053/*
54 * Use for maintaining statistics
55 */
Jens Axboeebac4652005-12-08 15:25:21 +010056struct io_stat {
Jens Axboeebac4652005-12-08 15:25:21 +010057 unsigned long max_val;
58 unsigned long min_val;
59 unsigned long samples;
Jens Axboe68704082007-01-10 19:56:37 +010060
61 double mean;
62 double S;
Jens Axboeebac4652005-12-08 15:25:21 +010063};
64
Jens Axboe1c9e06e2007-02-11 04:07:57 +010065/*
66 * A single data sample
67 */
Jens Axboeebac4652005-12-08 15:25:21 +010068struct io_sample {
69 unsigned long time;
70 unsigned long val;
Jens Axboe1e97cce2006-12-05 11:44:16 +010071 enum fio_ddir ddir;
Jens Axboeebac4652005-12-08 15:25:21 +010072};
73
Jens Axboe1c9e06e2007-02-11 04:07:57 +010074/*
75 * Dynamically growing data sample log
76 */
Jens Axboeebac4652005-12-08 15:25:21 +010077struct io_log {
78 unsigned long nr_samples;
79 unsigned long max_samples;
80 struct io_sample *log;
81};
82
Jens Axboe1c9e06e2007-02-11 04:07:57 +010083/*
84 * When logging io actions, this matches a single sent io_u
85 */
Jens Axboeebac4652005-12-08 15:25:21 +010086struct io_piece {
Jens Axboe4b878982007-03-26 09:32:22 +020087 union {
88 struct rb_node rb_node;
89 struct list_head list;
90 };
Jens Axboef29b25a2007-07-23 08:56:43 +020091 union {
92 int fileno;
93 struct fio_file *file;
94 };
Jens Axboeebac4652005-12-08 15:25:21 +010095 unsigned long long offset;
Jens Axboea4f4fdd2007-02-14 01:16:39 +010096 unsigned long len;
Jens Axboe1e97cce2006-12-05 11:44:16 +010097 enum fio_ddir ddir;
Jens Axboef29b25a2007-07-23 08:56:43 +020098 union {
99 unsigned long delay;
100 unsigned int file_action;
101 };
Jens Axboeebac4652005-12-08 15:25:21 +0100102};
103
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100104#ifdef FIO_HAVE_SYSLET
105struct syslet_req {
Jens Axboe5b38ee82007-02-26 10:44:22 +0100106 struct syslet_uatom atom; /* the atom to submit */
107 struct syslet_uatom *head; /* head of the sequence */
108 long ret; /* syscall return value */
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100109};
110#endif
111
Jens Axboe0c6e7512007-02-22 11:19:39 +0100112enum {
113 IO_U_F_FREE = 1 << 0,
114 IO_U_F_FLIGHT = 1 << 1,
115};
116
Jens Axboe36690c92007-03-26 10:23:34 +0200117struct thread_data;
118
Jens Axboeebac4652005-12-08 15:25:21 +0100119/*
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;
132#endif
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100133#ifdef FIO_HAVE_SYSLET
Jens Axboea2e1b082007-02-14 08:06:19 +0100134 struct syslet_req req;
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100135#endif
Davide Libenzi609342f2007-03-21 08:46:18 +0100136#ifdef FIO_HAVE_GUASI
137 guasi_req_t greq;
138#endif
Jens Axboeebac4652005-12-08 15:25:21 +0100139 };
140 struct timeval start_time;
141 struct timeval issue_time;
142
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100143 /*
144 * Allocated/set buffer and length
145 */
Jens Axboe6b9cea22006-10-30 17:00:24 +0100146 void *buf;
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100147 unsigned long buflen;
Jens Axboeebac4652005-12-08 15:25:21 +0100148 unsigned long long offset;
Jens Axboed460eb32007-04-16 21:39:33 +0200149 unsigned long long endpos;
Jens Axboeebac4652005-12-08 15:25:21 +0100150
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100151 /*
152 * IO engine state, may be different from above when we get
153 * partial transfers / residual data counts
154 */
Jens Axboecec6b552007-02-06 20:15:38 +0100155 void *xfer_buf;
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100156 unsigned long xfer_buflen;
Jens Axboecec6b552007-02-06 20:15:38 +0100157
Jens Axboeebac4652005-12-08 15:25:21 +0100158 unsigned int resid;
159 unsigned int error;
160
Jens Axboe1e97cce2006-12-05 11:44:16 +0100161 enum fio_ddir ddir;
Jens Axboeebac4652005-12-08 15:25:21 +0100162
Jens Axboedfd7bc22006-10-24 12:17:57 +0200163 /*
164 * io engine private data
165 */
166 union {
167 unsigned int index;
168 unsigned int seen;
169 };
170
Jens Axboe0c6e7512007-02-22 11:19:39 +0100171 unsigned int flags;
172
Jens Axboe53cdc682006-10-18 11:50:58 +0200173 struct fio_file *file;
174
Jens Axboeebac4652005-12-08 15:25:21 +0100175 struct list_head list;
Jens Axboed7762cf2007-02-23 12:34:57 +0100176
177 /*
178 * Callback for io completion
179 */
Jens Axboe36690c92007-03-26 10:23:34 +0200180 int (*end_io)(struct thread_data *, struct io_u *);
Jens Axboeebac4652005-12-08 15:25:21 +0100181};
182
Jens Axboe36167d82007-02-18 05:41:31 +0100183/*
184 * io_ops->queue() return values
185 */
186enum {
187 FIO_Q_COMPLETED = 0, /* completed sync */
188 FIO_Q_QUEUED = 1, /* queued, will complete async */
Jens Axboe755200a2007-02-19 13:08:12 +0100189 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
Jens Axboe36167d82007-02-18 05:41:31 +0100190};
191
Jens Axboeebac4652005-12-08 15:25:21 +0100192#define FIO_HDR_MAGIC 0xf00baaef
193
194enum {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100195 VERIFY_NONE = 0, /* no verification */
196 VERIFY_MD5, /* md5 sum data blocks */
197 VERIFY_CRC32, /* crc32 sum data blocks */
Jens Axboe969f7ed2007-07-27 09:07:17 +0200198 VERIFY_CRC16, /* crc16 sum data blocks */
Jens Axboe1e154bd2007-07-27 09:52:40 +0200199 VERIFY_CRC7, /* crc7 sum data blocks */
Jens Axboe36690c92007-03-26 10:23:34 +0200200 VERIFY_NULL, /* pretend to verify */
Jens Axboeebac4652005-12-08 15:25:21 +0100201};
202
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100203/*
204 * A header structure associated with each checksummed data block
205 */
Jens Axboeebac4652005-12-08 15:25:21 +0100206struct 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;
Jens Axboe969f7ed2007-07-27 09:07:17 +0200213 unsigned short crc16;
Jens Axboe1e154bd2007-07-27 09:52:40 +0200214 unsigned char crc7;
Jens Axboeebac4652005-12-08 15:25:21 +0100215 };
216};
217
218struct group_run_stats {
Jens Axboe9104f872005-12-28 23:50:45 +0100219 unsigned long long max_run[2], min_run[2];
220 unsigned long long max_bw[2], min_bw[2];
Jens Axboee9b2a3f2006-06-06 15:38:33 +0200221 unsigned long long io_kb[2];
Jens Axboe9104f872005-12-28 23:50:45 +0100222 unsigned long long agg[2];
Jens Axboeebac4652005-12-08 15:25:21 +0100223};
224
Jens Axboee9c047a2006-06-07 21:13:04 +0200225/*
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 */
Jens Axboe74b025b2006-12-19 15:18:14 +0100231 MEM_SHMHUGE, /* use shared memory segments with huge pages */
Jens Axboee9c047a2006-06-07 21:13:04 +0200232 MEM_MMAP, /* use anonynomous mmap */
Jens Axboed0bdaf42006-12-20 14:40:44 +0100233 MEM_MMAPHUGE, /* memory mapped huge file */
Jens Axboee9c047a2006-06-07 21:13:04 +0200234};
235
236/*
237 * The type of object we are working on
238 */
239enum fio_filetype {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100240 FIO_TYPE_FILE = 1, /* plain file */
241 FIO_TYPE_BD, /* block device */
242 FIO_TYPE_CHAR, /* character device */
Jens Axboeb5605e92007-04-16 20:42:33 +0200243 FIO_TYPE_PIPE, /* pipe */
Jens Axboee9c047a2006-06-07 21:13:04 +0200244};
245
Jens Axboe2866c822006-10-09 15:57:48 +0200246enum fio_ioengine_flags {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100247 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
Jens Axboeba0fbe12007-03-09 14:34:23 +0100248 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
249 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
Jens Axboe02638822007-03-12 09:25:55 +0100250 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
Jens Axboe62d984e2007-03-13 08:15:18 +0100251 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
Jens Axboeb67740d2007-07-26 12:22:30 +0200252 FIO_UNIDIR = 1 << 5, /* engine is uni-directional */
Jens Axboee9c047a2006-06-07 21:13:04 +0200253};
254
Jens Axboef11bd942007-03-13 10:16:34 +0100255enum fio_file_flags {
Jens Axboe0ad920e2007-03-13 11:06:45 +0100256 FIO_FILE_OPEN = 1 << 0, /* file is open */
Jens Axboea9b7b302007-04-19 16:31:16 +0200257 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 */
Jens Axboef11bd942007-03-13 10:16:34 +0100263};
264
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100265/*
266 * Each thread_data structure has a number of files associated with it,
267 * this structure holds state information for a single file.
268 */
Jens Axboe53cdc682006-10-18 11:50:58 +0200269struct fio_file {
Jens Axboeaf52b342007-03-13 10:07:47 +0100270 enum fio_filetype filetype;
271
Jens Axboe53cdc682006-10-18 11:50:58 +0200272 /*
273 * A file may not be a file descriptor, let the io engine decide
274 */
275 union {
276 unsigned long file_data;
Jens Axboee26f8f72007-02-17 04:39:54 +0100277 int fd;
Jens Axboe53cdc682006-10-18 11:50:58 +0200278 };
Jens Axboe7bb48f82007-03-27 15:30:28 +0200279
280 /*
281 * filename and possible memory mapping
282 */
Jens Axboe1315a682007-03-13 11:25:07 +0100283 char *file_name;
Jens Axboe53cdc682006-10-18 11:50:58 +0200284 void *mmap;
Jens Axboe5e6c2062007-05-16 14:40:29 +0200285 unsigned int major, minor;
Jens Axboe7bb48f82007-03-27 15:30:28 +0200286
287 /*
288 * size of the file, offset into file, and io size from that offset
289 */
Jens Axboe53cdc682006-10-18 11:50:58 +0200290 unsigned long long real_file_size;
291 unsigned long long file_offset;
Jens Axboe7bb48f82007-03-27 15:30:28 +0200292 unsigned long long io_size;
293
Jens Axboe53cdc682006-10-18 11:50:58 +0200294 unsigned long long last_pos;
Jens Axboe02bcaa82006-11-24 10:42:00 +0100295 unsigned long long last_completed_pos;
Jens Axboe53cdc682006-10-18 11:50:58 +0200296
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100297 /*
298 * block map for random io
299 */
Jens Axboe53cdc682006-10-18 11:50:58 +0200300 unsigned long *file_map;
301 unsigned int num_maps;
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100302 unsigned int last_free_lookup;
Jens Axboe9b031dc2006-12-15 16:01:54 +0100303
Jens Axboe0ad920e2007-03-13 11:06:45 +0100304 int references;
Jens Axboef11bd942007-03-13 10:16:34 +0100305 enum fio_file_flags flags;
Jens Axboe53cdc682006-10-18 11:50:58 +0200306};
307
Jens Axboeb2560f32007-03-06 12:43:03 +0100308/*
309 * How many depth levels to log
310 */
311#define FIO_IO_U_MAP_NR 8
Jens Axboea9a18a32007-07-06 14:09:49 +0200312#define FIO_IO_U_LAT_U_NR 10
313#define FIO_IO_U_LAT_M_NR 12
Jens Axboeb2560f32007-03-06 12:43:03 +0100314
Jens Axboe079ad092007-02-20 13:58:20 +0100315struct thread_stat {
Jens Axboe756867b2007-03-06 15:19:24 +0100316 char *name;
317 char *verror;
318 int error;
319 int groupid;
320 pid_t pid;
321 char *description;
Jens Axboe6586ee82007-03-06 19:46:09 +0100322 int members;
Jens Axboe756867b2007-03-06 15:19:24 +0100323
Jens Axboe079ad092007-02-20 13:58:20 +0100324 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;
Jens Axboe079ad092007-02-20 13:58:20 +0100346
Jens Axboeb2560f32007-03-06 12:43:03 +0100347 /*
348 * IO depth and latency stats
349 */
350 unsigned int io_u_map[FIO_IO_U_MAP_NR];
Jens Axboe04a0fea2007-06-19 12:48:41 +0200351 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];
Jens Axboeb3605062007-03-12 14:19:47 +0100353 unsigned long total_io_u[2];
Jens Axboe30061b92007-04-17 13:31:34 +0200354 unsigned long short_io_u[2];
Jens Axboe756867b2007-03-06 15:19:24 +0100355
356 unsigned long long io_bytes[2];
357 unsigned long runtime[2];
358 unsigned long total_run_time;
Jens Axboeb2560f32007-03-06 12:43:03 +0100359};
Jens Axboe71619dc2007-01-13 23:56:33 +0100360
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100361struct thread_options {
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100362 int pad;
Jens Axboe61697c32007-02-05 15:04:46 +0100363 char *description;
Jens Axboeb4692822006-10-27 13:43:22 +0200364 char *name;
Jens Axboeef899b62006-06-06 09:31:00 +0200365 char *directory;
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200366 char *filename;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100367 char *opendir;
Jens Axboe09629a92007-03-09 09:00:06 +0100368 char *ioengine;
Jens Axboe413dd452007-02-23 09:26:09 +0100369 enum td_ddir td_ddir;
Jens Axboe211097b2007-03-22 18:56:45 +0100370 unsigned int ddir_nr;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100371 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;
Jens Axboee9c047a2006-06-07 21:13:04 +0200386
Jens Axboe9158d2f2006-10-27 14:27:39 +0200387 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;
Jens Axboe160b9662007-03-27 10:59:49 +0200394 unsigned int verifysort;
Jens Axboe9158d2f2006-10-27 14:27:39 +0200395 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;
Jens Axboebb8895e2006-10-30 15:14:48 +0100402 unsigned int norandommap;
Jens Axboe690adba2006-10-30 15:25:09 +0100403 unsigned int bs_unaligned;
Jens Axboeebb14152007-03-13 14:42:15 +0100404 unsigned int fsync_on_close;
Jens Axboee9c047a2006-06-07 21:13:04 +0200405
Jens Axboe56bb17f2006-12-20 20:27:36 +0100406 unsigned int hugepage_size;
Jens Axboea00735e2006-11-03 08:58:08 +0100407 unsigned int rw_min_bs;
Jens Axboeebac4652005-12-08 15:25:21 +0100408 unsigned int thinktime;
Jens Axboe48097d52007-02-17 06:30:44 +0100409 unsigned int thinktime_spin;
Jens Axboe9c1f7432007-01-03 20:43:19 +0100410 unsigned int thinktime_blocks;
Jens Axboeebac4652005-12-08 15:25:21 +0100411 unsigned int fsync_blocks;
412 unsigned int start_delay;
Jens Axboe0db26792007-05-16 08:59:27 +0200413 unsigned long long timeout;
Jens Axboeebac4652005-12-08 15:25:21 +0100414 unsigned int overwrite;
Jens Axboeebac4652005-12-08 15:25:21 +0100415 unsigned int bw_avg_time;
Jens Axboeebac4652005-12-08 15:25:21 +0100416 unsigned int loops;
Jens Axboe20dc95c2005-12-09 10:29:35 +0100417 unsigned long long zone_size;
418 unsigned long long zone_skip;
Jens Axboee9c047a2006-06-07 21:13:04 +0200419 enum fio_memtype mem_type;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100420
Jens Axboeebac4652005-12-08 15:25:21 +0100421 unsigned int stonewall;
Jens Axboeb3d62a72007-03-20 14:23:26 +0100422 unsigned int new_group;
Jens Axboeebac4652005-12-08 15:25:21 +0100423 unsigned int numjobs;
Jens Axboeebac4652005-12-08 15:25:21 +0100424 os_cpu_mask_t cpumask;
Jens Axboe375b2692007-05-22 09:13:02 +0200425 unsigned int cpumask_set;
Jens Axboeaea47d42006-05-26 19:27:29 +0200426 unsigned int iolog;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200427 unsigned int rwmixcycle;
Jens Axboee47f7992007-03-21 14:05:39 +0100428 unsigned int rwmix[2];
Jens Axboeb6f4d882006-06-02 10:32:51 +0200429 unsigned int nice;
Jens Axboe0aabe162007-02-23 08:45:55 +0100430 unsigned int file_service_type;
Jens Axboeb2560f32007-03-06 12:43:03 +0100431 unsigned int group_reporting;
Jens Axboed2f3ac32007-03-22 19:24:09 +0100432 unsigned int fadvise_hint;
Jens Axboee9459e52007-04-17 15:46:32 +0200433 unsigned int zero_buffers;
Jens Axboecf4464c2007-04-17 20:14:42 +0200434 unsigned int time_based;
Jens Axboeaea47d42006-05-26 19:27:29 +0200435
Jens Axboe076efc72006-10-27 11:24:25 +0200436 char *read_iolog_file;
437 char *write_iolog_file;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100438
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
Jens Axboee4e33252007-03-21 13:07:54 +0100460#define FIO_VERROR_SIZE 128
461
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100462/*
463 * This describes a single thread/process executing a fio job.
464 */
465struct thread_data {
466 struct thread_options o;
Jens Axboee4e33252007-03-21 13:07:54 +0100467 char verror[FIO_VERROR_SIZE];
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100468 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;
Jens Axboe1020a132007-03-29 11:15:06 +0200475 unsigned int nr_done_files;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100476 unsigned int nr_normal_files;
477 union {
478 unsigned int next_file;
479 os_random_state_t next_file_state;
480 };
481 int error;
Jens Axboe20e354e2007-07-23 14:36:16 +0200482 int done;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100483 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
Jens Axboe843a7412006-06-01 21:14:21 -0700494 void *iolog_buf;
495 FILE *iolog_f;
Jens Axboeebac4652005-12-08 15:25:21 +0100496
Jens Axboeda867742006-06-06 10:39:10 -0700497 char *sysfs_root;
Jens Axboeda867742006-06-06 10:39:10 -0700498
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200499 os_random_state_t bsrange_state;
500 os_random_state_t verify_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100501
502 int shm_id;
503
Jens Axboee9c047a2006-06-07 21:13:04 +0200504 /*
505 * IO engine hooks, contains everything needed to submit an io_u
506 * to any of the available IO engines.
507 */
Jens Axboe2866c822006-10-09 15:57:48 +0200508 struct ioengine_ops *io_ops;
Jens Axboeebac4652005-12-08 15:25:21 +0100509
Jens Axboee9c047a2006-06-07 21:13:04 +0200510 /*
511 * Current IO depth and list of free and busy io_u's.
512 */
Jens Axboeebac4652005-12-08 15:25:21 +0100513 unsigned int cur_depth;
514 struct list_head io_u_freelist;
515 struct list_head io_u_busylist;
Jens Axboe755200a2007-02-19 13:08:12 +0100516 struct list_head io_u_requeues;
Jens Axboecb5ab512007-02-26 12:57:09 +0100517 unsigned int io_u_queued;
Jens Axboeebac4652005-12-08 15:25:21 +0100518
Jens Axboee9c047a2006-06-07 21:13:04 +0200519 /*
520 * Rate state
521 */
Jens Axboeebac4652005-12-08 15:25:21 +0100522 unsigned long rate_usec_cycle;
523 long rate_pending_usleep;
524 unsigned long rate_bytes;
Jens Axboe4e991c22007-03-15 11:41:11 +0100525 unsigned long rate_blocks;
Jens Axboeebac4652005-12-08 15:25:21 +0100526 struct timeval lastrate;
527
Jens Axboeebac4652005-12-08 15:25:21 +0100528 unsigned long long total_io_size;
529
Jens Axboe755200a2007-02-19 13:08:12 +0100530 unsigned long io_issues[2];
Jens Axboe9104f872005-12-28 23:50:45 +0100531 unsigned long long io_blocks[2];
532 unsigned long long io_bytes[2];
Jens Axboe48f5abd2007-07-20 13:25:04 +0200533 unsigned long long io_skip_bytes;
Jens Axboe9104f872005-12-28 23:50:45 +0100534 unsigned long long this_io_bytes[2];
Jens Axboe079ad092007-02-20 13:58:20 +0100535 unsigned long long zone_bytes;
Jens Axboe07739b52007-03-08 20:25:46 +0100536 struct fio_sem *mutex;
Jens Axboeebac4652005-12-08 15:25:21 +0100537
Jens Axboee9c047a2006-06-07 21:13:04 +0200538 /*
539 * State for random io, a bitmap of blocks done vs not done
540 */
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200541 os_random_state_t random_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100542
Jens Axboeebac4652005-12-08 15:25:21 +0100543 struct timeval start; /* start of this loop */
544 struct timeval epoch; /* time job was started */
Jens Axboe38d77ca2007-03-21 14:20:20 +0100545 struct timeval rw_end[2];
Jens Axboea61edde2007-05-15 14:29:58 +0200546 struct timeval last_issue;
Jens Axboe38d77ca2007-03-21 14:20:20 +0100547 unsigned int rw_end_set[2];
Jens Axboeebac4652005-12-08 15:25:21 +0100548
Jens Axboee9c047a2006-06-07 21:13:04 +0200549 /*
Jens Axboee9c047a2006-06-07 21:13:04 +0200550 * read/write mixed workload state
551 */
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200552 os_random_state_t rwmix_state;
Jens Axboeafe24a52007-03-16 20:27:27 +0100553 unsigned long long rwmix_bytes;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200554 struct timeval rwmix_switch;
Jens Axboee9c047a2006-06-07 21:13:04 +0200555 enum fio_ddir rwmix_ddir;
Jens Axboe211097b2007-03-22 18:56:45 +0100556 unsigned int ddir_nr;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200557
Jens Axboe4e0ba8a2006-06-06 09:36:28 +0200558 /*
Jens Axboe8de8f042007-03-27 10:36:12 +0200559 * IO history logs for verification. We use a tree for sorting,
560 * if we are overwriting. Otherwise just use a fifo.
Jens Axboee9c047a2006-06-07 21:13:04 +0200561 */
Jens Axboe4b878982007-03-26 09:32:22 +0200562 struct rb_root io_hist_tree;
Jens Axboe8de8f042007-03-27 10:36:12 +0200563 struct list_head io_hist_list;
564
565 /*
566 * For IO replaying
567 */
Jens Axboeaea47d42006-05-26 19:27:29 +0200568 struct list_head io_log_list;
Jens Axboe433afcb2007-02-22 10:39:01 +0100569
570 /*
571 * timeout handling
572 */
573 struct timeval timeout_end;
574 struct itimerval timer;
Jens Axboe1907dbc2007-03-12 11:44:28 +0100575
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;
Jens Axboe9c60ce62007-03-15 09:14:47 +0100582
583 /*
584 * For generating file sizes
585 */
586 os_random_state_t file_size_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100587};
588
Jens Axboe433afcb2007-02-22 10:39:01 +0100589/*
Jens Axboe0aabe162007-02-23 08:45:55 +0100590 * roundrobin available files, or choose one at random.
591 */
592enum {
593 FIO_FSERVICE_RANDOM = 1,
594 FIO_FSERVICE_RR = 2,
595};
596
597/*
Jens Axboe433afcb2007-02-22 10:39:01 +0100598 * 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
Jens Axboee1161c32007-02-22 19:36:48 +0100604#define __td_verror(td, err, msg, func) \
Jens Axboeebac4652005-12-08 15:25:21 +0100605 do { \
Jens Axboe19abcd32007-02-21 20:14:33 +0100606 if ((td)->error) \
607 break; \
Jens Axboeebac4652005-12-08 15:25:21 +0100608 int e = (err); \
609 (td)->error = e; \
Jens Axboee1161c32007-02-22 19:36:48 +0100610 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 +0100611 } while (0)
612
Jens Axboeb990b5c2006-09-14 09:48:22 +0200613
Jens Axboee1161c32007-02-22 19:36:48 +0100614#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))
Jens Axboeb990b5c2006-09-14 09:48:22 +0200618
Jens Axboeebac4652005-12-08 15:25:21 +0100619extern int exitall_on_terminate;
620extern int thread_number;
Jens Axboe9cedf162007-03-12 11:29:30 +0100621extern int nr_process, nr_thread;
Jens Axboeebac4652005-12-08 15:25:21 +0100622extern int shm_id;
623extern int groupid;
Jens Axboec6ae0a52006-06-12 11:04:44 +0200624extern int terse_output;
Jens Axboeeb8bbf42006-06-08 21:40:11 +0200625extern FILE *f_out;
626extern FILE *f_err;
Jens Axboe53cdc682006-10-18 11:50:58 +0200627extern int temp_stall_ts;
Jens Axboe1e97cce2006-12-05 11:44:16 +0100628extern unsigned long long mlock_size;
Jens Axboecfc99db2007-03-14 10:34:47 +0100629extern unsigned long page_mask, page_size;
Jens Axboeebac4652005-12-08 15:25:21 +0100630
631extern struct thread_data *threads;
632
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100633#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)
Jens Axboeebac4652005-12-08 15:25:21 +0100637
638#define BLOCKS_PER_MAP (8 * sizeof(long))
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100639#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
Jens Axboe53cdc682006-10-18 11:50:58 +0200640#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))
Jens Axboeebac4652005-12-08 15:25:21 +0100642
643#define MAX_JOBS (1024)
644
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200645static inline int should_fsync(struct thread_data *td)
646{
647 if (td->last_was_sync)
648 return 0;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100649 if (td->o.odirect)
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200650 return 0;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100651 if (td_write(td) || td_rw(td) || td->o.override_sync)
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200652 return 1;
653
654 return 0;
655}
656
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100657/*
658 * Disk utils as read in /sys/block/<dev>/stat
659 */
Jens Axboeebac4652005-12-08 15:25:21 +0100660struct 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
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100669/*
670 * Per-device disk util management
671 */
Jens Axboeebac4652005-12-08 15:25:21 +0100672struct disk_util {
673 struct list_head list;
674
675 char *name;
Jens Axboee11c4102007-04-03 16:33:04 -0700676 char *sysfs_root;
Jens Axboeebac4652005-12-08 15:25:21 +0100677 char path[256];
Jens Axboe07e5b262007-04-02 14:46:07 +0200678 int major, minor;
Jens Axboeebac4652005-12-08 15:25:21 +0100679
680 struct disk_util_stat dus;
681 struct disk_util_stat last_dus;
682
683 unsigned long msec;
684 struct timeval time;
685};
686
Jens Axboeebac4652005-12-08 15:25:21 +0100687#define DISK_UTIL_MSEC (250)
688
Jens Axboe67962092006-06-07 08:45:01 +0200689/*
690 * Log exports
691 */
Jens Axboef29b25a2007-07-23 08:56:43 +0200692enum file_log_act {
693 FIO_LOG_ADD_FILE,
694 FIO_LOG_OPEN_FILE,
695 FIO_LOG_CLOSE_FILE,
696};
697
Jens Axboe72cb9712007-02-20 20:54:45 +0100698extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
Jens Axboef29b25a2007-07-23 08:56:43 +0200699extern void log_io_u(struct thread_data *, struct io_u *);
700extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
Jens Axboe72cb9712007-02-20 20:54:45 +0100701extern int __must_check init_iolog(struct thread_data *td);
Jens Axboe67962092006-06-07 08:45:01 +0200702extern 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 */
Jens Axboe1e97cce2006-12-05 11:44:16 +0100709extern 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 *);
Jens Axboe67962092006-06-07 08:45:01 +0200712extern 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);
Jens Axboe8914a9d2006-06-07 11:14:56 +0200717extern void setup_log(struct io_log **);
718extern void finish_log(struct thread_data *, struct io_log *, const char *);
Jens Axboebb3884d2007-01-17 17:23:11 +1100719extern void __finish_log(struct io_log *, const char *);
Jens Axboebb3884d2007-01-17 17:23:11 +1100720extern struct io_log *agg_io_log[2];
721extern int write_bw_log;
722extern void add_agg_sample(unsigned long, enum fio_ddir);
Jens Axboe67962092006-06-07 08:45:01 +0200723
724/*
725 * Time functions
726 */
727extern unsigned long utime_since(struct timeval *, struct timeval *);
Jens Axboe69008992006-11-24 13:12:56 +0100728extern unsigned long utime_since_now(struct timeval *);
Jens Axboe67962092006-06-07 08:45:01 +0200729extern unsigned long mtime_since(struct timeval *, struct timeval *);
730extern unsigned long mtime_since_now(struct timeval *);
731extern unsigned long time_since_now(struct timeval *);
Jens Axboe263e5292006-10-18 15:37:01 +0200732extern unsigned long mtime_since_genesis(void);
Jens Axboeb990b5c2006-09-14 09:48:22 +0200733extern void __usec_sleep(unsigned int);
Jens Axboe67962092006-06-07 08:45:01 +0200734extern void usec_sleep(struct thread_data *, unsigned long);
Jens Axboe413dd452007-02-23 09:26:09 +0100735extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
Jens Axboe6043c572006-11-03 11:37:47 +0100736extern void fill_start_time(struct timeval *);
Jens Axboe02bcaa82006-11-24 10:42:00 +0100737extern void fio_gettime(struct timeval *, void *);
Jens Axboea2f77c92007-02-22 11:53:00 +0100738extern void set_genesis_time(void);
Jens Axboe67962092006-06-07 08:45:01 +0200739
Jens Axboe8914a9d2006-06-07 11:14:56 +0200740/*
Jens Axboe214e1ec2007-03-15 10:48:13 +0100741 * Init/option functions
Jens Axboe8914a9d2006-06-07 11:14:56 +0200742 */
Jens Axboe72cb9712007-02-20 20:54:45 +0100743extern int __must_check parse_options(int, char **);
Jens Axboe214e1ec2007-03-15 10:48:13 +0100744extern 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 *);
Jens Axboed23bb322007-03-23 15:57:56 +0100749extern void options_mem_dupe(struct thread_data *);
750extern void options_mem_free(struct thread_data *);
Jens Axboe214e1ec2007-03-15 10:48:13 +0100751#define FIO_GETOPT_JOB 0x89988998
752#define FIO_NR_OPTIONS 128
Jens Axboe8914a9d2006-06-07 11:14:56 +0200753
Jens Axboebbfd6b02006-06-07 19:42:54 +0200754/*
Jens Axboe53cdc682006-10-18 11:50:58 +0200755 * File setup/shutdown
756 */
757extern void close_files(struct thread_data *);
Jens Axboeb2fdda42007-02-20 20:52:51 +0100758extern 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 *);
Jens Axboeb5af8292007-03-08 12:43:13 +0100761extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
762extern void generic_close_file(struct thread_data *, struct fio_file *);
Jens Axboef29b25a2007-07-23 08:56:43 +0200763extern int add_file(struct thread_data *, const char *);
Jens Axboe0ad920e2007-03-13 11:06:45 +0100764extern void get_file(struct fio_file *);
765extern void put_file(struct thread_data *, struct fio_file *);
Jens Axboebbf6b542007-03-13 15:28:55 +0100766extern int add_dir_files(struct thread_data *, const char *);
Jens Axboe68727072007-03-15 20:49:25 +0100767extern int init_random_map(struct thread_data *);
Jens Axboecade3ef2007-03-23 15:29:45 +0100768extern void dup_files(struct thread_data *, struct thread_data *);
Jens Axboef29b25a2007-07-23 08:56:43 +0200769extern int get_fileno(struct thread_data *, const char *);
770extern void free_release_files(struct thread_data *);
Jens Axboe53cdc682006-10-18 11:50:58 +0200771
772/*
Jens Axboe263e5292006-10-18 15:37:01 +0200773 * ETA/status stuff
774 */
775extern void print_thread_status(void);
776extern void print_status_init(int);
777
778/*
Jens Axboe9f8f2062007-04-02 15:08:01 +0200779 * 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
793/*
Jens Axboe263e5292006-10-18 15:37:01 +0200794 * 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
810/*
Jens Axboee29d1b72006-10-18 15:43:15 +0200811 * Verify helpers
812 */
813extern void populate_verify_io_u(struct thread_data *, struct io_u *);
Jens Axboeb2fdda42007-02-20 20:52:51 +0100814extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
Jens Axboe36690c92007-03-26 10:23:34 +0200815extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
Jens Axboee29d1b72006-10-18 15:43:15 +0200816
817/*
Jens Axboe2f9ade32006-10-20 11:25:52 +0200818 * Memory helpers
819 */
Jens Axboeb2fdda42007-02-20 20:52:51 +0100820extern int __must_check fio_pin_memory(void);
Jens Axboe2f9ade32006-10-20 11:25:52 +0200821extern void fio_unpin_memory(void);
Jens Axboeb2fdda42007-02-20 20:52:51 +0100822extern int __must_check allocate_io_mem(struct thread_data *);
Jens Axboe2f9ade32006-10-20 11:25:52 +0200823extern void free_io_mem(struct thread_data *);
824
825/*
Jens Axboe10ba5352006-10-20 11:39:27 +0200826 * 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 *);
Jens Axboe3d7c3912007-02-19 13:16:12 +0100830extern struct io_u *get_io_u(struct thread_data *);
Jens Axboe10ba5352006-10-20 11:39:27 +0200831extern void put_io_u(struct thread_data *, struct io_u *);
Jens Axboe755200a2007-02-19 13:08:12 +0100832extern void requeue_io_u(struct thread_data *, struct io_u **);
Jens Axboed7762cf2007-02-23 12:34:57 +0100833extern 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);
Jens Axboe7e77dd02007-02-20 10:57:34 +0100835extern void io_u_queued(struct thread_data *, struct io_u *);
Jens Axboe54517922007-03-05 10:06:06 +0100836extern void io_u_log_error(struct thread_data *, struct io_u *);
Jens Axboe433afcb2007-02-22 10:39:01 +0100837extern void io_u_init_timeout(void);
838extern void io_u_set_timeout(struct thread_data *);
Jens Axboeb3605062007-03-12 14:19:47 +0100839extern void io_u_mark_depth(struct thread_data *, struct io_u *);
Jens Axboe10ba5352006-10-20 11:39:27 +0200840
841/*
842 * io engine entry points
843 */
Jens Axboeb2fdda42007-02-20 20:52:51 +0100844extern 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 *);
Jens Axboeb5af8292007-03-08 12:43:13 +0100850extern 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 *);
Jens Axboe10ba5352006-10-20 11:39:27 +0200852
853/*
Jens Axboefb7b71a2007-05-15 08:44:04 +0200854 * blktrace support
855 */
Jens Axboe5e62c222007-05-22 13:27:30 +0200856#ifdef FIO_HAVE_BLKTRACE
Jens Axboefb7b71a2007-05-15 08:44:04 +0200857extern int is_blktrace(const char *);
858extern int load_blktrace(struct thread_data *, const char *);
Jens Axboe5e62c222007-05-22 13:27:30 +0200859#endif
Jens Axboefb7b71a2007-05-15 08:44:04 +0200860
861/*
Jens Axboe3b70d7e2006-06-08 21:48:46 +0200862 * 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
Jens Axboe9c60ce62007-03-15 09:14:47 +0100870#define log_info(args...) fprintf(f_out, ##args)
871
Joel Becker9728ce32007-03-01 08:24:39 +0100872FILE *get_f_out(void);
873FILE *get_f_err(void);
874
Jens Axboe2866c822006-10-09 15:57:48 +0200875struct ioengine_ops {
Jens Axboe5f350952006-11-07 15:20:59 +0100876 struct list_head list;
Jens Axboe2866c822006-10-09 15:57:48 +0200877 char name[16];
878 int version;
879 int flags;
Jens Axboeea2877a2006-10-10 08:30:24 +0200880 int (*setup)(struct thread_data *);
Jens Axboe2866c822006-10-09 15:57:48 +0200881 int (*init)(struct thread_data *);
882 int (*prep)(struct thread_data *, struct io_u *);
883 int (*queue)(struct thread_data *, struct io_u *);
Jens Axboe755200a2007-02-19 13:08:12 +0100884 int (*commit)(struct thread_data *);
Jens Axboe2866c822006-10-09 15:57:48 +0200885 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 *);
Jens Axboeb5af8292007-03-08 12:43:13 +0100889 int (*open_file)(struct thread_data *, struct fio_file *);
890 void (*close_file)(struct thread_data *, struct fio_file *);
Jens Axboe2866c822006-10-09 15:57:48 +0200891 void *data;
892 void *dlhandle;
893};
894
Jens Axboe2c187c02007-03-27 15:57:19 +0200895#define FIO_IOOPS_VERSION 7
Jens Axboe2866c822006-10-09 15:57:48 +0200896
Jens Axboeb4692822006-10-27 13:43:22 +0200897extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
Jens Axboeb2fdda42007-02-20 20:52:51 +0100898extern void register_ioengine(struct ioengine_ops *);
Jens Axboe5f350952006-11-07 15:20:59 +0100899extern void unregister_ioengine(struct ioengine_ops *);
Jens Axboe2866c822006-10-09 15:57:48 +0200900extern 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__))
Jens Axboe5f350952006-11-07 15:20:59 +0100906#define fio_init __attribute__((constructor))
907#define fio_exit __attribute__((destructor))
Jens Axboe2866c822006-10-09 15:57:48 +0200908
Jens Axboe34572e22006-10-20 09:33:18 +0200909#define for_each_td(td, i) \
910 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
Jens Axboe53cdc682006-10-18 11:50:58 +0200911#define for_each_file(td, f, i) \
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100912 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
Jens Axboe53cdc682006-10-18 11:50:58 +0200913
Jens Axboe0032bf92007-02-13 17:39:56 +0100914#define fio_assert(td, cond) do { \
915 if (!(cond)) { \
Jens Axboe340fd242007-02-13 20:09:10 +0100916 int *__foo = NULL; \
Jens Axboe0032bf92007-02-13 17:39:56 +0100917 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
918 (td)->runstate = TD_EXITED; \
Jens Axboe437c9b72007-02-13 18:20:37 +0100919 (td)->error = EFAULT; \
Jens Axboe340fd242007-02-13 20:09:10 +0100920 *__foo = 0; \
Jens Axboe0032bf92007-02-13 17:39:56 +0100921 } \
922} while (0)
923
Jens Axboe9bf27b42007-03-27 19:49:31 +0200924static inline void clear_error(struct thread_data *td)
925{
926 td->error = 0;
927 td->verror[0] = '\0';
928}
929
Jens Axboeebac4652005-12-08 15:25:21 +0100930#endif