scsi_transport_iscsi.h 17.2 KB
Newer Older
1
/*
Linus Torvalds's avatar
Linus Torvalds committed
2 3 4
 * iSCSI transport class definitions
 *
 * Copyright (C) IBM Corporation, 2004
5
 * Copyright (C) Mike Christie, 2004 - 2006
6 7
 * Copyright (C) Dmitry Yusupov, 2004 - 2005
 * Copyright (C) Alex Aizman, 2004 - 2005
Linus Torvalds's avatar
Linus Torvalds committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 *
 * 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 SCSI_TRANSPORT_ISCSI_H
#define SCSI_TRANSPORT_ISCSI_H

26
#include <linux/device.h>
27 28
#include <linux/list.h>
#include <linux/mutex.h>
29
#include <scsi/iscsi_if.h>
Linus Torvalds's avatar
Linus Torvalds committed
30

31
struct scsi_transport_template;
32
struct iscsi_transport;
33
struct iscsi_endpoint;
34
struct Scsi_Host;
35
struct scsi_cmnd;
36
struct iscsi_cls_conn;
37
struct iscsi_conn;
38
struct iscsi_task;
39
struct sockaddr;
40
struct iscsi_iface;
41
struct bsg_job;
42 43
struct iscsi_bus_flash_session;
struct iscsi_bus_flash_conn;
44

45 46 47 48 49 50 51 52 53 54 55
/**
 * struct iscsi_transport - iSCSI Transport template
 *
 * @name:		transport name
 * @caps:		iSCSI Data-Path capabilities
 * @create_session:	create new iSCSI session object
 * @destroy_session:	destroy existing iSCSI session object
 * @create_conn:	create new iSCSI connection
 * @bind_conn:		associate this connection with existing iSCSI session
 *			and specified transport descriptor
 * @destroy_conn:	destroy inactive iSCSI connection
56 57 58 59 60 61
 * @set_param:		set iSCSI parameter. Return 0 on success, -ENODATA
 *			when param is not supported, and a -Exx value on other
 *			error.
 * @get_param		get iSCSI parameter. Must return number of bytes
 *			copied to buffer on success, -ENODATA when param
 *			is not supported, and a -Exx value on other error
62 63 64
 * @start_conn:		set connection to be operational
 * @stop_conn:		suspend/recover/terminate connection
 * @send_pdu:		send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
65
 * @session_recovery_timedout: notify LLD a block during recovery timed out
66 67 68 69 70 71 72
 * @init_task:		Initialize a iscsi_task and any internal structs.
 *			When offloading the data path, this is called from
 *			queuecommand with the session lock, or from the
 *			iscsi_conn_send_pdu context with the session lock.
 *			When not offloading the data path, this is called
 *			from the scsi work queue without the session lock.
 * @xmit_task		Requests LLD to transfer cmd task. Returns 0 or the
73
 *			the number of bytes transferred on success, and -Exyz
74 75 76 77 78 79 80 81
 *			value on error. When offloading the data path, this
 *			is called from queuecommand with the session lock, or
 *			from the iscsi_conn_send_pdu context with the session
 *			lock. When not offloading the data path, this is called
 *			from the scsi work queue without the session lock.
 * @cleanup_task:	requests LLD to fail task. Called with session lock
 *			and after the connection has been suspended and
 *			terminated during recovery. If called
82 83
 *			from abort task then connection is not suspended
 *			or terminated but sk_callback_lock is held
84 85 86 87 88 89 90
 *
 * Template API provided by iSCSI Transport
 */
struct iscsi_transport {
	struct module *owner;
	char *name;
	unsigned int caps;
91

92
	struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep,
93
					uint16_t cmds_max, uint16_t qdepth,
94
					uint32_t sn);
95 96
	void (*destroy_session) (struct iscsi_cls_session *session);
	struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
97
				uint32_t cid);
98 99
	int (*bind_conn) (struct iscsi_cls_session *session,
			  struct iscsi_cls_conn *cls_conn,
100
			  uint64_t transport_eph, int is_leading);
