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