Binary format code section offset tracking (#2515)

Optionally track the binary format code section offsets,
that is, when loading a binary, remember where each IR
node was read from. This is necessary for DWARF
debug info, as these are the offsets DWARF refers to.

(Note that eventually we may want to do something
else, like first read the DWARF and only then add
debug info annotations into the IR in a more LLVM-like
manner, but this is more straightforward and should be
enough to update debug lines and ranges).

This tracking adds noticeable overhead - every single
IR node adds an entry in a map - so avoid it unless
actually necessary. Specifically, if the user passes in
-g and there are actually DWARF sections in the
binary, and we are not about to remove those sections,
then we need it.

Print binary format code section offsets in text, when
printing with -g. This will help debug and test dwarf
support. It looks like

;; code offset: 0x7

as an annotation right before each node.

Also add support for -g in wasm-opt tests (unlike
a pass, it has just one - as a prefix).

Helps #2400

1 files changed, 182 insertions, 0 deletions

diff --git a/test/passes/print.bin.txt b/test/passes/print.bin.txt
new file mode 100644
index 000000000..ce29777a7
--- /dev/null
+++ b/test/passes/print.bin.txt
@@ -0,0 +1,182 @@
+(module
+ (type $i32_=>_i32 (func (param i32) (result i32)))
+ (type $none_=>_none (func))
+ (type $i32_=>_none (func (param i32)))
+ (type $none_=>_i32 (func (result i32)))
+ (type $i32_i32_=>_i32 (func (param i32 i32) (result i32)))
+ (import "env" "memory" (memory $0 256 256))
+ (global $global$0 (mut i32) (i32.const 5243904))
+ (global $global$1 i32 (i32.const 1024))
+ (export "__wasm_call_ctors" (func $__wasm_call_ctors))
+ (export "main" (func $main))
+ (export "__data_end" (global $global$1))
+ (export "stackSave" (func $stackSave))
+ (export "stackAlloc" (func $stackAlloc))
+ (export "stackRestore" (func $stackRestore))
+ (export "__growWasmMemory" (func $__growWasmMemory))
+ (func $__wasm_call_ctors (; 0 ;)
+  (nop)
+ )
+ (func $main (; 1 ;) (param $0 i32) (param $1 i32) (result i32)
+  (if
+   (i32.ne
+    (i32.rem_s
+     (local.get $0)
+     (i32.const 120)
+    )
+    (i32.const 55)
+   )
+   (loop $label$2
+    (br_if $label$2
+     (i32.ne
+      (i32.rem_s
+       (local.tee $0
+        (i32.add
+         (i32.add
+          (i32.mul
+           (i32.mul
+            (local.get $0)
+            (local.get $0)
+           )
+           (local.get $0)
+          )
+          (i32.div_s
+           (local.get $0)
+           (i32.const -2)
+          )
+         )
+         (i32.const 13)
+        )
+       )
+       (i32.const 120)
+      )
+      (i32.const 55)
+     )
+    )
+   )
+  )
+  (local.get $0)
+ )
+ (func $stackSave (; 2 ;) (result i32)
+  (global.get $global$0)
+ )
+ (func $stackAlloc (; 3 ;) (param $0 i32) (result i32)
+  (global.set $global$0
+   (local.tee $0
+    (i32.and
+     (i32.sub
+      (global.get $global$0)
+      (local.get $0)
+     )
+     (i32.const -16)
+    )
+   )
+  )
+  (local.get $0)
+ )
+ (func $stackRestore (; 4 ;) (param $0 i32)
+  (global.set $global$0
+   (local.get $0)
+  )
+ )
+ (func $__growWasmMemory (; 5 ;) (param $0 i32) (result i32)
+  (memory.grow
+   (local.get $0)
+  )
+ )
+ ;; custom section ".debug_info", size 105
+ ;; custom section ".debug_abbrev", size 73
+ ;; custom section ".debug_line", size 92
+ ;; custom section ".debug_str", size 205
+)
+(module
+ (type $i32_=>_i32 (func (param i32) (result i32)))
+ (type $none_=>_none (func))
+ (type $i32_=>_none (func (param i32)))
+ (type $none_=>_i32 (func (result i32)))
+ (type $i32_i32_=>_i32 (func (param i32 i32) (result i32)))
+ (import "env" "memory" (memory $0 256 256))
+ (global $global$0 (mut i32) (i32.const 5243904))
+ (global $global$1 i32 (i32.const 1024))
+ (export "__wasm_call_ctors" (func $__wasm_call_ctors))
+ (export "main" (func $main))
+ (export "__data_end" (global $global$1))
+ (export "stackSave" (func $stackSave))
+ (export "stackAlloc" (func $stackAlloc))
+ (export "stackRestore" (func $stackRestore))
+ (export "__growWasmMemory" (func $__growWasmMemory))
+ (func $__wasm_call_ctors (; 0 ;)
+  (nop)
+ )
+ (func $main (; 1 ;) (param $0 i32) (param $1 i32) (result i32)
+  (if
+   (i32.ne
+    (i32.rem_s
+     (local.get $0)
+     (i32.const 120)
+    )
+    (i32.const 55)
+   )
+   (loop $label$2
+    (br_if $label$2
+     (i32.ne
+      (i32.rem_s
+       (local.tee $0
+        (i32.add
+         (i32.add
+          (i32.mul
+           (i32.mul
+            (local.get $0)
+            (local.get $0)
+           )
+           (local.get $0)
+          )
+          (i32.div_s
+           (local.get $0)
+           (i32.const -2)
+          )
+         )
+         (i32.const 13)
+        )
+       )
+       (i32.const 120)
+      )
+      (i32.const 55)
+     )
+    )
+   )
+  )
+  (local.get $0)
+ )
+ (func $stackSave (; 2 ;) (result i32)
+  (global.get $global$0)
+ )
+ (func $stackAlloc (; 3 ;) (param $0 i32) (result i32)
+  (global.set $global$0
+   (local.tee $0
+    (i32.and
+     (i32.sub
+      (global.get $global$0)
+      (local.get $0)
+     )
+     (i32.const -16)
+    )
+   )
+  )
+  (local.get $0)
+ )
+ (func $stackRestore (; 4 ;) (param $0 i32)
+  (global.set $global$0
+   (local.get $0)
+  )
+ )
+ (func $__growWasmMemory (; 5 ;) (param $0 i32) (result i32)
+  (memory.grow
+   (local.get $0)
+  )
+ )
+ ;; custom section ".debug_info", size 105
+ ;; custom section ".debug_abbrev", size 73
+ ;; custom section ".debug_line", size 92
+ ;; custom section ".debug_str", size 205
+)