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