Skip to content

[lldb][SymbolFileDWARFDebugMap] Introduce enum to indicate whether to continue iteration of object files #87344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 2, 2024
Merged

[lldb][SymbolFileDWARFDebugMap] Introduce enum to indicate whether to continue iteration of object files #87344

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9ebae9e
[lldb][SymbolFileDWARFDebugMap] Introduce enum to indicate whether to…
Michael137 Apr 2, 2024
24afa86
fixup! fix ParseDeclsForContext
Michael137 Apr 2, 2024
6263eec
fixup! IterationMarker->IterationAction; fix doxygen comment
Michael137 Apr 2, 2024
1980cd4
fixup! clang-format
Michael137 Apr 2, 2024
03c6973
fixup! move enum to lldb_private; rename enum values
Michael137 Apr 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions lldb/include/lldb/lldb-enumerations.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1339,6 +1339,13 @@ enum AddressMaskRange {
eAddressMaskRangeAll = eAddressMaskRangeAny,
};

/// Useful for callbacks whose return type indicates
/// whether to continue iteration or short-circuit.
enum class IterationAction {
eContinue = 0,
eStop,
};

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need this in the public API, so this should be moved to lldb-private-enumerations.h

since this is a enum class do we need the leading e character? So it would just be:

enum class IterationAction {
  Continue = 0,
  Stop,
};

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

} // namespace lldb

#endif // LLDB_LLDB_ENUMERATIONS_H
75 changes: 39 additions & 36 deletions lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARFDebugMap.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@

#include "LogChannelDWARF.h"
#include "SymbolFileDWARF.h"
#include "lldb/lldb-enumerations.h"

#include <memory>
#include <optional>
Expand Down Expand Up @@ -803,13 +804,13 @@ SymbolFileDWARFDebugMap::GetDynamicArrayInfoForUID(
bool SymbolFileDWARFDebugMap::CompleteType(CompilerType &compiler_type) {
bool success = false;
if (compiler_type) {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
if (oso_dwarf->HasForwardDeclForCompilerType(compiler_type)) {
oso_dwarf->CompleteType(compiler_type);
success = true;
return true;
return IterationAction::eStop;
}
return false;
return IterationAction::eContinue;
});
}
return success;
Expand Down Expand Up @@ -915,7 +916,7 @@ void SymbolFileDWARFDebugMap::FindGlobalVariables(
std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
uint32_t total_matches = 0;

ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
const uint32_t old_size = variables.GetSize();
oso_dwarf->FindGlobalVariables(name, parent_decl_ctx, max_matches,
variables);
Expand All @@ -925,18 +926,18 @@ void SymbolFileDWARFDebugMap::FindGlobalVariables(

// Are we getting all matches?
if (max_matches == UINT32_MAX)
return false; // Yep, continue getting everything
return IterationAction::eContinue; // Yep, continue getting everything

// If we have found enough matches, lets get out
if (max_matches >= total_matches)
return true;
return IterationAction::eStop;

// Update the max matches for any subsequent calls to find globals in any
// other object files with DWARF
max_matches -= oso_matches;
}

return false;
return IterationAction::eContinue;
});
}

Expand All @@ -945,7 +946,7 @@ void SymbolFileDWARFDebugMap::FindGlobalVariables(
VariableList &variables) {
std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
uint32_t total_matches = 0;
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
const uint32_t old_size = variables.GetSize();
oso_dwarf->FindGlobalVariables(regex, max_matches, variables);

Expand All @@ -955,18 +956,18 @@ void SymbolFileDWARFDebugMap::FindGlobalVariables(

// Are we getting all matches?
if (max_matches == UINT32_MAX)
return false; // Yep, continue getting everything
return IterationAction::eContinue; // Yep, continue getting everything

// If we have found enough matches, lets get out
if (max_matches >= total_matches)
return true;
return IterationAction::eStop;

// Update the max matches for any subsequent calls to find globals in any
// other object files with DWARF
max_matches -= oso_matches;
}

return false;
return IterationAction::eContinue;
});
}

