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