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