projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Fix access-outside-array of o->rwmix[]
[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 return ret;
633}
634
635/*
636 * This function leaks the buffer
637 */
638char *fio_uint_to_kmg(unsigned int val)
639{
640 char *buf = malloc(32);
641 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
642 char *p = post;
643
644 do {
645 if (val & 1023)
646 break;
647
648 val >>= 10;
649 p++;
650 } while (*p);
651
652 snprintf(buf, 32, "%u%c", val, *p);
653 return buf;
654}
655
656/* External engines are specified by "external:name.o") */
657static const char *get_engine_name(const char *str)
658{
659 char *p = strstr(str, ":");
660
661 if (!p)
662 return str;
663
664 p++;
665 strip_blank_front(&p);
666 strip_blank_end(p);
667 return p;
668}
669
670static int exists_and_not_file(const char *filename)
671{
672 struct stat sb;
673
674 if (lstat(filename, &sb) == -1)
675 return 0;
676
677 /* \\.\ is the device namespace in Windows, where every file
678 * is a device node */
679 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
680 return 0;
681
682 return 1;
683}
684
685static void td_fill_rand_seeds_os(struct thread_data *td)
686{
687 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
688 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
689 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
690
691 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
692 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
693
694 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
695 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
696
697 if (!td_random(td))
698 return;
699
700 if (td->o.rand_repeatable)
701 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
702
703 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
704
705 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], &td->seq_rand_state[DDIR_READ]);
706 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF], &td->seq_rand_state[DDIR_WRITE]);
707 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF], &td->seq_rand_state[DDIR_TRIM]);
708}
709
710static void td_fill_rand_seeds_internal(struct thread_data *td)
711{
712 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
713 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
714 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
715
716 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
717 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
718
719 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
720 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
721
722 if (!td_random(td))
723 return;
724
725 if (td->o.rand_repeatable)
726 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
727
728 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
729 init_rand_seed(&td->__seq_rand_state[DDIR_READ], td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF]);
730 init_rand_seed(&td->__seq_rand_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF]);
731 init_rand_seed(&td->__seq_rand_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF]);
732}
733
734void td_fill_rand_seeds(struct thread_data *td)
735{
736 if (td->o.use_os_rand)
737 td_fill_rand_seeds_os(td);
738 else
739 td_fill_rand_seeds_internal(td);
740
741 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
742}
743
744/*
745 * Initializes the ioengine configured for a job, if it has not been done so
746 * already.
747 */
748int ioengine_load(struct thread_data *td)
749{
750 const char *engine;
751
752 /*
753 * Engine has already been loaded.
754 */
755 if (td->io_ops)
756 return 0;
757 if (!td->o.ioengine) {
758 log_err("fio: internal fault, no IO engine specified\n");
759 return 1;
760 }
761
762 engine = get_engine_name(td->o.ioengine);
763 td->io_ops = load_ioengine(td, engine);
764 if (!td->io_ops) {
765 log_err("fio: failed to load engine %s\n", engine);
766 return 1;
767 }
768
769 if (td->io_ops->option_struct_size && td->io_ops->options) {
770 /*
771 * In cases where td->eo is set, clone it for a child thread.
772 * This requires that the parent thread has the same ioengine,
773 * but that requirement must be enforced by the code which
774 * cloned the thread.
775 */
776 void *origeo = td->eo;
777 /*
778 * Otherwise use the default thread options.
779 */
780 if (!origeo && td != &def_thread && def_thread.eo &&
781 def_thread.io_ops->options == td->io_ops->options)
782 origeo = def_thread.eo;
783
784 options_init(td->io_ops->options);
785 td->eo = malloc(td->io_ops->option_struct_size);
786 /*
787 * Use the default thread as an option template if this uses the
788 * same options structure and there are non-default options
789 * used.
790 */
791 if (origeo) {
792 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
793 options_mem_dupe(td->eo, td->io_ops->options);
794 } else {
795 memset(td->eo, 0, td->io_ops->option_struct_size);
796 fill_default_options(td->eo, td->io_ops->options);
797 }
798 *(struct thread_data **)td->eo = td;
799 }
800
801 return 0;
802}
803
804static void init_flags(struct thread_data *td)
805{
806 struct thread_options *o = &td->o;
807
808 if (o->verify_backlog)
809 td->flags |= TD_F_VER_BACKLOG;
810 if (o->trim_backlog)
811 td->flags |= TD_F_TRIM_BACKLOG;
812 if (o->read_iolog_file)
813 td->flags |= TD_F_READ_IOLOG;
814 if (o->refill_buffers)
815 td->flags |= TD_F_REFILL_BUFFERS;
816 if (o->scramble_buffers)
817 td->flags |= TD_F_SCRAMBLE_BUFFERS;
818 if (o->verify != VERIFY_NONE)
819 td->flags |= TD_F_VER_NONE;
820}
821
822static int setup_random_seeds(struct thread_data *td)
823{
824 unsigned long seed;
825 unsigned int i;
826
827 if (!td->o.rand_repeatable)
828 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
829
830 for (seed = 0x89, i = 0; i < 4; i++)
831 seed *= 0x9e370001UL;
832
833 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
834 td->rand_seeds[i] = seed;
835 seed *= 0x9e370001UL;
836 }
837
838 td_fill_rand_seeds(td);
839 return 0;
840}
841
842enum {
843 FPRE_NONE = 0,
844 FPRE_JOBNAME,
845 FPRE_JOBNUM,
846 FPRE_FILENUM
847};
848
849static struct fpre_keyword {
850 const char *keyword;
851 size_t strlen;
852 int key;
853} fpre_keywords[] = {
854 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
855 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
856 { .keyword = "$filenum", .key = FPRE_FILENUM, },
857 { .keyword = NULL, },
858 };
859
860static char *make_filename(char *buf, struct thread_options *o,
861 const char *jobname, int jobnum, int filenum)
862{
863 struct fpre_keyword *f;
864 char copy[PATH_MAX];
865
866 if (!o->filename_format || !strlen(o->filename_format)) {
867 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
868 return NULL;
869 }
870
871 for (f = &fpre_keywords[0]; f->keyword; f++)
872 f->strlen = strlen(f->keyword);
873
874 strcpy(buf, o->filename_format);
875 memset(copy, 0, sizeof(copy));
876 for (f = &fpre_keywords[0]; f->keyword; f++) {
877 do {
878 size_t pre_len, post_start = 0;
879 char *str, *dst = copy;
880
881 str = strcasestr(buf, f->keyword);
882 if (!str)
883 break;
884
885 pre_len = str - buf;
886 if (strlen(str) != f->strlen)
887 post_start = pre_len + f->strlen;
888
889 if (pre_len) {
890 strncpy(dst, buf, pre_len);
891 dst += pre_len;
892 }
893
894 switch (f->key) {
895 case FPRE_JOBNAME:
896 dst += sprintf(dst, "%s", jobname);
897 break;
898 case FPRE_JOBNUM:
899 dst += sprintf(dst, "%d", jobnum);
900 break;
901 case FPRE_FILENUM:
902 dst += sprintf(dst, "%d", filenum);
903 break;
904 default:
905 assert(0);
906 break;
907 }
908
909 if (post_start)
910 strcpy(dst, buf + post_start);
911
912 strcpy(buf, copy);
913 } while (1);
914 }
915
916 return buf;
917}
918
919int parse_dryrun(void)
920{
921 return dump_cmdline || parse_only;
922}
923
924/*
925 * Adds a job to the list of things todo. Sanitizes the various options
926 * to make sure we don't have conflicts, and initializes various
927 * members of td.
928 */
929static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
930 int recursed, int client_type)
931{
932 unsigned int i;
933 char fname[PATH_MAX];
934 int numjobs, file_alloced;
935 struct thread_options *o = &td->o;
936
937 /*
938 * the def_thread is just for options, it's not a real job
939 */
940 if (td == &def_thread)
941 return 0;
942
943 init_flags(td);
944
945 /*
946 * if we are just dumping the output command line, don't add the job
947 */
948 if (parse_dryrun()) {
949 put_job(td);
950 return 0;
951 }
952
953 td->client_type = client_type;
954
955 if (profile_td_init(td))
956 goto err;
957
958 if (ioengine_load(td))
959 goto err;
960
961 if (o->odirect)
962 td->io_ops->flags |= FIO_RAWIO;
963
964 file_alloced = 0;
965 if (!o->filename && !td->files_index && !o->read_iolog_file) {
966 file_alloced = 1;
967
968 if (o->nr_files == 1 && exists_and_not_file(jobname))
969 add_file(td, jobname);
970 else {
971 for (i = 0; i < o->nr_files; i++)
972 add_file(td, make_filename(fname, o, jobname, td->thread_number, i));
973 }
974 }
975
976 if (fixup_options(td))
977 goto err;
978
979 flow_init_job(td);
980
981 /*
982 * IO engines only need this for option callbacks, and the address may
983 * change in subprocesses.
984 */
985 if (td->eo)
986 *(struct thread_data **)td->eo = NULL;
987
988 if (td->io_ops->flags & FIO_DISKLESSIO) {
989 struct fio_file *f;
990
991 for_each_file(td, f, i)
992 f->real_file_size = -1ULL;
993 }
994
995 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
996
997 td->ts.clat_percentiles = o->clat_percentiles;
998 td->ts.percentile_precision = o->percentile_precision;
999 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1000
1001 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1002 td->ts.clat_stat[i].min_val = ULONG_MAX;
1003 td->ts.slat_stat[i].min_val = ULONG_MAX;
1004 td->ts.lat_stat[i].min_val = ULONG_MAX;
1005 td->ts.bw_stat[i].min_val = ULONG_MAX;
1006 }
1007 td->ddir_seq_nr = o->ddir_seq_nr;
1008
1009 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1010 prev_group_jobs = 0;
1011 groupid++;
1012 }
1013
1014 td->groupid = groupid;
1015 prev_group_jobs++;
1016
1017 if (setup_random_seeds(td)) {
1018 td_verror(td, errno, "init_random_state");
1019 goto err;
1020 }
1021
1022 if (setup_rate(td))
1023 goto err;
1024
1025 if (o->lat_log_file) {
1026 setup_log(&td->lat_log, o->log_avg_msec, IO_LOG_TYPE_LAT);
1027 setup_log(&td->slat_log, o->log_avg_msec, IO_LOG_TYPE_SLAT);
1028 setup_log(&td->clat_log, o->log_avg_msec, IO_LOG_TYPE_CLAT);
1029 }
1030 if (o->bw_log_file)
1031 setup_log(&td->bw_log, o->log_avg_msec, IO_LOG_TYPE_BW);
1032 if (o->iops_log_file)
1033 setup_log(&td->iops_log, o->log_avg_msec, IO_LOG_TYPE_IOPS);
1034
1035 if (!o->name)
1036 o->name = strdup(jobname);
1037
1038 if (output_format == FIO_OUTPUT_NORMAL) {
1039 if (!job_add_num) {
1040 if (is_backend && !recursed)
1041 fio_server_send_add_job(td);
1042
1043 if (!(td->io_ops->flags & FIO_NOIO)) {
1044 char *c1, *c2, *c3, *c4;
1045 char *c5 = NULL, *c6 = NULL;
1046
1047 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1048 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1049 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1050 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1051
1052 if (!o->bs_is_seq_rand) {
1053 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1054 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1055 }
1056
1057 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1058 td->groupid,
1059 ddir_str(o->td_ddir));
1060
1061 if (o->bs_is_seq_rand)
1062 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1063 c1, c2, c3, c4);
1064 else
1065 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1066 c1, c2, c3, c4, c5, c6);
1067
1068 log_info("ioengine=%s, iodepth=%u\n",
1069 td->io_ops->name, o->iodepth);
1070
1071 free(c1);
1072 free(c2);
1073 free(c3);
1074 free(c4);
1075 free(c5);
1076 free(c6);
1077 }
1078 } else if (job_add_num == 1)
1079 log_info("...\n");
1080 }
1081
1082 /*
1083 * recurse add identical jobs, clear numjobs and stonewall options
1084 * as they don't apply to sub-jobs
1085 */
1086 numjobs = o->numjobs;
1087 while (--numjobs) {
1088 struct thread_data *td_new = get_new_job(0, td, 1);
1089
1090 if (!td_new)
1091 goto err;
1092
1093 td_new->o.numjobs = 1;
1094 td_new->o.stonewall = 0;
1095 td_new->o.new_group = 0;
1096
1097 if (file_alloced) {
1098 td_new->o.filename = NULL;
1099 td_new->files_index = 0;
1100 td_new->files_size = 0;
1101 td_new->files = NULL;
1102 }
1103
1104 job_add_num = numjobs - 1;
1105
1106 if (add_job(td_new, jobname, job_add_num, 1, client_type))
1107 goto err;
1108 }
1109
1110 return 0;
1111err:
1112 put_job(td);
1113 return -1;
1114}
1115
1116/*
1117 * Parse as if 'o' was a command line
1118 */
1119void add_job_opts(const char **o, int client_type)
1120{
1121 struct thread_data *td, *td_parent;
1122 int i, in_global = 1;
1123 char jobname[32];
1124
1125 i = 0;
1126 td_parent = td = NULL;
1127 while (o[i]) {
1128 if (!strncmp(o[i], "name", 4)) {
1129 in_global = 0;
1130 if (td)
1131 add_job(td, jobname, 0, 0, client_type);
1132 td = NULL;
1133 sprintf(jobname, "%s", o[i] + 5);
1134 }
1135 if (in_global && !td_parent)
1136 td_parent = get_new_job(1, &def_thread, 0);
1137 else if (!in_global && !td) {
1138 if (!td_parent)
1139 td_parent = &def_thread;
1140 td = get_new_job(0, td_parent, 0);
1141 }
1142 if (in_global)
1143 fio_options_parse(td_parent, (char **) &o[i], 1);
1144 else
1145 fio_options_parse(td, (char **) &o[i], 1);
1146 i++;
1147 }
1148
1149 if (td)
1150 add_job(td, jobname, 0, 0, client_type);
1151}
1152
1153static int skip_this_section(const char *name)
1154{
1155 int i;
1156
1157 if (!nr_job_sections)
1158 return 0;
1159 if (!strncmp(name, "global", 6))
1160 return 0;
1161
1162 for (i = 0; i < nr_job_sections; i++)
1163 if (!strcmp(job_sections[i], name))
1164 return 0;
1165
1166 return 1;
1167}
1168
1169static int is_empty_or_comment(char *line)
1170{
1171 unsigned int i;
1172
1173 for (i = 0; i < strlen(line); i++) {
1174 if (line[i] == ';')
1175 return 1;
1176 if (line[i] == '#')
1177 return 1;
1178 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1179 return 0;
1180 }
1181
1182 return 1;
1183}
1184
1185/*
1186 * This is our [ini] type file parser.
1187 */
1188int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1189{
1190 unsigned int global;
1191 struct thread_data *td;
1192 char *string, *name;
1193 FILE *f;
1194 char *p;
1195 int ret = 0, stonewall;
1196 int first_sect = 1;
1197 int skip_fgets = 0;
1198 int inside_skip = 0;
1199 char **opts;
1200 int i, alloc_opts, num_opts;
1201
1202 if (is_buf)
1203 f = NULL;
1204 else {
1205 if (!strcmp(file, "-"))
1206 f = stdin;
1207 else
1208 f = fopen(file, "r");
1209
1210 if (!f) {
1211 perror("fopen job file");
1212 return 1;
1213 }
1214 }
1215
1216 string = malloc(4096);
1217
1218 /*
1219 * it's really 256 + small bit, 280 should suffice
1220 */
1221 name = malloc(280);
1222 memset(name, 0, 280);
1223
1224 alloc_opts = 8;
1225 opts = malloc(sizeof(char *) * alloc_opts);
1226 num_opts = 0;
1227
1228 stonewall = stonewall_flag;
1229 do {
1230 /*
1231 * if skip_fgets is set, we already have loaded a line we
1232 * haven't handled.
1233 */
1234 if (!skip_fgets) {
1235 if (is_buf)
1236 p = strsep(&file, "\n");
1237 else
1238 p = fgets(string, 4096, f);
1239 if (!p)
1240 break;
1241 }
1242
1243 skip_fgets = 0;
1244 strip_blank_front(&p);
1245 strip_blank_end(p);
1246
1247 if (is_empty_or_comment(p))
1248 continue;
1249 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1250 if (inside_skip)
1251 continue;
1252 log_err("fio: option <%s> outside of [] job section\n",
1253 p);
1254 break;
1255 }
1256
1257 name[strlen(name) - 1] = '\0';
1258
1259 if (skip_this_section(name)) {
1260 inside_skip = 1;
1261 continue;
1262 } else
1263 inside_skip = 0;
1264
1265 global = !strncmp(name, "global", 6);
1266
1267 if (dump_cmdline) {
1268 if (first_sect)
1269 log_info("fio ");
1270 if (!global)
1271 log_info("--name=%s ", name);
1272 first_sect = 0;
1273 }
1274
1275 td = get_new_job(global, &def_thread, 0);
1276 if (!td) {
1277 ret = 1;
1278 break;
1279 }
1280
1281 /*
1282 * Separate multiple job files by a stonewall
1283 */
1284 if (!global && stonewall) {
1285 td->o.stonewall = stonewall;
1286 stonewall = 0;
1287 }
1288
1289 num_opts = 0;
1290 memset(opts, 0, alloc_opts * sizeof(char *));
1291
1292 while (1) {
1293 if (is_buf)
1294 p = strsep(&file, "\n");
1295 else
1296 p = fgets(string, 4096, f);
1297 if (!p)
1298 break;
1299
1300 if (is_empty_or_comment(p))
1301 continue;
1302
1303 strip_blank_front(&p);
1304
1305 /*
1306 * new section, break out and make sure we don't
1307 * fgets() a new line at the top.
1308 */
1309 if (p[0] == '[') {
1310 skip_fgets = 1;
1311 break;
1312 }
1313
1314 strip_blank_end(p);
1315
1316 if (num_opts == alloc_opts) {
1317 alloc_opts <<= 1;
1318 opts = realloc(opts,
1319 alloc_opts * sizeof(char *));
1320 }
1321
1322 opts[num_opts] = strdup(p);
1323 num_opts++;
1324 }
1325
1326 ret = fio_options_parse(td, opts, num_opts);
1327 if (!ret) {
1328 if (dump_cmdline)
1329 for (i = 0; i < num_opts; i++)
1330 log_info("--%s ", opts[i]);
1331
1332 ret = add_job(td, name, 0, 0, type);
1333 } else {
1334 log_err("fio: job %s dropped\n", name);
1335 put_job(td);
1336 }
1337
1338 for (i = 0; i < num_opts; i++)
1339 free(opts[i]);
1340 num_opts = 0;
1341 } while (!ret);
1342
1343 if (dump_cmdline)
1344 log_info("\n");
1345
1346 i = 0;
1347 while (i < nr_job_sections) {
1348 free(job_sections[i]);
1349 i++;
1350 }
1351
1352 for (i = 0; i < num_opts; i++)
1353 free(opts[i]);
1354
1355 free(string);
1356 free(name);
1357 free(opts);
1358 if (!is_buf && f != stdin)
1359 fclose(f);
1360 return ret;
1361}
1362
1363static int fill_def_thread(void)
1364{
1365 memset(&def_thread, 0, sizeof(def_thread));
1366
1367 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1368 def_thread.o.timeout = def_timeout;
1369 def_thread.o.error_dump = 1;
1370 /*
1371 * fill default options
1372 */
1373 fio_fill_default_options(&def_thread);
1374 return 0;
1375}
1376
1377static void usage(const char *name)
1378{
1379 printf("%s\n", fio_version_string);
1380 printf("%s [options] [job options] <job file(s)>\n", name);
1381 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1382 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1383 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1384 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1385 printf(" --output\t\tWrite output to file\n");
1386 printf(" --runtime\t\tRuntime in seconds\n");
1387 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1388 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1389 printf(" --minimal\t\tMinimal (terse) output\n");
1390 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1391 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1392 printf(" --version\t\tPrint version info and exit\n");
1393 printf(" --help\t\tPrint this page\n");
1394 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1395 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1396 " them\n");
1397 printf(" --enghelp=engine\tPrint ioengine help, or list"
1398 " available ioengines\n");
1399 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1400 " cmd\n");
1401 printf(" --showcmd\t\tTurn a job file into command line options\n");
1402 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1403 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1404 printf(" --eta-newline=time\tForce a new line for every 'time'");
1405 printf(" period passed\n");
1406 printf(" --status-interval=t\tForce full status dump every");
1407 printf(" 't' period passed\n");
1408 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1409 " writes\n");
1410 printf(" --section=name\tOnly run specified section in job file\n");
1411 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1412 " (def 1024)\n");
1413 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1414 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1415 printf(" --server=args\t\tStart a backend fio server\n");
1416 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1417 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1418 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1419 "\t\t\t(option=system,percpu) or run unit work\n"
1420 "\t\t\tcalibration only (option=calibrate)\n");
1421 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1422 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1423}
1424
1425#ifdef FIO_INC_DEBUG
1426struct debug_level debug_levels[] = {
1427 { .name = "process",
1428 .help = "Process creation/exit logging",
1429 .shift = FD_PROCESS,
1430 },
1431 { .name = "file",
1432 .help = "File related action logging",
1433 .shift = FD_FILE,
1434 },
1435 { .name = "io",
1436 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1437 .shift = FD_IO,
1438 },
1439 { .name = "mem",
1440 .help = "Memory allocation/freeing logging",
1441 .shift = FD_MEM,
1442 },
1443 { .name = "blktrace",
1444 .help = "blktrace action logging",
1445 .shift = FD_BLKTRACE,
1446 },
1447 { .name = "verify",
1448 .help = "IO verification action logging",
1449 .shift = FD_VERIFY,
1450 },
1451 { .name = "random",
1452 .help = "Random generation logging",
1453 .shift = FD_RANDOM,
1454 },
1455 { .name = "parse",
1456 .help = "Parser logging",
1457 .shift = FD_PARSE,
1458 },
1459 { .name = "diskutil",
1460 .help = "Disk utility logging actions",
1461 .shift = FD_DISKUTIL,
1462 },
1463 { .name = "job",
1464 .help = "Logging related to creating/destroying jobs",
1465 .shift = FD_JOB,
1466 },
1467 { .name = "mutex",
1468 .help = "Mutex logging",
1469 .shift = FD_MUTEX
1470 },
1471 { .name = "profile",
1472 .help = "Logging related to profiles",
1473 .shift = FD_PROFILE,
1474 },
1475 { .name = "time",
1476 .help = "Logging related to time keeping functions",
1477 .shift = FD_TIME,
1478 },
1479 { .name = "net",
1480 .help = "Network logging",
1481 .shift = FD_NET,
1482 },
1483 { .name = NULL, },
1484};
1485
1486static int set_debug(const char *string)
1487{
1488 struct debug_level *dl;
1489 char *p = (char *) string;
1490 char *opt;
1491 int i;
1492
1493 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1494 log_info("fio: dumping debug options:");
1495 for (i = 0; debug_levels[i].name; i++) {
1496 dl = &debug_levels[i];
1497 log_info("%s,", dl->name);
1498 }
1499 log_info("all\n");
1500 return 1;
1501 }
1502
1503 while ((opt = strsep(&p, ",")) != NULL) {
1504 int found = 0;
1505
1506 if (!strncmp(opt, "all", 3)) {
1507 log_info("fio: set all debug options\n");
1508 fio_debug = ~0UL;
1509 continue;
1510 }
1511
1512 for (i = 0; debug_levels[i].name; i++) {
1513 dl = &debug_levels[i];
1514 found = !strncmp(opt, dl->name, strlen(dl->name));
1515 if (!found)
1516 continue;
1517
1518 if (dl->shift == FD_JOB) {
1519 opt = strchr(opt, ':');
1520 if (!opt) {
1521 log_err("fio: missing job number\n");
1522 break;
1523 }
1524 opt++;
1525 fio_debug_jobno = atoi(opt);
1526 log_info("fio: set debug jobno %d\n",
1527 fio_debug_jobno);
1528 } else {
1529 log_info("fio: set debug option %s\n", opt);
1530 fio_debug |= (1UL << dl->shift);
1531 }
1532 break;
1533 }
1534
1535 if (!found)
1536 log_err("fio: debug mask %s not found\n", opt);
1537 }
1538 return 0;
1539}
1540#else
1541static int set_debug(const char *string)
1542{
1543 log_err("fio: debug tracing not included in build\n");
1544 return 1;
1545}
1546#endif
1547
1548static void fio_options_fill_optstring(void)
1549{
1550 char *ostr = cmd_optstr;
1551 int i, c;
1552
1553 c = i = 0;
1554 while (l_opts[i].name) {
1555 ostr[c++] = l_opts[i].val;
1556 if (l_opts[i].has_arg == required_argument)
1557 ostr[c++] = ':';
1558 else if (l_opts[i].has_arg == optional_argument) {
1559 ostr[c++] = ':';
1560 ostr[c++] = ':';
1561 }
1562 i++;
1563 }
1564 ostr[c] = '\0';
1565}
1566
1567static int client_flag_set(char c)
1568{
1569 int i;
1570
1571 i = 0;
1572 while (l_opts[i].name) {
1573 int val = l_opts[i].val;
1574
1575 if (c == (val & 0xff))
1576 return (val & FIO_CLIENT_FLAG);
1577
1578 i++;
1579 }
1580
1581 return 0;
1582}
1583
1584void parse_cmd_client(void *client, char *opt)
1585{
1586 fio_client_add_cmd_option(client, opt);
1587}
1588
1589int parse_cmd_line(int argc, char *argv[], int client_type)
1590{
1591 struct thread_data *td = NULL;
1592 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1593 char *ostr = cmd_optstr;
1594 void *pid_file = NULL;
1595 void *cur_client = NULL;
1596 int backend = 0;
1597
1598 /*
1599 * Reset optind handling, since we may call this multiple times
1600 * for the backend.
1601 */
1602 optind = 1;
1603
1604 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1605 did_arg = 1;
1606
1607 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1608 parse_cmd_client(cur_client, argv[optind - 1]);
1609 c &= ~FIO_CLIENT_FLAG;
1610 }
1611
1612 switch (c) {
1613 case 'a':
1614 smalloc_pool_size = atoi(optarg);
1615 break;
1616 case 't':
1617 def_timeout = atoi(optarg);
1618 break;
1619 case 'l':
1620 write_lat_log = 1;
1621 break;
1622 case 'b':
1623 write_bw_log = 1;
1624 break;
1625 case 'o':
1626 f_out = fopen(optarg, "w+");
1627 if (!f_out) {
1628 perror("fopen output");
1629 exit(1);
1630 }
1631 f_err = f_out;
1632 break;
1633 case 'm':
1634 output_format = FIO_OUTPUT_TERSE;
1635 break;
1636 case 'F':
1637 if (!strcmp(optarg, "minimal") ||
1638 !strcmp(optarg, "terse") ||
1639 !strcmp(optarg, "csv"))
1640 output_format = FIO_OUTPUT_TERSE;
1641 else if (!strcmp(optarg, "json"))
1642 output_format = FIO_OUTPUT_JSON;
1643 else
1644 output_format = FIO_OUTPUT_NORMAL;
1645 break;
1646 case 'h':
1647 if (!cur_client) {
1648 usage(argv[0]);
1649 do_exit++;
1650 }
1651 break;
1652 case 'c':
1653 if (!cur_client) {
1654 fio_show_option_help(optarg);
1655 do_exit++;
1656 }
1657 break;
1658 case 'i':
1659 if (!cur_client) {
1660 fio_show_ioengine_help(optarg);
1661 do_exit++;
1662 }
1663 break;
1664 case 's':
1665 dump_cmdline = 1;
1666 break;
1667 case 'r':
1668 read_only = 1;
1669 break;
1670 case 'v':
1671 if (!cur_client) {
1672 log_info("%s\n", fio_version_string);
1673 do_exit++;
1674 }
1675 break;
1676 case 'V':
1677 terse_version = atoi(optarg);
1678 if (!(terse_version == 2 || terse_version == 3 ||
1679 terse_version == 4)) {
1680 log_err("fio: bad terse version format\n");
1681 exit_val = 1;
1682 do_exit++;
1683 }
1684 break;
1685 case 'e':
1686 if (!strcmp("always", optarg))
1687 eta_print = FIO_ETA_ALWAYS;
1688 else if (!strcmp("never", optarg))
1689 eta_print = FIO_ETA_NEVER;
1690 break;
1691 case 'E': {
1692 long long t = 0;
1693
1694 if (str_to_decimal(optarg, &t, 0, NULL)) {
1695 log_err("fio: failed parsing eta time %s\n", optarg);
1696 exit_val = 1;
1697 do_exit++;
1698 }
1699 eta_new_line = t;
1700 break;
1701 }
1702 case 'd':
1703 if (set_debug(optarg))
1704 do_exit++;
1705 break;
1706 case 'P':
1707 parse_only = 1;
1708 break;
1709 case 'x': {
1710 size_t new_size;
1711
1712 if (!strcmp(optarg, "global")) {
1713 log_err("fio: can't use global as only "
1714 "section\n");
1715 do_exit++;
1716 exit_val = 1;
1717 break;
1718 }
1719 new_size = (nr_job_sections + 1) * sizeof(char *);
1720 job_sections = realloc(job_sections, new_size);
1721 job_sections[nr_job_sections] = strdup(optarg);
1722 nr_job_sections++;
1723 break;
1724 }
1725 case 'p':
1726 exec_profile = strdup(optarg);
1727 break;
1728 case FIO_GETOPT_JOB: {
1729 const char *opt = l_opts[lidx].name;
1730 char *val = optarg;
1731
1732 if (!strncmp(opt, "name", 4) && td) {
1733 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1734 if (ret)
1735 return 0;
1736 td = NULL;
1737 }
1738 if (!td) {
1739 int is_section = !strncmp(opt, "name", 4);
1740 int global = 0;
1741
1742 if (!is_section || !strncmp(val, "global", 6))
1743 global = 1;
1744
1745 if (is_section && skip_this_section(val))
1746 continue;
1747
1748 td = get_new_job(global, &def_thread, 1);
1749 if (!td || ioengine_load(td))
1750 return 0;
1751 fio_options_set_ioengine_opts(l_opts, td);
1752 }
1753
1754 if ((!val || !strlen(val)) &&
1755 l_opts[lidx].has_arg == required_argument) {
1756 log_err("fio: option %s requires an argument\n", opt);
1757 ret = 1;
1758 } else
1759 ret = fio_cmd_option_parse(td, opt, val);
1760
1761 if (ret) {
1762 if (td) {
1763 put_job(td);
1764 td = NULL;
1765 }
1766 do_exit++;
1767 }
1768
1769 if (!ret && !strcmp(opt, "ioengine")) {
1770 free_ioengine(td);
1771 if (ioengine_load(td))
1772 return 0;
1773 fio_options_set_ioengine_opts(l_opts, td);
1774 }
1775 break;
1776 }
1777 case FIO_GETOPT_IOENGINE: {
1778 const char *opt = l_opts[lidx].name;
1779 char *val = optarg;
1780 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1781 break;
1782 }
1783 case 'w':
1784 warnings_fatal = 1;
1785 break;
1786 case 'j':
1787 max_jobs = atoi(optarg);
1788 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1789 log_err("fio: invalid max jobs: %d\n", max_jobs);
1790 do_exit++;
1791 exit_val = 1;
1792 }
1793 break;
1794 case 'S':
1795 if (nr_clients) {
1796 log_err("fio: can't be both client and server\n");
1797 do_exit++;
1798 exit_val = 1;
1799 break;
1800 }
1801 if (optarg)
1802 fio_server_set_arg(optarg);
1803 is_backend = 1;
1804 backend = 1;
1805 break;
1806 case 'D':
1807 pid_file = strdup(optarg);
1808 break;
1809 case 'I':
1810 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1811 /* exit on error and calibration only */
1812 do_exit++;
1813 if (ret == -1)
1814 exit_val = 1;
1815 }
1816 break;
1817 case 'C':
1818 if (is_backend) {
1819 log_err("fio: can't be both client and server\n");
1820 do_exit++;
1821 exit_val = 1;
1822 break;
1823 }
1824 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1825 log_err("fio: failed adding client %s\n", optarg);
1826 do_exit++;
1827 exit_val = 1;
1828 break;
1829 }
1830 /*
1831 * If the next argument exists and isn't an option,
1832 * assume it's a job file for this client only.
1833 */
1834 while (optind < argc) {
1835 if (!strncmp(argv[optind], "--", 2) ||
1836 !strncmp(argv[optind], "-", 1))
1837 break;
1838
1839 fio_client_add_ini_file(cur_client, argv[optind]);
1840 optind++;
1841 }
1842 break;
1843 case 'T':
1844 do_exit++;
1845 exit_val = fio_monotonic_clocktest();
1846 break;
1847 case 'L': {
1848 long long val;
1849
1850 if (check_str_time(optarg, &val)) {
1851 log_err("fio: failed parsing time %s\n", optarg);
1852 do_exit++;
1853 exit_val = 1;
1854 break;
1855 }
1856 status_interval = val * 1000;
1857 break;
1858 }
1859 case '?':
1860 log_err("%s: unrecognized option '%s'\n", argv[0],
1861 argv[optind - 1]);
1862 default:
1863 do_exit++;
1864 exit_val = 1;
1865 break;
1866 }
1867 if (do_exit)
1868 break;
1869 }
1870
1871 if (do_exit && !(is_backend || nr_clients))
1872 exit(exit_val);
1873
1874 if (nr_clients && fio_clients_connect()) {
1875 do_exit++;
1876 exit_val = 1;
1877 return -1;
1878 }
1879
1880 if (is_backend && backend)
1881 return fio_start_server(pid_file);
1882
1883 if (td) {
1884 if (!ret)
1885 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1886 }
1887
1888 while (!ret && optind < argc) {
1889 ini_idx++;
1890 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1891 ini_file[ini_idx - 1] = strdup(argv[optind]);
1892 optind++;
1893 }
1894
1895 return ini_idx;
1896}
1897
1898int fio_init_options(void)
1899{
1900 f_out = stdout;
1901 f_err = stderr;
1902
1903 fio_options_fill_optstring();
1904 fio_options_dup_and_init(l_opts);
1905
1906 atexit(free_shm);
1907
1908 if (fill_def_thread())
1909 return 1;
1910
1911 return 0;
1912}
1913
1914extern int fio_check_options(struct thread_options *);
1915
1916int parse_options(int argc, char *argv[])
1917{
1918 const int type = FIO_CLIENT_TYPE_CLI;
1919 int job_files, i;
1920
1921 if (fio_init_options())
1922 return 1;
1923 if (fio_test_cconv(&def_thread.o))
1924 log_err("fio: failed internal cconv test\n");
1925
1926 job_files = parse_cmd_line(argc, argv, type);
1927
1928 if (job_files > 0) {
1929 for (i = 0; i < job_files; i++) {
1930 if (fill_def_thread())
1931 return 1;
1932 if (nr_clients) {
1933 if (fio_clients_send_ini(ini_file[i]))
1934 return 1;
1935 free(ini_file[i]);
1936 } else if (!is_backend) {
1937 if (parse_jobs_ini(ini_file[i], 0, i, type))
1938 return 1;
1939 free(ini_file[i]);
1940 }
1941 }
1942 } else if (nr_clients) {
1943 if (fill_def_thread())
1944 return 1;
1945 if (fio_clients_send_ini(NULL))
1946 return 1;
1947 }
1948
1949 free(ini_file);
1950 fio_options_free(&def_thread);
1951
1952 if (!thread_number) {
1953 if (parse_dryrun())
1954 return 0;
1955 if (exec_profile)
1956 return 0;
1957 if (is_backend || nr_clients)
1958 return 0;
1959 if (did_arg)
1960 return 0;
1961
1962 log_err("No jobs(s) defined\n\n");
1963
1964 if (!did_arg) {
1965 usage(argv[0]);
1966 return 1;
1967 }
1968
1969 return 0;
1970 }
1971
1972 if (def_thread.o.gtod_offload) {
1973 fio_gtod_init();
1974 fio_gtod_offload = 1;
1975 fio_gtod_cpu = def_thread.o.gtod_cpu;
1976 }
1977
1978 if (output_format == FIO_OUTPUT_NORMAL)
1979 log_info("%s\n", fio_version_string);
1980
1981 return 0;
1982}
1983
1984void options_default_fill(struct thread_options *o)
1985{
1986 memcpy(o, &def_thread.o, sizeof(*o));
1987}
fio - Flexible IO Tester