FindCBLAS.cmake 15.5 KB
Newer Older
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
###
#
# @copyright (c) 2009-2014 The University of Tennessee and The University
#                          of Tennessee Research Foundation.
#                          All rights reserved.
# @copyright (c) 2012-2014 Inria. All rights reserved.
# @copyright (c) 2012-2014 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, Univ. Bordeaux. All rights reserved.
#
###
#
# - Find CBLAS include dirs and libraries
# Use this module by invoking find_package with the form:
#  find_package(CBLAS
#               [REQUIRED] # Fail with error if cblas is not found
#               [COMPONENTS <comp1> <comp2> ...] # dependencies
#              )
#
#  CBLAS depends on the following libraries:
#   - BLAS
#
#  COMPONENTS are optional libraries LAPACKE could be linked with,
#  Use it to drive detection of a specific compilation chain
#  COMPONENTS can be some of the following:
#   - BLASEXT: to activate detection of BLAS with BLASEXT cmake module
#
# This module finds headers and cblas library.
# Results are reported in variables:
#  CBLAS_FOUND            - True if headers and requested libraries were found
29
#  CBLAS_LINKER_FLAGS     - list of required linker flags (excluding -l and -L)
30 31 32 33 34 35 36 37 38 39 40 41
#  CBLAS_INCLUDE_DIRS     - cblas include directories
#  CBLAS_LIBRARY_DIRS     - Link directories for cblas libraries
#  CBLAS_LIBRARIES        - cblas component libraries to be linked
#  CBLAS_INCLUDE_DIRS_DEP - cblas + dependencies include directories
#  CBLAS_LIBRARY_DIRS_DEP - cblas + dependencies link directories
#  CBLAS_LIBRARIES_DEP    - cblas libraries + dependencies
#
# The user can give specific paths where to find the libraries adding cmake
# options at configure (ex: cmake path/to/project -DCBLAS_DIR=path/to/cblas):
#  CBLAS_DIR              - Where to find the base directory of cblas
#  CBLAS_INCDIR           - Where to find the header files
#  CBLAS_LIBDIR           - Where to find the library files
42 43
# The module can also look for the following environment variables if paths
# are not given as cmake variable: CBLAS_DIR, CBLAS_INCDIR, CBLAS_LIBDIR
44 45 46 47 48 49 50
#
# CBLAS could be directly embedded in BLAS library (ex: Intel MKL) so that
# we test a cblas function with the blas libraries found and set CBLAS
# variables to BLAS ones if test is successful. To skip this feature and
# look for a stand alone cblas, please add the following in your
# CMakeLists.txt before to call find_package(CBLAS):
# set(CBLAS_STANDALONE TRUE)
51 52 53 54 55 56 57
###
# We handle different modes to find the dependency
#
# - Detection if already installed on the system
#   - CBLAS libraries can be detected from different ways
#     Here is the order of precedence:
#     1) we look in cmake variable CBLAS_LIBDIR or CBLAS_DIR (we guess the libdirs) if defined
58
#     2) we look in environment variable CBLAS_LIBDIR or CBLAS_DIR (we guess the libdirs) if defined
59 60 61 62 63
#     3) we look in common environnment variables depending on the system (INCLUDE, C_INCLUDE_PATH, CPATH - LIB, DYLD_LIBRARY_PATH, LD_LIBRARY_PATH)
#     4) we look in common system paths depending on the system, see for example paths contained in the following cmake variables:
#       - CMAKE_PLATFORM_IMPLICIT_INCLUDE_DIRECTORIES, CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES
#       - CMAKE_C_IMPLICIT_INCLUDE_DIRECTORIES, CMAKE_C_IMPLICIT_LINK_DIRECTORIES
#
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83

#=============================================================================
# Copyright 2012-2013 Inria
# Copyright 2012-2013 Emmanuel Agullo
# Copyright 2012-2013 Mathieu Faverge
# Copyright 2012      Cedric Castagnede
# Copyright 2013      Florent Pruvost
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file MORSE-Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# (To distribute this file outside of Morse, substitute the full
#  License text for the above reference.)


