[deliverable/linux.git] / include / scsi / libiscsi.h

/*
 * iSCSI lib definitions
 *
 * Copyright (C) 2006 Red Hat, Inc.  All rights reserved.
 * Copyright (C) 2004 - 2006 Mike Christie
 * Copyright (C) 2004 - 2005 Dmitry Yusupov
 * Copyright (C) 2004 - 2005 Alex Aizman
 *
 * 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 LIBISCSI_H
#define LIBISCSI_H

#include <linux/types.h>
#include <linux/mutex.h>
#include <scsi/iscsi_proto.h>
#include <scsi/iscsi_if.h>

struct scsi_transport_template;
struct scsi_device;
struct Scsi_Host;
struct scsi_cmnd;
struct socket;
struct iscsi_transport;
struct iscsi_cls_session;
struct iscsi_cls_conn;
struct iscsi_session;
struct iscsi_nopin;

/* #define DEBUG_SCSI */
#ifdef DEBUG_SCSI
#define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
#else
#define debug_scsi(fmt...)
#endif

#define ISCSI_XMIT_CMDS_MAX	128	/* must be power of 2 */
#define ISCSI_MGMT_CMDS_MAX	32	/* must be power of 2 */
#define ISCSI_CONN_MAX			1

#define ISCSI_MGMT_ITT_OFFSET	0xa00

#define ISCSI_DEF_CMD_PER_LUN		32
#define ISCSI_MAX_CMD_PER_LUN		128

/* Task Mgmt states */
#define TMABORT_INITIAL			0x0
#define TMABORT_SUCCESS			0x1
#define TMABORT_FAILED			0x2
#define TMABORT_TIMEDOUT		0x3
#define TMABORT_NOT_FOUND		0x4

/* Connection suspend "bit" */
#define ISCSI_SUSPEND_BIT		1

#define ISCSI_ITT_MASK			(0xfff)
#define ISCSI_CID_SHIFT			12
#define ISCSI_CID_MASK			(0xffff << ISCSI_CID_SHIFT)
#define ISCSI_AGE_SHIFT			28
#define ISCSI_AGE_MASK			(0xf << ISCSI_AGE_SHIFT)

struct iscsi_mgmt_task {
	/*
	 * Becuae LLDs allocate their hdr differently, this is a pointer to
	 * that storage. It must be setup at session creation time.
	 */
	struct iscsi_hdr	*hdr;
	char			*data;		/* mgmt payload */
	int			data_count;	/* counts data to be sent */
	uint32_t		itt;		/* this ITT */
	void			*dd_data;	/* driver/transport data */
	struct list_head	running;
};

enum {
	ISCSI_TASK_COMPLETED,
	ISCSI_TASK_PENDING,
	ISCSI_TASK_RUNNING,
};

struct iscsi_cmd_task {
	/*
	 * Becuae LLDs allocate their hdr differently, this is a pointer to
	 * that storage. It must be setup at session creation time.
	 */
	struct iscsi_cmd	*hdr;
	int			itt;		/* this ITT */
	int			datasn;		/* DataSN */

	uint32_t		unsol_datasn;
	int			imm_count;	/* imm-data (bytes)   */
	int			unsol_count;	/* unsolicited (bytes)*/
	int			data_count;	/* remaining Data-Out */
	struct scsi_cmnd	*sc;		/* associated SCSI cmd*/
	int			total_length;
	struct iscsi_conn	*conn;		/* used connection    */
	struct iscsi_mgmt_task	*mtask;		/* tmf mtask in progr */

	/* state set/tested under session->lock */
	int			state;
	struct list_head	running;	/* running cmd list */
	void			*dd_data;	/* driver/transport data */
};

struct iscsi_conn {
	struct iscsi_cls_conn	*cls_conn;	/* ptr to class connection */
	void			*dd_data;	/* iscsi_transport data */
	struct iscsi_session	*session;	/* parent session */
	/*
	 * LLDs should set this lock. It protects the transport recv
	 * code
	 */
	rwlock_t		*recv_lock;
	/*
	 * conn_stop() flag: stop to recover, stop to terminate
	 */
        int			stop_stage;

	/* iSCSI connection-wide sequencing */
	uint32_t		exp_statsn;

