[mirror_ubuntu-focal-kernel.git] / drivers / nvme / target / nvmet.h

/*
 * Copyright (c) 2015-2016 HGST, a Western Digital Company.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 */

#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>

#define NVMET_ASYNC_EVENTS		4
#define NVMET_ERROR_LOG_SLOTS		128

/* 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)	\
	(cpu_to_le32((1 << 16) | (offsetof(struct nvmf_connect_data, x))))
#define IPO_IATTR_CONNECT_SQE(x)	\
	(cpu_to_le32(offsetof(struct nvmf_connect_command, x)))

struct nvmet_ns {
	struct list_head	dev_link;
	struct percpu_ref	ref;
	struct block_device	*bdev;
	u32			nsid;
	u32			blksize_shift;
	loff_t			size;
	u8			nguid[16];
	uuid_t			uuid;

	bool			enabled;
	struct nvmet_subsys	*subsys;
	const char		*device_path;

	struct config_group	device_group;
	struct config_group	group;

	struct completion	disable_done;
};

static inline struct nvmet_ns *to_nvmet_ns(struct config_item *item)
{
	return container_of(to_config_group(item), struct nvmet_ns, group);
}

struct nvmet_cq {
	u16			qid;
	u16			size;
};

struct nvmet_sq {
	struct nvmet_ctrl	*ctrl;
	struct percpu_ref	ref;
	u16			qid;
	u16			size;
	struct completion	free_done;
	struct completion	confirm_done;
};

/**
 * struct nvmet_port -	Common structure to keep port
 *				information for the target.
 * @entry:		List head for holding a list of these elements.
 * @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 {
	struct list_head		entry;
	struct nvmf_disc_rsp_page_entry	disc_addr;
	struct config_group		group;
	struct config_group		subsys_group;
	struct list_head		subsystems;
	struct config_group		referrals_group;
	struct list_head		referrals;
	void				*priv;
	bool				enabled;
};

static inline struct nvmet_port *to_nvmet_port(struct config_item *item)
{
	return container_of(to_config_group(item), struct nvmet_port,
			group);
}

struct nvmet_ctrl {
	struct nvmet_subsys	*subsys;
	struct nvmet_cq		**cqs;
	struct nvmet_sq		**sqs;

	struct mutex		lock;
	u64			cap;
	u32			cc;
	u32			csts;

	uuid_t			hostid;
	u16			cntlid;
	u32			kato;

	struct nvmet_req	*async_event_cmds[NVMET_ASYNC_EVENTS];
	unsigned int		nr_async_event_cmds;
	struct list_head	async_events;
	struct work_struct	async_event_work;

	struct list_head	subsys_entry;
	struct kref		ref;
	struct delayed_work	ka_work;
	struct work_struct	fatal_err_work;

	struct nvmet_fabrics_ops *ops;

	char			subsysnqn[NVMF_NQN_FIELD_LEN];
	char			hostnqn[NVMF_NQN_FIELD_LEN];
};

struct nvmet_subsys {
	enum nvme_subsys_type	type;

	struct mutex		lock;
	struct kref		ref;

	struct list_head	namespaces;
	unsigned int		max_nsid;

	struct list_head	ctrls;

	struct list_head	hosts;
	bool			allow_any_host;

	u16			max_qid;

	u64			ver;
	u64			serial;
	char			*subsysnqn;

	struct config_group	group;

	struct config_group	namespaces_group;
	struct config_group	allowed_hosts_group;
};

static inline struct nvmet_subsys *to_subsys(struct config_item *item)
{
	return container_of(to_config_group(item), struct nvmet_subsys, group);
}

static inline struct nvmet_subsys *namespaces_to_subsys(
		struct config_item *item)
{
	return container_of(to_config_group(item), struct nvmet_subsys,
			namespaces_group);
}

struct nvmet_host {
	struct config_group	group;
};

static inline struct nvmet_host *to_host(struct config_item *item)
{
	return container_of(to_config_group(item), struct nvmet_host, group);
}

static inline char *nvmet_host_name(struct nvmet_host *host)
{
	return config_item_name(&host->group.cg_item);
}

struct nvmet_host_link {
	struct list_head	entry;
	struct nvmet_host	*host;
};

struct nvmet_subsys_link {
	struct list_head	entry;
	struct nvmet_subsys	*subsys;
};

struct nvmet_req;
struct nvmet_fabrics_ops {
	struct module *owner;
	unsigned int type;
	unsigned int sqe_inline_size;
	unsigned int msdbd;
	bool has_keyed_sgls : 1;
	void (*queue_response)(struct nvmet_req *req);
	int (*add_port)(struct nvmet_port *port);
	void (*remove_port)(struct nvmet_port *port);
	void (*delete_ctrl)(struct nvmet_ctrl *ctrl);
};

#define NVMET_MAX_INLINE_BIOVEC	8

struct nvmet_req {
	struct nvme_command	*cmd;
	struct nvme_completion	*rsp;
	struct nvmet_sq		*sq;
	struct nvmet_cq		*cq;
	struct nvmet_ns		*ns;
	struct scatterlist	*sg;
	struct bio		inline_bio;
	struct bio_vec		inline_bvec[NVMET_MAX_INLINE_BIOVEC];
	int			sg_cnt;
	size_t			data_len;

	struct nvmet_port	*port;

	void (*execute)(struct nvmet_req *req);
	struct nvmet_fabrics_ops *ops;
};

static inline void nvmet_set_status(struct nvmet_req *req, u16 status)
{
	req->rsp->status = cpu_to_le16(status << 1);
}

static inline void nvmet_set_result(struct nvmet_req *req, u32 result)
{
	req->rsp->result.u32 = cpu_to_le32(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)
{
	return nvme_is_write(req->cmd) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
}

struct nvmet_async_event {
	struct list_head	entry;
	u8			event_type;
	u8			event_info;
	u8			log_page;
};

u16 nvmet_parse_connect_cmd(struct nvmet_req *req);
u16 nvmet_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_cmd(struct nvmet_req *req);

bool nvmet_req_init(struct nvmet_req *req, struct nvmet_cq *cq,
		struct nvmet_sq *sq, struct nvmet_fabrics_ops *ops);
void nvmet_req_uninit(struct nvmet_req *req);
void nvmet_req_complete(struct nvmet_req *req, u16 status);

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);
u16 nvmet_ctrl_find_get(const char *subsysnqn, const char *hostnqn, u16 cntlid,
		struct nvmet_req *req, struct nvmet_ctrl **ret);
void nvmet_ctrl_put(struct nvmet_ctrl *ctrl);
u16 nvmet_check_ctrl_status(struct nvmet_req *req, struct nvme_command *cmd);

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);

struct nvmet_ns *nvmet_find_namespace(struct nvmet_ctrl *ctrl, __le32 nsid);
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);

int nvmet_register_transport(struct nvmet_fabrics_ops *ops);
void nvmet_unregister_transport(struct nvmet_fabrics_ops *ops);

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 *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);

u32 nvmet_get_log_page_len(struct nvme_command *cmd);

#define NVMET_QUEUE_SIZE	1024
#define NVMET_NR_QUEUES		64
#define NVMET_MAX_CMD		NVMET_QUEUE_SIZE
#define NVMET_KAS		10
#define NVMET_DISC_KATO		120

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 u64 nvmet_genctr;
extern struct rw_semaphore nvmet_config_sem;

bool nvmet_host_allowed(struct nvmet_req *req, struct nvmet_subsys *subsys,
		const char *hostnqn);

#endif /* _NVMET_H */
Commit	Line	Data
a07b4970 CH	1	/*
	2	* Copyright (c) 2015-2016 HGST, a Western Digital Company.
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms and conditions of the GNU General Public License,
	6	* version 2, as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	11	* more details.
	12	*/
	13
	14	#ifndef _NVMET_H
	15	#define _NVMET_H
	16
	17	#include <linux/dma-mapping.h>
	18	#include <linux/types.h>
	19	#include <linux/device.h>
	20	#include <linux/kref.h>
	21	#include <linux/percpu-refcount.h>
	22	#include <linux/list.h>
	23	#include <linux/mutex.h>
