Skip to content

Commit

Permalink
[compiler-rt] Simple crtbegin.o and crtend.o implementation
Browse files Browse the repository at this point in the history
Clang relies on existence of certain symbols that are normally
provided by crtbegin.o/crtend.o. However, LLVM does not currently
provide implementation of these files, instead relying on either
libgcc or implementations provided as part of the system.

This change provides an initial implementation of crtbegin.o/crtend.o
that can be used on system that don't provide crtbegin.o/crtend.o as
part of their C library.

Differential Revision: https://reviews.llvm.org/D28791

llvm-svn: 359576
  • Loading branch information
petrhosek committed Apr 30, 2019
1 parent 9fa970a commit c8be6e6
Show file tree
Hide file tree
Showing 12 changed files with 420 additions and 17 deletions.
2 changes: 2 additions & 0 deletions compiler-rt/CMakeLists.txt
Expand Up @@ -29,6 +29,8 @@ include(CompilerRTUtils)

option(COMPILER_RT_BUILD_BUILTINS "Build builtins" ON)
mark_as_advanced(COMPILER_RT_BUILD_BUILTINS)
option(COMPILER_RT_BUILD_CRT "Build crtbegin.o/crtend.o" ON)
mark_as_advanced(COMPILER_RT_BUILD_CRT)
option(COMPILER_RT_BUILD_SANITIZERS "Build sanitizers" ON)
mark_as_advanced(COMPILER_RT_BUILD_SANITIZERS)
option(COMPILER_RT_BUILD_XRAY "Build xray" ON)
Expand Down
52 changes: 35 additions & 17 deletions compiler-rt/cmake/Modules/AddCompilerRT.cmake
Expand Up @@ -132,7 +132,7 @@ endmacro()
# Adds static or shared runtime for a list of architectures and operating
# systems and puts it in the proper directory in the build and install trees.
# add_compiler_rt_runtime(<name>
# {STATIC|SHARED}
# {OBJECT|STATIC|SHARED}
# ARCHS <architectures>
# OS <os list>
# SOURCES <source files>
Expand All @@ -144,8 +144,8 @@ endmacro()
# PARENT_TARGET <convenience parent target>
# ADDITIONAL_HEADERS <header files>)
function(add_compiler_rt_runtime name type)
if(NOT type MATCHES "^(STATIC|SHARED)$")
message(FATAL_ERROR "type argument must be STATIC or SHARED")
if(NOT type MATCHES "^(OBJECT|STATIC|SHARED)$")
message(FATAL_ERROR "type argument must be OBJECT, STATIC or SHARED")
return()
endif()
cmake_parse_arguments(LIB
Expand Down Expand Up @@ -204,7 +204,10 @@ function(add_compiler_rt_runtime name type)
message(FATAL_ERROR "Architecture ${arch} can't be targeted")
return()
endif()
if(type STREQUAL "STATIC")
if(type STREQUAL "OBJECT")
set(libname "${name}-${arch}")
set_output_name(output_name_${libname} ${name}${COMPILER_RT_OS_SUFFIX} ${arch})
elseif(type STREQUAL "STATIC")
set(libname "${name}-${arch}")
set_output_name(output_name_${libname} ${name} ${arch})
else()
Expand Down Expand Up @@ -270,12 +273,34 @@ function(add_compiler_rt_runtime name type)
set(COMPONENT_OPTION COMPONENT ${libname})
endif()

add_library(${libname} ${type} ${sources_${libname}})
set_target_compile_flags(${libname} ${extra_cflags_${libname}})
set_target_link_flags(${libname} ${extra_link_flags_${libname}})
set_property(TARGET ${libname} APPEND PROPERTY
COMPILE_DEFINITIONS ${LIB_DEFS})
set_target_output_directories(${libname} ${output_dir_${libname}})
if(type STREQUAL "OBJECT")
string(TOUPPER ${CMAKE_BUILD_TYPE} config)
get_property(cflags SOURCE ${sources_${libname}} PROPERTY COMPILE_FLAGS)
separate_arguments(cflags)
add_custom_command(
OUTPUT ${output_dir_${libname}}/${output_name_${libname}}.o
COMMAND ${CMAKE_C_COMPILER} ${sources_${libname}} ${cflags} ${extra_cflags_${libname}} -c -o ${output_dir_${libname}}/${output_name_${libname}}.o
DEPENDS ${sources_${libname}}
COMMENT "Building C object ${output_name_${libname}}.o")
add_custom_target(${libname} DEPENDS ${output_dir_${libname}}/${output_name_${libname}}.o)
install(FILES ${output_dir_${libname}}/${output_name_${libname}}.o
DESTINATION ${install_dir_${libname}}
${COMPONENT_OPTION})
else()
add_library(${libname} ${type} ${sources_${libname}})
set_target_compile_flags(${libname} ${extra_cflags_${libname}})
set_target_link_flags(${libname} ${extra_link_flags_${libname}})
set_property(TARGET ${libname} APPEND PROPERTY
COMPILE_DEFINITIONS ${LIB_DEFS})
set_target_output_directories(${libname} ${output_dir_${libname}})
install(TARGETS ${libname}
ARCHIVE DESTINATION ${install_dir_${libname}}
${COMPONENT_OPTION}
LIBRARY DESTINATION ${install_dir_${libname}}
${COMPONENT_OPTION}
RUNTIME DESTINATION ${install_dir_${libname}}
${COMPONENT_OPTION})
endif()
set_target_properties(${libname} PROPERTIES
OUTPUT_NAME ${output_name_${libname}})
set_target_properties(${libname} PROPERTIES FOLDER "Compiler-RT Runtime")
Expand All @@ -299,13 +324,6 @@ function(add_compiler_rt_runtime name type)
)
endif()
endif()
install(TARGETS ${libname}
ARCHIVE DESTINATION ${install_dir_${libname}}
${COMPONENT_OPTION}
LIBRARY DESTINATION ${install_dir_${libname}}
${COMPONENT_OPTION}
RUNTIME DESTINATION ${install_dir_${libname}}
${COMPONENT_OPTION})

