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