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