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