Make _get_program_from_buffer work for bundled programs#14435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zingo merged 2 commits into from
Sep 22, 2025
Merged

Make _get_program_from_buffer work for bundled programs #14435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89ffa17
Make _get_program_from_buffer work for bundled programs
Erik-Lundell Sep 15, 2025
93d51bb
Arm backend: Allow autogen included ops with bundleio
Erik-Lundell Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -738,9 +738,6 @@ endif()

if(EXECUTORCH_BUILD_PYBIND)

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

if(NOT EXECUTORCH_BUILD_EXTENSION_DATA_LOADER)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/data_loader)
endif()
Expand All@@ -749,6 +746,9 @@ if(EXECUTORCH_BUILD_PYBIND)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/devtools)
endif()

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

# Create bundled_module target only for pybindings when bundled_program exists
# This target has hard dependencies on devtools generated headers
if(TARGET bundled_program)
Expand Down
5 changes: 5 additions & 0 deletions codegen/tools/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
# Copyright 2025 Arm Limited and/or its affiliates.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
Expand DownExpand Up@@ -28,6 +29,10 @@ target_compile_options(
)

# Link against required libraries
if(TARGET bundled_program)
target_compile_definitions(selective_build PRIVATE -DET_BUNDLE_IO)
target_link_libraries(selective_build PRIVATE bundled_program)
endif()
target_link_libraries(selective_build PRIVATE executorch_core program_schema)

# Install the module
Expand Down
42 changes: 39 additions & 3 deletions codegen/tools/selective_build.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
* Copyright 2025 Arm Limited and/or its affiliates.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#ifdef ET_BUNDLE_IO
#include <executorch/devtools/bundled_program/bundled_program.h>
#include <stdexcept>
#endif

namespace py = pybind11;

Expand DownExpand Up@@ -186,8 +191,39 @@ get_kernel_tensor_metadatas_from_execution_plan(

const executorch_flatbuffer::Program* _get_program_from_buffer(
const py::bytes& buffer) {
// Access the Python bytes without copying and get raw pointer/size.
const std::string_view sv = buffer.cast<std::string_view>();
void* buf_ptr = const_cast<void*>(static_cast<const void*>(sv.data()));
const size_t buf_len = sv.size();
#ifdef ET_BUNDLE_IO

// If this is a bundled program, extract the inner ExecuTorch program bytes.
if (executorch::bundled_program::is_bundled_program(buf_ptr, buf_len)) {
const void* program_data = nullptr;
size_t program_size = 0;

const auto status = executorch::bundled_program::get_program_data(
buf_ptr, // serialized BundledProgram start
buf_len, // total size of the BundledProgram blob
&program_data, // [out] pointer to inner .pte bytes
&program_size // [out] size of inner .pte bytes
);

if (status != ::executorch::runtime::Error::Ok || program_data == nullptr ||
program_size == 0) {
throw std::runtime_error(
"bundled_program::get_program_data() failed or returned empty data");
}

// program_data points directly at the flatbuffer-encoded Program region.
return executorch_flatbuffer::GetProgram(
reinterpret_cast<const uint8_t*>(program_data));
}
#endif
// Otherwise treat the buffer as a raw .pte (flatbuffer Program with optional
// extended header).
return executorch_flatbuffer::GetProgram(
buffer.cast<std::string_view>().data());
reinterpret_cast<const uint8_t*>(sv.data()));
}

