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