verify: Reset verify_state before verification phase.
[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/types.h>
13#include <sys/stat.h>
14
15#include "fio.h"
16#ifndef FIO_NO_HAVE_SHM_H
17#include <sys/shm.h>
18#endif
19
20#include "parse.h"
21#include "smalloc.h"
22#include "filehash.h"
23#include "verify.h"
24#include "profile.h"
25#include "server.h"
26#include "idletime.h"
27#include "filelock.h"
28
29#include "oslib/getopt.h"
30#include "oslib/strcasestr.h"
31
32#include "crc/test.h"
33
34const char fio_version_string[] = FIO_VERSION;
35
36#define FIO_RANDSEED (0xb1899bedUL)
37
38static char **ini_file;
39static int max_jobs = FIO_MAX_JOBS;
40static int dump_cmdline;
41static long long def_timeout;
42static int parse_only;
43
44static struct thread_data def_thread;
45struct thread_data *threads = NULL;
46static char **job_sections;
47static int nr_job_sections;
48
49int exitall_on_terminate = 0;
50int exitall_on_terminate_error = 0;
51int output_format = FIO_OUTPUT_NORMAL;
52int eta_print = FIO_ETA_AUTO;
53int eta_new_line = 0;
54FILE *f_out = NULL;
55FILE *f_err = NULL;
56char *exec_profile = NULL;
57int warnings_fatal = 0;
58int terse_version = 3;
59int is_backend = 0;
60int nr_clients = 0;
61int log_syslog = 0;
62
63int write_bw_log = 0;
64int read_only = 0;
65int status_interval = 0;
66
67char *trigger_file = NULL;
68long long trigger_timeout = 0;
69char *trigger_cmd = NULL;
70char *trigger_remote_cmd = NULL;
71
72char *aux_path = NULL;
73
74static int prev_group_jobs;
75
76unsigned long fio_debug = 0;
77unsigned int fio_debug_jobno = -1;
78unsigned int *fio_debug_jobp = NULL;
79
80static char cmd_optstr[256];
81static int did_arg;
82
83#define FIO_CLIENT_FLAG (1 << 16)
84
85/*
86 * Command line options. These will contain the above, plus a few
87 * extra that only pertain to fio itself and not jobs.
88 */
89static struct option l_opts[FIO_NR_OPTIONS] = {
90 {
91 .name = (char *) "output",
92 .has_arg = required_argument,
93 .val = 'o' | FIO_CLIENT_FLAG,
94 },
95 {
96 .name = (char *) "timeout",
97 .has_arg = required_argument,
98 .val = 't' | FIO_CLIENT_FLAG,
99 },
100 {
101 .name = (char *) "latency-log",
102 .has_arg = required_argument,
103 .val = 'l' | FIO_CLIENT_FLAG,
104 },
105 {
106 .name = (char *) "bandwidth-log",
107 .has_arg = required_argument,
108 .val = 'b' | FIO_CLIENT_FLAG,
109 },
110 {
111 .name = (char *) "minimal",
112 .has_arg = no_argument,
113 .val = 'm' | FIO_CLIENT_FLAG,
114 },
115 {
116 .name = (char *) "output-format",
117 .has_arg = optional_argument,
118 .val = 'F' | FIO_CLIENT_FLAG,
119 },
120 {
121 .name = (char *) "append-terse",
122 .has_arg = optional_argument,
123 .val = 'f',
124 },
125 {
126 .name = (char *) "version",
127 .has_arg = no_argument,
128 .val = 'v' | FIO_CLIENT_FLAG,
129 },
130 {
131 .name = (char *) "help",
132 .has_arg = no_argument,
133 .val = 'h' | FIO_CLIENT_FLAG,
134 },
135 {
136 .name = (char *) "cmdhelp",
137 .has_arg = optional_argument,
138 .val = 'c' | FIO_CLIENT_FLAG,
139 },
140 {
141 .name = (char *) "enghelp",
142 .has_arg = optional_argument,
143 .val = 'i' | FIO_CLIENT_FLAG,
144 },
145 {
146 .name = (char *) "showcmd",
147 .has_arg = no_argument,
148 .val = 's' | FIO_CLIENT_FLAG,
149 },
150 {
151 .name = (char *) "readonly",
152 .has_arg = no_argument,
153 .val = 'r' | FIO_CLIENT_FLAG,
154 },
155 {
156 .name = (char *) "eta",
157 .has_arg = required_argument,
158 .val = 'e' | FIO_CLIENT_FLAG,
159 },
160 {
161 .name = (char *) "eta-newline",
162 .has_arg = required_argument,
163 .val = 'E' | FIO_CLIENT_FLAG,
164 },
165 {
166 .name = (char *) "debug",
167 .has_arg = required_argument,
168 .val = 'd' | FIO_CLIENT_FLAG,
169 },
170 {
171 .name = (char *) "parse-only",
172 .has_arg = no_argument,
173 .val = 'P' | FIO_CLIENT_FLAG,
174 },
175 {
176 .name = (char *) "section",
177 .has_arg = required_argument,
178 .val = 'x' | FIO_CLIENT_FLAG,
179 },
180#ifdef CONFIG_ZLIB
181 {
182 .name = (char *) "inflate-log",
183 .has_arg = required_argument,
184 .val = 'X' | FIO_CLIENT_FLAG,
185 },
186#endif
187 {
188 .name = (char *) "alloc-size",
189 .has_arg = required_argument,
190 .val = 'a' | FIO_CLIENT_FLAG,
191 },
192 {
193 .name = (char *) "profile",
194 .has_arg = required_argument,
195 .val = 'p' | FIO_CLIENT_FLAG,
196 },
197 {
198 .name = (char *) "warnings-fatal",
199 .has_arg = no_argument,
200 .val = 'w' | FIO_CLIENT_FLAG,
201 },
202 {
203 .name = (char *) "max-jobs",
204 .has_arg = required_argument,
205 .val = 'j' | FIO_CLIENT_FLAG,
206 },
207 {
208 .name = (char *) "terse-version",
209 .has_arg = required_argument,
210 .val = 'V' | FIO_CLIENT_FLAG,
211 },
212 {
213 .name = (char *) "server",
214 .has_arg = optional_argument,
215 .val = 'S',
216 },
217 { .name = (char *) "daemonize",
218 .has_arg = required_argument,
219 .val = 'D',
220 },
221 {
222 .name = (char *) "client",
223 .has_arg = required_argument,
224 .val = 'C',
225 },
226 {
227 .name = (char *) "remote-config",
228 .has_arg = required_argument,
229 .val = 'R',
230 },
231 {
232 .name = (char *) "cpuclock-test",
233 .has_arg = no_argument,
234 .val = 'T',
235 },
236 {
237 .name = (char *) "crctest",
238 .has_arg = optional_argument,
239 .val = 'G',
240 },
241 {
242 .name = (char *) "idle-prof",
243 .has_arg = required_argument,
244 .val = 'I',
245 },
246 {
247 .name = (char *) "status-interval",
248 .has_arg = required_argument,
249 .val = 'L',
250 },
251 {
252 .name = (char *) "trigger-file",
253 .has_arg = required_argument,
254 .val = 'W',
255 },
256 {
257 .name = (char *) "trigger-timeout",
258 .has_arg = required_argument,
259 .val = 'B',
260 },
261 {
262 .name = (char *) "trigger",
263 .has_arg = required_argument,
264 .val = 'H',
265 },
266 {
267 .name = (char *) "trigger-remote",
268 .has_arg = required_argument,
269 .val = 'J',
270 },
271 {
272 .name = (char *) "aux-path",
273 .has_arg = required_argument,
274 .val = 'K',
275 },
276 {
277 .name = NULL,
278 },
279};
280
281void free_threads_shm(void)
282{
283 if (threads) {
284 void *tp = threads;
285#ifndef CONFIG_NO_SHM
286 struct shmid_ds sbuf;
287
288 threads = NULL;
289 shmdt(tp);
290 shmctl(shm_id, IPC_RMID, &sbuf);
291 shm_id = -1;
292#else
293 threads = NULL;
294 free(tp);
295#endif
296 }
297}
298
299static void free_shm(void)
300{
301 if (threads) {
302 file_hash_exit();
303 flow_exit();
304 fio_debug_jobp = NULL;
305 free_threads_shm();
306 }
307
308 free(trigger_file);
309 free(trigger_cmd);
310 free(trigger_remote_cmd);
311 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
312
313 options_free(fio_options, &def_thread);
314 fio_filelock_exit();
315 scleanup();
316}
317
318/*
319 * The thread area is shared between the main process and the job
320 * threads/processes. So setup a shared memory segment that will hold
321 * all the job info. We use the end of the region for keeping track of
322 * open files across jobs, for file sharing.
323 */
324static int setup_thread_area(void)
325{
326 void *hash;
327
328 if (threads)
329 return 0;
330
331 /*
332 * 1024 is too much on some machines, scale max_jobs if
333 * we get a failure that looks like too large a shm segment
334 */
335 do {
336 size_t size = max_jobs * sizeof(struct thread_data);
337
338 size += file_hash_size;
339 size += sizeof(unsigned int);
340
341#ifndef CONFIG_NO_SHM
342 shm_id = shmget(0, size, IPC_CREAT | 0600);
343 if (shm_id != -1)
344 break;
345 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
346 perror("shmget");
347 break;
348 }
349#else
350 threads = malloc(size);
351 if (threads)
352 break;
353#endif
354
355 max_jobs >>= 1;
356 } while (max_jobs);
357
358#ifndef CONFIG_NO_SHM
359 if (shm_id == -1)
360 return 1;
361
362 threads = shmat(shm_id, NULL, 0);
363 if (threads == (void *) -1) {
364 perror("shmat");
365 return 1;
366 }
367#endif
368
369 memset(threads, 0, max_jobs * sizeof(struct thread_data));
370 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
371 fio_debug_jobp = (void *) hash + file_hash_size;
372 *fio_debug_jobp = -1;
373 file_hash_init(hash);
374
375 flow_init();
376
377 return 0;
378}
379
380static void set_cmd_options(struct thread_data *td)
381{
382 struct thread_options *o = &td->o;
383
384 if (!o->timeout)
385 o->timeout = def_timeout;
386}
387
388static void dump_print_option(struct print_option *p)
389{
390 const char *delim;
391
392 if (!strcmp("description", p->name))
393 delim = "\"";
394 else
395 delim = "";
396
397 log_info("--%s%s", p->name, p->value ? "" : " ");
398 if (p->value)
399 log_info("=%s%s%s ", delim, p->value, delim);
400}
401
402static void dump_opt_list(struct thread_data *td)
403{
404 struct flist_head *entry;
405 struct print_option *p;
406
407 if (flist_empty(&td->opt_list))
408 return;
409
410 flist_for_each(entry, &td->opt_list) {
411 p = flist_entry(entry, struct print_option, list);
412 dump_print_option(p);
413 }
414}
415
416static void fio_dump_options_free(struct thread_data *td)
417{
418 while (!flist_empty(&td->opt_list)) {
419 struct print_option *p;
420
421 p = flist_first_entry(&td->opt_list, struct print_option, list);
422 flist_del_init(&p->list);
423 free(p->name);
424 free(p->value);
425 free(p);
426 }
427}
428
429static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
430{
431 struct flist_head *entry;
432
433 if (flist_empty(&src->opt_list))
434 return;
435
436 flist_for_each(entry, &src->opt_list) {
437 struct print_option *srcp, *dstp;
438
439 srcp = flist_entry(entry, struct print_option, list);
440 dstp = malloc(sizeof(*dstp));
441 dstp->name = strdup(srcp->name);
442 if (srcp->value)
443 dstp->value = strdup(srcp->value);
444 else
445 dstp->value = NULL;
446 flist_add_tail(&dstp->list, &dst->opt_list);
447 }
448}
449
450/*
451 * Return a free job structure.
452 */
453static struct thread_data *get_new_job(int global, struct thread_data *parent,
454 int preserve_eo, const char *jobname)
455{
456 struct thread_data *td;
457
458 if (global) {
459 set_cmd_options(&def_thread);
460 return &def_thread;
461 }
462 if (setup_thread_area()) {
463 log_err("error: failed to setup shm segment\n");
464 return NULL;
465 }
466 if (thread_number >= max_jobs) {
467 log_err("error: maximum number of jobs (%d) reached.\n",
468 max_jobs);
469 return NULL;
470 }
471
472 td = &threads[thread_number++];
473 *td = *parent;
474
475 INIT_FLIST_HEAD(&td->opt_list);
476 if (parent != &def_thread)
477 copy_opt_list(td, parent);
478
479 td->io_ops = NULL;
480 if (!preserve_eo)
481 td->eo = NULL;
482
483 td->o.uid = td->o.gid = -1U;
484
485 dup_files(td, parent);
486 fio_options_mem_dupe(td);
487
488 profile_add_hooks(td);
489
490 td->thread_number = thread_number;
491 td->subjob_number = 0;
492
493 if (jobname)
494 td->o.name = strdup(jobname);
495
496 if (!parent->o.group_reporting || parent == &def_thread)
497 stat_number++;
498
499 set_cmd_options(td);
500 return td;
501}
502
503static void put_job(struct thread_data *td)
504{
505 if (td == &def_thread)
506 return;
507
508 profile_td_exit(td);
509 flow_exit_job(td);
510
511 if (td->error)
512 log_info("fio: %s\n", td->verror);
513
514 fio_options_free(td);
515 fio_dump_options_free(td);
516 if (td->io_ops)
517 free_ioengine(td);
518
519 if (td->o.name)
520 free(td->o.name);
521
522 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
523 thread_number--;
524}
525
526static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
527{
528 unsigned int bs = td->o.min_bs[ddir];
529
530 assert(ddir_rw(ddir));
531
532 if (td->o.rate[ddir])
533 td->rate_bps[ddir] = td->o.rate[ddir];
534 else
535 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
536
537 if (!td->rate_bps[ddir]) {
538 log_err("rate lower than supported\n");
539 return -1;
540 }
541
542 td->rate_next_io_time[ddir] = 0;
543 td->rate_io_issue_bytes[ddir] = 0;
544 td->last_usec = 0;
545 return 0;
546}
547
548static int setup_rate(struct thread_data *td)
549{
550 int ret = 0;
551
552 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
553 ret = __setup_rate(td, DDIR_READ);
554 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
555 ret |= __setup_rate(td, DDIR_WRITE);
556 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
557 ret |= __setup_rate(td, DDIR_TRIM);
558
559 return ret;
560}
561
562static int fixed_block_size(struct thread_options *o)
563{
564 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
565 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
566 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
567 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
568 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
569}
570
571
572static unsigned long long get_rand_start_delay(struct thread_data *td)
573{
574 unsigned long long delayrange;
575 uint64_t frand_max;
576 unsigned long r;
577
578 delayrange = td->o.start_delay_high - td->o.start_delay;
579
580 frand_max = rand_max(&td->delay_state);
581 r = __rand(&td->delay_state);
582 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
583
584 delayrange += td->o.start_delay;
585 return delayrange;
586}
587
588/*
589 * Lazy way of fixing up options that depend on each other. We could also
590 * define option callback handlers, but this is easier.
591 */
592static int fixup_options(struct thread_data *td)
593{
594 struct thread_options *o = &td->o;
595 int ret = 0;
596
597#ifndef FIO_HAVE_PSHARED_MUTEX
598 if (!o->use_thread) {
599 log_info("fio: this platform does not support process shared"
600 " mutexes, forcing use of threads. Use the 'thread'"
601 " option to get rid of this warning.\n");
602 o->use_thread = 1;
603 ret = warnings_fatal;
604 }
605#endif
606
607 if (o->write_iolog_file && o->read_iolog_file) {
608 log_err("fio: read iolog overrides write_iolog\n");
609 free(o->write_iolog_file);
610 o->write_iolog_file = NULL;
611 ret = warnings_fatal;
612 }
613
614 /*
615 * only really works with 1 file
616 */
617 if (o->zone_size && o->open_files > 1)
618 o->zone_size = 0;
619
620 /*
621 * If zone_range isn't specified, backward compatibility dictates it
622 * should be made equal to zone_size.
623 */
624 if (o->zone_size && !o->zone_range)
625 o->zone_range = o->zone_size;
626
627 /*
628 * Reads can do overwrites, we always need to pre-create the file
629 */
630 if (td_read(td) || td_rw(td))
631 o->overwrite = 1;
632
633 if (!o->min_bs[DDIR_READ])
634 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
635 if (!o->max_bs[DDIR_READ])
636 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
637 if (!o->min_bs[DDIR_WRITE])
638 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
639 if (!o->max_bs[DDIR_WRITE])
640 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
641 if (!o->min_bs[DDIR_TRIM])
642 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
643 if (!o->max_bs[DDIR_TRIM])
644 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
645
646 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
647 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
648
649 /*
650 * For random IO, allow blockalign offset other than min_bs.
651 */
652 if (!o->ba[DDIR_READ] || !td_random(td))
653 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
654 if (!o->ba[DDIR_WRITE] || !td_random(td))
655 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
656 if (!o->ba[DDIR_TRIM] || !td_random(td))
657 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
658
659 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
660 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
661 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
662 !o->norandommap) {
663 log_err("fio: Any use of blockalign= turns off randommap\n");
664 o->norandommap = 1;
665 ret = warnings_fatal;
666 }
667
668 if (!o->file_size_high)
669 o->file_size_high = o->file_size_low;
670
671 if (o->start_delay_high)
672 o->start_delay = get_rand_start_delay(td);
673
674 if (o->norandommap && o->verify != VERIFY_NONE
675 && !fixed_block_size(o)) {
676 log_err("fio: norandommap given for variable block sizes, "
677 "verify limited\n");
678 ret = warnings_fatal;
679 }
680 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
681 log_err("fio: bs_unaligned may not work with raw io\n");
682
683 /*
684 * thinktime_spin must be less than thinktime
685 */
686 if (o->thinktime_spin > o->thinktime)
687 o->thinktime_spin = o->thinktime;
688
689 /*
690 * The low water mark cannot be bigger than the iodepth
691 */
692 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
693 o->iodepth_low = o->iodepth;
694
695 /*
696 * If batch number isn't set, default to the same as iodepth
697 */
698 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
699 o->iodepth_batch = o->iodepth;
700
701 /*
702 * If max batch complete number isn't set or set incorrectly,
703 * default to the same as iodepth_batch_complete_min
704 */
705 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
706 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
707
708 if (o->nr_files > td->files_index)
709 o->nr_files = td->files_index;
710
711 if (o->open_files > o->nr_files || !o->open_files)
712 o->open_files = o->nr_files;
713
714 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
715 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
716 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
717 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
718 log_err("fio: rate and rate_iops are mutually exclusive\n");
719 ret = 1;
720 }
721 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
722 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
723 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
724 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
725 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
726 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
727 log_err("fio: minimum rate exceeds rate\n");
728 ret = 1;
729 }
730
731 if (!o->timeout && o->time_based) {
732 log_err("fio: time_based requires a runtime/timeout setting\n");
733 o->time_based = 0;
734 ret = warnings_fatal;
735 }
736
737 if (o->fill_device && !o->size)
738 o->size = -1ULL;
739
740 if (o->verify != VERIFY_NONE) {
741 if (td_write(td) && o->do_verify && o->numjobs > 1) {
742 log_info("Multiple writers may overwrite blocks that "
743 "belong to other jobs. This can cause "
744 "verification failures.\n");
745 ret = warnings_fatal;
746 }
747
748 if (!fio_option_is_set(o, refill_buffers))
749 o->refill_buffers = 1;
750
751 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
752 !o->verify_interval)
753 o->verify_interval = o->min_bs[DDIR_WRITE];
754
755 /*
756 * Verify interval must be smaller or equal to the
757 * write size.
758 */
759 if (o->verify_interval > o->min_bs[DDIR_WRITE])
760 o->verify_interval = o->min_bs[DDIR_WRITE];
761 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
762 o->verify_interval = o->min_bs[DDIR_READ];
763 }
764
765 if (o->pre_read) {
766 o->invalidate_cache = 0;
767 if (td->io_ops->flags & FIO_PIPEIO) {
768 log_info("fio: cannot pre-read files with an IO engine"
769 " that isn't seekable. Pre-read disabled.\n");
770 ret = warnings_fatal;
771 }
772 }
773
774 if (!o->unit_base) {
775 if (td->io_ops->flags & FIO_BIT_BASED)
776 o->unit_base = 1;
777 else
778 o->unit_base = 8;
779 }
780
781#ifndef CONFIG_FDATASYNC
782 if (o->fdatasync_blocks) {
783 log_info("fio: this platform does not support fdatasync()"
784 " falling back to using fsync(). Use the 'fsync'"
785 " option instead of 'fdatasync' to get rid of"
786 " this warning\n");
787 o->fsync_blocks = o->fdatasync_blocks;
788 o->fdatasync_blocks = 0;
789 ret = warnings_fatal;
790 }
791#endif
792
793#ifdef WIN32
794 /*
795 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
796 * so fail if we're passed those flags
797 */
798 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
799 log_err("fio: Windows does not support direct or non-buffered io with"
800 " the synchronous ioengines. Use the 'windowsaio' ioengine"
801 " with 'direct=1' and 'iodepth=1' instead.\n");
802 ret = 1;
803 }
804#endif
805
806 /*
807 * For fully compressible data, just zero them at init time.
808 * It's faster than repeatedly filling it. For non-zero
809 * compression, we should have refill_buffers set. Set it, unless
810 * the job file already changed it.
811 */
812 if (o->compress_percentage) {
813 if (o->compress_percentage == 100) {
814 o->zero_buffers = 1;
815 o->compress_percentage = 0;
816 } else if (!fio_option_is_set(o, refill_buffers))
817 o->refill_buffers = 1;
818 }
819
820 /*
821 * Using a non-uniform random distribution excludes usage of
822 * a random map
823 */
824 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
825 td->o.norandommap = 1;
826
827 /*
828 * If size is set but less than the min block size, complain
829 */
830 if (o->size && o->size < td_min_bs(td)) {
831 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
832 ret = 1;
833 }
834
835 /*
836 * O_ATOMIC implies O_DIRECT
837 */
838 if (td->o.oatomic)
839 td->o.odirect = 1;
840
841 /*
842 * If randseed is set, that overrides randrepeat
843 */
844 if (fio_option_is_set(&td->o, rand_seed))
845 td->o.rand_repeatable = 0;
846
847 if ((td->io_ops->flags & FIO_NOEXTEND) && td->o.file_append) {
848 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
849 ret = 1;
850 }
851
852 if (fio_option_is_set(o, gtod_cpu)) {
853 fio_gtod_init();
854 fio_gtod_set_cpu(o->gtod_cpu);
855 fio_gtod_offload = 1;
856 }
857
858 td->loops = o->loops;
859 if (!td->loops)
860 td->loops = 1;
861
862 if (td->o.block_error_hist && td->o.nr_files != 1) {
863 log_err("fio: block error histogram only available with "
864 "with a single file per job, but %d files "
865 "provided\n", td->o.nr_files);
866 ret = 1;
867 }
868
869 return ret;
870}
871
872/*
873 * This function leaks the buffer
874 */
875char *fio_uint_to_kmg(unsigned int val)
876{
877 char *buf = malloc(32);
878 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
879 char *p = post;
880
881 do {
882 if (val & 1023)
883 break;
884
885 val >>= 10;
886 p++;
887 } while (*p);
888
889 snprintf(buf, 32, "%u%c", val, *p);
890 return buf;
891}
892
893/* External engines are specified by "external:name.o") */
894static const char *get_engine_name(const char *str)
895{
896 char *p = strstr(str, ":");
897
898 if (!p)
899 return str;
900
901 p++;
902 strip_blank_front(&p);
903 strip_blank_end(p);
904 return p;
905}
906
907static int exists_and_not_file(const char *filename)
908{
909 struct stat sb;
910
911 if (lstat(filename, &sb) == -1)
912 return 0;
913
914 /* \\.\ is the device namespace in Windows, where every file
915 * is a device node */
916 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
917 return 0;
918
919 return 1;
920}
921
922static void init_rand_file_service(struct thread_data *td)
923{
924 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
925 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
926
927 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
928 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
929 zipf_disable_hash(&td->next_file_zipf);
930 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
931 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
932 zipf_disable_hash(&td->next_file_zipf);
933 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
934 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
935 gauss_disable_hash(&td->next_file_gauss);
936 }
937}
938
939void td_fill_verify_state_seed(struct thread_data *td)
940{
941 bool use64;
942
943 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
944 use64 = 1;
945 else
946 use64 = 0;
947
948 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
949 use64);
950}
951
952static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
953{
954 int i;
955
956 init_rand_seed(&td->bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF], use64);
957 td_fill_verify_state_seed(td);
958 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
959
960 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
961 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
962 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
963 init_rand_file_service(td);
964
965 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
966 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
967 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
968 init_rand_seed(&td->poisson_state, td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
969 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
970 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
971
972 if (!td_random(td))
973 return;
974
975 if (td->o.rand_repeatable)
976 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
977
978 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
979
980 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
981 struct frand_state *s = &td->seq_rand_state[i];
982
983 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
984 }
985}
986
987void td_fill_rand_seeds(struct thread_data *td)
988{
989 bool use64;
990
991 if (td->o.allrand_repeatable) {
992 unsigned int i;
993
994 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
995 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
996 + i;
997 }
998
999 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1000 use64 = 1;
1001 else
1002 use64 = 0;
1003
1004 td_fill_rand_seeds_internal(td, use64);
1005
1006 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1007 frand_copy(&td->buf_state_prev, &td->buf_state);
1008}
1009
1010/*
1011 * Initializes the ioengine configured for a job, if it has not been done so
1012 * already.
1013 */
1014int ioengine_load(struct thread_data *td)
1015{
1016 const char *engine;
1017
1018 /*
1019 * Engine has already been loaded.
1020 */
1021 if (td->io_ops)
1022 return 0;
1023 if (!td->o.ioengine) {
1024 log_err("fio: internal fault, no IO engine specified\n");
1025 return 1;
1026 }
1027
1028 engine = get_engine_name(td->o.ioengine);
1029 td->io_ops = load_ioengine(td, engine);
1030 if (!td->io_ops) {
1031 log_err("fio: failed to load engine %s\n", engine);
1032 return 1;
1033 }
1034
1035 if (td->io_ops->option_struct_size && td->io_ops->options) {
1036 /*
1037 * In cases where td->eo is set, clone it for a child thread.
1038 * This requires that the parent thread has the same ioengine,
1039 * but that requirement must be enforced by the code which
1040 * cloned the thread.
1041 */
1042 void *origeo = td->eo;
1043 /*
1044 * Otherwise use the default thread options.
1045 */
1046 if (!origeo && td != &def_thread && def_thread.eo &&
1047 def_thread.io_ops->options == td->io_ops->options)
1048 origeo = def_thread.eo;
1049
1050 options_init(td->io_ops->options);
1051 td->eo = malloc(td->io_ops->option_struct_size);
1052 /*
1053 * Use the default thread as an option template if this uses the
1054 * same options structure and there are non-default options
1055 * used.
1056 */
1057 if (origeo) {
1058 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1059 options_mem_dupe(td->eo, td->io_ops->options);
1060 } else {
1061 memset(td->eo, 0, td->io_ops->option_struct_size);
1062 fill_default_options(td->eo, td->io_ops->options);
1063 }
1064 *(struct thread_data **)td->eo = td;
1065 }
1066
1067 return 0;
1068}
1069
1070static void init_flags(struct thread_data *td)
1071{
1072 struct thread_options *o = &td->o;
1073
1074 if (o->verify_backlog)
1075 td->flags |= TD_F_VER_BACKLOG;
1076 if (o->trim_backlog)
1077 td->flags |= TD_F_TRIM_BACKLOG;
1078 if (o->read_iolog_file)
1079 td->flags |= TD_F_READ_IOLOG;
1080 if (o->refill_buffers)
1081 td->flags |= TD_F_REFILL_BUFFERS;
1082 /*
1083 * Always scramble buffers if asked to
1084 */
1085 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1086 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1087 /*
1088 * But also scramble buffers, unless we were explicitly asked
1089 * to zero them.
1090 */
1091 if (o->scramble_buffers && !(o->zero_buffers &&
1092 fio_option_is_set(o, zero_buffers)))
1093 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1094 if (o->verify != VERIFY_NONE)
1095 td->flags |= TD_F_VER_NONE;
1096
1097 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1098 td->flags |= TD_F_NEED_LOCK;
1099}
1100
1101static int setup_random_seeds(struct thread_data *td)
1102{
1103 unsigned long seed;
1104 unsigned int i;
1105
1106 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed))
1107 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
1108
1109 seed = td->o.rand_seed;
1110 for (i = 0; i < 4; i++)
1111 seed *= 0x9e370001UL;
1112
1113 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1114 td->rand_seeds[i] = seed * td->thread_number + i;
1115 seed *= 0x9e370001UL;
1116 }
1117
1118 td_fill_rand_seeds(td);
1119 return 0;
1120}
1121
1122enum {
1123 FPRE_NONE = 0,
1124 FPRE_JOBNAME,
1125 FPRE_JOBNUM,
1126 FPRE_FILENUM
1127};
1128
1129static struct fpre_keyword {
1130 const char *keyword;
1131 size_t strlen;
1132 int key;
1133} fpre_keywords[] = {
1134 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1135 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1136 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1137 { .keyword = NULL, },
1138 };
1139
1140static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1141 const char *jobname, int jobnum, int filenum)
1142{
1143 struct fpre_keyword *f;
1144 char copy[PATH_MAX];
1145 size_t dst_left = PATH_MAX - 1;
1146
1147 if (!o->filename_format || !strlen(o->filename_format)) {
1148 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1149 return NULL;
1150 }
1151
1152 for (f = &fpre_keywords[0]; f->keyword; f++)
1153 f->strlen = strlen(f->keyword);
1154
1155 buf[buf_size - 1] = '\0';
1156 strncpy(buf, o->filename_format, buf_size - 1);
1157
1158 memset(copy, 0, sizeof(copy));
1159 for (f = &fpre_keywords[0]; f->keyword; f++) {
1160 do {
1161 size_t pre_len, post_start = 0;
1162 char *str, *dst = copy;
1163
1164 str = strcasestr(buf, f->keyword);
1165 if (!str)
1166 break;
1167
1168 pre_len = str - buf;
1169 if (strlen(str) != f->strlen)
1170 post_start = pre_len + f->strlen;
1171
1172 if (pre_len) {
1173 strncpy(dst, buf, pre_len);
1174 dst += pre_len;
1175 dst_left -= pre_len;
1176 }
1177
1178 switch (f->key) {
1179 case FPRE_JOBNAME: {
1180 int ret;
1181
1182 ret = snprintf(dst, dst_left, "%s", jobname);
1183 if (ret < 0)
1184 break;
1185 else if (ret > dst_left) {
1186 log_err("fio: truncated filename\n");
1187 dst += dst_left;
1188 dst_left = 0;
1189 } else {
1190 dst += ret;
1191 dst_left -= ret;
1192 }
1193 break;
1194 }
1195 case FPRE_JOBNUM: {
1196 int ret;
1197
1198 ret = snprintf(dst, dst_left, "%d", jobnum);
1199 if (ret < 0)
1200 break;
1201 else if (ret > dst_left) {
1202 log_err("fio: truncated filename\n");
1203 dst += dst_left;
1204 dst_left = 0;
1205 } else {
1206 dst += ret;
1207 dst_left -= ret;
1208 }
1209 break;
1210 }
1211 case FPRE_FILENUM: {
1212 int ret;
1213
1214 ret = snprintf(dst, dst_left, "%d", filenum);
1215 if (ret < 0)
1216 break;
1217 else if (ret > dst_left) {
1218 log_err("fio: truncated filename\n");
1219 dst += dst_left;
1220 dst_left = 0;
1221 } else {
1222 dst += ret;
1223 dst_left -= ret;
1224 }
1225 break;
1226 }
1227 default:
1228 assert(0);
1229 break;
1230 }
1231
1232 if (post_start)
1233 strncpy(dst, buf + post_start, dst_left);
1234
1235 strncpy(buf, copy, buf_size - 1);
1236 } while (1);
1237 }
1238
1239 return buf;
1240}
1241
1242int parse_dryrun(void)
1243{
1244 return dump_cmdline || parse_only;
1245}
1246
1247static void gen_log_name(char *name, size_t size, const char *logtype,
1248 const char *logname, unsigned int num,
1249 const char *suf, int per_job)
1250{
1251 if (per_job)
1252 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1253 else
1254 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1255}
1256
1257static int check_waitees(char *waitee)
1258{
1259 struct thread_data *td;
1260 int i, ret = 0;
1261
1262 for_each_td(td, i) {
1263 if (td->subjob_number)
1264 continue;
1265
1266 ret += !strcmp(td->o.name, waitee);
1267 }
1268
1269 return ret;
1270}
1271
1272static bool wait_for_ok(const char *jobname, struct thread_options *o)
1273{
1274 int nw;
1275
1276 if (!o->wait_for)
1277 return true;
1278
1279 if (!strcmp(jobname, o->wait_for)) {
1280 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1281 jobname, o->wait_for);
1282 return false;
1283 }
1284
1285 if (!(nw = check_waitees(o->wait_for))) {
1286 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1287 return false;
1288 }
1289
1290 if (nw > 1) {
1291 log_err("%s: multiple waitees %s found,\n"
1292 "please avoid duplicates when using wait_for option.\n",
1293 jobname, o->wait_for);
1294 return false;
1295 }
1296
1297 return true;
1298}
1299
1300/*
1301 * Adds a job to the list of things todo. Sanitizes the various options
1302 * to make sure we don't have conflicts, and initializes various
1303 * members of td.
1304 */
1305static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1306 int recursed, int client_type)
1307{
1308 unsigned int i;
1309 char fname[PATH_MAX];
1310 int numjobs, file_alloced;
1311 struct thread_options *o = &td->o;
1312 char logname[PATH_MAX + 32];
1313
1314 /*
1315 * the def_thread is just for options, it's not a real job
1316 */
1317 if (td == &def_thread)
1318 return 0;
1319
1320 init_flags(td);
1321
1322 /*
1323 * if we are just dumping the output command line, don't add the job
1324 */
1325 if (parse_dryrun()) {
1326 put_job(td);
1327 return 0;
1328 }
1329
1330 td->client_type = client_type;
1331
1332 if (profile_td_init(td))
1333 goto err;
1334
1335 if (ioengine_load(td))
1336 goto err;
1337
1338 if (o->odirect)
1339 td->io_ops->flags |= FIO_RAWIO;
1340
1341 file_alloced = 0;
1342 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1343 file_alloced = 1;
1344
1345 if (o->nr_files == 1 && exists_and_not_file(jobname))
1346 add_file(td, jobname, job_add_num, 0);
1347 else {
1348 for (i = 0; i < o->nr_files; i++)
1349 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1350 }
1351 }
1352
1353 if (fixup_options(td))
1354 goto err;
1355
1356 /*
1357 * Belongs to fixup_options, but o->name is not necessarily set as yet
1358 */
1359 if (!wait_for_ok(jobname, o))
1360 goto err;
1361
1362 flow_init_job(td);
1363
1364 /*
1365 * IO engines only need this for option callbacks, and the address may
1366 * change in subprocesses.
1367 */
1368 if (td->eo)
1369 *(struct thread_data **)td->eo = NULL;
1370
1371 if (td->io_ops->flags & FIO_DISKLESSIO) {
1372 struct fio_file *f;
1373
1374 for_each_file(td, f, i)
1375 f->real_file_size = -1ULL;
1376 }
1377
1378 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1379
1380 td->ts.clat_percentiles = o->clat_percentiles;
1381 td->ts.percentile_precision = o->percentile_precision;
1382 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1383
1384 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1385 td->ts.clat_stat[i].min_val = ULONG_MAX;
1386 td->ts.slat_stat[i].min_val = ULONG_MAX;
1387 td->ts.lat_stat[i].min_val = ULONG_MAX;
1388 td->ts.bw_stat[i].min_val = ULONG_MAX;
1389 }
1390 td->ddir_seq_nr = o->ddir_seq_nr;
1391
1392 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1393 prev_group_jobs = 0;
1394 groupid++;
1395 if (groupid == INT_MAX) {
1396 log_err("fio: too many groups defined\n");
1397 goto err;
1398 }
1399 }
1400
1401 td->groupid = groupid;
1402 prev_group_jobs++;
1403
1404 if (setup_random_seeds(td)) {
1405 td_verror(td, errno, "init_random_state");
1406 goto err;
1407 }
1408
1409 if (setup_rate(td))
1410 goto err;
1411
1412 if (o->lat_log_file) {
1413 struct log_params p = {
1414 .td = td,
1415 .avg_msec = o->log_avg_msec,
1416 .log_type = IO_LOG_TYPE_LAT,
1417 .log_offset = o->log_offset,
1418 .log_gz = o->log_gz,
1419 .log_gz_store = o->log_gz_store,
1420 };
1421 const char *suf;
1422
1423 if (p.log_gz_store)
1424 suf = "log.fz";
1425 else
1426 suf = "log";
1427
1428 gen_log_name(logname, sizeof(logname), "lat", o->lat_log_file,
1429 td->thread_number, suf, o->per_job_logs);
1430 setup_log(&td->lat_log, &p, logname);
1431
1432 gen_log_name(logname, sizeof(logname), "slat", o->lat_log_file,
1433 td->thread_number, suf, o->per_job_logs);
1434 setup_log(&td->slat_log, &p, logname);
1435
1436 gen_log_name(logname, sizeof(logname), "clat", o->lat_log_file,
1437 td->thread_number, suf, o->per_job_logs);
1438 setup_log(&td->clat_log, &p, logname);
1439 }
1440 if (o->bw_log_file) {
1441 struct log_params p = {
1442 .td = td,
1443 .avg_msec = o->log_avg_msec,
1444 .log_type = IO_LOG_TYPE_BW,
1445 .log_offset = o->log_offset,
1446 .log_gz = o->log_gz,
1447 .log_gz_store = o->log_gz_store,
1448 };
1449 const char *suf;
1450
1451 if (fio_option_is_set(o, bw_avg_time))
1452 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1453 else
1454 o->bw_avg_time = p.avg_msec;
1455
1456 if (p.log_gz_store)
1457 suf = "log.fz";
1458 else
1459 suf = "log";
1460
1461 gen_log_name(logname, sizeof(logname), "bw", o->bw_log_file,
1462 td->thread_number, suf, o->per_job_logs);
1463 setup_log(&td->bw_log, &p, logname);
1464 }
1465 if (o->iops_log_file) {
1466 struct log_params p = {
1467 .td = td,
1468 .avg_msec = o->log_avg_msec,
1469 .log_type = IO_LOG_TYPE_IOPS,
1470 .log_offset = o->log_offset,
1471 .log_gz = o->log_gz,
1472 .log_gz_store = o->log_gz_store,
1473 };
1474 const char *suf;
1475
1476 if (fio_option_is_set(o, iops_avg_time))
1477 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1478 else
1479 o->iops_avg_time = p.avg_msec;
1480
1481 if (p.log_gz_store)
1482 suf = "log.fz";
1483 else
1484 suf = "log";
1485
1486 gen_log_name(logname, sizeof(logname), "iops", o->iops_log_file,
1487 td->thread_number, suf, o->per_job_logs);
1488 setup_log(&td->iops_log, &p, logname);
1489 }
1490
1491 if (!o->name)
1492 o->name = strdup(jobname);
1493
1494 if (output_format & FIO_OUTPUT_NORMAL) {
1495 if (!job_add_num) {
1496 if (is_backend && !recursed)
1497 fio_server_send_add_job(td);
1498
1499 if (!(td->io_ops->flags & FIO_NOIO)) {
1500 char *c1, *c2, *c3, *c4;
1501 char *c5 = NULL, *c6 = NULL;
1502
1503 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1504 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1505 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1506 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1507
1508 if (!o->bs_is_seq_rand) {
1509 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1510 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1511 }
1512
1513 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1514 td->groupid,
1515 ddir_str(o->td_ddir));
1516
1517 if (o->bs_is_seq_rand)
1518 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1519 c1, c2, c3, c4);
1520 else
1521 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1522 c1, c2, c3, c4, c5, c6);
1523
1524 log_info("ioengine=%s, iodepth=%u\n",
1525 td->io_ops->name, o->iodepth);
1526
1527 free(c1);
1528 free(c2);
1529 free(c3);
1530 free(c4);
1531 free(c5);
1532 free(c6);
1533 }
1534 } else if (job_add_num == 1)
1535 log_info("...\n");
1536 }
1537
1538 /*
1539 * recurse add identical jobs, clear numjobs and stonewall options
1540 * as they don't apply to sub-jobs
1541 */
1542 numjobs = o->numjobs;
1543 while (--numjobs) {
1544 struct thread_data *td_new = get_new_job(0, td, 1, jobname);
1545
1546 if (!td_new)
1547 goto err;
1548
1549 td_new->o.numjobs = 1;
1550 td_new->o.stonewall = 0;
1551 td_new->o.new_group = 0;
1552 td_new->subjob_number = numjobs;
1553
1554 if (file_alloced) {
1555 if (td_new->files) {
1556 struct fio_file *f;
1557 for_each_file(td_new, f, i) {
1558 if (f->file_name)
1559 sfree(f->file_name);
1560 sfree(f);
1561 }
1562 free(td_new->files);
1563 td_new->files = NULL;
1564 }
1565 td_new->files_index = 0;
1566 td_new->files_size = 0;
1567 if (td_new->o.filename) {
1568 free(td_new->o.filename);
1569 td_new->o.filename = NULL;
1570 }
1571 }
1572
1573 if (add_job(td_new, jobname, numjobs, 1, client_type))
1574 goto err;
1575 }
1576
1577 return 0;
1578err:
1579 put_job(td);
1580 return -1;
1581}
1582
1583/*
1584 * Parse as if 'o' was a command line
1585 */
1586void add_job_opts(const char **o, int client_type)
1587{
1588 struct thread_data *td, *td_parent;
1589 int i, in_global = 1;
1590 char jobname[32];
1591
1592 i = 0;
1593 td_parent = td = NULL;
1594 while (o[i]) {
1595 if (!strncmp(o[i], "name", 4)) {
1596 in_global = 0;
1597 if (td)
1598 add_job(td, jobname, 0, 0, client_type);
1599 td = NULL;
1600 sprintf(jobname, "%s", o[i] + 5);
1601 }
1602 if (in_global && !td_parent)
1603 td_parent = get_new_job(1, &def_thread, 0, jobname);
1604 else if (!in_global && !td) {
1605 if (!td_parent)
1606 td_parent = &def_thread;
1607 td = get_new_job(0, td_parent, 0, jobname);
1608 }
1609 if (in_global)
1610 fio_options_parse(td_parent, (char **) &o[i], 1);
1611 else
1612 fio_options_parse(td, (char **) &o[i], 1);
1613 i++;
1614 }
1615
1616 if (td)
1617 add_job(td, jobname, 0, 0, client_type);
1618}
1619
1620static int skip_this_section(const char *name)
1621{
1622 int i;
1623
1624 if (!nr_job_sections)
1625 return 0;
1626 if (!strncmp(name, "global", 6))
1627 return 0;
1628
1629 for (i = 0; i < nr_job_sections; i++)
1630 if (!strcmp(job_sections[i], name))
1631 return 0;
1632
1633 return 1;
1634}
1635
1636static int is_empty_or_comment(char *line)
1637{
1638 unsigned int i;
1639
1640 for (i = 0; i < strlen(line); i++) {
1641 if (line[i] == ';')
1642 return 1;
1643 if (line[i] == '#')
1644 return 1;
1645 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1646 return 0;
1647 }
1648
1649 return 1;
1650}
1651
1652/*
1653 * This is our [ini] type file parser.
1654 */
1655int __parse_jobs_ini(struct thread_data *td,
1656 char *file, int is_buf, int stonewall_flag, int type,
1657 int nested, char *name, char ***popts, int *aopts, int *nopts)
1658{
1659 unsigned int global = 0;
1660 char *string;
1661 FILE *f;
1662 char *p;
1663 int ret = 0, stonewall;
1664 int first_sect = 1;
1665 int skip_fgets = 0;
1666 int inside_skip = 0;
1667 char **opts;
1668 int i, alloc_opts, num_opts;
1669
1670 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1671 assert(td || !nested);
1672
1673 if (is_buf)
1674 f = NULL;
1675 else {
1676 if (!strcmp(file, "-"))
1677 f = stdin;
1678 else
1679 f = fopen(file, "r");
1680
1681 if (!f) {
1682 int __err = errno;
1683
1684 log_err("fio: unable to open '%s' job file\n", file);
1685 if (td)
1686 td_verror(td, __err, "job file open");
1687 return 1;
1688 }
1689 }
1690
1691 string = malloc(4096);
1692
1693 /*
1694 * it's really 256 + small bit, 280 should suffice
1695 */
1696 if (!nested) {
1697 name = malloc(280);
1698 memset(name, 0, 280);
1699 }
1700
1701 opts = NULL;
1702 if (nested && popts) {
1703 opts = *popts;
1704 alloc_opts = *aopts;
1705 num_opts = *nopts;
1706 }
1707
1708 if (!opts) {
1709 alloc_opts = 8;
1710 opts = malloc(sizeof(char *) * alloc_opts);
1711 num_opts = 0;
1712 }
1713
1714 stonewall = stonewall_flag;
1715 do {
1716 /*
1717 * if skip_fgets is set, we already have loaded a line we
1718 * haven't handled.
1719 */
1720 if (!skip_fgets) {
1721 if (is_buf)
1722 p = strsep(&file, "\n");
1723 else
1724 p = fgets(string, 4096, f);
1725 if (!p)
1726 break;
1727 }
1728
1729 skip_fgets = 0;
1730 strip_blank_front(&p);
1731 strip_blank_end(p);
1732
1733 dprint(FD_PARSE, "%s\n", p);
1734 if (is_empty_or_comment(p))
1735 continue;
1736
1737 if (!nested) {
1738 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1739 if (inside_skip)
1740 continue;
1741
1742 log_err("fio: option <%s> outside of "
1743 "[] job section\n", p);
1744 ret = 1;
1745 break;
1746 }
1747
1748 name[strlen(name) - 1] = '\0';
1749
1750 if (skip_this_section(name)) {
1751 inside_skip = 1;
1752 continue;
1753 } else
1754 inside_skip = 0;
1755
1756 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1757
1758 global = !strncmp(name, "global", 6);
1759
1760 if (dump_cmdline) {
1761 if (first_sect)
1762 log_info("fio ");
1763 if (!global)
1764 log_info("--name=%s ", name);
1765 first_sect = 0;
1766 }
1767
1768 td = get_new_job(global, &def_thread, 0, name);
1769 if (!td) {
1770 ret = 1;
1771 break;
1772 }
1773
1774 /*
1775 * Separate multiple job files by a stonewall
1776 */
1777 if (!global && stonewall) {
1778 td->o.stonewall = stonewall;
1779 stonewall = 0;
1780 }
1781
1782 num_opts = 0;
1783 memset(opts, 0, alloc_opts * sizeof(char *));
1784 }
1785 else
1786 skip_fgets = 1;
1787
1788 while (1) {
1789 if (!skip_fgets) {
1790 if (is_buf)
1791 p = strsep(&file, "\n");
1792 else
1793 p = fgets(string, 4096, f);
1794 if (!p)
1795 break;
1796 dprint(FD_PARSE, "%s", p);
1797 }
1798 else
1799 skip_fgets = 0;
1800
1801 if (is_empty_or_comment(p))
1802 continue;
1803
1804 strip_blank_front(&p);
1805
1806 /*
1807 * new section, break out and make sure we don't
1808 * fgets() a new line at the top.
1809 */
1810 if (p[0] == '[') {
1811 if (nested) {
1812 log_err("No new sections in included files\n");
1813 return 1;
1814 }
1815
1816 skip_fgets = 1;
1817 break;
1818 }
1819
1820 strip_blank_end(p);
1821
1822 if (!strncmp(p, "include", strlen("include"))) {
1823 char *filename = p + strlen("include") + 1,
1824 *ts, *full_fn = NULL;
1825
1826 /*
1827 * Allow for the include filename
1828 * specification to be relative.
1829 */
1830 if (access(filename, F_OK) &&
1831 (ts = strrchr(file, '/'))) {
1832 int len = ts - file +
1833 strlen(filename) + 2;
1834
1835 if (!(full_fn = calloc(1, len))) {
1836 ret = ENOMEM;
1837 break;
1838 }
1839
1840 strncpy(full_fn,
1841 file, (ts - file) + 1);
1842 strncpy(full_fn + (ts - file) + 1,
1843 filename, strlen(filename));
1844 full_fn[len - 1] = 0;
1845 filename = full_fn;
1846 }
1847
1848 ret = __parse_jobs_ini(td, filename, is_buf,
1849 stonewall_flag, type, 1,
1850 name, &opts,
1851 &alloc_opts, &num_opts);
1852
1853 if (ret) {
1854 log_err("Error %d while parsing "
1855 "include file %s\n",
1856 ret, filename);
1857 }
1858
1859 if (full_fn)
1860 free(full_fn);
1861
1862 if (ret)
1863 break;
1864
1865 continue;
1866 }
1867
1868 if (num_opts == alloc_opts) {
1869 alloc_opts <<= 1;
1870 opts = realloc(opts,
1871 alloc_opts * sizeof(char *));
1872 }
1873
1874 opts[num_opts] = strdup(p);
1875 num_opts++;
1876 }
1877
1878 if (nested) {
1879 *popts = opts;
1880 *aopts = alloc_opts;
1881 *nopts = num_opts;
1882 goto out;
1883 }
1884
1885 ret = fio_options_parse(td, opts, num_opts);
1886 if (!ret) {
1887 if (dump_cmdline)
1888 dump_opt_list(td);
1889
1890 ret = add_job(td, name, 0, 0, type);
1891 } else {
1892 log_err("fio: job %s dropped\n", name);
1893 put_job(td);
1894 }
1895
1896 for (i = 0; i < num_opts; i++)
1897 free(opts[i]);
1898 num_opts = 0;
1899 } while (!ret);
1900
1901 if (dump_cmdline)
1902 log_info("\n");
1903
1904 i = 0;
1905 while (i < nr_job_sections) {
1906 free(job_sections[i]);
1907 i++;
1908 }
1909
1910 free(opts);
1911out:
1912 free(string);
1913 if (!nested)
1914 free(name);
1915 if (!is_buf && f != stdin)
1916 fclose(f);
1917 return ret;
1918}
1919
1920int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1921{
1922 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
1923 0, NULL, NULL, NULL, NULL);
1924}
1925
1926static int fill_def_thread(void)
1927{
1928 memset(&def_thread, 0, sizeof(def_thread));
1929 INIT_FLIST_HEAD(&def_thread.opt_list);
1930
1931 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1932 def_thread.o.error_dump = 1;
1933
1934 /*
1935 * fill default options
1936 */
1937 fio_fill_default_options(&def_thread);
1938 return 0;
1939}
1940
1941static void show_debug_categories(void)
1942{
1943#ifdef FIO_INC_DEBUG
1944 struct debug_level *dl = &debug_levels[0];
1945 int curlen, first = 1;
1946
1947 curlen = 0;
1948 while (dl->name) {
1949 int has_next = (dl + 1)->name != NULL;
1950
1951 if (first || curlen + strlen(dl->name) >= 80) {
1952 if (!first) {
1953 printf("\n");
1954 curlen = 0;
1955 }
1956 curlen += printf("\t\t\t%s", dl->name);
1957 curlen += 3 * (8 - 1);
1958 if (has_next)
1959 curlen += printf(",");
1960 } else {
1961 curlen += printf("%s", dl->name);
1962 if (has_next)
1963 curlen += printf(",");
1964 }
1965 dl++;
1966 first = 0;
1967 }
1968 printf("\n");
1969#endif
1970}
1971
1972static void usage(const char *name)
1973{
1974 printf("%s\n", fio_version_string);
1975 printf("%s [options] [job options] <job file(s)>\n", name);
1976 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
1977 show_debug_categories();
1978 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1979 printf(" --output\t\tWrite output to file\n");
1980 printf(" --runtime\t\tRuntime in seconds\n");
1981 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1982 printf(" --minimal\t\tMinimal (terse) output\n");
1983 printf(" --output-format=x\tOutput format (terse,json,json+,normal)\n");
1984 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1985 printf(" --version\t\tPrint version info and exit\n");
1986 printf(" --help\t\tPrint this page\n");
1987 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1988 printf(" --crctest\t\tTest speed of checksum functions\n");
1989 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1990 " them\n");
1991 printf(" --enghelp=engine\tPrint ioengine help, or list"
1992 " available ioengines\n");
1993 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1994 " cmd\n");
1995 printf(" --showcmd\t\tTurn a job file into command line options\n");
1996 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1997 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1998 printf(" --eta-newline=time\tForce a new line for every 'time'");
1999 printf(" period passed\n");
2000 printf(" --status-interval=t\tForce full status dump every");
2001 printf(" 't' period passed\n");
2002 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2003 " writes\n");
2004 printf(" --section=name\tOnly run specified section in job file\n");
2005 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2006 " (def 1024)\n");
2007 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2008 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2009 printf(" --server=args\t\tStart a backend fio server\n");
2010 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2011 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
2012 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2013 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2014 "\t\t\t(option=system,percpu) or run unit work\n"
2015 "\t\t\tcalibration only (option=calibrate)\n");
2016#ifdef CONFIG_ZLIB
2017 printf(" --inflate-log=log\tInflate and output compressed log\n");
2018#endif
2019 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2020 printf(" --trigger-timeout=t\tExecute trigger af this time\n");
2021 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2022 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2023 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2024 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
2025 printf("\n Jens Axboe <jaxboe@fusionio.com>");
2026 printf("\n Jens Axboe <axboe@fb.com>\n");
2027}
2028
2029#ifdef FIO_INC_DEBUG
2030struct debug_level debug_levels[] = {
2031 { .name = "process",
2032 .help = "Process creation/exit logging",
2033 .shift = FD_PROCESS,
2034 },
2035 { .name = "file",
2036 .help = "File related action logging",
2037 .shift = FD_FILE,
2038 },
2039 { .name = "io",
2040 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2041 .shift = FD_IO,
2042 },
2043 { .name = "mem",
2044 .help = "Memory allocation/freeing logging",
2045 .shift = FD_MEM,
2046 },
2047 { .name = "blktrace",
2048 .help = "blktrace action logging",
2049 .shift = FD_BLKTRACE,
2050 },
2051 { .name = "verify",
2052 .help = "IO verification action logging",
2053 .shift = FD_VERIFY,
2054 },
2055 { .name = "random",
2056 .help = "Random generation logging",
2057 .shift = FD_RANDOM,
2058 },
2059 { .name = "parse",
2060 .help = "Parser logging",
2061 .shift = FD_PARSE,
2062 },
2063 { .name = "diskutil",
2064 .help = "Disk utility logging actions",
2065 .shift = FD_DISKUTIL,
2066 },
2067 { .name = "job",
2068 .help = "Logging related to creating/destroying jobs",
2069 .shift = FD_JOB,
2070 },
2071 { .name = "mutex",
2072 .help = "Mutex logging",
2073 .shift = FD_MUTEX
2074 },
2075 { .name = "profile",
2076 .help = "Logging related to profiles",
2077 .shift = FD_PROFILE,
2078 },
2079 { .name = "time",
2080 .help = "Logging related to time keeping functions",
2081 .shift = FD_TIME,
2082 },
2083 { .name = "net",
2084 .help = "Network logging",
2085 .shift = FD_NET,
2086 },
2087 { .name = "rate",
2088 .help = "Rate logging",
2089 .shift = FD_RATE,
2090 },
2091 { .name = "compress",
2092 .help = "Log compression logging",
2093 .shift = FD_COMPRESS,
2094 },
2095 { .name = NULL, },
2096};
2097
2098static int set_debug(const char *string)
2099{
2100 struct debug_level *dl;
2101 char *p = (char *) string;
2102 char *opt;
2103 int i;
2104
2105 if (!string)
2106 return 0;
2107
2108 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2109 log_info("fio: dumping debug options:");
2110 for (i = 0; debug_levels[i].name; i++) {
2111 dl = &debug_levels[i];
2112 log_info("%s,", dl->name);
2113 }
2114 log_info("all\n");
2115 return 1;
2116 }
2117
2118 while ((opt = strsep(&p, ",")) != NULL) {
2119 int found = 0;
2120
2121 if (!strncmp(opt, "all", 3)) {
2122 log_info("fio: set all debug options\n");
2123 fio_debug = ~0UL;
2124 continue;
2125 }
2126
2127 for (i = 0; debug_levels[i].name; i++) {
2128 dl = &debug_levels[i];
2129 found = !strncmp(opt, dl->name, strlen(dl->name));
2130 if (!found)
2131 continue;
2132
2133 if (dl->shift == FD_JOB) {
2134 opt = strchr(opt, ':');
2135 if (!opt) {
2136 log_err("fio: missing job number\n");
2137 break;
2138 }
2139 opt++;
2140 fio_debug_jobno = atoi(opt);
2141 log_info("fio: set debug jobno %d\n",
2142 fio_debug_jobno);
2143 } else {
2144 log_info("fio: set debug option %s\n", opt);
2145 fio_debug |= (1UL << dl->shift);
2146 }
2147 break;
2148 }
2149
2150 if (!found)
2151 log_err("fio: debug mask %s not found\n", opt);
2152 }
2153 return 0;
2154}
2155#else
2156static int set_debug(const char *string)
2157{
2158 log_err("fio: debug tracing not included in build\n");
2159 return 1;
2160}
2161#endif
2162
2163static void fio_options_fill_optstring(void)
2164{
2165 char *ostr = cmd_optstr;
2166 int i, c;
2167
2168 c = i = 0;
2169 while (l_opts[i].name) {
2170 ostr[c++] = l_opts[i].val;
2171 if (l_opts[i].has_arg == required_argument)
2172 ostr[c++] = ':';
2173 else if (l_opts[i].has_arg == optional_argument) {
2174 ostr[c++] = ':';
2175 ostr[c++] = ':';
2176 }
2177 i++;
2178 }
2179 ostr[c] = '\0';
2180}
2181
2182static int client_flag_set(char c)
2183{
2184 int i;
2185
2186 i = 0;
2187 while (l_opts[i].name) {
2188 int val = l_opts[i].val;
2189
2190 if (c == (val & 0xff))
2191 return (val & FIO_CLIENT_FLAG);
2192
2193 i++;
2194 }
2195
2196 return 0;
2197}
2198
2199static void parse_cmd_client(void *client, char *opt)
2200{
2201 fio_client_add_cmd_option(client, opt);
2202}
2203
2204static void show_closest_option(const char *name)
2205{
2206 int best_option, best_distance;
2207 int i, distance;
2208
2209 while (*name == '-')
2210 name++;
2211
2212 best_option = -1;
2213 best_distance = INT_MAX;
2214 i = 0;
2215 while (l_opts[i].name) {
2216 distance = string_distance(name, l_opts[i].name);
2217 if (distance < best_distance) {
2218 best_distance = distance;
2219 best_option = i;
2220 }
2221 i++;
2222 }
2223
2224 if (best_option != -1 && string_distance_ok(name, best_distance))
2225 log_err("Did you mean %s?\n", l_opts[best_option].name);
2226}
2227
2228static int parse_output_format(const char *optarg)
2229{
2230 char *p, *orig, *opt;
2231 int ret = 0;
2232
2233 p = orig = strdup(optarg);
2234
2235 output_format = 0;
2236
2237 while ((opt = strsep(&p, ",")) != NULL) {
2238 if (!strcmp(opt, "minimal") ||
2239 !strcmp(opt, "terse") ||
2240 !strcmp(opt, "csv"))
2241 output_format |= FIO_OUTPUT_TERSE;
2242 else if (!strcmp(opt, "json"))
2243 output_format |= FIO_OUTPUT_JSON;
2244 else if (!strcmp(opt, "json+"))
2245 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2246 else if (!strcmp(opt, "normal"))
2247 output_format |= FIO_OUTPUT_NORMAL;
2248 else {
2249 log_err("fio: invalid output format %s\n", opt);
2250 ret = 1;
2251 break;
2252 }
2253 }
2254
2255 free(orig);
2256 return ret;
2257}
2258
2259int parse_cmd_line(int argc, char *argv[], int client_type)
2260{
2261 struct thread_data *td = NULL;
2262 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2263 char *ostr = cmd_optstr;
2264 void *pid_file = NULL;
2265 void *cur_client = NULL;
2266 int backend = 0;
2267
2268 /*
2269 * Reset optind handling, since we may call this multiple times
2270 * for the backend.
2271 */
2272 optind = 1;
2273
2274 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2275 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2276 parse_cmd_client(cur_client, argv[optind - 1]);
2277 c &= ~FIO_CLIENT_FLAG;
2278 }
2279
2280 switch (c) {
2281 case 'a':
2282 smalloc_pool_size = atoi(optarg);
2283 break;
2284 case 't':
2285 if (check_str_time(optarg, &def_timeout, 1)) {
2286 log_err("fio: failed parsing time %s\n", optarg);
2287 do_exit++;
2288 exit_val = 1;
2289 }
2290 break;
2291 case 'l':
2292 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2293 do_exit++;
2294 exit_val = 1;
2295 break;
2296 case 'b':
2297 write_bw_log = 1;
2298 break;
2299 case 'o':
2300 if (f_out && f_out != stdout)
2301 fclose(f_out);
2302
2303 f_out = fopen(optarg, "w+");
2304 if (!f_out) {
2305 perror("fopen output");
2306 exit(1);
2307 }
2308 f_err = f_out;
2309 break;
2310 case 'm':
2311 output_format = FIO_OUTPUT_TERSE;
2312 break;
2313 case 'F':
2314 if (!optarg) {
2315 log_err("fio: missing --output-format argument\n");
2316 exit_val = 1;
2317 do_exit++;
2318 break;
2319 }
2320 if (parse_output_format(optarg)) {
2321 log_err("fio: failed parsing output-format\n");
2322 exit_val = 1;
2323 do_exit++;
2324 break;
2325 }
2326 break;
2327 case 'f':
2328 output_format |= FIO_OUTPUT_TERSE;
2329 break;
2330 case 'h':
2331 did_arg = 1;
2332 if (!cur_client) {
2333 usage(argv[0]);
2334 do_exit++;
2335 }
2336 break;
2337 case 'c':
2338 did_arg = 1;
2339 if (!cur_client) {
2340 fio_show_option_help(optarg);
2341 do_exit++;
2342 }
2343 break;
2344 case 'i':
2345 did_arg = 1;
2346 if (!cur_client) {
2347 fio_show_ioengine_help(optarg);
2348 do_exit++;
2349 }
2350 break;
2351 case 's':
2352 did_arg = 1;
2353 dump_cmdline = 1;
2354 break;
2355 case 'r':
2356 read_only = 1;
2357 break;
2358 case 'v':
2359 did_arg = 1;
2360 if (!cur_client) {
2361 log_info("%s\n", fio_version_string);
2362 do_exit++;
2363 }
2364 break;
2365 case 'V':
2366 terse_version = atoi(optarg);
2367 if (!(terse_version == 2 || terse_version == 3 ||
2368 terse_version == 4)) {
2369 log_err("fio: bad terse version format\n");
2370 exit_val = 1;
2371 do_exit++;
2372 }
2373 break;
2374 case 'e':
2375 if (!strcmp("always", optarg))
2376 eta_print = FIO_ETA_ALWAYS;
2377 else if (!strcmp("never", optarg))
2378 eta_print = FIO_ETA_NEVER;
2379 break;
2380 case 'E': {
2381 long long t = 0;
2382
2383 if (check_str_time(optarg, &t, 1)) {
2384 log_err("fio: failed parsing eta time %s\n", optarg);
2385 exit_val = 1;
2386 do_exit++;
2387 }
2388 eta_new_line = t / 1000;
2389 break;
2390 }
2391 case 'd':
2392 if (set_debug(optarg))
2393 do_exit++;
2394 break;
2395 case 'P':
2396 did_arg = 1;
2397 parse_only = 1;
2398 break;
2399 case 'x': {
2400 size_t new_size;
2401
2402 if (!strcmp(optarg, "global")) {
2403 log_err("fio: can't use global as only "
2404 "section\n");
2405 do_exit++;
2406 exit_val = 1;
2407 break;
2408 }
2409 new_size = (nr_job_sections + 1) * sizeof(char *);
2410 job_sections = realloc(job_sections, new_size);
2411 job_sections[nr_job_sections] = strdup(optarg);
2412 nr_job_sections++;
2413 break;
2414 }
2415#ifdef CONFIG_ZLIB
2416 case 'X':
2417 exit_val = iolog_file_inflate(optarg);
2418 did_arg++;
2419 do_exit++;
2420 break;
2421#endif
2422 case 'p':
2423 did_arg = 1;
2424 if (exec_profile)
2425 free(exec_profile);
2426 exec_profile = strdup(optarg);
2427 break;
2428 case FIO_GETOPT_JOB: {
2429 const char *opt = l_opts[lidx].name;
2430 char *val = optarg;
2431
2432 if (!strncmp(opt, "name", 4) && td) {
2433 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2434 if (ret)
2435 goto out_free;
2436 td = NULL;
2437 did_arg = 1;
2438 }
2439 if (!td) {
2440 int is_section = !strncmp(opt, "name", 4);
2441 int global = 0;
2442
2443 if (!is_section || !strncmp(val, "global", 6))
2444 global = 1;
2445
2446 if (is_section && skip_this_section(val))
2447 continue;
2448
2449 td = get_new_job(global, &def_thread, 1, NULL);
2450 if (!td || ioengine_load(td)) {
2451 if (td) {
2452 put_job(td);
2453 td = NULL;
2454 }
2455 do_exit++;
2456 exit_val = 1;
2457 break;
2458 }
2459 fio_options_set_ioengine_opts(l_opts, td);
2460 }
2461
2462 if ((!val || !strlen(val)) &&
2463 l_opts[lidx].has_arg == required_argument) {
2464 log_err("fio: option %s requires an argument\n", opt);
2465 ret = 1;
2466 } else
2467 ret = fio_cmd_option_parse(td, opt, val);
2468
2469 if (ret) {
2470 if (td) {
2471 put_job(td);
2472 td = NULL;
2473 }
2474 do_exit++;
2475 exit_val = 1;
2476 }
2477
2478 if (!ret && !strcmp(opt, "ioengine")) {
2479 free_ioengine(td);
2480 if (ioengine_load(td)) {
2481 put_job(td);
2482 td = NULL;
2483 do_exit++;
2484 exit_val = 1;
2485 break;
2486 }
2487 fio_options_set_ioengine_opts(l_opts, td);
2488 }
2489 break;
2490 }
2491 case FIO_GETOPT_IOENGINE: {
2492 const char *opt = l_opts[lidx].name;
2493 char *val = optarg;
2494
2495 if (!td)
2496 break;
2497
2498 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2499 break;
2500 }
2501 case 'w':
2502 warnings_fatal = 1;
2503 break;
2504 case 'j':
2505 max_jobs = atoi(optarg);
2506 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2507 log_err("fio: invalid max jobs: %d\n", max_jobs);
2508 do_exit++;
2509 exit_val = 1;
2510 }
2511 break;
2512 case 'S':
2513 did_arg = 1;
2514#ifndef CONFIG_NO_SHM
2515 if (nr_clients) {
2516 log_err("fio: can't be both client and server\n");
2517 do_exit++;
2518 exit_val = 1;
2519 break;
2520 }
2521 if (optarg)
2522 fio_server_set_arg(optarg);
2523 is_backend = 1;
2524 backend = 1;
2525#else
2526 log_err("fio: client/server requires SHM support\n");
2527 do_exit++;
2528 exit_val = 1;
2529#endif
2530 break;
2531 case 'D':
2532 if (pid_file)
2533 free(pid_file);
2534 pid_file = strdup(optarg);
2535 break;
2536 case 'I':
2537 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2538 /* exit on error and calibration only */
2539 did_arg = 1;
2540 do_exit++;
2541 if (ret == -1)
2542 exit_val = 1;
2543 }
2544 break;
2545 case 'C':
2546 did_arg = 1;
2547 if (is_backend) {
2548 log_err("fio: can't be both client and server\n");
2549 do_exit++;
2550 exit_val = 1;
2551 break;
2552 }
2553 /* if --client parameter contains a pathname */
2554 if (0 == access(optarg, R_OK)) {
2555 /* file contains a list of host addrs or names */
2556 char hostaddr[PATH_MAX] = {0};
2557 char formatstr[8];
2558 FILE * hostf = fopen(optarg, "r");
2559 if (!hostf) {
2560 log_err("fio: could not open client list file %s for read\n", optarg);
2561 do_exit++;
2562 exit_val = 1;
2563 break;
2564 }
2565 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2566 /*
2567 * read at most PATH_MAX-1 chars from each
2568 * record in this file
2569 */
2570 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2571 /* expect EVERY host in file to be valid */
2572 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2573 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2574 do_exit++;
2575 exit_val = 1;
2576 break;
2577 }
2578 }
2579 fclose(hostf);
2580 break; /* no possibility of job file for "this client only" */
2581 }
2582 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2583 log_err("fio: failed adding client %s\n", optarg);
2584 do_exit++;
2585 exit_val = 1;
2586 break;
2587 }
2588 /*
2589 * If the next argument exists and isn't an option,
2590 * assume it's a job file for this client only.
2591 */
2592 while (optind < argc) {
2593 if (!strncmp(argv[optind], "--", 2) ||
2594 !strncmp(argv[optind], "-", 1))
2595 break;
2596
2597 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2598 break;
2599 optind++;
2600 }
2601 break;
2602 case 'R':
2603 did_arg = 1;
2604 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2605 do_exit++;
2606 exit_val = 1;
2607 }
2608 break;
2609 case 'T':
2610 did_arg = 1;
2611 do_exit++;
2612 exit_val = fio_monotonic_clocktest(1);
2613 break;
2614 case 'G':
2615 did_arg = 1;
2616 do_exit++;
2617 exit_val = fio_crctest(optarg);
2618 break;
2619 case 'L': {
2620 long long val;
2621
2622 if (check_str_time(optarg, &val, 1)) {
2623 log_err("fio: failed parsing time %s\n", optarg);
2624 do_exit++;
2625 exit_val = 1;
2626 break;
2627 }
2628 status_interval = val / 1000;
2629 break;
2630 }
2631 case 'W':
2632 if (trigger_file)
2633 free(trigger_file);
2634 trigger_file = strdup(optarg);
2635 break;
2636 case 'H':
2637 if (trigger_cmd)
2638 free(trigger_cmd);
2639 trigger_cmd = strdup(optarg);
2640 break;
2641 case 'J':
2642 if (trigger_remote_cmd)
2643 free(trigger_remote_cmd);
2644 trigger_remote_cmd = strdup(optarg);
2645 break;
2646 case 'K':
2647 if (aux_path)
2648 free(aux_path);
2649 aux_path = strdup(optarg);
2650 break;
2651 case 'B':
2652 if (check_str_time(optarg, &trigger_timeout, 1)) {
2653 log_err("fio: failed parsing time %s\n", optarg);
2654 do_exit++;
2655 exit_val = 1;
2656 }
2657 trigger_timeout /= 1000000;
2658 break;
2659 case '?':
2660 log_err("%s: unrecognized option '%s'\n", argv[0],
2661 argv[optind - 1]);
2662 show_closest_option(argv[optind - 1]);
2663 default:
2664 do_exit++;
2665 exit_val = 1;
2666 break;
2667 }
2668 if (do_exit)
2669 break;
2670 }
2671
2672 if (do_exit && !(is_backend || nr_clients))
2673 exit(exit_val);
2674
2675 if (nr_clients && fio_clients_connect())
2676 exit(1);
2677
2678 if (is_backend && backend)
2679 return fio_start_server(pid_file);
2680 else if (pid_file)
2681 free(pid_file);
2682
2683 if (td) {
2684 if (!ret) {
2685 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2686 if (ret)
2687 did_arg = 1;
2688 }
2689 }
2690
2691 while (!ret && optind < argc) {
2692 ini_idx++;
2693 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2694 ini_file[ini_idx - 1] = strdup(argv[optind]);
2695 optind++;
2696 }
2697
2698out_free:
2699 if (pid_file)
2700 free(pid_file);
2701
2702 return ini_idx;
2703}
2704
2705int fio_init_options(void)
2706{
2707 f_out = stdout;
2708 f_err = stderr;
2709
2710 fio_options_fill_optstring();
2711 fio_options_dup_and_init(l_opts);
2712
2713 atexit(free_shm);
2714
2715 if (fill_def_thread())
2716 return 1;
2717
2718 return 0;
2719}
2720
2721extern int fio_check_options(struct thread_options *);
2722
2723int parse_options(int argc, char *argv[])
2724{
2725 const int type = FIO_CLIENT_TYPE_CLI;
2726 int job_files, i;
2727
2728 if (fio_init_options())
2729 return 1;
2730 if (fio_test_cconv(&def_thread.o))
2731 log_err("fio: failed internal cconv test\n");
2732
2733 job_files = parse_cmd_line(argc, argv, type);
2734
2735 if (job_files > 0) {
2736 for (i = 0; i < job_files; i++) {
2737 if (i && fill_def_thread())
2738 return 1;
2739 if (nr_clients) {
2740 if (fio_clients_send_ini(ini_file[i]))
2741 return 1;
2742 free(ini_file[i]);
2743 } else if (!is_backend) {
2744 if (parse_jobs_ini(ini_file[i], 0, i, type))
2745 return 1;
2746 free(ini_file[i]);
2747 }
2748 }
2749 } else if (nr_clients) {
2750 if (fill_def_thread())
2751 return 1;
2752 if (fio_clients_send_ini(NULL))
2753 return 1;
2754 }
2755
2756 free(ini_file);
2757 fio_options_free(&def_thread);
2758 filesetup_mem_free();
2759
2760 if (!thread_number) {
2761 if (parse_dryrun())
2762 return 0;
2763 if (exec_profile)
2764 return 0;
2765 if (is_backend || nr_clients)
2766 return 0;
2767 if (did_arg)
2768 return 0;
2769
2770 log_err("No jobs(s) defined\n\n");
2771
2772 if (!did_arg) {
2773 usage(argv[0]);
2774 return 1;
2775 }
2776
2777 return 0;
2778 }
2779
2780 if (output_format & FIO_OUTPUT_NORMAL)
2781 log_info("%s\n", fio_version_string);
2782
2783 return 0;
2784}
2785
2786void options_default_fill(struct thread_options *o)
2787{
2788 memcpy(o, &def_thread.o, sizeof(*o));
2789}
2790
2791struct thread_data *get_global_options(void)
2792{
2793 return &def_thread;
2794}