libiscsi.h 12.3 KB
Newer Older
Mike Christie's avatar
Mike Christie committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/*
 * 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>
27
#include <linux/wait.h>
Mike Christie's avatar
Mike Christie committed
28
#include <linux/mutex.h>
Al Viro's avatar
Al Viro committed
29 30
#include <linux/timer.h>
#include <linux/workqueue.h>
Mike Christie's avatar
Mike Christie committed
31 32
#include <scsi/iscsi_proto.h>
#include <scsi/iscsi_if.h>
33
#include <scsi/scsi_transport_iscsi.h>
Mike Christie's avatar
Mike Christie committed
34 35

struct scsi_transport_template;
36
struct scsi_host_template;
Mike Christie's avatar
Mike Christie committed
37 38 39 40 41 42 43 44 45
struct scsi_device;
struct Scsi_Host;
struct scsi_cmnd;
struct socket;
struct iscsi_transport;
struct iscsi_cls_session;
struct iscsi_cls_conn;
struct iscsi_session;
struct iscsi_nopin;
46
struct device;
Mike Christie's avatar
Mike Christie committed
47

48
#define ISCSI_DEF_XMIT_CMDS_MAX	128	/* must be power of 2 */
49
#define ISCSI_MGMT_CMDS_MAX	15
Mike Christie's avatar
Mike Christie committed
50

51
#define ISCSI_DEF_CMD_PER_LUN	32
Mike Christie's avatar
Mike Christie committed
52 53

/* Task Mgmt states */
54 55 56 57 58 59 60 61
enum {
	TMF_INITIAL,
	TMF_QUEUED,
	TMF_SUCCESS,
	TMF_FAILED,
	TMF_TIMEDOUT,
	TMF_NOT_FOUND,
};
Mike Christie's avatar
Mike Christie committed
62 63 64 65

/* Connection suspend "bit" */
#define ISCSI_SUSPEND_BIT		1

66
#define ISCSI_ITT_MASK			0x1fff
67 68 69
#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
Mike Christie's avatar
Mike Christie committed
70
#define ISCSI_AGE_SHIFT			28
71
#define ISCSI_AGE_MASK			0xf
Mike Christie's avatar
Mike Christie committed
72

73 74
#define ISCSI_ADDRESS_BUF_LEN		64

75
enum {
76 77 78
	/* this is the maximum possible storage for AHSs */
	ISCSI_MAX_AHS_SIZE = sizeof(struct iscsi_ecdb_ahdr) +
				sizeof(struct iscsi_rlength_ahdr),
79 80 81
	ISCSI_DIGEST_SIZE = sizeof(__u32),
};

Mike Christie's avatar
Mike Christie committed
82

83 84 85 86 87 88
enum {
	ISCSI_TASK_COMPLETED,
	ISCSI_TASK_PENDING,
	ISCSI_TASK_RUNNING,
};

89 90 91 92 93 94 95 96 97 98 99
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 */
};

100
struct iscsi_task {
Mike Christie's avatar
Mike Christie committed
101
	/*
102 103 104
	 * Because LLDs allocate their hdr differently, this is a pointer
	 * and length to that storage. It must be setup at session
	 * creation time.
Mike Christie's avatar
Mike Christie committed
105
	 */
106
	struct iscsi_hdr	*hdr;
107 108
	unsigned short		hdr_max;
	unsigned short		hdr_len;	/* accumulated size of hdr used */
109 110 111 112 113
	/* copied values in case we need to send tmfs */
	itt_t			hdr_itt;
	__be32			cmdsn;
	uint8_t			lun[8];

Mike Christie's avatar
Mike Christie committed
114 115
	int			itt;		/* this ITT */

116
	unsigned		imm_count;	/* imm-data (bytes)   */
117
	/* offset in unsolicited stream (bytes); */
118
	struct iscsi_r2t_info	unsol_r2t;
119
	char			*data;		/* mgmt payload */
120
	unsigned		data_count;
Mike Christie's avatar
Mike Christie committed
121 122 123
	struct scsi_cmnd	*sc;		/* associated SCSI cmd*/
	struct iscsi_conn	*conn;		/* used connection    */

124 125
	/* state set/tested under session->lock */
	int			state;
126
	atomic_t		refcount;
Mike Christie's avatar
Mike Christie committed
127 128 129 130
	struct list_head	running;	/* running cmd list */
	void			*dd_data;	/* driver/transport data */
};

131 132 133 134 135
static inline int iscsi_task_has_unsol_data(struct iscsi_task *task)
{
	return task->unsol_r2t.data_length > task->unsol_r2t.sent;
}

136
static inline void* iscsi_next_hdr(struct iscsi_task *task)
137
{
138
	return (void*)task->hdr + task->hdr_len;
139 140
}

141 142 143 144 145 146 147 148
/* Connection's states */
enum {
	ISCSI_CONN_INITIAL_STAGE,
	ISCSI_CONN_STARTED,
	ISCSI_CONN_STOPPED,
	ISCSI_CONN_CLEANUP_WAIT,
};

