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