Only do math on known keywords
[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 <getopt.h>
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"
18#include "parse.h"
19#include "smalloc.h"
20#include "filehash.h"
21#include "verify.h"
22
23static char fio_version_string[] = "fio 1.35";
24
25#define FIO_RANDSEED (0xb1899bedUL)
26
27static char **ini_file;
28static int max_jobs = MAX_JOBS;
29static int dump_cmdline;
30
31static struct thread_data def_thread;
32struct thread_data *threads = NULL;
33
34int exitall_on_terminate = 0;
35int terse_output = 0;
36int eta_print;
37unsigned long long mlock_size = 0;
38FILE *f_out = NULL;
39FILE *f_err = NULL;
40char *job_section = NULL;
41
42int write_bw_log = 0;
43int read_only = 0;
44
45static int def_timeout;
46static int write_lat_log;
47
48static int prev_group_jobs;
49
50unsigned long fio_debug = 0;
51unsigned int fio_debug_jobno = -1;
52unsigned int *fio_debug_jobp = NULL;
53
54/*
55 * Command line options. These will contain the above, plus a few
56 * extra that only pertain to fio itself and not jobs.
57 */
58static struct option l_opts[FIO_NR_OPTIONS] = {
59 {
60 .name = "output",
61 .has_arg = required_argument,
62 .val = 'o',
63 },
64 {
65 .name = "timeout",
66 .has_arg = required_argument,
67 .val = 't',
68 },
69 {
70 .name = "latency-log",
71 .has_arg = required_argument,
72 .val = 'l',
73 },
74 {
75 .name = "bandwidth-log",
76 .has_arg = required_argument,
77 .val = 'b',
78 },
79 {
80 .name = "minimal",
81 .has_arg = optional_argument,
82 .val = 'm',
83 },
84 {
85 .name = "version",
86 .has_arg = no_argument,
87 .val = 'v',
88 },
89 {
90 .name = "help",
91 .has_arg = no_argument,
92 .val = 'h',
93 },
94 {
95 .name = "cmdhelp",
96 .has_arg = optional_argument,
97 .val = 'c',
98 },
99 {
100 .name = "showcmd",
101 .has_arg = no_argument,
102 .val = 's',
103 },
104 {
105 .name = "readonly",
106 .has_arg = no_argument,
107 .val = 'r',
108 },
109 {
110 .name = "eta",
111 .has_arg = required_argument,
112 .val = 'e',
113 },
114 {
115 .name = "debug",
116 .has_arg = required_argument,
117 .val = 'd',
118 },
119 {
120 .name = "section",
121 .has_arg = required_argument,
122 .val = 'x',
123 },
124 {
125 .name = "alloc-size",
126 .has_arg = required_argument,
127 .val = 'a',
128 },
129 {
130 .name = NULL,
131 },
132};
133
134FILE *get_f_out()
135{
136 return f_out;
137}
138
139FILE *get_f_err()
140{
141 return f_err;
142}
143
144/*
145 * Return a free job structure.
146 */
147static struct thread_data *get_new_job(int global, struct thread_data *parent)
148{
149 struct thread_data *td;
150
151 if (global)
152 return &def_thread;
153 if (thread_number >= max_jobs)
154 return NULL;
155
156 td = &threads[thread_number++];
157 *td = *parent;
158
159 dup_files(td, parent);
160 options_mem_dupe(td);
161
162 td->thread_number = thread_number;
163 return td;
164}
165
166static void put_job(struct thread_data *td)
167{
168 if (td == &def_thread)
169 return;
170
171 if (td->error)
172 log_info("fio: %s\n", td->verror);
173
174 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
175 thread_number--;
176}
177
178static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
179{
180 unsigned int bs = td->o.min_bs[ddir];
181 unsigned long long rate;
182 unsigned long ios_per_msec;
183
184 if (td->o.rate[ddir]) {
185 rate = td->o.rate[ddir];
186 ios_per_msec = (rate * 1000LL) / bs;
187 } else
188 ios_per_msec = td->o.rate_iops[ddir] * 1000UL;
189
190 if (!ios_per_msec) {
191 log_err("rate lower than supported\n");
192 return -1;
193 }
194
195 td->rate_usec_cycle[ddir] = 1000000000ULL / ios_per_msec;
196 td->rate_pending_usleep[ddir] = 0;
197 return 0;
198}
199
200static int setup_rate(struct thread_data *td)
201{
202 int ret = 0;
203
204 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
205 ret = __setup_rate(td, DDIR_READ);
206 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
207 ret |= __setup_rate(td, DDIR_WRITE);
208
209 return ret;
210}
211
212static int fixed_block_size(struct thread_options *o)
213{
214 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
215 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
216 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
217}
218
219/*
220 * Lazy way of fixing up options that depend on each other. We could also
221 * define option callback handlers, but this is easier.
222 */
223static int fixup_options(struct thread_data *td)
224{
225 struct thread_options *o = &td->o;
226
227#ifndef FIO_HAVE_PSHARED_MUTEX
228 if (!td->o.use_thread) {
229 log_info("fio: this platform does not support process shared"
230 " mutexes, forcing use of threads. Use the 'thread'"
231 " option to get rid of this warning.\n");
232 td->o.use_thread = 1;
233 }
234#endif
235
236 if (o->write_iolog_file && o->read_iolog_file) {
237 log_err("fio: read iolog overrides write_iolog\n");
238 free(o->write_iolog_file);
239 o->write_iolog_file = NULL;
240 }
241
242 /*
243 * only really works for sequential io for now, and with 1 file
244 */
245 if (o->zone_size && td_random(td) && o->open_files == 1)
246 o->zone_size = 0;
247
248 /*
249 * Reads can do overwrites, we always need to pre-create the file
250 */
251 if (td_read(td) || td_rw(td))
252 o->overwrite = 1;
253
254 if (!o->min_bs[DDIR_READ])
255 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
256 if (!o->max_bs[DDIR_READ])
257 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
258 if (!o->min_bs[DDIR_WRITE])
259 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
260 if (!o->max_bs[DDIR_WRITE])
261 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
262
263 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
264
265 /*
266 * For random IO, allow blockalign offset other than min_bs.
267 */
268 if (!o->ba[DDIR_READ] || !td_random(td))
269 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
270 if (!o->ba[DDIR_WRITE] || !td_random(td))
271 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
272
273 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
274 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
275 !td->o.norandommap) {
276 log_err("fio: Any use of blockalign= turns off randommap\n");
277 td->o.norandommap = 1;
278 }
279
280 if (!o->file_size_high)
281 o->file_size_high = o->file_size_low;
282
283 if (o->norandommap && o->verify != VERIFY_NONE
284 && !fixed_block_size(o)) {
285 log_err("fio: norandommap given for variable block sizes, "
286 "verify disabled\n");
287 o->verify = VERIFY_NONE;
288 }
289 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
290 log_err("fio: bs_unaligned may not work with raw io\n");
291
292 /*
293 * thinktime_spin must be less than thinktime
294 */
295 if (o->thinktime_spin > o->thinktime)
296 o->thinktime_spin = o->thinktime;
297
298 /*
299 * The low water mark cannot be bigger than the iodepth
300 */
301 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
302 /*
303 * syslet work around - if the workload is sequential,
304 * we want to let the queue drain all the way down to
305 * avoid seeking between async threads
306 */
307 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
308 o->iodepth_low = 1;
309 else
310 o->iodepth_low = o->iodepth;
311 }
312
313 /*
314 * If batch number isn't set, default to the same as iodepth
315 */
316 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
317 o->iodepth_batch = o->iodepth;
318
319 if (o->nr_files > td->files_index)
320 o->nr_files = td->files_index;
321
322 if (o->open_files > o->nr_files || !o->open_files)
323 o->open_files = o->nr_files;
324
325 if (((o->rate[0] + o->rate[1]) && (o->rate_iops[0] + o->rate_iops[1]))||
326 ((o->ratemin[0] + o->ratemin[1]) && (o->rate_iops_min[0] +
327 o->rate_iops_min[1]))) {
328 log_err("fio: rate and rate_iops are mutually exclusive\n");
329 return 1;
330 }
331 if ((o->rate[0] < o->ratemin[0]) || (o->rate[1] < o->ratemin[1]) ||
332 (o->rate_iops[0] < o->rate_iops_min[0]) ||
333 (o->rate_iops[1] < o->rate_iops_min[1])) {
334 log_err("fio: minimum rate exceeds rate\n");
335 return 1;
336 }
337
338 if (!o->timeout && o->time_based) {
339 log_err("fio: time_based requires a runtime/timeout setting\n");
340 o->time_based = 0;
341 }
342
343 if (o->fill_device && !o->size)
344 o->size = -1ULL;
345
346 if (td_rw(td) && td->o.verify != VERIFY_NONE)
347 log_info("fio: mixed read/write workload with verify. May not "
348 "work as expected, unless you pre-populated the file\n");
349
350 if (td->o.verify != VERIFY_NONE)
351 td->o.refill_buffers = 1;
352
353 if (td->o.pre_read) {
354 td->o.invalidate_cache = 0;
355 if (td->io_ops->flags & FIO_PIPEIO)
356 log_info("fio: cannot pre-read files with an IO engine"
357 " that isn't seekable. Pre-read disabled.\n");
358 }
359
360 return 0;
361}
362
363/*
364 * This function leaks the buffer
365 */
366static char *to_kmg(unsigned int val)
367{
368 char *buf = malloc(32);
369 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
370 char *p = post;
371
372 do {
373 if (val & 1023)
374 break;
375
376 val >>= 10;
377 p++;
378 } while (*p);
379
380 snprintf(buf, 31, "%u%c", val, *p);
381 return buf;
382}
383
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
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
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
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{
437 int fd;
438
439 fd = open("/dev/urandom", O_RDONLY);
440 if (fd == -1) {
441 td_verror(td, errno, "open");
442 return 1;
443 }
444
445 if (read(fd, td->rand_seeds, sizeof(td->rand_seeds)) <
446 (int) sizeof(td->rand_seeds)) {
447 td_verror(td, EIO, "read");
448 close(fd);
449 return 1;
450 }
451
452 close(fd);
453 td_fill_rand_seeds(td);
454 return 0;
455}
456
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 */
462static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
463{
464 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
465 "randread", "randwrite", "randrw" };
466 unsigned int i;
467 const char *engine;
468 char fname[PATH_MAX];
469 int numjobs, file_alloced;
470
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
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
485 engine = get_engine_name(td->o.ioengine);
486 td->io_ops = load_ioengine(td, engine);
487 if (!td->io_ops) {
488 log_err("fio: failed to load engine %s\n", engine);
489 goto err;
490 }
491
492 if (td->o.use_thread)
493 nr_thread++;
494 else
495 nr_process++;
496
497 if (td->o.odirect)
498 td->io_ops->flags |= FIO_RAWIO;
499
500 file_alloced = 0;
501 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
502 file_alloced = 1;
503
504 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
505 add_file(td, jobname);
506 else {
507 for (i = 0; i < td->o.nr_files; i++) {
508 sprintf(fname, "%s.%d.%d", jobname,
509 td->thread_number, i);
510 add_file(td, fname);
511 }
512 }
513 }
514
515 if (fixup_options(td))
516 goto err;
517
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
525 td->mutex = fio_mutex_init(0);
526
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;
530 td->ddir_nr = td->o.ddir_nr;
531
532 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
533 prev_group_jobs = 0;
534 groupid++;
535 }
536
537 td->groupid = groupid;
538 prev_group_jobs++;
539
540 if (init_random_state(td))
541 goto err;
542
543 if (setup_rate(td))
544 goto err;
545
546 if (td->o.write_lat_log) {
547 setup_log(&td->ts.slat_log);
548 setup_log(&td->ts.clat_log);
549 }
550 if (td->o.write_bw_log)
551 setup_log(&td->ts.bw_log);
552
553 if (!td->o.name)
554 td->o.name = strdup(jobname);
555
556 if (!terse_output) {
557 if (!job_add_num) {
558 if (!strcmp(td->io_ops->name, "cpuio")) {
559 log_info("%s: ioengine=cpu, cpuload=%u,"
560 " cpucycle=%u\n", td->o.name,
561 td->o.cpuload,
562 td->o.cpucycle);
563 } else {
564 char *c1, *c2, *c3, *c4;
565
566 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
567 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
568 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
569 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
570
571 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
572 " ioengine=%s, iodepth=%u\n",
573 td->o.name, td->groupid,
574 ddir_str[td->o.td_ddir],
575 c1, c2, c3, c4,
576 td->io_ops->name,
577 td->o.iodepth);
578
579 free(c1);
580 free(c2);
581 free(c3);
582 free(c4);
583 }
584 } else if (job_add_num == 1)
585 log_info("...\n");
586 }
587
588 /*
589 * recurse add identical jobs, clear numjobs and stonewall options
590 * as they don't apply to sub-jobs
591 */
592 numjobs = td->o.numjobs;
593 while (--numjobs) {
594 struct thread_data *td_new = get_new_job(0, td);
595
596 if (!td_new)
597 goto err;
598
599 td_new->o.numjobs = 1;
600 td_new->o.stonewall = 0;
601 td_new->o.new_group = 0;
602
603 if (file_alloced) {
604 td_new->o.filename = NULL;
605 td_new->files_index = 0;
606 td_new->files_size = 0;
607 td_new->files = NULL;
608 }
609
610 job_add_num = numjobs - 1;
611
612 if (add_job(td_new, jobname, job_add_num))
613 goto err;
614 }
615
616 return 0;
617err:
618 put_job(td);
619 return -1;
620}
621
622static int skip_this_section(const char *name)
623{
624 if (!job_section)
625 return 0;
626 if (!strncmp(name, "global", 6))
627 return 0;
628
629 return strcmp(job_section, name);
630}
631
632static int is_empty_or_comment(char *line)
633{
634 unsigned int i;
635
636 for (i = 0; i < strlen(line); i++) {
637 if (line[i] == ';')
638 return 1;
639 if (line[i] == '#')
640 return 1;
641 if (!isspace(line[i]) && !iscntrl(line[i]))
642 return 0;
643 }
644
645 return 1;
646}
647
648/*
649 * This is our [ini] type file parser.
650 */
651static int parse_jobs_ini(char *file, int stonewall_flag)
652{
653 unsigned int global;
654 struct thread_data *td;
655 char *string, *name;
656 FILE *f;
657 char *p;
658 int ret = 0, stonewall;
659 int first_sect = 1;
660 int skip_fgets = 0;
661 int inside_skip = 0;
662 char **opts;
663 int i, alloc_opts, num_opts;
664
665 if (!strcmp(file, "-"))
666 f = stdin;
667 else
668 f = fopen(file, "r");
669
670 if (!f) {
671 perror("fopen job file");
672 return 1;
673 }
674
675 string = malloc(4096);
676
677 /*
678 * it's really 256 + small bit, 280 should suffice
679 */
680 name = malloc(280);
681 memset(name, 0, 280);
682
683 alloc_opts = 8;
684 opts = malloc(sizeof(char *) * alloc_opts);
685 num_opts = 0;
686
687 stonewall = stonewall_flag;
688 do {
689 /*
690 * if skip_fgets is set, we already have loaded a line we
691 * haven't handled.
692 */
693 if (!skip_fgets) {
694 p = fgets(string, 4095, f);
695 if (!p)
696 break;
697 }
698
699 skip_fgets = 0;
700 strip_blank_front(&p);
701 strip_blank_end(p);
702
703 if (is_empty_or_comment(p))
704 continue;
705 if (sscanf(p, "[%255s]", name) != 1) {
706 if (inside_skip)
707 continue;
708 log_err("fio: option <%s> outside of [] job section\n",
709 p);
710 break;
711 }
712
713 if (skip_this_section(name)) {
714 inside_skip = 1;
715 continue;
716 } else
717 inside_skip = 0;
718
719 global = !strncmp(name, "global", 6);
720
721 name[strlen(name) - 1] = '\0';
722
723 if (dump_cmdline) {
724 if (first_sect)
725 log_info("fio ");
726 if (!global)
727 log_info("--name=%s ", name);
728 first_sect = 0;
729 }
730
731 td = get_new_job(global, &def_thread);
732 if (!td) {
733 ret = 1;
734 break;
735 }
736
737 /*
738 * Seperate multiple job files by a stonewall
739 */
740 if (!global && stonewall) {
741 td->o.stonewall = stonewall;
742 stonewall = 0;
743 }
744
745 num_opts = 0;
746 memset(opts, 0, alloc_opts * sizeof(char *));
747
748 while ((p = fgets(string, 4096, f)) != NULL) {
749 if (is_empty_or_comment(p))
750 continue;
751
752 strip_blank_front(&p);
753
754 /*
755 * new section, break out and make sure we don't
756 * fgets() a new line at the top.
757 */
758 if (p[0] == '[') {
759 skip_fgets = 1;
760 break;
761 }
762
763 strip_blank_end(p);
764
765 if (num_opts == alloc_opts) {
766 alloc_opts <<= 1;
767 opts = realloc(opts,
768 alloc_opts * sizeof(char *));
769 }
770
771 opts[num_opts] = strdup(p);
772 num_opts++;
773 }
774
775 ret = fio_options_parse(td, opts, num_opts);
776 if (!ret) {
777 if (dump_cmdline)
778 for (i = 0; i < num_opts; i++)
779 log_info("--%s ", opts[i]);
780
781 ret = add_job(td, name, 0);
782 } else {
783 log_err("fio: job %s dropped\n", name);
784 put_job(td);
785 }
786
787 for (i = 0; i < num_opts; i++)
788 free(opts[i]);
789 num_opts = 0;
790 } while (!ret);
791
792 if (dump_cmdline)
793 log_info("\n");
794
795 for (i = 0; i < num_opts; i++)
796 free(opts[i]);
797
798 free(string);
799 free(name);
800 free(opts);
801 if (f != stdin)
802 fclose(f);
803 return ret;
804}
805
806static int fill_def_thread(void)
807{
808 memset(&def_thread, 0, sizeof(def_thread));
809
810 fio_getaffinity(getpid(), &def_thread.o.cpumask);
811
812 /*
813 * fill default options
814 */
815 fio_fill_default_options(&def_thread);
816
817 def_thread.o.timeout = def_timeout;
818 def_thread.o.write_bw_log = write_bw_log;
819 def_thread.o.write_lat_log = write_lat_log;
820
821 return 0;
822}
823
824static void free_shm(void)
825{
826 struct shmid_ds sbuf;
827
828 if (threads) {
829 void *tp = threads;
830
831 threads = NULL;
832 file_hash_exit();
833 fio_debug_jobp = NULL;
834 shmdt(tp);
835 shmctl(shm_id, IPC_RMID, &sbuf);
836 }
837
838 scleanup();
839}
840
841/*
842 * The thread area is shared between the main process and the job
843 * threads/processes. So setup a shared memory segment that will hold
844 * all the job info. We use the end of the region for keeping track of
845 * open files across jobs, for file sharing.
846 */
847static int setup_thread_area(void)
848{
849 void *hash;
850
851 /*
852 * 1024 is too much on some machines, scale max_jobs if
853 * we get a failure that looks like too large a shm segment
854 */
855 do {
856 size_t size = max_jobs * sizeof(struct thread_data);
857
858 size += file_hash_size;
859 size += sizeof(unsigned int);
860
861 shm_id = shmget(0, size, IPC_CREAT | 0600);
862 if (shm_id != -1)
863 break;
864 if (errno != EINVAL) {
865 perror("shmget");
866 break;
867 }
868
869 max_jobs >>= 1;
870 } while (max_jobs);
871
872 if (shm_id == -1)
873 return 1;
874
875 threads = shmat(shm_id, NULL, 0);
876 if (threads == (void *) -1) {
877 perror("shmat");
878 return 1;
879 }
880
881 memset(threads, 0, max_jobs * sizeof(struct thread_data));
882 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
883 fio_debug_jobp = (void *) hash + file_hash_size;
884 *fio_debug_jobp = -1;
885 file_hash_init(hash);
886 atexit(free_shm);
887 return 0;
888}
889
890static void usage(const char *name)
891{
892 printf("%s\n", fio_version_string);
893 printf("%s [options] [job options] <job file(s)>\n", name);
894 printf("\t--debug=options\tEnable debug logging\n");
895 printf("\t--output\tWrite output to file\n");
896 printf("\t--timeout\tRuntime in seconds\n");
897 printf("\t--latency-log\tGenerate per-job latency logs\n");
898 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
899 printf("\t--minimal\tMinimal (terse) output\n");
900 printf("\t--version\tPrint version info and exit\n");
901 printf("\t--help\t\tPrint this page\n");
902 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of"
903 " them\n");
904 printf("\t--showcmd\tTurn a job file into command line options\n");
905 printf("\t--eta=when\tWhen ETA estimate should be printed\n");
906 printf("\t \tMay be \"always\", \"never\" or \"auto\"\n");
907 printf("\t--readonly\tTurn on safety read-only checks, preventing"
908 " writes\n");
909 printf("\t--section=name\tOnly run specified section in job file\n");
910 printf("\t--alloc-size=kb\tSet smalloc pool to this size in kb"
911 " (def 1024)\n");
912 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>\n");
913}
914
915#ifdef FIO_INC_DEBUG
916struct debug_level debug_levels[] = {
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 },
923 { .name = "random", .shift = FD_RANDOM },
924 { .name = "parse", .shift = FD_PARSE },
925 { .name = "diskutil", .shift = FD_DISKUTIL },
926 { .name = "job", .shift = FD_JOB },
927 { .name = "mutex", .shift = FD_MUTEX },
928 { .name = NULL, },
929};
930
931static int set_debug(const char *string)
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 }
946 log_info("all\n");
947 return 1;
948 }
949
950 while ((opt = strsep(&p, ",")) != NULL) {
951 int found = 0;
952
953 if (!strncmp(opt, "all", 3)) {
954 log_info("fio: set all debug options\n");
955 fio_debug = ~0UL;
956 continue;
957 }
958
959 for (i = 0; debug_levels[i].name; i++) {
960 dl = &debug_levels[i];
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 {
976 log_info("fio: set debug option %s\n", opt);
977 fio_debug |= (1UL << dl->shift);
978 }
979 break;
980 }
981
982 if (!found)
983 log_err("fio: debug mask %s not found\n", opt);
984 }
985 return 0;
986}
987#else
988static int set_debug(const char *string)
989{
990 log_err("fio: debug tracing not included in build\n");
991 return 1;
992}
993#endif
994
995static int parse_cmd_line(int argc, char *argv[])
996{
997 struct thread_data *td = NULL;
998 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
999
1000 while ((c = getopt_long_only(argc, argv, "", l_opts, &lidx)) != -1) {
1001 switch (c) {
1002 case 'a':
1003 smalloc_pool_size = atoi(optarg);
1004 break;
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':
1026 usage(argv[0]);
1027 exit(0);
1028 case 'c':
1029 exit(fio_show_option_help(optarg));
1030 case 's':
1031 dump_cmdline = 1;
1032 break;
1033 case 'r':
1034 read_only = 1;
1035 break;
1036 case 'v':
1037 printf("%s\n", fio_version_string);
1038 exit(0);
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;
1045 case 'd':
1046 if (set_debug(optarg))
1047 do_exit++;
1048 break;
1049 case 'x':
1050 if (!strcmp(optarg, "global")) {
1051 log_err("fio: can't use global as only "
1052 "section\n");
1053 do_exit++;
1054 exit_val = 1;
1055 break;
1056 }
1057 if (job_section)
1058 free(job_section);
1059 job_section = strdup(optarg);
1060 break;
1061 case FIO_GETOPT_JOB: {
1062 const char *opt = l_opts[lidx].name;
1063 char *val = optarg;
1064
1065 if (!strncmp(opt, "name", 4) && td) {
1066 ret = add_job(td, td->o.name ?: "fio", 0);
1067 if (ret) {
1068 put_job(td);
1069 return 0;
1070 }
1071 td = NULL;
1072 }
1073 if (!td) {
1074 int is_section = !strncmp(opt, "name", 4);
1075 int global = 0;
1076
1077 if (!is_section || !strncmp(val, "global", 6))
1078 global = 1;
1079
1080 if (is_section && skip_this_section(val))
1081 continue;
1082
1083 td = get_new_job(global, &def_thread);
1084 if (!td)
1085 return 0;
1086 }
1087
1088 ret = fio_cmd_option_parse(td, opt, val);
1089 break;
1090 }
1091 default:
1092 do_exit++;
1093 exit_val = 1;
1094 break;
1095 }
1096 }
1097
1098 if (do_exit)
1099 exit(exit_val);
1100
1101 if (td) {
1102 if (!ret)
1103 ret = add_job(td, td->o.name ?: "fio", 0);
1104 if (ret)
1105 put_job(td);
1106 }
1107
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++;
1113 }
1114
1115 return ini_idx;
1116}
1117
1118int parse_options(int argc, char *argv[])
1119{
1120 int job_files, i;
1121
1122 f_out = stdout;
1123 f_err = stderr;
1124
1125 fio_options_dup_and_init(l_opts);
1126
1127 if (setup_thread_area())
1128 return 1;
1129 if (fill_def_thread())
1130 return 1;
1131
1132 job_files = parse_cmd_line(argc, argv);
1133
1134 for (i = 0; i < job_files; i++) {
1135 if (fill_def_thread())
1136 return 1;
1137 if (parse_jobs_ini(ini_file[i], i))
1138 return 1;
1139 free(ini_file[i]);
1140 }
1141
1142 free(ini_file);
1143 options_mem_free(&def_thread);
1144
1145 if (!thread_number) {
1146 if (dump_cmdline)
1147 return 0;
1148
1149 log_err("No jobs defined(s)\n\n");
1150 usage(argv[0]);
1151 return 1;
1152 }
1153
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
1160 return 0;
1161}