projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
[PATCH] Add 'description' option
[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 * How many depth levels to log
172 */
173#define FIO_IO_U_MAP_NR 8
174
175/*
176 * This describes a single thread/process executing a fio job.
177 */
178struct thread_data {
179 char *description;
180 char *name;
181 char *directory;
182 char *filename;
183 char verror[80];
184 pthread_t thread;
185 int thread_number;
186 int groupid;
187 enum fio_filetype filetype;
188 struct fio_file *files;
189 unsigned int nr_files;
190 unsigned int nr_uniq_files;
191 unsigned int next_file;
192 int error;
193 pid_t pid;
194 char *orig_buffer;
195 size_t orig_buffer_size;
196 volatile int terminate;
197 volatile int runstate;
198 enum fio_ddir ddir;
199 unsigned int iomix;
200 unsigned int ioprio;
201 unsigned int last_was_sync;
202
203 unsigned int sequential;
204 unsigned int odirect;
205 unsigned int invalidate_cache;
206 unsigned int create_serialize;
207 unsigned int create_fsync;
208 unsigned int end_fsync;
209 unsigned int sync_io;
210 unsigned int verify;
211 unsigned int use_thread;
212 unsigned int unlink;
213 unsigned int do_disk_util;
214 unsigned int override_sync;
215 unsigned int rand_repeatable;
216 unsigned int write_lat_log;
217 unsigned int write_bw_log;
218 unsigned int norandommap;
219 unsigned int bs_unaligned;
220
221 unsigned int bs[2];
222 unsigned int min_bs[2];
223 unsigned int max_bs[2];
224 unsigned int hugepage_size;
225 unsigned int rw_min_bs;
226 unsigned int thinktime;
227 unsigned int thinktime_blocks;
228 unsigned int fsync_blocks;
229 unsigned int start_delay;
230 unsigned long timeout;
231 unsigned int overwrite;
232 unsigned int bw_avg_time;
233 unsigned int loops;
234 unsigned long long zone_size;
235 unsigned long long zone_skip;
236 enum fio_memtype mem_type;
237 char *mmapfile;
238 int mmapfd;
239 unsigned int stonewall;
240 unsigned int numjobs;
241 unsigned int iodepth;
242 os_cpu_mask_t cpumask;
243 unsigned int iolog;
244 unsigned int read_iolog;
245 unsigned int rwmixcycle;
246 unsigned int rwmixread;
247 unsigned int rwmixwrite;
248 unsigned int nice;
249
250 char *read_iolog_file;
251 char *write_iolog_file;
252 void *iolog_buf;
253 FILE *iolog_f;
254
255 char *sysfs_root;
256 char *ioscheduler;
257
258 os_random_state_t bsrange_state;
259 os_random_state_t verify_state;
260
261 int shm_id;
262
263 /*
264 * IO engine hooks, contains everything needed to submit an io_u
265 * to any of the available IO engines.
266 */
267 struct ioengine_ops *io_ops;
268
269 /*
270 * Current IO depth and list of free and busy io_u's.
271 */
272 unsigned int cur_depth;
273 unsigned int io_u_map[FIO_IO_U_MAP_NR];
274 unsigned long total_io_u;
275 struct list_head io_u_freelist;
276 struct list_head io_u_busylist;
277
278 /*
279 * Rate state
280 */
281 unsigned int rate;
282 unsigned int ratemin;
283 unsigned int ratecycle;
284 unsigned long rate_usec_cycle;
285 long rate_pending_usleep;
286 unsigned long rate_bytes;
287 struct timeval lastrate;
288
289 unsigned long runtime[2]; /* msec */
290 unsigned long long io_size;
291 unsigned long long total_file_size;
292 unsigned long long start_offset;
293 unsigned long long total_io_size;
294
295 unsigned long long io_blocks[2];
296 unsigned long long io_bytes[2];
297 unsigned long long zone_bytes;
298 unsigned long long this_io_bytes[2];
299 volatile int mutex;
300
301 /*
302 * State for random io, a bitmap of blocks done vs not done
303 */
304 os_random_state_t random_state;
305
306 /*
307 * CPU "io" cycle burner
308 */
309 unsigned int cpuload;
310 unsigned int cpucycle;
311
312 /*
313 * bandwidth and latency stats
314 */
315 struct io_stat clat_stat[2]; /* completion latency */
316 struct io_stat slat_stat[2]; /* submission latency */
317 struct io_stat bw_stat[2]; /* bandwidth stats */
318
319 unsigned long long stat_io_bytes[2];
320 struct timeval stat_sample_time[2];
321
322 struct io_log *slat_log;
323 struct io_log *clat_log;
324 struct io_log *bw_log;
325
326 struct timeval start; /* start of this loop */
327 struct timeval epoch; /* time job was started */
328 struct timeval end_time;/* time job ended */
329
330 /*
331 * fio system usage accounting
332 */
333 struct rusage ru_start;
334 struct rusage ru_end;
335 unsigned long usr_time;
336 unsigned long sys_time;
337 unsigned long ctx;
338
339 /*
340 * read/write mixed workload state
341 */
342 os_random_state_t rwmix_state;
343 struct timeval rwmix_switch;
344 enum fio_ddir rwmix_ddir;
345
346 /*
347 * Pre-run and post-run shell
348 */
349 char *exec_prerun;
350 char *exec_postrun;
351
352 /*
353 * IO historic logs
354 */
355 struct list_head io_hist_list;
356 struct list_head io_log_list;
357};
358
359#define __td_verror(td, err, msg) \
360 do { \
361 int e = (err); \
362 (td)->error = e; \
363 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, (msg)); \
364 } while (0)
365
366
367#define td_verror(td, err) __td_verror((td), (err), strerror((err)))
368#define td_vmsg(td, err, msg) __td_verror((td), (err), (msg))
369
370extern int exitall_on_terminate;
371extern int thread_number;
372extern int shm_id;
373extern int groupid;
374extern int terse_output;
375extern FILE *f_out;
376extern FILE *f_err;
377extern int temp_stall_ts;
378extern unsigned long long mlock_size;
379
380extern struct thread_data *threads;
381
382#define td_read(td) ((td)->ddir == DDIR_READ)
383#define td_write(td) ((td)->ddir == DDIR_WRITE)
384#define td_rw(td) ((td)->iomix != 0)
385
386#define BLOCKS_PER_MAP (8 * sizeof(long))
387#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->rw_min_bs))
388#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
389#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
390
391#define MAX_JOBS (1024)
392
393static inline int should_fsync(struct thread_data *td)
394{
395 if (td->last_was_sync)
396 return 0;
397 if (td->odirect)
398 return 0;
399 if (td_write(td) || td_rw(td) || td->override_sync)
400 return 1;
401
402 return 0;
403}
404
405struct disk_util_stat {
406 unsigned ios[2];
407 unsigned merges[2];
408 unsigned long long sectors[2];
409 unsigned ticks[2];
410 unsigned io_ticks;
411 unsigned time_in_queue;
412};
413
414struct disk_util {
415 struct list_head list;
416
417 char *name;
418 char path[256];
419 dev_t dev;
420
421 struct disk_util_stat dus;
422 struct disk_util_stat last_dus;
423
424 unsigned long msec;
425 struct timeval time;
426};
427
428struct io_completion_data {
429 int nr; /* input */
430
431 int error; /* output */
432 unsigned long bytes_done[2]; /* output */
433 struct timeval time; /* output */
434};
435
436#define DISK_UTIL_MSEC (250)
437
438#ifndef min
439#define min(a, b) ((a) < (b) ? (a) : (b))
440#endif
441#ifndef max
442#define max(a, b) ((a) > (b) ? (a) : (b))
443#endif
444
445/*
446 * Log exports
447 */
448extern int read_iolog_get(struct thread_data *, struct io_u *);
449extern void write_iolog_put(struct thread_data *, struct io_u *);
450extern int init_iolog(struct thread_data *td);
451extern void log_io_piece(struct thread_data *, struct io_u *);
452extern void prune_io_piece_log(struct thread_data *);
453extern void write_iolog_close(struct thread_data *);
454
455/*
456 * Logging
457 */
458extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
459extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
460extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
461extern void show_run_stats(void);
462extern void init_disk_util(struct thread_data *);
463extern void update_rusage_stat(struct thread_data *);
464extern void update_io_ticks(void);
465extern void disk_util_timer_arm(void);
466extern void setup_log(struct io_log **);
467extern void finish_log(struct thread_data *, struct io_log *, const char *);
468extern void __finish_log(struct io_log *, const char *);
469extern int setup_rate(struct thread_data *);
470extern struct io_log *agg_io_log[2];
471extern int write_bw_log;
472extern void add_agg_sample(unsigned long, enum fio_ddir);
473
474/*
475 * Time functions
476 */
477extern unsigned long utime_since(struct timeval *, struct timeval *);
478extern unsigned long utime_since_now(struct timeval *);
479extern unsigned long mtime_since(struct timeval *, struct timeval *);
480extern unsigned long mtime_since_now(struct timeval *);
481extern unsigned long time_since_now(struct timeval *);
482extern unsigned long mtime_since_genesis(void);
483extern void __usec_sleep(unsigned int);
484extern void usec_sleep(struct thread_data *, unsigned long);
485extern void rate_throttle(struct thread_data *, unsigned long, unsigned int, int);
486extern void fill_start_time(struct timeval *);
487extern void fio_gettime(struct timeval *, void *);
488
489/*
490 * Init functions
491 */
492extern int parse_options(int, char **);
493extern int init_random_state(struct thread_data *);
494
495/*
496 * File setup/shutdown
497 */
498extern void close_files(struct thread_data *);
499extern int setup_files(struct thread_data *);
500extern int open_files(struct thread_data *);
501extern int file_invalidate_cache(struct thread_data *, struct fio_file *);
502
503/*
504 * ETA/status stuff
505 */
506extern void print_thread_status(void);
507extern void print_status_init(int);
508
509/*
510 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
511 * will never back again. It may cycle between running/verififying/fsyncing.
512 * Once the thread reaches TD_EXITED, it is just waiting for the core to
513 * reap it.
514 */
515enum {
516 TD_NOT_CREATED = 0,
517 TD_CREATED,
518 TD_INITIALIZED,
519 TD_RUNNING,
520 TD_VERIFYING,
521 TD_FSYNCING,
522 TD_EXITED,
523 TD_REAPED,
524};
525
526/*
527 * Verify helpers
528 */
529extern void populate_verify_io_u(struct thread_data *, struct io_u *);
530extern int get_next_verify(struct thread_data *td, struct io_u *);
531extern int do_io_u_verify(struct thread_data *, struct io_u **);
532
533/*
534 * Memory helpers
535 */
536extern int fio_pin_memory(void);
537extern void fio_unpin_memory(void);
538extern int allocate_io_mem(struct thread_data *);
539extern void free_io_mem(struct thread_data *);
540
541/*
542 * io unit handling
543 */
544#define queue_full(td) list_empty(&(td)->io_u_freelist)
545extern struct io_u *__get_io_u(struct thread_data *);
546extern struct io_u *get_io_u(struct thread_data *, struct fio_file *);
547extern void put_io_u(struct thread_data *, struct io_u *);
548extern void ios_completed(struct thread_data *, struct io_completion_data *);
549extern void io_completed(struct thread_data *, struct io_u *, struct io_completion_data *);
550
551/*
552 * io engine entry points
553 */
554extern int td_io_init(struct thread_data *);
555extern int td_io_prep(struct thread_data *, struct io_u *);
556extern int td_io_queue(struct thread_data *, struct io_u *);
557extern int td_io_sync(struct thread_data *, struct fio_file *);
558extern int td_io_getevents(struct thread_data *, int, int, struct timespec *);
559
560/*
561 * This is a pretty crappy semaphore implementation, but with the use that fio
562 * has (just signalling start/go conditions), it doesn't have to be better.
563 * Naturally this would not work for any type of contended semaphore or
564 * for real locking.
565 */
566static inline void fio_sem_init(volatile int *sem, int val)
567{
568 *sem = val;
569}
570
571static inline void fio_sem_down(volatile int *sem)
572{
573 while (*sem == 0)
574 usleep(10000);
575
576 (*sem)--;
577}
578
579static inline void fio_sem_up(volatile int *sem)
580{
581 (*sem)++;
582}
583
584/*
585 * If logging output to a file, stderr should go to both stderr and f_err
586 */
587#define log_err(args...) do { \
588 fprintf(f_err, ##args); \
589 if (f_err != stderr) \
590 fprintf(stderr, ##args); \
591 } while (0)
592
593struct ioengine_ops {
594 struct list_head list;
595 char name[16];
596 int version;
597 int flags;
598 int (*setup)(struct thread_data *);
599 int (*init)(struct thread_data *);
600 int (*prep)(struct thread_data *, struct io_u *);
601 int (*queue)(struct thread_data *, struct io_u *);
602 int (*getevents)(struct thread_data *, int, int, struct timespec *);
603 struct io_u *(*event)(struct thread_data *, int);
604 int (*cancel)(struct thread_data *, struct io_u *);
605 void (*cleanup)(struct thread_data *);
606 void *data;
607 void *dlhandle;
608};
609
610#define FIO_IOOPS_VERSION 3
611
612extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
613extern int register_ioengine(struct ioengine_ops *);
614extern void unregister_ioengine(struct ioengine_ops *);
615extern void close_ioengine(struct thread_data *);
616
617/*
618 * Mark unused variables passed to ops functions as unused, to silence gcc
619 */
620#define fio_unused __attribute((__unused__))
621#define fio_init __attribute__((constructor))
622#define fio_exit __attribute__((destructor))
623
624#define for_each_td(td, i) \
625 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
626#define for_each_file(td, f, i) \
627 for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)
628
629#endif
fio - Flexible IO Tester