[tir] Add line level debug info #13012

driazati · 2022-10-07T20:18:16Z

This adds a pass InstallDebugSpans that uses the printout from the TIR text printer to override the source spans on statements and expressions in an IRModule. The pass runs a new printer that records statements and their corresponding line number as they are printed. The LLVM CPU codegen then reads these spans to set the debug location on llvm::Instructions as they are created in the builder.

areusch · 2022-10-19T20:24:54Z

cc @kparzysz-quic

tvm-bot · 2022-10-29T01:09:45Z

Thanks for contributing to TVM! Please refer to the contributing guidelines https://tvm.apache.org/docs/contribute/ for useful information and tips. Please request code reviews from Reviewers by @-ing them in a comment.

Built docs for commit 4a5c1a2 can be found here.
This PR had no significant effect on CI runtime: +15.13% (167.15m -> 192.44m)

_{Generated by tvm-bot}

areusch

thanks @driazati

@kparzysz-quic can you review the LLVM parts?

areusch · 2022-11-17T21:01:23Z

include/tvm/ir/expr.h

@@ -526,6 +526,7 @@ class IntImm : public PrimExpr {
  TVM_DLL IntImm(DataType dtype, int64_t value, Span span = Span());

  TVM_DEFINE_OBJECT_REF_METHODS(IntImm, PrimExpr, IntImmNode);
+  TVM_DEFINE_OBJECT_REF_COW_METHOD(IntImmNode);


just wondering why you needed this one?

do you mean for TVM_DEFINE_OBJECT_REF_COW_METHOD or for IntImmNode in particular? the copy on write is used when creating new nodes so every supported op needs to have it defined, and IntImm is one of the supported ops in install_debug_spans_ops.h so it needs it as well

Could you create a separate PR with the COW changes?

src/printer/tir_text_printer.cc

src/target/llvm/codegen_cpu.cc

src/tir/transforms/install_debug_spans.h

src/tir/transforms/install_debug_spans.cc

src/tir/transforms/install_debug_spans.h

kparzysz-quic · 2022-11-29T15:22:47Z

include/tvm/ir/expr.h

@@ -526,6 +526,7 @@ class IntImm : public PrimExpr {
  TVM_DLL IntImm(DataType dtype, int64_t value, Span span = Span());

  TVM_DEFINE_OBJECT_REF_METHODS(IntImm, PrimExpr, IntImmNode);
+  TVM_DEFINE_OBJECT_REF_COW_METHOD(IntImmNode);


Could you create a separate PR with the COW changes?

kparzysz-quic · 2022-11-29T15:34:26Z

src/tir/transforms/install_debug_spans.cc

+
+Pass InstallDebugSpans() {
+  auto pass_func = [](PrimFunc f, IRModule m, PassContext ctx) {
+    ICHECK(m->functions.size() == 1)


I'm not sure if it's an error to run it on a module with multiple functions... If multiple functions aren't supported, then maybe just exit without doing anything?

Is this a temporary restriction?

Yeah this is just there for the first pass. Seeing how this pass has to be explicitly enabled I think it makes more sense to keep it strict rather than permissive so errors are surfaced early

This enables copy on write methods for all nodes since some were missing it before (see apache#13012 for more context)

tqchen · 2022-11-29T18:43:39Z

Given that we are moving more towards TVMScript, It would be good to think about how to make it compatible with TVMScript printing and debug info. cc @junrushao @yelite

src/tir/transforms/install_debug_spans.h

This enables copy on write methods for all nodes since some were missing it before (see #13012 for more context) Co-authored-by: driazati <driazati@users.noreply.github.com>

driazati · 2022-11-30T22:23:57Z

Given that we are moving more towards TVMScript, It would be good to think about how to make it compatible with TVMScript printing and debug info. cc @junrushao @yelite

One shortcut this PR takes is to explicitly avoid TVM script (at least for source reporting) and use the TIR text printer so it can be run at any point in the compilation pipeline. I think the eventual plan would be to have true source line numbers from the actual written TVM script rather than the generated TIR

yelite · 2022-12-01T06:03:15Z

One shortcut this PR takes is to explicitly avoid TVM script (at least for source reporting) and use the TIR text printer so it can be run at any point in the compilation pipeline. I think the eventual plan would be to have true source line numbers from the actual written TVM script rather than the generated TIR

The new TVMScript printer is able to print IR fragments (not constraining to print IRModule and PrimFunc only). And it's able to record span of an IR node based on printed result (https://github.com/apache/tvm/blob/main/src/script/printer/base_doc_printer.cc#L331, used for diagnostic marker printing) and distinguish the same node in different places (for example, the same VarNode can be found in different places of the IR graph). The implementation of TIR printing is finished. But we need to sort out the detail on how to track ObjectPath in a more ergonomic and readable way before finally upstreaming this part.

The plan of migrating to TVMScript printer sounds good to me. If we are interested in tracing back to the TVMScript code of Var or Buffer, we need to be aware of that such nodes can appear multiple times in the graph (which means multiple spans in the TVMScript code), and the 1-1 mapping between node and span in TVM will cause some trouble.

masahi · 2022-12-12T21:04:09Z

Can we merge this? @areusch @kparzysz-quic @tqchen

areusch · 2023-01-06T19:12:28Z

@tvm-bot rerun

* TIR debug info * Fix location emission * Comments 1/N (docs, cleanups) * Remove leaky macro usage * Add unit test * Remove dead code * Add accuracy test Co-authored-by: driazati <driazati@users.noreply.github.com>

driazati changed the title ~~Cleanup 5 (broken)~~ Add line level debug info for TIR Oct 7, 2022

driazati force-pushed the gdb3 branch 6 times, most recently from 43c6b08 to a2fdb8f Compare October 13, 2022 07:21

areusch added needs-triage PRs or issues that need to be investigated by maintainers to find the right assignees to address it and removed needs-triage PRs or issues that need to be investigated by maintainers to find the right assignees to address it labels Oct 19, 2022

driazati force-pushed the gdb3 branch 3 times, most recently from 9966735 to dec0d8a Compare October 21, 2022 18:17

driazati marked this pull request as ready for review October 21, 2022 18:21

driazati changed the title ~~Add line level debug info for TIR~~ [tir] Add line level debug info Oct 21, 2022

driazati marked this pull request as draft October 21, 2022 18:22

driazati force-pushed the gdb3 branch 3 times, most recently from 9c96a2d to d66fe0d Compare October 25, 2022 18:20

driazati marked this pull request as ready for review October 25, 2022 18:20

driazati requested review from areusch, mbaret and kparzysz-quic October 25, 2022 18:20

driazati force-pushed the gdb3 branch 3 times, most recently from 34e8283 to d68def3 Compare October 28, 2022 21:37

driazati force-pushed the gdb3 branch from d68def3 to 41a03f2 Compare November 4, 2022 23:06

driazati force-pushed the gdb3 branch from 41a03f2 to 81cf7d2 Compare November 16, 2022 19:19

areusch reviewed Nov 18, 2022

View reviewed changes

driazati force-pushed the gdb3 branch from 336cf86 to 4e6ad04 Compare November 21, 2022 19:58

driazati requested a review from areusch November 21, 2022 23:26

kparzysz-quic reviewed Nov 29, 2022

View reviewed changes

driazati mentioned this pull request Nov 29, 2022

[tir] Add copy on write to all nodes #13512

Merged

driazati added a commit to driazati/tvm that referenced this pull request Nov 29, 2022

[tir] Add copy on write to all nodes

9024827

This enables copy on write methods for all nodes since some were missing it before (see apache#13012 for more context)

tqchen reviewed Nov 29, 2022

View reviewed changes

src/tir/transforms/install_debug_spans.h Outdated Show resolved Hide resolved

driazati force-pushed the gdb3 branch 2 times, most recently from 4a5c1a2 to bf0e9d6 Compare December 6, 2022 22:40

driazati added 7 commits January 6, 2023 11:15

TIR debug info

6b8e030

Fix location emission

3ba16a8

Comments 1/N (docs, cleanups)

5c0be62

Remove leaky macro usage

849fe60

Add unit test

b89c185

Remove dead code

91220a7

Add accuracy test

b80864d

driazati force-pushed the gdb3 branch from bf0e9d6 to b80864d Compare January 6, 2023 19:16

kparzysz-quic approved these changes Jan 6, 2023

View reviewed changes

kparzysz-quic merged commit 123f1f5 into apache:main Jan 6, 2023

ysh329 mentioned this pull request Apr 17, 2023

[Release] v0.12.0 Release Candidate Notes #14645

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[tir] Add line level debug info #13012

[tir] Add line level debug info #13012

driazati commented Oct 7, 2022 •

edited

Loading

areusch commented Oct 19, 2022

tvm-bot commented Oct 29, 2022 •

edited

Loading

areusch left a comment

areusch Nov 17, 2022

driazati Nov 21, 2022

kparzysz-quic Nov 29, 2022

kparzysz-quic Nov 29, 2022

kparzysz-quic Nov 29, 2022

driazati Nov 29, 2022

tqchen commented Nov 29, 2022 •

edited

Loading

driazati commented Nov 30, 2022

yelite commented Dec 1, 2022

masahi commented Dec 12, 2022

areusch commented Jan 6, 2023

[tir] Add line level debug info #13012

[tir] Add line level debug info #13012

Conversation

driazati commented Oct 7, 2022 • edited Loading

areusch commented Oct 19, 2022

tvm-bot commented Oct 29, 2022 • edited Loading

areusch left a comment

Choose a reason for hiding this comment

areusch Nov 17, 2022

Choose a reason for hiding this comment

driazati Nov 21, 2022

Choose a reason for hiding this comment

kparzysz-quic Nov 29, 2022

Choose a reason for hiding this comment

kparzysz-quic Nov 29, 2022

Choose a reason for hiding this comment

kparzysz-quic Nov 29, 2022

Choose a reason for hiding this comment

driazati Nov 29, 2022

Choose a reason for hiding this comment

tqchen commented Nov 29, 2022 • edited Loading

driazati commented Nov 30, 2022

yelite commented Dec 1, 2022

masahi commented Dec 12, 2022

areusch commented Jan 6, 2023

driazati commented Oct 7, 2022 •

edited

Loading

tvm-bot commented Oct 29, 2022 •

edited

Loading

tqchen commented Nov 29, 2022 •

edited

Loading