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