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