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