Remove redundant symbol lookups in IRExecutionUnit::FindInSymbols

DmT021 · DmT021 · commit e20d83c59d23 · 2024-08-13T07:18:44.000+02:00
When we search for a symbol, we first check if it is in the module_sp of the current SymbolContext, and if not, we check in the target's modules. However, the target's ModuleList also includes the already checked module, which leads to a redundant search in it.
diff --git a/lldb/include/lldb/Core/ModuleList.h b/lldb/include/lldb/Core/ModuleList.h
@@ -285,7 +285,7 @@ class ModuleList {
   /// \see Module::FindFunctions ()
   void FindFunctions(ConstString name, lldb::FunctionNameType name_type_mask,
                      const ModuleFunctionSearchOptions &options,
-                     SymbolContextList &sc_list) const;
+                     const SymbolContext &sc, SymbolContextList &sc_list) const;
 
   /// \see Module::FindFunctionSymbols ()
   void FindFunctionSymbols(ConstString name,
@@ -295,7 +295,7 @@ class ModuleList {
   /// \see Module::FindFunctions ()
   void FindFunctions(const RegularExpression &name,
                      const ModuleFunctionSearchOptions &options,
-                     SymbolContextList &sc_list);
+                     const SymbolContext &sc, SymbolContextList &sc_list);
 
   /// Find global and static variables by name.
   ///
@@ -355,6 +355,7 @@ class ModuleList {
 
   void FindSymbolsWithNameAndType(ConstString name,
                                   lldb::SymbolType symbol_type,
+                                  const SymbolContext &sc,
                                   SymbolContextList &sc_list) const;
 
   void FindSymbolsMatchingRegExAndType(const RegularExpression &regex,
diff --git a/lldb/source/API/SBTarget.cpp b/lldb/source/API/SBTarget.cpp
@@ -1764,8 +1764,8 @@ lldb::SBSymbolContextList SBTarget::FindFunctions(const char *name,
   function_options.include_inlines = true;
 
   FunctionNameType mask = static_cast<FunctionNameType>(name_type_mask);
-  target_sp->GetImages().FindFunctions(ConstString(name), mask,
-                                       function_options, *sb_sc_list);
+  target_sp->GetImages().FindFunctions(
+      ConstString(name), mask, function_options, SymbolContext(), *sb_sc_list);
   return sb_sc_list;
 }
 
@@ -1787,22 +1787,24 @@ lldb::SBSymbolContextList SBTarget::FindGlobalFunctions(const char *name,
       switch (matchtype) {
       case eMatchTypeRegex:
         target_sp->GetImages().FindFunctions(RegularExpression(name_ref),
-                                             function_options, *sb_sc_list);
+                                             function_options, SymbolContext(),
+                                             *sb_sc_list);
         break;
       case eMatchTypeRegexInsensitive:
         target_sp->GetImages().FindFunctions(
             RegularExpression(name_ref, llvm::Regex::RegexFlags::IgnoreCase),
-            function_options, *sb_sc_list);
+            function_options, SymbolContext(), *sb_sc_list);
         break;
       case eMatchTypeStartsWith:
         regexstr = llvm::Regex::escape(name) + ".*";
         target_sp->GetImages().FindFunctions(RegularExpression(regexstr),
-                                             function_options, *sb_sc_list);
+                                             function_options, SymbolContext(),
+                                             *sb_sc_list);
         break;
       default:
-        target_sp->GetImages().FindFunctions(ConstString(name),
-                                             eFunctionNameTypeAny,
-                                             function_options, *sb_sc_list);
+        target_sp->GetImages().FindFunctions(
+            ConstString(name), eFunctionNameTypeAny, function_options,
+            SymbolContext(), *sb_sc_list);
         break;
       }
     }
@@ -2274,7 +2276,7 @@ lldb::SBSymbolContextList SBTarget::FindSymbols(const char *name,
     TargetSP target_sp(GetSP());
     if (target_sp)
       target_sp->GetImages().FindSymbolsWithNameAndType(
-          ConstString(name), symbol_type, *sb_sc_list);
+          ConstString(name), symbol_type, SymbolContext(), *sb_sc_list);
   }
   return sb_sc_list;
 }
