[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 <linux/kfifo.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,
};

#define ISID_SIZE			6

/* 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 */
	ISCSI_TASK_REQUEUE_SCSIQ,	/* qcmd requeueing to scsi-ml */
};

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;
	struct scsi_lun		lun;

	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;

	/* T10 protection information */
	bool			protected;

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

	unsigned		max_segment_size;
	unsigned		tcp_xmit_wsf;
	unsigned		tcp_recv_wsf;
	uint16_t		keepalive_tmo;
	uint16_t		local_port;
	uint8_t			tcp_timestamp_stat;
	uint8_t			tcp_nagle_disable;
	uint8_t			tcp_wsf_disable;
	uint8_t			tcp_timer_scale;
	uint8_t			tcp_timestamp_en;
	uint8_t			fragment_disable;
	uint8_t			ipv4_tos;
	uint8_t			ipv6_traffic_class;
	uint8_t			ipv6_flow_label;
	uint8_t			is_fw_assigned_ipv6;
	char			*local_ipaddr;

	/* 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 short		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			*targetalias;
	char			*ifacename;
	char			*initiatorname;
	char			*boot_root;
	char			*boot_nic;
	char			*boot_target;
	char			*portal_type;
	char			*discovery_parent_type;
	uint16_t		discovery_parent_idx;
	uint16_t		def_taskmgmt_tmo;
	uint16_t		tsid;
	uint8_t			auto_snd_tgt_disable;
	uint8_t			discovery_sess;
	uint8_t			chap_auth_en;
	uint8_t			discovery_logout_en;
	uint8_t			bidi_chap_en;
	uint8_t			discovery_auth_optional;
	uint8_t			isid[ISID_SIZE];

	/* control data */
	struct iscsi_transport	*tt;
	struct Scsi_Host	*host;
	struct iscsi_conn	*leadconn;	/* leading connection */
	/* Between the forward and the backward locks exists a strict locking
	 * hierarchy. The mutual exclusion zone protected by the forward lock
	 * can enclose the mutual exclusion zone protected by the backward lock
	 * but not vice versa.
	 */
	spinlock_t		frwd_lock;	/* protects session state, *
						 * cmdsn, queued_cmdsn     *
						 * session resources:      *
						 * - cmdpool kfifo_out ,   *
						 * - mgmtpool,		   */
	spinlock_t		back_lock;	/* protects cmdsn_exp      *
						 * cmdsn_max,              *
						 * cmdpool kfifo_in        */
	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;

	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_eh_abort(struct scsi_cmnd *sc);
extern int iscsi_eh_recover_target(struct scsi_cmnd *sc);
extern int iscsi_eh_session_reset(struct scsi_cmnd *sc);
extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
extern int iscsi_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *sc);

/*
 * 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 int iscsi_conn_get_addr_param(struct sockaddr_storage *addr,
				     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_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);
extern int iscsi_switch_str_param(char **, char *);

/*
 * 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>
45465487	31	#include <linux/kfifo.h>
7996a778 MC	32	#include <scsi/iscsi_proto.h>
7996a778 MC	33	#include <scsi/iscsi_if.h>
262ef636	34	#include <scsi/scsi_transport_iscsi.h>
7996a778 MC	35
7996a778 MC	36	struct scsi_transport_template;
a4804cd6	37	struct scsi_host_template;
7996a778 MC	38	struct scsi_device;
7996a778 MC	39	struct Scsi_Host;
6b5d6c44	40	struct scsi_target;
7996a778 MC	41	struct scsi_cmnd;
	42	struct socket;
	43	struct iscsi_transport;
	44	struct iscsi_cls_session;
	45	struct iscsi_cls_conn;
	46	struct iscsi_session;
	47	struct iscsi_nopin;
a4804cd6	48	struct device;
7996a778	49
1548271e	50	#define ISCSI_DEF_XMIT_CMDS_MAX 128 /* must be power of 2 */
3cf7b233	51	#define ISCSI_MGMT_CMDS_MAX 15
7996a778	52
e28f3d5b	53	#define ISCSI_DEF_CMD_PER_LUN 32
7996a778 MC	54
7996a778 MC	55	/* Task Mgmt states */
843c0a8a MC	56	enum {
	57	TMF_INITIAL,
	58	TMF_QUEUED,
	59	TMF_SUCCESS,
	60	TMF_FAILED,
	61	TMF_TIMEDOUT,
	62	TMF_NOT_FOUND,
	63	};