# We only want to generate per-library install targets if you aren't using
# an IDE because the extra targets get cluttered in IDEs.
Expand Down
8 changes: 8 additions & 0 deletions compiler-rt/cmake/config-ix.cmake
Expand Up @@ -229,6 +229,7 @@ set(ALL_SANITIZER_COMMON_SUPPORTED_ARCH ${X86} ${X86_64} ${PPC64}
${ARM32} ${ARM64} ${MIPS32} ${MIPS64} ${S390X})
set(ALL_ASAN_SUPPORTED_ARCH ${X86} ${X86_64} ${ARM32} ${ARM64}
${MIPS32} ${MIPS64} ${PPC64} ${S390X})
set(ALL_CRT_SUPPORTED_ARCH ${X86} ${X86_64} ${ARM32} ${ARM64})
set(ALL_DFSAN_SUPPORTED_ARCH ${X86_64} ${MIPS64} ${ARM64})
set(ALL_FUZZER_SUPPORTED_ARCH ${X86_64} ${ARM64})

Expand Down Expand Up @@ -472,6 +473,7 @@ if(APPLE)
SANITIZER_COMMON_SUPPORTED_ARCH)

else()
filter_available_targets(CRT_SUPPORTED_ARCH ${ALL_CRT_SUPPORTED_ARCH})
# Architectures supported by compiler-rt libraries.
filter_available_targets(SANITIZER_COMMON_SUPPORTED_ARCH
${ALL_SANITIZER_COMMON_SUPPORTED_ARCH})
Expand Down Expand Up @@ -560,6 +562,12 @@ endif()

# TODO: Add builtins support.

if (CRT_SUPPORTED_ARCH AND OS_NAME MATCHES "Linux")
set(COMPILER_RT_HAS_CRT TRUE)
else()
set(COMPILER_RT_HAS_CRT FALSE)
endif()