	/* control data */
	int			id;		/* CID */
	struct list_head	item;		/* maintains list of conns */
	int			c_stage;	/* connection state */
	struct iscsi_mgmt_task	*login_mtask;	/* mtask used for login/text */
	struct iscsi_mgmt_task	*mtask;		/* xmit mtask in progress */
	struct iscsi_cmd_task	*ctask;		/* xmit ctask in progress */

	/* xmit */
	struct kfifo		*immqueue;	/* immediate xmit queue */
	struct kfifo		*mgmtqueue;	/* mgmt (control) xmit queue */
	struct list_head	mgmt_run_list;	/* list of control tasks */
	struct list_head	xmitqueue;	/* data-path cmd queue */
	struct list_head	run_list;	/* list of cmds in progress */
	struct work_struct	xmitwork;	/* per-conn. xmit workqueue */
	/*
	 * serializes connection xmit, access to kfifos:
	 * xmitqueue, immqueue, mgmtqueue
	 */
	struct mutex		xmitmutex;

	unsigned long		suspend_tx;	/* suspend Tx */
	unsigned long		suspend_rx;	/* suspend Rx */

	/* abort */
	wait_queue_head_t	ehwait;		/* used in eh_abort() */
	struct iscsi_tm		tmhdr;
	struct timer_list	tmabort_timer;
	int			tmabort_state;	/* see TMABORT_INITIAL, etc.*/

	/* negotiated params */
	int			max_recv_dlength; /* initiator_max_recv_dsl*/
	int			max_xmit_dlength; /* target_max_recv_dsl */
	int			hdrdgst_en;
	int			datadgst_en;
	int			ifmarker_en;
	int			ofmarker_en;
	/* values userspace uses to id a conn */
	int			persistent_port;
	char			*persistent_address;

	/* MIB-statistics */
	uint64_t		txdata_octets;
	uint64_t		rxdata_octets;
	uint32_t		scsicmd_pdus_cnt;
	uint32_t		dataout_pdus_cnt;
	uint32_t		scsirsp_pdus_cnt;
	uint32_t		datain_pdus_cnt;
	uint32_t		r2t_pdus_cnt;
	uint32_t		tmfcmd_pdus_cnt;
	int32_t			tmfrsp_pdus_cnt;

	/* custom statistics */
	uint32_t		eh_abort_cnt;
};

struct iscsi_queue {
	struct kfifo		*queue;		/* FIFO Queue */
	void			**pool;		/* Pool of elements */
	int			max;		/* Max number of elements */
};

struct iscsi_session {
	/* iSCSI session-wide sequencing */
	uint32_t		cmdsn;
	uint32_t		exp_cmdsn;
	uint32_t		max_cmdsn;

	/* configuration */
	int			initial_r2t_en;
	int			max_r2t;
	int			imm_data_en;
	int			first_burst;
	int			max_burst;
	int			time2wait;
	int			time2retain;
	int			pdu_inorder_en;
	int			dataseq_inorder_en;
	int			erl;
	int			tpgt;
	char			*targetname;

	/* control data */
	struct iscsi_transport	*tt;
	struct Scsi_Host	*host;
	struct iscsi_conn	*leadconn;	/* leading connection */
	spinlock_t		lock;		/* protects session state, *
						 * sequence numbers,       *
						 * session resources:      *
						 * - cmdpool,		   *
						 * - mgmtpool,		   *
						 * - r2tpool		   */
	int			state;		/* session state           */
	struct list_head	item;
	int			age;		/* counts session re-opens */

	struct list_head	connections;	/* list of connections */
	int			cmds_max;	/* size of cmds array */
	struct iscsi_cmd_task	**cmds;		/* Original Cmds arr */
	struct iscsi_queue	cmdpool;	/* PDU's pool */
	int			mgmtpool_max;	/* size of mgmt array */
	struct iscsi_mgmt_task	**mgmt_cmds;	/* Original mgmt arr */
	struct iscsi_queue	mgmtpool;	/* Mgmt PDU's pool */
};

/*
 * scsi host template
 */
extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
extern int iscsi_eh_abort(struct scsi_cmnd *sc);
extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
extern int iscsi_queuecommand(struct scsi_cmnd *sc,
			      void (*done)(struct scsi_cmnd *));

/*
 * session management
 */
extern struct iscsi_cls_session *
iscsi_session_setup(struct iscsi_transport *, struct scsi_transport_template *,
		    int, int, uint32_t, uint32_t *);
