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