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