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