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