Developer Guide

Developer Guide for Intel® oneAPI Math Kernel Library Windows*

Download PDF
ID 766692
Date 7/13/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 Windows*
Developer Guide for Intel® oneAPI Math Kernel Library for Windows* 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 Programming with Intel® Math Kernel Library in Integrated Development Environments (IDE) 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
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 Dynamic-link Libraries Building a Universal Windows Driver
Linking Quick Start x
Using the /Qmkl Compiler Option Automatically Linking a Project in the Visual Studio* Integrated Development Environment with Intel® oneAPI Math Kernel Library Using the Single Dynamic Library Selecting Libraries to Link with Using the Link-line Advisor Using the Command-Line Link Tool
Automatically Linking a Project in the Visual Studio* Integrated Development Environment with Intel® oneAPI Math Kernel Library x
Automatically Linking Your Microsoft Visual C/C++* Project with oneMKL Automatically Linking Your Intel® Visual Fortran Project with oneMKL
Linking Examples x
Linking on IA-32 Architecture Systems Linking on Intel(R) 64 Architecture Systems
Linking in Detail x
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 Dynamic-link Libraries x
Using the Custom Dynamic-link Library Builder in the Command-line Mode See Also Composing a List of Functions Specifying Function Names Building a Custom Dynamic-link Library in the Visual Studio* Development System Distributing Your Custom Dynamic-link Library
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
Message-Passing Interface Support Linking with oneMKL Cluster Software Determining the Number of OpenMP* Threads Using DLLs 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
Programming with Intel® Math Kernel Library in Integrated Development Environments (IDE) x
Configuring Your Integrated Development Environment to Link with Intel® oneAPI Math Kernel Library Getting Assistance for Programming in the Microsoft Visual Studio* IDE
Configuring Your Integrated Development Environment to Link with Intel® oneAPI Math Kernel Library x
Configuring the Microsoft Visual C/C++* Development System to Link with Intel® MKL Configuring Intel® Visual Fortran to Link with Intel MKL
Getting Assistance for Programming in the Microsoft Visual Studio* IDE x
Using Context-Sensitive Help Using the IntelliSense* Capability
Intel® oneAPI Math Kernel Library Benchmarks x
Intel Optimized LINPACK Benchmark for Windows* Intel® Distribution for LINPACK* Benchmark and Intel® Optimized HPL-AI* Benchmark
Intel Optimized LINPACK Benchmark for Windows* 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
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 lib\\ia32 Directory Dynamic Libraries in the lib\\ia32 Directory Contents of the redist\\ia32 Directory
Detailed Structure of the Intel® 64 Architecture Directories x
Static Libraries in the lib\\intel64 Directory Dynamic Libraries in the lib\\intel64 Directory Contents of the redist\\intel64 Directory
Developer Guide for Intel® oneAPI Math Kernel Library for Windows*

Using the Custom Dynamic-link Library Builder in the Command-line Mode

To build a custom DLL, use the following command:

nmake target [<options>]

The following table lists possible values of target and explains what the command does for each value:

Value

Comment

libia32

The builder uses static Intel® oneAPI Math Kernel Library (oneMKL) interface, threading, and core libraries to build a customDLL for the IA-32 architecture.

libintel64

The builder uses static Intel® oneAPI Math Kernel Library (oneMKL) interface, threading, and core libraries to build a customDLL for the Intel® 64 architecture.

dllia32

The builder uses the single dynamic library libmkl_rt.dll to build a custom DLL for the IA-32 architecture.

dllintel64

The builder uses the single dynamic library libmkl_rt.dll to build a custom DLL for the Intel® 64 architecture.

help

The command prints Help on the custom DLL builder

The <options> placeholder stands for the list of parameters that define macros to be used by the makefile. The following table describes these parameters:

Parameter [Values]

Description

interface

Defines which programming interface to use.Possible values:

  • For the IA-32 architecture, {cdecl}. The default value is cdecl.
  • For the Intel 64 architecture, {lp64|ilp64}. The default value is lp64.
threading = {parallel|sequential}

Defines whether to use the Intel® oneAPI Math Kernel Library (oneMKL) in the threaded or sequential mode. The default value isparallel.

Prallel = {intel|tbb}

Specifies whether to use Intel OpenMP or Intel® oneTBB. The default value isintel.

cluster = {yes|no}

(For libintel64only) Specifies whether Intel® oneAPI Math Kernel Library (oneMKL) cluster components (BLACS, ScaLAPACK and/or CDFT) are needed to build the custom shared object. The default value isno.

blacs_mpi = {intelmpi|msmpi}

Specifies the pre-compiled Intel® oneAPI Math Kernel Library (oneMKL) BLACS library to use. Ignored if'cluster=no'. The default value is intelmpi.

blacs_name = <lib name>

Specifies the name (without extension) of a custom Intel® oneAPI Math Kernel Library (oneMKL) BLACS library to use. Ignored if'cluster=no'. 'blacs_mpi' is ignored if 'blacs_name' was explicitly specified. The default value is mkl_blacs_<blacs_mpi>_<interface>.

