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