1 /* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
3 * Copyright (c) 2004, 2005 Intel Corporation. All rights reserved.
4 * Copyright (c) 2004 Topspin Corporation. All rights reserved.
5 * Copyright (c) 2004 Voltaire Corporation. All rights reserved.
6 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
7 * Copyright (c) 2019, Mellanox Technologies inc. All rights reserved.
12 #include <rdma/ib_mad.h>
13 #include <rdma/ib_sa.h>
15 /* ib_cm and ib_user_cm modules share /sys/class/infiniband_cm */
16 extern struct class cm_class;
37 enum ib_cm_lap_state {
46 enum ib_cm_event_type {
52 IB_CM_USER_ESTABLISHED,
63 IB_CM_SIDR_REQ_RECEIVED,
64 IB_CM_SIDR_REP_RECEIVED
67 enum ib_cm_data_size {
68 IB_CM_REQ_PRIVATE_DATA_SIZE = 92,
69 IB_CM_MRA_PRIVATE_DATA_SIZE = 222,
70 IB_CM_REJ_PRIVATE_DATA_SIZE = 148,
71 IB_CM_REP_PRIVATE_DATA_SIZE = 196,
72 IB_CM_RTU_PRIVATE_DATA_SIZE = 224,
73 IB_CM_DREQ_PRIVATE_DATA_SIZE = 220,
74 IB_CM_DREP_PRIVATE_DATA_SIZE = 224,
75 IB_CM_REJ_ARI_LENGTH = 72,
76 IB_CM_LAP_PRIVATE_DATA_SIZE = 168,
77 IB_CM_APR_PRIVATE_DATA_SIZE = 148,
78 IB_CM_APR_INFO_LENGTH = 72,
79 IB_CM_SIDR_REQ_PRIVATE_DATA_SIZE = 216,
80 IB_CM_SIDR_REP_PRIVATE_DATA_SIZE = 136,
81 IB_CM_SIDR_REP_INFO_LENGTH = 72,
86 struct ib_cm_req_event_param {
87 struct ib_cm_id *listen_id;
89 /* P_Key that was used by the GMP's BTH header */
94 struct sa_path_rec *primary_path;
95 struct sa_path_rec *alternate_path;
98 * SGID attribute of the primary path. Currently only
99 * useful for RoCE. Alternate path GID attributes
100 * are not yet supported.
102 const struct ib_gid_attr *ppath_sgid_attr;
104 __be64 remote_ca_guid;
107 enum ib_qp_type qp_type;
110 u8 responder_resources;
112 unsigned int local_cm_response_timeout:5;
113 unsigned int flow_control:1;
114 unsigned int remote_cm_response_timeout:5;
115 unsigned int retry_count:3;
116 unsigned int rnr_retry_count:3;
120 struct ib_cm_rep_event_param {
121 __be64 remote_ca_guid;
125 u8 responder_resources;
127 unsigned int target_ack_delay:5;
128 unsigned int failover_accepted:2;
129 unsigned int flow_control:1;
130 unsigned int rnr_retry_count:3;
134 enum ib_cm_rej_reason {
136 IB_CM_REJ_NO_EEC = 2,
137 IB_CM_REJ_NO_RESOURCES = 3,
138 IB_CM_REJ_TIMEOUT = 4,
139 IB_CM_REJ_UNSUPPORTED = 5,
140 IB_CM_REJ_INVALID_COMM_ID = 6,
141 IB_CM_REJ_INVALID_COMM_INSTANCE = 7,
142 IB_CM_REJ_INVALID_SERVICE_ID = 8,
143 IB_CM_REJ_INVALID_TRANSPORT_TYPE = 9,
144 IB_CM_REJ_STALE_CONN = 10,
145 IB_CM_REJ_RDC_NOT_EXIST = 11,
146 IB_CM_REJ_INVALID_GID = 12,
147 IB_CM_REJ_INVALID_LID = 13,
148 IB_CM_REJ_INVALID_SL = 14,
149 IB_CM_REJ_INVALID_TRAFFIC_CLASS = 15,
150 IB_CM_REJ_INVALID_HOP_LIMIT = 16,
151 IB_CM_REJ_INVALID_PACKET_RATE = 17,
152 IB_CM_REJ_INVALID_ALT_GID = 18,
153 IB_CM_REJ_INVALID_ALT_LID = 19,
154 IB_CM_REJ_INVALID_ALT_SL = 20,
155 IB_CM_REJ_INVALID_ALT_TRAFFIC_CLASS = 21,
156 IB_CM_REJ_INVALID_ALT_HOP_LIMIT = 22,
157 IB_CM_REJ_INVALID_ALT_PACKET_RATE = 23,
158 IB_CM_REJ_PORT_CM_REDIRECT = 24,
159 IB_CM_REJ_PORT_REDIRECT = 25,
160 IB_CM_REJ_INVALID_MTU = 26,
161 IB_CM_REJ_INSUFFICIENT_RESP_RESOURCES = 27,
162 IB_CM_REJ_CONSUMER_DEFINED = 28,
163 IB_CM_REJ_INVALID_RNR_RETRY = 29,
164 IB_CM_REJ_DUPLICATE_LOCAL_COMM_ID = 30,
165 IB_CM_REJ_INVALID_CLASS_VERSION = 31,
166 IB_CM_REJ_INVALID_FLOW_LABEL = 32,
167 IB_CM_REJ_INVALID_ALT_FLOW_LABEL = 33
170 struct ib_cm_rej_event_param {
171 enum ib_cm_rej_reason reason;
176 struct ib_cm_mra_event_param {
180 struct ib_cm_lap_event_param {
181 struct sa_path_rec *alternate_path;
184 enum ib_cm_apr_status {
186 IB_CM_APR_INVALID_COMM_ID,
187 IB_CM_APR_UNSUPPORTED,
190 IB_CM_APR_IS_CURRENT,
191 IB_CM_APR_INVALID_QPN_EECN,
192 IB_CM_APR_INVALID_LID,
193 IB_CM_APR_INVALID_GID,
194 IB_CM_APR_INVALID_FLOW_LABEL,
195 IB_CM_APR_INVALID_TCLASS,
196 IB_CM_APR_INVALID_HOP_LIMIT,
197 IB_CM_APR_INVALID_PACKET_RATE,
201 struct ib_cm_apr_event_param {
202 enum ib_cm_apr_status ap_status;
207 struct ib_cm_sidr_req_event_param {
208 struct ib_cm_id *listen_id;
212 * SGID attribute of the request. Currently only
215 const struct ib_gid_attr *sgid_attr;
216 /* P_Key that was used by the GMP's BTH header */
222 enum ib_cm_sidr_status {
228 IB_SIDR_UNSUPPORTED_VERSION
231 struct ib_cm_sidr_rep_event_param {
232 enum ib_cm_sidr_status status;
236 const struct ib_gid_attr *sgid_attr;
241 enum ib_cm_event_type event;
243 struct ib_cm_req_event_param req_rcvd;
244 struct ib_cm_rep_event_param rep_rcvd;
245 /* No data for RTU received events. */
246 struct ib_cm_rej_event_param rej_rcvd;
247 struct ib_cm_mra_event_param mra_rcvd;
248 struct ib_cm_lap_event_param lap_rcvd;
249 struct ib_cm_apr_event_param apr_rcvd;
250 /* No data for DREQ/DREP received events. */
251 struct ib_cm_sidr_req_event_param sidr_req_rcvd;
252 struct ib_cm_sidr_rep_event_param sidr_rep_rcvd;
253 enum ib_wc_status send_status;
259 #define CM_REQ_ATTR_ID cpu_to_be16(0x0010)
260 #define CM_MRA_ATTR_ID cpu_to_be16(0x0011)
261 #define CM_REJ_ATTR_ID cpu_to_be16(0x0012)
262 #define CM_REP_ATTR_ID cpu_to_be16(0x0013)
263 #define CM_RTU_ATTR_ID cpu_to_be16(0x0014)
264 #define CM_DREQ_ATTR_ID cpu_to_be16(0x0015)
265 #define CM_DREP_ATTR_ID cpu_to_be16(0x0016)
266 #define CM_SIDR_REQ_ATTR_ID cpu_to_be16(0x0017)
267 #define CM_SIDR_REP_ATTR_ID cpu_to_be16(0x0018)
268 #define CM_LAP_ATTR_ID cpu_to_be16(0x0019)
269 #define CM_APR_ATTR_ID cpu_to_be16(0x001A)
272 * ib_cm_handler - User-defined callback to process communication events.
273 * @cm_id: Communication identifier associated with the reported event.
274 * @event: Information about the communication event.
276 * IB_CM_REQ_RECEIVED and IB_CM_SIDR_REQ_RECEIVED communication events
277 * generated as a result of listen requests result in the allocation of a
278 * new @cm_id. The new @cm_id is returned to the user through this callback.
279 * Clients are responsible for destroying the new @cm_id. For peer-to-peer
280 * IB_CM_REQ_RECEIVED and all other events, the returned @cm_id corresponds
281 * to a user's existing communication identifier.
283 * Users may not call ib_destroy_cm_id while in the context of this callback;
284 * however, returning a non-zero value instructs the communication manager to
285 * destroy the @cm_id after the callback completes.
287 typedef int (*ib_cm_handler)(struct ib_cm_id *cm_id,
288 const struct ib_cm_event *event);
291 ib_cm_handler cm_handler;
293 struct ib_device *device;
296 enum ib_cm_state state; /* internal CM/debug use */
297 enum ib_cm_lap_state lap_state; /* internal CM/debug use */
300 u32 remote_cm_qpn; /* 1 unless redirected */
304 * ib_create_cm_id - Allocate a communication identifier.
305 * @device: Device associated with the cm_id. All related communication will
306 * be associated with the specified device.
307 * @cm_handler: Callback invoked to notify the user of CM events.
308 * @context: User specified context associated with the communication
311 * Communication identifiers are used to track connection states, service
312 * ID resolution requests, and listen requests.
314 struct ib_cm_id *ib_create_cm_id(struct ib_device *device,
315 ib_cm_handler cm_handler,
319 * ib_destroy_cm_id - Destroy a connection identifier.
320 * @cm_id: Connection identifier to destroy.
322 * This call blocks until the connection identifier is destroyed.
324 void ib_destroy_cm_id(struct ib_cm_id *cm_id);
326 #define IB_SERVICE_ID_AGN_MASK cpu_to_be64(0xFF00000000000000ULL)
327 #define IB_CM_ASSIGN_SERVICE_ID cpu_to_be64(0x0200000000000000ULL)
328 #define IB_CMA_SERVICE_ID cpu_to_be64(0x0000000001000000ULL)
329 #define IB_CMA_SERVICE_ID_MASK cpu_to_be64(0xFFFFFFFFFF000000ULL)
330 #define IB_SDP_SERVICE_ID cpu_to_be64(0x0000000000010000ULL)
331 #define IB_SDP_SERVICE_ID_MASK cpu_to_be64(0xFFFFFFFFFFFF0000ULL)
334 * ib_cm_listen - Initiates listening on the specified service ID for
335 * connection and service ID resolution requests.
336 * @cm_id: Connection identifier associated with the listen request.
337 * @service_id: Service identifier matched against incoming connection
338 * and service ID resolution requests. The service ID should be specified
339 * network-byte order. If set to IB_CM_ASSIGN_SERVICE_ID, the CM will
340 * assign a service ID to the caller.
341 * @service_mask: Mask applied to service ID used to listen across a
342 * range of service IDs. If set to 0, the service ID is matched
343 * exactly. This parameter is ignored if %service_id is set to
344 * IB_CM_ASSIGN_SERVICE_ID.
346 int ib_cm_listen(struct ib_cm_id *cm_id, __be64 service_id,
347 __be64 service_mask);
349 struct ib_cm_id *ib_cm_insert_listen(struct ib_device *device,
350 ib_cm_handler cm_handler,
353 struct ib_cm_req_param {
354 struct sa_path_rec *primary_path;
355 struct sa_path_rec *alternate_path;
356 const struct ib_gid_attr *ppath_sgid_attr;
359 enum ib_qp_type qp_type;
361 const void *private_data;
364 u8 responder_resources;
366 u8 remote_cm_response_timeout;
368 u8 local_cm_response_timeout;
376 * ib_send_cm_req - Sends a connection request to the remote node.
377 * @cm_id: Connection identifier that will be associated with the
378 * connection request.
379 * @param: Connection request information needed to establish the
382 int ib_send_cm_req(struct ib_cm_id *cm_id,
383 struct ib_cm_req_param *param);
385 struct ib_cm_rep_param {
388 const void *private_data;
390 u8 responder_resources;
392 u8 failover_accepted;
399 * ib_send_cm_rep - Sends a connection reply in response to a connection
401 * @cm_id: Connection identifier that will be associated with the
402 * connection request.
403 * @param: Connection reply information needed to establish the
406 int ib_send_cm_rep(struct ib_cm_id *cm_id,
407 struct ib_cm_rep_param *param);
410 * ib_send_cm_rtu - Sends a connection ready to use message in response
411 * to a connection reply message.
412 * @cm_id: Connection identifier associated with the connection request.
413 * @private_data: Optional user-defined private data sent with the
414 * ready to use message.
415 * @private_data_len: Size of the private data buffer, in bytes.
417 int ib_send_cm_rtu(struct ib_cm_id *cm_id,
418 const void *private_data,
419 u8 private_data_len);
422 * ib_send_cm_dreq - Sends a disconnection request for an existing
424 * @cm_id: Connection identifier associated with the connection being
426 * @private_data: Optional user-defined private data sent with the
427 * disconnection request message.
428 * @private_data_len: Size of the private data buffer, in bytes.
430 int ib_send_cm_dreq(struct ib_cm_id *cm_id,
431 const void *private_data,
432 u8 private_data_len);
435 * ib_send_cm_drep - Sends a disconnection reply to a disconnection request.
436 * @cm_id: Connection identifier associated with the connection being
438 * @private_data: Optional user-defined private data sent with the
439 * disconnection reply message.
440 * @private_data_len: Size of the private data buffer, in bytes.
442 * If the cm_id is in the correct state, the CM will transition the connection
443 * to the timewait state, even if an error occurs sending the DREP message.
445 int ib_send_cm_drep(struct ib_cm_id *cm_id,
446 const void *private_data,
447 u8 private_data_len);
450 * ib_cm_notify - Notifies the CM of an event reported to the consumer.
451 * @cm_id: Connection identifier to transition to established.
452 * @event: Type of event.
454 * This routine should be invoked by users to notify the CM of relevant
455 * communication events. Events that should be reported to the CM and
456 * when to report them are:
458 * IB_EVENT_COMM_EST - Used when a message is received on a connected
459 * QP before an RTU has been received.
460 * IB_EVENT_PATH_MIG - Notifies the CM that the connection has failed over
461 * to the alternate path.
463 int ib_cm_notify(struct ib_cm_id *cm_id, enum ib_event_type event);
466 * ib_send_cm_rej - Sends a connection rejection message to the
468 * @cm_id: Connection identifier associated with the connection being
470 * @reason: Reason for the connection request rejection.
471 * @ari: Optional additional rejection information.
472 * @ari_length: Size of the additional rejection information, in bytes.
473 * @private_data: Optional user-defined private data sent with the
475 * @private_data_len: Size of the private data buffer, in bytes.
477 int ib_send_cm_rej(struct ib_cm_id *cm_id,
478 enum ib_cm_rej_reason reason,
481 const void *private_data,
482 u8 private_data_len);
484 #define IB_CM_MRA_FLAG_DELAY 0x80 /* Send MRA only after a duplicate msg */
487 * ib_send_cm_mra - Sends a message receipt acknowledgement to a connection
489 * @cm_id: Connection identifier associated with the connection message.
490 * @service_timeout: The lower 5-bits specify the maximum time required for
491 * the sender to reply to the connection message. The upper 3-bits
492 * specify additional control flags.
493 * @private_data: Optional user-defined private data sent with the
494 * message receipt acknowledgement.
495 * @private_data_len: Size of the private data buffer, in bytes.
497 int ib_send_cm_mra(struct ib_cm_id *cm_id,
499 const void *private_data,
500 u8 private_data_len);
503 * ib_send_cm_lap - Sends a load alternate path request.
504 * @cm_id: Connection identifier associated with the load alternate path
506 * @alternate_path: A path record that identifies the alternate path to
508 * @private_data: Optional user-defined private data sent with the
509 * load alternate path message.
510 * @private_data_len: Size of the private data buffer, in bytes.
512 int ib_send_cm_lap(struct ib_cm_id *cm_id,
513 struct sa_path_rec *alternate_path,
514 const void *private_data,
515 u8 private_data_len);
518 * ib_cm_init_qp_attr - Initializes the QP attributes for use in transitioning
519 * to a specified QP state.
520 * @cm_id: Communication identifier associated with the QP attributes to
522 * @qp_attr: On input, specifies the desired QP state. On output, the
523 * mandatory and desired optional attributes will be set in order to
524 * modify the QP to the specified state.
525 * @qp_attr_mask: The QP attribute mask that may be used to transition the
526 * QP to the specified state.
528 * Users must set the @qp_attr->qp_state to the desired QP state. This call
529 * will set all required attributes for the given transition, along with
530 * known optional attributes. Users may override the attributes returned from
531 * this call before calling ib_modify_qp.
533 int ib_cm_init_qp_attr(struct ib_cm_id *cm_id,
534 struct ib_qp_attr *qp_attr,
538 * ib_send_cm_apr - Sends an alternate path response message in response to
539 * a load alternate path request.
540 * @cm_id: Connection identifier associated with the alternate path response.
541 * @status: Reply status sent with the alternate path response.
542 * @info: Optional additional information sent with the alternate path
544 * @info_length: Size of the additional information, in bytes.
545 * @private_data: Optional user-defined private data sent with the
546 * alternate path response message.
547 * @private_data_len: Size of the private data buffer, in bytes.
549 int ib_send_cm_apr(struct ib_cm_id *cm_id,
550 enum ib_cm_apr_status status,
553 const void *private_data,
554 u8 private_data_len);
556 struct ib_cm_sidr_req_param {
557 struct sa_path_rec *path;
558 const struct ib_gid_attr *sgid_attr;
560 unsigned long timeout_ms;
561 const void *private_data;
567 * ib_send_cm_sidr_req - Sends a service ID resolution request to the
569 * @cm_id: Communication identifier that will be associated with the
570 * service ID resolution request.
571 * @param: Service ID resolution request information.
573 int ib_send_cm_sidr_req(struct ib_cm_id *cm_id,
574 struct ib_cm_sidr_req_param *param);
576 struct ib_cm_sidr_rep_param {
579 enum ib_cm_sidr_status status;
582 const void *private_data;
587 * ib_send_cm_sidr_rep - Sends a service ID resolution reply to the
589 * @cm_id: Communication identifier associated with the received service ID
590 * resolution request.
591 * @param: Service ID resolution reply information.
593 int ib_send_cm_sidr_rep(struct ib_cm_id *cm_id,
594 struct ib_cm_sidr_rep_param *param);
597 * ibcm_reject_msg - return a pointer to a reject message string.
598 * @reason: Value returned in the REJECT event status field.
600 const char *__attribute_const__ ibcm_reject_msg(int reason);