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