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