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