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