init.c

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