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