SuiteSparse/SuiteSparse_config/cmake_modules/SuiteSparse__blas_threading.cmake at 9759b8c7538ecc92f9aa76b19fbf3f266432d113 · DrTimothyAldenDavis/SuiteSparse · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
#-------------------------------------------------------------------------------
# SuiteSparse/cmake_modules/SuiteSparse__blas_threading.cmake
#-------------------------------------------------------------------------------

# Copyright (c) 2017-2025, Timothy A. Davis.  All Rights Reserved.
# SPDX-License-Identifier: BSD-3-clause

#-------------------------------------------------------------------------------

#-------------------------------------------------------------------------------
# determine the BLAS library properties: sequential or multithreaded
#-------------------------------------------------------------------------------

# This script determines more information about the BLAS library being linked
# against.  For OpenBLAS and Intel MKL, it can determine if the BLAS libraries
# are single or multithreaded (but only if not cross-compiling).  It can
# discover if the OpenBLAS has the openblas_set_num_threads_local method
# (requiring v0.3.27 or later).

# Most of the result of this script is informational, appearing in the cmake
# output.  A single #define is added for OpenBLAS, if it has the
# openblas_set_num_threads_local function:
#
#  add_compile_definitions ( SUITESPARSE_HAVE_OPENBLAS_SET_NUM_THREADS_LOCAL )

# Other BLAS libraries (ACML, Arm, Apple, etc) are not queried.

set ( CMAKE_REQUIRED_LIBRARIES    ${BLAS_LIBRARIES} )
set ( CMAKE_REQUIRED_LINK_OPTIONS ${BLAS_LINKER_FLAGS} )
set ( CMAKE_REQUIRED_INCLUDES     ${BLAS_INCLUDE_DIRS} )

#-------------------------------------------------------------------------------
# cross-compiling: just use try_compile, not try_run
#-------------------------------------------------------------------------------

if ( NOT ( ${CMAKE_SYSTEM} MATCHES ${CMAKE_HOST_SYSTEM} ) )

    message ( STATUS "target system: ${CMAKE_SYSTEM}" )
    message ( STATUS "host system:   ${CMAKE_HOST_SYSTEM}" )

    if ( ${BLA_VENDOR} STREQUAL "OpenBLAS" )
        # check if OpenBLAS has openblas_set_num_threads_local (Apr 2024 or later)
        get_filename_component ( ABS_SOURCE_PATH
            ${PROJECT_SOURCE_DIR}/../SuiteSparse_config/cmake_modules/check_openblas_Apr2024.c
            ABSOLUTE )
        try_compile ( OPENBLAS_2024_COMPILES
            ${CMAKE_CURRENT_BINARY_DIR}
            ${ABS_SOURCE_PATH}
            LINK_OPTIONS    ${BLAS_LINKER_FLAGS}
            LINK_LIBRARIES  ${BLAS_LIBRARIES} )
        if ( ${OPENBLAS_2024_COMPILES} )
            # We have OpenBLAS 0.3.27 or later;
            add_compile_definitions ( SUITESPARSE_HAVE_OPENBLAS_SET_NUM_THREADS_LOCAL )
            message ( STATUS "BLAS: OpenBLAS v0.3.27 or later" )
        else ( )
            message ( STATUS "BLAS: OpenBLAS v0.2.14 to v0.3.26" )
        endif ( )
    endif ( )

    return ( )
endif ( )

#-------------------------------------------------------------------------------
# check the Intel MKL properties
#-------------------------------------------------------------------------------

string ( REGEX MATCH "^Intel" is_Intel ${BLA_VENDOR} )

if ( is_Intel )

    #---------------------------------------------------------------------------
    # determine if MKL is single-threaded or multi-threaded (info only)
    #---------------------------------------------------------------------------

    get_filename_component ( ABS_SOURCE_PATH
        ${PROJECT_SOURCE_DIR}/../SuiteSparse_config/cmake_modules/check_mkl.c
        ABSOLUTE )
    try_run ( MKL_RUNS MKL_COMPILES
        ${CMAKE_CURRENT_BINARY_DIR}
        ${ABS_SOURCE_PATH}
        LINK_OPTIONS    ${BLAS_LINKER_FLAGS}
        LINK_LIBRARIES  ${BLAS_LIBRARIES}
        RUN_OUTPUT_VARIABLE MKL_OUTPUT )

    if ( ${MKL_COMPILES} )
        if ( ${MKL_RUNS} STREQUAL "FAILED_TO_RUN" )
            # MKL compiled but failed to run ... why?
            message ( FATAL_ERROR "Intel MKL failed to run" )
        endif ( )
        if ( ${MKL_OUTPUT} EQUAL 1 )
            message ( STATUS "BLAS: Intel MKL: single-threaded" )
        else ( )
            message ( STATUS "BLAS: Intel MKL: multi-threaded (threads: ${MKL_OUTPUT})" )
        endif ( )
    else ( )
        message ( FATAL_ERROR "BLAS: Intel MKL failed to compile" )
    endif ( )