Mike Christie's avatar
Mike Christie committed
149 150 151 152 153 154 155 156
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;
157 158 159 160 161
	struct timer_list	transport_timer;
	unsigned long		last_recv;
	unsigned long		last_ping;
	int			ping_timeout;
	int			recv_timeout;
162
	struct iscsi_task 	*ping_task;
Mike Christie's avatar
Mike Christie committed
163 164 165 166 167 168 169

	/* iSCSI connection-wide sequencing */
	uint32_t		exp_statsn;

	/* control data */
	int			id;		/* CID */
	int			c_stage;	/* connection state */
170 171 172 173 174 175 176 177
	/*
	 * 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;
178 179
	struct iscsi_task 	*login_task;	/* mtask used for login/text */
	struct iscsi_task	*task;		/* xmit task in progress */
Mike Christie's avatar
Mike Christie committed
180 181

	/* xmit */
182
	struct list_head	mgmtqueue;	/* mgmt (control) xmit queue */
Mike Christie's avatar
Mike Christie committed
183
	struct list_head	mgmt_run_list;	/* list of control tasks */
184
	struct list_head	xmitqueue;	/* data-path cmd queue */
Mike Christie's avatar
Mike Christie committed
185
	struct list_head	run_list;	/* list of cmds in progress */
186
	struct list_head	requeue;	/* tasks needing another run */
Mike Christie's avatar
Mike Christie committed
187 188 189 190 191 192 193
	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;
194 195
	struct timer_list	tmf_timer;
	int			tmf_state;	/* see TMF_INITIAL, etc.*/
Mike Christie's avatar
Mike Christie committed
196 197

	/* negotiated params */
198 199
	unsigned		max_recv_dlength; /* initiator_max_recv_dsl*/
	unsigned		max_xmit_dlength; /* target_max_recv_dsl */
Mike Christie's avatar
Mike Christie committed
200 201
	int			hdrdgst_en;
	int			datadgst_en;
202 203 204 205 206
	int			ifmarker_en;
	int			ofmarker_en;
	/* values userspace uses to id a conn */
	int			persistent_port;
	char			*persistent_address;
207 208 209
	/* remote portal currently connected to */
	int			portal_port;
	char			portal_address[ISCSI_ADDRESS_BUF_LEN];
Mike Christie's avatar
Mike Christie committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223

	/* 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;
224
	uint32_t		fmr_unalign_cnt;
Mike Christie's avatar
Mike Christie committed
225 226
};

227
struct iscsi_pool {
Mike Christie's avatar
Mike Christie committed
228 229 230 231 232
	struct kfifo		*queue;		/* FIFO Queue */
	void			**pool;		/* Pool of elements */
	int			max;		/* Max number of elements */
};

233 234 235 236 237 238 239 240 241 242 243
/* 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,
};

Mike Christie's avatar
Mike Christie committed
244
struct iscsi_session {
245
	struct iscsi_cls_session *cls_session;
246 247 248 249 250 251 252
	/*
	 * 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;

Mike Christie's avatar
Mike Christie committed
253 254 255 256 257
	/* iSCSI session-wide sequencing */
	uint32_t		cmdsn;
	uint32_t		exp_cmdsn;
	uint32_t		max_cmdsn;

258 259 260
	/* This tracks the reqs queued into the initiator */
	uint32_t		queued_cmdsn;

Mike Christie's avatar
Mike Christie committed
261
	/* configuration */
262 263
	int			abort_timeout;
	int			lu_reset_timeout;
Mike Christie's avatar
Mike Christie committed
264
	int			initial_r2t_en;
265
	unsigned		max_r2t;
Mike Christie's avatar
Mike Christie committed
266
	int			imm_data_en;
267 268
	unsigned		first_burst;
	unsigned		max_burst;
Mike Christie's avatar
Mike Christie committed
269 270 271 272 273
	int			time2wait;
	int			time2retain;
	int			pdu_inorder_en;
	int			dataseq_inorder_en;
	int			erl;
274
	int			fast_abort;
275
	int			tpgt;
276 277 278 279
	char			*username;
	char			*username_in;
	char			*password;
	char			*password_in;
280
	char			*targetname;
281 282
	char			*ifacename;
	char			*initiatorname;
Mike Christie's avatar
Mike Christie committed
283 284 285 286 287 288 289 290 291 292 293 294 295
	/* control data */
	struct iscsi_transport	*tt;
	struct Scsi_Host	*host;
	struct iscsi_conn	*leadconn;	/* leading connection */
	spinlock_t		lock;		/* protects session state, *
						 * sequence numbers,       *
						 * session resources:      *
						 * - cmdpool,		   *
						 * - mgmtpool,		   *
						 * - r2tpool		   */
	int			state;		/* session state           */
	int			age;		/* counts session re-opens */

296
	int			scsi_cmds_max; 	/* max scsi commands */
