Have inlining pass append invoke's locations to the inlined nodes.

When we inline a function information about where in the source the invoke occurred is lost. To preserve it we can just add it onto the end of any nodes which are 'inlined'. This means this information is still around for later debugging and allows one to distinguish between two different invokes nodes.

PiperOrigin-RevId: 720327368

Author: allight

xls/ir/source_location.h

@@ -17,6 +17,7 @@
 
 #include <compare>
 #include <string>
+#include <utility>
 #include <vector>
 
 #include "absl/strings/str_format.h"
@@ -66,6 +67,8 @@ struct SourceInfo {
 
   SourceInfo() = default;
   explicit SourceInfo(const SourceLocation& loc) : locations({loc}) {}
+  explicit SourceInfo(std::vector<SourceLocation>&& locs)
+      : locations(std::move(locs)) {}
   explicit SourceInfo(absl::Span<const SourceLocation> locs)
       : locations(locs.begin(), locs.end()) {}
 

xls/passes/BUILD

@@ -349,6 +349,8 @@ cc_library(
         "//xls/common/status:ret_check",
         "//xls/common/status:status_macros",
         "//xls/ir",
+        "//xls/ir:source_location",
+        "@com_google_absl//absl/algorithm:container",
         "@com_google_absl//absl/container:flat_hash_map",
         "@com_google_absl//absl/status",
         "@com_google_absl//absl/status:statusor",

xls/passes/inlining_pass.cc

@@ -15,12 +15,14 @@
 #include "xls/passes/inlining_pass.h"
 
 #include <cstdint>
+#include <iterator>
 #include <optional>
 #include <string>
 #include <string_view>
 #include <utility>
 #include <vector>
 
+#include "absl/algorithm/container.h"
 #include "absl/container/flat_hash_map.h"
 #include "absl/status/status.h"
 #include "absl/status/statusor.h"
@@ -33,6 +35,7 @@
 #include "xls/ir/node.h"
 #include "xls/ir/nodes.h"
 #include "xls/ir/package.h"
+#include "xls/ir/source_location.h"
 #include "xls/ir/topo_sort.h"
 #include "xls/passes/optimization_pass.h"
 #include "xls/passes/optimization_pass_registry.h"
@@ -125,6 +128,12 @@ absl::Status InlineInvoke(Invoke* invoke, int inline_count) {
         node->CloneInNewFunction(new_operands, invoke->function_base()));
     if (new_node->loc().Empty()) {
       new_node->SetLoc(invoke->loc());
+    } else {
+      std::vector<SourceLocation> locs(new_node->loc().locations);
+      locs.reserve(new_node->loc().locations.size() +
+                   invoke->loc().locations.size());
+      absl::c_copy(invoke->loc().locations, std::back_inserter(locs));
+      new_node->SetLoc(SourceInfo(std::move(locs)));
     }
     invoked_node_to_replacement[node] = new_node;
   }