Arm Performance Reports 19.1.4 Release Notes
============================================
Copyright (c) 2002-2019 Arm Limited (or its affiliates). All rights reserved.

Arm Performance Reports 19.1.4 helps you characterize and understand the performance of your HPC application runs in a simple one-page report.

Contents
========

This document provides information specific to the 19.1.4 release of Arm Performance Reports:

- Changes in this release:
    - New features and enhancements
    - Bug fixes
- Known issues
- System requirements
- Installing, uninstalling, licensing
- Running the tools
- Where to find example code
- How to access user documentation
- How to contact support

For information about previous releases of Arm Performance Reports, refer to the release history online:

https://developer.arm.com/products/software-development-tools/hpc/arm-performance-reports/release-history

Changes in this release
=======================

- New features and enhancements:

None in this release.

- Bug fixes:

[FOR-8192] The link to the Arm website from the Arm Performance Reports logo now takes you to the Arm Developer website, for more relevant information.

Known issues
============

Please refer to the known issues section on the Arm Developer website:

https://developer.arm.com/products/software-development-tools/hpc/arm-performance-reports/known-issues


System requirements
===================

Please refer to the supported platforms pages on the Arm Developer website:

https://developer.arm.com/products/software-development-tools/hpc/arm-performance-reports/arm-performance-reports-platforms

Installation instructions
=========================

Run the graphical "installer" or the text-only "textinstall.sh" from the download tarball.

You may choose to install just for you or for all users on your system.

If you are installing on a cluster, please make sure the package is available at the same path on every machine.

Full installation instructions are available in the Arm Performance Reports user guide, available on the Arm Developer website:

https://developer.arm.com/docs/101137/latest/installation

Uninstalling Arm Performance Reports
====================================

To uninstall Arm Performance Reports, remove the installation directory from your system:

rm -r <installation-dir>

Licences
========

If you do not have a licence file you will need to obtain one from Arm. Evaluation licences may be obtained from the Arm website:

https://www.arm.com/products/development-tools/hpc-tools/get-software

Full licences may be obtained by emailing HPCToolsSales@arm.com. Licence files should be stored in a directory called licences below the installation directory. For a default (root) installation, that directory would be:

   /opt/arm/reports/licences

and for a user-only installation it would be:

   ${HOME}/arm/reports/licences

Running Arm Performance Reports
===============================

To run Arm Performance Reports, add 'perf-report' in front of your existing mpiexec or aprun command-line, e.g.:

     {arm-reports-path}/bin/perf-report mpiexec -n 4 examples/wave_c

If {arm-reports-path}/bin is in your $PATH, just 'perf-report' will do.

Your chosen program will be run just as before and two report files, one .txt and one .html will be created in the current directory on completion. If you have problems starting your program under Performance Reports, first ensure it can run without Performance Reports with no errors.

You can use the --output/-o argument to specify a single output file name.

See perf-report --help or the user guide for more information.

Examples
========

Example code can be found in the installation directory:

   <INSTALL_DIR>/examples

Copy the example code to a writeable directory and run the examples using the makefiles provided.

Documentation
=============

Once installed these release notes can be found in the installation directory, and online at:

https://developer.arm.com/products/software-development-tools/hpc/arm-performance-reports/release-history

The Arm Performance Reports user guide is available in the <INSTALL_DIR>/doc directory, or online here:

https://developer.arm.com/docs/101137/latest/introduction

Further documentation, help and tutorials can be found online at:

https://developer.arm.com/products/software-development-tools/hpc/documentation

Support
=======

If you require support or would like to provide feedback, please contact allinea-support@arm.com or use our support request form online:

https://developer.arm.com/products/software-development-tools/hpc/get-support

Changes in this release

Arm Performance Reports 19.0 covers the following releases:

• Arm Performance Reports 19.0.0 - Released 7th December 2018
• Arm Performance Reports 19.0.1 - Released 18th December 2018
• Arm Performance Reports 19.0.2 - Released 25th January 2019
• Arm Performance Reports 19.0.3 - Released 1st March 2019
• Arm Performance Reports 19.0.4 - Released 29th March 2019
• Arm Performance Reports 19.0.5 - Released 3rd May 2019

