KEMBAR78
[None][chore] Only check the bindings lib for current build by liji-nv · Pull Request #7026 · NVIDIA/TensorRT-LLM · GitHub
Skip to content

Conversation

@liji-nv
Copy link
Collaborator

@liji-nv liji-nv commented Aug 19, 2025

Summary by CodeRabbit

  • Bug Fixes

    • Reduced Linux install/runtime errors by accurately detecting and handling missing shared libraries per dependency.
    • Improved reliability of native binding installation, minimizing “library not found” issues.
  • Chores

    • Streamlined packaging flow for native components, installing the correct library directory rather than a single file.
    • More robust Python stub generation aligned with the actual binding library.
    • Clearer diagnostics during build to surface missing dependencies early, improving cross-distro compatibility.

Description

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 the stage-list parameter 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.md
and the scripts/test_to_stage_mapping.py helper.

kill

kill

Kill all running builds associated with pull request.

skip

skip --comment COMMENT

Skip 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-pipeline

Reuse 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.

Signed-off-by: Jin Li <59594262+liji-nv@users.noreply.github.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 19, 2025

📝 Walkthrough

Walkthrough

Refactors missing-library detection to accept an explicit library name and parse ldd output. Updates Linux stub generation to accept and propagate the binding library name, adjusts installation to use the binding library directory, and updates call sites accordingly. Public function signatures are modified to include the new parameters.

Changes

Cohort / File(s) Summary
Build script: missing-lib detection and stub generation
scripts/build_wheel.py
- check_missing_libs now takes lib_name and runs ldd on that exact library; extracts unique “not found” libs.
- generate_python_stubs_linux adds binding_lib_name parameter and uses it to call check_missing_libs.
- Installation logic derives binding_lib_dir and installs the directory, not a single file path.
- Call site passes binding_lib_file_name into generate_python_stubs_linux.
- Updated public signatures accordingly.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Dev as Build Invoker
  participant BW as build_wheel.py
  participant GL as generate_python_stubs_linux()
  participant CML as check_missing_libs()
  participant ldd as System ldd

  Dev->>BW: Run build process
  BW->>GL: generate_python_stubs_linux(binding_type, venv_python, deep_ep, binding_lib_name)
  note right of GL: Uses binding_lib_name to verify deps

  GL->>CML: check_missing_libs(binding_lib_name)
  CML->>ldd: ldd {binding_lib_name}
  ldd-->>CML: stdout (libs, "not found" lines)
  CML-->>GL: list of missing libs (unique)

  alt Missing libs found
    GL->>BW: Report/handle missing dependencies
  else No missing libs
    GL->>BW: Proceed with stub generation
    note right of GL: Install binding_lib_dir (not single file)
  end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

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.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (5)
scripts/build_wheel.py (5)

332-341: Harden ldd invocation: quote path, tolerate non-zero exit, and avoid parameter shadowing

  • ldd can legitimately exit non-zero (e.g., non-dynamic or unresolved deps), which will raise due to check=True in build_run; you currently don’t handle that, so stub generation may fail prematurely.
  • lib_name is re-used inside the loop, shadowing the function parameter; this is confusing and error-prone.
  • Use quoting to handle spaces and avoid shell injection.

Suggested patch:

-def check_missing_libs(lib_name: str) -> list[str]:
-    result = build_run(f"ldd {lib_name}", capture_output=True, text=True)
-    missing = []
-    for line in result.stdout.splitlines():
-        if "not found" in line:
-            lib_name = line.split()[0]  # Extract the library name before "=> not found"
-            if lib_name not in missing:
-                missing.append(lib_name)
-    return missing
+def check_missing_libs(lib_path: str) -> list[str]:
+    # Use check=False so we can still parse output when ldd exits non‑zero.
+    proc = run(f'ldd "{lib_path}"', shell=True, capture_output=True, text=True, check=False)
+    missing: list[str] = []
+    for line in (proc.stdout or "").splitlines():
+        if "not found" in line:
+            soname = line.split()[0]  # e.g. "libcuda.so.1"
+            if soname not in missing:
+                missing.append(soname)
+    return missing

345-346: Pass an absolute library path and clarify parameter naming

Relying on the current working directory to resolve the library name is brittle. Pass the absolute path to the checked library and reflect that in the parameter name.

Apply:

-def generate_python_stubs_linux(binding_type: str, venv_python: Path,
-                                deep_ep: bool, binding_lib_name: str):
+def generate_python_stubs_linux(binding_type: str, venv_python: Path,
+                                deep_ep: bool, binding_lib_path: str):
@@
-    missing_libs = check_missing_libs(binding_lib_name)
+    missing_libs = check_missing_libs(binding_lib_path)

Also applies to: 354-355


807-810: Variable name misleads: this is a file, not a directory

