[mirror_ubuntu-bionic-kernel.git] / include / scsi / scsi_transport_iscsi.h

/*
 * iSCSI transport class definitions
 *
 * Copyright (C) IBM Corporation, 2004
 * Copyright (C) Mike Christie, 2004 - 2006
 * Copyright (C) Dmitry Yusupov, 2004 - 2005
 * Copyright (C) Alex Aizman, 2004 - 2005
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */
#ifndef SCSI_TRANSPORT_ISCSI_H
#define SCSI_TRANSPORT_ISCSI_H

#include <linux/device.h>
#include <linux/list.h>
#include <linux/mutex.h>
#include <scsi/iscsi_if.h>

struct scsi_transport_template;
struct iscsi_transport;
struct Scsi_Host;
struct iscsi_cls_conn;
struct iscsi_conn;
struct iscsi_cmd_task;
struct iscsi_mgmt_task;
struct sockaddr;

/**
 * struct iscsi_transport - iSCSI Transport template
 *
 * @name:		transport name
 * @caps:		iSCSI Data-Path capabilities
 * @create_session:	create new iSCSI session object
 * @destroy_session:	destroy existing iSCSI session object
 * @create_conn:	create new iSCSI connection
 * @bind_conn:		associate this connection with existing iSCSI session
 *			and specified transport descriptor
 * @destroy_conn:	destroy inactive iSCSI connection
 * @set_param:		set iSCSI parameter. Return 0 on success, -ENODATA
 *			when param is not supported, and a -Exx value on other
 *			error.
 * @get_param		get iSCSI parameter. Must return number of bytes
 *			copied to buffer on success, -ENODATA when param
 *			is not supported, and a -Exx value on other error
 * @start_conn:		set connection to be operational
 * @stop_conn:		suspend/recover/terminate connection
 * @send_pdu:		send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
 * @session_recovery_timedout: notify LLD a block during recovery timed out
 * @init_cmd_task:	Initialize a iscsi_cmd_task and any internal structs.
 *			Called from queuecommand with session lock held.
 * @init_mgmt_task:	Initialize a iscsi_mgmt_task and any internal structs.
 *			Called from iscsi_conn_send_generic with xmitmutex.
 * @xmit_cmd_task:	Requests LLD to transfer cmd task. Returns 0 or the
 *			the number of bytes transferred on success, and -Exyz
 *			value on error.
 * @xmit_mgmt_task:	Requests LLD to transfer mgmt task. Returns 0 or the
 *			the number of bytes transferred on success, and -Exyz
 *			value on error.
 * @cleanup_cmd_task:	requests LLD to fail cmd task. Called with xmitmutex
 *			and session->lock after the connection has been
 *			suspended and terminated during recovery. If called
 *			from abort task then connection is not suspended
 *			or terminated but sk_callback_lock is held
 *
 * Template API provided by iSCSI Transport
 */
struct iscsi_transport {
	struct module *owner;
	char *name;
	unsigned int caps;
	/* LLD sets this to indicate what values it can export to sysfs */
	uint64_t param_mask;
	uint64_t host_param_mask;
	struct iscsi_cls_session *(*create_session) (struct Scsi_Host *shost,
					uint16_t cmds_max, uint16_t qdepth,
					uint32_t sn, uint32_t *hn);
	void (*destroy_session) (struct iscsi_cls_session *session);
	struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
				uint32_t cid);
	int (*bind_conn) (struct iscsi_cls_session *session,
			  struct iscsi_cls_conn *cls_conn,
			  uint64_t transport_eph, int is_leading);
	int (*start_conn) (struct iscsi_cls_conn *conn);
	void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
	void (*destroy_conn) (struct iscsi_cls_conn *conn);
	int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
			  char *buf, int buflen);
	int (*get_conn_param) (struct iscsi_cls_conn *conn,
			       enum iscsi_param param, char *buf);
	int (*get_session_param) (struct iscsi_cls_session *session,
				  enum iscsi_param param, char *buf);
	int (*get_host_param) (struct Scsi_Host *shost,
				enum iscsi_host_param param, char *buf);
	int (*set_host_param) (struct Scsi_Host *shost,
			       enum iscsi_host_param param, char *buf,
			       int buflen);
	int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
			 char *data, uint32_t data_size);
	void (*get_stats) (struct iscsi_cls_conn *conn,
			   struct iscsi_stats *stats);
	int (*init_cmd_task) (struct iscsi_cmd_task *ctask);
	void (*init_mgmt_task) (struct iscsi_conn *conn,
				struct iscsi_mgmt_task *mtask);
	int (*xmit_cmd_task) (struct iscsi_conn *conn,
			      struct iscsi_cmd_task *ctask);
	void (*cleanup_cmd_task) (struct iscsi_conn *conn,
				  struct iscsi_cmd_task *ctask);
	int (*xmit_mgmt_task) (struct iscsi_conn *conn,
			       struct iscsi_mgmt_task *mtask);
	void (*session_recovery_timedout) (struct iscsi_cls_session *session);
	int (*ep_connect) (struct sockaddr *dst_addr, int non_blocking,
			   uint64_t *ep_handle);
	int (*ep_poll) (uint64_t ep_handle, int timeout_ms);
	void (*ep_disconnect) (uint64_t ep_handle);
	int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
			  uint32_t enable, struct sockaddr *dst_addr);
};

