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