admin/revng-revng
1
0
Fork 0
mirror of https://github.com/revng/revng synced 2026-06-21 14:07:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
revng-revng/CMakeLists.txt
T
Alessandro Di Federico 1429b526ab Introduce libtcg 
This commit drops libptc in favor of its new form libtcg.

It brings several improvements, among which:

* The QEMU version we work on has been upgraded.
* CPUStateAccessAnalysis has been reimplemented in a way that makes it
  easier to debug and solves some limitations (e.g., tracking leaking
  pointers).
* Identification of pieces of the CPU state that are read by each helper
  and fixing access to the CPU state is now performed at build-time.
* We no longer mmap the code we need to translate, dropping all the
  issues related to code that needed to be mapped where something is
  already present.
* We now have two distinct flavors of helper modules: the full one and
  the "slim" one. The latter contains the definition only of functions
  we intend to inline. It is used in most of the pipeline, a good thing
  since we spend less time optimizing code we don't really care about.
  The full module is only used on the re-compilation branch of the
  pipeline.
* We no longer split the `cpu_loop` function.
* We change MetaAddress to rely on architectures from `model::` as
  opposed to the LLVM ones.
* We no longer attach debug info to LLVM IR containing the original
  assembly.
* We now verify that the lifted code only contains code we expect.
2025-10-31 17:25:03 +01:00

403 lines
14 KiB
CMake
Raw Permalink Blame History