diff --git a/lldb/source/Commands/CommandObjectDisassemble.cpp b/lldb/source/Commands/CommandObjectDisassemble.cpp
@@ -351,8 +351,8 @@ CommandObjectDisassemble::GetNameRanges(CommandReturnObject &result) {
 
   // Find functions matching the given name.
   SymbolContextList sc_list;
-  GetTarget().GetImages().FindFunctions(name, eFunctionNameTypeAuto,
-                                        function_options, sc_list);
+  GetTarget().GetImages().FindFunctions(
+      name, eFunctionNameTypeAuto, function_options, SymbolContext(), sc_list);
 
   std::vector<AddressRange> ranges;
   llvm::Error range_errs = llvm::Error::success();
diff --git a/lldb/source/Commands/CommandObjectSource.cpp b/lldb/source/Commands/CommandObjectSource.cpp
@@ -382,7 +382,7 @@ class CommandObjectSourceInfo : public CommandObjectParsed {
     ModuleList module_list =
         (m_module_list.GetSize() > 0) ? m_module_list : target.GetImages();
     module_list.FindFunctions(name, eFunctionNameTypeAuto, function_options,
-                              sc_list_funcs);
+                              SymbolContext(), sc_list_funcs);
     size_t num_matches = sc_list_funcs.GetSize();
 
     if (!num_matches) {
@@ -875,12 +875,14 @@ class CommandObjectSourceList : public CommandObjectParsed {
           target.GetImages().FindModules(module_spec, matching_modules);
 
           matching_modules.FindFunctions(name, eFunctionNameTypeAuto,
-                                         function_options, sc_list);
+                                         function_options, SymbolContext(),
+                                         sc_list);
         }
       }
     } else {
       target.GetImages().FindFunctions(name, eFunctionNameTypeAuto,
-                                       function_options, sc_list);
+                                       function_options, SymbolContext(),
+                                       sc_list);
     }
   }
 
