xref: /freebsd/sys/ofed/include/rdma/rdma_cm.h (revision a0ee8cc636cd5c2374ec44ca71226564ea0bca95)
1 /*
2  * Copyright (c) 2005 Voltaire Inc.  All rights reserved.
3  * Copyright (c) 2005 Intel Corporation.  All rights reserved.
4  *
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:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      - Redistributions of source code must retain the above
16  *        copyright notice, this list of conditions and the following
17  *        disclaimer.
18  *
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.
23  *
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
31  * SOFTWARE.
32  */
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  */
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,
62 	RDMA_CM_EVENT_TIMEWAIT_EXIT,
63 	RDMA_CM_EVENT_ALT_ROUTE_RESOLVED,
64 	RDMA_CM_EVENT_ALT_ROUTE_ERROR,
65 	RDMA_CM_EVENT_LOAD_ALT_PATH,
66 	RDMA_CM_EVENT_ALT_PATH_LOADED,
67 };
68 
69 enum rdma_port_space {
70 	RDMA_PS_SDP   = 0x0001,
71 	RDMA_PS_IPOIB = 0x0002,
72 	RDMA_PS_IB    = 0x013F,
73 	RDMA_PS_TCP   = 0x0106,
74 	RDMA_PS_UDP   = 0x0111,
75 };
76 
77 enum alt_path_type {
78 	RDMA_ALT_PATH_NONE,
79 	RDMA_ALT_PATH_PORT,
80 	RDMA_ALT_PATH_LID,
81 	RDMA_ALT_PATH_BEST
82 };
83 
84 struct rdma_addr {
85 	struct sockaddr_storage src_addr;
86 	struct sockaddr_storage dst_addr;
87 	struct rdma_dev_addr dev_addr;
88 };
89 
90 struct rdma_route {
91 	struct rdma_addr addr;
92 	struct ib_sa_path_rec *path_rec;
93 	int num_paths;
94 };
95 
96 struct rdma_conn_param {
97 	const void *private_data;
98 	u8 private_data_len;
99 	u8 responder_resources;
100 	u8 initiator_depth;
101 	u8 flow_control;
102 	u8 retry_count;		/* ignored when accepting */
103 	u8 rnr_retry_count;
104 	/* Fields below ignored if a QP is created on the rdma_cm_id. */
105 	u8 srq;
106 	u32 qp_num;
107 };
108 
109 struct rdma_ud_param {
110 	const void *private_data;
111 	u8 private_data_len;
112 	struct ib_ah_attr ah_attr;
113 	u32 qp_num;
114 	u32 qkey;
115 	u8 alt_path_index;
116 };
117 
118 struct rdma_cm_event {
119 	enum rdma_cm_event_type	 event;
120 	int			 status;
121 	union {
122 		struct rdma_conn_param	conn;
123 		struct rdma_ud_param	ud;
124 	} param;
125 };
126 
127 enum rdma_cm_state {
128 	RDMA_CM_IDLE,
129 	RDMA_CM_ADDR_QUERY,
130 	RDMA_CM_ADDR_RESOLVED,
131 	RDMA_CM_ROUTE_QUERY,
132 	RDMA_CM_ROUTE_RESOLVED,
133 	RDMA_CM_CONNECT,
134 	RDMA_CM_DISCONNECT,
135 	RDMA_CM_ADDR_BOUND,
136 	RDMA_CM_LISTEN,
137 	RDMA_CM_DEVICE_REMOVAL,
138 	RDMA_CM_DESTROYING
139 };
140 
141 struct rdma_cm_id;
142 
143 /**
144  * rdma_cm_event_handler - Callback used to report user events.
145  *
146  * Notes: Users may not call rdma_destroy_id from this callback to destroy
147  *   the passed in id, or a corresponding listen id.  Returning a
148  *   non-zero value from the callback will destroy the passed in id.
149  */
150 typedef int (*rdma_cm_event_handler)(struct rdma_cm_id *id,
151 				     struct rdma_cm_event *event);
152 
153 struct rdma_cm_id {
154 	struct ib_device	*device;
155 	void			*context;
156 	struct ib_qp		*qp;
157 	rdma_cm_event_handler	 event_handler;
158 	struct rdma_route	 route;
159 	enum rdma_port_space	 ps;
160 	enum ib_qp_type		 qp_type;
161 	u8			 port_num;
162 	void			 *ucontext;
163 };
164 
165 /**
166  * rdma_create_id - Create an RDMA identifier.
167  *
168  * @event_handler: User callback invoked to report events associated with the
169  *   returned rdma_id.
170  * @context: User specified context associated with the id.
171  * @ps: RDMA port space.
172  * @qp_type: type of queue pair associated with the id.
173  */
174 struct rdma_cm_id *rdma_create_id(rdma_cm_event_handler event_handler,
175 				  void *context, enum rdma_port_space ps,
176 				  enum ib_qp_type qp_type);
177 
178 /**
179   * rdma_destroy_id - Destroys an RDMA identifier.
180   *
181   * @id: RDMA identifier.
182   *
183   * Note: calling this function has the effect of canceling in-flight
184   * asynchronous operations associated with the id.
185   */
186 void rdma_destroy_id(struct rdma_cm_id *id);
187 
188 /**
189  * rdma_bind_addr - Bind an RDMA identifier to a source address and
190  *   associated RDMA device, if needed.
191  *
192  * @id: RDMA identifier.
193  * @addr: Local address information.  Wildcard values are permitted.
194  *
195  * This associates a source address with the RDMA identifier before calling
196  * rdma_listen.  If a specific local address is given, the RDMA identifier will
197  * be bound to a local RDMA device.
198  */
199 int rdma_bind_addr(struct rdma_cm_id *id, struct sockaddr *addr);
200 
201 /**
202  * rdma_resolve_addr - Resolve destination and optional source addresses
203  *   from IP addresses to an RDMA address.  If successful, the specified
204  *   rdma_cm_id will be bound to a local device.
205  *
206  * @id: RDMA identifier.
207  * @src_addr: Source address information.  This parameter may be NULL.
208  * @dst_addr: Destination address information.
209  * @timeout_ms: Time to wait for resolution to complete.
210  */
211 int rdma_resolve_addr(struct rdma_cm_id *id, struct sockaddr *src_addr,
212 		      struct sockaddr *dst_addr, int timeout_ms);
213 
214 /**
215  * rdma_resolve_route - Resolve the RDMA address bound to the RDMA identifier
216  *   into route information needed to establish a connection.
217  *
218  * This is called on the client side of a connection.
219  * Users must have first called rdma_resolve_addr to resolve a dst_addr
220  * into an RDMA address before calling this routine.
221  */
222 int rdma_resolve_route(struct rdma_cm_id *id, int timeout_ms);
223 
224 /**
225  * rdma_enable_apm - Get ready to use APM for the given ID.
226  * Actual Alternate path discovery and load will take place only
227  * after a connection has been established.
228  *
229  * Calling this function only has an effect on the connection's client side.
230  * It should be called after rdma_resolve_route and before rdma_connect.
231  *
232  * @id: RDMA identifier.
233  * @alt_type: Alternate path type to resolve.
234  */
235 int rdma_enable_apm(struct rdma_cm_id *id, enum alt_path_type alt_type);
236 
237 /**
238  * rdma_create_qp - Allocate a QP and associate it with the specified RDMA
239  * identifier.
240  *
241  * QPs allocated to an rdma_cm_id will automatically be transitioned by the CMA
242  * through their states.
243  */
244 int rdma_create_qp(struct rdma_cm_id *id, struct ib_pd *pd,
245 		   struct ib_qp_init_attr *qp_init_attr);
246 
247 /**
248  * rdma_destroy_qp - Deallocate the QP associated with the specified RDMA
249  * identifier.
250  *
251  * Users must destroy any QP associated with an RDMA identifier before
252  * destroying the RDMA ID.
253  */
254 void rdma_destroy_qp(struct rdma_cm_id *id);
255 
256 /**
257  * rdma_init_qp_attr - Initializes the QP attributes for use in transitioning
258  *   to a specified QP state.
259  * @id: Communication identifier associated with the QP attributes to
260  *   initialize.
261  * @qp_attr: On input, specifies the desired QP state.  On output, the
262  *   mandatory and desired optional attributes will be set in order to
263  *   modify the QP to the specified state.
264  * @qp_attr_mask: The QP attribute mask that may be used to transition the
265  *   QP to the specified state.
266  *
267  * Users must set the @qp_attr->qp_state to the desired QP state.  This call
268  * will set all required attributes for the given transition, along with
269  * known optional attributes.  Users may override the attributes returned from
270  * this call before calling ib_modify_qp.
271  *
272  * Users that wish to have their QP automatically transitioned through its
273  * states can associate a QP with the rdma_cm_id by calling rdma_create_qp().
274  */
275 int rdma_init_qp_attr(struct rdma_cm_id *id, struct ib_qp_attr *qp_attr,
276 		       int *qp_attr_mask);
277 
278 /**
279  * rdma_connect - Initiate an active connection request.
280  * @id: Connection identifier to connect.
281  * @conn_param: Connection information used for connected QPs.
282  *
283  * Users must have resolved a route for the rdma_cm_id to connect with
284  * by having called rdma_resolve_route before calling this routine.
285  *
286  * This call will either connect to a remote QP or obtain remote QP
287  * information for unconnected rdma_cm_id's.  The actual operation is
288  * based on the rdma_cm_id's port space.
289  */
290 int rdma_connect(struct rdma_cm_id *id, struct rdma_conn_param *conn_param);
291 
292 /**
293  * rdma_listen - This function is called by the passive side to
294  *   listen for incoming connection requests.
295  *
296  * Users must have bound the rdma_cm_id to a local address by calling
297  * rdma_bind_addr before calling this routine.
298  */
299 int rdma_listen(struct rdma_cm_id *id, int backlog);
300 
301 /**
302  * rdma_accept - Called to accept a connection request or response.
303  * @id: Connection identifier associated with the request.
304  * @conn_param: Information needed to establish the connection.  This must be
305  *   provided if accepting a connection request.  If accepting a connection
306  *   response, this parameter must be NULL.
307  *
308  * Typically, this routine is only called by the listener to accept a connection
309  * request.  It must also be called on the active side of a connection if the
310  * user is performing their own QP transitions.
311  *
312  * In the case of error, a reject message is sent to the remote side and the
313  * state of the qp associated with the id is modified to error, such that any
314  * previously posted receive buffers would be flushed.
315  */
316 int rdma_accept(struct rdma_cm_id *id, struct rdma_conn_param *conn_param);
317 
318 /**
319  * rdma_notify - Notifies the RDMA CM of an asynchronous event that has
320  * occurred on the connection.
321  * @id: Connection identifier to transition to established.
322  * @event: Asynchronous event.
323  *
324  * This routine should be invoked by users to notify the CM of relevant
325  * communication events.  Events that should be reported to the CM and
326  * when to report them are:
327  *
328  * IB_EVENT_COMM_EST - Used when a message is received on a connected
329  *    QP before an RTU has been received.
330  */
331 int rdma_notify(struct rdma_cm_id *id, enum ib_event_type event);
332 
333 /**
334  * rdma_reject - Called to reject a connection request or response.
335  */
336 int rdma_reject(struct rdma_cm_id *id, const void *private_data,
337 		u8 private_data_len);
338 
339 /**
340  * rdma_disconnect - This function disconnects the associated QP and
341  *   transitions it into the error state.
342  */
343 int rdma_disconnect(struct rdma_cm_id *id);
344 
345 /**
346  * rdma_join_multicast - Join the multicast group specified by the given
347  *   address.
348  * @id: Communication identifier associated with the request.
349  * @addr: Multicast address identifying the group to join.
350  * @context: User-defined context associated with the join request, returned
351  * to the user through the private_data pointer in multicast events.
352  */
353 int rdma_join_multicast(struct rdma_cm_id *id, struct sockaddr *addr,
354 			void *context);
355 
356 /**
357  * rdma_leave_multicast - Leave the multicast group specified by the given
358  *   address.
359  */
360 void rdma_leave_multicast(struct rdma_cm_id *id, struct sockaddr *addr);
361 
362 /**
363  * rdma_set_service_type - Set the type of service associated with a
364  *   connection identifier.
365  * @id: Communication identifier to associated with service type.
366  * @tos: Type of service.
367  *
368  * The type of service is interpretted as a differentiated service
369  * field (RFC 2474).  The service type should be specified before
370  * performing route resolution, as existing communication on the
371  * connection identifier may be unaffected.  The type of service
372  * requested may not be supported by the network to all destinations.
373  */
374 void rdma_set_service_type(struct rdma_cm_id *id, int tos);
375 
376 /**
377  * rdma_set_reuseaddr - Allow the reuse of local addresses when binding
378  *    the rdma_cm_id.
379  * @id: Communication identifier to configure.
380  * @reuse: Value indicating if the bound address is reusable.
381  *
382  * Reuse must be set before an address is bound to the id.
383  */
384 int rdma_set_reuseaddr(struct rdma_cm_id *id, int reuse);
385 
386 /**
387  * rdma_set_afonly - Specify that listens are restricted to the
388  *    bound address family only.
389  * @id: Communication identifer to configure.
390  * @afonly: Value indicating if listens are restricted.
391  *
392  * Must be set before identifier is in the listening state.
393  */
394 int rdma_set_afonly(struct rdma_cm_id *id, int afonly);
395 
396 /**
397  * rdma_set_timeout - Set the QP timeout associated with a connection
398  * identifier.
399  * @id: Communication identifier to associated with service type.
400  * @timeout: QP timeout
401  */
402 void rdma_set_timeout(struct rdma_cm_id *id, int timeout);
403 
404 #endif /* RDMA_CM_H */
405