New features and enhancements:

19.0.0

• None in this release.

19.0.1

• None in this release.

19.0.2

• None in this release.

19.0.3

• None in this release.

19.0.4

• Support for profiling debug versions of Python.

19.0.5

• None in this release

Bug fixes:

19.0.0

• [FOR-5412] You can now launch serial programs that are in the environment's path without specifying the full path.
• [FOR-6217] Fixed an issue that caused a slowdown in the analysis phase.

19.0.1

• [FOR-6407] Fixed a startup issue with CRAY ALPS.

19.0.2

• [FOR-6510] Arm Performance Reports can now profile applications when SHELL is unset.

19.0.3

• [FOR-6564] The Known Issues section of the Forge user guide has been updated to describe compilation flags for OpenMPI 3.x with GCC, to fix a startup issue.
• [FOR-6644] Re-enabled Accelerator Metrics.

19.0.4

• [FOR-6791] Fixed an issue that causes the incorrect number of physical cores to be reported.
• [FOR-6886] Fixed an issue that occurs when using the PGI compiler to link with the static MAP sampler library.

19.0.5

• [FOR-6988] Fixes an issue when debugging static PGI binaries.
• [FOR-7106] Fixes an issue where the number of OpenMP threads were not being set correctly when using express launch.
• [FOR-7094] Fixes an issue where processes launched by srun would have their CPU affinity settings reset.

Known issues

Please refer to the known issues page.

System requirements

Please refer to the supported platforms page.

Installation instructions

Run the graphical "installer" or the text-only "textinstall.sh" from the download tarball.

You may choose to install just for you or for all users on your system.

If you are installing on a cluster, please make sure the package is available at the same path on every machine.

Full installation instructions are available in the Arm Performance Reports user guide.

Uninstalling Arm Performance Reports

To uninstall Arm Performance Reports, remove the installation directory from your system:

rm -r <installation-dir>

Licences

If you do not have a licence file you will need to obtain one from Arm. Get an evaluation licence.

Full licences may be obtained by emailing HPCToolsSales@arm.com. Licence files should be stored in a directory called licences below the installation directory. For a default (root) installation, that directory would be:

/opt/arm/reports/licences

For a user-only installation it would be:

${HOME}/arm/reports/licences

Running Arm Performance Reports

To run Arm Performance Reports, add 'perf-report' in front of your existing mpiexec or aprun command-line:

{arm-reports-path}/bin/perf-report mpiexec -n 4 examples/wave_c

If {arm-reports-path}/bin is in your $PATH, you can use:

perf-report

Your chosen program will be run just as before and two report files, one .txt and one .html will be created in the current directory on completion. If you have problems starting your program under Performance Reports, first ensure it can run without Performance Reports with no errors.

You can use the --outputor -o argument to specify a single output file name.

See perf-report --help or the user guide for more information.

Examples

Example code can be found in the installation directory:

<INSTALL_DIR>/examples

Copy the example code to a writeable directory and run the examples using the makefiles provided.

Documentation

Once installed these release notes can be found in the installation directory, and on the Release History page on the Arm Developer website.

The Arm Performance Reports user guide is available in the <INSTALL_DIR>/doc directory, or online here.

Further documentation, help and tutorials can be found on the Arm Developer website.

Support

If you require support or would like to provide feedback, please contact allinea-support@arm.com or use our support request form.

Changes in this release

New features and enhancements:

• Performance Reports is now supported on IBM Power 8 and 9 systems.
• Reduced runtime overhead when profiling OpenMP programs with short running parallel regions.
• Updated supported platforms information in the Appendix of the user guide.

Bug fixes:

• [FOR-5909] Fixed an issue where the Windows client could not establish a multihop remote connection.

Known issues

Please refer to the known issues section on the Arm Developer website: https://developer.arm.com/products/software-development-tools/hpc/arm-performance-reports/known-issues.

System requirements

Please refer to the supported platforms pages on the Arm Developer website: https://developer.arm.com/products/software-development-tools/hpc/arm-performance-reports/arm-performance-reports-platforms.

Installation instructions

Run the graphical "installer" or the text-only "textinstall.sh" from the download tarball. You may choose to install just for you or for all users on your system.

