os/windows/posix.c: Strip trailing whitespace
[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);
685e367e
YK
1102 if (!ops)
1103 goto fail;
1104
14dc963c
JA
1105 if (ops == td->io_ops && dlhandle == td->io_ops_dlhandle) {
1106 if (dlhandle)
1107 dlclose(dlhandle);
3e262e2f 1108 return 0;
14dc963c 1109 }
3e262e2f
JA
1110
1111 if (dlhandle && dlhandle != td->io_ops_dlhandle)
1112 dlclose(dlhandle);
1113
800334db
BW
1114 /* Unload the old engine. */
1115 free_ioengine(td);
1116 }
1117
4fedf59a 1118 td->io_ops = load_ioengine(td);
685e367e
YK
1119 if (!td->io_ops)
1120 goto fail;
de890a1e
SL
1121
1122 if (td->io_ops->option_struct_size && td->io_ops->options) {
1123 /*
1124 * In cases where td->eo is set, clone it for a child thread.
1125 * This requires that the parent thread has the same ioengine,
1126 * but that requirement must be enforced by the code which
1127 * cloned the thread.
1128 */
1129 void *origeo = td->eo;
1130 /*
1131 * Otherwise use the default thread options.
1132 */
1133 if (!origeo && td != &def_thread && def_thread.eo &&
1134 def_thread.io_ops->options == td->io_ops->options)
1135 origeo = def_thread.eo;
1136
1137 options_init(td->io_ops->options);
1138 td->eo = malloc(td->io_ops->option_struct_size);
1139 /*
1140 * Use the default thread as an option template if this uses the
1141 * same options structure and there are non-default options
1142 * used.
1143 */
1144 if (origeo) {
1145 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
53b5693d 1146 options_mem_dupe(td->io_ops->options, td->eo);
de890a1e
SL
1147 } else {
1148 memset(td->eo, 0, td->io_ops->option_struct_size);
1149 fill_default_options(td->eo, td->io_ops->options);
1150 }
1151 *(struct thread_data **)td->eo = td;
1152 }
1153
9b87f09b
JA
1154 if (td->o.odirect)
1155 td->io_ops->flags |= FIO_RAWIO;
1156
1157 td_set_ioengine_flags(td);
de890a1e 1158 return 0;
685e367e
YK
1159
1160fail:
1161 log_err("fio: failed to load engine\n");
1162 return 1;
1163
de890a1e
SL
1164}
1165
d72be545
JA
1166static void init_flags(struct thread_data *td)
1167{
1168 struct thread_options *o = &td->o;
5c81ff5e 1169 int i;
d72be545
JA
1170
1171 if (o->verify_backlog)
1172 td->flags |= TD_F_VER_BACKLOG;
1173 if (o->trim_backlog)
1174 td->flags |= TD_F_TRIM_BACKLOG;
1175 if (o->read_iolog_file)
1176 td->flags |= TD_F_READ_IOLOG;
1177 if (o->refill_buffers)
1178 td->flags |= TD_F_REFILL_BUFFERS;
1bf2498d 1179 /*
b04f5905 1180 * Always scramble buffers if asked to
1bf2498d 1181 */
b04f5905
JA
1182 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1183 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1184 /*
1185 * But also scramble buffers, unless we were explicitly asked
1186 * to zero them.
1187 */
1188 if (o->scramble_buffers && !(o->zero_buffers &&
1189 fio_option_is_set(o, zero_buffers)))
d72be545
JA
1190 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1191 if (o->verify != VERIFY_NONE)
553f9652 1192 td->flags |= TD_F_DO_VERIFY;
a9da8ab2
JA
1193
1194 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1195 td->flags |= TD_F_NEED_LOCK;
15600335
JA
1196
1197 if (o->mem_type == MEM_CUDA_MALLOC)
1198 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
5c81ff5e
JA
1199
1200 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1201 if (option_check_rate(td, i)) {
1202 td->flags |= TD_F_CHECK_RATE;
1203 break;
1204 }
1205 }
d72be545
JA
1206}
1207
9dbc7bfe
JA
1208static int setup_random_seeds(struct thread_data *td)
1209{
9781c080 1210 uint64_t seed;
9dbc7bfe
JA
1211 unsigned int i;
1212
1ed84d86
TK
1213 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1214 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1215 if (!ret)
1216 td_fill_rand_seeds(td);
1217 return ret;
1218 }
9dbc7bfe 1219
40fe5e7b 1220 seed = td->o.rand_seed;
04778baf 1221 for (i = 0; i < 4; i++)
9dbc7bfe
JA
1222 seed *= 0x9e370001UL;
1223
1224 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
87a0ea3b 1225 td->rand_seeds[i] = seed * td->thread_number + i;
9dbc7bfe
JA
1226 seed *= 0x9e370001UL;
1227 }
1228
1229 td_fill_rand_seeds(td);
1230 return 0;
1231}
1232
de98bd30
JA
1233enum {
1234 FPRE_NONE = 0,
1235 FPRE_JOBNAME,
1236 FPRE_JOBNUM,
1237 FPRE_FILENUM
1238};
1239
1240static struct fpre_keyword {
1241 const char *keyword;
1242 size_t strlen;
1243 int key;
1244} fpre_keywords[] = {
1245 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1246 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1247 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1248 { .keyword = NULL, },
1249 };
1250
3660ceae 1251static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
de98bd30
JA
1252 const char *jobname, int jobnum, int filenum)
1253{
1254 struct fpre_keyword *f;
1255 char copy[PATH_MAX];
b400a20e 1256 size_t dst_left = PATH_MAX - 1;
de98bd30
JA
1257
1258 if (!o->filename_format || !strlen(o->filename_format)) {
1259 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
e5a43605 1260 return buf;
de98bd30
JA
1261 }
1262
1263 for (f = &fpre_keywords[0]; f->keyword; f++)
1264 f->strlen = strlen(f->keyword);
1265
36833fb0 1266 snprintf(buf, buf_size, "%s", o->filename_format);
3660ceae 1267
de98bd30
JA
1268 memset(copy, 0, sizeof(copy));
1269 for (f = &fpre_keywords[0]; f->keyword; f++) {
1270 do {
1271 size_t pre_len, post_start = 0;
1272 char *str, *dst = copy;
1273
e25b6d5a 1274 str = strcasestr(buf, f->keyword);
de98bd30
JA
1275 if (!str)
1276 break;
1277
1278 pre_len = str - buf;
1279 if (strlen(str) != f->strlen)
1280 post_start = pre_len + f->strlen;
1281
1282 if (pre_len) {
1283 strncpy(dst, buf, pre_len);
1284 dst += pre_len;
73a467e6 1285 dst_left -= pre_len;
de98bd30
JA
1286 }
1287
1288 switch (f->key) {
73a467e6
JA
1289 case FPRE_JOBNAME: {
1290 int ret;
1291
1292 ret = snprintf(dst, dst_left, "%s", jobname);
1293 if (ret < 0)
1294 break;
17a2be59
JA
1295 else if (ret > dst_left) {
1296 log_err("fio: truncated filename\n");
1297 dst += dst_left;
1298 dst_left = 0;
1299 } else {
1300 dst += ret;
1301 dst_left -= ret;
1302 }
de98bd30 1303 break;
73a467e6
JA
1304 }
1305 case FPRE_JOBNUM: {
1306 int ret;
1307
1308 ret = snprintf(dst, dst_left, "%d", jobnum);
1309 if (ret < 0)
1310 break;
17a2be59
JA
1311 else if (ret > dst_left) {
1312 log_err("fio: truncated filename\n");
1313 dst += dst_left;
1314 dst_left = 0;
1315 } else {
1316 dst += ret;
1317 dst_left -= ret;
1318 }
de98bd30 1319 break;
73a467e6
JA
1320 }
1321 case FPRE_FILENUM: {
1322 int ret;
1323
1324 ret = snprintf(dst, dst_left, "%d", filenum);
1325 if (ret < 0)
1326 break;
17a2be59
JA
1327 else if (ret > dst_left) {
1328 log_err("fio: truncated filename\n");
1329 dst += dst_left;
1330 dst_left = 0;
1331 } else {
1332 dst += ret;
1333 dst_left -= ret;
1334 }
de98bd30 1335 break;
73a467e6 1336 }
de98bd30
JA
1337 default:
1338 assert(0);
1339 break;
1340 }
1341
1342 if (post_start)
73a467e6 1343 strncpy(dst, buf + post_start, dst_left);
de98bd30 1344
36833fb0 1345 snprintf(buf, buf_size, "%s", copy);
de98bd30
JA
1346 } while (1);
1347 }
1348
1349 return buf;
1350}
f9633d72 1351
8aa89d70 1352bool parse_dryrun(void)
f9633d72
JA
1353{
1354 return dump_cmdline || parse_only;
1355}
1356
3a5db920
JA
1357static void gen_log_name(char *name, size_t size, const char *logtype,
1358 const char *logname, unsigned int num,
1359 const char *suf, int per_job)
1360{
1361 if (per_job)
1362 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1363 else
1364 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1365}
1366
9cc8cb91
AK
1367static int check_waitees(char *waitee)
1368{
1369 struct thread_data *td;
1370 int i, ret = 0;
1371
1372 for_each_td(td, i) {
1373 if (td->subjob_number)
1374 continue;
1375
1376 ret += !strcmp(td->o.name, waitee);
1377 }
1378
1379 return ret;
1380}
1381
1382static bool wait_for_ok(const char *jobname, struct thread_options *o)
1383{
1384 int nw;
1385
1386 if (!o->wait_for)
1387 return true;
1388
1389 if (!strcmp(jobname, o->wait_for)) {
1390 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1391 jobname, o->wait_for);
1392 return false;
1393 }
1394
1395 if (!(nw = check_waitees(o->wait_for))) {
1396 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1397 return false;
1398 }
1399
1400 if (nw > 1) {
1401 log_err("%s: multiple waitees %s found,\n"
1402 "please avoid duplicates when using wait_for option.\n",
1403 jobname, o->wait_for);
1404 return false;
1405 }
1406
1407 return true;
1408}
1409
789b8673
JA
1410/*
1411 * Treat an empty log file name the same as a one not given
1412 */
1413static const char *make_log_name(const char *logname, const char *jobname)
1414{
1415 if (logname && strcmp(logname, ""))
1416 return logname;
1417
1418 return jobname;
1419}
1420
906c8d75
JA
1421/*
1422 * Adds a job to the list of things todo. Sanitizes the various options
1423 * to make sure we don't have conflicts, and initializes various
1424 * members of td.
1425 */
b7cfb2e1 1426static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
46bcd498 1427 int recursed, int client_type)
ebac4655 1428{
af52b345 1429 unsigned int i;
32e31c8c 1430 char fname[PATH_MAX + 1];
e132cbae 1431 int numjobs, file_alloced;
de98bd30 1432 struct thread_options *o = &td->o;
cb7e0ace 1433 char logname[PATH_MAX + 32];
ebac4655 1434
ebac4655
JA
1435 /*
1436 * the def_thread is just for options, it's not a real job
1437 */
1438 if (td == &def_thread)
1439 return 0;
1440
d72be545
JA
1441 init_flags(td);
1442
cca73aa7
JA
1443 /*
1444 * if we are just dumping the output command line, don't add the job
1445 */
f9633d72 1446 if (parse_dryrun()) {
cca73aa7
JA
1447 put_job(td);
1448 return 0;
1449 }
1450
46bcd498
JA
1451 td->client_type = client_type;
1452
58c55ba0 1453 if (profile_td_init(td))
66251554 1454 goto err;
58c55ba0 1455
de890a1e 1456 if (ioengine_load(td))
205927a3 1457 goto err;
df64119d 1458
e132cbae 1459 file_alloced = 0;
de98bd30 1460 if (!o->filename && !td->files_index && !o->read_iolog_file) {
e132cbae 1461 file_alloced = 1;
80be24f4 1462
5e62565b 1463 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
5903e7b7 1464 add_file(td, jobname, job_add_num, 0);
7b05a215 1465 else {
de98bd30 1466 for (i = 0; i < o->nr_files; i++)
3660ceae 1467 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
af52b345 1468 }
0af7b542 1469 }
ebac4655 1470
49050b56
JA
1471 if (setup_random_seeds(td)) {
1472 td_verror(td, errno, "setup_random_seeds");
1473 goto err;
1474 }
1475
4e991c23
JA
1476 if (fixup_options(td))
1477 goto err;
e0a22335 1478
9cc8cb91
AK
1479 /*
1480 * Belongs to fixup_options, but o->name is not necessarily set as yet
1481 */
1482 if (!wait_for_ok(jobname, o))
1483 goto err;
1484
9e684a49
DE
1485 flow_init_job(td);
1486
de890a1e
SL
1487 /*
1488 * IO engines only need this for option callbacks, and the address may
1489 * change in subprocesses.
1490 */
1491 if (td->eo)
1492 *(struct thread_data **)td->eo = NULL;
1493
9b87f09b 1494 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
07eb79df
JA
1495 struct fio_file *f;
1496
1497 for_each_file(td, f, i)
1498 f->real_file_size = -1ULL;
1499 }
1500
971caeb1 1501 td->sem = fio_sem_init(FIO_SEM_LOCKED);
ebac4655 1502
de98bd30 1503 td->ts.clat_percentiles = o->clat_percentiles;
b599759b 1504 td->ts.lat_percentiles = o->lat_percentiles;
56440e63 1505 td->ts.slat_percentiles = o->slat_percentiles;
de98bd30
JA
1506 td->ts.percentile_precision = o->percentile_precision;
1507 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
18aa1998 1508 td->ts.sig_figs = o->sig_figs;
83349190 1509
6eaf09d6
SL
1510 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1511 td->ts.clat_stat[i].min_val = ULONG_MAX;
1512 td->ts.slat_stat[i].min_val = ULONG_MAX;
1513 td->ts.lat_stat[i].min_val = ULONG_MAX;
1514 td->ts.bw_stat[i].min_val = ULONG_MAX;
188b6016 1515 td->ts.iops_stat[i].min_val = ULONG_MAX;
b2a432bf 1516 td->ts.clat_high_prio_stat[i].min_val = ULONG_MAX;
efd78265 1517 td->ts.clat_low_prio_stat[i].min_val = ULONG_MAX;
6eaf09d6 1518 }
7f3ecee2 1519 td->ts.sync_stat.min_val = ULONG_MAX;
de98bd30 1520 td->ddir_seq_nr = o->ddir_seq_nr;
ebac4655 1521
de98bd30 1522 if ((o->stonewall || o->new_group) && prev_group_jobs) {
3c5df6fa 1523 prev_group_jobs = 0;
ebac4655 1524 groupid++;
d883efbd
JA
1525 if (groupid == INT_MAX) {
1526 log_err("fio: too many groups defined\n");
1527 goto err;
1528 }
3c5df6fa 1529 }
ebac4655
JA
1530
1531 td->groupid = groupid;
3c5df6fa 1532 prev_group_jobs++;
ebac4655
JA
1533
1534 if (setup_rate(td))
1535 goto err;
1536
dded427c 1537 if (o->write_lat_log) {
aee2ab67
JA
1538 struct log_params p = {
1539 .td = td,
1540 .avg_msec = o->log_avg_msec,
1e613c9c
KC
1541 .hist_msec = o->log_hist_msec,
1542 .hist_coarseness = o->log_hist_coarseness,
aee2ab67
JA
1543 .log_type = IO_LOG_TYPE_LAT,
1544 .log_offset = o->log_offset,
1545 .log_gz = o->log_gz,
b26317c9 1546 .log_gz_store = o->log_gz_store,
aee2ab67 1547 };
789b8673 1548 const char *pre = make_log_name(o->lat_log_file, o->name);
b26317c9 1549 const char *suf;
aee2ab67 1550
b26317c9
JA
1551 if (p.log_gz_store)
1552 suf = "log.fz";
1553 else
1554 suf = "log";
1555
dded427c 1556 gen_log_name(logname, sizeof(logname), "lat", pre,
3a5db920 1557 td->thread_number, suf, o->per_job_logs);
aee2ab67 1558 setup_log(&td->lat_log, &p, logname);
3a5db920 1559
dded427c 1560 gen_log_name(logname, sizeof(logname), "slat", pre,
3a5db920 1561 td->thread_number, suf, o->per_job_logs);
aee2ab67 1562 setup_log(&td->slat_log, &p, logname);
3a5db920 1563
dded427c 1564 gen_log_name(logname, sizeof(logname), "clat", pre,
3a5db920 1565 td->thread_number, suf, o->per_job_logs);
aee2ab67 1566 setup_log(&td->clat_log, &p, logname);
a7935806 1567
ebac4655 1568 }
1e613c9c 1569
dded427c 1570 if (o->write_hist_log) {
1e613c9c
KC
1571 struct log_params p = {
1572 .td = td,
1573 .avg_msec = o->log_avg_msec,
1574 .hist_msec = o->log_hist_msec,
1575 .hist_coarseness = o->log_hist_coarseness,
1576 .log_type = IO_LOG_TYPE_HIST,
1577 .log_offset = o->log_offset,
1578 .log_gz = o->log_gz,
1579 .log_gz_store = o->log_gz_store,
1580 };
789b8673 1581 const char *pre = make_log_name(o->hist_log_file, o->name);
1e613c9c
KC
1582 const char *suf;
1583
66da8a60
JA
1584#ifndef CONFIG_ZLIB
1585 if (td->client_type) {
1586 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1587 goto err;
1588 }
1589#endif
1590
1e613c9c
KC
1591 if (p.log_gz_store)
1592 suf = "log.fz";
1593 else
1594 suf = "log";
1595
dded427c 1596 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1e613c9c
KC
1597 td->thread_number, suf, o->per_job_logs);
1598 setup_log(&td->clat_hist_log, &p, logname);
1599 }
1600
dded427c 1601 if (o->write_bw_log) {
aee2ab67
JA
1602 struct log_params p = {
1603 .td = td,
1604 .avg_msec = o->log_avg_msec,
1e613c9c
KC
1605 .hist_msec = o->log_hist_msec,
1606 .hist_coarseness = o->log_hist_coarseness,
aee2ab67
JA
1607 .log_type = IO_LOG_TYPE_BW,
1608 .log_offset = o->log_offset,
1609 .log_gz = o->log_gz,
b26317c9 1610 .log_gz_store = o->log_gz_store,
aee2ab67 1611 };
789b8673 1612 const char *pre = make_log_name(o->bw_log_file, o->name);
b26317c9
JA
1613 const char *suf;
1614
a47591e4
JA
1615 if (fio_option_is_set(o, bw_avg_time))
1616 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1617 else
1618 o->bw_avg_time = p.avg_msec;
c82acb8d 1619
1e613c9c
KC
1620 p.hist_msec = o->log_hist_msec;
1621 p.hist_coarseness = o->log_hist_coarseness;
a47591e4 1622
b26317c9
JA
1623 if (p.log_gz_store)
1624 suf = "log.fz";
1625 else
1626 suf = "log";
aee2ab67 1627
dded427c 1628 gen_log_name(logname, sizeof(logname), "bw", pre,
3a5db920 1629 td->thread_number, suf, o->per_job_logs);
aee2ab67 1630 setup_log(&td->bw_log, &p, logname);
cb7e0ace 1631 }
dded427c 1632 if (o->write_iops_log) {
aee2ab67
JA
1633 struct log_params p = {
1634 .td = td,
1635 .avg_msec = o->log_avg_msec,
1e613c9c
KC
1636 .hist_msec = o->log_hist_msec,
1637 .hist_coarseness = o->log_hist_coarseness,
aee2ab67
JA
1638 .log_type = IO_LOG_TYPE_IOPS,
1639 .log_offset = o->log_offset,
1640 .log_gz = o->log_gz,
b26317c9 1641 .log_gz_store = o->log_gz_store,
aee2ab67 1642 };
789b8673 1643 const char *pre = make_log_name(o->iops_log_file, o->name);
b26317c9
JA
1644 const char *suf;
1645
a47591e4
JA
1646 if (fio_option_is_set(o, iops_avg_time))
1647 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1648 else
1649 o->iops_avg_time = p.avg_msec;
c82acb8d 1650
1e613c9c
KC
1651 p.hist_msec = o->log_hist_msec;
1652 p.hist_coarseness = o->log_hist_coarseness;
a47591e4 1653
b26317c9
JA
1654 if (p.log_gz_store)
1655 suf = "log.fz";
1656 else
1657 suf = "log";
aee2ab67 1658
dded427c 1659 gen_log_name(logname, sizeof(logname), "iops", pre,
3a5db920 1660 td->thread_number, suf, o->per_job_logs);
aee2ab67 1661 setup_log(&td->iops_log, &p, logname);
cb7e0ace 1662 }
ebac4655 1663
de98bd30
JA
1664 if (!o->name)
1665 o->name = strdup(jobname);
01452055 1666
129fb2d4 1667 if (output_format & FIO_OUTPUT_NORMAL) {
b990b5c0 1668 if (!job_add_num) {
b7cfb2e1 1669 if (is_backend && !recursed)
2f122b13 1670 fio_server_send_add_job(td);
807f9971 1671
9b87f09b 1672 if (!td_ioengine_flagged(td, FIO_NOIO)) {
d21e2535
JA
1673 char *c1, *c2, *c3, *c4;
1674 char *c5 = NULL, *c6 = NULL;
d694a6a7 1675 int i2p = is_power_of_2(o->kb_base);
a41fc529 1676 struct buf_output out;
f8977ee6 1677
e883cb35
JF
1678 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1679 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1680 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1681 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
d21e2535
JA
1682
1683 if (!o->bs_is_seq_rand) {
e883cb35
JF
1684 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1685 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
d21e2535
JA
1686 }
1687
a41fc529 1688 buf_output_init(&out);
71ccdf58 1689 __log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
d21e2535
JA
1690 td->groupid,
1691 ddir_str(o->td_ddir));
1692
1693 if (o->bs_is_seq_rand)
71ccdf58 1694 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
d21e2535
JA
1695 c1, c2, c3, c4);
1696 else
71ccdf58 1697 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
d21e2535
JA
1698 c1, c2, c3, c4, c5, c6);
1699
71ccdf58 1700 __log_buf(&out, "ioengine=%s, iodepth=%u\n",
de98bd30 1701 td->io_ops->name, o->iodepth);
a41fc529 1702 log_info_buf(out.buf, out.buflen);
d5bb0a89 1703 buf_output_free(&out);
f8977ee6
JA
1704
1705 free(c1);
1706 free(c2);
1707 free(c3);
1708 free(c4);
6eaf09d6
SL
1709 free(c5);
1710 free(c6);
f8977ee6 1711 }
b990b5c0 1712 } else if (job_add_num == 1)
6d86144d 1713 log_info("...\n");
c6ae0a5b 1714 }
ebac4655 1715
56a90eba
VF
1716 if (td_steadystate_init(td))
1717 goto err;
16e56d25 1718
b9921d1a
DZ
1719 if (o->merge_blktrace_file && !merge_blktrace_iologs(td))
1720 goto err;
1721
1722 if (merge_blktrace_only) {
1723 put_job(td);
1724 return 0;
1725 }
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
07a2919d 1882 string = malloc(OPT_LEN_MAX);
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
07a2919d 1915 p = fgets(string, OPT_LEN_MAX, 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
07a2919d 1984 p = fgets(string, OPT_LEN_MAX, f);
b3270921
AK
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, '/'))) {
36833fb0
BVA
2024 if (asprintf(&full_fn, "%.*s%s",
2025 (int)(ts - file + 1), file,
2026 filename) < 0) {
c0821a08
AK
2027 ret = ENOMEM;
2028 break;
2029 }
c0821a08
AK
2030 filename = full_fn;
2031 }
2032
2033 ret = __parse_jobs_ini(td, filename, is_buf,
2034 stonewall_flag, type, 1,
2035 name, &opts,
2036 &alloc_opts, &num_opts);
b3270921 2037
c0821a08
AK
2038 if (ret) {
2039 log_err("Error %d while parsing "
2040 "include file %s\n",
b3270921 2041 ret, filename);
b3270921 2042 }
c0821a08
AK
2043
2044 if (full_fn)
2045 free(full_fn);
2046
2047 if (ret)
2048 break;
2049
b3270921
AK
2050 continue;
2051 }
2052
3b8b7135
JA
2053 if (num_opts == alloc_opts) {
2054 alloc_opts <<= 1;
2055 opts = realloc(opts,
2056 alloc_opts * sizeof(char *));
2057 }
2058
2059 opts[num_opts] = strdup(p);
2060 num_opts++;
ebac4655 2061 }
ebac4655 2062
b3270921
AK
2063 if (nested) {
2064 *popts = opts;
2065 *aopts = alloc_opts;
2066 *nopts = num_opts;
2067 goto out;
2068 }
2069
c2292325
JA
2070 ret = fio_options_parse(td, opts, num_opts);
2071 if (!ret) {
2072 if (dump_cmdline)
2073 dump_opt_list(td);
2074
46bcd498 2075 ret = add_job(td, name, 0, 0, type);
c2292325 2076 } else {
b1508cf9
JA
2077 log_err("fio: job %s dropped\n", name);
2078 put_job(td);
45410acb 2079 }
3b8b7135
JA
2080
2081 for (i = 0; i < num_opts; i++)
2082 free(opts[i]);
2083 num_opts = 0;
7c124ac1 2084 } while (!ret);
ebac4655 2085
cca73aa7
JA
2086 if (dump_cmdline)
2087 log_info("\n");
2088
7e356b2d
JA
2089 i = 0;
2090 while (i < nr_job_sections) {
2091 free(job_sections[i]);
2092 i++;
2093 }
2094
2577594d 2095 free(opts);
b3270921
AK
2096out:
2097 free(string);
2098 if (!nested)
2099 free(name);
50d16976 2100 if (!is_buf && f != stdin)
5a729cbe 2101 fclose(f);
45410acb 2102 return ret;
ebac4655
JA
2103}
2104
b3270921
AK
2105int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2106{
2107 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2108 0, NULL, NULL, NULL, NULL);
2109}
2110
ebac4655
JA
2111static int fill_def_thread(void)
2112{
2113 memset(&def_thread, 0, sizeof(def_thread));
66e19a38 2114 INIT_FLIST_HEAD(&def_thread.opt_list);
ebac4655 2115
375b2695 2116 fio_getaffinity(getpid(), &def_thread.o.cpumask);
8b28bd41 2117 def_thread.o.error_dump = 1;
25bd16ce 2118
ebac4655 2119 /*
ee738499 2120 * fill default options
ebac4655 2121 */
214e1eca 2122 fio_fill_default_options(&def_thread);
ebac4655
JA
2123 return 0;
2124}
2125
2236df3d
JA
2126static void show_debug_categories(void)
2127{
44acdcf4 2128#ifdef FIO_INC_DEBUG
447931d9 2129 const struct debug_level *dl = &debug_levels[0];
2236df3d
JA
2130 int curlen, first = 1;
2131
2132 curlen = 0;
2133 while (dl->name) {
2134 int has_next = (dl + 1)->name != NULL;
2135
2136 if (first || curlen + strlen(dl->name) >= 80) {
2137 if (!first) {
2138 printf("\n");
2139 curlen = 0;
2140 }
2141 curlen += printf("\t\t\t%s", dl->name);
2142 curlen += 3 * (8 - 1);
2143 if (has_next)
2144 curlen += printf(",");
2145 } else {
2146 curlen += printf("%s", dl->name);
2147 if (has_next)
2148 curlen += printf(",");
2149 }
2150 dl++;
2151 first = 0;
2152 }
2153 printf("\n");
44acdcf4 2154#endif
2236df3d
JA
2155}
2156
baa9fe6b
TK
2157/*
2158 * Following options aren't printed by usage().
2159 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2160 * --latency-log - Deprecated option.
2161 */
45378b35 2162static void usage(const char *name)
4785f995 2163{
3d43382c 2164 printf("%s\n", fio_version_string);
45378b35 2165 printf("%s [options] [job options] <job file(s)>\n", name);
2236df3d
JA
2166 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2167 show_debug_categories();
111e032d 2168 printf(" --parse-only\t\tParse options only, don't start any IO\n");
b9921d1a 2169 printf(" --merge-blktrace-only\tMerge blktraces only, don't start any IO\n");
83881283 2170 printf(" --output\t\tWrite output to file\n");
d23ae827 2171 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
83881283 2172 printf(" --minimal\t\tMinimal (terse) output\n");
95a12fbe
TK
2173 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2174 printf(" --terse-version=type\tSet terse version output format"
2175 " (default 3, or 2 or 4)\n");
f3afa57e 2176 printf(" --version\t\tPrint version info and exit\n");
83881283 2177 printf(" --help\t\tPrint this page\n");
23893646 2178 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1a1822bf 2179 printf(" --crctest=[type]\tTest speed of checksum functions\n");
83881283 2180 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
5ec10eaa 2181 " them\n");
de890a1e
SL
2182 printf(" --enghelp=engine\tPrint ioengine help, or list"
2183 " available ioengines\n");
2184 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2185 " cmd\n");
83881283
JA
2186 printf(" --showcmd\t\tTurn a job file into command line options\n");
2187 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2188 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
9a496382 2189 printf(" --eta-newline=t\tForce a new line for every 't'");
e382e661 2190 printf(" period passed\n");
06464907
JA
2191 printf(" --status-interval=t\tForce full status dump every");
2192 printf(" 't' period passed\n");
83881283 2193 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
5ec10eaa 2194 " writes\n");
95a12fbe
TK
2195 printf(" --section=name\tOnly run specified section in job file,"
2196 " multiple sections can be specified\n");
83881283 2197 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
95a12fbe 2198 " (def 16384)\n");
83881283
JA
2199 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2200 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2201 printf(" --server=args\t\tStart a backend fio server\n");
2202 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
95a12fbe 2203 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
323255cc 2204 printf(" --remote-config=file\tTell fio server to load this local job file\n");
f2a2ce0e
HL
2205 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2206 "\t\t\t(option=system,percpu) or run unit work\n"
2207 "\t\t\tcalibration only (option=calibrate)\n");
b26317c9
JA
2208#ifdef CONFIG_ZLIB
2209 printf(" --inflate-log=log\tInflate and output compressed log\n");
2210#endif
b63efd30 2211 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2ae7a90d 2212 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
b63efd30
JA
2213 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2214 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
d264264a 2215 printf(" --aux-path=path\tUse this path for fio state generated files\n");
d292596c 2216 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
4785f995
JA
2217}
2218
79e48f72 2219#ifdef FIO_INC_DEBUG
447931d9 2220const struct debug_level debug_levels[] = {
0b8d11ed
JA
2221 { .name = "process",
2222 .help = "Process creation/exit logging",
2223 .shift = FD_PROCESS,
2224 },
2225 { .name = "file",
2226 .help = "File related action logging",
2227 .shift = FD_FILE,
2228 },
2229 { .name = "io",
2230 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2231 .shift = FD_IO,
2232 },
2233 { .name = "mem",
2234 .help = "Memory allocation/freeing logging",
2235 .shift = FD_MEM,
2236 },
2237 { .name = "blktrace",
2238 .help = "blktrace action logging",
2239 .shift = FD_BLKTRACE,
2240 },
2241 { .name = "verify",
2242 .help = "IO verification action logging",
2243 .shift = FD_VERIFY,
2244 },
2245 { .name = "random",
2246 .help = "Random generation logging",
2247 .shift = FD_RANDOM,
2248 },
2249 { .name = "parse",
2250 .help = "Parser logging",
2251 .shift = FD_PARSE,
2252 },
2253 { .name = "diskutil",
2254 .help = "Disk utility logging actions",
2255 .shift = FD_DISKUTIL,
2256 },
2257 { .name = "job",
2258 .help = "Logging related to creating/destroying jobs",
2259 .shift = FD_JOB,
2260 },
2261 { .name = "mutex",
2262 .help = "Mutex logging",
2263 .shift = FD_MUTEX
2264 },
2265 { .name = "profile",
2266 .help = "Logging related to profiles",
2267 .shift = FD_PROFILE,
2268 },
2269 { .name = "time",
2270 .help = "Logging related to time keeping functions",
2271 .shift = FD_TIME,
2272 },
2273 { .name = "net",
2274 .help = "Network logging",
2275 .shift = FD_NET,
2276 },
3e260a46
JA
2277 { .name = "rate",
2278 .help = "Rate logging",
2279 .shift = FD_RATE,
2280 },
0c56718d
JA
2281 { .name = "compress",
2282 .help = "Log compression logging",
2283 .shift = FD_COMPRESS,
2284 },
16e56d25
VF
2285 { .name = "steadystate",
2286 .help = "Steady state detection logging",
2287 .shift = FD_STEADYSTATE,
2288 },
e569ca6b
VF
2289 { .name = "helperthread",
2290 .help = "Helper thread logging",
2291 .shift = FD_HELPERTHREAD,
2292 },
4806b824
BVA
2293 { .name = "zbd",
2294 .help = "Zoned Block Device logging",
2295 .shift = FD_ZBD,
2296 },
02444ad1 2297 { .name = NULL, },
ee56ad50
JA
2298};
2299
c09823ab 2300static int set_debug(const char *string)
ee56ad50 2301{
447931d9 2302 const struct debug_level *dl;
ee56ad50
JA
2303 char *p = (char *) string;
2304 char *opt;
2305 int i;
2306
2706fa00
JA
2307 if (!string)
2308 return 0;
2309
ee56ad50 2310 if (!strcmp(string, "?") || !strcmp(string, "help")) {
ee56ad50
JA
2311 log_info("fio: dumping debug options:");
2312 for (i = 0; debug_levels[i].name; i++) {
2313 dl = &debug_levels[i];
2314 log_info("%s,", dl->name);
2315 }
bd6f78b2 2316 log_info("all\n");
c09823ab 2317 return 1;
ee56ad50
JA
2318 }
2319
2320 while ((opt = strsep(&p, ",")) != NULL) {
2321 int found = 0;
2322
5e1d306e
JA
2323 if (!strncmp(opt, "all", 3)) {
2324 log_info("fio: set all debug options\n");
2325 fio_debug = ~0UL;
2326 continue;
2327 }
2328
ee56ad50
JA
2329 for (i = 0; debug_levels[i].name; i++) {
2330 dl = &debug_levels[i];
5e1d306e
JA
2331 found = !strncmp(opt, dl->name, strlen(dl->name));
2332 if (!found)
2333 continue;
2334
2335 if (dl->shift == FD_JOB) {
2336 opt = strchr(opt, ':');
2337 if (!opt) {
2338 log_err("fio: missing job number\n");
2339 break;
2340 }
2341 opt++;
2342 fio_debug_jobno = atoi(opt);
2343 log_info("fio: set debug jobno %d\n",
2344 fio_debug_jobno);
2345 } else {
ee56ad50 2346 log_info("fio: set debug option %s\n", opt);
bd6f78b2 2347 fio_debug |= (1UL << dl->shift);
ee56ad50 2348 }
5e1d306e 2349 break;
ee56ad50
JA
2350 }
2351
2352 if (!found)
2353 log_err("fio: debug mask %s not found\n", opt);
2354 }
c09823ab 2355 return 0;
ee56ad50 2356}
79e48f72 2357#else
69b98d4c 2358static int set_debug(const char *string)
79e48f72
JA
2359{
2360 log_err("fio: debug tracing not included in build\n");
c09823ab 2361 return 1;
79e48f72
JA
2362}
2363#endif
9ac8a797 2364
4c6107ff
JA
2365static void fio_options_fill_optstring(void)
2366{
2367 char *ostr = cmd_optstr;
2368 int i, c;
2369
2370 c = i = 0;
2371 while (l_opts[i].name) {
2372 ostr[c++] = l_opts[i].val;
2373 if (l_opts[i].has_arg == required_argument)
2374 ostr[c++] = ':';
2375 else if (l_opts[i].has_arg == optional_argument) {
2376 ostr[c++] = ':';
2377 ostr[c++] = ':';
2378 }
2379 i++;
2380 }
2381 ostr[c] = '\0';
2382}
2383
c2c94585
JA
2384static int client_flag_set(char c)
2385{
2386 int i;
2387
2388 i = 0;
2389 while (l_opts[i].name) {
2390 int val = l_opts[i].val;
2391
2392 if (c == (val & 0xff))
2393 return (val & FIO_CLIENT_FLAG);
2394
2395 i++;
2396 }
2397
2398 return 0;
2399}
2400
10aa136b 2401static void parse_cmd_client(void *client, char *opt)
7a4b8240 2402{
fa2ea806 2403 fio_client_add_cmd_option(client, opt);
7a4b8240
JA
2404}
2405
a893c261
JA
2406static void show_closest_option(const char *name)
2407{
2408 int best_option, best_distance;
2409 int i, distance;
2410
2411 while (*name == '-')
2412 name++;
2413
2414 best_option = -1;
2415 best_distance = INT_MAX;
2416 i = 0;
2417 while (l_opts[i].name) {
2418 distance = string_distance(name, l_opts[i].name);
2419 if (distance < best_distance) {
2420 best_distance = distance;
2421 best_option = i;
2422 }
2423 i++;
2424 }
2425
3701636d 2426 if (best_option != -1 && string_distance_ok(name, best_distance))
a893c261
JA
2427 log_err("Did you mean %s?\n", l_opts[best_option].name);
2428}
2429
a666cab8
JA
2430static int parse_output_format(const char *optarg)
2431{
2432 char *p, *orig, *opt;
2433 int ret = 0;
2434
2435 p = orig = strdup(optarg);
2436
2437 output_format = 0;
2438
2439 while ((opt = strsep(&p, ",")) != NULL) {
2440 if (!strcmp(opt, "minimal") ||
2441 !strcmp(opt, "terse") ||
2442 !strcmp(opt, "csv"))
2443 output_format |= FIO_OUTPUT_TERSE;
2444 else if (!strcmp(opt, "json"))
2445 output_format |= FIO_OUTPUT_JSON;
513e37ee
VF
2446 else if (!strcmp(opt, "json+"))
2447 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
a666cab8
JA
2448 else if (!strcmp(opt, "normal"))
2449 output_format |= FIO_OUTPUT_NORMAL;
2450 else {
2451 log_err("fio: invalid output format %s\n", opt);
2452 ret = 1;
2453 break;
2454 }
2455 }
2456
2457 free(orig);
2458 return ret;
2459}
2460
46bcd498 2461int parse_cmd_line(int argc, char *argv[], int client_type)
ebac4655 2462{
b4692828 2463 struct thread_data *td = NULL;
c09823ab 2464 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
4c6107ff 2465 char *ostr = cmd_optstr;
977b9596 2466 char *pid_file = NULL;
9bae26e8 2467 void *cur_client = NULL;
f1867a7f 2468 bool backend = false;
ebac4655 2469
c2c94585
JA
2470 /*
2471 * Reset optind handling, since we may call this multiple times
2472 * for the backend.
2473 */
2474 optind = 1;
7a4b8240 2475
c2c94585
JA
2476 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2477 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
fa2ea806 2478 parse_cmd_client(cur_client, argv[optind - 1]);
7a4b8240
JA
2479 c &= ~FIO_CLIENT_FLAG;
2480 }
2481
ebac4655 2482 switch (c) {
2b386d25
JA
2483 case 'a':
2484 smalloc_pool_size = atoi(optarg);
52d892b2 2485 smalloc_pool_size <<= 10;
5f9454a2 2486 sinit();
2b386d25 2487 break;
b4692828 2488 case 'l':
cb7e0ace
JA
2489 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2490 do_exit++;
2491 exit_val = 1;
b4692828 2492 break;
3d73e5a9 2493 case 'b':
f1867a7f 2494 write_bw_log = true;
b4692828 2495 break;
34b1b5c6
JA
2496 case 'o': {
2497 FILE *tmp;
2498
988da120 2499 if (f_out && f_out != stdout)
5e1d8745
JA
2500 fclose(f_out);
2501
34b1b5c6
JA
2502 tmp = fopen(optarg, "w+");
2503 if (!tmp) {
2504 log_err("fio: output file open error: %s\n", strerror(errno));
2505 exit_val = 1;
2506 do_exit++;
2507 break;
b4692828 2508 }
34b1b5c6 2509 f_err = f_out = tmp;
b4692828 2510 break;
34b1b5c6 2511 }
b4692828 2512 case 'm':
f3afa57e 2513 output_format = FIO_OUTPUT_TERSE;
b4692828 2514 break;
f3afa57e 2515 case 'F':
a666cab8
JA
2516 if (parse_output_format(optarg)) {
2517 log_err("fio: failed parsing output-format\n");
2518 exit_val = 1;
2519 do_exit++;
2520 break;
2521 }
2b8c71b0 2522 break;
f6a7df53
JA
2523 case 'f':
2524 output_format |= FIO_OUTPUT_TERSE;
2525 break;
b4692828 2526 case 'h':
1201b24a 2527 did_arg = true;
7874f8b7 2528 if (!cur_client) {
c2c94585 2529 usage(argv[0]);
7874f8b7
JA
2530 do_exit++;
2531 }
c2c94585 2532 break;
fd28ca49 2533 case 'c':
1201b24a 2534 did_arg = true;
7874f8b7 2535 if (!cur_client) {
c2c94585 2536 fio_show_option_help(optarg);
7874f8b7
JA
2537 do_exit++;
2538 }
c2c94585 2539 break;
de890a1e 2540 case 'i':
1201b24a 2541 did_arg = true;
de890a1e
SL
2542 if (!cur_client) {
2543 fio_show_ioengine_help(optarg);
2544 do_exit++;
2545 }
2546 break;
cca73aa7 2547 case 's':
1201b24a 2548 did_arg = true;
f1867a7f 2549 dump_cmdline = true;
cca73aa7 2550 break;
724e4435
JA
2551 case 'r':
2552 read_only = 1;
2553 break;
b4692828 2554 case 'v':
1201b24a 2555 did_arg = true;
7874f8b7 2556 if (!cur_client) {
3d43382c 2557 log_info("%s\n", fio_version_string);
7874f8b7
JA
2558 do_exit++;
2559 }
c2c94585 2560 break;
f57a9c59
JA
2561 case 'V':
2562 terse_version = atoi(optarg);
a2c95580 2563 if (!(terse_version >= 2 && terse_version <= 5)) {
f57a9c59
JA
2564 log_err("fio: bad terse version format\n");
2565 exit_val = 1;
2566 do_exit++;
2567 }
2568 break;
e592a06b
AC
2569 case 'e':
2570 if (!strcmp("always", optarg))
2571 eta_print = FIO_ETA_ALWAYS;
2572 else if (!strcmp("never", optarg))
2573 eta_print = FIO_ETA_NEVER;
2574 break;
e382e661
JA
2575 case 'E': {
2576 long long t = 0;
2577
88038bc7 2578 if (check_str_time(optarg, &t, 1)) {
e382e661
JA
2579 log_err("fio: failed parsing eta time %s\n", optarg);
2580 exit_val = 1;
2581 do_exit++;
db37d890 2582 break;
e382e661 2583 }
88038bc7 2584 eta_new_line = t / 1000;
db37d890
JA
2585 if (!eta_new_line) {
2586 log_err("fio: eta new line time too short\n");
2587 exit_val = 1;
2588 do_exit++;
2589 }
2590 break;
2591 }
2592 case 'O': {
2593 long long t = 0;
2594
2595 if (check_str_time(optarg, &t, 1)) {
2596 log_err("fio: failed parsing eta interval %s\n", optarg);
2597 exit_val = 1;
2598 do_exit++;
2599 break;
2600 }
2601 eta_interval_msec = t / 1000;
2602 if (eta_interval_msec < DISK_UTIL_MSEC) {
2603 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2604 exit_val = 1;
2605 do_exit++;
2606 }
e382e661
JA
2607 break;
2608 }
ee56ad50 2609 case 'd':
c09823ab
JA
2610 if (set_debug(optarg))
2611 do_exit++;
ee56ad50 2612 break;
111e032d 2613 case 'P':
1201b24a 2614 did_arg = true;
f1867a7f 2615 parse_only = true;
111e032d 2616 break;
ad0a2735
JA
2617 case 'x': {
2618 size_t new_size;
2619
01f06b63 2620 if (!strcmp(optarg, "global")) {
5ec10eaa
JA
2621 log_err("fio: can't use global as only "
2622 "section\n");
c09823ab
JA
2623 do_exit++;
2624 exit_val = 1;
01f06b63
JA
2625 break;
2626 }
ad0a2735
JA
2627 new_size = (nr_job_sections + 1) * sizeof(char *);
2628 job_sections = realloc(job_sections, new_size);
2629 job_sections[nr_job_sections] = strdup(optarg);
2630 nr_job_sections++;
01f06b63 2631 break;
ad0a2735 2632 }
b26317c9
JA
2633#ifdef CONFIG_ZLIB
2634 case 'X':
2635 exit_val = iolog_file_inflate(optarg);
1201b24a 2636 did_arg = true;
b26317c9
JA
2637 do_exit++;
2638 break;
2639#endif
9ac8a797 2640 case 'p':
1201b24a 2641 did_arg = true;
4af7c007
JA
2642 if (exec_profile)
2643 free(exec_profile);
07b3232d 2644 exec_profile = strdup(optarg);
9ac8a797 2645 break;
b4692828 2646 case FIO_GETOPT_JOB: {
5ec10eaa 2647 const char *opt = l_opts[lidx].name;
b4692828
JA
2648 char *val = optarg;
2649
c2b1e753 2650 if (!strncmp(opt, "name", 4) && td) {
46bcd498 2651 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
66251554 2652 if (ret)
4a4ac4e3 2653 goto out_free;
c2b1e753 2654 td = NULL;
1201b24a 2655 did_arg = true;
c2b1e753 2656 }
b4692828 2657 if (!td) {
01f06b63 2658 int is_section = !strncmp(opt, "name", 4);
3106f220
JA
2659 int global = 0;
2660
01f06b63 2661 if (!is_section || !strncmp(val, "global", 6))
3106f220 2662 global = 1;
c2b1e753 2663
01f06b63
JA
2664 if (is_section && skip_this_section(val))
2665 continue;
2666
8983ce71 2667 td = get_new_job(global, &def_thread, true, NULL);
f6ff24cb
JA
2668 if (!td || ioengine_load(td)) {
2669 if (td) {
2670 put_job(td);
2671 td = NULL;
2672 }
2673 do_exit++;
205a719e 2674 exit_val = 1;
f6ff24cb
JA
2675 break;
2676 }
de890a1e 2677 fio_options_set_ioengine_opts(l_opts, td);
b4692828 2678 }
38d0adb0 2679
9d918187
JA
2680 if ((!val || !strlen(val)) &&
2681 l_opts[lidx].has_arg == required_argument) {
2682 log_err("fio: option %s requires an argument\n", opt);
2683 ret = 1;
2684 } else
2685 ret = fio_cmd_option_parse(td, opt, val);
2686
bfb3ea22
JA
2687 if (ret) {
2688 if (td) {
2689 put_job(td);
2690 td = NULL;
2691 }
a88c8c14 2692 do_exit++;
205a719e 2693 exit_val = 1;
bfb3ea22 2694 }
de890a1e
SL
2695
2696 if (!ret && !strcmp(opt, "ioengine")) {
f6ff24cb 2697 if (ioengine_load(td)) {
342f570e
JA
2698 put_job(td);
2699 td = NULL;
f6ff24cb 2700 do_exit++;
205a719e 2701 exit_val = 1;
f6ff24cb
JA
2702 break;
2703 }
de890a1e
SL
2704 fio_options_set_ioengine_opts(l_opts, td);
2705 }
2706 break;
2707 }
2708 case FIO_GETOPT_IOENGINE: {
2709 const char *opt = l_opts[lidx].name;
2710 char *val = optarg;
b1ed74e0
JA
2711
2712 if (!td)
2713 break;
2714
de890a1e 2715 ret = fio_cmd_ioengine_option_parse(td, opt, val);
b4692828
JA
2716 break;
2717 }
a9523c6f
JA
2718 case 'w':
2719 warnings_fatal = 1;
2720 break;
fca70358
JA
2721 case 'j':
2722 max_jobs = atoi(optarg);
2723 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2724 log_err("fio: invalid max jobs: %d\n", max_jobs);
2725 do_exit++;
2726 exit_val = 1;
2727 }
2728 break;
50d16976 2729 case 'S':
1201b24a 2730 did_arg = true;
c8931876 2731#ifndef CONFIG_NO_SHM
a37f69b7 2732 if (nr_clients) {
132159a5
JA
2733 log_err("fio: can't be both client and server\n");
2734 do_exit++;
2735 exit_val = 1;
2736 break;
2737 }
87aa8f19 2738 if (optarg)
bebe6398 2739 fio_server_set_arg(optarg);
f1867a7f
JA
2740 is_backend = true;
2741 backend = true;
c8931876
JA
2742#else
2743 log_err("fio: client/server requires SHM support\n");
2744 do_exit++;
2745 exit_val = 1;
2746#endif
50d16976 2747 break;
e46d8091 2748 case 'D':
6cfe9a8c
JA
2749 if (pid_file)
2750 free(pid_file);
402668f3 2751 pid_file = strdup(optarg);
e46d8091 2752 break;
f2a2ce0e
HL
2753 case 'I':
2754 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2755 /* exit on error and calibration only */
1201b24a 2756 did_arg = true;
f2a2ce0e 2757 do_exit++;
7d8ea970 2758 if (ret == -1)
f2a2ce0e
HL
2759 exit_val = 1;
2760 }
2761 break;
132159a5 2762 case 'C':
1201b24a 2763 did_arg = true;
132159a5
JA
2764 if (is_backend) {
2765 log_err("fio: can't be both client and server\n");
2766 do_exit++;
2767 exit_val = 1;
2768 break;
2769 }
08633c32
BE
2770 /* if --client parameter contains a pathname */
2771 if (0 == access(optarg, R_OK)) {
2772 /* file contains a list of host addrs or names */
2972708f 2773 char hostaddr[PATH_MAX] = {0};
08633c32
BE
2774 char formatstr[8];
2775 FILE * hostf = fopen(optarg, "r");
2776 if (!hostf) {
2777 log_err("fio: could not open client list file %s for read\n", optarg);
2778 do_exit++;
2779 exit_val = 1;
2780 break;
2781 }
2972708f
JA
2782 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2783 /*
2784 * read at most PATH_MAX-1 chars from each
2785 * record in this file
2786 */
08633c32
BE
2787 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2788 /* expect EVERY host in file to be valid */
2789 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2790 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2791 do_exit++;
2792 exit_val = 1;
2793 break;
2794 }
2795 }
2796 fclose(hostf);
2797 break; /* no possibility of job file for "this client only" */
2798 }
a5276616 2799 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
bebe6398
JA
2800 log_err("fio: failed adding client %s\n", optarg);
2801 do_exit++;
2802 exit_val = 1;
2803 break;
2804 }
14ea90ed
JA
2805 /*
2806 * If the next argument exists and isn't an option,
2807 * assume it's a job file for this client only.
2808 */
2809 while (optind < argc) {
2810 if (!strncmp(argv[optind], "--", 2) ||
2811 !strncmp(argv[optind], "-", 1))
2812 break;
2813
bb781643 2814 if (fio_client_add_ini_file(cur_client, argv[optind], false))
323255cc 2815 break;
14ea90ed
JA
2816 optind++;
2817 }
132159a5 2818 break;
323255cc 2819 case 'R':
1201b24a 2820 did_arg = true;
bb781643 2821 if (fio_client_add_ini_file(cur_client, optarg, true)) {
323255cc
JA
2822 do_exit++;
2823 exit_val = 1;
2824 }
2825 break;
7d11f871 2826 case 'T':
1201b24a 2827 did_arg = true;
7d11f871 2828 do_exit++;
aad918e4 2829 exit_val = fio_monotonic_clocktest(1);
7d11f871 2830 break;
fec0f21c 2831 case 'G':
1201b24a 2832 did_arg = true;
fec0f21c
JA
2833 do_exit++;
2834 exit_val = fio_crctest(optarg);
2835 break;
b76d85a4
JA
2836 case 'M':
2837 did_arg = true;
2838 do_exit++;
2839 exit_val = fio_memcpy_test(optarg);
2840 break;
06464907
JA
2841 case 'L': {
2842 long long val;
2843
88038bc7 2844 if (check_str_time(optarg, &val, 1)) {
06464907
JA
2845 log_err("fio: failed parsing time %s\n", optarg);
2846 do_exit++;
2847 exit_val = 1;
2848 break;
2849 }
969357b0
JA
2850 if (val < 1000) {
2851 log_err("fio: status interval too small\n");
2852 do_exit++;
2853 exit_val = 1;
2854 }
88038bc7 2855 status_interval = val / 1000;
06464907
JA
2856 break;
2857 }
b63efd30 2858 case 'W':
f9cbae9e
JA
2859 if (trigger_file)
2860 free(trigger_file);
b63efd30
JA
2861 trigger_file = strdup(optarg);
2862 break;
2863 case 'H':
f9cbae9e
JA
2864 if (trigger_cmd)
2865 free(trigger_cmd);
b63efd30
JA
2866 trigger_cmd = strdup(optarg);
2867 break;
2868 case 'J':
f9cbae9e
JA
2869 if (trigger_remote_cmd)
2870 free(trigger_remote_cmd);
b63efd30 2871 trigger_remote_cmd = strdup(optarg);
ca09be4b 2872 break;
d264264a
JA
2873 case 'K':
2874 if (aux_path)
2875 free(aux_path);
2876 aux_path = strdup(optarg);
2877 break;
ca09be4b
JA
2878 case 'B':
2879 if (check_str_time(optarg, &trigger_timeout, 1)) {
2880 log_err("fio: failed parsing time %s\n", optarg);
2881 do_exit++;
2882 exit_val = 1;
2883 }
2884 trigger_timeout /= 1000000;
2885 break;
b9921d1a
DZ
2886
2887 case 'A':
2888 did_arg = true;
f1867a7f 2889 merge_blktrace_only = true;
b9921d1a 2890 break;
798827c8
JA
2891 case '?':
2892 log_err("%s: unrecognized option '%s'\n", argv[0],
2893 argv[optind - 1]);
a893c261 2894 show_closest_option(argv[optind - 1]);
24010223 2895 /* fall through */
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}