xref: /spdk/lib/bdev/bdev.c (revision 8b2120812921e325bbc0b6bb4df15ed1b8387917)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) Intel Corporation. All rights reserved.
5  *   Copyright (c) 2019 Mellanox Technologies LTD. All rights reserved.
6  *   Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
7  *
8  *   Redistribution and use in source and binary forms, with or without
9  *   modification, are permitted provided that the following conditions
10  *   are met:
11  *
12  *     * Redistributions of source code must retain the above copyright
13  *       notice, this list of conditions and the following disclaimer.
14  *     * Redistributions in binary form must reproduce the above copyright
15  *       notice, this list of conditions and the following disclaimer in
16  *       the documentation and/or other materials provided with the
17  *       distribution.
18  *     * Neither the name of Intel Corporation nor the names of its
19  *       contributors may be used to endorse or promote products derived
20  *       from this software without specific prior written permission.
21  *
22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #include "spdk/stdinc.h"
36 
37 #include "spdk/bdev.h"
38 
39 #include "spdk/config.h"
40 #include "spdk/env.h"
41 #include "spdk/thread.h"
42 #include "spdk/likely.h"
43 #include "spdk/queue.h"
44 #include "spdk/nvme_spec.h"
45 #include "spdk/scsi_spec.h"
46 #include "spdk/notify.h"
47 #include "spdk/util.h"
48 #include "spdk/trace.h"
49 
50 #include "spdk/bdev_module.h"
51 #include "spdk/log.h"
52 #include "spdk/string.h"
53 
54 #include "bdev_internal.h"
55 
56 #ifdef SPDK_CONFIG_VTUNE
57 #include "ittnotify.h"
58 #include "ittnotify_types.h"
59 int __itt_init_ittlib(const char *, __itt_group_id);
60 #endif
61 
62 #define SPDK_BDEV_IO_POOL_SIZE			(64 * 1024 - 1)
63 #define SPDK_BDEV_IO_CACHE_SIZE			256
64 #define SPDK_BDEV_AUTO_EXAMINE			true
65 #define BUF_SMALL_POOL_SIZE			8191
66 #define BUF_LARGE_POOL_SIZE			1023
67 #define NOMEM_THRESHOLD_COUNT			8
68 #define ZERO_BUFFER_SIZE			0x100000
69 
70 #define OWNER_BDEV		0x2
71 
72 #define OBJECT_BDEV_IO		0x2
73 
74 #define TRACE_GROUP_BDEV	0x3
75 #define TRACE_BDEV_IO_START	SPDK_TPOINT_ID(TRACE_GROUP_BDEV, 0x0)
76 #define TRACE_BDEV_IO_DONE	SPDK_TPOINT_ID(TRACE_GROUP_BDEV, 0x1)
77 
78 #define SPDK_BDEV_QOS_TIMESLICE_IN_USEC		1000
79 #define SPDK_BDEV_QOS_MIN_IO_PER_TIMESLICE	1
80 #define SPDK_BDEV_QOS_MIN_BYTE_PER_TIMESLICE	512
81 #define SPDK_BDEV_QOS_MIN_IOS_PER_SEC		1000
82 #define SPDK_BDEV_QOS_MIN_BYTES_PER_SEC		(1024 * 1024)
83 #define SPDK_BDEV_QOS_LIMIT_NOT_DEFINED		UINT64_MAX
84 #define SPDK_BDEV_IO_POLL_INTERVAL_IN_MSEC	1000
85 
86 #define SPDK_BDEV_POOL_ALIGNMENT 512
87 
88 /* The maximum number of children requests for a UNMAP or WRITE ZEROES command
89  * when splitting into children requests at a time.
90  */
91 #define SPDK_BDEV_MAX_CHILDREN_UNMAP_WRITE_ZEROES_REQS (8)
92 
93 static const char *qos_rpc_type[] = {"rw_ios_per_sec",
94 				     "rw_mbytes_per_sec", "r_mbytes_per_sec", "w_mbytes_per_sec"
95 				    };
96 
97 TAILQ_HEAD(spdk_bdev_list, spdk_bdev);
98 
99 RB_HEAD(bdev_name_tree, spdk_bdev_name);
100 
101 static int
102 bdev_name_cmp(struct spdk_bdev_name *name1, struct spdk_bdev_name *name2)
103 {
104 	return strcmp(name1->name, name2->name);
105 }
106 
107 RB_GENERATE_STATIC(bdev_name_tree, spdk_bdev_name, node, bdev_name_cmp);
108 
109 struct spdk_bdev_mgr {
110 	struct spdk_mempool *bdev_io_pool;
111 
112 	struct spdk_mempool *buf_small_pool;
113 	struct spdk_mempool *buf_large_pool;
114 
115 	void *zero_buffer;
116 
117 	TAILQ_HEAD(bdev_module_list, spdk_bdev_module) bdev_modules;
118 
119 	struct spdk_bdev_list bdevs;
120 	struct bdev_name_tree bdev_names;
121 
122 	bool init_complete;
123 	bool module_init_complete;
124 
125 	pthread_mutex_t mutex;
126 
127 #ifdef SPDK_CONFIG_VTUNE
128 	__itt_domain	*domain;
129 #endif
130 };
131 
132 static struct spdk_bdev_mgr g_bdev_mgr = {
133 	.bdev_modules = TAILQ_HEAD_INITIALIZER(g_bdev_mgr.bdev_modules),
134 	.bdevs = TAILQ_HEAD_INITIALIZER(g_bdev_mgr.bdevs),
135 	.bdev_names = RB_INITIALIZER(g_bdev_mgr.bdev_names),
136 	.init_complete = false,
137 	.module_init_complete = false,
138 	.mutex = PTHREAD_MUTEX_INITIALIZER,
139 };
140 
141 typedef void (*lock_range_cb)(void *ctx, int status);
142 
143 struct lba_range {
144 	uint64_t			offset;
145 	uint64_t			length;
146 	void				*locked_ctx;
147 	struct spdk_bdev_channel	*owner_ch;
148 	TAILQ_ENTRY(lba_range)		tailq;
149 };
150 
151 static struct spdk_bdev_opts	g_bdev_opts = {
152 	.bdev_io_pool_size = SPDK_BDEV_IO_POOL_SIZE,
153 	.bdev_io_cache_size = SPDK_BDEV_IO_CACHE_SIZE,
154 	.bdev_auto_examine = SPDK_BDEV_AUTO_EXAMINE,
155 	.small_buf_pool_size = BUF_SMALL_POOL_SIZE,
156 	.large_buf_pool_size = BUF_LARGE_POOL_SIZE,
157 };
158 
159 static spdk_bdev_init_cb	g_init_cb_fn = NULL;
160 static void			*g_init_cb_arg = NULL;
161 
162 static spdk_bdev_fini_cb	g_fini_cb_fn = NULL;
163 static void			*g_fini_cb_arg = NULL;
164 static struct spdk_thread	*g_fini_thread = NULL;
165 
166 struct spdk_bdev_qos_limit {
167 	/** IOs or bytes allowed per second (i.e., 1s). */
168 	uint64_t limit;
169 
170 	/** Remaining IOs or bytes allowed in current timeslice (e.g., 1ms).
171 	 *  For remaining bytes, allowed to run negative if an I/O is submitted when
172 	 *  some bytes are remaining, but the I/O is bigger than that amount. The
173 	 *  excess will be deducted from the next timeslice.
174 	 */
175 	int64_t remaining_this_timeslice;
176 
177 	/** Minimum allowed IOs or bytes to be issued in one timeslice (e.g., 1ms). */
178 	uint32_t min_per_timeslice;
179 
180 	/** Maximum allowed IOs or bytes to be issued in one timeslice (e.g., 1ms). */
181 	uint32_t max_per_timeslice;
182 
183 	/** Function to check whether to queue the IO. */
184 	bool (*queue_io)(const struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io);
185 
186 	/** Function to update for the submitted IO. */
187 	void (*update_quota)(struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io);
188 };
189 
190 struct spdk_bdev_qos {
191 	/** Types of structure of rate limits. */
192 	struct spdk_bdev_qos_limit rate_limits[SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES];
193 
194 	/** The channel that all I/O are funneled through. */
195 	struct spdk_bdev_channel *ch;
196 
197 	/** The thread on which the poller is running. */
198 	struct spdk_thread *thread;
199 
200 	/** Queue of I/O waiting to be issued. */
201 	bdev_io_tailq_t queued;
202 
203 	/** Size of a timeslice in tsc ticks. */
204 	uint64_t timeslice_size;
205 
206 	/** Timestamp of start of last timeslice. */
207 	uint64_t last_timeslice;
208 
209 	/** Poller that processes queued I/O commands each time slice. */
210 	struct spdk_poller *poller;
211 };
212 
213 struct spdk_bdev_mgmt_channel {
214 	bdev_io_stailq_t need_buf_small;
215 	bdev_io_stailq_t need_buf_large;
216 
217 	/*
218 	 * Each thread keeps a cache of bdev_io - this allows
219 	 *  bdev threads which are *not* DPDK threads to still
220 	 *  benefit from a per-thread bdev_io cache.  Without
221 	 *  this, non-DPDK threads fetching from the mempool
222 	 *  incur a cmpxchg on get and put.
223 	 */
224 	bdev_io_stailq_t per_thread_cache;
225 	uint32_t	per_thread_cache_count;
226 	uint32_t	bdev_io_cache_size;
227 
228 	TAILQ_HEAD(, spdk_bdev_shared_resource)	shared_resources;
229 	TAILQ_HEAD(, spdk_bdev_io_wait_entry)	io_wait_queue;
230 };
231 
232 /*
233  * Per-module (or per-io_device) data. Multiple bdevs built on the same io_device
234  * will queue here their IO that awaits retry. It makes it possible to retry sending
235  * IO to one bdev after IO from other bdev completes.
236  */
237 struct spdk_bdev_shared_resource {
238 	/* The bdev management channel */
239 	struct spdk_bdev_mgmt_channel *mgmt_ch;
240 
241 	/*
242 	 * Count of I/O submitted to bdev module and waiting for completion.
243 	 * Incremented before submit_request() is called on an spdk_bdev_io.
244 	 */
245 	uint64_t		io_outstanding;
246 
247 	/*
248 	 * Queue of IO awaiting retry because of a previous NOMEM status returned
249 	 *  on this channel.
250 	 */
251 	bdev_io_tailq_t		nomem_io;
252 
253 	/*
254 	 * Threshold which io_outstanding must drop to before retrying nomem_io.
255 	 */
256 	uint64_t		nomem_threshold;
257 
258 	/* I/O channel allocated by a bdev module */
259 	struct spdk_io_channel	*shared_ch;
260 
261 	/* Refcount of bdev channels using this resource */
262 	uint32_t		ref;
263 
264 	TAILQ_ENTRY(spdk_bdev_shared_resource) link;
265 };
266 
267 #define BDEV_CH_RESET_IN_PROGRESS	(1 << 0)
268 #define BDEV_CH_QOS_ENABLED		(1 << 1)
269 
270 struct spdk_bdev_channel {
271 	struct spdk_bdev	*bdev;
272 
273 	/* The channel for the underlying device */
274 	struct spdk_io_channel	*channel;
275 
276 	/* Per io_device per thread data */
277 	struct spdk_bdev_shared_resource *shared_resource;
278 
279 	struct spdk_bdev_io_stat stat;
280 
281 	/*
282 	 * Count of I/O submitted to the underlying dev module through this channel
283 	 * and waiting for completion.
284 	 */
285 	uint64_t		io_outstanding;
286 
287 	/*
288 	 * List of all submitted I/Os including I/O that are generated via splitting.
289 	 */
290 	bdev_io_tailq_t		io_submitted;
291 
292 	/*
293 	 * List of spdk_bdev_io that are currently queued because they write to a locked
294 	 * LBA range.
295 	 */
296 	bdev_io_tailq_t		io_locked;
297 
298 	uint32_t		flags;
299 
300 	struct spdk_histogram_data *histogram;
301 
302 #ifdef SPDK_CONFIG_VTUNE
303 	uint64_t		start_tsc;
304 	uint64_t		interval_tsc;
305 	__itt_string_handle	*handle;
306 	struct spdk_bdev_io_stat prev_stat;
307 #endif
308 
309 	bdev_io_tailq_t		queued_resets;
310 
311 	lba_range_tailq_t	locked_ranges;
312 };
313 
314 struct media_event_entry {
315 	struct spdk_bdev_media_event	event;
316 	TAILQ_ENTRY(media_event_entry)	tailq;
317 };
318 
319 #define MEDIA_EVENT_POOL_SIZE 64
320 
321 struct spdk_bdev_desc {
322 	struct spdk_bdev		*bdev;
323 	struct spdk_thread		*thread;
324 	struct {
325 		spdk_bdev_event_cb_t event_fn;
326 		void *ctx;
327 	}				callback;
328 	bool				closed;
329 	bool				write;
330 	pthread_mutex_t			mutex;
331 	uint32_t			refs;
332 	TAILQ_HEAD(, media_event_entry)	pending_media_events;
333 	TAILQ_HEAD(, media_event_entry)	free_media_events;
334 	struct media_event_entry	*media_events_buffer;
335 	TAILQ_ENTRY(spdk_bdev_desc)	link;
336 
337 	uint64_t		timeout_in_sec;
338 	spdk_bdev_io_timeout_cb	cb_fn;
339 	void			*cb_arg;
340 	struct spdk_poller	*io_timeout_poller;
341 };
342 
343 struct spdk_bdev_iostat_ctx {
344 	struct spdk_bdev_io_stat *stat;
345 	spdk_bdev_get_device_stat_cb cb;
346 	void *cb_arg;
347 };
348 
349 struct set_qos_limit_ctx {
350 	void (*cb_fn)(void *cb_arg, int status);
351 	void *cb_arg;
352 	struct spdk_bdev *bdev;
353 };
354 
355 #define __bdev_to_io_dev(bdev)		(((char *)bdev) + 1)
356 #define __bdev_from_io_dev(io_dev)	((struct spdk_bdev *)(((char *)io_dev) - 1))
357 
358 static void bdev_write_zero_buffer_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg);
359 static void bdev_write_zero_buffer_next(void *_bdev_io);
360 
361 static void bdev_enable_qos_msg(struct spdk_io_channel_iter *i);
362 static void bdev_enable_qos_done(struct spdk_io_channel_iter *i, int status);
363 
364 static int
365 bdev_readv_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
366 			  struct iovec *iov, int iovcnt, void *md_buf, uint64_t offset_blocks,
367 			  uint64_t num_blocks, spdk_bdev_io_completion_cb cb, void *cb_arg,
368 			  struct spdk_bdev_ext_io_opts *opts);
369 static int
370 bdev_writev_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
371 			   struct iovec *iov, int iovcnt, void *md_buf,
372 			   uint64_t offset_blocks, uint64_t num_blocks,
373 			   spdk_bdev_io_completion_cb cb, void *cb_arg,
374 			   struct spdk_bdev_ext_io_opts *opts);
375 
376 static int
377 bdev_lock_lba_range(struct spdk_bdev_desc *desc, struct spdk_io_channel *_ch,
378 		    uint64_t offset, uint64_t length,
379 		    lock_range_cb cb_fn, void *cb_arg);
380 
381 static int
382 bdev_unlock_lba_range(struct spdk_bdev_desc *desc, struct spdk_io_channel *_ch,
383 		      uint64_t offset, uint64_t length,
384 		      lock_range_cb cb_fn, void *cb_arg);
385 
386 static inline void bdev_io_complete(void *ctx);
387 
388 static bool bdev_abort_queued_io(bdev_io_tailq_t *queue, struct spdk_bdev_io *bio_to_abort);
389 static bool bdev_abort_buf_io(bdev_io_stailq_t *queue, struct spdk_bdev_io *bio_to_abort);
390 
391 void
392 spdk_bdev_get_opts(struct spdk_bdev_opts *opts, size_t opts_size)
393 {
394 	if (!opts) {
395 		SPDK_ERRLOG("opts should not be NULL\n");
396 		return;
397 	}
398 
399 	if (!opts_size) {
400 		SPDK_ERRLOG("opts_size should not be zero value\n");
401 		return;
402 	}
403 
404 	opts->opts_size = opts_size;
405 
406 #define SET_FIELD(field) \
407 	if (offsetof(struct spdk_bdev_opts, field) + sizeof(opts->field) <= opts_size) { \
408 		opts->field = g_bdev_opts.field; \
409 	} \
410 
411 	SET_FIELD(bdev_io_pool_size);
412 	SET_FIELD(bdev_io_cache_size);
413 	SET_FIELD(bdev_auto_examine);
414 	SET_FIELD(small_buf_pool_size);
415 	SET_FIELD(large_buf_pool_size);
416 
417 	/* Do not remove this statement, you should always update this statement when you adding a new field,
418 	 * and do not forget to add the SET_FIELD statement for your added field. */
419 	SPDK_STATIC_ASSERT(sizeof(struct spdk_bdev_opts) == 32, "Incorrect size");
420 
421 #undef SET_FIELD
422 }
423 
424 int
425 spdk_bdev_set_opts(struct spdk_bdev_opts *opts)
426 {
427 	uint32_t min_pool_size;
428 
429 	if (!opts) {
430 		SPDK_ERRLOG("opts cannot be NULL\n");
431 		return -1;
432 	}
433 
434 	if (!opts->opts_size) {
435 		SPDK_ERRLOG("opts_size inside opts cannot be zero value\n");
436 		return -1;
437 	}
438 
439 	/*
440 	 * Add 1 to the thread count to account for the extra mgmt_ch that gets created during subsystem
441 	 *  initialization.  A second mgmt_ch will be created on the same thread when the application starts
442 	 *  but before the deferred put_io_channel event is executed for the first mgmt_ch.
443 	 */
444 	min_pool_size = opts->bdev_io_cache_size * (spdk_thread_get_count() + 1);
445 	if (opts->bdev_io_pool_size < min_pool_size) {
446 		SPDK_ERRLOG("bdev_io_pool_size %" PRIu32 " is not compatible with bdev_io_cache_size %" PRIu32
447 			    " and %" PRIu32 " threads\n", opts->bdev_io_pool_size, opts->bdev_io_cache_size,
448 			    spdk_thread_get_count());
449 		SPDK_ERRLOG("bdev_io_pool_size must be at least %" PRIu32 "\n", min_pool_size);
450 		return -1;
451 	}
452 
453 	if (opts->small_buf_pool_size < BUF_SMALL_POOL_SIZE) {
454 		SPDK_ERRLOG("small_buf_pool_size must be at least %" PRIu32 "\n", BUF_SMALL_POOL_SIZE);
455 		return -1;
456 	}
457 
458 	if (opts->large_buf_pool_size < BUF_LARGE_POOL_SIZE) {
459 		SPDK_ERRLOG("large_buf_pool_size must be at least %" PRIu32 "\n", BUF_LARGE_POOL_SIZE);
460 		return -1;
461 	}
462 
463 #define SET_FIELD(field) \
464         if (offsetof(struct spdk_bdev_opts, field) + sizeof(opts->field) <= opts->opts_size) { \
465                 g_bdev_opts.field = opts->field; \
466         } \
467 
468 	SET_FIELD(bdev_io_pool_size);
469 	SET_FIELD(bdev_io_cache_size);
470 	SET_FIELD(bdev_auto_examine);
471 	SET_FIELD(small_buf_pool_size);
472 	SET_FIELD(large_buf_pool_size);
473 
474 	g_bdev_opts.opts_size = opts->opts_size;
475 
476 #undef SET_FIELD
477 
478 	return 0;
479 }
480 
481 static struct spdk_bdev *
482 bdev_get_by_name(const char *bdev_name)
483 {
484 	struct spdk_bdev_name find;
485 	struct spdk_bdev_name *res;
486 
487 	find.name = (char *)bdev_name;
488 	res = RB_FIND(bdev_name_tree, &g_bdev_mgr.bdev_names, &find);
489 	if (res != NULL) {
490 		return res->bdev;
491 	}
492 
493 	return NULL;
494 }
495 
496 struct spdk_bdev *
497 spdk_bdev_get_by_name(const char *bdev_name)
498 {
499 	struct spdk_bdev *bdev;
500 
501 	pthread_mutex_lock(&g_bdev_mgr.mutex);
502 	bdev = bdev_get_by_name(bdev_name);
503 	pthread_mutex_unlock(&g_bdev_mgr.mutex);
504 
505 	return bdev;
506 }
507 
508 struct spdk_bdev_wait_for_examine_ctx {
509 	struct spdk_poller              *poller;
510 	spdk_bdev_wait_for_examine_cb	cb_fn;
511 	void				*cb_arg;
512 };
513 
514 static bool
515 bdev_module_all_actions_completed(void);
516 
517 static int
518 bdev_wait_for_examine_cb(void *arg)
519 {
520 	struct spdk_bdev_wait_for_examine_ctx *ctx = arg;
521 
522 	if (!bdev_module_all_actions_completed()) {
523 		return SPDK_POLLER_IDLE;
524 	}
525 
526 	spdk_poller_unregister(&ctx->poller);
527 	ctx->cb_fn(ctx->cb_arg);
528 	free(ctx);
529 
530 	return SPDK_POLLER_BUSY;
531 }
532 
533 int
534 spdk_bdev_wait_for_examine(spdk_bdev_wait_for_examine_cb cb_fn, void *cb_arg)
535 {
536 	struct spdk_bdev_wait_for_examine_ctx *ctx;
537 
538 	ctx = calloc(1, sizeof(*ctx));
539 	if (ctx == NULL) {
540 		return -ENOMEM;
541 	}
542 	ctx->cb_fn = cb_fn;
543 	ctx->cb_arg = cb_arg;
544 	ctx->poller = SPDK_POLLER_REGISTER(bdev_wait_for_examine_cb, ctx, 0);
545 
546 	return 0;
547 }
548 
549 struct spdk_bdev_examine_item {
550 	char *name;
551 	TAILQ_ENTRY(spdk_bdev_examine_item) link;
552 };
553 
554 TAILQ_HEAD(spdk_bdev_examine_allowlist, spdk_bdev_examine_item);
555 
556 struct spdk_bdev_examine_allowlist g_bdev_examine_allowlist = TAILQ_HEAD_INITIALIZER(
557 			g_bdev_examine_allowlist);
558 
559 static inline bool
560 bdev_examine_allowlist_check(const char *name)
561 {
562 	struct spdk_bdev_examine_item *item;
563 	TAILQ_FOREACH(item, &g_bdev_examine_allowlist, link) {
564 		if (strcmp(name, item->name) == 0) {
565 			return true;
566 		}
567 	}
568 	return false;
569 }
570 
571 static inline void
572 bdev_examine_allowlist_free(void)
573 {
574 	struct spdk_bdev_examine_item *item;
575 	while (!TAILQ_EMPTY(&g_bdev_examine_allowlist)) {
576 		item = TAILQ_FIRST(&g_bdev_examine_allowlist);
577 		TAILQ_REMOVE(&g_bdev_examine_allowlist, item, link);
578 		free(item->name);
579 		free(item);
580 	}
581 }
582 
583 static inline bool
584 bdev_in_examine_allowlist(struct spdk_bdev *bdev)
585 {
586 	struct spdk_bdev_alias *tmp;
587 	if (bdev_examine_allowlist_check(bdev->name)) {
588 		return true;
589 	}
590 	TAILQ_FOREACH(tmp, &bdev->aliases, tailq) {
591 		if (bdev_examine_allowlist_check(tmp->alias.name)) {
592 			return true;
593 		}
594 	}
595 	return false;
596 }
597 
598 static inline bool
599 bdev_ok_to_examine(struct spdk_bdev *bdev)
600 {
601 	if (g_bdev_opts.bdev_auto_examine) {
602 		return true;
603 	} else {
604 		return bdev_in_examine_allowlist(bdev);
605 	}
606 }
607 
608 static void
609 bdev_examine(struct spdk_bdev *bdev)
610 {
611 	struct spdk_bdev_module *module;
612 	uint32_t action;
613 
614 	TAILQ_FOREACH(module, &g_bdev_mgr.bdev_modules, internal.tailq) {
615 		if (module->examine_config && bdev_ok_to_examine(bdev)) {
616 			action = module->internal.action_in_progress;
617 			module->internal.action_in_progress++;
618 			module->examine_config(bdev);
619 			if (action != module->internal.action_in_progress) {
620 				SPDK_ERRLOG("examine_config for module %s did not call spdk_bdev_module_examine_done()\n",
621 					    module->name);
622 			}
623 		}
624 	}
625 
626 	if (bdev->internal.claim_module && bdev_ok_to_examine(bdev)) {
627 		if (bdev->internal.claim_module->examine_disk) {
628 			bdev->internal.claim_module->internal.action_in_progress++;
629 			bdev->internal.claim_module->examine_disk(bdev);
630 		}
631 		return;
632 	}
633 
634 	TAILQ_FOREACH(module, &g_bdev_mgr.bdev_modules, internal.tailq) {
635 		if (module->examine_disk && bdev_ok_to_examine(bdev)) {
636 			module->internal.action_in_progress++;
637 			module->examine_disk(bdev);
638 		}
639 	}
640 }
641 
642 int
643 spdk_bdev_examine(const char *name)
644 {
645 	struct spdk_bdev *bdev;
646 	struct spdk_bdev_examine_item *item;
647 
648 	if (g_bdev_opts.bdev_auto_examine) {
649 		SPDK_ERRLOG("Manual examine is not allowed if auto examine is enabled");
650 		return -EINVAL;
651 	}
652 
653 	if (bdev_examine_allowlist_check(name)) {
654 		SPDK_ERRLOG("Duplicate bdev name for manual examine: %s\n", name);
655 		return -EEXIST;
656 	}
657 
658 	item = calloc(1, sizeof(*item));
659 	if (!item) {
660 		return -ENOMEM;
661 	}
662 	item->name = strdup(name);
663 	if (!item->name) {
664 		free(item);
665 		return -ENOMEM;
666 	}
667 	TAILQ_INSERT_TAIL(&g_bdev_examine_allowlist, item, link);
668 
669 	bdev = spdk_bdev_get_by_name(name);
670 	if (bdev) {
671 		bdev_examine(bdev);
672 	}
673 	return 0;
674 }
675 
676 static inline void
677 bdev_examine_allowlist_config_json(struct spdk_json_write_ctx *w)
678 {
679 	struct spdk_bdev_examine_item *item;
680 	TAILQ_FOREACH(item, &g_bdev_examine_allowlist, link) {
681 		spdk_json_write_object_begin(w);
682 		spdk_json_write_named_string(w, "method", "bdev_examine");
683 		spdk_json_write_named_object_begin(w, "params");
684 		spdk_json_write_named_string(w, "name", item->name);
685 		spdk_json_write_object_end(w);
686 		spdk_json_write_object_end(w);
687 	}
688 }
689 
690 struct spdk_bdev *
691 spdk_bdev_first(void)
692 {
693 	struct spdk_bdev *bdev;
694 
695 	bdev = TAILQ_FIRST(&g_bdev_mgr.bdevs);
696 	if (bdev) {
697 		SPDK_DEBUGLOG(bdev, "Starting bdev iteration at %s\n", bdev->name);
698 	}
699 
700 	return bdev;
701 }
702 
703 struct spdk_bdev *
704 spdk_bdev_next(struct spdk_bdev *prev)
705 {
706 	struct spdk_bdev *bdev;
707 
708 	bdev = TAILQ_NEXT(prev, internal.link);
709 	if (bdev) {
710 		SPDK_DEBUGLOG(bdev, "Continuing bdev iteration at %s\n", bdev->name);
711 	}
712 
713 	return bdev;
714 }
715 
716 static struct spdk_bdev *
717 _bdev_next_leaf(struct spdk_bdev *bdev)
718 {
719 	while (bdev != NULL) {
720 		if (bdev->internal.claim_module == NULL) {
721 			return bdev;
722 		} else {
723 			bdev = TAILQ_NEXT(bdev, internal.link);
724 		}
725 	}
726 
727 	return bdev;
728 }
729 
730 struct spdk_bdev *
731 spdk_bdev_first_leaf(void)
732 {
733 	struct spdk_bdev *bdev;
734 
735 	bdev = _bdev_next_leaf(TAILQ_FIRST(&g_bdev_mgr.bdevs));
736 
737 	if (bdev) {
738 		SPDK_DEBUGLOG(bdev, "Starting bdev iteration at %s\n", bdev->name);
739 	}
740 
741 	return bdev;
742 }
743 
744 struct spdk_bdev *
745 spdk_bdev_next_leaf(struct spdk_bdev *prev)
746 {
747 	struct spdk_bdev *bdev;
748 
749 	bdev = _bdev_next_leaf(TAILQ_NEXT(prev, internal.link));
750 
751 	if (bdev) {
752 		SPDK_DEBUGLOG(bdev, "Continuing bdev iteration at %s\n", bdev->name);
753 	}
754 
755 	return bdev;
756 }
757 
758 void
759 spdk_bdev_io_set_buf(struct spdk_bdev_io *bdev_io, void *buf, size_t len)
760 {
761 	struct iovec *iovs;
762 
763 	if (bdev_io->u.bdev.iovs == NULL) {
764 		bdev_io->u.bdev.iovs = &bdev_io->iov;
765 		bdev_io->u.bdev.iovcnt = 1;
766 	}
767 
768 	iovs = bdev_io->u.bdev.iovs;
769 
770 	assert(iovs != NULL);
771 	assert(bdev_io->u.bdev.iovcnt >= 1);
772 
773 	iovs[0].iov_base = buf;
774 	iovs[0].iov_len = len;
775 }
776 
777 void
778 spdk_bdev_io_set_md_buf(struct spdk_bdev_io *bdev_io, void *md_buf, size_t len)
779 {
780 	assert((len / spdk_bdev_get_md_size(bdev_io->bdev)) >= bdev_io->u.bdev.num_blocks);
781 	bdev_io->u.bdev.md_buf = md_buf;
782 }
783 
784 static bool
785 _is_buf_allocated(const struct iovec *iovs)
786 {
787 	if (iovs == NULL) {
788 		return false;
789 	}
790 
791 	return iovs[0].iov_base != NULL;
792 }
793 
794 static bool
795 _are_iovs_aligned(struct iovec *iovs, int iovcnt, uint32_t alignment)
796 {
797 	int i;
798 	uintptr_t iov_base;
799 
800 	if (spdk_likely(alignment == 1)) {
801 		return true;
802 	}
803 
804 	for (i = 0; i < iovcnt; i++) {
805 		iov_base = (uintptr_t)iovs[i].iov_base;
806 		if ((iov_base & (alignment - 1)) != 0) {
807 			return false;
808 		}
809 	}
810 
811 	return true;
812 }
813 
814 static void
815 _copy_iovs_to_buf(void *buf, size_t buf_len, struct iovec *iovs, int iovcnt)
816 {
817 	int i;
818 	size_t len;
819 
820 	for (i = 0; i < iovcnt; i++) {
821 		len = spdk_min(iovs[i].iov_len, buf_len);
822 		memcpy(buf, iovs[i].iov_base, len);
823 		buf += len;
824 		buf_len -= len;
825 	}
826 }
827 
828 static void
829 _copy_buf_to_iovs(struct iovec *iovs, int iovcnt, void *buf, size_t buf_len)
830 {
831 	int i;
832 	size_t len;
833 
834 	for (i = 0; i < iovcnt; i++) {
835 		len = spdk_min(iovs[i].iov_len, buf_len);
836 		memcpy(iovs[i].iov_base, buf, len);
837 		buf += len;
838 		buf_len -= len;
839 	}
840 }
841 
842 static void
843 _bdev_io_set_bounce_buf(struct spdk_bdev_io *bdev_io, void *buf, size_t len)
844 {
845 	/* save original iovec */
846 	bdev_io->internal.orig_iovs = bdev_io->u.bdev.iovs;
847 	bdev_io->internal.orig_iovcnt = bdev_io->u.bdev.iovcnt;
848 	/* set bounce iov */
849 	bdev_io->u.bdev.iovs = &bdev_io->internal.bounce_iov;
850 	bdev_io->u.bdev.iovcnt = 1;
851 	/* set bounce buffer for this operation */
852 	bdev_io->u.bdev.iovs[0].iov_base = buf;
853 	bdev_io->u.bdev.iovs[0].iov_len = len;
854 	/* if this is write path, copy data from original buffer to bounce buffer */
855 	if (bdev_io->type == SPDK_BDEV_IO_TYPE_WRITE) {
856 		_copy_iovs_to_buf(buf, len, bdev_io->internal.orig_iovs, bdev_io->internal.orig_iovcnt);
857 	}
858 }
859 
860 static void
861 _bdev_io_set_bounce_md_buf(struct spdk_bdev_io *bdev_io, void *md_buf, size_t len)
862 {
863 	/* save original md_buf */
864 	bdev_io->internal.orig_md_buf = bdev_io->u.bdev.md_buf;
865 	/* set bounce md_buf */
866 	bdev_io->u.bdev.md_buf = md_buf;
867 
868 	if (bdev_io->type == SPDK_BDEV_IO_TYPE_WRITE) {
869 		memcpy(md_buf, bdev_io->internal.orig_md_buf, len);
870 	}
871 }
872 
873 static void
874 bdev_io_get_buf_complete(struct spdk_bdev_io *bdev_io, void *buf, bool status)
875 {
876 	struct spdk_io_channel *ch = spdk_bdev_io_get_io_channel(bdev_io);
877 
878 	if (spdk_unlikely(bdev_io->internal.get_aux_buf_cb != NULL)) {
879 		bdev_io->internal.get_aux_buf_cb(ch, bdev_io, buf);
880 		bdev_io->internal.get_aux_buf_cb = NULL;
881 	} else {
882 		assert(bdev_io->internal.get_buf_cb != NULL);
883 		bdev_io->internal.buf = buf;
884 		bdev_io->internal.get_buf_cb(ch, bdev_io, status);
885 		bdev_io->internal.get_buf_cb = NULL;
886 	}
887 }
888 
889 static void
890 _bdev_io_set_buf(struct spdk_bdev_io *bdev_io, void *buf, uint64_t len)
891 {
892 	struct spdk_bdev *bdev = bdev_io->bdev;
893 	bool buf_allocated;
894 	uint64_t md_len, alignment;
895 	void *aligned_buf;
896 
897 	if (spdk_unlikely(bdev_io->internal.get_aux_buf_cb != NULL)) {
898 		bdev_io_get_buf_complete(bdev_io, buf, true);
899 		return;
900 	}
901 
902 	alignment = spdk_bdev_get_buf_align(bdev);
903 	buf_allocated = _is_buf_allocated(bdev_io->u.bdev.iovs);
904 	aligned_buf = (void *)(((uintptr_t)buf + (alignment - 1)) & ~(alignment - 1));
905 
906 	if (buf_allocated) {
907 		_bdev_io_set_bounce_buf(bdev_io, aligned_buf, len);
908 	} else {
909 		spdk_bdev_io_set_buf(bdev_io, aligned_buf, len);
910 	}
911 
912 	if (spdk_bdev_is_md_separate(bdev)) {
913 		aligned_buf = (char *)aligned_buf + len;
914 		md_len = bdev_io->u.bdev.num_blocks * bdev->md_len;
915 
916 		assert(((uintptr_t)aligned_buf & (alignment - 1)) == 0);
917 
918 		if (bdev_io->u.bdev.md_buf != NULL) {
919 			_bdev_io_set_bounce_md_buf(bdev_io, aligned_buf, md_len);
920 		} else {
921 			spdk_bdev_io_set_md_buf(bdev_io, aligned_buf, md_len);
922 		}
923 	}
924 	bdev_io_get_buf_complete(bdev_io, buf, true);
925 }
926 
927 static void
928 _bdev_io_put_buf(struct spdk_bdev_io *bdev_io, void *buf, uint64_t buf_len)
929 {
930 	struct spdk_bdev *bdev = bdev_io->bdev;
931 	struct spdk_mempool *pool;
932 	struct spdk_bdev_io *tmp;
933 	bdev_io_stailq_t *stailq;
934 	struct spdk_bdev_mgmt_channel *ch;
935 	uint64_t md_len, alignment;
936 
937 	md_len = spdk_bdev_is_md_separate(bdev) ? bdev_io->u.bdev.num_blocks * bdev->md_len : 0;
938 	alignment = spdk_bdev_get_buf_align(bdev);
939 	ch = bdev_io->internal.ch->shared_resource->mgmt_ch;
940 
941 	if (buf_len + alignment + md_len <= SPDK_BDEV_BUF_SIZE_WITH_MD(SPDK_BDEV_SMALL_BUF_MAX_SIZE) +
942 	    SPDK_BDEV_POOL_ALIGNMENT) {
943 		pool = g_bdev_mgr.buf_small_pool;
944 		stailq = &ch->need_buf_small;
945 	} else {
946 		pool = g_bdev_mgr.buf_large_pool;
947 		stailq = &ch->need_buf_large;
948 	}
949 
950 	if (STAILQ_EMPTY(stailq)) {
951 		spdk_mempool_put(pool, buf);
952 	} else {
953 		tmp = STAILQ_FIRST(stailq);
954 		STAILQ_REMOVE_HEAD(stailq, internal.buf_link);
955 		_bdev_io_set_buf(tmp, buf, tmp->internal.buf_len);
956 	}
957 }
958 
959 static void
960 bdev_io_put_buf(struct spdk_bdev_io *bdev_io)
961 {
962 	assert(bdev_io->internal.buf != NULL);
963 	_bdev_io_put_buf(bdev_io, bdev_io->internal.buf, bdev_io->internal.buf_len);
964 	bdev_io->internal.buf = NULL;
965 }
966 
967 void
968 spdk_bdev_io_put_aux_buf(struct spdk_bdev_io *bdev_io, void *buf)
969 {
970 	uint64_t len = bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen;
971 
972 	assert(buf != NULL);
973 	_bdev_io_put_buf(bdev_io, buf, len);
974 }
975 
976 static void
977 _bdev_io_unset_bounce_buf(struct spdk_bdev_io *bdev_io)
978 {
979 	if (spdk_likely(bdev_io->internal.orig_iovcnt == 0)) {
980 		assert(bdev_io->internal.orig_md_buf == NULL);
981 		return;
982 	}
983 
984 	/* if this is read path, copy data from bounce buffer to original buffer */
985 	if (bdev_io->type == SPDK_BDEV_IO_TYPE_READ &&
986 	    bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS) {
987 		_copy_buf_to_iovs(bdev_io->internal.orig_iovs,
988 				  bdev_io->internal.orig_iovcnt,
989 				  bdev_io->internal.bounce_iov.iov_base,
990 				  bdev_io->internal.bounce_iov.iov_len);
991 	}
992 	/* set original buffer for this io */
993 	bdev_io->u.bdev.iovcnt = bdev_io->internal.orig_iovcnt;
994 	bdev_io->u.bdev.iovs = bdev_io->internal.orig_iovs;
995 	/* disable bouncing buffer for this io */
996 	bdev_io->internal.orig_iovcnt = 0;
997 	bdev_io->internal.orig_iovs = NULL;
998 
999 	/* do the same for metadata buffer */
1000 	if (spdk_unlikely(bdev_io->internal.orig_md_buf != NULL)) {
1001 		assert(spdk_bdev_is_md_separate(bdev_io->bdev));
1002 
1003 		if (bdev_io->type == SPDK_BDEV_IO_TYPE_READ &&
1004 		    bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS) {
1005 			memcpy(bdev_io->internal.orig_md_buf, bdev_io->u.bdev.md_buf,
1006 			       bdev_io->u.bdev.num_blocks * spdk_bdev_get_md_size(bdev_io->bdev));
1007 		}
1008 
1009 		bdev_io->u.bdev.md_buf = bdev_io->internal.orig_md_buf;
1010 		bdev_io->internal.orig_md_buf = NULL;
1011 	}
1012 
1013 	/* We want to free the bounce buffer here since we know we're done with it (as opposed
1014 	 * to waiting for the conditional free of internal.buf in spdk_bdev_free_io()).
1015 	 */
1016 	bdev_io_put_buf(bdev_io);
1017 }
1018 
1019 static void
1020 bdev_io_get_buf(struct spdk_bdev_io *bdev_io, uint64_t len)
1021 {
1022 	struct spdk_bdev *bdev = bdev_io->bdev;
1023 	struct spdk_mempool *pool;
1024 	bdev_io_stailq_t *stailq;
1025 	struct spdk_bdev_mgmt_channel *mgmt_ch;
1026 	uint64_t alignment, md_len;
1027 	void *buf;
1028 
1029 	alignment = spdk_bdev_get_buf_align(bdev);
1030 	md_len = spdk_bdev_is_md_separate(bdev) ? bdev_io->u.bdev.num_blocks * bdev->md_len : 0;
1031 
1032 	if (len + alignment + md_len > SPDK_BDEV_BUF_SIZE_WITH_MD(SPDK_BDEV_LARGE_BUF_MAX_SIZE) +
1033 	    SPDK_BDEV_POOL_ALIGNMENT) {
1034 		SPDK_ERRLOG("Length + alignment %" PRIu64 " is larger than allowed\n",
1035 			    len + alignment);
1036 		bdev_io_get_buf_complete(bdev_io, NULL, false);
1037 		return;
1038 	}
1039 
1040 	mgmt_ch = bdev_io->internal.ch->shared_resource->mgmt_ch;
1041 
1042 	bdev_io->internal.buf_len = len;
1043 
1044 	if (len + alignment + md_len <= SPDK_BDEV_BUF_SIZE_WITH_MD(SPDK_BDEV_SMALL_BUF_MAX_SIZE) +
1045 	    SPDK_BDEV_POOL_ALIGNMENT) {
1046 		pool = g_bdev_mgr.buf_small_pool;
1047 		stailq = &mgmt_ch->need_buf_small;
1048 	} else {
1049 		pool = g_bdev_mgr.buf_large_pool;
1050 		stailq = &mgmt_ch->need_buf_large;
1051 	}
1052 
1053 	buf = spdk_mempool_get(pool);
1054 	if (!buf) {
1055 		STAILQ_INSERT_TAIL(stailq, bdev_io, internal.buf_link);
1056 	} else {
1057 		_bdev_io_set_buf(bdev_io, buf, len);
1058 	}
1059 }
1060 
1061 void
1062 spdk_bdev_io_get_buf(struct spdk_bdev_io *bdev_io, spdk_bdev_io_get_buf_cb cb, uint64_t len)
1063 {
1064 	struct spdk_bdev *bdev = bdev_io->bdev;
1065 	uint64_t alignment;
1066 
1067 	assert(cb != NULL);
1068 	bdev_io->internal.get_buf_cb = cb;
1069 
1070 	alignment = spdk_bdev_get_buf_align(bdev);
1071 
1072 	if (_is_buf_allocated(bdev_io->u.bdev.iovs) &&
1073 	    _are_iovs_aligned(bdev_io->u.bdev.iovs, bdev_io->u.bdev.iovcnt, alignment)) {
1074 		/* Buffer already present and aligned */
1075 		cb(spdk_bdev_io_get_io_channel(bdev_io), bdev_io, true);
1076 		return;
1077 	}
1078 
1079 	bdev_io_get_buf(bdev_io, len);
1080 }
1081 
1082 void
1083 spdk_bdev_io_get_aux_buf(struct spdk_bdev_io *bdev_io, spdk_bdev_io_get_aux_buf_cb cb)
1084 {
1085 	uint64_t len = bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen;
1086 
1087 	assert(cb != NULL);
1088 	assert(bdev_io->internal.get_aux_buf_cb == NULL);
1089 	bdev_io->internal.get_aux_buf_cb = cb;
1090 	bdev_io_get_buf(bdev_io, len);
1091 }
1092 
1093 static int
1094 bdev_module_get_max_ctx_size(void)
1095 {
1096 	struct spdk_bdev_module *bdev_module;
1097 	int max_bdev_module_size = 0;
1098 
1099 	TAILQ_FOREACH(bdev_module, &g_bdev_mgr.bdev_modules, internal.tailq) {
1100 		if (bdev_module->get_ctx_size && bdev_module->get_ctx_size() > max_bdev_module_size) {
1101 			max_bdev_module_size = bdev_module->get_ctx_size();
1102 		}
1103 	}
1104 
1105 	return max_bdev_module_size;
1106 }
1107 
1108 static void
1109 bdev_qos_config_json(struct spdk_bdev *bdev, struct spdk_json_write_ctx *w)
1110 {
1111 	int i;
1112 	struct spdk_bdev_qos *qos = bdev->internal.qos;
1113 	uint64_t limits[SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES];
1114 
1115 	if (!qos) {
1116 		return;
1117 	}
1118 
1119 	spdk_bdev_get_qos_rate_limits(bdev, limits);
1120 
1121 	spdk_json_write_object_begin(w);
1122 	spdk_json_write_named_string(w, "method", "bdev_set_qos_limit");
1123 
1124 	spdk_json_write_named_object_begin(w, "params");
1125 	spdk_json_write_named_string(w, "name", bdev->name);
1126 	for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) {
1127 		if (limits[i] > 0) {
1128 			spdk_json_write_named_uint64(w, qos_rpc_type[i], limits[i]);
1129 		}
1130 	}
1131 	spdk_json_write_object_end(w);
1132 
1133 	spdk_json_write_object_end(w);
1134 }
1135 
1136 void
1137 spdk_bdev_subsystem_config_json(struct spdk_json_write_ctx *w)
1138 {
1139 	struct spdk_bdev_module *bdev_module;
1140 	struct spdk_bdev *bdev;
1141 
1142 	assert(w != NULL);
1143 
1144 	spdk_json_write_array_begin(w);
1145 
1146 	spdk_json_write_object_begin(w);
1147 	spdk_json_write_named_string(w, "method", "bdev_set_options");
1148 	spdk_json_write_named_object_begin(w, "params");
1149 	spdk_json_write_named_uint32(w, "bdev_io_pool_size", g_bdev_opts.bdev_io_pool_size);
1150 	spdk_json_write_named_uint32(w, "bdev_io_cache_size", g_bdev_opts.bdev_io_cache_size);
1151 	spdk_json_write_named_bool(w, "bdev_auto_examine", g_bdev_opts.bdev_auto_examine);
1152 	spdk_json_write_object_end(w);
1153 	spdk_json_write_object_end(w);
1154 
1155 	bdev_examine_allowlist_config_json(w);
1156 
1157 	TAILQ_FOREACH(bdev_module, &g_bdev_mgr.bdev_modules, internal.tailq) {
1158 		if (bdev_module->config_json) {
1159 			bdev_module->config_json(w);
1160 		}
1161 	}
1162 
1163 	pthread_mutex_lock(&g_bdev_mgr.mutex);
1164 
1165 	TAILQ_FOREACH(bdev, &g_bdev_mgr.bdevs, internal.link) {
1166 		if (bdev->fn_table->write_config_json) {
1167 			bdev->fn_table->write_config_json(bdev, w);
1168 		}
1169 
1170 		bdev_qos_config_json(bdev, w);
1171 	}
1172 
1173 	pthread_mutex_unlock(&g_bdev_mgr.mutex);
1174 
1175 	/* This has to be last RPC in array to make sure all bdevs finished examine */
1176 	spdk_json_write_object_begin(w);
1177 	spdk_json_write_named_string(w, "method", "bdev_wait_for_examine");
1178 	spdk_json_write_object_end(w);
1179 
1180 	spdk_json_write_array_end(w);
1181 }
1182 
1183 static int
1184 bdev_mgmt_channel_create(void *io_device, void *ctx_buf)
1185 {
1186 	struct spdk_bdev_mgmt_channel *ch = ctx_buf;
1187 	struct spdk_bdev_io *bdev_io;
1188 	uint32_t i;
1189 
1190 	STAILQ_INIT(&ch->need_buf_small);
1191 	STAILQ_INIT(&ch->need_buf_large);
1192 
1193 	STAILQ_INIT(&ch->per_thread_cache);
1194 	ch->bdev_io_cache_size = g_bdev_opts.bdev_io_cache_size;
1195 
1196 	/* Pre-populate bdev_io cache to ensure this thread cannot be starved. */
1197 	ch->per_thread_cache_count = 0;
1198 	for (i = 0; i < ch->bdev_io_cache_size; i++) {
1199 		bdev_io = spdk_mempool_get(g_bdev_mgr.bdev_io_pool);
1200 		assert(bdev_io != NULL);
1201 		ch->per_thread_cache_count++;
1202 		STAILQ_INSERT_HEAD(&ch->per_thread_cache, bdev_io, internal.buf_link);
1203 	}
1204 
1205 	TAILQ_INIT(&ch->shared_resources);
1206 	TAILQ_INIT(&ch->io_wait_queue);
1207 
1208 	return 0;
1209 }
1210 
1211 static void
1212 bdev_mgmt_channel_destroy(void *io_device, void *ctx_buf)
1213 {
1214 	struct spdk_bdev_mgmt_channel *ch = ctx_buf;
1215 	struct spdk_bdev_io *bdev_io;
1216 
1217 	if (!STAILQ_EMPTY(&ch->need_buf_small) || !STAILQ_EMPTY(&ch->need_buf_large)) {
1218 		SPDK_ERRLOG("Pending I/O list wasn't empty on mgmt channel free\n");
1219 	}
1220 
1221 	if (!TAILQ_EMPTY(&ch->shared_resources)) {
1222 		SPDK_ERRLOG("Module channel list wasn't empty on mgmt channel free\n");
1223 	}
1224 
1225 	while (!STAILQ_EMPTY(&ch->per_thread_cache)) {
1226 		bdev_io = STAILQ_FIRST(&ch->per_thread_cache);
1227 		STAILQ_REMOVE_HEAD(&ch->per_thread_cache, internal.buf_link);
1228 		ch->per_thread_cache_count--;
1229 		spdk_mempool_put(g_bdev_mgr.bdev_io_pool, (void *)bdev_io);
1230 	}
1231 
1232 	assert(ch->per_thread_cache_count == 0);
1233 }
1234 
1235 static void
1236 bdev_init_complete(int rc)
1237 {
1238 	spdk_bdev_init_cb cb_fn = g_init_cb_fn;
1239 	void *cb_arg = g_init_cb_arg;
1240 	struct spdk_bdev_module *m;
1241 
1242 	g_bdev_mgr.init_complete = true;
1243 	g_init_cb_fn = NULL;
1244 	g_init_cb_arg = NULL;
1245 
1246 	/*
1247 	 * For modules that need to know when subsystem init is complete,
1248 	 * inform them now.
1249 	 */
1250 	if (rc == 0) {
1251 		TAILQ_FOREACH(m, &g_bdev_mgr.bdev_modules, internal.tailq) {
1252 			if (m->init_complete) {
1253 				m->init_complete();
1254 			}
1255 		}
1256 	}
1257 
1258 	cb_fn(cb_arg, rc);
1259 }
1260 
1261 static bool
1262 bdev_module_all_actions_completed(void)
1263 {
1264 	struct spdk_bdev_module *m;
1265 
1266 	TAILQ_FOREACH(m, &g_bdev_mgr.bdev_modules, internal.tailq) {
1267 		if (m->internal.action_in_progress > 0) {
1268 			return false;
1269 		}
1270 	}
1271 	return true;
1272 }
1273 
1274 static void
1275 bdev_module_action_complete(void)
1276 {
1277 	/*
1278 	 * Don't finish bdev subsystem initialization if
1279 	 * module pre-initialization is still in progress, or
1280 	 * the subsystem been already initialized.
1281 	 */
1282 	if (!g_bdev_mgr.module_init_complete || g_bdev_mgr.init_complete) {
1283 		return;
1284 	}
1285 
1286 	/*
1287 	 * Check all bdev modules for inits/examinations in progress. If any
1288 	 * exist, return immediately since we cannot finish bdev subsystem
1289 	 * initialization until all are completed.
1290 	 */
1291 	if (!bdev_module_all_actions_completed()) {
1292 		return;
1293 	}
1294 
1295 	/*
1296 	 * Modules already finished initialization - now that all
1297 	 * the bdev modules have finished their asynchronous I/O
1298 	 * processing, the entire bdev layer can be marked as complete.
1299 	 */
1300 	bdev_init_complete(0);
1301 }
1302 
1303 static void
1304 bdev_module_action_done(struct spdk_bdev_module *module)
1305 {
1306 	assert(module->internal.action_in_progress > 0);
1307 	module->internal.action_in_progress--;
1308 	bdev_module_action_complete();
1309 }
1310 
1311 void
1312 spdk_bdev_module_init_done(struct spdk_bdev_module *module)
1313 {
1314 	bdev_module_action_done(module);
1315 }
1316 
1317 void
1318 spdk_bdev_module_examine_done(struct spdk_bdev_module *module)
1319 {
1320 	bdev_module_action_done(module);
1321 }
1322 
1323 /** The last initialized bdev module */
1324 static struct spdk_bdev_module *g_resume_bdev_module = NULL;
1325 
1326 static void
1327 bdev_init_failed(void *cb_arg)
1328 {
1329 	struct spdk_bdev_module *module = cb_arg;
1330 
1331 	module->internal.action_in_progress--;
1332 	bdev_init_complete(-1);
1333 }
1334 
1335 static int
1336 bdev_modules_init(void)
1337 {
1338 	struct spdk_bdev_module *module;
1339 	int rc = 0;
1340 
1341 	TAILQ_FOREACH(module, &g_bdev_mgr.bdev_modules, internal.tailq) {
1342 		g_resume_bdev_module = module;
1343 		if (module->async_init) {
1344 			module->internal.action_in_progress = 1;
1345 		}
1346 		rc = module->module_init();
1347 		if (rc != 0) {
1348 			/* Bump action_in_progress to prevent other modules from completion of modules_init
1349 			 * Send message to defer application shutdown until resources are cleaned up */
1350 			module->internal.action_in_progress = 1;
1351 			spdk_thread_send_msg(spdk_get_thread(), bdev_init_failed, module);
1352 			return rc;
1353 		}
1354 	}
1355 
1356 	g_resume_bdev_module = NULL;
1357 	return 0;
1358 }
1359 
1360 void
1361 spdk_bdev_initialize(spdk_bdev_init_cb cb_fn, void *cb_arg)
1362 {
1363 	int cache_size;
1364 	int rc = 0;
1365 	char mempool_name[32];
1366 
1367 	assert(cb_fn != NULL);
1368 
1369 	g_init_cb_fn = cb_fn;
1370 	g_init_cb_arg = cb_arg;
1371 
1372 	spdk_notify_type_register("bdev_register");
1373 	spdk_notify_type_register("bdev_unregister");
1374 
1375 	snprintf(mempool_name, sizeof(mempool_name), "bdev_io_%d", getpid());
1376 
1377 	g_bdev_mgr.bdev_io_pool = spdk_mempool_create(mempool_name,
1378 				  g_bdev_opts.bdev_io_pool_size,
1379 				  sizeof(struct spdk_bdev_io) +
1380 				  bdev_module_get_max_ctx_size(),
1381 				  0,
1382 				  SPDK_ENV_SOCKET_ID_ANY);
1383 
1384 	if (g_bdev_mgr.bdev_io_pool == NULL) {
1385 		SPDK_ERRLOG("could not allocate spdk_bdev_io pool\n");
1386 		bdev_init_complete(-1);
1387 		return;
1388 	}
1389 
1390 	/**
1391 	 * Ensure no more than half of the total buffers end up local caches, by
1392 	 *   using spdk_env_get_core_count() to determine how many local caches we need
1393 	 *   to account for.
1394 	 */
1395 	cache_size = BUF_SMALL_POOL_SIZE / (2 * spdk_env_get_core_count());
1396 	snprintf(mempool_name, sizeof(mempool_name), "buf_small_pool_%d", getpid());
1397 
1398 	g_bdev_mgr.buf_small_pool = spdk_mempool_create(mempool_name,
1399 				    g_bdev_opts.small_buf_pool_size,
1400 				    SPDK_BDEV_BUF_SIZE_WITH_MD(SPDK_BDEV_SMALL_BUF_MAX_SIZE) +
1401 				    SPDK_BDEV_POOL_ALIGNMENT,
1402 				    cache_size,
1403 				    SPDK_ENV_SOCKET_ID_ANY);
1404 	if (!g_bdev_mgr.buf_small_pool) {
1405 		SPDK_ERRLOG("create rbuf small pool failed\n");
1406 		bdev_init_complete(-1);
1407 		return;
1408 	}
1409 
1410 	cache_size = BUF_LARGE_POOL_SIZE / (2 * spdk_env_get_core_count());
1411 	snprintf(mempool_name, sizeof(mempool_name), "buf_large_pool_%d", getpid());
1412 
1413 	g_bdev_mgr.buf_large_pool = spdk_mempool_create(mempool_name,
1414 				    g_bdev_opts.large_buf_pool_size,
1415 				    SPDK_BDEV_BUF_SIZE_WITH_MD(SPDK_BDEV_LARGE_BUF_MAX_SIZE) +
1416 				    SPDK_BDEV_POOL_ALIGNMENT,
1417 				    cache_size,
1418 				    SPDK_ENV_SOCKET_ID_ANY);
1419 	if (!g_bdev_mgr.buf_large_pool) {
1420 		SPDK_ERRLOG("create rbuf large pool failed\n");
1421 		bdev_init_complete(-1);
1422 		return;
1423 	}
1424 
1425 	g_bdev_mgr.zero_buffer = spdk_zmalloc(ZERO_BUFFER_SIZE, ZERO_BUFFER_SIZE,
1426 					      NULL, SPDK_ENV_LCORE_ID_ANY, SPDK_MALLOC_DMA);
1427 	if (!g_bdev_mgr.zero_buffer) {
1428 		SPDK_ERRLOG("create bdev zero buffer failed\n");
1429 		bdev_init_complete(-1);
1430 		return;
1431 	}
1432 
1433 #ifdef SPDK_CONFIG_VTUNE
1434 	g_bdev_mgr.domain = __itt_domain_create("spdk_bdev");
1435 #endif
1436 
1437 	spdk_io_device_register(&g_bdev_mgr, bdev_mgmt_channel_create,
1438 				bdev_mgmt_channel_destroy,
1439 				sizeof(struct spdk_bdev_mgmt_channel),
1440 				"bdev_mgr");
1441 
1442 	rc = bdev_modules_init();
1443 	g_bdev_mgr.module_init_complete = true;
1444 	if (rc != 0) {
1445 		SPDK_ERRLOG("bdev modules init failed\n");
1446 		return;
1447 	}
1448 
1449 	bdev_module_action_complete();
1450 }
1451 
1452 static void
1453 bdev_mgr_unregister_cb(void *io_device)
1454 {
1455 	spdk_bdev_fini_cb cb_fn = g_fini_cb_fn;
1456 
1457 	if (g_bdev_mgr.bdev_io_pool) {
1458 		if (spdk_mempool_count(g_bdev_mgr.bdev_io_pool) != g_bdev_opts.bdev_io_pool_size) {
1459 			SPDK_ERRLOG("bdev IO pool count is %zu but should be %u\n",
1460 				    spdk_mempool_count(g_bdev_mgr.bdev_io_pool),
1461 				    g_bdev_opts.bdev_io_pool_size);
1462 		}
1463 
1464 		spdk_mempool_free(g_bdev_mgr.bdev_io_pool);
1465 	}
1466 
1467 	if (g_bdev_mgr.buf_small_pool) {
1468 		if (spdk_mempool_count(g_bdev_mgr.buf_small_pool) != g_bdev_opts.small_buf_pool_size) {
1469 			SPDK_ERRLOG("Small buffer pool count is %zu but should be %u\n",
1470 				    spdk_mempool_count(g_bdev_mgr.buf_small_pool),
1471 				    g_bdev_opts.small_buf_pool_size);
1472 			assert(false);
1473 		}
1474 
1475 		spdk_mempool_free(g_bdev_mgr.buf_small_pool);
1476 	}
1477 
1478 	if (g_bdev_mgr.buf_large_pool) {
1479 		if (spdk_mempool_count(g_bdev_mgr.buf_large_pool) != g_bdev_opts.large_buf_pool_size) {
1480 			SPDK_ERRLOG("Large buffer pool count is %zu but should be %u\n",
1481 				    spdk_mempool_count(g_bdev_mgr.buf_large_pool),
1482 				    g_bdev_opts.large_buf_pool_size);
1483 			assert(false);
1484 		}
1485 
1486 		spdk_mempool_free(g_bdev_mgr.buf_large_pool);
1487 	}
1488 
1489 	spdk_free(g_bdev_mgr.zero_buffer);
1490 
1491 	bdev_examine_allowlist_free();
1492 
1493 	cb_fn(g_fini_cb_arg);
1494 	g_fini_cb_fn = NULL;
1495 	g_fini_cb_arg = NULL;
1496 	g_bdev_mgr.init_complete = false;
1497 	g_bdev_mgr.module_init_complete = false;
1498 }
1499 
1500 static void
1501 bdev_module_finish_iter(void *arg)
1502 {
1503 	struct spdk_bdev_module *bdev_module;
1504 
1505 	/* FIXME: Handling initialization failures is broken now,
1506 	 * so we won't even try cleaning up after successfully
1507 	 * initialized modules. if module_init_complete is false,
1508 	 * just call spdk_bdev_mgr_unregister_cb
1509 	 */
1510 	if (!g_bdev_mgr.module_init_complete) {
1511 		bdev_mgr_unregister_cb(NULL);
1512 		return;
1513 	}
1514 
1515 	/* Start iterating from the last touched module */
1516 	if (!g_resume_bdev_module) {
1517 		bdev_module = TAILQ_LAST(&g_bdev_mgr.bdev_modules, bdev_module_list);
1518 	} else {
1519 		bdev_module = TAILQ_PREV(g_resume_bdev_module, bdev_module_list,
1520 					 internal.tailq);
1521 	}
1522 
1523 	while (bdev_module) {
1524 		if (bdev_module->async_fini) {
1525 			/* Save our place so we can resume later. We must
1526 			 * save the variable here, before calling module_fini()
1527 			 * below, because in some cases the module may immediately
1528 			 * call spdk_bdev_module_finish_done() and re-enter
1529 			 * this function to continue iterating. */
1530 			g_resume_bdev_module = bdev_module;
1531 		}
1532 
1533 		if (bdev_module->module_fini) {
1534 			bdev_module->module_fini();
1535 		}
1536 
1537 		if (bdev_module->async_fini) {
1538 			return;
1539 		}
1540 
1541 		bdev_module = TAILQ_PREV(bdev_module, bdev_module_list,
1542 					 internal.tailq);
1543 	}
1544 
1545 	g_resume_bdev_module = NULL;
1546 	spdk_io_device_unregister(&g_bdev_mgr, bdev_mgr_unregister_cb);
1547 }
1548 
1549 void
1550 spdk_bdev_module_finish_done(void)
1551 {
1552 	if (spdk_get_thread() != g_fini_thread) {
1553 		spdk_thread_send_msg(g_fini_thread, bdev_module_finish_iter, NULL);
1554 	} else {
1555 		bdev_module_finish_iter(NULL);
1556 	}
1557 }
1558 
1559 static void
1560 bdev_finish_unregister_bdevs_iter(void *cb_arg, int bdeverrno)
1561 {
1562 	struct spdk_bdev *bdev = cb_arg;
1563 
1564 	if (bdeverrno && bdev) {
1565 		SPDK_WARNLOG("Unable to unregister bdev '%s' during spdk_bdev_finish()\n",
1566 			     bdev->name);
1567 
1568 		/*
1569 		 * Since the call to spdk_bdev_unregister() failed, we have no way to free this
1570 		 *  bdev; try to continue by manually removing this bdev from the list and continue
1571 		 *  with the next bdev in the list.
1572 		 */
1573 		TAILQ_REMOVE(&g_bdev_mgr.bdevs, bdev, internal.link);
1574 	}
1575 
1576 	if (TAILQ_EMPTY(&g_bdev_mgr.bdevs)) {
1577 		SPDK_DEBUGLOG(bdev, "Done unregistering bdevs\n");
1578 		/*
1579 		 * Bdev module finish need to be deferred as we might be in the middle of some context
1580 		 * (like bdev part free) that will use this bdev (or private bdev driver ctx data)
1581 		 * after returning.
1582 		 */
1583 		spdk_thread_send_msg(spdk_get_thread(), bdev_module_finish_iter, NULL);
1584 		return;
1585 	}
1586 
1587 	/*
1588 	 * Unregister last unclaimed bdev in the list, to ensure that bdev subsystem
1589 	 * shutdown proceeds top-down. The goal is to give virtual bdevs an opportunity
1590 	 * to detect clean shutdown as opposed to run-time hot removal of the underlying
1591 	 * base bdevs.
1592 	 *
1593 	 * Also, walk the list in the reverse order.
1594 	 */
1595 	for (bdev = TAILQ_LAST(&g_bdev_mgr.bdevs, spdk_bdev_list);
1596 	     bdev; bdev = TAILQ_PREV(bdev, spdk_bdev_list, internal.link)) {
1597 		if (bdev->internal.claim_module != NULL) {
1598 			SPDK_DEBUGLOG(bdev, "Skipping claimed bdev '%s'(<-'%s').\n",
1599 				      bdev->name, bdev->internal.claim_module->name);
1600 			continue;
1601 		}
1602 
1603 		SPDK_DEBUGLOG(bdev, "Unregistering bdev '%s'\n", bdev->name);
1604 		spdk_bdev_unregister(bdev, bdev_finish_unregister_bdevs_iter, bdev);
1605 		return;
1606 	}
1607 
1608 	/*
1609 	 * If any bdev fails to unclaim underlying bdev properly, we may face the
1610 	 * case of bdev list consisting of claimed bdevs only (if claims are managed
1611 	 * correctly, this would mean there's a loop in the claims graph which is
1612 	 * clearly impossible). Warn and unregister last bdev on the list then.
1613 	 */
1614 	for (bdev = TAILQ_LAST(&g_bdev_mgr.bdevs, spdk_bdev_list);
1615 	     bdev; bdev = TAILQ_PREV(bdev, spdk_bdev_list, internal.link)) {
1616 		SPDK_WARNLOG("Unregistering claimed bdev '%s'!\n", bdev->name);
1617 		spdk_bdev_unregister(bdev, bdev_finish_unregister_bdevs_iter, bdev);
1618 		return;
1619 	}
1620 }
1621 
1622 void
1623 spdk_bdev_finish(spdk_bdev_fini_cb cb_fn, void *cb_arg)
1624 {
1625 	struct spdk_bdev_module *m;
1626 
1627 	assert(cb_fn != NULL);
1628 
1629 	g_fini_thread = spdk_get_thread();
1630 
1631 	g_fini_cb_fn = cb_fn;
1632 	g_fini_cb_arg = cb_arg;
1633 
1634 	TAILQ_FOREACH(m, &g_bdev_mgr.bdev_modules, internal.tailq) {
1635 		if (m->fini_start) {
1636 			m->fini_start();
1637 		}
1638 	}
1639 
1640 	bdev_finish_unregister_bdevs_iter(NULL, 0);
1641 }
1642 
1643 struct spdk_bdev_io *
1644 bdev_channel_get_io(struct spdk_bdev_channel *channel)
1645 {
1646 	struct spdk_bdev_mgmt_channel *ch = channel->shared_resource->mgmt_ch;
1647 	struct spdk_bdev_io *bdev_io;
1648 
1649 	if (ch->per_thread_cache_count > 0) {
1650 		bdev_io = STAILQ_FIRST(&ch->per_thread_cache);
1651 		STAILQ_REMOVE_HEAD(&ch->per_thread_cache, internal.buf_link);
1652 		ch->per_thread_cache_count--;
1653 	} else if (spdk_unlikely(!TAILQ_EMPTY(&ch->io_wait_queue))) {
1654 		/*
1655 		 * Don't try to look for bdev_ios in the global pool if there are
1656 		 * waiters on bdev_ios - we don't want this caller to jump the line.
1657 		 */
1658 		bdev_io = NULL;
1659 	} else {
1660 		bdev_io = spdk_mempool_get(g_bdev_mgr.bdev_io_pool);
1661 	}
1662 
1663 	return bdev_io;
1664 }
1665 
1666 void
1667 spdk_bdev_free_io(struct spdk_bdev_io *bdev_io)
1668 {
1669 	struct spdk_bdev_mgmt_channel *ch;
1670 
1671 	assert(bdev_io != NULL);
1672 	assert(bdev_io->internal.status != SPDK_BDEV_IO_STATUS_PENDING);
1673 
1674 	ch = bdev_io->internal.ch->shared_resource->mgmt_ch;
1675 
1676 	if (bdev_io->internal.buf != NULL) {
1677 		bdev_io_put_buf(bdev_io);
1678 	}
1679 
1680 	if (ch->per_thread_cache_count < ch->bdev_io_cache_size) {
1681 		ch->per_thread_cache_count++;
1682 		STAILQ_INSERT_HEAD(&ch->per_thread_cache, bdev_io, internal.buf_link);
1683 		while (ch->per_thread_cache_count > 0 && !TAILQ_EMPTY(&ch->io_wait_queue)) {
1684 			struct spdk_bdev_io_wait_entry *entry;
1685 
1686 			entry = TAILQ_FIRST(&ch->io_wait_queue);
1687 			TAILQ_REMOVE(&ch->io_wait_queue, entry, link);
1688 			entry->cb_fn(entry->cb_arg);
1689 		}
1690 	} else {
1691 		/* We should never have a full cache with entries on the io wait queue. */
1692 		assert(TAILQ_EMPTY(&ch->io_wait_queue));
1693 		spdk_mempool_put(g_bdev_mgr.bdev_io_pool, (void *)bdev_io);
1694 	}
1695 }
1696 
1697 static bool
1698 bdev_qos_is_iops_rate_limit(enum spdk_bdev_qos_rate_limit_type limit)
1699 {
1700 	assert(limit != SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES);
1701 
1702 	switch (limit) {
1703 	case SPDK_BDEV_QOS_RW_IOPS_RATE_LIMIT:
1704 		return true;
1705 	case SPDK_BDEV_QOS_RW_BPS_RATE_LIMIT:
1706 	case SPDK_BDEV_QOS_R_BPS_RATE_LIMIT:
1707 	case SPDK_BDEV_QOS_W_BPS_RATE_LIMIT:
1708 		return false;
1709 	case SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES:
1710 	default:
1711 		return false;
1712 	}
1713 }
1714 
1715 static bool
1716 bdev_qos_io_to_limit(struct spdk_bdev_io *bdev_io)
1717 {
1718 	switch (bdev_io->type) {
1719 	case SPDK_BDEV_IO_TYPE_NVME_IO:
1720 	case SPDK_BDEV_IO_TYPE_NVME_IO_MD:
1721 	case SPDK_BDEV_IO_TYPE_READ:
1722 	case SPDK_BDEV_IO_TYPE_WRITE:
1723 		return true;
1724 	case SPDK_BDEV_IO_TYPE_ZCOPY:
1725 		if (bdev_io->u.bdev.zcopy.start) {
1726 			return true;
1727 		} else {
1728 			return false;
1729 		}
1730 	default:
1731 		return false;
1732 	}
1733 }
1734 
1735 static bool
1736 bdev_is_read_io(struct spdk_bdev_io *bdev_io)
1737 {
1738 	switch (bdev_io->type) {
1739 	case SPDK_BDEV_IO_TYPE_NVME_IO:
1740 	case SPDK_BDEV_IO_TYPE_NVME_IO_MD:
1741 		/* Bit 1 (0x2) set for read operation */
1742 		if (bdev_io->u.nvme_passthru.cmd.opc & SPDK_NVME_OPC_READ) {
1743 			return true;
1744 		} else {
1745 			return false;
1746 		}
1747 	case SPDK_BDEV_IO_TYPE_READ:
1748 		return true;
1749 	case SPDK_BDEV_IO_TYPE_ZCOPY:
1750 		/* Populate to read from disk */
1751 		if (bdev_io->u.bdev.zcopy.populate) {
1752 			return true;
1753 		} else {
1754 			return false;
1755 		}
1756 	default:
1757 		return false;
1758 	}
1759 }
1760 
1761 static uint64_t
1762 bdev_get_io_size_in_byte(struct spdk_bdev_io *bdev_io)
1763 {
1764 	struct spdk_bdev	*bdev = bdev_io->bdev;
1765 
1766 	switch (bdev_io->type) {
1767 	case SPDK_BDEV_IO_TYPE_NVME_IO:
1768 	case SPDK_BDEV_IO_TYPE_NVME_IO_MD:
1769 		return bdev_io->u.nvme_passthru.nbytes;
1770 	case SPDK_BDEV_IO_TYPE_READ:
1771 	case SPDK_BDEV_IO_TYPE_WRITE:
1772 		return bdev_io->u.bdev.num_blocks * bdev->blocklen;
1773 	case SPDK_BDEV_IO_TYPE_ZCOPY:
1774 		/* Track the data in the start phase only */
1775 		if (bdev_io->u.bdev.zcopy.start) {
1776 			return bdev_io->u.bdev.num_blocks * bdev->blocklen;
1777 		} else {
1778 			return 0;
1779 		}
1780 	default:
1781 		return 0;
1782 	}
1783 }
1784 
1785 static bool
1786 bdev_qos_rw_queue_io(const struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io)
1787 {
1788 	if (limit->max_per_timeslice > 0 && limit->remaining_this_timeslice <= 0) {
1789 		return true;
1790 	} else {
1791 		return false;
1792 	}
1793 }
1794 
1795 static bool
1796 bdev_qos_r_queue_io(const struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io)
1797 {
1798 	if (bdev_is_read_io(io) == false) {
1799 		return false;
1800 	}
1801 
1802 	return bdev_qos_rw_queue_io(limit, io);
1803 }
1804 
1805 static bool
1806 bdev_qos_w_queue_io(const struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io)
1807 {
1808 	if (bdev_is_read_io(io) == true) {
1809 		return false;
1810 	}
1811 
1812 	return bdev_qos_rw_queue_io(limit, io);
1813 }
1814 
1815 static void
1816 bdev_qos_rw_iops_update_quota(struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io)
1817 {
1818 	limit->remaining_this_timeslice--;
1819 }
1820 
1821 static void
1822 bdev_qos_rw_bps_update_quota(struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io)
1823 {
1824 	limit->remaining_this_timeslice -= bdev_get_io_size_in_byte(io);
1825 }
1826 
1827 static void
1828 bdev_qos_r_bps_update_quota(struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io)
1829 {
1830 	if (bdev_is_read_io(io) == false) {
1831 		return;
1832 	}
1833 
1834 	return bdev_qos_rw_bps_update_quota(limit, io);
1835 }
1836 
1837 static void
1838 bdev_qos_w_bps_update_quota(struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io)
1839 {
1840 	if (bdev_is_read_io(io) == true) {
1841 		return;
1842 	}
1843 
1844 	return bdev_qos_rw_bps_update_quota(limit, io);
1845 }
1846 
1847 static void
1848 bdev_qos_set_ops(struct spdk_bdev_qos *qos)
1849 {
1850 	int i;
1851 
1852 	for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) {
1853 		if (qos->rate_limits[i].limit == SPDK_BDEV_QOS_LIMIT_NOT_DEFINED) {
1854 			qos->rate_limits[i].queue_io = NULL;
1855 			qos->rate_limits[i].update_quota = NULL;
1856 			continue;
1857 		}
1858 
1859 		switch (i) {
1860 		case SPDK_BDEV_QOS_RW_IOPS_RATE_LIMIT:
1861 			qos->rate_limits[i].queue_io = bdev_qos_rw_queue_io;
1862 			qos->rate_limits[i].update_quota = bdev_qos_rw_iops_update_quota;
1863 			break;
1864 		case SPDK_BDEV_QOS_RW_BPS_RATE_LIMIT:
1865 			qos->rate_limits[i].queue_io = bdev_qos_rw_queue_io;
1866 			qos->rate_limits[i].update_quota = bdev_qos_rw_bps_update_quota;
1867 			break;
1868 		case SPDK_BDEV_QOS_R_BPS_RATE_LIMIT:
1869 			qos->rate_limits[i].queue_io = bdev_qos_r_queue_io;
1870 			qos->rate_limits[i].update_quota = bdev_qos_r_bps_update_quota;
1871 			break;
1872 		case SPDK_BDEV_QOS_W_BPS_RATE_LIMIT:
1873 			qos->rate_limits[i].queue_io = bdev_qos_w_queue_io;
1874 			qos->rate_limits[i].update_quota = bdev_qos_w_bps_update_quota;
1875 			break;
1876 		default:
1877 			break;
1878 		}
1879 	}
1880 }
1881 
1882 static void
1883 _bdev_io_complete_in_submit(struct spdk_bdev_channel *bdev_ch,
1884 			    struct spdk_bdev_io *bdev_io,
1885 			    enum spdk_bdev_io_status status)
1886 {
1887 	struct spdk_bdev_shared_resource *shared_resource = bdev_ch->shared_resource;
1888 
1889 	bdev_io->internal.in_submit_request = true;
1890 	bdev_ch->io_outstanding++;
1891 	shared_resource->io_outstanding++;
1892 	spdk_bdev_io_complete(bdev_io, status);
1893 	bdev_io->internal.in_submit_request = false;
1894 }
1895 
1896 static inline void
1897 bdev_io_do_submit(struct spdk_bdev_channel *bdev_ch, struct spdk_bdev_io *bdev_io)
1898 {
1899 	struct spdk_bdev *bdev = bdev_io->bdev;
1900 	struct spdk_io_channel *ch = bdev_ch->channel;
1901 	struct spdk_bdev_shared_resource *shared_resource = bdev_ch->shared_resource;
1902 
1903 	if (spdk_unlikely(bdev_io->type == SPDK_BDEV_IO_TYPE_ABORT)) {
1904 		struct spdk_bdev_mgmt_channel *mgmt_channel = shared_resource->mgmt_ch;
1905 		struct spdk_bdev_io *bio_to_abort = bdev_io->u.abort.bio_to_abort;
1906 
1907 		if (bdev_abort_queued_io(&shared_resource->nomem_io, bio_to_abort) ||
1908 		    bdev_abort_buf_io(&mgmt_channel->need_buf_small, bio_to_abort) ||
1909 		    bdev_abort_buf_io(&mgmt_channel->need_buf_large, bio_to_abort)) {
1910 			_bdev_io_complete_in_submit(bdev_ch, bdev_io,
1911 						    SPDK_BDEV_IO_STATUS_SUCCESS);
1912 			return;
1913 		}
1914 	}
1915 
1916 	if (spdk_likely(TAILQ_EMPTY(&shared_resource->nomem_io))) {
1917 		bdev_ch->io_outstanding++;
1918 		shared_resource->io_outstanding++;
1919 		bdev_io->internal.in_submit_request = true;
1920 		bdev->fn_table->submit_request(ch, bdev_io);
1921 		bdev_io->internal.in_submit_request = false;
1922 	} else {
1923 		TAILQ_INSERT_TAIL(&shared_resource->nomem_io, bdev_io, internal.link);
1924 	}
1925 }
1926 
1927 static int
1928 bdev_qos_io_submit(struct spdk_bdev_channel *ch, struct spdk_bdev_qos *qos)
1929 {
1930 	struct spdk_bdev_io		*bdev_io = NULL, *tmp = NULL;
1931 	int				i, submitted_ios = 0;
1932 
1933 	TAILQ_FOREACH_SAFE(bdev_io, &qos->queued, internal.link, tmp) {
1934 		if (bdev_qos_io_to_limit(bdev_io) == true) {
1935 			for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) {
1936 				if (!qos->rate_limits[i].queue_io) {
1937 					continue;
1938 				}
1939 
1940 				if (qos->rate_limits[i].queue_io(&qos->rate_limits[i],
1941 								 bdev_io) == true) {
1942 					return submitted_ios;
1943 				}
1944 			}
1945 			for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) {
1946 				if (!qos->rate_limits[i].update_quota) {
1947 					continue;
1948 				}
1949 
1950 				qos->rate_limits[i].update_quota(&qos->rate_limits[i], bdev_io);
1951 			}
1952 		}
1953 
1954 		TAILQ_REMOVE(&qos->queued, bdev_io, internal.link);
1955 		bdev_io_do_submit(ch, bdev_io);
1956 		submitted_ios++;
1957 	}
1958 
1959 	return submitted_ios;
1960 }
1961 
1962 static void
1963 bdev_queue_io_wait_with_cb(struct spdk_bdev_io *bdev_io, spdk_bdev_io_wait_cb cb_fn)
1964 {
1965 	int rc;
1966 
1967 	bdev_io->internal.waitq_entry.bdev = bdev_io->bdev;
1968 	bdev_io->internal.waitq_entry.cb_fn = cb_fn;
1969 	bdev_io->internal.waitq_entry.cb_arg = bdev_io;
1970 	rc = spdk_bdev_queue_io_wait(bdev_io->bdev, spdk_io_channel_from_ctx(bdev_io->internal.ch),
1971 				     &bdev_io->internal.waitq_entry);
1972 	if (rc != 0) {
1973 		SPDK_ERRLOG("Queue IO failed, rc=%d\n", rc);
1974 		bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED;
1975 		bdev_io->internal.cb(bdev_io, false, bdev_io->internal.caller_ctx);
1976 	}
1977 }
1978 
1979 static bool
1980 bdev_rw_should_split(struct spdk_bdev_io *bdev_io)
1981 {
1982 	uint32_t io_boundary = bdev_io->bdev->optimal_io_boundary;
1983 	uint32_t max_size = bdev_io->bdev->max_segment_size;
1984 	int max_segs = bdev_io->bdev->max_num_segments;
1985 
1986 	io_boundary = bdev_io->bdev->split_on_optimal_io_boundary ? io_boundary : 0;
1987 
1988 	if (spdk_likely(!io_boundary && !max_segs && !max_size)) {
1989 		return false;
1990 	}
1991 
1992 	if (io_boundary) {
1993 		uint64_t start_stripe, end_stripe;
1994 
1995 		start_stripe = bdev_io->u.bdev.offset_blocks;
1996 		end_stripe = start_stripe + bdev_io->u.bdev.num_blocks - 1;
1997 		/* Avoid expensive div operations if possible.  These spdk_u32 functions are very cheap. */
1998 		if (spdk_likely(spdk_u32_is_pow2(io_boundary))) {
1999 			start_stripe >>= spdk_u32log2(io_boundary);
2000 			end_stripe >>= spdk_u32log2(io_boundary);
2001 		} else {
2002 			start_stripe /= io_boundary;
2003 			end_stripe /= io_boundary;
2004 		}
2005 
2006 		if (start_stripe != end_stripe) {
2007 			return true;
2008 		}
2009 	}
2010 
2011 	if (max_segs) {
2012 		if (bdev_io->u.bdev.iovcnt > max_segs) {
2013 			return true;
2014 		}
2015 	}
2016 
2017 	if (max_size) {
2018 		for (int i = 0; i < bdev_io->u.bdev.iovcnt; i++) {
2019 			if (bdev_io->u.bdev.iovs[i].iov_len > max_size) {
2020 				return true;
2021 			}
2022 		}
2023 	}
2024 
2025 	return false;
2026 }
2027 
2028 static bool
2029 bdev_unmap_should_split(struct spdk_bdev_io *bdev_io)
2030 {
2031 	uint32_t num_unmap_segments;
2032 
2033 	if (!bdev_io->bdev->max_unmap || !bdev_io->bdev->max_unmap_segments) {
2034 		return false;
2035 	}
2036 	num_unmap_segments = spdk_divide_round_up(bdev_io->u.bdev.num_blocks, bdev_io->bdev->max_unmap);
2037 	if (num_unmap_segments > bdev_io->bdev->max_unmap_segments) {
2038 		return true;
2039 	}
2040 
2041 	return false;
2042 }
2043 
2044 static bool
2045 bdev_write_zeroes_should_split(struct spdk_bdev_io *bdev_io)
2046 {
2047 	if (!bdev_io->bdev->max_write_zeroes) {
2048 		return false;
2049 	}
2050 
2051 	if (bdev_io->u.bdev.num_blocks > bdev_io->bdev->max_write_zeroes) {
2052 		return true;
2053 	}
2054 
2055 	return false;
2056 }
2057 
2058 static bool
2059 bdev_io_should_split(struct spdk_bdev_io *bdev_io)
2060 {
2061 	switch (bdev_io->type) {
2062 	case SPDK_BDEV_IO_TYPE_READ:
2063 	case SPDK_BDEV_IO_TYPE_WRITE:
2064 		return bdev_rw_should_split(bdev_io);
2065 	case SPDK_BDEV_IO_TYPE_UNMAP:
2066 		return bdev_unmap_should_split(bdev_io);
2067 	case SPDK_BDEV_IO_TYPE_WRITE_ZEROES:
2068 		return bdev_write_zeroes_should_split(bdev_io);
2069 	default:
2070 		return false;
2071 	}
2072 }
2073 
2074 static uint32_t
2075 _to_next_boundary(uint64_t offset, uint32_t boundary)
2076 {
2077 	return (boundary - (offset % boundary));
2078 }
2079 
2080 static void
2081 bdev_io_split_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg);
2082 
2083 static void
2084 _bdev_rw_split(void *_bdev_io);
2085 
2086 static void
2087 bdev_unmap_split(struct spdk_bdev_io *bdev_io);
2088 
2089 static void
2090 _bdev_unmap_split(void *_bdev_io)
2091 {
2092 	return bdev_unmap_split((struct spdk_bdev_io *)_bdev_io);
2093 }
2094 
2095 static void
2096 bdev_write_zeroes_split(struct spdk_bdev_io *bdev_io);
2097 
2098 static void
2099 _bdev_write_zeroes_split(void *_bdev_io)
2100 {
2101 	return bdev_write_zeroes_split((struct spdk_bdev_io *)_bdev_io);
2102 }
2103 
2104 static int
2105 bdev_io_split_submit(struct spdk_bdev_io *bdev_io, struct iovec *iov, int iovcnt, void *md_buf,
2106 		     uint64_t num_blocks, uint64_t *offset, uint64_t *remaining)
2107 {
2108 	int rc;
2109 	uint64_t current_offset, current_remaining;
2110 	spdk_bdev_io_wait_cb io_wait_fn;
2111 
2112 	current_offset = *offset;
2113 	current_remaining = *remaining;
2114 
2115 	bdev_io->u.bdev.split_outstanding++;
2116 
2117 	io_wait_fn = _bdev_rw_split;
2118 	switch (bdev_io->type) {
2119 	case SPDK_BDEV_IO_TYPE_READ:
2120 		rc = bdev_readv_blocks_with_md(bdev_io->internal.desc,
2121 					       spdk_io_channel_from_ctx(bdev_io->internal.ch),
2122 					       iov, iovcnt, md_buf, current_offset,
2123 					       num_blocks,
2124 					       bdev_io_split_done, bdev_io,
2125 					       bdev_io->internal.ext_opts);
2126 		break;
2127 	case SPDK_BDEV_IO_TYPE_WRITE:
2128 		rc = bdev_writev_blocks_with_md(bdev_io->internal.desc,
2129 						spdk_io_channel_from_ctx(bdev_io->internal.ch),
2130 						iov, iovcnt, md_buf, current_offset,
2131 						num_blocks,
2132 						bdev_io_split_done, bdev_io,
2133 						bdev_io->internal.ext_opts);
2134 		break;
2135 	case SPDK_BDEV_IO_TYPE_UNMAP:
2136 		io_wait_fn = _bdev_unmap_split;
2137 		rc = spdk_bdev_unmap_blocks(bdev_io->internal.desc,
2138 					    spdk_io_channel_from_ctx(bdev_io->internal.ch),
2139 					    current_offset, num_blocks,
2140 					    bdev_io_split_done, bdev_io);
2141 		break;
2142 	case SPDK_BDEV_IO_TYPE_WRITE_ZEROES:
2143 		io_wait_fn = _bdev_write_zeroes_split;
2144 		rc = spdk_bdev_write_zeroes_blocks(bdev_io->internal.desc,
2145 						   spdk_io_channel_from_ctx(bdev_io->internal.ch),
2146 						   current_offset, num_blocks,
2147 						   bdev_io_split_done, bdev_io);
2148 		break;
2149 	default:
2150 		assert(false);
2151 		rc = -EINVAL;
2152 		break;
2153 	}
2154 
2155 	if (rc == 0) {
2156 		current_offset += num_blocks;
2157 		current_remaining -= num_blocks;
2158 		bdev_io->u.bdev.split_current_offset_blocks = current_offset;
2159 		bdev_io->u.bdev.split_remaining_num_blocks = current_remaining;
2160 		*offset = current_offset;
2161 		*remaining = current_remaining;
2162 	} else {
2163 		bdev_io->u.bdev.split_outstanding--;
2164 		if (rc == -ENOMEM) {
2165 			if (bdev_io->u.bdev.split_outstanding == 0) {
2166 				/* No I/O is outstanding. Hence we should wait here. */
2167 				bdev_queue_io_wait_with_cb(bdev_io, io_wait_fn);
2168 			}
2169 		} else {
2170 			bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED;
2171 			if (bdev_io->u.bdev.split_outstanding == 0) {
2172 				spdk_trace_record(TRACE_BDEV_IO_DONE, 0, 0, (uintptr_t)bdev_io);
2173 				TAILQ_REMOVE(&bdev_io->internal.ch->io_submitted, bdev_io, internal.ch_link);
2174 				bdev_io->internal.cb(bdev_io, false, bdev_io->internal.caller_ctx);
2175 			}
2176 		}
2177 	}
2178 
2179 	return rc;
2180 }
2181 
2182 static void
2183 _bdev_rw_split(void *_bdev_io)
2184 {
2185 	struct iovec *parent_iov, *iov;
2186 	struct spdk_bdev_io *bdev_io = _bdev_io;
2187 	struct spdk_bdev *bdev = bdev_io->bdev;
2188 	uint64_t parent_offset, current_offset, remaining;
2189 	uint32_t parent_iov_offset, parent_iovcnt, parent_iovpos, child_iovcnt;
2190 	uint32_t to_next_boundary, to_next_boundary_bytes, to_last_block_bytes;
2191 	uint32_t iovcnt, iov_len, child_iovsize;
2192 	uint32_t blocklen = bdev->blocklen;
2193 	uint32_t io_boundary = bdev->optimal_io_boundary;
2194 	uint32_t max_segment_size = bdev->max_segment_size;
2195 	uint32_t max_child_iovcnt = bdev->max_num_segments;
2196 	void *md_buf = NULL;
2197 	int rc;
2198 
2199 	max_segment_size = max_segment_size ? max_segment_size : UINT32_MAX;
2200 	max_child_iovcnt = max_child_iovcnt ? spdk_min(max_child_iovcnt, BDEV_IO_NUM_CHILD_IOV) :
2201 			   BDEV_IO_NUM_CHILD_IOV;
2202 	io_boundary = bdev->split_on_optimal_io_boundary ? io_boundary : UINT32_MAX;
2203 
2204 	remaining = bdev_io->u.bdev.split_remaining_num_blocks;
2205 	current_offset = bdev_io->u.bdev.split_current_offset_blocks;
2206 	parent_offset = bdev_io->u.bdev.offset_blocks;
2207 	parent_iov_offset = (current_offset - parent_offset) * blocklen;
2208 	parent_iovcnt = bdev_io->u.bdev.iovcnt;
2209 
2210 	for (parent_iovpos = 0; parent_iovpos < parent_iovcnt; parent_iovpos++) {
2211 		parent_iov = &bdev_io->u.bdev.iovs[parent_iovpos];
2212 		if (parent_iov_offset < parent_iov->iov_len) {
2213 			break;
2214 		}
2215 		parent_iov_offset -= parent_iov->iov_len;
2216 	}
2217 
2218 	child_iovcnt = 0;
2219 	while (remaining > 0 && parent_iovpos < parent_iovcnt && child_iovcnt < BDEV_IO_NUM_CHILD_IOV) {
2220 		to_next_boundary = _to_next_boundary(current_offset, io_boundary);
2221 		to_next_boundary = spdk_min(remaining, to_next_boundary);
2222 		to_next_boundary_bytes = to_next_boundary * blocklen;
2223 
2224 		iov = &bdev_io->child_iov[child_iovcnt];
2225 		iovcnt = 0;
2226 
2227 		if (bdev_io->u.bdev.md_buf) {
2228 			md_buf = (char *)bdev_io->u.bdev.md_buf +
2229 				 (current_offset - parent_offset) * spdk_bdev_get_md_size(bdev);
2230 		}
2231 
2232 		child_iovsize = spdk_min(BDEV_IO_NUM_CHILD_IOV - child_iovcnt, max_child_iovcnt);
2233 		while (to_next_boundary_bytes > 0 && parent_iovpos < parent_iovcnt &&
2234 		       iovcnt < child_iovsize) {
2235 			parent_iov = &bdev_io->u.bdev.iovs[parent_iovpos];
2236 			iov_len = parent_iov->iov_len - parent_iov_offset;
2237 
2238 			iov_len = spdk_min(iov_len, max_segment_size);
2239 			iov_len = spdk_min(iov_len, to_next_boundary_bytes);
2240 			to_next_boundary_bytes -= iov_len;
2241 
2242 			bdev_io->child_iov[child_iovcnt].iov_base = parent_iov->iov_base + parent_iov_offset;
2243 			bdev_io->child_iov[child_iovcnt].iov_len = iov_len;
2244 
2245 			if (iov_len < parent_iov->iov_len - parent_iov_offset) {
2246 				parent_iov_offset += iov_len;
2247 			} else {
2248 				parent_iovpos++;
2249 				parent_iov_offset = 0;
2250 			}
2251 			child_iovcnt++;
2252 			iovcnt++;
2253 		}
2254 
2255 		if (to_next_boundary_bytes > 0) {
2256 			/* We had to stop this child I/O early because we ran out of
2257 			 * child_iov space or were limited by max_num_segments.
2258 			 * Ensure the iovs to be aligned with block size and
2259 			 * then adjust to_next_boundary before starting the
2260 			 * child I/O.
2261 			 */
2262 			assert(child_iovcnt == BDEV_IO_NUM_CHILD_IOV ||
2263 			       iovcnt == child_iovsize);
2264 			to_last_block_bytes = to_next_boundary_bytes % blocklen;
2265 			if (to_last_block_bytes != 0) {
2266 				uint32_t child_iovpos = child_iovcnt - 1;
2267 				/* don't decrease child_iovcnt when it equals to BDEV_IO_NUM_CHILD_IOV
2268 				 * so the loop will naturally end
2269 				 */
2270 
2271 				to_last_block_bytes = blocklen - to_last_block_bytes;
2272 				to_next_boundary_bytes += to_last_block_bytes;
2273 				while (to_last_block_bytes > 0 && iovcnt > 0) {
2274 					iov_len = spdk_min(to_last_block_bytes,
2275 							   bdev_io->child_iov[child_iovpos].iov_len);
2276 					bdev_io->child_iov[child_iovpos].iov_len -= iov_len;
2277 					if (bdev_io->child_iov[child_iovpos].iov_len == 0) {
2278 						child_iovpos--;
2279 						if (--iovcnt == 0) {
2280 							/* If the child IO is less than a block size just return.
2281 							 * If the first child IO of any split round is less than
2282 							 * a block size, an error exit.
2283 							 */
2284 							if (bdev_io->u.bdev.split_outstanding == 0) {
2285 								SPDK_ERRLOG("The first child io was less than a block size\n");
2286 								bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED;
2287 								spdk_trace_record(TRACE_BDEV_IO_DONE, 0, 0, (uintptr_t)bdev_io);
2288 								TAILQ_REMOVE(&bdev_io->internal.ch->io_submitted, bdev_io, internal.ch_link);
2289 								bdev_io->internal.cb(bdev_io, false, bdev_io->internal.caller_ctx);
2290 							}
2291 
2292 							return;
2293 						}
2294 					}
2295 
2296 					to_last_block_bytes -= iov_len;
2297 
2298 					if (parent_iov_offset == 0) {
2299 						parent_iovpos--;
2300 						parent_iov_offset = bdev_io->u.bdev.iovs[parent_iovpos].iov_len;
2301 					}
2302 					parent_iov_offset -= iov_len;
2303 				}
2304 
2305 				assert(to_last_block_bytes == 0);
2306 			}
2307 			to_next_boundary -= to_next_boundary_bytes / blocklen;
2308 		}
2309 
2310 		rc = bdev_io_split_submit(bdev_io, iov, iovcnt, md_buf, to_next_boundary,
2311 					  &current_offset, &remaining);
2312 		if (spdk_unlikely(rc)) {
2313 			return;
2314 		}
2315 	}
2316 }
2317 
2318 static void
2319 bdev_unmap_split(struct spdk_bdev_io *bdev_io)
2320 {
2321 	uint64_t offset, unmap_blocks, remaining, max_unmap_blocks;
2322 	uint32_t num_children_reqs = 0;
2323 	int rc;
2324 
2325 	offset = bdev_io->u.bdev.split_current_offset_blocks;
2326 	remaining = bdev_io->u.bdev.split_remaining_num_blocks;
2327 	max_unmap_blocks = bdev_io->bdev->max_unmap * bdev_io->bdev->max_unmap_segments;
2328 
2329 	while (remaining && (num_children_reqs < SPDK_BDEV_MAX_CHILDREN_UNMAP_WRITE_ZEROES_REQS)) {
2330 		unmap_blocks = spdk_min(remaining, max_unmap_blocks);
2331 
2332 		rc = bdev_io_split_submit(bdev_io, NULL, 0, NULL, unmap_blocks,
2333 					  &offset, &remaining);
2334 		if (spdk_likely(rc == 0)) {
2335 			num_children_reqs++;
2336 		} else {
2337 			return;
2338 		}
2339 	}
2340 }
2341 
2342 static void
2343 bdev_write_zeroes_split(struct spdk_bdev_io *bdev_io)
2344 {
2345 	uint64_t offset, write_zeroes_blocks, remaining;
2346 	uint32_t num_children_reqs = 0;
2347 	int rc;
2348 
2349 	offset = bdev_io->u.bdev.split_current_offset_blocks;
2350 	remaining = bdev_io->u.bdev.split_remaining_num_blocks;
2351 
2352 	while (remaining && (num_children_reqs < SPDK_BDEV_MAX_CHILDREN_UNMAP_WRITE_ZEROES_REQS)) {
2353 		write_zeroes_blocks = spdk_min(remaining, bdev_io->bdev->max_write_zeroes);
2354 
2355 		rc = bdev_io_split_submit(bdev_io, NULL, 0, NULL, write_zeroes_blocks,
2356 					  &offset, &remaining);
2357 		if (spdk_likely(rc == 0)) {
2358 			num_children_reqs++;
2359 		} else {
2360 			return;
2361 		}
2362 	}
2363 }
2364 
2365 static void
2366 bdev_io_split_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
2367 {
2368 	struct spdk_bdev_io *parent_io = cb_arg;
2369 
2370 	spdk_bdev_free_io(bdev_io);
2371 
2372 	if (!success) {
2373 		parent_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED;
2374 		/* If any child I/O failed, stop further splitting process. */
2375 		parent_io->u.bdev.split_current_offset_blocks += parent_io->u.bdev.split_remaining_num_blocks;
2376 		parent_io->u.bdev.split_remaining_num_blocks = 0;
2377 	}
2378 	parent_io->u.bdev.split_outstanding--;
2379 	if (parent_io->u.bdev.split_outstanding != 0) {
2380 		return;
2381 	}
2382 
2383 	/*
2384 	 * Parent I/O finishes when all blocks are consumed.
2385 	 */
2386 	if (parent_io->u.bdev.split_remaining_num_blocks == 0) {
2387 		assert(parent_io->internal.cb != bdev_io_split_done);
2388 		spdk_trace_record(TRACE_BDEV_IO_DONE, 0, 0, (uintptr_t)parent_io);
2389 		TAILQ_REMOVE(&parent_io->internal.ch->io_submitted, parent_io, internal.ch_link);
2390 		parent_io->internal.cb(parent_io, parent_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS,
2391 				       parent_io->internal.caller_ctx);
2392 		return;
2393 	}
2394 
2395 	/*
2396 	 * Continue with the splitting process.  This function will complete the parent I/O if the
2397 	 * splitting is done.
2398 	 */
2399 	switch (parent_io->type) {
2400 	case SPDK_BDEV_IO_TYPE_READ:
2401 	case SPDK_BDEV_IO_TYPE_WRITE:
2402 		_bdev_rw_split(parent_io);
2403 		break;
2404 	case SPDK_BDEV_IO_TYPE_UNMAP:
2405 		bdev_unmap_split(parent_io);
2406 		break;
2407 	case SPDK_BDEV_IO_TYPE_WRITE_ZEROES:
2408 		bdev_write_zeroes_split(parent_io);
2409 		break;
2410 	default:
2411 		assert(false);
2412 		break;
2413 	}
2414 }
2415 
2416 static void
2417 bdev_rw_split_get_buf_cb(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io, bool success);
2418 
2419 static void
2420 bdev_io_split(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io)
2421 {
2422 	bdev_io->u.bdev.split_current_offset_blocks = bdev_io->u.bdev.offset_blocks;
2423 	bdev_io->u.bdev.split_remaining_num_blocks = bdev_io->u.bdev.num_blocks;
2424 	bdev_io->u.bdev.split_outstanding = 0;
2425 	bdev_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS;
2426 
2427 	switch (bdev_io->type) {
2428 	case SPDK_BDEV_IO_TYPE_READ:
2429 	case SPDK_BDEV_IO_TYPE_WRITE:
2430 		if (_is_buf_allocated(bdev_io->u.bdev.iovs)) {
2431 			_bdev_rw_split(bdev_io);
2432 		} else {
2433 			assert(bdev_io->type == SPDK_BDEV_IO_TYPE_READ);
2434 			spdk_bdev_io_get_buf(bdev_io, bdev_rw_split_get_buf_cb,
2435 					     bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen);
2436 		}
2437 		break;
2438 	case SPDK_BDEV_IO_TYPE_UNMAP:
2439 		bdev_unmap_split(bdev_io);
2440 		break;
2441 	case SPDK_BDEV_IO_TYPE_WRITE_ZEROES:
2442 		bdev_write_zeroes_split(bdev_io);
2443 		break;
2444 	default:
2445 		assert(false);
2446 		break;
2447 	}
2448 }
2449 
2450 static void
2451 bdev_rw_split_get_buf_cb(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io, bool success)
2452 {
2453 	if (!success) {
2454 		spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_FAILED);
2455 		return;
2456 	}
2457 
2458 	_bdev_rw_split(bdev_io);
2459 }
2460 
2461 /* Explicitly mark this inline, since it's used as a function pointer and otherwise won't
2462  *  be inlined, at least on some compilers.
2463  */
2464 static inline void
2465 _bdev_io_submit(void *ctx)
2466 {
2467 	struct spdk_bdev_io *bdev_io = ctx;
2468 	struct spdk_bdev *bdev = bdev_io->bdev;
2469 	struct spdk_bdev_channel *bdev_ch = bdev_io->internal.ch;
2470 	uint64_t tsc;
2471 
2472 	tsc = spdk_get_ticks();
2473 	bdev_io->internal.submit_tsc = tsc;
2474 	spdk_trace_record_tsc(tsc, TRACE_BDEV_IO_START, 0, 0, (uintptr_t)bdev_io, bdev_io->type);
2475 
2476 	if (spdk_likely(bdev_ch->flags == 0)) {
2477 		bdev_io_do_submit(bdev_ch, bdev_io);
2478 		return;
2479 	}
2480 
2481 	if (bdev_ch->flags & BDEV_CH_RESET_IN_PROGRESS) {
2482 		_bdev_io_complete_in_submit(bdev_ch, bdev_io, SPDK_BDEV_IO_STATUS_ABORTED);
2483 	} else if (bdev_ch->flags & BDEV_CH_QOS_ENABLED) {
2484 		if (spdk_unlikely(bdev_io->type == SPDK_BDEV_IO_TYPE_ABORT) &&
2485 		    bdev_abort_queued_io(&bdev->internal.qos->queued, bdev_io->u.abort.bio_to_abort)) {
2486 			_bdev_io_complete_in_submit(bdev_ch, bdev_io, SPDK_BDEV_IO_STATUS_SUCCESS);
2487 		} else {
2488 			TAILQ_INSERT_TAIL(&bdev->internal.qos->queued, bdev_io, internal.link);
2489 			bdev_qos_io_submit(bdev_ch, bdev->internal.qos);
2490 		}
2491 	} else {
2492 		SPDK_ERRLOG("unknown bdev_ch flag %x found\n", bdev_ch->flags);
2493 		_bdev_io_complete_in_submit(bdev_ch, bdev_io, SPDK_BDEV_IO_STATUS_FAILED);
2494 	}
2495 }
2496 
2497 bool
2498 bdev_lba_range_overlapped(struct lba_range *range1, struct lba_range *range2);
2499 
2500 bool
2501 bdev_lba_range_overlapped(struct lba_range *range1, struct lba_range *range2)
2502 {
2503 	if (range1->length == 0 || range2->length == 0) {
2504 		return false;
2505 	}
2506 
2507 	if (range1->offset + range1->length <= range2->offset) {
2508 		return false;
2509 	}
2510 
2511 	if (range2->offset + range2->length <= range1->offset) {
2512 		return false;
2513 	}
2514 
2515 	return true;
2516 }
2517 
2518 static bool
2519 bdev_io_range_is_locked(struct spdk_bdev_io *bdev_io, struct lba_range *range)
2520 {
2521 	struct spdk_bdev_channel *ch = bdev_io->internal.ch;
2522 	struct lba_range r;
2523 
2524 	switch (bdev_io->type) {
2525 	case SPDK_BDEV_IO_TYPE_NVME_IO:
2526 	case SPDK_BDEV_IO_TYPE_NVME_IO_MD:
2527 		/* Don't try to decode the NVMe command - just assume worst-case and that
2528 		 * it overlaps a locked range.
2529 		 */
2530 		return true;
2531 	case SPDK_BDEV_IO_TYPE_WRITE:
2532 	case SPDK_BDEV_IO_TYPE_UNMAP:
2533 	case SPDK_BDEV_IO_TYPE_WRITE_ZEROES:
2534 	case SPDK_BDEV_IO_TYPE_ZCOPY:
2535 		r.offset = bdev_io->u.bdev.offset_blocks;
2536 		r.length = bdev_io->u.bdev.num_blocks;
2537 		if (!bdev_lba_range_overlapped(range, &r)) {
2538 			/* This I/O doesn't overlap the specified LBA range. */
2539 			return false;
2540 		} else if (range->owner_ch == ch && range->locked_ctx == bdev_io->internal.caller_ctx) {
2541 			/* This I/O overlaps, but the I/O is on the same channel that locked this
2542 			 * range, and the caller_ctx is the same as the locked_ctx.  This means
2543 			 * that this I/O is associated with the lock, and is allowed to execute.
2544 			 */
2545 			return false;
2546 		} else {
2547 			return true;
2548 		}
2549 	default:
2550 		return false;
2551 	}
2552 }
2553 
2554 void
2555 bdev_io_submit(struct spdk_bdev_io *bdev_io)
2556 {
2557 	struct spdk_bdev *bdev = bdev_io->bdev;
2558 	struct spdk_thread *thread = spdk_bdev_io_get_thread(bdev_io);
2559 	struct spdk_bdev_channel *ch = bdev_io->internal.ch;
2560 
2561 	assert(thread != NULL);
2562 	assert(bdev_io->internal.status == SPDK_BDEV_IO_STATUS_PENDING);
2563 
2564 	if (!TAILQ_EMPTY(&ch->locked_ranges)) {
2565 		struct lba_range *range;
2566 
2567 		TAILQ_FOREACH(range, &ch->locked_ranges, tailq) {
2568 			if (bdev_io_range_is_locked(bdev_io, range)) {
2569 				TAILQ_INSERT_TAIL(&ch->io_locked, bdev_io, internal.ch_link);
2570 				return;
2571 			}
2572 		}
2573 	}
2574 
2575 	TAILQ_INSERT_TAIL(&ch->io_submitted, bdev_io, internal.ch_link);
2576 
2577 	if (bdev_io_should_split(bdev_io)) {
2578 		bdev_io->internal.submit_tsc = spdk_get_ticks();
2579 		spdk_trace_record_tsc(bdev_io->internal.submit_tsc, TRACE_BDEV_IO_START, 0, 0,
2580 				      (uintptr_t)bdev_io, bdev_io->type);
2581 		bdev_io_split(NULL, bdev_io);
2582 		return;
2583 	}
2584 
2585 	if (ch->flags & BDEV_CH_QOS_ENABLED) {
2586 		if ((thread == bdev->internal.qos->thread) || !bdev->internal.qos->thread) {
2587 			_bdev_io_submit(bdev_io);
2588 		} else {
2589 			bdev_io->internal.io_submit_ch = ch;
2590 			bdev_io->internal.ch = bdev->internal.qos->ch;
2591 			spdk_thread_send_msg(bdev->internal.qos->thread, _bdev_io_submit, bdev_io);
2592 		}
2593 	} else {
2594 		_bdev_io_submit(bdev_io);
2595 	}
2596 }
2597 
2598 static void
2599 bdev_io_submit_reset(struct spdk_bdev_io *bdev_io)
2600 {
2601 	struct spdk_bdev *bdev = bdev_io->bdev;
2602 	struct spdk_bdev_channel *bdev_ch = bdev_io->internal.ch;
2603 	struct spdk_io_channel *ch = bdev_ch->channel;
2604 
2605 	assert(bdev_io->internal.status == SPDK_BDEV_IO_STATUS_PENDING);
2606 
2607 	bdev_io->internal.in_submit_request = true;
2608 	bdev->fn_table->submit_request(ch, bdev_io);
2609 	bdev_io->internal.in_submit_request = false;
2610 }
2611 
2612 void
2613 bdev_io_init(struct spdk_bdev_io *bdev_io,
2614 	     struct spdk_bdev *bdev, void *cb_arg,
2615 	     spdk_bdev_io_completion_cb cb)
2616 {
2617 	bdev_io->bdev = bdev;
2618 	bdev_io->internal.caller_ctx = cb_arg;
2619 	bdev_io->internal.cb = cb;
2620 	bdev_io->internal.status = SPDK_BDEV_IO_STATUS_PENDING;
2621 	bdev_io->internal.in_submit_request = false;
2622 	bdev_io->internal.buf = NULL;
2623 	bdev_io->internal.io_submit_ch = NULL;
2624 	bdev_io->internal.orig_iovs = NULL;
2625 	bdev_io->internal.orig_iovcnt = 0;
2626 	bdev_io->internal.orig_md_buf = NULL;
2627 	bdev_io->internal.error.nvme.cdw0 = 0;
2628 	bdev_io->num_retries = 0;
2629 	bdev_io->internal.get_buf_cb = NULL;
2630 	bdev_io->internal.get_aux_buf_cb = NULL;
2631 	bdev_io->internal.ext_opts = NULL;
2632 }
2633 
2634 static bool
2635 bdev_io_type_supported(struct spdk_bdev *bdev, enum spdk_bdev_io_type io_type)
2636 {
2637 	return bdev->fn_table->io_type_supported(bdev->ctxt, io_type);
2638 }
2639 
2640 bool
2641 spdk_bdev_io_type_supported(struct spdk_bdev *bdev, enum spdk_bdev_io_type io_type)
2642 {
2643 	bool supported;
2644 
2645 	supported = bdev_io_type_supported(bdev, io_type);
2646 
2647 	if (!supported) {
2648 		switch (io_type) {
2649 		case SPDK_BDEV_IO_TYPE_WRITE_ZEROES:
2650 			/* The bdev layer will emulate write zeroes as long as write is supported. */
2651 			supported = bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_WRITE);
2652 			break;
2653 		default:
2654 			break;
2655 		}
2656 	}
2657 
2658 	return supported;
2659 }
2660 
2661 int
2662 spdk_bdev_dump_info_json(struct spdk_bdev *bdev, struct spdk_json_write_ctx *w)
2663 {
2664 	if (bdev->fn_table->dump_info_json) {
2665 		return bdev->fn_table->dump_info_json(bdev->ctxt, w);
2666 	}
2667 
2668 	return 0;
2669 }
2670 
2671 static void
2672 bdev_qos_update_max_quota_per_timeslice(struct spdk_bdev_qos *qos)
2673 {
2674 	uint32_t max_per_timeslice = 0;
2675 	int i;
2676 
2677 	for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) {
2678 		if (qos->rate_limits[i].limit == SPDK_BDEV_QOS_LIMIT_NOT_DEFINED) {
2679 			qos->rate_limits[i].max_per_timeslice = 0;
2680 			continue;
2681 		}
2682 
2683 		max_per_timeslice = qos->rate_limits[i].limit *
2684 				    SPDK_BDEV_QOS_TIMESLICE_IN_USEC / SPDK_SEC_TO_USEC;
2685 
2686 		qos->rate_limits[i].max_per_timeslice = spdk_max(max_per_timeslice,
2687 							qos->rate_limits[i].min_per_timeslice);
2688 
2689 		qos->rate_limits[i].remaining_this_timeslice = qos->rate_limits[i].max_per_timeslice;
2690 	}
2691 
2692 	bdev_qos_set_ops(qos);
2693 }
2694 
2695 static int
2696 bdev_channel_poll_qos(void *arg)
2697 {
2698 	struct spdk_bdev_qos *qos = arg;
2699 	uint64_t now = spdk_get_ticks();
2700 	int i;
2701 
2702 	if (now < (qos->last_timeslice + qos->timeslice_size)) {
2703 		/* We received our callback earlier than expected - return
2704 		 *  immediately and wait to do accounting until at least one
2705 		 *  timeslice has actually expired.  This should never happen
2706 		 *  with a well-behaved timer implementation.
2707 		 */
2708 		return SPDK_POLLER_IDLE;
2709 	}
2710 
2711 	/* Reset for next round of rate limiting */
2712 	for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) {
2713 		/* We may have allowed the IOs or bytes to slightly overrun in the last
2714 		 * timeslice. remaining_this_timeslice is signed, so if it's negative
2715 		 * here, we'll account for the overrun so that the next timeslice will
2716 		 * be appropriately reduced.
2717 		 */
2718 		if (qos->rate_limits[i].remaining_this_timeslice > 0) {
2719 			qos->rate_limits[i].remaining_this_timeslice = 0;
2720 		}
2721 	}
2722 
2723 	while (now >= (qos->last_timeslice + qos->timeslice_size)) {
2724 		qos->last_timeslice += qos->timeslice_size;
2725 		for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) {
2726 			qos->rate_limits[i].remaining_this_timeslice +=
2727 				qos->rate_limits[i].max_per_timeslice;
2728 		}
2729 	}
2730 
2731 	return bdev_qos_io_submit(qos->ch, qos);
2732 }
2733 
2734 static void
2735 bdev_channel_destroy_resource(struct spdk_bdev_channel *ch)
2736 {
2737 	struct spdk_bdev_shared_resource *shared_resource;
2738 	struct lba_range *range;
2739 
2740 	while (!TAILQ_EMPTY(&ch->locked_ranges)) {
2741 		range = TAILQ_FIRST(&ch->locked_ranges);
2742 		TAILQ_REMOVE(&ch->locked_ranges, range, tailq);
2743 		free(range);
2744 	}
2745 
2746 	spdk_put_io_channel(ch->channel);
2747 
2748 	shared_resource = ch->shared_resource;
2749 
2750 	assert(TAILQ_EMPTY(&ch->io_locked));
2751 	assert(TAILQ_EMPTY(&ch->io_submitted));
2752 	assert(ch->io_outstanding == 0);
2753 	assert(shared_resource->ref > 0);
2754 	shared_resource->ref--;
2755 	if (shared_resource->ref == 0) {
2756 		assert(shared_resource->io_outstanding == 0);
2757 		TAILQ_REMOVE(&shared_resource->mgmt_ch->shared_resources, shared_resource, link);
2758 		spdk_put_io_channel(spdk_io_channel_from_ctx(shared_resource->mgmt_ch));
2759 		free(shared_resource);
2760 	}
2761 }
2762 
2763 /* Caller must hold bdev->internal.mutex. */
2764 static void
2765 bdev_enable_qos(struct spdk_bdev *bdev, struct spdk_bdev_channel *ch)
2766 {
2767 	struct spdk_bdev_qos	*qos = bdev->internal.qos;
2768 	int			i;
2769 
2770 	/* Rate limiting on this bdev enabled */
2771 	if (qos) {
2772 		if (qos->ch == NULL) {
2773 			struct spdk_io_channel *io_ch;
2774 
2775 			SPDK_DEBUGLOG(bdev, "Selecting channel %p as QoS channel for bdev %s on thread %p\n", ch,
2776 				      bdev->name, spdk_get_thread());
2777 
2778 			/* No qos channel has been selected, so set one up */
2779 
2780 			/* Take another reference to ch */
2781 			io_ch = spdk_get_io_channel(__bdev_to_io_dev(bdev));
2782 			assert(io_ch != NULL);
2783 			qos->ch = ch;
2784 
2785 			qos->thread = spdk_io_channel_get_thread(io_ch);
2786 
2787 			TAILQ_INIT(&qos->queued);
2788 
2789 			for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) {
2790 				if (bdev_qos_is_iops_rate_limit(i) == true) {
2791 					qos->rate_limits[i].min_per_timeslice =
2792 						SPDK_BDEV_QOS_MIN_IO_PER_TIMESLICE;
2793 				} else {
2794 					qos->rate_limits[i].min_per_timeslice =
2795 						SPDK_BDEV_QOS_MIN_BYTE_PER_TIMESLICE;
2796 				}
2797 
2798 				if (qos->rate_limits[i].limit == 0) {
2799 					qos->rate_limits[i].limit = SPDK_BDEV_QOS_LIMIT_NOT_DEFINED;
2800 				}
2801 			}
2802 			bdev_qos_update_max_quota_per_timeslice(qos);
2803 			qos->timeslice_size =
2804 				SPDK_BDEV_QOS_TIMESLICE_IN_USEC * spdk_get_ticks_hz() / SPDK_SEC_TO_USEC;
2805 			qos->last_timeslice = spdk_get_ticks();
2806 			qos->poller = SPDK_POLLER_REGISTER(bdev_channel_poll_qos,
2807 							   qos,
2808 							   SPDK_BDEV_QOS_TIMESLICE_IN_USEC);
2809 		}
2810 
2811 		ch->flags |= BDEV_CH_QOS_ENABLED;
2812 	}
2813 }
2814 
2815 struct poll_timeout_ctx {
2816 	struct spdk_bdev_desc	*desc;
2817 	uint64_t		timeout_in_sec;
2818 	spdk_bdev_io_timeout_cb	cb_fn;
2819 	void			*cb_arg;
2820 };
2821 
2822 static void
2823 bdev_desc_free(struct spdk_bdev_desc *desc)
2824 {
2825 	pthread_mutex_destroy(&desc->mutex);
2826 	free(desc->media_events_buffer);
2827 	free(desc);
2828 }
2829 
2830 static void
2831 bdev_channel_poll_timeout_io_done(struct spdk_io_channel_iter *i, int status)
2832 {
2833 	struct poll_timeout_ctx *ctx  = spdk_io_channel_iter_get_ctx(i);
2834 	struct spdk_bdev_desc *desc = ctx->desc;
2835 
2836 	free(ctx);
2837 
2838 	pthread_mutex_lock(&desc->mutex);
2839 	desc->refs--;
2840 	if (desc->closed == true && desc->refs == 0) {
2841 		pthread_mutex_unlock(&desc->mutex);
2842 		bdev_desc_free(desc);
2843 		return;
2844 	}
2845 	pthread_mutex_unlock(&desc->mutex);
2846 }
2847 
2848 static void
2849 bdev_channel_poll_timeout_io(struct spdk_io_channel_iter *i)
2850 {
2851 	struct poll_timeout_ctx *ctx  = spdk_io_channel_iter_get_ctx(i);
2852 	struct spdk_io_channel *io_ch = spdk_io_channel_iter_get_channel(i);
2853 	struct spdk_bdev_channel *bdev_ch = spdk_io_channel_get_ctx(io_ch);
2854 	struct spdk_bdev_desc *desc = ctx->desc;
2855 	struct spdk_bdev_io *bdev_io;
2856 	uint64_t now;
2857 
2858 	pthread_mutex_lock(&desc->mutex);
2859 	if (desc->closed == true) {
2860 		pthread_mutex_unlock(&desc->mutex);
2861 		spdk_for_each_channel_continue(i, -1);
2862 		return;
2863 	}
2864 	pthread_mutex_unlock(&desc->mutex);
2865 
2866 	now = spdk_get_ticks();
2867 	TAILQ_FOREACH(bdev_io, &bdev_ch->io_submitted, internal.ch_link) {
2868 		/* Exclude any I/O that are generated via splitting. */
2869 		if (bdev_io->internal.cb == bdev_io_split_done) {
2870 			continue;
2871 		}
2872 
2873 		/* Once we find an I/O that has not timed out, we can immediately
2874 		 * exit the loop.
2875 		 */
2876 		if (now < (bdev_io->internal.submit_tsc +
2877 			   ctx->timeout_in_sec * spdk_get_ticks_hz())) {
2878 			goto end;
2879 		}
2880 
2881 		if (bdev_io->internal.desc == desc) {
2882 			ctx->cb_fn(ctx->cb_arg, bdev_io);
2883 		}
2884 	}
2885 
2886 end:
2887 	spdk_for_each_channel_continue(i, 0);
2888 }
2889 
2890 static int
2891 bdev_poll_timeout_io(void *arg)
2892 {
2893 	struct spdk_bdev_desc *desc = arg;
2894 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
2895 	struct poll_timeout_ctx *ctx;
2896 
2897 	ctx = calloc(1, sizeof(struct poll_timeout_ctx));
2898 	if (!ctx) {
2899 		SPDK_ERRLOG("failed to allocate memory\n");
2900 		return SPDK_POLLER_BUSY;
2901 	}
2902 	ctx->desc = desc;
2903 	ctx->cb_arg = desc->cb_arg;
2904 	ctx->cb_fn = desc->cb_fn;
2905 	ctx->timeout_in_sec = desc->timeout_in_sec;
2906 
2907 	/* Take a ref on the descriptor in case it gets closed while we are checking
2908 	 * all of the channels.
2909 	 */
2910 	pthread_mutex_lock(&desc->mutex);
2911 	desc->refs++;
2912 	pthread_mutex_unlock(&desc->mutex);
2913 
2914 	spdk_for_each_channel(__bdev_to_io_dev(bdev),
2915 			      bdev_channel_poll_timeout_io,
2916 			      ctx,
2917 			      bdev_channel_poll_timeout_io_done);
2918 
2919 	return SPDK_POLLER_BUSY;
2920 }
2921 
2922 int
2923 spdk_bdev_set_timeout(struct spdk_bdev_desc *desc, uint64_t timeout_in_sec,
2924 		      spdk_bdev_io_timeout_cb cb_fn, void *cb_arg)
2925 {
2926 	assert(desc->thread == spdk_get_thread());
2927 
2928 	spdk_poller_unregister(&desc->io_timeout_poller);
2929 
2930 	if (timeout_in_sec) {
2931 		assert(cb_fn != NULL);
2932 		desc->io_timeout_poller = SPDK_POLLER_REGISTER(bdev_poll_timeout_io,
2933 					  desc,
2934 					  SPDK_BDEV_IO_POLL_INTERVAL_IN_MSEC * SPDK_SEC_TO_USEC /
2935 					  1000);
2936 		if (desc->io_timeout_poller == NULL) {
2937 			SPDK_ERRLOG("can not register the desc timeout IO poller\n");
2938 			return -1;
2939 		}
2940 	}
2941 
2942 	desc->cb_fn = cb_fn;
2943 	desc->cb_arg = cb_arg;
2944 	desc->timeout_in_sec = timeout_in_sec;
2945 
2946 	return 0;
2947 }
2948 
2949 static int
2950 bdev_channel_create(void *io_device, void *ctx_buf)
2951 {
2952 	struct spdk_bdev		*bdev = __bdev_from_io_dev(io_device);
2953 	struct spdk_bdev_channel	*ch = ctx_buf;
2954 	struct spdk_io_channel		*mgmt_io_ch;
2955 	struct spdk_bdev_mgmt_channel	*mgmt_ch;
2956 	struct spdk_bdev_shared_resource *shared_resource;
2957 	struct lba_range		*range;
2958 
2959 	ch->bdev = bdev;
2960 	ch->channel = bdev->fn_table->get_io_channel(bdev->ctxt);
2961 	if (!ch->channel) {
2962 		return -1;
2963 	}
2964 
2965 	assert(ch->histogram == NULL);
2966 	if (bdev->internal.histogram_enabled) {
2967 		ch->histogram = spdk_histogram_data_alloc();
2968 		if (ch->histogram == NULL) {
2969 			SPDK_ERRLOG("Could not allocate histogram\n");
2970 		}
2971 	}
2972 
2973 	mgmt_io_ch = spdk_get_io_channel(&g_bdev_mgr);
2974 	if (!mgmt_io_ch) {
2975 		spdk_put_io_channel(ch->channel);
2976 		return -1;
2977 	}
2978 
2979 	mgmt_ch = spdk_io_channel_get_ctx(mgmt_io_ch);
2980 	TAILQ_FOREACH(shared_resource, &mgmt_ch->shared_resources, link) {
2981 		if (shared_resource->shared_ch == ch->channel) {
2982 			spdk_put_io_channel(mgmt_io_ch);
2983 			shared_resource->ref++;
2984 			break;
2985 		}
2986 	}
2987 
2988 	if (shared_resource == NULL) {
2989 		shared_resource = calloc(1, sizeof(*shared_resource));
2990 		if (shared_resource == NULL) {
2991 			spdk_put_io_channel(ch->channel);
2992 			spdk_put_io_channel(mgmt_io_ch);
2993 			return -1;
2994 		}
2995 
2996 		shared_resource->mgmt_ch = mgmt_ch;
2997 		shared_resource->io_outstanding = 0;
2998 		TAILQ_INIT(&shared_resource->nomem_io);
2999 		shared_resource->nomem_threshold = 0;
3000 		shared_resource->shared_ch = ch->channel;
3001 		shared_resource->ref = 1;
3002 		TAILQ_INSERT_TAIL(&mgmt_ch->shared_resources, shared_resource, link);
3003 	}
3004 
3005 	memset(&ch->stat, 0, sizeof(ch->stat));
3006 	ch->stat.ticks_rate = spdk_get_ticks_hz();
3007 	ch->io_outstanding = 0;
3008 	TAILQ_INIT(&ch->queued_resets);
3009 	TAILQ_INIT(&ch->locked_ranges);
3010 	ch->flags = 0;
3011 	ch->shared_resource = shared_resource;
3012 
3013 	TAILQ_INIT(&ch->io_submitted);
3014 	TAILQ_INIT(&ch->io_locked);
3015 
3016 #ifdef SPDK_CONFIG_VTUNE
3017 	{
3018 		char *name;
3019 		__itt_init_ittlib(NULL, 0);
3020 		name = spdk_sprintf_alloc("spdk_bdev_%s_%p", ch->bdev->name, ch);
3021 		if (!name) {
3022 			bdev_channel_destroy_resource(ch);
3023 			return -1;
3024 		}
3025 		ch->handle = __itt_string_handle_create(name);
3026 		free(name);
3027 		ch->start_tsc = spdk_get_ticks();
3028 		ch->interval_tsc = spdk_get_ticks_hz() / 100;
3029 		memset(&ch->prev_stat, 0, sizeof(ch->prev_stat));
3030 	}
3031 #endif
3032 
3033 	pthread_mutex_lock(&bdev->internal.mutex);
3034 	bdev_enable_qos(bdev, ch);
3035 
3036 	TAILQ_FOREACH(range, &bdev->internal.locked_ranges, tailq) {
3037 		struct lba_range *new_range;
3038 
3039 		new_range = calloc(1, sizeof(*new_range));
3040 		if (new_range == NULL) {
3041 			pthread_mutex_unlock(&bdev->internal.mutex);
3042 			bdev_channel_destroy_resource(ch);
3043 			return -1;
3044 		}
3045 		new_range->length = range->length;
3046 		new_range->offset = range->offset;
3047 		new_range->locked_ctx = range->locked_ctx;
3048 		TAILQ_INSERT_TAIL(&ch->locked_ranges, new_range, tailq);
3049 	}
3050 
3051 	pthread_mutex_unlock(&bdev->internal.mutex);
3052 
3053 	return 0;
3054 }
3055 
3056 /*
3057  * Abort I/O that are waiting on a data buffer.  These types of I/O are
3058  *  linked using the spdk_bdev_io internal.buf_link TAILQ_ENTRY.
3059  */
3060 static void
3061 bdev_abort_all_buf_io(bdev_io_stailq_t *queue, struct spdk_bdev_channel *ch)
3062 {
3063 	bdev_io_stailq_t tmp;
3064 	struct spdk_bdev_io *bdev_io;
3065 
3066 	STAILQ_INIT(&tmp);
3067 
3068 	while (!STAILQ_EMPTY(queue)) {
3069 		bdev_io = STAILQ_FIRST(queue);
3070 		STAILQ_REMOVE_HEAD(queue, internal.buf_link);
3071 		if (bdev_io->internal.ch == ch) {
3072 			spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_ABORTED);
3073 		} else {
3074 			STAILQ_INSERT_TAIL(&tmp, bdev_io, internal.buf_link);
3075 		}
3076 	}
3077 
3078 	STAILQ_SWAP(&tmp, queue, spdk_bdev_io);
3079 }
3080 
3081 /*
3082  * Abort I/O that are queued waiting for submission.  These types of I/O are
3083  *  linked using the spdk_bdev_io link TAILQ_ENTRY.
3084  */
3085 static void
3086 bdev_abort_all_queued_io(bdev_io_tailq_t *queue, struct spdk_bdev_channel *ch)
3087 {
3088 	struct spdk_bdev_io *bdev_io, *tmp;
3089 
3090 	TAILQ_FOREACH_SAFE(bdev_io, queue, internal.link, tmp) {
3091 		if (bdev_io->internal.ch == ch) {
3092 			TAILQ_REMOVE(queue, bdev_io, internal.link);
3093 			/*
3094 			 * spdk_bdev_io_complete() assumes that the completed I/O had
3095 			 *  been submitted to the bdev module.  Since in this case it
3096 			 *  hadn't, bump io_outstanding to account for the decrement
3097 			 *  that spdk_bdev_io_complete() will do.
3098 			 */
3099 			if (bdev_io->type != SPDK_BDEV_IO_TYPE_RESET) {
3100 				ch->io_outstanding++;
3101 				ch->shared_resource->io_outstanding++;
3102 			}
3103 			spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_ABORTED);
3104 		}
3105 	}
3106 }
3107 
3108 static bool
3109 bdev_abort_queued_io(bdev_io_tailq_t *queue, struct spdk_bdev_io *bio_to_abort)
3110 {
3111 	struct spdk_bdev_io *bdev_io;
3112 
3113 	TAILQ_FOREACH(bdev_io, queue, internal.link) {
3114 		if (bdev_io == bio_to_abort) {
3115 			TAILQ_REMOVE(queue, bio_to_abort, internal.link);
3116 			spdk_bdev_io_complete(bio_to_abort, SPDK_BDEV_IO_STATUS_ABORTED);
3117 			return true;
3118 		}
3119 	}
3120 
3121 	return false;
3122 }
3123 
3124 static bool
3125 bdev_abort_buf_io(bdev_io_stailq_t *queue, struct spdk_bdev_io *bio_to_abort)
3126 {
3127 	struct spdk_bdev_io *bdev_io;
3128 
3129 	STAILQ_FOREACH(bdev_io, queue, internal.buf_link) {
3130 		if (bdev_io == bio_to_abort) {
3131 			STAILQ_REMOVE(queue, bio_to_abort, spdk_bdev_io, internal.buf_link);
3132 			spdk_bdev_io_complete(bio_to_abort, SPDK_BDEV_IO_STATUS_ABORTED);
3133 			return true;
3134 		}
3135 	}
3136 
3137 	return false;
3138 }
3139 
3140 static void
3141 bdev_qos_channel_destroy(void *cb_arg)
3142 {
3143 	struct spdk_bdev_qos *qos = cb_arg;
3144 
3145 	spdk_put_io_channel(spdk_io_channel_from_ctx(qos->ch));
3146 	spdk_poller_unregister(&qos->poller);
3147 
3148 	SPDK_DEBUGLOG(bdev, "Free QoS %p.\n", qos);
3149 
3150 	free(qos);
3151 }
3152 
3153 static int
3154 bdev_qos_destroy(struct spdk_bdev *bdev)
3155 {
3156 	int i;
3157 
3158 	/*
3159 	 * Cleanly shutting down the QoS poller is tricky, because
3160 	 * during the asynchronous operation the user could open
3161 	 * a new descriptor and create a new channel, spawning
3162 	 * a new QoS poller.
3163 	 *
3164 	 * The strategy is to create a new QoS structure here and swap it
3165 	 * in. The shutdown path then continues to refer to the old one
3166 	 * until it completes and then releases it.
3167 	 */
3168 	struct spdk_bdev_qos *new_qos, *old_qos;
3169 
3170 	old_qos = bdev->internal.qos;
3171 
3172 	new_qos = calloc(1, sizeof(*new_qos));
3173 	if (!new_qos) {
3174 		SPDK_ERRLOG("Unable to allocate memory to shut down QoS.\n");
3175 		return -ENOMEM;
3176 	}
3177 
3178 	/* Copy the old QoS data into the newly allocated structure */
3179 	memcpy(new_qos, old_qos, sizeof(*new_qos));
3180 
3181 	/* Zero out the key parts of the QoS structure */
3182 	new_qos->ch = NULL;
3183 	new_qos->thread = NULL;
3184 	new_qos->poller = NULL;
3185 	TAILQ_INIT(&new_qos->queued);
3186 	/*
3187 	 * The limit member of spdk_bdev_qos_limit structure is not zeroed.
3188 	 * It will be used later for the new QoS structure.
3189 	 */
3190 	for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) {
3191 		new_qos->rate_limits[i].remaining_this_timeslice = 0;
3192 		new_qos->rate_limits[i].min_per_timeslice = 0;
3193 		new_qos->rate_limits[i].max_per_timeslice = 0;
3194 	}
3195 
3196 	bdev->internal.qos = new_qos;
3197 
3198 	if (old_qos->thread == NULL) {
3199 		free(old_qos);
3200 	} else {
3201 		spdk_thread_send_msg(old_qos->thread, bdev_qos_channel_destroy, old_qos);
3202 	}
3203 
3204 	/* It is safe to continue with destroying the bdev even though the QoS channel hasn't
3205 	 * been destroyed yet. The destruction path will end up waiting for the final
3206 	 * channel to be put before it releases resources. */
3207 
3208 	return 0;
3209 }
3210 
3211 static void
3212 bdev_io_stat_add(struct spdk_bdev_io_stat *total, struct spdk_bdev_io_stat *add)
3213 {
3214 	total->bytes_read += add->bytes_read;
3215 	total->num_read_ops += add->num_read_ops;
3216 	total->bytes_written += add->bytes_written;
3217 	total->num_write_ops += add->num_write_ops;
3218 	total->bytes_unmapped += add->bytes_unmapped;
3219 	total->num_unmap_ops += add->num_unmap_ops;
3220 	total->read_latency_ticks += add->read_latency_ticks;
3221 	total->write_latency_ticks += add->write_latency_ticks;
3222 	total->unmap_latency_ticks += add->unmap_latency_ticks;
3223 }
3224 
3225 static void
3226 bdev_channel_destroy(void *io_device, void *ctx_buf)
3227 {
3228 	struct spdk_bdev_channel	*ch = ctx_buf;
3229 	struct spdk_bdev_mgmt_channel	*mgmt_ch;
3230 	struct spdk_bdev_shared_resource *shared_resource = ch->shared_resource;
3231 
3232 	SPDK_DEBUGLOG(bdev, "Destroying channel %p for bdev %s on thread %p\n", ch, ch->bdev->name,
3233 		      spdk_get_thread());
3234 
3235 	/* This channel is going away, so add its statistics into the bdev so that they don't get lost. */
3236 	pthread_mutex_lock(&ch->bdev->internal.mutex);
3237 	bdev_io_stat_add(&ch->bdev->internal.stat, &ch->stat);
3238 	pthread_mutex_unlock(&ch->bdev->internal.mutex);
3239 
3240 	mgmt_ch = shared_resource->mgmt_ch;
3241 
3242 	bdev_abort_all_queued_io(&ch->queued_resets, ch);
3243 	bdev_abort_all_queued_io(&shared_resource->nomem_io, ch);
3244 	bdev_abort_all_buf_io(&mgmt_ch->need_buf_small, ch);
3245 	bdev_abort_all_buf_io(&mgmt_ch->need_buf_large, ch);
3246 
3247 	if (ch->histogram) {
3248 		spdk_histogram_data_free(ch->histogram);
3249 	}
3250 
3251 	bdev_channel_destroy_resource(ch);
3252 }
3253 
3254 /*
3255  * If the name already exists in the global bdev name tree, RB_INSERT() returns a pointer
3256  * to it. Hence we do not have to call bdev_get_by_name() when using this function.
3257  */
3258 static int
3259 bdev_name_add(struct spdk_bdev_name *bdev_name, struct spdk_bdev *bdev, const char *name)
3260 {
3261 	struct spdk_bdev_name *tmp;
3262 
3263 	bdev_name->name = strdup(name);
3264 	if (bdev_name->name == NULL) {
3265 		SPDK_ERRLOG("Unable to allocate bdev name\n");
3266 		return -ENOMEM;
3267 	}
3268 
3269 	bdev_name->bdev = bdev;
3270 
3271 	pthread_mutex_lock(&g_bdev_mgr.mutex);
3272 	tmp = RB_INSERT(bdev_name_tree, &g_bdev_mgr.bdev_names, bdev_name);
3273 	pthread_mutex_unlock(&g_bdev_mgr.mutex);
3274 
3275 	if (tmp != NULL) {
3276 		SPDK_ERRLOG("Bdev name %s already exists\n", name);
3277 		free(bdev_name->name);
3278 		return -EEXIST;
3279 	}
3280 
3281 	return 0;
3282 }
3283 
3284 static void
3285 bdev_name_del(struct spdk_bdev_name *bdev_name)
3286 {
3287 	RB_REMOVE(bdev_name_tree, &g_bdev_mgr.bdev_names, bdev_name);
3288 	free(bdev_name->name);
3289 }
3290 
3291 int
3292 spdk_bdev_alias_add(struct spdk_bdev *bdev, const char *alias)
3293 {
3294 	struct spdk_bdev_alias *tmp;
3295 	int ret;
3296 
3297 	if (alias == NULL) {
3298 		SPDK_ERRLOG("Empty alias passed\n");
3299 		return -EINVAL;
3300 	}
3301 
3302 	tmp = calloc(1, sizeof(*tmp));
3303 	if (tmp == NULL) {
3304 		SPDK_ERRLOG("Unable to allocate alias\n");
3305 		return -ENOMEM;
3306 	}
3307 
3308 	ret = bdev_name_add(&tmp->alias, bdev, alias);
3309 	if (ret != 0) {
3310 		free(tmp);
3311 		return ret;
3312 	}
3313 
3314 	TAILQ_INSERT_TAIL(&bdev->aliases, tmp, tailq);
3315 
3316 	return 0;
3317 }
3318 
3319 int
3320 spdk_bdev_alias_del(struct spdk_bdev *bdev, const char *alias)
3321 {
3322 	struct spdk_bdev_alias *tmp;
3323 
3324 	TAILQ_FOREACH(tmp, &bdev->aliases, tailq) {
3325 		if (strcmp(alias, tmp->alias.name) == 0) {
3326 			TAILQ_REMOVE(&bdev->aliases, tmp, tailq);
3327 			pthread_mutex_lock(&g_bdev_mgr.mutex);
3328 			bdev_name_del(&tmp->alias);
3329 			pthread_mutex_unlock(&g_bdev_mgr.mutex);
3330 			free(tmp);
3331 			return 0;
3332 		}
3333 	}
3334 
3335 	SPDK_INFOLOG(bdev, "Alias %s does not exists\n", alias);
3336 
3337 	return -ENOENT;
3338 }
3339 
3340 void
3341 spdk_bdev_alias_del_all(struct spdk_bdev *bdev)
3342 {
3343 	struct spdk_bdev_alias *p, *tmp;
3344 
3345 	TAILQ_FOREACH_SAFE(p, &bdev->aliases, tailq, tmp) {
3346 		TAILQ_REMOVE(&bdev->aliases, p, tailq);
3347 		pthread_mutex_lock(&g_bdev_mgr.mutex);
3348 		bdev_name_del(&p->alias);
3349 		pthread_mutex_unlock(&g_bdev_mgr.mutex);
3350 		free(p);
3351 	}
3352 }
3353 
3354 struct spdk_io_channel *
3355 spdk_bdev_get_io_channel(struct spdk_bdev_desc *desc)
3356 {
3357 	return spdk_get_io_channel(__bdev_to_io_dev(spdk_bdev_desc_get_bdev(desc)));
3358 }
3359 
3360 void *
3361 spdk_bdev_get_module_ctx(struct spdk_bdev_desc *desc)
3362 {
3363 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
3364 	void *ctx = NULL;
3365 
3366 	if (bdev->fn_table->get_module_ctx) {
3367 		ctx = bdev->fn_table->get_module_ctx(bdev->ctxt);
3368 	}
3369 
3370 	return ctx;
3371 }
3372 
3373 const char *
3374 spdk_bdev_get_module_name(const struct spdk_bdev *bdev)
3375 {
3376 	return bdev->module->name;
3377 }
3378 
3379 const char *
3380 spdk_bdev_get_name(const struct spdk_bdev *bdev)
3381 {
3382 	return bdev->name;
3383 }
3384 
3385 const char *
3386 spdk_bdev_get_product_name(const struct spdk_bdev *bdev)
3387 {
3388 	return bdev->product_name;
3389 }
3390 
3391 const struct spdk_bdev_aliases_list *
3392 spdk_bdev_get_aliases(const struct spdk_bdev *bdev)
3393 {
3394 	return &bdev->aliases;
3395 }
3396 
3397 uint32_t
3398 spdk_bdev_get_block_size(const struct spdk_bdev *bdev)
3399 {
3400 	return bdev->blocklen;
3401 }
3402 
3403 uint32_t
3404 spdk_bdev_get_write_unit_size(const struct spdk_bdev *bdev)
3405 {
3406 	return bdev->write_unit_size;
3407 }
3408 
3409 uint64_t
3410 spdk_bdev_get_num_blocks(const struct spdk_bdev *bdev)
3411 {
3412 	return bdev->blockcnt;
3413 }
3414 
3415 const char *
3416 spdk_bdev_get_qos_rpc_type(enum spdk_bdev_qos_rate_limit_type type)
3417 {
3418 	return qos_rpc_type[type];
3419 }
3420 
3421 void
3422 spdk_bdev_get_qos_rate_limits(struct spdk_bdev *bdev, uint64_t *limits)
3423 {
3424 	int i;
3425 
3426 	memset(limits, 0, sizeof(*limits) * SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES);
3427 
3428 	pthread_mutex_lock(&bdev->internal.mutex);
3429 	if (bdev->internal.qos) {
3430 		for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) {
3431 			if (bdev->internal.qos->rate_limits[i].limit !=
3432 			    SPDK_BDEV_QOS_LIMIT_NOT_DEFINED) {
3433 				limits[i] = bdev->internal.qos->rate_limits[i].limit;
3434 				if (bdev_qos_is_iops_rate_limit(i) == false) {
3435 					/* Change from Byte to Megabyte which is user visible. */
3436 					limits[i] = limits[i] / 1024 / 1024;
3437 				}
3438 			}
3439 		}
3440 	}
3441 	pthread_mutex_unlock(&bdev->internal.mutex);
3442 }
3443 
3444 size_t
3445 spdk_bdev_get_buf_align(const struct spdk_bdev *bdev)
3446 {
3447 	return 1 << bdev->required_alignment;
3448 }
3449 
3450 uint32_t
3451 spdk_bdev_get_optimal_io_boundary(const struct spdk_bdev *bdev)
3452 {
3453 	return bdev->optimal_io_boundary;
3454 }
3455 
3456 bool
3457 spdk_bdev_has_write_cache(const struct spdk_bdev *bdev)
3458 {
3459 	return bdev->write_cache;
3460 }
3461 
3462 const struct spdk_uuid *
3463 spdk_bdev_get_uuid(const struct spdk_bdev *bdev)
3464 {
3465 	return &bdev->uuid;
3466 }
3467 
3468 uint16_t
3469 spdk_bdev_get_acwu(const struct spdk_bdev *bdev)
3470 {
3471 	return bdev->acwu;
3472 }
3473 
3474 uint32_t
3475 spdk_bdev_get_md_size(const struct spdk_bdev *bdev)
3476 {
3477 	return bdev->md_len;
3478 }
3479 
3480 bool
3481 spdk_bdev_is_md_interleaved(const struct spdk_bdev *bdev)
3482 {
3483 	return (bdev->md_len != 0) && bdev->md_interleave;
3484 }
3485 
3486 bool
3487 spdk_bdev_is_md_separate(const struct spdk_bdev *bdev)
3488 {
3489 	return (bdev->md_len != 0) && !bdev->md_interleave;
3490 }
3491 
3492 bool
3493 spdk_bdev_is_zoned(const struct spdk_bdev *bdev)
3494 {
3495 	return bdev->zoned;
3496 }
3497 
3498 uint32_t
3499 spdk_bdev_get_data_block_size(const struct spdk_bdev *bdev)
3500 {
3501 	if (spdk_bdev_is_md_interleaved(bdev)) {
3502 		return bdev->blocklen - bdev->md_len;
3503 	} else {
3504 		return bdev->blocklen;
3505 	}
3506 }
3507 
3508 uint32_t
3509 spdk_bdev_get_physical_block_size(const struct spdk_bdev *bdev)
3510 {
3511 	return bdev->phys_blocklen;
3512 }
3513 
3514 static uint32_t
3515 _bdev_get_block_size_with_md(const struct spdk_bdev *bdev)
3516 {
3517 	if (!spdk_bdev_is_md_interleaved(bdev)) {
3518 		return bdev->blocklen + bdev->md_len;
3519 	} else {
3520 		return bdev->blocklen;
3521 	}
3522 }
3523 
3524 enum spdk_dif_type spdk_bdev_get_dif_type(const struct spdk_bdev *bdev)
3525 {
3526 	if (bdev->md_len != 0) {
3527 		return bdev->dif_type;
3528 	} else {
3529 		return SPDK_DIF_DISABLE;
3530 	}
3531 }
3532 
3533 bool
3534 spdk_bdev_is_dif_head_of_md(const struct spdk_bdev *bdev)
3535 {
3536 	if (spdk_bdev_get_dif_type(bdev) != SPDK_DIF_DISABLE) {
3537 		return bdev->dif_is_head_of_md;
3538 	} else {
3539 		return false;
3540 	}
3541 }
3542 
3543 bool
3544 spdk_bdev_is_dif_check_enabled(const struct spdk_bdev *bdev,
3545 			       enum spdk_dif_check_type check_type)
3546 {
3547 	if (spdk_bdev_get_dif_type(bdev) == SPDK_DIF_DISABLE) {
3548 		return false;
3549 	}
3550 
3551 	switch (check_type) {
3552 	case SPDK_DIF_CHECK_TYPE_REFTAG:
3553 		return (bdev->dif_check_flags & SPDK_DIF_FLAGS_REFTAG_CHECK) != 0;
3554 	case SPDK_DIF_CHECK_TYPE_APPTAG:
3555 		return (bdev->dif_check_flags & SPDK_DIF_FLAGS_APPTAG_CHECK) != 0;
3556 	case SPDK_DIF_CHECK_TYPE_GUARD:
3557 		return (bdev->dif_check_flags & SPDK_DIF_FLAGS_GUARD_CHECK) != 0;
3558 	default:
3559 		return false;
3560 	}
3561 }
3562 
3563 uint64_t
3564 spdk_bdev_get_qd(const struct spdk_bdev *bdev)
3565 {
3566 	return bdev->internal.measured_queue_depth;
3567 }
3568 
3569 uint64_t
3570 spdk_bdev_get_qd_sampling_period(const struct spdk_bdev *bdev)
3571 {
3572 	return bdev->internal.period;
3573 }
3574 
3575 uint64_t
3576 spdk_bdev_get_weighted_io_time(const struct spdk_bdev *bdev)
3577 {
3578 	return bdev->internal.weighted_io_time;
3579 }
3580 
3581 uint64_t
3582 spdk_bdev_get_io_time(const struct spdk_bdev *bdev)
3583 {
3584 	return bdev->internal.io_time;
3585 }
3586 
3587 static void
3588 _calculate_measured_qd_cpl(struct spdk_io_channel_iter *i, int status)
3589 {
3590 	struct spdk_bdev *bdev = spdk_io_channel_iter_get_ctx(i);
3591 
3592 	bdev->internal.measured_queue_depth = bdev->internal.temporary_queue_depth;
3593 
3594 	if (bdev->internal.measured_queue_depth) {
3595 		bdev->internal.io_time += bdev->internal.period;
3596 		bdev->internal.weighted_io_time += bdev->internal.period * bdev->internal.measured_queue_depth;
3597 	}
3598 }
3599 
3600 static void
3601 _calculate_measured_qd(struct spdk_io_channel_iter *i)
3602 {
3603 	struct spdk_bdev *bdev = spdk_io_channel_iter_get_ctx(i);
3604 	struct spdk_io_channel *io_ch = spdk_io_channel_iter_get_channel(i);
3605 	struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(io_ch);
3606 
3607 	bdev->internal.temporary_queue_depth += ch->io_outstanding;
3608 	spdk_for_each_channel_continue(i, 0);
3609 }
3610 
3611 static int
3612 bdev_calculate_measured_queue_depth(void *ctx)
3613 {
3614 	struct spdk_bdev *bdev = ctx;
3615 	bdev->internal.temporary_queue_depth = 0;
3616 	spdk_for_each_channel(__bdev_to_io_dev(bdev), _calculate_measured_qd, bdev,
3617 			      _calculate_measured_qd_cpl);
3618 	return SPDK_POLLER_BUSY;
3619 }
3620 
3621 void
3622 spdk_bdev_set_qd_sampling_period(struct spdk_bdev *bdev, uint64_t period)
3623 {
3624 	bdev->internal.period = period;
3625 
3626 	if (bdev->internal.qd_poller != NULL) {
3627 		spdk_poller_unregister(&bdev->internal.qd_poller);
3628 		bdev->internal.measured_queue_depth = UINT64_MAX;
3629 	}
3630 
3631 	if (period != 0) {
3632 		bdev->internal.qd_poller = SPDK_POLLER_REGISTER(bdev_calculate_measured_queue_depth, bdev,
3633 					   period);
3634 	}
3635 }
3636 
3637 static void
3638 _resize_notify(void *arg)
3639 {
3640 	struct spdk_bdev_desc *desc = arg;
3641 
3642 	pthread_mutex_lock(&desc->mutex);
3643 	desc->refs--;
3644 	if (!desc->closed) {
3645 		pthread_mutex_unlock(&desc->mutex);
3646 		desc->callback.event_fn(SPDK_BDEV_EVENT_RESIZE,
3647 					desc->bdev,
3648 					desc->callback.ctx);
3649 		return;
3650 	} else if (0 == desc->refs) {
3651 		/* This descriptor was closed after this resize_notify message was sent.
3652 		 * spdk_bdev_close() could not free the descriptor since this message was
3653 		 * in flight, so we free it now using bdev_desc_free().
3654 		 */
3655 		pthread_mutex_unlock(&desc->mutex);
3656 		bdev_desc_free(desc);
3657 		return;
3658 	}
3659 	pthread_mutex_unlock(&desc->mutex);
3660 }
3661 
3662 int
3663 spdk_bdev_notify_blockcnt_change(struct spdk_bdev *bdev, uint64_t size)
3664 {
3665 	struct spdk_bdev_desc *desc;
3666 	int ret;
3667 
3668 	if (size == bdev->blockcnt) {
3669 		return 0;
3670 	}
3671 
3672 	pthread_mutex_lock(&bdev->internal.mutex);
3673 
3674 	/* bdev has open descriptors */
3675 	if (!TAILQ_EMPTY(&bdev->internal.open_descs) &&
3676 	    bdev->blockcnt > size) {
3677 		ret = -EBUSY;
3678 	} else {
3679 		bdev->blockcnt = size;
3680 		TAILQ_FOREACH(desc, &bdev->internal.open_descs, link) {
3681 			pthread_mutex_lock(&desc->mutex);
3682 			if (!desc->closed) {
3683 				desc->refs++;
3684 				spdk_thread_send_msg(desc->thread, _resize_notify, desc);
3685 			}
3686 			pthread_mutex_unlock(&desc->mutex);
3687 		}
3688 		ret = 0;
3689 	}
3690 
3691 	pthread_mutex_unlock(&bdev->internal.mutex);
3692 
3693 	return ret;
3694 }
3695 
3696 /*
3697  * Convert I/O offset and length from bytes to blocks.
3698  *
3699  * Returns zero on success or non-zero if the byte parameters aren't divisible by the block size.
3700  */
3701 static uint64_t
3702 bdev_bytes_to_blocks(struct spdk_bdev *bdev, uint64_t offset_bytes, uint64_t *offset_blocks,
3703 		     uint64_t num_bytes, uint64_t *num_blocks)
3704 {
3705 	uint32_t block_size = bdev->blocklen;
3706 	uint8_t shift_cnt;
3707 
3708 	/* Avoid expensive div operations if possible. These spdk_u32 functions are very cheap. */
3709 	if (spdk_likely(spdk_u32_is_pow2(block_size))) {
3710 		shift_cnt = spdk_u32log2(block_size);
3711 		*offset_blocks = offset_bytes >> shift_cnt;
3712 		*num_blocks = num_bytes >> shift_cnt;
3713 		return (offset_bytes - (*offset_blocks << shift_cnt)) |
3714 		       (num_bytes - (*num_blocks << shift_cnt));
3715 	} else {
3716 		*offset_blocks = offset_bytes / block_size;
3717 		*num_blocks = num_bytes / block_size;
3718 		return (offset_bytes % block_size) | (num_bytes % block_size);
3719 	}
3720 }
3721 
3722 static bool
3723 bdev_io_valid_blocks(struct spdk_bdev *bdev, uint64_t offset_blocks, uint64_t num_blocks)
3724 {
3725 	/* Return failure if offset_blocks + num_blocks is less than offset_blocks; indicates there
3726 	 * has been an overflow and hence the offset has been wrapped around */
3727 	if (offset_blocks + num_blocks < offset_blocks) {
3728 		return false;
3729 	}
3730 
3731 	/* Return failure if offset_blocks + num_blocks exceeds the size of the bdev */
3732 	if (offset_blocks + num_blocks > bdev->blockcnt) {
3733 		return false;
3734 	}
3735 
3736 	return true;
3737 }
3738 
3739 static bool
3740 _bdev_io_check_md_buf(const struct iovec *iovs, const void *md_buf)
3741 {
3742 	return _is_buf_allocated(iovs) == (md_buf != NULL);
3743 }
3744 
3745 static int
3746 bdev_read_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, void *buf,
3747 			 void *md_buf, uint64_t offset_blocks, uint64_t num_blocks,
3748 			 spdk_bdev_io_completion_cb cb, void *cb_arg)
3749 {
3750 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
3751 	struct spdk_bdev_io *bdev_io;
3752 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
3753 
3754 	if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) {
3755 		return -EINVAL;
3756 	}
3757 
3758 	bdev_io = bdev_channel_get_io(channel);
3759 	if (!bdev_io) {
3760 		return -ENOMEM;
3761 	}
3762 
3763 	bdev_io->internal.ch = channel;
3764 	bdev_io->internal.desc = desc;
3765 	bdev_io->type = SPDK_BDEV_IO_TYPE_READ;
3766 	bdev_io->u.bdev.iovs = &bdev_io->iov;
3767 	bdev_io->u.bdev.iovs[0].iov_base = buf;
3768 	bdev_io->u.bdev.iovs[0].iov_len = num_blocks * bdev->blocklen;
3769 	bdev_io->u.bdev.iovcnt = 1;
3770 	bdev_io->u.bdev.md_buf = md_buf;
3771 	bdev_io->u.bdev.num_blocks = num_blocks;
3772 	bdev_io->u.bdev.offset_blocks = offset_blocks;
3773 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
3774 
3775 	bdev_io_submit(bdev_io);
3776 	return 0;
3777 }
3778 
3779 int
3780 spdk_bdev_read(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
3781 	       void *buf, uint64_t offset, uint64_t nbytes,
3782 	       spdk_bdev_io_completion_cb cb, void *cb_arg)
3783 {
3784 	uint64_t offset_blocks, num_blocks;
3785 
3786 	if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks,
3787 				 nbytes, &num_blocks) != 0) {
3788 		return -EINVAL;
3789 	}
3790 
3791 	return spdk_bdev_read_blocks(desc, ch, buf, offset_blocks, num_blocks, cb, cb_arg);
3792 }
3793 
3794 int
3795 spdk_bdev_read_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
3796 		      void *buf, uint64_t offset_blocks, uint64_t num_blocks,
3797 		      spdk_bdev_io_completion_cb cb, void *cb_arg)
3798 {
3799 	return bdev_read_blocks_with_md(desc, ch, buf, NULL, offset_blocks, num_blocks, cb, cb_arg);
3800 }
3801 
3802 int
3803 spdk_bdev_read_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
3804 			      void *buf, void *md_buf, uint64_t offset_blocks, uint64_t num_blocks,
3805 			      spdk_bdev_io_completion_cb cb, void *cb_arg)
3806 {
3807 	struct iovec iov = {
3808 		.iov_base = buf,
3809 	};
3810 
3811 	if (!spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) {
3812 		return -EINVAL;
3813 	}
3814 
3815 	if (!_bdev_io_check_md_buf(&iov, md_buf)) {
3816 		return -EINVAL;
3817 	}
3818 
3819 	return bdev_read_blocks_with_md(desc, ch, buf, md_buf, offset_blocks, num_blocks,
3820 					cb, cb_arg);
3821 }
3822 
3823 int
3824 spdk_bdev_readv(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
3825 		struct iovec *iov, int iovcnt,
3826 		uint64_t offset, uint64_t nbytes,
3827 		spdk_bdev_io_completion_cb cb, void *cb_arg)
3828 {
3829 	uint64_t offset_blocks, num_blocks;
3830 
3831 	if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks,
3832 				 nbytes, &num_blocks) != 0) {
3833 		return -EINVAL;
3834 	}
3835 
3836 	return spdk_bdev_readv_blocks(desc, ch, iov, iovcnt, offset_blocks, num_blocks, cb, cb_arg);
3837 }
3838 
3839 static int
3840 bdev_readv_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
3841 			  struct iovec *iov, int iovcnt, void *md_buf, uint64_t offset_blocks,
3842 			  uint64_t num_blocks, spdk_bdev_io_completion_cb cb, void *cb_arg,
3843 			  struct spdk_bdev_ext_io_opts *opts)
3844 {
3845 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
3846 	struct spdk_bdev_io *bdev_io;
3847 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
3848 
3849 	if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) {
3850 		return -EINVAL;
3851 	}
3852 
3853 	bdev_io = bdev_channel_get_io(channel);
3854 	if (!bdev_io) {
3855 		return -ENOMEM;
3856 	}
3857 
3858 	bdev_io->internal.ch = channel;
3859 	bdev_io->internal.desc = desc;
3860 	bdev_io->type = SPDK_BDEV_IO_TYPE_READ;
3861 	bdev_io->u.bdev.iovs = iov;
3862 	bdev_io->u.bdev.iovcnt = iovcnt;
3863 	bdev_io->u.bdev.md_buf = md_buf;
3864 	bdev_io->u.bdev.num_blocks = num_blocks;
3865 	bdev_io->u.bdev.offset_blocks = offset_blocks;
3866 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
3867 	bdev_io->internal.ext_opts = opts;
3868 
3869 	bdev_io_submit(bdev_io);
3870 	return 0;
3871 }
3872 
3873 int spdk_bdev_readv_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
3874 			   struct iovec *iov, int iovcnt,
3875 			   uint64_t offset_blocks, uint64_t num_blocks,
3876 			   spdk_bdev_io_completion_cb cb, void *cb_arg)
3877 {
3878 	return bdev_readv_blocks_with_md(desc, ch, iov, iovcnt, NULL, offset_blocks,
3879 					 num_blocks, cb, cb_arg, NULL);
3880 }
3881 
3882 int
3883 spdk_bdev_readv_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
3884 			       struct iovec *iov, int iovcnt, void *md_buf,
3885 			       uint64_t offset_blocks, uint64_t num_blocks,
3886 			       spdk_bdev_io_completion_cb cb, void *cb_arg)
3887 {
3888 	if (!spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) {
3889 		return -EINVAL;
3890 	}
3891 
3892 	if (!_bdev_io_check_md_buf(iov, md_buf)) {
3893 		return -EINVAL;
3894 	}
3895 
3896 	return bdev_readv_blocks_with_md(desc, ch, iov, iovcnt, md_buf, offset_blocks,
3897 					 num_blocks, cb, cb_arg, NULL);
3898 }
3899 
3900 int
3901 spdk_bdev_readv_blocks_ext(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
3902 			   struct iovec *iov, int iovcnt,
3903 			   uint64_t offset_blocks, uint64_t num_blocks,
3904 			   spdk_bdev_io_completion_cb cb, void *cb_arg,
3905 			   struct spdk_bdev_ext_io_opts *opts)
3906 {
3907 	void *md = NULL;
3908 
3909 	if (opts) {
3910 		md = opts->metadata;
3911 	}
3912 
3913 	if (md && !spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) {
3914 		return -EINVAL;
3915 	}
3916 
3917 	if (md && !_bdev_io_check_md_buf(iov, md)) {
3918 		return -EINVAL;
3919 	}
3920 
3921 	return bdev_readv_blocks_with_md(desc, ch, iov, iovcnt, md, offset_blocks,
3922 					 num_blocks, cb, cb_arg, opts);
3923 }
3924 
3925 static int
3926 bdev_write_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
3927 			  void *buf, void *md_buf, uint64_t offset_blocks, uint64_t num_blocks,
3928 			  spdk_bdev_io_completion_cb cb, void *cb_arg)
3929 {
3930 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
3931 	struct spdk_bdev_io *bdev_io;
3932 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
3933 
3934 	if (!desc->write) {
3935 		return -EBADF;
3936 	}
3937 
3938 	if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) {
3939 		return -EINVAL;
3940 	}
3941 
3942 	bdev_io = bdev_channel_get_io(channel);
3943 	if (!bdev_io) {
3944 		return -ENOMEM;
3945 	}
3946 
3947 	bdev_io->internal.ch = channel;
3948 	bdev_io->internal.desc = desc;
3949 	bdev_io->type = SPDK_BDEV_IO_TYPE_WRITE;
3950 	bdev_io->u.bdev.iovs = &bdev_io->iov;
3951 	bdev_io->u.bdev.iovs[0].iov_base = buf;
3952 	bdev_io->u.bdev.iovs[0].iov_len = num_blocks * bdev->blocklen;
3953 	bdev_io->u.bdev.iovcnt = 1;
3954 	bdev_io->u.bdev.md_buf = md_buf;
3955 	bdev_io->u.bdev.num_blocks = num_blocks;
3956 	bdev_io->u.bdev.offset_blocks = offset_blocks;
3957 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
3958 
3959 	bdev_io_submit(bdev_io);
3960 	return 0;
3961 }
3962 
3963 int
3964 spdk_bdev_write(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
3965 		void *buf, uint64_t offset, uint64_t nbytes,
3966 		spdk_bdev_io_completion_cb cb, void *cb_arg)
3967 {
3968 	uint64_t offset_blocks, num_blocks;
3969 
3970 	if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks,
3971 				 nbytes, &num_blocks) != 0) {
3972 		return -EINVAL;
3973 	}
3974 
3975 	return spdk_bdev_write_blocks(desc, ch, buf, offset_blocks, num_blocks, cb, cb_arg);
3976 }
3977 
3978 int
3979 spdk_bdev_write_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
3980 		       void *buf, uint64_t offset_blocks, uint64_t num_blocks,
3981 		       spdk_bdev_io_completion_cb cb, void *cb_arg)
3982 {
3983 	return bdev_write_blocks_with_md(desc, ch, buf, NULL, offset_blocks, num_blocks,
3984 					 cb, cb_arg);
3985 }
3986 
3987 int
3988 spdk_bdev_write_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
3989 			       void *buf, void *md_buf, uint64_t offset_blocks, uint64_t num_blocks,
3990 			       spdk_bdev_io_completion_cb cb, void *cb_arg)
3991 {
3992 	struct iovec iov = {
3993 		.iov_base = buf,
3994 	};
3995 
3996 	if (!spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) {
3997 		return -EINVAL;
3998 	}
3999 
4000 	if (!_bdev_io_check_md_buf(&iov, md_buf)) {
4001 		return -EINVAL;
4002 	}
4003 
4004 	return bdev_write_blocks_with_md(desc, ch, buf, md_buf, offset_blocks, num_blocks,
4005 					 cb, cb_arg);
4006 }
4007 
4008 static int
4009 bdev_writev_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4010 			   struct iovec *iov, int iovcnt, void *md_buf,
4011 			   uint64_t offset_blocks, uint64_t num_blocks,
4012 			   spdk_bdev_io_completion_cb cb, void *cb_arg,
4013 			   struct spdk_bdev_ext_io_opts *opts)
4014 {
4015 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
4016 	struct spdk_bdev_io *bdev_io;
4017 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4018 
4019 	if (!desc->write) {
4020 		return -EBADF;
4021 	}
4022 
4023 	if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) {
4024 		return -EINVAL;
4025 	}
4026 
4027 	bdev_io = bdev_channel_get_io(channel);
4028 	if (!bdev_io) {
4029 		return -ENOMEM;
4030 	}
4031 
4032 	bdev_io->internal.ch = channel;
4033 	bdev_io->internal.desc = desc;
4034 	bdev_io->type = SPDK_BDEV_IO_TYPE_WRITE;
4035 	bdev_io->u.bdev.iovs = iov;
4036 	bdev_io->u.bdev.iovcnt = iovcnt;
4037 	bdev_io->u.bdev.md_buf = md_buf;
4038 	bdev_io->u.bdev.num_blocks = num_blocks;
4039 	bdev_io->u.bdev.offset_blocks = offset_blocks;
4040 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
4041 	bdev_io->internal.ext_opts = opts;
4042 
4043 	bdev_io_submit(bdev_io);
4044 	return 0;
4045 }
4046 
4047 int
4048 spdk_bdev_writev(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4049 		 struct iovec *iov, int iovcnt,
4050 		 uint64_t offset, uint64_t len,
4051 		 spdk_bdev_io_completion_cb cb, void *cb_arg)
4052 {
4053 	uint64_t offset_blocks, num_blocks;
4054 
4055 	if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks,
4056 				 len, &num_blocks) != 0) {
4057 		return -EINVAL;
4058 	}
4059 
4060 	return spdk_bdev_writev_blocks(desc, ch, iov, iovcnt, offset_blocks, num_blocks, cb, cb_arg);
4061 }
4062 
4063 int
4064 spdk_bdev_writev_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4065 			struct iovec *iov, int iovcnt,
4066 			uint64_t offset_blocks, uint64_t num_blocks,
4067 			spdk_bdev_io_completion_cb cb, void *cb_arg)
4068 {
4069 	return bdev_writev_blocks_with_md(desc, ch, iov, iovcnt, NULL, offset_blocks,
4070 					  num_blocks, cb, cb_arg, NULL);
4071 }
4072 
4073 int
4074 spdk_bdev_writev_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4075 				struct iovec *iov, int iovcnt, void *md_buf,
4076 				uint64_t offset_blocks, uint64_t num_blocks,
4077 				spdk_bdev_io_completion_cb cb, void *cb_arg)
4078 {
4079 	if (!spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) {
4080 		return -EINVAL;
4081 	}
4082 
4083 	if (!_bdev_io_check_md_buf(iov, md_buf)) {
4084 		return -EINVAL;
4085 	}
4086 
4087 	return bdev_writev_blocks_with_md(desc, ch, iov, iovcnt, md_buf, offset_blocks,
4088 					  num_blocks, cb, cb_arg, NULL);
4089 }
4090 
4091 int
4092 spdk_bdev_writev_blocks_ext(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4093 			    struct iovec *iov, int iovcnt,
4094 			    uint64_t offset_blocks, uint64_t num_blocks,
4095 			    spdk_bdev_io_completion_cb cb, void *cb_arg,
4096 			    struct spdk_bdev_ext_io_opts *opts)
4097 {
4098 	void *md = NULL;
4099 
4100 	if (opts) {
4101 		md = opts->metadata;
4102 	}
4103 
4104 	if (md && !spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) {
4105 		return -EINVAL;
4106 	}
4107 
4108 	if (md && !_bdev_io_check_md_buf(iov, md)) {
4109 		return -EINVAL;
4110 	}
4111 
4112 	return bdev_writev_blocks_with_md(desc, ch, iov, iovcnt, md, offset_blocks,
4113 					  num_blocks, cb, cb_arg, opts);
4114 }
4115 
4116 static void
4117 bdev_compare_do_read_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
4118 {
4119 	struct spdk_bdev_io *parent_io = cb_arg;
4120 	uint8_t *read_buf = bdev_io->u.bdev.iovs[0].iov_base;
4121 	int i, rc = 0;
4122 
4123 	if (!success) {
4124 		parent_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED;
4125 		parent_io->internal.cb(parent_io, false, parent_io->internal.caller_ctx);
4126 		spdk_bdev_free_io(bdev_io);
4127 		return;
4128 	}
4129 
4130 	for (i = 0; i < parent_io->u.bdev.iovcnt; i++) {
4131 		rc = memcmp(read_buf,
4132 			    parent_io->u.bdev.iovs[i].iov_base,
4133 			    parent_io->u.bdev.iovs[i].iov_len);
4134 		if (rc) {
4135 			break;
4136 		}
4137 		read_buf += parent_io->u.bdev.iovs[i].iov_len;
4138 	}
4139 
4140 	spdk_bdev_free_io(bdev_io);
4141 
4142 	if (rc == 0) {
4143 		parent_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS;
4144 		parent_io->internal.cb(parent_io, true, parent_io->internal.caller_ctx);
4145 	} else {
4146 		parent_io->internal.status = SPDK_BDEV_IO_STATUS_MISCOMPARE;
4147 		parent_io->internal.cb(parent_io, false, parent_io->internal.caller_ctx);
4148 	}
4149 }
4150 
4151 static void
4152 bdev_compare_do_read(void *_bdev_io)
4153 {
4154 	struct spdk_bdev_io *bdev_io = _bdev_io;
4155 	int rc;
4156 
4157 	rc = spdk_bdev_read_blocks(bdev_io->internal.desc,
4158 				   spdk_io_channel_from_ctx(bdev_io->internal.ch), NULL,
4159 				   bdev_io->u.bdev.offset_blocks, bdev_io->u.bdev.num_blocks,
4160 				   bdev_compare_do_read_done, bdev_io);
4161 
4162 	if (rc == -ENOMEM) {
4163 		bdev_queue_io_wait_with_cb(bdev_io, bdev_compare_do_read);
4164 	} else if (rc != 0) {
4165 		bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED;
4166 		bdev_io->internal.cb(bdev_io, false, bdev_io->internal.caller_ctx);
4167 	}
4168 }
4169 
4170 static int
4171 bdev_comparev_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4172 			     struct iovec *iov, int iovcnt, void *md_buf,
4173 			     uint64_t offset_blocks, uint64_t num_blocks,
4174 			     spdk_bdev_io_completion_cb cb, void *cb_arg)
4175 {
4176 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
4177 	struct spdk_bdev_io *bdev_io;
4178 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4179 
4180 	if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) {
4181 		return -EINVAL;
4182 	}
4183 
4184 	bdev_io = bdev_channel_get_io(channel);
4185 	if (!bdev_io) {
4186 		return -ENOMEM;
4187 	}
4188 
4189 	bdev_io->internal.ch = channel;
4190 	bdev_io->internal.desc = desc;
4191 	bdev_io->type = SPDK_BDEV_IO_TYPE_COMPARE;
4192 	bdev_io->u.bdev.iovs = iov;
4193 	bdev_io->u.bdev.iovcnt = iovcnt;
4194 	bdev_io->u.bdev.md_buf = md_buf;
4195 	bdev_io->u.bdev.num_blocks = num_blocks;
4196 	bdev_io->u.bdev.offset_blocks = offset_blocks;
4197 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
4198 
4199 	if (bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_COMPARE)) {
4200 		bdev_io_submit(bdev_io);
4201 		return 0;
4202 	}
4203 
4204 	bdev_compare_do_read(bdev_io);
4205 
4206 	return 0;
4207 }
4208 
4209 int
4210 spdk_bdev_comparev_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4211 			  struct iovec *iov, int iovcnt,
4212 			  uint64_t offset_blocks, uint64_t num_blocks,
4213 			  spdk_bdev_io_completion_cb cb, void *cb_arg)
4214 {
4215 	return bdev_comparev_blocks_with_md(desc, ch, iov, iovcnt, NULL, offset_blocks,
4216 					    num_blocks, cb, cb_arg);
4217 }
4218 
4219 int
4220 spdk_bdev_comparev_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4221 				  struct iovec *iov, int iovcnt, void *md_buf,
4222 				  uint64_t offset_blocks, uint64_t num_blocks,
4223 				  spdk_bdev_io_completion_cb cb, void *cb_arg)
4224 {
4225 	if (!spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) {
4226 		return -EINVAL;
4227 	}
4228 
4229 	if (!_bdev_io_check_md_buf(iov, md_buf)) {
4230 		return -EINVAL;
4231 	}
4232 
4233 	return bdev_comparev_blocks_with_md(desc, ch, iov, iovcnt, md_buf, offset_blocks,
4234 					    num_blocks, cb, cb_arg);
4235 }
4236 
4237 static int
4238 bdev_compare_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4239 			    void *buf, void *md_buf, uint64_t offset_blocks, uint64_t num_blocks,
4240 			    spdk_bdev_io_completion_cb cb, void *cb_arg)
4241 {
4242 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
4243 	struct spdk_bdev_io *bdev_io;
4244 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4245 
4246 	if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) {
4247 		return -EINVAL;
4248 	}
4249 
4250 	bdev_io = bdev_channel_get_io(channel);
4251 	if (!bdev_io) {
4252 		return -ENOMEM;
4253 	}
4254 
4255 	bdev_io->internal.ch = channel;
4256 	bdev_io->internal.desc = desc;
4257 	bdev_io->type = SPDK_BDEV_IO_TYPE_COMPARE;
4258 	bdev_io->u.bdev.iovs = &bdev_io->iov;
4259 	bdev_io->u.bdev.iovs[0].iov_base = buf;
4260 	bdev_io->u.bdev.iovs[0].iov_len = num_blocks * bdev->blocklen;
4261 	bdev_io->u.bdev.iovcnt = 1;
4262 	bdev_io->u.bdev.md_buf = md_buf;
4263 	bdev_io->u.bdev.num_blocks = num_blocks;
4264 	bdev_io->u.bdev.offset_blocks = offset_blocks;
4265 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
4266 
4267 	if (bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_COMPARE)) {
4268 		bdev_io_submit(bdev_io);
4269 		return 0;
4270 	}
4271 
4272 	bdev_compare_do_read(bdev_io);
4273 
4274 	return 0;
4275 }
4276 
4277 int
4278 spdk_bdev_compare_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4279 			 void *buf, uint64_t offset_blocks, uint64_t num_blocks,
4280 			 spdk_bdev_io_completion_cb cb, void *cb_arg)
4281 {
4282 	return bdev_compare_blocks_with_md(desc, ch, buf, NULL, offset_blocks, num_blocks,
4283 					   cb, cb_arg);
4284 }
4285 
4286 int
4287 spdk_bdev_compare_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4288 				 void *buf, void *md_buf, uint64_t offset_blocks, uint64_t num_blocks,
4289 				 spdk_bdev_io_completion_cb cb, void *cb_arg)
4290 {
4291 	struct iovec iov = {
4292 		.iov_base = buf,
4293 	};
4294 
4295 	if (!spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) {
4296 		return -EINVAL;
4297 	}
4298 
4299 	if (!_bdev_io_check_md_buf(&iov, md_buf)) {
4300 		return -EINVAL;
4301 	}
4302 
4303 	return bdev_compare_blocks_with_md(desc, ch, buf, md_buf, offset_blocks, num_blocks,
4304 					   cb, cb_arg);
4305 }
4306 
4307 static void
4308 bdev_comparev_and_writev_blocks_unlocked(void *ctx, int unlock_status)
4309 {
4310 	struct spdk_bdev_io *bdev_io = ctx;
4311 
4312 	if (unlock_status) {
4313 		SPDK_ERRLOG("LBA range unlock failed\n");
4314 	}
4315 
4316 	bdev_io->internal.cb(bdev_io, bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS ? true :
4317 			     false, bdev_io->internal.caller_ctx);
4318 }
4319 
4320 static void
4321 bdev_comparev_and_writev_blocks_unlock(struct spdk_bdev_io *bdev_io, int status)
4322 {
4323 	bdev_io->internal.status = status;
4324 
4325 	bdev_unlock_lba_range(bdev_io->internal.desc, spdk_io_channel_from_ctx(bdev_io->internal.ch),
4326 			      bdev_io->u.bdev.offset_blocks, bdev_io->u.bdev.num_blocks,
4327 			      bdev_comparev_and_writev_blocks_unlocked, bdev_io);
4328 }
4329 
4330 static void
4331 bdev_compare_and_write_do_write_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
4332 {
4333 	struct spdk_bdev_io *parent_io = cb_arg;
4334 
4335 	if (!success) {
4336 		SPDK_ERRLOG("Compare and write operation failed\n");
4337 	}
4338 
4339 	spdk_bdev_free_io(bdev_io);
4340 
4341 	bdev_comparev_and_writev_blocks_unlock(parent_io,
4342 					       success ? SPDK_BDEV_IO_STATUS_SUCCESS : SPDK_BDEV_IO_STATUS_FAILED);
4343 }
4344 
4345 static void
4346 bdev_compare_and_write_do_write(void *_bdev_io)
4347 {
4348 	struct spdk_bdev_io *bdev_io = _bdev_io;
4349 	int rc;
4350 
4351 	rc = spdk_bdev_writev_blocks(bdev_io->internal.desc,
4352 				     spdk_io_channel_from_ctx(bdev_io->internal.ch),
4353 				     bdev_io->u.bdev.fused_iovs, bdev_io->u.bdev.fused_iovcnt,
4354 				     bdev_io->u.bdev.offset_blocks, bdev_io->u.bdev.num_blocks,
4355 				     bdev_compare_and_write_do_write_done, bdev_io);
4356 
4357 
4358 	if (rc == -ENOMEM) {
4359 		bdev_queue_io_wait_with_cb(bdev_io, bdev_compare_and_write_do_write);
4360 	} else if (rc != 0) {
4361 		bdev_comparev_and_writev_blocks_unlock(bdev_io, SPDK_BDEV_IO_STATUS_FAILED);
4362 	}
4363 }
4364 
4365 static void
4366 bdev_compare_and_write_do_compare_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
4367 {
4368 	struct spdk_bdev_io *parent_io = cb_arg;
4369 
4370 	spdk_bdev_free_io(bdev_io);
4371 
4372 	if (!success) {
4373 		bdev_comparev_and_writev_blocks_unlock(parent_io, SPDK_BDEV_IO_STATUS_MISCOMPARE);
4374 		return;
4375 	}
4376 
4377 	bdev_compare_and_write_do_write(parent_io);
4378 }
4379 
4380 static void
4381 bdev_compare_and_write_do_compare(void *_bdev_io)
4382 {
4383 	struct spdk_bdev_io *bdev_io = _bdev_io;
4384 	int rc;
4385 
4386 	rc = spdk_bdev_comparev_blocks(bdev_io->internal.desc,
4387 				       spdk_io_channel_from_ctx(bdev_io->internal.ch), bdev_io->u.bdev.iovs,
4388 				       bdev_io->u.bdev.iovcnt, bdev_io->u.bdev.offset_blocks, bdev_io->u.bdev.num_blocks,
4389 				       bdev_compare_and_write_do_compare_done, bdev_io);
4390 
4391 	if (rc == -ENOMEM) {
4392 		bdev_queue_io_wait_with_cb(bdev_io, bdev_compare_and_write_do_compare);
4393 	} else if (rc != 0) {
4394 		bdev_comparev_and_writev_blocks_unlock(bdev_io, SPDK_BDEV_IO_STATUS_FIRST_FUSED_FAILED);
4395 	}
4396 }
4397 
4398 static void
4399 bdev_comparev_and_writev_blocks_locked(void *ctx, int status)
4400 {
4401 	struct spdk_bdev_io *bdev_io = ctx;
4402 
4403 	if (status) {
4404 		bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FIRST_FUSED_FAILED;
4405 		bdev_io->internal.cb(bdev_io, false, bdev_io->internal.caller_ctx);
4406 		return;
4407 	}
4408 
4409 	bdev_compare_and_write_do_compare(bdev_io);
4410 }
4411 
4412 int
4413 spdk_bdev_comparev_and_writev_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4414 				     struct iovec *compare_iov, int compare_iovcnt,
4415 				     struct iovec *write_iov, int write_iovcnt,
4416 				     uint64_t offset_blocks, uint64_t num_blocks,
4417 				     spdk_bdev_io_completion_cb cb, void *cb_arg)
4418 {
4419 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
4420 	struct spdk_bdev_io *bdev_io;
4421 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4422 
4423 	if (!desc->write) {
4424 		return -EBADF;
4425 	}
4426 
4427 	if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) {
4428 		return -EINVAL;
4429 	}
4430 
4431 	if (num_blocks > bdev->acwu) {
4432 		return -EINVAL;
4433 	}
4434 
4435 	bdev_io = bdev_channel_get_io(channel);
4436 	if (!bdev_io) {
4437 		return -ENOMEM;
4438 	}
4439 
4440 	bdev_io->internal.ch = channel;
4441 	bdev_io->internal.desc = desc;
4442 	bdev_io->type = SPDK_BDEV_IO_TYPE_COMPARE_AND_WRITE;
4443 	bdev_io->u.bdev.iovs = compare_iov;
4444 	bdev_io->u.bdev.iovcnt = compare_iovcnt;
4445 	bdev_io->u.bdev.fused_iovs = write_iov;
4446 	bdev_io->u.bdev.fused_iovcnt = write_iovcnt;
4447 	bdev_io->u.bdev.md_buf = NULL;
4448 	bdev_io->u.bdev.num_blocks = num_blocks;
4449 	bdev_io->u.bdev.offset_blocks = offset_blocks;
4450 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
4451 
4452 	if (bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_COMPARE_AND_WRITE)) {
4453 		bdev_io_submit(bdev_io);
4454 		return 0;
4455 	}
4456 
4457 	return bdev_lock_lba_range(desc, ch, offset_blocks, num_blocks,
4458 				   bdev_comparev_and_writev_blocks_locked, bdev_io);
4459 }
4460 
4461 int
4462 spdk_bdev_zcopy_start(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4463 		      struct iovec *iov, int iovcnt,
4464 		      uint64_t offset_blocks, uint64_t num_blocks,
4465 		      bool populate,
4466 		      spdk_bdev_io_completion_cb cb, void *cb_arg)
4467 {
4468 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
4469 	struct spdk_bdev_io *bdev_io;
4470 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4471 
4472 	if (!desc->write) {
4473 		return -EBADF;
4474 	}
4475 
4476 	if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) {
4477 		return -EINVAL;
4478 	}
4479 
4480 	if (!spdk_bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_ZCOPY)) {
4481 		return -ENOTSUP;
4482 	}
4483 
4484 	bdev_io = bdev_channel_get_io(channel);
4485 	if (!bdev_io) {
4486 		return -ENOMEM;
4487 	}
4488 
4489 	bdev_io->internal.ch = channel;
4490 	bdev_io->internal.desc = desc;
4491 	bdev_io->type = SPDK_BDEV_IO_TYPE_ZCOPY;
4492 	bdev_io->u.bdev.num_blocks = num_blocks;
4493 	bdev_io->u.bdev.offset_blocks = offset_blocks;
4494 	bdev_io->u.bdev.iovs = iov;
4495 	bdev_io->u.bdev.iovcnt = iovcnt;
4496 	bdev_io->u.bdev.md_buf = NULL;
4497 	bdev_io->u.bdev.zcopy.populate = populate ? 1 : 0;
4498 	bdev_io->u.bdev.zcopy.commit = 0;
4499 	bdev_io->u.bdev.zcopy.start = 1;
4500 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
4501 
4502 	bdev_io_submit(bdev_io);
4503 
4504 	return 0;
4505 }
4506 
4507 int
4508 spdk_bdev_zcopy_end(struct spdk_bdev_io *bdev_io, bool commit,
4509 		    spdk_bdev_io_completion_cb cb, void *cb_arg)
4510 {
4511 	if (bdev_io->type != SPDK_BDEV_IO_TYPE_ZCOPY) {
4512 		return -EINVAL;
4513 	}
4514 
4515 	bdev_io->u.bdev.zcopy.commit = commit ? 1 : 0;
4516 	bdev_io->u.bdev.zcopy.start = 0;
4517 	bdev_io->internal.caller_ctx = cb_arg;
4518 	bdev_io->internal.cb = cb;
4519 	bdev_io->internal.status = SPDK_BDEV_IO_STATUS_PENDING;
4520 
4521 	bdev_io_submit(bdev_io);
4522 
4523 	return 0;
4524 }
4525 
4526 int
4527 spdk_bdev_write_zeroes(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4528 		       uint64_t offset, uint64_t len,
4529 		       spdk_bdev_io_completion_cb cb, void *cb_arg)
4530 {
4531 	uint64_t offset_blocks, num_blocks;
4532 
4533 	if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks,
4534 				 len, &num_blocks) != 0) {
4535 		return -EINVAL;
4536 	}
4537 
4538 	return spdk_bdev_write_zeroes_blocks(desc, ch, offset_blocks, num_blocks, cb, cb_arg);
4539 }
4540 
4541 int
4542 spdk_bdev_write_zeroes_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4543 			      uint64_t offset_blocks, uint64_t num_blocks,
4544 			      spdk_bdev_io_completion_cb cb, void *cb_arg)
4545 {
4546 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
4547 	struct spdk_bdev_io *bdev_io;
4548 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4549 
4550 	if (!desc->write) {
4551 		return -EBADF;
4552 	}
4553 
4554 	if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) {
4555 		return -EINVAL;
4556 	}
4557 
4558 	if (!bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_WRITE_ZEROES) &&
4559 	    !bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_WRITE)) {
4560 		return -ENOTSUP;
4561 	}
4562 
4563 	bdev_io = bdev_channel_get_io(channel);
4564 
4565 	if (!bdev_io) {
4566 		return -ENOMEM;
4567 	}
4568 
4569 	bdev_io->type = SPDK_BDEV_IO_TYPE_WRITE_ZEROES;
4570 	bdev_io->internal.ch = channel;
4571 	bdev_io->internal.desc = desc;
4572 	bdev_io->u.bdev.offset_blocks = offset_blocks;
4573 	bdev_io->u.bdev.num_blocks = num_blocks;
4574 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
4575 
4576 	if (bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_WRITE_ZEROES)) {
4577 		bdev_io_submit(bdev_io);
4578 		return 0;
4579 	}
4580 
4581 	assert(bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_WRITE));
4582 	assert(_bdev_get_block_size_with_md(bdev) <= ZERO_BUFFER_SIZE);
4583 	bdev_io->u.bdev.split_remaining_num_blocks = num_blocks;
4584 	bdev_io->u.bdev.split_current_offset_blocks = offset_blocks;
4585 	bdev_write_zero_buffer_next(bdev_io);
4586 
4587 	return 0;
4588 }
4589 
4590 int
4591 spdk_bdev_unmap(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4592 		uint64_t offset, uint64_t nbytes,
4593 		spdk_bdev_io_completion_cb cb, void *cb_arg)
4594 {
4595 	uint64_t offset_blocks, num_blocks;
4596 
4597 	if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks,
4598 				 nbytes, &num_blocks) != 0) {
4599 		return -EINVAL;
4600 	}
4601 
4602 	return spdk_bdev_unmap_blocks(desc, ch, offset_blocks, num_blocks, cb, cb_arg);
4603 }
4604 
4605 int
4606 spdk_bdev_unmap_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4607 		       uint64_t offset_blocks, uint64_t num_blocks,
4608 		       spdk_bdev_io_completion_cb cb, void *cb_arg)
4609 {
4610 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
4611 	struct spdk_bdev_io *bdev_io;
4612 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4613 
4614 	if (!desc->write) {
4615 		return -EBADF;
4616 	}
4617 
4618 	if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) {
4619 		return -EINVAL;
4620 	}
4621 
4622 	if (num_blocks == 0) {
4623 		SPDK_ERRLOG("Can't unmap 0 bytes\n");
4624 		return -EINVAL;
4625 	}
4626 
4627 	bdev_io = bdev_channel_get_io(channel);
4628 	if (!bdev_io) {
4629 		return -ENOMEM;
4630 	}
4631 
4632 	bdev_io->internal.ch = channel;
4633 	bdev_io->internal.desc = desc;
4634 	bdev_io->type = SPDK_BDEV_IO_TYPE_UNMAP;
4635 
4636 	bdev_io->u.bdev.iovs = &bdev_io->iov;
4637 	bdev_io->u.bdev.iovs[0].iov_base = NULL;
4638 	bdev_io->u.bdev.iovs[0].iov_len = 0;
4639 	bdev_io->u.bdev.iovcnt = 1;
4640 
4641 	bdev_io->u.bdev.offset_blocks = offset_blocks;
4642 	bdev_io->u.bdev.num_blocks = num_blocks;
4643 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
4644 
4645 	bdev_io_submit(bdev_io);
4646 	return 0;
4647 }
4648 
4649 int
4650 spdk_bdev_flush(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4651 		uint64_t offset, uint64_t length,
4652 		spdk_bdev_io_completion_cb cb, void *cb_arg)
4653 {
4654 	uint64_t offset_blocks, num_blocks;
4655 
4656 	if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks,
4657 				 length, &num_blocks) != 0) {
4658 		return -EINVAL;
4659 	}
4660 
4661 	return spdk_bdev_flush_blocks(desc, ch, offset_blocks, num_blocks, cb, cb_arg);
4662 }
4663 
4664 int
4665 spdk_bdev_flush_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4666 		       uint64_t offset_blocks, uint64_t num_blocks,
4667 		       spdk_bdev_io_completion_cb cb, void *cb_arg)
4668 {
4669 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
4670 	struct spdk_bdev_io *bdev_io;
4671 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4672 
4673 	if (!desc->write) {
4674 		return -EBADF;
4675 	}
4676 
4677 	if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) {
4678 		return -EINVAL;
4679 	}
4680 
4681 	bdev_io = bdev_channel_get_io(channel);
4682 	if (!bdev_io) {
4683 		return -ENOMEM;
4684 	}
4685 
4686 	bdev_io->internal.ch = channel;
4687 	bdev_io->internal.desc = desc;
4688 	bdev_io->type = SPDK_BDEV_IO_TYPE_FLUSH;
4689 	bdev_io->u.bdev.iovs = NULL;
4690 	bdev_io->u.bdev.iovcnt = 0;
4691 	bdev_io->u.bdev.offset_blocks = offset_blocks;
4692 	bdev_io->u.bdev.num_blocks = num_blocks;
4693 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
4694 
4695 	bdev_io_submit(bdev_io);
4696 	return 0;
4697 }
4698 
4699 static void
4700 bdev_reset_dev(struct spdk_io_channel_iter *i, int status)
4701 {
4702 	struct spdk_bdev_channel *ch = spdk_io_channel_iter_get_ctx(i);
4703 	struct spdk_bdev_io *bdev_io;
4704 
4705 	bdev_io = TAILQ_FIRST(&ch->queued_resets);
4706 	TAILQ_REMOVE(&ch->queued_resets, bdev_io, internal.link);
4707 	bdev_io_submit_reset(bdev_io);
4708 }
4709 
4710 static void
4711 bdev_reset_freeze_channel(struct spdk_io_channel_iter *i)
4712 {
4713 	struct spdk_io_channel		*ch;
4714 	struct spdk_bdev_channel	*channel;
4715 	struct spdk_bdev_mgmt_channel	*mgmt_channel;
4716 	struct spdk_bdev_shared_resource *shared_resource;
4717 	bdev_io_tailq_t			tmp_queued;
4718 
4719 	TAILQ_INIT(&tmp_queued);
4720 
4721 	ch = spdk_io_channel_iter_get_channel(i);
4722 	channel = spdk_io_channel_get_ctx(ch);
4723 	shared_resource = channel->shared_resource;
4724 	mgmt_channel = shared_resource->mgmt_ch;
4725 
4726 	channel->flags |= BDEV_CH_RESET_IN_PROGRESS;
4727 
4728 	if ((channel->flags & BDEV_CH_QOS_ENABLED) != 0) {
4729 		/* The QoS object is always valid and readable while
4730 		 * the channel flag is set, so the lock here should not
4731 		 * be necessary. We're not in the fast path though, so
4732 		 * just take it anyway. */
4733 		pthread_mutex_lock(&channel->bdev->internal.mutex);
4734 		if (channel->bdev->internal.qos->ch == channel) {
4735 			TAILQ_SWAP(&channel->bdev->internal.qos->queued, &tmp_queued, spdk_bdev_io, internal.link);
4736 		}
4737 		pthread_mutex_unlock(&channel->bdev->internal.mutex);
4738 	}
4739 
4740 	bdev_abort_all_queued_io(&shared_resource->nomem_io, channel);
4741 	bdev_abort_all_buf_io(&mgmt_channel->need_buf_small, channel);
4742 	bdev_abort_all_buf_io(&mgmt_channel->need_buf_large, channel);
4743 	bdev_abort_all_queued_io(&tmp_queued, channel);
4744 
4745 	spdk_for_each_channel_continue(i, 0);
4746 }
4747 
4748 static void
4749 bdev_start_reset(void *ctx)
4750 {
4751 	struct spdk_bdev_channel *ch = ctx;
4752 
4753 	spdk_for_each_channel(__bdev_to_io_dev(ch->bdev), bdev_reset_freeze_channel,
4754 			      ch, bdev_reset_dev);
4755 }
4756 
4757 static void
4758 bdev_channel_start_reset(struct spdk_bdev_channel *ch)
4759 {
4760 	struct spdk_bdev *bdev = ch->bdev;
4761 
4762 	assert(!TAILQ_EMPTY(&ch->queued_resets));
4763 
4764 	pthread_mutex_lock(&bdev->internal.mutex);
4765 	if (bdev->internal.reset_in_progress == NULL) {
4766 		bdev->internal.reset_in_progress = TAILQ_FIRST(&ch->queued_resets);
4767 		/*
4768 		 * Take a channel reference for the target bdev for the life of this
4769 		 *  reset.  This guards against the channel getting destroyed while
4770 		 *  spdk_for_each_channel() calls related to this reset IO are in
4771 		 *  progress.  We will release the reference when this reset is
4772 		 *  completed.
4773 		 */
4774 		bdev->internal.reset_in_progress->u.reset.ch_ref = spdk_get_io_channel(__bdev_to_io_dev(bdev));
4775 		bdev_start_reset(ch);
4776 	}
4777 	pthread_mutex_unlock(&bdev->internal.mutex);
4778 }
4779 
4780 int
4781 spdk_bdev_reset(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4782 		spdk_bdev_io_completion_cb cb, void *cb_arg)
4783 {
4784 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
4785 	struct spdk_bdev_io *bdev_io;
4786 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4787 
4788 	bdev_io = bdev_channel_get_io(channel);
4789 	if (!bdev_io) {
4790 		return -ENOMEM;
4791 	}
4792 
4793 	bdev_io->internal.ch = channel;
4794 	bdev_io->internal.desc = desc;
4795 	bdev_io->internal.submit_tsc = spdk_get_ticks();
4796 	bdev_io->type = SPDK_BDEV_IO_TYPE_RESET;
4797 	bdev_io->u.reset.ch_ref = NULL;
4798 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
4799 
4800 	pthread_mutex_lock(&bdev->internal.mutex);
4801 	TAILQ_INSERT_TAIL(&channel->queued_resets, bdev_io, internal.link);
4802 	pthread_mutex_unlock(&bdev->internal.mutex);
4803 
4804 	TAILQ_INSERT_TAIL(&bdev_io->internal.ch->io_submitted, bdev_io,
4805 			  internal.ch_link);
4806 
4807 	bdev_channel_start_reset(channel);
4808 
4809 	return 0;
4810 }
4811 
4812 void
4813 spdk_bdev_get_io_stat(struct spdk_bdev *bdev, struct spdk_io_channel *ch,
4814 		      struct spdk_bdev_io_stat *stat)
4815 {
4816 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4817 
4818 	*stat = channel->stat;
4819 }
4820 
4821 static void
4822 bdev_get_device_stat_done(struct spdk_io_channel_iter *i, int status)
4823 {
4824 	void *io_device = spdk_io_channel_iter_get_io_device(i);
4825 	struct spdk_bdev_iostat_ctx *bdev_iostat_ctx = spdk_io_channel_iter_get_ctx(i);
4826 
4827 	bdev_iostat_ctx->cb(__bdev_from_io_dev(io_device), bdev_iostat_ctx->stat,
4828 			    bdev_iostat_ctx->cb_arg, 0);
4829 	free(bdev_iostat_ctx);
4830 }
4831 
4832 static void
4833 bdev_get_each_channel_stat(struct spdk_io_channel_iter *i)
4834 {
4835 	struct spdk_bdev_iostat_ctx *bdev_iostat_ctx = spdk_io_channel_iter_get_ctx(i);
4836 	struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i);
4837 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4838 
4839 	bdev_io_stat_add(bdev_iostat_ctx->stat, &channel->stat);
4840 	spdk_for_each_channel_continue(i, 0);
4841 }
4842 
4843 void
4844 spdk_bdev_get_device_stat(struct spdk_bdev *bdev, struct spdk_bdev_io_stat *stat,
4845 			  spdk_bdev_get_device_stat_cb cb, void *cb_arg)
4846 {
4847 	struct spdk_bdev_iostat_ctx *bdev_iostat_ctx;
4848 
4849 	assert(bdev != NULL);
4850 	assert(stat != NULL);
4851 	assert(cb != NULL);
4852 
4853 	bdev_iostat_ctx = calloc(1, sizeof(struct spdk_bdev_iostat_ctx));
4854 	if (bdev_iostat_ctx == NULL) {
4855 		SPDK_ERRLOG("Unable to allocate memory for spdk_bdev_iostat_ctx\n");
4856 		cb(bdev, stat, cb_arg, -ENOMEM);
4857 		return;
4858 	}
4859 
4860 	bdev_iostat_ctx->stat = stat;
4861 	bdev_iostat_ctx->cb = cb;
4862 	bdev_iostat_ctx->cb_arg = cb_arg;
4863 
4864 	/* Start with the statistics from previously deleted channels. */
4865 	pthread_mutex_lock(&bdev->internal.mutex);
4866 	bdev_io_stat_add(bdev_iostat_ctx->stat, &bdev->internal.stat);
4867 	pthread_mutex_unlock(&bdev->internal.mutex);
4868 
4869 	/* Then iterate and add the statistics from each existing channel. */
4870 	spdk_for_each_channel(__bdev_to_io_dev(bdev),
4871 			      bdev_get_each_channel_stat,
4872 			      bdev_iostat_ctx,
4873 			      bdev_get_device_stat_done);
4874 }
4875 
4876 int
4877 spdk_bdev_nvme_admin_passthru(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4878 			      const struct spdk_nvme_cmd *cmd, void *buf, size_t nbytes,
4879 			      spdk_bdev_io_completion_cb cb, void *cb_arg)
4880 {
4881 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
4882 	struct spdk_bdev_io *bdev_io;
4883 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4884 
4885 	if (!desc->write) {
4886 		return -EBADF;
4887 	}
4888 
4889 	bdev_io = bdev_channel_get_io(channel);
4890 	if (!bdev_io) {
4891 		return -ENOMEM;
4892 	}
4893 
4894 	bdev_io->internal.ch = channel;
4895 	bdev_io->internal.desc = desc;
4896 	bdev_io->type = SPDK_BDEV_IO_TYPE_NVME_ADMIN;
4897 	bdev_io->u.nvme_passthru.cmd = *cmd;
4898 	bdev_io->u.nvme_passthru.buf = buf;
4899 	bdev_io->u.nvme_passthru.nbytes = nbytes;
4900 	bdev_io->u.nvme_passthru.md_buf = NULL;
4901 	bdev_io->u.nvme_passthru.md_len = 0;
4902 
4903 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
4904 
4905 	bdev_io_submit(bdev_io);
4906 	return 0;
4907 }
4908 
4909 int
4910 spdk_bdev_nvme_io_passthru(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4911 			   const struct spdk_nvme_cmd *cmd, void *buf, size_t nbytes,
4912 			   spdk_bdev_io_completion_cb cb, void *cb_arg)
4913 {
4914 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
4915 	struct spdk_bdev_io *bdev_io;
4916 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4917 
4918 	if (!desc->write) {
4919 		/*
4920 		 * Do not try to parse the NVMe command - we could maybe use bits in the opcode
4921 		 *  to easily determine if the command is a read or write, but for now just
4922 		 *  do not allow io_passthru with a read-only descriptor.
4923 		 */
4924 		return -EBADF;
4925 	}
4926 
4927 	bdev_io = bdev_channel_get_io(channel);
4928 	if (!bdev_io) {
4929 		return -ENOMEM;
4930 	}
4931 
4932 	bdev_io->internal.ch = channel;
4933 	bdev_io->internal.desc = desc;
4934 	bdev_io->type = SPDK_BDEV_IO_TYPE_NVME_IO;
4935 	bdev_io->u.nvme_passthru.cmd = *cmd;
4936 	bdev_io->u.nvme_passthru.buf = buf;
4937 	bdev_io->u.nvme_passthru.nbytes = nbytes;
4938 	bdev_io->u.nvme_passthru.md_buf = NULL;
4939 	bdev_io->u.nvme_passthru.md_len = 0;
4940 
4941 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
4942 
4943 	bdev_io_submit(bdev_io);
4944 	return 0;
4945 }
4946 
4947 int
4948 spdk_bdev_nvme_io_passthru_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
4949 			      const struct spdk_nvme_cmd *cmd, void *buf, size_t nbytes, void *md_buf, size_t md_len,
4950 			      spdk_bdev_io_completion_cb cb, void *cb_arg)
4951 {
4952 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
4953 	struct spdk_bdev_io *bdev_io;
4954 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
4955 
4956 	if (!desc->write) {
4957 		/*
4958 		 * Do not try to parse the NVMe command - we could maybe use bits in the opcode
4959 		 *  to easily determine if the command is a read or write, but for now just
4960 		 *  do not allow io_passthru with a read-only descriptor.
4961 		 */
4962 		return -EBADF;
4963 	}
4964 
4965 	bdev_io = bdev_channel_get_io(channel);
4966 	if (!bdev_io) {
4967 		return -ENOMEM;
4968 	}
4969 
4970 	bdev_io->internal.ch = channel;
4971 	bdev_io->internal.desc = desc;
4972 	bdev_io->type = SPDK_BDEV_IO_TYPE_NVME_IO_MD;
4973 	bdev_io->u.nvme_passthru.cmd = *cmd;
4974 	bdev_io->u.nvme_passthru.buf = buf;
4975 	bdev_io->u.nvme_passthru.nbytes = nbytes;
4976 	bdev_io->u.nvme_passthru.md_buf = md_buf;
4977 	bdev_io->u.nvme_passthru.md_len = md_len;
4978 
4979 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
4980 
4981 	bdev_io_submit(bdev_io);
4982 	return 0;
4983 }
4984 
4985 static void bdev_abort_retry(void *ctx);
4986 static void bdev_abort(struct spdk_bdev_io *parent_io);
4987 
4988 static void
4989 bdev_abort_io_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
4990 {
4991 	struct spdk_bdev_channel *channel = bdev_io->internal.ch;
4992 	struct spdk_bdev_io *parent_io = cb_arg;
4993 	struct spdk_bdev_io *bio_to_abort, *tmp_io;
4994 
4995 	bio_to_abort = bdev_io->u.abort.bio_to_abort;
4996 
4997 	spdk_bdev_free_io(bdev_io);
4998 
4999 	if (!success) {
5000 		/* Check if the target I/O completed in the meantime. */
5001 		TAILQ_FOREACH(tmp_io, &channel->io_submitted, internal.ch_link) {
5002 			if (tmp_io == bio_to_abort) {
5003 				break;
5004 			}
5005 		}
5006 
5007 		/* If the target I/O still exists, set the parent to failed. */
5008 		if (tmp_io != NULL) {
5009 			parent_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED;
5010 		}
5011 	}
5012 
5013 	parent_io->u.bdev.split_outstanding--;
5014 	if (parent_io->u.bdev.split_outstanding == 0) {
5015 		if (parent_io->internal.status == SPDK_BDEV_IO_STATUS_NOMEM) {
5016 			bdev_abort_retry(parent_io);
5017 		} else {
5018 			bdev_io_complete(parent_io);
5019 		}
5020 	}
5021 }
5022 
5023 static int
5024 bdev_abort_io(struct spdk_bdev_desc *desc, struct spdk_bdev_channel *channel,
5025 	      struct spdk_bdev_io *bio_to_abort,
5026 	      spdk_bdev_io_completion_cb cb, void *cb_arg)
5027 {
5028 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
5029 	struct spdk_bdev_io *bdev_io;
5030 
5031 	if (bio_to_abort->type == SPDK_BDEV_IO_TYPE_ABORT ||
5032 	    bio_to_abort->type == SPDK_BDEV_IO_TYPE_RESET) {
5033 		/* TODO: Abort reset or abort request. */
5034 		return -ENOTSUP;
5035 	}
5036 
5037 	bdev_io = bdev_channel_get_io(channel);
5038 	if (bdev_io == NULL) {
5039 		return -ENOMEM;
5040 	}
5041 
5042 	bdev_io->internal.ch = channel;
5043 	bdev_io->internal.desc = desc;
5044 	bdev_io->type = SPDK_BDEV_IO_TYPE_ABORT;
5045 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
5046 
5047 	if (bdev->split_on_optimal_io_boundary && bdev_io_should_split(bio_to_abort)) {
5048 		bdev_io->u.bdev.abort.bio_cb_arg = bio_to_abort;
5049 
5050 		/* Parent abort request is not submitted directly, but to manage its
5051 		 * execution add it to the submitted list here.
5052 		 */
5053 		bdev_io->internal.submit_tsc = spdk_get_ticks();
5054 		TAILQ_INSERT_TAIL(&channel->io_submitted, bdev_io, internal.ch_link);
5055 
5056 		bdev_abort(bdev_io);
5057 
5058 		return 0;
5059 	}
5060 
5061 	bdev_io->u.abort.bio_to_abort = bio_to_abort;
5062 
5063 	/* Submit the abort request to the underlying bdev module. */
5064 	bdev_io_submit(bdev_io);
5065 
5066 	return 0;
5067 }
5068 
5069 static uint32_t
5070 _bdev_abort(struct spdk_bdev_io *parent_io)
5071 {
5072 	struct spdk_bdev_desc *desc = parent_io->internal.desc;
5073 	struct spdk_bdev_channel *channel = parent_io->internal.ch;
5074 	void *bio_cb_arg;
5075 	struct spdk_bdev_io *bio_to_abort;
5076 	uint32_t matched_ios;
5077 	int rc;
5078 
5079 	bio_cb_arg = parent_io->u.bdev.abort.bio_cb_arg;
5080 
5081 	/* matched_ios is returned and will be kept by the caller.
5082 	 *
5083 	 * This funcion will be used for two cases, 1) the same cb_arg is used for
5084 	 * multiple I/Os, 2) a single large I/O is split into smaller ones.
5085 	 * Incrementing split_outstanding directly here may confuse readers especially
5086 	 * for the 1st case.
5087 	 *
5088 	 * Completion of I/O abort is processed after stack unwinding. Hence this trick
5089 	 * works as expected.
5090 	 */
5091 	matched_ios = 0;
5092 	parent_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS;
5093 
5094 	TAILQ_FOREACH(bio_to_abort, &channel->io_submitted, internal.ch_link) {
5095 		if (bio_to_abort->internal.caller_ctx != bio_cb_arg) {
5096 			continue;
5097 		}
5098 
5099 		if (bio_to_abort->internal.submit_tsc > parent_io->internal.submit_tsc) {
5100 			/* Any I/O which was submitted after this abort command should be excluded. */
5101 			continue;
5102 		}
5103 
5104 		rc = bdev_abort_io(desc, channel, bio_to_abort, bdev_abort_io_done, parent_io);
5105 		if (rc != 0) {
5106 			if (rc == -ENOMEM) {
5107 				parent_io->internal.status = SPDK_BDEV_IO_STATUS_NOMEM;
5108 			} else {
5109 				parent_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED;
5110 			}
5111 			break;
5112 		}
5113 		matched_ios++;
5114 	}
5115 
5116 	return matched_ios;
5117 }
5118 
5119 static void
5120 bdev_abort_retry(void *ctx)
5121 {
5122 	struct spdk_bdev_io *parent_io = ctx;
5123 	uint32_t matched_ios;
5124 
5125 	matched_ios = _bdev_abort(parent_io);
5126 
5127 	if (matched_ios == 0) {
5128 		if (parent_io->internal.status == SPDK_BDEV_IO_STATUS_NOMEM) {
5129 			bdev_queue_io_wait_with_cb(parent_io, bdev_abort_retry);
5130 		} else {
5131 			/* For retry, the case that no target I/O was found is success
5132 			 * because it means target I/Os completed in the meantime.
5133 			 */
5134 			bdev_io_complete(parent_io);
5135 		}
5136 		return;
5137 	}
5138 
5139 	/* Use split_outstanding to manage the progress of aborting I/Os. */
5140 	parent_io->u.bdev.split_outstanding = matched_ios;
5141 }
5142 
5143 static void
5144 bdev_abort(struct spdk_bdev_io *parent_io)
5145 {
5146 	uint32_t matched_ios;
5147 
5148 	matched_ios = _bdev_abort(parent_io);
5149 
5150 	if (matched_ios == 0) {
5151 		if (parent_io->internal.status == SPDK_BDEV_IO_STATUS_NOMEM) {
5152 			bdev_queue_io_wait_with_cb(parent_io, bdev_abort_retry);
5153 		} else {
5154 			/* The case the no target I/O was found is failure. */
5155 			parent_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED;
5156 			bdev_io_complete(parent_io);
5157 		}
5158 		return;
5159 	}
5160 
5161 	/* Use split_outstanding to manage the progress of aborting I/Os. */
5162 	parent_io->u.bdev.split_outstanding = matched_ios;
5163 }
5164 
5165 int
5166 spdk_bdev_abort(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
5167 		void *bio_cb_arg,
5168 		spdk_bdev_io_completion_cb cb, void *cb_arg)
5169 {
5170 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
5171 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
5172 	struct spdk_bdev_io *bdev_io;
5173 
5174 	if (bio_cb_arg == NULL) {
5175 		return -EINVAL;
5176 	}
5177 
5178 	if (!spdk_bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_ABORT)) {
5179 		return -ENOTSUP;
5180 	}
5181 
5182 	bdev_io = bdev_channel_get_io(channel);
5183 	if (bdev_io == NULL) {
5184 		return -ENOMEM;
5185 	}
5186 
5187 	bdev_io->internal.ch = channel;
5188 	bdev_io->internal.desc = desc;
5189 	bdev_io->internal.submit_tsc = spdk_get_ticks();
5190 	bdev_io->type = SPDK_BDEV_IO_TYPE_ABORT;
5191 	bdev_io_init(bdev_io, bdev, cb_arg, cb);
5192 
5193 	bdev_io->u.bdev.abort.bio_cb_arg = bio_cb_arg;
5194 
5195 	/* Parent abort request is not submitted directly, but to manage its execution,
5196 	 * add it to the submitted list here.
5197 	 */
5198 	TAILQ_INSERT_TAIL(&channel->io_submitted, bdev_io, internal.ch_link);
5199 
5200 	bdev_abort(bdev_io);
5201 
5202 	return 0;
5203 }
5204 
5205 int
5206 spdk_bdev_queue_io_wait(struct spdk_bdev *bdev, struct spdk_io_channel *ch,
5207 			struct spdk_bdev_io_wait_entry *entry)
5208 {
5209 	struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch);
5210 	struct spdk_bdev_mgmt_channel *mgmt_ch = channel->shared_resource->mgmt_ch;
5211 
5212 	if (bdev != entry->bdev) {
5213 		SPDK_ERRLOG("bdevs do not match\n");
5214 		return -EINVAL;
5215 	}
5216 
5217 	if (mgmt_ch->per_thread_cache_count > 0) {
5218 		SPDK_ERRLOG("Cannot queue io_wait if spdk_bdev_io available in per-thread cache\n");
5219 		return -EINVAL;
5220 	}
5221 
5222 	TAILQ_INSERT_TAIL(&mgmt_ch->io_wait_queue, entry, link);
5223 	return 0;
5224 }
5225 
5226 static void
5227 bdev_ch_retry_io(struct spdk_bdev_channel *bdev_ch)
5228 {
5229 	struct spdk_bdev *bdev = bdev_ch->bdev;
5230 	struct spdk_bdev_shared_resource *shared_resource = bdev_ch->shared_resource;
5231 	struct spdk_bdev_io *bdev_io;
5232 
5233 	if (shared_resource->io_outstanding > shared_resource->nomem_threshold) {
5234 		/*
5235 		 * Allow some more I/O to complete before retrying the nomem_io queue.
5236 		 *  Some drivers (such as nvme) cannot immediately take a new I/O in
5237 		 *  the context of a completion, because the resources for the I/O are
5238 		 *  not released until control returns to the bdev poller.  Also, we
5239 		 *  may require several small I/O to complete before a larger I/O
5240 		 *  (that requires splitting) can be submitted.
5241 		 */
5242 		return;
5243 	}
5244 
5245 	while (!TAILQ_EMPTY(&shared_resource->nomem_io)) {
5246 		bdev_io = TAILQ_FIRST(&shared_resource->nomem_io);
5247 		TAILQ_REMOVE(&shared_resource->nomem_io, bdev_io, internal.link);
5248 		bdev_io->internal.ch->io_outstanding++;
5249 		shared_resource->io_outstanding++;
5250 		bdev_io->internal.status = SPDK_BDEV_IO_STATUS_PENDING;
5251 		bdev_io->internal.error.nvme.cdw0 = 0;
5252 		bdev_io->num_retries++;
5253 		bdev->fn_table->submit_request(spdk_bdev_io_get_io_channel(bdev_io), bdev_io);
5254 		if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_NOMEM) {
5255 			break;
5256 		}
5257 	}
5258 }
5259 
5260 static inline void
5261 bdev_io_complete(void *ctx)
5262 {
5263 	struct spdk_bdev_io *bdev_io = ctx;
5264 	struct spdk_bdev_channel *bdev_ch = bdev_io->internal.ch;
5265 	uint64_t tsc, tsc_diff;
5266 
5267 	if (spdk_unlikely(bdev_io->internal.in_submit_request || bdev_io->internal.io_submit_ch)) {
5268 		/*
5269 		 * Send the completion to the thread that originally submitted the I/O,
5270 		 * which may not be the current thread in the case of QoS.
5271 		 */
5272 		if (bdev_io->internal.io_submit_ch) {
5273 			bdev_io->internal.ch = bdev_io->internal.io_submit_ch;
5274 			bdev_io->internal.io_submit_ch = NULL;
5275 		}
5276 
5277 		/*
5278 		 * Defer completion to avoid potential infinite recursion if the
5279 		 * user's completion callback issues a new I/O.
5280 		 */
5281 		spdk_thread_send_msg(spdk_bdev_io_get_thread(bdev_io),
5282 				     bdev_io_complete, bdev_io);
5283 		return;
5284 	}
5285 
5286 	tsc = spdk_get_ticks();
5287 	tsc_diff = tsc - bdev_io->internal.submit_tsc;
5288 	spdk_trace_record_tsc(tsc, TRACE_BDEV_IO_DONE, 0, 0, (uintptr_t)bdev_io);
5289 
5290 	TAILQ_REMOVE(&bdev_ch->io_submitted, bdev_io, internal.ch_link);
5291 
5292 	if (bdev_io->internal.ch->histogram) {
5293 		spdk_histogram_data_tally(bdev_io->internal.ch->histogram, tsc_diff);
5294 	}
5295 
5296 	if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS) {
5297 		switch (bdev_io->type) {
5298 		case SPDK_BDEV_IO_TYPE_READ:
5299 			bdev_io->internal.ch->stat.bytes_read += bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen;
5300 			bdev_io->internal.ch->stat.num_read_ops++;
5301 			bdev_io->internal.ch->stat.read_latency_ticks += tsc_diff;
5302 			break;
5303 		case SPDK_BDEV_IO_TYPE_WRITE:
5304 			bdev_io->internal.ch->stat.bytes_written += bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen;
5305 			bdev_io->internal.ch->stat.num_write_ops++;
5306 			bdev_io->internal.ch->stat.write_latency_ticks += tsc_diff;
5307 			break;
5308 		case SPDK_BDEV_IO_TYPE_UNMAP:
5309 			bdev_io->internal.ch->stat.bytes_unmapped += bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen;
5310 			bdev_io->internal.ch->stat.num_unmap_ops++;
5311 			bdev_io->internal.ch->stat.unmap_latency_ticks += tsc_diff;
5312 			break;
5313 		case SPDK_BDEV_IO_TYPE_ZCOPY:
5314 			/* Track the data in the start phase only */
5315 			if (bdev_io->u.bdev.zcopy.start) {
5316 				if (bdev_io->u.bdev.zcopy.populate) {
5317 					bdev_io->internal.ch->stat.bytes_read +=
5318 						bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen;
5319 					bdev_io->internal.ch->stat.num_read_ops++;
5320 					bdev_io->internal.ch->stat.read_latency_ticks += tsc_diff;
5321 				} else {
5322 					bdev_io->internal.ch->stat.bytes_written +=
5323 						bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen;
5324 					bdev_io->internal.ch->stat.num_write_ops++;
5325 					bdev_io->internal.ch->stat.write_latency_ticks += tsc_diff;
5326 				}
5327 			}
5328 			break;
5329 		default:
5330 			break;
5331 		}
5332 	}
5333 
5334 #ifdef SPDK_CONFIG_VTUNE
5335 	uint64_t now_tsc = spdk_get_ticks();
5336 	if (now_tsc > (bdev_io->internal.ch->start_tsc + bdev_io->internal.ch->interval_tsc)) {
5337 		uint64_t data[5];
5338 
5339 		data[0] = bdev_io->internal.ch->stat.num_read_ops - bdev_io->internal.ch->prev_stat.num_read_ops;
5340 		data[1] = bdev_io->internal.ch->stat.bytes_read - bdev_io->internal.ch->prev_stat.bytes_read;
5341 		data[2] = bdev_io->internal.ch->stat.num_write_ops - bdev_io->internal.ch->prev_stat.num_write_ops;
5342 		data[3] = bdev_io->internal.ch->stat.bytes_written - bdev_io->internal.ch->prev_stat.bytes_written;
5343 		data[4] = bdev_io->bdev->fn_table->get_spin_time ?
5344 			  bdev_io->bdev->fn_table->get_spin_time(spdk_bdev_io_get_io_channel(bdev_io)) : 0;
5345 
5346 		__itt_metadata_add(g_bdev_mgr.domain, __itt_null, bdev_io->internal.ch->handle,
5347 				   __itt_metadata_u64, 5, data);
5348 
5349 		bdev_io->internal.ch->prev_stat = bdev_io->internal.ch->stat;
5350 		bdev_io->internal.ch->start_tsc = now_tsc;
5351 	}
5352 #endif
5353 
5354 	assert(bdev_io->internal.cb != NULL);
5355 	assert(spdk_get_thread() == spdk_bdev_io_get_thread(bdev_io));
5356 
5357 	bdev_io->internal.cb(bdev_io, bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS,
5358 			     bdev_io->internal.caller_ctx);
5359 }
5360 
5361 static void
5362 bdev_reset_complete(struct spdk_io_channel_iter *i, int status)
5363 {
5364 	struct spdk_bdev_io *bdev_io = spdk_io_channel_iter_get_ctx(i);
5365 
5366 	if (bdev_io->u.reset.ch_ref != NULL) {
5367 		spdk_put_io_channel(bdev_io->u.reset.ch_ref);
5368 		bdev_io->u.reset.ch_ref = NULL;
5369 	}
5370 
5371 	bdev_io_complete(bdev_io);
5372 }
5373 
5374 static void
5375 bdev_unfreeze_channel(struct spdk_io_channel_iter *i)
5376 {
5377 	struct spdk_bdev_io *bdev_io = spdk_io_channel_iter_get_ctx(i);
5378 	struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i);
5379 	struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch);
5380 	struct spdk_bdev_io *queued_reset;
5381 
5382 	ch->flags &= ~BDEV_CH_RESET_IN_PROGRESS;
5383 	while (!TAILQ_EMPTY(&ch->queued_resets)) {
5384 		queued_reset = TAILQ_FIRST(&ch->queued_resets);
5385 		TAILQ_REMOVE(&ch->queued_resets, queued_reset, internal.link);
5386 		spdk_bdev_io_complete(queued_reset, bdev_io->internal.status);
5387 	}
5388 
5389 	spdk_for_each_channel_continue(i, 0);
5390 }
5391 
5392 void
5393 spdk_bdev_io_complete(struct spdk_bdev_io *bdev_io, enum spdk_bdev_io_status status)
5394 {
5395 	struct spdk_bdev *bdev = bdev_io->bdev;
5396 	struct spdk_bdev_channel *bdev_ch = bdev_io->internal.ch;
5397 	struct spdk_bdev_shared_resource *shared_resource = bdev_ch->shared_resource;
5398 
5399 	bdev_io->internal.status = status;
5400 
5401 	if (spdk_unlikely(bdev_io->type == SPDK_BDEV_IO_TYPE_RESET)) {
5402 		bool unlock_channels = false;
5403 
5404 		if (status == SPDK_BDEV_IO_STATUS_NOMEM) {
5405 			SPDK_ERRLOG("NOMEM returned for reset\n");
5406 		}
5407 		pthread_mutex_lock(&bdev->internal.mutex);
5408 		if (bdev_io == bdev->internal.reset_in_progress) {
5409 			bdev->internal.reset_in_progress = NULL;
5410 			unlock_channels = true;
5411 		}
5412 		pthread_mutex_unlock(&bdev->internal.mutex);
5413 
5414 		if (unlock_channels) {
5415 			spdk_for_each_channel(__bdev_to_io_dev(bdev), bdev_unfreeze_channel,
5416 					      bdev_io, bdev_reset_complete);
5417 			return;
5418 		}
5419 	} else {
5420 		_bdev_io_unset_bounce_buf(bdev_io);
5421 
5422 		assert(bdev_ch->io_outstanding > 0);
5423 		assert(shared_resource->io_outstanding > 0);
5424 		bdev_ch->io_outstanding--;
5425 		shared_resource->io_outstanding--;
5426 
5427 		if (spdk_unlikely(status == SPDK_BDEV_IO_STATUS_NOMEM)) {
5428 			TAILQ_INSERT_HEAD(&shared_resource->nomem_io, bdev_io, internal.link);
5429 			/*
5430 			 * Wait for some of the outstanding I/O to complete before we
5431 			 *  retry any of the nomem_io.  Normally we will wait for
5432 			 *  NOMEM_THRESHOLD_COUNT I/O to complete but for low queue
5433 			 *  depth channels we will instead wait for half to complete.
5434 			 */
5435 			shared_resource->nomem_threshold = spdk_max((int64_t)shared_resource->io_outstanding / 2,
5436 							   (int64_t)shared_resource->io_outstanding - NOMEM_THRESHOLD_COUNT);
5437 			return;
5438 		}
5439 
5440 		if (spdk_unlikely(!TAILQ_EMPTY(&shared_resource->nomem_io))) {
5441 			bdev_ch_retry_io(bdev_ch);
5442 		}
5443 	}
5444 
5445 	bdev_io_complete(bdev_io);
5446 }
5447 
5448 void
5449 spdk_bdev_io_complete_scsi_status(struct spdk_bdev_io *bdev_io, enum spdk_scsi_status sc,
5450 				  enum spdk_scsi_sense sk, uint8_t asc, uint8_t ascq)
5451 {
5452 	if (sc == SPDK_SCSI_STATUS_GOOD) {
5453 		bdev_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS;
5454 	} else {
5455 		bdev_io->internal.status = SPDK_BDEV_IO_STATUS_SCSI_ERROR;
5456 		bdev_io->internal.error.scsi.sc = sc;
5457 		bdev_io->internal.error.scsi.sk = sk;
5458 		bdev_io->internal.error.scsi.asc = asc;
5459 		bdev_io->internal.error.scsi.ascq = ascq;
5460 	}
5461 
5462 	spdk_bdev_io_complete(bdev_io, bdev_io->internal.status);
5463 }
5464 
5465 void
5466 spdk_bdev_io_get_scsi_status(const struct spdk_bdev_io *bdev_io,
5467 			     int *sc, int *sk, int *asc, int *ascq)
5468 {
5469 	assert(sc != NULL);
5470 	assert(sk != NULL);
5471 	assert(asc != NULL);
5472 	assert(ascq != NULL);
5473 
5474 	switch (bdev_io->internal.status) {
5475 	case SPDK_BDEV_IO_STATUS_SUCCESS:
5476 		*sc = SPDK_SCSI_STATUS_GOOD;
5477 		*sk = SPDK_SCSI_SENSE_NO_SENSE;
5478 		*asc = SPDK_SCSI_ASC_NO_ADDITIONAL_SENSE;
5479 		*ascq = SPDK_SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
5480 		break;
5481 	case SPDK_BDEV_IO_STATUS_NVME_ERROR:
5482 		spdk_scsi_nvme_translate(bdev_io, sc, sk, asc, ascq);
5483 		break;
5484 	case SPDK_BDEV_IO_STATUS_SCSI_ERROR:
5485 		*sc = bdev_io->internal.error.scsi.sc;
5486 		*sk = bdev_io->internal.error.scsi.sk;
5487 		*asc = bdev_io->internal.error.scsi.asc;
5488 		*ascq = bdev_io->internal.error.scsi.ascq;
5489 		break;
5490 	default:
5491 		*sc = SPDK_SCSI_STATUS_CHECK_CONDITION;
5492 		*sk = SPDK_SCSI_SENSE_ABORTED_COMMAND;
5493 		*asc = SPDK_SCSI_ASC_NO_ADDITIONAL_SENSE;
5494 		*ascq = SPDK_SCSI_ASCQ_CAUSE_NOT_REPORTABLE;
5495 		break;
5496 	}
5497 }
5498 
5499 void
5500 spdk_bdev_io_complete_aio_status(struct spdk_bdev_io *bdev_io, int aio_result)
5501 {
5502 	if (aio_result == 0) {
5503 		bdev_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS;
5504 	} else {
5505 		bdev_io->internal.status = SPDK_BDEV_IO_STATUS_AIO_ERROR;
5506 	}
5507 
5508 	bdev_io->internal.error.aio_result = aio_result;
5509 
5510 	spdk_bdev_io_complete(bdev_io, bdev_io->internal.status);
5511 }
5512 
5513 void
5514 spdk_bdev_io_get_aio_status(const struct spdk_bdev_io *bdev_io, int *aio_result)
5515 {
5516 	assert(aio_result != NULL);
5517 
5518 	if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_AIO_ERROR) {
5519 		*aio_result = bdev_io->internal.error.aio_result;
5520 	} else if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS) {
5521 		*aio_result = 0;
5522 	} else {
5523 		*aio_result = -EIO;
5524 	}
5525 }
5526 
5527 void
5528 spdk_bdev_io_complete_nvme_status(struct spdk_bdev_io *bdev_io, uint32_t cdw0, int sct, int sc)
5529 {
5530 	if (sct == SPDK_NVME_SCT_GENERIC && sc == SPDK_NVME_SC_SUCCESS) {
5531 		bdev_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS;
5532 	} else if (sct == SPDK_NVME_SCT_GENERIC && sc == SPDK_NVME_SC_ABORTED_BY_REQUEST) {
5533 		bdev_io->internal.status = SPDK_BDEV_IO_STATUS_ABORTED;
5534 	} else {
5535 		bdev_io->internal.status = SPDK_BDEV_IO_STATUS_NVME_ERROR;
5536 	}
5537 
5538 	bdev_io->internal.error.nvme.cdw0 = cdw0;
5539 	bdev_io->internal.error.nvme.sct = sct;
5540 	bdev_io->internal.error.nvme.sc = sc;
5541 
5542 	spdk_bdev_io_complete(bdev_io, bdev_io->internal.status);
5543 }
5544 
5545 void
5546 spdk_bdev_io_get_nvme_status(const struct spdk_bdev_io *bdev_io, uint32_t *cdw0, int *sct, int *sc)
5547 {
5548 	assert(sct != NULL);
5549 	assert(sc != NULL);
5550 	assert(cdw0 != NULL);
5551 
5552 	if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_NVME_ERROR) {
5553 		*sct = bdev_io->internal.error.nvme.sct;
5554 		*sc = bdev_io->internal.error.nvme.sc;
5555 	} else if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS) {
5556 		*sct = SPDK_NVME_SCT_GENERIC;
5557 		*sc = SPDK_NVME_SC_SUCCESS;
5558 	} else if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_ABORTED) {
5559 		*sct = SPDK_NVME_SCT_GENERIC;
5560 		*sc = SPDK_NVME_SC_ABORTED_BY_REQUEST;
5561 	} else {
5562 		*sct = SPDK_NVME_SCT_GENERIC;
5563 		*sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
5564 	}
5565 
5566 	*cdw0 = bdev_io->internal.error.nvme.cdw0;
5567 }
5568 
5569 void
5570 spdk_bdev_io_get_nvme_fused_status(const struct spdk_bdev_io *bdev_io, uint32_t *cdw0,
5571 				   int *first_sct, int *first_sc, int *second_sct, int *second_sc)
5572 {
5573 	assert(first_sct != NULL);
5574 	assert(first_sc != NULL);
5575 	assert(second_sct != NULL);
5576 	assert(second_sc != NULL);
5577 	assert(cdw0 != NULL);
5578 
5579 	if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_NVME_ERROR) {
5580 		if (bdev_io->internal.error.nvme.sct == SPDK_NVME_SCT_MEDIA_ERROR &&
5581 		    bdev_io->internal.error.nvme.sc == SPDK_NVME_SC_COMPARE_FAILURE) {
5582 			*first_sct = bdev_io->internal.error.nvme.sct;
5583 			*first_sc = bdev_io->internal.error.nvme.sc;
5584 			*second_sct = SPDK_NVME_SCT_GENERIC;
5585 			*second_sc = SPDK_NVME_SC_ABORTED_FAILED_FUSED;
5586 		} else {
5587 			*first_sct = SPDK_NVME_SCT_GENERIC;
5588 			*first_sc = SPDK_NVME_SC_SUCCESS;
5589 			*second_sct = bdev_io->internal.error.nvme.sct;
5590 			*second_sc = bdev_io->internal.error.nvme.sc;
5591 		}
5592 	} else if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS) {
5593 		*first_sct = SPDK_NVME_SCT_GENERIC;
5594 		*first_sc = SPDK_NVME_SC_SUCCESS;
5595 		*second_sct = SPDK_NVME_SCT_GENERIC;
5596 		*second_sc = SPDK_NVME_SC_SUCCESS;
5597 	} else if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_FIRST_FUSED_FAILED) {
5598 		*first_sct = SPDK_NVME_SCT_GENERIC;
5599 		*first_sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
5600 		*second_sct = SPDK_NVME_SCT_GENERIC;
5601 		*second_sc = SPDK_NVME_SC_ABORTED_FAILED_FUSED;
5602 	} else if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_MISCOMPARE) {
5603 		*first_sct = SPDK_NVME_SCT_MEDIA_ERROR;
5604 		*first_sc = SPDK_NVME_SC_COMPARE_FAILURE;
5605 		*second_sct = SPDK_NVME_SCT_GENERIC;
5606 		*second_sc = SPDK_NVME_SC_ABORTED_FAILED_FUSED;
5607 	} else {
5608 		*first_sct = SPDK_NVME_SCT_GENERIC;
5609 		*first_sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
5610 		*second_sct = SPDK_NVME_SCT_GENERIC;
5611 		*second_sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR;
5612 	}
5613 
5614 	*cdw0 = bdev_io->internal.error.nvme.cdw0;
5615 }
5616 
5617 struct spdk_thread *
5618 spdk_bdev_io_get_thread(struct spdk_bdev_io *bdev_io)
5619 {
5620 	return spdk_io_channel_get_thread(bdev_io->internal.ch->channel);
5621 }
5622 
5623 struct spdk_io_channel *
5624 spdk_bdev_io_get_io_channel(struct spdk_bdev_io *bdev_io)
5625 {
5626 	return bdev_io->internal.ch->channel;
5627 }
5628 
5629 static int
5630 bdev_register(struct spdk_bdev *bdev)
5631 {
5632 	char *bdev_name;
5633 	int ret;
5634 
5635 	assert(bdev->module != NULL);
5636 
5637 	if (!bdev->name) {
5638 		SPDK_ERRLOG("Bdev name is NULL\n");
5639 		return -EINVAL;
5640 	}
5641 
5642 	if (!strlen(bdev->name)) {
5643 		SPDK_ERRLOG("Bdev name must not be an empty string\n");
5644 		return -EINVAL;
5645 	}
5646 
5647 	/* Users often register their own I/O devices using the bdev name. In
5648 	 * order to avoid conflicts, prepend bdev_. */
5649 	bdev_name = spdk_sprintf_alloc("bdev_%s", bdev->name);
5650 	if (!bdev_name) {
5651 		SPDK_ERRLOG("Unable to allocate memory for internal bdev name.\n");
5652 		return -ENOMEM;
5653 	}
5654 
5655 	bdev->internal.status = SPDK_BDEV_STATUS_READY;
5656 	bdev->internal.measured_queue_depth = UINT64_MAX;
5657 	bdev->internal.claim_module = NULL;
5658 	bdev->internal.qd_poller = NULL;
5659 	bdev->internal.qos = NULL;
5660 
5661 	ret = bdev_name_add(&bdev->internal.bdev_name, bdev, bdev->name);
5662 	if (ret != 0) {
5663 		free(bdev_name);
5664 		return ret;
5665 	}
5666 
5667 	/* If the user didn't specify a uuid, generate one. */
5668 	if (spdk_mem_all_zero(&bdev->uuid, sizeof(bdev->uuid))) {
5669 		spdk_uuid_generate(&bdev->uuid);
5670 	}
5671 
5672 	if (spdk_bdev_get_buf_align(bdev) > 1) {
5673 		if (bdev->split_on_optimal_io_boundary) {
5674 			bdev->optimal_io_boundary = spdk_min(bdev->optimal_io_boundary,
5675 							     SPDK_BDEV_LARGE_BUF_MAX_SIZE / bdev->blocklen);
5676 		} else {
5677 			bdev->split_on_optimal_io_boundary = true;
5678 			bdev->optimal_io_boundary = SPDK_BDEV_LARGE_BUF_MAX_SIZE / bdev->blocklen;
5679 		}
5680 	}
5681 
5682 	/* If the user didn't specify a write unit size, set it to one. */
5683 	if (bdev->write_unit_size == 0) {
5684 		bdev->write_unit_size = 1;
5685 	}
5686 
5687 	/* Set ACWU value to 1 if bdev module did not set it (does not support it natively) */
5688 	if (bdev->acwu == 0) {
5689 		bdev->acwu = 1;
5690 	}
5691 
5692 	if (bdev->phys_blocklen == 0) {
5693 		bdev->phys_blocklen = spdk_bdev_get_data_block_size(bdev);
5694 	}
5695 
5696 	TAILQ_INIT(&bdev->internal.open_descs);
5697 	TAILQ_INIT(&bdev->internal.locked_ranges);
5698 	TAILQ_INIT(&bdev->internal.pending_locked_ranges);
5699 
5700 	TAILQ_INIT(&bdev->aliases);
5701 
5702 	bdev->internal.reset_in_progress = NULL;
5703 
5704 	spdk_io_device_register(__bdev_to_io_dev(bdev),
5705 				bdev_channel_create, bdev_channel_destroy,
5706 				sizeof(struct spdk_bdev_channel),
5707 				bdev_name);
5708 
5709 	free(bdev_name);
5710 
5711 	pthread_mutex_init(&bdev->internal.mutex, NULL);
5712 
5713 	SPDK_DEBUGLOG(bdev, "Inserting bdev %s into list\n", bdev->name);
5714 	TAILQ_INSERT_TAIL(&g_bdev_mgr.bdevs, bdev, internal.link);
5715 
5716 	return 0;
5717 }
5718 
5719 static void
5720 bdev_destroy_cb(void *io_device)
5721 {
5722 	int			rc;
5723 	struct spdk_bdev	*bdev;
5724 	spdk_bdev_unregister_cb	cb_fn;
5725 	void			*cb_arg;
5726 
5727 	bdev = __bdev_from_io_dev(io_device);
5728 	cb_fn = bdev->internal.unregister_cb;
5729 	cb_arg = bdev->internal.unregister_ctx;
5730 
5731 	pthread_mutex_destroy(&bdev->internal.mutex);
5732 	free(bdev->internal.qos);
5733 
5734 	rc = bdev->fn_table->destruct(bdev->ctxt);
5735 	if (rc < 0) {
5736 		SPDK_ERRLOG("destruct failed\n");
5737 	}
5738 	if (rc <= 0 && cb_fn != NULL) {
5739 		cb_fn(cb_arg, rc);
5740 	}
5741 }
5742 
5743 static void
5744 bdev_register_finished(void *arg)
5745 {
5746 	struct spdk_bdev *bdev = arg;
5747 
5748 	spdk_notify_send("bdev_register", spdk_bdev_get_name(bdev));
5749 }
5750 
5751 int
5752 spdk_bdev_register(struct spdk_bdev *bdev)
5753 {
5754 	int rc = bdev_register(bdev);
5755 
5756 	if (rc == 0) {
5757 		/* Examine configuration before initializing I/O */
5758 		bdev_examine(bdev);
5759 
5760 		spdk_bdev_wait_for_examine(bdev_register_finished, bdev);
5761 	}
5762 
5763 	return rc;
5764 }
5765 
5766 void
5767 spdk_bdev_destruct_done(struct spdk_bdev *bdev, int bdeverrno)
5768 {
5769 	if (bdev->internal.unregister_cb != NULL) {
5770 		bdev->internal.unregister_cb(bdev->internal.unregister_ctx, bdeverrno);
5771 	}
5772 }
5773 
5774 static void
5775 _remove_notify(void *arg)
5776 {
5777 	struct spdk_bdev_desc *desc = arg;
5778 
5779 	pthread_mutex_lock(&desc->mutex);
5780 	desc->refs--;
5781 
5782 	if (!desc->closed) {
5783 		pthread_mutex_unlock(&desc->mutex);
5784 		desc->callback.event_fn(SPDK_BDEV_EVENT_REMOVE, desc->bdev, desc->callback.ctx);
5785 		return;
5786 	} else if (0 == desc->refs) {
5787 		/* This descriptor was closed after this remove_notify message was sent.
5788 		 * spdk_bdev_close() could not free the descriptor since this message was
5789 		 * in flight, so we free it now using bdev_desc_free().
5790 		 */
5791 		pthread_mutex_unlock(&desc->mutex);
5792 		bdev_desc_free(desc);
5793 		return;
5794 	}
5795 	pthread_mutex_unlock(&desc->mutex);
5796 }
5797 
5798 /* Must be called while holding bdev->internal.mutex.
5799  * returns: 0 - bdev removed and ready to be destructed.
5800  *          -EBUSY - bdev can't be destructed yet.  */
5801 static int
5802 bdev_unregister_unsafe(struct spdk_bdev *bdev)
5803 {
5804 	struct spdk_bdev_desc	*desc, *tmp;
5805 	int			rc = 0;
5806 
5807 	/* Notify each descriptor about hotremoval */
5808 	TAILQ_FOREACH_SAFE(desc, &bdev->internal.open_descs, link, tmp) {
5809 		rc = -EBUSY;
5810 		pthread_mutex_lock(&desc->mutex);
5811 		/*
5812 		 * Defer invocation of the event_cb to a separate message that will
5813 		 *  run later on its thread.  This ensures this context unwinds and
5814 		 *  we don't recursively unregister this bdev again if the event_cb
5815 		 *  immediately closes its descriptor.
5816 		 */
5817 		desc->refs++;
5818 		spdk_thread_send_msg(desc->thread, _remove_notify, desc);
5819 		pthread_mutex_unlock(&desc->mutex);
5820 	}
5821 
5822 	/* If there are no descriptors, proceed removing the bdev */
5823 	if (rc == 0) {
5824 		TAILQ_REMOVE(&g_bdev_mgr.bdevs, bdev, internal.link);
5825 		SPDK_DEBUGLOG(bdev, "Removing bdev %s from list done\n", bdev->name);
5826 		bdev_name_del(&bdev->internal.bdev_name);
5827 		spdk_notify_send("bdev_unregister", spdk_bdev_get_name(bdev));
5828 	}
5829 
5830 	return rc;
5831 }
5832 
5833 void
5834 spdk_bdev_unregister(struct spdk_bdev *bdev, spdk_bdev_unregister_cb cb_fn, void *cb_arg)
5835 {
5836 	struct spdk_thread	*thread;
5837 	int			rc;
5838 
5839 	SPDK_DEBUGLOG(bdev, "Removing bdev %s from list\n", bdev->name);
5840 
5841 	thread = spdk_get_thread();
5842 	if (!thread) {
5843 		/* The user called this from a non-SPDK thread. */
5844 		if (cb_fn != NULL) {
5845 			cb_fn(cb_arg, -ENOTSUP);
5846 		}
5847 		return;
5848 	}
5849 
5850 	pthread_mutex_lock(&g_bdev_mgr.mutex);
5851 	if (bdev->internal.status == SPDK_BDEV_STATUS_REMOVING) {
5852 		pthread_mutex_unlock(&g_bdev_mgr.mutex);
5853 		if (cb_fn) {
5854 			cb_fn(cb_arg, -EBUSY);
5855 		}
5856 		return;
5857 	}
5858 
5859 	pthread_mutex_lock(&bdev->internal.mutex);
5860 	bdev->internal.status = SPDK_BDEV_STATUS_REMOVING;
5861 	bdev->internal.unregister_cb = cb_fn;
5862 	bdev->internal.unregister_ctx = cb_arg;
5863 
5864 	/* Call under lock. */
5865 	rc = bdev_unregister_unsafe(bdev);
5866 	pthread_mutex_unlock(&bdev->internal.mutex);
5867 	pthread_mutex_unlock(&g_bdev_mgr.mutex);
5868 
5869 	if (rc == 0) {
5870 		spdk_io_device_unregister(__bdev_to_io_dev(bdev), bdev_destroy_cb);
5871 	}
5872 }
5873 
5874 static int
5875 bdev_start_qos(struct spdk_bdev *bdev)
5876 {
5877 	struct set_qos_limit_ctx *ctx;
5878 
5879 	/* Enable QoS */
5880 	if (bdev->internal.qos && bdev->internal.qos->thread == NULL) {
5881 		ctx = calloc(1, sizeof(*ctx));
5882 		if (ctx == NULL) {
5883 			SPDK_ERRLOG("Failed to allocate memory for QoS context\n");
5884 			return -ENOMEM;
5885 		}
5886 		ctx->bdev = bdev;
5887 		spdk_for_each_channel(__bdev_to_io_dev(bdev),
5888 				      bdev_enable_qos_msg, ctx,
5889 				      bdev_enable_qos_done);
5890 	}
5891 
5892 	return 0;
5893 }
5894 
5895 static int
5896 bdev_open(struct spdk_bdev *bdev, bool write, struct spdk_bdev_desc *desc)
5897 {
5898 	struct spdk_thread *thread;
5899 	int rc = 0;
5900 
5901 	thread = spdk_get_thread();
5902 	if (!thread) {
5903 		SPDK_ERRLOG("Cannot open bdev from non-SPDK thread.\n");
5904 		return -ENOTSUP;
5905 	}
5906 
5907 	SPDK_DEBUGLOG(bdev, "Opening descriptor %p for bdev %s on thread %p\n", desc, bdev->name,
5908 		      spdk_get_thread());
5909 
5910 	desc->bdev = bdev;
5911 	desc->thread = thread;
5912 	desc->write = write;
5913 
5914 	pthread_mutex_lock(&bdev->internal.mutex);
5915 	if (bdev->internal.status == SPDK_BDEV_STATUS_REMOVING) {
5916 		pthread_mutex_unlock(&bdev->internal.mutex);
5917 		return -ENODEV;
5918 	}
5919 
5920 	if (write && bdev->internal.claim_module) {
5921 		SPDK_ERRLOG("Could not open %s - %s module already claimed it\n",
5922 			    bdev->name, bdev->internal.claim_module->name);
5923 		pthread_mutex_unlock(&bdev->internal.mutex);
5924 		return -EPERM;
5925 	}
5926 
5927 	rc = bdev_start_qos(bdev);
5928 	if (rc != 0) {
5929 		SPDK_ERRLOG("Failed to start QoS on bdev %s\n", bdev->name);
5930 		pthread_mutex_unlock(&bdev->internal.mutex);
5931 		return rc;
5932 	}
5933 
5934 	TAILQ_INSERT_TAIL(&bdev->internal.open_descs, desc, link);
5935 
5936 	pthread_mutex_unlock(&bdev->internal.mutex);
5937 
5938 	return 0;
5939 }
5940 
5941 int
5942 spdk_bdev_open_ext(const char *bdev_name, bool write, spdk_bdev_event_cb_t event_cb,
5943 		   void *event_ctx, struct spdk_bdev_desc **_desc)
5944 {
5945 	struct spdk_bdev_desc *desc;
5946 	struct spdk_bdev *bdev;
5947 	unsigned int event_id;
5948 	int rc;
5949 
5950 	if (event_cb == NULL) {
5951 		SPDK_ERRLOG("Missing event callback function\n");
5952 		return -EINVAL;
5953 	}
5954 
5955 	pthread_mutex_lock(&g_bdev_mgr.mutex);
5956 
5957 	bdev = bdev_get_by_name(bdev_name);
5958 
5959 	if (bdev == NULL) {
5960 		SPDK_NOTICELOG("Currently unable to find bdev with name: %s\n", bdev_name);
5961 		pthread_mutex_unlock(&g_bdev_mgr.mutex);
5962 		return -ENODEV;
5963 	}
5964 
5965 	desc = calloc(1, sizeof(*desc));
5966 	if (desc == NULL) {
5967 		SPDK_ERRLOG("Failed to allocate memory for bdev descriptor\n");
5968 		pthread_mutex_unlock(&g_bdev_mgr.mutex);
5969 		return -ENOMEM;
5970 	}
5971 
5972 	TAILQ_INIT(&desc->pending_media_events);
5973 	TAILQ_INIT(&desc->free_media_events);
5974 
5975 	desc->callback.event_fn = event_cb;
5976 	desc->callback.ctx = event_ctx;
5977 	pthread_mutex_init(&desc->mutex, NULL);
5978 
5979 	if (bdev->media_events) {
5980 		desc->media_events_buffer = calloc(MEDIA_EVENT_POOL_SIZE,
5981 						   sizeof(*desc->media_events_buffer));
5982 		if (desc->media_events_buffer == NULL) {
5983 			SPDK_ERRLOG("Failed to initialize media event pool\n");
5984 			bdev_desc_free(desc);
5985 			pthread_mutex_unlock(&g_bdev_mgr.mutex);
5986 			return -ENOMEM;
5987 		}
5988 
5989 		for (event_id = 0; event_id < MEDIA_EVENT_POOL_SIZE; ++event_id) {
5990 			TAILQ_INSERT_TAIL(&desc->free_media_events,
5991 					  &desc->media_events_buffer[event_id], tailq);
5992 		}
5993 	}
5994 
5995 	rc = bdev_open(bdev, write, desc);
5996 	if (rc != 0) {
5997 		bdev_desc_free(desc);
5998 		desc = NULL;
5999 	}
6000 
6001 	*_desc = desc;
6002 
6003 	pthread_mutex_unlock(&g_bdev_mgr.mutex);
6004 
6005 	return rc;
6006 }
6007 
6008 void
6009 spdk_bdev_close(struct spdk_bdev_desc *desc)
6010 {
6011 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
6012 	int rc;
6013 
6014 	SPDK_DEBUGLOG(bdev, "Closing descriptor %p for bdev %s on thread %p\n", desc, bdev->name,
6015 		      spdk_get_thread());
6016 
6017 	assert(desc->thread == spdk_get_thread());
6018 
6019 	spdk_poller_unregister(&desc->io_timeout_poller);
6020 
6021 	pthread_mutex_lock(&g_bdev_mgr.mutex);
6022 	pthread_mutex_lock(&bdev->internal.mutex);
6023 	pthread_mutex_lock(&desc->mutex);
6024 
6025 	TAILQ_REMOVE(&bdev->internal.open_descs, desc, link);
6026 
6027 	desc->closed = true;
6028 
6029 	if (0 == desc->refs) {
6030 		pthread_mutex_unlock(&desc->mutex);
6031 		bdev_desc_free(desc);
6032 	} else {
6033 		pthread_mutex_unlock(&desc->mutex);
6034 	}
6035 
6036 	/* If no more descriptors, kill QoS channel */
6037 	if (bdev->internal.qos && TAILQ_EMPTY(&bdev->internal.open_descs)) {
6038 		SPDK_DEBUGLOG(bdev, "Closed last descriptor for bdev %s on thread %p. Stopping QoS.\n",
6039 			      bdev->name, spdk_get_thread());
6040 
6041 		if (bdev_qos_destroy(bdev)) {
6042 			/* There isn't anything we can do to recover here. Just let the
6043 			 * old QoS poller keep running. The QoS handling won't change
6044 			 * cores when the user allocates a new channel, but it won't break. */
6045 			SPDK_ERRLOG("Unable to shut down QoS poller. It will continue running on the current thread.\n");
6046 		}
6047 	}
6048 
6049 	spdk_bdev_set_qd_sampling_period(bdev, 0);
6050 
6051 	if (bdev->internal.status == SPDK_BDEV_STATUS_REMOVING && TAILQ_EMPTY(&bdev->internal.open_descs)) {
6052 		rc = bdev_unregister_unsafe(bdev);
6053 		pthread_mutex_unlock(&bdev->internal.mutex);
6054 		pthread_mutex_unlock(&g_bdev_mgr.mutex);
6055 
6056 		if (rc == 0) {
6057 			spdk_io_device_unregister(__bdev_to_io_dev(bdev), bdev_destroy_cb);
6058 		}
6059 	} else {
6060 		pthread_mutex_unlock(&bdev->internal.mutex);
6061 		pthread_mutex_unlock(&g_bdev_mgr.mutex);
6062 	}
6063 }
6064 
6065 int
6066 spdk_bdev_module_claim_bdev(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc,
6067 			    struct spdk_bdev_module *module)
6068 {
6069 	if (bdev->internal.claim_module != NULL) {
6070 		SPDK_ERRLOG("bdev %s already claimed by module %s\n", bdev->name,
6071 			    bdev->internal.claim_module->name);
6072 		return -EPERM;
6073 	}
6074 
6075 	if (desc && !desc->write) {
6076 		desc->write = true;
6077 	}
6078 
6079 	bdev->internal.claim_module = module;
6080 	return 0;
6081 }
6082 
6083 void
6084 spdk_bdev_module_release_bdev(struct spdk_bdev *bdev)
6085 {
6086 	assert(bdev->internal.claim_module != NULL);
6087 	bdev->internal.claim_module = NULL;
6088 }
6089 
6090 struct spdk_bdev *
6091 spdk_bdev_desc_get_bdev(struct spdk_bdev_desc *desc)
6092 {
6093 	assert(desc != NULL);
6094 	return desc->bdev;
6095 }
6096 
6097 void
6098 spdk_bdev_io_get_iovec(struct spdk_bdev_io *bdev_io, struct iovec **iovp, int *iovcntp)
6099 {
6100 	struct iovec *iovs;
6101 	int iovcnt;
6102 
6103 	if (bdev_io == NULL) {
6104 		return;
6105 	}
6106 
6107 	switch (bdev_io->type) {
6108 	case SPDK_BDEV_IO_TYPE_READ:
6109 	case SPDK_BDEV_IO_TYPE_WRITE:
6110 	case SPDK_BDEV_IO_TYPE_ZCOPY:
6111 		iovs = bdev_io->u.bdev.iovs;
6112 		iovcnt = bdev_io->u.bdev.iovcnt;
6113 		break;
6114 	default:
6115 		iovs = NULL;
6116 		iovcnt = 0;
6117 		break;
6118 	}
6119 
6120 	if (iovp) {
6121 		*iovp = iovs;
6122 	}
6123 	if (iovcntp) {
6124 		*iovcntp = iovcnt;
6125 	}
6126 }
6127 
6128 void *
6129 spdk_bdev_io_get_md_buf(struct spdk_bdev_io *bdev_io)
6130 {
6131 	if (bdev_io == NULL) {
6132 		return NULL;
6133 	}
6134 
6135 	if (!spdk_bdev_is_md_separate(bdev_io->bdev)) {
6136 		return NULL;
6137 	}
6138 
6139 	if (bdev_io->type == SPDK_BDEV_IO_TYPE_READ ||
6140 	    bdev_io->type == SPDK_BDEV_IO_TYPE_WRITE) {
6141 		return bdev_io->u.bdev.md_buf;
6142 	}
6143 
6144 	return NULL;
6145 }
6146 
6147 void *
6148 spdk_bdev_io_get_cb_arg(struct spdk_bdev_io *bdev_io)
6149 {
6150 	if (bdev_io == NULL) {
6151 		assert(false);
6152 		return NULL;
6153 	}
6154 
6155 	return bdev_io->internal.caller_ctx;
6156 }
6157 
6158 void
6159 spdk_bdev_module_list_add(struct spdk_bdev_module *bdev_module)
6160 {
6161 
6162 	if (spdk_bdev_module_list_find(bdev_module->name)) {
6163 		SPDK_ERRLOG("ERROR: module '%s' already registered.\n", bdev_module->name);
6164 		assert(false);
6165 	}
6166 
6167 	/*
6168 	 * Modules with examine callbacks must be initialized first, so they are
6169 	 *  ready to handle examine callbacks from later modules that will
6170 	 *  register physical bdevs.
6171 	 */
6172 	if (bdev_module->examine_config != NULL || bdev_module->examine_disk != NULL) {
6173 		TAILQ_INSERT_HEAD(&g_bdev_mgr.bdev_modules, bdev_module, internal.tailq);
6174 	} else {
6175 		TAILQ_INSERT_TAIL(&g_bdev_mgr.bdev_modules, bdev_module, internal.tailq);
6176 	}
6177 }
6178 
6179 struct spdk_bdev_module *
6180 spdk_bdev_module_list_find(const char *name)
6181 {
6182 	struct spdk_bdev_module *bdev_module;
6183 
6184 	TAILQ_FOREACH(bdev_module, &g_bdev_mgr.bdev_modules, internal.tailq) {
6185 		if (strcmp(name, bdev_module->name) == 0) {
6186 			break;
6187 		}
6188 	}
6189 
6190 	return bdev_module;
6191 }
6192 
6193 static void
6194 bdev_write_zero_buffer_next(void *_bdev_io)
6195 {
6196 	struct spdk_bdev_io *bdev_io = _bdev_io;
6197 	uint64_t num_bytes, num_blocks;
6198 	void *md_buf = NULL;
6199 	int rc;
6200 
6201 	num_bytes = spdk_min(_bdev_get_block_size_with_md(bdev_io->bdev) *
6202 			     bdev_io->u.bdev.split_remaining_num_blocks,
6203 			     ZERO_BUFFER_SIZE);
6204 	num_blocks = num_bytes / _bdev_get_block_size_with_md(bdev_io->bdev);
6205 
6206 	if (spdk_bdev_is_md_separate(bdev_io->bdev)) {
6207 		md_buf = (char *)g_bdev_mgr.zero_buffer +
6208 			 spdk_bdev_get_block_size(bdev_io->bdev) * num_blocks;
6209 	}
6210 
6211 	rc = bdev_write_blocks_with_md(bdev_io->internal.desc,
6212 				       spdk_io_channel_from_ctx(bdev_io->internal.ch),
6213 				       g_bdev_mgr.zero_buffer, md_buf,
6214 				       bdev_io->u.bdev.split_current_offset_blocks, num_blocks,
6215 				       bdev_write_zero_buffer_done, bdev_io);
6216 	if (rc == 0) {
6217 		bdev_io->u.bdev.split_remaining_num_blocks -= num_blocks;
6218 		bdev_io->u.bdev.split_current_offset_blocks += num_blocks;
6219 	} else if (rc == -ENOMEM) {
6220 		bdev_queue_io_wait_with_cb(bdev_io, bdev_write_zero_buffer_next);
6221 	} else {
6222 		bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED;
6223 		bdev_io->internal.cb(bdev_io, false, bdev_io->internal.caller_ctx);
6224 	}
6225 }
6226 
6227 static void
6228 bdev_write_zero_buffer_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
6229 {
6230 	struct spdk_bdev_io *parent_io = cb_arg;
6231 
6232 	spdk_bdev_free_io(bdev_io);
6233 
6234 	if (!success) {
6235 		parent_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED;
6236 		parent_io->internal.cb(parent_io, false, parent_io->internal.caller_ctx);
6237 		return;
6238 	}
6239 
6240 	if (parent_io->u.bdev.split_remaining_num_blocks == 0) {
6241 		parent_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS;
6242 		parent_io->internal.cb(parent_io, true, parent_io->internal.caller_ctx);
6243 		return;
6244 	}
6245 
6246 	bdev_write_zero_buffer_next(parent_io);
6247 }
6248 
6249 static void
6250 bdev_set_qos_limit_done(struct set_qos_limit_ctx *ctx, int status)
6251 {
6252 	pthread_mutex_lock(&ctx->bdev->internal.mutex);
6253 	ctx->bdev->internal.qos_mod_in_progress = false;
6254 	pthread_mutex_unlock(&ctx->bdev->internal.mutex);
6255 
6256 	if (ctx->cb_fn) {
6257 		ctx->cb_fn(ctx->cb_arg, status);
6258 	}
6259 	free(ctx);
6260 }
6261 
6262 static void
6263 bdev_disable_qos_done(void *cb_arg)
6264 {
6265 	struct set_qos_limit_ctx *ctx = cb_arg;
6266 	struct spdk_bdev *bdev = ctx->bdev;
6267 	struct spdk_bdev_io *bdev_io;
6268 	struct spdk_bdev_qos *qos;
6269 
6270 	pthread_mutex_lock(&bdev->internal.mutex);
6271 	qos = bdev->internal.qos;
6272 	bdev->internal.qos = NULL;
6273 	pthread_mutex_unlock(&bdev->internal.mutex);
6274 
6275 	while (!TAILQ_EMPTY(&qos->queued)) {
6276 		/* Send queued I/O back to their original thread for resubmission. */
6277 		bdev_io = TAILQ_FIRST(&qos->queued);
6278 		TAILQ_REMOVE(&qos->queued, bdev_io, internal.link);
6279 
6280 		if (bdev_io->internal.io_submit_ch) {
6281 			/*
6282 			 * Channel was changed when sending it to the QoS thread - change it back
6283 			 *  before sending it back to the original thread.
6284 			 */
6285 			bdev_io->internal.ch = bdev_io->internal.io_submit_ch;
6286 			bdev_io->internal.io_submit_ch = NULL;
6287 		}
6288 
6289 		spdk_thread_send_msg(spdk_bdev_io_get_thread(bdev_io),
6290 				     _bdev_io_submit, bdev_io);
6291 	}
6292 
6293 	if (qos->thread != NULL) {
6294 		spdk_put_io_channel(spdk_io_channel_from_ctx(qos->ch));
6295 		spdk_poller_unregister(&qos->poller);
6296 	}
6297 
6298 	free(qos);
6299 
6300 	bdev_set_qos_limit_done(ctx, 0);
6301 }
6302 
6303 static void
6304 bdev_disable_qos_msg_done(struct spdk_io_channel_iter *i, int status)
6305 {
6306 	void *io_device = spdk_io_channel_iter_get_io_device(i);
6307 	struct spdk_bdev *bdev = __bdev_from_io_dev(io_device);
6308 	struct set_qos_limit_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
6309 	struct spdk_thread *thread;
6310 
6311 	pthread_mutex_lock(&bdev->internal.mutex);
6312 	thread = bdev->internal.qos->thread;
6313 	pthread_mutex_unlock(&bdev->internal.mutex);
6314 
6315 	if (thread != NULL) {
6316 		spdk_thread_send_msg(thread, bdev_disable_qos_done, ctx);
6317 	} else {
6318 		bdev_disable_qos_done(ctx);
6319 	}
6320 }
6321 
6322 static void
6323 bdev_disable_qos_msg(struct spdk_io_channel_iter *i)
6324 {
6325 	struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i);
6326 	struct spdk_bdev_channel *bdev_ch = spdk_io_channel_get_ctx(ch);
6327 
6328 	bdev_ch->flags &= ~BDEV_CH_QOS_ENABLED;
6329 
6330 	spdk_for_each_channel_continue(i, 0);
6331 }
6332 
6333 static void
6334 bdev_update_qos_rate_limit_msg(void *cb_arg)
6335 {
6336 	struct set_qos_limit_ctx *ctx = cb_arg;
6337 	struct spdk_bdev *bdev = ctx->bdev;
6338 
6339 	pthread_mutex_lock(&bdev->internal.mutex);
6340 	bdev_qos_update_max_quota_per_timeslice(bdev->internal.qos);
6341 	pthread_mutex_unlock(&bdev->internal.mutex);
6342 
6343 	bdev_set_qos_limit_done(ctx, 0);
6344 }
6345 
6346 static void
6347 bdev_enable_qos_msg(struct spdk_io_channel_iter *i)
6348 {
6349 	void *io_device = spdk_io_channel_iter_get_io_device(i);
6350 	struct spdk_bdev *bdev = __bdev_from_io_dev(io_device);
6351 	struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i);
6352 	struct spdk_bdev_channel *bdev_ch = spdk_io_channel_get_ctx(ch);
6353 
6354 	pthread_mutex_lock(&bdev->internal.mutex);
6355 	bdev_enable_qos(bdev, bdev_ch);
6356 	pthread_mutex_unlock(&bdev->internal.mutex);
6357 	spdk_for_each_channel_continue(i, 0);
6358 }
6359 
6360 static void
6361 bdev_enable_qos_done(struct spdk_io_channel_iter *i, int status)
6362 {
6363 	struct set_qos_limit_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
6364 
6365 	bdev_set_qos_limit_done(ctx, status);
6366 }
6367 
6368 static void
6369 bdev_set_qos_rate_limits(struct spdk_bdev *bdev, uint64_t *limits)
6370 {
6371 	int i;
6372 
6373 	assert(bdev->internal.qos != NULL);
6374 
6375 	for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) {
6376 		if (limits[i] != SPDK_BDEV_QOS_LIMIT_NOT_DEFINED) {
6377 			bdev->internal.qos->rate_limits[i].limit = limits[i];
6378 
6379 			if (limits[i] == 0) {
6380 				bdev->internal.qos->rate_limits[i].limit =
6381 					SPDK_BDEV_QOS_LIMIT_NOT_DEFINED;
6382 			}
6383 		}
6384 	}
6385 }
6386 
6387 void
6388 spdk_bdev_set_qos_rate_limits(struct spdk_bdev *bdev, uint64_t *limits,
6389 			      void (*cb_fn)(void *cb_arg, int status), void *cb_arg)
6390 {
6391 	struct set_qos_limit_ctx	*ctx;
6392 	uint32_t			limit_set_complement;
6393 	uint64_t			min_limit_per_sec;
6394 	int				i;
6395 	bool				disable_rate_limit = true;
6396 
6397 	for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) {
6398 		if (limits[i] == SPDK_BDEV_QOS_LIMIT_NOT_DEFINED) {
6399 			continue;
6400 		}
6401 
6402 		if (limits[i] > 0) {
6403 			disable_rate_limit = false;
6404 		}
6405 
6406 		if (bdev_qos_is_iops_rate_limit(i) == true) {
6407 			min_limit_per_sec = SPDK_BDEV_QOS_MIN_IOS_PER_SEC;
6408 		} else {
6409 			/* Change from megabyte to byte rate limit */
6410 			limits[i] = limits[i] * 1024 * 1024;
6411 			min_limit_per_sec = SPDK_BDEV_QOS_MIN_BYTES_PER_SEC;
6412 		}
6413 
6414 		limit_set_complement = limits[i] % min_limit_per_sec;
6415 		if (limit_set_complement) {
6416 			SPDK_ERRLOG("Requested rate limit %" PRIu64 " is not a multiple of %" PRIu64 "\n",
6417 				    limits[i], min_limit_per_sec);
6418 			limits[i] += min_limit_per_sec - limit_set_complement;
6419 			SPDK_ERRLOG("Round up the rate limit to %" PRIu64 "\n", limits[i]);
6420 		}
6421 	}
6422 
6423 	ctx = calloc(1, sizeof(*ctx));
6424 	if (ctx == NULL) {
6425 		cb_fn(cb_arg, -ENOMEM);
6426 		return;
6427 	}
6428 
6429 	ctx->cb_fn = cb_fn;
6430 	ctx->cb_arg = cb_arg;
6431 	ctx->bdev = bdev;
6432 
6433 	pthread_mutex_lock(&bdev->internal.mutex);
6434 	if (bdev->internal.qos_mod_in_progress) {
6435 		pthread_mutex_unlock(&bdev->internal.mutex);
6436 		free(ctx);
6437 		cb_fn(cb_arg, -EAGAIN);
6438 		return;
6439 	}
6440 	bdev->internal.qos_mod_in_progress = true;
6441 
6442 	if (disable_rate_limit == true && bdev->internal.qos) {
6443 		for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) {
6444 			if (limits[i] == SPDK_BDEV_QOS_LIMIT_NOT_DEFINED &&
6445 			    (bdev->internal.qos->rate_limits[i].limit > 0 &&
6446 			     bdev->internal.qos->rate_limits[i].limit !=
6447 			     SPDK_BDEV_QOS_LIMIT_NOT_DEFINED)) {
6448 				disable_rate_limit = false;
6449 				break;
6450 			}
6451 		}
6452 	}
6453 
6454 	if (disable_rate_limit == false) {
6455 		if (bdev->internal.qos == NULL) {
6456 			bdev->internal.qos = calloc(1, sizeof(*bdev->internal.qos));
6457 			if (!bdev->internal.qos) {
6458 				pthread_mutex_unlock(&bdev->internal.mutex);
6459 				SPDK_ERRLOG("Unable to allocate memory for QoS tracking\n");
6460 				bdev_set_qos_limit_done(ctx, -ENOMEM);
6461 				return;
6462 			}
6463 		}
6464 
6465 		if (bdev->internal.qos->thread == NULL) {
6466 			/* Enabling */
6467 			bdev_set_qos_rate_limits(bdev, limits);
6468 
6469 			spdk_for_each_channel(__bdev_to_io_dev(bdev),
6470 					      bdev_enable_qos_msg, ctx,
6471 					      bdev_enable_qos_done);
6472 		} else {
6473 			/* Updating */
6474 			bdev_set_qos_rate_limits(bdev, limits);
6475 
6476 			spdk_thread_send_msg(bdev->internal.qos->thread,
6477 					     bdev_update_qos_rate_limit_msg, ctx);
6478 		}
6479 	} else {
6480 		if (bdev->internal.qos != NULL) {
6481 			bdev_set_qos_rate_limits(bdev, limits);
6482 
6483 			/* Disabling */
6484 			spdk_for_each_channel(__bdev_to_io_dev(bdev),
6485 					      bdev_disable_qos_msg, ctx,
6486 					      bdev_disable_qos_msg_done);
6487 		} else {
6488 			pthread_mutex_unlock(&bdev->internal.mutex);
6489 			bdev_set_qos_limit_done(ctx, 0);
6490 			return;
6491 		}
6492 	}
6493 
6494 	pthread_mutex_unlock(&bdev->internal.mutex);
6495 }
6496 
6497 struct spdk_bdev_histogram_ctx {
6498 	spdk_bdev_histogram_status_cb cb_fn;
6499 	void *cb_arg;
6500 	struct spdk_bdev *bdev;
6501 	int status;
6502 };
6503 
6504 static void
6505 bdev_histogram_disable_channel_cb(struct spdk_io_channel_iter *i, int status)
6506 {
6507 	struct spdk_bdev_histogram_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
6508 
6509 	pthread_mutex_lock(&ctx->bdev->internal.mutex);
6510 	ctx->bdev->internal.histogram_in_progress = false;
6511 	pthread_mutex_unlock(&ctx->bdev->internal.mutex);
6512 	ctx->cb_fn(ctx->cb_arg, ctx->status);
6513 	free(ctx);
6514 }
6515 
6516 static void
6517 bdev_histogram_disable_channel(struct spdk_io_channel_iter *i)
6518 {
6519 	struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i);
6520 	struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch);
6521 
6522 	if (ch->histogram != NULL) {
6523 		spdk_histogram_data_free(ch->histogram);
6524 		ch->histogram = NULL;
6525 	}
6526 	spdk_for_each_channel_continue(i, 0);
6527 }
6528 
6529 static void
6530 bdev_histogram_enable_channel_cb(struct spdk_io_channel_iter *i, int status)
6531 {
6532 	struct spdk_bdev_histogram_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
6533 
6534 	if (status != 0) {
6535 		ctx->status = status;
6536 		ctx->bdev->internal.histogram_enabled = false;
6537 		spdk_for_each_channel(__bdev_to_io_dev(ctx->bdev), bdev_histogram_disable_channel, ctx,
6538 				      bdev_histogram_disable_channel_cb);
6539 	} else {
6540 		pthread_mutex_lock(&ctx->bdev->internal.mutex);
6541 		ctx->bdev->internal.histogram_in_progress = false;
6542 		pthread_mutex_unlock(&ctx->bdev->internal.mutex);
6543 		ctx->cb_fn(ctx->cb_arg, ctx->status);
6544 		free(ctx);
6545 	}
6546 }
6547 
6548 static void
6549 bdev_histogram_enable_channel(struct spdk_io_channel_iter *i)
6550 {
6551 	struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i);
6552 	struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch);
6553 	int status = 0;
6554 
6555 	if (ch->histogram == NULL) {
6556 		ch->histogram = spdk_histogram_data_alloc();
6557 		if (ch->histogram == NULL) {
6558 			status = -ENOMEM;
6559 		}
6560 	}
6561 
6562 	spdk_for_each_channel_continue(i, status);
6563 }
6564 
6565 void
6566 spdk_bdev_histogram_enable(struct spdk_bdev *bdev, spdk_bdev_histogram_status_cb cb_fn,
6567 			   void *cb_arg, bool enable)
6568 {
6569 	struct spdk_bdev_histogram_ctx *ctx;
6570 
6571 	ctx = calloc(1, sizeof(struct spdk_bdev_histogram_ctx));
6572 	if (ctx == NULL) {
6573 		cb_fn(cb_arg, -ENOMEM);
6574 		return;
6575 	}
6576 
6577 	ctx->bdev = bdev;
6578 	ctx->status = 0;
6579 	ctx->cb_fn = cb_fn;
6580 	ctx->cb_arg = cb_arg;
6581 
6582 	pthread_mutex_lock(&bdev->internal.mutex);
6583 	if (bdev->internal.histogram_in_progress) {
6584 		pthread_mutex_unlock(&bdev->internal.mutex);
6585 		free(ctx);
6586 		cb_fn(cb_arg, -EAGAIN);
6587 		return;
6588 	}
6589 
6590 	bdev->internal.histogram_in_progress = true;
6591 	pthread_mutex_unlock(&bdev->internal.mutex);
6592 
6593 	bdev->internal.histogram_enabled = enable;
6594 
6595 	if (enable) {
6596 		/* Allocate histogram for each channel */
6597 		spdk_for_each_channel(__bdev_to_io_dev(bdev), bdev_histogram_enable_channel, ctx,
6598 				      bdev_histogram_enable_channel_cb);
6599 	} else {
6600 		spdk_for_each_channel(__bdev_to_io_dev(bdev), bdev_histogram_disable_channel, ctx,
6601 				      bdev_histogram_disable_channel_cb);
6602 	}
6603 }
6604 
6605 struct spdk_bdev_histogram_data_ctx {
6606 	spdk_bdev_histogram_data_cb cb_fn;
6607 	void *cb_arg;
6608 	struct spdk_bdev *bdev;
6609 	/** merged histogram data from all channels */
6610 	struct spdk_histogram_data	*histogram;
6611 };
6612 
6613 static void
6614 bdev_histogram_get_channel_cb(struct spdk_io_channel_iter *i, int status)
6615 {
6616 	struct spdk_bdev_histogram_data_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
6617 
6618 	ctx->cb_fn(ctx->cb_arg, status, ctx->histogram);
6619 	free(ctx);
6620 }
6621 
6622 static void
6623 bdev_histogram_get_channel(struct spdk_io_channel_iter *i)
6624 {
6625 	struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i);
6626 	struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch);
6627 	struct spdk_bdev_histogram_data_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
6628 	int status = 0;
6629 
6630 	if (ch->histogram == NULL) {
6631 		status = -EFAULT;
6632 	} else {
6633 		spdk_histogram_data_merge(ctx->histogram, ch->histogram);
6634 	}
6635 
6636 	spdk_for_each_channel_continue(i, status);
6637 }
6638 
6639 void
6640 spdk_bdev_histogram_get(struct spdk_bdev *bdev, struct spdk_histogram_data *histogram,
6641 			spdk_bdev_histogram_data_cb cb_fn,
6642 			void *cb_arg)
6643 {
6644 	struct spdk_bdev_histogram_data_ctx *ctx;
6645 
6646 	ctx = calloc(1, sizeof(struct spdk_bdev_histogram_data_ctx));
6647 	if (ctx == NULL) {
6648 		cb_fn(cb_arg, -ENOMEM, NULL);
6649 		return;
6650 	}
6651 
6652 	ctx->bdev = bdev;
6653 	ctx->cb_fn = cb_fn;
6654 	ctx->cb_arg = cb_arg;
6655 
6656 	ctx->histogram = histogram;
6657 
6658 	spdk_for_each_channel(__bdev_to_io_dev(bdev), bdev_histogram_get_channel, ctx,
6659 			      bdev_histogram_get_channel_cb);
6660 }
6661 
6662 size_t
6663 spdk_bdev_get_media_events(struct spdk_bdev_desc *desc, struct spdk_bdev_media_event *events,
6664 			   size_t max_events)
6665 {
6666 	struct media_event_entry *entry;
6667 	size_t num_events = 0;
6668 
6669 	for (; num_events < max_events; ++num_events) {
6670 		entry = TAILQ_FIRST(&desc->pending_media_events);
6671 		if (entry == NULL) {
6672 			break;
6673 		}
6674 
6675 		events[num_events] = entry->event;
6676 		TAILQ_REMOVE(&desc->pending_media_events, entry, tailq);
6677 		TAILQ_INSERT_TAIL(&desc->free_media_events, entry, tailq);
6678 	}
6679 
6680 	return num_events;
6681 }
6682 
6683 int
6684 spdk_bdev_push_media_events(struct spdk_bdev *bdev, const struct spdk_bdev_media_event *events,
6685 			    size_t num_events)
6686 {
6687 	struct spdk_bdev_desc *desc;
6688 	struct media_event_entry *entry;
6689 	size_t event_id;
6690 	int rc = 0;
6691 
6692 	assert(bdev->media_events);
6693 
6694 	pthread_mutex_lock(&bdev->internal.mutex);
6695 	TAILQ_FOREACH(desc, &bdev->internal.open_descs, link) {
6696 		if (desc->write) {
6697 			break;
6698 		}
6699 	}
6700 
6701 	if (desc == NULL || desc->media_events_buffer == NULL) {
6702 		rc = -ENODEV;
6703 		goto out;
6704 	}
6705 
6706 	for (event_id = 0; event_id < num_events; ++event_id) {
6707 		entry = TAILQ_FIRST(&desc->free_media_events);
6708 		if (entry == NULL) {
6709 			break;
6710 		}
6711 
6712 		TAILQ_REMOVE(&desc->free_media_events, entry, tailq);
6713 		TAILQ_INSERT_TAIL(&desc->pending_media_events, entry, tailq);
6714 		entry->event = events[event_id];
6715 	}
6716 
6717 	rc = event_id;
6718 out:
6719 	pthread_mutex_unlock(&bdev->internal.mutex);
6720 	return rc;
6721 }
6722 
6723 void
6724 spdk_bdev_notify_media_management(struct spdk_bdev *bdev)
6725 {
6726 	struct spdk_bdev_desc *desc;
6727 
6728 	pthread_mutex_lock(&bdev->internal.mutex);
6729 	TAILQ_FOREACH(desc, &bdev->internal.open_descs, link) {
6730 		if (!TAILQ_EMPTY(&desc->pending_media_events)) {
6731 			desc->callback.event_fn(SPDK_BDEV_EVENT_MEDIA_MANAGEMENT, bdev,
6732 						desc->callback.ctx);
6733 		}
6734 	}
6735 	pthread_mutex_unlock(&bdev->internal.mutex);
6736 }
6737 
6738 struct locked_lba_range_ctx {
6739 	struct lba_range		range;
6740 	struct spdk_bdev		*bdev;
6741 	struct lba_range		*current_range;
6742 	struct lba_range		*owner_range;
6743 	struct spdk_poller		*poller;
6744 	lock_range_cb			cb_fn;
6745 	void				*cb_arg;
6746 };
6747 
6748 static void
6749 bdev_lock_error_cleanup_cb(struct spdk_io_channel_iter *i, int status)
6750 {
6751 	struct locked_lba_range_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
6752 
6753 	ctx->cb_fn(ctx->cb_arg, -ENOMEM);
6754 	free(ctx);
6755 }
6756 
6757 static void
6758 bdev_unlock_lba_range_get_channel(struct spdk_io_channel_iter *i);
6759 
6760 static void
6761 bdev_lock_lba_range_cb(struct spdk_io_channel_iter *i, int status)
6762 {
6763 	struct locked_lba_range_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
6764 	struct spdk_bdev *bdev = ctx->bdev;
6765 
6766 	if (status == -ENOMEM) {
6767 		/* One of the channels could not allocate a range object.
6768 		 * So we have to go back and clean up any ranges that were
6769 		 * allocated successfully before we return error status to
6770 		 * the caller.  We can reuse the unlock function to do that
6771 		 * clean up.
6772 		 */
6773 		spdk_for_each_channel(__bdev_to_io_dev(bdev),
6774 				      bdev_unlock_lba_range_get_channel, ctx,
6775 				      bdev_lock_error_cleanup_cb);
6776 		return;
6777 	}
6778 
6779 	/* All channels have locked this range and no I/O overlapping the range
6780 	 * are outstanding!  Set the owner_ch for the range object for the
6781 	 * locking channel, so that this channel will know that it is allowed
6782 	 * to write to this range.
6783 	 */
6784 	ctx->owner_range->owner_ch = ctx->range.owner_ch;
6785 	ctx->cb_fn(ctx->cb_arg, status);
6786 
6787 	/* Don't free the ctx here.  Its range is in the bdev's global list of
6788 	 * locked ranges still, and will be removed and freed when this range
6789 	 * is later unlocked.
6790 	 */
6791 }
6792 
6793 static int
6794 bdev_lock_lba_range_check_io(void *_i)
6795 {
6796 	struct spdk_io_channel_iter *i = _i;
6797 	struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i);
6798 	struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch);
6799 	struct locked_lba_range_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
6800 	struct lba_range *range = ctx->current_range;
6801 	struct spdk_bdev_io *bdev_io;
6802 
6803 	spdk_poller_unregister(&ctx->poller);
6804 
6805 	/* The range is now in the locked_ranges, so no new IO can be submitted to this
6806 	 * range.  But we need to wait until any outstanding IO overlapping with this range
6807 	 * are completed.
6808 	 */
6809 	TAILQ_FOREACH(bdev_io, &ch->io_submitted, internal.ch_link) {
6810 		if (bdev_io_range_is_locked(bdev_io, range)) {
6811 			ctx->poller = SPDK_POLLER_REGISTER(bdev_lock_lba_range_check_io, i, 100);
6812 			return SPDK_POLLER_BUSY;
6813 		}
6814 	}
6815 
6816 	spdk_for_each_channel_continue(i, 0);
6817 	return SPDK_POLLER_BUSY;
6818 }
6819 
6820 static void
6821 bdev_lock_lba_range_get_channel(struct spdk_io_channel_iter *i)
6822 {
6823 	struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i);
6824 	struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch);
6825 	struct locked_lba_range_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
6826 	struct lba_range *range;
6827 
6828 	TAILQ_FOREACH(range, &ch->locked_ranges, tailq) {
6829 		if (range->length == ctx->range.length &&
6830 		    range->offset == ctx->range.offset &&
6831 		    range->locked_ctx == ctx->range.locked_ctx) {
6832 			/* This range already exists on this channel, so don't add
6833 			 * it again.  This can happen when a new channel is created
6834 			 * while the for_each_channel operation is in progress.
6835 			 * Do not check for outstanding I/O in that case, since the
6836 			 * range was locked before any I/O could be submitted to the
6837 			 * new channel.
6838 			 */
6839 			spdk_for_each_channel_continue(i, 0);
6840 			return;
6841 		}
6842 	}
6843 
6844 	range = calloc(1, sizeof(*range));
6845 	if (range == NULL) {
6846 		spdk_for_each_channel_continue(i, -ENOMEM);
6847 		return;
6848 	}
6849 
6850 	range->length = ctx->range.length;
6851 	range->offset = ctx->range.offset;
6852 	range->locked_ctx = ctx->range.locked_ctx;
6853 	ctx->current_range = range;
6854 	if (ctx->range.owner_ch == ch) {
6855 		/* This is the range object for the channel that will hold
6856 		 * the lock.  Store it in the ctx object so that we can easily
6857 		 * set its owner_ch after the lock is finally acquired.
6858 		 */
6859 		ctx->owner_range = range;
6860 	}
6861 	TAILQ_INSERT_TAIL(&ch->locked_ranges, range, tailq);
6862 	bdev_lock_lba_range_check_io(i);
6863 }
6864 
6865 static void
6866 bdev_lock_lba_range_ctx(struct spdk_bdev *bdev, struct locked_lba_range_ctx *ctx)
6867 {
6868 	assert(spdk_get_thread() == spdk_io_channel_get_thread(ctx->range.owner_ch->channel));
6869 
6870 	/* We will add a copy of this range to each channel now. */
6871 	spdk_for_each_channel(__bdev_to_io_dev(bdev), bdev_lock_lba_range_get_channel, ctx,
6872 			      bdev_lock_lba_range_cb);
6873 }
6874 
6875 static bool
6876 bdev_lba_range_overlaps_tailq(struct lba_range *range, lba_range_tailq_t *tailq)
6877 {
6878 	struct lba_range *r;
6879 
6880 	TAILQ_FOREACH(r, tailq, tailq) {
6881 		if (bdev_lba_range_overlapped(range, r)) {
6882 			return true;
6883 		}
6884 	}
6885 	return false;
6886 }
6887 
6888 static int
6889 bdev_lock_lba_range(struct spdk_bdev_desc *desc, struct spdk_io_channel *_ch,
6890 		    uint64_t offset, uint64_t length,
6891 		    lock_range_cb cb_fn, void *cb_arg)
6892 {
6893 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
6894 	struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch);
6895 	struct locked_lba_range_ctx *ctx;
6896 
6897 	if (cb_arg == NULL) {
6898 		SPDK_ERRLOG("cb_arg must not be NULL\n");
6899 		return -EINVAL;
6900 	}
6901 
6902 	ctx = calloc(1, sizeof(*ctx));
6903 	if (ctx == NULL) {
6904 		return -ENOMEM;
6905 	}
6906 
6907 	ctx->range.offset = offset;
6908 	ctx->range.length = length;
6909 	ctx->range.owner_ch = ch;
6910 	ctx->range.locked_ctx = cb_arg;
6911 	ctx->bdev = bdev;
6912 	ctx->cb_fn = cb_fn;
6913 	ctx->cb_arg = cb_arg;
6914 
6915 	pthread_mutex_lock(&bdev->internal.mutex);
6916 	if (bdev_lba_range_overlaps_tailq(&ctx->range, &bdev->internal.locked_ranges)) {
6917 		/* There is an active lock overlapping with this range.
6918 		 * Put it on the pending list until this range no
6919 		 * longer overlaps with another.
6920 		 */
6921 		TAILQ_INSERT_TAIL(&bdev->internal.pending_locked_ranges, &ctx->range, tailq);
6922 	} else {
6923 		TAILQ_INSERT_TAIL(&bdev->internal.locked_ranges, &ctx->range, tailq);
6924 		bdev_lock_lba_range_ctx(bdev, ctx);
6925 	}
6926 	pthread_mutex_unlock(&bdev->internal.mutex);
6927 	return 0;
6928 }
6929 
6930 static void
6931 bdev_lock_lba_range_ctx_msg(void *_ctx)
6932 {
6933 	struct locked_lba_range_ctx *ctx = _ctx;
6934 
6935 	bdev_lock_lba_range_ctx(ctx->bdev, ctx);
6936 }
6937 
6938 static void
6939 bdev_unlock_lba_range_cb(struct spdk_io_channel_iter *i, int status)
6940 {
6941 	struct locked_lba_range_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
6942 	struct locked_lba_range_ctx *pending_ctx;
6943 	struct spdk_bdev_channel *ch = ctx->range.owner_ch;
6944 	struct spdk_bdev *bdev = ch->bdev;
6945 	struct lba_range *range, *tmp;
6946 
6947 	pthread_mutex_lock(&bdev->internal.mutex);
6948 	/* Check if there are any pending locked ranges that overlap with this range
6949 	 * that was just unlocked.  If there are, check that it doesn't overlap with any
6950 	 * other locked ranges before calling bdev_lock_lba_range_ctx which will start
6951 	 * the lock process.
6952 	 */
6953 	TAILQ_FOREACH_SAFE(range, &bdev->internal.pending_locked_ranges, tailq, tmp) {
6954 		if (bdev_lba_range_overlapped(range, &ctx->range) &&
6955 		    !bdev_lba_range_overlaps_tailq(range, &bdev->internal.locked_ranges)) {
6956 			TAILQ_REMOVE(&bdev->internal.pending_locked_ranges, range, tailq);
6957 			pending_ctx = SPDK_CONTAINEROF(range, struct locked_lba_range_ctx, range);
6958 			TAILQ_INSERT_TAIL(&bdev->internal.locked_ranges, range, tailq);
6959 			spdk_thread_send_msg(spdk_io_channel_get_thread(pending_ctx->range.owner_ch->channel),
6960 					     bdev_lock_lba_range_ctx_msg, pending_ctx);
6961 		}
6962 	}
6963 	pthread_mutex_unlock(&bdev->internal.mutex);
6964 
6965 	ctx->cb_fn(ctx->cb_arg, status);
6966 	free(ctx);
6967 }
6968 
6969 static void
6970 bdev_unlock_lba_range_get_channel(struct spdk_io_channel_iter *i)
6971 {
6972 	struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i);
6973 	struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch);
6974 	struct locked_lba_range_ctx *ctx = spdk_io_channel_iter_get_ctx(i);
6975 	TAILQ_HEAD(, spdk_bdev_io) io_locked;
6976 	struct spdk_bdev_io *bdev_io;
6977 	struct lba_range *range;
6978 
6979 	TAILQ_FOREACH(range, &ch->locked_ranges, tailq) {
6980 		if (ctx->range.offset == range->offset &&
6981 		    ctx->range.length == range->length &&
6982 		    ctx->range.locked_ctx == range->locked_ctx) {
6983 			TAILQ_REMOVE(&ch->locked_ranges, range, tailq);
6984 			free(range);
6985 			break;
6986 		}
6987 	}
6988 
6989 	/* Note: we should almost always be able to assert that the range specified
6990 	 * was found.  But there are some very rare corner cases where a new channel
6991 	 * gets created simultaneously with a range unlock, where this function
6992 	 * would execute on that new channel and wouldn't have the range.
6993 	 * We also use this to clean up range allocations when a later allocation
6994 	 * fails in the locking path.
6995 	 * So we can't actually assert() here.
6996 	 */
6997 
6998 	/* Swap the locked IO into a temporary list, and then try to submit them again.
6999 	 * We could hyper-optimize this to only resubmit locked I/O that overlap
7000 	 * with the range that was just unlocked, but this isn't a performance path so
7001 	 * we go for simplicity here.
7002 	 */
7003 	TAILQ_INIT(&io_locked);
7004 	TAILQ_SWAP(&ch->io_locked, &io_locked, spdk_bdev_io, internal.ch_link);
7005 	while (!TAILQ_EMPTY(&io_locked)) {
7006 		bdev_io = TAILQ_FIRST(&io_locked);
7007 		TAILQ_REMOVE(&io_locked, bdev_io, internal.ch_link);
7008 		bdev_io_submit(bdev_io);
7009 	}
7010 
7011 	spdk_for_each_channel_continue(i, 0);
7012 }
7013 
7014 static int
7015 bdev_unlock_lba_range(struct spdk_bdev_desc *desc, struct spdk_io_channel *_ch,
7016 		      uint64_t offset, uint64_t length,
7017 		      lock_range_cb cb_fn, void *cb_arg)
7018 {
7019 	struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc);
7020 	struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch);
7021 	struct locked_lba_range_ctx *ctx;
7022 	struct lba_range *range;
7023 	bool range_found = false;
7024 
7025 	/* Let's make sure the specified channel actually has a lock on
7026 	 * the specified range.  Note that the range must match exactly.
7027 	 */
7028 	TAILQ_FOREACH(range, &ch->locked_ranges, tailq) {
7029 		if (range->offset == offset && range->length == length &&
7030 		    range->owner_ch == ch && range->locked_ctx == cb_arg) {
7031 			range_found = true;
7032 			break;
7033 		}
7034 	}
7035 
7036 	if (!range_found) {
7037 		return -EINVAL;
7038 	}
7039 
7040 	pthread_mutex_lock(&bdev->internal.mutex);
7041 	/* We confirmed that this channel has locked the specified range.  To
7042 	 * start the unlock the process, we find the range in the bdev's locked_ranges
7043 	 * and remove it.  This ensures new channels don't inherit the locked range.
7044 	 * Then we will send a message to each channel (including the one specified
7045 	 * here) to remove the range from its per-channel list.
7046 	 */
7047 	TAILQ_FOREACH(range, &bdev->internal.locked_ranges, tailq) {
7048 		if (range->offset == offset && range->length == length &&
7049 		    range->locked_ctx == cb_arg) {
7050 			break;
7051 		}
7052 	}
7053 	if (range == NULL) {
7054 		assert(false);
7055 		pthread_mutex_unlock(&bdev->internal.mutex);
7056 		return -EINVAL;
7057 	}
7058 	TAILQ_REMOVE(&bdev->internal.locked_ranges, range, tailq);
7059 	ctx = SPDK_CONTAINEROF(range, struct locked_lba_range_ctx, range);
7060 	pthread_mutex_unlock(&bdev->internal.mutex);
7061 
7062 	ctx->cb_fn = cb_fn;
7063 	ctx->cb_arg = cb_arg;
7064 
7065 	spdk_for_each_channel(__bdev_to_io_dev(bdev), bdev_unlock_lba_range_get_channel, ctx,
7066 			      bdev_unlock_lba_range_cb);
7067 	return 0;
7068 }
7069 
7070 int
7071 spdk_bdev_get_memory_domains(struct spdk_bdev *bdev, struct spdk_memory_domain **domains,
7072 			     int array_size)
7073 {
7074 	if (!bdev) {
7075 		return -EINVAL;
7076 	}
7077 
7078 	if (bdev->fn_table->get_memory_domains) {
7079 		return bdev->fn_table->get_memory_domains(bdev->ctxt, domains, array_size);
7080 	}
7081 
7082 	return 0;
7083 }
7084 
7085 SPDK_LOG_REGISTER_COMPONENT(bdev)
7086 
7087 SPDK_TRACE_REGISTER_FN(bdev_trace, "bdev", TRACE_GROUP_BDEV)
7088 {
7089 	spdk_trace_register_owner(OWNER_BDEV, 'b');
7090 	spdk_trace_register_object(OBJECT_BDEV_IO, 'i');
7091 	spdk_trace_register_description("BDEV_IO_START", TRACE_BDEV_IO_START, OWNER_BDEV,
7092 					OBJECT_BDEV_IO, 1,
7093 					SPDK_TRACE_ARG_TYPE_INT, "type");
7094 	spdk_trace_register_description("BDEV_IO_DONE", TRACE_BDEV_IO_DONE, OWNER_BDEV,
7095 					OBJECT_BDEV_IO, 0,
7096 					SPDK_TRACE_ARG_TYPE_INT, "");
7097 }
7098