[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 <scsi/iscsi_if.h>

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

/**
 * 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 Data-Path operational parameter
 * @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
 * @suspend_conn_recv:	susepend the recv side of the connection
 * @termincate_conn:	destroy socket connection. Called with mutex lock.
 * @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 */
	unsigned int param_mask;
	struct scsi_host_template *host_template;
	/* LLD connection data size */
	int conndata_size;
	/* LLD session data size */
	int sessiondata_size;
	int max_lun;
	unsigned int max_conn;
	unsigned int max_cmd_len;
	struct iscsi_cls_session *(*create_session) (struct iscsi_transport *it,
		struct scsi_transport_template *t, 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,
			  uint32_t value);
	int (*get_conn_param) (struct iscsi_cls_conn *conn,
			       enum iscsi_param param, uint32_t *value);
	int (*get_session_param) (struct iscsi_cls_session *session,
				  enum iscsi_param param, uint32_t *value);
	int (*get_conn_str_param) (struct iscsi_cls_conn *conn,
				   enum iscsi_param param, char *buf);
	int (*get_session_str_param) (struct iscsi_cls_session *session,
				      enum iscsi_param param, char *buf);
	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);
	void (*suspend_conn_recv) (struct iscsi_conn *conn);
	void (*terminate_conn) (struct iscsi_conn *conn);
	void (*init_cmd_task) (struct iscsi_cmd_task *ctask);
	void (*init_mgmt_task) (struct iscsi_conn *conn,
				struct iscsi_mgmt_task *mtask,
				char *data, uint32_t data_size);
	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);
};

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


/* Connection's states */
#define ISCSI_CONN_INITIAL_STAGE	0
#define ISCSI_CONN_STARTED		1
#define ISCSI_CONN_STOPPED		2
#define ISCSI_CONN_CLEANUP_WAIT		3

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 */

	/* portal/group values we got during discovery */
	char *persistent_address;
	int persistent_port;
	/* portal/group values we are currently using */
	char *address;
	int port;

	int active;			/* must be accessed with the connlock */
	struct device dev;		/* sysfs transport/container device */
	struct mempool_zone *z_error;
	struct mempool_zone *z_pdu;
	struct list_head freequeue;
};

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

/* Session's states */
#define ISCSI_STATE_FREE		1
#define ISCSI_STATE_LOGGED_IN		2
#define ISCSI_STATE_FAILED		3
#define ISCSI_STATE_TERMINATE		4
#define ISCSI_STATE_IN_RECOVERY		5
#define ISCSI_STATE_RECOVERY_FAILED	6

struct iscsi_cls_session {
	struct list_head sess_list;		/* item in session_list */
	struct list_head host_list;
	struct iscsi_transport *transport;

	/* iSCSI values used as unique id by userspace. */
	char *targetname;
	int tpgt;

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

	int target_id;
	int channel;

	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)

struct iscsi_host {
	int next_target_id;
	struct list_head sessions;
	struct mutex mutex;
};

/*
 * session and connection functions that can be used by HW iSCSI LLDs
 */
extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
				struct iscsi_transport *t, int channel);
extern int iscsi_destroy_session(struct iscsi_cls_session *session);
extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
					    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);

#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>
39e84790	27	#include <scsi/iscsi_if.h>
1da177e4	28
7b8631b5	29	struct scsi_transport_template;
7996a778	30	struct iscsi_transport;
7b8631b5 MC	31	struct Scsi_Host;
	32	struct mempool_zone;
	33	struct iscsi_cls_conn;
7996a778 MC	34	struct iscsi_conn;
	35	struct iscsi_cmd_task;
	36	struct iscsi_mgmt_task;
