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