binding_lib_dir points to a file (a .so/.pyd), not a directory. Rename for clarity.

-        binding_lib_dir = get_binding_lib(binding_type, "bindings")
-        binding_lib_file_name = binding_lib_dir.name
-        install_file(binding_lib_dir, pkg_dir)
+        binding_lib_path = get_binding_lib(binding_type, "bindings")
+        binding_lib_file_name = binding_lib_path.name
+        install_file(binding_lib_path, pkg_dir)

849-850: Pass absolute path into generate_python_stubs_linux to decouple from cwd

Even though you're in working_directory(pkg_dir), making the dependency explicit improves robustness.

-                        bool(deep_ep_cuda_architectures), binding_lib_file_name)
+                        bool(deep_ep_cuda_architectures), str(pkg_dir / binding_lib_file_name))

332-332: Minor typing note: list[str] requires Python ≥3.9

The file uses list[str] in multiple places (pre-existing), which isn’t valid in Python 3.8 without from future import annotations. If 3.8 remains a supported minimum, consider one of:

  • Add at the top of the file: from future import annotations
  • Or use typing.List[str] consistently

I can prepare a follow-up patch if you confirm the target Python versions in CI.

Would you like me to add from future import annotations at the top of this module to align with Python 3.8 compatibility?

📜 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.

📥 Commits

Reviewing files that changed from the base of the PR and between bff5fdf and 5142716.

📒 Files selected for processing (1)
  • scripts/build_wheel.py (5 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.py

📄 CodeRabbit Inference Engine (CODING_GUIDELINES.md)

**/*.py: Python code must target Python 3.8+
Python indentation: 4 spaces, no tabs
Maintain module namespace in imports (from package.subpackage import foo; then use foo.SomeClass())
Python file names use snake_case
Python class names use PascalCase
Python functions/methods and local variables use snake_case; variables starting with a number get k_ prefix (e.g., k_99th_percentile)
Global variables use G_ prefixed UPPER_SNAKE_CASE (e.g., G_MY_GLOBAL)
Constants use UPPER_SNAKE_CASE in Python
Avoid shadowing variables from outer scopes in Python
Initialize all externally visible members of a Python class in init
Prefer docstrings for interfaces used outside a file; comments for local code
Use Google-style docstrings for classes and functions (Sphinx-parsable)
Document attributes/variables inline with short docstrings
Avoid reflection when simple alternatives exist (e.g., prefer explicit parameters over dict(**locals()))
In try/except, catch the narrowest exceptions possible
For duck-typing with try/except, keep try body minimal and put logic in else

Files:

  • scripts/build_wheel.py
**/*.{cpp,cxx,cc,cu,h,hpp,hxx,hh,cuh,py}

📄 CodeRabbit Inference Engine (CODING_GUIDELINES.md)

Prepend NVIDIA copyright header (current year) to all source files

Files:

  • scripts/build_wheel.py
🔇 Additional comments (2)
scripts/build_wheel.py (2)

351-365: LD_LIBRARY_PATH setup and cleanup LGTM

Creating versioned symlinks in a temp dir and prepending both the temp dir and CUDA stubs to LD_LIBRARY_PATH is sound, and the finally block reliably removes the temp dir. This should keep stub generation self-contained without polluting the environment.


345-346: All call sites for generate_python_stubs_linux have been updated
A repository-wide search only found the definition and its single invocation in scripts/build_wheel.py (lines 846–848), which now passes both deep_ep and binding_lib_name correctly. No other references exist.

@MartinMarciniszyn
Copy link
Collaborator

/bot run --skip-test

@tensorrt-cicd
Copy link
Collaborator

PR_Github #15740 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #15740 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #11829 (Partly Tested) completed with status: 'SUCCESS'

@liji-nv liji-nv enabled auto-merge (squash) August 19, 2025 10:52
@liji-nv
Copy link
Collaborator Author

liji-nv commented Aug 19, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #15774 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #15774 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #11859 completed with status: 'FAILURE'

@liji-nv
Copy link
Collaborator Author

liji-nv commented Aug 20, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #15853 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #15853 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #11916 completed with status: 'SUCCESS'
Pipeline passed with automatic retried tests. Check the rerun report for details.

@liji-nv liji-nv merged commit e5e4170 into NVIDIA:main Aug 20, 2025
5 checks passed
zhou-yuxin pushed a commit to zhou-yuxin/TensorRT-LLM that referenced this pull request Aug 21, 2025
)

Signed-off-by: Jin Li <59594262+liji-nv@users.noreply.github.com>
Signed-off-by: Yuxin <yuxinz@nvidia.com>
zhenhuaw-me added a commit to zhenhuaw-me/TensorRT-LLM that referenced this pull request Aug 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants