[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/wait.h>
#include <linux/mutex.h>
#include <linux/timer.h>
#include <linux/workqueue.h>
#include <scsi/iscsi_proto.h>
#include <scsi/iscsi_if.h>

struct scsi_transport_template;
struct scsi_host_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;
struct device;

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

#define ISCSI_DEF_XMIT_CMDS_MAX	128	/* must be power of 2 */
#define ISCSI_MGMT_CMDS_MAX	16	/* must be power of 2 */

#define ISCSI_MGMT_ITT_OFFSET	0xa00

#define ISCSI_DEF_CMD_PER_LUN		32
#define ISCSI_MAX_CMD_PER_LUN		128

/* Task Mgmt states */
enum {
	TMF_INITIAL,
	TMF_QUEUED,
	TMF_SUCCESS,
	TMF_FAILED,
	TMF_TIMEDOUT,
	TMF_NOT_FOUND,
};

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

#define ISCSI_ITT_MASK			(0xfff)
#define ISCSI_AGE_SHIFT			28
#define ISCSI_AGE_MASK			(0xf << ISCSI_AGE_SHIFT)

#define ISCSI_ADDRESS_BUF_LEN		64

enum {
	/* this is the maximum possible storage for AHSs */
	ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
				sizeof(struct iscsi_rlength_ahdr),
	ISCSI_DIGEST_SIZE = sizeof(__u32),
};

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 */
	unsigned		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 {
	/*
	 * Because LLDs allocate their hdr differently, this is a pointer
	 * and length to that storage. It must be setup at session
	 * creation time.
	 */
	struct iscsi_cmd	*hdr;
	unsigned short		hdr_max;
	unsigned short		hdr_len;	/* accumulated size of hdr used */
	int			itt;		/* this ITT */

	uint32_t		unsol_datasn;
	unsigned		imm_count;	/* imm-data (bytes)   */
	unsigned		unsol_count;	/* unsolicited (bytes)*/
	/* offset in unsolicited stream (bytes); */
	unsigned		unsol_offset;
	unsigned		data_count;	/* remaining Data-Out */
	struct scsi_cmnd	*sc;		/* associated SCSI cmd*/
	struct iscsi_conn	*conn;		/* used connection    */

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

static inline void* iscsi_next_hdr(struct iscsi_cmd_task *ctask)
{
	return (void*)ctask->hdr + ctask->hdr_len;
}

/* Connection's states */
enum {
	ISCSI_CONN_INITIAL_STAGE,
	ISCSI_CONN_STARTED,
	ISCSI_CONN_STOPPED,
	ISCSI_CONN_CLEANUP_WAIT,
};

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;
	struct timer_list	transport_timer;
	unsigned long		last_recv;
	unsigned long		last_ping;
	int			ping_timeout;
	int			recv_timeout;
	struct iscsi_mgmt_task	*ping_mtask;

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

	/* control data */
	int			id;		/* CID */
	int			c_stage;	/* connection state */
	/*
	 * Preallocated buffer for pdus that have data but do not
	 * originate from scsi-ml. We never have two pdus using the
	 * buffer at the same time. It is only allocated to
	 * the default max recv size because the pdus we support
	 * should always fit in this buffer
	 */
	char			*data;
	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 list_head	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 list_head	requeue;	/* tasks needing another run */
	struct work_struct	xmitwork;	/* per-conn. xmit workqueue */
	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	tmf_timer;
	int			tmf_state;	/* see TMF_INITIAL, etc.*/

	/* negotiated params */
	unsigned		max_recv_dlength; /* initiator_max_recv_dsl*/
	unsigned		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;
	/* remote portal currently connected to */
	int			portal_port;
	char			portal_address[ISCSI_ADDRESS_BUF_LEN];

	/* 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;
	uint32_t		fmr_unalign_cnt;
};

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

/* Session's states */
enum {
	ISCSI_STATE_FREE = 1,
	ISCSI_STATE_LOGGED_IN,
	ISCSI_STATE_FAILED,
	ISCSI_STATE_TERMINATE,
	ISCSI_STATE_IN_RECOVERY,
	ISCSI_STATE_RECOVERY_FAILED,
	ISCSI_STATE_LOGGING_OUT,
};

struct iscsi_session {
	struct iscsi_cls_session *cls_session;
	/*
	 * Syncs up the scsi eh thread with the iscsi eh thread when sending
	 * task management functions. This must be taken before the session
	 * and recv lock.
	 */
	struct mutex		eh_mutex;

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

	/* This tracks the reqs queued into the initiator */
	uint32_t		queued_cmdsn;

	/* configuration */
	int			abort_timeout;
	int			lu_reset_timeout;
	int			initial_r2t_en;
	unsigned		max_r2t;
	int			imm_data_en;
	unsigned		first_burst;
	unsigned		max_burst;
	int			time2wait;
	int			time2retain;
	int			pdu_inorder_en;
	int			dataseq_inorder_en;
	int			erl;
	int			fast_abort;
	int			tpgt;
	char			*username;
	char			*username_in;
	char			*password;
	char			*password_in;
	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           */
	int			age;		/* counts session re-opens */

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

struct iscsi_host {
	char			*initiatorname;
	/* hw address or netdev iscsi connection is bound to */
	char			*hwaddress;
	char			*netdev;
	/* local address */
	int			local_port;
	char			local_address[ISCSI_ADDRESS_BUF_LEN];
};

/*
 * 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_eh_device_reset(struct scsi_cmnd *sc);
extern int iscsi_queuecommand(struct scsi_cmnd *sc,
			      void (*done)(struct scsi_cmnd *));

/*
 * iSCSI host helpers.
 */
#define iscsi_host_priv(_shost) \
	(shost_priv(_shost) + sizeof(struct iscsi_host))

extern int iscsi_host_set_param(struct Scsi_Host *shost,
				enum iscsi_host_param param, char *buf,
				int buflen);
extern int iscsi_host_get_param(struct Scsi_Host *shost,
				enum iscsi_host_param param, char *buf);
extern int iscsi_host_add(struct Scsi_Host *shost, struct device *pdev);
extern struct Scsi_Host *iscsi_host_alloc(struct scsi_host_template *sht,
					  int dd_data_size, uint16_t qdepth);
extern void iscsi_host_remove(struct Scsi_Host *shost);
extern void iscsi_host_free(struct Scsi_Host *shost);

/*
 * session management
 */
extern struct iscsi_cls_session *
iscsi_session_setup(struct iscsi_transport *, struct Scsi_Host *shost,
		    uint16_t, int, int, uint32_t);
extern void iscsi_session_teardown(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 iscsi_session_printk(prefix, _sess, fmt, a...)	\
	iscsi_cls_session_printk(prefix, _sess->cls_session, fmt, ##a)

/*
 * connection management
 */
extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
					       int, 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);
extern void iscsi_suspend_tx(struct iscsi_conn *conn);

#define iscsi_conn_printk(prefix, _c, fmt, a...) \
	iscsi_cls_conn_printk(prefix, ((struct iscsi_conn *)_c)->cls_conn, \
			      fmt, ##a)

/*
 * pdu and task processing
 */
extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *);
extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
					struct iscsi_data *hdr);
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_verify_itt(struct iscsi_conn *, struct iscsi_hdr *,
			    uint32_t *);
extern void iscsi_requeue_ctask(struct iscsi_cmd_task *ctask);
extern void iscsi_free_mgmt_task(struct iscsi_conn *conn,
				 struct iscsi_mgmt_task *mtask);

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

/*
 * inline functions to deal with padding.
 */
static inline unsigned int
iscsi_padded(unsigned int len)
{
	return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1);
}

static inline unsigned int
iscsi_padding(unsigned int len)
{
	len &= (ISCSI_PAD_LEN - 1);
	if (len)
		len = ISCSI_PAD_LEN - len;
	return len;
}

#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>
40753caa	27	#include <linux/wait.h>
7996a778	28	#include <linux/mutex.h>
f6a57033 AV	29	#include <linux/timer.h>
f6a57033 AV	30	#include <linux/workqueue.h>
7996a778 MC	31	#include <scsi/iscsi_proto.h>
	32	#include <scsi/iscsi_if.h>
	33
	34	struct scsi_transport_template;
a4804cd6	35	struct scsi_host_template;
7996a778 MC	36	struct scsi_device;
	37	struct Scsi_Host;
	38	struct scsi_cmnd;
	39	struct socket;
	40	struct iscsi_transport;
	41	struct iscsi_cls_session;
	42	struct iscsi_cls_conn;
	43	struct iscsi_session;
	44	struct iscsi_nopin;
a4804cd6	45	struct device;
7996a778 MC	46
	47	/* #define DEBUG_SCSI */
	48	#ifdef DEBUG_SCSI
be2df72e	49	#define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
7996a778 MC	50	#else
	51	#define debug_scsi(fmt...)
	52	#endif
	53
1548271e MC	54	#define ISCSI_DEF_XMIT_CMDS_MAX 128 /* must be power of 2 */
1548271e MC	55	#define ISCSI_MGMT_CMDS_MAX 16 /* must be power of 2 */
7996a778 MC	56
	57	#define ISCSI_MGMT_ITT_OFFSET 0xa00
	58
	59	#define ISCSI_DEF_CMD_PER_LUN 32
	60	#define ISCSI_MAX_CMD_PER_LUN 128
	61
	62	/* Task Mgmt states */
843c0a8a MC	63	enum {
	64	TMF_INITIAL,
	65	TMF_QUEUED,
	66	TMF_SUCCESS,
	67	TMF_FAILED,
	68	TMF_TIMEDOUT,
	69	TMF_NOT_FOUND,
	70	};
7996a778 MC	71
	72	/* Connection suspend "bit" */
	73	#define ISCSI_SUSPEND_BIT 1
	74
	75	#define ISCSI_ITT_MASK (0xfff)
7996a778 MC	76	#define ISCSI_AGE_SHIFT 28
	77	#define ISCSI_AGE_MASK (0xf << ISCSI_AGE_SHIFT)
	78
22236961 MC	79	#define ISCSI_ADDRESS_BUF_LEN 64
22236961 MC	80
da32dd68	81	enum {
004d6530 BH	82	/* this is the maximum possible storage for AHSs */
	83	ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
	84	sizeof(struct iscsi_rlength_ahdr),
da32dd68 OK	85	ISCSI_DIGEST_SIZE = sizeof(__u32),
	86	};
	87
7996a778 MC	88	struct iscsi_mgmt_task {
	89	/*
	90	* Becuae LLDs allocate their hdr differently, this is a pointer to
	91	* that storage. It must be setup at session creation time.
	92	*/
	93	struct iscsi_hdr *hdr;
	94	char data; / mgmt payload */
857ae0bd	95	unsigned data_count; /* counts data to be sent */
7996a778 MC	96	uint32_t itt; /* this ITT */
	97	void dd_data; / driver/transport data */
	98	struct list_head running;
	99	};
	100
b6c395ed MC	101	enum {
	102	ISCSI_TASK_COMPLETED,
	103	ISCSI_TASK_PENDING,
	104	ISCSI_TASK_RUNNING,
	105	};
	106
7996a778 MC	107	struct iscsi_cmd_task {
7996a778 MC	108	/*
004d6530 BH	109	* Because LLDs allocate their hdr differently, this is a pointer
	110	* and length to that storage. It must be setup at session
	111	* creation time.
7996a778 MC	112	*/
7996a778 MC	113	struct iscsi_cmd *hdr;
004d6530 BH	114	unsigned short hdr_max;
004d6530 BH	115	unsigned short hdr_len; /* accumulated size of hdr used */
7996a778	116	int itt; /* this ITT */
7996a778 MC	117
7996a778 MC	118	uint32_t unsol_datasn;
857ae0bd MC	119	unsigned imm_count; /* imm-data (bytes) */
857ae0bd MC	120	unsigned unsol_count; /* unsolicited (bytes)*/
ffd0436e	121	/* offset in unsolicited stream (bytes); */
857ae0bd MC	122	unsigned unsol_offset;
857ae0bd MC	123	unsigned data_count; /* remaining Data-Out */
7996a778	124	struct scsi_cmnd sc; / associated SCSI cmd*/
7996a778	125	struct iscsi_conn conn; / used connection */
7996a778	126
b6c395ed MC	127	/* state set/tested under session->lock */
b6c395ed MC	128	int state;
60ecebf5	129	atomic_t refcount;
7996a778 MC	130	struct list_head running; /* running cmd list */
	131	void dd_data; / driver/transport data */
	132	};
	133
004d6530 BH	134	static inline void* iscsi_next_hdr(struct iscsi_cmd_task *ctask)
	135	{
	136	return (void*)ctask->hdr + ctask->hdr_len;
	137	}
	138
6eabafbe MC	139	/* Connection's states */
	140	enum {
	141	ISCSI_CONN_INITIAL_STAGE,
	142	ISCSI_CONN_STARTED,
	143	ISCSI_CONN_STOPPED,
	144	ISCSI_CONN_CLEANUP_WAIT,
	145	};
	146
7996a778 MC	147	struct iscsi_conn {
	148	struct iscsi_cls_conn cls_conn; / ptr to class connection */
	149	void dd_data; / iscsi_transport data */
	150	struct iscsi_session session; / parent session */
	151	/*
	152	* LLDs should set this lock. It protects the transport recv
	153	* code
	154	*/
	155	rwlock_t *recv_lock;
	156	/*
	157	* conn_stop() flag: stop to recover, stop to terminate
	158	*/
	159	int stop_stage;
f6d5180c MC	160	struct timer_list transport_timer;
	161	unsigned long last_recv;
	162	unsigned long last_ping;
	163	int ping_timeout;
	164	int recv_timeout;
	165	struct iscsi_mgmt_task *ping_mtask;
7996a778 MC	166
	167	/* iSCSI connection-wide sequencing */
	168	uint32_t exp_statsn;
	169
	170	/* control data */
	171	int id; /* CID */
7996a778	172	int c_stage; /* connection state */
c8dc1e52 MC	173	/*
	174	* Preallocated buffer for pdus that have data but do not
	175	* originate from scsi-ml. We never have two pdus using the
	176	* buffer at the same time. It is only allocated to
	177	* the default max recv size because the pdus we support
	178	* should always fit in this buffer
	179	*/
	180	char *data;
7996a778 MC	181	struct iscsi_mgmt_task login_mtask; / mtask used for login/text */
	182	struct iscsi_mgmt_task mtask; / xmit mtask in progress */
	183	struct iscsi_cmd_task ctask; / xmit ctask in progress */
	184
	185	/* xmit */
843c0a8a	186	struct list_head mgmtqueue; /* mgmt (control) xmit queue */
7996a778	187	struct list_head mgmt_run_list; /* list of control tasks */
b6c395ed	188	struct list_head xmitqueue; /* data-path cmd queue */
7996a778	189	struct list_head run_list; /* list of cmds in progress */
843c0a8a	190	struct list_head requeue; /* tasks needing another run */
7996a778	191	struct work_struct xmitwork; /* per-conn. xmit workqueue */
7996a778 MC	192	unsigned long suspend_tx; /* suspend Tx */
	193	unsigned long suspend_rx; /* suspend Rx */
	194
	195	/* abort */
	196	wait_queue_head_t ehwait; /* used in eh_abort() */
	197	struct iscsi_tm tmhdr;
843c0a8a MC	198	struct timer_list tmf_timer;
843c0a8a MC	199	int tmf_state; /* see TMF_INITIAL, etc.*/
7996a778 MC	200
7996a778 MC	201	/* negotiated params */
857ae0bd MC	202	unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
857ae0bd MC	203	unsigned max_xmit_dlength; /* target_max_recv_dsl */
7996a778 MC	204	int hdrdgst_en;
7996a778 MC	205	int datadgst_en;
a54a52ca MC	206	int ifmarker_en;
	207	int ofmarker_en;
	208	/* values userspace uses to id a conn */
	209	int persistent_port;
	210	char *persistent_address;
22236961 MC	211	/* remote portal currently connected to */
	212	int portal_port;
	213	char portal_address[ISCSI_ADDRESS_BUF_LEN];
7996a778 MC	214
	215	/* MIB-statistics */
	216	uint64_t txdata_octets;
	217	uint64_t rxdata_octets;
	218	uint32_t scsicmd_pdus_cnt;
	219	uint32_t dataout_pdus_cnt;
	220	uint32_t scsirsp_pdus_cnt;
	221	uint32_t datain_pdus_cnt;
	222	uint32_t r2t_pdus_cnt;
	223	uint32_t tmfcmd_pdus_cnt;
	224	int32_t tmfrsp_pdus_cnt;
	225
	226	/* custom statistics */
	227	uint32_t eh_abort_cnt;
87528227	228	uint32_t fmr_unalign_cnt;
7996a778 MC	229	};
7996a778 MC	230
6320377f	231	struct iscsi_pool {
7996a778 MC	232	struct kfifo queue; / FIFO Queue */
	233	void *pool; / Pool of elements */
	234	int max; /* Max number of elements */
	235	};
	236
6eabafbe MC	237	/* Session's states */
	238	enum {
	239	ISCSI_STATE_FREE = 1,
	240	ISCSI_STATE_LOGGED_IN,
	241	ISCSI_STATE_FAILED,
	242	ISCSI_STATE_TERMINATE,
	243	ISCSI_STATE_IN_RECOVERY,
	244	ISCSI_STATE_RECOVERY_FAILED,
	245	ISCSI_STATE_LOGGING_OUT,
	246	};
	247
7996a778	248	struct iscsi_session {
75613521	249	struct iscsi_cls_session *cls_session;
6724add1 MC	250	/*
	251	* Syncs up the scsi eh thread with the iscsi eh thread when sending
	252	* task management functions. This must be taken before the session
	253	* and recv lock.
	254	*/
	255	struct mutex eh_mutex;
	256
7996a778 MC	257	/* iSCSI session-wide sequencing */
	258	uint32_t cmdsn;
	259	uint32_t exp_cmdsn;
	260	uint32_t max_cmdsn;
	261
e0726407 MC	262	/* This tracks the reqs queued into the initiator */
	263	uint32_t queued_cmdsn;
	264
7996a778	265	/* configuration */
f6d5180c MC	266	int abort_timeout;
f6d5180c MC	267	int lu_reset_timeout;
7996a778	268	int initial_r2t_en;
857ae0bd	269	unsigned max_r2t;
7996a778	270	int imm_data_en;
857ae0bd MC	271	unsigned first_burst;
857ae0bd MC	272	unsigned max_burst;
7996a778 MC	273	int time2wait;
	274	int time2retain;
	275	int pdu_inorder_en;
	276	int dataseq_inorder_en;
	277	int erl;
843c0a8a	278	int fast_abort;
a54a52ca	279	int tpgt;
b2c64167 MC	280	char *username;
	281	char *username_in;
	282	char *password;
	283	char *password_in;
a54a52ca	284	char *targetname;
7996a778 MC	285	/* control data */
	286	struct iscsi_transport *tt;
	287	struct Scsi_Host *host;
	288	struct iscsi_conn leadconn; / leading connection */
	289	spinlock_t lock; /* protects session state, *
	290	* sequence numbers, *
	291	* session resources: *
	292	* - cmdpool, *
	293	* - mgmtpool, *
	294	* - r2tpool */
	295	int state; /* session state */
7996a778 MC	296	int age; /* counts session re-opens */
7996a778 MC	297
7996a778 MC	298	int cmds_max; /* size of cmds array */
7996a778 MC	299	struct iscsi_cmd_task *cmds; / Original Cmds arr */
6320377f	300	struct iscsi_pool cmdpool; /* PDU's pool */
7996a778 MC	301	int mgmtpool_max; /* size of mgmt array */
7996a778 MC	302	struct iscsi_mgmt_task *mgmt_cmds; / Original mgmt arr */
6320377f	303	struct iscsi_pool mgmtpool; /* Mgmt PDU's pool */
7996a778 MC	304	};
7996a778 MC	305
75613521 MC	306	struct iscsi_host {
	307	char *initiatorname;
	308	/* hw address or netdev iscsi connection is bound to */
	309	char *hwaddress;
	310	char *netdev;
	311	/* local address */
	312	int local_port;
	313	char local_address[ISCSI_ADDRESS_BUF_LEN];
	314	};
	315
7996a778 MC	316	/*
	317	* scsi host template
	318	*/
	319	extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
	320	extern int iscsi_eh_abort(struct scsi_cmnd *sc);
	321	extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
843c0a8a	322	extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
7996a778 MC	323	extern int iscsi_queuecommand(struct scsi_cmnd *sc,
7996a778 MC	324	void (done)(struct scsi_cmnd ));
0801c242	325
0801c242 MC	326	/*
	327	* iSCSI host helpers.
	328	*/
5d91e209 MC	329	#define iscsi_host_priv(_shost) \
	330	(shost_priv(_shost) + sizeof(struct iscsi_host))
	331
0801c242 MC	332	extern int iscsi_host_set_param(struct Scsi_Host *shost,
	333	enum iscsi_host_param param, char *buf,
	334	int buflen);
	335	extern int iscsi_host_get_param(struct Scsi_Host *shost,
	336	enum iscsi_host_param param, char *buf);
a4804cd6 MC	337	extern int iscsi_host_add(struct Scsi_Host shost, struct device pdev);
	338	extern struct Scsi_Host iscsi_host_alloc(struct scsi_host_template sht,
	339	int dd_data_size, uint16_t qdepth);
	340	extern void iscsi_host_remove(struct Scsi_Host *shost);
	341	extern void iscsi_host_free(struct Scsi_Host *shost);
7996a778 MC	342
	343	/*
	344	* session management
	345	*/
	346	extern struct iscsi_cls_session *
75613521 MC	347	iscsi_session_setup(struct iscsi_transport , struct Scsi_Host shost,
75613521 MC	348	uint16_t, int, int, uint32_t);
7996a778	349	extern void iscsi_session_teardown(struct iscsi_cls_session *);
7996a778	350	extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
a54a52ca MC	351	extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
	352	enum iscsi_param param, char *buf, int buflen);
	353	extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
	354	enum iscsi_param param, char *buf);
