Developer Guide

Developer Guide for Intel® oneAPI Math Kernel Library Linux*

Download PDF
ID 766690
Date 11/07/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
Developer Guide for Intel® oneAPI Math Kernel Library for Linux*
Developer Guide for Intel® oneAPI Math Kernel Library for Linux* x
Getting Help and Support What's New Notational Conventions Related Information Getting Started Structure of the Intel® oneAPI Math Kernel Library Linking Your Application with the Intel® oneAPI Math Kernel Library Managing Performance and Memory Language-specific Usage Options Obtaining Numerically Reproducible Results Coding Tips Managing Output Working with the Intel® oneAPI Math Kernel Library Cluster Software Managing Behavior of the Intel® oneAPI Math Kernel Library with Environment Variables Configuring Your Integrated Development Environment to Link with Intel® oneAPI Math Kernel Library Intel® oneAPI Math Kernel Library Benchmarks Appendix A: Intel® oneAPI Math Kernel Library Language Interfaces Support Appendix B: Support for Third-Party Interfaces Appendix C: Directory Structure in Detail Notices and Disclaimers
Getting Started x
Shared Library Versioning CMake Config for oneMKL Checking Your Installation Setting Environment Variables Compiler Support Using Code Examples What You Need to Know Before You Begin Using the Intel® oneAPI Math Kernel Library
Setting Environment Variables x
Scripts to Set Environment Variables Modulefiles to Set Environment Variables Automating the Process of Setting Environment Variables Using the CMake Config File
Structure of the Intel® oneAPI Math Kernel Library x
Architecture Support High-Level Directory Structure Layered Model Concept
Linking Your Application with the Intel® oneAPI Math Kernel Library x
Linking Quick Start Linking Examples Linking in Detail Building Custom Shared Objects
Linking Quick Start x
Using the -qmkl Compiler Option Using the -qmkl-ilp64 Compiler Option Using the Single Dynamic Library Selecting Libraries to Link with Using the Link-line Advisor Using the Command-Line Link Tool
Linking Examples x
Linking on IA-32 Architecture Systems Linking on Intel(R) 64 Architecture Systems
Linking in Detail x
Listing Libraries on a Link Line Dynamically Selecting the Interface and Threading Layer Linking with Interface Libraries Linking with Threading Libraries Linking with Computational Libraries Linking with Compiler Run-time Libraries Linking with System Libraries
Linking with Interface Libraries x
Using the ILP64 Interface vs. LP64 Interface Linking with Fortran 95 Interface Libraries
Building Custom Shared Objects x
Using the Custom Shared Object Builder Composing a List of Functions Specifying Function Names Distributing Your Custom Shared Object
Managing Performance and Memory x
Improving Performance with Threading Improving Performance for Small Size Problems Other Tips and Techniques to Improve Performance Using Memory Functions
Improving Performance with Threading x
OpenMP* Threaded Functions and Problems Functions Threaded with Intel® Threading Building Blocks Avoiding Conflicts in the Execution Environment Techniques to Set the Number of Threads Setting the Number of Threads Using an OpenMP* Environment Variable Changing the Number of OpenMP* Threads at Run Time Using Additional Threading Control Calling oneMKL Functions from Multi-threaded Applications Using Intel® Hyper-Threading Technology Managing Multi-core Performance Managing Performance with Heterogeneous Cores
Using Additional Threading Control x
oneMKL-specific Environment Variables for OpenMP Threading Control MKL_DYNAMIC MKL_DOMAIN_NUM_THREADS MKL_NUM_STRIPES Setting the Environment Variables for Threading Control
Improving Performance for Small Size Problems x
Using MKL_DIRECT_CALL in C Applications Using MKL_DIRECT_CALL in Fortran Applications Limitations of the Direct Call
Other Tips and Techniques to Improve Performance x
Coding Techniques Improving oneMKL Performance on Specific Processors Operating on Denormals
Using Memory Functions x
Avoiding Memory Leaks in oneMKL Redefining Memory Functions
Language-specific Usage Options x
Using Language-Specific Interfaces with Intel® oneAPI Math Kernel Library Mixed-language Programming with the Intel Math Kernel Library
Using Language-Specific Interfaces with Intel® oneAPI Math Kernel Library x
Interface Libraries and Modules Fortran 95 Interfaces to LAPACK and BLAS Compiler-dependent Functions and Fortran 90 Modules
Mixed-language Programming with the Intel Math Kernel Library x
Calling LAPACK, BLAS, and CBLAS Routines from C/C++ Language Environments Using Complex Types in C/C++ Calling BLAS Functions That Return the Complex Values in C/C++ Code
Obtaining Numerically Reproducible Results x
Getting Started with Conditional Numerical Reproducibility Specifying Code Branches Reproducibility Conditions Setting the Environment Variable for Conditional Numerical Reproducibility Code Examples
Coding Tips x
Example of Data Alignment Using Predefined Preprocessor Symbols for Intel® MKL Version-Dependent Compilation
Managing Output x
Using oneMKL Verbose Mode
Using oneMKL Verbose Mode x
Version Information Line Call Description Line
Working with the Intel® oneAPI Math Kernel Library Cluster Software x
Linking with oneMKL Cluster Software Setting the Number of OpenMP* Threads Using Shared Libraries Setting Environment Variables on a Cluster Interaction with the Message-passing Interface Using a Custom Message-Passing Interface Examples of Linking for Clusters
Examples of Linking for Clusters x
Examples for Linking a C Application Examples for Linking a Fortran Application
Managing Behavior of the Intel® oneAPI Math Kernel Library with Environment Variables x
Managing Behavior of Function Domains with Environment Variables Instruction Set Specific Dispatching on Intel® Architectures
Managing Behavior of Function Domains with Environment Variables x
Setting the Default Mode of Vector Math with an Environment Variable Managing Performance of the Cluster Fourier Transform Functions Managing Invalid Input Checking in LAPACKE Functions
Configuring Your Integrated Development Environment to Link with Intel® oneAPI Math Kernel Library x
Configuring the Eclipse* IDE CDT to Link with oneMKL
Intel® oneAPI Math Kernel Library Benchmarks x
Intel Optimized LINPACK Benchmark for Linux* Intel® Distribution for LINPACK* Benchmark and Intel® Optimized HPL-AI* Benchmark Intel® Optimized High Performance Conjugate Gradient Benchmark
Intel Optimized LINPACK Benchmark for Linux* x
Contents of the Intel® Optimized LINPACK Benchmark Running the Software Known Limitations of the Intel® Optimized LINPACK Benchmark
Intel® Distribution for LINPACK* Benchmark and Intel® Optimized HPL-AI* Benchmark x
Overview of the Intel® Distribution for LINPACK* Benchmark Overview of the Intel® Optimized HPL-AI* Benchmark Contents of the Intel® Distribution for LINPACK* Benchmark and the Intel® Optimized HPL-AI* Benchmark Building the Intel® Distribution for LINPACK* Benchmark and the Intel® Optimized HPL-AI* Benchmark for a Customized MPI Implementation Building the Netlib HPL from Source Code Configuring Parameters Ease-of-use Command-line Parameters Running the Intel® Distribution for LINPACK* Benchmark and the Intel® Optimized HPL-AI* Benchmark Heterogeneous Support in the Intel® Distribution for LINPACK* Benchmark Environment Variables Improving Performance of Your Cluster
Intel® Optimized High Performance Conjugate Gradient Benchmark x
Overview of the Intel Optimized HPCG Versions of the Intel Optimized HPCG Getting Started with Intel Optimized HPCG Choosing Best Configuration and Problem Sizes
Appendix A: Intel® oneAPI Math Kernel Library Language Interfaces Support x
Language Interfaces Support, by Function Domain Include Files
Appendix B: Support for Third-Party Interfaces x
FFTW Interface Support
Appendix C: Directory Structure in Detail x
Detailed Structure of the IA-32 Architecture Directories Detailed Structure of the Intel® 64 Architecture Directories
Detailed Structure of the IA-32 Architecture Directories x
Static Libraries in the lib32 Directory Dynamic Libraries in the lib32 Directory
Detailed Structure of the Intel® 64 Architecture Directories x
Static Libraries in the lib Directory Dynamic Libraries in the lib Directory
Developer Guide for Intel® oneAPI Math Kernel Library for Linux*

