1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright (c) 2011-2014, Intel Corporation. 4 */ 5 6 #ifndef _NVME_H 7 #define _NVME_H 8 9 #include <linux/nvme.h> 10 #include <linux/cdev.h> 11 #include <linux/pci.h> 12 #include <linux/kref.h> 13 #include <linux/blk-mq.h> 14 #include <linux/sed-opal.h> 15 #include <linux/fault-inject.h> 16 #include <linux/rcupdate.h> 17 #include <linux/wait.h> 18 #include <linux/t10-pi.h> 19 #include <linux/ratelimit_types.h> 20 21 #include <trace/events/block.h> 22 23 extern const struct pr_ops nvme_pr_ops; 24 25 extern unsigned int nvme_io_timeout; 26 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ) 27 28 extern unsigned int admin_timeout; 29 #define NVME_ADMIN_TIMEOUT (admin_timeout * HZ) 30 31 #define NVME_DEFAULT_KATO 5 32 33 #ifdef CONFIG_ARCH_NO_SG_CHAIN 34 #define NVME_INLINE_SG_CNT 0 35 #define NVME_INLINE_METADATA_SG_CNT 0 36 #else 37 #define NVME_INLINE_SG_CNT 2 38 #define NVME_INLINE_METADATA_SG_CNT 1 39 #endif 40 41 /* 42 * Default to a 4K page size, with the intention to update this 43 * path in the future to accommodate architectures with differing 44 * kernel and IO page sizes. 45 */ 46 #define NVME_CTRL_PAGE_SHIFT 12 47 #define NVME_CTRL_PAGE_SIZE (1 << NVME_CTRL_PAGE_SHIFT) 48 49 extern struct workqueue_struct *nvme_wq; 50 extern struct workqueue_struct *nvme_reset_wq; 51 extern struct workqueue_struct *nvme_delete_wq; 52 extern struct mutex nvme_subsystems_lock; 53 54 /* 55 * List of workarounds for devices that required behavior not specified in 56 * the standard. 57 */ 58 enum nvme_quirks { 59 /* 60 * Prefers I/O aligned to a stripe size specified in a vendor 61 * specific Identify field. 62 */ 63 NVME_QUIRK_STRIPE_SIZE = (1 << 0), 64 65 /* 66 * The controller doesn't handle Identify value others than 0 or 1 67 * correctly. 68 */ 69 NVME_QUIRK_IDENTIFY_CNS = (1 << 1), 70 71 /* 72 * The controller deterministically returns O's on reads to 73 * logical blocks that deallocate was called on. 74 */ 75 NVME_QUIRK_DEALLOCATE_ZEROES = (1 << 2), 76 77 /* 78 * The controller needs a delay before starts checking the device 79 * readiness, which is done by reading the NVME_CSTS_RDY bit. 80 */ 81 NVME_QUIRK_DELAY_BEFORE_CHK_RDY = (1 << 3), 82 83 /* 84 * APST should not be used. 85 */ 86 NVME_QUIRK_NO_APST = (1 << 4), 87 88 /* 89 * The deepest sleep state should not be used. 90 */ 91 NVME_QUIRK_NO_DEEPEST_PS = (1 << 5), 92 93 /* 94 * Problems seen with concurrent commands 95 */ 96 NVME_QUIRK_QDEPTH_ONE = (1 << 6), 97 98 /* 99 * Set MEDIUM priority on SQ creation 100 */ 101 NVME_QUIRK_MEDIUM_PRIO_SQ = (1 << 7), 102 103 /* 104 * Ignore device provided subnqn. 105 */ 106 NVME_QUIRK_IGNORE_DEV_SUBNQN = (1 << 8), 107 108 /* 109 * Broken Write Zeroes. 110 */ 111 NVME_QUIRK_DISABLE_WRITE_ZEROES = (1 << 9), 112 113 /* 114 * Force simple suspend/resume path. 115 */ 116 NVME_QUIRK_SIMPLE_SUSPEND = (1 << 10), 117 118 /* 119 * Use only one interrupt vector for all queues 120 */ 121 NVME_QUIRK_SINGLE_VECTOR = (1 << 11), 122 123 /* 124 * Use non-standard 128 bytes SQEs. 125 */ 126 NVME_QUIRK_128_BYTES_SQES = (1 << 12), 127 128 /* 129 * Prevent tag overlap between queues 130 */ 131 NVME_QUIRK_SHARED_TAGS = (1 << 13), 132 133 /* 134 * Don't change the value of the temperature threshold feature 135 */ 136 NVME_QUIRK_NO_TEMP_THRESH_CHANGE = (1 << 14), 137 138 /* 139 * The controller doesn't handle the Identify Namespace 140 * Identification Descriptor list subcommand despite claiming 141 * NVMe 1.3 compliance. 142 */ 143 NVME_QUIRK_NO_NS_DESC_LIST = (1 << 15), 144 145 /* 146 * The controller does not properly handle DMA addresses over 147 * 48 bits. 148 */ 149 NVME_QUIRK_DMA_ADDRESS_BITS_48 = (1 << 16), 150 151 /* 152 * The controller requires the command_id value be limited, so skip 153 * encoding the generation sequence number. 154 */ 155 NVME_QUIRK_SKIP_CID_GEN = (1 << 17), 156 157 /* 158 * Reports garbage in the namespace identifiers (eui64, nguid, uuid). 159 */ 160 NVME_QUIRK_BOGUS_NID = (1 << 18), 161 162 /* 163 * No temperature thresholds for channels other than 0 (Composite). 164 */ 165 NVME_QUIRK_NO_SECONDARY_TEMP_THRESH = (1 << 19), 166 167 /* 168 * Disables simple suspend/resume path. 169 */ 170 NVME_QUIRK_FORCE_NO_SIMPLE_SUSPEND = (1 << 20), 171 172 /* 173 * MSI (but not MSI-X) interrupts are broken and never fire. 174 */ 175 NVME_QUIRK_BROKEN_MSI = (1 << 21), 176 }; 177 178 /* 179 * Common request structure for NVMe passthrough. All drivers must have 180 * this structure as the first member of their request-private data. 181 */ 182 struct nvme_request { 183 struct nvme_command *cmd; 184 union nvme_result result; 185 u8 genctr; 186 u8 retries; 187 u8 flags; 188 u16 status; 189 #ifdef CONFIG_NVME_MULTIPATH 190 unsigned long start_time; 191 #endif 192 struct nvme_ctrl *ctrl; 193 }; 194 195 /* 196 * Mark a bio as coming in through the mpath node. 197 */ 198 #define REQ_NVME_MPATH REQ_DRV 199 200 enum { 201 NVME_REQ_CANCELLED = (1 << 0), 202 NVME_REQ_USERCMD = (1 << 1), 203 NVME_MPATH_IO_STATS = (1 << 2), 204 NVME_MPATH_CNT_ACTIVE = (1 << 3), 205 }; 206 207 static inline struct nvme_request *nvme_req(struct request *req) 208 { 209 return blk_mq_rq_to_pdu(req); 210 } 211 212 static inline u16 nvme_req_qid(struct request *req) 213 { 214 if (!req->q->queuedata) 215 return 0; 216 217 return req->mq_hctx->queue_num + 1; 218 } 219 220 /* The below value is the specific amount of delay needed before checking 221 * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the 222 * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was 223 * found empirically. 224 */ 225 #define NVME_QUIRK_DELAY_AMOUNT 2300 226 227 /* 228 * enum nvme_ctrl_state: Controller state 229 * 230 * @NVME_CTRL_NEW: New controller just allocated, initial state 231 * @NVME_CTRL_LIVE: Controller is connected and I/O capable 232 * @NVME_CTRL_RESETTING: Controller is resetting (or scheduled reset) 233 * @NVME_CTRL_CONNECTING: Controller is disconnected, now connecting the 234 * transport 235 * @NVME_CTRL_DELETING: Controller is deleting (or scheduled deletion) 236 * @NVME_CTRL_DELETING_NOIO: Controller is deleting and I/O is not 237 * disabled/failed immediately. This state comes 238 * after all async event processing took place and 239 * before ns removal and the controller deletion 240 * progress 241 * @NVME_CTRL_DEAD: Controller is non-present/unresponsive during 242 * shutdown or removal. In this case we forcibly 243 * kill all inflight I/O as they have no chance to 244 * complete 245 */ 246 enum nvme_ctrl_state { 247 NVME_CTRL_NEW, 248 NVME_CTRL_LIVE, 249 NVME_CTRL_RESETTING, 250 NVME_CTRL_CONNECTING, 251 NVME_CTRL_DELETING, 252 NVME_CTRL_DELETING_NOIO, 253 NVME_CTRL_DEAD, 254 }; 255 256 struct nvme_fault_inject { 257 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS 258 struct fault_attr attr; 259 struct dentry *parent; 260 bool dont_retry; /* DNR, do not retry */ 261 u16 status; /* status code */ 262 #endif 263 }; 264 265 enum nvme_ctrl_flags { 266 NVME_CTRL_FAILFAST_EXPIRED = 0, 267 NVME_CTRL_ADMIN_Q_STOPPED = 1, 268 NVME_CTRL_STARTED_ONCE = 2, 269 NVME_CTRL_STOPPED = 3, 270 NVME_CTRL_SKIP_ID_CNS_CS = 4, 271 NVME_CTRL_DIRTY_CAPABILITY = 5, 272 NVME_CTRL_FROZEN = 6, 273 }; 274 275 struct nvme_ctrl { 276 bool comp_seen; 277 bool identified; 278 bool passthru_err_log_enabled; 279 enum nvme_ctrl_state state; 280 spinlock_t lock; 281 struct mutex scan_lock; 282 const struct nvme_ctrl_ops *ops; 283 struct request_queue *admin_q; 284 struct request_queue *connect_q; 285 struct request_queue *fabrics_q; 286 struct device *dev; 287 int instance; 288 int numa_node; 289 struct blk_mq_tag_set *tagset; 290 struct blk_mq_tag_set *admin_tagset; 291 struct list_head namespaces; 292 struct mutex namespaces_lock; 293 struct srcu_struct srcu; 294 struct device ctrl_device; 295 struct device *device; /* char device */ 296 #ifdef CONFIG_NVME_HWMON 297 struct device *hwmon_device; 298 #endif 299 struct cdev cdev; 300 struct work_struct reset_work; 301 struct work_struct delete_work; 302 wait_queue_head_t state_wq; 303 304 struct nvme_subsystem *subsys; 305 struct list_head subsys_entry; 306 307 struct opal_dev *opal_dev; 308 309 u16 cntlid; 310 311 u16 mtfa; 312 u32 ctrl_config; 313 u32 queue_count; 314 315 u64 cap; 316 u32 max_hw_sectors; 317 u32 max_segments; 318 u32 max_integrity_segments; 319 u32 max_zeroes_sectors; 320 #ifdef CONFIG_BLK_DEV_ZONED 321 u32 max_zone_append; 322 #endif 323 u16 crdt[3]; 324 u16 oncs; 325 u8 dmrl; 326 u32 dmrsl; 327 u16 oacs; 328 u16 sqsize; 329 u32 max_namespaces; 330 atomic_t abort_limit; 331 u8 vwc; 332 u32 vs; 333 u32 sgls; 334 u16 kas; 335 u8 npss; 336 u8 apsta; 337 u16 wctemp; 338 u16 cctemp; 339 u32 oaes; 340 u32 aen_result; 341 u32 ctratt; 342 unsigned int shutdown_timeout; 343 unsigned int kato; 344 bool subsystem; 345 unsigned long quirks; 346 struct nvme_id_power_state psd[32]; 347 struct nvme_effects_log *effects; 348 struct xarray cels; 349 struct work_struct scan_work; 350 struct work_struct async_event_work; 351 struct delayed_work ka_work; 352 struct delayed_work failfast_work; 353 struct nvme_command ka_cmd; 354 unsigned long ka_last_check_time; 355 struct work_struct fw_act_work; 356 unsigned long events; 357 358 #ifdef CONFIG_NVME_MULTIPATH 359 /* asymmetric namespace access: */ 360 u8 anacap; 361 u8 anatt; 362 u32 anagrpmax; 363 u32 nanagrpid; 364 struct mutex ana_lock; 365 struct nvme_ana_rsp_hdr *ana_log_buf; 366 size_t ana_log_size; 367 struct timer_list anatt_timer; 368 struct work_struct ana_work; 369 atomic_t nr_active; 370 #endif 371 372 #ifdef CONFIG_NVME_HOST_AUTH 373 struct work_struct dhchap_auth_work; 374 struct mutex dhchap_auth_mutex; 375 struct nvme_dhchap_queue_context *dhchap_ctxs; 376 struct nvme_dhchap_key *host_key; 377 struct nvme_dhchap_key *ctrl_key; 378 u16 transaction; 379 #endif 380 key_serial_t tls_pskid; 381 382 /* Power saving configuration */ 383 u64 ps_max_latency_us; 384 bool apst_enabled; 385 386 /* PCIe only: */ 387 u16 hmmaxd; 388 u32 hmpre; 389 u32 hmmin; 390 u32 hmminds; 391 392 /* Fabrics only */ 393 u32 ioccsz; 394 u32 iorcsz; 395 u16 icdoff; 396 u16 maxcmd; 397 int nr_reconnects; 398 unsigned long flags; 399 struct nvmf_ctrl_options *opts; 400 401 struct page *discard_page; 402 unsigned long discard_page_busy; 403 404 struct nvme_fault_inject fault_inject; 405 406 enum nvme_ctrl_type cntrltype; 407 enum nvme_dctype dctype; 408 }; 409 410 static inline enum nvme_ctrl_state nvme_ctrl_state(struct nvme_ctrl *ctrl) 411 { 412 return READ_ONCE(ctrl->state); 413 } 414 415 enum nvme_iopolicy { 416 NVME_IOPOLICY_NUMA, 417 NVME_IOPOLICY_RR, 418 NVME_IOPOLICY_QD, 419 }; 420 421 struct nvme_subsystem { 422 int instance; 423 struct device dev; 424 /* 425 * Because we unregister the device on the last put we need 426 * a separate refcount. 427 */ 428 struct kref ref; 429 struct list_head entry; 430 struct mutex lock; 431 struct list_head ctrls; 432 struct list_head nsheads; 433 char subnqn[NVMF_NQN_SIZE]; 434 char serial[20]; 435 char model[40]; 436 char firmware_rev[8]; 437 u8 cmic; 438 enum nvme_subsys_type subtype; 439 u16 vendor_id; 440 u16 awupf; /* 0's based awupf value. */ 441 struct ida ns_ida; 442 #ifdef CONFIG_NVME_MULTIPATH 443 enum nvme_iopolicy iopolicy; 444 #endif 445 }; 446 447 /* 448 * Container structure for uniqueue namespace identifiers. 449 */ 450 struct nvme_ns_ids { 451 u8 eui64[8]; 452 u8 nguid[16]; 453 uuid_t uuid; 454 u8 csi; 455 }; 456 457 /* 458 * Anchor structure for namespaces. There is one for each namespace in a 459 * NVMe subsystem that any of our controllers can see, and the namespace 460 * structure for each controller is chained of it. For private namespaces 461 * there is a 1:1 relation to our namespace structures, that is ->list 462 * only ever has a single entry for private namespaces. 463 */ 464 struct nvme_ns_head { 465 struct list_head list; 466 struct srcu_struct srcu; 467 struct nvme_subsystem *subsys; 468 struct nvme_ns_ids ids; 469 u8 lba_shift; 470 u16 ms; 471 u16 pi_size; 472 u8 pi_type; 473 u8 guard_type; 474 struct list_head entry; 475 struct kref ref; 476 bool shared; 477 bool passthru_err_log_enabled; 478 struct nvme_effects_log *effects; 479 u64 nuse; 480 unsigned ns_id; 481 int instance; 482 #ifdef CONFIG_BLK_DEV_ZONED 483 u64 zsze; 484 #endif 485 unsigned long features; 486 487 struct ratelimit_state rs_nuse; 488 489 struct cdev cdev; 490 struct device cdev_device; 491 492 struct gendisk *disk; 493 #ifdef CONFIG_NVME_MULTIPATH 494 struct bio_list requeue_list; 495 spinlock_t requeue_lock; 496 struct work_struct requeue_work; 497 struct work_struct partition_scan_work; 498 struct mutex lock; 499 unsigned long flags; 500 #define NVME_NSHEAD_DISK_LIVE 0 501 struct nvme_ns __rcu *current_path[]; 502 #endif 503 }; 504 505 static inline bool nvme_ns_head_multipath(struct nvme_ns_head *head) 506 { 507 return IS_ENABLED(CONFIG_NVME_MULTIPATH) && head->disk; 508 } 509 510 enum nvme_ns_features { 511 NVME_NS_EXT_LBAS = 1 << 0, /* support extended LBA format */ 512 NVME_NS_METADATA_SUPPORTED = 1 << 1, /* support getting generated md */ 513 NVME_NS_DEAC = 1 << 2, /* DEAC bit in Write Zeores supported */ 514 }; 515 516 struct nvme_ns { 517 struct list_head list; 518 519 struct nvme_ctrl *ctrl; 520 struct request_queue *queue; 521 struct gendisk *disk; 522 #ifdef CONFIG_NVME_MULTIPATH 523 enum nvme_ana_state ana_state; 524 u32 ana_grpid; 525 #endif 526 struct list_head siblings; 527 struct kref kref; 528 struct nvme_ns_head *head; 529 530 unsigned long flags; 531 #define NVME_NS_REMOVING 0 532 #define NVME_NS_ANA_PENDING 2 533 #define NVME_NS_FORCE_RO 3 534 #define NVME_NS_READY 4 535 536 struct cdev cdev; 537 struct device cdev_device; 538 539 struct nvme_fault_inject fault_inject; 540 }; 541 542 /* NVMe ns supports metadata actions by the controller (generate/strip) */ 543 static inline bool nvme_ns_has_pi(struct nvme_ns_head *head) 544 { 545 return head->pi_type && head->ms == head->pi_size; 546 } 547 548 struct nvme_ctrl_ops { 549 const char *name; 550 struct module *module; 551 unsigned int flags; 552 #define NVME_F_FABRICS (1 << 0) 553 #define NVME_F_METADATA_SUPPORTED (1 << 1) 554 #define NVME_F_BLOCKING (1 << 2) 555 556 const struct attribute_group **dev_attr_groups; 557 int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val); 558 int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val); 559 int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val); 560 void (*free_ctrl)(struct nvme_ctrl *ctrl); 561 void (*submit_async_event)(struct nvme_ctrl *ctrl); 562 int (*subsystem_reset)(struct nvme_ctrl *ctrl); 563 void (*delete_ctrl)(struct nvme_ctrl *ctrl); 564 void (*stop_ctrl)(struct nvme_ctrl *ctrl); 565 int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size); 566 void (*print_device_info)(struct nvme_ctrl *ctrl); 567 bool (*supports_pci_p2pdma)(struct nvme_ctrl *ctrl); 568 }; 569 570 /* 571 * nvme command_id is constructed as such: 572 * | xxxx | xxxxxxxxxxxx | 573 * gen request tag 574 */ 575 #define nvme_genctr_mask(gen) (gen & 0xf) 576 #define nvme_cid_install_genctr(gen) (nvme_genctr_mask(gen) << 12) 577 #define nvme_genctr_from_cid(cid) ((cid & 0xf000) >> 12) 578 #define nvme_tag_from_cid(cid) (cid & 0xfff) 579 580 static inline u16 nvme_cid(struct request *rq) 581 { 582 return nvme_cid_install_genctr(nvme_req(rq)->genctr) | rq->tag; 583 } 584 585 static inline struct request *nvme_find_rq(struct blk_mq_tags *tags, 586 u16 command_id) 587 { 588 u8 genctr = nvme_genctr_from_cid(command_id); 589 u16 tag = nvme_tag_from_cid(command_id); 590 struct request *rq; 591 592 rq = blk_mq_tag_to_rq(tags, tag); 593 if (unlikely(!rq)) { 594 pr_err("could not locate request for tag %#x\n", 595 tag); 596 return NULL; 597 } 598 if (unlikely(nvme_genctr_mask(nvme_req(rq)->genctr) != genctr)) { 599 dev_err(nvme_req(rq)->ctrl->device, 600 "request %#x genctr mismatch (got %#x expected %#x)\n", 601 tag, genctr, nvme_genctr_mask(nvme_req(rq)->genctr)); 602 return NULL; 603 } 604 return rq; 605 } 606 607 static inline struct request *nvme_cid_to_rq(struct blk_mq_tags *tags, 608 u16 command_id) 609 { 610 return blk_mq_tag_to_rq(tags, nvme_tag_from_cid(command_id)); 611 } 612 613 /* 614 * Return the length of the string without the space padding 615 */ 616 static inline int nvme_strlen(char *s, int len) 617 { 618 while (s[len - 1] == ' ') 619 len--; 620 return len; 621 } 622 623 static inline void nvme_print_device_info(struct nvme_ctrl *ctrl) 624 { 625 struct nvme_subsystem *subsys = ctrl->subsys; 626 627 if (ctrl->ops->print_device_info) { 628 ctrl->ops->print_device_info(ctrl); 629 return; 630 } 631 632 dev_err(ctrl->device, 633 "VID:%04x model:%.*s firmware:%.*s\n", subsys->vendor_id, 634 nvme_strlen(subsys->model, sizeof(subsys->model)), 635 subsys->model, nvme_strlen(subsys->firmware_rev, 636 sizeof(subsys->firmware_rev)), 637 subsys->firmware_rev); 638 } 639 640 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS 641 void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj, 642 const char *dev_name); 643 void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inject); 644 void nvme_should_fail(struct request *req); 645 #else 646 static inline void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj, 647 const char *dev_name) 648 { 649 } 650 static inline void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inj) 651 { 652 } 653 static inline void nvme_should_fail(struct request *req) {} 654 #endif 655 656 bool nvme_wait_reset(struct nvme_ctrl *ctrl); 657 int nvme_try_sched_reset(struct nvme_ctrl *ctrl); 658 659 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl) 660 { 661 if (!ctrl->subsystem || !ctrl->ops->subsystem_reset) 662 return -ENOTTY; 663 return ctrl->ops->subsystem_reset(ctrl); 664 } 665 666 /* 667 * Convert a 512B sector number to a device logical block number. 668 */ 669 static inline u64 nvme_sect_to_lba(struct nvme_ns_head *head, sector_t sector) 670 { 671 return sector >> (head->lba_shift - SECTOR_SHIFT); 672 } 673 674 /* 675 * Convert a device logical block number to a 512B sector number. 676 */ 677 static inline sector_t nvme_lba_to_sect(struct nvme_ns_head *head, u64 lba) 678 { 679 return lba << (head->lba_shift - SECTOR_SHIFT); 680 } 681 682 /* 683 * Convert byte length to nvme's 0-based num dwords 684 */ 685 static inline u32 nvme_bytes_to_numd(size_t len) 686 { 687 return (len >> 2) - 1; 688 } 689 690 static inline bool nvme_is_ana_error(u16 status) 691 { 692 switch (status & NVME_SCT_SC_MASK) { 693 case NVME_SC_ANA_TRANSITION: 694 case NVME_SC_ANA_INACCESSIBLE: 695 case NVME_SC_ANA_PERSISTENT_LOSS: 696 return true; 697 default: 698 return false; 699 } 700 } 701 702 static inline bool nvme_is_path_error(u16 status) 703 { 704 /* check for a status code type of 'path related status' */ 705 return (status & NVME_SCT_MASK) == NVME_SCT_PATH; 706 } 707 708 /* 709 * Fill in the status and result information from the CQE, and then figure out 710 * if blk-mq will need to use IPI magic to complete the request, and if yes do 711 * so. If not let the caller complete the request without an indirect function 712 * call. 713 */ 714 static inline bool nvme_try_complete_req(struct request *req, __le16 status, 715 union nvme_result result) 716 { 717 struct nvme_request *rq = nvme_req(req); 718 struct nvme_ctrl *ctrl = rq->ctrl; 719 720 if (!(ctrl->quirks & NVME_QUIRK_SKIP_CID_GEN)) 721 rq->genctr++; 722 723 rq->status = le16_to_cpu(status) >> 1; 724 rq->result = result; 725 /* inject error when permitted by fault injection framework */ 726 nvme_should_fail(req); 727 if (unlikely(blk_should_fake_timeout(req->q))) 728 return true; 729 return blk_mq_complete_request_remote(req); 730 } 731 732 static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl) 733 { 734 get_device(ctrl->device); 735 } 736 737 static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl) 738 { 739 put_device(ctrl->device); 740 } 741 742 static inline bool nvme_is_aen_req(u16 qid, __u16 command_id) 743 { 744 return !qid && 745 nvme_tag_from_cid(command_id) >= NVME_AQ_BLK_MQ_DEPTH; 746 } 747 748 /* 749 * Returns true for sink states that can't ever transition back to live. 750 */ 751 static inline bool nvme_state_terminal(struct nvme_ctrl *ctrl) 752 { 753 switch (nvme_ctrl_state(ctrl)) { 754 case NVME_CTRL_NEW: 755 case NVME_CTRL_LIVE: 756 case NVME_CTRL_RESETTING: 757 case NVME_CTRL_CONNECTING: 758 return false; 759 case NVME_CTRL_DELETING: 760 case NVME_CTRL_DELETING_NOIO: 761 case NVME_CTRL_DEAD: 762 return true; 763 default: 764 WARN_ONCE(1, "Unhandled ctrl state:%d", ctrl->state); 765 return true; 766 } 767 } 768 769 void nvme_end_req(struct request *req); 770 void nvme_complete_rq(struct request *req); 771 void nvme_complete_batch_req(struct request *req); 772 773 static __always_inline void nvme_complete_batch(struct io_comp_batch *iob, 774 void (*fn)(struct request *rq)) 775 { 776 struct request *req; 777 778 rq_list_for_each(&iob->req_list, req) { 779 fn(req); 780 nvme_complete_batch_req(req); 781 } 782 blk_mq_end_request_batch(iob); 783 } 784 785 blk_status_t nvme_host_path_error(struct request *req); 786 bool nvme_cancel_request(struct request *req, void *data); 787 void nvme_cancel_tagset(struct nvme_ctrl *ctrl); 788 void nvme_cancel_admin_tagset(struct nvme_ctrl *ctrl); 789 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl, 790 enum nvme_ctrl_state new_state); 791 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, bool shutdown); 792 int nvme_enable_ctrl(struct nvme_ctrl *ctrl); 793 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev, 794 const struct nvme_ctrl_ops *ops, unsigned long quirks); 795 int nvme_add_ctrl(struct nvme_ctrl *ctrl); 796 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl); 797 void nvme_start_ctrl(struct nvme_ctrl *ctrl); 798 void nvme_stop_ctrl(struct nvme_ctrl *ctrl); 799 int nvme_init_ctrl_finish(struct nvme_ctrl *ctrl, bool was_suspended); 800 int nvme_alloc_admin_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set, 801 const struct blk_mq_ops *ops, unsigned int cmd_size); 802 void nvme_remove_admin_tag_set(struct nvme_ctrl *ctrl); 803 int nvme_alloc_io_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set, 804 const struct blk_mq_ops *ops, unsigned int nr_maps, 805 unsigned int cmd_size); 806 void nvme_remove_io_tag_set(struct nvme_ctrl *ctrl); 807 808 void nvme_remove_namespaces(struct nvme_ctrl *ctrl); 809 810 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status, 811 volatile union nvme_result *res); 812 813 void nvme_quiesce_io_queues(struct nvme_ctrl *ctrl); 814 void nvme_unquiesce_io_queues(struct nvme_ctrl *ctrl); 815 void nvme_quiesce_admin_queue(struct nvme_ctrl *ctrl); 816 void nvme_unquiesce_admin_queue(struct nvme_ctrl *ctrl); 817 void nvme_mark_namespaces_dead(struct nvme_ctrl *ctrl); 818 void nvme_sync_queues(struct nvme_ctrl *ctrl); 819 void nvme_sync_io_queues(struct nvme_ctrl *ctrl); 820 void nvme_unfreeze(struct nvme_ctrl *ctrl); 821 void nvme_wait_freeze(struct nvme_ctrl *ctrl); 822 int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout); 823 void nvme_start_freeze(struct nvme_ctrl *ctrl); 824 825 static inline enum req_op nvme_req_op(struct nvme_command *cmd) 826 { 827 return nvme_is_write(cmd) ? REQ_OP_DRV_OUT : REQ_OP_DRV_IN; 828 } 829 830 #define NVME_QID_ANY -1 831 void nvme_init_request(struct request *req, struct nvme_command *cmd); 832 void nvme_cleanup_cmd(struct request *req); 833 blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req); 834 blk_status_t nvme_fail_nonready_command(struct nvme_ctrl *ctrl, 835 struct request *req); 836 bool __nvme_check_ready(struct nvme_ctrl *ctrl, struct request *rq, 837 bool queue_live, enum nvme_ctrl_state state); 838 839 static inline bool nvme_check_ready(struct nvme_ctrl *ctrl, struct request *rq, 840 bool queue_live) 841 { 842 enum nvme_ctrl_state state = nvme_ctrl_state(ctrl); 843 844 if (likely(state == NVME_CTRL_LIVE)) 845 return true; 846 if (ctrl->ops->flags & NVME_F_FABRICS && state == NVME_CTRL_DELETING) 847 return queue_live; 848 return __nvme_check_ready(ctrl, rq, queue_live, state); 849 } 850 851 /* 852 * NSID shall be unique for all shared namespaces, or if at least one of the 853 * following conditions is met: 854 * 1. Namespace Management is supported by the controller 855 * 2. ANA is supported by the controller 856 * 3. NVM Set are supported by the controller 857 * 858 * In other case, private namespace are not required to report a unique NSID. 859 */ 860 static inline bool nvme_is_unique_nsid(struct nvme_ctrl *ctrl, 861 struct nvme_ns_head *head) 862 { 863 return head->shared || 864 (ctrl->oacs & NVME_CTRL_OACS_NS_MNGT_SUPP) || 865 (ctrl->subsys->cmic & NVME_CTRL_CMIC_ANA) || 866 (ctrl->ctratt & NVME_CTRL_CTRATT_NVM_SETS); 867 } 868 869 /* 870 * Flags for __nvme_submit_sync_cmd() 871 */ 872 typedef __u32 __bitwise nvme_submit_flags_t; 873 874 enum { 875 /* Insert request at the head of the queue */ 876 NVME_SUBMIT_AT_HEAD = (__force nvme_submit_flags_t)(1 << 0), 877 /* Set BLK_MQ_REQ_NOWAIT when allocating request */ 878 NVME_SUBMIT_NOWAIT = (__force nvme_submit_flags_t)(1 << 1), 879 /* Set BLK_MQ_REQ_RESERVED when allocating request */ 880 NVME_SUBMIT_RESERVED = (__force nvme_submit_flags_t)(1 << 2), 881 /* Retry command when NVME_STATUS_DNR is not set in the result */ 882 NVME_SUBMIT_RETRY = (__force nvme_submit_flags_t)(1 << 3), 883 }; 884 885 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 886 void *buf, unsigned bufflen); 887 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 888 union nvme_result *result, void *buffer, unsigned bufflen, 889 int qid, nvme_submit_flags_t flags); 890 int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid, 891 unsigned int dword11, void *buffer, size_t buflen, 892 u32 *result); 893 int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid, 894 unsigned int dword11, void *buffer, size_t buflen, 895 u32 *result); 896 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count); 897 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl); 898 int nvme_reset_ctrl(struct nvme_ctrl *ctrl); 899 int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl); 900 int nvme_delete_ctrl(struct nvme_ctrl *ctrl); 901 void nvme_queue_scan(struct nvme_ctrl *ctrl); 902 int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi, 903 void *log, size_t size, u64 offset); 904 bool nvme_tryget_ns_head(struct nvme_ns_head *head); 905 void nvme_put_ns_head(struct nvme_ns_head *head); 906 int nvme_cdev_add(struct cdev *cdev, struct device *cdev_device, 907 const struct file_operations *fops, struct module *owner); 908 void nvme_cdev_del(struct cdev *cdev, struct device *cdev_device); 909 int nvme_ioctl(struct block_device *bdev, blk_mode_t mode, 910 unsigned int cmd, unsigned long arg); 911 long nvme_ns_chr_ioctl(struct file *file, unsigned int cmd, unsigned long arg); 912 int nvme_ns_head_ioctl(struct block_device *bdev, blk_mode_t mode, 913 unsigned int cmd, unsigned long arg); 914 long nvme_ns_head_chr_ioctl(struct file *file, unsigned int cmd, 915 unsigned long arg); 916 long nvme_dev_ioctl(struct file *file, unsigned int cmd, 917 unsigned long arg); 918 int nvme_ns_chr_uring_cmd_iopoll(struct io_uring_cmd *ioucmd, 919 struct io_comp_batch *iob, unsigned int poll_flags); 920 int nvme_ns_chr_uring_cmd(struct io_uring_cmd *ioucmd, 921 unsigned int issue_flags); 922 int nvme_ns_head_chr_uring_cmd(struct io_uring_cmd *ioucmd, 923 unsigned int issue_flags); 924 int nvme_identify_ns(struct nvme_ctrl *ctrl, unsigned nsid, 925 struct nvme_id_ns **id); 926 int nvme_getgeo(struct block_device *bdev, struct hd_geometry *geo); 927 int nvme_dev_uring_cmd(struct io_uring_cmd *ioucmd, unsigned int issue_flags); 928 929 extern const struct attribute_group *nvme_ns_attr_groups[]; 930 extern const struct pr_ops nvme_pr_ops; 931 extern const struct block_device_operations nvme_ns_head_ops; 932 extern const struct attribute_group nvme_dev_attrs_group; 933 extern const struct attribute_group *nvme_subsys_attrs_groups[]; 934 extern const struct attribute_group *nvme_dev_attr_groups[]; 935 extern const struct block_device_operations nvme_bdev_ops; 936 937 void nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl); 938 struct nvme_ns *nvme_find_path(struct nvme_ns_head *head); 939 #ifdef CONFIG_NVME_MULTIPATH 940 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl) 941 { 942 return ctrl->ana_log_buf != NULL; 943 } 944 945 void nvme_mpath_unfreeze(struct nvme_subsystem *subsys); 946 void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys); 947 void nvme_mpath_start_freeze(struct nvme_subsystem *subsys); 948 void nvme_mpath_default_iopolicy(struct nvme_subsystem *subsys); 949 void nvme_failover_req(struct request *req); 950 void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl); 951 int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head); 952 void nvme_mpath_add_disk(struct nvme_ns *ns, __le32 anagrpid); 953 void nvme_mpath_remove_disk(struct nvme_ns_head *head); 954 int nvme_mpath_init_identify(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id); 955 void nvme_mpath_init_ctrl(struct nvme_ctrl *ctrl); 956 void nvme_mpath_update(struct nvme_ctrl *ctrl); 957 void nvme_mpath_uninit(struct nvme_ctrl *ctrl); 958 void nvme_mpath_stop(struct nvme_ctrl *ctrl); 959 bool nvme_mpath_clear_current_path(struct nvme_ns *ns); 960 void nvme_mpath_revalidate_paths(struct nvme_ns *ns); 961 void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl); 962 void nvme_mpath_shutdown_disk(struct nvme_ns_head *head); 963 void nvme_mpath_start_request(struct request *rq); 964 void nvme_mpath_end_request(struct request *rq); 965 966 static inline void nvme_trace_bio_complete(struct request *req) 967 { 968 struct nvme_ns *ns = req->q->queuedata; 969 970 if ((req->cmd_flags & REQ_NVME_MPATH) && req->bio) 971 trace_block_bio_complete(ns->head->disk->queue, req->bio); 972 } 973 974 extern bool multipath; 975 extern struct device_attribute dev_attr_ana_grpid; 976 extern struct device_attribute dev_attr_ana_state; 977 extern struct device_attribute subsys_attr_iopolicy; 978 979 static inline bool nvme_disk_is_ns_head(struct gendisk *disk) 980 { 981 return disk->fops == &nvme_ns_head_ops; 982 } 983 #else 984 #define multipath false 985 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl) 986 { 987 return false; 988 } 989 static inline void nvme_failover_req(struct request *req) 990 { 991 } 992 static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl) 993 { 994 } 995 static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl, 996 struct nvme_ns_head *head) 997 { 998 return 0; 999 } 1000 static inline void nvme_mpath_add_disk(struct nvme_ns *ns, __le32 anagrpid) 1001 { 1002 } 1003 static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head) 1004 { 1005 } 1006 static inline bool nvme_mpath_clear_current_path(struct nvme_ns *ns) 1007 { 1008 return false; 1009 } 1010 static inline void nvme_mpath_revalidate_paths(struct nvme_ns *ns) 1011 { 1012 } 1013 static inline void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl) 1014 { 1015 } 1016 static inline void nvme_mpath_shutdown_disk(struct nvme_ns_head *head) 1017 { 1018 } 1019 static inline void nvme_trace_bio_complete(struct request *req) 1020 { 1021 } 1022 static inline void nvme_mpath_init_ctrl(struct nvme_ctrl *ctrl) 1023 { 1024 } 1025 static inline int nvme_mpath_init_identify(struct nvme_ctrl *ctrl, 1026 struct nvme_id_ctrl *id) 1027 { 1028 if (ctrl->subsys->cmic & NVME_CTRL_CMIC_ANA) 1029 dev_warn(ctrl->device, 1030 "Please enable CONFIG_NVME_MULTIPATH for full support of multi-port devices.\n"); 1031 return 0; 1032 } 1033 static inline void nvme_mpath_update(struct nvme_ctrl *ctrl) 1034 { 1035 } 1036 static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl) 1037 { 1038 } 1039 static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl) 1040 { 1041 } 1042 static inline void nvme_mpath_unfreeze(struct nvme_subsystem *subsys) 1043 { 1044 } 1045 static inline void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys) 1046 { 1047 } 1048 static inline void nvme_mpath_start_freeze(struct nvme_subsystem *subsys) 1049 { 1050 } 1051 static inline void nvme_mpath_default_iopolicy(struct nvme_subsystem *subsys) 1052 { 1053 } 1054 static inline void nvme_mpath_start_request(struct request *rq) 1055 { 1056 } 1057 static inline void nvme_mpath_end_request(struct request *rq) 1058 { 1059 } 1060 static inline bool nvme_disk_is_ns_head(struct gendisk *disk) 1061 { 1062 return false; 1063 } 1064 #endif /* CONFIG_NVME_MULTIPATH */ 1065 1066 int nvme_ns_get_unique_id(struct nvme_ns *ns, u8 id[16], 1067 enum blk_unique_id type); 1068 1069 struct nvme_zone_info { 1070 u64 zone_size; 1071 unsigned int max_open_zones; 1072 unsigned int max_active_zones; 1073 }; 1074 1075 int nvme_ns_report_zones(struct nvme_ns *ns, sector_t sector, 1076 unsigned int nr_zones, report_zones_cb cb, void *data); 1077 int nvme_query_zone_info(struct nvme_ns *ns, unsigned lbaf, 1078 struct nvme_zone_info *zi); 1079 void nvme_update_zone_info(struct nvme_ns *ns, struct queue_limits *lim, 1080 struct nvme_zone_info *zi); 1081 #ifdef CONFIG_BLK_DEV_ZONED 1082 blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, struct request *req, 1083 struct nvme_command *cmnd, 1084 enum nvme_zone_mgmt_action action); 1085 #else 1086 static inline blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, 1087 struct request *req, struct nvme_command *cmnd, 1088 enum nvme_zone_mgmt_action action) 1089 { 1090 return BLK_STS_NOTSUPP; 1091 } 1092 #endif 1093 1094 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev) 1095 { 1096 struct gendisk *disk = dev_to_disk(dev); 1097 1098 WARN_ON(nvme_disk_is_ns_head(disk)); 1099 return disk->private_data; 1100 } 1101 1102 #ifdef CONFIG_NVME_HWMON 1103 int nvme_hwmon_init(struct nvme_ctrl *ctrl); 1104 void nvme_hwmon_exit(struct nvme_ctrl *ctrl); 1105 #else 1106 static inline int nvme_hwmon_init(struct nvme_ctrl *ctrl) 1107 { 1108 return 0; 1109 } 1110 1111 static inline void nvme_hwmon_exit(struct nvme_ctrl *ctrl) 1112 { 1113 } 1114 #endif 1115 1116 static inline void nvme_start_request(struct request *rq) 1117 { 1118 if (rq->cmd_flags & REQ_NVME_MPATH) 1119 nvme_mpath_start_request(rq); 1120 blk_mq_start_request(rq); 1121 } 1122 1123 static inline bool nvme_ctrl_sgl_supported(struct nvme_ctrl *ctrl) 1124 { 1125 return ctrl->sgls & ((1 << 0) | (1 << 1)); 1126 } 1127 1128 #ifdef CONFIG_NVME_HOST_AUTH 1129 int __init nvme_init_auth(void); 1130 void __exit nvme_exit_auth(void); 1131 int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl); 1132 void nvme_auth_stop(struct nvme_ctrl *ctrl); 1133 int nvme_auth_negotiate(struct nvme_ctrl *ctrl, int qid); 1134 int nvme_auth_wait(struct nvme_ctrl *ctrl, int qid); 1135 void nvme_auth_free(struct nvme_ctrl *ctrl); 1136 #else 1137 static inline int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl) 1138 { 1139 return 0; 1140 } 1141 static inline int __init nvme_init_auth(void) 1142 { 1143 return 0; 1144 } 1145 static inline void __exit nvme_exit_auth(void) 1146 { 1147 } 1148 static inline void nvme_auth_stop(struct nvme_ctrl *ctrl) {}; 1149 static inline int nvme_auth_negotiate(struct nvme_ctrl *ctrl, int qid) 1150 { 1151 return -EPROTONOSUPPORT; 1152 } 1153 static inline int nvme_auth_wait(struct nvme_ctrl *ctrl, int qid) 1154 { 1155 return -EPROTONOSUPPORT; 1156 } 1157 static inline void nvme_auth_free(struct nvme_ctrl *ctrl) {}; 1158 #endif 1159 1160 u32 nvme_command_effects(struct nvme_ctrl *ctrl, struct nvme_ns *ns, 1161 u8 opcode); 1162 u32 nvme_passthru_start(struct nvme_ctrl *ctrl, struct nvme_ns *ns, u8 opcode); 1163 int nvme_execute_rq(struct request *rq, bool at_head); 1164 void nvme_passthru_end(struct nvme_ctrl *ctrl, struct nvme_ns *ns, u32 effects, 1165 struct nvme_command *cmd, int status); 1166 struct nvme_ctrl *nvme_ctrl_from_file(struct file *file); 1167 struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid); 1168 bool nvme_get_ns(struct nvme_ns *ns); 1169 void nvme_put_ns(struct nvme_ns *ns); 1170 1171 static inline bool nvme_multi_css(struct nvme_ctrl *ctrl) 1172 { 1173 return (ctrl->ctrl_config & NVME_CC_CSS_MASK) == NVME_CC_CSS_CSI; 1174 } 1175 1176 #ifdef CONFIG_NVME_VERBOSE_ERRORS 1177 const char *nvme_get_error_status_str(u16 status); 1178 const char *nvme_get_opcode_str(u8 opcode); 1179 const char *nvme_get_admin_opcode_str(u8 opcode); 1180 const char *nvme_get_fabrics_opcode_str(u8 opcode); 1181 #else /* CONFIG_NVME_VERBOSE_ERRORS */ 1182 static inline const char *nvme_get_error_status_str(u16 status) 1183 { 1184 return "I/O Error"; 1185 } 1186 static inline const char *nvme_get_opcode_str(u8 opcode) 1187 { 1188 return "I/O Cmd"; 1189 } 1190 static inline const char *nvme_get_admin_opcode_str(u8 opcode) 1191 { 1192 return "Admin Cmd"; 1193 } 1194 1195 static inline const char *nvme_get_fabrics_opcode_str(u8 opcode) 1196 { 1197 return "Fabrics Cmd"; 1198 } 1199 #endif /* CONFIG_NVME_VERBOSE_ERRORS */ 1200 1201 static inline const char *nvme_opcode_str(int qid, u8 opcode) 1202 { 1203 return qid ? nvme_get_opcode_str(opcode) : 1204 nvme_get_admin_opcode_str(opcode); 1205 } 1206 1207 static inline const char *nvme_fabrics_opcode_str( 1208 int qid, const struct nvme_command *cmd) 1209 { 1210 if (nvme_is_fabrics(cmd)) 1211 return nvme_get_fabrics_opcode_str(cmd->fabrics.fctype); 1212 1213 return nvme_opcode_str(qid, cmd->common.opcode); 1214 } 1215 #endif /* _NVME_H */ 1216