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