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