Skip to content

Conversation

dongxuy04
Copy link
Collaborator

@dongxuy04 dongxuy04 commented Aug 29, 2025

Summary by CodeRabbit

  • New Features

    • Added support for configuring the EPLB shared memory base name via the TRTLLM_EPLB_SHM_NAME environment variable.
    • Automatically cleans up stale EPLB shared memory segments before creating new ones, reducing start-up conflicts and easing restarts.
  • Documentation

    • Rewrote the EPLB shared memory section to cover configuration via environment variable, automatic cleanup behavior, and manual cleanup commands (with warnings).
    • Minor wording improvements for clarity.

Description

  • Add automatic EPLB shared memory delete if already exist.
  • Add environment variable TRTLLM_EPLB_SHM_NAME to set shared memory base name.
  • Update docs.

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.

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.

@dongxuy04 dongxuy04 requested review from Superjomn and yuxianq August 29, 2025 14:03
@dongxuy04 dongxuy04 requested review from a team as code owners August 29, 2025 14:03
@dongxuy04
Copy link
Collaborator Author

/bot run --disable-fail-fast

@tensorrt-cicd
Copy link
Collaborator

PR_Github #16995 [ run ] triggered by Bot

Copy link
Contributor

coderabbitai bot commented Aug 29, 2025

📝 Walkthrough

Walkthrough

Documentation updates describe configurable shared-memory naming and auto-cleanup for EPLB. Code changes implement environment-driven base-name resolution, pre-creation cleanup of existing shared memory segments, and additional initializer state in MoeLoadBalancer. The constructor signature now accepts an optional shared-memory base name.

Changes

Cohort / File(s) Summary of Changes
Documentation: EPLB shared memory
examples/wide_ep/README.md
Rewrote EPLB shared-memory section: introduced TRTLLM_EPLB_SHM_NAME, described auto-cleanup of leftover segments, provided manual cleanup commands and warnings, and made minor wording adjustments.
EPLB runtime handling & init
tensorrt_llm/_torch/modules/fused_moe/moe_load_balancer.py
Added os import; in finalize_layer_weights, unlink existing /dev/shm segment before creating new SharedMemory; MoeLoadBalancer.init now takes Optional[str] shared_memory_base_name defaulting via env TRTLLM_EPLB_SHM_NAME with fallback 'moe_shared'; initialized iteration/statistics control fields. Public signature updated.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant U as Caller
  participant LB as MoeLoadBalancer.__init__
  participant ENV as Environment
  participant FLW as finalize_layer_weights
  participant FS as /dev/shm
  participant SM as SharedMemory

  U->>LB: Instantiate MoeLoadBalancer(ep_rank, ep_size, layer_updates_per_iter, shared_memory_base_name=None)
  LB->>ENV: Read TRTLLM_EPLB_SHM_NAME
  alt Name provided via arg
    LB-->>LB: Use provided base name
  else Name from env or default
    LB-->>LB: Use env value or 'moe_shared'
  end
  LB-->>U: Instance ready (iter/control fields initialized)

  U->>FLW: finalize_layer_weights(...)
  FLW->>FS: Check for existing shm path (/dev/shm/<base>_lX_lr0_all)
  alt Exists
    FLW->>FS: Unlink existing shm
    Note right of FLW: Logs a warning before unlink
  end
  FLW->>SM: Create new SharedMemory segment
  SM-->>FLW: Handle to segment
  FLW-->>U: Return/continue
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested labels

Documentation

Suggested reviewers

  • litaotju
  • WeiHaocheng
  • qiaoxj07

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 @coderabbit in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbit 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:
    • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbit 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 @coderabbit help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbit 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: 3

🧹 Nitpick comments (3)
tensorrt_llm/_torch/modules/fused_moe/moe_load_balancer.py (1)

179-188: Make SHM cleanup robust and use the imported logger.

  • Switch to the imported logger for consistency.
  • Fix wording (“existing”).
  • Guard unlink with try/except to avoid race failures.
  • Retry SharedMemory(...) on FileExistsError.
    [ suggest_essential_refactor ]
    Apply:
         shm_name = self.get_shared_memory_name()
-        shm_full_path = os.path.join('/dev/shm/', shm_name)
-        if os.path.exists(shm_full_path):
-            tensorrt_llm.logger.warning(
-                f'Found exist EPLB shared memory name: {shm_name}, unlinking {shm_full_path}'
-            )
-            os.unlink(shm_full_path)
-        shm = shared_memory.SharedMemory(name=shm_name,
-                                         create=True,
-                                         size=total_size)
+        shm_full_path = os.path.join('/dev/shm', shm_name)
+        if os.path.exists(shm_full_path):
+            logger.warning(
+                f"Found existing EPLB shared memory: {shm_name}; unlinking {shm_full_path}"
+            )
+            try:
+                os.unlink(shm_full_path)
+            except FileNotFoundError:
+                pass  # raced with another cleaner
+            except OSError as e:
+                logger.warning(
+                    f"Failed to unlink leftover SHM {shm_full_path}: {e}; will retry creation."
+                )
+        try:
+            shm = shared_memory.SharedMemory(
+                name=shm_name, create=True, size=total_size
+            )
+        except FileExistsError:
+            # Defensive retry in case of a race
+            try:
+                os.unlink(shm_full_path)
+            except Exception:
+                pass
+            shm = shared_memory.SharedMemory(
+                name=shm_name, create=True, size=total_size
+            )

Note: Consider documenting that identical base names across jobs on the same node can cause one job to unlink another’s SHM; encourage per-job base names.

examples/wide_ep/README.md (2)

101-111: Tighten wording and clarity.

Minor grammar and clarity nits; also mention defaulting behavior explicitly.

-There is one environment variable `TRTLLM_EPLB_SHM_NAME` to specify the base name of the shared memory. This environment variable may need to be specified if there are multiple instances on one node. If not, you can ignore it.
+There is an environment variable `TRTLLM_EPLB_SHM_NAME` that specifies the base name of the shared memory. Set it when multiple instances run on the same node; otherwise, you can ignore it.
 
-The default value of `TRTLLM_EPLB_SHM_NAME` is `moe_shared`. When `TRTLLM_EPLB_SHM_NAME` is set to `moe_shared`, the shared memory segments will be named as `moe_shared_l0_lr0_all`, `moe_shared_l1_lr0_all`, and so on.
+If unset or empty, it defaults to `moe_shared`. With `moe_shared`, the segments are named `moe_shared_l0_lr0_all`, `moe_shared_l1_lr0_all`, and so on.
 
-Normally, these shared memory segments will be cleaned up automatically at process exit. However, they may not get the chance to be cleaned up if an abnormal exit occurs. Therefore, EPLB will automatically clean up leftover shared memory with the same name that already exists before creating new segments.
+Normally, these segments are cleaned up at process exit. After an abnormal exit, leftovers may remain. EPLB now automatically cleans up leftover segments with the same base name before creating new ones.

115-124: Parameterize manual cleanup with the env var.

Use the configured base name in commands to avoid deleting another job’s segments.

-# List all moe_shared related shared memory
-ls -la /dev/shm/moe_shared_*
+# List all segments for the configured base name (default: moe_shared)
+BASE_NAME="${TRTLLM_EPLB_SHM_NAME:-moe_shared}"
+ls -la "/dev/shm/${BASE_NAME}_"*
 
-# Remove all moe_shared related shared memory
-rm -f /dev/shm/moe_shared_*
+# Remove all segments for the configured base name
+rm -f "/dev/shm/${BASE_NAME}_"*
 
-# Or remove specific shared memory segments
-rm -f /dev/shm/moe_shared_l0_lr0_all
+# Or remove a specific segment
+rm -f "/dev/shm/${BASE_NAME}_l0_lr0_all"

Optionally add: “Verify no running processes depend on the segment before deletion.”

Also applies to: 126-126

📜 Review details

Configuration used: Path: .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 62459d5 and d95d649.

📒 Files selected for processing (2)
  • examples/wide_ep/README.md (1 hunks)
  • tensorrt_llm/_torch/modules/fused_moe/moe_load_balancer.py (4 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{cpp,cc,cxx,cu,h,hpp,hh,hxx,cuh,py}

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

**/*.{cpp,cc,cxx,cu,h,hpp,hh,hxx,cuh,py}: Use spaces only; no tabs; indent with 4 spaces
Prepend NVIDIA copyright header (current year) to all source files (.cpp, .h, .cu, .py, etc.)

Files:

  • tensorrt_llm/_torch/modules/fused_moe/moe_load_balancer.py
**/*.py

📄 CodeRabbit inference engine (CODING_GUIDELINES.md)

**/*.py: Python code must target Python 3.8+
Indent Python with 4 spaces; no tabs
Preserve module namespaces when importing: from package.subpackage import foo; then call foo.SomeClass() instead of importing the class directly
Python naming: files snake_case; classes PascalCase; functions/methods snake_case; locals snake_case (prefix k_ when starting with a number); globals UPPER_SNAKE_CASE with G_ prefix; constants UPPER_SNAKE_CASE
Avoid shadowing outer-scope variables; initialize all externally visible members in init
Prefer docstrings for interfaces used outside a file; limit comments to function-internal or file-local interfaces
Use Google-style docstrings for classes and functions; document attributes/variables inline so Sphinx can render them
Avoid reflection when simpler alternatives exist; prefer explicit parameters and return dicts over locals()/dynamic tricks
In try/except, catch the narrowest exceptions possible; keep try bodies minimal and use else for the main logic when doing duck-typing checks

Files:

  • tensorrt_llm/_torch/modules/fused_moe/moe_load_balancer.py
🧬 Code graph analysis (1)
tensorrt_llm/_torch/modules/fused_moe/moe_load_balancer.py (1)
tensorrt_llm/logger.py (1)
  • warning (131-132)
⏰ 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

@dongxuy04
Copy link
Collaborator Author

/bot run --disable-fail-fast

@tensorrt-cicd
Copy link
Collaborator

PR_Github #17001 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #16995 [ run ] completed with state ABORTED

@tensorrt-cicd
Copy link
Collaborator

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

@dongxuy04
Copy link
Collaborator Author

/bot run --disable-fail-fast

@tensorrt-cicd
Copy link
Collaborator

PR_Github #17028 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

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.

2 participants