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