/*
 * transport registration upcalls
 */
extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
extern int iscsi_unregister_transport(struct iscsi_transport *tt);

/*
 * control plane upcalls
 */
extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error);
extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
			  char *data, uint32_t data_size);

struct iscsi_cls_conn {
	struct list_head conn_list;	/* item in connlist */
	void *dd_data;			/* LLD private data */
	struct iscsi_transport *transport;
	uint32_t cid;			/* connection id */

	int active;			/* must be accessed with the connlock */
	struct device dev;		/* sysfs transport/container device */
};

#define iscsi_dev_to_conn(_dev) \
	container_of(_dev, struct iscsi_cls_conn, dev)

#define iscsi_conn_to_session(_conn) \
	iscsi_dev_to_session(_conn->dev.parent)

/* iscsi class session state */
enum {
	ISCSI_SESSION_LOGGED_IN,
	ISCSI_SESSION_FAILED,
	ISCSI_SESSION_FREE,
};

struct iscsi_cls_session {
	struct list_head sess_list;		/* item in session_list */
	struct list_head host_list;
	struct iscsi_transport *transport;
	spinlock_t lock;
	struct work_struct block_work;
	struct work_struct unblock_work;
	struct work_struct scan_work;
	struct work_struct unbind_work;

	/* recovery fields */
	int recovery_tmo;
	struct delayed_work recovery_work;

	int target_id;

	int state;
	int sid;				/* session id */
	void *dd_data;				/* LLD private data */
	struct device dev;	/* sysfs transport/container device */
};

#define iscsi_dev_to_session(_dev) \
	container_of(_dev, struct iscsi_cls_session, dev)

#define iscsi_session_to_shost(_session) \
	dev_to_shost(_session->dev.parent)

#define starget_to_session(_stgt) \
	iscsi_dev_to_session(_stgt->dev.parent)

struct iscsi_cls_host {
	struct list_head sessions;
	atomic_t nr_scans;
	struct mutex mutex;
	struct workqueue_struct *scan_workq;
	char scan_workq_name[KOBJ_NAME_LEN];
};

extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
				void (*fn)(struct iscsi_cls_session *));


/*
 * session and connection functions that can be used by HW iSCSI LLDs
 */
#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
	dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)

#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
	dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)

extern int iscsi_session_chkready(struct iscsi_cls_session *session);
extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
				struct iscsi_transport *transport, int dd_size);
extern int iscsi_add_session(struct iscsi_cls_session *session,
			     unsigned int target_id);
extern int iscsi_session_event(struct iscsi_cls_session *session,
			       enum iscsi_uevent_e event);
extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
						struct iscsi_transport *t,
						int dd_size,
						unsigned int target_id);
extern void iscsi_remove_session(struct iscsi_cls_session *session);
extern void iscsi_free_session(struct iscsi_cls_session *session);
extern int iscsi_destroy_session(struct iscsi_cls_session *session);
extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
						int dd_size, uint32_t cid);
extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
extern void iscsi_unblock_session(struct iscsi_cls_session *session);
extern void iscsi_block_session(struct iscsi_cls_session *session);
extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);

