KEMBAR78
[https://nvbugs/5498165][fix] fix permission error for config file lock by chang-l · Pull Request #7656 · NVIDIA/TensorRT-LLM · GitHub
Skip to content

Conversation

@chang-l
Copy link
Collaborator

@chang-l chang-l commented Sep 9, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved reliability of module loading by adding a secondary locking strategy using the system temp directory when the primary cache lock is unavailable.
    • Gracefully handles lock timeouts and permission errors by logging warnings and proceeding without a lock when necessary.
    • Reduces crashes and stalls on restricted or networked filesystems, improving startup stability and overall robustness.

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.

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.

@chang-l chang-l requested a review from a team as a code owner September 9, 2025 17:21
@chang-l
Copy link
Collaborator Author

chang-l commented Sep 9, 2025

/bot run

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 9, 2025

📝 Walkthrough

Walkthrough

Introduces a secondary locking strategy in config_file_lock: if acquiring the primary lock under HF_MODULES_CACHE fails due to PermissionError/OSError, attempts a temp-dir lock via tempfile.gettempdir(). On timeouts or errors with the temp lock, logs warnings and proceeds without a lock. Primary path behavior otherwise unchanged.

Changes

Cohort / File(s) Summary
Locking and error handling updates
tensorrt_llm/_torch/model_config.py
Added tempfile import; expanded config_file_lock to try primary HF cache lock, fall back to temp-dir lock on PermissionError/OSError; on timeout or additional exceptions, log warnings and proceed without locking; preserved original timeout behavior for primary lock.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant Caller
  participant config_file_lock
  participant PrimaryLock as HF_CACHE/_remote_code.lock
  participant TempLock as TMP/_remote_code.lock

  Caller->>config_file_lock: enter context
  config_file_lock->>PrimaryLock: try acquire
  alt acquired
    Note over config_file_lock,PrimaryLock: Use primary lock
  else PermissionError/OSError
    Note over config_file_lock: Primary lock access error
    config_file_lock->>TempLock: try acquire in temp dir
    alt acquired
      Note over config_file_lock,TempLock: Using temp-dir lock
    else Timeout
      Note over config_file_lock: Warn: temp lock timeout
      Note over Caller,config_file_lock: Proceed without lock
    else PermissionError/OSError
      Note over config_file_lock: Warn with exception
      Note over Caller,config_file_lock: Proceed without lock
    end
  else Timeout
    Note over config_file_lock: Warn: primary lock timeout
    Note over Caller,config_file_lock: Proceed without lock
  end
  Caller-->>config_file_lock: exit context (release if held)
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks (2 passed, 1 warning)

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The current pull request description only contains template placeholders and lacks an actual summary, a clear explanation of the issue and solution, and any test coverage details, making it incomplete for reviewer understanding. Please replace the placeholder sections by providing a concise summary of changes, a clear Description explaining the problem and solution, and a Test Coverage section listing relevant tests to ensure adequate coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title uses the NVBugs ID and [fix] tag and concisely describes the main change of fixing a permission error in the config file lock mechanism, making it clear and specific to the changeset.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

✨ 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

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

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18254 [ run ] triggered by Bot

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: 1

🧹 Nitpick comments (4)
tensorrt_llm/_torch/model_config.py (4)

14-20: Deduplicate logger imports.

Two imports bring in the same symbol; keep one to avoid confusion.

-from tensorrt_llm import logger
 from tensorrt_llm._torch.pyexecutor.config_utils import is_nemotron_hybrid
 ...
-from tensorrt_llm.logger import logger
+from tensorrt_llm.logger import logger

66-75: Docstring is outdated—document fallback and no-lock behavior.

Reflect the new tempdir fallback and proceed-without-lock path.

-    """
-    Context manager for file locking when loading pretrained configs.
-
-    This prevents race conditions when multiple processes try to download/load
-    the same model configuration simultaneously.
-
-    Args:
-        timeout: Maximum time to wait for lock acquisition in seconds
-    """
+    """
+    Context manager for file locking when loading pretrained configs.
+
+    Primary lock: HF_MODULES_CACHE/_remote_code.lock.
+    Fallback: on PermissionError/OSError, use tempfile.gettempdir()/_remote_code.lock.
+    On Timeout at either location, or if both are unavailable, proceed without a lock (warn).
+
+    Args:
+        timeout: Maximum seconds to wait for lock acquisition.
+    """

86-91: Include lock path in the timeout warning.

Improves observability during contention.

-    except filelock.Timeout:
-        logger.warning(
-            f"Failed to acquire config lock within {timeout} seconds, proceeding without lock"
-        )
+    except filelock.Timeout:
+        logger.warning(
+            f"Failed to acquire config lock at {lock_path} within {timeout} seconds, proceeding without lock"
+        )

103-111: Clarify fallback warnings; include path and exception class.

More actionable logs; avoid implying only permission errors.

-            except filelock.Timeout:
-                logger.warning(
-                    f"Failed to acquire tempdir config lock within {timeout} seconds, proceeding without lock"
-                )
+            except filelock.Timeout:
+                logger.warning(
+                    f"Failed to acquire tempdir config lock at {lock_path} within {timeout} seconds, proceeding without lock"
+                )
 ...
-        except (PermissionError, OSError) as e:
-            logger.warning(
-                f"HF_MODULES_CACHE and tempdir config lock unavailable due to permission error: {e}, proceeding without lock"
-            )
+        except (PermissionError, OSError) as e:
+            logger.warning(
+                f"HF_MODULES_CACHE and tempdir config locks unavailable due to {e.__class__.__name__}: {e}; proceeding without lock"
+            )
📜 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 d49374b and 9085871.

📒 Files selected for processing (1)
  • tensorrt_llm/_torch/model_config.py (2 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/_torch/model_config.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/_torch/model_config.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/_torch/model_config.py
🧬 Code graph analysis (1)
tensorrt_llm/_torch/model_config.py (1)
tensorrt_llm/logger.py (1)
  • warning (132-133)
⏰ 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 (2)
tensorrt_llm/_torch/model_config.py (2)

4-4: Import for tempfile is appropriate.

Needed for the fallback lock path.


92-92: Catching OSError broadly—confirm intent.

Catching OSError may hide disk/full/IO failures unrelated to permissions. If the goal is strictly permission issues, consider narrowing to (PermissionError, FileNotFoundError). Otherwise, keep as-is and rely on warnings.

@tensorrt-cicd
Copy link
Collaborator

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

@chang-l
Copy link
Collaborator Author

chang-l commented Sep 9, 2025

/bot run --reuse-test

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18261 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

@chang-l
Copy link
Collaborator Author

chang-l commented Sep 9, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18266 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

@chang-l
Copy link
Collaborator Author

chang-l commented Sep 10, 2025

/bot run --reuse-test

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18292 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

@chang-l
Copy link
Collaborator Author

chang-l commented Sep 10, 2025

/bot run --reuse-test

@chang-l chang-l enabled auto-merge (squash) September 10, 2025 06:08
@tensorrt-cicd
Copy link
Collaborator

PR_Github #18312 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18312 [ run ] completed with state FAILURE
/LLM/main/L0_MergeRequest_PR pipeline #13728 completed with status: 'FAILURE'

@chang-l
Copy link
Collaborator Author

chang-l commented Sep 10, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18317 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18317 [ run ] completed with state FAILURE
/LLM/main/L0_MergeRequest_PR pipeline #13737 completed with status: 'FAILURE'

@chang-l
Copy link
Collaborator Author

chang-l commented Sep 10, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18332 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18332 [ run ] completed with state FAILURE
/LLM/main/L0_MergeRequest_PR pipeline #13749 completed with status: 'FAILURE'

Signed-off-by: Chang Liu <9713593+chang-l@users.noreply.github.com>
@chang-l
Copy link
Collaborator Author

chang-l commented Sep 10, 2025

/bot run

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18380 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #18380 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #13786 completed with status: 'SUCCESS'

@chang-l chang-l merged commit 3a9847e into NVIDIA:main Sep 11, 2025
5 checks passed
MrGeva pushed a commit to nv-auto-deploy/TensorRT-LLM that referenced this pull request Sep 18, 2025
…ck (NVIDIA#7656)

Signed-off-by: Chang Liu <9713593+chang-l@users.noreply.github.com>
Wong4j pushed a commit to Wong4j/TensorRT-LLM that referenced this pull request Sep 20, 2025
…ck (NVIDIA#7656)

Signed-off-by: Chang Liu <9713593+chang-l@users.noreply.github.com>
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.

4 participants