blob: b087f97285f0a7b7682538cc1d76c34846a3cc1e [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"
20
Jens Axboeb6959b52007-02-14 21:40:27 +000021#ifdef FIO_HAVE_SYSLET
Jens Axboea4f4fdd2007-02-14 01:16:39 +010022#include "syslet.h"
Jens Axboeb6959b52007-02-14 21:40:27 +000023#endif
Jens Axboea4f4fdd2007-02-14 01:16:39 +010024
Jens Axboe1e97cce2006-12-05 11:44:16 +010025enum fio_ddir {
26 DDIR_READ = 0,
27 DDIR_WRITE,
28 DDIR_SYNC,
29};
30
Jens Axboe1c9e06e2007-02-11 04:07:57 +010031/*
32 * Use for maintaining statistics
33 */
Jens Axboeebac4652005-12-08 15:25:21 +010034struct io_stat {
Jens Axboeebac4652005-12-08 15:25:21 +010035 unsigned long max_val;
36 unsigned long min_val;
37 unsigned long samples;
Jens Axboe68704082007-01-10 19:56:37 +010038
39 double mean;
40 double S;
Jens Axboeebac4652005-12-08 15:25:21 +010041};
42
Jens Axboe1c9e06e2007-02-11 04:07:57 +010043/*
44 * A single data sample
45 */
Jens Axboeebac4652005-12-08 15:25:21 +010046struct io_sample {
47 unsigned long time;
48 unsigned long val;
Jens Axboe1e97cce2006-12-05 11:44:16 +010049 enum fio_ddir ddir;
Jens Axboeebac4652005-12-08 15:25:21 +010050};
51
Jens Axboe1c9e06e2007-02-11 04:07:57 +010052/*
53 * Dynamically growing data sample log
54 */
Jens Axboeebac4652005-12-08 15:25:21 +010055struct io_log {
56 unsigned long nr_samples;
57 unsigned long max_samples;
58 struct io_sample *log;
59};
60
Jens Axboe1c9e06e2007-02-11 04:07:57 +010061/*
62 * When logging io actions, this matches a single sent io_u
63 */
Jens Axboeebac4652005-12-08 15:25:21 +010064struct io_piece {
65 struct list_head list;
Jens Axboe53cdc682006-10-18 11:50:58 +020066 struct fio_file *file;
Jens Axboeebac4652005-12-08 15:25:21 +010067 unsigned long long offset;
Jens Axboea4f4fdd2007-02-14 01:16:39 +010068 unsigned long len;
Jens Axboe1e97cce2006-12-05 11:44:16 +010069 enum fio_ddir ddir;
Jens Axboeebac4652005-12-08 15:25:21 +010070};
71
Jens Axboea4f4fdd2007-02-14 01:16:39 +010072#ifdef FIO_HAVE_SYSLET
73struct syslet_req {
74 struct syslet_uatom atom;
Jens Axboea4f4fdd2007-02-14 01:16:39 +010075 long ret;
76};
77#endif
78
Jens Axboeebac4652005-12-08 15:25:21 +010079/*
80 * The io unit
81 */
82struct io_u {
83 union {
84#ifdef FIO_HAVE_LIBAIO
85 struct iocb iocb;
86#endif
87#ifdef FIO_HAVE_POSIXAIO
88 struct aiocb aiocb;
89#endif
90#ifdef FIO_HAVE_SGIO
91 struct sg_io_hdr hdr;
92#endif
Jens Axboea4f4fdd2007-02-14 01:16:39 +010093#ifdef FIO_HAVE_SYSLET
Jens Axboea2e1b082007-02-14 08:06:19 +010094 struct syslet_req req;
Jens Axboea4f4fdd2007-02-14 01:16:39 +010095#endif
Jens Axboeebac4652005-12-08 15:25:21 +010096 };
97 struct timeval start_time;
98 struct timeval issue_time;
99
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100100 /*
101 * Allocated/set buffer and length
102 */
Jens Axboe6b9cea22006-10-30 17:00:24 +0100103 void *buf;
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100104 unsigned long buflen;
Jens Axboeebac4652005-12-08 15:25:21 +0100105 unsigned long long offset;
106
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100107 /*
108 * IO engine state, may be different from above when we get
109 * partial transfers / residual data counts
110 */
Jens Axboecec6b552007-02-06 20:15:38 +0100111 void *xfer_buf;
Jens Axboea4f4fdd2007-02-14 01:16:39 +0100112 unsigned long xfer_buflen;
Jens Axboecec6b552007-02-06 20:15:38 +0100113
Jens Axboeebac4652005-12-08 15:25:21 +0100114 unsigned int resid;
115 unsigned int error;
116
Jens Axboe1e97cce2006-12-05 11:44:16 +0100117 enum fio_ddir ddir;
Jens Axboeebac4652005-12-08 15:25:21 +0100118
Jens Axboedfd7bc22006-10-24 12:17:57 +0200119 /*
120 * io engine private data
121 */
122 union {
123 unsigned int index;
124 unsigned int seen;
125 };
126
Jens Axboe53cdc682006-10-18 11:50:58 +0200127 struct fio_file *file;
128
Jens Axboeebac4652005-12-08 15:25:21 +0100129 struct list_head list;
130};
131
Jens Axboe36167d82007-02-18 05:41:31 +0100132/*
133 * io_ops->queue() return values
134 */
135enum {
136 FIO_Q_COMPLETED = 0, /* completed sync */
137 FIO_Q_QUEUED = 1, /* queued, will complete async */
138};
139
Jens Axboeebac4652005-12-08 15:25:21 +0100140#define FIO_HDR_MAGIC 0xf00baaef
141
142enum {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100143 VERIFY_NONE = 0, /* no verification */
144 VERIFY_MD5, /* md5 sum data blocks */
145 VERIFY_CRC32, /* crc32 sum data blocks */
Jens Axboeebac4652005-12-08 15:25:21 +0100146};
147
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100148/*
149 * A header structure associated with each checksummed data block
150 */
Jens Axboeebac4652005-12-08 15:25:21 +0100151struct verify_header {
152 unsigned int fio_magic;
153 unsigned int len;
154 unsigned int verify_type;
155 union {
156 char md5_digest[MD5_HASH_WORDS * 4];
157 unsigned long crc32;
158 };
159};
160
161struct group_run_stats {
Jens Axboe9104f872005-12-28 23:50:45 +0100162 unsigned long long max_run[2], min_run[2];
163 unsigned long long max_bw[2], min_bw[2];
Jens Axboee9b2a3f2006-06-06 15:38:33 +0200164 unsigned long long io_kb[2];
Jens Axboe9104f872005-12-28 23:50:45 +0100165 unsigned long long agg[2];
Jens Axboeebac4652005-12-08 15:25:21 +0100166};
167
Jens Axboee9c047a2006-06-07 21:13:04 +0200168/*
169 * What type of allocation to use for io buffers
170 */
171enum fio_memtype {
172 MEM_MALLOC = 0, /* ordinary malloc */
173 MEM_SHM, /* use shared memory segments */
Jens Axboe74b025b2006-12-19 15:18:14 +0100174 MEM_SHMHUGE, /* use shared memory segments with huge pages */
Jens Axboee9c047a2006-06-07 21:13:04 +0200175 MEM_MMAP, /* use anonynomous mmap */
Jens Axboed0bdaf42006-12-20 14:40:44 +0100176 MEM_MMAPHUGE, /* memory mapped huge file */
Jens Axboee9c047a2006-06-07 21:13:04 +0200177};
178
179/*
180 * The type of object we are working on
181 */
182enum fio_filetype {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100183 FIO_TYPE_FILE = 1, /* plain file */
184 FIO_TYPE_BD, /* block device */
185 FIO_TYPE_CHAR, /* character device */
Jens Axboee9c047a2006-06-07 21:13:04 +0200186};
187
Jens Axboe2866c822006-10-09 15:57:48 +0200188enum fio_ioengine_flags {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100189 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
190 FIO_CPUIO = 1 << 1, /* cpu burner, doesn't do real io */
191 FIO_MMAPIO = 1 << 2, /* uses memory mapped io */
192 FIO_RAWIO = 1 << 3, /* some sort of direct/raw io */
193 FIO_NETIO = 1 << 4, /* networked io */
194 FIO_NULLIO = 1 << 5, /* no real data transfer (cpu/null) */
Jens Axboee9c047a2006-06-07 21:13:04 +0200195};
196
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100197/*
198 * Each thread_data structure has a number of files associated with it,
199 * this structure holds state information for a single file.
200 */
Jens Axboe53cdc682006-10-18 11:50:58 +0200201struct fio_file {
202 /*
203 * A file may not be a file descriptor, let the io engine decide
204 */
205 union {
206 unsigned long file_data;
Jens Axboee26f8f72007-02-17 04:39:54 +0100207 int fd;
Jens Axboe53cdc682006-10-18 11:50:58 +0200208 };
209 char *file_name;
210 void *mmap;
211 unsigned long long file_size;
212 unsigned long long real_file_size;
213 unsigned long long file_offset;
214 unsigned long long last_pos;
Jens Axboe02bcaa82006-11-24 10:42:00 +0100215 unsigned long long last_completed_pos;
Jens Axboe53cdc682006-10-18 11:50:58 +0200216
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100217 /*
218 * block map for random io
219 */
Jens Axboe53cdc682006-10-18 11:50:58 +0200220 unsigned long *file_map;
221 unsigned int num_maps;
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100222 unsigned int last_free_lookup;
Jens Axboe9b031dc2006-12-15 16:01:54 +0100223
224 unsigned int unlink;
Jens Axboe53cdc682006-10-18 11:50:58 +0200225};
226
Jens Axboee9c047a2006-06-07 21:13:04 +0200227/*
Jens Axboe71619dc2007-01-13 23:56:33 +0100228 * How many depth levels to log
229 */
230#define FIO_IO_U_MAP_NR 8
Jens Axboeec118302007-02-17 04:38:20 +0100231#define FIO_IO_U_LAT_NR 12
Jens Axboe71619dc2007-01-13 23:56:33 +0100232
233/*
Jens Axboee9c047a2006-06-07 21:13:04 +0200234 * This describes a single thread/process executing a fio job.
235 */
Jens Axboeebac4652005-12-08 15:25:21 +0100236struct thread_data {
Jens Axboe61697c32007-02-05 15:04:46 +0100237 char *description;
Jens Axboeb4692822006-10-27 13:43:22 +0200238 char *name;
Jens Axboeef899b62006-06-06 09:31:00 +0200239 char *directory;
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200240 char *filename;
Jens Axboeebac4652005-12-08 15:25:21 +0100241 char verror[80];
242 pthread_t thread;
243 int thread_number;
244 int groupid;
Jens Axboee9c047a2006-06-07 21:13:04 +0200245 enum fio_filetype filetype;
Jens Axboe53cdc682006-10-18 11:50:58 +0200246 struct fio_file *files;
247 unsigned int nr_files;
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200248 unsigned int nr_uniq_files;
Jens Axboe53cdc682006-10-18 11:50:58 +0200249 unsigned int next_file;
Jens Axboeebac4652005-12-08 15:25:21 +0100250 int error;
Jens Axboeebac4652005-12-08 15:25:21 +0100251 pid_t pid;
252 char *orig_buffer;
253 size_t orig_buffer_size;
254 volatile int terminate;
255 volatile int runstate;
Jens Axboee9c047a2006-06-07 21:13:04 +0200256 enum fio_ddir ddir;
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200257 unsigned int iomix;
Jens Axboeebac4652005-12-08 15:25:21 +0100258 unsigned int ioprio;
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200259 unsigned int last_was_sync;
Jens Axboee9c047a2006-06-07 21:13:04 +0200260
Jens Axboe9158d2f2006-10-27 14:27:39 +0200261 unsigned int sequential;
262 unsigned int odirect;
263 unsigned int invalidate_cache;
264 unsigned int create_serialize;
265 unsigned int create_fsync;
266 unsigned int end_fsync;
267 unsigned int sync_io;
268 unsigned int verify;
269 unsigned int use_thread;
270 unsigned int unlink;
271 unsigned int do_disk_util;
272 unsigned int override_sync;
273 unsigned int rand_repeatable;
274 unsigned int write_lat_log;
275 unsigned int write_bw_log;
Jens Axboebb8895e2006-10-30 15:14:48 +0100276 unsigned int norandommap;
Jens Axboe690adba2006-10-30 15:25:09 +0100277 unsigned int bs_unaligned;
Jens Axboee9c047a2006-06-07 21:13:04 +0200278
Jens Axboea00735e2006-11-03 08:58:08 +0100279 unsigned int bs[2];
280 unsigned int min_bs[2];
281 unsigned int max_bs[2];
Jens Axboe56bb17f2006-12-20 20:27:36 +0100282 unsigned int hugepage_size;
Jens Axboea00735e2006-11-03 08:58:08 +0100283 unsigned int rw_min_bs;
Jens Axboeebac4652005-12-08 15:25:21 +0100284 unsigned int thinktime;
Jens Axboe48097d52007-02-17 06:30:44 +0100285 unsigned int thinktime_spin;
Jens Axboe9c1f7432007-01-03 20:43:19 +0100286 unsigned int thinktime_blocks;
Jens Axboeebac4652005-12-08 15:25:21 +0100287 unsigned int fsync_blocks;
288 unsigned int start_delay;
Jens Axboe906c8d72006-06-13 09:37:56 +0200289 unsigned long timeout;
Jens Axboeebac4652005-12-08 15:25:21 +0100290 unsigned int overwrite;
Jens Axboeebac4652005-12-08 15:25:21 +0100291 unsigned int bw_avg_time;
Jens Axboeebac4652005-12-08 15:25:21 +0100292 unsigned int loops;
Jens Axboe20dc95c2005-12-09 10:29:35 +0100293 unsigned long long zone_size;
294 unsigned long long zone_skip;
Jens Axboee9c047a2006-06-07 21:13:04 +0200295 enum fio_memtype mem_type;
Jens Axboe313cb202006-12-21 09:50:00 +0100296 char *mmapfile;
297 int mmapfd;
Jens Axboeebac4652005-12-08 15:25:21 +0100298 unsigned int stonewall;
299 unsigned int numjobs;
Jens Axboeebac4652005-12-08 15:25:21 +0100300 unsigned int iodepth;
301 os_cpu_mask_t cpumask;
Jens Axboeaea47d42006-05-26 19:27:29 +0200302 unsigned int iolog;
Jens Axboe843a7412006-06-01 21:14:21 -0700303 unsigned int read_iolog;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200304 unsigned int rwmixcycle;
305 unsigned int rwmixread;
Jens Axboee1f36502006-10-27 10:54:08 +0200306 unsigned int rwmixwrite;
Jens Axboeb6f4d882006-06-02 10:32:51 +0200307 unsigned int nice;
Jens Axboeaea47d42006-05-26 19:27:29 +0200308
Jens Axboe076efc72006-10-27 11:24:25 +0200309 char *read_iolog_file;
310 char *write_iolog_file;
Jens Axboe843a7412006-06-01 21:14:21 -0700311 void *iolog_buf;
312 FILE *iolog_f;
Jens Axboeebac4652005-12-08 15:25:21 +0100313
Jens Axboeda867742006-06-06 10:39:10 -0700314 char *sysfs_root;
Jens Axboeda867742006-06-06 10:39:10 -0700315 char *ioscheduler;
316
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200317 os_random_state_t bsrange_state;
318 os_random_state_t verify_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100319
320 int shm_id;
321
Jens Axboee9c047a2006-06-07 21:13:04 +0200322 /*
323 * IO engine hooks, contains everything needed to submit an io_u
324 * to any of the available IO engines.
325 */
Jens Axboe2866c822006-10-09 15:57:48 +0200326 struct ioengine_ops *io_ops;
Jens Axboeebac4652005-12-08 15:25:21 +0100327
Jens Axboee9c047a2006-06-07 21:13:04 +0200328 /*
329 * Current IO depth and list of free and busy io_u's.
330 */
Jens Axboeebac4652005-12-08 15:25:21 +0100331 unsigned int cur_depth;
Jens Axboe71619dc2007-01-13 23:56:33 +0100332 unsigned int io_u_map[FIO_IO_U_MAP_NR];
Jens Axboeec118302007-02-17 04:38:20 +0100333 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
Jens Axboe71619dc2007-01-13 23:56:33 +0100334 unsigned long total_io_u;
Jens Axboeebac4652005-12-08 15:25:21 +0100335 struct list_head io_u_freelist;
336 struct list_head io_u_busylist;
337
Jens Axboee9c047a2006-06-07 21:13:04 +0200338 /*
339 * Rate state
340 */
Jens Axboeebac4652005-12-08 15:25:21 +0100341 unsigned int rate;
342 unsigned int ratemin;
343 unsigned int ratecycle;
344 unsigned long rate_usec_cycle;
345 long rate_pending_usleep;
346 unsigned long rate_bytes;
347 struct timeval lastrate;
348
349 unsigned long runtime[2]; /* msec */
350 unsigned long long io_size;
Jens Axboe53cdc682006-10-18 11:50:58 +0200351 unsigned long long total_file_size;
352 unsigned long long start_offset;
Jens Axboeebac4652005-12-08 15:25:21 +0100353 unsigned long long total_io_size;
354
Jens Axboe9104f872005-12-28 23:50:45 +0100355 unsigned long long io_blocks[2];
356 unsigned long long io_bytes[2];
357 unsigned long long zone_bytes;
358 unsigned long long this_io_bytes[2];
Jens Axboebbfd6b02006-06-07 19:42:54 +0200359 volatile int mutex;
Jens Axboeebac4652005-12-08 15:25:21 +0100360
Jens Axboee9c047a2006-06-07 21:13:04 +0200361 /*
362 * State for random io, a bitmap of blocks done vs not done
363 */
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200364 os_random_state_t random_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100365
366 /*
Jens Axboeb990b5c2006-09-14 09:48:22 +0200367 * CPU "io" cycle burner
368 */
369 unsigned int cpuload;
370 unsigned int cpucycle;
371
372 /*
Jens Axboeebac4652005-12-08 15:25:21 +0100373 * bandwidth and latency stats
374 */
375 struct io_stat clat_stat[2]; /* completion latency */
376 struct io_stat slat_stat[2]; /* submission latency */
377 struct io_stat bw_stat[2]; /* bandwidth stats */
378
Jens Axboe9104f872005-12-28 23:50:45 +0100379 unsigned long long stat_io_bytes[2];
Jens Axboeebac4652005-12-08 15:25:21 +0100380 struct timeval stat_sample_time[2];
381
382 struct io_log *slat_log;
383 struct io_log *clat_log;
384 struct io_log *bw_log;
385
386 struct timeval start; /* start of this loop */
387 struct timeval epoch; /* time job was started */
Jens Axboe69008992006-11-24 13:12:56 +0100388 struct timeval end_time;/* time job ended */
Jens Axboeebac4652005-12-08 15:25:21 +0100389
Jens Axboee9c047a2006-06-07 21:13:04 +0200390 /*
391 * fio system usage accounting
392 */
Jens Axboeebac4652005-12-08 15:25:21 +0100393 struct rusage ru_start;
394 struct rusage ru_end;
395 unsigned long usr_time;
396 unsigned long sys_time;
397 unsigned long ctx;
398
Jens Axboee9c047a2006-06-07 21:13:04 +0200399 /*
400 * read/write mixed workload state
401 */
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200402 os_random_state_t rwmix_state;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200403 struct timeval rwmix_switch;
Jens Axboee9c047a2006-06-07 21:13:04 +0200404 enum fio_ddir rwmix_ddir;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200405
Jens Axboe4e0ba8a2006-06-06 09:36:28 +0200406 /*
407 * Pre-run and post-run shell
408 */
409 char *exec_prerun;
410 char *exec_postrun;
411
Jens Axboee9c047a2006-06-07 21:13:04 +0200412 /*
413 * IO historic logs
414 */
Jens Axboeebac4652005-12-08 15:25:21 +0100415 struct list_head io_hist_list;
Jens Axboeaea47d42006-05-26 19:27:29 +0200416 struct list_head io_log_list;
Jens Axboeebac4652005-12-08 15:25:21 +0100417};
418
Jens Axboeb990b5c2006-09-14 09:48:22 +0200419#define __td_verror(td, err, msg) \
Jens Axboeebac4652005-12-08 15:25:21 +0100420 do { \
421 int e = (err); \
422 (td)->error = e; \
Jens Axboeb990b5c2006-09-14 09:48:22 +0200423 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, (msg)); \
Jens Axboeebac4652005-12-08 15:25:21 +0100424 } while (0)
425
Jens Axboeb990b5c2006-09-14 09:48:22 +0200426
427#define td_verror(td, err) __td_verror((td), (err), strerror((err)))
428#define td_vmsg(td, err, msg) __td_verror((td), (err), (msg))
429
Jens Axboeebac4652005-12-08 15:25:21 +0100430extern int exitall_on_terminate;
431extern int thread_number;
432extern int shm_id;
433extern int groupid;
Jens Axboec6ae0a52006-06-12 11:04:44 +0200434extern int terse_output;
Jens Axboeeb8bbf42006-06-08 21:40:11 +0200435extern FILE *f_out;
436extern FILE *f_err;
Jens Axboe53cdc682006-10-18 11:50:58 +0200437extern int temp_stall_ts;
Jens Axboe1e97cce2006-12-05 11:44:16 +0100438extern unsigned long long mlock_size;
Jens Axboeebac4652005-12-08 15:25:21 +0100439
440extern struct thread_data *threads;
441
Jens Axboeebac4652005-12-08 15:25:21 +0100442#define td_read(td) ((td)->ddir == DDIR_READ)
443#define td_write(td) ((td)->ddir == DDIR_WRITE)
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200444#define td_rw(td) ((td)->iomix != 0)
Jens Axboeebac4652005-12-08 15:25:21 +0100445
446#define BLOCKS_PER_MAP (8 * sizeof(long))
Jens Axboea00735e2006-11-03 08:58:08 +0100447#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->rw_min_bs))
Jens Axboe53cdc682006-10-18 11:50:58 +0200448#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
449#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
Jens Axboeebac4652005-12-08 15:25:21 +0100450
451#define MAX_JOBS (1024)
452
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200453static inline int should_fsync(struct thread_data *td)
454{
455 if (td->last_was_sync)
456 return 0;
457 if (td->odirect)
458 return 0;
459 if (td_write(td) || td_rw(td) || td->override_sync)
460 return 1;
461
462 return 0;
463}
464
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100465/*
466 * Disk utils as read in /sys/block/<dev>/stat
467 */
Jens Axboeebac4652005-12-08 15:25:21 +0100468struct disk_util_stat {
469 unsigned ios[2];
470 unsigned merges[2];
471 unsigned long long sectors[2];
472 unsigned ticks[2];
473 unsigned io_ticks;
474 unsigned time_in_queue;
475};
476
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100477/*
478 * Per-device disk util management
479 */
Jens Axboeebac4652005-12-08 15:25:21 +0100480struct disk_util {
481 struct list_head list;
482
483 char *name;
484 char path[256];
485 dev_t dev;
486
487 struct disk_util_stat dus;
488 struct disk_util_stat last_dus;
489
490 unsigned long msec;
491 struct timeval time;
492};
493
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100494/*
495 * Used for passing io_u completion data
496 */
Jens Axboeebac4652005-12-08 15:25:21 +0100497struct io_completion_data {
498 int nr; /* input */
499
500 int error; /* output */
501 unsigned long bytes_done[2]; /* output */
Jens Axboe02bcaa82006-11-24 10:42:00 +0100502 struct timeval time; /* output */
Jens Axboeebac4652005-12-08 15:25:21 +0100503};
504
505#define DISK_UTIL_MSEC (250)
506
Jens Axboe6a0106a2006-05-05 10:34:43 +0200507#ifndef min
508#define min(a, b) ((a) < (b) ? (a) : (b))
509#endif
Jens Axboea00735e2006-11-03 08:58:08 +0100510#ifndef max
511#define max(a, b) ((a) > (b) ? (a) : (b))
512#endif
Jens Axboe6a0106a2006-05-05 10:34:43 +0200513
Jens Axboe67962092006-06-07 08:45:01 +0200514/*
515 * Log exports
516 */
517extern int read_iolog_get(struct thread_data *, struct io_u *);
518extern void write_iolog_put(struct thread_data *, struct io_u *);
519extern int init_iolog(struct thread_data *td);
520extern void log_io_piece(struct thread_data *, struct io_u *);
521extern void prune_io_piece_log(struct thread_data *);
522extern void write_iolog_close(struct thread_data *);
523
524/*
525 * Logging
526 */
Jens Axboe1e97cce2006-12-05 11:44:16 +0100527extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
528extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
529extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
Jens Axboe67962092006-06-07 08:45:01 +0200530extern void show_run_stats(void);
531extern void init_disk_util(struct thread_data *);
532extern void update_rusage_stat(struct thread_data *);
533extern void update_io_ticks(void);
534extern void disk_util_timer_arm(void);
Jens Axboe8914a9d2006-06-07 11:14:56 +0200535extern void setup_log(struct io_log **);
536extern void finish_log(struct thread_data *, struct io_log *, const char *);
Jens Axboebb3884d2007-01-17 17:23:11 +1100537extern void __finish_log(struct io_log *, const char *);
Jens Axboe8914a9d2006-06-07 11:14:56 +0200538extern int setup_rate(struct thread_data *);
Jens Axboebb3884d2007-01-17 17:23:11 +1100539extern struct io_log *agg_io_log[2];
540extern int write_bw_log;
541extern void add_agg_sample(unsigned long, enum fio_ddir);
Jens Axboe67962092006-06-07 08:45:01 +0200542
543/*
544 * Time functions
545 */
546extern unsigned long utime_since(struct timeval *, struct timeval *);
Jens Axboe69008992006-11-24 13:12:56 +0100547extern unsigned long utime_since_now(struct timeval *);
Jens Axboe67962092006-06-07 08:45:01 +0200548extern unsigned long mtime_since(struct timeval *, struct timeval *);
549extern unsigned long mtime_since_now(struct timeval *);
550extern unsigned long time_since_now(struct timeval *);
Jens Axboe263e5292006-10-18 15:37:01 +0200551extern unsigned long mtime_since_genesis(void);
Jens Axboeb990b5c2006-09-14 09:48:22 +0200552extern void __usec_sleep(unsigned int);
Jens Axboe67962092006-06-07 08:45:01 +0200553extern void usec_sleep(struct thread_data *, unsigned long);
Jens Axboea00735e2006-11-03 08:58:08 +0100554extern void rate_throttle(struct thread_data *, unsigned long, unsigned int, int);
Jens Axboe6043c572006-11-03 11:37:47 +0100555extern void fill_start_time(struct timeval *);
Jens Axboe02bcaa82006-11-24 10:42:00 +0100556extern void fio_gettime(struct timeval *, void *);
Jens Axboe67962092006-06-07 08:45:01 +0200557
Jens Axboe8914a9d2006-06-07 11:14:56 +0200558/*
559 * Init functions
560 */
561extern int parse_options(int, char **);
562extern int init_random_state(struct thread_data *);
563
Jens Axboebbfd6b02006-06-07 19:42:54 +0200564/*
Jens Axboe53cdc682006-10-18 11:50:58 +0200565 * File setup/shutdown
566 */
567extern void close_files(struct thread_data *);
568extern int setup_files(struct thread_data *);
Jens Axboe21972cd2006-11-23 12:39:16 +0100569extern int open_files(struct thread_data *);
Jens Axboee5b401d2006-10-18 16:03:40 +0200570extern int file_invalidate_cache(struct thread_data *, struct fio_file *);
Jens Axboe53cdc682006-10-18 11:50:58 +0200571
572/*
Jens Axboe263e5292006-10-18 15:37:01 +0200573 * ETA/status stuff
574 */
575extern void print_thread_status(void);
576extern void print_status_init(int);
577
578/*
579 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
580 * will never back again. It may cycle between running/verififying/fsyncing.
581 * Once the thread reaches TD_EXITED, it is just waiting for the core to
582 * reap it.
583 */
584enum {
585 TD_NOT_CREATED = 0,
586 TD_CREATED,
587 TD_INITIALIZED,
588 TD_RUNNING,
589 TD_VERIFYING,
590 TD_FSYNCING,
591 TD_EXITED,
592 TD_REAPED,
593};
594
595/*
Jens Axboee29d1b72006-10-18 15:43:15 +0200596 * Verify helpers
597 */
598extern void populate_verify_io_u(struct thread_data *, struct io_u *);
599extern int get_next_verify(struct thread_data *td, struct io_u *);
Jens Axboea9619d42006-10-18 15:47:42 +0200600extern int do_io_u_verify(struct thread_data *, struct io_u **);
Jens Axboee29d1b72006-10-18 15:43:15 +0200601
602/*
Jens Axboe2f9ade32006-10-20 11:25:52 +0200603 * Memory helpers
604 */
605extern int fio_pin_memory(void);
606extern void fio_unpin_memory(void);
607extern int allocate_io_mem(struct thread_data *);
608extern void free_io_mem(struct thread_data *);
609
610/*
Jens Axboe10ba5352006-10-20 11:39:27 +0200611 * io unit handling
612 */
613#define queue_full(td) list_empty(&(td)->io_u_freelist)
614extern struct io_u *__get_io_u(struct thread_data *);
615extern struct io_u *get_io_u(struct thread_data *, struct fio_file *);
616extern void put_io_u(struct thread_data *, struct io_u *);
617extern void ios_completed(struct thread_data *, struct io_completion_data *);
618extern void io_completed(struct thread_data *, struct io_u *, struct io_completion_data *);
Jens Axboe36167d82007-02-18 05:41:31 +0100619extern void init_icd(struct io_completion_data *);
Jens Axboe10ba5352006-10-20 11:39:27 +0200620
621/*
622 * io engine entry points
623 */
Jens Axboe8c16d842006-10-20 11:48:33 +0200624extern int td_io_init(struct thread_data *);
Jens Axboe10ba5352006-10-20 11:39:27 +0200625extern int td_io_prep(struct thread_data *, struct io_u *);
626extern int td_io_queue(struct thread_data *, struct io_u *);
627extern int td_io_sync(struct thread_data *, struct fio_file *);
628extern int td_io_getevents(struct thread_data *, int, int, struct timespec *);
629
630/*
Jens Axboebbfd6b02006-06-07 19:42:54 +0200631 * This is a pretty crappy semaphore implementation, but with the use that fio
632 * has (just signalling start/go conditions), it doesn't have to be better.
633 * Naturally this would not work for any type of contended semaphore or
634 * for real locking.
635 */
Jens Axboe1056eaa2006-07-13 10:33:45 -0700636static inline void fio_sem_init(volatile int *sem, int val)
Jens Axboebbfd6b02006-06-07 19:42:54 +0200637{
638 *sem = val;
639}
640
Jens Axboe1056eaa2006-07-13 10:33:45 -0700641static inline void fio_sem_down(volatile int *sem)
Jens Axboebbfd6b02006-06-07 19:42:54 +0200642{
643 while (*sem == 0)
644 usleep(10000);
645
646 (*sem)--;
647}
648
Jens Axboe1056eaa2006-07-13 10:33:45 -0700649static inline void fio_sem_up(volatile int *sem)
Jens Axboebbfd6b02006-06-07 19:42:54 +0200650{
651 (*sem)++;
652}
653
Jens Axboe3b70d7e2006-06-08 21:48:46 +0200654/*
655 * If logging output to a file, stderr should go to both stderr and f_err
656 */
657#define log_err(args...) do { \
658 fprintf(f_err, ##args); \
659 if (f_err != stderr) \
660 fprintf(stderr, ##args); \
661 } while (0)
662
Jens Axboe2866c822006-10-09 15:57:48 +0200663struct ioengine_ops {
Jens Axboe5f350952006-11-07 15:20:59 +0100664 struct list_head list;
Jens Axboe2866c822006-10-09 15:57:48 +0200665 char name[16];
666 int version;
667 int flags;
Jens Axboeea2877a2006-10-10 08:30:24 +0200668 int (*setup)(struct thread_data *);
Jens Axboe2866c822006-10-09 15:57:48 +0200669 int (*init)(struct thread_data *);
670 int (*prep)(struct thread_data *, struct io_u *);
671 int (*queue)(struct thread_data *, struct io_u *);
672 int (*getevents)(struct thread_data *, int, int, struct timespec *);
673 struct io_u *(*event)(struct thread_data *, int);
674 int (*cancel)(struct thread_data *, struct io_u *);
675 void (*cleanup)(struct thread_data *);
Jens Axboe2866c822006-10-09 15:57:48 +0200676 void *data;
677 void *dlhandle;
Jens Axboe36167d82007-02-18 05:41:31 +0100678 unsigned long priv;
Jens Axboe2866c822006-10-09 15:57:48 +0200679};
680
Jens Axboe36167d82007-02-18 05:41:31 +0100681#define FIO_IOOPS_VERSION 4
Jens Axboe2866c822006-10-09 15:57:48 +0200682
Jens Axboeb4692822006-10-27 13:43:22 +0200683extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
Jens Axboe5f350952006-11-07 15:20:59 +0100684extern int register_ioengine(struct ioengine_ops *);
685extern void unregister_ioengine(struct ioengine_ops *);
Jens Axboe2866c822006-10-09 15:57:48 +0200686extern void close_ioengine(struct thread_data *);
687
688/*
689 * Mark unused variables passed to ops functions as unused, to silence gcc
690 */
691#define fio_unused __attribute((__unused__))
Jens Axboe5f350952006-11-07 15:20:59 +0100692#define fio_init __attribute__((constructor))
693#define fio_exit __attribute__((destructor))
Jens Axboe2866c822006-10-09 15:57:48 +0200694
Jens Axboe34572e22006-10-20 09:33:18 +0200695#define for_each_td(td, i) \
696 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
Jens Axboe53cdc682006-10-18 11:50:58 +0200697#define for_each_file(td, f, i) \
Jens Axboe34572e22006-10-20 09:33:18 +0200698 for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)
Jens Axboe53cdc682006-10-18 11:50:58 +0200699
Jens Axboe0032bf92007-02-13 17:39:56 +0100700#define fio_assert(td, cond) do { \
701 if (!(cond)) { \
Jens Axboe340fd242007-02-13 20:09:10 +0100702 int *__foo = NULL; \
Jens Axboe0032bf92007-02-13 17:39:56 +0100703 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
704 (td)->runstate = TD_EXITED; \
Jens Axboe437c9b72007-02-13 18:20:37 +0100705 (td)->error = EFAULT; \
Jens Axboe340fd242007-02-13 20:09:10 +0100706 *__foo = 0; \
Jens Axboe0032bf92007-02-13 17:39:56 +0100707 } \
708} while (0)
709
Jens Axboeebac4652005-12-08 15:25:21 +0100710#endif