Skip to content

[StackIR] Support source maps and DWARF with StackIR #6564

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
kripken merged 5 commits into from
May 1, 2024
Merged

[StackIR] Support source maps and DWARF with StackIR #6564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0e5a3c5
try
kripken Apr 29, 2024
40a45ec
test
kripken Apr 29, 2024
c64abcf
format
kripken Apr 29, 2024
a3fc1e3
update a test
kripken Apr 30, 2024
8e232c9
simplify.test
kripken Apr 30, 2024
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
10 changes: 7 additions & 3 deletions src/wasm-stack.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,17 +508,21 @@ class StackIRToBinaryWriter {
public:
StackIRToBinaryWriter(WasmBinaryWriter& parent,
BufferWithRandomAccess& o,
Function* func)
: writer(parent, o, func, false /* sourceMap */, false /* DWARF */),
func(func) {}
Function* func,
bool sourceMap = false,
bool DWARF = false)
: parent(parent), writer(parent, o, func, sourceMap, DWARF), func(func),
sourceMap(sourceMap) {}

void write();

MappedLocals& getMappedLocals() { return writer.mappedLocals; }

private:
WasmBinaryWriter& parent;
BinaryInstWriter writer;
Function* func;
bool sourceMap;
};

std::ostream& printStackIR(std::ostream& o, Module* module, bool optimize);
Expand Down
4 changes: 2 additions & 2 deletions src/wasm/wasm-binary.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,9 +403,9 @@ void WasmBinaryWriter::writeFunctions() {
size_t start = o.size();
BYN_TRACE("writing" << func->name << std::endl);
// Emit Stack IR if present, and if we can
if (func->stackIR && !sourceMap && !DWARF) {
if (func->stackIR) {
BYN_TRACE("write Stack IR\n");
StackIRToBinaryWriter writer(*this, o, func);
StackIRToBinaryWriter writer(*this, o, func, sourceMap, DWARF);
writer.write();
if (debugInfo) {
funcMappedLocals[func->name] = std::move(writer.getMappedLocals());
Expand Down
12 changes: 12 additions & 0 deletions src/wasm/wasm-stack.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2779,6 +2779,9 @@ StackInst* StackIRGenerator::makeStackInst(StackInst::Op op,
}

void StackIRToBinaryWriter::write() {
if (func->prologLocation.size()) {
parent.writeDebugLocation(*func->prologLocation.begin());
}
writer.mapLocalsAndEmitHeader();
// Stack to track indices of catches within a try
SmallVector<Index, 4> catchIndexStack;
Expand All @@ -2795,7 +2798,13 @@ void StackIRToBinaryWriter::write() {
case StackInst::IfBegin:
case StackInst::LoopBegin:
case StackInst::TryTableBegin: {
if (sourceMap) {
parent.writeDebugLocation(inst->origin, func);
}
writer.visit(inst->origin);
if (sourceMap) {
parent.writeDebugLocationEnd(inst->origin, func);
}
break;
}
case StackInst::TryEnd:
Expand Down Expand Up @@ -2830,6 +2839,9 @@ void StackIRToBinaryWriter::write() {
WASM_UNREACHABLE("unexpected op");
}
}
if (func->epilogLocation.size()) {
parent.writeDebugLocation(*func->epilogLocation.begin());
}
writer.emitFunctionEnd();
}

Expand Down
84 changes: 45 additions & 39 deletions test/lit/source-map.wast
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,43 @@
;; NOTE: Assertions have been generated by update_lit_checks.py --all-items and should not be edited.

;; RUN: wasm-opt %s -o %t.wasm -osm %t.map -g -q
;; RUN: wasm-opt %t.wasm -ism %t.map -q -o - -S | filecheck %s

;; RUN: wasm-opt %s --new-wat-parser -S -o - | filecheck %s
;; Also test with StackIR, which should have identical results.
;;
;; RUN: wasm-opt %s --generate-stack-ir -o %t.wasm -osm %t.map -g -q
;; RUN: wasm-opt %t.wasm -ism %t.map -q -o - -S | filecheck %s

(module
;;@ src.cpp:0:1
;; CHECK: (type $0 (func (param i32 i32)))

;; CHECK: (type $1 (func))

;; CHECK: (func $foo (param $x i32) (param $y i32)
;; CHECK-NEXT: ;;@ src.cpp:10:1
;; CHECK-NEXT: (if
;; CHECK-NEXT: ;;@ src.cpp:20:1
;; CHECK-NEXT: (i32.add
;; CHECK-NEXT: ;;@ src.cpp:30:1
;; CHECK-NEXT: (local.get $x)
;; CHECK-NEXT: ;;@ src.cpp:40:1
;; CHECK-NEXT: (local.get $y)
;; CHECK-NEXT: )
;; CHECK-NEXT: (then
;; CHECK-NEXT: ;;@ src.cpp:50:1
;; CHECK-NEXT: (return)
;; CHECK-NEXT: )
;; CHECK-NEXT: )
;; CHECK-NEXT: ;;@ src.cpp:60:1
;; CHECK-NEXT: (call $foo
;; CHECK-NEXT: ;;@ src.cpp:70:1
;; CHECK-NEXT: (local.get $x)
;; CHECK-NEXT: ;;@ src.cpp:80:1
;; CHECK-NEXT: (local.get $y)
;; CHECK-NEXT: )
;; CHECK-NEXT: ;;@ src.cpp:90:1
;; CHECK-NEXT: )
(func $foo (param $x i32) (param $y i32)
;;@ src.cpp:10:1
(if
Expand Down Expand Up @@ -33,6 +66,17 @@
;;@ src.cpp:90:1
)

;; CHECK: (func $nested-blocks
;; CHECK-NEXT: ;;@ src.cpp:2:1
;; CHECK-NEXT: (block $label$1
;; CHECK-NEXT: ;;@ src.cpp:2:2
;; CHECK-NEXT: (block $label$2
;; CHECK-NEXT: (br $label$2)
;; CHECK-NEXT: )
;; CHECK-NEXT: )
;; CHECK-NEXT: ;;@ src.cpp:3:1
;; CHECK-NEXT: (return)
;; CHECK-NEXT: )
(func $nested-blocks
;;@ src.cpp:2:1
(block $label$1
Expand All @@ -45,41 +89,3 @@
(return)
)
)

;; CHECK: ;;@ src.cpp:0:1
;; CHECK-NEXT: (func $foo (param $x i32) (param $y i32)
;; CHECK-NEXT: ;;@ src.cpp:10:1
;; CHECK-NEXT: (if
;; CHECK-NEXT: ;;@ src.cpp:20:1
;; CHECK-NEXT: (i32.add
;; CHECK-NEXT: ;;@ src.cpp:30:1
;; CHECK-NEXT: (local.get $x)
;; CHECK-NEXT: ;;@ src.cpp:40:1
;; CHECK-NEXT: (local.get $y)
;; CHECK-NEXT: )
;; CHECK-NEXT: (then
;; CHECK-NEXT: ;;@ src.cpp:50:1
;; CHECK-NEXT: (return)
;; CHECK-NEXT: )
;; CHECK-NEXT: )
;; CHECK-NEXT: ;;@ src.cpp:60:1
;; CHECK-NEXT: (call $foo
;; CHECK-NEXT: ;;@ src.cpp:70:1
;; CHECK-NEXT: (local.get $x)
;; CHECK-NEXT: ;;@ src.cpp:80:1
;; CHECK-NEXT: (local.get $y)
;; CHECK-NEXT: )
;; CHECK-NEXT: ;;@ src.cpp:90:1
;; CHECK-NEXT: )

;; CHECK: (func $nested-blocks
;; CHECK-NEXT: ;;@ src.cpp:2:1
;; CHECK-NEXT: (block $label$1
;; CHECK-NEXT: ;;@ src.cpp:2:2
;; CHECK-NEXT: (block $label$2
;; CHECK-NEXT: (br $label$2)
;; CHECK-NEXT: )
;; CHECK-NEXT: )
;; CHECK-NEXT: ;;@ src.cpp:3:1
;; CHECK-NEXT: (return)
;; CHECK-NEXT: )
Loading