[https://nvbugs/5532023][fix] executor with-statement bug #7895
Conversation
Signed-off-by: chunweiy <chunweiy@nvidia.com>
|
/bot run --stage-list "DGX_H200-4_GPUs-TensorRT-Post-Merge-1, DGX_H200-4_GPUs-TensorRT-Post-Merge-2, DGX_H200-4_GPUs-TensorRT-Post-Merge-3" |
📝 WalkthroughWalkthroughAdds a context manager exit handler to GenerationExecutorWorker by implementing exit that always calls shutdown and suppresses WorkerExit exceptions (and no-exception cases), altering teardown control flow when used in a with-statement. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant C as Caller
participant W as GenerationExecutorWorker
rect rgb(240,245,255)
Note over C,W: Context usage
C->>W: __enter__()
activate W
C-->>W: run operations
end
alt No exception
C->>W: __exit__(None, None, None)
W->>W: shutdown()
W-->>C: return True (suppressed)
else WorkerExit raised inside with
C->>W: __exit__(WorkerExit, e, tb)
W->>W: shutdown()
Note over W: Treat WorkerExit as non-error
W-->>C: return True (suppressed)
else Other exception
C->>W: __exit__(OtherExc, e, tb)
W->>W: shutdown()
W-->>C: return False (propagate)
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
tensorrt_llm/executor/worker.py (2)
1-1: Add the required NVIDIA Apache-2.0 header (2025).Repository guideline requires the header at the top of all .py files.
+# Copyright (c) 2025, NVIDIA CORPORATION. All rights reserved. +# SPDX-License-Identifier: Apache-2.0 +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License.
257-274: Use typing.Union for Python 3.8 compatibility.PEP 604 unions (|) require Python 3.10+. The style guide targets 3.8+.
- engine: Path | Engine, + engine: Union[Path, Engine],
🧹 Nitpick comments (5)
tensorrt_llm/executor/worker.py (5)
250-253: Make suppression check more robust and avoid name shadowing in exit.
- Use issubclass to cover subclassed exits (safer), and rename the traceback arg to tb to avoid shadowing the imported traceback module. Returning False on no-exception is clearer and equivalent.
- def __exit__(self, exc_type, exc_value, traceback) -> bool: - self.shutdown() - return exc_type is None or exc_type == GenerationExecutorWorker.WorkerExit + def __exit__(self, exc_type, exc_value, tb) -> bool: + """Ensure shutdown on context exit; suppress only coordinated worker exits.""" + self.shutdown() + if exc_type is None: + return False # explicit no-op on normal path + return issubclass(exc_type, GenerationExecutorWorker.WorkerExit)
453-456: Remove redundant catch/rethrow of WorkerExit.With exit now suppressing WorkerExit, this block is unnecessary noise.
- except GenerationExecutorWorker.WorkerExit as e: - # This will capture by the with-statement and exit normally. - raise e
239-248: Message text nit: align guidance with actual usage.The error suggests using with GenerationExecutorWorker() as ...:, but code uses with worker:. Consider a neutral message to avoid confusion.
- "block_subordinates() should be used in a `with GenerationExecutorWorker() as ...:` block" + "block_subordinates() must be called inside a GenerationExecutorWorker context (`with worker:`)."
250-253: Optional: docstring for context behavior.Briefly document that WorkerExit is intentionally suppressed; helps future readers.
394-406: Tests: add a minimal with-statement test to assert WorkerExit is swallowed.E.g., spawn a non‑leader worker, have block_subordinates() raise, and assert the with block exits cleanly and shutdown is called once.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
tensorrt_llm/executor/worker.py(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{h,hpp,hh,hxx,cpp,cxx,cc,cu,cuh,py}
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
Use only spaces, no tabs; indent with 4 spaces.
Files:
tensorrt_llm/executor/worker.py
**/*.py
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
**/*.py: Python code must target Python 3.8+.
Indent Python code with 4 spaces; do not use tabs.
Maintain module namespace when importing; prefer 'from package.subpackage import foo' then 'foo.SomeClass()' instead of importing the class directly.
Python filenames should be snake_case (e.g., some_file.py).
Python classes use PascalCase names.
Functions and methods use snake_case names.
Local variables use snake_case; prefix 'k' for variables that start with a number (e.g., k_99th_percentile).
Global variables use upper SNAKE_CASE prefixed with 'G' (e.g., G_MY_GLOBAL).
Constants use upper SNAKE_CASE (e.g., MY_CONSTANT).
Avoid shadowing variables from an outer scope.
Initialize all externally visible members of a class in the constructor.
Prefer docstrings for interfaces that may be used outside a file; comments for in-function or file-local interfaces.
Use Google-style docstrings for classes and functions (Sphinx-parsable).
Document attributes and variables inline so they render under the class/function docstring.
Avoid reflection when a simpler, explicit approach suffices (e.g., avoid dict(**locals()) patterns).
In try/except, catch the most specific exceptions possible.
For duck-typing try/except, keep the try body minimal and use else for the main logic.
Files:
tensorrt_llm/executor/worker.py
**/*.{cpp,cxx,cc,h,hpp,hh,hxx,cu,cuh,py}
📄 CodeRabbit inference engine (CODING_GUIDELINES.md)
Prepend the NVIDIA Apache-2.0 copyright header with current year to the top of all source files (e.g., .cpp, .h, .cu, .py).
Files:
tensorrt_llm/executor/worker.py
🧬 Code graph analysis (1)
tensorrt_llm/executor/worker.py (3)
tensorrt_llm/_torch/pyexecutor/py_executor.py (1)
shutdown(405-418)tests/unittest/executor/test_base_worker.py (1)
shutdown(49-53)tensorrt_llm/executor/base_worker.py (1)
WorkerExit(46-47)
⏰ 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)
tensorrt_llm/executor/worker.py (1)
416-451: Sanity check paths: ensure shutdown remains idempotent across paths.Double shutdown occurs for non‑leader tllm.Executor (block_subordinates calls shutdown, then exit calls it again). Guarding via doing_shutdown makes this safe—please confirm doing_shutdown is initialized in BaseWorker.
|
PR_Github #19506 [ run ] triggered by Bot |
|
/bot run --extra-stage "DGX_H200-4_GPUs-TensorRT-Post-Merge-1, DGX_H200-4_GPUs-TensorRT-Post-Merge-2, DGX_H200-4_GPUs-TensorRT-Post-Merge-3" |
|
PR_Github #19510 [ run ] triggered by Bot |
|
PR_Github #19506 [ run ] completed with state |
|
PR_Github #19510 [ run ] completed with state |
|
/bot run --extra-stage "DGX_H200-4_GPUs-TensorRT-Post-Merge-1, DGX_H200-4_GPUs-TensorRT-Post-Merge-2, DGX_H200-4_GPUs-TensorRT-Post-Merge-3" |
|
PR_Github #19571 [ run ] triggered by Bot |
|
PR_Github #19571 [ run ] completed with state |
|
/bot run --extra-stage "DGX_H200-4_GPUs-TensorRT-Post-Merge-1, DGX_H200-4_GPUs-TensorRT-Post-Merge-2, DGX_H200-4_GPUs-TensorRT-Post-Merge-3" |
|
PR_Github #19648 [ run ] triggered by Bot |
|
PR_Github #19648 [ run ] completed with state |
5 participants
Summary by CodeRabbit
Description
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
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.
Details
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.