3.2.1. Using Master Package - 3.2.1. Using Master Package - 5.3 English - 57404

Complete the following steps to install the AOCL library suite. In inline path and directory names, <release> means the package version 5.3.0.

Throughout this chapter, INSTALL_ROOT means the directory on disk that contains lib, include, amd-libs.cfg, and the generated module file for the tree you are using (for example .../gcc/MT). In examples, the token <INSTALL_ROOT> is a placeholder for that directory path. The AOCL_ROOT environment variable is set to the same directory only after you source amd-libs.cfg or load the Environment Modules file—use <INSTALL_ROOT> (or an explicit path) until then.

1. Download the AOCL tar packages from the Download (https://www.amd.com/en/developer/aocl.html#downloads) section to the target machine.

2. Untar the package. The installer script install.sh is in the top-level directory aocl-linux-<compiler>-<release>:

   $ tar -xvf aocl-linux-<compiler>-5.3.0.tar.gz
   

3. Run ./install.sh to install the AOCL package (all libraries). The default INSTALL_ROOT is /home/<username>/aocl/<release>/<compiler>/<threading>, where <compiler> is aocc or gcc, and <threading> is MT (multi-threaded) or ST (single-threaded). The default amd-libs.cfg / module instructions refer to the MT tree unless you choose otherwise.

   The master tarball includes both ST and MT library archives; the installer writes two trees, .../aocc/ST and .../aocc/MT (or .../gcc/ST and .../gcc/MT). Libraries that do not ship a separate multi-threaded build are still placed under MT by reusing the ST binaries so both trees stay complete. The Multi-threaded column in AOCL Feature Support Matrix - 2 in the Introduction summarizes native multi-threading support per library.

   Use ./install.sh -h to print the usage of the script. A few supported options are:

   Table 3.1 install.sh Script Options#

   Option	Description
   -h	Print the help.
   -t	Custom target directory to install libraries.
   -l	Library to be installed.
   -i	Select LP64/ILP64 libraries to be set as default.

4. To install the AOCL package in a custom location, run ./install.sh with -t <CUSTOM_PATH>. The installer creates both ST and MT trees under that base:

   <CUSTOM_PATH>/<release>/<compiler>/ST and <CUSTOM_PATH>/<release>/<compiler>/MT

   By default both ST and MT trees are installed. The default INSTALL_ROOT in amd-libs.cfg and the Environment Modules snippet is the MT tree. The ST tree is the sibling ST directory. After you source amd-libs.cfg or load that module, AOCL_ROOT is set to that default (MT) INSTALL_ROOT.

   Examples:

   • ./install.sh — default base /home/<username>/aocl; MT tree: /home/<username>/aocl/<release>/aocc/MT.

   • ./install.sh -t /home/<username> — base is /home/<username>; MT tree: /home/<username>/<release>/aocc/MT.

   • ./install.sh -t . — run inside aocl-linux-<compiler>-<release>; MT tree: <current-dir>/<release>/aocc/MT.

   Note

   If <CUSTOM_PATH> contains spaces, quote it in the shell, for example ./install.sh -t "/home/user/my aocl".

5. You can install a subset of libraries with -l. Pass one or more names after -l (space-separated). Valid names are: blis, compression, crypto, da, dlp, fftw, fftz, libflame, libm, libmem, rng, scalapack, securerng, sparse, and utils.

   • Example (single library): ./install.sh -l blis.

   • Example (several libraries): ./install.sh -l blis libflame sparse.

   By default, the master installer includes AOCL-FFTW. To install AOCL-FFTZ instead of FFTW, use -l fftz (do not request fftw and fftz in the same install).

6. AOCL libraries support the following two integer types:

   <INSTALL_ROOT> refers to the INSTALL_ROOT for the library tree you are configuring (by default the MT tree; see step 4). After source amd-libs.cfg, that path is also $AOCL_ROOT. Paths are:

   • LP64 libraries and header files are installed respectively in the following paths:

     • <INSTALL_ROOT>/lib_LP64

     • <INSTALL_ROOT>/include_LP64

   • ILP64 libraries and header files are installed respectively in the following paths:

     • <INSTALL_ROOT>/lib_ILP64

     • <INSTALL_ROOT>/include_ILP64

   Note

   • AOCL-Compression supports only LP64

   • AOCL-FFTW supports LP64 and ILP64 in single binary using a different set of APIs.

   By default, LP64 libraries and header files are available in <INSTALL_ROOT>/lib and <INSTALL_ROOT>/include respectively (symlinks to the chosen LP64 or ILP64 directories). If you do not pass -i lp64 or -i ilp64, the installer prompts you to choose.

   Suffix ./install.sh with -i <lp64/ilp64> to:

   • Set the LP64 libraries as the default libraries; use the installer with the option: -i lp64. For example, ./install.sh -t /home/amd -l blis -i lp64.

     This installs only AOCL-BLAS library in the path /home/amd and sets LP64 AOCL-BLAS libraries as the default.

   • Set ILP64 libraries as the default; use the installer with the option: -i ilp64. For example, ./install.sh -i ilp64.

     This installs all AOCL libraries in the default path and sets ILP64 libraries as the default.