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