/* SPDX-License-Identifier: GPL-2.0 */ /* * Copyright (c) 2015-2016 HGST, a Western Digital Company. */ #ifndef _NVMET_H #define _NVMET_H #include <linux/dma-mapping.h> #include <linux/types.h> #include <linux/device.h> #include <linux/kref.h> #include <linux/percpu-refcount.h> #include <linux/list.h> #include <linux/mutex.h> #include <linux/uuid.h> #include <linux/nvme.h> #include <linux/configfs.h> #include <linux/rcupdate.h> #include <linux/blkdev.h> #include <linux/radix-tree.h> #include <linux/t10-pi.h> #define NVMET_DEFAULT_VS … #define NVMET_ASYNC_EVENTS … #define NVMET_ERROR_LOG_SLOTS … #define NVMET_NO_ERROR_LOC … #define NVMET_DEFAULT_CTRL_MODEL … #define NVMET_MN_MAX_SIZE … #define NVMET_SN_MAX_SIZE … #define NVMET_FR_MAX_SIZE … /* * Supported optional AENs: */ #define NVMET_AEN_CFG_OPTIONAL … #define NVMET_DISC_AEN_CFG_OPTIONAL … /* * Plus mandatory SMART AENs (we'll never send them, but allow enabling them): */ #define NVMET_AEN_CFG_ALL … /* Helper Macros when NVMe error is NVME_SC_CONNECT_INVALID_PARAM * The 16 bit shift is to set IATTR bit to 1, which means offending * offset starts in the data section of connect() */ #define IPO_IATTR_CONNECT_DATA(x) … #define IPO_IATTR_CONNECT_SQE(x) … struct nvmet_ns { … }; static inline struct nvmet_ns *to_nvmet_ns(struct config_item *item) { … } static inline struct device *nvmet_ns_dev(struct nvmet_ns *ns) { … } struct nvmet_cq { … }; struct nvmet_sq { … }; struct nvmet_ana_group { … }; static inline struct nvmet_ana_group *to_ana_group(struct config_item *item) { … } /** * struct nvmet_port - Common structure to keep port * information for the target. * @entry: Entry into referrals or transport list. * @disc_addr: Address information is stored in a format defined * for a discovery log page entry. * @group: ConfigFS group for this element's folder. * @priv: Private data for the transport. */ struct nvmet_port { … }; static inline struct nvmet_port *to_nvmet_port(struct config_item *item) { … } static inline struct nvmet_port *ana_groups_to_port( struct config_item *item) { … } static inline u8 nvmet_port_disc_addr_treq_secure_channel(struct nvmet_port *port) { … } static inline bool nvmet_port_secure_channel_required(struct nvmet_port *port) { … } struct nvmet_ctrl { … }; struct nvmet_subsys { … }; static inline struct nvmet_subsys *to_subsys(struct config_item *item) { … } static inline struct nvmet_subsys *namespaces_to_subsys( struct config_item *item) { … } struct nvmet_host { … }; static inline struct nvmet_host *to_host(struct config_item *item) { … } static inline char *nvmet_host_name(struct nvmet_host *host) { … } struct nvmet_host_link { … }; struct nvmet_subsys_link { … }; struct nvmet_req; struct nvmet_fabrics_ops { … }; #define NVMET_MAX_INLINE_BIOVEC … #define NVMET_MAX_INLINE_DATA_LEN … struct nvmet_req { … }; #define NVMET_MAX_MPOOL_BVEC … extern struct kmem_cache *nvmet_bvec_cache; extern struct workqueue_struct *buffered_io_wq; extern struct workqueue_struct *zbd_wq; extern struct workqueue_struct *nvmet_wq; static inline void nvmet_set_result(struct nvmet_req *req, u32 result) { … } /* * NVMe command writes actually are DMA reads for us on the target side. */ static inline enum dma_data_direction nvmet_data_dir(struct nvmet_req *req) { … } struct nvmet_async_event { … }; static inline void nvmet_clear_aen_bit(struct nvmet_req *req, u32 bn) { … } static inline bool nvmet_aen_bit_disabled(struct nvmet_ctrl *ctrl, u32 bn) { … } void nvmet_get_feat_kato(struct nvmet_req *req); void nvmet_get_feat_async_event(struct nvmet_req *req); u16 nvmet_set_feat_kato(struct nvmet_req *req); u16 nvmet_set_feat_async_event(struct nvmet_req *req, u32 mask); void nvmet_execute_async_event(struct nvmet_req *req); void nvmet_start_keep_alive_timer(struct nvmet_ctrl *ctrl); void nvmet_stop_keep_alive_timer(struct nvmet_ctrl *ctrl); u16 nvmet_parse_connect_cmd(struct nvmet_req *req); void nvmet_bdev_set_limits(struct block_device *bdev, struct nvme_id_ns *id); u16 nvmet_bdev_parse_io_cmd(struct nvmet_req *req); u16 nvmet_file_parse_io_cmd(struct nvmet_req *req); u16 nvmet_bdev_zns_parse_io_cmd(struct nvmet_req *req); u16 nvmet_parse_admin_cmd(struct nvmet_req *req); u16 nvmet_parse_discovery_cmd(struct nvmet_req *req); u16 nvmet_parse_fabrics_admin_cmd(struct nvmet_req *req); u16 nvmet_parse_fabrics_io_cmd(struct nvmet_req *req); bool nvmet_req_init(struct nvmet_req *req, struct nvmet_cq *cq, struct nvmet_sq *sq, const struct nvmet_fabrics_ops *ops); void nvmet_req_uninit(struct nvmet_req *req); bool nvmet_check_transfer_len(struct nvmet_req *req, size_t len); bool nvmet_check_data_len_lte(struct nvmet_req *req, size_t data_len); void nvmet_req_complete(struct nvmet_req *req, u16 status); int nvmet_req_alloc_sgls(struct nvmet_req *req); void nvmet_req_free_sgls(struct nvmet_req *req); void nvmet_execute_set_features(struct nvmet_req *req); void nvmet_execute_get_features(struct nvmet_req *req); void nvmet_execute_keep_alive(struct nvmet_req *req); void nvmet_cq_setup(struct nvmet_ctrl *ctrl, struct nvmet_cq *cq, u16 qid, u16 size); void nvmet_sq_setup(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq, u16 qid, u16 size); void nvmet_sq_destroy(struct nvmet_sq *sq); int nvmet_sq_init(struct nvmet_sq *sq); void nvmet_ctrl_fatal_error(struct nvmet_ctrl *ctrl); void nvmet_update_cc(struct nvmet_ctrl *ctrl, u32 new); u16 nvmet_alloc_ctrl(const char *subsysnqn, const char *hostnqn, struct nvmet_req *req, u32 kato, struct nvmet_ctrl **ctrlp); struct nvmet_ctrl *nvmet_ctrl_find_get(const char *subsysnqn, const char *hostnqn, u16 cntlid, struct nvmet_req *req); void nvmet_ctrl_put(struct nvmet_ctrl *ctrl); u16 nvmet_check_ctrl_status(struct nvmet_req *req); ssize_t nvmet_ctrl_host_traddr(struct nvmet_ctrl *ctrl, char *traddr, size_t traddr_len); struct nvmet_subsys *nvmet_subsys_alloc(const char *subsysnqn, enum nvme_subsys_type type); void nvmet_subsys_put(struct nvmet_subsys *subsys); void nvmet_subsys_del_ctrls(struct nvmet_subsys *subsys); u16 nvmet_req_find_ns(struct nvmet_req *req); void nvmet_put_namespace(struct nvmet_ns *ns); int nvmet_ns_enable(struct nvmet_ns *ns); void nvmet_ns_disable(struct nvmet_ns *ns); struct nvmet_ns *nvmet_ns_alloc(struct nvmet_subsys *subsys, u32 nsid); void nvmet_ns_free(struct nvmet_ns *ns); void nvmet_send_ana_event(struct nvmet_subsys *subsys, struct nvmet_port *port); void nvmet_port_send_ana_event(struct nvmet_port *port); int nvmet_register_transport(const struct nvmet_fabrics_ops *ops); void nvmet_unregister_transport(const struct nvmet_fabrics_ops *ops); void nvmet_port_del_ctrls(struct nvmet_port *port, struct nvmet_subsys *subsys); int nvmet_enable_port(struct nvmet_port *port); void nvmet_disable_port(struct nvmet_port *port); void nvmet_referral_enable(struct nvmet_port *parent, struct nvmet_port *port); void nvmet_referral_disable(struct nvmet_port *parent, struct nvmet_port *port); u16 nvmet_copy_to_sgl(struct nvmet_req *req, off_t off, const void *buf, size_t len); u16 nvmet_copy_from_sgl(struct nvmet_req *req, off_t off, void *buf, size_t len); u16 nvmet_zero_sgl(struct nvmet_req *req, off_t off, size_t len); u32 nvmet_get_log_page_len(struct nvme_command *cmd); u64 nvmet_get_log_page_offset(struct nvme_command *cmd); extern struct list_head *nvmet_ports; void nvmet_port_disc_changed(struct nvmet_port *port, struct nvmet_subsys *subsys); void nvmet_subsys_disc_changed(struct nvmet_subsys *subsys, struct nvmet_host *host); void nvmet_add_async_event(struct nvmet_ctrl *ctrl, u8 event_type, u8 event_info, u8 log_page); bool nvmet_subsys_nsid_exists(struct nvmet_subsys *subsys, u32 nsid); #define NVMET_MIN_QUEUE_SIZE … #define NVMET_MAX_QUEUE_SIZE … #define NVMET_NR_QUEUES … #define NVMET_MAX_CMD(ctrl) … /* * Nice round number that makes a list of nsids fit into a page. * Should become tunable at some point in the future. */ #define NVMET_MAX_NAMESPACES … /* * 0 is not a valid ANA group ID, so we start numbering at 1. * * ANA Group 1 exists without manual intervention, has namespaces assigned to it * by default, and is available in an optimized state through all ports. */ #define NVMET_MAX_ANAGRPS … #define NVMET_DEFAULT_ANA_GRPID … #define NVMET_KAS … #define NVMET_DISC_KATO_MS … int __init nvmet_init_configfs(void); void __exit nvmet_exit_configfs(void); int __init nvmet_init_discovery(void); void nvmet_exit_discovery(void); extern struct nvmet_subsys *nvmet_disc_subsys; extern struct rw_semaphore nvmet_config_sem; extern u32 nvmet_ana_group_enabled[NVMET_MAX_ANAGRPS + 1]; extern u64 nvmet_ana_chgcnt; extern struct rw_semaphore nvmet_ana_sem; bool nvmet_host_allowed(struct nvmet_subsys *subsys, const char *hostnqn); int nvmet_bdev_ns_enable(struct nvmet_ns *ns); int nvmet_file_ns_enable(struct nvmet_ns *ns); void nvmet_bdev_ns_disable(struct nvmet_ns *ns); void nvmet_file_ns_disable(struct nvmet_ns *ns); u16 nvmet_bdev_flush(struct nvmet_req *req); u16 nvmet_file_flush(struct nvmet_req *req); void nvmet_ns_changed(struct nvmet_subsys *subsys, u32 nsid); void nvmet_bdev_ns_revalidate(struct nvmet_ns *ns); void nvmet_file_ns_revalidate(struct nvmet_ns *ns); bool nvmet_ns_revalidate(struct nvmet_ns *ns); u16 blk_to_nvme_status(struct nvmet_req *req, blk_status_t blk_sts); bool nvmet_bdev_zns_enable(struct nvmet_ns *ns); void nvmet_execute_identify_ctrl_zns(struct nvmet_req *req); void nvmet_execute_identify_ns_zns(struct nvmet_req *req); void nvmet_bdev_execute_zone_mgmt_recv(struct nvmet_req *req); void nvmet_bdev_execute_zone_mgmt_send(struct nvmet_req *req); void nvmet_bdev_execute_zone_append(struct nvmet_req *req); static inline u32 nvmet_rw_data_len(struct nvmet_req *req) { … } static inline u32 nvmet_rw_metadata_len(struct nvmet_req *req) { … } static inline u32 nvmet_dsm_len(struct nvmet_req *req) { … } static inline struct nvmet_subsys *nvmet_req_subsys(struct nvmet_req *req) { … } static inline bool nvmet_is_disc_subsys(struct nvmet_subsys *subsys) { … } #ifdef CONFIG_NVME_TARGET_PASSTHRU void nvmet_passthru_subsys_free(struct nvmet_subsys *subsys); int nvmet_passthru_ctrl_enable(struct nvmet_subsys *subsys); void nvmet_passthru_ctrl_disable(struct nvmet_subsys *subsys); u16 nvmet_parse_passthru_admin_cmd(struct nvmet_req *req); u16 nvmet_parse_passthru_io_cmd(struct nvmet_req *req); static inline bool nvmet_is_passthru_subsys(struct nvmet_subsys *subsys) { … } #else /* CONFIG_NVME_TARGET_PASSTHRU */ static inline void nvmet_passthru_subsys_free(struct nvmet_subsys *subsys) { } static inline void nvmet_passthru_ctrl_disable(struct nvmet_subsys *subsys) { } static inline u16 nvmet_parse_passthru_admin_cmd(struct nvmet_req *req) { return 0; } static inline u16 nvmet_parse_passthru_io_cmd(struct nvmet_req *req) { return 0; } static inline bool nvmet_is_passthru_subsys(struct nvmet_subsys *subsys) { return NULL; } #endif /* CONFIG_NVME_TARGET_PASSTHRU */ static inline bool nvmet_is_passthru_req(struct nvmet_req *req) { … } void nvmet_passthrough_override_cap(struct nvmet_ctrl *ctrl); u16 errno_to_nvme_status(struct nvmet_req *req, int errno); u16 nvmet_report_invalid_opcode(struct nvmet_req *req); /* Convert a 32-bit number to a 16-bit 0's based number */ static inline __le16 to0based(u32 a) { … } static inline bool nvmet_ns_has_pi(struct nvmet_ns *ns) { … } static inline __le64 nvmet_sect_to_lba(struct nvmet_ns *ns, sector_t sect) { … } static inline sector_t nvmet_lba_to_sect(struct nvmet_ns *ns, __le64 lba) { … } static inline bool nvmet_use_inline_bvec(struct nvmet_req *req) { … } static inline void nvmet_req_bio_put(struct nvmet_req *req, struct bio *bio) { … } #ifdef CONFIG_NVME_TARGET_AUTH void nvmet_execute_auth_send(struct nvmet_req *req); void nvmet_execute_auth_receive(struct nvmet_req *req); int nvmet_auth_set_key(struct nvmet_host *host, const char *secret, bool set_ctrl); int nvmet_auth_set_host_hash(struct nvmet_host *host, const char *hash); u8 nvmet_setup_auth(struct nvmet_ctrl *ctrl); void nvmet_auth_sq_init(struct nvmet_sq *sq); void nvmet_destroy_auth(struct nvmet_ctrl *ctrl); void nvmet_auth_sq_free(struct nvmet_sq *sq); int nvmet_setup_dhgroup(struct nvmet_ctrl *ctrl, u8 dhgroup_id); bool nvmet_check_auth_status(struct nvmet_req *req); int nvmet_auth_host_hash(struct nvmet_req *req, u8 *response, unsigned int hash_len); int nvmet_auth_ctrl_hash(struct nvmet_req *req, u8 *response, unsigned int hash_len); static inline bool nvmet_has_auth(struct nvmet_ctrl *ctrl) { … } int nvmet_auth_ctrl_exponential(struct nvmet_req *req, u8 *buf, int buf_size); int nvmet_auth_ctrl_sesskey(struct nvmet_req *req, u8 *buf, int buf_size); #else static inline u8 nvmet_setup_auth(struct nvmet_ctrl *ctrl) { return 0; } static inline void nvmet_auth_sq_init(struct nvmet_sq *sq) { } static inline void nvmet_destroy_auth(struct nvmet_ctrl *ctrl) {}; static inline void nvmet_auth_sq_free(struct nvmet_sq *sq) {}; static inline bool nvmet_check_auth_status(struct nvmet_req *req) { return true; } static inline bool nvmet_has_auth(struct nvmet_ctrl *ctrl) { return false; } static inline const char *nvmet_dhchap_dhgroup_name(u8 dhgid) { return NULL; } #endif #endif /* _NVMET_H */
Codebase Browser
linux