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