init: get rid of td_fill_rand_seeds_internal
[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_rand_seeds(struct thread_data *td)
1024 {
1025         uint64_t read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
1026         uint64_t write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
1027         uint64_t trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
1028         int i;
1029         bool use64;
1030
1031         if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1032                 use64 = true;
1033         else
1034                 use64 = false;
1035
1036         /*
1037          * trimwrite is special in that we need to generate the same
1038          * offsets to get the "write after trim" effect. If we are
1039          * using bssplit to set buffer length distributions, ensure that
1040          * we seed the trim and write generators identically. Ditto for
1041          * verify, read and writes must have the same seed, if we are doing
1042          * read verify.
1043          */
1044         if (td->o.verify != VERIFY_NONE)
1045                 write_seed = read_seed;
1046         if (td_trimwrite(td))
1047                 trim_seed = write_seed;
1048         init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1049         init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1050         init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1051
1052         init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
1053                 use64);
1054         init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1055
1056         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1057                 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1058         else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1059                 init_rand_file_service(td);
1060
1061         init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1062         init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1063         init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1064         init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1065         init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1066         init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1067         init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1068         init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1069         init_rand_seed(&td->prio_state, td->rand_seeds[FIO_RAND_PRIO_CMDS], false);
1070         init_rand_seed(&td->dedupe_working_set_index_state, td->rand_seeds[FIO_RAND_DEDUPE_WORKING_SET_IX], use64);
1071
1072         init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1073
1074         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1075                 struct frand_state *s = &td->seq_rand_state[i];
1076
1077                 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1078         }
1079
1080         init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1081         frand_copy(&td->buf_state_prev, &td->buf_state);
1082 }
1083
1084 static int setup_random_seeds(struct thread_data *td)
1085 {
1086         uint64_t seed;
1087         unsigned int i;
1088
1089         if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1090                 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1091                 if (ret)
1092                         return ret;
1093         } else {
1094                 seed = td->o.rand_seed;
1095                 for (i = 0; i < 4; i++)
1096                         seed *= 0x9e370001UL;
1097
1098                 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1099                         td->rand_seeds[i] = seed * td->thread_number + i;
1100                         seed *= 0x9e370001UL;
1101                 }
1102         }
1103
1104         if (td->o.allrand_repeatable) {
1105                 unsigned int i;
1106
1107                 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1108                         td->rand_seeds[i] = FIO_RANDSEED * td->thread_number + i;
1109         }
1110
1111         if (td->o.rand_repeatable)
1112                 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1113
1114         td_fill_rand_seeds(td);
1115
1116         dprint(FD_RANDOM, "FIO_RAND_NR_OFFS=%d\n", FIO_RAND_NR_OFFS);
1117         for (int i = 0; i < FIO_RAND_NR_OFFS; i++)
1118                 dprint(FD_RANDOM, "rand_seeds[%d]=%" PRIu64 "\n", i, td->rand_seeds[i]);
1119
1120         return 0;
1121 }
1122
1123 /*
1124  * Initializes the ioengine configured for a job, if it has not been done so
1125  * already.
1126  */
1127 int ioengine_load(struct thread_data *td)
1128 {
1129         if (!td->o.ioengine) {
1130                 log_err("fio: internal fault, no IO engine specified\n");
1131                 return 1;
1132         }
1133
1134         if (td->io_ops) {
1135                 struct ioengine_ops *ops;
1136                 void *dlhandle;
1137
1138                 /* An engine is loaded, but the requested ioengine
1139                  * may have changed.
1140                  */
1141                 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1142                         /* The right engine is already loaded */
1143                         return 0;
1144                 }
1145
1146                 /*
1147                  * Name of file and engine may be different, load ops
1148                  * for this name and see if they match. If they do, then
1149                  * the engine is unchanged.
1150                  */
1151                 dlhandle = td->io_ops->dlhandle;
1152                 ops = load_ioengine(td);
1153                 if (!ops)
1154                         goto fail;
1155
1156                 if (ops == td->io_ops && dlhandle == td->io_ops->dlhandle)
1157                         return 0;
1158
1159                 if (dlhandle && dlhandle != td->io_ops->dlhandle)
1160                         dlclose(dlhandle);
1161
1162                 /* Unload the old engine. */
1163                 free_ioengine(td);
1164         }
1165
1166         td->io_ops = load_ioengine(td);
1167         if (!td->io_ops)
1168                 goto fail;
1169
1170         if (td->io_ops->option_struct_size && td->io_ops->options) {
1171                 /*
1172                  * In cases where td->eo is set, clone it for a child thread.
1173                  * This requires that the parent thread has the same ioengine,
1174                  * but that requirement must be enforced by the code which
1175                  * cloned the thread.
1176                  */
1177                 void *origeo = td->eo;
1178                 /*
1179                  * Otherwise use the default thread options.
1180                  */
1181                 if (!origeo && td != &def_thread && def_thread.eo &&
1182                     def_thread.io_ops->options == td->io_ops->options)
1183                         origeo = def_thread.eo;
1184
1185                 options_init(td->io_ops->options);
1186                 td->eo = malloc(td->io_ops->option_struct_size);
1187                 /*
1188                  * Use the default thread as an option template if this uses the
1189                  * same options structure and there are non-default options
1190                  * used.
1191                  */
1192                 if (origeo) {
1193                         memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1194                         options_mem_dupe(td->io_ops->options, td->eo);
1195                 } else {
1196                         memset(td->eo, 0, td->io_ops->option_struct_size);
1197                         fill_default_options(td->eo, td->io_ops->options);
1198                 }
1199                 *(struct thread_data **)td->eo = td;
1200         }
1201
1202         if (td->o.odirect)
1203                 td->io_ops->flags |= FIO_RAWIO;
1204
1205         td_set_ioengine_flags(td);
1206         return 0;
1207
1208 fail:
1209         log_err("fio: failed to load engine\n");
1210         return 1;
1211
1212 }
1213
1214 static void init_flags(struct thread_data *td)
1215 {
1216         struct thread_options *o = &td->o;
1217         int i;
1218
1219         if (o->verify_backlog)
1220                 td->flags |= TD_F_VER_BACKLOG;
1221         if (o->trim_backlog)
1222                 td->flags |= TD_F_TRIM_BACKLOG;
1223         if (o->read_iolog_file)
1224                 td->flags |= TD_F_READ_IOLOG;
1225         if (o->refill_buffers)
1226                 td->flags |= TD_F_REFILL_BUFFERS;
1227         /*
1228          * Always scramble buffers if asked to
1229          */
1230         if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1231                 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1232         /*
1233          * But also scramble buffers, unless we were explicitly asked
1234          * to zero them.
1235          */
1236         if (o->scramble_buffers && !(o->zero_buffers &&
1237             fio_option_is_set(o, zero_buffers)))
1238                 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1239         if (o->verify != VERIFY_NONE)
1240                 td->flags |= TD_F_DO_VERIFY;
1241
1242         if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1243                 td->flags |= TD_F_NEED_LOCK;
1244
1245         if (o->mem_type == MEM_CUDA_MALLOC)
1246                 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1247
1248         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1249                 if (option_check_rate(td, i)) {
1250                         td->flags |= TD_F_CHECK_RATE;
1251                         break;
1252                 }
1253         }
1254 }
1255
1256 enum {
1257         FPRE_NONE = 0,
1258         FPRE_JOBNAME,
1259         FPRE_JOBNUM,
1260         FPRE_FILENUM,
1261         FPRE_CLIENTUID
1262 };
1263
1264 static struct fpre_keyword {
1265         const char *keyword;
1266         size_t strlen;
1267         int key;
1268 } fpre_keywords[] = {
1269         { .keyword = "$jobname",        .key = FPRE_JOBNAME, },
1270         { .keyword = "$jobnum",         .key = FPRE_JOBNUM, },
1271         { .keyword = "$filenum",        .key = FPRE_FILENUM, },
1272         { .keyword = "$clientuid",      .key = FPRE_CLIENTUID, },
1273         { .keyword = NULL, },
1274         };
1275
1276 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1277                            const char *jobname, int jobnum, int filenum)
1278 {
1279         struct fpre_keyword *f;
1280         char copy[PATH_MAX];
1281         size_t dst_left = PATH_MAX - 1;
1282
1283         if (!o->filename_format || !strlen(o->filename_format)) {
1284                 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1285                 return buf;
1286         }
1287
1288         for (f = &fpre_keywords[0]; f->keyword; f++)
1289                 f->strlen = strlen(f->keyword);
1290
1291         snprintf(buf, buf_size, "%s", o->filename_format);
1292
1293         memset(copy, 0, sizeof(copy));
1294         for (f = &fpre_keywords[0]; f->keyword; f++) {
1295                 do {
1296                         size_t pre_len, post_start = 0;
1297                         char *str, *dst = copy;
1298
1299                         str = strcasestr(buf, f->keyword);
1300                         if (!str)
1301                                 break;
1302
1303                         pre_len = str - buf;
1304                         if (strlen(str) != f->strlen)
1305                                 post_start = pre_len + f->strlen;
1306
1307                         if (pre_len) {
1308                                 strncpy(dst, buf, pre_len);
1309                                 dst += pre_len;
1310                                 dst_left -= pre_len;
1311                         }
1312
1313                         switch (f->key) {
1314                         case FPRE_JOBNAME: {
1315                                 int ret;
1316
1317                                 ret = snprintf(dst, dst_left, "%s", jobname);
1318                                 if (ret < 0)
1319                                         break;
1320                                 else if (ret > dst_left) {
1321                                         log_err("fio: truncated filename\n");
1322                                         dst += dst_left;
1323                                         dst_left = 0;
1324                                 } else {
1325                                         dst += ret;
1326                                         dst_left -= ret;
1327                                 }
1328                                 break;
1329                                 }
1330                         case FPRE_JOBNUM: {
1331                                 int ret;
1332
1333                                 ret = snprintf(dst, dst_left, "%d", jobnum);
1334                                 if (ret < 0)
1335                                         break;
1336                                 else if (ret > dst_left) {
1337                                         log_err("fio: truncated filename\n");
1338                                         dst += dst_left;
1339                                         dst_left = 0;
1340                                 } else {
1341                                         dst += ret;
1342                                         dst_left -= ret;
1343                                 }
1344                                 break;
1345                                 }
1346                         case FPRE_FILENUM: {
1347                                 int ret;
1348
1349                                 ret = snprintf(dst, dst_left, "%d", filenum);
1350                                 if (ret < 0)
1351                                         break;
1352                                 else if (ret > dst_left) {
1353                                         log_err("fio: truncated filename\n");
1354                                         dst += dst_left;
1355                                         dst_left = 0;
1356                                 } else {
1357                                         dst += ret;
1358                                         dst_left -= ret;
1359                                 }
1360                                 break;
1361                                 }
1362                         case FPRE_CLIENTUID: {
1363                                 int ret;
1364                                 ret = snprintf(dst, dst_left, "%s", client_sockaddr_str);
1365                                 if (ret < 0)
1366                                         break;
1367                                 else if (ret > dst_left) {
1368                                         log_err("fio: truncated filename\n");
1369                                         dst += dst_left;
1370                                         dst_left = 0;
1371                                 } else {
1372                                         dst += ret;
1373                                         dst_left -= ret;
1374                                 }
1375                                 break;
1376                                 }
1377                         default:
1378                                 assert(0);
1379                                 break;
1380                         }
1381
1382                         if (post_start)
1383                                 strncpy(dst, buf + post_start, dst_left);
1384
1385                         snprintf(buf, buf_size, "%s", copy);
1386                 } while (1);
1387         }
1388
1389         return buf;
1390 }
1391
1392 bool parse_dryrun(void)
1393 {
1394         return dump_cmdline || parse_only;
1395 }
1396
1397 static void gen_log_name(char *name, size_t size, const char *logtype,
1398                          const char *logname, unsigned int num,
1399                          const char *suf, int per_job)
1400 {
1401         if (per_job)
1402                 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1403         else
1404                 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1405 }
1406
1407 static int check_waitees(char *waitee)
1408 {
1409         int ret = 0;
1410
1411         for_each_td(td) {
1412                 if (td->subjob_number)
1413                         continue;
1414
1415                 ret += !strcmp(td->o.name, waitee);
1416         } end_for_each();
1417
1418         return ret;
1419 }
1420
1421 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1422 {
1423         int nw;
1424
1425         if (!o->wait_for)
1426                 return true;
1427
1428         if (!strcmp(jobname, o->wait_for)) {
1429                 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1430                                 jobname, o->wait_for);
1431                 return false;
1432         }
1433
1434         if (!(nw = check_waitees(o->wait_for))) {
1435                 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1436                 return false;
1437         }
1438
1439         if (nw > 1) {
1440                 log_err("%s: multiple waitees %s found,\n"
1441                         "please avoid duplicates when using wait_for option.\n",
1442                                 jobname, o->wait_for);
1443                 return false;
1444         }
1445
1446         return true;
1447 }
1448
1449 static int verify_per_group_options(struct thread_data *td, const char *jobname)
1450 {
1451         for_each_td(td2) {
1452                 if (td->groupid != td2->groupid)
1453                         continue;
1454
1455                 if (td->o.stats &&
1456                     td->o.lat_percentiles != td2->o.lat_percentiles) {
1457                         log_err("fio: lat_percentiles in job: %s differs from group\n",
1458                                 jobname);
1459                         return 1;
1460                 }
1461         } end_for_each();
1462
1463         return 0;
1464 }
1465
1466 /*
1467  * Treat an empty log file name the same as a one not given
1468  */
1469 static const char *make_log_name(const char *logname, const char *jobname)
1470 {
1471         if (logname && strcmp(logname, ""))
1472                 return logname;
1473
1474         return jobname;
1475 }
1476
1477 /*
1478  * Adds a job to the list of things todo. Sanitizes the various options
1479  * to make sure we don't have conflicts, and initializes various
1480  * members of td.
1481  */
1482 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1483                    int recursed, int client_type)
1484 {
1485         unsigned int i;
1486         char fname[PATH_MAX + 1];
1487         int numjobs, file_alloced;
1488         struct thread_options *o = &td->o;
1489         char logname[PATH_MAX + 32];
1490
1491         /*
1492          * the def_thread is just for options, it's not a real job
1493          */
1494         if (td == &def_thread)
1495                 return 0;
1496
1497         init_flags(td);
1498
1499         /*
1500          * if we are just dumping the output command line, don't add the job
1501          */
1502         if (parse_dryrun()) {
1503                 put_job(td);
1504                 return 0;
1505         }
1506
1507         td->client_type = client_type;
1508
1509         if (profile_td_init(td))
1510                 goto err;
1511
1512         if (ioengine_load(td))
1513                 goto err;
1514
1515         file_alloced = 0;
1516         if (!o->filename && !td->files_index && !o->read_iolog_file) {
1517                 file_alloced = 1;
1518
1519                 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1520                         add_file(td, jobname, job_add_num, 0);
1521                 else {
1522                         for (i = 0; i < o->nr_files; i++)
1523                                 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1524                 }
1525         }
1526
1527         if (setup_random_seeds(td)) {
1528                 td_verror(td, errno, "setup_random_seeds");
1529                 goto err;
1530         }
1531
1532         if (fixup_options(td))
1533                 goto err;
1534
1535         if (!td->o.dedupe_global && init_dedupe_working_set_seeds(td, 0))
1536                 goto err;
1537
1538         /*
1539          * Belongs to fixup_options, but o->name is not necessarily set as yet
1540          */
1541         if (!wait_for_ok(jobname, o))
1542                 goto err;
1543
1544         flow_init_job(td);
1545
1546         /*
1547          * IO engines only need this for option callbacks, and the address may
1548          * change in subprocesses.
1549          */
1550         if (td->eo)
1551                 *(struct thread_data **)td->eo = NULL;
1552
1553         if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1554                 struct fio_file *f;
1555
1556                 for_each_file(td, f, i)
1557                         f->real_file_size = -1ULL;
1558         }
1559
1560         td->sem = fio_sem_init(FIO_SEM_LOCKED);
1561
1562         td->ts.clat_percentiles = o->clat_percentiles;
1563         td->ts.lat_percentiles = o->lat_percentiles;
1564         td->ts.slat_percentiles = o->slat_percentiles;
1565         td->ts.percentile_precision = o->percentile_precision;
1566         memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1567         td->ts.sig_figs = o->sig_figs;
1568
1569         init_thread_stat_min_vals(&td->ts);
1570
1571         /*
1572          * td->>ddir_seq_nr needs to be initialized to 1, NOT o->ddir_seq_nr,
1573          * so that get_next_offset gets a new random offset the first time it
1574          * is called, instead of keeping an initial offset of 0 for the first
1575          * nr-1 calls
1576          */
1577         td->ddir_seq_nr = 1;
1578
1579         if ((o->stonewall || o->new_group) && prev_group_jobs) {
1580                 prev_group_jobs = 0;
1581                 groupid++;
1582                 if (groupid == INT_MAX) {
1583                         log_err("fio: too many groups defined\n");
1584                         goto err;
1585                 }
1586         }
1587
1588         td->groupid = groupid;
1589         prev_group_jobs++;
1590
1591         if (td->o.group_reporting && prev_group_jobs > 1 &&
1592             verify_per_group_options(td, jobname))
1593                 goto err;
1594
1595         if (setup_rate(td))
1596                 goto err;
1597
1598         if (o->write_lat_log) {
1599                 struct log_params p = {
1600                         .td = td,
1601                         .avg_msec = o->log_avg_msec,
1602                         .hist_msec = o->log_hist_msec,
1603                         .hist_coarseness = o->log_hist_coarseness,
1604                         .log_type = IO_LOG_TYPE_LAT,
1605                         .log_offset = o->log_offset,
1606                         .log_prio = o->log_prio,
1607                         .log_gz = o->log_gz,
1608                         .log_gz_store = o->log_gz_store,
1609                 };
1610                 const char *pre = make_log_name(o->lat_log_file, o->name);
1611                 const char *suf;
1612
1613                 if (p.log_gz_store)
1614                         suf = "log.fz";
1615                 else
1616                         suf = "log";
1617
1618                 if (!o->disable_lat) {
1619                         gen_log_name(logname, sizeof(logname), "lat", pre,
1620                                      td->thread_number, suf, o->per_job_logs);
1621                         setup_log(&td->lat_log, &p, logname);
1622                 }
1623
1624                 if (!o->disable_slat) {
1625                         gen_log_name(logname, sizeof(logname), "slat", pre,
1626                                      td->thread_number, suf, o->per_job_logs);
1627                         setup_log(&td->slat_log, &p, logname);
1628                 }
1629
1630                 if (!o->disable_clat) {
1631                         gen_log_name(logname, sizeof(logname), "clat", pre,
1632                                      td->thread_number, suf, o->per_job_logs);
1633                         setup_log(&td->clat_log, &p, logname);
1634                 }
1635
1636         }
1637
1638         if (o->write_hist_log) {
1639                 struct log_params p = {
1640                         .td = td,
1641                         .avg_msec = o->log_avg_msec,
1642                         .hist_msec = o->log_hist_msec,
1643                         .hist_coarseness = o->log_hist_coarseness,
1644                         .log_type = IO_LOG_TYPE_HIST,
1645                         .log_offset = o->log_offset,
1646                         .log_prio = o->log_prio,
1647                         .log_gz = o->log_gz,
1648                         .log_gz_store = o->log_gz_store,
1649                 };
1650                 const char *pre = make_log_name(o->hist_log_file, o->name);
1651                 const char *suf;
1652
1653 #ifndef CONFIG_ZLIB
1654                 if (td->client_type) {
1655                         log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1656                         goto err;
1657                 }
1658 #endif
1659
1660                 if (p.log_gz_store)
1661                         suf = "log.fz";
1662                 else
1663                         suf = "log";
1664
1665                 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1666                                 td->thread_number, suf, o->per_job_logs);
1667                 setup_log(&td->clat_hist_log, &p, logname);
1668         }
1669
1670         if (o->write_bw_log) {
1671                 struct log_params p = {
1672                         .td = td,
1673                         .avg_msec = o->log_avg_msec,
1674                         .hist_msec = o->log_hist_msec,
1675                         .hist_coarseness = o->log_hist_coarseness,
1676                         .log_type = IO_LOG_TYPE_BW,
1677                         .log_offset = o->log_offset,
1678                         .log_prio = o->log_prio,
1679                         .log_gz = o->log_gz,
1680                         .log_gz_store = o->log_gz_store,
1681                 };
1682                 const char *pre = make_log_name(o->bw_log_file, o->name);
1683                 const char *suf;
1684
1685                 if (fio_option_is_set(o, bw_avg_time))
1686                         p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1687                 else
1688                         o->bw_avg_time = p.avg_msec;
1689
1690                 p.hist_msec = o->log_hist_msec;
1691                 p.hist_coarseness = o->log_hist_coarseness;
1692
1693                 if (p.log_gz_store)
1694                         suf = "log.fz";
1695                 else
1696                         suf = "log";
1697
1698                 gen_log_name(logname, sizeof(logname), "bw", pre,
1699                                 td->thread_number, suf, o->per_job_logs);
1700                 setup_log(&td->bw_log, &p, logname);
1701         }
1702         if (o->write_iops_log) {
1703                 struct log_params p = {
1704                         .td = td,
1705                         .avg_msec = o->log_avg_msec,
1706                         .hist_msec = o->log_hist_msec,
1707                         .hist_coarseness = o->log_hist_coarseness,
1708                         .log_type = IO_LOG_TYPE_IOPS,
1709                         .log_offset = o->log_offset,
1710                         .log_prio = o->log_prio,
1711                         .log_gz = o->log_gz,
1712                         .log_gz_store = o->log_gz_store,
1713                 };
1714                 const char *pre = make_log_name(o->iops_log_file, o->name);
1715                 const char *suf;
1716
1717                 if (fio_option_is_set(o, iops_avg_time))
1718                         p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1719                 else
1720                         o->iops_avg_time = p.avg_msec;
1721
1722                 p.hist_msec = o->log_hist_msec;
1723                 p.hist_coarseness = o->log_hist_coarseness;
1724
1725                 if (p.log_gz_store)
1726                         suf = "log.fz";
1727                 else
1728                         suf = "log";
1729
1730                 gen_log_name(logname, sizeof(logname), "iops", pre,
1731                                 td->thread_number, suf, o->per_job_logs);
1732                 setup_log(&td->iops_log, &p, logname);
1733         }
1734
1735         if (!o->name)
1736                 o->name = strdup(jobname);
1737
1738         if (output_format & FIO_OUTPUT_NORMAL) {
1739                 if (!job_add_num) {
1740                         if (is_backend && !recursed)
1741                                 fio_server_send_add_job(td);
1742
1743                         if (!td_ioengine_flagged(td, FIO_NOIO)) {
1744                                 char *c1, *c2, *c3, *c4;
1745                                 char *c5 = NULL, *c6 = NULL;
1746                                 int i2p = is_power_of_2(o->kb_base);
1747                                 struct buf_output out;
1748
1749                                 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1750                                 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1751                                 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1752                                 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1753
1754                                 if (!o->bs_is_seq_rand) {
1755                                         c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1756                                         c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1757                                 }
1758
1759                                 buf_output_init(&out);
1760                                 __log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
1761                                                         td->groupid,
1762                                                         ddir_str(o->td_ddir));
1763
1764                                 if (o->bs_is_seq_rand)
1765                                         __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1766                                                         c1, c2, c3, c4);
1767                                 else
1768                                         __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1769                                                         c1, c2, c3, c4, c5, c6);
1770
1771                                 __log_buf(&out, "ioengine=%s, iodepth=%u\n",
1772                                                 td->io_ops->name, o->iodepth);
1773                                 log_info_buf(out.buf, out.buflen);
1774                                 buf_output_free(&out);
1775
1776                                 free(c1);
1777                                 free(c2);
1778                                 free(c3);
1779                                 free(c4);
1780                                 free(c5);
1781                                 free(c6);
1782                         }
1783                 } else if (job_add_num == 1)
1784                         log_info("...\n");
1785         }
1786
1787         if (td_steadystate_init(td))
1788                 goto err;
1789
1790         if (o->merge_blktrace_file && !merge_blktrace_iologs(td))
1791                 goto err;
1792
1793         if (merge_blktrace_only) {
1794                 put_job(td);
1795                 return 0;
1796         }
1797
1798         /*
1799          * recurse add identical jobs, clear numjobs and stonewall options
1800          * as they don't apply to sub-jobs
1801          */
1802         numjobs = o->numjobs;
1803         while (--numjobs) {
1804                 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1805
1806                 if (!td_new)
1807                         goto err;
1808
1809                 td_new->o.numjobs = 1;
1810                 td_new->o.stonewall = 0;
1811                 td_new->o.new_group = 0;
1812                 td_new->subjob_number = numjobs;
1813                 td_new->o.ss_dur = o->ss_dur * 1000000l;
1814                 td_new->o.ss_limit = o->ss_limit;
1815
1816                 if (file_alloced) {
1817                         if (td_new->files) {
1818                                 struct fio_file *f;
1819                                 for_each_file(td_new, f, i)
1820                                         fio_file_free(f);
1821                                 free(td_new->files);
1822                                 td_new->files = NULL;
1823                         }
1824                         td_new->files_index = 0;
1825                         td_new->files_size = 0;
1826                         if (td_new->o.filename) {
1827                                 free(td_new->o.filename);
1828                                 td_new->o.filename = NULL;
1829                         }
1830                 }
1831
1832                 if (add_job(td_new, jobname, numjobs, 1, client_type))
1833                         goto err;
1834         }
1835
1836         return 0;
1837 err:
1838         put_job(td);
1839         return -1;
1840 }
1841
1842 /*
1843  * Parse as if 'o' was a command line
1844  */
1845 void add_job_opts(const char **o, int client_type)
1846 {
1847         struct thread_data *td, *td_parent;
1848         int i, in_global = 1;
1849         char jobname[32];
1850
1851         i = 0;
1852         td_parent = td = NULL;
1853         while (o[i]) {
1854                 if (!strncmp(o[i], "name", 4)) {
1855                         in_global = 0;
1856                         if (td)
1857                                 add_job(td, jobname, 0, 0, client_type);
1858                         td = NULL;
1859                         sprintf(jobname, "%s", o[i] + 5);
1860                 }
1861                 if (in_global && !td_parent)
1862                         td_parent = get_new_job(true, &def_thread, false, jobname);
1863                 else if (!in_global && !td) {
1864                         if (!td_parent)
1865                                 td_parent = &def_thread;
1866                         td = get_new_job(false, td_parent, false, jobname);
1867                 }
1868                 if (in_global)
1869                         fio_options_parse(td_parent, (char **) &o[i], 1);
1870                 else
1871                         fio_options_parse(td, (char **) &o[i], 1);
1872                 i++;
1873         }
1874
1875         if (td)
1876                 add_job(td, jobname, 0, 0, client_type);
1877 }
1878
1879 static int skip_this_section(const char *name)
1880 {
1881         int i;
1882
1883         if (!nr_job_sections)
1884                 return 0;
1885         if (!strncmp(name, "global", 6))
1886                 return 0;
1887
1888         for (i = 0; i < nr_job_sections; i++)
1889                 if (!strcmp(job_sections[i], name))
1890                         return 0;
1891
1892         return 1;
1893 }
1894
1895 static int is_empty_or_comment(char *line)
1896 {
1897         unsigned int i;
1898
1899         for (i = 0; i < strlen(line); i++) {
1900                 if (line[i] == ';')
1901                         return 1;
1902                 if (line[i] == '#')
1903                         return 1;
1904                 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1905                         return 0;
1906         }
1907
1908         return 1;
1909 }
1910
1911 /*
1912  * This is our [ini] type file parser.
1913  */
1914 static int __parse_jobs_ini(struct thread_data *td,
1915                 char *file, int is_buf, int stonewall_flag, int type,
1916                 int nested, char *name, char ***popts, int *aopts, int *nopts)
1917 {
1918         bool global = false;
1919         bool stdin_occupied = false;
1920         char *string;
1921         FILE *f;
1922         char *p;
1923         int ret = 0, stonewall;
1924         int first_sect = 1;
1925         int skip_fgets = 0;
1926         int inside_skip = 0;
1927         char **opts;
1928         int i, alloc_opts, num_opts;
1929
1930         dprint(FD_PARSE, "Parsing ini file %s\n", file);
1931         assert(td || !nested);
1932
1933         if (is_buf)
1934                 f = NULL;
1935         else {
1936                 if (!strcmp(file, "-")) {
1937                         f = stdin;
1938                         stdin_occupied = true;
1939                 } else
1940                         f = fopen(file, "r");
1941
1942                 if (!f) {
1943                         int __err = errno;
1944
1945                         log_err("fio: unable to open '%s' job file\n", file);
1946                         if (td)
1947                                 td_verror(td, __err, "job file open");
1948                         return 1;
1949                 }
1950         }
1951
1952         string = malloc(OPT_LEN_MAX);
1953
1954         /*
1955          * it's really 256 + small bit, 280 should suffice
1956          */
1957         if (!nested) {
1958                 name = malloc(280);
1959                 memset(name, 0, 280);
1960         }
1961
1962         opts = NULL;
1963         if (nested && popts) {
1964                 opts = *popts;
1965                 alloc_opts = *aopts;
1966                 num_opts = *nopts;
1967         }
1968
1969         if (!opts) {
1970                 alloc_opts = 8;
1971                 opts = malloc(sizeof(char *) * alloc_opts);
1972                 num_opts = 0;
1973         }
1974
1975         stonewall = stonewall_flag;
1976         do {
1977                 /*
1978                  * if skip_fgets is set, we already have loaded a line we
1979                  * haven't handled.
1980                  */
1981                 if (!skip_fgets) {
1982                         if (is_buf)
1983                                 p = strsep(&file, "\n");
1984                         else
1985                                 p = fgets(string, OPT_LEN_MAX, f);
1986                         if (!p)
1987                                 break;
1988                 }
1989
1990                 skip_fgets = 0;
1991                 strip_blank_front(&p);
1992                 strip_blank_end(p);
1993
1994                 dprint(FD_PARSE, "%s\n", p);
1995                 if (is_empty_or_comment(p))
1996                         continue;
1997
1998                 if (!nested) {
1999                         if (sscanf(p, "[%255[^\n]]", name) != 1) {
2000                                 if (inside_skip)
2001                                         continue;
2002
2003                                 log_err("fio: option <%s> outside of "
2004                                         "[] job section\n", p);
2005                                 ret = 1;
2006                                 break;
2007                         }
2008
2009                         name[strlen(name) - 1] = '\0';
2010
2011                         if (skip_this_section(name)) {
2012                                 inside_skip = 1;
2013                                 continue;
2014                         } else
2015                                 inside_skip = 0;
2016
2017                         dprint(FD_PARSE, "Parsing section [%s]\n", name);
2018
2019                         global = !strncmp(name, "global", 6);
2020
2021                         if (dump_cmdline) {
2022                                 if (first_sect)
2023                                         log_info("fio ");
2024                                 if (!global)
2025                                         log_info("--name=%s ", name);
2026                                 first_sect = 0;
2027                         }
2028
2029                         td = get_new_job(global, &def_thread, false, name);
2030                         if (!td) {
2031                                 ret = 1;
2032                                 break;
2033                         }
2034
2035                         /*
2036                          * Separate multiple job files by a stonewall
2037                          */
2038                         if (!global && stonewall) {
2039                                 td->o.stonewall = stonewall;
2040                                 stonewall = 0;
2041                         }
2042
2043                         num_opts = 0;
2044                         memset(opts, 0, alloc_opts * sizeof(char *));
2045                 }
2046                 else
2047                         skip_fgets = 1;
2048
2049                 while (1) {
2050                         if (!skip_fgets) {
2051                                 if (is_buf)
2052                                         p = strsep(&file, "\n");
2053                                 else
2054                                         p = fgets(string, OPT_LEN_MAX, f);
2055                                 if (!p)
2056                                         break;
2057                                 dprint(FD_PARSE, "%s", p);
2058                         }
2059                         else
2060                                 skip_fgets = 0;
2061
2062                         if (is_empty_or_comment(p))
2063                                 continue;
2064
2065                         strip_blank_front(&p);
2066
2067                         /*
2068                          * new section, break out and make sure we don't
2069                          * fgets() a new line at the top.
2070                          */
2071                         if (p[0] == '[') {
2072                                 if (nested) {
2073                                         log_err("No new sections in included files\n");
2074                                         ret = 1;
2075                                         goto out;
2076                                 }
2077
2078                                 skip_fgets = 1;
2079                                 break;
2080                         }
2081
2082                         strip_blank_end(p);
2083
2084                         if (!strncmp(p, "include", strlen("include"))) {
2085                                 char *filename = p + strlen("include") + 1,
2086                                         *ts, *full_fn = NULL;
2087
2088                                 /*
2089                                  * Allow for the include filename
2090                                  * specification to be relative.
2091                                  */
2092                                 if (access(filename, F_OK) &&
2093                                     (ts = strrchr(file, '/'))) {
2094                                         if (asprintf(&full_fn, "%.*s%s",
2095                                                  (int)(ts - file + 1), file,
2096                                                  filename) < 0) {
2097                                                 ret = ENOMEM;
2098                                                 break;
2099                                         }
2100                                         filename = full_fn;
2101                                 }
2102
2103                                 ret = __parse_jobs_ini(td, filename, is_buf,
2104                                                        stonewall_flag, type, 1,
2105                                                        name, &opts,
2106                                                        &alloc_opts, &num_opts);
2107
2108                                 if (ret) {
2109                                         log_err("Error %d while parsing "
2110                                                 "include file %s\n",
2111                                                 ret, filename);
2112                                 }
2113
2114                                 if (full_fn)
2115                                         free(full_fn);
2116
2117                                 if (ret)
2118                                         break;
2119
2120                                 continue;
2121                         }
2122
2123                         if (num_opts == alloc_opts) {
2124                                 alloc_opts <<= 1;
2125                                 opts = realloc(opts,
2126                                                 alloc_opts * sizeof(char *));
2127                         }
2128
2129                         opts[num_opts] = strdup(p);
2130                         num_opts++;
2131                 }
2132
2133                 if (nested) {
2134                         *popts = opts;
2135                         *aopts = alloc_opts;
2136                         *nopts = num_opts;
2137                         goto out;
2138                 }
2139
2140                 ret = fio_options_parse(td, opts, num_opts);
2141
2142                 if (!ret && td->o.read_iolog_file != NULL) {
2143                         char *fname = get_name_by_idx(td->o.read_iolog_file,
2144                                                       td->subjob_number);
2145                         if (!strcmp(fname, "-")) {
2146                                 if (stdin_occupied) {
2147                                         log_err("fio: only one user (read_iolog_file/job "
2148                                                 "file) of stdin is permitted at once but "
2149                                                 "more than one was found.\n");
2150                                         ret = 1;
2151                                 }
2152                                 stdin_occupied = true;
2153                         }
2154                 }
2155                 if (!ret) {
2156                         if (dump_cmdline)
2157                                 dump_opt_list(td);
2158
2159                         ret = add_job(td, name, 0, 0, type);
2160                 } else {
2161                         log_err("fio: job %s dropped\n", name);
2162                         put_job(td);
2163                 }
2164
2165                 for (i = 0; i < num_opts; i++)
2166                         free(opts[i]);
2167                 num_opts = 0;
2168         } while (!ret);
2169
2170         if (dump_cmdline)
2171                 log_info("\n");
2172
2173         i = 0;
2174         while (i < nr_job_sections) {
2175                 free(job_sections[i]);
2176                 i++;
2177         }
2178
2179         free(job_sections);
2180         job_sections = NULL;
2181         nr_job_sections = 0;
2182
2183         free(opts);
2184 out:
2185         free(string);
2186         if (!nested)
2187                 free(name);
2188         if (!is_buf && f != stdin)
2189                 fclose(f);
2190         return ret;
2191 }
2192
2193 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2194 {
2195         return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2196                         0, NULL, NULL, NULL, NULL);
2197 }
2198
2199 static int fill_def_thread(void)
2200 {
2201         memset(&def_thread, 0, sizeof(def_thread));
2202         INIT_FLIST_HEAD(&def_thread.opt_list);
2203
2204         fio_getaffinity(getpid(), &def_thread.o.cpumask);
2205         def_thread.o.error_dump = 1;
2206
2207         /*
2208          * fill default options
2209          */
2210         fio_fill_default_options(&def_thread);
2211         return 0;
2212 }
2213
2214 static void show_debug_categories(void)
2215 {
2216 #ifdef FIO_INC_DEBUG
2217         const struct debug_level *dl = &debug_levels[0];
2218         int curlen, first = 1;
2219
2220         curlen = 0;
2221         while (dl->name) {
2222                 int has_next = (dl + 1)->name != NULL;
2223
2224                 if (first || curlen + strlen(dl->name) >= 80) {
2225                         if (!first) {
2226                                 printf("\n");
2227                                 curlen = 0;
2228                         }
2229                         curlen += printf("\t\t\t%s", dl->name);
2230                         curlen += 3 * (8 - 1);
2231                         if (has_next)
2232                                 curlen += printf(",");
2233                 } else {
2234                         curlen += printf("%s", dl->name);
2235                         if (has_next)
2236                                 curlen += printf(",");
2237                 }
2238                 dl++;
2239                 first = 0;
2240         }
2241         printf("\n");
2242 #endif
2243 }
2244
2245 /*
2246  * Following options aren't printed by usage().
2247  * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2248  * --latency-log - Deprecated option.
2249  */
2250 static void usage(const char *name)
2251 {
2252         printf("%s\n", fio_version_string);
2253         printf("%s [options] [job options] <job file(s)>\n", name);
2254         printf("  --debug=options\tEnable debug logging. May be one/more of:\n");
2255         show_debug_categories();
2256         printf("  --parse-only\t\tParse options only, don't start any IO\n");
2257         printf("  --merge-blktrace-only\tMerge blktraces only, don't start any IO\n");
2258         printf("  --output\t\tWrite output to file\n");
2259         printf("  --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2260         printf("  --minimal\t\tMinimal (terse) output\n");
2261         printf("  --output-format=type\tOutput format (terse,json,json+,normal)\n");
2262         printf("  --terse-version=type\tSet terse version output format"
2263                 " (default 3, or 2 or 4 or 5)\n");
2264         printf("  --version\t\tPrint version info and exit\n");
2265         printf("  --help\t\tPrint this page\n");
2266         printf("  --cpuclock-test\tPerform test/validation of CPU clock\n");
2267         printf("  --crctest=[type]\tTest speed of checksum functions\n");
2268         printf("  --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2269                 " them\n");
2270         printf("  --enghelp=engine\tPrint ioengine help, or list"
2271                 " available ioengines\n");
2272         printf("  --enghelp=engine,cmd\tPrint help for an ioengine"
2273                 " cmd\n");
2274         printf("  --showcmd\t\tTurn a job file into command line options\n");
2275         printf("  --eta=when\t\tWhen ETA estimate should be printed\n");
2276         printf("            \t\tMay be \"always\", \"never\" or \"auto\"\n");
2277         printf("  --eta-newline=t\tForce a new line for every 't'");
2278         printf(" period passed\n");
2279         printf("  --status-interval=t\tForce full status dump every");
2280         printf(" 't' period passed\n");
2281         printf("  --readonly\t\tTurn on safety read-only checks, preventing"
2282                 " writes\n");
2283         printf("  --section=name\tOnly run specified section in job file,"
2284                 " multiple sections can be specified\n");
2285         printf("  --alloc-size=kb\tSet smalloc pool to this size in kb"
2286                 " (def 16384)\n");
2287         printf("  --warnings-fatal\tFio parser warnings are fatal\n");
2288         printf("  --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2289         printf("  --server=args\t\tStart a backend fio server\n");
2290         printf("  --daemonize=pidfile\tBackground fio server, write pid to file\n");
2291         printf("  --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2292         printf("  --remote-config=file\tTell fio server to load this local job file\n");
2293         printf("  --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2294                 "\t\t\t(option=system,percpu) or run unit work\n"
2295                 "\t\t\tcalibration only (option=calibrate)\n");
2296 #ifdef CONFIG_ZLIB
2297         printf("  --inflate-log=log\tInflate and output compressed log\n");
2298 #endif
2299         printf("  --trigger-file=file\tExecute trigger cmd when file exists\n");
2300         printf("  --trigger-timeout=t\tExecute trigger at this time\n");
2301         printf("  --trigger=cmd\t\tSet this command as local trigger\n");
2302         printf("  --trigger-remote=cmd\tSet this command as remote trigger\n");
2303         printf("  --aux-path=path\tUse this path for fio state generated files\n");
2304         printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2305 }
2306
2307 #ifdef FIO_INC_DEBUG
2308 const struct debug_level debug_levels[] = {
2309         { .name = "process",
2310           .help = "Process creation/exit logging",
2311           .shift = FD_PROCESS,
2312         },
2313         { .name = "file",
2314           .help = "File related action logging",
2315           .shift = FD_FILE,
2316         },
2317         { .name = "io",
2318           .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2319           .shift = FD_IO,
2320         },
2321         { .name = "mem",
2322           .help = "Memory allocation/freeing logging",
2323           .shift = FD_MEM,
2324         },
2325         { .name = "blktrace",
2326           .help = "blktrace action logging",
2327           .shift = FD_BLKTRACE,
2328         },
2329         { .name = "verify",
2330           .help = "IO verification action logging",
2331           .shift = FD_VERIFY,
2332         },
2333         { .name = "random",
2334           .help = "Random generation logging",
2335           .shift = FD_RANDOM,
2336         },
2337         { .name = "parse",
2338           .help = "Parser logging",
2339           .shift = FD_PARSE,
2340         },
2341         { .name = "diskutil",
2342           .help = "Disk utility logging actions",
2343           .shift = FD_DISKUTIL,
2344         },
2345         { .name = "job",
2346           .help = "Logging related to creating/destroying jobs",
2347           .shift = FD_JOB,
2348         },
2349         { .name = "mutex",
2350           .help = "Mutex logging",
2351           .shift = FD_MUTEX
2352         },
2353         { .name = "profile",
2354           .help = "Logging related to profiles",
2355           .shift = FD_PROFILE,
2356         },
2357         { .name = "time",
2358           .help = "Logging related to time keeping functions",
2359           .shift = FD_TIME,
2360         },
2361         { .name = "net",
2362           .help = "Network logging",
2363           .shift = FD_NET,
2364         },
2365         { .name = "rate",
2366           .help = "Rate logging",
2367           .shift = FD_RATE,
2368         },
2369         { .name = "compress",
2370           .help = "Log compression logging",
2371           .shift = FD_COMPRESS,
2372         },
2373         { .name = "steadystate",
2374           .help = "Steady state detection logging",
2375           .shift = FD_STEADYSTATE,
2376         },
2377         { .name = "helperthread",
2378           .help = "Helper thread logging",
2379           .shift = FD_HELPERTHREAD,
2380         },
2381         { .name = "zbd",
2382           .help = "Zoned Block Device logging",
2383           .shift = FD_ZBD,
2384         },
2385         { .name = NULL, },
2386 };
2387
2388 static int set_debug(const char *string)
2389 {
2390         const struct debug_level *dl;
2391         char *p = (char *) string;
2392         char *opt;
2393         int i;
2394
2395         if (!string)
2396                 return 0;
2397
2398         if (!strcmp(string, "?") || !strcmp(string, "help")) {
2399                 log_info("fio: dumping debug options:");
2400                 for (i = 0; debug_levels[i].name; i++) {
2401                         dl = &debug_levels[i];
2402                         log_info("%s,", dl->name);
2403                 }
2404                 log_info("all\n");
2405                 return 1;
2406         }
2407
2408         while ((opt = strsep(&p, ",")) != NULL) {
2409                 int found = 0;
2410
2411                 if (!strncmp(opt, "all", 3)) {
2412                         log_info("fio: set all debug options\n");
2413                         fio_debug = ~0UL;
2414                         continue;
2415                 }
2416
2417                 for (i = 0; debug_levels[i].name; i++) {
2418                         dl = &debug_levels[i];
2419                         found = !strncmp(opt, dl->name, strlen(dl->name));
2420                         if (!found)
2421                                 continue;
2422
2423                         if (dl->shift == FD_JOB) {
2424                                 opt = strchr(opt, ':');
2425                                 if (!opt) {
2426                                         log_err("fio: missing job number\n");
2427                                         break;
2428                                 }
2429                                 opt++;
2430                                 fio_debug_jobno = atoi(opt);
2431                                 log_info("fio: set debug jobno %d\n",
2432                                                         fio_debug_jobno);
2433                         } else {
2434                                 log_info("fio: set debug option %s\n", opt);
2435                                 fio_debug |= (1UL << dl->shift);
2436                         }
2437                         break;
2438                 }
2439
2440                 if (!found)
2441                         log_err("fio: debug mask %s not found\n", opt);
2442         }
2443         return 0;
2444 }
2445 #else
2446 static int set_debug(const char *string)
2447 {
2448         log_err("fio: debug tracing not included in build\n");
2449         return 1;
2450 }
2451 #endif
2452
2453 static void fio_options_fill_optstring(void)
2454 {
2455         char *ostr = cmd_optstr;
2456         int i, c;
2457
2458         c = i = 0;
2459         while (l_opts[i].name) {
2460                 ostr[c++] = l_opts[i].val;
2461                 if (l_opts[i].has_arg == required_argument)
2462                         ostr[c++] = ':';
2463                 else if (l_opts[i].has_arg == optional_argument) {
2464                         ostr[c++] = ':';
2465                         ostr[c++] = ':';
2466                 }
2467                 i++;
2468         }
2469         ostr[c] = '\0';
2470 }
2471
2472 static int client_flag_set(char c)
2473 {
2474         int i;
2475
2476         i = 0;
2477         while (l_opts[i].name) {
2478                 int val = l_opts[i].val;
2479
2480                 if (c == (val & 0xff))
2481                         return (val & FIO_CLIENT_FLAG);
2482
2483                 i++;
2484         }
2485
2486         return 0;
2487 }
2488
2489 static void parse_cmd_client(void *client, char *opt)
2490 {
2491         fio_client_add_cmd_option(client, opt);
2492 }
2493
2494 static void show_closest_option(const char *name)
2495 {
2496         int best_option, best_distance;
2497         int i, distance;
2498
2499         while (*name == '-')
2500                 name++;
2501
2502         best_option = -1;
2503         best_distance = INT_MAX;
2504         i = 0;
2505         while (l_opts[i].name) {
2506                 distance = string_distance(name, l_opts[i].name);
2507                 if (distance < best_distance) {
2508                         best_distance = distance;
2509                         best_option = i;
2510                 }
2511                 i++;
2512         }
2513
2514         if (best_option != -1 && string_distance_ok(name, best_distance))
2515                 log_err("Did you mean %s?\n", l_opts[best_option].name);
2516 }
2517
2518 static int parse_output_format(const char *optarg)
2519 {
2520         char *p, *orig, *opt;
2521         int ret = 0;
2522
2523         p = orig = strdup(optarg);
2524
2525         output_format = 0;
2526
2527         while ((opt = strsep(&p, ",")) != NULL) {
2528                 if (!strcmp(opt, "minimal") ||
2529                     !strcmp(opt, "terse") ||
2530                     !strcmp(opt, "csv"))
2531                         output_format |= FIO_OUTPUT_TERSE;
2532                 else if (!strcmp(opt, "json"))
2533                         output_format |= FIO_OUTPUT_JSON;
2534                 else if (!strcmp(opt, "json+"))
2535                         output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2536                 else if (!strcmp(opt, "normal"))
2537                         output_format |= FIO_OUTPUT_NORMAL;
2538                 else {
2539                         log_err("fio: invalid output format %s\n", opt);
2540                         ret = 1;
2541                         break;
2542                 }
2543         }
2544
2545         free(orig);
2546         return ret;
2547 }
2548
2549 int parse_cmd_line(int argc, char *argv[], int client_type)
2550 {
2551         struct thread_data *td = NULL;
2552         int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2553         char *ostr = cmd_optstr;
2554         char *pid_file = NULL;
2555         void *cur_client = NULL;
2556         bool backend = false;
2557
2558         /*
2559          * Reset optind handling, since we may call this multiple times
2560          * for the backend.
2561          */
2562         optind = 1;
2563
2564         while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2565                 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2566                         parse_cmd_client(cur_client, argv[optind - 1]);
2567                         c &= ~FIO_CLIENT_FLAG;
2568                 }
2569
2570                 switch (c) {
2571                 case 'a':
2572                         smalloc_pool_size = atoi(optarg);
2573                         smalloc_pool_size <<= 10;
2574                         sinit();
2575                         break;
2576                 case 'l':
2577                         log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2578                         do_exit++;
2579                         exit_val = 1;
2580                         break;
2581                 case 'b':
2582                         write_bw_log = true;
2583                         break;
2584                 case 'o': {
2585                         FILE *tmp;
2586
2587                         if (f_out && f_out != stdout)
2588                                 fclose(f_out);
2589
2590                         tmp = fopen(optarg, "w+");
2591                         if (!tmp) {
2592                                 log_err("fio: output file open error: %s\n", strerror(errno));
2593                                 exit_val = 1;
2594                                 do_exit++;
2595                                 break;
2596                         }
2597                         f_err = f_out = tmp;
2598                         break;
2599                         }
2600                 case 'm':
2601                         output_format = FIO_OUTPUT_TERSE;
2602                         break;
2603                 case 'F':
2604                         if (parse_output_format(optarg)) {
2605                                 log_err("fio: failed parsing output-format\n");
2606                                 exit_val = 1;
2607                                 do_exit++;
2608                                 break;
2609                         }
2610                         break;
2611                 case 'f':
2612                         output_format |= FIO_OUTPUT_TERSE;
2613                         break;
2614                 case 'h':
2615                         did_arg = true;
2616                         if (!cur_client) {
2617                                 usage(argv[0]);
2618                                 do_exit++;
2619                         }
2620                         break;
2621                 case 'c':
2622                         did_arg = true;
2623                         if (!cur_client) {
2624                                 fio_show_option_help(optarg);
2625                                 do_exit++;
2626                         }
2627                         break;
2628                 case 'i':
2629                         did_arg = true;
2630                         if (!cur_client) {
2631                                 exit_val = fio_show_ioengine_help(optarg);
2632                                 do_exit++;
2633                         }
2634                         break;
2635                 case 's':
2636                         did_arg = true;
2637                         dump_cmdline = true;
2638                         break;
2639                 case 'r':
2640                         read_only = 1;
2641                         break;
2642                 case 'v':
2643                         did_arg = true;
2644                         if (!cur_client) {
2645                                 log_info("%s\n", fio_version_string);
2646                                 do_exit++;
2647                         }
2648                         break;
2649                 case 'V':
2650                         terse_version = atoi(optarg);
2651                         if (!(terse_version >= 2 && terse_version <= 5)) {
2652                                 log_err("fio: bad terse version format\n");
2653                                 exit_val = 1;
2654                                 do_exit++;
2655                         }
2656                         break;
2657                 case 'e':
2658                         if (!strcmp("always", optarg))
2659                                 eta_print = FIO_ETA_ALWAYS;
2660                         else if (!strcmp("never", optarg))
2661                                 eta_print = FIO_ETA_NEVER;
2662                         break;
2663                 case 'E': {
2664                         long long t = 0;
2665
2666                         if (check_str_time(optarg, &t, 1)) {
2667                                 log_err("fio: failed parsing eta time %s\n", optarg);
2668                                 exit_val = 1;
2669                                 do_exit++;
2670                                 break;
2671                         }
2672                         eta_new_line = t / 1000;
2673                         if (!eta_new_line) {
2674                                 log_err("fio: eta new line time too short\n");
2675                                 exit_val = 1;
2676                                 do_exit++;
2677                         }
2678                         break;
2679                         }
2680                 case 'O': {
2681                         long long t = 0;
2682
2683                         if (check_str_time(optarg, &t, 1)) {
2684                                 log_err("fio: failed parsing eta interval %s\n", optarg);
2685                                 exit_val = 1;
2686                                 do_exit++;
2687                                 break;
2688                         }
2689                         eta_interval_msec = t / 1000;
2690                         if (eta_interval_msec < DISK_UTIL_MSEC) {
2691                                 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2692                                 exit_val = 1;
2693                                 do_exit++;
2694                         }
2695                         break;
2696                         }
2697                 case 'd':
2698                         if (set_debug(optarg))
2699                                 do_exit++;
2700                         break;
2701                 case 'P':
2702                         did_arg = true;
2703                         parse_only = true;
2704                         break;
2705                 case 'x': {
2706                         size_t new_size;
2707
2708                         if (!strcmp(optarg, "global")) {
2709                                 log_err("fio: can't use global as only "
2710                                         "section\n");
2711                                 do_exit++;
2712                                 exit_val = 1;
2713                                 break;
2714                         }
2715                         new_size = (nr_job_sections + 1) * sizeof(char *);
2716                         job_sections = realloc(job_sections, new_size);
2717                         job_sections[nr_job_sections] = strdup(optarg);
2718                         nr_job_sections++;
2719                         break;
2720                         }
2721 #ifdef CONFIG_ZLIB
2722                 case 'X':
2723                         exit_val = iolog_file_inflate(optarg);
2724                         did_arg = true;
2725                         do_exit++;
2726                         break;
2727 #endif
2728                 case 'p':
2729                         did_arg = true;
2730                         if (exec_profile)
2731                                 free(exec_profile);
2732                         exec_profile = strdup(optarg);
2733                         break;
2734                 case FIO_GETOPT_JOB: {
2735                         const char *opt = l_opts[lidx].name;
2736                         char *val = optarg;
2737
2738                         if (!strncmp(opt, "name", 4) && td) {
2739                                 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2740                                 if (ret)
2741                                         goto out_free;
2742                                 td = NULL;
2743                                 did_arg = true;
2744                         }
2745                         if (!td) {
2746                                 int is_section = !strncmp(opt, "name", 4);
2747                                 int global = 0;
2748
2749                                 if (!is_section || !strncmp(val, "global", 6))
2750                                         global = 1;
2751
2752                                 if (is_section && skip_this_section(val))
2753                                         continue;
2754
2755                                 td = get_new_job(global, &def_thread, true, NULL);
2756                                 if (!td || ioengine_load(td)) {
2757                                         if (td) {
2758                                                 put_job(td);
2759                                                 td = NULL;
2760                                         }
2761                                         do_exit++;
2762                                         exit_val = 1;
2763                                         break;
2764                                 }
2765                                 fio_options_set_ioengine_opts(l_opts, td);
2766                         }
2767
2768                         if ((!val || !strlen(val)) &&
2769                             l_opts[lidx].has_arg == required_argument) {
2770                                 log_err("fio: option %s requires an argument\n", opt);
2771                                 ret = 1;
2772                         } else
2773                                 ret = fio_cmd_option_parse(td, opt, val);
2774
2775                         if (ret) {
2776                                 if (td) {
2777                                         put_job(td);
2778                                         td = NULL;
2779                                 }
2780                                 do_exit++;
2781                                 exit_val = 1;
2782                         }
2783
2784                         if (!ret && !strcmp(opt, "ioengine")) {
2785                                 if (ioengine_load(td)) {
2786                                         put_job(td);
2787                                         td = NULL;
2788                                         do_exit++;
2789                                         exit_val = 1;
2790                                         break;
2791                                 }
2792                                 fio_options_set_ioengine_opts(l_opts, td);
2793                         }
2794                         break;
2795                 }
2796                 case FIO_GETOPT_IOENGINE: {
2797                         const char *opt = l_opts[lidx].name;
2798                         char *val = optarg;
2799
2800                         if (!td)
2801                                 break;
2802
2803                         ret = fio_cmd_ioengine_option_parse(td, opt, val);
2804
2805                         if (ret) {
2806                                 if (td) {
2807                                         put_job(td);
2808                                         td = NULL;
2809                                 }
2810                                 do_exit++;
2811                                 exit_val = 1;
2812                         }
2813                         break;
2814                 }
2815                 case 'w':
2816                         warnings_fatal = 1;
2817                         break;
2818                 case 'j':
2819                         /* we don't track/need this anymore, ignore it */
2820                         break;
2821                 case 'S':
2822                         did_arg = true;
2823 #ifndef CONFIG_NO_SHM
2824                         if (nr_clients) {
2825                                 log_err("fio: can't be both client and server\n");
2826                                 do_exit++;
2827                                 exit_val = 1;
2828                                 break;
2829                         }
2830                         if (optarg)
2831                                 fio_server_set_arg(optarg);
2832                         is_backend = true;
2833                         backend = true;
2834 #else
2835                         log_err("fio: client/server requires SHM support\n");
2836                         do_exit++;
2837                         exit_val = 1;
2838 #endif
2839                         break;
2840 #ifdef WIN32
2841                 case 'N':
2842                         did_arg = true;
2843                         fio_server_internal_set(optarg);
2844                         break;
2845 #endif
2846                 case 'D':
2847                         if (pid_file)
2848                                 free(pid_file);
2849                         pid_file = strdup(optarg);
2850                         break;
2851                 case 'I':
2852                         if ((ret = fio_idle_prof_parse_opt(optarg))) {
2853                                 /* exit on error and calibration only */
2854                                 did_arg = true;
2855                                 do_exit++;
2856                                 if (ret == -1)
2857                                         exit_val = 1;
2858                         }
2859                         break;
2860                 case 'C':
2861                         did_arg = true;
2862                         if (is_backend) {
2863                                 log_err("fio: can't be both client and server\n");
2864                                 do_exit++;
2865                                 exit_val = 1;
2866                                 break;
2867                         }
2868                         /* if --client parameter contains a pathname */
2869                         if (0 == access(optarg, R_OK)) {
2870                                 /* file contains a list of host addrs or names */
2871                                 char hostaddr[PATH_MAX] = {0};
2872                                 char formatstr[8];
2873                                 FILE * hostf = fopen(optarg, "r");
2874                                 if (!hostf) {
2875                                         log_err("fio: could not open client list file %s for read\n", optarg);
2876                                         do_exit++;
2877                                         exit_val = 1;
2878                                         break;
2879                                 }
2880                                 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2881                                 /*
2882                                  * read at most PATH_MAX-1 chars from each
2883                                  * record in this file
2884                                  */
2885                                 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2886                                         /* expect EVERY host in file to be valid */
2887                                         if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2888                                                 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2889                                                 do_exit++;
2890                                                 exit_val = 1;
2891                                                 break;
2892                                         }
2893                                 }
2894                                 fclose(hostf);
2895                                 break; /* no possibility of job file for "this client only" */
2896                         }
2897                         if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2898                                 log_err("fio: failed adding client %s\n", optarg);
2899                                 do_exit++;
2900                                 exit_val = 1;
2901                                 break;
2902                         }
2903                         /*
2904                          * If the next argument exists and isn't an option,
2905                          * assume it's a job file for this client only.
2906                          */
2907                         while (optind < argc) {
2908                                 if (!strncmp(argv[optind], "--", 2) ||
2909                                     !strncmp(argv[optind], "-", 1))
2910                                         break;
2911
2912                                 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2913                                         break;
2914                                 optind++;
2915                         }
2916                         break;
2917                 case 'R':
2918                         did_arg = true;
2919                         if (fio_client_add_ini_file(cur_client, optarg, true)) {
2920                                 do_exit++;
2921                                 exit_val = 1;
2922                         }
2923                         break;
2924                 case 'T':
2925                         did_arg = true;
2926                         do_exit++;
2927                         exit_val = fio_monotonic_clocktest(1);
2928                         break;
2929                 case 'G':
2930                         did_arg = true;
2931                         do_exit++;
2932                         exit_val = fio_crctest(optarg);
2933                         break;
2934                 case 'M':
2935                         did_arg = true;
2936                         do_exit++;
2937                         exit_val = fio_memcpy_test(optarg);
2938                         break;
2939                 case 'L': {
2940                         long long val;
2941
2942                         if (check_str_time(optarg, &val, 1)) {
2943                                 log_err("fio: failed parsing time %s\n", optarg);
2944                                 do_exit++;
2945                                 exit_val = 1;
2946                                 break;
2947                         }
2948                         if (val < 1000) {
2949                                 log_err("fio: status interval too small\n");
2950                                 do_exit++;
2951                                 exit_val = 1;
2952                         }
2953                         status_interval = val / 1000;
2954                         break;
2955                         }
2956                 case 'W':
2957                         if (trigger_file)
2958                                 free(trigger_file);
2959                         trigger_file = strdup(optarg);
2960                         break;
2961                 case 'H':
2962                         if (trigger_cmd)
2963                                 free(trigger_cmd);
2964                         trigger_cmd = strdup(optarg);
2965                         break;
2966                 case 'J':
2967                         if (trigger_remote_cmd)
2968                                 free(trigger_remote_cmd);
2969                         trigger_remote_cmd = strdup(optarg);
2970                         break;
2971                 case 'K':
2972                         if (aux_path)
2973                                 free(aux_path);
2974                         aux_path = strdup(optarg);
2975                         break;
2976                 case 'B':
2977                         if (check_str_time(optarg, &trigger_timeout, 1)) {
2978                                 log_err("fio: failed parsing time %s\n", optarg);
2979                                 do_exit++;
2980                                 exit_val = 1;
2981                         }
2982                         trigger_timeout /= 1000000;
2983                         break;
2984
2985                 case 'A':
2986                         did_arg = true;
2987                         merge_blktrace_only = true;
2988                         break;
2989                 case '?':
2990                         log_err("%s: unrecognized option '%s'\n", argv[0],
2991                                                         argv[optind - 1]);
2992                         show_closest_option(argv[optind - 1]);
2993                         fio_fallthrough;
2994                 default:
2995                         do_exit++;
2996                         exit_val = 1;
2997                         break;
2998                 }
2999                 if (do_exit)
3000                         break;
3001         }
3002
3003         if (do_exit && !(is_backend || nr_clients))
3004                 exit(exit_val);
3005
3006         if (nr_clients && fio_clients_connect())
3007                 exit(1);
3008
3009         if (is_backend && backend)
3010                 return fio_start_server(pid_file);
3011         else if (pid_file)
3012                 free(pid_file);
3013
3014         if (td) {
3015                 if (!ret) {
3016                         ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
3017                         if (ret)
3018                                 exit(1);
3019                 }
3020         }
3021
3022         while (!ret && optind < argc) {
3023                 ini_idx++;
3024                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
3025                 ini_file[ini_idx - 1] = strdup(argv[optind]);
3026                 optind++;
3027         }
3028
3029 out_free:
3030         return ini_idx;
3031 }
3032
3033 int fio_init_options(void)
3034 {
3035         f_out = stdout;
3036         f_err = stderr;
3037
3038         fio_options_fill_optstring();
3039         fio_options_dup_and_init(l_opts);
3040
3041         atexit(free_shm);
3042
3043         if (fill_def_thread())
3044                 return 1;
3045
3046         return 0;
3047 }
3048
3049 extern int fio_check_options(struct thread_options *);
3050
3051 int parse_options(int argc, char *argv[])
3052 {
3053         const int type = FIO_CLIENT_TYPE_CLI;
3054         int job_files, i;
3055
3056         if (fio_init_options())
3057                 return 1;
3058         if (fio_test_cconv(&def_thread.o))
3059                 log_err("fio: failed internal cconv test\n");
3060
3061         job_files = parse_cmd_line(argc, argv, type);
3062
3063         if (job_files > 0) {
3064                 for (i = 0; i < job_files; i++) {
3065                         if (i && fill_def_thread())
3066                                 return 1;
3067                         if (nr_clients) {
3068                                 if (fio_clients_send_ini(ini_file[i]))
3069                                         return 1;
3070                                 free(ini_file[i]);
3071                         } else if (!is_backend) {
3072                                 if (parse_jobs_ini(ini_file[i], 0, i, type))
3073                                         return 1;
3074                                 free(ini_file[i]);
3075                         }
3076                 }
3077         } else if (nr_clients) {
3078                 if (fill_def_thread())
3079                         return 1;
3080                 if (fio_clients_send_ini(NULL))
3081                         return 1;
3082         }
3083
3084         free(ini_file);
3085         fio_options_free(&def_thread);
3086         filesetup_mem_free();
3087
3088         if (!thread_number) {
3089                 if (parse_dryrun())
3090                         return 0;
3091                 if (exec_profile)
3092                         return 0;
3093                 if (is_backend || nr_clients)
3094                         return 0;
3095                 if (did_arg)
3096                         return 0;
3097
3098                 log_err("No job(s) defined\n\n");
3099                 usage(argv[0]);
3100                 return 1;
3101         }
3102
3103         if (output_format & FIO_OUTPUT_NORMAL)
3104                 log_info("%s\n", fio_version_string);
3105
3106         return 0;
3107 }
3108
3109 void options_default_fill(struct thread_options *o)
3110 {
3111         memcpy(o, &def_thread.o, sizeof(*o));
3112 }
3113
3114 struct thread_data *get_global_options(void)
3115 {
3116         return &def_thread;
3117 }