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