Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[vcpkg] Fixup rpath after building dynamic libraries on linux #23035

Merged
merged 3 commits into from
Jul 18, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions scripts/cmake/vcpkg_find_acquire_program.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,24 @@ function(vcpkg_find_acquire_program program)
set(apt_package_name pkg-config)
set(paths_to_search "/bin" "/usr/bin" "/usr/local/bin")
endif()
elseif(program STREQUAL "PATCHELF")
set(program_name patchelf)
set(program_version 0.14.5)
set(supported_on_unix ON)
if(CMAKE_HOST_SYSTEM_NAME STREQUAL "Linux")
if(HOST_ARCH STREQUAL "aarch64")
set(patchelf_platform "aarch64")
set(download_sha512 "3B5EB4405FAB1D5202728AA390DD9F059CD7AFD582BAD9C50383CAD605127BC77DFCE3F2F26E9714F6BD5CCFFD49D3973BA2F061D2E2931B6E1BD0C263B99E75")
else()
set(patchelf_platform "x86_64")
set(download_sha512 "5E983A25B3F3F3B8582D1DE6C7DE30812E8D6E58E96F711F33A2634D3FB1F2370531DA179927AA401328319F92465E6F76274A6F994D1DC54C74B98E704D0D29")
endif()
set(download_filename "${program_name}-${program_version}-${patchelf_platform}.tar.gz")
set(download_urls "https://github.com/NixOS/patchelf/releases/download/${program_version}/${download_filename}")
set(tool_subdirectory "${program_version}-${patchelf_platform}-linux")
set(paths_to_search "${DOWNLOADS}/tools/patchelf/${program_version}-${patchelf_platform}-linux/bin")
endif()
set(version_command --version)
else()
message(FATAL "unknown tool ${program} -- unable to acquire.")
endif()
Expand Down
57 changes: 57 additions & 0 deletions scripts/cmake/z_vcpkg_fixup_rpath.cmake
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
function(z_vcpkg_fixup_rpath_in_dir)
vcpkg_find_acquire_program(PATCHELF)

# We need to iterate trough everything because we
# can't predict where an elf file will be located
file(GLOB root_entries LIST_DIRECTORIES TRUE "${CURRENT_PACKAGES_DIR}/*")

# Skip some folders for better throughput
list(APPEND folders_to_skip "include")
list(JOIN folders_to_skip "|" folders_to_skip_regex)
set(folders_to_skip_regex "^(${folders_to_skip_regex})$")

foreach(folder IN LISTS root_entries)
if(NOT IS_DIRECTORY "${folder}")
continue()
endif()

get_filename_component(folder_name "${folder}" NAME)
if(folder_name MATCHES "${folders_to_skip_regex}")
continue()
endif()

file(GLOB_RECURSE elf_files LIST_DIRECTORIES FALSE "${folder}/*")
foreach(elf_file IN LISTS elf_files)
if(IS_SYMLINK "${elf_file}")
continue()
endif()

get_filename_component(elf_file_dir "${elf_file}" DIRECTORY)

set(current_prefix "${CURRENT_PACKAGES_DIR}")
if(elf_file_dir MATCHES "debug/")
set(current_prefix "${CURRENT_PACKAGES_DIR}/debug")
endif()

# compute path relative to lib
file(RELATIVE_PATH relative_to_lib "${elf_file_dir}" "${current_prefix}/lib")
if(relative_to_lib STREQUAL "")
set(rpath "\$ORIGIN")
else()
set(rpath "\$ORIGIN:\$ORIGIN/${relative_to_lib}")
endif()

# If this fails, the file is not an elf
execute_process(
COMMAND "${PATCHELF}" --set-rpath "${rpath}" "${elf_file}"
OUTPUT_QUIET
ERROR_VARIABLE set_rpath_error
)
if("${set_rpath_error}" STREQUAL "")
message(STATUS "Fixed rpath: ${elf_file} (${rpath})")
endif()
endforeach()
endforeach()
endfunction()

z_vcpkg_fixup_rpath_in_dir()
3 changes: 3 additions & 0 deletions scripts/ports.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,9 @@ if(CMD STREQUAL "BUILD")

include("${CURRENT_PORT_DIR}/portfile.cmake")
if(DEFINED PORT)
if(VCPKG_FIXUP_ELF_RPATH)
include("${SCRIPTS}/cmake/z_vcpkg_fixup_rpath.cmake")
endif()
include("${SCRIPTS}/build_info.cmake")
endif()
elseif(CMD STREQUAL "CREATE")
Expand Down
7 changes: 7 additions & 0 deletions triplets/community/x64-linux-dynamic.cmake
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
set(VCPKG_TARGET_ARCHITECTURE x64)
set(VCPKG_CRT_LINKAGE dynamic)
set(VCPKG_LIBRARY_LINKAGE dynamic)

set(VCPKG_CMAKE_SYSTEM_NAME Linux)

set(VCPKG_FIXUP_ELF_RPATH ON)
1 change: 1 addition & 0 deletions triplets/x64-linux.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ set(VCPKG_LIBRARY_LINKAGE static)

set(VCPKG_CMAKE_SYSTEM_NAME Linux)

set(VCPKG_FIXUP_ELF_RPATH ON)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is needed because some ports have set(VCPKG_LIBRARY_LINKAGE dynamic) in their portfiles.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't this be automatically ON if VCPKG_LIBRARY_LINKAGE is dynamic ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how to reliably check for that.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this effectively changes the produced binaries we want it to be an explicit setting even if it is something that the user would actually want to enable every time

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about enabling this on x64-linux (if we do, then the world rebuild is warranted)

@ras0219-msft @BillyONeal thoughts?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't mind moving this change to a separate PR, to be able to postpone the changes until a real world rebuild is required.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about enabling this on x64-linux (if we do, then the world rebuild is warranted)

x64-linux is a static triplet so I don't think we really need to go there but I don't feel strongly about it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed that executables work with relocated installed/ folder and when shared libraries are located side-by-side 🎉

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Osyotr I think we're ready to merge this PR if this change is reverted.

We can always make this on-by-default and enable it in static triplet in a future change if we wanted to.