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