if (NOT CBLAS_FOUND)
84
    set(CBLAS_DIR "" CACHE PATH "Installation directory of CBLAS library")
85 86 87 88 89 90 91 92 93 94 95
    if (NOT CBLAS_FIND_QUIETLY)
        message(STATUS "A cache variable, namely CBLAS_DIR, has been set to specify the install directory of CBLAS")
    endif()
endif()


# CBLAS may depend on BLASEXT
# try to find it specified as COMPONENTS during the call
if (CBLAS_FIND_COMPONENTS)
    foreach( component ${CBLAS_FIND_COMPONENTS} )
        if(CBLAS_FIND_REQUIRED_${component})
96
            find_package(${component} REQUIRED)
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
        else()
            find_package(${component})
        endif()
        if(${component}_FOUND)
            set(CBLAS_${component}_FOUND TRUE)
        else()
            set(CBLAS_${component}_FOUND FALSE)
        endif()
    endforeach()
endif ()


# CBLAS depends on BLAS anyway, try to find it
if (NOT BLAS_FOUND)
    if(CBLAS_FIND_REQUIRED)
        find_package(BLAS REQUIRED)
    else()
        find_package(BLAS)
    endif()
endif()

118

119 120 121 122 123 124 125
# find CBLAS
if (BLAS_FOUND)

    if (NOT CBLAS_STANDALONE)
        # check if a cblas function exists in the BLAS lib
        # this can be the case with libs such as MKL, ACML
        include(CheckFunctionExists)
126
        set(CMAKE_REQUIRED_LIBRARIES "${BLAS_LINKER_FLAGS};${BLAS_LIBRARIES}")
127 128 129 130 131 132 133 134 135 136 137
        unset(CBLAS_WORKS CACHE)
        check_function_exists(cblas_dscal CBLAS_WORKS)
        mark_as_advanced(CBLAS_WORKS)
        set(CMAKE_REQUIRED_LIBRARIES)

        if(CBLAS_WORKS)
            if(NOT CBLAS_FIND_QUIETLY)
                message(STATUS "Looking for cblas: test with blas succeeds")
            endif()
            # test succeeds: CBLAS is in BLAS
            set(CBLAS_LIBRARIES "${BLAS_LIBRARIES}")
138 139 140
            if (BLAS_LIBRARY_DIRS)
                set(CBLAS_LIBRARY_DIRS "${BLAS_LIBRARY_DIRS}")
            endif()
141 142 143
            if(BLAS_INCLUDE_DIRS)
                set(CBLAS_INCLUDE_DIRS "${BLAS_INCLUDE_DIRS}")
            endif()
144 145 146
            if (BLAS_LINKER_FLAGS)
                set(CBLAS_LINKER_FLAGS "${BLAS_LINKER_FLAGS}")
            endif()
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
        endif()
    endif (NOT CBLAS_STANDALONE)

    if (CBLAS_STANDALONE OR NOT CBLAS_WORKS)

        if(NOT CBLAS_WORKS AND NOT CBLAS_FIND_QUIETLY)
            message(STATUS "Looking for cblas : test with blas fails")
        endif()
        # test fails: try to find CBLAS lib exterior to BLAS

        # Try to find CBLAS lib
        #######################

        # Looking for include
        # -------------------

        # Add system include paths to search include
        # ------------------------------------------
        unset(_inc_env)
166 167 168 169 170 171 172 173
        set(ENV_CBLAS_DIR "$ENV{CBLAS_DIR}")
        set(ENV_CBLAS_INCDIR "$ENV{CBLAS_INCDIR}")
        if(ENV_CBLAS_INCDIR)
            list(APPEND _inc_env "${ENV_CBLAS_INCDIR}")
        elseif(ENV_CBLAS_DIR)
            list(APPEND _inc_env "${ENV_CBLAS_DIR}")
            list(APPEND _inc_env "${ENV_CBLAS_DIR}/include")
            list(APPEND _inc_env "${ENV_CBLAS_DIR}/include/cblas")
