<h1 align="center">User's Manual</h1>\r
<h2 align="center">Release 2.0</h2>\r
<h3 align="center">\r
-<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%m/%d/%Y" startspan -->09/08/2008<!--webbot bot="Timestamp" endspan i-checksum="12638" --></h3>\r
+<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%m/%d/%Y" startspan -->09/24/2008<!--webbot bot="Timestamp" endspan i-checksum="12590" --></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
<h2 align="left"><u><a name="TOP"></a>WinOF Features</u></h2>\r
<ul>\r
<li>\r
- <h3 align="left"><a href="#Tools">Tools</a><br>\r
- </h3></li>\r
+ <h3 align="left"><a href="#Tools">Tools</a></h3></li>\r
</ul>\r
<ul>\r
<li>\r
- <h3 align="left"><a href="#IPoIB">IPoIB - Internet Protocols over InfiniBand</a><br>\r
- </h3>\r
+ <h3 align="left"><a href="#IPoIB">IPoIB - Internet Protocols over InfiniBand</a></h3>\r
</li>\r
<li>\r
<h3 align="left"><a href="#winsockdirect">Winsock Direct Service Provider</a></h3>\r
Files\WinOF' is appended to the system wide search path registry entry. \r
A start menu short-cut 'WinOF Cmd Window' is provided to faciliate \r
correction tool operation.</p>\r
- <h4 align="left"><u>Infiniband Subnet Management</u></h4>\r
+ <h4 align="left"><u>IPoIB Partition Management</u></h4>\r
<ul>\r
- <li>\r
- <p align="left"><a href="#opensm">opensm</a> Open Subnet \r
- Management - configure and manage an InfiniBand subnet</li>\r
<li>\r
<p align="left"><a href="#InfiniBand_Partition_Management">part_man</a> \r
- Manage (add/remove/display) Infiniband fabric partitions.</li>\r
+ Manage (add/remove/show) IPoIB partitions.</li>\r
+ </ul>\r
+ <h4 align="left"><u>Infiniband Subnet Management</u></h4>\r
+ <ul>\r
<li>\r
- <p align="left"><a href="#osmtest">osmtest</a> Subnet management tests</li>\r
+ <p align="left"><a href="#opensm">opensm</a> Open Subnet \r
+ Management - configure and manage an InfiniBand subnet</li>\r
<li>\r
- <p align="left"><a href="#ibtrapgen">ib_trapgen</a> Generate Infiniband Subnet \r
+ <p align="left"><a href="#osmtest">osmtest</a> Subnet management tests</li>\r
+ <li>\r
+ <p align="left"><a href="#ibtrapgen">ib_trapgen</a> Generate Infiniband Subnet \r
Management Traps for testing purposes</li>\r
</ul>\r
<h4 align="left"><a href="#verbs_benchmarks">Performance</a></h4>\r
<ul>\r
<li>\r
- <p align="left"><a href="#ibsend_lat">ib_send_lat</a> Infiniband send \r
+ <p align="left"><a href="#ibsend_lat">ib_send_lat</a> Infiniband send \r
latency measurement</li>\r
<li>\r
- <p align="left"><a href="#ibsend_bw">ib_send_bw</a> Infiniband send bandwidth \r
+ <p align="left"><a href="#ibsend_bw">ib_send_bw</a> Infiniband send bandwidth \r
measurement</li>\r
<li>\r
<p align="left"><a href="#ibwrite_lat">ib_write_lat</a> Infiniband RDMA write \r
<li>\r
<p align="left"><a href="#cmtest">cmtest </a> Connection Manager tests</li>\r
<li>\r
- <p align="left"><a href="#printip">PrintIP</a> Display \r
+ <p align="left"><a href="#printip">PrintIP</a> Display \r
an Internet Protocol address associated with an IB GUID.</li>\r
<li>\r
- <p align="left"><a href="#vstat">vstat</a> \r
- Display HCA attributes (lids), statistics and error counters.<br> </li>\r
+ <p align="left"><a href="#vstat">vstat</a> Display HCA attributes (lids), statistics and error counters.<br> </li>\r
</ul>\r
</blockquote>\r
</blockquote>\r
<h3 align="left"><a name="InfiniBand_Partition_Management">InfiniBand Partition \r
Management</a></h3>\r
<p align="left"><font face="Times New Roman">The part</font><font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">_man.exe \r
-application allows creating, deleting and viewing partitions existing on host.</span></font></p>\r
-<p align="left"> </p>\r
+application allows creating, deleting and viewing existing </span><span style="FONT-SIZE: 12pt">\r
+host partitions</span><span style="FONT-SIZE: 12pt">.</span></font></p>\r
+<p align="left">Usage : part_man.exe <show|add|rem> <port_guid> <pkey1 pkey2 \r
+...></p>\r
+ <b><font face="Times New Roman" size="4">\r
+ <span style="font-weight: bold">show - </span></font></b>\r
+<font face="Times New Roman" size="3">\r
+ <span style="FONT-SIZE: 12pt">
\96 shows existing partitions</span></font><p style="MARGIN-LEFT: 0.5in"><font face="Times New Roman" size="3">
\r+ <span style="FONT-SIZE: 12pt">Expected results after execution <b>\r
+ <span style="FONT-WEIGHT: bold">part_man.exe show</span></b></span></font></p>\r
+ <p style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">1.</span></font><font size="1"><span style="FONT-SIZE: 7pt"> \r
+ </span></font>Output has a format<font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt"> </span></font></p>\r
+ <p style="MARGIN-LEFT: 0.5in"><b><font face="Times New Roman" size="3">\r
+ <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">port_guid1 pkey1 pkey2 \r
+ pkey3 pkey4 pkey5 pkey6 pkey7 pkey8</span></font></b></p>\r
+ <p style="MARGIN-LEFT: 0.5in"><b><font face="Times New Roman" size="3">\r
+ <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">port_guid2 \r
+ pkey1 pkey2 pkey3 pkey4 pkey5 pkey6 pkey7 pkey8</span></font></b></p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">where <b>\r
+ <span style="FONT-WEIGHT: bold">port_guid</span></b> is a port guid in \r
+ hexadecimal format, <b><span style="FONT-WEIGHT: bold">pkey</span></b> \96 \r
+ values of partition key (in hex format) for this port.</span></font></p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Default \r
+ partition key (0xFFFF) is not shown and can not be created by the \r
+ part_man.exe.</span></font></p>\r
+<p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
+ </p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.0in"><b>\r
+ <font face="Times New Roman" size="4">\r
+ <span style="FONT-WEIGHT: bold; ">add - </span></font></b>create new partition(s) \r
+ on specified port </p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
+ <font face="Times New Roman" size="3">\r
+ <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">port_guid</span></font></b> \r
+ <b><span style="FONT-WEIGHT: bold">add</span></b> <<b><span style="FONT-WEIGHT: bold">port_guid</span></b>> \r
+ <<b><span style="FONT-WEIGHT: bold">pkey1</span></b>> <<b><span style="FONT-WEIGHT: bold">pkey2</span></b>> \r
+ </p>\r
+<p class="MsoNormal" style="MARGIN-LEFT: 0.5in">creates new partition(s) on port specified by port_guid parameter (in \r
+ hexadecimal format) and pkey \96 new partition key value in hexadecimal \r
+ format (e.g. 0xABCD or ABCD).</p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Port \r
+ guid is taken form vstat output and has a following format:</span></font></p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
+ <font face="Times New Roman" size="3">\r
+ <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">XXXX:XXXX:XXXX:XXXX.</span></font></b></p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Vstat \r
+ prints node guid, so user has to add 1 to node guid value to obtain port \r
+ guid. For example, if node guid is <b><span style="FONT-WEIGHT: bold">\r
+ 0008:f104:0397:7ccc</span></b>, port guid will be</span></font></p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
+ <font face="Times New Roman" size="3">\r
+ <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">0008:f104:0397:7ccd</span></font></b> \r
+ \96 for the first port,</p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
+ <font face="Times New Roman" size="3">\r
+ <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">0008:f104:0397:7cce</span></font></b> \r
+ \96 for the second port.</p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
+ <font face="Courier New" color="green" size="2">\r
+ <span style="FONT-SIZE: 10pt; COLOR: green; FONT-FAMILY: 'Courier New'"> </span></font></p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Expected \r
+ results of execution <b><span style="FONT-WEIGHT: bold">part_man.exe add \r
+ 0x0D99:9703:04f1:0800 0xABCD</span></b></span></font></p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">1.</span></font><font size="1"><span style="FONT-SIZE: 7pt"> \r
+ </span></font>part_man.exe output ends up with <b>\r
+ <span style="FONT-WEIGHT: bold">\85Done </span></b>message.</p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">2.</span></font><font size="1"><span style="FONT-SIZE: 7pt"> \r
+ </span></font>A new instance of a Network Adapter named \93OpenFabrics IPoIB \r
+ Adapter Partition\94 will appear in Device manager \r
+ window. <br>\r
+ If the new adapter appears with yellow label, manual device driver installation is \r
+ required.</p>\r
+<ul>\r
+ <li>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">In \r
+ the device manager view, right click \93OpenFabrics IPoIB Adapter Partition\94</p>\r
+ </li>\r
+ <li>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
+ select 'update driver' and follow the instructions.</p></li>\r
+ <li>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">don't \r
+ allow Windows Update to search the Internet</p></li>\r
+ <li>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
+ select install software automatically.</p></li>\r
+</ul>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">3.</span></font><font size="1"><span style="FONT-SIZE: 7pt"> \r
+ </span></font>New adapter name ends with \93Partition\94, e.g. \93OpenFabrics IPoIB \r
+ Adapter Partition\94.</p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt"> </span></font></p>\r
+ <b>\r
+ <font face="Times New Roman" size="4">\r
+ <span style="FONT-WEIGHT: bold; ">rem </span></font></b>\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">\96 \r
+ removes partition key on specified \r
+ port.</span></font></p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
+ <font face="Times New Roman" size="3">\r
+ <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">part_man.exe rem <port_guid> \r
+ <pkey1> <pkey2></span></font></b></p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">\r
+ Port_guid \96 in hexadecimal format (same as for <b>\r
+ <span style="FONT-WEIGHT: bold">add</span></b> command), identifies port for \r
+ operation. </span></font></p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Expected \r
+ results after execution <b><span style="FONT-WEIGHT: bold">part_man rem <port_guid> \r
+ <pkey></span></b></span></font></p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">1.</span></font><font size="1"><span style="FONT-SIZE: 7pt"> \r
+ </span></font>Application prints <b><span style="FONT-WEIGHT: bold">\85Done\r
+ </span></b>message.</p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">2.</span></font><font size="1"><span style="FONT-SIZE: 7pt"> \r
+ </span></font>In device manager window IPoIB network adapter will disappear.</p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
+ <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">3.</span></font><font size="1"><span style="FONT-SIZE: 7pt"> \r
+ </span></font>Execution of <b><span style="FONT-WEIGHT: bold">part_man.exe \r
+ show </span></b>will not show removed adapter.</p>\r
+ <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in"> </div>\r
+ \r
<p align="left"><b><a href="#TOP"><font color="#000000"><return-to-top></font></a></b></p>\r
<p align="left"> </p>\r
<h3 align="left"><a name="printip"></a>PrintIP - print ip adapters and their addresses</h3>\r
projects / ~shefty / rdma-win.git / commitdiff