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