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 }; 64 65 enum rdma_port_space { 66 RDMA_PS_SDP = 0x0001, 67 RDMA_PS_IPOIB = 0x0002, 68 RDMA_PS_IB = 0x013F, 69 RDMA_PS_TCP = 0x0106, 70 RDMA_PS_UDP = 0x0111, 71 }; 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 ib_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 }; 97 98 struct rdma_ud_param { 99 const void *private_data; 100 u8 private_data_len; 101 struct ib_ah_attr ah_attr; 102 u32 qp_num; 103 u32 qkey; 104 }; 105 106 struct rdma_cm_event { 107 enum rdma_cm_event_type event; 108 int status; 109 union { 110 struct rdma_conn_param conn; 111 struct rdma_ud_param ud; 112 } param; 113 }; 114 115 enum rdma_cm_state { 116 RDMA_CM_IDLE, 117 RDMA_CM_ADDR_QUERY, 118 RDMA_CM_ADDR_RESOLVED, 119 RDMA_CM_ROUTE_QUERY, 120 RDMA_CM_ROUTE_RESOLVED, 121 RDMA_CM_CONNECT, 122 RDMA_CM_DISCONNECT, 123 RDMA_CM_ADDR_BOUND, 124 RDMA_CM_LISTEN, 125 RDMA_CM_DEVICE_REMOVAL, 126 RDMA_CM_DESTROYING 127 }; 128 129 struct rdma_cm_id; 130 131 /** 132 * rdma_cm_event_handler - Callback used to report user events. 133 * 134 * Notes: Users may not call rdma_destroy_id from this callback to destroy 135 * the passed in id, or a corresponding listen id. Returning a 136 * non-zero value from the callback will destroy the passed in id. 137 */ 138 typedef int (*rdma_cm_event_handler)(struct rdma_cm_id *id, 139 struct rdma_cm_event *event); 140 141 struct rdma_cm_id { 142 struct ib_device *device; 143 void *context; 144 struct ib_qp *qp; 145 rdma_cm_event_handler event_handler; 146 struct rdma_route route; 147 enum rdma_port_space ps; 148 enum ib_qp_type qp_type; 149 u8 port_num; 150 }; 151 152 /** 153 * rdma_create_id - Create an RDMA identifier. 154 * 155 * @event_handler: User callback invoked to report events associated with the 156 * returned rdma_id. 157 * @context: User specified context associated with the id. 158 * @ps: RDMA port space. 159 * @qp_type: type of queue pair associated with the id. 160 */ 161 struct rdma_cm_id *rdma_create_id(rdma_cm_event_handler event_handler, 162 void *context, enum rdma_port_space ps, 163 enum ib_qp_type qp_type); 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 struct sockaddr *dst_addr, int timeout_ms); 200 201 /** 202 * rdma_resolve_route - Resolve the RDMA address bound to the RDMA identifier 203 * into route information needed to establish a connection. 204 * 205 * This is called on the client side of a connection. 206 * Users must have first called rdma_resolve_addr to resolve a dst_addr 207 * into an RDMA address before calling this routine. 208 */ 209 int rdma_resolve_route(struct rdma_cm_id *id, int timeout_ms); 210 211 /** 212 * rdma_create_qp - Allocate a QP and associate it with the specified RDMA 213 * identifier. 214 * 215 * QPs allocated to an rdma_cm_id will automatically be transitioned by the CMA 216 * through their states. 217 */ 218 int rdma_create_qp(struct rdma_cm_id *id, struct ib_pd *pd, 219 struct ib_qp_init_attr *qp_init_attr); 220 221 /** 222 * rdma_destroy_qp - Deallocate the QP associated with the specified RDMA 223 * identifier. 224 * 225 * Users must destroy any QP associated with an RDMA identifier before 226 * destroying the RDMA ID. 227 */ 228 void rdma_destroy_qp(struct rdma_cm_id *id); 229 230 /** 231 * rdma_init_qp_attr - Initializes the QP attributes for use in transitioning 232 * to a specified QP state. 233 * @id: Communication identifier associated with the QP attributes to 234 * initialize. 235 * @qp_attr: On input, specifies the desired QP state. On output, the 236 * mandatory and desired optional attributes will be set in order to 237 * modify the QP to the specified state. 238 * @qp_attr_mask: The QP attribute mask that may be used to transition the 239 * QP to the specified state. 240 * 241 * Users must set the @qp_attr->qp_state to the desired QP state. This call 242 * will set all required attributes for the given transition, along with 243 * known optional attributes. Users may override the attributes returned from 244 * this call before calling ib_modify_qp. 245 * 246 * Users that wish to have their QP automatically transitioned through its 247 * states can associate a QP with the rdma_cm_id by calling rdma_create_qp(). 248 */ 249 int rdma_init_qp_attr(struct rdma_cm_id *id, struct ib_qp_attr *qp_attr, 250 int *qp_attr_mask); 251 252 /** 253 * rdma_connect - Initiate an active connection request. 254 * @id: Connection identifier to connect. 255 * @conn_param: Connection information used for connected QPs. 256 * 257 * Users must have resolved a route for the rdma_cm_id to connect with 258 * by having called rdma_resolve_route before calling this routine. 259 * 260 * This call will either connect to a remote QP or obtain remote QP 261 * information for unconnected rdma_cm_id's. The actual operation is 262 * based on the rdma_cm_id's port space. 263 */ 264 int rdma_connect(struct rdma_cm_id *id, struct rdma_conn_param *conn_param); 265 266 /** 267 * rdma_listen - This function is called by the passive side to 268 * listen for incoming connection requests. 269 * 270 * Users must have bound the rdma_cm_id to a local address by calling 271 * rdma_bind_addr before calling this routine. 272 */ 273 int rdma_listen(struct rdma_cm_id *id, int backlog); 274 275 /** 276 * rdma_accept - Called to accept a connection request or response. 277 * @id: Connection identifier associated with the request. 278 * @conn_param: Information needed to establish the connection. This must be 279 * provided if accepting a connection request. If accepting a connection 280 * response, this parameter must be NULL. 281 * 282 * Typically, this routine is only called by the listener to accept a connection 283 * request. It must also be called on the active side of a connection if the 284 * user is performing their own QP transitions. 285 * 286 * In the case of error, a reject message is sent to the remote side and the 287 * state of the qp associated with the id is modified to error, such that any 288 * previously posted receive buffers would be flushed. 289 */ 290 int rdma_accept(struct rdma_cm_id *id, struct rdma_conn_param *conn_param); 291 292 /** 293 * rdma_notify - Notifies the RDMA CM of an asynchronous event that has 294 * occurred on the connection. 295 * @id: Connection identifier to transition to established. 296 * @event: Asynchronous event. 297 * 298 * This routine should be invoked by users to notify the CM of relevant 299 * communication events. Events that should be reported to the CM and 300 * when to report them are: 301 * 302 * IB_EVENT_COMM_EST - Used when a message is received on a connected 303 * QP before an RTU has been received. 304 */ 305 int rdma_notify(struct rdma_cm_id *id, enum ib_event_type event); 306 307 /** 308 * rdma_reject - Called to reject a connection request or response. 309 */ 310 int rdma_reject(struct rdma_cm_id *id, const void *private_data, 311 u8 private_data_len); 312 313 /** 314 * rdma_disconnect - This function disconnects the associated QP and 315 * transitions it into the error state. 316 */ 317 int rdma_disconnect(struct rdma_cm_id *id); 318 319 /** 320 * rdma_join_multicast - Join the multicast group specified by the given 321 * address. 322 * @id: Communication identifier associated with the request. 323 * @addr: Multicast address identifying the group to join. 324 * @context: User-defined context associated with the join request, returned 325 * to the user through the private_data pointer in multicast events. 326 */ 327 int rdma_join_multicast(struct rdma_cm_id *id, struct sockaddr *addr, 328 void *context); 329 330 /** 331 * rdma_leave_multicast - Leave the multicast group specified by the given 332 * address. 333 */ 334 void rdma_leave_multicast(struct rdma_cm_id *id, struct sockaddr *addr); 335 336 /** 337 * rdma_set_service_type - Set the type of service associated with a 338 * connection identifier. 339 * @id: Communication identifier to associated with service type. 340 * @tos: Type of service. 341 * 342 * The type of service is interpretted as a differentiated service 343 * field (RFC 2474). The service type should be specified before 344 * performing route resolution, as existing communication on the 345 * connection identifier may be unaffected. The type of service 346 * requested may not be supported by the network to all destinations. 347 */ 348 void rdma_set_service_type(struct rdma_cm_id *id, int tos); 349 350 /** 351 * rdma_set_reuseaddr - Allow the reuse of local addresses when binding 352 * the rdma_cm_id. 353 * @id: Communication identifier to configure. 354 * @reuse: Value indicating if the bound address is reusable. 355 * 356 * Reuse must be set before an address is bound to the id. 357 */ 358 int rdma_set_reuseaddr(struct rdma_cm_id *id, int reuse); 359 360 #endif /* RDMA_CM_H */ 361