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