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