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