Add debug symbols for parsed and compiler pass replaced instructions by CharlieL7 · Pull Request #4626 · ROCm/AMDMIGraphX

CharlieL7 · 2026-02-20T21:54:12Z

Motivation

Often when debugging we would like to know where an instruction came from in the ONNX model or similar
This PR passes the ONNX node name throughout parsed instructions and propagates them through compiler passes

Technical Details

Enable debug symbols with onnx parser option use_debug_symbols=true.
module::replace_instruction() changes:
- DFS as gather_max_splice() which are the maximum possible instruction splices
- Find the set intersection of the old and new maximum splices
- Traverse down the graph from the set intersection and include only the instructions in the max splice. These instructions are the actual splice, which I call the minimum splice.
- Propagate all the debug symbols from the old splice to the new splice
Added debug symbols to program serialization to MXR and bumped up the MXR version number.
Added driver option to enable ONNX debug symbols.
Other:
- Removed build* from gitignore because of op builder directories

Changelog Category

Add a CHANGELOG.md entry for any option other than Not Applicable

- Added: New functionality.
- Changed: Changes to existing functionality.
- Removed: Functionality or support that has been removed. (Compared to a previous release)
- Optimized: Component performance that has been optimized or improved.
- Resolved Issues: Known issues from a previous version that have been resolved.
- Not Applicable: This PR is not to be included in the changelog.

…symbols

Copilot

Pull request overview

This PR introduces debug symbol tracking on instructions so provenance (e.g., originating ONNX node names) can be preserved through parsing and compiler transformations, improving debuggability of optimized MIGraphX graphs.

Changes:

Add per-instruction debug symbol storage and printing support.
Add module-level debug symbol enabling plus scoped_debug_symbols RAII to tag inserted/replaced instructions during passes.
Propagate debug symbols through ONNX parsing and matcher-based compiler passes; add a comprehensive debug-symbol propagation test suite.

Reviewed changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
`test/debug_symbols_test.cpp`	Adds tests covering symbol propagation across passes, replace paths, and printing.
`src/simplify_algebra.cpp`	Updates a matcher to bind matched instructions into matcher context for symbol propagation.
`src/program.cpp`	Adjusts `program` equality to use fully-qualified `migraphx::to_string`.
`src/op/builder/gelu.cpp`	Adds missing `reflect` to builders for consistency/introspection.
`src/op/builder/clip.cpp`	Adds missing `reflect` to builders for consistency/introspection.
`src/onnx/onnx_parser.cpp`	Wraps ONNX op lowering in a debug-symbol scope so created instructions inherit node symbols.
`src/onnx/include/migraphx/onnx/onnx_parser.hpp`	Clarifies node_info `name` is MIGraphX-generated (not ONNX node name).
`src/module.cpp`	Implements debug-symbol enablement, RAII active symbols, and replace-propagation logic.
`src/include/migraphx/module.hpp`	Exposes debug-symbol APIs and declares `scoped_debug_symbols`.
`src/include/migraphx/matcher.hpp`	Adds matcher-apply scoping so matcher replacements inherit matched instruction symbols.
`src/instruction.cpp`	Implements debug symbol accessors and prints symbols in instruction serialization.
`src/include/migraphx/instruction.hpp`	Adds debug symbol storage and APIs to `instruction`.
`.gitignore`	Removes build/IDE ignore patterns per PR notes.

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

Traverse over ins with empty debug symbols also just in case. Probably will not occur however

Copilot

Pull request overview

Copilot reviewed 14 out of 15 changed files in this pull request and generated 5 comments.

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

…symbols

pfultz2 · 2026-03-26T23:17:02Z

Not sure about the tidy error. I think it's gotten confused with the variadic version of insert_instruction

I think these are related to the MIGRAPHX_TIDY_CONST. You can try to add them to remove_instruction and insert_instruction, but I dont know if tidy would complain about more methods needing const. If thats the case. I'll open a PR to remove this and use a NOLINT comment instead.

This reverts commit a9519a5.

…symbols

pfultz2 · 2026-04-10T14:18:54Z

+inline std::string
+join_strings(Strings strings,
+             const std::string& delim) 
+// NOLINTEND(performance-unnecessary-value-param)


I wonder why tidy is complaining here. This function hasnt changed.

TedThemistokleous · 2026-04-10T15:51:07Z

+                mod->add_debug_symbols(ins, {debug_symbol});
+            }
+        }
        if(enabled(MIGRAPHX_TRACE_ONNX_PARSER{}))


You can likely move this in the above IF

CharlieL7 added 14 commits January 13, 2026 16:41

progress

2e4d205

dd

bb622af

