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