If you are installing on a cluster, please make sure the package is available at the same path on every machine.

Full installation instructions are available in the Arm Performance Reports user guide, available on the Arm Developer website: https://developer.arm.com/docs/101137/latest/installation.

Uninstalling Arm Performance Reports

To uninstall Arm Performance Reports, remove the installation directory from your system:

rm -r <installation-dir>

Licenses

If you do not have a license file you will need to obtain one from Arm. Evaluation licenses may be obtained from the Arm website: https://www.arm.com/products/development-tools/hpc-tools/get-software.

Full licenses may be obtained by emailing HPCToolsSales@arm.com. License files should be stored in a directory called licenses below the installation directory. For a default (root) installation, that directory would be:

/opt/arm/reports/licences

For a user-only installation it would be:

${HOME}/arm/reports/licences

Running Arm Performance Reports

To run Arm Performance Reports, add 'perf-report' in front of your existing mpiexec or aprun command-line, for example:

{arm-reports-path}/bin/perf-report mpiexec -n 4 examples/wave_c

Or, if {arm-reports-path}/bin is in your $PATH, you can use

perf-report

Your chosen program will be run just as before and two report files, one .txt and one .html will be created in the current directory on completion. If you have problems starting your program under Performance Reports, first ensure it can run without Performance Reports with no errors.

You can use the --output/-o argument to specify a single output file name.

See perf-report --help or the user guide for more information.

Examples

Example code can be found in the installation directory: <INSTALL_DIR>/examples.

Copy the example code to a writeable directory and run the examples using the makefiles provided.

Documentation

Once installed these release notes can be found in the installation directory, and online at: https://developer.arm.com/products/software-development-tools/hpc/arm-performance-reports/release-history.

The Arm Performance Reports user guide is available in the <INSTALL_DIR>/doc directory, or online here: https://developer.arm.com/docs/101137/latest/introduction.

Further documentation, help and tutorials can be found online at: https://developer.arm.com/products/software-development-tools/hpc/documentation

Support

If you require support or would like to provide feedback, please contact allinea-support@arm.com or use our support request form online: https://developer.arm.com/products/software-development-tools/hpc/get-support.

Arm Performance Reports 18.2 Release Notes
=================================
Copyright (c) 2002-2018 Arm Limited (or its affiliates). All rights reserved.

Arm Performance Reports 18.2 helps you characterize and understand the performance of your HPC application runs in a simple one-page report.

Contents
======

This document provides information specific to the 18.2 release of Arm Performance Reports:

- Changes in this release:
    - New features and enhancements
    - Bug fixes
- Known issues
- System requirements
- Installing, uninstalling, licensing
- Running the tools
- Where to find example code
- How to access user documentation
- How to contact support

For information about previous releases of Arm Performance Reports, refer to the release history online:

https://developer.arm.com/products/software-development-tools/hpc/arm-performance-reports/release-history

Changes in 18.2.0
=============

- New features and enhancements:

None in this release.

- Bug fixes:

Fixed bug causing the PAPI.config file to be read incorrectly.

Changes in 18.2.1
=============

- New features and enhancements:

None in this release.

- Bug fixes:

Fixed issue where running the GUI installer as root you could not install to an NFS directory.

Changes in 18.2.2
=============

- New features and enhancements:

None in this release.

- Bug fixes:

None in this release.

Changes in 18.2.3
=============

- New features and enhancements:

None in this release.

- Bug fixes:

None in this release.

Known issues
==========

Please refer to the known issues section on the Arm Developer website:

https://developer.arm.com/products/software-development-tools/hpc/arm-performance-reports/known-issues

System requirements
===============

Please refer to the supported platforms pages on the Arm Developer website:

https://developer.arm.com/products/software-development-tools/hpc/arm-performance-reports/arm-performance-reports-platforms

Installation instructions
=================

Run the graphical "installer" or the text-only "textinstall.sh" from the download tarball.

You may choose to install just for you or for all users on your system.

If you are installing on a cluster, please make sure the package is available at the same path on every machine.

Full installation instructions are available in the Arm Performance Reports user guide, available on the Arm Developer website:

https://developer.arm.com/docs/101137/latest/installation

Uninstalling Arm Performance Reports
============================

To uninstall Arm Performance Reports, remove the installation directory from your system:

rm -r <installation-dir>

Licences
=======

If you do not have a licence file you will need to obtain one from Arm. Evaluation licences may be obtained from the Arm website:

https://www.arm.com/products/development-tools/hpc-tools/get-software

Full licences may be obtained by emailing HPCToolsSales@arm.com. Licence files should be stored in a directory called licences below the installation directory. For a default (root) installation, that directory would be:

   /opt/arm/reports/licences

and for a user-only installation it would be:

   ${HOME}/arm/reports/licences

Running Arm Performance Reports
==========================

To run Arm Performance Reports, add 'perf-report' in front of your existing mpiexec or aprun command-line, e.g.:

     {arm-reports-path}/bin/perf-report mpiexec -n 4 examples/wave_c

If {arm-reports-path}/bin is in your $PATH, just 'perf-report' will do.

Your chosen program will be run just as before and two report files, one .txt and one .html will be created in the current directory on completion. If you have problems starting your program under Performance Reports, first ensure it can run without Performance Reports with no errors.

You can use the --output/-o argument to specify a single output file name.

See perf-report --help or the user guide for more information.

Examples
========

Example code can be found in the installation directory:

   <INSTALL_DIR>/examples

Copy the example code to a writeable directory and run the examples using the makefiles provided.

Documentation
===========

Once installed these release notes can be found in the installation directory, and online at:

https://developer.arm.com/products/software-development-tools/hpc/arm-performance-reports/release-history

The Arm Performance Reports user guide is available in the <INSTALL_DIR>/doc directory, or online here:

https://developer.arm.com/docs/101137/latest/introduction

Further documentation, help and tutorials can be found online at:

https://developer.arm.com/products/software-development-tools/hpc/documentation

Support
======

If you require support or would like to provide feedback, please contact allinea-support@arm.com or use our support request form online:

https://developer.arm.com/products/software-development-tools/hpc/get-support

Copyright (c) 2002-2018 Arm Limited (or its affiliates). All rights reserved.

Arm Performance Reports 18.1 helps you characterize and understand the performance of your HPC application runs in a simple one-page report.

Contents

This document provides information specific to the 18.1 release of Arm Performance Reports:

• Changes in this release:
  • New features and enhancements
  • Bug fixes
• Known issues
• System requirements
• Installing, uninstalling, licensing
• Running the tools
• Where to find example code
• How to access user documentation
• How to contact support

For information about previous releases of Arm Performance Reports, refer to the release history.

Changes in this release

New features and enhancements

• Updated our licensing model to include a new “Arm Allinea Studio” licence type.
• Significantly reduced the overhead of Arm Performance Reports when profiling executables or shared libraries that do not include .eh_frame_header sections.
• Added support of numactl for Arm Performance Reports.
• Improved the documentation related to custom metrics.

Bug fixes

• Fixed a bug causing Arm Performance Reports to report a tcmalloc error when trying to profile a dynamic executable compiled in an Intel programming environment on Cray systems.
• Fixed a visualization glitch in the user guide.

Known issues

Please refer to the Known issues page.

System requirements

Please refer to the Supported platforms page.

Installation instructions

Run the graphical installer or the text-only textinstall.sh from the download tarball. You may choose to install just for you or for all users on your system.

If you are installing on a cluster, please make sure the package is available at the same path on every machine.

Full installation instructions are available in the Arm Performance Reports user guide.

Uninstalling Arm Performance Reports

To uninstall Arm Performance Reports, remove the installation directory from your system:

rm -r <installation-dir>

Licences

If you do not have a licence file you will need to obtain one from Arm. Evaluation licenses may be obtained from the Arm website.

Full licences may be obtained by emailing HPCToolsSales@arm.com.

Licence files should be stored in a directory called licences below the installation directory. For a default (root) installation, that directory would be:

/opt/arm/reports/licences

and for a user-only installation it would be:

${HOME}/arm/reports/licences

Running Arm Performance Reports

To run Arm Performance Reports, add 'perf-report' in front of your existing mpiexec or aprun command-line, for example:

