/usr/include/dat2/dat.h is in libdapl-dev 2.1.10.1.f1e05b7a-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 | /*
* Copyright (c) 2002-2006, Network Appliance, Inc. All rights reserved.
*
* This Software is licensed under all of the following licenses:
*
* 1) under the terms of the "Common Public License 1.0" a copy of which is
* in the file LICENSE.txt in the root directory. The license is also
* available from the Open Source Initiative, see
* http://www.opensource.org/licenses/cpl.php.
*
* 2) under the terms of the "The BSD License" a copy of which is in the file
* LICENSE2.txt in the root directory. The license is also available from
* the Open Source Initiative, see
* http://www.opensource.org/licenses/bsd-license.php.
*
* 3) under the terms of the "GNU General Public License (GPL) Version 2" a
* copy of which is in the file LICENSE3.txt in the root directory. The
* license is also available from the Open Source Initiative, see
* http://www.opensource.org/licenses/gpl-license.php.
*
* Licensee has the right to choose one of the above licenses.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain both the above copyright
* notice and one of the license notices.
*
* Redistributions in binary form must reproduce both the above copyright
* notice, one of the license notices in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of Network Appliance, Inc. nor the names of other DAT
* Collaborative contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*/
/***************************************************************
*
* HEADER: dat.h
*
* PURPOSE: defines the common DAT API for uDAPL and kDAPL.
*
* Description: Header file for "DAPL: Direct Access Programming
* Library, Version: 2.0"
*
* Mapping rules:
* All global symbols are prepended with DAT_ or dat_
* All DAT objects have an 'api' tag which, such as 'EP' or 'LMR'
* The method table is in the provider definition structure.
*
*
***************************************************************/
#ifndef _DAT_H_
#define _DAT_H_
#include <dat2/dat_error.h>
#ifdef __cplusplus
extern "C"
{
#endif
/* Generic DAT types */
typedef char * DAT_NAME_PTR; /* Format for ia_name and attributes */
#define DAT_NAME_MAX_LENGTH 256
/*
* Used for provider, vendor, transport, hardware-specific attributes
* definitions.
*/
typedef struct dat_named_attr
{
const char * name; /* Name of attribute */
const char * value; /* Value of attribute */
} DAT_NAMED_ATTR;
typedef enum dat_boolean
{
DAT_FALSE = 0,
DAT_TRUE = 1
} DAT_BOOLEAN;
#ifdef DAT_EXTENSIONS
#define DAT_IB_EXTENSION 1
#define DAT_IW_EXTENSION 2
#endif /* DAT_EXTENSIONS */
typedef DAT_UINT32 DAT_HA_LB;
#define DAT_HA_LB_NONE (DAT_HA_LB)0
#define DAT_HA_LB_INTERCOMM (DAT_HA_LB)1
#define DAT_HA_LB_INTRACOMM (DAT_HA_LB)2
typedef union dat_context
{
DAT_PVOID as_ptr;
DAT_UINT64 as_64;
DAT_UVERYLONG as_index;
} DAT_CONTEXT;
typedef DAT_CONTEXT DAT_DTO_COOKIE;
typedef DAT_CONTEXT DAT_RMR_COOKIE;
typedef enum dat_completion_flags
{
/* Completes with notification */
DAT_COMPLETION_DEFAULT_FLAG = 0x00,
/* Completions suppressed if successful */
DAT_COMPLETION_SUPPRESS_FLAG = 0x01,
/* Sender controlled notification for recv completion */
DAT_COMPLETION_SOLICITED_WAIT_FLAG = 0x02,
/* Completions with unsignaled notifications */
DAT_COMPLETION_UNSIGNALLED_FLAG = 0x04,
/* Do not start processing until all previous RDMA reads complete. */
DAT_COMPLETION_BARRIER_FENCE_FLAG = 0x08,
/* Only valid for uDAPL as EP attribute for Recv Completion flags.
* Waiter unblocking is controlled by the Threshold value of
* dat_evd_wait. UNSIGNALLED for RECV is not allowed when EP has
* this attribute. */
DAT_COMPLETION_EVD_THRESHOLD_FLAG = 0x10,
/* Only valid for kDAPL
* Do not start processing LMR invalidate until all
* previously posted DTOs to the EP Request Queue
* have been completed.
* The value for LMR Invalidate Fence does not
* conflict with uDAPL so it can be extended
* to uDAPL usage later.
*/
DAT_COMPLETION_LMR_INVALIDATE_FENCE_FLAG = 0x20
} DAT_COMPLETION_FLAGS;
typedef DAT_UINT32 DAT_TIMEOUT; /* microseconds */
/* timeout = infinity */
#define DAT_TIMEOUT_INFINITE ((DAT_TIMEOUT) ~0)
/* dat handles */
typedef DAT_PVOID DAT_HANDLE;
typedef DAT_HANDLE DAT_CR_HANDLE;
typedef DAT_HANDLE DAT_EP_HANDLE;
typedef DAT_HANDLE DAT_EVD_HANDLE;
typedef DAT_HANDLE DAT_IA_HANDLE;
typedef DAT_HANDLE DAT_LMR_HANDLE;
typedef DAT_HANDLE DAT_PSP_HANDLE;
typedef DAT_HANDLE DAT_PZ_HANDLE;
typedef DAT_HANDLE DAT_RMR_HANDLE;
typedef DAT_HANDLE DAT_RSP_HANDLE;
typedef DAT_HANDLE DAT_SRQ_HANDLE;
typedef DAT_HANDLE DAT_CSP_HANDLE;
typedef enum dat_dtos
{
DAT_DTO_SEND,
DAT_DTO_RDMA_WRITE,
DAT_DTO_RDMA_READ,
DAT_DTO_RECEIVE,
DAT_DTO_RECEIVE_WITH_INVALIDATE,
DAT_DTO_BIND_MW, /* DAT 2.0 review, binds are reported via DTO events */
DAT_DTO_LMR_FMR, /* kdat specific */
DAT_DTO_LMR_INVALIDATE /* kdat specific */
#ifdef DAT_EXTENSIONS
,DAT_DTO_EXTENSION_BASE /* To be used by DAT extensions
as a starting point of extension DTOs */
#endif /* DAT_EXTENSIONS */
} DAT_DTOS;
/* dat NULL handles */
#define DAT_HANDLE_NULL ((DAT_HANDLE)NULL)
typedef DAT_SOCK_ADDR* DAT_IA_ADDRESS_PTR;
typedef DAT_UINT64 DAT_CONN_QUAL;
typedef DAT_UINT64 DAT_PORT_QUAL;
/* QOS definitions */
typedef enum dat_qos
{
DAT_QOS_BEST_EFFORT = 0x00,
DAT_QOS_HIGH_THROUGHPUT = 0x01,
DAT_QOS_LOW_LATENCY = 0x02,
/* not low latency, nor high throughput */
DAT_QOS_ECONOMY = 0x04,
/* both low latency and high throughput */
DAT_QOS_PREMIUM = 0x08
} DAT_QOS;
/*
* FLAGS
*/
/* for backward compatibility */
#define DAT_CONNECT_MULTIPATH_REQUESTED_FLAG DAT_CONNECT_MULTIPATH_FLAG
typedef enum dat_connect_flags
{
DAT_CONNECT_DEFAULT_FLAG = 0x00,
DAT_CONNECT_MULTIPATH_REQUESTED_FLAG = 0x01,
DAT_CONNECT_MULTIPATH_REQUIRED_FLAG = 0x02
} DAT_CONNECT_FLAGS;
typedef enum dat_close_flags
{
DAT_CLOSE_ABRUPT_FLAG = 0x00,
DAT_CLOSE_GRACEFUL_FLAG = 0x01
} DAT_CLOSE_FLAGS;
#define DAT_CLOSE_DEFAULT DAT_CLOSE_ABRUPT_FLAG
typedef enum dat_evd_flags
{
DAT_EVD_SOFTWARE_FLAG = 0x001,
DAT_EVD_CR_FLAG = 0x010,
DAT_EVD_DTO_FLAG = 0x020,
DAT_EVD_CONNECTION_FLAG = 0x040,
DAT_EVD_RMR_BIND_FLAG = 0x080,
DAT_EVD_ASYNC_FLAG = 0x100,
/* DAT events only, no software events */
DAT_EVD_DEFAULT_FLAG = 0x1F0
#ifdef DAT_EXTENSIONS
/* To be used by DAT extensions as a starting point for extended evd flags */
,DAT_EVD_EXTENSION_BASE = 0x200
#endif /* DAT_EXTENSIONS */
} DAT_EVD_FLAGS;
typedef enum dat_psp_flags
{
DAT_PSP_CONSUMER_FLAG = 0x00, /* Consumer creates an Endpoint */
DAT_PSP_PROVIDER_FLAG = 0x01 /* Provider creates an Endpoint */
} DAT_PSP_FLAGS;
/*
* Memory Buffers
*
* Both LMR and RMR triplets specify 64-bit addresses in the local host's byte
* order, even when that exceeds the size of a DAT_PVOID for the host
* architecture.
*/
/*
* Both LMR and RMR Triplets specify 64-bit addresses in the local host
* order, even when that exceeds the size of a void pointer for the host
* architecture. The DAT_VADDR type that represents addresses is in the
* native byte-order of the local host. Helper macros that allow Consumers
* to convert DAT_VADDR into various orders that might be useful for
* inclusion of RMR Triplets into a payload of a message follow.
*
* DAT defines the following macros to convert the fields on an RMR Triplet
* to defined byte orders to allow their export by the Consumer over wire
* protocols. DAT does not define how the two peers decide which byte should be
* used.
*
* DAT_LMRC_TO_LSB(lmrc) returns the supplied LMR Context in ls-byte
* order.
* DAT_LMRC_TO_MSB(lmrc) returns the supplied LMR Context in ms-byte
* order.
* DAT_RMRC_TO_LSB(rmrc) returns the supplied RMR Context in ls-byte
* order.
* DAT_RMRC_TO_MSB(rmrc) returns the supplied RMR Context in ms-byte
* order.
* DAT_VADDR_TO_LSB(vaddr) returns the supplied Virtual Address in ls-byte
* order.
* DAT_VADDR_TO_MSB(vaddr) returns the supplied Virtual Address in
* ms-byte order.
* DAT_VLEN_TO_LSB(vlen) returns the supplied length in ls-byte order.
* DAT_VLEN_TO_MSB(vlen) returns the supplied length in ms-byte order.
*
* Consumers are free to use 64-bit or 32-bit arithmetic for local or remote
* memory address and length manipulation in their preferred byte-order. Only the
* LMR and RMR Triplets passed to a Provider as part of a Posted DTO are
* required to be in 64-bit address and local host order formats. Providers shall
* convert RMR_Triplets to a Transport-required wire format.
*
* For the best performance, Consumers should align each buffer segment to
* the boundary specified by the dat_optimal_alignment.
*/
typedef DAT_UINT32 DAT_LMR_CONTEXT;
typedef DAT_UINT32 DAT_RMR_CONTEXT;
typedef DAT_UINT64 DAT_VLEN;
typedef DAT_UINT64 DAT_VADDR;
typedef DAT_UINT32 DAT_SEG_LENGTH; /* The maximum data segment length */
typedef struct dat_provider_attr DAT_PROVIDER_ATTR;
typedef struct dat_evd_param DAT_EVD_PARAM;
typedef struct dat_lmr_param DAT_LMR_PARAM;
typedef enum dat_lmr_param_mask DAT_LMR_PARAM_MASK;
/* It is legal for the Consumer to specify zero for segment_length
* of the dat_lmr_triplet. When 0 is specified for the
* segment_length then the other two elements of the
* dat_lmr_triplet are irrelevant and can be invalid.
*/
typedef struct dat_lmr_triplet
{
DAT_VADDR virtual_address;/* 64-bit address */
DAT_SEG_LENGTH segment_length; /* 32-bit length */
DAT_LMR_CONTEXT lmr_context; /* 32-bit lmr_context */
} DAT_LMR_TRIPLET;
typedef struct dat_rmr_triplet
{
DAT_VADDR virtual_address;/* 64-bit address */
DAT_SEG_LENGTH segment_length; /* 32-bit length */
DAT_RMR_CONTEXT rmr_context; /* 32-bit rmr_context */
} DAT_RMR_TRIPLET;
/* Memory privileges */
typedef enum dat_mem_priv_flags
{
DAT_MEM_PRIV_NONE_FLAG = 0x00,
DAT_MEM_PRIV_LOCAL_READ_FLAG = 0x01,
DAT_MEM_PRIV_REMOTE_READ_FLAG = 0x02,
DAT_MEM_PRIV_LOCAL_WRITE_FLAG = 0x10,
DAT_MEM_PRIV_REMOTE_WRITE_FLAG = 0x20,
DAT_MEM_PRIV_ALL_FLAG = 0x33
#ifdef DAT_EXTENSIONS
/* To be used by DAT extensions as a starting
point of extension memory privileges */
,DAT_MEM_PRIV_EXTENSION_BASE = 0x40
#endif /* DAT_EXTENSIONS */
} DAT_MEM_PRIV_FLAGS;
/* For backward compatibility with DAT-1.0, memory privileges values are
* supported
*/
#define DAT_MEM_PRIV_READ_FLAG (DAT_MEM_PRIV_LOCAL_READ_FLAG | DAT_MEM_PRIV_REMOTE_READ_FLAG)
#define DAT_MEM_PRIV_WRITE_FLAG (DAT_MEM_PRIV_LOCAL_WRITE_FLAG | DAT_MEM_PRIV_REMOTE_WRITE_FLAG)
/* LMR VA types */
typedef enum dat_va_type
{
DAT_VA_TYPE_VA = 0x0,
DAT_VA_TYPE_ZB = 0x1
} DAT_VA_TYPE;
/* RMR Arguments & RMR Arguments Mask */
/* DAPL 2.0 addition */
/* Defines RMR protection scope */
typedef enum dat_rmr_scope
{
DAT_RMR_SCOPE_EP, /* bound to at most one EP at a time. */
DAT_RMR_SCOPE_PZ, /* bound to a Protection Zone */
DAT_RMR_SCOPE_ANY /* Supports all types */
} DAT_RMR_SCOPE;
typedef struct dat_rmr_param
{
DAT_IA_HANDLE ia_handle;
DAT_PZ_HANDLE pz_handle;
DAT_LMR_TRIPLET lmr_triplet;
DAT_MEM_PRIV_FLAGS mem_priv;
DAT_RMR_CONTEXT rmr_context;
DAT_RMR_SCOPE rmr_scope;
DAT_VA_TYPE va_type;
} DAT_RMR_PARAM;
typedef enum dat_rmr_param_mask
{
DAT_RMR_FIELD_IA_HANDLE = 0x01,
DAT_RMR_FIELD_PZ_HANDLE = 0x02,
DAT_RMR_FIELD_LMR_TRIPLET = 0x04,
DAT_RMR_FIELD_MEM_PRIV = 0x08,
DAT_RMR_FIELD_RMR_CONTEXT = 0x10,
DAT_RMR_FIELD_RMR_SCOPE = 0x20,
DAT_RMR_FIELD_VA_TYPE = 0x40,
DAT_RMR_FIELD_ALL = 0x7F
} DAT_RMR_PARAM_MASK;
/* Provider attributes */
typedef enum dat_iov_ownership
{
/* Not a modification by the Provider; the Consumer can use anytime. */
DAT_IOV_CONSUMER = 0x0,
/* Provider does not modify returned IOV DTO on completion. */
DAT_IOV_PROVIDER_NOMOD = 0x1,
/* Provider can modify IOV DTO on completion; can't trust it. */
DAT_IOV_PROVIDER_MOD = 0x2
} DAT_IOV_OWNERSHIP;
typedef enum dat_ep_creator_for_psp
{
DAT_PSP_CREATES_EP_NEVER, /* Provider never creates Endpoint. */
DAT_PSP_CREATES_EP_IFASKED, /* Provider creates Endpoint if asked. */
DAT_PSP_CREATES_EP_ALWAYS /* Provider always creates Endpoint. */
} DAT_EP_CREATOR_FOR_PSP;
/* General Interface Adapter attributes. These apply to both udat and kdat. */
/* To support backwards compatibility for DAPL-1.0 */
#define max_rdma_read_per_ep max_rdma_read_per_ep_in
#define DAT_IA_FIELD_IA_MAX_DTO_PER_OP DAT_IA_FIELD_IA_MAX_DTO_PER_EP_IN
/* To support backwards compatibility for DAPL-1.0 & DAPL-1.1 */
#define max_mtu_size max_message_size
/* Query for provider IA extension support */
typedef enum dat_extension
{
DAT_EXTENSION_NONE,/* no extension supported. */
DAT_EXTENSION_IB, /* IB extension. */
DAT_EXTENSION_IW /* iWARP extension. */
} DAT_EXTENSION;
typedef struct dat_ia_attr DAT_IA_ATTR;
/* To support backwards compatibility for DAPL-1.0 & DAPL-1.1 */
#define DAT_IA_FIELD_IA_MAX_MTU_SIZE DAT_IA_FIELD_IA_MAX_MESSAGE_SIZE
typedef DAT_UINT64 DAT_IA_ATTR_MASK;
#define DAT_IA_FIELD_IA_ADAPTER_NAME UINT64_C(0x000000001)
#define DAT_IA_FIELD_IA_VENDOR_NAME UINT64_C(0x000000002)
#define DAT_IA_FIELD_IA_HARDWARE_MAJOR_VERSION UINT64_C(0x000000004)
#define DAT_IA_FIELD_IA_HARDWARE_MINOR_VERSION UINT64_C(0x000000008)
#define DAT_IA_FIELD_IA_FIRMWARE_MAJOR_VERSION UINT64_C(0x000000010)
#define DAT_IA_FIELD_IA_FIRMWARE_MINOR_VERSION UINT64_C(0x000000020)
#define DAT_IA_FIELD_IA_ADDRESS_PTR UINT64_C(0x000000040)
#define DAT_IA_FIELD_IA_MAX_EPS UINT64_C(0x000000080)
#define DAT_IA_FIELD_IA_MAX_DTO_PER_EP UINT64_C(0x000000100)
#define DAT_IA_FIELD_IA_MAX_RDMA_READ_PER_EP_IN UINT64_C(0x000000200)
#define DAT_IA_FIELD_IA_MAX_RDMA_READ_PER_EP_OUT UINT64_C(0x000000400)
#define DAT_IA_FIELD_IA_MAX_EVDS UINT64_C(0x000000800)
#define DAT_IA_FIELD_IA_MAX_EVD_QLEN UINT64_C(0x000001000)
#define DAT_IA_FIELD_IA_MAX_IOV_SEGMENTS_PER_DTO UINT64_C(0x000002000)
#define DAT_IA_FIELD_IA_MAX_LMRS UINT64_C(0x000004000)
#define DAT_IA_FIELD_IA_MAX_LMR_BLOCK_SIZE UINT64_C(0x000008000)
#define DAT_IA_FIELD_IA_MAX_LMR_VIRTUAL_ADDRESS UINT64_C(0x000010000)
#define DAT_IA_FIELD_IA_MAX_PZS UINT64_C(0x000020000)
#define DAT_IA_FIELD_IA_MAX_MESSAGE_SIZE UINT64_C(0x000040000)
#define DAT_IA_FIELD_IA_MAX_RDMA_SIZE UINT64_C(0x000080000)
#define DAT_IA_FIELD_IA_MAX_RMRS UINT64_C(0x000100000)
#define DAT_IA_FIELD_IA_MAX_RMR_TARGET_ADDRESS UINT64_C(0x000200000)
#define DAT_IA_FIELD_IA_MAX_SRQS UINT64_C(0x000400000)
#define DAT_IA_FIELD_IA_MAX_EP_PER_SRQ UINT64_C(0x000800000)
#define DAT_IA_FIELD_IA_MAX_RECV_PER_SRQ UINT64_C(0x001000000)
#define DAT_IA_FIELD_IA_MAX_IOV_SEGMENTS_PER_RDMA_READ UINT64_C(0x002000000)
#define DAT_IA_FIELD_IA_MAX_IOV_SEGMENTS_PER_RDMA_WRITE UINT64_C(0x004000000)
#define DAT_IA_FIELD_IA_MAX_RDMA_READ_IN UINT64_C(0x008000000)
#define DAT_IA_FIELD_IA_MAX_RDMA_READ_OUT UINT64_C(0x010000000)
#define DAT_IA_FIELD_IA_MAX_RDMA_READ_PER_EP_IN_GUARANTEED UINT64_C(0x020000000)
#define DAT_IA_FIELD_IA_MAX_RDMA_READ_PER_EP_OUT_GUARANTEED UINT64_C(0x040000000)
#define DAT_IA_FIELD_IA_ZB_SUPPORTED UINT64_C(0x080000000)
#define DAT_IA_FIELD_IA_EXTENSIONS_SUPPORTED UINT64_C(0x100000000)
/* To support backwards compatibility for DAPL-1.0 & DAPL-1.1 */
#define DAT_IA_ALL DAT_IA_FIELD_ALL
#define DAT_IA_FIELD_NONE UINT64_C(0x0)
/* Endpoint attributes */
typedef enum dat_service_type
{
DAT_SERVICE_TYPE_RC /* reliable connections */
#ifdef DAT_EXTENSIONS
,DAT_SERVICE_TYPE_EXTENSION_BASE /* To be used by DAT extensions
as a starting point of extension services */
#endif /* DAT_EXTENSIONS */
} DAT_SERVICE_TYPE;
typedef struct dat_ep_attr
{
DAT_SERVICE_TYPE service_type;
DAT_SEG_LENGTH max_message_size;
DAT_SEG_LENGTH max_rdma_size;
DAT_QOS qos;
DAT_COMPLETION_FLAGS recv_completion_flags;
DAT_COMPLETION_FLAGS request_completion_flags;
DAT_COUNT max_recv_dtos;
DAT_COUNT max_request_dtos;
DAT_COUNT max_recv_iov;
DAT_COUNT max_request_iov;
DAT_COUNT max_rdma_read_in;
DAT_COUNT max_rdma_read_out;
DAT_COUNT srq_soft_hw;
DAT_COUNT max_rdma_read_iov;
DAT_COUNT max_rdma_write_iov;
DAT_COUNT ep_transport_specific_count;
DAT_NAMED_ATTR * ep_transport_specific;
DAT_COUNT ep_provider_specific_count;
DAT_NAMED_ATTR * ep_provider_specific;
} DAT_EP_ATTR;
/* Endpoint Parameters */
/* For backwards compatibility */
#define DAT_EP_STATE_ERROR DAT_EP_STATE_DISCONNECTED
typedef enum dat_ep_state
{
DAT_EP_STATE_UNCONNECTED, /* quiescent state */
DAT_EP_STATE_UNCONFIGURED_UNCONNECTED,
DAT_EP_STATE_RESERVED,
DAT_EP_STATE_UNCONFIGURED_RESERVED,
DAT_EP_STATE_PASSIVE_CONNECTION_PENDING,
DAT_EP_STATE_UNCONFIGURED_PASSIVE,
DAT_EP_STATE_ACTIVE_CONNECTION_PENDING,
DAT_EP_STATE_TENTATIVE_CONNECTION_PENDING,
DAT_EP_STATE_UNCONFIGURED_TENTATIVE,
DAT_EP_STATE_CONNECTED,
DAT_EP_STATE_DISCONNECT_PENDING,
DAT_EP_STATE_DISCONNECTED,
DAT_EP_STATE_COMPLETION_PENDING,
DAT_EP_STATE_CONNECTED_SINGLE_PATH,
DAT_EP_STATE_CONNECTED_MULTI_PATH
} DAT_EP_STATE;
typedef struct dat_ep_param
{
DAT_IA_HANDLE ia_handle;
DAT_EP_STATE ep_state;
DAT_COMM comm;
DAT_IA_ADDRESS_PTR local_ia_address_ptr;
DAT_PORT_QUAL local_port_qual;
DAT_IA_ADDRESS_PTR remote_ia_address_ptr;
DAT_PORT_QUAL remote_port_qual;
DAT_PZ_HANDLE pz_handle;
DAT_EVD_HANDLE recv_evd_handle;
DAT_EVD_HANDLE request_evd_handle;
DAT_EVD_HANDLE connect_evd_handle;
DAT_SRQ_HANDLE srq_handle;
DAT_EP_ATTR ep_attr;
} DAT_EP_PARAM;
typedef DAT_UINT64 DAT_EP_PARAM_MASK;
#define DAT_EP_FIELD_IA_HANDLE UINT64_C(0x00000001)
#define DAT_EP_FIELD_EP_STATE UINT64_C(0x00000002)
#define DAT_EP_FIELD_COMM UINT64_C(0x00000004)
#define DAT_EP_FIELD_LOCAL_IA_ADDRESS_PTR UINT64_C(0x00000008)
#define DAT_EP_FIELD_LOCAL_PORT_QUAL UINT64_C(0x00000010)
#define DAT_EP_FIELD_REMOTE_IA_ADDRESS_PTR UINT64_C(0x00000020)
#define DAT_EP_FIELD_REMOTE_PORT_QUAL UINT64_C(0x00000040)
#define DAT_EP_FIELD_PZ_HANDLE UINT64_C(0x00000080)
#define DAT_EP_FIELD_RECV_EVD_HANDLE UINT64_C(0x00000100)
#define DAT_EP_FIELD_REQUEST_EVD_HANDLE UINT64_C(0x00000200)
#define DAT_EP_FIELD_CONNECT_EVD_HANDLE UINT64_C(0x00000400)
#define DAT_EP_FIELD_SRQ_HANDLE UINT64_C(0x00000800)
/* Remainder of values from EP_ATTR, 0x00001000 and up */
#define DAT_EP_FIELD_EP_ATTR_SERVICE_TYPE UINT64_C(0x00001000)
#define DAT_EP_FIELD_EP_ATTR_MAX_MESSAGE_SIZE UINT64_C(0x00002000)
#define DAT_EP_FIELD_EP_ATTR_MAX_RDMA_SIZE UINT64_C(0x00004000)
#define DAT_EP_FIELD_EP_ATTR_QOS UINT64_C(0x00008000)
#define DAT_EP_FIELD_EP_ATTR_RECV_COMPLETION_FLAGS UINT64_C(0x00010000)
#define DAT_EP_FIELD_EP_ATTR_REQUEST_COMPLETION_FLAGS UINT64_C(0x00020000)
#define DAT_EP_FIELD_EP_ATTR_MAX_RECV_DTOS UINT64_C(0x00040000)
#define DAT_EP_FIELD_EP_ATTR_MAX_REQUEST_DTOS UINT64_C(0x00080000)
#define DAT_EP_FIELD_EP_ATTR_MAX_RECV_IOV UINT64_C(0x00100000)
#define DAT_EP_FIELD_EP_ATTR_MAX_REQUEST_IOV UINT64_C(0x00200000)
#define DAT_EP_FIELD_EP_ATTR_MAX_RDMA_READ_IN UINT64_C(0x00400000)
#define DAT_EP_FIELD_EP_ATTR_MAX_RDMA_READ_OUT UINT64_C(0x00800000)
#define DAT_EP_FIELD_EP_ATTR_SRQ_SOFT_HW UINT64_C(0x01000000)
#define DAT_EP_FIELD_EP_ATTR_MAX_RDMA_READ_IOV UINT64_C(0x02000000)
#define DAT_EP_FIELD_EP_ATTR_MAX_RDMA_WRITE_IOV UINT64_C(0x04000000)
#define DAT_EP_FIELD_EP_ATTR_NUM_TRANSPORT_ATTR UINT64_C(0x08000000)
#define DAT_EP_FIELD_EP_ATTR_TRANSPORT_SPECIFIC_ATTR UINT64_C(0x10000000)
#define DAT_EP_FIELD_EP_ATTR_NUM_PROVIDER_ATTR UINT64_C(0x20000000)
#define DAT_EP_FIELD_EP_ATTR_PROVIDER_SPECIFIC_ATTR UINT64_C(0x40000000)
#define DAT_EP_FIELD_EP_ATTR_ALL UINT64_C(0x7FFFF000)
#define DAT_EP_FIELD_ALL UINT64_C(0x7FFFFFFF)
#define DAT_WATERMARK_INFINITE ((DAT_COUNT)~0)
#define DAT_HW_DEFAULT DAT_WATERMARK_INFINITE
#define DAT_SRQ_LW_DEFAULT 0x0
typedef enum dat_srq_state
{
DAT_SRQ_STATE_ERROR,
DAT_SRQ_STATE_OPERATIONAL,
DAT_SRQ_STATE_SHUTDOWN
} DAT_SRQ_STATE;
#define DAT_VALUE_UNKNOWN (((DAT_COUNT) ~0)-1)
typedef struct dat_srq_attr
{
DAT_COUNT max_recv_dtos;
DAT_COUNT max_recv_iov;
DAT_COUNT low_watermark;
} DAT_SRQ_ATTR;
typedef struct dat_srq_param
{
DAT_IA_HANDLE ia_handle;
DAT_SRQ_STATE srq_state;
DAT_PZ_HANDLE pz_handle;
DAT_COUNT max_recv_dtos;
DAT_COUNT max_recv_iov;
DAT_COUNT low_watermark;
DAT_COUNT available_dto_count;
DAT_COUNT outstanding_dto_count;
} DAT_SRQ_PARAM;
typedef enum dat_srq_param_mask
{
DAT_SRQ_FIELD_IA_HANDLE = 0x001,
DAT_SRQ_FIELD_SRQ_STATE = 0x002,
DAT_SRQ_FIELD_PZ_HANDLE = 0x004,
DAT_SRQ_FIELD_MAX_RECV_DTO = 0x008,
DAT_SRQ_FIELD_MAX_RECV_IOV = 0x010,
DAT_SRQ_FIELD_LOW_WATERMARK = 0x020,
DAT_SRQ_FIELD_AVAILABLE_DTO_COUNT = 0x040,
DAT_SRQ_FIELD_OUTSTANDING_DTO_COUNT = 0x080,
DAT_SRQ_FIELD_ALL = 0x0FF
} DAT_SRQ_PARAM_MASK;
/* PZ Parameters */
typedef struct dat_pz_param
{
DAT_IA_HANDLE ia_handle;
} DAT_PZ_PARAM;
typedef enum dat_pz_param_mask
{
DAT_PZ_FIELD_IA_HANDLE = 0x01,
DAT_PZ_FIELD_ALL = 0x01
} DAT_PZ_PARAM_MASK;
/* PSP Parameters */
typedef struct dat_psp_param
{
DAT_IA_HANDLE ia_handle;
DAT_CONN_QUAL conn_qual;
DAT_EVD_HANDLE evd_handle;
DAT_PSP_FLAGS psp_flags;
} DAT_PSP_PARAM;
typedef enum dat_psp_param_mask
{
DAT_PSP_FIELD_IA_HANDLE = 0x01,
DAT_PSP_FIELD_CONN_QUAL = 0x02,
DAT_PSP_FIELD_EVD_HANDLE = 0x04,
DAT_PSP_FIELD_PSP_FLAGS = 0x08,
DAT_PSP_FIELD_ALL = 0x0F
} DAT_PSP_PARAM_MASK;
/* RSP Parameters */
typedef struct dat_rsp_param
{
DAT_IA_HANDLE ia_handle;
DAT_CONN_QUAL conn_qual;
DAT_EVD_HANDLE evd_handle;
DAT_EP_HANDLE ep_handle;
} DAT_RSP_PARAM;
typedef enum dat_rsp_param_mask
{
DAT_RSP_FIELD_IA_HANDLE = 0x01,
DAT_RSP_FIELD_CONN_QUAL = 0x02,
DAT_RSP_FIELD_EVD_HANDLE = 0x04,
DAT_RSP_FIELD_EP_HANDLE = 0x08,
DAT_RSP_FIELD_ALL = 0x0F
} DAT_RSP_PARAM_MASK;
/* CSP Parameters */
typedef struct dat_csp_param
{
DAT_IA_HANDLE ia_handle;
DAT_COMM *comm;
DAT_IA_ADDRESS_PTR address_ptr;
DAT_EVD_HANDLE evd_handle;
} DAT_CSP_PARAM;
typedef enum dat_csp_param_mask
{
DAT_CSP_FIELD_IA_HANDLE = 0x01,
DAT_CSP_FIELD_COMM = 0x02,
DAT_CSP_FIELD_IA_ADDRESS = 0x04,
DAT_CSP_FIELD_EVD_HANDLE = 0x08,
DAT_CSP_FIELD_ALL = 0x0F
} DAT_CSP_PARAM_MASK;
/* Connection Request Parameters.
*
* The Connection Request does not provide Remote Endpoint attributes.
* If a local Consumer needs this information, the remote Consumer should
* encode it into Private Data.
*/
typedef struct dat_cr_param
{
/* Remote IA whose Endpoint requested the connection. */
DAT_IA_ADDRESS_PTR remote_ia_address_ptr;
/* Port qualifier of the remote Endpoint of the requested connection.*/
DAT_PORT_QUAL remote_port_qual;
/* Size of the Private Data. */
DAT_COUNT private_data_size;
/* Pointer to the Private Data passed by remote side in the Connection
* Request.
*/
DAT_PVOID private_data;
/* The local Endpoint provided by the Service Point for the requested
* connection. It is the only Endpoint that can accept a Connection
* Request on this Service Point. The value DAT_HANDLE_NULL
* represents that there is no associated local Endpoint for the
* requested connection.
*/
DAT_EP_HANDLE local_ep_handle;
} DAT_CR_PARAM;
typedef enum dat_cr_param_mask
{
DAT_CR_FIELD_REMOTE_IA_ADDRESS_PTR = 0x01,
DAT_CR_FIELD_REMOTE_PORT_QUAL = 0x02,
DAT_CR_FIELD_PRIVATE_DATA_SIZE = 0x04,
DAT_CR_FIELD_PRIVATE_DATA = 0x08,
DAT_CR_FIELD_LOCAL_EP_HANDLE = 0x10,
DAT_CR_FIELD_ALL = 0x1F
} DAT_CR_PARAM_MASK;
/************************** Events ******************************/
/* Completion status flags */
/* DTO completion status */
/* For backwards compatibility */
#define DAT_DTO_LENGTH_ERROR DAT_DTO_ERR_LOCAL_LENGTH
#define DAT_DTO_FAILURE DAT_DTO_ERR_FLUSHED
typedef enum dat_dto_completion_status
{
DAT_DTO_SUCCESS = 0,
DAT_DTO_ERR_FLUSHED = 1,
DAT_DTO_ERR_LOCAL_LENGTH = 2,
DAT_DTO_ERR_LOCAL_EP = 3,
DAT_DTO_ERR_LOCAL_PROTECTION = 4,
DAT_DTO_ERR_BAD_RESPONSE = 5,
DAT_DTO_ERR_REMOTE_ACCESS = 6,
DAT_DTO_ERR_REMOTE_RESPONDER = 7,
DAT_DTO_ERR_TRANSPORT = 8,
DAT_DTO_ERR_RECEIVER_NOT_READY = 9,
DAT_DTO_ERR_PARTIAL_PACKET = 10,
DAT_RMR_OPERATION_FAILED = 11,
DAT_DTO_ERR_LOCAL_MM_ERROR = 12 /* kdat specific */
} DAT_DTO_COMPLETION_STATUS;
/* RMR completion status */
/* For backwards compatibility */
#define DAT_RMR_BIND_SUCCESS DAT_DTO_SUCCESS
#define DAT_RMR_BIND_FAILURE DAT_DTO_ERR_FLUSHED
/* RMR completion status */
#define DAT_RMR_BIND_COMPLETION_STATUS DAT_DTO_COMPLETION_STATUS
/* Completion group structs (six total) */
/* DTO completion event data */
/* transfered_length is not defined if status is not DAT_SUCCESS */
/* invalidate_flag and rmr_context are not defined if status is not DAT_SUCCESS */
typedef struct dat_dto_completion_event_data
{
DAT_EP_HANDLE ep_handle;
DAT_DTO_COOKIE user_cookie;
DAT_DTO_COMPLETION_STATUS status;
DAT_SEG_LENGTH transfered_length;
DAT_DTOS operation;
DAT_RMR_CONTEXT rmr_context;
} DAT_DTO_COMPLETION_EVENT_DATA;
/* RMR bind completion event data */
typedef struct dat_rmr_bind_completion_event_data
{
DAT_RMR_HANDLE rmr_handle;
DAT_RMR_COOKIE user_cookie;
DAT_RMR_BIND_COMPLETION_STATUS status;
} DAT_RMR_BIND_COMPLETION_EVENT_DATA;
typedef union dat_sp_handle
{
DAT_RSP_HANDLE rsp_handle;
DAT_PSP_HANDLE psp_handle;
DAT_CSP_HANDLE csp_handle;
} DAT_SP_HANDLE;
/* Connection Request Arrival event data */
typedef struct dat_cr_arrival_event_data
{
/* Handle to the Service Point that received the Connection Request
* from the remote side. If the Service Point was Reserved, sp_handle is
* DAT_HANDLE_NULL because the reserved Service Point is
* automatically destroyed upon generating this event. Can be PSP,
* CSP, or RSP.
*/
DAT_SP_HANDLE sp_handle;
/* Address of the IA on which the Connection Request arrived. */
DAT_IA_ADDRESS_PTR local_ia_address_ptr;
/* Connection Qualifier of the IA on which the Service Point received a
* Connection Request.
*/
DAT_CONN_QUAL conn_qual;
/* The Connection Request instance created by a Provider for the
* arrived Connection Request. Consumers can find out private_data
* passed by a remote Consumer from cr_handle. It is up to a Consumer
* to dat_cr_accept or dat_cr_reject of the Connection Request.
*/
DAT_CR_HANDLE cr_handle;
/* The binary indicator whether the arrived privata data was trancated
* or not.
* The default value of 0 means not truncation of received private data. */
DAT_BOOLEAN truncate_flag;
} DAT_CR_ARRIVAL_EVENT_DATA;
/* Connection event data */
typedef struct dat_connection_event_data
{
DAT_EP_HANDLE ep_handle;
DAT_COUNT private_data_size;
DAT_PVOID private_data;
} DAT_CONNECTION_EVENT_DATA;
/* Async Error event data */
/* For unaffiliated asynchronous event dat_handle is ia_handle. For
* Endpoint affiliated asynchronous event dat_handle is ep_handle. For
* EVD affiliated asynchronous event dat_handle is evd_handle. For SRQ
* affiliated asynchronous event dat_handle is srq_handle. For Memory
* affiliated asynchronous event dat_handle is either lmr_handle,
* rmr_handle or pz_handle.
*/
typedef struct dat_asynch_error_event_data
{
DAT_HANDLE dat_handle; /* either IA, EP, EVD, SRQ, */
/* LMR, RMR, or PZ handle */
DAT_COUNT reason; /* object specific */
} DAT_ASYNCH_ERROR_EVENT_DATA;
/* The reason is object type specific and its values are defined below. */
typedef enum ia_async_error_reason
{
DAT_IA_CATASTROPHIC_ERROR,
DAT_IA_OTHER_ERROR
} DAT_IA_ASYNC_ERROR_REASON;
typedef enum ep_async_error_reason
{
DAT_EP_TRANSFER_TO_ERROR,
DAT_EP_OTHER_ERROR,
DAT_SRQ_SOFT_HIGH_WATERMARK_EVENT
} DAT_EP_ASYNC_ERROR_REASON;
typedef enum evd_async_error_reason
{
DAT_EVD_OVERFLOW_ERROR,
DAT_EVD_OTHER_ERROR
} DAT_EVD_ASYNC_ERROR_REASON;
typedef enum srq_async_error_reason
{
DAT_SRQ_TRANSFER_TO_ERROR,
DAT_SRQ_OTHER_ERROR,
DAT_SRQ_LOW_WATERMARK_EVENT
} DAT_SRQ_ASYNC_ERROR_REASON;
typedef enum lmr_async_error_reason
{
DAT_LMR_OTHER_ERROR
} DAT_LMR_ASYNC_ERROR_REASON;
typedef enum rmr_async_error_reason
{
DAT_RMR_OTHER_ERROR
} DAT_RMR_ASYNC_ERROR_REASON;
typedef enum pz_async_error_reason
{
DAT_PZ_OTHER_ERROR
} DAT_PZ_ASYNC_ERROR_REASON;
/* Software event data */
typedef struct dat_software_event_data
{
DAT_PVOID pointer;
} DAT_SOFTWARE_EVENT_DATA;
typedef enum dat_event_number
{
DAT_DTO_COMPLETION_EVENT = 0x00001,
DAT_RMR_BIND_COMPLETION_EVENT = 0x01001,
DAT_CONNECTION_REQUEST_EVENT = 0x02001,
DAT_CONNECTION_EVENT_ESTABLISHED = 0x04001,
DAT_CONNECTION_EVENT_PEER_REJECTED = 0x04002,
DAT_CONNECTION_EVENT_NON_PEER_REJECTED = 0x04003,
DAT_CONNECTION_EVENT_ACCEPT_COMPLETION_ERROR = 0x04004,
DAT_CONNECTION_EVENT_DISCONNECTED = 0x04005,
DAT_CONNECTION_EVENT_BROKEN = 0x04006,
DAT_CONNECTION_EVENT_TIMED_OUT = 0x04007,
DAT_CONNECTION_EVENT_UNREACHABLE = 0x04008,
DAT_ASYNC_ERROR_EVD_OVERFLOW = 0x08001,
DAT_ASYNC_ERROR_IA_CATASTROPHIC = 0x08002,
DAT_ASYNC_ERROR_EP_BROKEN = 0x08003,
DAT_ASYNC_ERROR_TIMED_OUT = 0x08004,
DAT_ASYNC_ERROR_PROVIDER_INTERNAL_ERROR = 0x08005,
DAT_HA_DOWN_TO_1 = 0x08101,
DAT_HA_UP_TO_MULTI_PATH = 0x08102,
DAT_SOFTWARE_EVENT = 0x10001
#ifdef DAT_EXTENSIONS
,DAT_EXTENSION_EVENT = 0x20000,
DAT_IB_EXTENSION_RANGE_BASE = 0x40000,
DAT_IW_EXTENSION_RANGE_BASE = 0x80000
#endif /* DAT_EXTENSIONS */
} DAT_EVENT_NUMBER;
/* Union for event Data */
typedef union dat_event_data
{
DAT_DTO_COMPLETION_EVENT_DATA dto_completion_event_data;
DAT_RMR_BIND_COMPLETION_EVENT_DATA rmr_completion_event_data;
DAT_CR_ARRIVAL_EVENT_DATA cr_arrival_event_data;
DAT_CONNECTION_EVENT_DATA connect_event_data;
DAT_ASYNCH_ERROR_EVENT_DATA asynch_error_event_data;
DAT_SOFTWARE_EVENT_DATA software_event_data;
} DAT_EVENT_DATA;
/* Event struct that holds all event information */
typedef struct dat_event
{
DAT_EVENT_NUMBER event_number;
DAT_EVD_HANDLE evd_handle;
DAT_EVENT_DATA event_data;
DAT_UINT64 event_extension_data[8];
} DAT_EVENT;
/* Provider/registration info */
typedef struct dat_provider_info
{
char ia_name[DAT_NAME_MAX_LENGTH];
DAT_UINT32 dapl_version_major;
DAT_UINT32 dapl_version_minor;
DAT_BOOLEAN is_thread_safe;
} DAT_PROVIDER_INFO;
/***************************************************************
*
* FUNCTION PROTOTYPES
***************************************************************/
/*
* IA functions
*
* Note that there are actual 'dat_ia_open' and 'dat_ia_close'
* functions, it is not just a re-directing #define. That is
* because the functions may have to ensure that the provider
* library is loaded before it can call it, and may choose to
* unload the library after the last close.
*/
extern DAT_RETURN DAT_API dat_ia_openv (
IN const DAT_NAME_PTR, /* provider */
IN DAT_COUNT, /* asynch_evd_min_qlen */
INOUT DAT_EVD_HANDLE *, /* asynch_evd_handle */
OUT DAT_IA_HANDLE *, /* ia_handle */
IN DAT_UINT32, /* dat major version number */
IN DAT_UINT32, /* dat minor version number */
IN DAT_BOOLEAN); /* dat thread safety */
#define dat_ia_open(name, qlen, async_evd, ia) \
dat_ia_openv((name), (qlen), (async_evd), (ia), \
DAT_VERSION_MAJOR, DAT_VERSION_MINOR, \
DAT_THREADSAFE)
extern DAT_RETURN DAT_API dat_ia_query (
IN DAT_IA_HANDLE, /* ia_handle */
OUT DAT_EVD_HANDLE *, /* async_evd_handle */
IN DAT_IA_ATTR_MASK, /* ia_attr_mask */
OUT DAT_IA_ATTR *, /* ia_attr */
IN DAT_PROVIDER_ATTR_MASK, /* provider_attr_mask */
OUT DAT_PROVIDER_ATTR * ); /* provider_attr */
extern DAT_RETURN DAT_API dat_ia_close (
IN DAT_IA_HANDLE, /* ia_handle */
IN DAT_CLOSE_FLAGS ); /* close_flags */
/* helper functions */
extern DAT_RETURN DAT_API dat_set_consumer_context (
IN DAT_HANDLE, /* dat_handle */
IN DAT_CONTEXT); /* context */
extern DAT_RETURN DAT_API dat_get_consumer_context (
IN DAT_HANDLE, /* dat_handle */
OUT DAT_CONTEXT * ); /* context */
extern DAT_RETURN DAT_API dat_get_handle_type (
IN DAT_HANDLE, /* dat_handle */
OUT DAT_HANDLE_TYPE * ); /* handle_type */
/* CR functions */
extern DAT_RETURN DAT_API dat_cr_query (
IN DAT_CR_HANDLE, /* cr_handle */
IN DAT_CR_PARAM_MASK, /* cr_param_mask */
OUT DAT_CR_PARAM * ); /* cr_param */
extern DAT_RETURN DAT_API dat_cr_accept (
IN DAT_CR_HANDLE, /* cr_handle */
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_COUNT, /* private_data_size */
IN const DAT_PVOID ); /* private_data */
extern DAT_RETURN DAT_API dat_cr_reject (
IN DAT_CR_HANDLE, /* cr_handle */
IN DAT_COUNT, /* private_data_size */
IN const DAT_PVOID ); /* private_data */
/* For DAT-1.1 and above, this function is defined for both uDAPL and
* kDAPL. For DAT-1.0, it is only defined for uDAPL.
*/
extern DAT_RETURN DAT_API dat_cr_handoff (
IN DAT_CR_HANDLE, /* cr_handle */
IN DAT_CONN_QUAL); /* handoff */
/* EVD functions */
extern DAT_RETURN DAT_API dat_evd_resize (
IN DAT_EVD_HANDLE, /* evd_handle */
IN DAT_COUNT ); /* evd_min_qlen */
extern DAT_RETURN DAT_API dat_evd_post_se (
IN DAT_EVD_HANDLE, /* evd_handle */
IN const DAT_EVENT * ); /* event */
extern DAT_RETURN DAT_API dat_evd_dequeue (
IN DAT_EVD_HANDLE, /* evd_handle */
OUT DAT_EVENT * ); /* event */
extern DAT_RETURN DAT_API dat_evd_query (
IN DAT_EVD_HANDLE, /* evd_handle */
IN DAT_EVD_PARAM_MASK, /* evd_param_mask */
OUT DAT_EVD_PARAM * ); /* evd_param */
extern DAT_RETURN DAT_API dat_evd_free (
IN DAT_EVD_HANDLE ); /* evd_handle */
/* EP functions */
extern DAT_RETURN DAT_API dat_ep_create (
IN DAT_IA_HANDLE, /* ia_handle */
IN DAT_PZ_HANDLE, /* pz_handle */
IN DAT_EVD_HANDLE, /* recv_completion_evd_handle */
IN DAT_EVD_HANDLE, /* request_completion_evd_handle */
IN DAT_EVD_HANDLE, /* connect_evd_handle */
IN const DAT_EP_ATTR *, /* ep_attributes */
OUT DAT_EP_HANDLE * ); /* ep_handle */
extern DAT_RETURN DAT_API dat_ep_query (
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_EP_PARAM_MASK, /* ep_param_mask */
OUT DAT_EP_PARAM * ); /* ep_param */
extern DAT_RETURN DAT_API dat_ep_modify (
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_EP_PARAM_MASK, /* ep_param_mask */
IN const DAT_EP_PARAM * ); /* ep_param */
extern DAT_RETURN DAT_API dat_ep_connect (
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_IA_ADDRESS_PTR, /* remote_ia_address */
IN DAT_CONN_QUAL, /* remote_conn_qual */
IN DAT_TIMEOUT, /* timeout */
IN DAT_COUNT, /* private_data_size */
IN const DAT_PVOID, /* private_data */
IN DAT_QOS, /* quality_of_service */
IN DAT_CONNECT_FLAGS ); /* connect_flags */
extern DAT_RETURN DAT_API dat_ep_dup_connect (
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_EP_HANDLE, /* ep_dup_handle */
IN DAT_TIMEOUT, /* timeout */
IN DAT_COUNT, /* private_data_size */
IN const DAT_PVOID, /* private_data */
IN DAT_QOS); /* quality_of_service */
extern DAT_RETURN DAT_API dat_ep_common_connect (
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_IA_ADDRESS_PTR, /* remote_ia_address */
IN DAT_TIMEOUT, /* timeout */
IN DAT_COUNT, /* private_data_size */
IN const DAT_PVOID ); /* private_data */
extern DAT_RETURN DAT_API dat_ep_disconnect (
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_CLOSE_FLAGS ); /* close_flags */
extern DAT_RETURN DAT_API dat_ep_post_send (
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_COUNT, /* num_segments */
IN DAT_LMR_TRIPLET *, /* local_iov */
IN DAT_DTO_COOKIE, /* user_cookie */
IN DAT_COMPLETION_FLAGS ); /* completion_flags */
extern DAT_RETURN DAT_API dat_ep_post_send_with_invalidate (
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_COUNT, /* num_segments */
IN DAT_LMR_TRIPLET *, /* local_iov */
IN DAT_DTO_COOKIE, /* user_cookie */
IN DAT_COMPLETION_FLAGS, /* completion_flags */
IN DAT_BOOLEAN, /* invalidate_flag */
IN DAT_RMR_CONTEXT ); /* RMR to invalidate */
extern DAT_RETURN DAT_API dat_ep_post_recv (
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_COUNT, /* num_segments */
IN DAT_LMR_TRIPLET *, /* local_iov */
IN DAT_DTO_COOKIE, /* user_cookie */
IN DAT_COMPLETION_FLAGS ); /* completion_flags */
extern DAT_RETURN DAT_API dat_ep_post_rdma_read (
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_COUNT, /* num_segments */
IN DAT_LMR_TRIPLET *, /* local_iov */
IN DAT_DTO_COOKIE, /* user_cookie */
IN const DAT_RMR_TRIPLET *,/* remote_iov */
IN DAT_COMPLETION_FLAGS ); /* completion_flags */
extern DAT_RETURN DAT_API dat_ep_post_rdma_read_to_rmr (
IN DAT_EP_HANDLE, /* ep_handle */
IN const DAT_RMR_TRIPLET *, /* local_iov */
IN DAT_DTO_COOKIE, /* user_cookie */
IN const DAT_RMR_TRIPLET *,/* remote_iov */
IN DAT_COMPLETION_FLAGS ); /* completion_flags */
extern DAT_RETURN DAT_API dat_ep_post_rdma_write (
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_COUNT, /* num_segments */
IN DAT_LMR_TRIPLET *, /* local_iov */
IN DAT_DTO_COOKIE, /* user_cookie */
IN const DAT_RMR_TRIPLET *,/* remote_iov */
IN DAT_COMPLETION_FLAGS ); /* completion_flags */
extern DAT_RETURN DAT_API dat_ep_get_status (
IN DAT_EP_HANDLE, /* ep_handle */
OUT DAT_EP_STATE *, /* ep_state */
OUT DAT_BOOLEAN *, /* recv_idle */
OUT DAT_BOOLEAN * ); /* request_idle */
extern DAT_RETURN DAT_API dat_ep_free (
IN DAT_EP_HANDLE); /* ep_handle */
extern DAT_RETURN DAT_API dat_ep_reset (
IN DAT_EP_HANDLE); /* ep_handle */
extern DAT_RETURN DAT_API dat_ep_create_with_srq (
IN DAT_IA_HANDLE, /* ia_handle */
IN DAT_PZ_HANDLE, /* pz_handle */
IN DAT_EVD_HANDLE, /* recv_evd_handle */
IN DAT_EVD_HANDLE, /* request_evd_handle */
IN DAT_EVD_HANDLE, /* connect_evd_handle */
IN DAT_SRQ_HANDLE, /* srq_handle */
IN const DAT_EP_ATTR *, /* ep_attributes */
OUT DAT_EP_HANDLE *); /* ep_handle */
extern DAT_RETURN DAT_API dat_ep_recv_query (
IN DAT_EP_HANDLE, /* ep_handle */
OUT DAT_COUNT *, /* nbufs_allocated */
OUT DAT_COUNT *); /* bufs_alloc_span */
extern DAT_RETURN DAT_API dat_ep_set_watermark (
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_COUNT, /* soft_high_watermark */
IN DAT_COUNT); /* hard_high_watermark */
/* LMR functions */
extern DAT_RETURN DAT_API dat_lmr_free (
IN DAT_LMR_HANDLE); /* lmr_handle */
/* Non-coherent memory functions */
extern DAT_RETURN DAT_API dat_lmr_sync_rdma_read (
IN DAT_IA_HANDLE, /* ia_handle */
IN const DAT_LMR_TRIPLET *, /* local_segments */
IN DAT_VLEN); /* num_segments */
extern DAT_RETURN DAT_API dat_lmr_sync_rdma_write (
IN DAT_IA_HANDLE, /* ia_handle */
IN const DAT_LMR_TRIPLET *, /* local_segments */
IN DAT_VLEN); /* num_segments */
/* RMR functions */
extern DAT_RETURN DAT_API dat_rmr_create (
IN DAT_PZ_HANDLE, /* pz_handle */
OUT DAT_RMR_HANDLE *); /* rmr_handle */
extern DAT_RETURN DAT_API dat_rmr_create_for_ep (
IN DAT_PZ_HANDLE, /* pz_handle */
OUT DAT_RMR_HANDLE *); /* rmr_handle */
extern DAT_RETURN DAT_API dat_rmr_query (
IN DAT_RMR_HANDLE, /* rmr_handle */
IN DAT_RMR_PARAM_MASK, /* rmr_param_mask */
OUT DAT_RMR_PARAM *); /* rmr_param */
extern DAT_RETURN DAT_API dat_rmr_bind (
IN DAT_RMR_HANDLE, /* rmr_handle */
IN DAT_LMR_HANDLE, /* lmr_handle */
IN const DAT_LMR_TRIPLET *,/* lmr_triplet */
IN DAT_MEM_PRIV_FLAGS, /* mem_priv */
IN DAT_VA_TYPE, /* va_type */
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_RMR_COOKIE, /* user_cookie */
IN DAT_COMPLETION_FLAGS, /* completion_flags */
OUT DAT_RMR_CONTEXT * ); /* context */
extern DAT_RETURN DAT_API dat_rmr_free (
IN DAT_RMR_HANDLE); /* rmr_handle */
/* PSP functions */
extern DAT_RETURN DAT_API dat_psp_create (
IN DAT_IA_HANDLE, /* ia_handle */
IN DAT_CONN_QUAL, /* conn_qual */
IN DAT_EVD_HANDLE, /* evd_handle */
IN DAT_PSP_FLAGS, /* psp_flags */
OUT DAT_PSP_HANDLE * ); /* psp_handle */
extern DAT_RETURN DAT_API dat_psp_create_any (
IN DAT_IA_HANDLE, /* ia_handle */
OUT DAT_CONN_QUAL *, /* conn_qual */
IN DAT_EVD_HANDLE, /* evd_handle */
IN DAT_PSP_FLAGS, /* psp_flags */
OUT DAT_PSP_HANDLE * ); /* psp_handle */
extern DAT_RETURN DAT_API dat_psp_query (
IN DAT_PSP_HANDLE, /* psp_handle */
IN DAT_PSP_PARAM_MASK, /* psp_param_mask */
OUT DAT_PSP_PARAM * ); /* psp_param */
extern DAT_RETURN DAT_API dat_psp_free (
IN DAT_PSP_HANDLE ); /* psp_handle */
/* RSP functions */
extern DAT_RETURN DAT_API dat_rsp_create (
IN DAT_IA_HANDLE, /* ia_handle */
IN DAT_CONN_QUAL, /* conn_qual */
IN DAT_EP_HANDLE, /* ep_handle */
IN DAT_EVD_HANDLE, /* evd_handle */
OUT DAT_RSP_HANDLE * ); /* rsp_handle */
extern DAT_RETURN DAT_API dat_rsp_query (
IN DAT_RSP_HANDLE, /* rsp_handle */
IN DAT_RSP_PARAM_MASK, /* rsp_param_mask */
OUT DAT_RSP_PARAM * ); /* rsp_param */
extern DAT_RETURN DAT_API dat_rsp_free (
IN DAT_RSP_HANDLE ); /* rsp_handle */
/* CSP functions */
extern DAT_RETURN DAT_API dat_csp_create (
IN DAT_IA_HANDLE, /* ia_handle */
IN DAT_COMM *, /* communicator */
IN DAT_IA_ADDRESS_PTR, /* address */
IN DAT_EVD_HANDLE, /* evd_handle */
OUT DAT_CSP_HANDLE * ); /* csp_handle */
extern DAT_RETURN DAT_API dat_csp_query (
IN DAT_CSP_HANDLE, /* csp_handle */
IN DAT_CSP_PARAM_MASK, /* csp_param_mask */
OUT DAT_CSP_PARAM * ); /* csp_param */
extern DAT_RETURN DAT_API dat_csp_free (
IN DAT_CSP_HANDLE ); /* csp_handle */
/* PZ functions */
extern DAT_RETURN DAT_API dat_pz_create (
IN DAT_IA_HANDLE, /* ia_handle */
OUT DAT_PZ_HANDLE * ); /* pz_handle */
extern DAT_RETURN DAT_API dat_pz_query (
IN DAT_PZ_HANDLE, /* pz_handle */
IN DAT_PZ_PARAM_MASK, /* pz_param_mask */
OUT DAT_PZ_PARAM *); /* pz_param */
extern DAT_RETURN DAT_API dat_pz_free (
IN DAT_PZ_HANDLE ); /* pz_handle */
/* SRQ functions */
extern DAT_RETURN DAT_API dat_srq_create (
IN DAT_IA_HANDLE, /* ia_handle */
IN DAT_PZ_HANDLE, /* pz_handle */
IN DAT_SRQ_ATTR *, /* srq_attr */
OUT DAT_SRQ_HANDLE *); /* srq_handle */
extern DAT_RETURN DAT_API dat_srq_free (
IN DAT_SRQ_HANDLE); /* srq_handle */
extern DAT_RETURN DAT_API dat_srq_post_recv (
IN DAT_SRQ_HANDLE, /* srq_handle */
IN DAT_COUNT, /* num_segments */
IN DAT_LMR_TRIPLET *, /* local_iov */
IN DAT_DTO_COOKIE); /* user_cookie */
extern DAT_RETURN DAT_API dat_srq_query (
IN DAT_SRQ_HANDLE, /* srq_handle */
IN DAT_SRQ_PARAM_MASK, /* srq_param_mask */
OUT DAT_SRQ_PARAM *); /* srq_param */
extern DAT_RETURN DAT_API dat_srq_resize (
IN DAT_SRQ_HANDLE, /* srq_handle */
IN DAT_COUNT); /* srq_max_recv_dto */
extern DAT_RETURN DAT_API dat_srq_set_lw (
IN DAT_SRQ_HANDLE, /* srq_handle */
IN DAT_COUNT); /* low_watermark */
#ifdef DAT_EXTENSIONS
#define DAT_OPEN_EXTENSION_BASE 0x1000
#define DAT_CLOSE_EXTENSION_BASE 0x2000
typedef int DAT_EXTENDED_OP;
extern DAT_RETURN DAT_API dat_extension_op(
IN DAT_HANDLE, /* handle */
IN DAT_EXTENDED_OP, /* operation */
IN ... ); /* args */
#endif
/*
* DAT registry functions.
*
* Note the dat_ia_open and dat_ia_close functions are linked to
* registration code which "redirects" to the appropriate provider.
*/
extern DAT_RETURN DAT_API dat_registry_list_providers (
IN DAT_COUNT, /* max_to_return */
OUT DAT_COUNT *, /* entries_returned */
OUT DAT_PROVIDER_INFO *(dat_provider_list[]) ); /* dat_provider_list */
/*
* DAT error functions.
*/
extern DAT_RETURN DAT_API dat_strerror (
IN DAT_RETURN, /* dat function return */
OUT const char ** , /* major message string */
OUT const char ** ); /* minor message string */
#ifdef __cplusplus
}
#endif
#endif /* _DAT_H_ */
|