Removed SRP_CRED_REQ support again.
[mirror/scst/.git] / srpt / src / ib_srpt.h
1 /*
2  * Copyright (c) 2006 - 2009 Mellanox Technology Inc.  All rights reserved.
3  *
4  * This software is available to you under a choice of one of two
5  * licenses.  You may choose to be licensed under the terms of the GNU
6  * General Public License (GPL) Version 2, available from the file
7  * COPYING in the main directory of this source tree, or the
8  * OpenIB.org BSD license below:
9  *
10  *     Redistribution and use in source and binary forms, with or
11  *     without modification, are permitted provided that the following
12  *     conditions are met:
13  *
14  *      - Redistributions of source code must retain the above
15  *        copyright notice, this list of conditions and the following
16  *        disclaimer.
17  *
18  *      - Redistributions in binary form must reproduce the above
19  *        copyright notice, this list of conditions and the following
20  *        disclaimer in the documentation and/or other materials
21  *        provided with the distribution.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30  * SOFTWARE.
31  *
32  */
33
34 #ifndef IB_SRPT_H
35 #define IB_SRPT_H
36
37 #include <linux/version.h>
38 #include <linux/types.h>
39 #include <linux/list.h>
40 #include <linux/mutex.h>
41
42 #include <rdma/ib_verbs.h>
43 #include <rdma/ib_sa.h>
44 #include <rdma/ib_cm.h>
45
46 #include <scsi/srp.h>
47
48 #include <scst.h>
49
50 #include "ib_dm_mad.h"
51
52 /*
53  * The prefix the ServiceName field of the ServiceName/ServiceID pair in the
54  * device management ServiceEntries attribute pair must start with, as specified
55  * in the SRP r16a document.
56  */
57 #define SRP_SERVICE_NAME_PREFIX         "SRP.T10:"
58
59 enum {
60         /*
61          * SRP IOControllerProfile attributes for SRP target ports that have
62          * not been defined in <scsi/srp.h>. Source: section B.7, table B.7
63          * in the T10 SRP r16a document.
64          */
65         SRP_PROTOCOL = 0x0108,
66         SRP_PROTOCOL_VERSION = 0x0001,
67         SRP_IO_SUBCLASS = 0x609e,
68         SRP_SEND_TO_IOC = 0x01,
69         SRP_SEND_FROM_IOC = 0x02,
70         SRP_RDMA_READ_FROM_IOC = 0x08,
71         SRP_RDMA_WRITE_FROM_IOC = 0x20,
72
73         /*
74          * srp_login_cmd::req_flags bitmasks. See also table 9 in the T10 r16a
75          * document.
76          */
77         SRP_MTCH_ACTION = 0x03, /* MULTI-CHANNEL ACTION */
78         SRP_LOSOLNT = 0x10, /* logout solicited notification */
79         SRP_CRSOLNT = 0x20, /* credit request solicited notification */
80         SRP_AESOLNT = 0x40, /* asynchronous event solicited notification */
81
82         /*
83          * srp_cmd::sol_nt / srp_tsk_mgmt::sol_not bitmasks. See also tables
84          * 18 and 20 in the T10 r16a document.
85          */
86         SRP_SCSOLNT = 0x02, /* SCSOLNT = successful solicited notification */
87         SRP_UCSOLNT = 0x04, /* UCSOLNT = unsuccessful solicited notification */
88
89         /*
90          * srp_rsp::sol_not / srp_t_logout::sol_not bitmasks. See also tables
91          * 16 and 22 in the T10 r16a document.
92          */
93         SRP_SOLNT = 0x01, /* SOLNT = solicited notification */
94
95         /* See also table 24 in the T10 r16a document. */
96         SRP_TSK_MGMT_SUCCESS = 0x00,
97         SRP_TSK_MGMT_FUNC_NOT_SUPP = 0x04,
98         SRP_TSK_MGMT_FAILED = 0x05,
99
100         /* See also table 21 in the T10 r16a document. */
101         SRP_CMD_SIMPLE_Q = 0x0,
102         SRP_CMD_HEAD_OF_Q = 0x1,
103         SRP_CMD_ORDERED_Q = 0x2,
104         SRP_CMD_ACA = 0x4,
105
106         SRP_LOGIN_RSP_MULTICHAN_NO_CHAN = 0x0,
107         SRP_LOGIN_RSP_MULTICHAN_TERMINATED = 0x1,
108         SRP_LOGIN_RSP_MULTICHAN_MAINTAINED = 0x2,
109
110         SRPT_DEF_SG_TABLESIZE = 128,
111         SRPT_DEF_SG_PER_WQE = 16,
112
113         SRPT_SQ_SIZE = 128 * SRPT_DEF_SG_PER_WQE,
114         SRPT_RQ_SIZE = 128,
115         SRPT_SRQ_SIZE = 4095,
116
117         MIN_MAX_MESSAGE_SIZE = 996,
118         DEFAULT_MAX_MESSAGE_SIZE
119                 = sizeof(struct srp_cmd)/*48*/
120                 + sizeof(struct srp_indirect_buf)/*20*/
121                 + 128 * sizeof(struct srp_direct_buf)/*16*/,
122
123         DEFAULT_MAX_RDMA_SIZE = 65536,
124 };
125
126 /* wr_id / wc_id flag for marking receive operations. */
127 #define SRPT_OP_RECV                    (1 << 31)
128
129
130 struct rdma_iu {
131         u64 raddr;
132         u32 rkey;
133         struct ib_sge *sge;
134         u32 sge_cnt;
135         int mem_id;
136 };
137
138 /* Command states. */
139 enum srpt_command_state {
140         /* New command arrived and is being processed. */
141         SRPT_STATE_NEW = 0,
142         /* Processing a write or bidir command and waiting for data arrival. */
143         SRPT_STATE_NEED_DATA = 1,
144         /* Data for the write or bidir command arrived and is being processed.*/
145         SRPT_STATE_DATA_IN = 2,
146         /* Command processing finished. */
147         SRPT_STATE_PROCESSED = 3,
148         /* Command processing has been aborted. */
149         SRPT_STATE_ABORTED = 4,
150 };
151
152 /* SRPT I/O context: SRPT-private data associated with a struct scst_cmd. */
153 struct srpt_ioctx {
154         int index;
155         void *buf;
156         dma_addr_t dma;
157         struct rdma_iu *rdma_ius;
158         struct srp_direct_buf *rbufs;
159         struct srp_direct_buf single_rbuf;
160         /* Node for insertion in srpt_rdma_ch::cmd_wait_list. */
161         struct list_head wait_list;
162         u16 n_rdma_ius;
163         u8 n_rdma;
164         u8 n_rbuf;
165         u8 sol_not;
166
167         enum ib_wc_opcode op;
168         /* Node for insertion in the srpt_thread::thread_ioctx_list. */
169         struct list_head comp_list;
170         struct srpt_rdma_ch *ch;
171         struct scst_cmd *scmnd;
172         atomic_t state; /*enum srpt_command_state*/
173 };
174
175 /* Additional context information for SCST management commands. */
176 struct srpt_mgmt_ioctx {
177         struct srpt_ioctx *ioctx;
178         struct srpt_rdma_ch *ch;
179         u64 tag;
180 };
181
182 /* channel state */
183 enum rdma_ch_state {
184         RDMA_CHANNEL_CONNECTING,
185         RDMA_CHANNEL_LIVE,
186         RDMA_CHANNEL_DISCONNECTING
187 };
188
189 struct srpt_rdma_ch {
190         /* AESOLNT flag from SRP_LOGIN_REQ. */
191         unsigned aesolnt:1;
192         /* CRSOLNT from SRP_LOGIN_REQ. */
193         unsigned crsolnt:1;
194         /* LOSOLNT flag from SRP_LOGIN_REQ. */
195         unsigned losolnt:1;
196         struct ib_cm_id *cm_id;
197         /* IB queue pair. */
198         struct ib_qp *qp;
199         /* Number of WR's in the QP 'qp' that are not in use. */
200         atomic_t qp_wr_avail;
201         struct ib_cq *cq;
202         struct srpt_port *sport;
203         /* 128-bit initiator port identifier copied from SRP_LOGIN_REQ. */
204         u8 i_port_id[16];
205         /* 128-bit target port identifier copied from SRP_LOGIN_REQ. */
206         u8 t_port_id[16];
207         int max_ti_iu_len;
208         /*
209          * Request limit: maximum number of request that may be sent by
210          * the initiator without having received a response or SRP_CRED_REQ.
211          */
212         atomic_t req_lim;
213         /*
214          * Value of req_lim the last time a response or SRP_CRED_REQ was sent.
215          */
216         atomic_t last_response_req_lim;
217         /* Channel state -- see also enum rdma_ch_state. */
218         atomic_t state;
219         /* Node for insertion in the srpt_device::rch_list list. */
220         struct list_head list;
221         /*
222          * List of SCST commands that arrived before the RTU event.
223          * This list contains struct srpt_ioctx elements and is protected
224          * against concurrent modification by the cm_id spinlock.
225          */
226         struct list_head cmd_wait_list;
227
228         struct scst_session *scst_sess;
229         u8 sess_name[36];
230 };
231
232 struct srpt_port {
233         struct srpt_device *sdev;
234         struct ib_mad_agent *mad_agent;
235         /* One-based port number. */
236         u8 port;
237         /* Cached values of the port's sm_lid, lid and gid. */
238         u16 sm_lid;
239         u16 lid;
240         union ib_gid gid;
241         /* Work structure for refreshing the aforementioned cached values. */
242         struct work_struct work;
243 };
244
245 /*
246  * Data stored by the ib_srpt kernel module per InfiniBand device
247  * (struct ib_device).
248  */
249 struct srpt_device {
250         /* Backpointer to the struct ib_device managed by the IB core. */
251         struct ib_device *device;
252         /* Protection domain. */
253         struct ib_pd *pd;
254         /* L_Key (local key) with write access to all local memory. */
255         struct ib_mr *mr;
256         /* SRQ (shared receive queue). */
257         struct ib_srq *srq;
258         /* Connection identifier. */
259         struct ib_cm_id *cm_id;
260         /*
261          * Attributes of the InfiniBand device as obtained during the
262          * ib_client::add() callback.
263          */
264         struct ib_device_attr dev_attr;
265         /* I/O context ring. */
266         struct srpt_ioctx *ioctx_ring[SRPT_SRQ_SIZE];
267         /*
268          * List node for insertion in the srpt_rdma_ch::list list.
269          * This list is protected by srpt_device::spinlock.
270          */
271         struct list_head rch_list;
272         spinlock_t spinlock;
273         struct srpt_port port[2];
274         struct ib_event_handler event_handler;
275 #if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 26)
276         /* per-port srpt-<portname> device instance. */
277         struct class_device class_dev;
278 #else
279         struct device dev;
280 #endif
281 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 30)
282         char init_name[20];
283 #endif
284
285         struct scst_tgt *scst_tgt;
286 };
287
288 #endif                          /* IB_SRPT_H */