8e412263	24	#include <linux/uuid.h>
a07b4970 CH	25	#include <linux/nvme.h>
	26	#include <linux/configfs.h>
	27	#include <linux/rcupdate.h>
	28	#include <linux/blkdev.h>
	29
	30	#define NVMET_ASYNC_EVENTS 4
	31	#define NVMET_ERROR_LOG_SLOTS 128
	32
	33	/* Helper Macros when NVMe error is NVME_SC_CONNECT_INVALID_PARAM
	34	* The 16 bit shift is to set IATTR bit to 1, which means offending
	35	* offset starts in the data section of connect()
	36	*/
	37	#define IPO_IATTR_CONNECT_DATA(x) \
	38	(cpu_to_le32((1 << 16) \| (offsetof(struct nvmf_connect_data, x))))
	39	#define IPO_IATTR_CONNECT_SQE(x) \
	40	(cpu_to_le32(offsetof(struct nvmf_connect_command, x)))
	41
	42	struct nvmet_ns {
	43	struct list_head dev_link;
	44	struct percpu_ref ref;
	45	struct block_device *bdev;
	46	u32 nsid;
	47	u32 blksize_shift;
	48	loff_t size;
	49	u8 nguid[16];
637dc0f3	50	uuid_t uuid;
a07b4970	51
e4fcf07c	52	bool enabled;
a07b4970 CH	53	struct nvmet_subsys *subsys;
	54	const char *device_path;
	55
	56	struct config_group device_group;
	57	struct config_group group;
	58
	59	struct completion disable_done;
	60	};
	61
	62	static inline struct nvmet_ns to_nvmet_ns(struct config_item item)
	63	{
	64	return container_of(to_config_group(item), struct nvmet_ns, group);
	65	}
	66
