[linux-block.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	15

#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			(0x1fff)
#define ISCSI_TOTAL_CMDS_MAX		4096
/* this must be a power of two greater than ISCSI_MGMT_CMDS_MAX */
#define ISCSI_TOTAL_CMDS_MIN		16
#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),
};


enum {
	ISCSI_TASK_COMPLETED,
	ISCSI_TASK_PENDING,
	ISCSI_TASK_RUNNING,
};

struct iscsi_r2t_info {
	__be32			ttt;		/* copied from R2T */
	__be32			exp_statsn;	/* copied from R2T */
	uint32_t		data_length;	/* copied from R2T */
	uint32_t		data_offset;	/* copied from R2T */
	int			data_count;	/* DATA-Out payload progress */
	int			datasn;
	/* LLDs should set/update these values */
	int			sent;		/* R2T sequence progress */
};

struct iscsi_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_hdr	*hdr;
	unsigned short		hdr_max;
	unsigned short		hdr_len;	/* accumulated size of hdr used */
	/* copied values in case we need to send tmfs */
	itt_t			hdr_itt;
	__be32			cmdsn;
	uint8_t			lun[8];

	int			itt;		/* this ITT */

	unsigned		imm_count;	/* imm-data (bytes)   */
	/* offset in unsolicited stream (bytes); */
	struct iscsi_r2t_info	unsol_r2t;
	char			*data;		/* mgmt payload */
	unsigned		data_count;
	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 int iscsi_task_has_unsol_data(struct iscsi_task *task)
{
	return task->unsol_r2t.data_length > task->unsol_r2t.sent;
}

static inline void* iscsi_next_hdr(struct iscsi_task *task)
{
	return (void*)task->hdr + task->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 */
	/*
	 * 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_task 	*ping_task;

	/* 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_task 	*login_task;	/* mtask used for login/text */
	struct iscsi_task	*task;		/* xmit task 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;
	char			*ifacename;
	char			*initiatorname;
	/* 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			scsi_cmds_max; 	/* max scsi commands */
	int			cmds_max;	/* size of cmds array */
	struct iscsi_task	**cmds;		/* Original Cmds arr */
	struct iscsi_pool	cmdpool;	/* PDU's pool */
};

enum {
	ISCSI_HOST_SETUP,
	ISCSI_HOST_REMOVED,
};

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];

	wait_queue_head_t	session_removal_wq;
	/* protects sessions and state */
	spinlock_t		lock;
	int			num_sessions;
	int			state;
};

/*
 * 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_target_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, uint32_t, unsigned int);
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 void iscsi_session_failure(struct iscsi_cls_session *cls_session,
				  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_data_out_pdu(struct iscsi_task *task,
				    struct iscsi_r2t_info *r2t,
				    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_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
				char *, int);
extern int iscsi_verify_itt(struct iscsi_conn *, itt_t);
extern struct iscsi_task *iscsi_itt_to_ctask(struct iscsi_conn *, itt_t);
extern void iscsi_requeue_task(struct iscsi_task *task);
extern void iscsi_put_task(struct iscsi_task *task);
extern void __iscsi_get_task(struct iscsi_task *task);

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