Arm Performance Libraries 21.0.0 Release Note
=============================================

Non-Confidential
Copyright © 2015-2021, Arm Limited (or its affiliates). All rights reserved.

Non-Confidential Proprietary Notice
===================================

This document is protected by copyright and other related rights and the
practice or implementation of the information contained in this document may be
protected by one or more patents or pending patent applications. No part of this
document may be reproduced in any form by any means without the express prior
written permission of Arm. No license, express or implied, by estoppel or
otherwise to any intellectual property rights is granted by this document
unless specifically stated.

Your access to the information in this document is conditional upon your
acceptance that you will not use or permit others to use the information for
the purposes of determining whether implementations infringe any third party
patents.

THIS DOCUMENT IS PROVIDED “AS IS”. ARM PROVIDES NO REPRESENTATIONS AND NO
WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE
IMPLIED WARRANTIES OF MERCHANTABILITY, SATISFACTORY QUALITY, NON-INFRINGEMENT
OR FITNESS FOR A PARTICULAR PURPOSE WITH RESPECT TO THE DOCUMENT. For the
avoidance of doubt, Arm makes no representation with respect to, and has
undertaken no analysis to identify or understand the scope and content of,
patents, copyrights, trade secrets, or other rights.

This document may include technical inaccuracies or typographical errors.

TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT WILL ARM BE LIABLE FOR ANY
DAMAGES, INCLUDING WITHOUT LIMITATION ANY DIRECT, INDIRECT, SPECIAL,
INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, HOWEVER CAUSED AND REGARDLESS
OF THE THEORY OF LIABILITY, ARISING OUT OF ANY USE OF THIS DOCUMENT, EVEN IF
ARM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

This document consists solely of commercial items. You shall be responsible for
ensuring that any use, duplication or disclosure of this document complies fully
with any relevant export laws and regulations to assure that this document or
any portion thereof is not exported, directly or indirectly, in violation of
such export laws. Use of the word “partner” in reference to Arm’s customers is
not intended to create or refer to any partnership relationship with any other
company. Arm may make changes to this document at any time and without notice.

If any of the provisions contained in these terms conflict with any of the
provisions of any click through or signed written agreement covering this
document with Arm, then the click through or signed written agreement prevails
over and supersedes the conflicting provisions of these terms. This document may
be translated into other languages for convenience, and you agree that if there
is any conflict between the English version of this document and any
translation, the terms of the English version of the Agreement shall prevail.

The Arm corporate logo and words marked with ® or ™ are registered trademarks or
trademarks of Arm Limited (or its affiliates) in the US and/or elsewhere. All
rights reserved. Other brands and names mentioned in this document may be the
trademarks of their respective owners. Please follow Arm’s trademark usage
guidelines at http://www.arm.com/company/policies/trademarks.

Copyright © 2015-2021, Arm Limited (or its affiliates). All rights reserved.

Arm Limited. Company 02557590 registered in England.

110 Fulbourn Road, Cambridge, England CB1 9NJ.

(LES-PRE-20349)

Confidentiality Status
----------------------

This document is Non-Confidential. The right to use, copy and disclose this
document may be subject to license restrictions in accordance with the terms
of the agreement entered into by Arm and the party that Arm delivered this
document to.

Unrestricted Access is an Arm internal classification.

Product Status
--------------

The information in this document is Final, that is for a developed product.

Web Address
-----------

https://developer.arm.com

Progressive terminology commitment
----------------------------------

Arm values inclusive communities. Arm recognizes that we and our industry have
used terms that can be offensive. Arm strives to lead the industry and create
change.

We believe that this document contains no offensive terms. If you find offensive
terms in this document, please email terms@arm.com.

Contents
========

- Conventions
- Release overview
- Release contents
- Get started
- Support
- Release History

Conventions
===========

The following subsections describe conventions used in Arm documents.

Glossary
--------

The Arm Glossary is a list of terms that are used in Arm documentation, together
with definitions for those terms. The Arm Glossary does not contain terms that
are industry standard unless the Arm meaning differs from the generally accepted
meaning.

See the Arm Glossary for more information: https://developer.arm.com/glossary.

Release overview
================

Use of the free of charge version of Arm Performance Libraries is subject to the
terms and conditions of the applicable End User License Agreement (“EULA”). A
copy of the EULA can be found in the 'license_terms' folder of your product
installation.

Product description
-------------------

The Arm Performance Libraries 21.0.0 package provides
GCC 10.2-compatible libraries that:

  - Run on all Armv8-A AArch64 64-bit-based implementations.
  - Are optimized for Arm® Neoverse™ N1-based implementations.

Release Status
--------------

This is the 21.0.0 release of Arm Performance Libraries.