a07b4970 CH	67	struct nvmet_cq {
	68	u16 qid;
	69	u16 size;
	70	};
	71
	72	struct nvmet_sq {
	73	struct nvmet_ctrl *ctrl;
	74	struct percpu_ref ref;
	75	u16 qid;
	76	u16 size;
	77	struct completion free_done;
427242ce	78	struct completion confirm_done;
a07b4970 CH	79	};
	80
	81	/**
	82	* struct nvmet_port - Common structure to keep port
	83	* information for the target.
	84	* @entry: List head for holding a list of these elements.
	85	* @disc_addr: Address information is stored in a format defined
	86	* for a discovery log page entry.
	87	* @group: ConfigFS group for this element's folder.
	88	* @priv: Private data for the transport.
	89	*/
	90	struct nvmet_port {
	91	struct list_head entry;
	92	struct nvmf_disc_rsp_page_entry disc_addr;
	93	struct config_group group;
	94	struct config_group subsys_group;
	95	struct list_head subsystems;
	96	struct config_group referrals_group;
	97	struct list_head referrals;
	98	void *priv;
	99	bool enabled;
	100	};
	101
	102	static inline struct nvmet_port to_nvmet_port(struct config_item item)
	103	{
	104	return container_of(to_config_group(item), struct nvmet_port,
	105	group);
	106	}
	107
	108	struct nvmet_ctrl {
	109	struct nvmet_subsys *subsys;
	110	struct nvmet_cq **cqs;
	111	struct nvmet_sq **sqs;
	112
	113	struct mutex lock;
	114	u64 cap;
	115	u32 cc;
	116	u32 csts;
	117
28dd5cf7	118	uuid_t hostid;
a07b4970 CH	119	u16 cntlid;
	120	u32 kato;
	121
	122	struct nvmet_req *async_event_cmds[NVMET_ASYNC_EVENTS];
	123	unsigned int nr_async_event_cmds;
	124	struct list_head async_events;
	125	struct work_struct async_event_work;
	126
	127	struct list_head subsys_entry;
	128	struct kref ref;
	129	struct delayed_work ka_work;
	130	struct work_struct fatal_err_work;
	131
	132	struct nvmet_fabrics_ops *ops;
	133
	134	char subsysnqn[NVMF_NQN_FIELD_LEN];
	135	char hostnqn[NVMF_NQN_FIELD_LEN];
	136	};
	137
	138	struct nvmet_subsys {
	139	enum nvme_subsys_type type;
	140
	141	struct mutex lock;
	142	struct kref ref;
	143
	144	struct list_head namespaces;
	145	unsigned int max_nsid;
	146
	147	struct list_head ctrls;
a07b4970 CH	148
	149	struct list_head hosts;
	150	bool allow_any_host;
	151
	152	u16 max_qid;
	153
	154	u64 ver;
2e7f5d2a	155	u64 serial;
a07b4970 CH	156	char *subsysnqn;
	157
	158	struct config_group group;
	159
	160	struct config_group namespaces_group;
	161	struct config_group allowed_hosts_group;
	162	};
	163
	164	static inline struct nvmet_subsys to_subsys(struct config_item item)
	165	{
	166	return container_of(to_config_group(item), struct nvmet_subsys, group);
	167	}
	168
	169	static inline struct nvmet_subsys *namespaces_to_subsys(
	170	struct config_item *item)
	171	{
	172	return container_of(to_config_group(item), struct nvmet_subsys,
	173	namespaces_group);
	174	}
	175
	176	struct nvmet_host {
	177	struct config_group group;
	178	};
	179
	180	static inline struct nvmet_host to_host(struct config_item item)
	181	{
	182	return container_of(to_config_group(item), struct nvmet_host, group);
	183	}
	184
	185	static inline char nvmet_host_name(struct nvmet_host host)
	186	{
	187	return config_item_name(&host->group.cg_item);
	188	}
	189
	190	struct nvmet_host_link {
	191	struct list_head entry;
	192	struct nvmet_host *host;
	193	};
	194
	195	struct nvmet_subsys_link {
	196	struct list_head entry;
	197	struct nvmet_subsys *subsys;
	198	};
	199
	200	struct nvmet_req;
	201	struct nvmet_fabrics_ops {
	202	struct module *owner;
	203	unsigned int type;
	204	unsigned int sqe_inline_size;
	205	unsigned int msdbd;
	206	bool has_keyed_sgls : 1;
	207	void (queue_response)(struct nvmet_req req);
	208	int (add_port)(struct nvmet_port port);
	209	void (remove_port)(struct nvmet_port port);
	210	void (delete_ctrl)(struct nvmet_ctrl ctrl);
	211	};
	212
	213	#define NVMET_MAX_INLINE_BIOVEC 8
	214
	215	struct nvmet_req {
	216	struct nvme_command *cmd;
	217	struct nvme_completion *rsp;
	218	struct nvmet_sq *sq;
	219	struct nvmet_cq *cq;
220	struct nvmet_ns *ns;
221	struct scatterlist *sg;
222	struct bio inline_bio;
223	struct bio_vec inline_bvec[NVMET_MAX_INLINE_BIOVEC];
224	int sg_cnt;
225	size_t data_len;
226
227	struct nvmet_port *port;
228
229	void (execute)(struct nvmet_req req);
230	struct nvmet_fabrics_ops *ops;
231	};
232
233	static inline void nvmet_set_status(struct nvmet_req *req, u16 status)
234	{
235	req->rsp->status = cpu_to_le16(status << 1);
236	}
237
238	static inline void nvmet_set_result(struct nvmet_req *req, u32 result)
239	{
d49187e9	240	req->rsp->result.u32 = cpu_to_le32(result);
a07b4970 CH	241	}
	242
	243	/*
	244	* NVMe command writes actually are DMA reads for us on the target side.
	245	*/
	246	static inline enum dma_data_direction
	247	nvmet_data_dir(struct nvmet_req *req)
	248	{
	249	return nvme_is_write(req->cmd) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
	250	}
	251
	252	struct nvmet_async_event {
	253	struct list_head entry;
	254	u8 event_type;
	255	u8 event_info;
	256	u8 log_page;
	257	};
	258
