[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_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_task:		Initialize a iscsi_task and any internal structs.
 *			When offloading the data path, this is called from
 *			queuecommand with the session lock, or from the
 *			iscsi_conn_send_pdu context with the session lock.
 *			When not offloading the data path, this is called
 *			from the scsi work queue without the session lock.
 * @xmit_task		Requests LLD to transfer cmd task. Returns 0 or the
 *			the number of bytes transferred on success, and -Exyz
 *			value on error. When offloading the data path, this
 *			is called from queuecommand with the session lock, or
 *			from the iscsi_conn_send_pdu context with the session
 *			lock. When not offloading the data path, this is called
 *			from the scsi work queue without the session lock.
 * @cleanup_task:	requests LLD to fail task. Called with session lock
 *			and 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_task) (struct iscsi_task *task);
	int (*xmit_task) (struct iscsi_task *task);
	void (*cleanup_task) (struct iscsi_conn *conn,
				  struct iscsi_task *task);
	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,
};

#define ISCSI_MAX_TARGET -1

struct iscsi_cls_session {
	struct list_head sess_list;		/* item in session_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;

	unsigned 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 {
	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	35	struct iscsi_conn;
9c19a7d0	36	struct iscsi_task;
a54a52ca	37	struct sockaddr;
7b8631b5	38
39e84790 AA	39	/**
	40	* struct iscsi_transport - iSCSI Transport template
	41	*
	42	* @name: transport name
	43	* @caps: iSCSI Data-Path capabilities
	44	* @create_session: create new iSCSI session object
	45	* @destroy_session: destroy existing iSCSI session object
	46	* @create_conn: create new iSCSI connection
	47	* @bind_conn: associate this connection with existing iSCSI session
	48	* and specified transport descriptor
	49	* @destroy_conn: destroy inactive iSCSI connection
a54a52ca MC	50	* @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
	51	* when param is not supported, and a -Exx value on other
	52	* error.
	53	* @get_param get iSCSI parameter. Must return number of bytes
	54	* copied to buffer on success, -ENODATA when param
	55	* is not supported, and a -Exx value on other error
39e84790 AA	56	* @start_conn: set connection to be operational
	57	* @stop_conn: suspend/recover/terminate connection
	58	* @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
7996a778	59	* @session_recovery_timedout: notify LLD a block during recovery timed out
3e5c28ad MC	60	* @init_task: Initialize a iscsi_task and any internal structs.
	61	* When offloading the data path, this is called from
	62	* queuecommand with the session lock, or from the
	63	* iscsi_conn_send_pdu context with the session lock.
	64	* When not offloading the data path, this is called
	65	* from the scsi work queue without the session lock.
	66	* @xmit_task Requests LLD to transfer cmd task. Returns 0 or the
3219e529	67	* the number of bytes transferred on success, and -Exyz
3e5c28ad MC	68	* value on error. When offloading the data path, this
	69	* is called from queuecommand with the session lock, or
	70	* from the iscsi_conn_send_pdu context with the session
	71	* lock. When not offloading the data path, this is called
	72	* from the scsi work queue without the session lock.
	73	* @cleanup_task: requests LLD to fail task. Called with session lock
	74	* and after the connection has been suspended and
	75	* terminated during recovery. If called
7996a778 MC	76	* from abort task then connection is not suspended
7996a778 MC	77	* or terminated but sk_callback_lock is held
39e84790 AA	78	*
	79	* Template API provided by iSCSI Transport
	80	*/
	81	struct iscsi_transport {
	82	struct module *owner;
	83	char *name;
	84	unsigned int caps;
fd7255f5	85	/* LLD sets this to indicate what values it can export to sysfs */
1819dc81 MC	86	uint64_t param_mask;
1819dc81 MC	87	uint64_t host_param_mask;
75613521 MC	88	struct iscsi_cls_session (create_session) (struct Scsi_Host *shost,
	89	uint16_t cmds_max, uint16_t qdepth,
	90	uint32_t sn, uint32_t *hn);
7b7232f3 MC	91	void (destroy_session) (struct iscsi_cls_session session);
7b7232f3 MC	92	struct iscsi_cls_conn (create_conn) (struct iscsi_cls_session *sess,
7b8631b5	93	uint32_t cid);
7b7232f3 MC	94	int (bind_conn) (struct iscsi_cls_session session,
7b7232f3 MC	95	struct iscsi_cls_conn *cls_conn,
264faaaa	96	uint64_t transport_eph, int is_leading);
7b7232f3 MC	97	int (start_conn) (struct iscsi_cls_conn conn);
7b7232f3 MC	98	void (stop_conn) (struct iscsi_cls_conn conn, int flag);
7b8631b5	99	void (destroy_conn) (struct iscsi_cls_conn conn);
7b7232f3	100	int (set_param) (struct iscsi_cls_conn conn, enum iscsi_param param,
a54a52ca	101	char *buf, int buflen);
7b7232f3	102	int (get_conn_param) (struct iscsi_cls_conn conn,
a54a52ca	103	enum iscsi_param param, char *buf);
7b7232f3	104	int (get_session_param) (struct iscsi_cls_session session,
a54a52ca	105	enum iscsi_param param, char *buf);
1819dc81 MC	106	int (get_host_param) (struct Scsi_Host shost,
1819dc81 MC	107	enum iscsi_host_param param, char *buf);
1d9bf13a MC	108	int (set_host_param) (struct Scsi_Host shost,
	109	enum iscsi_host_param param, char *buf,
	110	int buflen);
7b7232f3	111	int (send_pdu) (struct iscsi_cls_conn conn, struct iscsi_hdr *hdr,
39e84790	112	char *data, uint32_t data_size);
7b7232f3 MC	113	void (get_stats) (struct iscsi_cls_conn conn,
7b7232f3 MC	114	struct iscsi_stats *stats);
9c19a7d0 MC	115	int (init_task) (struct iscsi_task task);
9c19a7d0 MC	116	int (xmit_task) (struct iscsi_task task);
3e5c28ad	117	void (cleanup_task) (struct iscsi_conn conn,
9c19a7d0	118	struct iscsi_task *task);
30a6c652	119	void (session_recovery_timedout) (struct iscsi_cls_session session);
264faaaa OG	120	int (ep_connect) (struct sockaddr dst_addr, int non_blocking,
	121	uint64_t *ep_handle);
	122	int (*ep_poll) (uint64_t ep_handle, int timeout_ms);
	123	void (*ep_disconnect) (uint64_t ep_handle);
2174a04e	124	int (tgt_dscvr) (struct Scsi_Host shost, enum iscsi_tgt_dscvr type,
01cb225d	125	uint32_t enable, struct sockaddr *dst_addr);
1da177e4 LT	126	};
	127
	128	/*
39e84790	129	* transport registration upcalls
1da177e4	130	*/
7b8631b5	131	extern struct scsi_transport_template iscsi_register_transport(struct iscsi_transport tt);
39e84790	132	extern int iscsi_unregister_transport(struct iscsi_transport *tt);
1da177e4 LT	133
1da177e4 LT	134	/*
39e84790	135	* control plane upcalls
1da177e4	136	*/
7b7232f3 MC	137	extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error);
7b7232f3 MC	138	extern int iscsi_recv_pdu(struct iscsi_cls_conn conn, struct iscsi_hdr hdr,
39e84790	139	char *data, uint32_t data_size);
1da177e4	140
7b8631b5 MC	141	struct iscsi_cls_conn {
	142	struct list_head conn_list; /* item in connlist */
	143	void dd_data; / LLD private data */
	144	struct iscsi_transport *transport;
b5c7a12d	145	uint32_t cid; /* connection id */
fd7255f5	146
7b8631b5 MC	147	int active; /* must be accessed with the connlock */
7b8631b5 MC	148	struct device dev; /* sysfs transport/container device */
7b8631b5 MC	149	};
	150
	151	#define iscsi_dev_to_conn(_dev) \
	152	container_of(_dev, struct iscsi_cls_conn, dev)
	153