Expand Down Expand Up @@ -1071,15 +1072,15 @@ void SymbolFileDWARFDebugMap::FindFunctions(
LLDB_SCOPED_TIMERF("SymbolFileDWARFDebugMap::FindFunctions (name = %s)",
lookup_info.GetLookupName().GetCString());

ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
uint32_t sc_idx = sc_list.GetSize();
oso_dwarf->FindFunctions(lookup_info, parent_decl_ctx, include_inlines,
sc_list);
if (!sc_list.IsEmpty()) {
RemoveFunctionsWithModuleNotEqualTo(m_objfile_sp->GetModule(), sc_list,
sc_idx);
}
return false;
return IterationAction::eContinue;
});
}

Expand All @@ -1090,15 +1091,15 @@ void SymbolFileDWARFDebugMap::FindFunctions(const RegularExpression &regex,
LLDB_SCOPED_TIMERF("SymbolFileDWARFDebugMap::FindFunctions (regex = '%s')",
regex.GetText().str().c_str());

ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
uint32_t sc_idx = sc_list.GetSize();

oso_dwarf->FindFunctions(regex, include_inlines, sc_list);
if (!sc_list.IsEmpty()) {
RemoveFunctionsWithModuleNotEqualTo(m_objfile_sp->GetModule(), sc_list,
sc_idx);
}
return false;
return IterationAction::eContinue;
});
}

Expand All @@ -1121,9 +1122,9 @@ void SymbolFileDWARFDebugMap::GetTypes(SymbolContextScope *sc_scope,
oso_dwarf->GetTypes(sc_scope, type_mask, type_list);
}
} else {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
oso_dwarf->GetTypes(sc_scope, type_mask, type_list);
return false;
return IterationAction::eContinue;
});
}
}
Expand All @@ -1141,9 +1142,9 @@ SymbolFileDWARFDebugMap::ParseCallEdgesInFunction(
TypeSP SymbolFileDWARFDebugMap::FindDefinitionTypeForDWARFDeclContext(
const DWARFDIE &die) {
TypeSP type_sp;
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
type_sp = oso_dwarf->FindDefinitionTypeForDWARFDeclContext(die);
return ((bool)type_sp);
return type_sp ? IterationAction::eStop : IterationAction::eContinue;
});
return type_sp;
}
Expand All @@ -1152,13 +1153,13 @@ bool SymbolFileDWARFDebugMap::Supports_DW_AT_APPLE_objc_complete_type(
SymbolFileDWARF *skip_dwarf_oso) {
if (m_supports_DW_AT_APPLE_objc_complete_type == eLazyBoolCalculate) {
m_supports_DW_AT_APPLE_objc_complete_type = eLazyBoolNo;
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
if (skip_dwarf_oso != oso_dwarf &&
oso_dwarf->Supports_DW_AT_APPLE_objc_complete_type(nullptr)) {
m_supports_DW_AT_APPLE_objc_complete_type = eLazyBoolYes;
return true;
return IterationAction::eStop;
}
return false;
return IterationAction::eContinue;
});
}
return m_supports_DW_AT_APPLE_objc_complete_type == eLazyBoolYes;
Expand Down Expand Up @@ -1217,10 +1218,10 @@ TypeSP SymbolFileDWARFDebugMap::FindCompleteObjCDefinitionTypeForDIE(
if (!must_be_implementation) {
TypeSP type_sp;

ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
type_sp = oso_dwarf->FindCompleteObjCDefinitionTypeForDIE(
die, type_name, must_be_implementation);
return (bool)type_sp;
return type_sp ? IterationAction::eStop : IterationAction::eContinue;
});

return type_sp;
Expand All @@ -1231,9 +1232,10 @@ TypeSP SymbolFileDWARFDebugMap::FindCompleteObjCDefinitionTypeForDIE(
void SymbolFileDWARFDebugMap::FindTypes(const TypeQuery &query,
TypeResults &results) {
std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
oso_dwarf->FindTypes(query, results);
return results.Done(query); // Keep iterating if we aren't done.
return results.Done(query) ? IterationAction::eStop
: IterationAction::eContinue;
});
}

