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