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