]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/scsi/scsi_transport_iscsi.h
NFS: Determine initial mount security
[mirror_ubuntu-zesty-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;
7b8631b5 40
39e84790
AA
41/**
42 * struct iscsi_transport - iSCSI Transport template
43 *
44 * @name: transport name
45 * @caps: iSCSI Data-Path capabilities
46 * @create_session: create new iSCSI session object
47 * @destroy_session: destroy existing iSCSI session object
48 * @create_conn: create new iSCSI connection
49 * @bind_conn: associate this connection with existing iSCSI session
50 * and specified transport descriptor
51 * @destroy_conn: destroy inactive iSCSI connection
a54a52ca
MC
52 * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
53 * when param is not supported, and a -Exx value on other
54 * error.
55 * @get_param get iSCSI parameter. Must return number of bytes
56 * copied to buffer on success, -ENODATA when param
57 * is not supported, and a -Exx value on other error
39e84790
AA
58 * @start_conn: set connection to be operational
59 * @stop_conn: suspend/recover/terminate connection
60 * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
7996a778 61 * @session_recovery_timedout: notify LLD a block during recovery timed out
3e5c28ad
MC
62 * @init_task: Initialize a iscsi_task and any internal structs.
63 * When offloading the data path, this is called from
64 * queuecommand with the session lock, or from the
65 * iscsi_conn_send_pdu context with the session lock.
66 * When not offloading the data path, this is called
67 * from the scsi work queue without the session lock.
68 * @xmit_task Requests LLD to transfer cmd task. Returns 0 or the
3219e529 69 * the number of bytes transferred on success, and -Exyz
3e5c28ad
MC
70 * value on error. When offloading the data path, this
71 * is called from queuecommand with the session lock, or
72 * from the iscsi_conn_send_pdu context with the session
73 * lock. When not offloading the data path, this is called
74 * from the scsi work queue without the session lock.
75 * @cleanup_task: requests LLD to fail task. Called with session lock
76 * and after the connection has been suspended and
77 * terminated during recovery. If called
7996a778
MC
78 * from abort task then connection is not suspended
79 * or terminated but sk_callback_lock is held
39e84790
AA
80 *
81 * Template API provided by iSCSI Transport
82 */
83struct iscsi_transport {
84 struct module *owner;
85 char *name;
86 unsigned int caps;
fd7255f5 87 /* LLD sets this to indicate what values it can export to sysfs */
1819dc81
MC
88 uint64_t param_mask;
89 uint64_t host_param_mask;
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);
1da177e4
LT
140};
141
142/*
39e84790 143 * transport registration upcalls
1da177e4 144 */
7b8631b5 145extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
39e84790 146extern int iscsi_unregister_transport(struct iscsi_transport *tt);
1da177e4
LT
147
148/*
39e84790 149 * control plane upcalls
1da177e4 150 */
e5bd7b54
MC
151extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
152 enum iscsi_err error);
7b7232f3 153extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
39e84790 154 char *data, uint32_t data_size);
1da177e4 155
43514774
MC
156extern int iscsi_offload_mesg(struct Scsi_Host *shost,
157 struct iscsi_transport *transport, uint32_t type,
158 char *data, uint16_t data_size);
159
7b8631b5
MC
160struct iscsi_cls_conn {
161 struct list_head conn_list; /* item in connlist */
162 void *dd_data; /* LLD private data */
163 struct iscsi_transport *transport;
b5c7a12d 164 uint32_t cid; /* connection id */
22a39fbb
MC
165 struct mutex ep_mutex;
166 struct iscsi_endpoint *ep;
fd7255f5 167
7b8631b5 168 struct device dev; /* sysfs transport/container device */
7b8631b5
MC
169};
170
171#define iscsi_dev_to_conn(_dev) \
172 container_of(_dev, struct iscsi_cls_conn, dev)
173
6eabafbe
MC
174#define iscsi_conn_to_session(_conn) \
175 iscsi_dev_to_session(_conn->dev.parent)
176
177/* iscsi class session state */
178enum {
179 ISCSI_SESSION_LOGGED_IN,
180 ISCSI_SESSION_FAILED,
181 ISCSI_SESSION_FREE,
182};
7996a778 183
7970634b
MC
184#define ISCSI_MAX_TARGET -1
185
7b8631b5 186struct iscsi_cls_session {
7b7232f3 187 struct list_head sess_list; /* item in session_list */
7b8631b5 188 struct iscsi_transport *transport;
6eabafbe 189 spinlock_t lock;
45ab33b6
MC
190 struct work_struct block_work;
191 struct work_struct unblock_work;
bd976f62
MC
192 struct work_struct scan_work;
193 struct work_struct unbind_work;
fd7255f5 194
30a6c652
MC
195 /* recovery fields */
196 int recovery_tmo;
c4028958 197 struct delayed_work recovery_work;
30a6c652 198
7970634b 199 unsigned int target_id;
30a6c652 200
6eabafbe 201 int state;
b5c7a12d
MC
202 int sid; /* session id */
203 void *dd_data; /* LLD private data */
7b8631b5
MC
204 struct device dev; /* sysfs transport/container device */
205};
206
207#define iscsi_dev_to_session(_dev) \
208 container_of(_dev, struct iscsi_cls_session, dev)
209
210#define iscsi_session_to_shost(_session) \
211 dev_to_shost(_session->dev.parent)
212
8434aa8b
MC
213#define starget_to_session(_stgt) \
214 iscsi_dev_to_session(_stgt->dev.parent)
215
32c6e1b9 216struct iscsi_cls_host {
8aae18ad 217 atomic_t nr_scans;
30a6c652
MC
218 struct mutex mutex;
219};
220
a4804cd6
MC
221extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
222 void (*fn)(struct iscsi_cls_session *));
223
d82ff9be
MC
224struct iscsi_endpoint {
225 void *dd_data; /* LLD private data */
226 struct device dev;
21536062 227 uint64_t id;
22a39fbb 228 struct iscsi_cls_conn *conn;
d82ff9be 229};
a4804cd6 230
7b8631b5
MC
231/*
232 * session and connection functions that can be used by HW iSCSI LLDs
233 */
322d739d
MC
234#define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
235 dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
236
237#define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
238 dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
239
6eabafbe 240extern int iscsi_session_chkready(struct iscsi_cls_session *session);
8434aa8b 241extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
5d91e209 242 struct iscsi_transport *transport, int dd_size);
6a8a0d36
MC
243extern int iscsi_add_session(struct iscsi_cls_session *session,
244 unsigned int target_id);
26974789
MC
245extern int iscsi_session_event(struct iscsi_cls_session *session,
246 enum iscsi_uevent_e event);
7b8631b5 247extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
6a8a0d36 248 struct iscsi_transport *t,
5d91e209 249 int dd_size,
6a8a0d36 250 unsigned int target_id);
8434aa8b
MC
251extern void iscsi_remove_session(struct iscsi_cls_session *session);
252extern void iscsi_free_session(struct iscsi_cls_session *session);
7b8631b5
MC
253extern int iscsi_destroy_session(struct iscsi_cls_session *session);
254extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
5d91e209 255 int dd_size, uint32_t cid);
7b8631b5 256extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
30a6c652
MC
257extern void iscsi_unblock_session(struct iscsi_cls_session *session);
258extern void iscsi_block_session(struct iscsi_cls_session *session);
8aae18ad 259extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
d82ff9be
MC
260extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
261extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
262extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
c01be6dc 263extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
53cb8a1f 264
1da177e4 265#endif