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