101 102
	int (*start_conn) (struct iscsi_cls_conn *conn);
	void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
103
	void (*destroy_conn) (struct iscsi_cls_conn *conn);
104
	int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
105
			  char *buf, int buflen);
106 107
	int (*get_ep_param) (struct iscsi_endpoint *ep, enum iscsi_param param,
			     char *buf);
108
	int (*get_conn_param) (struct iscsi_cls_conn *conn,
109
			       enum iscsi_param param, char *buf);
110
	int (*get_session_param) (struct iscsi_cls_session *session,
111
				  enum iscsi_param param, char *buf);
112 113
	int (*get_host_param) (struct Scsi_Host *shost,
				enum iscsi_host_param param, char *buf);
114 115 116
	int (*set_host_param) (struct Scsi_Host *shost,
			       enum iscsi_host_param param, char *buf,
			       int buflen);
117
	int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
118
			 char *data, uint32_t data_size);
119 120
	void (*get_stats) (struct iscsi_cls_conn *conn,
			   struct iscsi_stats *stats);
121

122 123
	int (*init_task) (struct iscsi_task *task);
	int (*xmit_task) (struct iscsi_task *task);
124 125
	void (*cleanup_task) (struct iscsi_task *task);

126
	int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode);
127 128 129
	int (*xmit_pdu) (struct iscsi_task *task);
	int (*init_pdu) (struct iscsi_task *task, unsigned int offset,
			 unsigned int count);
130 131 132
	void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt,
			       int *index, int *age);

133
	void (*session_recovery_timedout) (struct iscsi_cls_session *session);
134 135
	struct iscsi_endpoint *(*ep_connect) (struct Scsi_Host *shost,
					      struct sockaddr *dst_addr,
136 137 138
					      int non_blocking);
	int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms);
	void (*ep_disconnect) (struct iscsi_endpoint *ep);
139
	int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
140
			  uint32_t enable, struct sockaddr *dst_addr);
141
	int (*set_path) (struct Scsi_Host *shost, struct iscsi_path *params);
142 143
	int (*set_iface_param) (struct Scsi_Host *shost, void *data,
				uint32_t len);
144 145 146
	int (*get_iface_param) (struct iscsi_iface *iface,
				enum iscsi_param_type param_type,
				int param, char *buf);
147
	umode_t (*attr_is_visible)(int param_type, int param);
148
	int (*bsg_request)(struct bsg_job *job);
149 150 151
	int (*send_ping) (struct Scsi_Host *shost, uint32_t iface_num,
			  uint32_t iface_type, uint32_t payload_size,
			  uint32_t pid, struct sockaddr *dst_addr);
152 153 154
	int (*get_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx,
			 uint32_t *num_entries, char *buf);
	int (*delete_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx);
155
	int (*set_chap) (struct Scsi_Host *shost, void *data, int len);
156 157 158 159 160 161 162 163 164 165 166 167 168
	int (*get_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
				    int param, char *buf);
	int (*set_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
				    struct iscsi_bus_flash_conn *fnode_conn,
				    void *data, int len);
	int (*new_flashnode) (struct Scsi_Host *shost, const char *buf,
			      int len);
	int (*del_flashnode) (struct iscsi_bus_flash_session *fnode_sess);
	int (*login_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
				struct iscsi_bus_flash_conn *fnode_conn);
	int (*logout_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
				 struct iscsi_bus_flash_conn *fnode_conn);
	int (*logout_flashnode_sid) (struct iscsi_cls_session *cls_sess);
169
	int (*get_host_stats) (struct Scsi_Host *shost, char *buf, int len);
170
	u8 (*check_protection)(struct iscsi_task *task, sector_t *sector);
Linus Torvalds's avatar
Linus Torvalds committed
171 172 173
};

/*
174
 * transport registration upcalls
Linus Torvalds's avatar
Linus Torvalds committed
175
 */
