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