<h1 align="center">User's Manual</h1>\r
<h2 align="center">Release 1.0</h2>\r
<h3 align="center">\r
-<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%m/%d/%Y" startspan -->06/27/2007<!--webbot bot="Timestamp" endspan i-checksum="12630" --></h3>\r
+<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%m/%d/%Y" startspan -->07/12/2007<!--webbot bot="Timestamp" endspan i-checksum="12544" --></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
</ul>\r
<h3 align="left"> </h3>\r
<p align="left"> </p>\r
-<hr>\r
<p align="left"> </p>\r
-<h2 align="left"><a name="verbs_benchmarks"></a>User mode verbs micro-benchmarks<br>\r
- </h2>\r
-<p align="left">These micro-benchmarks tests are intended as useful benchmarks for HW or SW \r
+<h2 align="left"><a name="verbs_benchmarks"></a>User mode micro-benchmarks</h2>\r
+<hr>\r
+<p align="left">The following user-mode test programs are intended as useful \r
+micro-benchmarks for HW or SW \r
tuning and/or functional testing.</p>\r
<blockquote>\r
<p align="left">Tests use CPU cycle counters to get time stamps without \r
<p align="left"><br>\r
</p>\r
<h4 align="left"><a name="ttcp"></a>ttcp - Test TCP performance</h4>\r
+<p align="left">TTCP accesses the Windows socket layer, hence it does not access \r
+IB verbs directly. IPoIB or WSD layers are invoked beneath the socket layer \r
+depending on configuration. TTCP is included as a quick baseline performance \r
+check.</p>\r
<blockquote>\r
<pre>Usage: ttcp -t [-options] host \r
ttcp -r [-options]\r
<p align="left"> </p>\r
<p align="left"> </p>\r
<h2 align="left"><a name="diags"></a>Diagnostics</h2>\r
+<hr>\r
<p align="left"> </p>\r
<h3 align="left"><a name="iblimits"></a>ib_limits - Infiniband verbs tests</h3>\r
<p align="left">Usage: ib_limits [options]</p>\r
<h4 align="left"><a href="#TOP"><font color="#000000"><return-to-top></font></a></h4>\r
<p align="left"> </p>\r
<h2 align="left"><a name="opensm"></a>Subnet Management with OpenSM Rev: openib-1.2.0</h2>\r
+<hr>\r
<p align="left">A single running process (opensm.exe) is required to configure \r
and thus make an Infiniband subnet useable. For most cases, InfiniBand \r
Subnet Management as a Windows service is sufficient to correctly configure most \r
Management service status via the Windows service manager (see #1).</li>\r
</ol>\r
<p> </p>\r
-<hr>\r
<h4 align="left">Manual InfiniBand Subnet Management from a command window</h4>\r
<p align="left">Usage: opensm.exe [options]</p>\r
<p align="left">Options:</p>\r
<p align="left"> </p>\r
<p align="left"> </p>\r
<h2 align="left"><a name="IPoIB"></a>IPoIB - Internet Protocols over InfiniBand</h2>\r
+<hr>\r
<p align="left">IPoIB enables the use of Internet Protocol utilities (e.g., ftp, \r
telnet) to function correctly over an Infiniband fabric. IPoIB is implemented as \r
an NDIS Miniport driver with a WDM lower edge.</p>\r
<p align="left"> </p>\r
<p align="left"> </p>\r
<h2 align="left"><a name="winsockdirect"></a>Winsock Direct Service Provider</h2>\r
+<hr>\r
<p align="left">Winsock Direct (WSD) is Microsoft's proprietary protocol that \r
predates SDP (Sockets Direct Protocol) for accelerating TCP/IP applications by \r
using RDMA hardware. Microsoft had a significant role in defining the SDP \r
the regular TCP/IP stack, or offload it to a WSD provider. The WSD provider is a \r
hardware specific DLL that implements connection management and data transfers \r
over particular RDMA hardware.</p>\r
+<p align="left">WinOF WSD is not supported in the Windows XP environment.</p>\r
<p align="left">The WSD Protocol seamlessly transports TCP \r
data using Infiniband data packets in 'buffered' mode or Infiniband \r
RDMA in 'direct' mode. Either way the user mode socket application sees no \r
- difference in the standard Inet socket which it created other than \r
+ behavioral difference in the standard Internet Protocol socket it created other than \r
reduced data transfer times and increased bandwidth.<br>\r
<br>\r
The Windows OpenFabrics release includes a WSD provider library that has been \r
-extensively tested with Microsoft Windows Server 2003.</p>\r
+extensively tested with Microsoft Windows Server 2003.<br>\r
+During testing, bugs where found in the WSD switch that could lead to hangs, \r
+crashes, data corruption, and other unwanted behavior. Microsoft released a \r
+hotfix to address these issues which should be installed if using WSD; the \r
+Microsoft Windows Server 2003 hotfix can be found\r
+<a class="wiki" href="http://support.microsoft.com/?kbid=910481">here</a>.<br>\r
+ </p>\r
<div id="tiki-main">\r
<div id="tiki-mid">\r
<table id="table1" cellSpacing="0" cellPadding="0" border="0">\r
</tr>\r
<tr>\r
<td class="wikicell">0x00000040</td>\r
- <td class="wikicell">CM</td>\r
+ <td class="wikicell">CM (Connection Manager)</td>\r
</tr>\r
<tr>\r
<td class="wikicell">0x00000080</td>\r
See <a href="https://wiki.openfabrics.org/tiki-index.php?page=Winsock+Direct">\r
https://wiki.openfabrics.org/tiki-index.php?page=Winsock+Direct</a> for the \r
latest WSD status.</p>\r
-<h3 align="left">Install Winsock Direct Service Provider</h3>\r
+<h3 align="left">Winsock Direct Service Provider Installation</h3>\r
<p align="left">When the custom install option 'WSD' is selected the WSD service \r
is automatically installed and started as part of the installation.<br>\r
Manual control is performed via the \Program Files\WinOF\installsp.exe utility.</p>\r
<h4 align="left"><a href="#TOP"><font color="#000000"><return-to-top></font></a></h4>\r
<p align="left"> </p>\r
<p align="left"> </p>\r
-<h2 align="left"><a name="DAT"></a>Direct Access Transport and usermode Direct Access Programing \r
+<h2 align="left"><a name="DAT"></a>Direct Access Transport and usermode Direct Access Programming \r
Libraries</h2>\r
-<p align="left">DAT and uDAPL are based on the 1.1 DAT specification. The DAPL \r
-(Direct Access Provider Library) provider now fully supports Infiniband RDMA and \r
+<hr>\r
+<p align="left"><font face="Times New Roman">The DAT (Direct Access Transport) \r
+API is a C programming interface developed by the\r
+<a class="wiki" href="http://www.datcollaborative.org">DAT Collaborative</a> in \r
+order provide a set of transport-independent, platform-independent Application \r
+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
+<div id="tiki-main0">\r
+ <div id="tiki-mid0">\r
+ <table id="table3" cellSpacing="0" cellPadding="0" border="0">\r
+ <tr>\r
+ <td id="centercolumn0">\r
+ <div id="tiki-center0">\r
+ <div class="wikitext">\r
+ <br>\r
+ How DAT objects map to equivalent\r
+ <a class="wiki" href="http://en.wikipedia.org/wiki/Infiniband">\r
+ InfiniBand</a> objects:<br>\r
+ <table class="wikitable" id="table4">\r
+ <tr>\r
+ <td class="wikicell">Interface Adapter (IA) \r
+ </td>\r
+ <td class="wikicell">HCA (Host Channel Adapter)</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="wikicell">Protection Zone (PZ) </td>\r
+ <td class="wikicell">PD (Protection Domain)</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="wikicell">Local Memory Region (LMR) \r
+ </td>\r
+ <td class="wikicell">MR (Memory Region)</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="wikicell">Remote Memory Region (RMR) \r
+ </td>\r
+ <td class="wikicell">MW (Memory Windows)</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="wikicell">Event Dispatcher (EVD) \r
+ </td>\r
+ <td class="wikicell">CQ (Completion Queue)</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="wikicell">Endpoint (EP) </td>\r
+ <td class="wikicell">QP (Queue Pair)</td>\r
+ </tr>\r
+ <tr>\r
+ <td class="wikicell">Public Service Point (PSP) \r
+ </td>\r
+ <td class="wikicell">connection identifier </td>\r
+ </tr>\r
+ <tr>\r
+ <td class="wikicell">Reserved Service Point (RSP) \r
+ </td>\r
+ <td class="wikicell">connection identifier </td>\r
+ </tr>\r
+ <tr>\r
+ <td class="wikicell">Connection Request (CR) \r
+ </td>\r
+ <td class="wikicell">connection manager event \r
+ </td>\r
+ </tr>\r
+ </table>\r
+ </div>\r
+ </div>\r
+ </td>\r
+ </tr>\r
+ </table>\r
+ </div>\r
+</div>\r
+<p align="left"> </p>\r
<div align="left">\r
<h3 align="left"><font face="Courier New" size="3">DAT EXECUTION ENVIRONMENT</font><font face="Courier New" size="2">:</font></h3>\r
</div>\r
<p align="left"> </p>\r
<p align="left"> </p>\r
<h2 align="left"><u><a name="SRP"></a>SRP - SCSI RDMA Protocol</u></h2>\r
-<p align="left">[ADD text here]</p>\r
+<p align="left"><span style="color: black">\r
+<font face="Times New Roman" size="3">The\r
+<a href="http://infiniband.sourceforge.net/Storage/SRP/overview.htm">SCSI RDMA \r
+Protocol </a> (SRP) is an emerging industry standard protocol for utilizing \r
+block storage devices over an InfiniBand\99 fabric. SRP is being defined in the \r
+ANSI T-10 committee.</font></span></p>\r
+<p align="left"><font face="Times New Roman">WinOF </font>SRP is a storage \r
+driver implementation that enables the SCSI RDMA protocol over an InfiniBand \r
+fabric.<br>\r
+The implementation conforms\r
+to the T10 Working Group draft\r
+<a href="http://www.t10.org/ftp/t10/drafts/srp/srp-r16a.pdf">\r
+http://www.t10.org/ftp/t10/drafts/srp/srp-r16a.pdf</a>.</p>\r
+<h4 align="left"><u>Software Dependencies</u></h4>\r
+<p align="left">The SRP driver depends on the installation of the WinOF stack \r
+with a Subnet<br>\r
+Manager running somewhere on the IB fabric.<br>\r
+<br>\r
+- Supported Operating Systems and Service Packs:<br>\r
+ o Windows XP SP2 x64<br>\r
+ o Windows Server 2003 SP1 (x86, x64)<br>\r
+ o Windows Server 2003 CCS (x64)</p>\r
+<h4 align="left"><br>\r
+<u>Testing Level</u></h4>\r
+<p align="left">The SRP driver has undergone basic testing against Mellanox \r
+Technologies'<br>\r
+SRP Targets MTD1000 and MTD2000. Testing included format, read, and write<br>\r
+operations.<br>\r
+ </p>\r
+<h4 align="left"><u>Installation</u></h4>\r
+<p align="left">The WinOF stack does not install the SRP driver by default. \r
+If SRP is\r
+selected in the <i>custom</i> installation window, it will only be copied during WinOF\r
+installation. To complete the SRP driver installation, an SRP target must be\r
+detected; a Subnet Manager must be running somewhere in the IB subnet.<br>\r
+<br>\r
+Upon the detection of an SRP target, the "New Hardware Found" Wizard pops up.<br>\r
+- Select Install Automatically and click Next. This installs the I/O unit \r
+device.<br>\r
+<br>\r
+Once completed, the "New Hardware Found" Wizard pops up again.<br>\r
+- Select Install Automatically and click Next. This installs the SRP driver.<br>\r
+ </p>\r
+<h4 align="left"><u>New Features and Changes</u></h4>\r
+<p align="left">- SRP supports WPP tracing tools by using the GUID: \r
+'5AF07B3C-D119-4233-9C81-C07EF481CBE6'.<br>\r
+ The flags and level of debug can be controlled at load-time or run-time.<br>\r
+ </p>\r
<h4 align="left"><a href="#TOP"><font color="#000000"><return-to-top></font></a></h4>\r
projects / ~shefty / rdma-win.git / commitdiff