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