Skip to content
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.

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

[enhancement] add structured traceback for fn and test failures #1462

Open
proppy opened this issue Jun 6, 2024 · 0 comments
Open

[enhancement] add structured traceback for fn and test failures #1462

proppy opened this issue Jun 6, 2024 · 0 comments
Labels
enhancement New feature or request ux User experience (end-user invoking XLS and its related tools)

Comments

@proppy
Copy link
Member

proppy commented Jun 6, 2024

What's hard to do? (limit 100 words)

<discussed offline with @hzeller />

When a dslx function or test fails it can be difficult to traceback why it did so: the interpreter doesn't print stacktrace or contextual value about the state that led to that particular failure.

Current best alternative workaround (limit 100 words)

Currently the best alternative is to scatter trace_fmt statement along the code paths that led to the failure.

Your view of the "best case XLS enhancement" (limit 100 words)

Ideally we would have a structured representation of the execution trace of the call graph that led to the failure w/ input and output bit vectors of each function (similar to what is proposed in #1438 for channels) and possibly values of intermediate let bindings.

An interesting take on this could be to annotate the IR presentation itself w/ recording of the input/output signals of each node across a given execution; which could lend itself to being nicely displayed in https://google.github.io/xls/ir_visualization/.

@proppy proppy added enhancement New feature or request ux User experience (end-user invoking XLS and its related tools) labels Jun 6, 2024
@proppy proppy changed the title [enhancement] [enhancement] add structured traceback for fn and test failures Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ux User experience (end-user invoking XLS and its related tools)
Projects
None yet
Development

No branches or pull requests

1 participant