	    Open Fabrics Enterprise Distribution (OFED)
	          Version 4.8 Release Notes
	               	   January 2017

===============================================================================
Table of Contents
===============================================================================
1. Overview, which includes:
	- OFED Distribution Rev 4.8 Contents
	- Supported Platforms and Operating Systems
	- Supported HCA and RNIC Adapter Cards and Firmware Versions
	- Tested Switch Platforms
	- Third party Test Packages
	- OFED sources
2. Change log
3. Known Issues

===============================================================================
1. Overview
===============================================================================
These are the release notes of OpenFabrics Enterprise Distribution (OFED)
release 4.8. The OFED software package is composed of several software modules,
and is intended for use on a computer cluster constructed as an InfiniBand
Fabric, an iWARP Network or a RoCE Fabric.

Note: If you plan to upgrade the OFED package on your cluster, please upgrade
all of its nodes to this new version.


1.1 OFED 4.8 Contents
-----------------------
The OFED package contains the following components:
 - OpenFabrics core and ULPs:
	- IB HCA drivers (mthca, mlx4, mlx5, qib, ehca)
	- iWARP RNIC driver (cxgb3, cxgb4, nes)
	- RoCE drivers (mlx4, ocrdma)
 - IB core
 - Upper Layer Protocols: IPoIB, SRP Initiator and target, RDS,
   uDAPL, qlgc_vnic and NFS-RDMA*.
 - OpenFabrics utilities:
	- OpenSM (OSM): InfiniBand Subnet Manager
	- Diagnostic tools
	- Performance tests
 - Extra packages:
	- infinipath-psm: Performance-Scaled Messaging API, an accelerated
	  interface to Intel(R) HCAs
	- Packages for Intel(R) Xeon Phi(TM) coprocessor systems (libibscif, ibpd)
	- IBSCIF Driver (ibscif)
	- libfbric - library that exports interfaces for fabric services to applications
	- CCL-Direct host-side drivers for Intel(R) Xeon Phi(TM) coprocessor systems:
        - HCA proxy (ibp_server)
        - Connection Manager proxy (ibp_cm_server)
        - Subnet Administrator proxy (ibp_sa_server)
	- Sources of all software modules (under conditions mentioned in the modules'
		LICENSE files)
	- Documentation


1.2 Supported Platforms and Operating Systems
---------------------------------------------
  o   CPU architectures:
	- x86_64
	- x86
	- ppc64

  o   Linux Operating Systems:
	- RedHat EL7.0 		3.10.0-123.el7
	- RedHat EL7.1 		3.10.0-210.el7
	- RedHat EL7.2 		3.10.0-327.el7
	- RedHat EL7.3 		3.10.0-514.el7
	- SLES12        	3.12.28-4
	- SLES12.1        	3.12.49-11.1
	- SLES12.2        	4.4.21-69-default
	- kernel.org		4.8    *

      * Minimal QA for these versions.

1.3 HCAs and RNICs Supported
----------------------------
This release supports IB HCAs by IBM, Intel and Mellanox Technologies, iWARP RNICs by Chelsio Communications and Intel and RoCE adapters by Emulex, IBM and Mellanox.

InfiniBand Adapters
  o   IBM HCAs:
	- GX Dual-port SDR 4x IB HCA
	- GX Dual-port SDR 12x IB HCA
	- GX Dual-port DDR 4x IB HCA
	- GX Dual-port DDR 12x IB HCA

  o   Intel (formerly QLogic) HCAs:
	- Intel(R) True Scale DDR PCIe x8 and x16 HCAs
	- Intel(R) True Scale QDR PCIe x8 Gen2 HCAs

  o   Mellanox Technologies HCAs (SDR, DDR and QDR Modes are Supported):
	- ConnectX(R) and ConnectX EN (Rev 2.9.1000)
	- ConnectX-2 (Rev 2.9.1200 and above)

  o   Mellanox Technologies HCAs (FDR and FDR10 Modes are Supported):
	- ConnectX-3 (Rev 2.33.5100 and above)
	- ConnectX-3 Pro (Rev 2.33.5100 and above)

  o   Mellanox Technologies HCAs (FDR and FDR10 Modes are Supported):
	- Connect-IB (Rev 10.10.5054 and above)

	For official firmware versions please see:
	http://www.mellanox.com/content/pages.php?pg=firmware_download

iWARP Adapters
  o   Chelsio RNICs:
	- S310/S320 10GbE Storage Accelerators
	- R310/R320 10GbE iWARP Adapters
	- T4: T420-CR, T440-CR, T422-CR, T404-BT, T440-LP-CR, T420-LL-CR, T420-CX
	- T5: T502-BT, T580-CR, T580-LP-CR, T520-LL-CR, T520-CR, T522-CR, T540-CR

  o   Intel RNICs:
	- NE020 10Gb iWARP Adapter

RoCE Adapters
 o   Emulex - using ocrdma
	- Emulex OCe14102 2-port 10 GbE RoCE
	- Emulex OCe14401 1-port 40 GbE RoCE

 o   IBM
	- IBM Flex System EN4132 2-port 10 GbE RoCE
	- IBM EL27 PCIe LP 2-Port 10GbE RoCE SFP+ adapter
	- IBM EC28 PCIe 2-Port 10GbE RoCE SFP+ adapter

  o   Mellanox
	- ConnectX-2 EN (Rev 2.9.1200 and above)
	- ConnectX-3 EN (Rev 2.31.5050 and above)

