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