py::list _get_program_operators(const executorch_flatbuffer::Program* program) {
Expand Down
3 changes: 1 addition & 2 deletions docs/source/backends-arm-ethos-u.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -268,8 +268,7 @@ You can see how this coupling between the memory mode and runtime application i

The arm_executor_runner supports [bundled-io](https://docs.pytorch.org/executorch/0.4/bundled-io.html) and [ETdump](https://docs.pytorch.org/executorch/stable/etdump.html) debugging tools.

To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. Currently using bundled-io requires specifying your
non delegated Aten ops manually by setting `EXECUTORCH_SELECT_OPS_LIST`. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
when building the executor_runner.


Expand Down
13 changes: 4 additions & 9 deletions examples/arm/executor_runner/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -235,10 +235,10 @@ list(
-Map=arm_executor_runner.map
)

# Prefer to generate kernel bindings from model file if possible, which is when
# 1. Not building for semihosting 2. Not building with bundleio If that is not
# the case, fallback to select_ops_list If the model file does not contain any
# aten ops, a workaround is currently needed to avoid crashing.
# Figure out which ops to include: For semihosting build, use
# (user-set)SELECT_OPS_MODEL variable. For normal build, use
# EXECUTORCH_SELECT_OPS_MODEL to include ops automatically. If the pte contains
# no undelegated ops, use neither.
execute_process(
COMMAND
python "${ET_DIR_PATH}/codegen/tools/gen_oplist.py"
Expand All@@ -264,11 +264,6 @@ elseif(${FOUND_OPS_IN_FILE})
message(
"gen_oplist: EXECUTORCH_SELECT_OPS_MODEL=${ET_PTE_FILE_PATH} is used to auto generate ops from"
)
elseif(NOT ${FOUND_OPS_IN_FILE} AND ${ET_BUNDLE_IO})
set(EXECUTORCH_SELECT_OPS_MODEL "")
message(
"gen_oplist: Building with ET_BUNDLE_IO and .bpte is not supported to auto generate ops from will use EXECUTORCH_SELECT_OPS_LIST=${EXECUTORCH_SELECT_OPS_LIST}"
)
else()
set(EXECUTORCH_SELECT_OPS_LIST "")
set(EXECUTORCH_SELECT_OPS_MODEL "")
Expand Down
4 changes: 2 additions & 2 deletions examples/arm/run.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ function help() {
echo " --no_delegate Do not delegate the model (can't override builtin models)"
echo " --no_quantize Do not quantize the model (can't override builtin models)"
echo " --portable_kernels=<OPS> TO BE DEPRECATED: Alias to select_ops_list."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delegated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is used when select_ops_model is not possible to use, e.g. for semihosting or bundleio."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delagated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is only used when building for semihosting."
echo " See https://docs.pytorch.org/executorch/stable/kernel-library-selective-build.html for more information."
echo " --target=<TARGET> Target to build and run for Default: ${target}"
echo " --output=<FOLDER> Target build output folder Default: ${output_folder}"
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Make _get_program_from_buffer work for bundled programs#14435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zingo merged 2 commits into from
Sep 22, 2025
Merged

Make _get_program_from_buffer work for bundled programs #14435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89ffa17
Make _get_program_from_buffer work for bundled programs
Erik-Lundell Sep 15, 2025
93d51bb
Arm backend: Allow autogen included ops with bundleio
Erik-Lundell Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -738,9 +738,6 @@ endif()

if(EXECUTORCH_BUILD_PYBIND)

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

if(NOT EXECUTORCH_BUILD_EXTENSION_DATA_LOADER)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/data_loader)
endif()
Expand All@@ -749,6 +746,9 @@ if(EXECUTORCH_BUILD_PYBIND)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/devtools)
endif()

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

# Create bundled_module target only for pybindings when bundled_program exists
# This target has hard dependencies on devtools generated headers
if(TARGET bundled_program)
Expand Down
5 changes: 5 additions & 0 deletions codegen/tools/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
# Copyright 2025 Arm Limited and/or its affiliates.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
Expand DownExpand Up@@ -28,6 +29,10 @@ target_compile_options(
)

# Link against required libraries
if(TARGET bundled_program)
target_compile_definitions(selective_build PRIVATE -DET_BUNDLE_IO)
target_link_libraries(selective_build PRIVATE bundled_program)
endif()
target_link_libraries(selective_build PRIVATE executorch_core program_schema)

# Install the module
Expand Down
42 changes: 39 additions & 3 deletions codegen/tools/selective_build.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
* Copyright 2025 Arm Limited and/or its affiliates.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#ifdef ET_BUNDLE_IO
#include <executorch/devtools/bundled_program/bundled_program.h>
#include <stdexcept>
#endif

namespace py = pybind11;

Expand DownExpand Up@@ -186,8 +191,39 @@ get_kernel_tensor_metadatas_from_execution_plan(

const executorch_flatbuffer::Program* _get_program_from_buffer(
const py::bytes& buffer) {
// Access the Python bytes without copying and get raw pointer/size.
const std::string_view sv = buffer.cast<std::string_view>();
void* buf_ptr = const_cast<void*>(static_cast<const void*>(sv.data()));
const size_t buf_len = sv.size();
#ifdef ET_BUNDLE_IO

// If this is a bundled program, extract the inner ExecuTorch program bytes.
if (executorch::bundled_program::is_bundled_program(buf_ptr, buf_len)) {
const void* program_data = nullptr;
size_t program_size = 0;

const auto status = executorch::bundled_program::get_program_data(
buf_ptr, // serialized BundledProgram start
buf_len, // total size of the BundledProgram blob
&program_data, // [out] pointer to inner .pte bytes
&program_size // [out] size of inner .pte bytes
);

if (status != ::executorch::runtime::Error::Ok || program_data == nullptr ||
program_size == 0) {
throw std::runtime_error(
"bundled_program::get_program_data() failed or returned empty data");
}

// program_data points directly at the flatbuffer-encoded Program region.
return executorch_flatbuffer::GetProgram(
reinterpret_cast<const uint8_t*>(program_data));
}
#endif
// Otherwise treat the buffer as a raw .pte (flatbuffer Program with optional
// extended header).
return executorch_flatbuffer::GetProgram(
buffer.cast<std::string_view>().data());
reinterpret_cast<const uint8_t*>(sv.data()));
}

py::list _get_program_operators(const executorch_flatbuffer::Program* program) {
Expand Down
3 changes: 1 addition & 2 deletions docs/source/backends-arm-ethos-u.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -268,8 +268,7 @@ You can see how this coupling between the memory mode and runtime application i

The arm_executor_runner supports [bundled-io](https://docs.pytorch.org/executorch/0.4/bundled-io.html) and [ETdump](https://docs.pytorch.org/executorch/stable/etdump.html) debugging tools.

To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. Currently using bundled-io requires specifying your
non delegated Aten ops manually by setting `EXECUTORCH_SELECT_OPS_LIST`. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
when building the executor_runner.


Expand Down
13 changes: 4 additions & 9 deletions examples/arm/executor_runner/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -235,10 +235,10 @@ list(
-Map=arm_executor_runner.map
)

# Prefer to generate kernel bindings from model file if possible, which is when
# 1. Not building for semihosting 2. Not building with bundleio If that is not
# the case, fallback to select_ops_list If the model file does not contain any
# aten ops, a workaround is currently needed to avoid crashing.
# Figure out which ops to include: For semihosting build, use
# (user-set)SELECT_OPS_MODEL variable. For normal build, use
# EXECUTORCH_SELECT_OPS_MODEL to include ops automatically. If the pte contains
# no undelegated ops, use neither.
execute_process(
COMMAND
python "${ET_DIR_PATH}/codegen/tools/gen_oplist.py"
Expand All@@ -264,11 +264,6 @@ elseif(${FOUND_OPS_IN_FILE})
message(
"gen_oplist: EXECUTORCH_SELECT_OPS_MODEL=${ET_PTE_FILE_PATH} is used to auto generate ops from"
)
elseif(NOT ${FOUND_OPS_IN_FILE} AND ${ET_BUNDLE_IO})
set(EXECUTORCH_SELECT_OPS_MODEL "")
message(
"gen_oplist: Building with ET_BUNDLE_IO and .bpte is not supported to auto generate ops from will use EXECUTORCH_SELECT_OPS_LIST=${EXECUTORCH_SELECT_OPS_LIST}"
)
else()
set(EXECUTORCH_SELECT_OPS_LIST "")
set(EXECUTORCH_SELECT_OPS_MODEL "")
Expand Down
4 changes: 2 additions & 2 deletions examples/arm/run.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ function help() {
echo " --no_delegate Do not delegate the model (can't override builtin models)"
echo " --no_quantize Do not quantize the model (can't override builtin models)"
echo " --portable_kernels=<OPS> TO BE DEPRECATED: Alias to select_ops_list."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delegated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is used when select_ops_model is not possible to use, e.g. for semihosting or bundleio."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delagated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is only used when building for semihosting."
echo " See https://docs.pytorch.org/executorch/stable/kernel-library-selective-build.html for more information."
echo " --target=<TARGET> Target to build and run for Default: ${target}"
echo " --output=<FOLDER> Target build output folder Default: ${output_folder}"
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Make _get_program_from_buffer work for bundled programs#14435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zingo merged 2 commits into from
Sep 22, 2025
Merged

Make _get_program_from_buffer work for bundled programs #14435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89ffa17
Make _get_program_from_buffer work for bundled programs
Erik-Lundell Sep 15, 2025
93d51bb
Arm backend: Allow autogen included ops with bundleio
Erik-Lundell Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -738,9 +738,6 @@ endif()

if(EXECUTORCH_BUILD_PYBIND)

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

if(NOT EXECUTORCH_BUILD_EXTENSION_DATA_LOADER)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/data_loader)
endif()
Expand All@@ -749,6 +746,9 @@ if(EXECUTORCH_BUILD_PYBIND)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/devtools)
endif()

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

# Create bundled_module target only for pybindings when bundled_program exists
# This target has hard dependencies on devtools generated headers
if(TARGET bundled_program)
Expand Down
5 changes: 5 additions & 0 deletions codegen/tools/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
# Copyright 2025 Arm Limited and/or its affiliates.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
Expand DownExpand Up@@ -28,6 +29,10 @@ target_compile_options(
)

# Link against required libraries
if(TARGET bundled_program)
target_compile_definitions(selective_build PRIVATE -DET_BUNDLE_IO)
target_link_libraries(selective_build PRIVATE bundled_program)
endif()
target_link_libraries(selective_build PRIVATE executorch_core program_schema)

# Install the module
Expand Down
42 changes: 39 additions & 3 deletions codegen/tools/selective_build.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
* Copyright 2025 Arm Limited and/or its affiliates.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#ifdef ET_BUNDLE_IO
#include <executorch/devtools/bundled_program/bundled_program.h>
#include <stdexcept>
#endif

namespace py = pybind11;

Expand DownExpand Up@@ -186,8 +191,39 @@ get_kernel_tensor_metadatas_from_execution_plan(

const executorch_flatbuffer::Program* _get_program_from_buffer(
const py::bytes& buffer) {
// Access the Python bytes without copying and get raw pointer/size.
const std::string_view sv = buffer.cast<std::string_view>();
void* buf_ptr = const_cast<void*>(static_cast<const void*>(sv.data()));
const size_t buf_len = sv.size();
#ifdef ET_BUNDLE_IO

// If this is a bundled program, extract the inner ExecuTorch program bytes.
if (executorch::bundled_program::is_bundled_program(buf_ptr, buf_len)) {
const void* program_data = nullptr;
size_t program_size = 0;

const auto status = executorch::bundled_program::get_program_data(
buf_ptr, // serialized BundledProgram start
buf_len, // total size of the BundledProgram blob
&program_data, // [out] pointer to inner .pte bytes
&program_size // [out] size of inner .pte bytes
);

if (status != ::executorch::runtime::Error::Ok || program_data == nullptr ||
program_size == 0) {
throw std::runtime_error(
"bundled_program::get_program_data() failed or returned empty data");
}

// program_data points directly at the flatbuffer-encoded Program region.
return executorch_flatbuffer::GetProgram(
reinterpret_cast<const uint8_t*>(program_data));
}
#endif
// Otherwise treat the buffer as a raw .pte (flatbuffer Program with optional
// extended header).
return executorch_flatbuffer::GetProgram(
buffer.cast<std::string_view>().data());
reinterpret_cast<const uint8_t*>(sv.data()));
}

py::list _get_program_operators(const executorch_flatbuffer::Program* program) {
Expand Down
3 changes: 1 addition & 2 deletions docs/source/backends-arm-ethos-u.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -268,8 +268,7 @@ You can see how this coupling between the memory mode and runtime application i

The arm_executor_runner supports [bundled-io](https://docs.pytorch.org/executorch/0.4/bundled-io.html) and [ETdump](https://docs.pytorch.org/executorch/stable/etdump.html) debugging tools.

To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. Currently using bundled-io requires specifying your
non delegated Aten ops manually by setting `EXECUTORCH_SELECT_OPS_LIST`. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
when building the executor_runner.


Expand Down
13 changes: 4 additions & 9 deletions examples/arm/executor_runner/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -235,10 +235,10 @@ list(
-Map=arm_executor_runner.map
)

# Prefer to generate kernel bindings from model file if possible, which is when
# 1. Not building for semihosting 2. Not building with bundleio If that is not
# the case, fallback to select_ops_list If the model file does not contain any
# aten ops, a workaround is currently needed to avoid crashing.
# Figure out which ops to include: For semihosting build, use
# (user-set)SELECT_OPS_MODEL variable. For normal build, use
# EXECUTORCH_SELECT_OPS_MODEL to include ops automatically. If the pte contains
# no undelegated ops, use neither.
execute_process(
COMMAND
python "${ET_DIR_PATH}/codegen/tools/gen_oplist.py"
Expand All@@ -264,11 +264,6 @@ elseif(${FOUND_OPS_IN_FILE})
message(
"gen_oplist: EXECUTORCH_SELECT_OPS_MODEL=${ET_PTE_FILE_PATH} is used to auto generate ops from"
)
elseif(NOT ${FOUND_OPS_IN_FILE} AND ${ET_BUNDLE_IO})
set(EXECUTORCH_SELECT_OPS_MODEL "")
message(
"gen_oplist: Building with ET_BUNDLE_IO and .bpte is not supported to auto generate ops from will use EXECUTORCH_SELECT_OPS_LIST=${EXECUTORCH_SELECT_OPS_LIST}"
)
else()
set(EXECUTORCH_SELECT_OPS_LIST "")
set(EXECUTORCH_SELECT_OPS_MODEL "")
Expand Down
4 changes: 2 additions & 2 deletions examples/arm/run.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ function help() {
echo " --no_delegate Do not delegate the model (can't override builtin models)"
echo " --no_quantize Do not quantize the model (can't override builtin models)"
echo " --portable_kernels=<OPS> TO BE DEPRECATED: Alias to select_ops_list."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delegated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is used when select_ops_model is not possible to use, e.g. for semihosting or bundleio."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delagated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is only used when building for semihosting."
echo " See https://docs.pytorch.org/executorch/stable/kernel-library-selective-build.html for more information."
echo " --target=<TARGET> Target to build and run for Default: ${target}"
echo " --output=<FOLDER> Target build output folder Default: ${output_folder}"
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Make _get_program_from_buffer work for bundled programs#14435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zingo merged 2 commits into from
Sep 22, 2025
Merged

Make _get_program_from_buffer work for bundled programs #14435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89ffa17
Make _get_program_from_buffer work for bundled programs
Erik-Lundell Sep 15, 2025
93d51bb
Arm backend: Allow autogen included ops with bundleio
Erik-Lundell Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -738,9 +738,6 @@ endif()

if(EXECUTORCH_BUILD_PYBIND)

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

if(NOT EXECUTORCH_BUILD_EXTENSION_DATA_LOADER)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/data_loader)
endif()
Expand All@@ -749,6 +746,9 @@ if(EXECUTORCH_BUILD_PYBIND)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/devtools)
endif()

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

# Create bundled_module target only for pybindings when bundled_program exists
# This target has hard dependencies on devtools generated headers
if(TARGET bundled_program)
Expand Down
5 changes: 5 additions & 0 deletions codegen/tools/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
# Copyright 2025 Arm Limited and/or its affiliates.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
Expand DownExpand Up@@ -28,6 +29,10 @@ target_compile_options(
)

# Link against required libraries
if(TARGET bundled_program)
target_compile_definitions(selective_build PRIVATE -DET_BUNDLE_IO)
target_link_libraries(selective_build PRIVATE bundled_program)
endif()
target_link_libraries(selective_build PRIVATE executorch_core program_schema)

# Install the module
Expand Down
42 changes: 39 additions & 3 deletions codegen/tools/selective_build.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
* Copyright 2025 Arm Limited and/or its affiliates.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#ifdef ET_BUNDLE_IO
#include <executorch/devtools/bundled_program/bundled_program.h>
#include <stdexcept>
#endif

namespace py = pybind11;

Expand DownExpand Up@@ -186,8 +191,39 @@ get_kernel_tensor_metadatas_from_execution_plan(

const executorch_flatbuffer::Program* _get_program_from_buffer(
const py::bytes& buffer) {
// Access the Python bytes without copying and get raw pointer/size.
const std::string_view sv = buffer.cast<std::string_view>();
void* buf_ptr = const_cast<void*>(static_cast<const void*>(sv.data()));
const size_t buf_len = sv.size();
#ifdef ET_BUNDLE_IO

// If this is a bundled program, extract the inner ExecuTorch program bytes.
if (executorch::bundled_program::is_bundled_program(buf_ptr, buf_len)) {
const void* program_data = nullptr;
size_t program_size = 0;

const auto status = executorch::bundled_program::get_program_data(
buf_ptr, // serialized BundledProgram start
buf_len, // total size of the BundledProgram blob
&program_data, // [out] pointer to inner .pte bytes
&program_size // [out] size of inner .pte bytes
);

if (status != ::executorch::runtime::Error::Ok || program_data == nullptr ||
program_size == 0) {
throw std::runtime_error(
"bundled_program::get_program_data() failed or returned empty data");
}

// program_data points directly at the flatbuffer-encoded Program region.
return executorch_flatbuffer::GetProgram(
reinterpret_cast<const uint8_t*>(program_data));
}
#endif
// Otherwise treat the buffer as a raw .pte (flatbuffer Program with optional
// extended header).
return executorch_flatbuffer::GetProgram(
buffer.cast<std::string_view>().data());
reinterpret_cast<const uint8_t*>(sv.data()));
}

py::list _get_program_operators(const executorch_flatbuffer::Program* program) {
Expand Down
3 changes: 1 addition & 2 deletions docs/source/backends-arm-ethos-u.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -268,8 +268,7 @@ You can see how this coupling between the memory mode and runtime application i

The arm_executor_runner supports [bundled-io](https://docs.pytorch.org/executorch/0.4/bundled-io.html) and [ETdump](https://docs.pytorch.org/executorch/stable/etdump.html) debugging tools.

To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. Currently using bundled-io requires specifying your
non delegated Aten ops manually by setting `EXECUTORCH_SELECT_OPS_LIST`. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
when building the executor_runner.


Expand Down
13 changes: 4 additions & 9 deletions examples/arm/executor_runner/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -235,10 +235,10 @@ list(
-Map=arm_executor_runner.map
)

# Prefer to generate kernel bindings from model file if possible, which is when
# 1. Not building for semihosting 2. Not building with bundleio If that is not
# the case, fallback to select_ops_list If the model file does not contain any
# aten ops, a workaround is currently needed to avoid crashing.
# Figure out which ops to include: For semihosting build, use
# (user-set)SELECT_OPS_MODEL variable. For normal build, use
# EXECUTORCH_SELECT_OPS_MODEL to include ops automatically. If the pte contains
# no undelegated ops, use neither.
execute_process(
COMMAND
python "${ET_DIR_PATH}/codegen/tools/gen_oplist.py"
Expand All@@ -264,11 +264,6 @@ elseif(${FOUND_OPS_IN_FILE})
message(
"gen_oplist: EXECUTORCH_SELECT_OPS_MODEL=${ET_PTE_FILE_PATH} is used to auto generate ops from"
)
elseif(NOT ${FOUND_OPS_IN_FILE} AND ${ET_BUNDLE_IO})
set(EXECUTORCH_SELECT_OPS_MODEL "")
message(
"gen_oplist: Building with ET_BUNDLE_IO and .bpte is not supported to auto generate ops from will use EXECUTORCH_SELECT_OPS_LIST=${EXECUTORCH_SELECT_OPS_LIST}"
)
else()
set(EXECUTORCH_SELECT_OPS_LIST "")
set(EXECUTORCH_SELECT_OPS_MODEL "")
Expand Down
4 changes: 2 additions & 2 deletions examples/arm/run.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ function help() {
echo " --no_delegate Do not delegate the model (can't override builtin models)"
echo " --no_quantize Do not quantize the model (can't override builtin models)"
echo " --portable_kernels=<OPS> TO BE DEPRECATED: Alias to select_ops_list."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delegated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is used when select_ops_model is not possible to use, e.g. for semihosting or bundleio."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delagated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is only used when building for semihosting."
echo " See https://docs.pytorch.org/executorch/stable/kernel-library-selective-build.html for more information."
echo " --target=<TARGET> Target to build and run for Default: ${target}"
echo " --output=<FOLDER> Target build output folder Default: ${output_folder}"
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Make _get_program_from_buffer work for bundled programs#14435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zingo merged 2 commits into from
Sep 22, 2025
Merged

Make _get_program_from_buffer work for bundled programs #14435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89ffa17
Make _get_program_from_buffer work for bundled programs
Erik-Lundell Sep 15, 2025
93d51bb
Arm backend: Allow autogen included ops with bundleio
Erik-Lundell Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -738,9 +738,6 @@ endif()

if(EXECUTORCH_BUILD_PYBIND)

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

if(NOT EXECUTORCH_BUILD_EXTENSION_DATA_LOADER)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/data_loader)
endif()
Expand All@@ -749,6 +746,9 @@ if(EXECUTORCH_BUILD_PYBIND)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/devtools)
endif()

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

# Create bundled_module target only for pybindings when bundled_program exists
# This target has hard dependencies on devtools generated headers
if(TARGET bundled_program)
Expand Down
5 changes: 5 additions & 0 deletions codegen/tools/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
# Copyright 2025 Arm Limited and/or its affiliates.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
Expand DownExpand Up@@ -28,6 +29,10 @@ target_compile_options(
)

# Link against required libraries
if(TARGET bundled_program)
target_compile_definitions(selective_build PRIVATE -DET_BUNDLE_IO)
target_link_libraries(selective_build PRIVATE bundled_program)
endif()
target_link_libraries(selective_build PRIVATE executorch_core program_schema)

# Install the module
Expand Down
42 changes: 39 additions & 3 deletions codegen/tools/selective_build.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
* Copyright 2025 Arm Limited and/or its affiliates.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#ifdef ET_BUNDLE_IO
#include <executorch/devtools/bundled_program/bundled_program.h>
#include <stdexcept>
#endif

namespace py = pybind11;

Expand DownExpand Up@@ -186,8 +191,39 @@ get_kernel_tensor_metadatas_from_execution_plan(

const executorch_flatbuffer::Program* _get_program_from_buffer(
const py::bytes& buffer) {
// Access the Python bytes without copying and get raw pointer/size.
const std::string_view sv = buffer.cast<std::string_view>();
void* buf_ptr = const_cast<void*>(static_cast<const void*>(sv.data()));
const size_t buf_len = sv.size();
#ifdef ET_BUNDLE_IO

// If this is a bundled program, extract the inner ExecuTorch program bytes.
if (executorch::bundled_program::is_bundled_program(buf_ptr, buf_len)) {
const void* program_data = nullptr;
size_t program_size = 0;

const auto status = executorch::bundled_program::get_program_data(
buf_ptr, // serialized BundledProgram start
buf_len, // total size of the BundledProgram blob
&program_data, // [out] pointer to inner .pte bytes
&program_size // [out] size of inner .pte bytes
);

if (status != ::executorch::runtime::Error::Ok || program_data == nullptr ||
program_size == 0) {
throw std::runtime_error(
"bundled_program::get_program_data() failed or returned empty data");
}

// program_data points directly at the flatbuffer-encoded Program region.
return executorch_flatbuffer::GetProgram(
reinterpret_cast<const uint8_t*>(program_data));
}
#endif
// Otherwise treat the buffer as a raw .pte (flatbuffer Program with optional
// extended header).
return executorch_flatbuffer::GetProgram(
buffer.cast<std::string_view>().data());
reinterpret_cast<const uint8_t*>(sv.data()));
}

py::list _get_program_operators(const executorch_flatbuffer::Program* program) {
Expand Down
3 changes: 1 addition & 2 deletions docs/source/backends-arm-ethos-u.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -268,8 +268,7 @@ You can see how this coupling between the memory mode and runtime application i

The arm_executor_runner supports [bundled-io](https://docs.pytorch.org/executorch/0.4/bundled-io.html) and [ETdump](https://docs.pytorch.org/executorch/stable/etdump.html) debugging tools.

To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. Currently using bundled-io requires specifying your
non delegated Aten ops manually by setting `EXECUTORCH_SELECT_OPS_LIST`. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
when building the executor_runner.


Expand Down
13 changes: 4 additions & 9 deletions examples/arm/executor_runner/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -235,10 +235,10 @@ list(
-Map=arm_executor_runner.map
)

# Prefer to generate kernel bindings from model file if possible, which is when
# 1. Not building for semihosting 2. Not building with bundleio If that is not
# the case, fallback to select_ops_list If the model file does not contain any
# aten ops, a workaround is currently needed to avoid crashing.
# Figure out which ops to include: For semihosting build, use
# (user-set)SELECT_OPS_MODEL variable. For normal build, use
# EXECUTORCH_SELECT_OPS_MODEL to include ops automatically. If the pte contains
# no undelegated ops, use neither.
execute_process(
COMMAND
python "${ET_DIR_PATH}/codegen/tools/gen_oplist.py"
Expand All@@ -264,11 +264,6 @@ elseif(${FOUND_OPS_IN_FILE})
message(
"gen_oplist: EXECUTORCH_SELECT_OPS_MODEL=${ET_PTE_FILE_PATH} is used to auto generate ops from"
)
elseif(NOT ${FOUND_OPS_IN_FILE} AND ${ET_BUNDLE_IO})
set(EXECUTORCH_SELECT_OPS_MODEL "")
message(
"gen_oplist: Building with ET_BUNDLE_IO and .bpte is not supported to auto generate ops from will use EXECUTORCH_SELECT_OPS_LIST=${EXECUTORCH_SELECT_OPS_LIST}"
)
else()
set(EXECUTORCH_SELECT_OPS_LIST "")
set(EXECUTORCH_SELECT_OPS_MODEL "")
Expand Down
4 changes: 2 additions & 2 deletions examples/arm/run.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ function help() {
echo " --no_delegate Do not delegate the model (can't override builtin models)"
echo " --no_quantize Do not quantize the model (can't override builtin models)"
echo " --portable_kernels=<OPS> TO BE DEPRECATED: Alias to select_ops_list."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delegated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is used when select_ops_model is not possible to use, e.g. for semihosting or bundleio."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delagated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is only used when building for semihosting."
echo " See https://docs.pytorch.org/executorch/stable/kernel-library-selective-build.html for more information."
echo " --target=<TARGET> Target to build and run for Default: ${target}"
echo " --output=<FOLDER> Target build output folder Default: ${output_folder}"
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Make _get_program_from_buffer work for bundled programs#14435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zingo merged 2 commits into from
Sep 22, 2025
Merged

Make _get_program_from_buffer work for bundled programs #14435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89ffa17
Make _get_program_from_buffer work for bundled programs
Erik-Lundell Sep 15, 2025
93d51bb
Arm backend: Allow autogen included ops with bundleio
Erik-Lundell Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -738,9 +738,6 @@ endif()

if(EXECUTORCH_BUILD_PYBIND)

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

if(NOT EXECUTORCH_BUILD_EXTENSION_DATA_LOADER)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/data_loader)
endif()
Expand All@@ -749,6 +746,9 @@ if(EXECUTORCH_BUILD_PYBIND)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/devtools)
endif()

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

# Create bundled_module target only for pybindings when bundled_program exists
# This target has hard dependencies on devtools generated headers
if(TARGET bundled_program)
Expand Down
5 changes: 5 additions & 0 deletions codegen/tools/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
# Copyright 2025 Arm Limited and/or its affiliates.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
Expand DownExpand Up@@ -28,6 +29,10 @@ target_compile_options(
)

# Link against required libraries
if(TARGET bundled_program)
target_compile_definitions(selective_build PRIVATE -DET_BUNDLE_IO)
target_link_libraries(selective_build PRIVATE bundled_program)
endif()
target_link_libraries(selective_build PRIVATE executorch_core program_schema)

# Install the module
Expand Down
42 changes: 39 additions & 3 deletions codegen/tools/selective_build.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
* Copyright 2025 Arm Limited and/or its affiliates.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#ifdef ET_BUNDLE_IO
#include <executorch/devtools/bundled_program/bundled_program.h>
#include <stdexcept>
#endif

namespace py = pybind11;

Expand DownExpand Up@@ -186,8 +191,39 @@ get_kernel_tensor_metadatas_from_execution_plan(

const executorch_flatbuffer::Program* _get_program_from_buffer(
const py::bytes& buffer) {
// Access the Python bytes without copying and get raw pointer/size.
const std::string_view sv = buffer.cast<std::string_view>();
void* buf_ptr = const_cast<void*>(static_cast<const void*>(sv.data()));
const size_t buf_len = sv.size();
#ifdef ET_BUNDLE_IO

// If this is a bundled program, extract the inner ExecuTorch program bytes.
if (executorch::bundled_program::is_bundled_program(buf_ptr, buf_len)) {
const void* program_data = nullptr;
size_t program_size = 0;

const auto status = executorch::bundled_program::get_program_data(
buf_ptr, // serialized BundledProgram start
buf_len, // total size of the BundledProgram blob
&program_data, // [out] pointer to inner .pte bytes
&program_size // [out] size of inner .pte bytes
);

if (status != ::executorch::runtime::Error::Ok || program_data == nullptr ||
program_size == 0) {
throw std::runtime_error(
"bundled_program::get_program_data() failed or returned empty data");
}

// program_data points directly at the flatbuffer-encoded Program region.
return executorch_flatbuffer::GetProgram(
reinterpret_cast<const uint8_t*>(program_data));
}
#endif
// Otherwise treat the buffer as a raw .pte (flatbuffer Program with optional
// extended header).
return executorch_flatbuffer::GetProgram(
buffer.cast<std::string_view>().data());
reinterpret_cast<const uint8_t*>(sv.data()));
}

py::list _get_program_operators(const executorch_flatbuffer::Program* program) {
Expand Down
3 changes: 1 addition & 2 deletions docs/source/backends-arm-ethos-u.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -268,8 +268,7 @@ You can see how this coupling between the memory mode and runtime application i

The arm_executor_runner supports [bundled-io](https://docs.pytorch.org/executorch/0.4/bundled-io.html) and [ETdump](https://docs.pytorch.org/executorch/stable/etdump.html) debugging tools.

To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. Currently using bundled-io requires specifying your
non delegated Aten ops manually by setting `EXECUTORCH_SELECT_OPS_LIST`. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
when building the executor_runner.


Expand Down
13 changes: 4 additions & 9 deletions examples/arm/executor_runner/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -235,10 +235,10 @@ list(
-Map=arm_executor_runner.map
)

# Prefer to generate kernel bindings from model file if possible, which is when
# 1. Not building for semihosting 2. Not building with bundleio If that is not
# the case, fallback to select_ops_list If the model file does not contain any
# aten ops, a workaround is currently needed to avoid crashing.
# Figure out which ops to include: For semihosting build, use
# (user-set)SELECT_OPS_MODEL variable. For normal build, use
# EXECUTORCH_SELECT_OPS_MODEL to include ops automatically. If the pte contains
# no undelegated ops, use neither.
execute_process(
COMMAND
python "${ET_DIR_PATH}/codegen/tools/gen_oplist.py"
Expand All@@ -264,11 +264,6 @@ elseif(${FOUND_OPS_IN_FILE})
message(
"gen_oplist: EXECUTORCH_SELECT_OPS_MODEL=${ET_PTE_FILE_PATH} is used to auto generate ops from"
)
elseif(NOT ${FOUND_OPS_IN_FILE} AND ${ET_BUNDLE_IO})
set(EXECUTORCH_SELECT_OPS_MODEL "")
message(
"gen_oplist: Building with ET_BUNDLE_IO and .bpte is not supported to auto generate ops from will use EXECUTORCH_SELECT_OPS_LIST=${EXECUTORCH_SELECT_OPS_LIST}"
)
else()
set(EXECUTORCH_SELECT_OPS_LIST "")
set(EXECUTORCH_SELECT_OPS_MODEL "")
Expand Down
4 changes: 2 additions & 2 deletions examples/arm/run.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ function help() {
echo " --no_delegate Do not delegate the model (can't override builtin models)"
echo " --no_quantize Do not quantize the model (can't override builtin models)"
echo " --portable_kernels=<OPS> TO BE DEPRECATED: Alias to select_ops_list."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delegated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is used when select_ops_model is not possible to use, e.g. for semihosting or bundleio."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delagated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is only used when building for semihosting."
echo " See https://docs.pytorch.org/executorch/stable/kernel-library-selective-build.html for more information."
echo " --target=<TARGET> Target to build and run for Default: ${target}"
echo " --output=<FOLDER> Target build output folder Default: ${output_folder}"
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Make _get_program_from_buffer work for bundled programs#14435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zingo merged 2 commits into from
Sep 22, 2025
Merged

Make _get_program_from_buffer work for bundled programs #14435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89ffa17
Make _get_program_from_buffer work for bundled programs
Erik-Lundell Sep 15, 2025
93d51bb
Arm backend: Allow autogen included ops with bundleio
Erik-Lundell Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -738,9 +738,6 @@ endif()

if(EXECUTORCH_BUILD_PYBIND)

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

if(NOT EXECUTORCH_BUILD_EXTENSION_DATA_LOADER)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/data_loader)
endif()
Expand All@@ -749,6 +746,9 @@ if(EXECUTORCH_BUILD_PYBIND)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/devtools)
endif()

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

# Create bundled_module target only for pybindings when bundled_program exists
# This target has hard dependencies on devtools generated headers
if(TARGET bundled_program)
Expand Down
5 changes: 5 additions & 0 deletions codegen/tools/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
# Copyright 2025 Arm Limited and/or its affiliates.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
Expand DownExpand Up@@ -28,6 +29,10 @@ target_compile_options(
)

# Link against required libraries
if(TARGET bundled_program)
target_compile_definitions(selective_build PRIVATE -DET_BUNDLE_IO)
target_link_libraries(selective_build PRIVATE bundled_program)
endif()
target_link_libraries(selective_build PRIVATE executorch_core program_schema)

# Install the module
Expand Down
42 changes: 39 additions & 3 deletions codegen/tools/selective_build.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
* Copyright 2025 Arm Limited and/or its affiliates.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#ifdef ET_BUNDLE_IO
#include <executorch/devtools/bundled_program/bundled_program.h>
#include <stdexcept>
#endif

namespace py = pybind11;

Expand DownExpand Up@@ -186,8 +191,39 @@ get_kernel_tensor_metadatas_from_execution_plan(

const executorch_flatbuffer::Program* _get_program_from_buffer(
const py::bytes& buffer) {
// Access the Python bytes without copying and get raw pointer/size.
const std::string_view sv = buffer.cast<std::string_view>();
void* buf_ptr = const_cast<void*>(static_cast<const void*>(sv.data()));
const size_t buf_len = sv.size();
#ifdef ET_BUNDLE_IO

// If this is a bundled program, extract the inner ExecuTorch program bytes.
if (executorch::bundled_program::is_bundled_program(buf_ptr, buf_len)) {
const void* program_data = nullptr;
size_t program_size = 0;

const auto status = executorch::bundled_program::get_program_data(
buf_ptr, // serialized BundledProgram start
buf_len, // total size of the BundledProgram blob
&program_data, // [out] pointer to inner .pte bytes
&program_size // [out] size of inner .pte bytes
);

if (status != ::executorch::runtime::Error::Ok || program_data == nullptr ||
program_size == 0) {
throw std::runtime_error(
"bundled_program::get_program_data() failed or returned empty data");
}

// program_data points directly at the flatbuffer-encoded Program region.
return executorch_flatbuffer::GetProgram(
reinterpret_cast<const uint8_t*>(program_data));
}
#endif
// Otherwise treat the buffer as a raw .pte (flatbuffer Program with optional
// extended header).
return executorch_flatbuffer::GetProgram(
buffer.cast<std::string_view>().data());
reinterpret_cast<const uint8_t*>(sv.data()));
}

py::list _get_program_operators(const executorch_flatbuffer::Program* program) {
Expand Down
3 changes: 1 addition & 2 deletions docs/source/backends-arm-ethos-u.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -268,8 +268,7 @@ You can see how this coupling between the memory mode and runtime application i

The arm_executor_runner supports [bundled-io](https://docs.pytorch.org/executorch/0.4/bundled-io.html) and [ETdump](https://docs.pytorch.org/executorch/stable/etdump.html) debugging tools.

To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. Currently using bundled-io requires specifying your
non delegated Aten ops manually by setting `EXECUTORCH_SELECT_OPS_LIST`. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
when building the executor_runner.


Expand Down
13 changes: 4 additions & 9 deletions examples/arm/executor_runner/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -235,10 +235,10 @@ list(
-Map=arm_executor_runner.map
)

# Prefer to generate kernel bindings from model file if possible, which is when
# 1. Not building for semihosting 2. Not building with bundleio If that is not
# the case, fallback to select_ops_list If the model file does not contain any
# aten ops, a workaround is currently needed to avoid crashing.
# Figure out which ops to include: For semihosting build, use
# (user-set)SELECT_OPS_MODEL variable. For normal build, use
# EXECUTORCH_SELECT_OPS_MODEL to include ops automatically. If the pte contains
# no undelegated ops, use neither.
execute_process(
COMMAND
python "${ET_DIR_PATH}/codegen/tools/gen_oplist.py"
Expand All@@ -264,11 +264,6 @@ elseif(${FOUND_OPS_IN_FILE})
message(
"gen_oplist: EXECUTORCH_SELECT_OPS_MODEL=${ET_PTE_FILE_PATH} is used to auto generate ops from"
)
elseif(NOT ${FOUND_OPS_IN_FILE} AND ${ET_BUNDLE_IO})
set(EXECUTORCH_SELECT_OPS_MODEL "")
message(
"gen_oplist: Building with ET_BUNDLE_IO and .bpte is not supported to auto generate ops from will use EXECUTORCH_SELECT_OPS_LIST=${EXECUTORCH_SELECT_OPS_LIST}"
)
else()
set(EXECUTORCH_SELECT_OPS_LIST "")
set(EXECUTORCH_SELECT_OPS_MODEL "")
Expand Down
4 changes: 2 additions & 2 deletions examples/arm/run.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ function help() {
echo " --no_delegate Do not delegate the model (can't override builtin models)"
echo " --no_quantize Do not quantize the model (can't override builtin models)"
echo " --portable_kernels=<OPS> TO BE DEPRECATED: Alias to select_ops_list."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delegated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is used when select_ops_model is not possible to use, e.g. for semihosting or bundleio."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delagated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is only used when building for semihosting."
echo " See https://docs.pytorch.org/executorch/stable/kernel-library-selective-build.html for more information."
echo " --target=<TARGET> Target to build and run for Default: ${target}"
echo " --output=<FOLDER> Target build output folder Default: ${output_folder}"
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Make _get_program_from_buffer work for bundled programs#14435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zingo merged 2 commits into from
Sep 22, 2025
Merged

Make _get_program_from_buffer work for bundled programs #14435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89ffa17
Make _get_program_from_buffer work for bundled programs
Erik-Lundell Sep 15, 2025
93d51bb
Arm backend: Allow autogen included ops with bundleio
Erik-Lundell Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -738,9 +738,6 @@ endif()

if(EXECUTORCH_BUILD_PYBIND)

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

if(NOT EXECUTORCH_BUILD_EXTENSION_DATA_LOADER)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/data_loader)
endif()
Expand All@@ -749,6 +746,9 @@ if(EXECUTORCH_BUILD_PYBIND)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/devtools)
endif()

# Add codegen tools subdirectory for selective_build pybind module
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/codegen/tools)

# Create bundled_module target only for pybindings when bundled_program exists
# This target has hard dependencies on devtools generated headers
if(TARGET bundled_program)
Expand Down
5 changes: 5 additions & 0 deletions codegen/tools/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
# Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
# Copyright 2025 Arm Limited and/or its affiliates.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
Expand DownExpand Up@@ -28,6 +29,10 @@ target_compile_options(
)

# Link against required libraries
if(TARGET bundled_program)
target_compile_definitions(selective_build PRIVATE -DET_BUNDLE_IO)
target_link_libraries(selective_build PRIVATE bundled_program)
endif()
target_link_libraries(selective_build PRIVATE executorch_core program_schema)

# Install the module
Expand Down
42 changes: 39 additions & 3 deletions codegen/tools/selective_build.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
* All rights reserved.
* Copyright 2025 Arm Limited and/or its affiliates.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>

#include <executorch/runtime/platform/assert.h>
#include <executorch/schema/program_generated.h>
#ifdef ET_BUNDLE_IO
#include <executorch/devtools/bundled_program/bundled_program.h>
#include <stdexcept>
#endif

namespace py = pybind11;

Expand DownExpand Up@@ -186,8 +191,39 @@ get_kernel_tensor_metadatas_from_execution_plan(

const executorch_flatbuffer::Program* _get_program_from_buffer(
const py::bytes& buffer) {
// Access the Python bytes without copying and get raw pointer/size.
const std::string_view sv = buffer.cast<std::string_view>();
void* buf_ptr = const_cast<void*>(static_cast<const void*>(sv.data()));
const size_t buf_len = sv.size();
#ifdef ET_BUNDLE_IO

// If this is a bundled program, extract the inner ExecuTorch program bytes.
if (executorch::bundled_program::is_bundled_program(buf_ptr, buf_len)) {
const void* program_data = nullptr;
size_t program_size = 0;

const auto status = executorch::bundled_program::get_program_data(
buf_ptr, // serialized BundledProgram start
buf_len, // total size of the BundledProgram blob
&program_data, // [out] pointer to inner .pte bytes
&program_size // [out] size of inner .pte bytes
);

if (status != ::executorch::runtime::Error::Ok || program_data == nullptr ||
program_size == 0) {
throw std::runtime_error(
"bundled_program::get_program_data() failed or returned empty data");
}

// program_data points directly at the flatbuffer-encoded Program region.
return executorch_flatbuffer::GetProgram(
reinterpret_cast<const uint8_t*>(program_data));
}
#endif
// Otherwise treat the buffer as a raw .pte (flatbuffer Program with optional
// extended header).
return executorch_flatbuffer::GetProgram(
buffer.cast<std::string_view>().data());
reinterpret_cast<const uint8_t*>(sv.data()));
}

py::list _get_program_operators(const executorch_flatbuffer::Program* program) {
Expand Down
3 changes: 1 addition & 2 deletions docs/source/backends-arm-ethos-u.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -268,8 +268,7 @@ You can see how this coupling between the memory mode and runtime application i

The arm_executor_runner supports [bundled-io](https://docs.pytorch.org/executorch/0.4/bundled-io.html) and [ETdump](https://docs.pytorch.org/executorch/stable/etdump.html) debugging tools.

To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. Currently using bundled-io requires specifying your
non delegated Aten ops manually by setting `EXECUTORCH_SELECT_OPS_LIST`. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
To enable bundled-io, set `EXECUTORCH_BUILD_DEVTOOLS` when building Executorch and `DET_BUNDLE_IO` when building the executor_runner. To enable ETdump, set `EXECUTORCH_BUILD_ARM_ETDUMP` when building Executorch and `DEXECUTORCH_ENABLE_EVENT_TRACER`
when building the executor_runner.


Expand Down
13 changes: 4 additions & 9 deletions examples/arm/executor_runner/CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -235,10 +235,10 @@ list(
-Map=arm_executor_runner.map
)

# Prefer to generate kernel bindings from model file if possible, which is when
# 1. Not building for semihosting 2. Not building with bundleio If that is not
# the case, fallback to select_ops_list If the model file does not contain any
# aten ops, a workaround is currently needed to avoid crashing.
# Figure out which ops to include: For semihosting build, use
# (user-set)SELECT_OPS_MODEL variable. For normal build, use
# EXECUTORCH_SELECT_OPS_MODEL to include ops automatically. If the pte contains
# no undelegated ops, use neither.
execute_process(
COMMAND
python "${ET_DIR_PATH}/codegen/tools/gen_oplist.py"
Expand All@@ -264,11 +264,6 @@ elseif(${FOUND_OPS_IN_FILE})
message(
"gen_oplist: EXECUTORCH_SELECT_OPS_MODEL=${ET_PTE_FILE_PATH} is used to auto generate ops from"
)
elseif(NOT ${FOUND_OPS_IN_FILE} AND ${ET_BUNDLE_IO})
set(EXECUTORCH_SELECT_OPS_MODEL "")
message(
"gen_oplist: Building with ET_BUNDLE_IO and .bpte is not supported to auto generate ops from will use EXECUTORCH_SELECT_OPS_LIST=${EXECUTORCH_SELECT_OPS_LIST}"
)
else()
set(EXECUTORCH_SELECT_OPS_LIST "")
set(EXECUTORCH_SELECT_OPS_MODEL "")
Expand Down
4 changes: 2 additions & 2 deletions examples/arm/run.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,8 +53,8 @@ function help() {
echo " --no_delegate Do not delegate the model (can't override builtin models)"
echo " --no_quantize Do not quantize the model (can't override builtin models)"
echo " --portable_kernels=<OPS> TO BE DEPRECATED: Alias to select_ops_list."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delegated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is used when select_ops_model is not possible to use, e.g. for semihosting or bundleio."
echo " --select_ops_list=<OPS> Comma separated list of portable (non delagated) kernels to include Default: ${select_ops_list}"
echo " NOTE: This is only used when building for semihosting."
echo " See https://docs.pytorch.org/executorch/stable/kernel-library-selective-build.html for more information."
echo " --target=<TARGET> Target to build and run for Default: ${target}"
echo " --output=<FOLDER> Target build output folder Default: ${output_folder}"
Expand Down
Loading