174
        else()
175 176 177 178 179 180 181 182 183 184 185 186 187
            if(WIN32)
                string(REPLACE ":" ";" _path_env "$ENV{INCLUDE}")
                list(APPEND _inc_env "${_path_env}")
            else()
                string(REPLACE ":" ";" _path_env "$ENV{INCLUDE}")
                list(APPEND _inc_env "${_path_env}")
                string(REPLACE ":" ";" _path_env "$ENV{C_INCLUDE_PATH}")
                list(APPEND _inc_env "${_path_env}")
                string(REPLACE ":" ";" _path_env "$ENV{CPATH}")
                list(APPEND _inc_env "${_path_env}")
                string(REPLACE ":" ";" _path_env "$ENV{INCLUDE_PATH}")
                list(APPEND _inc_env "${_path_env}")
            endif()
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
        endif()
        list(APPEND _inc_env "${CMAKE_PLATFORM_IMPLICIT_INCLUDE_DIRECTORIES}")
        list(APPEND _inc_env "${CMAKE_C_IMPLICIT_INCLUDE_DIRECTORIES}")
        list(REMOVE_DUPLICATES _inc_env)


        # Try to find the cblas header in the given paths
        # -------------------------------------------------
        # call cmake macro to find the header path
        if(CBLAS_INCDIR)
            set(CBLAS_cblas.h_DIRS "CBLAS_cblas.h_DIRS-NOTFOUND")
            find_path(CBLAS_cblas.h_DIRS
            NAMES cblas.h
            HINTS ${CBLAS_INCDIR})
        else()
            if(CBLAS_DIR)
                set(CBLAS_cblas.h_DIRS "CBLAS_cblas.h_DIRS-NOTFOUND")
                find_path(CBLAS_cblas.h_DIRS
                NAMES cblas.h
                HINTS ${CBLAS_DIR}
208
                PATH_SUFFIXES "include" "include/cblas")
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
            else()
                set(CBLAS_cblas.h_DIRS "CBLAS_cblas.h_DIRS-NOTFOUND")
                find_path(CBLAS_cblas.h_DIRS
                NAMES cblas.h
                HINTS ${_inc_env})
            endif()
        endif()
        mark_as_advanced(CBLAS_cblas.h_DIRS)

        # If found, add path to cmake variable
        # ------------------------------------
        if (CBLAS_cblas.h_DIRS)
            set(CBLAS_INCLUDE_DIRS "${CBLAS_cblas.h_DIRS}")
        else ()
            set(CBLAS_INCLUDE_DIRS "CBLAS_INCLUDE_DIRS-NOTFOUND")
            if(NOT CBLAS_FIND_QUIETLY)
                message(STATUS "Looking for cblas -- cblas.h not found")
            endif()
        endif()


        # Looking for lib
        # ---------------

        # Add system library paths to search lib
        # --------------------------------------
        unset(_lib_env)
236 237 238 239 240 241
        set(ENV_CBLAS_LIBDIR "$ENV{CBLAS_LIBDIR}")
        if(ENV_CBLAS_LIBDIR)
            list(APPEND _lib_env "${ENV_CBLAS_LIBDIR}")
        elseif(ENV_CBLAS_DIR)
            list(APPEND _lib_env "${ENV_CBLAS_DIR}")
            list(APPEND _lib_env "${ENV_CBLAS_DIR}/lib")
242
        else()
243 244
            if(WIN32)
                string(REPLACE ":" ";" _lib_env "$ENV{LIB}")
245
            else()
