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