7996a778	64
f8525eb4 AC	65	#define ISID_SIZE 6
f8525eb4 AC	66
7996a778 MC	67	/* Connection suspend "bit" */
	68	#define ISCSI_SUSPEND_BIT 1
	69
262ef636	70	#define ISCSI_ITT_MASK 0x1fff
3cf7b233 MC	71	#define ISCSI_TOTAL_CMDS_MAX 4096
	72	/* this must be a power of two greater than ISCSI_MGMT_CMDS_MAX */
	73	#define ISCSI_TOTAL_CMDS_MIN 16
7996a778	74	#define ISCSI_AGE_SHIFT 28
262ef636	75	#define ISCSI_AGE_MASK 0xf
7996a778	76
22236961 MC	77	#define ISCSI_ADDRESS_BUF_LEN 64
22236961 MC	78
da32dd68	79	enum {
004d6530 BH	80	/* this is the maximum possible storage for AHSs */
	81	ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
	82	sizeof(struct iscsi_rlength_ahdr),
da32dd68 OK	83	ISCSI_DIGEST_SIZE = sizeof(__u32),
	84	};
	85
7996a778	86
b6c395ed	87	enum {
3bbaaad9	88	ISCSI_TASK_FREE,
b6c395ed MC	89	ISCSI_TASK_COMPLETED,
	90	ISCSI_TASK_PENDING,
	91	ISCSI_TASK_RUNNING,
b3cd5050 MC	92	ISCSI_TASK_ABRT_TMF, /* aborted due to TMF */
b3cd5050 MC	93	ISCSI_TASK_ABRT_SESS_RECOV, /* aborted due to session recovery */
f41d4721	94	ISCSI_TASK_REQUEUE_SCSIQ, /* qcmd requeueing to scsi-ml */
b6c395ed MC	95	};
b6c395ed MC	96
577577da MC	97	struct iscsi_r2t_info {
	98	__be32 ttt; /* copied from R2T */
	99	__be32 exp_statsn; /* copied from R2T */
	100	uint32_t data_length; /* copied from R2T */
	101	uint32_t data_offset; /* copied from R2T */
	102	int data_count; /* DATA-Out payload progress */
	103	int datasn;
	104	/* LLDs should set/update these values */
	105	int sent; /* R2T sequence progress */
	106	};
	107
9c19a7d0	108	struct iscsi_task {
7996a778	109	/*
004d6530 BH	110	* Because LLDs allocate their hdr differently, this is a pointer
	111	* and length to that storage. It must be setup at session
	112	* creation time.
7996a778	113	*/
577577da	114	struct iscsi_hdr *hdr;
004d6530 BH	115	unsigned short hdr_max;
004d6530 BH	116	unsigned short hdr_len; /* accumulated size of hdr used */
577577da MC	117	/* copied values in case we need to send tmfs */
	118	itt_t hdr_itt;
	119	__be32 cmdsn;
516f43a2	120	struct scsi_lun lun;
577577da	121
7996a778	122	int itt; /* this ITT */
7996a778	123
857ae0bd	124	unsigned imm_count; /* imm-data (bytes) */
ffd0436e	125	/* offset in unsolicited stream (bytes); */
577577da	126	struct iscsi_r2t_info unsol_r2t;
3e5c28ad	127	char data; / mgmt payload */
577577da	128	unsigned data_count;
7996a778	129	struct scsi_cmnd sc; / associated SCSI cmd*/
7996a778	130	struct iscsi_conn conn; / used connection */
7996a778	131
d355e57d MC	132	/* data processing tracking */
	133	unsigned long last_xfer;
	134	unsigned long last_timeout;
	135	bool have_checked_conn;
55e51eda SG	136
	137	/* T10 protection information */
	138	bool protected;
	139
b6c395ed MC	140	/* state set/tested under session->lock */
b6c395ed MC	141	int state;
60ecebf5	142	atomic_t refcount;
7996a778 MC	143	struct list_head running; /* running cmd list */
	144	void dd_data; / driver/transport data */
	145	};
	146