1.4 Switches Supported
----------------------
This release was tested with switches and gateways provided by the following
companies:
InfiniBand Switches
  o   Flextronics
	- F-X430044
  o   Intel (formerly QLogic)
	- 12200
  o   Mellanox
	- MLNX-OS MSX6036/SX6025 w/w MLNX-OS version 3.3.4304
	- Grid Director 4036 w/w Grid Director version 3.9.2-992
	- FabricIT EFM IS5035 w/w FabricIT EFM version 1.1.3000
	- FabricIT BXM MBX5020 w/w FabricIT BXM version 2.1.2000

iWARP Switches
  o   Fujitsu
	- XG2000C 10Gb Ethernet Switch

RoCE Switches
  o   Arista
  o   BLADE Network Technologies (BNT)
  o   Mellanox
	- SX1036
	- SX1024
	- SX1016

1.5 Third Party Packages
------------------------
The following third party packages have been tested with OFED 4.8:
- Open MPI - 1.8
- Intel MPI 4.1.3
- MVAPICH2 

1.6 OFED Sources
----------------
All sources are located under git://git.openfabrics.org/

Linux:
------
URL: git://git.openfabrics.org/compat-rdma/linux-4.8.git
Branch: master

- Linux kernel sub-tree that includes files relevant for the OFED project only.
  Based on v4.8. Used to shorten git clone time.
  Note: the regular Linux git tree can be used as well.

compat:
-------
URL: git://git.openfabrics.org/compat-rdma/compat.git
Branch: ofed

- Based on compat project (https://github.com/mcgrof/compat). The compat module
  provides functionality introduced in newer kernels to older kernels through a
  set of header files and exported symbols.
  See https://github.com/mcgrof/compat/wiki for details.
- Used to replace kernel_addons in the previous OFED kernel tree.

compat-rdma:
------------
URL: git://git.openfabrics.org/compat-rdma/compat-rdma.git
Branch: master

User level Sources are downloaded from http://www.openfabrics.org/downloads/
as written in the BUILD_ID

The kernel sources are based on Linux 4.8 mainline kernel. Its patches
are included in the OFED sources directory.
For details see HOWTO.build_ofed.

The list of maintainers is available under:
http://www.openfabrics.org/downloads/MAINTAINERS

===============================================================================
2. Change log
===============================================================================
OFED-4.8-rc1 Main Changes from OFED 3.18-2 GA
-------------------------------------------------------------------------------
1. Updated packages:
 - compat-rdma-4.8

===============================================================================
3. Known Issues
===============================================================================
The following is a list of general limitations and known issues of the various
components of the OFED 4.8 release.

01. When upgrading from an earlier OFED version, the installation script does
    not stop the earlier OFED version prior to uninstalling it.
    Workaround: Stop the old OFED stack (/etc/init.d/openibd stop) before
    upgrading to OFED 4.8 or reboot the server after OFED installation.
02. Memory registration by the user is limited according to administrator
    setting. See "Pinning (Locking) User Memory Pages" in OFED_tips.txt for
    system configuration.
03. Fork support from kernel 2.6.12 and above is available provided
    that applications do not use threads. fork() is supported as long as the
    parent process does not run before the child exits or calls exec().
    The former can be achieved by calling wait(childpid), and the latter can be
    achieved by application specific means.  The Posix system() call is
    supported.
04. The qib driver is supported only on 64-bit platforms.
05. IPoIB: brctl utilities do not work on IPoIB interfaces. The reason for that
    is that these utilities support devices of type Ethernet only.
06. In case uninstall is failing, check the error log and remove
    the remaining RPMs manually using 'rpm -e <rpms list>'.
07. On SLES11.x, set allow_unsupported_modules parameter to 1 in file:
    /etc/modprobe.d/unsupported-modules. Without this the modules will not
    load.
08. RDS is not supported.
09. Bug 2515: when an Intel HCA is attached directly to a Mellanox ConnectX3
    and the OpenSM is started on the Intel HCA, the link will not go to active.
    The workaround is to start the OpenSM on the Mellanox HCA.
10. Bug 2553: Unable to run UD traffic using qperf on a RoCE R-NIC
11. Bug 2561: Devices do not receive the echo reply of the first ping sequence 
    when the payload size is 65493 or higher. This is still an issues in the 
    4.3 kernel and should be resolved in a future OFED 4.x release
12. Bug 2574: Installing OFED (with --with_xeon_phi and qib=y in ofed.conf file)
    makes the access to the scif char device fail.
    psmd uses scif functions to allow psm to connect to the Phi devices. 
    It also makes sure it can connect to them when the service is started.
    Scif functions cannot be called unless the mpss service is running.
    Since openibd starts the psmd service, it should be loaded after mpss
13. Bug 2580:  NFSoRDMA client on PPC64LE will crash while trying to mount to 
    a NFSoRDMA server running on x86 box. This will be resolved in OFED 4.8
14. The ipath and eHCA drivers will be deprecated in the next OFED build that 
    uses a kernel >= 4.3 
15. Bug 2583: "iwpm_mapping_error_cb: Received msg seq = 381240 err code = 12
	client = 3" seen intermittently
16. Bug 2587: autoconf is needed by ibacm-1.1.0-1.x86_64
17. Bug 2596: Host crash related to mlx5 driver, ConnectIB HCAs, ib_srp, and
    performing IO
18. cmake and ninja packages are required to build rdma-core package.
	ninja binary RPMs can be downloaded from https://software.opensuse.org/package/ninja
	On SLES12 cmake-3.5 or higher is required. The working cmake version can be
	taken from SLES12 SP2 and installed on SLES12 SP0 or SP1.


Note: See the release notes of each component for additional issues.