246 247 248 249 250 251 252
                if(APPLE)
                    string(REPLACE ":" ";" _lib_env "$ENV{DYLD_LIBRARY_PATH}")
                else()
                    string(REPLACE ":" ";" _lib_env "$ENV{LD_LIBRARY_PATH}")
                endif()
                list(APPEND _lib_env "${CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES}")
                list(APPEND _lib_env "${CMAKE_C_IMPLICIT_LINK_DIRECTORIES}")
253 254 255 256 257 258 259 260 261 262 263
            endif()
        endif()
        list(REMOVE_DUPLICATES _lib_env)

        # Try to find the cblas lib in the given paths
        # ----------------------------------------------

        # call cmake macro to find the lib path
        if(CBLAS_LIBDIR)
            set(CBLAS_cblas_LIBRARY "CBLAS_cblas_LIBRARY-NOTFOUND")
            find_library(CBLAS_cblas_LIBRARY
264
                NAMES cblas
265 266 267 268 269
                HINTS ${CBLAS_LIBDIR})
        else()
            if(CBLAS_DIR)
                set(CBLAS_cblas_LIBRARY "CBLAS_cblas_LIBRARY-NOTFOUND")
                find_library(CBLAS_cblas_LIBRARY
270
                    NAMES cblas
271 272 273 274 275
                    HINTS ${CBLAS_DIR}
                    PATH_SUFFIXES lib lib32 lib64)
            else()
                set(CBLAS_cblas_LIBRARY "CBLAS_cblas_LIBRARY-NOTFOUND")
                find_library(CBLAS_cblas_LIBRARY
276
                    NAMES cblas
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
                    HINTS ${_lib_env})
            endif()
        endif()
        mark_as_advanced(CBLAS_cblas_LIBRARY)

        # If found, add path to cmake variable
        # ------------------------------------
        if (CBLAS_cblas_LIBRARY)
            get_filename_component(cblas_lib_path "${CBLAS_cblas_LIBRARY}" PATH)
            # set cmake variables
            set(CBLAS_LIBRARIES    "${CBLAS_cblas_LIBRARY}")
            set(CBLAS_LIBRARY_DIRS "${cblas_lib_path}")
        else ()
            set(CBLAS_LIBRARIES    "CBLAS_LIBRARIES-NOTFOUND")
            set(CBLAS_LIBRARY_DIRS "CBLAS_LIBRARY_DIRS-NOTFOUND")
            if (NOT CBLAS_FIND_QUIETLY)
                message(STATUS "Looking for cblas -- lib cblas not found")
            endif()
        endif ()

        # check a function to validate the find
        if(CBLAS_LIBRARIES)

            set(REQUIRED_INCDIRS)
301
            set(REQUIRED_LDFLAGS)
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
            set(REQUIRED_LIBDIRS)
            set(REQUIRED_LIBS)

            # CBLAS
            if (CBLAS_INCLUDE_DIRS)
                set(REQUIRED_INCDIRS "${CBLAS_INCLUDE_DIRS}")
            endif()
            if (CBLAS_LIBRARY_DIRS)
                set(REQUIRED_LIBDIRS "${CBLAS_LIBRARY_DIRS}")
            endif()
            set(REQUIRED_LIBS "${CBLAS_LIBRARIES}")
            # BLAS
            if (BLAS_INCLUDE_DIRS)
                list(APPEND REQUIRED_INCDIRS "${BLAS_INCLUDE_DIRS}")
            endif()
            if (BLAS_LIBRARY_DIRS)
                list(APPEND REQUIRED_LIBDIRS "${BLAS_LIBRARY_DIRS}")
            endif()
            list(APPEND REQUIRED_LIBS "${BLAS_LIBRARIES}")
321 322 323
            if (BLAS_LINKER_FLAGS)
                list(APPEND REQUIRED_LDFLAGS "${BLAS_LINKER_FLAGS}")
            endif()
324 325 326 327

            # set required libraries for link
            set(CMAKE_REQUIRED_INCLUDES "${REQUIRED_INCDIRS}")
            set(CMAKE_REQUIRED_LIBRARIES)
