-
Notifications
You must be signed in to change notification settings - Fork 1.8k
[https://nvbugs/5453827][fix] Fix RPATH of th_common shared library to find pip-installed NCCL #6984
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
[https://nvbugs/5453827][fix] Fix RPATH of th_common shared library to find pip-installed NCCL #6984
Conversation
📝 WalkthroughWalkthroughRemoved special-case linker rpath flags and migrated runtime search paths to CMake BUILD_RPATH for non-Windows targets; and removed an AARCH64 gating block in Jenkins Changes
Sequence Diagram(s)sequenceDiagram
participant Jenkins as Jenkins pipeline
participant Launch as launchTestJobs
participant PipCheck as checkPipStage
Jenkins->>Launch: call launchTestJobs(cpu_arch, image)
alt Before PR
Launch->>PipCheck: if cpu_arch == AARCH64 && image != DLFW_IMAGE -> set false (skip)
PipCheck-->>Jenkins: pip-install sanity checks skipped
else After PR
Launch->>PipCheck: no AARCH64 special-case -> allow checks
PipCheck-->>Jenkins: run pip-install sanity checks
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: .coderabbit.yaml 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
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.
Actionable comments posted: 1
🧹 Nitpick comments (1)
cpp/tensorrt_llm/CMakeLists.txt (1)
297-299: Consider gating the NCCL subpath on NCCL usage to keep RPATH minimalIf NCCL is not linked (e.g., ENABLE_MULTI_DEVICE is OFF), embedding the NCCL directory in RPATH is unnecessary. Optional: add the NCCL rpath segment only when NCCL is enabled.
Happy to propose a small CMake snippet to conditionally append "$ORIGIN/../nvidia/nccl/lib" when ENABLE_MULTI_DEVICE is ON.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
cpp/tensorrt_llm/CMakeLists.txt(1 hunks)
🔇 Additional comments (2)
cpp/tensorrt_llm/CMakeLists.txt (2)
297-299: Sanity-check: $ORIGIN usage and generator-time evaluationUsing "$ORIGIN" as a literal here is correct (CMake won’t attempt to expand it). The semicolon-separated list is also appropriate (CMake will translate to colon-separated RPATH on ELF). No changes needed, just a checkmark.
297-299: No conflicting INSTALL_RPATH on${SHARED_TARGET}
A repo-wide search shows thatINSTALL_RPATHis only applied to thedeep_epanddeep_gemmlibraries—not to our${SHARED_TARGET}(tensorrt_llm). The shared target only has aBUILD_RPATHset (lines 297–299), so there are no conflicting install-time RPATH settings to worry about.
|
/bot run |
|
PR_Github #15633 [ run ] triggered by Bot |
|
PR_Github #15633 [ run ] completed with state |
a678367 to
1e771c2
Compare
|
/bot run |
|
PR_Github #15689 [ run ] triggered by Bot |
|
PR_Github #15689 [ run ] completed with state |
Signed-off-by: Yuan Tong <13075180+tongyuantongyu@users.noreply.github.com>
1e771c2 to
2c3fe80
Compare
|
/bot run |
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.
Actionable comments posted: 1
🧹 Nitpick comments (3)
cpp/tensorrt_llm/CMakeLists.txt (1)
257-263: Optional: Prefer target_link_options() over LINK_FLAGSModern CMake recommends target_link_options() instead of embedding flags via LINK_FLAGS on targets. Functionally equivalent here, but switching improves clarity and toolchain compatibility.
-set_target_properties( - ${SHARED_TARGET} - PROPERTIES CXX_STANDARD "17" CXX_STANDARD_REQUIRED "YES" CXX_EXTENSIONS "NO" - LINK_FLAGS "${AS_NEEDED_FLAG} ${UNDEFINED_FLAG}") +set_target_properties(${SHARED_TARGET} + PROPERTIES + CXX_STANDARD 17 + CXX_STANDARD_REQUIRED YES + CXX_EXTENSIONS NO) +target_link_options(${SHARED_TARGET} PRIVATE ${AS_NEEDED_FLAG} ${UNDEFINED_FLAG})cpp/tensorrt_llm/thop/CMakeLists.txt (2)
121-125: Optional hardening: add sibling-level NCCL path as a fallbackIf the thop .so location changes in future packaging, adding "$ORIGIN/../nvidia/nccl/lib" is a cheap safety net and mirrors the robustness suggested for the main library. Not required if the layout is stable.
set_target_properties( - th_common PROPERTIES BUILD_RPATH "$ORIGIN;$ORIGIN/../../nvidia/nccl/lib") + th_common PROPERTIES BUILD_RPATH "$ORIGIN;$ORIGIN/../nvidia/nccl/lib;$ORIGIN/../../nvidia/nccl/lib")
123-124: Optional: use target_link_options() for link flagsFor consistency with modern CMake:
-set_target_properties( - th_common PROPERTIES LINK_FLAGS "${AS_NEEDED_FLAG} ${UNDEFINED_FLAG}") +target_link_options(th_common PRIVATE ${AS_NEEDED_FLAG} ${UNDEFINED_FLAG})
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
cpp/tensorrt_llm/CMakeLists.txt(1 hunks)cpp/tensorrt_llm/thop/CMakeLists.txt(1 hunks)jenkins/L0_Test.groovy(0 hunks)
💤 Files with no reviewable changes (1)
- jenkins/L0_Test.groovy
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: tongyuantongyu
PR: NVIDIA/TensorRT-LLM#6984
File: cpp/tensorrt_llm/CMakeLists.txt:297-299
Timestamp: 2025-08-18T09:08:07.661Z
Learning: In the TensorRT-LLM project, artifacts are manually copied rather than installed via `cmake --install`, so INSTALL_RPATH properties are not needed - only BUILD_RPATH affects the final artifacts.
📚 Learning: 2025-08-18T09:08:07.661Z
Learnt from: tongyuantongyu
PR: NVIDIA/TensorRT-LLM#6984
File: cpp/tensorrt_llm/CMakeLists.txt:297-299
Timestamp: 2025-08-18T09:08:07.661Z
Learning: In the TensorRT-LLM project, artifacts are manually copied rather than installed via `cmake --install`, so INSTALL_RPATH properties are not needed - only BUILD_RPATH affects the final artifacts.
Applied to files:
cpp/tensorrt_llm/thop/CMakeLists.txtcpp/tensorrt_llm/CMakeLists.txt
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Pre-commit Check
🔇 Additional comments (1)
cpp/tensorrt_llm/thop/CMakeLists.txt (1)
121-125: LGTM: thop BUILD_RPATH includes pip NCCL path and flags moved out of rpathGood separation of concerns: BUILD_RPATH handles runtime search paths and LINK_FLAGS keeps only the link options. Including "$ORIGIN/../../nvidia/nccl/lib" matches the expected wheel layout for extension modules under tensorrt_llm/thop.
|
PR_Github #15750 [ run ] triggered by Bot |
|
PR_Github #15750 [ run ] completed with state |
|
/bot run --disable-fail-fast |
|
PR_Github #15841 [ run ] triggered by Bot |
|
/bot run --disable-fail-fast |
|
PR_Github #15894 [ run ] triggered by Bot |
|
PR_Github #15841 [ run ] completed with state |
|
PR_Github #15894 [ run ] completed with state |
|
/bot run |
|
PR_Github #15982 [ run ] triggered by Bot |
|
PR_Github #15982 [ run ] completed with state |
Summary by CodeRabbit
Description
Help
libtensorrt_llm.sofind pip-installed NCCL library.Test Coverage
GitHub Bot Help
/bot [-h] ['run', 'kill', 'skip', 'reuse-pipeline'] ...Provide a user friendly way for developers to interact with a Jenkins server.
Run
/bot [-h|--help]to print this help message.See details below for each supported subcommand.
run [--reuse-test (optional)pipeline-id --disable-fail-fast --skip-test --stage-list "A10-PyTorch-1, xxx" --gpu-type "A30, H100_PCIe" --test-backend "pytorch, cpp" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" --detailed-log --debug(experimental)]Launch build/test pipelines. All previously running jobs will be killed.
--reuse-test (optional)pipeline-id(OPTIONAL) : Allow the new pipeline to reuse build artifacts and skip successful test stages from a specified pipeline or the last pipeline if no pipeline-id is indicated. If the Git commit ID has changed, this option will be always ignored. The DEFAULT behavior of the bot is to reuse build artifacts and successful test results from the last pipeline.--disable-reuse-test(OPTIONAL) : Explicitly prevent the pipeline from reusing build artifacts and skipping successful test stages from a previous pipeline. Ensure that all builds and tests are run regardless of previous successes.--disable-fail-fast(OPTIONAL) : Disable fail fast on build/tests/infra failures.--skip-test(OPTIONAL) : Skip all test stages, but still run build stages, package stages and sanity check stages. Note: Does NOT update GitHub check status.--stage-list "A10-PyTorch-1, xxx"(OPTIONAL) : Only run the specified test stages. Examples: "A10-PyTorch-1, xxx". Note: Does NOT update GitHub check status.--gpu-type "A30, H100_PCIe"(OPTIONAL) : Only run the test stages on the specified GPU types. Examples: "A30, H100_PCIe". Note: Does NOT update GitHub check status.--test-backend "pytorch, cpp"(OPTIONAL) : Skip test stages which don't match the specified backends. Only support [pytorch, cpp, tensorrt, triton]. Examples: "pytorch, cpp" (does not run test stages with tensorrt or triton backend). Note: Does NOT update GitHub pipeline status.--only-multi-gpu-test(OPTIONAL) : Only run the multi-GPU tests. Note: Does NOT update GitHub check status.--disable-multi-gpu-test(OPTIONAL) : Disable the multi-GPU tests. Note: Does NOT update GitHub check status.--add-multi-gpu-test(OPTIONAL) : Force run the multi-GPU tests in addition to running L0 pre-merge pipeline.--post-merge(OPTIONAL) : Run the L0 post-merge pipeline instead of the ordinary L0 pre-merge pipeline.--extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx"(OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx".--detailed-log(OPTIONAL) : Enable flushing out all logs to the Jenkins console. This will significantly increase the log volume and may slow down the job.--debug(OPTIONAL) : Experimental feature. Enable access to the CI container for debugging purpose. Note: Specify exactly one stage in thestage-listparameter to access the appropriate container environment. Note: Does NOT update GitHub check status.For guidance on mapping tests to stage names, see
docs/source/reference/ci-overview.mdand the
scripts/test_to_stage_mapping.pyhelper.kill
killKill all running builds associated with pull request.
skip
skip --comment COMMENTSkip testing for latest commit on pull request.
--comment "Reason for skipping build/test"is required. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.reuse-pipeline
reuse-pipelineReuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.