Add blockalign/ba option
[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 <getopt.h>
12 #include <sys/ipc.h>
13 #include <sys/shm.h>
14 #include <sys/types.h>
15 #include <sys/stat.h>
16
17 #include "fio.h"
18 #include "parse.h"
19 #include "smalloc.h"
20 #include "filehash.h"
21
22 static char fio_version_string[] = "fio 1.24";
23
24 #define FIO_RANDSEED            (0xb1899bedUL)
25
26 static char **ini_file;
27 static int max_jobs = MAX_JOBS;
28 static int dump_cmdline;
29
30 static struct thread_data def_thread;
31 struct thread_data *threads = NULL;
32
33 int exitall_on_terminate = 0;
34 int terse_output = 0;
35 int eta_print;
36 unsigned long long mlock_size = 0;
37 FILE *f_out = NULL;
38 FILE *f_err = NULL;
39 char *job_section = NULL;
40
41 int write_bw_log = 0;
42 int read_only = 0;
43
44 static int def_timeout;
45 static int write_lat_log;
46
47 static int prev_group_jobs;
48
49 unsigned long fio_debug = 0;
50 unsigned int fio_debug_jobno = -1;
51 unsigned int *fio_debug_jobp = NULL;
52
53 /*
54  * Command line options. These will contain the above, plus a few
55  * extra that only pertain to fio itself and not jobs.
56  */
57 static struct option l_opts[FIO_NR_OPTIONS] = {
58         {
59                 .name           = "output",
60                 .has_arg        = required_argument,
61                 .val            = 'o',
62         },
63         {
64                 .name           = "timeout",
65                 .has_arg        = required_argument,
66                 .val            = 't',
67         },
68         {
69                 .name           = "latency-log",
70                 .has_arg        = required_argument,
71                 .val            = 'l',
72         },
73         {
74                 .name           = "bandwidth-log",
75                 .has_arg        = required_argument,
76                 .val            = 'b',
77         },
78         {
79                 .name           = "minimal",
80                 .has_arg        = optional_argument,
81                 .val            = 'm',
82         },
83         {
84                 .name           = "version",
85                 .has_arg        = no_argument,
86                 .val            = 'v',
87         },
88         {
89                 .name           = "help",
90                 .has_arg        = no_argument,
91                 .val            = 'h',
92         },
93         {
94                 .name           = "cmdhelp",
95                 .has_arg        = optional_argument,
96                 .val            = 'c',
97         },
98         {
99                 .name           = "showcmd",
100                 .has_arg        = no_argument,
101                 .val            = 's',
102         },
103         {
104                 .name           = "readonly",
105                 .has_arg        = no_argument,
106                 .val            = 'r',
107         },
108         {
109                 .name           = "eta",
110                 .has_arg        = required_argument,
111                 .val            = 'e',
112         },
113         {
114                 .name           = "debug",
115                 .has_arg        = required_argument,
116                 .val            = 'd',
117         },
118         {
119                 .name           = "section",
120                 .has_arg        = required_argument,
121                 .val            = 'x',
122         },
123         {
124                 .name           = "alloc-size",
125                 .has_arg        = required_argument,
126                 .val            = 'a',
127         },
128         {
129                 .name           = NULL,
130         },
131 };
132
133 FILE *get_f_out()
134 {
135         return f_out;
136 }
137
138 FILE *get_f_err()
139 {
140         return f_err;
141 }
142
143 /*
144  * Return a free job structure.
145  */
146 static struct thread_data *get_new_job(int global, struct thread_data *parent)
147 {
148         struct thread_data *td;
149
150         if (global)
151                 return &def_thread;
152         if (thread_number >= max_jobs)
153                 return NULL;
154
155         td = &threads[thread_number++];
156         *td = *parent;
157
158         dup_files(td, parent);
159         options_mem_dupe(td);
160
161         td->thread_number = thread_number;
162         return td;
163 }
164
165 static void put_job(struct thread_data *td)
166 {
167         if (td == &def_thread)
168                 return;
169
170         if (td->error)
171                 log_info("fio: %s\n", td->verror);
172
173         memset(&threads[td->thread_number - 1], 0, sizeof(*td));
174         thread_number--;
175 }
176
177 static int setup_rate(struct thread_data *td)
178 {
179         unsigned long nr_reads_per_msec;
180         unsigned long long rate;
181         unsigned int bs;
182
183         if (!td->o.rate && !td->o.rate_iops)
184                 return 0;
185
186         if (td_rw(td))
187                 bs = td->o.rw_min_bs;
188         else if (td_read(td))
189                 bs = td->o.min_bs[DDIR_READ];
190         else
191                 bs = td->o.min_bs[DDIR_WRITE];
192
193         if (td->o.rate) {
194                 rate = td->o.rate;
195                 nr_reads_per_msec = (rate * 1024 * 1000LL) / bs;
196         } else
197                 nr_reads_per_msec = td->o.rate_iops * 1000UL;
198
199         if (!nr_reads_per_msec) {
200                 log_err("rate lower than supported\n");
201                 return -1;
202         }
203
204         td->rate_usec_cycle = 1000000000ULL / nr_reads_per_msec;
205         td->rate_pending_usleep = 0;
206         return 0;
207 }
208
209 static int fixed_block_size(struct thread_options *o)
210 {
211         return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
212                 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
213                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
214 }
215
216 /*
217  * Lazy way of fixing up options that depend on each other. We could also
218  * define option callback handlers, but this is easier.
219  */
220 static int fixup_options(struct thread_data *td)
221 {
222         struct thread_options *o = &td->o;
223
224 #ifndef FIO_HAVE_PSHARED_MUTEX
225         if (!td->o.use_thread) {
226                 log_info("fio: this platform does not support process shared"
227                          " mutexes, forcing use of threads. Use the 'thread'"
228                          " option to get rid of this warning.\n");
229                 td->o.use_thread = 1;
230         }
231 #endif
232
233 #ifndef FIO_HAVE_CPU_AFFINITY
234         if (td->o.gtod_cpu) {
235                 log_err("fio: platform must support CPU affinity for"
236                         "gettimeofday() offloading\n");
237                 return 1;
238         }
239 #endif
240
241         if (read_only && td_write(td)) {
242                 log_err("fio: job <%s> has write bit set, but fio is in"
243                         " read-only mode\n", td->o.name);
244                 return 1;
245         }
246
247         if (o->write_iolog_file && o->read_iolog_file) {
248                 log_err("fio: read iolog overrides write_iolog\n");
249                 free(o->write_iolog_file);
250                 o->write_iolog_file = NULL;
251         }
252
253         /*
254          * only really works for sequential io for now, and with 1 file
255          */
256         if (o->zone_size && td_random(td) && o->open_files == 1)
257                 o->zone_size = 0;
258
259         /*
260          * Reads can do overwrites, we always need to pre-create the file
261          */
262         if (td_read(td) || td_rw(td))
263                 o->overwrite = 1;
264
265         if (!o->min_bs[DDIR_READ])
266                 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
267         if (!o->max_bs[DDIR_READ])
268                 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
269         if (!o->min_bs[DDIR_WRITE])
270                 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
271         if (!o->max_bs[DDIR_WRITE])
272                 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
273
274         o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
275
276         /*
277          * For random IO, allow blockalign offset other than min_bs.
278          */
279         if (!o->ba[DDIR_READ] || !td_random(td))
280                 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
281         if (!o->ba[DDIR_WRITE] || !td_random(td))
282                 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
283
284         if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
285             o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
286             !td->o.norandommap) {
287                 log_err("fio: Any use of blockalign= turns off randommap\n");
288                 td->o.norandommap = 1;
289         }
290
291         if (!o->file_size_high)
292                 o->file_size_high = o->file_size_low;
293
294         if (o->norandommap && o->verify != VERIFY_NONE
295             && !fixed_block_size(o))  {
296                 log_err("fio: norandommap given for variable block sizes, "
297                         "verify disabled\n");
298                 o->verify = VERIFY_NONE;
299         }
300         if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
301                 log_err("fio: bs_unaligned may not work with raw io\n");
302
303         /*
304          * thinktime_spin must be less than thinktime
305          */
306         if (o->thinktime_spin > o->thinktime)
307                 o->thinktime_spin = o->thinktime;
308
309         /*
310          * The low water mark cannot be bigger than the iodepth
311          */
312         if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
313                 /*
314                  * syslet work around - if the workload is sequential,
315                  * we want to let the queue drain all the way down to
316                  * avoid seeking between async threads
317                  */
318                 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
319                         o->iodepth_low = 1;
320                 else
321                         o->iodepth_low = o->iodepth;
322         }
323
324         /*
325          * If batch number isn't set, default to the same as iodepth
326          */
327         if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
328                 o->iodepth_batch = o->iodepth;
329
330         if (o->nr_files > td->files_index)
331                 o->nr_files = td->files_index;
332
333         if (o->open_files > o->nr_files || !o->open_files)
334                 o->open_files = o->nr_files;
335
336         if ((o->rate && o->rate_iops) || (o->ratemin && o->rate_iops_min)) {
337                 log_err("fio: rate and rate_iops are mutually exclusive\n");
338                 return 1;
339         }
340         if ((o->rate < o->ratemin) || (o->rate_iops < o->rate_iops_min)) {
341                 log_err("fio: minimum rate exceeds rate\n");
342                 return 1;
343         }
344
345         if (!o->timeout && o->time_based) {
346                 log_err("fio: time_based requires a runtime/timeout setting\n");
347                 o->time_based = 0;
348         }
349
350         if (o->fill_device && !o->size)
351                 o->size = -1ULL;
352
353         if (td_rw(td) && td->o.verify != VERIFY_NONE)
354                 log_info("fio: mixed read/write workload with verify. May not "
355                  "work as expected, unless you pre-populated the file\n");
356
357         if (td->o.verify != VERIFY_NONE)
358                 td->o.refill_buffers = 1;
359
360         return 0;
361 }
362
363 /*
364  * This function leaks the buffer
365  */
366 static char *to_kmg(unsigned int val)
367 {
368         char *buf = malloc(32);
369         char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
370         char *p = post;
371
372         do {
373                 if (val & 1023)
374                         break;
375
376                 val >>= 10;
377                 p++;
378         } while (*p);
379
380         snprintf(buf, 31, "%u%c", val, *p);
381         return buf;
382 }
383
384 /* External engines are specified by "external:name.o") */
385 static const char *get_engine_name(const char *str)
386 {
387         char *p = strstr(str, ":");
388
389         if (!p)
390                 return str;
391
392         p++;
393         strip_blank_front(&p);
394         strip_blank_end(p);
395         return p;
396 }
397
398 static int exists_and_not_file(const char *filename)
399 {
400         struct stat sb;
401
402         if (lstat(filename, &sb) == -1)
403                 return 0;
404
405         if (S_ISREG(sb.st_mode))
406                 return 0;
407
408         return 1;
409 }
410
411 /*
412  * Initialize the various random states we need (random io, block size ranges,
413  * read/write mix, etc).
414  */
415 static int init_random_state(struct thread_data *td)
416 {
417         unsigned long seeds[6];
418         int fd;
419
420         fd = open("/dev/urandom", O_RDONLY);
421         if (fd == -1) {
422                 td_verror(td, errno, "open");
423                 return 1;
424         }
425
426         if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
427                 td_verror(td, EIO, "read");
428                 close(fd);
429                 return 1;
430         }
431
432         close(fd);
433
434         os_random_seed(seeds[0], &td->bsrange_state);
435         os_random_seed(seeds[1], &td->verify_state);
436         os_random_seed(seeds[2], &td->rwmix_state);
437
438         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
439                 os_random_seed(seeds[3], &td->next_file_state);
440
441         os_random_seed(seeds[5], &td->file_size_state);
442
443         if (!td_random(td))
444                 return 0;
445
446         if (td->o.rand_repeatable)
447                 seeds[4] = FIO_RANDSEED * td->thread_number;
448
449         os_random_seed(seeds[4], &td->random_state);
450         return 0;
451 }
452
453 /*
454  * Adds a job to the list of things todo. Sanitizes the various options
455  * to make sure we don't have conflicts, and initializes various
456  * members of td.
457  */
458 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
459 {
460         const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
461                                    "randread", "randwrite", "randrw" };
462         unsigned int i;
463         const char *engine;
464         char fname[PATH_MAX];
465         int numjobs, file_alloced;
466
467         /*
468          * the def_thread is just for options, it's not a real job
469          */
470         if (td == &def_thread)
471                 return 0;
472
473         /*
474          * if we are just dumping the output command line, don't add the job
475          */
476         if (dump_cmdline) {
477                 put_job(td);
478                 return 0;
479         }
480
481         engine = get_engine_name(td->o.ioengine);
482         td->io_ops = load_ioengine(td, engine);
483         if (!td->io_ops) {
484                 log_err("fio: failed to load engine %s\n", engine);
485                 goto err;
486         }
487
488         if (td->o.use_thread)
489                 nr_thread++;
490         else
491                 nr_process++;
492
493         if (td->o.odirect)
494                 td->io_ops->flags |= FIO_RAWIO;
495
496         file_alloced = 0;
497         if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
498                 file_alloced = 1;
499
500                 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
501                         add_file(td, jobname);
502                 else {
503                         for (i = 0; i < td->o.nr_files; i++) {
504                                 sprintf(fname, "%s.%d.%d", jobname,
505                                                         td->thread_number, i);
506                                 add_file(td, fname);
507                         }
508                 }
509         }
510
511         if (fixup_options(td))
512                 goto err;
513
514         if (td->io_ops->flags & FIO_DISKLESSIO) {
515                 struct fio_file *f;
516
517                 for_each_file(td, f, i)
518                         f->real_file_size = -1ULL;
519         }
520
521         td->mutex = fio_mutex_init(0);
522
523         td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
524         td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
525         td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
526         td->ddir_nr = td->o.ddir_nr;
527
528         if ((td->o.stonewall || td->o.numjobs > 1 || td->o.new_group)
529              && prev_group_jobs) {
530                 prev_group_jobs = 0;
531                 groupid++;
532         }
533
534         td->groupid = groupid;
535         prev_group_jobs++;
536
537         if (init_random_state(td))
538                 goto err;
539
540         if (setup_rate(td))
541                 goto err;
542
543         if (td->o.write_lat_log) {
544                 setup_log(&td->ts.slat_log);
545                 setup_log(&td->ts.clat_log);
546         }
547         if (td->o.write_bw_log)
548                 setup_log(&td->ts.bw_log);
549
550         if (!td->o.name)
551                 td->o.name = strdup(jobname);
552
553         if (!terse_output) {
554                 if (!job_add_num) {
555                         if (!strcmp(td->io_ops->name, "cpuio")) {
556                                 log_info("%s: ioengine=cpu, cpuload=%u,"
557                                          " cpucycle=%u\n", td->o.name,
558                                                         td->o.cpuload,
559                                                         td->o.cpucycle);
560                         } else {
561                                 char *c1, *c2, *c3, *c4;
562
563                                 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
564                                 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
565                                 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
566                                 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
567
568                                 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
569                                          " ioengine=%s, iodepth=%u\n",
570                                                 td->o.name, td->groupid,
571                                                 ddir_str[td->o.td_ddir],
572                                                 c1, c2, c3, c4,
573                                                 td->io_ops->name,
574                                                 td->o.iodepth);
575
576                                 free(c1);
577                                 free(c2);
578                                 free(c3);
579                                 free(c4);
580                         }
581                 } else if (job_add_num == 1)
582                         log_info("...\n");
583         }
584
585         /*
586          * recurse add identical jobs, clear numjobs and stonewall options
587          * as they don't apply to sub-jobs
588          */
589         numjobs = td->o.numjobs;
590         while (--numjobs) {
591                 struct thread_data *td_new = get_new_job(0, td);
592
593                 if (!td_new)
594                         goto err;
595
596                 td_new->o.numjobs = 1;
597                 td_new->o.stonewall = 0;
598                 td_new->o.new_group = 0;
599
600                 if (file_alloced) {
601                         td_new->o.filename = NULL;
602                         td_new->files_index = 0;
603                         td_new->files_size = 0;
604                         td_new->files = NULL;
605                 }
606
607                 job_add_num = numjobs - 1;
608
609                 if (add_job(td_new, jobname, job_add_num))
610                         goto err;
611         }
612
613         return 0;
614 err:
615         put_job(td);
616         return -1;
617 }
618
619 static int skip_this_section(const char *name)
620 {
621         if (!job_section)
622                 return 0;
623         if (!strncmp(name, "global", 6))
624                 return 0;
625
626         return strcmp(job_section, name);
627 }
628
629 static int is_empty_or_comment(char *line)
630 {
631         unsigned int i;
632
633         for (i = 0; i < strlen(line); i++) {
634                 if (line[i] == ';')
635                         return 1;
636                 if (line[i] == '#')
637                         return 1;
638                 if (!isspace(line[i]) && !iscntrl(line[i]))
639                         return 0;
640         }
641
642         return 1;
643 }
644
645 /*
646  * This is our [ini] type file parser.
647  */
648 static int parse_jobs_ini(char *file, int stonewall_flag)
649 {
650         unsigned int global;
651         struct thread_data *td;
652         char *string, *name;
653         FILE *f;
654         char *p;
655         int ret = 0, stonewall;
656         int first_sect = 1;
657         int skip_fgets = 0;
658         int inside_skip = 0;
659         char **opts;
660         int i, alloc_opts, num_opts;
661
662         if (!strcmp(file, "-"))
663                 f = stdin;
664         else
665                 f = fopen(file, "r");
666
667         if (!f) {
668                 perror("fopen job file");
669                 return 1;
670         }
671
672         string = malloc(4096);
673
674         /*
675          * it's really 256 + small bit, 280 should suffice
676          */
677         name = malloc(280);
678         memset(name, 0, 280);
679
680         alloc_opts = 8;
681         opts = malloc(sizeof(char *) * alloc_opts);
682         num_opts = 0;
683
684         stonewall = stonewall_flag;
685         do {
686                 /*
687                  * if skip_fgets is set, we already have loaded a line we
688                  * haven't handled.
689                  */
690                 if (!skip_fgets) {
691                         p = fgets(string, 4095, f);
692                         if (!p)
693                                 break;
694                 }
695
696                 skip_fgets = 0;
697                 strip_blank_front(&p);
698                 strip_blank_end(p);
699
700                 if (is_empty_or_comment(p))
701                         continue;
702                 if (sscanf(p, "[%255s]", name) != 1) {
703                         if (inside_skip)
704                                 continue;
705                         log_err("fio: option <%s> outside of [] job section\n",
706                                                                         p);
707                         break;
708                 }
709
710                 if (skip_this_section(name)) {
711                         inside_skip = 1;
712                         continue;
713                 } else
714                         inside_skip = 0;
715
716                 global = !strncmp(name, "global", 6);
717
718                 name[strlen(name) - 1] = '\0';
719
720                 if (dump_cmdline) {
721                         if (first_sect)
722                                 log_info("fio ");
723                         if (!global)
724                                 log_info("--name=%s ", name);
725                         first_sect = 0;
726                 }
727
728                 td = get_new_job(global, &def_thread);
729                 if (!td) {
730                         ret = 1;
731                         break;
732                 }
733
734                 /*
735                  * Seperate multiple job files by a stonewall
736                  */
737                 if (!global && stonewall) {
738                         td->o.stonewall = stonewall;
739                         stonewall = 0;
740                 }
741
742                 num_opts = 0;
743                 memset(opts, 0, alloc_opts * sizeof(char *));
744
745                 while ((p = fgets(string, 4096, f)) != NULL) {
746                         if (is_empty_or_comment(p))
747                                 continue;
748
749                         strip_blank_front(&p);
750
751                         /*
752                          * new section, break out and make sure we don't
753                          * fgets() a new line at the top.
754                          */
755                         if (p[0] == '[') {
756                                 skip_fgets = 1;
757                                 break;
758                         }
759
760                         strip_blank_end(p);
761
762                         if (num_opts == alloc_opts) {
763                                 alloc_opts <<= 1;
764                                 opts = realloc(opts,
765                                                 alloc_opts * sizeof(char *));
766                         }
767
768                         opts[num_opts] = strdup(p);
769                         num_opts++;
770                 }
771
772                 ret = fio_options_parse(td, opts, num_opts);
773                 if (!ret) {
774                         if (dump_cmdline)
775                                 for (i = 0; i < num_opts; i++)
776                                         log_info("--%s ", opts[i]);
777
778                         ret = add_job(td, name, 0);
779                 } else {
780                         log_err("fio: job %s dropped\n", name);
781                         put_job(td);
782                 }
783
784                 for (i = 0; i < num_opts; i++)
785                         free(opts[i]);
786                 num_opts = 0;
787         } while (!ret);
788
789         if (dump_cmdline)
790                 log_info("\n");
791
792         for (i = 0; i < num_opts; i++)
793                 free(opts[i]);
794
795         free(string);
796         free(name);
797         free(opts);
798         if (f != stdin)
799                 fclose(f);
800         return ret;
801 }
802
803 static int fill_def_thread(void)
804 {
805         memset(&def_thread, 0, sizeof(def_thread));
806
807         fio_getaffinity(getpid(), &def_thread.o.cpumask);
808
809         /*
810          * fill default options
811          */
812         fio_fill_default_options(&def_thread);
813
814         def_thread.o.timeout = def_timeout;
815         def_thread.o.write_bw_log = write_bw_log;
816         def_thread.o.write_lat_log = write_lat_log;
817
818         return 0;
819 }
820
821 static void free_shm(void)
822 {
823         struct shmid_ds sbuf;
824
825         if (threads) {
826                 void *tp = threads;
827
828                 threads = NULL;
829                 file_hash_exit();
830                 fio_debug_jobp = NULL;
831                 shmdt(tp);
832                 shmctl(shm_id, IPC_RMID, &sbuf);
833         }
834
835         scleanup();
836 }
837
838 /*
839  * The thread area is shared between the main process and the job
840  * threads/processes. So setup a shared memory segment that will hold
841  * all the job info. We use the end of the region for keeping track of
842  * open files across jobs, for file sharing.
843  */
844 static int setup_thread_area(void)
845 {
846         void *hash;
847
848         /*
849          * 1024 is too much on some machines, scale max_jobs if
850          * we get a failure that looks like too large a shm segment
851          */
852         do {
853                 size_t size = max_jobs * sizeof(struct thread_data);
854
855                 size += file_hash_size;
856                 size += sizeof(unsigned int);
857
858                 shm_id = shmget(0, size, IPC_CREAT | 0600);
859                 if (shm_id != -1)
860                         break;
861                 if (errno != EINVAL) {
862                         perror("shmget");
863                         break;
864                 }
865
866                 max_jobs >>= 1;
867         } while (max_jobs);
868
869         if (shm_id == -1)
870                 return 1;
871
872         threads = shmat(shm_id, NULL, 0);
873         if (threads == (void *) -1) {
874                 perror("shmat");
875                 return 1;
876         }
877
878         memset(threads, 0, max_jobs * sizeof(struct thread_data));
879         hash = (void *) threads + max_jobs * sizeof(struct thread_data);
880         fio_debug_jobp = (void *) hash + file_hash_size;
881         *fio_debug_jobp = -1;
882         file_hash_init(hash);
883         atexit(free_shm);
884         return 0;
885 }
886
887 static void usage(const char *name)
888 {
889         printf("%s\n", fio_version_string);
890         printf("%s [options] [job options] <job file(s)>\n", name);
891         printf("\t--debug=options\tEnable debug logging\n");
892         printf("\t--output\tWrite output to file\n");
893         printf("\t--timeout\tRuntime in seconds\n");
894         printf("\t--latency-log\tGenerate per-job latency logs\n");
895         printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
896         printf("\t--minimal\tMinimal (terse) output\n");
897         printf("\t--version\tPrint version info and exit\n");
898         printf("\t--help\t\tPrint this page\n");
899         printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of"
900                 " them\n");
901         printf("\t--showcmd\tTurn a job file into command line options\n");
902         printf("\t--eta=when\tWhen ETA estimate should be printed\n");
903         printf("\t          \tMay be \"always\", \"never\" or \"auto\"\n");
904         printf("\t--readonly\tTurn on safety read-only checks, preventing"
905                 " writes\n");
906         printf("\t--section=name\tOnly run specified section in job file\n");
907         printf("\t--alloc-size=kb\tSet smalloc pool to this size in kb"
908                 " (def 1024)\n");
909 }
910
911 #ifdef FIO_INC_DEBUG
912 struct debug_level debug_levels[] = {
913         { .name = "process",    .shift = FD_PROCESS, },
914         { .name = "file",       .shift = FD_FILE, },
915         { .name = "io",         .shift = FD_IO, },
916         { .name = "mem",        .shift = FD_MEM, },
917         { .name = "blktrace",   .shift = FD_BLKTRACE },
918         { .name = "verify",     .shift = FD_VERIFY },
919         { .name = "random",     .shift = FD_RANDOM },
920         { .name = "parse",      .shift = FD_PARSE },
921         { .name = "diskutil",   .shift = FD_DISKUTIL },
922         { .name = "job",        .shift = FD_JOB },
923         { .name = "mutex",      .shift = FD_MUTEX },
924         { .name = NULL, },
925 };
926
927 static int set_debug(const char *string)
928 {
929         struct debug_level *dl;
930         char *p = (char *) string;
931         char *opt;
932         int i;
933
934         if (!strcmp(string, "?") || !strcmp(string, "help")) {
935                 int i;
936
937                 log_info("fio: dumping debug options:");
938                 for (i = 0; debug_levels[i].name; i++) {
939                         dl = &debug_levels[i];
940                         log_info("%s,", dl->name);
941                 }
942                 log_info("all\n");
943                 return 1;
944         }
945
946         while ((opt = strsep(&p, ",")) != NULL) {
947                 int found = 0;
948
949                 if (!strncmp(opt, "all", 3)) {
950                         log_info("fio: set all debug options\n");
951                         fio_debug = ~0UL;
952                         continue;
953                 }
954
955                 for (i = 0; debug_levels[i].name; i++) {
956                         dl = &debug_levels[i];
957                         found = !strncmp(opt, dl->name, strlen(dl->name));
958                         if (!found)
959                                 continue;
960
961                         if (dl->shift == FD_JOB) {
962                                 opt = strchr(opt, ':');
963                                 if (!opt) {
964                                         log_err("fio: missing job number\n");
965                                         break;
966                                 }
967                                 opt++;
968                                 fio_debug_jobno = atoi(opt);
969                                 log_info("fio: set debug jobno %d\n",
970                                                         fio_debug_jobno);
971                         } else {
972                                 log_info("fio: set debug option %s\n", opt);
973                                 fio_debug |= (1UL << dl->shift);
974                         }
975                         break;
976                 }
977
978                 if (!found)
979                         log_err("fio: debug mask %s not found\n", opt);
980         }
981         return 0;
982 }
983 #else
984 static int set_debug(const char *string)
985 {
986         log_err("fio: debug tracing not included in build\n");
987         return 1;
988 }
989 #endif
990
991 static int parse_cmd_line(int argc, char *argv[])
992 {
993         struct thread_data *td = NULL;
994         int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
995
996         while ((c = getopt_long_only(argc, argv, "", l_opts, &lidx)) != -1) {
997                 switch (c) {
998                 case 'a':
999                         smalloc_pool_size = atoi(optarg);
1000                         break;
1001                 case 't':
1002                         def_timeout = atoi(optarg);
1003                         break;
1004                 case 'l':
1005                         write_lat_log = 1;
1006                         break;
1007                 case 'w':
1008                         write_bw_log = 1;
1009                         break;
1010                 case 'o':
1011                         f_out = fopen(optarg, "w+");
1012                         if (!f_out) {
1013                                 perror("fopen output");
1014                                 exit(1);
1015                         }
1016                         f_err = f_out;
1017                         break;
1018                 case 'm':
1019                         terse_output = 1;
1020                         break;
1021                 case 'h':
1022                         usage(argv[0]);
1023                         exit(0);
1024                 case 'c':
1025                         exit(fio_show_option_help(optarg));
1026                 case 's':
1027                         dump_cmdline = 1;
1028                         break;
1029                 case 'r':
1030                         read_only = 1;
1031                         break;
1032                 case 'v':
1033                         printf("%s\n", fio_version_string);
1034                         exit(0);
1035                 case 'e':
1036                         if (!strcmp("always", optarg))
1037                                 eta_print = FIO_ETA_ALWAYS;
1038                         else if (!strcmp("never", optarg))
1039                                 eta_print = FIO_ETA_NEVER;
1040                         break;
1041                 case 'd':
1042                         if (set_debug(optarg))
1043                                 do_exit++;
1044                         break;
1045                 case 'x':
1046                         if (!strcmp(optarg, "global")) {
1047                                 log_err("fio: can't use global as only "
1048                                         "section\n");
1049                                 do_exit++;
1050                                 exit_val = 1;
1051                                 break;
1052                         }
1053                         if (job_section)
1054                                 free(job_section);
1055                         job_section = strdup(optarg);
1056                         break;
1057                 case FIO_GETOPT_JOB: {
1058                         const char *opt = l_opts[lidx].name;
1059                         char *val = optarg;
1060
1061                         if (!strncmp(opt, "name", 4) && td) {
1062                                 ret = add_job(td, td->o.name ?: "fio", 0);
1063                                 if (ret) {
1064                                         put_job(td);
1065                                         return 0;
1066                                 }
1067                                 td = NULL;
1068                         }
1069                         if (!td) {
1070                                 int is_section = !strncmp(opt, "name", 4);
1071                                 int global = 0;
1072
1073                                 if (!is_section || !strncmp(val, "global", 6))
1074                                         global = 1;
1075
1076                                 if (is_section && skip_this_section(val))
1077                                         continue;
1078
1079                                 td = get_new_job(global, &def_thread);
1080                                 if (!td)
1081                                         return 0;
1082                         }
1083
1084                         ret = fio_cmd_option_parse(td, opt, val);
1085                         break;
1086                 }
1087                 default:
1088                         do_exit++;
1089                         exit_val = 1;
1090                         break;
1091                 }
1092         }
1093
1094         if (do_exit)
1095                 exit(exit_val);
1096
1097         if (td) {
1098                 if (!ret)
1099                         ret = add_job(td, td->o.name ?: "fio", 0);
1100                 if (ret)
1101                         put_job(td);
1102         }
1103
1104         while (optind < argc) {
1105                 ini_idx++;
1106                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1107                 ini_file[ini_idx - 1] = strdup(argv[optind]);
1108                 optind++;
1109         }
1110
1111         return ini_idx;
1112 }
1113
1114 int parse_options(int argc, char *argv[])
1115 {
1116         int job_files, i;
1117
1118         f_out = stdout;
1119         f_err = stderr;
1120
1121         fio_options_dup_and_init(l_opts);
1122
1123         if (setup_thread_area())
1124                 return 1;
1125         if (fill_def_thread())
1126                 return 1;
1127
1128         job_files = parse_cmd_line(argc, argv);
1129
1130         for (i = 0; i < job_files; i++) {
1131                 if (fill_def_thread())
1132                         return 1;
1133                 if (parse_jobs_ini(ini_file[i], i))
1134                         return 1;
1135                 free(ini_file[i]);
1136         }
1137
1138         free(ini_file);
1139         options_mem_free(&def_thread);
1140
1141         if (!thread_number) {
1142                 if (dump_cmdline)
1143                         return 0;
1144
1145                 log_err("No jobs defined(s)\n");
1146                 usage(argv[0]);
1147                 return 1;
1148         }
1149
1150         if (def_thread.o.gtod_offload) {
1151                 fio_gtod_init();
1152                 fio_gtod_offload = 1;
1153                 fio_gtod_cpu = def_thread.o.gtod_cpu;
1154         }
1155
1156         return 0;
1157 }