[linux-2.6-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>
#include <scsi/scsi_transport_iscsi.h>

struct scsi_transport_template;
struct scsi_host_template;
struct scsi_device;
struct Scsi_Host;
struct scsi_target;
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 ISCSI_DEF_XMIT_CMDS_MAX	128	/* must be power of 2 */
#define ISCSI_MGMT_CMDS_MAX	15

#define ISCSI_DEF_CMD_PER_LUN	32

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

#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_FREE,
	ISCSI_TASK_COMPLETED,
	ISCSI_TASK_PENDING,
	ISCSI_TASK_RUNNING,
	ISCSI_TASK_ABRT_TMF,		/* aborted due to TMF */
	ISCSI_TASK_ABRT_SESS_RECOV,	/* aborted due to session recovery */
};

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

	/* data processing tracking */
	unsigned long		last_xfer;
	unsigned long		last_timeout;
	bool			have_checked_conn;
	/* 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	cmdqueue;	/* data-path cmd queue */
	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			tgt_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 */
	void			*dd_data;	/* LLD private data */
};

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;

	struct workqueue_struct	*workq;
	char			workq_name[20];
};

/*
 * scsi host template
 */
extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth,
				    int reason);
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,
					  bool xmit_can_sleep);
extern void iscsi_host_remove(struct Scsi_Host *shost);
extern void iscsi_host_free(struct Scsi_Host *shost);
extern int iscsi_target_alloc(struct scsi_target *starget);

/*
 * session management
 */
extern struct iscsi_cls_session *
iscsi_session_setup(struct iscsi_transport *, struct Scsi_Host *shost,
		    uint16_t, int, 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_session *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);
extern void iscsi_suspend_queue(struct iscsi_conn *conn);
extern void iscsi_conn_queue_work(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 struct iscsi_task *iscsi_itt_to_task(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);
extern void iscsi_complete_scsi_task(struct iscsi_task *task,
				     uint32_t exp_cmdsn, uint32_t max_cmdsn);

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