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