2020-08-24 17:01:05 +08:00
if ( NOT IS_DIRECTORY "${CMAKE_CURRENT_LIST_DIR}/../libcxx" )
message ( FATAL_ERROR "libunwind requires being built in a monorepo layout with libcxx available" )
endif ( )
2015-04-25 09:46:35 +08:00
#===============================================================================
2015-08-07 07:31:37 +08:00
# Setup Project
2015-04-25 09:46:35 +08:00
#===============================================================================
2020-04-22 23:15:05 +08:00
cmake_minimum_required ( VERSION 3.13.4 )
2015-04-25 09:46:35 +08:00
2022-01-01 15:03:31 +08:00
set ( LLVM_COMMON_CMAKE_UTILS "${CMAKE_CURRENT_SOURCE_DIR}/../cmake" )
2017-04-12 10:28:07 +08:00
# Add path for custom modules
2022-01-01 15:03:31 +08:00
list ( INSERT CMAKE_MODULE_PATH 0
2017-04-12 10:28:07 +08:00
" $ { C M A K E _ C U R R E N T _ S O U R C E _ D I R } / c m a k e "
" $ { C M A K E _ C U R R E N T _ S O U R C E _ D I R } / c m a k e / M o d u l e s "
2022-01-01 15:03:31 +08:00
" $ { L L V M _ C O M M O N _ C M A K E _ U T I L S } "
" $ { L L V M _ C O M M O N _ C M A K E _ U T I L S } / M o d u l e s "
2017-04-12 10:28:07 +08:00
)
2020-08-24 17:01:05 +08:00
set ( LIBUNWIND_SOURCE_DIR ${ CMAKE_CURRENT_SOURCE_DIR } )
set ( LIBUNWIND_BINARY_DIR ${ CMAKE_CURRENT_BINARY_DIR } )
set ( LIBUNWIND_LIBCXX_PATH "${CMAKE_CURRENT_LIST_DIR}/../libcxx" CACHE PATH
" S p e c i f y p a t h t o l i b c + + s o u r c e . " )
2019-05-30 15:34:39 +08:00
if ( CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR OR LIBUNWIND_STANDALONE_BUILD )
2022-02-09 00:38:29 +08:00
message ( FATAL_ERROR "The Standalone build has been deprecated since LLVM 14, and it is not supported anymore. "
" P l e a s e u s e o n e o f t h e w a y s d e s c r i b e d a t h t t p s : / / l i b c x x . l l v m . o r g / B u i l d i n g L i b c x x . h t m l f o r "
" b u i l d i n g l i b u n w i n d . " )
2021-09-11 03:14:48 +08:00
# We may have an incomplete toolchain - do language support tests without
# linking.
include ( EnableLanguageNolink )
project ( libunwind LANGUAGES NONE )
2015-04-25 09:46:35 +08:00
set ( PACKAGE_NAME libunwind )
2022-02-02 15:29:29 +08:00
set ( PACKAGE_VERSION 15.0.0git )
2015-04-25 09:46:35 +08:00
set ( PACKAGE_STRING "${PACKAGE_NAME} ${PACKAGE_VERSION}" )
2015-08-05 12:01:47 +08:00
set ( PACKAGE_BUGREPORT "llvm-bugs@lists.llvm.org" )
2015-04-25 09:46:35 +08:00
2022-01-19 14:45:07 +08:00
set ( LIBUNWIND_STANDALONE_BUILD TRUE )
endif ( )
# Must go below project(..)
include ( GNUInstallDirs )
if ( LIBUNWIND_STANDALONE_BUILD )
llvm_enable_language_nolink ( C CXX ASM )
# Find the LLVM sources and simulate LLVM CMake options.
include ( HandleOutOfTreeLLVM )
2020-08-24 17:01:05 +08:00
# In a standalone build, we don't have llvm to automatically generate the
# llvm-lit script for us. So we need to provide an explicit directory that
# the configurator should write the script into.
set ( LLVM_LIT_OUTPUT_DIR "${LIBUNWIND_BINARY_DIR}/bin" )
2015-04-25 09:46:35 +08:00
else ( )
set ( LLVM_LIT "${CMAKE_SOURCE_DIR}/utils/lit/lit.py" )
endif ( )
#===============================================================================
# Setup CMake Options
#===============================================================================
2018-07-25 07:42:51 +08:00
include ( CMakeDependentOption )
2017-04-12 10:28:07 +08:00
include ( HandleCompilerRT )
2015-04-25 09:46:35 +08:00
# Define options.
2021-11-24 05:34:09 +08:00
option ( LIBUNWIND_BUILD_32_BITS "Build 32 bit multilib libunwind. This option is not supported anymore when building the runtimes. Please specify a full triple instead." ${ LLVM_BUILD_32_BITS } )
if ( LIBUNWIND_BUILD_32_BITS )
2021-12-02 01:57:30 +08:00
message ( FATAL_ERROR "LIBUNWIND_BUILD_32_BITS is not supported anymore when building the runtimes, please specify a full triple instead." )
2021-11-24 05:34:09 +08:00
endif ( )
[libunwind] Support stack unwind in CET environment
Control-flow Enforcement Technology (CET), published by Intel,
introduces shadow stack feature aiming to ensure a return from
a function is directed to where the function was called.
In a CET enabled system, each function call will push return
address into normal stack and shadow stack, when the function
returns, the address stored in shadow stack will be popped and
compared with the return address, program will fail if the 2
addresses don't match.
In exception handling, the control flow may skip some stack frames
and we must adjust shadow stack to avoid violating CET restriction.
In order to achieve this, we count the number of stack frames skipped
and adjust shadow stack by this number before jumping to landing pad.
Reviewed By: hjl.tools, compnerd, MaskRay
Differential Revision: https://reviews.llvm.org/D105968
Signed-off-by: gejin <ge.jin@intel.com>
2021-08-26 16:20:38 +08:00
option ( LIBUNWIND_ENABLE_CET "Build libunwind with CET enabled." OFF )
2015-04-25 09:46:35 +08:00
option ( LIBUNWIND_ENABLE_ASSERTIONS "Enable assertions independent of build mode." ON )
option ( LIBUNWIND_ENABLE_PEDANTIC "Compile with pedantic enabled." ON )
option ( LIBUNWIND_ENABLE_WERROR "Fail and stop if a warning is triggered." OFF )
option ( LIBUNWIND_ENABLE_SHARED "Build libunwind as a shared library." ON )
2016-08-09 06:55:48 +08:00
option ( LIBUNWIND_ENABLE_STATIC "Build libunwind as a static library." ON )
2016-05-27 16:29:27 +08:00
option ( LIBUNWIND_ENABLE_CROSS_UNWINDING "Enable cross-platform unwinding support." OFF )
2016-07-07 18:55:39 +08:00
option ( LIBUNWIND_ENABLE_ARM_WMMX "Enable unwinding support for ARM WMMX registers." OFF )
2016-09-28 18:57:15 +08:00
option ( LIBUNWIND_ENABLE_THREADS "Build libunwind with threading support." ON )
2019-05-14 02:45:03 +08:00
option ( LIBUNWIND_WEAK_PTHREAD_LIB "Use weak references to refer to pthread functions." OFF )
2017-04-12 10:28:07 +08:00
option ( LIBUNWIND_USE_COMPILER_RT "Use compiler-rt instead of libgcc" OFF )
2017-03-28 23:21:43 +08:00
option ( LIBUNWIND_INCLUDE_DOCS "Build the libunwind documentation." ${ LLVM_INCLUDE_DOCS } )
2021-02-13 18:49:47 +08:00
option ( LIBUNWIND_INCLUDE_TESTS "Build the libunwind tests." ${ LLVM_INCLUDE_TESTS } )
2020-07-29 18:39:41 +08:00
option ( LIBUNWIND_IS_BAREMETAL "Build libunwind for baremetal targets." OFF )
2020-08-19 03:05:07 +08:00
option ( LIBUNWIND_USE_FRAME_HEADER_CACHE "Cache frame headers for unwinding. Requires locking dl_iterate_phdr." OFF )
2020-11-11 17:58:41 +08:00
option ( LIBUNWIND_REMEMBER_HEAP_ALLOC "Use heap instead of the stack for .cfi_remember_state." OFF )
2021-12-17 02:32:12 +08:00
option ( LIBUNWIND_INSTALL_HEADERS "Install the libunwind headers." OFF )
2015-04-25 09:46:35 +08:00
2017-08-08 08:37:59 +08:00
set ( LIBUNWIND_LIBDIR_SUFFIX "${LLVM_LIBDIR_SUFFIX}" CACHE STRING
" D e f i n e s u f f i x o f l i b r a r y d i r e c t o r y name ( 32/64 ) " )
2017-11-18 07:29:46 +08:00
option ( LIBUNWIND_INSTALL_LIBRARY "Install the libunwind library." ON )
2018-07-25 07:27:51 +08:00
cmake_dependent_option ( LIBUNWIND_INSTALL_STATIC_LIBRARY
" I n s t a l l t h e s t a t i c l i b u n w i n d l i b r a r y . " O N
" L I B U N W I N D _ E N A B L E _ S T A T I C ; L I B U N W I N D _ I N S T A L L _ L I B R A R Y " O F F )
cmake_dependent_option ( LIBUNWIND_INSTALL_SHARED_LIBRARY
" I n s t a l l t h e s h a r e d l i b u n w i n d l i b r a r y . " O N
" L I B U N W I N D _ E N A B L E _ S H A R E D ; L I B U N W I N D _ I N S T A L L _ L I B R A R Y " O F F )
2018-02-28 02:40:04 +08:00
set ( LIBUNWIND_TEST_LINKER_FLAGS "" CACHE STRING
" A d d i t i o n a l l i n k e r f l a g s f o r t e s t p r o g r a m s . " )
set ( LIBUNWIND_TEST_COMPILER_FLAGS "" CACHE STRING
" A d d i t i o n a l c o m p i l e r f l a g s f o r t e s t p r o g r a m s . " )
2021-10-13 02:10:02 +08:00
2021-10-13 03:59:08 +08:00
# TODO: Remove this after branching for LLVM 15
if ( LIBUNWIND_SYSROOT OR LIBUNWIND_TARGET_TRIPLE OR LIBUNWIND_GCC_TOOLCHAIN )
message ( WARNING "LIBUNWIND_SYSROOT, LIBUNWIND_TARGET_TRIPLE and LIBUNWIND_GCC_TOOLCHAIN are not supported anymore, please use the native CMake equivalents instead" )
endif ( )
2021-10-13 02:10:02 +08:00
if ( LIBUNWIND_ENABLE_SHARED )
set ( LIBUNWIND_DEFAULT_TEST_CONFIG "llvm-libunwind-shared.cfg.in" )
else ( )
set ( LIBUNWIND_DEFAULT_TEST_CONFIG "llvm-libunwind-static.cfg.in" )
endif ( )
set ( LIBUNWIND_TEST_CONFIG "${LIBUNWIND_DEFAULT_TEST_CONFIG}" CACHE STRING
2021-09-30 03:26:05 +08:00
" T h e p a t h t o t h e L i t t e s t i n g c o n f i g u r a t i o n t o u s e w h e n r u n n i n g t h e t e s t s .
2021-10-13 00:46:21 +08:00
I f a r e l a t i v e p a t h i s p r o v i d e d , i t i s a s s u m e d t o b e r e l a t i v e t o ' < m o n o r e p o > / l i b u n w i n d / t e s t / c o n f i g s ' . " )
2021-09-30 03:26:05 +08:00
if ( NOT IS_ABSOLUTE "${LIBUNWIND_TEST_CONFIG}" )
2021-10-13 00:46:21 +08:00
set ( LIBUNWIND_TEST_CONFIG "${CMAKE_CURRENT_SOURCE_DIR}/test/configs/${LIBUNWIND_TEST_CONFIG}" )
2021-09-30 03:26:05 +08:00
endif ( )
2020-08-24 17:01:05 +08:00
set ( LIBUNWIND_TEST_PARAMS "" CACHE STRING
" A l i s t o f p a r a m e t e r s t o r u n t h e L i t t e s t s u i t e w i t h . " )
2015-04-25 09:46:35 +08:00
2016-08-09 06:55:48 +08:00
if ( NOT LIBUNWIND_ENABLE_SHARED AND NOT LIBUNWIND_ENABLE_STATIC )
message ( FATAL_ERROR "libunwind must be built as either a shared or static library." )
endif ( )
[libunwind] Support stack unwind in CET environment
Control-flow Enforcement Technology (CET), published by Intel,
introduces shadow stack feature aiming to ensure a return from
a function is directed to where the function was called.
In a CET enabled system, each function call will push return
address into normal stack and shadow stack, when the function
returns, the address stored in shadow stack will be popped and
compared with the return address, program will fail if the 2
addresses don't match.
In exception handling, the control flow may skip some stack frames
and we must adjust shadow stack to avoid violating CET restriction.
In order to achieve this, we count the number of stack frames skipped
and adjust shadow stack by this number before jumping to landing pad.
Reviewed By: hjl.tools, compnerd, MaskRay
Differential Revision: https://reviews.llvm.org/D105968
Signed-off-by: gejin <ge.jin@intel.com>
2021-08-26 16:20:38 +08:00
if ( LIBUNWIND_ENABLE_CET AND MSVC )
message ( FATAL_ERROR "libunwind CET support is not available for MSVC!" )
endif ( )
[libunwind] unw_* alias fixes for ELF and Mach-O
Rename the CMake option, LIBUNWIND_HERMETIC_STATIC_LIBRARY, to
LIBUNWIND_HIDE_SYMBOLS. Rename the C macro define,
_LIBUNWIND_DISABLE_VISIBILITY_ANNOTATIONS, to _LIBUNWIND_HIDE_SYMBOLS,
because now the macro adds a .hidden directive rather than merely
suppress visibility annotations.
For ELF, when LIBUNWIND_HIDE_SYMBOLS is enabled, mark unw_getcontext as
hidden. This symbol is the only one defined using src/assembly.h's
WEAK_ALIAS macro. Other unw_* weak aliases are defined in C++ and are
already hidden.
Mach-O doesn't support weak aliases, so remove .weak_reference and
weak_import. When LIBUNWIND_HIDE_SYMBOLS is enabled, output
.private_extern for the unw_* aliases.
In assembly.h, add missing SYMBOL_NAME macro invocations, which are
used to prefix symbol names with '_' on some targets.
Fixes PR46709.
Reviewed By: #libunwind, phosek, compnerd, steven_wu
Differential Revision: https://reviews.llvm.org/D93003
2021-02-23 08:35:38 +08:00
option ( LIBUNWIND_HIDE_SYMBOLS
2019-01-30 07:01:08 +08:00
" D o n o t e x p o r t a n y s y m b o l s f r o m t h e s t a t i c l i b r a r y . " O F F )
2015-04-25 09:46:35 +08:00
#===============================================================================
# Configure System
#===============================================================================
# Add path for custom modules
set ( CMAKE_MODULE_PATH
" $ { C M A K E _ C U R R E N T _ S O U R C E _ D I R } / c m a k e "
$ { C M A K E _ M O D U L E _ P A T H } )
2022-01-16 14:00:29 +08:00
set ( LIBUNWIND_INSTALL_INCLUDE_DIR "${CMAKE_INSTALL_INCLUDEDIR}" CACHE PATH
2022-01-11 11:03:21 +08:00
" P a t h w h e r e b u i l t l i b u n w i n d h e a d e r s s h o u l d b e i n s t a l l e d . " )
2022-01-16 14:00:29 +08:00
set ( LIBUNWIND_INSTALL_RUNTIME_DIR "${CMAKE_INSTALL_BINDIR}" CACHE PATH
2022-01-11 11:03:21 +08:00
" P a t h w h e r e b u i l t l i b u n w i n d r u n t i m e l i b r a r i e s s h o u l d b e i n s t a l l e d . " )
2018-06-30 04:27:40 +08:00
if ( LLVM_ENABLE_PER_TARGET_RUNTIME_DIR AND NOT APPLE )
2021-04-17 12:33:18 +08:00
set ( LIBUNWIND_LIBRARY_DIR ${ LLVM_LIBRARY_OUTPUT_INTDIR } / ${ LLVM_DEFAULT_TARGET_TRIPLE } )
Prepare Compiler-RT for GnuInstallDirs, matching libcxx, document all
This is a second attempt at D101497, which landed as
9a9bc76c0eb72f0f2732c729a460abbd5239c2e3 but had to be reverted in
8cf7ddbdd4e5af966a369e170c73250f2e3920e7.
This issue was that in the case that `COMPILER_RT_INSTALL_PATH` is
empty, expressions like "${COMPILER_RT_INSTALL_PATH}/bin" evaluated to
"/bin" not "bin" as intended and as was originally.
One solution is to make `COMPILER_RT_INSTALL_PATH` always non-empty,
defaulting it to `CMAKE_INSTALL_PREFIX`. D99636 adopted that approach.
But, I think it is more ergonomic to allow those project-specific paths
to be relative the global ones. Also, making install paths absolute by
default inhibits the proper behavior of functions like
`GNUInstallDirs_get_absolute_install_dir` which make relative install
paths absolute in a more complicated way.
Given all this, I will define a function like the one asked for in
https://gitlab.kitware.com/cmake/cmake/-/issues/19568 (and needed for a
similar use-case).
---
Original message:
Instead of using `COMPILER_RT_INSTALL_PATH` through the CMake for
complier-rt, just use it to define variables for the subdirs which
themselves are used.
This preserves compatibility, but later on we might consider getting rid
of `COMPILER_RT_INSTALL_PATH` and just changing the defaults for the
subdir variables directly.
---
There was a seaming bug where the (non-Apple) per-target libdir was
`${target}` not `lib/${target}`. I suspect that has to do with the docs
on `COMPILER_RT_INSTALL_PATH` saying was the library dir when that's no
longer true, so I just went ahead and fixed it, allowing me to define
fewer and more sensible variables.
That last part should be the only behavior changes; everything else
should be a pure refactoring.
---
I added some documentation of these variables too. In particular, I
wanted to highlight the gotcha where `-DSomeCachePath=...` without the
`:PATH` will lead CMake to make the path absolute. See [1] for
discussion of the problem, and [2] for the brief official documentation
they added as a result.
[1]: https://cmake.org/pipermail/cmake/2015-March/060204.html
[2]: https://cmake.org/cmake/help/latest/manual/cmake.1.html#options
In 38b2dec37ee735d5409148e71ecba278caf0f969 the problem was somewhat
misidentified and so `:STRING` was used, but `:PATH` is better as it
sets the correct type from the get-go.
---
D99484 is the main thrust of the `GnuInstallDirs` work. Once this lands,
it should be feasible to follow both of these up with a simple patch for
compiler-rt analogous to the one for libcxx.
Reviewed By: phosek, #libc_abi, #libunwind
Differential Revision: https://reviews.llvm.org/D105765
2021-04-29 06:36:47 +08:00
set ( LIBUNWIND_INSTALL_LIBRARY_DIR lib ${ LLVM_LIBDIR_SUFFIX } / ${ LLVM_DEFAULT_TARGET_TRIPLE } CACHE PATH
" P a t h w h e r e b u i l t l i b u n w i n d l i b r a r i e s s h o u l d b e i n s t a l l e d . " )
2019-05-23 05:08:33 +08:00
if ( LIBCXX_LIBDIR_SUBDIR )
string ( APPEND LIBUNWIND_LIBRARY_DIR / ${ LIBUNWIND_LIBDIR_SUBDIR } )
string ( APPEND LIBUNWIND_INSTALL_LIBRARY_DIR / ${ LIBUNWIND_LIBDIR_SUBDIR } )
endif ( )
2017-07-19 05:30:18 +08:00
else ( )
2022-01-09 08:08:15 +08:00
if ( LLVM_LIBRARY_OUTPUT_INTDIR )
set ( LIBUNWIND_LIBRARY_DIR ${ LLVM_LIBRARY_OUTPUT_INTDIR } )
else ( )
set ( LIBUNWIND_LIBRARY_DIR ${ CMAKE_BINARY_DIR } /lib ${ LIBUNWIND_LIBDIR_SUFFIX } )
endif ( )
Prepare Compiler-RT for GnuInstallDirs, matching libcxx, document all
This is a second attempt at D101497, which landed as
9a9bc76c0eb72f0f2732c729a460abbd5239c2e3 but had to be reverted in
8cf7ddbdd4e5af966a369e170c73250f2e3920e7.
This issue was that in the case that `COMPILER_RT_INSTALL_PATH` is
empty, expressions like "${COMPILER_RT_INSTALL_PATH}/bin" evaluated to
"/bin" not "bin" as intended and as was originally.
One solution is to make `COMPILER_RT_INSTALL_PATH` always non-empty,
defaulting it to `CMAKE_INSTALL_PREFIX`. D99636 adopted that approach.
But, I think it is more ergonomic to allow those project-specific paths
to be relative the global ones. Also, making install paths absolute by
default inhibits the proper behavior of functions like
`GNUInstallDirs_get_absolute_install_dir` which make relative install
paths absolute in a more complicated way.
Given all this, I will define a function like the one asked for in
https://gitlab.kitware.com/cmake/cmake/-/issues/19568 (and needed for a
similar use-case).
---
Original message:
Instead of using `COMPILER_RT_INSTALL_PATH` through the CMake for
complier-rt, just use it to define variables for the subdirs which
themselves are used.
This preserves compatibility, but later on we might consider getting rid
of `COMPILER_RT_INSTALL_PATH` and just changing the defaults for the
subdir variables directly.
---
There was a seaming bug where the (non-Apple) per-target libdir was
`${target}` not `lib/${target}`. I suspect that has to do with the docs
on `COMPILER_RT_INSTALL_PATH` saying was the library dir when that's no
longer true, so I just went ahead and fixed it, allowing me to define
fewer and more sensible variables.
That last part should be the only behavior changes; everything else
should be a pure refactoring.
---
I added some documentation of these variables too. In particular, I
wanted to highlight the gotcha where `-DSomeCachePath=...` without the
`:PATH` will lead CMake to make the path absolute. See [1] for
discussion of the problem, and [2] for the brief official documentation
they added as a result.
[1]: https://cmake.org/pipermail/cmake/2015-March/060204.html
[2]: https://cmake.org/cmake/help/latest/manual/cmake.1.html#options
In 38b2dec37ee735d5409148e71ecba278caf0f969 the problem was somewhat
misidentified and so `:STRING` was used, but `:PATH` is better as it
sets the correct type from the get-go.
---
D99484 is the main thrust of the `GnuInstallDirs` work. Once this lands,
it should be feasible to follow both of these up with a simple patch for
compiler-rt analogous to the one for libcxx.
Reviewed By: phosek, #libc_abi, #libunwind
Differential Revision: https://reviews.llvm.org/D105765
2021-04-29 06:36:47 +08:00
set ( LIBUNWIND_INSTALL_LIBRARY_DIR lib ${ LIBUNWIND_LIBDIR_SUFFIX } CACHE PATH
" P a t h w h e r e b u i l t l i b u n w i n d l i b r a r i e s s h o u l d b e i n s t a l l e d . " )
2017-07-19 05:30:18 +08:00
endif ( )
set ( CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${ LIBUNWIND_LIBRARY_DIR } )
set ( CMAKE_LIBRARY_OUTPUT_DIRECTORY ${ LIBUNWIND_LIBRARY_DIR } )
set ( CMAKE_RUNTIME_OUTPUT_DIRECTORY ${ LIBUNWIND_LIBRARY_DIR } )
2015-04-25 09:46:35 +08:00
2016-06-02 09:02:10 +08:00
set ( LIBUNWIND_C_FLAGS "" )
set ( LIBUNWIND_CXX_FLAGS "" )
set ( LIBUNWIND_COMPILE_FLAGS "" )
set ( LIBUNWIND_LINK_FLAGS "" )
2015-04-25 09:46:35 +08:00
2019-10-12 06:22:29 +08:00
# Include macros for adding and removing libunwind flags.
include ( HandleLibunwindFlags )
#===============================================================================
# Setup Compiler Flags
#===============================================================================
2016-06-02 09:02:10 +08:00
# Configure compiler.
include ( config-ix )
2018-09-05 04:57:50 +08:00
if ( LIBUNWIND_USE_COMPILER_RT AND NOT LIBUNWIND_HAS_NODEFAULTLIBS_FLAG )
2017-04-12 10:28:07 +08:00
list ( APPEND LIBUNWIND_LINK_FLAGS "-rtlib=compiler-rt" )
endif ( )
2019-10-12 06:22:29 +08:00
add_compile_flags_if_supported ( -Werror=return-type )
2015-04-25 09:46:35 +08:00
[libunwind] Support stack unwind in CET environment
Control-flow Enforcement Technology (CET), published by Intel,
introduces shadow stack feature aiming to ensure a return from
a function is directed to where the function was called.
In a CET enabled system, each function call will push return
address into normal stack and shadow stack, when the function
returns, the address stored in shadow stack will be popped and
compared with the return address, program will fail if the 2
addresses don't match.
In exception handling, the control flow may skip some stack frames
and we must adjust shadow stack to avoid violating CET restriction.
In order to achieve this, we count the number of stack frames skipped
and adjust shadow stack by this number before jumping to landing pad.
Reviewed By: hjl.tools, compnerd, MaskRay
Differential Revision: https://reviews.llvm.org/D105968
Signed-off-by: gejin <ge.jin@intel.com>
2021-08-26 16:20:38 +08:00
if ( LIBUNWIND_ENABLE_CET )
add_compile_flags_if_supported ( -fcf-protection=full )
add_compile_flags_if_supported ( -mshstk )
if ( NOT LIBUNWIND_SUPPORTS_FCF_PROTECTION_EQ_FULL_FLAG )
message ( SEND_ERROR "Compiler doesn't support CET -fcf-protection option!" )
endif ( )
if ( NOT LIBUNWIND_SUPPORTS_MSHSTK_FLAG )
message ( SEND_ERROR "Compiler doesn't support CET -mshstk option!" )
endif ( )
endif ( )
2015-04-25 09:46:35 +08:00
# Get warning flags
2019-10-12 06:22:29 +08:00
add_compile_flags_if_supported ( -W )
add_compile_flags_if_supported ( -Wall )
add_compile_flags_if_supported ( -Wchar-subscripts )
add_compile_flags_if_supported ( -Wconversion )
add_compile_flags_if_supported ( -Wmismatched-tags )
add_compile_flags_if_supported ( -Wmissing-braces )
add_compile_flags_if_supported ( -Wnewline-eof )
add_compile_flags_if_supported ( -Wno-unused-function )
add_compile_flags_if_supported ( -Wshadow )
add_compile_flags_if_supported ( -Wshorten-64-to-32 )
add_compile_flags_if_supported ( -Wsign-compare )
add_compile_flags_if_supported ( -Wsign-conversion )
add_compile_flags_if_supported ( -Wstrict-aliasing=2 )
add_compile_flags_if_supported ( -Wstrict-overflow=4 )
add_compile_flags_if_supported ( -Wunused-parameter )
add_compile_flags_if_supported ( -Wunused-variable )
add_compile_flags_if_supported ( -Wwrite-strings )
add_compile_flags_if_supported ( -Wundef )
2015-04-25 09:46:35 +08:00
2020-08-01 01:44:02 +08:00
add_compile_flags_if_supported ( -Wno-suggest-override )
2020-10-24 03:51:21 +08:00
if ( WIN32 )
# The headers lack matching dllexport attributes (_LIBUNWIND_EXPORT);
# silence the warning instead of cluttering the headers (which aren't
# necessarily the ones that the callers will use anyway) with the
# attributes.
add_compile_flags_if_supported ( -Wno-dll-attribute-on-redeclaration )
endif ( )
2015-04-25 09:46:35 +08:00
if ( LIBUNWIND_ENABLE_WERROR )
2019-10-12 06:22:29 +08:00
add_compile_flags_if_supported ( -Werror )
add_compile_flags_if_supported ( -WX )
2015-04-25 09:46:35 +08:00
else ( )
2019-10-12 06:22:29 +08:00
add_compile_flags_if_supported ( -Wno-error )
add_compile_flags_if_supported ( -WX- )
2015-04-25 09:46:35 +08:00
endif ( )
if ( LIBUNWIND_ENABLE_PEDANTIC )
2019-10-12 06:22:29 +08:00
add_compile_flags_if_supported ( -pedantic )
2015-04-25 09:46:35 +08:00
endif ( )
# Get feature flags.
# Exceptions
# Catches C++ exceptions only and tells the compiler to assume that extern C
# functions never throw a C++ exception.
2019-10-12 06:22:29 +08:00
add_cxx_compile_flags_if_supported ( -fstrict-aliasing )
add_cxx_compile_flags_if_supported ( -EHsc )
2015-04-25 09:46:35 +08:00
2019-12-06 22:26:35 +08:00
# Don't run the linker in this CMake check.
#
# The reason why this was added is that when building libunwind for
# ARM Linux, we need to pass the -funwind-tables flag in order for it to
# work properly with ARM EHABI.
#
# However, when performing CMake checks, adding this flag causes the check
# to produce a false negative, because the compiler generates calls
# to __aeabi_unwind_cpp_pr0, which is defined in libunwind itself,
# which isn't built yet, so the linker complains about undefined symbols.
#
# This leads to libunwind not being built with this flag, which makes
# libunwind quite useless in this setup.
set ( _previous_CMAKE_TRY_COMPILE_TARGET_TYPE ${ CMAKE_TRY_COMPILE_TARGET_TYPE } )
set ( CMAKE_TRY_COMPILE_TARGET_TYPE STATIC_LIBRARY )
2019-10-12 09:50:57 +08:00
add_compile_flags_if_supported ( -funwind-tables )
2019-12-06 22:26:35 +08:00
set ( CMAKE_TRY_COMPILE_TARGET_TYPE ${ _previous_CMAKE_TRY_COMPILE_TARGET_TYPE } )
2022-03-10 17:47:09 +08:00
if ( LIBUNWIND_USES_ARM_EHABI AND NOT CXX_SUPPORTS_FUNWIND_TABLES_FLAG )
2019-12-06 22:26:35 +08:00
message ( SEND_ERROR "The -funwind-tables flag must be supported "
" b e c a u s e t h i s t a r g e t u s e s A R M E x c e p t i o n H a n d l i n g A B I " )
endif ( )
2019-10-12 06:22:29 +08:00
add_cxx_compile_flags_if_supported ( -fno-exceptions )
add_cxx_compile_flags_if_supported ( -fno-rtti )
2015-04-25 09:46:35 +08:00
2019-01-30 06:26:18 +08:00
# Ensure that we don't depend on C++ standard library.
2022-03-10 17:47:09 +08:00
if ( CXX_SUPPORTS_NOSTDINCXX_FLAG )
2019-10-12 06:22:29 +08:00
list ( APPEND LIBUNWIND_COMPILE_FLAGS -nostdinc++ )
# Remove -stdlib flags to prevent them from causing an unused flag warning.
2020-10-13 22:05:00 +08:00
string ( REPLACE "--stdlib=libc++" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}" )
string ( REPLACE "--stdlib=libstdc++" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}" )
2019-10-12 06:22:29 +08:00
string ( REPLACE "-stdlib=libc++" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}" )
string ( REPLACE "-stdlib=libstdc++" "" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}" )
endif ( )
2019-01-30 06:26:18 +08:00
2015-04-25 09:46:35 +08:00
# Assert
string ( TOUPPER "${CMAKE_BUILD_TYPE}" uppercase_CMAKE_BUILD_TYPE )
if ( LIBUNWIND_ENABLE_ASSERTIONS )
# MSVC doesn't like _DEBUG on release builds. See PR 4379.
if ( NOT MSVC )
2019-10-12 06:22:29 +08:00
add_compile_flags ( -D_DEBUG )
2016-08-09 01:56:28 +08:00
endif ( )
2015-04-25 09:46:35 +08:00
# On Release builds cmake automatically defines NDEBUG, so we
# explicitly undefine it:
2022-05-04 17:52:20 +08:00
if ( NOT uppercase_CMAKE_BUILD_TYPE STREQUAL "DEBUG" )
2019-10-12 06:22:29 +08:00
add_compile_flags ( -UNDEBUG )
2016-08-09 01:56:28 +08:00
endif ( )
2015-04-25 09:46:35 +08:00
else ( )
2022-05-04 17:52:20 +08:00
if ( uppercase_CMAKE_BUILD_TYPE STREQUAL "DEBUG" )
2019-10-12 06:22:29 +08:00
add_compile_flags ( -DNDEBUG )
2016-08-09 01:56:28 +08:00
endif ( )
endif ( )
2015-04-25 09:46:35 +08:00
2016-05-25 20:36:34 +08:00
# Cross-unwinding
if ( NOT LIBUNWIND_ENABLE_CROSS_UNWINDING )
2019-10-12 06:22:29 +08:00
add_compile_flags ( -D_LIBUNWIND_IS_NATIVE_ONLY )
2016-08-09 01:56:28 +08:00
endif ( )
2016-05-25 20:36:34 +08:00
2016-09-28 18:57:15 +08:00
# Threading-support
if ( NOT LIBUNWIND_ENABLE_THREADS )
2019-10-12 06:22:29 +08:00
add_compile_flags ( -D_LIBUNWIND_HAS_NO_THREADS )
2016-09-28 18:57:15 +08:00
endif ( )
2016-07-07 18:55:39 +08:00
# ARM WMMX register support
if ( LIBUNWIND_ENABLE_ARM_WMMX )
# __ARM_WMMX is a compiler pre-define (as per the ACLE 2.0). Clang does not
# define this macro for any supported target at present. Therefore, here we
# provide the option to explicitly enable support for WMMX registers in the
# unwinder.
2019-10-12 06:22:29 +08:00
add_compile_flags ( -D__ARM_WMMX )
2016-08-09 01:56:28 +08:00
endif ( )
2016-07-07 18:55:39 +08:00
2020-07-29 18:39:41 +08:00
if ( LIBUNWIND_IS_BAREMETAL )
add_compile_definitions ( _LIBUNWIND_IS_BAREMETAL )
endif ( )
2020-08-19 03:05:07 +08:00
if ( LIBUNWIND_USE_FRAME_HEADER_CACHE )
add_compile_definitions ( _LIBUNWIND_USE_FRAME_HEADER_CACHE )
endif ( )
2020-11-11 17:58:41 +08:00
if ( LIBUNWIND_REMEMBER_HEAP_ALLOC )
add_compile_definitions ( _LIBUNWIND_REMEMBER_HEAP_ALLOC )
endif ( )
2015-04-25 09:46:35 +08:00
# This is the _ONLY_ place where add_definitions is called.
if ( MSVC )
add_definitions ( -D_CRT_SECURE_NO_WARNINGS )
2016-08-09 01:56:28 +08:00
endif ( )
2015-04-25 09:46:35 +08:00
2017-11-29 16:21:12 +08:00
# Disable DLL annotations on Windows for static builds.
if ( WIN32 AND LIBUNWIND_ENABLE_STATIC AND NOT LIBUNWIND_ENABLE_SHARED )
[libunwind] unw_* alias fixes for ELF and Mach-O
Rename the CMake option, LIBUNWIND_HERMETIC_STATIC_LIBRARY, to
LIBUNWIND_HIDE_SYMBOLS. Rename the C macro define,
_LIBUNWIND_DISABLE_VISIBILITY_ANNOTATIONS, to _LIBUNWIND_HIDE_SYMBOLS,
because now the macro adds a .hidden directive rather than merely
suppress visibility annotations.
For ELF, when LIBUNWIND_HIDE_SYMBOLS is enabled, mark unw_getcontext as
hidden. This symbol is the only one defined using src/assembly.h's
WEAK_ALIAS macro. Other unw_* weak aliases are defined in C++ and are
already hidden.
Mach-O doesn't support weak aliases, so remove .weak_reference and
weak_import. When LIBUNWIND_HIDE_SYMBOLS is enabled, output
.private_extern for the unw_* aliases.
In assembly.h, add missing SYMBOL_NAME macro invocations, which are
used to prefix symbol names with '_' on some targets.
Fixes PR46709.
Reviewed By: #libunwind, phosek, compnerd, steven_wu
Differential Revision: https://reviews.llvm.org/D93003
2021-02-23 08:35:38 +08:00
add_definitions ( -D_LIBUNWIND_HIDE_SYMBOLS )
2017-11-29 16:21:12 +08:00
endif ( )
2022-03-10 17:47:09 +08:00
if ( C_SUPPORTS_COMMENT_LIB_PRAGMA )
2019-11-30 22:13:56 +08:00
if ( LIBUNWIND_HAS_DL_LIB )
add_definitions ( -D_LIBUNWIND_LINK_DL_LIB )
endif ( )
if ( LIBUNWIND_HAS_PTHREAD_LIB )
add_definitions ( -D_LIBUNWIND_LINK_PTHREAD_LIB )
endif ( )
2019-05-30 12:40:21 +08:00
endif ( )
2015-04-25 09:46:35 +08:00
#===============================================================================
# Setup Source Code
#===============================================================================
2021-12-17 02:32:12 +08:00
add_subdirectory ( include )
2015-04-25 09:46:35 +08:00
add_subdirectory ( src )
2017-03-28 23:21:43 +08:00
if ( LIBUNWIND_INCLUDE_DOCS )
add_subdirectory ( docs )
endif ( )
2017-07-06 23:20:12 +08:00
2021-09-17 00:27:53 +08:00
if ( LIBUNWIND_INCLUDE_TESTS AND EXISTS ${ LLVM_CMAKE_DIR } )
2018-08-03 13:51:31 +08:00
add_subdirectory ( test )
endif ( )