extern void iscsi_session_teardown(struct iscsi_cls_session *);
extern struct iscsi_session *class_to_transport_session(struct iscsi_cls_session *);
extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
			   enum iscsi_param param, char *buf, int buflen);
extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
				   enum iscsi_param param, char *buf);

#define session_to_cls(_sess) \
	hostdata_session(_sess->host->hostdata)

/*
 * connection management
 */
extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
					       uint32_t);
extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
extern int iscsi_conn_start(struct iscsi_cls_conn *);
extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *,
			   int);
extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
				enum iscsi_param param, char *buf);

/*
 * pdu and task processing
 */
extern int iscsi_check_assign_cmdsn(struct iscsi_session *,
				    struct iscsi_nopin *);
extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
					struct iscsi_data *hdr,
					int transport_data_cnt);
extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *,
				char *, uint32_t);
extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
			      char *, int);
extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
				char *, int);
extern int iscsi_verify_itt(struct iscsi_conn *, struct iscsi_hdr *,
			    uint32_t *);

/*
 * generic helpers
 */
extern void iscsi_pool_free(struct iscsi_queue *, void **);
extern int iscsi_pool_init(struct iscsi_queue *, int, void ***, int);

#endif
Commit	Line	Data
7996a778 MC	1	/*
	2	* iSCSI lib definitions
	3	*
	4	* Copyright (C) 2006 Red Hat, Inc. All rights reserved.
	5	* Copyright (C) 2004 - 2006 Mike Christie
	6	* Copyright (C) 2004 - 2005 Dmitry Yusupov
	7	* Copyright (C) 2004 - 2005 Alex Aizman
	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 LIBISCSI_H
	24	#define LIBISCSI_H
	25
	26	#include <linux/types.h>
	27	#include <linux/mutex.h>
	28	#include <scsi/iscsi_proto.h>
	29	#include <scsi/iscsi_if.h>
	30
	31	struct scsi_transport_template;
	32	struct scsi_device;
	33	struct Scsi_Host;
	34	struct scsi_cmnd;
	35	struct socket;
	36	struct iscsi_transport;
	37	struct iscsi_cls_session;
	38	struct iscsi_cls_conn;
	39	struct iscsi_session;
	40	struct iscsi_nopin;
	41
	42	/* #define DEBUG_SCSI */
	43	#ifdef DEBUG_SCSI
be2df72e	44	#define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
7996a778 MC	45	#else
	46	#define debug_scsi(fmt...)
	47	#endif
	48
	49	#define ISCSI_XMIT_CMDS_MAX 128 /* must be power of 2 */
	50	#define ISCSI_MGMT_CMDS_MAX 32 /* must be power of 2 */
	51	#define ISCSI_CONN_MAX 1
	52
	53	#define ISCSI_MGMT_ITT_OFFSET 0xa00
	54
	55	#define ISCSI_DEF_CMD_PER_LUN 32
	56	#define ISCSI_MAX_CMD_PER_LUN 128
	57
	58	/* Task Mgmt states */
	59	#define TMABORT_INITIAL 0x0
	60	#define TMABORT_SUCCESS 0x1
	61	#define TMABORT_FAILED 0x2
	62	#define TMABORT_TIMEDOUT 0x3
7ea8b828	63	#define TMABORT_NOT_FOUND 0x4
7996a778 MC	64
	65	/* Connection suspend "bit" */
	66	#define ISCSI_SUSPEND_BIT 1
	67
	68	#define ISCSI_ITT_MASK (0xfff)
	69	#define ISCSI_CID_SHIFT 12
	70	#define ISCSI_CID_MASK (0xffff << ISCSI_CID_SHIFT)
	71	#define ISCSI_AGE_SHIFT 28
	72	#define ISCSI_AGE_MASK (0xf << ISCSI_AGE_SHIFT)
	73
	74	struct iscsi_mgmt_task {
	75	/*
	76	* Becuae LLDs allocate their hdr differently, this is a pointer to
	77	* that storage. It must be setup at session creation time.
	78	*/
	79	struct iscsi_hdr *hdr;
	80	char data; / mgmt payload */
	81	int data_count; /* counts data to be sent */
	82	uint32_t itt; /* this ITT */
	83	void dd_data; / driver/transport data */
	84	struct list_head running;
	85	};
	86
b6c395ed MC	87	enum {
	88	ISCSI_TASK_COMPLETED,
	89	ISCSI_TASK_PENDING,
	90	ISCSI_TASK_RUNNING,
	91	};
	92
