init.c revision 8d916c942bb088204ab5c0438c297903c9160698
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 /* 625 * If size is set but less than the min block size, complain 626 */ 627 if (o->size && o->size < td_min_bs(td)) { 628 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size); 629 ret = 1; 630 } 631 632 return ret; 633} 634 635/* 636 * This function leaks the buffer 637 */ 638char *fio_uint_to_kmg(unsigned int val) 639{ 640 char *buf = malloc(32); 641 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 }; 642 char *p = post; 643 644 do { 645 if (val & 1023) 646 break; 647 648 val >>= 10; 649 p++; 650 } while (*p); 651 652 snprintf(buf, 32, "%u%c", val, *p); 653 return buf; 654} 655 656/* External engines are specified by "external:name.o") */ 657static const char *get_engine_name(const char *str) 658{ 659 char *p = strstr(str, ":"); 660 661 if (!p) 662 return str; 663 664 p++; 665 strip_blank_front(&p); 666 strip_blank_end(p); 667 return p; 668} 669 670static int exists_and_not_file(const char *filename) 671{ 672 struct stat sb; 673 674 if (lstat(filename, &sb) == -1) 675 return 0; 676 677 /* \\.\ is the device namespace in Windows, where every file 678 * is a device node */ 679 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0) 680 return 0; 681 682 return 1; 683} 684 685static void td_fill_rand_seeds_os(struct thread_data *td) 686{ 687 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state); 688 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state); 689 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state); 690 691 if (td->o.file_service_type == FIO_FSERVICE_RANDOM) 692 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state); 693 694 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state); 695 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state); 696 697 if (!td_random(td)) 698 return; 699 700 if (td->o.rand_repeatable) 701 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number; 702 703 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state); 704} 705 706static void td_fill_rand_seeds_internal(struct thread_data *td) 707{ 708 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]); 709 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]); 710 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]); 711 712 if (td->o.file_service_type == FIO_FSERVICE_RANDOM) 713 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]); 714 715 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]); 716 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]); 717 718 if (!td_random(td)) 719 return; 720 721 if (td->o.rand_repeatable) 722 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number; 723 724 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]); 725} 726 727void td_fill_rand_seeds(struct thread_data *td) 728{ 729 if (td->o.use_os_rand) 730 td_fill_rand_seeds_os(td); 731 else 732 td_fill_rand_seeds_internal(td); 733 734 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]); 735} 736 737/* 738 * Initializes the ioengine configured for a job, if it has not been done so 739 * already. 740 */ 741int ioengine_load(struct thread_data *td) 742{ 743 const char *engine; 744 745 /* 746 * Engine has already been loaded. 747 */ 748 if (td->io_ops) 749 return 0; 750 751 engine = get_engine_name(td->o.ioengine); 752 td->io_ops = load_ioengine(td, engine); 753 if (!td->io_ops) { 754 log_err("fio: failed to load engine %s\n", engine); 755 return 1; 756 } 757 758 if (td->io_ops->option_struct_size && td->io_ops->options) { 759 /* 760 * In cases where td->eo is set, clone it for a child thread. 761 * This requires that the parent thread has the same ioengine, 762 * but that requirement must be enforced by the code which 763 * cloned the thread. 764 */ 765 void *origeo = td->eo; 766 /* 767 * Otherwise use the default thread options. 768 */ 769 if (!origeo && td != &def_thread && def_thread.eo && 770 def_thread.io_ops->options == td->io_ops->options) 771 origeo = def_thread.eo; 772 773 options_init(td->io_ops->options); 774 td->eo = malloc(td->io_ops->option_struct_size); 775 /* 776 * Use the default thread as an option template if this uses the 777 * same options structure and there are non-default options 778 * used. 779 */ 780 if (origeo) { 781 memcpy(td->eo, origeo, td->io_ops->option_struct_size); 782 options_mem_dupe(td->eo, td->io_ops->options); 783 } else { 784 memset(td->eo, 0, td->io_ops->option_struct_size); 785 fill_default_options(td->eo, td->io_ops->options); 786 } 787 *(struct thread_data **)td->eo = td; 788 } 789 790 return 0; 791} 792 793static void init_flags(struct thread_data *td) 794{ 795 struct thread_options *o = &td->o; 796 797 if (o->verify_backlog) 798 td->flags |= TD_F_VER_BACKLOG; 799 if (o->trim_backlog) 800 td->flags |= TD_F_TRIM_BACKLOG; 801 if (o->read_iolog_file) 802 td->flags |= TD_F_READ_IOLOG; 803 if (o->refill_buffers) 804 td->flags |= TD_F_REFILL_BUFFERS; 805 if (o->scramble_buffers) 806 td->flags |= TD_F_SCRAMBLE_BUFFERS; 807 if (o->verify != VERIFY_NONE) 808 td->flags |= TD_F_VER_NONE; 809} 810 811static int setup_random_seeds(struct thread_data *td) 812{ 813 unsigned long seed; 814 unsigned int i; 815 816 if (!td->o.rand_repeatable) 817 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds)); 818 819 for (seed = 0x89, i = 0; i < 4; i++) 820 seed *= 0x9e370001UL; 821 822 for (i = 0; i < FIO_RAND_NR_OFFS; i++) { 823 td->rand_seeds[i] = seed; 824 seed *= 0x9e370001UL; 825 } 826 827 td_fill_rand_seeds(td); 828 return 0; 829} 830 831enum { 832 FPRE_NONE = 0, 833 FPRE_JOBNAME, 834 FPRE_JOBNUM, 835 FPRE_FILENUM 836}; 837 838static struct fpre_keyword { 839 const char *keyword; 840 size_t strlen; 841 int key; 842} fpre_keywords[] = { 843 { .keyword = "$jobname", .key = FPRE_JOBNAME, }, 844 { .keyword = "$jobnum", .key = FPRE_JOBNUM, }, 845 { .keyword = "$filenum", .key = FPRE_FILENUM, }, 846 { .keyword = NULL, }, 847 }; 848 849static char *make_filename(char *buf, struct thread_options *o, 850 const char *jobname, int jobnum, int filenum) 851{ 852 struct fpre_keyword *f; 853 char copy[PATH_MAX]; 854 855 if (!o->filename_format || !strlen(o->filename_format)) { 856 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum); 857 return NULL; 858 } 859 860 for (f = &fpre_keywords[0]; f->keyword; f++) 861 f->strlen = strlen(f->keyword); 862 863 strcpy(buf, o->filename_format); 864 memset(copy, 0, sizeof(copy)); 865 for (f = &fpre_keywords[0]; f->keyword; f++) { 866 do { 867 size_t pre_len, post_start = 0; 868 char *str, *dst = copy; 869 870 str = strcasestr(buf, f->keyword); 871 if (!str) 872 break; 873 874 pre_len = str - buf; 875 if (strlen(str) != f->strlen) 876 post_start = pre_len + f->strlen; 877 878 if (pre_len) { 879 strncpy(dst, buf, pre_len); 880 dst += pre_len; 881 } 882 883 switch (f->key) { 884 case FPRE_JOBNAME: 885 dst += sprintf(dst, "%s", jobname); 886 break; 887 case FPRE_JOBNUM: 888 dst += sprintf(dst, "%d", jobnum); 889 break; 890 case FPRE_FILENUM: 891 dst += sprintf(dst, "%d", filenum); 892 break; 893 default: 894 assert(0); 895 break; 896 } 897 898 if (post_start) 899 strcpy(dst, buf + post_start); 900 901 strcpy(buf, copy); 902 } while (1); 903 } 904 905 return buf; 906} 907/* 908 * Adds a job to the list of things todo. Sanitizes the various options 909 * to make sure we don't have conflicts, and initializes various 910 * members of td. 911 */ 912static int add_job(struct thread_data *td, const char *jobname, int job_add_num, 913 int recursed, int client_type) 914{ 915 unsigned int i; 916 char fname[PATH_MAX]; 917 int numjobs, file_alloced; 918 struct thread_options *o = &td->o; 919 920 /* 921 * the def_thread is just for options, it's not a real job 922 */ 923 if (td == &def_thread) 924 return 0; 925 926 init_flags(td); 927 928 /* 929 * if we are just dumping the output command line, don't add the job 930 */ 931 if (dump_cmdline || parse_only) { 932 put_job(td); 933 return 0; 934 } 935 936 td->client_type = client_type; 937 938 if (profile_td_init(td)) 939 goto err; 940 941 if (ioengine_load(td)) 942 goto err; 943 944 if (o->odirect) 945 td->io_ops->flags |= FIO_RAWIO; 946 947 file_alloced = 0; 948 if (!o->filename && !td->files_index && !o->read_iolog_file) { 949 file_alloced = 1; 950 951 if (o->nr_files == 1 && exists_and_not_file(jobname)) 952 add_file(td, jobname); 953 else { 954 for (i = 0; i < o->nr_files; i++) 955 add_file(td, make_filename(fname, o, jobname, td->thread_number, i)); 956 } 957 } 958 959 if (fixup_options(td)) 960 goto err; 961 962 flow_init_job(td); 963 964 /* 965 * IO engines only need this for option callbacks, and the address may 966 * change in subprocesses. 967 */ 968 if (td->eo) 969 *(struct thread_data **)td->eo = NULL; 970 971 if (td->io_ops->flags & FIO_DISKLESSIO) { 972 struct fio_file *f; 973 974 for_each_file(td, f, i) 975 f->real_file_size = -1ULL; 976 } 977 978 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED); 979 980 td->ts.clat_percentiles = o->clat_percentiles; 981 td->ts.percentile_precision = o->percentile_precision; 982 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list)); 983 984 for (i = 0; i < DDIR_RWDIR_CNT; i++) { 985 td->ts.clat_stat[i].min_val = ULONG_MAX; 986 td->ts.slat_stat[i].min_val = ULONG_MAX; 987 td->ts.lat_stat[i].min_val = ULONG_MAX; 988 td->ts.bw_stat[i].min_val = ULONG_MAX; 989 } 990 td->ddir_seq_nr = o->ddir_seq_nr; 991 992 if ((o->stonewall || o->new_group) && prev_group_jobs) { 993 prev_group_jobs = 0; 994 groupid++; 995 } 996 997 td->groupid = groupid; 998 prev_group_jobs++; 999 1000 if (setup_random_seeds(td)) { 1001 td_verror(td, errno, "init_random_state"); 1002 goto err; 1003 } 1004 1005 if (setup_rate(td)) 1006 goto err; 1007 1008 if (o->lat_log_file) { 1009 setup_log(&td->lat_log, o->log_avg_msec, IO_LOG_TYPE_LAT); 1010 setup_log(&td->slat_log, o->log_avg_msec, IO_LOG_TYPE_SLAT); 1011 setup_log(&td->clat_log, o->log_avg_msec, IO_LOG_TYPE_CLAT); 1012 } 1013 if (o->bw_log_file) 1014 setup_log(&td->bw_log, o->log_avg_msec, IO_LOG_TYPE_BW); 1015 if (o->iops_log_file) 1016 setup_log(&td->iops_log, o->log_avg_msec, IO_LOG_TYPE_IOPS); 1017 1018 if (!o->name) 1019 o->name = strdup(jobname); 1020 1021 if (output_format == FIO_OUTPUT_NORMAL) { 1022 if (!job_add_num) { 1023 if (is_backend && !recursed) 1024 fio_server_send_add_job(td); 1025 1026 if (!(td->io_ops->flags & FIO_NOIO)) { 1027 char *c1, *c2, *c3, *c4, *c5, *c6; 1028 1029 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]); 1030 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]); 1031 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]); 1032 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]); 1033 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]); 1034 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]); 1035 1036 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s," 1037 " ioengine=%s, iodepth=%u\n", 1038 td->o.name, td->groupid, 1039 ddir_str(o->td_ddir), 1040 c1, c2, c3, c4, c5, c6, 1041 td->io_ops->name, o->iodepth); 1042 1043 free(c1); 1044 free(c2); 1045 free(c3); 1046 free(c4); 1047 free(c5); 1048 free(c6); 1049 } 1050 } else if (job_add_num == 1) 1051 log_info("...\n"); 1052 } 1053 1054 /* 1055 * recurse add identical jobs, clear numjobs and stonewall options 1056 * as they don't apply to sub-jobs 1057 */ 1058 numjobs = o->numjobs; 1059 while (--numjobs) { 1060 struct thread_data *td_new = get_new_job(0, td, 1); 1061 1062 if (!td_new) 1063 goto err; 1064 1065 td_new->o.numjobs = 1; 1066 td_new->o.stonewall = 0; 1067 td_new->o.new_group = 0; 1068 1069 if (file_alloced) { 1070 td_new->o.filename = NULL; 1071 td_new->files_index = 0; 1072 td_new->files_size = 0; 1073 td_new->files = NULL; 1074 } 1075 1076 job_add_num = numjobs - 1; 1077 1078 if (add_job(td_new, jobname, job_add_num, 1, client_type)) 1079 goto err; 1080 } 1081 1082 return 0; 1083err: 1084 put_job(td); 1085 return -1; 1086} 1087 1088/* 1089 * Parse as if 'o' was a command line 1090 */ 1091void add_job_opts(const char **o, int client_type) 1092{ 1093 struct thread_data *td, *td_parent; 1094 int i, in_global = 1; 1095 char jobname[32]; 1096 1097 i = 0; 1098 td_parent = td = NULL; 1099 while (o[i]) { 1100 if (!strncmp(o[i], "name", 4)) { 1101 in_global = 0; 1102 if (td) 1103 add_job(td, jobname, 0, 0, client_type); 1104 td = NULL; 1105 sprintf(jobname, "%s", o[i] + 5); 1106 } 1107 if (in_global && !td_parent) 1108 td_parent = get_new_job(1, &def_thread, 0); 1109 else if (!in_global && !td) { 1110 if (!td_parent) 1111 td_parent = &def_thread; 1112 td = get_new_job(0, td_parent, 0); 1113 } 1114 if (in_global) 1115 fio_options_parse(td_parent, (char **) &o[i], 1); 1116 else 1117 fio_options_parse(td, (char **) &o[i], 1); 1118 i++; 1119 } 1120 1121 if (td) 1122 add_job(td, jobname, 0, 0, client_type); 1123} 1124 1125static int skip_this_section(const char *name) 1126{ 1127 int i; 1128 1129 if (!nr_job_sections) 1130 return 0; 1131 if (!strncmp(name, "global", 6)) 1132 return 0; 1133 1134 for (i = 0; i < nr_job_sections; i++) 1135 if (!strcmp(job_sections[i], name)) 1136 return 0; 1137 1138 return 1; 1139} 1140 1141static int is_empty_or_comment(char *line) 1142{ 1143 unsigned int i; 1144 1145 for (i = 0; i < strlen(line); i++) { 1146 if (line[i] == ';') 1147 return 1; 1148 if (line[i] == '#') 1149 return 1; 1150 if (!isspace((int) line[i]) && !iscntrl((int) line[i])) 1151 return 0; 1152 } 1153 1154 return 1; 1155} 1156 1157/* 1158 * This is our [ini] type file parser. 1159 */ 1160int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type) 1161{ 1162 unsigned int global; 1163 struct thread_data *td; 1164 char *string, *name; 1165 FILE *f; 1166 char *p; 1167 int ret = 0, stonewall; 1168 int first_sect = 1; 1169 int skip_fgets = 0; 1170 int inside_skip = 0; 1171 char **opts; 1172 int i, alloc_opts, num_opts; 1173 1174 if (is_buf) 1175 f = NULL; 1176 else { 1177 if (!strcmp(file, "-")) 1178 f = stdin; 1179 else 1180 f = fopen(file, "r"); 1181 1182 if (!f) { 1183 perror("fopen job file"); 1184 return 1; 1185 } 1186 } 1187 1188 string = malloc(4096); 1189 1190 /* 1191 * it's really 256 + small bit, 280 should suffice 1192 */ 1193 name = malloc(280); 1194 memset(name, 0, 280); 1195 1196 alloc_opts = 8; 1197 opts = malloc(sizeof(char *) * alloc_opts); 1198 num_opts = 0; 1199 1200 stonewall = stonewall_flag; 1201 do { 1202 /* 1203 * if skip_fgets is set, we already have loaded a line we 1204 * haven't handled. 1205 */ 1206 if (!skip_fgets) { 1207 if (is_buf) 1208 p = strsep(&file, "\n"); 1209 else 1210 p = fgets(string, 4096, f); 1211 if (!p) 1212 break; 1213 } 1214 1215 skip_fgets = 0; 1216 strip_blank_front(&p); 1217 strip_blank_end(p); 1218 1219 if (is_empty_or_comment(p)) 1220 continue; 1221 if (sscanf(p, "[%255[^\n]]", name) != 1) { 1222 if (inside_skip) 1223 continue; 1224 log_err("fio: option <%s> outside of [] job section\n", 1225 p); 1226 break; 1227 } 1228 1229 name[strlen(name) - 1] = '\0'; 1230 1231 if (skip_this_section(name)) { 1232 inside_skip = 1; 1233 continue; 1234 } else 1235 inside_skip = 0; 1236 1237 global = !strncmp(name, "global", 6); 1238 1239 if (dump_cmdline) { 1240 if (first_sect) 1241 log_info("fio "); 1242 if (!global) 1243 log_info("--name=%s ", name); 1244 first_sect = 0; 1245 } 1246 1247 td = get_new_job(global, &def_thread, 0); 1248 if (!td) { 1249 ret = 1; 1250 break; 1251 } 1252 1253 /* 1254 * Seperate multiple job files by a stonewall 1255 */ 1256 if (!global && stonewall) { 1257 td->o.stonewall = stonewall; 1258 stonewall = 0; 1259 } 1260 1261 num_opts = 0; 1262 memset(opts, 0, alloc_opts * sizeof(char *)); 1263 1264 while (1) { 1265 if (is_buf) 1266 p = strsep(&file, "\n"); 1267 else 1268 p = fgets(string, 4096, f); 1269 if (!p) 1270 break; 1271 1272 if (is_empty_or_comment(p)) 1273 continue; 1274 1275 strip_blank_front(&p); 1276 1277 /* 1278 * new section, break out and make sure we don't 1279 * fgets() a new line at the top. 1280 */ 1281 if (p[0] == '[') { 1282 skip_fgets = 1; 1283 break; 1284 } 1285 1286 strip_blank_end(p); 1287 1288 if (num_opts == alloc_opts) { 1289 alloc_opts <<= 1; 1290 opts = realloc(opts, 1291 alloc_opts * sizeof(char *)); 1292 } 1293 1294 opts[num_opts] = strdup(p); 1295 num_opts++; 1296 } 1297 1298 ret = fio_options_parse(td, opts, num_opts); 1299 if (!ret) { 1300 if (dump_cmdline) 1301 for (i = 0; i < num_opts; i++) 1302 log_info("--%s ", opts[i]); 1303 1304 ret = add_job(td, name, 0, 0, type); 1305 } else { 1306 log_err("fio: job %s dropped\n", name); 1307 put_job(td); 1308 } 1309 1310 for (i = 0; i < num_opts; i++) 1311 free(opts[i]); 1312 num_opts = 0; 1313 } while (!ret); 1314 1315 if (dump_cmdline) 1316 log_info("\n"); 1317 1318 i = 0; 1319 while (i < nr_job_sections) { 1320 free(job_sections[i]); 1321 i++; 1322 } 1323 1324 for (i = 0; i < num_opts; i++) 1325 free(opts[i]); 1326 1327 free(string); 1328 free(name); 1329 free(opts); 1330 if (!is_buf && f != stdin) 1331 fclose(f); 1332 return ret; 1333} 1334 1335static int fill_def_thread(void) 1336{ 1337 memset(&def_thread, 0, sizeof(def_thread)); 1338 1339 fio_getaffinity(getpid(), &def_thread.o.cpumask); 1340 def_thread.o.timeout = def_timeout; 1341 def_thread.o.error_dump = 1; 1342 /* 1343 * fill default options 1344 */ 1345 fio_fill_default_options(&def_thread); 1346 return 0; 1347} 1348 1349static void usage(const char *name) 1350{ 1351 printf("%s\n", fio_version_string); 1352 printf("%s [options] [job options] <job file(s)>\n", name); 1353 printf(" --debug=options\tEnable debug logging. May be one/more of:\n" 1354 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n" 1355 "\t\t\tdiskutil,job,mutex,profile,time,net\n"); 1356 printf(" --parse-only\t\tParse options only, don't start any IO\n"); 1357 printf(" --output\t\tWrite output to file\n"); 1358 printf(" --runtime\t\tRuntime in seconds\n"); 1359 printf(" --latency-log\t\tGenerate per-job latency logs\n"); 1360 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n"); 1361 printf(" --minimal\t\tMinimal (terse) output\n"); 1362 printf(" --output-format=x\tOutput format (terse,json,normal)\n"); 1363 printf(" --terse-version=x\tSet terse version output format to 'x'\n"); 1364 printf(" --version\t\tPrint version info and exit\n"); 1365 printf(" --help\t\tPrint this page\n"); 1366 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n"); 1367 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of" 1368 " them\n"); 1369 printf(" --enghelp=engine\tPrint ioengine help, or list" 1370 " available ioengines\n"); 1371 printf(" --enghelp=engine,cmd\tPrint help for an ioengine" 1372 " cmd\n"); 1373 printf(" --showcmd\t\tTurn a job file into command line options\n"); 1374 printf(" --eta=when\t\tWhen ETA estimate should be printed\n"); 1375 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n"); 1376 printf(" --eta-newline=time\tForce a new line for every 'time'"); 1377 printf(" period passed\n"); 1378 printf(" --status-interval=t\tForce full status dump every"); 1379 printf(" 't' period passed\n"); 1380 printf(" --readonly\t\tTurn on safety read-only checks, preventing" 1381 " writes\n"); 1382 printf(" --section=name\tOnly run specified section in job file\n"); 1383 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb" 1384 " (def 1024)\n"); 1385 printf(" --warnings-fatal\tFio parser warnings are fatal\n"); 1386 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n"); 1387 printf(" --server=args\t\tStart a backend fio server\n"); 1388 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n"); 1389 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n"); 1390 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n" 1391 "\t\t\t(option=system,percpu) or run unit work\n" 1392 "\t\t\tcalibration only (option=calibrate)\n"); 1393 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>"); 1394 printf("\n Jens Axboe <jaxboe@fusionio.com>\n"); 1395} 1396 1397#ifdef FIO_INC_DEBUG 1398struct debug_level debug_levels[] = { 1399 { .name = "process", 1400 .help = "Process creation/exit logging", 1401 .shift = FD_PROCESS, 1402 }, 1403 { .name = "file", 1404 .help = "File related action logging", 1405 .shift = FD_FILE, 1406 }, 1407 { .name = "io", 1408 .help = "IO and IO engine action logging (offsets, queue, completions, etc)", 1409 .shift = FD_IO, 1410 }, 1411 { .name = "mem", 1412 .help = "Memory allocation/freeing logging", 1413 .shift = FD_MEM, 1414 }, 1415 { .name = "blktrace", 1416 .help = "blktrace action logging", 1417 .shift = FD_BLKTRACE, 1418 }, 1419 { .name = "verify", 1420 .help = "IO verification action logging", 1421 .shift = FD_VERIFY, 1422 }, 1423 { .name = "random", 1424 .help = "Random generation logging", 1425 .shift = FD_RANDOM, 1426 }, 1427 { .name = "parse", 1428 .help = "Parser logging", 1429 .shift = FD_PARSE, 1430 }, 1431 { .name = "diskutil", 1432 .help = "Disk utility logging actions", 1433 .shift = FD_DISKUTIL, 1434 }, 1435 { .name = "job", 1436 .help = "Logging related to creating/destroying jobs", 1437 .shift = FD_JOB, 1438 }, 1439 { .name = "mutex", 1440 .help = "Mutex logging", 1441 .shift = FD_MUTEX 1442 }, 1443 { .name = "profile", 1444 .help = "Logging related to profiles", 1445 .shift = FD_PROFILE, 1446 }, 1447 { .name = "time", 1448 .help = "Logging related to time keeping functions", 1449 .shift = FD_TIME, 1450 }, 1451 { .name = "net", 1452 .help = "Network logging", 1453 .shift = FD_NET, 1454 }, 1455 { .name = NULL, }, 1456}; 1457 1458static int set_debug(const char *string) 1459{ 1460 struct debug_level *dl; 1461 char *p = (char *) string; 1462 char *opt; 1463 int i; 1464 1465 if (!strcmp(string, "?") || !strcmp(string, "help")) { 1466 log_info("fio: dumping debug options:"); 1467 for (i = 0; debug_levels[i].name; i++) { 1468 dl = &debug_levels[i]; 1469 log_info("%s,", dl->name); 1470 } 1471 log_info("all\n"); 1472 return 1; 1473 } 1474 1475 while ((opt = strsep(&p, ",")) != NULL) { 1476 int found = 0; 1477 1478 if (!strncmp(opt, "all", 3)) { 1479 log_info("fio: set all debug options\n"); 1480 fio_debug = ~0UL; 1481 continue; 1482 } 1483 1484 for (i = 0; debug_levels[i].name; i++) { 1485 dl = &debug_levels[i]; 1486 found = !strncmp(opt, dl->name, strlen(dl->name)); 1487 if (!found) 1488 continue; 1489 1490 if (dl->shift == FD_JOB) { 1491 opt = strchr(opt, ':'); 1492 if (!opt) { 1493 log_err("fio: missing job number\n"); 1494 break; 1495 } 1496 opt++; 1497 fio_debug_jobno = atoi(opt); 1498 log_info("fio: set debug jobno %d\n", 1499 fio_debug_jobno); 1500 } else { 1501 log_info("fio: set debug option %s\n", opt); 1502 fio_debug |= (1UL << dl->shift); 1503 } 1504 break; 1505 } 1506 1507 if (!found) 1508 log_err("fio: debug mask %s not found\n", opt); 1509 } 1510 return 0; 1511} 1512#else 1513static int set_debug(const char *string) 1514{ 1515 log_err("fio: debug tracing not included in build\n"); 1516 return 1; 1517} 1518#endif 1519 1520static void fio_options_fill_optstring(void) 1521{ 1522 char *ostr = cmd_optstr; 1523 int i, c; 1524 1525 c = i = 0; 1526 while (l_opts[i].name) { 1527 ostr[c++] = l_opts[i].val; 1528 if (l_opts[i].has_arg == required_argument) 1529 ostr[c++] = ':'; 1530 else if (l_opts[i].has_arg == optional_argument) { 1531 ostr[c++] = ':'; 1532 ostr[c++] = ':'; 1533 } 1534 i++; 1535 } 1536 ostr[c] = '\0'; 1537} 1538 1539static int client_flag_set(char c) 1540{ 1541 int i; 1542 1543 i = 0; 1544 while (l_opts[i].name) { 1545 int val = l_opts[i].val; 1546 1547 if (c == (val & 0xff)) 1548 return (val & FIO_CLIENT_FLAG); 1549 1550 i++; 1551 } 1552 1553 return 0; 1554} 1555 1556void parse_cmd_client(void *client, char *opt) 1557{ 1558 fio_client_add_cmd_option(client, opt); 1559} 1560 1561int parse_cmd_line(int argc, char *argv[], int client_type) 1562{ 1563 struct thread_data *td = NULL; 1564 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0; 1565 char *ostr = cmd_optstr; 1566 void *pid_file = NULL; 1567 void *cur_client = NULL; 1568 int backend = 0; 1569 1570 /* 1571 * Reset optind handling, since we may call this multiple times 1572 * for the backend. 1573 */ 1574 optind = 1; 1575 1576 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) { 1577 did_arg = 1; 1578 1579 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) { 1580 parse_cmd_client(cur_client, argv[optind - 1]); 1581 c &= ~FIO_CLIENT_FLAG; 1582 } 1583 1584 switch (c) { 1585 case 'a': 1586 smalloc_pool_size = atoi(optarg); 1587 break; 1588 case 't': 1589 def_timeout = atoi(optarg); 1590 break; 1591 case 'l': 1592 write_lat_log = 1; 1593 break; 1594 case 'b': 1595 write_bw_log = 1; 1596 break; 1597 case 'o': 1598 f_out = fopen(optarg, "w+"); 1599 if (!f_out) { 1600 perror("fopen output"); 1601 exit(1); 1602 } 1603 f_err = f_out; 1604 break; 1605 case 'm': 1606 output_format = FIO_OUTPUT_TERSE; 1607 break; 1608 case 'F': 1609 if (!strcmp(optarg, "minimal") || 1610 !strcmp(optarg, "terse") || 1611 !strcmp(optarg, "csv")) 1612 output_format = FIO_OUTPUT_TERSE; 1613 else if (!strcmp(optarg, "json")) 1614 output_format = FIO_OUTPUT_JSON; 1615 else 1616 output_format = FIO_OUTPUT_NORMAL; 1617 break; 1618 case 'h': 1619 if (!cur_client) { 1620 usage(argv[0]); 1621 do_exit++; 1622 } 1623 break; 1624 case 'c': 1625 if (!cur_client) { 1626 fio_show_option_help(optarg); 1627 do_exit++; 1628 } 1629 break; 1630 case 'i': 1631 if (!cur_client) { 1632 fio_show_ioengine_help(optarg); 1633 do_exit++; 1634 } 1635 break; 1636 case 's': 1637 dump_cmdline = 1; 1638 break; 1639 case 'r': 1640 read_only = 1; 1641 break; 1642 case 'v': 1643 if (!cur_client) { 1644 log_info("%s\n", fio_version_string); 1645 do_exit++; 1646 } 1647 break; 1648 case 'V': 1649 terse_version = atoi(optarg); 1650 if (!(terse_version == 2 || terse_version == 3 || 1651 terse_version == 4)) { 1652 log_err("fio: bad terse version format\n"); 1653 exit_val = 1; 1654 do_exit++; 1655 } 1656 break; 1657 case 'e': 1658 if (!strcmp("always", optarg)) 1659 eta_print = FIO_ETA_ALWAYS; 1660 else if (!strcmp("never", optarg)) 1661 eta_print = FIO_ETA_NEVER; 1662 break; 1663 case 'E': { 1664 long long t = 0; 1665 1666 if (str_to_decimal(optarg, &t, 0, NULL)) { 1667 log_err("fio: failed parsing eta time %s\n", optarg); 1668 exit_val = 1; 1669 do_exit++; 1670 } 1671 eta_new_line = t; 1672 break; 1673 } 1674 case 'd': 1675 if (set_debug(optarg)) 1676 do_exit++; 1677 break; 1678 case 'P': 1679 parse_only = 1; 1680 break; 1681 case 'x': { 1682 size_t new_size; 1683 1684 if (!strcmp(optarg, "global")) { 1685 log_err("fio: can't use global as only " 1686 "section\n"); 1687 do_exit++; 1688 exit_val = 1; 1689 break; 1690 } 1691 new_size = (nr_job_sections + 1) * sizeof(char *); 1692 job_sections = realloc(job_sections, new_size); 1693 job_sections[nr_job_sections] = strdup(optarg); 1694 nr_job_sections++; 1695 break; 1696 } 1697 case 'p': 1698 exec_profile = strdup(optarg); 1699 break; 1700 case FIO_GETOPT_JOB: { 1701 const char *opt = l_opts[lidx].name; 1702 char *val = optarg; 1703 1704 if (!strncmp(opt, "name", 4) && td) { 1705 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type); 1706 if (ret) 1707 return 0; 1708 td = NULL; 1709 } 1710 if (!td) { 1711 int is_section = !strncmp(opt, "name", 4); 1712 int global = 0; 1713 1714 if (!is_section || !strncmp(val, "global", 6)) 1715 global = 1; 1716 1717 if (is_section && skip_this_section(val)) 1718 continue; 1719 1720 td = get_new_job(global, &def_thread, 1); 1721 if (!td || ioengine_load(td)) 1722 return 0; 1723 fio_options_set_ioengine_opts(l_opts, td); 1724 } 1725 1726 ret = fio_cmd_option_parse(td, opt, val); 1727 if (ret) 1728 do_exit++; 1729 1730 if (!ret && !strcmp(opt, "ioengine")) { 1731 free_ioengine(td); 1732 if (ioengine_load(td)) 1733 return 0; 1734 fio_options_set_ioengine_opts(l_opts, td); 1735 } 1736 break; 1737 } 1738 case FIO_GETOPT_IOENGINE: { 1739 const char *opt = l_opts[lidx].name; 1740 char *val = optarg; 1741 opt = l_opts[lidx].name; 1742 val = optarg; 1743 ret = fio_cmd_ioengine_option_parse(td, opt, val); 1744 break; 1745 } 1746 case 'w': 1747 warnings_fatal = 1; 1748 break; 1749 case 'j': 1750 max_jobs = atoi(optarg); 1751 if (!max_jobs || max_jobs > REAL_MAX_JOBS) { 1752 log_err("fio: invalid max jobs: %d\n", max_jobs); 1753 do_exit++; 1754 exit_val = 1; 1755 } 1756 break; 1757 case 'S': 1758 if (nr_clients) { 1759 log_err("fio: can't be both client and server\n"); 1760 do_exit++; 1761 exit_val = 1; 1762 break; 1763 } 1764 if (optarg) 1765 fio_server_set_arg(optarg); 1766 is_backend = 1; 1767 backend = 1; 1768 break; 1769 case 'D': 1770 pid_file = strdup(optarg); 1771 break; 1772 case 'I': 1773 if ((ret = fio_idle_prof_parse_opt(optarg))) { 1774 /* exit on error and calibration only */ 1775 do_exit++; 1776 if (ret == -1) 1777 exit_val = 1; 1778 } 1779 break; 1780 case 'C': 1781 if (is_backend) { 1782 log_err("fio: can't be both client and server\n"); 1783 do_exit++; 1784 exit_val = 1; 1785 break; 1786 } 1787 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) { 1788 log_err("fio: failed adding client %s\n", optarg); 1789 do_exit++; 1790 exit_val = 1; 1791 break; 1792 } 1793 /* 1794 * If the next argument exists and isn't an option, 1795 * assume it's a job file for this client only. 1796 */ 1797 while (optind < argc) { 1798 if (!strncmp(argv[optind], "--", 2) || 1799 !strncmp(argv[optind], "-", 1)) 1800 break; 1801 1802 fio_client_add_ini_file(cur_client, argv[optind]); 1803 optind++; 1804 } 1805 break; 1806 case 'T': 1807 do_exit++; 1808 exit_val = fio_monotonic_clocktest(); 1809 break; 1810 case 'L': { 1811 long long val; 1812 1813 if (check_str_time(optarg, &val)) { 1814 log_err("fio: failed parsing time %s\n", optarg); 1815 do_exit++; 1816 exit_val = 1; 1817 break; 1818 } 1819 status_interval = val * 1000; 1820 break; 1821 } 1822 case '?': 1823 log_err("%s: unrecognized option '%s'\n", argv[0], 1824 argv[optind - 1]); 1825 default: 1826 do_exit++; 1827 exit_val = 1; 1828 break; 1829 } 1830 if (do_exit) 1831 break; 1832 } 1833 1834 if (do_exit) { 1835 if (exit_val && !(is_backend || nr_clients)) 1836 exit(exit_val); 1837 } 1838 1839 if (nr_clients && fio_clients_connect()) { 1840 do_exit++; 1841 exit_val = 1; 1842 return -1; 1843 } 1844 1845 if (is_backend && backend) 1846 return fio_start_server(pid_file); 1847 1848 if (td) { 1849 if (!ret) 1850 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type); 1851 } 1852 1853 while (!ret && optind < argc) { 1854 ini_idx++; 1855 ini_file = realloc(ini_file, ini_idx * sizeof(char *)); 1856 ini_file[ini_idx - 1] = strdup(argv[optind]); 1857 optind++; 1858 } 1859 1860 return ini_idx; 1861} 1862 1863int fio_init_options(void) 1864{ 1865 f_out = stdout; 1866 f_err = stderr; 1867 1868 fio_options_fill_optstring(); 1869 fio_options_dup_and_init(l_opts); 1870 1871 atexit(free_shm); 1872 1873 if (fill_def_thread()) 1874 return 1; 1875 1876 return 0; 1877} 1878 1879extern int fio_check_options(struct thread_options *); 1880 1881int parse_options(int argc, char *argv[]) 1882{ 1883 const int type = FIO_CLIENT_TYPE_CLI; 1884 int job_files, i; 1885 1886 if (fio_init_options()) 1887 return 1; 1888 if (fio_test_cconv(&def_thread.o)) 1889 log_err("fio: failed internal cconv test\n"); 1890 1891 job_files = parse_cmd_line(argc, argv, type); 1892 1893 if (job_files > 0) { 1894 for (i = 0; i < job_files; i++) { 1895 if (fill_def_thread()) 1896 return 1; 1897 if (nr_clients) { 1898 if (fio_clients_send_ini(ini_file[i])) 1899 return 1; 1900 free(ini_file[i]); 1901 } else if (!is_backend) { 1902 if (parse_jobs_ini(ini_file[i], 0, i, type)) 1903 return 1; 1904 free(ini_file[i]); 1905 } 1906 } 1907 } else if (nr_clients) { 1908 if (fill_def_thread()) 1909 return 1; 1910 if (fio_clients_send_ini(NULL)) 1911 return 1; 1912 } 1913 1914 free(ini_file); 1915 fio_options_free(&def_thread); 1916 1917 if (!thread_number) { 1918 if (dump_cmdline || parse_only) 1919 return 0; 1920 if (exec_profile) 1921 return 0; 1922 if (is_backend || nr_clients) 1923 return 0; 1924 if (did_arg) 1925 return 0; 1926 1927 log_err("No jobs(s) defined\n\n"); 1928 1929 if (!did_arg) { 1930 usage(argv[0]); 1931 return 1; 1932 } 1933 1934 return 0; 1935 } 1936 1937 if (def_thread.o.gtod_offload) { 1938 fio_gtod_init(); 1939 fio_gtod_offload = 1; 1940 fio_gtod_cpu = def_thread.o.gtod_cpu; 1941 } 1942 1943 if (output_format == FIO_OUTPUT_NORMAL) 1944 log_info("%s\n", fio_version_string); 1945 1946 return 0; 1947} 1948 1949void options_default_fill(struct thread_options *o) 1950{ 1951 memcpy(o, &def_thread.o, sizeof(*o)); 1952} 1953