diff --git a/lldb/source/Commands/CommandObjectTarget.cpp b/lldb/source/Commands/CommandObjectTarget.cpp
@@ -3541,7 +3541,8 @@ class CommandObjectTargetModulesShowUnwind : public CommandObjectParsed {
       function_options.include_symbols = true;
       function_options.include_inlines = false;
       target->GetImages().FindFunctions(function_name, eFunctionNameTypeAuto,
-                                        function_options, sc_list);
+                                        function_options, SymbolContext(),
+                                        sc_list);
     } else if (m_options.m_type == eLookupTypeAddress && target) {
       Address addr;
       if (target->GetSectionLoadList().ResolveLoadAddress(m_options.m_addr,
diff --git a/lldb/source/Core/ModuleList.cpp b/lldb/source/Core/ModuleList.cpp
@@ -441,14 +441,20 @@ ModuleSP ModuleList::GetModuleAtIndexUnlocked(size_t idx) const {
 void ModuleList::FindFunctions(ConstString name,
                                FunctionNameType name_type_mask,
                                const ModuleFunctionSearchOptions &options,
+                               const SymbolContext &sc,
                                SymbolContextList &sc_list) const {
   const size_t old_size = sc_list.GetSize();
 
   if (name_type_mask & eFunctionNameTypeAuto) {
     Module::LookupInfo lookup_info(name, name_type_mask, eLanguageTypeUnknown);
 
     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
+    if (sc.module_sp)
+      sc.module_sp->FindFunctions(lookup_info, CompilerDeclContext(), options,
+                                  sc_list);
     for (const ModuleSP &module_sp : m_modules) {
+      if (module_sp == sc.module_sp)
+        continue;
       module_sp->FindFunctions(lookup_info, CompilerDeclContext(), options,
                                sc_list);
     }
@@ -459,7 +465,12 @@ void ModuleList::FindFunctions(ConstString name,
       lookup_info.Prune(sc_list, old_size);
   } else {
     std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
+    if (sc.module_sp)
+      sc.module_sp->FindFunctions(name, CompilerDeclContext(), name_type_mask,
+                                  options, sc_list);
     for (const ModuleSP &module_sp : m_modules) {
+      if (module_sp == sc.module_sp)
+        continue;
       module_sp->FindFunctions(name, CompilerDeclContext(), name_type_mask,
                                options, sc_list);
     }
@@ -494,10 +505,14 @@ void ModuleList::FindFunctionSymbols(ConstString name,
 
 void ModuleList::FindFunctions(const RegularExpression &name,
                                const ModuleFunctionSearchOptions &options,
+                               const SymbolContext &sc,
                                SymbolContextList &sc_list) {
   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
+  if (sc.module_sp)
+    sc.module_sp->FindFunctions(name, options, sc_list);
   for (const ModuleSP &module_sp : m_modules)
-    module_sp->FindFunctions(name, options, sc_list);
+    if (module_sp != sc.module_sp)
+      module_sp->FindFunctions(name, options, sc_list);
 }
 
 void ModuleList::FindCompileUnits(const FileSpec &path,
@@ -526,10 +541,14 @@ void ModuleList::FindGlobalVariables(const RegularExpression &regex,
 
 void ModuleList::FindSymbolsWithNameAndType(ConstString name,
                                             SymbolType symbol_type,
+                                            const SymbolContext &sc,
                                             SymbolContextList &sc_list) const {
   std::lock_guard<std::recursive_mutex> guard(m_modules_mutex);
+  if (sc.module_sp)
+    sc.module_sp->FindSymbolsWithNameAndType(name, symbol_type, sc_list);
   for (const ModuleSP &module_sp : m_modules)
-    module_sp->FindSymbolsWithNameAndType(name, symbol_type, sc_list);
+    if (module_sp != sc.module_sp)
+      module_sp->FindSymbolsWithNameAndType(name, symbol_type, sc_list);
 }
 
 void ModuleList::FindSymbolsMatchingRegExAndType(
diff --git a/lldb/source/Expression/IRExecutionUnit.cpp b/lldb/source/Expression/IRExecutionUnit.cpp
@@ -791,31 +791,17 @@ IRExecutionUnit::FindInSymbols(const std::vector<ConstString> &names,
   function_options.include_symbols = true;
   function_options.include_inlines = false;
 
+  const ModuleList &images = target->GetImages();
   for (const ConstString &name : names) {
-    if (sc.module_sp) {
-      SymbolContextList sc_list;
-      sc.module_sp->FindFunctions(name, CompilerDeclContext(),
-                                  lldb::eFunctionNameTypeFull, function_options,
-                                  sc_list);
-      if (auto load_addr = resolver.Resolve(sc_list))
-        return *load_addr;
-    }
-
-    if (sc.target_sp) {
-      SymbolContextList sc_list;
-      sc.target_sp->GetImages().FindFunctions(name, lldb::eFunctionNameTypeFull,
-                                              function_options, sc_list);
-      if (auto load_addr = resolver.Resolve(sc_list))
-        return *load_addr;
-    }
-
-    if (sc.target_sp) {
-      SymbolContextList sc_list;
-      sc.target_sp->GetImages().FindSymbolsWithNameAndType(
-          name, lldb::eSymbolTypeAny, sc_list);
-      if (auto load_addr = resolver.Resolve(sc_list))
-        return *load_addr;
-    }
+    SymbolContextList sc_list;
+    images.FindFunctions(name, lldb::eFunctionNameTypeFull, function_options,
+                         sc, sc_list);
+    if (auto load_addr = resolver.Resolve(sc_list))
+      return *load_addr;
+
+    images.FindSymbolsWithNameAndType(name, lldb::eSymbolTypeAny, sc, sc_list);
+    if (auto load_addr = resolver.Resolve(sc_list))
+      return *load_addr;
 
     lldb::addr_t best_internal_load_address =
         resolver.GetBestInternalLoadAddress();
diff --git a/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/DynamicLoaderHexagonDYLD.cpp b/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/DynamicLoaderHexagonDYLD.cpp
@@ -419,7 +419,8 @@ DynamicLoaderHexagonDYLD::GetStepThroughTrampolinePlan(Thread &thread,
   Target &target = thread.GetProcess()->GetTarget();
   const ModuleList &images = target.GetImages();
 
-  images.FindSymbolsWithNameAndType(sym_name, eSymbolTypeCode, target_symbols);
+  images.FindSymbolsWithNameAndType(sym_name, eSymbolTypeCode, SymbolContext(),
+                                    target_symbols);
   if (target_symbols.GetSize() == 0)
     return thread_plan_sp;
 
diff --git a/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/HexagonDYLDRendezvous.cpp b/lldb/source/Plugins/DynamicLoader/Hexagon-DYLD/HexagonDYLDRendezvous.cpp
@@ -292,8 +292,8 @@ bool HexagonDYLDRendezvous::FindMetadata(const char *name, PThreadField field,
   Target &target = m_process->GetTarget();
 
   SymbolContextList list;
-  target.GetImages().FindSymbolsWithNameAndType(ConstString(name),
-                                                eSymbolTypeAny, list);
+  target.GetImages().FindSymbolsWithNameAndType(
+      ConstString(name), eSymbolTypeAny, SymbolContext(), list);
   if (list.IsEmpty())
     return false;
 
diff --git a/lldb/source/Plugins/DynamicLoader/MacOSX-DYLD/DynamicLoaderDarwin.cpp b/lldb/source/Plugins/DynamicLoader/MacOSX-DYLD/DynamicLoaderDarwin.cpp
@@ -895,7 +895,7 @@ DynamicLoaderDarwin::GetStepThroughTrampolinePlan(Thread &thread,
 
         SymbolContextList code_symbols;
         images.FindSymbolsWithNameAndType(trampoline_name, eSymbolTypeCode,
-                                          code_symbols);
+                                          current_context, code_symbols);
         for (const SymbolContext &context : code_symbols) {
           AddressRange addr_range;
           context.GetAddressRange(eSymbolContextEverything, 0, false,
@@ -911,8 +911,9 @@ DynamicLoaderDarwin::GetStepThroughTrampolinePlan(Thread &thread,
         }
 
         SymbolContextList reexported_symbols;
-        images.FindSymbolsWithNameAndType(
-            trampoline_name, eSymbolTypeReExported, reexported_symbols);
+        images.FindSymbolsWithNameAndType(trampoline_name,
+                                          eSymbolTypeReExported,
+                                          current_context, reexported_symbols);
         for (const SymbolContext &context : reexported_symbols) {
           if (context.symbol) {
             Symbol *actual_symbol =
@@ -935,7 +936,7 @@ DynamicLoaderDarwin::GetStepThroughTrampolinePlan(Thread &thread,
 
         SymbolContextList indirect_symbols;
         images.FindSymbolsWithNameAndType(trampoline_name, eSymbolTypeResolver,
-                                          indirect_symbols);
+                                          current_context, indirect_symbols);
 
         for (const SymbolContext &context : indirect_symbols) {
           AddressRange addr_range;
diff --git a/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DYLDRendezvous.cpp b/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DYLDRendezvous.cpp
@@ -708,8 +708,8 @@ bool DYLDRendezvous::FindMetadata(const char *name, PThreadField field,
   Target &target = m_process->GetTarget();
 
   SymbolContextList list;
-  target.GetImages().FindSymbolsWithNameAndType(ConstString(name),
-                                                eSymbolTypeAny, list);
+  target.GetImages().FindSymbolsWithNameAndType(
+      ConstString(name), eSymbolTypeAny, SymbolContext(), list);
   if (list.IsEmpty())
     return false;
 
diff --git a/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DynamicLoaderPOSIXDYLD.cpp b/lldb/source/Plugins/DynamicLoader/POSIX-DYLD/DynamicLoaderPOSIXDYLD.cpp
@@ -519,7 +519,8 @@ DynamicLoaderPOSIXDYLD::GetStepThroughTrampolinePlan(Thread &thread,
       sym_name = ConstString(target_name);
     }
   }
-  images.FindSymbolsWithNameAndType(sym_name, eSymbolTypeCode, target_symbols);
+  images.FindSymbolsWithNameAndType(sym_name, eSymbolTypeCode, context,
+                                    target_symbols);
   if (!target_symbols.GetSize())
     return thread_plan_sp;
 
diff --git a/lldb/source/Plugins/ExpressionParser/Clang/ClangASTSource.cpp b/lldb/source/Plugins/ExpressionParser/Clang/ClangASTSource.cpp
@@ -937,9 +937,9 @@ void ClangASTSource::FindObjCMethodDecls(NameSearchContext &context) {
     ConstString instance_method_name(ms.GetString());
 
     sc_list.Clear();
-    m_target->GetImages().FindFunctions(instance_method_name,
-                                        lldb::eFunctionNameTypeFull,
-                                        function_options, sc_list);
+    m_target->GetImages().FindFunctions(
+        instance_method_name, lldb::eFunctionNameTypeFull, function_options,
+        SymbolContext(), sc_list);
 
     if (sc_list.GetSize())
       break;
@@ -950,9 +950,9 @@ void ClangASTSource::FindObjCMethodDecls(NameSearchContext &context) {
     ConstString class_method_name(ms.GetString());
 
     sc_list.Clear();
-    m_target->GetImages().FindFunctions(class_method_name,
-                                        lldb::eFunctionNameTypeFull,
-                                        function_options, sc_list);
+    m_target->GetImages().FindFunctions(
+        class_method_name, lldb::eFunctionNameTypeFull, function_options,
+        SymbolContext(), sc_list);
 
     if (sc_list.GetSize())
       break;
@@ -963,9 +963,9 @@ void ClangASTSource::FindObjCMethodDecls(NameSearchContext &context) {
 
     SymbolContextList candidate_sc_list;
 
-    m_target->GetImages().FindFunctions(selector_name,
-                                        lldb::eFunctionNameTypeSelector,
-                                        function_options, candidate_sc_list);
+    m_target->GetImages().FindFunctions(
+        selector_name, lldb::eFunctionNameTypeSelector, function_options,
+        SymbolContext(), candidate_sc_list);
 
     for (const SymbolContext &candidate_sc : candidate_sc_list) {
       if (!candidate_sc.function)
diff --git a/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionDeclMap.cpp b/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionDeclMap.cpp
@@ -523,11 +523,8 @@ addr_t ClangExpressionDeclMap::GetSymbolAddress(Target &target,
                                                 lldb::SymbolType symbol_type,
                                                 lldb_private::Module *module) {
   SymbolContextList sc_list;
-
-  if (module)
-    module->FindSymbolsWithNameAndType(name, symbol_type, sc_list);
-  else
-    target.GetImages().FindSymbolsWithNameAndType(name, symbol_type, sc_list);
+  const SymbolContext sc{ModuleSP(module)};
+  target.GetImages().FindSymbolsWithNameAndType(name, symbol_type, sc, sc_list);
 
   addr_t symbol_load_addr = LLDB_INVALID_ADDRESS;
 
@@ -1251,7 +1248,7 @@ void ClangExpressionDeclMap::LookupFunction(
 
     target->GetImages().FindFunctions(
         name, eFunctionNameTypeFull | eFunctionNameTypeBase, function_options,
-        sc_list);
+        SymbolContext(), sc_list);
   }
 
   // If we found more than one function, see if we can use the frame's decl
diff --git a/lldb/source/Plugins/JITLoader/GDB/JITLoaderGDB.cpp b/lldb/source/Plugins/JITLoader/GDB/JITLoaderGDB.cpp
@@ -446,7 +446,8 @@ addr_t JITLoaderGDB::GetSymbolAddress(ModuleList &module_list,
   SymbolContextList target_symbols;
   Target &target = m_process->GetTarget();
 
-  module_list.FindSymbolsWithNameAndType(name, symbol_type, target_symbols);
+  module_list.FindSymbolsWithNameAndType(name, symbol_type, SymbolContext(),
+                                         target_symbols);
   if (target_symbols.IsEmpty())
     return LLDB_INVALID_ADDRESS;
 
diff --git a/lldb/source/Plugins/LanguageRuntime/CPlusPlus/ItaniumABI/ItaniumABILanguageRuntime.cpp b/lldb/source/Plugins/LanguageRuntime/CPlusPlus/ItaniumABI/ItaniumABILanguageRuntime.cpp
@@ -634,7 +634,8 @@ ValueObjectSP ItaniumABILanguageRuntime::GetExceptionObjectForThread(
   SymbolContext context;
 
   modules.FindSymbolsWithNameAndType(
-      ConstString("__cxa_current_exception_type"), eSymbolTypeCode, contexts);
+      ConstString("__cxa_current_exception_type"), eSymbolTypeCode,
+      SymbolContext(), contexts);
   contexts.GetContextAtIndex(0, context);
   if (!context.symbol) {
     return {};
diff --git a/lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCRuntime.cpp b/lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCRuntime.cpp
diff --git a/lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCRuntimeV2.cpp b/lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCRuntimeV2.cpp
diff --git a/lldb/source/Plugins/LanguageRuntime/ObjC/GNUstepObjCRuntime/GNUstepObjCRuntime.cpp b/lldb/source/Plugins/LanguageRuntime/ObjC/GNUstepObjCRuntime/GNUstepObjCRuntime.cpp
diff --git a/lldb/source/Plugins/LanguageRuntime/ObjC/ObjCLanguageRuntime.cpp b/lldb/source/Plugins/LanguageRuntime/ObjC/ObjCLanguageRuntime.cpp
diff --git a/lldb/source/Plugins/Process/Utility/InferiorCallPOSIX.cpp b/lldb/source/Plugins/Process/Utility/InferiorCallPOSIX.cpp
diff --git a/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.cpp b/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.cpp
diff --git a/lldb/source/Plugins/SystemRuntime/MacOSX/SystemRuntimeMacOSX.cpp b/lldb/source/Plugins/SystemRuntime/MacOSX/SystemRuntimeMacOSX.cpp
diff --git a/lldb/source/Symbol/SymbolContext.cpp b/lldb/source/Symbol/SymbolContext.cpp

Original file line number	Diff line number	Diff line change
`@@ -382,7 +382,7 @@ class CommandObjectSourceInfo : public CommandObjectParsed {`
`382`	`382`	`ModuleList module_list =`
`383`	`383`	`(m_module_list.GetSize() > 0) ? m_module_list : target.GetImages();`
`384`	`384`	`module_list.FindFunctions(name, eFunctionNameTypeAuto, function_options,`
`385`		`- sc_list_funcs);`
	`385`	`+ SymbolContext(), sc_list_funcs);`
`386`	`386`	`size_t num_matches = sc_list_funcs.GetSize();`
`387`	`387`
`388`	`388`	`if (!num_matches) {`
`@@ -875,12 +875,14 @@ class CommandObjectSourceList : public CommandObjectParsed {`
`875`	`875`	`target.GetImages().FindModules(module_spec, matching_modules);`
`876`	`876`
`877`	`877`	`matching_modules.FindFunctions(name, eFunctionNameTypeAuto,`
`878`		`- function_options, sc_list);`
	`878`	`+ function_options, SymbolContext(),`
	`879`	`+ sc_list);`
`879`	`880`	`}`
`880`	`881`	`}`
`881`	`882`	`} else {`
`882`	`883`	`target.GetImages().FindFunctions(name, eFunctionNameTypeAuto,`
`883`		`- function_options, sc_list);`
	`884`	`+ function_options, SymbolContext(),`
	`885`	`+ sc_list);`
`884`	`886`	`}`
`885`	`887`	`}`
`886`	`888`