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