[PATCH] Add support for giving multiple job files
[fio.git] / fio.h
CommitLineData
ebac4655
JA
1#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>
3c39a379
JA
9#include <errno.h>
10#include <stdlib.h>
11#include <stdio.h>
6d6f031f 12#include <unistd.h>
ebac4655
JA
13
14#include "list.h"
15#include "md5.h"
16#include "crc32.h"
17#include "arch.h"
18#include "os.h"
19
20struct io_stat {
21 unsigned long val;
22 unsigned long val_sq;
23 unsigned long max_val;
24 unsigned long min_val;
25 unsigned long samples;
26};
27
28struct io_sample {
29 unsigned long time;
30 unsigned long val;
31 unsigned int ddir;
32};
33
34struct io_log {
35 unsigned long nr_samples;
36 unsigned long max_samples;
37 struct io_sample *log;
38};
39
40struct io_piece {
41 struct list_head list;
42 unsigned long long offset;
43 unsigned int len;
aea47d44 44 int ddir;
ebac4655
JA
45};
46
47/*
48 * The io unit
49 */
50struct io_u {
51 union {
52#ifdef FIO_HAVE_LIBAIO
53 struct iocb iocb;
54#endif
55#ifdef FIO_HAVE_POSIXAIO
56 struct aiocb aiocb;
57#endif
58#ifdef FIO_HAVE_SGIO
59 struct sg_io_hdr hdr;
60#endif
61 };
62 struct timeval start_time;
63 struct timeval issue_time;
64
65 char *buf;
66 unsigned int buflen;
67 unsigned long long offset;
b1ff3403 68 unsigned int index;
ebac4655
JA
69
70 unsigned int resid;
71 unsigned int error;
72
73 unsigned char seen;
74 unsigned char ddir;
75
76 struct list_head list;
77};
78
79#define FIO_HDR_MAGIC 0xf00baaef
80
81enum {
82 VERIFY_NONE = 0,
83 VERIFY_MD5,
84 VERIFY_CRC32,
85};
86
87struct verify_header {
88 unsigned int fio_magic;
89 unsigned int len;
90 unsigned int verify_type;
91 union {
92 char md5_digest[MD5_HASH_WORDS * 4];
93 unsigned long crc32;
94 };
95};
96
97struct group_run_stats {
9104f874
JA
98 unsigned long long max_run[2], min_run[2];
99 unsigned long long max_bw[2], min_bw[2];
e9b2a3fa 100 unsigned long long io_kb[2];
9104f874 101 unsigned long long agg[2];
ebac4655
JA
102};
103
e9c047a0
JA
104enum fio_ddir {
105 DDIR_READ = 0,
106 DDIR_WRITE,
107};
108
109/*
110 * What type of allocation to use for io buffers
111 */
112enum fio_memtype {
113 MEM_MALLOC = 0, /* ordinary malloc */
114 MEM_SHM, /* use shared memory segments */
115 MEM_MMAP, /* use anonynomous mmap */
116};
117
118/*
119 * The type of object we are working on
120 */
121enum fio_filetype {
122 FIO_TYPE_FILE = 1,
123 FIO_TYPE_BD,
124 FIO_TYPE_CHAR,
125};
126
127enum fio_iotype {
128 FIO_SYNCIO = 1 << 0,
129 FIO_MMAPIO = 1 << 1 | FIO_SYNCIO,
130 FIO_LIBAIO = 1 << 2,
131 FIO_POSIXAIO = 1 << 3,
132 FIO_SGIO = 1 << 4,
133 FIO_SPLICEIO = 1 << 5 | FIO_SYNCIO,
134};
135
136/*
137 * This describes a single thread/process executing a fio job.
138 */
ebac4655 139struct thread_data {
e9c047a0
JA
140 char name[32];
141 char *file_name;
ef899b63 142 char *directory;
ebac4655
JA
143 char verror[80];
144 pthread_t thread;
145 int thread_number;
146 int groupid;
e9c047a0 147 enum fio_filetype filetype;
ebac4655
JA
148 int error;
149 int fd;
150 void *mmap;
151 pid_t pid;
152 char *orig_buffer;
153 size_t orig_buffer_size;
154 volatile int terminate;
155 volatile int runstate;
e9c047a0 156 enum fio_ddir ddir;
3d60d1ed 157 unsigned int iomix;
ebac4655 158 unsigned int ioprio;
e9c047a0
JA
159
160 unsigned char sequential;
161 unsigned char odirect;
162 unsigned char create_file;
163 unsigned char invalidate_cache;
164 unsigned char create_serialize;
165 unsigned char create_fsync;
166 unsigned char end_fsync;
167 unsigned char sync_io;
168 unsigned char verify;
169 unsigned char use_thread;
170 unsigned char do_disk_util;
171 unsigned char override_sync;
172
ebac4655
JA
173 unsigned int bs;
174 unsigned int min_bs;
175 unsigned int max_bs;
ebac4655
JA
176 unsigned int thinktime;
177 unsigned int fsync_blocks;
178 unsigned int start_delay;
179 unsigned int timeout;
e9c047a0 180 enum fio_iotype io_engine;
ebac4655 181 unsigned int overwrite;
ebac4655 182 unsigned int bw_avg_time;
ebac4655
JA
183 unsigned int loops;
184 unsigned long long file_size;
838a3cd3 185 unsigned long long real_file_size;
ebac4655 186 unsigned long long file_offset;
20dc95c4
JA
187 unsigned long long zone_size;
188 unsigned long long zone_skip;
e9c047a0 189 enum fio_memtype mem_type;
ebac4655
JA
190 unsigned int stonewall;
191 unsigned int numjobs;
ebac4655
JA
192 unsigned int iodepth;
193 os_cpu_mask_t cpumask;
eba09dd3 194 unsigned int jobnum;
aea47d44 195 unsigned int iolog;
843a7413
JA
196 unsigned int read_iolog;
197 unsigned int write_iolog;
a6ccc7be
JA
198 unsigned int rwmixcycle;
199 unsigned int rwmixread;
b6f4d880 200 unsigned int nice;
aea47d44 201
ef899b63 202 char *iolog_file;
843a7413
JA
203 void *iolog_buf;
204 FILE *iolog_f;
ebac4655 205
da86774e 206 char *sysfs_root;
da86774e
JA
207 char *ioscheduler;
208
6dfd46b9
JA
209 os_random_state_t bsrange_state;
210 os_random_state_t verify_state;
ebac4655
JA
211
212 int shm_id;
213
e9c047a0
JA
214 /*
215 * IO engine hooks, contains everything needed to submit an io_u
216 * to any of the available IO engines.
217 */
ebac4655
JA
218 void *io_data;
219 char io_engine_name[16];
220 int (*io_prep)(struct thread_data *, struct io_u *);
221 int (*io_queue)(struct thread_data *, struct io_u *);
222 int (*io_getevents)(struct thread_data *, int, int, struct timespec *);
223 struct io_u *(*io_event)(struct thread_data *, int);
224 int (*io_cancel)(struct thread_data *, struct io_u *);
225 void (*io_cleanup)(struct thread_data *);
226 int (*io_sync)(struct thread_data *);
227
e9c047a0
JA
228 /*
229 * Current IO depth and list of free and busy io_u's.
230 */
ebac4655
JA
231 unsigned int cur_depth;
232 struct list_head io_u_freelist;
233 struct list_head io_u_busylist;
234
e9c047a0
JA
235 /*
236 * Rate state
237 */
ebac4655
JA
238 unsigned int rate;
239 unsigned int ratemin;
240 unsigned int ratecycle;
241 unsigned long rate_usec_cycle;
242 long rate_pending_usleep;
243 unsigned long rate_bytes;
244 struct timeval lastrate;
245
246 unsigned long runtime[2]; /* msec */
247 unsigned long long io_size;
248 unsigned long long total_io_size;
249
9104f874
JA
250 unsigned long long io_blocks[2];
251 unsigned long long io_bytes[2];
252 unsigned long long zone_bytes;
253 unsigned long long this_io_bytes[2];
20dc95c4 254 unsigned long long last_pos;
bbfd6b00 255 volatile int mutex;
ebac4655 256
e9c047a0
JA
257 /*
258 * State for random io, a bitmap of blocks done vs not done
259 */
6dfd46b9 260 os_random_state_t random_state;
ebac4655
JA
261 unsigned long *file_map;
262 unsigned int num_maps;
263
264 /*
265 * bandwidth and latency stats
266 */
267 struct io_stat clat_stat[2]; /* completion latency */
268 struct io_stat slat_stat[2]; /* submission latency */
269 struct io_stat bw_stat[2]; /* bandwidth stats */
270
9104f874 271 unsigned long long stat_io_bytes[2];
ebac4655
JA
272 struct timeval stat_sample_time[2];
273
274 struct io_log *slat_log;
275 struct io_log *clat_log;
276 struct io_log *bw_log;
277
278 struct timeval start; /* start of this loop */
279 struct timeval epoch; /* time job was started */
280
e9c047a0
JA
281 /*
282 * fio system usage accounting
283 */
ebac4655
JA
284 struct rusage ru_start;
285 struct rusage ru_end;
286 unsigned long usr_time;
287 unsigned long sys_time;
288 unsigned long ctx;
289
e9c047a0
JA
290 /*
291 * read/write mixed workload state
292 */
6dfd46b9 293 os_random_state_t rwmix_state;
a6ccc7be 294 struct timeval rwmix_switch;
e9c047a0 295 enum fio_ddir rwmix_ddir;
a6ccc7be 296
4e0ba8af
JA
297 /*
298 * Pre-run and post-run shell
299 */
300 char *exec_prerun;
301 char *exec_postrun;
302
e9c047a0
JA
303 /*
304 * IO historic logs
305 */
ebac4655 306 struct list_head io_hist_list;
aea47d44 307 struct list_head io_log_list;
ebac4655
JA
308};
309
310#define td_verror(td, err) \
311 do { \
312 int e = (err); \
313 (td)->error = e; \
314 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, strerror(e)); \
315 } while (0)
316
b1ff3403
JA
317extern struct io_u *__get_io_u(struct thread_data *);
318extern void put_io_u(struct thread_data *, struct io_u *);
ebac4655
JA
319
320extern int rate_quit;
321extern int write_lat_log;
322extern int write_bw_log;
323extern int exitall_on_terminate;
324extern int thread_number;
325extern int shm_id;
326extern int groupid;
eb8bbf48
JA
327extern FILE *f_out;
328extern FILE *f_err;
ebac4655
JA
329
330extern struct thread_data *threads;
331
ebac4655
JA
332#define td_read(td) ((td)->ddir == DDIR_READ)
333#define td_write(td) ((td)->ddir == DDIR_WRITE)
3d60d1ed 334#define td_rw(td) ((td)->iomix != 0)
ebac4655
JA
335
336#define BLOCKS_PER_MAP (8 * sizeof(long))
337#define TO_MAP_BLOCK(td, b) ((b) - ((td)->file_offset / (td)->min_bs))
338#define RAND_MAP_IDX(td, b) (TO_MAP_BLOCK(td, b) / BLOCKS_PER_MAP)
339#define RAND_MAP_BIT(td, b) (TO_MAP_BLOCK(td, b) & (BLOCKS_PER_MAP - 1))
340
341#define MAX_JOBS (1024)
342
343struct disk_util_stat {
344 unsigned ios[2];
345 unsigned merges[2];
346 unsigned long long sectors[2];
347 unsigned ticks[2];
348 unsigned io_ticks;
349 unsigned time_in_queue;
350};
351
352struct disk_util {
353 struct list_head list;
354
355 char *name;
356 char path[256];
357 dev_t dev;
358
359 struct disk_util_stat dus;
360 struct disk_util_stat last_dus;
361
362 unsigned long msec;
363 struct timeval time;
364};
365
366struct io_completion_data {
367 int nr; /* input */
368
369 int error; /* output */
370 unsigned long bytes_done[2]; /* output */
371};
372
373#define DISK_UTIL_MSEC (250)
374
6a0106a0
JA
375#ifndef min
376#define min(a, b) ((a) < (b) ? (a) : (b))
377#endif
378
6796209a
JA
379/*
380 * Log exports
381 */
382extern int read_iolog_get(struct thread_data *, struct io_u *);
383extern void write_iolog_put(struct thread_data *, struct io_u *);
384extern int init_iolog(struct thread_data *td);
385extern void log_io_piece(struct thread_data *, struct io_u *);
386extern void prune_io_piece_log(struct thread_data *);
387extern void write_iolog_close(struct thread_data *);
388
389/*
390 * Logging
391 */
392extern void add_clat_sample(struct thread_data *, int, unsigned long);
393extern void add_slat_sample(struct thread_data *, int, unsigned long);
394extern void add_bw_sample(struct thread_data *, int);
395extern void show_run_stats(void);
396extern void init_disk_util(struct thread_data *);
397extern void update_rusage_stat(struct thread_data *);
398extern void update_io_ticks(void);
399extern void disk_util_timer_arm(void);
8914a9d8
JA
400extern void setup_log(struct io_log **);
401extern void finish_log(struct thread_data *, struct io_log *, const char *);
402extern int setup_rate(struct thread_data *);
6796209a
JA
403
404/*
405 * Time functions
406 */
407extern unsigned long utime_since(struct timeval *, struct timeval *);
408extern unsigned long mtime_since(struct timeval *, struct timeval *);
409extern unsigned long mtime_since_now(struct timeval *);
410extern unsigned long time_since_now(struct timeval *);
411extern void usec_sleep(struct thread_data *, unsigned long);
412extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
413
8914a9d8
JA
414/*
415 * Init functions
416 */
417extern int parse_options(int, char **);
418extern int init_random_state(struct thread_data *);
419
bbfd6b00
JA
420/*
421 * This is a pretty crappy semaphore implementation, but with the use that fio
422 * has (just signalling start/go conditions), it doesn't have to be better.
423 * Naturally this would not work for any type of contended semaphore or
424 * for real locking.
425 */
426static inline void fio_sem_init(volatile int volatile *sem, int val)
427{
428 *sem = val;
429}
430
431static inline void fio_sem_down(volatile int volatile *sem)
432{
433 while (*sem == 0)
434 usleep(10000);
435
436 (*sem)--;
437}
438
439static inline void fio_sem_up(volatile int volatile *sem)
440{
441 (*sem)++;
442}
443
3b70d7e5
JA
444/*
445 * If logging output to a file, stderr should go to both stderr and f_err
446 */
447#define log_err(args...) do { \
448 fprintf(f_err, ##args); \
449 if (f_err != stderr) \
450 fprintf(stderr, ##args); \
451 } while (0)
452
ebac4655 453#endif