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