| blob | 18b072de313072c2690c99dc94223a4e489d9ab6 |
1 '\" te
2 .\" This manual page is derived from the DAT/uDAPL 1.2 specification.
3 .\" Portions Copyright (c) 2009, 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_LMR_CREATE 3DAT "Jan 28, 2009"
8 .SH NAME
9 dat_lmr_create \- register a memory region with an IA
10 .SH SYNOPSIS
11 .LP
12 .nf
13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
14 #include <\fBdat/udat.h\fR>
16 DAT_RETURN
17 dat_lmr_create (
18 IN DAT_IA_HANDLE ia_handle,
19 IN DAT_MEM_TYPE mem_type,
20 IN DAT_REGION_DESCRIPTION region_description,
21 IN DAT_VLEN length,
22 IN DAT_PZ_HANDLE pz_handle,
23 IN DAT_MEM_PRIV_FLAGS mem_privileges,
24 OUT DAT_LMR_HANDLE *lmr_handle,
25 OUT DAT_LMR_CONTEXT *lmr_context,
26 OUT DAT_RMR_CONTEXT *rmr_context,
27 OUT DAT_VLEN *registered_size,
28 OUT DAT_VADDR *registered_address
29 )
30 .fi
32 .SH PARAMETERS
33 .sp
34 .ne 2
35 .na
36 \fB\fIia_handle\fR\fR
37 .ad
38 .sp .6
39 .RS 4n
40 Handle for an open instance of the IA.
41 .RE
43 .sp
44 .ne 2
45 .na
46 \fB\fImem_type\fR\fR
47 .ad
48 .sp .6
49 .RS 4n
50 Type of memory to be registered. The following list outlines the memory type
51 specifications.
52 .sp
53 .ne 2
54 .na
55 \fB\fBDAT_MEM_TYPE_VIRTUAL\fR\fR
56 .ad
57 .sp .6
58 .RS 4n
59 Consumer virtual memory.
60 .sp
61 Region description: A pointer to a contiguous user virtual range.
62 .sp
63 Length: Length of the Memory Region.
64 .RE
66 .sp
67 .ne 2
68 .na
69 \fB\fBDAT_MEM_TYPE_SO_VIRTUAL\fR\fR
70 .ad
71 .sp .6
72 .RS 4n
73 Consumer virtual memory with strong memory ordering. This type is a Solaris
74 specific addition. If the \fIia_handle\fR was opened without \fBRO_AWARE_\fR
75 (see \fBdat_ia_open\fR(3DAT)), then type \fBDAT_MEM_TYPE_VIRTUAL\fR is
76 implicitly converted to this type.
77 .sp
78 Region description: A pointer to a contiguous user virtual range.
79 .sp
80 Length: Length of the Memory Region.
81 .RE
83 .sp
84 .ne 2
85 .na
86 \fB\fBDAT_MEM_TYPE_LMR\fR\fR
87 .ad
88 .sp .6
89 .RS 4n
90 LMR.
91 .sp
92 Region description: An LMR_handle.
93 .sp
94 Length: Length parameter is ignored.
95 .RE
97 .sp
98 .ne 2
99 .na
100 \fB\fBDAT_MEM_TYPE_SHARED_VIRTUAL\fR\fR
101 .ad
102 .sp .6
103 .RS 4n
104 Shared memory region. All DAT Consumers of the same uDAPL Provider specify the
105 same Consumer cookie to indicate who is sharing the shared memory region. This
106 supports a peer-to-peer model of shared memory. All DAT Consumers of the shared
107 memory must allocate the memory region as shared memory using Platform-specific
108 primitives.
109 .sp
110 Region description: A structure with 2 elements, where the first one is of type
111 \fBDAT_LMR_COOKIE\fR and is a unique identifier of the shared memory region,
112 and the second one is a pointer to a contiguous user virtual range.
113 .sp
114 Length: Length of the Memory Region
115 .RE
117 .RE
119 .sp
120 .ne 2
121 .na
122 \fB\fIregion_description\fR\fR
123 .ad
124 .sp .6
125 .RS 4n
126 Pointer to type-specific data describing the memory in the region to be
127 registered. The type is derived from the \fImem_type\fR parameter.
128 .RE
130 .sp
131 .ne 2
132 .na
133 \fB\fIlength\fR\fR
134 .ad
135 .sp .6
136 .RS 4n
137 Length parameter accompanying the region_description.
138 .RE
140 .sp
141 .ne 2
142 .na
143 \fB\fIpz_handle\fR\fR
144 .ad
145 .sp .6
146 .RS 4n
147 Handle for an instance of the Protection Zone.
148 .RE
150 .sp
151 .ne 2
152 .na
153 \fB\fImem_privileges:\fR\fR
154 .ad
155 .sp .6
156 .RS 4n
157 Consumer-requested memory access privileges for the registered local memory
158 region. The Default value is \fBDAT_MEM_PRIV_NONE_FLAG\fR. The constant value
159 \fBDAT_MEM_PRIV_ALL_FLAG\fR = 0x33, which specifies both Read and Write
160 privileges, is also defined. Memory privilege definitions are as follows:
161 .sp
162 .ne 2
163 .na
164 \fBLocal Read\fR
165 .ad
166 .RS 16n
167 \fBDAT_MEM_PRIV_LOCAL_READ_FLAG\fR
168 .sp
169 .ne 2
170 .na
171 \fB0x01\fR
172 .ad
173 .RS 8n
174 Local read access requested.
175 .RE
177 .RE
179 .sp
180 .ne 2
181 .na
182 \fBLocal Write\fR
183 .ad
184 .RS 16n
185 \fBDAT_MEM_PRIV_LOCAL_WRITE_FLAG\fR
186 .sp
187 .ne 2
188 .na
189 \fB0x10\fR
190 .ad
191 .RS 8n
192 Local write access requested.
193 .RE
195 .RE
197 .sp
198 .ne 2
199 .na
200 \fBRemote Read\fR
201 .ad
202 .RS 16n
203 \fBDAT_MEM_PRIV_REMOTE_READ_FLAG\fR
204 .sp
205 .ne 2
206 .na
207 \fB0x02\fR
208 .ad
209 .RS 8n
210 Remote read access requested.
211 .RE
213 .RE
215 .sp
216 .ne 2
217 .na
218 \fBRemote Write\fR
219 .ad
220 .RS 16n
221 \fBDAT_MEM_PRIV_REMOTE_WRITE_FLAG\fR
222 .sp
223 .ne 2
224 .na
225 \fB0x20\fR
226 .ad
227 .RS 8n
228 Remote write access requested.
229 .RE
231 .RE
233 .RE
235 .sp
236 .ne 2
237 .na
238 \fB\fIlmr_handle\fR\fR
239 .ad
240 .sp .6
241 .RS 4n
242 Handle for the created instance of the LMR.
243 .RE
245 .sp
246 .ne 2
247 .na
248 \fB\fIlmr_context\fR\fR
249 .ad
250 .sp .6
251 .RS 4n
252 Context for the created instance of the LMR to use for DTO local buffers.
253 .RE
255 .sp
256 .ne 2
257 .na
258 \fB\fIregistered_size\fR\fR
259 .ad
260 .sp .6
261 .RS 4n
262 Actual memory size registered by the Provider.
263 .RE
265 .sp
266 .ne 2
267 .na
268 \fB\fIregistered_address\fR\fR
269 .ad
270 .sp .6
271 .RS 4n
272 Actual base address of the memory registered by the Provider.
273 .RE
275 .SH DESCRIPTION
276 .sp
277 .LP
278 The \fBdat_lmr_create()\fR function registers a memory region with an IA. The
279 specified buffer must have been previously allocated and pinned by the uDAPL
280 Consumer on the platform. The Provider must do memory pinning if needed, which
281 includes whatever OS-dependent steps are required to ensure that the memory is
282 available on demand for the Interface Adapter. uDAPL does not require that the
283 memory never be swapped out; just that neither the hardware nor the Consumer
284 ever has to deal with it not being there. The created \fIlmr_context\fR can be
285 used for local buffers of DTOs and for binding RMRs, and \fIlmr_handle\fR can
286 be used for creating other LMRs. For uDAPL the scope of the \fIlmr_context\fR
287 is the address space of the DAT Consumer.
288 .sp
289 .LP
290 The return values of \fIregistered_size\fR and \fIregistered_address\fR
291 indicate to the Consumer how much the contiguous region of Consumer virtual
292 memory was registered by the Provider and where the region starts in the
293 Consumer virtual address.
294 .sp
295 .LP
296 The \fImem_type\fR parameter indicates to the Provider the kind of memory to be
297 registered, and can take on any of the values defined in the table in the
298 PARAMETERS section.
299 .sp
300 .LP
301 The \fIpz_handle\fR parameter allows Consumers to restrict local accesses to
302 the registered LMR by DTOs.
303 .sp
304 .LP
305 \fBDAT_LMR_COOKIE\fR is a pointer to a unique identifier of the shared memory
306 region of the \fBDAT_MEM_TYPE_SHARED_VIRTUAL\fR DAT memory type. The identifier
307 is an array of 40 bytes allocated by the Consumer. The Provider must check the
308 entire 40 bytes and shall not interpret it as a null-terminated string.
309 .sp
310 .LP
311 The return value of \fIrmr_context\fR can be transferred by the local Consumer
312 to a Consumer on a remote host to be used for an RDMA DTO.
313 .sp
314 .LP
315 If \fImem_privileges\fR does not specify remote Read and Write privileges,
316 \fIrmr_context\fR is not generated and \fINULL\fR is returned. No remote
317 privileges are given for Memory Region unless explicitly asked for by the
318 Consumer.
319 .SH RETURN VALUES
320 .sp
321 .ne 2
322 .na
323 \fB\fBDAT_SUCCESS\fR\fR
324 .ad
325 .RS 30n
326 The operation was successful.
327 .RE
329 .sp
330 .ne 2
331 .na
332 \fB\fBDAT_UNSUFFICIENT_RESOURCES\fR\fR
333 .ad
334 .RS 30n
335 The operation failed due to resource limitations.
336 .RE
338 .sp
339 .ne 2
340 .na
341 \fB\fBDAT_INVALID_PARAMETER\fR\fR
342 .ad
343 .RS 30n
344 Invalid parameter.
345 .RE
347 .sp
348 .ne 2
349 .na
350 \fB\fBDAT_INVALID_HANDLE\fR\fR
351 .ad
352 .RS 30n
353 Invalid DAT handle.
354 .RE
356 .sp
357 .ne 2
358 .na
359 \fB\fBDAT_INVALID_STATE\fR\fR
360 .ad
361 .RS 30n
362 Parameter in an invalid state. For example, shared virtual buffer was not
363 created shared by the platform.
364 .RE
366 .sp
367 .ne 2
368 .na
369 \fB\fBDAT_MODEL_NOT_SUPPORTED\fR\fR
370 .ad
371 .RS 30n
372 The requested Model was not supported by the Provider. For example, requested
373 Memory Type was not supported by the Provider.
374 .RE
376 .SH USAGE
377 .sp
378 .LP
379 Consumers can create an LMR over the existing LMR memory with different
380 Protection Zones and privileges using previously created IA translation table
381 entries.
382 .sp
383 .LP
384 The Consumer should use \fIrmr_context\fR with caution. Once advertised to a
385 remote peer, the \fIrmr_context\fR of the LMR cannot be invalidated. The only
386 way to invalidate it is to destroy the LMR with \fBdat_lmr_free\fR(3DAT).
387 .SH ATTRIBUTES
388 .sp
389 .LP
390 See \fBattributes\fR(5) for descriptions of the following attributes:
391 .sp
393 .sp
394 .TS
395 box;
396 c | c
397 l | l .
398 ATTRIBUTE TYPE ATTRIBUTE VALUE
399 _
400 Interface Stability Committed
401 _
402 MT-Level Safe
403 _
404 Standard T{
405 uDAPL, 1.1, 1.2 (except \fBDAT_MEM_TYPE_SO_VIRTUAL\fR)
406 T}
407 .TE
409 .SH SEE ALSO
410 .sp
411 .LP
412 \fBdat_lmr_free\fR(3DAT), \fBlibdat\fR(3LIB), \fBattributes\fR(5)