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