[lldb][swift] Filter unnecessary funclets when setting line breakpoints

Prior to this commit, line breakpoints that match multiple funclets were
being filtered out to remove "Q" funclets from them. This generally
works for simple "await foo()" expressions, but it is not a
comprehensive solution, as it does not address the patterns emerging
from `async let` and `await <async_let_variable>` statements.

This commit generalizes the filtering algorithm:
1. Locations are bundled together based on the async function that
   generated them.
2. For each bundle, choose the funclet with the smallest "number" as per
   its mangling.

To see why this is helpful, consider an `async let` statement like:
  `async let timestamp3 = getTimestamp(i: 44)`
It creates 4 funclets:

```
2.1:
  function = (3) suspend resume partial function for test.some_other_async() async -> ()
  mangled function = $s4test16some_other_asyncyyYaFTY2_
2.2:
  function = implicit closure swiftlang#1 @sendable () async -> Swift.Int in test.some_other_async() async -> ()
  mangled function = $s4test16some_other_asyncyyYaFSiyYaYbcfu_
2.3:
  function = (1) await resume partial function for implicit closure swiftlang#1 @sendable () async -> Swift.Int in test.some_other_async() async -> ()
  mangled function = $s4test16some_other_asyncyyYaFSiyYaYbcfu_TQ0_
2.4:
  function = (2) suspend resume partial function for implicit closure swiftlang#1 @sendable () async -> Swift.Int in test.some_other_async() async -> ()
  mangled function = $s4test16some_other_asyncyyYaFSiyYaYbcfu_TY1_
```

The first is for the LHS, the others are for the RHS expression and are
only executed by the new Task. Only 2.1 and 2.2 should receive
breakpoints.

Likewise, a breakpoint on an `await <async_let_variable>` line would
create 3 funclets:
```
3.1:
  function = (3) suspend resume partial function for test.some_other_async() async -> ()
  mangled function = $s4test16some_other_asyncyyYaFTY2_
3.2:
  function = (4) suspend resume partial function for test.some_other_async() async -> ()
  mangled function = $s4test16some_other_asyncyyYaFTY3_
3.3:
  function = (5) suspend resume partial function for test.some_other_async() async -> ()
  mangled function = $s4test16some_other_asyncyyYaFTY4_
```

The first is for "before" the await, the other two for "after". Only the
first should receive a breakpoint.

Author: felipepiovezan

Diff for: lldb/source/Plugins/Language/Swift/SwiftLanguage.cpp

@@ -1832,19 +1832,110 @@ SwiftLanguage::GetDemangledFunctionNameWithoutArguments(Mangled mangled) const {
   return mangled_name;
 }
 