7996a778 MC	93	struct iscsi_cmd_task {
	94	/*
	95	* Becuae LLDs allocate their hdr differently, this is a pointer to
	96	* that storage. It must be setup at session creation time.
	97	*/
	98	struct iscsi_cmd *hdr;
	99	int itt; /* this ITT */
	100	int datasn; /* DataSN */
	101
	102	uint32_t unsol_datasn;
	103	int imm_count; /* imm-data (bytes) */
	104	int unsol_count; /* unsolicited (bytes)*/
	105	int data_count; /* remaining Data-Out */
	106	struct scsi_cmnd sc; / associated SCSI cmd*/
	107	int total_length;
	108	struct iscsi_conn conn; / used connection */
	109	struct iscsi_mgmt_task mtask; / tmf mtask in progr */
	110
b6c395ed MC	111	/* state set/tested under session->lock */
b6c395ed MC	112	int state;
7996a778 MC	113	struct list_head running; /* running cmd list */
	114	void dd_data; / driver/transport data */
	115	};
	116
	117	struct iscsi_conn {
	118	struct iscsi_cls_conn cls_conn; / ptr to class connection */
	119	void dd_data; / iscsi_transport data */
	120	struct iscsi_session session; / parent session */
	121	/*
	122	* LLDs should set this lock. It protects the transport recv
	123	* code
	124	*/
	125	rwlock_t *recv_lock;
	126	/*
	127	* conn_stop() flag: stop to recover, stop to terminate
	128	*/
	129	int stop_stage;
	130
	131	/* iSCSI connection-wide sequencing */
	132	uint32_t exp_statsn;
	133
	134	/* control data */
	135	int id; /* CID */
	136	struct list_head item; /* maintains list of conns */
	137	int c_stage; /* connection state */
	138	struct iscsi_mgmt_task login_mtask; / mtask used for login/text */
	139	struct iscsi_mgmt_task mtask; / xmit mtask in progress */
	140	struct iscsi_cmd_task ctask; / xmit ctask in progress */
	141
	142	/* xmit */
	143	struct kfifo immqueue; / immediate xmit queue */
	144	struct kfifo mgmtqueue; / mgmt (control) xmit queue */
	145	struct list_head mgmt_run_list; /* list of control tasks */
b6c395ed	146	struct list_head xmitqueue; /* data-path cmd queue */
7996a778 MC	147	struct list_head run_list; /* list of cmds in progress */
	148	struct work_struct xmitwork; /* per-conn. xmit workqueue */
	149	/*
	150	* serializes connection xmit, access to kfifos:
	151	* xmitqueue, immqueue, mgmtqueue
	152	*/
	153	struct mutex xmitmutex;
	154
	155	unsigned long suspend_tx; /* suspend Tx */
	156	unsigned long suspend_rx; /* suspend Rx */
	157
	158	/* abort */
	159	wait_queue_head_t ehwait; /* used in eh_abort() */
	160	struct iscsi_tm tmhdr;
	161	struct timer_list tmabort_timer;
	162	int tmabort_state; /* see TMABORT_INITIAL, etc.*/
	163
	164	/* negotiated params */
	165	int max_recv_dlength; /* initiator_max_recv_dsl*/
	166	int max_xmit_dlength; /* target_max_recv_dsl */
	167	int hdrdgst_en;
	168	int datadgst_en;
a54a52ca MC	169	int ifmarker_en;
	170	int ofmarker_en;
	171	/* values userspace uses to id a conn */
	172	int persistent_port;
	173	char *persistent_address;
7996a778 MC	174
	175	/* MIB-statistics */
	176	uint64_t txdata_octets;
	177	uint64_t rxdata_octets;
	178	uint32_t scsicmd_pdus_cnt;
	179	uint32_t dataout_pdus_cnt;
	180	uint32_t scsirsp_pdus_cnt;
	181	uint32_t datain_pdus_cnt;
	182	uint32_t r2t_pdus_cnt;
	183	uint32_t tmfcmd_pdus_cnt;
	184	int32_t tmfrsp_pdus_cnt;
	185
	186	/* custom statistics */
	187	uint32_t eh_abort_cnt;
	188	};
	189
	190	struct iscsi_queue {
	191	struct kfifo queue; / FIFO Queue */
	192	void *pool; / Pool of elements */
	193	int max; /* Max number of elements */
	194	};
	195
	196	struct iscsi_session {
	197	/* iSCSI session-wide sequencing */
	198	uint32_t cmdsn;
	199	uint32_t exp_cmdsn;
	200	uint32_t max_cmdsn;
	201
	202	/* configuration */
	203	int initial_r2t_en;
	204	int max_r2t;
	205	int imm_data_en;
	206	int first_burst;
	207	int max_burst;
	208	int time2wait;
	209	int time2retain;
	210	int pdu_inorder_en;
	211	int dataseq_inorder_en;
	212	int erl;
a54a52ca MC	213	int tpgt;
a54a52ca MC	214	char *targetname;
7996a778 MC	215
	216	/* control data */
	217	struct iscsi_transport *tt;
	218	struct Scsi_Host *host;
	219	struct iscsi_conn leadconn; / leading connection */
	220	spinlock_t lock; /* protects session state, *
	221	* sequence numbers, *
	222	* session resources: *
	223	* - cmdpool, *
	224	* - mgmtpool, *
	225	* - r2tpool */
	226	int state; /* session state */
7996a778	227	struct list_head item;
7996a778 MC	228	int age; /* counts session re-opens */
	229
	230	struct list_head connections; /* list of connections */
	231	int cmds_max; /* size of cmds array */
	232	struct iscsi_cmd_task *cmds; / Original Cmds arr */
	233	struct iscsi_queue cmdpool; /* PDU's pool */
	234	int mgmtpool_max; /* size of mgmt array */
	235	struct iscsi_mgmt_task *mgmt_cmds; / Original mgmt arr */
	236	struct iscsi_queue mgmtpool; /* Mgmt PDU's pool */
	237	};
	238
	239	/*
	240	* scsi host template
	241	*/
	242	extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
	243	extern int iscsi_eh_abort(struct scsi_cmnd *sc);
	244	extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
	245	extern int iscsi_queuecommand(struct scsi_cmnd *sc,
	246	void (done)(struct scsi_cmnd ));
	247
	248	/*
	249	* session management
	250	*/
	251	extern struct iscsi_cls_session *
	252	iscsi_session_setup(struct iscsi_transport , struct scsi_transport_template ,
	253	int, int, uint32_t, uint32_t *);
	254	extern void iscsi_session_teardown(struct iscsi_cls_session *);
	255	extern struct iscsi_session class_to_transport_session(struct iscsi_cls_session );