endif ( )

#-------------------------------------------------------------------------------
# check the OpenBLAS properties
#-------------------------------------------------------------------------------

if ( ${BLA_VENDOR} STREQUAL "OpenBLAS" )

    # check if OpenBLAS has openblas_get_num_threads (Mar 2015 or later)
    get_filename_component ( ABS_SOURCE_PATH
        ${PROJECT_SOURCE_DIR}/../SuiteSparse_config/cmake_modules/check_openblas_Mar2015.c
        ABSOLUTE )
    try_run ( OPENBLAS_2015_RUNS OPENBLAS_2015_COMPILES
        ${CMAKE_CURRENT_BINARY_DIR}
        ${ABS_SOURCE_PATH}
        LINK_OPTIONS    ${BLAS_LINKER_FLAGS}
        LINK_LIBRARIES  ${BLAS_LIBRARIES}
        RUN_OUTPUT_VARIABLE OPENBLAS_2015_OUTPUT )
    if ( ${OPENBLAS_2015_COMPILES} )
        if ( ${OPENBLAS_2015_RUNS} STREQUAL "FAILED_TO_RUN" )
            # OpenBLAS compiled but failed to run ... why?
            message ( FATAL_ERROR "BLAS: OpenBLAS failed to run (v0.2.14 or later is required)" )
        endif ( )
    else ( )
        message ( FATAL_ERROR "BLAS: OpenBLAS failed to compile (v0.2.14 or later is required)" )
    endif ( )

    # check if OpenBLAS has openblas_set_num_threads_local (Apr 2024 or later)
    get_filename_component ( ABS_SOURCE_PATH
        ${PROJECT_SOURCE_DIR}/../SuiteSparse_config/cmake_modules/check_openblas_Apr2024.c
        ABSOLUTE )
    try_run ( OPENBLAS_2024_RUNS OPENBLAS_2024_COMPILES
        ${CMAKE_CURRENT_BINARY_DIR}
        ${ABS_SOURCE_PATH}
        LINK_OPTIONS    ${BLAS_LINKER_FLAGS}
        LINK_LIBRARIES  ${BLAS_LIBRARIES}
        RUN_OUTPUT_VARIABLE OPENBLAS_2024_OUTPUT )

    if ( ${OPENBLAS_2024_COMPILES} )
        if ( ${OPENBLAS_2024_RUNS} STREQUAL "FAILED_TO_RUN" )
            # OpenBLAS compiled but failed to run ... why?
            message ( FATAL_ERROR "BLAS: OpenBLAS v0.3.27 or later: failed to run" )
        endif ( )
        # We have OpenBLAS 0.3.27 or later;
        add_compile_definitions ( SUITESPARSE_HAVE_OPENBLAS_SET_NUM_THREADS_LOCAL )
        if ( ${OPENBLAS_2024_OUTPUT} EQUAL 1 )
            message ( STATUS "BLAS: OpenBLAS v0.3.27 or later: single-threaded" )
        else ( )
            message ( STATUS "BLAS: OpenBLAS v0.3.27 or later: multi-threaded (threads: ${OPENBLAS_2024_OUTPUT})" )
        endif ( )
    else ( )
        # We have OpenBLAS 0.2.14 to 0.3.26;
        # openblas_set_num_threads_local is not available
        if ( ${OPENBLAS_2015_OUTPUT} EQUAL 1 )
            message ( STATUS "BLAS: OpenBLAS v0.2.14 to v0.3.26: single-threaded" )
        else ( )
            message ( STATUS "BLAS: OpenBLAS v0.2.14 to v0.3.26: multi-threaded (threads: ${OPENBLAS_2015_OUTPUT})" )
        endif ( )
    endif ( )
endif ( )