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