[linux-block.git] / include / scsi / libiscsi.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * 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
 */
#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_cmnd.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 flags */
#define ISCSI_CONN_FLAG_SUSPEND_TX	0
#define ISCSI_CONN_FLAG_SUSPEND_RX	1
#define ISCSI_CONN_FLAG_BOUND		2

#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;
}

static inline bool iscsi_task_is_completed(struct iscsi_task *task)
{
	return task->state == ISCSI_TASK_COMPLETED ||
	       task->state == ISCSI_TASK_ABRT_TMF ||
	       task->state == ISCSI_TASK_ABRT_SESS_RECOV;
}

/* Private data associated with struct scsi_cmnd. */
struct iscsi_cmd {
	struct iscsi_task	*task;
	int			age;
};

static inline struct iscsi_cmd *iscsi_cmd(struct scsi_cmnd *cmd)
{
	return scsi_cmd_priv(cmd);
}

/* 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 */
	/* items must be added/deleted under frwd lock */
	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 */
	/* recv */
	struct work_struct	recvwork;
	unsigned long		flags;		/* ISCSI_CONN_FLAGs */

	/* 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;
	/* 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.*/
	struct iscsi_task	*running_aborted_task;

	/* 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, queues	   */
	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;
};

/*
 * 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 scsi_timeout_action 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(const struct scsi_host_template *sht,
					  int dd_data_size,
					  bool xmit_can_sleep);
extern void iscsi_host_remove(struct Scsi_Host *shost, bool is_shutdown);
extern void iscsi_host_free(struct Scsi_Host *shost);
extern int iscsi_target_alloc(struct scsi_target *starget);
extern int iscsi_host_get_max_scsi_cmds(struct Scsi_Host *shost,
					uint16_t requested_cmds_max);

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