FindLAPACKE.cmake 14.6 KB
Newer Older
PRUVOST Florent's avatar
PRUVOST Florent committed
1 2 3 4 5
###
#
# @copyright (c) 2009-2014 The University of Tennessee and The University
#                          of Tennessee Research Foundation.
#                          All rights reserved.
6
# @copyright (c) 2012-2017 Inria. All rights reserved.
PRUVOST Florent's avatar
PRUVOST Florent committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20
# @copyright (c) 2012-2014 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, Univ. Bordeaux. All rights reserved.
#
###
#
# - Find LAPACKE include dirs and libraries
# Use this module by invoking find_package with the form:
#  find_package(LAPACKE
#               [REQUIRED] # Fail with error if lapacke is not found
#               [COMPONENTS <comp1> <comp2> ...] # dependencies
#              )
#
#  LAPACKE depends on the following libraries:
#   - LAPACK
#
21 22 23 24 25
#  COMPONENTS are optional libraries CHAMELEON could be linked with,
#  Use it to drive detection of a specific compilation chain
#  COMPONENTS can be some of the following:
#   - TMG: to check that LAPACKE provides the tmglib interface
#
PRUVOST Florent's avatar
PRUVOST Florent committed
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
# This module finds headers and lapacke library.
# Results are reported in variables:
#  LAPACKE_FOUND            - True if headers and requested libraries were found
#  LAPACKE_LINKER_FLAGS     - list of required linker flags (excluding -l and -L)
#  LAPACKE_INCLUDE_DIRS     - lapacke include directories
#  LAPACKE_LIBRARY_DIRS     - Link directories for lapacke libraries
#  LAPACKE_LIBRARIES        - lapacke component libraries to be linked
#  LAPACKE_INCLUDE_DIRS_DEP - lapacke + dependencies include directories
#  LAPACKE_LIBRARY_DIRS_DEP - lapacke + dependencies link directories
#  LAPACKE_LIBRARIES_DEP    - lapacke libraries + dependencies
#
# The user can give specific paths where to find the libraries adding cmake
# options at configure (ex: cmake path/to/project -DLAPACKE_DIR=path/to/lapacke):
#  LAPACKE_DIR             - Where to find the base directory of lapacke
#  LAPACKE_INCDIR          - Where to find the header files
#  LAPACKE_LIBDIR          - Where to find the library files
# The module can also look for the following environment variables if paths
# are not given as cmake variable: LAPACKE_DIR, LAPACKE_INCDIR, LAPACKE_LIBDIR
#
# LAPACKE could be directly embedded in LAPACK library (ex: Intel MKL) so that
# we test a lapacke function with the lapack libraries found and set LAPACKE
# variables to LAPACK ones if test is successful. To skip this feature and
# look for a stand alone lapacke, please add the following in your
# CMakeLists.txt before to call find_package(LAPACKE):
# set(LAPACKE_STANDALONE TRUE)

#=============================================================================
# Copyright 2012-2013 Inria
# Copyright 2012-2013 Emmanuel Agullo
# Copyright 2012-2013 Mathieu Faverge
# Copyright 2012      Cedric Castagnede
57
# Copyright 2013-2017 Florent Pruvost
PRUVOST Florent's avatar
PRUVOST Florent committed
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
#
# 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 LAPACKE_FOUND)
  set(LAPACKE_DIR "" CACHE PATH "Installation directory of LAPACKE library")
  if (NOT LAPACKE_FIND_QUIETLY)
    message(STATUS "A cache variable, namely LAPACKE_DIR, has been set to specify the install directory of LAPACKE")
  endif()
endif()

76 77 78 79 80 81 82 83 84 85
# to check that LAPACKE provides the tmglib interface
set(LAPACKE_WITH_TMG OFF)
if( LAPACKE_FIND_COMPONENTS )
  foreach( component ${LAPACKE_FIND_COMPONENTS} )
    if (${component} STREQUAL "TMG")
      set(LAPACKE_WITH_TMG ON)
    endif()
  endforeach()
endif()

