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