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