xref: /illumos-gate/usr/src/man/man3lib/libdat.3lib (revision cd964fce751ca752af4158842063a9579a2d4331)
te
Copyright (c) 2004, Sun Microsystems, Inc. All rights reserved.
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.
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.
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]
LIBDAT 3LIB "Jul 16, 2004"
NAME
libdat - direct access transport library
SYNOPSIS

cc [ flag... ] file... -ldat [ library... ]
#include <dat/udat.h>
DESCRIPTION

The libdat library provides an application with the User Direct Access Programming Library (uDAPL) 1.2 functions to access the underlying RDMA-able interconnects. Different uDAPL service providers listed in the DAT static registry dat.conf(4) can be registered during runtime with the DAT library. After an application opens an interface adapter belonging to a particular service provider, all function calls will be redirected to that service provider's library.

INTERFACES

The shared object libdat.so.1 provides the public interfaces defined below for applications. See Intro(3) for additional information on shared object interfaces.

"uDAPL 1.1"
dat_cno_create dat_cno_free
dat_cno_modify_agent dat_cno_query
dat_cno_wait dat_cr_accept
dat_cr_handoff dat_cr_query
dat_cr_reject dat_ep_connect
dat_ep_create dat_ep_disconnect
dat_ep_dup_connect dat_ep_free
dat_ep_get_status dat_ep_modify
dat_ep_post_rdma_read dat_ep_post_rdma_write
dat_ep_post_recv dat_ep_post_send
dat_ep_query dat_ep_reset
dat_evd_clear_unwaitable dat_evd_create
dat_evd_dequeue dat_evd_disable
dat_evd_enable dat_evd_free
dat_evd_modify_cno dat_evd_post_se
dat_evd_query dat_evd_resize
dat_evd_set_unwaitable dat_evd_wait
dat_get_consumer_context dat_get_handle_type
dat_ia_close dat_ia_open
dat_ia_query dat_lmr_create
dat_lmr_free dat_lmr_query
dat_provider_fini dat_provider_init
dat_psp_create dat_psp_create_any
dat_psp_free dat_psp_query
dat_pz_create dat_pz_free
dat_pz_query dat_registry_list_providers
dat_rmr_bind dat_rmr_create
dat_rmr_free dat_rmr_query
dat_rsp_create dat_rsp_free
dat_rsp_query dat_set_consumer_context
dat_strerror
"uDAPL 1.2"
dat_ep_create_with_srq dat_ep_recv_query
dat_ep_set_watermark dat_lmr_sync_rdma_read
dat_lmr_sync_rdma_write dat_srq_create
dat_srq_free dat_srq_post_recv
dat_srq_query dat_srq_resize
dat_srq_set_lw

The shared object libdat.so.1 also provides the public interfaces defined below for service providers.

dat_registry_add_provider dat_registry_remove_provider
FILES
/usr/lib/libdat.so.1

shared object

/usr/lib/64/libdat.so.1

64-bit shared object

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard: uDAPL, 1.1, 1.2
MT-Level Unsafe
SEE ALSO

datadm(1M), Intro(3), dat.conf(4), attributes(5)

NOTES

The libdat library supports service providers written according to the uDAPL 1.2 specification. A service provider library has to be a dynamic loadable shared object with two public entry points exported:

dat_provider_init dat_provider_fini

In terms of installation, the service provider package should include a service_provider.conf(4) file. The datadm(1M) administrative configuration program should be used to add and remove service provider's entries in the system-wide dat.conf(4).