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