FindSCOTCH.cmake 11.2 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
29
###
#
# @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 SCOTCH include dirs and libraries
# Use this module by invoking find_package with the form:
#  find_package(SCOTCH
#               [REQUIRED]             # Fail with error if scotch is not found
#              )
#
# This module finds headers and scotch library.
# Results are reported in variables:
#  SCOTCH_FOUND           - True if headers and requested libraries were found
#  SCOTCH_INCLUDE_DIRS    - scotch include directories
#  SCOTCH_LIBRARY_DIRS    - Link directories for scotch libraries
#  SCOTCH_LIBRARIES       - scotch component libraries to be linked
#  SCOTCH_INTSIZE         - Number of octets occupied by a SCOTCH_Num
#
# The user can give specific paths where to find the libraries adding cmake
# options at configure (ex: cmake path/to/project -DSCOTCH=path/to/scotch):
#  SCOTCH_DIR             - Where to find the base directory of scotch
#  SCOTCH_INCDIR          - Where to find the header files
#  SCOTCH_LIBDIR          - Where to find the library files
30
31
# The module can also look for the following environment variables if paths
# are not given as cmake variable: SCOTCH_DIR, SCOTCH_INCDIR, SCOTCH_LIBDIR
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

#=============================================================================
# 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 SCOTCH_FOUND)
51
    set(SCOTCH_DIR "" CACHE PATH "Installation directory of SCOTCH library")
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
    if (NOT SCOTCH_FIND_QUIETLY)
        message(STATUS "A cache variable, namely SCOTCH_DIR, has been set to specify the install directory of SCOTCH")
    endif()
endif()

# SCOTCH may depend on Threads, try to find it
if (NOT THREADS_FOUND)
    if (SCOTCH_FIND_REQUIRED)
        find_package(Threads REQUIRED)
    else()
        find_package(Threads)
    endif()
endif()

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

# Add system include paths to search include
# ------------------------------------------
unset(_inc_env)
72
73
74
75
76
77
78
79
set(ENV_SCOTCH_DIR "$ENV{SCOTCH_DIR}")
set(ENV_SCOTCH_INCDIR "$ENV{SCOTCH_INCDIR}")
if(ENV_SCOTCH_INCDIR)
    list(APPEND _inc_env "${ENV_SCOTCH_INCDIR}")
elseif(ENV_SCOTCH_DIR)
    list(APPEND _inc_env "${ENV_SCOTCH_DIR}")
    list(APPEND _inc_env "${ENV_SCOTCH_DIR}/include")
    list(APPEND _inc_env "${ENV_SCOTCH_DIR}/include/scotch")
80
else()
81
82
83
84
85
86
87
88
89
90
91
92
    if(WIN32)
        string(REPLACE ":" ";" _inc_env "$ENV{INCLUDE}")
    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()
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
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 scotch header in the given paths
# -------------------------------------------------
# call cmake macro to find the header path
if(SCOTCH_INCDIR)
    set(SCOTCH_scotch.h_DIRS "SCOTCH_scotch.h_DIRS-NOTFOUND")
    find_path(SCOTCH_scotch.h_DIRS
      NAMES scotch.h
      HINTS ${SCOTCH_INCDIR})
else()
    if(SCOTCH_DIR)
        set(SCOTCH_scotch.h_DIRS "SCOTCH_scotch.h_DIRS-NOTFOUND")
        find_path(SCOTCH_scotch.h_DIRS
          NAMES scotch.h
          HINTS ${SCOTCH_DIR}
113
          PATH_SUFFIXES "include" "include/scotch")
114
115
116
117
    else()
        set(SCOTCH_scotch.h_DIRS "SCOTCH_scotch.h_DIRS-NOTFOUND")
        find_path(SCOTCH_scotch.h_DIRS
          NAMES scotch.h
118
119
          HINTS ${_inc_env}
          PATH_SUFFIXES "scotch")
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
    endif()
endif()
mark_as_advanced(SCOTCH_scotch.h_DIRS)

# If found, add path to cmake variable
# ------------------------------------
if (SCOTCH_scotch.h_DIRS)
    set(SCOTCH_INCLUDE_DIRS "${SCOTCH_scotch.h_DIRS}")
