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