Skip to content

Fix osx-dynamic install names for updated dependent shared library ids #39889

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.

Sign up for GitHub

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

Merged
BillyONeal merged 8 commits into from
Nov 28, 2024
Merged

Fix osx-dynamic install names for updated dependent shared library ids #39889

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bfeaae4
Fix osx-dynamic install names for updated dependent shared library ids
dcyruschow-cat Jul 12, 2024
5cfdd84
[vcpkg] Fix handling of macho file paths containing regex special cha…
dcyruschow-cat Jul 22, 2024
99ccc90
Add rpath tests for macho
m-kuhn Oct 16, 2024
f9dfb06
[vcpkg] Simplify fetching of ID returned from `otool -D <macho_file>`...
dcyruschow-cat Oct 23, 2024
95ed519
[vcpkg] extract z_vcpkg_regex_escape function for z_vcpkg_fixup_rpath…
dcyruschow-cat Nov 27, 2024
2bbba3b
[vcpkg] Add comment to z_vcpkg_fixup_macho_rpath_in_dir implementation
dcyruschow-cat Nov 28, 2024
2f70113
Merge branch 'microsoft:master' into fix_osx_dynamic_dependent_instal…
dcyruschow-cat Nov 28, 2024
f41bc39
[vcpkg] add exit code error handling to execute_process() calls in z_…
dcyruschow-cat Nov 28, 2024
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
54 changes: 53 additions & 1 deletion scripts/cmake/z_vcpkg_fixup_rpath_macho.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ function(z_vcpkg_fixup_macho_rpath_in_dir)
continue()
endif()

list(APPEND macho_executables_and_shared_libs "${macho_file}")

get_filename_component(macho_file_dir "${macho_file}" DIRECTORY)
get_filename_component(macho_file_name "${macho_file}" NAME)

Expand All @@ -106,7 +108,16 @@ function(z_vcpkg_fixup_macho_rpath_in_dir)
if("${file_type}" STREQUAL "shared")
# Set the install name for shared libraries
execute_process(
COMMAND "${install_name_tool_cmd}" -id "@rpath/${macho_file_name}" "${macho_file}"
COMMAND "${otool_cmd}" -D "${macho_file}"
OUTPUT_VARIABLE get_id_ov
RESULT_VARIABLE get_id_rv
)
if(NOT get_id_rv EQUAL 0)
message(FATAL_ERROR "Could not obtain install name id from '${macho_file}'")
endif()
set(macho_new_id "@rpath/${macho_file_name}")
execute_process(
COMMAND "${install_name_tool_cmd}" -id "${macho_new_id}" "${macho_file}"
OUTPUT_QUIET
ERROR_VARIABLE set_id_error
)
Expand All @@ -115,6 +126,11 @@ function(z_vcpkg_fixup_macho_rpath_in_dir)
message(WARNING "Couldn't adjust install name of '${macho_file}': ${set_id_error}")
continue()
endif()

string(REGEX REPLACE "${macho_file}:\n" "" get_id_ov "${get_id_ov}")
string(REGEX REPLACE "\n.*" "" get_id_ov "${get_id_ov}")
list(APPEND adjusted_shared_lib_old_ids "${get_id_ov}")
list(APPEND adjusted_shared_lib_new_ids "${macho_new_id}")
endif()

# Clear all existing rpaths
Expand Down Expand Up @@ -156,4 +172,40 @@ function(z_vcpkg_fixup_macho_rpath_in_dir)
message(STATUS "Adjusted RPATH of '${macho_file}' (To '${new_rpath}')")
endforeach()
endforeach()

# Check for dependent libraries in executables and shared libraries that
# need adjusting after id change
list(LENGTH adjusted_shared_lib_old_ids last_adjusted_index)
if(NOT last_adjusted_index EQUAL 0)
math(EXPR last_adjusted_index "${last_adjusted_index} - 1")
foreach(macho_file IN LISTS macho_executables_and_shared_libs)
execute_process(
COMMAND "${otool_cmd}" -L "${macho_file}"
OUTPUT_VARIABLE get_deps_ov
RESULT_VARIABLE get_deps_rv
)
if(NOT get_deps_rv EQUAL 0)
message(FATAL_ERROR "Could not obtain dependencies list from '${macho_file}'")
endif()
foreach(i RANGE ${last_adjusted_index})
Comment thread
dcyruschow-cat marked this conversation as resolved.
list(GET adjusted_shared_lib_old_ids ${i} adjusted_old_id)
Comment thread
BillyONeal marked this conversation as resolved.
if(NOT get_deps_ov MATCHES "[ \t]${adjusted_old_id} ")
continue()
endif()
list(GET adjusted_shared_lib_new_ids ${i} adjusted_new_id)

# Replace the old id with the new id
execute_process(
COMMAND "${install_name_tool_cmd}" -change "${adjusted_old_id}" "${adjusted_new_id}" "${macho_file}"
OUTPUT_QUIET
ERROR_VARIABLE change_id_error

@BillyONeal BillyONeal Nov 27, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Check exit code? (Or COMMAND_ERROR_IS_FATAL ?)

@dcyruschow-cat dcyruschow-cat Nov 27, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Sorry I'm new to using COMMAND_ERROR_IS_FATAL - if I add COMMAND_ERROR_IS_FATAL ANY would that make the check for change_id_error potentially redundant or I should have both checks in-case install_name_tool returns a 0 exit code but still prints something out to stderr?

@BillyONeal BillyONeal Nov 27, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

To be honest I haven't used COMMAND_ERROR_IS_FATAL yet either 😅. I was just looking at the docs to make sure I understood what you were doing and saw that there.

I don't know what "${install_name_tool_cmd}"'s behavior with respect to stderr and errors is; despite the name, stderr does not always mean 'all errors go here'. It originates from big iron in the 70s where you would have machine readable bits on and input and output tape, and anything you wanted to show to a human operator would be sent to a separate physical printer.

My comment is more like 'some of these commands' exit code is being checked and some of them aren't being checked, it seems like they should all be checked unless there is a specific reason not to'

@dcyruschow-cat dcyruschow-cat Nov 28, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

applied nitpicks.patch to f41bc39 (one of the nitpicks already applied via code suggestion in another comment).

)
if(NOT "${change_id_error}" STREQUAL "")
message(WARNING "Couldn't adjust dependent shared library install name in '${macho_file}': ${change_id_error}")
continue()
endif()
message(STATUS "Adjusted dependent shared library install name in '${macho_file}' (From '${adjusted_old_id}' -> To '${adjusted_new_id}')")
endforeach()
endforeach()
endif()
endfunction()