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