2 * Copyright (c) 2004, 2005 Intel Corporation. All rights reserved.
3 * Copyright (c) 2004 Topspin Corporation. All rights reserved.
4 * Copyright (c) 2004 Voltaire Corporation. All rights reserved.
5 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
7 * This software is available to you under a choice of one of two
8 * licenses. You may choose to be licensed under the terms of the GNU
9 * General Public License (GPL) Version 2, available from the file
10 * COPYING in the main directory of this source tree, or the
11 * OpenIB.org BSD license below:
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
17 * - Redistributions of source code must retain the above
18 * copyright notice, this list of conditions and the following
21 * - Redistributions in binary form must reproduce the above
22 * copyright notice, this list of conditions and the following
23 * disclaimer in the documentation and/or other materials
24 * provided with the distribution.
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
29 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
30 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
31 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
32 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
35 * $Id: ib_cm.h 4311 2005-12-05 18:42:01Z sean.hefty $
40 #include <rdma/ib_mad.h>
41 #include <rdma/ib_sa.h>
62 enum ib_cm_lap_state
{
71 enum ib_cm_event_type
{
77 IB_CM_USER_ESTABLISHED
,
88 IB_CM_SIDR_REQ_RECEIVED
,
89 IB_CM_SIDR_REP_RECEIVED
92 enum ib_cm_data_size
{
93 IB_CM_REQ_PRIVATE_DATA_SIZE
= 92,
94 IB_CM_MRA_PRIVATE_DATA_SIZE
= 222,
95 IB_CM_REJ_PRIVATE_DATA_SIZE
= 148,
96 IB_CM_REP_PRIVATE_DATA_SIZE
= 196,
97 IB_CM_RTU_PRIVATE_DATA_SIZE
= 224,
98 IB_CM_DREQ_PRIVATE_DATA_SIZE
= 220,
99 IB_CM_DREP_PRIVATE_DATA_SIZE
= 224,
100 IB_CM_REJ_ARI_LENGTH
= 72,
101 IB_CM_LAP_PRIVATE_DATA_SIZE
= 168,
102 IB_CM_APR_PRIVATE_DATA_SIZE
= 148,
103 IB_CM_APR_INFO_LENGTH
= 72,
104 IB_CM_SIDR_REQ_PRIVATE_DATA_SIZE
= 216,
105 IB_CM_SIDR_REP_PRIVATE_DATA_SIZE
= 136,
106 IB_CM_SIDR_REP_INFO_LENGTH
= 72,
107 IB_CM_COMPARE_SIZE
= 64
112 struct ib_cm_req_event_param
{
113 struct ib_cm_id
*listen_id
;
116 struct ib_sa_path_rec
*primary_path
;
117 struct ib_sa_path_rec
*alternate_path
;
119 __be64 remote_ca_guid
;
122 enum ib_qp_type qp_type
;
125 u8 responder_resources
;
127 unsigned int local_cm_response_timeout
:5;
128 unsigned int flow_control
:1;
129 unsigned int remote_cm_response_timeout
:5;
130 unsigned int retry_count
:3;
131 unsigned int rnr_retry_count
:3;
135 struct ib_cm_rep_event_param
{
136 __be64 remote_ca_guid
;
140 u8 responder_resources
;
142 unsigned int target_ack_delay
:5;
143 unsigned int failover_accepted
:2;
144 unsigned int flow_control
:1;
145 unsigned int rnr_retry_count
:3;
149 enum ib_cm_rej_reason
{
151 IB_CM_REJ_NO_EEC
= 2,
152 IB_CM_REJ_NO_RESOURCES
= 3,
153 IB_CM_REJ_TIMEOUT
= 4,
154 IB_CM_REJ_UNSUPPORTED
= 5,
155 IB_CM_REJ_INVALID_COMM_ID
= 6,
156 IB_CM_REJ_INVALID_COMM_INSTANCE
= 7,
157 IB_CM_REJ_INVALID_SERVICE_ID
= 8,
158 IB_CM_REJ_INVALID_TRANSPORT_TYPE
= 9,
159 IB_CM_REJ_STALE_CONN
= 10,
160 IB_CM_REJ_RDC_NOT_EXIST
= 11,
161 IB_CM_REJ_INVALID_GID
= 12,
162 IB_CM_REJ_INVALID_LID
= 13,
163 IB_CM_REJ_INVALID_SL
= 14,
164 IB_CM_REJ_INVALID_TRAFFIC_CLASS
= 15,
165 IB_CM_REJ_INVALID_HOP_LIMIT
= 16,
166 IB_CM_REJ_INVALID_PACKET_RATE
= 17,
167 IB_CM_REJ_INVALID_ALT_GID
= 18,
168 IB_CM_REJ_INVALID_ALT_LID
= 19,
169 IB_CM_REJ_INVALID_ALT_SL
= 20,
170 IB_CM_REJ_INVALID_ALT_TRAFFIC_CLASS
= 21,
171 IB_CM_REJ_INVALID_ALT_HOP_LIMIT
= 22,
172 IB_CM_REJ_INVALID_ALT_PACKET_RATE
= 23,
173 IB_CM_REJ_PORT_CM_REDIRECT
= 24,
174 IB_CM_REJ_PORT_REDIRECT
= 25,
175 IB_CM_REJ_INVALID_MTU
= 26,
176 IB_CM_REJ_INSUFFICIENT_RESP_RESOURCES
= 27,
177 IB_CM_REJ_CONSUMER_DEFINED
= 28,
178 IB_CM_REJ_INVALID_RNR_RETRY
= 29,
179 IB_CM_REJ_DUPLICATE_LOCAL_COMM_ID
= 30,
180 IB_CM_REJ_INVALID_CLASS_VERSION
= 31,
181 IB_CM_REJ_INVALID_FLOW_LABEL
= 32,
182 IB_CM_REJ_INVALID_ALT_FLOW_LABEL
= 33
185 struct ib_cm_rej_event_param
{
186 enum ib_cm_rej_reason reason
;
191 struct ib_cm_mra_event_param
{
195 struct ib_cm_lap_event_param
{
196 struct ib_sa_path_rec
*alternate_path
;
199 enum ib_cm_apr_status
{
201 IB_CM_APR_INVALID_COMM_ID
,
202 IB_CM_APR_UNSUPPORTED
,
205 IB_CM_APR_IS_CURRENT
,
206 IB_CM_APR_INVALID_QPN_EECN
,
207 IB_CM_APR_INVALID_LID
,
208 IB_CM_APR_INVALID_GID
,
209 IB_CM_APR_INVALID_FLOW_LABEL
,
210 IB_CM_APR_INVALID_TCLASS
,
211 IB_CM_APR_INVALID_HOP_LIMIT
,
212 IB_CM_APR_INVALID_PACKET_RATE
,
216 struct ib_cm_apr_event_param
{
217 enum ib_cm_apr_status ap_status
;
222 struct ib_cm_sidr_req_event_param
{
223 struct ib_cm_id
*listen_id
;
228 enum ib_cm_sidr_status
{
234 IB_SIDR_UNSUPPORTED_VERSION
237 struct ib_cm_sidr_rep_event_param
{
238 enum ib_cm_sidr_status status
;
246 enum ib_cm_event_type event
;
248 struct ib_cm_req_event_param req_rcvd
;
249 struct ib_cm_rep_event_param rep_rcvd
;
250 /* No data for RTU received events. */
251 struct ib_cm_rej_event_param rej_rcvd
;
252 struct ib_cm_mra_event_param mra_rcvd
;
253 struct ib_cm_lap_event_param lap_rcvd
;
254 struct ib_cm_apr_event_param apr_rcvd
;
255 /* No data for DREQ/DREP received events. */
256 struct ib_cm_sidr_req_event_param sidr_req_rcvd
;
257 struct ib_cm_sidr_rep_event_param sidr_rep_rcvd
;
258 enum ib_wc_status send_status
;
265 * ib_cm_handler - User-defined callback to process communication events.
266 * @cm_id: Communication identifier associated with the reported event.
267 * @event: Information about the communication event.
269 * IB_CM_REQ_RECEIVED and IB_CM_SIDR_REQ_RECEIVED communication events
270 * generated as a result of listen requests result in the allocation of a
271 * new @cm_id. The new @cm_id is returned to the user through this callback.
272 * Clients are responsible for destroying the new @cm_id. For peer-to-peer
273 * IB_CM_REQ_RECEIVED and all other events, the returned @cm_id corresponds
274 * to a user's existing communication identifier.
276 * Users may not call ib_destroy_cm_id while in the context of this callback;
277 * however, returning a non-zero value instructs the communication manager to
278 * destroy the @cm_id after the callback completes.
280 typedef int (*ib_cm_handler
)(struct ib_cm_id
*cm_id
,
281 struct ib_cm_event
*event
);
284 ib_cm_handler cm_handler
;
286 struct ib_device
*device
;
289 enum ib_cm_state state
; /* internal CM/debug use */
290 enum ib_cm_lap_state lap_state
; /* internal CM/debug use */
293 u32 remote_cm_qpn
; /* 1 unless redirected */
297 * ib_create_cm_id - Allocate a communication identifier.
298 * @device: Device associated with the cm_id. All related communication will
299 * be associated with the specified device.
300 * @cm_handler: Callback invoked to notify the user of CM events.
301 * @context: User specified context associated with the communication
304 * Communication identifiers are used to track connection states, service
305 * ID resolution requests, and listen requests.
307 struct ib_cm_id
*ib_create_cm_id(struct ib_device
*device
,
308 ib_cm_handler cm_handler
,
312 * ib_destroy_cm_id - Destroy a connection identifier.
313 * @cm_id: Connection identifier to destroy.
315 * This call blocks until the connection identifier is destroyed.
317 void ib_destroy_cm_id(struct ib_cm_id
*cm_id
);
319 #define IB_SERVICE_ID_AGN_MASK __constant_cpu_to_be64(0xFF00000000000000ULL)
320 #define IB_CM_ASSIGN_SERVICE_ID __constant_cpu_to_be64(0x0200000000000000ULL)
321 #define IB_CMA_SERVICE_ID __constant_cpu_to_be64(0x0000000001000000ULL)
322 #define IB_CMA_SERVICE_ID_MASK __constant_cpu_to_be64(0xFFFFFFFFFF000000ULL)
323 #define IB_SDP_SERVICE_ID __constant_cpu_to_be64(0x0000000000010000ULL)
324 #define IB_SDP_SERVICE_ID_MASK __constant_cpu_to_be64(0xFFFFFFFFFFFF0000ULL)
326 struct ib_cm_compare_data
{
327 u8 data
[IB_CM_COMPARE_SIZE
];
328 u8 mask
[IB_CM_COMPARE_SIZE
];
332 * ib_cm_listen - Initiates listening on the specified service ID for
333 * connection and service ID resolution requests.
334 * @cm_id: Connection identifier associated with the listen request.
335 * @service_id: Service identifier matched against incoming connection
336 * and service ID resolution requests. The service ID should be specified
337 * network-byte order. If set to IB_CM_ASSIGN_SERVICE_ID, the CM will
338 * assign a service ID to the caller.
339 * @service_mask: Mask applied to service ID used to listen across a
340 * range of service IDs. If set to 0, the service ID is matched
341 * exactly. This parameter is ignored if %service_id is set to
342 * IB_CM_ASSIGN_SERVICE_ID.
343 * @compare_data: This parameter is optional. It specifies data that must
344 * appear in the private data of a connection request for the specified
347 int ib_cm_listen(struct ib_cm_id
*cm_id
, __be64 service_id
, __be64 service_mask
,
348 struct ib_cm_compare_data
*compare_data
);
350 struct ib_cm_req_param
{
351 struct ib_sa_path_rec
*primary_path
;
352 struct ib_sa_path_rec
*alternate_path
;
355 enum ib_qp_type qp_type
;
357 const void *private_data
;
360 u8 responder_resources
;
362 u8 remote_cm_response_timeout
;
364 u8 local_cm_response_timeout
;
372 * ib_send_cm_req - Sends a connection request to the remote node.
373 * @cm_id: Connection identifier that will be associated with the
374 * connection request.
375 * @param: Connection request information needed to establish the
378 int ib_send_cm_req(struct ib_cm_id
*cm_id
,
379 struct ib_cm_req_param
*param
);
381 struct ib_cm_rep_param
{
384 const void *private_data
;
386 u8 responder_resources
;
388 u8 failover_accepted
;
395 * ib_send_cm_rep - Sends a connection reply in response to a connection
397 * @cm_id: Connection identifier that will be associated with the
398 * connection request.
399 * @param: Connection reply information needed to establish the
402 int ib_send_cm_rep(struct ib_cm_id
*cm_id
,
403 struct ib_cm_rep_param
*param
);
406 * ib_send_cm_rtu - Sends a connection ready to use message in response
407 * to a connection reply message.
408 * @cm_id: Connection identifier associated with the connection request.
409 * @private_data: Optional user-defined private data sent with the
410 * ready to use message.
411 * @private_data_len: Size of the private data buffer, in bytes.
413 int ib_send_cm_rtu(struct ib_cm_id
*cm_id
,
414 const void *private_data
,
415 u8 private_data_len
);
418 * ib_send_cm_dreq - Sends a disconnection request for an existing
420 * @cm_id: Connection identifier associated with the connection being
422 * @private_data: Optional user-defined private data sent with the
423 * disconnection request message.
424 * @private_data_len: Size of the private data buffer, in bytes.
426 int ib_send_cm_dreq(struct ib_cm_id
*cm_id
,
427 const void *private_data
,
428 u8 private_data_len
);
431 * ib_send_cm_drep - Sends a disconnection reply to a disconnection request.
432 * @cm_id: Connection identifier associated with the connection being
434 * @private_data: Optional user-defined private data sent with the
435 * disconnection reply message.
436 * @private_data_len: Size of the private data buffer, in bytes.
438 * If the cm_id is in the correct state, the CM will transition the connection
439 * to the timewait state, even if an error occurs sending the DREP message.
441 int ib_send_cm_drep(struct ib_cm_id
*cm_id
,
442 const void *private_data
,
443 u8 private_data_len
);
446 * ib_cm_notify - Notifies the CM of an event reported to the consumer.
447 * @cm_id: Connection identifier to transition to established.
448 * @event: Type of event.
450 * This routine should be invoked by users to notify the CM of relevant
451 * communication events. Events that should be reported to the CM and
452 * when to report them are:
454 * IB_EVENT_COMM_EST - Used when a message is received on a connected
455 * QP before an RTU has been received.
456 * IB_EVENT_PATH_MIG - Notifies the CM that the connection has failed over
457 * to the alternate path.
459 int ib_cm_notify(struct ib_cm_id
*cm_id
, enum ib_event_type event
);
462 * ib_send_cm_rej - Sends a connection rejection message to the
464 * @cm_id: Connection identifier associated with the connection being
466 * @reason: Reason for the connection request rejection.
467 * @ari: Optional additional rejection information.
468 * @ari_length: Size of the additional rejection information, in bytes.
469 * @private_data: Optional user-defined private data sent with the
471 * @private_data_len: Size of the private data buffer, in bytes.
473 int ib_send_cm_rej(struct ib_cm_id
*cm_id
,
474 enum ib_cm_rej_reason reason
,
477 const void *private_data
,
478 u8 private_data_len
);
481 * ib_send_cm_mra - Sends a message receipt acknowledgement to a connection
483 * @cm_id: Connection identifier associated with the connection message.
484 * @service_timeout: The maximum time required for the sender to reply to
485 * to the connection message.
486 * @private_data: Optional user-defined private data sent with the
487 * message receipt acknowledgement.
488 * @private_data_len: Size of the private data buffer, in bytes.
490 int ib_send_cm_mra(struct ib_cm_id
*cm_id
,
492 const void *private_data
,
493 u8 private_data_len
);
496 * ib_send_cm_lap - Sends a load alternate path request.
497 * @cm_id: Connection identifier associated with the load alternate path
499 * @alternate_path: A path record that identifies the alternate path to
501 * @private_data: Optional user-defined private data sent with the
502 * load alternate path message.
503 * @private_data_len: Size of the private data buffer, in bytes.
505 int ib_send_cm_lap(struct ib_cm_id
*cm_id
,
506 struct ib_sa_path_rec
*alternate_path
,
507 const void *private_data
,
508 u8 private_data_len
);
511 * ib_cm_init_qp_attr - Initializes the QP attributes for use in transitioning
512 * to a specified QP state.
513 * @cm_id: Communication identifier associated with the QP attributes to
515 * @qp_attr: On input, specifies the desired QP state. On output, the
516 * mandatory and desired optional attributes will be set in order to
517 * modify the QP to the specified state.
518 * @qp_attr_mask: The QP attribute mask that may be used to transition the
519 * QP to the specified state.
521 * Users must set the @qp_attr->qp_state to the desired QP state. This call
522 * will set all required attributes for the given transition, along with
523 * known optional attributes. Users may override the attributes returned from
524 * this call before calling ib_modify_qp.
526 int ib_cm_init_qp_attr(struct ib_cm_id
*cm_id
,
527 struct ib_qp_attr
*qp_attr
,
531 * ib_send_cm_apr - Sends an alternate path response message in response to
532 * a load alternate path request.
533 * @cm_id: Connection identifier associated with the alternate path response.
534 * @status: Reply status sent with the alternate path response.
535 * @info: Optional additional information sent with the alternate path
537 * @info_length: Size of the additional information, in bytes.
538 * @private_data: Optional user-defined private data sent with the
539 * alternate path response message.
540 * @private_data_len: Size of the private data buffer, in bytes.
542 int ib_send_cm_apr(struct ib_cm_id
*cm_id
,
543 enum ib_cm_apr_status status
,
546 const void *private_data
,
547 u8 private_data_len
);
549 struct ib_cm_sidr_req_param
{
550 struct ib_sa_path_rec
*path
;
553 const void *private_data
;
559 * ib_send_cm_sidr_req - Sends a service ID resolution request to the
561 * @cm_id: Communication identifier that will be associated with the
562 * service ID resolution request.
563 * @param: Service ID resolution request information.
565 int ib_send_cm_sidr_req(struct ib_cm_id
*cm_id
,
566 struct ib_cm_sidr_req_param
*param
);
568 struct ib_cm_sidr_rep_param
{
571 enum ib_cm_sidr_status status
;
574 const void *private_data
;
579 * ib_send_cm_sidr_rep - Sends a service ID resolution reply to the
581 * @cm_id: Communication identifier associated with the received service ID
582 * resolution request.
583 * @param: Service ID resolution reply information.
585 int ib_send_cm_sidr_rep(struct ib_cm_id
*cm_id
,
586 struct ib_cm_sidr_rep_param
*param
);