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