PRUVOST Florent's avatar
PRUVOST Florent committed
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
# LAPACKE depends on LAPACK anyway, try to find it
if (NOT LAPACK_FOUND)
  if(LAPACKE_FIND_REQUIRED)
    find_package(LAPACKEXT REQUIRED)
  else()
    find_package(LAPACKEXT)
  endif()
endif()

# LAPACKE depends on LAPACK
if (LAPACK_FOUND)

  if (NOT LAPACKE_STANDALONE)
    # check if a lapacke function exists in the LAPACK lib
    include(CheckFunctionExists)
    set(CMAKE_REQUIRED_LIBRARIES "${LAPACK_LINKER_FLAGS};${LAPACK_LIBRARIES}")
    unset(LAPACKE_WORKS CACHE)
    check_function_exists(LAPACKE_dgeqrf LAPACKE_WORKS)
    mark_as_advanced(LAPACKE_WORKS)
    set(CMAKE_REQUIRED_LIBRARIES)

    if(LAPACKE_WORKS)
      if(NOT LAPACKE_FIND_QUIETLY)
109
        message(STATUS "Looking for lapacke: test with lapack succeeds")
PRUVOST Florent's avatar
PRUVOST Florent committed
110 111 112
      endif()
      # test succeeds: LAPACKE is in LAPACK
      set(LAPACKE_LIBRARIES "${LAPACK_LIBRARIES}")
113
      set(LAPACKE_LIBRARIES_DEP "${LAPACK_LIBRARIES}")
PRUVOST Florent's avatar
PRUVOST Florent committed
114
      if (LAPACK_LIBRARY_DIRS)
115
        set(LAPACKE_LIBRARY_DIRS "${LAPACK_LIBRARY_DIRS}")
PRUVOST Florent's avatar
PRUVOST Florent committed
116 117
      endif()
      if(LAPACK_INCLUDE_DIRS)
118 119
        set(LAPACKE_INCLUDE_DIRS "${LAPACK_INCLUDE_DIRS}")
        set(LAPACKE_INCLUDE_DIRS_DEP "${LAPACK_INCLUDE_DIRS}")
PRUVOST Florent's avatar
PRUVOST Florent committed
120 121
      endif()
      if (LAPACK_LINKER_FLAGS)
122
        set(LAPACKE_LINKER_FLAGS "${LAPACK_LINKER_FLAGS}")
PRUVOST Florent's avatar
PRUVOST Florent committed
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
      endif()
    endif()
  endif (NOT LAPACKE_STANDALONE)

  if (LAPACKE_STANDALONE OR NOT LAPACKE_WORKS)

    if(NOT LAPACKE_WORKS AND NOT LAPACKE_FIND_QUIETLY)
      message(STATUS "Looking for lapacke : test with lapack fails")
    endif()
    # test fails: try to find LAPACKE lib exterior to LAPACK

    # Try to find LAPACKE lib
    #######################

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

    # Add system include paths to search include
    # ------------------------------------------
    unset(_inc_env)
    set(ENV_LAPACKE_DIR "$ENV{LAPACKE_DIR}")
    set(ENV_LAPACKE_INCDIR "$ENV{LAPACKE_INCDIR}")
    if(ENV_LAPACKE_INCDIR)
      list(APPEND _inc_env "${ENV_LAPACKE_INCDIR}")
    elseif(ENV_LAPACKE_DIR)
      list(APPEND _inc_env "${ENV_LAPACKE_DIR}")
      list(APPEND _inc_env "${ENV_LAPACKE_DIR}/include")
      list(APPEND _inc_env "${ENV_LAPACKE_DIR}/include/lapacke")
    else()
      if(WIN32)
153
        string(REPLACE ":" ";" _inc_env "$ENV{INCLUDE}")
PRUVOST Florent's avatar
PRUVOST Florent committed
154
      else()
155 156 157 158 159 160 161 162
        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}")
PRUVOST Florent's avatar
PRUVOST Florent committed
163 164 165 166 167 168 169 170 171 172 173 174 175
      endif()
    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 lapacke header in the given paths
    # -------------------------------------------------
    # call cmake macro to find the header path
    if(LAPACKE_INCDIR)
      set(LAPACKE_lapacke.h_DIRS "LAPACKE_lapacke.h_DIRS-NOTFOUND")
      find_path(LAPACKE_lapacke.h_DIRS
176 177
        NAMES lapacke.h
        HINTS ${LAPACKE_INCDIR})
