blob: b50aabe2861e1d469d84f2dceb029bd9bf7a1d7d [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 Christie7b8631b2006-01-13 18:05:50 -060035struct iscsi_cls_conn;
Mike Christie7996a772006-04-06 21:13:41 -050036struct iscsi_conn;
Mike Christie9c19a7d2008-05-21 15:54:09 -050037struct iscsi_task;
Mike Christiea54a52c2006-06-28 12:00:23 -050038struct sockaddr;
Mike Christie7b8631b2006-01-13 18:05:50 -060039
Alex Aizman39e84792005-08-04 19:31:00 -070040/**
41 * struct iscsi_transport - iSCSI Transport template
42 *
43 * @name: transport name
44 * @caps: iSCSI Data-Path capabilities
45 * @create_session: create new iSCSI session object
46 * @destroy_session: destroy existing iSCSI session object
47 * @create_conn: create new iSCSI connection
48 * @bind_conn: associate this connection with existing iSCSI session
49 * and specified transport descriptor
50 * @destroy_conn: destroy inactive iSCSI connection
Mike Christiea54a52c2006-06-28 12:00:23 -050051 * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
52 * when param is not supported, and a -Exx value on other
53 * error.
54 * @get_param get iSCSI parameter. Must return number of bytes
55 * copied to buffer on success, -ENODATA when param
56 * is not supported, and a -Exx value on other error
Alex Aizman39e84792005-08-04 19:31:00 -070057 * @start_conn: set connection to be operational
58 * @stop_conn: suspend/recover/terminate connection
59 * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
Mike Christie7996a772006-04-06 21:13:41 -050060 * @session_recovery_timedout: notify LLD a block during recovery timed out
Mike Christie3e5c28a2008-05-21 15:54:06 -050061 * @init_task: Initialize a iscsi_task and any internal structs.
62 * When offloading the data path, this is called from
63 * queuecommand with the session lock, or from the
64 * iscsi_conn_send_pdu context with the session lock.
65 * When not offloading the data path, this is called
66 * from the scsi work queue without the session lock.
67 * @xmit_task Requests LLD to transfer cmd task. Returns 0 or the
Mike Christie3219e522006-05-30 00:37:28 -050068 * the number of bytes transferred on success, and -Exyz
Mike Christie3e5c28a2008-05-21 15:54:06 -050069 * value on error. When offloading the data path, this
70 * is called from queuecommand with the session lock, or
71 * from the iscsi_conn_send_pdu context with the session
72 * lock. When not offloading the data path, this is called
73 * from the scsi work queue without the session lock.
74 * @cleanup_task: requests LLD to fail task. Called with session lock
75 * and after the connection has been suspended and
76 * terminated during recovery. If called
Mike Christie7996a772006-04-06 21:13:41 -050077 * from abort task then connection is not suspended
78 * or terminated but sk_callback_lock is held
Alex Aizman39e84792005-08-04 19:31:00 -070079 *
80 * Template API provided by iSCSI Transport
81 */
82struct iscsi_transport {
83 struct module *owner;
84 char *name;
85 unsigned int caps;
Mike Christiefd7255f2006-04-06 21:13:36 -050086 /* LLD sets this to indicate what values it can export to sysfs */
Mike Christie1819dc82007-05-30 12:57:08 -050087 uint64_t param_mask;
88 uint64_t host_param_mask;
Mike Christied82ff9be2008-05-21 15:54:13 -050089 struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep,
Mike Christie75613522008-05-21 15:53:59 -050090 uint16_t cmds_max, uint16_t qdepth,
91 uint32_t sn, uint32_t *hn);
Mike Christie7b7232f2006-02-01 21:06:49 -060092 void (*destroy_session) (struct iscsi_cls_session *session);
93 struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
Mike Christie7b8631b2006-01-13 18:05:50 -060094 uint32_t cid);
Mike Christie7b7232f2006-02-01 21:06:49 -060095 int (*bind_conn) (struct iscsi_cls_session *session,
96 struct iscsi_cls_conn *cls_conn,
Or Gerlitz264faaa2006-05-02 19:46:36 -050097 uint64_t transport_eph, int is_leading);
Mike Christie7b7232f2006-02-01 21:06:49 -060098 int (*start_conn) (struct iscsi_cls_conn *conn);
99 void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
Mike Christie7b8631b2006-01-13 18:05:50 -0600100 void (*destroy_conn) (struct iscsi_cls_conn *conn);
Mike Christie7b7232f2006-02-01 21:06:49 -0600101 int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
Mike Christiea54a52c2006-06-28 12:00:23 -0500102 char *buf, int buflen);
Mike Christie7b7232f2006-02-01 21:06:49 -0600103 int (*get_conn_param) (struct iscsi_cls_conn *conn,
Mike Christiea54a52c2006-06-28 12:00:23 -0500104 enum iscsi_param param, char *buf);
Mike Christie7b7232f2006-02-01 21:06:49 -0600105 int (*get_session_param) (struct iscsi_cls_session *session,
Mike Christiea54a52c2006-06-28 12:00:23 -0500106 enum iscsi_param param, char *buf);
Mike Christie1819dc82007-05-30 12:57:08 -0500107 int (*get_host_param) (struct Scsi_Host *shost,
108 enum iscsi_host_param param, char *buf);
Mike Christie1d9bf132007-05-30 12:57:11 -0500109 int (*set_host_param) (struct Scsi_Host *shost,
110 enum iscsi_host_param param, char *buf,
111 int buflen);
Mike Christie7b7232f2006-02-01 21:06:49 -0600112 int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
Alex Aizman39e84792005-08-04 19:31:00 -0700113 char *data, uint32_t data_size);
Mike Christie7b7232f2006-02-01 21:06:49 -0600114 void (*get_stats) (struct iscsi_cls_conn *conn,
115 struct iscsi_stats *stats);
Mike Christie577577d2008-12-02 00:32:05 -0600116
Mike Christie9c19a7d2008-05-21 15:54:09 -0500117 int (*init_task) (struct iscsi_task *task);
118 int (*xmit_task) (struct iscsi_task *task);
Mike Christie577577d2008-12-02 00:32:05 -0600119 void (*cleanup_task) (struct iscsi_task *task);
120
Mike Christie2ff79d52008-12-02 00:32:14 -0600121 int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode);
Mike Christie577577d2008-12-02 00:32:05 -0600122 int (*xmit_pdu) (struct iscsi_task *task);
123 int (*init_pdu) (struct iscsi_task *task, unsigned int offset,
124 unsigned int count);
Mike Christie262ef632008-12-02 00:32:13 -0600125 void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt,
126 int *index, int *age);
127
Mike Christie30a6c652006-04-06 21:13:39 -0500128 void (*session_recovery_timedout) (struct iscsi_cls_session *session);
Mike Christied82ff9be2008-05-21 15:54:13 -0500129 struct iscsi_endpoint *(*ep_connect) (struct sockaddr *dst_addr,
130 int non_blocking);
131 int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms);
132 void (*ep_disconnect) (struct iscsi_endpoint *ep);
Mike Christie2174a042007-05-30 12:57:10 -0500133 int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
Mike Christie01cb2252006-06-28 12:00:22 -0500134 uint32_t enable, struct sockaddr *dst_addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135};
136
137/*
Alex Aizman39e84792005-08-04 19:31:00 -0700138 * transport registration upcalls
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 */
Mike Christie7b8631b2006-01-13 18:05:50 -0600140extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
Alex Aizman39e84792005-08-04 19:31:00 -0700141extern int iscsi_unregister_transport(struct iscsi_transport *tt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
143/*
Alex Aizman39e84792005-08-04 19:31:00 -0700144 * control plane upcalls
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 */
Mike Christiee5bd7b52008-09-24 11:46:10 -0500146extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
147 enum iscsi_err error);
Mike Christie7b7232f2006-02-01 21:06:49 -0600148extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
Alex Aizman39e84792005-08-04 19:31:00 -0700149 char *data, uint32_t data_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Mike Christie7b8631b2006-01-13 18:05:50 -0600151struct iscsi_cls_conn {
152 struct list_head conn_list; /* item in connlist */
153 void *dd_data; /* LLD private data */
154 struct iscsi_transport *transport;
Mike Christieb5c7a122006-04-06 21:13:33 -0500155 uint32_t cid; /* connection id */
Mike Christiefd7255f2006-04-06 21:13:36 -0500156
Mike Christie7b8631b2006-01-13 18:05:50 -0600157 int active; /* must be accessed with the connlock */
158 struct device dev; /* sysfs transport/container device */
Mike Christie7b8631b2006-01-13 18:05:50 -0600159};
160
161#define iscsi_dev_to_conn(_dev) \
162 container_of(_dev, struct iscsi_cls_conn, dev)
163
Mike Christie6eabafb2008-01-31 13:36:43 -0600164#define iscsi_conn_to_session(_conn) \
165 iscsi_dev_to_session(_conn->dev.parent)
166
167/* iscsi class session state */
168enum {
169 ISCSI_SESSION_LOGGED_IN,
170 ISCSI_SESSION_FAILED,
171 ISCSI_SESSION_FREE,
172};
Mike Christie7996a772006-04-06 21:13:41 -0500173
Mike Christie79706342008-05-21 15:54:12 -0500174#define ISCSI_MAX_TARGET -1
175
Mike Christie7b8631b2006-01-13 18:05:50 -0600176struct iscsi_cls_session {
Mike Christie7b7232f2006-02-01 21:06:49 -0600177 struct list_head sess_list; /* item in session_list */
Mike Christie7b8631b2006-01-13 18:05:50 -0600178 struct iscsi_transport *transport;
Mike Christie6eabafb2008-01-31 13:36:43 -0600179 spinlock_t lock;
Mike Christie45ab33b2008-03-04 13:26:55 -0600180 struct work_struct block_work;
181 struct work_struct unblock_work;
Mike Christiebd976f62008-01-31 13:36:46 -0600182 struct work_struct scan_work;
183 struct work_struct unbind_work;
Mike Christiefd7255f2006-04-06 21:13:36 -0500184
Mike Christie30a6c652006-04-06 21:13:39 -0500185 /* recovery fields */
186 int recovery_tmo;
David Howellsc4028952006-11-22 14:57:56 +0000187 struct delayed_work recovery_work;
Mike Christie30a6c652006-04-06 21:13:39 -0500188
Mike Christie79706342008-05-21 15:54:12 -0500189 unsigned int target_id;
Mike Christie30a6c652006-04-06 21:13:39 -0500190
Mike Christie6eabafb2008-01-31 13:36:43 -0600191 int state;
Mike Christieb5c7a122006-04-06 21:13:33 -0500192 int sid; /* session id */
193 void *dd_data; /* LLD private data */
Mike Christie7b8631b2006-01-13 18:05:50 -0600194 struct device dev; /* sysfs transport/container device */
195};
196
197#define iscsi_dev_to_session(_dev) \
198 container_of(_dev, struct iscsi_cls_session, dev)
199
200#define iscsi_session_to_shost(_session) \
201 dev_to_shost(_session->dev.parent)
202
Mike Christie8434aa82006-06-28 12:00:30 -0500203#define starget_to_session(_stgt) \
204 iscsi_dev_to_session(_stgt->dev.parent)
205
Mike Christie32c6e1b2008-05-21 15:53:58 -0500206struct iscsi_cls_host {
Mike Christie8aae18a2008-01-31 13:36:48 -0600207 atomic_t nr_scans;
Mike Christie30a6c652006-04-06 21:13:39 -0500208 struct mutex mutex;
Mike Christiebd976f62008-01-31 13:36:46 -0600209 struct workqueue_struct *scan_workq;
Kay Sieversaab0de22008-05-02 06:02:41 +0200210 char scan_workq_name[20];
Mike Christie30a6c652006-04-06 21:13:39 -0500211};
212
Mike Christiea4804cd2008-05-21 15:54:00 -0500213extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
214 void (*fn)(struct iscsi_cls_session *));
215
Mike Christied82ff9be2008-05-21 15:54:13 -0500216struct iscsi_endpoint {
217 void *dd_data; /* LLD private data */
218 struct device dev;
Mike Christie21536062008-09-24 11:46:11 -0500219 uint64_t id;
Mike Christied82ff9be2008-05-21 15:54:13 -0500220};
Mike Christiea4804cd2008-05-21 15:54:00 -0500221
Mike Christie7b8631b2006-01-13 18:05:50 -0600222/*
223 * session and connection functions that can be used by HW iSCSI LLDs
224 */
Mike Christie322d7392008-01-31 13:36:52 -0600225#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
226 dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
227
228#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
229 dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
230
Mike Christie6eabafb2008-01-31 13:36:43 -0600231extern int iscsi_session_chkready(struct iscsi_cls_session *session);
Mike Christie8434aa82006-06-28 12:00:30 -0500232extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
Mike Christie5d91e202008-05-21 15:54:01 -0500233 struct iscsi_transport *transport, int dd_size);
Mike Christie6a8a0d32006-06-28 12:00:31 -0500234extern int iscsi_add_session(struct iscsi_cls_session *session,
235 unsigned int target_id);
Mike Christie26974782007-12-13 12:43:29 -0600236extern int iscsi_session_event(struct iscsi_cls_session *session,
237 enum iscsi_uevent_e event);
Mike Christie7b8631b2006-01-13 18:05:50 -0600238extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
Mike Christie6a8a0d32006-06-28 12:00:31 -0500239 struct iscsi_transport *t,
Mike Christie5d91e202008-05-21 15:54:01 -0500240 int dd_size,
Mike Christie6a8a0d32006-06-28 12:00:31 -0500241 unsigned int target_id);
Mike Christie8434aa82006-06-28 12:00:30 -0500242extern void iscsi_remove_session(struct iscsi_cls_session *session);
243extern void iscsi_free_session(struct iscsi_cls_session *session);
Mike Christie7b8631b2006-01-13 18:05:50 -0600244extern int iscsi_destroy_session(struct iscsi_cls_session *session);
245extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
Mike Christie5d91e202008-05-21 15:54:01 -0500246 int dd_size, uint32_t cid);
Mike Christie7b8631b2006-01-13 18:05:50 -0600247extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
Mike Christie30a6c652006-04-06 21:13:39 -0500248extern void iscsi_unblock_session(struct iscsi_cls_session *session);
249extern void iscsi_block_session(struct iscsi_cls_session *session);
Mike Christie8aae18a2008-01-31 13:36:48 -0600250extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
Mike Christied82ff9be2008-05-21 15:54:13 -0500251extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
252extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
253extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
Mike Christie53cb8a12006-06-28 12:00:32 -0500254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255#endif