[DRAFT] Minimize cuopt_static test linkage to avoid 5 GB package size explosion #1566
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| #!/bin/bash | ||
| # SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| set -eEuo pipefail | ||
|
|
||
| echo "checking for symbol visibility issues" | ||
|
|
||
| LIBRARY="${1}" | ||
|
|
||
| echo "" | ||
| echo "Checking exported symbols in '${LIBRARY}'" | ||
| symbol_file="$(mktemp)" | ||
| match_file="$(mktemp)" | ||
| trap 'rm -f "${symbol_file}" "${match_file}"' EXIT | ||
|
|
||
| # Ignore WEAK and UNIQUE symbols since UNIQUE symbols should be exported and | ||
| # WEAK symbols may come from template instantiations. | ||
| # Ignore symbols containing "_error" since these are likely exception types | ||
| # and should be exported. | ||
|
|
||
| readelf --dyn-syms --wide "${LIBRARY}" \ | ||
| | awk '$7 != "UND" && $5 != "WEAK" && $5 != "UNIQUE"' \ | ||
| | c++filt --no-params \ | ||
| | awk '$0 !~ /_error/' \ | ||
| > "${symbol_file}" | ||
|
|
||
| patterns=( | ||
| 'cub::' | ||
| 'thrust::' | ||
| 'raft::' | ||
| 'rmm::' | ||
| 'cuopt::mathematical_optimization::detail' | ||
| 'cuopt::routing::detail' | ||
| 'grpc::' | ||
| 'google::protobuf' | ||
| 'tbb::' | ||
| 'absl::' | ||
| 'dejavu::' | ||
| 'papilo::' | ||
| 'boost::' | ||
| 'pslp_' | ||
| ) | ||
|
|
||
| failed=0 | ||
|
|
||
| for pattern in "${patterns[@]}"; do | ||
| echo "Checking for '${pattern}' symbols..." | ||
|
|
||
| awk -v pattern="${pattern}" ' | ||
| BEGIN { has_trailing_scope = (substr(pattern, length(pattern) - 1) == "::") } | ||
| $1 ~ /^[0-9]+:/ { | ||
| symbol = "" | ||
| for (i = 8; i <= NF; ++i) { | ||
| symbol = symbol (i == 8 ? "" : " ") $i | ||
| } | ||
|
|
||
| sub(/<.*/, "", symbol) | ||
| sub(/^.*[[:space:]](for|to)[[:space:]]+/, "", symbol) | ||
|
|
||
| if (has_trailing_scope) { | ||
| matched = (index(symbol, pattern) == 1) | ||
| } else { | ||
| matched = (symbol == pattern || index(symbol, pattern "::") == 1) | ||
| } | ||
|
|
||
| if (matched) { print } | ||
| } | ||
| ' "${symbol_file}" > "${match_file}" | ||
|
|
||
| matches=$(awk 'END { print NR }' "${match_file}") | ||
| if [[ "${matches}" -ne 0 ]]; then | ||
| sed -n '1,20p' "${match_file}" | ||
| echo "ERROR: Found exported symbols in ${LIBRARY} matching the pattern ${pattern}." | ||
| echo "ERROR: Total matching symbols: ${matches}" | ||
| failed=1 | ||
| fi | ||
| done | ||
|
|
||
| if [[ "${failed}" -ne 0 ]]; then | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "No symbol visibility issues found in ${LIBRARY}" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| /* clang-format off */ | ||
| /* | ||
| * SPDX-FileCopyrightText: Copyright (c) 2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
| /* clang-format on */ | ||
|
|
||
| #pragma once | ||
|
|
||
| #if defined(__GNUC__) || defined(__clang__) | ||
| #define CUOPT_EXPORT __attribute__((visibility("default"))) | ||
| #else | ||
| #define CUOPT_EXPORT | ||
| #endif |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🌐 Web query:
readelf --dyn-syms symbol visibility naming convention exception types "_error" suffix💡 Result:
There is no single, universal naming convention in the ELF specification that mandates an "_error" suffix for symbols [1][2]. When you encounter a symbol with an "_error" suffix in the output of readelf --dyn-syms, it is typically a result of project-specific internal naming conventions rather than an ELF-level standard [3][4][5]. Naming Conventions and Exception Types: In large software projects like GNU Binutils or GDB, the "_error" suffix is frequently used as a naming convention to identify functions or variables responsible for handling, reporting, or defining error conditions [3][6][4][5]. For instance, GDB uses an "_ERROR" suffix for various exception types within its common-exceptions.h header to maintain naming consistency, even when the specific symbol is not strictly a fatal error [4][5]. Similarly, internal BFD (Binary File Descriptor) library functions—such as _bfd_x86_elf_link_report_tls_invalid_section_error—use this suffix to clearly denote their purpose in error reporting during the linking process [6]. Visibility and readelf --dyn-syms: The presence of such symbols in the dynamic symbol table (viewable via readelf --dyn-syms) indicates that these symbols are exported or required for dynamic linking [1]. In many cases, developers intentionally mark these internal symbols as hidden (using attributes like ATTRIBUTE_HIDDEN) to prevent them from being visible or preemptable outside of the library itself, even if they appear in the object file [3][6][7][8]. This practice reduces the size of the dynamic symbol table and improves encapsulation, effectively making them private to the DSO (Dynamic Shared Object) while keeping them accessible for internal build-time operations [3][7][8]. In summary, the "_error" suffix is a developer-chosen label for error-handling code, and its visibility in your dynamic symbol table is a separate characteristic managed by ELF symbol visibility attributes (such as STV_HIDDEN, STV_PROTECTED, or STV_DEFAULT) [6][1].
Citations:
🏁 Script executed:
Repository: NVIDIA/cuopt
Length of output: 185
🏁 Script executed:
Repository: NVIDIA/cuopt
Length of output: 50368
🏁 Script executed:
Repository: NVIDIA/cuopt
Length of output: 50368
ci/check_symbols.sh:25ignores too much.awk '$0 !~ /_error/'drops any demangled symbol containing_error, so public API names likeget_error_status,get_error_message, orlast_errornever reach the diff. Narrow this to the specific exception symbols you want to exempt.🤖 Prompt for AI Agents