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