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          * I/O Error handling
 192          */
 193         enum error_type continue_on_error;
 194
 195         /*
 196          * Benchmark profile type
 197          */
 198         char *profile;
 199
 200         /*
 201          * blkio cgroup support
 202          */
 203         char *cgroup;
 204         unsigned int cgroup_weight;
 205         unsigned int cgroup_nodelete;
 206
 207         unsigned int uid;
 208         unsigned int gid;
 209
 210         int flow_id;
 211         int flow;
 212         int flow_watermark;
 213         unsigned int flow_sleep;
 214
 215         unsigned long long offset_increment;
 216
 217         unsigned int sync_file_range;
 218 };
 219
 220 #define FIO_TOP_STR_MAX         256
 221
 222 struct thread_options_pack {
 223         uint8_t description[FIO_TOP_STR_MAX];
 224         uint8_t name[FIO_TOP_STR_MAX];
 225         uint8_t directory[FIO_TOP_STR_MAX];
 226         uint8_t filename[FIO_TOP_STR_MAX];
 227         uint8_t opendir[FIO_TOP_STR_MAX];
 228         uint8_t ioengine[FIO_TOP_STR_MAX];
 229         uint32_t td_ddir;
 230         uint32_t rw_seq;
 231         uint32_t kb_base;
 232         uint32_t ddir_seq_nr;
 233         uint64_t ddir_seq_add;
 234         uint32_t iodepth;
 235         uint32_t iodepth_low;
 236         uint32_t iodepth_batch;
 237         uint32_t iodepth_batch_complete;
 238
 239         uint64_t size;
 240         uint32_t size_percent;
 241         uint32_t fill_device;
 242         uint64_t file_size_low;
 243         uint64_t file_size_high;
 244         uint64_t start_offset;
 245
 246         uint32_t bs[2];
 247         uint32_t ba[2];
 248         uint32_t min_bs[2];
 249         uint32_t max_bs[2];
 250         struct bssplit bssplit[2][BSSPLIT_MAX];
 251         uint32_t bssplit_nr[2];
 252
 253         uint32_t nr_files;
 254         uint32_t open_files;
 255         uint32_t file_lock_mode;
 256         uint32_t lockfile_batch;
 257
 258         uint32_t odirect;
 259         uint32_t invalidate_cache;
 260         uint32_t create_serialize;
 261         uint32_t create_fsync;
 262         uint32_t create_on_open;
 263         uint32_t end_fsync;
 264         uint32_t pre_read;
 265         uint32_t sync_io;
 266         uint32_t verify;
 267         uint32_t do_verify;
 268         uint32_t verifysort;
 269         uint32_t verify_interval;
 270         uint32_t verify_offset;
 271         uint8_t verify_pattern[MAX_PATTERN_SIZE];
 272         uint32_t verify_pattern_bytes;
 273         uint32_t verify_fatal;
 274         uint32_t verify_dump;
 275         uint32_t verify_async;
 276         uint64_t verify_backlog;
 277         uint32_t verify_batch;
 278         uint32_t use_thread;
 279         uint32_t unlink;
 280         uint32_t do_disk_util;
 281         uint32_t override_sync;
 282         uint32_t rand_repeatable;
 283         uint32_t use_os_rand;
 284         uint32_t write_lat_log;
 285         uint32_t write_bw_log;
 286         uint32_t write_iops_log;
 287         uint32_t log_avg_msec;
 288         uint32_t norandommap;
 289         uint32_t softrandommap;
 290         uint32_t bs_unaligned;
 291         uint32_t fsync_on_close;
 292
 293         uint32_t hugepage_size;
 294         uint32_t rw_min_bs;
 295         uint32_t thinktime;
 296         uint32_t thinktime_spin;
 297         uint32_t thinktime_blocks;
 298         uint32_t fsync_blocks;
 299         uint32_t fdatasync_blocks;
 300         uint32_t barrier_blocks;
 301         uint64_t start_delay;
 302         uint64_t timeout;
 303         uint64_t ramp_time;
 304         uint32_t overwrite;
 305         uint32_t bw_avg_time;
 306         uint32_t iops_avg_time;
 307         uint32_t loops;
 308         uint64_t zone_range;
 309         uint64_t zone_size;
 310         uint64_t zone_skip;
 311         uint32_t mem_type;
 312         uint32_t mem_align;
 313
 314         uint32_t stonewall;
 315         uint32_t new_group;
 316         uint32_t numjobs;
 317         uint8_t cpumask[FIO_TOP_STR_MAX];
 318         uint32_t cpumask_set;
 319         uint8_t verify_cpumask[FIO_TOP_STR_MAX];
 320         uint32_t verify_cpumask_set;
 321         uint32_t iolog;
 322         uint32_t rwmixcycle;
 323         uint32_t rwmix[2];
 324         uint32_t nice;
 325         uint32_t file_service_type;
 326         uint32_t group_reporting;
 327         uint32_t fadvise_hint;
 328         uint32_t fallocate_mode;
 329         uint32_t zero_buffers;
 330         uint32_t refill_buffers;
 331         uint32_t scramble_buffers;
 332         unsigned int compress_percentage;
 333         unsigned int compress_chunk;
 334         uint32_t time_based;
 335         uint32_t disable_lat;
 336         uint32_t disable_clat;
 337         uint32_t disable_slat;
 338         uint32_t disable_bw;
 339         uint32_t gtod_reduce;
 340         uint32_t gtod_cpu;
 341         uint32_t gtod_offload;
 342         uint32_t clocksource;
 343         uint32_t no_stall;
 344         uint32_t trim_percentage;
 345         uint32_t trim_batch;
 346         uint32_t trim_zero;
 347         uint64_t trim_backlog;
 348         uint32_t clat_percentiles;
 349         uint32_t overwrite_plist;
 350         fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
 351
 352         uint8_t read_iolog_file[FIO_TOP_STR_MAX];
 353         uint8_t write_iolog_file[FIO_TOP_STR_MAX];
 354         uint8_t bw_log_file[FIO_TOP_STR_MAX];
 355         uint8_t lat_log_file[FIO_TOP_STR_MAX];
 356         uint8_t iops_log_file[FIO_TOP_STR_MAX];
 357         uint8_t replay_redirect[FIO_TOP_STR_MAX];
 358
 359         /*
 360          * Pre-run and post-run shell
 361          */
 362         uint8_t exec_prerun[FIO_TOP_STR_MAX];
 363         uint8_t exec_postrun[FIO_TOP_STR_MAX];
 364
 365         uint32_t rate[2];
 366         uint32_t ratemin[2];
 367         uint32_t ratecycle;
 368         uint32_t rate_iops[2];
 369         uint32_t rate_iops_min[2];
 370
 371         uint8_t ioscheduler[FIO_TOP_STR_MAX];
 372
 373         /*
 374          * I/O Error handling
 375          */
 376         uint32_t continue_on_error;
 377
 378         /*
 379          * Benchmark profile type
 380          */
 381         uint8_t profile[FIO_TOP_STR_MAX];
 382
 383         /*
 384          * blkio cgroup support
 385          */
 386         uint8_t cgroup[FIO_TOP_STR_MAX];
 387         uint32_t cgroup_weight;
 388         uint32_t cgroup_nodelete;
 389
 390         uint32_t uid;
 391         uint32_t gid;
 392
 393         int32_t flow_id;
 394         int32_t flow;
 395         int32_t flow_watermark;
 396         uint32_t flow_sleep;
 397
 398         uint64_t offset_increment;
 399
 400         uint32_t sync_file_range;
 401 } __attribute__((packed));
 402
 403 extern void convert_thread_options_to_cpu(struct thread_options *o, struct thread_options_pack *top);
 404 extern void convert_thread_options_to_net(struct thread_options_pack *top, struct thread_options *);
 405 extern int fio_test_cconv(struct thread_options *);
 406 extern void options_default_fill(struct thread_options *o);
 407
 408 #endif