Mellanox Technologies

===============================================================================
                      Mellanox OFED 1.5.2 for Linux
             IbDump 1.0.5 - ConnectX HCA Sniffing Utility 
===============================================================================

===============================================================================
Table of Contents
===============================================================================
1. Overview
2. Supported Systems
3. New features
4. Major Bugs Fixed 
5. Known Issues

===============================================================================
1. Overview
===============================================================================
The ibdump tool dumps InfiniBand traffic that flows to and from 
Mellanox ConnectX®/ConnectX®-2 adapters.
It provides a similar functionality to the tcpdump tool on an Ethernet network.
The ibdump tool generates packet dump file is in .pcap format. 
This file can be loaded by the Wireshark tool for graphical traffic analysis.  
This provides the ability to analyze network behavior and performance, 
and to debug applications that send or receive InfiniBand network traffic.
Run "ibdump -h" to display a help message which details the tools options.

1.1 Package Contents
--------------------
The tarball contains an RPM package for each supported system.
The RPM installs the ibdump tool under /usr/bin

1.2 Installation and pre-requisites
-----------------------------------
Note: Installing ibdump requires OFED or MLNX_OFED 1.5.

ibdump Installation:
1. Select the RPM that matches the target system.
2. Run:
     > rpm -i ibdump-1.0.5-4.<arch>-<os>.rpm 

1.3 How to Get Wireshark
------------------------
Download the current release from www.wireshark.org for a Linux or Windows
environment.

Note: 
Although ibdump is a Linux application, the generated .pcap file may be
analyzed on either operating system.

Note:
The InfiniBand plug-in released with the current Wireshark version (rev 1.4.2)
has a basic IB packets parser which includes Verbs level, IPoIB adn some SMP
Mads parsing. 
To get the latest version of the IB plugin, which includes EoIB, 
SDP, and FCoIB parsing, download the latest Wireshark daily build:
- For Windows: Download the exe installer from
  http://www.wireshark.org/download/automated/win32/ and install it
- For Linux: Download the Wireshark dev source tarball from
  http://www.wireshark.org/download/automated/src/ and build it


===============================================================================
2. Supported Systems
===============================================================================
- CPU architectures:
  - x86_64
  - x86
  - power-pc

- Linux Operating Systems:
  - RedHat EL5 up4
  - RedHat EL5 up5
  - RedHat EL5 up6
  - RedHat EL6           
  - SLES10 SP3
  - SLES11
  - SLES11 SP1

===============================================================================
3. New Features
===============================================================================
* Improved capture performance
* Added --silent flag: Do not pring progress indication
* Progress indication is refreshed every 1 second in order to save overhead.


===============================================================================
4. Major Bugs Fixed 
===============================================================================
* Fixed: -d flag (device selection) was ignored on certain setups.


===============================================================================
5. Known Issues
===============================================================================
* ibdump may encounter packet drops upon a burst of more than 4096 (or
  2^max-burst) packets.
* Packets loss is not reported by ibdump.
* Outbound retransmitted and multicast packets may not be collected correctly.
* ibdump may stop capturing packets when run on the same port of the Subnet
  Manager (E.G.: opensm). It is advised not to run the SM and ibdump on the same
  port.