7b8631b5	37
39e84790 AA	38	/**
	39	* struct iscsi_transport - iSCSI Transport template
	40	*
	41	* @name: transport name
	42	* @caps: iSCSI Data-Path capabilities
	43	* @create_session: create new iSCSI session object
	44	* @destroy_session: destroy existing iSCSI session object
	45	* @create_conn: create new iSCSI connection
	46	* @bind_conn: associate this connection with existing iSCSI session
	47	* and specified transport descriptor
	48	* @destroy_conn: destroy inactive iSCSI connection
	49	* @set_param: set iSCSI Data-Path operational parameter
	50	* @start_conn: set connection to be operational
	51	* @stop_conn: suspend/recover/terminate connection
	52	* @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
7996a778 MC	53	* @session_recovery_timedout: notify LLD a block during recovery timed out
	54	* @suspend_conn_recv: susepend the recv side of the connection
	55	* @termincate_conn: destroy socket connection. Called with mutex lock.
	56	* @init_cmd_task: Initialize a iscsi_cmd_task and any internal structs.
	57	* Called from queuecommand with session lock held.
	58	* @init_mgmt_task: Initialize a iscsi_mgmt_task and any internal structs.
	59	* Called from iscsi_conn_send_generic with xmitmutex.
3219e529 MC	60	* @xmit_cmd_task: Requests LLD to transfer cmd task. Returns 0 or the
	61	* the number of bytes transferred on success, and -Exyz
	62	* value on error.
	63	* @xmit_mgmt_task: Requests LLD to transfer mgmt task. Returns 0 or the
	64	* the number of bytes transferred on success, and -Exyz
	65	* value on error.
7996a778 MC	66	* @cleanup_cmd_task: requests LLD to fail cmd task. Called with xmitmutex
	67	* and session->lock after the connection has been
	68	* suspended and terminated during recovery. If called
	69	* from abort task then connection is not suspended
	70	* or terminated but sk_callback_lock is held
39e84790 AA	71	*
	72	* Template API provided by iSCSI Transport
	73	*/
	74	struct iscsi_transport {
	75	struct module *owner;
	76	char *name;
	77	unsigned int caps;
fd7255f5 MC	78	/* LLD sets this to indicate what values it can export to sysfs */
fd7255f5 MC	79	unsigned int param_mask;
39e84790	80	struct scsi_host_template *host_template;
7b8631b5 MC	81	/* LLD connection data size */
7b8631b5 MC	82	int conndata_size;
b5c7a12d MC	83	/* LLD session data size */
b5c7a12d MC	84	int sessiondata_size;
39e84790 AA	85	int max_lun;
	86	unsigned int max_conn;
	87	unsigned int max_cmd_len;
7996a778 MC	88	struct iscsi_cls_session (create_session) (struct iscsi_transport *it,
7996a778 MC	89	struct scsi_transport_template t, uint32_t sn, uint32_t hn);
7b7232f3 MC	90	void (destroy_session) (struct iscsi_cls_session session);
7b7232f3 MC	91	struct iscsi_cls_conn (create_conn) (struct iscsi_cls_session *sess,
7b8631b5	92	uint32_t cid);
7b7232f3 MC	93	int (bind_conn) (struct iscsi_cls_session session,
7b7232f3 MC	94	struct iscsi_cls_conn *cls_conn,
264faaaa	95	uint64_t transport_eph, int is_leading);
7b7232f3 MC	96	int (start_conn) (struct iscsi_cls_conn conn);
7b7232f3 MC	97	void (stop_conn) (struct iscsi_cls_conn conn, int flag);
7b8631b5	98	void (destroy_conn) (struct iscsi_cls_conn conn);
7b7232f3	99	int (set_param) (struct iscsi_cls_conn conn, enum iscsi_param param,
39e84790	100	uint32_t value);
7b7232f3	101	int (get_conn_param) (struct iscsi_cls_conn conn,
fd7255f5	102	enum iscsi_param param, uint32_t *value);
7b7232f3	103	int (get_session_param) (struct iscsi_cls_session session,
7b8631b5	104	enum iscsi_param param, uint32_t *value);
fd7255f5 MC	105	int (get_conn_str_param) (struct iscsi_cls_conn conn,
	106	enum iscsi_param param, char *buf);
	107	int (get_session_str_param) (struct iscsi_cls_session session,
	108	enum iscsi_param param, char *buf);
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);
7996a778 MC	113	void (suspend_conn_recv) (struct iscsi_conn conn);
	114	void (terminate_conn) (struct iscsi_conn conn);
	115	void (init_cmd_task) (struct iscsi_cmd_task ctask);
	116	void (init_mgmt_task) (struct iscsi_conn conn,
	117	struct iscsi_mgmt_task *mtask,
	118	char *data, uint32_t data_size);
	119	int (xmit_cmd_task) (struct iscsi_conn conn,
	120	struct iscsi_cmd_task *ctask);
	121	void (cleanup_cmd_task) (struct iscsi_conn conn,
	122	struct iscsi_cmd_task *ctask);
	123	int (xmit_mgmt_task) (struct iscsi_conn conn,
	124	struct iscsi_mgmt_task *mtask);
30a6c652	125	void (session_recovery_timedout) (struct iscsi_cls_session session);
264faaaa OG	126	int (ep_connect) (struct sockaddr dst_addr, int non_blocking,
	127	uint64_t *ep_handle);
	128	int (*ep_poll) (uint64_t ep_handle, int timeout_ms);
	129	void (*ep_disconnect) (uint64_t ep_handle);
