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