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_fini_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_fini_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_fini_done(void) 1551 { 1552 if (spdk_get_thread() != g_fini_thread) { 1553 spdk_thread_send_msg(g_fini_thread, bdev_module_fini_iter, NULL); 1554 } else { 1555 bdev_module_fini_iter(NULL); 1556 } 1557 } 1558 1559 /* Deprecated */ 1560 void 1561 spdk_bdev_module_finish_done(void) 1562 { 1563 SPDK_NOTICELOG("spdk_bdev_module_finish_done() is deprecated, please use spdk_bdev_module_fini_done().\n"); 1564 spdk_bdev_module_fini_done(); 1565 } 1566 1567 static void 1568 bdev_finish_unregister_bdevs_iter(void *cb_arg, int bdeverrno) 1569 { 1570 struct spdk_bdev *bdev = cb_arg; 1571 1572 if (bdeverrno && bdev) { 1573 SPDK_WARNLOG("Unable to unregister bdev '%s' during spdk_bdev_finish()\n", 1574 bdev->name); 1575 1576 /* 1577 * Since the call to spdk_bdev_unregister() failed, we have no way to free this 1578 * bdev; try to continue by manually removing this bdev from the list and continue 1579 * with the next bdev in the list. 1580 */ 1581 TAILQ_REMOVE(&g_bdev_mgr.bdevs, bdev, internal.link); 1582 } 1583 1584 if (TAILQ_EMPTY(&g_bdev_mgr.bdevs)) { 1585 SPDK_DEBUGLOG(bdev, "Done unregistering bdevs\n"); 1586 /* 1587 * Bdev module finish need to be deferred as we might be in the middle of some context 1588 * (like bdev part free) that will use this bdev (or private bdev driver ctx data) 1589 * after returning. 1590 */ 1591 spdk_thread_send_msg(spdk_get_thread(), bdev_module_fini_iter, NULL); 1592 return; 1593 } 1594 1595 /* 1596 * Unregister last unclaimed bdev in the list, to ensure that bdev subsystem 1597 * shutdown proceeds top-down. The goal is to give virtual bdevs an opportunity 1598 * to detect clean shutdown as opposed to run-time hot removal of the underlying 1599 * base bdevs. 1600 * 1601 * Also, walk the list in the reverse order. 1602 */ 1603 for (bdev = TAILQ_LAST(&g_bdev_mgr.bdevs, spdk_bdev_list); 1604 bdev; bdev = TAILQ_PREV(bdev, spdk_bdev_list, internal.link)) { 1605 if (bdev->internal.claim_module != NULL) { 1606 SPDK_DEBUGLOG(bdev, "Skipping claimed bdev '%s'(<-'%s').\n", 1607 bdev->name, bdev->internal.claim_module->name); 1608 continue; 1609 } 1610 1611 SPDK_DEBUGLOG(bdev, "Unregistering bdev '%s'\n", bdev->name); 1612 spdk_bdev_unregister(bdev, bdev_finish_unregister_bdevs_iter, bdev); 1613 return; 1614 } 1615 1616 /* 1617 * If any bdev fails to unclaim underlying bdev properly, we may face the 1618 * case of bdev list consisting of claimed bdevs only (if claims are managed 1619 * correctly, this would mean there's a loop in the claims graph which is 1620 * clearly impossible). Warn and unregister last bdev on the list then. 1621 */ 1622 for (bdev = TAILQ_LAST(&g_bdev_mgr.bdevs, spdk_bdev_list); 1623 bdev; bdev = TAILQ_PREV(bdev, spdk_bdev_list, internal.link)) { 1624 SPDK_WARNLOG("Unregistering claimed bdev '%s'!\n", bdev->name); 1625 spdk_bdev_unregister(bdev, bdev_finish_unregister_bdevs_iter, bdev); 1626 return; 1627 } 1628 } 1629 1630 static void 1631 bdev_module_fini_start_iter(void *arg) 1632 { 1633 struct spdk_bdev_module *bdev_module; 1634 1635 if (!g_resume_bdev_module) { 1636 bdev_module = TAILQ_LAST(&g_bdev_mgr.bdev_modules, bdev_module_list); 1637 } else { 1638 bdev_module = TAILQ_PREV(g_resume_bdev_module, bdev_module_list, internal.tailq); 1639 } 1640 1641 while (bdev_module) { 1642 if (bdev_module->async_fini_start) { 1643 /* Save our place so we can resume later. We must 1644 * save the variable here, before calling fini_start() 1645 * below, because in some cases the module may immediately 1646 * call spdk_bdev_module_fini_start_done() and re-enter 1647 * this function to continue iterating. */ 1648 g_resume_bdev_module = bdev_module; 1649 } 1650 1651 if (bdev_module->fini_start) { 1652 bdev_module->fini_start(); 1653 } 1654 1655 if (bdev_module->async_fini_start) { 1656 return; 1657 } 1658 1659 bdev_module = TAILQ_PREV(bdev_module, bdev_module_list, internal.tailq); 1660 } 1661 1662 g_resume_bdev_module = NULL; 1663 1664 bdev_finish_unregister_bdevs_iter(NULL, 0); 1665 } 1666 1667 void 1668 spdk_bdev_module_fini_start_done(void) 1669 { 1670 if (spdk_get_thread() != g_fini_thread) { 1671 spdk_thread_send_msg(g_fini_thread, bdev_module_fini_start_iter, NULL); 1672 } else { 1673 bdev_module_fini_start_iter(NULL); 1674 } 1675 } 1676 1677 void 1678 spdk_bdev_finish(spdk_bdev_fini_cb cb_fn, void *cb_arg) 1679 { 1680 assert(cb_fn != NULL); 1681 1682 g_fini_thread = spdk_get_thread(); 1683 1684 g_fini_cb_fn = cb_fn; 1685 g_fini_cb_arg = cb_arg; 1686 1687 bdev_module_fini_start_iter(NULL); 1688 } 1689 1690 struct spdk_bdev_io * 1691 bdev_channel_get_io(struct spdk_bdev_channel *channel) 1692 { 1693 struct spdk_bdev_mgmt_channel *ch = channel->shared_resource->mgmt_ch; 1694 struct spdk_bdev_io *bdev_io; 1695 1696 if (ch->per_thread_cache_count > 0) { 1697 bdev_io = STAILQ_FIRST(&ch->per_thread_cache); 1698 STAILQ_REMOVE_HEAD(&ch->per_thread_cache, internal.buf_link); 1699 ch->per_thread_cache_count--; 1700 } else if (spdk_unlikely(!TAILQ_EMPTY(&ch->io_wait_queue))) { 1701 /* 1702 * Don't try to look for bdev_ios in the global pool if there are 1703 * waiters on bdev_ios - we don't want this caller to jump the line. 1704 */ 1705 bdev_io = NULL; 1706 } else { 1707 bdev_io = spdk_mempool_get(g_bdev_mgr.bdev_io_pool); 1708 } 1709 1710 return bdev_io; 1711 } 1712 1713 void 1714 spdk_bdev_free_io(struct spdk_bdev_io *bdev_io) 1715 { 1716 struct spdk_bdev_mgmt_channel *ch; 1717 1718 assert(bdev_io != NULL); 1719 assert(bdev_io->internal.status != SPDK_BDEV_IO_STATUS_PENDING); 1720 1721 ch = bdev_io->internal.ch->shared_resource->mgmt_ch; 1722 1723 if (bdev_io->internal.buf != NULL) { 1724 bdev_io_put_buf(bdev_io); 1725 } 1726 1727 if (ch->per_thread_cache_count < ch->bdev_io_cache_size) { 1728 ch->per_thread_cache_count++; 1729 STAILQ_INSERT_HEAD(&ch->per_thread_cache, bdev_io, internal.buf_link); 1730 while (ch->per_thread_cache_count > 0 && !TAILQ_EMPTY(&ch->io_wait_queue)) { 1731 struct spdk_bdev_io_wait_entry *entry; 1732 1733 entry = TAILQ_FIRST(&ch->io_wait_queue); 1734 TAILQ_REMOVE(&ch->io_wait_queue, entry, link); 1735 entry->cb_fn(entry->cb_arg); 1736 } 1737 } else { 1738 /* We should never have a full cache with entries on the io wait queue. */ 1739 assert(TAILQ_EMPTY(&ch->io_wait_queue)); 1740 spdk_mempool_put(g_bdev_mgr.bdev_io_pool, (void *)bdev_io); 1741 } 1742 } 1743 1744 static bool 1745 bdev_qos_is_iops_rate_limit(enum spdk_bdev_qos_rate_limit_type limit) 1746 { 1747 assert(limit != SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES); 1748 1749 switch (limit) { 1750 case SPDK_BDEV_QOS_RW_IOPS_RATE_LIMIT: 1751 return true; 1752 case SPDK_BDEV_QOS_RW_BPS_RATE_LIMIT: 1753 case SPDK_BDEV_QOS_R_BPS_RATE_LIMIT: 1754 case SPDK_BDEV_QOS_W_BPS_RATE_LIMIT: 1755 return false; 1756 case SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES: 1757 default: 1758 return false; 1759 } 1760 } 1761 1762 static bool 1763 bdev_qos_io_to_limit(struct spdk_bdev_io *bdev_io) 1764 { 1765 switch (bdev_io->type) { 1766 case SPDK_BDEV_IO_TYPE_NVME_IO: 1767 case SPDK_BDEV_IO_TYPE_NVME_IO_MD: 1768 case SPDK_BDEV_IO_TYPE_READ: 1769 case SPDK_BDEV_IO_TYPE_WRITE: 1770 return true; 1771 case SPDK_BDEV_IO_TYPE_ZCOPY: 1772 if (bdev_io->u.bdev.zcopy.start) { 1773 return true; 1774 } else { 1775 return false; 1776 } 1777 default: 1778 return false; 1779 } 1780 } 1781 1782 static bool 1783 bdev_is_read_io(struct spdk_bdev_io *bdev_io) 1784 { 1785 switch (bdev_io->type) { 1786 case SPDK_BDEV_IO_TYPE_NVME_IO: 1787 case SPDK_BDEV_IO_TYPE_NVME_IO_MD: 1788 /* Bit 1 (0x2) set for read operation */ 1789 if (bdev_io->u.nvme_passthru.cmd.opc & SPDK_NVME_OPC_READ) { 1790 return true; 1791 } else { 1792 return false; 1793 } 1794 case SPDK_BDEV_IO_TYPE_READ: 1795 return true; 1796 case SPDK_BDEV_IO_TYPE_ZCOPY: 1797 /* Populate to read from disk */ 1798 if (bdev_io->u.bdev.zcopy.populate) { 1799 return true; 1800 } else { 1801 return false; 1802 } 1803 default: 1804 return false; 1805 } 1806 } 1807 1808 static uint64_t 1809 bdev_get_io_size_in_byte(struct spdk_bdev_io *bdev_io) 1810 { 1811 struct spdk_bdev *bdev = bdev_io->bdev; 1812 1813 switch (bdev_io->type) { 1814 case SPDK_BDEV_IO_TYPE_NVME_IO: 1815 case SPDK_BDEV_IO_TYPE_NVME_IO_MD: 1816 return bdev_io->u.nvme_passthru.nbytes; 1817 case SPDK_BDEV_IO_TYPE_READ: 1818 case SPDK_BDEV_IO_TYPE_WRITE: 1819 return bdev_io->u.bdev.num_blocks * bdev->blocklen; 1820 case SPDK_BDEV_IO_TYPE_ZCOPY: 1821 /* Track the data in the start phase only */ 1822 if (bdev_io->u.bdev.zcopy.start) { 1823 return bdev_io->u.bdev.num_blocks * bdev->blocklen; 1824 } else { 1825 return 0; 1826 } 1827 default: 1828 return 0; 1829 } 1830 } 1831 1832 static bool 1833 bdev_qos_rw_queue_io(const struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io) 1834 { 1835 if (limit->max_per_timeslice > 0 && limit->remaining_this_timeslice <= 0) { 1836 return true; 1837 } else { 1838 return false; 1839 } 1840 } 1841 1842 static bool 1843 bdev_qos_r_queue_io(const struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io) 1844 { 1845 if (bdev_is_read_io(io) == false) { 1846 return false; 1847 } 1848 1849 return bdev_qos_rw_queue_io(limit, io); 1850 } 1851 1852 static bool 1853 bdev_qos_w_queue_io(const struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io) 1854 { 1855 if (bdev_is_read_io(io) == true) { 1856 return false; 1857 } 1858 1859 return bdev_qos_rw_queue_io(limit, io); 1860 } 1861 1862 static void 1863 bdev_qos_rw_iops_update_quota(struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io) 1864 { 1865 limit->remaining_this_timeslice--; 1866 } 1867 1868 static void 1869 bdev_qos_rw_bps_update_quota(struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io) 1870 { 1871 limit->remaining_this_timeslice -= bdev_get_io_size_in_byte(io); 1872 } 1873 1874 static void 1875 bdev_qos_r_bps_update_quota(struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io) 1876 { 1877 if (bdev_is_read_io(io) == false) { 1878 return; 1879 } 1880 1881 return bdev_qos_rw_bps_update_quota(limit, io); 1882 } 1883 1884 static void 1885 bdev_qos_w_bps_update_quota(struct spdk_bdev_qos_limit *limit, struct spdk_bdev_io *io) 1886 { 1887 if (bdev_is_read_io(io) == true) { 1888 return; 1889 } 1890 1891 return bdev_qos_rw_bps_update_quota(limit, io); 1892 } 1893 1894 static void 1895 bdev_qos_set_ops(struct spdk_bdev_qos *qos) 1896 { 1897 int i; 1898 1899 for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) { 1900 if (qos->rate_limits[i].limit == SPDK_BDEV_QOS_LIMIT_NOT_DEFINED) { 1901 qos->rate_limits[i].queue_io = NULL; 1902 qos->rate_limits[i].update_quota = NULL; 1903 continue; 1904 } 1905 1906 switch (i) { 1907 case SPDK_BDEV_QOS_RW_IOPS_RATE_LIMIT: 1908 qos->rate_limits[i].queue_io = bdev_qos_rw_queue_io; 1909 qos->rate_limits[i].update_quota = bdev_qos_rw_iops_update_quota; 1910 break; 1911 case SPDK_BDEV_QOS_RW_BPS_RATE_LIMIT: 1912 qos->rate_limits[i].queue_io = bdev_qos_rw_queue_io; 1913 qos->rate_limits[i].update_quota = bdev_qos_rw_bps_update_quota; 1914 break; 1915 case SPDK_BDEV_QOS_R_BPS_RATE_LIMIT: 1916 qos->rate_limits[i].queue_io = bdev_qos_r_queue_io; 1917 qos->rate_limits[i].update_quota = bdev_qos_r_bps_update_quota; 1918 break; 1919 case SPDK_BDEV_QOS_W_BPS_RATE_LIMIT: 1920 qos->rate_limits[i].queue_io = bdev_qos_w_queue_io; 1921 qos->rate_limits[i].update_quota = bdev_qos_w_bps_update_quota; 1922 break; 1923 default: 1924 break; 1925 } 1926 } 1927 } 1928 1929 static void 1930 _bdev_io_complete_in_submit(struct spdk_bdev_channel *bdev_ch, 1931 struct spdk_bdev_io *bdev_io, 1932 enum spdk_bdev_io_status status) 1933 { 1934 struct spdk_bdev_shared_resource *shared_resource = bdev_ch->shared_resource; 1935 1936 bdev_io->internal.in_submit_request = true; 1937 bdev_ch->io_outstanding++; 1938 shared_resource->io_outstanding++; 1939 spdk_bdev_io_complete(bdev_io, status); 1940 bdev_io->internal.in_submit_request = false; 1941 } 1942 1943 static inline void 1944 bdev_io_do_submit(struct spdk_bdev_channel *bdev_ch, struct spdk_bdev_io *bdev_io) 1945 { 1946 struct spdk_bdev *bdev = bdev_io->bdev; 1947 struct spdk_io_channel *ch = bdev_ch->channel; 1948 struct spdk_bdev_shared_resource *shared_resource = bdev_ch->shared_resource; 1949 1950 if (spdk_unlikely(bdev_io->type == SPDK_BDEV_IO_TYPE_ABORT)) { 1951 struct spdk_bdev_mgmt_channel *mgmt_channel = shared_resource->mgmt_ch; 1952 struct spdk_bdev_io *bio_to_abort = bdev_io->u.abort.bio_to_abort; 1953 1954 if (bdev_abort_queued_io(&shared_resource->nomem_io, bio_to_abort) || 1955 bdev_abort_buf_io(&mgmt_channel->need_buf_small, bio_to_abort) || 1956 bdev_abort_buf_io(&mgmt_channel->need_buf_large, bio_to_abort)) { 1957 _bdev_io_complete_in_submit(bdev_ch, bdev_io, 1958 SPDK_BDEV_IO_STATUS_SUCCESS); 1959 return; 1960 } 1961 } 1962 1963 if (spdk_likely(TAILQ_EMPTY(&shared_resource->nomem_io))) { 1964 bdev_ch->io_outstanding++; 1965 shared_resource->io_outstanding++; 1966 bdev_io->internal.in_submit_request = true; 1967 bdev->fn_table->submit_request(ch, bdev_io); 1968 bdev_io->internal.in_submit_request = false; 1969 } else { 1970 TAILQ_INSERT_TAIL(&shared_resource->nomem_io, bdev_io, internal.link); 1971 } 1972 } 1973 1974 static int 1975 bdev_qos_io_submit(struct spdk_bdev_channel *ch, struct spdk_bdev_qos *qos) 1976 { 1977 struct spdk_bdev_io *bdev_io = NULL, *tmp = NULL; 1978 int i, submitted_ios = 0; 1979 1980 TAILQ_FOREACH_SAFE(bdev_io, &qos->queued, internal.link, tmp) { 1981 if (bdev_qos_io_to_limit(bdev_io) == true) { 1982 for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) { 1983 if (!qos->rate_limits[i].queue_io) { 1984 continue; 1985 } 1986 1987 if (qos->rate_limits[i].queue_io(&qos->rate_limits[i], 1988 bdev_io) == true) { 1989 return submitted_ios; 1990 } 1991 } 1992 for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) { 1993 if (!qos->rate_limits[i].update_quota) { 1994 continue; 1995 } 1996 1997 qos->rate_limits[i].update_quota(&qos->rate_limits[i], bdev_io); 1998 } 1999 } 2000 2001 TAILQ_REMOVE(&qos->queued, bdev_io, internal.link); 2002 bdev_io_do_submit(ch, bdev_io); 2003 submitted_ios++; 2004 } 2005 2006 return submitted_ios; 2007 } 2008 2009 static void 2010 bdev_queue_io_wait_with_cb(struct spdk_bdev_io *bdev_io, spdk_bdev_io_wait_cb cb_fn) 2011 { 2012 int rc; 2013 2014 bdev_io->internal.waitq_entry.bdev = bdev_io->bdev; 2015 bdev_io->internal.waitq_entry.cb_fn = cb_fn; 2016 bdev_io->internal.waitq_entry.cb_arg = bdev_io; 2017 rc = spdk_bdev_queue_io_wait(bdev_io->bdev, spdk_io_channel_from_ctx(bdev_io->internal.ch), 2018 &bdev_io->internal.waitq_entry); 2019 if (rc != 0) { 2020 SPDK_ERRLOG("Queue IO failed, rc=%d\n", rc); 2021 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED; 2022 bdev_io->internal.cb(bdev_io, false, bdev_io->internal.caller_ctx); 2023 } 2024 } 2025 2026 static bool 2027 bdev_rw_should_split(struct spdk_bdev_io *bdev_io) 2028 { 2029 uint32_t io_boundary = bdev_io->bdev->optimal_io_boundary; 2030 uint32_t max_size = bdev_io->bdev->max_segment_size; 2031 int max_segs = bdev_io->bdev->max_num_segments; 2032 2033 io_boundary = bdev_io->bdev->split_on_optimal_io_boundary ? io_boundary : 0; 2034 2035 if (spdk_likely(!io_boundary && !max_segs && !max_size)) { 2036 return false; 2037 } 2038 2039 if (io_boundary) { 2040 uint64_t start_stripe, end_stripe; 2041 2042 start_stripe = bdev_io->u.bdev.offset_blocks; 2043 end_stripe = start_stripe + bdev_io->u.bdev.num_blocks - 1; 2044 /* Avoid expensive div operations if possible. These spdk_u32 functions are very cheap. */ 2045 if (spdk_likely(spdk_u32_is_pow2(io_boundary))) { 2046 start_stripe >>= spdk_u32log2(io_boundary); 2047 end_stripe >>= spdk_u32log2(io_boundary); 2048 } else { 2049 start_stripe /= io_boundary; 2050 end_stripe /= io_boundary; 2051 } 2052 2053 if (start_stripe != end_stripe) { 2054 return true; 2055 } 2056 } 2057 2058 if (max_segs) { 2059 if (bdev_io->u.bdev.iovcnt > max_segs) { 2060 return true; 2061 } 2062 } 2063 2064 if (max_size) { 2065 for (int i = 0; i < bdev_io->u.bdev.iovcnt; i++) { 2066 if (bdev_io->u.bdev.iovs[i].iov_len > max_size) { 2067 return true; 2068 } 2069 } 2070 } 2071 2072 return false; 2073 } 2074 2075 static bool 2076 bdev_unmap_should_split(struct spdk_bdev_io *bdev_io) 2077 { 2078 uint32_t num_unmap_segments; 2079 2080 if (!bdev_io->bdev->max_unmap || !bdev_io->bdev->max_unmap_segments) { 2081 return false; 2082 } 2083 num_unmap_segments = spdk_divide_round_up(bdev_io->u.bdev.num_blocks, bdev_io->bdev->max_unmap); 2084 if (num_unmap_segments > bdev_io->bdev->max_unmap_segments) { 2085 return true; 2086 } 2087 2088 return false; 2089 } 2090 2091 static bool 2092 bdev_write_zeroes_should_split(struct spdk_bdev_io *bdev_io) 2093 { 2094 if (!bdev_io->bdev->max_write_zeroes) { 2095 return false; 2096 } 2097 2098 if (bdev_io->u.bdev.num_blocks > bdev_io->bdev->max_write_zeroes) { 2099 return true; 2100 } 2101 2102 return false; 2103 } 2104 2105 static bool 2106 bdev_io_should_split(struct spdk_bdev_io *bdev_io) 2107 { 2108 switch (bdev_io->type) { 2109 case SPDK_BDEV_IO_TYPE_READ: 2110 case SPDK_BDEV_IO_TYPE_WRITE: 2111 return bdev_rw_should_split(bdev_io); 2112 case SPDK_BDEV_IO_TYPE_UNMAP: 2113 return bdev_unmap_should_split(bdev_io); 2114 case SPDK_BDEV_IO_TYPE_WRITE_ZEROES: 2115 return bdev_write_zeroes_should_split(bdev_io); 2116 default: 2117 return false; 2118 } 2119 } 2120 2121 static uint32_t 2122 _to_next_boundary(uint64_t offset, uint32_t boundary) 2123 { 2124 return (boundary - (offset % boundary)); 2125 } 2126 2127 static void 2128 bdev_io_split_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg); 2129 2130 static void 2131 _bdev_rw_split(void *_bdev_io); 2132 2133 static void 2134 bdev_unmap_split(struct spdk_bdev_io *bdev_io); 2135 2136 static void 2137 _bdev_unmap_split(void *_bdev_io) 2138 { 2139 return bdev_unmap_split((struct spdk_bdev_io *)_bdev_io); 2140 } 2141 2142 static void 2143 bdev_write_zeroes_split(struct spdk_bdev_io *bdev_io); 2144 2145 static void 2146 _bdev_write_zeroes_split(void *_bdev_io) 2147 { 2148 return bdev_write_zeroes_split((struct spdk_bdev_io *)_bdev_io); 2149 } 2150 2151 static int 2152 bdev_io_split_submit(struct spdk_bdev_io *bdev_io, struct iovec *iov, int iovcnt, void *md_buf, 2153 uint64_t num_blocks, uint64_t *offset, uint64_t *remaining) 2154 { 2155 int rc; 2156 uint64_t current_offset, current_remaining; 2157 spdk_bdev_io_wait_cb io_wait_fn; 2158 2159 current_offset = *offset; 2160 current_remaining = *remaining; 2161 2162 bdev_io->u.bdev.split_outstanding++; 2163 2164 io_wait_fn = _bdev_rw_split; 2165 switch (bdev_io->type) { 2166 case SPDK_BDEV_IO_TYPE_READ: 2167 rc = bdev_readv_blocks_with_md(bdev_io->internal.desc, 2168 spdk_io_channel_from_ctx(bdev_io->internal.ch), 2169 iov, iovcnt, md_buf, current_offset, 2170 num_blocks, 2171 bdev_io_split_done, bdev_io, 2172 bdev_io->internal.ext_opts); 2173 break; 2174 case SPDK_BDEV_IO_TYPE_WRITE: 2175 rc = bdev_writev_blocks_with_md(bdev_io->internal.desc, 2176 spdk_io_channel_from_ctx(bdev_io->internal.ch), 2177 iov, iovcnt, md_buf, current_offset, 2178 num_blocks, 2179 bdev_io_split_done, bdev_io, 2180 bdev_io->internal.ext_opts); 2181 break; 2182 case SPDK_BDEV_IO_TYPE_UNMAP: 2183 io_wait_fn = _bdev_unmap_split; 2184 rc = spdk_bdev_unmap_blocks(bdev_io->internal.desc, 2185 spdk_io_channel_from_ctx(bdev_io->internal.ch), 2186 current_offset, num_blocks, 2187 bdev_io_split_done, bdev_io); 2188 break; 2189 case SPDK_BDEV_IO_TYPE_WRITE_ZEROES: 2190 io_wait_fn = _bdev_write_zeroes_split; 2191 rc = spdk_bdev_write_zeroes_blocks(bdev_io->internal.desc, 2192 spdk_io_channel_from_ctx(bdev_io->internal.ch), 2193 current_offset, num_blocks, 2194 bdev_io_split_done, bdev_io); 2195 break; 2196 default: 2197 assert(false); 2198 rc = -EINVAL; 2199 break; 2200 } 2201 2202 if (rc == 0) { 2203 current_offset += num_blocks; 2204 current_remaining -= num_blocks; 2205 bdev_io->u.bdev.split_current_offset_blocks = current_offset; 2206 bdev_io->u.bdev.split_remaining_num_blocks = current_remaining; 2207 *offset = current_offset; 2208 *remaining = current_remaining; 2209 } else { 2210 bdev_io->u.bdev.split_outstanding--; 2211 if (rc == -ENOMEM) { 2212 if (bdev_io->u.bdev.split_outstanding == 0) { 2213 /* No I/O is outstanding. Hence we should wait here. */ 2214 bdev_queue_io_wait_with_cb(bdev_io, io_wait_fn); 2215 } 2216 } else { 2217 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED; 2218 if (bdev_io->u.bdev.split_outstanding == 0) { 2219 spdk_trace_record(TRACE_BDEV_IO_DONE, 0, 0, (uintptr_t)bdev_io); 2220 TAILQ_REMOVE(&bdev_io->internal.ch->io_submitted, bdev_io, internal.ch_link); 2221 bdev_io->internal.cb(bdev_io, false, bdev_io->internal.caller_ctx); 2222 } 2223 } 2224 } 2225 2226 return rc; 2227 } 2228 2229 static void 2230 _bdev_rw_split(void *_bdev_io) 2231 { 2232 struct iovec *parent_iov, *iov; 2233 struct spdk_bdev_io *bdev_io = _bdev_io; 2234 struct spdk_bdev *bdev = bdev_io->bdev; 2235 uint64_t parent_offset, current_offset, remaining; 2236 uint32_t parent_iov_offset, parent_iovcnt, parent_iovpos, child_iovcnt; 2237 uint32_t to_next_boundary, to_next_boundary_bytes, to_last_block_bytes; 2238 uint32_t iovcnt, iov_len, child_iovsize; 2239 uint32_t blocklen = bdev->blocklen; 2240 uint32_t io_boundary = bdev->optimal_io_boundary; 2241 uint32_t max_segment_size = bdev->max_segment_size; 2242 uint32_t max_child_iovcnt = bdev->max_num_segments; 2243 void *md_buf = NULL; 2244 int rc; 2245 2246 max_segment_size = max_segment_size ? max_segment_size : UINT32_MAX; 2247 max_child_iovcnt = max_child_iovcnt ? spdk_min(max_child_iovcnt, BDEV_IO_NUM_CHILD_IOV) : 2248 BDEV_IO_NUM_CHILD_IOV; 2249 io_boundary = bdev->split_on_optimal_io_boundary ? io_boundary : UINT32_MAX; 2250 2251 remaining = bdev_io->u.bdev.split_remaining_num_blocks; 2252 current_offset = bdev_io->u.bdev.split_current_offset_blocks; 2253 parent_offset = bdev_io->u.bdev.offset_blocks; 2254 parent_iov_offset = (current_offset - parent_offset) * blocklen; 2255 parent_iovcnt = bdev_io->u.bdev.iovcnt; 2256 2257 for (parent_iovpos = 0; parent_iovpos < parent_iovcnt; parent_iovpos++) { 2258 parent_iov = &bdev_io->u.bdev.iovs[parent_iovpos]; 2259 if (parent_iov_offset < parent_iov->iov_len) { 2260 break; 2261 } 2262 parent_iov_offset -= parent_iov->iov_len; 2263 } 2264 2265 child_iovcnt = 0; 2266 while (remaining > 0 && parent_iovpos < parent_iovcnt && child_iovcnt < BDEV_IO_NUM_CHILD_IOV) { 2267 to_next_boundary = _to_next_boundary(current_offset, io_boundary); 2268 to_next_boundary = spdk_min(remaining, to_next_boundary); 2269 to_next_boundary_bytes = to_next_boundary * blocklen; 2270 2271 iov = &bdev_io->child_iov[child_iovcnt]; 2272 iovcnt = 0; 2273 2274 if (bdev_io->u.bdev.md_buf) { 2275 md_buf = (char *)bdev_io->u.bdev.md_buf + 2276 (current_offset - parent_offset) * spdk_bdev_get_md_size(bdev); 2277 } 2278 2279 child_iovsize = spdk_min(BDEV_IO_NUM_CHILD_IOV - child_iovcnt, max_child_iovcnt); 2280 while (to_next_boundary_bytes > 0 && parent_iovpos < parent_iovcnt && 2281 iovcnt < child_iovsize) { 2282 parent_iov = &bdev_io->u.bdev.iovs[parent_iovpos]; 2283 iov_len = parent_iov->iov_len - parent_iov_offset; 2284 2285 iov_len = spdk_min(iov_len, max_segment_size); 2286 iov_len = spdk_min(iov_len, to_next_boundary_bytes); 2287 to_next_boundary_bytes -= iov_len; 2288 2289 bdev_io->child_iov[child_iovcnt].iov_base = parent_iov->iov_base + parent_iov_offset; 2290 bdev_io->child_iov[child_iovcnt].iov_len = iov_len; 2291 2292 if (iov_len < parent_iov->iov_len - parent_iov_offset) { 2293 parent_iov_offset += iov_len; 2294 } else { 2295 parent_iovpos++; 2296 parent_iov_offset = 0; 2297 } 2298 child_iovcnt++; 2299 iovcnt++; 2300 } 2301 2302 if (to_next_boundary_bytes > 0) { 2303 /* We had to stop this child I/O early because we ran out of 2304 * child_iov space or were limited by max_num_segments. 2305 * Ensure the iovs to be aligned with block size and 2306 * then adjust to_next_boundary before starting the 2307 * child I/O. 2308 */ 2309 assert(child_iovcnt == BDEV_IO_NUM_CHILD_IOV || 2310 iovcnt == child_iovsize); 2311 to_last_block_bytes = to_next_boundary_bytes % blocklen; 2312 if (to_last_block_bytes != 0) { 2313 uint32_t child_iovpos = child_iovcnt - 1; 2314 /* don't decrease child_iovcnt when it equals to BDEV_IO_NUM_CHILD_IOV 2315 * so the loop will naturally end 2316 */ 2317 2318 to_last_block_bytes = blocklen - to_last_block_bytes; 2319 to_next_boundary_bytes += to_last_block_bytes; 2320 while (to_last_block_bytes > 0 && iovcnt > 0) { 2321 iov_len = spdk_min(to_last_block_bytes, 2322 bdev_io->child_iov[child_iovpos].iov_len); 2323 bdev_io->child_iov[child_iovpos].iov_len -= iov_len; 2324 if (bdev_io->child_iov[child_iovpos].iov_len == 0) { 2325 child_iovpos--; 2326 if (--iovcnt == 0) { 2327 /* If the child IO is less than a block size just return. 2328 * If the first child IO of any split round is less than 2329 * a block size, an error exit. 2330 */ 2331 if (bdev_io->u.bdev.split_outstanding == 0) { 2332 SPDK_ERRLOG("The first child io was less than a block size\n"); 2333 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED; 2334 spdk_trace_record(TRACE_BDEV_IO_DONE, 0, 0, (uintptr_t)bdev_io); 2335 TAILQ_REMOVE(&bdev_io->internal.ch->io_submitted, bdev_io, internal.ch_link); 2336 bdev_io->internal.cb(bdev_io, false, bdev_io->internal.caller_ctx); 2337 } 2338 2339 return; 2340 } 2341 } 2342 2343 to_last_block_bytes -= iov_len; 2344 2345 if (parent_iov_offset == 0) { 2346 parent_iovpos--; 2347 parent_iov_offset = bdev_io->u.bdev.iovs[parent_iovpos].iov_len; 2348 } 2349 parent_iov_offset -= iov_len; 2350 } 2351 2352 assert(to_last_block_bytes == 0); 2353 } 2354 to_next_boundary -= to_next_boundary_bytes / blocklen; 2355 } 2356 2357 rc = bdev_io_split_submit(bdev_io, iov, iovcnt, md_buf, to_next_boundary, 2358 ¤t_offset, &remaining); 2359 if (spdk_unlikely(rc)) { 2360 return; 2361 } 2362 } 2363 } 2364 2365 static void 2366 bdev_unmap_split(struct spdk_bdev_io *bdev_io) 2367 { 2368 uint64_t offset, unmap_blocks, remaining, max_unmap_blocks; 2369 uint32_t num_children_reqs = 0; 2370 int rc; 2371 2372 offset = bdev_io->u.bdev.split_current_offset_blocks; 2373 remaining = bdev_io->u.bdev.split_remaining_num_blocks; 2374 max_unmap_blocks = bdev_io->bdev->max_unmap * bdev_io->bdev->max_unmap_segments; 2375 2376 while (remaining && (num_children_reqs < SPDK_BDEV_MAX_CHILDREN_UNMAP_WRITE_ZEROES_REQS)) { 2377 unmap_blocks = spdk_min(remaining, max_unmap_blocks); 2378 2379 rc = bdev_io_split_submit(bdev_io, NULL, 0, NULL, unmap_blocks, 2380 &offset, &remaining); 2381 if (spdk_likely(rc == 0)) { 2382 num_children_reqs++; 2383 } else { 2384 return; 2385 } 2386 } 2387 } 2388 2389 static void 2390 bdev_write_zeroes_split(struct spdk_bdev_io *bdev_io) 2391 { 2392 uint64_t offset, write_zeroes_blocks, remaining; 2393 uint32_t num_children_reqs = 0; 2394 int rc; 2395 2396 offset = bdev_io->u.bdev.split_current_offset_blocks; 2397 remaining = bdev_io->u.bdev.split_remaining_num_blocks; 2398 2399 while (remaining && (num_children_reqs < SPDK_BDEV_MAX_CHILDREN_UNMAP_WRITE_ZEROES_REQS)) { 2400 write_zeroes_blocks = spdk_min(remaining, bdev_io->bdev->max_write_zeroes); 2401 2402 rc = bdev_io_split_submit(bdev_io, NULL, 0, NULL, write_zeroes_blocks, 2403 &offset, &remaining); 2404 if (spdk_likely(rc == 0)) { 2405 num_children_reqs++; 2406 } else { 2407 return; 2408 } 2409 } 2410 } 2411 2412 static void 2413 bdev_io_split_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg) 2414 { 2415 struct spdk_bdev_io *parent_io = cb_arg; 2416 2417 spdk_bdev_free_io(bdev_io); 2418 2419 if (!success) { 2420 parent_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED; 2421 /* If any child I/O failed, stop further splitting process. */ 2422 parent_io->u.bdev.split_current_offset_blocks += parent_io->u.bdev.split_remaining_num_blocks; 2423 parent_io->u.bdev.split_remaining_num_blocks = 0; 2424 } 2425 parent_io->u.bdev.split_outstanding--; 2426 if (parent_io->u.bdev.split_outstanding != 0) { 2427 return; 2428 } 2429 2430 /* 2431 * Parent I/O finishes when all blocks are consumed. 2432 */ 2433 if (parent_io->u.bdev.split_remaining_num_blocks == 0) { 2434 assert(parent_io->internal.cb != bdev_io_split_done); 2435 spdk_trace_record(TRACE_BDEV_IO_DONE, 0, 0, (uintptr_t)parent_io); 2436 TAILQ_REMOVE(&parent_io->internal.ch->io_submitted, parent_io, internal.ch_link); 2437 parent_io->internal.cb(parent_io, parent_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS, 2438 parent_io->internal.caller_ctx); 2439 return; 2440 } 2441 2442 /* 2443 * Continue with the splitting process. This function will complete the parent I/O if the 2444 * splitting is done. 2445 */ 2446 switch (parent_io->type) { 2447 case SPDK_BDEV_IO_TYPE_READ: 2448 case SPDK_BDEV_IO_TYPE_WRITE: 2449 _bdev_rw_split(parent_io); 2450 break; 2451 case SPDK_BDEV_IO_TYPE_UNMAP: 2452 bdev_unmap_split(parent_io); 2453 break; 2454 case SPDK_BDEV_IO_TYPE_WRITE_ZEROES: 2455 bdev_write_zeroes_split(parent_io); 2456 break; 2457 default: 2458 assert(false); 2459 break; 2460 } 2461 } 2462 2463 static void 2464 bdev_rw_split_get_buf_cb(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io, bool success); 2465 2466 static void 2467 bdev_io_split(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io) 2468 { 2469 bdev_io->u.bdev.split_current_offset_blocks = bdev_io->u.bdev.offset_blocks; 2470 bdev_io->u.bdev.split_remaining_num_blocks = bdev_io->u.bdev.num_blocks; 2471 bdev_io->u.bdev.split_outstanding = 0; 2472 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS; 2473 2474 switch (bdev_io->type) { 2475 case SPDK_BDEV_IO_TYPE_READ: 2476 case SPDK_BDEV_IO_TYPE_WRITE: 2477 if (_is_buf_allocated(bdev_io->u.bdev.iovs)) { 2478 _bdev_rw_split(bdev_io); 2479 } else { 2480 assert(bdev_io->type == SPDK_BDEV_IO_TYPE_READ); 2481 spdk_bdev_io_get_buf(bdev_io, bdev_rw_split_get_buf_cb, 2482 bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen); 2483 } 2484 break; 2485 case SPDK_BDEV_IO_TYPE_UNMAP: 2486 bdev_unmap_split(bdev_io); 2487 break; 2488 case SPDK_BDEV_IO_TYPE_WRITE_ZEROES: 2489 bdev_write_zeroes_split(bdev_io); 2490 break; 2491 default: 2492 assert(false); 2493 break; 2494 } 2495 } 2496 2497 static void 2498 bdev_rw_split_get_buf_cb(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io, bool success) 2499 { 2500 if (!success) { 2501 spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_FAILED); 2502 return; 2503 } 2504 2505 _bdev_rw_split(bdev_io); 2506 } 2507 2508 /* Explicitly mark this inline, since it's used as a function pointer and otherwise won't 2509 * be inlined, at least on some compilers. 2510 */ 2511 static inline void 2512 _bdev_io_submit(void *ctx) 2513 { 2514 struct spdk_bdev_io *bdev_io = ctx; 2515 struct spdk_bdev *bdev = bdev_io->bdev; 2516 struct spdk_bdev_channel *bdev_ch = bdev_io->internal.ch; 2517 uint64_t tsc; 2518 2519 tsc = spdk_get_ticks(); 2520 bdev_io->internal.submit_tsc = tsc; 2521 spdk_trace_record_tsc(tsc, TRACE_BDEV_IO_START, 0, 0, (uintptr_t)bdev_io, bdev_io->type); 2522 2523 if (spdk_likely(bdev_ch->flags == 0)) { 2524 bdev_io_do_submit(bdev_ch, bdev_io); 2525 return; 2526 } 2527 2528 if (bdev_ch->flags & BDEV_CH_RESET_IN_PROGRESS) { 2529 _bdev_io_complete_in_submit(bdev_ch, bdev_io, SPDK_BDEV_IO_STATUS_ABORTED); 2530 } else if (bdev_ch->flags & BDEV_CH_QOS_ENABLED) { 2531 if (spdk_unlikely(bdev_io->type == SPDK_BDEV_IO_TYPE_ABORT) && 2532 bdev_abort_queued_io(&bdev->internal.qos->queued, bdev_io->u.abort.bio_to_abort)) { 2533 _bdev_io_complete_in_submit(bdev_ch, bdev_io, SPDK_BDEV_IO_STATUS_SUCCESS); 2534 } else { 2535 TAILQ_INSERT_TAIL(&bdev->internal.qos->queued, bdev_io, internal.link); 2536 bdev_qos_io_submit(bdev_ch, bdev->internal.qos); 2537 } 2538 } else { 2539 SPDK_ERRLOG("unknown bdev_ch flag %x found\n", bdev_ch->flags); 2540 _bdev_io_complete_in_submit(bdev_ch, bdev_io, SPDK_BDEV_IO_STATUS_FAILED); 2541 } 2542 } 2543 2544 bool 2545 bdev_lba_range_overlapped(struct lba_range *range1, struct lba_range *range2); 2546 2547 bool 2548 bdev_lba_range_overlapped(struct lba_range *range1, struct lba_range *range2) 2549 { 2550 if (range1->length == 0 || range2->length == 0) { 2551 return false; 2552 } 2553 2554 if (range1->offset + range1->length <= range2->offset) { 2555 return false; 2556 } 2557 2558 if (range2->offset + range2->length <= range1->offset) { 2559 return false; 2560 } 2561 2562 return true; 2563 } 2564 2565 static bool 2566 bdev_io_range_is_locked(struct spdk_bdev_io *bdev_io, struct lba_range *range) 2567 { 2568 struct spdk_bdev_channel *ch = bdev_io->internal.ch; 2569 struct lba_range r; 2570 2571 switch (bdev_io->type) { 2572 case SPDK_BDEV_IO_TYPE_NVME_IO: 2573 case SPDK_BDEV_IO_TYPE_NVME_IO_MD: 2574 /* Don't try to decode the NVMe command - just assume worst-case and that 2575 * it overlaps a locked range. 2576 */ 2577 return true; 2578 case SPDK_BDEV_IO_TYPE_WRITE: 2579 case SPDK_BDEV_IO_TYPE_UNMAP: 2580 case SPDK_BDEV_IO_TYPE_WRITE_ZEROES: 2581 case SPDK_BDEV_IO_TYPE_ZCOPY: 2582 r.offset = bdev_io->u.bdev.offset_blocks; 2583 r.length = bdev_io->u.bdev.num_blocks; 2584 if (!bdev_lba_range_overlapped(range, &r)) { 2585 /* This I/O doesn't overlap the specified LBA range. */ 2586 return false; 2587 } else if (range->owner_ch == ch && range->locked_ctx == bdev_io->internal.caller_ctx) { 2588 /* This I/O overlaps, but the I/O is on the same channel that locked this 2589 * range, and the caller_ctx is the same as the locked_ctx. This means 2590 * that this I/O is associated with the lock, and is allowed to execute. 2591 */ 2592 return false; 2593 } else { 2594 return true; 2595 } 2596 default: 2597 return false; 2598 } 2599 } 2600 2601 void 2602 bdev_io_submit(struct spdk_bdev_io *bdev_io) 2603 { 2604 struct spdk_bdev *bdev = bdev_io->bdev; 2605 struct spdk_thread *thread = spdk_bdev_io_get_thread(bdev_io); 2606 struct spdk_bdev_channel *ch = bdev_io->internal.ch; 2607 2608 assert(thread != NULL); 2609 assert(bdev_io->internal.status == SPDK_BDEV_IO_STATUS_PENDING); 2610 2611 if (!TAILQ_EMPTY(&ch->locked_ranges)) { 2612 struct lba_range *range; 2613 2614 TAILQ_FOREACH(range, &ch->locked_ranges, tailq) { 2615 if (bdev_io_range_is_locked(bdev_io, range)) { 2616 TAILQ_INSERT_TAIL(&ch->io_locked, bdev_io, internal.ch_link); 2617 return; 2618 } 2619 } 2620 } 2621 2622 TAILQ_INSERT_TAIL(&ch->io_submitted, bdev_io, internal.ch_link); 2623 2624 if (bdev_io_should_split(bdev_io)) { 2625 bdev_io->internal.submit_tsc = spdk_get_ticks(); 2626 spdk_trace_record_tsc(bdev_io->internal.submit_tsc, TRACE_BDEV_IO_START, 0, 0, 2627 (uintptr_t)bdev_io, bdev_io->type); 2628 bdev_io_split(NULL, bdev_io); 2629 return; 2630 } 2631 2632 if (ch->flags & BDEV_CH_QOS_ENABLED) { 2633 if ((thread == bdev->internal.qos->thread) || !bdev->internal.qos->thread) { 2634 _bdev_io_submit(bdev_io); 2635 } else { 2636 bdev_io->internal.io_submit_ch = ch; 2637 bdev_io->internal.ch = bdev->internal.qos->ch; 2638 spdk_thread_send_msg(bdev->internal.qos->thread, _bdev_io_submit, bdev_io); 2639 } 2640 } else { 2641 _bdev_io_submit(bdev_io); 2642 } 2643 } 2644 2645 static void 2646 bdev_io_submit_reset(struct spdk_bdev_io *bdev_io) 2647 { 2648 struct spdk_bdev *bdev = bdev_io->bdev; 2649 struct spdk_bdev_channel *bdev_ch = bdev_io->internal.ch; 2650 struct spdk_io_channel *ch = bdev_ch->channel; 2651 2652 assert(bdev_io->internal.status == SPDK_BDEV_IO_STATUS_PENDING); 2653 2654 bdev_io->internal.in_submit_request = true; 2655 bdev->fn_table->submit_request(ch, bdev_io); 2656 bdev_io->internal.in_submit_request = false; 2657 } 2658 2659 void 2660 bdev_io_init(struct spdk_bdev_io *bdev_io, 2661 struct spdk_bdev *bdev, void *cb_arg, 2662 spdk_bdev_io_completion_cb cb) 2663 { 2664 bdev_io->bdev = bdev; 2665 bdev_io->internal.caller_ctx = cb_arg; 2666 bdev_io->internal.cb = cb; 2667 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_PENDING; 2668 bdev_io->internal.in_submit_request = false; 2669 bdev_io->internal.buf = NULL; 2670 bdev_io->internal.io_submit_ch = NULL; 2671 bdev_io->internal.orig_iovs = NULL; 2672 bdev_io->internal.orig_iovcnt = 0; 2673 bdev_io->internal.orig_md_buf = NULL; 2674 bdev_io->internal.error.nvme.cdw0 = 0; 2675 bdev_io->num_retries = 0; 2676 bdev_io->internal.get_buf_cb = NULL; 2677 bdev_io->internal.get_aux_buf_cb = NULL; 2678 bdev_io->internal.ext_opts = NULL; 2679 } 2680 2681 static bool 2682 bdev_io_type_supported(struct spdk_bdev *bdev, enum spdk_bdev_io_type io_type) 2683 { 2684 return bdev->fn_table->io_type_supported(bdev->ctxt, io_type); 2685 } 2686 2687 bool 2688 spdk_bdev_io_type_supported(struct spdk_bdev *bdev, enum spdk_bdev_io_type io_type) 2689 { 2690 bool supported; 2691 2692 supported = bdev_io_type_supported(bdev, io_type); 2693 2694 if (!supported) { 2695 switch (io_type) { 2696 case SPDK_BDEV_IO_TYPE_WRITE_ZEROES: 2697 /* The bdev layer will emulate write zeroes as long as write is supported. */ 2698 supported = bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_WRITE); 2699 break; 2700 default: 2701 break; 2702 } 2703 } 2704 2705 return supported; 2706 } 2707 2708 int 2709 spdk_bdev_dump_info_json(struct spdk_bdev *bdev, struct spdk_json_write_ctx *w) 2710 { 2711 if (bdev->fn_table->dump_info_json) { 2712 return bdev->fn_table->dump_info_json(bdev->ctxt, w); 2713 } 2714 2715 return 0; 2716 } 2717 2718 static void 2719 bdev_qos_update_max_quota_per_timeslice(struct spdk_bdev_qos *qos) 2720 { 2721 uint32_t max_per_timeslice = 0; 2722 int i; 2723 2724 for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) { 2725 if (qos->rate_limits[i].limit == SPDK_BDEV_QOS_LIMIT_NOT_DEFINED) { 2726 qos->rate_limits[i].max_per_timeslice = 0; 2727 continue; 2728 } 2729 2730 max_per_timeslice = qos->rate_limits[i].limit * 2731 SPDK_BDEV_QOS_TIMESLICE_IN_USEC / SPDK_SEC_TO_USEC; 2732 2733 qos->rate_limits[i].max_per_timeslice = spdk_max(max_per_timeslice, 2734 qos->rate_limits[i].min_per_timeslice); 2735 2736 qos->rate_limits[i].remaining_this_timeslice = qos->rate_limits[i].max_per_timeslice; 2737 } 2738 2739 bdev_qos_set_ops(qos); 2740 } 2741 2742 static int 2743 bdev_channel_poll_qos(void *arg) 2744 { 2745 struct spdk_bdev_qos *qos = arg; 2746 uint64_t now = spdk_get_ticks(); 2747 int i; 2748 2749 if (now < (qos->last_timeslice + qos->timeslice_size)) { 2750 /* We received our callback earlier than expected - return 2751 * immediately and wait to do accounting until at least one 2752 * timeslice has actually expired. This should never happen 2753 * with a well-behaved timer implementation. 2754 */ 2755 return SPDK_POLLER_IDLE; 2756 } 2757 2758 /* Reset for next round of rate limiting */ 2759 for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) { 2760 /* We may have allowed the IOs or bytes to slightly overrun in the last 2761 * timeslice. remaining_this_timeslice is signed, so if it's negative 2762 * here, we'll account for the overrun so that the next timeslice will 2763 * be appropriately reduced. 2764 */ 2765 if (qos->rate_limits[i].remaining_this_timeslice > 0) { 2766 qos->rate_limits[i].remaining_this_timeslice = 0; 2767 } 2768 } 2769 2770 while (now >= (qos->last_timeslice + qos->timeslice_size)) { 2771 qos->last_timeslice += qos->timeslice_size; 2772 for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) { 2773 qos->rate_limits[i].remaining_this_timeslice += 2774 qos->rate_limits[i].max_per_timeslice; 2775 } 2776 } 2777 2778 return bdev_qos_io_submit(qos->ch, qos); 2779 } 2780 2781 static void 2782 bdev_channel_destroy_resource(struct spdk_bdev_channel *ch) 2783 { 2784 struct spdk_bdev_shared_resource *shared_resource; 2785 struct lba_range *range; 2786 2787 while (!TAILQ_EMPTY(&ch->locked_ranges)) { 2788 range = TAILQ_FIRST(&ch->locked_ranges); 2789 TAILQ_REMOVE(&ch->locked_ranges, range, tailq); 2790 free(range); 2791 } 2792 2793 spdk_put_io_channel(ch->channel); 2794 2795 shared_resource = ch->shared_resource; 2796 2797 assert(TAILQ_EMPTY(&ch->io_locked)); 2798 assert(TAILQ_EMPTY(&ch->io_submitted)); 2799 assert(ch->io_outstanding == 0); 2800 assert(shared_resource->ref > 0); 2801 shared_resource->ref--; 2802 if (shared_resource->ref == 0) { 2803 assert(shared_resource->io_outstanding == 0); 2804 TAILQ_REMOVE(&shared_resource->mgmt_ch->shared_resources, shared_resource, link); 2805 spdk_put_io_channel(spdk_io_channel_from_ctx(shared_resource->mgmt_ch)); 2806 free(shared_resource); 2807 } 2808 } 2809 2810 /* Caller must hold bdev->internal.mutex. */ 2811 static void 2812 bdev_enable_qos(struct spdk_bdev *bdev, struct spdk_bdev_channel *ch) 2813 { 2814 struct spdk_bdev_qos *qos = bdev->internal.qos; 2815 int i; 2816 2817 /* Rate limiting on this bdev enabled */ 2818 if (qos) { 2819 if (qos->ch == NULL) { 2820 struct spdk_io_channel *io_ch; 2821 2822 SPDK_DEBUGLOG(bdev, "Selecting channel %p as QoS channel for bdev %s on thread %p\n", ch, 2823 bdev->name, spdk_get_thread()); 2824 2825 /* No qos channel has been selected, so set one up */ 2826 2827 /* Take another reference to ch */ 2828 io_ch = spdk_get_io_channel(__bdev_to_io_dev(bdev)); 2829 assert(io_ch != NULL); 2830 qos->ch = ch; 2831 2832 qos->thread = spdk_io_channel_get_thread(io_ch); 2833 2834 TAILQ_INIT(&qos->queued); 2835 2836 for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) { 2837 if (bdev_qos_is_iops_rate_limit(i) == true) { 2838 qos->rate_limits[i].min_per_timeslice = 2839 SPDK_BDEV_QOS_MIN_IO_PER_TIMESLICE; 2840 } else { 2841 qos->rate_limits[i].min_per_timeslice = 2842 SPDK_BDEV_QOS_MIN_BYTE_PER_TIMESLICE; 2843 } 2844 2845 if (qos->rate_limits[i].limit == 0) { 2846 qos->rate_limits[i].limit = SPDK_BDEV_QOS_LIMIT_NOT_DEFINED; 2847 } 2848 } 2849 bdev_qos_update_max_quota_per_timeslice(qos); 2850 qos->timeslice_size = 2851 SPDK_BDEV_QOS_TIMESLICE_IN_USEC * spdk_get_ticks_hz() / SPDK_SEC_TO_USEC; 2852 qos->last_timeslice = spdk_get_ticks(); 2853 qos->poller = SPDK_POLLER_REGISTER(bdev_channel_poll_qos, 2854 qos, 2855 SPDK_BDEV_QOS_TIMESLICE_IN_USEC); 2856 } 2857 2858 ch->flags |= BDEV_CH_QOS_ENABLED; 2859 } 2860 } 2861 2862 struct poll_timeout_ctx { 2863 struct spdk_bdev_desc *desc; 2864 uint64_t timeout_in_sec; 2865 spdk_bdev_io_timeout_cb cb_fn; 2866 void *cb_arg; 2867 }; 2868 2869 static void 2870 bdev_desc_free(struct spdk_bdev_desc *desc) 2871 { 2872 pthread_mutex_destroy(&desc->mutex); 2873 free(desc->media_events_buffer); 2874 free(desc); 2875 } 2876 2877 static void 2878 bdev_channel_poll_timeout_io_done(struct spdk_io_channel_iter *i, int status) 2879 { 2880 struct poll_timeout_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2881 struct spdk_bdev_desc *desc = ctx->desc; 2882 2883 free(ctx); 2884 2885 pthread_mutex_lock(&desc->mutex); 2886 desc->refs--; 2887 if (desc->closed == true && desc->refs == 0) { 2888 pthread_mutex_unlock(&desc->mutex); 2889 bdev_desc_free(desc); 2890 return; 2891 } 2892 pthread_mutex_unlock(&desc->mutex); 2893 } 2894 2895 static void 2896 bdev_channel_poll_timeout_io(struct spdk_io_channel_iter *i) 2897 { 2898 struct poll_timeout_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 2899 struct spdk_io_channel *io_ch = spdk_io_channel_iter_get_channel(i); 2900 struct spdk_bdev_channel *bdev_ch = spdk_io_channel_get_ctx(io_ch); 2901 struct spdk_bdev_desc *desc = ctx->desc; 2902 struct spdk_bdev_io *bdev_io; 2903 uint64_t now; 2904 2905 pthread_mutex_lock(&desc->mutex); 2906 if (desc->closed == true) { 2907 pthread_mutex_unlock(&desc->mutex); 2908 spdk_for_each_channel_continue(i, -1); 2909 return; 2910 } 2911 pthread_mutex_unlock(&desc->mutex); 2912 2913 now = spdk_get_ticks(); 2914 TAILQ_FOREACH(bdev_io, &bdev_ch->io_submitted, internal.ch_link) { 2915 /* Exclude any I/O that are generated via splitting. */ 2916 if (bdev_io->internal.cb == bdev_io_split_done) { 2917 continue; 2918 } 2919 2920 /* Once we find an I/O that has not timed out, we can immediately 2921 * exit the loop. 2922 */ 2923 if (now < (bdev_io->internal.submit_tsc + 2924 ctx->timeout_in_sec * spdk_get_ticks_hz())) { 2925 goto end; 2926 } 2927 2928 if (bdev_io->internal.desc == desc) { 2929 ctx->cb_fn(ctx->cb_arg, bdev_io); 2930 } 2931 } 2932 2933 end: 2934 spdk_for_each_channel_continue(i, 0); 2935 } 2936 2937 static int 2938 bdev_poll_timeout_io(void *arg) 2939 { 2940 struct spdk_bdev_desc *desc = arg; 2941 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 2942 struct poll_timeout_ctx *ctx; 2943 2944 ctx = calloc(1, sizeof(struct poll_timeout_ctx)); 2945 if (!ctx) { 2946 SPDK_ERRLOG("failed to allocate memory\n"); 2947 return SPDK_POLLER_BUSY; 2948 } 2949 ctx->desc = desc; 2950 ctx->cb_arg = desc->cb_arg; 2951 ctx->cb_fn = desc->cb_fn; 2952 ctx->timeout_in_sec = desc->timeout_in_sec; 2953 2954 /* Take a ref on the descriptor in case it gets closed while we are checking 2955 * all of the channels. 2956 */ 2957 pthread_mutex_lock(&desc->mutex); 2958 desc->refs++; 2959 pthread_mutex_unlock(&desc->mutex); 2960 2961 spdk_for_each_channel(__bdev_to_io_dev(bdev), 2962 bdev_channel_poll_timeout_io, 2963 ctx, 2964 bdev_channel_poll_timeout_io_done); 2965 2966 return SPDK_POLLER_BUSY; 2967 } 2968 2969 int 2970 spdk_bdev_set_timeout(struct spdk_bdev_desc *desc, uint64_t timeout_in_sec, 2971 spdk_bdev_io_timeout_cb cb_fn, void *cb_arg) 2972 { 2973 assert(desc->thread == spdk_get_thread()); 2974 2975 spdk_poller_unregister(&desc->io_timeout_poller); 2976 2977 if (timeout_in_sec) { 2978 assert(cb_fn != NULL); 2979 desc->io_timeout_poller = SPDK_POLLER_REGISTER(bdev_poll_timeout_io, 2980 desc, 2981 SPDK_BDEV_IO_POLL_INTERVAL_IN_MSEC * SPDK_SEC_TO_USEC / 2982 1000); 2983 if (desc->io_timeout_poller == NULL) { 2984 SPDK_ERRLOG("can not register the desc timeout IO poller\n"); 2985 return -1; 2986 } 2987 } 2988 2989 desc->cb_fn = cb_fn; 2990 desc->cb_arg = cb_arg; 2991 desc->timeout_in_sec = timeout_in_sec; 2992 2993 return 0; 2994 } 2995 2996 static int 2997 bdev_channel_create(void *io_device, void *ctx_buf) 2998 { 2999 struct spdk_bdev *bdev = __bdev_from_io_dev(io_device); 3000 struct spdk_bdev_channel *ch = ctx_buf; 3001 struct spdk_io_channel *mgmt_io_ch; 3002 struct spdk_bdev_mgmt_channel *mgmt_ch; 3003 struct spdk_bdev_shared_resource *shared_resource; 3004 struct lba_range *range; 3005 3006 ch->bdev = bdev; 3007 ch->channel = bdev->fn_table->get_io_channel(bdev->ctxt); 3008 if (!ch->channel) { 3009 return -1; 3010 } 3011 3012 assert(ch->histogram == NULL); 3013 if (bdev->internal.histogram_enabled) { 3014 ch->histogram = spdk_histogram_data_alloc(); 3015 if (ch->histogram == NULL) { 3016 SPDK_ERRLOG("Could not allocate histogram\n"); 3017 } 3018 } 3019 3020 mgmt_io_ch = spdk_get_io_channel(&g_bdev_mgr); 3021 if (!mgmt_io_ch) { 3022 spdk_put_io_channel(ch->channel); 3023 return -1; 3024 } 3025 3026 mgmt_ch = spdk_io_channel_get_ctx(mgmt_io_ch); 3027 TAILQ_FOREACH(shared_resource, &mgmt_ch->shared_resources, link) { 3028 if (shared_resource->shared_ch == ch->channel) { 3029 spdk_put_io_channel(mgmt_io_ch); 3030 shared_resource->ref++; 3031 break; 3032 } 3033 } 3034 3035 if (shared_resource == NULL) { 3036 shared_resource = calloc(1, sizeof(*shared_resource)); 3037 if (shared_resource == NULL) { 3038 spdk_put_io_channel(ch->channel); 3039 spdk_put_io_channel(mgmt_io_ch); 3040 return -1; 3041 } 3042 3043 shared_resource->mgmt_ch = mgmt_ch; 3044 shared_resource->io_outstanding = 0; 3045 TAILQ_INIT(&shared_resource->nomem_io); 3046 shared_resource->nomem_threshold = 0; 3047 shared_resource->shared_ch = ch->channel; 3048 shared_resource->ref = 1; 3049 TAILQ_INSERT_TAIL(&mgmt_ch->shared_resources, shared_resource, link); 3050 } 3051 3052 memset(&ch->stat, 0, sizeof(ch->stat)); 3053 ch->stat.ticks_rate = spdk_get_ticks_hz(); 3054 ch->io_outstanding = 0; 3055 TAILQ_INIT(&ch->queued_resets); 3056 TAILQ_INIT(&ch->locked_ranges); 3057 ch->flags = 0; 3058 ch->shared_resource = shared_resource; 3059 3060 TAILQ_INIT(&ch->io_submitted); 3061 TAILQ_INIT(&ch->io_locked); 3062 3063 #ifdef SPDK_CONFIG_VTUNE 3064 { 3065 char *name; 3066 __itt_init_ittlib(NULL, 0); 3067 name = spdk_sprintf_alloc("spdk_bdev_%s_%p", ch->bdev->name, ch); 3068 if (!name) { 3069 bdev_channel_destroy_resource(ch); 3070 return -1; 3071 } 3072 ch->handle = __itt_string_handle_create(name); 3073 free(name); 3074 ch->start_tsc = spdk_get_ticks(); 3075 ch->interval_tsc = spdk_get_ticks_hz() / 100; 3076 memset(&ch->prev_stat, 0, sizeof(ch->prev_stat)); 3077 } 3078 #endif 3079 3080 pthread_mutex_lock(&bdev->internal.mutex); 3081 bdev_enable_qos(bdev, ch); 3082 3083 TAILQ_FOREACH(range, &bdev->internal.locked_ranges, tailq) { 3084 struct lba_range *new_range; 3085 3086 new_range = calloc(1, sizeof(*new_range)); 3087 if (new_range == NULL) { 3088 pthread_mutex_unlock(&bdev->internal.mutex); 3089 bdev_channel_destroy_resource(ch); 3090 return -1; 3091 } 3092 new_range->length = range->length; 3093 new_range->offset = range->offset; 3094 new_range->locked_ctx = range->locked_ctx; 3095 TAILQ_INSERT_TAIL(&ch->locked_ranges, new_range, tailq); 3096 } 3097 3098 pthread_mutex_unlock(&bdev->internal.mutex); 3099 3100 return 0; 3101 } 3102 3103 /* 3104 * Abort I/O that are waiting on a data buffer. These types of I/O are 3105 * linked using the spdk_bdev_io internal.buf_link TAILQ_ENTRY. 3106 */ 3107 static void 3108 bdev_abort_all_buf_io(bdev_io_stailq_t *queue, struct spdk_bdev_channel *ch) 3109 { 3110 bdev_io_stailq_t tmp; 3111 struct spdk_bdev_io *bdev_io; 3112 3113 STAILQ_INIT(&tmp); 3114 3115 while (!STAILQ_EMPTY(queue)) { 3116 bdev_io = STAILQ_FIRST(queue); 3117 STAILQ_REMOVE_HEAD(queue, internal.buf_link); 3118 if (bdev_io->internal.ch == ch) { 3119 spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_ABORTED); 3120 } else { 3121 STAILQ_INSERT_TAIL(&tmp, bdev_io, internal.buf_link); 3122 } 3123 } 3124 3125 STAILQ_SWAP(&tmp, queue, spdk_bdev_io); 3126 } 3127 3128 /* 3129 * Abort I/O that are queued waiting for submission. These types of I/O are 3130 * linked using the spdk_bdev_io link TAILQ_ENTRY. 3131 */ 3132 static void 3133 bdev_abort_all_queued_io(bdev_io_tailq_t *queue, struct spdk_bdev_channel *ch) 3134 { 3135 struct spdk_bdev_io *bdev_io, *tmp; 3136 3137 TAILQ_FOREACH_SAFE(bdev_io, queue, internal.link, tmp) { 3138 if (bdev_io->internal.ch == ch) { 3139 TAILQ_REMOVE(queue, bdev_io, internal.link); 3140 /* 3141 * spdk_bdev_io_complete() assumes that the completed I/O had 3142 * been submitted to the bdev module. Since in this case it 3143 * hadn't, bump io_outstanding to account for the decrement 3144 * that spdk_bdev_io_complete() will do. 3145 */ 3146 if (bdev_io->type != SPDK_BDEV_IO_TYPE_RESET) { 3147 ch->io_outstanding++; 3148 ch->shared_resource->io_outstanding++; 3149 } 3150 spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_ABORTED); 3151 } 3152 } 3153 } 3154 3155 static bool 3156 bdev_abort_queued_io(bdev_io_tailq_t *queue, struct spdk_bdev_io *bio_to_abort) 3157 { 3158 struct spdk_bdev_io *bdev_io; 3159 3160 TAILQ_FOREACH(bdev_io, queue, internal.link) { 3161 if (bdev_io == bio_to_abort) { 3162 TAILQ_REMOVE(queue, bio_to_abort, internal.link); 3163 spdk_bdev_io_complete(bio_to_abort, SPDK_BDEV_IO_STATUS_ABORTED); 3164 return true; 3165 } 3166 } 3167 3168 return false; 3169 } 3170 3171 static bool 3172 bdev_abort_buf_io(bdev_io_stailq_t *queue, struct spdk_bdev_io *bio_to_abort) 3173 { 3174 struct spdk_bdev_io *bdev_io; 3175 3176 STAILQ_FOREACH(bdev_io, queue, internal.buf_link) { 3177 if (bdev_io == bio_to_abort) { 3178 STAILQ_REMOVE(queue, bio_to_abort, spdk_bdev_io, internal.buf_link); 3179 spdk_bdev_io_complete(bio_to_abort, SPDK_BDEV_IO_STATUS_ABORTED); 3180 return true; 3181 } 3182 } 3183 3184 return false; 3185 } 3186 3187 static void 3188 bdev_qos_channel_destroy(void *cb_arg) 3189 { 3190 struct spdk_bdev_qos *qos = cb_arg; 3191 3192 spdk_put_io_channel(spdk_io_channel_from_ctx(qos->ch)); 3193 spdk_poller_unregister(&qos->poller); 3194 3195 SPDK_DEBUGLOG(bdev, "Free QoS %p.\n", qos); 3196 3197 free(qos); 3198 } 3199 3200 static int 3201 bdev_qos_destroy(struct spdk_bdev *bdev) 3202 { 3203 int i; 3204 3205 /* 3206 * Cleanly shutting down the QoS poller is tricky, because 3207 * during the asynchronous operation the user could open 3208 * a new descriptor and create a new channel, spawning 3209 * a new QoS poller. 3210 * 3211 * The strategy is to create a new QoS structure here and swap it 3212 * in. The shutdown path then continues to refer to the old one 3213 * until it completes and then releases it. 3214 */ 3215 struct spdk_bdev_qos *new_qos, *old_qos; 3216 3217 old_qos = bdev->internal.qos; 3218 3219 new_qos = calloc(1, sizeof(*new_qos)); 3220 if (!new_qos) { 3221 SPDK_ERRLOG("Unable to allocate memory to shut down QoS.\n"); 3222 return -ENOMEM; 3223 } 3224 3225 /* Copy the old QoS data into the newly allocated structure */ 3226 memcpy(new_qos, old_qos, sizeof(*new_qos)); 3227 3228 /* Zero out the key parts of the QoS structure */ 3229 new_qos->ch = NULL; 3230 new_qos->thread = NULL; 3231 new_qos->poller = NULL; 3232 TAILQ_INIT(&new_qos->queued); 3233 /* 3234 * The limit member of spdk_bdev_qos_limit structure is not zeroed. 3235 * It will be used later for the new QoS structure. 3236 */ 3237 for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) { 3238 new_qos->rate_limits[i].remaining_this_timeslice = 0; 3239 new_qos->rate_limits[i].min_per_timeslice = 0; 3240 new_qos->rate_limits[i].max_per_timeslice = 0; 3241 } 3242 3243 bdev->internal.qos = new_qos; 3244 3245 if (old_qos->thread == NULL) { 3246 free(old_qos); 3247 } else { 3248 spdk_thread_send_msg(old_qos->thread, bdev_qos_channel_destroy, old_qos); 3249 } 3250 3251 /* It is safe to continue with destroying the bdev even though the QoS channel hasn't 3252 * been destroyed yet. The destruction path will end up waiting for the final 3253 * channel to be put before it releases resources. */ 3254 3255 return 0; 3256 } 3257 3258 static void 3259 bdev_io_stat_add(struct spdk_bdev_io_stat *total, struct spdk_bdev_io_stat *add) 3260 { 3261 total->bytes_read += add->bytes_read; 3262 total->num_read_ops += add->num_read_ops; 3263 total->bytes_written += add->bytes_written; 3264 total->num_write_ops += add->num_write_ops; 3265 total->bytes_unmapped += add->bytes_unmapped; 3266 total->num_unmap_ops += add->num_unmap_ops; 3267 total->read_latency_ticks += add->read_latency_ticks; 3268 total->write_latency_ticks += add->write_latency_ticks; 3269 total->unmap_latency_ticks += add->unmap_latency_ticks; 3270 } 3271 3272 static void 3273 bdev_channel_destroy(void *io_device, void *ctx_buf) 3274 { 3275 struct spdk_bdev_channel *ch = ctx_buf; 3276 struct spdk_bdev_mgmt_channel *mgmt_ch; 3277 struct spdk_bdev_shared_resource *shared_resource = ch->shared_resource; 3278 3279 SPDK_DEBUGLOG(bdev, "Destroying channel %p for bdev %s on thread %p\n", ch, ch->bdev->name, 3280 spdk_get_thread()); 3281 3282 /* This channel is going away, so add its statistics into the bdev so that they don't get lost. */ 3283 pthread_mutex_lock(&ch->bdev->internal.mutex); 3284 bdev_io_stat_add(&ch->bdev->internal.stat, &ch->stat); 3285 pthread_mutex_unlock(&ch->bdev->internal.mutex); 3286 3287 mgmt_ch = shared_resource->mgmt_ch; 3288 3289 bdev_abort_all_queued_io(&ch->queued_resets, ch); 3290 bdev_abort_all_queued_io(&shared_resource->nomem_io, ch); 3291 bdev_abort_all_buf_io(&mgmt_ch->need_buf_small, ch); 3292 bdev_abort_all_buf_io(&mgmt_ch->need_buf_large, ch); 3293 3294 if (ch->histogram) { 3295 spdk_histogram_data_free(ch->histogram); 3296 } 3297 3298 bdev_channel_destroy_resource(ch); 3299 } 3300 3301 /* 3302 * If the name already exists in the global bdev name tree, RB_INSERT() returns a pointer 3303 * to it. Hence we do not have to call bdev_get_by_name() when using this function. 3304 */ 3305 static int 3306 bdev_name_add(struct spdk_bdev_name *bdev_name, struct spdk_bdev *bdev, const char *name) 3307 { 3308 struct spdk_bdev_name *tmp; 3309 3310 bdev_name->name = strdup(name); 3311 if (bdev_name->name == NULL) { 3312 SPDK_ERRLOG("Unable to allocate bdev name\n"); 3313 return -ENOMEM; 3314 } 3315 3316 bdev_name->bdev = bdev; 3317 3318 pthread_mutex_lock(&g_bdev_mgr.mutex); 3319 tmp = RB_INSERT(bdev_name_tree, &g_bdev_mgr.bdev_names, bdev_name); 3320 pthread_mutex_unlock(&g_bdev_mgr.mutex); 3321 3322 if (tmp != NULL) { 3323 SPDK_ERRLOG("Bdev name %s already exists\n", name); 3324 free(bdev_name->name); 3325 return -EEXIST; 3326 } 3327 3328 return 0; 3329 } 3330 3331 static void 3332 bdev_name_del(struct spdk_bdev_name *bdev_name) 3333 { 3334 RB_REMOVE(bdev_name_tree, &g_bdev_mgr.bdev_names, bdev_name); 3335 free(bdev_name->name); 3336 } 3337 3338 int 3339 spdk_bdev_alias_add(struct spdk_bdev *bdev, const char *alias) 3340 { 3341 struct spdk_bdev_alias *tmp; 3342 int ret; 3343 3344 if (alias == NULL) { 3345 SPDK_ERRLOG("Empty alias passed\n"); 3346 return -EINVAL; 3347 } 3348 3349 tmp = calloc(1, sizeof(*tmp)); 3350 if (tmp == NULL) { 3351 SPDK_ERRLOG("Unable to allocate alias\n"); 3352 return -ENOMEM; 3353 } 3354 3355 ret = bdev_name_add(&tmp->alias, bdev, alias); 3356 if (ret != 0) { 3357 free(tmp); 3358 return ret; 3359 } 3360 3361 TAILQ_INSERT_TAIL(&bdev->aliases, tmp, tailq); 3362 3363 return 0; 3364 } 3365 3366 int 3367 spdk_bdev_alias_del(struct spdk_bdev *bdev, const char *alias) 3368 { 3369 struct spdk_bdev_alias *tmp; 3370 3371 TAILQ_FOREACH(tmp, &bdev->aliases, tailq) { 3372 if (strcmp(alias, tmp->alias.name) == 0) { 3373 TAILQ_REMOVE(&bdev->aliases, tmp, tailq); 3374 pthread_mutex_lock(&g_bdev_mgr.mutex); 3375 bdev_name_del(&tmp->alias); 3376 pthread_mutex_unlock(&g_bdev_mgr.mutex); 3377 free(tmp); 3378 return 0; 3379 } 3380 } 3381 3382 SPDK_INFOLOG(bdev, "Alias %s does not exists\n", alias); 3383 3384 return -ENOENT; 3385 } 3386 3387 void 3388 spdk_bdev_alias_del_all(struct spdk_bdev *bdev) 3389 { 3390 struct spdk_bdev_alias *p, *tmp; 3391 3392 TAILQ_FOREACH_SAFE(p, &bdev->aliases, tailq, tmp) { 3393 TAILQ_REMOVE(&bdev->aliases, p, tailq); 3394 pthread_mutex_lock(&g_bdev_mgr.mutex); 3395 bdev_name_del(&p->alias); 3396 pthread_mutex_unlock(&g_bdev_mgr.mutex); 3397 free(p); 3398 } 3399 } 3400 3401 struct spdk_io_channel * 3402 spdk_bdev_get_io_channel(struct spdk_bdev_desc *desc) 3403 { 3404 return spdk_get_io_channel(__bdev_to_io_dev(spdk_bdev_desc_get_bdev(desc))); 3405 } 3406 3407 void * 3408 spdk_bdev_get_module_ctx(struct spdk_bdev_desc *desc) 3409 { 3410 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 3411 void *ctx = NULL; 3412 3413 if (bdev->fn_table->get_module_ctx) { 3414 ctx = bdev->fn_table->get_module_ctx(bdev->ctxt); 3415 } 3416 3417 return ctx; 3418 } 3419 3420 const char * 3421 spdk_bdev_get_module_name(const struct spdk_bdev *bdev) 3422 { 3423 return bdev->module->name; 3424 } 3425 3426 const char * 3427 spdk_bdev_get_name(const struct spdk_bdev *bdev) 3428 { 3429 return bdev->name; 3430 } 3431 3432 const char * 3433 spdk_bdev_get_product_name(const struct spdk_bdev *bdev) 3434 { 3435 return bdev->product_name; 3436 } 3437 3438 const struct spdk_bdev_aliases_list * 3439 spdk_bdev_get_aliases(const struct spdk_bdev *bdev) 3440 { 3441 return &bdev->aliases; 3442 } 3443 3444 uint32_t 3445 spdk_bdev_get_block_size(const struct spdk_bdev *bdev) 3446 { 3447 return bdev->blocklen; 3448 } 3449 3450 uint32_t 3451 spdk_bdev_get_write_unit_size(const struct spdk_bdev *bdev) 3452 { 3453 return bdev->write_unit_size; 3454 } 3455 3456 uint64_t 3457 spdk_bdev_get_num_blocks(const struct spdk_bdev *bdev) 3458 { 3459 return bdev->blockcnt; 3460 } 3461 3462 const char * 3463 spdk_bdev_get_qos_rpc_type(enum spdk_bdev_qos_rate_limit_type type) 3464 { 3465 return qos_rpc_type[type]; 3466 } 3467 3468 void 3469 spdk_bdev_get_qos_rate_limits(struct spdk_bdev *bdev, uint64_t *limits) 3470 { 3471 int i; 3472 3473 memset(limits, 0, sizeof(*limits) * SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES); 3474 3475 pthread_mutex_lock(&bdev->internal.mutex); 3476 if (bdev->internal.qos) { 3477 for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) { 3478 if (bdev->internal.qos->rate_limits[i].limit != 3479 SPDK_BDEV_QOS_LIMIT_NOT_DEFINED) { 3480 limits[i] = bdev->internal.qos->rate_limits[i].limit; 3481 if (bdev_qos_is_iops_rate_limit(i) == false) { 3482 /* Change from Byte to Megabyte which is user visible. */ 3483 limits[i] = limits[i] / 1024 / 1024; 3484 } 3485 } 3486 } 3487 } 3488 pthread_mutex_unlock(&bdev->internal.mutex); 3489 } 3490 3491 size_t 3492 spdk_bdev_get_buf_align(const struct spdk_bdev *bdev) 3493 { 3494 return 1 << bdev->required_alignment; 3495 } 3496 3497 uint32_t 3498 spdk_bdev_get_optimal_io_boundary(const struct spdk_bdev *bdev) 3499 { 3500 return bdev->optimal_io_boundary; 3501 } 3502 3503 bool 3504 spdk_bdev_has_write_cache(const struct spdk_bdev *bdev) 3505 { 3506 return bdev->write_cache; 3507 } 3508 3509 const struct spdk_uuid * 3510 spdk_bdev_get_uuid(const struct spdk_bdev *bdev) 3511 { 3512 return &bdev->uuid; 3513 } 3514 3515 uint16_t 3516 spdk_bdev_get_acwu(const struct spdk_bdev *bdev) 3517 { 3518 return bdev->acwu; 3519 } 3520 3521 uint32_t 3522 spdk_bdev_get_md_size(const struct spdk_bdev *bdev) 3523 { 3524 return bdev->md_len; 3525 } 3526 3527 bool 3528 spdk_bdev_is_md_interleaved(const struct spdk_bdev *bdev) 3529 { 3530 return (bdev->md_len != 0) && bdev->md_interleave; 3531 } 3532 3533 bool 3534 spdk_bdev_is_md_separate(const struct spdk_bdev *bdev) 3535 { 3536 return (bdev->md_len != 0) && !bdev->md_interleave; 3537 } 3538 3539 bool 3540 spdk_bdev_is_zoned(const struct spdk_bdev *bdev) 3541 { 3542 return bdev->zoned; 3543 } 3544 3545 uint32_t 3546 spdk_bdev_get_data_block_size(const struct spdk_bdev *bdev) 3547 { 3548 if (spdk_bdev_is_md_interleaved(bdev)) { 3549 return bdev->blocklen - bdev->md_len; 3550 } else { 3551 return bdev->blocklen; 3552 } 3553 } 3554 3555 uint32_t 3556 spdk_bdev_get_physical_block_size(const struct spdk_bdev *bdev) 3557 { 3558 return bdev->phys_blocklen; 3559 } 3560 3561 static uint32_t 3562 _bdev_get_block_size_with_md(const struct spdk_bdev *bdev) 3563 { 3564 if (!spdk_bdev_is_md_interleaved(bdev)) { 3565 return bdev->blocklen + bdev->md_len; 3566 } else { 3567 return bdev->blocklen; 3568 } 3569 } 3570 3571 enum spdk_dif_type spdk_bdev_get_dif_type(const struct spdk_bdev *bdev) 3572 { 3573 if (bdev->md_len != 0) { 3574 return bdev->dif_type; 3575 } else { 3576 return SPDK_DIF_DISABLE; 3577 } 3578 } 3579 3580 bool 3581 spdk_bdev_is_dif_head_of_md(const struct spdk_bdev *bdev) 3582 { 3583 if (spdk_bdev_get_dif_type(bdev) != SPDK_DIF_DISABLE) { 3584 return bdev->dif_is_head_of_md; 3585 } else { 3586 return false; 3587 } 3588 } 3589 3590 bool 3591 spdk_bdev_is_dif_check_enabled(const struct spdk_bdev *bdev, 3592 enum spdk_dif_check_type check_type) 3593 { 3594 if (spdk_bdev_get_dif_type(bdev) == SPDK_DIF_DISABLE) { 3595 return false; 3596 } 3597 3598 switch (check_type) { 3599 case SPDK_DIF_CHECK_TYPE_REFTAG: 3600 return (bdev->dif_check_flags & SPDK_DIF_FLAGS_REFTAG_CHECK) != 0; 3601 case SPDK_DIF_CHECK_TYPE_APPTAG: 3602 return (bdev->dif_check_flags & SPDK_DIF_FLAGS_APPTAG_CHECK) != 0; 3603 case SPDK_DIF_CHECK_TYPE_GUARD: 3604 return (bdev->dif_check_flags & SPDK_DIF_FLAGS_GUARD_CHECK) != 0; 3605 default: 3606 return false; 3607 } 3608 } 3609 3610 uint64_t 3611 spdk_bdev_get_qd(const struct spdk_bdev *bdev) 3612 { 3613 return bdev->internal.measured_queue_depth; 3614 } 3615 3616 uint64_t 3617 spdk_bdev_get_qd_sampling_period(const struct spdk_bdev *bdev) 3618 { 3619 return bdev->internal.period; 3620 } 3621 3622 uint64_t 3623 spdk_bdev_get_weighted_io_time(const struct spdk_bdev *bdev) 3624 { 3625 return bdev->internal.weighted_io_time; 3626 } 3627 3628 uint64_t 3629 spdk_bdev_get_io_time(const struct spdk_bdev *bdev) 3630 { 3631 return bdev->internal.io_time; 3632 } 3633 3634 static void 3635 _calculate_measured_qd_cpl(struct spdk_io_channel_iter *i, int status) 3636 { 3637 struct spdk_bdev *bdev = spdk_io_channel_iter_get_ctx(i); 3638 3639 bdev->internal.measured_queue_depth = bdev->internal.temporary_queue_depth; 3640 3641 if (bdev->internal.measured_queue_depth) { 3642 bdev->internal.io_time += bdev->internal.period; 3643 bdev->internal.weighted_io_time += bdev->internal.period * bdev->internal.measured_queue_depth; 3644 } 3645 } 3646 3647 static void 3648 _calculate_measured_qd(struct spdk_io_channel_iter *i) 3649 { 3650 struct spdk_bdev *bdev = spdk_io_channel_iter_get_ctx(i); 3651 struct spdk_io_channel *io_ch = spdk_io_channel_iter_get_channel(i); 3652 struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(io_ch); 3653 3654 bdev->internal.temporary_queue_depth += ch->io_outstanding; 3655 spdk_for_each_channel_continue(i, 0); 3656 } 3657 3658 static int 3659 bdev_calculate_measured_queue_depth(void *ctx) 3660 { 3661 struct spdk_bdev *bdev = ctx; 3662 bdev->internal.temporary_queue_depth = 0; 3663 spdk_for_each_channel(__bdev_to_io_dev(bdev), _calculate_measured_qd, bdev, 3664 _calculate_measured_qd_cpl); 3665 return SPDK_POLLER_BUSY; 3666 } 3667 3668 void 3669 spdk_bdev_set_qd_sampling_period(struct spdk_bdev *bdev, uint64_t period) 3670 { 3671 bdev->internal.period = period; 3672 3673 if (bdev->internal.qd_poller != NULL) { 3674 spdk_poller_unregister(&bdev->internal.qd_poller); 3675 bdev->internal.measured_queue_depth = UINT64_MAX; 3676 } 3677 3678 if (period != 0) { 3679 bdev->internal.qd_poller = SPDK_POLLER_REGISTER(bdev_calculate_measured_queue_depth, bdev, 3680 period); 3681 } 3682 } 3683 3684 static void 3685 _resize_notify(void *arg) 3686 { 3687 struct spdk_bdev_desc *desc = arg; 3688 3689 pthread_mutex_lock(&desc->mutex); 3690 desc->refs--; 3691 if (!desc->closed) { 3692 pthread_mutex_unlock(&desc->mutex); 3693 desc->callback.event_fn(SPDK_BDEV_EVENT_RESIZE, 3694 desc->bdev, 3695 desc->callback.ctx); 3696 return; 3697 } else if (0 == desc->refs) { 3698 /* This descriptor was closed after this resize_notify message was sent. 3699 * spdk_bdev_close() could not free the descriptor since this message was 3700 * in flight, so we free it now using bdev_desc_free(). 3701 */ 3702 pthread_mutex_unlock(&desc->mutex); 3703 bdev_desc_free(desc); 3704 return; 3705 } 3706 pthread_mutex_unlock(&desc->mutex); 3707 } 3708 3709 int 3710 spdk_bdev_notify_blockcnt_change(struct spdk_bdev *bdev, uint64_t size) 3711 { 3712 struct spdk_bdev_desc *desc; 3713 int ret; 3714 3715 if (size == bdev->blockcnt) { 3716 return 0; 3717 } 3718 3719 pthread_mutex_lock(&bdev->internal.mutex); 3720 3721 /* bdev has open descriptors */ 3722 if (!TAILQ_EMPTY(&bdev->internal.open_descs) && 3723 bdev->blockcnt > size) { 3724 ret = -EBUSY; 3725 } else { 3726 bdev->blockcnt = size; 3727 TAILQ_FOREACH(desc, &bdev->internal.open_descs, link) { 3728 pthread_mutex_lock(&desc->mutex); 3729 if (!desc->closed) { 3730 desc->refs++; 3731 spdk_thread_send_msg(desc->thread, _resize_notify, desc); 3732 } 3733 pthread_mutex_unlock(&desc->mutex); 3734 } 3735 ret = 0; 3736 } 3737 3738 pthread_mutex_unlock(&bdev->internal.mutex); 3739 3740 return ret; 3741 } 3742 3743 /* 3744 * Convert I/O offset and length from bytes to blocks. 3745 * 3746 * Returns zero on success or non-zero if the byte parameters aren't divisible by the block size. 3747 */ 3748 static uint64_t 3749 bdev_bytes_to_blocks(struct spdk_bdev *bdev, uint64_t offset_bytes, uint64_t *offset_blocks, 3750 uint64_t num_bytes, uint64_t *num_blocks) 3751 { 3752 uint32_t block_size = bdev->blocklen; 3753 uint8_t shift_cnt; 3754 3755 /* Avoid expensive div operations if possible. These spdk_u32 functions are very cheap. */ 3756 if (spdk_likely(spdk_u32_is_pow2(block_size))) { 3757 shift_cnt = spdk_u32log2(block_size); 3758 *offset_blocks = offset_bytes >> shift_cnt; 3759 *num_blocks = num_bytes >> shift_cnt; 3760 return (offset_bytes - (*offset_blocks << shift_cnt)) | 3761 (num_bytes - (*num_blocks << shift_cnt)); 3762 } else { 3763 *offset_blocks = offset_bytes / block_size; 3764 *num_blocks = num_bytes / block_size; 3765 return (offset_bytes % block_size) | (num_bytes % block_size); 3766 } 3767 } 3768 3769 static bool 3770 bdev_io_valid_blocks(struct spdk_bdev *bdev, uint64_t offset_blocks, uint64_t num_blocks) 3771 { 3772 /* Return failure if offset_blocks + num_blocks is less than offset_blocks; indicates there 3773 * has been an overflow and hence the offset has been wrapped around */ 3774 if (offset_blocks + num_blocks < offset_blocks) { 3775 return false; 3776 } 3777 3778 /* Return failure if offset_blocks + num_blocks exceeds the size of the bdev */ 3779 if (offset_blocks + num_blocks > bdev->blockcnt) { 3780 return false; 3781 } 3782 3783 return true; 3784 } 3785 3786 static bool 3787 _bdev_io_check_md_buf(const struct iovec *iovs, const void *md_buf) 3788 { 3789 return _is_buf_allocated(iovs) == (md_buf != NULL); 3790 } 3791 3792 static int 3793 bdev_read_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, void *buf, 3794 void *md_buf, uint64_t offset_blocks, uint64_t num_blocks, 3795 spdk_bdev_io_completion_cb cb, void *cb_arg) 3796 { 3797 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 3798 struct spdk_bdev_io *bdev_io; 3799 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 3800 3801 if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) { 3802 return -EINVAL; 3803 } 3804 3805 bdev_io = bdev_channel_get_io(channel); 3806 if (!bdev_io) { 3807 return -ENOMEM; 3808 } 3809 3810 bdev_io->internal.ch = channel; 3811 bdev_io->internal.desc = desc; 3812 bdev_io->type = SPDK_BDEV_IO_TYPE_READ; 3813 bdev_io->u.bdev.iovs = &bdev_io->iov; 3814 bdev_io->u.bdev.iovs[0].iov_base = buf; 3815 bdev_io->u.bdev.iovs[0].iov_len = num_blocks * bdev->blocklen; 3816 bdev_io->u.bdev.iovcnt = 1; 3817 bdev_io->u.bdev.md_buf = md_buf; 3818 bdev_io->u.bdev.num_blocks = num_blocks; 3819 bdev_io->u.bdev.offset_blocks = offset_blocks; 3820 bdev_io_init(bdev_io, bdev, cb_arg, cb); 3821 3822 bdev_io_submit(bdev_io); 3823 return 0; 3824 } 3825 3826 int 3827 spdk_bdev_read(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 3828 void *buf, uint64_t offset, uint64_t nbytes, 3829 spdk_bdev_io_completion_cb cb, void *cb_arg) 3830 { 3831 uint64_t offset_blocks, num_blocks; 3832 3833 if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks, 3834 nbytes, &num_blocks) != 0) { 3835 return -EINVAL; 3836 } 3837 3838 return spdk_bdev_read_blocks(desc, ch, buf, offset_blocks, num_blocks, cb, cb_arg); 3839 } 3840 3841 int 3842 spdk_bdev_read_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 3843 void *buf, uint64_t offset_blocks, uint64_t num_blocks, 3844 spdk_bdev_io_completion_cb cb, void *cb_arg) 3845 { 3846 return bdev_read_blocks_with_md(desc, ch, buf, NULL, offset_blocks, num_blocks, cb, cb_arg); 3847 } 3848 3849 int 3850 spdk_bdev_read_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 3851 void *buf, void *md_buf, uint64_t offset_blocks, uint64_t num_blocks, 3852 spdk_bdev_io_completion_cb cb, void *cb_arg) 3853 { 3854 struct iovec iov = { 3855 .iov_base = buf, 3856 }; 3857 3858 if (!spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) { 3859 return -EINVAL; 3860 } 3861 3862 if (!_bdev_io_check_md_buf(&iov, md_buf)) { 3863 return -EINVAL; 3864 } 3865 3866 return bdev_read_blocks_with_md(desc, ch, buf, md_buf, offset_blocks, num_blocks, 3867 cb, cb_arg); 3868 } 3869 3870 int 3871 spdk_bdev_readv(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 3872 struct iovec *iov, int iovcnt, 3873 uint64_t offset, uint64_t nbytes, 3874 spdk_bdev_io_completion_cb cb, void *cb_arg) 3875 { 3876 uint64_t offset_blocks, num_blocks; 3877 3878 if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks, 3879 nbytes, &num_blocks) != 0) { 3880 return -EINVAL; 3881 } 3882 3883 return spdk_bdev_readv_blocks(desc, ch, iov, iovcnt, offset_blocks, num_blocks, cb, cb_arg); 3884 } 3885 3886 static int 3887 bdev_readv_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 3888 struct iovec *iov, int iovcnt, void *md_buf, uint64_t offset_blocks, 3889 uint64_t num_blocks, spdk_bdev_io_completion_cb cb, void *cb_arg, 3890 struct spdk_bdev_ext_io_opts *opts) 3891 { 3892 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 3893 struct spdk_bdev_io *bdev_io; 3894 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 3895 3896 if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) { 3897 return -EINVAL; 3898 } 3899 3900 bdev_io = bdev_channel_get_io(channel); 3901 if (!bdev_io) { 3902 return -ENOMEM; 3903 } 3904 3905 bdev_io->internal.ch = channel; 3906 bdev_io->internal.desc = desc; 3907 bdev_io->type = SPDK_BDEV_IO_TYPE_READ; 3908 bdev_io->u.bdev.iovs = iov; 3909 bdev_io->u.bdev.iovcnt = iovcnt; 3910 bdev_io->u.bdev.md_buf = md_buf; 3911 bdev_io->u.bdev.num_blocks = num_blocks; 3912 bdev_io->u.bdev.offset_blocks = offset_blocks; 3913 bdev_io_init(bdev_io, bdev, cb_arg, cb); 3914 bdev_io->internal.ext_opts = opts; 3915 3916 bdev_io_submit(bdev_io); 3917 return 0; 3918 } 3919 3920 int spdk_bdev_readv_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 3921 struct iovec *iov, int iovcnt, 3922 uint64_t offset_blocks, uint64_t num_blocks, 3923 spdk_bdev_io_completion_cb cb, void *cb_arg) 3924 { 3925 return bdev_readv_blocks_with_md(desc, ch, iov, iovcnt, NULL, offset_blocks, 3926 num_blocks, cb, cb_arg, NULL); 3927 } 3928 3929 int 3930 spdk_bdev_readv_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 3931 struct iovec *iov, int iovcnt, void *md_buf, 3932 uint64_t offset_blocks, uint64_t num_blocks, 3933 spdk_bdev_io_completion_cb cb, void *cb_arg) 3934 { 3935 if (!spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) { 3936 return -EINVAL; 3937 } 3938 3939 if (!_bdev_io_check_md_buf(iov, md_buf)) { 3940 return -EINVAL; 3941 } 3942 3943 return bdev_readv_blocks_with_md(desc, ch, iov, iovcnt, md_buf, offset_blocks, 3944 num_blocks, cb, cb_arg, NULL); 3945 } 3946 3947 int 3948 spdk_bdev_readv_blocks_ext(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 3949 struct iovec *iov, int iovcnt, 3950 uint64_t offset_blocks, uint64_t num_blocks, 3951 spdk_bdev_io_completion_cb cb, void *cb_arg, 3952 struct spdk_bdev_ext_io_opts *opts) 3953 { 3954 void *md = NULL; 3955 3956 if (opts) { 3957 md = opts->metadata; 3958 } 3959 3960 if (md && !spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) { 3961 return -EINVAL; 3962 } 3963 3964 if (md && !_bdev_io_check_md_buf(iov, md)) { 3965 return -EINVAL; 3966 } 3967 3968 return bdev_readv_blocks_with_md(desc, ch, iov, iovcnt, md, offset_blocks, 3969 num_blocks, cb, cb_arg, opts); 3970 } 3971 3972 static int 3973 bdev_write_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 3974 void *buf, void *md_buf, uint64_t offset_blocks, uint64_t num_blocks, 3975 spdk_bdev_io_completion_cb cb, void *cb_arg) 3976 { 3977 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 3978 struct spdk_bdev_io *bdev_io; 3979 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 3980 3981 if (!desc->write) { 3982 return -EBADF; 3983 } 3984 3985 if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) { 3986 return -EINVAL; 3987 } 3988 3989 bdev_io = bdev_channel_get_io(channel); 3990 if (!bdev_io) { 3991 return -ENOMEM; 3992 } 3993 3994 bdev_io->internal.ch = channel; 3995 bdev_io->internal.desc = desc; 3996 bdev_io->type = SPDK_BDEV_IO_TYPE_WRITE; 3997 bdev_io->u.bdev.iovs = &bdev_io->iov; 3998 bdev_io->u.bdev.iovs[0].iov_base = buf; 3999 bdev_io->u.bdev.iovs[0].iov_len = num_blocks * bdev->blocklen; 4000 bdev_io->u.bdev.iovcnt = 1; 4001 bdev_io->u.bdev.md_buf = md_buf; 4002 bdev_io->u.bdev.num_blocks = num_blocks; 4003 bdev_io->u.bdev.offset_blocks = offset_blocks; 4004 bdev_io_init(bdev_io, bdev, cb_arg, cb); 4005 4006 bdev_io_submit(bdev_io); 4007 return 0; 4008 } 4009 4010 int 4011 spdk_bdev_write(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4012 void *buf, uint64_t offset, uint64_t nbytes, 4013 spdk_bdev_io_completion_cb cb, void *cb_arg) 4014 { 4015 uint64_t offset_blocks, num_blocks; 4016 4017 if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks, 4018 nbytes, &num_blocks) != 0) { 4019 return -EINVAL; 4020 } 4021 4022 return spdk_bdev_write_blocks(desc, ch, buf, offset_blocks, num_blocks, cb, cb_arg); 4023 } 4024 4025 int 4026 spdk_bdev_write_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4027 void *buf, uint64_t offset_blocks, uint64_t num_blocks, 4028 spdk_bdev_io_completion_cb cb, void *cb_arg) 4029 { 4030 return bdev_write_blocks_with_md(desc, ch, buf, NULL, offset_blocks, num_blocks, 4031 cb, cb_arg); 4032 } 4033 4034 int 4035 spdk_bdev_write_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4036 void *buf, void *md_buf, uint64_t offset_blocks, uint64_t num_blocks, 4037 spdk_bdev_io_completion_cb cb, void *cb_arg) 4038 { 4039 struct iovec iov = { 4040 .iov_base = buf, 4041 }; 4042 4043 if (!spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) { 4044 return -EINVAL; 4045 } 4046 4047 if (!_bdev_io_check_md_buf(&iov, md_buf)) { 4048 return -EINVAL; 4049 } 4050 4051 return bdev_write_blocks_with_md(desc, ch, buf, md_buf, offset_blocks, num_blocks, 4052 cb, cb_arg); 4053 } 4054 4055 static int 4056 bdev_writev_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4057 struct iovec *iov, int iovcnt, void *md_buf, 4058 uint64_t offset_blocks, uint64_t num_blocks, 4059 spdk_bdev_io_completion_cb cb, void *cb_arg, 4060 struct spdk_bdev_ext_io_opts *opts) 4061 { 4062 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 4063 struct spdk_bdev_io *bdev_io; 4064 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 4065 4066 if (!desc->write) { 4067 return -EBADF; 4068 } 4069 4070 if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) { 4071 return -EINVAL; 4072 } 4073 4074 bdev_io = bdev_channel_get_io(channel); 4075 if (!bdev_io) { 4076 return -ENOMEM; 4077 } 4078 4079 bdev_io->internal.ch = channel; 4080 bdev_io->internal.desc = desc; 4081 bdev_io->type = SPDK_BDEV_IO_TYPE_WRITE; 4082 bdev_io->u.bdev.iovs = iov; 4083 bdev_io->u.bdev.iovcnt = iovcnt; 4084 bdev_io->u.bdev.md_buf = md_buf; 4085 bdev_io->u.bdev.num_blocks = num_blocks; 4086 bdev_io->u.bdev.offset_blocks = offset_blocks; 4087 bdev_io_init(bdev_io, bdev, cb_arg, cb); 4088 bdev_io->internal.ext_opts = opts; 4089 4090 bdev_io_submit(bdev_io); 4091 return 0; 4092 } 4093 4094 int 4095 spdk_bdev_writev(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4096 struct iovec *iov, int iovcnt, 4097 uint64_t offset, uint64_t len, 4098 spdk_bdev_io_completion_cb cb, void *cb_arg) 4099 { 4100 uint64_t offset_blocks, num_blocks; 4101 4102 if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks, 4103 len, &num_blocks) != 0) { 4104 return -EINVAL; 4105 } 4106 4107 return spdk_bdev_writev_blocks(desc, ch, iov, iovcnt, offset_blocks, num_blocks, cb, cb_arg); 4108 } 4109 4110 int 4111 spdk_bdev_writev_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4112 struct iovec *iov, int iovcnt, 4113 uint64_t offset_blocks, uint64_t num_blocks, 4114 spdk_bdev_io_completion_cb cb, void *cb_arg) 4115 { 4116 return bdev_writev_blocks_with_md(desc, ch, iov, iovcnt, NULL, offset_blocks, 4117 num_blocks, cb, cb_arg, NULL); 4118 } 4119 4120 int 4121 spdk_bdev_writev_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4122 struct iovec *iov, int iovcnt, void *md_buf, 4123 uint64_t offset_blocks, uint64_t num_blocks, 4124 spdk_bdev_io_completion_cb cb, void *cb_arg) 4125 { 4126 if (!spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) { 4127 return -EINVAL; 4128 } 4129 4130 if (!_bdev_io_check_md_buf(iov, md_buf)) { 4131 return -EINVAL; 4132 } 4133 4134 return bdev_writev_blocks_with_md(desc, ch, iov, iovcnt, md_buf, offset_blocks, 4135 num_blocks, cb, cb_arg, NULL); 4136 } 4137 4138 int 4139 spdk_bdev_writev_blocks_ext(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4140 struct iovec *iov, int iovcnt, 4141 uint64_t offset_blocks, uint64_t num_blocks, 4142 spdk_bdev_io_completion_cb cb, void *cb_arg, 4143 struct spdk_bdev_ext_io_opts *opts) 4144 { 4145 void *md = NULL; 4146 4147 if (opts) { 4148 md = opts->metadata; 4149 } 4150 4151 if (md && !spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) { 4152 return -EINVAL; 4153 } 4154 4155 if (md && !_bdev_io_check_md_buf(iov, md)) { 4156 return -EINVAL; 4157 } 4158 4159 return bdev_writev_blocks_with_md(desc, ch, iov, iovcnt, md, offset_blocks, 4160 num_blocks, cb, cb_arg, opts); 4161 } 4162 4163 static void 4164 bdev_compare_do_read_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg) 4165 { 4166 struct spdk_bdev_io *parent_io = cb_arg; 4167 uint8_t *read_buf = bdev_io->u.bdev.iovs[0].iov_base; 4168 int i, rc = 0; 4169 4170 if (!success) { 4171 parent_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED; 4172 parent_io->internal.cb(parent_io, false, parent_io->internal.caller_ctx); 4173 spdk_bdev_free_io(bdev_io); 4174 return; 4175 } 4176 4177 for (i = 0; i < parent_io->u.bdev.iovcnt; i++) { 4178 rc = memcmp(read_buf, 4179 parent_io->u.bdev.iovs[i].iov_base, 4180 parent_io->u.bdev.iovs[i].iov_len); 4181 if (rc) { 4182 break; 4183 } 4184 read_buf += parent_io->u.bdev.iovs[i].iov_len; 4185 } 4186 4187 spdk_bdev_free_io(bdev_io); 4188 4189 if (rc == 0) { 4190 parent_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS; 4191 parent_io->internal.cb(parent_io, true, parent_io->internal.caller_ctx); 4192 } else { 4193 parent_io->internal.status = SPDK_BDEV_IO_STATUS_MISCOMPARE; 4194 parent_io->internal.cb(parent_io, false, parent_io->internal.caller_ctx); 4195 } 4196 } 4197 4198 static void 4199 bdev_compare_do_read(void *_bdev_io) 4200 { 4201 struct spdk_bdev_io *bdev_io = _bdev_io; 4202 int rc; 4203 4204 rc = spdk_bdev_read_blocks(bdev_io->internal.desc, 4205 spdk_io_channel_from_ctx(bdev_io->internal.ch), NULL, 4206 bdev_io->u.bdev.offset_blocks, bdev_io->u.bdev.num_blocks, 4207 bdev_compare_do_read_done, bdev_io); 4208 4209 if (rc == -ENOMEM) { 4210 bdev_queue_io_wait_with_cb(bdev_io, bdev_compare_do_read); 4211 } else if (rc != 0) { 4212 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED; 4213 bdev_io->internal.cb(bdev_io, false, bdev_io->internal.caller_ctx); 4214 } 4215 } 4216 4217 static int 4218 bdev_comparev_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4219 struct iovec *iov, int iovcnt, void *md_buf, 4220 uint64_t offset_blocks, uint64_t num_blocks, 4221 spdk_bdev_io_completion_cb cb, void *cb_arg) 4222 { 4223 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 4224 struct spdk_bdev_io *bdev_io; 4225 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 4226 4227 if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) { 4228 return -EINVAL; 4229 } 4230 4231 bdev_io = bdev_channel_get_io(channel); 4232 if (!bdev_io) { 4233 return -ENOMEM; 4234 } 4235 4236 bdev_io->internal.ch = channel; 4237 bdev_io->internal.desc = desc; 4238 bdev_io->type = SPDK_BDEV_IO_TYPE_COMPARE; 4239 bdev_io->u.bdev.iovs = iov; 4240 bdev_io->u.bdev.iovcnt = iovcnt; 4241 bdev_io->u.bdev.md_buf = md_buf; 4242 bdev_io->u.bdev.num_blocks = num_blocks; 4243 bdev_io->u.bdev.offset_blocks = offset_blocks; 4244 bdev_io_init(bdev_io, bdev, cb_arg, cb); 4245 4246 if (bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_COMPARE)) { 4247 bdev_io_submit(bdev_io); 4248 return 0; 4249 } 4250 4251 bdev_compare_do_read(bdev_io); 4252 4253 return 0; 4254 } 4255 4256 int 4257 spdk_bdev_comparev_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4258 struct iovec *iov, int iovcnt, 4259 uint64_t offset_blocks, uint64_t num_blocks, 4260 spdk_bdev_io_completion_cb cb, void *cb_arg) 4261 { 4262 return bdev_comparev_blocks_with_md(desc, ch, iov, iovcnt, NULL, offset_blocks, 4263 num_blocks, cb, cb_arg); 4264 } 4265 4266 int 4267 spdk_bdev_comparev_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4268 struct iovec *iov, int iovcnt, void *md_buf, 4269 uint64_t offset_blocks, uint64_t num_blocks, 4270 spdk_bdev_io_completion_cb cb, void *cb_arg) 4271 { 4272 if (!spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) { 4273 return -EINVAL; 4274 } 4275 4276 if (!_bdev_io_check_md_buf(iov, md_buf)) { 4277 return -EINVAL; 4278 } 4279 4280 return bdev_comparev_blocks_with_md(desc, ch, iov, iovcnt, md_buf, offset_blocks, 4281 num_blocks, cb, cb_arg); 4282 } 4283 4284 static int 4285 bdev_compare_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4286 void *buf, void *md_buf, uint64_t offset_blocks, uint64_t num_blocks, 4287 spdk_bdev_io_completion_cb cb, void *cb_arg) 4288 { 4289 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 4290 struct spdk_bdev_io *bdev_io; 4291 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 4292 4293 if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) { 4294 return -EINVAL; 4295 } 4296 4297 bdev_io = bdev_channel_get_io(channel); 4298 if (!bdev_io) { 4299 return -ENOMEM; 4300 } 4301 4302 bdev_io->internal.ch = channel; 4303 bdev_io->internal.desc = desc; 4304 bdev_io->type = SPDK_BDEV_IO_TYPE_COMPARE; 4305 bdev_io->u.bdev.iovs = &bdev_io->iov; 4306 bdev_io->u.bdev.iovs[0].iov_base = buf; 4307 bdev_io->u.bdev.iovs[0].iov_len = num_blocks * bdev->blocklen; 4308 bdev_io->u.bdev.iovcnt = 1; 4309 bdev_io->u.bdev.md_buf = md_buf; 4310 bdev_io->u.bdev.num_blocks = num_blocks; 4311 bdev_io->u.bdev.offset_blocks = offset_blocks; 4312 bdev_io_init(bdev_io, bdev, cb_arg, cb); 4313 4314 if (bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_COMPARE)) { 4315 bdev_io_submit(bdev_io); 4316 return 0; 4317 } 4318 4319 bdev_compare_do_read(bdev_io); 4320 4321 return 0; 4322 } 4323 4324 int 4325 spdk_bdev_compare_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4326 void *buf, uint64_t offset_blocks, uint64_t num_blocks, 4327 spdk_bdev_io_completion_cb cb, void *cb_arg) 4328 { 4329 return bdev_compare_blocks_with_md(desc, ch, buf, NULL, offset_blocks, num_blocks, 4330 cb, cb_arg); 4331 } 4332 4333 int 4334 spdk_bdev_compare_blocks_with_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4335 void *buf, void *md_buf, uint64_t offset_blocks, uint64_t num_blocks, 4336 spdk_bdev_io_completion_cb cb, void *cb_arg) 4337 { 4338 struct iovec iov = { 4339 .iov_base = buf, 4340 }; 4341 4342 if (!spdk_bdev_is_md_separate(spdk_bdev_desc_get_bdev(desc))) { 4343 return -EINVAL; 4344 } 4345 4346 if (!_bdev_io_check_md_buf(&iov, md_buf)) { 4347 return -EINVAL; 4348 } 4349 4350 return bdev_compare_blocks_with_md(desc, ch, buf, md_buf, offset_blocks, num_blocks, 4351 cb, cb_arg); 4352 } 4353 4354 static void 4355 bdev_comparev_and_writev_blocks_unlocked(void *ctx, int unlock_status) 4356 { 4357 struct spdk_bdev_io *bdev_io = ctx; 4358 4359 if (unlock_status) { 4360 SPDK_ERRLOG("LBA range unlock failed\n"); 4361 } 4362 4363 bdev_io->internal.cb(bdev_io, bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS ? true : 4364 false, bdev_io->internal.caller_ctx); 4365 } 4366 4367 static void 4368 bdev_comparev_and_writev_blocks_unlock(struct spdk_bdev_io *bdev_io, int status) 4369 { 4370 bdev_io->internal.status = status; 4371 4372 bdev_unlock_lba_range(bdev_io->internal.desc, spdk_io_channel_from_ctx(bdev_io->internal.ch), 4373 bdev_io->u.bdev.offset_blocks, bdev_io->u.bdev.num_blocks, 4374 bdev_comparev_and_writev_blocks_unlocked, bdev_io); 4375 } 4376 4377 static void 4378 bdev_compare_and_write_do_write_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg) 4379 { 4380 struct spdk_bdev_io *parent_io = cb_arg; 4381 4382 if (!success) { 4383 SPDK_ERRLOG("Compare and write operation failed\n"); 4384 } 4385 4386 spdk_bdev_free_io(bdev_io); 4387 4388 bdev_comparev_and_writev_blocks_unlock(parent_io, 4389 success ? SPDK_BDEV_IO_STATUS_SUCCESS : SPDK_BDEV_IO_STATUS_FAILED); 4390 } 4391 4392 static void 4393 bdev_compare_and_write_do_write(void *_bdev_io) 4394 { 4395 struct spdk_bdev_io *bdev_io = _bdev_io; 4396 int rc; 4397 4398 rc = spdk_bdev_writev_blocks(bdev_io->internal.desc, 4399 spdk_io_channel_from_ctx(bdev_io->internal.ch), 4400 bdev_io->u.bdev.fused_iovs, bdev_io->u.bdev.fused_iovcnt, 4401 bdev_io->u.bdev.offset_blocks, bdev_io->u.bdev.num_blocks, 4402 bdev_compare_and_write_do_write_done, bdev_io); 4403 4404 4405 if (rc == -ENOMEM) { 4406 bdev_queue_io_wait_with_cb(bdev_io, bdev_compare_and_write_do_write); 4407 } else if (rc != 0) { 4408 bdev_comparev_and_writev_blocks_unlock(bdev_io, SPDK_BDEV_IO_STATUS_FAILED); 4409 } 4410 } 4411 4412 static void 4413 bdev_compare_and_write_do_compare_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg) 4414 { 4415 struct spdk_bdev_io *parent_io = cb_arg; 4416 4417 spdk_bdev_free_io(bdev_io); 4418 4419 if (!success) { 4420 bdev_comparev_and_writev_blocks_unlock(parent_io, SPDK_BDEV_IO_STATUS_MISCOMPARE); 4421 return; 4422 } 4423 4424 bdev_compare_and_write_do_write(parent_io); 4425 } 4426 4427 static void 4428 bdev_compare_and_write_do_compare(void *_bdev_io) 4429 { 4430 struct spdk_bdev_io *bdev_io = _bdev_io; 4431 int rc; 4432 4433 rc = spdk_bdev_comparev_blocks(bdev_io->internal.desc, 4434 spdk_io_channel_from_ctx(bdev_io->internal.ch), bdev_io->u.bdev.iovs, 4435 bdev_io->u.bdev.iovcnt, bdev_io->u.bdev.offset_blocks, bdev_io->u.bdev.num_blocks, 4436 bdev_compare_and_write_do_compare_done, bdev_io); 4437 4438 if (rc == -ENOMEM) { 4439 bdev_queue_io_wait_with_cb(bdev_io, bdev_compare_and_write_do_compare); 4440 } else if (rc != 0) { 4441 bdev_comparev_and_writev_blocks_unlock(bdev_io, SPDK_BDEV_IO_STATUS_FIRST_FUSED_FAILED); 4442 } 4443 } 4444 4445 static void 4446 bdev_comparev_and_writev_blocks_locked(void *ctx, int status) 4447 { 4448 struct spdk_bdev_io *bdev_io = ctx; 4449 4450 if (status) { 4451 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FIRST_FUSED_FAILED; 4452 bdev_io->internal.cb(bdev_io, false, bdev_io->internal.caller_ctx); 4453 return; 4454 } 4455 4456 bdev_compare_and_write_do_compare(bdev_io); 4457 } 4458 4459 int 4460 spdk_bdev_comparev_and_writev_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4461 struct iovec *compare_iov, int compare_iovcnt, 4462 struct iovec *write_iov, int write_iovcnt, 4463 uint64_t offset_blocks, uint64_t num_blocks, 4464 spdk_bdev_io_completion_cb cb, void *cb_arg) 4465 { 4466 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 4467 struct spdk_bdev_io *bdev_io; 4468 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 4469 4470 if (!desc->write) { 4471 return -EBADF; 4472 } 4473 4474 if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) { 4475 return -EINVAL; 4476 } 4477 4478 if (num_blocks > bdev->acwu) { 4479 return -EINVAL; 4480 } 4481 4482 bdev_io = bdev_channel_get_io(channel); 4483 if (!bdev_io) { 4484 return -ENOMEM; 4485 } 4486 4487 bdev_io->internal.ch = channel; 4488 bdev_io->internal.desc = desc; 4489 bdev_io->type = SPDK_BDEV_IO_TYPE_COMPARE_AND_WRITE; 4490 bdev_io->u.bdev.iovs = compare_iov; 4491 bdev_io->u.bdev.iovcnt = compare_iovcnt; 4492 bdev_io->u.bdev.fused_iovs = write_iov; 4493 bdev_io->u.bdev.fused_iovcnt = write_iovcnt; 4494 bdev_io->u.bdev.md_buf = NULL; 4495 bdev_io->u.bdev.num_blocks = num_blocks; 4496 bdev_io->u.bdev.offset_blocks = offset_blocks; 4497 bdev_io_init(bdev_io, bdev, cb_arg, cb); 4498 4499 if (bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_COMPARE_AND_WRITE)) { 4500 bdev_io_submit(bdev_io); 4501 return 0; 4502 } 4503 4504 return bdev_lock_lba_range(desc, ch, offset_blocks, num_blocks, 4505 bdev_comparev_and_writev_blocks_locked, bdev_io); 4506 } 4507 4508 int 4509 spdk_bdev_zcopy_start(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4510 struct iovec *iov, int iovcnt, 4511 uint64_t offset_blocks, uint64_t num_blocks, 4512 bool populate, 4513 spdk_bdev_io_completion_cb cb, void *cb_arg) 4514 { 4515 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 4516 struct spdk_bdev_io *bdev_io; 4517 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 4518 4519 if (!desc->write) { 4520 return -EBADF; 4521 } 4522 4523 if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) { 4524 return -EINVAL; 4525 } 4526 4527 if (!spdk_bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_ZCOPY)) { 4528 return -ENOTSUP; 4529 } 4530 4531 bdev_io = bdev_channel_get_io(channel); 4532 if (!bdev_io) { 4533 return -ENOMEM; 4534 } 4535 4536 bdev_io->internal.ch = channel; 4537 bdev_io->internal.desc = desc; 4538 bdev_io->type = SPDK_BDEV_IO_TYPE_ZCOPY; 4539 bdev_io->u.bdev.num_blocks = num_blocks; 4540 bdev_io->u.bdev.offset_blocks = offset_blocks; 4541 bdev_io->u.bdev.iovs = iov; 4542 bdev_io->u.bdev.iovcnt = iovcnt; 4543 bdev_io->u.bdev.md_buf = NULL; 4544 bdev_io->u.bdev.zcopy.populate = populate ? 1 : 0; 4545 bdev_io->u.bdev.zcopy.commit = 0; 4546 bdev_io->u.bdev.zcopy.start = 1; 4547 bdev_io_init(bdev_io, bdev, cb_arg, cb); 4548 4549 bdev_io_submit(bdev_io); 4550 4551 return 0; 4552 } 4553 4554 int 4555 spdk_bdev_zcopy_end(struct spdk_bdev_io *bdev_io, bool commit, 4556 spdk_bdev_io_completion_cb cb, void *cb_arg) 4557 { 4558 if (bdev_io->type != SPDK_BDEV_IO_TYPE_ZCOPY) { 4559 return -EINVAL; 4560 } 4561 4562 bdev_io->u.bdev.zcopy.commit = commit ? 1 : 0; 4563 bdev_io->u.bdev.zcopy.start = 0; 4564 bdev_io->internal.caller_ctx = cb_arg; 4565 bdev_io->internal.cb = cb; 4566 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_PENDING; 4567 4568 bdev_io_submit(bdev_io); 4569 4570 return 0; 4571 } 4572 4573 int 4574 spdk_bdev_write_zeroes(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4575 uint64_t offset, uint64_t len, 4576 spdk_bdev_io_completion_cb cb, void *cb_arg) 4577 { 4578 uint64_t offset_blocks, num_blocks; 4579 4580 if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks, 4581 len, &num_blocks) != 0) { 4582 return -EINVAL; 4583 } 4584 4585 return spdk_bdev_write_zeroes_blocks(desc, ch, offset_blocks, num_blocks, cb, cb_arg); 4586 } 4587 4588 int 4589 spdk_bdev_write_zeroes_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4590 uint64_t offset_blocks, uint64_t num_blocks, 4591 spdk_bdev_io_completion_cb cb, void *cb_arg) 4592 { 4593 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 4594 struct spdk_bdev_io *bdev_io; 4595 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 4596 4597 if (!desc->write) { 4598 return -EBADF; 4599 } 4600 4601 if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) { 4602 return -EINVAL; 4603 } 4604 4605 if (!bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_WRITE_ZEROES) && 4606 !bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_WRITE)) { 4607 return -ENOTSUP; 4608 } 4609 4610 bdev_io = bdev_channel_get_io(channel); 4611 4612 if (!bdev_io) { 4613 return -ENOMEM; 4614 } 4615 4616 bdev_io->type = SPDK_BDEV_IO_TYPE_WRITE_ZEROES; 4617 bdev_io->internal.ch = channel; 4618 bdev_io->internal.desc = desc; 4619 bdev_io->u.bdev.offset_blocks = offset_blocks; 4620 bdev_io->u.bdev.num_blocks = num_blocks; 4621 bdev_io_init(bdev_io, bdev, cb_arg, cb); 4622 4623 if (bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_WRITE_ZEROES)) { 4624 bdev_io_submit(bdev_io); 4625 return 0; 4626 } 4627 4628 assert(bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_WRITE)); 4629 assert(_bdev_get_block_size_with_md(bdev) <= ZERO_BUFFER_SIZE); 4630 bdev_io->u.bdev.split_remaining_num_blocks = num_blocks; 4631 bdev_io->u.bdev.split_current_offset_blocks = offset_blocks; 4632 bdev_write_zero_buffer_next(bdev_io); 4633 4634 return 0; 4635 } 4636 4637 int 4638 spdk_bdev_unmap(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4639 uint64_t offset, uint64_t nbytes, 4640 spdk_bdev_io_completion_cb cb, void *cb_arg) 4641 { 4642 uint64_t offset_blocks, num_blocks; 4643 4644 if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks, 4645 nbytes, &num_blocks) != 0) { 4646 return -EINVAL; 4647 } 4648 4649 return spdk_bdev_unmap_blocks(desc, ch, offset_blocks, num_blocks, cb, cb_arg); 4650 } 4651 4652 int 4653 spdk_bdev_unmap_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4654 uint64_t offset_blocks, uint64_t num_blocks, 4655 spdk_bdev_io_completion_cb cb, void *cb_arg) 4656 { 4657 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 4658 struct spdk_bdev_io *bdev_io; 4659 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 4660 4661 if (!desc->write) { 4662 return -EBADF; 4663 } 4664 4665 if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) { 4666 return -EINVAL; 4667 } 4668 4669 if (num_blocks == 0) { 4670 SPDK_ERRLOG("Can't unmap 0 bytes\n"); 4671 return -EINVAL; 4672 } 4673 4674 bdev_io = bdev_channel_get_io(channel); 4675 if (!bdev_io) { 4676 return -ENOMEM; 4677 } 4678 4679 bdev_io->internal.ch = channel; 4680 bdev_io->internal.desc = desc; 4681 bdev_io->type = SPDK_BDEV_IO_TYPE_UNMAP; 4682 4683 bdev_io->u.bdev.iovs = &bdev_io->iov; 4684 bdev_io->u.bdev.iovs[0].iov_base = NULL; 4685 bdev_io->u.bdev.iovs[0].iov_len = 0; 4686 bdev_io->u.bdev.iovcnt = 1; 4687 4688 bdev_io->u.bdev.offset_blocks = offset_blocks; 4689 bdev_io->u.bdev.num_blocks = num_blocks; 4690 bdev_io_init(bdev_io, bdev, cb_arg, cb); 4691 4692 bdev_io_submit(bdev_io); 4693 return 0; 4694 } 4695 4696 int 4697 spdk_bdev_flush(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4698 uint64_t offset, uint64_t length, 4699 spdk_bdev_io_completion_cb cb, void *cb_arg) 4700 { 4701 uint64_t offset_blocks, num_blocks; 4702 4703 if (bdev_bytes_to_blocks(spdk_bdev_desc_get_bdev(desc), offset, &offset_blocks, 4704 length, &num_blocks) != 0) { 4705 return -EINVAL; 4706 } 4707 4708 return spdk_bdev_flush_blocks(desc, ch, offset_blocks, num_blocks, cb, cb_arg); 4709 } 4710 4711 int 4712 spdk_bdev_flush_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4713 uint64_t offset_blocks, uint64_t num_blocks, 4714 spdk_bdev_io_completion_cb cb, void *cb_arg) 4715 { 4716 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 4717 struct spdk_bdev_io *bdev_io; 4718 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 4719 4720 if (!desc->write) { 4721 return -EBADF; 4722 } 4723 4724 if (!bdev_io_valid_blocks(bdev, offset_blocks, num_blocks)) { 4725 return -EINVAL; 4726 } 4727 4728 bdev_io = bdev_channel_get_io(channel); 4729 if (!bdev_io) { 4730 return -ENOMEM; 4731 } 4732 4733 bdev_io->internal.ch = channel; 4734 bdev_io->internal.desc = desc; 4735 bdev_io->type = SPDK_BDEV_IO_TYPE_FLUSH; 4736 bdev_io->u.bdev.iovs = NULL; 4737 bdev_io->u.bdev.iovcnt = 0; 4738 bdev_io->u.bdev.offset_blocks = offset_blocks; 4739 bdev_io->u.bdev.num_blocks = num_blocks; 4740 bdev_io_init(bdev_io, bdev, cb_arg, cb); 4741 4742 bdev_io_submit(bdev_io); 4743 return 0; 4744 } 4745 4746 static void 4747 bdev_reset_dev(struct spdk_io_channel_iter *i, int status) 4748 { 4749 struct spdk_bdev_channel *ch = spdk_io_channel_iter_get_ctx(i); 4750 struct spdk_bdev_io *bdev_io; 4751 4752 bdev_io = TAILQ_FIRST(&ch->queued_resets); 4753 TAILQ_REMOVE(&ch->queued_resets, bdev_io, internal.link); 4754 bdev_io_submit_reset(bdev_io); 4755 } 4756 4757 static void 4758 bdev_reset_freeze_channel(struct spdk_io_channel_iter *i) 4759 { 4760 struct spdk_io_channel *ch; 4761 struct spdk_bdev_channel *channel; 4762 struct spdk_bdev_mgmt_channel *mgmt_channel; 4763 struct spdk_bdev_shared_resource *shared_resource; 4764 bdev_io_tailq_t tmp_queued; 4765 4766 TAILQ_INIT(&tmp_queued); 4767 4768 ch = spdk_io_channel_iter_get_channel(i); 4769 channel = spdk_io_channel_get_ctx(ch); 4770 shared_resource = channel->shared_resource; 4771 mgmt_channel = shared_resource->mgmt_ch; 4772 4773 channel->flags |= BDEV_CH_RESET_IN_PROGRESS; 4774 4775 if ((channel->flags & BDEV_CH_QOS_ENABLED) != 0) { 4776 /* The QoS object is always valid and readable while 4777 * the channel flag is set, so the lock here should not 4778 * be necessary. We're not in the fast path though, so 4779 * just take it anyway. */ 4780 pthread_mutex_lock(&channel->bdev->internal.mutex); 4781 if (channel->bdev->internal.qos->ch == channel) { 4782 TAILQ_SWAP(&channel->bdev->internal.qos->queued, &tmp_queued, spdk_bdev_io, internal.link); 4783 } 4784 pthread_mutex_unlock(&channel->bdev->internal.mutex); 4785 } 4786 4787 bdev_abort_all_queued_io(&shared_resource->nomem_io, channel); 4788 bdev_abort_all_buf_io(&mgmt_channel->need_buf_small, channel); 4789 bdev_abort_all_buf_io(&mgmt_channel->need_buf_large, channel); 4790 bdev_abort_all_queued_io(&tmp_queued, channel); 4791 4792 spdk_for_each_channel_continue(i, 0); 4793 } 4794 4795 static void 4796 bdev_start_reset(void *ctx) 4797 { 4798 struct spdk_bdev_channel *ch = ctx; 4799 4800 spdk_for_each_channel(__bdev_to_io_dev(ch->bdev), bdev_reset_freeze_channel, 4801 ch, bdev_reset_dev); 4802 } 4803 4804 static void 4805 bdev_channel_start_reset(struct spdk_bdev_channel *ch) 4806 { 4807 struct spdk_bdev *bdev = ch->bdev; 4808 4809 assert(!TAILQ_EMPTY(&ch->queued_resets)); 4810 4811 pthread_mutex_lock(&bdev->internal.mutex); 4812 if (bdev->internal.reset_in_progress == NULL) { 4813 bdev->internal.reset_in_progress = TAILQ_FIRST(&ch->queued_resets); 4814 /* 4815 * Take a channel reference for the target bdev for the life of this 4816 * reset. This guards against the channel getting destroyed while 4817 * spdk_for_each_channel() calls related to this reset IO are in 4818 * progress. We will release the reference when this reset is 4819 * completed. 4820 */ 4821 bdev->internal.reset_in_progress->u.reset.ch_ref = spdk_get_io_channel(__bdev_to_io_dev(bdev)); 4822 bdev_start_reset(ch); 4823 } 4824 pthread_mutex_unlock(&bdev->internal.mutex); 4825 } 4826 4827 int 4828 spdk_bdev_reset(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4829 spdk_bdev_io_completion_cb cb, void *cb_arg) 4830 { 4831 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 4832 struct spdk_bdev_io *bdev_io; 4833 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 4834 4835 bdev_io = bdev_channel_get_io(channel); 4836 if (!bdev_io) { 4837 return -ENOMEM; 4838 } 4839 4840 bdev_io->internal.ch = channel; 4841 bdev_io->internal.desc = desc; 4842 bdev_io->internal.submit_tsc = spdk_get_ticks(); 4843 bdev_io->type = SPDK_BDEV_IO_TYPE_RESET; 4844 bdev_io->u.reset.ch_ref = NULL; 4845 bdev_io_init(bdev_io, bdev, cb_arg, cb); 4846 4847 pthread_mutex_lock(&bdev->internal.mutex); 4848 TAILQ_INSERT_TAIL(&channel->queued_resets, bdev_io, internal.link); 4849 pthread_mutex_unlock(&bdev->internal.mutex); 4850 4851 TAILQ_INSERT_TAIL(&bdev_io->internal.ch->io_submitted, bdev_io, 4852 internal.ch_link); 4853 4854 bdev_channel_start_reset(channel); 4855 4856 return 0; 4857 } 4858 4859 void 4860 spdk_bdev_get_io_stat(struct spdk_bdev *bdev, struct spdk_io_channel *ch, 4861 struct spdk_bdev_io_stat *stat) 4862 { 4863 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 4864 4865 *stat = channel->stat; 4866 } 4867 4868 static void 4869 bdev_get_device_stat_done(struct spdk_io_channel_iter *i, int status) 4870 { 4871 void *io_device = spdk_io_channel_iter_get_io_device(i); 4872 struct spdk_bdev_iostat_ctx *bdev_iostat_ctx = spdk_io_channel_iter_get_ctx(i); 4873 4874 bdev_iostat_ctx->cb(__bdev_from_io_dev(io_device), bdev_iostat_ctx->stat, 4875 bdev_iostat_ctx->cb_arg, 0); 4876 free(bdev_iostat_ctx); 4877 } 4878 4879 static void 4880 bdev_get_each_channel_stat(struct spdk_io_channel_iter *i) 4881 { 4882 struct spdk_bdev_iostat_ctx *bdev_iostat_ctx = spdk_io_channel_iter_get_ctx(i); 4883 struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i); 4884 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 4885 4886 bdev_io_stat_add(bdev_iostat_ctx->stat, &channel->stat); 4887 spdk_for_each_channel_continue(i, 0); 4888 } 4889 4890 void 4891 spdk_bdev_get_device_stat(struct spdk_bdev *bdev, struct spdk_bdev_io_stat *stat, 4892 spdk_bdev_get_device_stat_cb cb, void *cb_arg) 4893 { 4894 struct spdk_bdev_iostat_ctx *bdev_iostat_ctx; 4895 4896 assert(bdev != NULL); 4897 assert(stat != NULL); 4898 assert(cb != NULL); 4899 4900 bdev_iostat_ctx = calloc(1, sizeof(struct spdk_bdev_iostat_ctx)); 4901 if (bdev_iostat_ctx == NULL) { 4902 SPDK_ERRLOG("Unable to allocate memory for spdk_bdev_iostat_ctx\n"); 4903 cb(bdev, stat, cb_arg, -ENOMEM); 4904 return; 4905 } 4906 4907 bdev_iostat_ctx->stat = stat; 4908 bdev_iostat_ctx->cb = cb; 4909 bdev_iostat_ctx->cb_arg = cb_arg; 4910 4911 /* Start with the statistics from previously deleted channels. */ 4912 pthread_mutex_lock(&bdev->internal.mutex); 4913 bdev_io_stat_add(bdev_iostat_ctx->stat, &bdev->internal.stat); 4914 pthread_mutex_unlock(&bdev->internal.mutex); 4915 4916 /* Then iterate and add the statistics from each existing channel. */ 4917 spdk_for_each_channel(__bdev_to_io_dev(bdev), 4918 bdev_get_each_channel_stat, 4919 bdev_iostat_ctx, 4920 bdev_get_device_stat_done); 4921 } 4922 4923 int 4924 spdk_bdev_nvme_admin_passthru(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4925 const struct spdk_nvme_cmd *cmd, void *buf, size_t nbytes, 4926 spdk_bdev_io_completion_cb cb, void *cb_arg) 4927 { 4928 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 4929 struct spdk_bdev_io *bdev_io; 4930 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 4931 4932 if (!desc->write) { 4933 return -EBADF; 4934 } 4935 4936 bdev_io = bdev_channel_get_io(channel); 4937 if (!bdev_io) { 4938 return -ENOMEM; 4939 } 4940 4941 bdev_io->internal.ch = channel; 4942 bdev_io->internal.desc = desc; 4943 bdev_io->type = SPDK_BDEV_IO_TYPE_NVME_ADMIN; 4944 bdev_io->u.nvme_passthru.cmd = *cmd; 4945 bdev_io->u.nvme_passthru.buf = buf; 4946 bdev_io->u.nvme_passthru.nbytes = nbytes; 4947 bdev_io->u.nvme_passthru.md_buf = NULL; 4948 bdev_io->u.nvme_passthru.md_len = 0; 4949 4950 bdev_io_init(bdev_io, bdev, cb_arg, cb); 4951 4952 bdev_io_submit(bdev_io); 4953 return 0; 4954 } 4955 4956 int 4957 spdk_bdev_nvme_io_passthru(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4958 const struct spdk_nvme_cmd *cmd, void *buf, size_t nbytes, 4959 spdk_bdev_io_completion_cb cb, void *cb_arg) 4960 { 4961 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 4962 struct spdk_bdev_io *bdev_io; 4963 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 4964 4965 if (!desc->write) { 4966 /* 4967 * Do not try to parse the NVMe command - we could maybe use bits in the opcode 4968 * to easily determine if the command is a read or write, but for now just 4969 * do not allow io_passthru with a read-only descriptor. 4970 */ 4971 return -EBADF; 4972 } 4973 4974 bdev_io = bdev_channel_get_io(channel); 4975 if (!bdev_io) { 4976 return -ENOMEM; 4977 } 4978 4979 bdev_io->internal.ch = channel; 4980 bdev_io->internal.desc = desc; 4981 bdev_io->type = SPDK_BDEV_IO_TYPE_NVME_IO; 4982 bdev_io->u.nvme_passthru.cmd = *cmd; 4983 bdev_io->u.nvme_passthru.buf = buf; 4984 bdev_io->u.nvme_passthru.nbytes = nbytes; 4985 bdev_io->u.nvme_passthru.md_buf = NULL; 4986 bdev_io->u.nvme_passthru.md_len = 0; 4987 4988 bdev_io_init(bdev_io, bdev, cb_arg, cb); 4989 4990 bdev_io_submit(bdev_io); 4991 return 0; 4992 } 4993 4994 int 4995 spdk_bdev_nvme_io_passthru_md(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 4996 const struct spdk_nvme_cmd *cmd, void *buf, size_t nbytes, void *md_buf, size_t md_len, 4997 spdk_bdev_io_completion_cb cb, void *cb_arg) 4998 { 4999 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 5000 struct spdk_bdev_io *bdev_io; 5001 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 5002 5003 if (!desc->write) { 5004 /* 5005 * Do not try to parse the NVMe command - we could maybe use bits in the opcode 5006 * to easily determine if the command is a read or write, but for now just 5007 * do not allow io_passthru with a read-only descriptor. 5008 */ 5009 return -EBADF; 5010 } 5011 5012 bdev_io = bdev_channel_get_io(channel); 5013 if (!bdev_io) { 5014 return -ENOMEM; 5015 } 5016 5017 bdev_io->internal.ch = channel; 5018 bdev_io->internal.desc = desc; 5019 bdev_io->type = SPDK_BDEV_IO_TYPE_NVME_IO_MD; 5020 bdev_io->u.nvme_passthru.cmd = *cmd; 5021 bdev_io->u.nvme_passthru.buf = buf; 5022 bdev_io->u.nvme_passthru.nbytes = nbytes; 5023 bdev_io->u.nvme_passthru.md_buf = md_buf; 5024 bdev_io->u.nvme_passthru.md_len = md_len; 5025 5026 bdev_io_init(bdev_io, bdev, cb_arg, cb); 5027 5028 bdev_io_submit(bdev_io); 5029 return 0; 5030 } 5031 5032 static void bdev_abort_retry(void *ctx); 5033 static void bdev_abort(struct spdk_bdev_io *parent_io); 5034 5035 static void 5036 bdev_abort_io_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg) 5037 { 5038 struct spdk_bdev_channel *channel = bdev_io->internal.ch; 5039 struct spdk_bdev_io *parent_io = cb_arg; 5040 struct spdk_bdev_io *bio_to_abort, *tmp_io; 5041 5042 bio_to_abort = bdev_io->u.abort.bio_to_abort; 5043 5044 spdk_bdev_free_io(bdev_io); 5045 5046 if (!success) { 5047 /* Check if the target I/O completed in the meantime. */ 5048 TAILQ_FOREACH(tmp_io, &channel->io_submitted, internal.ch_link) { 5049 if (tmp_io == bio_to_abort) { 5050 break; 5051 } 5052 } 5053 5054 /* If the target I/O still exists, set the parent to failed. */ 5055 if (tmp_io != NULL) { 5056 parent_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED; 5057 } 5058 } 5059 5060 parent_io->u.bdev.split_outstanding--; 5061 if (parent_io->u.bdev.split_outstanding == 0) { 5062 if (parent_io->internal.status == SPDK_BDEV_IO_STATUS_NOMEM) { 5063 bdev_abort_retry(parent_io); 5064 } else { 5065 bdev_io_complete(parent_io); 5066 } 5067 } 5068 } 5069 5070 static int 5071 bdev_abort_io(struct spdk_bdev_desc *desc, struct spdk_bdev_channel *channel, 5072 struct spdk_bdev_io *bio_to_abort, 5073 spdk_bdev_io_completion_cb cb, void *cb_arg) 5074 { 5075 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 5076 struct spdk_bdev_io *bdev_io; 5077 5078 if (bio_to_abort->type == SPDK_BDEV_IO_TYPE_ABORT || 5079 bio_to_abort->type == SPDK_BDEV_IO_TYPE_RESET) { 5080 /* TODO: Abort reset or abort request. */ 5081 return -ENOTSUP; 5082 } 5083 5084 bdev_io = bdev_channel_get_io(channel); 5085 if (bdev_io == NULL) { 5086 return -ENOMEM; 5087 } 5088 5089 bdev_io->internal.ch = channel; 5090 bdev_io->internal.desc = desc; 5091 bdev_io->type = SPDK_BDEV_IO_TYPE_ABORT; 5092 bdev_io_init(bdev_io, bdev, cb_arg, cb); 5093 5094 if (bdev->split_on_optimal_io_boundary && bdev_io_should_split(bio_to_abort)) { 5095 bdev_io->u.bdev.abort.bio_cb_arg = bio_to_abort; 5096 5097 /* Parent abort request is not submitted directly, but to manage its 5098 * execution add it to the submitted list here. 5099 */ 5100 bdev_io->internal.submit_tsc = spdk_get_ticks(); 5101 TAILQ_INSERT_TAIL(&channel->io_submitted, bdev_io, internal.ch_link); 5102 5103 bdev_abort(bdev_io); 5104 5105 return 0; 5106 } 5107 5108 bdev_io->u.abort.bio_to_abort = bio_to_abort; 5109 5110 /* Submit the abort request to the underlying bdev module. */ 5111 bdev_io_submit(bdev_io); 5112 5113 return 0; 5114 } 5115 5116 static uint32_t 5117 _bdev_abort(struct spdk_bdev_io *parent_io) 5118 { 5119 struct spdk_bdev_desc *desc = parent_io->internal.desc; 5120 struct spdk_bdev_channel *channel = parent_io->internal.ch; 5121 void *bio_cb_arg; 5122 struct spdk_bdev_io *bio_to_abort; 5123 uint32_t matched_ios; 5124 int rc; 5125 5126 bio_cb_arg = parent_io->u.bdev.abort.bio_cb_arg; 5127 5128 /* matched_ios is returned and will be kept by the caller. 5129 * 5130 * This funcion will be used for two cases, 1) the same cb_arg is used for 5131 * multiple I/Os, 2) a single large I/O is split into smaller ones. 5132 * Incrementing split_outstanding directly here may confuse readers especially 5133 * for the 1st case. 5134 * 5135 * Completion of I/O abort is processed after stack unwinding. Hence this trick 5136 * works as expected. 5137 */ 5138 matched_ios = 0; 5139 parent_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS; 5140 5141 TAILQ_FOREACH(bio_to_abort, &channel->io_submitted, internal.ch_link) { 5142 if (bio_to_abort->internal.caller_ctx != bio_cb_arg) { 5143 continue; 5144 } 5145 5146 if (bio_to_abort->internal.submit_tsc > parent_io->internal.submit_tsc) { 5147 /* Any I/O which was submitted after this abort command should be excluded. */ 5148 continue; 5149 } 5150 5151 rc = bdev_abort_io(desc, channel, bio_to_abort, bdev_abort_io_done, parent_io); 5152 if (rc != 0) { 5153 if (rc == -ENOMEM) { 5154 parent_io->internal.status = SPDK_BDEV_IO_STATUS_NOMEM; 5155 } else { 5156 parent_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED; 5157 } 5158 break; 5159 } 5160 matched_ios++; 5161 } 5162 5163 return matched_ios; 5164 } 5165 5166 static void 5167 bdev_abort_retry(void *ctx) 5168 { 5169 struct spdk_bdev_io *parent_io = ctx; 5170 uint32_t matched_ios; 5171 5172 matched_ios = _bdev_abort(parent_io); 5173 5174 if (matched_ios == 0) { 5175 if (parent_io->internal.status == SPDK_BDEV_IO_STATUS_NOMEM) { 5176 bdev_queue_io_wait_with_cb(parent_io, bdev_abort_retry); 5177 } else { 5178 /* For retry, the case that no target I/O was found is success 5179 * because it means target I/Os completed in the meantime. 5180 */ 5181 bdev_io_complete(parent_io); 5182 } 5183 return; 5184 } 5185 5186 /* Use split_outstanding to manage the progress of aborting I/Os. */ 5187 parent_io->u.bdev.split_outstanding = matched_ios; 5188 } 5189 5190 static void 5191 bdev_abort(struct spdk_bdev_io *parent_io) 5192 { 5193 uint32_t matched_ios; 5194 5195 matched_ios = _bdev_abort(parent_io); 5196 5197 if (matched_ios == 0) { 5198 if (parent_io->internal.status == SPDK_BDEV_IO_STATUS_NOMEM) { 5199 bdev_queue_io_wait_with_cb(parent_io, bdev_abort_retry); 5200 } else { 5201 /* The case the no target I/O was found is failure. */ 5202 parent_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED; 5203 bdev_io_complete(parent_io); 5204 } 5205 return; 5206 } 5207 5208 /* Use split_outstanding to manage the progress of aborting I/Os. */ 5209 parent_io->u.bdev.split_outstanding = matched_ios; 5210 } 5211 5212 int 5213 spdk_bdev_abort(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 5214 void *bio_cb_arg, 5215 spdk_bdev_io_completion_cb cb, void *cb_arg) 5216 { 5217 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 5218 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 5219 struct spdk_bdev_io *bdev_io; 5220 5221 if (bio_cb_arg == NULL) { 5222 return -EINVAL; 5223 } 5224 5225 if (!spdk_bdev_io_type_supported(bdev, SPDK_BDEV_IO_TYPE_ABORT)) { 5226 return -ENOTSUP; 5227 } 5228 5229 bdev_io = bdev_channel_get_io(channel); 5230 if (bdev_io == NULL) { 5231 return -ENOMEM; 5232 } 5233 5234 bdev_io->internal.ch = channel; 5235 bdev_io->internal.desc = desc; 5236 bdev_io->internal.submit_tsc = spdk_get_ticks(); 5237 bdev_io->type = SPDK_BDEV_IO_TYPE_ABORT; 5238 bdev_io_init(bdev_io, bdev, cb_arg, cb); 5239 5240 bdev_io->u.bdev.abort.bio_cb_arg = bio_cb_arg; 5241 5242 /* Parent abort request is not submitted directly, but to manage its execution, 5243 * add it to the submitted list here. 5244 */ 5245 TAILQ_INSERT_TAIL(&channel->io_submitted, bdev_io, internal.ch_link); 5246 5247 bdev_abort(bdev_io); 5248 5249 return 0; 5250 } 5251 5252 int 5253 spdk_bdev_queue_io_wait(struct spdk_bdev *bdev, struct spdk_io_channel *ch, 5254 struct spdk_bdev_io_wait_entry *entry) 5255 { 5256 struct spdk_bdev_channel *channel = spdk_io_channel_get_ctx(ch); 5257 struct spdk_bdev_mgmt_channel *mgmt_ch = channel->shared_resource->mgmt_ch; 5258 5259 if (bdev != entry->bdev) { 5260 SPDK_ERRLOG("bdevs do not match\n"); 5261 return -EINVAL; 5262 } 5263 5264 if (mgmt_ch->per_thread_cache_count > 0) { 5265 SPDK_ERRLOG("Cannot queue io_wait if spdk_bdev_io available in per-thread cache\n"); 5266 return -EINVAL; 5267 } 5268 5269 TAILQ_INSERT_TAIL(&mgmt_ch->io_wait_queue, entry, link); 5270 return 0; 5271 } 5272 5273 static void 5274 bdev_ch_retry_io(struct spdk_bdev_channel *bdev_ch) 5275 { 5276 struct spdk_bdev *bdev = bdev_ch->bdev; 5277 struct spdk_bdev_shared_resource *shared_resource = bdev_ch->shared_resource; 5278 struct spdk_bdev_io *bdev_io; 5279 5280 if (shared_resource->io_outstanding > shared_resource->nomem_threshold) { 5281 /* 5282 * Allow some more I/O to complete before retrying the nomem_io queue. 5283 * Some drivers (such as nvme) cannot immediately take a new I/O in 5284 * the context of a completion, because the resources for the I/O are 5285 * not released until control returns to the bdev poller. Also, we 5286 * may require several small I/O to complete before a larger I/O 5287 * (that requires splitting) can be submitted. 5288 */ 5289 return; 5290 } 5291 5292 while (!TAILQ_EMPTY(&shared_resource->nomem_io)) { 5293 bdev_io = TAILQ_FIRST(&shared_resource->nomem_io); 5294 TAILQ_REMOVE(&shared_resource->nomem_io, bdev_io, internal.link); 5295 bdev_io->internal.ch->io_outstanding++; 5296 shared_resource->io_outstanding++; 5297 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_PENDING; 5298 bdev_io->internal.error.nvme.cdw0 = 0; 5299 bdev_io->num_retries++; 5300 bdev->fn_table->submit_request(spdk_bdev_io_get_io_channel(bdev_io), bdev_io); 5301 if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_NOMEM) { 5302 break; 5303 } 5304 } 5305 } 5306 5307 static inline void 5308 bdev_io_complete(void *ctx) 5309 { 5310 struct spdk_bdev_io *bdev_io = ctx; 5311 struct spdk_bdev_channel *bdev_ch = bdev_io->internal.ch; 5312 uint64_t tsc, tsc_diff; 5313 5314 if (spdk_unlikely(bdev_io->internal.in_submit_request || bdev_io->internal.io_submit_ch)) { 5315 /* 5316 * Send the completion to the thread that originally submitted the I/O, 5317 * which may not be the current thread in the case of QoS. 5318 */ 5319 if (bdev_io->internal.io_submit_ch) { 5320 bdev_io->internal.ch = bdev_io->internal.io_submit_ch; 5321 bdev_io->internal.io_submit_ch = NULL; 5322 } 5323 5324 /* 5325 * Defer completion to avoid potential infinite recursion if the 5326 * user's completion callback issues a new I/O. 5327 */ 5328 spdk_thread_send_msg(spdk_bdev_io_get_thread(bdev_io), 5329 bdev_io_complete, bdev_io); 5330 return; 5331 } 5332 5333 tsc = spdk_get_ticks(); 5334 tsc_diff = tsc - bdev_io->internal.submit_tsc; 5335 spdk_trace_record_tsc(tsc, TRACE_BDEV_IO_DONE, 0, 0, (uintptr_t)bdev_io); 5336 5337 TAILQ_REMOVE(&bdev_ch->io_submitted, bdev_io, internal.ch_link); 5338 5339 if (bdev_io->internal.ch->histogram) { 5340 spdk_histogram_data_tally(bdev_io->internal.ch->histogram, tsc_diff); 5341 } 5342 5343 if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS) { 5344 switch (bdev_io->type) { 5345 case SPDK_BDEV_IO_TYPE_READ: 5346 bdev_io->internal.ch->stat.bytes_read += bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen; 5347 bdev_io->internal.ch->stat.num_read_ops++; 5348 bdev_io->internal.ch->stat.read_latency_ticks += tsc_diff; 5349 break; 5350 case SPDK_BDEV_IO_TYPE_WRITE: 5351 bdev_io->internal.ch->stat.bytes_written += bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen; 5352 bdev_io->internal.ch->stat.num_write_ops++; 5353 bdev_io->internal.ch->stat.write_latency_ticks += tsc_diff; 5354 break; 5355 case SPDK_BDEV_IO_TYPE_UNMAP: 5356 bdev_io->internal.ch->stat.bytes_unmapped += bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen; 5357 bdev_io->internal.ch->stat.num_unmap_ops++; 5358 bdev_io->internal.ch->stat.unmap_latency_ticks += tsc_diff; 5359 break; 5360 case SPDK_BDEV_IO_TYPE_ZCOPY: 5361 /* Track the data in the start phase only */ 5362 if (bdev_io->u.bdev.zcopy.start) { 5363 if (bdev_io->u.bdev.zcopy.populate) { 5364 bdev_io->internal.ch->stat.bytes_read += 5365 bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen; 5366 bdev_io->internal.ch->stat.num_read_ops++; 5367 bdev_io->internal.ch->stat.read_latency_ticks += tsc_diff; 5368 } else { 5369 bdev_io->internal.ch->stat.bytes_written += 5370 bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen; 5371 bdev_io->internal.ch->stat.num_write_ops++; 5372 bdev_io->internal.ch->stat.write_latency_ticks += tsc_diff; 5373 } 5374 } 5375 break; 5376 default: 5377 break; 5378 } 5379 } 5380 5381 #ifdef SPDK_CONFIG_VTUNE 5382 uint64_t now_tsc = spdk_get_ticks(); 5383 if (now_tsc > (bdev_io->internal.ch->start_tsc + bdev_io->internal.ch->interval_tsc)) { 5384 uint64_t data[5]; 5385 5386 data[0] = bdev_io->internal.ch->stat.num_read_ops - bdev_io->internal.ch->prev_stat.num_read_ops; 5387 data[1] = bdev_io->internal.ch->stat.bytes_read - bdev_io->internal.ch->prev_stat.bytes_read; 5388 data[2] = bdev_io->internal.ch->stat.num_write_ops - bdev_io->internal.ch->prev_stat.num_write_ops; 5389 data[3] = bdev_io->internal.ch->stat.bytes_written - bdev_io->internal.ch->prev_stat.bytes_written; 5390 data[4] = bdev_io->bdev->fn_table->get_spin_time ? 5391 bdev_io->bdev->fn_table->get_spin_time(spdk_bdev_io_get_io_channel(bdev_io)) : 0; 5392 5393 __itt_metadata_add(g_bdev_mgr.domain, __itt_null, bdev_io->internal.ch->handle, 5394 __itt_metadata_u64, 5, data); 5395 5396 bdev_io->internal.ch->prev_stat = bdev_io->internal.ch->stat; 5397 bdev_io->internal.ch->start_tsc = now_tsc; 5398 } 5399 #endif 5400 5401 assert(bdev_io->internal.cb != NULL); 5402 assert(spdk_get_thread() == spdk_bdev_io_get_thread(bdev_io)); 5403 5404 bdev_io->internal.cb(bdev_io, bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS, 5405 bdev_io->internal.caller_ctx); 5406 } 5407 5408 static void 5409 bdev_reset_complete(struct spdk_io_channel_iter *i, int status) 5410 { 5411 struct spdk_bdev_io *bdev_io = spdk_io_channel_iter_get_ctx(i); 5412 5413 if (bdev_io->u.reset.ch_ref != NULL) { 5414 spdk_put_io_channel(bdev_io->u.reset.ch_ref); 5415 bdev_io->u.reset.ch_ref = NULL; 5416 } 5417 5418 bdev_io_complete(bdev_io); 5419 } 5420 5421 static void 5422 bdev_unfreeze_channel(struct spdk_io_channel_iter *i) 5423 { 5424 struct spdk_bdev_io *bdev_io = spdk_io_channel_iter_get_ctx(i); 5425 struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i); 5426 struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch); 5427 struct spdk_bdev_io *queued_reset; 5428 5429 ch->flags &= ~BDEV_CH_RESET_IN_PROGRESS; 5430 while (!TAILQ_EMPTY(&ch->queued_resets)) { 5431 queued_reset = TAILQ_FIRST(&ch->queued_resets); 5432 TAILQ_REMOVE(&ch->queued_resets, queued_reset, internal.link); 5433 spdk_bdev_io_complete(queued_reset, bdev_io->internal.status); 5434 } 5435 5436 spdk_for_each_channel_continue(i, 0); 5437 } 5438 5439 void 5440 spdk_bdev_io_complete(struct spdk_bdev_io *bdev_io, enum spdk_bdev_io_status status) 5441 { 5442 struct spdk_bdev *bdev = bdev_io->bdev; 5443 struct spdk_bdev_channel *bdev_ch = bdev_io->internal.ch; 5444 struct spdk_bdev_shared_resource *shared_resource = bdev_ch->shared_resource; 5445 5446 bdev_io->internal.status = status; 5447 5448 if (spdk_unlikely(bdev_io->type == SPDK_BDEV_IO_TYPE_RESET)) { 5449 bool unlock_channels = false; 5450 5451 if (status == SPDK_BDEV_IO_STATUS_NOMEM) { 5452 SPDK_ERRLOG("NOMEM returned for reset\n"); 5453 } 5454 pthread_mutex_lock(&bdev->internal.mutex); 5455 if (bdev_io == bdev->internal.reset_in_progress) { 5456 bdev->internal.reset_in_progress = NULL; 5457 unlock_channels = true; 5458 } 5459 pthread_mutex_unlock(&bdev->internal.mutex); 5460 5461 if (unlock_channels) { 5462 spdk_for_each_channel(__bdev_to_io_dev(bdev), bdev_unfreeze_channel, 5463 bdev_io, bdev_reset_complete); 5464 return; 5465 } 5466 } else { 5467 _bdev_io_unset_bounce_buf(bdev_io); 5468 5469 assert(bdev_ch->io_outstanding > 0); 5470 assert(shared_resource->io_outstanding > 0); 5471 bdev_ch->io_outstanding--; 5472 shared_resource->io_outstanding--; 5473 5474 if (spdk_unlikely(status == SPDK_BDEV_IO_STATUS_NOMEM)) { 5475 TAILQ_INSERT_HEAD(&shared_resource->nomem_io, bdev_io, internal.link); 5476 /* 5477 * Wait for some of the outstanding I/O to complete before we 5478 * retry any of the nomem_io. Normally we will wait for 5479 * NOMEM_THRESHOLD_COUNT I/O to complete but for low queue 5480 * depth channels we will instead wait for half to complete. 5481 */ 5482 shared_resource->nomem_threshold = spdk_max((int64_t)shared_resource->io_outstanding / 2, 5483 (int64_t)shared_resource->io_outstanding - NOMEM_THRESHOLD_COUNT); 5484 return; 5485 } 5486 5487 if (spdk_unlikely(!TAILQ_EMPTY(&shared_resource->nomem_io))) { 5488 bdev_ch_retry_io(bdev_ch); 5489 } 5490 } 5491 5492 bdev_io_complete(bdev_io); 5493 } 5494 5495 void 5496 spdk_bdev_io_complete_scsi_status(struct spdk_bdev_io *bdev_io, enum spdk_scsi_status sc, 5497 enum spdk_scsi_sense sk, uint8_t asc, uint8_t ascq) 5498 { 5499 if (sc == SPDK_SCSI_STATUS_GOOD) { 5500 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS; 5501 } else { 5502 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_SCSI_ERROR; 5503 bdev_io->internal.error.scsi.sc = sc; 5504 bdev_io->internal.error.scsi.sk = sk; 5505 bdev_io->internal.error.scsi.asc = asc; 5506 bdev_io->internal.error.scsi.ascq = ascq; 5507 } 5508 5509 spdk_bdev_io_complete(bdev_io, bdev_io->internal.status); 5510 } 5511 5512 void 5513 spdk_bdev_io_get_scsi_status(const struct spdk_bdev_io *bdev_io, 5514 int *sc, int *sk, int *asc, int *ascq) 5515 { 5516 assert(sc != NULL); 5517 assert(sk != NULL); 5518 assert(asc != NULL); 5519 assert(ascq != NULL); 5520 5521 switch (bdev_io->internal.status) { 5522 case SPDK_BDEV_IO_STATUS_SUCCESS: 5523 *sc = SPDK_SCSI_STATUS_GOOD; 5524 *sk = SPDK_SCSI_SENSE_NO_SENSE; 5525 *asc = SPDK_SCSI_ASC_NO_ADDITIONAL_SENSE; 5526 *ascq = SPDK_SCSI_ASCQ_CAUSE_NOT_REPORTABLE; 5527 break; 5528 case SPDK_BDEV_IO_STATUS_NVME_ERROR: 5529 spdk_scsi_nvme_translate(bdev_io, sc, sk, asc, ascq); 5530 break; 5531 case SPDK_BDEV_IO_STATUS_SCSI_ERROR: 5532 *sc = bdev_io->internal.error.scsi.sc; 5533 *sk = bdev_io->internal.error.scsi.sk; 5534 *asc = bdev_io->internal.error.scsi.asc; 5535 *ascq = bdev_io->internal.error.scsi.ascq; 5536 break; 5537 default: 5538 *sc = SPDK_SCSI_STATUS_CHECK_CONDITION; 5539 *sk = SPDK_SCSI_SENSE_ABORTED_COMMAND; 5540 *asc = SPDK_SCSI_ASC_NO_ADDITIONAL_SENSE; 5541 *ascq = SPDK_SCSI_ASCQ_CAUSE_NOT_REPORTABLE; 5542 break; 5543 } 5544 } 5545 5546 void 5547 spdk_bdev_io_complete_aio_status(struct spdk_bdev_io *bdev_io, int aio_result) 5548 { 5549 if (aio_result == 0) { 5550 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS; 5551 } else { 5552 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_AIO_ERROR; 5553 } 5554 5555 bdev_io->internal.error.aio_result = aio_result; 5556 5557 spdk_bdev_io_complete(bdev_io, bdev_io->internal.status); 5558 } 5559 5560 void 5561 spdk_bdev_io_get_aio_status(const struct spdk_bdev_io *bdev_io, int *aio_result) 5562 { 5563 assert(aio_result != NULL); 5564 5565 if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_AIO_ERROR) { 5566 *aio_result = bdev_io->internal.error.aio_result; 5567 } else if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS) { 5568 *aio_result = 0; 5569 } else { 5570 *aio_result = -EIO; 5571 } 5572 } 5573 5574 void 5575 spdk_bdev_io_complete_nvme_status(struct spdk_bdev_io *bdev_io, uint32_t cdw0, int sct, int sc) 5576 { 5577 if (sct == SPDK_NVME_SCT_GENERIC && sc == SPDK_NVME_SC_SUCCESS) { 5578 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS; 5579 } else if (sct == SPDK_NVME_SCT_GENERIC && sc == SPDK_NVME_SC_ABORTED_BY_REQUEST) { 5580 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_ABORTED; 5581 } else { 5582 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_NVME_ERROR; 5583 } 5584 5585 bdev_io->internal.error.nvme.cdw0 = cdw0; 5586 bdev_io->internal.error.nvme.sct = sct; 5587 bdev_io->internal.error.nvme.sc = sc; 5588 5589 spdk_bdev_io_complete(bdev_io, bdev_io->internal.status); 5590 } 5591 5592 void 5593 spdk_bdev_io_get_nvme_status(const struct spdk_bdev_io *bdev_io, uint32_t *cdw0, int *sct, int *sc) 5594 { 5595 assert(sct != NULL); 5596 assert(sc != NULL); 5597 assert(cdw0 != NULL); 5598 5599 if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_NVME_ERROR) { 5600 *sct = bdev_io->internal.error.nvme.sct; 5601 *sc = bdev_io->internal.error.nvme.sc; 5602 } else if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS) { 5603 *sct = SPDK_NVME_SCT_GENERIC; 5604 *sc = SPDK_NVME_SC_SUCCESS; 5605 } else if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_ABORTED) { 5606 *sct = SPDK_NVME_SCT_GENERIC; 5607 *sc = SPDK_NVME_SC_ABORTED_BY_REQUEST; 5608 } else { 5609 *sct = SPDK_NVME_SCT_GENERIC; 5610 *sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 5611 } 5612 5613 *cdw0 = bdev_io->internal.error.nvme.cdw0; 5614 } 5615 5616 void 5617 spdk_bdev_io_get_nvme_fused_status(const struct spdk_bdev_io *bdev_io, uint32_t *cdw0, 5618 int *first_sct, int *first_sc, int *second_sct, int *second_sc) 5619 { 5620 assert(first_sct != NULL); 5621 assert(first_sc != NULL); 5622 assert(second_sct != NULL); 5623 assert(second_sc != NULL); 5624 assert(cdw0 != NULL); 5625 5626 if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_NVME_ERROR) { 5627 if (bdev_io->internal.error.nvme.sct == SPDK_NVME_SCT_MEDIA_ERROR && 5628 bdev_io->internal.error.nvme.sc == SPDK_NVME_SC_COMPARE_FAILURE) { 5629 *first_sct = bdev_io->internal.error.nvme.sct; 5630 *first_sc = bdev_io->internal.error.nvme.sc; 5631 *second_sct = SPDK_NVME_SCT_GENERIC; 5632 *second_sc = SPDK_NVME_SC_ABORTED_FAILED_FUSED; 5633 } else { 5634 *first_sct = SPDK_NVME_SCT_GENERIC; 5635 *first_sc = SPDK_NVME_SC_SUCCESS; 5636 *second_sct = bdev_io->internal.error.nvme.sct; 5637 *second_sc = bdev_io->internal.error.nvme.sc; 5638 } 5639 } else if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS) { 5640 *first_sct = SPDK_NVME_SCT_GENERIC; 5641 *first_sc = SPDK_NVME_SC_SUCCESS; 5642 *second_sct = SPDK_NVME_SCT_GENERIC; 5643 *second_sc = SPDK_NVME_SC_SUCCESS; 5644 } else if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_FIRST_FUSED_FAILED) { 5645 *first_sct = SPDK_NVME_SCT_GENERIC; 5646 *first_sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 5647 *second_sct = SPDK_NVME_SCT_GENERIC; 5648 *second_sc = SPDK_NVME_SC_ABORTED_FAILED_FUSED; 5649 } else if (bdev_io->internal.status == SPDK_BDEV_IO_STATUS_MISCOMPARE) { 5650 *first_sct = SPDK_NVME_SCT_MEDIA_ERROR; 5651 *first_sc = SPDK_NVME_SC_COMPARE_FAILURE; 5652 *second_sct = SPDK_NVME_SCT_GENERIC; 5653 *second_sc = SPDK_NVME_SC_ABORTED_FAILED_FUSED; 5654 } else { 5655 *first_sct = SPDK_NVME_SCT_GENERIC; 5656 *first_sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 5657 *second_sct = SPDK_NVME_SCT_GENERIC; 5658 *second_sc = SPDK_NVME_SC_INTERNAL_DEVICE_ERROR; 5659 } 5660 5661 *cdw0 = bdev_io->internal.error.nvme.cdw0; 5662 } 5663 5664 struct spdk_thread * 5665 spdk_bdev_io_get_thread(struct spdk_bdev_io *bdev_io) 5666 { 5667 return spdk_io_channel_get_thread(bdev_io->internal.ch->channel); 5668 } 5669 5670 struct spdk_io_channel * 5671 spdk_bdev_io_get_io_channel(struct spdk_bdev_io *bdev_io) 5672 { 5673 return bdev_io->internal.ch->channel; 5674 } 5675 5676 static int 5677 bdev_register(struct spdk_bdev *bdev) 5678 { 5679 char *bdev_name; 5680 int ret; 5681 5682 assert(bdev->module != NULL); 5683 5684 if (!bdev->name) { 5685 SPDK_ERRLOG("Bdev name is NULL\n"); 5686 return -EINVAL; 5687 } 5688 5689 if (!strlen(bdev->name)) { 5690 SPDK_ERRLOG("Bdev name must not be an empty string\n"); 5691 return -EINVAL; 5692 } 5693 5694 /* Users often register their own I/O devices using the bdev name. In 5695 * order to avoid conflicts, prepend bdev_. */ 5696 bdev_name = spdk_sprintf_alloc("bdev_%s", bdev->name); 5697 if (!bdev_name) { 5698 SPDK_ERRLOG("Unable to allocate memory for internal bdev name.\n"); 5699 return -ENOMEM; 5700 } 5701 5702 bdev->internal.status = SPDK_BDEV_STATUS_READY; 5703 bdev->internal.measured_queue_depth = UINT64_MAX; 5704 bdev->internal.claim_module = NULL; 5705 bdev->internal.qd_poller = NULL; 5706 bdev->internal.qos = NULL; 5707 5708 ret = bdev_name_add(&bdev->internal.bdev_name, bdev, bdev->name); 5709 if (ret != 0) { 5710 free(bdev_name); 5711 return ret; 5712 } 5713 5714 /* If the user didn't specify a uuid, generate one. */ 5715 if (spdk_mem_all_zero(&bdev->uuid, sizeof(bdev->uuid))) { 5716 spdk_uuid_generate(&bdev->uuid); 5717 } 5718 5719 if (spdk_bdev_get_buf_align(bdev) > 1) { 5720 if (bdev->split_on_optimal_io_boundary) { 5721 bdev->optimal_io_boundary = spdk_min(bdev->optimal_io_boundary, 5722 SPDK_BDEV_LARGE_BUF_MAX_SIZE / bdev->blocklen); 5723 } else { 5724 bdev->split_on_optimal_io_boundary = true; 5725 bdev->optimal_io_boundary = SPDK_BDEV_LARGE_BUF_MAX_SIZE / bdev->blocklen; 5726 } 5727 } 5728 5729 /* If the user didn't specify a write unit size, set it to one. */ 5730 if (bdev->write_unit_size == 0) { 5731 bdev->write_unit_size = 1; 5732 } 5733 5734 /* Set ACWU value to 1 if bdev module did not set it (does not support it natively) */ 5735 if (bdev->acwu == 0) { 5736 bdev->acwu = 1; 5737 } 5738 5739 if (bdev->phys_blocklen == 0) { 5740 bdev->phys_blocklen = spdk_bdev_get_data_block_size(bdev); 5741 } 5742 5743 TAILQ_INIT(&bdev->internal.open_descs); 5744 TAILQ_INIT(&bdev->internal.locked_ranges); 5745 TAILQ_INIT(&bdev->internal.pending_locked_ranges); 5746 5747 TAILQ_INIT(&bdev->aliases); 5748 5749 bdev->internal.reset_in_progress = NULL; 5750 5751 spdk_io_device_register(__bdev_to_io_dev(bdev), 5752 bdev_channel_create, bdev_channel_destroy, 5753 sizeof(struct spdk_bdev_channel), 5754 bdev_name); 5755 5756 free(bdev_name); 5757 5758 pthread_mutex_init(&bdev->internal.mutex, NULL); 5759 5760 SPDK_DEBUGLOG(bdev, "Inserting bdev %s into list\n", bdev->name); 5761 TAILQ_INSERT_TAIL(&g_bdev_mgr.bdevs, bdev, internal.link); 5762 5763 return 0; 5764 } 5765 5766 static void 5767 bdev_destroy_cb(void *io_device) 5768 { 5769 int rc; 5770 struct spdk_bdev *bdev; 5771 spdk_bdev_unregister_cb cb_fn; 5772 void *cb_arg; 5773 5774 bdev = __bdev_from_io_dev(io_device); 5775 cb_fn = bdev->internal.unregister_cb; 5776 cb_arg = bdev->internal.unregister_ctx; 5777 5778 pthread_mutex_destroy(&bdev->internal.mutex); 5779 free(bdev->internal.qos); 5780 5781 rc = bdev->fn_table->destruct(bdev->ctxt); 5782 if (rc < 0) { 5783 SPDK_ERRLOG("destruct failed\n"); 5784 } 5785 if (rc <= 0 && cb_fn != NULL) { 5786 cb_fn(cb_arg, rc); 5787 } 5788 } 5789 5790 static void 5791 bdev_register_finished(void *arg) 5792 { 5793 struct spdk_bdev *bdev = arg; 5794 5795 spdk_notify_send("bdev_register", spdk_bdev_get_name(bdev)); 5796 } 5797 5798 int 5799 spdk_bdev_register(struct spdk_bdev *bdev) 5800 { 5801 int rc = bdev_register(bdev); 5802 5803 if (rc == 0) { 5804 /* Examine configuration before initializing I/O */ 5805 bdev_examine(bdev); 5806 5807 spdk_bdev_wait_for_examine(bdev_register_finished, bdev); 5808 } 5809 5810 return rc; 5811 } 5812 5813 void 5814 spdk_bdev_destruct_done(struct spdk_bdev *bdev, int bdeverrno) 5815 { 5816 if (bdev->internal.unregister_cb != NULL) { 5817 bdev->internal.unregister_cb(bdev->internal.unregister_ctx, bdeverrno); 5818 } 5819 } 5820 5821 static void 5822 _remove_notify(void *arg) 5823 { 5824 struct spdk_bdev_desc *desc = arg; 5825 5826 pthread_mutex_lock(&desc->mutex); 5827 desc->refs--; 5828 5829 if (!desc->closed) { 5830 pthread_mutex_unlock(&desc->mutex); 5831 desc->callback.event_fn(SPDK_BDEV_EVENT_REMOVE, desc->bdev, desc->callback.ctx); 5832 return; 5833 } else if (0 == desc->refs) { 5834 /* This descriptor was closed after this remove_notify message was sent. 5835 * spdk_bdev_close() could not free the descriptor since this message was 5836 * in flight, so we free it now using bdev_desc_free(). 5837 */ 5838 pthread_mutex_unlock(&desc->mutex); 5839 bdev_desc_free(desc); 5840 return; 5841 } 5842 pthread_mutex_unlock(&desc->mutex); 5843 } 5844 5845 /* Must be called while holding bdev->internal.mutex. 5846 * returns: 0 - bdev removed and ready to be destructed. 5847 * -EBUSY - bdev can't be destructed yet. */ 5848 static int 5849 bdev_unregister_unsafe(struct spdk_bdev *bdev) 5850 { 5851 struct spdk_bdev_desc *desc, *tmp; 5852 int rc = 0; 5853 5854 /* Notify each descriptor about hotremoval */ 5855 TAILQ_FOREACH_SAFE(desc, &bdev->internal.open_descs, link, tmp) { 5856 rc = -EBUSY; 5857 pthread_mutex_lock(&desc->mutex); 5858 /* 5859 * Defer invocation of the event_cb to a separate message that will 5860 * run later on its thread. This ensures this context unwinds and 5861 * we don't recursively unregister this bdev again if the event_cb 5862 * immediately closes its descriptor. 5863 */ 5864 desc->refs++; 5865 spdk_thread_send_msg(desc->thread, _remove_notify, desc); 5866 pthread_mutex_unlock(&desc->mutex); 5867 } 5868 5869 /* If there are no descriptors, proceed removing the bdev */ 5870 if (rc == 0) { 5871 TAILQ_REMOVE(&g_bdev_mgr.bdevs, bdev, internal.link); 5872 SPDK_DEBUGLOG(bdev, "Removing bdev %s from list done\n", bdev->name); 5873 bdev_name_del(&bdev->internal.bdev_name); 5874 spdk_notify_send("bdev_unregister", spdk_bdev_get_name(bdev)); 5875 } 5876 5877 return rc; 5878 } 5879 5880 void 5881 spdk_bdev_unregister(struct spdk_bdev *bdev, spdk_bdev_unregister_cb cb_fn, void *cb_arg) 5882 { 5883 struct spdk_thread *thread; 5884 int rc; 5885 5886 SPDK_DEBUGLOG(bdev, "Removing bdev %s from list\n", bdev->name); 5887 5888 thread = spdk_get_thread(); 5889 if (!thread) { 5890 /* The user called this from a non-SPDK thread. */ 5891 if (cb_fn != NULL) { 5892 cb_fn(cb_arg, -ENOTSUP); 5893 } 5894 return; 5895 } 5896 5897 pthread_mutex_lock(&g_bdev_mgr.mutex); 5898 if (bdev->internal.status == SPDK_BDEV_STATUS_REMOVING) { 5899 pthread_mutex_unlock(&g_bdev_mgr.mutex); 5900 if (cb_fn) { 5901 cb_fn(cb_arg, -EBUSY); 5902 } 5903 return; 5904 } 5905 5906 pthread_mutex_lock(&bdev->internal.mutex); 5907 bdev->internal.status = SPDK_BDEV_STATUS_REMOVING; 5908 bdev->internal.unregister_cb = cb_fn; 5909 bdev->internal.unregister_ctx = cb_arg; 5910 5911 /* Call under lock. */ 5912 rc = bdev_unregister_unsafe(bdev); 5913 pthread_mutex_unlock(&bdev->internal.mutex); 5914 pthread_mutex_unlock(&g_bdev_mgr.mutex); 5915 5916 if (rc == 0) { 5917 spdk_io_device_unregister(__bdev_to_io_dev(bdev), bdev_destroy_cb); 5918 } 5919 } 5920 5921 static int 5922 bdev_start_qos(struct spdk_bdev *bdev) 5923 { 5924 struct set_qos_limit_ctx *ctx; 5925 5926 /* Enable QoS */ 5927 if (bdev->internal.qos && bdev->internal.qos->thread == NULL) { 5928 ctx = calloc(1, sizeof(*ctx)); 5929 if (ctx == NULL) { 5930 SPDK_ERRLOG("Failed to allocate memory for QoS context\n"); 5931 return -ENOMEM; 5932 } 5933 ctx->bdev = bdev; 5934 spdk_for_each_channel(__bdev_to_io_dev(bdev), 5935 bdev_enable_qos_msg, ctx, 5936 bdev_enable_qos_done); 5937 } 5938 5939 return 0; 5940 } 5941 5942 static int 5943 bdev_open(struct spdk_bdev *bdev, bool write, struct spdk_bdev_desc *desc) 5944 { 5945 struct spdk_thread *thread; 5946 int rc = 0; 5947 5948 thread = spdk_get_thread(); 5949 if (!thread) { 5950 SPDK_ERRLOG("Cannot open bdev from non-SPDK thread.\n"); 5951 return -ENOTSUP; 5952 } 5953 5954 SPDK_DEBUGLOG(bdev, "Opening descriptor %p for bdev %s on thread %p\n", desc, bdev->name, 5955 spdk_get_thread()); 5956 5957 desc->bdev = bdev; 5958 desc->thread = thread; 5959 desc->write = write; 5960 5961 pthread_mutex_lock(&bdev->internal.mutex); 5962 if (bdev->internal.status == SPDK_BDEV_STATUS_REMOVING) { 5963 pthread_mutex_unlock(&bdev->internal.mutex); 5964 return -ENODEV; 5965 } 5966 5967 if (write && bdev->internal.claim_module) { 5968 SPDK_ERRLOG("Could not open %s - %s module already claimed it\n", 5969 bdev->name, bdev->internal.claim_module->name); 5970 pthread_mutex_unlock(&bdev->internal.mutex); 5971 return -EPERM; 5972 } 5973 5974 rc = bdev_start_qos(bdev); 5975 if (rc != 0) { 5976 SPDK_ERRLOG("Failed to start QoS on bdev %s\n", bdev->name); 5977 pthread_mutex_unlock(&bdev->internal.mutex); 5978 return rc; 5979 } 5980 5981 TAILQ_INSERT_TAIL(&bdev->internal.open_descs, desc, link); 5982 5983 pthread_mutex_unlock(&bdev->internal.mutex); 5984 5985 return 0; 5986 } 5987 5988 int 5989 spdk_bdev_open_ext(const char *bdev_name, bool write, spdk_bdev_event_cb_t event_cb, 5990 void *event_ctx, struct spdk_bdev_desc **_desc) 5991 { 5992 struct spdk_bdev_desc *desc; 5993 struct spdk_bdev *bdev; 5994 unsigned int event_id; 5995 int rc; 5996 5997 if (event_cb == NULL) { 5998 SPDK_ERRLOG("Missing event callback function\n"); 5999 return -EINVAL; 6000 } 6001 6002 pthread_mutex_lock(&g_bdev_mgr.mutex); 6003 6004 bdev = bdev_get_by_name(bdev_name); 6005 6006 if (bdev == NULL) { 6007 SPDK_NOTICELOG("Currently unable to find bdev with name: %s\n", bdev_name); 6008 pthread_mutex_unlock(&g_bdev_mgr.mutex); 6009 return -ENODEV; 6010 } 6011 6012 desc = calloc(1, sizeof(*desc)); 6013 if (desc == NULL) { 6014 SPDK_ERRLOG("Failed to allocate memory for bdev descriptor\n"); 6015 pthread_mutex_unlock(&g_bdev_mgr.mutex); 6016 return -ENOMEM; 6017 } 6018 6019 TAILQ_INIT(&desc->pending_media_events); 6020 TAILQ_INIT(&desc->free_media_events); 6021 6022 desc->callback.event_fn = event_cb; 6023 desc->callback.ctx = event_ctx; 6024 pthread_mutex_init(&desc->mutex, NULL); 6025 6026 if (bdev->media_events) { 6027 desc->media_events_buffer = calloc(MEDIA_EVENT_POOL_SIZE, 6028 sizeof(*desc->media_events_buffer)); 6029 if (desc->media_events_buffer == NULL) { 6030 SPDK_ERRLOG("Failed to initialize media event pool\n"); 6031 bdev_desc_free(desc); 6032 pthread_mutex_unlock(&g_bdev_mgr.mutex); 6033 return -ENOMEM; 6034 } 6035 6036 for (event_id = 0; event_id < MEDIA_EVENT_POOL_SIZE; ++event_id) { 6037 TAILQ_INSERT_TAIL(&desc->free_media_events, 6038 &desc->media_events_buffer[event_id], tailq); 6039 } 6040 } 6041 6042 rc = bdev_open(bdev, write, desc); 6043 if (rc != 0) { 6044 bdev_desc_free(desc); 6045 desc = NULL; 6046 } 6047 6048 *_desc = desc; 6049 6050 pthread_mutex_unlock(&g_bdev_mgr.mutex); 6051 6052 return rc; 6053 } 6054 6055 void 6056 spdk_bdev_close(struct spdk_bdev_desc *desc) 6057 { 6058 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 6059 int rc; 6060 6061 SPDK_DEBUGLOG(bdev, "Closing descriptor %p for bdev %s on thread %p\n", desc, bdev->name, 6062 spdk_get_thread()); 6063 6064 assert(desc->thread == spdk_get_thread()); 6065 6066 spdk_poller_unregister(&desc->io_timeout_poller); 6067 6068 pthread_mutex_lock(&g_bdev_mgr.mutex); 6069 pthread_mutex_lock(&bdev->internal.mutex); 6070 pthread_mutex_lock(&desc->mutex); 6071 6072 TAILQ_REMOVE(&bdev->internal.open_descs, desc, link); 6073 6074 desc->closed = true; 6075 6076 if (0 == desc->refs) { 6077 pthread_mutex_unlock(&desc->mutex); 6078 bdev_desc_free(desc); 6079 } else { 6080 pthread_mutex_unlock(&desc->mutex); 6081 } 6082 6083 /* If no more descriptors, kill QoS channel */ 6084 if (bdev->internal.qos && TAILQ_EMPTY(&bdev->internal.open_descs)) { 6085 SPDK_DEBUGLOG(bdev, "Closed last descriptor for bdev %s on thread %p. Stopping QoS.\n", 6086 bdev->name, spdk_get_thread()); 6087 6088 if (bdev_qos_destroy(bdev)) { 6089 /* There isn't anything we can do to recover here. Just let the 6090 * old QoS poller keep running. The QoS handling won't change 6091 * cores when the user allocates a new channel, but it won't break. */ 6092 SPDK_ERRLOG("Unable to shut down QoS poller. It will continue running on the current thread.\n"); 6093 } 6094 } 6095 6096 spdk_bdev_set_qd_sampling_period(bdev, 0); 6097 6098 if (bdev->internal.status == SPDK_BDEV_STATUS_REMOVING && TAILQ_EMPTY(&bdev->internal.open_descs)) { 6099 rc = bdev_unregister_unsafe(bdev); 6100 pthread_mutex_unlock(&bdev->internal.mutex); 6101 pthread_mutex_unlock(&g_bdev_mgr.mutex); 6102 6103 if (rc == 0) { 6104 spdk_io_device_unregister(__bdev_to_io_dev(bdev), bdev_destroy_cb); 6105 } 6106 } else { 6107 pthread_mutex_unlock(&bdev->internal.mutex); 6108 pthread_mutex_unlock(&g_bdev_mgr.mutex); 6109 } 6110 } 6111 6112 int 6113 spdk_bdev_module_claim_bdev(struct spdk_bdev *bdev, struct spdk_bdev_desc *desc, 6114 struct spdk_bdev_module *module) 6115 { 6116 if (bdev->internal.claim_module != NULL) { 6117 SPDK_ERRLOG("bdev %s already claimed by module %s\n", bdev->name, 6118 bdev->internal.claim_module->name); 6119 return -EPERM; 6120 } 6121 6122 if (desc && !desc->write) { 6123 desc->write = true; 6124 } 6125 6126 bdev->internal.claim_module = module; 6127 return 0; 6128 } 6129 6130 void 6131 spdk_bdev_module_release_bdev(struct spdk_bdev *bdev) 6132 { 6133 assert(bdev->internal.claim_module != NULL); 6134 bdev->internal.claim_module = NULL; 6135 } 6136 6137 struct spdk_bdev * 6138 spdk_bdev_desc_get_bdev(struct spdk_bdev_desc *desc) 6139 { 6140 assert(desc != NULL); 6141 return desc->bdev; 6142 } 6143 6144 void 6145 spdk_bdev_io_get_iovec(struct spdk_bdev_io *bdev_io, struct iovec **iovp, int *iovcntp) 6146 { 6147 struct iovec *iovs; 6148 int iovcnt; 6149 6150 if (bdev_io == NULL) { 6151 return; 6152 } 6153 6154 switch (bdev_io->type) { 6155 case SPDK_BDEV_IO_TYPE_READ: 6156 case SPDK_BDEV_IO_TYPE_WRITE: 6157 case SPDK_BDEV_IO_TYPE_ZCOPY: 6158 iovs = bdev_io->u.bdev.iovs; 6159 iovcnt = bdev_io->u.bdev.iovcnt; 6160 break; 6161 default: 6162 iovs = NULL; 6163 iovcnt = 0; 6164 break; 6165 } 6166 6167 if (iovp) { 6168 *iovp = iovs; 6169 } 6170 if (iovcntp) { 6171 *iovcntp = iovcnt; 6172 } 6173 } 6174 6175 void * 6176 spdk_bdev_io_get_md_buf(struct spdk_bdev_io *bdev_io) 6177 { 6178 if (bdev_io == NULL) { 6179 return NULL; 6180 } 6181 6182 if (!spdk_bdev_is_md_separate(bdev_io->bdev)) { 6183 return NULL; 6184 } 6185 6186 if (bdev_io->type == SPDK_BDEV_IO_TYPE_READ || 6187 bdev_io->type == SPDK_BDEV_IO_TYPE_WRITE) { 6188 return bdev_io->u.bdev.md_buf; 6189 } 6190 6191 return NULL; 6192 } 6193 6194 void * 6195 spdk_bdev_io_get_cb_arg(struct spdk_bdev_io *bdev_io) 6196 { 6197 if (bdev_io == NULL) { 6198 assert(false); 6199 return NULL; 6200 } 6201 6202 return bdev_io->internal.caller_ctx; 6203 } 6204 6205 void 6206 spdk_bdev_module_list_add(struct spdk_bdev_module *bdev_module) 6207 { 6208 6209 if (spdk_bdev_module_list_find(bdev_module->name)) { 6210 SPDK_ERRLOG("ERROR: module '%s' already registered.\n", bdev_module->name); 6211 assert(false); 6212 } 6213 6214 /* 6215 * Modules with examine callbacks must be initialized first, so they are 6216 * ready to handle examine callbacks from later modules that will 6217 * register physical bdevs. 6218 */ 6219 if (bdev_module->examine_config != NULL || bdev_module->examine_disk != NULL) { 6220 TAILQ_INSERT_HEAD(&g_bdev_mgr.bdev_modules, bdev_module, internal.tailq); 6221 } else { 6222 TAILQ_INSERT_TAIL(&g_bdev_mgr.bdev_modules, bdev_module, internal.tailq); 6223 } 6224 } 6225 6226 struct spdk_bdev_module * 6227 spdk_bdev_module_list_find(const char *name) 6228 { 6229 struct spdk_bdev_module *bdev_module; 6230 6231 TAILQ_FOREACH(bdev_module, &g_bdev_mgr.bdev_modules, internal.tailq) { 6232 if (strcmp(name, bdev_module->name) == 0) { 6233 break; 6234 } 6235 } 6236 6237 return bdev_module; 6238 } 6239 6240 static void 6241 bdev_write_zero_buffer_next(void *_bdev_io) 6242 { 6243 struct spdk_bdev_io *bdev_io = _bdev_io; 6244 uint64_t num_bytes, num_blocks; 6245 void *md_buf = NULL; 6246 int rc; 6247 6248 num_bytes = spdk_min(_bdev_get_block_size_with_md(bdev_io->bdev) * 6249 bdev_io->u.bdev.split_remaining_num_blocks, 6250 ZERO_BUFFER_SIZE); 6251 num_blocks = num_bytes / _bdev_get_block_size_with_md(bdev_io->bdev); 6252 6253 if (spdk_bdev_is_md_separate(bdev_io->bdev)) { 6254 md_buf = (char *)g_bdev_mgr.zero_buffer + 6255 spdk_bdev_get_block_size(bdev_io->bdev) * num_blocks; 6256 } 6257 6258 rc = bdev_write_blocks_with_md(bdev_io->internal.desc, 6259 spdk_io_channel_from_ctx(bdev_io->internal.ch), 6260 g_bdev_mgr.zero_buffer, md_buf, 6261 bdev_io->u.bdev.split_current_offset_blocks, num_blocks, 6262 bdev_write_zero_buffer_done, bdev_io); 6263 if (rc == 0) { 6264 bdev_io->u.bdev.split_remaining_num_blocks -= num_blocks; 6265 bdev_io->u.bdev.split_current_offset_blocks += num_blocks; 6266 } else if (rc == -ENOMEM) { 6267 bdev_queue_io_wait_with_cb(bdev_io, bdev_write_zero_buffer_next); 6268 } else { 6269 bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED; 6270 bdev_io->internal.cb(bdev_io, false, bdev_io->internal.caller_ctx); 6271 } 6272 } 6273 6274 static void 6275 bdev_write_zero_buffer_done(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg) 6276 { 6277 struct spdk_bdev_io *parent_io = cb_arg; 6278 6279 spdk_bdev_free_io(bdev_io); 6280 6281 if (!success) { 6282 parent_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED; 6283 parent_io->internal.cb(parent_io, false, parent_io->internal.caller_ctx); 6284 return; 6285 } 6286 6287 if (parent_io->u.bdev.split_remaining_num_blocks == 0) { 6288 parent_io->internal.status = SPDK_BDEV_IO_STATUS_SUCCESS; 6289 parent_io->internal.cb(parent_io, true, parent_io->internal.caller_ctx); 6290 return; 6291 } 6292 6293 bdev_write_zero_buffer_next(parent_io); 6294 } 6295 6296 static void 6297 bdev_set_qos_limit_done(struct set_qos_limit_ctx *ctx, int status) 6298 { 6299 pthread_mutex_lock(&ctx->bdev->internal.mutex); 6300 ctx->bdev->internal.qos_mod_in_progress = false; 6301 pthread_mutex_unlock(&ctx->bdev->internal.mutex); 6302 6303 if (ctx->cb_fn) { 6304 ctx->cb_fn(ctx->cb_arg, status); 6305 } 6306 free(ctx); 6307 } 6308 6309 static void 6310 bdev_disable_qos_done(void *cb_arg) 6311 { 6312 struct set_qos_limit_ctx *ctx = cb_arg; 6313 struct spdk_bdev *bdev = ctx->bdev; 6314 struct spdk_bdev_io *bdev_io; 6315 struct spdk_bdev_qos *qos; 6316 6317 pthread_mutex_lock(&bdev->internal.mutex); 6318 qos = bdev->internal.qos; 6319 bdev->internal.qos = NULL; 6320 pthread_mutex_unlock(&bdev->internal.mutex); 6321 6322 while (!TAILQ_EMPTY(&qos->queued)) { 6323 /* Send queued I/O back to their original thread for resubmission. */ 6324 bdev_io = TAILQ_FIRST(&qos->queued); 6325 TAILQ_REMOVE(&qos->queued, bdev_io, internal.link); 6326 6327 if (bdev_io->internal.io_submit_ch) { 6328 /* 6329 * Channel was changed when sending it to the QoS thread - change it back 6330 * before sending it back to the original thread. 6331 */ 6332 bdev_io->internal.ch = bdev_io->internal.io_submit_ch; 6333 bdev_io->internal.io_submit_ch = NULL; 6334 } 6335 6336 spdk_thread_send_msg(spdk_bdev_io_get_thread(bdev_io), 6337 _bdev_io_submit, bdev_io); 6338 } 6339 6340 if (qos->thread != NULL) { 6341 spdk_put_io_channel(spdk_io_channel_from_ctx(qos->ch)); 6342 spdk_poller_unregister(&qos->poller); 6343 } 6344 6345 free(qos); 6346 6347 bdev_set_qos_limit_done(ctx, 0); 6348 } 6349 6350 static void 6351 bdev_disable_qos_msg_done(struct spdk_io_channel_iter *i, int status) 6352 { 6353 void *io_device = spdk_io_channel_iter_get_io_device(i); 6354 struct spdk_bdev *bdev = __bdev_from_io_dev(io_device); 6355 struct set_qos_limit_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 6356 struct spdk_thread *thread; 6357 6358 pthread_mutex_lock(&bdev->internal.mutex); 6359 thread = bdev->internal.qos->thread; 6360 pthread_mutex_unlock(&bdev->internal.mutex); 6361 6362 if (thread != NULL) { 6363 spdk_thread_send_msg(thread, bdev_disable_qos_done, ctx); 6364 } else { 6365 bdev_disable_qos_done(ctx); 6366 } 6367 } 6368 6369 static void 6370 bdev_disable_qos_msg(struct spdk_io_channel_iter *i) 6371 { 6372 struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i); 6373 struct spdk_bdev_channel *bdev_ch = spdk_io_channel_get_ctx(ch); 6374 6375 bdev_ch->flags &= ~BDEV_CH_QOS_ENABLED; 6376 6377 spdk_for_each_channel_continue(i, 0); 6378 } 6379 6380 static void 6381 bdev_update_qos_rate_limit_msg(void *cb_arg) 6382 { 6383 struct set_qos_limit_ctx *ctx = cb_arg; 6384 struct spdk_bdev *bdev = ctx->bdev; 6385 6386 pthread_mutex_lock(&bdev->internal.mutex); 6387 bdev_qos_update_max_quota_per_timeslice(bdev->internal.qos); 6388 pthread_mutex_unlock(&bdev->internal.mutex); 6389 6390 bdev_set_qos_limit_done(ctx, 0); 6391 } 6392 6393 static void 6394 bdev_enable_qos_msg(struct spdk_io_channel_iter *i) 6395 { 6396 void *io_device = spdk_io_channel_iter_get_io_device(i); 6397 struct spdk_bdev *bdev = __bdev_from_io_dev(io_device); 6398 struct spdk_io_channel *ch = spdk_io_channel_iter_get_channel(i); 6399 struct spdk_bdev_channel *bdev_ch = spdk_io_channel_get_ctx(ch); 6400 6401 pthread_mutex_lock(&bdev->internal.mutex); 6402 bdev_enable_qos(bdev, bdev_ch); 6403 pthread_mutex_unlock(&bdev->internal.mutex); 6404 spdk_for_each_channel_continue(i, 0); 6405 } 6406 6407 static void 6408 bdev_enable_qos_done(struct spdk_io_channel_iter *i, int status) 6409 { 6410 struct set_qos_limit_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 6411 6412 bdev_set_qos_limit_done(ctx, status); 6413 } 6414 6415 static void 6416 bdev_set_qos_rate_limits(struct spdk_bdev *bdev, uint64_t *limits) 6417 { 6418 int i; 6419 6420 assert(bdev->internal.qos != NULL); 6421 6422 for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) { 6423 if (limits[i] != SPDK_BDEV_QOS_LIMIT_NOT_DEFINED) { 6424 bdev->internal.qos->rate_limits[i].limit = limits[i]; 6425 6426 if (limits[i] == 0) { 6427 bdev->internal.qos->rate_limits[i].limit = 6428 SPDK_BDEV_QOS_LIMIT_NOT_DEFINED; 6429 } 6430 } 6431 } 6432 } 6433 6434 void 6435 spdk_bdev_set_qos_rate_limits(struct spdk_bdev *bdev, uint64_t *limits, 6436 void (*cb_fn)(void *cb_arg, int status), void *cb_arg) 6437 { 6438 struct set_qos_limit_ctx *ctx; 6439 uint32_t limit_set_complement; 6440 uint64_t min_limit_per_sec; 6441 int i; 6442 bool disable_rate_limit = true; 6443 6444 for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) { 6445 if (limits[i] == SPDK_BDEV_QOS_LIMIT_NOT_DEFINED) { 6446 continue; 6447 } 6448 6449 if (limits[i] > 0) { 6450 disable_rate_limit = false; 6451 } 6452 6453 if (bdev_qos_is_iops_rate_limit(i) == true) { 6454 min_limit_per_sec = SPDK_BDEV_QOS_MIN_IOS_PER_SEC; 6455 } else { 6456 /* Change from megabyte to byte rate limit */ 6457 limits[i] = limits[i] * 1024 * 1024; 6458 min_limit_per_sec = SPDK_BDEV_QOS_MIN_BYTES_PER_SEC; 6459 } 6460 6461 limit_set_complement = limits[i] % min_limit_per_sec; 6462 if (limit_set_complement) { 6463 SPDK_ERRLOG("Requested rate limit %" PRIu64 " is not a multiple of %" PRIu64 "\n", 6464 limits[i], min_limit_per_sec); 6465 limits[i] += min_limit_per_sec - limit_set_complement; 6466 SPDK_ERRLOG("Round up the rate limit to %" PRIu64 "\n", limits[i]); 6467 } 6468 } 6469 6470 ctx = calloc(1, sizeof(*ctx)); 6471 if (ctx == NULL) { 6472 cb_fn(cb_arg, -ENOMEM); 6473 return; 6474 } 6475 6476 ctx->cb_fn = cb_fn; 6477 ctx->cb_arg = cb_arg; 6478 ctx->bdev = bdev; 6479 6480 pthread_mutex_lock(&bdev->internal.mutex); 6481 if (bdev->internal.qos_mod_in_progress) { 6482 pthread_mutex_unlock(&bdev->internal.mutex); 6483 free(ctx); 6484 cb_fn(cb_arg, -EAGAIN); 6485 return; 6486 } 6487 bdev->internal.qos_mod_in_progress = true; 6488 6489 if (disable_rate_limit == true && bdev->internal.qos) { 6490 for (i = 0; i < SPDK_BDEV_QOS_NUM_RATE_LIMIT_TYPES; i++) { 6491 if (limits[i] == SPDK_BDEV_QOS_LIMIT_NOT_DEFINED && 6492 (bdev->internal.qos->rate_limits[i].limit > 0 && 6493 bdev->internal.qos->rate_limits[i].limit != 6494 SPDK_BDEV_QOS_LIMIT_NOT_DEFINED)) { 6495 disable_rate_limit = false; 6496 break; 6497 } 6498 } 6499 } 6500 6501 if (disable_rate_limit == false) { 6502 if (bdev->internal.qos == NULL) { 6503 bdev->internal.qos = calloc(1, sizeof(*bdev->internal.qos)); 6504 if (!bdev->internal.qos) { 6505 pthread_mutex_unlock(&bdev->internal.mutex); 6506 SPDK_ERRLOG("Unable to allocate memory for QoS tracking\n"); 6507 bdev_set_qos_limit_done(ctx, -ENOMEM); 6508 return; 6509 } 6510 } 6511 6512 if (bdev->internal.qos->thread == NULL) { 6513 /* Enabling */ 6514 bdev_set_qos_rate_limits(bdev, limits); 6515 6516 spdk_for_each_channel(__bdev_to_io_dev(bdev), 6517 bdev_enable_qos_msg, ctx, 6518 bdev_enable_qos_done); 6519 } else { 6520 /* Updating */ 6521 bdev_set_qos_rate_limits(bdev, limits); 6522 6523 spdk_thread_send_msg(bdev->internal.qos->thread, 6524 bdev_update_qos_rate_limit_msg, ctx); 6525 } 6526 } else { 6527 if (bdev->internal.qos != NULL) { 6528 bdev_set_qos_rate_limits(bdev, limits); 6529 6530 /* Disabling */ 6531 spdk_for_each_channel(__bdev_to_io_dev(bdev), 6532 bdev_disable_qos_msg, ctx, 6533 bdev_disable_qos_msg_done); 6534 } else { 6535 pthread_mutex_unlock(&bdev->internal.mutex); 6536 bdev_set_qos_limit_done(ctx, 0); 6537 return; 6538 } 6539 } 6540 6541 pthread_mutex_unlock(&bdev->internal.mutex); 6542 } 6543 6544 struct spdk_bdev_histogram_ctx { 6545 spdk_bdev_histogram_status_cb cb_fn; 6546 void *cb_arg; 6547 struct spdk_bdev *bdev; 6548 int status; 6549 }; 6550 6551 static void 6552 bdev_histogram_disable_channel_cb(struct spdk_io_channel_iter *i, int status) 6553 { 6554 struct spdk_bdev_histogram_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 6555 6556 pthread_mutex_lock(&ctx->bdev->internal.mutex); 6557 ctx->bdev->internal.histogram_in_progress = false; 6558 pthread_mutex_unlock(&ctx->bdev->internal.mutex); 6559 ctx->cb_fn(ctx->cb_arg, ctx->status); 6560 free(ctx); 6561 } 6562 6563 static void 6564 bdev_histogram_disable_channel(struct spdk_io_channel_iter *i) 6565 { 6566 struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i); 6567 struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch); 6568 6569 if (ch->histogram != NULL) { 6570 spdk_histogram_data_free(ch->histogram); 6571 ch->histogram = NULL; 6572 } 6573 spdk_for_each_channel_continue(i, 0); 6574 } 6575 6576 static void 6577 bdev_histogram_enable_channel_cb(struct spdk_io_channel_iter *i, int status) 6578 { 6579 struct spdk_bdev_histogram_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 6580 6581 if (status != 0) { 6582 ctx->status = status; 6583 ctx->bdev->internal.histogram_enabled = false; 6584 spdk_for_each_channel(__bdev_to_io_dev(ctx->bdev), bdev_histogram_disable_channel, ctx, 6585 bdev_histogram_disable_channel_cb); 6586 } else { 6587 pthread_mutex_lock(&ctx->bdev->internal.mutex); 6588 ctx->bdev->internal.histogram_in_progress = false; 6589 pthread_mutex_unlock(&ctx->bdev->internal.mutex); 6590 ctx->cb_fn(ctx->cb_arg, ctx->status); 6591 free(ctx); 6592 } 6593 } 6594 6595 static void 6596 bdev_histogram_enable_channel(struct spdk_io_channel_iter *i) 6597 { 6598 struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i); 6599 struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch); 6600 int status = 0; 6601 6602 if (ch->histogram == NULL) { 6603 ch->histogram = spdk_histogram_data_alloc(); 6604 if (ch->histogram == NULL) { 6605 status = -ENOMEM; 6606 } 6607 } 6608 6609 spdk_for_each_channel_continue(i, status); 6610 } 6611 6612 void 6613 spdk_bdev_histogram_enable(struct spdk_bdev *bdev, spdk_bdev_histogram_status_cb cb_fn, 6614 void *cb_arg, bool enable) 6615 { 6616 struct spdk_bdev_histogram_ctx *ctx; 6617 6618 ctx = calloc(1, sizeof(struct spdk_bdev_histogram_ctx)); 6619 if (ctx == NULL) { 6620 cb_fn(cb_arg, -ENOMEM); 6621 return; 6622 } 6623 6624 ctx->bdev = bdev; 6625 ctx->status = 0; 6626 ctx->cb_fn = cb_fn; 6627 ctx->cb_arg = cb_arg; 6628 6629 pthread_mutex_lock(&bdev->internal.mutex); 6630 if (bdev->internal.histogram_in_progress) { 6631 pthread_mutex_unlock(&bdev->internal.mutex); 6632 free(ctx); 6633 cb_fn(cb_arg, -EAGAIN); 6634 return; 6635 } 6636 6637 bdev->internal.histogram_in_progress = true; 6638 pthread_mutex_unlock(&bdev->internal.mutex); 6639 6640 bdev->internal.histogram_enabled = enable; 6641 6642 if (enable) { 6643 /* Allocate histogram for each channel */ 6644 spdk_for_each_channel(__bdev_to_io_dev(bdev), bdev_histogram_enable_channel, ctx, 6645 bdev_histogram_enable_channel_cb); 6646 } else { 6647 spdk_for_each_channel(__bdev_to_io_dev(bdev), bdev_histogram_disable_channel, ctx, 6648 bdev_histogram_disable_channel_cb); 6649 } 6650 } 6651 6652 struct spdk_bdev_histogram_data_ctx { 6653 spdk_bdev_histogram_data_cb cb_fn; 6654 void *cb_arg; 6655 struct spdk_bdev *bdev; 6656 /** merged histogram data from all channels */ 6657 struct spdk_histogram_data *histogram; 6658 }; 6659 6660 static void 6661 bdev_histogram_get_channel_cb(struct spdk_io_channel_iter *i, int status) 6662 { 6663 struct spdk_bdev_histogram_data_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 6664 6665 ctx->cb_fn(ctx->cb_arg, status, ctx->histogram); 6666 free(ctx); 6667 } 6668 6669 static void 6670 bdev_histogram_get_channel(struct spdk_io_channel_iter *i) 6671 { 6672 struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i); 6673 struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch); 6674 struct spdk_bdev_histogram_data_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 6675 int status = 0; 6676 6677 if (ch->histogram == NULL) { 6678 status = -EFAULT; 6679 } else { 6680 spdk_histogram_data_merge(ctx->histogram, ch->histogram); 6681 } 6682 6683 spdk_for_each_channel_continue(i, status); 6684 } 6685 6686 void 6687 spdk_bdev_histogram_get(struct spdk_bdev *bdev, struct spdk_histogram_data *histogram, 6688 spdk_bdev_histogram_data_cb cb_fn, 6689 void *cb_arg) 6690 { 6691 struct spdk_bdev_histogram_data_ctx *ctx; 6692 6693 ctx = calloc(1, sizeof(struct spdk_bdev_histogram_data_ctx)); 6694 if (ctx == NULL) { 6695 cb_fn(cb_arg, -ENOMEM, NULL); 6696 return; 6697 } 6698 6699 ctx->bdev = bdev; 6700 ctx->cb_fn = cb_fn; 6701 ctx->cb_arg = cb_arg; 6702 6703 ctx->histogram = histogram; 6704 6705 spdk_for_each_channel(__bdev_to_io_dev(bdev), bdev_histogram_get_channel, ctx, 6706 bdev_histogram_get_channel_cb); 6707 } 6708 6709 size_t 6710 spdk_bdev_get_media_events(struct spdk_bdev_desc *desc, struct spdk_bdev_media_event *events, 6711 size_t max_events) 6712 { 6713 struct media_event_entry *entry; 6714 size_t num_events = 0; 6715 6716 for (; num_events < max_events; ++num_events) { 6717 entry = TAILQ_FIRST(&desc->pending_media_events); 6718 if (entry == NULL) { 6719 break; 6720 } 6721 6722 events[num_events] = entry->event; 6723 TAILQ_REMOVE(&desc->pending_media_events, entry, tailq); 6724 TAILQ_INSERT_TAIL(&desc->free_media_events, entry, tailq); 6725 } 6726 6727 return num_events; 6728 } 6729 6730 int 6731 spdk_bdev_push_media_events(struct spdk_bdev *bdev, const struct spdk_bdev_media_event *events, 6732 size_t num_events) 6733 { 6734 struct spdk_bdev_desc *desc; 6735 struct media_event_entry *entry; 6736 size_t event_id; 6737 int rc = 0; 6738 6739 assert(bdev->media_events); 6740 6741 pthread_mutex_lock(&bdev->internal.mutex); 6742 TAILQ_FOREACH(desc, &bdev->internal.open_descs, link) { 6743 if (desc->write) { 6744 break; 6745 } 6746 } 6747 6748 if (desc == NULL || desc->media_events_buffer == NULL) { 6749 rc = -ENODEV; 6750 goto out; 6751 } 6752 6753 for (event_id = 0; event_id < num_events; ++event_id) { 6754 entry = TAILQ_FIRST(&desc->free_media_events); 6755 if (entry == NULL) { 6756 break; 6757 } 6758 6759 TAILQ_REMOVE(&desc->free_media_events, entry, tailq); 6760 TAILQ_INSERT_TAIL(&desc->pending_media_events, entry, tailq); 6761 entry->event = events[event_id]; 6762 } 6763 6764 rc = event_id; 6765 out: 6766 pthread_mutex_unlock(&bdev->internal.mutex); 6767 return rc; 6768 } 6769 6770 void 6771 spdk_bdev_notify_media_management(struct spdk_bdev *bdev) 6772 { 6773 struct spdk_bdev_desc *desc; 6774 6775 pthread_mutex_lock(&bdev->internal.mutex); 6776 TAILQ_FOREACH(desc, &bdev->internal.open_descs, link) { 6777 if (!TAILQ_EMPTY(&desc->pending_media_events)) { 6778 desc->callback.event_fn(SPDK_BDEV_EVENT_MEDIA_MANAGEMENT, bdev, 6779 desc->callback.ctx); 6780 } 6781 } 6782 pthread_mutex_unlock(&bdev->internal.mutex); 6783 } 6784 6785 struct locked_lba_range_ctx { 6786 struct lba_range range; 6787 struct spdk_bdev *bdev; 6788 struct lba_range *current_range; 6789 struct lba_range *owner_range; 6790 struct spdk_poller *poller; 6791 lock_range_cb cb_fn; 6792 void *cb_arg; 6793 }; 6794 6795 static void 6796 bdev_lock_error_cleanup_cb(struct spdk_io_channel_iter *i, int status) 6797 { 6798 struct locked_lba_range_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 6799 6800 ctx->cb_fn(ctx->cb_arg, -ENOMEM); 6801 free(ctx); 6802 } 6803 6804 static void 6805 bdev_unlock_lba_range_get_channel(struct spdk_io_channel_iter *i); 6806 6807 static void 6808 bdev_lock_lba_range_cb(struct spdk_io_channel_iter *i, int status) 6809 { 6810 struct locked_lba_range_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 6811 struct spdk_bdev *bdev = ctx->bdev; 6812 6813 if (status == -ENOMEM) { 6814 /* One of the channels could not allocate a range object. 6815 * So we have to go back and clean up any ranges that were 6816 * allocated successfully before we return error status to 6817 * the caller. We can reuse the unlock function to do that 6818 * clean up. 6819 */ 6820 spdk_for_each_channel(__bdev_to_io_dev(bdev), 6821 bdev_unlock_lba_range_get_channel, ctx, 6822 bdev_lock_error_cleanup_cb); 6823 return; 6824 } 6825 6826 /* All channels have locked this range and no I/O overlapping the range 6827 * are outstanding! Set the owner_ch for the range object for the 6828 * locking channel, so that this channel will know that it is allowed 6829 * to write to this range. 6830 */ 6831 ctx->owner_range->owner_ch = ctx->range.owner_ch; 6832 ctx->cb_fn(ctx->cb_arg, status); 6833 6834 /* Don't free the ctx here. Its range is in the bdev's global list of 6835 * locked ranges still, and will be removed and freed when this range 6836 * is later unlocked. 6837 */ 6838 } 6839 6840 static int 6841 bdev_lock_lba_range_check_io(void *_i) 6842 { 6843 struct spdk_io_channel_iter *i = _i; 6844 struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i); 6845 struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch); 6846 struct locked_lba_range_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 6847 struct lba_range *range = ctx->current_range; 6848 struct spdk_bdev_io *bdev_io; 6849 6850 spdk_poller_unregister(&ctx->poller); 6851 6852 /* The range is now in the locked_ranges, so no new IO can be submitted to this 6853 * range. But we need to wait until any outstanding IO overlapping with this range 6854 * are completed. 6855 */ 6856 TAILQ_FOREACH(bdev_io, &ch->io_submitted, internal.ch_link) { 6857 if (bdev_io_range_is_locked(bdev_io, range)) { 6858 ctx->poller = SPDK_POLLER_REGISTER(bdev_lock_lba_range_check_io, i, 100); 6859 return SPDK_POLLER_BUSY; 6860 } 6861 } 6862 6863 spdk_for_each_channel_continue(i, 0); 6864 return SPDK_POLLER_BUSY; 6865 } 6866 6867 static void 6868 bdev_lock_lba_range_get_channel(struct spdk_io_channel_iter *i) 6869 { 6870 struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i); 6871 struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch); 6872 struct locked_lba_range_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 6873 struct lba_range *range; 6874 6875 TAILQ_FOREACH(range, &ch->locked_ranges, tailq) { 6876 if (range->length == ctx->range.length && 6877 range->offset == ctx->range.offset && 6878 range->locked_ctx == ctx->range.locked_ctx) { 6879 /* This range already exists on this channel, so don't add 6880 * it again. This can happen when a new channel is created 6881 * while the for_each_channel operation is in progress. 6882 * Do not check for outstanding I/O in that case, since the 6883 * range was locked before any I/O could be submitted to the 6884 * new channel. 6885 */ 6886 spdk_for_each_channel_continue(i, 0); 6887 return; 6888 } 6889 } 6890 6891 range = calloc(1, sizeof(*range)); 6892 if (range == NULL) { 6893 spdk_for_each_channel_continue(i, -ENOMEM); 6894 return; 6895 } 6896 6897 range->length = ctx->range.length; 6898 range->offset = ctx->range.offset; 6899 range->locked_ctx = ctx->range.locked_ctx; 6900 ctx->current_range = range; 6901 if (ctx->range.owner_ch == ch) { 6902 /* This is the range object for the channel that will hold 6903 * the lock. Store it in the ctx object so that we can easily 6904 * set its owner_ch after the lock is finally acquired. 6905 */ 6906 ctx->owner_range = range; 6907 } 6908 TAILQ_INSERT_TAIL(&ch->locked_ranges, range, tailq); 6909 bdev_lock_lba_range_check_io(i); 6910 } 6911 6912 static void 6913 bdev_lock_lba_range_ctx(struct spdk_bdev *bdev, struct locked_lba_range_ctx *ctx) 6914 { 6915 assert(spdk_get_thread() == spdk_io_channel_get_thread(ctx->range.owner_ch->channel)); 6916 6917 /* We will add a copy of this range to each channel now. */ 6918 spdk_for_each_channel(__bdev_to_io_dev(bdev), bdev_lock_lba_range_get_channel, ctx, 6919 bdev_lock_lba_range_cb); 6920 } 6921 6922 static bool 6923 bdev_lba_range_overlaps_tailq(struct lba_range *range, lba_range_tailq_t *tailq) 6924 { 6925 struct lba_range *r; 6926 6927 TAILQ_FOREACH(r, tailq, tailq) { 6928 if (bdev_lba_range_overlapped(range, r)) { 6929 return true; 6930 } 6931 } 6932 return false; 6933 } 6934 6935 static int 6936 bdev_lock_lba_range(struct spdk_bdev_desc *desc, struct spdk_io_channel *_ch, 6937 uint64_t offset, uint64_t length, 6938 lock_range_cb cb_fn, void *cb_arg) 6939 { 6940 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 6941 struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch); 6942 struct locked_lba_range_ctx *ctx; 6943 6944 if (cb_arg == NULL) { 6945 SPDK_ERRLOG("cb_arg must not be NULL\n"); 6946 return -EINVAL; 6947 } 6948 6949 ctx = calloc(1, sizeof(*ctx)); 6950 if (ctx == NULL) { 6951 return -ENOMEM; 6952 } 6953 6954 ctx->range.offset = offset; 6955 ctx->range.length = length; 6956 ctx->range.owner_ch = ch; 6957 ctx->range.locked_ctx = cb_arg; 6958 ctx->bdev = bdev; 6959 ctx->cb_fn = cb_fn; 6960 ctx->cb_arg = cb_arg; 6961 6962 pthread_mutex_lock(&bdev->internal.mutex); 6963 if (bdev_lba_range_overlaps_tailq(&ctx->range, &bdev->internal.locked_ranges)) { 6964 /* There is an active lock overlapping with this range. 6965 * Put it on the pending list until this range no 6966 * longer overlaps with another. 6967 */ 6968 TAILQ_INSERT_TAIL(&bdev->internal.pending_locked_ranges, &ctx->range, tailq); 6969 } else { 6970 TAILQ_INSERT_TAIL(&bdev->internal.locked_ranges, &ctx->range, tailq); 6971 bdev_lock_lba_range_ctx(bdev, ctx); 6972 } 6973 pthread_mutex_unlock(&bdev->internal.mutex); 6974 return 0; 6975 } 6976 6977 static void 6978 bdev_lock_lba_range_ctx_msg(void *_ctx) 6979 { 6980 struct locked_lba_range_ctx *ctx = _ctx; 6981 6982 bdev_lock_lba_range_ctx(ctx->bdev, ctx); 6983 } 6984 6985 static void 6986 bdev_unlock_lba_range_cb(struct spdk_io_channel_iter *i, int status) 6987 { 6988 struct locked_lba_range_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 6989 struct locked_lba_range_ctx *pending_ctx; 6990 struct spdk_bdev_channel *ch = ctx->range.owner_ch; 6991 struct spdk_bdev *bdev = ch->bdev; 6992 struct lba_range *range, *tmp; 6993 6994 pthread_mutex_lock(&bdev->internal.mutex); 6995 /* Check if there are any pending locked ranges that overlap with this range 6996 * that was just unlocked. If there are, check that it doesn't overlap with any 6997 * other locked ranges before calling bdev_lock_lba_range_ctx which will start 6998 * the lock process. 6999 */ 7000 TAILQ_FOREACH_SAFE(range, &bdev->internal.pending_locked_ranges, tailq, tmp) { 7001 if (bdev_lba_range_overlapped(range, &ctx->range) && 7002 !bdev_lba_range_overlaps_tailq(range, &bdev->internal.locked_ranges)) { 7003 TAILQ_REMOVE(&bdev->internal.pending_locked_ranges, range, tailq); 7004 pending_ctx = SPDK_CONTAINEROF(range, struct locked_lba_range_ctx, range); 7005 TAILQ_INSERT_TAIL(&bdev->internal.locked_ranges, range, tailq); 7006 spdk_thread_send_msg(spdk_io_channel_get_thread(pending_ctx->range.owner_ch->channel), 7007 bdev_lock_lba_range_ctx_msg, pending_ctx); 7008 } 7009 } 7010 pthread_mutex_unlock(&bdev->internal.mutex); 7011 7012 ctx->cb_fn(ctx->cb_arg, status); 7013 free(ctx); 7014 } 7015 7016 static void 7017 bdev_unlock_lba_range_get_channel(struct spdk_io_channel_iter *i) 7018 { 7019 struct spdk_io_channel *_ch = spdk_io_channel_iter_get_channel(i); 7020 struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch); 7021 struct locked_lba_range_ctx *ctx = spdk_io_channel_iter_get_ctx(i); 7022 TAILQ_HEAD(, spdk_bdev_io) io_locked; 7023 struct spdk_bdev_io *bdev_io; 7024 struct lba_range *range; 7025 7026 TAILQ_FOREACH(range, &ch->locked_ranges, tailq) { 7027 if (ctx->range.offset == range->offset && 7028 ctx->range.length == range->length && 7029 ctx->range.locked_ctx == range->locked_ctx) { 7030 TAILQ_REMOVE(&ch->locked_ranges, range, tailq); 7031 free(range); 7032 break; 7033 } 7034 } 7035 7036 /* Note: we should almost always be able to assert that the range specified 7037 * was found. But there are some very rare corner cases where a new channel 7038 * gets created simultaneously with a range unlock, where this function 7039 * would execute on that new channel and wouldn't have the range. 7040 * We also use this to clean up range allocations when a later allocation 7041 * fails in the locking path. 7042 * So we can't actually assert() here. 7043 */ 7044 7045 /* Swap the locked IO into a temporary list, and then try to submit them again. 7046 * We could hyper-optimize this to only resubmit locked I/O that overlap 7047 * with the range that was just unlocked, but this isn't a performance path so 7048 * we go for simplicity here. 7049 */ 7050 TAILQ_INIT(&io_locked); 7051 TAILQ_SWAP(&ch->io_locked, &io_locked, spdk_bdev_io, internal.ch_link); 7052 while (!TAILQ_EMPTY(&io_locked)) { 7053 bdev_io = TAILQ_FIRST(&io_locked); 7054 TAILQ_REMOVE(&io_locked, bdev_io, internal.ch_link); 7055 bdev_io_submit(bdev_io); 7056 } 7057 7058 spdk_for_each_channel_continue(i, 0); 7059 } 7060 7061 static int 7062 bdev_unlock_lba_range(struct spdk_bdev_desc *desc, struct spdk_io_channel *_ch, 7063 uint64_t offset, uint64_t length, 7064 lock_range_cb cb_fn, void *cb_arg) 7065 { 7066 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(desc); 7067 struct spdk_bdev_channel *ch = spdk_io_channel_get_ctx(_ch); 7068 struct locked_lba_range_ctx *ctx; 7069 struct lba_range *range; 7070 bool range_found = false; 7071 7072 /* Let's make sure the specified channel actually has a lock on 7073 * the specified range. Note that the range must match exactly. 7074 */ 7075 TAILQ_FOREACH(range, &ch->locked_ranges, tailq) { 7076 if (range->offset == offset && range->length == length && 7077 range->owner_ch == ch && range->locked_ctx == cb_arg) { 7078 range_found = true; 7079 break; 7080 } 7081 } 7082 7083 if (!range_found) { 7084 return -EINVAL; 7085 } 7086 7087 pthread_mutex_lock(&bdev->internal.mutex); 7088 /* We confirmed that this channel has locked the specified range. To 7089 * start the unlock the process, we find the range in the bdev's locked_ranges 7090 * and remove it. This ensures new channels don't inherit the locked range. 7091 * Then we will send a message to each channel (including the one specified 7092 * here) to remove the range from its per-channel list. 7093 */ 7094 TAILQ_FOREACH(range, &bdev->internal.locked_ranges, tailq) { 7095 if (range->offset == offset && range->length == length && 7096 range->locked_ctx == cb_arg) { 7097 break; 7098 } 7099 } 7100 if (range == NULL) { 7101 assert(false); 7102 pthread_mutex_unlock(&bdev->internal.mutex); 7103 return -EINVAL; 7104 } 7105 TAILQ_REMOVE(&bdev->internal.locked_ranges, range, tailq); 7106 ctx = SPDK_CONTAINEROF(range, struct locked_lba_range_ctx, range); 7107 pthread_mutex_unlock(&bdev->internal.mutex); 7108 7109 ctx->cb_fn = cb_fn; 7110 ctx->cb_arg = cb_arg; 7111 7112 spdk_for_each_channel(__bdev_to_io_dev(bdev), bdev_unlock_lba_range_get_channel, ctx, 7113 bdev_unlock_lba_range_cb); 7114 return 0; 7115 } 7116 7117 int 7118 spdk_bdev_get_memory_domains(struct spdk_bdev *bdev, struct spdk_memory_domain **domains, 7119 int array_size) 7120 { 7121 if (!bdev) { 7122 return -EINVAL; 7123 } 7124 7125 if (bdev->fn_table->get_memory_domains) { 7126 return bdev->fn_table->get_memory_domains(bdev->ctxt, domains, array_size); 7127 } 7128 7129 return 0; 7130 } 7131 7132 SPDK_LOG_REGISTER_COMPONENT(bdev) 7133 7134 SPDK_TRACE_REGISTER_FN(bdev_trace, "bdev", TRACE_GROUP_BDEV) 7135 { 7136 spdk_trace_register_owner(OWNER_BDEV, 'b'); 7137 spdk_trace_register_object(OBJECT_BDEV_IO, 'i'); 7138 spdk_trace_register_description("BDEV_IO_START", TRACE_BDEV_IO_START, OWNER_BDEV, 7139 OBJECT_BDEV_IO, 1, 7140 SPDK_TRACE_ARG_TYPE_INT, "type"); 7141 spdk_trace_register_description("BDEV_IO_DONE", TRACE_BDEV_IO_DONE, OWNER_BDEV, 7142 OBJECT_BDEV_IO, 0, 7143 SPDK_TRACE_ARG_TYPE_INT, ""); 7144 } 7145