fio-genzipf results output are slightly wrong, it doesn't help to understand how...
[fio.git] / thread_options.h
1 #ifndef FIO_THREAD_OPTIONS_H
2 #define FIO_THREAD_OPTIONS_H
3
4 #include "arch/arch.h"
5 #include "os/os.h"
6 #include "options.h"
7 #include "stat.h"
8 #include "gettime.h"
9 #include "lib/ieee754.h"
10 #include "td_error.h"
11
12 /*
13  * What type of allocation to use for io buffers
14  */
15 enum fio_memtype {
16         MEM_MALLOC = 0, /* ordinary malloc */
17         MEM_SHM,        /* use shared memory segments */
18         MEM_SHMHUGE,    /* use shared memory segments with huge pages */
19         MEM_MMAP,       /* use anonynomous mmap */
20         MEM_MMAPHUGE,   /* memory mapped huge file */
21 };
22
23 #define ERROR_STR_MAX   128
24
25 #define BSSPLIT_MAX     64
26
27 struct bssplit {
28         uint32_t bs;
29         uint32_t perc;
30 };
31
32 #define NR_OPTS_SZ      (FIO_MAX_OPTS / (8 * sizeof(uint64_t)))
33
34 #define OPT_MAGIC       0x4f50544e
35
36 struct thread_options {
37         int magic;
38         uint64_t set_options[NR_OPTS_SZ];
39         char *description;
40         char *name;
41         char *directory;
42         char *filename;
43         char *filename_format;
44         char *opendir;
45         char *ioengine;
46         char *mmapfile;
47         enum td_ddir td_ddir;
48         unsigned int rw_seq;
49         unsigned int kb_base;
50         unsigned int unit_base;
51         unsigned int ddir_seq_nr;
52         long long ddir_seq_add;
53         unsigned int iodepth;
54         unsigned int iodepth_low;
55         unsigned int iodepth_batch;
56         unsigned int iodepth_batch_complete;
57
58         unsigned long long size;
59         unsigned long long io_limit;
60         unsigned int size_percent;
61         unsigned int fill_device;
62         unsigned int file_append;
63         unsigned long long file_size_low;
64         unsigned long long file_size_high;
65         unsigned long long start_offset;
66
67         unsigned int bs[DDIR_RWDIR_CNT];
68         unsigned int ba[DDIR_RWDIR_CNT];
69         unsigned int min_bs[DDIR_RWDIR_CNT];
70         unsigned int max_bs[DDIR_RWDIR_CNT];
71         struct bssplit *bssplit[DDIR_RWDIR_CNT];
72         unsigned int bssplit_nr[DDIR_RWDIR_CNT];
73
74         int *ignore_error[ERROR_TYPE_CNT];
75         unsigned int ignore_error_nr[ERROR_TYPE_CNT];
76         unsigned int error_dump;
77
78         unsigned int nr_files;
79         unsigned int open_files;
80         enum file_lock_mode file_lock_mode;
81
82         unsigned int odirect;
83         unsigned int oatomic;
84         unsigned int invalidate_cache;
85         unsigned int create_serialize;
86         unsigned int create_fsync;
87         unsigned int create_on_open;
88         unsigned int create_only;
89         unsigned int end_fsync;
90         unsigned int pre_read;
91         unsigned int sync_io;
92         unsigned int verify;
93         unsigned int do_verify;
94         unsigned int verifysort;
95         unsigned int verifysort_nr;
96         unsigned int verify_interval;
97         unsigned int verify_offset;
98         char verify_pattern[MAX_PATTERN_SIZE];
99         unsigned int verify_pattern_bytes;
100         unsigned int verify_fatal;
101         unsigned int verify_dump;
102         unsigned int verify_async;
103         unsigned long long verify_backlog;
104         unsigned int verify_batch;
105         unsigned int experimental_verify;
106         unsigned int verify_state;
107         unsigned int verify_state_save;
108         unsigned int use_thread;
109         unsigned int unlink;
110         unsigned int do_disk_util;
111         unsigned int override_sync;
112         unsigned int rand_repeatable;
113         unsigned int allrand_repeatable;
114         unsigned long long rand_seed;
115         unsigned int dep_use_os_rand;
116         unsigned int log_avg_msec;
117         unsigned int log_offset;
118         unsigned int log_gz;
119         unsigned int log_gz_store;
120         unsigned int norandommap;
121         unsigned int softrandommap;
122         unsigned int bs_unaligned;
123         unsigned int fsync_on_close;
124         unsigned int bs_is_seq_rand;
125
126         unsigned int verify_only;
127
128         unsigned int random_distribution;
129
130         fio_fp64_t zipf_theta;
131         fio_fp64_t pareto_h;
132
133         unsigned int random_generator;
134
135         unsigned int perc_rand[DDIR_RWDIR_CNT];
136
137         unsigned int hugepage_size;
138         unsigned int rw_min_bs;
139         unsigned int thinktime;
140         unsigned int thinktime_spin;
141         unsigned int thinktime_blocks;
142         unsigned int fsync_blocks;
143         unsigned int fdatasync_blocks;
144         unsigned int barrier_blocks;
145         unsigned long long start_delay;
146         unsigned long long start_delay_high;
147         unsigned long long timeout;
148         unsigned long long ramp_time;
149         unsigned int overwrite;
150         unsigned int bw_avg_time;
151         unsigned int iops_avg_time;
152         unsigned int loops;
153         unsigned long long zone_range;
154         unsigned long long zone_size;
155         unsigned long long zone_skip;
156         unsigned long long lockmem;
157         enum fio_memtype mem_type;
158         unsigned int mem_align;
159
160         unsigned int max_latency;
161
162         unsigned int stonewall;
163         unsigned int new_group;
164         unsigned int numjobs;
165         os_cpu_mask_t cpumask;
166         os_cpu_mask_t verify_cpumask;
167         unsigned int cpus_allowed_policy;
168         char *numa_cpunodes;
169         unsigned short numa_mem_mode;
170         unsigned int numa_mem_prefer_node;
171         char *numa_memnodes;
172         unsigned int iolog;
173         unsigned int rwmixcycle;
174         unsigned int rwmix[DDIR_RWDIR_CNT];
175         unsigned int nice;
176         unsigned int ioprio;
177         unsigned int ioprio_class;
178         unsigned int file_service_type;
179         unsigned int group_reporting;
180         unsigned int fadvise_hint;
181         unsigned int fadvise_stream;
182         enum fio_fallocate_mode fallocate_mode;
183         unsigned int zero_buffers;
184         unsigned int refill_buffers;
185         unsigned int scramble_buffers;
186         char buffer_pattern[MAX_PATTERN_SIZE];
187         unsigned int buffer_pattern_bytes;
188         unsigned int compress_percentage;
189         unsigned int compress_chunk;
190         unsigned int dedupe_percentage;
191         unsigned int time_based;
192         unsigned int disable_lat;
193         unsigned int disable_clat;
194         unsigned int disable_slat;
195         unsigned int disable_bw;
196         unsigned int unified_rw_rep;
197         unsigned int gtod_reduce;
198         unsigned int gtod_cpu;
199         enum fio_cs clocksource;
200         unsigned int no_stall;
201         unsigned int trim_percentage;
202         unsigned int trim_batch;
203         unsigned int trim_zero;
204         unsigned long long trim_backlog;
205         unsigned int clat_percentiles;
206         unsigned int percentile_precision;      /* digits after decimal for percentiles */
207         fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
208
209         char *read_iolog_file;
210         char *write_iolog_file;
211         char *bw_log_file;
212         char *lat_log_file;
213         char *iops_log_file;
214         char *replay_redirect;
215
216         /*
217          * Pre-run and post-run shell
218          */
219         char *exec_prerun;
220         char *exec_postrun;
221
222         unsigned int rate[DDIR_RWDIR_CNT];
223         unsigned int ratemin[DDIR_RWDIR_CNT];
224         unsigned int ratecycle;
225         unsigned int rate_iops[DDIR_RWDIR_CNT];
226         unsigned int rate_iops_min[DDIR_RWDIR_CNT];
227
228         char *ioscheduler;
229
230         /*
231          * I/O Error handling
232          */
233         enum error_type continue_on_error;
234
235         /*
236          * Benchmark profile type
237          */
238         char *profile;
239
240         /*
241          * blkio cgroup support
242          */
243         char *cgroup;
244         unsigned int cgroup_weight;
245         unsigned int cgroup_nodelete;
246
247         unsigned int uid;
248         unsigned int gid;
249
250         int flow_id;
251         int flow;
252         int flow_watermark;
253         unsigned int flow_sleep;
254
255         unsigned long long offset_increment;
256         unsigned long long number_ios;
257
258         unsigned int sync_file_range;
259
260         unsigned long long latency_target;
261         unsigned long long latency_window;
262         fio_fp64_t latency_percentile;
263 };
264
265 #define FIO_TOP_STR_MAX         256
266
267 struct thread_options_pack {
268         uint64_t set_options[NR_OPTS_SZ];
269         uint8_t description[FIO_TOP_STR_MAX];
270         uint8_t name[FIO_TOP_STR_MAX];
271         uint8_t directory[FIO_TOP_STR_MAX];
272         uint8_t filename[FIO_TOP_STR_MAX];
273         uint8_t filename_format[FIO_TOP_STR_MAX];
274         uint8_t opendir[FIO_TOP_STR_MAX];
275         uint8_t ioengine[FIO_TOP_STR_MAX];
276         uint8_t mmapfile[FIO_TOP_STR_MAX];
277         uint32_t td_ddir;
278         uint32_t rw_seq;
279         uint32_t kb_base;
280         uint32_t unit_base;
281         uint32_t ddir_seq_nr;
282         uint64_t ddir_seq_add;
283         uint32_t iodepth;
284         uint32_t iodepth_low;
285         uint32_t iodepth_batch;
286         uint32_t iodepth_batch_complete;
287
288         uint64_t size;
289         uint64_t io_limit;
290         uint32_t size_percent;
291         uint32_t fill_device;
292         uint32_t file_append;
293         uint64_t file_size_low;
294         uint64_t file_size_high;
295         uint64_t start_offset;
296
297         uint32_t bs[DDIR_RWDIR_CNT];
298         uint32_t ba[DDIR_RWDIR_CNT];
299         uint32_t min_bs[DDIR_RWDIR_CNT];
300         uint32_t max_bs[DDIR_RWDIR_CNT];
301         struct bssplit bssplit[DDIR_RWDIR_CNT][BSSPLIT_MAX];
302         uint32_t bssplit_nr[DDIR_RWDIR_CNT];
303
304         uint32_t ignore_error[ERROR_TYPE_CNT][ERROR_STR_MAX];
305         uint32_t ignore_error_nr[ERROR_TYPE_CNT];
306         uint32_t error_dump;
307
308         uint32_t nr_files;
309         uint32_t open_files;
310         uint32_t file_lock_mode;
311
312         uint32_t odirect;
313         uint32_t oatomic;
314         uint32_t invalidate_cache;
315         uint32_t create_serialize;
316         uint32_t create_fsync;
317         uint32_t create_on_open;
318         uint32_t create_only;
319         uint32_t end_fsync;
320         uint32_t pre_read;
321         uint32_t sync_io;
322         uint32_t verify;
323         uint32_t do_verify;
324         uint32_t verifysort;
325         uint32_t verifysort_nr;
326         uint32_t verify_interval;
327         uint32_t verify_offset;
328         uint8_t verify_pattern[MAX_PATTERN_SIZE];
329         uint32_t verify_pattern_bytes;
330         uint32_t verify_fatal;
331         uint32_t verify_dump;
332         uint32_t verify_async;
333         uint64_t verify_backlog;
334         uint32_t verify_batch;
335         uint32_t experimental_verify;
336         uint32_t verify_state;
337         uint32_t verify_state_save;
338         uint32_t use_thread;
339         uint32_t unlink;
340         uint32_t do_disk_util;
341         uint32_t override_sync;
342         uint32_t rand_repeatable;
343         uint32_t allrand_repeatable;
344         uint64_t rand_seed;
345         uint32_t dep_use_os_rand;
346         uint32_t log_avg_msec;
347         uint32_t log_offset;
348         uint32_t log_gz;
349         uint32_t log_gz_store;
350         uint32_t norandommap;
351         uint32_t softrandommap;
352         uint32_t bs_unaligned;
353         uint32_t fsync_on_close;
354         uint32_t bs_is_seq_rand;
355
356         uint32_t random_distribution;
357         uint32_t pad;
358         fio_fp64_t zipf_theta;
359         fio_fp64_t pareto_h;
360
361         uint32_t random_generator;
362
363         uint32_t perc_rand[DDIR_RWDIR_CNT];
364
365         uint32_t hugepage_size;
366         uint32_t rw_min_bs;
367         uint32_t thinktime;
368         uint32_t thinktime_spin;
369         uint32_t thinktime_blocks;
370         uint32_t fsync_blocks;
371         uint32_t fdatasync_blocks;
372         uint32_t barrier_blocks;
373         uint64_t start_delay;
374         uint64_t start_delay_high;
375         uint64_t timeout;
376         uint64_t ramp_time;
377         uint32_t overwrite;
378         uint32_t bw_avg_time;
379         uint32_t iops_avg_time;
380         uint32_t loops;
381         uint64_t zone_range;
382         uint64_t zone_size;
383         uint64_t zone_skip;
384         uint64_t lockmem;
385         uint32_t mem_type;
386         uint32_t mem_align;
387
388         uint32_t max_latency;
389
390         uint32_t stonewall;
391         uint32_t new_group;
392         uint32_t numjobs;
393         uint8_t cpumask[FIO_TOP_STR_MAX];
394         uint8_t verify_cpumask[FIO_TOP_STR_MAX];
395         uint32_t cpus_allowed_policy;
396         uint32_t iolog;
397         uint32_t rwmixcycle;
398         uint32_t rwmix[DDIR_RWDIR_CNT];
399         uint32_t nice;
400         uint32_t ioprio;
401         uint32_t ioprio_class;
402         uint32_t file_service_type;
403         uint32_t group_reporting;
404         uint32_t fadvise_hint;
405         uint32_t fadvise_stream;
406         uint32_t fallocate_mode;
407         uint32_t zero_buffers;
408         uint32_t refill_buffers;
409         uint32_t scramble_buffers;
410         uint8_t buffer_pattern[MAX_PATTERN_SIZE];
411         uint32_t buffer_pattern_bytes;
412         uint32_t compress_percentage;
413         uint32_t compress_chunk;
414         uint32_t dedupe_percentage;
415         uint32_t time_based;
416         uint32_t disable_lat;
417         uint32_t disable_clat;
418         uint32_t disable_slat;
419         uint32_t disable_bw;
420         uint32_t unified_rw_rep;
421         uint32_t gtod_reduce;
422         uint32_t gtod_cpu;
423         uint32_t clocksource;
424         uint32_t no_stall;
425         uint32_t trim_percentage;
426         uint32_t trim_batch;
427         uint32_t trim_zero;
428         uint64_t trim_backlog;
429         uint32_t clat_percentiles;
430         uint32_t percentile_precision;
431         fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
432
433         uint8_t read_iolog_file[FIO_TOP_STR_MAX];
434         uint8_t write_iolog_file[FIO_TOP_STR_MAX];
435         uint8_t bw_log_file[FIO_TOP_STR_MAX];
436         uint8_t lat_log_file[FIO_TOP_STR_MAX];
437         uint8_t iops_log_file[FIO_TOP_STR_MAX];
438         uint8_t replay_redirect[FIO_TOP_STR_MAX];
439
440         /*
441          * Pre-run and post-run shell
442          */
443         uint8_t exec_prerun[FIO_TOP_STR_MAX];
444         uint8_t exec_postrun[FIO_TOP_STR_MAX];
445
446         uint32_t rate[DDIR_RWDIR_CNT];
447         uint32_t ratemin[DDIR_RWDIR_CNT];
448         uint32_t ratecycle;
449         uint32_t rate_iops[DDIR_RWDIR_CNT];
450         uint32_t rate_iops_min[DDIR_RWDIR_CNT];
451
452         uint8_t ioscheduler[FIO_TOP_STR_MAX];
453
454         /*
455          * I/O Error handling
456          */
457         uint32_t continue_on_error;
458
459         /*
460          * Benchmark profile type
461          */
462         uint8_t profile[FIO_TOP_STR_MAX];
463
464         /*
465          * blkio cgroup support
466          */
467         uint8_t cgroup[FIO_TOP_STR_MAX];
468         uint32_t cgroup_weight;
469         uint32_t cgroup_nodelete;
470
471         uint32_t uid;
472         uint32_t gid;
473
474         int32_t flow_id;
475         int32_t flow;
476         int32_t flow_watermark;
477         uint32_t flow_sleep;
478
479         uint64_t offset_increment;
480         uint64_t number_ios;
481
482         uint32_t sync_file_range;
483
484         uint64_t latency_target;
485         uint64_t latency_window;
486         uint32_t pad3;
487         fio_fp64_t latency_percentile;
488 } __attribute__((packed));
489
490 extern void convert_thread_options_to_cpu(struct thread_options *o, struct thread_options_pack *top);
491 extern void convert_thread_options_to_net(struct thread_options_pack *top, struct thread_options *);
492 extern int fio_test_cconv(struct thread_options *);
493 extern void options_default_fill(struct thread_options *o);
494
495 #endif