[OPENSM] added version number to FileDescription string for easy identification.
[mirror/winof/.git] / docs / Manual.htm
1 \r
2 <head>\r
3 <style>\r
4 <!--\r
5 div.Section1\r
6         {page:Section1;}\r
7 -->\r
8 </style>\r
9 </head>\r
10 \r
11 <h1 align="left">\r
12 <img border="0" src="openfabrics.gif" width="107" height="93">&nbsp; \r
13 <a href="#TOP"></a> </h1>\r
14 <h1 align="center">Windows OpenFabrics </h1>\r
15 <h1 align="center">User's Manual</h1>\r
16 <h2 align="center">Release 2.1</h2>\r
17 <h3 align="center">\r
18 <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%m/%d/%Y" startspan -->08/18/2009<!--webbot bot="Timestamp" endspan i-checksum="12646" --></h3>\r
19 <h2 align="left"><u>Overview</u></h2>\r
20 <p align="left"><span style="FONT-SIZE: 12pt; FONT-FAMILY: 'Times New Roman'">\r
21 The Windows OpenFabrics (WinOF) package is composed of software modules intended \r
22 for use on Microsoft Windows based computer systems connected via an InfiniBand \r
23 fabric.</span></p>\r
24 <p align="left">The Windows OpenFabrics software package contains the \r
25 following:<br>\r
26 <br>\r
27 OpenFabrics Infiniband core drivers and Upper Level Protocols (ULPs):</p>\r
28 <ul>\r
29         <li>\r
30         <p align="left">HCA (Host Channel Adapter) driver </li>\r
31         <li>\r
32         <p style="text-indent: -.25in; margin-left: .5in"><span dir="LTR">MTHCA -<span style='background-position: 0% 0%; mso-highlight:yellow; background-image:none; background-repeat:repeat; background-attachment:scroll'> \r
33         Mellanox </span></span><span style='background-position: 0% 0%; mso-highlight:yellow; background-image:none; background-repeat:repeat; background-attachment:scroll'> \r
34         InfiniHost low level driver. See \r
35         Release_notes.htm for a list of supported devices.</span></li>\r
36         <li>\r
37         <p style="text-indent: -.25in; margin-left: .5in">\r
38         <span style="background-position: 0% 0%">MLX4&nbsp;&nbsp;&nbsp; - Mellanox \r
39         ConnectX low level driver.</span><span\r
40 style='background-position: 0% 0%; mso-highlight:yellow; background-image:none; background-repeat:repeat; background-attachment:scroll'> <o:p></o:p></span>\r
41         </li>\r
42 <li>\r
43 <p align="left">Infiniband Core modules: IB verbs and IB access layer</li>\r
44 <li>\r
45 <p align="left">Upper Layer Protocols: IPoIB, WSD, NetworkDirect, VNIC, SRP Initiator and uDAPL</li>\r
46 </ul>\r
47 <p align="left">OpenFabrics utilities:</p>\r
48 <ul>\r
49         <li>\r
50         <p align="left">OpenSM: InfiniBand Subnet Manager</li>\r
51 <li>\r
52 <p align="left">Performance tests</li>\r
53 <li>\r
54 <p align="left">Diagnostic tools</li>\r
55 </ul>\r
56 <p align="left">Documentation</p>\r
57 <ul>\r
58         <li>\r
59         <p align="left">User's manual</li>\r
60 <li>\r
61 <p align="left">Release Notes</li>\r
62 </ul>\r
63 <p align="left">&nbsp;</p>\r
64 <h2 align="left"><u><a name="TOP"></a>WinOF Features</u></h2>\r
65 <ul>\r
66         <li>\r
67         <h3 align="left"><a href="#Tools">Tools &amp; Diagnostics</a></h3></li>\r
68 </ul>\r
69 <ul>\r
70         <li>\r
71         <h3 align="left"><a href="#IPoIB">IPoIB - Internet Protocols over InfiniBand</a></h3>\r
72         </li>\r
73         <li>\r
74         <h3 align="left"><a href="#winsockdirect">Winsock Direct Service Provider</a></h3>\r
75         </li>\r
76         <li>\r
77         <h3 align="left"><a href="#Network_Direct_Service_Provider">NetworkDirect \r
78         Service Provider</a></h3>\r
79         </li>\r
80         <li>\r
81         <h3 align="left"><a href="#DAT">DAT and uDAPL</a></h3>\r
82 <ul>\r
83         <li>\r
84         <h4 align="left"><a href="#DAPLTEST">DAPLtest</a></h4></li>\r
85         <li>\r
86         <h4 align="left"><a href="#DAPLtest-examples">DAPLtest Examples</a></h4>\r
87         </li>\r
88         <li>\r
89         <p align="left"><b><a href="#DAT_App_Build">DAT Application Build</a></b><br>\r
90         <br>&nbsp;</li>\r
91 </ul></li>\r
92         <li>\r
93         <h3 align="left"><a href="#SRP">SRP (SCSI RDMA) Protocol Driver</a></h3></li>\r
94         <li>\r
95         <h3 align="left"><u><font color="#0000FF"><a href="#QLOGICVNIC">QLogic VNIC_Driver</a></font></u></h3></li>\r
96         <li>\r
97         <h3 align="left"><u><a href="#InfiniBand_Software_Development_Kit">\r
98         InfiniBand Software Development Kit</a></u></h3></li>\r
99         <li>\r
100         <h3 align="left"><a href="#WinVerbs">WinVerbs</a></h3></li>\r
101 </ul>\r
102 <h3 align="left">&nbsp;</h3>\r
103 <p align="left">&nbsp;</p>\r
104 <p align="left">&nbsp;</p>\r
105 <BLOCKQUOTE></BLOCKQUOTE>\r
106 <h2 align="left"><a name="verbs_benchmarks0"></a><a name="Tools">Tools</a></h2>\r
107 <hr>\r
108 <blockquote>\r
109         <blockquote>\r
110                 <p align="left">The OpenFabrics Alliance Windows release contains a set of \r
111         user mode tools which are designed to faciliate the smooth operation of an \r
112         Windows OpenFabrics installation. These tools are available from a command \r
113                 window (cmd.exe) as the installation path '%SystemDrive%\Program \r
114                 Files\WinOF' is appended to the system wide search path registry entry. \r
115                 A start menu short-cut 'WinOF Cmd Window' is provided to faciliate \r
116                 correction tool operation.</p>\r
117                 <h4 align="left"><u>IPoIB Partition Management</u></h4>\r
118                 <ul>\r
119                         <li>\r
120                         <p align="left"><a href="#InfiniBand_Partition_Management">part_man</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
121                         Manage (add/remove/show) IPoIB partitions.</li>\r
122         </ul>\r
123         <h4 align="left"><u>Infiniband Subnet Management</u></h4>\r
124                 <ul>\r
125                         <li>\r
126                         <p align="left"><a href="#opensm">opensm</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Open Subnet \r
127         Management - configure and manage an InfiniBand subnet</li>\r
128                         <li>\r
129                         <p align="left"><a href="#osmtest">osmtest</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Subnet management tests</li>\r
130                         <li>\r
131                         <p align="left"><a href="#ibtrapgen">ib_trapgen</a>&nbsp;&nbsp;&nbsp;&nbsp; Generate Infiniband Subnet \r
132         Management Traps for testing purposes</li>\r
133                 </ul>\r
134         <h4 align="left"><u>QLogic VNIC Child Device Management</u></h4>\r
135                 <ul>\r
136                         <li>\r
137                         <p align="left"><a href="#qlgcvnicconfig">qlgcvnic_config</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Configuration \r
138                         utility used to configure IB Stack to create VNIC child devices as per user's requirement.</li>\r
139                 </ul>\r
140                 <h4 align="left"><a href="#verbs_benchmarks"><font color="#000000">Performance</font></a></h4>\r
141                 <ul>\r
142                         <li>\r
143                         <p align="left"><a href="#ibsend_lat">ib_send_lat</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Infiniband send \r
144 latency measurement</li>\r
145                         <li>\r
146                         <p align="left"><a href="#ibsend_bw">ib_send_bw</a>&nbsp;&nbsp;&nbsp;&nbsp;Infiniband send bandwidth \r
147         measurement</li>\r
148                         <li>\r
149                         <p align="left"><a href="#ibwrite_lat">ib_write_lat</a>&nbsp;&nbsp;&nbsp;&nbsp; Infiniband RDMA write \r
150 latency measurement</li>\r
151                         <li>\r
152                         <p align="left">i<a href="#ibwrite_bw">b_write_bw</a>&nbsp;&nbsp;&nbsp; Infiniband RDMA write bandwidth \r
153 measurement</li>\r
154                         <li>\r
155                         <p align="left"><a href="#ttcp">ttcp</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
156 TCP performance measurements</li>\r
157                 </ul>\r
158                 <h4 align="left"><a href="#diags"><font color="#000000">Diagnostics</font></a></h4>\r
159                 <ul>\r
160                         <li>\r
161                         <p align="left"><a href="#cmtest">cmtest&nbsp;</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Connection Manager tests</li>\r
162                         <li>\r
163                         <p align="left"><a href="#iblimits">ib_limits</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
164         InfiniBand verb tests</li>\r
165                         <li>\r
166                         <p align="left"><a href="#printip">printIP</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Display \r
167 an Internet Protocol address associated with an IB GUID.</li>\r
168                         <li>\r
169                         <p align="left"><a href="#vstat">vstat</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Display HCA attributes (lids), statistics and error counters.</li>\r
170                 </ul>\r
171                 <h4 align="left"><u><font color="#0000FF"><a href="#diags">\r
172                 <font color="#000000">OFED </font> </a> </font></u>\r
173                 <a href="#diags"><font color="#000000">Diagnostics</font></a></h4>\r
174                 <ul>\r
175                         <li>\r
176                         <p align="left"><a href="#IBADDR">ibaddr</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
177                         Query InfiniBand address(es)</li>\r
178                         <li>\r
179                         <p align="left"><a href="#IBLINKINFO">iblinkinfo</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
180                         Report link info for all links in the fabric</li>\r
181                         <li>\r
182                         <p align="left"><a href="#IBNETDISCOVER">ibnetdiscover&nbsp;</a>&nbsp;&nbsp; Generate a fabric \r
183                         topology.</li>\r
184                         <li>\r
185                         <p align="left"><a href="#IBPING">ibping</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
186                         Ping an InfiniBand address</li>\r
187                         <li>\r
188                         <p align="left"><a href="#IBPORTSTATE">ibportstate</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
189                         Display InfiniBand port specific information.</li>\r
190                         <li>\r
191                         <p align="left"><a href="#IBQUERYERRORS">ibqueryerrors</a>&nbsp;&nbsp;&nbsp; Query and report \r
192                         non-zero IB port counters</li>\r
193                         <li>\r
194                         <p align="left"><a href="#IBROUTE">ibroute</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
195                         Query InfiniBand switch forwarding tables</li>\r
196                         <li>\r
197                         <p align="left"><a href="#ibstat">ibstat</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Display HCA stats.</li>\r
198                         <li>\r
199                         <p align="left"><a href="#IBSYSSTAT">ibsysstat</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
200                         System status for an InfiniBand address</li>\r
201                         <li>\r
202                         <p align="left"><a href="#IBTRACERT">ibtracert</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
203                         Trace InfiniBand path</li>\r
204                         <li>\r
205                         <p align="left"><a href="#ibv_devinfo">ibv_devinfo</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
206                         Display HCA device information.</li>\r
207                         <li>\r
208                         <p align="left"><a href="#PERFQUERY">perfquery </a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
209                         Query InfiniBand performance counters</li>\r
210                         <li>\r
211                         <p align="left"><a href="#SAQUERY">saquery</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; SA (Subnet Administrator) query test</li>\r
212                         <li>\r
213                         <p align="left"><a href="#SMINFO">sminfo</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
214                         Query InfiniBand SMInfo attributes</li>\r
215                         <li>\r
216                         <p align="left"><a href="#SMPDUMP">smpdump</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
217                         Dump InfiniBand subnet management attributes</li>\r
218                         <li>\r
219                         <p align="left"><a href="#SMPQUERY">smpquery</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
220                         Query InfiniBand subnet management attributes</li>\r
221                         <li>\r
222                         <p align="left"><a href="#VENDSTAT">vendstat&nbsp;</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Query InfiniBand vendor specific functions</li>\r
223                 </ul>\r
224         </blockquote>\r
225 </blockquote>\r
226 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
227 <p align="left">&nbsp;</p>\r
228 <h2 align="left"><a name="verbs_benchmarks"></a>User mode micro-benchmarks</h2>\r
229 <hr>\r
230 <p align="left">The following user-mode test programs are intended as useful \r
231 micro-benchmarks for HW or SW \r
232 tuning and/or functional testing.</p>\r
233 <blockquote>\r
234         <p align="left">Tests use CPU cycle counters to get time stamps without \r
235         context switch.<br>\r
236         <br>Tests measure round-trip time but report half of that as one-way latency<br>\r
237         (i.e.. May not be sufficiently accurate for \r
238         asymmetrical configurations).<br>\r
239         <br>Min/Median/Max result is reported.<br>The median (vs. average) is less sensitive to extreme scores.<br>Typically the &quot;Max&quot; value is the first value measured.<br>\r
240         <br>larger samples only marginally help. The default (1000) is pretty good.<br>Note that an array of cycles_t (typically unsigned long) is allocated<br>once to collect samples and again to store the difference between them.<br>Really big sample sizes (e.g. 1 million) might expose other problems<br>with the program.<br>\r
241         <br>&quot;-H&quot; option will dump the histogram for additional statistical analysis.<br>See xgraph, ygraph, r-base (http://www.r-project.org/), pspp, or other\r
242         <br>statistical math programs.<br><br>Architectures tested: x86, x86_64, ia64</p>\r
243         <p align="left">Also see <a href="#WinVerbs">winverbs</a> performance tools.</p>\r
244 </blockquote>\r
245 <h4 align="left"><a name="ibsend_lat"></a><br>\r
246 ib_send_lat.exe&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - latency test with \r
247 send transactions</h4>\r
248 <blockquote>\r
249         <p align="left">Usage:</p>\r
250         <blockquote>\r
251                 <p align="left">ib_send_lat start a server and wait for connection<br>\r
252                 ib_send_lat &lt;host&gt; connect to server at &lt;host&gt;</p>\r
253         </blockquote>\r
254         <p align="left">Options:</p>\r
255         <blockquote>\r
256                 <p align="left">-p, --port=&lt;port&gt; listen on/connect to port &lt;port&gt; \r
257                 (default 18515)<br>\r
258                 -c, --connection=&lt;RC/UC&gt; connection type RC/UC (default RC)<br>\r
259                 -m, --mtu=&lt;mtu&gt; mtu size (default 2048)<br>\r
260                 -d, --ib-dev=&lt;dev&gt; use IB device &lt;dev&gt; (default first device found)<br>\r
261                 -i, --ib-port=&lt;port&gt; use port &lt;port&gt; of IB device (default 1)<br>\r
262                 -s, --size=&lt;size&gt; size of message to exchange (default 1)<br>\r
263                 -t, --tx-depth=&lt;dep&gt; size of tx queue (default 50)<br>\r
264                 -l, --signal signal completion on each msg<br>\r
265                 -a, --all Run sizes from 2 till 2^23<br>\r
266                 -n, --iters=&lt;iters&gt; number of exchanges (at least 2, default 1000)<br>\r
267                 -C, --report-cycles report times in cpu cycle units (default \r
268                 microseconds)<br>\r
269                 -H, --report-histogram print out all results (default print summary \r
270                 only)<br>\r
271                 -U, --report-unsorted (implies -H) print out unsorted results (default \r
272                 sorted)<br>\r
273                 -V, --version display version number<br>\r
274                 -e, --events sleep on CQ events (default poll)</p>\r
275         </blockquote>\r
276 </blockquote>\r
277 <h4 align="left"><a name="ibsend_bw"></a><br>\r
278 ib_send_bw.exe&nbsp;&nbsp;&nbsp;&nbsp; - BW (BandWidth) test with send transactions</h4>\r
279 <blockquote>\r
280         <p align="left">Usage:</p>\r
281         <blockquote>\r
282                 <p align="left">ib_send_bw start a server and wait for connection<br>\r
283                 ib_send_bw &lt;host&gt; connect to server at &lt;host&gt;</p>\r
284         </blockquote>\r
285         <p align="left">Options:</p>\r
286         <blockquote>\r
287                 <p align="left">-p, --port=&lt;port&gt; listen on/connect to port &lt;port&gt; \r
288                 (default 18515)<br>\r
289                 -d, --ib-dev=&lt;dev&gt; use IB device &lt;dev&gt; (default first device found)<br>\r
290                 -i, --ib-port=&lt;port&gt; use port &lt;port&gt; of IB device (default 1)<br>\r
291                 -c, --connection=&lt;RC/UC&gt; connection type RC/UC/UD (default RC)<br>\r
292                 -m, --mtu=&lt;mtu&gt; mtu size (default 1024)<br>\r
293                 -s, --size=&lt;size&gt; size of message to exchange (default 65536)<br>\r
294                 -a, --all Run sizes from 2 till 2^23<br>\r
295                 -t, --tx-depth=&lt;dep&gt; size of tx queue (default 300)<br>\r
296                 -n, --iters=&lt;iters&gt; number of exchanges (at least 2, default 1000)<br>\r
297                 -b, --bidirectional measure bidirectional bandwidth (default \r
298                 unidirectional)<br>\r
299                 -V, --version display version number<br>\r
300                 -e, --events sleep on CQ events (default poll)</p>\r
301         </blockquote>\r
302 </blockquote>\r
303 <h4 align="left"><a name="ibwrite_lat"></a><br>\r
304 ib_write_lat.exe&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - latency test with RDMA write \r
305 transactions</h4>\r
306 <blockquote>\r
307         <p align="left">Usage:</p>\r
308         <blockquote>\r
309                 <p align="left">ib_write_lat start a server and wait for connection<br>\r
310                 ib_write_lat &lt;host&gt; connect to server at &lt;host&gt;</p>\r
311         </blockquote>\r
312         <p align="left">Options:</p>\r
313         <blockquote>\r
314                 <p align="left">-p, --port=&lt;port&gt; listen on/connect to port &lt;port&gt; \r
315                 (default 18515)<br>\r
316                 -c, --connection=&lt;RC/UC&gt; connection type RC/UC (default RC)<br>\r
317                 -m, --mtu=&lt;mtu&gt; mtu size (default 1024)<br>\r
318                 -d, --ib-dev=&lt;dev&gt; use IB device &lt;dev&gt; (default first device found)<br>\r
319                 -i, --ib-port=&lt;port&gt; use port &lt;port&gt; of IB device (default 1)<br>\r
320                 -s, --size=&lt;size&gt; size of message to exchange (default 1)<br>\r
321                 -a, --all Run sizes from 2 till 2^23<br>\r
322                 -t, --tx-depth=&lt;dep&gt; size of tx queue (default 50)<br>\r
323                 -n, --iters=&lt;iters&gt; number of exchanges (at least 2, default 1000)<br>\r
324                 -C, --report-cycles report times in cpu cycle units (default \r
325                 microseconds)<br>\r
326                 -H, --report-histogram print out all results (default print summary \r
327                 only)<br>\r
328                 -U, --report-unsorted (implies -H) print out unsorted results (default \r
329                 sorted)<br>\r
330                 -V, --version display version number</p>\r
331         </blockquote>\r
332 </blockquote>\r
333 <h4 align="left"><a name="ibwrite_bw"></a><br>\r
334 ib_write_bw.exe&nbsp;&nbsp;&nbsp;&nbsp; - BW test with RDMA write transactions</h4>\r
335 <blockquote>\r
336         <p align="left">Usage:</p>\r
337         <blockquote>\r
338                 <p align="left">ib_write_bw&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
339                 # start a server and wait for connection<br>\r
340                 ib_write_bw &lt;host&gt;&nbsp;&nbsp;&nbsp; # connect to server at &lt;host&gt;</p>\r
341         </blockquote>\r
342         <p align="left">Options:</p>\r
343         <blockquote>\r
344                 <p align="left">-p, --port=&lt;port&gt; listen on/connect to port &lt;port&gt; \r
345                 (default 18515)<br>\r
346                 -d, --ib-dev=&lt;dev&gt; use IB device &lt;dev&gt; (default first device found)<br>\r
347                 -i, --ib-port=&lt;port&gt; use port &lt;port&gt; of IB device (default 1)<br>\r
348                 -c, --connection=&lt;RC/UC&gt; connection type RC/UC (default RC)<br>\r
349                 -m, --mtu=&lt;mtu&gt; mtu size (default 1024)<br>\r
350                 -g, --post=&lt;num of posts&gt; number of posts for each qp in the chain \r
351                 (default tx_depth)<br>\r
352                 -q, --qp=&lt;num of qp's&gt; Num of qp's(default 1)<br>\r
353                 -s, --size=&lt;size&gt; size of message to exchange (default 65536)<br>\r
354                 -a, --all Run sizes from 2 till 2^23<br>\r
355                 -t, --tx-depth=&lt;dep&gt; size of tx queue (default 100)<br>\r
356                 -n, --iters=&lt;iters&gt; number of exchanges (at least 2, default 5000)<br>\r
357                 -b, --bidirectional measure bidirectional bandwidth (default \r
358                 unidirectional)<br>\r
359                 -V, --version display version number</p>\r
360         </blockquote>\r
361 </blockquote>\r
362 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
363 <p align="left"><br>\r
364 &nbsp;</p>\r
365 <h4 align="left"><a name="ttcp"></a><br>\r
366 ttcp - Test TCP performance</h4>\r
367 <p align="left">TTCP accesses the Windows socket layer, hence it does not access \r
368 IB verbs directly. IPoIB or WSD layers are invoked beneath the socket layer \r
369 depending on configuration. TTCP is included as a quick baseline performance \r
370 check.</p>\r
371 <blockquote>\r
372         <pre>Usage: ttcp -t [-options] host \r
373        ttcp -r [-options]\r
374 Common options:\r
375         -l ##   length of bufs read from or written to network (default 8192)\r
376         -u      use UDP instead of TCP\r
377         -p ##   port number to send to or listen at (default 5001)\r
378         -A      align the start of buffers to this modulus (default 16384)\r
379         -O      start buffers at this offset from the modulus (default 0)\r
380         -d      set SO_DEBUG socket option\r
381         -b ##   set socket buffer size (if supported)\r
382         -f X    format for rate: k,K = kilo{bit,byte}; m,M = mega; g,G = giga\r
383 Options specific to -t:\r
384         -n##    number of source bufs written to network (default 2048)\r
385         -D      don't buffer TCP writes (sets TCP_NODELAY socket option)\r
386 Options specific to -r:\r
387         -B      for -s, only output full blocks as specified by -l (for TAR)\r
388         -T      &quot;touch&quot;: access each byte as it's read</pre>\r
389         <p align="left">Requires a receiver (server) side and a transmitter (client) \r
390         side, host1 and host2 are IPoIB connected hosts.</p>\r
391         <p align="left">at host1 (receiver)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
392         ttcp -r -f M -l 4096</p>\r
393         <p align="left">at host2 (transmitter)&nbsp;&nbsp;&nbsp; ttcp -t -f M -l \r
394         4096 -n1000 host1</p>\r
395 </blockquote>\r
396 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
397 <p align="left">&nbsp;</p>\r
398 <p align="left">&nbsp;</p>\r
399 <h2 align="left"><a name="diags"></a>Diagnostics</h2>\r
400 <hr>\r
401 <BLOCKQUOTE></BLOCKQUOTE>\r
402 <h3 align="left"><a name="IBADDR">IBADDR</a>(8) OFED Diagnostics</h3>\r
403 <p align="left">NAME<br>\r
404 ibaddr - query InfiniBand address(es)<br>\r
405 <br>\r
406 SYNOPSIS<br>\r
407 ibaddr [-d(ebug)] [-D(irect)] [-G(uid)] [-l(id_show)] [-g(id_show)] [-C\r
408 ca_name] [-P ca_port] [-t(imeout) timeout_ms] [-V(ersion)] [-h(elp)]\r
409 [&lt;lid | dr_path | guid&gt;]<br>\r
410 <br>\r
411 DESCRIPTION<br>\r
412 Display the lid (and range) as well as the GID address of the port<br>\r
413 specified (by DR path, lid, or GUID) or the local port by default.<br>\r
414 <br>\r
415 Note: this utility can be used as simple address resolver.<br>\r
416 <br>\r
417 OPTIONS<br>\r
418 -G, --Guid<br>\r
419 show lid range and gid for GUID address<br>\r
420 <br>\r
421 -l, --lid_show<br>\r
422 show lid range only<br>\r
423 <br>\r
424 -L, --Lid_show<br>\r
425 show lid range (in decimal) only<br>\r
426 <br>\r
427 -g, --gid_show<br>\r
428 show gid address only<br>\r
429 <br>\r
430 <br>\r
431 COMMON OPTIONS<br>\r
432 Most WinOF diagnostics take the following common flags. The exact list<br>\r
433 of supported flags per utility can be found in the usage message and<br>\r
434 can be shown using the util_name -h syntax.<br>\r
435 <br>\r
436 # Debugging flags<br>\r
437 <br>\r
438 -d raise the IB debugging level.<br>\r
439 May be used several times (-ddd or -d -d -d).<br>\r
440 <br>\r
441 -e show send and receive errors (timeouts and others)<br>\r
442 <br>\r
443 -h show the usage message<br>\r
444 <br>\r
445 -v increase the application verbosity level.<br>\r
446 May be used several times (-vv or -v -v -v)<br>\r
447 <br>\r
448 -V show the version info.<br>\r
449 <br>\r
450 # Addressing flags<br>\r
451 <br>\r
452 -D use directed path address arguments. The path<br>\r
453 is a comma separated list of out ports.<br>\r
454 Examples:<br>\r
455 &quot;0&quot; # self port<br>\r
456 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
457 <br>\r
458 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
459 Example:<br>\r
460 &quot;0x08f1040023&quot;<br>\r
461 <br>\r
462 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
463 <br>\r
464 # Other common flags:<br>\r
465 <br>\r
466 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
467 <br>\r
468 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
469 <br>\r
470 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
471 <br>\r
472 Multiple CA/Multiple Port Support<br>\r
473 <br>\r
474 When no IB device or port is specified, the port to use is selected by<br>\r
475 the following criteria:<br>\r
476 <br>\r
477 1. the first port that is ACTIVE.<br>\r
478 <br>\r
479 2. if not found, the first port that is UP (physical link up).<br>\r
480 <br>\r
481 If a port and/or CA name is specified, the user request is attempted to<br>\r
482 be fulfilled, and will fail if it is not possible.<br>\r
483 <br>\r
484 <br>\r
485 EXAMPLES<br>\r
486 ibaddr # local port´s address<br>\r
487 <br>\r
488 ibaddr 32 # show lid range and gid of lid 32<br>\r
489 <br>\r
490 ibaddr -G 0x8f1040023 # same but using guid address<br>\r
491 <br>\r
492 ibaddr -l 32 # show lid range only<br>\r
493 <br>\r
494 ibaddr -L 32 # show decimal lid range only<br>\r
495 <br>\r
496 ibaddr -g 32 # show gid address only<br>\r
497 <br>\r
498 <br>\r
499 SEE ALSO<br>\r
500 ibroute(8), ibtracert(8)<br>\r
501 <br>\r
502 AUTHOR<br>\r
503 Hal Rosenstock<br>\r
504 &lt;halr@voltaire.com&gt;<br>\r
505 <br>\r
506 <br>\r
507 OFED June 18, 2007 IBADDR(8)<br>\r
508 &nbsp;</p>\r
509 <h3 align="left">&nbsp;</h3>\r
510 <h3 align="left"><a name="IBLINKINFO">IBLINKINFO</a>(8) OFED Diagnostics<br>\r
511 &nbsp;</h3>\r
512 <p align="left">NAME<br>\r
513 iblinkinfo - report link info for all links in the fabric<br>\r
514 <br>\r
515 <br>\r
516 SYNOPSIS<br>\r
517 iblinkinfo\r
518 [-Rhcdl -C &lt;ca_name&gt; -P &lt;ca_port&gt; -v &lt;lt,hoq,vlstall&gt; -S &lt;guid&gt; -D&lt;direct_route&gt;]<br>\r
519 <br>\r
520 <br>\r
521 DESCRIPTION<br>\r
522 iblinkinfo reports the link info for each port of each switch active<br>\r
523 in the IB fabric.<br>\r
524 <br>\r
525 <br>\r
526 OPTIONS<br>\r
527 -R Recalculate the ibnetdiscover information, ie do not use the<br>\r
528 cached information. This option is slower but should be used if<br>\r
529 the diag tools have not been used for some time or if there are<br>\r
530 other reasons to believe the fabric has changed.<br>\r
531 <br>\r
532 -S &lt;guid&gt;<br>\r
533 Output only the switch specified by &lt;guid&gt; (hex format)<br>\r
534 <br>\r
535 -D &lt;direct_route&gt;<br>\r
536 Output only the switch specified by the direct route path.<br>\r
537 <br>\r
538 -l Print all information for each link on one line. Default is to<br>\r
539 print a header with the switch information and then a list for<br>\r
540 each port (useful for grep´ing output).<br>\r
541 <br>\r
542 -d Print only switches which have a port in the &quot;Down&quot; state.<br>\r
543 <br>\r
544 -v &lt;lt,hoq,vlstall&gt;<br>\r
545 Verify additional switch settings (&lt;Life-<br>\r
546 Time&gt;,&lt;HoqLife&gt;,&lt;VLStallCount&gt;)<br>\r
547 <br>\r
548 -c Print port capabilities (enabled and supported values)<br>\r
549 <br>\r
550 -C &lt;ca_name&gt; use the specified ca_name for the search.<br>\r
551 <br>\r
552 -P &lt;ca_port&gt; use the specified ca_port for the search.<br>\r
553 <br>\r
554 <br>\r
555 <br>\r
556 AUTHOR<br>\r
557 Ira Weiny &lt;weiny2@llnl.gov&gt;<br>\r
558 <br>\r
559 <br>\r
560 OFED Jan 24, 2008 IBLINKINFO(8)</p>\r
561 <p align="left"><font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font><br>\r
562 &nbsp;</p>\r
563 <p align="left">&nbsp;</p>\r
564 <h3 align="left"><a name="IBNETDISCOVER">IBNETDISCOVER</a>(8) OFED Diagnostics<br>\r
565 &nbsp;</h3>\r
566 <p align="left">NAME<br>\r
567 ibnetdiscover - discover InfiniBand topology<br>\r
568 <br>\r
569 <br>\r
570 SYNOPSIS<br>\r
571 ibnetdiscover [-d(ebug)] [-e(rr_show)] [-v(erbose)] [-s(how)] [-l(ist)]<br>\r
572 [-g(rouping)] [-H(ca_list)] [-S(witch_list)] [-R(outer_list)] [-C<br>\r
573 ca_name] [-P ca_port] [-t(imeout) timeout_ms] [-V(ersion)] [--node-<br>\r
574 name-map &lt;node-name-map&gt;] [-p(orts)] [-h(elp)] [&lt;topology-file&gt;]<br>\r
575 <br>\r
576 <br>\r
577 DESCRIPTION<br>\r
578 ibnetdiscover performs IB subnet discovery and outputs a human readable<br>\r
579 topology file. GUIDs, node types, and port numbers are displayed as<br>\r
580 well as port LIDs and NodeDescriptions. All nodes (and links) are dis-<br>\r
581 played (full topology). Optionally, this utility can be used to list<br>\r
582 the current connected nodes by nodetype. The output is printed to<br>\r
583 standard output unless a topology file is specified.<br>\r
584 <br>\r
585 <br>\r
586 OPTIONS<br>\r
587 -l, --list<br>\r
588 List of connected nodes<br>\r
589 <br>\r
590 -g, --grouping<br>\r
591 Show grouping. Grouping correlates IB nodes by different vendor<br>\r
592 specific schemes. It may also show the switch external ports<br>\r
593 correspondence.<br>\r
594 <br>\r
595 -H, --Hca_list<br>\r
596 List of connected CAs<br>\r
597 <br>\r
598 -S, --Switch_list<br>\r
599 List of connected switches<br>\r
600 <br>\r
601 -R, --Router_list<br>\r
602 List of connected routers<br>\r
603 <br>\r
604 -s, --show<br>\r
605 Show progress information during discovery.<br>\r
606 <br>\r
607 --node-name-map &lt;node-name-map&gt;<br>\r
608 Specify a node name map. The node name map file maps GUIDs to<br>\r
609 more user friendly names. See file format below.<br>\r
610 <br>\r
611 -p, --ports<br>\r
612 Obtain a ports report which is a list of connected ports with<br>\r
613 relevant information (like LID, portnum, GUID, width, speed, and<br>\r
614 NodeDescription).<br>\r
615 <br>\r
616 <br>\r
617 COMMON OPTIONS<br>\r
618 Most OpenIB diagnostics take the following common flags. The exact list<br>\r
619 of supported flags per utility can be found in the usage message and<br>\r
620 can be shown using the util_name -h syntax.<br>\r
621 <br>\r
622 # Debugging flags<br>\r
623 <br>\r
624 -d raise the IB debugging level.<br>\r
625 May be used several times (-ddd or -d -d -d).<br>\r
626 <br>\r
627 -e show send and receive errors (timeouts and others)<br>\r
628 <br>\r
629 -h show the usage message<br>\r
630 <br>\r
631 -v increase the application verbosity level.<br>\r
632 May be used several times (-vv or -v -v -v)<br>\r
633 <br>\r
634 -V show the version info.<br>\r
635 <br>\r
636 # Other common flags:<br>\r
637 <br>\r
638 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
639 <br>\r
640 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
641 <br>\r
642 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
643 <br>\r
644 Multiple CA/Multiple Port Support<br>\r
645 <br>\r
646 When no IB device or port is specified, the port to use is selected by<br>\r
647 the following criteria:<br>\r
648 <br>\r
649 1. the first port that is ACTIVE.<br>\r
650 <br>\r
651 2. if not found, the first port that is UP (physical link up).<br>\r
652 <br>\r
653 If a port and/or CA name is specified, the user request is attempted to<br>\r
654 be fulfilled, and will fail if it is not possible.<br>\r
655 <br>\r
656 <br>\r
657 TOPOLOGY FILE FORMAT<br>\r
658 The topology file format is human readable and largely intuitive. Most<br>\r
659 identifiers are given textual names like vendor ID (vendid), device ID<br>\r
660 (device ID), GUIDs of various types (sysimgguid, caguid, switchguid,<br>\r
661 etc.). PortGUIDs are shown in parentheses (). For switches, this is<br>\r
662 shown on the switchguid line. For CA and router ports, it is shown on<br>\r
663 the connectivity lines. The IB node is identified followed by the num-<br>\r
664 ber of ports and a quoted the node GUID. On the right of this line is<br>\r
665 a comment (#) followed by the NodeDescription in quotes. If the node<br>\r
666 is a switch, this line also contains whether switch port 0 is base or<br>\r
667 enhanced, and the LID and LMC of port 0. Subsequent lines pertaining<br>\r
668 to this node show the connectivity. On the left is the port number of<br>\r
669 the current node. On the right is the peer node (node at other end of<br>\r
670 link). It is identified in quotes with nodetype followed by - followed<br>\r
671 by NodeGUID with the port number in square brackets. Further on the<br>\r
672 right is a comment (#). What follows the comment is dependent on the<br>\r
673 node type. If it it a switch node, it is followed by the NodeDescrip-<br>\r
674 tion in quotes and the LID of the peer node. If it is a CA or router<br>\r
675 node, it is followed by the local LID and LMC and then followed by the<br>\r
676 NodeDescription in quotes and the LID of the peer node. The active<br>\r
677 link width and speed are then appended to the end of this output line.<br>\r
678 <br>\r
679 An example of this is:<br>\r
680 #<br>\r
681 # Topology file: generated on Tue Jun 5 14:15:10 2007<br>\r
682 #<br>\r
683 # Max of 3 hops discovered<br>\r
684 # Initiated from node 0008f10403960558 port 0008f10403960559<br>\r
685 <br>\r
686 Non-Chassis Nodes<br>\r
687 <br>\r
688 vendid=0x8f1<br>\r
689 devid=0x5a06<br>\r
690 sysimgguid=0x5442ba00003000<br>\r
691 switchguid=0x5442ba00003080(5442ba00003080)<br>\r
692 Switch 24 &quot;S-005442ba00003080&quot; # &quot;ISR9024 Voltaire&quot; base port 0 lid 6 lmc 0<br>\r
693 [22] &quot;H-0008f10403961354&quot;[1](8f10403961355) # &quot;MT23108 InfiniHost Mellanox \r
694 Technologies&quot; lid 4 4xSDR<br>\r
695 [10] &quot;S-0008f10400410015&quot;[1] # &quot;SW-6IB4 Voltaire&quot; lid 3 4xSDR<br>\r
696 [8] &quot;H-0008f10403960558&quot;[2](8f1040396055a) # &quot;MT23108 InfiniHost Mellanox \r
697 Technologies&quot; lid 14 4xSDR<br>\r
698 [6] &quot;S-0008f10400410015&quot;[3] # &quot;SW-6IB4 Voltaire&quot; lid 3 4xSDR<br>\r
699 [12] &quot;H-0008f10403960558&quot;[1](8f10403960559) # &quot;MT23108 InfiniHost Mellanox \r
700 Technologies&quot; lid 10 4xSDR<br>\r
701 <br>\r
702 vendid=0x8f1<br>\r
703 devid=0x5a05<br>\r
704 switchguid=0x8f10400410015(8f10400410015)<br>\r
705 Switch 8 &quot;S-0008f10400410015&quot; # &quot;SW-6IB4 Voltaire&quot; base port 0 lid 3 lmc 0<br>\r
706 [6] &quot;H-0008f10403960984&quot;[1](8f10403960985) # &quot;MT23108 InfiniHost Mellanox \r
707 Technologies&quot; lid 16 4xSDR<br>\r
708 [4] &quot;H-005442b100004900&quot;[1](5442b100004901) # &quot;MT23108 InfiniHost Mellanox \r
709 Technologies&quot; lid 12 4xSDR<br>\r
710 [1] &quot;S-005442ba00003080&quot;[10] # &quot;ISR9024 Voltaire&quot; lid 6 1xSDR<br>\r
711 [3] &quot;S-005442ba00003080&quot;[6] # &quot;ISR9024 Voltaire&quot; lid 6 4xSDR<br>\r
712 <br>\r
713 vendid=0x2c9<br>\r
714 devid=0x5a44<br>\r
715 caguid=0x8f10403960984<br>\r
716 Ca 2 &quot;H-0008f10403960984&quot; # &quot;MT23108 InfiniHost Mellanox Technologies&quot;<br>\r
717 [1](8f10403960985) &quot;S-0008f10400410015&quot;[6] # lid 16 lmc 1 &quot;SW-6IB4 Voltaire&quot; lid \r
718 3 4xSDR<br>\r
719 <br>\r
720 vendid=0x2c9<br>\r
721 devid=0x5a44<br>\r
722 caguid=0x5442b100004900<br>\r
723 Ca 2 &quot;H-005442b100004900&quot; # &quot;MT23108 InfiniHost Mellanox Technologies&quot;<br>\r
724 [1](5442b100004901) &quot;S-0008f10400410015&quot;[4] # lid 12 lmc 1 &quot;SW-6IB4 Voltaire&quot; \r
725 lid 3 4xSDR<br>\r
726 <br>\r
727 vendid=0x2c9<br>\r
728 devid=0x5a44<br>\r
729 caguid=0x8f10403961354<br>\r
730 Ca 2 &quot;H-0008f10403961354&quot; # &quot;MT23108 InfiniHost Mellanox Technologies&quot;<br>\r
731 [1](8f10403961355) &quot;S-005442ba00003080&quot;[22] # lid 4 lmc 1 &quot;ISR9024 Voltaire&quot; lid \r
732 6 4xSDR<br>\r
733 <br>\r
734 vendid=0x2c9<br>\r
735 devid=0x5a44<br>\r
736 caguid=0x8f10403960558<br>\r
737 Ca 2 &quot;H-0008f10403960558&quot; # &quot;MT23108 InfiniHost Mellanox Technologies&quot;<br>\r
738 [2](8f1040396055a) &quot;S-005442ba00003080&quot;[8] # lid 14 lmc 1 &quot;ISR9024 Voltaire&quot; lid \r
739 6 4xSDR<br>\r
740 [1](8f10403960559) &quot;S-005442ba00003080&quot;[12] # lid 10 lmc 1 &quot;ISR9024 Voltaire&quot; \r
741 lid 6 1xSDR<br>\r
742 <br>\r
743 When grouping is used, IB nodes are organized into chasses which are<br>\r
744 numbered. Nodes which cannot be determined to be in a chassis are dis-<br>\r
745 played as &quot;Non-Chassis Nodes&quot;. External ports are also shown on the<br>\r
746 connectivity lines.<br>\r
747 <br>\r
748 <br>\r
749 <br>\r
750 NODE NAME MAP FILE FORMAT<br>\r
751 The node name map is used to specify user friendly names for nodes in<br>\r
752 the output. GUIDs are used to perform the lookup.<br>\r
753 <br>\r
754 <br>\r
755 Generically:<br>\r
756 <br>\r
757 # comment<br>\r
758 &lt;guid&gt; &quot;&lt;name&gt;&quot;<br>\r
759 <br>\r
760 <br>\r
761 Example:<br>\r
762 <br>\r
763 # IB1<br>\r
764 # Line cards<br>\r
765 0x0008f104003f125c &quot;IB1 (Rack 11 slot 1 ) ISR9288/ISR9096<br>\r
766 Voltaire sLB-24D&quot;<br>\r
767 0x0008f104003f125d &quot;IB1 (Rack 11 slot 1 ) ISR9288/ISR9096<br>\r
768 Voltaire sLB-24D&quot;<br>\r
769 0x0008f104003f10d2 &quot;IB1 (Rack 11 slot 2 ) ISR9288/ISR9096<br>\r
770 Voltaire sLB-24D&quot;<br>\r
771 0x0008f104003f10d3 &quot;IB1 (Rack 11 slot 2 ) ISR9288/ISR9096<br>\r
772 Voltaire sLB-24D&quot;<br>\r
773 0x0008f104003f10bf &quot;IB1 (Rack 11 slot 12 ) ISR9288/ISR9096<br>\r
774 Voltaire sLB-24D&quot;<br>\r
775 # Spines<br>\r
776 0x0008f10400400e2d &quot;IB1 (Rack 11 spine 1 ) ISR9288 Voltaire<br>\r
777 sFB-12D&quot;<br>\r
778 0x0008f10400400e2e &quot;IB1 (Rack 11 spine 1 ) ISR9288 Voltaire<br>\r
779 sFB-12D&quot;<br>\r
780 0x0008f10400400e2f &quot;IB1 (Rack 11 spine 1 ) ISR9288 Voltaire<br>\r
781 sFB-12D&quot;<br>\r
782 0x0008f10400400e31 &quot;IB1 (Rack 11 spine 2 ) ISR9288 Voltaire<br>\r
783 sFB-12D&quot;<br>\r
784 0x0008f10400400e32 &quot;IB1 (Rack 11 spine 2 ) ISR9288 Voltaire<br>\r
785 sFB-12D&quot;<br>\r
786 # GUID Node Name<br>\r
787 0x0008f10400411a08 &quot;SW1 (Rack 3) ISR9024 Voltaire 9024D&quot;<br>\r
788 0x0008f10400411a28 &quot;SW2 (Rack 3) ISR9024 Voltaire 9024D&quot;<br>\r
789 0x0008f10400411a34 &quot;SW3 (Rack 3) ISR9024 Voltaire 9024D&quot;<br>\r
790 0x0008f104004119d0 &quot;SW4 (Rack 3) ISR9024 Voltaire 9024D&quot;<br>\r
791 <br>\r
792 <br>\r
793 AUTHORS<br>\r
794 Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;halr@voltaire.com&gt;<br>\r
795 <br>\r
796 Ira Weiny&nbsp;&nbsp;&nbsp; &lt;weiny2@llnl.gov&gt;<br>\r
797 <br>\r
798 <br>\r
799 OFED January 3, 2008 IBNETDISCOVER(8)<br>\r
800 <br>\r
801 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font><br>\r
802 &nbsp;</p>\r
803 <p align="left">&nbsp;</p>\r
804 <h3 align="left"><a name="IBPING">IBPING</a>(8) OFED Diagnostics<br>\r
805 &nbsp;</h3>\r
806 <p align="left">NAME<br>\r
807 ibping - ping an InfiniBand address<br>\r
808 <br>\r
809 <br>\r
810 SYNOPSIS<br>\r
811 ibping [-d(ebug)] [-e(rr_show)] [-v(erbose)] [-G(uid)] [-C ca_name] [-P<br>\r
812 ca_port] [-s smlid] [-t(imeout) timeout_ms] [-V(ersion)] [-c<br>\r
813 ping_count] [-f(lood)] [-o oui] [-S(erver)] [-h(elp)] &lt;dest lid | guid&gt;<br>\r
814 <br>\r
815 <br>\r
816 DESCRIPTION<br>\r
817 ibping uses vendor mads to validate connectivity between IB nodes. On<br>\r
818 exit, (IP) ping like output is show. ibping is run as client/server.<br>\r
819 Default is to run as client. Note also that a default ping server is<br>\r
820 implemented within the kernel.<br>\r
821 <br>\r
822 <br>\r
823 OPTIONS<br>\r
824 -c stop after count packets<br>\r
825 <br>\r
826 -f, --flood<br>\r
827 flood destination: send packets back to back without delay<br>\r
828 <br>\r
829 -o, --oui<br>\r
830 use specified OUI number to multiplex vendor mads<br>\r
831 <br>\r
832 -S, --Server<br>\r
833 start in server mode (do not return)<br>\r
834 <br>\r
835 <br>\r
836 COMMON OPTIONS<br>\r
837 Most OFED diagnostics take the following common flags. The exact list<br>\r
838 of supported flags per utility can be found in the usage message and<br>\r
839 can be shown using the util_name -h syntax.<br>\r
840 <br>\r
841 # Debugging flags<br>\r
842 <br>\r
843 -d raise the IB debugging level.<br>\r
844 May be used several times (-ddd or -d -d -d).<br>\r
845 <br>\r
846 -e show send and receive errors (timeouts and others)<br>\r
847 <br>\r
848 -h show the usage message<br>\r
849 <br>\r
850 -v increase the application verbosity level.<br>\r
851 May be used several times (-vv or -v -v -v)<br>\r
852 <br>\r
853 -V show the version info.<br>\r
854 <br>\r
855 # Addressing flags<br>\r
856 <br>\r
857 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
858 Example:<br>\r
859 &quot;0x08f1040023&quot;<br>\r
860 <br>\r
861 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
862 <br>\r
863 # Other common flags:<br>\r
864 <br>\r
865 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
866 <br>\r
867 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
868 <br>\r
869 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
870 <br>\r
871 Multiple CA/Multiple Port Support<br>\r
872 <br>\r
873 When no IB device or port is specified, the port to use is selected by<br>\r
874 the following criteria:<br>\r
875 <br>\r
876 1. the first port that is ACTIVE.<br>\r
877 <br>\r
878 2. if not found, the first port that is UP (physical link up).<br>\r
879 <br>\r
880 If a port and/or CA name is specified, the user request is attempted to<br>\r
881 be fulfilled, and will fail if it is not possible.<br>\r
882 <br>\r
883 <br>\r
884 AUTHOR<br>\r
885 Hal Rosenstock &lt;halr@voltaire.com&gt;<br>\r
886 <br>\r
887 <br>\r
888 OFED August 11, 2006 IBPING(8)</p>\r
889 <p align="left"><br>\r
890 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font></p>\r
891 <h3 align="left">&nbsp;</h3>\r
892 <h3 align="left"><a name="IBPORTSTATE">IBPORTSTATE</a>(8) OFED Diagnostics</h3>\r
893 <p align="left"><br>\r
894 NAME<br>\r
895 ibportstate - handle port (physical) state and link speed of an Infini-<br>\r
896 Band port<br>\r
897 <br>\r
898 <br>\r
899 SYNOPSIS<br>\r
900 ibportstate [-d(ebug)] [-e(rr_show)] [-v(erbose)] [-D(irect)] [-G(uid)] [-s \r
901 smlid] [-V(ersion)] [-C ca_name] [-P ca_port] [-t(imeout) time-out_ms] [-h(elp)] \r
902 &lt;dest dr_path|lid|guid&gt; &lt;portnum&gt; [&lt;op&gt;]<br>\r
903 <br>\r
904 <br>\r
905 DESCRIPTION<br>\r
906 ibportstate allows the port state and port physical state of an IB port<br>\r
907 to be queried (in addition to link width and speed being validated rel-<br>\r
908 ative to the peer port when the port queried is a switch port), or a<br>\r
909 switch port to be disabled, enabled, or reset. It also allows the link<br>\r
910 speed enabled on any IB port to be adjusted.<br>\r
911 <br>\r
912 <br>\r
913 OPTIONS<br>\r
914 op Port operations allowed<br>\r
915 supported ops: enable, disable, reset, speed, query<br>\r
916 Default is query<br>\r
917 <br>\r
918 ops enable, disable, and reset are only allowed on switch ports<br>\r
919 (An error is indicated if attempted on CA or router ports)<br>\r
920 speed op is allowed on any port<br>\r
921 speed values are legal values for PortInfo:LinkSpeedEnabled<br>\r
922 (An error is indicated if PortInfo:LinkSpeedSupported does not support<br>\r
923 this setting)<br>\r
924 (NOTE: Speed changes are not effected until the port goes through<br>\r
925 link renegotiation)<br>\r
926 query also validates port characteristics (link width and speed)<br>\r
927 based on the peer port. This checking is done when the port<br>\r
928 queried is a switch port as it relies on combined routing<br>\r
929 (an initial LID route with directed routing to the peer) which<br>\r
930 can only be done on a switch. This peer port validation feature<br>\r
931 of query op requires LID routing to be functioning in the subnet.<br>\r
932 <br>\r
933 <br>\r
934 COMMON OPTIONS<br>\r
935 Most OFED diagnostics take the following common flags. The exact list<br>\r
936 of supported flags per utility can be found in the usage message and<br>\r
937 can be shown using the util_name -h syntax.<br>\r
938 <br>\r
939 # Debugging flags<br>\r
940 <br>\r
941 -d raise the IB debugging level.<br>\r
942 May be used several times (-ddd or -d -d -d).<br>\r
943 <br>\r
944 -e show send and receive errors (timeouts and others)<br>\r
945 <br>\r
946 -h show the usage message<br>\r
947 <br>\r
948 -v increase the application verbosity level.<br>\r
949 May be used several times (-vv or -v -v -v)<br>\r
950 <br>\r
951 -V show the version info.<br>\r
952 <br>\r
953 # Addressing flags<br>\r
954 <br>\r
955 -D use directed path address arguments. The path<br>\r
956 is a comma separated list of out ports.<br>\r
957 Examples:<br>\r
958 &quot;0&quot; # self port<br>\r
959 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
960 <br>\r
961 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
962 Example:<br>\r
963 &quot;0x08f1040023&quot;<br>\r
964 <br>\r
965 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
966 <br>\r
967 # Other common flags:<br>\r
968 <br>\r
969 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
970 <br>\r
971 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
972 <br>\r
973 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
974 <br>\r
975 Multiple CA/Multiple Port Support<br>\r
976 <br>\r
977 When no IB device or port is specified, the port to use is selected by<br>\r
978 the following criteria:<br>\r
979 <br>\r
980 1. the first port that is ACTIVE.<br>\r
981 <br>\r
982 2. if not found, the first port that is UP (physical link up).<br>\r
983 <br>\r
984 If a port and/or CA name is specified, the user request is attempted to<br>\r
985 be fulfilled, and will fail if it is not possible.<br>\r
986 <br>\r
987 <br>\r
988 EXAMPLES<br>\r
989 ibportstate 3 1 disable # by lid<br>\r
990 <br>\r
991 ibportstate -G 0x2C9000100D051 1 enable # by guid<br>\r
992 <br>\r
993 ibportstate -D 0 1 # (query) by direct route<br>\r
994 <br>\r
995 ibportstate 3 1 reset # by lid<br>\r
996 <br>\r
997 ibportstate 3 1 speed 1 # by lid<br>\r
998 <br>\r
999 <br>\r
1000 AUTHOR<br>\r
1001 Hal Rosenstock &lt;halr@voltaire.com&gt;<br>\r
1002 <br>\r
1003 <br>\r
1004 OFED October 19, 2006 IBPORTSTATE(8)</p>\r
1005 <p align="left"><br>\r
1006 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font></p>\r
1007 <h3 align="left">&nbsp;</h3>\r
1008 <h3 align="left"><a name="IBQUERYERRORS">IBQUERYERRORS</a>(8) OFED Diagnostics<br>\r
1009 &nbsp;</h3>\r
1010 <p align="left">NAME<br>\r
1011 ibqueryerrors - query and report non-zero IB port counters<br>\r
1012 <br>\r
1013 <br>\r
1014 SYNOPSIS<br>\r
1015 ibqueryerrors [-a -c -r -R -C &lt;ca_name&gt; -P &lt;ca_port&gt; -s<br>\r
1016 &lt;err1,err2,...&gt; -S &lt;switch_guid&gt; -D &lt;direct_route&gt; -d]<br>\r
1017 <br>\r
1018 <br>\r
1019 DESCRIPTION<br>\r
1020 ibqueryerrors reports the port counters of switches. This is simi-<br>\r
1021 lar to ibcheckerrors with the additional ability to filter out selected<br>\r
1022 errors, include the optional transmit and receive data counters, report<br>\r
1023 actions to remedy a non-zero count, and report full link information<br>\r
1024 for the link reported.<br>\r
1025 <br>\r
1026 <br>\r
1027 OPTIONS<br>\r
1028 -a Report an action to take. Some of the counters are not errors<br>\r
1029 in and of themselves. This reports some more information on<br>\r
1030 what the counters mean and what actions can/should be taken if<br>\r
1031 they are non-zero.<br>\r
1032 <br>\r
1033 -c Suppress some of the common &quot;side effect&quot; counters. These coun-<br>\r
1034 ters usually do not indicate an error condition and can be usu-<br>\r
1035 ally be safely ignored.<br>\r
1036 <br>\r
1037 -r Report the port information. This includes LID, port, external<br>\r
1038 port (if applicable), link speed setting, remote GUID, remote<br>\r
1039 port, remote external port (if applicable), and remote node<br>\r
1040 description information.<br>\r
1041 <br>\r
1042 -R Recalculate the ibnetdiscover information, ie do not use the<br>\r
1043 cached information. This option is slower but should be used if<br>\r
1044 the diag tools have not been used for some time or if there are<br>\r
1045 other reasons to believe that the fabric has changed.<br>\r
1046 <br>\r
1047 -s &lt;err1,err2,...&gt;<br>\r
1048 Suppress the errors listed in the comma separated list provided.<br>\r
1049 <br>\r
1050 -S &lt;switch_guid&gt;<br>\r
1051 Report results only for the switch specified. (hex format)<br>\r
1052 <br>\r
1053 -D &lt;direct_route&gt;<br>\r
1054 Report results only for the switch specified by the direct route<br>\r
1055 path.<br>\r
1056 <br>\r
1057 -d Include the optional transmit and receive data counters.<br>\r
1058 <br>\r
1059 -C &lt;ca_name&gt; use the specified ca_name for the search.<br>\r
1060 <br>\r
1061 -P &lt;ca_port&gt; use the specified ca_port for the search.<br>\r
1062 <br>\r
1063 AUTHOR<br>\r
1064 Ira Weiny &lt;weiny2@llnl.gov&gt;<br>\r
1065 <br>\r
1066 <br>\r
1067 OFED Jan 24, 2008 IBQUERYERRORS(8)</p>\r
1068 <p align="left"><br>\r
1069 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font></p>\r
1070 <h3 align="left">&nbsp;</h3>\r
1071 <h3 align="left"><a name="IBROUTE">IBROUTE</a>(8) OFED Diagnostics<br>\r
1072 &nbsp;</h3>\r
1073 <p align="left">NAME<br>\r
1074 ibroute - query InfiniBand switch forwarding tables<br>\r
1075 <br>\r
1076 <br>\r
1077 SYNOPSIS<br>\r
1078 ibroute [-d(ebug)] [-a(ll)] [-n(o_dests)] [-v(erbose)] [-D(irect)]<br>\r
1079 [-G(uid)] [-M(ulticast)] [-s smlid] [-C ca_name] [-P ca_port] [-t(ime-<br>\r
1080 out) timeout_ms] [-V(ersion)] [-h(elp)] [&lt;dest dr_path|lid|guid&gt;<br>\r
1081 [&lt;startlid&gt; [&lt;endlid&gt;]]]<br>\r
1082 <br>\r
1083 <br>\r
1084 DESCRIPTION<br>\r
1085 ibroute uses SMPs to display the forwarding tables (unicast (LinearFor-<br>\r
1086 wardingTable or LFT) or multicast (MulticastForwardingTable or MFT))<br>\r
1087 for the specified switch LID and the optional lid (mlid) range. The<br>\r
1088 default range is all valid entries in the range 1...FDBTop.<br>\r
1089 <br>\r
1090 <br>\r
1091 OPTIONS<br>\r
1092 -a, --all<br>\r
1093 show all lids in range, even invalid entries<br>\r
1094 <br>\r
1095 -n, --no_dests<br>\r
1096 do not try to resolve destinations<br>\r
1097 <br>\r
1098 -M, --Multicast<br>\r
1099 show multicast forwarding tables In this case, the range parame-<br>\r
1100 ters are specifying the mlid range.<br>\r
1101 <br>\r
1102 <br>\r
1103 COMMON OPTIONS<br>\r
1104 Most OFED diagnostics take the following common flags. The exact list<br>\r
1105 of supported flags per utility can be found in the usage message and<br>\r
1106 can be shown using the util_name -h syntax.<br>\r
1107 <br>\r
1108 # Debugging flags<br>\r
1109 <br>\r
1110 -d raise the IB debugging level.<br>\r
1111 May be used several times (-ddd or -d -d -d).<br>\r
1112 <br>\r
1113 -e show send and receive errors (timeouts and others)<br>\r
1114 <br>\r
1115 -h show the usage message<br>\r
1116 <br>\r
1117 -v increase the application verbosity level.<br>\r
1118 May be used several times (-vv or -v -v -v)<br>\r
1119 <br>\r
1120 -V show the version info.<br>\r
1121 <br>\r
1122 # Addressing flags<br>\r
1123 <br>\r
1124 -D use directed path address arguments. The path<br>\r
1125 is a comma separated list of out ports.<br>\r
1126 Examples:<br>\r
1127 &quot;0&quot; # self port<br>\r
1128 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
1129 <br>\r
1130 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1131 Example:<br>\r
1132 &quot;0x08f1040023&quot;<br>\r
1133 <br>\r
1134 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1135 <br>\r
1136 # Other common flags:<br>\r
1137 <br>\r
1138 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1139 <br>\r
1140 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1141 <br>\r
1142 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1143 <br>\r
1144 Multiple CA/Multiple Port Support<br>\r
1145 <br>\r
1146 When no IB device or port is specified, the port to use is selected by<br>\r
1147 the following criteria:<br>\r
1148 <br>\r
1149 1. the first port that is ACTIVE.<br>\r
1150 <br>\r
1151 2. if not found, the first port that is UP (physical link up).<br>\r
1152 <br>\r
1153 If a port and/or CA name is specified, the user request is attempted to<br>\r
1154 be fulfilled, and will fail if it is not possible.<br>\r
1155 <br>\r
1156 <br>\r
1157 EXAMPLES<br>\r
1158 Unicast examples<br>\r
1159 <br>\r
1160 ibroute 4 # dump all lids with valid out ports of switch with lid 4<br>\r
1161 <br>\r
1162 ibroute -a 4 # same, but dump all lids, even with invalid out ports<br>\r
1163 <br>\r
1164 ibroute -n 4 # simple dump format - no destination resolution<br>\r
1165 <br>\r
1166 ibroute 4 10 # dump lids starting from 10 (up to FDBTop)<br>\r
1167 <br>\r
1168 ibroute 4 0x10 0x20 # dump lid range<br>\r
1169 <br>\r
1170 ibroute -G 0x08f1040023 # resolve switch by GUID<br>\r
1171 <br>\r
1172 ibroute -D 0,1 # resolve switch by direct path<br>\r
1173 <br>\r
1174 <br>\r
1175 Multicast examples<br>\r
1176 <br>\r
1177 ibroute -M 4 # dump all non empty mlids of switch with lid 4<br>\r
1178 <br>\r
1179 ibroute -M 4 0xc010 0xc020 # same, but with range<br>\r
1180 <br>\r
1181 ibroute -M -n 4 # simple dump format<br>\r
1182 <br>\r
1183 <br>\r
1184 SEE ALSO<br>\r
1185 ibtracert(8)<br>\r
1186 <br>\r
1187 AUTHOR<br>\r
1188 Hal Rosenstock &lt;halr@voltaire.com&gt;<br>\r
1189 <br>\r
1190 <br>\r
1191 OFED July 25, 2006 IBROUTE(8)</p>\r
1192 <p align="left"><br>\r
1193 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font><br>\r
1194 &nbsp;</p>\r
1195 <p align="left">&nbsp;</p>\r
1196 <BLOCKQUOTE></BLOCKQUOTE>\r
1197 <h3 align="left"><a name="ibv_devinfo"></a><br>\r
1198 ibv_devinfo - print CA (Channel Adapter) attributes</h3>\r
1199 <p align="left">usage: ibv_devinfo&nbsp; [options]<br>\r
1200 <br>\r
1201 Options:<br>\r
1202 &nbsp;&nbsp; -d, --ib-dev=&lt;dev&gt; use IB device &lt;dev&gt; (default: first device \r
1203 found)<br>\r
1204 &nbsp;&nbsp;&nbsp; -i, --ib-port=&lt;port&gt; use port &lt;port&gt; of IB device (default: \r
1205 all ports)<br>\r
1206 &nbsp;&nbsp;&nbsp; -l, --list print only the IB devices names<br>\r
1207 &nbsp;&nbsp;&nbsp; -v, --verbose print all the attributes of the IB device(s)<br>\r
1208 <br>\r
1209 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font><br>\r
1210 &nbsp;</p>\r
1211 <BLOCKQUOTE></BLOCKQUOTE>\r
1212 <h3 align="left"><a name="ibstat"></a><br>\r
1213 IBSTAT(8) OFED Diagnostics</h3>\r
1214 <p align="left">NAME<br>\r
1215 ibstat - query basic status of InfiniBand device(s)<br>\r
1216 <br>\r
1217 <br>\r
1218 SYNOPSIS<br>\r
1219 ibstat [-d(ebug)] [-l(ist_of_cas)] [-s(hort)] [-p(ort_list)] [-V(ersion)] [-h] &lt;ca_name&gt; \r
1220 [portnum]<br>\r
1221 <br>\r
1222 <br>\r
1223 DESCRIPTION<br>\r
1224 ibstat is a binary which displays basic information obtained from the<br>\r
1225 local IB driver. Output includes LID, SMLID, port state, link width<br>\r
1226 active, and port physical state.<br>\r
1227 <br>\r
1228 It is similar to the ibstatus utility but implemented as a binary<br>\r
1229 rather than a script. It has options to list CAs and/or ports and dis-<br>\r
1230 plays more information than ibstatus.<br>\r
1231 <br>\r
1232 <br>\r
1233 OPTIONS<br>\r
1234 -l, --list_of_cas<br>\r
1235 list all IB devices<br>\r
1236 <br>\r
1237 -s, --short<br>\r
1238 short output<br>\r
1239 <br>\r
1240 -p, --port_list<br>\r
1241 show port list<br>\r
1242 <br>\r
1243 ca_name<br>\r
1244 InfiniBand device name<br>\r
1245 <br>\r
1246 portnum<br>\r
1247 port number of InfiniBand device<br>\r
1248 <br>\r
1249 <br>\r
1250 COMMON OPTIONS<br>\r
1251 Most OFED diagnostics take the following common flags. The exact list<br>\r
1252 of supported flags per utility can be found in the usage message and<br>\r
1253 can be shown using the util_name -h syntax.<br>\r
1254 <br>\r
1255 # Debugging flags<br>\r
1256 <br>\r
1257 -d raise the IB debugging level.<br>\r
1258 May be used several times (-ddd or -d -d -d).<br>\r
1259 <br>\r
1260 -e show send and receive errors (timeouts and others)<br>\r
1261 <br>\r
1262 -h show the usage message<br>\r
1263 <br>\r
1264 -v increase the application verbosity level.<br>\r
1265 May be used several times (-vv or -v -v -v)<br>\r
1266 <br>\r
1267 -V show the version info.<br>\r
1268 <br>\r
1269 # Addressing flags<br>\r
1270 <br>\r
1271 -D use directed path address arguments. The path<br>\r
1272 is a comma separated list of out ports.<br>\r
1273 Examples:<br>\r
1274 &quot;0&quot; # self port<br>\r
1275 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
1276 <br>\r
1277 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1278 Example:<br>\r
1279 &quot;0x08f1040023&quot;<br>\r
1280 <br>\r
1281 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1282 <br>\r
1283 # Other common flags:<br>\r
1284 <br>\r
1285 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1286 <br>\r
1287 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1288 <br>\r
1289 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1290 <br>\r
1291 Multiple CA/Multiple Port Support<br>\r
1292 <br>\r
1293 When no IB device or port is specified, the port to use is selected by<br>\r
1294 the following criteria:<br>\r
1295 <br>\r
1296 1. the first port that is ACTIVE.<br>\r
1297 <br>\r
1298 2. if not found, the first port that is UP (physical link up).<br>\r
1299 <br>\r
1300 If a port and/or CA name is specified, the user request is attempted to<br>\r
1301 be fulfilled, and will fail if it is not possible.<br>\r
1302 <br>\r
1303 <br>\r
1304 EXAMPLES<br>\r
1305 ibstat # display status of all ports on all IB devices<br>\r
1306 <br>\r
1307 ibstat -l # list all IB devices<br>\r
1308 <br>\r
1309 ibstat -p # show port guids<br>\r
1310 <br>\r
1311 ibstat ibv_device0 2 # show status of port 2 of \92hca0\92<br>\r
1312 <br>\r
1313 <br>\r
1314 SEE ALSO<br>\r
1315 ibstatus(8)<br>\r
1316 <br>\r
1317 <br>\r
1318 AUTHOR<br>\r
1319 Hal Rosenstock &lt;halr@voltaire.com&gt;<br>\r
1320 <br>\r
1321 <br>\r
1322 OFED July 25, 2006 IBSTAT(8)<br>\r
1323 <br>\r
1324 <font color="#000000"><a href="#TOP">&lt;return-to-top&gt;</a></font><br>\r
1325 &nbsp;</p>\r
1326 <p align="left">&nbsp;</p>\r
1327 <h3 align="left"><a name="IBSYSSTAT">IBSYSSTAT</a>(8) OFED Diagnostics<br>\r
1328 &nbsp;</h3>\r
1329 <p align="left">NAME<br>\r
1330 ibsysstat - system status on an InfiniBand address<br>\r
1331 <br>\r
1332 <br>\r
1333 SYNOPSIS<br>\r
1334 ibsysstat [-d(ebug)] [-e(rr_show)] [-v(erbose)] [-G(uid)] [-C ca_name]<br>\r
1335 [-P ca_port] [-s smlid] [-t(imeout) timeout_ms] [-V(ersion)] [-o oui]<br>\r
1336 [-S(erver)] [-h(elp)] &lt;dest lid | guid&gt; [&lt;op&gt;]<br>\r
1337 <br>\r
1338 <br>\r
1339 DESCRIPTION<br>\r
1340 ibsysstat uses vendor mads to validate connectivity between IB nodes<br>\r
1341 and obtain other information about the IB node. ibsysstat is run as<br>\r
1342 client/server. Default is to run as client.<br>\r
1343 <br>\r
1344 <br>\r
1345 OPTIONS<br>\r
1346 Current supported operations:<br>\r
1347 ping - verify connectivity to server (default)<br>\r
1348 host - obtain host information from server<br>\r
1349 cpu - obtain cpu information from server<br>\r
1350 <br>\r
1351 -o, --oui<br>\r
1352 use specified OUI number to multiplex vendor mads<br>\r
1353 <br>\r
1354 -S, --Server<br>\r
1355 start in server mode (do not return)<br>\r
1356 <br>\r
1357 <br>\r
1358 <br>\r
1359 COMMON OPTIONS<br>\r
1360 Most OFED diagnostics take the following common flags. The exact list<br>\r
1361 of supported flags per utility can be found in the usage message and<br>\r
1362 can be shown using the util_name -h syntax.<br>\r
1363 <br>\r
1364 # Debugging flags<br>\r
1365 <br>\r
1366 -d raise the IB debugging level.<br>\r
1367 May be used several times (-ddd or -d -d -d).<br>\r
1368 <br>\r
1369 -e show send and receive errors (timeouts and others)<br>\r
1370 <br>\r
1371 -h show the usage message<br>\r
1372 <br>\r
1373 -v increase the application verbosity level.<br>\r
1374 May be used several times (-vv or -v -v -v)<br>\r
1375 <br>\r
1376 -V show the version info.<br>\r
1377 <br>\r
1378 # Addressing flags<br>\r
1379 <br>\r
1380 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1381 Example:<br>\r
1382 &quot;0x08f1040023&quot;<br>\r
1383 <br>\r
1384 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1385 <br>\r
1386 # Other common flags:<br>\r
1387 <br>\r
1388 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1389 <br>\r
1390 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1391 <br>\r
1392 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1393 <br>\r
1394 Multiple CA/Multiple Port Support<br>\r
1395 <br>\r
1396 When no IB device or port is specified, the port to use is selected by<br>\r
1397 the following criteria:<br>\r
1398 <br>\r
1399 1. the first port that is ACTIVE.<br>\r
1400 <br>\r
1401 2. if not found, the first port that is UP (physical link up).<br>\r
1402 <br>\r
1403 If a port and/or CA name is specified, the user request is attempted to<br>\r
1404 be fulfilled, and will fail if it is not possible.<br>\r
1405 <br>\r
1406 <br>\r
1407 AUTHOR<br>\r
1408 Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;halr@voltaire.com&gt;<br>\r
1409 <br>\r
1410 <br>\r
1411 OFED August 11, 2006 IBSYSSTAT(8)</p>\r
1412 <p align="left"><br>\r
1413 <a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></p>\r
1414 <h3 align="left">&nbsp;</h3>\r
1415 <h3 align="left"><a name="IBTRACERT">IBTRACERT</a>(8) OFED Diagnostics</h3>\r
1416 <p align="left"><br>\r
1417 NAME<br>\r
1418 ibtracert- trace InfiniBand path<br>\r
1419 <br>\r
1420 <br>\r
1421 SYNOPSIS<br>\r
1422 ibtracert [-d(ebug)] [-v(erbose)] [-D(irect)] [-G(uids)] [-n(o_info)]<br>\r
1423 [-m mlid] [-s smlid] [-C ca_name] [-P ca_port] [-t(imeout) timeout_ms]<br>\r
1424 [-V(ersion)] [--node-name--map &lt;node-name-map&gt;] [-h(elp)] [&lt;dest<br>\r
1425 dr_path|lid|guid&gt; [&lt;startlid&gt; [&lt;endlid&gt;]]]<br>\r
1426 <br>\r
1427 <br>\r
1428 DESCRIPTION<br>\r
1429 ibtracert uses SMPs to trace the path from a source GID/LID to a desti-<br>\r
1430 nation GID/LID. Each hop along the path is displayed until the destina-<br>\r
1431 tion is reached or a hop does not respond. By using the -m option, mul-<br>\r
1432 ticast path tracing can be performed between source and destination<br>\r
1433 nodes.<br>\r
1434 <br>\r
1435 <br>\r
1436 OPTIONS<br>\r
1437 -n, --no_info<br>\r
1438 simple format; don\92t show additional information<br>\r
1439 <br>\r
1440 -m show the multicast trace of the specified mlid<br>\r
1441 <br>\r
1442 --node-name-map &lt;node-name-map&gt;<br>\r
1443 Specify a node name map. The node name map file maps GUIDs to<br>\r
1444 more user friendly names. See ibnetdiscover(8) for node name<br>\r
1445 map file format.<br>\r
1446 <br>\r
1447 <br>\r
1448 COMMON OPTIONS<br>\r
1449 Most OFED diagnostics take the following common flags. The exact list<br>\r
1450 of supported flags per utility can be found in the usage message and<br>\r
1451 can be shown using the util_name -h syntax.<br>\r
1452 <br>\r
1453 # Debugging flags<br>\r
1454 <br>\r
1455 -d raise the IB debugging level.<br>\r
1456 May be used several times (-ddd or -d -d -d).<br>\r
1457 <br>\r
1458 -h show the usage message<br>\r
1459 <br>\r
1460 -v increase the application verbosity level.<br>\r
1461 May be used several times (-vv or -v -v -v)<br>\r
1462 <br>\r
1463 -V show the version info.<br>\r
1464 <br>\r
1465 # Addressing flags<br>\r
1466 <br>\r
1467 -D use directed path address arguments. The path<br>\r
1468 is a comma separated list of out ports.<br>\r
1469 Examples:<br>\r
1470 &quot;0&quot; # self port<br>\r
1471 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
1472 <br>\r
1473 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1474 Example:<br>\r
1475 &quot;0x08f1040023&quot;<br>\r
1476 <br>\r
1477 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1478 <br>\r
1479 # Other common flags:<br>\r
1480 <br>\r
1481 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1482 <br>\r
1483 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1484 <br>\r
1485 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1486 <br>\r
1487 Multiple CA/Multiple Port Support<br>\r
1488 <br>\r
1489 When no IB device or port is specified, the port to use is selected by<br>\r
1490 the following criteria:<br>\r
1491 <br>\r
1492 1. the first port that is ACTIVE.<br>\r
1493 <br>\r
1494 2. if not found, the first port that is UP (physical link up).<br>\r
1495 <br>\r
1496 If a port and/or CA name is specified, the user request is attempted to<br>\r
1497 be fulfilled, and will fail if it is not possible.<br>\r
1498 <br>\r
1499 <br>\r
1500 EXAMPLES<br>\r
1501 Unicast examples<br>\r
1502 <br>\r
1503 ibtracert 4 16 # show path between lids 4 and 16<br>\r
1504 <br>\r
1505 ibtracert -n 4 16 # same, but using simple output format<br>\r
1506 <br>\r
1507 ibtracert -G 0x8f1040396522d 0x002c9000100d051 # use guid addresses<br>\r
1508 <br>\r
1509 <br>\r
1510 Multicast example<br>\r
1511 <br>\r
1512 ibtracert -m 0xc000 4 16 # show multicast path of mlid 0xc000<br>\r
1513 between lids 4 and 16<br>\r
1514 <br>\r
1515 <br>\r
1516 SEE ALSO<br>\r
1517 ibroute(8)<br>\r
1518 <br>\r
1519 <br>\r
1520 AUTHOR<br>\r
1521 &nbsp;&nbsp;&nbsp; Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;<a href="mailto:halr@voltaire.com">halr@voltaire.com</a>&gt;<br>\r
1522 <br>\r
1523 &nbsp;&nbsp;&nbsp; Ira Weiny&nbsp;&nbsp;&nbsp; &lt;weiny2@llnl.gov&gt;<br>\r
1524 <br>\r
1525 OFED April 14, 2007 IBTRACERT(8)</p>\r
1526 <p align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></p>\r
1527 <h3 align="left">&nbsp;</h3>\r
1528 <h3 align="left"><a name="PERFQUERY">PERFQUERY</a>(8) OFED Diagnostics</h3>\r
1529 <p align="left"><br>\r
1530 NAME<br>\r
1531 perfquery - query InfiniBand port counters<br>\r
1532 <br>\r
1533 <br>\r
1534 SYNOPSIS<br>\r
1535 perfquery [-d(ebug)] [-G(uid)] [-x|--extended] [-X|--xmtsl]<br>\r
1536 [-S|--rcvsl] [-a(ll_ports)] [-l(oop_ports)] [-r(eset_after_read)]<br>\r
1537 [-R(eset_only)] [-C ca_name] [-P ca_port] [-t(imeout) timeout_ms]<br>\r
1538 [-V(ersion)] [-h(elp)] [&lt;lid|guid&gt; [[port] [reset_mask]]]<br>\r
1539 <br>\r
1540 <br>\r
1541 DESCRIPTION<br>\r
1542 perfquery uses PerfMgt GMPs to obtain the PortCounters (basic perfor-<br>\r
1543 mance and error counters), PortExtendedCounters, PortXmitDataSL, or<br>\r
1544 PortRcvDataSL from the PMA at the node/port specified. Optionally shows<br>\r
1545 aggregated counters for all ports of node. Also, optionally, reset<br>\r
1546 after read, or only reset counters.<br>\r
1547 <br>\r
1548 Note: In PortCounters, PortCountersExtended, PortXmitDataSL, and PortR-<br>\r
1549 cvDataSL, components that represent Data (e.g. PortXmitData and PortR-<br>\r
1550 cvData) indicate octets divided by 4 rather than just octets.<br>\r
1551 <br>\r
1552 Note: Inputting a port of 255 indicates an operation be performed on<br>\r
1553 all ports.<br>\r
1554 <br>\r
1555 <br>\r
1556 OPTIONS<br>\r
1557 -x, --extended<br>\r
1558 show extended port counters rather than (basic) port counters.<br>\r
1559 Note that extended port counters attribute is optional.<br>\r
1560 <br>\r
1561 -X, --xmtsl<br>\r
1562 show transmit data SL counter. This is an optional counter for<br>\r
1563 QoS.<br>\r
1564 <br>\r
1565 -S, --rcvsl<br>\r
1566 show receive data SL counter. This is an optional counter for<br>\r
1567 QoS.<br>\r
1568 <br>\r
1569 -a, --all_ports<br>\r
1570 show aggregated counters for all ports of the destination lid or<br>\r
1571 reset all counters for all ports. If the destination lid does<br>\r
1572 not support the AllPortSelect flag, all ports will be iterated<br>\r
1573 through to emulate AllPortSelect behavior.<br>\r
1574 <br>\r
1575 -l, --loop_ports<br>\r
1576 If all ports are selected by the user (either through the -a<br>\r
1577 option or port 255) iterate through each port rather than doing<br>\r
1578 than aggregate operation.<br>\r
1579 <br>\r
1580 -r, --reset_after_read<br>\r
1581 reset counters after read<br>\r
1582 <br>\r
1583 -R, --Reset_only<br>\r
1584 only reset counters<br>\r
1585 <br>\r
1586 <br>\r
1587 COMMON OPTIONS<br>\r
1588 Most OFED diagnostics take the following common flags. The exact list<br>\r
1589 of supported flags per utility can be found in the usage message and<br>\r
1590 can be shown using the util_name -h syntax.<br>\r
1591 <br>\r
1592 # Debugging flags<br>\r
1593 <br>\r
1594 -d raise the IB debugging level.<br>\r
1595 May be used several times (-ddd or -d -d -d).<br>\r
1596 <br>\r
1597 -e show send and receive errors (timeouts and others)<br>\r
1598 <br>\r
1599 -h show the usage message<br>\r
1600 <br>\r
1601 -v increase the application verbosity level.<br>\r
1602 May be used several times (-vv or -v -v -v)<br>\r
1603 <br>\r
1604 -V show the version info.<br>\r
1605 <br>\r
1606 # Addressing flags<br>\r
1607 <br>\r
1608 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1609 Example:<br>\r
1610 &quot;0x08f1040023&quot;<br>\r
1611 <br>\r
1612 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1613 <br>\r
1614 # Other common flags:<br>\r
1615 <br>\r
1616 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1617 <br>\r
1618 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1619 <br>\r
1620 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1621 <br>\r
1622 Multiple CA/Multiple Port Support<br>\r
1623 <br>\r
1624 When no IB device or port is specified, the port to use is selected by<br>\r
1625 the following criteria:<br>\r
1626 <br>\r
1627 1. the first port that is ACTIVE.<br>\r
1628 <br>\r
1629 2. if not found, the first port that is UP (physical link up).<br>\r
1630 <br>\r
1631 If a port and/or CA name is specified, the user request is attempted to<br>\r
1632 be fulfilled, and will fail if it is not possible.<br>\r
1633 <br>\r
1634 <br>\r
1635 EXAMPLES<br>\r
1636 perfquery # read local port performance counters<br>\r
1637 <br>\r
1638 perfquery 32 1 # read performance counters from lid 32, port 1<br>\r
1639 <br>\r
1640 perfquery -x 32 1 # read extended performance counters from lid 32, port 1<br>\r
1641 <br>\r
1642 perfquery -a 32 # read perf counters from lid 32, all ports<br>\r
1643 <br>\r
1644 perfquery -r 32 1 # read performance counters and reset<br>\r
1645 <br>\r
1646 perfquery -x -r 32 1 # read extended performance counters and reset<br>\r
1647 <br>\r
1648 perfquery -R 0x20 1 # reset performance counters of port 1 only<br>\r
1649 <br>\r
1650 perfquery -x -R 0x20 1 # reset extended performance counters of port 1 only<br>\r
1651 <br>\r
1652 perfquery -R -a 32 # reset performance counters of all ports<br>\r
1653 <br>\r
1654 perfquery -R 32 2 0x0fff # reset only error counters of port 2<br>\r
1655 <br>\r
1656 perfquery -R 32 2 0xf000 # reset only non-error counters of port 2<br>\r
1657 <br>\r
1658 <br>\r
1659 AUTHOR<br>\r
1660 Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;halr@voltaire.com&gt;<br>\r
1661 <br>\r
1662 <br>\r
1663 OFED March 10, 2009 PERFQUERY(8)</p>\r
1664 <p align="left"><br>\r
1665 <a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></p>\r
1666 <h3 align="left">&nbsp;</h3>\r
1667 <h3 align="left"><a name="SAQUERY">SAQUERY</a>(8) OFED Diagnostics</h3>\r
1668 <p align="left"><br>\r
1669 NAME<br>\r
1670 saquery - query InfiniBand subnet administration attributes<br>\r
1671 <br>\r
1672 <br>\r
1673 SYNOPSIS<br>\r
1674 saquery [-h] [-d] [-p] [-N] [--list | -D] [-S] [-I] [-L] [-l] [-G] [-O]<br>\r
1675 [-U] [-c] [-s] [-g] [-m] [-x] [-C ca_name] [-P ca_port] [--smkey val]<br>\r
1676 [-t(imeout) &lt;msec&gt;] [--src-to-dst &lt;src:dst&gt;] [--sgid-to-dgid<br>\r
1677 &lt;sgid-dgid&gt;] [--node-name-map &lt;node-name-map&gt;] [&lt;name&gt; | &lt;lid&gt; |<br>\r
1678 &lt;guid&gt;]<br>\r
1679 <br>\r
1680 <br>\r
1681 DESCRIPTION<br>\r
1682 saquery issues the selected SA query. Node records are queried by<br>\r
1683 default.<br>\r
1684 <br>\r
1685 <br>\r
1686 OPTIONS<br>\r
1687 -p get PathRecord info<br>\r
1688 <br>\r
1689 -N get NodeRecord info<br>\r
1690 <br>\r
1691 --list | -D<br>\r
1692 get NodeDescriptions of CAs only<br>\r
1693 <br>\r
1694 -S get ServiceRecord info<br>\r
1695 <br>\r
1696 -I get InformInfoRecord (subscription) info<br>\r
1697 <br>\r
1698 -L return the Lids of the name specified<br>\r
1699 <br>\r
1700 -l return the unique Lid of the name specified<br>\r
1701 <br>\r
1702 -G return the Guids of the name specified<br>\r
1703 <br>\r
1704 -O return the name for the Lid specified<br>\r
1705 <br>\r
1706 -U return the name for the Guid specified<br>\r
1707 <br>\r
1708 -c get the SA\92s class port info<br>\r
1709 <br>\r
1710 -s return the PortInfoRecords with isSM or isSMdisabled capability<br>\r
1711 mask bit on<br>\r
1712 <br>\r
1713 -g get multicast group info<br>\r
1714 <br>\r
1715 -m get multicast member info. If a group is specified, limit the<br>\r
1716 output to the group specified and print one line containing only<br>\r
1717 the GUID and node description for each entry. Example: saquery<br>\r
1718 -m 0xc000<br>\r
1719 <br>\r
1720 -x get LinkRecord info<br>\r
1721 <br>\r
1722 --src-to-dst<br>\r
1723 get a PathRecord for &lt;src:dst&gt; where src and dst are either node<br>\r
1724 names or LIDs<br>\r
1725 <br>\r
1726 --sgid-to-dgid<br>\r
1727 get a PathRecord for sgid to dgid where both GIDs are in an IPv6<br>\r
1728 format acceptable to inet_pton(3).<br>\r
1729 <br>\r
1730 -C &lt;ca_name&gt;<br>\r
1731 use the specified ca_name.<br>\r
1732 <br>\r
1733 -P &lt;ca_port&gt;<br>\r
1734 use the specified ca_port.<br>\r
1735 <br>\r
1736 --smkey &lt;val&gt;<br>\r
1737 use SM_Key value for the query. Will be used only with &quot;trusted&quot;<br>\r
1738 queries. If non-numeric value (like \92x\92) is specified then<br>\r
1739 saquery will prompt for a value.<br>\r
1740 <br>\r
1741 -t, -timeout &lt;msec&gt;<br>\r
1742 Specify SA query response timeout in milliseconds. Default is<br>\r
1743 100 milliseconds. You may want to use this option if IB_TIMEOUT<br>\r
1744 is indicated.<br>\r
1745 <br>\r
1746 --node-name-map &lt;node-name-map&gt;<br>\r
1747 Specify a node name map. The node name map file maps GUIDs to<br>\r
1748 more user friendly names. See ibnetdiscover(8) for node name<br>\r
1749 map file format. Only used with the -O and -U options.<br>\r
1750 <br>\r
1751 Supported query names (and aliases):<br>\r
1752 ClassPortInfo (CPI)<br>\r
1753 NodeRecord (NR) [lid]<br>\r
1754 PortInfoRecord (PIR) [[lid]/[port]]<br>\r
1755 SL2VLTableRecord (SL2VL) [[lid]/[in_port]/[out_port]]<br>\r
1756 PKeyTableRecord (PKTR) [[lid]/[port]/[block]]<br>\r
1757 VLArbitrationTableRecord (VLAR) [[lid]/[port]/[block]]<br>\r
1758 InformInfoRecord (IIR)<br>\r
1759 LinkRecord (LR) [[from_lid]/[from_port]] [[to_lid]/[to_port]]<br>\r
1760 ServiceRecord (SR)<br>\r
1761 PathRecord (PR)<br>\r
1762 MCMemberRecord (MCMR)<br>\r
1763 LFTRecord (LFTR) [[lid]/[block]]<br>\r
1764 MFTRecord (MFTR) [[mlid]/[position]/[block]]<br>\r
1765 <br>\r
1766 -d enable debugging<br>\r
1767 <br>\r
1768 -h show help<br>\r
1769 <br>\r
1770 <br>\r
1771 AUTHORS<br>\r
1772 Ira Weiny &lt;weiny2@llnl.gov&gt;<br>\r
1773 <br>\r
1774 Hal Rosenstock &lt;halr@voltaire.com&gt;<br>\r
1775 <br>\r
1776 <br>\r
1777 OFED October 19, 2008 SAQUERY(8)</p>\r
1778 <p align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></p>\r
1779 <p align="left">&nbsp;</p>\r
1780 <h3 align="left"><a name="SMINFO">SMINFO</a>(8) OFED Diagnostics</h3>\r
1781 <p align="left"><br>\r
1782 NAME<br>\r
1783 sminfo - query InfiniBand SMInfo attribute<br>\r
1784 <br>\r
1785 <br>\r
1786 SYNOPSIS<br>\r
1787 sminfo [-d(ebug)] [-e(rr_show)] -s state -p prio -a activity<br>\r
1788 [-D(irect)] [-G(uid)] [-C ca_name] [-P ca_port] [-t(imeout) time-<br>\r
1789 out_ms] [-V(ersion)] [-h(elp)] sm_lid | sm_dr_path [modifier]<br>\r
1790 <br>\r
1791 <br>\r
1792 DESCRIPTION<br>\r
1793 Optionally set and display the output of a sminfo query in human read-<br>\r
1794 able format. The target SM is the one listed in the local port info, or<br>\r
1795 the SM specified by the optional SM lid or by the SM direct routed<br>\r
1796 path.<br>\r
1797 <br>\r
1798 Note: using sminfo for any purposes other then simple query may be very<br>\r
1799 dangerous, and may result in a malfunction of the target SM.<br>\r
1800 <br>\r
1801 <br>\r
1802 OPTIONS<br>\r
1803 -s set SM state<br>\r
1804 0 - not active<br>\r
1805 1 - discovering<br>\r
1806 2 - standby<br>\r
1807 3 - master<br>\r
1808 <br>\r
1809 -p set priority (0-15)<br>\r
1810 <br>\r
1811 -a set activity count<br>\r
1812 <br>\r
1813 <br>\r
1814 COMMON OPTIONS<br>\r
1815 Most OFED diagnostics take the following common flags. The exact list<br>\r
1816 of supported flags per utility can be found in the usage message and<br>\r
1817 can be shown using the util_name -h syntax.<br>\r
1818 <br>\r
1819 # Debugging flags<br>\r
1820 <br>\r
1821 -d raise the IB debugging level.<br>\r
1822 May be used several times (-ddd or -d -d -d).<br>\r
1823 <br>\r
1824 -e show send and receive errors (timeouts and others)<br>\r
1825 <br>\r
1826 -h show the usage message<br>\r
1827 <br>\r
1828 -v increase the application verbosity level.<br>\r
1829 May be used several times (-vv or -v -v -v)<br>\r
1830 <br>\r
1831 -V show the version info.<br>\r
1832 <br>\r
1833 # Addressing flags<br>\r
1834 <br>\r
1835 -D use directed path address arguments. The path<br>\r
1836 is a comma separated list of out ports.<br>\r
1837 Examples:<br>\r
1838 &quot;0&quot; # self port<br>\r
1839 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
1840 <br>\r
1841 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1842 Example:<br>\r
1843 &quot;0x08f1040023&quot;<br>\r
1844 <br>\r
1845 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1846 <br>\r
1847 # Other common flags:<br>\r
1848 <br>\r
1849 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1850 <br>\r
1851 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1852 <br>\r
1853 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1854 <br>\r
1855 Multiple CA/Multiple Port Support<br>\r
1856 <br>\r
1857 When no IB device or port is specified, the port to use is selected by<br>\r
1858 the following criteria:<br>\r
1859 <br>\r
1860 1. the first port that is ACTIVE.<br>\r
1861 <br>\r
1862 2. if not found, the first port that is UP (physical link up).<br>\r
1863 <br>\r
1864 If a port and/or CA name is specified, the user request is attempted to<br>\r
1865 be fulfilled, and will fail if it is not possible.<br>\r
1866 <br>\r
1867 <br>\r
1868 EXAMPLES<br>\r
1869 sminfo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; # local port´s sminfo<br>\r
1870 <br>\r
1871 sminfo 32&nbsp;&nbsp;&nbsp;&nbsp; # show sminfo of lid 32<br>\r
1872 <br>\r
1873 sminfo -G 0x8f1040023&nbsp;&nbsp;&nbsp;&nbsp; # same but using guid address<br>\r
1874 <br>\r
1875 <br>\r
1876 SEE ALSO<br>\r
1877 smpdump(8)<br>\r
1878 <br>\r
1879 <br>\r
1880 AUTHOR<br>\r
1881 Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;halr@voltaire.com&gt;<br>\r
1882 <br>\r
1883 OFED July 25, 2006 SMINFO(8)</p>\r
1884 <p align="left"><br>\r
1885 <a href="#TOP"><font color="#000000">&lt;<b>return-to-top</b>&gt;</font></a></p>\r
1886 <h3 align="left">&nbsp;</h3>\r
1887 <h3 align="left"><a name="SMPDUMP">SMPDUMP</a>(8) OFED Diagnostics</h3>\r
1888 <p align="left"><br>\r
1889 NAME<br>\r
1890 smpdump - dump InfiniBand subnet management attributes<br>\r
1891 <br>\r
1892 <br>\r
1893 SYNOPSIS<br>\r
1894 smpdump [-s(ring)] [-D(irect)] [-C ca_name] [-P ca_port] [-t(imeout)<br>\r
1895 timeout_ms] [-V(ersion)] [-h(elp)] &lt;dlid|dr_path&gt; &lt;attr&gt; [mod]<br>\r
1896 <br>\r
1897 <br>\r
1898 DESCRIPTION<br>\r
1899 smpdump is a general purpose SMP utility which gets SM attributes from<br>\r
1900 a specified SMA. The result is dumped in hex by default.<br>\r
1901 <br>\r
1902 <br>\r
1903 OPTIONS<br>\r
1904 attr IBA attribute ID for SM attribute<br>\r
1905 <br>\r
1906 mod IBA modifier for SM attribute<br>\r
1907 <br>\r
1908 <br>\r
1909 COMMON OPTIONS<br>\r
1910 Most OFED diagnostics take the following common flags. The exact list<br>\r
1911 of supported flags per utility can be found in the usage message and<br>\r
1912 can be shown using the util_name -h syntax.<br>\r
1913 <br>\r
1914 # Debugging flags<br>\r
1915 <br>\r
1916 -d raise the IB debugging level.<br>\r
1917 May be used several times (-ddd or -d -d -d).<br>\r
1918 <br>\r
1919 -e show send and receive errors (timeouts and others)<br>\r
1920 <br>\r
1921 -h show the usage message<br>\r
1922 <br>\r
1923 -v increase the application verbosity level.<br>\r
1924 May be used several times (-vv or -v -v -v)<br>\r
1925 <br>\r
1926 -V show the version info.<br>\r
1927 <br>\r
1928 # Addressing flags<br>\r
1929 <br>\r
1930 -D use directed path address arguments. The path<br>\r
1931 is a comma separated list of out ports.<br>\r
1932 Examples:<br>\r
1933 &quot;0&quot; # self port<br>\r
1934 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
1935 <br>\r
1936 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
1937 Example:<br>\r
1938 &quot;0x08f1040023&quot;<br>\r
1939 <br>\r
1940 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
1941 <br>\r
1942 # Other common flags:<br>\r
1943 <br>\r
1944 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
1945 <br>\r
1946 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
1947 <br>\r
1948 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
1949 <br>\r
1950 Multiple CA/Multiple Port Support<br>\r
1951 <br>\r
1952 When no IB device or port is specified, the port to use is selected by<br>\r
1953 the following criteria:<br>\r
1954 <br>\r
1955 1. the first port that is ACTIVE.<br>\r
1956 <br>\r
1957 2. if not found, the first port that is UP (physical link up).<br>\r
1958 <br>\r
1959 If a port and/or CA name is specified, the user request is attempted to<br>\r
1960 be fulfilled, and will fail if it is not possible.<br>\r
1961 <br>\r
1962 <br>\r
1963 EXAMPLES<br>\r
1964 Direct Routed Examples<br>\r
1965 <br>\r
1966 smpdump -D 0,1,2,3,5 16 # NODE DESC<br>\r
1967 <br>\r
1968 smpdump -D 0,1,2 0x15 2 # PORT INFO, port 2<br>\r
1969 <br>\r
1970 LID Routed Examples<br>\r
1971 <br>\r
1972 smpdump 3 0x15 2 # PORT INFO, lid 3 port 2<br>\r
1973 <br>\r
1974 smpdump 0xa0 0x11 # NODE INFO, lid 0xa0<br>\r
1975 <br>\r
1976 <br>\r
1977 SEE ALSO<br>\r
1978 smpquery(8)<br>\r
1979 <br>\r
1980 <br>\r
1981 AUTHOR<br>\r
1982 Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;halr@voltaire.com&gt;<br>\r
1983 <br>\r
1984 <br>\r
1985 OFED July 25, 2006 SMPDUMP(8)</p>\r
1986 <p align="left"><br>\r
1987 <a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></p>\r
1988 <h3 align="left">&nbsp;</h3>\r
1989 <h3 align="left"><a name="SMPQUERY">SMPQUERY</a>(8) OFED Diagnostics</h3>\r
1990 <p align="left"><br>\r
1991 NAME<br>\r
1992 smpquery - query InfiniBand subnet management attributes<br>\r
1993 <br>\r
1994 <br>\r
1995 SYNOPSIS<br>\r
1996 smpquery [-d(ebug)] [-e(rr_show)] [-v(erbose)] [-D(irect)] [-G(uid)]<br>\r
1997 [-C ca_name] [-P ca_port] [-t(imeout) timeout_ms] [--node-name-map<br>\r
1998 node-name-map] [-V(ersion)] [-h(elp)] &lt;op&gt; &lt;dest dr_path|lid|guid&gt; [op<br>\r
1999 params]<br>\r
2000 <br>\r
2001 <br>\r
2002 DESCRIPTION<br>\r
2003 smpquery allows a basic subset of standard SMP queries including the<br>\r
2004 following: node info, node description, switch info, port info. Fields<br>\r
2005 are displayed in human readable format.<br>\r
2006 <br>\r
2007 <br>\r
2008 OPTIONS<br>\r
2009 Current supported operations and their parameters:<br>\r
2010 nodeinfo &lt;addr&gt;<br>\r
2011 nodedesc &lt;addr&gt;<br>\r
2012 portinfo &lt;addr&gt; [&lt;portnum&gt;] # default port is zero<br>\r
2013 switchinfo &lt;addr&gt;<br>\r
2014 pkeys &lt;addr&gt; [&lt;portnum&gt;]<br>\r
2015 sl2vl &lt;addr&gt; [&lt;portnum&gt;]<br>\r
2016 vlarb &lt;addr&gt; [&lt;portnum&gt;]<br>\r
2017 guids &lt;addr&gt;<br>\r
2018 <br>\r
2019 <br>\r
2020 --node-name-map &lt;node-name-map&gt;<br>\r
2021 Specify a node name map. The node name map file maps GUIDs to<br>\r
2022 more user friendly names. See ibnetdiscover(8) for node name<br>\r
2023 map file format.<br>\r
2024 <br>\r
2025 <br>\r
2026 COMMON OPTIONS<br>\r
2027 Most OFED diagnostics take the following common flags. The exact list<br>\r
2028 of supported flags per utility can be found in the usage message and<br>\r
2029 can be shown using the util_name -h syntax.<br>\r
2030 <br>\r
2031 # Debugging flags<br>\r
2032 <br>\r
2033 -d raise the IB debugging level.<br>\r
2034 May be used several times (-ddd or -d -d -d).<br>\r
2035 <br>\r
2036 -e show send and receive errors (timeouts and others)<br>\r
2037 <br>\r
2038 -h show the usage message<br>\r
2039 <br>\r
2040 -v increase the application verbosity level.<br>\r
2041 May be used several times (-vv or -v -v -v)<br>\r
2042 <br>\r
2043 -V show the version info.<br>\r
2044 <br>\r
2045 # Addressing flags<br>\r
2046 <br>\r
2047 -D use directed path address arguments. The path<br>\r
2048 is a comma separated list of out ports.<br>\r
2049 Examples:<br>\r
2050 &quot;0&quot; # self port<br>\r
2051 &quot;0,1,2,1,4&quot; # out via port 1, then 2, ...<br>\r
2052 <br>\r
2053 -c use combined route address arguments. The<br>\r
2054 address is a combination of a LID and a direct route path.<br>\r
2055 The LID specified is the DLID and the local LID is used<br>\r
2056 as the DrSLID.<br>\r
2057 <br>\r
2058 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
2059 Example:<br>\r
2060 &quot;0x08f1040023&quot;<br>\r
2061 <br>\r
2062 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
2063 <br>\r
2064 # Other common flags:<br>\r
2065 <br>\r
2066 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
2067 <br>\r
2068 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
2069 <br>\r
2070 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
2071 <br>\r
2072 Multiple CA/Multiple Port Support<br>\r
2073 <br>\r
2074 When no IB device or port is specified, the port to use is selected by<br>\r
2075 the following criteria:<br>\r
2076 <br>\r
2077 1. the first port that is ACTIVE.<br>\r
2078 <br>\r
2079 2. if not found, the first port that is UP (physical link up).<br>\r
2080 <br>\r
2081 If a port and/or CA name is specified, the user request is attempted to<br>\r
2082 be fulfilled, and will fail if it is not possible.<br>\r
2083 <br>\r
2084 <br>\r
2085 EXAMPLES<br>\r
2086 smpquery portinfo 3 1 # portinfo by lid, with port modifier<br>\r
2087 <br>\r
2088 smpquery -G switchinfo 0x2C9000100D051 1 # switchinfo by guid<br>\r
2089 <br>\r
2090 smpquery -D nodeinfo 0 # nodeinfo by direct route<br>\r
2091 <br>\r
2092 smpquery -c nodeinfo 6 0,12 # nodeinfo by combined route<br>\r
2093 <br>\r
2094 <br>\r
2095 SEE ALSO<br>\r
2096 smpdump(8)<br>\r
2097 <br>\r
2098 <br>\r
2099 AUTHOR<br>\r
2100 Hal Rosenstock &lt;halr@voltaire.com&gt;<br>\r
2101 <br>\r
2102 <br>\r
2103 OFED March 14, 2007 SMPQUERY(8)</p>\r
2104 <p align="left"><a href="#TOP"><font color="#000000">&lt;<b><font size="4">return-to-top</font></b>&gt;</font></a></p>\r
2105 <h3 align="left">&nbsp;</h3>\r
2106 <h3 align="left"><a name="VENDSTAT">VENDSTAT</a>(8) OFED Diagnostics</h3>\r
2107 <p align="left">NAME<br>\r
2108 vendstat - query InfiniBand vendor specific functions<br>\r
2109 <br>\r
2110 <br>\r
2111 SYNOPSIS<br>\r
2112 vendstat [-d(ebug)] [-G(uid)] [-N] [-w] [-i] [-c &lt;num,num&gt;] [-C ca_name] [-P \r
2113 ca_port] [-t(imeout) timeout_ms] [-V(ersion)] [-h(elp)] &lt;lid|guid&gt;<br>\r
2114 <br>\r
2115 <br>\r
2116 DESCRIPTION<br>\r
2117 vendstat uses vendor specific MADs to access beyond the IB spec vendor<br>\r
2118 specific functionality. Currently, there is support for Mellanox InfiniSwitch-III \r
2119 (IS3) and InfiniSwitch-IV (IS4).<br>\r
2120 <br>\r
2121 <br>\r
2122 OPTIONS<br>\r
2123 -N show IS3 general information.<br>\r
2124 <br>\r
2125 -w show IS3 port xmit wait counters.<br>\r
2126 <br>\r
2127 -i show IS4 counter group info.<br>\r
2128 <br>\r
2129 -c &lt;num,num&gt;<br>\r
2130 configure IS4 counter groups.<br>\r
2131 <br>\r
2132 Configure IS4 counter groups 0 and 1. Such configuration is not<br>\r
2133 persistent across IS4 reboot. First number is for counter group<br>\r
2134 0 and second is for counter group 1.<br>\r
2135 <br>\r
2136 Group 0 counter config values:<br>\r
2137 0 - PortXmitDataSL0-7<br>\r
2138 1 - PortXmitDataSL8-15<br>\r
2139 2 - PortRcvDataSL0-7<br>\r
2140 <br>\r
2141 Group 1 counter config values:<br>\r
2142 1 - PortXmitDataSL8-15<br>\r
2143 2 - PortRcvDataSL0-7<br>\r
2144 8 - PortRcvDataSL8-15<br>\r
2145 <br>\r
2146 <br>\r
2147 COMMON OPTIONS<br>\r
2148 Most OFED diagnostics take the following common flags. The exact list<br>\r
2149 of supported flags per utility can be found in the usage message and<br>\r
2150 can be shown using the util_name -h syntax.<br>\r
2151 <br>\r
2152 # Debugging flags<br>\r
2153 <br>\r
2154 -d raise the IB debugging level.<br>\r
2155 May be used several times (-ddd or -d -d -d).<br>\r
2156 <br>\r
2157 -e show send and receive errors (timeouts and others)<br>\r
2158 <br>\r
2159 -h show the usage message<br>\r
2160 <br>\r
2161 -v increase the application verbosity level.<br>\r
2162 May be used several times (-vv or -v -v -v)<br>\r
2163 <br>\r
2164 -V show the version info.<br>\r
2165 <br>\r
2166 # Addressing flags<br>\r
2167 <br>\r
2168 -G use GUID address argument. In most cases, it is the Port GUID.<br>\r
2169 Example:<br>\r
2170 &quot;0x08f1040023&quot;<br>\r
2171 <br>\r
2172 -s &lt;smlid&gt; use \92smlid\92 as the target lid for SM/SA queries.<br>\r
2173 <br>\r
2174 # Other common flags:<br>\r
2175 <br>\r
2176 -C &lt;ca_name&gt; use the specified ca_name.<br>\r
2177 <br>\r
2178 -P &lt;ca_port&gt; use the specified ca_port.<br>\r
2179 <br>\r
2180 -t &lt;timeout_ms&gt; override the default timeout for the solicited mads.<br>\r
2181 <br>\r
2182 Multiple CA/Multiple Port Support<br>\r
2183 <br>\r
2184 When no IB device or port is specified, the port to use is selected by<br>\r
2185 the following criteria:<br>\r
2186 <br>\r
2187 1. the first port that is ACTIVE.<br>\r
2188 <br>\r
2189 2. if not found, the first port that is UP (physical link up).<br>\r
2190 <br>\r
2191 If a port and/or CA name is specified, the user request is attempted to<br>\r
2192 be fulfilled, and will fail if it is not possible.<br>\r
2193 <br>\r
2194 <br>\r
2195 EXAMPLES<br>\r
2196 vendstat -N 6 # read IS3 general information<br>\r
2197 <br>\r
2198 vendstat -w 6 # read IS3 port xmit wait counters<br>\r
2199 <br>\r
2200 vendstat -i 6 12 # read IS4 port 12 counter group info<br>\r
2201 <br>\r
2202 vendstat -c 0,1 6 12 # configure IS4 port 12 counter groups for PortXmitDataSL<br>\r
2203 <br>\r
2204 vendstat -c 2,8 6 12 # configure IS4 port 12 counter groups for PortRcvDataSL<br>\r
2205 <br>\r
2206 <br>\r
2207 AUTHOR<br>\r
2208 Hal Rosenstock&nbsp;&nbsp;&nbsp; &lt;halr@voltaire.com&gt;<br>\r
2209 <br>\r
2210 <br>\r
2211 OFED April 16, 2009 VENDSTAT(8)</p>\r
2212 <p align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a><br>\r
2213 &nbsp;</p>\r
2214 <h3 align="left"><a name="iblimits"></a><br>\r
2215 ib_limits - Infiniband verbs tests</h3>\r
2216 <p align="left">Usage: ib_limits [options]</p>\r
2217 <blockquote>\r
2218         <p align="left">Options:<br>-m or --memory<br>&nbsp;&nbsp;&nbsp; Direct ib_limits to test memory registration<br>-c or --cq<br>&nbsp;&nbsp;&nbsp; Direct ib_limits to test CQ creation<br>-r or --resize_cq<br>&nbsp;&nbsp;&nbsp; direct ib_limits to test CQ resize<br>-q or --qp<br>&nbsp;&nbsp;&nbsp; Directs ib_limits to test QP creation<br>-v or --verbose<br>&nbsp;&nbsp;&nbsp; Enable verbosity level to debug console.<br>-h or --help<br>&nbsp;&nbsp;&nbsp; Display this usage info then exit.</p>\r
2219 </blockquote>\r
2220 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
2221 <p align="left">&nbsp;</p>\r
2222 <h3 align="left"><a name="cmtest"></a><br>\r
2223 cmtest - Connection Manager Tests</h3>\r
2224 <p>Usage: cmtest [options]</p>\r
2225 <p>&nbsp;&nbsp;&nbsp; Options:</p>\r
2226 <blockquote>\r
2227         <p>&nbsp;-s --server This option directs cmtest to act as a Server<br>\r
2228 &nbsp;-l\r
2229         <lid>--local\r
2230         <lid>This option specifies the local endpoint.<br>\r
2231 &nbsp;-r\r
2232         <lid>--remote\r
2233         <lid>This option specifies the remote endpoint LID as a hex integer 0x; see \r
2234         vstat command for active port LID hex integer.<br>\r
2235 &nbsp;-c\r
2236         <number>--connect\r
2237         <number>This option specifies the number of connections to open. Default of \r
2238         1.<br>\r
2239 &nbsp;-m\r
2240         <bytes>--msize\r
2241         <bytes>This option specifies the byte size of each message. Default is 100 \r
2242         bytes.<br>\r
2243 &nbsp;-n\r
2244         <number>--nmsgs\r
2245         <number>This option specifies the number of messages to send at a time.<br>\r
2246 &nbsp;-p --permsg This option indicates if a separate buffer should be used per \r
2247         message. Default is one buffer for all messages.<br>\r
2248 &nbsp;-i\r
2249         <number>--iterate\r
2250         <number>This option specifies the number of times to loop through 'nmsgs'. \r
2251         Default of 1.<br>\r
2252 &nbsp;-v --verbose This option enables verbosity level to debug console.<br>\r
2253 &nbsp;-h --help Display this usage info then exit.</p>\r
2254 </blockquote>\r
2255 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
2256 <p align="left">&nbsp;</p>\r
2257 <BLOCKQUOTE></BLOCKQUOTE>\r
2258 <h3 align="left"><a name="InfiniBand_Partition_Management">InfiniBand Partition \r
2259 Management</a></h3>\r
2260 <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
2261 application allows creating, deleting and viewing existing </span><span style="FONT-SIZE: 12pt">\r
2262 host partitions</span><span style="FONT-SIZE: 12pt">.</span></font></p>\r
2263 <p align="left">Usage : part_man.exe &lt;show|add|rem&gt; &lt;port_guid&gt; &lt;pkey1 pkey2 \r
2264 ...&gt;</p>\r
2265         <b><font face="Times New Roman" size="4">\r
2266         <span style="font-weight: bold">show - </span></font></b>\r
2267 <font face="Times New Roman" size="3">\r
2268         <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
2269         <span style="FONT-SIZE: 12pt">Expected results after execution <b>\r
2270         <span style="FONT-WEIGHT: bold">part_man.exe show</span></b></span></font></p>\r
2271         <p style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2272         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">1.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2273         </span></font>Output has a format<font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">&nbsp;</span></font></p>\r
2274         <p style="MARGIN-LEFT: 0.5in"><b><font face="Times New Roman" size="3">\r
2275         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">port_guid1&nbsp;&nbsp; pkey1&nbsp; pkey2&nbsp; \r
2276         pkey3&nbsp; pkey4&nbsp; pkey5&nbsp; pkey6&nbsp; pkey7&nbsp; pkey8</span></font></b></p>\r
2277         <p style="MARGIN-LEFT: 0.5in"><b><font face="Times New Roman" size="3">\r
2278         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">port_guid2&nbsp;&nbsp; \r
2279         pkey1&nbsp;&nbsp;pkey2&nbsp; pkey3&nbsp; pkey4&nbsp; pkey5&nbsp; pkey6&nbsp; pkey7&nbsp; pkey8</span></font></b></p>\r
2280         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2281         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">where <b>\r
2282         <span style="FONT-WEIGHT: bold">port_guid</span></b> is a port guid in \r
2283         hexadecimal format, <b><span style="FONT-WEIGHT: bold">pkey</span></b> \96 \r
2284         values of partition key (in hex format) for this port.</span></font></p>\r
2285         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2286         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Default \r
2287         partition key (0xFFFF) is not shown and can not be created by the \r
2288         part_man.exe.</span></font></p>\r
2289 <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2290         &nbsp;</p>\r
2291         <p class="MsoNormal" style="MARGIN-LEFT: 0.0in"><b>\r
2292         <font face="Times New Roman" size="4">\r
2293         <span style="FONT-WEIGHT: bold; ">add - </span></font></b>create new partition(s) \r
2294         on specified port </p>\r
2295         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
2296         <font face="Times New Roman" size="3">\r
2297         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">port_guid</span></font></b>&nbsp;\r
2298         <b><span style="FONT-WEIGHT: bold">add</span></b>&nbsp;&nbsp; &lt;<b><span style="FONT-WEIGHT: bold">port_guid</span></b>&gt; \r
2299         &nbsp;&lt;<b><span style="FONT-WEIGHT: bold">pkey1</span></b>&gt; &nbsp;&nbsp;&lt;<b><span style="FONT-WEIGHT: bold">pkey2</span></b>&gt; \r
2300         </p>\r
2301 <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">creates new partition(s) on port specified by port_guid parameter (in \r
2302         hexadecimal format) and pkey \96 new partition key value in hexadecimal \r
2303         format (e.g. 0xABCD or ABCD).</p>\r
2304         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2305         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Port \r
2306         guid is taken form vstat output and has a following format:</span></font></p>\r
2307         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
2308         <font face="Times New Roman" size="3">\r
2309         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">XXXX:XXXX:XXXX:XXXX.</span></font></b></p>\r
2310         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2311         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Vstat \r
2312         prints node guid, so user has to add 1 to node guid value to obtain port \r
2313         guid. For example, if node guid is <b><span style="FONT-WEIGHT: bold">\r
2314         0008:f104:0397:7ccc</span></b>, port guid will be</span></font></p>\r
2315         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
2316         <font face="Times New Roman" size="3">\r
2317         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">0008:f104:0397:7ccd</span></font></b> \r
2318         \96 for the first port,</p>\r
2319         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
2320         <font face="Times New Roman" size="3">\r
2321         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">0008:f104:0397:7cce</span></font></b> \r
2322         \96 for the second port.</p>\r
2323         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2324         <font face="Courier New" color="green" size="2">\r
2325         <span style="FONT-SIZE: 10pt; COLOR: green; FONT-FAMILY: 'Courier New'">&nbsp;</span></font></p>\r
2326         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2327         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Expected \r
2328         results of execution <b><span style="FONT-WEIGHT: bold">part_man.exe add \r
2329         0x0D99:9703:04f1:0800 0xABCD</span></b></span></font></p>\r
2330         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2331         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">1.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2332         </span></font>part_man.exe output ends up with <b>\r
2333         <span style="FONT-WEIGHT: bold">\85Done </span></b>message.</p>\r
2334         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2335         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">2.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2336         </span></font>A new instance of a Network Adapter named \93OpenFabrics IPoIB \r
2337         Adapter Partition\94 will appear in Device manager \r
2338         window.&nbsp; <br>\r
2339         If the new adapter appears with yellow label, manual device driver installation is \r
2340         required.</p>\r
2341 <ul>\r
2342         <li>\r
2343         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">In \r
2344         the device manager view, right click \93OpenFabrics IPoIB Adapter Partition\94</p>\r
2345         </li>\r
2346         <li>\r
2347         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2348         select 'update driver' and follow the instructions.</p></li>\r
2349         <li>\r
2350         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">don't \r
2351         allow Windows Update to search the Internet</p></li>\r
2352         <li>\r
2353         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2354         select install software automatically.</p></li>\r
2355 </ul>\r
2356         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2357         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">3.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2358         </span></font>New adapter name ends with \93Partition\94, e.g. \93OpenFabrics IPoIB \r
2359         Adapter Partition\94.</p>\r
2360         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2361         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">&nbsp;</span></font></p>\r
2362         <b>\r
2363         <font face="Times New Roman" size="4">\r
2364         <span style="FONT-WEIGHT: bold; ">rem </span></font></b>\r
2365         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">\96 \r
2366         removes partition key on specified \r
2367         port.</span></font></p>\r
2368         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in"><b>\r
2369         <font face="Times New Roman" size="3">\r
2370         <span style="FONT-WEIGHT: bold; FONT-SIZE: 12pt">part_man.exe rem &lt;port_guid&gt; \r
2371         &lt;pkey1&gt;&nbsp; &lt;pkey2&gt;</span></font></b></p>\r
2372         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2373         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">\r
2374         Port_guid \96 in hexadecimal format (same as for <b>\r
2375         <span style="FONT-WEIGHT: bold">add</span></b> command), identifies port for \r
2376         operation. </span></font></p>\r
2377         <p class="MsoNormal" style="MARGIN-LEFT: 0.5in">\r
2378         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">Expected \r
2379         results after execution <b><span style="FONT-WEIGHT: bold">part_man rem &lt;port_guid&gt; \r
2380         &nbsp;&lt;pkey&gt;</span></b></span></font></p>\r
2381         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2382         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">1.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2383         </span></font>Application prints <b><span style="FONT-WEIGHT: bold">\85Done\r
2384         </span></b>message.</p>\r
2385         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2386         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">2.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2387         </span></font>In device manager window IPoIB network adapter will disappear.</p>\r
2388         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">\r
2389         <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">3.</span></font><font size="1"><span style="FONT-SIZE: 7pt">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\r
2390         </span></font>Execution of&nbsp; <b><span style="FONT-WEIGHT: bold">part_man.exe \r
2391         show </span></b>will not show removed adapter.</p>\r
2392         <p class="MsoNormal" style="MARGIN-LEFT: 0.75in; TEXT-INDENT: -0.25in">&nbsp;</div>\r
2393         \r
2394 <p align="left"><b><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></b></p>\r
2395 <p align="left">&nbsp;</p>\r
2396 <h3 align="left"><a name="printip"></a><br>\r
2397 PrintIP - print ip adapters and their addresses</h3>\r
2398 <blockquote>\r
2399         <p align="left">PrintIP is used to print IP adapters and their addresses, or \r
2400         ARP (Address Resolution Protocol) and IP address.<br>\r
2401         <br>\r
2402         Usage:<br>\r
2403 &nbsp;&nbsp;&nbsp; printip &lt;print_ips&gt;<br>\r
2404 &nbsp;&nbsp;&nbsp; printip &lt;remoteip&gt; &lt;ip&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
2405         (example printip remoteip 10.10.2.20)</p>\r
2406 </blockquote>\r
2407 <h3 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h3>\r
2408 <p align="left">&nbsp;</p>\r
2409 <h3 align="left">\r
2410 <br>\r
2411 <a name="vstat"></a><br>\r
2412 vstat - HCA Stats and Counters</h3>\r
2413 <blockquote>\r
2414         <p align="left">Display HCA (Host channel Adapter) attributes.</p>\r
2415         <p align="left">Usage: vstat [-v] [-c]<br>\r
2416 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; -v - verbose mode<br>\r
2417 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; -c - HCA error/statistic \r
2418         counters<br>\r
2419         <br>\r
2420         Includes Node GUID, Subnet Manager and port LIDs.</p>\r
2421 </blockquote>\r
2422 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
2423 <p align="left">&nbsp;</p>\r
2424 <BLOCKQUOTE></BLOCKQUOTE>\r
2425 <h2 align="left"><a name="opensm"></a>Subnet Management with OpenSM Rev: openib-1.2.0</h2>\r
2426 <hr>\r
2427 <p align="left">A single running process (opensm.exe) is required to configure \r
2428 and thus make an Infiniband subnet useable.&nbsp; For most cases, InfiniBand \r
2429 Subnet Management as a Windows service is sufficient to correctly configure most \r
2430 InfiniBand fabrics.</p>\r
2431 <p align="left">The Infiniband subnet management process (opensm) may exist on a \r
2432 Windows (WinOF) node or a Linux (OFED) node.<br>\r
2433 <br>\r
2434 Limit the number of OpenSM processes per IB fabric; one SM is sufficient \r
2435 although redundant SMs are supported. You do not need a Subnet Manager per \r
2436 node/system.</p>\r
2437 <h4>OpenIB Subnet Management as a Windows Service</h4>\r
2438 <p>InfiniBand subnet management (OpenSM), as a Windows service, is installed by default, although it is NOT \r
2439 started by default. There are two ways to enable the InfiniBand Subnet \r
2440 Management service.</p>\r
2441 <ol style="margin-bottom: 0in">\r
2442         <li>Reset the installed OpenSM service &quot;InfiniBand Subnet Management&quot; \r
2443         to start automatically; From a command window type 'services.msc'.<br>\r
2444         Locate the InfiniBand Subnet Management view and select the start option; \r
2445         additionally select the startup option 'Automatic' to start the OpenSM \r
2446         service on system startup.<br>&nbsp;</li>\r
2447         <li>Install OpenSM as a 'running' Windows service:<br>\r
2448         Select the OpenSM_service_Started install feature. \r
2449         Once the installation has completed, check the running InfiniBand Subnet \r
2450         Management service status via the Windows service manager (see #1).<br>\r
2451 &nbsp;</li>\r
2452         <li>Consult the OpenSM log file @ %SystemRoot%\Temp\osm.log to see what \r
2453         OpenSM thinks is happening.</li>\r
2454 </ol>\r
2455 <p>&nbsp;</p>\r
2456 <h4 align="left">Manual InfiniBand Subnet Management from a command window</h4>\r
2457 <p align="left">Usage: opensm.exe [options]</p>\r
2458 <p align="left">Options:</p>\r
2459 <blockquote>\r
2460         <p align="left">-c<br>\r
2461         --cache-options</p>\r
2462         <blockquote>\r
2463                 <p align="left">Cache the given command line options into the file<br>\r
2464                 /var/cache/osm/opensm.opts for use next invocation<br>\r
2465                 The cache directory can be changed by the environment<br>\r
2466                 variable OSM_CACHE_DIR</p>\r
2467         </blockquote>\r
2468         <p align="left">-g[=]&lt;GUID in hex&gt;<br>\r
2469         --guid[=]&lt;GUID in hex&gt;</p>\r
2470         <blockquote>\r
2471                 <p align="left">This option specifies the local port GUID value with \r
2472                 which OpenSM should bind. OpenSM may be<br>\r
2473                 bound to 1 port at a time.&nbsp; If GUID given is 0, OpenSM displays a \r
2474                 list of possible port GUIDs and waits for user input. Without -g, OpenSM \r
2475                 trys to use the default port.</p>\r
2476         </blockquote>\r
2477         <p align="left">-l &lt;LMC&gt;<br>\r
2478         --lmc &lt;LMC&gt;</p>\r
2479         <blockquote>\r
2480                 <p align="left">This option specifies the subnet's LMC value.<br>\r
2481                 The number of LIDs assigned to each port is 2^LMC.<br>\r
2482                 The LMC value must be in the range 0-7.<br>\r
2483                 LMC values &gt; 0 allow multiple paths between ports.<br>\r
2484                 LMC values &gt; 0 should only be used if the subnet<br>\r
2485                 topology actually provides multiple paths between<br>\r
2486                 ports, i.e. multiple interconnects between switches.<br>\r
2487                 Without -l, OpenSM defaults to LMC = 0, which allows<br>\r
2488                 one path between any two ports.</p>\r
2489         </blockquote>\r
2490         <p align="left">-p &lt;PRIORITY&gt;<br>\r
2491         --priority &lt;PRIORITY&gt;</p>\r
2492         <blockquote>\r
2493                 <p align="left">This option specifies the SM's PRIORITY.<br>\r
2494                 This will effect the handover cases, where master<br>\r
2495                 is chosen by priority and GUID.<br>\r
2496                 -smkey &lt;SM_Key&gt;<br>\r
2497                 This option specifies the SM's SM_Key (64 bits).<br>\r
2498                 This will effect SM authentication.</p>\r
2499         </blockquote>\r
2500         <p align="left">-r<br>\r
2501         --reassign_lids</p>\r
2502         <blockquote>\r
2503                 <p align="left"><br>\r
2504                 This option causes OpenSM to reassign LIDs to all end nodes. Specifying \r
2505                 -r on a running subnet<br>\r
2506                 may disrupt subnet traffic.&nbsp; Without -r, OpenSM attempts to \r
2507                 preserve existing LID assignments resolving multiple use of same LID.</p>\r
2508         </blockquote>\r
2509         <p align="left">-u<br>\r
2510         --updn</p>\r
2511         <blockquote>\r
2512                 <p align="left">This option activate UPDN algorithm instead of Min Hop \r
2513                 algorithm (default).</p>\r
2514         </blockquote>\r
2515         <p align="left">-a<br>\r
2516         --add_guid_file &lt;path to file&gt;</p>\r
2517         <blockquote>\r
2518                 <p align="left">Set the root nodes for the Up/Down routing algorithm to \r
2519                 the guids provided in the given file (one per line)</p>\r
2520         </blockquote>\r
2521         <p align="left">-o<br>\r
2522         --once</p>\r
2523         <blockquote>\r
2524                 <p align="left">This option causes OpenSM to configure the subnet once, \r
2525                 then exit. Ports remain in the ACTIVE state.</p>\r
2526         </blockquote>\r
2527         <p align="left">-s &lt;interval&gt;<br>\r
2528         --sweep &lt;interval&gt;</p>\r
2529         <blockquote>\r
2530                 <p align="left">This option specifies the number of seconds between \r
2531                 subnet sweeps. Specifying -s 0 disables sweeping.<br>\r
2532                 Without -s, OpenSM defaults to a sweep interval of 10 seconds.</p>\r
2533         </blockquote>\r
2534         <p align="left">-t &lt;milliseconds&gt;<br>\r
2535         --timeout &lt;milliseconds&gt;</p>\r
2536         <blockquote>\r
2537                 <p align="left">This option specifies the time in milliseconds<br>\r
2538                 used for transaction timeouts.<br>\r
2539                 Specifying -t 0 disables timeouts.<br>\r
2540                 Without -t, OpenSM defaults to a timeout value of<br>\r
2541                 200 milliseconds.</p>\r
2542         </blockquote>\r
2543         <p align="left">-maxsmps &lt;number&gt;</p>\r
2544         <blockquote>\r
2545                 <p align="left">This option specifies the number of VL15 SMP MADs \r
2546                 allowed on the wire at any one time.<br>\r
2547                 Specifying -maxsmps 0 allows unlimited outstanding SMPs.<br>\r
2548                 Without -maxsmps, OpenSM defaults to a maximum of one outstanding SMP.</p>\r
2549         </blockquote>\r
2550         <p align="left">-i &lt;equalize-ignore-guids-file&gt;<br>\r
2551         -ignore-guids &lt;equalize-ignore-guids-file&gt;</p>\r
2552         <blockquote>\r
2553                 <p align="left">This option provides the means to define a set of ports\r
2554                 (by guids) that will be ignored by the link load&nbsp;\r
2555                 equalization algorithm.</p>\r
2556         </blockquote>\r
2557         <p align="left">-x<br>\r
2558         --honor_guid2lid</p>\r
2559         <blockquote>\r
2560                 <p align="left">This option forces OpenSM to honor the guid2lid file,\r
2561                 when it comes out of Standby state, if such file exists\r
2562                 under OSM_CACHE_DIR, and is valid.\r
2563                 By default this is FALSE.</p>\r
2564         </blockquote>\r
2565         <p align="left">-f<br>\r
2566         --log_file</p>\r
2567         <blockquote>\r
2568                 <p align="left">This option names the OpenSM log file. By \r
2569                 default the log goes to %SystemRoot%\Temp\osm.log when started as<br>\r
2570                 a Windows service. When OpenSM.exe is run from a command prompt, the \r
2571                 default log file is created as '%TEMP%\osm.log'.<br>\r
2572                 For the log to go to standard output use -f stdout.</p>\r
2573         </blockquote>\r
2574         <p align="left">-e<br>\r
2575         --erase_log_file</p>\r
2576         <blockquote>\r
2577                 <p align="left">This option will cause deletion of the log file&nbsp; \r
2578                 (if it previously exists). By default, the log file is accumulative.</p>\r
2579         </blockquote>\r
2580         <p align="left">-y<br>\r
2581         --stay_on_fatal</p>\r
2582         <blockquote>\r
2583                 <p align="left">This option will cause SM not to exit on fatal \r
2584                 initialization\r
2585                 issues: if SM discovers duplicated guids or 12x link with\r
2586                 lane reversal badly configured.\r
2587                 By default, the SM will exit on these errors.</p>\r
2588         </blockquote>\r
2589         <p align="left">-v<br>\r
2590         --verbose</p>\r
2591         <blockquote>\r
2592                 <p align="left">This option increases the log verbosity level.\r
2593                 The -v option may be specified multiple times\r
2594                 to further increase the verbosity level.&nbsp;\r
2595                 See the -vf option for more information about.\r
2596                 log verbosity.</p>\r
2597         </blockquote>\r
2598         <p align="left">-V</p>\r
2599         <blockquote>\r
2600                 <p align="left">This option sets the maximum verbosity level and\r
2601                 forces log flushing.<br>\r
2602                 The -V is equivalent to '-vf 0xFF -d 2'.\r
2603                 See the -vf option for more information about\r
2604                 log verbosity.</p>\r
2605         </blockquote>\r
2606         <p align="left">-D &lt;flags&gt;</p>\r
2607         <blockquote>\r
2608                 <p align="left">This option sets the log verbosity level.&nbsp; A flags \r
2609                 field must follow the -D option.<br>\r
2610                 A bit set/clear in the flags enables/disables a specific log level as \r
2611                 follows:<br>\r
2612                 BIT LOG LEVEL ENABLED<br>\r
2613                 ---- -----------------<br>\r
2614                 0x01 - ERROR (error messages)<br>\r
2615                 0x02 - INFO (basic messages, low volume)<br>\r
2616                 0x04 - VERBOSE (interesting stuff, moderate volume)<br>\r
2617                 0x08 - DEBUG (diagnostic, high volume)<br>\r
2618                 0x10 - FUNCS (function entry/exit, very high volume)<br>\r
2619                 0x20 - FRAMES (dumps all SMP and GMP frames)<br>\r
2620                 0x40 - ROUTING (dump FDB routing information)<br>\r
2621                 0x80 - currently unused.<br>\r
2622                 Without -D, OpenSM defaults to ERROR + INFO (0x3).<br>\r
2623                 Specifying -D 0 disables all messages.<br>\r
2624                 Specifying -D 0xFF enables all messages (see -V).<br>\r
2625                 High verbosity levels may require increasing the transaction timeout \r
2626                 with the -t option.</p>\r
2627         </blockquote>\r
2628         <p align="left">-d &lt;number&gt;<br>\r
2629         --debug &lt;number&gt;</p>\r
2630         <blockquote>\r
2631                 <p align="left">This option specifies a debug option. These options are \r
2632                 not normally needed. The number following -d selects the debug option to \r
2633                 enable as follows:<br>\r
2634                 OPT Description<br>\r
2635                 --- -----------------<br>\r
2636                 -d0 - Ignore other SM nodes<br>\r
2637                 -d1 - Force single threaded dispatching<br>\r
2638                 -d2 - Force log flushing after each log message<br>\r
2639                 -d3 - Disable multicast support<br>\r
2640                 -d4 - Put OpenSM in memory tracking mode<br>\r
2641                 -d10 - Put OpenSM in testability mode<br>\r
2642                 Without -d, no debug options are enabled</p>\r
2643         </blockquote>\r
2644         <p align="left">-h<br>\r
2645         --help</p>\r
2646         <blockquote>\r
2647                 <p align="left">Display this usage info then exit.</p>\r
2648         </blockquote>\r
2649         <p align="left">-?</p>\r
2650         <blockquote>\r
2651                 <p align="left">Display this usage info then exit.</p>\r
2652         </blockquote>\r
2653 </blockquote>\r
2654 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
2655 <h3 align="left">&nbsp;</h3>\r
2656 <h3 align="left"><a name="osmtest"></a><br>\r
2657 Osmtest - Subnet Management Tests</h3>\r
2658 <p align="left">Invoke open subnet management tests. osmtest currently can not \r
2659 run on the same HCA port which OpenSM is currently using.</p>\r
2660 <blockquote>\r
2661         <p align="left">&nbsp;Usage: osmtest [options]</p>\r
2662         <p align="left">Options:</p>\r
2663         <blockquote>\r
2664                 <p align="left">&nbsp;-f &lt;c|a|v|s|e|f|m|q|t&gt;<br>\r
2665                 --flow &lt;c|a|v|s|e|f|m|q|t&gt;</p>\r
2666 \r
2667                         <p align="left">This option directs osmtest to run a specific flow:</p>\r
2668                         <p align="left">FLOW DESCRIPTIONS<br>\r
2669                         c = create an inventory file with all nodes, ports &amp; paths.<br>\r
2670                         a = run all validation tests (expecting an input inventory)<br>\r
2671                         v = only validate the given inventory file.<br>\r
2672                         s = run service registration, un-registration and lease.<br>\r
2673                         e = run event forwarding test.<br>\r
2674                         f = flood the SA with queries accoring to the stress mode.<br>\r
2675                         m = multicast flow.<br>\r
2676                         q = QoS info - VLArb and SLtoVL tables.<br>\r
2677                         t = run trap 64/65 flow; requires running an external tool.<br>\r
2678                         (default is all but QoS).</p>\r
2679         \r
2680                 <p align="left">-w &lt;trap_wait_time&gt;<br>\r
2681                 --wait &lt;trap_wait_time&gt;</p>\r
2682                 <blockquote>\r
2683                         <p align="left">This option specifies the wait time for trap 64/65 \r
2684                         in seconds.<br>\r
2685                         It is used only when running -f t - the trap 64/65 flow<br>\r
2686                         (default to 10 sec).</p>\r
2687                 </blockquote>\r
2688                 <p align="left">-d &lt;number&gt;<br>\r
2689                 --debug &lt;number&gt;</p>\r
2690                 <blockquote>\r
2691                         <p align="left">This option specifies a debug option.\r
2692                         These options are not normally needed.<br>\r
2693                         The number following -d selects the debug\r
2694                         option to enable as follows:<br>\r
2695                         OPT Description<br>\r
2696                         --- -----------------<br>\r
2697                         -d0 - Unused.<br>\r
2698                         -d1 - Do not scan/compare path records.<br>\r
2699                         -d2 - Force log flushing after each log message.<br>\r
2700                         -d3 - Use mem tracking.<br>\r
2701                         Without -d, no debug options are enabled.</p>\r
2702                 </blockquote>\r
2703                 <p align="left">-m &lt;LID in hex&gt;<br>\r
2704                 --max_lid &lt;LID in hex&gt;</p>\r
2705                 <blockquote>\r
2706                         <p align="left">This option specifies the maximal LID number to be \r
2707                         searched\r
2708                         for during inventory file build (default to 100).</p>\r
2709                 </blockquote>\r
2710                 <p align="left">-g &lt;GUID in hex&gt;<br>\r
2711                 --guid &lt;GUID in hex&gt;</p>\r
2712                 <blockquote>\r
2713                         <p align="left">This option specifies the local port GUID value\r
2714                         with which osmtest should bind. osmtest may be\r
2715                         bound to 1 port at a time.\r
2716                         Without -g, osmtest displays a menu of possible\r
2717                         port GUIDs and waits for user input.</p>\r
2718                 </blockquote>\r
2719                 <p align="left">-h<br>\r
2720                 --help</p>\r
2721                 <blockquote>\r
2722                         <p align="left">Display this usage info then exit.</p>\r
2723                 </blockquote>\r
2724                 <p align="left">-i &lt;filename&gt;<br>\r
2725                 --inventory &lt;filename&gt;</p>\r
2726                 <blockquote>\r
2727                         <p align="left">This option specifies the name of the inventory \r
2728                         file.\r
2729                         Normally, osmtest expects to find an inventory file,\r
2730                         which osmtest uses to validate real-time information\r
2731                         received from the SA during testing.\r
2732                         If -i is not specified, osmtest defaults to the file\r
2733                         'osmtest.dat'.<br>\r
2734                         See the -c option for related information.</p>\r
2735                 </blockquote>\r
2736                 <p align="left">-s<br>\r
2737                 --stress</p>\r
2738                 <blockquote>\r
2739                         <p align="left">This option runs the specified stress test instead \r
2740                         of the normal test suite.<br>\r
2741                         Stress test options are as follows:<br>\r
2742                         OPT Description<br>\r
2743                         --- -----------------<br>\r
2744                         -s1 - Single-MAD response SA queries .<br>\r
2745                         -s2 - Multi-MAD (RMPP) response SA queries.<br>\r
2746                         -s3 - Multi-MAD (RMPP) Path Record SA queries.<br>\r
2747                         Without -s, stress testing is not performed.</p>\r
2748                 </blockquote>\r
2749                 <p align="left">-M<br>\r
2750                 --Multicast_Mode</p>\r
2751                 <blockquote>\r
2752                         <p align="left">This option specify length of Multicast test :<br>\r
2753                         OPT Description<br>\r
2754                         --- -----------------<br>\r
2755                         -M1 - Short Multicast Flow (default) - single mode.<br>\r
2756                         -M2 - Short Multicast Flow - multiple mode.<br>\r
2757                         -M3 - Long Multicast Flow - single mode.<br>\r
2758                         -M4 - Long Multicast Flow - multiple mode.<br>\r
2759                         Single mode - Osmtest is tested alone , with no other <br>\r
2760                         apps that interact vs. OpenSM MC.<br>\r
2761                         Multiple mode - Could be run with other apps using MC vs.<br>\r
2762                         OpenSM. Without -M, default flow testing is performed.</p>\r
2763                 </blockquote>\r
2764                 <p align="left">-t &lt;milliseconds&gt;</p>\r
2765                 <blockquote>\r
2766                         <p align="left">This option specifies the time in milliseconds used \r
2767                         for transaction timeouts.<br>\r
2768                         Specifying -t 0 disables timeouts.<br>\r
2769                         Without -t, osmtest defaults to a timeout value of 1 second.</p>\r
2770                 </blockquote>\r
2771                 <p align="left">-l<br>\r
2772                 --log_file</p>\r
2773                 <blockquote>\r
2774                         <p align="left">This option defines the log to be the given file.<br>\r
2775                         By default the log goes to stdout.</p>\r
2776                 </blockquote>\r
2777                 <p align="left">-v</p>\r
2778                 <blockquote>\r
2779                         <p align="left">This option increases the log verbosity level. The \r
2780                         -v option may be specified multiple times<br>\r
2781                         to further increase the verbosity level. See the -vf option for more \r
2782                         information about log verbosity.</p>\r
2783                 </blockquote>\r
2784                 <p align="left">-V</p>\r
2785                 <blockquote>\r
2786                         <p align="left">This option sets the maximum verbosity level and \r
2787                         forces log flushing.<br>\r
2788                         The -V is equivalent to '-vf 0xFF -d 2'.<br>\r
2789                         See the -vf option for more information about log verbosity.</p>\r
2790                 </blockquote>\r
2791                 <p align="left">-vf &lt;flags&gt;</p>\r
2792                 <blockquote>\r
2793                         <p align="left">This option sets the log verbosity level. A flags \r
2794                         field must follow the -vf option.<br>\r
2795                         A bit set/clear in the flags enables/disables a specific log level \r
2796                         as follows:<br>\r
2797                         BIT LOG LEVEL ENABLED<br>\r
2798                         ---- -----------------<br>\r
2799                         0x01 - ERROR (error messages)<br>\r
2800                         0x02 - INFO (basic messages, low volume)<br>\r
2801                         0x04 - VERBOSE (interesting stuff, moderate volume)<br>\r
2802                         0x08 - DEBUG (diagnostic, high volume)<br>\r
2803                         0x10 - FUNCS (function entry/exit, very high volume)<br>\r
2804                         0x20 - FRAMES (dumps all SMP and GMP frames)<br>\r
2805                         0x40 - currently unused.<br>\r
2806                         0x80 - currently unused.<br>\r
2807                         Without -vf, osmtest defaults to ERROR + INFO (0x3).<br>\r
2808                         Specifying -vf 0 disables all messages.<br>\r
2809                         Specifying -vf 0xFF enables all messages (see -V).<br>\r
2810                         High verbosity levels may require increasing<br>\r
2811                         the transaction timeout with the -t option.</p>\r
2812                 </blockquote>\r
2813         </blockquote>\r
2814 </blockquote>\r
2815 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
2816 <h3 align="left">&nbsp;</h3>\r
2817 <h3 align="left"><br>\r
2818 <BLOCKQUOTE></BLOCKQUOTE>\r
2819 <a name="ibtrapgen"></a><br>\r
2820 ibtrapgen - Generate Infiniband subnet management traps</h3>\r
2821 <p align="left">Usage: ibtrapgen -t|--trap_num &lt;TRAP_NUM&gt; -n|--number &lt;NUM_TRAP_CREATIONS&gt;<br>\r
2822 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
2823 -r|--rate &lt;TRAP_RATE&gt; -l|--lid &lt;LIDADDR&gt; <br>\r
2824 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
2825 -s|--src_port &lt;SOURCE_PORT&gt; -p|--port_num &lt;PORT_NUM&gt;<br>\r
2826 <br>\r
2827 Options: one of the following optional flows:</p>\r
2828 <blockquote>\r
2829         <p align="left">-t &lt;TRAP_NUM&gt;<br>\r
2830         --trap_num &lt;TRAP_NUM&gt;<br>\r
2831 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; This option specifies the \r
2832         number of the trap to generate. Valid values are 128-131.<br>\r
2833         -n &lt;NUM_TRAP_CREATIONS&gt;<br>\r
2834         --number &lt;NUM_TRAP_CREATIONS&gt;<br>\r
2835 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; This option specifies the \r
2836         number of times to generate this trap.<br>\r
2837 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; If not specified - \r
2838         default to 1.<br>\r
2839         -r &lt;TRAP_RATE&gt;<br>\r
2840         --rate &lt;TRAP_RATE&gt;<br>\r
2841 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; This option specifies the \r
2842         rate of the trap generation.<br>\r
2843 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; What is the time period \r
2844         between one generation and another?<br>\r
2845 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; The value is given in \r
2846         miliseconds. <br>\r
2847 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; If the number of trap \r
2848         creations is 1 - this value is ignored.<br>\r
2849         -l &lt;LIDADDR&gt;<br>\r
2850         --lid &lt;LIDADDR&gt;<br>\r
2851 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; This option specifies the \r
2852         lid address from where the trap should be generated.<br>\r
2853         -s &lt;SOURCE_PORT&gt;<br>\r
2854         --src_port &lt;SOURCE_PORT&gt;<br>\r
2855 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; This option specifies the \r
2856         port number from which the trap should<br>\r
2857 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; be generated. If trap \r
2858         number is 128 - this value is ignored (since<br>\r
2859 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; trap 128 is not sent with \r
2860         a specific port number)<br>\r
2861         -p &lt;port num&gt;<br>\r
2862         --port_num &lt;port num&gt;<br>\r
2863 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; This is the port number \r
2864         used for communicating with the SA.<br>\r
2865         -h<br>\r
2866         --help<br>\r
2867 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Display this usage info \r
2868         then exit.<br>\r
2869         -o<br>\r
2870         --out_log_file<br>\r
2871 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; This option defines the \r
2872         log to be the given file.<br>\r
2873 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; By default the log goes \r
2874         to stdout.<br>\r
2875         -v<br>\r
2876 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; This option increases the \r
2877         log verbosity level.<br>\r
2878 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; The -v option may be \r
2879         specified multiple times to further increase the verbosity level.<br>\r
2880 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; See the -vf option for \r
2881         more information about log verbosity.<br>\r
2882         -V<br>\r
2883 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; This option sets the \r
2884         maximum verbosity level and forces log flushing.<br>\r
2885 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; The -V is equivalent to \r
2886         '-vf 0xFF -d 2'.<br>\r
2887 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; See the -vf option for \r
2888         more information about. log verbosity.<br>\r
2889         -x &lt;flags&gt;<br>\r
2890 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; This option sets the log \r
2891         verbosity level.<br>\r
2892 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; A flags field must follow \r
2893         the -vf option.<br>\r
2894 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; A bit set/clear in the \r
2895         flags enables/disables a<br>\r
2896 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; specific log level as \r
2897         follows:</p>\r
2898         <blockquote>\r
2899                 <p align="left">BIT LOG LEVEL ENABLED<br>\r
2900                 ---- -----------------<br>\r
2901                 0x01 - ERROR (error messages)<br>\r
2902                 0x02 - INFO (basic messages, low volume)<br>\r
2903                 0x04 - VERBOSE (interesting stuff, moderate volume)<br>\r
2904                 0x08 - DEBUG (diagnostic, high volume)<br>\r
2905                 0x10 - FUNCS (function entry/exit, very high volume)<br>\r
2906                 0x20 - FRAMES (dumps all SMP and GMP frames)<br>\r
2907                 0x40 - currently unused.<br>\r
2908                 0x80 - currently unused.<br>\r
2909                 Without -x, ibtrapgen defaults to ERROR + INFO (0x3).<br>\r
2910                 Specifying -x 0 disables all messages.<br>\r
2911                 Specifying -x 0xFF enables all messages (see -V).</p>\r
2912         </blockquote>\r
2913 </blockquote>\r
2914 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
2915 <p align="left">&nbsp;</p>\r
2916 <p align="left">&nbsp;</p>\r
2917 <BLOCKQUOTE></BLOCKQUOTE>\r
2918 <h2 align="left"><a name="IPoIB"></a>IPoIB - Internet Protocols over InfiniBand</h2>\r
2919 <hr>\r
2920 <p align="left">IPoIB enables the use of Internet Protocol utilities (e.g., ftp, \r
2921 telnet) to function correctly over an Infiniband fabric. IPoIB is implemented as \r
2922 an NDIS Miniport driver with a WDM lower edge.</p>\r
2923 <p align="left">The IPoIB Network adapters are \r
2924 located via 'My Computer-&gt;Manage-&gt;Device Manager-&gt;Network adapters-&gt;IPoIB'.<br>\r
2925 'My \r
2926 Network Places-&gt;Properties' will display IPoIB Local Area Connection instances and should be used to \r
2927 configure IP addresses for the IPoIB interfaces; one Local Area Connection \r
2928 instance per HCA port. The IP \r
2929 (Internet Protocol) address bound to the IPoIB adapter instance can be assigned \r
2930 by DHCP or as a static IP addresses via<br>\r
2931 'My Network Places-&gt;Properties-&gt;Local \r
2932 Area Connection X-&gt;Properties-&gt;(General Tab)Internet Protocol(TCP/IP)-&gt;Properties'.</p>\r
2933 <p align="left">When the subnet manager (opensm) configures/sweeps the local \r
2934 Infiniband HCA, the Local Area Connection will become enabled. If you discover \r
2935 the Local Area Connection to be disabled, then likely your subnet manager \r
2936 (opensm) is not running or functioning correctly.</p>\r
2937                 <h4 align="left"><u>IPoIB Partition Management</u></h4>\r
2938                 <ul>\r
2939                         <li>\r
2940                         <p align="left"><a href="#InfiniBand_Partition_Management">part_man</a>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; \r
2941                         Manage (add/remove/show) IPoIB partitions.</li>\r
2942         </ul>\r
2943 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
2944 <p align="left">&nbsp;</p>\r
2945 <p align="left">&nbsp;</p>\r
2946 <BLOCKQUOTE></BLOCKQUOTE>\r
2947 <h2 align="left"><a name="winsockdirect"></a>Winsock Direct Service Provider</h2>\r
2948 <hr>\r
2949 <p align="left">Winsock Direct (WSD) is Microsoft's proprietary protocol that \r
2950 predates SDP (Sockets Direct Protocol) for accelerating TCP/IP applications by \r
2951 using RDMA hardware. Microsoft had a significant role in defining the SDP \r
2952 protocol, hence SDP and WSD are remarkably similar, though unfortunately \r
2953 incompatible.<br>\r
2954 <br>\r
2955 WSD is made up of two parts, the winsock direct switch and the winsock direct \r
2956 provider. The WSD switch is in the winsock DLL that ships in all editions of \r
2957 Windows Server 2003/2008, and is responsible for routing socket traffic over either \r
2958 the regular TCP/IP stack, or offload it to a WSD provider. The WSD provider is a \r
2959 hardware specific DLL that implements connection management and data transfers \r
2960 over particular RDMA hardware.</p>\r
2961 <p align="left">WinOF WSD is not supported in the Windows XP environment.</p>\r
2962 <p align="left">The WSD Protocol seamlessly transports TCP \r
2963                 data using Infiniband data packets in 'buffered' mode or Infiniband \r
2964                 RDMA in 'direct' mode. Either way the user mode socket application sees no \r
2965                 behavioral difference in the standard Internet Protocol socket it created other than \r
2966 reduced data transfer times and increased bandwidth.<br>\r
2967 <br>\r
2968 The Windows OpenFabrics release includes a WSD provider library that has been \r
2969 extensively tested with Microsoft Windows Server 2003.<br>\r
2970 During testing, bugs where found in the WSD switch that could lead to hangs, \r
2971 crashes, data corruption, and other unwanted behavior. Microsoft released a \r
2972 hotfix to address these issues which should be installed if using WSD; the \r
2973 Microsoft Windows Server 2003 hotfix can be found\r
2974 <a class="wiki" href="http://support.microsoft.com/?kbid=910481">here</a>.<br>\r
2975 Windows Server 2003 (R2) no longer requires this patch, nor does Windows Server \r
2976 2008.<br>\r
2977 &nbsp;</p>\r
2978 <div id="tiki-main">\r
2979         <div id="tiki-mid">\r
2980                 <table id="table1" cellSpacing="0" cellPadding="0" border="0">\r
2981                         <tr>\r
2982                                 <td id="centercolumn">\r
2983                                 <div id="tiki-center">\r
2984                                         <div class="wikitext">\r
2985                                                 Environment variables can be used to change the behavior \r
2986                                                 of the WSD provider:<br>\r
2987                                                 <br>\r
2988                                                 IBWSD_NO_READ - Disables RDMA Read operations when set \r
2989                                                 to any value. Note that this variable must be used \r
2990                                                 consistently throughout the cluster or communication \r
2991                                                 will fail.<br>\r
2992                                                 <br>\r
2993                                                 IBWSD_POLL - Sets the number of times to poll the \r
2994                                                 completion queue after processing completions in \r
2995                                                 response to a CQ event. Reduces latency at the cost of \r
2996                                                 CPU utilization. Default is 500.<br>\r
2997                                                 <br>\r
2998                                                 IBWSD_SA_RETRY - Sets the number of times to retry SA \r
2999                                                 query requests. Default is 4, can be increased if \r
3000                                                 connection establishment fails.<br>\r
3001                                                 <br>\r
3002                                                 IBWSD_SA_TIMEOUT - Sets the number of milliseconds to \r
3003                                                 wait before retrying SA query requests. Default is 4, \r
3004                                                 can be increased if connection establishment fails.<br>\r
3005                                                 <br>\r
3006                                                 IBWSD_NO_IPOIB - SA query timeouts by default allow the \r
3007                                                 connection to be established over IPoIB. Setting this \r
3008                                                 environment variable to any value prevents fall back to \r
3009                                                 IPoIB if SA queries time out.<br>\r
3010                                                 <br>\r
3011                                                 IBWSD_DBG - Controls debug output when using a debug \r
3012                                                 version of the WSD provider. Takes a hex value, with \r
3013                                                 leading '0x', default value is '0x80000000'<br>\r
3014                                                 <br>\r
3015 &nbsp;<table class="wikitable" id="table2">\r
3016                                                         <tr>\r
3017                                                                 <td class="wikicell">0x00000001</td>\r
3018                                                                 <td class="wikicell">DLL</td>\r
3019                                                         </tr>\r
3020                                                         <tr>\r
3021                                                                 <td class="wikicell">0x00000002</td>\r
3022                                                                 <td class="wikicell">socket info</td>\r
3023                                                         </tr>\r
3024                                                         <tr>\r
3025                                                                 <td class="wikicell">0x00000004</td>\r
3026                                                                 <td class="wikicell">initialization code</td>\r
3027                                                         </tr>\r
3028                                                         <tr>\r
3029                                                                 <td class="wikicell">0x00000008</td>\r
3030                                                                 <td class="wikicell">WQ related functions</td>\r
3031                                                         </tr>\r
3032                                                         <tr>\r
3033                                                                 <td class="wikicell">0x00000010</td>\r
3034                                                                 <td class="wikicell">Enpoints related functions</td>\r
3035                                                         </tr>\r
3036                                                         <tr>\r
3037                                                                 <td class="wikicell">0x00000020</td>\r
3038                                                                 <td class="wikicell">memory registration</td>\r
3039                                                         </tr>\r
3040                                                         <tr>\r
3041                                                                 <td class="wikicell">0x00000040</td>\r
3042                                                                 <td class="wikicell">CM (Connection Manager)</td>\r
3043                                                         </tr>\r
3044                                                         <tr>\r
3045                                                                 <td class="wikicell">0x00000080</td>\r
3046                                                                 <td class="wikicell">connections</td>\r
3047                                                         </tr>\r
3048                                                         <tr>\r
3049                                                                 <td class="wikicell">0x00000200</td>\r
3050                                                                 <td class="wikicell">socket options</td>\r
3051                                                         </tr>\r
3052                                                         <tr>\r
3053                                                                 <td class="wikicell">0x00000400</td>\r
3054                                                                 <td class="wikicell">network events</td>\r
3055                                                         </tr>\r
3056                                                         <tr>\r
3057                                                                 <td class="wikicell">0x00000800</td>\r
3058                                                                 <td class="wikicell">Hardware</td>\r
3059                                                         </tr>\r
3060                                                         <tr>\r
3061                                                                 <td class="wikicell">0x00001000</td>\r
3062                                                                 <td class="wikicell">Overlapped I/O request</td>\r
3063                                                         </tr>\r
3064                                                         <tr>\r
3065                                                                 <td class="wikicell">0x00002000</td>\r
3066                                                                 <td class="wikicell">Socket Duplication</td>\r
3067                                                         </tr>\r
3068                                                         <tr>\r
3069                                                                 <td class="wikicell">0x00004000</td>\r
3070                                                                 <td class="wikicell">Performance Monitoring</td>\r
3071                                                         </tr>\r
3072                                                         <tr>\r
3073                                                                 <td class="wikicell">0x01000000</td>\r
3074                                                                 <td class="wikicell">More verbose than \r
3075                                                                 IBSP_DBG_LEVEL3</td>\r
3076                                                         </tr>\r
3077                                                         <tr>\r
3078                                                                 <td class="wikicell">0x02000000</td>\r
3079                                                                 <td class="wikicell">More verbose than \r
3080                                                                 IBSP_DBG_LEVEL2</td>\r
3081                                                         </tr>\r
3082                                                         <tr>\r
3083                                                                 <td class="wikicell">0x04000000</td>\r
3084                                                                 <td class="wikicell">More verbose than \r
3085                                                                 IBSP_DBG_LEVEL1</td>\r
3086                                                         </tr>\r
3087                                                         <tr>\r
3088                                                                 <td class="wikicell">0x08000000</td>\r
3089                                                                 <td class="wikicell">Verbose output</td>\r
3090                                                         </tr>\r
3091                                                         <tr>\r
3092                                                                 <td class="wikicell">0x20000000</td>\r
3093                                                                 <td class="wikicell">Function enter/exit</td>\r
3094                                                         </tr>\r
3095                                                         <tr>\r
3096                                                                 <td class="wikicell">0x40000000</td>\r
3097                                                                 <td class="wikicell">Warnings</td>\r
3098                                                         </tr>\r
3099                                                         <tr>\r
3100                                                                 <td class="wikicell">0x80000000</td>\r
3101                                                                 <td class="wikicell">Errors</td>\r
3102                                                         </tr>\r
3103                                                 </table>\r
3104                                         </div>\r
3105                                 </div>\r
3106                                 </td>\r
3107                         </tr>\r
3108                 </table>\r
3109         </div>\r
3110 </div>\r
3111 <p align="left"><br>\r
3112 See <a href="https://wiki.openfabrics.org/tiki-index.php?page=Winsock+Direct">\r
3113 https://wiki.openfabrics.org/tiki-index.php?page=Winsock+Direct</a> for the \r
3114 latest WSD status.</p>\r
3115 <h3 align="left">Winsock Direct Service Provider Installation</h3>\r
3116 <p align="left">WSD service \r
3117 is automatically installed and started as part of the 'default' installation; \r
3118 except on XP systems - WSD not supported.<br>\r
3119 Manual control is performed via the \Program Files\WinOF\installsp.exe utility.</p>\r
3120 <blockquote>\r
3121         <p align="left">usage: installsp [-i | -r | -l]<br>\r
3122         <br>\r
3123         -i&nbsp;&nbsp;&nbsp; Install the Winsock Direct (WSD) service provider<br>\r
3124         -r&nbsp;&nbsp;&nbsp; Remove the WSD service provider<br>\r
3125         -r &lt;name&gt;&nbsp;&nbsp;&nbsp; Remove the specified service provider<br>\r
3126         -l&nbsp;&nbsp;&nbsp; List service providers<br>\r
3127 &nbsp;</p>\r
3128 </blockquote>\r
3129 <h4 align="left"><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></h4>\r
3130 <p align="left">&nbsp;</p>\r
3131 <BLOCKQUOTE></BLOCKQUOTE>\r
3132 <h2 align="left"><a name="Network_Direct_Service_Provider">NetworkDirect \r
3133 Service Provider</a></h2><hr>\r
3134 <h3 align="left">NetworkDirect Service Provider Installation</h3>\r
3135 <p align="left">ND service \r
3136 is automatically installed and started as part of the 'default' installation for \r
3137 Windows server 2008, Vista or HPC systems.<br>\r
3138 Manual control is performed via the %windir%\system32\ndinstall.exe utility.</p>\r
3139 <blockquote>\r
3140         <p align="left">usage: ndinstall [-l] [-i | -r [ServiceProvider]]<br>\r
3141         <br>\r
3142         where ServiceProvider is 'ibal' or 'winverbs' or blank [blank implies the \r
3143         default Service Provider 'ibal']</p>\r
3144         <p align="left">-i&nbsp;&lt;name&gt;&nbsp;&nbsp;&nbsp; Install (enable) the NetworkDirect (ND) \r
3145         Service Provider 'name'<br>\r
3146         -r &lt;name&gt;&nbsp;&nbsp;&nbsp; Remove the specified Service Provider \r
3147         'name'<br>\r
3148         -l&nbsp;&nbsp;&nbsp; List all service providers; same as 'ndinstall' with no \r
3149         args.</p>\r
3150 </blockquote>\r
3151 <p align="left">The Microsoft Network Direct SDK can be downloaded from\r
3152 <a href="http://www.microsoft.com/downloads/details.aspx?familyid=12887DA1-9410-4A59-B903-693116BFD30E&displaylang=en">\r
3153 here</a>.&nbsp; Once the ND SDK is installed, ND test programs can be located @<br>\r
3154 %ProgramFiles%\Microsoft HPC Pack 2008 SDK\NetworkDirect\Bin\amd64\ as nd*.exe.</p>\r
3155 <p align="left">Known working ND test command invocations (loopback or remote \r
3156 host)</p>\r
3157 <blockquote>\r
3158         <p align="left"><font size="4">svr: ndrpingpong s IPoIB_IPv4_addr 4096 p1<br>\r
3159         cli: ndrpingpong c IPoIB_IPv4_addr 4096 p1</font></p>\r
3160         <p align="left"><font size="4">svr: ndpingpong s IPoIB_IPv4_addr 4096 b1<br>\r
3161         cli: ndpingpong c IPoIB_IPv4_addr 4096 b1</font></p>\r
3162 </blockquote>\r
3163 <p align="left">See ndping.exe /? for details.</p>\r
3164 <p align="left"><b><a href="#TOP"><font color="#000000">&lt;return-to-top&gt;</font></a></b></p>\r
3165 <p align="left">&nbsp;</p>\r
3166 <BLOCKQUOTE></BLOCKQUOTE>\r
3167 <h2 align="left"><a name="DAT"></a>Usermode Direct Access Transport and Direct Access Programming \r
3168 Libraries</h2>\r
3169 <hr>\r
3170 <p align="left"><font face="Times New Roman">The DAT (Direct Access Transport) \r
3171 API is a C programming interface developed by the\r
3172 <a class="wiki" href="http://www.datcollaborative.org">DAT Collaborative</a> in \r
3173 order provide a set of transport-independent, platform-independent Application \r
3174 Programming Interfaces that exploit the RDMA (remote direct memory access) \r
3175 capabilities of next-generation interconnect technologies such as InfiniBand, \r
3176 and iWARP.</font></p>\r
3177 <p align="left"><font face="Times New Roman">WinOF DAT and DAPL are based on the 1.1 DAT specification. The DAPL \r
3178 (Direct Access Provider Library) which now fully supports Infiniband RDMA and \r
3179 IPoIB.</font></p>\r
3180 <p align="left"><font face="Times New Roman">WinOF 1.0.1, and future WinOF \r
3181 releases, will include DAT/DAPL version 2.0 runtime libraries along with an optional \r
3182 v2.0 application build environment.<br>\r
3183 DAT 2.0 is configured with InfiniBand extensions enabled. The IB extensions \r
3184 include</font></p>\r
3185 <ul>\r
3186         <li>\r
3187         <p align="left"><font face="Times New Roman">RDMA write with Immediate data</font></p>\r
3188         </li>\r
3189         <li>\r
3190         <p align="left"><font face="Times New Roman">Atomic Compare and Swap \r
3191         operation</font></p></li>\r
3192         <li>\r
3193         <p align="left"><font face="Times New Roman">Atomic Fetch and Add operation<br>&nbsp;</font></p>\r
3194         </li>\r
3195 </ul>\r
3196 <div id="tiki-main0">\r
3197         <div id="tiki-mid0">\r
3198                 <table id="table3" cellSpacing="0" cellPadding="0" border="0">\r
3199                         <tr>\r
3200                                 <td id="centercolumn0">\r
3201                                 <div id="tiki-center0">\r
3202                                         <div class="wikitext">\r
3203                                                 <br>\r
3204                                                 How&nbsp; DAT objects map to equivalent\r
3205                                                 <a class="wiki" href="http://en.wikipedia.org/wiki/Infiniband">\r
3206                                                 InfiniBand</a> objects:<br>\r
3207 &nbsp;<table class="wikitable" id="table4">\r
3208                                                         <tr>\r
3209                                                                 <td class="wikicell">Interface Adapter (IA) \r
3210                                                                 </td>\r
3211                                                                 <td class="wikicell">HCA (Host Channel Adapter)</td>\r
3212                                                         </tr>\r
3213                                                         <tr>\r
3214                                                                 <td class="wikicell">Protection Zone (PZ) </td>\r
3215                                                                 <td class="wikicell">PD (Protection Domain)</td>\r
3216                                                         </tr>\r
3217                                                         <tr>\r
3218                                                                 <td class="wikicell">Local Memory Region (LMR) \r
3219                                                                 </td>\r
3220                                                                 <td class="wikicell">MR (Memory Region)</td>\r
3221                                                         </tr>\r
3222                                                         <tr>\r
3223                                                                 <td class="wikicell">Remote Memory Region (RMR) \r
3224                                                                 </td>\r
3225                                                                 <td class="wikicell">MW (Memory Windows)</td>\r
3226                                                         </tr>\r
3227                                                         <tr>\r
3228                                                                 <td class="wikicell">Event Dispatcher (EVD) \r
3229                                                                 </td>\r
3230                                                                 <td class="wikicell">CQ (Completion Queue)</td>\r
3231                                                         </tr>\r
3232                                                         <tr>\r
3233                                                                 <td class="wikicell">Endpoint (EP) </td>\r
3234                                                                 <td class="wikicell">QP (Queue Pair)</td>\r
3235                                                         </tr>\r
3236                                                         <tr>\r
3237                                                                 <td class="wikicell">Public Service Point (PSP) \r
3238                                                                 </td>\r
3239                                                                 <td class="wikicell">connection identifier </td>\r
3240                                                         </tr>\r
3241                                                         <tr>\r
3242                                                                 <td class="wikicell">Reserved Service Point (RSP) \r
3243                                                                 </td>\r
3244                                                                 <td class="wikicell">connection identifier </td>\r
3245                                                         </tr>\r
3246                                                         <tr>\r
3247                                                                 <td class="wikicell">Connection Request (CR) \r
3248                                                                 </td>\r
3249                                                                 <td class="wikicell">connection manager event \r
3250                                                                 </td>\r
3251                                                         </tr>\r
3252                                                 </table>\r
3253                                         </div>\r
3254                                 </div>\r
3255                                 </td>\r
3256                         </tr>\r
3257                 </table>\r
3258         </div>\r
3259 </div>\r
3260 <div align="left">\r
3261         <h3 align="left"><font face="Courier New" size="3"><br>\r
3262         DAT ENVIRONMENT</font><font face="Courier New" size="2">:</font></h3>\r
3263 </div>\r
3264 <blockquote>\r
3265         <p align="left"><font face="Courier New" size="2">DAT/DAPL v1.1 (free-build) \r
3266         runtime libraries are installed into %SystemRoot%, with the v1.1 Debug \r
3267         versions located in '%SystemDrive%\%ProgramFiles(x86)%\WinOF'.&nbsp; Debug \r
3268         libraries are identified as datd.dll and dapld.dll.</font></p>\r
3269         <p align="left"><font face="Courier New" size="2">IA32 (aka, 32-bit) \r
3270         versions of DAT/DAPL 1.1 runtime libraries, found only on 64-bit systems, \r
3271         are identified in '%SystemDrive%\%ProgramFiles(x86)%\WinOF' as dat32.dll and \r
3272         dapl32.dll.<br>\r
3273         <br>\r
3274         DAT/DAPL 2.0 (free-build) libraries are identified in %SystemRoot% as \r
3275         dat2.dll and dapl2.dll.&nbsp; Debug versions of the v2.0 runtime libraries \r
3276         are located in '%SystemDrive%\%ProgramFiles(x86)%\WinOF'.</font></p>\r
3277         <p align="left"><font face="Courier New" size="2">IA32 (aka, 32-bit) \r
3278         versions of DAT/DAPL 2.0 runtime libraries, found only on 64-bit systems, \r
3279         are identified in '%SystemDrive%\%ProgramFiles(x86)%\WinOF' as dat232.dll \r
3280         and dapl232.dll.</font></p>\r
3281         <p align="left"><font face="Courier New" size="2">In order for DAT/uDAPL \r
3282         programs to execute correctly, the runtime library files 'dat.dll and \r
3283         dapl.dll' must be present in one of the following folders: current \r
3284         directory, %SystemRoot% or in the library search path.</font></p>\r
3285         <p align="left"><font face="Courier New" size="2">The default WinOF \r
3286         installation places the runtime library files dat.dll and dapl.dll in the '%SystemRoot%' folder; \r
3287         symbol files (.pdb) are located in '%SystemDrive%\%ProgramFiles(x86)%\WinOF'.</font></p>\r
3288         <p align="left"><font face="Courier New" size="2">The default DAPL configuration \r
3289         file is defined as '%SystemDrive%\DAT\dat.conf'. This default \r
3290         specification can be overriden by use of the environment variable \r
3291         DAT_OVERRIDE; see following environment variable discussion.</font></p>\r
3292     &n