{arm-reports-path}/bin/perf-report mpiexec -n 4 examples/wave_c

If {arm-reports-path}/bin is in your $PATH, just type:

perf-report

Your chosen program will be run just as before and two report files, one .txt and one .html will be created in the current directory on completion.

If you have problems starting your program under Performance Reports, first ensure it can run without Performance Reports with no errors.

You can use the --output or -o argument to specify a single output file name.

See perf-report --help or the Arm Performance Reports user guide for more information.

Examples

Example code can be found in the installation directory:

<INSTALL_DIR>/examples

Copy the example code to a writeable directory and run the examples using the makefiles provided.

Documentation

Once installed these release notes can be found in the installation directory, and online at:

The Arm Performance Reports user guide is available in the <INSTALL_DIR>/doc directory, or online here.

Further documentation, help and tutorials can be found on the Arm Developer website.

Support

If you require support or would like to provide feedback, please contact allinea-support@arm.com or use our support request form.

Changes for Arm Performance Reports 18.0.2:

• Fixed a bug that caused startup to fail with OpenMPI on Cray systems. 
• Several pthread functions are now correctly classified as "synchronization" functions as opposed to "computing" functions.
• Improved the test examples compilation procedure.

Changes for Arm Performance Reports 18.0.1:

• Fix incorrect metric values seen on Ubuntu 16.04.
• Add user-friendly warning messages displayed for unknown or incompatible configuration options.

Changes for Arm Performance Reports 18.0:

• Update the tools branding, from Allinea Performance Reports to Arm Performance Reports.
• Arm Performance Reports is now part of Arm Allinea Studio toolkit for AArch64. The tools remain cross-platform.
• Add support for Arm HPC Compiler 18.0.
• Add support for Red Hat 7.4 and Ubuntu 16.04 on AArch64.
• Improve profiling performance with WRF when using SGI MPT.
• Update our EULA.

Changes for Allinea Performance Reports 7.1:

• Add full Arm support with hardware CPU performance counter metrics.
• Advanced Metrics Pack now included as standard.
• Add user-defined sections to reports to show data from custom metric plugins.
• Allow enabling and disabling of metrics on the command-line.
• Extend Custom metrics to allow out-of-band data to be included when a job ends.
• Optionally profile only a subset of all ranks in a job.
• IBM Spectrum MPI support.
• Improved sampling performance.

Changes for Allinea Performance Reports 7.0.6:

• Updated recommended Intel compiler flags (user guide section E6).
• Fixed a bug affecting --stop-after on some SLES 11 systems.

Changes for Allinea Performance Reports 7.0.5:

• Fix a conflict with the Cray C++ STL library when using static linking.

Changes for Allinea Performance Reports 7.0.4:

• Fix an issue with dlsym under IBM Spectrum MPI that affected profiling of hybrid MPI+OpenMP codes.

Changes for Allinea Performance Reports 7.0.3:

• Improve ANSYS Fluent support.
• Fix issue with the custom metrics example.

Changes for Allinea Performance Reports 7.0.2:

• New I/O functions tracked: pread_nocancel and pwrite_nocancel.
• Add auto-detection support for PlatformMPI 9.1.4.2.
• Add MP_IN_PLACE and MPI_BOTTOM support to SGI MPT wrappers.

Changes for Allinea Performance Reports 7.0.1:

• Call allinea_plugin_cleanup in custom metrics at the end of a profiling job.
• Make a "onePerNode" attribute available for custom metrics that should only collect one process of each node.

Changes for Allinea Performance Reports 7.0:

• Custom Metrics for Performance Reports - add your own custom site- or application-specific metrics to Performance Reports.
• Add Lustre metadata metrics to the Advanced Metrics Pack add-on.
• Allow profiling of programs that use MPI_THREAD_MULTIPLE and MPI_THREAD_SERIALIZED (MPI calls tracked on main thread only).
• Provide module files to simplify static and dynamic linking of the Allinea profiler libraries on the Cray (in share/modules/cray).
• Performance Reports can now be generated in JSON format for use with continuous integration and regression testing systems.
• Categorise OpenACC-CUDA functions as GPU functions.