1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 3 * 4 * Copyright (c) 2005 Voltaire Inc. All rights reserved. 5 * Copyright (c) 2005 Intel Corporation. All rights reserved. 6 * 7 * This software is available to you under a choice of one of two 8 * licenses. You may choose to be licensed under the terms of the GNU 9 * General Public License (GPL) Version 2, available from the file 10 * COPYING in the main directory of this source tree, or the 11 * OpenIB.org BSD license below: 12 * 13 * Redistribution and use in source and binary forms, with or 14 * without modification, are permitted provided that the following 15 * conditions are met: 16 * 17 * - Redistributions of source code must retain the above 18 * copyright notice, this list of conditions and the following 19 * disclaimer. 20 * 21 * - Redistributions in binary form must reproduce the above 22 * copyright notice, this list of conditions and the following 23 * disclaimer in the documentation and/or other materials 24 * provided with the distribution. 25 * 26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 27 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 29 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 30 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN 31 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 32 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 33 * SOFTWARE. 34 * 35 * $FreeBSD$ 36 */ 37 38 #if !defined(RDMA_CM_H) 39 #define RDMA_CM_H 40 41 #include <linux/socket.h> 42 #include <linux/in6.h> 43 #include <rdma/ib_addr.h> 44 #include <rdma/ib_sa.h> 45 46 /* 47 * Upon receiving a device removal event, users must destroy the associated 48 * RDMA identifier and release all resources allocated with the device. 49 */ 50 enum rdma_cm_event_type { 51 RDMA_CM_EVENT_ADDR_RESOLVED, 52 RDMA_CM_EVENT_ADDR_ERROR, 53 RDMA_CM_EVENT_ROUTE_RESOLVED, 54 RDMA_CM_EVENT_ROUTE_ERROR, 55 RDMA_CM_EVENT_CONNECT_REQUEST, 56 RDMA_CM_EVENT_CONNECT_RESPONSE, 57 RDMA_CM_EVENT_CONNECT_ERROR, 58 RDMA_CM_EVENT_UNREACHABLE, 59 RDMA_CM_EVENT_REJECTED, 60 RDMA_CM_EVENT_ESTABLISHED, 61 RDMA_CM_EVENT_DISCONNECTED, 62 RDMA_CM_EVENT_DEVICE_REMOVAL, 63 RDMA_CM_EVENT_MULTICAST_JOIN, 64 RDMA_CM_EVENT_MULTICAST_ERROR, 65 RDMA_CM_EVENT_ADDR_CHANGE, 66 RDMA_CM_EVENT_TIMEWAIT_EXIT 67 }; 68 69 const char *__attribute_const__ rdma_event_msg(enum rdma_cm_event_type event); 70 71 enum rdma_port_space { 72 RDMA_PS_SDP = 0x0001, 73 RDMA_PS_IPOIB = 0x0002, 74 RDMA_PS_IB = 0x013F, 75 RDMA_PS_TCP = 0x0106, 76 RDMA_PS_UDP = 0x0111, 77 }; 78 79 #define RDMA_IB_IP_PS_MASK 0xFFFFFFFFFFFF0000ULL 80 #define RDMA_IB_IP_PS_TCP 0x0000000001060000ULL 81 #define RDMA_IB_IP_PS_UDP 0x0000000001110000ULL 82 #define RDMA_IB_IP_PS_IB 0x00000000013F0000ULL 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 u32 qkey; 108 }; 109 110 struct rdma_ud_param { 111 const void *private_data; 112 u8 private_data_len; 113 struct ib_ah_attr ah_attr; 114 u32 qp_num; 115 u32 qkey; 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 }; 163 164 /** 165 * rdma_create_id - Create an RDMA identifier. 166 * 167 * @net: The network namespace in which to create the new id. 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 * The id holds a reference on the network namespace until it is destroyed. 175 */ 176 struct rdma_cm_id *rdma_create_id(struct vnet *net, 177 rdma_cm_event_handler event_handler, 178 void *context, enum rdma_port_space ps, 179 enum ib_qp_type qp_type); 180 181 /** 182 * rdma_destroy_id - Destroys an RDMA identifier. 183 * 184 * @id: RDMA identifier. 185 * 186 * Note: calling this function has the effect of canceling in-flight 187 * asynchronous operations associated with the id. 188 */ 189 void rdma_destroy_id(struct rdma_cm_id *id); 190 191 /** 192 * rdma_bind_addr - Bind an RDMA identifier to a source address and 193 * associated RDMA device, if needed. 194 * 195 * @id: RDMA identifier. 196 * @addr: Local address information. Wildcard values are permitted. 197 * 198 * This associates a source address with the RDMA identifier before calling 199 * rdma_listen. If a specific local address is given, the RDMA identifier will 200 * be bound to a local RDMA device. 201 */ 202 int rdma_bind_addr(struct rdma_cm_id *id, struct sockaddr *addr); 203 204 /** 205 * rdma_resolve_addr - Resolve destination and optional source addresses 206 * from IP addresses to an RDMA address. If successful, the specified 207 * rdma_cm_id will be bound to a local device. 208 * 209 * @id: RDMA identifier. 210 * @src_addr: Source address information. This parameter may be NULL. 211 * @dst_addr: Destination address information. 212 * @timeout_ms: Time to wait for resolution to complete. 213 */ 214 int rdma_resolve_addr(struct rdma_cm_id *id, struct sockaddr *src_addr, 215 struct sockaddr *dst_addr, int timeout_ms); 216 217 /** 218 * rdma_resolve_route - Resolve the RDMA address bound to the RDMA identifier 219 * into route information needed to establish a connection. 220 * 221 * This is called on the client side of a connection. 222 * Users must have first called rdma_resolve_addr to resolve a dst_addr 223 * into an RDMA address before calling this routine. 224 */ 225 int rdma_resolve_route(struct rdma_cm_id *id, int timeout_ms); 226 227 /** 228 * rdma_create_qp - Allocate a QP and associate it with the specified RDMA 229 * identifier. 230 * 231 * QPs allocated to an rdma_cm_id will automatically be transitioned by the CMA 232 * through their states. 233 */ 234 int rdma_create_qp(struct rdma_cm_id *id, struct ib_pd *pd, 235 struct ib_qp_init_attr *qp_init_attr); 236 237 /** 238 * rdma_destroy_qp - Deallocate the QP associated with the specified RDMA 239 * identifier. 240 * 241 * Users must destroy any QP associated with an RDMA identifier before 242 * destroying the RDMA ID. 243 */ 244 void rdma_destroy_qp(struct rdma_cm_id *id); 245 246 /** 247 * rdma_init_qp_attr - Initializes the QP attributes for use in transitioning 248 * to a specified QP state. 249 * @id: Communication identifier associated with the QP attributes to 250 * initialize. 251 * @qp_attr: On input, specifies the desired QP state. On output, the 252 * mandatory and desired optional attributes will be set in order to 253 * modify the QP to the specified state. 254 * @qp_attr_mask: The QP attribute mask that may be used to transition the 255 * QP to the specified state. 256 * 257 * Users must set the @qp_attr->qp_state to the desired QP state. This call 258 * will set all required attributes for the given transition, along with 259 * known optional attributes. Users may override the attributes returned from 260 * this call before calling ib_modify_qp. 261 * 262 * Users that wish to have their QP automatically transitioned through its 263 * states can associate a QP with the rdma_cm_id by calling rdma_create_qp(). 264 */ 265 int rdma_init_qp_attr(struct rdma_cm_id *id, struct ib_qp_attr *qp_attr, 266 int *qp_attr_mask); 267 268 /** 269 * rdma_connect - Initiate an active connection request. 270 * @id: Connection identifier to connect. 271 * @conn_param: Connection information used for connected QPs. 272 * 273 * Users must have resolved a route for the rdma_cm_id to connect with 274 * by having called rdma_resolve_route before calling this routine. 275 * 276 * This call will either connect to a remote QP or obtain remote QP 277 * information for unconnected rdma_cm_id's. The actual operation is 278 * based on the rdma_cm_id's port space. 279 */ 280 int rdma_connect(struct rdma_cm_id *id, struct rdma_conn_param *conn_param); 281 282 /** 283 * rdma_listen - This function is called by the passive side to 284 * listen for incoming connection requests. 285 * 286 * Users must have bound the rdma_cm_id to a local address by calling 287 * rdma_bind_addr before calling this routine. 288 */ 289 int rdma_listen(struct rdma_cm_id *id, int backlog); 290 291 /** 292 * rdma_accept - Called to accept a connection request or response. 293 * @id: Connection identifier associated with the request. 294 * @conn_param: Information needed to establish the connection. This must be 295 * provided if accepting a connection request. If accepting a connection 296 * response, this parameter must be NULL. 297 * 298 * Typically, this routine is only called by the listener to accept a connection 299 * request. It must also be called on the active side of a connection if the 300 * user is performing their own QP transitions. 301 * 302 * In the case of error, a reject message is sent to the remote side and the 303 * state of the qp associated with the id is modified to error, such that any 304 * previously posted receive buffers would be flushed. 305 */ 306 int rdma_accept(struct rdma_cm_id *id, struct rdma_conn_param *conn_param); 307 308 /** 309 * rdma_notify - Notifies the RDMA CM of an asynchronous event that has 310 * occurred on the connection. 311 * @id: Connection identifier to transition to established. 312 * @event: Asynchronous event. 313 * 314 * This routine should be invoked by users to notify the CM of relevant 315 * communication events. Events that should be reported to the CM and 316 * when to report them are: 317 * 318 * IB_EVENT_COMM_EST - Used when a message is received on a connected 319 * QP before an RTU has been received. 320 */ 321 int rdma_notify(struct rdma_cm_id *id, enum ib_event_type event); 322 323 /** 324 * rdma_reject - Called to reject a connection request or response. 325 */ 326 int rdma_reject(struct rdma_cm_id *id, const void *private_data, 327 u8 private_data_len); 328 329 /** 330 * rdma_disconnect - This function disconnects the associated QP and 331 * transitions it into the error state. 332 */ 333 int rdma_disconnect(struct rdma_cm_id *id); 334 335 /** 336 * rdma_join_multicast - Join the multicast group specified by the given 337 * address. 338 * @id: Communication identifier associated with the request. 339 * @addr: Multicast address identifying the group to join. 340 * @join_state: Multicast JoinState bitmap requested by port. 341 * Bitmap is based on IB_SA_MCMEMBER_REC_JOIN_STATE bits. 342 * @context: User-defined context associated with the join request, returned 343 * to the user through the private_data pointer in multicast events. 344 */ 345 int rdma_join_multicast(struct rdma_cm_id *id, struct sockaddr *addr, 346 u8 join_state, void *context); 347 348 /** 349 * rdma_leave_multicast - Leave the multicast group specified by the given 350 * address. 351 */ 352 void rdma_leave_multicast(struct rdma_cm_id *id, struct sockaddr *addr); 353 354 /** 355 * rdma_set_service_type - Set the type of service associated with a 356 * connection identifier. 357 * @id: Communication identifier to associated with service type. 358 * @tos: Type of service. 359 * 360 * The type of service is interpretted as a differentiated service 361 * field (RFC 2474). The service type should be specified before 362 * performing route resolution, as existing communication on the 363 * connection identifier may be unaffected. The type of service 364 * requested may not be supported by the network to all destinations. 365 */ 366 void rdma_set_service_type(struct rdma_cm_id *id, int tos); 367 368 /** 369 * rdma_set_reuseaddr - Allow the reuse of local addresses when binding 370 * the rdma_cm_id. 371 * @id: Communication identifier to configure. 372 * @reuse: Value indicating if the bound address is reusable. 373 * 374 * Reuse must be set before an address is bound to the id. 375 */ 376 int rdma_set_reuseaddr(struct rdma_cm_id *id, int reuse); 377 378 /** 379 * rdma_set_afonly - Specify that listens are restricted to the 380 * bound address family only. 381 * @id: Communication identifer to configure. 382 * @afonly: Value indicating if listens are restricted. 383 * 384 * Must be set before identifier is in the listening state. 385 */ 386 int rdma_set_afonly(struct rdma_cm_id *id, int afonly); 387 388 /** 389 * rdma_get_service_id - Return the IB service ID for a specified address. 390 * @id: Communication identifier associated with the address. 391 * @addr: Address for the service ID. 392 */ 393 __be64 rdma_get_service_id(struct rdma_cm_id *id, struct sockaddr *addr); 394 395 #endif /* RDMA_CM_H */ 396