Merge branch 'develop' of github.com:ROCm/AMDMIGraphX into ins_debug_…

277ff30

…symbols

Add onnx_parser and module changes

432ed83

Change to use a set of debug_symbols when inserting ins

c2381cb

Incomplete first parse design

b00e7e2

Version 2 using scoped debug symbols in module

1517438

Cleanup

b8e1cdb

cleanup 2

ec7487e

Formatting

f499489

Add debug propagate with matcher context

8324d9b

formatting

c9f567f

tests and fixup

e66c848

Merge branch 'develop' of github.com:ROCm/AMDMIGraphX into ins_debug_…

42eaac8

…symbols

CharlieL7 requested review from kahmed10 and pfultz2 February 20, 2026 21:54

CharlieL7 self-assigned this Feb 20, 2026

CharlieL7 requested a review from causten as a code owner February 20, 2026 21:54

Copilot AI review requested due to automatic review settings February 20, 2026 21:54

CharlieL7 added the enhancement New feature or request label Feb 20, 2026

Copilot started reviewing on behalf of CharlieL7 February 20, 2026 21:56 View session

Add docs changes

a769c11

CharlieL7 requested a review from a team as a code owner February 20, 2026 22:00

Copilot AI reviewed Feb 20, 2026

View reviewed changes

Comment thread test/debug_symbols_test.cpp Outdated

Comment thread src/simplify_algebra.cpp Outdated

Comment thread src/simplify_algebra.cpp Outdated

Comment thread src/onnx/onnx_parser.cpp Outdated

Comment thread src/module.cpp Outdated

CharlieL7 added 3 commits February 20, 2026 16:05

Have gather_replace_debug_symbols traverse empty

7321509

Traverse over ins with empty debug symbols also just in case. Probably will not occur however

Copilot suggestions

2794a66

more copilot

69c787a

CharlieL7 requested a review from Copilot February 20, 2026 22:18

Copilot started reviewing on behalf of CharlieL7 February 20, 2026 22:19 View session

Copilot AI reviewed Feb 20, 2026

View reviewed changes

Comment thread test/debug_symbols_test.cpp Outdated

Comment thread src/module.cpp Outdated

Comment thread CHANGELOG.md Outdated

Comment thread src/module.cpp Outdated

Comment thread src/module.cpp Outdated

CharlieL7 added 4 commits March 24, 2026 18:31

Remove print

9d8f0cf

Move and change tests

3eea60c

Update API to set onnx_options use_debug_symbols

9b2f759

Merge branch 'develop' of github.com:ROCm/AMDMIGraphX into ins_debug_…

fc3850c

…symbols

kahmed10 reviewed Mar 26, 2026

View reviewed changes

Comment thread src/module.cpp Outdated

pfultz2 reviewed Mar 26, 2026

View reviewed changes

Comment thread src/api/include/migraphx/migraphx.hpp Outdated

Comment thread src/module.cpp

Comment thread test/module_test.cpp

CharlieL7 added 11 commits March 27, 2026 17:23

Review comments

17d4595

Formatting

e5b2009

License

e710cf6

Add tidy const to header

ce9d36c

Add debug symbols interface to api

a9519a5

Revert "Add debug symbols interface to api"

14cb668

This reverts commit a9519a5.

clean up const-ness

f0f5b78

Merge branch 'develop' of github.com:ROCm/AMDMIGraphX into ins_debug_…

bd39c88

…symbols

Formatting

51b4cfe

Remove constness

2dca4f7

Tidy no lint stringutils

f5acdc1

CharlieL7 requested review from kahmed10 and pfultz2 April 7, 2026 17:20

CharlieL7 added 3 commits April 7, 2026 15:16

License date

904d37b

Formatting agin

48b9f78

Cleanup replace_instruction code

748e2bc

pfultz2 approved these changes Apr 10, 2026

View reviewed changes

TedThemistokleous reviewed Apr 10, 2026

View reviewed changes

Comment thread src/onnx/onnx_parser.cpp

TedThemistokleous reviewed Apr 10, 2026

View reviewed changes

kahmed10 approved these changes Apr 10, 2026

View reviewed changes

TedThemistokleous approved these changes Apr 10, 2026

View reviewed changes

causten merged commit b5b7967 into develop Apr 10, 2026
12 checks passed

causten deleted the ins_debug_symbols branch April 10, 2026 21:08

Conversation

CharlieL7 commented Feb 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Technical Details

Changelog Category

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pfultz2 commented Mar 26, 2026

Uh oh!

pfultz2 Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TedThemistokleous Apr 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

CharlieL7 commented Feb 20, 2026 •

edited

Loading