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