Add basic write/read-and-verify example job file
[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
29#include "oslib/getopt.h"
30#include "oslib/strcasestr.h"
31
32#include "crc/test.h"
33
34const char fio_version_string[] = FIO_VERSION;
35
36#define FIO_RANDSEED (0xb1899bedUL)
37
38static char **ini_file;
39static int max_jobs = FIO_MAX_JOBS;
40static int dump_cmdline;
41static long long def_timeout;
42static int parse_only;
43
44static struct thread_data def_thread;
45struct thread_data *threads = NULL;
46static char **job_sections;
47static int nr_job_sections;
48
49int exitall_on_terminate = 0;
50int output_format = FIO_OUTPUT_NORMAL;
51int eta_print = FIO_ETA_AUTO;
52int eta_new_line = 0;
53FILE *f_out = NULL;
54FILE *f_err = NULL;
55char *exec_profile = NULL;
56int warnings_fatal = 0;
57int terse_version = 3;
58int is_backend = 0;
59int nr_clients = 0;
60int log_syslog = 0;
61
62int write_bw_log = 0;
63int read_only = 0;
64int status_interval = 0;
65
66char *trigger_file = NULL;
67long long trigger_timeout = 0;
68char *trigger_cmd = NULL;
69char *trigger_remote_cmd = NULL;
70
71char *aux_path = NULL;
72
73static int prev_group_jobs;
74
75unsigned long fio_debug = 0;
76unsigned int fio_debug_jobno = -1;
77unsigned int *fio_debug_jobp = NULL;
78
79static char cmd_optstr[256];
80static int did_arg;
81
82#define FIO_CLIENT_FLAG (1 << 16)
83
84/*
85 * Command line options. These will contain the above, plus a few
86 * extra that only pertain to fio itself and not jobs.
87 */
88static struct option l_opts[FIO_NR_OPTIONS] = {
89 {
90 .name = (char *) "output",
91 .has_arg = required_argument,
92 .val = 'o' | FIO_CLIENT_FLAG,
93 },
94 {
95 .name = (char *) "timeout",
96 .has_arg = required_argument,
97 .val = 't' | FIO_CLIENT_FLAG,
98 },
99 {
100 .name = (char *) "latency-log",
101 .has_arg = required_argument,
102 .val = 'l' | FIO_CLIENT_FLAG,
103 },
104 {
105 .name = (char *) "bandwidth-log",
106 .has_arg = required_argument,
107 .val = 'b' | FIO_CLIENT_FLAG,
108 },
109 {
110 .name = (char *) "minimal",
111 .has_arg = no_argument,
112 .val = 'm' | FIO_CLIENT_FLAG,
113 },
114 {
115 .name = (char *) "output-format",
116 .has_arg = required_argument,
117 .val = 'F' | FIO_CLIENT_FLAG,
118 },
119 {
120 .name = (char *) "append-terse",
121 .has_arg = optional_argument,
122 .val = 'f',
123 },
124 {
125 .name = (char *) "version",
126 .has_arg = no_argument,
127 .val = 'v' | FIO_CLIENT_FLAG,
128 },
129 {
130 .name = (char *) "help",
131 .has_arg = no_argument,
132 .val = 'h' | FIO_CLIENT_FLAG,
133 },
134 {
135 .name = (char *) "cmdhelp",
136 .has_arg = optional_argument,
137 .val = 'c' | FIO_CLIENT_FLAG,
138 },
139 {
140 .name = (char *) "enghelp",
141 .has_arg = optional_argument,
142 .val = 'i' | FIO_CLIENT_FLAG,
143 },
144 {
145 .name = (char *) "showcmd",
146 .has_arg = no_argument,
147 .val = 's' | FIO_CLIENT_FLAG,
148 },
149 {
150 .name = (char *) "readonly",
151 .has_arg = no_argument,
152 .val = 'r' | FIO_CLIENT_FLAG,
153 },
154 {
155 .name = (char *) "eta",
156 .has_arg = required_argument,
157 .val = 'e' | FIO_CLIENT_FLAG,
158 },
159 {
160 .name = (char *) "eta-newline",
161 .has_arg = required_argument,
162 .val = 'E' | FIO_CLIENT_FLAG,
163 },
164 {
165 .name = (char *) "debug",
166 .has_arg = required_argument,
167 .val = 'd' | FIO_CLIENT_FLAG,
168 },
169 {
170 .name = (char *) "parse-only",
171 .has_arg = no_argument,
172 .val = 'P' | FIO_CLIENT_FLAG,
173 },
174 {
175 .name = (char *) "section",
176 .has_arg = required_argument,
177 .val = 'x' | FIO_CLIENT_FLAG,
178 },
179#ifdef CONFIG_ZLIB
180 {
181 .name = (char *) "inflate-log",
182 .has_arg = required_argument,
183 .val = 'X' | FIO_CLIENT_FLAG,
184 },
185#endif
186 {
187 .name = (char *) "alloc-size",
188 .has_arg = required_argument,
189 .val = 'a' | FIO_CLIENT_FLAG,
190 },
191 {
192 .name = (char *) "profile",
193 .has_arg = required_argument,
194 .val = 'p' | FIO_CLIENT_FLAG,
195 },
196 {
197 .name = (char *) "warnings-fatal",
198 .has_arg = no_argument,
199 .val = 'w' | FIO_CLIENT_FLAG,
200 },
201 {
202 .name = (char *) "max-jobs",
203 .has_arg = required_argument,
204 .val = 'j' | FIO_CLIENT_FLAG,
205 },
206 {
207 .name = (char *) "terse-version",
208 .has_arg = required_argument,
209 .val = 'V' | FIO_CLIENT_FLAG,
210 },
211 {
212 .name = (char *) "server",
213 .has_arg = optional_argument,
214 .val = 'S',
215 },
216 { .name = (char *) "daemonize",
217 .has_arg = required_argument,
218 .val = 'D',
219 },
220 {
221 .name = (char *) "client",
222 .has_arg = required_argument,
223 .val = 'C',
224 },
225 {
226 .name = (char *) "remote-config",
227 .has_arg = required_argument,
228 .val = 'R',
229 },
230 {
231 .name = (char *) "cpuclock-test",
232 .has_arg = no_argument,
233 .val = 'T',
234 },
235 {
236 .name = (char *) "crctest",
237 .has_arg = optional_argument,
238 .val = 'G',
239 },
240 {
241 .name = (char *) "idle-prof",
242 .has_arg = required_argument,
243 .val = 'I',
244 },
245 {
246 .name = (char *) "status-interval",
247 .has_arg = required_argument,
248 .val = 'L',
249 },
250 {
251 .name = (char *) "trigger-file",
252 .has_arg = required_argument,
253 .val = 'W',
254 },
255 {
256 .name = (char *) "trigger-timeout",
257 .has_arg = required_argument,
258 .val = 'B',
259 },
260 {
261 .name = (char *) "trigger",
262 .has_arg = required_argument,
263 .val = 'H',
264 },
265 {
266 .name = (char *) "trigger-remote",
267 .has_arg = required_argument,
268 .val = 'J',
269 },
270 {
271 .name = (char *) "aux-path",
272 .has_arg = required_argument,
273 .val = 'K',
274 },
275 {
276 .name = NULL,
277 },
278};
279
280void free_threads_shm(void)
281{
282 if (threads) {
283 void *tp = threads;
284#ifndef CONFIG_NO_SHM
285 struct shmid_ds sbuf;
286
287 threads = NULL;
288 shmdt(tp);
289 shmctl(shm_id, IPC_RMID, &sbuf);
290 shm_id = -1;
291#else
292 threads = NULL;
293 free(tp);
294#endif
295 }
296}
297
298static void free_shm(void)
299{
300 if (threads) {
301 file_hash_exit();
302 flow_exit();
303 fio_debug_jobp = NULL;
304 free_threads_shm();
305 }
306
307 free(trigger_file);
308 free(trigger_cmd);
309 free(trigger_remote_cmd);
310 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
311
312 options_free(fio_options, &def_thread);
313 fio_filelock_exit();
314 scleanup();
315}
316
317/*
318 * The thread area is shared between the main process and the job
319 * threads/processes. So setup a shared memory segment that will hold
320 * all the job info. We use the end of the region for keeping track of
321 * open files across jobs, for file sharing.
322 */
323static int setup_thread_area(void)
324{
325 void *hash;
326
327 if (threads)
328 return 0;
329
330 /*
331 * 1024 is too much on some machines, scale max_jobs if
332 * we get a failure that looks like too large a shm segment
333 */
334 do {
335 size_t size = max_jobs * sizeof(struct thread_data);
336
337 size += file_hash_size;
338 size += sizeof(unsigned int);
339
340#ifndef CONFIG_NO_SHM
341 shm_id = shmget(0, size, IPC_CREAT | 0600);
342 if (shm_id != -1)
343 break;
344 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
345 perror("shmget");
346 break;
347 }
348#else
349 threads = malloc(size);
350 if (threads)
351 break;
352#endif
353
354 max_jobs >>= 1;
355 } while (max_jobs);
356
357#ifndef CONFIG_NO_SHM
358 if (shm_id == -1)
359 return 1;
360
361 threads = shmat(shm_id, NULL, 0);
362 if (threads == (void *) -1) {
363 perror("shmat");
364 return 1;
365 }
366#endif
367
368 memset(threads, 0, max_jobs * sizeof(struct thread_data));
369 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
370 fio_debug_jobp = (void *) hash + file_hash_size;
371 *fio_debug_jobp = -1;
372 file_hash_init(hash);
373
374 flow_init();
375
376 return 0;
377}
378
379static void set_cmd_options(struct thread_data *td)
380{
381 struct thread_options *o = &td->o;
382
383 if (!o->timeout)
384 o->timeout = def_timeout;
385}
386
387static void dump_print_option(struct print_option *p)
388{
389 const char *delim;
390
391 if (!strcmp("description", p->name))
392 delim = "\"";
393 else
394 delim = "";
395
396 log_info("--%s%s", p->name, p->value ? "" : " ");
397 if (p->value)
398 log_info("=%s%s%s ", delim, p->value, delim);
399}
400
401static void dump_opt_list(struct thread_data *td)
402{
403 struct flist_head *entry;
404 struct print_option *p;
405
406 if (flist_empty(&td->opt_list))
407 return;
408
409 flist_for_each(entry, &td->opt_list) {
410 p = flist_entry(entry, struct print_option, list);
411 dump_print_option(p);
412 }
413}
414
415static void fio_dump_options_free(struct thread_data *td)
416{
417 while (!flist_empty(&td->opt_list)) {
418 struct print_option *p;
419
420 p = flist_first_entry(&td->opt_list, struct print_option, list);
421 flist_del_init(&p->list);
422 free(p->name);
423 free(p->value);
424 free(p);
425 }
426}
427
428static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
429{
430 struct flist_head *entry;
431
432 if (flist_empty(&src->opt_list))
433 return;
434
435 flist_for_each(entry, &src->opt_list) {
436 struct print_option *srcp, *dstp;
437
438 srcp = flist_entry(entry, struct print_option, list);
439 dstp = malloc(sizeof(*dstp));
440 dstp->name = strdup(srcp->name);
441 if (srcp->value)
442 dstp->value = strdup(srcp->value);
443 else
444 dstp->value = NULL;
445 flist_add_tail(&dstp->list, &dst->opt_list);
446 }
447}
448
449/*
450 * Return a free job structure.
451 */
452static struct thread_data *get_new_job(int global, struct thread_data *parent,
453 int preserve_eo, const char *jobname)
454{
455 struct thread_data *td;
456
457 if (global) {
458 set_cmd_options(&def_thread);
459 return &def_thread;
460 }
461 if (setup_thread_area()) {
462 log_err("error: failed to setup shm segment\n");
463 return NULL;
464 }
465 if (thread_number >= max_jobs) {
466 log_err("error: maximum number of jobs (%d) reached.\n",
467 max_jobs);
468 return NULL;
469 }
470
471 td = &threads[thread_number++];
472 *td = *parent;
473
474 INIT_FLIST_HEAD(&td->opt_list);
475 if (parent != &def_thread)
476 copy_opt_list(td, parent);
477
478 td->io_ops = NULL;
479 if (!preserve_eo)
480 td->eo = NULL;
481
482 td->o.uid = td->o.gid = -1U;
483
484 dup_files(td, parent);
485 fio_options_mem_dupe(td);
486
487 profile_add_hooks(td);
488
489 td->thread_number = thread_number;
490 td->subjob_number = 0;
491
492 if (jobname)
493 td->o.name = strdup(jobname);
494
495 if (!parent->o.group_reporting || parent == &def_thread)
496 stat_number++;
497
498 set_cmd_options(td);
499 return td;
500}
501
502static void put_job(struct thread_data *td)
503{
504 if (td == &def_thread)
505 return;
506
507 profile_td_exit(td);
508 flow_exit_job(td);
509
510 if (td->error)
511 log_info("fio: %s\n", td->verror);
512
513 fio_options_free(td);
514 fio_dump_options_free(td);
515 if (td->io_ops)
516 free_ioengine(td);
517
518 if (td->o.name)
519 free(td->o.name);
520
521 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
522 thread_number--;
523}
524
525static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
526{
527 unsigned int bs = td->o.min_bs[ddir];
528
529 assert(ddir_rw(ddir));
530
531 if (td->o.rate[ddir])
532 td->rate_bps[ddir] = td->o.rate[ddir];
533 else
534 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
535
536 if (!td->rate_bps[ddir]) {
537 log_err("rate lower than supported\n");
538 return -1;
539 }
540
541 td->rate_next_io_time[ddir] = 0;
542 td->rate_io_issue_bytes[ddir] = 0;
543 td->last_usec = 0;
544 return 0;
545}
546
547static int setup_rate(struct thread_data *td)
548{
549 int ret = 0;
550
551 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
552 ret = __setup_rate(td, DDIR_READ);
553 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
554 ret |= __setup_rate(td, DDIR_WRITE);
555 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
556 ret |= __setup_rate(td, DDIR_TRIM);
557
558 return ret;
559}
560
561static int fixed_block_size(struct thread_options *o)
562{
563 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
564 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
565 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
566 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
567 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
568}
569
570
571static unsigned long long get_rand_start_delay(struct thread_data *td)
572{
573 unsigned long long delayrange;
574 uint64_t frand_max;
575 unsigned long r;
576
577 delayrange = td->o.start_delay_high - td->o.start_delay;
578
579 frand_max = rand_max(&td->delay_state);
580 r = __rand(&td->delay_state);
581 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
582
583 delayrange += td->o.start_delay;
584 return delayrange;
585}
586
587/*
588 * Lazy way of fixing up options that depend on each other. We could also
589 * define option callback handlers, but this is easier.
590 */
591static int fixup_options(struct thread_data *td)
592{
593 struct thread_options *o = &td->o;
594 int ret = 0;
595
596#ifndef FIO_HAVE_PSHARED_MUTEX
597 if (!o->use_thread) {
598 log_info("fio: this platform does not support process shared"
599 " mutexes, forcing use of threads. Use the 'thread'"
600 " option to get rid of this warning.\n");
601 o->use_thread = 1;
602 ret = warnings_fatal;
603 }
604#endif
605
606 if (o->write_iolog_file && o->read_iolog_file) {
607 log_err("fio: read iolog overrides write_iolog\n");
608 free(o->write_iolog_file);
609 o->write_iolog_file = NULL;
610 ret = warnings_fatal;
611 }
612
613 /*
614 * only really works with 1 file
615 */
616 if (o->zone_size && o->open_files > 1)
617 o->zone_size = 0;
618
619 /*
620 * If zone_range isn't specified, backward compatibility dictates it
621 * should be made equal to zone_size.
622 */
623 if (o->zone_size && !o->zone_range)
624 o->zone_range = o->zone_size;
625
626 /*
627 * Reads can do overwrites, we always need to pre-create the file
628 */
629 if (td_read(td) || td_rw(td))
630 o->overwrite = 1;
631
632 if (!o->min_bs[DDIR_READ])
633 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
634 if (!o->max_bs[DDIR_READ])
635 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
636 if (!o->min_bs[DDIR_WRITE])
637 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
638 if (!o->max_bs[DDIR_WRITE])
639 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
640 if (!o->min_bs[DDIR_TRIM])
641 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
642 if (!o->max_bs[DDIR_TRIM])
643 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
644
645 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
646 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
647
648 /*
649 * For random IO, allow blockalign offset other than min_bs.
650 */
651 if (!o->ba[DDIR_READ] || !td_random(td))
652 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
653 if (!o->ba[DDIR_WRITE] || !td_random(td))
654 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
655 if (!o->ba[DDIR_TRIM] || !td_random(td))
656 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
657
658 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
659 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
660 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
661 !o->norandommap) {
662 log_err("fio: Any use of blockalign= turns off randommap\n");
663 o->norandommap = 1;
664 ret = warnings_fatal;
665 }
666
667 if (!o->file_size_high)
668 o->file_size_high = o->file_size_low;
669
670 if (o->start_delay_high)
671 o->start_delay = get_rand_start_delay(td);
672
673 if (o->norandommap && o->verify != VERIFY_NONE
674 && !fixed_block_size(o)) {
675 log_err("fio: norandommap given for variable block sizes, "
676 "verify limited\n");
677 ret = warnings_fatal;
678 }
679 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
680 log_err("fio: bs_unaligned may not work with raw io\n");
681
682 /*
683 * thinktime_spin must be less than thinktime
684 */
685 if (o->thinktime_spin > o->thinktime)
686 o->thinktime_spin = o->thinktime;
687
688 /*
689 * The low water mark cannot be bigger than the iodepth
690 */
691 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
692 o->iodepth_low = o->iodepth;
693
694 /*
695 * If batch number isn't set, default to the same as iodepth
696 */
697 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
698 o->iodepth_batch = o->iodepth;
699
700 /*
701 * If max batch complete number isn't set or set incorrectly,
702 * default to the same as iodepth_batch_complete_min
703 */
704 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
705 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
706
707 if (o->nr_files > td->files_index)
708 o->nr_files = td->files_index;
709
710 if (o->open_files > o->nr_files || !o->open_files)
711 o->open_files = o->nr_files;
712
713 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
714 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
715 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
716 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
717 log_err("fio: rate and rate_iops are mutually exclusive\n");
718 ret = 1;
719 }
720 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
721 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
722 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
723 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
724 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
725 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
726 log_err("fio: minimum rate exceeds rate\n");
727 ret = 1;
728 }
729
730 if (!o->timeout && o->time_based) {
731 log_err("fio: time_based requires a runtime/timeout setting\n");
732 o->time_based = 0;
733 ret = warnings_fatal;
734 }
735
736 if (o->fill_device && !o->size)
737 o->size = -1ULL;
738
739 if (o->verify != VERIFY_NONE) {
740 if (td_write(td) && o->do_verify && o->numjobs > 1) {
741 log_info("Multiple writers may overwrite blocks that "
742 "belong to other jobs. This can cause "
743 "verification failures.\n");
744 ret = warnings_fatal;
745 }
746
747 if (!fio_option_is_set(o, refill_buffers))
748 o->refill_buffers = 1;
749
750 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
751 !o->verify_interval)
752 o->verify_interval = o->min_bs[DDIR_WRITE];
753
754 /*
755 * Verify interval must be smaller or equal to the
756 * write size.
757 */
758 if (o->verify_interval > o->min_bs[DDIR_WRITE])
759 o->verify_interval = o->min_bs[DDIR_WRITE];
760 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
761 o->verify_interval = o->min_bs[DDIR_READ];
762 }
763
764 if (o->pre_read) {
765 o->invalidate_cache = 0;
766 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
767 log_info("fio: cannot pre-read files with an IO engine"
768 " that isn't seekable. Pre-read disabled.\n");
769 ret = warnings_fatal;
770 }
771 }
772
773 if (!o->unit_base) {
774 if (td_ioengine_flagged(td, FIO_BIT_BASED))
775 o->unit_base = 1;
776 else
777 o->unit_base = 8;
778 }
779
780#ifndef CONFIG_FDATASYNC
781 if (o->fdatasync_blocks) {
782 log_info("fio: this platform does not support fdatasync()"
783 " falling back to using fsync(). Use the 'fsync'"
784 " option instead of 'fdatasync' to get rid of"
785 " this warning\n");
786 o->fsync_blocks = o->fdatasync_blocks;
787 o->fdatasync_blocks = 0;
788 ret = warnings_fatal;
789 }
790#endif
791
792#ifdef WIN32
793 /*
794 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
795 * so fail if we're passed those flags
796 */
797 if (td_ioengine_flagged(td, FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
798 log_err("fio: Windows does not support direct or non-buffered io with"
799 " the synchronous ioengines. Use the 'windowsaio' ioengine"
800 " with 'direct=1' and 'iodepth=1' instead.\n");
801 ret = 1;
802 }
803#endif
804
805 /*
806 * For fully compressible data, just zero them at init time.
807 * It's faster than repeatedly filling it. For non-zero
808 * compression, we should have refill_buffers set. Set it, unless
809 * the job file already changed it.
810 */
811 if (o->compress_percentage) {
812 if (o->compress_percentage == 100) {
813 o->zero_buffers = 1;
814 o->compress_percentage = 0;
815 } else if (!fio_option_is_set(o, refill_buffers))
816 o->refill_buffers = 1;
817 }
818
819 /*
820 * Using a non-uniform random distribution excludes usage of
821 * a random map
822 */
823 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
824 td->o.norandommap = 1;
825
826 /*
827 * If size is set but less than the min block size, complain
828 */
829 if (o->size && o->size < td_min_bs(td)) {
830 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
831 ret = 1;
832 }
833
834 /*
835 * O_ATOMIC implies O_DIRECT
836 */
837 if (td->o.oatomic)
838 td->o.odirect = 1;
839
840 /*
841 * If randseed is set, that overrides randrepeat
842 */
843 if (fio_option_is_set(&td->o, rand_seed))
844 td->o.rand_repeatable = 0;
845
846 if (td_ioengine_flagged(td, FIO_NOEXTEND) && td->o.file_append) {
847 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
848 ret = 1;
849 }
850
851 if (fio_option_is_set(o, gtod_cpu)) {
852 fio_gtod_init();
853 fio_gtod_set_cpu(o->gtod_cpu);
854 fio_gtod_offload = 1;
855 }
856
857 td->loops = o->loops;
858 if (!td->loops)
859 td->loops = 1;
860
861 if (td->o.block_error_hist && td->o.nr_files != 1) {
862 log_err("fio: block error histogram only available "
863 "with a single file per job, but %d files "
864 "provided\n", td->o.nr_files);
865 ret = 1;
866 }
867
868 return ret;
869}
870
871/*
872 * This function leaks the buffer
873 */
874char *fio_uint_to_kmg(unsigned int val)
875{
876 char *buf = malloc(32);
877 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
878 char *p = post;
879
880 do {
881 if (val & 1023)
882 break;
883
884 val >>= 10;
885 p++;
886 } while (*p);
887
888 snprintf(buf, 32, "%u%c", val, *p);
889 return buf;
890}
891
892/* External engines are specified by "external:name.o") */
893static const char *get_engine_name(const char *str)
894{
895 char *p = strstr(str, ":");
896
897 if (!p)
898 return str;
899
900 p++;
901 strip_blank_front(&p);
902 strip_blank_end(p);
903 return p;
904}
905
906static int exists_and_not_regfile(const char *filename)
907{
908 struct stat sb;
909
910 if (lstat(filename, &sb) == -1)
911 return 0;
912
913#ifndef WIN32 /* NOT Windows */
914 if (S_ISREG(sb.st_mode))
915 return 0;
916#else
917 /* \\.\ is the device namespace in Windows, where every file
918 * is a device node */
919 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
920 return 0;
921#endif
922
923 return 1;
924}
925
926static void init_rand_file_service(struct thread_data *td)
927{
928 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
929 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
930
931 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
932 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
933 zipf_disable_hash(&td->next_file_zipf);
934 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
935 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
936 zipf_disable_hash(&td->next_file_zipf);
937 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
938 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
939 gauss_disable_hash(&td->next_file_gauss);
940 }
941}
942
943void td_fill_verify_state_seed(struct thread_data *td)
944{
945 bool use64;
946
947 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
948 use64 = 1;
949 else
950 use64 = 0;
951
952 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
953 use64);
954}
955
956static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
957{
958 int i;
959
960 init_rand_seed(&td->bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF], use64);
961 td_fill_verify_state_seed(td);
962 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
963
964 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
965 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
966 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
967 init_rand_file_service(td);
968
969 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
970 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
971 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
972 init_rand_seed(&td->poisson_state, td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
973 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
974 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
975
976 if (!td_random(td))
977 return;
978
979 if (td->o.rand_repeatable)
980 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
981
982 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
983
984 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
985 struct frand_state *s = &td->seq_rand_state[i];
986
987 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
988 }
989}
990
991void td_fill_rand_seeds(struct thread_data *td)
992{
993 bool use64;
994
995 if (td->o.allrand_repeatable) {
996 unsigned int i;
997
998 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
999 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1000 + i;
1001 }
1002
1003 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1004 use64 = 1;
1005 else
1006 use64 = 0;
1007
1008 td_fill_rand_seeds_internal(td, use64);
1009
1010 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1011 frand_copy(&td->buf_state_prev, &td->buf_state);
1012}
1013
1014/*
1015 * Initializes the ioengine configured for a job, if it has not been done so
1016 * already.
1017 */
1018int ioengine_load(struct thread_data *td)
1019{
1020 const char *engine;
1021
1022 /*
1023 * Engine has already been loaded.
1024 */
1025 if (td->io_ops)
1026 return 0;
1027 if (!td->o.ioengine) {
1028 log_err("fio: internal fault, no IO engine specified\n");
1029 return 1;
1030 }
1031
1032 engine = get_engine_name(td->o.ioengine);
1033 td->io_ops = load_ioengine(td, engine);
1034 if (!td->io_ops) {
1035 log_err("fio: failed to load engine %s\n", engine);
1036 return 1;
1037 }
1038
1039 if (td->io_ops->option_struct_size && td->io_ops->options) {
1040 /*
1041 * In cases where td->eo is set, clone it for a child thread.
1042 * This requires that the parent thread has the same ioengine,
1043 * but that requirement must be enforced by the code which
1044 * cloned the thread.
1045 */
1046 void *origeo = td->eo;
1047 /*
1048 * Otherwise use the default thread options.
1049 */
1050 if (!origeo && td != &def_thread && def_thread.eo &&
1051 def_thread.io_ops->options == td->io_ops->options)
1052 origeo = def_thread.eo;
1053
1054 options_init(td->io_ops->options);
1055 td->eo = malloc(td->io_ops->option_struct_size);
1056 /*
1057 * Use the default thread as an option template if this uses the
1058 * same options structure and there are non-default options
1059 * used.
1060 */
1061 if (origeo) {
1062 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1063 options_mem_dupe(td->eo, td->io_ops->options);
1064 } else {
1065 memset(td->eo, 0, td->io_ops->option_struct_size);
1066 fill_default_options(td->eo, td->io_ops->options);
1067 }
1068 *(struct thread_data **)td->eo = td;
1069 }
1070
1071 if (td->o.odirect)
1072 td->io_ops->flags |= FIO_RAWIO;
1073
1074 td_set_ioengine_flags(td);
1075 return 0;
1076}
1077
1078static void init_flags(struct thread_data *td)
1079{
1080 struct thread_options *o = &td->o;
1081
1082 if (o->verify_backlog)
1083 td->flags |= TD_F_VER_BACKLOG;
1084 if (o->trim_backlog)
1085 td->flags |= TD_F_TRIM_BACKLOG;
1086 if (o->read_iolog_file)
1087 td->flags |= TD_F_READ_IOLOG;
1088 if (o->refill_buffers)
1089 td->flags |= TD_F_REFILL_BUFFERS;
1090 /*
1091 * Always scramble buffers if asked to
1092 */
1093 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1094 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1095 /*
1096 * But also scramble buffers, unless we were explicitly asked
1097 * to zero them.
1098 */
1099 if (o->scramble_buffers && !(o->zero_buffers &&
1100 fio_option_is_set(o, zero_buffers)))
1101 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1102 if (o->verify != VERIFY_NONE)
1103 td->flags |= TD_F_VER_NONE;
1104
1105 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1106 td->flags |= TD_F_NEED_LOCK;
1107}
1108
1109static int setup_random_seeds(struct thread_data *td)
1110{
1111 unsigned long seed;
1112 unsigned int i;
1113
1114 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed))
1115 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
1116
1117 seed = td->o.rand_seed;
1118 for (i = 0; i < 4; i++)
1119 seed *= 0x9e370001UL;
1120
1121 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1122 td->rand_seeds[i] = seed * td->thread_number + i;
1123 seed *= 0x9e370001UL;
1124 }
1125
1126 td_fill_rand_seeds(td);
1127 return 0;
1128}
1129
1130enum {
1131 FPRE_NONE = 0,
1132 FPRE_JOBNAME,
1133 FPRE_JOBNUM,
1134 FPRE_FILENUM
1135};
1136
1137static struct fpre_keyword {
1138 const char *keyword;
1139 size_t strlen;
1140 int key;
1141} fpre_keywords[] = {
1142 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1143 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1144 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1145 { .keyword = NULL, },
1146 };
1147
1148static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1149 const char *jobname, int jobnum, int filenum)
1150{
1151 struct fpre_keyword *f;
1152 char copy[PATH_MAX];
1153 size_t dst_left = PATH_MAX - 1;
1154
1155 if (!o->filename_format || !strlen(o->filename_format)) {
1156 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1157 return NULL;
1158 }
1159
1160 for (f = &fpre_keywords[0]; f->keyword; f++)
1161 f->strlen = strlen(f->keyword);
1162
1163 buf[buf_size - 1] = '\0';
1164 strncpy(buf, o->filename_format, buf_size - 1);
1165
1166 memset(copy, 0, sizeof(copy));
1167 for (f = &fpre_keywords[0]; f->keyword; f++) {
1168 do {
1169 size_t pre_len, post_start = 0;
1170 char *str, *dst = copy;
1171
1172 str = strcasestr(buf, f->keyword);
1173 if (!str)
1174 break;
1175
1176 pre_len = str - buf;
1177 if (strlen(str) != f->strlen)
1178 post_start = pre_len + f->strlen;
1179
1180 if (pre_len) {
1181 strncpy(dst, buf, pre_len);
1182 dst += pre_len;
1183 dst_left -= pre_len;
1184 }
1185
1186 switch (f->key) {
1187 case FPRE_JOBNAME: {
1188 int ret;
1189
1190 ret = snprintf(dst, dst_left, "%s", jobname);
1191 if (ret < 0)
1192 break;
1193 else if (ret > dst_left) {
1194 log_err("fio: truncated filename\n");
1195 dst += dst_left;
1196 dst_left = 0;
1197 } else {
1198 dst += ret;
1199 dst_left -= ret;
1200 }
1201 break;
1202 }
1203 case FPRE_JOBNUM: {
1204 int ret;
1205
1206 ret = snprintf(dst, dst_left, "%d", jobnum);
1207 if (ret < 0)
1208 break;
1209 else if (ret > dst_left) {
1210 log_err("fio: truncated filename\n");
1211 dst += dst_left;
1212 dst_left = 0;
1213 } else {
1214 dst += ret;
1215 dst_left -= ret;
1216 }
1217 break;
1218 }
1219 case FPRE_FILENUM: {
1220 int ret;
1221
1222 ret = snprintf(dst, dst_left, "%d", filenum);
1223 if (ret < 0)
1224 break;
1225 else if (ret > dst_left) {
1226 log_err("fio: truncated filename\n");
1227 dst += dst_left;
1228 dst_left = 0;
1229 } else {
1230 dst += ret;
1231 dst_left -= ret;
1232 }
1233 break;
1234 }
1235 default:
1236 assert(0);
1237 break;
1238 }
1239
1240 if (post_start)
1241 strncpy(dst, buf + post_start, dst_left);
1242
1243 strncpy(buf, copy, buf_size - 1);
1244 } while (1);
1245 }
1246
1247 return buf;
1248}
1249
1250bool parse_dryrun(void)
1251{
1252 return dump_cmdline || parse_only;
1253}
1254
1255static void gen_log_name(char *name, size_t size, const char *logtype,
1256 const char *logname, unsigned int num,
1257 const char *suf, int per_job)
1258{
1259 if (per_job)
1260 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1261 else
1262 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1263}
1264
1265static int check_waitees(char *waitee)
1266{
1267 struct thread_data *td;
1268 int i, ret = 0;
1269
1270 for_each_td(td, i) {
1271 if (td->subjob_number)
1272 continue;
1273
1274 ret += !strcmp(td->o.name, waitee);
1275 }
1276
1277 return ret;
1278}
1279
1280static bool wait_for_ok(const char *jobname, struct thread_options *o)
1281{
1282 int nw;
1283
1284 if (!o->wait_for)
1285 return true;
1286
1287 if (!strcmp(jobname, o->wait_for)) {
1288 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1289 jobname, o->wait_for);
1290 return false;
1291 }
1292
1293 if (!(nw = check_waitees(o->wait_for))) {
1294 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1295 return false;
1296 }
1297
1298 if (nw > 1) {
1299 log_err("%s: multiple waitees %s found,\n"
1300 "please avoid duplicates when using wait_for option.\n",
1301 jobname, o->wait_for);
1302 return false;
1303 }
1304
1305 return true;
1306}
1307
1308/*
1309 * Adds a job to the list of things todo. Sanitizes the various options
1310 * to make sure we don't have conflicts, and initializes various
1311 * members of td.
1312 */
1313static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1314 int recursed, int client_type)
1315{
1316 unsigned int i;
1317 char fname[PATH_MAX];
1318 int numjobs, file_alloced;
1319 struct thread_options *o = &td->o;
1320 char logname[PATH_MAX + 32];
1321
1322 /*
1323 * the def_thread is just for options, it's not a real job
1324 */
1325 if (td == &def_thread)
1326 return 0;
1327
1328 init_flags(td);
1329
1330 /*
1331 * if we are just dumping the output command line, don't add the job
1332 */
1333 if (parse_dryrun()) {
1334 put_job(td);
1335 return 0;
1336 }
1337
1338 td->client_type = client_type;
1339
1340 if (profile_td_init(td))
1341 goto err;
1342
1343 if (ioengine_load(td))
1344 goto err;
1345
1346 file_alloced = 0;
1347 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1348 file_alloced = 1;
1349
1350 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1351 add_file(td, jobname, job_add_num, 0);
1352 else {
1353 for (i = 0; i < o->nr_files; i++)
1354 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1355 }
1356 }
1357
1358 if (fixup_options(td))
1359 goto err;
1360
1361 /*
1362 * Belongs to fixup_options, but o->name is not necessarily set as yet
1363 */
1364 if (!wait_for_ok(jobname, o))
1365 goto err;
1366
1367 flow_init_job(td);
1368
1369 /*
1370 * IO engines only need this for option callbacks, and the address may
1371 * change in subprocesses.
1372 */
1373 if (td->eo)
1374 *(struct thread_data **)td->eo = NULL;
1375
1376 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1377 struct fio_file *f;
1378
1379 for_each_file(td, f, i)
1380 f->real_file_size = -1ULL;
1381 }
1382
1383 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1384
1385 td->ts.clat_percentiles = o->clat_percentiles;
1386 td->ts.percentile_precision = o->percentile_precision;
1387 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1388
1389 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1390 td->ts.clat_stat[i].min_val = ULONG_MAX;
1391 td->ts.slat_stat[i].min_val = ULONG_MAX;
1392 td->ts.lat_stat[i].min_val = ULONG_MAX;
1393 td->ts.bw_stat[i].min_val = ULONG_MAX;
1394 }
1395 td->ddir_seq_nr = o->ddir_seq_nr;
1396
1397 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1398 prev_group_jobs = 0;
1399 groupid++;
1400 if (groupid == INT_MAX) {
1401 log_err("fio: too many groups defined\n");
1402 goto err;
1403 }
1404 }
1405
1406 td->groupid = groupid;
1407 prev_group_jobs++;
1408
1409 if (setup_random_seeds(td)) {
1410 td_verror(td, errno, "init_random_state");
1411 goto err;
1412 }
1413
1414 if (setup_rate(td))
1415 goto err;
1416
1417 if (o->lat_log_file) {
1418 struct log_params p = {
1419 .td = td,
1420 .avg_msec = o->log_avg_msec,
1421 .hist_msec = o->log_hist_msec,
1422 .hist_coarseness = o->log_hist_coarseness,
1423 .log_type = IO_LOG_TYPE_LAT,
1424 .log_offset = o->log_offset,
1425 .log_gz = o->log_gz,
1426 .log_gz_store = o->log_gz_store,
1427 };
1428 const char *suf;
1429
1430 if (p.log_gz_store)
1431 suf = "log.fz";
1432 else
1433 suf = "log";
1434
1435 gen_log_name(logname, sizeof(logname), "lat", o->lat_log_file,
1436 td->thread_number, suf, o->per_job_logs);
1437 setup_log(&td->lat_log, &p, logname);
1438
1439 gen_log_name(logname, sizeof(logname), "slat", o->lat_log_file,
1440 td->thread_number, suf, o->per_job_logs);
1441 setup_log(&td->slat_log, &p, logname);
1442
1443 gen_log_name(logname, sizeof(logname), "clat", o->lat_log_file,
1444 td->thread_number, suf, o->per_job_logs);
1445 setup_log(&td->clat_log, &p, logname);
1446 }
1447
1448 if (o->hist_log_file) {
1449 struct log_params p = {
1450 .td = td,
1451 .avg_msec = o->log_avg_msec,
1452 .hist_msec = o->log_hist_msec,
1453 .hist_coarseness = o->log_hist_coarseness,
1454 .log_type = IO_LOG_TYPE_HIST,
1455 .log_offset = o->log_offset,
1456 .log_gz = o->log_gz,
1457 .log_gz_store = o->log_gz_store,
1458 };
1459 const char *suf;
1460
1461 if (p.log_gz_store)
1462 suf = "log.fz";
1463 else
1464 suf = "log";
1465
1466 gen_log_name(logname, sizeof(logname), "clat_hist", o->hist_log_file,
1467 td->thread_number, suf, o->per_job_logs);
1468 setup_log(&td->clat_hist_log, &p, logname);
1469 }
1470
1471 if (o->bw_log_file) {
1472 struct log_params p = {
1473 .td = td,
1474 .avg_msec = o->log_avg_msec,
1475 .hist_msec = o->log_hist_msec,
1476 .hist_coarseness = o->log_hist_coarseness,
1477 .log_type = IO_LOG_TYPE_BW,
1478 .log_offset = o->log_offset,
1479 .log_gz = o->log_gz,
1480 .log_gz_store = o->log_gz_store,
1481 };
1482 const char *suf;
1483
1484 if (fio_option_is_set(o, bw_avg_time))
1485 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1486 else
1487 o->bw_avg_time = p.avg_msec;
1488
1489 p.hist_msec = o->log_hist_msec;
1490 p.hist_coarseness = o->log_hist_coarseness;
1491
1492 if (p.log_gz_store)
1493 suf = "log.fz";
1494 else
1495 suf = "log";
1496
1497 gen_log_name(logname, sizeof(logname), "bw", o->bw_log_file,
1498 td->thread_number, suf, o->per_job_logs);
1499 setup_log(&td->bw_log, &p, logname);
1500 }
1501 if (o->iops_log_file) {
1502 struct log_params p = {
1503 .td = td,
1504 .avg_msec = o->log_avg_msec,
1505 .hist_msec = o->log_hist_msec,
1506 .hist_coarseness = o->log_hist_coarseness,
1507 .log_type = IO_LOG_TYPE_IOPS,
1508 .log_offset = o->log_offset,
1509 .log_gz = o->log_gz,
1510 .log_gz_store = o->log_gz_store,
1511 };
1512 const char *suf;
1513
1514 if (fio_option_is_set(o, iops_avg_time))
1515 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1516 else
1517 o->iops_avg_time = p.avg_msec;
1518
1519 p.hist_msec = o->log_hist_msec;
1520 p.hist_coarseness = o->log_hist_coarseness;
1521
1522 if (p.log_gz_store)
1523 suf = "log.fz";
1524 else
1525 suf = "log";
1526
1527 gen_log_name(logname, sizeof(logname), "iops", o->iops_log_file,
1528 td->thread_number, suf, o->per_job_logs);
1529 setup_log(&td->iops_log, &p, logname);
1530 }
1531
1532 if (!o->name)
1533 o->name = strdup(jobname);
1534
1535 if (output_format & FIO_OUTPUT_NORMAL) {
1536 if (!job_add_num) {
1537 if (is_backend && !recursed)
1538 fio_server_send_add_job(td);
1539
1540 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1541 char *c1, *c2, *c3, *c4;
1542 char *c5 = NULL, *c6 = NULL;
1543
1544 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1545 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1546 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1547 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1548
1549 if (!o->bs_is_seq_rand) {
1550 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1551 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1552 }
1553
1554 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1555 td->groupid,
1556 ddir_str(o->td_ddir));
1557
1558 if (o->bs_is_seq_rand)
1559 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1560 c1, c2, c3, c4);
1561 else
1562 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1563 c1, c2, c3, c4, c5, c6);
1564
1565 log_info("ioengine=%s, iodepth=%u\n",
1566 td->io_ops->name, o->iodepth);
1567
1568 free(c1);
1569 free(c2);
1570 free(c3);
1571 free(c4);
1572 free(c5);
1573 free(c6);
1574 }
1575 } else if (job_add_num == 1)
1576 log_info("...\n");
1577 }
1578
1579 /*
1580 * recurse add identical jobs, clear numjobs and stonewall options
1581 * as they don't apply to sub-jobs
1582 */
1583 numjobs = o->numjobs;
1584 while (--numjobs) {
1585 struct thread_data *td_new = get_new_job(0, td, 1, jobname);
1586
1587 if (!td_new)
1588 goto err;
1589
1590 td_new->o.numjobs = 1;
1591 td_new->o.stonewall = 0;
1592 td_new->o.new_group = 0;
1593 td_new->subjob_number = numjobs;
1594
1595 if (file_alloced) {
1596 if (td_new->files) {
1597 struct fio_file *f;
1598 for_each_file(td_new, f, i) {
1599 if (f->file_name)
1600 sfree(f->file_name);
1601 sfree(f);
1602 }
1603 free(td_new->files);
1604 td_new->files = NULL;
1605 }
1606 td_new->files_index = 0;
1607 td_new->files_size = 0;
1608 if (td_new->o.filename) {
1609 free(td_new->o.filename);
1610 td_new->o.filename = NULL;
1611 }
1612 }
1613
1614 if (add_job(td_new, jobname, numjobs, 1, client_type))
1615 goto err;
1616 }
1617
1618 return 0;
1619err:
1620 put_job(td);
1621 return -1;
1622}
1623
1624/*
1625 * Parse as if 'o' was a command line
1626 */
1627void add_job_opts(const char **o, int client_type)
1628{
1629 struct thread_data *td, *td_parent;
1630 int i, in_global = 1;
1631 char jobname[32];
1632
1633 i = 0;
1634 td_parent = td = NULL;
1635 while (o[i]) {
1636 if (!strncmp(o[i], "name", 4)) {
1637 in_global = 0;
1638 if (td)
1639 add_job(td, jobname, 0, 0, client_type);
1640 td = NULL;
1641 sprintf(jobname, "%s", o[i] + 5);
1642 }
1643 if (in_global && !td_parent)
1644 td_parent = get_new_job(1, &def_thread, 0, jobname);
1645 else if (!in_global && !td) {
1646 if (!td_parent)
1647 td_parent = &def_thread;
1648 td = get_new_job(0, td_parent, 0, jobname);
1649 }
1650 if (in_global)
1651 fio_options_parse(td_parent, (char **) &o[i], 1);
1652 else
1653 fio_options_parse(td, (char **) &o[i], 1);
1654 i++;
1655 }
1656
1657 if (td)
1658 add_job(td, jobname, 0, 0, client_type);
1659}
1660
1661static int skip_this_section(const char *name)
1662{
1663 int i;
1664
1665 if (!nr_job_sections)
1666 return 0;
1667 if (!strncmp(name, "global", 6))
1668 return 0;
1669
1670 for (i = 0; i < nr_job_sections; i++)
1671 if (!strcmp(job_sections[i], name))
1672 return 0;
1673
1674 return 1;
1675}
1676
1677static int is_empty_or_comment(char *line)
1678{
1679 unsigned int i;
1680
1681 for (i = 0; i < strlen(line); i++) {
1682 if (line[i] == ';')
1683 return 1;
1684 if (line[i] == '#')
1685 return 1;
1686 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1687 return 0;
1688 }
1689
1690 return 1;
1691}
1692
1693/*
1694 * This is our [ini] type file parser.
1695 */
1696int __parse_jobs_ini(struct thread_data *td,
1697 char *file, int is_buf, int stonewall_flag, int type,
1698 int nested, char *name, char ***popts, int *aopts, int *nopts)
1699{
1700 unsigned int global = 0;
1701 char *string;
1702 FILE *f;
1703 char *p;
1704 int ret = 0, stonewall;
1705 int first_sect = 1;
1706 int skip_fgets = 0;
1707 int inside_skip = 0;
1708 char **opts;
1709 int i, alloc_opts, num_opts;
1710
1711 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1712 assert(td || !nested);
1713
1714 if (is_buf)
1715 f = NULL;
1716 else {
1717 if (!strcmp(file, "-"))
1718 f = stdin;
1719 else
1720 f = fopen(file, "r");
1721
1722 if (!f) {
1723 int __err = errno;
1724
1725 log_err("fio: unable to open '%s' job file\n", file);
1726 if (td)
1727 td_verror(td, __err, "job file open");
1728 return 1;
1729 }
1730 }
1731
1732 string = malloc(4096);
1733
1734 /*
1735 * it's really 256 + small bit, 280 should suffice
1736 */
1737 if (!nested) {
1738 name = malloc(280);
1739 memset(name, 0, 280);
1740 }
1741
1742 opts = NULL;
1743 if (nested && popts) {
1744 opts = *popts;
1745 alloc_opts = *aopts;
1746 num_opts = *nopts;
1747 }
1748
1749 if (!opts) {
1750 alloc_opts = 8;
1751 opts = malloc(sizeof(char *) * alloc_opts);
1752 num_opts = 0;
1753 }
1754
1755 stonewall = stonewall_flag;
1756 do {
1757 /*
1758 * if skip_fgets is set, we already have loaded a line we
1759 * haven't handled.
1760 */
1761 if (!skip_fgets) {
1762 if (is_buf)
1763 p = strsep(&file, "\n");
1764 else
1765 p = fgets(string, 4096, f);
1766 if (!p)
1767 break;
1768 }
1769
1770 skip_fgets = 0;
1771 strip_blank_front(&p);
1772 strip_blank_end(p);
1773
1774 dprint(FD_PARSE, "%s\n", p);
1775 if (is_empty_or_comment(p))
1776 continue;
1777
1778 if (!nested) {
1779 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1780 if (inside_skip)
1781 continue;
1782
1783 log_err("fio: option <%s> outside of "
1784 "[] job section\n", p);
1785 ret = 1;
1786 break;
1787 }
1788
1789 name[strlen(name) - 1] = '\0';
1790
1791 if (skip_this_section(name)) {
1792 inside_skip = 1;
1793 continue;
1794 } else
1795 inside_skip = 0;
1796
1797 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1798
1799 global = !strncmp(name, "global", 6);
1800
1801 if (dump_cmdline) {
1802 if (first_sect)
1803 log_info("fio ");
1804 if (!global)
1805 log_info("--name=%s ", name);
1806 first_sect = 0;
1807 }
1808
1809 td = get_new_job(global, &def_thread, 0, name);
1810 if (!td) {
1811 ret = 1;
1812 break;
1813 }
1814
1815 /*
1816 * Separate multiple job files by a stonewall
1817 */
1818 if (!global && stonewall) {
1819 td->o.stonewall = stonewall;
1820 stonewall = 0;
1821 }
1822
1823 num_opts = 0;
1824 memset(opts, 0, alloc_opts * sizeof(char *));
1825 }
1826 else
1827 skip_fgets = 1;
1828
1829 while (1) {
1830 if (!skip_fgets) {
1831 if (is_buf)
1832 p = strsep(&file, "\n");
1833 else
1834 p = fgets(string, 4096, f);
1835 if (!p)
1836 break;
1837 dprint(FD_PARSE, "%s", p);
1838 }
1839 else
1840 skip_fgets = 0;
1841
1842 if (is_empty_or_comment(p))
1843 continue;
1844
1845 strip_blank_front(&p);
1846
1847 /*
1848 * new section, break out and make sure we don't
1849 * fgets() a new line at the top.
1850 */
1851 if (p[0] == '[') {
1852 if (nested) {
1853 log_err("No new sections in included files\n");
1854 return 1;
1855 }
1856
1857 skip_fgets = 1;
1858 break;
1859 }
1860
1861 strip_blank_end(p);
1862
1863 if (!strncmp(p, "include", strlen("include"))) {
1864 char *filename = p + strlen("include") + 1,
1865 *ts, *full_fn = NULL;
1866
1867 /*
1868 * Allow for the include filename
1869 * specification to be relative.
1870 */
1871 if (access(filename, F_OK) &&
1872 (ts = strrchr(file, '/'))) {
1873 int len = ts - file +
1874 strlen(filename) + 2;
1875
1876 if (!(full_fn = calloc(1, len))) {
1877 ret = ENOMEM;
1878 break;
1879 }
1880
1881 strncpy(full_fn,
1882 file, (ts - file) + 1);
1883 strncpy(full_fn + (ts - file) + 1,
1884 filename, strlen(filename));
1885 full_fn[len - 1] = 0;
1886 filename = full_fn;
1887 }
1888
1889 ret = __parse_jobs_ini(td, filename, is_buf,
1890 stonewall_flag, type, 1,
1891 name, &opts,
1892 &alloc_opts, &num_opts);
1893
1894 if (ret) {
1895 log_err("Error %d while parsing "
1896 "include file %s\n",
1897 ret, filename);
1898 }
1899
1900 if (full_fn)
1901 free(full_fn);
1902
1903 if (ret)
1904 break;
1905
1906 continue;
1907 }
1908
1909 if (num_opts == alloc_opts) {
1910 alloc_opts <<= 1;
1911 opts = realloc(opts,
1912 alloc_opts * sizeof(char *));
1913 }
1914
1915 opts[num_opts] = strdup(p);
1916 num_opts++;
1917 }
1918
1919 if (nested) {
1920 *popts = opts;
1921 *aopts = alloc_opts;
1922 *nopts = num_opts;
1923 goto out;
1924 }
1925
1926 ret = fio_options_parse(td, opts, num_opts);
1927 if (!ret) {
1928 if (dump_cmdline)
1929 dump_opt_list(td);
1930
1931 ret = add_job(td, name, 0, 0, type);
1932 } else {
1933 log_err("fio: job %s dropped\n", name);
1934 put_job(td);
1935 }
1936
1937 for (i = 0; i < num_opts; i++)
1938 free(opts[i]);
1939 num_opts = 0;
1940 } while (!ret);
1941
1942 if (dump_cmdline)
1943 log_info("\n");
1944
1945 i = 0;
1946 while (i < nr_job_sections) {
1947 free(job_sections[i]);
1948 i++;
1949 }
1950
1951 free(opts);
1952out:
1953 free(string);
1954 if (!nested)
1955 free(name);
1956 if (!is_buf && f != stdin)
1957 fclose(f);
1958 return ret;
1959}
1960
1961int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1962{
1963 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
1964 0, NULL, NULL, NULL, NULL);
1965}
1966
1967static int fill_def_thread(void)
1968{
1969 memset(&def_thread, 0, sizeof(def_thread));
1970 INIT_FLIST_HEAD(&def_thread.opt_list);
1971
1972 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1973 def_thread.o.error_dump = 1;
1974
1975 /*
1976 * fill default options
1977 */
1978 fio_fill_default_options(&def_thread);
1979 return 0;
1980}
1981
1982static void show_debug_categories(void)
1983{
1984#ifdef FIO_INC_DEBUG
1985 struct debug_level *dl = &debug_levels[0];
1986 int curlen, first = 1;
1987
1988 curlen = 0;
1989 while (dl->name) {
1990 int has_next = (dl + 1)->name != NULL;
1991
1992 if (first || curlen + strlen(dl->name) >= 80) {
1993 if (!first) {
1994 printf("\n");
1995 curlen = 0;
1996 }
1997 curlen += printf("\t\t\t%s", dl->name);
1998 curlen += 3 * (8 - 1);
1999 if (has_next)
2000 curlen += printf(",");
2001 } else {
2002 curlen += printf("%s", dl->name);
2003 if (has_next)
2004 curlen += printf(",");
2005 }
2006 dl++;
2007 first = 0;
2008 }
2009 printf("\n");
2010#endif
2011}
2012
2013static void usage(const char *name)
2014{
2015 printf("%s\n", fio_version_string);
2016 printf("%s [options] [job options] <job file(s)>\n", name);
2017 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2018 show_debug_categories();
2019 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2020 printf(" --output\t\tWrite output to file\n");
2021 printf(" --runtime\t\tRuntime in seconds\n");
2022 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
2023 printf(" --minimal\t\tMinimal (terse) output\n");
2024 printf(" --output-format=x\tOutput format (terse,json,json+,normal)\n");
2025 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
2026 printf(" --version\t\tPrint version info and exit\n");
2027 printf(" --help\t\tPrint this page\n");
2028 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2029 printf(" --crctest\t\tTest speed of checksum functions\n");
2030 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2031 " them\n");
2032 printf(" --enghelp=engine\tPrint ioengine help, or list"
2033 " available ioengines\n");
2034 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2035 " cmd\n");
2036 printf(" --showcmd\t\tTurn a job file into command line options\n");
2037 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2038 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2039 printf(" --eta-newline=time\tForce a new line for every 'time'");
2040 printf(" period passed\n");
2041 printf(" --status-interval=t\tForce full status dump every");
2042 printf(" 't' period passed\n");
2043 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2044 " writes\n");
2045 printf(" --section=name\tOnly run specified section in job file\n");
2046 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2047 " (def 1024)\n");
2048 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2049 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2050 printf(" --server=args\t\tStart a backend fio server\n");
2051 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2052 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
2053 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2054 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2055 "\t\t\t(option=system,percpu) or run unit work\n"
2056 "\t\t\tcalibration only (option=calibrate)\n");
2057#ifdef CONFIG_ZLIB
2058 printf(" --inflate-log=log\tInflate and output compressed log\n");
2059#endif
2060 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2061 printf(" --trigger-timeout=t\tExecute trigger af this time\n");
2062 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2063 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2064 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2065 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
2066 printf("\n Jens Axboe <jaxboe@fusionio.com>");
2067 printf("\n Jens Axboe <axboe@fb.com>\n");
2068}
2069
2070#ifdef FIO_INC_DEBUG
2071struct debug_level debug_levels[] = {
2072 { .name = "process",
2073 .help = "Process creation/exit logging",
2074 .shift = FD_PROCESS,
2075 },
2076 { .name = "file",
2077 .help = "File related action logging",
2078 .shift = FD_FILE,
2079 },
2080 { .name = "io",
2081 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2082 .shift = FD_IO,
2083 },
2084 { .name = "mem",
2085 .help = "Memory allocation/freeing logging",
2086 .shift = FD_MEM,
2087 },
2088 { .name = "blktrace",
2089 .help = "blktrace action logging",
2090 .shift = FD_BLKTRACE,
2091 },
2092 { .name = "verify",
2093 .help = "IO verification action logging",
2094 .shift = FD_VERIFY,
2095 },
2096 { .name = "random",
2097 .help = "Random generation logging",
2098 .shift = FD_RANDOM,
2099 },
2100 { .name = "parse",
2101 .help = "Parser logging",
2102 .shift = FD_PARSE,
2103 },
2104 { .name = "diskutil",
2105 .help = "Disk utility logging actions",
2106 .shift = FD_DISKUTIL,
2107 },
2108 { .name = "job",
2109 .help = "Logging related to creating/destroying jobs",
2110 .shift = FD_JOB,
2111 },
2112 { .name = "mutex",
2113 .help = "Mutex logging",
2114 .shift = FD_MUTEX
2115 },
2116 { .name = "profile",
2117 .help = "Logging related to profiles",
2118 .shift = FD_PROFILE,
2119 },
2120 { .name = "time",
2121 .help = "Logging related to time keeping functions",
2122 .shift = FD_TIME,
2123 },
2124 { .name = "net",
2125 .help = "Network logging",
2126 .shift = FD_NET,
2127 },
2128 { .name = "rate",
2129 .help = "Rate logging",
2130 .shift = FD_RATE,
2131 },
2132 { .name = "compress",
2133 .help = "Log compression logging",
2134 .shift = FD_COMPRESS,
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 break;
2325 case 't':
2326 if (check_str_time(optarg, &def_timeout, 1)) {
2327 log_err("fio: failed parsing time %s\n", optarg);
2328 do_exit++;
2329 exit_val = 1;
2330 }
2331 break;
2332 case 'l':
2333 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2334 do_exit++;
2335 exit_val = 1;
2336 break;
2337 case 'b':
2338 write_bw_log = 1;
2339 break;
2340 case 'o':
2341 if (f_out && f_out != stdout)
2342 fclose(f_out);
2343
2344 f_out = fopen(optarg, "w+");
2345 if (!f_out) {
2346 perror("fopen output");
2347 exit(1);
2348 }
2349 f_err = f_out;
2350 break;
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, 1, 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 did_arg = 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 if (pid_file)
2735 free(pid_file);
2736
2737 return ini_idx;
2738}
2739
2740int fio_init_options(void)
2741{
2742 f_out = stdout;
2743 f_err = stderr;
2744
2745 fio_options_fill_optstring();
2746 fio_options_dup_and_init(l_opts);
2747
2748 atexit(free_shm);
2749
2750 if (fill_def_thread())
2751 return 1;
2752
2753 return 0;
2754}
2755
2756extern int fio_check_options(struct thread_options *);
2757
2758int parse_options(int argc, char *argv[])
2759{
2760 const int type = FIO_CLIENT_TYPE_CLI;
2761 int job_files, i;
2762
2763 if (fio_init_options())
2764 return 1;
2765 if (fio_test_cconv(&def_thread.o))
2766 log_err("fio: failed internal cconv test\n");
2767
2768 job_files = parse_cmd_line(argc, argv, type);
2769
2770 if (job_files > 0) {
2771 for (i = 0; i < job_files; i++) {
2772 if (i && fill_def_thread())
2773 return 1;
2774 if (nr_clients) {
2775 if (fio_clients_send_ini(ini_file[i]))
2776 return 1;
2777 free(ini_file[i]);
2778 } else if (!is_backend) {
2779 if (parse_jobs_ini(ini_file[i], 0, i, type))
2780 return 1;
2781 free(ini_file[i]);
2782 }
2783 }
2784 } else if (nr_clients) {
2785 if (fill_def_thread())
2786 return 1;
2787 if (fio_clients_send_ini(NULL))
2788 return 1;
2789 }
2790
2791 free(ini_file);
2792 fio_options_free(&def_thread);
2793 filesetup_mem_free();
2794
2795 if (!thread_number) {
2796 if (parse_dryrun())
2797 return 0;
2798 if (exec_profile)
2799 return 0;
2800 if (is_backend || nr_clients)
2801 return 0;
2802 if (did_arg)
2803 return 0;
2804
2805 log_err("No jobs(s) defined\n\n");
2806
2807 if (!did_arg) {
2808 usage(argv[0]);
2809 return 1;
2810 }
2811
2812 return 0;
2813 }
2814
2815 if (output_format & FIO_OUTPUT_NORMAL)
2816 log_info("%s\n", fio_version_string);
2817
2818 return 0;
2819}
2820
2821void options_default_fill(struct thread_options *o)
2822{
2823 memcpy(o, &def_thread.o, sizeof(*o));
2824}
2825
2826struct thread_data *get_global_options(void)
2827{
2828 return &def_thread;
2829}