Ship runtime/executor and runtime/backend headers in pip wheel

[kirklandsign]

Summary

The hard-coded list of header directories in setup.py's CustomBuildPy diverged from the cmake install(DIRECTORY ...) rules in CMakeLists.txt, so runtime/executor/*.h (e.g. method.h, program.h, method_meta.h) and runtime/backend/*.h were never copied into the pip wheel's include/executorch/... tree.

Fixes: #7261

Test plan

CI

[pytorch-bot]

🔗 Helpful Links

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

• 📄 Preview Python docs built from this PR

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

❗ 1 Active SEVs

There are 1 currently active SEVs. If your PR is affected, please view them below:

• Rolling out OSDC (ARC) runners on pull & trunk workflows in PyTorch main

❌ 1 New Failure, 4 Cancelled Jobs, 1 Unrelated Failure

As of commit 81d5c34 with merge base c4ec988 ():

NEW FAILURE - The following job has failed:

• Cadence Build & Test / cpu-test / test-aot / test-aot (gh)
  backends/cadence/aot/tests/test_replace_ops_passes.py::TestReplaceOpsPasses::test_replace_conv2d_with_linear

CANCELLED JOBS - The following jobs were cancelled. Please retry:

• pull / test-multimodal-linux (gemma3-4b) / linux-job (gh)
• pull / test-voxtral-realtime-xnnpack-linux / linux-job (gh)
  ##[error]The operation was canceled.
• pull / unittest / macos / macos-job (gh)
  ##[error]The operation was canceled.
• pull / unittest-editable / macos / macos-job (gh)

FLAKY - The following job failed but was likely due to flakiness present on trunk:

• pull / unittest-arm-backend-with-no-deps (test_pytest_models_tosa) / linux-job (gh) (matched linux rule in flaky-rules.json)
  The runner has received a shutdown signal. This can happen when the runner service is stopped, or a manually started runner is canceled.

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

[github-actions]

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.

[Copilot]

Pull request overview

Updates the pip wheel build to ship additional runtime headers so downstream users (e.g., Android demo / C++ extensions) can include ExecuTorch runtime APIs after pip install.

Changes:

• Add runtime/executor/ to the header directories copied into the wheel include tree.
• Add runtime/backend/ to the header directories copied into the wheel include tree.

---

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

[Copilot]

While aligning the header directory list with the CMake install() rules, note that CMake also installs a generated runtime/core/version.h (from runtime/core/version.h.in). The current wheel header-copy logic only rglobs *.h from the source tree, so include/executorch/runtime/core/version.h will still be missing from the pip wheel. Consider copying the generated header from the CMake build dir (e.g. ${cmake_cache_dir}/include/executorch/runtime/core/version.h) into the wheel include tree to fully match the CMake install set.

[kirklandsign]

/claude review

[kirklandsign]

@claude review

[claude]

Claude finished @kirklandsign's task in 1m 34s —— View job

---

Review of PR #19196

• Read the PR diff and changed files
• Review setup.py context around the change
• Cross-reference with CMake install rules
• Provide review feedback

---

LGTM — this is a correct and straightforward fix.

The setup.py header list at line 600 was missing runtime/executor/ and runtime/backend/, while CMake's install(DIRECTORY ...) rules at CMakeLists.txt:610-627 have always installed both. This PR brings the two in sync.

I verified the directories exist and contain the expected headers:

• runtime/executor/: 9 headers (method.h, program.h, method_meta.h, memory_manager.h, etc.)
• runtime/backend/: 6 headers (interface.h, options.h, backend_execution_context.h, etc.)

The ordering in the list now matches the CMake install order (core → executor → kernel → backend → platform), which is a nice touch for maintainability.

One pre-existing gap worth noting (not a blocker for this PR): CMake also installs a generated runtime/core/version.h (from version.h.in, see CMakeLists.txt:605-609). Since this file only exists in the build directory (not the source tree), the rglob("*.h") approach won't pick it up. Today version.h is only included by a test file, so this is low-impact, but if it becomes part of the public API it'll need a separate copy step similar to what CMake does. The existing TODO comment at line 597 ("Use cmake to gather the headers instead of hard-coding them here") would address this holistically.

CI failure (test_replace_conv2d_with_linear in the Cadence backend) is unrelated to this change — it's in a Cadence AOT test pass, not in header packaging.

---