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