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