xref: /spdk/examples/bdev/bdevperf/bdevperf.c (revision 784b3b89f141b26148f1498fd4a211c5d7ae1d79)
1 /*   SPDX-License-Identifier: BSD-3-Clause
2  *   Copyright (C) 2016 Intel Corporation.
3  *   Copyright (c) 2022-2023 NVIDIA CORPORATION & AFFILIATES.
4  *   All rights reserved.
5  */
6 
7 #include "spdk/stdinc.h"
8 
9 #include "spdk/bdev.h"
10 #include "spdk/accel.h"
11 #include "spdk/endian.h"
12 #include "spdk/env.h"
13 #include "spdk/event.h"
14 #include "spdk/log.h"
15 #include "spdk/util.h"
16 #include "spdk/thread.h"
17 #include "spdk/string.h"
18 #include "spdk/rpc.h"
19 #include "spdk/bit_array.h"
20 #include "spdk/conf.h"
21 #include "spdk/zipf.h"
22 #include "spdk/histogram_data.h"
23 
24 #define BDEVPERF_CONFIG_MAX_FILENAME 1024
25 #define BDEVPERF_CONFIG_UNDEFINED -1
26 #define BDEVPERF_CONFIG_ERROR -2
27 
28 struct bdevperf_task {
29 	struct iovec			iov;
30 	struct bdevperf_job		*job;
31 	struct spdk_bdev_io		*bdev_io;
32 	void				*buf;
33 	void				*md_buf;
34 	uint64_t			offset_blocks;
35 	struct bdevperf_task		*task_to_abort;
36 	enum spdk_bdev_io_type		io_type;
37 	TAILQ_ENTRY(bdevperf_task)	link;
38 	struct spdk_bdev_io_wait_entry	bdev_io_wait;
39 };
40 
41 static const char *g_workload_type = NULL;
42 static int g_io_size = 0;
43 /* initialize to invalid value so we can detect if user overrides it. */
44 static int g_rw_percentage = -1;
45 static bool g_verify = false;
46 static bool g_reset = false;
47 static bool g_continue_on_failure = false;
48 static bool g_abort = false;
49 static bool g_error_to_exit = false;
50 static int g_queue_depth = 0;
51 static uint64_t g_time_in_usec;
52 static int g_show_performance_real_time = 0;
53 static uint64_t g_show_performance_period_in_usec = SPDK_SEC_TO_USEC;
54 static uint64_t g_show_performance_period_num = 0;
55 static uint64_t g_show_performance_ema_period = 0;
56 static int g_run_rc = 0;
57 static bool g_shutdown = false;
58 static uint64_t g_start_tsc;
59 static uint64_t g_shutdown_tsc;
60 static bool g_zcopy = false;
61 static struct spdk_thread *g_main_thread;
62 static int g_time_in_sec = 0;
63 static bool g_mix_specified = false;
64 static const char *g_job_bdev_name;
65 static bool g_wait_for_tests = false;
66 static struct spdk_jsonrpc_request *g_request = NULL;
67 static bool g_multithread_mode = false;
68 static int g_timeout_in_sec;
69 static struct spdk_conf *g_bdevperf_conf = NULL;
70 static const char *g_bdevperf_conf_file = NULL;
71 static double g_zipf_theta;
72 static bool g_random_map = false;
73 
74 static struct spdk_cpuset g_all_cpuset;
75 static struct spdk_poller *g_perf_timer = NULL;
76 
77 static void bdevperf_submit_single(struct bdevperf_job *job, struct bdevperf_task *task);
78 static void rpc_perform_tests_cb(void);
79 
80 static uint32_t g_bdev_count = 0;
81 static uint32_t g_latency_display_level;
82 
83 static bool g_one_thread_per_lcore = false;
84 
85 static const double g_latency_cutoffs[] = {
86 	0.01,
87 	0.10,
88 	0.25,
89 	0.50,
90 	0.75,
91 	0.90,
92 	0.95,
93 	0.98,
94 	0.99,
95 	0.995,
96 	0.999,
97 	0.9999,
98 	0.99999,
99 	0.999999,
100 	0.9999999,
101 	-1,
102 };
103 
104 struct latency_info {
105 	uint64_t	min;
106 	uint64_t	max;
107 	uint64_t	total;
108 };
109 
110 struct bdevperf_job {
111 	char				*name;
112 	struct spdk_bdev		*bdev;
113 	struct spdk_bdev_desc		*bdev_desc;
114 	struct spdk_io_channel		*ch;
115 	TAILQ_ENTRY(bdevperf_job)	link;
116 	struct spdk_thread		*thread;
117 
118 	const char			*workload_type;
119 	int				io_size;
120 	int				rw_percentage;
121 	bool				is_random;
122 	bool				verify;
123 	bool				reset;
124 	bool				continue_on_failure;
125 	bool				unmap;
126 	bool				write_zeroes;
127 	bool				flush;
128 	bool				abort;
129 	int				queue_depth;
130 	unsigned int			seed;
131 
132 	uint64_t			io_completed;
133 	uint64_t			io_failed;
134 	uint64_t			io_timeout;
135 	uint64_t			prev_io_completed;
136 	double				ema_io_per_second;
137 	int				current_queue_depth;
138 	uint64_t			size_in_ios;
139 	uint64_t			ios_base;
140 	uint64_t			offset_in_ios;
141 	uint64_t			io_size_blocks;
142 	uint64_t			buf_size;
143 	uint32_t			dif_check_flags;
144 	bool				is_draining;
145 	struct spdk_poller		*run_timer;
146 	struct spdk_poller		*reset_timer;
147 	struct spdk_bit_array		*outstanding;
148 	struct spdk_zipf		*zipf;
149 	TAILQ_HEAD(, bdevperf_task)	task_list;
150 	uint64_t			run_time_in_usec;
151 
152 	/* keep channel's histogram data before being destroyed */
153 	struct spdk_histogram_data	*histogram;
154 	struct spdk_bit_array		*random_map;
155 };
156 
157 struct spdk_bdevperf {
158 	TAILQ_HEAD(, bdevperf_job)	jobs;
159 	uint32_t			running_jobs;
160 };
161 
162 static struct spdk_bdevperf g_bdevperf = {
163 	.jobs = TAILQ_HEAD_INITIALIZER(g_bdevperf.jobs),
164 	.running_jobs = 0,
165 };
166 
167 enum job_config_rw {
168 	JOB_CONFIG_RW_READ = 0,
169 	JOB_CONFIG_RW_WRITE,
170 	JOB_CONFIG_RW_RANDREAD,
171 	JOB_CONFIG_RW_RANDWRITE,
172 	JOB_CONFIG_RW_RW,
173 	JOB_CONFIG_RW_RANDRW,
174 	JOB_CONFIG_RW_VERIFY,
175 	JOB_CONFIG_RW_RESET,
176 	JOB_CONFIG_RW_UNMAP,
177 	JOB_CONFIG_RW_FLUSH,
178 	JOB_CONFIG_RW_WRITE_ZEROES,
179 };
180 
181 /* Storing values from a section of job config file */
182 struct job_config {
183 	const char			*name;
184 	const char			*filename;
185 	struct spdk_cpuset		cpumask;
186 	int				bs;
187 	int				iodepth;
188 	int				rwmixread;
189 	uint32_t			lcore;
190 	int64_t				offset;
191 	uint64_t			length;
192 	enum job_config_rw		rw;
193 	TAILQ_ENTRY(job_config)	link;
194 };
195 
196 TAILQ_HEAD(, job_config) job_config_list
197 	= TAILQ_HEAD_INITIALIZER(job_config_list);
198 
199 static bool g_performance_dump_active = false;
200 
201 struct bdevperf_aggregate_stats {
202 	struct bdevperf_job		*current_job;
203 	uint64_t			io_time_in_usec;
204 	uint64_t			ema_period;
205 	double				total_io_per_second;
206 	double				total_mb_per_second;
207 	double				total_failed_per_second;
208 	double				total_timeout_per_second;
209 	double				min_latency;
210 	double				max_latency;
211 	uint64_t			total_io_completed;
212 	uint64_t			total_tsc;
213 };
214 
215 static struct bdevperf_aggregate_stats g_stats = {.min_latency = (double)UINT64_MAX};
216 
217 struct lcore_thread {
218 	struct spdk_thread		*thread;
219 	uint32_t			lcore;
220 	TAILQ_ENTRY(lcore_thread)	link;
221 };
222 
223 TAILQ_HEAD(, lcore_thread) g_lcore_thread_list
224 	= TAILQ_HEAD_INITIALIZER(g_lcore_thread_list);
225 
226 /*
227  * Cumulative Moving Average (CMA): average of all data up to current
228  * Exponential Moving Average (EMA): weighted mean of the previous n data and more weight is given to recent
229  * Simple Moving Average (SMA): unweighted mean of the previous n data
230  *
231  * Bdevperf supports CMA and EMA.
232  */
233 static double
234 get_cma_io_per_second(struct bdevperf_job *job, uint64_t io_time_in_usec)
235 {
236 	return (double)job->io_completed * SPDK_SEC_TO_USEC / io_time_in_usec;
237 }
238 
239 static double
240 get_ema_io_per_second(struct bdevperf_job *job, uint64_t ema_period)
241 {
242 	double io_completed, io_per_second;
243 
244 	io_completed = job->io_completed;
245 	io_per_second = (double)(io_completed - job->prev_io_completed) * SPDK_SEC_TO_USEC
246 			/ g_show_performance_period_in_usec;
247 	job->prev_io_completed = io_completed;
248 
249 	job->ema_io_per_second += (io_per_second - job->ema_io_per_second) * 2
250 				  / (ema_period + 1);
251 	return job->ema_io_per_second;
252 }
253 
254 static void
255 get_avg_latency(void *ctx, uint64_t start, uint64_t end, uint64_t count,
256 		uint64_t total, uint64_t so_far)
257 {
258 	struct latency_info *latency_info = ctx;
259 
260 	if (count == 0) {
261 		return;
262 	}
263 
264 	latency_info->total += (start + end) / 2 * count;
265 
266 	if (so_far == count) {
267 		latency_info->min = start;
268 	}
269 
270 	if (so_far == total) {
271 		latency_info->max = end;
272 	}
273 }
274 
275 static void
276 performance_dump_job(struct bdevperf_aggregate_stats *stats, struct bdevperf_job *job)
277 {
278 	double io_per_second, mb_per_second, failed_per_second, timeout_per_second;
279 	double average_latency = 0.0, min_latency, max_latency;
280 	uint64_t time_in_usec;
281 	uint64_t tsc_rate;
282 	uint64_t total_io;
283 	struct latency_info latency_info = {};
284 
285 	printf("\r Job: %s (Core Mask 0x%s)\n", job->name,
286 	       spdk_cpuset_fmt(spdk_thread_get_cpumask(job->thread)));
287 
288 	if (job->io_failed > 0 && !job->reset && !job->continue_on_failure) {
289 		printf("\r Job: %s ended in about %.2f seconds with error\n",
290 		       job->name, (double)job->run_time_in_usec / SPDK_SEC_TO_USEC);
291 	}
292 	if (job->verify) {
293 		printf("\t Verification LBA range: start 0x%" PRIx64 " length 0x%" PRIx64 "\n",
294 		       job->ios_base, job->size_in_ios);
295 	}
296 
297 	if (g_performance_dump_active == true) {
298 		/* Use job's actual run time as Job has ended */
299 		if (job->io_failed > 0 && !job->continue_on_failure) {
300 			time_in_usec = job->run_time_in_usec;
301 		} else {
302 			time_in_usec = stats->io_time_in_usec;
303 		}
304 	} else {
305 		time_in_usec = job->run_time_in_usec;
306 	}
307 
308 	if (stats->ema_period == 0) {
309 		io_per_second = get_cma_io_per_second(job, time_in_usec);
310 	} else {
311 		io_per_second = get_ema_io_per_second(job, stats->ema_period);
312 	}
313 
314 	tsc_rate = spdk_get_ticks_hz();
315 	mb_per_second = io_per_second * job->io_size / (1024 * 1024);
316 
317 	spdk_histogram_data_iterate(job->histogram, get_avg_latency, &latency_info);
318 
319 	total_io = job->io_completed + job->io_failed;
320 	if (total_io != 0) {
321 		average_latency = (double)latency_info.total / total_io * SPDK_SEC_TO_USEC / tsc_rate;
322 	}
323 	min_latency = (double)latency_info.min * SPDK_SEC_TO_USEC / tsc_rate;
324 	max_latency = (double)latency_info.max * SPDK_SEC_TO_USEC / tsc_rate;
325 
326 	failed_per_second = (double)job->io_failed * SPDK_SEC_TO_USEC / time_in_usec;
327 	timeout_per_second = (double)job->io_timeout * SPDK_SEC_TO_USEC / time_in_usec;
328 
329 	printf("\t %-20s: %10.2f %10.2f %10.2f",
330 	       job->name, (float)time_in_usec / SPDK_SEC_TO_USEC, io_per_second, mb_per_second);
331 	printf(" %10.2f %8.2f",
332 	       failed_per_second, timeout_per_second);
333 	printf(" %10.2f %10.2f %10.2f\n",
334 	       average_latency, min_latency, max_latency);
335 
336 	stats->total_io_per_second += io_per_second;
337 	stats->total_mb_per_second += mb_per_second;
338 	stats->total_failed_per_second += failed_per_second;
339 	stats->total_timeout_per_second += timeout_per_second;
340 	stats->total_io_completed += job->io_completed + job->io_failed;
341 	stats->total_tsc += latency_info.total;
342 	if (min_latency < stats->min_latency) {
343 		stats->min_latency = min_latency;
344 	}
345 	if (max_latency > stats->max_latency) {
346 		stats->max_latency = max_latency;
347 	}
348 }
349 
350 static void
351 generate_data(void *buf, int buf_len, int block_size, void *md_buf, int md_size,
352 	      int num_blocks)
353 {
354 	int offset_blocks = 0, md_offset, data_block_size, inner_offset;
355 
356 	if (buf_len < num_blocks * block_size) {
357 		return;
358 	}
359 
360 	if (md_buf == NULL) {
361 		data_block_size = block_size - md_size;
362 		md_buf = (char *)buf + data_block_size;
363 		md_offset = block_size;
364 	} else {
365 		data_block_size = block_size;
366 		md_offset = md_size;
367 	}
368 
369 	while (offset_blocks < num_blocks) {
370 		inner_offset = 0;
371 		while (inner_offset < data_block_size) {
372 			*(uint32_t *)buf = offset_blocks + inner_offset;
373 			inner_offset += sizeof(uint32_t);
374 			buf += sizeof(uint32_t);
375 		}
376 		memset(md_buf, offset_blocks, md_size);
377 		md_buf += md_offset;
378 		offset_blocks++;
379 	}
380 }
381 
382 static bool
383 copy_data(void *wr_buf, int wr_buf_len, void *rd_buf, int rd_buf_len, int block_size,
384 	  void *wr_md_buf, void *rd_md_buf, int md_size, int num_blocks)
385 {
386 	if (wr_buf_len < num_blocks * block_size || rd_buf_len < num_blocks * block_size) {
387 		return false;
388 	}
389 
390 	assert((wr_md_buf != NULL) == (rd_md_buf != NULL));
391 
392 	memcpy(wr_buf, rd_buf, block_size * num_blocks);
393 
394 	if (wr_md_buf != NULL) {
395 		memcpy(wr_md_buf, rd_md_buf, md_size * num_blocks);
396 	}
397 
398 	return true;
399 }
400 
401 static bool
402 verify_data(void *wr_buf, int wr_buf_len, void *rd_buf, int rd_buf_len, int block_size,
403 	    void *wr_md_buf, void *rd_md_buf, int md_size, int num_blocks, bool md_check)
404 {
405 	int offset_blocks = 0, md_offset, data_block_size;
406 
407 	if (wr_buf_len < num_blocks * block_size || rd_buf_len < num_blocks * block_size) {
408 		return false;
409 	}
410 
411 	assert((wr_md_buf != NULL) == (rd_md_buf != NULL));
412 
413 	if (wr_md_buf == NULL) {
414 		data_block_size = block_size - md_size;
415 		wr_md_buf = (char *)wr_buf + data_block_size;
416 		rd_md_buf = (char *)rd_buf + data_block_size;
417 		md_offset = block_size;
418 	} else {
419 		data_block_size = block_size;
420 		md_offset = md_size;
421 	}
422 
423 	while (offset_blocks < num_blocks) {
424 		if (memcmp(wr_buf, rd_buf, data_block_size) != 0) {
425 			return false;
426 		}
427 
428 		wr_buf += block_size;
429 		rd_buf += block_size;
430 
431 		if (md_check) {
432 			if (memcmp(wr_md_buf, rd_md_buf, md_size) != 0) {
433 				return false;
434 			}
435 
436 			wr_md_buf += md_offset;
437 			rd_md_buf += md_offset;
438 		}
439 
440 		offset_blocks++;
441 	}
442 
443 	return true;
444 }
445 
446 static void
447 free_job_config(void)
448 {
449 	struct job_config *config, *tmp;
450 
451 	spdk_conf_free(g_bdevperf_conf);
452 	g_bdevperf_conf = NULL;
453 
454 	TAILQ_FOREACH_SAFE(config, &job_config_list, link, tmp) {
455 		TAILQ_REMOVE(&job_config_list, config, link);
456 		free(config);
457 	}
458 }
459 
460 static void
461 bdevperf_job_free(struct bdevperf_job *job)
462 {
463 	spdk_histogram_data_free(job->histogram);
464 	spdk_bit_array_free(&job->outstanding);
465 	spdk_bit_array_free(&job->random_map);
466 	spdk_zipf_free(&job->zipf);
467 	free(job->name);
468 	free(job);
469 }
470 
471 static void
472 job_thread_exit(void *ctx)
473 {
474 	spdk_thread_exit(spdk_get_thread());
475 }
476 
477 static void
478 check_cutoff(void *ctx, uint64_t start, uint64_t end, uint64_t count,
479 	     uint64_t total, uint64_t so_far)
480 {
481 	double so_far_pct;
482 	double **cutoff = ctx;
483 	uint64_t tsc_rate;
484 
485 	if (count == 0) {
486 		return;
487 	}
488 
489 	tsc_rate = spdk_get_ticks_hz();
490 	so_far_pct = (double)so_far / total;
491 	while (so_far_pct >= **cutoff && **cutoff > 0) {
492 		printf("%9.5f%% : %9.3fus\n", **cutoff * 100, (double)end * SPDK_SEC_TO_USEC / tsc_rate);
493 		(*cutoff)++;
494 	}
495 }
496 
497 static void
498 print_bucket(void *ctx, uint64_t start, uint64_t end, uint64_t count,
499 	     uint64_t total, uint64_t so_far)
500 {
501 	double so_far_pct;
502 	uint64_t tsc_rate;
503 
504 	if (count == 0) {
505 		return;
506 	}
507 
508 	tsc_rate = spdk_get_ticks_hz();
509 	so_far_pct = (double)so_far * 100 / total;
510 	printf("%9.3f - %9.3f: %9.4f%%  (%9ju)\n",
511 	       (double)start * SPDK_SEC_TO_USEC / tsc_rate,
512 	       (double)end * SPDK_SEC_TO_USEC / tsc_rate,
513 	       so_far_pct, count);
514 }
515 
516 static void
517 bdevperf_test_done(void *ctx)
518 {
519 	struct bdevperf_job *job, *jtmp;
520 	struct bdevperf_task *task, *ttmp;
521 	struct lcore_thread *lthread, *lttmp;
522 	double average_latency = 0.0;
523 	uint64_t time_in_usec;
524 	int rc;
525 
526 	if (g_time_in_usec) {
527 		g_stats.io_time_in_usec = g_time_in_usec;
528 
529 		if (!g_run_rc && g_performance_dump_active) {
530 			spdk_thread_send_msg(spdk_get_thread(), bdevperf_test_done, NULL);
531 			return;
532 		}
533 	}
534 
535 	if (g_show_performance_real_time) {
536 		spdk_poller_unregister(&g_perf_timer);
537 	}
538 
539 	if (g_shutdown) {
540 		g_shutdown_tsc = spdk_get_ticks() - g_start_tsc;
541 		time_in_usec = g_shutdown_tsc * SPDK_SEC_TO_USEC / spdk_get_ticks_hz();
542 		g_time_in_usec = (g_time_in_usec > time_in_usec) ? time_in_usec : g_time_in_usec;
543 		printf("Received shutdown signal, test time was about %.6f seconds\n",
544 		       (double)g_time_in_usec / SPDK_SEC_TO_USEC);
545 	}
546 
547 	printf("\n%*s\n", 107, "Latency(us)");
548 	printf("\r %-*s: %10s %10s %10s %10s %8s %10s %10s %10s\n",
549 	       28, "Device Information", "runtime(s)", "IOPS", "MiB/s", "Fail/s", "TO/s", "Average", "min", "max");
550 
551 	TAILQ_FOREACH_SAFE(job, &g_bdevperf.jobs, link, jtmp) {
552 		performance_dump_job(&g_stats, job);
553 	}
554 
555 	printf("\r =================================================================================="
556 	       "=================================\n");
557 	printf("\r %-28s: %10s %10.2f %10.2f",
558 	       "Total", "", g_stats.total_io_per_second, g_stats.total_mb_per_second);
559 	printf(" %10.2f %8.2f",
560 	       g_stats.total_failed_per_second, g_stats.total_timeout_per_second);
561 
562 	if (g_stats.total_io_completed != 0) {
563 		average_latency = ((double)g_stats.total_tsc / g_stats.total_io_completed) * SPDK_SEC_TO_USEC /
564 				  spdk_get_ticks_hz();
565 	}
566 	printf(" %10.2f %10.2f %10.2f\n", average_latency, g_stats.min_latency, g_stats.max_latency);
567 
568 	fflush(stdout);
569 
570 	if (g_latency_display_level == 0 || g_stats.total_io_completed == 0) {
571 		goto clean;
572 	}
573 
574 	printf("\n Latency summary\n");
575 	TAILQ_FOREACH_SAFE(job, &g_bdevperf.jobs, link, jtmp) {
576 		printf("\r =============================================\n");
577 		printf("\r Job: %s (Core Mask 0x%s)\n", job->name,
578 		       spdk_cpuset_fmt(spdk_thread_get_cpumask(job->thread)));
579 
580 		const double *cutoff = g_latency_cutoffs;
581 
582 		spdk_histogram_data_iterate(job->histogram, check_cutoff, &cutoff);
583 
584 		printf("\n");
585 	}
586 
587 	if (g_latency_display_level == 1) {
588 		goto clean;
589 	}
590 
591 	printf("\r Latency histogram\n");
592 	TAILQ_FOREACH_SAFE(job, &g_bdevperf.jobs, link, jtmp) {
593 		printf("\r =============================================\n");
594 		printf("\r Job: %s (Core Mask 0x%s)\n", job->name,
595 		       spdk_cpuset_fmt(spdk_thread_get_cpumask(job->thread)));
596 
597 		spdk_histogram_data_iterate(job->histogram, print_bucket, NULL);
598 		printf("\n");
599 	}
600 
601 clean:
602 	TAILQ_FOREACH_SAFE(job, &g_bdevperf.jobs, link, jtmp) {
603 		TAILQ_REMOVE(&g_bdevperf.jobs, job, link);
604 
605 		if (!g_one_thread_per_lcore) {
606 			spdk_thread_send_msg(job->thread, job_thread_exit, NULL);
607 		}
608 
609 		TAILQ_FOREACH_SAFE(task, &job->task_list, link, ttmp) {
610 			TAILQ_REMOVE(&job->task_list, task, link);
611 			spdk_free(task->buf);
612 			spdk_free(task->md_buf);
613 			free(task);
614 		}
615 
616 		bdevperf_job_free(job);
617 	}
618 
619 	if (g_one_thread_per_lcore) {
620 		TAILQ_FOREACH_SAFE(lthread, &g_lcore_thread_list, link, lttmp) {
621 			TAILQ_REMOVE(&g_lcore_thread_list, lthread, link);
622 			spdk_thread_send_msg(lthread->thread, job_thread_exit, NULL);
623 			free(lthread);
624 		}
625 	}
626 
627 	rc = g_run_rc;
628 	if (g_request && !g_shutdown) {
629 		rpc_perform_tests_cb();
630 		if (rc != 0) {
631 			spdk_app_stop(rc);
632 		}
633 	} else {
634 		spdk_app_stop(rc);
635 	}
636 }
637 
638 static void
639 bdevperf_job_end(void *ctx)
640 {
641 	assert(g_main_thread == spdk_get_thread());
642 
643 	if (--g_bdevperf.running_jobs == 0) {
644 		bdevperf_test_done(NULL);
645 	}
646 }
647 
648 static void
649 bdevperf_channel_get_histogram_cb(void *cb_arg, int status, struct spdk_histogram_data *histogram)
650 {
651 	struct spdk_histogram_data *job_hist = cb_arg;
652 
653 	if (status == 0) {
654 		spdk_histogram_data_merge(job_hist, histogram);
655 	}
656 }
657 
658 static void
659 bdevperf_job_empty(struct bdevperf_job *job)
660 {
661 	uint64_t end_tsc = 0;
662 
663 	end_tsc = spdk_get_ticks() - g_start_tsc;
664 	job->run_time_in_usec = end_tsc * SPDK_SEC_TO_USEC / spdk_get_ticks_hz();
665 	/* keep histogram info before channel is destroyed */
666 	spdk_bdev_channel_get_histogram(job->ch, bdevperf_channel_get_histogram_cb,
667 					job->histogram);
668 	spdk_put_io_channel(job->ch);
669 	spdk_bdev_close(job->bdev_desc);
670 	spdk_thread_send_msg(g_main_thread, bdevperf_job_end, NULL);
671 }
672 
673 static void
674 bdevperf_end_task(struct bdevperf_task *task)
675 {
676 	struct bdevperf_job     *job = task->job;
677 
678 	TAILQ_INSERT_TAIL(&job->task_list, task, link);
679 	if (job->is_draining) {
680 		if (job->current_queue_depth == 0) {
681 			bdevperf_job_empty(job);
682 		}
683 	}
684 }
685 
686 static void
687 bdevperf_queue_io_wait_with_cb(struct bdevperf_task *task, spdk_bdev_io_wait_cb cb_fn)
688 {
689 	struct bdevperf_job	*job = task->job;
690 
691 	task->bdev_io_wait.bdev = job->bdev;
692 	task->bdev_io_wait.cb_fn = cb_fn;
693 	task->bdev_io_wait.cb_arg = task;
694 	spdk_bdev_queue_io_wait(job->bdev, job->ch, &task->bdev_io_wait);
695 }
696 
697 static int
698 bdevperf_job_drain(void *ctx)
699 {
700 	struct bdevperf_job *job = ctx;
701 
702 	spdk_poller_unregister(&job->run_timer);
703 	if (job->reset) {
704 		spdk_poller_unregister(&job->reset_timer);
705 	}
706 
707 	job->is_draining = true;
708 
709 	return -1;
710 }
711 
712 static int
713 bdevperf_job_drain_timer(void *ctx)
714 {
715 	struct bdevperf_job *job = ctx;
716 
717 	bdevperf_job_drain(ctx);
718 	if (job->current_queue_depth == 0) {
719 		bdevperf_job_empty(job);
720 	}
721 
722 	return SPDK_POLLER_BUSY;
723 }
724 
725 static void
726 bdevperf_abort_complete(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
727 {
728 	struct bdevperf_task	*task = cb_arg;
729 	struct bdevperf_job	*job = task->job;
730 
731 	job->current_queue_depth--;
732 
733 	if (success) {
734 		job->io_completed++;
735 	} else {
736 		job->io_failed++;
737 		if (!job->continue_on_failure) {
738 			bdevperf_job_drain(job);
739 			g_run_rc = -1;
740 		}
741 	}
742 
743 	spdk_bdev_free_io(bdev_io);
744 	bdevperf_end_task(task);
745 }
746 
747 static int
748 bdevperf_verify_dif(struct bdevperf_task *task, struct iovec *iovs, int iovcnt)
749 {
750 	struct bdevperf_job	*job = task->job;
751 	struct spdk_bdev	*bdev = job->bdev;
752 	struct spdk_dif_ctx	dif_ctx;
753 	struct spdk_dif_error	err_blk = {};
754 	int			rc;
755 
756 	rc = spdk_dif_ctx_init(&dif_ctx,
757 			       spdk_bdev_get_block_size(bdev),
758 			       spdk_bdev_get_md_size(bdev),
759 			       spdk_bdev_is_md_interleaved(bdev),
760 			       spdk_bdev_is_dif_head_of_md(bdev),
761 			       spdk_bdev_get_dif_type(bdev),
762 			       job->dif_check_flags,
763 			       task->offset_blocks, 0, 0, 0, 0);
764 	if (rc != 0) {
765 		fprintf(stderr, "Initialization of DIF context failed\n");
766 		return rc;
767 	}
768 
769 	if (spdk_bdev_is_md_interleaved(bdev)) {
770 		rc = spdk_dif_verify(iovs, iovcnt, job->io_size_blocks, &dif_ctx, &err_blk);
771 	} else {
772 		struct iovec md_iov = {
773 			.iov_base	= task->md_buf,
774 			.iov_len	= spdk_bdev_get_md_size(bdev) * job->io_size_blocks,
775 		};
776 
777 		rc = spdk_dix_verify(iovs, iovcnt, &md_iov, job->io_size_blocks, &dif_ctx, &err_blk);
778 	}
779 
780 	if (rc != 0) {
781 		fprintf(stderr, "DIF/DIX error detected. type=%d, offset=%" PRIu32 "\n",
782 			err_blk.err_type, err_blk.err_offset);
783 	}
784 
785 	return rc;
786 }
787 
788 static void
789 bdevperf_complete(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
790 {
791 	struct bdevperf_job	*job;
792 	struct bdevperf_task	*task = cb_arg;
793 	struct iovec		*iovs;
794 	int			iovcnt;
795 	bool			md_check;
796 	uint64_t		offset_in_ios;
797 	int			rc;
798 
799 	job = task->job;
800 	md_check = spdk_bdev_get_dif_type(job->bdev) == SPDK_DIF_DISABLE;
801 
802 	if (g_error_to_exit == true) {
803 		bdevperf_job_drain(job);
804 	} else if (!success) {
805 		if (!job->reset && !job->continue_on_failure) {
806 			bdevperf_job_drain(job);
807 			g_run_rc = -1;
808 			g_error_to_exit = true;
809 			printf("task offset: %" PRIu64 " on job bdev=%s fails\n",
810 			       task->offset_blocks, job->name);
811 		}
812 	} else if (job->verify || job->reset) {
813 		spdk_bdev_io_get_iovec(bdev_io, &iovs, &iovcnt);
814 		assert(iovcnt == 1);
815 		assert(iovs != NULL);
816 		if (!verify_data(task->buf, job->buf_size, iovs[0].iov_base, iovs[0].iov_len,
817 				 spdk_bdev_get_block_size(job->bdev),
818 				 task->md_buf, spdk_bdev_io_get_md_buf(bdev_io),
819 				 spdk_bdev_get_md_size(job->bdev),
820 				 job->io_size_blocks, md_check)) {
821 			printf("Buffer mismatch! Target: %s Disk Offset: %" PRIu64 "\n", job->name, task->offset_blocks);
822 			printf("   First dword expected 0x%x got 0x%x\n", *(int *)task->buf, *(int *)iovs[0].iov_base);
823 			bdevperf_job_drain(job);
824 			g_run_rc = -1;
825 		}
826 	} else if (job->dif_check_flags != 0) {
827 		if (task->io_type == SPDK_BDEV_IO_TYPE_READ && spdk_bdev_get_md_size(job->bdev) != 0) {
828 			spdk_bdev_io_get_iovec(bdev_io, &iovs, &iovcnt);
829 			assert(iovcnt == 1);
830 			assert(iovs != NULL);
831 			rc = bdevperf_verify_dif(task, iovs, iovcnt);
832 			if (rc != 0) {
833 				printf("DIF error detected. task offset: %" PRIu64 " on job bdev=%s\n",
834 				       task->offset_blocks, job->name);
835 
836 				success = false;
837 				if (!job->reset && !job->continue_on_failure) {
838 					bdevperf_job_drain(job);
839 					g_run_rc = -1;
840 					g_error_to_exit = true;
841 				}
842 			}
843 		}
844 	}
845 
846 	job->current_queue_depth--;
847 
848 	if (success) {
849 		job->io_completed++;
850 	} else {
851 		job->io_failed++;
852 	}
853 
854 	if (job->verify) {
855 		assert(task->offset_blocks / job->io_size_blocks >= job->ios_base);
856 		offset_in_ios = task->offset_blocks / job->io_size_blocks - job->ios_base;
857 
858 		assert(spdk_bit_array_get(job->outstanding, offset_in_ios) == true);
859 		spdk_bit_array_clear(job->outstanding, offset_in_ios);
860 	}
861 
862 	spdk_bdev_free_io(bdev_io);
863 
864 	/*
865 	 * is_draining indicates when time has expired for the test run
866 	 * and we are just waiting for the previously submitted I/O
867 	 * to complete.  In this case, do not submit a new I/O to replace
868 	 * the one just completed.
869 	 */
870 	if (!job->is_draining) {
871 		bdevperf_submit_single(job, task);
872 	} else {
873 		bdevperf_end_task(task);
874 	}
875 }
876 
877 static void
878 bdevperf_verify_submit_read(void *cb_arg)
879 {
880 	struct bdevperf_job	*job;
881 	struct bdevperf_task	*task = cb_arg;
882 	int			rc;
883 
884 	job = task->job;
885 
886 	/* Read the data back in */
887 	rc = spdk_bdev_read_blocks_with_md(job->bdev_desc, job->ch, NULL, NULL,
888 					   task->offset_blocks, job->io_size_blocks,
889 					   bdevperf_complete, task);
890 
891 	if (rc == -ENOMEM) {
892 		bdevperf_queue_io_wait_with_cb(task, bdevperf_verify_submit_read);
893 	} else if (rc != 0) {
894 		printf("Failed to submit read: %d\n", rc);
895 		bdevperf_job_drain(job);
896 		g_run_rc = rc;
897 	}
898 }
899 
900 static void
901 bdevperf_verify_write_complete(struct spdk_bdev_io *bdev_io, bool success,
902 			       void *cb_arg)
903 {
904 	if (success) {
905 		spdk_bdev_free_io(bdev_io);
906 		bdevperf_verify_submit_read(cb_arg);
907 	} else {
908 		bdevperf_complete(bdev_io, success, cb_arg);
909 	}
910 }
911 
912 static void
913 bdevperf_zcopy_populate_complete(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
914 {
915 	if (!success) {
916 		bdevperf_complete(bdev_io, success, cb_arg);
917 		return;
918 	}
919 
920 	spdk_bdev_zcopy_end(bdev_io, false, bdevperf_complete, cb_arg);
921 }
922 
923 static int
924 bdevperf_generate_dif(struct bdevperf_task *task)
925 {
926 	struct bdevperf_job	*job = task->job;
927 	struct spdk_bdev	*bdev = job->bdev;
928 	struct spdk_dif_ctx	dif_ctx;
929 	int			rc;
930 
931 	rc = spdk_dif_ctx_init(&dif_ctx,
932 			       spdk_bdev_get_block_size(bdev),
933 			       spdk_bdev_get_md_size(bdev),
934 			       spdk_bdev_is_md_interleaved(bdev),
935 			       spdk_bdev_is_dif_head_of_md(bdev),
936 			       spdk_bdev_get_dif_type(bdev),
937 			       job->dif_check_flags,
938 			       task->offset_blocks, 0, 0, 0, 0);
939 	if (rc != 0) {
940 		fprintf(stderr, "Initialization of DIF context failed\n");
941 		return rc;
942 	}
943 
944 	if (spdk_bdev_is_md_interleaved(bdev)) {
945 		rc = spdk_dif_generate(&task->iov, 1, job->io_size_blocks, &dif_ctx);
946 	} else {
947 		struct iovec md_iov = {
948 			.iov_base	= task->md_buf,
949 			.iov_len	= spdk_bdev_get_md_size(bdev) * job->io_size_blocks,
950 		};
951 
952 		rc = spdk_dix_generate(&task->iov, 1, &md_iov, job->io_size_blocks, &dif_ctx);
953 	}
954 
955 	if (rc != 0) {
956 		fprintf(stderr, "Generation of DIF/DIX failed\n");
957 	}
958 
959 	return rc;
960 }
961 
962 static void
963 bdevperf_submit_task(void *arg)
964 {
965 	struct bdevperf_task	*task = arg;
966 	struct bdevperf_job	*job = task->job;
967 	struct spdk_bdev_desc	*desc;
968 	struct spdk_io_channel	*ch;
969 	spdk_bdev_io_completion_cb cb_fn;
970 	uint64_t		offset_in_ios;
971 	int			rc = 0;
972 
973 	desc = job->bdev_desc;
974 	ch = job->ch;
975 
976 	switch (task->io_type) {
977 	case SPDK_BDEV_IO_TYPE_WRITE:
978 		if (spdk_bdev_get_md_size(job->bdev) != 0 && job->dif_check_flags != 0) {
979 			rc = bdevperf_generate_dif(task);
980 		}
981 		if (rc == 0) {
982 			cb_fn = (job->verify || job->reset) ? bdevperf_verify_write_complete : bdevperf_complete;
983 
984 			if (g_zcopy) {
985 				spdk_bdev_zcopy_end(task->bdev_io, true, cb_fn, task);
986 				return;
987 			} else {
988 				rc = spdk_bdev_writev_blocks_with_md(desc, ch, &task->iov, 1,
989 								     task->md_buf,
990 								     task->offset_blocks,
991 								     job->io_size_blocks,
992 								     cb_fn, task);
993 			}
994 		}
995 		break;
996 	case SPDK_BDEV_IO_TYPE_FLUSH:
997 		rc = spdk_bdev_flush_blocks(desc, ch, task->offset_blocks,
998 					    job->io_size_blocks, bdevperf_complete, task);
999 		break;
1000 	case SPDK_BDEV_IO_TYPE_UNMAP:
1001 		rc = spdk_bdev_unmap_blocks(desc, ch, task->offset_blocks,
1002 					    job->io_size_blocks, bdevperf_complete, task);
1003 		break;
1004 	case SPDK_BDEV_IO_TYPE_WRITE_ZEROES:
1005 		rc = spdk_bdev_write_zeroes_blocks(desc, ch, task->offset_blocks,
1006 						   job->io_size_blocks, bdevperf_complete, task);
1007 		break;
1008 	case SPDK_BDEV_IO_TYPE_READ:
1009 		if (g_zcopy) {
1010 			rc = spdk_bdev_zcopy_start(desc, ch, NULL, 0, task->offset_blocks, job->io_size_blocks,
1011 						   true, bdevperf_zcopy_populate_complete, task);
1012 		} else {
1013 			rc = spdk_bdev_read_blocks_with_md(desc, ch, task->buf, task->md_buf,
1014 							   task->offset_blocks,
1015 							   job->io_size_blocks,
1016 							   bdevperf_complete, task);
1017 		}
1018 		break;
1019 	case SPDK_BDEV_IO_TYPE_ABORT:
1020 		rc = spdk_bdev_abort(desc, ch, task->task_to_abort, bdevperf_abort_complete, task);
1021 		break;
1022 	default:
1023 		assert(false);
1024 		rc = -EINVAL;
1025 		break;
1026 	}
1027 
1028 	if (rc == -ENOMEM) {
1029 		bdevperf_queue_io_wait_with_cb(task, bdevperf_submit_task);
1030 		return;
1031 	} else if (rc != 0) {
1032 		printf("Failed to submit bdev_io: %d\n", rc);
1033 		if (job->verify) {
1034 			assert(task->offset_blocks / job->io_size_blocks >= job->ios_base);
1035 			offset_in_ios = task->offset_blocks / job->io_size_blocks - job->ios_base;
1036 
1037 			assert(spdk_bit_array_get(job->outstanding, offset_in_ios) == true);
1038 			spdk_bit_array_clear(job->outstanding, offset_in_ios);
1039 		}
1040 		bdevperf_job_drain(job);
1041 		g_run_rc = rc;
1042 		return;
1043 	}
1044 
1045 	job->current_queue_depth++;
1046 }
1047 
1048 static void
1049 bdevperf_zcopy_get_buf_complete(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
1050 {
1051 	struct bdevperf_task	*task = cb_arg;
1052 	struct bdevperf_job	*job = task->job;
1053 	struct iovec		*iovs;
1054 	int			iovcnt;
1055 
1056 	if (!success) {
1057 		bdevperf_job_drain(job);
1058 		g_run_rc = -1;
1059 		return;
1060 	}
1061 
1062 	task->bdev_io = bdev_io;
1063 	task->io_type = SPDK_BDEV_IO_TYPE_WRITE;
1064 
1065 	if (job->verify || job->reset) {
1066 		/* When job->verify or job->reset is enabled, task->buf is used for
1067 		 *  verification of read after write.  For write I/O, when zcopy APIs
1068 		 *  are used, task->buf cannot be used, and data must be written to
1069 		 *  the data buffer allocated underneath bdev layer instead.
1070 		 *  Hence we copy task->buf to the allocated data buffer here.
1071 		 */
1072 		spdk_bdev_io_get_iovec(bdev_io, &iovs, &iovcnt);
1073 		assert(iovcnt == 1);
1074 		assert(iovs != NULL);
1075 
1076 		copy_data(iovs[0].iov_base, iovs[0].iov_len, task->buf, job->buf_size,
1077 			  spdk_bdev_get_block_size(job->bdev),
1078 			  spdk_bdev_io_get_md_buf(bdev_io), task->md_buf,
1079 			  spdk_bdev_get_md_size(job->bdev), job->io_size_blocks);
1080 	}
1081 
1082 	bdevperf_submit_task(task);
1083 }
1084 
1085 static void
1086 bdevperf_prep_zcopy_write_task(void *arg)
1087 {
1088 	struct bdevperf_task	*task = arg;
1089 	struct bdevperf_job	*job = task->job;
1090 	int			rc;
1091 
1092 	rc = spdk_bdev_zcopy_start(job->bdev_desc, job->ch, NULL, 0,
1093 				   task->offset_blocks, job->io_size_blocks,
1094 				   false, bdevperf_zcopy_get_buf_complete, task);
1095 	if (rc != 0) {
1096 		assert(rc == -ENOMEM);
1097 		bdevperf_queue_io_wait_with_cb(task, bdevperf_prep_zcopy_write_task);
1098 		return;
1099 	}
1100 
1101 	job->current_queue_depth++;
1102 }
1103 
1104 static struct bdevperf_task *
1105 bdevperf_job_get_task(struct bdevperf_job *job)
1106 {
1107 	struct bdevperf_task *task;
1108 
1109 	task = TAILQ_FIRST(&job->task_list);
1110 	if (!task) {
1111 		printf("Task allocation failed\n");
1112 		abort();
1113 	}
1114 
1115 	TAILQ_REMOVE(&job->task_list, task, link);
1116 	return task;
1117 }
1118 
1119 static void
1120 bdevperf_submit_single(struct bdevperf_job *job, struct bdevperf_task *task)
1121 {
1122 	uint64_t offset_in_ios;
1123 	uint64_t rand_value;
1124 	uint32_t first_clear;
1125 
1126 	if (job->zipf) {
1127 		offset_in_ios = spdk_zipf_generate(job->zipf);
1128 	} else if (job->is_random) {
1129 		/* RAND_MAX is only INT32_MAX, so use 2 calls to rand_r to
1130 		 * get a large enough value to ensure we are issuing I/O
1131 		 * uniformly across the whole bdev.
1132 		 */
1133 		rand_value = (uint64_t)rand_r(&job->seed) * RAND_MAX + rand_r(&job->seed);
1134 		offset_in_ios = rand_value % job->size_in_ios;
1135 
1136 		if (g_random_map) {
1137 			/* Make sure, that the offset does not exceed the maximum size
1138 			 * of the bit array (verified during job creation)
1139 			 */
1140 			assert(offset_in_ios < UINT32_MAX);
1141 
1142 			first_clear = spdk_bit_array_find_first_clear(job->random_map, (uint32_t)offset_in_ios);
1143 
1144 			if (first_clear == UINT32_MAX) {
1145 				first_clear = spdk_bit_array_find_first_clear(job->random_map, 0);
1146 
1147 				if (first_clear == UINT32_MAX) {
1148 					/* If there are no more clear bits in the array, we start over
1149 					 * and select the previously selected random value.
1150 					 */
1151 					spdk_bit_array_clear_mask(job->random_map);
1152 					first_clear = (uint32_t)offset_in_ios;
1153 				}
1154 			}
1155 
1156 			spdk_bit_array_set(job->random_map, first_clear);
1157 
1158 			offset_in_ios = first_clear;
1159 		}
1160 	} else {
1161 		offset_in_ios = job->offset_in_ios++;
1162 		if (job->offset_in_ios == job->size_in_ios) {
1163 			job->offset_in_ios = 0;
1164 		}
1165 
1166 		/* Increment of offset_in_ios if there's already an outstanding IO
1167 		 * to that location. We only need this with job->verify as random
1168 		 * offsets are not supported with job->verify at this time.
1169 		 */
1170 		if (job->verify) {
1171 			assert(spdk_bit_array_find_first_clear(job->outstanding, 0) != UINT32_MAX);
1172 
1173 			while (spdk_bit_array_get(job->outstanding, offset_in_ios)) {
1174 				offset_in_ios = job->offset_in_ios++;
1175 				if (job->offset_in_ios == job->size_in_ios) {
1176 					job->offset_in_ios = 0;
1177 				}
1178 			}
1179 			spdk_bit_array_set(job->outstanding, offset_in_ios);
1180 		}
1181 	}
1182 
1183 	/* For multi-thread to same job, offset_in_ios is relative
1184 	 * to the LBA range assigned for that job. job->offset_blocks
1185 	 * is absolute (entire bdev LBA range).
1186 	 */
1187 	task->offset_blocks = (offset_in_ios + job->ios_base) * job->io_size_blocks;
1188 
1189 	if (job->verify || job->reset) {
1190 		generate_data(task->buf, job->buf_size,
1191 			      spdk_bdev_get_block_size(job->bdev),
1192 			      task->md_buf, spdk_bdev_get_md_size(job->bdev),
1193 			      job->io_size_blocks);
1194 		if (g_zcopy) {
1195 			bdevperf_prep_zcopy_write_task(task);
1196 			return;
1197 		} else {
1198 			task->iov.iov_base = task->buf;
1199 			task->iov.iov_len = job->buf_size;
1200 			task->io_type = SPDK_BDEV_IO_TYPE_WRITE;
1201 		}
1202 	} else if (job->flush) {
1203 		task->io_type = SPDK_BDEV_IO_TYPE_FLUSH;
1204 	} else if (job->unmap) {
1205 		task->io_type = SPDK_BDEV_IO_TYPE_UNMAP;
1206 	} else if (job->write_zeroes) {
1207 		task->io_type = SPDK_BDEV_IO_TYPE_WRITE_ZEROES;
1208 	} else if ((job->rw_percentage == 100) ||
1209 		   (job->rw_percentage != 0 && ((rand_r(&job->seed) % 100) < job->rw_percentage))) {
1210 		task->io_type = SPDK_BDEV_IO_TYPE_READ;
1211 	} else {
1212 		if (g_zcopy) {
1213 			bdevperf_prep_zcopy_write_task(task);
1214 			return;
1215 		} else {
1216 			task->iov.iov_base = task->buf;
1217 			task->iov.iov_len = job->buf_size;
1218 			task->io_type = SPDK_BDEV_IO_TYPE_WRITE;
1219 		}
1220 	}
1221 
1222 	bdevperf_submit_task(task);
1223 }
1224 
1225 static int reset_job(void *arg);
1226 
1227 static void
1228 reset_cb(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
1229 {
1230 	struct bdevperf_task	*task = cb_arg;
1231 	struct bdevperf_job	*job = task->job;
1232 
1233 	if (!success) {
1234 		printf("Reset blockdev=%s failed\n", spdk_bdev_get_name(job->bdev));
1235 		bdevperf_job_drain(job);
1236 		g_run_rc = -1;
1237 	}
1238 
1239 	TAILQ_INSERT_TAIL(&job->task_list, task, link);
1240 	spdk_bdev_free_io(bdev_io);
1241 
1242 	job->reset_timer = SPDK_POLLER_REGISTER(reset_job, job,
1243 						10 * SPDK_SEC_TO_USEC);
1244 }
1245 
1246 static int
1247 reset_job(void *arg)
1248 {
1249 	struct bdevperf_job *job = arg;
1250 	struct bdevperf_task *task;
1251 	int rc;
1252 
1253 	spdk_poller_unregister(&job->reset_timer);
1254 
1255 	/* Do reset. */
1256 	task = bdevperf_job_get_task(job);
1257 	rc = spdk_bdev_reset(job->bdev_desc, job->ch,
1258 			     reset_cb, task);
1259 	if (rc) {
1260 		printf("Reset failed: %d\n", rc);
1261 		bdevperf_job_drain(job);
1262 		g_run_rc = -1;
1263 	}
1264 
1265 	return -1;
1266 }
1267 
1268 static void
1269 bdevperf_timeout_cb(void *cb_arg, struct spdk_bdev_io *bdev_io)
1270 {
1271 	struct bdevperf_job *job = cb_arg;
1272 	struct bdevperf_task *task;
1273 
1274 	job->io_timeout++;
1275 
1276 	if (job->is_draining || !job->abort ||
1277 	    !spdk_bdev_io_type_supported(job->bdev, SPDK_BDEV_IO_TYPE_ABORT)) {
1278 		return;
1279 	}
1280 
1281 	task = bdevperf_job_get_task(job);
1282 	if (task == NULL) {
1283 		return;
1284 	}
1285 
1286 	task->task_to_abort = spdk_bdev_io_get_cb_arg(bdev_io);
1287 	task->io_type = SPDK_BDEV_IO_TYPE_ABORT;
1288 
1289 	bdevperf_submit_task(task);
1290 }
1291 
1292 static void
1293 bdevperf_job_run(void *ctx)
1294 {
1295 	struct bdevperf_job *job = ctx;
1296 	struct bdevperf_task *task;
1297 	int i;
1298 
1299 	/* Submit initial I/O for this job. Each time one
1300 	 * completes, another will be submitted. */
1301 
1302 	/* Start a timer to stop this I/O chain when the run is over */
1303 	job->run_timer = SPDK_POLLER_REGISTER(bdevperf_job_drain_timer, job, g_time_in_usec);
1304 	if (job->reset) {
1305 		job->reset_timer = SPDK_POLLER_REGISTER(reset_job, job,
1306 							10 * SPDK_SEC_TO_USEC);
1307 	}
1308 
1309 	spdk_bdev_set_timeout(job->bdev_desc, g_timeout_in_sec, bdevperf_timeout_cb, job);
1310 
1311 	for (i = 0; i < job->queue_depth; i++) {
1312 		task = bdevperf_job_get_task(job);
1313 		bdevperf_submit_single(job, task);
1314 	}
1315 }
1316 
1317 static void
1318 _performance_dump_done(void *ctx)
1319 {
1320 	struct bdevperf_aggregate_stats *stats = ctx;
1321 	double average_latency;
1322 
1323 	printf("\r =================================================================================="
1324 	       "=================================\n");
1325 	printf("\r %-28s: %10s %10.2f %10.2f",
1326 	       "Total", "", stats->total_io_per_second, stats->total_mb_per_second);
1327 	printf(" %10.2f %8.2f",
1328 	       stats->total_failed_per_second, stats->total_timeout_per_second);
1329 
1330 	average_latency = ((double)stats->total_tsc / stats->total_io_completed) * SPDK_SEC_TO_USEC /
1331 			  spdk_get_ticks_hz();
1332 	printf(" %10.2f %10.2f %10.2f\n", average_latency, stats->min_latency, stats->max_latency);
1333 	printf("\n");
1334 
1335 	fflush(stdout);
1336 
1337 	g_performance_dump_active = false;
1338 
1339 	free(stats);
1340 }
1341 
1342 static void
1343 _performance_dump(void *ctx)
1344 {
1345 	struct bdevperf_aggregate_stats *stats = ctx;
1346 
1347 	performance_dump_job(stats, stats->current_job);
1348 
1349 	/* This assumes the jobs list is static after start up time.
1350 	 * That's true right now, but if that ever changed this would need a lock. */
1351 	stats->current_job = TAILQ_NEXT(stats->current_job, link);
1352 	if (stats->current_job == NULL) {
1353 		spdk_thread_send_msg(g_main_thread, _performance_dump_done, stats);
1354 	} else {
1355 		spdk_thread_send_msg(stats->current_job->thread, _performance_dump, stats);
1356 	}
1357 }
1358 
1359 static int
1360 performance_statistics_thread(void *arg)
1361 {
1362 	struct bdevperf_aggregate_stats *stats;
1363 
1364 	if (g_performance_dump_active) {
1365 		return -1;
1366 	}
1367 
1368 	g_performance_dump_active = true;
1369 
1370 	stats = calloc(1, sizeof(*stats));
1371 	if (stats == NULL) {
1372 		return -1;
1373 	}
1374 
1375 	stats->min_latency = (double)UINT64_MAX;
1376 
1377 	g_show_performance_period_num++;
1378 
1379 	stats->io_time_in_usec = g_show_performance_period_num * g_show_performance_period_in_usec;
1380 	stats->ema_period = g_show_performance_ema_period;
1381 
1382 	/* Iterate all of the jobs to gather stats
1383 	 * These jobs will not get removed here until a final performance dump is run,
1384 	 * so this should be safe without locking.
1385 	 */
1386 	stats->current_job = TAILQ_FIRST(&g_bdevperf.jobs);
1387 	if (stats->current_job == NULL) {
1388 		spdk_thread_send_msg(g_main_thread, _performance_dump_done, stats);
1389 	} else {
1390 		spdk_thread_send_msg(stats->current_job->thread, _performance_dump, stats);
1391 	}
1392 
1393 	return -1;
1394 }
1395 
1396 static void
1397 bdevperf_test(void)
1398 {
1399 	struct bdevperf_job *job;
1400 
1401 	printf("Running I/O for %" PRIu64 " seconds...\n", g_time_in_usec / (uint64_t)SPDK_SEC_TO_USEC);
1402 	fflush(stdout);
1403 
1404 	/* Start a timer to dump performance numbers */
1405 	g_start_tsc = spdk_get_ticks();
1406 	if (g_show_performance_real_time && !g_perf_timer) {
1407 		printf("%*s\n", 107, "Latency(us)");
1408 		printf("\r %-*s: %10s %10s %10s %10s %8s %10s %10s %10s\n",
1409 		       28, "Device Information", "runtime(s)", "IOPS", "MiB/s", "Fail/s", "TO/s", "Average", "min", "max");
1410 
1411 		g_perf_timer = SPDK_POLLER_REGISTER(performance_statistics_thread, NULL,
1412 						    g_show_performance_period_in_usec);
1413 	}
1414 
1415 	/* Iterate jobs to start all I/O */
1416 	TAILQ_FOREACH(job, &g_bdevperf.jobs, link) {
1417 		g_bdevperf.running_jobs++;
1418 		spdk_thread_send_msg(job->thread, bdevperf_job_run, job);
1419 	}
1420 }
1421 
1422 static void
1423 bdevperf_bdev_removed(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *event_ctx)
1424 {
1425 	struct bdevperf_job *job = event_ctx;
1426 
1427 	if (SPDK_BDEV_EVENT_REMOVE == type) {
1428 		bdevperf_job_drain(job);
1429 	}
1430 }
1431 
1432 static void
1433 bdevperf_histogram_status_cb(void *cb_arg, int status)
1434 {
1435 	if (status != 0) {
1436 		g_run_rc = status;
1437 		if (g_continue_on_failure == false) {
1438 			g_error_to_exit = true;
1439 		}
1440 	}
1441 
1442 	if (--g_bdev_count == 0) {
1443 		if (g_run_rc == 0) {
1444 			/* Ready to run the test */
1445 			bdevperf_test();
1446 		} else {
1447 			bdevperf_test_done(NULL);
1448 		}
1449 	}
1450 }
1451 
1452 static uint32_t g_construct_job_count = 0;
1453 
1454 static int
1455 _bdevperf_enable_histogram(void *ctx, struct spdk_bdev *bdev)
1456 {
1457 	bool *enable = ctx;
1458 
1459 	g_bdev_count++;
1460 
1461 	spdk_bdev_histogram_enable(bdev, bdevperf_histogram_status_cb, NULL, *enable);
1462 
1463 	return 0;
1464 }
1465 
1466 static void
1467 bdevperf_enable_histogram(bool enable)
1468 {
1469 	struct spdk_bdev *bdev;
1470 	int rc;
1471 
1472 	/* increment initial g_bdev_count so that it will never reach 0 in the middle of iteration */
1473 	g_bdev_count = 1;
1474 
1475 	if (g_job_bdev_name != NULL) {
1476 		bdev = spdk_bdev_get_by_name(g_job_bdev_name);
1477 		if (bdev) {
1478 			rc = _bdevperf_enable_histogram(&enable, bdev);
1479 		} else {
1480 			fprintf(stderr, "Unable to find bdev '%s'\n", g_job_bdev_name);
1481 			rc = -1;
1482 		}
1483 	} else {
1484 		rc = spdk_for_each_bdev_leaf(&enable, _bdevperf_enable_histogram);
1485 	}
1486 
1487 	bdevperf_histogram_status_cb(NULL, rc);
1488 }
1489 
1490 static void
1491 _bdevperf_construct_job_done(void *ctx)
1492 {
1493 	if (--g_construct_job_count == 0) {
1494 		if (g_run_rc != 0) {
1495 			/* Something failed. */
1496 			bdevperf_test_done(NULL);
1497 			return;
1498 		}
1499 
1500 		/* always enable histogram. */
1501 		bdevperf_enable_histogram(true);
1502 	} else if (g_run_rc != 0) {
1503 		/* Reset error as some jobs constructed right */
1504 		g_run_rc = 0;
1505 		if (g_continue_on_failure == false) {
1506 			g_error_to_exit = true;
1507 		}
1508 	}
1509 }
1510 
1511 /* Checkformat will not allow to use inlined type,
1512    this is a workaround */
1513 typedef struct spdk_thread *spdk_thread_t;
1514 
1515 static spdk_thread_t
1516 construct_job_thread(struct spdk_cpuset *cpumask, const char *tag)
1517 {
1518 	struct spdk_cpuset tmp;
1519 
1520 	/* This function runs on the main thread. */
1521 	assert(g_main_thread == spdk_get_thread());
1522 
1523 	/* Handle default mask */
1524 	if (spdk_cpuset_count(cpumask) == 0) {
1525 		cpumask = &g_all_cpuset;
1526 	}
1527 
1528 	/* Warn user that mask might need to be changed */
1529 	spdk_cpuset_copy(&tmp, cpumask);
1530 	spdk_cpuset_or(&tmp, &g_all_cpuset);
1531 	if (!spdk_cpuset_equal(&tmp, &g_all_cpuset)) {
1532 		fprintf(stderr, "cpumask for '%s' is too big\n", tag);
1533 	}
1534 
1535 	return spdk_thread_create(tag, cpumask);
1536 }
1537 
1538 static uint32_t
1539 _get_next_core(void)
1540 {
1541 	static uint32_t current_core = SPDK_ENV_LCORE_ID_ANY;
1542 
1543 	if (current_core == SPDK_ENV_LCORE_ID_ANY) {
1544 		current_core = spdk_env_get_first_core();
1545 		return current_core;
1546 	}
1547 
1548 	current_core = spdk_env_get_next_core(current_core);
1549 	if (current_core == SPDK_ENV_LCORE_ID_ANY) {
1550 		current_core = spdk_env_get_first_core();
1551 	}
1552 
1553 	return current_core;
1554 }
1555 
1556 static void
1557 _bdevperf_construct_job(void *ctx)
1558 {
1559 	struct bdevperf_job *job = ctx;
1560 	int rc;
1561 
1562 	rc = spdk_bdev_open_ext(spdk_bdev_get_name(job->bdev), true, bdevperf_bdev_removed, job,
1563 				&job->bdev_desc);
1564 	if (rc != 0) {
1565 		SPDK_ERRLOG("Could not open leaf bdev %s, error=%d\n", spdk_bdev_get_name(job->bdev), rc);
1566 		g_run_rc = -EINVAL;
1567 		goto end;
1568 	}
1569 
1570 	if (g_zcopy) {
1571 		if (!spdk_bdev_io_type_supported(job->bdev, SPDK_BDEV_IO_TYPE_ZCOPY)) {
1572 			printf("Test requires ZCOPY but bdev module does not support ZCOPY\n");
1573 			g_run_rc = -ENOTSUP;
1574 			goto end;
1575 		}
1576 	}
1577 
1578 	job->ch = spdk_bdev_get_io_channel(job->bdev_desc);
1579 	if (!job->ch) {
1580 		SPDK_ERRLOG("Could not get io_channel for device %s, error=%d\n", spdk_bdev_get_name(job->bdev),
1581 			    rc);
1582 		spdk_bdev_close(job->bdev_desc);
1583 		TAILQ_REMOVE(&g_bdevperf.jobs, job, link);
1584 		g_run_rc = -ENOMEM;
1585 		goto end;
1586 	}
1587 
1588 end:
1589 	spdk_thread_send_msg(g_main_thread, _bdevperf_construct_job_done, NULL);
1590 }
1591 
1592 static void
1593 job_init_rw(struct bdevperf_job *job, enum job_config_rw rw)
1594 {
1595 	switch (rw) {
1596 	case JOB_CONFIG_RW_READ:
1597 		job->rw_percentage = 100;
1598 		break;
1599 	case JOB_CONFIG_RW_WRITE:
1600 		job->rw_percentage = 0;
1601 		break;
1602 	case JOB_CONFIG_RW_RANDREAD:
1603 		job->is_random = true;
1604 		job->rw_percentage = 100;
1605 		job->seed = rand();
1606 		break;
1607 	case JOB_CONFIG_RW_RANDWRITE:
1608 		job->is_random = true;
1609 		job->rw_percentage = 0;
1610 		job->seed = rand();
1611 		break;
1612 	case JOB_CONFIG_RW_RW:
1613 		job->is_random = false;
1614 		break;
1615 	case JOB_CONFIG_RW_RANDRW:
1616 		job->is_random = true;
1617 		job->seed = rand();
1618 		break;
1619 	case JOB_CONFIG_RW_VERIFY:
1620 		job->verify = true;
1621 		job->rw_percentage = 50;
1622 		break;
1623 	case JOB_CONFIG_RW_RESET:
1624 		job->reset = true;
1625 		job->verify = true;
1626 		job->rw_percentage = 50;
1627 		break;
1628 	case JOB_CONFIG_RW_UNMAP:
1629 		job->unmap = true;
1630 		break;
1631 	case JOB_CONFIG_RW_FLUSH:
1632 		job->flush = true;
1633 		break;
1634 	case JOB_CONFIG_RW_WRITE_ZEROES:
1635 		job->write_zeroes = true;
1636 		break;
1637 	}
1638 }
1639 
1640 static int
1641 bdevperf_construct_job(struct spdk_bdev *bdev, struct job_config *config,
1642 		       struct spdk_thread *thread)
1643 {
1644 	struct bdevperf_job *job;
1645 	struct bdevperf_task *task;
1646 	int block_size, data_block_size;
1647 	int rc;
1648 	int task_num, n;
1649 
1650 	block_size = spdk_bdev_get_block_size(bdev);
1651 	data_block_size = spdk_bdev_get_data_block_size(bdev);
1652 
1653 	job = calloc(1, sizeof(struct bdevperf_job));
1654 	if (!job) {
1655 		fprintf(stderr, "Unable to allocate memory for new job.\n");
1656 		return -ENOMEM;
1657 	}
1658 
1659 	job->name = strdup(spdk_bdev_get_name(bdev));
1660 	if (!job->name) {
1661 		fprintf(stderr, "Unable to allocate memory for job name.\n");
1662 		bdevperf_job_free(job);
1663 		return -ENOMEM;
1664 	}
1665 
1666 	job->workload_type = g_workload_type;
1667 	job->io_size = config->bs;
1668 	job->rw_percentage = config->rwmixread;
1669 	job->continue_on_failure = g_continue_on_failure;
1670 	job->queue_depth = config->iodepth;
1671 	job->bdev = bdev;
1672 	job->io_size_blocks = job->io_size / data_block_size;
1673 	job->buf_size = job->io_size_blocks * block_size;
1674 	job->abort = g_abort;
1675 	job_init_rw(job, config->rw);
1676 
1677 	if ((job->io_size % data_block_size) != 0) {
1678 		SPDK_ERRLOG("IO size (%d) is not multiples of data block size of bdev %s (%"PRIu32")\n",
1679 			    job->io_size, spdk_bdev_get_name(bdev), data_block_size);
1680 		bdevperf_job_free(job);
1681 		return -ENOTSUP;
1682 	}
1683 
1684 	if (job->unmap && !spdk_bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_UNMAP)) {
1685 		printf("Skipping %s because it does not support unmap\n", spdk_bdev_get_name(bdev));
1686 		bdevperf_job_free(job);
1687 		return -ENOTSUP;
1688 	}
1689 
1690 	if (spdk_bdev_is_dif_check_enabled(bdev, SPDK_DIF_CHECK_TYPE_REFTAG)) {
1691 		job->dif_check_flags |= SPDK_DIF_FLAGS_REFTAG_CHECK;
1692 	}
1693 	if (spdk_bdev_is_dif_check_enabled(bdev, SPDK_DIF_CHECK_TYPE_GUARD)) {
1694 		job->dif_check_flags |= SPDK_DIF_FLAGS_GUARD_CHECK;
1695 	}
1696 
1697 	job->offset_in_ios = 0;
1698 
1699 	if (config->length != 0) {
1700 		/* Use subset of disk */
1701 		job->size_in_ios = config->length / job->io_size_blocks;
1702 		job->ios_base = config->offset / job->io_size_blocks;
1703 	} else {
1704 		/* Use whole disk */
1705 		job->size_in_ios = spdk_bdev_get_num_blocks(bdev) / job->io_size_blocks;
1706 		job->ios_base = 0;
1707 	}
1708 
1709 	if (job->is_random && g_zipf_theta > 0) {
1710 		job->zipf = spdk_zipf_create(job->size_in_ios, g_zipf_theta, 0);
1711 	}
1712 
1713 	if (job->verify) {
1714 		if (job->size_in_ios >= UINT32_MAX) {
1715 			SPDK_ERRLOG("Due to constraints of verify operation, the job storage capacity is too large\n");
1716 			bdevperf_job_free(job);
1717 			return -ENOMEM;
1718 		}
1719 		job->outstanding = spdk_bit_array_create(job->size_in_ios);
1720 		if (job->outstanding == NULL) {
1721 			SPDK_ERRLOG("Could not create outstanding array bitmap for bdev %s\n",
1722 				    spdk_bdev_get_name(bdev));
1723 			bdevperf_job_free(job);
1724 			return -ENOMEM;
1725 		}
1726 		if (job->queue_depth > (int)job->size_in_ios) {
1727 			SPDK_WARNLOG("Due to constraints of verify job, queue depth (-q, %d) can't exceed the number of IO "
1728 				     "requests which can be submitted to the bdev %s simultaneously (%"PRIu64"). "
1729 				     "Queue depth is limited to %"PRIu64"\n",
1730 				     job->queue_depth, job->name, job->size_in_ios, job->size_in_ios);
1731 			job->queue_depth = (int)job->size_in_ios;
1732 		}
1733 	}
1734 
1735 	job->histogram = spdk_histogram_data_alloc();
1736 	if (job->histogram == NULL) {
1737 		fprintf(stderr, "Failed to allocate histogram\n");
1738 		bdevperf_job_free(job);
1739 		return -ENOMEM;
1740 	}
1741 
1742 	TAILQ_INIT(&job->task_list);
1743 
1744 	if (g_random_map) {
1745 		if (job->size_in_ios >= UINT32_MAX) {
1746 			SPDK_ERRLOG("Due to constraints of the random map, the job storage capacity is too large\n");
1747 			bdevperf_job_free(job);
1748 			return -ENOMEM;
1749 		}
1750 		job->random_map = spdk_bit_array_create(job->size_in_ios);
1751 		if (job->random_map == NULL) {
1752 			SPDK_ERRLOG("Could not create random_map array bitmap for bdev %s\n",
1753 				    spdk_bdev_get_name(bdev));
1754 			bdevperf_job_free(job);
1755 			return -ENOMEM;
1756 		}
1757 	}
1758 
1759 	task_num = job->queue_depth;
1760 	if (job->reset) {
1761 		task_num += 1;
1762 	}
1763 	if (job->abort) {
1764 		task_num += job->queue_depth;
1765 	}
1766 
1767 	TAILQ_INSERT_TAIL(&g_bdevperf.jobs, job, link);
1768 
1769 	for (n = 0; n < task_num; n++) {
1770 		task = calloc(1, sizeof(struct bdevperf_task));
1771 		if (!task) {
1772 			fprintf(stderr, "Failed to allocate task from memory\n");
1773 			spdk_zipf_free(&job->zipf);
1774 			return -ENOMEM;
1775 		}
1776 
1777 		task->buf = spdk_zmalloc(job->buf_size, spdk_bdev_get_buf_align(job->bdev), NULL,
1778 					 SPDK_ENV_LCORE_ID_ANY, SPDK_MALLOC_DMA);
1779 		if (!task->buf) {
1780 			fprintf(stderr, "Cannot allocate buf for task=%p\n", task);
1781 			spdk_zipf_free(&job->zipf);
1782 			free(task);
1783 			return -ENOMEM;
1784 		}
1785 
1786 		if (spdk_bdev_is_md_separate(job->bdev)) {
1787 			task->md_buf = spdk_zmalloc(job->io_size_blocks *
1788 						    spdk_bdev_get_md_size(job->bdev), 0, NULL,
1789 						    SPDK_ENV_LCORE_ID_ANY, SPDK_MALLOC_DMA);
1790 			if (!task->md_buf) {
1791 				fprintf(stderr, "Cannot allocate md buf for task=%p\n", task);
1792 				spdk_zipf_free(&job->zipf);
1793 				spdk_free(task->buf);
1794 				free(task);
1795 				return -ENOMEM;
1796 			}
1797 		}
1798 
1799 		task->job = job;
1800 		TAILQ_INSERT_TAIL(&job->task_list, task, link);
1801 	}
1802 
1803 	job->thread = thread;
1804 
1805 	g_construct_job_count++;
1806 
1807 	rc = spdk_thread_send_msg(thread, _bdevperf_construct_job, job);
1808 	assert(rc == 0);
1809 
1810 	return rc;
1811 }
1812 
1813 static int
1814 parse_rw(const char *str, enum job_config_rw ret)
1815 {
1816 	if (str == NULL) {
1817 		return ret;
1818 	}
1819 
1820 	if (!strcmp(str, "read")) {
1821 		ret = JOB_CONFIG_RW_READ;
1822 	} else if (!strcmp(str, "randread")) {
1823 		ret = JOB_CONFIG_RW_RANDREAD;
1824 	} else if (!strcmp(str, "write")) {
1825 		ret = JOB_CONFIG_RW_WRITE;
1826 	} else if (!strcmp(str, "randwrite")) {
1827 		ret = JOB_CONFIG_RW_RANDWRITE;
1828 	} else if (!strcmp(str, "verify")) {
1829 		ret = JOB_CONFIG_RW_VERIFY;
1830 	} else if (!strcmp(str, "reset")) {
1831 		ret = JOB_CONFIG_RW_RESET;
1832 	} else if (!strcmp(str, "unmap")) {
1833 		ret = JOB_CONFIG_RW_UNMAP;
1834 	} else if (!strcmp(str, "write_zeroes")) {
1835 		ret = JOB_CONFIG_RW_WRITE_ZEROES;
1836 	} else if (!strcmp(str, "flush")) {
1837 		ret = JOB_CONFIG_RW_FLUSH;
1838 	} else if (!strcmp(str, "rw")) {
1839 		ret = JOB_CONFIG_RW_RW;
1840 	} else if (!strcmp(str, "randrw")) {
1841 		ret = JOB_CONFIG_RW_RANDRW;
1842 	} else {
1843 		fprintf(stderr, "rw must be one of\n"
1844 			"(read, write, randread, randwrite, rw, randrw, verify, reset, unmap, flush)\n");
1845 		ret = BDEVPERF_CONFIG_ERROR;
1846 	}
1847 
1848 	return ret;
1849 }
1850 
1851 static const char *
1852 config_filename_next(const char *filename, char *out)
1853 {
1854 	int i, k;
1855 
1856 	if (filename == NULL) {
1857 		out[0] = '\0';
1858 		return NULL;
1859 	}
1860 
1861 	if (filename[0] == ':') {
1862 		filename++;
1863 	}
1864 
1865 	for (i = 0, k = 0;
1866 	     filename[i] != '\0' &&
1867 	     filename[i] != ':' &&
1868 	     i < BDEVPERF_CONFIG_MAX_FILENAME &&
1869 	     k < (BDEVPERF_CONFIG_MAX_FILENAME - 1);
1870 	     i++) {
1871 		if (filename[i] == ' ' || filename[i] == '\t') {
1872 			continue;
1873 		}
1874 
1875 		out[k++] = filename[i];
1876 	}
1877 	out[k] = 0;
1878 
1879 	return filename + i;
1880 }
1881 
1882 static struct spdk_thread *
1883 get_lcore_thread(uint32_t lcore)
1884 {
1885 	struct lcore_thread *lthread;
1886 
1887 	TAILQ_FOREACH(lthread, &g_lcore_thread_list, link) {
1888 		if (lthread->lcore == lcore) {
1889 			return lthread->thread;
1890 		}
1891 	}
1892 
1893 	return NULL;
1894 }
1895 
1896 static void
1897 bdevperf_construct_jobs(void)
1898 {
1899 	char filename[BDEVPERF_CONFIG_MAX_FILENAME];
1900 	struct spdk_thread *thread;
1901 	struct job_config *config;
1902 	struct spdk_bdev *bdev;
1903 	const char *filenames;
1904 	int rc;
1905 
1906 	TAILQ_FOREACH(config, &job_config_list, link) {
1907 		filenames = config->filename;
1908 
1909 		if (!g_one_thread_per_lcore) {
1910 			thread = construct_job_thread(&config->cpumask, config->name);
1911 		} else {
1912 			thread = get_lcore_thread(config->lcore);
1913 		}
1914 		assert(thread);
1915 
1916 		while (filenames) {
1917 			filenames = config_filename_next(filenames, filename);
1918 			if (strlen(filename) == 0) {
1919 				break;
1920 			}
1921 
1922 			bdev = spdk_bdev_get_by_name(filename);
1923 			if (!bdev) {
1924 				fprintf(stderr, "Unable to find bdev '%s'\n", filename);
1925 				g_run_rc = -EINVAL;
1926 				return;
1927 			}
1928 
1929 			rc = bdevperf_construct_job(bdev, config, thread);
1930 			if (rc < 0) {
1931 				g_run_rc = rc;
1932 				return;
1933 			}
1934 		}
1935 	}
1936 }
1937 
1938 static int
1939 make_cli_job_config(const char *filename, int64_t offset, uint64_t range)
1940 {
1941 	struct job_config *config = calloc(1, sizeof(*config));
1942 
1943 	if (config == NULL) {
1944 		fprintf(stderr, "Unable to allocate memory for job config\n");
1945 		return -ENOMEM;
1946 	}
1947 
1948 	config->name = filename;
1949 	config->filename = filename;
1950 	config->lcore = _get_next_core();
1951 	spdk_cpuset_zero(&config->cpumask);
1952 	spdk_cpuset_set_cpu(&config->cpumask, config->lcore, true);
1953 	config->bs = g_io_size;
1954 	config->iodepth = g_queue_depth;
1955 	config->rwmixread = g_rw_percentage;
1956 	config->offset = offset;
1957 	config->length = range;
1958 	config->rw = parse_rw(g_workload_type, BDEVPERF_CONFIG_ERROR);
1959 	if ((int)config->rw == BDEVPERF_CONFIG_ERROR) {
1960 		free(config);
1961 		return -EINVAL;
1962 	}
1963 
1964 	TAILQ_INSERT_TAIL(&job_config_list, config, link);
1965 	return 0;
1966 }
1967 
1968 static int
1969 bdevperf_construct_multithread_job_config(void *ctx, struct spdk_bdev *bdev)
1970 {
1971 	uint32_t *num_cores = ctx;
1972 	uint32_t i;
1973 	uint64_t blocks_per_job;
1974 	int64_t offset;
1975 	int rc;
1976 
1977 	blocks_per_job = spdk_bdev_get_num_blocks(bdev) / *num_cores;
1978 	offset = 0;
1979 
1980 	SPDK_ENV_FOREACH_CORE(i) {
1981 		rc = make_cli_job_config(spdk_bdev_get_name(bdev), offset, blocks_per_job);
1982 		if (rc) {
1983 			return rc;
1984 		}
1985 
1986 		offset += blocks_per_job;
1987 	}
1988 
1989 	return 0;
1990 }
1991 
1992 static void
1993 bdevperf_construct_multithread_job_configs(void)
1994 {
1995 	struct spdk_bdev *bdev;
1996 	uint32_t i;
1997 	uint32_t num_cores;
1998 
1999 	num_cores = 0;
2000 	SPDK_ENV_FOREACH_CORE(i) {
2001 		num_cores++;
2002 	}
2003 
2004 	if (num_cores == 0) {
2005 		g_run_rc = -EINVAL;
2006 		return;
2007 	}
2008 
2009 	if (g_job_bdev_name != NULL) {
2010 		bdev = spdk_bdev_get_by_name(g_job_bdev_name);
2011 		if (!bdev) {
2012 			fprintf(stderr, "Unable to find bdev '%s'\n", g_job_bdev_name);
2013 			return;
2014 		}
2015 		g_run_rc = bdevperf_construct_multithread_job_config(&num_cores, bdev);
2016 	} else {
2017 		g_run_rc = spdk_for_each_bdev_leaf(&num_cores, bdevperf_construct_multithread_job_config);
2018 	}
2019 
2020 }
2021 
2022 static int
2023 bdevperf_construct_job_config(void *ctx, struct spdk_bdev *bdev)
2024 {
2025 	/* Construct the job */
2026 	return make_cli_job_config(spdk_bdev_get_name(bdev), 0, 0);
2027 }
2028 
2029 static void
2030 create_lcore_thread(uint32_t lcore)
2031 {
2032 	struct lcore_thread *lthread;
2033 	struct spdk_cpuset cpumask = {};
2034 	char name[32];
2035 
2036 	lthread = calloc(1, sizeof(*lthread));
2037 	assert(lthread != NULL);
2038 
2039 	lthread->lcore = lcore;
2040 
2041 	snprintf(name, sizeof(name), "lcore_%u", lcore);
2042 	spdk_cpuset_set_cpu(&cpumask, lcore, true);
2043 
2044 	lthread->thread = spdk_thread_create(name, &cpumask);
2045 	assert(lthread->thread != NULL);
2046 
2047 	TAILQ_INSERT_TAIL(&g_lcore_thread_list, lthread, link);
2048 }
2049 
2050 static void
2051 bdevperf_construct_job_configs(void)
2052 {
2053 	struct spdk_bdev *bdev;
2054 	uint32_t i;
2055 
2056 	/* There are three different modes for allocating jobs. Standard mode
2057 	 * (the default) creates one spdk_thread per bdev and runs the I/O job there.
2058 	 *
2059 	 * The -C flag places bdevperf into "multithread" mode, meaning it creates
2060 	 * one spdk_thread per bdev PER CORE, and runs a copy of the job on each.
2061 	 * This runs multiple threads per bdev, effectively.
2062 	 *
2063 	 * The -j flag implies "FIO" mode which tries to mimic semantic of FIO jobs.
2064 	 * In "FIO" mode, threads are spawned per-job instead of per-bdev.
2065 	 * Each FIO job can be individually parameterized by filename, cpu mask, etc,
2066 	 * which is different from other modes in that they only support global options.
2067 	 *
2068 	 * Both for standard mode and "multithread" mode, if the -E flag is specified,
2069 	 * it creates one spdk_thread PER CORE. On each core, one spdk_thread is shared by
2070 	 * multiple jobs.
2071 	 */
2072 
2073 	if (g_bdevperf_conf) {
2074 		goto end;
2075 	}
2076 
2077 	if (g_one_thread_per_lcore) {
2078 		SPDK_ENV_FOREACH_CORE(i) {
2079 			create_lcore_thread(i);
2080 		}
2081 	}
2082 
2083 	if (g_multithread_mode) {
2084 		bdevperf_construct_multithread_job_configs();
2085 	} else if (g_job_bdev_name != NULL) {
2086 		bdev = spdk_bdev_get_by_name(g_job_bdev_name);
2087 		if (bdev) {
2088 			/* Construct the job */
2089 			g_run_rc = make_cli_job_config(g_job_bdev_name, 0, 0);
2090 		} else {
2091 			fprintf(stderr, "Unable to find bdev '%s'\n", g_job_bdev_name);
2092 		}
2093 	} else {
2094 		g_run_rc = spdk_for_each_bdev_leaf(NULL, bdevperf_construct_job_config);
2095 	}
2096 
2097 end:
2098 	/* Increment initial construct_jobs count so that it will never reach 0 in the middle
2099 	 * of iteration.
2100 	 */
2101 	g_construct_job_count = 1;
2102 
2103 	if (g_run_rc == 0) {
2104 		bdevperf_construct_jobs();
2105 	}
2106 
2107 	_bdevperf_construct_job_done(NULL);
2108 }
2109 
2110 static int
2111 parse_uint_option(struct spdk_conf_section *s, const char *name, int def)
2112 {
2113 	const char *job_name;
2114 	int tmp;
2115 
2116 	tmp = spdk_conf_section_get_intval(s, name);
2117 	if (tmp == -1) {
2118 		/* Field was not found. Check default value
2119 		 * In [global] section it is ok to have undefined values
2120 		 * but for other sections it is not ok */
2121 		if (def == BDEVPERF_CONFIG_UNDEFINED) {
2122 			job_name = spdk_conf_section_get_name(s);
2123 			if (strcmp(job_name, "global") == 0) {
2124 				return def;
2125 			}
2126 
2127 			fprintf(stderr,
2128 				"Job '%s' has no '%s' assigned\n",
2129 				job_name, name);
2130 			return BDEVPERF_CONFIG_ERROR;
2131 		}
2132 		return def;
2133 	}
2134 
2135 	/* NOTE: get_intval returns nonnegative on success */
2136 	if (tmp < 0) {
2137 		fprintf(stderr, "Job '%s' has bad '%s' value.\n",
2138 			spdk_conf_section_get_name(s), name);
2139 		return BDEVPERF_CONFIG_ERROR;
2140 	}
2141 
2142 	return tmp;
2143 }
2144 
2145 /* CLI arguments override parameters for global sections */
2146 static void
2147 config_set_cli_args(struct job_config *config)
2148 {
2149 	if (g_job_bdev_name) {
2150 		config->filename = g_job_bdev_name;
2151 	}
2152 	if (g_io_size > 0) {
2153 		config->bs = g_io_size;
2154 	}
2155 	if (g_queue_depth > 0) {
2156 		config->iodepth = g_queue_depth;
2157 	}
2158 	if (g_rw_percentage > 0) {
2159 		config->rwmixread = g_rw_percentage;
2160 	}
2161 	if (g_workload_type) {
2162 		config->rw = parse_rw(g_workload_type, config->rw);
2163 	}
2164 }
2165 
2166 static int
2167 read_job_config(void)
2168 {
2169 	struct job_config global_default_config;
2170 	struct job_config global_config;
2171 	struct spdk_conf_section *s;
2172 	struct job_config *config;
2173 	const char *cpumask;
2174 	const char *rw;
2175 	bool is_global;
2176 	int n = 0;
2177 	int val;
2178 
2179 	if (g_bdevperf_conf_file == NULL) {
2180 		return 0;
2181 	}
2182 
2183 	g_bdevperf_conf = spdk_conf_allocate();
2184 	if (g_bdevperf_conf == NULL) {
2185 		fprintf(stderr, "Could not allocate job config structure\n");
2186 		return 1;
2187 	}
2188 
2189 	spdk_conf_disable_sections_merge(g_bdevperf_conf);
2190 	if (spdk_conf_read(g_bdevperf_conf, g_bdevperf_conf_file)) {
2191 		fprintf(stderr, "Invalid job config");
2192 		return 1;
2193 	}
2194 
2195 	/* Initialize global defaults */
2196 	global_default_config.filename = NULL;
2197 	/* Zero mask is the same as g_all_cpuset
2198 	 * The g_all_cpuset is not initialized yet,
2199 	 * so use zero mask as the default instead */
2200 	spdk_cpuset_zero(&global_default_config.cpumask);
2201 	global_default_config.bs = BDEVPERF_CONFIG_UNDEFINED;
2202 	global_default_config.iodepth = BDEVPERF_CONFIG_UNDEFINED;
2203 	/* bdevperf has no default for -M option but in FIO the default is 50 */
2204 	global_default_config.rwmixread = 50;
2205 	global_default_config.offset = 0;
2206 	/* length 0 means 100% */
2207 	global_default_config.length = 0;
2208 	global_default_config.rw = BDEVPERF_CONFIG_UNDEFINED;
2209 	config_set_cli_args(&global_default_config);
2210 
2211 	if ((int)global_default_config.rw == BDEVPERF_CONFIG_ERROR) {
2212 		return 1;
2213 	}
2214 
2215 	/* There is only a single instance of global job_config
2216 	 * We just reset its value when we encounter new [global] section */
2217 	global_config = global_default_config;
2218 
2219 	for (s = spdk_conf_first_section(g_bdevperf_conf);
2220 	     s != NULL;
2221 	     s = spdk_conf_next_section(s)) {
2222 		config = calloc(1, sizeof(*config));
2223 		if (config == NULL) {
2224 			fprintf(stderr, "Unable to allocate memory for job config\n");
2225 			return 1;
2226 		}
2227 
2228 		config->name = spdk_conf_section_get_name(s);
2229 		is_global = strcmp(config->name, "global") == 0;
2230 
2231 		if (is_global) {
2232 			global_config = global_default_config;
2233 		}
2234 
2235 		config->filename = spdk_conf_section_get_val(s, "filename");
2236 		if (config->filename == NULL) {
2237 			config->filename = global_config.filename;
2238 		}
2239 		if (!is_global) {
2240 			if (config->filename == NULL) {
2241 				fprintf(stderr, "Job '%s' expects 'filename' parameter\n", config->name);
2242 				goto error;
2243 			} else if (strnlen(config->filename, BDEVPERF_CONFIG_MAX_FILENAME)
2244 				   >= BDEVPERF_CONFIG_MAX_FILENAME) {
2245 				fprintf(stderr,
2246 					"filename for '%s' job is too long. Max length is %d\n",
2247 					config->name, BDEVPERF_CONFIG_MAX_FILENAME);
2248 				goto error;
2249 			}
2250 		}
2251 
2252 		cpumask = spdk_conf_section_get_val(s, "cpumask");
2253 		if (cpumask == NULL) {
2254 			config->cpumask = global_config.cpumask;
2255 		} else if (spdk_cpuset_parse(&config->cpumask, cpumask)) {
2256 			fprintf(stderr, "Job '%s' has bad 'cpumask' value\n", config->name);
2257 			goto error;
2258 		}
2259 
2260 		config->bs = parse_uint_option(s, "bs", global_config.bs);
2261 		if (config->bs == BDEVPERF_CONFIG_ERROR) {
2262 			goto error;
2263 		} else if (config->bs == 0) {
2264 			fprintf(stderr, "'bs' of job '%s' must be greater than 0\n", config->name);
2265 			goto error;
2266 		}
2267 
2268 		config->iodepth = parse_uint_option(s, "iodepth", global_config.iodepth);
2269 		if (config->iodepth == BDEVPERF_CONFIG_ERROR) {
2270 			goto error;
2271 		} else if (config->iodepth == 0) {
2272 			fprintf(stderr,
2273 				"'iodepth' of job '%s' must be greater than 0\n",
2274 				config->name);
2275 			goto error;
2276 		}
2277 
2278 		config->rwmixread = parse_uint_option(s, "rwmixread", global_config.rwmixread);
2279 		if (config->rwmixread == BDEVPERF_CONFIG_ERROR) {
2280 			goto error;
2281 		} else if (config->rwmixread > 100) {
2282 			fprintf(stderr,
2283 				"'rwmixread' value of '%s' job is not in 0-100 range\n",
2284 				config->name);
2285 			goto error;
2286 		}
2287 
2288 		config->offset = parse_uint_option(s, "offset", global_config.offset);
2289 		if (config->offset == BDEVPERF_CONFIG_ERROR) {
2290 			goto error;
2291 		}
2292 
2293 		val = parse_uint_option(s, "length", global_config.length);
2294 		if (val == BDEVPERF_CONFIG_ERROR) {
2295 			goto error;
2296 		}
2297 		config->length = val;
2298 
2299 		rw = spdk_conf_section_get_val(s, "rw");
2300 		config->rw = parse_rw(rw, global_config.rw);
2301 		if ((int)config->rw == BDEVPERF_CONFIG_ERROR) {
2302 			fprintf(stderr, "Job '%s' has bad 'rw' value\n", config->name);
2303 			goto error;
2304 		} else if (!is_global && (int)config->rw == BDEVPERF_CONFIG_UNDEFINED) {
2305 			fprintf(stderr, "Job '%s' has no 'rw' assigned\n", config->name);
2306 			goto error;
2307 		}
2308 
2309 		if (is_global) {
2310 			config_set_cli_args(config);
2311 			global_config = *config;
2312 			free(config);
2313 		} else {
2314 			TAILQ_INSERT_TAIL(&job_config_list, config, link);
2315 			n++;
2316 		}
2317 	}
2318 
2319 	printf("Using job config with %d jobs\n", n);
2320 	return 0;
2321 error:
2322 	free(config);
2323 	return 1;
2324 }
2325 
2326 static void
2327 bdevperf_run(void *arg1)
2328 {
2329 	uint32_t i;
2330 
2331 	g_main_thread = spdk_get_thread();
2332 
2333 	spdk_cpuset_zero(&g_all_cpuset);
2334 	SPDK_ENV_FOREACH_CORE(i) {
2335 		spdk_cpuset_set_cpu(&g_all_cpuset, i, true);
2336 	}
2337 
2338 	if (g_wait_for_tests) {
2339 		/* Do not perform any tests until RPC is received */
2340 		return;
2341 	}
2342 
2343 	bdevperf_construct_job_configs();
2344 }
2345 
2346 static void
2347 rpc_perform_tests_reset(void)
2348 {
2349 	/* Reset g_run_rc to 0 for the next test run. */
2350 	g_run_rc = 0;
2351 
2352 	/* Reset g_stats to 0 for the next test run. */
2353 	memset(&g_stats, 0, sizeof(g_stats));
2354 
2355 	/* Reset g_show_performance_period_num to 0 for the next test run. */
2356 	g_show_performance_period_num = 0;
2357 }
2358 
2359 static void
2360 rpc_perform_tests_cb(void)
2361 {
2362 	struct spdk_json_write_ctx *w;
2363 	struct spdk_jsonrpc_request *request = g_request;
2364 
2365 	g_request = NULL;
2366 
2367 	if (g_run_rc == 0) {
2368 		w = spdk_jsonrpc_begin_result(request);
2369 		spdk_json_write_uint32(w, g_run_rc);
2370 		spdk_jsonrpc_end_result(request, w);
2371 	} else {
2372 		spdk_jsonrpc_send_error_response_fmt(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
2373 						     "bdevperf failed with error %s", spdk_strerror(-g_run_rc));
2374 	}
2375 
2376 	rpc_perform_tests_reset();
2377 }
2378 
2379 static void
2380 rpc_perform_tests(struct spdk_jsonrpc_request *request, const struct spdk_json_val *params)
2381 {
2382 	if (params != NULL) {
2383 		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS,
2384 						 "perform_tests method requires no parameters");
2385 		return;
2386 	}
2387 	if (g_request != NULL) {
2388 		fprintf(stderr, "Another test is already in progress.\n");
2389 		spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR,
2390 						 spdk_strerror(-EINPROGRESS));
2391 		return;
2392 	}
2393 	g_request = request;
2394 
2395 	/* Only construct job configs at the first test run.  */
2396 	if (TAILQ_EMPTY(&job_config_list)) {
2397 		bdevperf_construct_job_configs();
2398 	} else {
2399 		bdevperf_construct_jobs();
2400 	}
2401 }
2402 SPDK_RPC_REGISTER("perform_tests", rpc_perform_tests, SPDK_RPC_RUNTIME)
2403 
2404 static void
2405 _bdevperf_job_drain(void *ctx)
2406 {
2407 	bdevperf_job_drain(ctx);
2408 }
2409 
2410 static void
2411 spdk_bdevperf_shutdown_cb(void)
2412 {
2413 	g_shutdown = true;
2414 	struct bdevperf_job *job, *tmp;
2415 
2416 	if (g_bdevperf.running_jobs == 0) {
2417 		bdevperf_test_done(NULL);
2418 		return;
2419 	}
2420 
2421 	/* Iterate jobs to stop all I/O */
2422 	TAILQ_FOREACH_SAFE(job, &g_bdevperf.jobs, link, tmp) {
2423 		spdk_thread_send_msg(job->thread, _bdevperf_job_drain, job);
2424 	}
2425 }
2426 
2427 static int
2428 bdevperf_parse_arg(int ch, char *arg)
2429 {
2430 	long long tmp;
2431 
2432 	if (ch == 'w') {
2433 		g_workload_type = optarg;
2434 	} else if (ch == 'T') {
2435 		g_job_bdev_name = optarg;
2436 	} else if (ch == 'z') {
2437 		g_wait_for_tests = true;
2438 	} else if (ch == 'Z') {
2439 		g_zcopy = true;
2440 	} else if (ch == 'X') {
2441 		g_abort = true;
2442 	} else if (ch == 'C') {
2443 		g_multithread_mode = true;
2444 	} else if (ch == 'f') {
2445 		g_continue_on_failure = true;
2446 	} else if (ch == 'j') {
2447 		g_bdevperf_conf_file = optarg;
2448 	} else if (ch == 'F') {
2449 		char *endptr;
2450 
2451 		errno = 0;
2452 		g_zipf_theta = strtod(optarg, &endptr);
2453 		if (errno || optarg == endptr || g_zipf_theta < 0) {
2454 			fprintf(stderr, "Illegal zipf theta value %s\n", optarg);
2455 			return -EINVAL;
2456 		}
2457 	} else if (ch == 'l') {
2458 		g_latency_display_level++;
2459 	} else if (ch == 'D') {
2460 		g_random_map = true;
2461 	} else if (ch == 'E') {
2462 		g_one_thread_per_lcore = true;
2463 	} else {
2464 		tmp = spdk_strtoll(optarg, 10);
2465 		if (tmp < 0) {
2466 			fprintf(stderr, "Parse failed for the option %c.\n", ch);
2467 			return tmp;
2468 		} else if (tmp >= INT_MAX) {
2469 			fprintf(stderr, "Parsed option was too large %c.\n", ch);
2470 			return -ERANGE;
2471 		}
2472 
2473 		switch (ch) {
2474 		case 'q':
2475 			g_queue_depth = tmp;
2476 			break;
2477 		case 'o':
2478 			g_io_size = tmp;
2479 			break;
2480 		case 't':
2481 			g_time_in_sec = tmp;
2482 			break;
2483 		case 'k':
2484 			g_timeout_in_sec = tmp;
2485 			break;
2486 		case 'M':
2487 			g_rw_percentage = tmp;
2488 			g_mix_specified = true;
2489 			break;
2490 		case 'P':
2491 			g_show_performance_ema_period = tmp;
2492 			break;
2493 		case 'S':
2494 			g_show_performance_real_time = 1;
2495 			g_show_performance_period_in_usec = tmp * SPDK_SEC_TO_USEC;
2496 			break;
2497 		default:
2498 			return -EINVAL;
2499 		}
2500 	}
2501 	return 0;
2502 }
2503 
2504 static void
2505 bdevperf_usage(void)
2506 {
2507 	printf(" -q <depth>                io depth\n");
2508 	printf(" -o <size>                 io size in bytes\n");
2509 	printf(" -w <type>                 io pattern type, must be one of (read, write, randread, randwrite, rw, randrw, verify, reset, unmap, flush)\n");
2510 	printf(" -t <time>                 time in seconds\n");
2511 	printf(" -k <timeout>              timeout in seconds to detect starved I/O (default is 0 and disabled)\n");
2512 	printf(" -M <percent>              rwmixread (100 for reads, 0 for writes)\n");
2513 	printf(" -P <num>                  number of moving average period\n");
2514 	printf("\t\t(If set to n, show weighted mean of the previous n IO/s in real time)\n");
2515 	printf("\t\t(Formula: M = 2 / (n + 1), EMA[i+1] = IO/s * M + (1 - M) * EMA[i])\n");
2516 	printf("\t\t(only valid with -S)\n");
2517 	printf(" -S <period>               show performance result in real time every <period> seconds\n");
2518 	printf(" -T <bdev>                 bdev to run against. Default: all available bdevs.\n");
2519 	printf(" -f                        continue processing I/O even after failures\n");
2520 	printf(" -F <zipf theta>           use zipf distribution for random I/O\n");
2521 	printf(" -Z                        enable using zcopy bdev API for read or write I/O\n");
2522 	printf(" -z                        start bdevperf, but wait for RPC to start tests\n");
2523 	printf(" -X                        abort timed out I/O\n");
2524 	printf(" -C                        enable every core to send I/Os to each bdev\n");
2525 	printf(" -j <filename>             use job config file\n");
2526 	printf(" -l                        display latency histogram, default: disable. -l display summary, -ll display details\n");
2527 	printf(" -D                        use a random map for picking offsets not previously read or written (for all jobs)\n");
2528 	printf(" -E                        share per lcore thread among jobs. Available only if -j is not used.\n");
2529 }
2530 
2531 static int
2532 verify_test_params(struct spdk_app_opts *opts)
2533 {
2534 	/* When RPC is used for starting tests and
2535 	 * no rpc_addr was configured for the app,
2536 	 * use the default address. */
2537 	if (g_wait_for_tests && opts->rpc_addr == NULL) {
2538 		opts->rpc_addr = SPDK_DEFAULT_RPC_ADDR;
2539 	}
2540 
2541 	if (!g_bdevperf_conf_file && g_queue_depth <= 0) {
2542 		goto out;
2543 	}
2544 	if (!g_bdevperf_conf_file && g_io_size <= 0) {
2545 		goto out;
2546 	}
2547 	if (!g_bdevperf_conf_file && !g_workload_type) {
2548 		goto out;
2549 	}
2550 	if (g_bdevperf_conf_file && g_one_thread_per_lcore) {
2551 		printf("If bdevperf's config file is used, per lcore thread cannot be used\n");
2552 		goto out;
2553 	}
2554 	if (g_time_in_sec <= 0) {
2555 		goto out;
2556 	}
2557 	g_time_in_usec = g_time_in_sec * SPDK_SEC_TO_USEC;
2558 
2559 	if (g_timeout_in_sec < 0) {
2560 		goto out;
2561 	}
2562 
2563 	if (g_abort && !g_timeout_in_sec) {
2564 		printf("Timeout must be set for abort option, Ignoring g_abort\n");
2565 	}
2566 
2567 	if (g_show_performance_ema_period > 0 &&
2568 	    g_show_performance_real_time == 0) {
2569 		fprintf(stderr, "-P option must be specified with -S option\n");
2570 		return 1;
2571 	}
2572 
2573 	if (g_io_size > SPDK_BDEV_LARGE_BUF_MAX_SIZE) {
2574 		printf("I/O size of %d is greater than zero copy threshold (%d).\n",
2575 		       g_io_size, SPDK_BDEV_LARGE_BUF_MAX_SIZE);
2576 		printf("Zero copy mechanism will not be used.\n");
2577 		g_zcopy = false;
2578 	}
2579 
2580 	if (g_bdevperf_conf_file) {
2581 		/* workload_type verification happens during config file parsing */
2582 		return 0;
2583 	}
2584 
2585 	if (!strcmp(g_workload_type, "verify") ||
2586 	    !strcmp(g_workload_type, "reset")) {
2587 		g_rw_percentage = 50;
2588 		if (g_io_size > SPDK_BDEV_LARGE_BUF_MAX_SIZE) {
2589 			fprintf(stderr, "Unable to exceed max I/O size of %d for verify. (%d provided).\n",
2590 				SPDK_BDEV_LARGE_BUF_MAX_SIZE, g_io_size);
2591 			return 1;
2592 		}
2593 		g_verify = true;
2594 		if (!strcmp(g_workload_type, "reset")) {
2595 			g_reset = true;
2596 		}
2597 	}
2598 
2599 	if (!strcmp(g_workload_type, "read") ||
2600 	    !strcmp(g_workload_type, "randread") ||
2601 	    !strcmp(g_workload_type, "write") ||
2602 	    !strcmp(g_workload_type, "randwrite") ||
2603 	    !strcmp(g_workload_type, "verify") ||
2604 	    !strcmp(g_workload_type, "reset") ||
2605 	    !strcmp(g_workload_type, "unmap") ||
2606 	    !strcmp(g_workload_type, "write_zeroes") ||
2607 	    !strcmp(g_workload_type, "flush")) {
2608 		if (g_mix_specified) {
2609 			fprintf(stderr, "Ignoring -M option... Please use -M option"
2610 				" only when using rw or randrw.\n");
2611 		}
2612 	}
2613 
2614 	if (!strcmp(g_workload_type, "rw") ||
2615 	    !strcmp(g_workload_type, "randrw")) {
2616 		if (g_rw_percentage < 0 || g_rw_percentage > 100) {
2617 			fprintf(stderr,
2618 				"-M must be specified to value from 0 to 100 "
2619 				"for rw or randrw.\n");
2620 			return 1;
2621 		}
2622 	}
2623 
2624 	if (strcmp(g_workload_type, "randread") &&
2625 	    strcmp(g_workload_type, "randwrite") &&
2626 	    strcmp(g_workload_type, "randrw")) {
2627 		if (g_random_map) {
2628 			fprintf(stderr, "Ignoring -D option... Please use -D option"
2629 				" only when using randread, randwrite or randrw.\n");
2630 			return 1;
2631 		}
2632 	}
2633 
2634 	return 0;
2635 out:
2636 	spdk_app_usage();
2637 	bdevperf_usage();
2638 	return 1;
2639 }
2640 
2641 int
2642 main(int argc, char **argv)
2643 {
2644 	struct spdk_app_opts opts = {};
2645 	int rc;
2646 
2647 	/* Use the runtime PID to set the random seed */
2648 	srand(getpid());
2649 
2650 	spdk_app_opts_init(&opts, sizeof(opts));
2651 	opts.name = "bdevperf";
2652 	opts.rpc_addr = NULL;
2653 	opts.shutdown_cb = spdk_bdevperf_shutdown_cb;
2654 
2655 	if ((rc = spdk_app_parse_args(argc, argv, &opts, "Zzfq:o:t:w:k:CEF:M:P:S:T:Xlj:D", NULL,
2656 				      bdevperf_parse_arg, bdevperf_usage)) !=
2657 	    SPDK_APP_PARSE_ARGS_SUCCESS) {
2658 		return rc;
2659 	}
2660 
2661 	if (read_job_config()) {
2662 		free_job_config();
2663 		return 1;
2664 	}
2665 
2666 	if (verify_test_params(&opts) != 0) {
2667 		free_job_config();
2668 		exit(1);
2669 	}
2670 
2671 	rc = spdk_app_start(&opts, bdevperf_run, NULL);
2672 
2673 	spdk_app_fini();
2674 	free_job_config();
2675 	return rc;
2676 }
2677