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