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