Mike Christie's avatar
Mike Christie committed
297
	int			cmds_max;	/* size of cmds array */
298
	struct iscsi_task	**cmds;		/* Original Cmds arr */
299
	struct iscsi_pool	cmdpool;	/* PDU's pool */
Mike Christie's avatar
Mike Christie committed
300 301
};

302 303 304 305 306
enum {
	ISCSI_HOST_SETUP,
	ISCSI_HOST_REMOVED,
};

307 308 309 310 311 312 313 314
struct iscsi_host {
	char			*initiatorname;
	/* hw address or netdev iscsi connection is bound to */
	char			*hwaddress;
	char			*netdev;
	/* local address */
	int			local_port;
	char			local_address[ISCSI_ADDRESS_BUF_LEN];
315 316 317 318 319 320

	wait_queue_head_t	session_removal_wq;
	/* protects sessions and state */
	spinlock_t		lock;
	int			num_sessions;
	int			state;
321 322 323

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

Mike Christie's avatar
Mike Christie committed
326 327 328 329 330
/*
 * scsi host template
 */
extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
extern int iscsi_eh_abort(struct scsi_cmnd *sc);
331
extern int iscsi_eh_target_reset(struct scsi_cmnd *sc);
332
extern int iscsi_eh_device_reset(struct scsi_cmnd *sc);
Mike Christie's avatar
Mike Christie committed
333 334
extern int iscsi_queuecommand(struct scsi_cmnd *sc,
			      void (*done)(struct scsi_cmnd *));
335 336 337 338

/*
 * iSCSI host helpers.
 */
339 340 341
#define iscsi_host_priv(_shost) \
	(shost_priv(_shost) + sizeof(struct iscsi_host))

342 343 344 345 346
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);
347 348
extern int iscsi_host_add(struct Scsi_Host *shost, struct device *pdev);
extern struct Scsi_Host *iscsi_host_alloc(struct scsi_host_template *sht,
349 350
					  int dd_data_size, uint16_t qdepth,
					  bool xmit_can_sleep);
351 352
extern void iscsi_host_remove(struct Scsi_Host *shost);
extern void iscsi_host_free(struct Scsi_Host *shost);
Mike Christie's avatar
Mike Christie committed
353 354 355 356 357

/*
 * session management
 */
extern struct iscsi_cls_session *
358
iscsi_session_setup(struct iscsi_transport *, struct Scsi_Host *shost,
359
		    uint16_t, int, uint32_t, unsigned int);
Mike Christie's avatar
Mike Christie committed
360 361
extern void iscsi_session_teardown(struct iscsi_cls_session *);
extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
362 363 364 365
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);
Mike Christie's avatar
Mike Christie committed
366

367
#define iscsi_session_printk(prefix, _sess, fmt, a...)	\
368
	iscsi_cls_session_printk(prefix, _sess->cls_session, fmt, ##a)
369

Mike Christie's avatar
Mike Christie committed
370 371 372 373
/*
 * connection management
 */
extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
374
					       int, uint32_t);
Mike Christie's avatar
Mike Christie committed
375 376 377 378 379 380
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);
381 382
extern void iscsi_session_failure(struct iscsi_cls_session *cls_session,
				  enum iscsi_err err);
383 384
extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
				enum iscsi_param param, char *buf);
385
extern void iscsi_suspend_tx(struct iscsi_conn *conn);
386
extern void iscsi_conn_queue_work(struct iscsi_conn *conn);
Mike Christie's avatar
Mike Christie committed
387

388
#define iscsi_conn_printk(prefix, _c, fmt, a...) \
389 390
	iscsi_cls_conn_printk(prefix, ((struct iscsi_conn *)_c)->cls_conn, \
			      fmt, ##a)
391

Mike Christie's avatar
Mike Christie committed
392 393 394
/*
 * pdu and task processing
 */
395
extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *);
396 397 398
extern void iscsi_prep_data_out_pdu(struct iscsi_task *task,
				    struct iscsi_r2t_info *r2t,
				    struct iscsi_data *hdr);
Mike Christie's avatar
Mike Christie committed
399 400 401 402
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);
403 404
extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
				char *, int);
405
extern int iscsi_verify_itt(struct iscsi_conn *, itt_t);
406 407 408
extern struct iscsi_task *iscsi_itt_to_ctask(struct iscsi_conn *, itt_t);
extern void iscsi_requeue_task(struct iscsi_task *task);
extern void iscsi_put_task(struct iscsi_task *task);
409
extern void __iscsi_get_task(struct iscsi_task *task);
Mike Christie's avatar
Mike Christie committed
410 411 412 413

/*
 * generic helpers
 */
414 415
extern void iscsi_pool_free(struct iscsi_pool *);
extern int iscsi_pool_init(struct iscsi_pool *, int, void ***, int);
Mike Christie's avatar
Mike Christie committed
416

417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
/*
 * 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;
}

Mike Christie's avatar
Mike Christie committed
435
#endif