usr/src/man/man4/dat.conf.4

   1 '\" te
   2 .\" Copyright (c) 2003, 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 DAT.CONF 4 "Jun 18, 2004"
   7 .SH NAME
   8 dat.conf \- DAT static registry
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/etc/dat/dat.conf\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The DAT static registry, \fB/etc/dat/dat.conf\fR is a system-wide data resource
  19 maintained by the system administrative command \fBdatadm\fR(1M).
  20 .sp
  21 .LP
  22 \fB/etc/dat/dat.conf\fR contains a list of interface adapters supported by
  23 uDAPL service providers. An interface adapter on Infiniband (IB) corresponds to
  24 an IPoIB device instance, for example, \fBibd0\fR. An IPoIB device name
  25 represents an IP interface plumbed by \fBifconfig\fR(1M) on an IB
  26 partition/Host Channel Adapter port combination.
  27 .sp
  28 .LP
  29 Each entry in the DAT static registry is a single line that contains eight
  30 fields. Fields are separated by a SPACE. Lines that begin with a pound sign
  31 (\fB#\fR) are considered comments. All characters that follow the \fB#\fR are
  32 ignored. Enclose Solaris specific strings (\fISolaris_specific_string\fR) and
  33 service provider's instance data (\fIservice _provider_instance_data\fR) in
  34 quotes.
  35 .sp
  36 .LP
  37 The following shows the order of the fields in a \fBdat.conf\fR entry:
  38 .sp
  39 .in +2
  40 .nf
  41 "\fIinterface_adapter_name\fR" "\fIAPI_version\fR" "\fIthreadsafe\fR | \fInonthreadsafe\fR" \e
  42 "\fIdefault\fR | \fInondefault\fR" "\fIservice_provider_library_pathname\fR" \e
  43 "\fIservice_provider_version\fR" "\fIservice _provider_instance_data\fR"\e
  44 "\fISolaris_specific_string\fR"
  45 .fi
  46 .in -2
  47
  48 .sp
  49 .LP
  50 The fields are defined as follows:
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fIinterface_adapter_name\fR\fR
  55 .ad
  56 .sp .6
  57 .RS 4n
  58 Specifies the Interface Adapter (IA) name. In IB, this is the IPoIB device
  59 instance name, for example, \fBibd0\fR. This represents an IP interface plumbed
  60 on an IB partition/port combination of the HCA.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fIAPI_version\fR\fR
  67 .ad
  68 .sp .6
  69 .RS 4n
  70 Specifies the API version of the service provide library: For example,
  71 \fB"u"major.minor\fR is \fBu1.2\fR.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fIthreadsafe\fR | \fInonthreadsafe\fR\fR
  78 .ad
  79 .sp .6
  80 .RS 4n
  81 Specifies a threadsafe or non-threadsafe library.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fIdefault\fR | \fInondefault\fR\fR
  88 .ad
  89 .sp .6
  90 .RS 4n
  91 Specifies a default or non-default version of library. A service provider can
  92 offer several versions of the library. If so, one version is designated as
  93 \fBdefault\fR with the rest as \fBnondefault\fR.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fIservice_provider_library_pathname\fR\fR
 100 .ad
 101 .sp .6
 102 .RS 4n
 103 Specifies the pathname of the library image.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fIservice_provider_version\fR\fR
 110 .ad
 111 .sp .6
 112 .RS 4n
 113 Specifies the version of the service provider. By convention, specify the
 114 company stock symbol as the service provider, followed by major and minor
 115 version numbers, for example, \fBSUNW1.0\fR.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fIservice _provider_instance_data\fR\fR
 122 .ad
 123 .sp .6
 124 .RS 4n
 125 Specifies the service provider instance data.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fISolaris_specific_string\fR\fR
 132 .ad
 133 .sp .6
 134 .RS 4n
 135 Specifies a platform specific string, for example, the device name in the
 136 \fBservice_provider.conf\fR file.
 137 .RE
 138
 139 .SH EXAMPLES
 140 .LP
 141 \fBExample 1 \fRSample \fBdat.conf\fR File
 142 .sp
 143 .LP
 144 The following \fBdat.conf\fR file shows a \fBuDAPL 1.2\fR service provider for
 145 \fBtavor, udapl_tavor.so.1\fR supporting two interfaces, \fBibd0\fR and
 146 \fBibd1\fR:
 147
 148 .sp
 149 .in +2
 150 .nf
 151 #
 152 # dat.conf for uDAPL 1.2
 153 #
 154 ibd0 u1.2 nonthreadsafe default udapl_tavor.so.1 SUNW.1.0 ""
 155 "driver_name=tavor"
 156 ibd1 u1.2 nonthreadsafe default udapl_tavor.so.1 SUNW.1.0 ""
 157 "driver_name=tavor"
 158 .fi
 159 .in -2
 160
 161 .SH ATTRIBUTES
 162 .sp
 163 .LP
 164 See \fBattributes\fR(5) for descriptions of the following attributes:
 165 .sp
 166
 167 .sp
 168 .TS
 169 box;
 170 c | c
 171 l | l .
 172 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 173 _
 174 Interface Stability     Standard
 175 .TE
 176
 177 .SH SEE ALSO
 178 .sp
 179 .LP
 180 \fBdatadm\fR(1M), \fBifconfig\fR(1M), \fBlibdat\fR(3LIB),
 181 \fBservice_provider.conf\fR(4), \fBattributes\fR(5)
 182 .SH NOTES
 183 .sp
 184 .LP
 185 An empty \fBdat.conf\fR is created during the package \fBSUNWudaplr\fR
 186 installation if no file is present beforehand. Entries in the file are added or
 187 removed by running \fBdatadm\fR(1M).
 188 .sp
 189 .LP
 190 The content of the platform specific string does not constitute an API. It is
 191 generated by \fBdatadm\fR(1M) and might have a different content or
 192 interpretation in a future release.