Dynamic Libraries in the lib Directory

Some of the libraries in this directory are optional. However, some optional libraries are installed by default, while the rest are not. To get those libraries that are not installed by default, explicitly select the specified optional component during installation.

File

Contents

Optional Component

Name

Installed by Default

libmkl_rt.so

Single Dynamic Library for C/Fortran functionality.

Instead of multiple libraries, the user can link to one mkl_rt library and select interface and threading via function or environment variable.

   

SYCL API Layer

      

libmkl_sycl.so

Umbrella library (linker script) to link with all domain-specific SYCL libraries.

Required if SYCL-specific functionality is needed.

   

libmkl_sycl_blas.so

BLAS SYCL library for SYCL compilers

   

libmkl_sycl_lapack.so

LAPACK SYCL library for SYCL compilers

   

libmkl_sycl_dft.so

Discrete Fourier Transform (DFT) SYCL library for SYCL compilers

   

libmkl_sycl_sparse.so

Sparse BLAS SYCL library for SYCL compilers

   

libmkl_sycl_vm.so

Vector Mathematics (VM) SYCL library for SYCL compilers

   

libmkl_sycl_rng.so

Random Number Generator (RNG) SYCL library for SYCL compilers

   

libmkl_sycl_stats.so

Summary Statistic SYCL library for SYCL compilers

   

libmkl_sycl_data_fitting.so

Data Fitting SYCL library for SYCL compilers (experimental)

   

Interface Layer

      

libmkl_intel_lp64.so

LP64 interface library for the Intel compilers. Also use for other supported compilers that do not have a specialized Intel® oneAPI Math Kernel Library (oneMKL) interface library.

All Intel® oneAPI Math Kernel Library (oneMKL) function domains support LP64 programming. Read more about LP64 in Using the ILP64 Interface vs. LP64 Interface.

    

