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