#
# This file is distributed under the MIT License. See LICENSE.md for details.
#
cmake_minimum_required(VERSION 3.15.0)
project(revng)
include(share/revng/cmake/Common.cmake)
find_program(CLANG_PATH NAMES clang)
#
# Compile flags
#
# These have to be first to get highest priority
include_directories("${CMAKE_SOURCE_DIR}/include")
include_directories("${CMAKE_BINARY_DIR}/include")
add_definitions("-DINSTALL_PATH=\"${CMAKE_INSTALL_PREFIX}\"")
# Uncomment the following line if recursive coroutines make debugging hard
# add_definitions("-DDISABLE_RECURSIVE_COROUTINES")
# Remove -rdynamic
set(CMAKE_SHARED_LIBRARY_LINK_C_FLAGS)
# Basic compiler options
# cmake-format: off
# set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=address -shared-libasan")
# cmake-format: on
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++20")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wextra")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-rtti")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-exceptions")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fvisibility-inlines-hidden")
set(CMAKE_POSITION_INDEPENDENT_CODE ON)
# set(TUPLE_TREE_GENERATOR_EMIT_TRACKING_DEBUG ON)
if(${TUPLE_TREE_GENERATOR_EMIT_TRACKING_DEBUG})
set(CMAKE_CXX_FLAGS
"${CMAKE_CXX_FLAGS} -DTUPLE_TREE_GENERATOR_EMIT_TRACKING_DEBUG")
endif()
# Uncomment the following line if errors like `Couldn't find method
# SomeType::method` make debugging hard
#
# set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fno-limit-debug-info")
if(CMAKE_BUILD_TYPE STREQUAL "Release")
add_flag_if_available("-Wno-unused-local-typedefs")
endif()
# Disable some warnings
add_flag_if_available("-Wno-unused-parameter")
add_flag_if_available("-Wno-unused-variable")
add_flag_if_available("-Wno-maybe-uninitialized")
add_flag_if_available("-Wno-init-list-lifetime")
add_flag_if_available("-Wno-ambiguous-reversed-operator")
# Add some extra warnings
add_flag_if_available("-Wstrict-aliasing")
add_flag_if_available("-fstrict-aliasing")
add_flag_if_available("-Wnon-virtual-dtor")
add_flag_if_available("-Wunreachable-code-break")
add_flag_if_available("-Winconsistent-missing-destructor-override")
add_flag_if_available("-Wnewline-eof")
add_flag_if_available("-Wmissing-prototypes")
add_flag_if_available("-Wimplicit-fallthrough")
add_definitions("-D_FILE_OFFSET_BITS=64")
check_cxx_compiler_flag("-no-pie" COMPILER_SUPPORTS_NO_PIE)
if(COMPILER_SUPPORTS_NO_PIE)
set(NO_PIE "-no-pie")
endif()
include(CheckIncludeFiles)
check_include_files(valgrind/callgrind.h HAVE_VALGRIND_CALLGRIND_H)
if(HAVE_VALGRIND_CALLGRIND_H)
add_definitions("-DHAVE_VALGRIND_CALLGRIND_H")
endif()
#
# Link LLVM
#
find_package(LLVM REQUIRED CONFIG)
include_directories(${LLVM_INCLUDE_DIRS})
add_definitions(${LLVM_DEFINITIONS})
link_directories(${LLVM_LIBRARY_DIRS})
llvm_map_components_to_libnames(
LLVM_LIBRARIES
core
support
irreader
ScalarOpts
linker
Analysis
object
transformutils
BitWriter
BitReader
InstCombine
CodeGen
Passes
TargetParser)
# MLIR CMake stuff
find_package(MLIR REQUIRED CONFIG)
include_directories(${MLIR_INCLUDE_DIRS})
#
# Link Clang
#
find_package(Clang REQUIRED CONFIG)
#
# Component hash
#
file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/share/revng/component-hashes")
set(COMPONENT_HASH_PATH
"${CMAKE_BINARY_DIR}/share/revng/component-hashes/revng")
add_custom_command(
OUTPUT "${COMPONENT_HASH_PATH}"
COMMAND
sh -c
' (git -C "${CMAKE_SOURCE_DIR}" rev-parse HEAD || echo "\"${CMAKE_PROJECT_VERSION}\"") '
> "${COMPONENT_HASH_PATH}")
add_custom_target(generate-component-hash ALL DEPENDS "${COMPONENT_HASH_PATH}")
install(FILES "${COMPONENT_HASH_PATH}"
DESTINATION "${CMAKE_INSTALL_DIR}/share/revng/component-hashes/")
#
# share/revng
#
add_custom_target(copy_share ALL COMMAND cp -Tar "${CMAKE_SOURCE_DIR}/share/"
"${CMAKE_BINARY_DIR}/share/")
install(
DIRECTORY "${CMAKE_BINARY_DIR}/share/"
DESTINATION share/
USE_SOURCE_PERMISSIONS)
# Export CMake targets
install(
EXPORT revng
NAMESPACE DESTINATION
share/revng/cmake)
# Create share/revng/additional-bin-paths
set(ADDITIONAL_BIN_PATHS "${CMAKE_BINARY_DIR}/share/revng/additional-bin-paths")
file(WRITE "${ADDITIONAL_BIN_PATHS}" "libexec/revng\n")
file(RELATIVE_PATH RELATIVE_LLVM_TOOLS_BINARY_DIR "${CMAKE_INSTALL_PREFIX}"
"${LLVM_TOOLS_BINARY_DIR}")
file(APPEND "${ADDITIONAL_BIN_PATHS}" "${RELATIVE_LLVM_TOOLS_BINARY_DIR}\n")
# Create additional-search-prefixes
file(WRITE "${CMAKE_BINARY_DIR}/additional-search-prefixes"
"${CMAKE_INSTALL_PREFIX}\n")
file(RELATIVE_PATH RELATIVE_LLVM_TOOLS_BINARY_DIR "${CMAKE_INSTALL_PREFIX}"
"${LLVM_TOOLS_BINARY_DIR}")
file(APPEND "${ADDITIONAL_BIN_PATHS}" "${RELATIVE_LLVM_TOOLS_BINARY_DIR}\n")
# Build the support module for each architecture and in several configurations
set(SUPPORT_MODULES_CONFIGS "normal;trace")
set(SUPPORT_MODULES_CONFIG_normal "")
set(SUPPORT_MODULES_CONFIG_trace "-DTRACE")
# A set of llvm modules that contain all the known helpers.
set(HELPER_MODULE_LIST, "")
foreach(
ARCH
aarch64
arm
mips
mipsel
x86_64
i386
s390x)
set(OUTPUT "early-linked-${ARCH}.ll")
add_custom_command(
OUTPUT "${CMAKE_BINARY_DIR}/share/revng/${OUTPUT}"
DEPENDS "${CMAKE_SOURCE_DIR}/share/revng/early-linked.c"
COMMAND
${TARGET_CLANG} ARGS "${CMAKE_SOURCE_DIR}/share/revng/early-linked.c" -o
"${CMAKE_BINARY_DIR}/share/revng/${OUTPUT}" -S -emit-llvm -g
-DTARGET_${ARCH} -I"${CMAKE_SOURCE_DIR}/share/revng"
-I"${CMAKE_CURRENT_SOURCE_DIR}/include")
add_custom_target("early-linked-module-${OUTPUT}" ALL
DEPENDS "${CMAKE_BINARY_DIR}/share/revng/${OUTPUT}")
add_dependencies(revng-all-binaries "early-linked-module-${OUTPUT}")
list(APPEND HELPER_MODULE_LIST "${CMAKE_BINARY_DIR}/share/revng/${OUTPUT}")
# Enable the support for C exceptions to avoid optimizations that break
# exception support when linking a module with isolated functions
foreach(CONFIG ${SUPPORT_MODULES_CONFIGS})
set(OUTPUT "support-${ARCH}-${CONFIG}.ll")
add_custom_command(
OUTPUT "${CMAKE_BINARY_DIR}/share/revng/${OUTPUT}"
DEPENDS "${CMAKE_SOURCE_DIR}/share/revng/support.c"
COMMAND
${TARGET_CLANG} ARGS "${CMAKE_SOURCE_DIR}/share/revng/support.c" -O2
-fexceptions -o "${CMAKE_BINARY_DIR}/share/revng/${OUTPUT}" -S
-emit-llvm -g -DTARGET_${ARCH} -I"${CMAKE_SOURCE_DIR}/share/revng"
-I"${CMAKE_CURRENT_SOURCE_DIR}/include"
${SUPPORT_MODULES_CONFIG_${CONFIG}})
add_custom_target("support-module-${OUTPUT}" ALL
DEPENDS "${CMAKE_BINARY_DIR}/share/revng/${OUTPUT}")
add_dependencies(revng-all-binaries "support-module-${OUTPUT}")
list(APPEND HELPER_MODULE_LIST "${CMAKE_BINARY_DIR}/share/revng/${OUTPUT}")
endforeach()
# Annotate libtcg-helpers-*.bc
set(LIBTCG_HELPERS
"${CMAKE_INSTALL_PREFIX}/share/libtcg/libtcg-helpers-${ARCH}.bc")
set(LIBTCG_HELPERS_ANNOTATED
"${CMAKE_BINARY_DIR}/share/revng/libtcg-helpers-annotated-${ARCH}.bc")
add_custom_command(
OUTPUT "${LIBTCG_HELPERS_ANNOTATED}"
DEPENDS "${LIBTCG_HELPERS}" revng-all-binaries
COMMAND
./bin/revng opt -sroa -instsimplify -cpu-loop-exit
-analyze-helper-arguments -fix-helpers
-fix-helpers-architecture="${ARCH}" "${LIBTCG_HELPERS}" -o
"${LIBTCG_HELPERS_ANNOTATED}")
add_custom_target("annotated-libtcg-helpers-${ARCH}" ALL
DEPENDS "${LIBTCG_HELPERS_ANNOTATED}")
# Drop all the functions *not* tagged with revng_inline
set(LIBTCG_HELPERS_ANNOTATED_SLIM
"${CMAKE_BINARY_DIR}/share/revng/libtcg-helpers-annotated-slim-${ARCH}.bc"
)
add_custom_command(
OUTPUT "${LIBTCG_HELPERS_ANNOTATED_SLIM}"
DEPENDS "${LIBTCG_HELPERS_ANNOTATED}" revng-all-binaries
COMMAND ./bin/revng opt -slim-down-helpers-module -globaldce
"${LIBTCG_HELPERS_ANNOTATED}" -o "${LIBTCG_HELPERS_ANNOTATED_SLIM}")
add_custom_target("annotated-libtcg-helpers-slim-${ARCH}" ALL
DEPENDS "${LIBTCG_HELPERS_ANNOTATED_SLIM}")
list(APPEND HELPER_MODULE_LIST "${LIBTCG_HELPERS_ANNOTATED_SLIM}")
endforeach()
# Produce well-known-models
add_custom_target(well-known-binaries ALL)
foreach(WELL_KNOWN_BINARY IN LISTS WELL_KNOWN_BINARIES)
get_filename_component(BASENAME "${WELL_KNOWN_BINARY}" NAME)
set(MODEL_PATH "share/revng/well-known-models/${BASENAME}.yml")
set(FULL_MODEL_PATH "${CMAKE_BINARY_DIR}/${MODEL_PATH}")
add_custom_command(
OUTPUT "${FULL_MODEL_PATH}"
COMMAND "./bin/revng" analyze import-binary -o "${FULL_MODEL_PATH}"
"${WELL_KNOWN_BINARY}"
MAIN_DEPENDENCY "${WELL_KNOWN_BINARY}"
DEPENDS revng-all-binaries generate-revngModel-tuple-tree-code
generate-revngPipeline-tuple-tree-code
WORKING_DIRECTORY "${CMAKE_BINARY_DIR}")
add_custom_target("import-${BASENAME}" DEPENDS "${FULL_MODEL_PATH}")
add_dependencies(well-known-binaries "import-${BASENAME}")
endforeach()
# Custom command to create .clang-format file from revng-check-conventions
add_custom_command(
OUTPUT "${CMAKE_BINARY_DIR}/share/revng/.clang-format"
DEPENDS "${CMAKE_SOURCE_DIR}/libexec/revng/check-conventions"
"${CMAKE_SOURCE_DIR}/share/revng/clang-format-style-file.yml"
copy_share copy_libexec
COMMAND
"${CMAKE_BINARY_DIR}/libexec/revng/check-conventions" ARGS
--print-clang-format-config >
"${CMAKE_BINARY_DIR}/share/revng/.clang-format")
add_custom_target(clang-format-dot-file ALL
DEPENDS "${CMAKE_BINARY_DIR}/share/revng/.clang-format")
#
# libexec/revng
#
add_custom_target(
copy_libexec ALL COMMAND cp -Tar "${CMAKE_SOURCE_DIR}/libexec/"
"${CMAKE_BINARY_DIR}/libexec/")
install(
DIRECTORY "${CMAKE_BINARY_DIR}/libexec/"
DESTINATION libexec/
USE_SOURCE_PERMISSIONS)
#
# Export information useful for subdirectories
#
set(PYTHON_GENERATED_MODEL_PATH revng/model/_generated.py)
#
# Enable CTest
#
enable_testing()
#
# Find Python using the FindPython module. We request two components: *
# Interpreter: needed for some variables, such as $Python_SITELIB * Development:
# needed to compile nanobind module and friends, provides the
# $Python_INCLUDE_DIRS and $Python_LIBRARIES variables
#
find_package(
Python
COMPONENTS Interpreter Development
REQUIRED)
file(RELATIVE_PATH PYTHON_INSTALL_PATH "${CMAKE_INSTALL_PREFIX}"
"${Python_SITELIB}")
#
# Build docs
#
configure_file(mkdocs.yml "${CMAKE_BINARY_DIR}" COPYONLY)
set(HTML_DOCS_PATH "${CMAKE_CURRENT_BINARY_DIR}/share/doc/revng/html")
find_program(MKDOCS NAMES mkdocs)
add_custom_command(
OUTPUT share/doc/revng/html/404.html
DEPENDS mkdocs.yml
copy_share
"share/doc/revng/references/abi-definition.md"
"share/doc/revng/references/mime-types.md"
"share/doc/revng/references/ptml.md"
"share/doc/revng/references/cli/revng-common.md"
"share/doc/revng/references/cli/revng-artifact.md"
"share/doc/revng/references/cli/revng-analyze.md"
"share/doc/revng/user-manual/index.md"
"share/doc/revng/user-manual/initial-setup.md"
"share/doc/revng/user-manual/key-concepts/metaaddress.md"
"share/doc/revng/user-manual/key-concepts/model.md"
"share/doc/revng/user-manual/key-concepts/artifacts-and-analyses.md"
"share/doc/revng/user-manual/tutorial/model-from-scratch.md"
"share/doc/revng/user-manual/tutorial/running-analyses.md"
"share/doc/revng/what-is-revng.md"
"share/doc/revng/index.md"
generate-revngModel-tuple-tree-code
generate-revngPipeline-tuple-tree-code
python/revng/internal/cli/_commands/process_docs_yaml/pipeline.md.tpl
python/revng/internal/cli/_commands/process_docs_yaml/artifacts.md.tpl
python/revng/internal/cli/_commands/process_docs_yaml/analyses.md.tpl
python/revng/internal/cli/_commands/process_docs_yaml/common.md.tpl
share/revng/pipelines/revng-pipelines.yml
WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
COMMAND
"./bin/revng" process-docs-yaml
"${CMAKE_SOURCE_DIR}/python/revng/internal/cli/_commands/process_docs_yaml/pipeline.md.tpl"
< "${CMAKE_SOURCE_DIR}/share/revng/pipelines/revng-pipelines.yml" >
share/doc/revng/references/pipeline.md
COMMAND
"./bin/revng" process-docs-yaml
"${CMAKE_SOURCE_DIR}/python/revng/internal/cli/_commands/process_docs_yaml/analyses.md.tpl"
< "${CMAKE_SOURCE_DIR}/share/revng/pipelines/revng-pipelines.yml" >
share/doc/revng/references/analyses.md
COMMAND
"./bin/revng" process-docs-yaml
"${CMAKE_SOURCE_DIR}/python/revng/internal/cli/_commands/process_docs_yaml/artifacts.md.tpl"
< "${CMAKE_SOURCE_DIR}/share/revng/pipelines/revng-pipelines.yml" >
share/doc/revng/references/artifacts.md
COMMAND ${MKDOCS} build --quiet --strict --site-dir mkdocs-output
COMMAND rm -rf "${HTML_DOCS_PATH}"
COMMAND mv -T mkdocs-output "${HTML_DOCS_PATH}"
COMMENT "Generating mkdocs")
add_custom_target(mkdocs ALL DEPENDS share/doc/revng/html/404.html)
#
# Gather helper names
#
add_custom_command(
OUTPUT "${CMAKE_BINARY_DIR}/share/revng/helper-list.csv"
COMMAND
${CMAKE_SOURCE_DIR}/scripts/extract-helper-names.sh ${HELPER_MODULE_LIST} >
"${CMAKE_BINARY_DIR}/share/revng/helper-list.csv"
DEPENDS copy_share ${HELPER_MODULE_LIST})
add_custom_target(helper-list ALL
DEPENDS "${CMAKE_BINARY_DIR}/share/revng/helper-list.csv")
#
# Proceed to subdirectories
#
add_subdirectory(docs)
add_subdirectory(include)
add_subdirectory(lib)
add_subdirectory(python)
add_subdirectory(tests)
add_subdirectory(tools)
add_subdirectory(typescript)
Reference in New Issue View Git Blame Copy Permalink