176
extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
177
extern int iscsi_unregister_transport(struct iscsi_transport *tt);
Linus Torvalds's avatar
Linus Torvalds committed
178 179

/*
180
 * control plane upcalls
Linus Torvalds's avatar
Linus Torvalds committed
181
 */
182 183
extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
				   enum iscsi_err error);
184 185
extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn,
				   enum iscsi_conn_state state);
186
extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
187
			  char *data, uint32_t data_size);
Linus Torvalds's avatar
Linus Torvalds committed
188

189 190 191 192
extern int iscsi_offload_mesg(struct Scsi_Host *shost,
			      struct iscsi_transport *transport, uint32_t type,
			      char *data, uint16_t data_size);

193 194 195 196 197 198
extern void iscsi_post_host_event(uint32_t host_no,
				  struct iscsi_transport *transport,
				  enum iscsi_host_event_code code,
				  uint32_t data_size,
				  uint8_t *data);

199 200 201 202 203
extern void iscsi_ping_comp_event(uint32_t host_no,
				  struct iscsi_transport *transport,
				  uint32_t status, uint32_t pid,
				  uint32_t data_size, uint8_t *data);

204 205 206 207
struct iscsi_cls_conn {
	struct list_head conn_list;	/* item in connlist */
	void *dd_data;			/* LLD private data */
	struct iscsi_transport *transport;
208
	uint32_t cid;			/* connection id */
209 210
	struct mutex ep_mutex;
	struct iscsi_endpoint *ep;
211

212 213 214 215 216 217
	struct device dev;		/* sysfs transport/container device */
};

#define iscsi_dev_to_conn(_dev) \
	container_of(_dev, struct iscsi_cls_conn, dev)

218 219 220
#define transport_class_to_conn(_cdev) \
	iscsi_dev_to_conn(_cdev->parent)

221 222 223 224 225 226 227 228 229
#define iscsi_conn_to_session(_conn) \
	iscsi_dev_to_session(_conn->dev.parent)

/* iscsi class session state */
enum {
	ISCSI_SESSION_LOGGED_IN,
	ISCSI_SESSION_FAILED,
	ISCSI_SESSION_FREE,
};
230

231 232
#define ISCSI_MAX_TARGET -1

233
struct iscsi_cls_session {
234
	struct list_head sess_list;		/* item in session_list */
235
	struct iscsi_transport *transport;
236
	spinlock_t lock;
237 238
	struct work_struct block_work;
	struct work_struct unblock_work;
239 240
	struct work_struct scan_work;
	struct work_struct unbind_work;
241

242 243
	/* recovery fields */
	int recovery_tmo;
244
	struct delayed_work recovery_work;
245

246
	unsigned int target_id;
247
	bool ida_used;
248

249 250 251 252 253
	/*
	 * pid of userspace process that created session or -1 if
	 * created by the kernel.
	 */
	pid_t creator;
254
	int state;
255 256
	int sid;				/* session id */
	void *dd_data;				/* LLD private data */
257 258 259 260 261 262
	struct device dev;	/* sysfs transport/container device */
};

#define iscsi_dev_to_session(_dev) \
	container_of(_dev, struct iscsi_cls_session, dev)

263 264 265
#define transport_class_to_session(_cdev) \
	iscsi_dev_to_session(_cdev->parent)

266 267 268
#define iscsi_session_to_shost(_session) \
	dev_to_shost(_session->dev.parent)

269 270 271
#define starget_to_session(_stgt) \
	iscsi_dev_to_session(_stgt->dev.parent)

272
struct iscsi_cls_host {
273
	atomic_t nr_scans;
274
	struct mutex mutex;
275
	struct request_queue *bsg_q;
276 277
	uint32_t port_speed;
	uint32_t port_state;
278 279
};

280 281 282
#define iscsi_job_to_shost(_job) \
        dev_to_shost(_job->dev)

283 284 285
extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
				void (*fn)(struct iscsi_cls_session *));

