Fix merge error hiding mmap ioengine under Windows build
[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>
12#include <sys/shm.h>
13#include <sys/types.h>
14#include <sys/stat.h>
15
16#include "fio.h"
cb2c86fd 17#include "parse.h"
2e5cdb11 18#include "smalloc.h"
380065aa 19#include "filehash.h"
4f5af7b2 20#include "verify.h"
79d16311 21#include "profile.h"
ebac4655 22
bf2e821a
CC
23#include "lib/getopt.h"
24
964f5b9b 25static char fio_version_string[] = "fio 1.50-rc3";
214e1eca 26
ee738499 27#define FIO_RANDSEED (0xb1899bedUL)
ebac4655 28
214e1eca
JA
29static char **ini_file;
30static int max_jobs = MAX_JOBS;
cca73aa7 31static int dump_cmdline;
e1f36503 32
be4ecfdf 33static struct thread_data def_thread;
214e1eca 34struct thread_data *threads = NULL;
e1f36503 35
214e1eca
JA
36int exitall_on_terminate = 0;
37int terse_output = 0;
e592a06b 38int eta_print;
214e1eca
JA
39unsigned long long mlock_size = 0;
40FILE *f_out = NULL;
41FILE *f_err = NULL;
01f06b63 42char *job_section = NULL;
07b3232d 43char *exec_profile = NULL;
a9523c6f 44int warnings_fatal = 0;
ee738499 45
214e1eca 46int write_bw_log = 0;
4241ea8f 47int read_only = 0;
214e1eca 48
5ec10eaa
JA
49static int def_timeout;
50static int write_lat_log;
e1f36503 51
214e1eca 52static int prev_group_jobs;
b4692828 53
ee56ad50 54unsigned long fio_debug = 0;
5e1d306e
JA
55unsigned int fio_debug_jobno = -1;
56unsigned int *fio_debug_jobp = NULL;
ee56ad50 57
4c6107ff
JA
58static char cmd_optstr[256];
59
b4692828
JA
60/*
61 * Command line options. These will contain the above, plus a few
62 * extra that only pertain to fio itself and not jobs.
63 */
5ec10eaa 64static struct option l_opts[FIO_NR_OPTIONS] = {
b4692828
JA
65 {
66 .name = "output",
67 .has_arg = required_argument,
68 .val = 'o',
69 },
70 {
71 .name = "timeout",
72 .has_arg = required_argument,
73 .val = 't',
74 },
75 {
76 .name = "latency-log",
77 .has_arg = required_argument,
78 .val = 'l',
79 },
80 {
81 .name = "bandwidth-log",
82 .has_arg = required_argument,
83 .val = 'b',
84 },
85 {
86 .name = "minimal",
87 .has_arg = optional_argument,
88 .val = 'm',
89 },
90 {
91 .name = "version",
92 .has_arg = no_argument,
93 .val = 'v',
94 },
fd28ca49
JA
95 {
96 .name = "help",
97 .has_arg = no_argument,
98 .val = 'h',
99 },
100 {
101 .name = "cmdhelp",
320beefe 102 .has_arg = optional_argument,
fd28ca49
JA
103 .val = 'c',
104 },
cca73aa7
JA
105 {
106 .name = "showcmd",
107 .has_arg = no_argument,
724e4435
JA
108 .val = 's',
109 },
110 {
111 .name = "readonly",
112 .has_arg = no_argument,
113 .val = 'r',
cca73aa7 114 },
e592a06b
AC
115 {
116 .name = "eta",
117 .has_arg = required_argument,
118 .val = 'e',
119 },
ee56ad50
JA
120 {
121 .name = "debug",
122 .has_arg = required_argument,
123 .val = 'd',
124 },
01f06b63
JA
125 {
126 .name = "section",
127 .has_arg = required_argument,
128 .val = 'x',
129 },
2b386d25
JA
130 {
131 .name = "alloc-size",
132 .has_arg = required_argument,
133 .val = 'a',
134 },
9ac8a797
JA
135 {
136 .name = "profile",
137 .has_arg = required_argument,
138 .val = 'p',
139 },
a9523c6f
JA
140 {
141 .name = "warnings-fatal",
142 .has_arg = no_argument,
143 .val = 'w',
144 },
b4692828
JA
145 {
146 .name = NULL,
147 },
148};
149
9728ce37
JB
150FILE *get_f_out()
151{
152 return f_out;
153}
154
155FILE *get_f_err()
156{
157 return f_err;
158}
159
906c8d75
JA
160/*
161 * Return a free job structure.
162 */
ebac4655
JA
163static struct thread_data *get_new_job(int global, struct thread_data *parent)
164{
165 struct thread_data *td;
166
167 if (global)
168 return &def_thread;
e61f1ec8
BC
169 if (thread_number >= max_jobs) {
170 log_err("error: maximum number of jobs (%d) reached.\n",
171 max_jobs);
ebac4655 172 return NULL;
e61f1ec8 173 }
ebac4655
JA
174
175 td = &threads[thread_number++];
ddaeaa5a 176 *td = *parent;
ebac4655 177
e0b0d892
JA
178 td->o.uid = td->o.gid = -1U;
179
cade3ef4 180 dup_files(td, parent);
d23bb327 181 options_mem_dupe(td);
cade3ef4 182
15dc1934
JA
183 profile_add_hooks(td);
184
ebac4655 185 td->thread_number = thread_number;
ebac4655
JA
186 return td;
187}
188
189static void put_job(struct thread_data *td)
190{
549577a7
JA
191 if (td == &def_thread)
192 return;
58c55ba0
JA
193
194 profile_td_exit(td);
549577a7 195
16edf25d 196 if (td->error)
6d86144d 197 log_info("fio: %s\n", td->verror);
16edf25d 198
ebac4655
JA
199 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
200 thread_number--;
201}
202
581e7141 203static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
127f6865 204{
581e7141 205 unsigned int bs = td->o.min_bs[ddir];
ba3e4e0c 206 unsigned long long bytes_per_sec;
127f6865 207
ff58fced
JA
208 assert(ddir_rw(ddir));
209
ba3e4e0c
RR
210 if (td->o.rate[ddir])
211 bytes_per_sec = td->o.rate[ddir];
212 else
213 bytes_per_sec = td->o.rate_iops[ddir] * bs;
127f6865 214
ba3e4e0c 215 if (!bytes_per_sec) {
127f6865
JA
216 log_err("rate lower than supported\n");
217 return -1;
218 }
219
ba3e4e0c 220 td->rate_nsec_cycle[ddir] = 1000000000ULL / bytes_per_sec;
581e7141 221 td->rate_pending_usleep[ddir] = 0;
127f6865
JA
222 return 0;
223}
224
581e7141
JA
225static int setup_rate(struct thread_data *td)
226{
227 int ret = 0;
228
229 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
230 ret = __setup_rate(td, DDIR_READ);
231 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
232 ret |= __setup_rate(td, DDIR_WRITE);
233
234 return ret;
235}
236
8347239a
JA
237static int fixed_block_size(struct thread_options *o)
238{
239 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
240 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
241 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
242}
243
dad915e3
JA
244/*
245 * Lazy way of fixing up options that depend on each other. We could also
246 * define option callback handlers, but this is easier.
247 */
4e991c23 248static int fixup_options(struct thread_data *td)
e1f36503 249{
2dc1bbeb 250 struct thread_options *o = &td->o;
ff217451 251 int ret = 0;
dad915e3 252
f356d01d 253#ifndef FIO_HAVE_PSHARED_MUTEX
9bbf57cc 254 if (!o->use_thread) {
f356d01d
JA
255 log_info("fio: this platform does not support process shared"
256 " mutexes, forcing use of threads. Use the 'thread'"
257 " option to get rid of this warning.\n");
9bbf57cc 258 o->use_thread = 1;
a9523c6f 259 ret = warnings_fatal;
f356d01d
JA
260 }
261#endif
262
2dc1bbeb 263 if (o->write_iolog_file && o->read_iolog_file) {
076efc7c 264 log_err("fio: read iolog overrides write_iolog\n");
2dc1bbeb
JA
265 free(o->write_iolog_file);
266 o->write_iolog_file = NULL;
a9523c6f 267 ret = warnings_fatal;
076efc7c 268 }
16b462ae 269
16b462ae
JA
270 /*
271 * only really works for sequential io for now, and with 1 file
272 */
2dc1bbeb
JA
273 if (o->zone_size && td_random(td) && o->open_files == 1)
274 o->zone_size = 0;
16b462ae
JA
275
276 /*
277 * Reads can do overwrites, we always need to pre-create the file
278 */
279 if (td_read(td) || td_rw(td))
2dc1bbeb 280 o->overwrite = 1;
16b462ae 281
2dc1bbeb 282 if (!o->min_bs[DDIR_READ])
5ec10eaa 283 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
2dc1bbeb
JA
284 if (!o->max_bs[DDIR_READ])
285 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
286 if (!o->min_bs[DDIR_WRITE])
5ec10eaa 287 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
2dc1bbeb
JA
288 if (!o->max_bs[DDIR_WRITE])
289 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
a00735e6 290
2dc1bbeb 291 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
a00735e6 292
2b7a01d0
JA
293 /*
294 * For random IO, allow blockalign offset other than min_bs.
295 */
296 if (!o->ba[DDIR_READ] || !td_random(td))
297 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
298 if (!o->ba[DDIR_WRITE] || !td_random(td))
299 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
300
301 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
302 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
9bbf57cc 303 !o->norandommap) {
2b7a01d0 304 log_err("fio: Any use of blockalign= turns off randommap\n");
9bbf57cc 305 o->norandommap = 1;
a9523c6f 306 ret = warnings_fatal;
2b7a01d0
JA
307 }
308
2dc1bbeb
JA
309 if (!o->file_size_high)
310 o->file_size_high = o->file_size_low;
9c60ce64 311
8347239a
JA
312 if (o->norandommap && o->verify != VERIFY_NONE
313 && !fixed_block_size(o)) {
314 log_err("fio: norandommap given for variable block sizes, "
315 "verify disabled\n");
2dc1bbeb 316 o->verify = VERIFY_NONE;
a9523c6f 317 ret = warnings_fatal;
bb8895e0 318 }
2dc1bbeb 319 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
690adba3 320 log_err("fio: bs_unaligned may not work with raw io\n");
e0a22335 321
48097d5c
JA
322 /*
323 * thinktime_spin must be less than thinktime
324 */
2dc1bbeb
JA
325 if (o->thinktime_spin > o->thinktime)
326 o->thinktime_spin = o->thinktime;
e916b390
JA
327
328 /*
329 * The low water mark cannot be bigger than the iodepth
330 */
2dc1bbeb 331 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
9467b77c
JA
332 /*
333 * syslet work around - if the workload is sequential,
334 * we want to let the queue drain all the way down to
335 * avoid seeking between async threads
336 */
337 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
2dc1bbeb 338 o->iodepth_low = 1;
9467b77c 339 else
2dc1bbeb 340 o->iodepth_low = o->iodepth;
9467b77c 341 }
cb5ab512
JA
342
343 /*
344 * If batch number isn't set, default to the same as iodepth
345 */
2dc1bbeb
JA
346 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
347 o->iodepth_batch = o->iodepth;
b5af8293 348
2dc1bbeb
JA
349 if (o->nr_files > td->files_index)
350 o->nr_files = td->files_index;
9f9214f2 351
2dc1bbeb
JA
352 if (o->open_files > o->nr_files || !o->open_files)
353 o->open_files = o->nr_files;
4e991c23 354
581e7141
JA
355 if (((o->rate[0] + o->rate[1]) && (o->rate_iops[0] + o->rate_iops[1]))||
356 ((o->ratemin[0] + o->ratemin[1]) && (o->rate_iops_min[0] +
357 o->rate_iops_min[1]))) {
4e991c23 358 log_err("fio: rate and rate_iops are mutually exclusive\n");
a9523c6f 359 ret = 1;
4e991c23 360 }
581e7141
JA
361 if ((o->rate[0] < o->ratemin[0]) || (o->rate[1] < o->ratemin[1]) ||
362 (o->rate_iops[0] < o->rate_iops_min[0]) ||
363 (o->rate_iops[1] < o->rate_iops_min[1])) {
4e991c23 364 log_err("fio: minimum rate exceeds rate\n");
a9523c6f 365 ret = 1;
4e991c23
JA
366 }
367
cf4464ca
JA
368 if (!o->timeout && o->time_based) {
369 log_err("fio: time_based requires a runtime/timeout setting\n");
370 o->time_based = 0;
a9523c6f 371 ret = warnings_fatal;
cf4464ca
JA
372 }
373
aa31f1f1 374 if (o->fill_device && !o->size)
5921e80c 375 o->size = -1ULL;
5ec10eaa 376
9bbf57cc 377 if (o->verify != VERIFY_NONE) {
a9523c6f
JA
378 if (td_rw(td)) {
379 log_info("fio: mixed read/write workload with verify. "
380 "May not work as expected, unless you "
381 "pre-populated the file\n");
382 ret = warnings_fatal;
383 }
996936f9 384 if (td_write(td) && o->do_verify && o->numjobs > 1) {
a9523c6f
JA
385 log_info("Multiple writers may overwrite blocks that "
386 "belong to other jobs. This can cause "
387 "verification failures.\n");
388 ret = warnings_fatal;
389 }
390
9bbf57cc 391 o->refill_buffers = 1;
2f1b8e8b
JA
392 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
393 !o->verify_interval)
394 o->verify_interval = o->min_bs[DDIR_WRITE];
d990588e 395 }
41ccd845 396
9bbf57cc
JA
397 if (o->pre_read) {
398 o->invalidate_cache = 0;
a9523c6f 399 if (td->io_ops->flags & FIO_PIPEIO) {
9c0d2241
JA
400 log_info("fio: cannot pre-read files with an IO engine"
401 " that isn't seekable. Pre-read disabled.\n");
a9523c6f
JA
402 ret = warnings_fatal;
403 }
9c0d2241 404 }
34f1c044 405
e72fa4d4 406#ifndef FIO_HAVE_FDATASYNC
9bbf57cc 407 if (o->fdatasync_blocks) {
e72fa4d4
JA
408 log_info("fio: this platform does not support fdatasync()"
409 " falling back to using fsync(). Use the 'fsync'"
410 " option instead of 'fdatasync' to get rid of"
411 " this warning\n");
9bbf57cc
JA
412 o->fsync_blocks = o->fdatasync_blocks;
413 o->fdatasync_blocks = 0;
a9523c6f 414 ret = warnings_fatal;
e72fa4d4
JA
415 }
416#endif
417
a9523c6f 418 return ret;
e1f36503
JA
419}
420
f8977ee6
JA
421/*
422 * This function leaks the buffer
423 */
424static char *to_kmg(unsigned int val)
425{
426 char *buf = malloc(32);
f3502ba2 427 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
f8977ee6
JA
428 char *p = post;
429
245142ff 430 do {
f8977ee6
JA
431 if (val & 1023)
432 break;
433
434 val >>= 10;
435 p++;
245142ff 436 } while (*p);
f8977ee6
JA
437
438 snprintf(buf, 31, "%u%c", val, *p);
439 return buf;
440}
441
09629a90
JA
442/* External engines are specified by "external:name.o") */
443static const char *get_engine_name(const char *str)
444{
445 char *p = strstr(str, ":");
446
447 if (!p)
448 return str;
449
450 p++;
451 strip_blank_front(&p);
452 strip_blank_end(p);
453 return p;
454}
455
e132cbae
JA
456static int exists_and_not_file(const char *filename)
457{
458 struct stat sb;
459
460 if (lstat(filename, &sb) == -1)
461 return 0;
462
ecc314ba
BC
463 /* \\.\ is the device namespace in Windows, where every file
464 * is a device node */
465 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
e132cbae
JA
466 return 0;
467
468 return 1;
469}
470
5bfc35d7
JA
471void td_fill_rand_seeds(struct thread_data *td)
472{
473 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
474 os_random_seed(td->rand_seeds[1], &td->verify_state);
475 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
476
477 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
478 os_random_seed(td->rand_seeds[3], &td->next_file_state);
479
480 os_random_seed(td->rand_seeds[5], &td->file_size_state);
0d29de83 481 os_random_seed(td->rand_seeds[6], &td->trim_state);
5bfc35d7
JA
482
483 if (!td_random(td))
484 return;
485
486 if (td->o.rand_repeatable)
487 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
488
489 os_random_seed(td->rand_seeds[4], &td->random_state);
490}
491
9c60ce64
JA
492/*
493 * Initialize the various random states we need (random io, block size ranges,
494 * read/write mix, etc).
495 */
496static int init_random_state(struct thread_data *td)
497{
68727076 498 int fd;
9c60ce64
JA
499
500 fd = open("/dev/urandom", O_RDONLY);
501 if (fd == -1) {
502 td_verror(td, errno, "open");
503 return 1;
504 }
505
5bfc35d7
JA
506 if (read(fd, td->rand_seeds, sizeof(td->rand_seeds)) <
507 (int) sizeof(td->rand_seeds)) {
9c60ce64
JA
508 td_verror(td, EIO, "read");
509 close(fd);
510 return 1;
511 }
512
513 close(fd);
5bfc35d7 514 td_fill_rand_seeds(td);
9c60ce64
JA
515 return 0;
516}
517
906c8d75
JA
518/*
519 * Adds a job to the list of things todo. Sanitizes the various options
520 * to make sure we don't have conflicts, and initializes various
521 * members of td.
522 */
75154845 523static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
ebac4655 524{
413dd459
JA
525 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
526 "randread", "randwrite", "randrw" };
af52b345 527 unsigned int i;
09629a90 528 const char *engine;
af52b345 529 char fname[PATH_MAX];
e132cbae 530 int numjobs, file_alloced;
ebac4655 531
ebac4655
JA
532 /*
533 * the def_thread is just for options, it's not a real job
534 */
535 if (td == &def_thread)
536 return 0;
537
cca73aa7
JA
538 /*
539 * if we are just dumping the output command line, don't add the job
540 */
541 if (dump_cmdline) {
542 put_job(td);
543 return 0;
544 }
545
58c55ba0
JA
546 if (profile_td_init(td))
547 return 1;
548
2dc1bbeb 549 engine = get_engine_name(td->o.ioengine);
09629a90
JA
550 td->io_ops = load_ioengine(td, engine);
551 if (!td->io_ops) {
552 log_err("fio: failed to load engine %s\n", engine);
205927a3 553 goto err;
09629a90 554 }
df64119d 555
2dc1bbeb 556 if (td->o.use_thread)
9cedf167
JA
557 nr_thread++;
558 else
559 nr_process++;
560
2dc1bbeb 561 if (td->o.odirect)
690adba3
JA
562 td->io_ops->flags |= FIO_RAWIO;
563
e132cbae 564 file_alloced = 0;
691c8fb0 565 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
e132cbae 566 file_alloced = 1;
80be24f4 567
2dc1bbeb 568 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
e132cbae 569 add_file(td, jobname);
7b05a215 570 else {
2dc1bbeb 571 for (i = 0; i < td->o.nr_files; i++) {
5ec10eaa
JA
572 sprintf(fname, "%s.%d.%d", jobname,
573 td->thread_number, i);
7b05a215
JA
574 add_file(td, fname);
575 }
af52b345 576 }
0af7b542 577 }
ebac4655 578
4e991c23
JA
579 if (fixup_options(td))
580 goto err;
e0a22335 581
07eb79df
JA
582 if (td->io_ops->flags & FIO_DISKLESSIO) {
583 struct fio_file *f;
584
585 for_each_file(td, f, i)
586 f->real_file_size = -1ULL;
587 }
588
cdd18ad8 589 td->mutex = fio_mutex_init(0);
ebac4655 590
756867bd
JA
591 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
592 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
02af0988 593 td->ts.lat_stat[0].min_val = td->ts.lat_stat[1].min_val = ULONG_MAX;
756867bd 594 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
cdd5411e 595 td->ddir_seq_nr = td->o.ddir_seq_nr;
ebac4655 596
755c3189 597 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
3c5df6fa 598 prev_group_jobs = 0;
ebac4655 599 groupid++;
3c5df6fa 600 }
ebac4655
JA
601
602 td->groupid = groupid;
3c5df6fa 603 prev_group_jobs++;
ebac4655 604
9c60ce64
JA
605 if (init_random_state(td))
606 goto err;
607
ebac4655
JA
608 if (setup_rate(td))
609 goto err;
610
2dc1bbeb 611 if (td->o.write_lat_log) {
02af0988 612 setup_log(&td->ts.lat_log);
756867bd
JA
613 setup_log(&td->ts.slat_log);
614 setup_log(&td->ts.clat_log);
ebac4655 615 }
2dc1bbeb 616 if (td->o.write_bw_log)
756867bd 617 setup_log(&td->ts.bw_log);
ebac4655 618
2dc1bbeb
JA
619 if (!td->o.name)
620 td->o.name = strdup(jobname);
01452055 621
c6ae0a5b 622 if (!terse_output) {
b990b5c0 623 if (!job_add_num) {
5ec10eaa
JA
624 if (!strcmp(td->io_ops->name, "cpuio")) {
625 log_info("%s: ioengine=cpu, cpuload=%u,"
626 " cpucycle=%u\n", td->o.name,
627 td->o.cpuload,
628 td->o.cpucycle);
629 } else {
f8977ee6
JA
630 char *c1, *c2, *c3, *c4;
631
2dc1bbeb
JA
632 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
633 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
634 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
635 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
f8977ee6 636
5ec10eaa
JA
637 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
638 " ioengine=%s, iodepth=%u\n",
639 td->o.name, td->groupid,
640 ddir_str[td->o.td_ddir],
641 c1, c2, c3, c4,
642 td->io_ops->name,
643 td->o.iodepth);
f8977ee6
JA
644
645 free(c1);
646 free(c2);
647 free(c3);
648 free(c4);
649 }
b990b5c0 650 } else if (job_add_num == 1)
6d86144d 651 log_info("...\n");
c6ae0a5b 652 }
ebac4655
JA
653
654 /*
655 * recurse add identical jobs, clear numjobs and stonewall options
656 * as they don't apply to sub-jobs
657 */
2dc1bbeb 658 numjobs = td->o.numjobs;
ebac4655
JA
659 while (--numjobs) {
660 struct thread_data *td_new = get_new_job(0, td);
661
662 if (!td_new)
663 goto err;
664
2dc1bbeb
JA
665 td_new->o.numjobs = 1;
666 td_new->o.stonewall = 0;
92c1d41f 667 td_new->o.new_group = 0;
e132cbae
JA
668
669 if (file_alloced) {
2dc1bbeb 670 td_new->o.filename = NULL;
e132cbae 671 td_new->files_index = 0;
4e6ea2f1 672 td_new->files_size = 0;
e132cbae
JA
673 td_new->files = NULL;
674 }
675
75154845 676 job_add_num = numjobs - 1;
ebac4655 677
75154845 678 if (add_job(td_new, jobname, job_add_num))
ebac4655
JA
679 goto err;
680 }
3c5df6fa 681
ebac4655
JA
682 return 0;
683err:
684 put_job(td);
685 return -1;
686}
687
79d16311
JA
688/*
689 * Parse as if 'o' was a command line
690 */
691void add_job_opts(const char **o)
692{
693 struct thread_data *td, *td_parent;
694 int i, in_global = 1;
695 char jobname[32];
696
697 i = 0;
698 td_parent = td = NULL;
699 while (o[i]) {
700 if (!strncmp(o[i], "name", 4)) {
701 in_global = 0;
702 if (td)
703 add_job(td, jobname, 0);
704 td = NULL;
705 sprintf(jobname, "%s", o[i] + 5);
706 }
707 if (in_global && !td_parent)
708 td_parent = get_new_job(1, &def_thread);
709 else if (!in_global && !td) {
710 if (!td_parent)
711 td_parent = &def_thread;
712 td = get_new_job(0, td_parent);
713 }
714 if (in_global)
715 fio_options_parse(td_parent, (char **) &o[i], 1);
716 else
717 fio_options_parse(td, (char **) &o[i], 1);
718 i++;
719 }
720
721 if (td)
722 add_job(td, jobname, 0);
723}
724
01f06b63
JA
725static int skip_this_section(const char *name)
726{
727 if (!job_section)
728 return 0;
729 if (!strncmp(name, "global", 6))
730 return 0;
731
b36beb6e 732 return strcmp(job_section, name);
01f06b63
JA
733}
734
ebac4655
JA
735static int is_empty_or_comment(char *line)
736{
737 unsigned int i;
738
739 for (i = 0; i < strlen(line); i++) {
740 if (line[i] == ';')
741 return 1;
5cc2da30
IM
742 if (line[i] == '#')
743 return 1;
ebac4655
JA
744 if (!isspace(line[i]) && !iscntrl(line[i]))
745 return 0;
746 }
747
748 return 1;
749}
750
07261983
JA
751/*
752 * This is our [ini] type file parser.
753 */
1e97cce9 754static int parse_jobs_ini(char *file, int stonewall_flag)
ebac4655 755{
e1f36503 756 unsigned int global;
ebac4655 757 struct thread_data *td;
fee3bb48 758 char *string, *name;
ebac4655
JA
759 FILE *f;
760 char *p;
0c7e37a0 761 int ret = 0, stonewall;
097b2991 762 int first_sect = 1;
ccf8f127 763 int skip_fgets = 0;
01f06b63 764 int inside_skip = 0;
3b8b7135
JA
765 char **opts;
766 int i, alloc_opts, num_opts;
ebac4655 767
5a729cbe
AC
768 if (!strcmp(file, "-"))
769 f = stdin;
770 else
771 f = fopen(file, "r");
772
ebac4655 773 if (!f) {
aea47d44 774 perror("fopen job file");
ebac4655
JA
775 return 1;
776 }
777
778 string = malloc(4096);
7f7e6e59
JA
779
780 /*
781 * it's really 256 + small bit, 280 should suffice
782 */
783 name = malloc(280);
784 memset(name, 0, 280);
ebac4655 785
3b8b7135
JA
786 alloc_opts = 8;
787 opts = malloc(sizeof(char *) * alloc_opts);
b7c6302d 788 num_opts = 0;
3b8b7135 789
0c7e37a0 790 stonewall = stonewall_flag;
7c124ac1 791 do {
ccf8f127
JA
792 /*
793 * if skip_fgets is set, we already have loaded a line we
794 * haven't handled.
795 */
796 if (!skip_fgets) {
797 p = fgets(string, 4095, f);
798 if (!p)
799 break;
800 }
cdc7f193 801
ccf8f127 802 skip_fgets = 0;
cdc7f193 803 strip_blank_front(&p);
6c7c7da1 804 strip_blank_end(p);
cdc7f193 805
ebac4655
JA
806 if (is_empty_or_comment(p))
807 continue;
6c7c7da1 808 if (sscanf(p, "[%255s]", name) != 1) {
01f06b63
JA
809 if (inside_skip)
810 continue;
5ec10eaa
JA
811 log_err("fio: option <%s> outside of [] job section\n",
812 p);
088b4207 813 break;
6c7c7da1 814 }
ebac4655 815
7a4b80a1
JA
816 name[strlen(name) - 1] = '\0';
817
01f06b63
JA
818 if (skip_this_section(name)) {
819 inside_skip = 1;
820 continue;
821 } else
822 inside_skip = 0;
823
ebac4655
JA
824 global = !strncmp(name, "global", 6);
825
cca73aa7 826 if (dump_cmdline) {
097b2991
JA
827 if (first_sect)
828 log_info("fio ");
cca73aa7
JA
829 if (!global)
830 log_info("--name=%s ", name);
097b2991 831 first_sect = 0;
cca73aa7
JA
832 }
833
ebac4655 834 td = get_new_job(global, &def_thread);
45410acb
JA
835 if (!td) {
836 ret = 1;
837 break;
838 }
ebac4655 839
972cfd25
JA
840 /*
841 * Seperate multiple job files by a stonewall
842 */
f9481919 843 if (!global && stonewall) {
2dc1bbeb 844 td->o.stonewall = stonewall;
972cfd25
JA
845 stonewall = 0;
846 }
847
3b8b7135
JA
848 num_opts = 0;
849 memset(opts, 0, alloc_opts * sizeof(char *));
850
ebac4655
JA
851 while ((p = fgets(string, 4096, f)) != NULL) {
852 if (is_empty_or_comment(p))
853 continue;
e1f36503 854
b6754f9d 855 strip_blank_front(&p);
7c124ac1 856
ccf8f127
JA
857 /*
858 * new section, break out and make sure we don't
859 * fgets() a new line at the top.
860 */
861 if (p[0] == '[') {
862 skip_fgets = 1;
7c124ac1 863 break;
ccf8f127 864 }
7c124ac1 865
4ae3f763 866 strip_blank_end(p);
aea47d44 867
3b8b7135
JA
868 if (num_opts == alloc_opts) {
869 alloc_opts <<= 1;
870 opts = realloc(opts,
871 alloc_opts * sizeof(char *));
872 }
873
874 opts[num_opts] = strdup(p);
875 num_opts++;
ebac4655 876 }
ebac4655 877
3b8b7135
JA
878 ret = fio_options_parse(td, opts, num_opts);
879 if (!ret) {
880 if (dump_cmdline)
881 for (i = 0; i < num_opts; i++)
882 log_info("--%s ", opts[i]);
883
45410acb 884 ret = add_job(td, name, 0);
3b8b7135 885 } else {
b1508cf9
JA
886 log_err("fio: job %s dropped\n", name);
887 put_job(td);
45410acb 888 }
3b8b7135
JA
889
890 for (i = 0; i < num_opts; i++)
891 free(opts[i]);
892 num_opts = 0;
7c124ac1 893 } while (!ret);
ebac4655 894
cca73aa7
JA
895 if (dump_cmdline)
896 log_info("\n");
897
3b8b7135
JA
898 for (i = 0; i < num_opts; i++)
899 free(opts[i]);
900
ebac4655
JA
901 free(string);
902 free(name);
2577594d 903 free(opts);
5a729cbe
AC
904 if (f != stdin)
905 fclose(f);
45410acb 906 return ret;
ebac4655
JA
907}
908
909static int fill_def_thread(void)
910{
911 memset(&def_thread, 0, sizeof(def_thread));
912
375b2695 913 fio_getaffinity(getpid(), &def_thread.o.cpumask);
ebac4655
JA
914
915 /*
ee738499 916 * fill default options
ebac4655 917 */
214e1eca 918 fio_fill_default_options(&def_thread);
ee738499 919
2dc1bbeb 920 def_thread.o.timeout = def_timeout;
ebac4655
JA
921 return 0;
922}
923
214e1eca
JA
924static void free_shm(void)
925{
926 struct shmid_ds sbuf;
927
928 if (threads) {
5e1d306e
JA
929 void *tp = threads;
930
214e1eca 931 threads = NULL;
5e1d306e
JA
932 file_hash_exit();
933 fio_debug_jobp = NULL;
934 shmdt(tp);
214e1eca
JA
935 shmctl(shm_id, IPC_RMID, &sbuf);
936 }
2e5cdb11
JA
937
938 scleanup();
214e1eca
JA
939}
940
941/*
942 * The thread area is shared between the main process and the job
943 * threads/processes. So setup a shared memory segment that will hold
380065aa
JA
944 * all the job info. We use the end of the region for keeping track of
945 * open files across jobs, for file sharing.
214e1eca
JA
946 */
947static int setup_thread_area(void)
948{
380065aa
JA
949 void *hash;
950
214e1eca
JA
951 /*
952 * 1024 is too much on some machines, scale max_jobs if
953 * we get a failure that looks like too large a shm segment
954 */
955 do {
956 size_t size = max_jobs * sizeof(struct thread_data);
957
380065aa 958 size += file_hash_size;
5e1d306e 959 size += sizeof(unsigned int);
380065aa 960
214e1eca
JA
961 shm_id = shmget(0, size, IPC_CREAT | 0600);
962 if (shm_id != -1)
963 break;
964 if (errno != EINVAL) {
965 perror("shmget");
966 break;
967 }
968
969 max_jobs >>= 1;
970 } while (max_jobs);
971
972 if (shm_id == -1)
973 return 1;
974
975 threads = shmat(shm_id, NULL, 0);
976 if (threads == (void *) -1) {
977 perror("shmat");
978 return 1;
979 }
980
1f809d15 981 memset(threads, 0, max_jobs * sizeof(struct thread_data));
380065aa 982 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
5e1d306e
JA
983 fio_debug_jobp = (void *) hash + file_hash_size;
984 *fio_debug_jobp = -1;
380065aa 985 file_hash_init(hash);
214e1eca
JA
986 atexit(free_shm);
987 return 0;
988}
989
45378b35 990static void usage(const char *name)
4785f995 991{
45378b35 992 printf("%s [options] [job options] <job file(s)>\n", name);
ee56ad50 993 printf("\t--debug=options\tEnable debug logging\n");
b4692828
JA
994 printf("\t--output\tWrite output to file\n");
995 printf("\t--timeout\tRuntime in seconds\n");
996 printf("\t--latency-log\tGenerate per-job latency logs\n");
997 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
998 printf("\t--minimal\tMinimal (terse) output\n");
999 printf("\t--version\tPrint version info and exit\n");
fd28ca49 1000 printf("\t--help\t\tPrint this page\n");
5ec10eaa
JA
1001 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of"
1002 " them\n");
cca73aa7 1003 printf("\t--showcmd\tTurn a job file into command line options\n");
e592a06b
AC
1004 printf("\t--eta=when\tWhen ETA estimate should be printed\n");
1005 printf("\t \tMay be \"always\", \"never\" or \"auto\"\n");
5ec10eaa
JA
1006 printf("\t--readonly\tTurn on safety read-only checks, preventing"
1007 " writes\n");
01f06b63 1008 printf("\t--section=name\tOnly run specified section in job file\n");
2b386d25
JA
1009 printf("\t--alloc-size=kb\tSet smalloc pool to this size in kb"
1010 " (def 1024)\n");
a9523c6f 1011 printf("\t--warnings-fatal Fio parser warnings are fatal\n");
aa58d252
JA
1012 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1013 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
4785f995
JA
1014}
1015
79e48f72 1016#ifdef FIO_INC_DEBUG
ee56ad50 1017struct debug_level debug_levels[] = {
bd6f78b2
JA
1018 { .name = "process", .shift = FD_PROCESS, },
1019 { .name = "file", .shift = FD_FILE, },
1020 { .name = "io", .shift = FD_IO, },
1021 { .name = "mem", .shift = FD_MEM, },
1022 { .name = "blktrace", .shift = FD_BLKTRACE },
1023 { .name = "verify", .shift = FD_VERIFY },
84422acd 1024 { .name = "random", .shift = FD_RANDOM },
a3d741fa 1025 { .name = "parse", .shift = FD_PARSE },
cd991b9e 1026 { .name = "diskutil", .shift = FD_DISKUTIL },
5e1d306e 1027 { .name = "job", .shift = FD_JOB },
29adda3c 1028 { .name = "mutex", .shift = FD_MUTEX },
79d16311 1029 { .name = "profile", .shift = FD_PROFILE },
c223da83 1030 { .name = "time", .shift = FD_TIME },
02444ad1 1031 { .name = NULL, },
ee56ad50
JA
1032};
1033
c09823ab 1034static int set_debug(const char *string)
ee56ad50
JA
1035{
1036 struct debug_level *dl;
1037 char *p = (char *) string;
1038 char *opt;
1039 int i;
1040
1041 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1042 int i;
1043
1044 log_info("fio: dumping debug options:");
1045 for (i = 0; debug_levels[i].name; i++) {
1046 dl = &debug_levels[i];
1047 log_info("%s,", dl->name);
1048 }
bd6f78b2 1049 log_info("all\n");
c09823ab 1050 return 1;
ee56ad50
JA
1051 }
1052
1053 while ((opt = strsep(&p, ",")) != NULL) {
1054 int found = 0;
1055
5e1d306e
JA
1056 if (!strncmp(opt, "all", 3)) {
1057 log_info("fio: set all debug options\n");
1058 fio_debug = ~0UL;
1059 continue;
1060 }
1061
ee56ad50
JA
1062 for (i = 0; debug_levels[i].name; i++) {
1063 dl = &debug_levels[i];
5e1d306e
JA
1064 found = !strncmp(opt, dl->name, strlen(dl->name));
1065 if (!found)
1066 continue;
1067
1068 if (dl->shift == FD_JOB) {
1069 opt = strchr(opt, ':');
1070 if (!opt) {
1071 log_err("fio: missing job number\n");
1072 break;
1073 }
1074 opt++;
1075 fio_debug_jobno = atoi(opt);
1076 log_info("fio: set debug jobno %d\n",
1077 fio_debug_jobno);
1078 } else {
ee56ad50 1079 log_info("fio: set debug option %s\n", opt);
bd6f78b2 1080 fio_debug |= (1UL << dl->shift);
ee56ad50 1081 }
5e1d306e 1082 break;
ee56ad50
JA
1083 }
1084
1085 if (!found)
1086 log_err("fio: debug mask %s not found\n", opt);
1087 }
c09823ab 1088 return 0;
ee56ad50 1089}
79e48f72 1090#else
69b98d4c 1091static int set_debug(const char *string)
79e48f72
JA
1092{
1093 log_err("fio: debug tracing not included in build\n");
c09823ab 1094 return 1;
79e48f72
JA
1095}
1096#endif
9ac8a797 1097
4c6107ff
JA
1098static void fio_options_fill_optstring(void)
1099{
1100 char *ostr = cmd_optstr;
1101 int i, c;
1102
1103 c = i = 0;
1104 while (l_opts[i].name) {
1105 ostr[c++] = l_opts[i].val;
1106 if (l_opts[i].has_arg == required_argument)
1107 ostr[c++] = ':';
1108 else if (l_opts[i].has_arg == optional_argument) {
1109 ostr[c++] = ':';
1110 ostr[c++] = ':';
1111 }
1112 i++;
1113 }
1114 ostr[c] = '\0';
1115}
1116
972cfd25 1117static int parse_cmd_line(int argc, char *argv[])
ebac4655 1118{
b4692828 1119 struct thread_data *td = NULL;
c09823ab 1120 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
4c6107ff 1121 char *ostr = cmd_optstr;
ebac4655 1122
4c6107ff 1123 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
ebac4655 1124 switch (c) {
2b386d25
JA
1125 case 'a':
1126 smalloc_pool_size = atoi(optarg);
1127 break;
b4692828
JA
1128 case 't':
1129 def_timeout = atoi(optarg);
1130 break;
1131 case 'l':
1132 write_lat_log = 1;
1133 break;
3d73e5a9 1134 case 'b':
b4692828
JA
1135 write_bw_log = 1;
1136 break;
1137 case 'o':
1138 f_out = fopen(optarg, "w+");
1139 if (!f_out) {
1140 perror("fopen output");
1141 exit(1);
1142 }
1143 f_err = f_out;
1144 break;
1145 case 'm':
1146 terse_output = 1;
1147 break;
1148 case 'h':
45378b35 1149 usage(argv[0]);
b4692828 1150 exit(0);
fd28ca49 1151 case 'c':
214e1eca 1152 exit(fio_show_option_help(optarg));
cca73aa7
JA
1153 case 's':
1154 dump_cmdline = 1;
1155 break;
724e4435
JA
1156 case 'r':
1157 read_only = 1;
1158 break;
b4692828 1159 case 'v':
bce964a1 1160 /* already being printed, just quit */
b4692828 1161 exit(0);
e592a06b
AC
1162 case 'e':
1163 if (!strcmp("always", optarg))
1164 eta_print = FIO_ETA_ALWAYS;
1165 else if (!strcmp("never", optarg))
1166 eta_print = FIO_ETA_NEVER;
1167 break;
ee56ad50 1168 case 'd':
c09823ab
JA
1169 if (set_debug(optarg))
1170 do_exit++;
ee56ad50 1171 break;
01f06b63
JA
1172 case 'x':
1173 if (!strcmp(optarg, "global")) {
5ec10eaa
JA
1174 log_err("fio: can't use global as only "
1175 "section\n");
c09823ab
JA
1176 do_exit++;
1177 exit_val = 1;
01f06b63
JA
1178 break;
1179 }
1180 if (job_section)
1181 free(job_section);
1182 job_section = strdup(optarg);
1183 break;
9ac8a797 1184 case 'p':
07b3232d 1185 exec_profile = strdup(optarg);
9ac8a797 1186 break;
b4692828 1187 case FIO_GETOPT_JOB: {
5ec10eaa 1188 const char *opt = l_opts[lidx].name;
b4692828
JA
1189 char *val = optarg;
1190
c2b1e753 1191 if (!strncmp(opt, "name", 4) && td) {
2dc1bbeb 1192 ret = add_job(td, td->o.name ?: "fio", 0);
c2b1e753
JA
1193 if (ret) {
1194 put_job(td);
1195 return 0;
1196 }
1197 td = NULL;
1198 }
b4692828 1199 if (!td) {
01f06b63 1200 int is_section = !strncmp(opt, "name", 4);
3106f220
JA
1201 int global = 0;
1202
01f06b63 1203 if (!is_section || !strncmp(val, "global", 6))
3106f220 1204 global = 1;
c2b1e753 1205
01f06b63
JA
1206 if (is_section && skip_this_section(val))
1207 continue;
1208
c2b1e753 1209 td = get_new_job(global, &def_thread);
b4692828
JA
1210 if (!td)
1211 return 0;
1212 }
38d0adb0 1213
214e1eca 1214 ret = fio_cmd_option_parse(td, opt, val);
b4692828
JA
1215 break;
1216 }
a9523c6f
JA
1217 case 'w':
1218 warnings_fatal = 1;
1219 break;
b4692828 1220 default:
c09823ab
JA
1221 do_exit++;
1222 exit_val = 1;
b4692828 1223 break;
ebac4655
JA
1224 }
1225 }
c9fad893 1226
c09823ab
JA
1227 if (do_exit)
1228 exit(exit_val);
536582bf 1229
b4692828 1230 if (td) {
7d6a8904 1231 if (!ret)
2dc1bbeb 1232 ret = add_job(td, td->o.name ?: "fio", 0);
7d6a8904
JA
1233 if (ret)
1234 put_job(td);
972cfd25 1235 }
774a6177 1236
b4692828
JA
1237 while (optind < argc) {
1238 ini_idx++;
1239 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1240 ini_file[ini_idx - 1] = strdup(argv[optind]);
1241 optind++;
eb8bbf48 1242 }
972cfd25
JA
1243
1244 return ini_idx;
ebac4655
JA
1245}
1246
ebac4655
JA
1247int parse_options(int argc, char *argv[])
1248{
972cfd25
JA
1249 int job_files, i;
1250
b4692828
JA
1251 f_out = stdout;
1252 f_err = stderr;
1253
2d7760d1
JA
1254 log_info("%s\n", fio_version_string);
1255
4c6107ff 1256 fio_options_fill_optstring();
5ec10eaa 1257 fio_options_dup_and_init(l_opts);
b4692828 1258
ebac4655
JA
1259 if (setup_thread_area())
1260 return 1;
1261 if (fill_def_thread())
1262 return 1;
1263
972cfd25 1264 job_files = parse_cmd_line(argc, argv);
ebac4655 1265
972cfd25
JA
1266 for (i = 0; i < job_files; i++) {
1267 if (fill_def_thread())
1268 return 1;
0c7e37a0 1269 if (parse_jobs_ini(ini_file[i], i))
972cfd25 1270 return 1;
88c6ed80 1271 free(ini_file[i]);
972cfd25 1272 }
ebac4655 1273
88c6ed80 1274 free(ini_file);
d23bb327 1275 options_mem_free(&def_thread);
b4692828
JA
1276
1277 if (!thread_number) {
cca73aa7
JA
1278 if (dump_cmdline)
1279 return 0;
07b3232d
JA
1280 if (exec_profile)
1281 return 0;
cca73aa7 1282
03e20d68 1283 log_err("No jobs(s) defined\n\n");
45378b35 1284 usage(argv[0]);
b4692828
JA
1285 return 1;
1286 }
1287
be4ecfdf
JA
1288 if (def_thread.o.gtod_offload) {
1289 fio_gtod_init();
1290 fio_gtod_offload = 1;
1291 fio_gtod_cpu = def_thread.o.gtod_cpu;
1292 }
1293
ebac4655
JA
1294 return 0;
1295}