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