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