1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * NVM Express device driver 4 * Copyright (c) 2011-2014, Intel Corporation. 5 */ 6 7 #include <linux/blkdev.h> 8 #include <linux/blk-mq.h> 9 #include <linux/compat.h> 10 #include <linux/delay.h> 11 #include <linux/errno.h> 12 #include <linux/hdreg.h> 13 #include <linux/kernel.h> 14 #include <linux/module.h> 15 #include <linux/backing-dev.h> 16 #include <linux/list_sort.h> 17 #include <linux/slab.h> 18 #include <linux/types.h> 19 #include <linux/pr.h> 20 #include <linux/ptrace.h> 21 #include <linux/nvme_ioctl.h> 22 #include <linux/pm_qos.h> 23 #include <asm/unaligned.h> 24 25 #include "nvme.h" 26 #include "fabrics.h" 27 28 #define CREATE_TRACE_POINTS 29 #include "trace.h" 30 31 #define NVME_MINORS (1U << MINORBITS) 32 33 unsigned int admin_timeout = 60; 34 module_param(admin_timeout, uint, 0644); 35 MODULE_PARM_DESC(admin_timeout, "timeout in seconds for admin commands"); 36 EXPORT_SYMBOL_GPL(admin_timeout); 37 38 unsigned int nvme_io_timeout = 30; 39 module_param_named(io_timeout, nvme_io_timeout, uint, 0644); 40 MODULE_PARM_DESC(io_timeout, "timeout in seconds for I/O"); 41 EXPORT_SYMBOL_GPL(nvme_io_timeout); 42 43 static unsigned char shutdown_timeout = 5; 44 module_param(shutdown_timeout, byte, 0644); 45 MODULE_PARM_DESC(shutdown_timeout, "timeout in seconds for controller shutdown"); 46 47 static u8 nvme_max_retries = 5; 48 module_param_named(max_retries, nvme_max_retries, byte, 0644); 49 MODULE_PARM_DESC(max_retries, "max number of retries a command may have"); 50 51 static unsigned long default_ps_max_latency_us = 100000; 52 module_param(default_ps_max_latency_us, ulong, 0644); 53 MODULE_PARM_DESC(default_ps_max_latency_us, 54 "max power saving latency for new devices; use PM QOS to change per device"); 55 56 static bool force_apst; 57 module_param(force_apst, bool, 0644); 58 MODULE_PARM_DESC(force_apst, "allow APST for newly enumerated devices even if quirked off"); 59 60 static bool streams; 61 module_param(streams, bool, 0644); 62 MODULE_PARM_DESC(streams, "turn on support for Streams write directives"); 63 64 /* 65 * nvme_wq - hosts nvme related works that are not reset or delete 66 * nvme_reset_wq - hosts nvme reset works 67 * nvme_delete_wq - hosts nvme delete works 68 * 69 * nvme_wq will host works such as scan, aen handling, fw activation, 70 * keep-alive, periodic reconnects etc. nvme_reset_wq 71 * runs reset works which also flush works hosted on nvme_wq for 72 * serialization purposes. nvme_delete_wq host controller deletion 73 * works which flush reset works for serialization. 74 */ 75 struct workqueue_struct *nvme_wq; 76 EXPORT_SYMBOL_GPL(nvme_wq); 77 78 struct workqueue_struct *nvme_reset_wq; 79 EXPORT_SYMBOL_GPL(nvme_reset_wq); 80 81 struct workqueue_struct *nvme_delete_wq; 82 EXPORT_SYMBOL_GPL(nvme_delete_wq); 83 84 static LIST_HEAD(nvme_subsystems); 85 static DEFINE_MUTEX(nvme_subsystems_lock); 86 87 static DEFINE_IDA(nvme_instance_ida); 88 static dev_t nvme_chr_devt; 89 static struct class *nvme_class; 90 static struct class *nvme_subsys_class; 91 92 static int nvme_revalidate_disk(struct gendisk *disk); 93 static void nvme_put_subsystem(struct nvme_subsystem *subsys); 94 static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl, 95 unsigned nsid); 96 97 static void nvme_set_queue_dying(struct nvme_ns *ns) 98 { 99 /* 100 * Revalidating a dead namespace sets capacity to 0. This will end 101 * buffered writers dirtying pages that can't be synced. 102 */ 103 if (!ns->disk || test_and_set_bit(NVME_NS_DEAD, &ns->flags)) 104 return; 105 blk_set_queue_dying(ns->queue); 106 /* Forcibly unquiesce queues to avoid blocking dispatch */ 107 blk_mq_unquiesce_queue(ns->queue); 108 /* 109 * Revalidate after unblocking dispatchers that may be holding bd_butex 110 */ 111 revalidate_disk(ns->disk); 112 } 113 114 static void nvme_queue_scan(struct nvme_ctrl *ctrl) 115 { 116 /* 117 * Only new queue scan work when admin and IO queues are both alive 118 */ 119 if (ctrl->state == NVME_CTRL_LIVE && ctrl->tagset) 120 queue_work(nvme_wq, &ctrl->scan_work); 121 } 122 123 /* 124 * Use this function to proceed with scheduling reset_work for a controller 125 * that had previously been set to the resetting state. This is intended for 126 * code paths that can't be interrupted by other reset attempts. A hot removal 127 * may prevent this from succeeding. 128 */ 129 int nvme_try_sched_reset(struct nvme_ctrl *ctrl) 130 { 131 if (ctrl->state != NVME_CTRL_RESETTING) 132 return -EBUSY; 133 if (!queue_work(nvme_reset_wq, &ctrl->reset_work)) 134 return -EBUSY; 135 return 0; 136 } 137 EXPORT_SYMBOL_GPL(nvme_try_sched_reset); 138 139 int nvme_reset_ctrl(struct nvme_ctrl *ctrl) 140 { 141 if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING)) 142 return -EBUSY; 143 if (!queue_work(nvme_reset_wq, &ctrl->reset_work)) 144 return -EBUSY; 145 return 0; 146 } 147 EXPORT_SYMBOL_GPL(nvme_reset_ctrl); 148 149 int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl) 150 { 151 int ret; 152 153 ret = nvme_reset_ctrl(ctrl); 154 if (!ret) { 155 flush_work(&ctrl->reset_work); 156 if (ctrl->state != NVME_CTRL_LIVE) 157 ret = -ENETRESET; 158 } 159 160 return ret; 161 } 162 EXPORT_SYMBOL_GPL(nvme_reset_ctrl_sync); 163 164 static void nvme_do_delete_ctrl(struct nvme_ctrl *ctrl) 165 { 166 dev_info(ctrl->device, 167 "Removing ctrl: NQN \"%s\"\n", ctrl->opts->subsysnqn); 168 169 flush_work(&ctrl->reset_work); 170 nvme_stop_ctrl(ctrl); 171 nvme_remove_namespaces(ctrl); 172 ctrl->ops->delete_ctrl(ctrl); 173 nvme_uninit_ctrl(ctrl); 174 } 175 176 static void nvme_delete_ctrl_work(struct work_struct *work) 177 { 178 struct nvme_ctrl *ctrl = 179 container_of(work, struct nvme_ctrl, delete_work); 180 181 nvme_do_delete_ctrl(ctrl); 182 } 183 184 int nvme_delete_ctrl(struct nvme_ctrl *ctrl) 185 { 186 if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING)) 187 return -EBUSY; 188 if (!queue_work(nvme_delete_wq, &ctrl->delete_work)) 189 return -EBUSY; 190 return 0; 191 } 192 EXPORT_SYMBOL_GPL(nvme_delete_ctrl); 193 194 static void nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl) 195 { 196 /* 197 * Keep a reference until nvme_do_delete_ctrl() complete, 198 * since ->delete_ctrl can free the controller. 199 */ 200 nvme_get_ctrl(ctrl); 201 if (nvme_change_ctrl_state(ctrl, NVME_CTRL_DELETING)) 202 nvme_do_delete_ctrl(ctrl); 203 nvme_put_ctrl(ctrl); 204 } 205 206 static blk_status_t nvme_error_status(u16 status) 207 { 208 switch (status & 0x7ff) { 209 case NVME_SC_SUCCESS: 210 return BLK_STS_OK; 211 case NVME_SC_CAP_EXCEEDED: 212 return BLK_STS_NOSPC; 213 case NVME_SC_LBA_RANGE: 214 case NVME_SC_CMD_INTERRUPTED: 215 case NVME_SC_NS_NOT_READY: 216 return BLK_STS_TARGET; 217 case NVME_SC_BAD_ATTRIBUTES: 218 case NVME_SC_ONCS_NOT_SUPPORTED: 219 case NVME_SC_INVALID_OPCODE: 220 case NVME_SC_INVALID_FIELD: 221 case NVME_SC_INVALID_NS: 222 return BLK_STS_NOTSUPP; 223 case NVME_SC_WRITE_FAULT: 224 case NVME_SC_READ_ERROR: 225 case NVME_SC_UNWRITTEN_BLOCK: 226 case NVME_SC_ACCESS_DENIED: 227 case NVME_SC_READ_ONLY: 228 case NVME_SC_COMPARE_FAILED: 229 return BLK_STS_MEDIUM; 230 case NVME_SC_GUARD_CHECK: 231 case NVME_SC_APPTAG_CHECK: 232 case NVME_SC_REFTAG_CHECK: 233 case NVME_SC_INVALID_PI: 234 return BLK_STS_PROTECTION; 235 case NVME_SC_RESERVATION_CONFLICT: 236 return BLK_STS_NEXUS; 237 case NVME_SC_HOST_PATH_ERROR: 238 return BLK_STS_TRANSPORT; 239 default: 240 return BLK_STS_IOERR; 241 } 242 } 243 244 static inline bool nvme_req_needs_retry(struct request *req) 245 { 246 if (blk_noretry_request(req)) 247 return false; 248 if (nvme_req(req)->status & NVME_SC_DNR) 249 return false; 250 if (nvme_req(req)->retries >= nvme_max_retries) 251 return false; 252 return true; 253 } 254 255 static void nvme_retry_req(struct request *req) 256 { 257 struct nvme_ns *ns = req->q->queuedata; 258 unsigned long delay = 0; 259 u16 crd; 260 261 /* The mask and shift result must be <= 3 */ 262 crd = (nvme_req(req)->status & NVME_SC_CRD) >> 11; 263 if (ns && crd) 264 delay = ns->ctrl->crdt[crd - 1] * 100; 265 266 nvme_req(req)->retries++; 267 blk_mq_requeue_request(req, false); 268 blk_mq_delay_kick_requeue_list(req->q, delay); 269 } 270 271 void nvme_complete_rq(struct request *req) 272 { 273 blk_status_t status = nvme_error_status(nvme_req(req)->status); 274 275 trace_nvme_complete_rq(req); 276 277 nvme_cleanup_cmd(req); 278 279 if (nvme_req(req)->ctrl->kas) 280 nvme_req(req)->ctrl->comp_seen = true; 281 282 if (unlikely(status != BLK_STS_OK && nvme_req_needs_retry(req))) { 283 if ((req->cmd_flags & REQ_NVME_MPATH) && nvme_failover_req(req)) 284 return; 285 286 if (!blk_queue_dying(req->q)) { 287 nvme_retry_req(req); 288 return; 289 } 290 } 291 292 nvme_trace_bio_complete(req, status); 293 blk_mq_end_request(req, status); 294 } 295 EXPORT_SYMBOL_GPL(nvme_complete_rq); 296 297 bool nvme_cancel_request(struct request *req, void *data, bool reserved) 298 { 299 dev_dbg_ratelimited(((struct nvme_ctrl *) data)->device, 300 "Cancelling I/O %d", req->tag); 301 302 /* don't abort one completed request */ 303 if (blk_mq_request_completed(req)) 304 return true; 305 306 nvme_req(req)->status = NVME_SC_HOST_ABORTED_CMD; 307 blk_mq_complete_request(req); 308 return true; 309 } 310 EXPORT_SYMBOL_GPL(nvme_cancel_request); 311 312 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl, 313 enum nvme_ctrl_state new_state) 314 { 315 enum nvme_ctrl_state old_state; 316 unsigned long flags; 317 bool changed = false; 318 319 spin_lock_irqsave(&ctrl->lock, flags); 320 321 old_state = ctrl->state; 322 switch (new_state) { 323 case NVME_CTRL_LIVE: 324 switch (old_state) { 325 case NVME_CTRL_NEW: 326 case NVME_CTRL_RESETTING: 327 case NVME_CTRL_CONNECTING: 328 changed = true; 329 /* FALLTHRU */ 330 default: 331 break; 332 } 333 break; 334 case NVME_CTRL_RESETTING: 335 switch (old_state) { 336 case NVME_CTRL_NEW: 337 case NVME_CTRL_LIVE: 338 changed = true; 339 /* FALLTHRU */ 340 default: 341 break; 342 } 343 break; 344 case NVME_CTRL_CONNECTING: 345 switch (old_state) { 346 case NVME_CTRL_NEW: 347 case NVME_CTRL_RESETTING: 348 changed = true; 349 /* FALLTHRU */ 350 default: 351 break; 352 } 353 break; 354 case NVME_CTRL_DELETING: 355 switch (old_state) { 356 case NVME_CTRL_LIVE: 357 case NVME_CTRL_RESETTING: 358 case NVME_CTRL_CONNECTING: 359 changed = true; 360 /* FALLTHRU */ 361 default: 362 break; 363 } 364 break; 365 case NVME_CTRL_DEAD: 366 switch (old_state) { 367 case NVME_CTRL_DELETING: 368 changed = true; 369 /* FALLTHRU */ 370 default: 371 break; 372 } 373 break; 374 default: 375 break; 376 } 377 378 if (changed) { 379 ctrl->state = new_state; 380 wake_up_all(&ctrl->state_wq); 381 } 382 383 spin_unlock_irqrestore(&ctrl->lock, flags); 384 if (changed && ctrl->state == NVME_CTRL_LIVE) 385 nvme_kick_requeue_lists(ctrl); 386 return changed; 387 } 388 EXPORT_SYMBOL_GPL(nvme_change_ctrl_state); 389 390 /* 391 * Returns true for sink states that can't ever transition back to live. 392 */ 393 static bool nvme_state_terminal(struct nvme_ctrl *ctrl) 394 { 395 switch (ctrl->state) { 396 case NVME_CTRL_NEW: 397 case NVME_CTRL_LIVE: 398 case NVME_CTRL_RESETTING: 399 case NVME_CTRL_CONNECTING: 400 return false; 401 case NVME_CTRL_DELETING: 402 case NVME_CTRL_DEAD: 403 return true; 404 default: 405 WARN_ONCE(1, "Unhandled ctrl state:%d", ctrl->state); 406 return true; 407 } 408 } 409 410 /* 411 * Waits for the controller state to be resetting, or returns false if it is 412 * not possible to ever transition to that state. 413 */ 414 bool nvme_wait_reset(struct nvme_ctrl *ctrl) 415 { 416 wait_event(ctrl->state_wq, 417 nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING) || 418 nvme_state_terminal(ctrl)); 419 return ctrl->state == NVME_CTRL_RESETTING; 420 } 421 EXPORT_SYMBOL_GPL(nvme_wait_reset); 422 423 static void nvme_free_ns_head(struct kref *ref) 424 { 425 struct nvme_ns_head *head = 426 container_of(ref, struct nvme_ns_head, ref); 427 428 nvme_mpath_remove_disk(head); 429 ida_simple_remove(&head->subsys->ns_ida, head->instance); 430 cleanup_srcu_struct(&head->srcu); 431 nvme_put_subsystem(head->subsys); 432 kfree(head); 433 } 434 435 static void nvme_put_ns_head(struct nvme_ns_head *head) 436 { 437 kref_put(&head->ref, nvme_free_ns_head); 438 } 439 440 static void nvme_free_ns(struct kref *kref) 441 { 442 struct nvme_ns *ns = container_of(kref, struct nvme_ns, kref); 443 444 if (ns->ndev) 445 nvme_nvm_unregister(ns); 446 447 put_disk(ns->disk); 448 nvme_put_ns_head(ns->head); 449 nvme_put_ctrl(ns->ctrl); 450 kfree(ns); 451 } 452 453 static void nvme_put_ns(struct nvme_ns *ns) 454 { 455 kref_put(&ns->kref, nvme_free_ns); 456 } 457 458 static inline void nvme_clear_nvme_request(struct request *req) 459 { 460 if (!(req->rq_flags & RQF_DONTPREP)) { 461 nvme_req(req)->retries = 0; 462 nvme_req(req)->flags = 0; 463 req->rq_flags |= RQF_DONTPREP; 464 } 465 } 466 467 struct request *nvme_alloc_request(struct request_queue *q, 468 struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid) 469 { 470 unsigned op = nvme_is_write(cmd) ? REQ_OP_DRV_OUT : REQ_OP_DRV_IN; 471 struct request *req; 472 473 if (qid == NVME_QID_ANY) { 474 req = blk_mq_alloc_request(q, op, flags); 475 } else { 476 req = blk_mq_alloc_request_hctx(q, op, flags, 477 qid ? qid - 1 : 0); 478 } 479 if (IS_ERR(req)) 480 return req; 481 482 req->cmd_flags |= REQ_FAILFAST_DRIVER; 483 nvme_clear_nvme_request(req); 484 nvme_req(req)->cmd = cmd; 485 486 return req; 487 } 488 EXPORT_SYMBOL_GPL(nvme_alloc_request); 489 490 static int nvme_toggle_streams(struct nvme_ctrl *ctrl, bool enable) 491 { 492 struct nvme_command c; 493 494 memset(&c, 0, sizeof(c)); 495 496 c.directive.opcode = nvme_admin_directive_send; 497 c.directive.nsid = cpu_to_le32(NVME_NSID_ALL); 498 c.directive.doper = NVME_DIR_SND_ID_OP_ENABLE; 499 c.directive.dtype = NVME_DIR_IDENTIFY; 500 c.directive.tdtype = NVME_DIR_STREAMS; 501 c.directive.endir = enable ? NVME_DIR_ENDIR : 0; 502 503 return nvme_submit_sync_cmd(ctrl->admin_q, &c, NULL, 0); 504 } 505 506 static int nvme_disable_streams(struct nvme_ctrl *ctrl) 507 { 508 return nvme_toggle_streams(ctrl, false); 509 } 510 511 static int nvme_enable_streams(struct nvme_ctrl *ctrl) 512 { 513 return nvme_toggle_streams(ctrl, true); 514 } 515 516 static int nvme_get_stream_params(struct nvme_ctrl *ctrl, 517 struct streams_directive_params *s, u32 nsid) 518 { 519 struct nvme_command c; 520 521 memset(&c, 0, sizeof(c)); 522 memset(s, 0, sizeof(*s)); 523 524 c.directive.opcode = nvme_admin_directive_recv; 525 c.directive.nsid = cpu_to_le32(nsid); 526 c.directive.numd = cpu_to_le32(nvme_bytes_to_numd(sizeof(*s))); 527 c.directive.doper = NVME_DIR_RCV_ST_OP_PARAM; 528 c.directive.dtype = NVME_DIR_STREAMS; 529 530 return nvme_submit_sync_cmd(ctrl->admin_q, &c, s, sizeof(*s)); 531 } 532 533 static int nvme_configure_directives(struct nvme_ctrl *ctrl) 534 { 535 struct streams_directive_params s; 536 int ret; 537 538 if (!(ctrl->oacs & NVME_CTRL_OACS_DIRECTIVES)) 539 return 0; 540 if (!streams) 541 return 0; 542 543 ret = nvme_enable_streams(ctrl); 544 if (ret) 545 return ret; 546 547 ret = nvme_get_stream_params(ctrl, &s, NVME_NSID_ALL); 548 if (ret) 549 goto out_disable_stream; 550 551 ctrl->nssa = le16_to_cpu(s.nssa); 552 if (ctrl->nssa < BLK_MAX_WRITE_HINTS - 1) { 553 dev_info(ctrl->device, "too few streams (%u) available\n", 554 ctrl->nssa); 555 goto out_disable_stream; 556 } 557 558 ctrl->nr_streams = min_t(unsigned, ctrl->nssa, BLK_MAX_WRITE_HINTS - 1); 559 dev_info(ctrl->device, "Using %u streams\n", ctrl->nr_streams); 560 return 0; 561 562 out_disable_stream: 563 nvme_disable_streams(ctrl); 564 return ret; 565 } 566 567 /* 568 * Check if 'req' has a write hint associated with it. If it does, assign 569 * a valid namespace stream to the write. 570 */ 571 static void nvme_assign_write_stream(struct nvme_ctrl *ctrl, 572 struct request *req, u16 *control, 573 u32 *dsmgmt) 574 { 575 enum rw_hint streamid = req->write_hint; 576 577 if (streamid == WRITE_LIFE_NOT_SET || streamid == WRITE_LIFE_NONE) 578 streamid = 0; 579 else { 580 streamid--; 581 if (WARN_ON_ONCE(streamid > ctrl->nr_streams)) 582 return; 583 584 *control |= NVME_RW_DTYPE_STREAMS; 585 *dsmgmt |= streamid << 16; 586 } 587 588 if (streamid < ARRAY_SIZE(req->q->write_hints)) 589 req->q->write_hints[streamid] += blk_rq_bytes(req) >> 9; 590 } 591 592 static inline void nvme_setup_flush(struct nvme_ns *ns, 593 struct nvme_command *cmnd) 594 { 595 cmnd->common.opcode = nvme_cmd_flush; 596 cmnd->common.nsid = cpu_to_le32(ns->head->ns_id); 597 } 598 599 static blk_status_t nvme_setup_discard(struct nvme_ns *ns, struct request *req, 600 struct nvme_command *cmnd) 601 { 602 unsigned short segments = blk_rq_nr_discard_segments(req), n = 0; 603 struct nvme_dsm_range *range; 604 struct bio *bio; 605 606 /* 607 * Some devices do not consider the DSM 'Number of Ranges' field when 608 * determining how much data to DMA. Always allocate memory for maximum 609 * number of segments to prevent device reading beyond end of buffer. 610 */ 611 static const size_t alloc_size = sizeof(*range) * NVME_DSM_MAX_RANGES; 612 613 range = kzalloc(alloc_size, GFP_ATOMIC | __GFP_NOWARN); 614 if (!range) { 615 /* 616 * If we fail allocation our range, fallback to the controller 617 * discard page. If that's also busy, it's safe to return 618 * busy, as we know we can make progress once that's freed. 619 */ 620 if (test_and_set_bit_lock(0, &ns->ctrl->discard_page_busy)) 621 return BLK_STS_RESOURCE; 622 623 range = page_address(ns->ctrl->discard_page); 624 } 625 626 __rq_for_each_bio(bio, req) { 627 u64 slba = nvme_sect_to_lba(ns, bio->bi_iter.bi_sector); 628 u32 nlb = bio->bi_iter.bi_size >> ns->lba_shift; 629 630 if (n < segments) { 631 range[n].cattr = cpu_to_le32(0); 632 range[n].nlb = cpu_to_le32(nlb); 633 range[n].slba = cpu_to_le64(slba); 634 } 635 n++; 636 } 637 638 if (WARN_ON_ONCE(n != segments)) { 639 if (virt_to_page(range) == ns->ctrl->discard_page) 640 clear_bit_unlock(0, &ns->ctrl->discard_page_busy); 641 else 642 kfree(range); 643 return BLK_STS_IOERR; 644 } 645 646 cmnd->dsm.opcode = nvme_cmd_dsm; 647 cmnd->dsm.nsid = cpu_to_le32(ns->head->ns_id); 648 cmnd->dsm.nr = cpu_to_le32(segments - 1); 649 cmnd->dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD); 650 651 req->special_vec.bv_page = virt_to_page(range); 652 req->special_vec.bv_offset = offset_in_page(range); 653 req->special_vec.bv_len = alloc_size; 654 req->rq_flags |= RQF_SPECIAL_PAYLOAD; 655 656 return BLK_STS_OK; 657 } 658 659 static inline blk_status_t nvme_setup_write_zeroes(struct nvme_ns *ns, 660 struct request *req, struct nvme_command *cmnd) 661 { 662 if (ns->ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES) 663 return nvme_setup_discard(ns, req, cmnd); 664 665 cmnd->write_zeroes.opcode = nvme_cmd_write_zeroes; 666 cmnd->write_zeroes.nsid = cpu_to_le32(ns->head->ns_id); 667 cmnd->write_zeroes.slba = 668 cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req))); 669 cmnd->write_zeroes.length = 670 cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1); 671 cmnd->write_zeroes.control = 0; 672 return BLK_STS_OK; 673 } 674 675 static inline blk_status_t nvme_setup_rw(struct nvme_ns *ns, 676 struct request *req, struct nvme_command *cmnd) 677 { 678 struct nvme_ctrl *ctrl = ns->ctrl; 679 u16 control = 0; 680 u32 dsmgmt = 0; 681 682 if (req->cmd_flags & REQ_FUA) 683 control |= NVME_RW_FUA; 684 if (req->cmd_flags & (REQ_FAILFAST_DEV | REQ_RAHEAD)) 685 control |= NVME_RW_LR; 686 687 if (req->cmd_flags & REQ_RAHEAD) 688 dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH; 689 690 cmnd->rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read); 691 cmnd->rw.nsid = cpu_to_le32(ns->head->ns_id); 692 cmnd->rw.slba = cpu_to_le64(nvme_sect_to_lba(ns, blk_rq_pos(req))); 693 cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1); 694 695 if (req_op(req) == REQ_OP_WRITE && ctrl->nr_streams) 696 nvme_assign_write_stream(ctrl, req, &control, &dsmgmt); 697 698 if (ns->ms) { 699 /* 700 * If formated with metadata, the block layer always provides a 701 * metadata buffer if CONFIG_BLK_DEV_INTEGRITY is enabled. Else 702 * we enable the PRACT bit for protection information or set the 703 * namespace capacity to zero to prevent any I/O. 704 */ 705 if (!blk_integrity_rq(req)) { 706 if (WARN_ON_ONCE(!nvme_ns_has_pi(ns))) 707 return BLK_STS_NOTSUPP; 708 control |= NVME_RW_PRINFO_PRACT; 709 } 710 711 switch (ns->pi_type) { 712 case NVME_NS_DPS_PI_TYPE3: 713 control |= NVME_RW_PRINFO_PRCHK_GUARD; 714 break; 715 case NVME_NS_DPS_PI_TYPE1: 716 case NVME_NS_DPS_PI_TYPE2: 717 control |= NVME_RW_PRINFO_PRCHK_GUARD | 718 NVME_RW_PRINFO_PRCHK_REF; 719 cmnd->rw.reftag = cpu_to_le32(t10_pi_ref_tag(req)); 720 break; 721 } 722 } 723 724 cmnd->rw.control = cpu_to_le16(control); 725 cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt); 726 return 0; 727 } 728 729 void nvme_cleanup_cmd(struct request *req) 730 { 731 if (req->rq_flags & RQF_SPECIAL_PAYLOAD) { 732 struct nvme_ns *ns = req->rq_disk->private_data; 733 struct page *page = req->special_vec.bv_page; 734 735 if (page == ns->ctrl->discard_page) 736 clear_bit_unlock(0, &ns->ctrl->discard_page_busy); 737 else 738 kfree(page_address(page) + req->special_vec.bv_offset); 739 } 740 } 741 EXPORT_SYMBOL_GPL(nvme_cleanup_cmd); 742 743 blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req, 744 struct nvme_command *cmd) 745 { 746 blk_status_t ret = BLK_STS_OK; 747 748 nvme_clear_nvme_request(req); 749 750 memset(cmd, 0, sizeof(*cmd)); 751 switch (req_op(req)) { 752 case REQ_OP_DRV_IN: 753 case REQ_OP_DRV_OUT: 754 memcpy(cmd, nvme_req(req)->cmd, sizeof(*cmd)); 755 break; 756 case REQ_OP_FLUSH: 757 nvme_setup_flush(ns, cmd); 758 break; 759 case REQ_OP_WRITE_ZEROES: 760 ret = nvme_setup_write_zeroes(ns, req, cmd); 761 break; 762 case REQ_OP_DISCARD: 763 ret = nvme_setup_discard(ns, req, cmd); 764 break; 765 case REQ_OP_READ: 766 case REQ_OP_WRITE: 767 ret = nvme_setup_rw(ns, req, cmd); 768 break; 769 default: 770 WARN_ON_ONCE(1); 771 return BLK_STS_IOERR; 772 } 773 774 cmd->common.command_id = req->tag; 775 trace_nvme_setup_cmd(req, cmd); 776 return ret; 777 } 778 EXPORT_SYMBOL_GPL(nvme_setup_cmd); 779 780 static void nvme_end_sync_rq(struct request *rq, blk_status_t error) 781 { 782 struct completion *waiting = rq->end_io_data; 783 784 rq->end_io_data = NULL; 785 complete(waiting); 786 } 787 788 static void nvme_execute_rq_polled(struct request_queue *q, 789 struct gendisk *bd_disk, struct request *rq, int at_head) 790 { 791 DECLARE_COMPLETION_ONSTACK(wait); 792 793 WARN_ON_ONCE(!test_bit(QUEUE_FLAG_POLL, &q->queue_flags)); 794 795 rq->cmd_flags |= REQ_HIPRI; 796 rq->end_io_data = &wait; 797 blk_execute_rq_nowait(q, bd_disk, rq, at_head, nvme_end_sync_rq); 798 799 while (!completion_done(&wait)) { 800 blk_poll(q, request_to_qc_t(rq->mq_hctx, rq), true); 801 cond_resched(); 802 } 803 } 804 805 /* 806 * Returns 0 on success. If the result is negative, it's a Linux error code; 807 * if the result is positive, it's an NVM Express status code 808 */ 809 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 810 union nvme_result *result, void *buffer, unsigned bufflen, 811 unsigned timeout, int qid, int at_head, 812 blk_mq_req_flags_t flags, bool poll) 813 { 814 struct request *req; 815 int ret; 816 817 req = nvme_alloc_request(q, cmd, flags, qid); 818 if (IS_ERR(req)) 819 return PTR_ERR(req); 820 821 req->timeout = timeout ? timeout : ADMIN_TIMEOUT; 822 823 if (buffer && bufflen) { 824 ret = blk_rq_map_kern(q, req, buffer, bufflen, GFP_KERNEL); 825 if (ret) 826 goto out; 827 } 828 829 if (poll) 830 nvme_execute_rq_polled(req->q, NULL, req, at_head); 831 else 832 blk_execute_rq(req->q, NULL, req, at_head); 833 if (result) 834 *result = nvme_req(req)->result; 835 if (nvme_req(req)->flags & NVME_REQ_CANCELLED) 836 ret = -EINTR; 837 else 838 ret = nvme_req(req)->status; 839 out: 840 blk_mq_free_request(req); 841 return ret; 842 } 843 EXPORT_SYMBOL_GPL(__nvme_submit_sync_cmd); 844 845 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 846 void *buffer, unsigned bufflen) 847 { 848 return __nvme_submit_sync_cmd(q, cmd, NULL, buffer, bufflen, 0, 849 NVME_QID_ANY, 0, 0, false); 850 } 851 EXPORT_SYMBOL_GPL(nvme_submit_sync_cmd); 852 853 static void *nvme_add_user_metadata(struct bio *bio, void __user *ubuf, 854 unsigned len, u32 seed, bool write) 855 { 856 struct bio_integrity_payload *bip; 857 int ret = -ENOMEM; 858 void *buf; 859 860 buf = kmalloc(len, GFP_KERNEL); 861 if (!buf) 862 goto out; 863 864 ret = -EFAULT; 865 if (write && copy_from_user(buf, ubuf, len)) 866 goto out_free_meta; 867 868 bip = bio_integrity_alloc(bio, GFP_KERNEL, 1); 869 if (IS_ERR(bip)) { 870 ret = PTR_ERR(bip); 871 goto out_free_meta; 872 } 873 874 bip->bip_iter.bi_size = len; 875 bip->bip_iter.bi_sector = seed; 876 ret = bio_integrity_add_page(bio, virt_to_page(buf), len, 877 offset_in_page(buf)); 878 if (ret == len) 879 return buf; 880 ret = -ENOMEM; 881 out_free_meta: 882 kfree(buf); 883 out: 884 return ERR_PTR(ret); 885 } 886 887 static int nvme_submit_user_cmd(struct request_queue *q, 888 struct nvme_command *cmd, void __user *ubuffer, 889 unsigned bufflen, void __user *meta_buffer, unsigned meta_len, 890 u32 meta_seed, u64 *result, unsigned timeout) 891 { 892 bool write = nvme_is_write(cmd); 893 struct nvme_ns *ns = q->queuedata; 894 struct gendisk *disk = ns ? ns->disk : NULL; 895 struct request *req; 896 struct bio *bio = NULL; 897 void *meta = NULL; 898 int ret; 899 900 req = nvme_alloc_request(q, cmd, 0, NVME_QID_ANY); 901 if (IS_ERR(req)) 902 return PTR_ERR(req); 903 904 req->timeout = timeout ? timeout : ADMIN_TIMEOUT; 905 nvme_req(req)->flags |= NVME_REQ_USERCMD; 906 907 if (ubuffer && bufflen) { 908 ret = blk_rq_map_user(q, req, NULL, ubuffer, bufflen, 909 GFP_KERNEL); 910 if (ret) 911 goto out; 912 bio = req->bio; 913 bio->bi_disk = disk; 914 if (disk && meta_buffer && meta_len) { 915 meta = nvme_add_user_metadata(bio, meta_buffer, meta_len, 916 meta_seed, write); 917 if (IS_ERR(meta)) { 918 ret = PTR_ERR(meta); 919 goto out_unmap; 920 } 921 req->cmd_flags |= REQ_INTEGRITY; 922 } 923 } 924 925 blk_execute_rq(req->q, disk, req, 0); 926 if (nvme_req(req)->flags & NVME_REQ_CANCELLED) 927 ret = -EINTR; 928 else 929 ret = nvme_req(req)->status; 930 if (result) 931 *result = le64_to_cpu(nvme_req(req)->result.u64); 932 if (meta && !ret && !write) { 933 if (copy_to_user(meta_buffer, meta, meta_len)) 934 ret = -EFAULT; 935 } 936 kfree(meta); 937 out_unmap: 938 if (bio) 939 blk_rq_unmap_user(bio); 940 out: 941 blk_mq_free_request(req); 942 return ret; 943 } 944 945 static void nvme_keep_alive_end_io(struct request *rq, blk_status_t status) 946 { 947 struct nvme_ctrl *ctrl = rq->end_io_data; 948 unsigned long flags; 949 bool startka = false; 950 951 blk_mq_free_request(rq); 952 953 if (status) { 954 dev_err(ctrl->device, 955 "failed nvme_keep_alive_end_io error=%d\n", 956 status); 957 return; 958 } 959 960 ctrl->comp_seen = false; 961 spin_lock_irqsave(&ctrl->lock, flags); 962 if (ctrl->state == NVME_CTRL_LIVE || 963 ctrl->state == NVME_CTRL_CONNECTING) 964 startka = true; 965 spin_unlock_irqrestore(&ctrl->lock, flags); 966 if (startka) 967 queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ); 968 } 969 970 static int nvme_keep_alive(struct nvme_ctrl *ctrl) 971 { 972 struct request *rq; 973 974 rq = nvme_alloc_request(ctrl->admin_q, &ctrl->ka_cmd, BLK_MQ_REQ_RESERVED, 975 NVME_QID_ANY); 976 if (IS_ERR(rq)) 977 return PTR_ERR(rq); 978 979 rq->timeout = ctrl->kato * HZ; 980 rq->end_io_data = ctrl; 981 982 blk_execute_rq_nowait(rq->q, NULL, rq, 0, nvme_keep_alive_end_io); 983 984 return 0; 985 } 986 987 static void nvme_keep_alive_work(struct work_struct *work) 988 { 989 struct nvme_ctrl *ctrl = container_of(to_delayed_work(work), 990 struct nvme_ctrl, ka_work); 991 bool comp_seen = ctrl->comp_seen; 992 993 if ((ctrl->ctratt & NVME_CTRL_ATTR_TBKAS) && comp_seen) { 994 dev_dbg(ctrl->device, 995 "reschedule traffic based keep-alive timer\n"); 996 ctrl->comp_seen = false; 997 queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ); 998 return; 999 } 1000 1001 if (nvme_keep_alive(ctrl)) { 1002 /* allocation failure, reset the controller */ 1003 dev_err(ctrl->device, "keep-alive failed\n"); 1004 nvme_reset_ctrl(ctrl); 1005 return; 1006 } 1007 } 1008 1009 static void nvme_start_keep_alive(struct nvme_ctrl *ctrl) 1010 { 1011 if (unlikely(ctrl->kato == 0)) 1012 return; 1013 1014 queue_delayed_work(nvme_wq, &ctrl->ka_work, ctrl->kato * HZ); 1015 } 1016 1017 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl) 1018 { 1019 if (unlikely(ctrl->kato == 0)) 1020 return; 1021 1022 cancel_delayed_work_sync(&ctrl->ka_work); 1023 } 1024 EXPORT_SYMBOL_GPL(nvme_stop_keep_alive); 1025 1026 /* 1027 * In NVMe 1.0 the CNS field was just a binary controller or namespace 1028 * flag, thus sending any new CNS opcodes has a big chance of not working. 1029 * Qemu unfortunately had that bug after reporting a 1.1 version compliance 1030 * (but not for any later version). 1031 */ 1032 static bool nvme_ctrl_limited_cns(struct nvme_ctrl *ctrl) 1033 { 1034 if (ctrl->quirks & NVME_QUIRK_IDENTIFY_CNS) 1035 return ctrl->vs < NVME_VS(1, 2, 0); 1036 return ctrl->vs < NVME_VS(1, 1, 0); 1037 } 1038 1039 static int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id) 1040 { 1041 struct nvme_command c = { }; 1042 int error; 1043 1044 /* gcc-4.4.4 (at least) has issues with initializers and anon unions */ 1045 c.identify.opcode = nvme_admin_identify; 1046 c.identify.cns = NVME_ID_CNS_CTRL; 1047 1048 *id = kmalloc(sizeof(struct nvme_id_ctrl), GFP_KERNEL); 1049 if (!*id) 1050 return -ENOMEM; 1051 1052 error = nvme_submit_sync_cmd(dev->admin_q, &c, *id, 1053 sizeof(struct nvme_id_ctrl)); 1054 if (error) 1055 kfree(*id); 1056 return error; 1057 } 1058 1059 static int nvme_process_ns_desc(struct nvme_ctrl *ctrl, struct nvme_ns_ids *ids, 1060 struct nvme_ns_id_desc *cur) 1061 { 1062 const char *warn_str = "ctrl returned bogus length:"; 1063 void *data = cur; 1064 1065 switch (cur->nidt) { 1066 case NVME_NIDT_EUI64: 1067 if (cur->nidl != NVME_NIDT_EUI64_LEN) { 1068 dev_warn(ctrl->device, "%s %d for NVME_NIDT_EUI64\n", 1069 warn_str, cur->nidl); 1070 return -1; 1071 } 1072 memcpy(ids->eui64, data + sizeof(*cur), NVME_NIDT_EUI64_LEN); 1073 return NVME_NIDT_EUI64_LEN; 1074 case NVME_NIDT_NGUID: 1075 if (cur->nidl != NVME_NIDT_NGUID_LEN) { 1076 dev_warn(ctrl->device, "%s %d for NVME_NIDT_NGUID\n", 1077 warn_str, cur->nidl); 1078 return -1; 1079 } 1080 memcpy(ids->nguid, data + sizeof(*cur), NVME_NIDT_NGUID_LEN); 1081 return NVME_NIDT_NGUID_LEN; 1082 case NVME_NIDT_UUID: 1083 if (cur->nidl != NVME_NIDT_UUID_LEN) { 1084 dev_warn(ctrl->device, "%s %d for NVME_NIDT_UUID\n", 1085 warn_str, cur->nidl); 1086 return -1; 1087 } 1088 uuid_copy(&ids->uuid, data + sizeof(*cur)); 1089 return NVME_NIDT_UUID_LEN; 1090 default: 1091 /* Skip unknown types */ 1092 return cur->nidl; 1093 } 1094 } 1095 1096 static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl, unsigned nsid, 1097 struct nvme_ns_ids *ids) 1098 { 1099 struct nvme_command c = { }; 1100 int status; 1101 void *data; 1102 int pos; 1103 int len; 1104 1105 if (ctrl->quirks & NVME_QUIRK_NO_NS_DESC_LIST) 1106 return 0; 1107 1108 c.identify.opcode = nvme_admin_identify; 1109 c.identify.nsid = cpu_to_le32(nsid); 1110 c.identify.cns = NVME_ID_CNS_NS_DESC_LIST; 1111 1112 data = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL); 1113 if (!data) 1114 return -ENOMEM; 1115 1116 status = nvme_submit_sync_cmd(ctrl->admin_q, &c, data, 1117 NVME_IDENTIFY_DATA_SIZE); 1118 if (status) { 1119 dev_warn(ctrl->device, 1120 "Identify Descriptors failed (%d)\n", status); 1121 goto free_data; 1122 } 1123 1124 for (pos = 0; pos < NVME_IDENTIFY_DATA_SIZE; pos += len) { 1125 struct nvme_ns_id_desc *cur = data + pos; 1126 1127 if (cur->nidl == 0) 1128 break; 1129 1130 len = nvme_process_ns_desc(ctrl, ids, cur); 1131 if (len < 0) 1132 goto free_data; 1133 1134 len += sizeof(*cur); 1135 } 1136 free_data: 1137 kfree(data); 1138 return status; 1139 } 1140 1141 static int nvme_identify_ns_list(struct nvme_ctrl *dev, unsigned nsid, __le32 *ns_list) 1142 { 1143 struct nvme_command c = { }; 1144 1145 c.identify.opcode = nvme_admin_identify; 1146 c.identify.cns = NVME_ID_CNS_NS_ACTIVE_LIST; 1147 c.identify.nsid = cpu_to_le32(nsid); 1148 return nvme_submit_sync_cmd(dev->admin_q, &c, ns_list, 1149 NVME_IDENTIFY_DATA_SIZE); 1150 } 1151 1152 static int nvme_identify_ns(struct nvme_ctrl *ctrl, 1153 unsigned nsid, struct nvme_id_ns **id) 1154 { 1155 struct nvme_command c = { }; 1156 int error; 1157 1158 /* gcc-4.4.4 (at least) has issues with initializers and anon unions */ 1159 c.identify.opcode = nvme_admin_identify; 1160 c.identify.nsid = cpu_to_le32(nsid); 1161 c.identify.cns = NVME_ID_CNS_NS; 1162 1163 *id = kmalloc(sizeof(**id), GFP_KERNEL); 1164 if (!*id) 1165 return -ENOMEM; 1166 1167 error = nvme_submit_sync_cmd(ctrl->admin_q, &c, *id, sizeof(**id)); 1168 if (error) { 1169 dev_warn(ctrl->device, "Identify namespace failed (%d)\n", error); 1170 kfree(*id); 1171 } 1172 1173 return error; 1174 } 1175 1176 static int nvme_features(struct nvme_ctrl *dev, u8 op, unsigned int fid, 1177 unsigned int dword11, void *buffer, size_t buflen, u32 *result) 1178 { 1179 union nvme_result res = { 0 }; 1180 struct nvme_command c; 1181 int ret; 1182 1183 memset(&c, 0, sizeof(c)); 1184 c.features.opcode = op; 1185 c.features.fid = cpu_to_le32(fid); 1186 c.features.dword11 = cpu_to_le32(dword11); 1187 1188 ret = __nvme_submit_sync_cmd(dev->admin_q, &c, &res, 1189 buffer, buflen, 0, NVME_QID_ANY, 0, 0, false); 1190 if (ret >= 0 && result) 1191 *result = le32_to_cpu(res.u32); 1192 return ret; 1193 } 1194 1195 int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid, 1196 unsigned int dword11, void *buffer, size_t buflen, 1197 u32 *result) 1198 { 1199 return nvme_features(dev, nvme_admin_set_features, fid, dword11, buffer, 1200 buflen, result); 1201 } 1202 EXPORT_SYMBOL_GPL(nvme_set_features); 1203 1204 int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid, 1205 unsigned int dword11, void *buffer, size_t buflen, 1206 u32 *result) 1207 { 1208 return nvme_features(dev, nvme_admin_get_features, fid, dword11, buffer, 1209 buflen, result); 1210 } 1211 EXPORT_SYMBOL_GPL(nvme_get_features); 1212 1213 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count) 1214 { 1215 u32 q_count = (*count - 1) | ((*count - 1) << 16); 1216 u32 result; 1217 int status, nr_io_queues; 1218 1219 status = nvme_set_features(ctrl, NVME_FEAT_NUM_QUEUES, q_count, NULL, 0, 1220 &result); 1221 if (status < 0) 1222 return status; 1223 1224 /* 1225 * Degraded controllers might return an error when setting the queue 1226 * count. We still want to be able to bring them online and offer 1227 * access to the admin queue, as that might be only way to fix them up. 1228 */ 1229 if (status > 0) { 1230 dev_err(ctrl->device, "Could not set queue count (%d)\n", status); 1231 *count = 0; 1232 } else { 1233 nr_io_queues = min(result & 0xffff, result >> 16) + 1; 1234 *count = min(*count, nr_io_queues); 1235 } 1236 1237 return 0; 1238 } 1239 EXPORT_SYMBOL_GPL(nvme_set_queue_count); 1240 1241 #define NVME_AEN_SUPPORTED \ 1242 (NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_FW_ACT | \ 1243 NVME_AEN_CFG_ANA_CHANGE | NVME_AEN_CFG_DISC_CHANGE) 1244 1245 static void nvme_enable_aen(struct nvme_ctrl *ctrl) 1246 { 1247 u32 result, supported_aens = ctrl->oaes & NVME_AEN_SUPPORTED; 1248 int status; 1249 1250 if (!supported_aens) 1251 return; 1252 1253 status = nvme_set_features(ctrl, NVME_FEAT_ASYNC_EVENT, supported_aens, 1254 NULL, 0, &result); 1255 if (status) 1256 dev_warn(ctrl->device, "Failed to configure AEN (cfg %x)\n", 1257 supported_aens); 1258 1259 queue_work(nvme_wq, &ctrl->async_event_work); 1260 } 1261 1262 /* 1263 * Convert integer values from ioctl structures to user pointers, silently 1264 * ignoring the upper bits in the compat case to match behaviour of 32-bit 1265 * kernels. 1266 */ 1267 static void __user *nvme_to_user_ptr(uintptr_t ptrval) 1268 { 1269 if (in_compat_syscall()) 1270 ptrval = (compat_uptr_t)ptrval; 1271 return (void __user *)ptrval; 1272 } 1273 1274 static int nvme_submit_io(struct nvme_ns *ns, struct nvme_user_io __user *uio) 1275 { 1276 struct nvme_user_io io; 1277 struct nvme_command c; 1278 unsigned length, meta_len; 1279 void __user *metadata; 1280 1281 if (copy_from_user(&io, uio, sizeof(io))) 1282 return -EFAULT; 1283 if (io.flags) 1284 return -EINVAL; 1285 1286 switch (io.opcode) { 1287 case nvme_cmd_write: 1288 case nvme_cmd_read: 1289 case nvme_cmd_compare: 1290 break; 1291 default: 1292 return -EINVAL; 1293 } 1294 1295 length = (io.nblocks + 1) << ns->lba_shift; 1296 meta_len = (io.nblocks + 1) * ns->ms; 1297 metadata = nvme_to_user_ptr(io.metadata); 1298 1299 if (ns->features & NVME_NS_EXT_LBAS) { 1300 length += meta_len; 1301 meta_len = 0; 1302 } else if (meta_len) { 1303 if ((io.metadata & 3) || !io.metadata) 1304 return -EINVAL; 1305 } 1306 1307 memset(&c, 0, sizeof(c)); 1308 c.rw.opcode = io.opcode; 1309 c.rw.flags = io.flags; 1310 c.rw.nsid = cpu_to_le32(ns->head->ns_id); 1311 c.rw.slba = cpu_to_le64(io.slba); 1312 c.rw.length = cpu_to_le16(io.nblocks); 1313 c.rw.control = cpu_to_le16(io.control); 1314 c.rw.dsmgmt = cpu_to_le32(io.dsmgmt); 1315 c.rw.reftag = cpu_to_le32(io.reftag); 1316 c.rw.apptag = cpu_to_le16(io.apptag); 1317 c.rw.appmask = cpu_to_le16(io.appmask); 1318 1319 return nvme_submit_user_cmd(ns->queue, &c, 1320 nvme_to_user_ptr(io.addr), length, 1321 metadata, meta_len, lower_32_bits(io.slba), NULL, 0); 1322 } 1323 1324 static u32 nvme_known_admin_effects(u8 opcode) 1325 { 1326 switch (opcode) { 1327 case nvme_admin_format_nvm: 1328 return NVME_CMD_EFFECTS_CSUPP | NVME_CMD_EFFECTS_LBCC | 1329 NVME_CMD_EFFECTS_CSE_MASK; 1330 case nvme_admin_sanitize_nvm: 1331 return NVME_CMD_EFFECTS_CSE_MASK; 1332 default: 1333 break; 1334 } 1335 return 0; 1336 } 1337 1338 static u32 nvme_passthru_start(struct nvme_ctrl *ctrl, struct nvme_ns *ns, 1339 u8 opcode) 1340 { 1341 u32 effects = 0; 1342 1343 if (ns) { 1344 if (ctrl->effects) 1345 effects = le32_to_cpu(ctrl->effects->iocs[opcode]); 1346 if (effects & ~(NVME_CMD_EFFECTS_CSUPP | NVME_CMD_EFFECTS_LBCC)) 1347 dev_warn(ctrl->device, 1348 "IO command:%02x has unhandled effects:%08x\n", 1349 opcode, effects); 1350 return 0; 1351 } 1352 1353 if (ctrl->effects) 1354 effects = le32_to_cpu(ctrl->effects->acs[opcode]); 1355 effects |= nvme_known_admin_effects(opcode); 1356 1357 /* 1358 * For simplicity, IO to all namespaces is quiesced even if the command 1359 * effects say only one namespace is affected. 1360 */ 1361 if (effects & (NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_CSE_MASK)) { 1362 mutex_lock(&ctrl->scan_lock); 1363 mutex_lock(&ctrl->subsys->lock); 1364 nvme_mpath_start_freeze(ctrl->subsys); 1365 nvme_mpath_wait_freeze(ctrl->subsys); 1366 nvme_start_freeze(ctrl); 1367 nvme_wait_freeze(ctrl); 1368 } 1369 return effects; 1370 } 1371 1372 static void nvme_update_formats(struct nvme_ctrl *ctrl) 1373 { 1374 struct nvme_ns *ns; 1375 1376 down_read(&ctrl->namespaces_rwsem); 1377 list_for_each_entry(ns, &ctrl->namespaces, list) 1378 if (ns->disk && nvme_revalidate_disk(ns->disk)) 1379 nvme_set_queue_dying(ns); 1380 up_read(&ctrl->namespaces_rwsem); 1381 } 1382 1383 static void nvme_passthru_end(struct nvme_ctrl *ctrl, u32 effects) 1384 { 1385 /* 1386 * Revalidate LBA changes prior to unfreezing. This is necessary to 1387 * prevent memory corruption if a logical block size was changed by 1388 * this command. 1389 */ 1390 if (effects & NVME_CMD_EFFECTS_LBCC) 1391 nvme_update_formats(ctrl); 1392 if (effects & (NVME_CMD_EFFECTS_LBCC | NVME_CMD_EFFECTS_CSE_MASK)) { 1393 nvme_unfreeze(ctrl); 1394 nvme_mpath_unfreeze(ctrl->subsys); 1395 mutex_unlock(&ctrl->subsys->lock); 1396 nvme_remove_invalid_namespaces(ctrl, NVME_NSID_ALL); 1397 mutex_unlock(&ctrl->scan_lock); 1398 } 1399 if (effects & NVME_CMD_EFFECTS_CCC) 1400 nvme_init_identify(ctrl); 1401 if (effects & (NVME_CMD_EFFECTS_NIC | NVME_CMD_EFFECTS_NCC)) { 1402 nvme_queue_scan(ctrl); 1403 flush_work(&ctrl->scan_work); 1404 } 1405 } 1406 1407 static int nvme_user_cmd(struct nvme_ctrl *ctrl, struct nvme_ns *ns, 1408 struct nvme_passthru_cmd __user *ucmd) 1409 { 1410 struct nvme_passthru_cmd cmd; 1411 struct nvme_command c; 1412 unsigned timeout = 0; 1413 u32 effects; 1414 u64 result; 1415 int status; 1416 1417 if (!capable(CAP_SYS_ADMIN)) 1418 return -EACCES; 1419 if (copy_from_user(&cmd, ucmd, sizeof(cmd))) 1420 return -EFAULT; 1421 if (cmd.flags) 1422 return -EINVAL; 1423 1424 memset(&c, 0, sizeof(c)); 1425 c.common.opcode = cmd.opcode; 1426 c.common.flags = cmd.flags; 1427 c.common.nsid = cpu_to_le32(cmd.nsid); 1428 c.common.cdw2[0] = cpu_to_le32(cmd.cdw2); 1429 c.common.cdw2[1] = cpu_to_le32(cmd.cdw3); 1430 c.common.cdw10 = cpu_to_le32(cmd.cdw10); 1431 c.common.cdw11 = cpu_to_le32(cmd.cdw11); 1432 c.common.cdw12 = cpu_to_le32(cmd.cdw12); 1433 c.common.cdw13 = cpu_to_le32(cmd.cdw13); 1434 c.common.cdw14 = cpu_to_le32(cmd.cdw14); 1435 c.common.cdw15 = cpu_to_le32(cmd.cdw15); 1436 1437 if (cmd.timeout_ms) 1438 timeout = msecs_to_jiffies(cmd.timeout_ms); 1439 1440 effects = nvme_passthru_start(ctrl, ns, cmd.opcode); 1441 status = nvme_submit_user_cmd(ns ? ns->queue : ctrl->admin_q, &c, 1442 nvme_to_user_ptr(cmd.addr), cmd.data_len, 1443 nvme_to_user_ptr(cmd.metadata), cmd.metadata_len, 1444 0, &result, timeout); 1445 nvme_passthru_end(ctrl, effects); 1446 1447 if (status >= 0) { 1448 if (put_user(result, &ucmd->result)) 1449 return -EFAULT; 1450 } 1451 1452 return status; 1453 } 1454 1455 static int nvme_user_cmd64(struct nvme_ctrl *ctrl, struct nvme_ns *ns, 1456 struct nvme_passthru_cmd64 __user *ucmd) 1457 { 1458 struct nvme_passthru_cmd64 cmd; 1459 struct nvme_command c; 1460 unsigned timeout = 0; 1461 u32 effects; 1462 int status; 1463 1464 if (!capable(CAP_SYS_ADMIN)) 1465 return -EACCES; 1466 if (copy_from_user(&cmd, ucmd, sizeof(cmd))) 1467 return -EFAULT; 1468 if (cmd.flags) 1469 return -EINVAL; 1470 1471 memset(&c, 0, sizeof(c)); 1472 c.common.opcode = cmd.opcode; 1473 c.common.flags = cmd.flags; 1474 c.common.nsid = cpu_to_le32(cmd.nsid); 1475 c.common.cdw2[0] = cpu_to_le32(cmd.cdw2); 1476 c.common.cdw2[1] = cpu_to_le32(cmd.cdw3); 1477 c.common.cdw10 = cpu_to_le32(cmd.cdw10); 1478 c.common.cdw11 = cpu_to_le32(cmd.cdw11); 1479 c.common.cdw12 = cpu_to_le32(cmd.cdw12); 1480 c.common.cdw13 = cpu_to_le32(cmd.cdw13); 1481 c.common.cdw14 = cpu_to_le32(cmd.cdw14); 1482 c.common.cdw15 = cpu_to_le32(cmd.cdw15); 1483 1484 if (cmd.timeout_ms) 1485 timeout = msecs_to_jiffies(cmd.timeout_ms); 1486 1487 effects = nvme_passthru_start(ctrl, ns, cmd.opcode); 1488 status = nvme_submit_user_cmd(ns ? ns->queue : ctrl->admin_q, &c, 1489 nvme_to_user_ptr(cmd.addr), cmd.data_len, 1490 nvme_to_user_ptr(cmd.metadata), cmd.metadata_len, 1491 0, &cmd.result, timeout); 1492 nvme_passthru_end(ctrl, effects); 1493 1494 if (status >= 0) { 1495 if (put_user(cmd.result, &ucmd->result)) 1496 return -EFAULT; 1497 } 1498 1499 return status; 1500 } 1501 1502 /* 1503 * Issue ioctl requests on the first available path. Note that unlike normal 1504 * block layer requests we will not retry failed request on another controller. 1505 */ 1506 static struct nvme_ns *nvme_get_ns_from_disk(struct gendisk *disk, 1507 struct nvme_ns_head **head, int *srcu_idx) 1508 { 1509 #ifdef CONFIG_NVME_MULTIPATH 1510 if (disk->fops == &nvme_ns_head_ops) { 1511 struct nvme_ns *ns; 1512 1513 *head = disk->private_data; 1514 *srcu_idx = srcu_read_lock(&(*head)->srcu); 1515 ns = nvme_find_path(*head); 1516 if (!ns) 1517 srcu_read_unlock(&(*head)->srcu, *srcu_idx); 1518 return ns; 1519 } 1520 #endif 1521 *head = NULL; 1522 *srcu_idx = -1; 1523 return disk->private_data; 1524 } 1525 1526 static void nvme_put_ns_from_disk(struct nvme_ns_head *head, int idx) 1527 { 1528 if (head) 1529 srcu_read_unlock(&head->srcu, idx); 1530 } 1531 1532 static bool is_ctrl_ioctl(unsigned int cmd) 1533 { 1534 if (cmd == NVME_IOCTL_ADMIN_CMD || cmd == NVME_IOCTL_ADMIN64_CMD) 1535 return true; 1536 if (is_sed_ioctl(cmd)) 1537 return true; 1538 return false; 1539 } 1540 1541 static int nvme_handle_ctrl_ioctl(struct nvme_ns *ns, unsigned int cmd, 1542 void __user *argp, 1543 struct nvme_ns_head *head, 1544 int srcu_idx) 1545 { 1546 struct nvme_ctrl *ctrl = ns->ctrl; 1547 int ret; 1548 1549 nvme_get_ctrl(ns->ctrl); 1550 nvme_put_ns_from_disk(head, srcu_idx); 1551 1552 switch (cmd) { 1553 case NVME_IOCTL_ADMIN_CMD: 1554 ret = nvme_user_cmd(ctrl, NULL, argp); 1555 break; 1556 case NVME_IOCTL_ADMIN64_CMD: 1557 ret = nvme_user_cmd64(ctrl, NULL, argp); 1558 break; 1559 default: 1560 ret = sed_ioctl(ctrl->opal_dev, cmd, argp); 1561 break; 1562 } 1563 nvme_put_ctrl(ctrl); 1564 return ret; 1565 } 1566 1567 static int nvme_ioctl(struct block_device *bdev, fmode_t mode, 1568 unsigned int cmd, unsigned long arg) 1569 { 1570 struct nvme_ns_head *head = NULL; 1571 void __user *argp = (void __user *)arg; 1572 struct nvme_ns *ns; 1573 int srcu_idx, ret; 1574 1575 ns = nvme_get_ns_from_disk(bdev->bd_disk, &head, &srcu_idx); 1576 if (unlikely(!ns)) 1577 return -EWOULDBLOCK; 1578 1579 /* 1580 * Handle ioctls that apply to the controller instead of the namespace 1581 * seperately and drop the ns SRCU reference early. This avoids a 1582 * deadlock when deleting namespaces using the passthrough interface. 1583 */ 1584 if (is_ctrl_ioctl(cmd)) 1585 return nvme_handle_ctrl_ioctl(ns, cmd, argp, head, srcu_idx); 1586 1587 switch (cmd) { 1588 case NVME_IOCTL_ID: 1589 force_successful_syscall_return(); 1590 ret = ns->head->ns_id; 1591 break; 1592 case NVME_IOCTL_IO_CMD: 1593 ret = nvme_user_cmd(ns->ctrl, ns, argp); 1594 break; 1595 case NVME_IOCTL_SUBMIT_IO: 1596 ret = nvme_submit_io(ns, argp); 1597 break; 1598 case NVME_IOCTL_IO64_CMD: 1599 ret = nvme_user_cmd64(ns->ctrl, ns, argp); 1600 break; 1601 default: 1602 if (ns->ndev) 1603 ret = nvme_nvm_ioctl(ns, cmd, arg); 1604 else 1605 ret = -ENOTTY; 1606 } 1607 1608 nvme_put_ns_from_disk(head, srcu_idx); 1609 return ret; 1610 } 1611 1612 #ifdef CONFIG_COMPAT 1613 struct nvme_user_io32 { 1614 __u8 opcode; 1615 __u8 flags; 1616 __u16 control; 1617 __u16 nblocks; 1618 __u16 rsvd; 1619 __u64 metadata; 1620 __u64 addr; 1621 __u64 slba; 1622 __u32 dsmgmt; 1623 __u32 reftag; 1624 __u16 apptag; 1625 __u16 appmask; 1626 } __attribute__((__packed__)); 1627 1628 #define NVME_IOCTL_SUBMIT_IO32 _IOW('N', 0x42, struct nvme_user_io32) 1629 1630 static int nvme_compat_ioctl(struct block_device *bdev, fmode_t mode, 1631 unsigned int cmd, unsigned long arg) 1632 { 1633 /* 1634 * Corresponds to the difference of NVME_IOCTL_SUBMIT_IO 1635 * between 32 bit programs and 64 bit kernel. 1636 * The cause is that the results of sizeof(struct nvme_user_io), 1637 * which is used to define NVME_IOCTL_SUBMIT_IO, 1638 * are not same between 32 bit compiler and 64 bit compiler. 1639 * NVME_IOCTL_SUBMIT_IO32 is for 64 bit kernel handling 1640 * NVME_IOCTL_SUBMIT_IO issued from 32 bit programs. 1641 * Other IOCTL numbers are same between 32 bit and 64 bit. 1642 * So there is nothing to do regarding to other IOCTL numbers. 1643 */ 1644 if (cmd == NVME_IOCTL_SUBMIT_IO32) 1645 return nvme_ioctl(bdev, mode, NVME_IOCTL_SUBMIT_IO, arg); 1646 1647 return nvme_ioctl(bdev, mode, cmd, arg); 1648 } 1649 #else 1650 #define nvme_compat_ioctl NULL 1651 #endif /* CONFIG_COMPAT */ 1652 1653 static int nvme_open(struct block_device *bdev, fmode_t mode) 1654 { 1655 struct nvme_ns *ns = bdev->bd_disk->private_data; 1656 1657 #ifdef CONFIG_NVME_MULTIPATH 1658 /* should never be called due to GENHD_FL_HIDDEN */ 1659 if (WARN_ON_ONCE(ns->head->disk)) 1660 goto fail; 1661 #endif 1662 if (!kref_get_unless_zero(&ns->kref)) 1663 goto fail; 1664 if (!try_module_get(ns->ctrl->ops->module)) 1665 goto fail_put_ns; 1666 1667 return 0; 1668 1669 fail_put_ns: 1670 nvme_put_ns(ns); 1671 fail: 1672 return -ENXIO; 1673 } 1674 1675 static void nvme_release(struct gendisk *disk, fmode_t mode) 1676 { 1677 struct nvme_ns *ns = disk->private_data; 1678 1679 module_put(ns->ctrl->ops->module); 1680 nvme_put_ns(ns); 1681 } 1682 1683 static int nvme_getgeo(struct block_device *bdev, struct hd_geometry *geo) 1684 { 1685 /* some standard values */ 1686 geo->heads = 1 << 6; 1687 geo->sectors = 1 << 5; 1688 geo->cylinders = get_capacity(bdev->bd_disk) >> 11; 1689 return 0; 1690 } 1691 1692 #ifdef CONFIG_BLK_DEV_INTEGRITY 1693 static void nvme_init_integrity(struct gendisk *disk, u16 ms, u8 pi_type, 1694 u32 max_integrity_segments) 1695 { 1696 struct blk_integrity integrity; 1697 1698 memset(&integrity, 0, sizeof(integrity)); 1699 switch (pi_type) { 1700 case NVME_NS_DPS_PI_TYPE3: 1701 integrity.profile = &t10_pi_type3_crc; 1702 integrity.tag_size = sizeof(u16) + sizeof(u32); 1703 integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE; 1704 break; 1705 case NVME_NS_DPS_PI_TYPE1: 1706 case NVME_NS_DPS_PI_TYPE2: 1707 integrity.profile = &t10_pi_type1_crc; 1708 integrity.tag_size = sizeof(u16); 1709 integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE; 1710 break; 1711 default: 1712 integrity.profile = NULL; 1713 break; 1714 } 1715 integrity.tuple_size = ms; 1716 blk_integrity_register(disk, &integrity); 1717 blk_queue_max_integrity_segments(disk->queue, max_integrity_segments); 1718 } 1719 #else 1720 static void nvme_init_integrity(struct gendisk *disk, u16 ms, u8 pi_type, 1721 u32 max_integrity_segments) 1722 { 1723 } 1724 #endif /* CONFIG_BLK_DEV_INTEGRITY */ 1725 1726 static void nvme_config_discard(struct gendisk *disk, struct nvme_ns *ns) 1727 { 1728 struct nvme_ctrl *ctrl = ns->ctrl; 1729 struct request_queue *queue = disk->queue; 1730 u32 size = queue_logical_block_size(queue); 1731 1732 if (!(ctrl->oncs & NVME_CTRL_ONCS_DSM)) { 1733 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, queue); 1734 return; 1735 } 1736 1737 if (ctrl->nr_streams && ns->sws && ns->sgs) 1738 size *= ns->sws * ns->sgs; 1739 1740 BUILD_BUG_ON(PAGE_SIZE / sizeof(struct nvme_dsm_range) < 1741 NVME_DSM_MAX_RANGES); 1742 1743 queue->limits.discard_alignment = 0; 1744 queue->limits.discard_granularity = size; 1745 1746 /* If discard is already enabled, don't reset queue limits */ 1747 if (blk_queue_flag_test_and_set(QUEUE_FLAG_DISCARD, queue)) 1748 return; 1749 1750 blk_queue_max_discard_sectors(queue, UINT_MAX); 1751 blk_queue_max_discard_segments(queue, NVME_DSM_MAX_RANGES); 1752 1753 if (ctrl->quirks & NVME_QUIRK_DEALLOCATE_ZEROES) 1754 blk_queue_max_write_zeroes_sectors(queue, UINT_MAX); 1755 } 1756 1757 static void nvme_config_write_zeroes(struct gendisk *disk, struct nvme_ns *ns) 1758 { 1759 u64 max_blocks; 1760 1761 if (!(ns->ctrl->oncs & NVME_CTRL_ONCS_WRITE_ZEROES) || 1762 (ns->ctrl->quirks & NVME_QUIRK_DISABLE_WRITE_ZEROES)) 1763 return; 1764 /* 1765 * Even though NVMe spec explicitly states that MDTS is not 1766 * applicable to the write-zeroes:- "The restriction does not apply to 1767 * commands that do not transfer data between the host and the 1768 * controller (e.g., Write Uncorrectable ro Write Zeroes command).". 1769 * In order to be more cautious use controller's max_hw_sectors value 1770 * to configure the maximum sectors for the write-zeroes which is 1771 * configured based on the controller's MDTS field in the 1772 * nvme_init_identify() if available. 1773 */ 1774 if (ns->ctrl->max_hw_sectors == UINT_MAX) 1775 max_blocks = (u64)USHRT_MAX + 1; 1776 else 1777 max_blocks = ns->ctrl->max_hw_sectors + 1; 1778 1779 blk_queue_max_write_zeroes_sectors(disk->queue, 1780 nvme_lba_to_sect(ns, max_blocks)); 1781 } 1782 1783 static int nvme_report_ns_ids(struct nvme_ctrl *ctrl, unsigned int nsid, 1784 struct nvme_id_ns *id, struct nvme_ns_ids *ids) 1785 { 1786 memset(ids, 0, sizeof(*ids)); 1787 1788 if (ctrl->vs >= NVME_VS(1, 1, 0)) 1789 memcpy(ids->eui64, id->eui64, sizeof(id->eui64)); 1790 if (ctrl->vs >= NVME_VS(1, 2, 0)) 1791 memcpy(ids->nguid, id->nguid, sizeof(id->nguid)); 1792 if (ctrl->vs >= NVME_VS(1, 3, 0)) 1793 return nvme_identify_ns_descs(ctrl, nsid, ids); 1794 return 0; 1795 } 1796 1797 static bool nvme_ns_ids_valid(struct nvme_ns_ids *ids) 1798 { 1799 return !uuid_is_null(&ids->uuid) || 1800 memchr_inv(ids->nguid, 0, sizeof(ids->nguid)) || 1801 memchr_inv(ids->eui64, 0, sizeof(ids->eui64)); 1802 } 1803 1804 static bool nvme_ns_ids_equal(struct nvme_ns_ids *a, struct nvme_ns_ids *b) 1805 { 1806 return uuid_equal(&a->uuid, &b->uuid) && 1807 memcmp(&a->nguid, &b->nguid, sizeof(a->nguid)) == 0 && 1808 memcmp(&a->eui64, &b->eui64, sizeof(a->eui64)) == 0; 1809 } 1810 1811 static int nvme_setup_streams_ns(struct nvme_ctrl *ctrl, struct nvme_ns *ns, 1812 u32 *phys_bs, u32 *io_opt) 1813 { 1814 struct streams_directive_params s; 1815 int ret; 1816 1817 if (!ctrl->nr_streams) 1818 return 0; 1819 1820 ret = nvme_get_stream_params(ctrl, &s, ns->head->ns_id); 1821 if (ret) 1822 return ret; 1823 1824 ns->sws = le32_to_cpu(s.sws); 1825 ns->sgs = le16_to_cpu(s.sgs); 1826 1827 if (ns->sws) { 1828 *phys_bs = ns->sws * (1 << ns->lba_shift); 1829 if (ns->sgs) 1830 *io_opt = *phys_bs * ns->sgs; 1831 } 1832 1833 return 0; 1834 } 1835 1836 static void nvme_update_disk_info(struct gendisk *disk, 1837 struct nvme_ns *ns, struct nvme_id_ns *id) 1838 { 1839 sector_t capacity = nvme_lba_to_sect(ns, le64_to_cpu(id->nsze)); 1840 unsigned short bs = 1 << ns->lba_shift; 1841 u32 atomic_bs, phys_bs, io_opt = 0; 1842 1843 if (ns->lba_shift > PAGE_SHIFT) { 1844 /* unsupported block size, set capacity to 0 later */ 1845 bs = (1 << 9); 1846 } 1847 blk_mq_freeze_queue(disk->queue); 1848 blk_integrity_unregister(disk); 1849 1850 atomic_bs = phys_bs = bs; 1851 nvme_setup_streams_ns(ns->ctrl, ns, &phys_bs, &io_opt); 1852 if (id->nabo == 0) { 1853 /* 1854 * Bit 1 indicates whether NAWUPF is defined for this namespace 1855 * and whether it should be used instead of AWUPF. If NAWUPF == 1856 * 0 then AWUPF must be used instead. 1857 */ 1858 if (id->nsfeat & NVME_NS_FEAT_ATOMICS && id->nawupf) 1859 atomic_bs = (1 + le16_to_cpu(id->nawupf)) * bs; 1860 else 1861 atomic_bs = (1 + ns->ctrl->subsys->awupf) * bs; 1862 } 1863 1864 if (id->nsfeat & NVME_NS_FEAT_IO_OPT) { 1865 /* NPWG = Namespace Preferred Write Granularity */ 1866 phys_bs = bs * (1 + le16_to_cpu(id->npwg)); 1867 /* NOWS = Namespace Optimal Write Size */ 1868 io_opt = bs * (1 + le16_to_cpu(id->nows)); 1869 } 1870 1871 blk_queue_logical_block_size(disk->queue, bs); 1872 /* 1873 * Linux filesystems assume writing a single physical block is 1874 * an atomic operation. Hence limit the physical block size to the 1875 * value of the Atomic Write Unit Power Fail parameter. 1876 */ 1877 blk_queue_physical_block_size(disk->queue, min(phys_bs, atomic_bs)); 1878 blk_queue_io_min(disk->queue, phys_bs); 1879 blk_queue_io_opt(disk->queue, io_opt); 1880 1881 /* 1882 * The block layer can't support LBA sizes larger than the page size 1883 * yet, so catch this early and don't allow block I/O. 1884 */ 1885 if (ns->lba_shift > PAGE_SHIFT) 1886 capacity = 0; 1887 1888 /* 1889 * Register a metadata profile for PI, or the plain non-integrity NVMe 1890 * metadata masquerading as Type 0 if supported, otherwise reject block 1891 * I/O to namespaces with metadata except when the namespace supports 1892 * PI, as it can strip/insert in that case. 1893 */ 1894 if (ns->ms) { 1895 if (IS_ENABLED(CONFIG_BLK_DEV_INTEGRITY) && 1896 (ns->features & NVME_NS_METADATA_SUPPORTED)) 1897 nvme_init_integrity(disk, ns->ms, ns->pi_type, 1898 ns->ctrl->max_integrity_segments); 1899 else if (!nvme_ns_has_pi(ns)) 1900 capacity = 0; 1901 } 1902 1903 set_capacity_revalidate_and_notify(disk, capacity, false); 1904 1905 nvme_config_discard(disk, ns); 1906 nvme_config_write_zeroes(disk, ns); 1907 1908 if (id->nsattr & NVME_NS_ATTR_RO) 1909 set_disk_ro(disk, true); 1910 else 1911 set_disk_ro(disk, false); 1912 1913 blk_mq_unfreeze_queue(disk->queue); 1914 } 1915 1916 static int __nvme_revalidate_disk(struct gendisk *disk, struct nvme_id_ns *id) 1917 { 1918 struct nvme_ns *ns = disk->private_data; 1919 struct nvme_ctrl *ctrl = ns->ctrl; 1920 u32 iob; 1921 1922 /* 1923 * If identify namespace failed, use default 512 byte block size so 1924 * block layer can use before failing read/write for 0 capacity. 1925 */ 1926 ns->lba_shift = id->lbaf[id->flbas & NVME_NS_FLBAS_LBA_MASK].ds; 1927 if (ns->lba_shift == 0) 1928 ns->lba_shift = 9; 1929 1930 if ((ctrl->quirks & NVME_QUIRK_STRIPE_SIZE) && 1931 is_power_of_2(ctrl->max_hw_sectors)) 1932 iob = ctrl->max_hw_sectors; 1933 else 1934 iob = nvme_lba_to_sect(ns, le16_to_cpu(id->noiob)); 1935 1936 ns->features = 0; 1937 ns->ms = le16_to_cpu(id->lbaf[id->flbas & NVME_NS_FLBAS_LBA_MASK].ms); 1938 /* the PI implementation requires metadata equal t10 pi tuple size */ 1939 if (ns->ms == sizeof(struct t10_pi_tuple)) 1940 ns->pi_type = id->dps & NVME_NS_DPS_PI_MASK; 1941 else 1942 ns->pi_type = 0; 1943 1944 if (ns->ms) { 1945 /* 1946 * For PCIe only the separate metadata pointer is supported, 1947 * as the block layer supplies metadata in a separate bio_vec 1948 * chain. For Fabrics, only metadata as part of extended data 1949 * LBA is supported on the wire per the Fabrics specification, 1950 * but the HBA/HCA will do the remapping from the separate 1951 * metadata buffers for us. 1952 */ 1953 if (id->flbas & NVME_NS_FLBAS_META_EXT) { 1954 ns->features |= NVME_NS_EXT_LBAS; 1955 if ((ctrl->ops->flags & NVME_F_FABRICS) && 1956 (ctrl->ops->flags & NVME_F_METADATA_SUPPORTED) && 1957 ctrl->max_integrity_segments) 1958 ns->features |= NVME_NS_METADATA_SUPPORTED; 1959 } else { 1960 if (WARN_ON_ONCE(ctrl->ops->flags & NVME_F_FABRICS)) 1961 return -EINVAL; 1962 if (ctrl->ops->flags & NVME_F_METADATA_SUPPORTED) 1963 ns->features |= NVME_NS_METADATA_SUPPORTED; 1964 } 1965 } 1966 1967 if (iob) 1968 blk_queue_chunk_sectors(ns->queue, rounddown_pow_of_two(iob)); 1969 nvme_update_disk_info(disk, ns, id); 1970 #ifdef CONFIG_NVME_MULTIPATH 1971 if (ns->head->disk) { 1972 nvme_update_disk_info(ns->head->disk, ns, id); 1973 blk_queue_stack_limits(ns->head->disk->queue, ns->queue); 1974 nvme_mpath_update_disk_size(ns->head->disk); 1975 } 1976 #endif 1977 return 0; 1978 } 1979 1980 static int nvme_revalidate_disk(struct gendisk *disk) 1981 { 1982 struct nvme_ns *ns = disk->private_data; 1983 struct nvme_ctrl *ctrl = ns->ctrl; 1984 struct nvme_id_ns *id; 1985 struct nvme_ns_ids ids; 1986 int ret = 0; 1987 1988 if (test_bit(NVME_NS_DEAD, &ns->flags)) { 1989 set_capacity(disk, 0); 1990 return -ENODEV; 1991 } 1992 1993 ret = nvme_identify_ns(ctrl, ns->head->ns_id, &id); 1994 if (ret) 1995 goto out; 1996 1997 if (id->ncap == 0) { 1998 ret = -ENODEV; 1999 goto free_id; 2000 } 2001 2002 ret = nvme_report_ns_ids(ctrl, ns->head->ns_id, id, &ids); 2003 if (ret) 2004 goto free_id; 2005 2006 if (!nvme_ns_ids_equal(&ns->head->ids, &ids)) { 2007 dev_err(ctrl->device, 2008 "identifiers changed for nsid %d\n", ns->head->ns_id); 2009 ret = -ENODEV; 2010 goto free_id; 2011 } 2012 2013 ret = __nvme_revalidate_disk(disk, id); 2014 free_id: 2015 kfree(id); 2016 out: 2017 /* 2018 * Only fail the function if we got a fatal error back from the 2019 * device, otherwise ignore the error and just move on. 2020 */ 2021 if (ret == -ENOMEM || (ret > 0 && !(ret & NVME_SC_DNR))) 2022 ret = 0; 2023 else if (ret > 0) 2024 ret = blk_status_to_errno(nvme_error_status(ret)); 2025 return ret; 2026 } 2027 2028 static char nvme_pr_type(enum pr_type type) 2029 { 2030 switch (type) { 2031 case PR_WRITE_EXCLUSIVE: 2032 return 1; 2033 case PR_EXCLUSIVE_ACCESS: 2034 return 2; 2035 case PR_WRITE_EXCLUSIVE_REG_ONLY: 2036 return 3; 2037 case PR_EXCLUSIVE_ACCESS_REG_ONLY: 2038 return 4; 2039 case PR_WRITE_EXCLUSIVE_ALL_REGS: 2040 return 5; 2041 case PR_EXCLUSIVE_ACCESS_ALL_REGS: 2042 return 6; 2043 default: 2044 return 0; 2045 } 2046 }; 2047 2048 static int nvme_pr_command(struct block_device *bdev, u32 cdw10, 2049 u64 key, u64 sa_key, u8 op) 2050 { 2051 struct nvme_ns_head *head = NULL; 2052 struct nvme_ns *ns; 2053 struct nvme_command c; 2054 int srcu_idx, ret; 2055 u8 data[16] = { 0, }; 2056 2057 ns = nvme_get_ns_from_disk(bdev->bd_disk, &head, &srcu_idx); 2058 if (unlikely(!ns)) 2059 return -EWOULDBLOCK; 2060 2061 put_unaligned_le64(key, &data[0]); 2062 put_unaligned_le64(sa_key, &data[8]); 2063 2064 memset(&c, 0, sizeof(c)); 2065 c.common.opcode = op; 2066 c.common.nsid = cpu_to_le32(ns->head->ns_id); 2067 c.common.cdw10 = cpu_to_le32(cdw10); 2068 2069 ret = nvme_submit_sync_cmd(ns->queue, &c, data, 16); 2070 nvme_put_ns_from_disk(head, srcu_idx); 2071 return ret; 2072 } 2073 2074 static int nvme_pr_register(struct block_device *bdev, u64 old, 2075 u64 new, unsigned flags) 2076 { 2077 u32 cdw10; 2078 2079 if (flags & ~PR_FL_IGNORE_KEY) 2080 return -EOPNOTSUPP; 2081 2082 cdw10 = old ? 2 : 0; 2083 cdw10 |= (flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0; 2084 cdw10 |= (1 << 30) | (1 << 31); /* PTPL=1 */ 2085 return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_register); 2086 } 2087 2088 static int nvme_pr_reserve(struct block_device *bdev, u64 key, 2089 enum pr_type type, unsigned flags) 2090 { 2091 u32 cdw10; 2092 2093 if (flags & ~PR_FL_IGNORE_KEY) 2094 return -EOPNOTSUPP; 2095 2096 cdw10 = nvme_pr_type(type) << 8; 2097 cdw10 |= ((flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0); 2098 return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_acquire); 2099 } 2100 2101 static int nvme_pr_preempt(struct block_device *bdev, u64 old, u64 new, 2102 enum pr_type type, bool abort) 2103 { 2104 u32 cdw10 = nvme_pr_type(type) << 8 | (abort ? 2 : 1); 2105 return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_acquire); 2106 } 2107 2108 static int nvme_pr_clear(struct block_device *bdev, u64 key) 2109 { 2110 u32 cdw10 = 1 | (key ? 1 << 3 : 0); 2111 return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_register); 2112 } 2113 2114 static int nvme_pr_release(struct block_device *bdev, u64 key, enum pr_type type) 2115 { 2116 u32 cdw10 = nvme_pr_type(type) << 8 | (key ? 1 << 3 : 0); 2117 return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_release); 2118 } 2119 2120 static const struct pr_ops nvme_pr_ops = { 2121 .pr_register = nvme_pr_register, 2122 .pr_reserve = nvme_pr_reserve, 2123 .pr_release = nvme_pr_release, 2124 .pr_preempt = nvme_pr_preempt, 2125 .pr_clear = nvme_pr_clear, 2126 }; 2127 2128 #ifdef CONFIG_BLK_SED_OPAL 2129 int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len, 2130 bool send) 2131 { 2132 struct nvme_ctrl *ctrl = data; 2133 struct nvme_command cmd; 2134 2135 memset(&cmd, 0, sizeof(cmd)); 2136 if (send) 2137 cmd.common.opcode = nvme_admin_security_send; 2138 else 2139 cmd.common.opcode = nvme_admin_security_recv; 2140 cmd.common.nsid = 0; 2141 cmd.common.cdw10 = cpu_to_le32(((u32)secp) << 24 | ((u32)spsp) << 8); 2142 cmd.common.cdw11 = cpu_to_le32(len); 2143 2144 return __nvme_submit_sync_cmd(ctrl->admin_q, &cmd, NULL, buffer, len, 2145 ADMIN_TIMEOUT, NVME_QID_ANY, 1, 0, false); 2146 } 2147 EXPORT_SYMBOL_GPL(nvme_sec_submit); 2148 #endif /* CONFIG_BLK_SED_OPAL */ 2149 2150 static const struct block_device_operations nvme_fops = { 2151 .owner = THIS_MODULE, 2152 .ioctl = nvme_ioctl, 2153 .compat_ioctl = nvme_compat_ioctl, 2154 .open = nvme_open, 2155 .release = nvme_release, 2156 .getgeo = nvme_getgeo, 2157 .revalidate_disk= nvme_revalidate_disk, 2158 .pr_ops = &nvme_pr_ops, 2159 }; 2160 2161 #ifdef CONFIG_NVME_MULTIPATH 2162 static int nvme_ns_head_open(struct block_device *bdev, fmode_t mode) 2163 { 2164 struct nvme_ns_head *head = bdev->bd_disk->private_data; 2165 2166 if (!kref_get_unless_zero(&head->ref)) 2167 return -ENXIO; 2168 return 0; 2169 } 2170 2171 static void nvme_ns_head_release(struct gendisk *disk, fmode_t mode) 2172 { 2173 nvme_put_ns_head(disk->private_data); 2174 } 2175 2176 const struct block_device_operations nvme_ns_head_ops = { 2177 .owner = THIS_MODULE, 2178 .submit_bio = nvme_ns_head_submit_bio, 2179 .open = nvme_ns_head_open, 2180 .release = nvme_ns_head_release, 2181 .ioctl = nvme_ioctl, 2182 .compat_ioctl = nvme_compat_ioctl, 2183 .getgeo = nvme_getgeo, 2184 .pr_ops = &nvme_pr_ops, 2185 }; 2186 #endif /* CONFIG_NVME_MULTIPATH */ 2187 2188 static int nvme_wait_ready(struct nvme_ctrl *ctrl, u64 cap, bool enabled) 2189 { 2190 unsigned long timeout = 2191 ((NVME_CAP_TIMEOUT(cap) + 1) * HZ / 2) + jiffies; 2192 u32 csts, bit = enabled ? NVME_CSTS_RDY : 0; 2193 int ret; 2194 2195 while ((ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts)) == 0) { 2196 if (csts == ~0) 2197 return -ENODEV; 2198 if ((csts & NVME_CSTS_RDY) == bit) 2199 break; 2200 2201 usleep_range(1000, 2000); 2202 if (fatal_signal_pending(current)) 2203 return -EINTR; 2204 if (time_after(jiffies, timeout)) { 2205 dev_err(ctrl->device, 2206 "Device not ready; aborting %s, CSTS=0x%x\n", 2207 enabled ? "initialisation" : "reset", csts); 2208 return -ENODEV; 2209 } 2210 } 2211 2212 return ret; 2213 } 2214 2215 /* 2216 * If the device has been passed off to us in an enabled state, just clear 2217 * the enabled bit. The spec says we should set the 'shutdown notification 2218 * bits', but doing so may cause the device to complete commands to the 2219 * admin queue ... and we don't know what memory that might be pointing at! 2220 */ 2221 int nvme_disable_ctrl(struct nvme_ctrl *ctrl) 2222 { 2223 int ret; 2224 2225 ctrl->ctrl_config &= ~NVME_CC_SHN_MASK; 2226 ctrl->ctrl_config &= ~NVME_CC_ENABLE; 2227 2228 ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config); 2229 if (ret) 2230 return ret; 2231 2232 if (ctrl->quirks & NVME_QUIRK_DELAY_BEFORE_CHK_RDY) 2233 msleep(NVME_QUIRK_DELAY_AMOUNT); 2234 2235 return nvme_wait_ready(ctrl, ctrl->cap, false); 2236 } 2237 EXPORT_SYMBOL_GPL(nvme_disable_ctrl); 2238 2239 int nvme_enable_ctrl(struct nvme_ctrl *ctrl) 2240 { 2241 /* 2242 * Default to a 4K page size, with the intention to update this 2243 * path in the future to accomodate architectures with differing 2244 * kernel and IO page sizes. 2245 */ 2246 unsigned dev_page_min, page_shift = 12; 2247 int ret; 2248 2249 ret = ctrl->ops->reg_read64(ctrl, NVME_REG_CAP, &ctrl->cap); 2250 if (ret) { 2251 dev_err(ctrl->device, "Reading CAP failed (%d)\n", ret); 2252 return ret; 2253 } 2254 dev_page_min = NVME_CAP_MPSMIN(ctrl->cap) + 12; 2255 2256 if (page_shift < dev_page_min) { 2257 dev_err(ctrl->device, 2258 "Minimum device page size %u too large for host (%u)\n", 2259 1 << dev_page_min, 1 << page_shift); 2260 return -ENODEV; 2261 } 2262 2263 ctrl->page_size = 1 << page_shift; 2264 2265 ctrl->ctrl_config = NVME_CC_CSS_NVM; 2266 ctrl->ctrl_config |= (page_shift - 12) << NVME_CC_MPS_SHIFT; 2267 ctrl->ctrl_config |= NVME_CC_AMS_RR | NVME_CC_SHN_NONE; 2268 ctrl->ctrl_config |= NVME_CC_IOSQES | NVME_CC_IOCQES; 2269 ctrl->ctrl_config |= NVME_CC_ENABLE; 2270 2271 ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config); 2272 if (ret) 2273 return ret; 2274 return nvme_wait_ready(ctrl, ctrl->cap, true); 2275 } 2276 EXPORT_SYMBOL_GPL(nvme_enable_ctrl); 2277 2278 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl) 2279 { 2280 unsigned long timeout = jiffies + (ctrl->shutdown_timeout * HZ); 2281 u32 csts; 2282 int ret; 2283 2284 ctrl->ctrl_config &= ~NVME_CC_SHN_MASK; 2285 ctrl->ctrl_config |= NVME_CC_SHN_NORMAL; 2286 2287 ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config); 2288 if (ret) 2289 return ret; 2290 2291 while ((ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts)) == 0) { 2292 if ((csts & NVME_CSTS_SHST_MASK) == NVME_CSTS_SHST_CMPLT) 2293 break; 2294 2295 msleep(100); 2296 if (fatal_signal_pending(current)) 2297 return -EINTR; 2298 if (time_after(jiffies, timeout)) { 2299 dev_err(ctrl->device, 2300 "Device shutdown incomplete; abort shutdown\n"); 2301 return -ENODEV; 2302 } 2303 } 2304 2305 return ret; 2306 } 2307 EXPORT_SYMBOL_GPL(nvme_shutdown_ctrl); 2308 2309 static void nvme_set_queue_limits(struct nvme_ctrl *ctrl, 2310 struct request_queue *q) 2311 { 2312 bool vwc = false; 2313 2314 if (ctrl->max_hw_sectors) { 2315 u32 max_segments = 2316 (ctrl->max_hw_sectors / (ctrl->page_size >> 9)) + 1; 2317 2318 max_segments = min_not_zero(max_segments, ctrl->max_segments); 2319 blk_queue_max_hw_sectors(q, ctrl->max_hw_sectors); 2320 blk_queue_max_segments(q, min_t(u32, max_segments, USHRT_MAX)); 2321 } 2322 blk_queue_virt_boundary(q, ctrl->page_size - 1); 2323 blk_queue_dma_alignment(q, 7); 2324 if (ctrl->vwc & NVME_CTRL_VWC_PRESENT) 2325 vwc = true; 2326 blk_queue_write_cache(q, vwc, vwc); 2327 } 2328 2329 static int nvme_configure_timestamp(struct nvme_ctrl *ctrl) 2330 { 2331 __le64 ts; 2332 int ret; 2333 2334 if (!(ctrl->oncs & NVME_CTRL_ONCS_TIMESTAMP)) 2335 return 0; 2336 2337 ts = cpu_to_le64(ktime_to_ms(ktime_get_real())); 2338 ret = nvme_set_features(ctrl, NVME_FEAT_TIMESTAMP, 0, &ts, sizeof(ts), 2339 NULL); 2340 if (ret) 2341 dev_warn_once(ctrl->device, 2342 "could not set timestamp (%d)\n", ret); 2343 return ret; 2344 } 2345 2346 static int nvme_configure_acre(struct nvme_ctrl *ctrl) 2347 { 2348 struct nvme_feat_host_behavior *host; 2349 int ret; 2350 2351 /* Don't bother enabling the feature if retry delay is not reported */ 2352 if (!ctrl->crdt[0]) 2353 return 0; 2354 2355 host = kzalloc(sizeof(*host), GFP_KERNEL); 2356 if (!host) 2357 return 0; 2358 2359 host->acre = NVME_ENABLE_ACRE; 2360 ret = nvme_set_features(ctrl, NVME_FEAT_HOST_BEHAVIOR, 0, 2361 host, sizeof(*host), NULL); 2362 kfree(host); 2363 return ret; 2364 } 2365 2366 static int nvme_configure_apst(struct nvme_ctrl *ctrl) 2367 { 2368 /* 2369 * APST (Autonomous Power State Transition) lets us program a 2370 * table of power state transitions that the controller will 2371 * perform automatically. We configure it with a simple 2372 * heuristic: we are willing to spend at most 2% of the time 2373 * transitioning between power states. Therefore, when running 2374 * in any given state, we will enter the next lower-power 2375 * non-operational state after waiting 50 * (enlat + exlat) 2376 * microseconds, as long as that state's exit latency is under 2377 * the requested maximum latency. 2378 * 2379 * We will not autonomously enter any non-operational state for 2380 * which the total latency exceeds ps_max_latency_us. Users 2381 * can set ps_max_latency_us to zero to turn off APST. 2382 */ 2383 2384 unsigned apste; 2385 struct nvme_feat_auto_pst *table; 2386 u64 max_lat_us = 0; 2387 int max_ps = -1; 2388 int ret; 2389 2390 /* 2391 * If APST isn't supported or if we haven't been initialized yet, 2392 * then don't do anything. 2393 */ 2394 if (!ctrl->apsta) 2395 return 0; 2396 2397 if (ctrl->npss > 31) { 2398 dev_warn(ctrl->device, "NPSS is invalid; not using APST\n"); 2399 return 0; 2400 } 2401 2402 table = kzalloc(sizeof(*table), GFP_KERNEL); 2403 if (!table) 2404 return 0; 2405 2406 if (!ctrl->apst_enabled || ctrl->ps_max_latency_us == 0) { 2407 /* Turn off APST. */ 2408 apste = 0; 2409 dev_dbg(ctrl->device, "APST disabled\n"); 2410 } else { 2411 __le64 target = cpu_to_le64(0); 2412 int state; 2413 2414 /* 2415 * Walk through all states from lowest- to highest-power. 2416 * According to the spec, lower-numbered states use more 2417 * power. NPSS, despite the name, is the index of the 2418 * lowest-power state, not the number of states. 2419 */ 2420 for (state = (int)ctrl->npss; state >= 0; state--) { 2421 u64 total_latency_us, exit_latency_us, transition_ms; 2422 2423 if (target) 2424 table->entries[state] = target; 2425 2426 /* 2427 * Don't allow transitions to the deepest state 2428 * if it's quirked off. 2429 */ 2430 if (state == ctrl->npss && 2431 (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS)) 2432 continue; 2433 2434 /* 2435 * Is this state a useful non-operational state for 2436 * higher-power states to autonomously transition to? 2437 */ 2438 if (!(ctrl->psd[state].flags & 2439 NVME_PS_FLAGS_NON_OP_STATE)) 2440 continue; 2441 2442 exit_latency_us = 2443 (u64)le32_to_cpu(ctrl->psd[state].exit_lat); 2444 if (exit_latency_us > ctrl->ps_max_latency_us) 2445 continue; 2446 2447 total_latency_us = 2448 exit_latency_us + 2449 le32_to_cpu(ctrl->psd[state].entry_lat); 2450 2451 /* 2452 * This state is good. Use it as the APST idle 2453 * target for higher power states. 2454 */ 2455 transition_ms = total_latency_us + 19; 2456 do_div(transition_ms, 20); 2457 if (transition_ms > (1 << 24) - 1) 2458 transition_ms = (1 << 24) - 1; 2459 2460 target = cpu_to_le64((state << 3) | 2461 (transition_ms << 8)); 2462 2463 if (max_ps == -1) 2464 max_ps = state; 2465 2466 if (total_latency_us > max_lat_us) 2467 max_lat_us = total_latency_us; 2468 } 2469 2470 apste = 1; 2471 2472 if (max_ps == -1) { 2473 dev_dbg(ctrl->device, "APST enabled but no non-operational states are available\n"); 2474 } else { 2475 dev_dbg(ctrl->device, "APST enabled: max PS = %d, max round-trip latency = %lluus, table = %*phN\n", 2476 max_ps, max_lat_us, (int)sizeof(*table), table); 2477 } 2478 } 2479 2480 ret = nvme_set_features(ctrl, NVME_FEAT_AUTO_PST, apste, 2481 table, sizeof(*table), NULL); 2482 if (ret) 2483 dev_err(ctrl->device, "failed to set APST feature (%d)\n", ret); 2484 2485 kfree(table); 2486 return ret; 2487 } 2488 2489 static void nvme_set_latency_tolerance(struct device *dev, s32 val) 2490 { 2491 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); 2492 u64 latency; 2493 2494 switch (val) { 2495 case PM_QOS_LATENCY_TOLERANCE_NO_CONSTRAINT: 2496 case PM_QOS_LATENCY_ANY: 2497 latency = U64_MAX; 2498 break; 2499 2500 default: 2501 latency = val; 2502 } 2503 2504 if (ctrl->ps_max_latency_us != latency) { 2505 ctrl->ps_max_latency_us = latency; 2506 nvme_configure_apst(ctrl); 2507 } 2508 } 2509 2510 struct nvme_core_quirk_entry { 2511 /* 2512 * NVMe model and firmware strings are padded with spaces. For 2513 * simplicity, strings in the quirk table are padded with NULLs 2514 * instead. 2515 */ 2516 u16 vid; 2517 const char *mn; 2518 const char *fr; 2519 unsigned long quirks; 2520 }; 2521 2522 static const struct nvme_core_quirk_entry core_quirks[] = { 2523 { 2524 /* 2525 * This Toshiba device seems to die using any APST states. See: 2526 * https://bugs.launchpad.net/ubuntu/+source/linux/+bug/1678184/comments/11 2527 */ 2528 .vid = 0x1179, 2529 .mn = "THNSF5256GPUK TOSHIBA", 2530 .quirks = NVME_QUIRK_NO_APST, 2531 }, 2532 { 2533 /* 2534 * This LiteON CL1-3D*-Q11 firmware version has a race 2535 * condition associated with actions related to suspend to idle 2536 * LiteON has resolved the problem in future firmware 2537 */ 2538 .vid = 0x14a4, 2539 .fr = "22301111", 2540 .quirks = NVME_QUIRK_SIMPLE_SUSPEND, 2541 } 2542 }; 2543 2544 /* match is null-terminated but idstr is space-padded. */ 2545 static bool string_matches(const char *idstr, const char *match, size_t len) 2546 { 2547 size_t matchlen; 2548 2549 if (!match) 2550 return true; 2551 2552 matchlen = strlen(match); 2553 WARN_ON_ONCE(matchlen > len); 2554 2555 if (memcmp(idstr, match, matchlen)) 2556 return false; 2557 2558 for (; matchlen < len; matchlen++) 2559 if (idstr[matchlen] != ' ') 2560 return false; 2561 2562 return true; 2563 } 2564 2565 static bool quirk_matches(const struct nvme_id_ctrl *id, 2566 const struct nvme_core_quirk_entry *q) 2567 { 2568 return q->vid == le16_to_cpu(id->vid) && 2569 string_matches(id->mn, q->mn, sizeof(id->mn)) && 2570 string_matches(id->fr, q->fr, sizeof(id->fr)); 2571 } 2572 2573 static void nvme_init_subnqn(struct nvme_subsystem *subsys, struct nvme_ctrl *ctrl, 2574 struct nvme_id_ctrl *id) 2575 { 2576 size_t nqnlen; 2577 int off; 2578 2579 if(!(ctrl->quirks & NVME_QUIRK_IGNORE_DEV_SUBNQN)) { 2580 nqnlen = strnlen(id->subnqn, NVMF_NQN_SIZE); 2581 if (nqnlen > 0 && nqnlen < NVMF_NQN_SIZE) { 2582 strlcpy(subsys->subnqn, id->subnqn, NVMF_NQN_SIZE); 2583 return; 2584 } 2585 2586 if (ctrl->vs >= NVME_VS(1, 2, 1)) 2587 dev_warn(ctrl->device, "missing or invalid SUBNQN field.\n"); 2588 } 2589 2590 /* Generate a "fake" NQN per Figure 254 in NVMe 1.3 + ECN 001 */ 2591 off = snprintf(subsys->subnqn, NVMF_NQN_SIZE, 2592 "nqn.2014.08.org.nvmexpress:%04x%04x", 2593 le16_to_cpu(id->vid), le16_to_cpu(id->ssvid)); 2594 memcpy(subsys->subnqn + off, id->sn, sizeof(id->sn)); 2595 off += sizeof(id->sn); 2596 memcpy(subsys->subnqn + off, id->mn, sizeof(id->mn)); 2597 off += sizeof(id->mn); 2598 memset(subsys->subnqn + off, 0, sizeof(subsys->subnqn) - off); 2599 } 2600 2601 static void nvme_release_subsystem(struct device *dev) 2602 { 2603 struct nvme_subsystem *subsys = 2604 container_of(dev, struct nvme_subsystem, dev); 2605 2606 if (subsys->instance >= 0) 2607 ida_simple_remove(&nvme_instance_ida, subsys->instance); 2608 kfree(subsys); 2609 } 2610 2611 static void nvme_destroy_subsystem(struct kref *ref) 2612 { 2613 struct nvme_subsystem *subsys = 2614 container_of(ref, struct nvme_subsystem, ref); 2615 2616 mutex_lock(&nvme_subsystems_lock); 2617 list_del(&subsys->entry); 2618 mutex_unlock(&nvme_subsystems_lock); 2619 2620 ida_destroy(&subsys->ns_ida); 2621 device_del(&subsys->dev); 2622 put_device(&subsys->dev); 2623 } 2624 2625 static void nvme_put_subsystem(struct nvme_subsystem *subsys) 2626 { 2627 kref_put(&subsys->ref, nvme_destroy_subsystem); 2628 } 2629 2630 static struct nvme_subsystem *__nvme_find_get_subsystem(const char *subsysnqn) 2631 { 2632 struct nvme_subsystem *subsys; 2633 2634 lockdep_assert_held(&nvme_subsystems_lock); 2635 2636 /* 2637 * Fail matches for discovery subsystems. This results 2638 * in each discovery controller bound to a unique subsystem. 2639 * This avoids issues with validating controller values 2640 * that can only be true when there is a single unique subsystem. 2641 * There may be multiple and completely independent entities 2642 * that provide discovery controllers. 2643 */ 2644 if (!strcmp(subsysnqn, NVME_DISC_SUBSYS_NAME)) 2645 return NULL; 2646 2647 list_for_each_entry(subsys, &nvme_subsystems, entry) { 2648 if (strcmp(subsys->subnqn, subsysnqn)) 2649 continue; 2650 if (!kref_get_unless_zero(&subsys->ref)) 2651 continue; 2652 return subsys; 2653 } 2654 2655 return NULL; 2656 } 2657 2658 #define SUBSYS_ATTR_RO(_name, _mode, _show) \ 2659 struct device_attribute subsys_attr_##_name = \ 2660 __ATTR(_name, _mode, _show, NULL) 2661 2662 static ssize_t nvme_subsys_show_nqn(struct device *dev, 2663 struct device_attribute *attr, 2664 char *buf) 2665 { 2666 struct nvme_subsystem *subsys = 2667 container_of(dev, struct nvme_subsystem, dev); 2668 2669 return snprintf(buf, PAGE_SIZE, "%s\n", subsys->subnqn); 2670 } 2671 static SUBSYS_ATTR_RO(subsysnqn, S_IRUGO, nvme_subsys_show_nqn); 2672 2673 #define nvme_subsys_show_str_function(field) \ 2674 static ssize_t subsys_##field##_show(struct device *dev, \ 2675 struct device_attribute *attr, char *buf) \ 2676 { \ 2677 struct nvme_subsystem *subsys = \ 2678 container_of(dev, struct nvme_subsystem, dev); \ 2679 return sprintf(buf, "%.*s\n", \ 2680 (int)sizeof(subsys->field), subsys->field); \ 2681 } \ 2682 static SUBSYS_ATTR_RO(field, S_IRUGO, subsys_##field##_show); 2683 2684 nvme_subsys_show_str_function(model); 2685 nvme_subsys_show_str_function(serial); 2686 nvme_subsys_show_str_function(firmware_rev); 2687 2688 static struct attribute *nvme_subsys_attrs[] = { 2689 &subsys_attr_model.attr, 2690 &subsys_attr_serial.attr, 2691 &subsys_attr_firmware_rev.attr, 2692 &subsys_attr_subsysnqn.attr, 2693 #ifdef CONFIG_NVME_MULTIPATH 2694 &subsys_attr_iopolicy.attr, 2695 #endif 2696 NULL, 2697 }; 2698 2699 static struct attribute_group nvme_subsys_attrs_group = { 2700 .attrs = nvme_subsys_attrs, 2701 }; 2702 2703 static const struct attribute_group *nvme_subsys_attrs_groups[] = { 2704 &nvme_subsys_attrs_group, 2705 NULL, 2706 }; 2707 2708 static bool nvme_validate_cntlid(struct nvme_subsystem *subsys, 2709 struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id) 2710 { 2711 struct nvme_ctrl *tmp; 2712 2713 lockdep_assert_held(&nvme_subsystems_lock); 2714 2715 list_for_each_entry(tmp, &subsys->ctrls, subsys_entry) { 2716 if (nvme_state_terminal(tmp)) 2717 continue; 2718 2719 if (tmp->cntlid == ctrl->cntlid) { 2720 dev_err(ctrl->device, 2721 "Duplicate cntlid %u with %s, rejecting\n", 2722 ctrl->cntlid, dev_name(tmp->device)); 2723 return false; 2724 } 2725 2726 if ((id->cmic & NVME_CTRL_CMIC_MULTI_CTRL) || 2727 (ctrl->opts && ctrl->opts->discovery_nqn)) 2728 continue; 2729 2730 dev_err(ctrl->device, 2731 "Subsystem does not support multiple controllers\n"); 2732 return false; 2733 } 2734 2735 return true; 2736 } 2737 2738 static int nvme_init_subsystem(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id) 2739 { 2740 struct nvme_subsystem *subsys, *found; 2741 int ret; 2742 2743 subsys = kzalloc(sizeof(*subsys), GFP_KERNEL); 2744 if (!subsys) 2745 return -ENOMEM; 2746 2747 subsys->instance = -1; 2748 mutex_init(&subsys->lock); 2749 kref_init(&subsys->ref); 2750 INIT_LIST_HEAD(&subsys->ctrls); 2751 INIT_LIST_HEAD(&subsys->nsheads); 2752 nvme_init_subnqn(subsys, ctrl, id); 2753 memcpy(subsys->serial, id->sn, sizeof(subsys->serial)); 2754 memcpy(subsys->model, id->mn, sizeof(subsys->model)); 2755 memcpy(subsys->firmware_rev, id->fr, sizeof(subsys->firmware_rev)); 2756 subsys->vendor_id = le16_to_cpu(id->vid); 2757 subsys->cmic = id->cmic; 2758 subsys->awupf = le16_to_cpu(id->awupf); 2759 #ifdef CONFIG_NVME_MULTIPATH 2760 subsys->iopolicy = NVME_IOPOLICY_NUMA; 2761 #endif 2762 2763 subsys->dev.class = nvme_subsys_class; 2764 subsys->dev.release = nvme_release_subsystem; 2765 subsys->dev.groups = nvme_subsys_attrs_groups; 2766 dev_set_name(&subsys->dev, "nvme-subsys%d", ctrl->instance); 2767 device_initialize(&subsys->dev); 2768 2769 mutex_lock(&nvme_subsystems_lock); 2770 found = __nvme_find_get_subsystem(subsys->subnqn); 2771 if (found) { 2772 put_device(&subsys->dev); 2773 subsys = found; 2774 2775 if (!nvme_validate_cntlid(subsys, ctrl, id)) { 2776 ret = -EINVAL; 2777 goto out_put_subsystem; 2778 } 2779 } else { 2780 ret = device_add(&subsys->dev); 2781 if (ret) { 2782 dev_err(ctrl->device, 2783 "failed to register subsystem device.\n"); 2784 put_device(&subsys->dev); 2785 goto out_unlock; 2786 } 2787 ida_init(&subsys->ns_ida); 2788 list_add_tail(&subsys->entry, &nvme_subsystems); 2789 } 2790 2791 ret = sysfs_create_link(&subsys->dev.kobj, &ctrl->device->kobj, 2792 dev_name(ctrl->device)); 2793 if (ret) { 2794 dev_err(ctrl->device, 2795 "failed to create sysfs link from subsystem.\n"); 2796 goto out_put_subsystem; 2797 } 2798 2799 if (!found) 2800 subsys->instance = ctrl->instance; 2801 ctrl->subsys = subsys; 2802 list_add_tail(&ctrl->subsys_entry, &subsys->ctrls); 2803 mutex_unlock(&nvme_subsystems_lock); 2804 return 0; 2805 2806 out_put_subsystem: 2807 nvme_put_subsystem(subsys); 2808 out_unlock: 2809 mutex_unlock(&nvme_subsystems_lock); 2810 return ret; 2811 } 2812 2813 int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, 2814 void *log, size_t size, u64 offset) 2815 { 2816 struct nvme_command c = { }; 2817 u32 dwlen = nvme_bytes_to_numd(size); 2818 2819 c.get_log_page.opcode = nvme_admin_get_log_page; 2820 c.get_log_page.nsid = cpu_to_le32(nsid); 2821 c.get_log_page.lid = log_page; 2822 c.get_log_page.lsp = lsp; 2823 c.get_log_page.numdl = cpu_to_le16(dwlen & ((1 << 16) - 1)); 2824 c.get_log_page.numdu = cpu_to_le16(dwlen >> 16); 2825 c.get_log_page.lpol = cpu_to_le32(lower_32_bits(offset)); 2826 c.get_log_page.lpou = cpu_to_le32(upper_32_bits(offset)); 2827 2828 return nvme_submit_sync_cmd(ctrl->admin_q, &c, log, size); 2829 } 2830 2831 static int nvme_get_effects_log(struct nvme_ctrl *ctrl) 2832 { 2833 int ret; 2834 2835 if (!ctrl->effects) 2836 ctrl->effects = kzalloc(sizeof(*ctrl->effects), GFP_KERNEL); 2837 2838 if (!ctrl->effects) 2839 return 0; 2840 2841 ret = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CMD_EFFECTS, 0, 2842 ctrl->effects, sizeof(*ctrl->effects), 0); 2843 if (ret) { 2844 kfree(ctrl->effects); 2845 ctrl->effects = NULL; 2846 } 2847 return ret; 2848 } 2849 2850 /* 2851 * Initialize the cached copies of the Identify data and various controller 2852 * register in our nvme_ctrl structure. This should be called as soon as 2853 * the admin queue is fully up and running. 2854 */ 2855 int nvme_init_identify(struct nvme_ctrl *ctrl) 2856 { 2857 struct nvme_id_ctrl *id; 2858 int ret, page_shift; 2859 u32 max_hw_sectors; 2860 bool prev_apst_enabled; 2861 2862 ret = ctrl->ops->reg_read32(ctrl, NVME_REG_VS, &ctrl->vs); 2863 if (ret) { 2864 dev_err(ctrl->device, "Reading VS failed (%d)\n", ret); 2865 return ret; 2866 } 2867 page_shift = NVME_CAP_MPSMIN(ctrl->cap) + 12; 2868 ctrl->sqsize = min_t(int, NVME_CAP_MQES(ctrl->cap), ctrl->sqsize); 2869 2870 if (ctrl->vs >= NVME_VS(1, 1, 0)) 2871 ctrl->subsystem = NVME_CAP_NSSRC(ctrl->cap); 2872 2873 ret = nvme_identify_ctrl(ctrl, &id); 2874 if (ret) { 2875 dev_err(ctrl->device, "Identify Controller failed (%d)\n", ret); 2876 return -EIO; 2877 } 2878 2879 if (id->lpa & NVME_CTRL_LPA_CMD_EFFECTS_LOG) { 2880 ret = nvme_get_effects_log(ctrl); 2881 if (ret < 0) 2882 goto out_free; 2883 } 2884 2885 if (!(ctrl->ops->flags & NVME_F_FABRICS)) 2886 ctrl->cntlid = le16_to_cpu(id->cntlid); 2887 2888 if (!ctrl->identified) { 2889 int i; 2890 2891 ret = nvme_init_subsystem(ctrl, id); 2892 if (ret) 2893 goto out_free; 2894 2895 /* 2896 * Check for quirks. Quirk can depend on firmware version, 2897 * so, in principle, the set of quirks present can change 2898 * across a reset. As a possible future enhancement, we 2899 * could re-scan for quirks every time we reinitialize 2900 * the device, but we'd have to make sure that the driver 2901 * behaves intelligently if the quirks change. 2902 */ 2903 for (i = 0; i < ARRAY_SIZE(core_quirks); i++) { 2904 if (quirk_matches(id, &core_quirks[i])) 2905 ctrl->quirks |= core_quirks[i].quirks; 2906 } 2907 } 2908 2909 if (force_apst && (ctrl->quirks & NVME_QUIRK_NO_DEEPEST_PS)) { 2910 dev_warn(ctrl->device, "forcibly allowing all power states due to nvme_core.force_apst -- use at your own risk\n"); 2911 ctrl->quirks &= ~NVME_QUIRK_NO_DEEPEST_PS; 2912 } 2913 2914 ctrl->crdt[0] = le16_to_cpu(id->crdt1); 2915 ctrl->crdt[1] = le16_to_cpu(id->crdt2); 2916 ctrl->crdt[2] = le16_to_cpu(id->crdt3); 2917 2918 ctrl->oacs = le16_to_cpu(id->oacs); 2919 ctrl->oncs = le16_to_cpu(id->oncs); 2920 ctrl->mtfa = le16_to_cpu(id->mtfa); 2921 ctrl->oaes = le32_to_cpu(id->oaes); 2922 ctrl->wctemp = le16_to_cpu(id->wctemp); 2923 ctrl->cctemp = le16_to_cpu(id->cctemp); 2924 2925 atomic_set(&ctrl->abort_limit, id->acl + 1); 2926 ctrl->vwc = id->vwc; 2927 if (id->mdts) 2928 max_hw_sectors = 1 << (id->mdts + page_shift - 9); 2929 else 2930 max_hw_sectors = UINT_MAX; 2931 ctrl->max_hw_sectors = 2932 min_not_zero(ctrl->max_hw_sectors, max_hw_sectors); 2933 2934 nvme_set_queue_limits(ctrl, ctrl->admin_q); 2935 ctrl->sgls = le32_to_cpu(id->sgls); 2936 ctrl->kas = le16_to_cpu(id->kas); 2937 ctrl->max_namespaces = le32_to_cpu(id->mnan); 2938 ctrl->ctratt = le32_to_cpu(id->ctratt); 2939 2940 if (id->rtd3e) { 2941 /* us -> s */ 2942 u32 transition_time = le32_to_cpu(id->rtd3e) / 1000000; 2943 2944 ctrl->shutdown_timeout = clamp_t(unsigned int, transition_time, 2945 shutdown_timeout, 60); 2946 2947 if (ctrl->shutdown_timeout != shutdown_timeout) 2948 dev_info(ctrl->device, 2949 "Shutdown timeout set to %u seconds\n", 2950 ctrl->shutdown_timeout); 2951 } else 2952 ctrl->shutdown_timeout = shutdown_timeout; 2953 2954 ctrl->npss = id->npss; 2955 ctrl->apsta = id->apsta; 2956 prev_apst_enabled = ctrl->apst_enabled; 2957 if (ctrl->quirks & NVME_QUIRK_NO_APST) { 2958 if (force_apst && id->apsta) { 2959 dev_warn(ctrl->device, "forcibly allowing APST due to nvme_core.force_apst -- use at your own risk\n"); 2960 ctrl->apst_enabled = true; 2961 } else { 2962 ctrl->apst_enabled = false; 2963 } 2964 } else { 2965 ctrl->apst_enabled = id->apsta; 2966 } 2967 memcpy(ctrl->psd, id->psd, sizeof(ctrl->psd)); 2968 2969 if (ctrl->ops->flags & NVME_F_FABRICS) { 2970 ctrl->icdoff = le16_to_cpu(id->icdoff); 2971 ctrl->ioccsz = le32_to_cpu(id->ioccsz); 2972 ctrl->iorcsz = le32_to_cpu(id->iorcsz); 2973 ctrl->maxcmd = le16_to_cpu(id->maxcmd); 2974 2975 /* 2976 * In fabrics we need to verify the cntlid matches the 2977 * admin connect 2978 */ 2979 if (ctrl->cntlid != le16_to_cpu(id->cntlid)) { 2980 dev_err(ctrl->device, 2981 "Mismatching cntlid: Connect %u vs Identify " 2982 "%u, rejecting\n", 2983 ctrl->cntlid, le16_to_cpu(id->cntlid)); 2984 ret = -EINVAL; 2985 goto out_free; 2986 } 2987 2988 if (!ctrl->opts->discovery_nqn && !ctrl->kas) { 2989 dev_err(ctrl->device, 2990 "keep-alive support is mandatory for fabrics\n"); 2991 ret = -EINVAL; 2992 goto out_free; 2993 } 2994 } else { 2995 ctrl->hmpre = le32_to_cpu(id->hmpre); 2996 ctrl->hmmin = le32_to_cpu(id->hmmin); 2997 ctrl->hmminds = le32_to_cpu(id->hmminds); 2998 ctrl->hmmaxd = le16_to_cpu(id->hmmaxd); 2999 } 3000 3001 ret = nvme_mpath_init(ctrl, id); 3002 kfree(id); 3003 3004 if (ret < 0) 3005 return ret; 3006 3007 if (ctrl->apst_enabled && !prev_apst_enabled) 3008 dev_pm_qos_expose_latency_tolerance(ctrl->device); 3009 else if (!ctrl->apst_enabled && prev_apst_enabled) 3010 dev_pm_qos_hide_latency_tolerance(ctrl->device); 3011 3012 ret = nvme_configure_apst(ctrl); 3013 if (ret < 0) 3014 return ret; 3015 3016 ret = nvme_configure_timestamp(ctrl); 3017 if (ret < 0) 3018 return ret; 3019 3020 ret = nvme_configure_directives(ctrl); 3021 if (ret < 0) 3022 return ret; 3023 3024 ret = nvme_configure_acre(ctrl); 3025 if (ret < 0) 3026 return ret; 3027 3028 if (!ctrl->identified) 3029 nvme_hwmon_init(ctrl); 3030 3031 ctrl->identified = true; 3032 3033 return 0; 3034 3035 out_free: 3036 kfree(id); 3037 return ret; 3038 } 3039 EXPORT_SYMBOL_GPL(nvme_init_identify); 3040 3041 static int nvme_dev_open(struct inode *inode, struct file *file) 3042 { 3043 struct nvme_ctrl *ctrl = 3044 container_of(inode->i_cdev, struct nvme_ctrl, cdev); 3045 3046 switch (ctrl->state) { 3047 case NVME_CTRL_LIVE: 3048 break; 3049 default: 3050 return -EWOULDBLOCK; 3051 } 3052 3053 file->private_data = ctrl; 3054 return 0; 3055 } 3056 3057 static int nvme_dev_user_cmd(struct nvme_ctrl *ctrl, void __user *argp) 3058 { 3059 struct nvme_ns *ns; 3060 int ret; 3061 3062 down_read(&ctrl->namespaces_rwsem); 3063 if (list_empty(&ctrl->namespaces)) { 3064 ret = -ENOTTY; 3065 goto out_unlock; 3066 } 3067 3068 ns = list_first_entry(&ctrl->namespaces, struct nvme_ns, list); 3069 if (ns != list_last_entry(&ctrl->namespaces, struct nvme_ns, list)) { 3070 dev_warn(ctrl->device, 3071 "NVME_IOCTL_IO_CMD not supported when multiple namespaces present!\n"); 3072 ret = -EINVAL; 3073 goto out_unlock; 3074 } 3075 3076 dev_warn(ctrl->device, 3077 "using deprecated NVME_IOCTL_IO_CMD ioctl on the char device!\n"); 3078 kref_get(&ns->kref); 3079 up_read(&ctrl->namespaces_rwsem); 3080 3081 ret = nvme_user_cmd(ctrl, ns, argp); 3082 nvme_put_ns(ns); 3083 return ret; 3084 3085 out_unlock: 3086 up_read(&ctrl->namespaces_rwsem); 3087 return ret; 3088 } 3089 3090 static long nvme_dev_ioctl(struct file *file, unsigned int cmd, 3091 unsigned long arg) 3092 { 3093 struct nvme_ctrl *ctrl = file->private_data; 3094 void __user *argp = (void __user *)arg; 3095 3096 switch (cmd) { 3097 case NVME_IOCTL_ADMIN_CMD: 3098 return nvme_user_cmd(ctrl, NULL, argp); 3099 case NVME_IOCTL_ADMIN64_CMD: 3100 return nvme_user_cmd64(ctrl, NULL, argp); 3101 case NVME_IOCTL_IO_CMD: 3102 return nvme_dev_user_cmd(ctrl, argp); 3103 case NVME_IOCTL_RESET: 3104 dev_warn(ctrl->device, "resetting controller\n"); 3105 return nvme_reset_ctrl_sync(ctrl); 3106 case NVME_IOCTL_SUBSYS_RESET: 3107 return nvme_reset_subsystem(ctrl); 3108 case NVME_IOCTL_RESCAN: 3109 nvme_queue_scan(ctrl); 3110 return 0; 3111 default: 3112 return -ENOTTY; 3113 } 3114 } 3115 3116 static const struct file_operations nvme_dev_fops = { 3117 .owner = THIS_MODULE, 3118 .open = nvme_dev_open, 3119 .unlocked_ioctl = nvme_dev_ioctl, 3120 .compat_ioctl = compat_ptr_ioctl, 3121 }; 3122 3123 static ssize_t nvme_sysfs_reset(struct device *dev, 3124 struct device_attribute *attr, const char *buf, 3125 size_t count) 3126 { 3127 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); 3128 int ret; 3129 3130 ret = nvme_reset_ctrl_sync(ctrl); 3131 if (ret < 0) 3132 return ret; 3133 return count; 3134 } 3135 static DEVICE_ATTR(reset_controller, S_IWUSR, NULL, nvme_sysfs_reset); 3136 3137 static ssize_t nvme_sysfs_rescan(struct device *dev, 3138 struct device_attribute *attr, const char *buf, 3139 size_t count) 3140 { 3141 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); 3142 3143 nvme_queue_scan(ctrl); 3144 return count; 3145 } 3146 static DEVICE_ATTR(rescan_controller, S_IWUSR, NULL, nvme_sysfs_rescan); 3147 3148 static inline struct nvme_ns_head *dev_to_ns_head(struct device *dev) 3149 { 3150 struct gendisk *disk = dev_to_disk(dev); 3151 3152 if (disk->fops == &nvme_fops) 3153 return nvme_get_ns_from_dev(dev)->head; 3154 else 3155 return disk->private_data; 3156 } 3157 3158 static ssize_t wwid_show(struct device *dev, struct device_attribute *attr, 3159 char *buf) 3160 { 3161 struct nvme_ns_head *head = dev_to_ns_head(dev); 3162 struct nvme_ns_ids *ids = &head->ids; 3163 struct nvme_subsystem *subsys = head->subsys; 3164 int serial_len = sizeof(subsys->serial); 3165 int model_len = sizeof(subsys->model); 3166 3167 if (!uuid_is_null(&ids->uuid)) 3168 return sprintf(buf, "uuid.%pU\n", &ids->uuid); 3169 3170 if (memchr_inv(ids->nguid, 0, sizeof(ids->nguid))) 3171 return sprintf(buf, "eui.%16phN\n", ids->nguid); 3172 3173 if (memchr_inv(ids->eui64, 0, sizeof(ids->eui64))) 3174 return sprintf(buf, "eui.%8phN\n", ids->eui64); 3175 3176 while (serial_len > 0 && (subsys->serial[serial_len - 1] == ' ' || 3177 subsys->serial[serial_len - 1] == '\0')) 3178 serial_len--; 3179 while (model_len > 0 && (subsys->model[model_len - 1] == ' ' || 3180 subsys->model[model_len - 1] == '\0')) 3181 model_len--; 3182 3183 return sprintf(buf, "nvme.%04x-%*phN-%*phN-%08x\n", subsys->vendor_id, 3184 serial_len, subsys->serial, model_len, subsys->model, 3185 head->ns_id); 3186 } 3187 static DEVICE_ATTR_RO(wwid); 3188 3189 static ssize_t nguid_show(struct device *dev, struct device_attribute *attr, 3190 char *buf) 3191 { 3192 return sprintf(buf, "%pU\n", dev_to_ns_head(dev)->ids.nguid); 3193 } 3194 static DEVICE_ATTR_RO(nguid); 3195 3196 static ssize_t uuid_show(struct device *dev, struct device_attribute *attr, 3197 char *buf) 3198 { 3199 struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids; 3200 3201 /* For backward compatibility expose the NGUID to userspace if 3202 * we have no UUID set 3203 */ 3204 if (uuid_is_null(&ids->uuid)) { 3205 printk_ratelimited(KERN_WARNING 3206 "No UUID available providing old NGUID\n"); 3207 return sprintf(buf, "%pU\n", ids->nguid); 3208 } 3209 return sprintf(buf, "%pU\n", &ids->uuid); 3210 } 3211 static DEVICE_ATTR_RO(uuid); 3212 3213 static ssize_t eui_show(struct device *dev, struct device_attribute *attr, 3214 char *buf) 3215 { 3216 return sprintf(buf, "%8ph\n", dev_to_ns_head(dev)->ids.eui64); 3217 } 3218 static DEVICE_ATTR_RO(eui); 3219 3220 static ssize_t nsid_show(struct device *dev, struct device_attribute *attr, 3221 char *buf) 3222 { 3223 return sprintf(buf, "%d\n", dev_to_ns_head(dev)->ns_id); 3224 } 3225 static DEVICE_ATTR_RO(nsid); 3226 3227 static struct attribute *nvme_ns_id_attrs[] = { 3228 &dev_attr_wwid.attr, 3229 &dev_attr_uuid.attr, 3230 &dev_attr_nguid.attr, 3231 &dev_attr_eui.attr, 3232 &dev_attr_nsid.attr, 3233 #ifdef CONFIG_NVME_MULTIPATH 3234 &dev_attr_ana_grpid.attr, 3235 &dev_attr_ana_state.attr, 3236 #endif 3237 NULL, 3238 }; 3239 3240 static umode_t nvme_ns_id_attrs_are_visible(struct kobject *kobj, 3241 struct attribute *a, int n) 3242 { 3243 struct device *dev = container_of(kobj, struct device, kobj); 3244 struct nvme_ns_ids *ids = &dev_to_ns_head(dev)->ids; 3245 3246 if (a == &dev_attr_uuid.attr) { 3247 if (uuid_is_null(&ids->uuid) && 3248 !memchr_inv(ids->nguid, 0, sizeof(ids->nguid))) 3249 return 0; 3250 } 3251 if (a == &dev_attr_nguid.attr) { 3252 if (!memchr_inv(ids->nguid, 0, sizeof(ids->nguid))) 3253 return 0; 3254 } 3255 if (a == &dev_attr_eui.attr) { 3256 if (!memchr_inv(ids->eui64, 0, sizeof(ids->eui64))) 3257 return 0; 3258 } 3259 #ifdef CONFIG_NVME_MULTIPATH 3260 if (a == &dev_attr_ana_grpid.attr || a == &dev_attr_ana_state.attr) { 3261 if (dev_to_disk(dev)->fops != &nvme_fops) /* per-path attr */ 3262 return 0; 3263 if (!nvme_ctrl_use_ana(nvme_get_ns_from_dev(dev)->ctrl)) 3264 return 0; 3265 } 3266 #endif 3267 return a->mode; 3268 } 3269 3270 static const struct attribute_group nvme_ns_id_attr_group = { 3271 .attrs = nvme_ns_id_attrs, 3272 .is_visible = nvme_ns_id_attrs_are_visible, 3273 }; 3274 3275 const struct attribute_group *nvme_ns_id_attr_groups[] = { 3276 &nvme_ns_id_attr_group, 3277 #ifdef CONFIG_NVM 3278 &nvme_nvm_attr_group, 3279 #endif 3280 NULL, 3281 }; 3282 3283 #define nvme_show_str_function(field) \ 3284 static ssize_t field##_show(struct device *dev, \ 3285 struct device_attribute *attr, char *buf) \ 3286 { \ 3287 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); \ 3288 return sprintf(buf, "%.*s\n", \ 3289 (int)sizeof(ctrl->subsys->field), ctrl->subsys->field); \ 3290 } \ 3291 static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL); 3292 3293 nvme_show_str_function(model); 3294 nvme_show_str_function(serial); 3295 nvme_show_str_function(firmware_rev); 3296 3297 #define nvme_show_int_function(field) \ 3298 static ssize_t field##_show(struct device *dev, \ 3299 struct device_attribute *attr, char *buf) \ 3300 { \ 3301 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); \ 3302 return sprintf(buf, "%d\n", ctrl->field); \ 3303 } \ 3304 static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL); 3305 3306 nvme_show_int_function(cntlid); 3307 nvme_show_int_function(numa_node); 3308 nvme_show_int_function(queue_count); 3309 nvme_show_int_function(sqsize); 3310 3311 static ssize_t nvme_sysfs_delete(struct device *dev, 3312 struct device_attribute *attr, const char *buf, 3313 size_t count) 3314 { 3315 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); 3316 3317 /* Can't delete non-created controllers */ 3318 if (!ctrl->created) 3319 return -EBUSY; 3320 3321 if (device_remove_file_self(dev, attr)) 3322 nvme_delete_ctrl_sync(ctrl); 3323 return count; 3324 } 3325 static DEVICE_ATTR(delete_controller, S_IWUSR, NULL, nvme_sysfs_delete); 3326 3327 static ssize_t nvme_sysfs_show_transport(struct device *dev, 3328 struct device_attribute *attr, 3329 char *buf) 3330 { 3331 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); 3332 3333 return snprintf(buf, PAGE_SIZE, "%s\n", ctrl->ops->name); 3334 } 3335 static DEVICE_ATTR(transport, S_IRUGO, nvme_sysfs_show_transport, NULL); 3336 3337 static ssize_t nvme_sysfs_show_state(struct device *dev, 3338 struct device_attribute *attr, 3339 char *buf) 3340 { 3341 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); 3342 static const char *const state_name[] = { 3343 [NVME_CTRL_NEW] = "new", 3344 [NVME_CTRL_LIVE] = "live", 3345 [NVME_CTRL_RESETTING] = "resetting", 3346 [NVME_CTRL_CONNECTING] = "connecting", 3347 [NVME_CTRL_DELETING] = "deleting", 3348 [NVME_CTRL_DEAD] = "dead", 3349 }; 3350 3351 if ((unsigned)ctrl->state < ARRAY_SIZE(state_name) && 3352 state_name[ctrl->state]) 3353 return sprintf(buf, "%s\n", state_name[ctrl->state]); 3354 3355 return sprintf(buf, "unknown state\n"); 3356 } 3357 3358 static DEVICE_ATTR(state, S_IRUGO, nvme_sysfs_show_state, NULL); 3359 3360 static ssize_t nvme_sysfs_show_subsysnqn(struct device *dev, 3361 struct device_attribute *attr, 3362 char *buf) 3363 { 3364 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); 3365 3366 return snprintf(buf, PAGE_SIZE, "%s\n", ctrl->subsys->subnqn); 3367 } 3368 static DEVICE_ATTR(subsysnqn, S_IRUGO, nvme_sysfs_show_subsysnqn, NULL); 3369 3370 static ssize_t nvme_sysfs_show_hostnqn(struct device *dev, 3371 struct device_attribute *attr, 3372 char *buf) 3373 { 3374 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); 3375 3376 return snprintf(buf, PAGE_SIZE, "%s\n", ctrl->opts->host->nqn); 3377 } 3378 static DEVICE_ATTR(hostnqn, S_IRUGO, nvme_sysfs_show_hostnqn, NULL); 3379 3380 static ssize_t nvme_sysfs_show_hostid(struct device *dev, 3381 struct device_attribute *attr, 3382 char *buf) 3383 { 3384 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); 3385 3386 return snprintf(buf, PAGE_SIZE, "%pU\n", &ctrl->opts->host->id); 3387 } 3388 static DEVICE_ATTR(hostid, S_IRUGO, nvme_sysfs_show_hostid, NULL); 3389 3390 static ssize_t nvme_sysfs_show_address(struct device *dev, 3391 struct device_attribute *attr, 3392 char *buf) 3393 { 3394 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); 3395 3396 return ctrl->ops->get_address(ctrl, buf, PAGE_SIZE); 3397 } 3398 static DEVICE_ATTR(address, S_IRUGO, nvme_sysfs_show_address, NULL); 3399 3400 static struct attribute *nvme_dev_attrs[] = { 3401 &dev_attr_reset_controller.attr, 3402 &dev_attr_rescan_controller.attr, 3403 &dev_attr_model.attr, 3404 &dev_attr_serial.attr, 3405 &dev_attr_firmware_rev.attr, 3406 &dev_attr_cntlid.attr, 3407 &dev_attr_delete_controller.attr, 3408 &dev_attr_transport.attr, 3409 &dev_attr_subsysnqn.attr, 3410 &dev_attr_address.attr, 3411 &dev_attr_state.attr, 3412 &dev_attr_numa_node.attr, 3413 &dev_attr_queue_count.attr, 3414 &dev_attr_sqsize.attr, 3415 &dev_attr_hostnqn.attr, 3416 &dev_attr_hostid.attr, 3417 NULL 3418 }; 3419 3420 static umode_t nvme_dev_attrs_are_visible(struct kobject *kobj, 3421 struct attribute *a, int n) 3422 { 3423 struct device *dev = container_of(kobj, struct device, kobj); 3424 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); 3425 3426 if (a == &dev_attr_delete_controller.attr && !ctrl->ops->delete_ctrl) 3427 return 0; 3428 if (a == &dev_attr_address.attr && !ctrl->ops->get_address) 3429 return 0; 3430 if (a == &dev_attr_hostnqn.attr && !ctrl->opts) 3431 return 0; 3432 if (a == &dev_attr_hostid.attr && !ctrl->opts) 3433 return 0; 3434 3435 return a->mode; 3436 } 3437 3438 static struct attribute_group nvme_dev_attrs_group = { 3439 .attrs = nvme_dev_attrs, 3440 .is_visible = nvme_dev_attrs_are_visible, 3441 }; 3442 3443 static const struct attribute_group *nvme_dev_attr_groups[] = { 3444 &nvme_dev_attrs_group, 3445 NULL, 3446 }; 3447 3448 static struct nvme_ns_head *nvme_find_ns_head(struct nvme_subsystem *subsys, 3449 unsigned nsid) 3450 { 3451 struct nvme_ns_head *h; 3452 3453 lockdep_assert_held(&subsys->lock); 3454 3455 list_for_each_entry(h, &subsys->nsheads, entry) { 3456 if (h->ns_id == nsid && kref_get_unless_zero(&h->ref)) 3457 return h; 3458 } 3459 3460 return NULL; 3461 } 3462 3463 static int __nvme_check_ids(struct nvme_subsystem *subsys, 3464 struct nvme_ns_head *new) 3465 { 3466 struct nvme_ns_head *h; 3467 3468 lockdep_assert_held(&subsys->lock); 3469 3470 list_for_each_entry(h, &subsys->nsheads, entry) { 3471 if (nvme_ns_ids_valid(&new->ids) && 3472 nvme_ns_ids_equal(&new->ids, &h->ids)) 3473 return -EINVAL; 3474 } 3475 3476 return 0; 3477 } 3478 3479 static struct nvme_ns_head *nvme_alloc_ns_head(struct nvme_ctrl *ctrl, 3480 unsigned nsid, struct nvme_ns_ids *ids) 3481 { 3482 struct nvme_ns_head *head; 3483 size_t size = sizeof(*head); 3484 int ret = -ENOMEM; 3485 3486 #ifdef CONFIG_NVME_MULTIPATH 3487 size += num_possible_nodes() * sizeof(struct nvme_ns *); 3488 #endif 3489 3490 head = kzalloc(size, GFP_KERNEL); 3491 if (!head) 3492 goto out; 3493 ret = ida_simple_get(&ctrl->subsys->ns_ida, 1, 0, GFP_KERNEL); 3494 if (ret < 0) 3495 goto out_free_head; 3496 head->instance = ret; 3497 INIT_LIST_HEAD(&head->list); 3498 ret = init_srcu_struct(&head->srcu); 3499 if (ret) 3500 goto out_ida_remove; 3501 head->subsys = ctrl->subsys; 3502 head->ns_id = nsid; 3503 head->ids = *ids; 3504 kref_init(&head->ref); 3505 3506 ret = __nvme_check_ids(ctrl->subsys, head); 3507 if (ret) { 3508 dev_err(ctrl->device, 3509 "duplicate IDs for nsid %d\n", nsid); 3510 goto out_cleanup_srcu; 3511 } 3512 3513 ret = nvme_mpath_alloc_disk(ctrl, head); 3514 if (ret) 3515 goto out_cleanup_srcu; 3516 3517 list_add_tail(&head->entry, &ctrl->subsys->nsheads); 3518 3519 kref_get(&ctrl->subsys->ref); 3520 3521 return head; 3522 out_cleanup_srcu: 3523 cleanup_srcu_struct(&head->srcu); 3524 out_ida_remove: 3525 ida_simple_remove(&ctrl->subsys->ns_ida, head->instance); 3526 out_free_head: 3527 kfree(head); 3528 out: 3529 if (ret > 0) 3530 ret = blk_status_to_errno(nvme_error_status(ret)); 3531 return ERR_PTR(ret); 3532 } 3533 3534 static int nvme_init_ns_head(struct nvme_ns *ns, unsigned nsid, 3535 struct nvme_id_ns *id) 3536 { 3537 struct nvme_ctrl *ctrl = ns->ctrl; 3538 bool is_shared = id->nmic & NVME_NS_NMIC_SHARED; 3539 struct nvme_ns_head *head = NULL; 3540 struct nvme_ns_ids ids; 3541 int ret = 0; 3542 3543 ret = nvme_report_ns_ids(ctrl, nsid, id, &ids); 3544 if (ret) { 3545 if (ret < 0) 3546 return ret; 3547 return blk_status_to_errno(nvme_error_status(ret)); 3548 } 3549 3550 mutex_lock(&ctrl->subsys->lock); 3551 head = nvme_find_ns_head(ctrl->subsys, nsid); 3552 if (!head) { 3553 head = nvme_alloc_ns_head(ctrl, nsid, &ids); 3554 if (IS_ERR(head)) { 3555 ret = PTR_ERR(head); 3556 goto out_unlock; 3557 } 3558 head->shared = is_shared; 3559 } else { 3560 ret = -EINVAL; 3561 if (!is_shared || !head->shared) { 3562 dev_err(ctrl->device, 3563 "Duplicate unshared namespace %d\n", nsid); 3564 goto out_put_ns_head; 3565 } 3566 if (!nvme_ns_ids_equal(&head->ids, &ids)) { 3567 dev_err(ctrl->device, 3568 "IDs don't match for shared namespace %d\n", 3569 nsid); 3570 goto out_put_ns_head; 3571 } 3572 } 3573 3574 list_add_tail(&ns->siblings, &head->list); 3575 ns->head = head; 3576 mutex_unlock(&ctrl->subsys->lock); 3577 return 0; 3578 3579 out_put_ns_head: 3580 nvme_put_ns_head(head); 3581 out_unlock: 3582 mutex_unlock(&ctrl->subsys->lock); 3583 return ret; 3584 } 3585 3586 static int ns_cmp(void *priv, struct list_head *a, struct list_head *b) 3587 { 3588 struct nvme_ns *nsa = container_of(a, struct nvme_ns, list); 3589 struct nvme_ns *nsb = container_of(b, struct nvme_ns, list); 3590 3591 return nsa->head->ns_id - nsb->head->ns_id; 3592 } 3593 3594 static struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid) 3595 { 3596 struct nvme_ns *ns, *ret = NULL; 3597 3598 down_read(&ctrl->namespaces_rwsem); 3599 list_for_each_entry(ns, &ctrl->namespaces, list) { 3600 if (ns->head->ns_id == nsid) { 3601 if (!kref_get_unless_zero(&ns->kref)) 3602 continue; 3603 ret = ns; 3604 break; 3605 } 3606 if (ns->head->ns_id > nsid) 3607 break; 3608 } 3609 up_read(&ctrl->namespaces_rwsem); 3610 return ret; 3611 } 3612 3613 static void nvme_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid) 3614 { 3615 struct nvme_ns *ns; 3616 struct gendisk *disk; 3617 struct nvme_id_ns *id; 3618 char disk_name[DISK_NAME_LEN]; 3619 int node = ctrl->numa_node, flags = GENHD_FL_EXT_DEVT, ret; 3620 3621 ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node); 3622 if (!ns) 3623 return; 3624 3625 ns->queue = blk_mq_init_queue(ctrl->tagset); 3626 if (IS_ERR(ns->queue)) 3627 goto out_free_ns; 3628 3629 if (ctrl->opts && ctrl->opts->data_digest) 3630 ns->queue->backing_dev_info->capabilities 3631 |= BDI_CAP_STABLE_WRITES; 3632 3633 blk_queue_flag_set(QUEUE_FLAG_NONROT, ns->queue); 3634 if (ctrl->ops->flags & NVME_F_PCI_P2PDMA) 3635 blk_queue_flag_set(QUEUE_FLAG_PCI_P2PDMA, ns->queue); 3636 3637 ns->queue->queuedata = ns; 3638 ns->ctrl = ctrl; 3639 3640 kref_init(&ns->kref); 3641 ns->lba_shift = 9; /* set to a default value for 512 until disk is validated */ 3642 3643 blk_queue_logical_block_size(ns->queue, 1 << ns->lba_shift); 3644 nvme_set_queue_limits(ctrl, ns->queue); 3645 3646 ret = nvme_identify_ns(ctrl, nsid, &id); 3647 if (ret) 3648 goto out_free_queue; 3649 3650 if (id->ncap == 0) /* no namespace (legacy quirk) */ 3651 goto out_free_id; 3652 3653 ret = nvme_init_ns_head(ns, nsid, id); 3654 if (ret) 3655 goto out_free_id; 3656 nvme_set_disk_name(disk_name, ns, ctrl, &flags); 3657 3658 disk = alloc_disk_node(0, node); 3659 if (!disk) 3660 goto out_unlink_ns; 3661 3662 disk->fops = &nvme_fops; 3663 disk->private_data = ns; 3664 disk->queue = ns->queue; 3665 disk->flags = flags; 3666 memcpy(disk->disk_name, disk_name, DISK_NAME_LEN); 3667 ns->disk = disk; 3668 3669 if (__nvme_revalidate_disk(disk, id)) 3670 goto out_put_disk; 3671 3672 if ((ctrl->quirks & NVME_QUIRK_LIGHTNVM) && id->vs[0] == 0x1) { 3673 ret = nvme_nvm_register(ns, disk_name, node); 3674 if (ret) { 3675 dev_warn(ctrl->device, "LightNVM init failure\n"); 3676 goto out_put_disk; 3677 } 3678 } 3679 3680 down_write(&ctrl->namespaces_rwsem); 3681 list_add_tail(&ns->list, &ctrl->namespaces); 3682 up_write(&ctrl->namespaces_rwsem); 3683 3684 nvme_get_ctrl(ctrl); 3685 3686 device_add_disk(ctrl->device, ns->disk, nvme_ns_id_attr_groups); 3687 3688 nvme_mpath_add_disk(ns, id); 3689 nvme_fault_inject_init(&ns->fault_inject, ns->disk->disk_name); 3690 kfree(id); 3691 3692 return; 3693 out_put_disk: 3694 /* prevent double queue cleanup */ 3695 ns->disk->queue = NULL; 3696 put_disk(ns->disk); 3697 out_unlink_ns: 3698 mutex_lock(&ctrl->subsys->lock); 3699 list_del_rcu(&ns->siblings); 3700 if (list_empty(&ns->head->list)) 3701 list_del_init(&ns->head->entry); 3702 mutex_unlock(&ctrl->subsys->lock); 3703 nvme_put_ns_head(ns->head); 3704 out_free_id: 3705 kfree(id); 3706 out_free_queue: 3707 blk_cleanup_queue(ns->queue); 3708 out_free_ns: 3709 kfree(ns); 3710 } 3711 3712 static void nvme_ns_remove(struct nvme_ns *ns) 3713 { 3714 if (test_and_set_bit(NVME_NS_REMOVING, &ns->flags)) 3715 return; 3716 3717 nvme_fault_inject_fini(&ns->fault_inject); 3718 3719 mutex_lock(&ns->ctrl->subsys->lock); 3720 list_del_rcu(&ns->siblings); 3721 if (list_empty(&ns->head->list)) 3722 list_del_init(&ns->head->entry); 3723 mutex_unlock(&ns->ctrl->subsys->lock); 3724 3725 synchronize_rcu(); /* guarantee not available in head->list */ 3726 nvme_mpath_clear_current_path(ns); 3727 synchronize_srcu(&ns->head->srcu); /* wait for concurrent submissions */ 3728 3729 if (ns->disk && ns->disk->flags & GENHD_FL_UP) { 3730 del_gendisk(ns->disk); 3731 blk_cleanup_queue(ns->queue); 3732 if (blk_get_integrity(ns->disk)) 3733 blk_integrity_unregister(ns->disk); 3734 } 3735 3736 down_write(&ns->ctrl->namespaces_rwsem); 3737 list_del_init(&ns->list); 3738 up_write(&ns->ctrl->namespaces_rwsem); 3739 3740 nvme_mpath_check_last_path(ns); 3741 nvme_put_ns(ns); 3742 } 3743 3744 static void nvme_ns_remove_by_nsid(struct nvme_ctrl *ctrl, u32 nsid) 3745 { 3746 struct nvme_ns *ns = nvme_find_get_ns(ctrl, nsid); 3747 3748 if (ns) { 3749 nvme_ns_remove(ns); 3750 nvme_put_ns(ns); 3751 } 3752 } 3753 3754 static void nvme_validate_ns(struct nvme_ctrl *ctrl, unsigned nsid) 3755 { 3756 struct nvme_ns *ns; 3757 3758 ns = nvme_find_get_ns(ctrl, nsid); 3759 if (ns) { 3760 if (ns->disk && revalidate_disk(ns->disk)) 3761 nvme_ns_remove(ns); 3762 nvme_put_ns(ns); 3763 } else 3764 nvme_alloc_ns(ctrl, nsid); 3765 } 3766 3767 static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl, 3768 unsigned nsid) 3769 { 3770 struct nvme_ns *ns, *next; 3771 LIST_HEAD(rm_list); 3772 3773 down_write(&ctrl->namespaces_rwsem); 3774 list_for_each_entry_safe(ns, next, &ctrl->namespaces, list) { 3775 if (ns->head->ns_id > nsid || test_bit(NVME_NS_DEAD, &ns->flags)) 3776 list_move_tail(&ns->list, &rm_list); 3777 } 3778 up_write(&ctrl->namespaces_rwsem); 3779 3780 list_for_each_entry_safe(ns, next, &rm_list, list) 3781 nvme_ns_remove(ns); 3782 3783 } 3784 3785 static int nvme_scan_ns_list(struct nvme_ctrl *ctrl) 3786 { 3787 const int nr_entries = NVME_IDENTIFY_DATA_SIZE / sizeof(__le32); 3788 __le32 *ns_list; 3789 u32 prev = 0; 3790 int ret = 0, i; 3791 3792 if (nvme_ctrl_limited_cns(ctrl)) 3793 return -EOPNOTSUPP; 3794 3795 ns_list = kzalloc(NVME_IDENTIFY_DATA_SIZE, GFP_KERNEL); 3796 if (!ns_list) 3797 return -ENOMEM; 3798 3799 for (;;) { 3800 ret = nvme_identify_ns_list(ctrl, prev, ns_list); 3801 if (ret) 3802 goto free; 3803 3804 for (i = 0; i < nr_entries; i++) { 3805 u32 nsid = le32_to_cpu(ns_list[i]); 3806 3807 if (!nsid) /* end of the list? */ 3808 goto out; 3809 nvme_validate_ns(ctrl, nsid); 3810 while (++prev < nsid) 3811 nvme_ns_remove_by_nsid(ctrl, prev); 3812 } 3813 } 3814 out: 3815 nvme_remove_invalid_namespaces(ctrl, prev); 3816 free: 3817 kfree(ns_list); 3818 return ret; 3819 } 3820 3821 static void nvme_scan_ns_sequential(struct nvme_ctrl *ctrl) 3822 { 3823 struct nvme_id_ctrl *id; 3824 u32 nn, i; 3825 3826 if (nvme_identify_ctrl(ctrl, &id)) 3827 return; 3828 nn = le32_to_cpu(id->nn); 3829 kfree(id); 3830 3831 for (i = 1; i <= nn; i++) 3832 nvme_validate_ns(ctrl, i); 3833 3834 nvme_remove_invalid_namespaces(ctrl, nn); 3835 } 3836 3837 static void nvme_clear_changed_ns_log(struct nvme_ctrl *ctrl) 3838 { 3839 size_t log_size = NVME_MAX_CHANGED_NAMESPACES * sizeof(__le32); 3840 __le32 *log; 3841 int error; 3842 3843 log = kzalloc(log_size, GFP_KERNEL); 3844 if (!log) 3845 return; 3846 3847 /* 3848 * We need to read the log to clear the AEN, but we don't want to rely 3849 * on it for the changed namespace information as userspace could have 3850 * raced with us in reading the log page, which could cause us to miss 3851 * updates. 3852 */ 3853 error = nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_CHANGED_NS, 0, log, 3854 log_size, 0); 3855 if (error) 3856 dev_warn(ctrl->device, 3857 "reading changed ns log failed: %d\n", error); 3858 3859 kfree(log); 3860 } 3861 3862 static void nvme_scan_work(struct work_struct *work) 3863 { 3864 struct nvme_ctrl *ctrl = 3865 container_of(work, struct nvme_ctrl, scan_work); 3866 3867 /* No tagset on a live ctrl means IO queues could not created */ 3868 if (ctrl->state != NVME_CTRL_LIVE || !ctrl->tagset) 3869 return; 3870 3871 if (test_and_clear_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events)) { 3872 dev_info(ctrl->device, "rescanning namespaces.\n"); 3873 nvme_clear_changed_ns_log(ctrl); 3874 } 3875 3876 mutex_lock(&ctrl->scan_lock); 3877 if (nvme_scan_ns_list(ctrl) != 0) 3878 nvme_scan_ns_sequential(ctrl); 3879 mutex_unlock(&ctrl->scan_lock); 3880 3881 down_write(&ctrl->namespaces_rwsem); 3882 list_sort(NULL, &ctrl->namespaces, ns_cmp); 3883 up_write(&ctrl->namespaces_rwsem); 3884 } 3885 3886 /* 3887 * This function iterates the namespace list unlocked to allow recovery from 3888 * controller failure. It is up to the caller to ensure the namespace list is 3889 * not modified by scan work while this function is executing. 3890 */ 3891 void nvme_remove_namespaces(struct nvme_ctrl *ctrl) 3892 { 3893 struct nvme_ns *ns, *next; 3894 LIST_HEAD(ns_list); 3895 3896 /* 3897 * make sure to requeue I/O to all namespaces as these 3898 * might result from the scan itself and must complete 3899 * for the scan_work to make progress 3900 */ 3901 nvme_mpath_clear_ctrl_paths(ctrl); 3902 3903 /* prevent racing with ns scanning */ 3904 flush_work(&ctrl->scan_work); 3905 3906 /* 3907 * The dead states indicates the controller was not gracefully 3908 * disconnected. In that case, we won't be able to flush any data while 3909 * removing the namespaces' disks; fail all the queues now to avoid 3910 * potentially having to clean up the failed sync later. 3911 */ 3912 if (ctrl->state == NVME_CTRL_DEAD) 3913 nvme_kill_queues(ctrl); 3914 3915 down_write(&ctrl->namespaces_rwsem); 3916 list_splice_init(&ctrl->namespaces, &ns_list); 3917 up_write(&ctrl->namespaces_rwsem); 3918 3919 list_for_each_entry_safe(ns, next, &ns_list, list) 3920 nvme_ns_remove(ns); 3921 } 3922 EXPORT_SYMBOL_GPL(nvme_remove_namespaces); 3923 3924 static int nvme_class_uevent(struct device *dev, struct kobj_uevent_env *env) 3925 { 3926 struct nvme_ctrl *ctrl = 3927 container_of(dev, struct nvme_ctrl, ctrl_device); 3928 struct nvmf_ctrl_options *opts = ctrl->opts; 3929 int ret; 3930 3931 ret = add_uevent_var(env, "NVME_TRTYPE=%s", ctrl->ops->name); 3932 if (ret) 3933 return ret; 3934 3935 if (opts) { 3936 ret = add_uevent_var(env, "NVME_TRADDR=%s", opts->traddr); 3937 if (ret) 3938 return ret; 3939 3940 ret = add_uevent_var(env, "NVME_TRSVCID=%s", 3941 opts->trsvcid ?: "none"); 3942 if (ret) 3943 return ret; 3944 3945 ret = add_uevent_var(env, "NVME_HOST_TRADDR=%s", 3946 opts->host_traddr ?: "none"); 3947 } 3948 return ret; 3949 } 3950 3951 static void nvme_aen_uevent(struct nvme_ctrl *ctrl) 3952 { 3953 char *envp[2] = { NULL, NULL }; 3954 u32 aen_result = ctrl->aen_result; 3955 3956 ctrl->aen_result = 0; 3957 if (!aen_result) 3958 return; 3959 3960 envp[0] = kasprintf(GFP_KERNEL, "NVME_AEN=%#08x", aen_result); 3961 if (!envp[0]) 3962 return; 3963 kobject_uevent_env(&ctrl->device->kobj, KOBJ_CHANGE, envp); 3964 kfree(envp[0]); 3965 } 3966 3967 static void nvme_async_event_work(struct work_struct *work) 3968 { 3969 struct nvme_ctrl *ctrl = 3970 container_of(work, struct nvme_ctrl, async_event_work); 3971 3972 nvme_aen_uevent(ctrl); 3973 ctrl->ops->submit_async_event(ctrl); 3974 } 3975 3976 static bool nvme_ctrl_pp_status(struct nvme_ctrl *ctrl) 3977 { 3978 3979 u32 csts; 3980 3981 if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts)) 3982 return false; 3983 3984 if (csts == ~0) 3985 return false; 3986 3987 return ((ctrl->ctrl_config & NVME_CC_ENABLE) && (csts & NVME_CSTS_PP)); 3988 } 3989 3990 static void nvme_get_fw_slot_info(struct nvme_ctrl *ctrl) 3991 { 3992 struct nvme_fw_slot_info_log *log; 3993 3994 log = kmalloc(sizeof(*log), GFP_KERNEL); 3995 if (!log) 3996 return; 3997 3998 if (nvme_get_log(ctrl, NVME_NSID_ALL, NVME_LOG_FW_SLOT, 0, log, 3999 sizeof(*log), 0)) 4000 dev_warn(ctrl->device, "Get FW SLOT INFO log error\n"); 4001 kfree(log); 4002 } 4003 4004 static void nvme_fw_act_work(struct work_struct *work) 4005 { 4006 struct nvme_ctrl *ctrl = container_of(work, 4007 struct nvme_ctrl, fw_act_work); 4008 unsigned long fw_act_timeout; 4009 4010 if (ctrl->mtfa) 4011 fw_act_timeout = jiffies + 4012 msecs_to_jiffies(ctrl->mtfa * 100); 4013 else 4014 fw_act_timeout = jiffies + 4015 msecs_to_jiffies(admin_timeout * 1000); 4016 4017 nvme_stop_queues(ctrl); 4018 while (nvme_ctrl_pp_status(ctrl)) { 4019 if (time_after(jiffies, fw_act_timeout)) { 4020 dev_warn(ctrl->device, 4021 "Fw activation timeout, reset controller\n"); 4022 nvme_try_sched_reset(ctrl); 4023 return; 4024 } 4025 msleep(100); 4026 } 4027 4028 if (!nvme_change_ctrl_state(ctrl, NVME_CTRL_LIVE)) 4029 return; 4030 4031 nvme_start_queues(ctrl); 4032 /* read FW slot information to clear the AER */ 4033 nvme_get_fw_slot_info(ctrl); 4034 } 4035 4036 static void nvme_handle_aen_notice(struct nvme_ctrl *ctrl, u32 result) 4037 { 4038 u32 aer_notice_type = (result & 0xff00) >> 8; 4039 4040 trace_nvme_async_event(ctrl, aer_notice_type); 4041 4042 switch (aer_notice_type) { 4043 case NVME_AER_NOTICE_NS_CHANGED: 4044 set_bit(NVME_AER_NOTICE_NS_CHANGED, &ctrl->events); 4045 nvme_queue_scan(ctrl); 4046 break; 4047 case NVME_AER_NOTICE_FW_ACT_STARTING: 4048 /* 4049 * We are (ab)using the RESETTING state to prevent subsequent 4050 * recovery actions from interfering with the controller's 4051 * firmware activation. 4052 */ 4053 if (nvme_change_ctrl_state(ctrl, NVME_CTRL_RESETTING)) 4054 queue_work(nvme_wq, &ctrl->fw_act_work); 4055 break; 4056 #ifdef CONFIG_NVME_MULTIPATH 4057 case NVME_AER_NOTICE_ANA: 4058 if (!ctrl->ana_log_buf) 4059 break; 4060 queue_work(nvme_wq, &ctrl->ana_work); 4061 break; 4062 #endif 4063 case NVME_AER_NOTICE_DISC_CHANGED: 4064 ctrl->aen_result = result; 4065 break; 4066 default: 4067 dev_warn(ctrl->device, "async event result %08x\n", result); 4068 } 4069 } 4070 4071 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status, 4072 volatile union nvme_result *res) 4073 { 4074 u32 result = le32_to_cpu(res->u32); 4075 u32 aer_type = result & 0x07; 4076 4077 if (le16_to_cpu(status) >> 1 != NVME_SC_SUCCESS) 4078 return; 4079 4080 switch (aer_type) { 4081 case NVME_AER_NOTICE: 4082 nvme_handle_aen_notice(ctrl, result); 4083 break; 4084 case NVME_AER_ERROR: 4085 case NVME_AER_SMART: 4086 case NVME_AER_CSS: 4087 case NVME_AER_VS: 4088 trace_nvme_async_event(ctrl, aer_type); 4089 ctrl->aen_result = result; 4090 break; 4091 default: 4092 break; 4093 } 4094 queue_work(nvme_wq, &ctrl->async_event_work); 4095 } 4096 EXPORT_SYMBOL_GPL(nvme_complete_async_event); 4097 4098 void nvme_stop_ctrl(struct nvme_ctrl *ctrl) 4099 { 4100 nvme_mpath_stop(ctrl); 4101 nvme_stop_keep_alive(ctrl); 4102 flush_work(&ctrl->async_event_work); 4103 cancel_work_sync(&ctrl->fw_act_work); 4104 } 4105 EXPORT_SYMBOL_GPL(nvme_stop_ctrl); 4106 4107 void nvme_start_ctrl(struct nvme_ctrl *ctrl) 4108 { 4109 if (ctrl->kato) 4110 nvme_start_keep_alive(ctrl); 4111 4112 nvme_enable_aen(ctrl); 4113 4114 if (ctrl->queue_count > 1) { 4115 nvme_queue_scan(ctrl); 4116 nvme_start_queues(ctrl); 4117 } 4118 ctrl->created = true; 4119 } 4120 EXPORT_SYMBOL_GPL(nvme_start_ctrl); 4121 4122 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl) 4123 { 4124 nvme_fault_inject_fini(&ctrl->fault_inject); 4125 dev_pm_qos_hide_latency_tolerance(ctrl->device); 4126 cdev_device_del(&ctrl->cdev, ctrl->device); 4127 nvme_put_ctrl(ctrl); 4128 } 4129 EXPORT_SYMBOL_GPL(nvme_uninit_ctrl); 4130 4131 static void nvme_free_ctrl(struct device *dev) 4132 { 4133 struct nvme_ctrl *ctrl = 4134 container_of(dev, struct nvme_ctrl, ctrl_device); 4135 struct nvme_subsystem *subsys = ctrl->subsys; 4136 4137 if (subsys && ctrl->instance != subsys->instance) 4138 ida_simple_remove(&nvme_instance_ida, ctrl->instance); 4139 4140 kfree(ctrl->effects); 4141 nvme_mpath_uninit(ctrl); 4142 __free_page(ctrl->discard_page); 4143 4144 if (subsys) { 4145 mutex_lock(&nvme_subsystems_lock); 4146 list_del(&ctrl->subsys_entry); 4147 sysfs_remove_link(&subsys->dev.kobj, dev_name(ctrl->device)); 4148 mutex_unlock(&nvme_subsystems_lock); 4149 } 4150 4151 ctrl->ops->free_ctrl(ctrl); 4152 4153 if (subsys) 4154 nvme_put_subsystem(subsys); 4155 } 4156 4157 /* 4158 * Initialize a NVMe controller structures. This needs to be called during 4159 * earliest initialization so that we have the initialized structured around 4160 * during probing. 4161 */ 4162 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev, 4163 const struct nvme_ctrl_ops *ops, unsigned long quirks) 4164 { 4165 int ret; 4166 4167 ctrl->state = NVME_CTRL_NEW; 4168 spin_lock_init(&ctrl->lock); 4169 mutex_init(&ctrl->scan_lock); 4170 INIT_LIST_HEAD(&ctrl->namespaces); 4171 init_rwsem(&ctrl->namespaces_rwsem); 4172 ctrl->dev = dev; 4173 ctrl->ops = ops; 4174 ctrl->quirks = quirks; 4175 ctrl->numa_node = NUMA_NO_NODE; 4176 INIT_WORK(&ctrl->scan_work, nvme_scan_work); 4177 INIT_WORK(&ctrl->async_event_work, nvme_async_event_work); 4178 INIT_WORK(&ctrl->fw_act_work, nvme_fw_act_work); 4179 INIT_WORK(&ctrl->delete_work, nvme_delete_ctrl_work); 4180 init_waitqueue_head(&ctrl->state_wq); 4181 4182 INIT_DELAYED_WORK(&ctrl->ka_work, nvme_keep_alive_work); 4183 memset(&ctrl->ka_cmd, 0, sizeof(ctrl->ka_cmd)); 4184 ctrl->ka_cmd.common.opcode = nvme_admin_keep_alive; 4185 4186 BUILD_BUG_ON(NVME_DSM_MAX_RANGES * sizeof(struct nvme_dsm_range) > 4187 PAGE_SIZE); 4188 ctrl->discard_page = alloc_page(GFP_KERNEL); 4189 if (!ctrl->discard_page) { 4190 ret = -ENOMEM; 4191 goto out; 4192 } 4193 4194 ret = ida_simple_get(&nvme_instance_ida, 0, 0, GFP_KERNEL); 4195 if (ret < 0) 4196 goto out; 4197 ctrl->instance = ret; 4198 4199 device_initialize(&ctrl->ctrl_device); 4200 ctrl->device = &ctrl->ctrl_device; 4201 ctrl->device->devt = MKDEV(MAJOR(nvme_chr_devt), ctrl->instance); 4202 ctrl->device->class = nvme_class; 4203 ctrl->device->parent = ctrl->dev; 4204 ctrl->device->groups = nvme_dev_attr_groups; 4205 ctrl->device->release = nvme_free_ctrl; 4206 dev_set_drvdata(ctrl->device, ctrl); 4207 ret = dev_set_name(ctrl->device, "nvme%d", ctrl->instance); 4208 if (ret) 4209 goto out_release_instance; 4210 4211 nvme_get_ctrl(ctrl); 4212 cdev_init(&ctrl->cdev, &nvme_dev_fops); 4213 ctrl->cdev.owner = ops->module; 4214 ret = cdev_device_add(&ctrl->cdev, ctrl->device); 4215 if (ret) 4216 goto out_free_name; 4217 4218 /* 4219 * Initialize latency tolerance controls. The sysfs files won't 4220 * be visible to userspace unless the device actually supports APST. 4221 */ 4222 ctrl->device->power.set_latency_tolerance = nvme_set_latency_tolerance; 4223 dev_pm_qos_update_user_latency_tolerance(ctrl->device, 4224 min(default_ps_max_latency_us, (unsigned long)S32_MAX)); 4225 4226 nvme_fault_inject_init(&ctrl->fault_inject, dev_name(ctrl->device)); 4227 4228 return 0; 4229 out_free_name: 4230 nvme_put_ctrl(ctrl); 4231 kfree_const(ctrl->device->kobj.name); 4232 out_release_instance: 4233 ida_simple_remove(&nvme_instance_ida, ctrl->instance); 4234 out: 4235 if (ctrl->discard_page) 4236 __free_page(ctrl->discard_page); 4237 return ret; 4238 } 4239 EXPORT_SYMBOL_GPL(nvme_init_ctrl); 4240 4241 /** 4242 * nvme_kill_queues(): Ends all namespace queues 4243 * @ctrl: the dead controller that needs to end 4244 * 4245 * Call this function when the driver determines it is unable to get the 4246 * controller in a state capable of servicing IO. 4247 */ 4248 void nvme_kill_queues(struct nvme_ctrl *ctrl) 4249 { 4250 struct nvme_ns *ns; 4251 4252 down_read(&ctrl->namespaces_rwsem); 4253 4254 /* Forcibly unquiesce queues to avoid blocking dispatch */ 4255 if (ctrl->admin_q && !blk_queue_dying(ctrl->admin_q)) 4256 blk_mq_unquiesce_queue(ctrl->admin_q); 4257 4258 list_for_each_entry(ns, &ctrl->namespaces, list) 4259 nvme_set_queue_dying(ns); 4260 4261 up_read(&ctrl->namespaces_rwsem); 4262 } 4263 EXPORT_SYMBOL_GPL(nvme_kill_queues); 4264 4265 void nvme_unfreeze(struct nvme_ctrl *ctrl) 4266 { 4267 struct nvme_ns *ns; 4268 4269 down_read(&ctrl->namespaces_rwsem); 4270 list_for_each_entry(ns, &ctrl->namespaces, list) 4271 blk_mq_unfreeze_queue(ns->queue); 4272 up_read(&ctrl->namespaces_rwsem); 4273 } 4274 EXPORT_SYMBOL_GPL(nvme_unfreeze); 4275 4276 void nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout) 4277 { 4278 struct nvme_ns *ns; 4279 4280 down_read(&ctrl->namespaces_rwsem); 4281 list_for_each_entry(ns, &ctrl->namespaces, list) { 4282 timeout = blk_mq_freeze_queue_wait_timeout(ns->queue, timeout); 4283 if (timeout <= 0) 4284 break; 4285 } 4286 up_read(&ctrl->namespaces_rwsem); 4287 } 4288 EXPORT_SYMBOL_GPL(nvme_wait_freeze_timeout); 4289 4290 void nvme_wait_freeze(struct nvme_ctrl *ctrl) 4291 { 4292 struct nvme_ns *ns; 4293 4294 down_read(&ctrl->namespaces_rwsem); 4295 list_for_each_entry(ns, &ctrl->namespaces, list) 4296 blk_mq_freeze_queue_wait(ns->queue); 4297 up_read(&ctrl->namespaces_rwsem); 4298 } 4299 EXPORT_SYMBOL_GPL(nvme_wait_freeze); 4300 4301 void nvme_start_freeze(struct nvme_ctrl *ctrl) 4302 { 4303 struct nvme_ns *ns; 4304 4305 down_read(&ctrl->namespaces_rwsem); 4306 list_for_each_entry(ns, &ctrl->namespaces, list) 4307 blk_freeze_queue_start(ns->queue); 4308 up_read(&ctrl->namespaces_rwsem); 4309 } 4310 EXPORT_SYMBOL_GPL(nvme_start_freeze); 4311 4312 void nvme_stop_queues(struct nvme_ctrl *ctrl) 4313 { 4314 struct nvme_ns *ns; 4315 4316 down_read(&ctrl->namespaces_rwsem); 4317 list_for_each_entry(ns, &ctrl->namespaces, list) 4318 blk_mq_quiesce_queue(ns->queue); 4319 up_read(&ctrl->namespaces_rwsem); 4320 } 4321 EXPORT_SYMBOL_GPL(nvme_stop_queues); 4322 4323 void nvme_start_queues(struct nvme_ctrl *ctrl) 4324 { 4325 struct nvme_ns *ns; 4326 4327 down_read(&ctrl->namespaces_rwsem); 4328 list_for_each_entry(ns, &ctrl->namespaces, list) 4329 blk_mq_unquiesce_queue(ns->queue); 4330 up_read(&ctrl->namespaces_rwsem); 4331 } 4332 EXPORT_SYMBOL_GPL(nvme_start_queues); 4333 4334 4335 void nvme_sync_queues(struct nvme_ctrl *ctrl) 4336 { 4337 struct nvme_ns *ns; 4338 4339 down_read(&ctrl->namespaces_rwsem); 4340 list_for_each_entry(ns, &ctrl->namespaces, list) 4341 blk_sync_queue(ns->queue); 4342 up_read(&ctrl->namespaces_rwsem); 4343 4344 if (ctrl->admin_q) 4345 blk_sync_queue(ctrl->admin_q); 4346 } 4347 EXPORT_SYMBOL_GPL(nvme_sync_queues); 4348 4349 /* 4350 * Check we didn't inadvertently grow the command structure sizes: 4351 */ 4352 static inline void _nvme_check_size(void) 4353 { 4354 BUILD_BUG_ON(sizeof(struct nvme_common_command) != 64); 4355 BUILD_BUG_ON(sizeof(struct nvme_rw_command) != 64); 4356 BUILD_BUG_ON(sizeof(struct nvme_identify) != 64); 4357 BUILD_BUG_ON(sizeof(struct nvme_features) != 64); 4358 BUILD_BUG_ON(sizeof(struct nvme_download_firmware) != 64); 4359 BUILD_BUG_ON(sizeof(struct nvme_format_cmd) != 64); 4360 BUILD_BUG_ON(sizeof(struct nvme_dsm_cmd) != 64); 4361 BUILD_BUG_ON(sizeof(struct nvme_write_zeroes_cmd) != 64); 4362 BUILD_BUG_ON(sizeof(struct nvme_abort_cmd) != 64); 4363 BUILD_BUG_ON(sizeof(struct nvme_get_log_page_command) != 64); 4364 BUILD_BUG_ON(sizeof(struct nvme_command) != 64); 4365 BUILD_BUG_ON(sizeof(struct nvme_id_ctrl) != NVME_IDENTIFY_DATA_SIZE); 4366 BUILD_BUG_ON(sizeof(struct nvme_id_ns) != NVME_IDENTIFY_DATA_SIZE); 4367 BUILD_BUG_ON(sizeof(struct nvme_lba_range_type) != 64); 4368 BUILD_BUG_ON(sizeof(struct nvme_smart_log) != 512); 4369 BUILD_BUG_ON(sizeof(struct nvme_dbbuf) != 64); 4370 BUILD_BUG_ON(sizeof(struct nvme_directive_cmd) != 64); 4371 } 4372 4373 4374 static int __init nvme_core_init(void) 4375 { 4376 int result = -ENOMEM; 4377 4378 _nvme_check_size(); 4379 4380 nvme_wq = alloc_workqueue("nvme-wq", 4381 WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS, 0); 4382 if (!nvme_wq) 4383 goto out; 4384 4385 nvme_reset_wq = alloc_workqueue("nvme-reset-wq", 4386 WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS, 0); 4387 if (!nvme_reset_wq) 4388 goto destroy_wq; 4389 4390 nvme_delete_wq = alloc_workqueue("nvme-delete-wq", 4391 WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_SYSFS, 0); 4392 if (!nvme_delete_wq) 4393 goto destroy_reset_wq; 4394 4395 result = alloc_chrdev_region(&nvme_chr_devt, 0, NVME_MINORS, "nvme"); 4396 if (result < 0) 4397 goto destroy_delete_wq; 4398 4399 nvme_class = class_create(THIS_MODULE, "nvme"); 4400 if (IS_ERR(nvme_class)) { 4401 result = PTR_ERR(nvme_class); 4402 goto unregister_chrdev; 4403 } 4404 nvme_class->dev_uevent = nvme_class_uevent; 4405 4406 nvme_subsys_class = class_create(THIS_MODULE, "nvme-subsystem"); 4407 if (IS_ERR(nvme_subsys_class)) { 4408 result = PTR_ERR(nvme_subsys_class); 4409 goto destroy_class; 4410 } 4411 return 0; 4412 4413 destroy_class: 4414 class_destroy(nvme_class); 4415 unregister_chrdev: 4416 unregister_chrdev_region(nvme_chr_devt, NVME_MINORS); 4417 destroy_delete_wq: 4418 destroy_workqueue(nvme_delete_wq); 4419 destroy_reset_wq: 4420 destroy_workqueue(nvme_reset_wq); 4421 destroy_wq: 4422 destroy_workqueue(nvme_wq); 4423 out: 4424 return result; 4425 } 4426 4427 static void __exit nvme_core_exit(void) 4428 { 4429 class_destroy(nvme_subsys_class); 4430 class_destroy(nvme_class); 4431 unregister_chrdev_region(nvme_chr_devt, NVME_MINORS); 4432 destroy_workqueue(nvme_delete_wq); 4433 destroy_workqueue(nvme_reset_wq); 4434 destroy_workqueue(nvme_wq); 4435 ida_destroy(&nvme_instance_ida); 4436 } 4437 4438 MODULE_LICENSE("GPL"); 4439 MODULE_VERSION("1.0"); 4440 module_init(nvme_core_init); 4441 module_exit(nvme_core_exit); 4442