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