6eabafbe MC	154	#define iscsi_conn_to_session(_conn) \
	155	iscsi_dev_to_session(_conn->dev.parent)
	156
	157	/* iscsi class session state */
	158	enum {
	159	ISCSI_SESSION_LOGGED_IN,
	160	ISCSI_SESSION_FAILED,
	161	ISCSI_SESSION_FREE,
	162	};
7996a778	163
7970634b MC	164	#define ISCSI_MAX_TARGET -1
7970634b MC	165
7b8631b5	166	struct iscsi_cls_session {
7b7232f3	167	struct list_head sess_list; /* item in session_list */
7b8631b5	168	struct iscsi_transport *transport;
6eabafbe	169	spinlock_t lock;
45ab33b6 MC	170	struct work_struct block_work;
45ab33b6 MC	171	struct work_struct unblock_work;
bd976f62 MC	172	struct work_struct scan_work;
bd976f62 MC	173	struct work_struct unbind_work;
fd7255f5	174
30a6c652 MC	175	/* recovery fields */
30a6c652 MC	176	int recovery_tmo;
c4028958	177	struct delayed_work recovery_work;
30a6c652	178
7970634b	179	unsigned int target_id;
30a6c652	180
6eabafbe	181	int state;
b5c7a12d MC	182	int sid; /* session id */
b5c7a12d MC	183	void dd_data; / LLD private data */
7b8631b5 MC	184	struct device dev; /* sysfs transport/container device */
	185	};
	186
	187	#define iscsi_dev_to_session(_dev) \
	188	container_of(_dev, struct iscsi_cls_session, dev)
	189
	190	#define iscsi_session_to_shost(_session) \
	191	dev_to_shost(_session->dev.parent)
	192
