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