Mellanox Technologies
---------------------


=============================================================
=   MellanoX Messaging (MXM) Release Notes                  =
=   Version 1.5                                             =
=   Last Modified on January 13, 2012                       =
=============================================================


--------------------------------------------------------------
NOTE:

THIS HARDWARE, SOFTWARE OR TEST SUITE PRODUCT (“PRODUCT(S)”) 
AND ITS RELATED DOCUMENTATION ARE PROVIDED BY MELLANOX 
TECHNOLOGIES “AS-IS” WITH ALL FAULTS OF ANY KIND AND SOLELY 
FOR THE PURPOSE OF AIDING THE CUSTOMER IN TESTING APPLICATIONS 
THAT USE THE PRODUCTS IN DESIGNATED SOLUTIONS. THE CUSTOMER'S 
MANUFACTURING TEST ENVIRONMENT HAS NOT MET THE STANDARDS SET 
BY MELLANOX TECHNOLOGIES TO FULLY QUALIFY THE PRODUCTO(S) 
AND/OR THE SYSTEM USING IT. THEREFORE, MELLANOX TECHNOLOGIES 
CANNOT AND DOES NOT GUARANTEE OR WARRANT THAT THE PRODUCTS 
WILL OPERATE WITH THE HIGHEST QUALITY. ANY EXPRESS OR IMPLIED 
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR 
PURPOSE AND NONINFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL 
MELLANOX BE LIABLE TO CUSTOMER OR ANY THIRD PARTIES FOR ANY 
DIRECT, INDIRECT, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
OF ANY KIND (INCLUDING, BUT NOT LIMITED TO, PAYMENT FOR 
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
IN ANY WAY FROM THE USE OF THE PRODUCT(S) AND RELATED 
DOCUMENTATION EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 
DAMAGE.

--------------------------------------------------------------
© Copyright 2012. Mellanox Technologies. All rights reserved

Mellanox®, BridgeX®, ConnectX®, CORE-Direct®, InfiniBlast®, 
InfiniBridge®, InfiniHost®, InfiniRISC®, InfiniScale®,
InfiniPCI®, PhyX®, SwitchX®, UFM®, Virtual Protocol 
Interconnect®, and Voltaire® are registered trademarks of 
Mellanox Technologies, Ltd. 

Connect-IB™, FabricIT™, MetroX™, 
MLNX-OS™, Unbreakable-Link™, UFM™ and Unified Fabric Manager™ 
are trademarks of Mellanox Technologies, Ltd.
All other marks and names mentioned herein may be trademarks 
of their respective companies.


Contents
========
1. Overview
2. Changes in This Release
3. Supported Platforms and Operating Systems
4. Known Issues

===============================================================================
1. Overview
===============================================================================
These are the release notes for the Mellanox MXM 1.5
MellanoX Messaging (MXM) library provides enhancements to parallel communication
libraries by fully utilizing the underlying networking infrastructure provided 
by Mellanox HCA/switch hardware. 
This includes a variety of enhancements that take advantage of Mellanox networking
hardware including:
• Multiple transport support including RC, XRC and UD
• Proper management of HCA resources and memory structures
• Efficient memory registration
• One-sided communication semantics
• Connection management
• Receive side tag matching
• Intra-node shared memory communication
These enhancements significantly increase the scalability and performance of 
message communications in the network, alleviating bottlenecks within 
the parallel communication libraries.

===============================================================================
2. Changes in This Release
===============================================================================
Mellanox MXM v1.5 provides the following changes and new features:

Mellanox MXM v1.5 Main Changes (from v1.1):
-------------------------------------------------------------
1. Added Ethernet support.
2. Added Multi-Rail support.
3. Bugs fixes from MXM v1.1.

===============================================================================
3. Supported Platforms and Operating Systems
===============================================================================
The following is the list of supported patforms and OSes:

 - Supported platforms:
   - MLNX_OFED: 1.5.3-3.1.0
   - OpenMPI: 1.6.3 and later

 - Linux Operating Systems:
   - RHEL5.5
   - RHEL6.1
   - RHEL6.2
   - RHEL6.3
   - SLES10 SP4
   - SLES11 SP1
   - SLES11 SP2
   - CentOS5.6
   - CentOS5.7
   - CentOS6.0

=============================================================================== 
4. Known Issues
===============================================================================
 - MXM over Ethernet does not function for MTUs which are higher than 1024B 
   when using firmware version 2.11.0500
 
 - If the following error is displayed: 
   
   shm_queue.c:280  MXM ERROR Failed to get receive event, use:  
   -x MXM_SHM_RX_MAX_BUFFERS=32768. i.e. 
   mpirun -x MXM_SHM_RX_MAX_BUFFERS=32768 ...
   
   Increase the value of MXM_SHM_RX_MAX_BUFFERS to more than 32768 
   if the previous value did not help

 - MXM disqualifies itself in one of the following cases:
   - If there are no active ports
   - If less than 128 processes are running (default 128) 
     and the "-mca mtl_mxm_np X"* is not set to specify otherwise
     *(X = Num of processes to ativate MXM)

 - While working, MXM may show excessive log message.
   To reduce the amount of log messages to minimum, use: 
   -x MXM_LOG_LEVEL=fatal
   i.e. mpirun -x MXM_LOG_LEVEL=fatal ...
 	 
 - A mixed configuration of active ports (one InfiniBand and the other Ethernet) 
   on one card is not supported.
   In such case, please specify the port you would like to use 
   with “-x MXM_RDMA_PORTS”