PRUVOST Florent's avatar
PRUVOST Florent committed
178 179
    else()
      if(LAPACKE_DIR)
180 181 182 183 184
        set(LAPACKE_lapacke.h_DIRS "LAPACKE_lapacke.h_DIRS-NOTFOUND")
        find_path(LAPACKE_lapacke.h_DIRS
          NAMES lapacke.h
          HINTS ${LAPACKE_DIR}
          PATH_SUFFIXES "include" "include/lapacke")
PRUVOST Florent's avatar
PRUVOST Florent committed
185
      else()
186 187 188 189
        set(LAPACKE_lapacke.h_DIRS "LAPACKE_lapacke.h_DIRS-NOTFOUND")
        find_path(LAPACKE_lapacke.h_DIRS
          NAMES lapacke.h
          HINTS ${_inc_env})
PRUVOST Florent's avatar
PRUVOST Florent committed
190 191 192 193 194 195 196 197 198 199 200
      endif()
    endif()
    mark_as_advanced(LAPACKE_lapacke.h_DIRS)

    # If found, add path to cmake variable
    # ------------------------------------
    if (LAPACKE_lapacke.h_DIRS)
      set(LAPACKE_INCLUDE_DIRS "${LAPACKE_lapacke.h_DIRS}")
    else ()
      set(LAPACKE_INCLUDE_DIRS "LAPACKE_INCLUDE_DIRS-NOTFOUND")
      if(NOT LAPACKE_FIND_QUIETLY)
201
        message(STATUS "Looking for lapacke -- lapacke.h not found")
PRUVOST Florent's avatar
PRUVOST Florent committed
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
      endif()
    endif()


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

    # Add system library paths to search lib
    # --------------------------------------
    unset(_lib_env)
    set(ENV_LAPACKE_LIBDIR "$ENV{LAPACKE_LIBDIR}")
    if(ENV_LAPACKE_LIBDIR)
      list(APPEND _lib_env "${ENV_LAPACKE_LIBDIR}")
    elseif(ENV_LAPACKE_DIR)
      list(APPEND _lib_env "${ENV_LAPACKE_DIR}")
      list(APPEND _lib_env "${ENV_LAPACKE_DIR}/lib")
    else()
      if(WIN32)
220
        string(REPLACE ":" ";" _lib_env "$ENV{LIB}")
PRUVOST Florent's avatar
PRUVOST Florent committed
221
      else()
222 223 224 225 226 227 228
        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}")
PRUVOST Florent's avatar
PRUVOST Florent committed
229 230 231 232 233 234 235 236 237 238 239
      endif()
    endif()
    list(REMOVE_DUPLICATES _lib_env)

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

    # call cmake macro to find the lib path
    if(LAPACKE_LIBDIR)
      set(LAPACKE_lapacke_LIBRARY "LAPACKE_lapacke_LIBRARY-NOTFOUND")
      find_library(LAPACKE_lapacke_LIBRARY
240 241
        NAMES lapacke
        HINTS ${LAPACKE_LIBDIR})
PRUVOST Florent's avatar
PRUVOST Florent committed
242 243
    else()
      if(LAPACKE_DIR)
244 245 246 247 248
        set(LAPACKE_lapacke_LIBRARY "LAPACKE_lapacke_LIBRARY-NOTFOUND")
        find_library(LAPACKE_lapacke_LIBRARY
          NAMES lapacke
          HINTS ${LAPACKE_DIR}
          PATH_SUFFIXES lib lib32 lib64)
PRUVOST Florent's avatar
PRUVOST Florent committed
249
      else()
250 251 252 253
        set(LAPACKE_lapacke_LIBRARY "LAPACKE_lapacke_LIBRARY-NOTFOUND")
        find_library(LAPACKE_lapacke_LIBRARY
          NAMES lapacke
          HINTS ${_lib_env})
