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