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