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