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