1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Copyright (c) 2015-2016 HGST, a Western Digital Company. 4 */ 5 6 #ifndef _NVMET_H 7 #define _NVMET_H 8 9 #include <linux/dma-mapping.h> 10 #include <linux/types.h> 11 #include <linux/device.h> 12 #include <linux/kref.h> 13 #include <linux/percpu-refcount.h> 14 #include <linux/list.h> 15 #include <linux/mutex.h> 16 #include <linux/uuid.h> 17 #include <linux/nvme.h> 18 #include <linux/configfs.h> 19 #include <linux/rcupdate.h> 20 #include <linux/blkdev.h> 21 #include <linux/radix-tree.h> 22 #include <linux/t10-pi.h> 23 24 #define NVMET_DEFAULT_VS NVME_VS(1, 3, 0) 25 26 #define NVMET_ASYNC_EVENTS 4 27 #define NVMET_ERROR_LOG_SLOTS 128 28 #define NVMET_NO_ERROR_LOC ((u16)-1) 29 #define NVMET_DEFAULT_CTRL_MODEL "Linux" 30 #define NVMET_MN_MAX_SIZE 40 31 #define NVMET_SN_MAX_SIZE 20 32 33 /* 34 * Supported optional AENs: 35 */ 36 #define NVMET_AEN_CFG_OPTIONAL \ 37 (NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_ANA_CHANGE) 38 #define NVMET_DISC_AEN_CFG_OPTIONAL \ 39 (NVME_AEN_CFG_DISC_CHANGE) 40 41 /* 42 * Plus mandatory SMART AENs (we'll never send them, but allow enabling them): 43 */ 44 #define NVMET_AEN_CFG_ALL \ 45 (NVME_SMART_CRIT_SPARE | NVME_SMART_CRIT_TEMPERATURE | \ 46 NVME_SMART_CRIT_RELIABILITY | NVME_SMART_CRIT_MEDIA | \ 47 NVME_SMART_CRIT_VOLATILE_MEMORY | NVMET_AEN_CFG_OPTIONAL) 48 49 /* Helper Macros when NVMe error is NVME_SC_CONNECT_INVALID_PARAM 50 * The 16 bit shift is to set IATTR bit to 1, which means offending 51 * offset starts in the data section of connect() 52 */ 53 #define IPO_IATTR_CONNECT_DATA(x) \ 54 (cpu_to_le32((1 << 16) | (offsetof(struct nvmf_connect_data, x)))) 55 #define IPO_IATTR_CONNECT_SQE(x) \ 56 (cpu_to_le32(offsetof(struct nvmf_connect_command, x))) 57 58 struct nvmet_ns { 59 struct percpu_ref ref; 60 struct block_device *bdev; 61 struct file *file; 62 bool readonly; 63 u32 nsid; 64 u32 blksize_shift; 65 loff_t size; 66 u8 nguid[16]; 67 uuid_t uuid; 68 u32 anagrpid; 69 70 bool buffered_io; 71 bool enabled; 72 struct nvmet_subsys *subsys; 73 const char *device_path; 74 75 struct config_group device_group; 76 struct config_group group; 77 78 struct completion disable_done; 79 mempool_t *bvec_pool; 80 struct kmem_cache *bvec_cache; 81 82 int use_p2pmem; 83 struct pci_dev *p2p_dev; 84 int pi_type; 85 int metadata_size; 86 u8 csi; 87 }; 88 89 static inline struct nvmet_ns *to_nvmet_ns(struct config_item *item) 90 { 91 return container_of(to_config_group(item), struct nvmet_ns, group); 92 } 93 94 static inline struct device *nvmet_ns_dev(struct nvmet_ns *ns) 95 { 96 return ns->bdev ? disk_to_dev(ns->bdev->bd_disk) : NULL; 97 } 98 99 struct nvmet_cq { 100 u16 qid; 101 u16 size; 102 }; 103 104 struct nvmet_sq { 105 struct nvmet_ctrl *ctrl; 106 struct percpu_ref ref; 107 u16 qid; 108 u16 size; 109 u32 sqhd; 110 bool sqhd_disabled; 111 #ifdef CONFIG_NVME_TARGET_AUTH 112 bool authenticated; 113 u16 dhchap_tid; 114 u16 dhchap_status; 115 int dhchap_step; 116 u8 *dhchap_c1; 117 u8 *dhchap_c2; 118 u32 dhchap_s1; 119 u32 dhchap_s2; 120 u8 *dhchap_skey; 121 int dhchap_skey_len; 122 #endif 123 struct completion free_done; 124 struct completion confirm_done; 125 }; 126 127 struct nvmet_ana_group { 128 struct config_group group; 129 struct nvmet_port *port; 130 u32 grpid; 131 }; 132 133 static inline struct nvmet_ana_group *to_ana_group(struct config_item *item) 134 { 135 return container_of(to_config_group(item), struct nvmet_ana_group, 136 group); 137 } 138 139 /** 140 * struct nvmet_port - Common structure to keep port 141 * information for the target. 142 * @entry: Entry into referrals or transport list. 143 * @disc_addr: Address information is stored in a format defined 144 * for a discovery log page entry. 145 * @group: ConfigFS group for this element's folder. 146 * @priv: Private data for the transport. 147 */ 148 struct nvmet_port { 149 struct list_head entry; 150 struct nvmf_disc_rsp_page_entry disc_addr; 151 struct config_group group; 152 struct config_group subsys_group; 153 struct list_head subsystems; 154 struct config_group referrals_group; 155 struct list_head referrals; 156 struct list_head global_entry; 157 struct config_group ana_groups_group; 158 struct nvmet_ana_group ana_default_group; 159 enum nvme_ana_state *ana_state; 160 void *priv; 161 bool enabled; 162 int inline_data_size; 163 const struct nvmet_fabrics_ops *tr_ops; 164 bool pi_enable; 165 }; 166 167 static inline struct nvmet_port *to_nvmet_port(struct config_item *item) 168 { 169 return container_of(to_config_group(item), struct nvmet_port, 170 group); 171 } 172 173 static inline struct nvmet_port *ana_groups_to_port( 174 struct config_item *item) 175 { 176 return container_of(to_config_group(item), struct nvmet_port, 177 ana_groups_group); 178 } 179 180 struct nvmet_ctrl { 181 struct nvmet_subsys *subsys; 182 struct nvmet_sq **sqs; 183 184 bool reset_tbkas; 185 186 struct mutex lock; 187 u64 cap; 188 u32 cc; 189 u32 csts; 190 191 uuid_t hostid; 192 u16 cntlid; 193 u32 kato; 194 195 struct nvmet_port *port; 196 197 u32 aen_enabled; 198 unsigned long aen_masked; 199 struct nvmet_req *async_event_cmds[NVMET_ASYNC_EVENTS]; 200 unsigned int nr_async_event_cmds; 201 struct list_head async_events; 202 struct work_struct async_event_work; 203 204 struct list_head subsys_entry; 205 struct kref ref; 206 struct delayed_work ka_work; 207 struct work_struct fatal_err_work; 208 209 const struct nvmet_fabrics_ops *ops; 210 211 __le32 *changed_ns_list; 212 u32 nr_changed_ns; 213 214 char subsysnqn[NVMF_NQN_FIELD_LEN]; 215 char hostnqn[NVMF_NQN_FIELD_LEN]; 216 217 struct device *p2p_client; 218 struct radix_tree_root p2p_ns_map; 219 220 spinlock_t error_lock; 221 u64 err_counter; 222 struct nvme_error_slot slots[NVMET_ERROR_LOG_SLOTS]; 223 bool pi_support; 224 #ifdef CONFIG_NVME_TARGET_AUTH 225 struct nvme_dhchap_key *host_key; 226 struct nvme_dhchap_key *ctrl_key; 227 u8 shash_id; 228 #endif 229 }; 230 231 struct nvmet_subsys { 232 enum nvme_subsys_type type; 233 234 struct mutex lock; 235 struct kref ref; 236 237 struct xarray namespaces; 238 unsigned int nr_namespaces; 239 u32 max_nsid; 240 u16 cntlid_min; 241 u16 cntlid_max; 242 243 struct list_head ctrls; 244 245 struct list_head hosts; 246 bool allow_any_host; 247 248 u16 max_qid; 249 250 u64 ver; 251 char serial[NVMET_SN_MAX_SIZE]; 252 bool subsys_discovered; 253 char *subsysnqn; 254 bool pi_support; 255 256 struct config_group group; 257 258 struct config_group namespaces_group; 259 struct config_group allowed_hosts_group; 260 261 char *model_number; 262 263 #ifdef CONFIG_NVME_TARGET_PASSTHRU 264 struct nvme_ctrl *passthru_ctrl; 265 char *passthru_ctrl_path; 266 struct config_group passthru_group; 267 unsigned int admin_timeout; 268 unsigned int io_timeout; 269 unsigned int clear_ids; 270 #endif /* CONFIG_NVME_TARGET_PASSTHRU */ 271 272 #ifdef CONFIG_BLK_DEV_ZONED 273 u8 zasl; 274 #endif /* CONFIG_BLK_DEV_ZONED */ 275 }; 276 277 static inline struct nvmet_subsys *to_subsys(struct config_item *item) 278 { 279 return container_of(to_config_group(item), struct nvmet_subsys, group); 280 } 281 282 static inline struct nvmet_subsys *namespaces_to_subsys( 283 struct config_item *item) 284 { 285 return container_of(to_config_group(item), struct nvmet_subsys, 286 namespaces_group); 287 } 288 289 struct nvmet_host { 290 struct config_group group; 291 u8 *dhchap_secret; 292 u8 *dhchap_ctrl_secret; 293 u8 dhchap_key_hash; 294 u8 dhchap_ctrl_key_hash; 295 u8 dhchap_hash_id; 296 u8 dhchap_dhgroup_id; 297 }; 298 299 static inline struct nvmet_host *to_host(struct config_item *item) 300 { 301 return container_of(to_config_group(item), struct nvmet_host, group); 302 } 303 304 static inline char *nvmet_host_name(struct nvmet_host *host) 305 { 306 return config_item_name(&host->group.cg_item); 307 } 308 309 struct nvmet_host_link { 310 struct list_head entry; 311 struct nvmet_host *host; 312 }; 313 314 struct nvmet_subsys_link { 315 struct list_head entry; 316 struct nvmet_subsys *subsys; 317 }; 318 319 struct nvmet_req; 320 struct nvmet_fabrics_ops { 321 struct module *owner; 322 unsigned int type; 323 unsigned int msdbd; 324 unsigned int flags; 325 #define NVMF_KEYED_SGLS (1 << 0) 326 #define NVMF_METADATA_SUPPORTED (1 << 1) 327 void (*queue_response)(struct nvmet_req *req); 328 int (*add_port)(struct nvmet_port *port); 329 void (*remove_port)(struct nvmet_port *port); 330 void (*delete_ctrl)(struct nvmet_ctrl *ctrl); 331 void (*disc_traddr)(struct nvmet_req *req, 332 struct nvmet_port *port, char *traddr); 333 u16 (*install_queue)(struct nvmet_sq *nvme_sq); 334 void (*discovery_chg)(struct nvmet_port *port); 335 u8 (*get_mdts)(const struct nvmet_ctrl *ctrl); 336 u16 (*get_max_queue_size)(const struct nvmet_ctrl *ctrl); 337 }; 338 339 #define NVMET_MAX_INLINE_BIOVEC 8 340 #define NVMET_MAX_INLINE_DATA_LEN NVMET_MAX_INLINE_BIOVEC * PAGE_SIZE 341 342 struct nvmet_req { 343 struct nvme_command *cmd; 344 struct nvme_completion *cqe; 345 struct nvmet_sq *sq; 346 struct nvmet_cq *cq; 347 struct nvmet_ns *ns; 348 struct scatterlist *sg; 349 struct scatterlist *metadata_sg; 350 struct bio_vec inline_bvec[NVMET_MAX_INLINE_BIOVEC]; 351 union { 352 struct { 353 struct bio inline_bio; 354 } b; 355 struct { 356 bool mpool_alloc; 357 struct kiocb iocb; 358 struct bio_vec *bvec; 359 struct work_struct work; 360 } f; 361 struct { 362 struct bio inline_bio; 363 struct request *rq; 364 struct work_struct work; 365 bool use_workqueue; 366 } p; 367 #ifdef CONFIG_BLK_DEV_ZONED 368 struct { 369 struct bio inline_bio; 370 struct work_struct zmgmt_work; 371 } z; 372 #endif /* CONFIG_BLK_DEV_ZONED */ 373 }; 374 int sg_cnt; 375 int metadata_sg_cnt; 376 /* data length as parsed from the SGL descriptor: */ 377 size_t transfer_len; 378 size_t metadata_len; 379 380 struct nvmet_port *port; 381 382 void (*execute)(struct nvmet_req *req); 383 const struct nvmet_fabrics_ops *ops; 384 385 struct pci_dev *p2p_dev; 386 struct device *p2p_client; 387 u16 error_loc; 388 u64 error_slba; 389 }; 390 391 extern struct workqueue_struct *buffered_io_wq; 392 extern struct workqueue_struct *zbd_wq; 393 extern struct workqueue_struct *nvmet_wq; 394 395 static inline void nvmet_set_result(struct nvmet_req *req, u32 result) 396 { 397 req->cqe->result.u32 = cpu_to_le32(result); 398 } 399 400 /* 401 * NVMe command writes actually are DMA reads for us on the target side. 402 */ 403 static inline enum dma_data_direction 404 nvmet_data_dir(struct nvmet_req *req) 405 { 406 return nvme_is_write(req->cmd) ? DMA_FROM_DEVICE : DMA_TO_DEVICE; 407 } 408 409 struct nvmet_async_event { 410 struct list_head entry; 411 u8 event_type; 412 u8 event_info; 413 u8 log_page; 414 }; 415 416 static inline void nvmet_clear_aen_bit(struct nvmet_req *req, u32 bn) 417 { 418 int rae = le32_to_cpu(req->cmd->common.cdw10) & 1 << 15; 419 420 if (!rae) 421 clear_bit(bn, &req->sq->ctrl->aen_masked); 422 } 423 424 static inline bool nvmet_aen_bit_disabled(struct nvmet_ctrl *ctrl, u32 bn) 425 { 426 if (!(READ_ONCE(ctrl->aen_enabled) & (1 << bn))) 427 return true; 428 return test_and_set_bit(bn, &ctrl->aen_masked); 429 } 430 431 void nvmet_get_feat_kato(struct nvmet_req *req); 432 void nvmet_get_feat_async_event(struct nvmet_req *req); 433 u16 nvmet_set_feat_kato(struct nvmet_req *req); 434 u16 nvmet_set_feat_async_event(struct nvmet_req *req, u32 mask); 435 void nvmet_execute_async_event(struct nvmet_req *req); 436 void nvmet_start_keep_alive_timer(struct nvmet_ctrl *ctrl); 437 void nvmet_stop_keep_alive_timer(struct nvmet_ctrl *ctrl); 438 439 u16 nvmet_parse_connect_cmd(struct nvmet_req *req); 440 void nvmet_bdev_set_limits(struct block_device *bdev, struct nvme_id_ns *id); 441 u16 nvmet_bdev_parse_io_cmd(struct nvmet_req *req); 442 u16 nvmet_file_parse_io_cmd(struct nvmet_req *req); 443 u16 nvmet_bdev_zns_parse_io_cmd(struct nvmet_req *req); 444 u16 nvmet_parse_admin_cmd(struct nvmet_req *req); 445 u16 nvmet_parse_discovery_cmd(struct nvmet_req *req); 446 u16 nvmet_parse_fabrics_admin_cmd(struct nvmet_req *req); 447 u16 nvmet_parse_fabrics_io_cmd(struct nvmet_req *req); 448 449 bool nvmet_req_init(struct nvmet_req *req, struct nvmet_cq *cq, 450 struct nvmet_sq *sq, const struct nvmet_fabrics_ops *ops); 451 void nvmet_req_uninit(struct nvmet_req *req); 452 bool nvmet_check_transfer_len(struct nvmet_req *req, size_t len); 453 bool nvmet_check_data_len_lte(struct nvmet_req *req, size_t data_len); 454 void nvmet_req_complete(struct nvmet_req *req, u16 status); 455 int nvmet_req_alloc_sgls(struct nvmet_req *req); 456 void nvmet_req_free_sgls(struct nvmet_req *req); 457 458 void nvmet_execute_set_features(struct nvmet_req *req); 459 void nvmet_execute_get_features(struct nvmet_req *req); 460 void nvmet_execute_keep_alive(struct nvmet_req *req); 461 462 void nvmet_cq_setup(struct nvmet_ctrl *ctrl, struct nvmet_cq *cq, u16 qid, 463 u16 size); 464 void nvmet_sq_setup(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq, u16 qid, 465 u16 size); 466 void nvmet_sq_destroy(struct nvmet_sq *sq); 467 int nvmet_sq_init(struct nvmet_sq *sq); 468 469 void nvmet_ctrl_fatal_error(struct nvmet_ctrl *ctrl); 470 471 void nvmet_update_cc(struct nvmet_ctrl *ctrl, u32 new); 472 u16 nvmet_alloc_ctrl(const char *subsysnqn, const char *hostnqn, 473 struct nvmet_req *req, u32 kato, struct nvmet_ctrl **ctrlp); 474 struct nvmet_ctrl *nvmet_ctrl_find_get(const char *subsysnqn, 475 const char *hostnqn, u16 cntlid, 476 struct nvmet_req *req); 477 void nvmet_ctrl_put(struct nvmet_ctrl *ctrl); 478 u16 nvmet_check_ctrl_status(struct nvmet_req *req); 479 480 struct nvmet_subsys *nvmet_subsys_alloc(const char *subsysnqn, 481 enum nvme_subsys_type type); 482 void nvmet_subsys_put(struct nvmet_subsys *subsys); 483 void nvmet_subsys_del_ctrls(struct nvmet_subsys *subsys); 484 485 u16 nvmet_req_find_ns(struct nvmet_req *req); 486 void nvmet_put_namespace(struct nvmet_ns *ns); 487 int nvmet_ns_enable(struct nvmet_ns *ns); 488 void nvmet_ns_disable(struct nvmet_ns *ns); 489 struct nvmet_ns *nvmet_ns_alloc(struct nvmet_subsys *subsys, u32 nsid); 490 void nvmet_ns_free(struct nvmet_ns *ns); 491 492 void nvmet_send_ana_event(struct nvmet_subsys *subsys, 493 struct nvmet_port *port); 494 void nvmet_port_send_ana_event(struct nvmet_port *port); 495 496 int nvmet_register_transport(const struct nvmet_fabrics_ops *ops); 497 void nvmet_unregister_transport(const struct nvmet_fabrics_ops *ops); 498 499 void nvmet_port_del_ctrls(struct nvmet_port *port, 500 struct nvmet_subsys *subsys); 501 502 int nvmet_enable_port(struct nvmet_port *port); 503 void nvmet_disable_port(struct nvmet_port *port); 504 505 void nvmet_referral_enable(struct nvmet_port *parent, struct nvmet_port *port); 506 void nvmet_referral_disable(struct nvmet_port *parent, struct nvmet_port *port); 507 508 u16 nvmet_copy_to_sgl(struct nvmet_req *req, off_t off, const void *buf, 509 size_t len); 510 u16 nvmet_copy_from_sgl(struct nvmet_req *req, off_t off, void *buf, 511 size_t len); 512 u16 nvmet_zero_sgl(struct nvmet_req *req, off_t off, size_t len); 513 514 u32 nvmet_get_log_page_len(struct nvme_command *cmd); 515 u64 nvmet_get_log_page_offset(struct nvme_command *cmd); 516 517 extern struct list_head *nvmet_ports; 518 void nvmet_port_disc_changed(struct nvmet_port *port, 519 struct nvmet_subsys *subsys); 520 void nvmet_subsys_disc_changed(struct nvmet_subsys *subsys, 521 struct nvmet_host *host); 522 void nvmet_add_async_event(struct nvmet_ctrl *ctrl, u8 event_type, 523 u8 event_info, u8 log_page); 524 525 #define NVMET_QUEUE_SIZE 1024 526 #define NVMET_NR_QUEUES 128 527 #define NVMET_MAX_CMD NVMET_QUEUE_SIZE 528 529 /* 530 * Nice round number that makes a list of nsids fit into a page. 531 * Should become tunable at some point in the future. 532 */ 533 #define NVMET_MAX_NAMESPACES 1024 534 535 /* 536 * 0 is not a valid ANA group ID, so we start numbering at 1. 537 * 538 * ANA Group 1 exists without manual intervention, has namespaces assigned to it 539 * by default, and is available in an optimized state through all ports. 540 */ 541 #define NVMET_MAX_ANAGRPS 128 542 #define NVMET_DEFAULT_ANA_GRPID 1 543 544 #define NVMET_KAS 10 545 #define NVMET_DISC_KATO_MS 120000 546 547 int __init nvmet_init_configfs(void); 548 void __exit nvmet_exit_configfs(void); 549 550 int __init nvmet_init_discovery(void); 551 void nvmet_exit_discovery(void); 552 553 extern struct nvmet_subsys *nvmet_disc_subsys; 554 extern struct rw_semaphore nvmet_config_sem; 555 556 extern u32 nvmet_ana_group_enabled[NVMET_MAX_ANAGRPS + 1]; 557 extern u64 nvmet_ana_chgcnt; 558 extern struct rw_semaphore nvmet_ana_sem; 559 560 bool nvmet_host_allowed(struct nvmet_subsys *subsys, const char *hostnqn); 561 562 int nvmet_bdev_ns_enable(struct nvmet_ns *ns); 563 int nvmet_file_ns_enable(struct nvmet_ns *ns); 564 void nvmet_bdev_ns_disable(struct nvmet_ns *ns); 565 void nvmet_file_ns_disable(struct nvmet_ns *ns); 566 u16 nvmet_bdev_flush(struct nvmet_req *req); 567 u16 nvmet_file_flush(struct nvmet_req *req); 568 void nvmet_ns_changed(struct nvmet_subsys *subsys, u32 nsid); 569 void nvmet_bdev_ns_revalidate(struct nvmet_ns *ns); 570 void nvmet_file_ns_revalidate(struct nvmet_ns *ns); 571 bool nvmet_ns_revalidate(struct nvmet_ns *ns); 572 u16 blk_to_nvme_status(struct nvmet_req *req, blk_status_t blk_sts); 573 574 bool nvmet_bdev_zns_enable(struct nvmet_ns *ns); 575 void nvmet_execute_identify_cns_cs_ctrl(struct nvmet_req *req); 576 void nvmet_execute_identify_cns_cs_ns(struct nvmet_req *req); 577 void nvmet_bdev_execute_zone_mgmt_recv(struct nvmet_req *req); 578 void nvmet_bdev_execute_zone_mgmt_send(struct nvmet_req *req); 579 void nvmet_bdev_execute_zone_append(struct nvmet_req *req); 580 581 static inline u32 nvmet_rw_data_len(struct nvmet_req *req) 582 { 583 return ((u32)le16_to_cpu(req->cmd->rw.length) + 1) << 584 req->ns->blksize_shift; 585 } 586 587 static inline u32 nvmet_rw_metadata_len(struct nvmet_req *req) 588 { 589 if (!IS_ENABLED(CONFIG_BLK_DEV_INTEGRITY)) 590 return 0; 591 return ((u32)le16_to_cpu(req->cmd->rw.length) + 1) * 592 req->ns->metadata_size; 593 } 594 595 static inline u32 nvmet_dsm_len(struct nvmet_req *req) 596 { 597 return (le32_to_cpu(req->cmd->dsm.nr) + 1) * 598 sizeof(struct nvme_dsm_range); 599 } 600 601 static inline struct nvmet_subsys *nvmet_req_subsys(struct nvmet_req *req) 602 { 603 return req->sq->ctrl->subsys; 604 } 605 606 static inline bool nvmet_is_disc_subsys(struct nvmet_subsys *subsys) 607 { 608 return subsys->type != NVME_NQN_NVME; 609 } 610 611 #ifdef CONFIG_NVME_TARGET_PASSTHRU 612 void nvmet_passthru_subsys_free(struct nvmet_subsys *subsys); 613 int nvmet_passthru_ctrl_enable(struct nvmet_subsys *subsys); 614 void nvmet_passthru_ctrl_disable(struct nvmet_subsys *subsys); 615 u16 nvmet_parse_passthru_admin_cmd(struct nvmet_req *req); 616 u16 nvmet_parse_passthru_io_cmd(struct nvmet_req *req); 617 static inline bool nvmet_is_passthru_subsys(struct nvmet_subsys *subsys) 618 { 619 return subsys->passthru_ctrl; 620 } 621 #else /* CONFIG_NVME_TARGET_PASSTHRU */ 622 static inline void nvmet_passthru_subsys_free(struct nvmet_subsys *subsys) 623 { 624 } 625 static inline void nvmet_passthru_ctrl_disable(struct nvmet_subsys *subsys) 626 { 627 } 628 static inline u16 nvmet_parse_passthru_admin_cmd(struct nvmet_req *req) 629 { 630 return 0; 631 } 632 static inline u16 nvmet_parse_passthru_io_cmd(struct nvmet_req *req) 633 { 634 return 0; 635 } 636 static inline bool nvmet_is_passthru_subsys(struct nvmet_subsys *subsys) 637 { 638 return NULL; 639 } 640 #endif /* CONFIG_NVME_TARGET_PASSTHRU */ 641 642 static inline bool nvmet_is_passthru_req(struct nvmet_req *req) 643 { 644 return nvmet_is_passthru_subsys(nvmet_req_subsys(req)); 645 } 646 647 void nvmet_passthrough_override_cap(struct nvmet_ctrl *ctrl); 648 649 u16 errno_to_nvme_status(struct nvmet_req *req, int errno); 650 u16 nvmet_report_invalid_opcode(struct nvmet_req *req); 651 652 /* Convert a 32-bit number to a 16-bit 0's based number */ 653 static inline __le16 to0based(u32 a) 654 { 655 return cpu_to_le16(max(1U, min(1U << 16, a)) - 1); 656 } 657 658 static inline bool nvmet_ns_has_pi(struct nvmet_ns *ns) 659 { 660 if (!IS_ENABLED(CONFIG_BLK_DEV_INTEGRITY)) 661 return false; 662 return ns->pi_type && ns->metadata_size == sizeof(struct t10_pi_tuple); 663 } 664 665 static inline __le64 nvmet_sect_to_lba(struct nvmet_ns *ns, sector_t sect) 666 { 667 return cpu_to_le64(sect >> (ns->blksize_shift - SECTOR_SHIFT)); 668 } 669 670 static inline sector_t nvmet_lba_to_sect(struct nvmet_ns *ns, __le64 lba) 671 { 672 return le64_to_cpu(lba) << (ns->blksize_shift - SECTOR_SHIFT); 673 } 674 675 static inline bool nvmet_use_inline_bvec(struct nvmet_req *req) 676 { 677 return req->transfer_len <= NVMET_MAX_INLINE_DATA_LEN && 678 req->sg_cnt <= NVMET_MAX_INLINE_BIOVEC; 679 } 680 681 static inline void nvmet_req_cns_error_complete(struct nvmet_req *req) 682 { 683 pr_debug("unhandled identify cns %d on qid %d\n", 684 req->cmd->identify.cns, req->sq->qid); 685 req->error_loc = offsetof(struct nvme_identify, cns); 686 nvmet_req_complete(req, NVME_SC_INVALID_FIELD | NVME_SC_DNR); 687 } 688 689 static inline void nvmet_req_bio_put(struct nvmet_req *req, struct bio *bio) 690 { 691 if (bio != &req->b.inline_bio) 692 bio_put(bio); 693 } 694 695 #ifdef CONFIG_NVME_TARGET_AUTH 696 void nvmet_execute_auth_send(struct nvmet_req *req); 697 void nvmet_execute_auth_receive(struct nvmet_req *req); 698 int nvmet_auth_set_key(struct nvmet_host *host, const char *secret, 699 bool set_ctrl); 700 int nvmet_auth_set_host_hash(struct nvmet_host *host, const char *hash); 701 int nvmet_setup_auth(struct nvmet_ctrl *ctrl); 702 void nvmet_init_auth(struct nvmet_ctrl *ctrl, struct nvmet_req *req); 703 void nvmet_destroy_auth(struct nvmet_ctrl *ctrl); 704 void nvmet_auth_sq_free(struct nvmet_sq *sq); 705 bool nvmet_check_auth_status(struct nvmet_req *req); 706 int nvmet_auth_host_hash(struct nvmet_req *req, u8 *response, 707 unsigned int hash_len); 708 int nvmet_auth_ctrl_hash(struct nvmet_req *req, u8 *response, 709 unsigned int hash_len); 710 static inline bool nvmet_has_auth(struct nvmet_ctrl *ctrl) 711 { 712 return ctrl->host_key != NULL; 713 } 714 #else 715 static inline int nvmet_setup_auth(struct nvmet_ctrl *ctrl) 716 { 717 return 0; 718 } 719 static inline void nvmet_init_auth(struct nvmet_ctrl *ctrl, 720 struct nvmet_req *req) {}; 721 static inline void nvmet_destroy_auth(struct nvmet_ctrl *ctrl) {}; 722 static inline void nvmet_auth_sq_free(struct nvmet_sq *sq) {}; 723 static inline bool nvmet_check_auth_status(struct nvmet_req *req) 724 { 725 return true; 726 } 727 static inline bool nvmet_has_auth(struct nvmet_ctrl *ctrl) 728 { 729 return false; 730 } 731 static inline const char *nvmet_dhchap_dhgroup_name(u8 dhgid) { return NULL; } 732 #endif 733 734 #endif /* _NVMET_H */ 735