#endif
Commit	Line	Data
39e84790	1	/*
1da177e4 LT	2	* iSCSI transport class definitions
	3	*
	4	* Copyright (C) IBM Corporation, 2004
7996a778	5	* Copyright (C) Mike Christie, 2004 - 2006
39e84790 AA	6	* Copyright (C) Dmitry Yusupov, 2004 - 2005
39e84790 AA	7	* Copyright (C) Alex Aizman, 2004 - 2005
1da177e4 LT	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	22	*/
	23	#ifndef SCSI_TRANSPORT_ISCSI_H
	24	#define SCSI_TRANSPORT_ISCSI_H
	25
7b8631b5	26	#include <linux/device.h>
d773c082 MT	27	#include <linux/list.h>
d773c082 MT	28	#include <linux/mutex.h>
39e84790	29	#include <scsi/iscsi_if.h>
1da177e4	30
7b8631b5	31	struct scsi_transport_template;
7996a778	32	struct iscsi_transport;
7b8631b5	33	struct Scsi_Host;
7b8631b5	34	struct iscsi_cls_conn;
7996a778 MC	35	struct iscsi_conn;
	36	struct iscsi_cmd_task;
	37	struct iscsi_mgmt_task;
a54a52ca	38	struct sockaddr;
7b8631b5	39
39e84790 AA	40	/**
	41	* struct iscsi_transport - iSCSI Transport template
	42	*
	43	* @name: transport name
	44	* @caps: iSCSI Data-Path capabilities
	45	* @create_session: create new iSCSI session object
	46	* @destroy_session: destroy existing iSCSI session object
	47	* @create_conn: create new iSCSI connection
	48	* @bind_conn: associate this connection with existing iSCSI session
	49	* and specified transport descriptor
	50	* @destroy_conn: destroy inactive iSCSI connection
a54a52ca MC	51	* @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
	52	* when param is not supported, and a -Exx value on other
	53	* error.
	54	* @get_param get iSCSI parameter. Must return number of bytes
	55	* copied to buffer on success, -ENODATA when param
	56	* is not supported, and a -Exx value on other error
39e84790 AA	57	* @start_conn: set connection to be operational
	58	* @stop_conn: suspend/recover/terminate connection
	59	* @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
7996a778	60	* @session_recovery_timedout: notify LLD a block during recovery timed out
7996a778 MC	61	* @init_cmd_task: Initialize a iscsi_cmd_task and any internal structs.
	62	* Called from queuecommand with session lock held.
	63	* @init_mgmt_task: Initialize a iscsi_mgmt_task and any internal structs.
	64	* Called from iscsi_conn_send_generic with xmitmutex.
3219e529 MC	65	* @xmit_cmd_task: Requests LLD to transfer cmd task. Returns 0 or the
	66	* the number of bytes transferred on success, and -Exyz
	67	* value on error.
	68	* @xmit_mgmt_task: Requests LLD to transfer mgmt task. Returns 0 or the
	69	* the number of bytes transferred on success, and -Exyz
	70	* value on error.
7996a778 MC	71	* @cleanup_cmd_task: requests LLD to fail cmd task. Called with xmitmutex
	72	* and session->lock after the connection has been
	73	* suspended and terminated during recovery. If called
	74	* from abort task then connection is not suspended
	75	* or terminated but sk_callback_lock is held
39e84790 AA	76	*
	77	* Template API provided by iSCSI Transport
	78	*/
	79	struct iscsi_transport {
	80	struct module *owner;
	81	char *name;
	82	unsigned int caps;
fd7255f5	83	/* LLD sets this to indicate what values it can export to sysfs */
1819dc81 MC	84	uint64_t param_mask;
1819dc81 MC	85	uint64_t host_param_mask;
75613521 MC	86	struct iscsi_cls_session (create_session) (struct Scsi_Host *shost,
	87	uint16_t cmds_max, uint16_t qdepth,
	88	uint32_t sn, uint32_t *hn);
7b7232f3 MC	89	void (destroy_session) (struct iscsi_cls_session session);
7b7232f3 MC	90	struct iscsi_cls_conn (create_conn) (struct iscsi_cls_session *sess,
7b8631b5	91	uint32_t cid);
7b7232f3 MC	92	int (bind_conn) (struct iscsi_cls_session session,
7b7232f3 MC	93	struct iscsi_cls_conn *cls_conn,
264faaaa	94	uint64_t transport_eph, int is_leading);
7b7232f3 MC	95	int (start_conn) (struct iscsi_cls_conn conn);
7b7232f3 MC	96	void (stop_conn) (struct iscsi_cls_conn conn, int flag);
7b8631b5	97	void (destroy_conn) (struct iscsi_cls_conn conn);
7b7232f3	98	int (set_param) (struct iscsi_cls_conn conn, enum iscsi_param param,
a54a52ca	99	char *buf, int buflen);
7b7232f3	100	int (get_conn_param) (struct iscsi_cls_conn conn,
a54a52ca	101	enum iscsi_param param, char *buf);
7b7232f3	102	int (get_session_param) (struct iscsi_cls_session session,
a54a52ca	103	enum iscsi_param param, char *buf);
1819dc81 MC	104	int (get_host_param) (struct Scsi_Host shost,
1819dc81 MC	105	enum iscsi_host_param param, char *buf);
1d9bf13a MC	106	int (set_host_param) (struct Scsi_Host shost,
	107	enum iscsi_host_param param, char *buf,
	108	int buflen);
7b7232f3	109	int (send_pdu) (struct iscsi_cls_conn conn, struct iscsi_hdr *hdr,
39e84790	110	char *data, uint32_t data_size);
7b7232f3 MC	111	void (get_stats) (struct iscsi_cls_conn conn,
7b7232f3 MC	112	struct iscsi_stats *stats);
a8ac6311	113	int (init_cmd_task) (struct iscsi_cmd_task ctask);
7996a778	114	void (init_mgmt_task) (struct iscsi_conn conn,
77a23c21	115	struct iscsi_mgmt_task *mtask);
7996a778 MC	116	int (xmit_cmd_task) (struct iscsi_conn conn,
	117	struct iscsi_cmd_task *ctask);
	118	void (cleanup_cmd_task) (struct iscsi_conn conn,
	119	struct iscsi_cmd_task *ctask);
	120	int (xmit_mgmt_task) (struct iscsi_conn conn,
	121	struct iscsi_mgmt_task *mtask);
30a6c652	122	void (session_recovery_timedout) (struct iscsi_cls_session session);
264faaaa OG	123	int (ep_connect) (struct sockaddr dst_addr, int non_blocking,
	124	uint64_t *ep_handle);
	125	int (*ep_poll) (uint64_t ep_handle, int timeout_ms);
	126	void (*ep_disconnect) (uint64_t ep_handle);
2174a04e	127	int (tgt_dscvr) (struct Scsi_Host shost, enum iscsi_tgt_dscvr type,
01cb225d	128	uint32_t enable, struct sockaddr *dst_addr);
1da177e4 LT	129	};
	130
	131	/*
39e84790	132	* transport registration upcalls
1da177e4	133	*/
7b8631b5	134	extern struct scsi_transport_template iscsi_register_transport(struct iscsi_transport tt);
39e84790	135	extern int iscsi_unregister_transport(struct iscsi_transport *tt);
1da177e4 LT	136
1da177e4 LT	137	/*
39e84790	138	* control plane upcalls
1da177e4	139	*/
7b7232f3 MC	140	extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error);
7b7232f3 MC	141	extern int iscsi_recv_pdu(struct iscsi_cls_conn conn, struct iscsi_hdr hdr,
39e84790	142	char *data, uint32_t data_size);
1da177e4	143
7b8631b5 MC	144	struct iscsi_cls_conn {
	145	struct list_head conn_list; /* item in connlist */
	146	void dd_data; / LLD private data */
	147	struct iscsi_transport *transport;
b5c7a12d	148	uint32_t cid; /* connection id */
fd7255f5	149
7b8631b5 MC	150	int active; /* must be accessed with the connlock */
7b8631b5 MC	151	struct device dev; /* sysfs transport/container device */
7b8631b5 MC	152	};
	153
	154	#define iscsi_dev_to_conn(_dev) \
	155	container_of(_dev, struct iscsi_cls_conn, dev)
	156
