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