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