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