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