contrib/ofed/librdmacm/man/rdma_connect.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_CONNECT" 3 "2010-07-19" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_connect \- Initiate an active connection request.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_cma.h>"
   7 .P
   8 .B "int" rdma_connect
   9 .BI "(struct rdma_cm_id *" id ","
  10 .BI "struct rdma_conn_param *" conn_param ");"
  11 .SH ARGUMENTS
  12 .IP "id" 12
  13 RDMA identifier.
  14 .IP "conn_param" 12
  15 connection parameters.  See CONNECTION PROPERTIES below for details.
  16 .SH "DESCRIPTION"
  17 For an rdma_cm_id of type RDMA_PS_TCP, this call initiates a connection request
  18 to a remote destination.  For an rdma_cm_id of type RDMA_PS_UDP, it initiates
  19 a lookup of the remote QP providing the datagram service.
  20 .SH "RETURN VALUE"
  21 Returns 0 on success, or -1 on error.  If an error occurs, errno will be
  22 set to indicate the failure reason.
  23 .SH "NOTES"
  24 Users must have resolved a route to the destination address
  25 by having called rdma_resolve_route or rdma_create_ep before calling
  26 this routine.
  27 .SH "CONNECTION PROPERTIES"
  28 The following properties are used to configure the communication and specified
  29 by the conn_param parameter when connecting or establishing datagram
  30 communication.
  31 .IP private_data
  32 References a user-controlled data buffer.  The contents of the buffer are
  33 copied and transparently passed to the remote side as part of the
  34 communication request.  May be NULL if private_data is not required.
  35 .IP private_data_len
  36 Specifies the size of the user-controlled data buffer.  Note that the actual
  37 amount of data transferred to the remote side is transport dependent and may
  38 be larger than that requested.
  39 .IP responder_resources
  40 The maximum number of outstanding RDMA read and atomic operations that the
  41 local side will accept from the remote side.  Applies only to RDMA_PS_TCP.
  42 This value must be less than or equal to the local RDMA device attribute
  43 max_qp_rd_atom and remote RDMA device attribute max_qp_init_rd_atom.  The
  44 remote endpoint can adjust this value when accepting the connection.
  45 .IP initiator_depth
  46 The maximum number of outstanding RDMA read and atomic operations that the
  47 local side will have to the remote side.  Applies only to RDMA_PS_TCP.
  48 This value must be less than or equal to the local RDMA device attribute
  49 max_qp_init_rd_atom and remote RDMA device attribute max_qp_rd_atom.  The
  50 remote endpoint can adjust this value when accepting the connection.
  51 .IP flow_control
  52 Specifies if hardware flow control is available.  This value is exchanged
  53 with the remote peer and is not used to configure the QP.  Applies only to
  54 RDMA_PS_TCP.
  55 .IP retry_count
  56 The maximum number of times that a data transfer operation should be retried
  57 on the connection when an error occurs.  This setting controls the number of
  58 times to retry send, RDMA, and atomic operations when timeouts occur.
  59 Applies only to RDMA_PS_TCP.
  60 .IP rnr_retry_count
  61 The maximum number of times that a send operation from the remote peer
  62 should be retried on a connection after receiving a receiver not ready (RNR)
  63 error.  RNR errors are generated when a send request arrives before a buffer
  64 has been posted to receive the incoming data.  Applies only to RDMA_PS_TCP.
  65 .IP srq
  66 Specifies if the QP associated with the connection is using a shared receive
  67 queue.  This field is ignored by the library if a QP has been created on the
  68 rdma_cm_id.  Applies only to RDMA_PS_TCP.
  69 .IP qp_num
  70 Specifies the QP number associated with the connection.  This field is ignored
  71 by the library if a QP has been created on the rdma_cm_id.  Applies only to
  72 RDMA_PS_TCP.
  73 .SH "INFINIBAND SPECIFIC"
  74 In addition to the connection properties defined above, InfiniBand QPs are
  75 configured with minimum RNR NAK timer and local ACK timeout values.  The
  76 minimum RNR NAK timer value is set to 0, for a delay of 655 ms.
  77 The local ACK timeout is calculated based on the packet lifetime and local
  78 HCA ACK delay.  The packet lifetime is determined by the InfiniBand Subnet
  79 Administrator and is part of the resolved route (path record) information.
  80 The HCA ACK delay is a property of the locally used HCA.
  81 .P
  82 Retry count and RNR retry count values are 3-bit values.
  83 .P
  84 The length of the private data provided by the user is limited to 56 bytes
  85 for RDMA_PS_TCP, or 180 bytes for RDMA_PS_UDP.
  86 .SH "IWARP SPECIFIC"
  87 Connections established over iWarp RDMA devices currently require that the
  88 active side of the connection send the first message.
  89 .SH "SEE ALSO"
  90 rdma_cm(7), rdma_create_id(3), rdma_resolve_route(3), rdma_disconnect(3),
  91 rdma_listen(3), rdma_get_cm_event(3)