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