7996a778	355
322d739d	356	#define iscsi_session_printk(prefix, _sess, fmt, a...) \
75613521	357	iscsi_cls_session_printk(prefix, _sess->cls_session, fmt, ##a)
322d739d	358
7996a778 MC	359	/*
	360	* connection management
	361	*/
	362	extern struct iscsi_cls_conn iscsi_conn_setup(struct iscsi_cls_session ,
5d91e209	363	int, uint32_t);
7996a778 MC	364	extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
	365	extern int iscsi_conn_start(struct iscsi_cls_conn *);
	366	extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
	367	extern int iscsi_conn_bind(struct iscsi_cls_session , struct iscsi_cls_conn ,
	368	int);
	369	extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
a54a52ca MC	370	extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
a54a52ca MC	371	enum iscsi_param param, char *buf);
5af3e91d	372	extern void iscsi_suspend_tx(struct iscsi_conn *conn);
7996a778	373
322d739d	374	#define iscsi_conn_printk(prefix, _c, fmt, a...) \
5af3e91d MC	375	iscsi_cls_conn_printk(prefix, ((struct iscsi_conn *)_c)->cls_conn, \
5af3e91d MC	376	fmt, ##a)
322d739d	377
7996a778 MC	378	/*
	379	* pdu and task processing
	380	*/
77a23c21	381	extern void iscsi_update_cmdsn(struct iscsi_session , struct iscsi_nopin );
7996a778	382	extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
ffd0436e	383	struct iscsi_data *hdr);
7996a778 MC	384	extern int iscsi_conn_send_pdu(struct iscsi_cls_conn , struct iscsi_hdr ,
	385	char *, uint32_t);
	386	extern int iscsi_complete_pdu(struct iscsi_conn , struct iscsi_hdr ,
	387	char *, int);
7996a778 MC	388	extern int iscsi_verify_itt(struct iscsi_conn , struct iscsi_hdr ,
7996a778 MC	389	uint32_t *);
843c0a8a	390	extern void iscsi_requeue_ctask(struct iscsi_cmd_task *ctask);
b3a7ea8d MC	391	extern void iscsi_free_mgmt_task(struct iscsi_conn *conn,
b3a7ea8d MC	392	struct iscsi_mgmt_task *mtask);
7996a778 MC	393
	394	/*
	395	* generic helpers
	396	*/
6320377f OK	397	extern void iscsi_pool_free(struct iscsi_pool *);
6320377f OK	398	extern int iscsi_pool_init(struct iscsi_pool , int, void **, int);
7996a778	399
004d6530 BH	400	/*
	401	* inline functions to deal with padding.
	402	*/
	403	static inline unsigned int
	404	iscsi_padded(unsigned int len)
	405	{
	406	return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1);
	407	}
	408
	409	static inline unsigned int
	410	iscsi_padding(unsigned int len)
	411	{
	412	len &= (ISCSI_PAD_LEN - 1);
	413	if (len)
	414	len = ISCSI_PAD_LEN - len;
	415	return len;
	416	}
	417
7996a778	418	#endif