Skip to content

Fix embedding lowering crash when QNN_SDK_ROOT is unset#21051

Open
psiddh wants to merge 1 commit into
pytorch:mainfrom
psiddh:export-D112944232
Open

Fix embedding lowering crash when QNN_SDK_ROOT is unset#21051
psiddh wants to merge 1 commit into
pytorch:mainfrom
psiddh:export-D112944232

Conversation

@psiddh

@psiddh psiddh commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Summary:
D110960687 (#20686) rewrote Embedding.define_node to
select between the optimized and legacy pcq-embedding lowerings based on
is_qnn_sdk_version_less_than("2.48"). That helper resolves the SDK version via
get_sdk_build_id, which builds a path from os.environ["QNN_SDK_ROOT"].

define_node runs during AOT partitioning (is_node_supported), and AOT-only
environments do not necessarily have QNN_SDK_ROOT set. In that case
os.path.join(os.environ.get("QNN_SDK_ROOT", None), ...) raised
TypeError: expected str, bytes or os.PathLike object, not NoneType, breaking
every QNN lowering that contains an embedding — including the internal
test_dummy_llama_qnn_16a4w_aot_and_runtime.

Fall back to the legacy embedding lowering (valid on all QNN versions) when
QNN_SDK_ROOT is unavailable, so the version-gated optimization is only taken
when the SDK version can actually be determined. Also make get_sdk_build_id
raise a clear EnvironmentError instead of a cryptic TypeError when the
environment variable is missing.

This diff was authored with Claude Code.

Differential Revision: D112944232

Summary:
D110960687 (pytorch#20686) rewrote `Embedding.define_node` to
select between the optimized and legacy pcq-embedding lowerings based on
`is_qnn_sdk_version_less_than("2.48")`. That helper resolves the SDK version via
`get_sdk_build_id`, which builds a path from `os.environ["QNN_SDK_ROOT"]`.

`define_node` runs during AOT partitioning (`is_node_supported`), and AOT-only
environments do not necessarily have `QNN_SDK_ROOT` set. In that case
`os.path.join(os.environ.get("QNN_SDK_ROOT", None), ...)` raised
`TypeError: expected str, bytes or os.PathLike object, not NoneType`, breaking
every QNN lowering that contains an embedding — including the internal
`test_dummy_llama_qnn_16a4w_aot_and_runtime`.

Fall back to the legacy embedding lowering (valid on all QNN versions) when
`QNN_SDK_ROOT` is unavailable, so the version-gated optimization is only taken
when the SDK version can actually be determined. Also make `get_sdk_build_id`
raise a clear `EnvironmentError` instead of a cryptic `TypeError` when the
environment variable is missing.

This diff was authored with Claude Code.

Differential Revision: D112944232
@psiddh
psiddh requested a review from abhinaykukkadapu as a code owner July 21, 2026 02:26
Copilot AI review requested due to automatic review settings July 21, 2026 02:26
@pytorch-bot

pytorch-bot Bot commented Jul 21, 2026

Copy link
Copy Markdown

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/21051

Note: Links to docs will display an error until the docs builds have been completed.

❌ 3 New Failures, 1 Unrelated Failure

As of commit fdd05f2 with merge base a19d1ba (image):

NEW FAILURES - The following jobs have failed:

  • Cadence Build & Test / hifi-build / hifi4 (gh)
    Refusing to check out fork pull request code from a 'pull_request_target' workflow. This workflow runs with the base repository's GITHUB_TOKEN, secrets, default-branch cache scope, and runner access. Fetching and executing a fork's code in that trusted context commonly leads to "pwn request" vulnerabilities. To opt in, review the risks at https://gh.io/securely-using-pull_request_target and set 'allow-unsafe-pr-checkout: true' on the actions/checkout step.
  • Cadence Build & Test / vision-build / vision (gh)
    Refusing to check out fork pull request code from a 'pull_request_target' workflow. This workflow runs with the base repository's GITHUB_TOKEN, secrets, default-branch cache scope, and runner access. Fetching and executing a fork's code in that trusted context commonly leads to "pwn request" vulnerabilities. To opt in, review the risks at https://gh.io/securely-using-pull_request_target and set 'allow-unsafe-pr-checkout: true' on the actions/checkout step.
  • pull / unittest-buck / linux / linux-job (gh)
    RuntimeError: Command docker exec -t d3fb35a27f1173eb9a0dcbfe1d00e801a77d9c6e4e2edf7535fd571b0fd0cb7f /exec failed with exit code 3

BROKEN TRUNK - The following job failed but were present on the merge base:

👉 Rebase onto the `viable/strict` branch to avoid these failures

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jul 21, 2026
@meta-codesync

meta-codesync Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

@psiddh has exported this pull request. If you are a Meta employee, you can view the originating Diff in D112944232.

@github-actions

Copy link
Copy Markdown

This PR needs a release notes: label

If your change should be included in the release notes (i.e. would users of this library care about this change?), please use a label starting with release notes:. This helps us keep track and include your important work in the next release notes.

To add a label, you can comment to pytorchbot, for example
@pytorchbot label "release notes: none"

For more information, see
https://github.com/pytorch/pytorch/wiki/PyTorch-AutoLabel-Bot#why-categorize-for-release-notes-and-how-does-it-work.

@shewu-quic shewu-quic left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM. Thanks!

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes a crash in Qualcomm QNN embedding lowering during AOT partitioning when QNN_SDK_ROOT is unset, by preventing SDK-version probing in environments that don’t have an SDK path configured and by improving the error raised when the build-id helper is called without the required environment variable.

Changes:

  • Make get_sdk_build_id() explicitly raise EnvironmentError with a clear message when QNN_SDK_ROOT is missing.
  • Update embedding lowering to fall back to the legacy lowering when QNN_SDK_ROOT is unset, and only attempt the QNN 2.48+ optimized lowering when the SDK root is available.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
backends/qualcomm/utils/check_qnn_version.py Adds an explicit environment-variable check and clearer exception for SDK build-id lookup.
backends/qualcomm/builders/op_embedding.py Avoids version-gated optimized embedding lowering when SDK root is unavailable to prevent AOT partitioning crashes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +246 to 251
# The optimized pattern requires QNN 2.48+. Resolving the SDK version
# relies on QNN_SDK_ROOT; when it is unavailable (e.g. AOT-only
# environments) fall back to the legacy lowering, which is valid on all
# QNN versions.
if not os.environ.get("QNN_SDK_ROOT") or is_qnn_sdk_version_less_than("2.48"):
return self.define_node_legacy(node, nodes_to_wrappers)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. meta-exported

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants