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