mpi = <lib name>

Specifies the name (without extension) of the MPI library used to build the custom DLL. Ignored if 'cluster=no'. The default value is impi.

export = <file name>

Specifies the full name of the file that contains the list of entry-point functions to be included in the DLL. The default name is user_example_list (no extension).

name = <dll name>

Specifies the name of the dll and interface library to be created. By default, the names of the created libraries are mkl_custom.dll and mkl_custom.lib.
xerbla = <error handler>

Specifies the name of the object file <user_xerbla>.objthat contains the error handler of the user. The makefile adds this error handler to the library for use instead of the default Intel® oneAPI Math Kernel Library (oneMKL) error handlerxerbla. If you omit this parameter, the native Intel® oneAPI Math Kernel Library (oneMKL)xerbla is used. See the description of the xerblafunction in the Intel® oneAPI Math Kernel Library (oneMKL) Developer Reference to develop your own error handler. For the IA-32 architecture, the object file should be in the interface defined by the interface macro (cdecl).
MKLROOT = <mkl directory>

Specifies the location of Intel® oneAPI Math Kernel Library (oneMKL) libraries used to build the customDLL. By default, the builder uses the Intel® oneAPI Math Kernel Library (oneMKL) installation directory.

uwd_compat = {yes|no}

Build a Universal Windows Driver (UWD)-compatible custom DLL with OneCore.lib. The recommended versions of Windows SDK are 10.0.17134.0 or higher.

If 'uwd_compat'=yes, then threading = sequential and crt = ucrt.lib by default.

The default value of is uwd_compat is no.

buf_lib

Manages resolution of the __security_cookie external references in the custom DLL on systems based on the Intel® 64 architecture.

By default, the makefile uses the bufferoverflowu.lib library of Microsoft SDK builds 1289 or higher. This library resolves the __security_cookie external references.

To avoid using this library, set the empty value of this parameter. Therefore, if you are using an older SDK, set buf_lib= .

CAUTION:

Use the buf_lib parameter only with the empty value. Incorrect value of the parameter causes builder errors.

crt = <c run-time library>

Specifies the name of the Microsoft C run-time library to be used to build the custom DLL. By default, the builder uses msvcrt.lib.

manifest = {yes|no|embed}

Manages the creation of a Microsoft manifest for the custom DLL:

  • If manifest=yes, the manifest file with the name defined by the name parameter above and the manifest extension is created.
  • If manifest=no, the manifest file is not be created.
  • If manifest=embed, the manifest is embedded into the DLL.

By default, the builder does not use the manifest parameter.

All of the above parameters are optional. However, you must make the system and c-runtime (crt) libraries and link.exe available by setting the PATH and LIB environment variables appropriately. You can do this in the following ways:

  • Manually
  • If you are using Microsoft Visual Studio (VS), call the vcvarsall.bat script with the appropriate 32-bit (x86) or 64-bit (x64 or amd-64) architecture flag.
  • If you are using the Intel compiler, use the compilervars.bat script with the appropriate 32-bit (x86) or 64-bit (x64 or amd-64) architecture flag.

In the simplest case, the command line is: 

#source Visual Studio environment variables
call vcvarsall.bat x86
#run custom dll builder script
nmake ia32

and the missing options have default values. This command creates the  mkl_custom.dll and mkl_custom.lib libraries with the cdecl interface for processors using the IA-32 architecture . The command takes the list of functions from the functions_listfile and uses the native Intel® oneAPI Math Kernel Library (oneMKL) error handlerxerbla.

Here is an example of a more complex case: 

#source Visual Studio environment variables
call vcvarsall.bat x86
#run custom dll builder script
nmake ia32 interface=cdecl export=my_func_list.txt name=mkl_small xerbla=my_xerbla.obj

In this case, the command creates the mkl_small.dll and mkl_small.lib libraries with the cdecl interface for processors using the IA-32 architecture. The command takes the list of functions from my_func_list.txt file and uses the error handler of the user my_xerbla.obj.

To build a UWD-compatible custom dll, use the uwd_compat=yes option. For this purpose, you must make a different set of universal system (OneCore.lib) and universal c-runtime (ucrt.lib) libraries available. You can get these libraries by downloading Windows 10 SDK 10.0.17134.0 (version 1803) or newer. Make sure to source the Visual Studio environment with the appropriate native architecture to add the libraries to your path.

This example shows how to create a 64-bit architecture library, mkl_uwd_compat.dll, that is UWD-compatible with the lp64 interface using my_function_list.txt for specific functionality: 

#source Visual Studio environment variables, LIB should have paths to desired OneCore.lib and universal crt libraries
call vcvarsall.bat x64
#run custom dll builder script
nmake intel64 interface=lp64 export=my_func_list.txt uwd_compat=yes name=mkl_uwd_compat

Product and Performance Information

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

Notice revision #20201201

Parent topic: Building Custom Dynamic-link Libraries
Level Two Title