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