else ()
    set(SCOTCH_INCLUDE_DIRS "SCOTCH_INCLUDE_DIRS-NOTFOUND")
    if (NOT SCOTCH_FIND_QUIETLY)
        message(STATUS "Looking for scotch -- scotch.h not found")
    endif()
endif()


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

# Add system library paths to search lib
# --------------------------------------
unset(_lib_env)
142
143
144
145
146
147
set(ENV_SCOTCH_LIBDIR "$ENV{SCOTCH_LIBDIR}")
if(ENV_SCOTCH_LIBDIR)
    list(APPEND _lib_env "${ENV_SCOTCH_LIBDIR}")
elseif(ENV_SCOTCH_DIR)
    list(APPEND _lib_env "${ENV_SCOTCH_DIR}")
    list(APPEND _lib_env "${ENV_SCOTCH_DIR}/lib")
148
else()
149
150
    if(WIN32)
        string(REPLACE ":" ";" _lib_env "$ENV{LIB}")
151
    else()
152
153
154
155
156
157
158
        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}")
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
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
    endif()
endif()
list(REMOVE_DUPLICATES _lib_env)

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

set(SCOTCH_libs_to_find "scotch;scotcherrexit")

# call cmake macro to find the lib path
if(SCOTCH_LIBDIR)
    foreach(scotch_lib ${SCOTCH_libs_to_find})
        set(SCOTCH_${scotch_lib}_LIBRARY "SCOTCH_${scotch_lib}_LIBRARY-NOTFOUND")
        find_library(SCOTCH_${scotch_lib}_LIBRARY
            NAMES ${scotch_lib}
            HINTS ${SCOTCH_LIBDIR})
    endforeach()
else()
    if(SCOTCH_DIR)
        foreach(scotch_lib ${SCOTCH_libs_to_find})
            set(SCOTCH_${scotch_lib}_LIBRARY "SCOTCH_${scotch_lib}_LIBRARY-NOTFOUND")
            find_library(SCOTCH_${scotch_lib}_LIBRARY
                NAMES ${scotch_lib}
                HINTS ${SCOTCH_DIR}
                PATH_SUFFIXES lib lib32 lib64)
        endforeach()
    else()
        foreach(scotch_lib ${SCOTCH_libs_to_find})
            set(SCOTCH_${scotch_lib}_LIBRARY "SCOTCH_${scotch_lib}_LIBRARY-NOTFOUND")
            find_library(SCOTCH_${scotch_lib}_LIBRARY
                NAMES ${scotch_lib}
                HINTS ${_lib_env})
        endforeach()
    endif()
endif()

set(SCOTCH_LIBRARIES "")
set(SCOTCH_LIBRARY_DIRS "")
# If found, add path to cmake variable
# ------------------------------------
foreach(scotch_lib ${SCOTCH_libs_to_find})

    if (SCOTCH_${scotch_lib}_LIBRARY)
        get_filename_component(${scotch_lib}_lib_path "${SCOTCH_${scotch_lib}_LIBRARY}" PATH)
        # set cmake variables
        list(APPEND SCOTCH_LIBRARIES "${SCOTCH_${scotch_lib}_LIBRARY}")
        list(APPEND SCOTCH_LIBRARY_DIRS "${${scotch_lib}_lib_path}")
    else ()
        list(APPEND SCOTCH_LIBRARIES "${SCOTCH_${scotch_lib}_LIBRARY}")
        if (NOT SCOTCH_FIND_QUIETLY)
            message(STATUS "Looking for scotch -- lib ${scotch_lib} not found")
        endif()
    endif ()

    mark_as_advanced(SCOTCH_${scotch_lib}_LIBRARY)

endforeach()

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

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

    # SCOTCH
    if (SCOTCH_INCLUDE_DIRS)
        set(REQUIRED_INCDIRS  "${SCOTCH_INCLUDE_DIRS}")
    endif()
    if (SCOTCH_LIBRARY_DIRS)
        set(REQUIRED_LIBDIRS "${SCOTCH_LIBRARY_DIRS}")
    endif()
    set(REQUIRED_LIBS "${SCOTCH_LIBRARIES}")
    # THREADS
    if(CMAKE_THREAD_LIBS_INIT)
