blob: 53f0b361d668cf57d41bb8c8a2276d07fc6221da [file] [log] [blame]
Alex Aizman39e84792005-08-04 19:31:00 -07001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * iSCSI transport class definitions
3 *
4 * Copyright (C) IBM Corporation, 2004
Mike Christie7996a772006-04-06 21:13:41 -05005 * Copyright (C) Mike Christie, 2004 - 2006
Alex Aizman39e84792005-08-04 19:31:00 -07006 * Copyright (C) Dmitry Yusupov, 2004 - 2005
7 * Copyright (C) Alex Aizman, 2004 - 2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
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 SCSI_TRANSPORT_ISCSI_H
24#define SCSI_TRANSPORT_ISCSI_H
25
Mike Christie7b8631b2006-01-13 18:05:50 -060026#include <linux/device.h>
Michael S. Tsirkind773c082007-10-02 14:38:05 -070027#include <linux/list.h>
28#include <linux/mutex.h>
Alex Aizman39e84792005-08-04 19:31:00 -070029#include <scsi/iscsi_if.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Mike Christie7b8631b2006-01-13 18:05:50 -060031struct scsi_transport_template;
Mike Christie7996a772006-04-06 21:13:41 -050032struct iscsi_transport;
Mike Christied82ff9be2008-05-21 15:54:13 -050033struct iscsi_endpoint;
Mike Christie7b8631b2006-01-13 18:05:50 -060034struct Scsi_Host;
Mike Christiec01be6d2010-07-22 16:59:49 +053035struct scsi_cmnd;
Mike Christie7b8631b2006-01-13 18:05:50 -060036struct iscsi_cls_conn;
Mike Christie7996a772006-04-06 21:13:41 -050037struct iscsi_conn;
Mike Christie9c19a7d2008-05-21 15:54:09 -050038struct iscsi_task;
Mike Christiea54a52c2006-06-28 12:00:23 -050039struct sockaddr;
Mike Christie8d079132011-07-25 13:48:40 -050040struct iscsi_iface;
Mike Christie90eeb012011-07-25 13:48:50 -050041struct bsg_job;
Mike Christie7b8631b2006-01-13 18:05:50 -060042
Alex Aizman39e84792005-08-04 19:31:00 -070043/**
44 * struct iscsi_transport - iSCSI Transport template
45 *
46 * @name: transport name
47 * @caps: iSCSI Data-Path capabilities
48 * @create_session: create new iSCSI session object
49 * @destroy_session: destroy existing iSCSI session object
50 * @create_conn: create new iSCSI connection
51 * @bind_conn: associate this connection with existing iSCSI session
52 * and specified transport descriptor
53 * @destroy_conn: destroy inactive iSCSI connection
Mike Christiea54a52c2006-06-28 12:00:23 -050054 * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
55 * when param is not supported, and a -Exx value on other
56 * error.
57 * @get_param get iSCSI parameter. Must return number of bytes
58 * copied to buffer on success, -ENODATA when param
59 * is not supported, and a -Exx value on other error
Alex Aizman39e84792005-08-04 19:31:00 -070060 * @start_conn: set connection to be operational
61 * @stop_conn: suspend/recover/terminate connection
62 * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
Mike Christie7996a772006-04-06 21:13:41 -050063 * @session_recovery_timedout: notify LLD a block during recovery timed out
Mike Christie3e5c28a2008-05-21 15:54:06 -050064 * @init_task: Initialize a iscsi_task and any internal structs.
65 * When offloading the data path, this is called from
66 * queuecommand with the session lock, or from the
67 * iscsi_conn_send_pdu context with the session lock.
68 * When not offloading the data path, this is called
69 * from the scsi work queue without the session lock.
70 * @xmit_task Requests LLD to transfer cmd task. Returns 0 or the
Mike Christie3219e522006-05-30 00:37:28 -050071 * the number of bytes transferred on success, and -Exyz
Mike Christie3e5c28a2008-05-21 15:54:06 -050072 * value on error. When offloading the data path, this
73 * is called from queuecommand with the session lock, or
74 * from the iscsi_conn_send_pdu context with the session
75 * lock. When not offloading the data path, this is called
76 * from the scsi work queue without the session lock.
77 * @cleanup_task: requests LLD to fail task. Called with session lock
78 * and after the connection has been suspended and
79 * terminated during recovery. If called
Mike Christie7996a772006-04-06 21:13:41 -050080 * from abort task then connection is not suspended
81 * or terminated but sk_callback_lock is held
Alex Aizman39e84792005-08-04 19:31:00 -070082 *
83 * Template API provided by iSCSI Transport
84 */
85struct iscsi_transport {
86 struct module *owner;
87 char *name;
88 unsigned int caps;
Mike Christie8d079132011-07-25 13:48:40 -050089
Mike Christied82ff9be2008-05-21 15:54:13 -050090 struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep,
Mike Christie75613522008-05-21 15:53:59 -050091 uint16_t cmds_max, uint16_t qdepth,
Mike Christie5e7facb2009-03-05 14:46:06 -060092 uint32_t sn);
Mike Christie7b7232f2006-02-01 21:06:49 -060093 void (*destroy_session) (struct iscsi_cls_session *session);
94 struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
Mike Christie7b8631b2006-01-13 18:05:50 -060095 uint32_t cid);
Mike Christie7b7232f2006-02-01 21:06:49 -060096 int (*bind_conn) (struct iscsi_cls_session *session,
97 struct iscsi_cls_conn *cls_conn,
Or Gerlitz264faaa2006-05-02 19:46:36 -050098 uint64_t transport_eph, int is_leading);
Mike Christie7b7232f2006-02-01 21:06:49 -060099 int (*start_conn) (struct iscsi_cls_conn *conn);
100 void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
Mike Christie7b8631b2006-01-13 18:05:50 -0600101 void (*destroy_conn) (struct iscsi_cls_conn *conn);
Mike Christie7b7232f2006-02-01 21:06:49 -0600102 int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
Mike Christiea54a52c2006-06-28 12:00:23 -0500103 char *buf, int buflen);
Mike Christie289324b2011-02-16 15:04:37 -0600104 int (*get_ep_param) (struct iscsi_endpoint *ep, enum iscsi_param param,
105 char *buf);
Mike Christie7b7232f2006-02-01 21:06:49 -0600106 int (*get_conn_param) (struct iscsi_cls_conn *conn,
Mike Christiea54a52c2006-06-28 12:00:23 -0500107 enum iscsi_param param, char *buf);
Mike Christie7b7232f2006-02-01 21:06:49 -0600108 int (*get_session_param) (struct iscsi_cls_session *session,
Mike Christiea54a52c2006-06-28 12:00:23 -0500109 enum iscsi_param param, char *buf);
Mike Christie1819dc82007-05-30 12:57:08 -0500110 int (*get_host_param) (struct Scsi_Host *shost,
111 enum iscsi_host_param param, char *buf);
Mike Christie1d9bf132007-05-30 12:57:11 -0500112 int (*set_host_param) (struct Scsi_Host *shost,
113 enum iscsi_host_param param, char *buf,
114 int buflen);
Mike Christie7b7232f2006-02-01 21:06:49 -0600115 int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
Alex Aizman39e84792005-08-04 19:31:00 -0700116 char *data, uint32_t data_size);
Mike Christie7b7232f2006-02-01 21:06:49 -0600117 void (*get_stats) (struct iscsi_cls_conn *conn,
118 struct iscsi_stats *stats);
Mike Christie577577d2008-12-02 00:32:05 -0600119
Mike Christie9c19a7d2008-05-21 15:54:09 -0500120 int (*init_task) (struct iscsi_task *task);
121 int (*xmit_task) (struct iscsi_task *task);
Mike Christie577577d2008-12-02 00:32:05 -0600122 void (*cleanup_task) (struct iscsi_task *task);
123
Mike Christie2ff79d52008-12-02 00:32:14 -0600124 int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode);
Mike Christie577577d2008-12-02 00:32:05 -0600125 int (*xmit_pdu) (struct iscsi_task *task);
126 int (*init_pdu) (struct iscsi_task *task, unsigned int offset,
127 unsigned int count);
Mike Christie262ef632008-12-02 00:32:13 -0600128 void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt,
129 int *index, int *age);
130
Mike Christie30a6c652006-04-06 21:13:39 -0500131 void (*session_recovery_timedout) (struct iscsi_cls_session *session);
Mike Christie10eb0f02009-05-13 17:57:38 -0500132 struct iscsi_endpoint *(*ep_connect) (struct Scsi_Host *shost,
133 struct sockaddr *dst_addr,
Mike Christied82ff9be2008-05-21 15:54:13 -0500134 int non_blocking);
135 int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms);
136 void (*ep_disconnect) (struct iscsi_endpoint *ep);
Mike Christie2174a042007-05-30 12:57:10 -0500137 int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
Mike Christie01cb2252006-06-28 12:00:22 -0500138 uint32_t enable, struct sockaddr *dst_addr);
Michael Chan43514772009-06-08 18:14:41 -0700139 int (*set_path) (struct Scsi_Host *shost, struct iscsi_path *params);
Mike Christie00c31882011-10-06 03:56:59 -0500140 int (*set_iface_param) (struct Scsi_Host *shost, void *data,
141 uint32_t len);
Mike Christie8d079132011-07-25 13:48:40 -0500142 int (*get_iface_param) (struct iscsi_iface *iface,
143 enum iscsi_param_type param_type,
144 int param, char *buf);
Al Viro587a1f12011-07-23 23:11:19 -0400145 umode_t (*attr_is_visible)(int param_type, int param);
Mike Christie90eeb012011-07-25 13:48:50 -0500146 int (*bsg_request)(struct bsg_job *job);
Vikas Chaudharyac20c7b2012-02-13 18:30:48 +0530147 int (*send_ping) (struct Scsi_Host *shost, uint32_t iface_num,
148 uint32_t iface_type, uint32_t payload_size,
149 uint32_t pid, struct sockaddr *dst_addr);
Nilesh Javali6260a5d2012-02-27 03:08:51 -0800150 int (*get_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx,
151 uint32_t *num_entries, char *buf);
152 int (*delete_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153};
154
155/*
Alex Aizman39e84792005-08-04 19:31:00 -0700156 * transport registration upcalls
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 */
Mike Christie7b8631b2006-01-13 18:05:50 -0600158extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
Alex Aizman39e84792005-08-04 19:31:00 -0700159extern int iscsi_unregister_transport(struct iscsi_transport *tt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
161/*
Alex Aizman39e84792005-08-04 19:31:00 -0700162 * control plane upcalls
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 */
Mike Christiee5bd7b52008-09-24 11:46:10 -0500164extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
165 enum iscsi_err error);
Manish Rangankar17fa5752011-07-25 13:48:52 -0500166extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn,
167 enum iscsi_conn_state state);
Mike Christie7b7232f2006-02-01 21:06:49 -0600168extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
Alex Aizman39e84792005-08-04 19:31:00 -0700169 char *data, uint32_t data_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Michael Chan43514772009-06-08 18:14:41 -0700171extern int iscsi_offload_mesg(struct Scsi_Host *shost,
172 struct iscsi_transport *transport, uint32_t type,
173 char *data, uint16_t data_size);
174
Vikas Chaudharya11e2542012-02-13 18:30:46 +0530175extern void iscsi_post_host_event(uint32_t host_no,
176 struct iscsi_transport *transport,
177 enum iscsi_host_event_code code,
178 uint32_t data_size,
179 uint8_t *data);
180
Vikas Chaudharyac20c7b2012-02-13 18:30:48 +0530181extern void iscsi_ping_comp_event(uint32_t host_no,
182 struct iscsi_transport *transport,
183 uint32_t status, uint32_t pid,
184 uint32_t data_size, uint8_t *data);
185
Mike Christie7b8631b2006-01-13 18:05:50 -0600186struct iscsi_cls_conn {
187 struct list_head conn_list; /* item in connlist */
188 void *dd_data; /* LLD private data */
189 struct iscsi_transport *transport;
Mike Christieb5c7a122006-04-06 21:13:33 -0500190 uint32_t cid; /* connection id */
Mike Christie22a39fb2011-02-16 15:04:33 -0600191 struct mutex ep_mutex;
192 struct iscsi_endpoint *ep;
Mike Christiefd7255f2006-04-06 21:13:36 -0500193
Mike Christie7b8631b2006-01-13 18:05:50 -0600194 struct device dev; /* sysfs transport/container device */
Mike Christie7b8631b2006-01-13 18:05:50 -0600195};
196
197#define iscsi_dev_to_conn(_dev) \
198 container_of(_dev, struct iscsi_cls_conn, dev)
199
Mike Christie3128c6c2011-07-25 13:48:42 -0500200#define transport_class_to_conn(_cdev) \
201 iscsi_dev_to_conn(_cdev->parent)
202
Mike Christie6eabafb2008-01-31 13:36:43 -0600203#define iscsi_conn_to_session(_conn) \
204 iscsi_dev_to_session(_conn->dev.parent)
205
206/* iscsi class session state */
207enum {
208 ISCSI_SESSION_LOGGED_IN,
209 ISCSI_SESSION_FAILED,
210 ISCSI_SESSION_FREE,
211};
Mike Christie7996a772006-04-06 21:13:41 -0500212
Mike Christie79706342008-05-21 15:54:12 -0500213#define ISCSI_MAX_TARGET -1
214
Mike Christie7b8631b2006-01-13 18:05:50 -0600215struct iscsi_cls_session {
Mike Christie7b7232f2006-02-01 21:06:49 -0600216 struct list_head sess_list; /* item in session_list */
Mike Christie7b8631b2006-01-13 18:05:50 -0600217 struct iscsi_transport *transport;
Mike Christie6eabafb2008-01-31 13:36:43 -0600218 spinlock_t lock;
Mike Christie45ab33b2008-03-04 13:26:55 -0600219 struct work_struct block_work;
220 struct work_struct unblock_work;
Mike Christiebd976f62008-01-31 13:36:46 -0600221 struct work_struct scan_work;
222 struct work_struct unbind_work;
Mike Christiefd7255f2006-04-06 21:13:36 -0500223
Mike Christie30a6c652006-04-06 21:13:39 -0500224 /* recovery fields */
225 int recovery_tmo;
David Howellsc4028952006-11-22 14:57:56 +0000226 struct delayed_work recovery_work;
Mike Christie30a6c652006-04-06 21:13:39 -0500227
Mike Christie79706342008-05-21 15:54:12 -0500228 unsigned int target_id;
Mike Christie8d4a6902011-10-06 03:56:57 -0500229 bool ida_used;
Mike Christie30a6c652006-04-06 21:13:39 -0500230
Mike Christie0c70d842011-12-05 16:44:01 -0600231 /*
232 * pid of userspace process that created session or -1 if
233 * created by the kernel.
234 */
235 pid_t creator;
Mike Christie6eabafb2008-01-31 13:36:43 -0600236 int state;
Mike Christieb5c7a122006-04-06 21:13:33 -0500237 int sid; /* session id */
238 void *dd_data; /* LLD private data */
Mike Christie7b8631b2006-01-13 18:05:50 -0600239 struct device dev; /* sysfs transport/container device */
240};
241
242#define iscsi_dev_to_session(_dev) \
243 container_of(_dev, struct iscsi_cls_session, dev)
244
Mike Christie1d063c12011-07-25 13:48:43 -0500245#define transport_class_to_session(_cdev) \
246 iscsi_dev_to_session(_cdev->parent)
247
Mike Christie7b8631b2006-01-13 18:05:50 -0600248#define iscsi_session_to_shost(_session) \
249 dev_to_shost(_session->dev.parent)
250
Mike Christie8434aa82006-06-28 12:00:30 -0500251#define starget_to_session(_stgt) \
252 iscsi_dev_to_session(_stgt->dev.parent)
253
Mike Christie32c6e1b2008-05-21 15:53:58 -0500254struct iscsi_cls_host {
Mike Christie8aae18a2008-01-31 13:36:48 -0600255 atomic_t nr_scans;
Mike Christie30a6c652006-04-06 21:13:39 -0500256 struct mutex mutex;
Mike Christie90eeb012011-07-25 13:48:50 -0500257 struct request_queue *bsg_q;
Vikas Chaudharyaeddde22012-01-19 03:06:55 -0800258 uint32_t port_speed;
259 uint32_t port_state;
Mike Christie30a6c652006-04-06 21:13:39 -0500260};
261
Mike Christie90eeb012011-07-25 13:48:50 -0500262#define iscsi_job_to_shost(_job) \
263 dev_to_shost(_job->dev)
264
Mike Christiea4804cd2008-05-21 15:54:00 -0500265extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
266 void (*fn)(struct iscsi_cls_session *));
267
Mike Christied82ff9be2008-05-21 15:54:13 -0500268struct iscsi_endpoint {
269 void *dd_data; /* LLD private data */
270 struct device dev;
Mike Christie21536062008-09-24 11:46:11 -0500271 uint64_t id;
Mike Christie22a39fb2011-02-16 15:04:33 -0600272 struct iscsi_cls_conn *conn;
Mike Christied82ff9be2008-05-21 15:54:13 -0500273};
Mike Christiea4804cd2008-05-21 15:54:00 -0500274
Mike Christie8d079132011-07-25 13:48:40 -0500275struct iscsi_iface {
276 struct device dev;
277 struct iscsi_transport *transport;
278 uint32_t iface_type; /* IPv4 or IPv6 */
279 uint32_t iface_num; /* iface number, 0 - n */
280 void *dd_data; /* LLD private data */
281};
282
283#define iscsi_dev_to_iface(_dev) \
284 container_of(_dev, struct iscsi_iface, dev)
285
286#define iscsi_iface_to_shost(_iface) \
287 dev_to_shost(_iface->dev.parent)
288
Mike Christie7b8631b2006-01-13 18:05:50 -0600289/*
290 * session and connection functions that can be used by HW iSCSI LLDs
291 */
Mike Christie322d7392008-01-31 13:36:52 -0600292#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
293 dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
294
295#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
296 dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
297
Mike Christie6eabafb2008-01-31 13:36:43 -0600298extern int iscsi_session_chkready(struct iscsi_cls_session *session);
Manish Rangankar17fa5752011-07-25 13:48:52 -0500299extern int iscsi_is_session_online(struct iscsi_cls_session *session);
Mike Christie8434aa82006-06-28 12:00:30 -0500300extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
Mike Christie5d91e202008-05-21 15:54:01 -0500301 struct iscsi_transport *transport, int dd_size);
Mike Christie6a8a0d32006-06-28 12:00:31 -0500302extern int iscsi_add_session(struct iscsi_cls_session *session,
303 unsigned int target_id);
Mike Christie26974782007-12-13 12:43:29 -0600304extern int iscsi_session_event(struct iscsi_cls_session *session,
305 enum iscsi_uevent_e event);
Mike Christie7b8631b2006-01-13 18:05:50 -0600306extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
Mike Christie6a8a0d32006-06-28 12:00:31 -0500307 struct iscsi_transport *t,
Mike Christie5d91e202008-05-21 15:54:01 -0500308 int dd_size,
Mike Christie6a8a0d32006-06-28 12:00:31 -0500309 unsigned int target_id);
Mike Christie8434aa82006-06-28 12:00:30 -0500310extern void iscsi_remove_session(struct iscsi_cls_session *session);
311extern void iscsi_free_session(struct iscsi_cls_session *session);
Mike Christie7b8631b2006-01-13 18:05:50 -0600312extern int iscsi_destroy_session(struct iscsi_cls_session *session);
313extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
Mike Christie5d91e202008-05-21 15:54:01 -0500314 int dd_size, uint32_t cid);
Mike Christie7b8631b2006-01-13 18:05:50 -0600315extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
Mike Christie30a6c652006-04-06 21:13:39 -0500316extern void iscsi_unblock_session(struct iscsi_cls_session *session);
317extern void iscsi_block_session(struct iscsi_cls_session *session);
Mike Christie8aae18a2008-01-31 13:36:48 -0600318extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
Mike Christied82ff9be2008-05-21 15:54:13 -0500319extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
320extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
321extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
Mike Christiec01be6d2010-07-22 16:59:49 +0530322extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
Mike Christie8d079132011-07-25 13:48:40 -0500323extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost,
324 struct iscsi_transport *t,
325 uint32_t iface_type,
326 uint32_t iface_num, int dd_size);
327extern void iscsi_destroy_iface(struct iscsi_iface *iface);
328extern struct iscsi_iface *iscsi_lookup_iface(int handle);
Vikas Chaudharyaeddde22012-01-19 03:06:55 -0800329extern char *iscsi_get_port_speed_name(struct Scsi_Host *shost);
330extern char *iscsi_get_port_state_name(struct Scsi_Host *shost);
Nilesh Javali6260a5d2012-02-27 03:08:51 -0800331extern int iscsi_is_session_dev(const struct device *dev);
Mike Christie53cb8a12006-06-28 12:00:32 -0500332
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333#endif