xref: /aosp_15_r20/external/eigen/cmake/FindHWLOC.cmake (revision bf2c37156dfe67e5dfebd6d394bad8b2ab5804d4)
1###
2#
3# @copyright (c) 2009-2014 The University of Tennessee and The University
4#                          of Tennessee Research Foundation.
5#                          All rights reserved.
6# @copyright (c) 2012-2014 Inria. All rights reserved.
7# @copyright (c) 2012-2014 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, Univ. Bordeaux. All rights reserved.
8#
9###
10#
11# - Find HWLOC include dirs and libraries
12# Use this module by invoking find_package with the form:
13#  find_package(HWLOC
14#               [REQUIRED]) # Fail with error if hwloc is not found
15#
16# This module finds headers and hwloc library.
17# Results are reported in variables:
18#  HWLOC_FOUND           - True if headers and requested libraries were found
19#  HWLOC_INCLUDE_DIRS    - hwloc include directories
20#  HWLOC_LIBRARY_DIRS    - Link directories for hwloc libraries
21#  HWLOC_LIBRARIES       - hwloc component libraries to be linked
22#
23# The user can give specific paths where to find the libraries adding cmake
24# options at configure (ex: cmake path/to/project -DHWLOC_DIR=path/to/hwloc):
25#  HWLOC_DIR             - Where to find the base directory of hwloc
26#  HWLOC_INCDIR          - Where to find the header files
27#  HWLOC_LIBDIR          - Where to find the library files
28# The module can also look for the following environment variables if paths
29# are not given as cmake variable: HWLOC_DIR, HWLOC_INCDIR, HWLOC_LIBDIR
30
31#=============================================================================
32# Copyright 2012-2013 Inria
33# Copyright 2012-2013 Emmanuel Agullo
34# Copyright 2012-2013 Mathieu Faverge
35# Copyright 2012      Cedric Castagnede
36# Copyright 2013      Florent Pruvost
37#
38# Distributed under the OSI-approved BSD License (the "License");
39# see accompanying file MORSE-Copyright.txt for details.
40#
41# This software is distributed WITHOUT ANY WARRANTY; without even the
42# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
43# See the License for more information.
44#=============================================================================
45# (To distribute this file outside of Morse, substitute the full
46#  License text for the above reference.)
47
48include(CheckStructHasMember)
49include(CheckCSourceCompiles)
50
51if (NOT HWLOC_FOUND)
52  set(HWLOC_DIR "" CACHE PATH "Installation directory of HWLOC library")
53  if (NOT HWLOC_FIND_QUIETLY)
54    message(STATUS "A cache variable, namely HWLOC_DIR, has been set to specify the install directory of HWLOC")
55  endif()
56endif()
57
58set(ENV_HWLOC_DIR "$ENV{HWLOC_DIR}")
59set(ENV_HWLOC_INCDIR "$ENV{HWLOC_INCDIR}")
60set(ENV_HWLOC_LIBDIR "$ENV{HWLOC_LIBDIR}")
61set(HWLOC_GIVEN_BY_USER "FALSE")
62if ( HWLOC_DIR OR ( HWLOC_INCDIR AND HWLOC_LIBDIR) OR ENV_HWLOC_DIR OR (ENV_HWLOC_INCDIR AND ENV_HWLOC_LIBDIR) )
63  set(HWLOC_GIVEN_BY_USER "TRUE")
64endif()
65
66# Optionally use pkg-config to detect include/library dirs (if pkg-config is available)
67# -------------------------------------------------------------------------------------
68include(CMakeFindDependencyMacro)
69# include(FindPkgConfig)
70find_dependency(PkgConfig QUIET)
71if( PKG_CONFIG_EXECUTABLE AND NOT HWLOC_GIVEN_BY_USER )
72
73  pkg_search_module(HWLOC hwloc)
74  if (NOT HWLOC_FIND_QUIETLY)
75    if (HWLOC_FOUND AND HWLOC_LIBRARIES)
76      message(STATUS "Looking for HWLOC - found using PkgConfig")
77      #if(NOT HWLOC_INCLUDE_DIRS)
78      #    message("${Magenta}HWLOC_INCLUDE_DIRS is empty using PkgConfig."
79      #        "Perhaps the path to hwloc headers is already present in your"
80      #        "C(PLUS)_INCLUDE_PATH environment variable.${ColourReset}")
81      #endif()
82    else()
83      message(STATUS "${Magenta}Looking for HWLOC - not found using PkgConfig."
84	"\n   Perhaps you should add the directory containing hwloc.pc to"
85	"\n   the PKG_CONFIG_PATH environment variable.${ColourReset}")
86    endif()
87  endif()
88
89endif()
90
91if( (NOT PKG_CONFIG_EXECUTABLE) OR (PKG_CONFIG_EXECUTABLE AND NOT HWLOC_FOUND) OR (HWLOC_GIVEN_BY_USER) )
92
93  if (NOT HWLOC_FIND_QUIETLY)
94    message(STATUS "Looking for HWLOC - PkgConfig not used")
95  endif()
96
97  # Looking for include
98  # -------------------
99
100  # Add system include paths to search include
101  # ------------------------------------------
102  unset(_inc_env)
103  if(ENV_HWLOC_INCDIR)
104    list(APPEND _inc_env "${ENV_HWLOC_INCDIR}")
105  elseif(ENV_HWLOC_DIR)
106    list(APPEND _inc_env "${ENV_HWLOC_DIR}")
107    list(APPEND _inc_env "${ENV_HWLOC_DIR}/include")
108    list(APPEND _inc_env "${ENV_HWLOC_DIR}/include/hwloc")
109  else()
110    if(WIN32)
111      string(REPLACE ":" ";" _inc_env "$ENV{INCLUDE}")
112    else()
113      string(REPLACE ":" ";" _path_env "$ENV{INCLUDE}")
114      list(APPEND _inc_env "${_path_env}")
115      string(REPLACE ":" ";" _path_env "$ENV{C_INCLUDE_PATH}")
116      list(APPEND _inc_env "${_path_env}")
117      string(REPLACE ":" ";" _path_env "$ENV{CPATH}")
118      list(APPEND _inc_env "${_path_env}")
119      string(REPLACE ":" ";" _path_env "$ENV{INCLUDE_PATH}")
120      list(APPEND _inc_env "${_path_env}")
121    endif()
122  endif()
123  list(APPEND _inc_env "${CMAKE_PLATFORM_IMPLICIT_INCLUDE_DIRECTORIES}")
124  list(APPEND _inc_env "${CMAKE_C_IMPLICIT_INCLUDE_DIRECTORIES}")
125  list(REMOVE_DUPLICATES _inc_env)
126
127  # set paths where to look for
128  set(PATH_TO_LOOK_FOR "${_inc_env}")
129
130  # Try to find the hwloc header in the given paths
131  # -------------------------------------------------
132  # call cmake macro to find the header path
133  if(HWLOC_INCDIR)
134    set(HWLOC_hwloc.h_DIRS "HWLOC_hwloc.h_DIRS-NOTFOUND")
135    find_path(HWLOC_hwloc.h_DIRS
136      NAMES hwloc.h
137      HINTS ${HWLOC_INCDIR})
138  else()
139    if(HWLOC_DIR)
140      set(HWLOC_hwloc.h_DIRS "HWLOC_hwloc.h_DIRS-NOTFOUND")
141      find_path(HWLOC_hwloc.h_DIRS
142	NAMES hwloc.h
143	HINTS ${HWLOC_DIR}
144	PATH_SUFFIXES "include" "include/hwloc")
145    else()
146      set(HWLOC_hwloc.h_DIRS "HWLOC_hwloc.h_DIRS-NOTFOUND")
147      find_path(HWLOC_hwloc.h_DIRS
148	NAMES hwloc.h
149	HINTS ${PATH_TO_LOOK_FOR}
150	PATH_SUFFIXES "hwloc")
151    endif()
152  endif()
153  mark_as_advanced(HWLOC_hwloc.h_DIRS)
154
155  # Add path to cmake variable
156  # ------------------------------------
157  if (HWLOC_hwloc.h_DIRS)
158    set(HWLOC_INCLUDE_DIRS "${HWLOC_hwloc.h_DIRS}")
159  else ()
160    set(HWLOC_INCLUDE_DIRS "HWLOC_INCLUDE_DIRS-NOTFOUND")
161    if(NOT HWLOC_FIND_QUIETLY)
162      message(STATUS "Looking for hwloc -- hwloc.h not found")
163    endif()
164  endif ()
165
166  if (HWLOC_INCLUDE_DIRS)
167    list(REMOVE_DUPLICATES HWLOC_INCLUDE_DIRS)
168  endif ()
169
170
171  # Looking for lib
172  # ---------------
173
174  # Add system library paths to search lib
175  # --------------------------------------
176  unset(_lib_env)
177  if(ENV_HWLOC_LIBDIR)
178    list(APPEND _lib_env "${ENV_HWLOC_LIBDIR}")
179  elseif(ENV_HWLOC_DIR)
180    list(APPEND _lib_env "${ENV_HWLOC_DIR}")
181    list(APPEND _lib_env "${ENV_HWLOC_DIR}/lib")
182  else()
183    if(WIN32)
184      string(REPLACE ":" ";" _lib_env "$ENV{LIB}")
185    else()
186      if(APPLE)
187	string(REPLACE ":" ";" _lib_env "$ENV{DYLD_LIBRARY_PATH}")
188      else()
189	string(REPLACE ":" ";" _lib_env "$ENV{LD_LIBRARY_PATH}")
190      endif()
191      list(APPEND _lib_env "${CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES}")
192      list(APPEND _lib_env "${CMAKE_C_IMPLICIT_LINK_DIRECTORIES}")
193    endif()
194  endif()
195  list(REMOVE_DUPLICATES _lib_env)
196
197  # set paths where to look for
198  set(PATH_TO_LOOK_FOR "${_lib_env}")
199
200  # Try to find the hwloc lib in the given paths
201  # ----------------------------------------------
202
203  # call cmake macro to find the lib path
204  if(HWLOC_LIBDIR)
205    set(HWLOC_hwloc_LIBRARY "HWLOC_hwloc_LIBRARY-NOTFOUND")
206    find_library(HWLOC_hwloc_LIBRARY
207      NAMES hwloc
208      HINTS ${HWLOC_LIBDIR})
209  else()
210    if(HWLOC_DIR)
211      set(HWLOC_hwloc_LIBRARY "HWLOC_hwloc_LIBRARY-NOTFOUND")
212      find_library(HWLOC_hwloc_LIBRARY
213	NAMES hwloc
214	HINTS ${HWLOC_DIR}
215	PATH_SUFFIXES lib lib32 lib64)
216    else()
217      set(HWLOC_hwloc_LIBRARY "HWLOC_hwloc_LIBRARY-NOTFOUND")
218      find_library(HWLOC_hwloc_LIBRARY
219	NAMES hwloc
220	HINTS ${PATH_TO_LOOK_FOR})
221    endif()
222  endif()
223  mark_as_advanced(HWLOC_hwloc_LIBRARY)
224
225  # If found, add path to cmake variable
226  # ------------------------------------
227  if (HWLOC_hwloc_LIBRARY)
228    get_filename_component(hwloc_lib_path ${HWLOC_hwloc_LIBRARY} PATH)
229    # set cmake variables (respects naming convention)
230    set(HWLOC_LIBRARIES    "${HWLOC_hwloc_LIBRARY}")
231    set(HWLOC_LIBRARY_DIRS "${hwloc_lib_path}")
232  else ()
233    set(HWLOC_LIBRARIES    "HWLOC_LIBRARIES-NOTFOUND")
234    set(HWLOC_LIBRARY_DIRS "HWLOC_LIBRARY_DIRS-NOTFOUND")
235    if(NOT HWLOC_FIND_QUIETLY)
236      message(STATUS "Looking for hwloc -- lib hwloc not found")
237    endif()
238  endif ()
239
240  if (HWLOC_LIBRARY_DIRS)
241    list(REMOVE_DUPLICATES HWLOC_LIBRARY_DIRS)
242  endif ()
243
244  # check a function to validate the find
245  if(HWLOC_LIBRARIES)
246
247    set(REQUIRED_INCDIRS)
248    set(REQUIRED_LIBDIRS)
249    set(REQUIRED_LIBS)
250
251    # HWLOC
252    if (HWLOC_INCLUDE_DIRS)
253      set(REQUIRED_INCDIRS "${HWLOC_INCLUDE_DIRS}")
254    endif()
255    if (HWLOC_LIBRARY_DIRS)
256      set(REQUIRED_LIBDIRS "${HWLOC_LIBRARY_DIRS}")
257    endif()
258    set(REQUIRED_LIBS "${HWLOC_LIBRARIES}")
259
260    # set required libraries for link
261    set(CMAKE_REQUIRED_INCLUDES "${REQUIRED_INCDIRS}")
262    set(CMAKE_REQUIRED_LIBRARIES)
263    foreach(lib_dir ${REQUIRED_LIBDIRS})
264      list(APPEND CMAKE_REQUIRED_LIBRARIES "-L${lib_dir}")
265    endforeach()
266    list(APPEND CMAKE_REQUIRED_LIBRARIES "${REQUIRED_LIBS}")
267    string(REGEX REPLACE "^ -" "-" CMAKE_REQUIRED_LIBRARIES "${CMAKE_REQUIRED_LIBRARIES}")
268
269    # test link
270    unset(HWLOC_WORKS CACHE)
271    include(CheckFunctionExists)
272    check_function_exists(hwloc_topology_init HWLOC_WORKS)
273    mark_as_advanced(HWLOC_WORKS)
274
275    if(NOT HWLOC_WORKS)
276      if(NOT HWLOC_FIND_QUIETLY)
277	message(STATUS "Looking for hwloc : test of hwloc_topology_init with hwloc library fails")
278	message(STATUS "CMAKE_REQUIRED_LIBRARIES: ${CMAKE_REQUIRED_LIBRARIES}")
279	message(STATUS "CMAKE_REQUIRED_INCLUDES: ${CMAKE_REQUIRED_INCLUDES}")
280	message(STATUS "Check in CMakeFiles/CMakeError.log to figure out why it fails")
281      endif()
282    endif()
283    set(CMAKE_REQUIRED_INCLUDES)
284    set(CMAKE_REQUIRED_FLAGS)
285    set(CMAKE_REQUIRED_LIBRARIES)
286  endif()
287
288endif()
289
290if (HWLOC_LIBRARIES)
291  if (HWLOC_LIBRARY_DIRS)
292    list(GET HWLOC_LIBRARY_DIRS 0 first_lib_path)
293  else()
294    list(GET HWLOC_LIBRARIES 0 first_lib)
295    get_filename_component(first_lib_path "${first_lib}" PATH)
296  endif()
297  if (${first_lib_path} MATCHES "/lib(32|64)?$")
298    string(REGEX REPLACE "/lib(32|64)?$" "" not_cached_dir "${first_lib_path}")
299    set(HWLOC_DIR_FOUND "${not_cached_dir}" CACHE PATH "Installation directory of HWLOC library" FORCE)
300  else()
301    set(HWLOC_DIR_FOUND "${first_lib_path}" CACHE PATH "Installation directory of HWLOC library" FORCE)
302  endif()
303endif()
304mark_as_advanced(HWLOC_DIR)
305mark_as_advanced(HWLOC_DIR_FOUND)
306
307# check that HWLOC has been found
308# -------------------------------
309include(FindPackageHandleStandardArgs)
310if (PKG_CONFIG_EXECUTABLE AND HWLOC_FOUND)
311  find_package_handle_standard_args(HWLOC DEFAULT_MSG
312    HWLOC_LIBRARIES)
313else()
314  find_package_handle_standard_args(HWLOC DEFAULT_MSG
315    HWLOC_LIBRARIES
316    HWLOC_WORKS)
317endif()
318
319if (HWLOC_FOUND)
320  set(HWLOC_SAVE_CMAKE_REQUIRED_INCLUDES ${CMAKE_REQUIRED_INCLUDES})
321  list(APPEND CMAKE_REQUIRED_INCLUDES ${HWLOC_INCLUDE_DIRS})
322
323  # test headers to guess the version
324  check_struct_has_member( "struct hwloc_obj" parent hwloc.h HAVE_HWLOC_PARENT_MEMBER )
325  check_struct_has_member( "struct hwloc_cache_attr_s" size hwloc.h HAVE_HWLOC_CACHE_ATTR )
326  check_c_source_compiles( "#include <hwloc.h>
327	    int main(void) { hwloc_obj_t o; o->type = HWLOC_OBJ_PU; return 0;}" HAVE_HWLOC_OBJ_PU)
328  include(CheckLibraryExists)
329  check_library_exists(${HWLOC_LIBRARIES} hwloc_bitmap_free "" HAVE_HWLOC_BITMAP)
330
331  set(CMAKE_REQUIRED_INCLUDES ${HWLOC_SAVE_CMAKE_REQUIRED_INCLUDES})
332endif()
333