if (COMPILER_RT_HAS_SANITIZER_COMMON AND DFSAN_SUPPORTED_ARCH AND
OS_NAME MATCHES "Linux")
set(COMPILER_RT_HAS_DFSAN TRUE)
Expand Down
4 changes: 4 additions & 0 deletions compiler-rt/lib/CMakeLists.txt
Expand Up @@ -17,6 +17,10 @@ if(COMPILER_RT_BUILD_BUILTINS)
add_subdirectory(builtins)
endif()

if(COMPILER_RT_BUILD_CRT)
add_subdirectory(crt)
endif()

function(compiler_rt_build_runtime runtime)
string(TOUPPER ${runtime} runtime_uppercase)
if(COMPILER_RT_HAS_${runtime_uppercase})
Expand Down
90 changes: 90 additions & 0 deletions compiler-rt/lib/crt/CMakeLists.txt
@@ -0,0 +1,90 @@
add_compiler_rt_component(crt)

function(check_cxx_section_exists section output)
cmake_parse_arguments(ARG "" "" "SOURCE;FLAGS" ${ARGN})
if(NOT ARG_SOURCE)
set(ARG_SOURCE "int main() { return 0; }\n")
endif()

string(RANDOM TARGET_NAME)
set(TARGET_NAME "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/cmTC_${TARGET_NAME}.dir")
file(MAKE_DIRECTORY ${TARGET_NAME})

file(WRITE "${TARGET_NAME}/CheckSectionExists.c" "${ARG_SOURCE}\n")

string(REGEX MATCHALL "<[A-Za-z0-9_]*>" substitutions
${CMAKE_C_COMPILE_OBJECT})

set(try_compile_flags "${ARG_FLAGS}")
if(CMAKE_C_COMPILER_ID MATCHES Clang AND CMAKE_C_COMPILER_TARGET)
list(APPEND try_compile_flags "-target ${CMAKE_C_COMPILER_TARGET}")
endif()

string(REPLACE ";" " " extra_flags "${try_compile_flags}")

set(test_compile_command "${CMAKE_C_COMPILE_OBJECT}")
foreach(substitution ${substitutions})
if(substitution STREQUAL "<CMAKE_C_COMPILER>")
string(REPLACE "<CMAKE_C_COMPILER>"
"${CMAKE_C_COMPILER}" test_compile_command ${test_compile_command})
elseif(substitution STREQUAL "<OBJECT>")
string(REPLACE "<OBJECT>" "${TARGET_NAME}/CheckSectionExists.o"
test_compile_command ${test_compile_command})
elseif(substitution STREQUAL "<SOURCE>")
string(REPLACE "<SOURCE>" "${TARGET_NAME}/CheckSectionExists.c"
test_compile_command ${test_compile_command})
elseif(substitution STREQUAL "<FLAGS>")
string(REPLACE "<FLAGS>" "${CMAKE_C_FLAGS} ${extra_flags}"
test_compile_command ${test_compile_command})
else()
string(REPLACE "${substitution}" "" test_compile_command
${test_compile_command})
endif()
endforeach()

string(REPLACE " " ";" test_compile_command "${test_compile_command}")

execute_process(
COMMAND ${test_compile_command}
RESULT_VARIABLE TEST_RESULT
OUTPUT_VARIABLE TEST_OUTPUT
ERROR_VARIABLE TEST_ERROR
)

execute_process(
COMMAND ${CMAKE_OBJDUMP} -h "${TARGET_NAME}/CheckSectionExists.o"
RESULT_VARIABLE CHECK_RESULT
OUTPUT_VARIABLE CHECK_OUTPUT
ERROR_VARIABLE CHECK_ERROR
)
string(FIND "${CHECK_OUTPUT}" "${section}" SECTION_FOUND)

if(NOT SECTION_FOUND EQUAL -1)
set(${output} TRUE PARENT_SCOPE)
else()
set(${output} FALSE PARENT_SCOPE)
endif()

file(REMOVE_RECURSE ${TARGET_NAME})
endfunction()

