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