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