share/man/man3lib/libdat.3lib

   1 '\" te
   2 .\" Copyright (c) 2004, Sun Microsystems, Inc.  All rights reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH LIBDAT 3LIB "Jul 16, 2004"
   7 .SH NAME
   8 libdat \- direct access transport library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-ldat\fR [ \fIlibrary\fR... ]
  13 #include <\fBdat/udat.h\fR>
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The libdat library provides an application with the User Direct Access
  20 Programming Library (uDAPL) 1.2 functions to access the underlying RDMA-able
  21 interconnects. Different uDAPL service providers listed in the DAT static
  22 registry \fBdat.conf\fR(4) can be registered during runtime with the DAT
  23 library. After an application opens an interface adapter belonging to a
  24 particular service provider, all function calls will be redirected to that
  25 service provider's library.
  26 .SH INTERFACES
  27 .sp
  28 .LP
  29 The shared object \fBlibdat.so.1\fR provides the public interfaces defined
  30 below for applications. See \fBIntro\fR(3) for additional information on shared
  31 object interfaces.
  32 .SS "uDAPL 1.1"
  33 .sp
  34
  35 .sp
  36 .TS
  37 l l
  38 l l .
  39 \fBdat_cno_create\fR    \fBdat_cno_free\fR
  40 \fBdat_cno_modify_agent\fR      \fBdat_cno_query\fR
  41 \fBdat_cno_wait\fR      \fBdat_cr_accept\fR
  42 \fBdat_cr_handoff\fR    \fBdat_cr_query\fR
  43 \fBdat_cr_reject\fR     \fBdat_ep_connect\fR
  44 \fBdat_ep_create\fR     \fBdat_ep_disconnect\fR
  45 \fBdat_ep_dup_connect\fR        \fBdat_ep_free\fR
  46 \fBdat_ep_get_status\fR \fBdat_ep_modify\fR
  47 \fBdat_ep_post_rdma_read\fR     \fBdat_ep_post_rdma_write\fR
  48 \fBdat_ep_post_recv\fR  \fBdat_ep_post_send\fR
  49 \fBdat_ep_query\fR      \fBdat_ep_reset\fR
  50 \fBdat_evd_clear_unwaitable\fR  \fBdat_evd_create\fR
  51 \fBdat_evd_dequeue\fR   \fBdat_evd_disable\fR
  52 \fBdat_evd_enable\fR    \fBdat_evd_free\fR
  53 \fBdat_evd_modify_cno\fR        \fBdat_evd_post_se\fR
  54 \fBdat_evd_query\fR     \fBdat_evd_resize\fR
  55 \fBdat_evd_set_unwaitable\fR    \fBdat_evd_wait\fR
  56 \fBdat_get_consumer_context\fR  \fBdat_get_handle_type\fR
  57 \fBdat_ia_close\fR      \fBdat_ia_open\fR
  58 \fBdat_ia_query\fR      \fBdat_lmr_create\fR
  59 \fBdat_lmr_free\fR      \fBdat_lmr_query\fR
  60 \fBdat_provider_fini\fR \fBdat_provider_init\fR
  61 \fBdat_psp_create\fR    \fBdat_psp_create_any\fR
  62 \fBdat_psp_free\fR      \fBdat_psp_query\fR
  63 \fBdat_pz_create\fR     \fBdat_pz_free\fR
  64 \fBdat_pz_query\fR      \fBdat_registry_list_providers\fR
  65 \fBdat_rmr_bind\fR      \fBdat_rmr_create\fR
  66 \fBdat_rmr_free\fR      \fBdat_rmr_query\fR
  67 \fBdat_rsp_create\fR    \fBdat_rsp_free\fR
  68 \fBdat_rsp_query\fR     \fBdat_set_consumer_context\fR
  69 \fBdat_strerror\fR
  70 .TE
  71
  72 .SS "uDAPL 1.2"
  73 .sp
  74
  75 .sp
  76 .TS
  77 l l
  78 l l .
  79 \fBdat_ep_create_with_srq\fR    \fBdat_ep_recv_query\fR
  80 \fBdat_ep_set_watermark\fR      \fBdat_lmr_sync_rdma_read\fR
  81 \fBdat_lmr_sync_rdma_write\fR   \fBdat_srq_create\fR
  82 \fBdat_srq_free\fR      \fBdat_srq_post_recv\fR
  83 \fBdat_srq_query\fR     \fBdat_srq_resize\fR
  84 \fBdat_srq_set_lw\fR
  85 .TE
  86
  87 .sp
  88 .LP
  89 The shared object \fBlibdat.so.1\fR also provides the public interfaces defined
  90 below for service providers.
  91 .sp
  92
  93 .sp
  94 .TS
  95 l l .
  96 dat_registry_add_provider       \fBdat_registry_remove_provider\fR
  97 .TE
  98
  99 .SH FILES
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fB/usr/lib/libdat.so.1\fR\fR
 104 .ad
 105 .RS 27n
 106 shared object
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fB/usr/lib/64/libdat.so.1\fR\fR
 113 .ad
 114 .RS 27n
 115 64-bit shared object
 116 .RE
 117
 118 .SH ATTRIBUTES
 119 .sp
 120 .LP
 121 See \fBattributes\fR(5) for descriptions of the following attributes:
 122 .sp
 123
 124 .sp
 125 .TS
 126 box;
 127 c | c
 128 l | l .
 129 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 130 _
 131 Interface Stability     Standard: uDAPL, 1.1, 1.2
 132 _
 133 MT-Level        Unsafe
 134 .TE
 135
 136 .SH SEE ALSO
 137 .sp
 138 .LP
 139 \fBdatadm\fR(8), \fBIntro\fR(3), \fBdat.conf\fR(4), \fBattributes\fR(5)
 140 .SH NOTES
 141 .sp
 142 .LP
 143 The \fBlibdat\fR library supports service providers written according to the
 144 uDAPL 1.2 specification. A service provider library has to be a dynamic
 145 loadable shared object with two public entry points exported:
 146 .sp
 147
 148 .sp
 149 .TS
 150 l l .
 151 \fBdat_provider_init\fR \fBdat_provider_fini\fR
 152 .TE
 153
 154 .sp
 155 .LP
 156 In terms of installation, the service provider package should include a
 157 \fBservice_provider.conf\fR(4) file. The \fBdatadm\fR(8) administrative
 158 configuration program should be used to add and remove service provider's
 159 entries in the system-wide \fBdat.conf\fR(4).