577577da MC	147	static inline int iscsi_task_has_unsol_data(struct iscsi_task *task)
	148	{
	149	return task->unsol_r2t.data_length > task->unsol_r2t.sent;
	150	}
	151
9c19a7d0	152	static inline void* iscsi_next_hdr(struct iscsi_task *task)
004d6530	153	{
9c19a7d0	154	return (void*)task->hdr + task->hdr_len;
004d6530 BH	155	}
004d6530 BH	156
6eabafbe MC	157	/* Connection's states */
	158	enum {
	159	ISCSI_CONN_INITIAL_STAGE,
	160	ISCSI_CONN_STARTED,
	161	ISCSI_CONN_STOPPED,
	162	ISCSI_CONN_CLEANUP_WAIT,
	163	};
	164
7996a778 MC	165	struct iscsi_conn {
	166	struct iscsi_cls_conn cls_conn; / ptr to class connection */
	167	void dd_data; / iscsi_transport data */
	168	struct iscsi_session session; / parent session */
7996a778 MC	169	/*
	170	* conn_stop() flag: stop to recover, stop to terminate
	171	*/
	172	int stop_stage;
f6d5180c MC	173	struct timer_list transport_timer;
	174	unsigned long last_recv;
	175	unsigned long last_ping;
	176	int ping_timeout;
	177	int recv_timeout;
9c19a7d0	178	struct iscsi_task *ping_task;
7996a778 MC	179
	180	/* iSCSI connection-wide sequencing */
	181	uint32_t exp_statsn;
f8525eb4	182	uint32_t statsn;
7996a778 MC	183
	184	/* control data */
	185	int id; /* CID */
7996a778	186	int c_stage; /* connection state */
c8dc1e52 MC	187	/*
	188	* Preallocated buffer for pdus that have data but do not
	189	* originate from scsi-ml. We never have two pdus using the
	190	* buffer at the same time. It is only allocated to
	191	* the default max recv size because the pdus we support
	192	* should always fit in this buffer
	193	*/
	194	char *data;
9c19a7d0 MC	195	struct iscsi_task login_task; / mtask used for login/text */
9c19a7d0 MC	196	struct iscsi_task task; / xmit task in progress */
7996a778 MC	197
7996a778 MC	198	/* xmit */
843c0a8a	199	struct list_head mgmtqueue; /* mgmt (control) xmit queue */
3bbaaad9	200	struct list_head cmdqueue; /* data-path cmd queue */
843c0a8a	201	struct list_head requeue; /* tasks needing another run */
7996a778	202	struct work_struct xmitwork; /* per-conn. xmit workqueue */
7996a778 MC	203	unsigned long suspend_tx; /* suspend Tx */
	204	unsigned long suspend_rx; /* suspend Rx */
	205
	206	/* abort */
	207	wait_queue_head_t ehwait; /* used in eh_abort() */
	208	struct iscsi_tm tmhdr;
843c0a8a MC	209	struct timer_list tmf_timer;
843c0a8a MC	210	int tmf_state; /* see TMF_INITIAL, etc.*/
7996a778 MC	211
7996a778 MC	212	/* negotiated params */
857ae0bd MC	213	unsigned max_recv_dlength; /* initiator_max_recv_dsl*/
857ae0bd MC	214	unsigned max_xmit_dlength; /* target_max_recv_dsl */
7996a778 MC	215	int hdrdgst_en;
7996a778 MC	216	int datadgst_en;
a54a52ca MC	217	int ifmarker_en;
	218	int ofmarker_en;
	219	/* values userspace uses to id a conn */
	220	int persistent_port;
	221	char *persistent_address;
7996a778	222
f8525eb4 AC	223	unsigned max_segment_size;
	224	unsigned tcp_xmit_wsf;
	225	unsigned tcp_recv_wsf;
	226	uint16_t keepalive_tmo;
	227	uint16_t local_port;
	228	uint8_t tcp_timestamp_stat;
	229	uint8_t tcp_nagle_disable;
	230	uint8_t tcp_wsf_disable;
	231	uint8_t tcp_timer_scale;
	232	uint8_t tcp_timestamp_en;
	233	uint8_t fragment_disable;
	234	uint8_t ipv4_tos;
	235	uint8_t ipv6_traffic_class;
	236	uint8_t ipv6_flow_label;
	237	uint8_t is_fw_assigned_ipv6;
ae56ff40	238	char *local_ipaddr;
f8525eb4	239
7996a778 MC	240	/* MIB-statistics */
	241	uint64_t txdata_octets;
	242	uint64_t rxdata_octets;
	243	uint32_t scsicmd_pdus_cnt;
	244	uint32_t dataout_pdus_cnt;
	245	uint32_t scsirsp_pdus_cnt;
	246	uint32_t datain_pdus_cnt;
	247	uint32_t r2t_pdus_cnt;
	248	uint32_t tmfcmd_pdus_cnt;
	249	int32_t tmfrsp_pdus_cnt;
	250
	251	/* custom statistics */
	252	uint32_t eh_abort_cnt;
87528227	253	uint32_t fmr_unalign_cnt;
7996a778 MC	254	};
7996a778 MC	255
6320377f	256	struct iscsi_pool {
45465487	257	struct kfifo queue; /* FIFO Queue */
7996a778 MC	258	void *pool; / Pool of elements */
	259	int max; /* Max number of elements */
	260	};
	261