Expand All @@ -1243,23 +1245,24 @@ CompilerDeclContext SymbolFileDWARFDebugMap::FindNamespace(
std::lock_guard<std::recursive_mutex> guard(GetModuleMutex());
CompilerDeclContext matching_namespace;

ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
matching_namespace =
oso_dwarf->FindNamespace(name, parent_decl_ctx, only_root_namespaces);

return (bool)matching_namespace;
return matching_namespace ? IterationAction::eStop
: IterationAction::eContinue;
});

return matching_namespace;
}

void SymbolFileDWARFDebugMap::DumpClangAST(Stream &s) {
ForEachSymbolFile([&s](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&s](SymbolFileDWARF *oso_dwarf) {
oso_dwarf->DumpClangAST(s);
// The underlying assumption is that DumpClangAST(...) will obtain the
// AST from the underlying TypeSystem and therefore we only need to do
// this once and can stop after the first iteration hence we return true.
return true;
return IterationAction::eStop;
});
}

Expand Down Expand Up @@ -1389,9 +1392,9 @@ SymbolFileDWARFDebugMap::GetCompilerContextForUID(lldb::user_id_t type_uid) {

void SymbolFileDWARFDebugMap::ParseDeclsForContext(
lldb_private::CompilerDeclContext decl_ctx) {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
oso_dwarf->ParseDeclsForContext(decl_ctx);
return false; // Keep iterating
return IterationAction::eContinue;
});
}

Expand Down Expand Up @@ -1519,14 +1522,14 @@ SymbolFileDWARFDebugMap::AddOSOARanges(SymbolFileDWARF *dwarf2Data,

ModuleList SymbolFileDWARFDebugMap::GetDebugInfoModules() {
ModuleList oso_modules;
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
ObjectFile *oso_objfile = oso_dwarf->GetObjectFile();
if (oso_objfile) {
ModuleSP module_sp = oso_objfile->GetModule();
if (module_sp)
oso_modules.Append(module_sp);
}
return false; // Keep iterating
return IterationAction::eContinue;
});
return oso_modules;
}
Expand Down Expand Up @@ -1579,8 +1582,8 @@ Status SymbolFileDWARFDebugMap::CalculateFrameVariableError(StackFrame &frame) {
void SymbolFileDWARFDebugMap::GetCompileOptions(
std::unordered_map<lldb::CompUnitSP, lldb_private::Args> &args) {

ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) -> bool {
ForEachSymbolFile([&](SymbolFileDWARF *oso_dwarf) {
oso_dwarf->GetCompileOptions(args);
return false;
return IterationAction::eContinue;
});
}
10 changes: 6 additions & 4 deletions lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARFDebugMap.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@

#include "UniqueDWARFASTType.h"
#include "lldb/Utility/StructuredData.h"
#include "lldb/lldb-enumerations.h"

class DWARFASTParserClang;

Expand Down Expand Up @@ -233,13 +234,14 @@ class SymbolFileDWARFDebugMap : public SymbolFileCommon {

SymbolFileDWARF *GetSymbolFileByOSOIndex(uint32_t oso_idx);

// If closure returns "false", iteration continues. If it returns
// "true", iteration terminates.
void ForEachSymbolFile(std::function<bool(SymbolFileDWARF *)> closure) {
/// If closure returns \ref lldb::IterationAction::eContinue, iteration
/// continues. Otherwise, iteration terminates.
void ForEachSymbolFile(
std::function<lldb::IterationAction(SymbolFileDWARF *)> closure) {
for (uint32_t oso_idx = 0, num_oso_idxs = m_compile_unit_infos.size();
oso_idx < num_oso_idxs; ++oso_idx) {
if (SymbolFileDWARF *oso_dwarf = GetSymbolFileByOSOIndex(oso_idx)) {
if (closure(oso_dwarf))
if (closure(oso_dwarf) == lldb::IterationAction::eStop)
return;
}
}
Expand Down