blob: 67cc06529cd8fcab52375b3969bfdc4084ed0584 [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
132#define FIO_HDR_MAGIC 0xf00baaef
133
134enum {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100135 VERIFY_NONE = 0, /* no verification */
136 VERIFY_MD5, /* md5 sum data blocks */
137 VERIFY_CRC32, /* crc32 sum data blocks */
Jens Axboeebac4652005-12-08 15:25:21 +0100138};
139
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100140/*
141 * A header structure associated with each checksummed data block
142 */
Jens Axboeebac4652005-12-08 15:25:21 +0100143struct verify_header {
144 unsigned int fio_magic;
145 unsigned int len;
146 unsigned int verify_type;
147 union {
148 char md5_digest[MD5_HASH_WORDS * 4];
149 unsigned long crc32;
150 };
151};
152
153struct group_run_stats {
Jens Axboe9104f872005-12-28 23:50:45 +0100154 unsigned long long max_run[2], min_run[2];
155 unsigned long long max_bw[2], min_bw[2];
Jens Axboee9b2a3f2006-06-06 15:38:33 +0200156 unsigned long long io_kb[2];
Jens Axboe9104f872005-12-28 23:50:45 +0100157 unsigned long long agg[2];
Jens Axboeebac4652005-12-08 15:25:21 +0100158};
159
Jens Axboee9c047a2006-06-07 21:13:04 +0200160/*
161 * What type of allocation to use for io buffers
162 */
163enum fio_memtype {
164 MEM_MALLOC = 0, /* ordinary malloc */
165 MEM_SHM, /* use shared memory segments */
Jens Axboe74b025b2006-12-19 15:18:14 +0100166 MEM_SHMHUGE, /* use shared memory segments with huge pages */
Jens Axboee9c047a2006-06-07 21:13:04 +0200167 MEM_MMAP, /* use anonynomous mmap */
Jens Axboed0bdaf42006-12-20 14:40:44 +0100168 MEM_MMAPHUGE, /* memory mapped huge file */
Jens Axboee9c047a2006-06-07 21:13:04 +0200169};
170
171/*
172 * The type of object we are working on
173 */
174enum fio_filetype {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100175 FIO_TYPE_FILE = 1, /* plain file */
176 FIO_TYPE_BD, /* block device */
177 FIO_TYPE_CHAR, /* character device */
Jens Axboee9c047a2006-06-07 21:13:04 +0200178};
179
Jens Axboe2866c822006-10-09 15:57:48 +0200180enum fio_ioengine_flags {
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100181 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
182 FIO_CPUIO = 1 << 1, /* cpu burner, doesn't do real io */
183 FIO_MMAPIO = 1 << 2, /* uses memory mapped io */
184 FIO_RAWIO = 1 << 3, /* some sort of direct/raw io */
185 FIO_NETIO = 1 << 4, /* networked io */
186 FIO_NULLIO = 1 << 5, /* no real data transfer (cpu/null) */
Jens Axboee9c047a2006-06-07 21:13:04 +0200187};
188
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100189/*
190 * Each thread_data structure has a number of files associated with it,
191 * this structure holds state information for a single file.
192 */
Jens Axboe53cdc682006-10-18 11:50:58 +0200193struct fio_file {
194 /*
195 * A file may not be a file descriptor, let the io engine decide
196 */
197 union {
198 unsigned long file_data;
Jens Axboee26f8f72007-02-17 04:39:54 +0100199 int fd;
Jens Axboe53cdc682006-10-18 11:50:58 +0200200 };
201 char *file_name;
202 void *mmap;
203 unsigned long long file_size;
204 unsigned long long real_file_size;
205 unsigned long long file_offset;
206 unsigned long long last_pos;
Jens Axboe02bcaa82006-11-24 10:42:00 +0100207 unsigned long long last_completed_pos;
Jens Axboe53cdc682006-10-18 11:50:58 +0200208
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100209 /*
210 * block map for random io
211 */
Jens Axboe53cdc682006-10-18 11:50:58 +0200212 unsigned long *file_map;
213 unsigned int num_maps;
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100214 unsigned int last_free_lookup;
Jens Axboe9b031dc2006-12-15 16:01:54 +0100215
216 unsigned int unlink;
Jens Axboe53cdc682006-10-18 11:50:58 +0200217};
218
Jens Axboee9c047a2006-06-07 21:13:04 +0200219/*
Jens Axboe71619dc2007-01-13 23:56:33 +0100220 * How many depth levels to log
221 */
222#define FIO_IO_U_MAP_NR 8
Jens Axboeec118302007-02-17 04:38:20 +0100223#define FIO_IO_U_LAT_NR 12
Jens Axboe71619dc2007-01-13 23:56:33 +0100224
225/*
Jens Axboee9c047a2006-06-07 21:13:04 +0200226 * This describes a single thread/process executing a fio job.
227 */
Jens Axboeebac4652005-12-08 15:25:21 +0100228struct thread_data {
Jens Axboe61697c32007-02-05 15:04:46 +0100229 char *description;
Jens Axboeb4692822006-10-27 13:43:22 +0200230 char *name;
Jens Axboeef899b62006-06-06 09:31:00 +0200231 char *directory;
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200232 char *filename;
Jens Axboeebac4652005-12-08 15:25:21 +0100233 char verror[80];
234 pthread_t thread;
235 int thread_number;
236 int groupid;
Jens Axboee9c047a2006-06-07 21:13:04 +0200237 enum fio_filetype filetype;
Jens Axboe53cdc682006-10-18 11:50:58 +0200238 struct fio_file *files;
239 unsigned int nr_files;
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200240 unsigned int nr_uniq_files;
Jens Axboe53cdc682006-10-18 11:50:58 +0200241 unsigned int next_file;
Jens Axboeebac4652005-12-08 15:25:21 +0100242 int error;
Jens Axboeebac4652005-12-08 15:25:21 +0100243 pid_t pid;
244 char *orig_buffer;
245 size_t orig_buffer_size;
246 volatile int terminate;
247 volatile int runstate;
Jens Axboee9c047a2006-06-07 21:13:04 +0200248 enum fio_ddir ddir;
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200249 unsigned int iomix;
Jens Axboeebac4652005-12-08 15:25:21 +0100250 unsigned int ioprio;
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200251 unsigned int last_was_sync;
Jens Axboee9c047a2006-06-07 21:13:04 +0200252
Jens Axboe9158d2f2006-10-27 14:27:39 +0200253 unsigned int sequential;
254 unsigned int odirect;
255 unsigned int invalidate_cache;
256 unsigned int create_serialize;
257 unsigned int create_fsync;
258 unsigned int end_fsync;
259 unsigned int sync_io;
260 unsigned int verify;
261 unsigned int use_thread;
262 unsigned int unlink;
263 unsigned int do_disk_util;
264 unsigned int override_sync;
265 unsigned int rand_repeatable;
266 unsigned int write_lat_log;
267 unsigned int write_bw_log;
Jens Axboebb8895e2006-10-30 15:14:48 +0100268 unsigned int norandommap;
Jens Axboe690adba2006-10-30 15:25:09 +0100269 unsigned int bs_unaligned;
Jens Axboee9c047a2006-06-07 21:13:04 +0200270
Jens Axboea00735e2006-11-03 08:58:08 +0100271 unsigned int bs[2];
272 unsigned int min_bs[2];
273 unsigned int max_bs[2];
Jens Axboe56bb17f2006-12-20 20:27:36 +0100274 unsigned int hugepage_size;
Jens Axboea00735e2006-11-03 08:58:08 +0100275 unsigned int rw_min_bs;
Jens Axboeebac4652005-12-08 15:25:21 +0100276 unsigned int thinktime;
Jens Axboe9c1f7432007-01-03 20:43:19 +0100277 unsigned int thinktime_blocks;
Jens Axboeebac4652005-12-08 15:25:21 +0100278 unsigned int fsync_blocks;
279 unsigned int start_delay;
Jens Axboe906c8d72006-06-13 09:37:56 +0200280 unsigned long timeout;
Jens Axboeebac4652005-12-08 15:25:21 +0100281 unsigned int overwrite;
Jens Axboeebac4652005-12-08 15:25:21 +0100282 unsigned int bw_avg_time;
Jens Axboeebac4652005-12-08 15:25:21 +0100283 unsigned int loops;
Jens Axboe20dc95c2005-12-09 10:29:35 +0100284 unsigned long long zone_size;
285 unsigned long long zone_skip;
Jens Axboee9c047a2006-06-07 21:13:04 +0200286 enum fio_memtype mem_type;
Jens Axboe313cb202006-12-21 09:50:00 +0100287 char *mmapfile;
288 int mmapfd;
Jens Axboeebac4652005-12-08 15:25:21 +0100289 unsigned int stonewall;
290 unsigned int numjobs;
Jens Axboeebac4652005-12-08 15:25:21 +0100291 unsigned int iodepth;
292 os_cpu_mask_t cpumask;
Jens Axboeaea47d42006-05-26 19:27:29 +0200293 unsigned int iolog;
Jens Axboe843a7412006-06-01 21:14:21 -0700294 unsigned int read_iolog;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200295 unsigned int rwmixcycle;
296 unsigned int rwmixread;
Jens Axboee1f36502006-10-27 10:54:08 +0200297 unsigned int rwmixwrite;
Jens Axboeb6f4d882006-06-02 10:32:51 +0200298 unsigned int nice;
Jens Axboeaea47d42006-05-26 19:27:29 +0200299
Jens Axboe076efc72006-10-27 11:24:25 +0200300 char *read_iolog_file;
301 char *write_iolog_file;
Jens Axboe843a7412006-06-01 21:14:21 -0700302 void *iolog_buf;
303 FILE *iolog_f;
Jens Axboeebac4652005-12-08 15:25:21 +0100304
Jens Axboeda867742006-06-06 10:39:10 -0700305 char *sysfs_root;
Jens Axboeda867742006-06-06 10:39:10 -0700306 char *ioscheduler;
307
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200308 os_random_state_t bsrange_state;
309 os_random_state_t verify_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100310
311 int shm_id;
312
Jens Axboee9c047a2006-06-07 21:13:04 +0200313 /*
314 * IO engine hooks, contains everything needed to submit an io_u
315 * to any of the available IO engines.
316 */
Jens Axboe2866c822006-10-09 15:57:48 +0200317 struct ioengine_ops *io_ops;
Jens Axboeebac4652005-12-08 15:25:21 +0100318
Jens Axboee9c047a2006-06-07 21:13:04 +0200319 /*
320 * Current IO depth and list of free and busy io_u's.
321 */
Jens Axboeebac4652005-12-08 15:25:21 +0100322 unsigned int cur_depth;
Jens Axboe71619dc2007-01-13 23:56:33 +0100323 unsigned int io_u_map[FIO_IO_U_MAP_NR];
Jens Axboeec118302007-02-17 04:38:20 +0100324 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
Jens Axboe71619dc2007-01-13 23:56:33 +0100325 unsigned long total_io_u;
Jens Axboeebac4652005-12-08 15:25:21 +0100326 struct list_head io_u_freelist;
327 struct list_head io_u_busylist;
328
Jens Axboee9c047a2006-06-07 21:13:04 +0200329 /*
330 * Rate state
331 */
Jens Axboeebac4652005-12-08 15:25:21 +0100332 unsigned int rate;
333 unsigned int ratemin;
334 unsigned int ratecycle;
335 unsigned long rate_usec_cycle;
336 long rate_pending_usleep;
337 unsigned long rate_bytes;
338 struct timeval lastrate;
339
340 unsigned long runtime[2]; /* msec */
341 unsigned long long io_size;
Jens Axboe53cdc682006-10-18 11:50:58 +0200342 unsigned long long total_file_size;
343 unsigned long long start_offset;
Jens Axboeebac4652005-12-08 15:25:21 +0100344 unsigned long long total_io_size;
345
Jens Axboe9104f872005-12-28 23:50:45 +0100346 unsigned long long io_blocks[2];
347 unsigned long long io_bytes[2];
348 unsigned long long zone_bytes;
349 unsigned long long this_io_bytes[2];
Jens Axboebbfd6b02006-06-07 19:42:54 +0200350 volatile int mutex;
Jens Axboeebac4652005-12-08 15:25:21 +0100351
Jens Axboee9c047a2006-06-07 21:13:04 +0200352 /*
353 * State for random io, a bitmap of blocks done vs not done
354 */
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200355 os_random_state_t random_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100356
357 /*
Jens Axboeb990b5c2006-09-14 09:48:22 +0200358 * CPU "io" cycle burner
359 */
360 unsigned int cpuload;
361 unsigned int cpucycle;
362
363 /*
Jens Axboeebac4652005-12-08 15:25:21 +0100364 * bandwidth and latency stats
365 */
366 struct io_stat clat_stat[2]; /* completion latency */
367 struct io_stat slat_stat[2]; /* submission latency */
368 struct io_stat bw_stat[2]; /* bandwidth stats */
369
Jens Axboe9104f872005-12-28 23:50:45 +0100370 unsigned long long stat_io_bytes[2];
Jens Axboeebac4652005-12-08 15:25:21 +0100371 struct timeval stat_sample_time[2];
372
373 struct io_log *slat_log;
374 struct io_log *clat_log;
375 struct io_log *bw_log;
376
377 struct timeval start; /* start of this loop */
378 struct timeval epoch; /* time job was started */
Jens Axboe69008992006-11-24 13:12:56 +0100379 struct timeval end_time;/* time job ended */
Jens Axboeebac4652005-12-08 15:25:21 +0100380
Jens Axboee9c047a2006-06-07 21:13:04 +0200381 /*
382 * fio system usage accounting
383 */
Jens Axboeebac4652005-12-08 15:25:21 +0100384 struct rusage ru_start;
385 struct rusage ru_end;
386 unsigned long usr_time;
387 unsigned long sys_time;
388 unsigned long ctx;
389
Jens Axboee9c047a2006-06-07 21:13:04 +0200390 /*
391 * read/write mixed workload state
392 */
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200393 os_random_state_t rwmix_state;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200394 struct timeval rwmix_switch;
Jens Axboee9c047a2006-06-07 21:13:04 +0200395 enum fio_ddir rwmix_ddir;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200396
Jens Axboe4e0ba8a2006-06-06 09:36:28 +0200397 /*
398 * Pre-run and post-run shell
399 */
400 char *exec_prerun;
401 char *exec_postrun;
402
Jens Axboee9c047a2006-06-07 21:13:04 +0200403 /*
404 * IO historic logs
405 */
Jens Axboeebac4652005-12-08 15:25:21 +0100406 struct list_head io_hist_list;
Jens Axboeaea47d42006-05-26 19:27:29 +0200407 struct list_head io_log_list;
Jens Axboeebac4652005-12-08 15:25:21 +0100408};
409
Jens Axboeb990b5c2006-09-14 09:48:22 +0200410#define __td_verror(td, err, msg) \
Jens Axboeebac4652005-12-08 15:25:21 +0100411 do { \
412 int e = (err); \
413 (td)->error = e; \
Jens Axboeb990b5c2006-09-14 09:48:22 +0200414 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, (msg)); \
Jens Axboeebac4652005-12-08 15:25:21 +0100415 } while (0)
416
Jens Axboeb990b5c2006-09-14 09:48:22 +0200417
418#define td_verror(td, err) __td_verror((td), (err), strerror((err)))
419#define td_vmsg(td, err, msg) __td_verror((td), (err), (msg))
420
Jens Axboeebac4652005-12-08 15:25:21 +0100421extern int exitall_on_terminate;
422extern int thread_number;
423extern int shm_id;
424extern int groupid;
Jens Axboec6ae0a52006-06-12 11:04:44 +0200425extern int terse_output;
Jens Axboeeb8bbf42006-06-08 21:40:11 +0200426extern FILE *f_out;
427extern FILE *f_err;
Jens Axboe53cdc682006-10-18 11:50:58 +0200428extern int temp_stall_ts;
Jens Axboe1e97cce2006-12-05 11:44:16 +0100429extern unsigned long long mlock_size;
Jens Axboeebac4652005-12-08 15:25:21 +0100430
431extern struct thread_data *threads;
432
Jens Axboeebac4652005-12-08 15:25:21 +0100433#define td_read(td) ((td)->ddir == DDIR_READ)
434#define td_write(td) ((td)->ddir == DDIR_WRITE)
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200435#define td_rw(td) ((td)->iomix != 0)
Jens Axboeebac4652005-12-08 15:25:21 +0100436
437#define BLOCKS_PER_MAP (8 * sizeof(long))
Jens Axboea00735e2006-11-03 08:58:08 +0100438#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->rw_min_bs))
Jens Axboe53cdc682006-10-18 11:50:58 +0200439#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
440#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
Jens Axboeebac4652005-12-08 15:25:21 +0100441
442#define MAX_JOBS (1024)
443
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200444static inline int should_fsync(struct thread_data *td)
445{
446 if (td->last_was_sync)
447 return 0;
448 if (td->odirect)
449 return 0;
450 if (td_write(td) || td_rw(td) || td->override_sync)
451 return 1;
452
453 return 0;
454}
455
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100456/*
457 * Disk utils as read in /sys/block/<dev>/stat
458 */
Jens Axboeebac4652005-12-08 15:25:21 +0100459struct disk_util_stat {
460 unsigned ios[2];
461 unsigned merges[2];
462 unsigned long long sectors[2];
463 unsigned ticks[2];
464 unsigned io_ticks;
465 unsigned time_in_queue;
466};
467
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100468/*
469 * Per-device disk util management
470 */
Jens Axboeebac4652005-12-08 15:25:21 +0100471struct disk_util {
472 struct list_head list;
473
474 char *name;
475 char path[256];
476 dev_t dev;
477
478 struct disk_util_stat dus;
479 struct disk_util_stat last_dus;
480
481 unsigned long msec;
482 struct timeval time;
483};
484
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100485/*
486 * Used for passing io_u completion data
487 */
Jens Axboeebac4652005-12-08 15:25:21 +0100488struct io_completion_data {
489 int nr; /* input */
490
491 int error; /* output */
492 unsigned long bytes_done[2]; /* output */
Jens Axboe02bcaa82006-11-24 10:42:00 +0100493 struct timeval time; /* output */
Jens Axboeebac4652005-12-08 15:25:21 +0100494};
495
496#define DISK_UTIL_MSEC (250)
497
Jens Axboe6a0106a2006-05-05 10:34:43 +0200498#ifndef min
499#define min(a, b) ((a) < (b) ? (a) : (b))
500#endif
Jens Axboea00735e2006-11-03 08:58:08 +0100501#ifndef max
502#define max(a, b) ((a) > (b) ? (a) : (b))
503#endif
Jens Axboe6a0106a2006-05-05 10:34:43 +0200504
Jens Axboe67962092006-06-07 08:45:01 +0200505/*
506 * Log exports
507 */
508extern int read_iolog_get(struct thread_data *, struct io_u *);
509extern void write_iolog_put(struct thread_data *, struct io_u *);
510extern int init_iolog(struct thread_data *td);
511extern void log_io_piece(struct thread_data *, struct io_u *);
512extern void prune_io_piece_log(struct thread_data *);
513extern void write_iolog_close(struct thread_data *);
514
515/*
516 * Logging
517 */
Jens Axboe1e97cce2006-12-05 11:44:16 +0100518extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
519extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
520extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
Jens Axboe67962092006-06-07 08:45:01 +0200521extern void show_run_stats(void);
522extern void init_disk_util(struct thread_data *);
523extern void update_rusage_stat(struct thread_data *);
524extern void update_io_ticks(void);
525extern void disk_util_timer_arm(void);
Jens Axboe8914a9d2006-06-07 11:14:56 +0200526extern void setup_log(struct io_log **);
527extern void finish_log(struct thread_data *, struct io_log *, const char *);
Jens Axboebb3884d2007-01-17 17:23:11 +1100528extern void __finish_log(struct io_log *, const char *);
Jens Axboe8914a9d2006-06-07 11:14:56 +0200529extern int setup_rate(struct thread_data *);
Jens Axboebb3884d2007-01-17 17:23:11 +1100530extern struct io_log *agg_io_log[2];
531extern int write_bw_log;
532extern void add_agg_sample(unsigned long, enum fio_ddir);
Jens Axboe67962092006-06-07 08:45:01 +0200533
534/*
535 * Time functions
536 */
537extern unsigned long utime_since(struct timeval *, struct timeval *);
Jens Axboe69008992006-11-24 13:12:56 +0100538extern unsigned long utime_since_now(struct timeval *);
Jens Axboe67962092006-06-07 08:45:01 +0200539extern unsigned long mtime_since(struct timeval *, struct timeval *);
540extern unsigned long mtime_since_now(struct timeval *);
541extern unsigned long time_since_now(struct timeval *);
Jens Axboe263e5292006-10-18 15:37:01 +0200542extern unsigned long mtime_since_genesis(void);
Jens Axboeb990b5c2006-09-14 09:48:22 +0200543extern void __usec_sleep(unsigned int);
Jens Axboe67962092006-06-07 08:45:01 +0200544extern void usec_sleep(struct thread_data *, unsigned long);
Jens Axboea00735e2006-11-03 08:58:08 +0100545extern void rate_throttle(struct thread_data *, unsigned long, unsigned int, int);
Jens Axboe6043c572006-11-03 11:37:47 +0100546extern void fill_start_time(struct timeval *);
Jens Axboe02bcaa82006-11-24 10:42:00 +0100547extern void fio_gettime(struct timeval *, void *);
Jens Axboe67962092006-06-07 08:45:01 +0200548
Jens Axboe8914a9d2006-06-07 11:14:56 +0200549/*
550 * Init functions
551 */
552extern int parse_options(int, char **);
553extern int init_random_state(struct thread_data *);
554
Jens Axboebbfd6b02006-06-07 19:42:54 +0200555/*
Jens Axboe53cdc682006-10-18 11:50:58 +0200556 * File setup/shutdown
557 */
558extern void close_files(struct thread_data *);
559extern int setup_files(struct thread_data *);
Jens Axboe21972cd2006-11-23 12:39:16 +0100560extern int open_files(struct thread_data *);
Jens Axboee5b401d2006-10-18 16:03:40 +0200561extern int file_invalidate_cache(struct thread_data *, struct fio_file *);
Jens Axboe53cdc682006-10-18 11:50:58 +0200562
563/*
Jens Axboe263e5292006-10-18 15:37:01 +0200564 * ETA/status stuff
565 */
566extern void print_thread_status(void);
567extern void print_status_init(int);
568
569/*
570 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
571 * will never back again. It may cycle between running/verififying/fsyncing.
572 * Once the thread reaches TD_EXITED, it is just waiting for the core to
573 * reap it.
574 */
575enum {
576 TD_NOT_CREATED = 0,
577 TD_CREATED,
578 TD_INITIALIZED,
579 TD_RUNNING,
580 TD_VERIFYING,
581 TD_FSYNCING,
582 TD_EXITED,
583 TD_REAPED,
584};
585
586/*
Jens Axboee29d1b72006-10-18 15:43:15 +0200587 * Verify helpers
588 */
589extern void populate_verify_io_u(struct thread_data *, struct io_u *);
590extern int get_next_verify(struct thread_data *td, struct io_u *);
Jens Axboea9619d42006-10-18 15:47:42 +0200591extern int do_io_u_verify(struct thread_data *, struct io_u **);
Jens Axboee29d1b72006-10-18 15:43:15 +0200592
593/*
Jens Axboe2f9ade32006-10-20 11:25:52 +0200594 * Memory helpers
595 */
596extern int fio_pin_memory(void);
597extern void fio_unpin_memory(void);
598extern int allocate_io_mem(struct thread_data *);
599extern void free_io_mem(struct thread_data *);
600
601/*
Jens Axboe10ba5352006-10-20 11:39:27 +0200602 * io unit handling
603 */
604#define queue_full(td) list_empty(&(td)->io_u_freelist)
605extern struct io_u *__get_io_u(struct thread_data *);
606extern struct io_u *get_io_u(struct thread_data *, struct fio_file *);
607extern void put_io_u(struct thread_data *, struct io_u *);
608extern void ios_completed(struct thread_data *, struct io_completion_data *);
609extern void io_completed(struct thread_data *, struct io_u *, struct io_completion_data *);
610
611/*
612 * io engine entry points
613 */
Jens Axboe8c16d842006-10-20 11:48:33 +0200614extern int td_io_init(struct thread_data *);
Jens Axboe10ba5352006-10-20 11:39:27 +0200615extern int td_io_prep(struct thread_data *, struct io_u *);
616extern int td_io_queue(struct thread_data *, struct io_u *);
617extern int td_io_sync(struct thread_data *, struct fio_file *);
618extern int td_io_getevents(struct thread_data *, int, int, struct timespec *);
619
620/*
Jens Axboebbfd6b02006-06-07 19:42:54 +0200621 * This is a pretty crappy semaphore implementation, but with the use that fio
622 * has (just signalling start/go conditions), it doesn't have to be better.
623 * Naturally this would not work for any type of contended semaphore or
624 * for real locking.
625 */
Jens Axboe1056eaa2006-07-13 10:33:45 -0700626static inline void fio_sem_init(volatile int *sem, int val)
Jens Axboebbfd6b02006-06-07 19:42:54 +0200627{
628 *sem = val;
629}
630
Jens Axboe1056eaa2006-07-13 10:33:45 -0700631static inline void fio_sem_down(volatile int *sem)
Jens Axboebbfd6b02006-06-07 19:42:54 +0200632{
633 while (*sem == 0)
634 usleep(10000);
635
636 (*sem)--;
637}
638
Jens Axboe1056eaa2006-07-13 10:33:45 -0700639static inline void fio_sem_up(volatile int *sem)
Jens Axboebbfd6b02006-06-07 19:42:54 +0200640{
641 (*sem)++;
642}
643
Jens Axboe3b70d7e2006-06-08 21:48:46 +0200644/*
645 * If logging output to a file, stderr should go to both stderr and f_err
646 */
647#define log_err(args...) do { \
648 fprintf(f_err, ##args); \
649 if (f_err != stderr) \
650 fprintf(stderr, ##args); \
651 } while (0)
652
Jens Axboe2866c822006-10-09 15:57:48 +0200653struct ioengine_ops {
Jens Axboe5f350952006-11-07 15:20:59 +0100654 struct list_head list;
Jens Axboe2866c822006-10-09 15:57:48 +0200655 char name[16];
656 int version;
657 int flags;
Jens Axboeea2877a2006-10-10 08:30:24 +0200658 int (*setup)(struct thread_data *);
Jens Axboe2866c822006-10-09 15:57:48 +0200659 int (*init)(struct thread_data *);
660 int (*prep)(struct thread_data *, struct io_u *);
661 int (*queue)(struct thread_data *, struct io_u *);
662 int (*getevents)(struct thread_data *, int, int, struct timespec *);
663 struct io_u *(*event)(struct thread_data *, int);
664 int (*cancel)(struct thread_data *, struct io_u *);
665 void (*cleanup)(struct thread_data *);
Jens Axboe2866c822006-10-09 15:57:48 +0200666 void *data;
667 void *dlhandle;
668};
669
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200670#define FIO_IOOPS_VERSION 3
Jens Axboe2866c822006-10-09 15:57:48 +0200671
Jens Axboeb4692822006-10-27 13:43:22 +0200672extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
Jens Axboe5f350952006-11-07 15:20:59 +0100673extern int register_ioengine(struct ioengine_ops *);
674extern void unregister_ioengine(struct ioengine_ops *);
Jens Axboe2866c822006-10-09 15:57:48 +0200675extern void close_ioengine(struct thread_data *);
676
677/*
678 * Mark unused variables passed to ops functions as unused, to silence gcc
679 */
680#define fio_unused __attribute((__unused__))
Jens Axboe5f350952006-11-07 15:20:59 +0100681#define fio_init __attribute__((constructor))
682#define fio_exit __attribute__((destructor))
Jens Axboe2866c822006-10-09 15:57:48 +0200683
Jens Axboe34572e22006-10-20 09:33:18 +0200684#define for_each_td(td, i) \
685 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
Jens Axboe53cdc682006-10-18 11:50:58 +0200686#define for_each_file(td, f, i) \
Jens Axboe34572e22006-10-20 09:33:18 +0200687 for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)
Jens Axboe53cdc682006-10-18 11:50:58 +0200688
Jens Axboe0032bf92007-02-13 17:39:56 +0100689#define fio_assert(td, cond) do { \
690 if (!(cond)) { \
Jens Axboe340fd242007-02-13 20:09:10 +0100691 int *__foo = NULL; \
Jens Axboe0032bf92007-02-13 17:39:56 +0100692 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
693 (td)->runstate = TD_EXITED; \
Jens Axboe437c9b72007-02-13 18:20:37 +0100694 (td)->error = EFAULT; \
Jens Axboe340fd242007-02-13 20:09:10 +0100695 *__foo = 0; \
Jens Axboe0032bf92007-02-13 17:39:56 +0100696 } \
697} while (0)
698
Jens Axboeebac4652005-12-08 15:25:21 +0100699#endif