check_cxx_section_exists(".init_array" COMPILER_RT_HAS_INITFINI_ARRAY
SOURCE "__attribute__((constructor)) void f() {}\nint main() { return 0; }\n")

append_list_if(COMPILER_RT_HAS_INITFINI_ARRAY -DCRT_HAS_INITFINI_ARRAY CRT_CFLAGS)
append_list_if(COMPILER_RT_HAS_FPIC_FLAG -fPIC CRT_CFLAGS)

foreach(arch ${CRT_SUPPORTED_ARCH})
add_compiler_rt_runtime(clang_rt.crtbegin
OBJECT
ARCHS ${arch}
SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/crtbegin.c
CFLAGS ${CRT_CFLAGS}
PARENT_TARGET crt)
add_compiler_rt_runtime(clang_rt.crtend
OBJECT
ARCHS ${arch}
SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/crtend.c
CFLAGS ${CRT_CFLAGS}
PARENT_TARGET crt)
endforeach()
97 changes: 97 additions & 0 deletions compiler-rt/lib/crt/crtbegin.c
@@ -0,0 +1,97 @@
//===-- crtbegin.c - Start of constructors and destructors ----------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#include <stddef.h>

__attribute__((visibility("hidden"))) void *__dso_handle = &__dso_handle;

static void *__EH_FRAME_LIST__[]
__attribute__((section(".eh_frame"), aligned(sizeof(void *)))) = {};

extern void __register_frame_info(const void *, void *) __attribute__((weak));
extern void *__deregister_frame_info(const void *) __attribute__((weak));

#ifndef CRT_HAS_INITFINI_ARRAY
typedef void (*fp)(void);

static fp __CTOR_LIST__[]
__attribute__((section(".ctors"), aligned(sizeof(fp)))) = {(fp)-1};
extern fp __CTOR_LIST_END__[];
#endif

extern void __cxa_finalize(void *) __attribute__((weak));

static void __attribute__((used)) __do_init() {
static _Bool __initialized;
if (__builtin_expect(__initialized, 0))
return;
__initialized = 1;

static struct { void *p[8]; } __object;
if (__register_frame_info)
__register_frame_info(__EH_FRAME_LIST__, &__object);

#ifndef CRT_HAS_INITFINI_ARRAY
const size_t n = __CTOR_LIST_END__ - __CTOR_LIST__ - 1;
for (size_t i = n; i >= 1; i--) __CTOR_LIST__[i]();
#endif
}

#ifdef CRT_HAS_INITFINI_ARRAY
__attribute__((section(".init_array"),
used)) static void (*__init)(void) = __do_init;
#else // CRT_HAS_INITFINI_ARRAY
#if defined(__i386__) || defined(__x86_64__)
asm(".pushsection .init,\"ax\",@progbits\n\t"
"call " __USER_LABEL_PREFIX__ "__do_init\n\t"
".popsection");
#elif defined(__arm__)
asm(".pushsection .init,\"ax\",%progbits\n\t"
"bl " __USER_LABEL_PREFIX__ "__do_init\n\t"
".popsection");
#endif // CRT_HAS_INITFINI_ARRAY
#endif

#ifndef CRT_HAS_INITFINI_ARRAY
static fp __DTOR_LIST__[]
__attribute__((section(".dtors"), aligned(sizeof(fp)))) = {(fp)-1};
extern fp __DTOR_LIST_END__[];
#endif

static void __attribute__((used)) __do_fini() {
static _Bool __finalized;
if (__builtin_expect(__finalized, 0))
return;
__finalized = 1;

if (__cxa_finalize)
__cxa_finalize(__dso_handle);

#ifndef CRT_HAS_INITFINI_ARRAY
if (__deregister_frame_info)
__deregister_frame_info(__EH_FRAME_LIST__);

const size_t n = __DTOR_LIST_END__ - __DTOR_LIST__ - 1;
for (size_t i = 1; i < n; i++) __DTOR_LIST__[i]();
#endif
}

