FindBacktrace.cmake 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. # Distributed under the OSI-approved BSD 3-Clause License. See accompanying
  2. # file Copyright.txt or https://cmake.org/licensing for details.
  3. #.rst:
  4. # FindBacktrace
  5. # -------------
  6. #
  7. # Find provider for backtrace(3).
  8. #
  9. # Checks if OS supports backtrace(3) via either libc or custom library.
  10. # This module defines the following variables:
  11. #
  12. # ``Backtrace_HEADER``
  13. # The header file needed for backtrace(3). Cached.
  14. # Could be forcibly set by user.
  15. # ``Backtrace_INCLUDE_DIRS``
  16. # The include directories needed to use backtrace(3) header.
  17. # ``Backtrace_LIBRARIES``
  18. # The libraries (linker flags) needed to use backtrace(3), if any.
  19. # ``Backtrace_FOUND``
  20. # Is set if and only if backtrace(3) support detected.
  21. #
  22. # The following cache variables are also available to set or use:
  23. #
  24. # ``Backtrace_LIBRARY``
  25. # The external library providing backtrace, if any.
  26. # ``Backtrace_INCLUDE_DIR``
  27. # The directory holding the backtrace(3) header.
  28. #
  29. # Typical usage is to generate of header file using configure_file() with the
  30. # contents like the following::
  31. #
  32. # #cmakedefine01 Backtrace_FOUND
  33. # #if Backtrace_FOUND
  34. # # include <${Backtrace_HEADER}>
  35. # #endif
  36. #
  37. # And then reference that generated header file in actual source.
  38. include(CMakePushCheckState)
  39. include(CheckSymbolExists)
  40. include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
  41. # List of variables to be provided to find_package_handle_standard_args()
  42. set(_Backtrace_STD_ARGS Backtrace_INCLUDE_DIR)
  43. if(Backtrace_HEADER)
  44. set(_Backtrace_HEADER_TRY "${Backtrace_HEADER}")
  45. else(Backtrace_HEADER)
  46. set(_Backtrace_HEADER_TRY "execinfo.h")
  47. endif(Backtrace_HEADER)
  48. find_path(Backtrace_INCLUDE_DIR "${_Backtrace_HEADER_TRY}")
  49. set(Backtrace_INCLUDE_DIRS ${Backtrace_INCLUDE_DIR})
  50. if (NOT DEFINED Backtrace_LIBRARY)
  51. # First, check if we already have backtrace(), e.g., in libc
  52. cmake_push_check_state(RESET)
  53. set(CMAKE_REQUIRED_INCLUDES ${Backtrace_INCLUDE_DIRS})
  54. set(CMAKE_REQUIRED_QUIET ${Backtrace_FIND_QUIETLY})
  55. check_symbol_exists("backtrace" "${_Backtrace_HEADER_TRY}" _Backtrace_SYM_FOUND)
  56. cmake_pop_check_state()
  57. endif()
  58. if(_Backtrace_SYM_FOUND)
  59. # Avoid repeating the message() call below each time CMake is run.
  60. if(NOT Backtrace_FIND_QUIETLY AND NOT DEFINED Backtrace_LIBRARY)
  61. message(STATUS "backtrace facility detected in default set of libraries")
  62. endif()
  63. set(Backtrace_LIBRARY "" CACHE FILEPATH "Library providing backtrace(3), empty for default set of libraries")
  64. else()
  65. # Check for external library, for non-glibc systems
  66. if(Backtrace_INCLUDE_DIR)
  67. # OpenBSD has libbacktrace renamed to libexecinfo
  68. find_library(Backtrace_LIBRARY "execinfo")
  69. elseif() # respect user wishes
  70. set(_Backtrace_HEADER_TRY "backtrace.h")
  71. find_path(Backtrace_INCLUDE_DIR ${_Backtrace_HEADER_TRY})
  72. find_library(Backtrace_LIBRARY "backtrace")
  73. endif()
  74. # Prepend list with library path as it's more common practice
  75. set(_Backtrace_STD_ARGS Backtrace_LIBRARY ${_Backtrace_STD_ARGS})
  76. endif()
  77. set(Backtrace_LIBRARIES ${Backtrace_LIBRARY})
  78. set(Backtrace_HEADER "${_Backtrace_HEADER_TRY}" CACHE STRING "Header providing backtrace(3) facility")
  79. find_package_handle_standard_args(Backtrace FOUND_VAR Backtrace_FOUND REQUIRED_VARS ${_Backtrace_STD_ARGS})
  80. mark_as_advanced(Backtrace_HEADER Backtrace_INCLUDE_DIR Backtrace_LIBRARY)