328
            list(APPEND CMAKE_REQUIRED_LIBRARIES "${REQUIRED_LDFLAGS}")
329
            foreach(lib_dir ${REQUIRED_LIBDIRS})
330
                list(APPEND CMAKE_REQUIRED_LIBRARIES "-L${lib_dir}")
331 332
            endforeach()
            list(APPEND CMAKE_REQUIRED_LIBRARIES "${REQUIRED_LIBS}")
333
            string(REGEX REPLACE "^ -" "-" CMAKE_REQUIRED_LIBRARIES "${CMAKE_REQUIRED_LIBRARIES}")
334 335 336 337 338 339 340 341 342 343 344 345

            # test link
            unset(CBLAS_WORKS CACHE)
            include(CheckFunctionExists)
            check_function_exists(cblas_dscal CBLAS_WORKS)
            mark_as_advanced(CBLAS_WORKS)

            if(CBLAS_WORKS)
                # save link with dependencies
                set(CBLAS_LIBRARIES_DEP "${REQUIRED_LIBS}")
                set(CBLAS_LIBRARY_DIRS_DEP "${REQUIRED_LIBDIRS}")
                set(CBLAS_INCLUDE_DIRS_DEP "${REQUIRED_INCDIRS}")
346
                set(CBLAS_LINKER_FLAGS "${REQUIRED_LDFLAGS}")
347 348
                list(REMOVE_DUPLICATES CBLAS_LIBRARY_DIRS_DEP)
                list(REMOVE_DUPLICATES CBLAS_INCLUDE_DIRS_DEP)
349
                list(REMOVE_DUPLICATES CBLAS_LINKER_FLAGS)
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
            else()
                if(NOT CBLAS_FIND_QUIETLY)
                    message(STATUS "Looking for cblas : test of cblas_dscal with cblas and blas libraries fails")
                    message(STATUS "CMAKE_REQUIRED_LIBRARIES: ${CMAKE_REQUIRED_LIBRARIES}")
                    message(STATUS "CMAKE_REQUIRED_INCLUDES: ${CMAKE_REQUIRED_INCLUDES}")
                    message(STATUS "Check in CMakeFiles/CMakeError.log to figure out why it fails")
                endif()
            endif()
            set(CMAKE_REQUIRED_INCLUDES)
            set(CMAKE_REQUIRED_FLAGS)
            set(CMAKE_REQUIRED_LIBRARIES)
        endif(CBLAS_LIBRARIES)

    endif (CBLAS_STANDALONE OR NOT CBLAS_WORKS)

else(BLAS_FOUND)

    if (NOT CBLAS_FIND_QUIETLY)
        message(STATUS "CBLAS requires BLAS but BLAS has not been found."
            "Please look for BLAS first.")
    endif()

endif(BLAS_FOUND)

374
if (CBLAS_LIBRARIES)
375 376 377 378
    list(GET CBLAS_LIBRARIES 0 first_lib)
    get_filename_component(first_lib_path "${first_lib}" PATH)
    if (${first_lib_path} MATCHES "(/lib(32|64)?$)|(/lib/intel64$|/lib/ia32$)")
        string(REGEX REPLACE "(/lib(32|64)?$)|(/lib/intel64$|/lib/ia32$)" "" not_cached_dir "${first_lib_path}")
379 380 381
        set(CBLAS_DIR_FOUND "${not_cached_dir}" CACHE PATH "Installation directory of CBLAS library" FORCE)
    else()
        set(CBLAS_DIR_FOUND "${first_lib_path}" CACHE PATH "Installation directory of CBLAS library" FORCE)
382 383
    endif()
endif()
384 385 386 387 388 389 390

# check that CBLAS has been found
# -------------------------------
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(CBLAS DEFAULT_MSG
                                  CBLAS_LIBRARIES
                                  CBLAS_WORKS)