usr/src/man/man3dat/dat_ep_create.3dat

   1 '\" te
   2 .\" This manual page is derived from the DAT/uDAPL 1.2 specification.
   3 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH DAT_EP_CREATE 3DAT "Jul 16, 2004"
   8 .SH NAME
   9 dat_ep_create \- create an instance of an Endpoint
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <\fBdat/udat.h\fR>
  15
  16 DAT_RETURN
  17     dat_ep_create (
  18     IN    DAT_IA_HANDLE    ia_handle,
  19     IN    DAT_PZ_HANDLE    pz_handle,
  20     IN    DAT_EVD_HANDLE   recv_evd_handle,
  21     IN    DAT_EVD_HANDLE   request_evd_handle,
  22     IN    DAT_EVD_HANDLE   connect_evd_handle,
  23     IN    DAT_EP_ATTR      *ep_attributes,
  24     OUT   DAT_EP_HANDLE    *ep_handle
  25     )
  26 .fi
  27
  28 .SH PARAMETERS
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIia_handle\fR\fR
  33 .ad
  34 .RS 22n
  35 Handle for an open instance of the IA to which the created Endpoint belongs.
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fIpz_handle\fR\fR
  42 .ad
  43 .RS 22n
  44 Handle for an instance of the Protection Zone.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fIrecv_evd_handle\fR\fR
  51 .ad
  52 .RS 22n
  53 Handle for the Event Dispatcher where events for completions of incoming
  54 (receive) DTOs are reported. \fBDAT_HANDLE_NULL\fR specifies that the Consumer
  55 is not interested in events for completions of receives.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fIrequest_evd_handle\fR\fR
  62 .ad
  63 .RS 22n
  64 Handle for the Event Dispatcher where events for completions of outgoing (Send,
  65 RDMA Write, RDMA Read, and RMR Bind) DTOs are reported. \fBDAT_HANDLE_NULL\fR
  66 specifies that the Consumer is not interested in events for completions of
  67 requests.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fIconnect_evd_handle\fR\fR
  74 .ad
  75 .RS 22n
  76 Handle for the Event Dispatcher where Connection events are reported.
  77 \fBDAT_HANDLE_NULL\fR specifies that the Consumer is not interested in
  78 connection events for now.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fIep_attributes\fR\fR
  85 .ad
  86 .RS 22n
  87 Pointer to a structure that contains Consumer-requested Endpoint attributes.
  88 Can be \fINULL\fR.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fIep_handle\fR\fR
  95 .ad
  96 .RS 22n
  97 Handle for the created instance of an Endpoint.
  98 .RE
  99
 100 .SH DESCRIPTION
 101 .sp
 102 .LP
 103 The \fBdat_ep_create()\fR function creates an instance of an Endpoint that is
 104 provided to the Consumer as \fIep_handle\fR. The value of \fIep_handle\fR is
 105 not defined if the \fBDAT_RETURN\fR is not \fBDAT_SUCCESS\fR.
 106 .sp
 107 .LP
 108 The Endpoint is created in the Unconnected state.
 109 .sp
 110 .LP
 111 Protection Zone \fIpz_handle\fR allows Consumers to control what local memory
 112 the Endpoint can access for DTOs and what memory remote RDMA operations can
 113 access over the connection of a created Endpoint. Only memory referred to by
 114 LMRs and RMRs that match the Endpoint Protection Zone can be accessed by the
 115 Endpoint.
 116 .sp
 117 .LP
 118 The \fIrecv_evd_handle\fR and \fIrequest_evd_handle\fR parameters are Event
 119 Dispatcher instances where the Consumer collects completion notifications of
 120 DTOs. Completions of Receive DTOs are reported in \fIrecv_evd_handle\fR Event
 121 Dispatcher, and completions of Send, RDMA Read, and RDMA Write DTOs are
 122 reported in \fIrequest_evd_handle\fR Event Dispatcher.  All completion
 123 notifications of RMR bindings are reported to a Consumer in
 124 \fIrequest_evd_handle\fR Event Dispatcher.
 125 .sp
 126 .LP
 127 All Connection events for the connected Endpoint are reported to the Consumer
 128 through \fIconnect_evd_handle\fR Event Dispatcher.
 129 .sp
 130 .LP
 131 The \fIep_attributes\fR parameter specifies the initial attributes of the
 132 created Endpoint. If the Consumer specifies \fINULL\fR, the Provider fills it
 133 with its default Endpoint attributes. The Consumer might not be able to do any
 134 posts to the Endpoint or use the Endpoint in connection establishment until
 135 certain Endpoint attributes are set. Maximum Message Size and Maximum Recv DTOs
 136 are examples of such attributes.
 137 .SH RETURN VALUES
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fBDAT_SUCCESS\fR\fR
 142 .ad
 143 .RS 30n
 144 The operation was successful.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBDAT_INSUFFICIENT_RESOURCES\fR\fR
 151 .ad
 152 .RS 30n
 153 The operation failed due to resource limitations.
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fBDAT_INVALID_HANDLE\fR\fR
 160 .ad
 161 .RS 30n
 162 Invalid DAT handle.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBDAT_INVALID_PARAMETER\fR\fR
 169 .ad
 170 .RS 30n
 171 Invalid parameter. One of the requested EP parameters or attributes was invalid
 172 or a combination of attributes or parameters is invalid.
 173 .RE
 174
 175 .sp
 176 .ne 2
 177 .na
 178 \fB\fBDAT_MODEL_NOT_SUPPORTED\fR\fR
 179 .ad
 180 .RS 30n
 181 The requested Provider Model was not supported.
 182 .RE
 183
 184 .SH USAGE
 185 .sp
 186 .LP
 187 The Consumer creates an Endpoint prior to the establishment of a connection.
 188 The created Endpoint is in \fBDAT_EP_STATE_UNCONNECTED\fR. Consumers can do the
 189 following:
 190 .RS +4
 191 .TP
 192 1.
 193 Request a connection on the Endpoint through \fBdat_ep_connect\fR(3DAT) or
 194 \fBdat_ep_dup_connect\fR(3DAT) for the active side of the connection model.
 195 .RE
 196 .RS +4
 197 .TP
 198 2.
 199 Associate the Endpoint with the Pending Connection Request that does not
 200 have an associated local Endpoint for accepting the Pending Connection Request
 201 for the passive/server side of the connection model.
 202 .RE
 203 .RS +4
 204 .TP
 205 3.
 206 Create a Reserved Service Point with the Endpoint for the passive/server
 207 side of the connection model. Upon arrival of a Connection Request on the
 208 Service Point, the Consumer accepts the Pending Connection Request that has the
 209 Endpoint associated with it
 210 .RE
 211 .sp
 212 .LP
 213 The Consumer cannot specify a \fIrequest_evd_handle\fR (\fIrecv_evd_handle\fR)
 214 with Request Completion Flags (Recv Completion Flags) that do not match the
 215 other Endpoint Completion Flags for the DTO/RMR completion streams that use the
 216 same EVD. If \fIrequest_evd_handle\fR (\fIrecv_evd_handle\fR) is used for an
 217 EVD that is fed by any event stream other than DTO or RMR completion event
 218 streams, only \fBDAT_COMPLETION_THRESHOLD\fR is valid for Request/Recv
 219 Completion Flags for the Endpoint completion streams that use that EVD. If
 220 \fIrequest_evd_handle\fR (\fIrecv_evd_handle\fR) is used for request (recv)
 221 completions of an Endpoint whose associated Request (Recv) Completion Flag
 222 attribute is \fBDAT_COMPLETION_UNSIGNALLED_FLAG\fR, the Request Completion
 223 Flags and Recv Completion Flags for all Endpoint completion streams that use
 224 the EVD must specify the same. Analogously, if \fIrecv_evd_handle\fR is used
 225 for recv completions of an Endpoint whose associated Recv Completion Flags
 226 attribute is \fBDAT_COMPLETION_SOLICITED_WAIT\fR, the Recv Completion Flags for
 227 all Endpoint Recv completion streams that use the same EVD must specify the
 228 same Recv Completion Flags attribute value and the EVD cannot be used for any
 229 other event stream types.
 230 .sp
 231 .LP
 232 If EP is created with \fINULL\fR attributes, Provider can fill them with its
 233 own default values. The Consumer should not rely on the Provider-filled
 234 attribute defaults, especially for portable applications. The Consumer cannot
 235 do any operations on the created Endpoint except for \fBdat_ep_query\fR(3DAT),
 236 \fBdat_ep_get_status\fR(3DAT), \fBdat_ep_modify\fR(3DAT), and
 237 \fBdat_ep_free\fR(3DAT), depending on the values that the Provider picks.
 238 .sp
 239 .LP
 240 The Provider is encouraged to pick up reasonable defaults because unreasonable
 241 values might restrict Consumers to the \fBdat_ep_query()\fR,
 242 \fBdat_ep_get_status()\fR, \fBdat_ep_modify()\fR, and \fBdat_ep_free()\fR
 243 operations. The Consumer should check what values the Provider picked up for
 244 the attributes. It is especially important to make sure that the number of
 245 posted operations is not too large to avoid EVD overflow. Depending on the
 246 values picked up by the Provider, the Consumer might not be able to do any RDMA
 247 operations; it might only be able to send or receive messages of very small
 248 sizes, or it might not be able to have more than one segment in a buffer.
 249 Before doing any operations, except the ones listed above, the Consumer can
 250 configure the Endpoint using \fBdat_ep_modify()\fR to the attributes they want.
 251 .sp
 252 .LP
 253 One reason the Consumer might still want to create an Endpoint with Null
 254 attributes is for the Passive side of the connection establishment, where the
 255 Consumer sets up Endpoint attributes based on the connection request of the
 256 remote side.
 257 .sp
 258 .LP
 259 Consumers might want to create Endpoints with \fINULL\fR attributes if Endpoint
 260 properties are negotiated as part the Consumer connection establishment
 261 protocol.
 262 .sp
 263 .LP
 264 Consumers that create Endpoints with Provider default attributes should always
 265 verify that the Provider default attributes meet their application's
 266 requirements with regard to the number of request/receive DTOs that can be
 267 posted, maximum message sizes, maximum request/receive IOV sizes, and maximum
 268 RDMA sizes.
 269 .SH ATTRIBUTES
 270 .sp
 271 .LP
 272 See \fBattributes\fR(5) for descriptions of the following attributes:
 273 .sp
 274
 275 .sp
 276 .TS
 277 box;
 278 c | c
 279 l | l .
 280 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 281 _
 282 Interface Stability     Standard: uDAPL, 1.1, 1.2
 283 _
 284 MT-Level        Safe
 285 .TE
 286
 287 .SH SEE ALSO
 288 .sp
 289 .LP
 290 \fBdat_ep_connect\fR(3DAT), \fBdat_ep_dup_connect\fR(3DAT),
 291 \fBdat_ep_free\fR(3DAT), \fBdat_ep_get_status\fR(3DAT),
 292 \fBdat_ep_modify\fR(3DAT), \fBdat_ep_query\fR(3DAT), \fBlibdat\fR(3LIB),
 293 \fBattributes\fR(5)