-void SwiftLanguage::FilterForLineBreakpoints(
-    llvm::SmallVectorImpl<SymbolContext> &sc_list) const {
-  llvm::erase_if(sc_list, [](const SymbolContext &sc) {
-    // If we don't have a function, conservatively keep this sc.
-    if (!sc.function)
-      return false;
+namespace {
+using namespace swift::Demangle;
+struct AsyncInfo {
+  const Function *function;
+  NodePointer demangle_node;
+  std::optional<uint64_t> funclet_number;
+
+  /// Helper function for logging.
+  std::string to_str() const {
+    StreamString stream_str;
+    llvm::raw_ostream &str = stream_str.AsRawOstream();
+    str << "function = ";
+    if (function)
+      str << function->GetMangled().GetMangledName();
+    else
+      str << "nullptr";
+    str << ", demangle_node: " << demangle_node;
+    str << ", funclet_number = ";
+    if (funclet_number)
+      str << *funclet_number;
+    else
+      str << "nullopt";
+    return stream_str.GetString().str();
+  }
+};
 
-    // In async functions, ignore await resume ("Q") funclets, these only
-    // deallocate the async context and task_switch back to user code.
+/// Map each unique Function in sc_list to a Demangle::NodePointer, or null if
+/// demangling is not possible.
+llvm::SmallVector<AsyncInfo> GetAsyncInfo(llvm::ArrayRef<SymbolContext> sc_list,
+                                          swift::Demangle::Context &ctx) {
+  Log *log(GetLog(LLDBLog::Demangle));
+  llvm::SmallSet<Function *, 8> seen_functions;
+  llvm::SmallVector<AsyncInfo> async_infos;
+  for (const SymbolContext &sc : sc_list) {
+    if (!sc.function || seen_functions.contains(sc.function))
+      continue;
+    seen_functions.insert(sc.function);
     llvm::StringRef name =
         sc.function->GetMangled().GetMangledName().GetStringRef();
-    return SwiftLanguageRuntime::IsSwiftAsyncAwaitResumePartialFunctionSymbol(
-        name);
+    NodePointer node = SwiftLanguageRuntime::DemangleSymbolAsNode(name, ctx);
+    async_infos.push_back(
+        {sc.function, node, SwiftLanguageRuntime::GetFuncletNumber(node)});
+
+    if (log) {
+      std::string as_str = async_infos.back().to_str();
+      LLDB_LOGF(log, "%s: %s", __FUNCTION__, as_str.c_str());
+    }
+  }
+  return async_infos;
+}
+} // namespace
+
+void SwiftLanguage::FilterForLineBreakpoints(
+    llvm::SmallVectorImpl<SymbolContext> &sc_list) const {
+  using namespace swift::Demangle;
+  Context ctx;
+
+  llvm::SmallVector<AsyncInfo> async_infos = GetAsyncInfo(sc_list, ctx);
+
+  // Vector containing one representative funclet of each unique async function
+  // in sc_list. The representative is always the one with the smallest funclet
+  // number seen so far.
+  llvm::SmallVector<AsyncInfo> unique_async_funcs;
+
+  // Note the subtlety: this deletes based on functions, not SymbolContexts, as
+  // there might be multiple SCs with the same Function at this point.
+  llvm::SmallPtrSet<const Function *, 4> to_delete;
+
+  for (const auto &async_info : async_infos) {
+    // If we can't find a funclet number, don't delete this.
+    if (!async_info.funclet_number)
+      continue;
+
+    // Have we found other funclets of the same async function?
+    auto *representative =
+        llvm::find_if(unique_async_funcs, [&](AsyncInfo &other_info) {
+          // This looks quadratic, but in practice it is not. We should have at
+          // most 2 different async functions in the same line, unless a user
+          // writes many closures on the same line.
+          return SwiftLanguageRuntime::AreFuncletsOfSameAsyncFunction(
+                     async_info.demangle_node, other_info.demangle_node) ==
+                 SwiftLanguageRuntime::FuncletComparisonResult::
+                     SameAsyncFunction;
+        });
+
+    // We found a new async function.
+    if (representative == unique_async_funcs.end()) {
+      unique_async_funcs.push_back(async_info);
+      continue;
+    }
+
+    // This is another funclet of the same async function. Keep the one with the
+    // smallest number, erase the other. If they have the same number, don't
+    // erase it.
+    if (async_info.funclet_number > representative->funclet_number)
+      to_delete.insert(async_info.function);
+    else if (async_info.funclet_number < representative->funclet_number) {
+      to_delete.insert(representative->function);
+      *representative = async_info;
+    }
+  }
+
+  llvm::erase_if(sc_list, [&](const SymbolContext &sc) {
+    return to_delete.contains(sc.function);
   });
 }
 

Diff for: lldb/test/API/lang/swift/async_breakpoints/TestSwiftAsyncBreakpoints.py

@@ -19,9 +19,15 @@ def test(self):
         )
         breakpoint2 = target.BreakpointCreateBySourceRegex("Breakpoint2", filespec)
         breakpoint3 = target.BreakpointCreateBySourceRegex("Breakpoint3", filespec)
+        breakpoint4 = target.BreakpointCreateBySourceRegex("Breakpoint4", filespec)
+        breakpoint5 = target.BreakpointCreateBySourceRegex("Breakpoint5", filespec)
         self.assertEquals(breakpoint1.GetNumLocations(), 1)
         self.assertEquals(breakpoint2.GetNumLocations(), 1)
         self.assertEquals(breakpoint3.GetNumLocations(), 1)
+        # FIXME: there should be two breakpoints here, but the "entry" funclet of the
+        # implicit closure is mangled slightly differently. rdar://147035260
+        self.assertEquals(breakpoint4.GetNumLocations(), 3)
+        self.assertEquals(breakpoint5.GetNumLocations(), 1)
 
         location11 = breakpoint1.GetLocationAtIndex(0)
         self.assertEquals(location11.GetHitCount(), 1)

Diff for: lldb/test/API/lang/swift/async_breakpoints/main.swift

@@ -10,6 +10,12 @@ func foo() async {
   work() // Breakpoint2
   let timestamp2 = await getTimestamp(i:43) // Breakpoint3
   work()
+  // There should be two breakpoints below in an async let:
+  // One for the code in the "callee", i.e., foo.
+  // One for the implicit closure in the RHS.
+  async let timestamp3 = getTimestamp(i: 44) // Breakpoint4
+  // There should be one breakpoint in an await of an async let variable
+  await timestamp3 // Breakpoint5
 }
 
 await foo()