PRUVOST Florent's avatar
PRUVOST Florent committed
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
      endif()
    endif()
    mark_as_advanced(LAPACKE_lapacke_LIBRARY)

    # If found, add path to cmake variable
    # ------------------------------------
    if (LAPACKE_lapacke_LIBRARY)
      get_filename_component(lapacke_lib_path "${LAPACKE_lapacke_LIBRARY}" PATH)
      # set cmake variables
      set(LAPACKE_LIBRARIES    "${LAPACKE_lapacke_LIBRARY}")
      set(LAPACKE_LIBRARY_DIRS "${lapacke_lib_path}")
    else ()
      set(LAPACKE_LIBRARIES    "LAPACKE_LIBRARIES-NOTFOUND")
      set(LAPACKE_LIBRARY_DIRS "LAPACKE_LIBRARY_DIRS-NOTFOUND")
      if (NOT LAPACKE_FIND_QUIETLY)
269
        message(STATUS "Looking for lapacke -- lib lapacke not found")
PRUVOST Florent's avatar
PRUVOST Florent committed
270 271 272 273 274 275 276 277 278 279 280 281 282
      endif()
    endif ()

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

      set(REQUIRED_LDFLAGS)
      set(REQUIRED_INCDIRS)
      set(REQUIRED_LIBDIRS)
      set(REQUIRED_LIBS)

      # LAPACKE
      if (LAPACKE_INCLUDE_DIRS)
283
        set(REQUIRED_INCDIRS "${LAPACKE_INCLUDE_DIRS}")
PRUVOST Florent's avatar
PRUVOST Florent committed
284 285
      endif()
      if (LAPACKE_LIBRARY_DIRS)
286
        set(REQUIRED_LIBDIRS "${LAPACKE_LIBRARY_DIRS}")
PRUVOST Florent's avatar
PRUVOST Florent committed
287 288 289 290
      endif()
      set(REQUIRED_LIBS "${LAPACKE_LIBRARIES}")
      # LAPACK
      if (LAPACK_INCLUDE_DIRS)
291
        list(APPEND REQUIRED_INCDIRS "${LAPACK_INCLUDE_DIRS}")
PRUVOST Florent's avatar
PRUVOST Florent committed
292 293
      endif()
      if (LAPACK_LIBRARY_DIRS)
294
        list(APPEND REQUIRED_LIBDIRS "${LAPACK_LIBRARY_DIRS}")
PRUVOST Florent's avatar
PRUVOST Florent committed
295 296 297
      endif()
      list(APPEND REQUIRED_LIBS "${LAPACK_LIBRARIES}")
      if (LAPACK_LINKER_FLAGS)
298
        list(APPEND REQUIRED_LDFLAGS "${LAPACK_LINKER_FLAGS}")
PRUVOST Florent's avatar
PRUVOST Florent committed
299 300 301
      endif()
      # Fortran
      if (CMAKE_C_COMPILER_ID MATCHES "GNU")
302 303 304 305 306 307 308 309 310
        find_library(
          FORTRAN_gfortran_LIBRARY
          NAMES gfortran
          HINTS ${_lib_env}
          )
        mark_as_advanced(FORTRAN_gfortran_LIBRARY)
        if (FORTRAN_gfortran_LIBRARY)
          list(APPEND REQUIRED_LIBS "${FORTRAN_gfortran_LIBRARY}")
        endif()
PRUVOST Florent's avatar
PRUVOST Florent committed
311
      elseif (CMAKE_C_COMPILER_ID MATCHES "Intel")
312 313 314 315 316 317 318 319 320
        find_library(
          FORTRAN_ifcore_LIBRARY
          NAMES ifcore
          HINTS ${_lib_env}
          )
        mark_as_advanced(FORTRAN_ifcore_LIBRARY)
        if (FORTRAN_ifcore_LIBRARY)
          list(APPEND REQUIRED_LIBS "${FORTRAN_ifcore_LIBRARY}")
        endif()
PRUVOST Florent's avatar
PRUVOST Florent committed
321 322 323 324 325
      endif()
      # m
      find_library(M_LIBRARY NAMES m HINTS ${_lib_env})
      mark_as_advanced(M_LIBRARY)
      if(M_LIBRARY)