6eabafbe MC	262	/* Session's states */
	263	enum {
	264	ISCSI_STATE_FREE = 1,
	265	ISCSI_STATE_LOGGED_IN,
	266	ISCSI_STATE_FAILED,
	267	ISCSI_STATE_TERMINATE,
	268	ISCSI_STATE_IN_RECOVERY,
	269	ISCSI_STATE_RECOVERY_FAILED,
	270	ISCSI_STATE_LOGGING_OUT,
	271	};
	272
7996a778	273	struct iscsi_session {
75613521	274	struct iscsi_cls_session *cls_session;
6724add1 MC	275	/*
	276	* Syncs up the scsi eh thread with the iscsi eh thread when sending
	277	* task management functions. This must be taken before the session
	278	* and recv lock.
	279	*/
	280	struct mutex eh_mutex;
	281
7996a778 MC	282	/* iSCSI session-wide sequencing */
	283	uint32_t cmdsn;
	284	uint32_t exp_cmdsn;
	285	uint32_t max_cmdsn;
	286
e0726407 MC	287	/* This tracks the reqs queued into the initiator */
	288	uint32_t queued_cmdsn;
	289
7996a778	290	/* configuration */
f6d5180c MC	291	int abort_timeout;
f6d5180c MC	292	int lu_reset_timeout;
3fe5ae8b	293	int tgt_reset_timeout;
7996a778	294	int initial_r2t_en;
1304be5f	295	unsigned short max_r2t;
7996a778	296	int imm_data_en;
857ae0bd MC	297	unsigned first_burst;
857ae0bd MC	298	unsigned max_burst;
7996a778 MC	299	int time2wait;
	300	int time2retain;
	301	int pdu_inorder_en;
	302	int dataseq_inorder_en;
	303	int erl;
843c0a8a	304	int fast_abort;
a54a52ca	305	int tpgt;
b2c64167 MC	306	char *username;
	307	char *username_in;
	308	char *password;
	309	char *password_in;
a54a52ca	310	char *targetname;
3c5c4801	311	char *targetalias;
88dfd340 MC	312	char *ifacename;
88dfd340 MC	313	char *initiatorname;
3b9373e9 EW	314	char *boot_root;
	315	char *boot_nic;
	316	char *boot_target;
f8525eb4 AC	317	char *portal_type;
	318	char *discovery_parent_type;
	319	uint16_t discovery_parent_idx;
	320	uint16_t def_taskmgmt_tmo;
	321	uint16_t tsid;
	322	uint8_t auto_snd_tgt_disable;
	323	uint8_t discovery_sess;
	324	uint8_t chap_auth_en;
	325	uint8_t discovery_logout_en;
	326	uint8_t bidi_chap_en;
	327	uint8_t discovery_auth_optional;
	328	uint8_t isid[ISID_SIZE];
3b9373e9	329
7996a778 MC	330	/* control data */
	331	struct iscsi_transport *tt;
	332	struct Scsi_Host *host;
	333	struct iscsi_conn leadconn; / leading connection */
659743b0 SP	334	/* Between the forward and the backward locks exists a strict locking
	335	* hierarchy. The mutual exclusion zone protected by the forward lock
	336	* can enclose the mutual exclusion zone protected by the backward lock
	337	* but not vice versa.
	338	*/
	339	spinlock_t frwd_lock; /* protects session state, *
	340	* cmdsn, queued_cmdsn *
7996a778	341	* session resources: *
659743b0 SP	342	* - cmdpool kfifo_out , *
	343	* - mgmtpool, */
	344	spinlock_t back_lock; /* protects cmdsn_exp *
	345	* cmdsn_max, *
	346	* cmdpool kfifo_in */
7996a778	347	int state; /* session state */
7996a778 MC	348	int age; /* counts session re-opens */
7996a778 MC	349
3e5c28ad	350	int scsi_cmds_max; /* max scsi commands */
7996a778	351	int cmds_max; /* size of cmds array */
9c19a7d0	352	struct iscsi_task *cmds; / Original Cmds arr */
6320377f	353	struct iscsi_pool cmdpool; /* PDU's pool */
b8b9e1b8	354	void dd_data; / LLD private data */
7996a778 MC	355	};
7996a778 MC	356
e5bd7b54 MC	357	enum {
	358	ISCSI_HOST_SETUP,
	359	ISCSI_HOST_REMOVED,
	360	};
	361
