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