Merge tag 'fbdev-v5.2' of git://github.com/bzolnier/linux
[sfrench/cifs-2.6.git] / include / rdma / rdma_cm.h
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 #include <uapi/rdma/rdma_user_cm.h>
42
43 /*
44  * Upon receiving a device removal event, users must destroy the associated
45  * RDMA identifier and release all resources allocated with the device.
46  */
47 enum rdma_cm_event_type {
48         RDMA_CM_EVENT_ADDR_RESOLVED,
49         RDMA_CM_EVENT_ADDR_ERROR,
50         RDMA_CM_EVENT_ROUTE_RESOLVED,
51         RDMA_CM_EVENT_ROUTE_ERROR,
52         RDMA_CM_EVENT_CONNECT_REQUEST,
53         RDMA_CM_EVENT_CONNECT_RESPONSE,
54         RDMA_CM_EVENT_CONNECT_ERROR,
55         RDMA_CM_EVENT_UNREACHABLE,
56         RDMA_CM_EVENT_REJECTED,
57         RDMA_CM_EVENT_ESTABLISHED,
58         RDMA_CM_EVENT_DISCONNECTED,
59         RDMA_CM_EVENT_DEVICE_REMOVAL,
60         RDMA_CM_EVENT_MULTICAST_JOIN,
61         RDMA_CM_EVENT_MULTICAST_ERROR,
62         RDMA_CM_EVENT_ADDR_CHANGE,
63         RDMA_CM_EVENT_TIMEWAIT_EXIT
64 };
65
66 const char *__attribute_const__ rdma_event_msg(enum rdma_cm_event_type event);
67
68 #define RDMA_IB_IP_PS_MASK   0xFFFFFFFFFFFF0000ULL
69 #define RDMA_IB_IP_PS_TCP    0x0000000001060000ULL
70 #define RDMA_IB_IP_PS_UDP    0x0000000001110000ULL
71 #define RDMA_IB_IP_PS_IB     0x00000000013F0000ULL
72
73 struct rdma_addr {
74         struct sockaddr_storage src_addr;
75         struct sockaddr_storage dst_addr;
76         struct rdma_dev_addr dev_addr;
77 };
78
79 struct rdma_route {
80         struct rdma_addr addr;
81         struct sa_path_rec *path_rec;
82         int num_paths;
83 };
84
85 struct rdma_conn_param {
86         const void *private_data;
87         u8 private_data_len;
88         u8 responder_resources;
89         u8 initiator_depth;
90         u8 flow_control;
91         u8 retry_count;         /* ignored when accepting */
92         u8 rnr_retry_count;
93         /* Fields below ignored if a QP is created on the rdma_cm_id. */
94         u8 srq;
95         u32 qp_num;
96         u32 qkey;
97 };
98
99 struct rdma_ud_param {
100         const void *private_data;
101         u8 private_data_len;
102         struct rdma_ah_attr ah_attr;
103         u32 qp_num;
104         u32 qkey;
105 };
106
107 struct rdma_cm_event {
108         enum rdma_cm_event_type  event;
109         int                      status;
110         union {
111                 struct rdma_conn_param  conn;
112                 struct rdma_ud_param    ud;
113         } param;
114 };
115
116 struct rdma_cm_id;
117
118 /**
119  * rdma_cm_event_handler - Callback used to report user events.
120  *
121  * Notes: Users may not call rdma_destroy_id from this callback to destroy
122  *   the passed in id, or a corresponding listen id.  Returning a
123  *   non-zero value from the callback will destroy the passed in id.
124  */
125 typedef int (*rdma_cm_event_handler)(struct rdma_cm_id *id,
126                                      struct rdma_cm_event *event);
127
128 struct rdma_cm_id {
129         struct ib_device        *device;
130         void                    *context;
131         struct ib_qp            *qp;
132         rdma_cm_event_handler    event_handler;
133         struct rdma_route        route;
134         enum rdma_ucm_port_space ps;
135         enum ib_qp_type          qp_type;
136         u8                       port_num;
137 };
138
139 struct rdma_cm_id *__rdma_create_id(struct net *net,
140                                     rdma_cm_event_handler event_handler,
141                                     void *context, enum rdma_ucm_port_space ps,
142                                     enum ib_qp_type qp_type,
143                                     const char *caller);
144
145 /**
146  * rdma_create_id - Create an RDMA identifier.
147  *
148  * @net: The network namespace in which to create the new id.
149  * @event_handler: User callback invoked to report events associated with the
150  *   returned rdma_id.
151  * @context: User specified context associated with the id.
152  * @ps: RDMA port space.
153  * @qp_type: type of queue pair associated with the id.
154  *
155  * Returns a new rdma_cm_id. The id holds a reference on the network
156  * namespace until it is destroyed.
157  *
158  * The event handler callback serializes on the id's mutex and is
159  * allowed to sleep.
160  */
161 #define rdma_create_id(net, event_handler, context, ps, qp_type) \
162         __rdma_create_id((net), (event_handler), (context), (ps), (qp_type), \
163                          KBUILD_MODNAME)
164
165 /**
166   * rdma_destroy_id - Destroys an RDMA identifier.
167   *
168   * @id: RDMA identifier.
169   *
170   * Note: calling this function has the effect of canceling in-flight
171   * asynchronous operations associated with the id.
172   */
173 void rdma_destroy_id(struct rdma_cm_id *id);
174
175 /**
176  * rdma_bind_addr - Bind an RDMA identifier to a source address and
177  *   associated RDMA device, if needed.
178  *
179  * @id: RDMA identifier.
180  * @addr: Local address information.  Wildcard values are permitted.
181  *
182  * This associates a source address with the RDMA identifier before calling
183  * rdma_listen.  If a specific local address is given, the RDMA identifier will
184  * be bound to a local RDMA device.
185  */
186 int rdma_bind_addr(struct rdma_cm_id *id, struct sockaddr *addr);
187
188 /**
189  * rdma_resolve_addr - Resolve destination and optional source addresses
190  *   from IP addresses to an RDMA address.  If successful, the specified
191  *   rdma_cm_id will be bound to a local device.
192  *
193  * @id: RDMA identifier.
194  * @src_addr: Source address information.  This parameter may be NULL.
195  * @dst_addr: Destination address information.
196  * @timeout_ms: Time to wait for resolution to complete.
197  */
198 int rdma_resolve_addr(struct rdma_cm_id *id, struct sockaddr *src_addr,
199                       const struct sockaddr *dst_addr,
200                       unsigned long timeout_ms);
201
202 /**
203  * rdma_resolve_route - Resolve the RDMA address bound to the RDMA identifier
204  *   into route information needed to establish a connection.
205  *
206  * This is called on the client side of a connection.
207  * Users must have first called rdma_resolve_addr to resolve a dst_addr
208  * into an RDMA address before calling this routine.
209  */
210 int rdma_resolve_route(struct rdma_cm_id *id, unsigned long timeout_ms);
211
212 /**
213  * rdma_create_qp - Allocate a QP and associate it with the specified RDMA
214  * identifier.
215  *
216  * QPs allocated to an rdma_cm_id will automatically be transitioned by the CMA
217  * through their states.
218  */
219 int rdma_create_qp(struct rdma_cm_id *id, struct ib_pd *pd,
220                    struct ib_qp_init_attr *qp_init_attr);
221
222 /**
223  * rdma_destroy_qp - Deallocate the QP associated with the specified RDMA
224  * identifier.
225  *
226  * Users must destroy any QP associated with an RDMA identifier before
227  * destroying the RDMA ID.
228  */
229 void rdma_destroy_qp(struct rdma_cm_id *id);
230
231 /**
232  * rdma_init_qp_attr - Initializes the QP attributes for use in transitioning
233  *   to a specified QP state.
234  * @id: Communication identifier associated with the QP attributes to
235  *   initialize.
236  * @qp_attr: On input, specifies the desired QP state.  On output, the
237  *   mandatory and desired optional attributes will be set in order to
238  *   modify the QP to the specified state.
239  * @qp_attr_mask: The QP attribute mask that may be used to transition the
240  *   QP to the specified state.
241  *
242  * Users must set the @qp_attr->qp_state to the desired QP state.  This call
243  * will set all required attributes for the given transition, along with
244  * known optional attributes.  Users may override the attributes returned from
245  * this call before calling ib_modify_qp.
246  *
247  * Users that wish to have their QP automatically transitioned through its
248  * states can associate a QP with the rdma_cm_id by calling rdma_create_qp().
249  */
250 int rdma_init_qp_attr(struct rdma_cm_id *id, struct ib_qp_attr *qp_attr,
251                        int *qp_attr_mask);
252
253 /**
254  * rdma_connect - Initiate an active connection request.
255  * @id: Connection identifier to connect.
256  * @conn_param: Connection information used for connected QPs.
257  *
258  * Users must have resolved a route for the rdma_cm_id to connect with
259  * by having called rdma_resolve_route before calling this routine.
260  *
261  * This call will either connect to a remote QP or obtain remote QP
262  * information for unconnected rdma_cm_id's.  The actual operation is
263  * based on the rdma_cm_id's port space.
264  */
265 int rdma_connect(struct rdma_cm_id *id, struct rdma_conn_param *conn_param);
266
267 /**
268  * rdma_listen - This function is called by the passive side to
269  *   listen for incoming connection requests.
270  *
271  * Users must have bound the rdma_cm_id to a local address by calling
272  * rdma_bind_addr before calling this routine.
273  */
274 int rdma_listen(struct rdma_cm_id *id, int backlog);
275
276 int __rdma_accept(struct rdma_cm_id *id, struct rdma_conn_param *conn_param,
277                   const char *caller);
278
279 /**
280  * rdma_accept - Called to accept a connection request or response.
281  * @id: Connection identifier associated with the request.
282  * @conn_param: Information needed to establish the connection.  This must be
283  *   provided if accepting a connection request.  If accepting a connection
284  *   response, this parameter must be NULL.
285  *
286  * Typically, this routine is only called by the listener to accept a connection
287  * request.  It must also be called on the active side of a connection if the
288  * user is performing their own QP transitions.
289  *
290  * In the case of error, a reject message is sent to the remote side and the
291  * state of the qp associated with the id is modified to error, such that any
292  * previously posted receive buffers would be flushed.
293  */
294 #define rdma_accept(id, conn_param) \
295         __rdma_accept((id), (conn_param),  KBUILD_MODNAME)
296
297 /**
298  * rdma_notify - Notifies the RDMA CM of an asynchronous event that has
299  * occurred on the connection.
300  * @id: Connection identifier to transition to established.
301  * @event: Asynchronous event.
302  *
303  * This routine should be invoked by users to notify the CM of relevant
304  * communication events.  Events that should be reported to the CM and
305  * when to report them are:
306  *
307  * IB_EVENT_COMM_EST - Used when a message is received on a connected
308  *    QP before an RTU has been received.
309  */
310 int rdma_notify(struct rdma_cm_id *id, enum ib_event_type event);
311
312 /**
313  * rdma_reject - Called to reject a connection request or response.
314  */
315 int rdma_reject(struct rdma_cm_id *id, const void *private_data,
316                 u8 private_data_len);
317
318 /**
319  * rdma_disconnect - This function disconnects the associated QP and
320  *   transitions it into the error state.
321  */
322 int rdma_disconnect(struct rdma_cm_id *id);
323
324 /**
325  * rdma_join_multicast - Join the multicast group specified by the given
326  *   address.
327  * @id: Communication identifier associated with the request.
328  * @addr: Multicast address identifying the group to join.
329  * @join_state: Multicast JoinState bitmap requested by port.
330  *              Bitmap is based on IB_SA_MCMEMBER_REC_JOIN_STATE bits.
331  * @context: User-defined context associated with the join request, returned
332  * to the user through the private_data pointer in multicast events.
333  */
334 int rdma_join_multicast(struct rdma_cm_id *id, struct sockaddr *addr,
335                         u8 join_state, void *context);
336
337 /**
338  * rdma_leave_multicast - Leave the multicast group specified by the given
339  *   address.
340  */
341 void rdma_leave_multicast(struct rdma_cm_id *id, struct sockaddr *addr);
342
343 /**
344  * rdma_set_service_type - Set the type of service associated with a
345  *   connection identifier.
346  * @id: Communication identifier to associated with service type.
347  * @tos: Type of service.
348  *
349  * The type of service is interpretted as a differentiated service
350  * field (RFC 2474).  The service type should be specified before
351  * performing route resolution, as existing communication on the
352  * connection identifier may be unaffected.  The type of service
353  * requested may not be supported by the network to all destinations.
354  */
355 void rdma_set_service_type(struct rdma_cm_id *id, int tos);
356
357 /**
358  * rdma_set_reuseaddr - Allow the reuse of local addresses when binding
359  *    the rdma_cm_id.
360  * @id: Communication identifier to configure.
361  * @reuse: Value indicating if the bound address is reusable.
362  *
363  * Reuse must be set before an address is bound to the id.
364  */
365 int rdma_set_reuseaddr(struct rdma_cm_id *id, int reuse);
366
367 /**
368  * rdma_set_afonly - Specify that listens are restricted to the
369  *    bound address family only.
370  * @id: Communication identifer to configure.
371  * @afonly: Value indicating if listens are restricted.
372  *
373  * Must be set before identifier is in the listening state.
374  */
375 int rdma_set_afonly(struct rdma_cm_id *id, int afonly);
376
377 int rdma_set_ack_timeout(struct rdma_cm_id *id, u8 timeout);
378  /**
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
385 /**
386  * rdma_reject_msg - return a pointer to a reject message string.
387  * @id: Communication identifier that received the REJECT event.
388  * @reason: Value returned in the REJECT event status field.
389  */
390 const char *__attribute_const__ rdma_reject_msg(struct rdma_cm_id *id,
391                                                 int reason);
392 /**
393  * rdma_is_consumer_reject - return true if the consumer rejected the connect
394  *                           request.
395  * @id: Communication identifier that received the REJECT event.
396  * @reason: Value returned in the REJECT event status field.
397  */
398 bool rdma_is_consumer_reject(struct rdma_cm_id *id, int reason);
399
400 /**
401  * rdma_consumer_reject_data - return the consumer reject private data and
402  *                             length, if any.
403  * @id: Communication identifier that received the REJECT event.
404  * @ev: RDMA CM reject event.
405  * @data_len: Pointer to the resulting length of the consumer data.
406  */
407 const void *rdma_consumer_reject_data(struct rdma_cm_id *id,
408                                       struct rdma_cm_event *ev, u8 *data_len);
409
410 /**
411  * rdma_read_gids - Return the SGID and DGID used for establishing
412  *                  connection. This can be used after rdma_resolve_addr()
413  *                  on client side. This can be use on new connection
414  *                  on server side. This is applicable to IB, RoCE, iWarp.
415  *                  If cm_id is not bound yet to the RDMA device, it doesn't
416  *                  copy and SGID or DGID to the given pointers.
417  * @id: Communication identifier whose GIDs are queried.
418  * @sgid: Pointer to SGID where SGID will be returned. It is optional.
419  * @dgid: Pointer to DGID where DGID will be returned. It is optional.
420  * Note: This API should not be used by any new ULPs or new code.
421  * Instead, users interested in querying GIDs should refer to path record
422  * of the rdma_cm_id to query the GIDs.
423  * This API is provided for compatibility for existing users.
424  */
425
426 void rdma_read_gids(struct rdma_cm_id *cm_id, union ib_gid *sgid,
427                     union ib_gid *dgid);
428
429 struct iw_cm_id *rdma_iw_cm_id(struct rdma_cm_id *cm_id);
430 struct rdma_cm_id *rdma_res_to_id(struct rdma_restrack_entry *res);
431
432 #endif /* RDMA_CM_H */