projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
splice engine: add unmapping for vmsplice-to-user
[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#include <getopt.h>
15#include <inttypes.h>
16
17#include "compiler/compiler.h"
18#include "list.h"
19#include "fifo.h"
20#include "rbtree.h"
21#include "arch/arch.h"
22#include "os/os.h"
23#include "mutex.h"
24
25#ifdef FIO_HAVE_SYSLET
26#include "syslet.h"
27#endif
28
29#ifdef FIO_HAVE_GUASI
30#include <guasi.h>
31#endif
32
33enum fio_ddir {
34 DDIR_READ = 0,
35 DDIR_WRITE,
36 DDIR_SYNC,
37 DDIR_INVAL = -1,
38};
39
40enum td_ddir {
41 TD_DDIR_READ = 1 << 0,
42 TD_DDIR_WRITE = 1 << 1,
43 TD_DDIR_RAND = 1 << 2,
44 TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE,
45 TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND,
46 TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND,
47 TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND,
48};
49
50/*
51 * Use for maintaining statistics
52 */
53struct io_stat {
54 unsigned long max_val;
55 unsigned long min_val;
56 unsigned long samples;
57
58 double mean;
59 double S;
60};
61
62/*
63 * A single data sample
64 */
65struct io_sample {
66 unsigned long time;
67 unsigned long val;
68 enum fio_ddir ddir;
69};
70
71/*
72 * Dynamically growing data sample log
73 */
74struct io_log {
75 unsigned long nr_samples;
76 unsigned long max_samples;
77 struct io_sample *log;
78};
79
80/*
81 * When logging io actions, this matches a single sent io_u
82 */
83struct io_piece {
84 union {
85 struct rb_node rb_node;
86 struct list_head list;
87 };
88 union {
89 int fileno;
90 struct fio_file *file;
91 };
92 unsigned long long offset;
93 unsigned long len;
94 enum fio_ddir ddir;
95 union {
96 unsigned long delay;
97 unsigned int file_action;
98 };
99};
100
101#ifdef FIO_HAVE_SYSLET
102struct syslet_req {
103 struct syslet_uatom atom; /* the atom to submit */
104 struct syslet_uatom *head; /* head of the sequence */
105 long ret; /* syscall return value */
106};
107#endif
108
109enum {
110 IO_U_F_FREE = 1 << 0,
111 IO_U_F_FLIGHT = 1 << 1,
112};
113
114struct thread_data;
115
116/*
117 * The io unit
118 */
119struct io_u {
120 union {
121#ifdef FIO_HAVE_LIBAIO
122 struct iocb iocb;
123#endif
124#ifdef FIO_HAVE_POSIXAIO
125 struct aiocb aiocb;
126#endif
127#ifdef FIO_HAVE_SGIO
128 struct sg_io_hdr hdr;
129#endif
130#ifdef FIO_HAVE_SYSLET
131 struct syslet_req req;
132#endif
133#ifdef FIO_HAVE_GUASI
134 guasi_req_t greq;
135#endif
136 };
137 struct timeval start_time;
138 struct timeval issue_time;
139
140 /*
141 * Allocated/set buffer and length
142 */
143 void *buf;
144 unsigned long buflen;
145 unsigned long long offset;
146 unsigned long long endpos;
147
148 /*
149 * IO engine state, may be different from above when we get
150 * partial transfers / residual data counts
151 */
152 void *xfer_buf;
153 unsigned long xfer_buflen;
154
155 unsigned int resid;
156 unsigned int error;
157
158 enum fio_ddir ddir;
159
160 /*
161 * io engine private data
162 */
163 union {
164 unsigned int index;
165 unsigned int seen;
166 };
167
168 unsigned int flags;
169
170 struct fio_file *file;
171
172 struct list_head list;
173
174 /*
175 * Callback for io completion
176 */
177 int (*end_io)(struct thread_data *, struct io_u *);
178
179 /*
180 * Called when io_u is about to be freed
181 */
182 void (*unmap)(struct thread_data *, struct io_u *);
183};
184
185/*
186 * io_ops->queue() return values
187 */
188enum {
189 FIO_Q_COMPLETED = 0, /* completed sync */
190 FIO_Q_QUEUED = 1, /* queued, will complete async */
191 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
192};
193
194#define FIO_HDR_MAGIC 0xf00baaef
195
196enum {
197 VERIFY_NONE = 0, /* no verification */
198 VERIFY_MD5, /* md5 sum data blocks */
199 VERIFY_CRC64, /* crc64 sum data blocks */
200 VERIFY_CRC32, /* crc32 sum data blocks */
201 VERIFY_CRC16, /* crc16 sum data blocks */
202 VERIFY_CRC7, /* crc7 sum data blocks */
203 VERIFY_SHA256, /* sha256 sum data blocks */
204 VERIFY_SHA512, /* sha512 sum data blocks */
205 VERIFY_META, /* block_num, timestamp etc. */
206 VERIFY_PATTERN, /* verify a specific pattern */
207 VERIFY_NULL, /* pretend to verify */
208};
209
210/*
211 * A header structure associated with each checksummed data block. It is
212 * followed by a checksum specific header that contains the verification
213 * data.
214 */
215struct verify_header {
216 unsigned int fio_magic;
217 unsigned int len;
218 unsigned int verify_type;
219};
220
221struct vhdr_md5 {
222 uint32_t md5_digest[16];
223};
224struct vhdr_sha512 {
225 uint8_t sha512[128];
226};
227struct vhdr_sha256 {
228 uint8_t sha256[128];
229};
230struct vhdr_crc64 {
231 uint64_t crc64;
232};
233struct vhdr_crc32 {
234 uint32_t crc32;
235};
236struct vhdr_crc16 {
237 uint16_t crc16;
238};
239struct vhdr_crc7 {
240 uint8_t crc7;
241};
242struct vhdr_meta {
243 uint64_t offset;
244 unsigned char thread;
245 unsigned short numberio;
246 unsigned long time_sec;
247 unsigned long time_usec;
248};
249
250struct group_run_stats {
251 unsigned long long max_run[2], min_run[2];
252 unsigned long long max_bw[2], min_bw[2];
253 unsigned long long io_kb[2];
254 unsigned long long agg[2];
255};
256
257/*
258 * What type of allocation to use for io buffers
259 */
260enum fio_memtype {
261 MEM_MALLOC = 0, /* ordinary malloc */
262 MEM_SHM, /* use shared memory segments */
263 MEM_SHMHUGE, /* use shared memory segments with huge pages */
264 MEM_MMAP, /* use anonynomous mmap */
265 MEM_MMAPHUGE, /* memory mapped huge file */
266};
267
268/*
269 * The type of object we are working on
270 */
271enum fio_filetype {
272 FIO_TYPE_FILE = 1, /* plain file */
273 FIO_TYPE_BD, /* block device */
274 FIO_TYPE_CHAR, /* character device */
275 FIO_TYPE_PIPE, /* pipe */
276};
277
278enum fio_ioengine_flags {
279 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
280 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
281 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
282 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
283 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
284 FIO_UNIDIR = 1 << 5, /* engine is uni-directional */
285};
286
287enum fio_file_flags {
288 FIO_FILE_OPEN = 1 << 0, /* file is open */
289 FIO_FILE_CLOSING = 1 << 1, /* file being closed */
290 FIO_FILE_EXISTS = 1 << 2, /* file there */
291 FIO_FILE_EXTEND = 1 << 3, /* needs extend */
292 FIO_FILE_NOSORT = 1 << 4, /* don't sort verify blocks */
293 FIO_FILE_DONE = 1 << 5, /* io completed to this file */
294 FIO_SIZE_KNOWN = 1 << 6, /* size has been set */
295};
296
297/*
298 * Each thread_data structure has a number of files associated with it,
299 * this structure holds state information for a single file.
300 */
301struct fio_file {
302 enum fio_filetype filetype;
303
304 /*
305 * A file may not be a file descriptor, let the io engine decide
306 */
307 union {
308 unsigned long file_data;
309 int fd;
310 };
311
312 /*
313 * filename and possible memory mapping
314 */
315 char *file_name;
316 void *mmap;
317 unsigned int major, minor;
318
319 /*
320 * size of the file, offset into file, and io size from that offset
321 */
322 unsigned long long real_file_size;
323 unsigned long long file_offset;
324 unsigned long long io_size;
325
326 unsigned long long last_pos;
327 unsigned long long last_completed_pos;
328
329 /*
330 * block map for random io
331 */
332 unsigned long *file_map;
333 unsigned int num_maps;
334 unsigned int last_free_lookup;
335
336 int references;
337 enum fio_file_flags flags;
338};
339
340/*
341 * How many depth levels to log
342 */
343#define FIO_IO_U_MAP_NR 8
344#define FIO_IO_U_LAT_U_NR 10
345#define FIO_IO_U_LAT_M_NR 12
346
347struct thread_stat {
348 char *name;
349 char *verror;
350 int error;
351 int groupid;
352 pid_t pid;
353 char *description;
354 int members;
355
356 struct io_log *slat_log;
357 struct io_log *clat_log;
358 struct io_log *bw_log;
359
360 /*
361 * bandwidth and latency stats
362 */
363 struct io_stat clat_stat[2]; /* completion latency */
364 struct io_stat slat_stat[2]; /* submission latency */
365 struct io_stat bw_stat[2]; /* bandwidth stats */
366
367 unsigned long long stat_io_bytes[2];
368 struct timeval stat_sample_time[2];
369
370 /*
371 * fio system usage accounting
372 */
373 struct rusage ru_start;
374 struct rusage ru_end;
375 unsigned long usr_time;
376 unsigned long sys_time;
377 unsigned long ctx;
378
379 /*
380 * IO depth and latency stats
381 */
382 unsigned int io_u_map[FIO_IO_U_MAP_NR];
383 unsigned int io_u_lat_u[FIO_IO_U_LAT_U_NR];
384 unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
385 unsigned long total_io_u[2];
386 unsigned long short_io_u[2];
387
388 unsigned long long io_bytes[2];
389 unsigned long runtime[2];
390 unsigned long total_run_time;
391};
392
393struct thread_options {
394 int pad;
395 char *description;
396 char *name;
397 char *directory;
398 char *filename;
399 char *opendir;
400 char *ioengine;
401 enum td_ddir td_ddir;
402 unsigned int ddir_nr;
403 unsigned int iodepth;
404 unsigned int iodepth_low;
405 unsigned int iodepth_batch;
406
407 unsigned long long size;
408 unsigned long long file_size_low;
409 unsigned long long file_size_high;
410 unsigned long long start_offset;
411
412 unsigned int bs[2];
413 unsigned int min_bs[2];
414 unsigned int max_bs[2];
415
416 unsigned int nr_files;
417 unsigned int open_files;
418
419 unsigned int odirect;
420 unsigned int invalidate_cache;
421 unsigned int create_serialize;
422 unsigned int create_fsync;
423 unsigned int end_fsync;
424 unsigned int sync_io;
425 unsigned int verify;
426 unsigned int do_verify;
427 unsigned int verifysort;
428 unsigned int verify_interval;
429 unsigned int verify_offset;
430 unsigned int verify_pattern;
431 unsigned int verify_pattern_bytes;
432 unsigned int verify_fatal;
433 unsigned int use_thread;
434 unsigned int unlink;
435 unsigned int do_disk_util;
436 unsigned int override_sync;
437 unsigned int rand_repeatable;
438 unsigned int write_lat_log;
439 unsigned int write_bw_log;
440 unsigned int norandommap;
441 unsigned int bs_unaligned;
442 unsigned int fsync_on_close;
443
444 unsigned int hugepage_size;
445 unsigned int rw_min_bs;
446 unsigned int thinktime;
447 unsigned int thinktime_spin;
448 unsigned int thinktime_blocks;
449 unsigned int fsync_blocks;
450 unsigned int start_delay;
451 unsigned long long timeout;
452 unsigned int overwrite;
453 unsigned int bw_avg_time;
454 unsigned int loops;
455 unsigned long long zone_size;
456 unsigned long long zone_skip;
457 enum fio_memtype mem_type;
458
459 unsigned int stonewall;
460 unsigned int new_group;
461 unsigned int numjobs;
462 os_cpu_mask_t cpumask;
463 unsigned int cpumask_set;
464 unsigned int iolog;
465 unsigned int rwmixcycle;
466 unsigned int rwmix[2];
467 unsigned int nice;
468 unsigned int file_service_type;
469 unsigned int group_reporting;
470 unsigned int fadvise_hint;
471 unsigned int zero_buffers;
472 unsigned int time_based;
473
474 char *read_iolog_file;
475 char *write_iolog_file;
476
477 /*
478 * Pre-run and post-run shell
479 */
480 char *exec_prerun;
481 char *exec_postrun;
482
483 unsigned int rate;
484 unsigned int ratemin;
485 unsigned int ratecycle;
486 unsigned int rate_iops;
487 unsigned int rate_iops_min;
488
489 char *ioscheduler;
490
491 /*
492 * CPU "io" cycle burner
493 */
494 unsigned int cpuload;
495 unsigned int cpucycle;
496};
497
498#define FIO_VERROR_SIZE 128
499
500/*
501 * This describes a single thread/process executing a fio job.
502 */
503struct thread_data {
504 struct thread_options o;
505 char verror[FIO_VERROR_SIZE];
506 pthread_t thread;
507 int thread_number;
508 int groupid;
509 struct thread_stat ts;
510 struct fio_file *files;
511 unsigned int files_index;
512 unsigned int nr_open_files;
513 unsigned int nr_done_files;
514 unsigned int nr_normal_files;
515 union {
516 unsigned int next_file;
517 os_random_state_t next_file_state;
518 };
519 int error;
520 int done;
521 pid_t pid;
522 char *orig_buffer;
523 size_t orig_buffer_size;
524 volatile int terminate;
525 volatile int runstate;
526 unsigned int ioprio;
527 unsigned int last_was_sync;
528
529 char *mmapfile;
530 int mmapfd;
531
532 void *iolog_buf;
533 FILE *iolog_f;
534
535 char *sysfs_root;
536
537 os_random_state_t bsrange_state;
538 os_random_state_t verify_state;
539
540 int shm_id;
541
542 /*
543 * IO engine hooks, contains everything needed to submit an io_u
544 * to any of the available IO engines.
545 */
546 struct ioengine_ops *io_ops;
547
548 /*
549 * Current IO depth and list of free and busy io_u's.
550 */
551 unsigned int cur_depth;
552 struct list_head io_u_freelist;
553 struct list_head io_u_busylist;
554 struct list_head io_u_requeues;
555 unsigned int io_u_queued;
556
557 /*
558 * Rate state
559 */
560 unsigned long rate_usec_cycle;
561 long rate_pending_usleep;
562 unsigned long rate_bytes;
563 unsigned long rate_blocks;
564 struct timeval lastrate;
565
566 unsigned long long total_io_size;
567
568 unsigned long io_issues[2];
569 unsigned long long io_blocks[2];
570 unsigned long long io_bytes[2];
571 unsigned long long io_skip_bytes;
572 unsigned long long this_io_bytes[2];
573 unsigned long long zone_bytes;
574 struct fio_sem *mutex;
575
576 /*
577 * State for random io, a bitmap of blocks done vs not done
578 */
579 os_random_state_t random_state;
580
581 struct timeval start; /* start of this loop */
582 struct timeval epoch; /* time job was started */
583 struct timeval rw_end[2];
584 struct timeval last_issue;
585 unsigned int rw_end_set[2];
586
587 /*
588 * read/write mixed workload state
589 */
590 os_random_state_t rwmix_state;
591 unsigned long long rwmix_bytes;
592 struct timeval rwmix_switch;
593 enum fio_ddir rwmix_ddir;
594 unsigned int ddir_nr;
595
596 /*
597 * IO history logs for verification. We use a tree for sorting,
598 * if we are overwriting. Otherwise just use a fifo.
599 */
600 struct rb_root io_hist_tree;
601 struct list_head io_hist_list;
602
603 /*
604 * For IO replaying
605 */
606 struct list_head io_log_list;
607
608 /*
609 * timeout handling
610 */
611 struct timeval timeout_end;
612 struct itimerval timer;
613
614 /*
615 * for fileservice, how often to switch to a new file
616 */
617 unsigned int file_service_nr;
618 unsigned int file_service_left;
619 struct fio_file *file_service_file;
620
621 /*
622 * For generating file sizes
623 */
624 os_random_state_t file_size_state;
625};
626
627/*
628 * roundrobin available files, or choose one at random.
629 */
630enum {
631 FIO_FSERVICE_RANDOM = 1,
632 FIO_FSERVICE_RR = 2,
633};
634
635/*
636 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
637 * the timer on each queue operation.
638 */
639#define IO_U_TIMEOUT_INC 5
640#define IO_U_TIMEOUT 30
641
642#define __td_verror(td, err, msg, func) \
643 do { \
644 if ((td)->error) \
645 break; \
646 int e = (err); \
647 (td)->error = e; \
648 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
649 } while (0)
650
651
652#define td_verror(td, err, func) \
653 __td_verror((td), (err), strerror((err)), (func))
654#define td_vmsg(td, err, msg, func) \
655 __td_verror((td), (err), (msg), (func))
656
657extern int exitall_on_terminate;
658extern int thread_number;
659extern int nr_process, nr_thread;
660extern int shm_id;
661extern int groupid;
662extern int terse_output;
663extern FILE *f_out;
664extern FILE *f_err;
665extern int temp_stall_ts;
666extern unsigned long long mlock_size;
667extern unsigned long page_mask, page_size;
668
669extern struct thread_data *threads;
670
671#define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
672#define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
673#define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
674#define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
675
676#define BLOCKS_PER_MAP (8 * sizeof(long))
677#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
678#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
679#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
680
681#define MAX_JOBS (1024)
682
683static inline int should_fsync(struct thread_data *td)
684{
685 if (td->last_was_sync)
686 return 0;
687 if (td->o.odirect)
688 return 0;
689 if (td_write(td) || td_rw(td) || td->o.override_sync)
690 return 1;
691
692 return 0;
693}
694
695/*
696 * Disk utils as read in /sys/block/<dev>/stat
697 */
698struct disk_util_stat {
699 unsigned ios[2];
700 unsigned merges[2];
701 unsigned long long sectors[2];
702 unsigned ticks[2];
703 unsigned io_ticks;
704 unsigned time_in_queue;
705};
706
707/*
708 * Per-device disk util management
709 */
710struct disk_util {
711 struct list_head list;
712
713 char *name;
714 char *sysfs_root;
715 char path[256];
716 int major, minor;
717
718 struct disk_util_stat dus;
719 struct disk_util_stat last_dus;
720
721 unsigned long msec;
722 struct timeval time;
723};
724
725#define DISK_UTIL_MSEC (250)
726
727/*
728 * Log exports
729 */
730enum file_log_act {
731 FIO_LOG_ADD_FILE,
732 FIO_LOG_OPEN_FILE,
733 FIO_LOG_CLOSE_FILE,
734};
735
736extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
737extern void log_io_u(struct thread_data *, struct io_u *);
738extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
739extern int __must_check init_iolog(struct thread_data *td);
740extern void log_io_piece(struct thread_data *, struct io_u *);
741extern void prune_io_piece_log(struct thread_data *);
742extern void write_iolog_close(struct thread_data *);
743
744/*
745 * Logging
746 */
747extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
748extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
749extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
750extern void show_run_stats(void);
751extern void init_disk_util(struct thread_data *);
752extern void update_rusage_stat(struct thread_data *);
753extern void update_io_ticks(void);
754extern void disk_util_timer_arm(void);
755extern void setup_log(struct io_log **);
756extern void finish_log(struct thread_data *, struct io_log *, const char *);
757extern void __finish_log(struct io_log *, const char *);
758extern struct io_log *agg_io_log[2];
759extern int write_bw_log;
760extern void add_agg_sample(unsigned long, enum fio_ddir);
761
762/*
763 * Time functions
764 */
765extern unsigned long utime_since(struct timeval *, struct timeval *);
766extern unsigned long utime_since_now(struct timeval *);
767extern unsigned long mtime_since(struct timeval *, struct timeval *);
768extern unsigned long mtime_since_now(struct timeval *);
769extern unsigned long time_since_now(struct timeval *);
770extern unsigned long mtime_since_genesis(void);
771extern void __usec_sleep(unsigned int);
772extern void usec_sleep(struct thread_data *, unsigned long);
773extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
774extern void fill_start_time(struct timeval *);
775extern void fio_gettime(struct timeval *, void *);
776extern void set_genesis_time(void);
777
778/*
779 * Init/option functions
780 */
781extern int __must_check parse_options(int, char **);
782extern int fio_option_parse(struct thread_data *, const char *);
783extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
784extern void fio_fill_default_options(struct thread_data *);
785extern int fio_show_option_help(const char *);
786extern void fio_options_dup_and_init(struct option *);
787extern void options_mem_dupe(struct thread_data *);
788extern void options_mem_free(struct thread_data *);
789#define FIO_GETOPT_JOB 0x89988998
790#define FIO_NR_OPTIONS 128
791
792/*
793 * File setup/shutdown
794 */
795extern void close_files(struct thread_data *);
796extern int __must_check setup_files(struct thread_data *);
797extern int __must_check open_files(struct thread_data *);
798extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
799extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
800extern void generic_close_file(struct thread_data *, struct fio_file *);
801extern int add_file(struct thread_data *, const char *);
802extern void get_file(struct fio_file *);
803extern void put_file(struct thread_data *, struct fio_file *);
804extern int add_dir_files(struct thread_data *, const char *);
805extern int init_random_map(struct thread_data *);
806extern void dup_files(struct thread_data *, struct thread_data *);
807extern int get_fileno(struct thread_data *, const char *);
808extern void free_release_files(struct thread_data *);
809
810/*
811 * ETA/status stuff
812 */
813extern void print_thread_status(void);
814extern void print_status_init(int);
815
816/*
817 * disk util stuff
818 */
819#ifdef FIO_HAVE_DISK_UTIL
820extern void show_disk_util(void);
821extern void disk_util_timer_arm(void);
822extern void init_disk_util(struct thread_data *);
823extern void update_io_ticks(void);
824#else
825#define show_disk_util()
826#define disk_util_timer_arm()
827#define init_disk_util(td)
828#define update_io_ticks()
829#endif
830
831/*
832 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
833 * will never back again. It may cycle between running/verififying/fsyncing.
834 * Once the thread reaches TD_EXITED, it is just waiting for the core to
835 * reap it.
836 */
837enum {
838 TD_NOT_CREATED = 0,
839 TD_CREATED,
840 TD_INITIALIZED,
841 TD_RUNNING,
842 TD_VERIFYING,
843 TD_FSYNCING,
844 TD_EXITED,
845 TD_REAPED,
846};
847
848/*
849 * Verify helpers
850 */
851extern void populate_verify_io_u(struct thread_data *, struct io_u *);
852extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
853extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
854
855/*
856 * Memory helpers
857 */
858extern int __must_check fio_pin_memory(void);
859extern void fio_unpin_memory(void);
860extern int __must_check allocate_io_mem(struct thread_data *);
861extern void free_io_mem(struct thread_data *);
862
863/*
864 * io unit handling
865 */
866#define queue_full(td) list_empty(&(td)->io_u_freelist)
867extern struct io_u *__get_io_u(struct thread_data *);
868extern struct io_u *get_io_u(struct thread_data *);
869extern void put_io_u(struct thread_data *, struct io_u *);
870extern void requeue_io_u(struct thread_data *, struct io_u **);
871extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
872extern long __must_check io_u_queued_complete(struct thread_data *, int);
873extern void io_u_queued(struct thread_data *, struct io_u *);
874extern void io_u_log_error(struct thread_data *, struct io_u *);
875extern void io_u_init_timeout(void);
876extern void io_u_set_timeout(struct thread_data *);
877extern void io_u_mark_depth(struct thread_data *, struct io_u *);
878
879/*
880 * io engine entry points
881 */
882extern int __must_check td_io_init(struct thread_data *);
883extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
884extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
885extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
886extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
887extern int __must_check td_io_commit(struct thread_data *);
888extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
889extern void td_io_close_file(struct thread_data *, struct fio_file *);
890
891/*
892 * blktrace support
893 */
894#ifdef FIO_HAVE_BLKTRACE
895extern int is_blktrace(const char *);
896extern int load_blktrace(struct thread_data *, const char *);
897#endif
898
899/*
900 * If logging output to a file, stderr should go to both stderr and f_err
901 */
902#define log_err(args...) do { \
903 fprintf(f_err, ##args); \
904 if (f_err != stderr) \
905 fprintf(stderr, ##args); \
906 } while (0)
907
908#define log_info(args...) fprintf(f_out, ##args)
909
910FILE *get_f_out(void);
911FILE *get_f_err(void);
912
913struct ioengine_ops {
914 struct list_head list;
915 char name[16];
916 int version;
917 int flags;
918 int (*setup)(struct thread_data *);
919 int (*init)(struct thread_data *);
920 int (*prep)(struct thread_data *, struct io_u *);
921 int (*queue)(struct thread_data *, struct io_u *);
922 int (*commit)(struct thread_data *);
923 int (*getevents)(struct thread_data *, int, int, struct timespec *);
924 struct io_u *(*event)(struct thread_data *, int);
925 int (*cancel)(struct thread_data *, struct io_u *);
926 void (*cleanup)(struct thread_data *);
927 int (*open_file)(struct thread_data *, struct fio_file *);
928 void (*close_file)(struct thread_data *, struct fio_file *);
929 void *data;
930 void *dlhandle;
931};
932
933#define FIO_IOOPS_VERSION 7
934
935extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
936extern void register_ioengine(struct ioengine_ops *);
937extern void unregister_ioengine(struct ioengine_ops *);
938extern void close_ioengine(struct thread_data *);
939
940/*
941 * Mark unused variables passed to ops functions as unused, to silence gcc
942 */
943#define fio_unused __attribute((__unused__))
944#define fio_init __attribute__((constructor))
945#define fio_exit __attribute__((destructor))
946
947#define for_each_td(td, i) \
948 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
949#define for_each_file(td, f, i) \
950 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
951
952#define fio_assert(td, cond) do { \
953 if (!(cond)) { \
954 int *__foo = NULL; \
955 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
956 (td)->runstate = TD_EXITED; \
957 (td)->error = EFAULT; \
958 *__foo = 0; \
959 } \
960} while (0)
961
962static inline void clear_error(struct thread_data *td)
963{
964 td->error = 0;
965 td->verror[0] = '\0';
966}
967
968#endif
fio - Flexible IO Tester