blob: c92522c192d26df9401d061121fb743935ef9b45 [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
Sagi Grimberg2b1b5b62015-05-18 13:40:28 +030065__attribute_const__ const char *rdma_event_msg(enum rdma_cm_event_type event);
66
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 *
163 * @event_handler: User callback invoked to report events associated with the
164 * returned rdma_id.
165 * @context: User specified context associated with the id.
166 * @ps: RDMA port space.
Sean Heftyb26f9b92010-04-01 17:08:41 +0000167 * @qp_type: type of queue pair associated with the id.
Sean Heftye51060f2006-06-17 20:37:29 -0700168 */
169struct rdma_cm_id *rdma_create_id(rdma_cm_event_handler event_handler,
Sean Heftyb26f9b92010-04-01 17:08:41 +0000170 void *context, enum rdma_port_space ps,
171 enum ib_qp_type qp_type);
Sean Heftye51060f2006-06-17 20:37:29 -0700172
Or Gerlitz07eeec02006-09-12 09:03:33 -0700173/**
174 * rdma_destroy_id - Destroys an RDMA identifier.
175 *
176 * @id: RDMA identifier.
177 *
178 * Note: calling this function has the effect of canceling in-flight
179 * asynchronous operations associated with the id.
180 */
Sean Heftye51060f2006-06-17 20:37:29 -0700181void rdma_destroy_id(struct rdma_cm_id *id);
182
183/**
184 * rdma_bind_addr - Bind an RDMA identifier to a source address and
185 * associated RDMA device, if needed.
186 *
187 * @id: RDMA identifier.
188 * @addr: Local address information. Wildcard values are permitted.
189 *
190 * This associates a source address with the RDMA identifier before calling
191 * rdma_listen. If a specific local address is given, the RDMA identifier will
192 * be bound to a local RDMA device.
193 */
194int rdma_bind_addr(struct rdma_cm_id *id, struct sockaddr *addr);
195
196/**
197 * rdma_resolve_addr - Resolve destination and optional source addresses
198 * from IP addresses to an RDMA address. If successful, the specified
199 * rdma_cm_id will be bound to a local device.
200 *
201 * @id: RDMA identifier.
202 * @src_addr: Source address information. This parameter may be NULL.
203 * @dst_addr: Destination address information.
204 * @timeout_ms: Time to wait for resolution to complete.
205 */
206int rdma_resolve_addr(struct rdma_cm_id *id, struct sockaddr *src_addr,
207 struct sockaddr *dst_addr, int timeout_ms);
208
209/**
210 * rdma_resolve_route - Resolve the RDMA address bound to the RDMA identifier
211 * into route information needed to establish a connection.
212 *
213 * This is called on the client side of a connection.
214 * Users must have first called rdma_resolve_addr to resolve a dst_addr
215 * into an RDMA address before calling this routine.
216 */
217int rdma_resolve_route(struct rdma_cm_id *id, int timeout_ms);
218
219/**
220 * rdma_create_qp - Allocate a QP and associate it with the specified RDMA
221 * identifier.
222 *
223 * QPs allocated to an rdma_cm_id will automatically be transitioned by the CMA
224 * through their states.
225 */
226int rdma_create_qp(struct rdma_cm_id *id, struct ib_pd *pd,
227 struct ib_qp_init_attr *qp_init_attr);
228
229/**
230 * rdma_destroy_qp - Deallocate the QP associated with the specified RDMA
231 * identifier.
232 *
233 * Users must destroy any QP associated with an RDMA identifier before
234 * destroying the RDMA ID.
235 */
236void rdma_destroy_qp(struct rdma_cm_id *id);
237
238/**
239 * rdma_init_qp_attr - Initializes the QP attributes for use in transitioning
240 * to a specified QP state.
241 * @id: Communication identifier associated with the QP attributes to
242 * initialize.
243 * @qp_attr: On input, specifies the desired QP state. On output, the
244 * mandatory and desired optional attributes will be set in order to
245 * modify the QP to the specified state.
246 * @qp_attr_mask: The QP attribute mask that may be used to transition the
247 * QP to the specified state.
248 *
249 * Users must set the @qp_attr->qp_state to the desired QP state. This call
250 * will set all required attributes for the given transition, along with
251 * known optional attributes. Users may override the attributes returned from
252 * this call before calling ib_modify_qp.
253 *
254 * Users that wish to have their QP automatically transitioned through its
255 * states can associate a QP with the rdma_cm_id by calling rdma_create_qp().
256 */
257int rdma_init_qp_attr(struct rdma_cm_id *id, struct ib_qp_attr *qp_attr,
258 int *qp_attr_mask);
259
Sean Heftye51060f2006-06-17 20:37:29 -0700260/**
261 * rdma_connect - Initiate an active connection request.
Sean Hefty628e5f62006-11-30 16:44:16 -0800262 * @id: Connection identifier to connect.
263 * @conn_param: Connection information used for connected QPs.
Sean Heftye51060f2006-06-17 20:37:29 -0700264 *
265 * Users must have resolved a route for the rdma_cm_id to connect with
266 * by having called rdma_resolve_route before calling this routine.
Sean Hefty628e5f62006-11-30 16:44:16 -0800267 *
268 * This call will either connect to a remote QP or obtain remote QP
269 * information for unconnected rdma_cm_id's. The actual operation is
270 * based on the rdma_cm_id's port space.
Sean Heftye51060f2006-06-17 20:37:29 -0700271 */
272int rdma_connect(struct rdma_cm_id *id, struct rdma_conn_param *conn_param);
273
274/**
275 * rdma_listen - This function is called by the passive side to
276 * listen for incoming connection requests.
277 *
278 * Users must have bound the rdma_cm_id to a local address by calling
279 * rdma_bind_addr before calling this routine.
280 */
281int rdma_listen(struct rdma_cm_id *id, int backlog);
282
283/**
284 * rdma_accept - Called to accept a connection request or response.
285 * @id: Connection identifier associated with the request.
286 * @conn_param: Information needed to establish the connection. This must be
287 * provided if accepting a connection request. If accepting a connection
288 * response, this parameter must be NULL.
289 *
290 * Typically, this routine is only called by the listener to accept a connection
291 * request. It must also be called on the active side of a connection if the
292 * user is performing their own QP transitions.
Or Gerlitz951f7fc2006-09-22 15:22:54 -0700293 *
294 * In the case of error, a reject message is sent to the remote side and the
295 * state of the qp associated with the id is modified to error, such that any
296 * previously posted receive buffers would be flushed.
Sean Heftye51060f2006-06-17 20:37:29 -0700297 */
298int rdma_accept(struct rdma_cm_id *id, struct rdma_conn_param *conn_param);
299
300/**
Sean Hefty0fe313b2006-11-30 16:37:15 -0800301 * rdma_notify - Notifies the RDMA CM of an asynchronous event that has
302 * occurred on the connection.
303 * @id: Connection identifier to transition to established.
304 * @event: Asynchronous event.
305 *
306 * This routine should be invoked by users to notify the CM of relevant
307 * communication events. Events that should be reported to the CM and
308 * when to report them are:
309 *
310 * IB_EVENT_COMM_EST - Used when a message is received on a connected
311 * QP before an RTU has been received.
312 */
313int rdma_notify(struct rdma_cm_id *id, enum ib_event_type event);
314
315/**
Sean Heftye51060f2006-06-17 20:37:29 -0700316 * rdma_reject - Called to reject a connection request or response.
317 */
318int rdma_reject(struct rdma_cm_id *id, const void *private_data,
319 u8 private_data_len);
320
321/**
322 * rdma_disconnect - This function disconnects the associated QP and
323 * transitions it into the error state.
324 */
325int rdma_disconnect(struct rdma_cm_id *id);
326
Sean Heftyc8f6a362007-02-15 17:00:18 -0800327/**
328 * rdma_join_multicast - Join the multicast group specified by the given
329 * address.
330 * @id: Communication identifier associated with the request.
331 * @addr: Multicast address identifying the group to join.
332 * @context: User-defined context associated with the join request, returned
333 * to the user through the private_data pointer in multicast events.
334 */
335int rdma_join_multicast(struct rdma_cm_id *id, struct sockaddr *addr,
336 void *context);
Sean Heftye51060f2006-06-17 20:37:29 -0700337
Sean Heftyc8f6a362007-02-15 17:00:18 -0800338/**
339 * rdma_leave_multicast - Leave the multicast group specified by the given
340 * address.
341 */
342void rdma_leave_multicast(struct rdma_cm_id *id, struct sockaddr *addr);
343
Sean Heftya81c9942007-08-08 15:51:06 -0700344/**
345 * rdma_set_service_type - Set the type of service associated with a
346 * connection identifier.
347 * @id: Communication identifier to associated with service type.
348 * @tos: Type of service.
349 *
350 * The type of service is interpretted as a differentiated service
351 * field (RFC 2474). The service type should be specified before
352 * performing route resolution, as existing communication on the
353 * connection identifier may be unaffected. The type of service
354 * requested may not be supported by the network to all destinations.
355 */
356void rdma_set_service_type(struct rdma_cm_id *id, int tos);
357
Hefty, Seana9bb7912011-05-09 22:06:10 -0700358/**
359 * rdma_set_reuseaddr - Allow the reuse of local addresses when binding
360 * the rdma_cm_id.
361 * @id: Communication identifier to configure.
362 * @reuse: Value indicating if the bound address is reusable.
363 *
364 * Reuse must be set before an address is bound to the id.
365 */
366int rdma_set_reuseaddr(struct rdma_cm_id *id, int reuse);
367
Sean Hefty68602122012-06-14 20:31:39 +0000368/**
369 * rdma_set_afonly - Specify that listens are restricted to the
370 * bound address family only.
371 * @id: Communication identifer to configure.
372 * @afonly: Value indicating if listens are restricted.
373 *
374 * Must be set before identifier is in the listening state.
375 */
376int rdma_set_afonly(struct rdma_cm_id *id, int afonly);
377
Sean Heftycf539362013-05-29 10:09:28 -0700378 /**
379 * rdma_get_service_id - Return the IB service ID for a specified address.
380 * @id: Communication identifier associated with the address.
381 * @addr: Address for the service ID.
382 */
383__be64 rdma_get_service_id(struct rdma_cm_id *id, struct sockaddr *addr);
384
Sean Heftyc8f6a362007-02-15 17:00:18 -0800385#endif /* RDMA_CM_H */