64a0ca88 PP	259	u16 nvmet_parse_connect_cmd(struct nvmet_req *req);
	260	u16 nvmet_parse_io_cmd(struct nvmet_req *req);
	261	u16 nvmet_parse_admin_cmd(struct nvmet_req *req);
	262	u16 nvmet_parse_discovery_cmd(struct nvmet_req *req);
	263	u16 nvmet_parse_fabrics_cmd(struct nvmet_req *req);
a07b4970 CH	264
	265	bool nvmet_req_init(struct nvmet_req req, struct nvmet_cq cq,
	266	struct nvmet_sq sq, struct nvmet_fabrics_ops ops);
549f01ae	267	void nvmet_req_uninit(struct nvmet_req *req);
a07b4970 CH	268	void nvmet_req_complete(struct nvmet_req *req, u16 status);
	269
	270	void nvmet_cq_setup(struct nvmet_ctrl ctrl, struct nvmet_cq cq, u16 qid,
	271	u16 size);
	272	void nvmet_sq_setup(struct nvmet_ctrl ctrl, struct nvmet_sq sq, u16 qid,
	273	u16 size);
	274	void nvmet_sq_destroy(struct nvmet_sq *sq);
	275	int nvmet_sq_init(struct nvmet_sq *sq);
	276
	277	void nvmet_ctrl_fatal_error(struct nvmet_ctrl *ctrl);
	278
	279	void nvmet_update_cc(struct nvmet_ctrl *ctrl, u32 new);
	280	u16 nvmet_alloc_ctrl(const char subsysnqn, const char hostnqn,
	281	struct nvmet_req req, u32 kato, struct nvmet_ctrl *ctrlp);
	282	u16 nvmet_ctrl_find_get(const char subsysnqn, const char hostnqn, u16 cntlid,
	283	struct nvmet_req req, struct nvmet_ctrl *ret);
	284	void nvmet_ctrl_put(struct nvmet_ctrl *ctrl);
