[DAT/DAPL] Discussions about DAT v2.0 support and building DAT 2.0 applications.
authorstansmith <stansmith@ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86>
Wed, 19 Sep 2007 20:50:32 +0000 (20:50 +0000)
committerstansmith <stansmith@ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86>
Wed, 19 Sep 2007 20:50:32 +0000 (20:50 +0000)
git-svn-id: svn://openib.tc.cornell.edu/gen1/trunk@820 ad392aa1-c5ef-ae45-8dd8-e69d62a5ef86

docs/Manual.htm

index 3f58fe8..c791175 100644 (file)
@@ -15,7 +15,7 @@ div.Section1
 <h1 align="center">User's Manual</h1>\r
 <h2 align="center">Release 1.0.1</h2>\r
 <h3 align="center">\r
-<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%m/%d/%Y" startspan -->09/07/2007<!--webbot bot="Timestamp" endspan i-checksum="12620" --></h3>\r
+<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%m/%d/%Y" startspan -->09/19/2007<!--webbot bot="Timestamp" endspan i-checksum="12660" --></h3>\r
 <h2 align="left"><u>Overview</u></h2>\r
 <p align="left"><span style="FONT-SIZE: 12pt; FONT-FAMILY: 'Times New Roman'">\r
 The Windows OpenFabrics (WinOF) package is composed of software modules intended \r
@@ -1065,7 +1065,7 @@ Manual control is performed via the \Program Files\WinOF\installsp.exe utility.<
 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
 <p align="left">&nbsp;</p>\r
 <p align="left">&nbsp;</p>\r
-<h2 align="left"><a name="DAT"></a>Direct Access Transport and usermode Direct Access Programming \r
+<h2 align="left"><a name="DAT"></a>Usermode Direct Access Transport and Direct Access Programming \r
 Libraries</h2>\r
 <hr>\r
 <p align="left"><font face="Times New Roman">The DAT (Direct Access Transport) \r
@@ -1075,9 +1075,13 @@ order provide a set of transport-independent, platform-independent Application
 Programming Interfaces that exploit the RDMA (remote direct memory access) \r
 capabilities of next-generation interconnect technologies such as InfiniBand, \r
 and iWARP.</font></p>\r
-<p align="left">WinOF DAT and uDAPL are based on the 1.1 DAT specification. The DAPL \r
-(Direct Access Provider Library) now fully supports Infiniband RDMA and \r
-IPoIB.</p>\r
+<p align="left"><font face="Times New Roman">WinOF DAT and DAPL are based on the 1.1 DAT specification. The DAPL \r
+(Direct Access Provider Library) which now fully supports Infiniband RDMA and \r
+IPoIB.</font></p>\r
+<p align="left"><font face="Times New Roman">WinOF 1.0.1, and future WinOF \r
+releases, include DAT/DAPL version 2.0 runtime libraries along with an optional \r
+v2.0 application build environment.<br>\r
+&nbsp;</font></p>\r
 <div id="tiki-main0">\r
        <div id="tiki-mid0">\r
                <table id="table3" cellSpacing="0" cellPadding="0" border="0">\r
@@ -1147,19 +1151,36 @@ IPoIB.</p>
        <h3 align="left"><font face="Courier New" size="3">DAT ENVIRONMENT</font><font face="Courier New" size="2">:</font></h3>\r
 </div>\r
 <blockquote>\r
+       <p align="left"><font face="Courier New" size="2">DAT/DAPL v1.1 (free-build) \r
+       runtime libraries are installed into %SystemRoot%, with the v1.1 Debug \r
+       versions located in '%SystemDrive%\%ProgramFiles(x86)%\WinOF'.&nbsp; Debug \r
+       libraries are identified as datd.dll and dapld.dll.</font></p>\r
+       <p align="left"><font face="Courier New" size="2">IA32 (aka, 32-bit) \r
+       versions of DAT/DAPL 1.1 runtime libraries, found only on 64-bit systems, \r
+       are identified in '%SystemDrive%\%ProgramFiles(x86)%\WinOF' as dat32.dll and \r
+       dapl32.dll.<br>\r
+       <br>\r
+       DAT/DAPL 2.0 (free-build) libraries are identified in %SystemRoot% as \r
+       dat2.dll and dapl2.dll.&nbsp; Debug versions of the v2.0 runtime libraries \r
+       are located in '%SystemDrive%\%ProgramFiles(x86)%\WinOF'.</font></p>\r
+       <p align="left"><font face="Courier New" size="2">IA32 (aka, 32-bit) \r
+       versions of DAT/DAPL 2.0 runtime libraries, found only on 64-bit systems, \r
+       are identified in '%SystemDrive%\%ProgramFiles(x86)%\WinOF' as dat232.dll \r
+       and dapl232.dll.</font></p>\r
        <p align="left"><font face="Courier New" size="2">In order for DAT/uDAPL \r
