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