64a0ca88	285	u16 nvmet_check_ctrl_status(struct nvmet_req req, struct nvme_command cmd);
a07b4970 CH	286
	287	struct nvmet_subsys nvmet_subsys_alloc(const char subsysnqn,
	288	enum nvme_subsys_type type);
	289	void nvmet_subsys_put(struct nvmet_subsys *subsys);
344770b0	290	void nvmet_subsys_del_ctrls(struct nvmet_subsys *subsys);
a07b4970 CH	291
	292	struct nvmet_ns nvmet_find_namespace(struct nvmet_ctrl ctrl, __le32 nsid);
	293	void nvmet_put_namespace(struct nvmet_ns *ns);
	294	int nvmet_ns_enable(struct nvmet_ns *ns);
	295	void nvmet_ns_disable(struct nvmet_ns *ns);
	296	struct nvmet_ns nvmet_ns_alloc(struct nvmet_subsys subsys, u32 nsid);
	297	void nvmet_ns_free(struct nvmet_ns *ns);
	298
	299	int nvmet_register_transport(struct nvmet_fabrics_ops *ops);
	300	void nvmet_unregister_transport(struct nvmet_fabrics_ops *ops);
	301
	302	int nvmet_enable_port(struct nvmet_port *port);
	303	void nvmet_disable_port(struct nvmet_port *port);
	304
	305	void nvmet_referral_enable(struct nvmet_port parent, struct nvmet_port port);
	306	void nvmet_referral_disable(struct nvmet_port *port);
	307
	308	u16 nvmet_copy_to_sgl(struct nvmet_req req, off_t off, const void buf,
	309	size_t len);
	310	u16 nvmet_copy_from_sgl(struct nvmet_req req, off_t off, void buf,
	311	size_t len);
	312
	313	u32 nvmet_get_log_page_len(struct nvme_command *cmd);
	314
	315	#define NVMET_QUEUE_SIZE 1024
	316	#define NVMET_NR_QUEUES 64
	317	#define NVMET_MAX_CMD NVMET_QUEUE_SIZE
	318	#define NVMET_KAS 10
	319	#define NVMET_DISC_KATO 120
	320
	321	int __init nvmet_init_configfs(void);
	322	void __exit nvmet_exit_configfs(void);
	323
	324	int __init nvmet_init_discovery(void);
	325	void nvmet_exit_discovery(void);
	326
	327	extern struct nvmet_subsys *nvmet_disc_subsys;
	328	extern u64 nvmet_genctr;
	329	extern struct rw_semaphore nvmet_config_sem;
	330
	331	bool nvmet_host_allowed(struct nvmet_req req, struct nvmet_subsys subsys,
	332	const char *hostnqn);
	333
	334	#endif /* _NVMET_H */