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