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