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