7996a778	256	extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
a54a52ca MC	257	extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
	258	enum iscsi_param param, char *buf, int buflen);
	259	extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
	260	enum iscsi_param param, char *buf);
7996a778 MC	261
	262	#define session_to_cls(_sess) \
	263	hostdata_session(_sess->host->hostdata)
	264
	265	/*
	266	* connection management
	267	*/
	268	extern struct iscsi_cls_conn iscsi_conn_setup(struct iscsi_cls_session ,
	269	uint32_t);
	270	extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
	271	extern int iscsi_conn_start(struct iscsi_cls_conn *);
	272	extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
	273	extern int iscsi_conn_bind(struct iscsi_cls_session , struct iscsi_cls_conn ,
	274	int);
	275	extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
a54a52ca MC	276	extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
a54a52ca MC	277	enum iscsi_param param, char *buf);
7996a778 MC	278
	279	/*
	280	* pdu and task processing
	281	*/
	282	extern int iscsi_check_assign_cmdsn(struct iscsi_session *,
	283	struct iscsi_nopin *);
	284	extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
	285	struct iscsi_data *hdr,
	286	int transport_data_cnt);
	287	extern int iscsi_conn_send_pdu(struct iscsi_cls_conn , struct iscsi_hdr ,
	288	char *, uint32_t);
	289	extern int iscsi_complete_pdu(struct iscsi_conn , struct iscsi_hdr ,
	290	char *, int);
	291	extern int __iscsi_complete_pdu(struct iscsi_conn , struct iscsi_hdr ,
	292	char *, int);
	293	extern int iscsi_verify_itt(struct iscsi_conn , struct iscsi_hdr ,
	294	uint32_t *);
	295
	296	/*
	297	* generic helpers
	298	*/
	299	extern void iscsi_pool_free(struct iscsi_queue , void *);
	300	extern int iscsi_pool_init(struct iscsi_queue , int, void **, int);
	301
	302	#endif