mirror of
https://github.com/JakeHillion/object-introspection.git
synced 2024-11-09 21:24:14 +00:00
a6d74a20a6
Summary: Update to clang-15 compiler and libraries as clang-12 is ancient. The changes to oilgen are necessary because the new internal toolchain is being more picky about linking PIC to PIC. In certain modes we build with PIC, but try to link a non-PIC oilgen artifact. Add the ability to build the oilgen artifacts with PIC which sorts this. Reviewed By: ttreyer Differential Revision: D46220858
408 lines
13 KiB
CMake
408 lines
13 KiB
CMake
# object-introspection
|
||
cmake_minimum_required(VERSION 3.20)
|
||
project(object-introspection)
|
||
|
||
# Lets find_program() locate SETUID binaries
|
||
cmake_policy(SET CMP0109 NEW)
|
||
|
||
set(CMAKE_CXX_STANDARD 20)
|
||
set(CMAKE_CXX_STANDARD_REQUIRED True)
|
||
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake")
|
||
|
||
add_compile_definitions(OSS_ENABLE)
|
||
|
||
include(FetchContent)
|
||
include(ProcessorCount)
|
||
include(cmake/StandardProjectSettings.cmake)
|
||
include(cmake/PreventInSourceBuilds.cmake)
|
||
include(cmake/CompilerWarnings.cmake)
|
||
|
||
option(STATIC_LINK "Statically link oid" OFF)
|
||
option(ASAN "Enable address sanitizer" OFF)
|
||
option(CODE_COVERAGE "Enable code coverage" OFF)
|
||
option(WITH_TESTS "Build with tests" ON)
|
||
option(WITH_FLAKY_TESTS "Build with flaky tests" ON)
|
||
option(FORCE_BOOST_STATIC "Build with static boost" ON)
|
||
option(FORCE_LLVM_STATIC "Build with static llvm and clang" ON)
|
||
|
||
# Fetch all external projects before we enable warnings globally
|
||
|
||
### gflags (before glog)
|
||
find_package(gflags REQUIRED)
|
||
|
||
### tomlplusplus (for configuration files)
|
||
FetchContent_Declare(
|
||
tomlplusplus
|
||
GIT_REPOSITORY https://github.com/marzer/tomlplusplus.git
|
||
GIT_TAG 4b166b69f28e70a416a1a04a98f365d2aeb90de8 # v3.2.0
|
||
)
|
||
FetchContent_MakeAvailable(tomlplusplus)
|
||
|
||
### glog
|
||
FetchContent_Declare(
|
||
glog
|
||
GIT_REPOSITORY https://github.com/google/glog.git
|
||
GIT_TAG 96a2f23dca4cc7180821ca5f32e526314395d26a
|
||
)
|
||
FetchContent_MakeAvailable(glog)
|
||
|
||
# These glog executable targets still generate warnings - disable warnings for
|
||
# them explicitly
|
||
target_compile_options(demangle_unittest PRIVATE "-w")
|
||
target_compile_options(logging_unittest PRIVATE "-w")
|
||
target_compile_options(stl_logging_unittest PRIVATE "-w")
|
||
target_compile_options(symbolize_unittest PRIVATE "-w")
|
||
target_compile_options(utilities_unittest PRIVATE "-w")
|
||
|
||
### googletest
|
||
# Do this in the main file so it can be fetched before setting project warnings.
|
||
# After this is fixed with FetchContent, move to test/CMakeLists.txt.
|
||
FetchContent_Declare(
|
||
googletest
|
||
GIT_REPOSITORY https://github.com/google/googletest.git
|
||
GIT_TAG 1ed6a8c67a0bd675149ece27bbec0ef1759854cf
|
||
)
|
||
FetchContent_MakeAvailable(googletest)
|
||
|
||
### rocksdb
|
||
FetchContent_Declare(
|
||
rocksdb
|
||
GIT_REPOSITORY https://github.com/facebook/rocksdb.git
|
||
GIT_TAG 444b3f4845dd01b0d127c4b420fdd3b50ad56682
|
||
)
|
||
FetchContent_Populate(rocksdb)
|
||
add_custom_target(librocksdb ALL
|
||
WORKING_DIRECTORY ${rocksdb_SOURCE_DIR}
|
||
COMMAND cmake -G Ninja -B ${rocksdb_BINARY_DIR} -DCMAKE_BUILD_TYPE=Release -DWITH_GFLAGS=Off -DWITH_LIBURING=Off -DWITH_ZSTD=On -DFAIL_ON_WARNINGS=Off
|
||
COMMAND cmake --build ${rocksdb_BINARY_DIR} --target rocksdb
|
||
BYPRODUCTS ${rocksdb_BINARY_DIR}/librocksdb.a
|
||
COMMENT "Building RocksDB"
|
||
USES_TERMINAL
|
||
)
|
||
include_directories(SYSTEM "${rocksdb_SOURCE_DIR}/include")
|
||
|
||
### folly
|
||
### use folly as a header only library. some features won't be supported.
|
||
FetchContent_Declare(
|
||
folly
|
||
GIT_REPOSITORY https://github.com/JakeHillion/folly.git
|
||
GIT_TAG 8db54418e3ccdd97619ac8b69bb3702f82bb0f66
|
||
)
|
||
FetchContent_Populate(folly)
|
||
|
||
set_project_warnings()
|
||
|
||
if (ASAN)
|
||
add_compile_options(-fsanitize=address -fno-omit-frame-pointer)
|
||
add_link_options(-fsanitize=address)
|
||
endif()
|
||
|
||
if (CODE_COVERAGE)
|
||
add_compile_options(--coverage)
|
||
add_link_options(--coverage)
|
||
endif()
|
||
|
||
|
||
## System checks
|
||
## These checks are potentially fatal so perform them first.
|
||
|
||
### (Re)download submodules
|
||
find_package(Git QUIET)
|
||
|
||
# TODO: No idea if this huge block is required, just picked from an example. There may be a short-hand.
|
||
if(GIT_FOUND AND EXISTS "${PROJECT_SOURCE_DIR}/.git")
|
||
# Update submodules as needed
|
||
option(GIT_SUBMODULE "Check submodules during build" ON)
|
||
if(GIT_SUBMODULE)
|
||
message(STATUS "Submodule update")
|
||
|
||
# This is a hack. If contents in drgn/libdrgn folder are not found, do a force checkout
|
||
# If drgn/* is manually deleted (for whatever reason), git doesn't seem to re-pull the contents unless forced
|
||
if (NOT EXISTS "${PROJECT_SOURCE_DIR}/extern/drgn/libdrgn")
|
||
execute_process(COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive --force
|
||
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
|
||
RESULT_VARIABLE GIT_SUBMOD_RESULT)
|
||
else()
|
||
execute_process(COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive
|
||
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
|
||
RESULT_VARIABLE GIT_SUBMOD_RESULT)
|
||
endif()
|
||
if(NOT GIT_SUBMOD_RESULT EQUAL "0")
|
||
message(FATAL_ERROR "git submodule update --init failed with ${GIT_SUBMOD_RESULT}, please checkout submodules")
|
||
endif()
|
||
endif()
|
||
endif()
|
||
|
||
if(NOT EXISTS "${PROJECT_SOURCE_DIR}/extern/drgn")
|
||
message(FATAL_ERROR "The submodules were not downloaded! GIT_SUBMODULE was turned off or failed. Please update submodules and try again.")
|
||
endif()
|
||
|
||
### Select Python version
|
||
find_program(PYTHON NAMES python3.8 python3)
|
||
|
||
add_library(folly_headers INTERFACE)
|
||
target_include_directories(folly_headers SYSTEM INTERFACE ${folly_SOURCE_DIR})
|
||
target_link_libraries(folly_headers INTERFACE Boost::headers)
|
||
|
||
### bison & flex (for oid_parser)
|
||
find_package(BISON 3.5 REQUIRED)
|
||
find_package(FLEX)
|
||
|
||
### Boost
|
||
### Always use static linking with Boost, as some of its dependencies are not in the system's LD_LIBRARY_PATH.
|
||
if (FORCE_BOOST_STATIC)
|
||
set(Boost_USE_STATIC_LIBS True)
|
||
endif()
|
||
find_package(Boost REQUIRED COMPONENTS
|
||
system
|
||
filesystem
|
||
thread
|
||
regex
|
||
serialization
|
||
)
|
||
message(STATUS "Linking Boost libraries: ${Boost_LIBRARIES}")
|
||
|
||
### LLVM and Clang - Preferring Clang 15
|
||
find_package(LLVM 15 REQUIRED CONFIG)
|
||
message(STATUS "Found LLVM ${LLVM_PACKAGE_VERSION}")
|
||
message(STATUS "Using LLVMConfig.cmake in: ${LLVM_DIR}")
|
||
|
||
find_package(Clang REQUIRED CONFIG)
|
||
message(STATUS "Found Clang ${LLVM_PACKAGE_VERSION}")
|
||
message(STATUS "Using ClangConfig.cmake in: ${Clang_DIR}")
|
||
|
||
### msgpack
|
||
# msgpack v3.0.0 doesn't define the msgpackc-cxx target, but since the library is header only,
|
||
# we can locate the header dir and add it to our include directories.
|
||
# Ideally, we would use a more modern version, like v3.3.0, and directly use the msgpackc-cxx target.
|
||
find_package(msgpack REQUIRED CONFIG)
|
||
get_target_property(MSGPACK_INCLUDE_DIRS msgpackc INTERFACE_INCLUDE_DIRECTORIES)
|
||
include_directories(SYSTEM ${MSGPACK_INCLUDE_DIRS})
|
||
|
||
### zstd (for rocksdb)
|
||
find_package(zstd REQUIRED)
|
||
|
||
### drgn
|
||
# The setup.py script in drgn is really meant to build drgn (python
|
||
# debugger). It shoves the C headers/lib in a temporary directory (which
|
||
# is named 'build' below using --build-temp flag). It may(not) make sense
|
||
# to just build libdrgn manually. Don't know how finicky the setup.py
|
||
# might be. These are the steps to manually build lib/headers and output
|
||
# to extern/drgn/libdrgn/build directory :-
|
||
#
|
||
# cd extern/drgn/libdrgn
|
||
# autoreconf -i .
|
||
# autoreconf -i ./elfutils
|
||
# mkdir build
|
||
# cd build
|
||
# ../configure
|
||
# make
|
||
#
|
||
# Since setup.py has a single cmd to do this, just use it for now.
|
||
#
|
||
# Another extemely annoying point. drgn pretty much has to be compiled with gcc only
|
||
# clang-12 does NOT work. clang fails with the following error :-
|
||
# configure: error: gcc with GNU99 support required
|
||
|
||
set(DRGN_CONFIGURE_FLAGS "--with-libkdumpfile=no")
|
||
if (ASAN)
|
||
list(APPEND DRGN_CONFIGURE_FLAGS "--enable-asan=yes")
|
||
endif()
|
||
add_custom_target(libdrgn ALL
|
||
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/extern/drgn
|
||
COMMAND unset BISON_PKGDATADIR && CC=gcc CFLAGS="${DRGN_CFLAGS}" CONFIGURE_FLAGS="${DRGN_CONFIGURE_FLAGS}" ${PYTHON} ./setup.py build --build-temp build
|
||
BYPRODUCTS ${CMAKE_CURRENT_SOURCE_DIR}/extern/drgn/build/.libs/libdrgnimpl.a
|
||
${CMAKE_CURRENT_SOURCE_DIR}/extern/drgn/build/velfutils/libdw/libdw.a
|
||
${CMAKE_CURRENT_SOURCE_DIR}/extern/drgn/build/velfutils/libelf/libelf.a
|
||
${CMAKE_CURRENT_SOURCE_DIR}/extern/drgn/build/velfutils/libdwelf/libdwelf.a
|
||
COMMENT "Building drgn"
|
||
USES_TERMINAL
|
||
)
|
||
set(DRGN_PATH "${PROJECT_SOURCE_DIR}/extern/drgn/build")
|
||
|
||
# Ideally drgn stuff should be together at the end. But looks like rpath needs
|
||
# to be set before add_executable() unfortunately. Maybe split libdrgn stuff
|
||
# into a separate file later.
|
||
set(CMAKE_SKIP_BUILD_RPATH FALSE)
|
||
set(CMAKE_INSTALL_RPATH
|
||
"${DRGN_PATH}/.libs"
|
||
"${DRGN_PATH}/velfutils/libdw"
|
||
"${DRGN_PATH}/velfutils/libelf"
|
||
"${DRGN_PATH}/velfutils/libdwelf"
|
||
)
|
||
set(CMAKE_BUILD_RPATH
|
||
"${DRGN_PATH}/.libs"
|
||
"${DRGN_PATH}/velfutils/libdw"
|
||
"${DRGN_PATH}/velfutils/libelf"
|
||
"${DRGN_PATH}/velfutils/libdwelf"
|
||
)
|
||
set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
|
||
|
||
include_directories(SYSTEM "${DRGN_PATH}")
|
||
|
||
if (STATIC_LINK)
|
||
# glog links against the `gflags` target, which is an alias for `gflags_shared`
|
||
# For static builds, we force it to link against `gflags_static` instead
|
||
set_property(TARGET glog PROPERTY INTERFACE_LINK_LIBRARIES "gflags_static")
|
||
endif()
|
||
|
||
# FIXME: LLVM 12's source code is not compatible with C++20.
|
||
# We should check with the compiler team if we could apply a fix to our LLVM.
|
||
# In the meantime, we can compile OICompiler with C++17.
|
||
set_source_files_properties(oi/OICompiler.cpp PROPERTIES COMPILE_FLAGS -std=c++17 SKIP_PRECOMPILE_HEADERS ON)
|
||
|
||
|
||
|
||
## OI Dependencies (linked to by output libraries and executables)
|
||
### OI Language Parser
|
||
BISON_TARGET(Parser oi/OIParser.yy ${CMAKE_CURRENT_BINARY_DIR}/OIParser.tab.cpp
|
||
DEFINES_FILE ${CMAKE_CURRENT_BINARY_DIR}/OIParser.tab.hh)
|
||
FLEX_TARGET(Lexer oi/OILexer.l ${CMAKE_CURRENT_BINARY_DIR}/OILexer.cpp)
|
||
|
||
ADD_FLEX_BISON_DEPENDENCY(Lexer Parser)
|
||
|
||
add_library(oid_parser STATIC ${BISON_Parser_OUTPUTS} ${FLEX_Lexer_OUTPUTS})
|
||
target_compile_options(oid_parser PRIVATE "-w") # Disable warnings for generated code
|
||
target_link_libraries(oid_parser glog::glog)
|
||
|
||
### Core OI
|
||
|
||
include_directories(${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR})
|
||
add_subdirectory(oi)
|
||
add_subdirectory(resources)
|
||
add_library(oicore
|
||
oi/Descs.cpp
|
||
oi/Metrics.cpp
|
||
oi/OICache.cpp
|
||
oi/OICompiler.cpp
|
||
oi/OIUtils.cpp
|
||
oi/PaddingHunter.cpp
|
||
oi/Serialize.cpp
|
||
)
|
||
add_dependencies(oicore libdrgn)
|
||
target_include_directories(oicore SYSTEM PRIVATE ${LLVM_INCLUDE_DIRS} ${CLANG_INCLUDE_DIRS})
|
||
target_compile_definitions(oicore PRIVATE ${LLVM_DEFINITIONS})
|
||
target_include_directories(oicore PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
|
||
|
||
llvm_map_components_to_libnames(llvm_libs core native mcjit x86disassembler)
|
||
target_link_libraries(oicore
|
||
codegen
|
||
|
||
${Boost_LIBRARIES}
|
||
Boost::headers
|
||
glog::glog
|
||
resources
|
||
)
|
||
if (FORCE_LLVM_STATIC)
|
||
target_link_libraries(oicore
|
||
clangCodeGen
|
||
clangFrontend
|
||
)
|
||
else()
|
||
target_link_libraries(oicore
|
||
clang-cpp
|
||
)
|
||
endif()
|
||
# link the llvm_libs last as they must come after the clang dependencies in the
|
||
# linker order
|
||
if (FORCE_LLVM_STATIC)
|
||
target_link_libraries(oicore ${llvm_libs})
|
||
else()
|
||
target_link_libraries(oicore LLVM)
|
||
endif()
|
||
|
||
target_link_libraries(oicore
|
||
"-L${DRGN_PATH}/.libs"
|
||
drgn
|
||
dw
|
||
pthread
|
||
)
|
||
|
||
### TreeBuilder
|
||
add_library(treebuilder
|
||
oi/TreeBuilder.cpp
|
||
oi/exporters/TypeCheckingWalker.cpp
|
||
)
|
||
add_dependencies(treebuilder librocksdb)
|
||
target_link_libraries(treebuilder
|
||
${rocksdb_BINARY_DIR}/librocksdb.a
|
||
oicore # overkill but it does need a lot of stuff
|
||
zstd::zstd
|
||
)
|
||
|
||
|
||
|
||
## OI Outputs
|
||
### Object Introspection as a Library (OIL)
|
||
add_library(oil
|
||
oi/IntrospectionResult.cpp
|
||
oi/exporters/ParsedData.cpp
|
||
)
|
||
target_link_libraries(oil folly_headers)
|
||
target_include_directories(oil PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
|
||
|
||
add_library(oil_jit
|
||
oi/OILibrary.cpp
|
||
oi/OILibraryImpl.cpp
|
||
)
|
||
target_link_libraries(oil_jit oicore oil)
|
||
|
||
### Object Introspection as a Library Generator (OILGen)
|
||
add_executable(oilgen
|
||
tools/OILGen.cpp
|
||
oi/OIGenerator.cpp
|
||
)
|
||
target_link_libraries(oilgen
|
||
drgn_utils
|
||
oicore
|
||
)
|
||
|
||
### Object Introspection cache Printer (OIP)
|
||
add_executable(oip tools/OIP.cpp)
|
||
target_link_libraries(oip oicore)
|
||
|
||
### Object Introspection RocksDB Printer (OIRP)
|
||
add_executable(oirp tools/OIRP.cpp)
|
||
add_dependencies(oirp librocksdb)
|
||
target_link_libraries(oirp
|
||
${rocksdb_BINARY_DIR}/librocksdb.a
|
||
zstd::zstd
|
||
msgpackc
|
||
)
|
||
|
||
### Object Introspection Tree Builder (OITB)
|
||
add_executable(oitb tools/OITB.cpp)
|
||
target_link_libraries(oitb oicore treebuilder)
|
||
|
||
### Object Introspection Debugger (OID)
|
||
add_executable(oid oi/OID.cpp oi/OIDebugger.cpp)
|
||
|
||
target_link_libraries(oid oicore oid_parser treebuilder)
|
||
if (STATIC_LINK)
|
||
target_link_libraries(oid gflags_static)
|
||
else()
|
||
target_link_libraries(oid gflags_shared)
|
||
endif()
|
||
target_link_libraries(oid oicore treebuilder)
|
||
|
||
### Object Introspection Tests
|
||
if (WITH_TESTS)
|
||
add_subdirectory(test)
|
||
endif()
|
||
|
||
|
||
|
||
### Custom link options
|
||
if (STATIC_LINK)
|
||
target_link_libraries(oicore -static)
|
||
target_link_libraries(oil -static)
|
||
target_link_libraries(oip -static)
|
||
target_link_libraries(oid -static)
|
||
target_link_libraries(oitb -static)
|
||
endif()
|
||
|
||
# Add a hook for custom CMake rules
|
||
if (DEFINED ENV{CMAKE_HOOK})
|
||
include($ENV{CMAKE_HOOK})
|
||
endif()
|