options: free dump options list on exit
[fio.git] / init.c
CommitLineData
906c8d75 1/*
cb2c86fd 2 * This file contains job initialization and setup functions.
906c8d75 3 */
ebac4655
JA
4#include <stdio.h>
5#include <stdlib.h>
6#include <unistd.h>
ebac4655
JA
7#include <ctype.h>
8#include <string.h>
9#include <errno.h>
10#include <sys/ipc.h>
ebac4655 11#include <sys/types.h>
3e262e2f 12#include <dlfcn.h>
4f37732a
BVA
13#ifdef CONFIG_VALGRIND_DEV
14#include <valgrind/drd.h>
15#else
16#define DRD_IGNORE_VAR(x) do { } while (0)
17#endif
ebac4655
JA
18
19#include "fio.h"
a5e0ee11
O
20#ifndef FIO_NO_HAVE_SHM_H
21#include <sys/shm.h>
22#endif
23
cb2c86fd 24#include "parse.h"
2e5cdb11 25#include "smalloc.h"
380065aa 26#include "filehash.h"
4f5af7b2 27#include "verify.h"
79d16311 28#include "profile.h"
50d16976 29#include "server.h"
f2a2ce0e 30#include "idletime.h"
243bfe19 31#include "filelock.h"
16e56d25 32#include "steadystate.h"
b9921d1a 33#include "blktrace.h"
ebac4655 34
f5bff36e 35#include "oslib/asprintf.h"
f87cc561 36#include "oslib/getopt.h"
984f30c9 37#include "oslib/strcasestr.h"
bf2e821a 38
10aa136b 39#include "crc/test.h"
d694a6a7 40#include "lib/pow2.h"
b76d85a4 41#include "lib/memcpy.h"
10aa136b 42
3d43382c 43const char fio_version_string[] = FIO_VERSION;
214e1eca 44
ee738499 45#define FIO_RANDSEED (0xb1899bedUL)
ebac4655 46
214e1eca 47static char **ini_file;
f1867a7f
JA
48static bool dump_cmdline;
49static bool parse_only;
50static bool merge_blktrace_only;
e1f36503 51
be4ecfdf 52static struct thread_data def_thread;
d41647e6 53struct thread_segment segments[REAL_MAX_SEG];
10aa136b
JA
54static char **job_sections;
55static int nr_job_sections;
e1f36503 56
f1867a7f 57bool exitall_on_terminate = false;
f3afa57e 58int output_format = FIO_OUTPUT_NORMAL;
5be4c944 59int eta_print = FIO_ETA_AUTO;
db37d890 60unsigned int eta_interval_msec = 1000;
e382e661 61int eta_new_line = 0;
214e1eca
JA
62FILE *f_out = NULL;
63FILE *f_err = NULL;
07b3232d 64char *exec_profile = NULL;
a9523c6f 65int warnings_fatal = 0;
4d658652 66int terse_version = 3;
f1867a7f
JA
67bool is_backend = false;
68bool is_local_backend = false;
a37f69b7 69int nr_clients = 0;
f1867a7f 70bool log_syslog = false;
ee738499 71
f1867a7f
JA
72bool write_bw_log = false;
73bool read_only = false;
06464907 74int status_interval = 0;
214e1eca 75
ca09be4b 76char *trigger_file = NULL;
ca09be4b 77long long trigger_timeout = 0;
b63efd30
JA
78char *trigger_cmd = NULL;
79char *trigger_remote_cmd = NULL;
ca09be4b 80
d264264a
JA
81char *aux_path = NULL;
82
214e1eca 83static int prev_group_jobs;
b4692828 84
ee56ad50 85unsigned long fio_debug = 0;
5e1d306e
JA
86unsigned int fio_debug_jobno = -1;
87unsigned int *fio_debug_jobp = NULL;
5ec3bc54 88unsigned int *fio_warned = NULL;
ee56ad50 89
4c6107ff 90static char cmd_optstr[256];
1201b24a 91static bool did_arg;
4c6107ff 92
7a4b8240
JA
93#define FIO_CLIENT_FLAG (1 << 16)
94
b4692828
JA
95/*
96 * Command line options. These will contain the above, plus a few
97 * extra that only pertain to fio itself and not jobs.
98 */
5ec10eaa 99static struct option l_opts[FIO_NR_OPTIONS] = {
b4692828 100 {
08d2a19c 101 .name = (char *) "output",
b4692828 102 .has_arg = required_argument,
7a4b8240 103 .val = 'o' | FIO_CLIENT_FLAG,
b4692828 104 },
b4692828 105 {
08d2a19c 106 .name = (char *) "latency-log",
b4692828 107 .has_arg = required_argument,
7a4b8240 108 .val = 'l' | FIO_CLIENT_FLAG,
b4692828
JA
109 },
110 {
08d2a19c 111 .name = (char *) "bandwidth-log",
2fd6fad5 112 .has_arg = no_argument,
7a4b8240 113 .val = 'b' | FIO_CLIENT_FLAG,
b4692828
JA
114 },
115 {
08d2a19c 116 .name = (char *) "minimal",
c4ec0a1d 117 .has_arg = no_argument,
7a4b8240 118 .val = 'm' | FIO_CLIENT_FLAG,
b4692828 119 },
cc372b17 120 {
f3afa57e 121 .name = (char *) "output-format",
d2c87a78 122 .has_arg = required_argument,
f3afa57e 123 .val = 'F' | FIO_CLIENT_FLAG,
cc372b17 124 },
f6a7df53
JA
125 {
126 .name = (char *) "append-terse",
127 .has_arg = optional_argument,
128 .val = 'f',
129 },
b4692828 130 {
08d2a19c 131 .name = (char *) "version",
b4692828 132 .has_arg = no_argument,
7a4b8240 133 .val = 'v' | FIO_CLIENT_FLAG,
b4692828 134 },
fd28ca49 135 {
08d2a19c 136 .name = (char *) "help",
fd28ca49 137 .has_arg = no_argument,
7a4b8240 138 .val = 'h' | FIO_CLIENT_FLAG,
fd28ca49
JA
139 },
140 {
08d2a19c 141 .name = (char *) "cmdhelp",
320beefe 142 .has_arg = optional_argument,
7a4b8240 143 .val = 'c' | FIO_CLIENT_FLAG,
fd28ca49 144 },
de890a1e 145 {
06464907 146 .name = (char *) "enghelp",
de890a1e 147 .has_arg = optional_argument,
06464907 148 .val = 'i' | FIO_CLIENT_FLAG,
de890a1e 149 },
cca73aa7 150 {
08d2a19c 151 .name = (char *) "showcmd",
cca73aa7 152 .has_arg = no_argument,
7a4b8240 153 .val = 's' | FIO_CLIENT_FLAG,
724e4435
JA
154 },
155 {
08d2a19c 156 .name = (char *) "readonly",
724e4435 157 .has_arg = no_argument,
7a4b8240 158 .val = 'r' | FIO_CLIENT_FLAG,
cca73aa7 159 },
e592a06b 160 {
08d2a19c 161 .name = (char *) "eta",
e592a06b 162 .has_arg = required_argument,
7a4b8240 163 .val = 'e' | FIO_CLIENT_FLAG,
e592a06b 164 },
db37d890
JA
165 {
166 .name = (char *) "eta-interval",
167 .has_arg = required_argument,
168 .val = 'O' | FIO_CLIENT_FLAG,
169 },
e382e661
JA
170 {
171 .name = (char *) "eta-newline",
172 .has_arg = required_argument,
173 .val = 'E' | FIO_CLIENT_FLAG,
174 },
ee56ad50 175 {
08d2a19c 176 .name = (char *) "debug",
ee56ad50 177 .has_arg = required_argument,
7a4b8240 178 .val = 'd' | FIO_CLIENT_FLAG,
ee56ad50 179 },
111e032d
JA
180 {
181 .name = (char *) "parse-only",
182 .has_arg = no_argument,
183 .val = 'P' | FIO_CLIENT_FLAG,
184 },
01f06b63 185 {
08d2a19c 186 .name = (char *) "section",
01f06b63 187 .has_arg = required_argument,
7a4b8240 188 .val = 'x' | FIO_CLIENT_FLAG,
01f06b63 189 },
b26317c9
JA
190#ifdef CONFIG_ZLIB
191 {
192 .name = (char *) "inflate-log",
193 .has_arg = required_argument,
194 .val = 'X' | FIO_CLIENT_FLAG,
195 },
196#endif
2b386d25 197 {
08d2a19c 198 .name = (char *) "alloc-size",
2b386d25 199 .has_arg = required_argument,
7a4b8240 200 .val = 'a' | FIO_CLIENT_FLAG,
2b386d25 201 },
9ac8a797 202 {
08d2a19c 203 .name = (char *) "profile",
9ac8a797 204 .has_arg = required_argument,
7a4b8240 205 .val = 'p' | FIO_CLIENT_FLAG,
9ac8a797 206 },
a9523c6f 207 {
08d2a19c 208 .name = (char *) "warnings-fatal",
a9523c6f 209 .has_arg = no_argument,
7a4b8240 210 .val = 'w' | FIO_CLIENT_FLAG,
a9523c6f 211 },
fca70358
JA
212 {
213 .name = (char *) "max-jobs",
214 .has_arg = required_argument,
7a4b8240 215 .val = 'j' | FIO_CLIENT_FLAG,
fca70358 216 },
f57a9c59
JA
217 {
218 .name = (char *) "terse-version",
219 .has_arg = required_argument,
7a4b8240 220 .val = 'V' | FIO_CLIENT_FLAG,
f57a9c59 221 },
50d16976
JA
222 {
223 .name = (char *) "server",
87aa8f19 224 .has_arg = optional_argument,
50d16976
JA
225 .val = 'S',
226 },
e46d8091 227 { .name = (char *) "daemonize",
402668f3 228 .has_arg = required_argument,
e46d8091
JA
229 .val = 'D',
230 },
132159a5
JA
231 {
232 .name = (char *) "client",
233 .has_arg = required_argument,
234 .val = 'C',
235 },
323255cc
JA
236 {
237 .name = (char *) "remote-config",
238 .has_arg = required_argument,
239 .val = 'R',
240 },
7d11f871
JA
241 {
242 .name = (char *) "cpuclock-test",
243 .has_arg = no_argument,
244 .val = 'T',
245 },
fec0f21c
JA
246 {
247 .name = (char *) "crctest",
248 .has_arg = optional_argument,
249 .val = 'G',
250 },
b76d85a4
JA
251 {
252 .name = (char *) "memcpytest",
253 .has_arg = optional_argument,
254 .val = 'M',
255 },
f2a2ce0e
HL
256 {
257 .name = (char *) "idle-prof",
258 .has_arg = required_argument,
259 .val = 'I',
260 },
06464907
JA
261 {
262 .name = (char *) "status-interval",
263 .has_arg = required_argument,
b87ed299 264 .val = 'L' | FIO_CLIENT_FLAG,
06464907 265 },
ca09be4b 266 {
b63efd30 267 .name = (char *) "trigger-file",
ca09be4b
JA
268 .has_arg = required_argument,
269 .val = 'W',
270 },
271 {
272 .name = (char *) "trigger-timeout",
273 .has_arg = required_argument,
274 .val = 'B',
275 },
b63efd30
JA
276 {
277 .name = (char *) "trigger",
278 .has_arg = required_argument,
279 .val = 'H',
280 },
281 {
282 .name = (char *) "trigger-remote",
283 .has_arg = required_argument,
284 .val = 'J',
285 },
d264264a
JA
286 {
287 .name = (char *) "aux-path",
288 .has_arg = required_argument,
289 .val = 'K',
290 },
b9921d1a
DZ
291 {
292 .name = (char *) "merge-blktrace-only",
293 .has_arg = no_argument,
294 .val = 'A' | FIO_CLIENT_FLAG,
295 },
b4692828
JA
296 {
297 .name = NULL,
298 },
299};
300
2bb3f0a7 301void free_threads_shm(void)
9d9eb2e7 302{
2fbe1e19
JA
303 int i;
304
305 for (i = 0; i < nr_segments; i++) {
306 struct thread_segment *seg = &segments[i];
307
308 if (seg->threads) {
309 void *tp = seg->threads;
c8931876 310#ifndef CONFIG_NO_SHM
2fbe1e19 311 struct shmid_ds sbuf;
9d9eb2e7 312
2fbe1e19
JA
313 seg->threads = NULL;
314 shmdt(tp);
315 shmctl(seg->shm_id, IPC_RMID, &sbuf);
316 seg->shm_id = -1;
c8931876 317#else
2fbe1e19
JA
318 seg->threads = NULL;
319 free(tp);
c8931876 320#endif
2fbe1e19 321 }
2bb3f0a7 322 }
2fbe1e19
JA
323
324 nr_segments = 0;
325 cur_segment = 0;
2bb3f0a7
JA
326}
327
10aa136b 328static void free_shm(void)
2bb3f0a7 329{
1857e6b2 330#ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
2fbe1e19 331 if (nr_segments) {
9e684a49 332 flow_exit();
9d9eb2e7 333 fio_debug_jobp = NULL;
5ec3bc54 334 fio_warned = NULL;
2bb3f0a7 335 free_threads_shm();
9d9eb2e7
JA
336 }
337
b63efd30
JA
338 free(trigger_file);
339 free(trigger_cmd);
340 free(trigger_remote_cmd);
341 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
342
5e333ada 343 options_free(fio_options, &def_thread.o);
243bfe19 344 fio_filelock_exit();
d619275c 345 file_hash_exit();
9d9eb2e7 346 scleanup();
1857e6b2 347#endif
9d9eb2e7
JA
348}
349
2fbe1e19 350static int add_thread_segment(void)
9d9eb2e7 351{
2fbe1e19
JA
352 struct thread_segment *seg = &segments[nr_segments];
353 size_t size = JOBS_PER_SEG * sizeof(struct thread_data);
4f37732a
BVA
354 int i;
355
42eb9952
JA
356 if (nr_segments + 1 >= REAL_MAX_SEG) {
357 log_err("error: maximum number of jobs reached.\n");
2fbe1e19 358 return -1;
42eb9952 359 }
9d9eb2e7 360
2fbe1e19 361 size += 2 * sizeof(unsigned int);
9d9eb2e7 362
c8931876 363#ifndef CONFIG_NO_SHM
2fbe1e19
JA
364 seg->shm_id = shmget(0, size, IPC_CREAT | 0600);
365 if (seg->shm_id == -1) {
366 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC)
9d9eb2e7 367 perror("shmget");
2fbe1e19
JA
368 return -1;
369 }
c8931876 370#else
2fbe1e19
JA
371 seg->threads = malloc(size);
372 if (!seg->threads)
373 return -1;
c8931876 374#endif
9d9eb2e7 375
c8931876 376#ifndef CONFIG_NO_SHM
d41647e6
JA
377 seg->threads = shmat(seg->shm_id, NULL, 0);
378 if (seg->threads == (void *) -1) {
9d9eb2e7
JA
379 perror("shmat");
380 return 1;
381 }
0cfe2089 382 if (shm_attach_to_open_removed())
d41647e6 383 shmctl(seg->shm_id, IPC_RMID, NULL);
c8931876 384#endif
9d9eb2e7 385
2fbe1e19
JA
386 nr_segments++;
387
388 memset(seg->threads, 0, JOBS_PER_SEG * sizeof(struct thread_data));
389 for (i = 0; i < JOBS_PER_SEG; i++)
d41647e6 390 DRD_IGNORE_VAR(seg->threads[i]);
2fbe1e19
JA
391 seg->nr_threads = 0;
392
393 /* Not first segment, we're done */
394 if (nr_segments != 1) {
395 cur_segment++;
396 return 0;
397 }
398
399 fio_debug_jobp = (unsigned int *)(seg->threads + JOBS_PER_SEG);
9d9eb2e7 400 *fio_debug_jobp = -1;
5ec3bc54
JA
401 fio_warned = fio_debug_jobp + 1;
402 *fio_warned = 0;
9e684a49
DE
403
404 flow_init();
9d9eb2e7
JA
405 return 0;
406}
407
2fbe1e19
JA
408/*
409 * The thread areas are shared between the main process and the job
410 * threads/processes, and is split into chunks of JOBS_PER_SEG. If the current
411 * segment has no more room, add a new chunk.
412 */
413static int expand_thread_area(void)
414{
415 struct thread_segment *seg = &segments[cur_segment];
416
417 if (nr_segments && seg->nr_threads < JOBS_PER_SEG)
418 return 0;
419
420 return add_thread_segment();
421}
422
c2292325
JA
423static void dump_print_option(struct print_option *p)
424{
425 const char *delim;
426
427 if (!strcmp("description", p->name))
428 delim = "\"";
429 else
430 delim = "";
431
432 log_info("--%s%s", p->name, p->value ? "" : " ");
433 if (p->value)
434 log_info("=%s%s%s ", delim, p->value, delim);
435}
436
437static void dump_opt_list(struct thread_data *td)
438{
439 struct flist_head *entry;
440 struct print_option *p;
441
442 if (flist_empty(&td->opt_list))
443 return;
444
445 flist_for_each(entry, &td->opt_list) {
446 p = flist_entry(entry, struct print_option, list);
447 dump_print_option(p);
448 }
449}
450
876e1001
JA
451static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
452{
453 struct flist_head *entry;
454
455 if (flist_empty(&src->opt_list))
456 return;
457
458 flist_for_each(entry, &src->opt_list) {
459 struct print_option *srcp, *dstp;
460
461 srcp = flist_entry(entry, struct print_option, list);
462 dstp = malloc(sizeof(*dstp));
463 dstp->name = strdup(srcp->name);
464 if (srcp->value)
465 dstp->value = strdup(srcp->value);
466 else
467 dstp->value = NULL;
468 flist_add_tail(&dstp->list, &dst->opt_list);
469 }
470}
471
906c8d75
JA
472/*
473 * Return a free job structure.
474 */
8983ce71
JA
475static struct thread_data *get_new_job(bool global, struct thread_data *parent,
476 bool preserve_eo, const char *jobname)
ebac4655 477{
2fbe1e19 478 struct thread_segment *seg;
ebac4655
JA
479 struct thread_data *td;
480
5bba8b3a 481 if (global)
ebac4655 482 return &def_thread;
2fbe1e19 483 if (expand_thread_area()) {
9d9eb2e7
JA
484 log_err("error: failed to setup shm segment\n");
485 return NULL;
486 }
ebac4655 487
2fbe1e19
JA
488 seg = &segments[cur_segment];
489 td = &seg->threads[seg->nr_threads++];
490 thread_number++;
ddaeaa5a 491 *td = *parent;
ebac4655 492
c2292325 493 INIT_FLIST_HEAD(&td->opt_list);
876e1001
JA
494 if (parent != &def_thread)
495 copy_opt_list(td, parent);
c2292325 496
de890a1e 497 td->io_ops = NULL;
356ef1a1 498 td->io_ops_init = 0;
de890a1e
SL
499 if (!preserve_eo)
500 td->eo = NULL;
501
e0b0d892
JA
502 td->o.uid = td->o.gid = -1U;
503
cade3ef4 504 dup_files(td, parent);
de890a1e 505 fio_options_mem_dupe(td);
cade3ef4 506
15dc1934
JA
507 profile_add_hooks(td);
508
ebac4655 509 td->thread_number = thread_number;
69bdd6ba 510 td->subjob_number = 0;
108fea77 511
ef3d8e53
JA
512 if (jobname)
513 td->o.name = strdup(jobname);
514
13978e86 515 if (!parent->o.group_reporting || parent == &def_thread)
108fea77
JA
516 stat_number++;
517
ebac4655
JA
518 return td;
519}
520
521static void put_job(struct thread_data *td)
522{
549577a7
JA
523 if (td == &def_thread)
524 return;
84dd1886 525
58c55ba0 526 profile_td_exit(td);
9e684a49 527 flow_exit_job(td);
549577a7 528
16edf25d 529 if (td->error)
6d86144d 530 log_info("fio: %s\n", td->verror);
16edf25d 531
7e356b2d 532 fio_options_free(td);
c2292325 533 fio_dump_options_free(td);
de890a1e
SL
534 if (td->io_ops)
535 free_ioengine(td);
7e356b2d 536
ef3d8e53
JA
537 if (td->o.name)
538 free(td->o.name);
539
d41647e6 540 memset(td, 0, sizeof(*td));
2fbe1e19 541 segments[cur_segment].nr_threads--;
ebac4655
JA
542 thread_number--;
543}
544
581e7141 545static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
127f6865 546{
5fff9543 547 unsigned long long bs = td->o.min_bs[ddir];
127f6865 548
ff58fced
JA
549 assert(ddir_rw(ddir));
550
ba3e4e0c 551 if (td->o.rate[ddir])
1b8dbf25 552 td->rate_bps[ddir] = td->o.rate[ddir];
ba3e4e0c 553 else
194fffd0 554 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
127f6865 555
1b8dbf25 556 if (!td->rate_bps[ddir]) {
127f6865
JA
557 log_err("rate lower than supported\n");
558 return -1;
559 }
560
50a8ce86 561 td->rate_next_io_time[ddir] = 0;
89cdea5e 562 td->rate_io_issue_bytes[ddir] = 0;
6c8611c7 563 td->last_usec[ddir] = 0;
127f6865
JA
564 return 0;
565}
566
581e7141
JA
567static int setup_rate(struct thread_data *td)
568{
569 int ret = 0;
570
dde39f8c
AD
571 for_each_rw_ddir(ddir) {
572 if (td->o.rate[ddir] || td->o.rate_iops[ddir]) {
573 ret |= __setup_rate(td, ddir);
574 }
575 }
581e7141
JA
576 return ret;
577}
578
8347239a
JA
579static int fixed_block_size(struct thread_options *o)
580{
581 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
582 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
6eaf09d6
SL
583 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
584 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
585 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
8347239a
JA
586}
587
8c4e634a
JA
588/*
589 * <3 Johannes
590 */
9258468e
JA
591static unsigned int gcd(unsigned int m, unsigned int n)
592{
8c4e634a
JA
593 if (!n)
594 return m;
9258468e 595
8c4e634a 596 return gcd(n, m % n);
9258468e
JA
597}
598
dad915e3
JA
599/*
600 * Lazy way of fixing up options that depend on each other. We could also
601 * define option callback handlers, but this is easier.
602 */
4e991c23 603static int fixup_options(struct thread_data *td)
e1f36503 604{
2dc1bbeb 605 struct thread_options *o = &td->o;
eefd98b1 606 int ret = 0;
dad915e3 607
c0e9a238
VF
608 if (read_only && (td_write(td) || td_trim(td))) {
609 log_err("fio: trim and write operations are not allowed"
610 " with the --readonly parameter.\n");
611 ret |= 1;
612 }
613
06eac6b2 614#ifndef CONFIG_PSHARED
9bbf57cc 615 if (!o->use_thread) {
f356d01d
JA
616 log_info("fio: this platform does not support process shared"
617 " mutexes, forcing use of threads. Use the 'thread'"
618 " option to get rid of this warning.\n");
9bbf57cc 619 o->use_thread = 1;
1cce3c66 620 ret |= warnings_fatal;
f356d01d
JA
621 }
622#endif
623
2dc1bbeb 624 if (o->write_iolog_file && o->read_iolog_file) {
076efc7c 625 log_err("fio: read iolog overrides write_iolog\n");
2dc1bbeb
JA
626 free(o->write_iolog_file);
627 o->write_iolog_file = NULL;
1cce3c66 628 ret |= warnings_fatal;
076efc7c 629 }
16b462ae 630
7b865a2f
BVA
631 if (o->zone_mode == ZONE_MODE_NONE && o->zone_size) {
632 log_err("fio: --zonemode=none and --zonesize are not compatible.\n");
633 ret |= 1;
634 }
635
bfbdd35b
BVA
636 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_size) {
637 log_err("fio: --zonesize must be specified when using --zonemode=strided.\n");
638 ret |= 1;
639 }
640
7b865a2f
BVA
641 if (o->zone_mode == ZONE_MODE_NOT_SPECIFIED) {
642 if (o->zone_size)
643 o->zone_mode = ZONE_MODE_STRIDED;
644 else
645 o->zone_mode = ZONE_MODE_NONE;
646 }
647
16b462ae 648 /*
7b865a2f 649 * Strided zone mode only really works with 1 file.
16b462ae 650 */
7b865a2f
BVA
651 if (o->zone_mode == ZONE_MODE_STRIDED && o->open_files > 1)
652 o->zone_mode = ZONE_MODE_NONE;
16b462ae 653
ed335855
SN
654 /*
655 * If zone_range isn't specified, backward compatibility dictates it
656 * should be made equal to zone_size.
657 */
7b865a2f 658 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_range)
ed335855
SN
659 o->zone_range = o->zone_size;
660
16b462ae
JA
661 /*
662 * Reads can do overwrites, we always need to pre-create the file
663 */
dcf9844e 664 if (td_read(td))
2dc1bbeb 665 o->overwrite = 1;
16b462ae 666
dde39f8c
AD
667 for_each_rw_ddir(ddir) {
668 if (!o->min_bs[ddir])
669 o->min_bs[ddir] = o->bs[ddir];
670 if (!o->max_bs[ddir])
671 o->max_bs[ddir] = o->bs[ddir];
672 }
673
674 o->rw_min_bs = -1;
675 for_each_rw_ddir(ddir) {
676 o->rw_min_bs = min(o->rw_min_bs, o->min_bs[ddir]);
677 }
a00735e6 678
2b7a01d0
JA
679 /*
680 * For random IO, allow blockalign offset other than min_bs.
681 */
dde39f8c
AD
682 for_each_rw_ddir(ddir) {
683 if (!o->ba[ddir] || !td_random(td))
684 o->ba[ddir] = o->min_bs[ddir];
685 }
2b7a01d0
JA
686
687 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
6eaf09d6
SL
688 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
689 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
9bbf57cc 690 !o->norandommap) {
2b7a01d0 691 log_err("fio: Any use of blockalign= turns off randommap\n");
9bbf57cc 692 o->norandommap = 1;
1cce3c66 693 ret |= warnings_fatal;
2b7a01d0
JA
694 }
695
2dc1bbeb
JA
696 if (!o->file_size_high)
697 o->file_size_high = o->file_size_low;
9c60ce64 698
49050b56
JA
699 if (o->start_delay_high) {
700 if (!o->start_delay_orig)
701 o->start_delay_orig = o->start_delay;
386501be 702 o->start_delay = rand_between(&td->delay_state,
5630eccf
JA
703 o->start_delay_orig,
704 o->start_delay_high);
49050b56 705 }
23ed19b0 706
8347239a
JA
707 if (o->norandommap && o->verify != VERIFY_NONE
708 && !fixed_block_size(o)) {
709 log_err("fio: norandommap given for variable block sizes, "
83da8fbf 710 "verify limited\n");
1cce3c66 711 ret |= warnings_fatal;
bb8895e0 712 }
9b87f09b 713 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
690adba3 714 log_err("fio: bs_unaligned may not work with raw io\n");
e0a22335 715
48097d5c
JA
716 /*
717 * thinktime_spin must be less than thinktime
718 */
2dc1bbeb
JA
719 if (o->thinktime_spin > o->thinktime)
720 o->thinktime_spin = o->thinktime;
e916b390
JA
721
722 /*
723 * The low water mark cannot be bigger than the iodepth
724 */
67bf9823
JA
725 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
726 o->iodepth_low = o->iodepth;
cb5ab512
JA
727
728 /*
729 * If batch number isn't set, default to the same as iodepth
730 */
2dc1bbeb
JA
731 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
732 o->iodepth_batch = o->iodepth;
b5af8293 733
82407585
RP
734 /*
735 * If max batch complete number isn't set or set incorrectly,
736 * default to the same as iodepth_batch_complete_min
737 */
738 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
739 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
740
997b5680
SW
741 /*
742 * There's no need to check for in-flight overlapping IOs if the job
743 * isn't changing data or the maximum iodepth is guaranteed to be 1
a67c6dd1 744 * when we are not in offload mode
997b5680
SW
745 */
746 if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
a67c6dd1
VF
747 (!(td_write(td) || td_trim(td)) || o->iodepth == 1) &&
748 o->io_submit_mode != IO_MODE_OFFLOAD)
997b5680 749 o->serialize_overlap = 0;
997b5680 750
2dc1bbeb
JA
751 if (o->nr_files > td->files_index)
752 o->nr_files = td->files_index;
9f9214f2 753
2dc1bbeb
JA
754 if (o->open_files > o->nr_files || !o->open_files)
755 o->open_files = o->nr_files;
4e991c23 756
6eaf09d6
SL
757 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
758 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
759 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
760 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
4e991c23 761 log_err("fio: rate and rate_iops are mutually exclusive\n");
1cce3c66 762 ret |= 1;
4e991c23 763 }
dde39f8c
AD
764 for_each_rw_ddir(ddir) {
765 if ((o->rate[ddir] && (o->rate[ddir] < o->ratemin[ddir])) ||
766 (o->rate_iops[ddir] && (o->rate_iops[ddir] < o->rate_iops_min[ddir]))) {
767 log_err("fio: minimum rate exceeds rate, ddir %d\n", +ddir);
768 ret |= 1;
769 }
4e991c23
JA
770 }
771
cf4464ca
JA
772 if (!o->timeout && o->time_based) {
773 log_err("fio: time_based requires a runtime/timeout setting\n");
774 o->time_based = 0;
1cce3c66 775 ret |= warnings_fatal;
cf4464ca
JA
776 }
777
aa31f1f1 778 if (o->fill_device && !o->size)
5921e80c 779 o->size = -1ULL;
5ec10eaa 780
9bbf57cc 781 if (o->verify != VERIFY_NONE) {
9f6d7080
SW
782 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
783 (o->filename ||
784 !(o->unique_filename &&
785 strstr(o->filename_format, "$jobname") &&
786 strstr(o->filename_format, "$jobnum") &&
787 strstr(o->filename_format, "$filenum")))) {
788 log_info("fio: multiple writers may overwrite blocks "
789 "that belong to other jobs. This can cause "
a9523c6f 790 "verification failures.\n");
1cce3c66 791 ret |= warnings_fatal;
a9523c6f
JA
792 }
793
b9f3ee6c
SW
794 /*
795 * Warn if verification is requested but no verification of any
796 * kind can be started due to time constraints
797 */
798 if (td_write(td) && o->do_verify && o->timeout &&
799 o->time_based && !td_read(td) && !o->verify_backlog) {
800 log_info("fio: verification read phase will never "
801 "start because write phase uses all of "
802 "runtime\n");
1cce3c66 803 ret |= warnings_fatal;
b9f3ee6c
SW
804 }
805
7627557b
JA
806 if (!fio_option_is_set(o, refill_buffers))
807 o->refill_buffers = 1;
808
2f1b8e8b
JA
809 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
810 !o->verify_interval)
811 o->verify_interval = o->min_bs[DDIR_WRITE];
7ffa8930
JA
812
813 /*
814 * Verify interval must be smaller or equal to the
815 * write size.
816 */
817 if (o->verify_interval > o->min_bs[DDIR_WRITE])
818 o->verify_interval = o->min_bs[DDIR_WRITE];
819 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
820 o->verify_interval = o->min_bs[DDIR_READ];
9258468e
JA
821
822 /*
c82acb8d 823 * Verify interval must be a factor of both min and max
9258468e
JA
824 * write size
825 */
c82acb8d 826 if (!o->verify_interval ||
3c0a8bc2
JA
827 (o->min_bs[DDIR_WRITE] % o->verify_interval) ||
828 (o->max_bs[DDIR_WRITE] % o->verify_interval))
9258468e 829 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
3c0a8bc2 830 o->max_bs[DDIR_WRITE]);
d990588e 831 }
41ccd845 832
9bbf57cc 833 if (o->pre_read) {
49d719fc 834 if (o->invalidate_cache)
21c1b29e 835 o->invalidate_cache = 0;
9b87f09b 836 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
9c0d2241
JA
837 log_info("fio: cannot pre-read files with an IO engine"
838 " that isn't seekable. Pre-read disabled.\n");
1cce3c66 839 ret |= warnings_fatal;
a9523c6f 840 }
9c0d2241 841 }
34f1c044 842
41a87019 843 if (o->unit_base == N2S_NONE) {
9b87f09b 844 if (td_ioengine_flagged(td, FIO_BIT_BASED))
41a87019 845 o->unit_base = N2S_BITPERSEC;
ad705bcb 846 else
41a87019 847 o->unit_base = N2S_BYTEPERSEC;
ad705bcb
SN
848 }
849
67bf9823 850#ifndef CONFIG_FDATASYNC
9bbf57cc 851 if (o->fdatasync_blocks) {
e72fa4d4
JA
852 log_info("fio: this platform does not support fdatasync()"
853 " falling back to using fsync(). Use the 'fsync'"
854 " option instead of 'fdatasync' to get rid of"
855 " this warning\n");
9bbf57cc
JA
856 o->fsync_blocks = o->fdatasync_blocks;
857 o->fdatasync_blocks = 0;
1cce3c66 858 ret |= warnings_fatal;
e72fa4d4
JA
859 }
860#endif
861
93bcfd20
BC
862#ifdef WIN32
863 /*
864 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
865 * so fail if we're passed those flags
866 */
8945237c 867 if (td_ioengine_flagged(td, FIO_SYNCIO) && (o->odirect || o->sync_io)) {
93bcfd20
BC
868 log_err("fio: Windows does not support direct or non-buffered io with"
869 " the synchronous ioengines. Use the 'windowsaio' ioengine"
870 " with 'direct=1' and 'iodepth=1' instead.\n");
1cce3c66 871 ret |= 1;
93bcfd20
BC
872 }
873#endif
874
811ac503
JA
875 /*
876 * For fully compressible data, just zero them at init time.
6269123c
JA
877 * It's faster than repeatedly filling it. For non-zero
878 * compression, we should have refill_buffers set. Set it, unless
879 * the job file already changed it.
811ac503 880 */
6269123c
JA
881 if (o->compress_percentage) {
882 if (o->compress_percentage == 100) {
883 o->zero_buffers = 1;
884 o->compress_percentage = 0;
fbf6ded2 885 } else if (!fio_option_is_set(o, refill_buffers)) {
6269123c 886 o->refill_buffers = 1;
fbf6ded2
JA
887 td->flags |= TD_F_REFILL_BUFFERS;
888 }
811ac503
JA
889 }
890
5881fda4
JA
891 /*
892 * Using a non-uniform random distribution excludes usage of
893 * a random map
894 */
8945237c
JA
895 if (o->random_distribution != FIO_RAND_DIST_RANDOM)
896 o->norandommap = 1;
5881fda4 897
8d916c94
JA
898 /*
899 * If size is set but less than the min block size, complain
900 */
901 if (o->size && o->size < td_min_bs(td)) {
5fff9543 902 log_err("fio: size too small, must not be less than minimum block size: %llu < %llu\n",
13e0f06b 903 (unsigned long long) o->size, td_min_bs(td));
1cce3c66 904 ret |= 1;
8d916c94
JA
905 }
906
d01612f3
CM
907 /*
908 * O_ATOMIC implies O_DIRECT
909 */
8945237c
JA
910 if (o->oatomic)
911 o->odirect = 1;
d01612f3 912
04778baf
JA
913 /*
914 * If randseed is set, that overrides randrepeat
915 */
8945237c
JA
916 if (fio_option_is_set(o, rand_seed))
917 o->rand_repeatable = 0;
04778baf 918
8945237c 919 if (td_ioengine_flagged(td, FIO_NOEXTEND) && o->file_append) {
b1bebc32 920 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
1cce3c66 921 ret |= 1;
b1bebc32
JA
922 }
923
79c896a1
JA
924 if (fio_option_is_set(o, gtod_cpu)) {
925 fio_gtod_init();
926 fio_gtod_set_cpu(o->gtod_cpu);
927 fio_gtod_offload = 1;
928 }
929
cf8a46a7
JA
930 td->loops = o->loops;
931 if (!td->loops)
932 td->loops = 1;
933
8945237c 934 if (o->block_error_hist && o->nr_files != 1) {
b3ec877c 935 log_err("fio: block error histogram only available "
66347cfa 936 "with a single file per job, but %d files "
8945237c 937 "provided\n", o->nr_files);
1cce3c66 938 ret |= 1;
66347cfa
DE
939 }
940
db43af34
SW
941 if (o->disable_lat)
942 o->lat_percentiles = 0;
943 if (o->disable_clat)
944 o->clat_percentiles = 0;
56440e63
VF
945 if (o->disable_slat)
946 o->slat_percentiles = 0;
db43af34 947
c3a32714
JA
948 /*
949 * Fix these up to be nsec internally
950 */
951 o->max_latency *= 1000ULL;
952 o->latency_target *= 1000ULL;
c3a32714 953
a9523c6f 954 return ret;
e1f36503
JA
955}
956
99c94a6b
JA
957static void init_rand_file_service(struct thread_data *td)
958{
959 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
960 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
961
962 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
a87c90fd 963 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, td->random_center, seed);
99c94a6b
JA
964 zipf_disable_hash(&td->next_file_zipf);
965 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
a87c90fd 966 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, td->random_center, seed);
99c94a6b
JA
967 zipf_disable_hash(&td->next_file_zipf);
968 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
a87c90fd 969 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, td->random_center, seed);
99c94a6b
JA
970 gauss_disable_hash(&td->next_file_gauss);
971 }
972}
973
8f380de2
CJ
974void td_fill_verify_state_seed(struct thread_data *td)
975{
976 bool use64;
977
978 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
40c49471 979 use64 = true;
8f380de2 980 else
40c49471 981 use64 = false;
8f380de2
CJ
982
983 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
984 use64);
985}
986
36dd3379 987static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
4c07ad86 988{
eda99d55
SW
989 uint64_t read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
990 uint64_t write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
991 uint64_t trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
36dd3379
JA
992 int i;
993
71cf4d08
JA
994 /*
995 * trimwrite is special in that we need to generate the same
996 * offsets to get the "write after trim" effect. If we are
997 * using bssplit to set buffer length distributions, ensure that
a2e31314
JA
998 * we seed the trim and write generators identically. Ditto for
999 * verify, read and writes must have the same seed, if we are doing
1000 * read verify.
71cf4d08 1001 */
a2e31314
JA
1002 if (td->o.verify != VERIFY_NONE)
1003 write_seed = read_seed;
1004 if (td_trimwrite(td))
1005 trim_seed = write_seed;
1006 init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1007 init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1008 init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
2f282cec 1009
8f380de2 1010 td_fill_verify_state_seed(td);
36dd3379 1011 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
4c07ad86
JA
1012
1013 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
c3546b53 1014 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
99c94a6b
JA
1015 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1016 init_rand_file_service(td);
4c07ad86 1017
c3546b53
JA
1018 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1019 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1020 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
6c8611c7
JA
1021 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1022 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1023 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
36dd3379
JA
1024 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1025 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
b2a432bf 1026 init_rand_seed(&td->prio_state, td->rand_seeds[FIO_RAND_PRIO_CMDS], false);
4c07ad86
JA
1027
1028 if (!td_random(td))
1029 return;
1030
1031 if (td->o.rand_repeatable)
d24945f0 1032 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
4c07ad86 1033
c3546b53 1034 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
36dd3379
JA
1035
1036 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1037 struct frand_state *s = &td->seq_rand_state[i];
1038
1039 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1040 }
5bfc35d7
JA
1041}
1042
4c07ad86
JA
1043void td_fill_rand_seeds(struct thread_data *td)
1044{
36dd3379 1045 bool use64;
c3546b53 1046
56e2a5fc 1047 if (td->o.allrand_repeatable) {
5c94b008
JA
1048 unsigned int i;
1049
1050 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
56e2a5fc
CE
1051 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1052 + i;
1053 }
1054
c3546b53 1055 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
40c49471 1056 use64 = true;
c3546b53 1057 else
40c49471 1058 use64 = false;
c3546b53
JA
1059
1060 td_fill_rand_seeds_internal(td, use64);
3545a109 1061
c3546b53 1062 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
5c94b008 1063 frand_copy(&td->buf_state_prev, &td->buf_state);
4c07ad86
JA
1064}
1065
de890a1e
SL
1066/*
1067 * Initializes the ioengine configured for a job, if it has not been done so
1068 * already.
1069 */
1070int ioengine_load(struct thread_data *td)
1071{
6e5c4b8e
JA
1072 if (!td->o.ioengine) {
1073 log_err("fio: internal fault, no IO engine specified\n");
1074 return 1;
1075 }
de890a1e 1076
800334db 1077 if (td->io_ops) {
3e262e2f
JA
1078 struct ioengine_ops *ops;
1079 void *dlhandle;
1080
800334db
BW
1081 /* An engine is loaded, but the requested ioengine
1082 * may have changed.
1083 */
1084 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1085 /* The right engine is already loaded */
1086 return 0;
1087 }
1088
3e262e2f
JA
1089 /*
1090 * Name of file and engine may be different, load ops
1091 * for this name and see if they match. If they do, then
1092 * the engine is unchanged.
1093 */
f6931a1d 1094 dlhandle = td->io_ops->dlhandle;
3e262e2f 1095 ops = load_ioengine(td);
685e367e
YK
1096 if (!ops)
1097 goto fail;
1098
48ff7df9 1099 if (ops == td->io_ops && dlhandle == td->io_ops->dlhandle)
3e262e2f
JA
1100 return 0;
1101
f6931a1d 1102 if (dlhandle && dlhandle != td->io_ops->dlhandle)
3e262e2f
JA
1103 dlclose(dlhandle);
1104
800334db
BW
1105 /* Unload the old engine. */
1106 free_ioengine(td);
1107 }
1108
4fedf59a 1109 td->io_ops = load_ioengine(td);
685e367e
YK
1110 if (!td->io_ops)
1111 goto fail;
de890a1e
SL
1112
1113 if (td->io_ops->option_struct_size && td->io_ops->options) {
1114 /*
1115 * In cases where td->eo is set, clone it for a child thread.
1116 * This requires that the parent thread has the same ioengine,
1117 * but that requirement must be enforced by the code which
1118 * cloned the thread.
1119 */
1120 void *origeo = td->eo;
1121 /*
1122 * Otherwise use the default thread options.
1123 */
1124 if (!origeo && td != &def_thread && def_thread.eo &&
1125 def_thread.io_ops->options == td->io_ops->options)
1126 origeo = def_thread.eo;
1127
1128 options_init(td->io_ops->options);
1129 td->eo = malloc(td->io_ops->option_struct_size);
1130 /*
1131 * Use the default thread as an option template if this uses the
1132 * same options structure and there are non-default options
1133 * used.
1134 */
1135 if (origeo) {
1136 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
53b5693d 1137 options_mem_dupe(td->io_ops->options, td->eo);
de890a1e
SL
1138 } else {
1139 memset(td->eo, 0, td->io_ops->option_struct_size);
1140 fill_default_options(td->eo, td->io_ops->options);
1141 }
1142 *(struct thread_data **)td->eo = td;
1143 }
1144
9b87f09b
JA
1145 if (td->o.odirect)
1146 td->io_ops->flags |= FIO_RAWIO;
1147
1148 td_set_ioengine_flags(td);
de890a1e 1149 return 0;
685e367e
YK
1150
1151fail:
1152 log_err("fio: failed to load engine\n");
1153 return 1;
1154
de890a1e
SL
1155}
1156
d72be545
JA
1157static void init_flags(struct thread_data *td)
1158{
1159 struct thread_options *o = &td->o;
5c81ff5e 1160 int i;
d72be545
JA
1161
1162 if (o->verify_backlog)
1163 td->flags |= TD_F_VER_BACKLOG;
1164 if (o->trim_backlog)
1165 td->flags |= TD_F_TRIM_BACKLOG;
1166 if (o->read_iolog_file)
1167 td->flags |= TD_F_READ_IOLOG;
1168 if (o->refill_buffers)
1169 td->flags |= TD_F_REFILL_BUFFERS;
1bf2498d 1170 /*
b04f5905 1171 * Always scramble buffers if asked to
1bf2498d 1172 */
b04f5905
JA
1173 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1174 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1175 /*
1176 * But also scramble buffers, unless we were explicitly asked
1177 * to zero them.
1178 */
1179 if (o->scramble_buffers && !(o->zero_buffers &&
1180 fio_option_is_set(o, zero_buffers)))
d72be545
JA
1181 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1182 if (o->verify != VERIFY_NONE)
553f9652 1183 td->flags |= TD_F_DO_VERIFY;
a9da8ab2
JA
1184
1185 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1186 td->flags |= TD_F_NEED_LOCK;
15600335
JA
1187
1188 if (o->mem_type == MEM_CUDA_MALLOC)
1189 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
5c81ff5e
JA
1190
1191 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1192 if (option_check_rate(td, i)) {
1193 td->flags |= TD_F_CHECK_RATE;
1194 break;
1195 }
1196 }
d72be545
JA
1197}
1198
9dbc7bfe
JA
1199static int setup_random_seeds(struct thread_data *td)
1200{
9781c080 1201 uint64_t seed;
9dbc7bfe
JA
1202 unsigned int i;
1203
1ed84d86
TK
1204 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1205 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1206 if (!ret)
1207 td_fill_rand_seeds(td);
1208 return ret;
1209 }
9dbc7bfe 1210
40fe5e7b 1211 seed = td->o.rand_seed;
04778baf 1212 for (i = 0; i < 4; i++)
9dbc7bfe
JA
1213 seed *= 0x9e370001UL;
1214
1215 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
87a0ea3b 1216 td->rand_seeds[i] = seed * td->thread_number + i;
9dbc7bfe
JA
1217 seed *= 0x9e370001UL;
1218 }
1219
1220 td_fill_rand_seeds(td);
1221 return 0;
1222}
1223
de98bd30
JA
1224enum {
1225 FPRE_NONE = 0,
1226 FPRE_JOBNAME,
1227 FPRE_JOBNUM,
8d53c5f8
TG
1228 FPRE_FILENUM,
1229 FPRE_CLIENTUID
de98bd30
JA
1230};
1231
1232static struct fpre_keyword {
1233 const char *keyword;
1234 size_t strlen;
1235 int key;
1236} fpre_keywords[] = {
1237 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1238 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1239 { .keyword = "$filenum", .key = FPRE_FILENUM, },
8d53c5f8 1240 { .keyword = "$clientuid", .key = FPRE_CLIENTUID, },
de98bd30
JA
1241 { .keyword = NULL, },
1242 };
1243
3660ceae 1244static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
de98bd30
JA
1245 const char *jobname, int jobnum, int filenum)
1246{
1247 struct fpre_keyword *f;
1248 char copy[PATH_MAX];
b400a20e 1249 size_t dst_left = PATH_MAX - 1;
de98bd30
JA
1250
1251 if (!o->filename_format || !strlen(o->filename_format)) {
1252 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
e5a43605 1253 return buf;
de98bd30
JA
1254 }
1255
1256 for (f = &fpre_keywords[0]; f->keyword; f++)
1257 f->strlen = strlen(f->keyword);
1258
36833fb0 1259 snprintf(buf, buf_size, "%s", o->filename_format);
3660ceae 1260
de98bd30
JA
1261 memset(copy, 0, sizeof(copy));
1262 for (f = &fpre_keywords[0]; f->keyword; f++) {
1263 do {
1264 size_t pre_len, post_start = 0;
1265 char *str, *dst = copy;
1266
e25b6d5a 1267 str = strcasestr(buf, f->keyword);
de98bd30
JA
1268 if (!str)
1269 break;
1270
1271 pre_len = str - buf;
1272 if (strlen(str) != f->strlen)
1273 post_start = pre_len + f->strlen;
1274
1275 if (pre_len) {
1276 strncpy(dst, buf, pre_len);
1277 dst += pre_len;
73a467e6 1278 dst_left -= pre_len;
de98bd30
JA
1279 }
1280
1281 switch (f->key) {
73a467e6
JA
1282 case FPRE_JOBNAME: {
1283 int ret;
1284
1285 ret = snprintf(dst, dst_left, "%s", jobname);
1286 if (ret < 0)
1287 break;
17a2be59
JA
1288 else if (ret > dst_left) {
1289 log_err("fio: truncated filename\n");
1290 dst += dst_left;
1291 dst_left = 0;
1292 } else {
1293 dst += ret;
1294 dst_left -= ret;
1295 }
de98bd30 1296 break;
73a467e6
JA
1297 }
1298 case FPRE_JOBNUM: {
1299 int ret;
1300
1301 ret = snprintf(dst, dst_left, "%d", jobnum);
1302 if (ret < 0)
1303 break;
17a2be59
JA
1304 else if (ret > dst_left) {
1305 log_err("fio: truncated filename\n");
1306 dst += dst_left;
1307 dst_left = 0;
1308 } else {
1309 dst += ret;
1310 dst_left -= ret;
1311 }
de98bd30 1312 break;
73a467e6
JA
1313 }
1314 case FPRE_FILENUM: {
1315 int ret;
1316
1317 ret = snprintf(dst, dst_left, "%d", filenum);
1318 if (ret < 0)
1319 break;
17a2be59
JA
1320 else if (ret > dst_left) {
1321 log_err("fio: truncated filename\n");
1322 dst += dst_left;
1323 dst_left = 0;
1324 } else {
1325 dst += ret;
1326 dst_left -= ret;
1327 }
de98bd30 1328 break;
73a467e6 1329 }
8d53c5f8
TG
1330 case FPRE_CLIENTUID: {
1331 int ret;
1332 ret = snprintf(dst, dst_left, "%s", client_sockaddr_str);
1333 if (ret < 0)
1334 break;
1335 else if (ret > dst_left) {
1336 log_err("fio: truncated filename\n");
1337 dst += dst_left;
1338 dst_left = 0;
1339 } else {
1340 dst += ret;
1341 dst_left -= ret;
1342 }
1343 break;
1344 }
de98bd30
JA
1345 default:
1346 assert(0);
1347 break;
1348 }
1349
1350 if (post_start)
73a467e6 1351 strncpy(dst, buf + post_start, dst_left);
de98bd30 1352
36833fb0 1353 snprintf(buf, buf_size, "%s", copy);
de98bd30
JA
1354 } while (1);
1355 }
1356
1357 return buf;
1358}
f9633d72 1359
8aa89d70 1360bool parse_dryrun(void)
f9633d72
JA
1361{
1362 return dump_cmdline || parse_only;
1363}
1364
3a5db920
JA
1365static void gen_log_name(char *name, size_t size, const char *logtype,
1366 const char *logname, unsigned int num,
1367 const char *suf, int per_job)
1368{
1369 if (per_job)
1370 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1371 else
1372 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1373}
1374
9cc8cb91
AK
1375static int check_waitees(char *waitee)
1376{
1377 struct thread_data *td;
1378 int i, ret = 0;
1379
1380 for_each_td(td, i) {
1381 if (td->subjob_number)
1382 continue;
1383
1384 ret += !strcmp(td->o.name, waitee);
1385 }
1386
1387 return ret;
1388}
1389
1390static bool wait_for_ok(const char *jobname, struct thread_options *o)
1391{
1392 int nw;
1393
1394 if (!o->wait_for)
1395 return true;
1396
1397 if (!strcmp(jobname, o->wait_for)) {
1398 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1399 jobname, o->wait_for);
1400 return false;
1401 }
1402
1403 if (!(nw = check_waitees(o->wait_for))) {
1404 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1405 return false;
1406 }
1407
1408 if (nw > 1) {
1409 log_err("%s: multiple waitees %s found,\n"
1410 "please avoid duplicates when using wait_for option.\n",
1411 jobname, o->wait_for);
1412 return false;
1413 }
1414
1415 return true;
1416}
1417
789b8673
JA
1418/*
1419 * Treat an empty log file name the same as a one not given
1420 */
1421static const char *make_log_name(const char *logname, const char *jobname)
1422{
1423 if (logname && strcmp(logname, ""))
1424 return logname;
1425
1426 return jobname;
1427}
1428
906c8d75
JA
1429/*
1430 * Adds a job to the list of things todo. Sanitizes the various options
1431 * to make sure we don't have conflicts, and initializes various
1432 * members of td.
1433 */
b7cfb2e1 1434static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
46bcd498 1435 int recursed, int client_type)
ebac4655 1436{
af52b345 1437 unsigned int i;
32e31c8c 1438 char fname[PATH_MAX + 1];
e132cbae 1439 int numjobs, file_alloced;
de98bd30 1440 struct thread_options *o = &td->o;
cb7e0ace 1441 char logname[PATH_MAX + 32];
ebac4655 1442
ebac4655
JA
1443 /*
1444 * the def_thread is just for options, it's not a real job
1445 */
1446 if (td == &def_thread)
1447 return 0;
1448
d72be545
JA
1449 init_flags(td);
1450
cca73aa7
JA
1451 /*
1452 * if we are just dumping the output command line, don't add the job
1453 */
f9633d72 1454 if (parse_dryrun()) {
cca73aa7
JA
1455 put_job(td);
1456 return 0;
1457 }
1458
46bcd498
JA
1459 td->client_type = client_type;
1460
58c55ba0 1461 if (profile_td_init(td))
66251554 1462 goto err;
58c55ba0 1463
de890a1e 1464 if (ioengine_load(td))
205927a3 1465 goto err;
df64119d 1466
e132cbae 1467 file_alloced = 0;
de98bd30 1468 if (!o->filename && !td->files_index && !o->read_iolog_file) {
e132cbae 1469 file_alloced = 1;
80be24f4 1470
5e62565b 1471 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
5903e7b7 1472 add_file(td, jobname, job_add_num, 0);
7b05a215 1473 else {
de98bd30 1474 for (i = 0; i < o->nr_files; i++)
3660ceae 1475 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
af52b345 1476 }
0af7b542 1477 }
ebac4655 1478
49050b56
JA
1479 if (setup_random_seeds(td)) {
1480 td_verror(td, errno, "setup_random_seeds");
1481 goto err;
1482 }
1483
4e991c23
JA
1484 if (fixup_options(td))
1485 goto err;
e0a22335 1486
9cc8cb91
AK
1487 /*
1488 * Belongs to fixup_options, but o->name is not necessarily set as yet
1489 */
1490 if (!wait_for_ok(jobname, o))
1491 goto err;
1492
9e684a49
DE
1493 flow_init_job(td);
1494
de890a1e
SL
1495 /*
1496 * IO engines only need this for option callbacks, and the address may
1497 * change in subprocesses.
1498 */
1499 if (td->eo)
1500 *(struct thread_data **)td->eo = NULL;
1501
9b87f09b 1502 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
07eb79df
JA
1503 struct fio_file *f;
1504
1505 for_each_file(td, f, i)
1506 f->real_file_size = -1ULL;
1507 }
1508
971caeb1 1509 td->sem = fio_sem_init(FIO_SEM_LOCKED);
ebac4655 1510
de98bd30 1511 td->ts.clat_percentiles = o->clat_percentiles;
b599759b 1512 td->ts.lat_percentiles = o->lat_percentiles;
56440e63 1513 td->ts.slat_percentiles = o->slat_percentiles;
de98bd30
JA
1514 td->ts.percentile_precision = o->percentile_precision;
1515 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
18aa1998 1516 td->ts.sig_figs = o->sig_figs;
83349190 1517
6eaf09d6
SL
1518 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1519 td->ts.clat_stat[i].min_val = ULONG_MAX;
1520 td->ts.slat_stat[i].min_val = ULONG_MAX;
1521 td->ts.lat_stat[i].min_val = ULONG_MAX;
1522 td->ts.bw_stat[i].min_val = ULONG_MAX;
188b6016 1523 td->ts.iops_stat[i].min_val = ULONG_MAX;
b2a432bf 1524 td->ts.clat_high_prio_stat[i].min_val = ULONG_MAX;
efd78265 1525 td->ts.clat_low_prio_stat[i].min_val = ULONG_MAX;
6eaf09d6 1526 }
7f3ecee2 1527 td->ts.sync_stat.min_val = ULONG_MAX;
de98bd30 1528 td->ddir_seq_nr = o->ddir_seq_nr;
ebac4655 1529
de98bd30 1530 if ((o->stonewall || o->new_group) && prev_group_jobs) {
3c5df6fa 1531 prev_group_jobs = 0;
ebac4655 1532 groupid++;
d883efbd
JA
1533 if (groupid == INT_MAX) {
1534 log_err("fio: too many groups defined\n");
1535 goto err;
1536 }
3c5df6fa 1537 }
ebac4655
JA
1538
1539 td->groupid = groupid;
3c5df6fa 1540 prev_group_jobs++;
ebac4655
JA
1541
1542 if (setup_rate(td))
1543 goto err;
1544
dded427c 1545 if (o->write_lat_log) {
aee2ab67
JA
1546 struct log_params p = {
1547 .td = td,
1548 .avg_msec = o->log_avg_msec,
1e613c9c
KC
1549 .hist_msec = o->log_hist_msec,
1550 .hist_coarseness = o->log_hist_coarseness,
aee2ab67
JA
1551 .log_type = IO_LOG_TYPE_LAT,
1552 .log_offset = o->log_offset,
1553 .log_gz = o->log_gz,
b26317c9 1554 .log_gz_store = o->log_gz_store,
aee2ab67 1555 };
789b8673 1556 const char *pre = make_log_name(o->lat_log_file, o->name);
b26317c9 1557 const char *suf;
aee2ab67 1558
b26317c9
JA
1559 if (p.log_gz_store)
1560 suf = "log.fz";
1561 else
1562 suf = "log";
1563
dded427c 1564 gen_log_name(logname, sizeof(logname), "lat", pre,
3a5db920 1565 td->thread_number, suf, o->per_job_logs);
aee2ab67 1566 setup_log(&td->lat_log, &p, logname);
3a5db920 1567
dded427c 1568 gen_log_name(logname, sizeof(logname), "slat", pre,
3a5db920 1569 td->thread_number, suf, o->per_job_logs);
aee2ab67 1570 setup_log(&td->slat_log, &p, logname);
3a5db920 1571
dded427c 1572 gen_log_name(logname, sizeof(logname), "clat", pre,
3a5db920 1573 td->thread_number, suf, o->per_job_logs);
aee2ab67 1574 setup_log(&td->clat_log, &p, logname);
a7935806 1575
ebac4655 1576 }
1e613c9c 1577
dded427c 1578 if (o->write_hist_log) {
1e613c9c
KC
1579 struct log_params p = {
1580 .td = td,
1581 .avg_msec = o->log_avg_msec,
1582 .hist_msec = o->log_hist_msec,
1583 .hist_coarseness = o->log_hist_coarseness,
1584 .log_type = IO_LOG_TYPE_HIST,
1585 .log_offset = o->log_offset,
1586 .log_gz = o->log_gz,
1587 .log_gz_store = o->log_gz_store,
1588 };
789b8673 1589 const char *pre = make_log_name(o->hist_log_file, o->name);
1e613c9c
KC
1590 const char *suf;
1591
66da8a60
JA
1592#ifndef CONFIG_ZLIB
1593 if (td->client_type) {
1594 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1595 goto err;
1596 }
1597#endif
1598
1e613c9c
KC
1599 if (p.log_gz_store)
1600 suf = "log.fz";
1601 else
1602 suf = "log";
1603
dded427c 1604 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1e613c9c
KC
1605 td->thread_number, suf, o->per_job_logs);
1606 setup_log(&td->clat_hist_log, &p, logname);
1607 }
1608
dded427c 1609 if (o->write_bw_log) {
aee2ab67
JA
1610 struct log_params p = {
1611 .td = td,
1612 .avg_msec = o->log_avg_msec,
1e613c9c
KC
1613 .hist_msec = o->log_hist_msec,
1614 .hist_coarseness = o->log_hist_coarseness,
aee2ab67
JA
1615 .log_type = IO_LOG_TYPE_BW,
1616 .log_offset = o->log_offset,
1617 .log_gz = o->log_gz,
b26317c9 1618 .log_gz_store = o->log_gz_store,
aee2ab67 1619 };
789b8673 1620 const char *pre = make_log_name(o->bw_log_file, o->name);
b26317c9
JA
1621 const char *suf;
1622
a47591e4
JA
1623 if (fio_option_is_set(o, bw_avg_time))
1624 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1625 else
1626 o->bw_avg_time = p.avg_msec;
c82acb8d 1627
1e613c9c
KC
1628 p.hist_msec = o->log_hist_msec;
1629 p.hist_coarseness = o->log_hist_coarseness;
a47591e4 1630
b26317c9
JA
1631 if (p.log_gz_store)
1632 suf = "log.fz";
1633 else
1634 suf = "log";
aee2ab67 1635
dded427c 1636 gen_log_name(logname, sizeof(logname), "bw", pre,
3a5db920 1637 td->thread_number, suf, o->per_job_logs);
aee2ab67 1638 setup_log(&td->bw_log, &p, logname);
cb7e0ace 1639 }
dded427c 1640 if (o->write_iops_log) {
aee2ab67
JA
1641 struct log_params p = {
1642 .td = td,
1643 .avg_msec = o->log_avg_msec,
1e613c9c
KC
1644 .hist_msec = o->log_hist_msec,
1645 .hist_coarseness = o->log_hist_coarseness,
aee2ab67
JA
1646 .log_type = IO_LOG_TYPE_IOPS,
1647 .log_offset = o->log_offset,
1648 .log_gz = o->log_gz,
b26317c9 1649 .log_gz_store = o->log_gz_store,
aee2ab67 1650 };
789b8673 1651 const char *pre = make_log_name(o->iops_log_file, o->name);
b26317c9
JA
1652 const char *suf;
1653
a47591e4
JA
1654 if (fio_option_is_set(o, iops_avg_time))
1655 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1656 else
1657 o->iops_avg_time = p.avg_msec;
c82acb8d 1658
1e613c9c
KC
1659 p.hist_msec = o->log_hist_msec;
1660 p.hist_coarseness = o->log_hist_coarseness;
a47591e4 1661
b26317c9
JA
1662 if (p.log_gz_store)
1663 suf = "log.fz";
1664 else
1665 suf = "log";
aee2ab67 1666
dded427c 1667 gen_log_name(logname, sizeof(logname), "iops", pre,
3a5db920 1668 td->thread_number, suf, o->per_job_logs);
aee2ab67 1669 setup_log(&td->iops_log, &p, logname);
cb7e0ace 1670 }
ebac4655 1671
de98bd30
JA
1672 if (!o->name)
1673 o->name = strdup(jobname);
01452055 1674
129fb2d4 1675 if (output_format & FIO_OUTPUT_NORMAL) {
b990b5c0 1676 if (!job_add_num) {
b7cfb2e1 1677 if (is_backend && !recursed)
2f122b13 1678 fio_server_send_add_job(td);
807f9971 1679
9b87f09b 1680 if (!td_ioengine_flagged(td, FIO_NOIO)) {
d21e2535
JA
1681 char *c1, *c2, *c3, *c4;
1682 char *c5 = NULL, *c6 = NULL;
d694a6a7 1683 int i2p = is_power_of_2(o->kb_base);
a41fc529 1684 struct buf_output out;
f8977ee6 1685
e883cb35
JF
1686 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1687 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1688 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1689 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
d21e2535
JA
1690
1691 if (!o->bs_is_seq_rand) {
e883cb35
JF
1692 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1693 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
d21e2535
JA
1694 }
1695
a41fc529 1696 buf_output_init(&out);
71ccdf58 1697 __log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
d21e2535
JA
1698 td->groupid,
1699 ddir_str(o->td_ddir));
1700
1701 if (o->bs_is_seq_rand)
71ccdf58 1702 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
d21e2535
JA
1703 c1, c2, c3, c4);
1704 else
71ccdf58 1705 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
d21e2535
JA
1706 c1, c2, c3, c4, c5, c6);
1707
71ccdf58 1708 __log_buf(&out, "ioengine=%s, iodepth=%u\n",
de98bd30 1709 td->io_ops->name, o->iodepth);
a41fc529 1710 log_info_buf(out.buf, out.buflen);
d5bb0a89 1711 buf_output_free(&out);
f8977ee6
JA
1712
1713 free(c1);
1714 free(c2);
1715 free(c3);
1716 free(c4);
6eaf09d6
SL
1717 free(c5);
1718 free(c6);
f8977ee6 1719 }
b990b5c0 1720 } else if (job_add_num == 1)
6d86144d 1721 log_info("...\n");
c6ae0a5b 1722 }
ebac4655 1723
56a90eba
VF
1724 if (td_steadystate_init(td))
1725 goto err;
16e56d25 1726
b9921d1a
DZ
1727 if (o->merge_blktrace_file && !merge_blktrace_iologs(td))
1728 goto err;
1729
1730 if (merge_blktrace_only) {
1731 put_job(td);
1732 return 0;
1733 }
1734
ebac4655
JA
1735 /*
1736 * recurse add identical jobs, clear numjobs and stonewall options
1737 * as they don't apply to sub-jobs
1738 */
de98bd30 1739 numjobs = o->numjobs;
ebac4655 1740 while (--numjobs) {
8983ce71 1741 struct thread_data *td_new = get_new_job(false, td, true, jobname);
ebac4655
JA
1742
1743 if (!td_new)
1744 goto err;
1745
2dc1bbeb
JA
1746 td_new->o.numjobs = 1;
1747 td_new->o.stonewall = 0;
92c1d41f 1748 td_new->o.new_group = 0;
69bdd6ba 1749 td_new->subjob_number = numjobs;
16e56d25
VF
1750 td_new->o.ss_dur = o->ss_dur * 1000000l;
1751 td_new->o.ss_limit = o->ss_limit;
e132cbae
JA
1752
1753 if (file_alloced) {
455a50fa
CE
1754 if (td_new->files) {
1755 struct fio_file *f;
e711df54
JA
1756 for_each_file(td_new, f, i)
1757 fio_file_free(f);
ece6d647 1758 free(td_new->files);
455a50fa
CE
1759 td_new->files = NULL;
1760 }
ece6d647
AK
1761 td_new->files_index = 0;
1762 td_new->files_size = 0;
455a50fa
CE
1763 if (td_new->o.filename) {
1764 free(td_new->o.filename);
1765 td_new->o.filename = NULL;
1766 }
e132cbae
JA
1767 }
1768
bcbfeefa 1769 if (add_job(td_new, jobname, numjobs, 1, client_type))
ebac4655
JA
1770 goto err;
1771 }
3c5df6fa 1772
ebac4655
JA
1773 return 0;
1774err:
1775 put_job(td);
1776 return -1;
1777}
1778
79d16311
JA
1779/*
1780 * Parse as if 'o' was a command line
1781 */
46bcd498 1782void add_job_opts(const char **o, int client_type)
79d16311
JA
1783{
1784 struct thread_data *td, *td_parent;
1785 int i, in_global = 1;
1786 char jobname[32];
1787
1788 i = 0;
1789 td_parent = td = NULL;
1790 while (o[i]) {
1791 if (!strncmp(o[i], "name", 4)) {
1792 in_global = 0;
1793 if (td)
46bcd498 1794 add_job(td, jobname, 0, 0, client_type);
79d16311
JA
1795 td = NULL;
1796 sprintf(jobname, "%s", o[i] + 5);
1797 }
1798 if (in_global && !td_parent)
8983ce71 1799 td_parent = get_new_job(true, &def_thread, false, jobname);
79d16311
JA
1800 else if (!in_global && !td) {
1801 if (!td_parent)
1802 td_parent = &def_thread;
8983ce71 1803 td = get_new_job(false, td_parent, false, jobname);
79d16311
JA
1804 }
1805 if (in_global)
c2292325 1806 fio_options_parse(td_parent, (char **) &o[i], 1);
79d16311 1807 else
c2292325 1808 fio_options_parse(td, (char **) &o[i], 1);
79d16311
JA
1809 i++;
1810 }
1811
1812 if (td)
46bcd498 1813 add_job(td, jobname, 0, 0, client_type);
79d16311
JA
1814}
1815
01f06b63
JA
1816static int skip_this_section(const char *name)
1817{
ad0a2735
JA
1818 int i;
1819
1820 if (!nr_job_sections)
01f06b63
JA
1821 return 0;
1822 if (!strncmp(name, "global", 6))
1823 return 0;
1824
ad0a2735
JA
1825 for (i = 0; i < nr_job_sections; i++)
1826 if (!strcmp(job_sections[i], name))
1827 return 0;
1828
1829 return 1;
01f06b63
JA
1830}
1831
ebac4655
JA
1832static int is_empty_or_comment(char *line)
1833{
1834 unsigned int i;
1835
1836 for (i = 0; i < strlen(line); i++) {
1837 if (line[i] == ';')
1838 return 1;
5cc2da30
IM
1839 if (line[i] == '#')
1840 return 1;
76cd9378 1841 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
ebac4655
JA
1842 return 0;
1843 }
1844
1845 return 1;
1846}
1847
07261983
JA
1848/*
1849 * This is our [ini] type file parser.
1850 */
fc8d6d05 1851static int __parse_jobs_ini(struct thread_data *td,
b3270921
AK
1852 char *file, int is_buf, int stonewall_flag, int type,
1853 int nested, char *name, char ***popts, int *aopts, int *nopts)
ebac4655 1854{
8983ce71 1855 bool global = false;
cd91e482 1856 bool stdin_occupied = false;
b3270921 1857 char *string;
ebac4655
JA
1858 FILE *f;
1859 char *p;
0c7e37a0 1860 int ret = 0, stonewall;
097b2991 1861 int first_sect = 1;
ccf8f127 1862 int skip_fgets = 0;
01f06b63 1863 int inside_skip = 0;
3b8b7135
JA
1864 char **opts;
1865 int i, alloc_opts, num_opts;
ebac4655 1866
b3270921
AK
1867 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1868 assert(td || !nested);
1869
50d16976
JA
1870 if (is_buf)
1871 f = NULL;
1872 else {
cd91e482 1873 if (!strcmp(file, "-")) {
50d16976 1874 f = stdin;
cd91e482 1875 stdin_occupied = true;
1876 } else
50d16976 1877 f = fopen(file, "r");
5a729cbe 1878
50d16976 1879 if (!f) {
323255cc
JA
1880 int __err = errno;
1881
1882 log_err("fio: unable to open '%s' job file\n", file);
02957cd4
JA
1883 if (td)
1884 td_verror(td, __err, "job file open");
50d16976
JA
1885 return 1;
1886 }
ebac4655
JA
1887 }
1888
07a2919d 1889 string = malloc(OPT_LEN_MAX);
7f7e6e59
JA
1890
1891 /*
1892 * it's really 256 + small bit, 280 should suffice
1893 */
b3270921
AK
1894 if (!nested) {
1895 name = malloc(280);
1896 memset(name, 0, 280);
1897 }
ebac4655 1898
b3270921
AK
1899 opts = NULL;
1900 if (nested && popts) {
1901 opts = *popts;
1902 alloc_opts = *aopts;
1903 num_opts = *nopts;
1904 }
1905
1906 if (!opts) {
1907 alloc_opts = 8;
1908 opts = malloc(sizeof(char *) * alloc_opts);
1909 num_opts = 0;
1910 }
3b8b7135 1911
0c7e37a0 1912 stonewall = stonewall_flag;
7c124ac1 1913 do {
ccf8f127
JA
1914 /*
1915 * if skip_fgets is set, we already have loaded a line we
1916 * haven't handled.
1917 */
1918 if (!skip_fgets) {
50d16976
JA
1919 if (is_buf)
1920 p = strsep(&file, "\n");
1921 else
07a2919d 1922 p = fgets(string, OPT_LEN_MAX, f);
ccf8f127
JA
1923 if (!p)
1924 break;
1925 }
cdc7f193 1926
ccf8f127 1927 skip_fgets = 0;
cdc7f193 1928 strip_blank_front(&p);
6c7c7da1 1929 strip_blank_end(p);
cdc7f193 1930
b3270921 1931 dprint(FD_PARSE, "%s\n", p);
ebac4655
JA
1932 if (is_empty_or_comment(p))
1933 continue;
b3270921
AK
1934
1935 if (!nested) {
1936 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1937 if (inside_skip)
1938 continue;
1939
1940 log_err("fio: option <%s> outside of "
1941 "[] job section\n", p);
0e9c21a2 1942 ret = 1;
b3270921
AK
1943 break;
1944 }
1945
1946 name[strlen(name) - 1] = '\0';
1947
1948 if (skip_this_section(name)) {
1949 inside_skip = 1;
01f06b63 1950 continue;
b3270921
AK
1951 } else
1952 inside_skip = 0;
ebac4655 1953
b3270921 1954 dprint(FD_PARSE, "Parsing section [%s]\n", name);
7a4b80a1 1955
b3270921 1956 global = !strncmp(name, "global", 6);
01f06b63 1957
b3270921
AK
1958 if (dump_cmdline) {
1959 if (first_sect)
1960 log_info("fio ");
1961 if (!global)
1962 log_info("--name=%s ", name);
1963 first_sect = 0;
1964 }
ebac4655 1965
8983ce71 1966 td = get_new_job(global, &def_thread, false, name);
b3270921
AK
1967 if (!td) {
1968 ret = 1;
1969 break;
1970 }
cca73aa7 1971
b3270921
AK
1972 /*
1973 * Separate multiple job files by a stonewall
1974 */
1975 if (!global && stonewall) {
1976 td->o.stonewall = stonewall;
1977 stonewall = 0;
1978 }
ebac4655 1979
b3270921
AK
1980 num_opts = 0;
1981 memset(opts, 0, alloc_opts * sizeof(char *));
972cfd25 1982 }
b3270921
AK
1983 else
1984 skip_fgets = 1;
3b8b7135 1985
50d16976 1986 while (1) {
b3270921
AK
1987 if (!skip_fgets) {
1988 if (is_buf)
1989 p = strsep(&file, "\n");
1990 else
07a2919d 1991 p = fgets(string, OPT_LEN_MAX, f);
b3270921
AK
1992 if (!p)
1993 break;
1994 dprint(FD_PARSE, "%s", p);
1995 }
50d16976 1996 else
b3270921 1997 skip_fgets = 0;
50d16976 1998
ebac4655
JA
1999 if (is_empty_or_comment(p))
2000 continue;
e1f36503 2001
b6754f9d 2002 strip_blank_front(&p);
7c124ac1 2003
ccf8f127
JA
2004 /*
2005 * new section, break out and make sure we don't
2006 * fgets() a new line at the top.
2007 */
2008 if (p[0] == '[') {
b3270921
AK
2009 if (nested) {
2010 log_err("No new sections in included files\n");
1809e349
JA
2011 ret = 1;
2012 goto out;
b3270921
AK
2013 }
2014
ccf8f127 2015 skip_fgets = 1;
7c124ac1 2016 break;
ccf8f127 2017 }
7c124ac1 2018
4ae3f763 2019 strip_blank_end(p);
aea47d44 2020
b3270921 2021 if (!strncmp(p, "include", strlen("include"))) {
c0821a08
AK
2022 char *filename = p + strlen("include") + 1,
2023 *ts, *full_fn = NULL;
2024
2025 /*
2026 * Allow for the include filename
2027 * specification to be relative.
2028 */
2029 if (access(filename, F_OK) &&
2030 (ts = strrchr(file, '/'))) {
36833fb0
BVA
2031 if (asprintf(&full_fn, "%.*s%s",
2032 (int)(ts - file + 1), file,
2033 filename) < 0) {
c0821a08
AK
2034 ret = ENOMEM;
2035 break;
2036 }
c0821a08
AK
2037 filename = full_fn;
2038 }
2039
2040 ret = __parse_jobs_ini(td, filename, is_buf,
2041 stonewall_flag, type, 1,
2042 name, &opts,
2043 &alloc_opts, &num_opts);
b3270921 2044
c0821a08
AK
2045 if (ret) {
2046 log_err("Error %d while parsing "
2047 "include file %s\n",
b3270921 2048 ret, filename);
b3270921 2049 }
c0821a08
AK
2050
2051 if (full_fn)
2052 free(full_fn);
2053
2054 if (ret)
2055 break;
2056
b3270921
AK
2057 continue;
2058 }
2059
3b8b7135
JA
2060 if (num_opts == alloc_opts) {
2061 alloc_opts <<= 1;
2062 opts = realloc(opts,
2063 alloc_opts * sizeof(char *));
2064 }
2065
2066 opts[num_opts] = strdup(p);
2067 num_opts++;
ebac4655 2068 }
ebac4655 2069
b3270921
AK
2070 if (nested) {
2071 *popts = opts;
2072 *aopts = alloc_opts;
2073 *nopts = num_opts;
2074 goto out;
2075 }
2076
c2292325 2077 ret = fio_options_parse(td, opts, num_opts);
d19c04d1 2078
cd91e482 2079 if (!ret && td->o.read_iolog_file != NULL) {
2080 char *fname = get_name_by_idx(td->o.read_iolog_file,
2081 td->subjob_number);
2082 if (!strcmp(fname, "-")) {
2083 if (stdin_occupied) {
2084 log_err("fio: only one user (read_iolog_file/job "
2085 "file) of stdin is permitted at once but "
2086 "more than one was found.\n");
d19c04d1 2087 ret = 1;
2088 }
cd91e482 2089 stdin_occupied = true;
d19c04d1 2090 }
2091 }
c2292325
JA
2092 if (!ret) {
2093 if (dump_cmdline)
2094 dump_opt_list(td);
2095
46bcd498 2096 ret = add_job(td, name, 0, 0, type);
c2292325 2097 } else {
b1508cf9
JA
2098 log_err("fio: job %s dropped\n", name);
2099 put_job(td);
45410acb 2100 }
3b8b7135
JA
2101
2102 for (i = 0; i < num_opts; i++)
2103 free(opts[i]);
2104 num_opts = 0;
7c124ac1 2105 } while (!ret);
ebac4655 2106
cca73aa7
JA
2107 if (dump_cmdline)
2108 log_info("\n");
2109
7e356b2d
JA
2110 i = 0;
2111 while (i < nr_job_sections) {
2112 free(job_sections[i]);
2113 i++;
2114 }
2115
2577594d 2116 free(opts);
b3270921
AK
2117out:
2118 free(string);
2119 if (!nested)
2120 free(name);
50d16976 2121 if (!is_buf && f != stdin)
5a729cbe 2122 fclose(f);
45410acb 2123 return ret;
ebac4655
JA
2124}
2125
b3270921
AK
2126int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2127{
2128 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2129 0, NULL, NULL, NULL, NULL);
2130}
2131
ebac4655
JA
2132static int fill_def_thread(void)
2133{
2134 memset(&def_thread, 0, sizeof(def_thread));
66e19a38 2135 INIT_FLIST_HEAD(&def_thread.opt_list);
ebac4655 2136
375b2695 2137 fio_getaffinity(getpid(), &def_thread.o.cpumask);
8b28bd41 2138 def_thread.o.error_dump = 1;
25bd16ce 2139
ebac4655 2140 /*
ee738499 2141 * fill default options
ebac4655 2142 */
214e1eca 2143 fio_fill_default_options(&def_thread);
ebac4655
JA
2144 return 0;
2145}
2146
2236df3d
JA
2147static void show_debug_categories(void)
2148{
44acdcf4 2149#ifdef FIO_INC_DEBUG
447931d9 2150 const struct debug_level *dl = &debug_levels[0];
2236df3d
JA
2151 int curlen, first = 1;
2152
2153 curlen = 0;
2154 while (dl->name) {
2155 int has_next = (dl + 1)->name != NULL;
2156
2157 if (first || curlen + strlen(dl->name) >= 80) {
2158 if (!first) {
2159 printf("\n");
2160 curlen = 0;
2161 }
2162 curlen += printf("\t\t\t%s", dl->name);
2163 curlen += 3 * (8 - 1);
2164 if (has_next)
2165 curlen += printf(",");
2166 } else {
2167 curlen += printf("%s", dl->name);
2168 if (has_next)
2169 curlen += printf(",");
2170 }
2171 dl++;
2172 first = 0;
2173 }
2174 printf("\n");
44acdcf4 2175#endif
2236df3d
JA
2176}
2177
baa9fe6b
TK
2178/*
2179 * Following options aren't printed by usage().
2180 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2181 * --latency-log - Deprecated option.
2182 */
45378b35 2183static void usage(const char *name)
4785f995 2184{
3d43382c 2185 printf("%s\n", fio_version_string);
45378b35 2186 printf("%s [options] [job options] <job file(s)>\n", name);
2236df3d
JA
2187 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2188 show_debug_categories();
111e032d 2189 printf(" --parse-only\t\tParse options only, don't start any IO\n");
b9921d1a 2190 printf(" --merge-blktrace-only\tMerge blktraces only, don't start any IO\n");
83881283 2191 printf(" --output\t\tWrite output to file\n");
d23ae827 2192 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
83881283 2193 printf(" --minimal\t\tMinimal (terse) output\n");
95a12fbe
TK
2194 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2195 printf(" --terse-version=type\tSet terse version output format"
2196 " (default 3, or 2 or 4)\n");
f3afa57e 2197 printf(" --version\t\tPrint version info and exit\n");
83881283 2198 printf(" --help\t\tPrint this page\n");
23893646 2199 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1a1822bf 2200 printf(" --crctest=[type]\tTest speed of checksum functions\n");
83881283 2201 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
5ec10eaa 2202 " them\n");
de890a1e
SL
2203 printf(" --enghelp=engine\tPrint ioengine help, or list"
2204 " available ioengines\n");
2205 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2206 " cmd\n");
83881283
JA
2207 printf(" --showcmd\t\tTurn a job file into command line options\n");
2208 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2209 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
9a496382 2210 printf(" --eta-newline=t\tForce a new line for every 't'");
e382e661 2211 printf(" period passed\n");
06464907
JA
2212 printf(" --status-interval=t\tForce full status dump every");
2213 printf(" 't' period passed\n");
83881283 2214 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
5ec10eaa 2215 " writes\n");
95a12fbe
TK
2216 printf(" --section=name\tOnly run specified section in job file,"
2217 " multiple sections can be specified\n");
83881283 2218 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
95a12fbe 2219 " (def 16384)\n");
83881283
JA
2220 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2221 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2222 printf(" --server=args\t\tStart a backend fio server\n");
2223 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
95a12fbe 2224 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
323255cc 2225 printf(" --remote-config=file\tTell fio server to load this local job file\n");
f2a2ce0e
HL
2226 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2227 "\t\t\t(option=system,percpu) or run unit work\n"
2228 "\t\t\tcalibration only (option=calibrate)\n");
b26317c9
JA
2229#ifdef CONFIG_ZLIB
2230 printf(" --inflate-log=log\tInflate and output compressed log\n");
2231#endif
b63efd30 2232 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2ae7a90d 2233 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
b63efd30
JA
2234 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2235 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
d264264a 2236 printf(" --aux-path=path\tUse this path for fio state generated files\n");
d292596c 2237 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
4785f995
JA
2238}
2239
79e48f72 2240#ifdef FIO_INC_DEBUG
447931d9 2241const struct debug_level debug_levels[] = {
0b8d11ed
JA
2242 { .name = "process",
2243 .help = "Process creation/exit logging",
2244 .shift = FD_PROCESS,
2245 },
2246 { .name = "file",
2247 .help = "File related action logging",
2248 .shift = FD_FILE,
2249 },
2250 { .name = "io",
2251 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2252 .shift = FD_IO,
2253 },
2254 { .name = "mem",
2255 .help = "Memory allocation/freeing logging",
2256 .shift = FD_MEM,
2257 },
2258 { .name = "blktrace",
2259 .help = "blktrace action logging",
2260 .shift = FD_BLKTRACE,
2261 },
2262 { .name = "verify",
2263 .help = "IO verification action logging",
2264 .shift = FD_VERIFY,
2265 },
2266 { .name = "random",
2267 .help = "Random generation logging",
2268 .shift = FD_RANDOM,
2269 },
2270 { .name = "parse",
2271 .help = "Parser logging",
2272 .shift = FD_PARSE,
2273 },
2274 { .name = "diskutil",
2275 .help = "Disk utility logging actions",
2276 .shift = FD_DISKUTIL,
2277 },
2278 { .name = "job",
2279 .help = "Logging related to creating/destroying jobs",
2280 .shift = FD_JOB,
2281 },
2282 { .name = "mutex",
2283 .help = "Mutex logging",
2284 .shift = FD_MUTEX
2285 },
2286 { .name = "profile",
2287 .help = "Logging related to profiles",
2288 .shift = FD_PROFILE,
2289 },
2290 { .name = "time",
2291 .help = "Logging related to time keeping functions",
2292 .shift = FD_TIME,
2293 },
2294 { .name = "net",
2295 .help = "Network logging",
2296 .shift = FD_NET,
2297 },
3e260a46
JA
2298 { .name = "rate",
2299 .help = "Rate logging",
2300 .shift = FD_RATE,
2301 },
0c56718d
JA
2302 { .name = "compress",
2303 .help = "Log compression logging",
2304 .shift = FD_COMPRESS,
2305 },
16e56d25
VF
2306 { .name = "steadystate",
2307 .help = "Steady state detection logging",
2308 .shift = FD_STEADYSTATE,
2309 },
e569ca6b
VF
2310 { .name = "helperthread",
2311 .help = "Helper thread logging",
2312 .shift = FD_HELPERTHREAD,
2313 },
4806b824
BVA
2314 { .name = "zbd",
2315 .help = "Zoned Block Device logging",
2316 .shift = FD_ZBD,
2317 },
02444ad1 2318 { .name = NULL, },
ee56ad50
JA
2319};
2320
c09823ab 2321static int set_debug(const char *string)
ee56ad50 2322{
447931d9 2323 const struct debug_level *dl;
ee56ad50
JA
2324 char *p = (char *) string;
2325 char *opt;
2326 int i;
2327
2706fa00
JA
2328 if (!string)
2329 return 0;
2330
ee56ad50 2331 if (!strcmp(string, "?") || !strcmp(string, "help")) {
ee56ad50
JA
2332 log_info("fio: dumping debug options:");
2333 for (i = 0; debug_levels[i].name; i++) {
2334 dl = &debug_levels[i];
2335 log_info("%s,", dl->name);
2336 }
bd6f78b2 2337 log_info("all\n");
c09823ab 2338 return 1;
ee56ad50
JA
2339 }
2340
2341 while ((opt = strsep(&p, ",")) != NULL) {
2342 int found = 0;
2343
5e1d306e
JA
2344 if (!strncmp(opt, "all", 3)) {
2345 log_info("fio: set all debug options\n");
2346 fio_debug = ~0UL;
2347 continue;
2348 }
2349
ee56ad50
JA
2350 for (i = 0; debug_levels[i].name; i++) {
2351 dl = &debug_levels[i];
5e1d306e
JA
2352 found = !strncmp(opt, dl->name, strlen(dl->name));
2353 if (!found)
2354 continue;
2355
2356 if (dl->shift == FD_JOB) {
2357 opt = strchr(opt, ':');
2358 if (!opt) {
2359 log_err("fio: missing job number\n");
2360 break;
2361 }
2362 opt++;
2363 fio_debug_jobno = atoi(opt);
2364 log_info("fio: set debug jobno %d\n",
2365 fio_debug_jobno);
2366 } else {
ee56ad50 2367 log_info("fio: set debug option %s\n", opt);
bd6f78b2 2368 fio_debug |= (1UL << dl->shift);
ee56ad50 2369 }
5e1d306e 2370 break;
ee56ad50
JA
2371 }
2372
2373 if (!found)
2374 log_err("fio: debug mask %s not found\n", opt);
2375 }
c09823ab 2376 return 0;
ee56ad50 2377}
79e48f72 2378#else
69b98d4c 2379static int set_debug(const char *string)
79e48f72
JA
2380{
2381 log_err("fio: debug tracing not included in build\n");
c09823ab 2382 return 1;
79e48f72
JA
2383}
2384#endif
9ac8a797 2385
4c6107ff
JA
2386static void fio_options_fill_optstring(void)
2387{
2388 char *ostr = cmd_optstr;
2389 int i, c;
2390
2391 c = i = 0;
2392 while (l_opts[i].name) {
2393 ostr[c++] = l_opts[i].val;
2394 if (l_opts[i].has_arg == required_argument)
2395 ostr[c++] = ':';
2396 else if (l_opts[i].has_arg == optional_argument) {
2397 ostr[c++] = ':';
2398 ostr[c++] = ':';
2399 }
2400 i++;
2401 }
2402 ostr[c] = '\0';
2403}
2404
c2c94585
JA
2405static int client_flag_set(char c)
2406{
2407 int i;
2408
2409 i = 0;
2410 while (l_opts[i].name) {
2411 int val = l_opts[i].val;
2412
2413 if (c == (val & 0xff))
2414 return (val & FIO_CLIENT_FLAG);
2415
2416 i++;
2417 }
2418
2419 return 0;
2420}
2421
10aa136b 2422static void parse_cmd_client(void *client, char *opt)
7a4b8240 2423{
fa2ea806 2424 fio_client_add_cmd_option(client, opt);
7a4b8240
JA
2425}
2426
a893c261
JA
2427static void show_closest_option(const char *name)
2428{
2429 int best_option, best_distance;
2430 int i, distance;
2431
2432 while (*name == '-')
2433 name++;
2434
2435 best_option = -1;
2436 best_distance = INT_MAX;
2437 i = 0;
2438 while (l_opts[i].name) {
2439 distance = string_distance(name, l_opts[i].name);
2440 if (distance < best_distance) {
2441 best_distance = distance;
2442 best_option = i;
2443 }
2444 i++;
2445 }
2446
3701636d 2447 if (best_option != -1 && string_distance_ok(name, best_distance))
a893c261
JA
2448 log_err("Did you mean %s?\n", l_opts[best_option].name);
2449}
2450
a666cab8
JA
2451static int parse_output_format(const char *optarg)
2452{
2453 char *p, *orig, *opt;
2454 int ret = 0;
2455
2456 p = orig = strdup(optarg);
2457
2458 output_format = 0;
2459
2460 while ((opt = strsep(&p, ",")) != NULL) {
2461 if (!strcmp(opt, "minimal") ||
2462 !strcmp(opt, "terse") ||
2463 !strcmp(opt, "csv"))
2464 output_format |= FIO_OUTPUT_TERSE;
2465 else if (!strcmp(opt, "json"))
2466 output_format |= FIO_OUTPUT_JSON;
513e37ee
VF
2467 else if (!strcmp(opt, "json+"))
2468 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
a666cab8
JA
2469 else if (!strcmp(opt, "normal"))
2470 output_format |= FIO_OUTPUT_NORMAL;
2471 else {
2472 log_err("fio: invalid output format %s\n", opt);
2473 ret = 1;
2474 break;
2475 }
2476 }
2477
2478 free(orig);
2479 return ret;
2480}
2481
46bcd498 2482int parse_cmd_line(int argc, char *argv[], int client_type)
ebac4655 2483{
b4692828 2484 struct thread_data *td = NULL;
c09823ab 2485 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
4c6107ff 2486 char *ostr = cmd_optstr;
977b9596 2487 char *pid_file = NULL;
9bae26e8 2488 void *cur_client = NULL;
f1867a7f 2489 bool backend = false;
ebac4655 2490
c2c94585
JA
2491 /*
2492 * Reset optind handling, since we may call this multiple times
2493 * for the backend.
2494 */
2495 optind = 1;
7a4b8240 2496
c2c94585
JA
2497 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2498 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
fa2ea806 2499 parse_cmd_client(cur_client, argv[optind - 1]);
7a4b8240
JA
2500 c &= ~FIO_CLIENT_FLAG;
2501 }
2502
ebac4655 2503 switch (c) {
2b386d25
JA
2504 case 'a':
2505 smalloc_pool_size = atoi(optarg);
52d892b2 2506 smalloc_pool_size <<= 10;
5f9454a2 2507 sinit();
2b386d25 2508 break;
b4692828 2509 case 'l':
cb7e0ace
JA
2510 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2511 do_exit++;
2512 exit_val = 1;
b4692828 2513 break;
3d73e5a9 2514 case 'b':
f1867a7f 2515 write_bw_log = true;
b4692828 2516 break;
34b1b5c6
JA
2517 case 'o': {
2518 FILE *tmp;
2519
988da120 2520 if (f_out && f_out != stdout)
5e1d8745
JA
2521 fclose(f_out);
2522
34b1b5c6
JA
2523 tmp = fopen(optarg, "w+");
2524 if (!tmp) {
2525 log_err("fio: output file open error: %s\n", strerror(errno));
2526 exit_val = 1;
2527 do_exit++;
2528 break;
b4692828 2529 }
34b1b5c6 2530 f_err = f_out = tmp;
b4692828 2531 break;
34b1b5c6 2532 }
b4692828 2533 case 'm':
f3afa57e 2534 output_format = FIO_OUTPUT_TERSE;
b4692828 2535 break;
f3afa57e 2536 case 'F':
a666cab8
JA
2537 if (parse_output_format(optarg)) {
2538 log_err("fio: failed parsing output-format\n");
2539 exit_val = 1;
2540 do_exit++;
2541 break;
2542 }
2b8c71b0 2543 break;
f6a7df53
JA
2544 case 'f':
2545 output_format |= FIO_OUTPUT_TERSE;
2546 break;
b4692828 2547 case 'h':
1201b24a 2548 did_arg = true;
7874f8b7 2549 if (!cur_client) {
c2c94585 2550 usage(argv[0]);
7874f8b7
JA
2551 do_exit++;
2552 }
c2c94585 2553 break;
fd28ca49 2554 case 'c':
1201b24a 2555 did_arg = true;
7874f8b7 2556 if (!cur_client) {
c2c94585 2557 fio_show_option_help(optarg);
7874f8b7
JA
2558 do_exit++;
2559 }
c2c94585 2560 break;
de890a1e 2561 case 'i':
1201b24a 2562 did_arg = true;
de890a1e 2563 if (!cur_client) {
291a2d85 2564 exit_val = fio_show_ioengine_help(optarg);
de890a1e
SL
2565 do_exit++;
2566 }
2567 break;
cca73aa7 2568 case 's':
1201b24a 2569 did_arg = true;
f1867a7f 2570 dump_cmdline = true;
cca73aa7 2571 break;
724e4435
JA
2572 case 'r':
2573 read_only = 1;
2574 break;
b4692828 2575 case 'v':
1201b24a 2576 did_arg = true;
7874f8b7 2577 if (!cur_client) {
3d43382c 2578 log_info("%s\n", fio_version_string);
7874f8b7
JA
2579 do_exit++;
2580 }
c2c94585 2581 break;
f57a9c59
JA
2582 case 'V':
2583 terse_version = atoi(optarg);
a2c95580 2584 if (!(terse_version >= 2 && terse_version <= 5)) {
f57a9c59
JA
2585 log_err("fio: bad terse version format\n");
2586 exit_val = 1;
2587 do_exit++;
2588 }
2589 break;
e592a06b
AC
2590 case 'e':
2591 if (!strcmp("always", optarg))
2592 eta_print = FIO_ETA_ALWAYS;
2593 else if (!strcmp("never", optarg))
2594 eta_print = FIO_ETA_NEVER;
2595 break;
e382e661
JA
2596 case 'E': {
2597 long long t = 0;
2598
88038bc7 2599 if (check_str_time(optarg, &t, 1)) {
e382e661
JA
2600 log_err("fio: failed parsing eta time %s\n", optarg);
2601 exit_val = 1;
2602 do_exit++;
db37d890 2603 break;
e382e661 2604 }
88038bc7 2605 eta_new_line = t / 1000;
db37d890
JA
2606 if (!eta_new_line) {
2607 log_err("fio: eta new line time too short\n");
2608 exit_val = 1;
2609 do_exit++;
2610 }
2611 break;
2612 }
2613 case 'O': {
2614 long long t = 0;
2615
2616 if (check_str_time(optarg, &t, 1)) {
2617 log_err("fio: failed parsing eta interval %s\n", optarg);
2618 exit_val = 1;
2619 do_exit++;
2620 break;
2621 }
2622 eta_interval_msec = t / 1000;
2623 if (eta_interval_msec < DISK_UTIL_MSEC) {
2624 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2625 exit_val = 1;
2626 do_exit++;
2627 }
e382e661
JA
2628 break;
2629 }
ee56ad50 2630 case 'd':
c09823ab
JA
2631 if (set_debug(optarg))
2632 do_exit++;
ee56ad50 2633 break;
111e032d 2634 case 'P':
1201b24a 2635 did_arg = true;
f1867a7f 2636 parse_only = true;
111e032d 2637 break;
ad0a2735
JA
2638 case 'x': {
2639 size_t new_size;
2640
01f06b63 2641 if (!strcmp(optarg, "global")) {
5ec10eaa
JA
2642 log_err("fio: can't use global as only "
2643 "section\n");
c09823ab
JA
2644 do_exit++;
2645 exit_val = 1;
01f06b63
JA
2646 break;
2647 }
ad0a2735
JA
2648 new_size = (nr_job_sections + 1) * sizeof(char *);
2649 job_sections = realloc(job_sections, new_size);
2650 job_sections[nr_job_sections] = strdup(optarg);
2651 nr_job_sections++;
01f06b63 2652 break;
ad0a2735 2653 }
b26317c9
JA
2654#ifdef CONFIG_ZLIB
2655 case 'X':
2656 exit_val = iolog_file_inflate(optarg);
1201b24a 2657 did_arg = true;
b26317c9
JA
2658 do_exit++;
2659 break;
2660#endif
9ac8a797 2661 case 'p':
1201b24a 2662 did_arg = true;
4af7c007
JA
2663 if (exec_profile)
2664 free(exec_profile);
07b3232d 2665 exec_profile = strdup(optarg);
9ac8a797 2666 break;
b4692828 2667 case FIO_GETOPT_JOB: {
5ec10eaa 2668 const char *opt = l_opts[lidx].name;
b4692828
JA
2669 char *val = optarg;
2670
c2b1e753 2671 if (!strncmp(opt, "name", 4) && td) {
46bcd498 2672 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
66251554 2673 if (ret)
4a4ac4e3 2674 goto out_free;
c2b1e753 2675 td = NULL;
1201b24a 2676 did_arg = true;
c2b1e753 2677 }
b4692828 2678 if (!td) {
01f06b63 2679 int is_section = !strncmp(opt, "name", 4);
3106f220
JA
2680 int global = 0;
2681
01f06b63 2682 if (!is_section || !strncmp(val, "global", 6))
3106f220 2683 global = 1;
c2b1e753 2684
01f06b63
JA
2685 if (is_section && skip_this_section(val))
2686 continue;
2687
8983ce71 2688 td = get_new_job(global, &def_thread, true, NULL);
f6ff24cb
JA
2689 if (!td || ioengine_load(td)) {
2690 if (td) {
2691 put_job(td);
2692 td = NULL;
2693 }
2694 do_exit++;
205a719e 2695 exit_val = 1;
f6ff24cb
JA
2696 break;
2697 }
de890a1e 2698 fio_options_set_ioengine_opts(l_opts, td);
b4692828 2699 }
38d0adb0 2700
9d918187
JA
2701 if ((!val || !strlen(val)) &&
2702 l_opts[lidx].has_arg == required_argument) {
2703 log_err("fio: option %s requires an argument\n", opt);
2704 ret = 1;
2705 } else
2706 ret = fio_cmd_option_parse(td, opt, val);
2707
bfb3ea22
JA
2708 if (ret) {
2709 if (td) {
2710 put_job(td);
2711 td = NULL;
2712 }
a88c8c14 2713 do_exit++;
205a719e 2714 exit_val = 1;
bfb3ea22 2715 }
de890a1e
SL
2716
2717 if (!ret && !strcmp(opt, "ioengine")) {
f6ff24cb 2718 if (ioengine_load(td)) {
342f570e
JA
2719 put_job(td);
2720 td = NULL;
f6ff24cb 2721 do_exit++;
205a719e 2722 exit_val = 1;
f6ff24cb
JA
2723 break;
2724 }
de890a1e
SL
2725 fio_options_set_ioengine_opts(l_opts, td);
2726 }
2727 break;
2728 }
2729 case FIO_GETOPT_IOENGINE: {
2730 const char *opt = l_opts[lidx].name;
2731 char *val = optarg;
b1ed74e0
JA
2732
2733 if (!td)
2734 break;
2735
de890a1e 2736 ret = fio_cmd_ioengine_option_parse(td, opt, val);
b4692828
JA
2737 break;
2738 }
a9523c6f
JA
2739 case 'w':
2740 warnings_fatal = 1;
2741 break;
fca70358 2742 case 'j':
42eb9952 2743 /* we don't track/need this anymore, ignore it */
fca70358 2744 break;
50d16976 2745 case 'S':
1201b24a 2746 did_arg = true;
c8931876 2747#ifndef CONFIG_NO_SHM
a37f69b7 2748 if (nr_clients) {
132159a5
JA
2749 log_err("fio: can't be both client and server\n");
2750 do_exit++;
2751 exit_val = 1;
2752 break;
2753 }
87aa8f19 2754 if (optarg)
bebe6398 2755 fio_server_set_arg(optarg);
f1867a7f
JA
2756 is_backend = true;
2757 backend = true;
c8931876
JA
2758#else
2759 log_err("fio: client/server requires SHM support\n");
2760 do_exit++;
2761 exit_val = 1;
2762#endif
50d16976 2763 break;
e46d8091 2764 case 'D':
6cfe9a8c
JA
2765 if (pid_file)
2766 free(pid_file);
402668f3 2767 pid_file = strdup(optarg);
e46d8091 2768 break;
f2a2ce0e
HL
2769 case 'I':
2770 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2771 /* exit on error and calibration only */
1201b24a 2772 did_arg = true;
f2a2ce0e 2773 do_exit++;
7d8ea970 2774 if (ret == -1)
f2a2ce0e
HL
2775 exit_val = 1;
2776 }
2777 break;
132159a5 2778 case 'C':
1201b24a 2779 did_arg = true;
132159a5
JA
2780 if (is_backend) {
2781 log_err("fio: can't be both client and server\n");
2782 do_exit++;
2783 exit_val = 1;
2784 break;
2785 }
08633c32
BE
2786 /* if --client parameter contains a pathname */
2787 if (0 == access(optarg, R_OK)) {
2788 /* file contains a list of host addrs or names */
2972708f 2789 char hostaddr[PATH_MAX] = {0};
08633c32
BE
2790 char formatstr[8];
2791 FILE * hostf = fopen(optarg, "r");
2792 if (!hostf) {
2793 log_err("fio: could not open client list file %s for read\n", optarg);
2794 do_exit++;
2795 exit_val = 1;
2796 break;
2797 }
2972708f
JA
2798 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2799 /*
2800 * read at most PATH_MAX-1 chars from each
2801 * record in this file
2802 */
08633c32
BE
2803 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2804 /* expect EVERY host in file to be valid */
2805 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2806 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2807 do_exit++;
2808 exit_val = 1;
2809 break;
2810 }
2811 }
2812 fclose(hostf);
2813 break; /* no possibility of job file for "this client only" */
2814 }
a5276616 2815 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
bebe6398
JA
2816 log_err("fio: failed adding client %s\n", optarg);
2817 do_exit++;
2818 exit_val = 1;
2819 break;
2820 }
14ea90ed
JA
2821 /*
2822 * If the next argument exists and isn't an option,
2823 * assume it's a job file for this client only.
2824 */
2825 while (optind < argc) {
2826 if (!strncmp(argv[optind], "--", 2) ||
2827 !strncmp(argv[optind], "-", 1))
2828 break;
2829
bb781643 2830 if (fio_client_add_ini_file(cur_client, argv[optind], false))
323255cc 2831 break;
14ea90ed
JA
2832 optind++;
2833 }
132159a5 2834 break;
323255cc 2835 case 'R':
1201b24a 2836 did_arg = true;
bb781643 2837 if (fio_client_add_ini_file(cur_client, optarg, true)) {
323255cc
JA
2838 do_exit++;
2839 exit_val = 1;
2840 }
2841 break;
7d11f871 2842 case 'T':
1201b24a 2843 did_arg = true;
7d11f871 2844 do_exit++;
aad918e4 2845 exit_val = fio_monotonic_clocktest(1);
7d11f871 2846 break;
fec0f21c 2847 case 'G':
1201b24a 2848 did_arg = true;
fec0f21c
JA
2849 do_exit++;
2850 exit_val = fio_crctest(optarg);
2851 break;
b76d85a4
JA
2852 case 'M':
2853 did_arg = true;
2854 do_exit++;
2855 exit_val = fio_memcpy_test(optarg);
2856 break;
06464907
JA
2857 case 'L': {
2858 long long val;
2859
88038bc7 2860 if (check_str_time(optarg, &val, 1)) {
06464907
JA
2861 log_err("fio: failed parsing time %s\n", optarg);
2862 do_exit++;
2863 exit_val = 1;
2864 break;
2865 }
969357b0
JA
2866 if (val < 1000) {
2867 log_err("fio: status interval too small\n");
2868 do_exit++;
2869 exit_val = 1;
2870 }
88038bc7 2871 status_interval = val / 1000;
06464907
JA
2872 break;
2873 }
b63efd30 2874 case 'W':
f9cbae9e
JA
2875 if (trigger_file)
2876 free(trigger_file);
b63efd30
JA
2877 trigger_file = strdup(optarg);
2878 break;
2879 case 'H':
f9cbae9e
JA
2880 if (trigger_cmd)
2881 free(trigger_cmd);
b63efd30
JA
2882 trigger_cmd = strdup(optarg);
2883 break;
2884 case 'J':
f9cbae9e
JA
2885 if (trigger_remote_cmd)
2886 free(trigger_remote_cmd);
b63efd30 2887 trigger_remote_cmd = strdup(optarg);
ca09be4b 2888 break;
d264264a
JA
2889 case 'K':
2890 if (aux_path)
2891 free(aux_path);
2892 aux_path = strdup(optarg);
2893 break;
ca09be4b
JA
2894 case 'B':
2895 if (check_str_time(optarg, &trigger_timeout, 1)) {
2896 log_err("fio: failed parsing time %s\n", optarg);
2897 do_exit++;
2898 exit_val = 1;
2899 }
2900 trigger_timeout /= 1000000;
2901 break;
b9921d1a
DZ
2902
2903 case 'A':
2904 did_arg = true;
f1867a7f 2905 merge_blktrace_only = true;
b9921d1a 2906 break;
798827c8
JA
2907 case '?':
2908 log_err("%s: unrecognized option '%s'\n", argv[0],
2909 argv[optind - 1]);
a893c261 2910 show_closest_option(argv[optind - 1]);
db83b0ab 2911 fallthrough;
b4692828 2912 default:
c09823ab
JA
2913 do_exit++;
2914 exit_val = 1;
b4692828 2915 break;
ebac4655 2916 }
c7d5c941
JA
2917 if (do_exit)
2918 break;
ebac4655 2919 }
c9fad893 2920
0b14f0a8
JA
2921 if (do_exit && !(is_backend || nr_clients))
2922 exit(exit_val);
536582bf 2923
fb296043
JA
2924 if (nr_clients && fio_clients_connect())
2925 exit(1);
132159a5 2926
81179eec 2927 if (is_backend && backend)
402668f3 2928 return fio_start_server(pid_file);
b8ba87ac
JA
2929 else if (pid_file)
2930 free(pid_file);
50d16976 2931
b4692828 2932 if (td) {
7d8ea970 2933 if (!ret) {
46bcd498 2934 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
7d8ea970 2935 if (ret)
3bc20ebd 2936 exit(1);
7d8ea970 2937 }
972cfd25 2938 }
774a6177 2939
7874f8b7 2940 while (!ret && optind < argc) {
b4692828
JA
2941 ini_idx++;
2942 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2943 ini_file[ini_idx - 1] = strdup(argv[optind]);
2944 optind++;
eb8bbf48 2945 }
972cfd25 2946
4a4ac4e3 2947out_free:
972cfd25 2948 return ini_idx;
ebac4655
JA
2949}
2950
0420ba6a 2951int fio_init_options(void)
ebac4655 2952{
b4692828
JA
2953 f_out = stdout;
2954 f_err = stderr;
2955
4c6107ff 2956 fio_options_fill_optstring();
5ec10eaa 2957 fio_options_dup_and_init(l_opts);
b4692828 2958
9d9eb2e7
JA
2959 atexit(free_shm);
2960
ebac4655
JA
2961 if (fill_def_thread())
2962 return 1;
2963
0420ba6a
JA
2964 return 0;
2965}
2966
51167799
JA
2967extern int fio_check_options(struct thread_options *);
2968
0420ba6a
JA
2969int parse_options(int argc, char *argv[])
2970{
46bcd498 2971 const int type = FIO_CLIENT_TYPE_CLI;
0420ba6a
JA
2972 int job_files, i;
2973
2974 if (fio_init_options())
2975 return 1;
51167799
JA
2976 if (fio_test_cconv(&def_thread.o))
2977 log_err("fio: failed internal cconv test\n");
0420ba6a 2978
46bcd498 2979 job_files = parse_cmd_line(argc, argv, type);
ebac4655 2980
cdf54d85
JA
2981 if (job_files > 0) {
2982 for (i = 0; i < job_files; i++) {
bc4f5ef6 2983 if (i && fill_def_thread())
132159a5 2984 return 1;
cdf54d85
JA
2985 if (nr_clients) {
2986 if (fio_clients_send_ini(ini_file[i]))
2987 return 1;
2988 free(ini_file[i]);
2989 } else if (!is_backend) {
46bcd498 2990 if (parse_jobs_ini(ini_file[i], 0, i, type))
cdf54d85
JA
2991 return 1;
2992 free(ini_file[i]);
2993 }
132159a5 2994 }
14ea90ed
JA
2995 } else if (nr_clients) {
2996 if (fill_def_thread())
2997 return 1;
2998 if (fio_clients_send_ini(NULL))
2999 return 1;
972cfd25 3000 }
ebac4655 3001
88c6ed80 3002 free(ini_file);
7e356b2d 3003 fio_options_free(&def_thread);
bcbfeefa 3004 filesetup_mem_free();
b4692828
JA
3005
3006 if (!thread_number) {
f9633d72 3007 if (parse_dryrun())
cca73aa7 3008 return 0;
07b3232d
JA
3009 if (exec_profile)
3010 return 0;
a37f69b7 3011 if (is_backend || nr_clients)
5c341e9a 3012 return 0;
085399db
JA
3013 if (did_arg)
3014 return 0;
cca73aa7 3015
4bb7a775 3016 log_err("No job(s) defined\n\n");
a2e4a093
JA
3017 usage(argv[0]);
3018 return 1;
b4692828
JA
3019 }
3020
129fb2d4 3021 if (output_format & FIO_OUTPUT_NORMAL)
3d43382c 3022 log_info("%s\n", fio_version_string);
f6dea4d3 3023
ebac4655
JA
3024 return 0;
3025}
588b7f09
JA
3026
3027void options_default_fill(struct thread_options *o)
3028{
3029 memcpy(o, &def_thread.o, sizeof(*o));
3030}
c2292325 3031
66e19a38 3032struct thread_data *get_global_options(void)
c2292325 3033{
66e19a38 3034 return &def_thread;
c2292325 3035}