75613521 MC	362	struct iscsi_host {
	363	char *initiatorname;
	364	/* hw address or netdev iscsi connection is bound to */
	365	char *hwaddress;
	366	char *netdev;
e5bd7b54 MC	367
	368	wait_queue_head_t session_removal_wq;
	369	/* protects sessions and state */
	370	spinlock_t lock;
	371	int num_sessions;
	372	int state;
32ae763e MC	373
	374	struct workqueue_struct *workq;
	375	char workq_name[20];
75613521 MC	376	};
75613521 MC	377
7996a778 MC	378	/*
	379	* scsi host template
	380	*/
7996a778	381	extern int iscsi_eh_abort(struct scsi_cmnd *sc);
309ce156 JK	382	extern int iscsi_eh_recover_target(struct scsi_cmnd *sc);
309ce156 JK	383	extern int iscsi_eh_session_reset(struct scsi_cmnd *sc);
843c0a8a	384	extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
f41d4721	385	extern int iscsi_queuecommand(struct Scsi_Host host, struct scsi_cmnd sc);
0801c242	386
0801c242 MC	387	/*
	388	* iSCSI host helpers.
	389	*/
5d91e209 MC	390	#define iscsi_host_priv(_shost) \
	391	(shost_priv(_shost) + sizeof(struct iscsi_host))
	392
0801c242 MC	393	extern int iscsi_host_set_param(struct Scsi_Host *shost,
	394	enum iscsi_host_param param, char *buf,
	395	int buflen);
	396	extern int iscsi_host_get_param(struct Scsi_Host *shost,
	397	enum iscsi_host_param param, char *buf);
a4804cd6 MC	398	extern int iscsi_host_add(struct Scsi_Host shost, struct device pdev);
a4804cd6 MC	399	extern struct Scsi_Host iscsi_host_alloc(struct scsi_host_template sht,
4d108350	400	int dd_data_size,
32ae763e	401	bool xmit_can_sleep);
a4804cd6 MC	402	extern void iscsi_host_remove(struct Scsi_Host *shost);
a4804cd6 MC	403	extern void iscsi_host_free(struct Scsi_Host *shost);
6b5d6c44	404	extern int iscsi_target_alloc(struct scsi_target *starget);
7996a778 MC	405
	406	/*
	407	* session management
	408	*/
	409	extern struct iscsi_cls_session *
75613521	410	iscsi_session_setup(struct iscsi_transport , struct Scsi_Host shost,
b8b9e1b8	411	uint16_t, int, int, uint32_t, unsigned int);
7996a778	412	extern void iscsi_session_teardown(struct iscsi_cls_session *);
7996a778	413	extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
a54a52ca MC	414	extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
	415	enum iscsi_param param, char *buf, int buflen);
	416	extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
	417	enum iscsi_param param, char *buf);
