Enable read/write sequential offset to be a non-multiple of the block size
[fio.git] / fio.h
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 <inttypes.h>
15 #include <assert.h>
16
17 struct thread_data;
18
19 #include "compiler/compiler.h"
20 #include "flist.h"
21 #include "fifo.h"
22 #include "rbtree.h"
23 #include "arch/arch.h"
24 #include "os/os.h"
25 #include "mutex.h"
26 #include "log.h"
27 #include "debug.h"
28 #include "file.h"
29 #include "io_ddir.h"
30 #include "ioengine.h"
31 #include "iolog.h"
32 #include "helpers.h"
33 #include "options.h"
34 #include "profile.h"
35 #include "time.h"
36 #include "gettime.h"
37 #include "lib/getopt.h"
38 #include "lib/rand.h"
39 #include "server.h"
40 #include "stat.h"
41 #include "flow.h"
42
43 #ifdef FIO_HAVE_GUASI
44 #include <guasi.h>
45 #endif
46
47 #ifdef FIO_HAVE_SOLARISAIO
48 #include <sys/asynch.h>
49 #endif
50
51 /*
52  * What type of allocation to use for io buffers
53  */
54 enum fio_memtype {
55         MEM_MALLOC = 0, /* ordinary malloc */
56         MEM_SHM,        /* use shared memory segments */
57         MEM_SHMHUGE,    /* use shared memory segments with huge pages */
58         MEM_MMAP,       /* use anonynomous mmap */
59         MEM_MMAPHUGE,   /* memory mapped huge file */
60 };
61
62 /*
63  * offset generator types
64  */
65 enum {
66         RW_SEQ_SEQ      = 0,
67         RW_SEQ_IDENT,
68 };
69
70 /*
71  * What type of errors to continue on when continue_on_error is used
72  */
73 enum error_type {
74         ERROR_TYPE_NONE = 0,
75         ERROR_TYPE_READ = 1 << 0,
76         ERROR_TYPE_WRITE = 1 << 1,
77         ERROR_TYPE_VERIFY = 1 << 2,
78         ERROR_TYPE_ANY = 0xffff,
79 };
80
81 struct bssplit {
82         unsigned int bs;
83         unsigned char perc;
84 };
85
86 struct thread_options {
87         int pad;
88         char *description;
89         char *name;
90         char *directory;
91         char *filename;
92         char *opendir;
93         char *ioengine;
94         enum td_ddir td_ddir;
95         unsigned int rw_seq;
96         unsigned int kb_base;
97         unsigned int ddir_seq_nr;
98         long ddir_seq_add;
99         unsigned int iodepth;
100         unsigned int iodepth_low;
101         unsigned int iodepth_batch;
102         unsigned int iodepth_batch_complete;
103
104         unsigned long long size;
105         unsigned int size_percent;
106         unsigned int fill_device;
107         unsigned long long file_size_low;
108         unsigned long long file_size_high;
109         unsigned long long start_offset;
110
111         unsigned int bs[2];
112         unsigned int ba[2];
113         unsigned int min_bs[2];
114         unsigned int max_bs[2];
115         struct bssplit *bssplit[2];
116         unsigned int bssplit_nr[2];
117
118         unsigned int nr_files;
119         unsigned int open_files;
120         enum file_lock_mode file_lock_mode;
121         unsigned int lockfile_batch;
122
123         unsigned int odirect;
124         unsigned int invalidate_cache;
125         unsigned int create_serialize;
126         unsigned int create_fsync;
127         unsigned int create_on_open;
128         unsigned int end_fsync;
129         unsigned int pre_read;
130         unsigned int sync_io;
131         unsigned int verify;
132         unsigned int do_verify;
133         unsigned int verifysort;
134         unsigned int verify_interval;
135         unsigned int verify_offset;
136         char verify_pattern[MAX_PATTERN_SIZE];
137         unsigned int verify_pattern_bytes;
138         unsigned int verify_fatal;
139         unsigned int verify_dump;
140         unsigned int verify_async;
141         unsigned long long verify_backlog;
142         unsigned int verify_batch;
143         unsigned int use_thread;
144         unsigned int unlink;
145         unsigned int do_disk_util;
146         unsigned int override_sync;
147         unsigned int rand_repeatable;
148         unsigned int use_os_rand;
149         unsigned int write_lat_log;
150         unsigned int write_bw_log;
151         unsigned int write_iops_log;
152         unsigned int log_avg_msec;
153         unsigned int norandommap;
154         unsigned int softrandommap;
155         unsigned int bs_unaligned;
156         unsigned int fsync_on_close;
157
158         unsigned int hugepage_size;
159         unsigned int rw_min_bs;
160         unsigned int thinktime;
161         unsigned int thinktime_spin;
162         unsigned int thinktime_blocks;
163         unsigned int fsync_blocks;
164         unsigned int fdatasync_blocks;
165         unsigned int barrier_blocks;
166         unsigned long long start_delay;
167         unsigned long long timeout;
168         unsigned long long ramp_time;
169         unsigned int overwrite;
170         unsigned int bw_avg_time;
171         unsigned int iops_avg_time;
172         unsigned int loops;
173         unsigned long long zone_range;
174         unsigned long long zone_size;
175         unsigned long long zone_skip;
176         enum fio_memtype mem_type;
177         unsigned int mem_align;
178
179         unsigned int stonewall;
180         unsigned int new_group;
181         unsigned int numjobs;
182         os_cpu_mask_t cpumask;
183         unsigned int cpumask_set;
184         os_cpu_mask_t verify_cpumask;
185         unsigned int verify_cpumask_set;
186         unsigned int iolog;
187         unsigned int rwmixcycle;
188         unsigned int rwmix[2];
189         unsigned int nice;
190         unsigned int file_service_type;
191         unsigned int group_reporting;
192         unsigned int fadvise_hint;
193         enum fio_fallocate_mode fallocate_mode;
194         unsigned int zero_buffers;
195         unsigned int refill_buffers;
196         unsigned int scramble_buffers;
197         unsigned int compress_percentage;
198         unsigned int compress_chunk;
199         unsigned int time_based;
200         unsigned int disable_lat;
201         unsigned int disable_clat;
202         unsigned int disable_slat;
203         unsigned int disable_bw;
204         unsigned int gtod_reduce;
205         unsigned int gtod_cpu;
206         unsigned int gtod_offload;
207         enum fio_cs clocksource;
208         unsigned int no_stall;
209         unsigned int trim_percentage;
210         unsigned int trim_batch;
211         unsigned int trim_zero;
212         unsigned long long trim_backlog;
213         unsigned int clat_percentiles;
214         unsigned int overwrite_plist;
215         fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
216
217         char *read_iolog_file;
218         char *write_iolog_file;
219         char *bw_log_file;
220         char *lat_log_file;
221         char *iops_log_file;
222         char *replay_redirect;
223
224         /*
225          * Pre-run and post-run shell
226          */
227         char *exec_prerun;
228         char *exec_postrun;
229
230         unsigned int rate[2];
231         unsigned int ratemin[2];
232         unsigned int ratecycle;
233         unsigned int rate_iops[2];
234         unsigned int rate_iops_min[2];
235
236         char *ioscheduler;
237
238         /*
239          * CPU "io" cycle burner
240          */
241         unsigned int cpuload;
242         unsigned int cpucycle;
243
244         /*
245          * I/O Error handling
246          */
247         enum error_type continue_on_error;
248
249         /*
250          * Benchmark profile type
251          */
252         char *profile;
253
254         /*
255          * blkio cgroup support
256          */
257         char *cgroup;
258         unsigned int cgroup_weight;
259         unsigned int cgroup_nodelete;
260
261         unsigned int uid;
262         unsigned int gid;
263
264         int flow_id;
265         int flow;
266         int flow_watermark;
267         unsigned int flow_sleep;
268
269         unsigned long long offset_increment;
270
271         unsigned int sync_file_range;
272 };
273
274 /*
275  * This describes a single thread/process executing a fio job.
276  */
277 struct thread_data {
278         struct thread_options o;
279         void *eo;
280         char verror[FIO_VERROR_SIZE];
281         pthread_t thread;
282         int thread_number;
283         int groupid;
284         struct thread_stat ts;
285
286         struct io_log *slat_log;
287         struct io_log *clat_log;
288         struct io_log *lat_log;
289         struct io_log *bw_log;
290         struct io_log *iops_log;
291
292         uint64_t stat_io_bytes[2];
293         struct timeval bw_sample_time;
294
295         uint64_t stat_io_blocks[2];
296         struct timeval iops_sample_time;
297
298         struct rusage ru_start;
299         struct rusage ru_end;
300
301         struct fio_file **files;
302         unsigned int files_size;
303         unsigned int files_index;
304         unsigned int nr_open_files;
305         unsigned int nr_done_files;
306         unsigned int nr_normal_files;
307         union {
308                 unsigned int next_file;
309                 os_random_state_t next_file_state;
310                 struct frand_state __next_file_state;
311         };
312         int error;
313         int done;
314         pid_t pid;
315         char *orig_buffer;
316         size_t orig_buffer_size;
317         volatile int terminate;
318         volatile int runstate;
319         unsigned int ioprio;
320         unsigned int ioprio_set;
321         unsigned int last_was_sync;
322         enum fio_ddir last_ddir;
323
324         char *mmapfile;
325         int mmapfd;
326
327         void *iolog_buf;
328         FILE *iolog_f;
329
330         char *sysfs_root;
331
332         unsigned long rand_seeds[8];
333
334         union {
335                 os_random_state_t bsrange_state;
336                 struct frand_state __bsrange_state;
337         };
338         union {
339                 os_random_state_t verify_state;
340                 struct frand_state __verify_state;
341         };
342         union {
343                 os_random_state_t trim_state;
344                 struct frand_state __trim_state;
345         };
346
347         struct frand_state buf_state;
348
349         unsigned int verify_batch;
350         unsigned int trim_batch;
351
352         int shm_id;
353
354         /*
355          * IO engine hooks, contains everything needed to submit an io_u
356          * to any of the available IO engines.
357          */
358         struct ioengine_ops *io_ops;
359
360         /*
361          * Queue depth of io_u's that fio MIGHT do
362          */
363         unsigned int cur_depth;
364
365         /*
366          * io_u's about to be committed
367          */
368         unsigned int io_u_queued;
369
370         /*
371          * io_u's submitted but not completed yet
372          */
373         unsigned int io_u_in_flight;
374
375         /*
376          * List of free and busy io_u's
377          */
378         struct flist_head io_u_freelist;
379         struct flist_head io_u_busylist;
380         struct flist_head io_u_requeues;
381         pthread_mutex_t io_u_lock;
382         pthread_cond_t free_cond;
383
384         /*
385          * async verify offload
386          */
387         struct flist_head verify_list;
388         pthread_t *verify_threads;
389         unsigned int nr_verify_threads;
390         pthread_cond_t verify_cond;
391         int verify_thread_exit;
392
393         /*
394          * Rate state
395          */
396         unsigned long long rate_bps[2];
397         long rate_pending_usleep[2];
398         unsigned long rate_bytes[2];
399         unsigned long rate_blocks[2];
400         struct timeval lastrate[2];
401
402         unsigned long long total_io_size;
403         unsigned long long fill_device_size;
404
405         unsigned long io_issues[2];
406         unsigned long long io_blocks[2];
407         unsigned long long this_io_blocks[2];
408         unsigned long long io_bytes[2];
409         unsigned long long io_skip_bytes;
410         unsigned long long this_io_bytes[2];
411         unsigned long long zone_bytes;
412         struct fio_mutex *mutex;
413
414         /*
415          * State for random io, a bitmap of blocks done vs not done
416          */
417         union {
418                 os_random_state_t random_state;
419                 struct frand_state __random_state;
420         };
421
422         struct timeval start;   /* start of this loop */
423         struct timeval epoch;   /* time job was started */
424         struct timeval last_issue;
425         struct timeval tv_cache;
426         unsigned int tv_cache_nr;
427         unsigned int tv_cache_mask;
428         unsigned int ramp_time_over;
429
430         /*
431          * read/write mixed workload state
432          */
433         union {
434                 os_random_state_t rwmix_state;
435                 struct frand_state __rwmix_state;
436         };
437         unsigned long rwmix_issues;
438         enum fio_ddir rwmix_ddir;
439         unsigned int ddir_seq_nr;
440
441         /*
442          * IO history logs for verification. We use a tree for sorting,
443          * if we are overwriting. Otherwise just use a fifo.
444          */
445         struct rb_root io_hist_tree;
446         struct flist_head io_hist_list;
447         unsigned long io_hist_len;
448
449         /*
450          * For IO replaying
451          */
452         struct flist_head io_log_list;
453
454         /*
455          * For tracking/handling discards
456          */
457         struct flist_head trim_list;
458         unsigned long trim_entries;
459
460         /*
461          * for fileservice, how often to switch to a new file
462          */
463         unsigned int file_service_nr;
464         unsigned int file_service_left;
465         struct fio_file *file_service_file;
466
467         unsigned int sync_file_range_nr;
468
469         /*
470          * For generating file sizes
471          */
472         union {
473                 os_random_state_t file_size_state;
474                 struct frand_state __file_size_state;
475         };
476
477         /*
478          * Error counts
479          */
480         unsigned int total_err_count;
481         int first_error;
482
483         struct fio_flow *flow;
484
485         /*
486          * Can be overloaded by profiles
487          */
488         struct prof_io_ops prof_io_ops;
489         void *prof_data;
490 };
491
492 /*
493  * when should interactive ETA output be generated
494  */
495 enum {
496         FIO_ETA_AUTO,
497         FIO_ETA_ALWAYS,
498         FIO_ETA_NEVER,
499 };
500
501 #define __td_verror(td, err, msg, func)                                 \
502         do {                                                            \
503                 if ((td)->error)                                        \
504                         break;                                          \
505                 int e = (err);                                          \
506                 (td)->error = e;                                        \
507                 if (!(td)->first_error)                                 \
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_clear_error(td)              \
513         (td)->error = 0;
514 #define td_verror(td, err, func)        \
515         __td_verror((td), (err), strerror((err)), (func))
516 #define td_vmsg(td, err, msg, func)     \
517         __td_verror((td), (err), (msg), (func))
518
519 #define __fio_stringify_1(x)    #x
520 #define __fio_stringify(x)      __fio_stringify_1(x)
521
522 extern int exitall_on_terminate;
523 extern unsigned int thread_number;
524 extern unsigned int nr_process, nr_thread;
525 extern int shm_id;
526 extern int groupid;
527 extern int terse_output;
528 extern int temp_stall_ts;
529 extern unsigned long long mlock_size;
530 extern unsigned long page_mask, page_size;
531 extern int read_only;
532 extern int eta_print;
533 extern unsigned long done_secs;
534 extern char *job_section;
535 extern int fio_gtod_offload;
536 extern int fio_gtod_cpu;
537 extern enum fio_cs fio_clock_source;
538 extern int warnings_fatal;
539 extern int terse_version;
540 extern int is_backend;
541 extern int nr_clients;
542 extern int log_syslog;
543 extern const char fio_version_string[];
544 extern const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN];
545
546 extern struct thread_data *threads;
547
548 static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
549 {
550         assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
551 }
552
553 #define BLOCKS_PER_MAP          (8 * sizeof(unsigned long))
554 #define TO_MAP_BLOCK(f, b)      (b)
555 #define RAND_MAP_IDX(f, b)      (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
556 #define RAND_MAP_BIT(f, b)      (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
557
558 #define REAL_MAX_JOBS           2048
559
560 #define td_non_fatal_error(e)   ((e) == EIO || (e) == EILSEQ)
561
562 static inline enum error_type td_error_type(enum fio_ddir ddir, int err)
563 {
564         if (err == EILSEQ)
565                 return ERROR_TYPE_VERIFY;
566         if (ddir == DDIR_READ)
567                 return ERROR_TYPE_READ;
568         return ERROR_TYPE_WRITE;
569 }
570
571 static inline void update_error_count(struct thread_data *td, int err)
572 {
573         td->total_err_count++;
574         if (td->total_err_count == 1)
575                 td->first_error = err;
576 }
577
578 static inline int should_fsync(struct thread_data *td)
579 {
580         if (td->last_was_sync)
581                 return 0;
582         if (td->o.odirect)
583                 return 0;
584         if (td_write(td) || td_rw(td) || td->o.override_sync)
585                 return 1;
586
587         return 0;
588 }
589
590 /*
591  * Init/option functions
592  */
593 extern int __must_check parse_options(int, char **);
594 extern int parse_jobs_ini(char *, int, int);
595 extern int parse_cmd_line(int, char **);
596 extern int fio_backend(void);
597 extern void reset_fio_state(void);
598 extern void clear_io_state(struct thread_data *);
599 extern int fio_options_parse(struct thread_data *, char **, int);
600 extern void fio_keywords_init(void);
601 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
602 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
603 extern void fio_fill_default_options(struct thread_data *);
604 extern int fio_show_option_help(const char *);
605 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
606 extern void fio_options_dup_and_init(struct option *);
607 extern void fio_options_mem_dupe(struct thread_data *);
608 extern void options_mem_dupe(void *data, struct fio_option *options);
609 extern void td_fill_rand_seeds(struct thread_data *);
610 extern void add_job_opts(const char **);
611 extern char *num2str(unsigned long, int, int, int);
612 extern int ioengine_load(struct thread_data *);
613
614 #define FIO_GETOPT_JOB          0x89000000
615 #define FIO_GETOPT_IOENGINE     0x98000000
616 #define FIO_NR_OPTIONS          (FIO_MAX_OPTS + 128)
617
618 /*
619  * ETA/status stuff
620  */
621 extern void print_thread_status(void);
622 extern void print_status_init(int);
623
624 /*
625  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
626  * will never back again. It may cycle between running/verififying/fsyncing.
627  * Once the thread reaches TD_EXITED, it is just waiting for the core to
628  * reap it.
629  */
630 enum {
631         TD_NOT_CREATED = 0,
632         TD_CREATED,
633         TD_INITIALIZED,
634         TD_RAMP,
635         TD_RUNNING,
636         TD_PRE_READING,
637         TD_VERIFYING,
638         TD_FSYNCING,
639         TD_EXITED,
640         TD_REAPED,
641 };
642
643 extern void td_set_runstate(struct thread_data *, int);
644 #define TERMINATE_ALL           (-1)
645 extern void fio_terminate_threads(int);
646
647 /*
648  * Memory helpers
649  */
650 extern int __must_check fio_pin_memory(void);
651 extern void fio_unpin_memory(void);
652 extern int __must_check allocate_io_mem(struct thread_data *);
653 extern void free_io_mem(struct thread_data *);
654
655 /*
656  * Reset stats after ramp time completes
657  */
658 extern void reset_all_stats(struct thread_data *);
659
660 /*
661  * blktrace support
662  */
663 #ifdef FIO_HAVE_BLKTRACE
664 extern int is_blktrace(const char *);
665 extern int load_blktrace(struct thread_data *, const char *);
666 #endif
667
668 /*
669  * Mark unused variables passed to ops functions as unused, to silence gcc
670  */
671 #define fio_unused      __attribute((__unused__))
672 #define fio_init        __attribute__((constructor))
673 #define fio_exit        __attribute__((destructor))
674
675 #define for_each_td(td, i)      \
676         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
677 #define for_each_file(td, f, i) \
678         if ((td)->files_index)                                          \
679                 for ((i) = 0, (f) = (td)->files[0];                     \
680                  (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
681                  (i)++)
682
683 #define fio_assert(td, cond)    do {    \
684         if (!(cond)) {                  \
685                 int *__foo = NULL;      \
686                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
687                 td_set_runstate((td), TD_EXITED);       \
688                 (td)->error = EFAULT;           \
689                 *__foo = 0;                     \
690         }       \
691 } while (0)
692
693 static inline int fio_fill_issue_time(struct thread_data *td)
694 {
695         if (td->o.read_iolog_file ||
696             !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
697                 return 1;
698
699         return 0;
700 }
701
702 static inline int __should_check_rate(struct thread_data *td,
703                                       enum fio_ddir ddir)
704 {
705         struct thread_options *o = &td->o;
706
707         /*
708          * If some rate setting was given, we need to check it
709          */
710         if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
711             o->rate_iops_min[ddir])
712                 return 1;
713
714         return 0;
715 }
716
717 static inline int should_check_rate(struct thread_data *td,
718                                     unsigned long *bytes_done)
719 {
720         int ret = 0;
721
722         if (bytes_done[0])
723                 ret |= __should_check_rate(td, 0);
724         if (bytes_done[1])
725                 ret |= __should_check_rate(td, 1);
726
727         return ret;
728 }
729
730 static inline int is_power_of_2(unsigned int val)
731 {
732         return (val != 0 && ((val & (val - 1)) == 0));
733 }
734
735 /*
736  * We currently only need to do locking if we have verifier threads
737  * accessing our internal structures too
738  */
739 static inline void td_io_u_lock(struct thread_data *td)
740 {
741         if (td->o.verify_async)
742                 pthread_mutex_lock(&td->io_u_lock);
743 }
744
745 static inline void td_io_u_unlock(struct thread_data *td)
746 {
747         if (td->o.verify_async)
748                 pthread_mutex_unlock(&td->io_u_lock);
749 }
750
751 static inline void td_io_u_free_notify(struct thread_data *td)
752 {
753         if (td->o.verify_async)
754                 pthread_cond_signal(&td->free_cond);
755 }
756
757 extern const char *fio_get_arch_string(int);
758 extern const char *fio_get_os_string(int);
759
760 #endif