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