Intel® Math Kernel Library 2019 Developer Reference - C
Reports the peak memory allocated by the Intel MKL Memory Allocator.
MKL_INT64 mkl_peak_mem_usage (intmode);
Name |
Type |
Description |
---|---|---|
mode |
int |
Requested mode of the function's operation. Possible values:
|
The mkl_peak_mem_usage function reports the peak memory allocated by the Intel MKL Memory Allocator.
Gathering the peak memory data is turned off by default. If you need to know the peak memory, explicitly turn the data gathering mode on by calling the function with the MKL_PEAK_MEM_ENABLE value of the parameter. Use the MKL_PEAK_MEM and MKL_PEAK_MEM_RESET values only when the data gathering mode is turned on. Otherwise the function returns -1. The data gathering mode leads to performance degradation, so when the mode is turned on, you can turn it off by calling the function with the MKL_PEAK_MEM_DISABLE value of the parameter.
If Intel MKL is running in a threaded mode, the mkl_peak_mem_usage function may return different amounts of memory from run to run.
The function reports the peak memory for the entire application, not just for the calling thread.
Name |
Type |
Description |
---|---|---|
AllocatedBytes |
MKL_INT64 |
The peak memory allocated by the Memory Allocator (in bytes) or -1 in case of errors. |