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