286 287 288
struct iscsi_endpoint {
	void *dd_data;			/* LLD private data */
	struct device dev;
289
	uint64_t id;
290
	struct iscsi_cls_conn *conn;
291
};
292

293 294 295 296 297 298 299 300 301 302 303 304 305 306
struct iscsi_iface {
	struct device dev;
	struct iscsi_transport *transport;
	uint32_t iface_type;	/* IPv4 or IPv6 */
	uint32_t iface_num;	/* iface number, 0 - n */
	void *dd_data;		/* LLD private data */
};

#define iscsi_dev_to_iface(_dev) \
	container_of(_dev, struct iscsi_iface, dev)

#define iscsi_iface_to_shost(_iface) \
	dev_to_shost(_iface->dev.parent)

307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412

struct iscsi_bus_flash_conn {
	struct list_head conn_list;	/* item in connlist */
	void *dd_data;			/* LLD private data */
	struct iscsi_transport *transport;
	struct device dev;		/* sysfs transport/container device */
	/* iscsi connection parameters */
	uint32_t		exp_statsn;
	uint32_t		statsn;
	unsigned		max_recv_dlength; /* initiator_max_recv_dsl*/
	unsigned		max_xmit_dlength; /* target_max_recv_dsl */
	unsigned		max_segment_size;
	unsigned		tcp_xmit_wsf;
	unsigned		tcp_recv_wsf;
	int			hdrdgst_en;
	int			datadgst_en;
	int			port;
	char			*ipaddress;
	char			*link_local_ipv6_addr;
	char			*redirect_ipaddr;
	uint16_t		keepalive_timeout;
	uint16_t		local_port;
	uint8_t			snack_req_en;
	/* tcp timestamp negotiation status */
	uint8_t			tcp_timestamp_stat;
	uint8_t			tcp_nagle_disable;
	/* tcp window scale factor */
	uint8_t			tcp_wsf_disable;
	uint8_t			tcp_timer_scale;
	uint8_t			tcp_timestamp_en;
	uint8_t			ipv4_tos;
	uint8_t			ipv6_traffic_class;
	uint8_t			ipv6_flow_label;
	uint8_t			fragment_disable;
	/* Link local IPv6 address is assigned by firmware or driver */
	uint8_t			is_fw_assigned_ipv6;
};

#define iscsi_dev_to_flash_conn(_dev) \
	container_of(_dev, struct iscsi_bus_flash_conn, dev)

#define iscsi_flash_conn_to_flash_session(_conn) \
	iscsi_dev_to_flash_session(_conn->dev.parent)

#define ISID_SIZE 6

struct iscsi_bus_flash_session {
	struct list_head sess_list;		/* item in session_list */
	struct iscsi_transport *transport;
	unsigned int target_id;
	int flash_state;	/* persistent or non-persistent */
	void *dd_data;				/* LLD private data */
	struct device dev;	/* sysfs transport/container device */
	/* iscsi session parameters */
	unsigned		first_burst;
	unsigned		max_burst;
	unsigned short		max_r2t;
	int			default_taskmgmt_timeout;
	int			initial_r2t_en;
	int			imm_data_en;
	int			time2wait;
	int			time2retain;
	int			pdu_inorder_en;
	int			dataseq_inorder_en;
	int			erl;
	int			tpgt;
	char			*username;
	char			*username_in;
	char			*password;
	char			*password_in;
	char			*targetname;
	char			*targetalias;
	char			*portal_type;
	uint16_t		tsid;
	uint16_t		chap_in_idx;
	uint16_t		chap_out_idx;
	/* index of iSCSI discovery session if the entry is
	 * discovered by iSCSI discovery session
	 */
	uint16_t		discovery_parent_idx;
	/* indicates if discovery was done through iSNS discovery service
	 * or through sendTarget */
	uint16_t		discovery_parent_type;
	/* Firmware auto sendtarget discovery disable */
	uint8_t			auto_snd_tgt_disable;
	uint8_t			discovery_sess;
	/* indicates if this flashnode entry is enabled or disabled */
	uint8_t			entry_state;
	uint8_t			chap_auth_en;
	/* enables firmware to auto logout the discovery session on discovery
	 * completion
	 */
	uint8_t			discovery_logout_en;
	uint8_t			bidi_chap_en;
	/* makes authentication for discovery session optional */
	uint8_t			discovery_auth_optional;
	uint8_t			isid[ISID_SIZE];
	uint8_t			is_boot_target;
};

