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