client: ensure that cmd line arguments are always run
[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/shm.h>
13#include <sys/types.h>
14#include <sys/stat.h>
15
16#include "fio.h"
17#include "parse.h"
18#include "smalloc.h"
19#include "filehash.h"
20#include "verify.h"
21#include "profile.h"
22#include "server.h"
23
24#include "lib/getopt.h"
25
26#if FIO_PATCH > 0
27static char fio_version_string[] = __fio_stringify(FIO_MAJOR) "." \
28 __fio_stringify(FIO_MINOR) "." \
29 __fio_stringify(FIO_PATCH);
30#else
31static char fio_version_string[] = __fio_stringify(FIO_MAJOR) "." \
32 __fio_stringify(FIO_MINOR);
33#endif
34
35#define FIO_RANDSEED (0xb1899bedUL)
36
37static char **ini_file;
38static int max_jobs = FIO_MAX_JOBS;
39static int dump_cmdline;
40static int def_timeout;
41
42static struct thread_data def_thread;
43struct thread_data *threads = NULL;
44
45int exitall_on_terminate = 0;
46int terse_output = 0;
47int eta_print;
48unsigned long long mlock_size = 0;
49FILE *f_out = NULL;
50FILE *f_err = NULL;
51char **job_sections = NULL;
52int nr_job_sections = 0;
53char *exec_profile = NULL;
54int warnings_fatal = 0;
55int terse_version = 2;
56int is_backend = 0;
57int nr_clients = 0;
58int log_syslog = 0;
59
60int write_bw_log = 0;
61int read_only = 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];
72
73const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN] = {
74 { .u.f = 1.0 },
75 { .u.f = 5.0 },
76 { .u.f = 10.0 },
77 { .u.f = 20.0 },
78 { .u.f = 30.0 },
79 { .u.f = 40.0 },
80 { .u.f = 50.0 },
81 { .u.f = 60.0 },
82 { .u.f = 70.0 },
83 { .u.f = 80.0 },
84 { .u.f = 90.0 },
85 { .u.f = 95.0 },
86 { .u.f = 99.0 },
87 { .u.f = 99.5 },
88 { .u.f = 99.9 },
89};
90
91#define FIO_CLIENT_FLAG (1 << 16)
92
93/*
94 * Command line options. These will contain the above, plus a few
95 * extra that only pertain to fio itself and not jobs.
96 */
97static struct option l_opts[FIO_NR_OPTIONS] = {
98 {
99 .name = (char *) "output",
100 .has_arg = required_argument,
101 .val = 'o' | FIO_CLIENT_FLAG,
102 },
103 {
104 .name = (char *) "timeout",
105 .has_arg = required_argument,
106 .val = 't' | FIO_CLIENT_FLAG,
107 },
108 {
109 .name = (char *) "latency-log",
110 .has_arg = required_argument,
111 .val = 'l' | FIO_CLIENT_FLAG,
112 },
113 {
114 .name = (char *) "bandwidth-log",
115 .has_arg = required_argument,
116 .val = 'b' | FIO_CLIENT_FLAG,
117 },
118 {
119 .name = (char *) "minimal",
120 .has_arg = optional_argument,
121 .val = 'm' | FIO_CLIENT_FLAG,
122 },
123 {
124 .name = (char *) "version",
125 .has_arg = no_argument,
126 .val = 'v' | FIO_CLIENT_FLAG,
127 },
128 {
129 .name = (char *) "help",
130 .has_arg = no_argument,
131 .val = 'h' | FIO_CLIENT_FLAG,
132 },
133 {
134 .name = (char *) "cmdhelp",
135 .has_arg = optional_argument,
136 .val = 'c' | FIO_CLIENT_FLAG,
137 },
138 {
139 .name = (char *) "showcmd",
140 .has_arg = no_argument,
141 .val = 's' | FIO_CLIENT_FLAG,
142 },
143 {
144 .name = (char *) "readonly",
145 .has_arg = no_argument,
146 .val = 'r' | FIO_CLIENT_FLAG,
147 },
148 {
149 .name = (char *) "eta",
150 .has_arg = required_argument,
151 .val = 'e' | FIO_CLIENT_FLAG,
152 },
153 {
154 .name = (char *) "debug",
155 .has_arg = required_argument,
156 .val = 'd' | FIO_CLIENT_FLAG,
157 },
158 {
159 .name = (char *) "section",
160 .has_arg = required_argument,
161 .val = 'x' | FIO_CLIENT_FLAG,
162 },
163 {
164 .name = (char *) "alloc-size",
165 .has_arg = required_argument,
166 .val = 'a' | FIO_CLIENT_FLAG,
167 },
168 {
169 .name = (char *) "profile",
170 .has_arg = required_argument,
171 .val = 'p' | FIO_CLIENT_FLAG,
172 },
173 {
174 .name = (char *) "warnings-fatal",
175 .has_arg = no_argument,
176 .val = 'w' | FIO_CLIENT_FLAG,
177 },
178 {
179 .name = (char *) "max-jobs",
180 .has_arg = required_argument,
181 .val = 'j' | FIO_CLIENT_FLAG,
182 },
183 {
184 .name = (char *) "terse-version",
185 .has_arg = required_argument,
186 .val = 'V' | FIO_CLIENT_FLAG,
187 },
188 {
189 .name = (char *) "server",
190 .has_arg = no_argument,
191 .val = 'S',
192 },
193 { .name = (char *) "daemonize",
194 .has_arg = no_argument,
195 .val = 'D',
196 },
197 {
198 .name = (char *) "net-port",
199 .has_arg = required_argument,
200 .val = 'P',
201 },
202 {
203 .name = (char *) "client",
204 .has_arg = required_argument,
205 .val = 'C',
206 },
207 {
208 .name = NULL,
209 },
210};
211
212static void free_shm(void)
213{
214 struct shmid_ds sbuf;
215
216 if (threads) {
217 void *tp = threads;
218
219 threads = NULL;
220 file_hash_exit();
221 fio_debug_jobp = NULL;
222 shmdt(tp);
223 shmctl(shm_id, IPC_RMID, &sbuf);
224 }
225
226 scleanup();
227}
228
229/*
230 * The thread area is shared between the main process and the job
231 * threads/processes. So setup a shared memory segment that will hold
232 * all the job info. We use the end of the region for keeping track of
233 * open files across jobs, for file sharing.
234 */
235static int setup_thread_area(void)
236{
237 void *hash;
238
239 if (threads)
240 return 0;
241
242 /*
243 * 1024 is too much on some machines, scale max_jobs if
244 * we get a failure that looks like too large a shm segment
245 */
246 do {
247 size_t size = max_jobs * sizeof(struct thread_data);
248
249 size += file_hash_size;
250 size += sizeof(unsigned int);
251
252 shm_id = shmget(0, size, IPC_CREAT | 0600);
253 if (shm_id != -1)
254 break;
255 if (errno != EINVAL) {
256 perror("shmget");
257 break;
258 }
259
260 max_jobs >>= 1;
261 } while (max_jobs);
262
263 if (shm_id == -1)
264 return 1;
265
266 threads = shmat(shm_id, NULL, 0);
267 if (threads == (void *) -1) {
268 perror("shmat");
269 return 1;
270 }
271
272 memset(threads, 0, max_jobs * sizeof(struct thread_data));
273 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
274 fio_debug_jobp = (void *) hash + file_hash_size;
275 *fio_debug_jobp = -1;
276 file_hash_init(hash);
277 return 0;
278}
279
280/*
281 * Return a free job structure.
282 */
283static struct thread_data *get_new_job(int global, struct thread_data *parent)
284{
285 struct thread_data *td;
286
287 if (global)
288 return &def_thread;
289 if (setup_thread_area()) {
290 log_err("error: failed to setup shm segment\n");
291 return NULL;
292 }
293 if (thread_number >= max_jobs) {
294 log_err("error: maximum number of jobs (%d) reached.\n",
295 max_jobs);
296 return NULL;
297 }
298
299 td = &threads[thread_number++];
300 *td = *parent;
301
302 td->o.uid = td->o.gid = -1U;
303
304 dup_files(td, parent);
305 options_mem_dupe(td);
306
307 profile_add_hooks(td);
308
309 td->thread_number = thread_number;
310 return td;
311}
312
313static void put_job(struct thread_data *td)
314{
315 if (td == &def_thread)
316 return;
317
318 profile_td_exit(td);
319
320 if (td->error)
321 log_info("fio: %s\n", td->verror);
322
323 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
324 thread_number--;
325}
326
327static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
328{
329 unsigned int bs = td->o.min_bs[ddir];
330 unsigned long long bytes_per_sec;
331
332 assert(ddir_rw(ddir));
333
334 if (td->o.rate[ddir])
335 bytes_per_sec = td->o.rate[ddir];
336 else
337 bytes_per_sec = td->o.rate_iops[ddir] * bs;
338
339 if (!bytes_per_sec) {
340 log_err("rate lower than supported\n");
341 return -1;
342 }
343
344 td->rate_nsec_cycle[ddir] = 1000000000ULL / bytes_per_sec;
345 td->rate_pending_usleep[ddir] = 0;
346 return 0;
347}
348
349static int setup_rate(struct thread_data *td)
350{
351 int ret = 0;
352
353 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
354 ret = __setup_rate(td, DDIR_READ);
355 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
356 ret |= __setup_rate(td, DDIR_WRITE);
357
358 return ret;
359}
360
361static int fixed_block_size(struct thread_options *o)
362{
363 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
364 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
365 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
366}
367
368/*
369 * Lazy way of fixing up options that depend on each other. We could also
370 * define option callback handlers, but this is easier.
371 */
372static int fixup_options(struct thread_data *td)
373{
374 struct thread_options *o = &td->o;
375 int ret = 0;
376
377#ifndef FIO_HAVE_PSHARED_MUTEX
378 if (!o->use_thread) {
379 log_info("fio: this platform does not support process shared"
380 " mutexes, forcing use of threads. Use the 'thread'"
381 " option to get rid of this warning.\n");
382 o->use_thread = 1;
383 ret = warnings_fatal;
384 }
385#endif
386
387 if (o->write_iolog_file && o->read_iolog_file) {
388 log_err("fio: read iolog overrides write_iolog\n");
389 free(o->write_iolog_file);
390 o->write_iolog_file = NULL;
391 ret = warnings_fatal;
392 }
393
394 /*
395 * only really works for sequential io for now, and with 1 file
396 */
397 if (o->zone_size && td_random(td) && o->open_files == 1)
398 o->zone_size = 0;
399
400 /*
401 * Reads can do overwrites, we always need to pre-create the file
402 */
403 if (td_read(td) || td_rw(td))
404 o->overwrite = 1;
405
406 if (!o->min_bs[DDIR_READ])
407 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
408 if (!o->max_bs[DDIR_READ])
409 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
410 if (!o->min_bs[DDIR_WRITE])
411 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
412 if (!o->max_bs[DDIR_WRITE])
413 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
414
415 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
416
417 /*
418 * For random IO, allow blockalign offset other than min_bs.
419 */
420 if (!o->ba[DDIR_READ] || !td_random(td))
421 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
422 if (!o->ba[DDIR_WRITE] || !td_random(td))
423 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
424
425 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
426 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
427 !o->norandommap) {
428 log_err("fio: Any use of blockalign= turns off randommap\n");
429 o->norandommap = 1;
430 ret = warnings_fatal;
431 }
432
433 if (!o->file_size_high)
434 o->file_size_high = o->file_size_low;
435
436 if (o->norandommap && o->verify != VERIFY_NONE
437 && !fixed_block_size(o)) {
438 log_err("fio: norandommap given for variable block sizes, "
439 "verify disabled\n");
440 o->verify = VERIFY_NONE;
441 ret = warnings_fatal;
442 }
443 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
444 log_err("fio: bs_unaligned may not work with raw io\n");
445
446 /*
447 * thinktime_spin must be less than thinktime
448 */
449 if (o->thinktime_spin > o->thinktime)
450 o->thinktime_spin = o->thinktime;
451
452 /*
453 * The low water mark cannot be bigger than the iodepth
454 */
455 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
456 /*
457 * syslet work around - if the workload is sequential,
458 * we want to let the queue drain all the way down to
459 * avoid seeking between async threads
460 */
461 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
462 o->iodepth_low = 1;
463 else
464 o->iodepth_low = o->iodepth;
465 }
466
467 /*
468 * If batch number isn't set, default to the same as iodepth
469 */
470 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
471 o->iodepth_batch = o->iodepth;
472
473 if (o->nr_files > td->files_index)
474 o->nr_files = td->files_index;
475
476 if (o->open_files > o->nr_files || !o->open_files)
477 o->open_files = o->nr_files;
478
479 if (((o->rate[0] + o->rate[1]) && (o->rate_iops[0] + o->rate_iops[1]))||
480 ((o->ratemin[0] + o->ratemin[1]) && (o->rate_iops_min[0] +
481 o->rate_iops_min[1]))) {
482 log_err("fio: rate and rate_iops are mutually exclusive\n");
483 ret = 1;
484 }
485 if ((o->rate[0] < o->ratemin[0]) || (o->rate[1] < o->ratemin[1]) ||
486 (o->rate_iops[0] < o->rate_iops_min[0]) ||
487 (o->rate_iops[1] < o->rate_iops_min[1])) {
488 log_err("fio: minimum rate exceeds rate\n");
489 ret = 1;
490 }
491
492 if (!o->timeout && o->time_based) {
493 log_err("fio: time_based requires a runtime/timeout setting\n");
494 o->time_based = 0;
495 ret = warnings_fatal;
496 }
497
498 if (o->fill_device && !o->size)
499 o->size = -1ULL;
500
501 if (o->verify != VERIFY_NONE) {
502 if (td_write(td) && o->do_verify && o->numjobs > 1) {
503 log_info("Multiple writers may overwrite blocks that "
504 "belong to other jobs. This can cause "
505 "verification failures.\n");
506 ret = warnings_fatal;
507 }
508
509 o->refill_buffers = 1;
510 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
511 !o->verify_interval)
512 o->verify_interval = o->min_bs[DDIR_WRITE];
513 }
514
515 if (o->pre_read) {
516 o->invalidate_cache = 0;
517 if (td->io_ops->flags & FIO_PIPEIO) {
518 log_info("fio: cannot pre-read files with an IO engine"
519 " that isn't seekable. Pre-read disabled.\n");
520 ret = warnings_fatal;
521 }
522 }
523
524#ifndef FIO_HAVE_FDATASYNC
525 if (o->fdatasync_blocks) {
526 log_info("fio: this platform does not support fdatasync()"
527 " falling back to using fsync(). Use the 'fsync'"
528 " option instead of 'fdatasync' to get rid of"
529 " this warning\n");
530 o->fsync_blocks = o->fdatasync_blocks;
531 o->fdatasync_blocks = 0;
532 ret = warnings_fatal;
533 }
534#endif
535
536 return ret;
537}
538
539/*
540 * This function leaks the buffer
541 */
542static char *to_kmg(unsigned int val)
543{
544 char *buf = malloc(32);
545 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
546 char *p = post;
547
548 do {
549 if (val & 1023)
550 break;
551
552 val >>= 10;
553 p++;
554 } while (*p);
555
556 snprintf(buf, 31, "%u%c", val, *p);
557 return buf;
558}
559
560/* External engines are specified by "external:name.o") */
561static const char *get_engine_name(const char *str)
562{
563 char *p = strstr(str, ":");
564
565 if (!p)
566 return str;
567
568 p++;
569 strip_blank_front(&p);
570 strip_blank_end(p);
571 return p;
572}
573
574static int exists_and_not_file(const char *filename)
575{
576 struct stat sb;
577
578 if (lstat(filename, &sb) == -1)
579 return 0;
580
581 /* \\.\ is the device namespace in Windows, where every file
582 * is a device node */
583 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
584 return 0;
585
586 return 1;
587}
588
589static void td_fill_rand_seeds_os(struct thread_data *td)
590{
591 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
592 os_random_seed(td->rand_seeds[1], &td->verify_state);
593 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
594
595 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
596 os_random_seed(td->rand_seeds[3], &td->next_file_state);
597
598 os_random_seed(td->rand_seeds[5], &td->file_size_state);
599 os_random_seed(td->rand_seeds[6], &td->trim_state);
600
601 if (!td_random(td))
602 return;
603
604 if (td->o.rand_repeatable)
605 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
606
607 os_random_seed(td->rand_seeds[4], &td->random_state);
608}
609
610static void td_fill_rand_seeds_internal(struct thread_data *td)
611{
612 init_rand_seed(&td->__bsrange_state, td->rand_seeds[0]);
613 init_rand_seed(&td->__verify_state, td->rand_seeds[1]);
614 init_rand_seed(&td->__rwmix_state, td->rand_seeds[2]);
615
616 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
617 init_rand_seed(&td->__next_file_state, td->rand_seeds[3]);
618
619 init_rand_seed(&td->__file_size_state, td->rand_seeds[5]);
620 init_rand_seed(&td->__trim_state, td->rand_seeds[6]);
621
622 if (!td_random(td))
623 return;
624
625 if (td->o.rand_repeatable)
626 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
627
628 init_rand_seed(&td->__random_state, td->rand_seeds[4]);
629}
630
631void td_fill_rand_seeds(struct thread_data *td)
632{
633 if (td->o.use_os_rand)
634 td_fill_rand_seeds_os(td);
635 else
636 td_fill_rand_seeds_internal(td);
637
638 init_rand_seed(&td->buf_state, td->rand_seeds[7]);
639}
640
641/*
642 * Initialize the various random states we need (random io, block size ranges,
643 * read/write mix, etc).
644 */
645static int init_random_state(struct thread_data *td)
646{
647 int fd;
648
649 fd = open("/dev/urandom", O_RDONLY);
650 if (fd == -1) {
651 td_verror(td, errno, "open");
652 return 1;
653 }
654
655 if (read(fd, td->rand_seeds, sizeof(td->rand_seeds)) <
656 (int) sizeof(td->rand_seeds)) {
657 td_verror(td, EIO, "read");
658 close(fd);
659 return 1;
660 }
661
662 close(fd);
663 td_fill_rand_seeds(td);
664 return 0;
665}
666
667/*
668 * Adds a job to the list of things todo. Sanitizes the various options
669 * to make sure we don't have conflicts, and initializes various
670 * members of td.
671 */
672static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
673{
674 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
675 "randread", "randwrite", "randrw" };
676 unsigned int i;
677 const char *engine;
678 char fname[PATH_MAX];
679 int numjobs, file_alloced;
680
681 /*
682 * the def_thread is just for options, it's not a real job
683 */
684 if (td == &def_thread)
685 return 0;
686
687 /*
688 * if we are just dumping the output command line, don't add the job
689 */
690 if (dump_cmdline) {
691 put_job(td);
692 return 0;
693 }
694
695 if (profile_td_init(td))
696 goto err;
697
698 engine = get_engine_name(td->o.ioengine);
699 td->io_ops = load_ioengine(td, engine);
700 if (!td->io_ops) {
701 log_err("fio: failed to load engine %s\n", engine);
702 goto err;
703 }
704
705 if (td->o.use_thread)
706 nr_thread++;
707 else
708 nr_process++;
709
710 if (td->o.odirect)
711 td->io_ops->flags |= FIO_RAWIO;
712
713 file_alloced = 0;
714 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
715 file_alloced = 1;
716
717 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
718 add_file(td, jobname);
719 else {
720 for (i = 0; i < td->o.nr_files; i++) {
721 sprintf(fname, "%s.%d.%d", jobname,
722 td->thread_number, i);
723 add_file(td, fname);
724 }
725 }
726 }
727
728 if (fixup_options(td))
729 goto err;
730
731 if (td->io_ops->flags & FIO_DISKLESSIO) {
732 struct fio_file *f;
733
734 for_each_file(td, f, i)
735 f->real_file_size = -1ULL;
736 }
737
738 td->mutex = fio_mutex_init(0);
739
740 td->ts.clat_percentiles = td->o.clat_percentiles;
741 if (td->o.overwrite_plist)
742 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
743 else
744 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
745
746 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
747 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
748 td->ts.lat_stat[0].min_val = td->ts.lat_stat[1].min_val = ULONG_MAX;
749 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
750 td->ddir_seq_nr = td->o.ddir_seq_nr;
751
752 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
753 prev_group_jobs = 0;
754 groupid++;
755 }
756
757 td->groupid = groupid;
758 prev_group_jobs++;
759
760 if (init_random_state(td))
761 goto err;
762
763 if (setup_rate(td))
764 goto err;
765
766 if (td->o.write_lat_log) {
767 setup_log(&td->lat_log);
768 setup_log(&td->slat_log);
769 setup_log(&td->clat_log);
770 }
771 if (td->o.write_bw_log)
772 setup_log(&td->bw_log);
773 if (td->o.write_iops_log)
774 setup_log(&td->iops_log);
775
776 if (!td->o.name)
777 td->o.name = strdup(jobname);
778
779 if (!terse_output) {
780 if (!job_add_num) {
781 if (!strcmp(td->io_ops->name, "cpuio")) {
782 log_info("%s: ioengine=cpu, cpuload=%u,"
783 " cpucycle=%u\n", td->o.name,
784 td->o.cpuload,
785 td->o.cpucycle);
786 } else {
787 char *c1, *c2, *c3, *c4;
788
789 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
790 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
791 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
792 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
793
794 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
795 " ioengine=%s, iodepth=%u\n",
796 td->o.name, td->groupid,
797 ddir_str[td->o.td_ddir],
798 c1, c2, c3, c4,
799 td->io_ops->name,
800 td->o.iodepth);
801
802 free(c1);
803 free(c2);
804 free(c3);
805 free(c4);
806 }
807 } else if (job_add_num == 1)
808 log_info("...\n");
809 }
810
811 /*
812 * recurse add identical jobs, clear numjobs and stonewall options
813 * as they don't apply to sub-jobs
814 */
815 numjobs = td->o.numjobs;
816 while (--numjobs) {
817 struct thread_data *td_new = get_new_job(0, td);
818
819 if (!td_new)
820 goto err;
821
822 td_new->o.numjobs = 1;
823 td_new->o.stonewall = 0;
824 td_new->o.new_group = 0;
825
826 if (file_alloced) {
827 td_new->o.filename = NULL;
828 td_new->files_index = 0;
829 td_new->files_size = 0;
830 td_new->files = NULL;
831 }
832
833 job_add_num = numjobs - 1;
834
835 if (add_job(td_new, jobname, job_add_num))
836 goto err;
837 }
838
839 return 0;
840err:
841 put_job(td);
842 return -1;
843}
844
845/*
846 * Parse as if 'o' was a command line
847 */
848void add_job_opts(const char **o)
849{
850 struct thread_data *td, *td_parent;
851 int i, in_global = 1;
852 char jobname[32];
853
854 i = 0;
855 td_parent = td = NULL;
856 while (o[i]) {
857 if (!strncmp(o[i], "name", 4)) {
858 in_global = 0;
859 if (td)
860 add_job(td, jobname, 0);
861 td = NULL;
862 sprintf(jobname, "%s", o[i] + 5);
863 }
864 if (in_global && !td_parent)
865 td_parent = get_new_job(1, &def_thread);
866 else if (!in_global && !td) {
867 if (!td_parent)
868 td_parent = &def_thread;
869 td = get_new_job(0, td_parent);
870 }
871 if (in_global)
872 fio_options_parse(td_parent, (char **) &o[i], 1);
873 else
874 fio_options_parse(td, (char **) &o[i], 1);
875 i++;
876 }
877
878 if (td)
879 add_job(td, jobname, 0);
880}
881
882static int skip_this_section(const char *name)
883{
884 int i;
885
886 if (!nr_job_sections)
887 return 0;
888 if (!strncmp(name, "global", 6))
889 return 0;
890
891 for (i = 0; i < nr_job_sections; i++)
892 if (!strcmp(job_sections[i], name))
893 return 0;
894
895 return 1;
896}
897
898static int is_empty_or_comment(char *line)
899{
900 unsigned int i;
901
902 for (i = 0; i < strlen(line); i++) {
903 if (line[i] == ';')
904 return 1;
905 if (line[i] == '#')
906 return 1;
907 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
908 return 0;
909 }
910
911 return 1;
912}
913
914/*
915 * This is our [ini] type file parser.
916 */
917int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
918{
919 unsigned int global;
920 struct thread_data *td;
921 char *string, *name;
922 FILE *f;
923 char *p;
924 int ret = 0, stonewall;
925 int first_sect = 1;
926 int skip_fgets = 0;
927 int inside_skip = 0;
928 char **opts;
929 int i, alloc_opts, num_opts;
930
931 if (is_buf)
932 f = NULL;
933 else {
934 if (!strcmp(file, "-"))
935 f = stdin;
936 else
937 f = fopen(file, "r");
938
939 if (!f) {
940 perror("fopen job file");
941 return 1;
942 }
943 }
944
945 string = malloc(4096);
946
947 /*
948 * it's really 256 + small bit, 280 should suffice
949 */
950 name = malloc(280);
951 memset(name, 0, 280);
952
953 alloc_opts = 8;
954 opts = malloc(sizeof(char *) * alloc_opts);
955 num_opts = 0;
956
957 stonewall = stonewall_flag;
958 do {
959 /*
960 * if skip_fgets is set, we already have loaded a line we
961 * haven't handled.
962 */
963 if (!skip_fgets) {
964 if (is_buf)
965 p = strsep(&file, "\n");
966 else
967 p = fgets(string, 4095, f);
968 if (!p)
969 break;
970 }
971
972 skip_fgets = 0;
973 strip_blank_front(&p);
974 strip_blank_end(p);
975
976 if (is_empty_or_comment(p))
977 continue;
978 if (sscanf(p, "[%255[^\n]]", name) != 1) {
979 if (inside_skip)
980 continue;
981 log_err("fio: option <%s> outside of [] job section\n",
982 p);
983 break;
984 }
985
986 name[strlen(name) - 1] = '\0';
987
988 if (skip_this_section(name)) {
989 inside_skip = 1;
990 continue;
991 } else
992 inside_skip = 0;
993
994 global = !strncmp(name, "global", 6);
995
996 if (dump_cmdline) {
997 if (first_sect)
998 log_info("fio ");
999 if (!global)
1000 log_info("--name=%s ", name);
1001 first_sect = 0;
1002 }
1003
1004 td = get_new_job(global, &def_thread);
1005 if (!td) {
1006 ret = 1;
1007 break;
1008 }
1009
1010 /*
1011 * Seperate multiple job files by a stonewall
1012 */
1013 if (!global && stonewall) {
1014 td->o.stonewall = stonewall;
1015 stonewall = 0;
1016 }
1017
1018 num_opts = 0;
1019 memset(opts, 0, alloc_opts * sizeof(char *));
1020
1021 while (1) {
1022 if (is_buf)
1023 p = strsep(&file, "\n");
1024 else
1025 p = fgets(string, 4096, f);
1026 if (!p)
1027 break;
1028
1029 if (is_empty_or_comment(p))
1030 continue;
1031
1032 strip_blank_front(&p);
1033
1034 /*
1035 * new section, break out and make sure we don't
1036 * fgets() a new line at the top.
1037 */
1038 if (p[0] == '[') {
1039 skip_fgets = 1;
1040 break;
1041 }
1042
1043 strip_blank_end(p);
1044
1045 if (num_opts == alloc_opts) {
1046 alloc_opts <<= 1;
1047 opts = realloc(opts,
1048 alloc_opts * sizeof(char *));
1049 }
1050
1051 opts[num_opts] = strdup(p);
1052 num_opts++;
1053 }
1054
1055 ret = fio_options_parse(td, opts, num_opts);
1056 if (!ret) {
1057 if (dump_cmdline)
1058 for (i = 0; i < num_opts; i++)
1059 log_info("--%s ", opts[i]);
1060
1061 ret = add_job(td, name, 0);
1062 } else {
1063 log_err("fio: job %s dropped\n", name);
1064 put_job(td);
1065 }
1066
1067 for (i = 0; i < num_opts; i++)
1068 free(opts[i]);
1069 num_opts = 0;
1070 } while (!ret);
1071
1072 if (dump_cmdline)
1073 log_info("\n");
1074
1075 for (i = 0; i < num_opts; i++)
1076 free(opts[i]);
1077
1078 free(string);
1079 free(name);
1080 free(opts);
1081 if (!is_buf && f != stdin)
1082 fclose(f);
1083 return ret;
1084}
1085
1086static int fill_def_thread(void)
1087{
1088 memset(&def_thread, 0, sizeof(def_thread));
1089
1090 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1091 def_thread.o.timeout = def_timeout;
1092
1093 /*
1094 * fill default options
1095 */
1096 fio_fill_default_options(&def_thread);
1097 return 0;
1098}
1099
1100static void usage(const char *name)
1101{
1102 printf("%s\n", fio_version_string);
1103 printf("%s [options] [job options] <job file(s)>\n", name);
1104 printf("\t--debug=options\tEnable debug logging\n");
1105 printf("\t--output\tWrite output to file\n");
1106 printf("\t--timeout\tRuntime in seconds\n");
1107 printf("\t--latency-log\tGenerate per-job latency logs\n");
1108 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
1109 printf("\t--minimal\tMinimal (terse) output\n");
1110 printf("\t--version\tPrint version info and exit\n");
1111 printf("\t--terse-version=x Terse version output format\n");
1112 printf("\t--help\t\tPrint this page\n");
1113 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of"
1114 " them\n");
1115 printf("\t--showcmd\tTurn a job file into command line options\n");
1116 printf("\t--eta=when\tWhen ETA estimate should be printed\n");
1117 printf("\t \tMay be \"always\", \"never\" or \"auto\"\n");
1118 printf("\t--readonly\tTurn on safety read-only checks, preventing"
1119 " writes\n");
1120 printf("\t--section=name\tOnly run specified section in job file\n");
1121 printf("\t--alloc-size=kb\tSet smalloc pool to this size in kb"
1122 " (def 1024)\n");
1123 printf("\t--warnings-fatal Fio parser warnings are fatal\n");
1124 printf("\t--max-jobs\tMaximum number of threads/processes to support\n");
1125 printf("\t--server\tStart a backend fio server\n");
1126 printf("\t--client=hostname Talk to remove backend fio server at hostname\n");
1127 printf("\t--net-port=port\tUse specified port for client/server connection\n");
1128 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1129 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1130}
1131
1132#ifdef FIO_INC_DEBUG
1133struct debug_level debug_levels[] = {
1134 { .name = "process", .shift = FD_PROCESS, },
1135 { .name = "file", .shift = FD_FILE, },
1136 { .name = "io", .shift = FD_IO, },
1137 { .name = "mem", .shift = FD_MEM, },
1138 { .name = "blktrace", .shift = FD_BLKTRACE },
1139 { .name = "verify", .shift = FD_VERIFY },
1140 { .name = "random", .shift = FD_RANDOM },
1141 { .name = "parse", .shift = FD_PARSE },
1142 { .name = "diskutil", .shift = FD_DISKUTIL },
1143 { .name = "job", .shift = FD_JOB },
1144 { .name = "mutex", .shift = FD_MUTEX },
1145 { .name = "profile", .shift = FD_PROFILE },
1146 { .name = "time", .shift = FD_TIME },
1147 { .name = "net", .shift = FD_NET },
1148 { .name = NULL, },
1149};
1150
1151static int set_debug(const char *string)
1152{
1153 struct debug_level *dl;
1154 char *p = (char *) string;
1155 char *opt;
1156 int i;
1157
1158 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1159 log_info("fio: dumping debug options:");
1160 for (i = 0; debug_levels[i].name; i++) {
1161 dl = &debug_levels[i];
1162 log_info("%s,", dl->name);
1163 }
1164 log_info("all\n");
1165 return 1;
1166 }
1167
1168 while ((opt = strsep(&p, ",")) != NULL) {
1169 int found = 0;
1170
1171 if (!strncmp(opt, "all", 3)) {
1172 log_info("fio: set all debug options\n");
1173 fio_debug = ~0UL;
1174 continue;
1175 }
1176
1177 for (i = 0; debug_levels[i].name; i++) {
1178 dl = &debug_levels[i];
1179 found = !strncmp(opt, dl->name, strlen(dl->name));
1180 if (!found)
1181 continue;
1182
1183 if (dl->shift == FD_JOB) {
1184 opt = strchr(opt, ':');
1185 if (!opt) {
1186 log_err("fio: missing job number\n");
1187 break;
1188 }
1189 opt++;
1190 fio_debug_jobno = atoi(opt);
1191 log_info("fio: set debug jobno %d\n",
1192 fio_debug_jobno);
1193 } else {
1194 log_info("fio: set debug option %s\n", opt);
1195 fio_debug |= (1UL << dl->shift);
1196 }
1197 break;
1198 }
1199
1200 if (!found)
1201 log_err("fio: debug mask %s not found\n", opt);
1202 }
1203 return 0;
1204}
1205#else
1206static int set_debug(const char *string)
1207{
1208 log_err("fio: debug tracing not included in build\n");
1209 return 1;
1210}
1211#endif
1212
1213static void fio_options_fill_optstring(void)
1214{
1215 char *ostr = cmd_optstr;
1216 int i, c;
1217
1218 c = i = 0;
1219 while (l_opts[i].name) {
1220 ostr[c++] = l_opts[i].val;
1221 if (l_opts[i].has_arg == required_argument)
1222 ostr[c++] = ':';
1223 else if (l_opts[i].has_arg == optional_argument) {
1224 ostr[c++] = ':';
1225 ostr[c++] = ':';
1226 }
1227 i++;
1228 }
1229 ostr[c] = '\0';
1230}
1231
1232static int client_flag_set(char c)
1233{
1234 int i;
1235
1236 i = 0;
1237 while (l_opts[i].name) {
1238 int val = l_opts[i].val;
1239
1240 if (c == (val & 0xff))
1241 return (val & FIO_CLIENT_FLAG);
1242
1243 i++;
1244 }
1245
1246 return 0;
1247}
1248
1249int parse_cmd_client(char *client, char *opt)
1250{
1251 return fio_client_add_cmd_option(client, opt);
1252}
1253
1254int parse_cmd_line(int argc, char *argv[])
1255{
1256 struct thread_data *td = NULL;
1257 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1258 char *ostr = cmd_optstr;
1259 int daemonize_server = 0;
1260 char *cur_client = NULL;
1261 int backend = 0;
1262
1263 /*
1264 * Reset optind handling, since we may call this multiple times
1265 * for the backend.
1266 */
1267 optind = 1;
1268
1269 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1270 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1271 if (parse_cmd_client(cur_client, argv[optind - 1])) {
1272 exit_val = 1;
1273 do_exit++;
1274 break;
1275 }
1276 c &= ~FIO_CLIENT_FLAG;
1277 }
1278
1279 switch (c) {
1280 case 'a':
1281 smalloc_pool_size = atoi(optarg);
1282 break;
1283 case 't':
1284 def_timeout = atoi(optarg);
1285 break;
1286 case 'l':
1287 write_lat_log = 1;
1288 break;
1289 case 'b':
1290 write_bw_log = 1;
1291 break;
1292 case 'o':
1293 f_out = fopen(optarg, "w+");
1294 if (!f_out) {
1295 perror("fopen output");
1296 exit(1);
1297 }
1298 f_err = f_out;
1299 break;
1300 case 'm':
1301 terse_output = 1;
1302 break;
1303 case 'h':
1304 if (!cur_client)
1305 usage(argv[0]);
1306 do_exit++;
1307 break;
1308 case 'c':
1309 if (!cur_client)
1310 fio_show_option_help(optarg);
1311 do_exit++;
1312 break;
1313 case 's':
1314 dump_cmdline = 1;
1315 break;
1316 case 'r':
1317 read_only = 1;
1318 break;
1319 case 'v':
1320 if (!cur_client)
1321 log_info("%s\n", fio_version_string);
1322 do_exit++;
1323 break;
1324 case 'V':
1325 terse_version = atoi(optarg);
1326 if (terse_version != 2) {
1327 log_err("fio: bad terse version format\n");
1328 exit_val = 1;
1329 do_exit++;
1330 }
1331 break;
1332 case 'e':
1333 if (!strcmp("always", optarg))
1334 eta_print = FIO_ETA_ALWAYS;
1335 else if (!strcmp("never", optarg))
1336 eta_print = FIO_ETA_NEVER;
1337 break;
1338 case 'd':
1339 if (set_debug(optarg))
1340 do_exit++;
1341 break;
1342 case 'x': {
1343 size_t new_size;
1344
1345 if (!strcmp(optarg, "global")) {
1346 log_err("fio: can't use global as only "
1347 "section\n");
1348 do_exit++;
1349 exit_val = 1;
1350 break;
1351 }
1352 new_size = (nr_job_sections + 1) * sizeof(char *);
1353 job_sections = realloc(job_sections, new_size);
1354 job_sections[nr_job_sections] = strdup(optarg);
1355 nr_job_sections++;
1356 break;
1357 }
1358 case 'p':
1359 exec_profile = strdup(optarg);
1360 break;
1361 case FIO_GETOPT_JOB: {
1362 const char *opt = l_opts[lidx].name;
1363 char *val = optarg;
1364
1365 if (!strncmp(opt, "name", 4) && td) {
1366 ret = add_job(td, td->o.name ?: "fio", 0);
1367 if (ret)
1368 return 0;
1369 td = NULL;
1370 }
1371 if (!td) {
1372 int is_section = !strncmp(opt, "name", 4);
1373 int global = 0;
1374
1375 if (!is_section || !strncmp(val, "global", 6))
1376 global = 1;
1377
1378 if (is_section && skip_this_section(val))
1379 continue;
1380
1381 td = get_new_job(global, &def_thread);
1382 if (!td)
1383 return 0;
1384 }
1385
1386 ret = fio_cmd_option_parse(td, opt, val);
1387 break;
1388 }
1389 case 'w':
1390 warnings_fatal = 1;
1391 break;
1392 case 'j':
1393 max_jobs = atoi(optarg);
1394 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1395 log_err("fio: invalid max jobs: %d\n", max_jobs);
1396 do_exit++;
1397 exit_val = 1;
1398 }
1399 break;
1400 case 'S':
1401 if (nr_clients) {
1402 log_err("fio: can't be both client and server\n");
1403 do_exit++;
1404 exit_val = 1;
1405 break;
1406 }
1407 is_backend = 1;
1408 backend = 1;
1409 break;
1410 case 'D':
1411 daemonize_server = 1;
1412 break;
1413 case 'P':
1414 fio_net_port = atoi(optarg);
1415 break;
1416 case 'C':
1417 if (is_backend) {
1418 log_err("fio: can't be both client and server\n");
1419 do_exit++;
1420 exit_val = 1;
1421 break;
1422 }
1423 fio_client_add(optarg);
1424 cur_client = optarg;
1425 break;
1426 default:
1427 do_exit++;
1428 exit_val = 1;
1429 break;
1430 }
1431 if (do_exit)
1432 break;
1433 }
1434
1435 if (do_exit) {
1436 if (exit_val && !(is_backend || nr_clients))
1437 exit(exit_val);
1438 }
1439
1440 if (nr_clients && fio_clients_connect()) {
1441 do_exit++;
1442 exit_val = 1;
1443 return -1;
1444 }
1445
1446 if (is_backend && backend)
1447 return fio_start_server(daemonize_server);
1448
1449 if (td) {
1450 if (!ret)
1451 ret = add_job(td, td->o.name ?: "fio", 0);
1452 }
1453
1454 while (optind < argc) {
1455 ini_idx++;
1456 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1457 ini_file[ini_idx - 1] = strdup(argv[optind]);
1458 optind++;
1459 }
1460
1461 return ini_idx;
1462}
1463
1464int parse_options(int argc, char *argv[])
1465{
1466 int job_files, i;
1467
1468 f_out = stdout;
1469 f_err = stderr;
1470
1471 fio_options_fill_optstring();
1472 fio_options_dup_and_init(l_opts);
1473
1474 atexit(free_shm);
1475
1476 if (fill_def_thread())
1477 return 1;
1478
1479 job_files = parse_cmd_line(argc, argv);
1480
1481 if (job_files > 0) {
1482 for (i = 0; i < job_files; i++) {
1483 if (fill_def_thread())
1484 return 1;
1485 if (nr_clients) {
1486 if (fio_clients_send_ini(ini_file[i]))
1487 return 1;
1488 free(ini_file[i]);
1489 } else if (!is_backend) {
1490 if (parse_jobs_ini(ini_file[i], 0, i))
1491 return 1;
1492 free(ini_file[i]);
1493 }
1494 }
1495 }
1496
1497 free(ini_file);
1498 options_mem_free(&def_thread);
1499
1500 if (!thread_number) {
1501 if (dump_cmdline)
1502 return 0;
1503 if (exec_profile)
1504 return 0;
1505 if (is_backend || nr_clients)
1506 return 0;
1507
1508 log_err("No jobs(s) defined\n\n");
1509 usage(argv[0]);
1510 return 1;
1511 }
1512
1513 if (def_thread.o.gtod_offload) {
1514 fio_gtod_init();
1515 fio_gtod_offload = 1;
1516 fio_gtod_cpu = def_thread.o.gtod_cpu;
1517 }
1518
1519 log_info("%s\n", fio_version_string);
1520 return 0;
1521}