projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Turn file ->open and ->unlink into flags
[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 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
219};
220
221enum fio_file_flags {
222 FIO_FILE_OPEN = 1 << 0,
223 FIO_FILE_UNLINK = 1 << 1,
224};
225
226/*
227 * Each thread_data structure has a number of files associated with it,
228 * this structure holds state information for a single file.
229 */
230struct fio_file {
231 enum fio_filetype filetype;
232
233 /*
234 * A file may not be a file descriptor, let the io engine decide
235 */
236 union {
237 unsigned long file_data;
238 int fd;
239 };
240 const char *file_name;
241 void *mmap;
242 unsigned long long file_size;
243 unsigned long long real_file_size;
244 unsigned long long file_offset;
245 unsigned long long last_pos;
246 unsigned long long last_completed_pos;
247
248 /*
249 * block map for random io
250 */
251 unsigned long *file_map;
252 unsigned int num_maps;
253 unsigned int last_free_lookup;
254
255 enum fio_file_flags flags;
256};
257
258/*
259 * How many depth levels to log
260 */
261#define FIO_IO_U_MAP_NR 8
262#define FIO_IO_U_LAT_NR 12
263
264struct thread_stat {
265 char *name;
266 char *verror;
267 int error;
268 int groupid;
269 pid_t pid;
270 char *description;
271 int members;
272
273 struct io_log *slat_log;
274 struct io_log *clat_log;
275 struct io_log *bw_log;
276
277 /*
278 * bandwidth and latency stats
279 */
280 struct io_stat clat_stat[2]; /* completion latency */
281 struct io_stat slat_stat[2]; /* submission latency */
282 struct io_stat bw_stat[2]; /* bandwidth stats */
283
284 unsigned long long stat_io_bytes[2];
285 struct timeval stat_sample_time[2];
286
287 /*
288 * fio system usage accounting
289 */
290 struct rusage ru_start;
291 struct rusage ru_end;
292 unsigned long usr_time;
293 unsigned long sys_time;
294 unsigned long ctx;
295
296 /*
297 * IO depth and latency stats
298 */
299 unsigned int io_u_map[FIO_IO_U_MAP_NR];
300 unsigned int io_u_lat[FIO_IO_U_LAT_NR];
301 unsigned long total_io_u[2];
302
303 unsigned long long io_bytes[2];
304 unsigned long runtime[2];
305 unsigned long total_run_time;
306};
307
308/*
309 * This describes a single thread/process executing a fio job.
310 */
311struct thread_data {
312 int pad;
313 char *description;
314 char *name;
315 char *directory;
316 char *filename;
317 char *ioengine;
318 char verror[128];
319 pthread_t thread;
320 int thread_number;
321 int groupid;
322 struct thread_stat ts;
323 struct fio_file *files;
324 unsigned int nr_files;
325 unsigned int nr_open_files;
326 unsigned int nr_uniq_files;
327 union {
328 unsigned int next_file;
329 os_random_state_t next_file_state;
330 };
331 int error;
332 pid_t pid;
333 char *orig_buffer;
334 size_t orig_buffer_size;
335 volatile int terminate;
336 volatile int runstate;
337 enum td_ddir td_ddir;
338 unsigned int ioprio;
339 unsigned int last_was_sync;
340
341 unsigned int odirect;
342 unsigned int invalidate_cache;
343 unsigned int create_serialize;
344 unsigned int create_fsync;
345 unsigned int end_fsync;
346 unsigned int sync_io;
347 unsigned int verify;
348 unsigned int use_thread;
349 unsigned int unlink;
350 unsigned int do_disk_util;
351 unsigned int override_sync;
352 unsigned int rand_repeatable;
353 unsigned int write_lat_log;
354 unsigned int write_bw_log;
355 unsigned int norandommap;
356 unsigned int bs_unaligned;
357
358 unsigned int bs[2];
359 unsigned int min_bs[2];
360 unsigned int max_bs[2];
361 unsigned int hugepage_size;
362 unsigned int rw_min_bs;
363 unsigned int thinktime;
364 unsigned int thinktime_spin;
365 unsigned int thinktime_blocks;
366 unsigned int fsync_blocks;
367 unsigned int start_delay;
368 unsigned long timeout;
369 unsigned int overwrite;
370 unsigned int bw_avg_time;
371 unsigned int loops;
372 unsigned long long zone_size;
373 unsigned long long zone_skip;
374 enum fio_memtype mem_type;
375 char *mmapfile;
376 int mmapfd;
377 unsigned int stonewall;
378 unsigned int numjobs;
379 unsigned int iodepth;
380 unsigned int iodepth_low;
381 unsigned int iodepth_batch;
382 os_cpu_mask_t cpumask;
383 unsigned int iolog;
384 unsigned int read_iolog;
385 unsigned int rwmixcycle;
386 unsigned int rwmixread;
387 unsigned int rwmixwrite;
388 unsigned int nice;
389 unsigned int file_service_type;
390 unsigned int group_reporting;
391 unsigned int open_files;
392
393 char *read_iolog_file;
394 char *write_iolog_file;
395 void *iolog_buf;
396 FILE *iolog_f;
397
398 char *sysfs_root;
399 char *ioscheduler;
400
401 os_random_state_t bsrange_state;
402 os_random_state_t verify_state;
403
404 int shm_id;
405
406 /*
407 * IO engine hooks, contains everything needed to submit an io_u
408 * to any of the available IO engines.
409 */
410 struct ioengine_ops *io_ops;
411
412 /*
413 * Current IO depth and list of free and busy io_u's.
414 */
415 unsigned int cur_depth;
416 struct list_head io_u_freelist;
417 struct list_head io_u_busylist;
418 struct list_head io_u_requeues;
419 unsigned int io_u_queued;
420
421 /*
422 * Rate state
423 */
424 unsigned int rate;
425 unsigned int ratemin;
426 unsigned int ratecycle;
427 unsigned long rate_usec_cycle;
428 long rate_pending_usleep;
429 unsigned long rate_bytes;
430 struct timeval lastrate;
431
432 unsigned long long io_size;
433 unsigned long long total_file_size;
434 unsigned long long start_offset;
435 unsigned long long total_io_size;
436
437 unsigned long io_issues[2];
438 unsigned long long io_blocks[2];
439 unsigned long long io_bytes[2];
440 unsigned long long this_io_bytes[2];
441 unsigned long long zone_bytes;
442 struct fio_sem *mutex;
443
444 /*
445 * State for random io, a bitmap of blocks done vs not done
446 */
447 os_random_state_t random_state;
448
449 /*
450 * CPU "io" cycle burner
451 */
452 unsigned int cpuload;
453 unsigned int cpucycle;
454
455 struct timeval start; /* start of this loop */
456 struct timeval epoch; /* time job was started */
457
458 /*
459 * read/write mixed workload state
460 */
461 os_random_state_t rwmix_state;
462 struct timeval rwmix_switch;
463 enum fio_ddir rwmix_ddir;
464
465 /*
466 * Pre-run and post-run shell
467 */
468 char *exec_prerun;
469 char *exec_postrun;
470
471 /*
472 * IO historic logs
473 */
474 struct list_head io_hist_list;
475 struct list_head io_log_list;
476
477 /*
478 * timeout handling
479 */
480 struct timeval timeout_end;
481 struct itimerval timer;
482
483 /*
484 * for fileservice, how often to switch to a new file
485 */
486 unsigned int file_service_nr;
487 unsigned int file_service_left;
488 struct fio_file *file_service_file;
489};
490
491/*
492 * roundrobin available files, or choose one at random.
493 */
494enum {
495 FIO_FSERVICE_RANDOM = 1,
496 FIO_FSERVICE_RR = 2,
497};
498
499/*
500 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
501 * the timer on each queue operation.
502 */
503#define IO_U_TIMEOUT_INC 5
504#define IO_U_TIMEOUT 30
505
506#define __td_verror(td, err, msg, func) \
507 do { \
508 if ((td)->error) \
509 break; \
510 int e = (err); \
511 (td)->error = e; \
512 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
513 } while (0)
514
515
516#define td_verror(td, err, func) \
517 __td_verror((td), (err), strerror((err)), (func))
518#define td_vmsg(td, err, msg, func) \
519 __td_verror((td), (err), (msg), (func))
520
521extern int exitall_on_terminate;
522extern int thread_number;
523extern int nr_process, nr_thread;
524extern int shm_id;
525extern int groupid;
526extern int terse_output;
527extern FILE *f_out;
528extern FILE *f_err;
529extern int temp_stall_ts;
530extern unsigned long long mlock_size;
531
532extern struct thread_data *threads;
533
534#define td_read(td) ((td)->td_ddir & TD_DDIR_READ)
535#define td_write(td) ((td)->td_ddir & TD_DDIR_WRITE)
536#define td_rw(td) (((td)->td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
537#define td_random(td) ((td)->td_ddir & TD_DDIR_RAND)
538
539#define BLOCKS_PER_MAP (8 * sizeof(long))
540#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->rw_min_bs))
541#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
542#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
543
544#define MAX_JOBS (1024)
545
546static inline int should_fsync(struct thread_data *td)
547{
548 if (td->last_was_sync)
549 return 0;
550 if (td->odirect)
551 return 0;
552 if (td_write(td) || td_rw(td) || td->override_sync)
553 return 1;
554
555 return 0;
556}
557
558/*
559 * Disk utils as read in /sys/block/<dev>/stat
560 */
561struct disk_util_stat {
562 unsigned ios[2];
563 unsigned merges[2];
564 unsigned long long sectors[2];
565 unsigned ticks[2];
566 unsigned io_ticks;
567 unsigned time_in_queue;
568};
569
570/*
571 * Per-device disk util management
572 */
573struct disk_util {
574 struct list_head list;
575
576 char *name;
577 char path[256];
578 dev_t dev;
579
580 struct disk_util_stat dus;
581 struct disk_util_stat last_dus;
582
583 unsigned long msec;
584 struct timeval time;
585};
586
587#define DISK_UTIL_MSEC (250)
588
589#ifndef min
590#define min(a, b) ((a) < (b) ? (a) : (b))
591#endif
592#ifndef max
593#define max(a, b) ((a) > (b) ? (a) : (b))
594#endif
595
596/*
597 * Log exports
598 */
599extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
600extern void write_iolog_put(struct thread_data *, struct io_u *);
601extern int __must_check init_iolog(struct thread_data *td);
602extern void log_io_piece(struct thread_data *, struct io_u *);
603extern void prune_io_piece_log(struct thread_data *);
604extern void write_iolog_close(struct thread_data *);
605
606/*
607 * Logging
608 */
609extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
610extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
611extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
612extern void show_run_stats(void);
613extern void init_disk_util(struct thread_data *);
614extern void update_rusage_stat(struct thread_data *);
615extern void update_io_ticks(void);
616extern void disk_util_timer_arm(void);
617extern void setup_log(struct io_log **);
618extern void finish_log(struct thread_data *, struct io_log *, const char *);
619extern void __finish_log(struct io_log *, const char *);
620extern int setup_rate(struct thread_data *);
621extern struct io_log *agg_io_log[2];
622extern int write_bw_log;
623extern void add_agg_sample(unsigned long, enum fio_ddir);
624
625/*
626 * Time functions
627 */
628extern unsigned long utime_since(struct timeval *, struct timeval *);
629extern unsigned long utime_since_now(struct timeval *);
630extern unsigned long mtime_since(struct timeval *, struct timeval *);
631extern unsigned long mtime_since_now(struct timeval *);
632extern unsigned long time_since_now(struct timeval *);
633extern unsigned long mtime_since_genesis(void);
634extern void __usec_sleep(unsigned int);
635extern void usec_sleep(struct thread_data *, unsigned long);
636extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
637extern void fill_start_time(struct timeval *);
638extern void fio_gettime(struct timeval *, void *);
639extern void set_genesis_time(void);
640
641/*
642 * Init functions
643 */
644extern int __must_check parse_options(int, char **);
645extern int __must_check init_random_state(struct thread_data *);
646
647/*
648 * File setup/shutdown
649 */
650extern void close_files(struct thread_data *);
651extern int __must_check setup_files(struct thread_data *);
652extern int __must_check open_files(struct thread_data *);
653extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
654extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
655extern void generic_close_file(struct thread_data *, struct fio_file *);
656extern void add_file(struct thread_data *, const char *);
657
658/*
659 * ETA/status stuff
660 */
661extern void print_thread_status(void);
662extern void print_status_init(int);
663
664/*
665 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
666 * will never back again. It may cycle between running/verififying/fsyncing.
667 * Once the thread reaches TD_EXITED, it is just waiting for the core to
668 * reap it.
669 */
670enum {
671 TD_NOT_CREATED = 0,
672 TD_CREATED,
673 TD_INITIALIZED,
674 TD_RUNNING,
675 TD_VERIFYING,
676 TD_FSYNCING,
677 TD_EXITED,
678 TD_REAPED,
679};
680
681/*
682 * Verify helpers
683 */
684extern void populate_verify_io_u(struct thread_data *, struct io_u *);
685extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
686extern int __must_check verify_io_u(struct io_u *);
687
688/*
689 * Memory helpers
690 */
691extern int __must_check fio_pin_memory(void);
692extern void fio_unpin_memory(void);
693extern int __must_check allocate_io_mem(struct thread_data *);
694extern void free_io_mem(struct thread_data *);
695
696/*
697 * io unit handling
698 */
699#define queue_full(td) list_empty(&(td)->io_u_freelist)
700extern struct io_u *__get_io_u(struct thread_data *);
701extern struct io_u *get_io_u(struct thread_data *);
702extern void put_io_u(struct thread_data *, struct io_u *);
703extern void requeue_io_u(struct thread_data *, struct io_u **);
704extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
705extern long __must_check io_u_queued_complete(struct thread_data *, int);
706extern void io_u_queued(struct thread_data *, struct io_u *);
707extern void io_u_log_error(struct thread_data *, struct io_u *);
708extern void io_u_init_timeout(void);
709extern void io_u_set_timeout(struct thread_data *);
710extern void io_u_mark_depth(struct thread_data *, struct io_u *);
711
712/*
713 * io engine entry points
714 */
715extern int __must_check td_io_init(struct thread_data *);
716extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
717extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
718extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
719extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
720extern int __must_check td_io_commit(struct thread_data *);
721extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
722extern void td_io_close_file(struct thread_data *, struct fio_file *);
723
724/*
725 * If logging output to a file, stderr should go to both stderr and f_err
726 */
727#define log_err(args...) do { \
728 fprintf(f_err, ##args); \
729 if (f_err != stderr) \
730 fprintf(stderr, ##args); \
731 } while (0)
732
733FILE *get_f_out(void);
734FILE *get_f_err(void);
735
736struct ioengine_ops {
737 struct list_head list;
738 char name[16];
739 int version;
740 int flags;
741 int (*setup)(struct thread_data *);
742 int (*init)(struct thread_data *);
743 int (*prep)(struct thread_data *, struct io_u *);
744 int (*queue)(struct thread_data *, struct io_u *);
745 int (*commit)(struct thread_data *);
746 int (*getevents)(struct thread_data *, int, int, struct timespec *);
747 struct io_u *(*event)(struct thread_data *, int);
748 int (*cancel)(struct thread_data *, struct io_u *);
749 void (*cleanup)(struct thread_data *);
750 int (*open_file)(struct thread_data *, struct fio_file *);
751 void (*close_file)(struct thread_data *, struct fio_file *);
752 void *data;
753 void *dlhandle;
754};
755
756#define FIO_IOOPS_VERSION 6
757
758extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
759extern void register_ioengine(struct ioengine_ops *);
760extern void unregister_ioengine(struct ioengine_ops *);
761extern void close_ioengine(struct thread_data *);
762
763/*
764 * Mark unused variables passed to ops functions as unused, to silence gcc
765 */
766#define fio_unused __attribute((__unused__))
767#define fio_init __attribute__((constructor))
768#define fio_exit __attribute__((destructor))
769
770#define for_each_td(td, i) \
771 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
772#define for_each_file(td, f, i) \
773 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->open_files; (i)++, (f)++)
774
775#define fio_assert(td, cond) do { \
776 if (!(cond)) { \
777 int *__foo = NULL; \
778 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
779 (td)->runstate = TD_EXITED; \
780 (td)->error = EFAULT; \
781 *__foo = 0; \
782 } \
783} while (0)
784
785#endif
fio - Flexible IO Tester