[https://nvbugs/5689658][test] Fix gpu lock issue running on cluster

[yufeiwu-nv]

Summary by CodeRabbit

• New Features

  • Added --enable-gpu-clock-lock command-line flag to allow optional GPU clock locking during test execution.

• Improvements

  • Enhanced GPU clock lock error handling to distinguish permission errors from other failures.
  • Made GPU clock locking behavior conditional, allowing tests to proceed when disabled.
  • Improved GPU monitoring data validation with conditional clock locking checks.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Description

Current gpu lock implementation can't run on rootless container.

Add param let user to choose or not choose the customized gpu_lock solution which contains clock yaml file. Many users have their own logic to control gpu clock and different clock numbers.

To let user choose different gpu_lock solution and clock number because other solution may prefer other frequency number setting outside TRTLLM environment.

Test Coverage

PR Checklist

Please review the following before submitting your PR:

• PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.

• PR Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.

• Test cases are provided for new code paths (see test instructions)

• Any new dependencies have been scanned for license and vulnerabilities

• CODEOWNERS updated if ownership changes

• Documentation updated as needed

• Update tava architecture diagram if there is a significant design change in PR.

• The reviewers assigned automatically/manually are appropriate for the PR.

• Please check this after reviewing the above items as appropriate for this PR.

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.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR introduces a new CLI flag --enable-gpu-clock-lock to conditionally enable GPU clock locking during tests. The flag is passed from pytest configuration through the trt_gpu_clock_lock fixture into the GPUClockLock class, which implements guards and early exits when clock locking is disabled.

Changes

Cohort / File(s)	Summary
pytest CLI configuration tests/integration/defs/conftest.py	Added --enable-gpu-clock-lock command-line flag (store_true, default False) and threaded the option into the trt_gpu_clock_lock fixture to pass to GPUClockLock initialization.
GPU clock lock implementation tests/integration/defs/perf/gpu_clock_lock.py	Added enable_clock_locking parameter to __init__ (default False), implemented guard in _lock_gpu_clocks to no-op when disabled, adjusted error handling to distinguish NoPermission errors from other failures, and added early exit in validate_gpu_monitoring_data when not enabled.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Attention areas:
  • Error handling logic in _lock_gpu_clocks distinguishing between NoPermission and other failure modes
  • Guard placement in _lock_gpu_clocks and validate_gpu_monitoring_data to ensure proper early exits
  • Fixture threading in conftest.py correctly passes the flag value to GPUClockLock

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	PR description provides context on the GPU lock issue for rootless containers and explains the motivation, but lacks detail on the implementation and test coverage.	Clarify what the --enable-gpu-clock-lock flag does, how it enables rootless container support, and confirm existing or new tests validate the functionality.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly references the NVBugs ticket and describes the main change: fixing a GPU lock issue for cluster execution. It is specific and directly related to the core problem addressed in the changeset.
Docstring Coverage	✅ Passed	Docstring coverage is 80.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

tests/integration/defs/perf/gpu_clock_lock.py (1)

212-214: Consider clarifying the warning message.

The guard logic is correct, but the warning message "Clock locking is not enabled inside TRTLLM code" could be more descriptive. Consider:

-        print_warning("Clock locking is not enabled inside TRTLLM code")
+        print_warning("GPU clock locking is disabled. Use --enable-gpu-clock-lock to enable.")

This provides clearer guidance on how to enable the feature if needed.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a38d91a and 4e8b2c1.

📒 Files selected for processing (2)

• tests/integration/defs/conftest.py (2 hunks)
• tests/integration/defs/perf/gpu_clock_lock.py (5 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.py

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

**/*.py: The code developed for TensorRT-LLM should conform to Python 3.8+
Indent Python code with 4 spaces; do not use tabs
Always maintain the namespace when importing in Python, even if only one class or function from a module is used (e.g., use from package.subpackage import foo and then foo.SomeClass() instead of from package.subpackage.foo import SomeClass)
Python filenames should use snake_case (e.g., some_file.py)
Python class names should use PascalCase (e.g., class SomeClass)
Python function and method names should use snake_case (e.g., def my_awesome_function():)
Python local variable names should use snake_case, with prefix k for variable names that start with a number (e.g., k_99th_percentile = ...)
Python global variables should use upper snake_case with prefix G (e.g., G_MY_GLOBAL = ...)
Python constants should use upper snake_case (e.g., MY_CONSTANT = ...)
Avoid shadowing variables declared in an outer scope in Python
Initialize all externally visible members of a Python class in the constructor
For Python interfaces that may be used outside a file, prefer docstrings over comments
Python comments should be reserved for code within a function, or interfaces that are local to a file
Use Google style docstrings for Python classes and functions, which can be parsed by Sphinx
Python attributes and variables can be documented inline with type and description (e.g., self.x = 5 followed by """<type>: Description of 'x'""" )
Avoid using reflection in Python when functionality can be easily achieved without reflection
When using try-except blocks in Python, limit the except clause to the smallest set of specific errors possible instead of catching all exceptions
When using try-except blocks in Python to handle multiple possible variable types (duck-typing), keep the body of the try as small as possible and use the else block to implement the logic

Files:

• tests/integration/defs/perf/gpu_clock_lock.py
• tests/integration/defs/conftest.py

**/*.{cpp,h,cu,py}

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

All TensorRT-LLM Open Source Software code files should contain an NVIDIA copyright header that includes the current year at the top

Files:

• tests/integration/defs/perf/gpu_clock_lock.py
• tests/integration/defs/conftest.py

🧬 Code graph analysis (1)

tests/integration/defs/conftest.py (1)

tests/integration/defs/perf/gpu_clock_lock.py (1)

• GPUClockLock (68-580)

🪛 Ruff (0.14.5)

tests/integration/defs/perf/gpu_clock_lock.py

277-278: Within an except clause, raise exceptions with raise ... from err or raise ... from None to distinguish them from errors in exception handling

(B904)

---

277-278: Avoid specifying long messages outside the exception class

(TRY003)

⏰ 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 (4)

tests/integration/defs/conftest.py (2)

670-670: LGTM! Clean integration of the new CLI flag.

The code correctly reads the --enable-gpu-clock-lock option and passes it to the GPUClockLock constructor, following the established pattern for other configuration options in this file.

Also applies to: 674-674

---

2143-2149: LGTM! Well-defined CLI option.

The --enable-gpu-clock-lock option is properly configured with:

• Appropriate store_true action for a boolean flag
• Sensible default (False) making clock locking opt-in
• Clear help text explaining the purpose

tests/integration/defs/perf/gpu_clock_lock.py (2)

70-70: LGTM! Backward-compatible parameter addition.

The new enable_clock_locking parameter is properly implemented with:

• Default value False ensuring backward compatibility
• Clear documentation in the docstring
• Appropriate storage as an instance variable

Also applies to: 78-78, 88-88

---

438-441: LGTM! Appropriate validation skip logic.

The early exit when clock locking is disabled is logical and properly implemented:

• Correctly placed at the start of the validation method
• Provides clear informational message explaining why validation is skipped
• Maintains consistency with the overall feature design

[MrGeva]

can you preserve the existing clock locking in CI by adding --enable-gpu-clock-lock to jenkins/L0_Test.groovy:

if (perfMode) {
    testCmdLine += [
        "--perf",
        "--perf-log-formats csv",
        "--perf-log-formats yaml",
        "--enable-gpu-clock-lock"  // ← ADD THIS LINE
    ]
}

[yufeiwu-nv]

/bot run

[tensorrt-cicd]

PR_Github #25962 [ run ] triggered by Bot. Commit: 3864d8f

[tensorrt-cicd]

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