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