projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Merge branch 'master' of ssh://git.kernel.dk/data/git/fio
[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#include "mutex.h"
21
22#ifdef FIO_HAVE_SYSLET
23#include "syslet.h"
24#endif
25
26enum fio_ddir {
27 DDIR_READ = 0,
28 DDIR_WRITE,
29 DDIR_SYNC,
30};
31
32enum td_ddir {
33 TD_DDIR_READ = 1 << 0,
34 TD_DDIR_WRITE = 1 << 1,
35 TD_DDIR_RAND = 1 << 2,
36 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
37 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
38 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
39 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
40};
41
42/*
43 * Use for maintaining statistics
44 */
45struct io_stat {
46 unsigned long max_val;
47 unsigned long min_val;
48 unsigned long samples;
49
50 double mean;
51 double S;
52};
53
54/*
55 * A single data sample
56 */
57struct io_sample {
58 unsigned long time;
59 unsigned long val;
60 enum fio_ddir ddir;
61};
62
63/*
64 * Dynamically growing data sample log
65 */
66struct io_log {
67 unsigned long nr_samples;
68 unsigned long max_samples;
69 struct io_sample *log;
70};
71
72/*
73 * When logging io actions, this matches a single sent io_u
74 */
75struct io_piece {
76 struct list_head list;
77 struct fio_file *file;
78 unsigned long long offset;
79 unsigned long len;
80 enum fio_ddir ddir;
81};
82
83#ifdef FIO_HAVE_SYSLET
84struct syslet_req {
85 struct syslet_uatom atom; /* the atom to submit */
86 struct syslet_uatom *head; /* head of the sequence */
87 long ret; /* syscall return value */
88};
89#endif
90
91enum {
92 IO_U_F_FREE = 1 << 0,
93 IO_U_F_FLIGHT = 1 << 1,
94};
95
96/*
97 * The io unit
98 */
99struct io_u {
100 union {
101#ifdef FIO_HAVE_LIBAIO
102 struct iocb iocb;
103#endif
104#ifdef FIO_HAVE_POSIXAIO
105 struct aiocb aiocb;
106#endif
107#ifdef FIO_HAVE_SGIO
108 struct sg_io_hdr hdr;
109#endif
110#ifdef FIO_HAVE_SYSLET
111 struct syslet_req req;
112#endif
113 };
114 struct timeval start_time;
115 struct timeval issue_time;
116
117 /*
118 * Allocated/set buffer and length
119 */
120 void *buf;
121 unsigned long buflen;
122 unsigned long long offset;
123
124 /*
125 * IO engine state, may be different from above when we get
126 * partial transfers / residual data counts
127 */
128 void *xfer_buf;
129 unsigned long xfer_buflen;
130
131 unsigned int resid;
132 unsigned int error;
133
134 enum fio_ddir ddir;
135
136 /*
137 * io engine private data
138 */
139 union {
140 unsigned int index;
141 unsigned int seen;
142 };
143
144 unsigned int flags;
145
146 struct fio_file *file;
147
148 struct list_head list;
149
150 /*
151 * Callback for io completion
152 */
153 int (*end_io)(struct io_u *);
154};
155
156/*
157 * io_ops->queue() return values
158 */
159enum {
160 FIO_Q_COMPLETED = 0, /* completed sync */
161 FIO_Q_QUEUED = 1, /* queued, will complete async */
162 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
163};
164
165#define FIO_HDR_MAGIC 0xf00baaef
166
167enum {
168 VERIFY_NONE = 0, /* no verification */
169 VERIFY_MD5, /* md5 sum data blocks */
170 VERIFY_CRC32, /* crc32 sum data blocks */
171};
172
173/*
174 * A header structure associated with each checksummed data block
175 */
176struct verify_header {
177 unsigned int fio_magic;
178 unsigned int len;
179 unsigned int verify_type;
180 union {
181 char md5_digest[MD5_HASH_WORDS * 4];
182 unsigned long crc32;
183 };
184};
185
186struct group_run_stats {
187 unsigned long long max_run[2], min_run[2];
188 unsigned long long max_bw[2], min_bw[2];
189 unsigned long long io_kb[2];
190 unsigned long long agg[2];
191};
192
193/*
194 * What type of allocation to use for io buffers
195 */
196enum fio_memtype {
197 MEM_MALLOC = 0, /* ordinary malloc */
198 MEM_SHM, /* use shared memory segments */
199 MEM_SHMHUGE, /* use shared memory segments with huge pages */
200 MEM_MMAP, /* use anonynomous mmap */
201 MEM_MMAPHUGE, /* memory mapped huge file */
202};
203
204/*
205 * The type of object we are working on
206 */
207enum fio_filetype {
208 FIO_TYPE_FILE = 1, /* plain file */
209 FIO_TYPE_BD, /* block device */
210 FIO_TYPE_CHAR, /* character device */
211};
212
213enum fio_ioengine_flags {
214 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
215 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
216 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
217 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
218};
219
220/*
221 * Each thread_data structure has a number of files associated with it,
222 * this structure holds state information for a single file.
223 */
224struct fio_file {
225 /*
226 * A file may not be a file descriptor, let the io engine decide
227 */
228 union {
229 unsigned long file_data;
230 int fd;
231 };
232 char *file_name;
233 void *mmap;
234 unsigned long long file_size;
235 unsigned long long real_file_size;
236 unsigned long long file_offset;
237 unsigned long long last_pos;
238 unsigned long long last_completed_pos;
239
240 /*
241 * block map for random io
242 */
243 unsigned long *file_map;
244 unsigned int num_maps;
245 unsigned int last_free_lookup;
246
247 unsigned int unlink;
248 unsigned int open;
249};
250
251/*
252 * How many depth levels to log
253 */
254#define FIO_IO_U_MAP_NR 8
255#define FIO_IO_U_LAT_NR 12
256
257struct thread_stat {
258 char *name;
259 char *verror;
260 int error;
261 int groupid;
262 pid_t pid;
263 char *description;
264 int members;
265
266 struct io_log *slat_log;
267 struct io_log *clat_log;
268 struct io_log *bw_log;
269
270 /*
271 * bandwidth and latency stats
272 */
273 struct io_stat clat_stat[2]; /* completion latency */
274 struct io_stat slat_stat[2]; /* submission latency */
275 struct io_stat bw_stat[2]; /* bandwidth stats */
276
277 unsigned long long stat_io_bytes[2];
278 struct timeval stat_sample_time[2];
279
280 /*
281 * fio system usage accounting
282 */
283 struct rusage ru_start;
284 struct rusage ru_end;
285 unsigned long usr_time;
286 unsigned long sys_time;
287 unsigned long ctx;
288
289 /*
290 * IO depth and latency stats
291 */
292 unsigned int io_u_map[FIO_IO_U_MAP_NR];
293 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
294 unsigned long total_io_u[2];
295
296 unsigned long long io_bytes[2];
297 unsigned long runtime[2];
298 unsigned long total_run_time;
299};
300
301/*
302 * This describes a single thread/process executing a fio job.
303 */
304struct thread_data {
305 int pad;
306 char *description;
307 char *name;
308 char *directory;
309 char *filename;
310 char *ioengine;
311 char verror[128];
312 pthread_t thread;
313 int thread_number;
314 int groupid;
315 struct thread_stat ts;
316 enum fio_filetype filetype;
317 struct fio_file *files;
318 unsigned int nr_files;
319 unsigned int nr_open_files;
320 unsigned int nr_uniq_files;
321 union {
322 unsigned int next_file;
323 os_random_state_t next_file_state;
324 };
325 int error;
326 pid_t pid;
327 char *orig_buffer;
328 size_t orig_buffer_size;
329 volatile int terminate;
330 volatile int runstate;
331 enum td_ddir td_ddir;
332 unsigned int ioprio;
333 unsigned int last_was_sync;
334
335 unsigned int odirect;
336 unsigned int invalidate_cache;
337 unsigned int create_serialize;
338 unsigned int create_fsync;
339 unsigned int end_fsync;
340 unsigned int sync_io;
341 unsigned int verify;
342 unsigned int use_thread;
343 unsigned int unlink;
344 unsigned int do_disk_util;
345 unsigned int override_sync;
346 unsigned int rand_repeatable;
347 unsigned int write_lat_log;
348 unsigned int write_bw_log;
349 unsigned int norandommap;
350 unsigned int bs_unaligned;
351
352 unsigned int bs[2];
353 unsigned int min_bs[2];
354 unsigned int max_bs[2];
355 unsigned int hugepage_size;
356 unsigned int rw_min_bs;
357 unsigned int thinktime;
358 unsigned int thinktime_spin;
359 unsigned int thinktime_blocks;
360 unsigned int fsync_blocks;
361 unsigned int start_delay;
362 unsigned long timeout;
363 unsigned int overwrite;
364 unsigned int bw_avg_time;
365 unsigned int loops;
366 unsigned long long zone_size;
367 unsigned long long zone_skip;
368 enum fio_memtype mem_type;
369 char *mmapfile;
370 int mmapfd;
371 unsigned int stonewall;
372 unsigned int numjobs;
373 unsigned int iodepth;
374 unsigned int iodepth_low;
375 unsigned int iodepth_batch;
376 os_cpu_mask_t cpumask;
377 unsigned int iolog;
378 unsigned int read_iolog;
379 unsigned int rwmixcycle;
380 unsigned int rwmixread;
381 unsigned int rwmixwrite;
382 unsigned int nice;
383 unsigned int file_service_type;
384 unsigned int group_reporting;
385 unsigned int open_files;
386
387 char *read_iolog_file;
388 char *write_iolog_file;
389 void *iolog_buf;
390 FILE *iolog_f;
391
392 char *sysfs_root;
393 char *ioscheduler;
394
395 os_random_state_t bsrange_state;
396 os_random_state_t verify_state;
397
398 int shm_id;
399
400 /*
401 * IO engine hooks, contains everything needed to submit an io_u
402 * to any of the available IO engines.
403 */
404 struct ioengine_ops *io_ops;
405
406 /*
407 * Current IO depth and list of free and busy io_u's.
408 */
409 unsigned int cur_depth;
410 struct list_head io_u_freelist;
411 struct list_head io_u_busylist;
412 struct list_head io_u_requeues;
413 unsigned int io_u_queued;
414
415 /*
416 * Rate state
417 */
418 unsigned int rate;
419 unsigned int ratemin;
420 unsigned int ratecycle;
421 unsigned long rate_usec_cycle;
422 long rate_pending_usleep;
423 unsigned long rate_bytes;
424 struct timeval lastrate;
425
426 unsigned long long io_size;
427 unsigned long long total_file_size;
428 unsigned long long start_offset;
429 unsigned long long total_io_size;
430
431 unsigned long io_issues[2];
432 unsigned long long io_blocks[2];
433 unsigned long long io_bytes[2];
434 unsigned long long this_io_bytes[2];
435 unsigned long long zone_bytes;
436 struct fio_sem *mutex;
437
438 /*
439 * State for random io, a bitmap of blocks done vs not done
440 */
441 os_random_state_t random_state;
442
443 /*
444 * CPU "io" cycle burner
445 */
446 unsigned int cpuload;
447 unsigned int cpucycle;
448
449 struct timeval start; /* start of this loop */
450 struct timeval epoch; /* time job was started */
451
452 /*
453 * read/write mixed workload state
454 */
455 os_random_state_t rwmix_state;
456 struct timeval rwmix_switch;
457 enum fio_ddir rwmix_ddir;
458
459 /*
460 * Pre-run and post-run shell
461 */
462 char *exec_prerun;
463 char *exec_postrun;
464
465 /*
466 * IO historic logs
467 */
468 struct list_head io_hist_list;
469 struct list_head io_log_list;
470
471 /*
472 * timeout handling
473 */
474 struct timeval timeout_end;
475 struct itimerval timer;
476
477 /*
478 * for fileservice, how often to switch to a new file
479 */
480 unsigned int file_service_nr;
481 unsigned int file_service_left;
482 struct fio_file *file_service_file;
483};
484
485/*
486 * roundrobin available files, or choose one at random.
487 */
488enum {
489 FIO_FSERVICE_RANDOM = 1,
490 FIO_FSERVICE_RR = 2,
491};
492
493/*
494 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
495 * the timer on each queue operation.
496 */
497#define IO_U_TIMEOUT_INC 5
498#define IO_U_TIMEOUT 30
499
500#define __td_verror(td, err, msg, func) \
501 do { \
502 if ((td)->error) \
503 break; \
504 int e = (err); \
505 (td)->error = e; \
506 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
507 } while (0)
508
509
510#define td_verror(td, err, func) \
511 __td_verror((td), (err), strerror((err)), (func))
512#define td_vmsg(td, err, msg, func) \
513 __td_verror((td), (err), (msg), (func))
514
515extern int exitall_on_terminate;
516extern int thread_number;
517extern int nr_process, nr_thread;
518extern int shm_id;
519extern int groupid;
520extern int terse_output;
521extern FILE *f_out;
522extern FILE *f_err;
523extern int temp_stall_ts;
524extern unsigned long long mlock_size;
525
526extern struct thread_data *threads;
527
528#define td_read(td) ((td)->td_ddir & TD_DDIR_READ)
529#define td_write(td) ((td)->td_ddir & TD_DDIR_WRITE)
530#define td_rw(td) (((td)->td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
531#define td_random(td) ((td)->td_ddir & TD_DDIR_RAND)
532
533#define BLOCKS_PER_MAP (8 * sizeof(long))
534#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->rw_min_bs))
535#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
536#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
537
538#define MAX_JOBS (1024)
539
540static inline int should_fsync(struct thread_data *td)
541{
542 if (td->last_was_sync)
543 return 0;
544 if (td->odirect)
545 return 0;
546 if (td_write(td) || td_rw(td) || td->override_sync)
547 return 1;
548
549 return 0;
550}
551
552/*
553 * Disk utils as read in /sys/block/<dev>/stat
554 */
555struct disk_util_stat {
556 unsigned ios[2];
557 unsigned merges[2];
558 unsigned long long sectors[2];
559 unsigned ticks[2];
560 unsigned io_ticks;
561 unsigned time_in_queue;
562};
563
564/*
565 * Per-device disk util management
566 */
567struct disk_util {
568 struct list_head list;
569
570 char *name;
571 char path[256];
572 dev_t dev;
573
574 struct disk_util_stat dus;
575 struct disk_util_stat last_dus;
576
577 unsigned long msec;
578 struct timeval time;
579};
580
581#define DISK_UTIL_MSEC (250)
582
583#ifndef min
584#define min(a, b) ((a) < (b) ? (a) : (b))
585#endif
586#ifndef max
587#define max(a, b) ((a) > (b) ? (a) : (b))
588#endif
589
590/*
591 * Log exports
592 */
593extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
594extern void write_iolog_put(struct thread_data *, struct io_u *);
595extern int __must_check init_iolog(struct thread_data *td);
596extern void log_io_piece(struct thread_data *, struct io_u *);
597extern void prune_io_piece_log(struct thread_data *);
598extern void write_iolog_close(struct thread_data *);
599
600/*
601 * Logging
602 */
603extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
604extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
605extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
606extern void show_run_stats(void);
607extern void init_disk_util(struct thread_data *);
608extern void update_rusage_stat(struct thread_data *);
609extern void update_io_ticks(void);
610extern void disk_util_timer_arm(void);
611extern void setup_log(struct io_log **);
612extern void finish_log(struct thread_data *, struct io_log *, const char *);
613extern void __finish_log(struct io_log *, const char *);
614extern int setup_rate(struct thread_data *);
615extern struct io_log *agg_io_log[2];
616extern int write_bw_log;
617extern void add_agg_sample(unsigned long, enum fio_ddir);
618
619/*
620 * Time functions
621 */
622extern unsigned long utime_since(struct timeval *, struct timeval *);
623extern unsigned long utime_since_now(struct timeval *);
624extern unsigned long mtime_since(struct timeval *, struct timeval *);
625extern unsigned long mtime_since_now(struct timeval *);
626extern unsigned long time_since_now(struct timeval *);
627extern unsigned long mtime_since_genesis(void);
628extern void __usec_sleep(unsigned int);
629extern void usec_sleep(struct thread_data *, unsigned long);
630extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
631extern void fill_start_time(struct timeval *);
632extern void fio_gettime(struct timeval *, void *);
633extern void set_genesis_time(void);
634
635/*
636 * Init functions
637 */
638extern int __must_check parse_options(int, char **);
639extern int __must_check init_random_state(struct thread_data *);
640
641/*
642 * File setup/shutdown
643 */
644extern void close_files(struct thread_data *);
645extern int __must_check setup_files(struct thread_data *);
646extern int __must_check open_files(struct thread_data *);
647extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
648extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
649extern void generic_close_file(struct thread_data *, struct fio_file *);
650
651/*
652 * ETA/status stuff
653 */
654extern void print_thread_status(void);
655extern void print_status_init(int);
656
657/*
658 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
659 * will never back again. It may cycle between running/verififying/fsyncing.
660 * Once the thread reaches TD_EXITED, it is just waiting for the core to
661 * reap it.
662 */
663enum {
664 TD_NOT_CREATED = 0,
665 TD_CREATED,
666 TD_INITIALIZED,
667 TD_RUNNING,
668 TD_VERIFYING,
669 TD_FSYNCING,
670 TD_EXITED,
671 TD_REAPED,
672};
673
674/*
675 * Verify helpers
676 */
677extern void populate_verify_io_u(struct thread_data *, struct io_u *);
678extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
679extern int __must_check verify_io_u(struct io_u *);
680
681/*
682 * Memory helpers
683 */
684extern int __must_check fio_pin_memory(void);
685extern void fio_unpin_memory(void);
686extern int __must_check allocate_io_mem(struct thread_data *);
687extern void free_io_mem(struct thread_data *);
688
689/*
690 * io unit handling
691 */
692#define queue_full(td) list_empty(&(td)->io_u_freelist)
693extern struct io_u *__get_io_u(struct thread_data *);
694extern struct io_u *get_io_u(struct thread_data *);
695extern void put_io_u(struct thread_data *, struct io_u *);
696extern void requeue_io_u(struct thread_data *, struct io_u **);
697extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
698extern long __must_check io_u_queued_complete(struct thread_data *, int);
699extern void io_u_queued(struct thread_data *, struct io_u *);
700extern void io_u_log_error(struct thread_data *, struct io_u *);
701extern void io_u_init_timeout(void);
702extern void io_u_set_timeout(struct thread_data *);
703extern void io_u_mark_depth(struct thread_data *, struct io_u *);
704
705/*
706 * io engine entry points
707 */
708extern int __must_check td_io_init(struct thread_data *);
709extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
710extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
711extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
712extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
713extern int __must_check td_io_commit(struct thread_data *);
714extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
715extern void td_io_close_file(struct thread_data *, struct fio_file *);
716
717/*
718 * If logging output to a file, stderr should go to both stderr and f_err
719 */
720#define log_err(args...) do { \
721 fprintf(f_err, ##args); \
722 if (f_err != stderr) \
723 fprintf(stderr, ##args); \
724 } while (0)
725
726FILE *get_f_out(void);
727FILE *get_f_err(void);
728
729struct ioengine_ops {
730 struct list_head list;
731 char name[16];
732 int version;
733 int flags;
734 int (*setup)(struct thread_data *);
735 int (*init)(struct thread_data *);
736 int (*prep)(struct thread_data *, struct io_u *);
737 int (*queue)(struct thread_data *, struct io_u *);
738 int (*commit)(struct thread_data *);
739 int (*getevents)(struct thread_data *, int, int, struct timespec *);
740 struct io_u *(*event)(struct thread_data *, int);
741 int (*cancel)(struct thread_data *, struct io_u *);
742 void (*cleanup)(struct thread_data *);
743 int (*open_file)(struct thread_data *, struct fio_file *);
744 void (*close_file)(struct thread_data *, struct fio_file *);
745 void *data;
746 void *dlhandle;
747};
748
749#define FIO_IOOPS_VERSION 6
750
751extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
752extern void register_ioengine(struct ioengine_ops *);
753extern void unregister_ioengine(struct ioengine_ops *);
754extern void close_ioengine(struct thread_data *);
755
756/*
757 * Mark unused variables passed to ops functions as unused, to silence gcc
758 */
759#define fio_unused __attribute((__unused__))
760#define fio_init __attribute__((constructor))
761#define fio_exit __attribute__((destructor))
762
763#define for_each_td(td, i) \
764 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
765#define for_each_file(td, f, i) \
766 for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->open_files; (i)++, (f)++)
767
768#define fio_assert(td, cond) do { \
769 if (!(cond)) { \
770 int *__foo = NULL; \
771 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
772 (td)->runstate = TD_EXITED; \
773 (td)->error = EFAULT; \
774 *__foo = 0; \
775 } \
776} while (0)
777
778#endif
fio - Flexible IO Tester