7996a778	418
322d739d	419	#define iscsi_session_printk(prefix, _sess, fmt, a...) \
75613521	420	iscsi_cls_session_printk(prefix, _sess->cls_session, fmt, ##a)
322d739d	421
7996a778 MC	422	/*
	423	* connection management
	424	*/
	425	extern struct iscsi_cls_conn iscsi_conn_setup(struct iscsi_cls_session ,
5d91e209	426	int, uint32_t);
7996a778 MC	427	extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
	428	extern int iscsi_conn_start(struct iscsi_cls_conn *);
	429	extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
	430	extern int iscsi_conn_bind(struct iscsi_cls_session , struct iscsi_cls_conn ,
	431	int);
	432	extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
40a06e75	433	extern void iscsi_session_failure(struct iscsi_session *session,
e5bd7b54	434	enum iscsi_err err);
a54a52ca MC	435	extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
a54a52ca MC	436	enum iscsi_param param, char *buf);
00f3708e MC	437	extern int iscsi_conn_get_addr_param(struct sockaddr_storage *addr,
00f3708e MC	438	enum iscsi_param param, char *buf);
5af3e91d	439	extern void iscsi_suspend_tx(struct iscsi_conn *conn);
661134ad	440	extern void iscsi_suspend_queue(struct iscsi_conn *conn);
32ae763e	441	extern void iscsi_conn_queue_work(struct iscsi_conn *conn);
7996a778	442
322d739d	443	#define iscsi_conn_printk(prefix, _c, fmt, a...) \
5af3e91d MC	444	iscsi_cls_conn_printk(prefix, ((struct iscsi_conn *)_c)->cls_conn, \
5af3e91d MC	445	fmt, ##a)
322d739d	446
7996a778 MC	447	/*
	448	* pdu and task processing
	449	*/
77a23c21	450	extern void iscsi_update_cmdsn(struct iscsi_session , struct iscsi_nopin );
577577da MC	451	extern void iscsi_prep_data_out_pdu(struct iscsi_task *task,
	452	struct iscsi_r2t_info *r2t,
	453	struct iscsi_data *hdr);
7996a778 MC	454	extern int iscsi_conn_send_pdu(struct iscsi_cls_conn , struct iscsi_hdr ,
	455	char *, uint32_t);
	456	extern int iscsi_complete_pdu(struct iscsi_conn , struct iscsi_hdr ,
	457	char *, int);
913e5bf4 MC	458	extern int __iscsi_complete_pdu(struct iscsi_conn , struct iscsi_hdr ,
913e5bf4 MC	459	char *, int);
0af967f5	460	extern int iscsi_verify_itt(struct iscsi_conn *, itt_t);
9c19a7d0	461	extern struct iscsi_task iscsi_itt_to_ctask(struct iscsi_conn , itt_t);
8f9256ce	462	extern struct iscsi_task iscsi_itt_to_task(struct iscsi_conn , itt_t);
9c19a7d0 MC	463	extern void iscsi_requeue_task(struct iscsi_task *task);
9c19a7d0 MC	464	extern void iscsi_put_task(struct iscsi_task *task);
8eea2f55	465	extern void __iscsi_put_task(struct iscsi_task *task);
913e5bf4	466	extern void __iscsi_get_task(struct iscsi_task *task);
4c0ba5d2 MC	467	extern void iscsi_complete_scsi_task(struct iscsi_task *task,
4c0ba5d2 MC	468	uint32_t exp_cmdsn, uint32_t max_cmdsn);
7996a778 MC	469
	470	/*
	471	* generic helpers
	472	*/
6320377f OK	473	extern void iscsi_pool_free(struct iscsi_pool *);
6320377f OK	474	extern int iscsi_pool_init(struct iscsi_pool , int, void **, int);
adaf6990	475	extern int iscsi_switch_str_param(char *, char );
7996a778	476
004d6530 BH	477	/*
	478	* inline functions to deal with padding.
	479	*/
	480	static inline unsigned int
	481	iscsi_padded(unsigned int len)
	482	{
	483	return (len + ISCSI_PAD_LEN - 1) & ~(ISCSI_PAD_LEN - 1);
	484	}
	485
	486	static inline unsigned int
	487	iscsi_padding(unsigned int len)
	488	{
	489	len &= (ISCSI_PAD_LEN - 1);
	490	if (len)
	491	len = ISCSI_PAD_LEN - len;
	492	return len;
	493	}
	494
7996a778	495	#endif