FindHWLOC.cmake 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  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. # Copyright 2012-2013 Inria
  32. # Copyright 2012-2013 Emmanuel Agullo
  33. # Copyright 2012-2013 Mathieu Faverge
  34. # Copyright 2012 Cedric Castagnede
  35. # Copyright 2013 Florent Pruvost
  36. #
  37. # Distributed under the OSI-approved BSD License (the "License");
  38. # see accompanying file MORSE-Copyright.txt for details.
  39. #
  40. # This software is distributed WITHOUT ANY WARRANTY; without even the
  41. # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  42. # See the License for more information.
  43. #=============================================================================
  44. # (To distribute this file outside of Morse, substitute the full
  45. # License text for the above reference.)
  46. include(CheckStructHasMember)
  47. include(CheckCSourceCompiles)
  48. if (NOT HWLOC_FOUND)
  49. set(HWLOC_DIR "" CACHE PATH "Installation directory of HWLOC library")
  50. if (NOT HWLOC_FIND_QUIETLY)
  51. message(STATUS "A cache variable, namely HWLOC_DIR, has been set to specify the install directory of HWLOC")
  52. endif()
  53. endif()
  54. set(ENV_HWLOC_DIR "$ENV{HWLOC_DIR}")
  55. set(ENV_HWLOC_INCDIR "$ENV{HWLOC_INCDIR}")
  56. set(ENV_HWLOC_LIBDIR "$ENV{HWLOC_LIBDIR}")
  57. set(HWLOC_GIVEN_BY_USER "FALSE")
  58. if ( HWLOC_DIR OR ( HWLOC_INCDIR AND HWLOC_LIBDIR) OR ENV_HWLOC_DIR OR (ENV_HWLOC_INCDIR AND ENV_HWLOC_LIBDIR) )
  59. set(HWLOC_GIVEN_BY_USER "TRUE")
  60. endif()
  61. # Optionally use pkg-config to detect include/library dirs (if pkg-config is available)
  62. # -------------------------------------------------------------------------------------
  63. include(CMakeFindDependencyMacro)
  64. # include(FindPkgConfig)
  65. find_dependency(PkgConfig QUIET)
  66. if( PKG_CONFIG_EXECUTABLE AND NOT HWLOC_GIVEN_BY_USER )
  67. pkg_search_module(HWLOC hwloc)
  68. if (NOT HWLOC_FIND_QUIETLY)
  69. if (HWLOC_FOUND AND HWLOC_LIBRARIES)
  70. message(STATUS "Looking for HWLOC - found using PkgConfig")
  71. #if(NOT HWLOC_INCLUDE_DIRS)
  72. # message("${Magenta}HWLOC_INCLUDE_DIRS is empty using PkgConfig."
  73. # "Perhaps the path to hwloc headers is already present in your"
  74. # "C(PLUS)_INCLUDE_PATH environment variable.${ColourReset}")
  75. #endif()
  76. else()
  77. message(STATUS "${Magenta}Looking for HWLOC - not found using PkgConfig."
  78. "\n Perhaps you should add the directory containing hwloc.pc to"
  79. "\n the PKG_CONFIG_PATH environment variable.${ColourReset}")
  80. endif()
  81. endif()
  82. endif()
  83. if( (NOT PKG_CONFIG_EXECUTABLE) OR (PKG_CONFIG_EXECUTABLE AND NOT HWLOC_FOUND) OR (HWLOC_GIVEN_BY_USER) )
  84. if (NOT HWLOC_FIND_QUIETLY)
  85. message(STATUS "Looking for HWLOC - PkgConfig not used")
  86. endif()
  87. # Looking for include
  88. # -------------------
  89. # Add system include paths to search include
  90. # ------------------------------------------
  91. unset(_inc_env)
  92. if(ENV_HWLOC_INCDIR)
  93. list(APPEND _inc_env "${ENV_HWLOC_INCDIR}")
  94. elseif(ENV_HWLOC_DIR)
  95. list(APPEND _inc_env "${ENV_HWLOC_DIR}")
  96. list(APPEND _inc_env "${ENV_HWLOC_DIR}/include")
  97. list(APPEND _inc_env "${ENV_HWLOC_DIR}/include/hwloc")
  98. else()
  99. if(WIN32)
  100. string(REPLACE ":" ";" _inc_env "$ENV{INCLUDE}")
  101. else()
  102. string(REPLACE ":" ";" _path_env "$ENV{INCLUDE}")
  103. list(APPEND _inc_env "${_path_env}")
  104. string(REPLACE ":" ";" _path_env "$ENV{C_INCLUDE_PATH}")
  105. list(APPEND _inc_env "${_path_env}")
  106. string(REPLACE ":" ";" _path_env "$ENV{CPATH}")
  107. list(APPEND _inc_env "${_path_env}")
  108. string(REPLACE ":" ";" _path_env "$ENV{INCLUDE_PATH}")
  109. list(APPEND _inc_env "${_path_env}")
  110. endif()
  111. endif()
  112. list(APPEND _inc_env "${CMAKE_PLATFORM_IMPLICIT_INCLUDE_DIRECTORIES}")
  113. list(APPEND _inc_env "${CMAKE_C_IMPLICIT_INCLUDE_DIRECTORIES}")
  114. list(REMOVE_DUPLICATES _inc_env)
  115. # set paths where to look for
  116. set(PATH_TO_LOOK_FOR "${_inc_env}")
  117. # Try to find the hwloc header in the given paths
  118. # -------------------------------------------------
  119. # call cmake macro to find the header path
  120. if(HWLOC_INCDIR)
  121. set(HWLOC_hwloc.h_DIRS "HWLOC_hwloc.h_DIRS-NOTFOUND")
  122. find_path(HWLOC_hwloc.h_DIRS
  123. NAMES hwloc.h
  124. HINTS ${HWLOC_INCDIR})
  125. else()
  126. if(HWLOC_DIR)
  127. set(HWLOC_hwloc.h_DIRS "HWLOC_hwloc.h_DIRS-NOTFOUND")
  128. find_path(HWLOC_hwloc.h_DIRS
  129. NAMES hwloc.h
  130. HINTS ${HWLOC_DIR}
  131. PATH_SUFFIXES "include" "include/hwloc")
  132. else()
  133. set(HWLOC_hwloc.h_DIRS "HWLOC_hwloc.h_DIRS-NOTFOUND")
  134. find_path(HWLOC_hwloc.h_DIRS
  135. NAMES hwloc.h
  136. HINTS ${PATH_TO_LOOK_FOR}
  137. PATH_SUFFIXES "hwloc")
  138. endif()
  139. endif()
  140. mark_as_advanced(HWLOC_hwloc.h_DIRS)
  141. # Add path to cmake variable
  142. # ------------------------------------
  143. if (HWLOC_hwloc.h_DIRS)
  144. set(HWLOC_INCLUDE_DIRS "${HWLOC_hwloc.h_DIRS}")
  145. else ()
  146. set(HWLOC_INCLUDE_DIRS "HWLOC_INCLUDE_DIRS-NOTFOUND")
  147. if(NOT HWLOC_FIND_QUIETLY)
  148. message(STATUS "Looking for hwloc -- hwloc.h not found")
  149. endif()
  150. endif ()
  151. if (HWLOC_INCLUDE_DIRS)
  152. list(REMOVE_DUPLICATES HWLOC_INCLUDE_DIRS)
  153. endif ()
  154. # Looking for lib
  155. # ---------------
  156. # Add system library paths to search lib
  157. # --------------------------------------
  158. unset(_lib_env)
  159. if(ENV_HWLOC_LIBDIR)
  160. list(APPEND _lib_env "${ENV_HWLOC_LIBDIR}")
  161. elseif(ENV_HWLOC_DIR)
  162. list(APPEND _lib_env "${ENV_HWLOC_DIR}")
  163. list(APPEND _lib_env "${ENV_HWLOC_DIR}/lib")
  164. else()
  165. if(WIN32)
  166. string(REPLACE ":" ";" _lib_env "$ENV{LIB}")
  167. else()
  168. if(APPLE)
  169. string(REPLACE ":" ";" _lib_env "$ENV{DYLD_LIBRARY_PATH}")
  170. else()
  171. string(REPLACE ":" ";" _lib_env "$ENV{LD_LIBRARY_PATH}")
  172. endif()
  173. list(APPEND _lib_env "${CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES}")
  174. list(APPEND _lib_env "${CMAKE_C_IMPLICIT_LINK_DIRECTORIES}")
  175. endif()
  176. endif()
  177. list(REMOVE_DUPLICATES _lib_env)
  178. # set paths where to look for
  179. set(PATH_TO_LOOK_FOR "${_lib_env}")
  180. # Try to find the hwloc lib in the given paths
  181. # ----------------------------------------------
  182. # call cmake macro to find the lib path
  183. if(HWLOC_LIBDIR)
  184. set(HWLOC_hwloc_LIBRARY "HWLOC_hwloc_LIBRARY-NOTFOUND")
  185. find_library(HWLOC_hwloc_LIBRARY
  186. NAMES hwloc
  187. HINTS ${HWLOC_LIBDIR})
  188. else()
  189. if(HWLOC_DIR)
  190. set(HWLOC_hwloc_LIBRARY "HWLOC_hwloc_LIBRARY-NOTFOUND")
  191. find_library(HWLOC_hwloc_LIBRARY
  192. NAMES hwloc
  193. HINTS ${HWLOC_DIR}
  194. PATH_SUFFIXES lib lib32 lib64)
  195. else()
  196. set(HWLOC_hwloc_LIBRARY "HWLOC_hwloc_LIBRARY-NOTFOUND")
  197. find_library(HWLOC_hwloc_LIBRARY
  198. NAMES hwloc
  199. HINTS ${PATH_TO_LOOK_FOR})
  200. endif()
  201. endif()
  202. mark_as_advanced(HWLOC_hwloc_LIBRARY)
  203. # If found, add path to cmake variable
  204. # ------------------------------------
  205. if (HWLOC_hwloc_LIBRARY)
  206. get_filename_component(hwloc_lib_path ${HWLOC_hwloc_LIBRARY} PATH)
  207. # set cmake variables (respects naming convention)
  208. set(HWLOC_LIBRARIES "${HWLOC_hwloc_LIBRARY}")
  209. set(HWLOC_LIBRARY_DIRS "${hwloc_lib_path}")
  210. else ()
  211. set(HWLOC_LIBRARIES "HWLOC_LIBRARIES-NOTFOUND")
  212. set(HWLOC_LIBRARY_DIRS "HWLOC_LIBRARY_DIRS-NOTFOUND")
  213. if(NOT HWLOC_FIND_QUIETLY)
  214. message(STATUS "Looking for hwloc -- lib hwloc not found")
  215. endif()
  216. endif ()
  217. if (HWLOC_LIBRARY_DIRS)
  218. list(REMOVE_DUPLICATES HWLOC_LIBRARY_DIRS)
  219. endif ()
  220. # check a function to validate the find
  221. if(HWLOC_LIBRARIES)
  222. set(REQUIRED_INCDIRS)
  223. set(REQUIRED_LIBDIRS)
  224. set(REQUIRED_LIBS)
  225. # HWLOC
  226. if (HWLOC_INCLUDE_DIRS)
  227. set(REQUIRED_INCDIRS "${HWLOC_INCLUDE_DIRS}")
  228. endif()
  229. if (HWLOC_LIBRARY_DIRS)
  230. set(REQUIRED_LIBDIRS "${HWLOC_LIBRARY_DIRS}")
  231. endif()
  232. set(REQUIRED_LIBS "${HWLOC_LIBRARIES}")
  233. # set required libraries for link
  234. set(CMAKE_REQUIRED_INCLUDES "${REQUIRED_INCDIRS}")
  235. set(CMAKE_REQUIRED_LIBRARIES)
  236. foreach(lib_dir ${REQUIRED_LIBDIRS})
  237. list(APPEND CMAKE_REQUIRED_LIBRARIES "-L${lib_dir}")
  238. endforeach()
  239. list(APPEND CMAKE_REQUIRED_LIBRARIES "${REQUIRED_LIBS}")
  240. string(REGEX REPLACE "^ -" "-" CMAKE_REQUIRED_LIBRARIES "${CMAKE_REQUIRED_LIBRARIES}")
  241. # test link
  242. unset(HWLOC_WORKS CACHE)
  243. include(CheckFunctionExists)
  244. check_function_exists(hwloc_topology_init HWLOC_WORKS)
  245. mark_as_advanced(HWLOC_WORKS)
  246. if(NOT HWLOC_WORKS)
  247. if(NOT HWLOC_FIND_QUIETLY)
  248. message(STATUS "Looking for hwloc : test of hwloc_topology_init with hwloc library fails")
  249. message(STATUS "CMAKE_REQUIRED_LIBRARIES: ${CMAKE_REQUIRED_LIBRARIES}")
  250. message(STATUS "CMAKE_REQUIRED_INCLUDES: ${CMAKE_REQUIRED_INCLUDES}")
  251. message(STATUS "Check in CMakeFiles/CMakeError.log to figure out why it fails")
  252. endif()
  253. endif()
  254. set(CMAKE_REQUIRED_INCLUDES)
  255. set(CMAKE_REQUIRED_FLAGS)
  256. set(CMAKE_REQUIRED_LIBRARIES)
  257. endif()
  258. endif()
  259. if (HWLOC_LIBRARIES)
  260. if (HWLOC_LIBRARY_DIRS)
  261. list(GET HWLOC_LIBRARY_DIRS 0 first_lib_path)
  262. else()
  263. list(GET HWLOC_LIBRARIES 0 first_lib)
  264. get_filename_component(first_lib_path "${first_lib}" PATH)
  265. endif()
  266. if (${first_lib_path} MATCHES "/lib(32|64)?$")
  267. string(REGEX REPLACE "/lib(32|64)?$" "" not_cached_dir "${first_lib_path}")
  268. set(HWLOC_DIR_FOUND "${not_cached_dir}" CACHE PATH "Installation directory of HWLOC library" FORCE)
  269. else()
  270. set(HWLOC_DIR_FOUND "${first_lib_path}" CACHE PATH "Installation directory of HWLOC library" FORCE)
  271. endif()
  272. endif()
  273. mark_as_advanced(HWLOC_DIR)
  274. mark_as_advanced(HWLOC_DIR_FOUND)
  275. # check that HWLOC has been found
  276. # -------------------------------
  277. include(FindPackageHandleStandardArgs)
  278. if (PKG_CONFIG_EXECUTABLE AND HWLOC_FOUND)
  279. find_package_handle_standard_args(HWLOC DEFAULT_MSG
  280. HWLOC_LIBRARIES)
  281. else()
  282. find_package_handle_standard_args(HWLOC DEFAULT_MSG
  283. HWLOC_LIBRARIES
  284. HWLOC_WORKS)
  285. endif()
  286. if (HWLOC_FOUND)
  287. set(HWLOC_SAVE_CMAKE_REQUIRED_INCLUDES ${CMAKE_REQUIRED_INCLUDES})
  288. list(APPEND CMAKE_REQUIRED_INCLUDES ${HWLOC_INCLUDE_DIRS})
  289. # test headers to guess the version
  290. check_struct_has_member( "struct hwloc_obj" parent hwloc.h HAVE_HWLOC_PARENT_MEMBER )
  291. check_struct_has_member( "struct hwloc_cache_attr_s" size hwloc.h HAVE_HWLOC_CACHE_ATTR )
  292. check_c_source_compiles( "#include <hwloc.h>
  293. int main(void) { hwloc_obj_t o; o->type = HWLOC_OBJ_PU; return 0;}" HAVE_HWLOC_OBJ_PU)
  294. include(CheckLibraryExists)
  295. check_library_exists(${HWLOC_LIBRARIES} hwloc_bitmap_free "" HAVE_HWLOC_BITMAP)
  296. set(CMAKE_REQUIRED_INCLUDES ${HWLOC_SAVE_CMAKE_REQUIRED_INCLUDES})
  297. endif()