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