#define iscsi_dev_to_flash_session(_dev) \
	container_of(_dev, struct iscsi_bus_flash_session, dev)

#define iscsi_flash_session_to_shost(_session) \
	dev_to_shost(_session->dev.parent)

413 414 415
/*
 * session and connection functions that can be used by HW iSCSI LLDs
 */
416 417 418 419 420 421
#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
	dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)

#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
	dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)

422
extern int iscsi_session_chkready(struct iscsi_cls_session *session);
423
extern int iscsi_is_session_online(struct iscsi_cls_session *session);
424
extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
425
				struct iscsi_transport *transport, int dd_size);
426 427
extern int iscsi_add_session(struct iscsi_cls_session *session,
			     unsigned int target_id);
428 429
extern int iscsi_session_event(struct iscsi_cls_session *session,
			       enum iscsi_uevent_e event);
430
extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
431
						struct iscsi_transport *t,
432
						int dd_size,
433
						unsigned int target_id);
434 435
extern void iscsi_remove_session(struct iscsi_cls_session *session);
extern void iscsi_free_session(struct iscsi_cls_session *session);
436 437
extern int iscsi_destroy_session(struct iscsi_cls_session *session);
extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
438
						int dd_size, uint32_t cid);
439
extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
440 441
extern void iscsi_unblock_session(struct iscsi_cls_session *session);
extern void iscsi_block_session(struct iscsi_cls_session *session);
442
extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
443 444 445
extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
446
extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
447 448 449 450 451 452
extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost,
					      struct iscsi_transport *t,
					      uint32_t iface_type,
					      uint32_t iface_num, int dd_size);
extern void iscsi_destroy_iface(struct iscsi_iface *iface);
extern struct iscsi_iface *iscsi_lookup_iface(int handle);
453 454
extern char *iscsi_get_port_speed_name(struct Scsi_Host *shost);
extern char *iscsi_get_port_state_name(struct Scsi_Host *shost);
455
extern int iscsi_is_session_dev(const struct device *dev);
456

457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
extern char *iscsi_get_discovery_parent_name(int parent_type);
extern struct device *
iscsi_find_flashnode(struct Scsi_Host *shost, void *data,
		     int (*fn)(struct device *dev, void *data));

extern struct iscsi_bus_flash_session *
iscsi_create_flashnode_sess(struct Scsi_Host *shost, int index,
			    struct iscsi_transport *transport, int dd_size);

extern struct iscsi_bus_flash_conn *
iscsi_create_flashnode_conn(struct Scsi_Host *shost,
			    struct iscsi_bus_flash_session *fnode_sess,
			    struct iscsi_transport *transport, int dd_size);

extern void
iscsi_destroy_flashnode_sess(struct iscsi_bus_flash_session *fnode_sess);

extern void iscsi_destroy_all_flashnode(struct Scsi_Host *shost);
extern int iscsi_flashnode_bus_match(struct device *dev,
				     struct device_driver *drv);
extern struct device *
iscsi_find_flashnode_sess(struct Scsi_Host *shost, void *data,
			  int (*fn)(struct device *dev, void *data));
extern struct device *
481 482
iscsi_find_flashnode_conn(struct iscsi_bus_flash_session *fnode_sess);

483 484 485
extern char *
iscsi_get_ipaddress_state_name(enum iscsi_ipaddress_state port_state);
extern char *iscsi_get_router_state_name(enum iscsi_router_state router_state);
Linus Torvalds's avatar
Linus Torvalds committed
486
#endif