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