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