blob: 0ca23cc0e6b09186b059e8bae86b266d22a6d5de [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 Axboeebac4652005-12-08 15:25:21 +010014
15#include "list.h"
16#include "md5.h"
17#include "crc32.h"
18#include "arch.h"
19#include "os.h"
Jens Axboe07739b52007-03-08 20:25:46 +010020#include "mutex.h"
Jens Axboeebac4652005-12-08 15:25:21 +010021
Jens Axboeb6959b52007-02-14 21:40:27 +000022#ifdef FIO_HAVE_SYSLET
Jens Axboea4f4fdd2007-02-14 01:16:39 +010023#include "syslet.h"
Jens Axboeb6959b52007-02-14 21:40:27 +000024#endif
Jens Axboea4f4fdd2007-02-14 01:16:39 +010025
Jens Axboe1e97cce2006-12-05 11:44:16 +010026enum fio_ddir {
27 DDIR_READ = 0,
28 DDIR_WRITE,
29 DDIR_SYNC,
30};
31
Jens Axboe413dd452007-02-23 09:26:09 +010032enum td_ddir {
Jens Axboeb1ec1da2007-02-23 10:29:16 +010033 TD_DDIR_READ = 1 << 0,
34 TD_DDIR_WRITE = 1 << 1,
35 TD_DDIR_RAND = 1 << 2,
36 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
37 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
Joel Becker7ff1c142007-03-03 12:03:29 +010038 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
Jens Axboeb1ec1da2007-02-23 10:29:16 +010039 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
Jens Axboe413dd452007-02-23 09:26:09 +010040};
41
Jens Axboe1c9e06e2007-02-11 04:07:57 +010042/*
43 * Use for maintaining statistics
44 */
Jens Axboeebac4652005-12-08 15:25:21 +010045struct io_stat {
Jens Axboeebac4652005-12-08 15:25:21 +010046 unsigned long max_val;
47 unsigned long min_val;
48 unsigned long samples;
Jens Axboe68704082007-01-10 19:56:37 +010049
50 double mean;
51 double S;
Jens Axboeebac4652005-12-08 15:25:21 +010052};
53
Jens Axboe1c9e06e2007-02-11 04:07:57 +010054/*
55 * A single data sample
56 */
Jens Axboeebac4652005-12-08 15:25:21 +010057struct io_sample {
58 unsigned long time;
59 unsigned long val;
Jens Axboe1e97cce2006-12-05 11:44:16 +010060 enum fio_ddir ddir;
Jens Axboeebac4652005-12-08 15:25:21 +010061};
62
Jens Axboe1c9e06e2007-02-11 04:07:57 +010063/*
64 * Dynamically growing data sample log
65 */
Jens Axboeebac4652005-12-08 15:25:21 +010066struct io_log {
67 unsigned long nr_samples;
68 unsigned long max_samples;
69 struct io_sample *log;
70};
71
Jens Axboe1c9e06e2007-02-11 04:07:57 +010072/*
73 * When logging io actions, this matches a single sent io_u
74 */
Jens Axboeebac4652005-12-08 15:25:21 +010075struct io_piece {
76 struct list_head list;
Jens Axboe53cdc682006-10-18 11:50:58 +020077 struct fio_file *file;
Jens Axboeebac4652005-12-08 15:25:21 +010078 unsigned long long offset;
Jens Axboea4f4fdd2007-02-14 01:16:39 +010079 unsigned long len;
Jens Axboe1e97cce2006-12-05 11:44:16 +010080 enum fio_ddir ddir;
Jens Axboeebac4652005-12-08 15:25:21 +010081};
82
Jens Axboea4f4fdd2007-02-14 01:16:39 +010083#ifdef FIO_HAVE_SYSLET
84struct syslet_req {
Jens Axboe5b38ee82007-02-26 10:44:22 +010085 struct syslet_uatom atom; /* the atom to submit */
86 struct syslet_uatom *head; /* head of the sequence */
87 long ret; /* syscall return value */
Jens Axboea4f4fdd2007-02-14 01:16:39 +010088};
89#endif
90
Jens Axboe0c6e7512007-02-22 11:19:39 +010091enum {
92 IO_U_F_FREE = 1 << 0,
93 IO_U_F_FLIGHT = 1 << 1,
94};
95
Jens Axboeebac4652005-12-08 15:25:21 +010096/*
97 * The io unit
98 */
99struct io_u {
100 union {
101#ifdef FIO_HAVE_LIBAIO
102 struct iocb iocb;
103#endif
104#ifdef FIO_HAVE_POSIXAIO
105 struct aiocb aiocb;
106#endif
107#ifdef FIO_HAVE_SGIO
108 struct sg_io_hdr hdr;
109#endif
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100110#ifdef FIO_HAVE_SYSLET
Jens Axboea2e1b082007-02-14 08:06:19 +0100111 struct syslet_req req;
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100112#endif
Jens Axboeebac4652005-12-08 15:25:21 +0100113 };
114 struct timeval start_time;
115 struct timeval issue_time;
116
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100117 /*
118 * Allocated/set buffer and length
119 */
Jens Axboe6b9cea22006-10-30 17:00:24 +0100120 void *buf;
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100121 unsigned long buflen;
Jens Axboeebac4652005-12-08 15:25:21 +0100122 unsigned long long offset;
123
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100124 /*
125 * IO engine state, may be different from above when we get
126 * partial transfers / residual data counts
127 */
Jens Axboecec6b552007-02-06 20:15:38 +0100128 void *xfer_buf;
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100129 unsigned long xfer_buflen;
Jens Axboecec6b552007-02-06 20:15:38 +0100130
Jens Axboeebac4652005-12-08 15:25:21 +0100131 unsigned int resid;
132 unsigned int error;
133
Jens Axboe1e97cce2006-12-05 11:44:16 +0100134 enum fio_ddir ddir;
Jens Axboeebac4652005-12-08 15:25:21 +0100135
Jens Axboedfd7bc22006-10-24 12:17:57 +0200136 /*
137 * io engine private data
138 */
139 union {
140 unsigned int index;
141 unsigned int seen;
142 };
143
Jens Axboe0c6e7512007-02-22 11:19:39 +0100144 unsigned int flags;
145
Jens Axboe53cdc682006-10-18 11:50:58 +0200146 struct fio_file *file;
147
Jens Axboeebac4652005-12-08 15:25:21 +0100148 struct list_head list;
Jens Axboed7762cf2007-02-23 12:34:57 +0100149
150 /*
151 * Callback for io completion
152 */
153 int (*end_io)(struct io_u *);
Jens Axboeebac4652005-12-08 15:25:21 +0100154};
155
Jens Axboe36167d82007-02-18 05:41:31 +0100156/*
157 * io_ops->queue() return values
158 */
159enum {
160 FIO_Q_COMPLETED = 0, /* completed sync */
161 FIO_Q_QUEUED = 1, /* queued, will complete async */
Jens Axboe755200a2007-02-19 13:08:12 +0100162 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
Jens Axboe36167d82007-02-18 05:41:31 +0100163};
164
Jens Axboeebac4652005-12-08 15:25:21 +0100165#define FIO_HDR_MAGIC 0xf00baaef
166
167enum {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100168 VERIFY_NONE = 0, /* no verification */
169 VERIFY_MD5, /* md5 sum data blocks */
170 VERIFY_CRC32, /* crc32 sum data blocks */
Jens Axboeebac4652005-12-08 15:25:21 +0100171};
172
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100173/*
174 * A header structure associated with each checksummed data block
175 */
Jens Axboeebac4652005-12-08 15:25:21 +0100176struct verify_header {
177 unsigned int fio_magic;
178 unsigned int len;
179 unsigned int verify_type;
180 union {
181 char md5_digest[MD5_HASH_WORDS * 4];
182 unsigned long crc32;
183 };
184};
185
186struct group_run_stats {
Jens Axboe9104f872005-12-28 23:50:45 +0100187 unsigned long long max_run[2], min_run[2];
188 unsigned long long max_bw[2], min_bw[2];
Jens Axboee9b2a3f2006-06-06 15:38:33 +0200189 unsigned long long io_kb[2];
Jens Axboe9104f872005-12-28 23:50:45 +0100190 unsigned long long agg[2];
Jens Axboeebac4652005-12-08 15:25:21 +0100191};
192
Jens Axboee9c047a2006-06-07 21:13:04 +0200193/*
194 * What type of allocation to use for io buffers
195 */
196enum fio_memtype {
197 MEM_MALLOC = 0, /* ordinary malloc */
198 MEM_SHM, /* use shared memory segments */
Jens Axboe74b025b2006-12-19 15:18:14 +0100199 MEM_SHMHUGE, /* use shared memory segments with huge pages */
Jens Axboee9c047a2006-06-07 21:13:04 +0200200 MEM_MMAP, /* use anonynomous mmap */
Jens Axboed0bdaf42006-12-20 14:40:44 +0100201 MEM_MMAPHUGE, /* memory mapped huge file */
Jens Axboee9c047a2006-06-07 21:13:04 +0200202};
203
204/*
205 * The type of object we are working on
206 */
207enum fio_filetype {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100208 FIO_TYPE_FILE = 1, /* plain file */
209 FIO_TYPE_BD, /* block device */
210 FIO_TYPE_CHAR, /* character device */
Jens Axboee9c047a2006-06-07 21:13:04 +0200211};
212
Jens Axboe2866c822006-10-09 15:57:48 +0200213enum fio_ioengine_flags {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100214 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
Jens Axboeba0fbe12007-03-09 14:34:23 +0100215 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
216 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
Jens Axboe02638822007-03-12 09:25:55 +0100217 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
Jens Axboe62d984e2007-03-13 08:15:18 +0100218 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
Jens Axboee9c047a2006-06-07 21:13:04 +0200219};
220
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100221/*
222 * Each thread_data structure has a number of files associated with it,
223 * this structure holds state information for a single file.
224 */
Jens Axboe53cdc682006-10-18 11:50:58 +0200225struct fio_file {
226 /*
227 * A file may not be a file descriptor, let the io engine decide
228 */
229 union {
230 unsigned long file_data;
Jens Axboee26f8f72007-02-17 04:39:54 +0100231 int fd;
Jens Axboe53cdc682006-10-18 11:50:58 +0200232 };
233 char *file_name;
234 void *mmap;
235 unsigned long long file_size;
236 unsigned long long real_file_size;
237 unsigned long long file_offset;
238 unsigned long long last_pos;
Jens Axboe02bcaa82006-11-24 10:42:00 +0100239 unsigned long long last_completed_pos;
Jens Axboe53cdc682006-10-18 11:50:58 +0200240
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100241 /*
242 * block map for random io
243 */
Jens Axboe53cdc682006-10-18 11:50:58 +0200244 unsigned long *file_map;
245 unsigned int num_maps;
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100246 unsigned int last_free_lookup;
Jens Axboe9b031dc2006-12-15 16:01:54 +0100247
248 unsigned int unlink;
Jens Axboe860a3042007-03-08 14:09:18 +0100249 unsigned int open;
Jens Axboe53cdc682006-10-18 11:50:58 +0200250};
251
Jens Axboeb2560f32007-03-06 12:43:03 +0100252/*
253 * How many depth levels to log
254 */
255#define FIO_IO_U_MAP_NR 8
256#define FIO_IO_U_LAT_NR 12
257
Jens Axboe079ad092007-02-20 13:58:20 +0100258struct thread_stat {
Jens Axboe756867b2007-03-06 15:19:24 +0100259 char *name;
260 char *verror;
261 int error;
262 int groupid;
263 pid_t pid;
264 char *description;
Jens Axboe6586ee82007-03-06 19:46:09 +0100265 int members;
Jens Axboe756867b2007-03-06 15:19:24 +0100266
Jens Axboe079ad092007-02-20 13:58:20 +0100267 struct io_log *slat_log;
268 struct io_log *clat_log;
269 struct io_log *bw_log;
270
271 /*
272 * bandwidth and latency stats
273 */
274 struct io_stat clat_stat[2]; /* completion latency */
275 struct io_stat slat_stat[2]; /* submission latency */
276 struct io_stat bw_stat[2]; /* bandwidth stats */
277
278 unsigned long long stat_io_bytes[2];
279 struct timeval stat_sample_time[2];
280
281 /*
282 * fio system usage accounting
283 */
284 struct rusage ru_start;
285 struct rusage ru_end;
286 unsigned long usr_time;
287 unsigned long sys_time;
288 unsigned long ctx;
Jens Axboe079ad092007-02-20 13:58:20 +0100289
Jens Axboeb2560f32007-03-06 12:43:03 +0100290 /*
291 * IO depth and latency stats
292 */
293 unsigned int io_u_map[FIO_IO_U_MAP_NR];
294 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
Jens Axboeb3605062007-03-12 14:19:47 +0100295 unsigned long total_io_u[2];
Jens Axboe756867b2007-03-06 15:19:24 +0100296
297 unsigned long long io_bytes[2];
298 unsigned long runtime[2];
299 unsigned long total_run_time;
Jens Axboeb2560f32007-03-06 12:43:03 +0100300};
Jens Axboe71619dc2007-01-13 23:56:33 +0100301
302/*
Jens Axboee9c047a2006-06-07 21:13:04 +0200303 * This describes a single thread/process executing a fio job.
304 */
Jens Axboeebac4652005-12-08 15:25:21 +0100305struct thread_data {
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100306 int pad;
Jens Axboe61697c32007-02-05 15:04:46 +0100307 char *description;
Jens Axboeb4692822006-10-27 13:43:22 +0200308 char *name;
Jens Axboeef899b62006-06-06 09:31:00 +0200309 char *directory;
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200310 char *filename;
Jens Axboe09629a92007-03-09 09:00:06 +0100311 char *ioengine;
Joel Becker480936d2007-03-02 21:23:00 +0100312 char verror[128];
Jens Axboeebac4652005-12-08 15:25:21 +0100313 pthread_t thread;
314 int thread_number;
315 int groupid;
Jens Axboe756867b2007-03-06 15:19:24 +0100316 struct thread_stat ts;
Jens Axboee9c047a2006-06-07 21:13:04 +0200317 enum fio_filetype filetype;
Jens Axboe53cdc682006-10-18 11:50:58 +0200318 struct fio_file *files;
319 unsigned int nr_files;
Jens Axboebdb4e2e2007-03-01 09:54:57 +0100320 unsigned int nr_open_files;
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200321 unsigned int nr_uniq_files;
Jens Axboe0aabe162007-02-23 08:45:55 +0100322 union {
323 unsigned int next_file;
324 os_random_state_t next_file_state;
325 };
Jens Axboeebac4652005-12-08 15:25:21 +0100326 int error;
Jens Axboeebac4652005-12-08 15:25:21 +0100327 pid_t pid;
328 char *orig_buffer;
329 size_t orig_buffer_size;
330 volatile int terminate;
331 volatile int runstate;
Jens Axboe413dd452007-02-23 09:26:09 +0100332 enum td_ddir td_ddir;
Jens Axboeebac4652005-12-08 15:25:21 +0100333 unsigned int ioprio;
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200334 unsigned int last_was_sync;
Jens Axboee9c047a2006-06-07 21:13:04 +0200335
Jens Axboe9158d2f2006-10-27 14:27:39 +0200336 unsigned int odirect;
337 unsigned int invalidate_cache;
338 unsigned int create_serialize;
339 unsigned int create_fsync;
340 unsigned int end_fsync;
341 unsigned int sync_io;
342 unsigned int verify;
343 unsigned int use_thread;
344 unsigned int unlink;
345 unsigned int do_disk_util;
346 unsigned int override_sync;
347 unsigned int rand_repeatable;
348 unsigned int write_lat_log;
349 unsigned int write_bw_log;
Jens Axboebb8895e2006-10-30 15:14:48 +0100350 unsigned int norandommap;
Jens Axboe690adba2006-10-30 15:25:09 +0100351 unsigned int bs_unaligned;
Jens Axboee9c047a2006-06-07 21:13:04 +0200352
Jens Axboea00735e2006-11-03 08:58:08 +0100353 unsigned int bs[2];
354 unsigned int min_bs[2];
355 unsigned int max_bs[2];
Jens Axboe56bb17f2006-12-20 20:27:36 +0100356 unsigned int hugepage_size;
Jens Axboea00735e2006-11-03 08:58:08 +0100357 unsigned int rw_min_bs;
Jens Axboeebac4652005-12-08 15:25:21 +0100358 unsigned int thinktime;
Jens Axboe48097d52007-02-17 06:30:44 +0100359 unsigned int thinktime_spin;
Jens Axboe9c1f7432007-01-03 20:43:19 +0100360 unsigned int thinktime_blocks;
Jens Axboeebac4652005-12-08 15:25:21 +0100361 unsigned int fsync_blocks;
362 unsigned int start_delay;
Jens Axboe906c8d72006-06-13 09:37:56 +0200363 unsigned long timeout;
Jens Axboeebac4652005-12-08 15:25:21 +0100364 unsigned int overwrite;
Jens Axboeebac4652005-12-08 15:25:21 +0100365 unsigned int bw_avg_time;
Jens Axboeebac4652005-12-08 15:25:21 +0100366 unsigned int loops;
Jens Axboe20dc95c2005-12-09 10:29:35 +0100367 unsigned long long zone_size;
368 unsigned long long zone_skip;
Jens Axboee9c047a2006-06-07 21:13:04 +0200369 enum fio_memtype mem_type;
Jens Axboe313cb202006-12-21 09:50:00 +0100370 char *mmapfile;
371 int mmapfd;
Jens Axboeebac4652005-12-08 15:25:21 +0100372 unsigned int stonewall;
373 unsigned int numjobs;
Jens Axboeebac4652005-12-08 15:25:21 +0100374 unsigned int iodepth;
Jens Axboee916b392007-02-20 14:37:26 +0100375 unsigned int iodepth_low;
Jens Axboecb5ab512007-02-26 12:57:09 +0100376 unsigned int iodepth_batch;
Jens Axboeebac4652005-12-08 15:25:21 +0100377 os_cpu_mask_t cpumask;
Jens Axboeaea47d42006-05-26 19:27:29 +0200378 unsigned int iolog;
Jens Axboe843a7412006-06-01 21:14:21 -0700379 unsigned int read_iolog;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200380 unsigned int rwmixcycle;
381 unsigned int rwmixread;
Jens Axboee1f36502006-10-27 10:54:08 +0200382 unsigned int rwmixwrite;
Jens Axboeb6f4d882006-06-02 10:32:51 +0200383 unsigned int nice;
Jens Axboe0aabe162007-02-23 08:45:55 +0100384 unsigned int file_service_type;
Jens Axboeb2560f32007-03-06 12:43:03 +0100385 unsigned int group_reporting;
Jens Axboeb5af8292007-03-08 12:43:13 +0100386 unsigned int open_files;
Jens Axboeaea47d42006-05-26 19:27:29 +0200387
Jens Axboe076efc72006-10-27 11:24:25 +0200388 char *read_iolog_file;
389 char *write_iolog_file;
Jens Axboe843a7412006-06-01 21:14:21 -0700390 void *iolog_buf;
391 FILE *iolog_f;
Jens Axboeebac4652005-12-08 15:25:21 +0100392
Jens Axboeda867742006-06-06 10:39:10 -0700393 char *sysfs_root;
Jens Axboeda867742006-06-06 10:39:10 -0700394 char *ioscheduler;
395
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200396 os_random_state_t bsrange_state;
397 os_random_state_t verify_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100398
399 int shm_id;
400
Jens Axboee9c047a2006-06-07 21:13:04 +0200401 /*
402 * IO engine hooks, contains everything needed to submit an io_u
403 * to any of the available IO engines.
404 */
Jens Axboe2866c822006-10-09 15:57:48 +0200405 struct ioengine_ops *io_ops;
Jens Axboeebac4652005-12-08 15:25:21 +0100406
Jens Axboee9c047a2006-06-07 21:13:04 +0200407 /*
408 * Current IO depth and list of free and busy io_u's.
409 */
Jens Axboeebac4652005-12-08 15:25:21 +0100410 unsigned int cur_depth;
411 struct list_head io_u_freelist;
412 struct list_head io_u_busylist;
Jens Axboe755200a2007-02-19 13:08:12 +0100413 struct list_head io_u_requeues;
Jens Axboecb5ab512007-02-26 12:57:09 +0100414 unsigned int io_u_queued;
Jens Axboeebac4652005-12-08 15:25:21 +0100415
Jens Axboee9c047a2006-06-07 21:13:04 +0200416 /*
417 * Rate state
418 */
Jens Axboeebac4652005-12-08 15:25:21 +0100419 unsigned int rate;
420 unsigned int ratemin;
421 unsigned int ratecycle;
422 unsigned long rate_usec_cycle;
423 long rate_pending_usleep;
424 unsigned long rate_bytes;
425 struct timeval lastrate;
426
Jens Axboeebac4652005-12-08 15:25:21 +0100427 unsigned long long io_size;
Jens Axboe53cdc682006-10-18 11:50:58 +0200428 unsigned long long total_file_size;
429 unsigned long long start_offset;
Jens Axboeebac4652005-12-08 15:25:21 +0100430 unsigned long long total_io_size;
431
Jens Axboe755200a2007-02-19 13:08:12 +0100432 unsigned long io_issues[2];
Jens Axboe9104f872005-12-28 23:50:45 +0100433 unsigned long long io_blocks[2];
434 unsigned long long io_bytes[2];
Jens Axboe9104f872005-12-28 23:50:45 +0100435 unsigned long long this_io_bytes[2];
Jens Axboe079ad092007-02-20 13:58:20 +0100436 unsigned long long zone_bytes;
Jens Axboe07739b52007-03-08 20:25:46 +0100437 struct fio_sem *mutex;
Jens Axboeebac4652005-12-08 15:25:21 +0100438
Jens Axboee9c047a2006-06-07 21:13:04 +0200439 /*
440 * State for random io, a bitmap of blocks done vs not done
441 */
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200442 os_random_state_t random_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100443
444 /*
Jens Axboeb990b5c2006-09-14 09:48:22 +0200445 * CPU "io" cycle burner
446 */
447 unsigned int cpuload;
448 unsigned int cpucycle;
449
Jens Axboeebac4652005-12-08 15:25:21 +0100450 struct timeval start; /* start of this loop */
451 struct timeval epoch; /* time job was started */
452
Jens Axboee9c047a2006-06-07 21:13:04 +0200453 /*
Jens Axboee9c047a2006-06-07 21:13:04 +0200454 * read/write mixed workload state
455 */
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200456 os_random_state_t rwmix_state;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200457 struct timeval rwmix_switch;
Jens Axboee9c047a2006-06-07 21:13:04 +0200458 enum fio_ddir rwmix_ddir;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200459
Jens Axboe4e0ba8a2006-06-06 09:36:28 +0200460 /*
461 * Pre-run and post-run shell
462 */
463 char *exec_prerun;
464 char *exec_postrun;
465
Jens Axboee9c047a2006-06-07 21:13:04 +0200466 /*
467 * IO historic logs
468 */
Jens Axboeebac4652005-12-08 15:25:21 +0100469 struct list_head io_hist_list;
Jens Axboeaea47d42006-05-26 19:27:29 +0200470 struct list_head io_log_list;
Jens Axboe433afcb2007-02-22 10:39:01 +0100471
472 /*
473 * timeout handling
474 */
475 struct timeval timeout_end;
476 struct itimerval timer;
Jens Axboe1907dbc2007-03-12 11:44:28 +0100477
478 /*
479 * for fileservice, how often to switch to a new file
480 */
481 unsigned int file_service_nr;
482 unsigned int file_service_left;
483 struct fio_file *file_service_file;
Jens Axboeebac4652005-12-08 15:25:21 +0100484};
485
Jens Axboe433afcb2007-02-22 10:39:01 +0100486/*
Jens Axboe0aabe162007-02-23 08:45:55 +0100487 * roundrobin available files, or choose one at random.
488 */
489enum {
490 FIO_FSERVICE_RANDOM = 1,
491 FIO_FSERVICE_RR = 2,
492};
493
494/*
Jens Axboe433afcb2007-02-22 10:39:01 +0100495 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
496 * the timer on each queue operation.
497 */
498#define IO_U_TIMEOUT_INC 5
499#define IO_U_TIMEOUT 30
500
Jens Axboee1161c32007-02-22 19:36:48 +0100501#define __td_verror(td, err, msg, func) \
Jens Axboeebac4652005-12-08 15:25:21 +0100502 do { \
Jens Axboe19abcd32007-02-21 20:14:33 +0100503 if ((td)->error) \
504 break; \
Jens Axboeebac4652005-12-08 15:25:21 +0100505 int e = (err); \
506 (td)->error = e; \
Jens Axboee1161c32007-02-22 19:36:48 +0100507 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 +0100508 } while (0)
509
Jens Axboeb990b5c2006-09-14 09:48:22 +0200510
Jens Axboee1161c32007-02-22 19:36:48 +0100511#define td_verror(td, err, func) \
512 __td_verror((td), (err), strerror((err)), (func))
513#define td_vmsg(td, err, msg, func) \
514 __td_verror((td), (err), (msg), (func))
Jens Axboeb990b5c2006-09-14 09:48:22 +0200515
Jens Axboeebac4652005-12-08 15:25:21 +0100516extern int exitall_on_terminate;
517extern int thread_number;
Jens Axboe9cedf162007-03-12 11:29:30 +0100518extern int nr_process, nr_thread;
Jens Axboeebac4652005-12-08 15:25:21 +0100519extern int shm_id;
520extern int groupid;
Jens Axboec6ae0a52006-06-12 11:04:44 +0200521extern int terse_output;
Jens Axboeeb8bbf42006-06-08 21:40:11 +0200522extern FILE *f_out;
523extern FILE *f_err;
Jens Axboe53cdc682006-10-18 11:50:58 +0200524extern int temp_stall_ts;
Jens Axboe1e97cce2006-12-05 11:44:16 +0100525extern unsigned long long mlock_size;
Jens Axboeebac4652005-12-08 15:25:21 +0100526
527extern struct thread_data *threads;
528
Jens Axboe413dd452007-02-23 09:26:09 +0100529#define td_read(td) ((td)->td_ddir & TD_DDIR_READ)
530#define td_write(td) ((td)->td_ddir & TD_DDIR_WRITE)
531#define td_rw(td) (((td)->td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
532#define td_random(td) ((td)->td_ddir & TD_DDIR_RAND)
Jens Axboeebac4652005-12-08 15:25:21 +0100533
534#define BLOCKS_PER_MAP (8 * sizeof(long))
Jens Axboea00735e2006-11-03 08:58:08 +0100535#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->rw_min_bs))
Jens Axboe53cdc682006-10-18 11:50:58 +0200536#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
537#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
Jens Axboeebac4652005-12-08 15:25:21 +0100538
539#define MAX_JOBS (1024)
540
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200541static inline int should_fsync(struct thread_data *td)
542{
543 if (td->last_was_sync)
544 return 0;
545 if (td->odirect)
546 return 0;
547 if (td_write(td) || td_rw(td) || td->override_sync)
548 return 1;
549
550 return 0;
551}
552
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100553/*
554 * Disk utils as read in /sys/block/<dev>/stat
555 */
Jens Axboeebac4652005-12-08 15:25:21 +0100556struct disk_util_stat {
557 unsigned ios[2];
558 unsigned merges[2];
559 unsigned long long sectors[2];
560 unsigned ticks[2];
561 unsigned io_ticks;
562 unsigned time_in_queue;
563};
564
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100565/*
566 * Per-device disk util management
567 */
Jens Axboeebac4652005-12-08 15:25:21 +0100568struct disk_util {
569 struct list_head list;
570
571 char *name;
572 char path[256];
573 dev_t dev;
574
575 struct disk_util_stat dus;
576 struct disk_util_stat last_dus;
577
578 unsigned long msec;
579 struct timeval time;
580};
581
Jens Axboeebac4652005-12-08 15:25:21 +0100582#define DISK_UTIL_MSEC (250)
583
Jens Axboe6a0106a2006-05-05 10:34:43 +0200584#ifndef min
585#define min(a, b) ((a) < (b) ? (a) : (b))
586#endif
Jens Axboea00735e2006-11-03 08:58:08 +0100587#ifndef max
588#define max(a, b) ((a) > (b) ? (a) : (b))
589#endif
Jens Axboe6a0106a2006-05-05 10:34:43 +0200590
Jens Axboe67962092006-06-07 08:45:01 +0200591/*
592 * Log exports
593 */
Jens Axboe72cb9712007-02-20 20:54:45 +0100594extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
Jens Axboe67962092006-06-07 08:45:01 +0200595extern void write_iolog_put(struct thread_data *, struct io_u *);
Jens Axboe72cb9712007-02-20 20:54:45 +0100596extern int __must_check init_iolog(struct thread_data *td);
Jens Axboe67962092006-06-07 08:45:01 +0200597extern void log_io_piece(struct thread_data *, struct io_u *);
598extern void prune_io_piece_log(struct thread_data *);
599extern void write_iolog_close(struct thread_data *);
600
601/*
602 * Logging
603 */
Jens Axboe1e97cce2006-12-05 11:44:16 +0100604extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
605extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
606extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
Jens Axboe67962092006-06-07 08:45:01 +0200607extern void show_run_stats(void);
608extern void init_disk_util(struct thread_data *);
609extern void update_rusage_stat(struct thread_data *);
610extern void update_io_ticks(void);
611extern void disk_util_timer_arm(void);
Jens Axboe8914a9d2006-06-07 11:14:56 +0200612extern void setup_log(struct io_log **);
613extern void finish_log(struct thread_data *, struct io_log *, const char *);
Jens Axboebb3884d2007-01-17 17:23:11 +1100614extern void __finish_log(struct io_log *, const char *);
Jens Axboe8914a9d2006-06-07 11:14:56 +0200615extern int setup_rate(struct thread_data *);
Jens Axboebb3884d2007-01-17 17:23:11 +1100616extern struct io_log *agg_io_log[2];
617extern int write_bw_log;
618extern void add_agg_sample(unsigned long, enum fio_ddir);
Jens Axboe67962092006-06-07 08:45:01 +0200619
620/*
621 * Time functions
622 */
623extern unsigned long utime_since(struct timeval *, struct timeval *);
Jens Axboe69008992006-11-24 13:12:56 +0100624extern unsigned long utime_since_now(struct timeval *);
Jens Axboe67962092006-06-07 08:45:01 +0200625extern unsigned long mtime_since(struct timeval *, struct timeval *);
626extern unsigned long mtime_since_now(struct timeval *);
627extern unsigned long time_since_now(struct timeval *);
Jens Axboe263e5292006-10-18 15:37:01 +0200628extern unsigned long mtime_since_genesis(void);
Jens Axboeb990b5c2006-09-14 09:48:22 +0200629extern void __usec_sleep(unsigned int);
Jens Axboe67962092006-06-07 08:45:01 +0200630extern void usec_sleep(struct thread_data *, unsigned long);
Jens Axboe413dd452007-02-23 09:26:09 +0100631extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
Jens Axboe6043c572006-11-03 11:37:47 +0100632extern void fill_start_time(struct timeval *);
Jens Axboe02bcaa82006-11-24 10:42:00 +0100633extern void fio_gettime(struct timeval *, void *);
Jens Axboea2f77c92007-02-22 11:53:00 +0100634extern void set_genesis_time(void);
Jens Axboe67962092006-06-07 08:45:01 +0200635
Jens Axboe8914a9d2006-06-07 11:14:56 +0200636/*
637 * Init functions
638 */
Jens Axboe72cb9712007-02-20 20:54:45 +0100639extern int __must_check parse_options(int, char **);
640extern int __must_check init_random_state(struct thread_data *);
Jens Axboe8914a9d2006-06-07 11:14:56 +0200641
Jens Axboebbfd6b02006-06-07 19:42:54 +0200642/*
Jens Axboe53cdc682006-10-18 11:50:58 +0200643 * File setup/shutdown
644 */
645extern void close_files(struct thread_data *);
Jens Axboeb2fdda42007-02-20 20:52:51 +0100646extern int __must_check setup_files(struct thread_data *);
647extern int __must_check open_files(struct thread_data *);
648extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
Jens Axboeb5af8292007-03-08 12:43:13 +0100649extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
650extern void generic_close_file(struct thread_data *, struct fio_file *);
Jens Axboe53cdc682006-10-18 11:50:58 +0200651
652/*
Jens Axboe263e5292006-10-18 15:37:01 +0200653 * ETA/status stuff
654 */
655extern void print_thread_status(void);
656extern void print_status_init(int);
657
658/*
659 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
660 * will never back again. It may cycle between running/verififying/fsyncing.
661 * Once the thread reaches TD_EXITED, it is just waiting for the core to
662 * reap it.
663 */
664enum {
665 TD_NOT_CREATED = 0,
666 TD_CREATED,
667 TD_INITIALIZED,
668 TD_RUNNING,
669 TD_VERIFYING,
670 TD_FSYNCING,
671 TD_EXITED,
672 TD_REAPED,
673};
674
675/*
Jens Axboee29d1b72006-10-18 15:43:15 +0200676 * Verify helpers
677 */
678extern void populate_verify_io_u(struct thread_data *, struct io_u *);
Jens Axboeb2fdda42007-02-20 20:52:51 +0100679extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
680extern int __must_check verify_io_u(struct io_u *);
Jens Axboee29d1b72006-10-18 15:43:15 +0200681
682/*
Jens Axboe2f9ade32006-10-20 11:25:52 +0200683 * Memory helpers
684 */
Jens Axboeb2fdda42007-02-20 20:52:51 +0100685extern int __must_check fio_pin_memory(void);
Jens Axboe2f9ade32006-10-20 11:25:52 +0200686extern void fio_unpin_memory(void);
Jens Axboeb2fdda42007-02-20 20:52:51 +0100687extern int __must_check allocate_io_mem(struct thread_data *);
Jens Axboe2f9ade32006-10-20 11:25:52 +0200688extern void free_io_mem(struct thread_data *);
689
690/*
Jens Axboe10ba5352006-10-20 11:39:27 +0200691 * io unit handling
692 */
693#define queue_full(td) list_empty(&(td)->io_u_freelist)
694extern struct io_u *__get_io_u(struct thread_data *);
Jens Axboe3d7c3912007-02-19 13:16:12 +0100695extern struct io_u *get_io_u(struct thread_data *);
Jens Axboe10ba5352006-10-20 11:39:27 +0200696extern void put_io_u(struct thread_data *, struct io_u *);
Jens Axboe755200a2007-02-19 13:08:12 +0100697extern void requeue_io_u(struct thread_data *, struct io_u **);
Jens Axboed7762cf2007-02-23 12:34:57 +0100698extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
699extern long __must_check io_u_queued_complete(struct thread_data *, int);
Jens Axboe7e77dd02007-02-20 10:57:34 +0100700extern void io_u_queued(struct thread_data *, struct io_u *);
Jens Axboe54517922007-03-05 10:06:06 +0100701extern void io_u_log_error(struct thread_data *, struct io_u *);
Jens Axboe433afcb2007-02-22 10:39:01 +0100702extern void io_u_init_timeout(void);
703extern void io_u_set_timeout(struct thread_data *);
Jens Axboeb3605062007-03-12 14:19:47 +0100704extern void io_u_mark_depth(struct thread_data *, struct io_u *);
Jens Axboe10ba5352006-10-20 11:39:27 +0200705
706/*
707 * io engine entry points
708 */
Jens Axboeb2fdda42007-02-20 20:52:51 +0100709extern int __must_check td_io_init(struct thread_data *);
710extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
711extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
712extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
713extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
714extern int __must_check td_io_commit(struct thread_data *);
Jens Axboeb5af8292007-03-08 12:43:13 +0100715extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
716extern void td_io_close_file(struct thread_data *, struct fio_file *);
Jens Axboe10ba5352006-10-20 11:39:27 +0200717
718/*
Jens Axboe3b70d7e2006-06-08 21:48:46 +0200719 * If logging output to a file, stderr should go to both stderr and f_err
720 */
721#define log_err(args...) do { \
722 fprintf(f_err, ##args); \
723 if (f_err != stderr) \
724 fprintf(stderr, ##args); \
725 } while (0)
726
Joel Becker9728ce32007-03-01 08:24:39 +0100727FILE *get_f_out(void);
728FILE *get_f_err(void);
729
Jens Axboe2866c822006-10-09 15:57:48 +0200730struct ioengine_ops {
Jens Axboe5f350952006-11-07 15:20:59 +0100731 struct list_head list;
Jens Axboe2866c822006-10-09 15:57:48 +0200732 char name[16];
733 int version;
734 int flags;
Jens Axboeea2877a2006-10-10 08:30:24 +0200735 int (*setup)(struct thread_data *);
Jens Axboe2866c822006-10-09 15:57:48 +0200736 int (*init)(struct thread_data *);
737 int (*prep)(struct thread_data *, struct io_u *);
738 int (*queue)(struct thread_data *, struct io_u *);
Jens Axboe755200a2007-02-19 13:08:12 +0100739 int (*commit)(struct thread_data *);
Jens Axboe2866c822006-10-09 15:57:48 +0200740 int (*getevents)(struct thread_data *, int, int, struct timespec *);
741 struct io_u *(*event)(struct thread_data *, int);
742 int (*cancel)(struct thread_data *, struct io_u *);
743 void (*cleanup)(struct thread_data *);
Jens Axboeb5af8292007-03-08 12:43:13 +0100744 int (*open_file)(struct thread_data *, struct fio_file *);
745 void (*close_file)(struct thread_data *, struct fio_file *);
Jens Axboe2866c822006-10-09 15:57:48 +0200746 void *data;
747 void *dlhandle;
748};
749
Jens Axboeb5af8292007-03-08 12:43:13 +0100750#define FIO_IOOPS_VERSION 6
Jens Axboe2866c822006-10-09 15:57:48 +0200751
Jens Axboeb4692822006-10-27 13:43:22 +0200752extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
Jens Axboeb2fdda42007-02-20 20:52:51 +0100753extern void register_ioengine(struct ioengine_ops *);
Jens Axboe5f350952006-11-07 15:20:59 +0100754extern void unregister_ioengine(struct ioengine_ops *);
Jens Axboe2866c822006-10-09 15:57:48 +0200755extern void close_ioengine(struct thread_data *);
756
757/*
758 * Mark unused variables passed to ops functions as unused, to silence gcc
759 */
760#define fio_unused __attribute((__unused__))
Jens Axboe5f350952006-11-07 15:20:59 +0100761#define fio_init __attribute__((constructor))
762#define fio_exit __attribute__((destructor))
Jens Axboe2866c822006-10-09 15:57:48 +0200763
Jens Axboe34572e22006-10-20 09:33:18 +0200764#define for_each_td(td, i) \
765 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
Jens Axboe53cdc682006-10-18 11:50:58 +0200766#define for_each_file(td, f, i) \
Jens Axboeb5af8292007-03-08 12:43:13 +0100767 for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->open_files; (i)++, (f)++)
Jens Axboe53cdc682006-10-18 11:50:58 +0200768
Jens Axboe0032bf92007-02-13 17:39:56 +0100769#define fio_assert(td, cond) do { \
770 if (!(cond)) { \
Jens Axboe340fd242007-02-13 20:09:10 +0100771 int *__foo = NULL; \
Jens Axboe0032bf92007-02-13 17:39:56 +0100772 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
773 (td)->runstate = TD_EXITED; \
Jens Axboe437c9b72007-02-13 18:20:37 +0100774 (td)->error = EFAULT; \
Jens Axboe340fd242007-02-13 20:09:10 +0100775 *__foo = 0; \
Jens Axboe0032bf92007-02-13 17:39:56 +0100776 } \
777} while (0)
778
Jens Axboeebac4652005-12-08 15:25:21 +0100779#endif