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