--latency-log is now gone
[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/types.h>
13 #include <sys/stat.h>
14
15 #include "fio.h"
16 #ifndef FIO_NO_HAVE_SHM_H
17 #include <sys/shm.h>
18 #endif
19
20 #include "parse.h"
21 #include "smalloc.h"
22 #include "filehash.h"
23 #include "verify.h"
24 #include "profile.h"
25 #include "server.h"
26 #include "idletime.h"
27 #include "filelock.h"
28
29 #include "lib/getopt.h"
30 #include "lib/strcasestr.h"
31
32 #include "crc/test.h"
33
34 const char fio_version_string[] = FIO_VERSION;
35
36 #define FIO_RANDSEED            (0xb1899bedUL)
37
38 static char **ini_file;
39 static int max_jobs = FIO_MAX_JOBS;
40 static int dump_cmdline;
41 static long long def_timeout;
42 static int parse_only;
43
44 static struct thread_data def_thread;
45 struct thread_data *threads = NULL;
46 static char **job_sections;
47 static int nr_job_sections;
48
49 int exitall_on_terminate = 0;
50 int output_format = FIO_OUTPUT_NORMAL;
51 int append_terse_output = 0;
52 int eta_print = FIO_ETA_AUTO;
53 int eta_new_line = 0;
54 FILE *f_out = NULL;
55 FILE *f_err = NULL;
56 char *exec_profile = NULL;
57 int warnings_fatal = 0;
58 int terse_version = 3;
59 int is_backend = 0;
60 int nr_clients = 0;
61 int log_syslog = 0;
62
63 int write_bw_log = 0;
64 int read_only = 0;
65 int status_interval = 0;
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 #define FIO_CLIENT_FLAG         (1 << 16)
77
78 /*
79  * Command line options. These will contain the above, plus a few
80  * extra that only pertain to fio itself and not jobs.
81  */
82 static struct option l_opts[FIO_NR_OPTIONS] = {
83         {
84                 .name           = (char *) "output",
85                 .has_arg        = required_argument,
86                 .val            = 'o' | FIO_CLIENT_FLAG,
87         },
88         {
89                 .name           = (char *) "timeout",
90                 .has_arg        = required_argument,
91                 .val            = 't' | FIO_CLIENT_FLAG,
92         },
93         {
94                 .name           = (char *) "latency-log",
95                 .has_arg        = required_argument,
96                 .val            = 'l' | FIO_CLIENT_FLAG,
97         },
98         {
99                 .name           = (char *) "bandwidth-log",
100                 .has_arg        = required_argument,
101                 .val            = 'b' | FIO_CLIENT_FLAG,
102         },
103         {
104                 .name           = (char *) "minimal",
105                 .has_arg        = no_argument,
106                 .val            = 'm' | FIO_CLIENT_FLAG,
107         },
108         {
109                 .name           = (char *) "output-format",
110                 .has_arg        = optional_argument,
111                 .val            = 'F' | FIO_CLIENT_FLAG,
112         },
113         {
114                 .name           = (char *) "append-terse",
115                 .has_arg        = optional_argument,
116                 .val            = 'f',
117         },
118         {
119                 .name           = (char *) "version",
120                 .has_arg        = no_argument,
121                 .val            = 'v' | FIO_CLIENT_FLAG,
122         },
123         {
124                 .name           = (char *) "help",
125                 .has_arg        = no_argument,
126                 .val            = 'h' | FIO_CLIENT_FLAG,
127         },
128         {
129                 .name           = (char *) "cmdhelp",
130                 .has_arg        = optional_argument,
131                 .val            = 'c' | FIO_CLIENT_FLAG,
132         },
133         {
134                 .name           = (char *) "enghelp",
135                 .has_arg        = optional_argument,
136                 .val            = 'i' | FIO_CLIENT_FLAG,
137         },
138         {
139                 .name           = (char *) "showcmd",
140                 .has_arg        = no_argument,
141                 .val            = 's' | FIO_CLIENT_FLAG,
142         },
143         {
144                 .name           = (char *) "readonly",
145                 .has_arg        = no_argument,
146                 .val            = 'r' | FIO_CLIENT_FLAG,
147         },
148         {
149                 .name           = (char *) "eta",
150                 .has_arg        = required_argument,
151                 .val            = 'e' | FIO_CLIENT_FLAG,
152         },
153         {
154                 .name           = (char *) "eta-newline",
155                 .has_arg        = required_argument,
156                 .val            = 'E' | FIO_CLIENT_FLAG,
157         },
158         {
159                 .name           = (char *) "debug",
160                 .has_arg        = required_argument,
161                 .val            = 'd' | FIO_CLIENT_FLAG,
162         },
163         {
164                 .name           = (char *) "parse-only",
165                 .has_arg        = no_argument,
166                 .val            = 'P' | FIO_CLIENT_FLAG,
167         },
168         {
169                 .name           = (char *) "section",
170                 .has_arg        = required_argument,
171                 .val            = 'x' | FIO_CLIENT_FLAG,
172         },
173         {
174                 .name           = (char *) "alloc-size",
175                 .has_arg        = required_argument,
176                 .val            = 'a' | FIO_CLIENT_FLAG,
177         },
178         {
179                 .name           = (char *) "profile",
180                 .has_arg        = required_argument,
181                 .val            = 'p' | FIO_CLIENT_FLAG,
182         },
183         {
184                 .name           = (char *) "warnings-fatal",
185                 .has_arg        = no_argument,
186                 .val            = 'w' | FIO_CLIENT_FLAG,
187         },
188         {
189                 .name           = (char *) "max-jobs",
190                 .has_arg        = required_argument,
191                 .val            = 'j' | FIO_CLIENT_FLAG,
192         },
193         {
194                 .name           = (char *) "terse-version",
195                 .has_arg        = required_argument,
196                 .val            = 'V' | FIO_CLIENT_FLAG,
197         },
198         {
199                 .name           = (char *) "server",
200                 .has_arg        = optional_argument,
201                 .val            = 'S',
202         },
203         {       .name           = (char *) "daemonize",
204                 .has_arg        = required_argument,
205                 .val            = 'D',
206         },
207         {
208                 .name           = (char *) "client",
209                 .has_arg        = required_argument,
210                 .val            = 'C',
211         },
212         {
213                 .name           = (char *) "cpuclock-test",
214                 .has_arg        = no_argument,
215                 .val            = 'T',
216         },
217         {
218                 .name           = (char *) "crctest",
219                 .has_arg        = optional_argument,
220                 .val            = 'G',
221         },
222         {
223                 .name           = (char *) "idle-prof",
224                 .has_arg        = required_argument,
225                 .val            = 'I',
226         },
227         {
228                 .name           = (char *) "status-interval",
229                 .has_arg        = required_argument,
230                 .val            = 'L',
231         },
232         {
233                 .name           = NULL,
234         },
235 };
236
237 void free_threads_shm(void)
238 {
239         if (threads) {
240                 void *tp = threads;
241 #ifndef CONFIG_NO_SHM
242                 struct shmid_ds sbuf;
243
244                 threads = NULL;
245                 shmdt(tp);
246                 shmctl(shm_id, IPC_RMID, &sbuf);
247                 shm_id = -1;
248 #else
249                 threads = NULL;
250                 free(tp);
251 #endif
252         }
253 }
254
255 static void free_shm(void)
256 {
257         if (threads) {
258                 file_hash_exit();
259                 flow_exit();
260                 fio_debug_jobp = NULL;
261                 free_threads_shm();
262         }
263
264         options_free(fio_options, &def_thread);
265         fio_filelock_exit();
266         scleanup();
267 }
268
269 /*
270  * The thread area is shared between the main process and the job
271  * threads/processes. So setup a shared memory segment that will hold
272  * all the job info. We use the end of the region for keeping track of
273  * open files across jobs, for file sharing.
274  */
275 static int setup_thread_area(void)
276 {
277         void *hash;
278
279         if (threads)
280                 return 0;
281
282         /*
283          * 1024 is too much on some machines, scale max_jobs if
284          * we get a failure that looks like too large a shm segment
285          */
286         do {
287                 size_t size = max_jobs * sizeof(struct thread_data);
288
289                 size += file_hash_size;
290                 size += sizeof(unsigned int);
291
292 #ifndef CONFIG_NO_SHM
293                 shm_id = shmget(0, size, IPC_CREAT | 0600);
294                 if (shm_id != -1)
295                         break;
296                 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
297                         perror("shmget");
298                         break;
299                 }
300 #else
301                 threads = malloc(size);
302                 if (threads)
303                         break;
304 #endif
305
306                 max_jobs >>= 1;
307         } while (max_jobs);
308
309 #ifndef CONFIG_NO_SHM
310         if (shm_id == -1)
311                 return 1;
312
313         threads = shmat(shm_id, NULL, 0);
314         if (threads == (void *) -1) {
315                 perror("shmat");
316                 return 1;
317         }
318 #endif
319
320         memset(threads, 0, max_jobs * sizeof(struct thread_data));
321         hash = (void *) threads + max_jobs * sizeof(struct thread_data);
322         fio_debug_jobp = (void *) hash + file_hash_size;
323         *fio_debug_jobp = -1;
324         file_hash_init(hash);
325
326         flow_init();
327
328         return 0;
329 }
330
331 static void set_cmd_options(struct thread_data *td)
332 {
333         struct thread_options *o = &td->o;
334
335         if (!o->timeout)
336                 o->timeout = def_timeout;
337 }
338
339 /*
340  * Return a free job structure.
341  */
342 static struct thread_data *get_new_job(int global, struct thread_data *parent,
343                                        int preserve_eo, const char *jobname)
344 {
345         struct thread_data *td;
346
347         if (global) {
348                 set_cmd_options(&def_thread);
349                 return &def_thread;
350         }
351         if (setup_thread_area()) {
352                 log_err("error: failed to setup shm segment\n");
353                 return NULL;
354         }
355         if (thread_number >= max_jobs) {
356                 log_err("error: maximum number of jobs (%d) reached.\n",
357                                 max_jobs);
358                 return NULL;
359         }
360
361         td = &threads[thread_number++];
362         *td = *parent;
363
364         td->io_ops = NULL;
365         if (!preserve_eo)
366                 td->eo = NULL;
367
368         td->o.uid = td->o.gid = -1U;
369
370         dup_files(td, parent);
371         fio_options_mem_dupe(td);
372
373         profile_add_hooks(td);
374
375         td->thread_number = thread_number;
376
377         if (jobname)
378                 td->o.name = strdup(jobname);
379
380         if (!parent->o.group_reporting)
381                 stat_number++;
382
383         set_cmd_options(td);
384         return td;
385 }
386
387 static void put_job(struct thread_data *td)
388 {
389         if (td == &def_thread)
390                 return;
391
392         profile_td_exit(td);
393         flow_exit_job(td);
394
395         if (td->error)
396                 log_info("fio: %s\n", td->verror);
397
398         fio_options_free(td);
399         if (td->io_ops)
400                 free_ioengine(td);
401
402         if (td->o.name)
403                 free(td->o.name);
404
405         memset(&threads[td->thread_number - 1], 0, sizeof(*td));
406         thread_number--;
407 }
408
409 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
410 {
411         unsigned int bs = td->o.min_bs[ddir];
412
413         assert(ddir_rw(ddir));
414
415         if (td->o.rate[ddir])
416                 td->rate_bps[ddir] = td->o.rate[ddir];
417         else
418                 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
419
420         if (!td->rate_bps[ddir]) {
421                 log_err("rate lower than supported\n");
422                 return -1;
423         }
424
425         td->rate_pending_usleep[ddir] = 0;
426         return 0;
427 }
428
429 static int setup_rate(struct thread_data *td)
430 {
431         int ret = 0;
432
433         if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
434                 ret = __setup_rate(td, DDIR_READ);
435         if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
436                 ret |= __setup_rate(td, DDIR_WRITE);
437         if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
438                 ret |= __setup_rate(td, DDIR_TRIM);
439
440         return ret;
441 }
442
443 static int fixed_block_size(struct thread_options *o)
444 {
445         return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
446                 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
447                 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
448                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
449                 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
450 }
451
452
453 static unsigned long long get_rand_start_delay(struct thread_data *td)
454 {
455         unsigned long long delayrange;
456         unsigned long r;
457
458         delayrange = td->o.start_delay_high - td->o.start_delay;
459
460         if (td->o.use_os_rand) {
461                 r = os_random_long(&td->delay_state);
462                 delayrange = (unsigned long long) ((double) delayrange * (r / (OS_RAND_MAX + 1.0)));
463         } else {
464                 r = __rand(&td->__delay_state);
465                 delayrange = (unsigned long long) ((double) delayrange * (r / (FRAND_MAX + 1.0)));
466         }
467
468         delayrange += td->o.start_delay;
469         return delayrange;
470 }
471
472 /*
473  * Lazy way of fixing up options that depend on each other. We could also
474  * define option callback handlers, but this is easier.
475  */
476 static int fixup_options(struct thread_data *td)
477 {
478         struct thread_options *o = &td->o;
479         int ret = 0;
480
481 #ifndef FIO_HAVE_PSHARED_MUTEX
482         if (!o->use_thread) {
483                 log_info("fio: this platform does not support process shared"
484                          " mutexes, forcing use of threads. Use the 'thread'"
485                          " option to get rid of this warning.\n");
486                 o->use_thread = 1;
487                 ret = warnings_fatal;
488         }
489 #endif
490
491         if (o->write_iolog_file && o->read_iolog_file) {
492                 log_err("fio: read iolog overrides write_iolog\n");
493                 free(o->write_iolog_file);
494                 o->write_iolog_file = NULL;
495                 ret = warnings_fatal;
496         }
497
498         /*
499          * only really works with 1 file
500          */
501         if (o->zone_size && o->open_files > 1)
502                 o->zone_size = 0;
503
504         /*
505          * If zone_range isn't specified, backward compatibility dictates it
506          * should be made equal to zone_size.
507          */
508         if (o->zone_size && !o->zone_range)
509                 o->zone_range = o->zone_size;
510
511         /*
512          * Reads can do overwrites, we always need to pre-create the file
513          */
514         if (td_read(td) || td_rw(td))
515                 o->overwrite = 1;
516
517         if (!o->min_bs[DDIR_READ])
518                 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
519         if (!o->max_bs[DDIR_READ])
520                 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
521         if (!o->min_bs[DDIR_WRITE])
522                 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
523         if (!o->max_bs[DDIR_WRITE])
524                 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
525         if (!o->min_bs[DDIR_TRIM])
526                 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
527         if (!o->max_bs[DDIR_TRIM])
528                 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
529
530
531         o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
532         o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
533
534         /*
535          * For random IO, allow blockalign offset other than min_bs.
536          */
537         if (!o->ba[DDIR_READ] || !td_random(td))
538                 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
539         if (!o->ba[DDIR_WRITE] || !td_random(td))
540                 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
541         if (!o->ba[DDIR_TRIM] || !td_random(td))
542                 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
543
544         if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
545             o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
546             o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
547             !o->norandommap) {
548                 log_err("fio: Any use of blockalign= turns off randommap\n");
549                 o->norandommap = 1;
550                 ret = warnings_fatal;
551         }
552
553         if (!o->file_size_high)
554                 o->file_size_high = o->file_size_low;
555
556         if (o->start_delay_high)
557                 o->start_delay = get_rand_start_delay(td);
558
559         if (o->norandommap && o->verify != VERIFY_NONE
560             && !fixed_block_size(o))  {
561                 log_err("fio: norandommap given for variable block sizes, "
562                         "verify disabled\n");
563                 o->verify = VERIFY_NONE;
564                 ret = warnings_fatal;
565         }
566         if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
567                 log_err("fio: bs_unaligned may not work with raw io\n");
568
569         /*
570          * thinktime_spin must be less than thinktime
571          */
572         if (o->thinktime_spin > o->thinktime)
573                 o->thinktime_spin = o->thinktime;
574
575         /*
576          * The low water mark cannot be bigger than the iodepth
577          */
578         if (o->iodepth_low > o->iodepth || !o->iodepth_low)
579                 o->iodepth_low = o->iodepth;
580
581         /*
582          * If batch number isn't set, default to the same as iodepth
583          */
584         if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
585                 o->iodepth_batch = o->iodepth;
586
587         if (o->nr_files > td->files_index)
588                 o->nr_files = td->files_index;
589
590         if (o->open_files > o->nr_files || !o->open_files)
591                 o->open_files = o->nr_files;
592
593         if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
594             (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
595             ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
596             (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
597                 log_err("fio: rate and rate_iops are mutually exclusive\n");
598                 ret = 1;
599         }
600         if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
601             (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
602             (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
603             (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
604             (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
605             (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
606                 log_err("fio: minimum rate exceeds rate\n");
607                 ret = 1;
608         }
609
610         if (!o->timeout && o->time_based) {
611                 log_err("fio: time_based requires a runtime/timeout setting\n");
612                 o->time_based = 0;
613                 ret = warnings_fatal;
614         }
615
616         if (o->fill_device && !o->size)
617                 o->size = -1ULL;
618
619         if (o->verify != VERIFY_NONE) {
620                 if (td_write(td) && o->do_verify && o->numjobs > 1) {
621                         log_info("Multiple writers may overwrite blocks that "
622                                 "belong to other jobs. This can cause "
623                                 "verification failures.\n");
624                         ret = warnings_fatal;
625                 }
626
627                 o->refill_buffers = 1;
628                 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
629                     !o->verify_interval)
630                         o->verify_interval = o->min_bs[DDIR_WRITE];
631         }
632
633         if (o->pre_read) {
634                 o->invalidate_cache = 0;
635                 if (td->io_ops->flags & FIO_PIPEIO) {
636                         log_info("fio: cannot pre-read files with an IO engine"
637                                  " that isn't seekable. Pre-read disabled.\n");
638                         ret = warnings_fatal;
639                 }
640         }
641
642         if (!o->unit_base) {
643                 if (td->io_ops->flags & FIO_BIT_BASED)
644                         o->unit_base = 1;
645                 else
646                         o->unit_base = 8;
647         }
648
649 #ifndef CONFIG_FDATASYNC
650         if (o->fdatasync_blocks) {
651                 log_info("fio: this platform does not support fdatasync()"
652                          " falling back to using fsync().  Use the 'fsync'"
653                          " option instead of 'fdatasync' to get rid of"
654                          " this warning\n");
655                 o->fsync_blocks = o->fdatasync_blocks;
656                 o->fdatasync_blocks = 0;
657                 ret = warnings_fatal;
658         }
659 #endif
660
661 #ifdef WIN32
662         /*
663          * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
664          * so fail if we're passed those flags
665          */
666         if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
667                 log_err("fio: Windows does not support direct or non-buffered io with"
668                                 " the synchronous ioengines. Use the 'windowsaio' ioengine"
669                                 " with 'direct=1' and 'iodepth=1' instead.\n");
670                 ret = 1;
671         }
672 #endif
673
674         /*
675          * For fully compressible data, just zero them at init time.
676          * It's faster than repeatedly filling it.
677          */
678         if (td->o.compress_percentage == 100) {
679                 td->o.zero_buffers = 1;
680                 td->o.compress_percentage = 0;
681         }
682
683         /*
684          * Using a non-uniform random distribution excludes usage of
685          * a random map
686          */
687         if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
688                 td->o.norandommap = 1;
689
690         /*
691          * If size is set but less than the min block size, complain
692          */
693         if (o->size && o->size < td_min_bs(td)) {
694                 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
695                 ret = 1;
696         }
697
698         /*
699          * O_ATOMIC implies O_DIRECT
700          */
701         if (td->o.oatomic)
702                 td->o.odirect = 1;
703
704         /*
705          * If randseed is set, that overrides randrepeat
706          */
707         if (td->o.rand_seed)
708                 td->o.rand_repeatable = 0;
709
710         if ((td->io_ops->flags & FIO_NOEXTEND) && td->o.file_append) {
711                 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
712                 ret = 1;
713         }
714
715         return ret;
716 }
717
718 /*
719  * This function leaks the buffer
720  */
721 char *fio_uint_to_kmg(unsigned int val)
722 {
723         char *buf = malloc(32);
724         char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
725         char *p = post;
726
727         do {
728                 if (val & 1023)
729                         break;
730
731                 val >>= 10;
732                 p++;
733         } while (*p);
734
735         snprintf(buf, 32, "%u%c", val, *p);
736         return buf;
737 }
738
739 /* External engines are specified by "external:name.o") */
740 static const char *get_engine_name(const char *str)
741 {
742         char *p = strstr(str, ":");
743
744         if (!p)
745                 return str;
746
747         p++;
748         strip_blank_front(&p);
749         strip_blank_end(p);
750         return p;
751 }
752
753 static int exists_and_not_file(const char *filename)
754 {
755         struct stat sb;
756
757         if (lstat(filename, &sb) == -1)
758                 return 0;
759
760         /* \\.\ is the device namespace in Windows, where every file
761          * is a device node */
762         if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
763                 return 0;
764
765         return 1;
766 }
767
768 static void td_fill_rand_seeds_os(struct thread_data *td)
769 {
770         os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
771         os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
772         os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
773
774         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
775                 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
776
777         os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
778         os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
779         os_random_seed(td->rand_seeds[FIO_RAND_START_DELAY], &td->delay_state);
780
781         if (!td_random(td))
782                 return;
783
784         if (td->o.rand_repeatable)
785                 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
786
787         os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
788
789         os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], &td->seq_rand_state[DDIR_READ]);
790         os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF], &td->seq_rand_state[DDIR_WRITE]);
791         os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF], &td->seq_rand_state[DDIR_TRIM]);
792 }
793
794 static void td_fill_rand_seeds_internal(struct thread_data *td)
795 {
796         init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
797         init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
798         init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
799
800         if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
801                 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
802
803         init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
804         init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
805         init_rand_seed(&td->__delay_state, td->rand_seeds[FIO_RAND_START_DELAY]);
806
807         if (!td_random(td))
808                 return;
809
810         if (td->o.rand_repeatable)
811                 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
812
813         init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
814         init_rand_seed(&td->__seq_rand_state[DDIR_READ], td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF]);
815         init_rand_seed(&td->__seq_rand_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF]);
816         init_rand_seed(&td->__seq_rand_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF]);
817 }
818
819 void td_fill_rand_seeds(struct thread_data *td)
820 {
821         if (td->o.allrand_repeatable) {
822                 for (int i = 0; i < FIO_RAND_NR_OFFS; i++)
823                         td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
824                                 + i;
825         }
826
827         if (td->o.use_os_rand)
828                 td_fill_rand_seeds_os(td);
829         else
830                 td_fill_rand_seeds_internal(td);
831
832         init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
833 }
834
835 /*
836  * Initializes the ioengine configured for a job, if it has not been done so
837  * already.
838  */
839 int ioengine_load(struct thread_data *td)
840 {
841         const char *engine;
842
843         /*
844          * Engine has already been loaded.
845          */
846         if (td->io_ops)
847                 return 0;
848         if (!td->o.ioengine) {
849                 log_err("fio: internal fault, no IO engine specified\n");
850                 return 1;
851         }
852
853         engine = get_engine_name(td->o.ioengine);
854         td->io_ops = load_ioengine(td, engine);
855         if (!td->io_ops) {
856                 log_err("fio: failed to load engine %s\n", engine);
857                 return 1;
858         }
859
860         if (td->io_ops->option_struct_size && td->io_ops->options) {
861                 /*
862                  * In cases where td->eo is set, clone it for a child thread.
863                  * This requires that the parent thread has the same ioengine,
864                  * but that requirement must be enforced by the code which
865                  * cloned the thread.
866                  */
867                 void *origeo = td->eo;
868                 /*
869                  * Otherwise use the default thread options.
870                  */
871                 if (!origeo && td != &def_thread && def_thread.eo &&
872                     def_thread.io_ops->options == td->io_ops->options)
873                         origeo = def_thread.eo;
874
875                 options_init(td->io_ops->options);
876                 td->eo = malloc(td->io_ops->option_struct_size);
877                 /*
878                  * Use the default thread as an option template if this uses the
879                  * same options structure and there are non-default options
880                  * used.
881                  */
882                 if (origeo) {
883                         memcpy(td->eo, origeo, td->io_ops->option_struct_size);
884                         options_mem_dupe(td->eo, td->io_ops->options);
885                 } else {
886                         memset(td->eo, 0, td->io_ops->option_struct_size);
887                         fill_default_options(td->eo, td->io_ops->options);
888                 }
889                 *(struct thread_data **)td->eo = td;
890         }
891
892         return 0;
893 }
894
895 static void init_flags(struct thread_data *td)
896 {
897         struct thread_options *o = &td->o;
898
899         if (o->verify_backlog)
900                 td->flags |= TD_F_VER_BACKLOG;
901         if (o->trim_backlog)
902                 td->flags |= TD_F_TRIM_BACKLOG;
903         if (o->read_iolog_file)
904                 td->flags |= TD_F_READ_IOLOG;
905         if (o->refill_buffers)
906                 td->flags |= TD_F_REFILL_BUFFERS;
907         if (o->scramble_buffers)
908                 td->flags |= TD_F_SCRAMBLE_BUFFERS;
909         if (o->verify != VERIFY_NONE)
910                 td->flags |= TD_F_VER_NONE;
911 }
912
913 static int setup_random_seeds(struct thread_data *td)
914 {
915         unsigned long seed;
916         unsigned int i;
917
918         if (!td->o.rand_repeatable && !td->o.rand_seed)
919                 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
920
921         if (!td->o.rand_seed)
922                 seed = 0x89;
923         else
924                 seed = td->o.rand_seed;
925
926         for (i = 0; i < 4; i++)
927                 seed *= 0x9e370001UL;
928
929         for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
930                 td->rand_seeds[i] = seed;
931                 seed *= 0x9e370001UL;
932         }
933
934         td_fill_rand_seeds(td);
935         return 0;
936 }
937
938 enum {
939         FPRE_NONE = 0,
940         FPRE_JOBNAME,
941         FPRE_JOBNUM,
942         FPRE_FILENUM
943 };
944
945 static struct fpre_keyword {
946         const char *keyword;
947         size_t strlen;
948         int key;
949 } fpre_keywords[] = {
950         { .keyword = "$jobname",        .key = FPRE_JOBNAME, },
951         { .keyword = "$jobnum",         .key = FPRE_JOBNUM, },
952         { .keyword = "$filenum",        .key = FPRE_FILENUM, },
953         { .keyword = NULL, },
954         };
955
956 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
957                            const char *jobname, int jobnum, int filenum)
958 {
959         struct fpre_keyword *f;
960         char copy[PATH_MAX];
961         size_t dst_left = PATH_MAX - 1;
962
963         if (!o->filename_format || !strlen(o->filename_format)) {
964                 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
965                 return NULL;
966         }
967
968         for (f = &fpre_keywords[0]; f->keyword; f++)
969                 f->strlen = strlen(f->keyword);
970
971         buf[buf_size - 1] = '\0';
972         strncpy(buf, o->filename_format, buf_size - 1);
973
974         memset(copy, 0, sizeof(copy));
975         for (f = &fpre_keywords[0]; f->keyword; f++) {
976                 do {
977                         size_t pre_len, post_start = 0;
978                         char *str, *dst = copy;
979
980                         str = strcasestr(buf, f->keyword);
981                         if (!str)
982                                 break;
983
984                         pre_len = str - buf;
985                         if (strlen(str) != f->strlen)
986                                 post_start = pre_len + f->strlen;
987
988                         if (pre_len) {
989                                 strncpy(dst, buf, pre_len);
990                                 dst += pre_len;
991                                 dst_left -= pre_len;
992                         }
993
994                         switch (f->key) {
995                         case FPRE_JOBNAME: {
996                                 int ret;
997
998                                 ret = snprintf(dst, dst_left, "%s", jobname);
999                                 if (ret < 0)
1000                                         break;
1001                                 dst += ret;
1002                                 dst_left -= ret;
1003                                 break;
1004                                 }
1005                         case FPRE_JOBNUM: {
1006                                 int ret;
1007
1008                                 ret = snprintf(dst, dst_left, "%d", jobnum);
1009                                 if (ret < 0)
1010                                         break;
1011                                 dst += ret;
1012                                 dst_left -= ret;
1013                                 break;
1014                                 }
1015                         case FPRE_FILENUM: {
1016                                 int ret;
1017
1018                                 ret = snprintf(dst, dst_left, "%d", filenum);
1019                                 if (ret < 0)
1020                                         break;
1021                                 dst += ret;
1022                                 dst_left -= ret;
1023                                 break;
1024                                 }
1025                         default:
1026                                 assert(0);
1027                                 break;
1028                         }
1029
1030                         if (post_start)
1031                                 strncpy(dst, buf + post_start, dst_left);
1032
1033                         strncpy(buf, copy, buf_size - 1);
1034                 } while (1);
1035         }
1036
1037         return buf;
1038 }
1039
1040 int parse_dryrun(void)
1041 {
1042         return dump_cmdline || parse_only;
1043 }
1044
1045 /*
1046  * Adds a job to the list of things todo. Sanitizes the various options
1047  * to make sure we don't have conflicts, and initializes various
1048  * members of td.
1049  */
1050 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1051                    int recursed, int client_type)
1052 {
1053         unsigned int i;
1054         char fname[PATH_MAX];
1055         int numjobs, file_alloced;
1056         struct thread_options *o = &td->o;
1057         char logname[PATH_MAX + 32];
1058
1059         /*
1060          * the def_thread is just for options, it's not a real job
1061          */
1062         if (td == &def_thread)
1063                 return 0;
1064
1065         init_flags(td);
1066
1067         /*
1068          * if we are just dumping the output command line, don't add the job
1069          */
1070         if (parse_dryrun()) {
1071                 put_job(td);
1072                 return 0;
1073         }
1074
1075         td->client_type = client_type;
1076
1077         if (profile_td_init(td))
1078                 goto err;
1079
1080         if (ioengine_load(td))
1081                 goto err;
1082
1083         if (o->odirect)
1084                 td->io_ops->flags |= FIO_RAWIO;
1085
1086         file_alloced = 0;
1087         if (!o->filename && !td->files_index && !o->read_iolog_file) {
1088                 file_alloced = 1;
1089
1090                 if (o->nr_files == 1 && exists_and_not_file(jobname))
1091                         add_file(td, jobname, job_add_num, 0);
1092                 else {
1093                         for (i = 0; i < o->nr_files; i++)
1094                                 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1095                 }
1096         }
1097
1098         if (fixup_options(td))
1099                 goto err;
1100
1101         flow_init_job(td);
1102
1103         /*
1104          * IO engines only need this for option callbacks, and the address may
1105          * change in subprocesses.
1106          */
1107         if (td->eo)
1108                 *(struct thread_data **)td->eo = NULL;
1109
1110         if (td->io_ops->flags & FIO_DISKLESSIO) {
1111                 struct fio_file *f;
1112
1113                 for_each_file(td, f, i)
1114                         f->real_file_size = -1ULL;
1115         }
1116
1117         td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1118
1119         td->ts.clat_percentiles = o->clat_percentiles;
1120         td->ts.percentile_precision = o->percentile_precision;
1121         memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1122
1123         for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1124                 td->ts.clat_stat[i].min_val = ULONG_MAX;
1125                 td->ts.slat_stat[i].min_val = ULONG_MAX;
1126                 td->ts.lat_stat[i].min_val = ULONG_MAX;
1127                 td->ts.bw_stat[i].min_val = ULONG_MAX;
1128         }
1129         td->ddir_seq_nr = o->ddir_seq_nr;
1130
1131         if ((o->stonewall || o->new_group) && prev_group_jobs) {
1132                 prev_group_jobs = 0;
1133                 groupid++;
1134         }
1135
1136         td->groupid = groupid;
1137         prev_group_jobs++;
1138
1139         if (setup_random_seeds(td)) {
1140                 td_verror(td, errno, "init_random_state");
1141                 goto err;
1142         }
1143
1144         if (setup_rate(td))
1145                 goto err;
1146
1147         if (o->lat_log_file) {
1148                 snprintf(logname, sizeof(logname), "%s_lat.log", o->lat_log_file);
1149                 setup_log(&td->lat_log, o->log_avg_msec, IO_LOG_TYPE_LAT,
1150                                 o->log_offset, logname);
1151                 snprintf(logname, sizeof(logname), "%s_slat.log", o->lat_log_file);
1152                 setup_log(&td->slat_log, o->log_avg_msec, IO_LOG_TYPE_SLAT,
1153                                 o->log_offset, logname);
1154                 snprintf(logname, sizeof(logname), "%s_clat.log", o->lat_log_file);
1155                 setup_log(&td->clat_log, o->log_avg_msec, IO_LOG_TYPE_CLAT,
1156                                 o->log_offset, logname);
1157         }
1158         if (o->bw_log_file) {
1159                 snprintf(logname, sizeof(logname), "%s_bw.log", o->bw_log_file);
1160                 setup_log(&td->bw_log, o->log_avg_msec, IO_LOG_TYPE_BW,
1161                                 o->log_offset, logname);
1162         }
1163         if (o->iops_log_file) {
1164                 snprintf(logname, sizeof(logname), "%s_iops.log", o->iops_log_file);
1165                 setup_log(&td->iops_log, o->log_avg_msec, IO_LOG_TYPE_IOPS,
1166                                 o->log_offset, logname);
1167         }
1168
1169         if (!o->name)
1170                 o->name = strdup(jobname);
1171
1172         if (output_format == FIO_OUTPUT_NORMAL) {
1173                 if (!job_add_num) {
1174                         if (is_backend && !recursed)
1175                                 fio_server_send_add_job(td);
1176
1177                         if (!(td->io_ops->flags & FIO_NOIO)) {
1178                                 char *c1, *c2, *c3, *c4;
1179                                 char *c5 = NULL, *c6 = NULL;
1180
1181                                 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1182                                 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1183                                 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1184                                 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1185
1186                                 if (!o->bs_is_seq_rand) {
1187                                         c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1188                                         c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1189                                 }
1190
1191                                 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1192                                                         td->groupid,
1193                                                         ddir_str(o->td_ddir));
1194
1195                                 if (o->bs_is_seq_rand)
1196                                         log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1197                                                         c1, c2, c3, c4);
1198                                 else
1199                                         log_info("bs=%s-%s/%s-%s/%s-%s, ",
1200                                                         c1, c2, c3, c4, c5, c6);
1201
1202                                 log_info("ioengine=%s, iodepth=%u\n",
1203                                                 td->io_ops->name, o->iodepth);
1204
1205                                 free(c1);
1206                                 free(c2);
1207                                 free(c3);
1208                                 free(c4);
1209                                 free(c5);
1210                                 free(c6);
1211                         }
1212                 } else if (job_add_num == 1)
1213                         log_info("...\n");
1214         }
1215
1216         /*
1217          * recurse add identical jobs, clear numjobs and stonewall options
1218          * as they don't apply to sub-jobs
1219          */
1220         numjobs = o->numjobs;
1221         while (--numjobs) {
1222                 struct thread_data *td_new = get_new_job(0, td, 1, jobname);
1223
1224                 if (!td_new)
1225                         goto err;
1226
1227                 td_new->o.numjobs = 1;
1228                 td_new->o.stonewall = 0;
1229                 td_new->o.new_group = 0;
1230
1231                 if (file_alloced) {
1232                         if (td_new->files) {
1233                                 struct fio_file *f;
1234                                 for_each_file(td_new, f, i) {
1235                                         if (f->file_name)
1236                                                 sfree(f->file_name);
1237                                         sfree(f);
1238                                 }
1239                                 free(td_new->files);
1240                                 td_new->files = NULL;
1241                         }
1242                         td_new->files_index = 0;
1243                         td_new->files_size = 0;
1244                         if (td_new->o.filename) {
1245                                 free(td_new->o.filename);
1246                                 td_new->o.filename = NULL;
1247                         }
1248                 }
1249
1250                 if (add_job(td_new, jobname, numjobs, 1, client_type))
1251                         goto err;
1252         }
1253
1254         return 0;
1255 err:
1256         put_job(td);
1257         return -1;
1258 }
1259
1260 /*
1261  * Parse as if 'o' was a command line
1262  */
1263 void add_job_opts(const char **o, int client_type)
1264 {
1265         struct thread_data *td, *td_parent;
1266         int i, in_global = 1;
1267         char jobname[32];
1268
1269         i = 0;
1270         td_parent = td = NULL;
1271         while (o[i]) {
1272                 if (!strncmp(o[i], "name", 4)) {
1273                         in_global = 0;
1274                         if (td)
1275                                 add_job(td, jobname, 0, 0, client_type);
1276                         td = NULL;
1277                         sprintf(jobname, "%s", o[i] + 5);
1278                 }
1279                 if (in_global && !td_parent)
1280                         td_parent = get_new_job(1, &def_thread, 0, jobname);
1281                 else if (!in_global && !td) {
1282                         if (!td_parent)
1283                                 td_parent = &def_thread;
1284                         td = get_new_job(0, td_parent, 0, jobname);
1285                 }
1286                 if (in_global)
1287                         fio_options_parse(td_parent, (char **) &o[i], 1, 0);
1288                 else
1289                         fio_options_parse(td, (char **) &o[i], 1, 0);
1290                 i++;
1291         }
1292
1293         if (td)
1294                 add_job(td, jobname, 0, 0, client_type);
1295 }
1296
1297 static int skip_this_section(const char *name)
1298 {
1299         int i;
1300
1301         if (!nr_job_sections)
1302                 return 0;
1303         if (!strncmp(name, "global", 6))
1304                 return 0;
1305
1306         for (i = 0; i < nr_job_sections; i++)
1307                 if (!strcmp(job_sections[i], name))
1308                         return 0;
1309
1310         return 1;
1311 }
1312
1313 static int is_empty_or_comment(char *line)
1314 {
1315         unsigned int i;
1316
1317         for (i = 0; i < strlen(line); i++) {
1318                 if (line[i] == ';')
1319                         return 1;
1320                 if (line[i] == '#')
1321                         return 1;
1322                 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1323                         return 0;
1324         }
1325
1326         return 1;
1327 }
1328
1329 /*
1330  * This is our [ini] type file parser.
1331  */
1332 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1333 {
1334         unsigned int global;
1335         struct thread_data *td;
1336         char *string, *name;
1337         FILE *f;
1338         char *p;
1339         int ret = 0, stonewall;
1340         int first_sect = 1;
1341         int skip_fgets = 0;
1342         int inside_skip = 0;
1343         char **opts;
1344         int i, alloc_opts, num_opts;
1345
1346         if (is_buf)
1347                 f = NULL;
1348         else {
1349                 if (!strcmp(file, "-"))
1350                         f = stdin;
1351                 else
1352                         f = fopen(file, "r");
1353
1354                 if (!f) {
1355                         perror("fopen job file");
1356                         return 1;
1357                 }
1358         }
1359
1360         string = malloc(4096);
1361
1362         /*
1363          * it's really 256 + small bit, 280 should suffice
1364          */
1365         name = malloc(280);
1366         memset(name, 0, 280);
1367
1368         alloc_opts = 8;
1369         opts = malloc(sizeof(char *) * alloc_opts);
1370         num_opts = 0;
1371
1372         stonewall = stonewall_flag;
1373         do {
1374                 /*
1375                  * if skip_fgets is set, we already have loaded a line we
1376                  * haven't handled.
1377                  */
1378                 if (!skip_fgets) {
1379                         if (is_buf)
1380                                 p = strsep(&file, "\n");
1381                         else
1382                                 p = fgets(string, 4096, f);
1383                         if (!p)
1384                                 break;
1385                 }
1386
1387                 skip_fgets = 0;
1388                 strip_blank_front(&p);
1389                 strip_blank_end(p);
1390
1391                 if (is_empty_or_comment(p))
1392                         continue;
1393                 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1394                         if (inside_skip)
1395                                 continue;
1396                         log_err("fio: option <%s> outside of [] job section\n",
1397                                                                         p);
1398                         break;
1399                 }
1400
1401                 name[strlen(name) - 1] = '\0';
1402
1403                 if (skip_this_section(name)) {
1404                         inside_skip = 1;
1405                         continue;
1406                 } else
1407                         inside_skip = 0;
1408
1409                 global = !strncmp(name, "global", 6);
1410
1411                 if (dump_cmdline) {
1412                         if (first_sect)
1413                                 log_info("fio ");
1414                         if (!global)
1415                                 log_info("--name=%s ", name);
1416                         first_sect = 0;
1417                 }
1418
1419                 td = get_new_job(global, &def_thread, 0, name);
1420                 if (!td) {
1421                         ret = 1;
1422                         break;
1423                 }
1424
1425                 /*
1426                  * Separate multiple job files by a stonewall
1427                  */
1428                 if (!global && stonewall) {
1429                         td->o.stonewall = stonewall;
1430                         stonewall = 0;
1431                 }
1432
1433                 num_opts = 0;
1434                 memset(opts, 0, alloc_opts * sizeof(char *));
1435
1436                 while (1) {
1437                         if (is_buf)
1438                                 p = strsep(&file, "\n");
1439                         else
1440                                 p = fgets(string, 4096, f);
1441                         if (!p)
1442                                 break;
1443
1444                         if (is_empty_or_comment(p))
1445                                 continue;
1446
1447                         strip_blank_front(&p);
1448
1449                         /*
1450                          * new section, break out and make sure we don't
1451                          * fgets() a new line at the top.
1452                          */
1453                         if (p[0] == '[') {
1454                                 skip_fgets = 1;
1455                                 break;
1456                         }
1457
1458                         strip_blank_end(p);
1459
1460                         if (num_opts == alloc_opts) {
1461                                 alloc_opts <<= 1;
1462                                 opts = realloc(opts,
1463                                                 alloc_opts * sizeof(char *));
1464                         }
1465
1466                         opts[num_opts] = strdup(p);
1467                         num_opts++;
1468                 }
1469
1470                 ret = fio_options_parse(td, opts, num_opts, dump_cmdline);
1471                 if (!ret)
1472                         ret = add_job(td, name, 0, 0, type);
1473                 else {
1474                         log_err("fio: job %s dropped\n", name);
1475                         put_job(td);
1476                 }
1477
1478                 for (i = 0; i < num_opts; i++)
1479                         free(opts[i]);
1480                 num_opts = 0;
1481         } while (!ret);
1482
1483         if (dump_cmdline)
1484                 log_info("\n");
1485
1486         i = 0;
1487         while (i < nr_job_sections) {
1488                 free(job_sections[i]);
1489                 i++;
1490         }
1491
1492         free(string);
1493         free(name);
1494         free(opts);
1495         if (!is_buf && f != stdin)
1496                 fclose(f);
1497         return ret;
1498 }
1499
1500 static int fill_def_thread(void)
1501 {
1502         memset(&def_thread, 0, sizeof(def_thread));
1503
1504         fio_getaffinity(getpid(), &def_thread.o.cpumask);
1505         def_thread.o.error_dump = 1;
1506
1507         /*
1508          * fill default options
1509          */
1510         fio_fill_default_options(&def_thread);
1511         return 0;
1512 }
1513
1514 static void usage(const char *name)
1515 {
1516         printf("%s\n", fio_version_string);
1517         printf("%s [options] [job options] <job file(s)>\n", name);
1518         printf("  --debug=options\tEnable debug logging. May be one/more of:\n"
1519                 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1520                 "\t\t\tdiskutil,job,mutex,profile,time,net,rate\n");
1521         printf("  --parse-only\t\tParse options only, don't start any IO\n");
1522         printf("  --output\t\tWrite output to file\n");
1523         printf("  --runtime\t\tRuntime in seconds\n");
1524         printf("  --bandwidth-log\tGenerate per-job bandwidth logs\n");
1525         printf("  --minimal\t\tMinimal (terse) output\n");
1526         printf("  --output-format=x\tOutput format (terse,json,normal)\n");
1527         printf("  --terse-version=x\tSet terse version output format to 'x'\n");
1528         printf("  --version\t\tPrint version info and exit\n");
1529         printf("  --help\t\tPrint this page\n");
1530         printf("  --cpuclock-test\tPerform test/validation of CPU clock\n");
1531         printf("  --crctest\t\tTest speed of checksum functions\n");
1532         printf("  --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1533                 " them\n");
1534         printf("  --enghelp=engine\tPrint ioengine help, or list"
1535                 " available ioengines\n");
1536         printf("  --enghelp=engine,cmd\tPrint help for an ioengine"
1537                 " cmd\n");
1538         printf("  --showcmd\t\tTurn a job file into command line options\n");
1539         printf("  --eta=when\t\tWhen ETA estimate should be printed\n");
1540         printf("            \t\tMay be \"always\", \"never\" or \"auto\"\n");
1541         printf("  --eta-newline=time\tForce a new line for every 'time'");
1542         printf(" period passed\n");
1543         printf("  --status-interval=t\tForce full status dump every");
1544         printf(" 't' period passed\n");
1545         printf("  --readonly\t\tTurn on safety read-only checks, preventing"
1546                 " writes\n");
1547         printf("  --section=name\tOnly run specified section in job file\n");
1548         printf("  --alloc-size=kb\tSet smalloc pool to this size in kb"
1549                 " (def 1024)\n");
1550         printf("  --warnings-fatal\tFio parser warnings are fatal\n");
1551         printf("  --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1552         printf("  --server=args\t\tStart a backend fio server\n");
1553         printf("  --daemonize=pidfile\tBackground fio server, write pid to file\n");
1554         printf("  --client=hostname\tTalk to remote backend fio server at hostname\n");
1555         printf("  --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1556                 "\t\t\t(option=system,percpu) or run unit work\n"
1557                 "\t\t\tcalibration only (option=calibrate)\n");
1558         printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1559         printf("\n                   Jens Axboe <jaxboe@fusionio.com>");
1560         printf("\n                   Jens Axboe <axboe@fb.com>\n");
1561 }
1562
1563 #ifdef FIO_INC_DEBUG
1564 struct debug_level debug_levels[] = {
1565         { .name = "process",
1566           .help = "Process creation/exit logging",
1567           .shift = FD_PROCESS,
1568         },
1569         { .name = "file",
1570           .help = "File related action logging",
1571           .shift = FD_FILE,
1572         },
1573         { .name = "io",
1574           .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1575           .shift = FD_IO,
1576         },
1577         { .name = "mem",
1578           .help = "Memory allocation/freeing logging",
1579           .shift = FD_MEM,
1580         },
1581         { .name = "blktrace",
1582           .help = "blktrace action logging",
1583           .shift = FD_BLKTRACE,
1584         },
1585         { .name = "verify",
1586           .help = "IO verification action logging",
1587           .shift = FD_VERIFY,
1588         },
1589         { .name = "random",
1590           .help = "Random generation logging",
1591           .shift = FD_RANDOM,
1592         },
1593         { .name = "parse",
1594           .help = "Parser logging",
1595           .shift = FD_PARSE,
1596         },
1597         { .name = "diskutil",
1598           .help = "Disk utility logging actions",
1599           .shift = FD_DISKUTIL,
1600         },
1601         { .name = "job",
1602           .help = "Logging related to creating/destroying jobs",
1603           .shift = FD_JOB,
1604         },
1605         { .name = "mutex",
1606           .help = "Mutex logging",
1607           .shift = FD_MUTEX
1608         },
1609         { .name = "profile",
1610           .help = "Logging related to profiles",
1611           .shift = FD_PROFILE,
1612         },
1613         { .name = "time",
1614           .help = "Logging related to time keeping functions",
1615           .shift = FD_TIME,
1616         },
1617         { .name = "net",
1618           .help = "Network logging",
1619           .shift = FD_NET,
1620         },
1621         { .name = "rate",
1622           .help = "Rate logging",
1623           .shift = FD_RATE,
1624         },
1625         { .name = NULL, },
1626 };
1627
1628 static int set_debug(const char *string)
1629 {
1630         struct debug_level *dl;
1631         char *p = (char *) string;
1632         char *opt;
1633         int i;
1634
1635         if (!strcmp(string, "?") || !strcmp(string, "help")) {
1636                 log_info("fio: dumping debug options:");
1637                 for (i = 0; debug_levels[i].name; i++) {
1638                         dl = &debug_levels[i];
1639                         log_info("%s,", dl->name);
1640                 }
1641                 log_info("all\n");
1642                 return 1;
1643         }
1644
1645         while ((opt = strsep(&p, ",")) != NULL) {
1646                 int found = 0;
1647
1648                 if (!strncmp(opt, "all", 3)) {
1649                         log_info("fio: set all debug options\n");
1650                         fio_debug = ~0UL;
1651                         continue;
1652                 }
1653
1654                 for (i = 0; debug_levels[i].name; i++) {
1655                         dl = &debug_levels[i];
1656                         found = !strncmp(opt, dl->name, strlen(dl->name));
1657                         if (!found)
1658                                 continue;
1659
1660                         if (dl->shift == FD_JOB) {
1661                                 opt = strchr(opt, ':');
1662                                 if (!opt) {
1663                                         log_err("fio: missing job number\n");
1664                                         break;
1665                                 }
1666                                 opt++;
1667                                 fio_debug_jobno = atoi(opt);
1668                                 log_info("fio: set debug jobno %d\n",
1669                                                         fio_debug_jobno);
1670                         } else {
1671                                 log_info("fio: set debug option %s\n", opt);
1672                                 fio_debug |= (1UL << dl->shift);
1673                         }
1674                         break;
1675                 }
1676
1677                 if (!found)
1678                         log_err("fio: debug mask %s not found\n", opt);
1679         }
1680         return 0;
1681 }
1682 #else
1683 static int set_debug(const char *string)
1684 {
1685         log_err("fio: debug tracing not included in build\n");
1686         return 1;
1687 }
1688 #endif
1689
1690 static void fio_options_fill_optstring(void)
1691 {
1692         char *ostr = cmd_optstr;
1693         int i, c;
1694
1695         c = i = 0;
1696         while (l_opts[i].name) {
1697                 ostr[c++] = l_opts[i].val;
1698                 if (l_opts[i].has_arg == required_argument)
1699                         ostr[c++] = ':';
1700                 else if (l_opts[i].has_arg == optional_argument) {
1701                         ostr[c++] = ':';
1702                         ostr[c++] = ':';
1703                 }
1704                 i++;
1705         }
1706         ostr[c] = '\0';
1707 }
1708
1709 static int client_flag_set(char c)
1710 {
1711         int i;
1712
1713         i = 0;
1714         while (l_opts[i].name) {
1715                 int val = l_opts[i].val;
1716
1717                 if (c == (val & 0xff))
1718                         return (val & FIO_CLIENT_FLAG);
1719
1720                 i++;
1721         }
1722
1723         return 0;
1724 }
1725
1726 static void parse_cmd_client(void *client, char *opt)
1727 {
1728         fio_client_add_cmd_option(client, opt);
1729 }
1730
1731 int parse_cmd_line(int argc, char *argv[], int client_type)
1732 {
1733         struct thread_data *td = NULL;
1734         int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1735         char *ostr = cmd_optstr;
1736         void *pid_file = NULL;
1737         void *cur_client = NULL;
1738         int backend = 0;
1739
1740         /*
1741          * Reset optind handling, since we may call this multiple times
1742          * for the backend.
1743          */
1744         optind = 1;
1745
1746         while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1747                 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1748                         parse_cmd_client(cur_client, argv[optind - 1]);
1749                         c &= ~FIO_CLIENT_FLAG;
1750                 }
1751
1752                 switch (c) {
1753                 case 'a':
1754                         smalloc_pool_size = atoi(optarg);
1755                         break;
1756                 case 't':
1757                         if (check_str_time(optarg, &def_timeout, 1)) {
1758                                 log_err("fio: failed parsing time %s\n", optarg);
1759                                 do_exit++;
1760                                 exit_val = 1;
1761                         }
1762                         break;
1763                 case 'l':
1764                         log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
1765                         do_exit++;
1766                         exit_val = 1;
1767                         break;
1768                 case 'b':
1769                         write_bw_log = 1;
1770                         break;
1771                 case 'o':
1772                         if (f_out && f_out != stdout)
1773                                 fclose(f_out);
1774
1775                         f_out = fopen(optarg, "w+");
1776                         if (!f_out) {
1777                                 perror("fopen output");
1778                                 exit(1);
1779                         }
1780                         f_err = f_out;
1781                         break;
1782                 case 'm':
1783                         output_format = FIO_OUTPUT_TERSE;
1784                         break;
1785                 case 'F':
1786                         if (!optarg) {
1787                                 log_err("fio: missing --output-format argument\n");
1788                                 exit_val = 1;
1789                                 do_exit++;
1790                                 break;
1791                         }
1792                         if (!strcmp(optarg, "minimal") ||
1793                             !strcmp(optarg, "terse") ||
1794                             !strcmp(optarg, "csv"))
1795                                 output_format = FIO_OUTPUT_TERSE;
1796                         else if (!strcmp(optarg, "json"))
1797                                 output_format = FIO_OUTPUT_JSON;
1798                         else
1799                                 output_format = FIO_OUTPUT_NORMAL;
1800                         break;
1801                 case 'f':
1802                         append_terse_output = 1;
1803                         break;
1804                 case 'h':
1805                         did_arg = 1;
1806                         if (!cur_client) {
1807                                 usage(argv[0]);
1808                                 do_exit++;
1809                         }
1810                         break;
1811                 case 'c':
1812                         did_arg = 1;
1813                         if (!cur_client) {
1814                                 fio_show_option_help(optarg);
1815                                 do_exit++;
1816                         }
1817                         break;
1818                 case 'i':
1819                         did_arg = 1;
1820                         if (!cur_client) {
1821                                 fio_show_ioengine_help(optarg);
1822                                 do_exit++;
1823                         }
1824                         break;
1825                 case 's':
1826                         did_arg = 1;
1827                         dump_cmdline = 1;
1828                         break;
1829                 case 'r':
1830                         read_only = 1;
1831                         break;
1832                 case 'v':
1833                         did_arg = 1;
1834                         if (!cur_client) {
1835                                 log_info("%s\n", fio_version_string);
1836                                 do_exit++;
1837                         }
1838                         break;
1839                 case 'V':
1840                         terse_version = atoi(optarg);
1841                         if (!(terse_version == 2 || terse_version == 3 ||
1842                              terse_version == 4)) {
1843                                 log_err("fio: bad terse version format\n");
1844                                 exit_val = 1;
1845                                 do_exit++;
1846                         }
1847                         break;
1848                 case 'e':
1849                         if (!strcmp("always", optarg))
1850                                 eta_print = FIO_ETA_ALWAYS;
1851                         else if (!strcmp("never", optarg))
1852                                 eta_print = FIO_ETA_NEVER;
1853                         break;
1854                 case 'E': {
1855                         long long t = 0;
1856
1857                         if (str_to_decimal(optarg, &t, 0, NULL, 1)) {
1858                                 log_err("fio: failed parsing eta time %s\n", optarg);
1859                                 exit_val = 1;
1860                                 do_exit++;
1861                         }
1862                         eta_new_line = t;
1863                         break;
1864                         }
1865                 case 'd':
1866                         if (set_debug(optarg))
1867                                 do_exit++;
1868                         break;
1869                 case 'P':
1870                         did_arg = 1;
1871                         parse_only = 1;
1872                         break;
1873                 case 'x': {
1874                         size_t new_size;
1875
1876                         if (!strcmp(optarg, "global")) {
1877                                 log_err("fio: can't use global as only "
1878                                         "section\n");
1879                                 do_exit++;
1880                                 exit_val = 1;
1881                                 break;
1882                         }
1883                         new_size = (nr_job_sections + 1) * sizeof(char *);
1884                         job_sections = realloc(job_sections, new_size);
1885                         job_sections[nr_job_sections] = strdup(optarg);
1886                         nr_job_sections++;
1887                         break;
1888                         }
1889                 case 'p':
1890                         did_arg = 1;
1891                         if (exec_profile)
1892                                 free(exec_profile);
1893                         exec_profile = strdup(optarg);
1894                         break;
1895                 case FIO_GETOPT_JOB: {
1896                         const char *opt = l_opts[lidx].name;
1897                         char *val = optarg;
1898
1899                         if (!strncmp(opt, "name", 4) && td) {
1900                                 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1901                                 if (ret)
1902                                         goto out_free;
1903                                 td = NULL;
1904                                 did_arg = 1;
1905                         }
1906                         if (!td) {
1907                                 int is_section = !strncmp(opt, "name", 4);
1908                                 int global = 0;
1909
1910                                 if (!is_section || !strncmp(val, "global", 6))
1911                                         global = 1;
1912
1913                                 if (is_section && skip_this_section(val))
1914                                         continue;
1915
1916                                 td = get_new_job(global, &def_thread, 1, NULL);
1917                                 if (!td || ioengine_load(td)) {
1918                                         if (td) {
1919                                                 put_job(td);
1920                                                 td = NULL;
1921                                         }
1922                                         do_exit++;
1923                                         break;
1924                                 }
1925                                 fio_options_set_ioengine_opts(l_opts, td);
1926                         }
1927
1928                         if ((!val || !strlen(val)) &&
1929                             l_opts[lidx].has_arg == required_argument) {
1930                                 log_err("fio: option %s requires an argument\n", opt);
1931                                 ret = 1;
1932                         } else
1933                                 ret = fio_cmd_option_parse(td, opt, val);
1934
1935                         if (ret) {
1936                                 if (td) {
1937                                         put_job(td);
1938                                         td = NULL;
1939                                 }
1940                                 do_exit++;
1941                         }
1942
1943                         if (!ret && !strcmp(opt, "ioengine")) {
1944                                 free_ioengine(td);
1945                                 if (ioengine_load(td)) {
1946                                         if (td) {
1947                                                 put_job(td);
1948                                                 td = NULL;
1949                                         }
1950                                         do_exit++;
1951                                         break;
1952                                 }
1953                                 fio_options_set_ioengine_opts(l_opts, td);
1954                         }
1955                         break;
1956                 }
1957                 case FIO_GETOPT_IOENGINE: {
1958                         const char *opt = l_opts[lidx].name;
1959                         char *val = optarg;
1960
1961                         if (!td)
1962                                 break;
1963
1964                         ret = fio_cmd_ioengine_option_parse(td, opt, val);
1965                         break;
1966                 }
1967                 case 'w':
1968                         warnings_fatal = 1;
1969                         break;
1970                 case 'j':
1971                         max_jobs = atoi(optarg);
1972                         if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1973                                 log_err("fio: invalid max jobs: %d\n", max_jobs);
1974                                 do_exit++;
1975                                 exit_val = 1;
1976                         }
1977                         break;
1978                 case 'S':
1979                         did_arg = 1;
1980 #ifndef CONFIG_NO_SHM
1981                         if (nr_clients) {
1982                                 log_err("fio: can't be both client and server\n");
1983                                 do_exit++;
1984                                 exit_val = 1;
1985                                 break;
1986                         }
1987                         if (optarg)
1988                                 fio_server_set_arg(optarg);
1989                         is_backend = 1;
1990                         backend = 1;
1991 #else
1992                         log_err("fio: client/server requires SHM support\n");
1993                         do_exit++;
1994                         exit_val = 1;
1995 #endif
1996                         break;
1997                 case 'D':
1998                         if (pid_file)
1999                                 free(pid_file);
2000                         pid_file = strdup(optarg);
2001                         break;
2002                 case 'I':
2003                         if ((ret = fio_idle_prof_parse_opt(optarg))) {
2004                                 /* exit on error and calibration only */
2005                                 did_arg = 1;
2006                                 do_exit++;
2007                                 if (ret == -1)
2008                                         exit_val = 1;
2009                         }
2010                         break;
2011                 case 'C':
2012                         did_arg = 1;
2013                         if (is_backend) {
2014                                 log_err("fio: can't be both client and server\n");
2015                                 do_exit++;
2016                                 exit_val = 1;
2017                                 break;
2018                         }
2019                         if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2020                                 log_err("fio: failed adding client %s\n", optarg);
2021                                 do_exit++;
2022                                 exit_val = 1;
2023                                 break;
2024                         }
2025                         /*
2026                          * If the next argument exists and isn't an option,
2027                          * assume it's a job file for this client only.
2028                          */
2029                         while (optind < argc) {
2030                                 if (!strncmp(argv[optind], "--", 2) ||
2031                                     !strncmp(argv[optind], "-", 1))
2032                                         break;
2033
2034                                 fio_client_add_ini_file(cur_client, argv[optind]);
2035                                 optind++;
2036                         }
2037                         break;
2038                 case 'T':
2039                         did_arg = 1;
2040                         do_exit++;
2041                         exit_val = fio_monotonic_clocktest();
2042                         break;
2043                 case 'G':
2044                         did_arg = 1;
2045                         do_exit++;
2046                         exit_val = fio_crctest(optarg);
2047                         break;
2048                 case 'L': {
2049                         long long val;
2050
2051                         if (check_str_time(optarg, &val, 0)) {
2052                                 log_err("fio: failed parsing time %s\n", optarg);
2053                                 do_exit++;
2054                                 exit_val = 1;
2055                                 break;
2056                         }
2057                         status_interval = val * 1000;
2058                         break;
2059                         }
2060                 case '?':
2061                         log_err("%s: unrecognized option '%s'\n", argv[0],
2062                                                         argv[optind - 1]);
2063                 default:
2064                         do_exit++;
2065                         exit_val = 1;
2066                         break;
2067                 }
2068                 if (do_exit)
2069                         break;
2070         }
2071
2072         if (do_exit && !(is_backend || nr_clients))
2073                 exit(exit_val);
2074
2075         if (nr_clients && fio_clients_connect())
2076                 exit(1);
2077
2078         if (is_backend && backend)
2079                 return fio_start_server(pid_file);
2080         else if (pid_file)
2081                 free(pid_file);
2082
2083         if (td) {
2084                 if (!ret) {
2085                         ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2086                         if (ret)
2087                                 did_arg = 1;
2088                 }
2089         }
2090
2091         while (!ret && optind < argc) {
2092                 ini_idx++;
2093                 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2094                 ini_file[ini_idx - 1] = strdup(argv[optind]);
2095                 optind++;
2096         }
2097
2098 out_free:
2099         if (pid_file)
2100                 free(pid_file);
2101
2102         return ini_idx;
2103 }
2104
2105 int fio_init_options(void)
2106 {
2107         f_out = stdout;
2108         f_err = stderr;
2109
2110         fio_options_fill_optstring();
2111         fio_options_dup_and_init(l_opts);
2112
2113         atexit(free_shm);
2114
2115         if (fill_def_thread())
2116                 return 1;
2117
2118         return 0;
2119 }
2120
2121 extern int fio_check_options(struct thread_options *);
2122
2123 int parse_options(int argc, char *argv[])
2124 {
2125         const int type = FIO_CLIENT_TYPE_CLI;
2126         int job_files, i;
2127
2128         if (fio_init_options())
2129                 return 1;
2130         if (fio_test_cconv(&def_thread.o))
2131                 log_err("fio: failed internal cconv test\n");
2132
2133         job_files = parse_cmd_line(argc, argv, type);
2134
2135         if (job_files > 0) {
2136                 for (i = 0; i < job_files; i++) {
2137                         if (i && fill_def_thread())
2138                                 return 1;
2139                         if (nr_clients) {
2140                                 if (fio_clients_send_ini(ini_file[i]))
2141                                         return 1;
2142                                 free(ini_file[i]);
2143                         } else if (!is_backend) {
2144                                 if (parse_jobs_ini(ini_file[i], 0, i, type))
2145                                         return 1;
2146                                 free(ini_file[i]);
2147                         }
2148                 }
2149         } else if (nr_clients) {
2150                 if (fill_def_thread())
2151                         return 1;
2152                 if (fio_clients_send_ini(NULL))
2153                         return 1;
2154         }
2155
2156         free(ini_file);
2157         fio_options_free(&def_thread);
2158         filesetup_mem_free();
2159
2160         if (!thread_number) {
2161                 if (parse_dryrun())
2162                         return 0;
2163                 if (exec_profile)
2164                         return 0;
2165                 if (is_backend || nr_clients)
2166                         return 0;
2167                 if (did_arg)
2168                         return 0;
2169
2170                 log_err("No jobs(s) defined\n\n");
2171
2172                 if (!did_arg) {
2173                         usage(argv[0]);
2174                         return 1;
2175                 }
2176
2177                 return 0;
2178         }
2179
2180         if (def_thread.o.gtod_offload) {
2181                 fio_gtod_init();
2182                 fio_gtod_offload = 1;
2183                 fio_gtod_cpu = def_thread.o.gtod_cpu;
2184         }
2185
2186         if (output_format == FIO_OUTPUT_NORMAL)
2187                 log_info("%s\n", fio_version_string);
2188
2189         return 0;
2190 }
2191
2192 void options_default_fill(struct thread_options *o)
2193 {
2194         memcpy(o, &def_thread.o, sizeof(*o));
2195 }