]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/scsi/scsi_transport_iscsi.h
[SCSI] aacraid: use lower snprintf() limit
[mirror_ubuntu-bionic-kernel.git] / include / scsi / scsi_transport_iscsi.h
CommitLineData
39e84790 1/*
1da177e4
LT
2 * iSCSI transport class definitions
3 *
4 * Copyright (C) IBM Corporation, 2004
7996a778 5 * Copyright (C) Mike Christie, 2004 - 2006
39e84790
AA
6 * Copyright (C) Dmitry Yusupov, 2004 - 2005
7 * Copyright (C) Alex Aizman, 2004 - 2005
1da177e4
LT
8 *
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
7b8631b5 26#include <linux/device.h>
d773c082
MT
27#include <linux/list.h>
28#include <linux/mutex.h>
39e84790 29#include <scsi/iscsi_if.h>
1da177e4 30
7b8631b5 31struct scsi_transport_template;
7996a778 32struct iscsi_transport;
d82ff9be 33struct iscsi_endpoint;
7b8631b5 34struct Scsi_Host;
c01be6dc 35struct scsi_cmnd;
7b8631b5 36struct iscsi_cls_conn;
7996a778 37struct iscsi_conn;
9c19a7d0 38struct iscsi_task;
a54a52ca 39struct sockaddr;
8d07913d 40struct iscsi_iface;
90eeb01a 41struct bsg_job;
7b8631b5 42
39e84790
AA
43/**
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
a54a52ca
MC
54 * @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
39e84790
AA
60 * @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.
7996a778 63 * @session_recovery_timedout: notify LLD a block during recovery timed out
3e5c28ad
MC
64 * @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
3219e529 71 * the number of bytes transferred on success, and -Exyz
3e5c28ad
MC
72 * 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
7996a778
MC
80 * from abort task then connection is not suspended
81 * or terminated but sk_callback_lock is held
39e84790
AA
82 *
83 * Template API provided by iSCSI Transport
84 */
85struct iscsi_transport {
86 struct module *owner;
87 char *name;
88 unsigned int caps;
8d07913d 89
d82ff9be 90 struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep,
75613521 91 uint16_t cmds_max, uint16_t qdepth,
5e7facb7 92 uint32_t sn);
7b7232f3
MC
93 void (*destroy_session) (struct iscsi_cls_session *session);
94 struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
7b8631b5 95 uint32_t cid);
7b7232f3
MC
96 int (*bind_conn) (struct iscsi_cls_session *session,
97 struct iscsi_cls_conn *cls_conn,
264faaaa 98 uint64_t transport_eph, int is_leading);
7b7232f3
MC
99 int (*start_conn) (struct iscsi_cls_conn *conn);
100 void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
7b8631b5 101 void (*destroy_conn) (struct iscsi_cls_conn *conn);
7b7232f3 102 int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
a54a52ca 103 char *buf, int buflen);
289324b0
MC
104 int (*get_ep_param) (struct iscsi_endpoint *ep, enum iscsi_param param,
105 char *buf);
7b7232f3 106 int (*get_conn_param) (struct iscsi_cls_conn *conn,
a54a52ca 107 enum iscsi_param param, char *buf);
7b7232f3 108 int (*get_session_param) (struct iscsi_cls_session *session,
a54a52ca 109 enum iscsi_param param, char *buf);
1819dc81
MC
110 int (*get_host_param) (struct Scsi_Host *shost,
111 enum iscsi_host_param param, char *buf);
1d9bf13a
MC
112 int (*set_host_param) (struct Scsi_Host *shost,
113 enum iscsi_host_param param, char *buf,
114 int buflen);
7b7232f3 115 int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
39e84790 116 char *data, uint32_t data_size);
7b7232f3
MC
117 void (*get_stats) (struct iscsi_cls_conn *conn,
118 struct iscsi_stats *stats);
577577da 119
9c19a7d0
MC
120 int (*init_task) (struct iscsi_task *task);
121 int (*xmit_task) (struct iscsi_task *task);
577577da
MC
122 void (*cleanup_task) (struct iscsi_task *task);
123
2ff79d52 124 int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode);
577577da
MC
125 int (*xmit_pdu) (struct iscsi_task *task);
126 int (*init_pdu) (struct iscsi_task *task, unsigned int offset,
127 unsigned int count);
262ef636
MC
128 void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt,
129 int *index, int *age);
130
30a6c652 131 void (*session_recovery_timedout) (struct iscsi_cls_session *session);
10eb0f01
MC
132 struct iscsi_endpoint *(*ep_connect) (struct Scsi_Host *shost,
133 struct sockaddr *dst_addr,
d82ff9be
MC
134 int non_blocking);
135 int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms);
136 void (*ep_disconnect) (struct iscsi_endpoint *ep);
2174a04e 137 int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
01cb225d 138 uint32_t enable, struct sockaddr *dst_addr);
43514774 139 int (*set_path) (struct Scsi_Host *shost, struct iscsi_path *params);
56c155b5 140 int (*set_iface_param) (struct Scsi_Host *shost, char *data, int count);
8d07913d
MC
141 int (*get_iface_param) (struct iscsi_iface *iface,
142 enum iscsi_param_type param_type,
143 int param, char *buf);
3128c6c7 144 mode_t (*attr_is_visible)(int param_type, int param);
90eeb01a 145 int (*bsg_request)(struct bsg_job *job);
1da177e4
LT
146};
147
148/*
39e84790 149 * transport registration upcalls
1da177e4 150 */
7b8631b5 151extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
39e84790 152extern int iscsi_unregister_transport(struct iscsi_transport *tt);
1da177e4
LT
153
154/*
39e84790 155 * control plane upcalls
1da177e4 156 */
e5bd7b54
MC
157extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
158 enum iscsi_err error);
17fa575e
MR
159extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn,
160 enum iscsi_conn_state state);
7b7232f3 161extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
39e84790 162 char *data, uint32_t data_size);
1da177e4 163
43514774
MC
164extern int iscsi_offload_mesg(struct Scsi_Host *shost,
165 struct iscsi_transport *transport, uint32_t type,
166 char *data, uint16_t data_size);
167
7b8631b5
MC
168struct iscsi_cls_conn {
169 struct list_head conn_list; /* item in connlist */
170 void *dd_data; /* LLD private data */
171 struct iscsi_transport *transport;
b5c7a12d 172 uint32_t cid; /* connection id */
22a39fbb
MC
173 struct mutex ep_mutex;
174 struct iscsi_endpoint *ep;
fd7255f5 175
7b8631b5 176 struct device dev; /* sysfs transport/container device */
7b8631b5
MC
177};
178
179#define iscsi_dev_to_conn(_dev) \
180 container_of(_dev, struct iscsi_cls_conn, dev)
181
3128c6c7
MC
182#define transport_class_to_conn(_cdev) \
183 iscsi_dev_to_conn(_cdev->parent)
184
6eabafbe
MC
185#define iscsi_conn_to_session(_conn) \
186 iscsi_dev_to_session(_conn->dev.parent)
187
188/* iscsi class session state */
189enum {
190 ISCSI_SESSION_LOGGED_IN,
191 ISCSI_SESSION_FAILED,
192 ISCSI_SESSION_FREE,
193};
7996a778 194
7970634b
MC
195#define ISCSI_MAX_TARGET -1
196
7b8631b5 197struct iscsi_cls_session {
7b7232f3 198 struct list_head sess_list; /* item in session_list */
7b8631b5 199 struct iscsi_transport *transport;
6eabafbe 200 spinlock_t lock;
45ab33b6
MC
201 struct work_struct block_work;
202 struct work_struct unblock_work;
bd976f62
MC
203 struct work_struct scan_work;
204 struct work_struct unbind_work;
fd7255f5 205
30a6c652
MC
206 /* recovery fields */
207 int recovery_tmo;
c4028958 208 struct delayed_work recovery_work;
30a6c652 209
7970634b 210 unsigned int target_id;
30a6c652 211
6eabafbe 212 int state;
b5c7a12d
MC
213 int sid; /* session id */
214 void *dd_data; /* LLD private data */
7b8631b5
MC
215 struct device dev; /* sysfs transport/container device */
216};
217
218#define iscsi_dev_to_session(_dev) \
219 container_of(_dev, struct iscsi_cls_session, dev)
220
1d063c17
MC
221#define transport_class_to_session(_cdev) \
222 iscsi_dev_to_session(_cdev->parent)
223
7b8631b5
MC
224#define iscsi_session_to_shost(_session) \
225 dev_to_shost(_session->dev.parent)
226
8434aa8b
MC
227#define starget_to_session(_stgt) \
228 iscsi_dev_to_session(_stgt->dev.parent)
229
32c6e1b9 230struct iscsi_cls_host {
8aae18ad 231 atomic_t nr_scans;
30a6c652 232 struct mutex mutex;
90eeb01a 233 struct request_queue *bsg_q;
30a6c652
MC
234};
235
90eeb01a
MC
236#define iscsi_job_to_shost(_job) \
237 dev_to_shost(_job->dev)
238
a4804cd6
MC
239extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
240 void (*fn)(struct iscsi_cls_session *));
241
d82ff9be
MC
242struct iscsi_endpoint {
243 void *dd_data; /* LLD private data */
244 struct device dev;
21536062 245 uint64_t id;
22a39fbb 246 struct iscsi_cls_conn *conn;
d82ff9be 247};
a4804cd6 248
8d07913d
MC
249struct iscsi_iface {
250 struct device dev;
251 struct iscsi_transport *transport;
252 uint32_t iface_type; /* IPv4 or IPv6 */
253 uint32_t iface_num; /* iface number, 0 - n */
254 void *dd_data; /* LLD private data */
255};
256
257#define iscsi_dev_to_iface(_dev) \
258 container_of(_dev, struct iscsi_iface, dev)
259
260#define iscsi_iface_to_shost(_iface) \
261 dev_to_shost(_iface->dev.parent)
262
7b8631b5
MC
263/*
264 * session and connection functions that can be used by HW iSCSI LLDs
265 */
322d739d
MC
266#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
267 dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
268
269#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
270 dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
271
6eabafbe 272extern int iscsi_session_chkready(struct iscsi_cls_session *session);
17fa575e 273extern int iscsi_is_session_online(struct iscsi_cls_session *session);
8434aa8b 274extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
5d91e209 275 struct iscsi_transport *transport, int dd_size);
6a8a0d36
MC
276extern int iscsi_add_session(struct iscsi_cls_session *session,
277 unsigned int target_id);
26974789
MC
278extern int iscsi_session_event(struct iscsi_cls_session *session,
279 enum iscsi_uevent_e event);
7b8631b5 280extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
6a8a0d36 281 struct iscsi_transport *t,
5d91e209 282 int dd_size,
6a8a0d36 283 unsigned int target_id);
8434aa8b
MC
284extern void iscsi_remove_session(struct iscsi_cls_session *session);
285extern void iscsi_free_session(struct iscsi_cls_session *session);
7b8631b5
MC
286extern int iscsi_destroy_session(struct iscsi_cls_session *session);
287extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
5d91e209 288 int dd_size, uint32_t cid);
7b8631b5 289extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
30a6c652
MC
290extern void iscsi_unblock_session(struct iscsi_cls_session *session);
291extern void iscsi_block_session(struct iscsi_cls_session *session);
8aae18ad 292extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
d82ff9be
MC
293extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
294extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
295extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
c01be6dc 296extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
8d07913d
MC
297extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost,
298 struct iscsi_transport *t,
299 uint32_t iface_type,
300 uint32_t iface_num, int dd_size);
301extern void iscsi_destroy_iface(struct iscsi_iface *iface);
302extern struct iscsi_iface *iscsi_lookup_iface(int handle);
53cb8a1f 303
1da177e4 304#endif