1da177e4 LT	130	};
	131
	132	/*
39e84790	133	* transport registration upcalls
1da177e4	134	*/
7b8631b5	135	extern struct scsi_transport_template iscsi_register_transport(struct iscsi_transport tt);
39e84790	136	extern int iscsi_unregister_transport(struct iscsi_transport *tt);
1da177e4 LT	137
1da177e4 LT	138	/*
39e84790	139	* control plane upcalls
1da177e4	140	*/
7b7232f3 MC	141	extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error);
7b7232f3 MC	142	extern int iscsi_recv_pdu(struct iscsi_cls_conn conn, struct iscsi_hdr hdr,
39e84790	143	char *data, uint32_t data_size);
1da177e4	144
7996a778 MC	145
	146	/* Connection's states */
	147	#define ISCSI_CONN_INITIAL_STAGE 0
	148	#define ISCSI_CONN_STARTED 1
	149	#define ISCSI_CONN_STOPPED 2
	150	#define ISCSI_CONN_CLEANUP_WAIT 3
	151
7b8631b5 MC	152	struct iscsi_cls_conn {
	153	struct list_head conn_list; /* item in connlist */
	154	void dd_data; / LLD private data */
	155	struct iscsi_transport *transport;
b5c7a12d	156	uint32_t cid; /* connection id */
fd7255f5 MC	157
	158	/* portal/group values we got during discovery */
	159	char *persistent_address;
	160	int persistent_port;
	161	/* portal/group values we are currently using */
	162	char *address;
	163	int port;
	164
7b8631b5 MC	165	int active; /* must be accessed with the connlock */
	166	struct device dev; /* sysfs transport/container device */
	167	struct mempool_zone *z_error;
	168	struct mempool_zone *z_pdu;
	169	struct list_head freequeue;
	170	};
	171
	172	#define iscsi_dev_to_conn(_dev) \
	173	container_of(_dev, struct iscsi_cls_conn, dev)
	174
7996a778 MC	175	/* Session's states */
	176	#define ISCSI_STATE_FREE 1
	177	#define ISCSI_STATE_LOGGED_IN 2
	178	#define ISCSI_STATE_FAILED 3
	179	#define ISCSI_STATE_TERMINATE 4
656cffc9 MC	180	#define ISCSI_STATE_IN_RECOVERY 5
656cffc9 MC	181	#define ISCSI_STATE_RECOVERY_FAILED 6
7996a778	182
7b8631b5	183	struct iscsi_cls_session {
7b7232f3	184	struct list_head sess_list; /* item in session_list */
30a6c652	185	struct list_head host_list;
7b8631b5	186	struct iscsi_transport *transport;
fd7255f5 MC	187
	188	/* iSCSI values used as unique id by userspace. */
	189	char *targetname;
	190	int tpgt;
	191
30a6c652 MC	192	/* recovery fields */
	193	int recovery_tmo;
	194	struct work_struct recovery_work;
	195
	196	int target_id;
	197	int channel;
	198
b5c7a12d MC	199	int sid; /* session id */
b5c7a12d MC	200	void dd_data; / LLD private data */
7b8631b5 MC	201	struct device dev; /* sysfs transport/container device */
	202	};
	203
	204	#define iscsi_dev_to_session(_dev) \
	205	container_of(_dev, struct iscsi_cls_session, dev)
	206
	207	#define iscsi_session_to_shost(_session) \
	208	dev_to_shost(_session->dev.parent)
	209
30a6c652 MC	210	struct iscsi_host {
	211	int next_target_id;
	212	struct list_head sessions;
	213	struct mutex mutex;
	214	};
	215
7b8631b5 MC	216	/*
	217	* session and connection functions that can be used by HW iSCSI LLDs
	218	*/
	219	extern struct iscsi_cls_session iscsi_create_session(struct Scsi_Host shost,
30a6c652	220	struct iscsi_transport *t, int channel);
7b8631b5 MC	221	extern int iscsi_destroy_session(struct iscsi_cls_session *session);
	222	extern struct iscsi_cls_conn iscsi_create_conn(struct iscsi_cls_session sess,
	223	uint32_t cid);
	224	extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
30a6c652 MC	225	extern void iscsi_unblock_session(struct iscsi_cls_session *session);
30a6c652 MC	226	extern void iscsi_block_session(struct iscsi_cls_session *session);
7b8631b5	227
1da177e4	228	#endif