234
        list(APPEND REQUIRED_LIBS "${CMAKE_THREAD_LIBS_INIT}")
235
    endif()
236
237
238
239
    if(UNIX OR WIN32)
        list(APPEND REQUIRED_LIBS "-lm")
    endif()
    list(APPEND REQUIRED_LIBS "-lz -lrt")
240
241
242
243
244
245
246
247

    # set required libraries for link
    set(CMAKE_REQUIRED_INCLUDES "${REQUIRED_INCDIRS}")
    set(CMAKE_REQUIRED_LIBRARIES)
    foreach(lib_dir ${REQUIRED_LIBDIRS})
        list(APPEND CMAKE_REQUIRED_LIBRARIES "-L${lib_dir}")
    endforeach()
    list(APPEND CMAKE_REQUIRED_LIBRARIES "${REQUIRED_LIBS}")
248
    string(REGEX REPLACE "^ -" "-" CMAKE_REQUIRED_LIBRARIES "${CMAKE_REQUIRED_LIBRARIES}")
249
250
251
252
253
254
255

    # test link
    unset(SCOTCH_WORKS CACHE)
    include(CheckFunctionExists)
    check_function_exists(SCOTCH_graphInit SCOTCH_WORKS)
    mark_as_advanced(SCOTCH_WORKS)

256
    if(SCOTCH_WORKS)
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
        # save link with dependencies
        set(SCOTCH_LIBRARIES "${REQUIRED_LIBS}")
    else()
        if(NOT SCOTCH_FIND_QUIETLY)
            message(STATUS "Looking for SCOTCH : test of SCOTCH_graphInit with SCOTCH library 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(SCOTCH_LIBRARIES)

272
if (SCOTCH_LIBRARIES)
273
274
275
276
    list(GET SCOTCH_LIBRARIES 0 first_lib)
    get_filename_component(first_lib_path "${first_lib}" PATH)
    if (${first_lib_path} MATCHES "/lib(32|64)?$")
        string(REGEX REPLACE "/lib(32|64)?$" "" not_cached_dir "${first_lib_path}")
277
278
279
        set(SCOTCH_DIR_FOUND "${not_cached_dir}" CACHE PATH "Installation directory of SCOTCH library" FORCE)
    else()
        set(SCOTCH_DIR_FOUND "${first_lib_path}" CACHE PATH "Installation directory of SCOTCH library" FORCE)
280
281
    endif()
endif()
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333

# Check the size of SCOTCH_Num
# ---------------------------------
set(CMAKE_REQUIRED_INCLUDES ${SCOTCH_INCLUDE_DIRS})

include(CheckCSourceRuns)
#stdio.h and stdint.h should be included by scotch.h directly
set(SCOTCH_C_TEST_SCOTCH_Num_4 "
#include <stdio.h>
#include <stdint.h>
#include <scotch.h>
int main(int argc, char **argv) {
  if (sizeof(SCOTCH_Num) == 4)
    return 0;
  else
    return 1;
}
")

set(SCOTCH_C_TEST_SCOTCH_Num_8 "
#include <stdio.h>
#include <stdint.h>
#include <scotch.h>
int main(int argc, char **argv) {
  if (sizeof(SCOTCH_Num) == 8)
    return 0;
  else
    return 1;
}
")
check_c_source_runs("${SCOTCH_C_TEST_SCOTCH_Num_4}" SCOTCH_Num_4)
if(NOT SCOTCH_Num_4)
  check_c_source_runs("${SCOTCH_C_TEST_SCOTCH_Num_8}" SCOTCH_Num_8)
  if(NOT SCOTCH_Num_8)
    set(SCOTCH_INTSIZE -1)
  else()
    set(SCOTCH_INTSIZE 8)
  endif()
else()
  set(SCOTCH_INTSIZE 4)
endif()
set(CMAKE_REQUIRED_INCLUDES "")

# check that SCOTCH has been found
# ---------------------------------
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(SCOTCH DEFAULT_MSG
                                  SCOTCH_LIBRARIES
                                  SCOTCH_WORKS)
#
# TODO: Add possibility to check for specific functions in the library
#