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