init.c revision e66dac263f65ed4d762299dcdc4f9a6a3fb427a7
1/* 2 * This file contains job initialization and setup functions. 3 */ 4#include <stdio.h> 5#include <stdlib.h> 6#include <unistd.h> 7#include <fcntl.h> 8#include <ctype.h> 9#include <string.h> 10#include <errno.h> 11#include <sys/ipc.h> 12#include <sys/types.h> 13#include <sys/stat.h> 14 15#include "fio.h" 16#ifndef FIO_NO_HAVE_SHM_H 17#include <sys/shm.h> 18#endif 19 20#include "parse.h" 21#include "smalloc.h" 22#include "filehash.h" 23#include "verify.h" 24#include "profile.h" 25#include "server.h" 26#include "idletime.h" 27#include "filelock.h" 28 29#include "lib/getopt.h" 30#include "lib/strcasestr.h" 31 32#include "crc/test.h" 33 34const char fio_version_string[] = FIO_VERSION; 35 36#define FIO_RANDSEED (0xb1899bedUL) 37 38static char **ini_file; 39static int max_jobs = FIO_MAX_JOBS; 40static int dump_cmdline; 41static long long def_timeout; 42static int parse_only; 43 44static struct thread_data def_thread; 45struct thread_data *threads = NULL; 46static char **job_sections; 47static int nr_job_sections; 48 49int exitall_on_terminate = 0; 50int output_format = FIO_OUTPUT_NORMAL; 51int append_terse_output = 0; 52int eta_print = FIO_ETA_AUTO; 53int eta_new_line = 0; 54FILE *f_out = NULL; 55FILE *f_err = NULL; 56char *exec_profile = NULL; 57int warnings_fatal = 0; 58int terse_version = 3; 59int is_backend = 0; 60int nr_clients = 0; 61int log_syslog = 0; 62 63int write_bw_log = 0; 64int read_only = 0; 65int status_interval = 0; 66 67static int prev_group_jobs; 68 69unsigned long fio_debug = 0; 70unsigned int fio_debug_jobno = -1; 71unsigned int *fio_debug_jobp = NULL; 72 73static char cmd_optstr[256]; 74static int did_arg; 75 76#define FIO_CLIENT_FLAG (1 << 16) 77 78/* 79 * Command line options. These will contain the above, plus a few 80 * extra that only pertain to fio itself and not jobs. 81 */ 82static struct option l_opts[FIO_NR_OPTIONS] = { 83 { 84 .name = (char *) "output", 85 .has_arg = required_argument, 86 .val = 'o' | FIO_CLIENT_FLAG, 87 }, 88 { 89 .name = (char *) "timeout", 90 .has_arg = required_argument, 91 .val = 't' | FIO_CLIENT_FLAG, 92 }, 93 { 94 .name = (char *) "latency-log", 95 .has_arg = required_argument, 96 .val = 'l' | FIO_CLIENT_FLAG, 97 }, 98 { 99 .name = (char *) "bandwidth-log", 100 .has_arg = required_argument, 101 .val = 'b' | FIO_CLIENT_FLAG, 102 }, 103 { 104 .name = (char *) "minimal", 105 .has_arg = no_argument, 106 .val = 'm' | FIO_CLIENT_FLAG, 107 }, 108 { 109 .name = (char *) "output-format", 110 .has_arg = optional_argument, 111 .val = 'F' | FIO_CLIENT_FLAG, 112 }, 113 { 114 .name = (char *) "append-terse", 115 .has_arg = optional_argument, 116 .val = 'f', 117 }, 118 { 119 .name = (char *) "version", 120 .has_arg = no_argument, 121 .val = 'v' | FIO_CLIENT_FLAG, 122 }, 123 { 124 .name = (char *) "help", 125 .has_arg = no_argument, 126 .val = 'h' | FIO_CLIENT_FLAG, 127 }, 128 { 129 .name = (char *) "cmdhelp", 130 .has_arg = optional_argument, 131 .val = 'c' | FIO_CLIENT_FLAG, 132 }, 133 { 134 .name = (char *) "enghelp", 135 .has_arg = optional_argument, 136 .val = 'i' | FIO_CLIENT_FLAG, 137 }, 138 { 139 .name = (char *) "showcmd", 140 .has_arg = no_argument, 141 .val = 's' | FIO_CLIENT_FLAG, 142 }, 143 { 144 .name = (char *) "readonly", 145 .has_arg = no_argument, 146 .val = 'r' | FIO_CLIENT_FLAG, 147 }, 148 { 149 .name = (char *) "eta", 150 .has_arg = required_argument, 151 .val = 'e' | FIO_CLIENT_FLAG, 152 }, 153 { 154 .name = (char *) "eta-newline", 155 .has_arg = required_argument, 156 .val = 'E' | FIO_CLIENT_FLAG, 157 }, 158 { 159 .name = (char *) "debug", 160 .has_arg = required_argument, 161 .val = 'd' | FIO_CLIENT_FLAG, 162 }, 163 { 164 .name = (char *) "parse-only", 165 .has_arg = no_argument, 166 .val = 'P' | FIO_CLIENT_FLAG, 167 }, 168 { 169 .name = (char *) "section", 170 .has_arg = required_argument, 171 .val = 'x' | FIO_CLIENT_FLAG, 172 }, 173#ifdef CONFIG_ZLIB 174 { 175 .name = (char *) "inflate-log", 176 .has_arg = required_argument, 177 .val = 'X' | FIO_CLIENT_FLAG, 178 }, 179#endif 180 { 181 .name = (char *) "alloc-size", 182 .has_arg = required_argument, 183 .val = 'a' | FIO_CLIENT_FLAG, 184 }, 185 { 186 .name = (char *) "profile", 187 .has_arg = required_argument, 188 .val = 'p' | FIO_CLIENT_FLAG, 189 }, 190 { 191 .name = (char *) "warnings-fatal", 192 .has_arg = no_argument, 193 .val = 'w' | FIO_CLIENT_FLAG, 194 }, 195 { 196 .name = (char *) "max-jobs", 197 .has_arg = required_argument, 198 .val = 'j' | FIO_CLIENT_FLAG, 199 }, 200 { 201 .name = (char *) "terse-version", 202 .has_arg = required_argument, 203 .val = 'V' | FIO_CLIENT_FLAG, 204 }, 205 { 206 .name = (char *) "server", 207 .has_arg = optional_argument, 208 .val = 'S', 209 }, 210 { .name = (char *) "daemonize", 211 .has_arg = required_argument, 212 .val = 'D', 213 }, 214 { 215 .name = (char *) "client", 216 .has_arg = required_argument, 217 .val = 'C', 218 }, 219 { 220 .name = (char *) "cpuclock-test", 221 .has_arg = no_argument, 222 .val = 'T', 223 }, 224 { 225 .name = (char *) "crctest", 226 .has_arg = optional_argument, 227 .val = 'G', 228 }, 229 { 230 .name = (char *) "idle-prof", 231 .has_arg = required_argument, 232 .val = 'I', 233 }, 234 { 235 .name = (char *) "status-interval", 236 .has_arg = required_argument, 237 .val = 'L', 238 }, 239 { 240 .name = NULL, 241 }, 242}; 243 244void free_threads_shm(void) 245{ 246 if (threads) { 247 void *tp = threads; 248#ifndef CONFIG_NO_SHM 249 struct shmid_ds sbuf; 250 251 threads = NULL; 252 shmdt(tp); 253 shmctl(shm_id, IPC_RMID, &sbuf); 254 shm_id = -1; 255#else 256 threads = NULL; 257 free(tp); 258#endif 259 } 260} 261 262static void free_shm(void) 263{ 264 if (threads) { 265 file_hash_exit(); 266 flow_exit(); 267 fio_debug_jobp = NULL; 268 free_threads_shm(); 269 } 270 271 options_free(fio_options, &def_thread); 272 fio_filelock_exit(); 273 scleanup(); 274} 275 276/* 277 * The thread area is shared between the main process and the job 278 * threads/processes. So setup a shared memory segment that will hold 279 * all the job info. We use the end of the region for keeping track of 280 * open files across jobs, for file sharing. 281 */ 282static int setup_thread_area(void) 283{ 284 void *hash; 285 286 if (threads) 287 return 0; 288 289 /* 290 * 1024 is too much on some machines, scale max_jobs if 291 * we get a failure that looks like too large a shm segment 292 */ 293 do { 294 size_t size = max_jobs * sizeof(struct thread_data); 295 296 size += file_hash_size; 297 size += sizeof(unsigned int); 298 299#ifndef CONFIG_NO_SHM 300 shm_id = shmget(0, size, IPC_CREAT | 0600); 301 if (shm_id != -1) 302 break; 303 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) { 304 perror("shmget"); 305 break; 306 } 307#else 308 threads = malloc(size); 309 if (threads) 310 break; 311#endif 312 313 max_jobs >>= 1; 314 } while (max_jobs); 315 316#ifndef CONFIG_NO_SHM 317 if (shm_id == -1) 318 return 1; 319 320 threads = shmat(shm_id, NULL, 0); 321 if (threads == (void *) -1) { 322 perror("shmat"); 323 return 1; 324 } 325#endif 326 327 memset(threads, 0, max_jobs * sizeof(struct thread_data)); 328 hash = (void *) threads + max_jobs * sizeof(struct thread_data); 329 fio_debug_jobp = (void *) hash + file_hash_size; 330 *fio_debug_jobp = -1; 331 file_hash_init(hash); 332 333 flow_init(); 334 335 return 0; 336} 337 338static void set_cmd_options(struct thread_data *td) 339{ 340 struct thread_options *o = &td->o; 341 342 if (!o->timeout) 343 o->timeout = def_timeout; 344} 345 346/* 347 * Return a free job structure. 348 */ 349static struct thread_data *get_new_job(int global, struct thread_data *parent, 350 int preserve_eo, const char *jobname) 351{ 352 struct thread_data *td; 353 354 if (global) { 355 set_cmd_options(&def_thread); 356 return &def_thread; 357 } 358 if (setup_thread_area()) { 359 log_err("error: failed to setup shm segment\n"); 360 return NULL; 361 } 362 if (thread_number >= max_jobs) { 363 log_err("error: maximum number of jobs (%d) reached.\n", 364 max_jobs); 365 return NULL; 366 } 367 368 td = &threads[thread_number++]; 369 *td = *parent; 370 371 td->io_ops = NULL; 372 if (!preserve_eo) 373 td->eo = NULL; 374 375 td->o.uid = td->o.gid = -1U; 376 377 dup_files(td, parent); 378 fio_options_mem_dupe(td); 379 380 profile_add_hooks(td); 381 382 td->thread_number = thread_number; 383 td->subjob_number = 0; 384 385 if (jobname) 386 td->o.name = strdup(jobname); 387 388 if (!parent->o.group_reporting) 389 stat_number++; 390 391 set_cmd_options(td); 392 return td; 393} 394 395static void put_job(struct thread_data *td) 396{ 397 if (td == &def_thread) 398 return; 399 400 profile_td_exit(td); 401 flow_exit_job(td); 402 403 if (td->error) 404 log_info("fio: %s\n", td->verror); 405 406 fio_options_free(td); 407 if (td->io_ops) 408 free_ioengine(td); 409 410 if (td->o.name) 411 free(td->o.name); 412 413 memset(&threads[td->thread_number - 1], 0, sizeof(*td)); 414 thread_number--; 415} 416 417static int __setup_rate(struct thread_data *td, enum fio_ddir ddir) 418{ 419 unsigned int bs = td->o.min_bs[ddir]; 420 421 assert(ddir_rw(ddir)); 422 423 if (td->o.rate[ddir]) 424 td->rate_bps[ddir] = td->o.rate[ddir]; 425 else 426 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs; 427 428 if (!td->rate_bps[ddir]) { 429 log_err("rate lower than supported\n"); 430 return -1; 431 } 432 433 td->rate_pending_usleep[ddir] = 0; 434 return 0; 435} 436 437static int setup_rate(struct thread_data *td) 438{ 439 int ret = 0; 440 441 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ]) 442 ret = __setup_rate(td, DDIR_READ); 443 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE]) 444 ret |= __setup_rate(td, DDIR_WRITE); 445 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM]) 446 ret |= __setup_rate(td, DDIR_TRIM); 447 448 return ret; 449} 450 451static int fixed_block_size(struct thread_options *o) 452{ 453 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] && 454 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] && 455 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] && 456 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] && 457 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM]; 458} 459 460 461static unsigned long long get_rand_start_delay(struct thread_data *td) 462{ 463 unsigned long long delayrange; 464 unsigned long r; 465 466 delayrange = td->o.start_delay_high - td->o.start_delay; 467 468 if (td->o.use_os_rand) { 469 r = os_random_long(&td->delay_state); 470 delayrange = (unsigned long long) ((double) delayrange * (r / (OS_RAND_MAX + 1.0))); 471 } else { 472 r = __rand(&td->__delay_state); 473 delayrange = (unsigned long long) ((double) delayrange * (r / (FRAND_MAX + 1.0))); 474 } 475 476 delayrange += td->o.start_delay; 477 return delayrange; 478} 479 480/* 481 * Lazy way of fixing up options that depend on each other. We could also 482 * define option callback handlers, but this is easier. 483 */ 484static int fixup_options(struct thread_data *td) 485{ 486 struct thread_options *o = &td->o; 487 int ret = 0; 488 489#ifndef FIO_HAVE_PSHARED_MUTEX 490 if (!o->use_thread) { 491 log_info("fio: this platform does not support process shared" 492 " mutexes, forcing use of threads. Use the 'thread'" 493 " option to get rid of this warning.\n"); 494 o->use_thread = 1; 495 ret = warnings_fatal; 496 } 497#endif 498 499 if (o->write_iolog_file && o->read_iolog_file) { 500 log_err("fio: read iolog overrides write_iolog\n"); 501 free(o->write_iolog_file); 502 o->write_iolog_file = NULL; 503 ret = warnings_fatal; 504 } 505 506 /* 507 * only really works with 1 file 508 */ 509 if (o->zone_size && o->open_files > 1) 510 o->zone_size = 0; 511 512 /* 513 * If zone_range isn't specified, backward compatibility dictates it 514 * should be made equal to zone_size. 515 */ 516 if (o->zone_size && !o->zone_range) 517 o->zone_range = o->zone_size; 518 519 /* 520 * Reads can do overwrites, we always need to pre-create the file 521 */ 522 if (td_read(td) || td_rw(td)) 523 o->overwrite = 1; 524 525 if (!o->min_bs[DDIR_READ]) 526 o->min_bs[DDIR_READ] = o->bs[DDIR_READ]; 527 if (!o->max_bs[DDIR_READ]) 528 o->max_bs[DDIR_READ] = o->bs[DDIR_READ]; 529 if (!o->min_bs[DDIR_WRITE]) 530 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE]; 531 if (!o->max_bs[DDIR_WRITE]) 532 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE]; 533 if (!o->min_bs[DDIR_TRIM]) 534 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM]; 535 if (!o->max_bs[DDIR_TRIM]) 536 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM]; 537 538 539 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]); 540 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs); 541 542 /* 543 * For random IO, allow blockalign offset other than min_bs. 544 */ 545 if (!o->ba[DDIR_READ] || !td_random(td)) 546 o->ba[DDIR_READ] = o->min_bs[DDIR_READ]; 547 if (!o->ba[DDIR_WRITE] || !td_random(td)) 548 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE]; 549 if (!o->ba[DDIR_TRIM] || !td_random(td)) 550 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM]; 551 552 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] || 553 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] || 554 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) && 555 !o->norandommap) { 556 log_err("fio: Any use of blockalign= turns off randommap\n"); 557 o->norandommap = 1; 558 ret = warnings_fatal; 559 } 560 561 if (!o->file_size_high) 562 o->file_size_high = o->file_size_low; 563 564 if (o->start_delay_high) 565 o->start_delay = get_rand_start_delay(td); 566 567 if (o->norandommap && o->verify != VERIFY_NONE 568 && !fixed_block_size(o)) { 569 log_err("fio: norandommap given for variable block sizes, " 570 "verify disabled\n"); 571 o->verify = VERIFY_NONE; 572 ret = warnings_fatal; 573 } 574 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO)) 575 log_err("fio: bs_unaligned may not work with raw io\n"); 576 577 /* 578 * thinktime_spin must be less than thinktime 579 */ 580 if (o->thinktime_spin > o->thinktime) 581 o->thinktime_spin = o->thinktime; 582 583 /* 584 * The low water mark cannot be bigger than the iodepth 585 */ 586 if (o->iodepth_low > o->iodepth || !o->iodepth_low) 587 o->iodepth_low = o->iodepth; 588 589 /* 590 * If batch number isn't set, default to the same as iodepth 591 */ 592 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch) 593 o->iodepth_batch = o->iodepth; 594 595 if (o->nr_files > td->files_index) 596 o->nr_files = td->files_index; 597 598 if (o->open_files > o->nr_files || !o->open_files) 599 o->open_files = o->nr_files; 600 601 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) && 602 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) || 603 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) && 604 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) { 605 log_err("fio: rate and rate_iops are mutually exclusive\n"); 606 ret = 1; 607 } 608 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) || 609 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) || 610 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) || 611 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) || 612 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) || 613 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) { 614 log_err("fio: minimum rate exceeds rate\n"); 615 ret = 1; 616 } 617 618 if (!o->timeout && o->time_based) { 619 log_err("fio: time_based requires a runtime/timeout setting\n"); 620 o->time_based = 0; 621 ret = warnings_fatal; 622 } 623 624 if (o->fill_device && !o->size) 625 o->size = -1ULL; 626 627 if (o->verify != VERIFY_NONE) { 628 if (td_write(td) && o->do_verify && o->numjobs > 1) { 629 log_info("Multiple writers may overwrite blocks that " 630 "belong to other jobs. This can cause " 631 "verification failures.\n"); 632 ret = warnings_fatal; 633 } 634 635 o->refill_buffers = 1; 636 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] && 637 !o->verify_interval) 638 o->verify_interval = o->min_bs[DDIR_WRITE]; 639 640 /* 641 * Verify interval must be smaller or equal to the 642 * write size. 643 */ 644 if (o->verify_interval > o->min_bs[DDIR_WRITE]) 645 o->verify_interval = o->min_bs[DDIR_WRITE]; 646 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ]) 647 o->verify_interval = o->min_bs[DDIR_READ]; 648 } 649 650 if (o->pre_read) { 651 o->invalidate_cache = 0; 652 if (td->io_ops->flags & FIO_PIPEIO) { 653 log_info("fio: cannot pre-read files with an IO engine" 654 " that isn't seekable. Pre-read disabled.\n"); 655 ret = warnings_fatal; 656 } 657 } 658 659 if (!o->unit_base) { 660 if (td->io_ops->flags & FIO_BIT_BASED) 661 o->unit_base = 1; 662 else 663 o->unit_base = 8; 664 } 665 666#ifndef CONFIG_FDATASYNC 667 if (o->fdatasync_blocks) { 668 log_info("fio: this platform does not support fdatasync()" 669 " falling back to using fsync(). Use the 'fsync'" 670 " option instead of 'fdatasync' to get rid of" 671 " this warning\n"); 672 o->fsync_blocks = o->fdatasync_blocks; 673 o->fdatasync_blocks = 0; 674 ret = warnings_fatal; 675 } 676#endif 677 678#ifdef WIN32 679 /* 680 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface, 681 * so fail if we're passed those flags 682 */ 683 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) { 684 log_err("fio: Windows does not support direct or non-buffered io with" 685 " the synchronous ioengines. Use the 'windowsaio' ioengine" 686 " with 'direct=1' and 'iodepth=1' instead.\n"); 687 ret = 1; 688 } 689#endif 690 691 /* 692 * For fully compressible data, just zero them at init time. 693 * It's faster than repeatedly filling it. 694 */ 695 if (td->o.compress_percentage == 100) { 696 td->o.zero_buffers = 1; 697 td->o.compress_percentage = 0; 698 } 699 700 /* 701 * Using a non-uniform random distribution excludes usage of 702 * a random map 703 */ 704 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM) 705 td->o.norandommap = 1; 706 707 /* 708 * If size is set but less than the min block size, complain 709 */ 710 if (o->size && o->size < td_min_bs(td)) { 711 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size); 712 ret = 1; 713 } 714 715 /* 716 * O_ATOMIC implies O_DIRECT 717 */ 718 if (td->o.oatomic) 719 td->o.odirect = 1; 720 721 /* 722 * If randseed is set, that overrides randrepeat 723 */ 724 if (td->o.rand_seed) 725 td->o.rand_repeatable = 0; 726 727 if ((td->io_ops->flags & FIO_NOEXTEND) && td->o.file_append) { 728 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name); 729 ret = 1; 730 } 731 732 return ret; 733} 734 735/* 736 * This function leaks the buffer 737 */ 738char *fio_uint_to_kmg(unsigned int val) 739{ 740 char *buf = malloc(32); 741 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 }; 742 char *p = post; 743 744 do { 745 if (val & 1023) 746 break; 747 748 val >>= 10; 749 p++; 750 } while (*p); 751 752 snprintf(buf, 32, "%u%c", val, *p); 753 return buf; 754} 755 756/* External engines are specified by "external:name.o") */ 757static const char *get_engine_name(const char *str) 758{ 759 char *p = strstr(str, ":"); 760 761 if (!p) 762 return str; 763 764 p++; 765 strip_blank_front(&p); 766 strip_blank_end(p); 767 return p; 768} 769 770static int exists_and_not_file(const char *filename) 771{ 772 struct stat sb; 773 774 if (lstat(filename, &sb) == -1) 775 return 0; 776 777 /* \\.\ is the device namespace in Windows, where every file 778 * is a device node */ 779 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0) 780 return 0; 781 782 return 1; 783} 784 785static void td_fill_rand_seeds_os(struct thread_data *td) 786{ 787 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state); 788 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state); 789 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state); 790 791 if (td->o.file_service_type == FIO_FSERVICE_RANDOM) 792 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state); 793 794 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state); 795 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state); 796 os_random_seed(td->rand_seeds[FIO_RAND_START_DELAY], &td->delay_state); 797 798 if (!td_random(td)) 799 return; 800 801 if (td->o.rand_repeatable) 802 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number; 803 804 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state); 805 806 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], &td->seq_rand_state[DDIR_READ]); 807 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF], &td->seq_rand_state[DDIR_WRITE]); 808 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF], &td->seq_rand_state[DDIR_TRIM]); 809} 810 811static void td_fill_rand_seeds_internal(struct thread_data *td) 812{ 813 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]); 814 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]); 815 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]); 816 817 if (td->o.file_service_type == FIO_FSERVICE_RANDOM) 818 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]); 819 820 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]); 821 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]); 822 init_rand_seed(&td->__delay_state, td->rand_seeds[FIO_RAND_START_DELAY]); 823 824 if (!td_random(td)) 825 return; 826 827 if (td->o.rand_repeatable) 828 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number; 829 830 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]); 831 init_rand_seed(&td->__seq_rand_state[DDIR_READ], td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF]); 832 init_rand_seed(&td->__seq_rand_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF]); 833 init_rand_seed(&td->__seq_rand_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF]); 834} 835 836void td_fill_rand_seeds(struct thread_data *td) 837{ 838 if (td->o.allrand_repeatable) { 839 unsigned int i; 840 841 for (i = 0; i < FIO_RAND_NR_OFFS; i++) 842 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number 843 + i; 844 } 845 846 if (td->o.use_os_rand) 847 td_fill_rand_seeds_os(td); 848 else 849 td_fill_rand_seeds_internal(td); 850 851 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]); 852 frand_copy(&td->buf_state_prev, &td->buf_state); 853 854 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF]); 855} 856 857/* 858 * Initializes the ioengine configured for a job, if it has not been done so 859 * already. 860 */ 861int ioengine_load(struct thread_data *td) 862{ 863 const char *engine; 864 865 /* 866 * Engine has already been loaded. 867 */ 868 if (td->io_ops) 869 return 0; 870 if (!td->o.ioengine) { 871 log_err("fio: internal fault, no IO engine specified\n"); 872 return 1; 873 } 874 875 engine = get_engine_name(td->o.ioengine); 876 td->io_ops = load_ioengine(td, engine); 877 if (!td->io_ops) { 878 log_err("fio: failed to load engine %s\n", engine); 879 return 1; 880 } 881 882 if (td->io_ops->option_struct_size && td->io_ops->options) { 883 /* 884 * In cases where td->eo is set, clone it for a child thread. 885 * This requires that the parent thread has the same ioengine, 886 * but that requirement must be enforced by the code which 887 * cloned the thread. 888 */ 889 void *origeo = td->eo; 890 /* 891 * Otherwise use the default thread options. 892 */ 893 if (!origeo && td != &def_thread && def_thread.eo && 894 def_thread.io_ops->options == td->io_ops->options) 895 origeo = def_thread.eo; 896 897 options_init(td->io_ops->options); 898 td->eo = malloc(td->io_ops->option_struct_size); 899 /* 900 * Use the default thread as an option template if this uses the 901 * same options structure and there are non-default options 902 * used. 903 */ 904 if (origeo) { 905 memcpy(td->eo, origeo, td->io_ops->option_struct_size); 906 options_mem_dupe(td->eo, td->io_ops->options); 907 } else { 908 memset(td->eo, 0, td->io_ops->option_struct_size); 909 fill_default_options(td->eo, td->io_ops->options); 910 } 911 *(struct thread_data **)td->eo = td; 912 } 913 914 return 0; 915} 916 917static void init_flags(struct thread_data *td) 918{ 919 struct thread_options *o = &td->o; 920 921 if (o->verify_backlog) 922 td->flags |= TD_F_VER_BACKLOG; 923 if (o->trim_backlog) 924 td->flags |= TD_F_TRIM_BACKLOG; 925 if (o->read_iolog_file) 926 td->flags |= TD_F_READ_IOLOG; 927 if (o->refill_buffers) 928 td->flags |= TD_F_REFILL_BUFFERS; 929 if (o->scramble_buffers) 930 td->flags |= TD_F_SCRAMBLE_BUFFERS; 931 if (o->verify != VERIFY_NONE) 932 td->flags |= TD_F_VER_NONE; 933} 934 935static int setup_random_seeds(struct thread_data *td) 936{ 937 unsigned long seed; 938 unsigned int i; 939 940 if (!td->o.rand_repeatable && !td->o.rand_seed) 941 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds)); 942 943 if (!td->o.rand_seed) 944 seed = 0x89; 945 else 946 seed = td->o.rand_seed; 947 948 for (i = 0; i < 4; i++) 949 seed *= 0x9e370001UL; 950 951 for (i = 0; i < FIO_RAND_NR_OFFS; i++) { 952 td->rand_seeds[i] = seed; 953 seed *= 0x9e370001UL; 954 } 955 956 td_fill_rand_seeds(td); 957 return 0; 958} 959 960enum { 961 FPRE_NONE = 0, 962 FPRE_JOBNAME, 963 FPRE_JOBNUM, 964 FPRE_FILENUM 965}; 966 967static struct fpre_keyword { 968 const char *keyword; 969 size_t strlen; 970 int key; 971} fpre_keywords[] = { 972 { .keyword = "$jobname", .key = FPRE_JOBNAME, }, 973 { .keyword = "$jobnum", .key = FPRE_JOBNUM, }, 974 { .keyword = "$filenum", .key = FPRE_FILENUM, }, 975 { .keyword = NULL, }, 976 }; 977 978static char *make_filename(char *buf, size_t buf_size,struct thread_options *o, 979 const char *jobname, int jobnum, int filenum) 980{ 981 struct fpre_keyword *f; 982 char copy[PATH_MAX]; 983 size_t dst_left = PATH_MAX - 1; 984 985 if (!o->filename_format || !strlen(o->filename_format)) { 986 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum); 987 return NULL; 988 } 989 990 for (f = &fpre_keywords[0]; f->keyword; f++) 991 f->strlen = strlen(f->keyword); 992 993 buf[buf_size - 1] = '\0'; 994 strncpy(buf, o->filename_format, buf_size - 1); 995 996 memset(copy, 0, sizeof(copy)); 997 for (f = &fpre_keywords[0]; f->keyword; f++) { 998 do { 999 size_t pre_len, post_start = 0; 1000 char *str, *dst = copy; 1001 1002 str = strcasestr(buf, f->keyword); 1003 if (!str) 1004 break; 1005 1006 pre_len = str - buf; 1007 if (strlen(str) != f->strlen) 1008 post_start = pre_len + f->strlen; 1009 1010 if (pre_len) { 1011 strncpy(dst, buf, pre_len); 1012 dst += pre_len; 1013 dst_left -= pre_len; 1014 } 1015 1016 switch (f->key) { 1017 case FPRE_JOBNAME: { 1018 int ret; 1019 1020 ret = snprintf(dst, dst_left, "%s", jobname); 1021 if (ret < 0) 1022 break; 1023 dst += ret; 1024 dst_left -= ret; 1025 break; 1026 } 1027 case FPRE_JOBNUM: { 1028 int ret; 1029 1030 ret = snprintf(dst, dst_left, "%d", jobnum); 1031 if (ret < 0) 1032 break; 1033 dst += ret; 1034 dst_left -= ret; 1035 break; 1036 } 1037 case FPRE_FILENUM: { 1038 int ret; 1039 1040 ret = snprintf(dst, dst_left, "%d", filenum); 1041 if (ret < 0) 1042 break; 1043 dst += ret; 1044 dst_left -= ret; 1045 break; 1046 } 1047 default: 1048 assert(0); 1049 break; 1050 } 1051 1052 if (post_start) 1053 strncpy(dst, buf + post_start, dst_left); 1054 1055 strncpy(buf, copy, buf_size - 1); 1056 } while (1); 1057 } 1058 1059 return buf; 1060} 1061 1062int parse_dryrun(void) 1063{ 1064 return dump_cmdline || parse_only; 1065} 1066 1067/* 1068 * Adds a job to the list of things todo. Sanitizes the various options 1069 * to make sure we don't have conflicts, and initializes various 1070 * members of td. 1071 */ 1072static int add_job(struct thread_data *td, const char *jobname, int job_add_num, 1073 int recursed, int client_type) 1074{ 1075 unsigned int i; 1076 char fname[PATH_MAX]; 1077 int numjobs, file_alloced; 1078 struct thread_options *o = &td->o; 1079 char logname[PATH_MAX + 32]; 1080 1081 /* 1082 * the def_thread is just for options, it's not a real job 1083 */ 1084 if (td == &def_thread) 1085 return 0; 1086 1087 init_flags(td); 1088 1089 /* 1090 * if we are just dumping the output command line, don't add the job 1091 */ 1092 if (parse_dryrun()) { 1093 put_job(td); 1094 return 0; 1095 } 1096 1097 td->client_type = client_type; 1098 1099 if (profile_td_init(td)) 1100 goto err; 1101 1102 if (ioengine_load(td)) 1103 goto err; 1104 1105 if (o->odirect) 1106 td->io_ops->flags |= FIO_RAWIO; 1107 1108 file_alloced = 0; 1109 if (!o->filename && !td->files_index && !o->read_iolog_file) { 1110 file_alloced = 1; 1111 1112 if (o->nr_files == 1 && exists_and_not_file(jobname)) 1113 add_file(td, jobname, job_add_num, 0); 1114 else { 1115 for (i = 0; i < o->nr_files; i++) 1116 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0); 1117 } 1118 } 1119 1120 if (fixup_options(td)) 1121 goto err; 1122 1123 flow_init_job(td); 1124 1125 /* 1126 * IO engines only need this for option callbacks, and the address may 1127 * change in subprocesses. 1128 */ 1129 if (td->eo) 1130 *(struct thread_data **)td->eo = NULL; 1131 1132 if (td->io_ops->flags & FIO_DISKLESSIO) { 1133 struct fio_file *f; 1134 1135 for_each_file(td, f, i) 1136 f->real_file_size = -1ULL; 1137 } 1138 1139 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED); 1140 1141 td->ts.clat_percentiles = o->clat_percentiles; 1142 td->ts.percentile_precision = o->percentile_precision; 1143 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list)); 1144 1145 for (i = 0; i < DDIR_RWDIR_CNT; i++) { 1146 td->ts.clat_stat[i].min_val = ULONG_MAX; 1147 td->ts.slat_stat[i].min_val = ULONG_MAX; 1148 td->ts.lat_stat[i].min_val = ULONG_MAX; 1149 td->ts.bw_stat[i].min_val = ULONG_MAX; 1150 } 1151 td->ddir_seq_nr = o->ddir_seq_nr; 1152 1153 if ((o->stonewall || o->new_group) && prev_group_jobs) { 1154 prev_group_jobs = 0; 1155 groupid++; 1156 } 1157 1158 td->groupid = groupid; 1159 prev_group_jobs++; 1160 1161 if (setup_random_seeds(td)) { 1162 td_verror(td, errno, "init_random_state"); 1163 goto err; 1164 } 1165 1166 if (setup_rate(td)) 1167 goto err; 1168 1169 if (o->lat_log_file) { 1170 struct log_params p = { 1171 .td = td, 1172 .avg_msec = o->log_avg_msec, 1173 .log_type = IO_LOG_TYPE_LAT, 1174 .log_offset = o->log_offset, 1175 .log_gz = o->log_gz, 1176 .log_gz_store = o->log_gz_store, 1177 }; 1178 const char *suf; 1179 1180 if (p.log_gz_store) 1181 suf = "log.fz"; 1182 else 1183 suf = "log"; 1184 1185 snprintf(logname, sizeof(logname), "%s_lat.%d.%s", 1186 o->lat_log_file, td->thread_number, suf); 1187 setup_log(&td->lat_log, &p, logname); 1188 snprintf(logname, sizeof(logname), "%s_slat.%d.%s", 1189 o->lat_log_file, td->thread_number, suf); 1190 setup_log(&td->slat_log, &p, logname); 1191 snprintf(logname, sizeof(logname), "%s_clat.%d.%s", 1192 o->lat_log_file, td->thread_number, suf); 1193 setup_log(&td->clat_log, &p, logname); 1194 } 1195 if (o->bw_log_file) { 1196 struct log_params p = { 1197 .td = td, 1198 .avg_msec = o->log_avg_msec, 1199 .log_type = IO_LOG_TYPE_BW, 1200 .log_offset = o->log_offset, 1201 .log_gz = o->log_gz, 1202 .log_gz_store = o->log_gz_store, 1203 }; 1204 const char *suf; 1205 1206 if (p.log_gz_store) 1207 suf = "log.fz"; 1208 else 1209 suf = "log"; 1210 1211 snprintf(logname, sizeof(logname), "%s_bw.%d.%s", 1212 o->bw_log_file, td->thread_number, suf); 1213 setup_log(&td->bw_log, &p, logname); 1214 } 1215 if (o->iops_log_file) { 1216 struct log_params p = { 1217 .td = td, 1218 .avg_msec = o->log_avg_msec, 1219 .log_type = IO_LOG_TYPE_IOPS, 1220 .log_offset = o->log_offset, 1221 .log_gz = o->log_gz, 1222 .log_gz_store = o->log_gz_store, 1223 }; 1224 const char *suf; 1225 1226 if (p.log_gz_store) 1227 suf = "log.fz"; 1228 else 1229 suf = "log"; 1230 1231 snprintf(logname, sizeof(logname), "%s_iops.%d.%s", 1232 o->iops_log_file, td->thread_number, suf); 1233 setup_log(&td->iops_log, &p, logname); 1234 } 1235 1236 if (!o->name) 1237 o->name = strdup(jobname); 1238 1239 if (output_format == FIO_OUTPUT_NORMAL) { 1240 if (!job_add_num) { 1241 if (is_backend && !recursed) 1242 fio_server_send_add_job(td); 1243 1244 if (!(td->io_ops->flags & FIO_NOIO)) { 1245 char *c1, *c2, *c3, *c4; 1246 char *c5 = NULL, *c6 = NULL; 1247 1248 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]); 1249 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]); 1250 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]); 1251 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]); 1252 1253 if (!o->bs_is_seq_rand) { 1254 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]); 1255 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]); 1256 } 1257 1258 log_info("%s: (g=%d): rw=%s, ", td->o.name, 1259 td->groupid, 1260 ddir_str(o->td_ddir)); 1261 1262 if (o->bs_is_seq_rand) 1263 log_info("bs(seq/rand)=%s-%s/%s-%s, ", 1264 c1, c2, c3, c4); 1265 else 1266 log_info("bs=%s-%s/%s-%s/%s-%s, ", 1267 c1, c2, c3, c4, c5, c6); 1268 1269 log_info("ioengine=%s, iodepth=%u\n", 1270 td->io_ops->name, o->iodepth); 1271 1272 free(c1); 1273 free(c2); 1274 free(c3); 1275 free(c4); 1276 free(c5); 1277 free(c6); 1278 } 1279 } else if (job_add_num == 1) 1280 log_info("...\n"); 1281 } 1282 1283 /* 1284 * recurse add identical jobs, clear numjobs and stonewall options 1285 * as they don't apply to sub-jobs 1286 */ 1287 numjobs = o->numjobs; 1288 while (--numjobs) { 1289 struct thread_data *td_new = get_new_job(0, td, 1, jobname); 1290 1291 if (!td_new) 1292 goto err; 1293 1294 td_new->o.numjobs = 1; 1295 td_new->o.stonewall = 0; 1296 td_new->o.new_group = 0; 1297 td_new->subjob_number = numjobs; 1298 1299 if (file_alloced) { 1300 if (td_new->files) { 1301 struct fio_file *f; 1302 for_each_file(td_new, f, i) { 1303 if (f->file_name) 1304 sfree(f->file_name); 1305 sfree(f); 1306 } 1307 free(td_new->files); 1308 td_new->files = NULL; 1309 } 1310 td_new->files_index = 0; 1311 td_new->files_size = 0; 1312 if (td_new->o.filename) { 1313 free(td_new->o.filename); 1314 td_new->o.filename = NULL; 1315 } 1316 } 1317 1318 if (add_job(td_new, jobname, numjobs, 1, client_type)) 1319 goto err; 1320 } 1321 1322 return 0; 1323err: 1324 put_job(td); 1325 return -1; 1326} 1327 1328/* 1329 * Parse as if 'o' was a command line 1330 */ 1331void add_job_opts(const char **o, int client_type) 1332{ 1333 struct thread_data *td, *td_parent; 1334 int i, in_global = 1; 1335 char jobname[32]; 1336 1337 i = 0; 1338 td_parent = td = NULL; 1339 while (o[i]) { 1340 if (!strncmp(o[i], "name", 4)) { 1341 in_global = 0; 1342 if (td) 1343 add_job(td, jobname, 0, 0, client_type); 1344 td = NULL; 1345 sprintf(jobname, "%s", o[i] + 5); 1346 } 1347 if (in_global && !td_parent) 1348 td_parent = get_new_job(1, &def_thread, 0, jobname); 1349 else if (!in_global && !td) { 1350 if (!td_parent) 1351 td_parent = &def_thread; 1352 td = get_new_job(0, td_parent, 0, jobname); 1353 } 1354 if (in_global) 1355 fio_options_parse(td_parent, (char **) &o[i], 1, 0); 1356 else 1357 fio_options_parse(td, (char **) &o[i], 1, 0); 1358 i++; 1359 } 1360 1361 if (td) 1362 add_job(td, jobname, 0, 0, client_type); 1363} 1364 1365static int skip_this_section(const char *name) 1366{ 1367 int i; 1368 1369 if (!nr_job_sections) 1370 return 0; 1371 if (!strncmp(name, "global", 6)) 1372 return 0; 1373 1374 for (i = 0; i < nr_job_sections; i++) 1375 if (!strcmp(job_sections[i], name)) 1376 return 0; 1377 1378 return 1; 1379} 1380 1381static int is_empty_or_comment(char *line) 1382{ 1383 unsigned int i; 1384 1385 for (i = 0; i < strlen(line); i++) { 1386 if (line[i] == ';') 1387 return 1; 1388 if (line[i] == '#') 1389 return 1; 1390 if (!isspace((int) line[i]) && !iscntrl((int) line[i])) 1391 return 0; 1392 } 1393 1394 return 1; 1395} 1396 1397/* 1398 * This is our [ini] type file parser. 1399 */ 1400int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type) 1401{ 1402 unsigned int global; 1403 struct thread_data *td; 1404 char *string, *name; 1405 FILE *f; 1406 char *p; 1407 int ret = 0, stonewall; 1408 int first_sect = 1; 1409 int skip_fgets = 0; 1410 int inside_skip = 0; 1411 char **opts; 1412 int i, alloc_opts, num_opts; 1413 1414 if (is_buf) 1415 f = NULL; 1416 else { 1417 if (!strcmp(file, "-")) 1418 f = stdin; 1419 else 1420 f = fopen(file, "r"); 1421 1422 if (!f) { 1423 perror("fopen job file"); 1424 return 1; 1425 } 1426 } 1427 1428 string = malloc(4096); 1429 1430 /* 1431 * it's really 256 + small bit, 280 should suffice 1432 */ 1433 name = malloc(280); 1434 memset(name, 0, 280); 1435 1436 alloc_opts = 8; 1437 opts = malloc(sizeof(char *) * alloc_opts); 1438 num_opts = 0; 1439 1440 stonewall = stonewall_flag; 1441 do { 1442 /* 1443 * if skip_fgets is set, we already have loaded a line we 1444 * haven't handled. 1445 */ 1446 if (!skip_fgets) { 1447 if (is_buf) 1448 p = strsep(&file, "\n"); 1449 else 1450 p = fgets(string, 4096, f); 1451 if (!p) 1452 break; 1453 } 1454 1455 skip_fgets = 0; 1456 strip_blank_front(&p); 1457 strip_blank_end(p); 1458 1459 if (is_empty_or_comment(p)) 1460 continue; 1461 if (sscanf(p, "[%255[^\n]]", name) != 1) { 1462 if (inside_skip) 1463 continue; 1464 log_err("fio: option <%s> outside of [] job section\n", 1465 p); 1466 break; 1467 } 1468 1469 name[strlen(name) - 1] = '\0'; 1470 1471 if (skip_this_section(name)) { 1472 inside_skip = 1; 1473 continue; 1474 } else 1475 inside_skip = 0; 1476 1477 global = !strncmp(name, "global", 6); 1478 1479 if (dump_cmdline) { 1480 if (first_sect) 1481 log_info("fio "); 1482 if (!global) 1483 log_info("--name=%s ", name); 1484 first_sect = 0; 1485 } 1486 1487 td = get_new_job(global, &def_thread, 0, name); 1488 if (!td) { 1489 ret = 1; 1490 break; 1491 } 1492 1493 /* 1494 * Separate multiple job files by a stonewall 1495 */ 1496 if (!global && stonewall) { 1497 td->o.stonewall = stonewall; 1498 stonewall = 0; 1499 } 1500 1501 num_opts = 0; 1502 memset(opts, 0, alloc_opts * sizeof(char *)); 1503 1504 while (1) { 1505 if (is_buf) 1506 p = strsep(&file, "\n"); 1507 else 1508 p = fgets(string, 4096, f); 1509 if (!p) 1510 break; 1511 1512 if (is_empty_or_comment(p)) 1513 continue; 1514 1515 strip_blank_front(&p); 1516 1517 /* 1518 * new section, break out and make sure we don't 1519 * fgets() a new line at the top. 1520 */ 1521 if (p[0] == '[') { 1522 skip_fgets = 1; 1523 break; 1524 } 1525 1526 strip_blank_end(p); 1527 1528 if (num_opts == alloc_opts) { 1529 alloc_opts <<= 1; 1530 opts = realloc(opts, 1531 alloc_opts * sizeof(char *)); 1532 } 1533 1534 opts[num_opts] = strdup(p); 1535 num_opts++; 1536 } 1537 1538 ret = fio_options_parse(td, opts, num_opts, dump_cmdline); 1539 if (!ret) 1540 ret = add_job(td, name, 0, 0, type); 1541 else { 1542 log_err("fio: job %s dropped\n", name); 1543 put_job(td); 1544 } 1545 1546 for (i = 0; i < num_opts; i++) 1547 free(opts[i]); 1548 num_opts = 0; 1549 } while (!ret); 1550 1551 if (dump_cmdline) 1552 log_info("\n"); 1553 1554 i = 0; 1555 while (i < nr_job_sections) { 1556 free(job_sections[i]); 1557 i++; 1558 } 1559 1560 free(string); 1561 free(name); 1562 free(opts); 1563 if (!is_buf && f != stdin) 1564 fclose(f); 1565 return ret; 1566} 1567 1568static int fill_def_thread(void) 1569{ 1570 memset(&def_thread, 0, sizeof(def_thread)); 1571 1572 fio_getaffinity(getpid(), &def_thread.o.cpumask); 1573 def_thread.o.error_dump = 1; 1574 1575 /* 1576 * fill default options 1577 */ 1578 fio_fill_default_options(&def_thread); 1579 return 0; 1580} 1581 1582static void usage(const char *name) 1583{ 1584 printf("%s\n", fio_version_string); 1585 printf("%s [options] [job options] <job file(s)>\n", name); 1586 printf(" --debug=options\tEnable debug logging. May be one/more of:\n" 1587 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n" 1588 "\t\t\tdiskutil,job,mutex,profile,time,net,rate,compress\n"); 1589 printf(" --parse-only\t\tParse options only, don't start any IO\n"); 1590 printf(" --output\t\tWrite output to file\n"); 1591 printf(" --runtime\t\tRuntime in seconds\n"); 1592 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n"); 1593 printf(" --minimal\t\tMinimal (terse) output\n"); 1594 printf(" --output-format=x\tOutput format (terse,json,normal)\n"); 1595 printf(" --terse-version=x\tSet terse version output format to 'x'\n"); 1596 printf(" --version\t\tPrint version info and exit\n"); 1597 printf(" --help\t\tPrint this page\n"); 1598 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n"); 1599 printf(" --crctest\t\tTest speed of checksum functions\n"); 1600 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of" 1601 " them\n"); 1602 printf(" --enghelp=engine\tPrint ioengine help, or list" 1603 " available ioengines\n"); 1604 printf(" --enghelp=engine,cmd\tPrint help for an ioengine" 1605 " cmd\n"); 1606 printf(" --showcmd\t\tTurn a job file into command line options\n"); 1607 printf(" --eta=when\t\tWhen ETA estimate should be printed\n"); 1608 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n"); 1609 printf(" --eta-newline=time\tForce a new line for every 'time'"); 1610 printf(" period passed\n"); 1611 printf(" --status-interval=t\tForce full status dump every"); 1612 printf(" 't' period passed\n"); 1613 printf(" --readonly\t\tTurn on safety read-only checks, preventing" 1614 " writes\n"); 1615 printf(" --section=name\tOnly run specified section in job file\n"); 1616 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb" 1617 " (def 1024)\n"); 1618 printf(" --warnings-fatal\tFio parser warnings are fatal\n"); 1619 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n"); 1620 printf(" --server=args\t\tStart a backend fio server\n"); 1621 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n"); 1622 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n"); 1623 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n" 1624 "\t\t\t(option=system,percpu) or run unit work\n" 1625 "\t\t\tcalibration only (option=calibrate)\n"); 1626#ifdef CONFIG_ZLIB 1627 printf(" --inflate-log=log\tInflate and output compressed log\n"); 1628#endif 1629 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>"); 1630 printf("\n Jens Axboe <jaxboe@fusionio.com>"); 1631 printf("\n Jens Axboe <axboe@fb.com>\n"); 1632} 1633 1634#ifdef FIO_INC_DEBUG 1635struct debug_level debug_levels[] = { 1636 { .name = "process", 1637 .help = "Process creation/exit logging", 1638 .shift = FD_PROCESS, 1639 }, 1640 { .name = "file", 1641 .help = "File related action logging", 1642 .shift = FD_FILE, 1643 }, 1644 { .name = "io", 1645 .help = "IO and IO engine action logging (offsets, queue, completions, etc)", 1646 .shift = FD_IO, 1647 }, 1648 { .name = "mem", 1649 .help = "Memory allocation/freeing logging", 1650 .shift = FD_MEM, 1651 }, 1652 { .name = "blktrace", 1653 .help = "blktrace action logging", 1654 .shift = FD_BLKTRACE, 1655 }, 1656 { .name = "verify", 1657 .help = "IO verification action logging", 1658 .shift = FD_VERIFY, 1659 }, 1660 { .name = "random", 1661 .help = "Random generation logging", 1662 .shift = FD_RANDOM, 1663 }, 1664 { .name = "parse", 1665 .help = "Parser logging", 1666 .shift = FD_PARSE, 1667 }, 1668 { .name = "diskutil", 1669 .help = "Disk utility logging actions", 1670 .shift = FD_DISKUTIL, 1671 }, 1672 { .name = "job", 1673 .help = "Logging related to creating/destroying jobs", 1674 .shift = FD_JOB, 1675 }, 1676 { .name = "mutex", 1677 .help = "Mutex logging", 1678 .shift = FD_MUTEX 1679 }, 1680 { .name = "profile", 1681 .help = "Logging related to profiles", 1682 .shift = FD_PROFILE, 1683 }, 1684 { .name = "time", 1685 .help = "Logging related to time keeping functions", 1686 .shift = FD_TIME, 1687 }, 1688 { .name = "net", 1689 .help = "Network logging", 1690 .shift = FD_NET, 1691 }, 1692 { .name = "rate", 1693 .help = "Rate logging", 1694 .shift = FD_RATE, 1695 }, 1696 { .name = "compress", 1697 .help = "Log compression logging", 1698 .shift = FD_COMPRESS, 1699 }, 1700 { .name = NULL, }, 1701}; 1702 1703static int set_debug(const char *string) 1704{ 1705 struct debug_level *dl; 1706 char *p = (char *) string; 1707 char *opt; 1708 int i; 1709 1710 if (!strcmp(string, "?") || !strcmp(string, "help")) { 1711 log_info("fio: dumping debug options:"); 1712 for (i = 0; debug_levels[i].name; i++) { 1713 dl = &debug_levels[i]; 1714 log_info("%s,", dl->name); 1715 } 1716 log_info("all\n"); 1717 return 1; 1718 } 1719 1720 while ((opt = strsep(&p, ",")) != NULL) { 1721 int found = 0; 1722 1723 if (!strncmp(opt, "all", 3)) { 1724 log_info("fio: set all debug options\n"); 1725 fio_debug = ~0UL; 1726 continue; 1727 } 1728 1729 for (i = 0; debug_levels[i].name; i++) { 1730 dl = &debug_levels[i]; 1731 found = !strncmp(opt, dl->name, strlen(dl->name)); 1732 if (!found) 1733 continue; 1734 1735 if (dl->shift == FD_JOB) { 1736 opt = strchr(opt, ':'); 1737 if (!opt) { 1738 log_err("fio: missing job number\n"); 1739 break; 1740 } 1741 opt++; 1742 fio_debug_jobno = atoi(opt); 1743 log_info("fio: set debug jobno %d\n", 1744 fio_debug_jobno); 1745 } else { 1746 log_info("fio: set debug option %s\n", opt); 1747 fio_debug |= (1UL << dl->shift); 1748 } 1749 break; 1750 } 1751 1752 if (!found) 1753 log_err("fio: debug mask %s not found\n", opt); 1754 } 1755 return 0; 1756} 1757#else 1758static int set_debug(const char *string) 1759{ 1760 log_err("fio: debug tracing not included in build\n"); 1761 return 1; 1762} 1763#endif 1764 1765static void fio_options_fill_optstring(void) 1766{ 1767 char *ostr = cmd_optstr; 1768 int i, c; 1769 1770 c = i = 0; 1771 while (l_opts[i].name) { 1772 ostr[c++] = l_opts[i].val; 1773 if (l_opts[i].has_arg == required_argument) 1774 ostr[c++] = ':'; 1775 else if (l_opts[i].has_arg == optional_argument) { 1776 ostr[c++] = ':'; 1777 ostr[c++] = ':'; 1778 } 1779 i++; 1780 } 1781 ostr[c] = '\0'; 1782} 1783 1784static int client_flag_set(char c) 1785{ 1786 int i; 1787 1788 i = 0; 1789 while (l_opts[i].name) { 1790 int val = l_opts[i].val; 1791 1792 if (c == (val & 0xff)) 1793 return (val & FIO_CLIENT_FLAG); 1794 1795 i++; 1796 } 1797 1798 return 0; 1799} 1800 1801static void parse_cmd_client(void *client, char *opt) 1802{ 1803 fio_client_add_cmd_option(client, opt); 1804} 1805 1806int parse_cmd_line(int argc, char *argv[], int client_type) 1807{ 1808 struct thread_data *td = NULL; 1809 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0; 1810 char *ostr = cmd_optstr; 1811 void *pid_file = NULL; 1812 void *cur_client = NULL; 1813 int backend = 0; 1814 1815 /* 1816 * Reset optind handling, since we may call this multiple times 1817 * for the backend. 1818 */ 1819 optind = 1; 1820 1821 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) { 1822 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) { 1823 parse_cmd_client(cur_client, argv[optind - 1]); 1824 c &= ~FIO_CLIENT_FLAG; 1825 } 1826 1827 switch (c) { 1828 case 'a': 1829 smalloc_pool_size = atoi(optarg); 1830 break; 1831 case 't': 1832 if (check_str_time(optarg, &def_timeout, 1)) { 1833 log_err("fio: failed parsing time %s\n", optarg); 1834 do_exit++; 1835 exit_val = 1; 1836 } 1837 break; 1838 case 'l': 1839 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n"); 1840 do_exit++; 1841 exit_val = 1; 1842 break; 1843 case 'b': 1844 write_bw_log = 1; 1845 break; 1846 case 'o': 1847 if (f_out && f_out != stdout) 1848 fclose(f_out); 1849 1850 f_out = fopen(optarg, "w+"); 1851 if (!f_out) { 1852 perror("fopen output"); 1853 exit(1); 1854 } 1855 f_err = f_out; 1856 break; 1857 case 'm': 1858 output_format = FIO_OUTPUT_TERSE; 1859 break; 1860 case 'F': 1861 if (!optarg) { 1862 log_err("fio: missing --output-format argument\n"); 1863 exit_val = 1; 1864 do_exit++; 1865 break; 1866 } 1867 if (!strcmp(optarg, "minimal") || 1868 !strcmp(optarg, "terse") || 1869 !strcmp(optarg, "csv")) 1870 output_format = FIO_OUTPUT_TERSE; 1871 else if (!strcmp(optarg, "json")) 1872 output_format = FIO_OUTPUT_JSON; 1873 else 1874 output_format = FIO_OUTPUT_NORMAL; 1875 break; 1876 case 'f': 1877 append_terse_output = 1; 1878 break; 1879 case 'h': 1880 did_arg = 1; 1881 if (!cur_client) { 1882 usage(argv[0]); 1883 do_exit++; 1884 } 1885 break; 1886 case 'c': 1887 did_arg = 1; 1888 if (!cur_client) { 1889 fio_show_option_help(optarg); 1890 do_exit++; 1891 } 1892 break; 1893 case 'i': 1894 did_arg = 1; 1895 if (!cur_client) { 1896 fio_show_ioengine_help(optarg); 1897 do_exit++; 1898 } 1899 break; 1900 case 's': 1901 did_arg = 1; 1902 dump_cmdline = 1; 1903 break; 1904 case 'r': 1905 read_only = 1; 1906 break; 1907 case 'v': 1908 did_arg = 1; 1909 if (!cur_client) { 1910 log_info("%s\n", fio_version_string); 1911 do_exit++; 1912 } 1913 break; 1914 case 'V': 1915 terse_version = atoi(optarg); 1916 if (!(terse_version == 2 || terse_version == 3 || 1917 terse_version == 4)) { 1918 log_err("fio: bad terse version format\n"); 1919 exit_val = 1; 1920 do_exit++; 1921 } 1922 break; 1923 case 'e': 1924 if (!strcmp("always", optarg)) 1925 eta_print = FIO_ETA_ALWAYS; 1926 else if (!strcmp("never", optarg)) 1927 eta_print = FIO_ETA_NEVER; 1928 break; 1929 case 'E': { 1930 long long t = 0; 1931 1932 if (str_to_decimal(optarg, &t, 0, NULL, 1)) { 1933 log_err("fio: failed parsing eta time %s\n", optarg); 1934 exit_val = 1; 1935 do_exit++; 1936 } 1937 eta_new_line = t; 1938 break; 1939 } 1940 case 'd': 1941 if (set_debug(optarg)) 1942 do_exit++; 1943 break; 1944 case 'P': 1945 did_arg = 1; 1946 parse_only = 1; 1947 break; 1948 case 'x': { 1949 size_t new_size; 1950 1951 if (!strcmp(optarg, "global")) { 1952 log_err("fio: can't use global as only " 1953 "section\n"); 1954 do_exit++; 1955 exit_val = 1; 1956 break; 1957 } 1958 new_size = (nr_job_sections + 1) * sizeof(char *); 1959 job_sections = realloc(job_sections, new_size); 1960 job_sections[nr_job_sections] = strdup(optarg); 1961 nr_job_sections++; 1962 break; 1963 } 1964#ifdef CONFIG_ZLIB 1965 case 'X': 1966 exit_val = iolog_file_inflate(optarg); 1967 did_arg++; 1968 do_exit++; 1969 break; 1970#endif 1971 case 'p': 1972 did_arg = 1; 1973 if (exec_profile) 1974 free(exec_profile); 1975 exec_profile = strdup(optarg); 1976 break; 1977 case FIO_GETOPT_JOB: { 1978 const char *opt = l_opts[lidx].name; 1979 char *val = optarg; 1980 1981 if (!strncmp(opt, "name", 4) && td) { 1982 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type); 1983 if (ret) 1984 goto out_free; 1985 td = NULL; 1986 did_arg = 1; 1987 } 1988 if (!td) { 1989 int is_section = !strncmp(opt, "name", 4); 1990 int global = 0; 1991 1992 if (!is_section || !strncmp(val, "global", 6)) 1993 global = 1; 1994 1995 if (is_section && skip_this_section(val)) 1996 continue; 1997 1998 td = get_new_job(global, &def_thread, 1, NULL); 1999 if (!td || ioengine_load(td)) { 2000 if (td) { 2001 put_job(td); 2002 td = NULL; 2003 } 2004 do_exit++; 2005 break; 2006 } 2007 fio_options_set_ioengine_opts(l_opts, td); 2008 } 2009 2010 if ((!val || !strlen(val)) && 2011 l_opts[lidx].has_arg == required_argument) { 2012 log_err("fio: option %s requires an argument\n", opt); 2013 ret = 1; 2014 } else 2015 ret = fio_cmd_option_parse(td, opt, val); 2016 2017 if (ret) { 2018 if (td) { 2019 put_job(td); 2020 td = NULL; 2021 } 2022 do_exit++; 2023 } 2024 2025 if (!ret && !strcmp(opt, "ioengine")) { 2026 free_ioengine(td); 2027 if (ioengine_load(td)) { 2028 put_job(td); 2029 td = NULL; 2030 do_exit++; 2031 break; 2032 } 2033 fio_options_set_ioengine_opts(l_opts, td); 2034 } 2035 break; 2036 } 2037 case FIO_GETOPT_IOENGINE: { 2038 const char *opt = l_opts[lidx].name; 2039 char *val = optarg; 2040 2041 if (!td) 2042 break; 2043 2044 ret = fio_cmd_ioengine_option_parse(td, opt, val); 2045 break; 2046 } 2047 case 'w': 2048 warnings_fatal = 1; 2049 break; 2050 case 'j': 2051 max_jobs = atoi(optarg); 2052 if (!max_jobs || max_jobs > REAL_MAX_JOBS) { 2053 log_err("fio: invalid max jobs: %d\n", max_jobs); 2054 do_exit++; 2055 exit_val = 1; 2056 } 2057 break; 2058 case 'S': 2059 did_arg = 1; 2060#ifndef CONFIG_NO_SHM 2061 if (nr_clients) { 2062 log_err("fio: can't be both client and server\n"); 2063 do_exit++; 2064 exit_val = 1; 2065 break; 2066 } 2067 if (optarg) 2068 fio_server_set_arg(optarg); 2069 is_backend = 1; 2070 backend = 1; 2071#else 2072 log_err("fio: client/server requires SHM support\n"); 2073 do_exit++; 2074 exit_val = 1; 2075#endif 2076 break; 2077 case 'D': 2078 if (pid_file) 2079 free(pid_file); 2080 pid_file = strdup(optarg); 2081 break; 2082 case 'I': 2083 if ((ret = fio_idle_prof_parse_opt(optarg))) { 2084 /* exit on error and calibration only */ 2085 did_arg = 1; 2086 do_exit++; 2087 if (ret == -1) 2088 exit_val = 1; 2089 } 2090 break; 2091 case 'C': 2092 did_arg = 1; 2093 if (is_backend) { 2094 log_err("fio: can't be both client and server\n"); 2095 do_exit++; 2096 exit_val = 1; 2097 break; 2098 } 2099 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) { 2100 log_err("fio: failed adding client %s\n", optarg); 2101 do_exit++; 2102 exit_val = 1; 2103 break; 2104 } 2105 /* 2106 * If the next argument exists and isn't an option, 2107 * assume it's a job file for this client only. 2108 */ 2109 while (optind < argc) { 2110 if (!strncmp(argv[optind], "--", 2) || 2111 !strncmp(argv[optind], "-", 1)) 2112 break; 2113 2114 fio_client_add_ini_file(cur_client, argv[optind]); 2115 optind++; 2116 } 2117 break; 2118 case 'T': 2119 did_arg = 1; 2120 do_exit++; 2121 exit_val = fio_monotonic_clocktest(); 2122 break; 2123 case 'G': 2124 did_arg = 1; 2125 do_exit++; 2126 exit_val = fio_crctest(optarg); 2127 break; 2128 case 'L': { 2129 long long val; 2130 2131 if (check_str_time(optarg, &val, 0)) { 2132 log_err("fio: failed parsing time %s\n", optarg); 2133 do_exit++; 2134 exit_val = 1; 2135 break; 2136 } 2137 status_interval = val * 1000; 2138 break; 2139 } 2140 case '?': 2141 log_err("%s: unrecognized option '%s'\n", argv[0], 2142 argv[optind - 1]); 2143 default: 2144 do_exit++; 2145 exit_val = 1; 2146 break; 2147 } 2148 if (do_exit) 2149 break; 2150 } 2151 2152 if (do_exit && !(is_backend || nr_clients)) 2153 exit(exit_val); 2154 2155 if (nr_clients && fio_clients_connect()) 2156 exit(1); 2157 2158 if (is_backend && backend) 2159 return fio_start_server(pid_file); 2160 else if (pid_file) 2161 free(pid_file); 2162 2163 if (td) { 2164 if (!ret) { 2165 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type); 2166 if (ret) 2167 did_arg = 1; 2168 } 2169 } 2170 2171 while (!ret && optind < argc) { 2172 ini_idx++; 2173 ini_file = realloc(ini_file, ini_idx * sizeof(char *)); 2174 ini_file[ini_idx - 1] = strdup(argv[optind]); 2175 optind++; 2176 } 2177 2178out_free: 2179 if (pid_file) 2180 free(pid_file); 2181 2182 return ini_idx; 2183} 2184 2185int fio_init_options(void) 2186{ 2187 f_out = stdout; 2188 f_err = stderr; 2189 2190 fio_options_fill_optstring(); 2191 fio_options_dup_and_init(l_opts); 2192 2193 atexit(free_shm); 2194 2195 if (fill_def_thread()) 2196 return 1; 2197 2198 return 0; 2199} 2200 2201extern int fio_check_options(struct thread_options *); 2202 2203int parse_options(int argc, char *argv[]) 2204{ 2205 const int type = FIO_CLIENT_TYPE_CLI; 2206 int job_files, i; 2207 2208 if (fio_init_options()) 2209 return 1; 2210 if (fio_test_cconv(&def_thread.o)) 2211 log_err("fio: failed internal cconv test\n"); 2212 2213 job_files = parse_cmd_line(argc, argv, type); 2214 2215 if (job_files > 0) { 2216 for (i = 0; i < job_files; i++) { 2217 if (i && fill_def_thread()) 2218 return 1; 2219 if (nr_clients) { 2220 if (fio_clients_send_ini(ini_file[i])) 2221 return 1; 2222 free(ini_file[i]); 2223 } else if (!is_backend) { 2224 if (parse_jobs_ini(ini_file[i], 0, i, type)) 2225 return 1; 2226 free(ini_file[i]); 2227 } 2228 } 2229 } else if (nr_clients) { 2230 if (fill_def_thread()) 2231 return 1; 2232 if (fio_clients_send_ini(NULL)) 2233 return 1; 2234 } 2235 2236 free(ini_file); 2237 fio_options_free(&def_thread); 2238 filesetup_mem_free(); 2239 2240 if (!thread_number) { 2241 if (parse_dryrun()) 2242 return 0; 2243 if (exec_profile) 2244 return 0; 2245 if (is_backend || nr_clients) 2246 return 0; 2247 if (did_arg) 2248 return 0; 2249 2250 log_err("No jobs(s) defined\n\n"); 2251 2252 if (!did_arg) { 2253 usage(argv[0]); 2254 return 1; 2255 } 2256 2257 return 0; 2258 } 2259 2260 if (def_thread.o.gtod_offload) { 2261 fio_gtod_init(); 2262 fio_gtod_offload = 1; 2263 fio_gtod_cpu = def_thread.o.gtod_cpu; 2264 } 2265 2266 if (output_format == FIO_OUTPUT_NORMAL) 2267 log_info("%s\n", fio_version_string); 2268 2269 return 0; 2270} 2271 2272void options_default_fill(struct thread_options *o) 2273{ 2274 memcpy(o, &def_thread.o, sizeof(*o)); 2275} 2276