Skip to content

Addition note for ETDump #16214

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

Open
cccclai wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Addition note for ETDump #16214

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29308f4
Addition note for ETDump
cccclai Dec 11, 2025
229a877
Clarify ET_EVENT_TRACER_ENABLED flag requirement
cccclai Dec 11, 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
23 changes: 23 additions & 0 deletions docs/source/etdump.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,29 @@ if (result.buf != nullptr && result.size > 0) {
target_compile_options(executorch INTERFACE -DET_EVENT_TRACER_ENABLED)
target_compile_options(portable_ops_lib INTERFACE -DET_EVENT_TRACER_ENABLED)
```

### Make sure ET_EVENT_TRACER_ENABLED flag is enabled or ETDump will be empty.

If the binary is not compiled with the `ET_EVENT_TRACER_ENABLED` preprocessor flag, no trace events will be recorded and the ETDump will be empty.

When this flag is missing, the following code:

```C++
ETDumpResult result = etdump_gen.get_etdump_data();
if (result.buf != nullptr && result.size > 0) {
...
}
```

will always return:

```C++
result.buf == nullptr
result.size == 0
```

This indicates that no ETDump data was collected, and therefore nothing can be analyzed through the Inspector API.

## Using an ETDump

Pass this ETDump into the [Inspector API](model-inspector.rst) to access this data and do post-run analysis.
Loading