projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
More random fixes
[fio.git] / fio.h
... / ...
CommitLineData
1#ifndef FIO_H
2#define FIO_H
3
4#include <sched.h>
5#include <limits.h>
6#include <pthread.h>
7#include <sys/time.h>
8#include <sys/resource.h>
9#include <errno.h>
10#include <stdlib.h>
11#include <stdio.h>
12#include <unistd.h>
13#include <string.h>
14#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_EXISTS = 1 << 2, /* file there */
273 FIO_FILE_EXTEND = 1 << 3, /* needs extend */
274 FIO_FILE_NOSORT = 1 << 4, /* don't sort verify blocks */
275 FIO_FILE_DONE = 1 << 5, /* io completed to this file */
276 FIO_SIZE_KNOWN = 1 << 6, /* size has been set */
277};
278
279/*
280 * Each thread_data structure has a number of files associated with it,
281 * this structure holds state information for a single file.
282 */
283struct fio_file {
284 enum fio_filetype filetype;
285
286 /*
287 * A file may not be a file descriptor, let the io engine decide
288 */
289 union {
290 unsigned long file_data;
291 int fd;
292 };
293
294 /*
295 * filename and possible memory mapping
296 */
297 char *file_name;
298 void *mmap;
299 unsigned int major, minor;
300
301 /*
302 * size of the file, offset into file, and io size from that offset
303 */
304 unsigned long long real_file_size;
305 unsigned long long file_offset;
306 unsigned long long io_size;
307
308 unsigned long long last_pos;
309 unsigned long long last_completed_pos;
310
311 /*
312 * block map for random io
313 */
314 unsigned long *file_map;
315 unsigned int num_maps;
316 unsigned int last_free_lookup;
317
318 int references;
319 enum fio_file_flags flags;
320};
321
322/*
323 * How many depth levels to log
324 */
325#define FIO_IO_U_MAP_NR 8
326#define FIO_IO_U_LAT_U_NR 10
327#define FIO_IO_U_LAT_M_NR 12
328
329struct thread_stat {
330 char *name;
331 char *verror;
332 int error;
333 int groupid;
334 pid_t pid;
335 char *description;
336 int members;
337
338 struct io_log *slat_log;
339 struct io_log *clat_log;
340 struct io_log *bw_log;
341
342 /*
343 * bandwidth and latency stats
344 */
345 struct io_stat clat_stat[2]; /* completion latency */
346 struct io_stat slat_stat[2]; /* submission latency */
347 struct io_stat bw_stat[2]; /* bandwidth stats */
348
349 unsigned long long stat_io_bytes[2];
350 struct timeval stat_sample_time[2];
351
352 /*
353 * fio system usage accounting
354 */
355 struct rusage ru_start;
356 struct rusage ru_end;
357 unsigned long usr_time;
358 unsigned long sys_time;
359 unsigned long ctx;
360 unsigned long minf, majf;
361
362 /*
363 * IO depth and latency stats
364 */
365 unsigned int io_u_map[FIO_IO_U_MAP_NR];
366 unsigned int io_u_lat_u[FIO_IO_U_LAT_U_NR];
367 unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
368 unsigned long total_io_u[2];
369 unsigned long short_io_u[2];
370
371 unsigned long long io_bytes[2];
372 unsigned long runtime[2];
373 unsigned long total_run_time;
374};
375
376struct bssplit {
377 unsigned int bs;
378 unsigned char perc;
379};
380
381struct thread_options {
382 int pad;
383 char *description;
384 char *name;
385 char *directory;
386 char *filename;
387 char *opendir;
388 char *ioengine;
389 enum td_ddir td_ddir;
390 unsigned int ddir_nr;
391 unsigned int iodepth;
392 unsigned int iodepth_low;
393 unsigned int iodepth_batch;
394
395 unsigned long long size;
396 unsigned int fill_device;
397 unsigned long long file_size_low;
398 unsigned long long file_size_high;
399 unsigned long long start_offset;
400
401 unsigned int bs[2];
402 unsigned int min_bs[2];
403 unsigned int max_bs[2];
404 struct bssplit *bssplit;
405 unsigned int bssplit_nr;
406
407 unsigned int nr_files;
408 unsigned int open_files;
409
410 unsigned int odirect;
411 unsigned int invalidate_cache;
412 unsigned int create_serialize;
413 unsigned int create_fsync;
414 unsigned int end_fsync;
415 unsigned int sync_io;
416 unsigned int verify;
417 unsigned int do_verify;
418 unsigned int verifysort;
419 unsigned int verify_interval;
420 unsigned int verify_offset;
421 unsigned int verify_pattern;
422 unsigned int verify_pattern_bytes;
423 unsigned int verify_fatal;
424 unsigned int use_thread;
425 unsigned int unlink;
426 unsigned int do_disk_util;
427 unsigned int override_sync;
428 unsigned int rand_repeatable;
429 unsigned int write_lat_log;
430 unsigned int write_bw_log;
431 unsigned int norandommap;
432 unsigned int bs_unaligned;
433 unsigned int fsync_on_close;
434
435 unsigned int hugepage_size;
436 unsigned int rw_min_bs;
437 unsigned int thinktime;
438 unsigned int thinktime_spin;
439 unsigned int thinktime_blocks;
440 unsigned int fsync_blocks;
441 unsigned int start_delay;
442 unsigned long long timeout;
443 unsigned int overwrite;
444 unsigned int bw_avg_time;
445 unsigned int loops;
446 unsigned long long zone_size;
447 unsigned long long zone_skip;
448 enum fio_memtype mem_type;
449
450 unsigned int stonewall;
451 unsigned int new_group;
452 unsigned int numjobs;
453 os_cpu_mask_t cpumask;
454 unsigned int cpumask_set;
455 unsigned int iolog;
456 unsigned int rwmixcycle;
457 unsigned int rwmix[2];
458 unsigned int nice;
459 unsigned int file_service_type;
460 unsigned int group_reporting;
461 unsigned int fadvise_hint;
462 unsigned int zero_buffers;
463 unsigned int time_based;
464
465 char *read_iolog_file;
466 char *write_iolog_file;
467
468 /*
469 * Pre-run and post-run shell
470 */
471 char *exec_prerun;
472 char *exec_postrun;
473
474 unsigned int rate;
475 unsigned int ratemin;
476 unsigned int ratecycle;
477 unsigned int rate_iops;
478 unsigned int rate_iops_min;
479
480 char *ioscheduler;
481
482 /*
483 * CPU "io" cycle burner
484 */
485 unsigned int cpuload;
486 unsigned int cpucycle;
487};
488
489#define FIO_VERROR_SIZE 128
490
491/*
492 * This describes a single thread/process executing a fio job.
493 */
494struct thread_data {
495 struct thread_options o;
496 char verror[FIO_VERROR_SIZE];
497 pthread_t thread;
498 int thread_number;
499 int groupid;
500 struct thread_stat ts;
501 struct fio_file *files;
502 unsigned int files_index;
503 unsigned int nr_open_files;
504 unsigned int nr_done_files;
505 unsigned int nr_normal_files;
506 union {
507 unsigned int next_file;
508 os_random_state_t next_file_state;
509 };
510 int error;
511 int done;
512 pid_t pid;
513 char *orig_buffer;
514 size_t orig_buffer_size;
515 volatile int terminate;
516 volatile int runstate;
517 unsigned int ioprio;
518 unsigned int ioprio_set;
519 unsigned int last_was_sync;
520
521 char *mmapfile;
522 int mmapfd;
523
524 void *iolog_buf;
525 FILE *iolog_f;
526
527 char *sysfs_root;
528
529 os_random_state_t bsrange_state;
530 os_random_state_t verify_state;
531
532 int shm_id;
533
534 /*
535 * IO engine hooks, contains everything needed to submit an io_u
536 * to any of the available IO engines.
537 */
538 struct ioengine_ops *io_ops;
539
540 /*
541 * Current IO depth and list of free and busy io_u's.
542 */
543 unsigned int cur_depth;
544 struct list_head io_u_freelist;
545 struct list_head io_u_busylist;
546 struct list_head io_u_requeues;
547 unsigned int io_u_queued;
548
549 /*
550 * Rate state
551 */
552 unsigned long rate_usec_cycle;
553 long rate_pending_usleep;
554 unsigned long rate_bytes;
555 unsigned long rate_blocks;
556 struct timeval lastrate;
557
558 unsigned long long total_io_size;
559
560 unsigned long io_issues[2];
561 unsigned long long io_blocks[2];
562 unsigned long long io_bytes[2];
563 unsigned long long io_skip_bytes;
564 unsigned long long this_io_bytes[2];
565 unsigned long long zone_bytes;
566 struct fio_sem *mutex;
567
568 /*
569 * State for random io, a bitmap of blocks done vs not done
570 */
571 os_random_state_t random_state;
572
573 struct timeval start; /* start of this loop */
574 struct timeval epoch; /* time job was started */
575 struct timeval rw_end[2];
576 struct timeval last_issue;
577 unsigned int rw_end_set[2];
578
579 /*
580 * read/write mixed workload state
581 */
582 os_random_state_t rwmix_state;
583 unsigned long long rwmix_bytes;
584 struct timeval rwmix_switch;
585 enum fio_ddir rwmix_ddir;
586 unsigned int ddir_nr;
587
588 /*
589 * IO history logs for verification. We use a tree for sorting,
590 * if we are overwriting. Otherwise just use a fifo.
591 */
592 struct rb_root io_hist_tree;
593 struct list_head io_hist_list;
594
595 /*
596 * For IO replaying
597 */
598 struct list_head io_log_list;
599
600 /*
601 * timeout handling
602 */
603 struct timeval timeout_end;
604 struct itimerval timer;
605
606 /*
607 * for fileservice, how often to switch to a new file
608 */
609 unsigned int file_service_nr;
610 unsigned int file_service_left;
611 struct fio_file *file_service_file;
612
613 /*
614 * For generating file sizes
615 */
616 os_random_state_t file_size_state;
617};
618
619/*
620 * roundrobin available files, or choose one at random.
621 */
622enum {
623 FIO_FSERVICE_RANDOM = 1,
624 FIO_FSERVICE_RR = 2,
625};
626
627/*
628 * when should interactive ETA output be generated
629 */
630enum {
631 FIO_ETA_AUTO,
632 FIO_ETA_ALWAYS,
633 FIO_ETA_NEVER,
634};
635
636/*
637 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
638 * the timer on each queue operation.
639 */
640#define IO_U_TIMEOUT_INC 5
641#define IO_U_TIMEOUT 30
642
643#define __td_verror(td, err, msg, func) \
644 do { \
645 if ((td)->error) \
646 break; \
647 int e = (err); \
648 (td)->error = e; \
649 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
650 } while (0)
651
652
653#define td_verror(td, err, func) \
654 __td_verror((td), (err), strerror((err)), (func))
655#define td_vmsg(td, err, msg, func) \
656 __td_verror((td), (err), (msg), (func))
657
658extern int exitall_on_terminate;
659extern int thread_number;
660extern int nr_process, nr_thread;
661extern int shm_id;
662extern int groupid;
663extern int terse_output;
664extern FILE *f_out;
665extern FILE *f_err;
666extern int temp_stall_ts;
667extern unsigned long long mlock_size;
668extern unsigned long page_mask, page_size;
669extern int read_only;
670extern int eta_print;
671extern char *job_section;
672
673extern struct thread_data *threads;
674
675#define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
676#define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
677#define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
678#define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
679
680static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
681{
682 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
683}
684
685#define BLOCKS_PER_MAP (8 * sizeof(long))
686#define TO_MAP_BLOCK(td, f, b) (b)
687#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
688#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
689
690#define MAX_JOBS (1024)
691
692static inline int should_fsync(struct thread_data *td)
693{
694 if (td->last_was_sync)
695 return 0;
696 if (td->o.odirect)
697 return 0;
698 if (td_write(td) || td_rw(td) || td->o.override_sync)
699 return 1;
700
701 return 0;
702}
703
704/*
705 * Disk utils as read in /sys/block/<dev>/stat
706 */
707struct disk_util_stat {
708 unsigned ios[2];
709 unsigned merges[2];
710 unsigned long long sectors[2];
711 unsigned ticks[2];
712 unsigned io_ticks;
713 unsigned time_in_queue;
714};
715
716/*
717 * Per-device disk util management
718 */
719struct disk_util {
720 struct list_head list;
721
722 char *name;
723 char *sysfs_root;
724 char path[256];
725 int major, minor;
726
727 struct disk_util_stat dus;
728 struct disk_util_stat last_dus;
729
730 unsigned long msec;
731 struct timeval time;
732};
733
734#define DISK_UTIL_MSEC (250)
735
736/*
737 * Log exports
738 */
739enum file_log_act {
740 FIO_LOG_ADD_FILE,
741 FIO_LOG_OPEN_FILE,
742 FIO_LOG_CLOSE_FILE,
743};
744
745extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
746extern void log_io_u(struct thread_data *, struct io_u *);
747extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
748extern int __must_check init_iolog(struct thread_data *td);
749extern void log_io_piece(struct thread_data *, struct io_u *);
750extern void prune_io_piece_log(struct thread_data *);
751extern void write_iolog_close(struct thread_data *);
752
753/*
754 * Logging
755 */
756extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
757extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
758extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
759extern void show_run_stats(void);
760extern void init_disk_util(struct thread_data *);
761extern void update_rusage_stat(struct thread_data *);
762extern void update_io_ticks(void);
763extern void disk_util_timer_arm(void);
764extern void setup_log(struct io_log **);
765extern void finish_log(struct thread_data *, struct io_log *, const char *);
766extern void __finish_log(struct io_log *, const char *);
767extern struct io_log *agg_io_log[2];
768extern int write_bw_log;
769extern void add_agg_sample(unsigned long, enum fio_ddir);
770
771/*
772 * Time functions
773 */
774extern unsigned long long utime_since(struct timeval *, struct timeval *);
775extern unsigned long long utime_since_now(struct timeval *);
776extern unsigned long mtime_since(struct timeval *, struct timeval *);
777extern unsigned long mtime_since_now(struct timeval *);
778extern unsigned long time_since_now(struct timeval *);
779extern unsigned long mtime_since_genesis(void);
780extern void __usec_sleep(unsigned int);
781extern void usec_sleep(struct thread_data *, unsigned long);
782extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
783extern void fill_start_time(struct timeval *);
784extern void fio_gettime(struct timeval *, void *);
785extern void set_genesis_time(void);
786
787/*
788 * Init/option functions
789 */
790extern int __must_check parse_options(int, char **);
791extern int fio_option_parse(struct thread_data *, const char *);
792extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
793extern void fio_fill_default_options(struct thread_data *);
794extern int fio_show_option_help(const char *);
795extern void fio_options_dup_and_init(struct option *);
796extern void options_mem_dupe(struct thread_data *);
797extern void options_mem_free(struct thread_data *);
798#define FIO_GETOPT_JOB 0x89988998
799#define FIO_NR_OPTIONS 128
800
801/*
802 * File setup/shutdown
803 */
804extern void close_files(struct thread_data *);
805extern int __must_check setup_files(struct thread_data *);
806extern int __must_check open_files(struct thread_data *);
807extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
808extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
809extern void generic_close_file(struct thread_data *, struct fio_file *);
810extern int add_file(struct thread_data *, const char *);
811extern void get_file(struct fio_file *);
812extern void put_file(struct thread_data *, struct fio_file *);
813extern int add_dir_files(struct thread_data *, const char *);
814extern int init_random_map(struct thread_data *);
815extern void dup_files(struct thread_data *, struct thread_data *);
816extern int get_fileno(struct thread_data *, const char *);
817extern void free_release_files(struct thread_data *);
818
819/*
820 * ETA/status stuff
821 */
822extern void print_thread_status(void);
823extern void print_status_init(int);
824
825/*
826 * disk util stuff
827 */
828#ifdef FIO_HAVE_DISK_UTIL
829extern void show_disk_util(void);
830extern void disk_util_timer_arm(void);
831extern void init_disk_util(struct thread_data *);
832extern void update_io_ticks(void);
833#else
834#define show_disk_util()
835#define disk_util_timer_arm()
836#define init_disk_util(td)
837#define update_io_ticks()
838#endif
839
840/*
841 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
842 * will never back again. It may cycle between running/verififying/fsyncing.
843 * Once the thread reaches TD_EXITED, it is just waiting for the core to
844 * reap it.
845 */
846enum {
847 TD_NOT_CREATED = 0,
848 TD_CREATED,
849 TD_INITIALIZED,
850 TD_RUNNING,
851 TD_VERIFYING,
852 TD_FSYNCING,
853 TD_EXITED,
854 TD_REAPED,
855};
856
857/*
858 * Verify helpers
859 */
860extern void populate_verify_io_u(struct thread_data *, struct io_u *);
861extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
862extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
863
864/*
865 * Memory helpers
866 */
867extern int __must_check fio_pin_memory(void);
868extern void fio_unpin_memory(void);
869extern int __must_check allocate_io_mem(struct thread_data *);
870extern void free_io_mem(struct thread_data *);
871
872/*
873 * io unit handling
874 */
875#define queue_full(td) list_empty(&(td)->io_u_freelist)
876extern struct io_u *__get_io_u(struct thread_data *);
877extern struct io_u *get_io_u(struct thread_data *);
878extern void put_io_u(struct thread_data *, struct io_u *);
879extern void requeue_io_u(struct thread_data *, struct io_u **);
880extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
881extern long __must_check io_u_queued_complete(struct thread_data *, int);
882extern void io_u_queued(struct thread_data *, struct io_u *);
883extern void io_u_log_error(struct thread_data *, struct io_u *);
884extern void io_u_init_timeout(void);
885extern void io_u_set_timeout(struct thread_data *);
886extern void io_u_mark_depth(struct thread_data *, struct io_u *);
887
888/*
889 * io engine entry points
890 */
891extern int __must_check td_io_init(struct thread_data *);
892extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
893extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
894extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
895extern int __must_check td_io_getevents(struct thread_data *, unsigned int, unsigned int, struct timespec *);
896extern int __must_check td_io_commit(struct thread_data *);
897extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
898extern void td_io_close_file(struct thread_data *, struct fio_file *);
899
900/*
901 * blktrace support
902 */
903#ifdef FIO_HAVE_BLKTRACE
904extern int is_blktrace(const char *);
905extern int load_blktrace(struct thread_data *, const char *);
906#endif
907
908/*
909 * If logging output to a file, stderr should go to both stderr and f_err
910 */
911#define log_err(args...) do { \
912 fprintf(f_err, ##args); \
913 if (f_err != stderr) \
914 fprintf(stderr, ##args); \
915 } while (0)
916
917#define log_info(args...) fprintf(f_out, ##args)
918
919FILE *get_f_out(void);
920FILE *get_f_err(void);
921
922struct ioengine_ops {
923 struct list_head list;
924 char name[16];
925 int version;
926 int flags;
927 int (*setup)(struct thread_data *);
928 int (*init)(struct thread_data *);
929 int (*prep)(struct thread_data *, struct io_u *);
930 int (*queue)(struct thread_data *, struct io_u *);
931 int (*commit)(struct thread_data *);
932 int (*getevents)(struct thread_data *, unsigned int, unsigned int, struct timespec *);
933 struct io_u *(*event)(struct thread_data *, int);
934 int (*cancel)(struct thread_data *, struct io_u *);
935 void (*cleanup)(struct thread_data *);
936 int (*open_file)(struct thread_data *, struct fio_file *);
937 void (*close_file)(struct thread_data *, struct fio_file *);
938 void *data;
939 void *dlhandle;
940};
941
942#define FIO_IOOPS_VERSION 8
943
944extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
945extern void register_ioengine(struct ioengine_ops *);
946extern void unregister_ioengine(struct ioengine_ops *);
947extern void close_ioengine(struct thread_data *);
948
949/*
950 * Mark unused variables passed to ops functions as unused, to silence gcc
951 */
952#define fio_unused __attribute((__unused__))
953#define fio_init __attribute__((constructor))
954#define fio_exit __attribute__((destructor))
955
956#define for_each_td(td, i) \
957 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
958#define for_each_file(td, f, i) \
959 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
960
961#define fio_assert(td, cond) do { \
962 if (!(cond)) { \
963 int *__foo = NULL; \
964 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
965 (td)->runstate = TD_EXITED; \
966 (td)->error = EFAULT; \
967 *__foo = 0; \
968 } \
969} while (0)
970
971static inline void clear_error(struct thread_data *td)
972{
973 td->error = 0;
974 td->verror[0] = '\0';
975}
976
977enum {
978 FD_PROCESS = 0,
979 FD_FILE,
980 FD_IO,
981 FD_MEM,
982 FD_BLKTRACE,
983 FD_VERIFY,
984 FD_RANDOM,
985 FD_DEBUG_MAX,
986};
987
988#ifdef FIO_INC_DEBUG
989struct debug_level {
990 const char *name;
991 unsigned long shift;
992};
993extern struct debug_level debug_levels[];
994
995extern unsigned long fio_debug;
996
997#define dprint(type, str, args...) \
998 do { \
999 assert(type < FD_DEBUG_MAX); \
1000 if ((((1 << type)) & fio_debug) == 0) \
1001 break; \
1002 log_info("%-8s ", debug_levels[(type)].name); \
1003 log_info(str, ##args); \
1004 } while (0)
1005
1006static inline void dprint_io_u(struct io_u *io_u, const char *p)
1007{
1008 struct fio_file *f = io_u->file;
1009
1010 dprint(FD_IO, "%s: io_u %p: off=%llu/len=%lu/ddir=%d", p, io_u,
1011 io_u->offset, io_u->buflen, io_u->ddir);
1012 if (fio_debug & (1 << FD_IO)) {
1013 if (f)
1014 log_info("/%s", f->file_name);
1015
1016 log_info("\n");
1017 }
1018}
1019#else
1020#define dprint(type, str, args...)
1021#define dprint_io_u(io_u, p)
1022#endif
1023
1024#endif
fio - Flexible IO Tester