Developer Guide

Developer Guide for Intel® oneAPI Math Kernel Library Linux*

Download PDF
ID 766690
Date 3/31/2025
Public
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® Math Kernel Library Cluster Edition 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 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® oneMKL Version-Dependent Compilation Querying oneMATH Specification Version Compliance C Macro Usage Example C++ Usage Example Compliance Policy Values
Managing Output x
Using oneMKL Verbose Mode
Using oneMKL Verbose Mode x
Version Information Line Call Description Line
Working with the Intel® Math Kernel Library Cluster Edition Software x
Linking with Intel® Math Kernel Library Cluster Edition 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® CPU Optimized HPCG Versions of the Intel® GPU Optimized HPCG Getting Started with Intel® CPU Optimized HPCG Getting Started with Intel® GPU Optimized HPCG Choosing the Best Configuration and Problem Sizes for CPUs Choosing the Best HPCG Configuration for GPUs
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 Intel® 64 Architecture Directories
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*

Querying oneMATH Specification Version Compliance

Each Intel® oneAPI Math Kernel Library (oneMKL) domain defines a preprocessor macro to represent the version of the specification that the implementation is compliant with, in accordance with the oneMATH specification.

The macros for each domain are listed as follows: 

ONEMATH_BLAS_SPEC_VERSION
ONEMATH_LAPACK_SPEC_VERSION
ONEMATH_SPBLAS_SPEC_VERSION
ONEMATH_DFT_SPEC_VERSION
ONEMATH_RNG_SPEC_VERSION
ONEMATH_STATS_SPEC_VERSION
ONEMATH_VM_SPEC_VERSION

To support modern C++ usage, we also add constexpr of type SpecVersion for each domain in oneapi/mkl/<domain>/spec.hpp: 

oneapi::mkl::blas::spec_version
oneapi::mkl::lapack::spec_version
oneapi::mkl::sparse::spec_version
oneapi::mkl::dft::spec_version
oneapi::mkl::rng::spec_version
oneapi::mkl::stats::spec_version
oneapi::mkl::vm::spec_version

To simplify version comparison, we add version enums in include/oneapi/mkl/spec.hpp: 

enum class SpecVersion{
    not_compliant = 1,
    version_1_1 = 101,
    version_1_2 = 102,
    version_1_3 = 103,
    version_1_4 = 104,
    not_released
};

C Macro Usage Example

#include <oneapi/mkl/spec.hpp> // or mkl.hpp

#define MY_THRESHOLD_VERSION 102
#ifdef ONEMATH_BLAS_SPEC_VERSION
    #if ONEMATH_BLAS_SPEC_VERSION > MY_THRESHOLD_VERSION
        #define my_call call_optimization_A
    #elif ONEMATH_BLAS_SPEC_VERSION > 001
        #define my_call call_optimization_B
    #else
        #define my_call call_reference
    #endif
#else
    #define my_call call_reference
#endif

int main(){
    my_call();
    return 0;
}

C++ Usage Example

#include <oneapi/mkl/spec.hpp>  // or mkl.hpp

using namespace oneapi::mkl;

int main(){
    SpecVersion my_threshold_version = SpecVersion::version_1_2;

    if (oneapi::mkl::blas::spec_version > my_threshold_version)
        call_optimization_A(); // App's optimization for new spec
    else if (oneapi::mkl::blas::spec_version > SpecVersion::not_compliant)
        call_optimization_B(); // App's optimization for old spec
    else
        call_reference();      // App's reference implementation

    return 0;
}

Compliance Policy

  1. oneMKL domains can be compliant with any version of the oneMATH specification.
  2. oneMKL can increment the compliance version with new releases of oneMKL.
  3. A new release of the oneMATH specification does not require updating the oneMKL compliance version.

Values

  1. 1 if the domain does not comply with any released version of the oneMATH specification.
  2. <xxyy> if the domain is released with support for one of the available oneMATH specification versions, where xx is the major version and yy is the minor version of the oneMath Specification it is compliant with. For example, the integer value 103 represents oneMATH Specification version 1.3.
  3. Versions from 1 through 100 are reserved for alpha/beta support of the specification in oneMKL and should be used only for special cases.
Parent topic: Coding Tips
Level Two Title