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