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