326
        list(APPEND REQUIRED_LIBS "-lm")
PRUVOST Florent's avatar
PRUVOST Florent committed
327 328 329 330 331 332
      endif()
      # set required libraries for link
      set(CMAKE_REQUIRED_INCLUDES "${REQUIRED_INCDIRS}")
      set(CMAKE_REQUIRED_LIBRARIES)
      list(APPEND CMAKE_REQUIRED_LIBRARIES "${REQUIRED_LDFLAGS}")
      foreach(lib_dir ${REQUIRED_LIBDIRS})
333
        list(APPEND CMAKE_REQUIRED_LIBRARIES "-L${lib_dir}")
PRUVOST Florent's avatar
PRUVOST Florent committed
334 335 336 337 338 339 340 341
      endforeach()
      list(APPEND CMAKE_REQUIRED_LIBRARIES "${REQUIRED_LIBS}")
      string(REGEX REPLACE "^ -" "-" CMAKE_REQUIRED_LIBRARIES "${CMAKE_REQUIRED_LIBRARIES}")

      # test link
      unset(LAPACKE_WORKS CACHE)
      include(CheckFunctionExists)
      check_function_exists(LAPACKE_dgeqrf LAPACKE_WORKS)
342 343 344 345
      if (LAPACKE_WORKS AND LAPACKE_WITH_TMG)
        unset(LAPACKE_WORKS CACHE)
        check_function_exists(LAPACKE_dlatms_work LAPACKE_WORKS)
      endif()
PRUVOST Florent's avatar
PRUVOST Florent committed
346 347 348
      mark_as_advanced(LAPACKE_WORKS)

      if(LAPACKE_WORKS)
349 350 351 352 353 354 355 356
        # save link with dependencies
        set(LAPACKE_LIBRARIES_DEP "${REQUIRED_LIBS}")
        set(LAPACKE_LIBRARY_DIRS_DEP "${REQUIRED_LIBDIRS}")
        set(LAPACKE_INCLUDE_DIRS_DEP "${REQUIRED_INCDIRS}")
        set(LAPACKE_LINKER_FLAGS "${REQUIRED_LDFLAGS}")
        list(REMOVE_DUPLICATES LAPACKE_LIBRARY_DIRS_DEP)
        list(REMOVE_DUPLICATES LAPACKE_INCLUDE_DIRS_DEP)
        list(REMOVE_DUPLICATES LAPACKE_LINKER_FLAGS)
PRUVOST Florent's avatar
PRUVOST Florent committed
357
      else()
358 359 360 361 362 363
        if(NOT LAPACKE_FIND_QUIETLY)
          message(STATUS "Looking for lapacke: test of LAPACKE_dgeqrf with lapacke and lapack 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()
PRUVOST Florent's avatar
PRUVOST Florent committed
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
      endif()
      set(CMAKE_REQUIRED_INCLUDES)
      set(CMAKE_REQUIRED_FLAGS)
      set(CMAKE_REQUIRED_LIBRARIES)
    endif(LAPACKE_LIBRARIES)

  endif (LAPACKE_STANDALONE OR NOT LAPACKE_WORKS)

else(LAPACK_FOUND)

  if (NOT LAPACKE_FIND_QUIETLY)
    message(STATUS "LAPACKE requires LAPACK but LAPACK has not been found."
      "Please look for LAPACK first.")
  endif()

endif(LAPACK_FOUND)

if (LAPACKE_LIBRARIES)
  list(GET LAPACKE_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}")
    set(LAPACKE_DIR_FOUND "${not_cached_dir}" CACHE PATH "Installation directory of LAPACKE library" FORCE)
  else()
    set(LAPACKE_DIR_FOUND "${first_lib_path}" CACHE PATH "Installation directory of LAPACKE library" FORCE)
  endif()
endif()
mark_as_advanced(LAPACKE_DIR)
mark_as_advanced(LAPACKE_DIR_FOUND)

# check that LAPACKE has been found
# ---------------------------------
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(LAPACKE DEFAULT_MSG
  LAPACKE_LIBRARIES
  LAPACKE_WORKS)