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