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