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