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