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