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