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