projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
->getevents() should take unsigned args
[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_PATTERN, /* verify a specific pattern */
188 VERIFY_NULL, /* pretend to verify */
189};
190
191/*
192 * A header structure associated with each checksummed data block. It is
193 * followed by a checksum specific header that contains the verification
194 * data.
195 */
196struct verify_header {
197 unsigned int fio_magic;
198 unsigned int len;
199 unsigned int verify_type;
200};
201
202struct vhdr_md5 {
203 uint32_t md5_digest[16];
204};
205struct vhdr_sha512 {
206 uint8_t sha512[128];
207};
208struct vhdr_sha256 {
209 uint8_t sha256[128];
210};
211struct vhdr_crc64 {
212 uint64_t crc64;
213};
214struct vhdr_crc32 {
215 uint32_t crc32;
216};
217struct vhdr_crc16 {
218 uint16_t crc16;
219};
220struct vhdr_crc7 {
221 uint8_t crc7;
222};
223struct vhdr_meta {
224 uint64_t offset;
225 unsigned char thread;
226 unsigned short numberio;
227 unsigned long time_sec;
228 unsigned long time_usec;
229};
230
231struct group_run_stats {
232 unsigned long long max_run[2], min_run[2];
233 unsigned long long max_bw[2], min_bw[2];
234 unsigned long long io_kb[2];
235 unsigned long long agg[2];
236};
237
238/*
239 * What type of allocation to use for io buffers
240 */
241enum fio_memtype {
242 MEM_MALLOC = 0, /* ordinary malloc */
243 MEM_SHM, /* use shared memory segments */
244 MEM_SHMHUGE, /* use shared memory segments with huge pages */
245 MEM_MMAP, /* use anonynomous mmap */
246 MEM_MMAPHUGE, /* memory mapped huge file */
247};
248
249/*
250 * The type of object we are working on
251 */
252enum fio_filetype {
253 FIO_TYPE_FILE = 1, /* plain file */
254 FIO_TYPE_BD, /* block device */
255 FIO_TYPE_CHAR, /* character device */
256 FIO_TYPE_PIPE, /* pipe */
257};
258
259enum fio_ioengine_flags {
260 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
261 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
262 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
263 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
264 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
265 FIO_UNIDIR = 1 << 5, /* engine is uni-directional */
266 FIO_NOIO = 1 << 6, /* thread does only pseudo IO */
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 thread_options {
377 int pad;
378 char *description;
379 char *name;
380 char *directory;
381 char *filename;
382 char *opendir;
383 char *ioengine;
384 enum td_ddir td_ddir;
385 unsigned int ddir_nr;
386 unsigned int iodepth;
387 unsigned int iodepth_low;
388 unsigned int iodepth_batch;
389
390 unsigned long long size;
391 unsigned long long file_size_low;
392 unsigned long long file_size_high;
393 unsigned long long start_offset;
394
395 unsigned int bs[2];
396 unsigned int min_bs[2];
397 unsigned int max_bs[2];
398
399 unsigned int nr_files;
400 unsigned int open_files;
401
402 unsigned int odirect;
403 unsigned int invalidate_cache;
404 unsigned int create_serialize;
405 unsigned int create_fsync;
406 unsigned int end_fsync;
407 unsigned int sync_io;
408 unsigned int verify;
409 unsigned int do_verify;
410 unsigned int verifysort;
411 unsigned int verify_interval;
412 unsigned int verify_offset;
413 unsigned int verify_pattern;
414 unsigned int verify_pattern_bytes;
415 unsigned int verify_fatal;
416 unsigned int use_thread;
417 unsigned int unlink;
418 unsigned int do_disk_util;
419 unsigned int override_sync;
420 unsigned int rand_repeatable;
421 unsigned int write_lat_log;
422 unsigned int write_bw_log;
423 unsigned int norandommap;
424 unsigned int bs_unaligned;
425 unsigned int fsync_on_close;
426
427 unsigned int hugepage_size;
428 unsigned int rw_min_bs;
429 unsigned int thinktime;
430 unsigned int thinktime_spin;
431 unsigned int thinktime_blocks;
432 unsigned int fsync_blocks;
433 unsigned int start_delay;
434 unsigned long long timeout;
435 unsigned int overwrite;
436 unsigned int bw_avg_time;
437 unsigned int loops;
438 unsigned long long zone_size;
439 unsigned long long zone_skip;
440 enum fio_memtype mem_type;
441
442 unsigned int stonewall;
443 unsigned int new_group;
444 unsigned int numjobs;
445 os_cpu_mask_t cpumask;
446 unsigned int cpumask_set;
447 unsigned int iolog;
448 unsigned int rwmixcycle;
449 unsigned int rwmix[2];
450 unsigned int nice;
451 unsigned int file_service_type;
452 unsigned int group_reporting;
453 unsigned int fadvise_hint;
454 unsigned int zero_buffers;
455 unsigned int time_based;
456
457 char *read_iolog_file;
458 char *write_iolog_file;
459
460 /*
461 * Pre-run and post-run shell
462 */
463 char *exec_prerun;
464 char *exec_postrun;
465
466 unsigned int rate;
467 unsigned int ratemin;
468 unsigned int ratecycle;
469 unsigned int rate_iops;
470 unsigned int rate_iops_min;
471
472 char *ioscheduler;
473
474 /*
475 * CPU "io" cycle burner
476 */
477 unsigned int cpuload;
478 unsigned int cpucycle;
479};
480
481#define FIO_VERROR_SIZE 128
482
483/*
484 * This describes a single thread/process executing a fio job.
485 */
486struct thread_data {
487 struct thread_options o;
488 char verror[FIO_VERROR_SIZE];
489 pthread_t thread;
490 int thread_number;
491 int groupid;
492 struct thread_stat ts;
493 struct fio_file *files;
494 unsigned int files_index;
495 unsigned int nr_open_files;
496 unsigned int nr_done_files;
497 unsigned int nr_normal_files;
498 union {
499 unsigned int next_file;
500 os_random_state_t next_file_state;
501 };
502 int error;
503 int done;
504 pid_t pid;
505 char *orig_buffer;
506 size_t orig_buffer_size;
507 volatile int terminate;
508 volatile int runstate;
509 unsigned int ioprio;
510 unsigned int ioprio_set;
511 unsigned int last_was_sync;
512
513 char *mmapfile;
514 int mmapfd;
515
516 void *iolog_buf;
517 FILE *iolog_f;
518
519 char *sysfs_root;
520
521 os_random_state_t bsrange_state;
522 os_random_state_t verify_state;
523
524 int shm_id;
525
526 /*
527 * IO engine hooks, contains everything needed to submit an io_u
528 * to any of the available IO engines.
529 */
530 struct ioengine_ops *io_ops;
531
532 /*
533 * Current IO depth and list of free and busy io_u's.
534 */
535 unsigned int cur_depth;
536 struct list_head io_u_freelist;
537 struct list_head io_u_busylist;
538 struct list_head io_u_requeues;
539 unsigned int io_u_queued;
540
541 /*
542 * Rate state
543 */
544 unsigned long rate_usec_cycle;
545 long rate_pending_usleep;
546 unsigned long rate_bytes;
547 unsigned long rate_blocks;
548 struct timeval lastrate;
549
550 unsigned long long total_io_size;
551
552 unsigned long io_issues[2];
553 unsigned long long io_blocks[2];
554 unsigned long long io_bytes[2];
555 unsigned long long io_skip_bytes;
556 unsigned long long this_io_bytes[2];
557 unsigned long long zone_bytes;
558 struct fio_sem *mutex;
559
560 /*
561 * State for random io, a bitmap of blocks done vs not done
562 */
563 os_random_state_t random_state;
564
565 struct timeval start; /* start of this loop */
566 struct timeval epoch; /* time job was started */
567 struct timeval rw_end[2];
568 struct timeval last_issue;
569 unsigned int rw_end_set[2];
570
571 /*
572 * read/write mixed workload state
573 */
574 os_random_state_t rwmix_state;
575 unsigned long long rwmix_bytes;
576 struct timeval rwmix_switch;
577 enum fio_ddir rwmix_ddir;
578 unsigned int ddir_nr;
579
580 /*
581 * IO history logs for verification. We use a tree for sorting,
582 * if we are overwriting. Otherwise just use a fifo.
583 */
584 struct rb_root io_hist_tree;
585 struct list_head io_hist_list;
586
587 /*
588 * For IO replaying
589 */
590 struct list_head io_log_list;
591
592 /*
593 * timeout handling
594 */
595 struct timeval timeout_end;
596 struct itimerval timer;
597
598 /*
599 * for fileservice, how often to switch to a new file
600 */
601 unsigned int file_service_nr;
602 unsigned int file_service_left;
603 struct fio_file *file_service_file;
604
605 /*
606 * For generating file sizes
607 */
608 os_random_state_t file_size_state;
609};
610
611/*
612 * roundrobin available files, or choose one at random.
613 */
614enum {
615 FIO_FSERVICE_RANDOM = 1,
616 FIO_FSERVICE_RR = 2,
617};
618
619/*
620 * when should interactive ETA output be generated
621 */
622enum {
623 FIO_ETA_AUTO,
624 FIO_ETA_ALWAYS,
625 FIO_ETA_NEVER,
626};
627
628/*
629 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
630 * the timer on each queue operation.
631 */
632#define IO_U_TIMEOUT_INC 5
633#define IO_U_TIMEOUT 30
634
635#define __td_verror(td, err, msg, func) \
636 do { \
637 if ((td)->error) \
638 break; \
639 int e = (err); \
640 (td)->error = e; \
641 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
642 } while (0)
643
644
645#define td_verror(td, err, func) \
646 __td_verror((td), (err), strerror((err)), (func))
647#define td_vmsg(td, err, msg, func) \
648 __td_verror((td), (err), (msg), (func))
649
650extern int exitall_on_terminate;
651extern int thread_number;
652extern int nr_process, nr_thread;
653extern int shm_id;
654extern int groupid;
655extern int terse_output;
656extern FILE *f_out;
657extern FILE *f_err;
658extern int temp_stall_ts;
659extern unsigned long long mlock_size;
660extern unsigned long page_mask, page_size;
661extern int read_only;
662extern int eta_print;
663
664extern struct thread_data *threads;
665
666#define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
667#define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
668#define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
669#define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
670
671static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
672{
673 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
674}
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 long utime_since(struct timeval *, struct timeval *);
766extern unsigned long 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 *, unsigned int, unsigned 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 *, unsigned int, unsigned 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