2 * Copyright (c) 2005 Voltaire Inc. All rights reserved.
3 * Copyright (c) 2005 Intel Corporation. All rights reserved.
5 * 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:
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
15 * - Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
19 * - 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.
24 * 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
34 #if !defined(RDMA_CM_H)
37 #include <linux/socket.h>
38 #include <linux/in6.h>
39 #include <rdma/ib_addr.h>
40 #include <rdma/ib_sa.h>
43 * Upon receiving a device removal event, users must destroy the associated
44 * RDMA identifier and release all resources allocated with the device.
46 enum 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,
59 RDMA_CM_EVENT_MULTICAST_JOIN,
60 RDMA_CM_EVENT_MULTICAST_ERROR,
61 RDMA_CM_EVENT_ADDR_CHANGE
64 enum rdma_port_space {
66 RDMA_PS_IPOIB = 0x0002,
73 struct sockaddr src_addr;
74 u8 src_pad[sizeof(struct sockaddr_in6) -
75 sizeof(struct sockaddr)];
76 struct sockaddr dst_addr;
77 u8 dst_pad[sizeof(struct sockaddr_in6) -
78 sizeof(struct sockaddr)];
79 struct rdma_dev_addr dev_addr;
83 struct rdma_addr addr;
84 struct ib_sa_path_rec *path_rec;
88 struct rdma_conn_param {
89 const void *private_data;
91 u8 responder_resources;
94 u8 retry_count; /* ignored when accepting */
96 /* Fields below ignored if a QP is created on the rdma_cm_id. */
101 struct rdma_ud_param {
102 const void *private_data;
104 struct ib_ah_attr ah_attr;
109 struct rdma_cm_event {
110 enum rdma_cm_event_type event;
113 struct rdma_conn_param conn;
114 struct rdma_ud_param ud;
121 * rdma_cm_event_handler - Callback used to report user events.
123 * Notes: Users may not call rdma_destroy_id from this callback to destroy
124 * the passed in id, or a corresponding listen id. Returning a
125 * non-zero value from the callback will destroy the passed in id.
127 typedef int (*rdma_cm_event_handler)(struct rdma_cm_id *id,
128 struct rdma_cm_event *event);
131 struct ib_device *device;
134 rdma_cm_event_handler event_handler;
135 struct rdma_route route;
136 enum rdma_port_space ps;
141 * rdma_create_id - Create an RDMA identifier.
143 * @event_handler: User callback invoked to report events associated with the
145 * @context: User specified context associated with the id.
146 * @ps: RDMA port space.
148 struct rdma_cm_id *rdma_create_id(rdma_cm_event_handler event_handler,
149 void *context, enum rdma_port_space ps);
152 * rdma_destroy_id - Destroys an RDMA identifier.
154 * @id: RDMA identifier.
156 * Note: calling this function has the effect of canceling in-flight
157 * asynchronous operations associated with the id.
159 void rdma_destroy_id(struct rdma_cm_id *id);
162 * rdma_bind_addr - Bind an RDMA identifier to a source address and
163 * associated RDMA device, if needed.
165 * @id: RDMA identifier.
166 * @addr: Local address information. Wildcard values are permitted.
168 * This associates a source address with the RDMA identifier before calling
169 * rdma_listen. If a specific local address is given, the RDMA identifier will
170 * be bound to a local RDMA device.
172 int rdma_bind_addr(struct rdma_cm_id *id, struct sockaddr *addr);
175 * rdma_resolve_addr - Resolve destination and optional source addresses
176 * from IP addresses to an RDMA address. If successful, the specified
177 * rdma_cm_id will be bound to a local device.
179 * @id: RDMA identifier.
180 * @src_addr: Source address information. This parameter may be NULL.
181 * @dst_addr: Destination address information.
182 * @timeout_ms: Time to wait for resolution to complete.
184 int rdma_resolve_addr(struct rdma_cm_id *id, struct sockaddr *src_addr,
185 struct sockaddr *dst_addr, int timeout_ms);
188 * rdma_resolve_route - Resolve the RDMA address bound to the RDMA identifier
189 * into route information needed to establish a connection.
191 * This is called on the client side of a connection.
192 * Users must have first called rdma_resolve_addr to resolve a dst_addr
193 * into an RDMA address before calling this routine.
195 int rdma_resolve_route(struct rdma_cm_id *id, int timeout_ms);
198 * rdma_create_qp - Allocate a QP and associate it with the specified RDMA
201 * QPs allocated to an rdma_cm_id will automatically be transitioned by the CMA
202 * through their states.
204 int rdma_create_qp(struct rdma_cm_id *id, struct ib_pd *pd,
205 struct ib_qp_init_attr *qp_init_attr);
208 * rdma_destroy_qp - Deallocate the QP associated with the specified RDMA
211 * Users must destroy any QP associated with an RDMA identifier before
212 * destroying the RDMA ID.
214 void rdma_destroy_qp(struct rdma_cm_id *id);
217 * rdma_init_qp_attr - Initializes the QP attributes for use in transitioning
218 * to a specified QP state.
219 * @id: Communication identifier associated with the QP attributes to
221 * @qp_attr: On input, specifies the desired QP state. On output, the
222 * mandatory and desired optional attributes will be set in order to
223 * modify the QP to the specified state.
224 * @qp_attr_mask: The QP attribute mask that may be used to transition the
225 * QP to the specified state.
227 * Users must set the @qp_attr->qp_state to the desired QP state. This call
228 * will set all required attributes for the given transition, along with
229 * known optional attributes. Users may override the attributes returned from
230 * this call before calling ib_modify_qp.
232 * Users that wish to have their QP automatically transitioned through its
233 * states can associate a QP with the rdma_cm_id by calling rdma_create_qp().
235 int rdma_init_qp_attr(struct rdma_cm_id *id, struct ib_qp_attr *qp_attr,
239 * rdma_connect - Initiate an active connection request.
240 * @id: Connection identifier to connect.
241 * @conn_param: Connection information used for connected QPs.
243 * Users must have resolved a route for the rdma_cm_id to connect with
244 * by having called rdma_resolve_route before calling this routine.
246 * This call will either connect to a remote QP or obtain remote QP
247 * information for unconnected rdma_cm_id's. The actual operation is
248 * based on the rdma_cm_id's port space.
250 int rdma_connect(struct rdma_cm_id *id, struct rdma_conn_param *conn_param);
253 * rdma_listen - This function is called by the passive side to
254 * listen for incoming connection requests.
256 * Users must have bound the rdma_cm_id to a local address by calling
257 * rdma_bind_addr before calling this routine.
259 int rdma_listen(struct rdma_cm_id *id, int backlog);
262 * rdma_accept - Called to accept a connection request or response.
263 * @id: Connection identifier associated with the request.
264 * @conn_param: Information needed to establish the connection. This must be
265 * provided if accepting a connection request. If accepting a connection
266 * response, this parameter must be NULL.
268 * Typically, this routine is only called by the listener to accept a connection
269 * request. It must also be called on the active side of a connection if the
270 * user is performing their own QP transitions.
272 * In the case of error, a reject message is sent to the remote side and the
273 * state of the qp associated with the id is modified to error, such that any
274 * previously posted receive buffers would be flushed.
276 int rdma_accept(struct rdma_cm_id *id, struct rdma_conn_param *conn_param);
279 * rdma_notify - Notifies the RDMA CM of an asynchronous event that has
280 * occurred on the connection.
281 * @id: Connection identifier to transition to established.
282 * @event: Asynchronous event.
284 * This routine should be invoked by users to notify the CM of relevant
285 * communication events. Events that should be reported to the CM and
286 * when to report them are:
288 * IB_EVENT_COMM_EST - Used when a message is received on a connected
289 * QP before an RTU has been received.
291 int rdma_notify(struct rdma_cm_id *id, enum ib_event_type event);
294 * rdma_reject - Called to reject a connection request or response.
296 int rdma_reject(struct rdma_cm_id *id, const void *private_data,
297 u8 private_data_len);
300 * rdma_disconnect - This function disconnects the associated QP and
301 * transitions it into the error state.
303 int rdma_disconnect(struct rdma_cm_id *id);
306 * rdma_join_multicast - Join the multicast group specified by the given
308 * @id: Communication identifier associated with the request.
309 * @addr: Multicast address identifying the group to join.
310 * @context: User-defined context associated with the join request, returned
311 * to the user through the private_data pointer in multicast events.
313 int rdma_join_multicast(struct rdma_cm_id *id, struct sockaddr *addr,
317 * rdma_leave_multicast - Leave the multicast group specified by the given
320 void rdma_leave_multicast(struct rdma_cm_id *id, struct sockaddr *addr);
323 * rdma_set_service_type - Set the type of service associated with a
324 * connection identifier.
325 * @id: Communication identifier to associated with service type.
326 * @tos: Type of service.
328 * The type of service is interpretted as a differentiated service
329 * field (RFC 2474). The service type should be specified before
330 * performing route resolution, as existing communication on the
331 * connection identifier may be unaffected. The type of service
332 * requested may not be supported by the network to all destinations.
334 void rdma_set_service_type(struct rdma_cm_id *id, int tos);
336 #endif /* RDMA_CM_H */