These deliverables are being released under the terms of the agreement between
Arm and each licensee (the "Agreement"). All planned verification and
validation is complete.
The release is suitable for volume production under the terms of the Agreement.

Release contents
================

The following sub-sections describe:
- The product parts that are delivered as part of this release.
- Any changes since the previous release.
- Any known issues and limitations that exist at the time of this release.

Deliverables
------------

- Arm Performance Libraries 21.0.0
- Release Notes (this document)
- Documentation (product documentation is available on the Arm Developer
  website at:

  https://developer.arm.com/tools-and-software/server-and-hpc/downloads/arm-performance-libraries)

  Documentation may change between product releases. For the latest
  documentation bundle, check the delivery platform.

  Arm tests its PDFs only in Adobe Acrobat and Acrobat Reader. Arm cannot
  guarantee the quality this document when used with any other PDF reader.
  A suitable file reader can be downloaded from Adobe at http://www.adobe.com

Differences from previous release
---------------------------------

The following subsections describe differences from the previous release of
Arm Performance Libraries.

Additions and changes:
~~~~~~~~~~~~~~~~~~~~~~

Describes new features or components added, or any technical changes to
features or components, in this release.

- Arm Performance Libraries now supports all real-to-real transform functions
  defined in the FFTW3 interface. Previously, the planner functions for these
  types of transforms returned NULL, indicating that they were unavailable.

- Added support for ?GEMMT BLAS extension routines for all types, performing
  matrix-matrix multiplication and updating the lower or upper triangular part
  of C only.

- Added a new suite of routines that are optimized for large batches of small
  linear algebra problems. Interfaces for the following real and double
  precision problems are provided:

  * BLAS: DDOT, DGER, DGEMM, DGEMV, DSCAL, DTRMM, DTRSM, and DTRSV
  * LAPACK: DGEQR (QR), DGETRF (LU), and DPOTRF (Cholesky)
  * DORMQR and DORGQR (for multiplying and generating Q)
  * Utility routines for packing and unpacking matrices to and from the new
  batched data layout.

  An example and full documentation are provided.

- Improved performance for:

  * BLAS level 1 routines: ?IAMAX, ?NRM2, ?ASUM, and ?DOT
  * BLAS level 2 routines: ?HBMV, ?SBMV, ?TBMV, ?SYR, and ?SYR2
  * BLAS level 3 routines: ?TRSM and [SD]GEMM
  * LAPACK routines: ?POTRF and ?GETRF (for small problems)
  * General small problems

- Vector performance improvements in libamath:

  * Neon functions: atan, atanf, erf, erff, exp2, exp2f, exp10, and exp10f
  * SVE functions: atan, erff, cos, cosf, pow, sin, sincos, and sincosf

Resolved issues:
~~~~~~~~~~~~~~~~

Describes any technical issues resolved in this release.

- If you attempt to install the library using the
  `--install-to <installation-location>` option, the installer might generate a
  warning of the form: 'Installing...find:
  '<installation-location>/arm-*-compiler-<version>*/lib/clang/*/armpl_links':
  No such file or directory'. This warning is erroneous and does not impact the
  installation or function of the library.

- The prototypes for the following LAPACKE functions were previously missing:

  * lapacke_?geqpf
  * lapacke_?geqpf_work
  * lapacke_?ggsvd
  * lapacke_?ggsvd_work
  * lapacke_?ggsvp
  * lapacke_?ggsvp_work

  The prototypes are now available in armpl.h.

Known limitations
-----------------

There are no open technical issues at the time of this release.

Get started
===========

This section describes information to help you get started with accessing,
setting up, and using Arm Performance Libraries.

For more information, see the Get Started information on the Arm Developer
website:

  https://developer.arm.com/tools-and-software/server-and-hpc/downloads/arm-performance-libraries

Licensing information
---------------------

Use of the free of charge version of Arm Performance Libraries is subject to the
terms and conditions of the applicable End User License Agreement (“EULA”). A
copy of the EULA can be found in the 'license_terms' folder of your product
installation.

You do not require a license to use this Arm Performance Libraries package.

Prerequisites
-------------

If any of the following tools are not already installed by your Linux
distribution, you must install them before installing Arm Performance Libraries:

- Python (version 2.7 or later)
- C Libraries:
   - SLES and RHEL: glibc-devel
   - Ubuntu:        libc6-dev

Download the product
--------------------

Arm delivers the files through the Arm Developer website:

  https://developer.arm.com/tools-and-software/server-and-hpc/downloads/arm-performance-libraries

Unpack the product
------------------

The following steps describe how to unpack each constituent part delivered in
this bundle:

1. Relocate the bundle file. Move the .tar files to the directory you want to
   install the product in.

2. Extract the tar file contents using a tar utility:

     tar -xvf arm-performance-libraries_21.0.0_gcc-10.2.tar

Directory structure:
--------------------

Shows the principal directory structure of this release created after unpacking
the bundle:

  license_terms/
  arm-performance-libraries_<version>_*.sh
  RELEASE_NOTES.txt

Install the product
-------------------

To install Arm Performance Libraries, run the installation script as a
privileged user and pass any options to configure the installation:

  ./arm-performance-libraries_<version>_*.sh <option> <option>

Some common installation options are:

- For a headless installation and to automatically accept the EULA, use
  the '--accept' option.
- To perform a local install, use the '--install-to <dir>' option.

For a full list of supported installation options, see:

  https://developer.arm.com/tools-and-software/server-and-hpc/downloads/arm-performance-libraries

The installer displays the EULA and prompts you to agree to the terms. Type
'yes' at the prompt to continue.

The packages are unpacked to
<install_location>/arm-performance-libraries_21.0.0_gcc-10.2,
and <install_location>/armpl_21.0.0_gcc-10.2,
with environment modulefiles available under <install_location>/modulefiles. The
default installation location is /opt/arm/. Local installs have the same
directory structure starting from your chosen installation root.

RPMs
----

The installed packages are shipped as RPMs for RPM based Linux distributions.
These RPMs are signed by Arm's High Performance Computing (HPC) GPG key. The
public key can be downloaded from:

  https://developer.arm.com/-/media/files/keys/GPG-PUB-KEY-ARM-HPC-SW-TOOLS.PUB

This key can be imported by running:

  rpm --import GPG-PUB-KEY-ARM-HPC-SW-TOOLS.PUB

More information about Environment Modules can be found at:

http://modules.sourceforge.net

Run the product
---------------

1. Load the environment module.

     module load <install_location>/modulefiles/armpl/21.0.0_gcc-10.2

2. To generate an executable binary with GCC, compile your program with Arm
   Performance Libraries. Use:

     gcc -I<install_dir>/include -L<install_dir>/lib <-larmpl> -lgfortran -lm [options] -o <binary> <input>

   or

     gfortran -I<install_dir>/include -L<install_dir>/lib <-larmpl> -lm [options] -o <binary> <input>

   where:

   - <-larmpl> is one of: -larmpl, -larmpl_lp64, -larmpl_ilp64, -larmpl_lp64_mp,
     or -larmpl_ilp64_mp.
   - [options] denotes any other GCC compiler options
   - <input> is the source file (or files)
   - <binary> is the application executable to build

3. Run the generated binary <binary>:

     ./<binary>

Examples
--------

Example code can be found at:

<install_location>/armpl_21.0.0_gcc-10.2/examples

You need to copy this code to a writeable directory and load Arm Performance
Libraries environment module for the examples to build.

For example:

1. Copy the examples somewhere writeable:

     cp -r <install_location>/armpl_21.0.0_gcc-10.2/examples ./
     cd examples

2. Load the correct environment modules:

     module load <install_location>/modulefiles/armpl/21.0.0_gcc-10.2

3. Build the examples:

     make

Uninstall
---------

For convenience, this package includes an "uninstall.sh" script at:

  <install_location>/arm-performance-libraries_21.0.0_gcc-10.2/uninstall.sh

This script attempts to uninstall all the components supplied as part of
Arm Performance Libraries. However, if other packages outside of this product
depend on the GCC component, GCC will not be uninstalled.

If you require support when uninstalling any version of Arm Performance
Libraries, contact support-hpc-sw@arm.com.

Support
=======

Documentation for using this Arm Performance Libraries package is available on
the Arm Developer website at:

  https://developer.arm.com/tools-and-software/server-and-hpc/downloads/arm-performance-libraries

Reference documentation for the supported routines in Arm Performance Libraries
is available at:

  https://developer.arm.com/docs/101004/latest

If you have any issues with the installation, content or use of this release,
create a post that describes your issue on the Arm Community HPC forum:

  https://community.arm.com/developer/tools-software/hpc/f/hpc-user-group

Arm will respond as soon as possible.

These deliverables are being released under the terms of the agreement between
Arm and each licensee (the “Agreement”). All planned verification and
validation is complete. The release is suitable for volume production under
the terms of the Agreement.

OS
--

These libraries are supported on the following Linux platforms:

- AArch64 RHEL 7 and 8
- AArch64 SLES 15
- AArch64 Ubuntu 18.04 and 20.04

Full information about the platforms supported by Arm Performance Libraries is
available on the Arm Developer website:

  https://developer.arm.com/tools-and-software/server-and-hpc/downloads/arm-performance-libraries

Release history
===============

A full release history (with release notes) for Arm Performance Libraries is
available on the Arm Developer website:

  https://developer.arm.com/tools-and-software/server-and-hpc/downloads/arm-performance-libraries/release-history
