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