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