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