mirror of
https://github.com/XRPLF/rippled.git
synced 2026-10-10 05:38:10 +00:00
ede8af8191
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
91 lines
3.2 KiB
CMake
91 lines
3.2 KiB
CMake
#[===================================================================[
|
|
Patch executables to run in non-Nix environments.
|
|
|
|
The Nix toolchain links binaries against an ELF interpreter (loader)
|
|
that lives in the Nix store, so the resulting binaries don't run elsewhere
|
|
(including once installed from the .deb package). `patch_nix_binary` resets
|
|
the interpreter to the system default loader and drops the rpath, once the
|
|
binary has been linked.
|
|
|
|
This runs by default for Nix-toolchain builds (determined by whether the compiler resolves under /nix/store/).
|
|
Those builds are where binaries get a Nix-store loader.
|
|
It is opted out of by setting the XRPLD_NO_PATCH_NIX_BINARY environment variable —
|
|
the plain Nix dev shells set it, since their binaries link a newer glibc
|
|
and must not be retargeted to the system loader.
|
|
|
|
Non-Nix builds (a system compiler, already using the system loader) and sanitizer builds
|
|
(runtime libraries resolved through the rpath) are skipped too.
|
|
Everywhere else `patch_nix_binary` is a no-op.
|
|
|
|
The default loader is resolved by bin/nix/default-loader-path.sh.
|
|
#]===================================================================]
|
|
|
|
include_guard(GLOBAL)
|
|
|
|
include(CompilationEnv)
|
|
|
|
# Resolves the system default ELF loader path for the current architecture.
|
|
set(_loader_path_script "${CMAKE_SOURCE_DIR}/bin/nix/default-loader-path.sh")
|
|
|
|
if(
|
|
is_linux
|
|
AND NOT SANITIZERS_ENABLED
|
|
AND is_nix_compiler
|
|
AND NOT DEFINED ENV{XRPLD_NO_PATCH_NIX_BINARY}
|
|
)
|
|
execute_process(
|
|
COMMAND "${_loader_path_script}"
|
|
OUTPUT_VARIABLE DEFAULT_LOADER_PATH
|
|
OUTPUT_STRIP_TRAILING_WHITESPACE
|
|
COMMAND_ERROR_IS_FATAL ANY
|
|
)
|
|
find_program(PATCHELF_COMMAND patchelf REQUIRED)
|
|
set(PATCH_NIX_BINARIES TRUE)
|
|
message(
|
|
STATUS
|
|
"Binaries will be patched to use loader '${DEFAULT_LOADER_PATH}'"
|
|
)
|
|
else()
|
|
set(PATCH_NIX_BINARIES FALSE)
|
|
endif()
|
|
|
|
function(patch_nix_binary target)
|
|
if(NOT PATCH_NIX_BINARIES)
|
|
return()
|
|
endif()
|
|
|
|
set(patch_command
|
|
"${PATCHELF_COMMAND}"
|
|
--set-interpreter
|
|
"${DEFAULT_LOADER_PATH}"
|
|
--remove-rpath
|
|
"$<TARGET_FILE:${target}>"
|
|
)
|
|
set(comment "Patching ${target}: set default loader, remove rpath")
|
|
|
|
# POST_BUILD is the cheap way to do this: it runs only when the binary is
|
|
# relinked. It is also only available in the directory that defined the
|
|
# target, so for a target from elsewhere (e.g. a FetchContent subproject)
|
|
# fall back to a custom target that runs after the binary is linked. That
|
|
# one runs on every build, which is harmless because patchelf is idempotent.
|
|
get_target_property(target_source_dir ${target} SOURCE_DIR)
|
|
if("${target_source_dir}" STREQUAL "${CMAKE_CURRENT_SOURCE_DIR}")
|
|
add_custom_command(
|
|
TARGET ${target}
|
|
POST_BUILD
|
|
COMMAND ${patch_command}
|
|
COMMENT "${comment}"
|
|
VERBATIM
|
|
)
|
|
else()
|
|
add_custom_target(
|
|
${target}-patch-nix
|
|
ALL
|
|
COMMAND ${patch_command}
|
|
COMMENT "${comment}"
|
|
VERBATIM
|
|
)
|
|
add_dependencies(${target}-patch-nix ${target})
|
|
endif()
|
|
endfunction()
|