-       programs to execute correctly, the 'dat.dll' file must be present in the \r
-       current directory,\r
-       %SystemRoot%\system32, %SystemRoot% or in the library search path.</font></p>\r
+       programs to execute correctly, the runtime library files 'dat.dll and \r
+       dapl.dll' must be present in one of the following folders: current \r
+       directory, %SystemRoot% or in the library search path.</font></p>\r
        <p align="left"><font face="Courier New" size="2">The default WinOF \r
-       installation places the file dat.dll in the '%SystemRoot%' folder.</font></p>\r
-       <p align="left"><font face="Courier New" size="2">The DAPL configuration \r
-       file by default is defined as '%SystemDrive%\DAT\dat.conf'. This default \r
+       installation places the runtime library files dat.dll and dapl.dll in the '%SystemRoot%' folder; \r
+       symbol files (.pdb) are located in '%SystemDrive%\%ProgramFiles(x86)%\WinOF'.</font></p>\r
+       <p align="left"><font face="Courier New" size="2">The default DAPL configuration \r
+       file is defined as '%SystemDrive%\DAT\dat.conf'. This default \r
        specification can be overriden by use of the environment variable \r
        DAT_OVERRIDE; see following environment variable discussion.</font></p>\r
        <p align="left"><font face="Courier New" size="2">Within the dat.conf file, \r
        the DAPL library specification can be located as the 5th whitespace \r
-       separated line argument. By default the DAPL library file is installed as<br>\r
+       separated line argument. By default the DAPL library file is installed as\r
        '%SystemRoot%\dapl.dll'.</font></p>\r
        <p align="left"><font face="Courier New" size="2">Should you choose to \r
        relocated the DAPL library file to a path where whitespace appears in the \r
@@ -1171,16 +1192,17 @@ IPoIB.</p>
        double-quotes\r
        (e.g., &quot;C:\\Programs Files\\WinOF\\dapl.dll&quot;).</font></p>\r
        <p align="left"><font face="Courier New" size="2">A sample InfiniBand dat.conf file is \r
-       installed as '\Program Files\WinOF\dat.conf '.&nbsp; If dat.conf does not \r
+       installed as '\Program Files\WinOF\dat.conf'.&nbsp; If dat.conf does not \r
        exist in the DAT default configuration folder '%SystemDrive%\DAT\', dat.conf \r
-       will be copied there.</font></p>\r
+       will be copied there.<br>\r
+&nbsp;</font></p>\r
        <p align="left"><b>\r
 <u><a name="DAT_App_Build"></a>DAT application build environment</u>:</b></p>\r
        <p align="left"><font face="Courier New" size="2">DAT library header files \r
        are selectively installed in the DAT default configuration folder as<br>'%SystemDrive%\DAT\v1-1' \r
        or\r
        '%SystemDrive%\DAT\v2-0'. Your C language based DAT 1.1 application compilation command line \r
-       should include'/I%SystemDrive%\DAT\v1-1' with C code referencing '#include &lt;DAT\dat.h&gt;'.<br>\r
+       should include'/I%SystemDrive%\DAT\v1-1' with C code referencing '#include &lt;DAT\udat.h&gt;'.<br>\r
        <br>\r
        Visual Studio 2005 command window - (nmake) Makefile Fragments:</font></p>\r
        <blockquote>\r
@@ -1197,7 +1219,9 @@ IPoIB.</p>
                LIBS = ws2_32.lib advapi32.lib User32.lib bufferoverflowU.lib dat.lib<br>\r
                <br>\r
                LINK_FLAGS = /nologo /subsystem:console /machine:X64 \r
-               /libpath:$(DAT_PATH) $(LIBS)</font><b><br>&nbsp;</b></p>\r
+               /libpath:$(DAT_PATH) $(LIBS)</font><b><br><br>\r
+               </b>When linking a DEBUG/Checked version make sure to use datd.lib or \r
+               dat2d.lib for DAT v2.0.</p>\r
        </blockquote>\r
        <h4>\r
 <u>DAT library environment variables</u>:<br>\r