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