[lldb/Target] Fix `frame recognizer list` crash when registered with nullptr

[mib]

Summary

One way to register a recognizer is to use RegularExpressionSP for the
module and symbol.

In order to match a symbol regardless of the module, the recognizer can
be registered with a nullptr for the module. However, this cause the
frame recognizer list command to crash because it calls
RegularExpression::GetText without checking if the shared pointer is valid.

This patch adds checks for the symbol and module RegularExpressionSP.

Signed-off-by: Med Ismail Bennani <[e-mail]>

[mib]

Add unittest.

[mib]

Removed used class member

[friss]

LGTM

lldb/unittests/Target/StackFrameRecognizerTest.cpp

84–88

Either check what's printed to the stream or just check the boolean, but there's no reason to add the printing logic if the result is not used.

lldb/source/Target/StackFrameRecognizer.cpp

m_recognizers.push_front({(uint32_t)m_recognizers.size(), false, recognizer, true, ConstString(), module,
                               ConstString(), symbol, first_instruction_only});
   }
 
   void ForEach(
       std::function<void(uint32_t recognized_id, std::string recognizer_name, std::string module,
                          std::string symbol, bool regexp)> const &callback) {
     for (auto entry : m_recognizers) {
       if (entry.is_regexp) {
-        callback(entry.recognizer_id, entry.recognizer->GetName(),
-                 std::string(entry.module_regexp->GetText()),
-                 std::string(entry.symbol_regexp->GetText()), true);
+        std::string module_name;
+        std::string symbol_name;
+
+        if (entry.module_regexp)
+          module_name = entry.module_regexp->GetText().str();
+        if (entry.symbol_regexp)
+          symbol_name = entry.symbol_regexp->GetText().str();
+
+        callback(entry.recognizer_id, entry.recognizer->GetName(), module_name,
+                 symbol_name, true);
+
       } else {
         callback(entry.recognizer_id, entry.recognizer->GetName(), entry.module.GetCString(),
                  entry.symbol.GetCString(), false);
       }
     }
   }
 
   bool RemoveRecognizerWithID(uint32_t recognizer_id) {

lldb/unittests/Target/CMakeLists.txt

 add_lldb_unittest(TargetTests
   ExecutionContextTest.cpp
   MemoryRegionInfoTest.cpp
   ModuleCacheTest.cpp
   PathMappingListTest.cpp
+  StackFrameRecognizerTest.cpp
 
   LINK_LIBS
       lldbCore
       lldbHost
       lldbPluginObjectFileELF
       lldbPluginPlatformLinux
       lldbPluginSymbolFileSymtab
+      lldbTarget
       lldbSymbol
       lldbUtility
       lldbUtilityHelpers
     LINK_COMPONENTS
       Support
   )
 
 add_unittest_inputs(TargetTests TestModule.so)

lldb/unittests/Target/StackFrameRecognizerTest.cpp

+//===-- StackFrameRecognizerTest.cpp --------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "lldb/Target/StackFrameRecognizer.h"
+#include "Plugins/Platform/Linux/PlatformLinux.h"
+#include "lldb/Core/Debugger.h"
+#include "lldb/Host/FileSystem.h"
+#include "lldb/Host/HostInfo.h"
+#include "lldb/Utility/Reproducer.h"
+#include "lldb/lldb-enumerations.h"
+#include "lldb/lldb-forward.h"
+#include "lldb/lldb-private-enumerations.h"
+#include "lldb/lldb-private.h"
+#include "llvm/Support/FormatVariadic.h"
+#include "gtest/gtest.h"
+
+using namespace lldb_private;
+using namespace lldb_private::repro;
+using namespace lldb;
+
+namespace {
+class StackFrameRecognizerTest : public ::testing::Test {
+public:
+  void SetUp() override {
+    llvm::cantFail(Reproducer::Initialize(ReproducerMode::Off, llvm::None));
+    FileSystem::Initialize();
+    HostInfo::Initialize();
+
+    // Pretend Linux is the host platform.
+    platform_linux::PlatformLinux::Initialize();
+    ArchSpec arch("powerpc64-pc-linux");
+    Platform::SetHostPlatform(
+        platform_linux::PlatformLinux::CreateInstance(true, &arch));
+  }
+
+  void TearDown() override {
+    platform_linux::PlatformLinux::Terminate();
+    HostInfo::Terminate();
+    FileSystem::Terminate();
+    Reproducer::Terminate();
+  }
+};
+
+class DummyStackFrameRecognizer : public StackFrameRecognizer {
+public:
+  std::string GetName() override { return "Dummy StackFrame Recognizer"; }
+};
+
+void RegisterDummyStackFrameRecognizer() {
+  static llvm::once_flag g_once_flag;
+
+  llvm::call_once(g_once_flag, []() {
+    RegularExpressionSP module_regex_sp = nullptr;
+    RegularExpressionSP symbol_regex_sp(new RegularExpression("boom"));
+
+    StackFrameRecognizerSP dummy_recognizer_sp(new DummyStackFrameRecognizer());
+
+    StackFrameRecognizerManager::AddRecognizer(
+        dummy_recognizer_sp, module_regex_sp, symbol_regex_sp, false);
+  });
+}
+
+} // namespace
+
+TEST_F(StackFrameRecognizerTest, NullModuleRegex) {
+  DebuggerSP debugger_sp = Debugger::CreateInstance();
+  ASSERT_TRUE(debugger_sp);
+
+  RegisterDummyStackFrameRecognizer();
+
+  bool any_printed = false;
+  StackFrameRecognizerManager::ForEach(
+      [&any_printed](uint32_t recognizer_id, std::string name,
+                     std::string function, std::string symbol,
+                     bool regexp) { any_printed = true; });
+
+  EXPECT_TRUE(any_printed);
+}