Merge branch 'master' into gfio
[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/shm.h>
13 #include <sys/types.h>
14 #include <sys/stat.h>
15
16 #include "fio.h"
17 #include "parse.h"
18 #include "smalloc.h"
19 #include "filehash.h"
20 #include "verify.h"
21 #include "profile.h"
22 #include "server.h"
23
24 #include "lib/getopt.h"
25
26 const char fio_version_string[] = FIO_VERSION;
27
28 #define FIO_RANDSEED            (0xb1899bedUL)
29
30 static char **ini_file;
31 static int max_jobs = FIO_MAX_JOBS;
32 static int dump_cmdline;
33 static int def_timeout;
34
35 static struct thread_data def_thread;
36 struct thread_data *threads = NULL;
37
38 int exitall_on_terminate = 0;
39 int output_format = FIO_OUTPUT_NORMAL;
40 int eta_print;
41 FILE *f_out = NULL;
42 FILE *f_err = NULL;
43 char **job_sections = NULL;
44 int nr_job_sections = 0;
45 char *exec_profile = NULL;
46 int warnings_fatal = 0;
47 int terse_version = 3;
48 int is_backend = 0;
49 int nr_clients = 0;
50 int log_syslog = 0;
51
52 int write_bw_log = 0;
53 int read_only = 0;
54
55 static int write_lat_log;
56
57 static int prev_group_jobs;
58
59 unsigned long fio_debug = 0;
60 unsigned int fio_debug_jobno = -1;
61 unsigned int *fio_debug_jobp = NULL;
62
63 static char cmd_optstr[256];
64 static int did_arg;
65
66 const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN] = {
67         { .u.f  =  1.00 },
68         { .u.f  =  5.00 },
69         { .u.f  = 10.00 },
70         { .u.f  = 20.00 },
71         { .u.f  = 30.00 },
72         { .u.f  = 40.00 },
73         { .u.f  = 50.00 },
74         { .u.f  = 60.00 },
75         { .u.f  = 70.00 },
76         { .u.f  = 80.00 },
77         { .u.f  = 90.00 },
78         { .u.f  = 95.00 },
79         { .u.f  = 99.00 },
80         { .u.f  = 99.50 },
81         { .u.f  = 99.90 },
82         { .u.f  = 99.95 },
83         { .u.f  = 99.99 },
84 };
85
86 #define FIO_CLIENT_FLAG         (1 << 16)
87
88 /*
89  * Command line options. These will contain the above, plus a few
90  * extra that only pertain to fio itself and not jobs.
91  */
92 static struct option l_opts[FIO_NR_OPTIONS] = {
93         {
94                 .name           = (char *) "output",
95                 .has_arg        = required_argument,
96                 .val            = 'o' | FIO_CLIENT_FLAG,
97         },
98         {
99                 .name           = (char *) "timeout",
100                 .has_arg        = required_argument,
101                 .val            = 't' | FIO_CLIENT_FLAG,
102         },
103         {
104                 .name           = (char *) "latency-log",
105                 .has_arg        = required_argument,
106                 .val            = 'l' | FIO_CLIENT_FLAG,
107         },
108         {
109                 .name           = (char *) "bandwidth-log",
110                 .has_arg        = required_argument,
111                 .val            = 'b' | FIO_CLIENT_FLAG,
112         },
113         {
114                 .name           = (char *) "minimal",
115                 .has_arg        = optional_argument,
116                 .val            = 'm' | FIO_CLIENT_FLAG,
117         },
118         {
119                 .name           = (char *) "output-format",
120                 .has_arg        = optional_argument,
121                 .val            = 'F' | FIO_CLIENT_FLAG,
122         },
123         {
124                 .name           = (char *) "version",
125                 .has_arg        = no_argument,
126                 .val            = 'v' | FIO_CLIENT_FLAG,
127         },
128         {
129                 .name           = (char *) "help",
130                 .has_arg        = no_argument,
131                 .val            = 'h' | FIO_CLIENT_FLAG,
132         },
133         {
134                 .name           = (char *) "cmdhelp",
135                 .has_arg        = optional_argument,
136                 .val            = 'c' | FIO_CLIENT_FLAG,
137         },
138         {
139                 .name              = (char *) "enghelp",
140                 .has_arg        = optional_argument,
141                 .val                = 'i' | FIO_CLIENT_FLAG,
142         },
143         {
144                 .name           = (char *) "showcmd",
145                 .has_arg        = no_argument,
146                 .val            = 's' | FIO_CLIENT_FLAG,
147         },
148         {
149                 .name           = (char *) "readonly",
150                 .has_arg        = no_argument,
151                 .val            = 'r' | FIO_CLIENT_FLAG,
152         },
153         {
154                 .name           = (char *) "eta",
155                 .has_arg        = required_argument,
156                 .val            = 'e' | FIO_CLIENT_FLAG,
157         },
158         {
159                 .name           = (char *) "debug",
160                 .has_arg        = required_argument,
161                 .val            = 'd' | FIO_CLIENT_FLAG,
162         },
163         {
164                 .name           = (char *) "section",
165                 .has_arg        = required_argument,
166                 .val            = 'x' | FIO_CLIENT_FLAG,
167         },
168         {
169                 .name           = (char *) "alloc-size",
170                 .has_arg        = required_argument,
171                 .val            = 'a' | FIO_CLIENT_FLAG,
172         },
173         {
174                 .name           = (char *) "profile",
175                 .has_arg        = required_argument,
176                 .val            = 'p' | FIO_CLIENT_FLAG,
177         },
178         {
179                 .name           = (char *) "warnings-fatal",
180                 .has_arg        = no_argument,
181                 .val            = 'w' | FIO_CLIENT_FLAG,
182         },
183         {
184                 .name           = (char *) "max-jobs",
185                 .has_arg        = required_argument,
186                 .val            = 'j' | FIO_CLIENT_FLAG,
187         },
188         {
189                 .name           = (char *) "terse-version",
190                 .has_arg        = required_argument,
191                 .val            = 'V' | FIO_CLIENT_FLAG,
192         },
193         {
194                 .name           = (char *) "server",
195                 .has_arg        = optional_argument,
196                 .val            = 'S',
197         },
198         {       .name           = (char *) "daemonize",
199                 .has_arg        = required_argument,
200                 .val            = 'D',
201         },
202         {
203                 .name           = (char *) "client",
204                 .has_arg        = required_argument,
205                 .val            = 'C',
206         },
207         {
208                 .name           = NULL,
209         },
210 };
211
212 void free_threads_shm(void)
213 {
214         struct shmid_ds sbuf;
215
216         if (threads) {
217                 void *tp = threads;
218
219                 threads = NULL;
220                 shmdt(tp);
221                 shmctl(shm_id, IPC_RMID, &sbuf);
222                 shm_id = -1;
223         }
224 }
225
226 void free_shm(void)
227 {
228         if (threads) {
229                 file_hash_exit();
230                 flow_exit();
231                 fio_debug_jobp = NULL;
232                 free_threads_shm();
233         }
234
235         scleanup();
236 }
237
238 /*
239  * The thread area is shared between the main process and the job
240  * threads/processes. So setup a shared memory segment that will hold
241  * all the job info. We use the end of the region for keeping track of
242  * open files across jobs, for file sharing.
243  */
244 static int setup_thread_area(void)
245 {
246         void *hash;
247
248         if (threads)
249                 return 0;
250
251         /*
252          * 1024 is too much on some machines, scale max_jobs if
253          * we get a failure that looks like too large a shm segment
254          */
255         do {
256                 size_t size = max_jobs * sizeof(struct thread_data);
257
258                 size += file_hash_size;
259                 size += sizeof(unsigned int);
260
261                 shm_id = shmget(0, size, IPC_CREAT | 0600);
262                 if (shm_id != -1)
263                         break;
264                 if (errno != EINVAL && errno != ENOMEM) {
265                         perror("shmget");
266                         break;
267                 }
268
269                 max_jobs >>= 1;
270         } while (max_jobs);
271
272         if (shm_id == -1)
273                 return 1;
274
275         threads = shmat(shm_id, NULL, 0);
276         if (threads == (void *) -1) {
277                 perror("shmat");
278                 return 1;
279         }
280
281         memset(threads, 0, max_jobs * sizeof(struct thread_data));
282         hash = (void *) threads + max_jobs * sizeof(struct thread_data);
283         fio_debug_jobp = (void *) hash + file_hash_size;
284         *fio_debug_jobp = -1;
285         file_hash_init(hash);
286
287         flow_init();
288
289         return 0;
290 }
291
292 /*
293  * Return a free job structure.
294  */
295 static struct thread_data *get_new_job(int global, struct thread_data *parent,
296                                        int preserve_eo)
297 {
298         struct thread_data *td;
299
300         if (global)
301                 return &def_thread;
302         if (setup_thread_area()) {
303                 log_err("error: failed to setup shm segment\n");
304                 return NULL;
305         }
306         if (thread_number >= max_jobs) {
307                 log_err("error: maximum number of jobs (%d) reached.\n",
308                                 max_jobs);
309                 return NULL;
310         }
311
312         td = &threads[thread_number++];
313         *td = *parent;
314
315         td->io_ops = NULL;
316         if (!preserve_eo)
317                 td->eo = NULL;
318
319         td->o.uid = td->o.gid = -1U;
320
321         dup_files(td, parent);
322         fio_options_mem_dupe(td);
323
324         profile_add_hooks(td);
325
326         td->thread_number = thread_number;
327         return td;
328 }
329
330 static void put_job(struct thread_data *td)
331 {
332         if (td == &def_thread)
333                 return;
334
335         profile_td_exit(td);
336         flow_exit_job(td);
337
338         if (td->error)
339                 log_info("fio: %s\n", td->verror);
340
341         fio_options_free(td);
342         if (td->io_ops)
343                 free_ioengine(td);
344
345         memset(&threads[td->thread_number - 1], 0, sizeof(*td));
346         thread_number--;
347 }
348
349 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
350 {
351         unsigned int bs = td->o.min_bs[ddir];
352
353         assert(ddir_rw(ddir));
354
355         if (td->o.rate[ddir])
356                 td->rate_bps[ddir] = td->o.rate[ddir];
357         else
358                 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
359
360         if (!td->rate_bps[ddir]) {
361                 log_err("rate lower than supported\n");
362                 return -1;
363         }
364
365         td->rate_pending_usleep[ddir] = 0;
366         return 0;
367 }
368
369 static int setup_rate(struct thread_data *td)
370 {
371         int ret = 0;
372
373         if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
374                 ret = __setup_rate(td, DDIR_READ);
375         if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
376                 ret |= __setup_rate(td, DDIR_WRITE);
377         if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
378                 ret |= __setup_rate(td, DDIR_TRIM);
379
380         return ret;
381 }
382
383 static int fixed_block_size(struct thread_options *o)
384 {
385         return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
386                 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
387                 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
388                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
389                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
390 }
391
392 /*
393  * Lazy way of fixing up options that depend on each other. We could also
394  * define option callback handlers, but this is easier.
395  */
396 static int fixup_options(struct thread_data *td)
397 {
398         struct thread_options *o = &td->o;
399         int ret = 0;
400
401 #ifndef FIO_HAVE_PSHARED_MUTEX
402         if (!o->use_thread) {
403                 log_info("fio: this platform does not support process shared"
404                          " mutexes, forcing use of threads. Use the 'thread'"
405                          " option to get rid of this warning.\n");
406                 o->use_thread = 1;
407                 ret = warnings_fatal;
408         }
409 #endif
410
411         if (o->write_iolog_file && o->read_iolog_file) {
412                 log_err("fio: read iolog overrides write_iolog\n");
413                 free(o->write_iolog_file);
414                 o->write_iolog_file = NULL;
415                 ret = warnings_fatal;
416         }
417
418         /*
419          * only really works with 1 file
420          */
421         if (o->zone_size && o->open_files == 1)
422                 o->zone_size = 0;
423
424         /*
425          * If zone_range isn't specified, backward compatibility dictates it
426          * should be made equal to zone_size.
427          */
428         if (o->zone_size && !o->zone_range)
429                 o->zone_range = o->zone_size;
430
431         /*
432          * Reads can do overwrites, we always need to pre-create the file
433          */
434         if (td_read(td) || td_rw(td))
435                 o->overwrite = 1;
436
437         if (!o->min_bs[DDIR_READ])
438                 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
439         if (!o->max_bs[DDIR_READ])
440                 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
441         if (!o->min_bs[DDIR_WRITE])
442                 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
443         if (!o->max_bs[DDIR_WRITE])
444                 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
445         if (!o->min_bs[DDIR_TRIM])
446                 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
447         if (!o->max_bs[DDIR_TRIM])
448                 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
449
450
451         o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
452         o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
453
454         /*
455          * For random IO, allow blockalign offset other than min_bs.
456          */
457         if (!o->ba[DDIR_READ] || !td_random(td))
458                 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
459         if (!o->ba[DDIR_WRITE] || !td_random(td))
460                 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
461         if (!o->ba[DDIR_TRIM] || !td_random(td))
462                 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
463
464         if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
465             o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
466             o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
467             !o->norandommap) {
468                 log_err("fio: Any use of blockalign= turns off randommap\n");
469                 o->norandommap = 1;
470                 ret = warnings_fatal;
471         }
472
473         if (!o->file_size_high)
474                 o->file_size_high = o->file_size_low;
475
476         if (o->norandommap && o->verify != VERIFY_NONE
477             && !fixed_block_size(o))  {
478                 log_err("fio: norandommap given for variable block sizes, "
479                         "verify disabled\n");
480                 o->verify = VERIFY_NONE;
481                 ret = warnings_fatal;
482         }
483         if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
484                 log_err("fio: bs_unaligned may not work with raw io\n");
485
486         /*
487          * thinktime_spin must be less than thinktime
488          */
489         if (o->thinktime_spin > o->thinktime)
490                 o->thinktime_spin = o->thinktime;
491
492         /*
493          * The low water mark cannot be bigger than the iodepth
494          */
495         if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
496                 /*
497                  * syslet work around - if the workload is sequential,
498                  * we want to let the queue drain all the way down to
499                  * avoid seeking between async threads
500                  */
501                 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
502                         o->iodepth_low = 1;
503                 else
504                         o->iodepth_low = o->iodepth;
505         }
506
507         /*
508          * If batch number isn't set, default to the same as iodepth
509          */
510         if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
511                 o->iodepth_batch = o->iodepth;
512
513         if (o->nr_files > td->files_index)
514                 o->nr_files = td->files_index;
515
516         if (o->open_files > o->nr_files || !o->open_files)
517                 o->open_files = o->nr_files;
518
519         if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
520             (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
521             ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
522             (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
523                 log_err("fio: rate and rate_iops are mutually exclusive\n");
524                 ret = 1;
525         }
526         if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
527             (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
528             (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
529             (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
530             (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
531             (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
532                 log_err("fio: minimum rate exceeds rate\n");
533                 ret = 1;
534         }
535
536         if (!o->timeout && o->time_based) {
537                 log_err("fio: time_based requires a runtime/timeout setting\n");
538                 o->time_based = 0;
539                 ret = warnings_fatal;
540         }
541
542         if (o->fill_device && !o->size)
543                 o->size = -1ULL;
544
545         if (o->verify != VERIFY_NONE) {
546                 if (td_write(td) && o->do_verify && o->numjobs > 1) {
547                         log_info("Multiple writers may overwrite blocks that "
548                                 "belong to other jobs. This can cause "
549                                 "verification failures.\n");
550                         ret = warnings_fatal;
551                 }
552
553                 o->refill_buffers = 1;
554                 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
555                     !o->verify_interval)
556                         o->verify_interval = o->min_bs[DDIR_WRITE];
557         }
558
559         if (o->pre_read) {
560                 o->invalidate_cache = 0;
561                 if (td->io_ops->flags & FIO_PIPEIO) {
562                         log_info("fio: cannot pre-read files with an IO engine"
563                                  " that isn't seekable. Pre-read disabled.\n");
564                         ret = warnings_fatal;
565                 }
566         }
567
568 #ifndef FIO_HAVE_FDATASYNC
569         if (o->fdatasync_blocks) {
570                 log_info("fio: this platform does not support fdatasync()"
571                          " falling back to using fsync().  Use the 'fsync'"
572                          " option instead of 'fdatasync' to get rid of"
573                          " this warning\n");
574                 o->fsync_blocks = o->fdatasync_blocks;
575                 o->fdatasync_blocks = 0;
576                 ret = warnings_fatal;
577         }
578 #endif
579
580 #ifdef WIN32
581         /*
582          * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
583          * so fail if we're passed those flags
584          */
585         if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
586                 log_err("fio: Windows does not support direct or non-buffered io with"
587                                 " the synchronous ioengines. Use the 'windowsaio' ioengine"
588                                 " with 'direct=1' and 'iodepth=1' instead.\n");
589                 ret = 1;
590         }
591 #endif
592
593         /*
594          * For fully compressible data, just zero them at init time.
595          * It's faster than repeatedly filling it.
596          */
597         if (td->o.compress_percentage == 100) {
598                 td->o.zero_buffers = 1;
599                 td->o.compress_percentage = 0;
600         }
601
602         return ret;
603 }
604
605 /*
606  * This function leaks the buffer
607  */
608 char *fio_uint_to_kmg(unsigned int val)
609 {
610         char *buf = malloc(32);
611         char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
612         char *p = post;
613
614         do {
615                 if (val & 1023)
616                         break;
617
618                 val >>= 10;
619                 p++;
620         } while (*p);
621
622         snprintf(buf, 31, "%u%c", val, *p);
623         return buf;
624 }
625
626 /* External engines are specified by "external:name.o") */
627 static const char *get_engine_name(const char *str)
628 {
629         char *p = strstr(str, ":");
630
631         if (!p)
632                 return str;
633
634         p++;
635         strip_blank_front(&p);
636         strip_blank_end(p);
637         return p;
638 }
639
640 static int exists_and_not_file(const char *filename)
641 {
642         struct stat sb;
643
644         if (lstat(filename, &sb) == -1)
645                 return 0;
646
647         /* \\.\ is the device namespace in Windows, where every file
648          * is a device node */
649         if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
650                 return 0;
651
652         return 1;
653 }
654
655 static void td_fill_rand_seeds_os(struct thread_data *td)
656 {
657         os_random_seed(td->rand_seeds[0], &td->bsrange_state);
658         os_random_seed(td->rand_seeds[1], &td->verify_state);
659         os_random_seed(td->rand_seeds[2], &td->rwmix_state);
660
661         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
662                 os_random_seed(td->rand_seeds[3], &td->next_file_state);
663
664         os_random_seed(td->rand_seeds[5], &td->file_size_state);
665         os_random_seed(td->rand_seeds[6], &td->trim_state);
666
667         if (!td_random(td))
668                 return;
669
670         if (td->o.rand_repeatable)
671                 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
672
673         os_random_seed(td->rand_seeds[4], &td->random_state);
674 }
675
676 static void td_fill_rand_seeds_internal(struct thread_data *td)
677 {
678         init_rand_seed(&td->__bsrange_state, td->rand_seeds[0]);
679         init_rand_seed(&td->__verify_state, td->rand_seeds[1]);
680         init_rand_seed(&td->__rwmix_state, td->rand_seeds[2]);
681
682         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
683                 init_rand_seed(&td->__next_file_state, td->rand_seeds[3]);
684
685         init_rand_seed(&td->__file_size_state, td->rand_seeds[5]);
686         init_rand_seed(&td->__trim_state, td->rand_seeds[6]);
687
688         if (!td_random(td))
689                 return;
690
691         if (td->o.rand_repeatable)
692                 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
693
694         init_rand_seed(&td->__random_state, td->rand_seeds[4]);
695 }
696
697 void td_fill_rand_seeds(struct thread_data *td)
698 {
699         if (td->o.use_os_rand)
700                 td_fill_rand_seeds_os(td);
701         else
702                 td_fill_rand_seeds_internal(td);
703
704         init_rand_seed(&td->buf_state, td->rand_seeds[7]);
705 }
706
707
708 /*
709  * Initializes the ioengine configured for a job, if it has not been done so
710  * already.
711  */
712 int ioengine_load(struct thread_data *td)
713 {
714         const char *engine;
715
716         /*
717          * Engine has already been loaded.
718          */
719         if (td->io_ops)
720                 return 0;
721
722         engine = get_engine_name(td->o.ioengine);
723         td->io_ops = load_ioengine(td, engine);
724         if (!td->io_ops) {
725                 log_err("fio: failed to load engine %s\n", engine);
726                 return 1;
727         }
728
729         if (td->io_ops->option_struct_size && td->io_ops->options) {
730                 /*
731                  * In cases where td->eo is set, clone it for a child thread.
732                  * This requires that the parent thread has the same ioengine,
733                  * but that requirement must be enforced by the code which
734                  * cloned the thread.
735                  */
736                 void *origeo = td->eo;
737                 /*
738                  * Otherwise use the default thread options.
739                  */
740                 if (!origeo && td != &def_thread && def_thread.eo &&
741                     def_thread.io_ops->options == td->io_ops->options)
742                         origeo = def_thread.eo;
743
744                 options_init(td->io_ops->options);
745                 td->eo = malloc(td->io_ops->option_struct_size);
746                 /*
747                  * Use the default thread as an option template if this uses the
748                  * same options structure and there are non-default options
749                  * used.
750                  */
751                 if (origeo) {
752                         memcpy(td->eo, origeo, td->io_ops->option_struct_size);
753                         options_mem_dupe(td->eo, td->io_ops->options);
754                 } else {
755                         memset(td->eo, 0, td->io_ops->option_struct_size);
756                         fill_default_options(td->eo, td->io_ops->options);
757                 }
758                 *(struct thread_data **)td->eo = td;
759         }
760
761         return 0;
762 }
763
764 /*
765  * Adds a job to the list of things todo. Sanitizes the various options
766  * to make sure we don't have conflicts, and initializes various
767  * members of td.
768  */
769 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
770                    int recursed, int client_type)
771 {
772         unsigned int i;
773         char fname[PATH_MAX];
774         int numjobs, file_alloced;
775
776         /*
777          * the def_thread is just for options, it's not a real job
778          */
779         if (td == &def_thread)
780                 return 0;
781
782         /*
783          * if we are just dumping the output command line, don't add the job
784          */
785         if (dump_cmdline) {
786                 put_job(td);
787                 return 0;
788         }
789
790         td->client_type = client_type;
791
792         if (profile_td_init(td))
793                 goto err;
794
795         if (ioengine_load(td))
796                 goto err;
797
798         if (td->o.odirect)
799                 td->io_ops->flags |= FIO_RAWIO;
800
801         file_alloced = 0;
802         if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
803                 file_alloced = 1;
804
805                 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
806                         add_file(td, jobname);
807                 else {
808                         for (i = 0; i < td->o.nr_files; i++) {
809                                 sprintf(fname, "%s.%d.%d", jobname,
810                                                         td->thread_number, i);
811                                 add_file(td, fname);
812                         }
813                 }
814         }
815
816         if (fixup_options(td))
817                 goto err;
818
819         flow_init_job(td);
820
821         /*
822          * IO engines only need this for option callbacks, and the address may
823          * change in subprocesses.
824          */
825         if (td->eo)
826                 *(struct thread_data **)td->eo = NULL;
827
828         if (td->io_ops->flags & FIO_DISKLESSIO) {
829                 struct fio_file *f;
830
831                 for_each_file(td, f, i)
832                         f->real_file_size = -1ULL;
833         }
834
835         td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
836
837         td->ts.clat_percentiles = td->o.clat_percentiles;
838         if (td->o.overwrite_plist)
839                 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
840         else
841                 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
842
843         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
844                 td->ts.clat_stat[i].min_val = ULONG_MAX;
845                 td->ts.slat_stat[i].min_val = ULONG_MAX;
846                 td->ts.lat_stat[i].min_val = ULONG_MAX;
847                 td->ts.bw_stat[i].min_val = ULONG_MAX;
848         }
849         td->ddir_seq_nr = td->o.ddir_seq_nr;
850
851         if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
852                 prev_group_jobs = 0;
853                 groupid++;
854         }
855
856         td->groupid = groupid;
857         prev_group_jobs++;
858
859         if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
860                 td_verror(td, errno, "init_random_state");
861                 goto err;
862         }
863
864         if (setup_rate(td))
865                 goto err;
866
867         if (td->o.lat_log_file) {
868                 setup_log(&td->lat_log, td->o.log_avg_msec, IO_LOG_TYPE_LAT);
869                 setup_log(&td->slat_log, td->o.log_avg_msec, IO_LOG_TYPE_SLAT);
870                 setup_log(&td->clat_log, td->o.log_avg_msec, IO_LOG_TYPE_CLAT);
871         }
872         if (td->o.bw_log_file)
873                 setup_log(&td->bw_log, td->o.log_avg_msec, IO_LOG_TYPE_BW);
874         if (td->o.iops_log_file)
875                 setup_log(&td->iops_log, td->o.log_avg_msec, IO_LOG_TYPE_IOPS);
876
877         if (!td->o.name)
878                 td->o.name = strdup(jobname);
879
880         if (output_format == FIO_OUTPUT_NORMAL) {
881                 if (!job_add_num) {
882                         if (is_backend && !recursed)
883                                 fio_server_send_add_job(td);
884
885                         if (!(td->io_ops->flags & FIO_NOIO)) {
886                                 char *c1, *c2, *c3, *c4, *c5, *c6;
887
888                                 c1 = fio_uint_to_kmg(td->o.min_bs[DDIR_READ]);
889                                 c2 = fio_uint_to_kmg(td->o.max_bs[DDIR_READ]);
890                                 c3 = fio_uint_to_kmg(td->o.min_bs[DDIR_WRITE]);
891                                 c4 = fio_uint_to_kmg(td->o.max_bs[DDIR_WRITE]);
892                                 c5 = fio_uint_to_kmg(td->o.min_bs[DDIR_TRIM]);
893                                 c6 = fio_uint_to_kmg(td->o.max_bs[DDIR_TRIM]);
894
895                                 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
896                                          " ioengine=%s, iodepth=%u\n",
897                                                 td->o.name, td->groupid,
898                                                 ddir_str(td->o.td_ddir),
899                                                 c1, c2, c3, c4, c5, c6,
900                                                 td->io_ops->name,
901                                                 td->o.iodepth);
902
903                                 free(c1);
904                                 free(c2);
905                                 free(c3);
906                                 free(c4);
907                                 free(c5);
908                                 free(c6);
909                         }
910                 } else if (job_add_num == 1)
911                         log_info("...\n");
912         }
913
914         /*
915          * recurse add identical jobs, clear numjobs and stonewall options
916          * as they don't apply to sub-jobs
917          */
918         numjobs = td->o.numjobs;
919         while (--numjobs) {
920                 struct thread_data *td_new = get_new_job(0, td, 1);
921
922                 if (!td_new)
923                         goto err;
924
925                 td_new->o.numjobs = 1;
926                 td_new->o.stonewall = 0;
927                 td_new->o.new_group = 0;
928
929                 if (file_alloced) {
930                         td_new->o.filename = NULL;
931                         td_new->files_index = 0;
932                         td_new->files_size = 0;
933                         td_new->files = NULL;
934                 }
935
936                 job_add_num = numjobs - 1;
937
938                 if (add_job(td_new, jobname, job_add_num, 1, client_type))
939                         goto err;
940         }
941
942         return 0;
943 err:
944         put_job(td);
945         return -1;
946 }
947
948 /*
949  * Parse as if 'o' was a command line
950  */
951 void add_job_opts(const char **o, int client_type)
952 {
953         struct thread_data *td, *td_parent;
954         int i, in_global = 1;
955         char jobname[32];
956
957         i = 0;
958         td_parent = td = NULL;
959         while (o[i]) {
960                 if (!strncmp(o[i], "name", 4)) {
961                         in_global = 0;
962                         if (td)
963                                 add_job(td, jobname, 0, 0, client_type);
964                         td = NULL;
965                         sprintf(jobname, "%s", o[i] + 5);
966                 }
967                 if (in_global && !td_parent)
968                         td_parent = get_new_job(1, &def_thread, 0);
969                 else if (!in_global && !td) {
970                         if (!td_parent)
971                                 td_parent = &def_thread;
972                         td = get_new_job(0, td_parent, 0);
973                 }
974                 if (in_global)
975                         fio_options_parse(td_parent, (char **) &o[i], 1);
976                 else
977                         fio_options_parse(td, (char **) &o[i], 1);
978                 i++;
979         }
980
981         if (td)
982                 add_job(td, jobname, 0, 0, client_type);
983 }
984
985 static int skip_this_section(const char *name)
986 {
987         int i;
988
989         if (!nr_job_sections)
990                 return 0;
991         if (!strncmp(name, "global", 6))
992                 return 0;
993
994         for (i = 0; i < nr_job_sections; i++)
995                 if (!strcmp(job_sections[i], name))
996                         return 0;
997
998         return 1;
999 }
1000
1001 static int is_empty_or_comment(char *line)
1002 {
1003         unsigned int i;
1004
1005         for (i = 0; i < strlen(line); i++) {
1006                 if (line[i] == ';')
1007                         return 1;
1008                 if (line[i] == '#')
1009                         return 1;
1010                 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1011                         return 0;
1012         }
1013
1014         return 1;
1015 }
1016
1017 /*
1018  * This is our [ini] type file parser.
1019  */
1020 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1021 {
1022         unsigned int global;
1023         struct thread_data *td;
1024         char *string, *name;
1025         FILE *f;
1026         char *p;
1027         int ret = 0, stonewall;
1028         int first_sect = 1;
1029         int skip_fgets = 0;
1030         int inside_skip = 0;
1031         char **opts;
1032         int i, alloc_opts, num_opts;
1033
1034         if (is_buf)
1035                 f = NULL;
1036         else {
1037                 if (!strcmp(file, "-"))
1038                         f = stdin;
1039                 else
1040                         f = fopen(file, "r");
1041
1042                 if (!f) {
1043                         perror("fopen job file");
1044                         return 1;
1045                 }
1046         }
1047
1048         string = malloc(4096);
1049
1050         /*
1051          * it's really 256 + small bit, 280 should suffice
1052          */
1053         name = malloc(280);
1054         memset(name, 0, 280);
1055
1056         alloc_opts = 8;
1057         opts = malloc(sizeof(char *) * alloc_opts);
1058         num_opts = 0;
1059
1060         stonewall = stonewall_flag;
1061         do {
1062                 /*
1063                  * if skip_fgets is set, we already have loaded a line we
1064                  * haven't handled.
1065                  */
1066                 if (!skip_fgets) {
1067                         if (is_buf)
1068                                 p = strsep(&file, "\n");
1069                         else
1070                                 p = fgets(string, 4096, f);
1071                         if (!p)
1072                                 break;
1073                 }
1074
1075                 skip_fgets = 0;
1076                 strip_blank_front(&p);
1077                 strip_blank_end(p);
1078
1079                 if (is_empty_or_comment(p))
1080                         continue;
1081                 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1082                         if (inside_skip)
1083                                 continue;
1084                         log_err("fio: option <%s> outside of [] job section\n",
1085                                                                         p);
1086                         break;
1087                 }
1088
1089                 name[strlen(name) - 1] = '\0';
1090
1091                 if (skip_this_section(name)) {
1092                         inside_skip = 1;
1093                         continue;
1094                 } else
1095                         inside_skip = 0;
1096
1097                 global = !strncmp(name, "global", 6);
1098
1099                 if (dump_cmdline) {
1100                         if (first_sect)
1101                                 log_info("fio ");
1102                         if (!global)
1103                                 log_info("--name=%s ", name);
1104                         first_sect = 0;
1105                 }
1106
1107                 td = get_new_job(global, &def_thread, 0);
1108                 if (!td) {
1109                         ret = 1;
1110                         break;
1111                 }
1112
1113                 /*
1114                  * Seperate multiple job files by a stonewall
1115                  */
1116                 if (!global && stonewall) {
1117                         td->o.stonewall = stonewall;
1118                         stonewall = 0;
1119                 }
1120
1121                 num_opts = 0;
1122                 memset(opts, 0, alloc_opts * sizeof(char *));
1123
1124                 while (1) {
1125                         if (is_buf)
1126                                 p = strsep(&file, "\n");
1127                         else
1128                                 p = fgets(string, 4096, f);
1129                         if (!p)
1130                                 break;
1131
1132                         if (is_empty_or_comment(p))
1133                                 continue;
1134
1135                         strip_blank_front(&p);
1136
1137                         /*
1138                          * new section, break out and make sure we don't
1139                          * fgets() a new line at the top.
1140                          */
1141                         if (p[0] == '[') {
1142                                 skip_fgets = 1;
1143                                 break;
1144                         }
1145
1146                         strip_blank_end(p);
1147
1148                         if (num_opts == alloc_opts) {
1149                                 alloc_opts <<= 1;
1150                                 opts = realloc(opts,
1151                                                 alloc_opts * sizeof(char *));
1152                         }
1153
1154                         opts[num_opts] = strdup(p);
1155                         num_opts++;
1156                 }
1157
1158                 ret = fio_options_parse(td, opts, num_opts);
1159                 if (!ret) {
1160                         if (dump_cmdline)
1161                                 for (i = 0; i < num_opts; i++)
1162                                         log_info("--%s ", opts[i]);
1163
1164                         ret = add_job(td, name, 0, 0, type);
1165                 } else {
1166                         log_err("fio: job %s dropped\n", name);
1167                         put_job(td);
1168                 }
1169
1170                 for (i = 0; i < num_opts; i++)
1171                         free(opts[i]);
1172                 num_opts = 0;
1173         } while (!ret);
1174
1175         if (dump_cmdline)
1176                 log_info("\n");
1177
1178         i = 0;
1179         while (i < nr_job_sections) {
1180                 free(job_sections[i]);
1181                 i++;
1182         }
1183
1184         for (i = 0; i < num_opts; i++)
1185                 free(opts[i]);
1186
1187         free(string);
1188         free(name);
1189         free(opts);
1190         if (!is_buf && f != stdin)
1191                 fclose(f);
1192         return ret;
1193 }
1194
1195 static int fill_def_thread(void)
1196 {
1197         memset(&def_thread, 0, sizeof(def_thread));
1198
1199         fio_getaffinity(getpid(), &def_thread.o.cpumask);
1200         def_thread.o.timeout = def_timeout;
1201
1202         /*
1203          * fill default options
1204          */
1205         fio_fill_default_options(&def_thread);
1206         return 0;
1207 }
1208
1209 static void usage(const char *name)
1210 {
1211         printf("%s\n", fio_version_string);
1212         printf("%s [options] [job options] <job file(s)>\n", name);
1213         printf("  --debug=options\tEnable debug logging. May be one/more of:\n"
1214                 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1215                 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1216         printf("  --output\t\tWrite output to file\n");
1217         printf("  --runtime\t\tRuntime in seconds\n");
1218         printf("  --latency-log\t\tGenerate per-job latency logs\n");
1219         printf("  --bandwidth-log\tGenerate per-job bandwidth logs\n");
1220         printf("  --minimal\t\tMinimal (terse) output\n");
1221         printf("  --output-format=x\tOutput format (terse,json,normal)\n");
1222         printf("  --terse-version=x\tSet terse version output format to 'x'\n");
1223         printf("  --version\t\tPrint version info and exit\n");
1224         printf("  --help\t\tPrint this page\n");
1225         printf("  --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1226                 " them\n");
1227         printf("  --enghelp=engine\tPrint ioengine help, or list"
1228                 " available ioengines\n");
1229         printf("  --enghelp=engine,cmd\tPrint help for an ioengine"
1230                 " cmd\n");
1231         printf("  --showcmd\t\tTurn a job file into command line options\n");
1232         printf("  --eta=when\t\tWhen ETA estimate should be printed\n");
1233         printf("            \t\tMay be \"always\", \"never\" or \"auto\"\n");
1234         printf("  --readonly\t\tTurn on safety read-only checks, preventing"
1235                 " writes\n");
1236         printf("  --section=name\tOnly run specified section in job file\n");
1237         printf("  --alloc-size=kb\tSet smalloc pool to this size in kb"
1238                 " (def 1024)\n");
1239         printf("  --warnings-fatal\tFio parser warnings are fatal\n");
1240         printf("  --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1241         printf("  --server=args\t\tStart a backend fio server\n");
1242         printf("  --daemonize=pidfile\tBackground fio server, write pid to file\n");
1243         printf("  --client=hostname\tTalk to remote backend fio server at hostname\n");
1244         printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1245         printf("\n                 Jens Axboe <jaxboe@fusionio.com>\n");
1246 }
1247
1248 #ifdef FIO_INC_DEBUG
1249 struct debug_level debug_levels[] = {
1250         { .name = "process",
1251           .help = "Process creation/exit logging",
1252           .shift = FD_PROCESS,
1253         },
1254         { .name = "file",
1255           .help = "File related action logging",
1256           .shift = FD_FILE,
1257         },
1258         { .name = "io",
1259           .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1260           .shift = FD_IO,
1261         },
1262         { .name = "mem",
1263           .help = "Memory allocation/freeing logging",
1264           .shift = FD_MEM,
1265         },
1266         { .name = "blktrace",
1267           .help = "blktrace action logging",
1268           .shift = FD_BLKTRACE,
1269         },
1270         { .name = "verify",
1271           .help = "IO verification action logging",
1272           .shift = FD_VERIFY,
1273         },
1274         { .name = "random",
1275           .help = "Random generation logging",
1276           .shift = FD_RANDOM,
1277         },
1278         { .name = "parse",
1279           .help = "Parser logging",
1280           .shift = FD_PARSE,
1281         },
1282         { .name = "diskutil",
1283           .help = "Disk utility logging actions",
1284           .shift = FD_DISKUTIL,
1285         },
1286         { .name = "job",
1287           .help = "Logging related to creating/destroying jobs",
1288           .shift = FD_JOB,
1289         },
1290         { .name = "mutex",
1291           .help = "Mutex logging",
1292           .shift = FD_MUTEX
1293         },
1294         { .name = "profile",
1295           .help = "Logging related to profiles",
1296           .shift = FD_PROFILE,
1297         },
1298         { .name = "time",
1299           .help = "Logging related to time keeping functions",
1300           .shift = FD_TIME,
1301         },
1302         { .name = "net",
1303           .help = "Network logging",
1304           .shift = FD_NET,
1305         },
1306         { .name = NULL, },
1307 };
1308
1309 static int set_debug(const char *string)
1310 {
1311         struct debug_level *dl;
1312         char *p = (char *) string;
1313         char *opt;
1314         int i;
1315
1316         if (!strcmp(string, "?") || !strcmp(string, "help")) {
1317                 log_info("fio: dumping debug options:");
1318                 for (i = 0; debug_levels[i].name; i++) {
1319                         dl = &debug_levels[i];
1320                         log_info("%s,", dl->name);
1321                 }
1322                 log_info("all\n");
1323                 return 1;
1324         }
1325
1326         while ((opt = strsep(&p, ",")) != NULL) {
1327                 int found = 0;
1328
1329                 if (!strncmp(opt, "all", 3)) {
1330                         log_info("fio: set all debug options\n");
1331                         fio_debug = ~0UL;
1332                         continue;
1333                 }
1334
1335                 for (i = 0; debug_levels[i].name; i++) {
1336                         dl = &debug_levels[i];
1337                         found = !strncmp(opt, dl->name, strlen(dl->name));
1338                         if (!found)
1339                                 continue;
1340
1341                         if (dl->shift == FD_JOB) {
1342                                 opt = strchr(opt, ':');
1343                                 if (!opt) {
1344                                         log_err("fio: missing job number\n");
1345                                         break;
1346                                 }
1347                                 opt++;
1348                                 fio_debug_jobno = atoi(opt);
1349                                 log_info("fio: set debug jobno %d\n",
1350                                                         fio_debug_jobno);
1351                         } else {
1352                                 log_info("fio: set debug option %s\n", opt);
1353                                 fio_debug |= (1UL << dl->shift);
1354                         }
1355                         break;
1356                 }
1357
1358                 if (!found)
1359                         log_err("fio: debug mask %s not found\n", opt);
1360         }
1361         return 0;
1362 }
1363 #else
1364 static int set_debug(const char *string)
1365 {
1366         log_err("fio: debug tracing not included in build\n");
1367         return 1;
1368 }
1369 #endif
1370
1371 static void fio_options_fill_optstring(void)
1372 {
1373         char *ostr = cmd_optstr;
1374         int i, c;
1375
1376         c = i = 0;
1377         while (l_opts[i].name) {
1378                 ostr[c++] = l_opts[i].val;
1379                 if (l_opts[i].has_arg == required_argument)
1380                         ostr[c++] = ':';
1381                 else if (l_opts[i].has_arg == optional_argument) {
1382                         ostr[c++] = ':';
1383                         ostr[c++] = ':';
1384                 }
1385                 i++;
1386         }
1387         ostr[c] = '\0';
1388 }
1389
1390 static int client_flag_set(char c)
1391 {
1392         int i;
1393
1394         i = 0;
1395         while (l_opts[i].name) {
1396                 int val = l_opts[i].val;
1397
1398                 if (c == (val & 0xff))
1399                         return (val & FIO_CLIENT_FLAG);
1400
1401                 i++;
1402         }
1403
1404         return 0;
1405 }
1406
1407 void parse_cmd_client(void *client, char *opt)
1408 {
1409         fio_client_add_cmd_option(client, opt);
1410 }
1411
1412 int parse_cmd_line(int argc, char *argv[], int client_type)
1413 {
1414         struct thread_data *td = NULL;
1415         int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1416         char *ostr = cmd_optstr;
1417         void *pid_file = NULL;
1418         void *cur_client = NULL;
1419         int backend = 0;
1420
1421         /*
1422          * Reset optind handling, since we may call this multiple times
1423          * for the backend.
1424          */
1425         optind = 1;
1426
1427         while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1428                 did_arg = 1;
1429
1430                 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1431                         parse_cmd_client(cur_client, argv[optind - 1]);
1432                         c &= ~FIO_CLIENT_FLAG;
1433                 }
1434
1435                 switch (c) {
1436                 case 'a':
1437                         smalloc_pool_size = atoi(optarg);
1438                         break;
1439                 case 't':
1440                         def_timeout = atoi(optarg);
1441                         break;
1442                 case 'l':
1443                         write_lat_log = 1;
1444                         break;
1445                 case 'b':
1446                         write_bw_log = 1;
1447                         break;
1448                 case 'o':
1449                         f_out = fopen(optarg, "w+");
1450                         if (!f_out) {
1451                                 perror("fopen output");
1452                                 exit(1);
1453                         }
1454                         f_err = f_out;
1455                         break;
1456                 case 'm':
1457                         output_format = FIO_OUTPUT_TERSE;
1458                         break;
1459                 case 'F':
1460                         if (!strcmp(optarg, "minimal") ||
1461                             !strcmp(optarg, "terse") ||
1462                             !strcmp(optarg, "csv"))
1463                                 output_format = FIO_OUTPUT_TERSE;
1464                         else if (!strcmp(optarg, "json"))
1465                                 output_format = FIO_OUTPUT_JSON;
1466                         else
1467                                 output_format = FIO_OUTPUT_NORMAL;
1468                         break;
1469                 case 'h':
1470                         if (!cur_client) {
1471                                 usage(argv[0]);
1472                                 do_exit++;
1473                         }
1474                         break;
1475                 case 'c':
1476                         if (!cur_client) {
1477                                 fio_show_option_help(optarg);
1478                                 do_exit++;
1479                         }
1480                         break;
1481                 case 'i':
1482                         if (!cur_client) {
1483                                 fio_show_ioengine_help(optarg);
1484                                 do_exit++;
1485                         }
1486                         break;
1487                 case 's':
1488                         dump_cmdline = 1;
1489                         break;
1490                 case 'r':
1491                         read_only = 1;
1492                         break;
1493                 case 'v':
1494                         if (!cur_client) {
1495                                 log_info("%s\n", fio_version_string);
1496                                 do_exit++;
1497                         }
1498                         break;
1499                 case 'V':
1500                         terse_version = atoi(optarg);
1501                         if (!(terse_version == 2 || terse_version == 3) ||
1502                              (terse_version == 4)) {
1503                                 log_err("fio: bad terse version format\n");
1504                                 exit_val = 1;
1505                                 do_exit++;
1506                         }
1507                         break;
1508                 case 'e':
1509                         if (!strcmp("always", optarg))
1510                                 eta_print = FIO_ETA_ALWAYS;
1511                         else if (!strcmp("never", optarg))
1512                                 eta_print = FIO_ETA_NEVER;
1513                         break;
1514                 case 'd':
1515                         if (set_debug(optarg))
1516                                 do_exit++;
1517                         break;
1518                 case 'x': {
1519                         size_t new_size;
1520
1521                         if (!strcmp(optarg, "global")) {
1522                                 log_err("fio: can't use global as only "
1523                                         "section\n");
1524                                 do_exit++;
1525                                 exit_val = 1;
1526                                 break;
1527                         }
1528                         new_size = (nr_job_sections + 1) * sizeof(char *);
1529                         job_sections = realloc(job_sections, new_size);
1530                         job_sections[nr_job_sections] = strdup(optarg);
1531                         nr_job_sections++;
1532                         break;
1533                         }
1534                 case 'p':
1535                         exec_profile = strdup(optarg);
1536                         break;
1537                 case FIO_GETOPT_JOB: {
1538                         const char *opt = l_opts[lidx].name;
1539                         char *val = optarg;
1540
1541                         if (!strncmp(opt, "name", 4) && td) {
1542                                 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1543                                 if (ret)
1544                                         return 0;
1545                                 td = NULL;
1546                         }
1547                         if (!td) {
1548                                 int is_section = !strncmp(opt, "name", 4);
1549                                 int global = 0;
1550
1551                                 if (!is_section || !strncmp(val, "global", 6))
1552                                         global = 1;
1553
1554                                 if (is_section && skip_this_section(val))
1555                                         continue;
1556
1557                                 td = get_new_job(global, &def_thread, 1);
1558                                 if (!td || ioengine_load(td))
1559                                         return 0;
1560                                 fio_options_set_ioengine_opts(l_opts, td);
1561                         }
1562
1563                         ret = fio_cmd_option_parse(td, opt, val);
1564
1565                         if (!ret && !strcmp(opt, "ioengine")) {
1566                                 free_ioengine(td);
1567                                 if (ioengine_load(td))
1568                                         return 0;
1569                                 fio_options_set_ioengine_opts(l_opts, td);
1570                         }
1571                         break;
1572                 }
1573                 case FIO_GETOPT_IOENGINE: {
1574                         const char *opt = l_opts[lidx].name;
1575                         char *val = optarg;
1576                         opt = l_opts[lidx].name;
1577                         val = optarg;
1578                         ret = fio_cmd_ioengine_option_parse(td, opt, val);
1579                         break;
1580                 }
1581                 case 'w':
1582                         warnings_fatal = 1;
1583                         break;
1584                 case 'j':
1585                         max_jobs = atoi(optarg);
1586                         if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1587                                 log_err("fio: invalid max jobs: %d\n", max_jobs);
1588                                 do_exit++;
1589                                 exit_val = 1;
1590                         }
1591                         break;
1592                 case 'S':
1593                         if (nr_clients) {
1594                                 log_err("fio: can't be both client and server\n");
1595                                 do_exit++;
1596                                 exit_val = 1;
1597                                 break;
1598                         }
1599                         if (optarg)
1600                                 fio_server_set_arg(optarg);
1601                         is_backend = 1;
1602                         backend = 1;
1603                         break;
1604                 case 'D':
1605                         pid_file = strdup(optarg);
1606                         break;
1607                 case 'C':
1608                         if (is_backend) {
1609                                 log_err("fio: can't be both client and server\n");
1610                                 do_exit++;
1611                                 exit_val = 1;
1612                                 break;
1613                         }
1614                         if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1615                                 log_err("fio: failed adding client %s\n", optarg);
1616                                 do_exit++;
1617                                 exit_val = 1;
1618                                 break;
1619                         }
1620                         /*
1621                          * If the next argument exists and isn't an option,
1622                          * assume it's a job file for this client only.
1623                          */
1624                         while (optind < argc) {
1625                                 if (!strncmp(argv[optind], "--", 2) ||
1626                                     !strncmp(argv[optind], "-", 1))
1627                                         break;
1628
1629                                 fio_client_add_ini_file(cur_client, argv[optind]);
1630                                 optind++;
1631                         }
1632                         break;
1633                 default:
1634                         do_exit++;
1635                         exit_val = 1;
1636                         break;
1637                 }
1638                 if (do_exit)
1639                         break;
1640         }
1641
1642         if (do_exit) {
1643                 if (exit_val && !(is_backend || nr_clients))
1644                         exit(exit_val);
1645         }
1646
1647         if (nr_clients && fio_clients_connect()) {
1648                 do_exit++;
1649                 exit_val = 1;
1650                 return -1;
1651         }
1652
1653         if (is_backend && backend)
1654                 return fio_start_server(pid_file);
1655
1656         if (td) {
1657                 if (!ret)
1658                         ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1659         }
1660
1661         while (!ret && optind < argc) {
1662                 ini_idx++;
1663                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1664                 ini_file[ini_idx - 1] = strdup(argv[optind]);
1665                 optind++;
1666         }
1667
1668         return ini_idx;
1669 }
1670
1671 int fio_init_options(void)
1672 {
1673         f_out = stdout;
1674         f_err = stderr;
1675
1676         fio_options_fill_optstring();
1677         fio_options_dup_and_init(l_opts);
1678
1679         atexit(free_shm);
1680
1681         if (fill_def_thread())
1682                 return 1;
1683
1684         return 0;
1685 }
1686
1687 extern int fio_check_options(struct thread_options *);
1688
1689 int parse_options(int argc, char *argv[])
1690 {
1691         const int type = FIO_CLIENT_TYPE_CLI;
1692         int job_files, i;
1693
1694         if (fio_init_options())
1695                 return 1;
1696         if (fio_test_cconv(&def_thread.o))
1697                 log_err("fio: failed internal cconv test\n");
1698
1699         job_files = parse_cmd_line(argc, argv, type);
1700
1701         if (job_files > 0) {
1702                 for (i = 0; i < job_files; i++) {
1703                         if (fill_def_thread())
1704                                 return 1;
1705                         if (nr_clients) {
1706                                 if (fio_clients_send_ini(ini_file[i]))
1707                                         return 1;
1708                                 free(ini_file[i]);
1709                         } else if (!is_backend) {
1710                                 if (parse_jobs_ini(ini_file[i], 0, i, type))
1711                                         return 1;
1712                                 free(ini_file[i]);
1713                         }
1714                 }
1715         } else if (nr_clients) {
1716                 if (fill_def_thread())
1717                         return 1;
1718                 if (fio_clients_send_ini(NULL))
1719                         return 1;
1720         }
1721
1722         free(ini_file);
1723         fio_options_free(&def_thread);
1724
1725         if (!thread_number) {
1726                 if (dump_cmdline)
1727                         return 0;
1728                 if (exec_profile)
1729                         return 0;
1730                 if (is_backend || nr_clients)
1731                         return 0;
1732                 if (did_arg)
1733                         return 0;
1734
1735                 log_err("No jobs(s) defined\n\n");
1736
1737                 if (!did_arg) {
1738                         usage(argv[0]);
1739                         return 1;
1740                 }
1741
1742                 return 0;
1743         }
1744
1745         if (def_thread.o.gtod_offload) {
1746                 fio_gtod_init();
1747                 fio_gtod_offload = 1;
1748                 fio_gtod_cpu = def_thread.o.gtod_cpu;
1749         }
1750
1751         if (output_format == FIO_OUTPUT_NORMAL)
1752                 log_info("%s\n", fio_version_string);
1753
1754         return 0;
1755 }
1756
1757 void options_default_fill(struct thread_options *o)
1758 {
1759         memcpy(o, &def_thread.o, sizeof(*o));
1760 }