libmkl_intel_ilp64.so

ILP64 interface library for the Intel compilers. Also use for other supported compilers that do not have a specialized Intel® oneAPI Math Kernel Library (oneMKL) interface library

All oneMKL function domains support ILP64 programming with some limitations for FFT. Read more about ILP64 and limitations in Using the ILP64 Interface vs. LP64 Interface.. 		   

libmkl_gf_lp64.so

LP64 interface library for the GNU Fortran compilers

All oneMKL function domains support LP64 programming. Read more about LP64 in Using the ILP64 Interface vs. LP64 Interface..

GNU* Compiler Collection support

Yes

libmkl_gf_ilp64.so

ILP64 interface library for the GNU Fortran compilers

All oneMKL function domains support ILP64 programming with some limitations for FFT. Read more about ILP64 and limitations in Using the ILP64 Interface vs. LP64 Interface..

GNU* Compiler Collection support

Yes

Threading Layer

      

libmkl_intel_thread.so

OpenMP threading library for the Intel compilers.

All oneMKL function domains support Intel OpenMP threading.

   

libmkl_tbb_thread.so

Intel TBB threading library for the Intel compilers.

All oneMKL function domains support Intel TBB threading.

Intel TBB threading support

Yes

libmkl_gnu_thread.so

OpenMP threading library for the GNU Fortran and C compilers.

All oneMKL function domains support GNU OpenMP threading.

GNU* Compiler Collection support

Yes

libmkl_pgi_thread.so (DEPRECATED)

OpenMP threading library for the PGI* compiler.

All oneMKL function domains except cluster domains (CDFT, CPARDISO, HPCG, BLACS) support PGI threading.

PGI* Compiler support

 

libmkl_sequential.so

Sequential library.

All oneMKL function domains support sequential mode.

   

Computational Layer

      

libmkl_core.so

All non–architecture-specific implementation and library dispatcher for dynamic load of architecture-specific kernels.

Read more about how to work with mkl_enable_instructions and mkl_cbwr_set in the developer reference.

mkl_core is required for any link configurations. You don't need to link kernel-specific libraries; just link mkl_core.

   

libmkl_def.so

Default kernel library.

All oneMKL function domains except Vector Mathematics (VM)/Vector Statistics (VS)/Data Fitting (DF) are presented in this library.

   

libmkl_mc3.so

Kernel library for Intel® Streaming SIMD Extensions 4.2 (Intel® SSE4.2) enabled processors.

All oneMKL function domains except VM/VS/DF are presented in this library.

   

libmkl_avx2.so

Kernel library for Intel® Advanced Vector Extensions 2 (Intel® AVX2) enabled processors.

All oneMKL function domains except VM/VS/DF are presented in this library.

   

libmkl_avx512.so

Kernel library for dispatching Intel® Advanced Vector Extensions 512 (Intel® AVX-512) on Intel® Xeon® processors.

All oneMKL function domains except VM/VS/DF are presented in this library.

   

libmkl_vml_def.so

Vector Mathematics (VM)/Vector Statistics (VS)/Data Fitting (DF) part of default kernels

   

libmkl_vml_mc3.so

VM/VS/DF for Intel® SSE4.2 enabled processors

   

libmkl_vml_avx2.so

VM/VS/DF optimized for Intel® AVX2 enabled processors

   

libmkl_vml_avx512.so

VM/VS/DF optimized for Intel® AVX-512 on Intel® Xeon® processors

   

libmkl_vml_cmpt.so

VM/VS/DF library for conditional numerical reproducibility

   

Cluster Libraries

      

libmkl_scalapack_lp64.so

ScaLAPACK routine library supporting the LP64 interface

Cluster support

 

libmkl_scalapack_ilp64.so

ScaLAPACK routine library supporting the ILP64 interface

Cluster support

 

libmkl_cdft_core.so

Cluster version of FFT functions.

Cluster support

 

libmkl_blacs_intelmpi_lp64.so

LP64 version of BLACS routines for Intel® MPI Library and MPICH2 or higher.

Cluster support

 

libmkl_blacs_intelmpi_ilp64.so

ILP64 version of BLACS routines for Intel MPI Library and MPICH2 or higher.

Cluster support

 

libmkl_blacs_openmpi_lp64.so

LP64 version of BLACS routines for Open MPI.

Cluster support

 

libmkl_blacs_openmpi_ilp64.so

ILP64 version of BLACS routines for Open MPI.

Cluster support

 
NOTE:

In case any functionality from a specific library is needed, this library should be added to the link line. For example, if you want to use oneMKL with the GCC compiler + ILP64 interface + GNU OpenMP threading, the link line should contain:

  1. mkl_intel_ilp64 for ILP64 interface
  2. mkl_gnu_thread for GNU OpenMP threading
  3. mkl_core for all other oneMKL functionality

Details about what should be linked in different cases can be found in the oneMKL Link Line Advisor.

Product and Performance Information

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.

Notice revision #20201201

Parent topic: Detailed Structure of the Intel® 64 Architecture Directories
Level Two Title