DebugInfo: Fix loss of debug info in replaceCurrent() (#5914)

The logic there assumed that we are removing the current node and replacing it
with the given one, so it copied debug info to the new one and deleted it for the
old. But the old one might now be a child of the new one, if we reordered, so we
were dropping debug info, in particular in MergeBlocks which reorders like
this:

(call
  (block ..

=>

(block
  (call

(it moves blocks outwards so it can merge them).

Author: kripken

src/wasm-traversal.h

@@ -128,9 +128,24 @@ struct Walker : public VisitorType {
         auto* curr = getCurrent();
         auto iter = debugLocations.find(curr);
         if (iter != debugLocations.end()) {
-          auto location = iter->second;
-          debugLocations.erase(iter);
-          debugLocations[expression] = location;
+          debugLocations[expression] = iter->second;
+          // Note that we do *not* erase the debug info of the expression being
+          // replaced, because it may still exist: we might replace
+          //
+          //  (call
+          //    (block ..
+          //
+          // with
+          //
+          //  (block
+          //    (call ..
+          //
+          // We still want the call here to have its old debug info.
+          //
+          // (In most cases, of course, we do remove the replaced expression,
+          // which means we accumulate unused garbage in debugLocations, but
+          // that's not that bad; we use arena allocation for Expressions, after
+          // all.)
         }
       }
     }

test/lit/debug/replace-keep.wat

@@ -0,0 +1,40 @@
+;; NOTE: Assertions have been generated by update_lit_checks.py and should not be edited.
+
+;; RUN: env BINARYEN_PRINT_FULL=1 wasm-opt %s --merge-blocks -S -o - | filecheck %s
+
+;; The optimization below will replace the local.set with the block it contains
+;; (i.e. it reorders them). While doing so we should keep the debug info of the
+;; local.set.
+
+(module
+  ;; CHECK:      (func $test
+  ;; CHECK-NEXT:  (local $temp i32)
+  ;; CHECK-NEXT:  [none] ;;@ src.cpp:200:2
+  ;; CHECK-NEXT:  [none](block
+  ;; CHECK-NEXT:   [none] ;;@ src.cpp:200:2
+  ;; CHECK-NEXT:   (call $test)
+  ;; CHECK-NEXT:   [none] ;;@ src.cpp:200:2
+  ;; CHECK-NEXT:   (local.set $temp
+  ;; CHECK-NEXT:    [i32] ;;@ src.cpp:200:2
+  ;; CHECK-NEXT:    (i32.const 1)
+  ;; CHECK-NEXT:   )
+  ;; CHECK-NEXT:  ) ;; end block
+  ;; CHECK-NEXT: )
+  (func $test
+    (local $temp i32)
+
+    ;; Everything here should stay with 200 as their debug info, while we
+    ;; optimize (we can remove the inner block, move the call up to before
+    ;; the local.set, and merge the outer blocks).
+
+    ;;@ src.cpp:200:2
+    (block
+      (local.set $temp
+        (block (result i32)
+          (call $test)
+          (i32.const 1)
+        )
+      )
+    )
+  )
+)