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