[lldb] add settings to control how synthetic symbol names are generated

Author: eronnen

lldb/include/lldb/Core/ModuleList.h

@@ -67,6 +67,20 @@ static constexpr OptionEnumValueElement g_auto_download_enum_values[] = {
     },
 };
 
+static constexpr OptionEnumValueElement
+    g_synthetic_symbols_name_style_values[] = {
+        {
+            lldb::eSyntheticSymbolsNameStyleIndex,
+            "index",
+            "Function index style",
+        },
+        {
+            lldb::eSyntheticSymbolsNameStyleFileAddress,
+            "file-address",
+            "Function file address in module style",
+        },
+};
+
 class ModuleListProperties : public Properties {
   mutable llvm::sys::RWMutex m_symlink_paths_mutex;
   PathMappingList m_symlink_paths;
@@ -91,6 +105,7 @@ class ModuleListProperties : public Properties {
   bool GetLoadSymbolOnDemand();
 
   lldb::SymbolDownload GetSymbolAutoDownload() const;
+  lldb::SyntheticSymbolsNameStyle GetSyntheticSymbolsNameStyle() const;
 
   PathMappingList GetSymlinkMappings() const;
 };

lldb/include/lldb/lldb-enumerations.h

@@ -1391,6 +1391,12 @@ enum StopDisassemblyType {
   eStopDisassemblyTypeAlways
 };
 
+/// Format to use for unknown symbols.
+enum SyntheticSymbolsNameStyle {
+  eSyntheticSymbolsNameStyleIndex = 0,
+  eSyntheticSymbolsNameStyleFileAddress = 1,
+};
+
 } // namespace lldb
 
 #endif // LLDB_LLDB_ENUMERATIONS_H

lldb/source/Core/CoreProperties.td

@@ -46,6 +46,11 @@ let Definition = "modulelist" in {
     Global,
     DefaultFalse,
     Desc<"Enable on demand symbol loading in LLDB. LLDB will load debug info on demand for each module based on various conditions (e.g. matched breakpoint, resolved stack frame addresses and matched global variables/function symbols in symbol table) to improve performance. Please refer to docs/use/ondemand.rst for details.">;
+  def SyntheticSymbolsNameStyle: Property<"synthetic-symbols-name-style", "Enum">,
+    Global,
+    DefaultEnumValue<"eSyntheticSymbolsNameStyleIndex">,
+    EnumValues<"OptionEnumValues(g_synthetic_symbols_name_style_values)">,
+    Desc<"Determines the way synthetic symbol names are generated for unknown symbols">;
 }
 
 let Definition = "debugger" in {

lldb/source/Core/ModuleList.cpp

@@ -115,6 +115,14 @@ SymbolDownload ModuleListProperties::GetSymbolAutoDownload() const {
                g_modulelist_properties[idx].default_uint_value));
 }
 
+lldb::SyntheticSymbolsNameStyle
+ModuleListProperties::GetSyntheticSymbolsNameStyle() const {
+  const uint32_t idx = ePropertySyntheticSymbolsNameStyle;
+  return GetPropertyAtIndexAs<lldb::SyntheticSymbolsNameStyle>(
+      idx, static_cast<lldb::SyntheticSymbolsNameStyle>(
+               g_modulelist_properties[idx].default_uint_value));
+}
+
 FileSpec ModuleListProperties::GetClangModulesCachePath() const {
   const uint32_t idx = ePropertyClangModulesCachePath;
   return GetPropertyAtIndexAs<FileSpec>(idx, {});

lldb/source/Symbol/Symbol.cpp

@@ -639,7 +639,18 @@ void Symbol::SynthesizeNameIfNeeded() const {
     // breakpoints on them.
     llvm::SmallString<256> name;
     llvm::raw_svector_ostream os(name);
-    os << GetSyntheticSymbolPrefix() << GetID();
+    os << GetSyntheticSymbolPrefix();
+    switch (ModuleList::GetGlobalModuleListProperties()
+                .GetSyntheticSymbolsNameStyle()) {
+    case eSyntheticSymbolsNameStyleIndex:
+      os << GetID();
+      break;
+    case eSyntheticSymbolsNameStyleFileAddress:
+      os << "_"
+         << llvm::format_hex_no_prefix(
+                m_addr_range.GetBaseAddress().GetFileAddress(), 0);
+      break;
+    }
     m_mangled.SetDemangledName(ConstString(os.str()));
   }
 }