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