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