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