8434aa8b MC	193	#define starget_to_session(_stgt) \
	194	iscsi_dev_to_session(_stgt->dev.parent)
	195
32c6e1b9	196	struct iscsi_cls_host {
8aae18ad	197	atomic_t nr_scans;
30a6c652	198	struct mutex mutex;
bd976f62 MC	199	struct workqueue_struct *scan_workq;
bd976f62 MC	200	char scan_workq_name[KOBJ_NAME_LEN];
30a6c652 MC	201	};
30a6c652 MC	202
a4804cd6 MC	203	extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
	204	void (fn)(struct iscsi_cls_session ));
	205
	206
7b8631b5 MC	207	/*
	208	* session and connection functions that can be used by HW iSCSI LLDs
	209	*/
322d739d MC	210	#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
	211	dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
	212
	213	#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
	214	dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
	215
6eabafbe	216	extern int iscsi_session_chkready(struct iscsi_cls_session *session);
8434aa8b	217	extern struct iscsi_cls_session iscsi_alloc_session(struct Scsi_Host shost,
5d91e209	218	struct iscsi_transport *transport, int dd_size);
6a8a0d36 MC	219	extern int iscsi_add_session(struct iscsi_cls_session *session,
6a8a0d36 MC	220	unsigned int target_id);
26974789 MC	221	extern int iscsi_session_event(struct iscsi_cls_session *session,
26974789 MC	222	enum iscsi_uevent_e event);
7b8631b5	223	extern struct iscsi_cls_session iscsi_create_session(struct Scsi_Host shost,
6a8a0d36	224	struct iscsi_transport *t,
5d91e209	225	int dd_size,
6a8a0d36	226	unsigned int target_id);
8434aa8b MC	227	extern void iscsi_remove_session(struct iscsi_cls_session *session);
8434aa8b MC	228	extern void iscsi_free_session(struct iscsi_cls_session *session);
7b8631b5 MC	229	extern int iscsi_destroy_session(struct iscsi_cls_session *session);
7b8631b5 MC	230	extern struct iscsi_cls_conn iscsi_create_conn(struct iscsi_cls_session sess,
5d91e209	231	int dd_size, uint32_t cid);
7b8631b5	232	extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
30a6c652 MC	233	extern void iscsi_unblock_session(struct iscsi_cls_session *session);
30a6c652 MC	234	extern void iscsi_block_session(struct iscsi_cls_session *session);
8aae18ad	235	extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
53cb8a1f	236
1da177e4	237	#endif