#ifdef CRT_HAS_INITFINI_ARRAY
__attribute__((section(".fini_array"),
used)) static void (*__fini)(void) = __do_fini;
#else // CRT_HAS_INITFINI_ARRAY
#if defined(__i386__) || defined(__x86_64__)
asm(".pushsection .fini,\"ax\",@progbits\n\t"
"call " __USER_LABEL_PREFIX__ "__do_fini\n\t"
".popsection");
#elif defined(__arm__)
asm(".pushsection .fini,\"ax\",%progbits\n\t"
"bl " __USER_LABEL_PREFIX__ "__do_fini\n\t"
".popsection");
#endif
#endif // CRT_HAS_INIT_FINI_ARRAY
22 changes: 22 additions & 0 deletions compiler-rt/lib/crt/crtend.c
@@ -0,0 +1,22 @@
//===-- crtend.c - End of constructors and destructors --------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#include <stdint.h>

// Put 4-byte zero which is the length field in FDE at the end as a terminator.
const int32_t __EH_FRAME_LIST_END__[]
__attribute__((section(".eh_frame"), aligned(sizeof(int32_t)),
visibility("hidden"), used)) = {0};

#ifndef CRT_HAS_INITFINI_ARRAY
typedef void (*fp)(void);
fp __CTOR_LIST_END__[]
__attribute__((section(".ctors"), visibility("hidden"), used)) = {0};
fp __DTOR_LIST_END__[]
__attribute__((section(".dtors"), visibility("hidden"), used)) = {0};
#endif
3 changes: 3 additions & 0 deletions compiler-rt/test/CMakeLists.txt
Expand Up @@ -73,6 +73,9 @@ if(COMPILER_RT_CAN_EXECUTE_TESTS)
if(COMPILER_RT_BUILD_XRAY)
compiler_rt_test_runtime(xray)
endif()
if(COMPILER_RT_HAS_CRT)
add_subdirectory(crt)
endif()
# ShadowCallStack does not yet provide a runtime with compiler-rt, the tests
# include their own minimal runtime
add_subdirectory(shadowcallstack)
Expand Down
34 changes: 34 additions & 0 deletions compiler-rt/test/crt/CMakeLists.txt
@@ -0,0 +1,34 @@
set(CRT_LIT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})

set(CRT_TESTSUITES)

set(CRT_TEST_DEPS)
if(NOT COMPILER_RT_STANDALONE_BUILD)
list(APPEND CRT_TEST_DEPS crt)
endif()
if(NOT COMPILER_RT_STANDALONE_BUILD AND NOT RUNTIMES_BUILD)
# Use LLVM utils and Clang from the same build tree.
list(APPEND CRT_TEST_DEPS
clang clang-resource-headers FileCheck not llvm-config)
endif()

set(CRT_TEST_ARCH ${CRT_SUPPORTED_ARCH})
if (COMPILER_RT_BUILD_CRT AND COMPILER_RT_HAS_CRT)
foreach(arch ${CRT_TEST_ARCH})
set(CRT_TEST_TARGET_ARCH ${arch})
string(TOLOWER "-${arch}-${OS_NAME}" CRT_TEST_CONFIG_SUFFIX)
get_test_cc_for_arch(${arch} CRT_TEST_TARGET_CC CRT_TEST_TARGET_CFLAGS)
string(TOUPPER ${arch} ARCH_UPPER_CASE)
set(CONFIG_NAME ${ARCH_UPPER_CASE}${OS_NAME}Config)

configure_lit_site_cfg(
${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.in
${CMAKE_CURRENT_BINARY_DIR}/${CONFIG_NAME}/lit.site.cfg)
list(APPEND CRT_TESTSUITES ${CMAKE_CURRENT_BINARY_DIR}/${CONFIG_NAME})
endforeach()
endif()

add_lit_testsuite(check-crt "Running the CRT tests"
${CRT_TESTSUITES}
DEPENDS ${CRT_TEST_DEPS})
set_target_properties(check-crt PROPERTIES FOLDER "Compiler-RT Misc")

0 comments on commit c8be6e6

Please sign in to comment.