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