6eabafbe MC	157	#define iscsi_conn_to_session(_conn) \
	158	iscsi_dev_to_session(_conn->dev.parent)
	159
	160	/* iscsi class session state */
	161	enum {
	162	ISCSI_SESSION_LOGGED_IN,
	163	ISCSI_SESSION_FAILED,
	164	ISCSI_SESSION_FREE,
	165	};
7996a778	166
7b8631b5	167	struct iscsi_cls_session {
7b7232f3	168	struct list_head sess_list; /* item in session_list */
30a6c652	169	struct list_head host_list;
7b8631b5	170	struct iscsi_transport *transport;
6eabafbe	171	spinlock_t lock;
45ab33b6 MC	172	struct work_struct block_work;
45ab33b6 MC	173	struct work_struct unblock_work;
bd976f62 MC	174	struct work_struct scan_work;
bd976f62 MC	175	struct work_struct unbind_work;
fd7255f5	176
30a6c652 MC	177	/* recovery fields */
30a6c652 MC	178	int recovery_tmo;
c4028958	179	struct delayed_work recovery_work;
30a6c652 MC	180
30a6c652 MC	181	int target_id;
30a6c652	182
6eabafbe	183	int state;
b5c7a12d MC	184	int sid; /* session id */
b5c7a12d MC	185	void dd_data; / LLD private data */
7b8631b5 MC	186	struct device dev; /* sysfs transport/container device */
	187	};
	188
	189	#define iscsi_dev_to_session(_dev) \
	190	container_of(_dev, struct iscsi_cls_session, dev)
	191
	192	#define iscsi_session_to_shost(_session) \
	193	dev_to_shost(_session->dev.parent)
	194
