Merge branch '32-bit-fixes' of https://github.com/sitsofe/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 <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 o->latency_window *= 1000ULL;
960
961 return ret;
962}
963
964static void init_rand_file_service(struct thread_data *td)
965{
966 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
967 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
968
969 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
970 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
971 zipf_disable_hash(&td->next_file_zipf);
972 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
973 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
974 zipf_disable_hash(&td->next_file_zipf);
975 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
976 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
977 gauss_disable_hash(&td->next_file_gauss);
978 }
979}
980
981void td_fill_verify_state_seed(struct thread_data *td)
982{
983 bool use64;
984
985 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
986 use64 = true;
987 else
988 use64 = false;
989
990 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
991 use64);
992}
993
994static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
995{
996 uint64_t read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
997 uint64_t write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
998 uint64_t trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
999 int i;
1000
1001 /*
1002 * trimwrite is special in that we need to generate the same
1003 * offsets to get the "write after trim" effect. If we are
1004 * using bssplit to set buffer length distributions, ensure that
1005 * we seed the trim and write generators identically. Ditto for
1006 * verify, read and writes must have the same seed, if we are doing
1007 * read verify.
1008 */
1009 if (td->o.verify != VERIFY_NONE)
1010 write_seed = read_seed;
1011 if (td_trimwrite(td))
1012 trim_seed = write_seed;
1013 init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1014 init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1015 init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1016
1017 td_fill_verify_state_seed(td);
1018 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1019
1020 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1021 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1022 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1023 init_rand_file_service(td);
1024
1025 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1026 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1027 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1028 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1029 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1030 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1031 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1032 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1033 init_rand_seed(&td->prio_state, td->rand_seeds[FIO_RAND_PRIO_CMDS], false);
1034
1035 if (!td_random(td))
1036 return;
1037
1038 if (td->o.rand_repeatable)
1039 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1040
1041 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1042
1043 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1044 struct frand_state *s = &td->seq_rand_state[i];
1045
1046 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1047 }
1048}
1049
1050void td_fill_rand_seeds(struct thread_data *td)
1051{
1052 bool use64;
1053
1054 if (td->o.allrand_repeatable) {
1055 unsigned int i;
1056
1057 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1058 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1059 + i;
1060 }
1061
1062 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1063 use64 = true;
1064 else
1065 use64 = false;
1066
1067 td_fill_rand_seeds_internal(td, use64);
1068
1069 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1070 frand_copy(&td->buf_state_prev, &td->buf_state);
1071}
1072
1073/*
1074 * Initializes the ioengine configured for a job, if it has not been done so
1075 * already.
1076 */
1077int ioengine_load(struct thread_data *td)
1078{
1079 if (!td->o.ioengine) {
1080 log_err("fio: internal fault, no IO engine specified\n");
1081 return 1;
1082 }
1083
1084 if (td->io_ops) {
1085 struct ioengine_ops *ops;
1086 void *dlhandle;
1087
1088 /* An engine is loaded, but the requested ioengine
1089 * may have changed.
1090 */
1091 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1092 /* The right engine is already loaded */
1093 return 0;
1094 }
1095
1096 /*
1097 * Name of file and engine may be different, load ops
1098 * for this name and see if they match. If they do, then
1099 * the engine is unchanged.
1100 */
1101 dlhandle = td->io_ops_dlhandle;
1102 ops = load_ioengine(td);
1103 if (ops == td->io_ops && dlhandle == td->io_ops_dlhandle) {
1104 if (dlhandle)
1105 dlclose(dlhandle);
1106 return 0;
1107 }
1108
1109 if (dlhandle && dlhandle != td->io_ops_dlhandle)
1110 dlclose(dlhandle);
1111
1112 /* Unload the old engine. */
1113 free_ioengine(td);
1114 }
1115
1116 td->io_ops = load_ioengine(td);
1117 if (!td->io_ops) {
1118 log_err("fio: failed to load engine\n");
1119 return 1;
1120 }
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}
1160
1161static void init_flags(struct thread_data *td)
1162{
1163 struct thread_options *o = &td->o;
1164 int i;
1165
1166 if (o->verify_backlog)
1167 td->flags |= TD_F_VER_BACKLOG;
1168 if (o->trim_backlog)
1169 td->flags |= TD_F_TRIM_BACKLOG;
1170 if (o->read_iolog_file)
1171 td->flags |= TD_F_READ_IOLOG;
1172 if (o->refill_buffers)
1173 td->flags |= TD_F_REFILL_BUFFERS;
1174 /*
1175 * Always scramble buffers if asked to
1176 */
1177 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1178 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1179 /*
1180 * But also scramble buffers, unless we were explicitly asked
1181 * to zero them.
1182 */
1183 if (o->scramble_buffers && !(o->zero_buffers &&
1184 fio_option_is_set(o, zero_buffers)))
1185 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1186 if (o->verify != VERIFY_NONE)
1187 td->flags |= TD_F_DO_VERIFY;
1188
1189 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1190 td->flags |= TD_F_NEED_LOCK;
1191
1192 if (o->mem_type == MEM_CUDA_MALLOC)
1193 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1194
1195 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1196 if (option_check_rate(td, i)) {
1197 td->flags |= TD_F_CHECK_RATE;
1198 break;
1199 }
1200 }
1201}
1202
1203static int setup_random_seeds(struct thread_data *td)
1204{
1205 uint64_t seed;
1206 unsigned int i;
1207
1208 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1209 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1210 if (!ret)
1211 td_fill_rand_seeds(td);
1212 return ret;
1213 }
1214
1215 seed = td->o.rand_seed;
1216 for (i = 0; i < 4; i++)
1217 seed *= 0x9e370001UL;
1218
1219 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1220 td->rand_seeds[i] = seed * td->thread_number + i;
1221 seed *= 0x9e370001UL;
1222 }
1223
1224 td_fill_rand_seeds(td);
1225 return 0;
1226}
1227
1228enum {
1229 FPRE_NONE = 0,
1230 FPRE_JOBNAME,
1231 FPRE_JOBNUM,
1232 FPRE_FILENUM
1233};
1234
1235static struct fpre_keyword {
1236 const char *keyword;
1237 size_t strlen;
1238 int key;
1239} fpre_keywords[] = {
1240 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1241 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1242 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1243 { .keyword = NULL, },
1244 };
1245
1246static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1247 const char *jobname, int jobnum, int filenum)
1248{
1249 struct fpre_keyword *f;
1250 char copy[PATH_MAX];
1251 size_t dst_left = PATH_MAX - 1;
1252
1253 if (!o->filename_format || !strlen(o->filename_format)) {
1254 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1255 return buf;
1256 }
1257
1258 for (f = &fpre_keywords[0]; f->keyword; f++)
1259 f->strlen = strlen(f->keyword);
1260
1261 snprintf(buf, buf_size, "%s", o->filename_format);
1262
1263 memset(copy, 0, sizeof(copy));
1264 for (f = &fpre_keywords[0]; f->keyword; f++) {
1265 do {
1266 size_t pre_len, post_start = 0;
1267 char *str, *dst = copy;
1268
1269 str = strcasestr(buf, f->keyword);
1270 if (!str)
1271 break;
1272
1273 pre_len = str - buf;
1274 if (strlen(str) != f->strlen)
1275 post_start = pre_len + f->strlen;
1276
1277 if (pre_len) {
1278 strncpy(dst, buf, pre_len);
1279 dst += pre_len;
1280 dst_left -= pre_len;
1281 }
1282
1283 switch (f->key) {
1284 case FPRE_JOBNAME: {
1285 int ret;
1286
1287 ret = snprintf(dst, dst_left, "%s", jobname);
1288 if (ret < 0)
1289 break;
1290 else if (ret > dst_left) {
1291 log_err("fio: truncated filename\n");
1292 dst += dst_left;
1293 dst_left = 0;
1294 } else {
1295 dst += ret;
1296 dst_left -= ret;
1297 }
1298 break;
1299 }
1300 case FPRE_JOBNUM: {
1301 int ret;
1302
1303 ret = snprintf(dst, dst_left, "%d", jobnum);
1304 if (ret < 0)
1305 break;
1306 else if (ret > dst_left) {
1307 log_err("fio: truncated filename\n");
1308 dst += dst_left;
1309 dst_left = 0;
1310 } else {
1311 dst += ret;
1312 dst_left -= ret;
1313 }
1314 break;
1315 }
1316 case FPRE_FILENUM: {
1317 int ret;
1318
1319 ret = snprintf(dst, dst_left, "%d", filenum);
1320 if (ret < 0)
1321 break;
1322 else if (ret > dst_left) {
1323 log_err("fio: truncated filename\n");
1324 dst += dst_left;
1325 dst_left = 0;
1326 } else {
1327 dst += ret;
1328 dst_left -= ret;
1329 }
1330 break;
1331 }
1332 default:
1333 assert(0);
1334 break;
1335 }
1336
1337 if (post_start)
1338 strncpy(dst, buf + post_start, dst_left);
1339
1340 snprintf(buf, buf_size, "%s", copy);
1341 } while (1);
1342 }
1343
1344 return buf;
1345}
1346
1347bool parse_dryrun(void)
1348{
1349 return dump_cmdline || parse_only;
1350}
1351
1352static void gen_log_name(char *name, size_t size, const char *logtype,
1353 const char *logname, unsigned int num,
1354 const char *suf, int per_job)
1355{
1356 if (per_job)
1357 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1358 else
1359 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1360}
1361
1362static int check_waitees(char *waitee)
1363{
1364 struct thread_data *td;
1365 int i, ret = 0;
1366
1367 for_each_td(td, i) {
1368 if (td->subjob_number)
1369 continue;
1370
1371 ret += !strcmp(td->o.name, waitee);
1372 }
1373
1374 return ret;
1375}
1376
1377static bool wait_for_ok(const char *jobname, struct thread_options *o)
1378{
1379 int nw;
1380
1381 if (!o->wait_for)
1382 return true;
1383
1384 if (!strcmp(jobname, o->wait_for)) {
1385 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1386 jobname, o->wait_for);
1387 return false;
1388 }
1389
1390 if (!(nw = check_waitees(o->wait_for))) {
1391 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1392 return false;
1393 }
1394
1395 if (nw > 1) {
1396 log_err("%s: multiple waitees %s found,\n"
1397 "please avoid duplicates when using wait_for option.\n",
1398 jobname, o->wait_for);
1399 return false;
1400 }
1401
1402 return true;
1403}
1404
1405/*
1406 * Treat an empty log file name the same as a one not given
1407 */
1408static const char *make_log_name(const char *logname, const char *jobname)
1409{
1410 if (logname && strcmp(logname, ""))
1411 return logname;
1412
1413 return jobname;
1414}
1415
1416/*
1417 * Adds a job to the list of things todo. Sanitizes the various options
1418 * to make sure we don't have conflicts, and initializes various
1419 * members of td.
1420 */
1421static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1422 int recursed, int client_type)
1423{
1424 unsigned int i;
1425 char fname[PATH_MAX + 1];
1426 int numjobs, file_alloced;
1427 struct thread_options *o = &td->o;
1428 char logname[PATH_MAX + 32];
1429
1430 /*
1431 * the def_thread is just for options, it's not a real job
1432 */
1433 if (td == &def_thread)
1434 return 0;
1435
1436 init_flags(td);
1437
1438 /*
1439 * if we are just dumping the output command line, don't add the job
1440 */
1441 if (parse_dryrun()) {
1442 put_job(td);
1443 return 0;
1444 }
1445
1446 td->client_type = client_type;
1447
1448 if (profile_td_init(td))
1449 goto err;
1450
1451 if (ioengine_load(td))
1452 goto err;
1453
1454 file_alloced = 0;
1455 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1456 file_alloced = 1;
1457
1458 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1459 add_file(td, jobname, job_add_num, 0);
1460 else {
1461 for (i = 0; i < o->nr_files; i++)
1462 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1463 }
1464 }
1465
1466 if (setup_random_seeds(td)) {
1467 td_verror(td, errno, "setup_random_seeds");
1468 goto err;
1469 }
1470
1471 if (fixup_options(td))
1472 goto err;
1473
1474 /*
1475 * Belongs to fixup_options, but o->name is not necessarily set as yet
1476 */
1477 if (!wait_for_ok(jobname, o))
1478 goto err;
1479
1480 flow_init_job(td);
1481
1482 /*
1483 * IO engines only need this for option callbacks, and the address may
1484 * change in subprocesses.
1485 */
1486 if (td->eo)
1487 *(struct thread_data **)td->eo = NULL;
1488
1489 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1490 struct fio_file *f;
1491
1492 for_each_file(td, f, i)
1493 f->real_file_size = -1ULL;
1494 }
1495
1496 td->sem = fio_sem_init(FIO_SEM_LOCKED);
1497
1498 td->ts.clat_percentiles = o->clat_percentiles;
1499 td->ts.lat_percentiles = o->lat_percentiles;
1500 td->ts.slat_percentiles = o->slat_percentiles;
1501 td->ts.percentile_precision = o->percentile_precision;
1502 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1503 td->ts.sig_figs = o->sig_figs;
1504
1505 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1506 td->ts.clat_stat[i].min_val = ULONG_MAX;
1507 td->ts.slat_stat[i].min_val = ULONG_MAX;
1508 td->ts.lat_stat[i].min_val = ULONG_MAX;
1509 td->ts.bw_stat[i].min_val = ULONG_MAX;
1510 td->ts.iops_stat[i].min_val = ULONG_MAX;
1511 td->ts.clat_high_prio_stat[i].min_val = ULONG_MAX;
1512 td->ts.clat_low_prio_stat[i].min_val = ULONG_MAX;
1513 }
1514 td->ts.sync_stat.min_val = ULONG_MAX;
1515 td->ddir_seq_nr = o->ddir_seq_nr;
1516
1517 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1518 prev_group_jobs = 0;
1519 groupid++;
1520 if (groupid == INT_MAX) {
1521 log_err("fio: too many groups defined\n");
1522 goto err;
1523 }
1524 }
1525
1526 td->groupid = groupid;
1527 prev_group_jobs++;
1528
1529 if (setup_rate(td))
1530 goto err;
1531
1532 if (o->write_lat_log) {
1533 struct log_params p = {
1534 .td = td,
1535 .avg_msec = o->log_avg_msec,
1536 .hist_msec = o->log_hist_msec,
1537 .hist_coarseness = o->log_hist_coarseness,
1538 .log_type = IO_LOG_TYPE_LAT,
1539 .log_offset = o->log_offset,
1540 .log_gz = o->log_gz,
1541 .log_gz_store = o->log_gz_store,
1542 };
1543 const char *pre = make_log_name(o->lat_log_file, o->name);
1544 const char *suf;
1545
1546 if (p.log_gz_store)
1547 suf = "log.fz";
1548 else
1549 suf = "log";
1550
1551 gen_log_name(logname, sizeof(logname), "lat", pre,
1552 td->thread_number, suf, o->per_job_logs);
1553 setup_log(&td->lat_log, &p, logname);
1554
1555 gen_log_name(logname, sizeof(logname), "slat", pre,
1556 td->thread_number, suf, o->per_job_logs);
1557 setup_log(&td->slat_log, &p, logname);
1558
1559 gen_log_name(logname, sizeof(logname), "clat", pre,
1560 td->thread_number, suf, o->per_job_logs);
1561 setup_log(&td->clat_log, &p, logname);
1562
1563 }
1564
1565 if (o->write_hist_log) {
1566 struct log_params p = {
1567 .td = td,
1568 .avg_msec = o->log_avg_msec,
1569 .hist_msec = o->log_hist_msec,
1570 .hist_coarseness = o->log_hist_coarseness,
1571 .log_type = IO_LOG_TYPE_HIST,
1572 .log_offset = o->log_offset,
1573 .log_gz = o->log_gz,
1574 .log_gz_store = o->log_gz_store,
1575 };
1576 const char *pre = make_log_name(o->hist_log_file, o->name);
1577 const char *suf;
1578
1579#ifndef CONFIG_ZLIB
1580 if (td->client_type) {
1581 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1582 goto err;
1583 }
1584#endif
1585
1586 if (p.log_gz_store)
1587 suf = "log.fz";
1588 else
1589 suf = "log";
1590
1591 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1592 td->thread_number, suf, o->per_job_logs);
1593 setup_log(&td->clat_hist_log, &p, logname);
1594 }
1595
1596 if (o->write_bw_log) {
1597 struct log_params p = {
1598 .td = td,
1599 .avg_msec = o->log_avg_msec,
1600 .hist_msec = o->log_hist_msec,
1601 .hist_coarseness = o->log_hist_coarseness,
1602 .log_type = IO_LOG_TYPE_BW,
1603 .log_offset = o->log_offset,
1604 .log_gz = o->log_gz,
1605 .log_gz_store = o->log_gz_store,
1606 };
1607 const char *pre = make_log_name(o->bw_log_file, o->name);
1608 const char *suf;
1609
1610 if (fio_option_is_set(o, bw_avg_time))
1611 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1612 else
1613 o->bw_avg_time = p.avg_msec;
1614
1615 p.hist_msec = o->log_hist_msec;
1616 p.hist_coarseness = o->log_hist_coarseness;
1617
1618 if (p.log_gz_store)
1619 suf = "log.fz";
1620 else
1621 suf = "log";
1622
1623 gen_log_name(logname, sizeof(logname), "bw", pre,
1624 td->thread_number, suf, o->per_job_logs);
1625 setup_log(&td->bw_log, &p, logname);
1626 }
1627 if (o->write_iops_log) {
1628 struct log_params p = {
1629 .td = td,
1630 .avg_msec = o->log_avg_msec,
1631 .hist_msec = o->log_hist_msec,
1632 .hist_coarseness = o->log_hist_coarseness,
1633 .log_type = IO_LOG_TYPE_IOPS,
1634 .log_offset = o->log_offset,
1635 .log_gz = o->log_gz,
1636 .log_gz_store = o->log_gz_store,
1637 };
1638 const char *pre = make_log_name(o->iops_log_file, o->name);
1639 const char *suf;
1640
1641 if (fio_option_is_set(o, iops_avg_time))
1642 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1643 else
1644 o->iops_avg_time = p.avg_msec;
1645
1646 p.hist_msec = o->log_hist_msec;
1647 p.hist_coarseness = o->log_hist_coarseness;
1648
1649 if (p.log_gz_store)
1650 suf = "log.fz";
1651 else
1652 suf = "log";
1653
1654 gen_log_name(logname, sizeof(logname), "iops", pre,
1655 td->thread_number, suf, o->per_job_logs);
1656 setup_log(&td->iops_log, &p, logname);
1657 }
1658
1659 if (!o->name)
1660 o->name = strdup(jobname);
1661
1662 if (output_format & FIO_OUTPUT_NORMAL) {
1663 if (!job_add_num) {
1664 if (is_backend && !recursed)
1665 fio_server_send_add_job(td);
1666
1667 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1668 char *c1, *c2, *c3, *c4;
1669 char *c5 = NULL, *c6 = NULL;
1670 int i2p = is_power_of_2(o->kb_base);
1671 struct buf_output out;
1672
1673 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1674 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1675 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1676 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1677
1678 if (!o->bs_is_seq_rand) {
1679 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1680 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1681 }
1682
1683 buf_output_init(&out);
1684 __log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
1685 td->groupid,
1686 ddir_str(o->td_ddir));
1687
1688 if (o->bs_is_seq_rand)
1689 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1690 c1, c2, c3, c4);
1691 else
1692 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1693 c1, c2, c3, c4, c5, c6);
1694
1695 __log_buf(&out, "ioengine=%s, iodepth=%u\n",
1696 td->io_ops->name, o->iodepth);
1697 log_info_buf(out.buf, out.buflen);
1698 buf_output_free(&out);
1699
1700 free(c1);
1701 free(c2);
1702 free(c3);
1703 free(c4);
1704 free(c5);
1705 free(c6);
1706 }
1707 } else if (job_add_num == 1)
1708 log_info("...\n");
1709 }
1710
1711 if (td_steadystate_init(td))
1712 goto err;
1713
1714 if (o->merge_blktrace_file && !merge_blktrace_iologs(td))
1715 goto err;
1716
1717 if (merge_blktrace_only) {
1718 put_job(td);
1719 return 0;
1720 }
1721
1722 /*
1723 * recurse add identical jobs, clear numjobs and stonewall options
1724 * as they don't apply to sub-jobs
1725 */
1726 numjobs = o->numjobs;
1727 while (--numjobs) {
1728 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1729
1730 if (!td_new)
1731 goto err;
1732
1733 td_new->o.numjobs = 1;
1734 td_new->o.stonewall = 0;
1735 td_new->o.new_group = 0;
1736 td_new->subjob_number = numjobs;
1737 td_new->o.ss_dur = o->ss_dur * 1000000l;
1738 td_new->o.ss_limit = o->ss_limit;
1739
1740 if (file_alloced) {
1741 if (td_new->files) {
1742 struct fio_file *f;
1743 for_each_file(td_new, f, i) {
1744 if (f->file_name)
1745 sfree(f->file_name);
1746 sfree(f);
1747 }
1748 free(td_new->files);
1749 td_new->files = NULL;
1750 }
1751 td_new->files_index = 0;
1752 td_new->files_size = 0;
1753 if (td_new->o.filename) {
1754 free(td_new->o.filename);
1755 td_new->o.filename = NULL;
1756 }
1757 }
1758
1759 if (add_job(td_new, jobname, numjobs, 1, client_type))
1760 goto err;
1761 }
1762
1763 return 0;
1764err:
1765 put_job(td);
1766 return -1;
1767}
1768
1769/*
1770 * Parse as if 'o' was a command line
1771 */
1772void add_job_opts(const char **o, int client_type)
1773{
1774 struct thread_data *td, *td_parent;
1775 int i, in_global = 1;
1776 char jobname[32];
1777
1778 i = 0;
1779 td_parent = td = NULL;
1780 while (o[i]) {
1781 if (!strncmp(o[i], "name", 4)) {
1782 in_global = 0;
1783 if (td)
1784 add_job(td, jobname, 0, 0, client_type);
1785 td = NULL;
1786 sprintf(jobname, "%s", o[i] + 5);
1787 }
1788 if (in_global && !td_parent)
1789 td_parent = get_new_job(true, &def_thread, false, jobname);
1790 else if (!in_global && !td) {
1791 if (!td_parent)
1792 td_parent = &def_thread;
1793 td = get_new_job(false, td_parent, false, jobname);
1794 }
1795 if (in_global)
1796 fio_options_parse(td_parent, (char **) &o[i], 1);
1797 else
1798 fio_options_parse(td, (char **) &o[i], 1);
1799 i++;
1800 }
1801
1802 if (td)
1803 add_job(td, jobname, 0, 0, client_type);
1804}
1805
1806static int skip_this_section(const char *name)
1807{
1808 int i;
1809
1810 if (!nr_job_sections)
1811 return 0;
1812 if (!strncmp(name, "global", 6))
1813 return 0;
1814
1815 for (i = 0; i < nr_job_sections; i++)
1816 if (!strcmp(job_sections[i], name))
1817 return 0;
1818
1819 return 1;
1820}
1821
1822static int is_empty_or_comment(char *line)
1823{
1824 unsigned int i;
1825
1826 for (i = 0; i < strlen(line); i++) {
1827 if (line[i] == ';')
1828 return 1;
1829 if (line[i] == '#')
1830 return 1;
1831 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1832 return 0;
1833 }
1834
1835 return 1;
1836}
1837
1838/*
1839 * This is our [ini] type file parser.
1840 */
1841static int __parse_jobs_ini(struct thread_data *td,
1842 char *file, int is_buf, int stonewall_flag, int type,
1843 int nested, char *name, char ***popts, int *aopts, int *nopts)
1844{
1845 bool global = false;
1846 char *string;
1847 FILE *f;
1848 char *p;
1849 int ret = 0, stonewall;
1850 int first_sect = 1;
1851 int skip_fgets = 0;
1852 int inside_skip = 0;
1853 char **opts;
1854 int i, alloc_opts, num_opts;
1855
1856 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1857 assert(td || !nested);
1858
1859 if (is_buf)
1860 f = NULL;
1861 else {
1862 if (!strcmp(file, "-"))
1863 f = stdin;
1864 else
1865 f = fopen(file, "r");
1866
1867 if (!f) {
1868 int __err = errno;
1869
1870 log_err("fio: unable to open '%s' job file\n", file);
1871 if (td)
1872 td_verror(td, __err, "job file open");
1873 return 1;
1874 }
1875 }
1876
1877 string = malloc(OPT_LEN_MAX);
1878
1879 /*
1880 * it's really 256 + small bit, 280 should suffice
1881 */
1882 if (!nested) {
1883 name = malloc(280);
1884 memset(name, 0, 280);
1885 }
1886
1887 opts = NULL;
1888 if (nested && popts) {
1889 opts = *popts;
1890 alloc_opts = *aopts;
1891 num_opts = *nopts;
1892 }
1893
1894 if (!opts) {
1895 alloc_opts = 8;
1896 opts = malloc(sizeof(char *) * alloc_opts);
1897 num_opts = 0;
1898 }
1899
1900 stonewall = stonewall_flag;
1901 do {
1902 /*
1903 * if skip_fgets is set, we already have loaded a line we
1904 * haven't handled.
1905 */
1906 if (!skip_fgets) {
1907 if (is_buf)
1908 p = strsep(&file, "\n");
1909 else
1910 p = fgets(string, OPT_LEN_MAX, f);
1911 if (!p)
1912 break;
1913 }
1914
1915 skip_fgets = 0;
1916 strip_blank_front(&p);
1917 strip_blank_end(p);
1918
1919 dprint(FD_PARSE, "%s\n", p);
1920 if (is_empty_or_comment(p))
1921 continue;
1922
1923 if (!nested) {
1924 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1925 if (inside_skip)
1926 continue;
1927
1928 log_err("fio: option <%s> outside of "
1929 "[] job section\n", p);
1930 ret = 1;
1931 break;
1932 }
1933
1934 name[strlen(name) - 1] = '\0';
1935
1936 if (skip_this_section(name)) {
1937 inside_skip = 1;
1938 continue;
1939 } else
1940 inside_skip = 0;
1941
1942 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1943
1944 global = !strncmp(name, "global", 6);
1945
1946 if (dump_cmdline) {
1947 if (first_sect)
1948 log_info("fio ");
1949 if (!global)
1950 log_info("--name=%s ", name);
1951 first_sect = 0;
1952 }
1953
1954 td = get_new_job(global, &def_thread, false, name);
1955 if (!td) {
1956 ret = 1;
1957 break;
1958 }
1959
1960 /*
1961 * Separate multiple job files by a stonewall
1962 */
1963 if (!global && stonewall) {
1964 td->o.stonewall = stonewall;
1965 stonewall = 0;
1966 }
1967
1968 num_opts = 0;
1969 memset(opts, 0, alloc_opts * sizeof(char *));
1970 }
1971 else
1972 skip_fgets = 1;
1973
1974 while (1) {
1975 if (!skip_fgets) {
1976 if (is_buf)
1977 p = strsep(&file, "\n");
1978 else
1979 p = fgets(string, OPT_LEN_MAX, f);
1980 if (!p)
1981 break;
1982 dprint(FD_PARSE, "%s", p);
1983 }
1984 else
1985 skip_fgets = 0;
1986
1987 if (is_empty_or_comment(p))
1988 continue;
1989
1990 strip_blank_front(&p);
1991
1992 /*
1993 * new section, break out and make sure we don't
1994 * fgets() a new line at the top.
1995 */
1996 if (p[0] == '[') {
1997 if (nested) {
1998 log_err("No new sections in included files\n");
1999 ret = 1;
2000 goto out;
2001 }
2002
2003 skip_fgets = 1;
2004 break;
2005 }
2006
2007 strip_blank_end(p);
2008
2009 if (!strncmp(p, "include", strlen("include"))) {
2010 char *filename = p + strlen("include") + 1,
2011 *ts, *full_fn = NULL;
2012
2013 /*
2014 * Allow for the include filename
2015 * specification to be relative.
2016 */
2017 if (access(filename, F_OK) &&
2018 (ts = strrchr(file, '/'))) {
2019 if (asprintf(&full_fn, "%.*s%s",
2020 (int)(ts - file + 1), file,
2021 filename) < 0) {
2022 ret = ENOMEM;
2023 break;
2024 }
2025 filename = full_fn;
2026 }
2027
2028 ret = __parse_jobs_ini(td, filename, is_buf,
2029 stonewall_flag, type, 1,
2030 name, &opts,
2031 &alloc_opts, &num_opts);
2032
2033 if (ret) {
2034 log_err("Error %d while parsing "
2035 "include file %s\n",
2036 ret, filename);
2037 }
2038
2039 if (full_fn)
2040 free(full_fn);
2041
2042 if (ret)
2043 break;
2044
2045 continue;
2046 }
2047
2048 if (num_opts == alloc_opts) {
2049 alloc_opts <<= 1;
2050 opts = realloc(opts,
2051 alloc_opts * sizeof(char *));
2052 }
2053
2054 opts[num_opts] = strdup(p);
2055 num_opts++;
2056 }
2057
2058 if (nested) {
2059 *popts = opts;
2060 *aopts = alloc_opts;
2061 *nopts = num_opts;
2062 goto out;
2063 }
2064
2065 ret = fio_options_parse(td, opts, num_opts);
2066 if (!ret) {
2067 if (dump_cmdline)
2068 dump_opt_list(td);
2069
2070 ret = add_job(td, name, 0, 0, type);
2071 } else {
2072 log_err("fio: job %s dropped\n", name);
2073 put_job(td);
2074 }
2075
2076 for (i = 0; i < num_opts; i++)
2077 free(opts[i]);
2078 num_opts = 0;
2079 } while (!ret);
2080
2081 if (dump_cmdline)
2082 log_info("\n");
2083
2084 i = 0;
2085 while (i < nr_job_sections) {
2086 free(job_sections[i]);
2087 i++;
2088 }
2089
2090 free(opts);
2091out:
2092 free(string);
2093 if (!nested)
2094 free(name);
2095 if (!is_buf && f != stdin)
2096 fclose(f);
2097 return ret;
2098}
2099
2100int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2101{
2102 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2103 0, NULL, NULL, NULL, NULL);
2104}
2105
2106static int fill_def_thread(void)
2107{
2108 memset(&def_thread, 0, sizeof(def_thread));
2109 INIT_FLIST_HEAD(&def_thread.opt_list);
2110
2111 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2112 def_thread.o.error_dump = 1;
2113
2114 /*
2115 * fill default options
2116 */
2117 fio_fill_default_options(&def_thread);
2118 return 0;
2119}
2120
2121static void show_debug_categories(void)
2122{
2123#ifdef FIO_INC_DEBUG
2124 const struct debug_level *dl = &debug_levels[0];
2125 int curlen, first = 1;
2126
2127 curlen = 0;
2128 while (dl->name) {
2129 int has_next = (dl + 1)->name != NULL;
2130
2131 if (first || curlen + strlen(dl->name) >= 80) {
2132 if (!first) {
2133 printf("\n");
2134 curlen = 0;
2135 }
2136 curlen += printf("\t\t\t%s", dl->name);
2137 curlen += 3 * (8 - 1);
2138 if (has_next)
2139 curlen += printf(",");
2140 } else {
2141 curlen += printf("%s", dl->name);
2142 if (has_next)
2143 curlen += printf(",");
2144 }
2145 dl++;
2146 first = 0;
2147 }
2148 printf("\n");
2149#endif
2150}
2151
2152/*
2153 * Following options aren't printed by usage().
2154 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2155 * --latency-log - Deprecated option.
2156 */
2157static void usage(const char *name)
2158{
2159 printf("%s\n", fio_version_string);
2160 printf("%s [options] [job options] <job file(s)>\n", name);
2161 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2162 show_debug_categories();
2163 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2164 printf(" --merge-blktrace-only\tMerge blktraces only, don't start any IO\n");
2165 printf(" --output\t\tWrite output to file\n");
2166 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2167 printf(" --minimal\t\tMinimal (terse) output\n");
2168 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2169 printf(" --terse-version=type\tSet terse version output format"
2170 " (default 3, or 2 or 4)\n");
2171 printf(" --version\t\tPrint version info and exit\n");
2172 printf(" --help\t\tPrint this page\n");
2173 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2174 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2175 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2176 " them\n");
2177 printf(" --enghelp=engine\tPrint ioengine help, or list"
2178 " available ioengines\n");
2179 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2180 " cmd\n");
2181 printf(" --showcmd\t\tTurn a job file into command line options\n");
2182 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2183 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2184 printf(" --eta-newline=t\tForce a new line for every 't'");
2185 printf(" period passed\n");
2186 printf(" --status-interval=t\tForce full status dump every");
2187 printf(" 't' period passed\n");
2188 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2189 " writes\n");
2190 printf(" --section=name\tOnly run specified section in job file,"
2191 " multiple sections can be specified\n");
2192 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2193 " (def 16384)\n");
2194 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2195 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2196 printf(" --server=args\t\tStart a backend fio server\n");
2197 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2198 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2199 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2200 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2201 "\t\t\t(option=system,percpu) or run unit work\n"
2202 "\t\t\tcalibration only (option=calibrate)\n");
2203#ifdef CONFIG_ZLIB
2204 printf(" --inflate-log=log\tInflate and output compressed log\n");
2205#endif
2206 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2207 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2208 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2209 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2210 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2211 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2212}
2213
2214#ifdef FIO_INC_DEBUG
2215const struct debug_level debug_levels[] = {
2216 { .name = "process",
2217 .help = "Process creation/exit logging",
2218 .shift = FD_PROCESS,
2219 },
2220 { .name = "file",
2221 .help = "File related action logging",
2222 .shift = FD_FILE,
2223 },
2224 { .name = "io",
2225 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2226 .shift = FD_IO,
2227 },
2228 { .name = "mem",
2229 .help = "Memory allocation/freeing logging",
2230 .shift = FD_MEM,
2231 },
2232 { .name = "blktrace",
2233 .help = "blktrace action logging",
2234 .shift = FD_BLKTRACE,
2235 },
2236 { .name = "verify",
2237 .help = "IO verification action logging",
2238 .shift = FD_VERIFY,
2239 },
2240 { .name = "random",
2241 .help = "Random generation logging",
2242 .shift = FD_RANDOM,
2243 },
2244 { .name = "parse",
2245 .help = "Parser logging",
2246 .shift = FD_PARSE,
2247 },
2248 { .name = "diskutil",
2249 .help = "Disk utility logging actions",
2250 .shift = FD_DISKUTIL,
2251 },
2252 { .name = "job",
2253 .help = "Logging related to creating/destroying jobs",
2254 .shift = FD_JOB,
2255 },
2256 { .name = "mutex",
2257 .help = "Mutex logging",
2258 .shift = FD_MUTEX
2259 },
2260 { .name = "profile",
2261 .help = "Logging related to profiles",
2262 .shift = FD_PROFILE,
2263 },
2264 { .name = "time",
2265 .help = "Logging related to time keeping functions",
2266 .shift = FD_TIME,
2267 },
2268 { .name = "net",
2269 .help = "Network logging",
2270 .shift = FD_NET,
2271 },
2272 { .name = "rate",
2273 .help = "Rate logging",
2274 .shift = FD_RATE,
2275 },
2276 { .name = "compress",
2277 .help = "Log compression logging",
2278 .shift = FD_COMPRESS,
2279 },
2280 { .name = "steadystate",
2281 .help = "Steady state detection logging",
2282 .shift = FD_STEADYSTATE,
2283 },
2284 { .name = "helperthread",
2285 .help = "Helper thread logging",
2286 .shift = FD_HELPERTHREAD,
2287 },
2288 { .name = "zbd",
2289 .help = "Zoned Block Device logging",
2290 .shift = FD_ZBD,
2291 },
2292 { .name = NULL, },
2293};
2294
2295static int set_debug(const char *string)
2296{
2297 const struct debug_level *dl;
2298 char *p = (char *) string;
2299 char *opt;
2300 int i;
2301
2302 if (!string)
2303 return 0;
2304
2305 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2306 log_info("fio: dumping debug options:");
2307 for (i = 0; debug_levels[i].name; i++) {
2308 dl = &debug_levels[i];
2309 log_info("%s,", dl->name);
2310 }
2311 log_info("all\n");
2312 return 1;
2313 }
2314
2315 while ((opt = strsep(&p, ",")) != NULL) {
2316 int found = 0;
2317
2318 if (!strncmp(opt, "all", 3)) {
2319 log_info("fio: set all debug options\n");
2320 fio_debug = ~0UL;
2321 continue;
2322 }
2323
2324 for (i = 0; debug_levels[i].name; i++) {
2325 dl = &debug_levels[i];
2326 found = !strncmp(opt, dl->name, strlen(dl->name));
2327 if (!found)
2328 continue;
2329
2330 if (dl->shift == FD_JOB) {
2331 opt = strchr(opt, ':');
2332 if (!opt) {
2333 log_err("fio: missing job number\n");
2334 break;
2335 }
2336 opt++;
2337 fio_debug_jobno = atoi(opt);
2338 log_info("fio: set debug jobno %d\n",
2339 fio_debug_jobno);
2340 } else {
2341 log_info("fio: set debug option %s\n", opt);
2342 fio_debug |= (1UL << dl->shift);
2343 }
2344 break;
2345 }
2346
2347 if (!found)
2348 log_err("fio: debug mask %s not found\n", opt);
2349 }
2350 return 0;
2351}
2352#else
2353static int set_debug(const char *string)
2354{
2355 log_err("fio: debug tracing not included in build\n");
2356 return 1;
2357}
2358#endif
2359
2360static void fio_options_fill_optstring(void)
2361{
2362 char *ostr = cmd_optstr;
2363 int i, c;
2364
2365 c = i = 0;
2366 while (l_opts[i].name) {
2367 ostr[c++] = l_opts[i].val;
2368 if (l_opts[i].has_arg == required_argument)
2369 ostr[c++] = ':';
2370 else if (l_opts[i].has_arg == optional_argument) {
2371 ostr[c++] = ':';
2372 ostr[c++] = ':';
2373 }
2374 i++;
2375 }
2376 ostr[c] = '\0';
2377}
2378
2379static int client_flag_set(char c)
2380{
2381 int i;
2382
2383 i = 0;
2384 while (l_opts[i].name) {
2385 int val = l_opts[i].val;
2386
2387 if (c == (val & 0xff))
2388 return (val & FIO_CLIENT_FLAG);
2389
2390 i++;
2391 }
2392
2393 return 0;
2394}
2395
2396static void parse_cmd_client(void *client, char *opt)
2397{
2398 fio_client_add_cmd_option(client, opt);
2399}
2400
2401static void show_closest_option(const char *name)
2402{
2403 int best_option, best_distance;
2404 int i, distance;
2405
2406 while (*name == '-')
2407 name++;
2408
2409 best_option = -1;
2410 best_distance = INT_MAX;
2411 i = 0;
2412 while (l_opts[i].name) {
2413 distance = string_distance(name, l_opts[i].name);
2414 if (distance < best_distance) {
2415 best_distance = distance;
2416 best_option = i;
2417 }
2418 i++;
2419 }
2420
2421 if (best_option != -1 && string_distance_ok(name, best_distance))
2422 log_err("Did you mean %s?\n", l_opts[best_option].name);
2423}
2424
2425static int parse_output_format(const char *optarg)
2426{
2427 char *p, *orig, *opt;
2428 int ret = 0;
2429
2430 p = orig = strdup(optarg);
2431
2432 output_format = 0;
2433
2434 while ((opt = strsep(&p, ",")) != NULL) {
2435 if (!strcmp(opt, "minimal") ||
2436 !strcmp(opt, "terse") ||
2437 !strcmp(opt, "csv"))
2438 output_format |= FIO_OUTPUT_TERSE;
2439 else if (!strcmp(opt, "json"))
2440 output_format |= FIO_OUTPUT_JSON;
2441 else if (!strcmp(opt, "json+"))
2442 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2443 else if (!strcmp(opt, "normal"))
2444 output_format |= FIO_OUTPUT_NORMAL;
2445 else {
2446 log_err("fio: invalid output format %s\n", opt);
2447 ret = 1;
2448 break;
2449 }
2450 }
2451
2452 free(orig);
2453 return ret;
2454}
2455
2456int parse_cmd_line(int argc, char *argv[], int client_type)
2457{
2458 struct thread_data *td = NULL;
2459 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2460 char *ostr = cmd_optstr;
2461 char *pid_file = NULL;
2462 void *cur_client = NULL;
2463 bool backend = false;
2464
2465 /*
2466 * Reset optind handling, since we may call this multiple times
2467 * for the backend.
2468 */
2469 optind = 1;
2470
2471 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2472 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2473 parse_cmd_client(cur_client, argv[optind - 1]);
2474 c &= ~FIO_CLIENT_FLAG;
2475 }
2476
2477 switch (c) {
2478 case 'a':
2479 smalloc_pool_size = atoi(optarg);
2480 smalloc_pool_size <<= 10;
2481 sinit();
2482 break;
2483 case 'l':
2484 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2485 do_exit++;
2486 exit_val = 1;
2487 break;
2488 case 'b':
2489 write_bw_log = true;
2490 break;
2491 case 'o': {
2492 FILE *tmp;
2493
2494 if (f_out && f_out != stdout)
2495 fclose(f_out);
2496
2497 tmp = fopen(optarg, "w+");
2498 if (!tmp) {
2499 log_err("fio: output file open error: %s\n", strerror(errno));
2500 exit_val = 1;
2501 do_exit++;
2502 break;
2503 }
2504 f_err = f_out = tmp;
2505 break;
2506 }
2507 case 'm':
2508 output_format = FIO_OUTPUT_TERSE;
2509 break;
2510 case 'F':
2511 if (parse_output_format(optarg)) {
2512 log_err("fio: failed parsing output-format\n");
2513 exit_val = 1;
2514 do_exit++;
2515 break;
2516 }
2517 break;
2518 case 'f':
2519 output_format |= FIO_OUTPUT_TERSE;
2520 break;
2521 case 'h':
2522 did_arg = true;
2523 if (!cur_client) {
2524 usage(argv[0]);
2525 do_exit++;
2526 }
2527 break;
2528 case 'c':
2529 did_arg = true;
2530 if (!cur_client) {
2531 fio_show_option_help(optarg);
2532 do_exit++;
2533 }
2534 break;
2535 case 'i':
2536 did_arg = true;
2537 if (!cur_client) {
2538 fio_show_ioengine_help(optarg);
2539 do_exit++;
2540 }
2541 break;
2542 case 's':
2543 did_arg = true;
2544 dump_cmdline = true;
2545 break;
2546 case 'r':
2547 read_only = 1;
2548 break;
2549 case 'v':
2550 did_arg = true;
2551 if (!cur_client) {
2552 log_info("%s\n", fio_version_string);
2553 do_exit++;
2554 }
2555 break;
2556 case 'V':
2557 terse_version = atoi(optarg);
2558 if (!(terse_version >= 2 && terse_version <= 5)) {
2559 log_err("fio: bad terse version format\n");
2560 exit_val = 1;
2561 do_exit++;
2562 }
2563 break;
2564 case 'e':
2565 if (!strcmp("always", optarg))
2566 eta_print = FIO_ETA_ALWAYS;
2567 else if (!strcmp("never", optarg))
2568 eta_print = FIO_ETA_NEVER;
2569 break;
2570 case 'E': {
2571 long long t = 0;
2572
2573 if (check_str_time(optarg, &t, 1)) {
2574 log_err("fio: failed parsing eta time %s\n", optarg);
2575 exit_val = 1;
2576 do_exit++;
2577 break;
2578 }
2579 eta_new_line = t / 1000;
2580 if (!eta_new_line) {
2581 log_err("fio: eta new line time too short\n");
2582 exit_val = 1;
2583 do_exit++;
2584 }
2585 break;
2586 }
2587 case 'O': {
2588 long long t = 0;
2589
2590 if (check_str_time(optarg, &t, 1)) {
2591 log_err("fio: failed parsing eta interval %s\n", optarg);
2592 exit_val = 1;
2593 do_exit++;
2594 break;
2595 }
2596 eta_interval_msec = t / 1000;
2597 if (eta_interval_msec < DISK_UTIL_MSEC) {
2598 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2599 exit_val = 1;
2600 do_exit++;
2601 }
2602 break;
2603 }
2604 case 'd':
2605 if (set_debug(optarg))
2606 do_exit++;
2607 break;
2608 case 'P':
2609 did_arg = true;
2610 parse_only = true;
2611 break;
2612 case 'x': {
2613 size_t new_size;
2614
2615 if (!strcmp(optarg, "global")) {
2616 log_err("fio: can't use global as only "
2617 "section\n");
2618 do_exit++;
2619 exit_val = 1;
2620 break;
2621 }
2622 new_size = (nr_job_sections + 1) * sizeof(char *);
2623 job_sections = realloc(job_sections, new_size);
2624 job_sections[nr_job_sections] = strdup(optarg);
2625 nr_job_sections++;
2626 break;
2627 }
2628#ifdef CONFIG_ZLIB
2629 case 'X':
2630 exit_val = iolog_file_inflate(optarg);
2631 did_arg = true;
2632 do_exit++;
2633 break;
2634#endif
2635 case 'p':
2636 did_arg = true;
2637 if (exec_profile)
2638 free(exec_profile);
2639 exec_profile = strdup(optarg);
2640 break;
2641 case FIO_GETOPT_JOB: {
2642 const char *opt = l_opts[lidx].name;
2643 char *val = optarg;
2644
2645 if (!strncmp(opt, "name", 4) && td) {
2646 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2647 if (ret)
2648 goto out_free;
2649 td = NULL;
2650 did_arg = true;
2651 }
2652 if (!td) {
2653 int is_section = !strncmp(opt, "name", 4);
2654 int global = 0;
2655
2656 if (!is_section || !strncmp(val, "global", 6))
2657 global = 1;
2658
2659 if (is_section && skip_this_section(val))
2660 continue;
2661
2662 td = get_new_job(global, &def_thread, true, NULL);
2663 if (!td || ioengine_load(td)) {
2664 if (td) {
2665 put_job(td);
2666 td = NULL;
2667 }
2668 do_exit++;
2669 exit_val = 1;
2670 break;
2671 }
2672 fio_options_set_ioengine_opts(l_opts, td);
2673 }
2674
2675 if ((!val || !strlen(val)) &&
2676 l_opts[lidx].has_arg == required_argument) {
2677 log_err("fio: option %s requires an argument\n", opt);
2678 ret = 1;
2679 } else
2680 ret = fio_cmd_option_parse(td, opt, val);
2681
2682 if (ret) {
2683 if (td) {
2684 put_job(td);
2685 td = NULL;
2686 }
2687 do_exit++;
2688 exit_val = 1;
2689 }
2690
2691 if (!ret && !strcmp(opt, "ioengine")) {
2692 if (ioengine_load(td)) {
2693 put_job(td);
2694 td = NULL;
2695 do_exit++;
2696 exit_val = 1;
2697 break;
2698 }
2699 fio_options_set_ioengine_opts(l_opts, td);
2700 }
2701 break;
2702 }
2703 case FIO_GETOPT_IOENGINE: {
2704 const char *opt = l_opts[lidx].name;
2705 char *val = optarg;
2706
2707 if (!td)
2708 break;
2709
2710 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2711 break;
2712 }
2713 case 'w':
2714 warnings_fatal = 1;
2715 break;
2716 case 'j':
2717 max_jobs = atoi(optarg);
2718 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2719 log_err("fio: invalid max jobs: %d\n", max_jobs);
2720 do_exit++;
2721 exit_val = 1;
2722 }
2723 break;
2724 case 'S':
2725 did_arg = true;
2726#ifndef CONFIG_NO_SHM
2727 if (nr_clients) {
2728 log_err("fio: can't be both client and server\n");
2729 do_exit++;
2730 exit_val = 1;
2731 break;
2732 }
2733 if (optarg)
2734 fio_server_set_arg(optarg);
2735 is_backend = true;
2736 backend = true;
2737#else
2738 log_err("fio: client/server requires SHM support\n");
2739 do_exit++;
2740 exit_val = 1;
2741#endif
2742 break;
2743 case 'D':
2744 if (pid_file)
2745 free(pid_file);
2746 pid_file = strdup(optarg);
2747 break;
2748 case 'I':
2749 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2750 /* exit on error and calibration only */
2751 did_arg = true;
2752 do_exit++;
2753 if (ret == -1)
2754 exit_val = 1;
2755 }
2756 break;
2757 case 'C':
2758 did_arg = true;
2759 if (is_backend) {
2760 log_err("fio: can't be both client and server\n");
2761 do_exit++;
2762 exit_val = 1;
2763 break;
2764 }
2765 /* if --client parameter contains a pathname */
2766 if (0 == access(optarg, R_OK)) {
2767 /* file contains a list of host addrs or names */
2768 char hostaddr[PATH_MAX] = {0};
2769 char formatstr[8];
2770 FILE * hostf = fopen(optarg, "r");
2771 if (!hostf) {
2772 log_err("fio: could not open client list file %s for read\n", optarg);
2773 do_exit++;
2774 exit_val = 1;
2775 break;
2776 }
2777 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2778 /*
2779 * read at most PATH_MAX-1 chars from each
2780 * record in this file
2781 */
2782 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2783 /* expect EVERY host in file to be valid */
2784 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2785 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2786 do_exit++;
2787 exit_val = 1;
2788 break;
2789 }
2790 }
2791 fclose(hostf);
2792 break; /* no possibility of job file for "this client only" */
2793 }
2794 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2795 log_err("fio: failed adding client %s\n", optarg);
2796 do_exit++;
2797 exit_val = 1;
2798 break;
2799 }
2800 /*
2801 * If the next argument exists and isn't an option,
2802 * assume it's a job file for this client only.
2803 */
2804 while (optind < argc) {
2805 if (!strncmp(argv[optind], "--", 2) ||
2806 !strncmp(argv[optind], "-", 1))
2807 break;
2808
2809 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2810 break;
2811 optind++;
2812 }
2813 break;
2814 case 'R':
2815 did_arg = true;
2816 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2817 do_exit++;
2818 exit_val = 1;
2819 }
2820 break;
2821 case 'T':
2822 did_arg = true;
2823 do_exit++;
2824 exit_val = fio_monotonic_clocktest(1);
2825 break;
2826 case 'G':
2827 did_arg = true;
2828 do_exit++;
2829 exit_val = fio_crctest(optarg);
2830 break;
2831 case 'M':
2832 did_arg = true;
2833 do_exit++;
2834 exit_val = fio_memcpy_test(optarg);
2835 break;
2836 case 'L': {
2837 long long val;
2838
2839 if (check_str_time(optarg, &val, 1)) {
2840 log_err("fio: failed parsing time %s\n", optarg);
2841 do_exit++;
2842 exit_val = 1;
2843 break;
2844 }
2845 if (val < 1000) {
2846 log_err("fio: status interval too small\n");
2847 do_exit++;
2848 exit_val = 1;
2849 }
2850 status_interval = val / 1000;
2851 break;
2852 }
2853 case 'W':
2854 if (trigger_file)
2855 free(trigger_file);
2856 trigger_file = strdup(optarg);
2857 break;
2858 case 'H':
2859 if (trigger_cmd)
2860 free(trigger_cmd);
2861 trigger_cmd = strdup(optarg);
2862 break;
2863 case 'J':
2864 if (trigger_remote_cmd)
2865 free(trigger_remote_cmd);
2866 trigger_remote_cmd = strdup(optarg);
2867 break;
2868 case 'K':
2869 if (aux_path)
2870 free(aux_path);
2871 aux_path = strdup(optarg);
2872 break;
2873 case 'B':
2874 if (check_str_time(optarg, &trigger_timeout, 1)) {
2875 log_err("fio: failed parsing time %s\n", optarg);
2876 do_exit++;
2877 exit_val = 1;
2878 }
2879 trigger_timeout /= 1000000;
2880 break;
2881
2882 case 'A':
2883 did_arg = true;
2884 merge_blktrace_only = true;
2885 break;
2886 case '?':
2887 log_err("%s: unrecognized option '%s'\n", argv[0],
2888 argv[optind - 1]);
2889 show_closest_option(argv[optind - 1]);
2890 /* fall through */
2891 default:
2892 do_exit++;
2893 exit_val = 1;
2894 break;
2895 }
2896 if (do_exit)
2897 break;
2898 }
2899
2900 if (do_exit && !(is_backend || nr_clients))
2901 exit(exit_val);
2902
2903 if (nr_clients && fio_clients_connect())
2904 exit(1);
2905
2906 if (is_backend && backend)
2907 return fio_start_server(pid_file);
2908 else if (pid_file)
2909 free(pid_file);
2910
2911 if (td) {
2912 if (!ret) {
2913 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2914 if (ret)
2915 exit(1);
2916 }
2917 }
2918
2919 while (!ret && optind < argc) {
2920 ini_idx++;
2921 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2922 ini_file[ini_idx - 1] = strdup(argv[optind]);
2923 optind++;
2924 }
2925
2926out_free:
2927 return ini_idx;
2928}
2929
2930int fio_init_options(void)
2931{
2932 f_out = stdout;
2933 f_err = stderr;
2934
2935 fio_options_fill_optstring();
2936 fio_options_dup_and_init(l_opts);
2937
2938 atexit(free_shm);
2939
2940 if (fill_def_thread())
2941 return 1;
2942
2943 return 0;
2944}
2945
2946extern int fio_check_options(struct thread_options *);
2947
2948int parse_options(int argc, char *argv[])
2949{
2950 const int type = FIO_CLIENT_TYPE_CLI;
2951 int job_files, i;
2952
2953 if (fio_init_options())
2954 return 1;
2955 if (fio_test_cconv(&def_thread.o))
2956 log_err("fio: failed internal cconv test\n");
2957
2958 job_files = parse_cmd_line(argc, argv, type);
2959
2960 if (job_files > 0) {
2961 for (i = 0; i < job_files; i++) {
2962 if (i && fill_def_thread())
2963 return 1;
2964 if (nr_clients) {
2965 if (fio_clients_send_ini(ini_file[i]))
2966 return 1;
2967 free(ini_file[i]);
2968 } else if (!is_backend) {
2969 if (parse_jobs_ini(ini_file[i], 0, i, type))
2970 return 1;
2971 free(ini_file[i]);
2972 }
2973 }
2974 } else if (nr_clients) {
2975 if (fill_def_thread())
2976 return 1;
2977 if (fio_clients_send_ini(NULL))
2978 return 1;
2979 }
2980
2981 free(ini_file);
2982 fio_options_free(&def_thread);
2983 filesetup_mem_free();
2984
2985 if (!thread_number) {
2986 if (parse_dryrun())
2987 return 0;
2988 if (exec_profile)
2989 return 0;
2990 if (is_backend || nr_clients)
2991 return 0;
2992 if (did_arg)
2993 return 0;
2994
2995 log_err("No job(s) defined\n\n");
2996 usage(argv[0]);
2997 return 1;
2998 }
2999
3000 if (output_format & FIO_OUTPUT_NORMAL)
3001 log_info("%s\n", fio_version_string);
3002
3003 return 0;
3004}
3005
3006void options_default_fill(struct thread_options *o)
3007{
3008 memcpy(o, &def_thread.o, sizeof(*o));
3009}
3010
3011struct thread_data *get_global_options(void)
3012{
3013 return &def_thread;
3014}