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