blob: afe44fde72a56599cb0dd1674078210a78438ae4 [file] [log] [blame]
Sean Heftye51060f2006-06-17 20:37:29 -07001/*
2 * Copyright (c) 2005 Voltaire Inc. All rights reserved.
3 * Copyright (c) 2005 Intel Corporation. All rights reserved.
4 *
Sean Heftya9474912008-07-14 23:48:43 -07005 * This software is available to you under a choice of one of two
6 * licenses. You may choose to be licensed under the terms of the GNU
7 * General Public License (GPL) Version 2, available from the file
8 * COPYING in the main directory of this source tree, or the
9 * OpenIB.org BSD license below:
Sean Heftye51060f2006-06-17 20:37:29 -070010 *
Sean Heftya9474912008-07-14 23:48:43 -070011 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
13 * conditions are met:
Sean Heftye51060f2006-06-17 20:37:29 -070014 *
Sean Heftya9474912008-07-14 23:48:43 -070015 * - Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
17 * disclaimer.
Sean Heftye51060f2006-06-17 20:37:29 -070018 *
Sean Heftya9474912008-07-14 23:48:43 -070019 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials
22 * provided with the distribution.
Sean Heftye51060f2006-06-17 20:37:29 -070023 *
Sean Heftya9474912008-07-14 23:48:43 -070024 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 * SOFTWARE.
Sean Heftye51060f2006-06-17 20:37:29 -070032 */
33
34#if !defined(RDMA_CM_H)
35#define RDMA_CM_H
36
37#include <linux/socket.h>
38#include <linux/in6.h>
39#include <rdma/ib_addr.h>
40#include <rdma/ib_sa.h>
41
42/*
43 * Upon receiving a device removal event, users must destroy the associated
44 * RDMA identifier and release all resources allocated with the device.
45 */
46enum rdma_cm_event_type {
47 RDMA_CM_EVENT_ADDR_RESOLVED,
48 RDMA_CM_EVENT_ADDR_ERROR,
49 RDMA_CM_EVENT_ROUTE_RESOLVED,
50 RDMA_CM_EVENT_ROUTE_ERROR,
51 RDMA_CM_EVENT_CONNECT_REQUEST,
52 RDMA_CM_EVENT_CONNECT_RESPONSE,
53 RDMA_CM_EVENT_CONNECT_ERROR,
54 RDMA_CM_EVENT_UNREACHABLE,
55 RDMA_CM_EVENT_REJECTED,
56 RDMA_CM_EVENT_ESTABLISHED,
57 RDMA_CM_EVENT_DISCONNECTED,
58 RDMA_CM_EVENT_DEVICE_REMOVAL,
Sean Heftyc8f6a362007-02-15 17:00:18 -080059 RDMA_CM_EVENT_MULTICAST_JOIN,
Or Gerlitzdd5bdff2008-07-22 14:14:22 -070060 RDMA_CM_EVENT_MULTICAST_ERROR,
Amir Vadai38ca83a2008-07-22 14:14:23 -070061 RDMA_CM_EVENT_ADDR_CHANGE,
62 RDMA_CM_EVENT_TIMEWAIT_EXIT
Sean Heftye51060f2006-06-17 20:37:29 -070063};
64
Bart Van Asschedb7489e2015-08-03 10:01:52 -070065const char *__attribute_const__ rdma_event_msg(enum rdma_cm_event_type event);
Sagi Grimberg2b1b5b62015-05-18 13:40:28 +030066
Sean Heftye51060f2006-06-17 20:37:29 -070067enum rdma_port_space {
Dotan Barak4deccd62008-07-14 23:48:44 -070068 RDMA_PS_SDP = 0x0001,
69 RDMA_PS_IPOIB = 0x0002,
Sean Hefty2d2e9412011-05-28 21:56:39 -070070 RDMA_PS_IB = 0x013F,
Dotan Barak4deccd62008-07-14 23:48:44 -070071 RDMA_PS_TCP = 0x0106,
72 RDMA_PS_UDP = 0x0111,
Sean Heftye51060f2006-06-17 20:37:29 -070073};
74
Sean Hefty58afdcb2013-05-29 10:09:11 -070075#define RDMA_IB_IP_PS_MASK 0xFFFFFFFFFFFF0000ULL
76#define RDMA_IB_IP_PS_TCP 0x0000000001060000ULL
77#define RDMA_IB_IP_PS_UDP 0x0000000001110000ULL
78#define RDMA_IB_IP_PS_IB 0x00000000013F0000ULL
79
Sean Heftye51060f2006-06-17 20:37:29 -070080struct rdma_addr {
Roland Dreier3f446752008-08-04 11:02:14 -070081 struct sockaddr_storage src_addr;
82 struct sockaddr_storage dst_addr;
Sean Heftye51060f2006-06-17 20:37:29 -070083 struct rdma_dev_addr dev_addr;
84};
85
86struct rdma_route {
87 struct rdma_addr addr;
88 struct ib_sa_path_rec *path_rec;
89 int num_paths;
90};
91
Sean Heftya1b1b612006-11-30 16:33:14 -080092struct rdma_conn_param {
93 const void *private_data;
94 u8 private_data_len;
95 u8 responder_resources;
96 u8 initiator_depth;
97 u8 flow_control;
98 u8 retry_count; /* ignored when accepting */
99 u8 rnr_retry_count;
100 /* Fields below ignored if a QP is created on the rdma_cm_id. */
101 u8 srq;
102 u32 qp_num;
Sean Hefty5c438132013-05-29 10:09:23 -0700103 u32 qkey;
Sean Heftya1b1b612006-11-30 16:33:14 -0800104};
105
Sean Hefty628e5f62006-11-30 16:44:16 -0800106struct rdma_ud_param {
107 const void *private_data;
108 u8 private_data_len;
109 struct ib_ah_attr ah_attr;
110 u32 qp_num;
111 u32 qkey;
112};
113
Sean Heftye51060f2006-06-17 20:37:29 -0700114struct rdma_cm_event {
115 enum rdma_cm_event_type event;
116 int status;
Sean Heftya1b1b612006-11-30 16:33:14 -0800117 union {
118 struct rdma_conn_param conn;
Sean Hefty628e5f62006-11-30 16:44:16 -0800119 struct rdma_ud_param ud;
Sean Heftya1b1b612006-11-30 16:33:14 -0800120 } param;
Sean Heftye51060f2006-06-17 20:37:29 -0700121};
122
Nir Muchtar550e5ca2011-05-20 11:46:11 -0700123enum rdma_cm_state {
124 RDMA_CM_IDLE,
125 RDMA_CM_ADDR_QUERY,
126 RDMA_CM_ADDR_RESOLVED,
127 RDMA_CM_ROUTE_QUERY,
128 RDMA_CM_ROUTE_RESOLVED,
129 RDMA_CM_CONNECT,
130 RDMA_CM_DISCONNECT,
131 RDMA_CM_ADDR_BOUND,
132 RDMA_CM_LISTEN,
133 RDMA_CM_DEVICE_REMOVAL,
134 RDMA_CM_DESTROYING
135};
136
Sean Heftye51060f2006-06-17 20:37:29 -0700137struct rdma_cm_id;
138
139/**
140 * rdma_cm_event_handler - Callback used to report user events.
141 *
142 * Notes: Users may not call rdma_destroy_id from this callback to destroy
143 * the passed in id, or a corresponding listen id. Returning a
144 * non-zero value from the callback will destroy the passed in id.
145 */
146typedef int (*rdma_cm_event_handler)(struct rdma_cm_id *id,
147 struct rdma_cm_event *event);
148
149struct rdma_cm_id {
150 struct ib_device *device;
151 void *context;
152 struct ib_qp *qp;
153 rdma_cm_event_handler event_handler;
154 struct rdma_route route;
155 enum rdma_port_space ps;
Sean Heftyb26f9b92010-04-01 17:08:41 +0000156 enum ib_qp_type qp_type;
Sean Heftye51060f2006-06-17 20:37:29 -0700157 u8 port_num;
158};
159
160/**
161 * rdma_create_id - Create an RDMA identifier.
162 *
Guy Shapirofa201052015-10-22 15:20:10 +0300163 * @net: The network namespace in which to create the new id.
Sean Heftye51060f2006-06-17 20:37:29 -0700164 * @event_handler: User callback invoked to report events associated with the
165 * returned rdma_id.
166 * @context: User specified context associated with the id.
167 * @ps: RDMA port space.
Sean Heftyb26f9b92010-04-01 17:08:41 +0000168 * @qp_type: type of queue pair associated with the id.
Guy Shapirofa201052015-10-22 15:20:10 +0300169 *
170 * The id holds a reference on the network namespace until it is destroyed.
Sean Heftye51060f2006-06-17 20:37:29 -0700171 */
Guy Shapirofa201052015-10-22 15:20:10 +0300172struct rdma_cm_id *rdma_create_id(struct net *net,
173 rdma_cm_event_handler event_handler,
Sean Heftyb26f9b92010-04-01 17:08:41 +0000174 void *context, enum rdma_port_space ps,
175 enum ib_qp_type qp_type);
Sean Heftye51060f2006-06-17 20:37:29 -0700176
Or Gerlitz07eeec02006-09-12 09:03:33 -0700177/**
178 * rdma_destroy_id - Destroys an RDMA identifier.
179 *
180 * @id: RDMA identifier.
181 *
182 * Note: calling this function has the effect of canceling in-flight
183 * asynchronous operations associated with the id.
184 */
Sean Heftye51060f2006-06-17 20:37:29 -0700185void rdma_destroy_id(struct rdma_cm_id *id);
186
187/**
188 * rdma_bind_addr - Bind an RDMA identifier to a source address and
189 * associated RDMA device, if needed.
190 *
191 * @id: RDMA identifier.
192 * @addr: Local address information. Wildcard values are permitted.
193 *
194 * This associates a source address with the RDMA identifier before calling
195 * rdma_listen. If a specific local address is given, the RDMA identifier will
196 * be bound to a local RDMA device.
197 */
198int rdma_bind_addr(struct rdma_cm_id *id, struct sockaddr *addr);
199
200/**
201 * rdma_resolve_addr - Resolve destination and optional source addresses
202 * from IP addresses to an RDMA address. If successful, the specified
203 * rdma_cm_id will be bound to a local device.
204 *
205 * @id: RDMA identifier.
206 * @src_addr: Source address information. This parameter may be NULL.
207 * @dst_addr: Destination address information.
208 * @timeout_ms: Time to wait for resolution to complete.
209 */
210int rdma_resolve_addr(struct rdma_cm_id *id, struct sockaddr *src_addr,
211 struct sockaddr *dst_addr, int timeout_ms);
212
213/**
214 * rdma_resolve_route - Resolve the RDMA address bound to the RDMA identifier
215 * into route information needed to establish a connection.
216 *
217 * This is called on the client side of a connection.
218 * Users must have first called rdma_resolve_addr to resolve a dst_addr
219 * into an RDMA address before calling this routine.
220 */
221int rdma_resolve_route(struct rdma_cm_id *id, int timeout_ms);
222
223/**
224 * rdma_create_qp - Allocate a QP and associate it with the specified RDMA
225 * identifier.
226 *
227 * QPs allocated to an rdma_cm_id will automatically be transitioned by the CMA
228 * through their states.
229 */
230int rdma_create_qp(struct rdma_cm_id *id, struct ib_pd *pd,
231 struct ib_qp_init_attr *qp_init_attr);
232
233/**
234 * rdma_destroy_qp - Deallocate the QP associated with the specified RDMA
235 * identifier.
236 *
237 * Users must destroy any QP associated with an RDMA identifier before
238 * destroying the RDMA ID.
239 */
240void rdma_destroy_qp(struct rdma_cm_id *id);
241
242/**
243 * rdma_init_qp_attr - Initializes the QP attributes for use in transitioning
244 * to a specified QP state.
245 * @id: Communication identifier associated with the QP attributes to
246 * initialize.
247 * @qp_attr: On input, specifies the desired QP state. On output, the
248 * mandatory and desired optional attributes will be set in order to
249 * modify the QP to the specified state.
250 * @qp_attr_mask: The QP attribute mask that may be used to transition the
251 * QP to the specified state.
252 *
253 * Users must set the @qp_attr->qp_state to the desired QP state. This call
254 * will set all required attributes for the given transition, along with
255 * known optional attributes. Users may override the attributes returned from
256 * this call before calling ib_modify_qp.
257 *
258 * Users that wish to have their QP automatically transitioned through its
259 * states can associate a QP with the rdma_cm_id by calling rdma_create_qp().
260 */
261int rdma_init_qp_attr(struct rdma_cm_id *id, struct ib_qp_attr *qp_attr,
262 int *qp_attr_mask);
263
Sean Heftye51060f2006-06-17 20:37:29 -0700264/**
265 * rdma_connect - Initiate an active connection request.
Sean Hefty628e5f62006-11-30 16:44:16 -0800266 * @id: Connection identifier to connect.
267 * @conn_param: Connection information used for connected QPs.
Sean Heftye51060f2006-06-17 20:37:29 -0700268 *
269 * Users must have resolved a route for the rdma_cm_id to connect with
270 * by having called rdma_resolve_route before calling this routine.
Sean Hefty628e5f62006-11-30 16:44:16 -0800271 *
272 * This call will either connect to a remote QP or obtain remote QP
273 * information for unconnected rdma_cm_id's. The actual operation is
274 * based on the rdma_cm_id's port space.
Sean Heftye51060f2006-06-17 20:37:29 -0700275 */
276int rdma_connect(struct rdma_cm_id *id, struct rdma_conn_param *conn_param);
277
278/**
279 * rdma_listen - This function is called by the passive side to
280 * listen for incoming connection requests.
281 *
282 * Users must have bound the rdma_cm_id to a local address by calling
283 * rdma_bind_addr before calling this routine.
284 */
285int rdma_listen(struct rdma_cm_id *id, int backlog);
286
287/**
288 * rdma_accept - Called to accept a connection request or response.
289 * @id: Connection identifier associated with the request.
290 * @conn_param: Information needed to establish the connection. This must be
291 * provided if accepting a connection request. If accepting a connection
292 * response, this parameter must be NULL.
293 *
294 * Typically, this routine is only called by the listener to accept a connection
295 * request. It must also be called on the active side of a connection if the
296 * user is performing their own QP transitions.
Or Gerlitz951f7fc2006-09-22 15:22:54 -0700297 *
298 * In the case of error, a reject message is sent to the remote side and the
299 * state of the qp associated with the id is modified to error, such that any
300 * previously posted receive buffers would be flushed.
Sean Heftye51060f2006-06-17 20:37:29 -0700301 */
302int rdma_accept(struct rdma_cm_id *id, struct rdma_conn_param *conn_param);
303
304/**
Sean Hefty0fe313b2006-11-30 16:37:15 -0800305 * rdma_notify - Notifies the RDMA CM of an asynchronous event that has
306 * occurred on the connection.
307 * @id: Connection identifier to transition to established.
308 * @event: Asynchronous event.
309 *
310 * This routine should be invoked by users to notify the CM of relevant
311 * communication events. Events that should be reported to the CM and
312 * when to report them are:
313 *
314 * IB_EVENT_COMM_EST - Used when a message is received on a connected
315 * QP before an RTU has been received.
316 */
317int rdma_notify(struct rdma_cm_id *id, enum ib_event_type event);
318
319/**
Sean Heftye51060f2006-06-17 20:37:29 -0700320 * rdma_reject - Called to reject a connection request or response.
321 */
322int rdma_reject(struct rdma_cm_id *id, const void *private_data,
323 u8 private_data_len);
324
325/**
326 * rdma_disconnect - This function disconnects the associated QP and
327 * transitions it into the error state.
328 */
329int rdma_disconnect(struct rdma_cm_id *id);
330
Sean Heftyc8f6a362007-02-15 17:00:18 -0800331/**
332 * rdma_join_multicast - Join the multicast group specified by the given
333 * address.
334 * @id: Communication identifier associated with the request.
335 * @addr: Multicast address identifying the group to join.
336 * @context: User-defined context associated with the join request, returned
337 * to the user through the private_data pointer in multicast events.
338 */
339int rdma_join_multicast(struct rdma_cm_id *id, struct sockaddr *addr,
340 void *context);
Sean Heftye51060f2006-06-17 20:37:29 -0700341
Sean Heftyc8f6a362007-02-15 17:00:18 -0800342/**
343 * rdma_leave_multicast - Leave the multicast group specified by the given
344 * address.
345 */
346void rdma_leave_multicast(struct rdma_cm_id *id, struct sockaddr *addr);
347
Sean Heftya81c9942007-08-08 15:51:06 -0700348/**
349 * rdma_set_service_type - Set the type of service associated with a
350 * connection identifier.
351 * @id: Communication identifier to associated with service type.
352 * @tos: Type of service.
353 *
354 * The type of service is interpretted as a differentiated service
355 * field (RFC 2474). The service type should be specified before
356 * performing route resolution, as existing communication on the
357 * connection identifier may be unaffected. The type of service
358 * requested may not be supported by the network to all destinations.
359 */
360void rdma_set_service_type(struct rdma_cm_id *id, int tos);
361
Hefty, Seana9bb7912011-05-09 22:06:10 -0700362/**
363 * rdma_set_reuseaddr - Allow the reuse of local addresses when binding
364 * the rdma_cm_id.
365 * @id: Communication identifier to configure.
366 * @reuse: Value indicating if the bound address is reusable.
367 *
368 * Reuse must be set before an address is bound to the id.
369 */
370int rdma_set_reuseaddr(struct rdma_cm_id *id, int reuse);
371
Sean Hefty68602122012-06-14 20:31:39 +0000372/**
373 * rdma_set_afonly - Specify that listens are restricted to the
374 * bound address family only.
375 * @id: Communication identifer to configure.
376 * @afonly: Value indicating if listens are restricted.
377 *
378 * Must be set before identifier is in the listening state.
379 */
380int rdma_set_afonly(struct rdma_cm_id *id, int afonly);
381
Sean Heftycf539362013-05-29 10:09:28 -0700382 /**
383 * rdma_get_service_id - Return the IB service ID for a specified address.
384 * @id: Communication identifier associated with the address.
385 * @addr: Address for the service ID.
386 */
387__be64 rdma_get_service_id(struct rdma_cm_id *id, struct sockaddr *addr);
388
Sean Heftyc8f6a362007-02-15 17:00:18 -0800389#endif /* RDMA_CM_H */