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