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