Print this page
9842 man page typos and spelling
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man3dat/dat_ia_query.3dat
+++ new/usr/src/man/man3dat/dat_ia_query.3dat
1 1 '\" te
2 2 .\" This manual page is derived from the DAT/uDAPL 1.2 specification.
3 3 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
4 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 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 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 7 .TH DAT_IA_QUERY 3DAT "Jul 16, 2004"
8 8 .SH NAME
9 9 dat_ia_query \- query an IA
10 10 .SH SYNOPSIS
11 11 .LP
12 12 .nf
13 13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldat\fR [ \fIlibrary\fR\&.\|.\|. ]
14 14 #include <\fBdat/udat.h\fR>
15 15
16 16 DAT_RETURN
17 17 dat_ia_query (
↓ open down ↓ |
17 lines elided |
↑ open up ↑ |
18 18 IN DAT_IA_HANDLE \fIia_handle\fR,
19 19 OUT DAT_EVD_HANDLE *\fIasync_evd_handle\fR,
20 20 IN DAT_IA_ATTR_MASK \fIia_attr_mask\fR,
21 21 OUT DAT_IA_ATTR *\fIia_attributes\fR,
22 22 IN DAT_PROVIDER_ATTR_MASK \fIprovider_attr_mask\fR,
23 23 OUT DAT_PROVIDER_ATTR *\fIprovider_attributes\fR
24 24 )
25 25 .fi
26 26
27 27 .SH PARAMETERS
28 -.sp
29 28 .ne 2
30 29 .na
31 30 \fB\fIia_handle\fR\fR
32 31 .ad
33 32 .RS 23n
34 33 Handle for an open instance of an IA.
35 34 .RE
36 35
37 36 .sp
38 37 .ne 2
39 38 .na
40 39 \fB\fIasync_evd_handle\fR\fR
41 40 .ad
42 41 .RS 23n
43 42 Handle for an Event Dispatcher for asynchronous events generated by the IA.
44 43 .RE
45 44
46 45 .sp
47 46 .ne 2
48 47 .na
49 48 \fB\fIia_attr_mask\fR\fR
50 49 .ad
51 50 .RS 23n
52 51 Mask for the \fIia_attributes\fR.
53 52 .RE
54 53
55 54 .sp
56 55 .ne 2
57 56 .na
58 57 \fB\fIia_attributes\fR\fR
59 58 .ad
60 59 .RS 23n
61 60 Pointer to a Consumer-allocated structure that the Provider fills with IA
62 61 attributes.
63 62 .RE
64 63
65 64 .sp
66 65 .ne 2
67 66 .na
68 67 \fB\fIprovider_attr_mask\fR\fR
69 68 .ad
70 69 .RS 23n
71 70 Mask for the \fIprovider_attributes\fR.
72 71 .RE
73 72
74 73 .sp
↓ open down ↓ |
36 lines elided |
↑ open up ↑ |
75 74 .ne 2
76 75 .na
77 76 \fB\fIprovider_attributes\fR\fR
78 77 .ad
79 78 .RS 23n
80 79 Pointer to a Consumer-allocated structure that the Provider fills with Provider
81 80 attributes.
82 81 .RE
83 82
84 83 .SH DESCRIPTION
85 -.sp
86 84 .LP
87 85 The \fBdat_ia_query()\fR functions provides the Consumer with the IA
88 86 parameters, as well as the IA and Provider attributes. Consumers pass in
89 87 pointers to Consumer-allocated structures for the IA and Provider attributes
90 88 that the Provider fills.
91 89 .sp
92 90 .LP
93 91 The \fIia_attr_mask\fR and \fIprovider_attr_mask\fR parameters allow the
94 92 Consumer to specify which attributes to query. The Provider returns values for
95 93 requested attributes. The Provider can also return values for any of the other
96 94 attributes.
97 95 .SS "Interface Adapter Attributes"
98 -.sp
99 96 .LP
100 97 The IA attributes are common to all open instances of the IA. DAT defines a
101 98 method to query the IA attributes but does not define a method to modify them.
102 99 .sp
103 100 .LP
104 101 If IA is multiported, each port is presented to a Consumer as a separate IA.
105 102 .sp
106 103 .ne 2
107 104 .na
108 105 \fBAdapter name:\fR
109 106 .ad
110 107 .br
111 108 .na
112 109 \fB\fR
113 110 .ad
114 111 .sp .6
115 112 .RS 4n
116 113 The name of the IA controlled by the Provider. The same as \fIia_name_ptr\fR.
117 114 .RE
118 115
119 116 .sp
120 117 .ne 2
121 118 .na
122 119 \fBVendor name:\fR
123 120 .ad
124 121 .sp .6
125 122 .RS 4n
126 123 Vendor if IA hardware.
127 124 .RE
128 125
129 126 .sp
130 127 .ne 2
131 128 .na
132 129 \fBHW version major:\fR
133 130 .ad
134 131 .sp .6
135 132 .RS 4n
136 133 Major version of IA hardware.
137 134 .RE
138 135
139 136 .sp
140 137 .ne 2
141 138 .na
142 139 \fBHW version minor:\fR
143 140 .ad
144 141 .sp .6
145 142 .RS 4n
146 143 Minor version of IA hardware.
147 144 .RE
148 145
149 146 .sp
150 147 .ne 2
151 148 .na
152 149 \fBFirmware version major:\fR
153 150 .ad
154 151 .sp .6
155 152 .RS 4n
156 153 Major version of IA firmware.
157 154 .RE
158 155
159 156 .sp
160 157 .ne 2
161 158 .na
162 159 \fBFirmware version minor:\fR
163 160 .ad
164 161 .sp .6
165 162 .RS 4n
166 163 Minor version of IA firmware.
167 164 .RE
168 165
169 166 .sp
170 167 .ne 2
171 168 .na
172 169 \fBIA_address_ptr:\fR
173 170 .ad
174 171 .sp .6
175 172 .RS 4n
176 173 An address of the interface Adapter.
177 174 .RE
178 175
179 176 .sp
180 177 .ne 2
181 178 .na
182 179 \fBMax EPs:\fR
183 180 .ad
184 181 .sp .6
185 182 .RS 4n
186 183 Maximum number of Endpoints that the IA can support. This covers all Endpoints
187 184 in all states, including the ones used by the Providers, zero or more
188 185 applications, and management.
189 186 .RE
190 187
191 188 .sp
192 189 .ne 2
193 190 .na
194 191 \fBMax DTOs per EP:\fR
195 192 .ad
196 193 .sp .6
197 194 .RS 4n
198 195 Maximum number of DTOs and RMR_binds that any Endpoint can support for a single
199 196 direction. This means the maximum number of outstanding and in-progress Send,
200 197 RDMA Read, RDMA Write DTOs, and RMR Binds at any one time for any Endpoint; and
201 198 maximum number of outstanding and in-progress Receive DTOs at any one time for
202 199 any Endpoint.
203 200 .RE
204 201
205 202 .sp
206 203 .ne 2
207 204 .na
208 205 \fBMax incoming RDMA Reads per EP:\fR
209 206 .ad
210 207 .sp .6
211 208 .RS 4n
212 209 Maximum number of RDMA Reads that can be outstanding per (connected) Endpoint
213 210 with the IA as the target.
214 211 .RE
215 212
216 213 .sp
217 214 .ne 2
218 215 .na
219 216 \fBMax outgoing RDMA Reads per EP:\fR
220 217 .ad
221 218 .sp .6
222 219 .RS 4n
223 220 Maximum number of RDMA Reads that can be outstanding per (connected) Endpoint
224 221 with the IA as the originator.
225 222 .RE
226 223
227 224 .sp
228 225 .ne 2
229 226 .na
230 227 \fBMax EVDs:\fR
231 228 .ad
232 229 .sp .6
233 230 .RS 4n
234 231 Maximum number of Event Dispatchers that an IA can support. An IA cannot
235 232 support an Event Dispatcher directly, but indirectly by Transport-specific
236 233 Objects, for example, Completion Queues for Infiniband\(tm and VI. The Event
237 234 Dispatcher Objects can be shared among multiple Providers and similar Objects
238 235 from other APIs, for example, Event Queues for uDAPL.
239 236 .RE
240 237
241 238 .sp
242 239 .ne 2
243 240 .na
244 241 \fBMax EVD queue size:\fR
245 242 .ad
246 243 .sp .6
247 244 .RS 4n
248 245 Maximum size of the EVD queue supported by an IA.
249 246 .RE
250 247
251 248 .sp
252 249 .ne 2
253 250 .na
254 251 \fBMax IOV segments per DTO:\fR
255 252 .ad
256 253 .sp .6
257 254 .RS 4n
258 255 Maximum entries in an IOV list that an IA supports. Notice that this number
259 256 cannot be explicit but must be implicit to transport-specific Object entries.
260 257 For example, for IB, it is the maximum number of scatter/gather entries per
261 258 Work Request, and for VI it is the maximum number of data segments per VI
262 259 Descriptor.
263 260 .RE
264 261
265 262 .sp
266 263 .ne 2
267 264 .na
268 265 \fBMax LMRs:\fR
269 266 .ad
270 267 .sp .6
271 268 .RS 4n
272 269 Maximum number of Local Memory Regions IA supports among all Providers and
273 270 applications of this IA.
274 271 .RE
275 272
276 273 .sp
277 274 .ne 2
278 275 .na
279 276 \fBMax LMR block size:\fR
280 277 .ad
281 278 .sp .6
282 279 .RS 4n
283 280 Maximum contiguous block that can be registered by the IA.
284 281 .RE
285 282
286 283 .sp
287 284 .ne 2
288 285 .na
289 286 \fBMac LMR VA:\fR
290 287 .ad
291 288 .sp .6
292 289 .RS 4n
293 290 Highest valid virtual address within the context of an LMR. Frequently, IAs on
294 291 32-bit architectures support only 32-bit local virtual addresses.
295 292 .RE
296 293
297 294 .sp
298 295 .ne 2
299 296 .na
300 297 \fBMax PZs:\fR
301 298 .ad
302 299 .sp .6
303 300 .RS 4n
304 301 Maximum number of Protection Zones that the IA supports.
305 302 .RE
306 303
307 304 .sp
308 305 .ne 2
309 306 .na
310 307 \fBMax MTU size:\fR
311 308 .ad
312 309 .sp .6
313 310 .RS 4n
314 311 Maximum message size supported by the IA
315 312 .RE
316 313
317 314 .sp
318 315 .ne 2
319 316 .na
320 317 \fBMax RDMA size:\fR
321 318 .ad
322 319 .sp .6
323 320 .RS 4n
324 321 Maximum RDMA size supported by the IA
325 322 .RE
326 323
327 324 .sp
328 325 .ne 2
329 326 .na
330 327 \fBMax RMRs:\fR
331 328 .ad
332 329 .sp .6
333 330 .RS 4n
334 331 Maximum number of RMRs an IA supports among all Providers and applications of
335 332 this IA.
336 333 .RE
337 334
338 335 .sp
339 336 .ne 2
340 337 .na
341 338 \fBMax RMR target address:\fR
342 339 .ad
343 340 .sp .6
344 341 .RS 4n
345 342 Highest valid target address with the context of a local RMR. Frequently, IAs
346 343 on 32-bit architectures support only 32-bit local virtual addresses.
347 344 .RE
348 345
349 346 .sp
350 347 .ne 2
351 348 .na
352 349 \fBNum transport attributes:\fR
353 350 .ad
354 351 .sp .6
355 352 .RS 4n
356 353 Number of transport-specific attributes.
357 354 .RE
358 355
359 356 .sp
360 357 .ne 2
361 358 .na
362 359 \fBTransport-specific attributes:\fR
363 360 .ad
364 361 .sp .6
365 362 .RS 4n
366 363 Array of transport-specific attributes. Each entry has the format of
367 364 \fBDAT_NAMED_ATTR\fR, which is a structure with two elements. The first element
368 365 is the name of the attribute. The second element is the value of the attribute
369 366 as a string.
370 367 .RE
371 368
372 369 .sp
373 370 .ne 2
374 371 .na
375 372 \fBNum vendor attributes:\fR
376 373 .ad
377 374 .sp .6
378 375 .RS 4n
379 376 Number of vendor-specific attributes.
380 377 .RE
381 378
382 379 .sp
383 380 .ne 2
384 381 .na
385 382 \fBVendor-specific attributes:\fR
↓ open down ↓ |
277 lines elided |
↑ open up ↑ |
386 383 .ad
387 384 .sp .6
388 385 .RS 4n
389 386 Array of vendor-specific attributes. Each entry has the format of
390 387 \fBDAT_NAMED_ATTR\fR, which is a structure with two elements. The first element
391 388 is the name of the attribute. The second element is the value of the attribute
392 389 as a string.
393 390 .RE
394 391
395 392 .SS "DAPL Provider Attributes"
396 -.sp
397 393 .LP
398 394 The provider attributes are specific to the open instance of the IA. DAT
399 395 defines a method to query Provider attributes but does not define a method to
400 396 modify them.
401 397 .sp
402 398 .ne 2
403 399 .na
404 400 \fBProvider name:\fR
405 401 .ad
406 402 .sp .6
407 403 .RS 4n
408 404 Name of the Provider vendor.
409 405 .RE
410 406
411 407 .sp
412 408 .ne 2
413 409 .na
414 410 \fBProvider version major:\fR
415 411 .ad
416 412 .sp .6
417 413 .RS 4n
418 414 Major Version of uDAPL Provider.
419 415 .RE
420 416
421 417 .sp
422 418 .ne 2
423 419 .na
424 420 \fBProvider version minor:\fR
425 421 .ad
426 422 .sp .6
427 423 .RS 4n
428 424 Minor Version of uDAPL Provider.
429 425 .RE
430 426
431 427 .sp
432 428 .ne 2
433 429 .na
434 430 \fBDAPL API version major:\fR
435 431 .ad
436 432 .sp .6
437 433 .RS 4n
438 434 Major Version of uDAPL API supported.
439 435 .RE
440 436
441 437 .sp
442 438 .ne 2
443 439 .na
444 440 \fBDAPL API version minor:\fR
445 441 .ad
446 442 .sp .6
447 443 .RS 4n
448 444 Minor Version of uDAPL API supported.
449 445 .RE
450 446
451 447 .sp
452 448 .ne 2
453 449 .na
454 450 \fBLMR memory types supported:\fR
455 451 .ad
456 452 .sp .6
457 453 .RS 4n
458 454 Memory types that LMR Create supports for memory registration. This value is a
459 455 union of LMR Memory Types \fBDAT_MEM_TYPE_VIRTUAL\fR, \fBDAT_MEM_TYPE_LMR\fR,
460 456 and \fBDAT_MEM_TYPE_SHARED_VIRTUAL\fR that the Provider supports. All Providers
461 457 must support the following Memory Types: \fBDAT_MEM_TYPE_VIRTUAL\fR,
462 458 \fBDAT_MEM_TYPE_LMR\fR, and \fBDAT_MEM_TYPE_SHARED_VIRTUAL\fR.
463 459 .RE
464 460
465 461 .sp
466 462 .ne 2
467 463 .na
468 464 \fBIOV ownership:\fR
469 465 .ad
470 466 .sp .6
471 467 .RS 4n
472 468 An enumeration flag that specifies the ownership of the local buffer
473 469 description (IOV list) after post DTO returns. The three values are as follows:
474 470 .RS +4
475 471 .TP
476 472 .ie t \(bu
477 473 .el o
478 474 \fBDAT_IOV_CONSUMER\fR indicates that the Consumer has the ownership of the
479 475 local buffer description after a post returns.
480 476 .RE
481 477 .RS +4
482 478 .TP
483 479 .ie t \(bu
484 480 .el o
485 481 \fBDAT_IOV_PROVIDER_NOMOD\fR indicates that the Provider still has ownership of
486 482 the local buffer description of the DTO when the post DTO returns, but the
487 483 Provider does not modify the buffer description.
488 484 .RE
489 485 .RS +4
490 486 .TP
491 487 .ie t \(bu
492 488 .el o
493 489 \fBDAT_IOV_PROVIDER_MOD\fR indicates that the Provider still has ownership of
494 490 the local buffer description of the DTO when the post DTO returns and can
495 491 modify the buffer description.
496 492 .RE
497 493 In any case, the Consumer obtains ownership of the local buffer description
498 494 after the DTO transfer is completed and the Consumer is notified through a DTO
499 495 completion event.
500 496 .RE
501 497
502 498 .sp
503 499 .ne 2
504 500 .na
505 501 \fBQOS supported:\fR
506 502 .ad
507 503 .sp .6
508 504 .RS 4n
509 505 The union of the connection QOS supported by the Provider.
510 506 .RE
511 507
512 508 .sp
513 509 .ne 2
514 510 .na
515 511 \fBCompletion flags supported:\fR
516 512 .ad
517 513 .sp .6
518 514 .RS 4n
519 515 The following values for the completion flag \fBDAT_COMPLETION_FLAGS\fR are
520 516 supported by the Provider: \fBDAT_COMPLETION_SUPPRESS_FLAG\fR,
521 517 \fBDAT_COMPLETION_UNSIGNALLED_FLAG\fR,
522 518 \fBDAT_COMPLETION_SOLICITED_WAIT_FLAG\fR, and
523 519 \fBDAT_COMPLETION_BARRIER_FENCE_FLAG\fR.
524 520 .RE
525 521
526 522 .sp
527 523 .ne 2
528 524 .na
529 525 \fBThread safety:\fR
530 526 .ad
531 527 .sp .6
532 528 .RS 4n
533 529 Provider Library thread safe or not. The Provider Library is not required to be
534 530 thread safe.
535 531 .RE
536 532
537 533 .sp
538 534 .ne 2
539 535 .na
540 536 \fBMax private data size:\fR
541 537 .ad
542 538 .sp .6
543 539 .RS 4n
544 540 Maximum size of private data the Provider supports. This value is at least 64
545 541 bytes.
546 542 .RE
547 543
548 544 .sp
549 545 .ne 2
550 546 .na
551 547 \fBMultipathing support:\fR
552 548 .ad
553 549 .sp .6
554 550 .RS 4n
555 551 Capability of the Provider to support Multipathing for connection
556 552 establishment.
557 553 .RE
558 554
559 555 .sp
560 556 .ne 2
561 557 .na
562 558 \fBEP creator for PSP:\fR
563 559 .ad
564 560 .sp .6
565 561 .RS 4n
566 562 Indicator for who can create an Endpoint for a Connection Request. For the
567 563 Consumer it is \fBDAT_PSP_CREATES_EP_NEVER\fR. For the Provider it is
568 564 \fBDAT_PSP_CREATES_EP_ALWAYS\fR. For both it is
569 565 \fBDAT_PSP_CREATES_EP_IFASKED\fR. This attribute is used for Public Service
570 566 Point creation.
571 567 .RE
572 568
573 569 .sp
574 570 .ne 2
575 571 .na
576 572 \fBPZ support:\fR
577 573 .ad
578 574 .sp .6
579 575 .RS 4n
580 576 Indicator of what kind of protection the Provider's PZ provides.
↓ open down ↓ |
174 lines elided |
↑ open up ↑ |
581 577 .RE
582 578
583 579 .sp
584 580 .ne 2
585 581 .na
586 582 \fBOptimal Buffer Alignment:\fR
587 583 .ad
588 584 .sp .6
589 585 .RS 4n
590 586 Local and remote DTO buffer alignment for optimal performance on the Platform.
591 -The \fBDAT_OPTIMAL_ALIGMNEMT\fR must be divisible by this attribute value. The
592 -maximum allowed value is \fBDAT_OPTIMAL_ALIGMNEMT\fR, or 256.
587 +The \fBDAT_OPTIMAL_ALIGNMENT\fR must be divisible by this attribute value. The
588 +maximum allowed value is \fBDAT_OPTIMAL_ALIGNMENT\fR, or 256.
593 589 .RE
594 590
595 591 .sp
596 592 .ne 2
597 593 .na
598 594 \fBEVD stream merging support:\fR
599 595 .ad
600 596 .sp .6
601 597 .RS 4n
602 598 A 2D binary matrix where each row and column represent an event stream type.
603 599 Each binary entry is 1 if the event streams of its row and column can be fed to
604 600 the same EVD, and 0 otherwise.
605 601 .sp
606 602 More than two different event stream types can feed the same EVD if for each
607 603 pair of the event stream types the entry is 1.
608 604 .sp
609 605 The Provider should support merging of all event stream types.
610 606 .sp
611 607 The Consumer should check this attribute before requesting an EVD that merges
612 608 multiple event stream types.
613 609 .RE
614 610
615 611 .sp
616 612 .ne 2
617 613 .na
618 614 \fBNum provider attributes:\fR
619 615 .ad
620 616 .sp .6
621 617 .RS 4n
622 618 Number of Provider-specific attributes.
623 619 .RE
624 620
625 621 .sp
626 622 .ne 2
627 623 .na
628 624 \fBProvider-specific attributes:\fR
↓ open down ↓ |
26 lines elided |
↑ open up ↑ |
629 625 .ad
630 626 .sp .6
631 627 .RS 4n
632 628 Array of Provider-specific attributes. Each entry has the format of
633 629 \fBDAT_NAMED_ATTR\fR, which is a structure with two elements. The first element
634 630 is the name of the attribute. The second element is the value of the attribute
635 631 as a string.
636 632 .RE
637 633
638 634 .SH RETURN VALUES
639 -.sp
640 635 .ne 2
641 636 .na
642 637 \fB\fBDAT_SUCCESS\fR\fR
643 638 .ad
644 639 .RS 25n
645 640 The operation was successful.
646 641 .RE
647 642
648 643 .sp
649 644 .ne 2
650 645 .na
651 646 \fB\fBDAT_INVALID_PARAMETER\fR\fR
652 647 .ad
653 648 .RS 25n
654 649 Invalid parameter;
655 650 .RE
656 651
↓ open down ↓ |
7 lines elided |
↑ open up ↑ |
657 652 .sp
658 653 .ne 2
659 654 .na
660 655 \fB\fBDAT_INVALID_HANDLE\fR\fR
661 656 .ad
662 657 .RS 25n
663 658 Invalid DAT handle; ia_handle is invalid.
664 659 .RE
665 660
666 661 .SH ATTRIBUTES
667 -.sp
668 662 .LP
669 663 See \fBattributes\fR(5) for descriptions of the following attributes:
670 664 .sp
671 665
672 666 .sp
673 667 .TS
674 668 box;
675 669 c | c
676 670 l | l .
677 671 ATTRIBUTE TYPE ATTRIBUTE VALUE
678 672 _
679 673 Interface Stability Standard: uDAPL, 1.1, 1.2
680 674 _
681 675 MT-Level Safe
682 676 .TE
683 677
684 678 .SH SEE ALSO
685 -.sp
686 679 .LP
687 680 \fBlibdat\fR(3LIB), \fBattributes\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX