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