8434aa8b MC	195	#define starget_to_session(_stgt) \
	196	iscsi_dev_to_session(_stgt->dev.parent)
	197
32c6e1b9	198	struct iscsi_cls_host {
30a6c652	199	struct list_head sessions;
8aae18ad	200	atomic_t nr_scans;
30a6c652	201	struct mutex mutex;
bd976f62 MC	202	struct workqueue_struct *scan_workq;
bd976f62 MC	203	char scan_workq_name[KOBJ_NAME_LEN];
30a6c652 MC	204	};
30a6c652 MC	205
a4804cd6 MC	206	extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
	207	void (fn)(struct iscsi_cls_session ));
	208
	209
7b8631b5 MC	210	/*
	211	* session and connection functions that can be used by HW iSCSI LLDs
	212	*/
322d739d MC	213	#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
	214	dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
	215
	216	#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
	217	dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
	218
6eabafbe	219	extern int iscsi_session_chkready(struct iscsi_cls_session *session);
8434aa8b	220	extern struct iscsi_cls_session iscsi_alloc_session(struct Scsi_Host shost,
5d91e209	221	struct iscsi_transport *transport, int dd_size);
6a8a0d36 MC	222	extern int iscsi_add_session(struct iscsi_cls_session *session,
6a8a0d36 MC	223	unsigned int target_id);
26974789 MC	224	extern int iscsi_session_event(struct iscsi_cls_session *session,
26974789 MC	225	enum iscsi_uevent_e event);
7b8631b5	226	extern struct iscsi_cls_session iscsi_create_session(struct Scsi_Host shost,
6a8a0d36	227	struct iscsi_transport *t,
5d91e209	228	int dd_size,
6a8a0d36	229	unsigned int target_id);
8434aa8b MC	230	extern void iscsi_remove_session(struct iscsi_cls_session *session);
8434aa8b MC	231	extern void iscsi_free_session(struct iscsi_cls_session *session);
7b8631b5 MC	232	extern int iscsi_destroy_session(struct iscsi_cls_session *session);
7b8631b5 MC	233	extern struct iscsi_cls_conn iscsi_create_conn(struct iscsi_cls_session sess,
5d91e209	234	int dd_size, uint32_t cid);
7b8631b5	235	extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
30a6c652 MC	236	extern void iscsi_unblock_session(struct iscsi_cls_session *session);
30a6c652 MC	237	extern void iscsi_block_session(struct iscsi_cls_session *session);
8aae18ad	238	extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
53cb8a1f	239
1da177e4	240	#endif