LLDB mainline
BreakpointResolverFileRegex.cpp
Go to the documentation of this file.
1//===-- BreakpointResolverFileRegex.cpp -----------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
10
14#include "lldb/Target/Target.h"
15#include "lldb/Utility/Log.h"
17
18using namespace lldb;
19using namespace lldb_private;
20
21// BreakpointResolverFileRegex:
23 const lldb::BreakpointSP &bkpt, RegularExpression regex,
24 const std::unordered_set<std::string> &func_names, bool exact_match)
25 : BreakpointResolver(bkpt, BreakpointResolver::FileRegexResolver),
26 m_regex(std::move(regex)), m_exact_match(exact_match),
27 m_function_names(func_names) {}
28
30 const lldb::BreakpointSP &bkpt, const StructuredData::Dictionary &options_dict,
31 Status &error) {
32 bool success;
33
34 llvm::StringRef regex_string;
35 success = options_dict.GetValueForKeyAsString(
36 GetKey(OptionNames::RegexString), regex_string);
37 if (!success) {
38 error.SetErrorString("BRFR::CFSD: Couldn't find regex entry.");
39 return nullptr;
40 }
41 RegularExpression regex(regex_string);
42
43 bool exact_match;
44 success = options_dict.GetValueForKeyAsBoolean(
45 GetKey(OptionNames::ExactMatch), exact_match);
46 if (!success) {
47 error.SetErrorString("BRFL::CFSD: Couldn't find exact match entry.");
48 return nullptr;
49 }
50
51 // The names array is optional:
52 std::unordered_set<std::string> names_set;
53 StructuredData::Array *names_array;
54 success = options_dict.GetValueForKeyAsArray(
56 if (success && names_array) {
57 size_t num_names = names_array->GetSize();
58 for (size_t i = 0; i < num_names; i++) {
59 llvm::StringRef name;
60 success = names_array->GetItemAtIndexAsString(i, name);
61 if (!success) {
62 error.SetErrorStringWithFormat(
63 "BRFR::CFSD: Malformed element %zu in the names array.", i);
64 return nullptr;
65 }
66 names_set.insert(std::string(name));
67 }
68 }
69
70 return new BreakpointResolverFileRegex(bkpt, std::move(regex), names_set,
71 exact_match);
72}
73
76 StructuredData::DictionarySP options_dict_sp(
78
79 options_dict_sp->AddStringItem(GetKey(OptionNames::RegexString),
81 options_dict_sp->AddBooleanItem(GetKey(OptionNames::ExactMatch),
83 if (!m_function_names.empty()) {
85 for (std::string name : m_function_names) {
87 names_array_sp->AddItem(item);
88 }
89 options_dict_sp->AddItem(GetKey(OptionNames::LineNumber), names_array_sp);
90 }
91
92 return WrapOptionsDict(options_dict_sp);
93}
94
96 SearchFilter &filter, SymbolContext &context, Address *addr) {
97
98 if (!context.target_sp)
100
101 CompileUnit *cu = context.comp_unit;
102 FileSpec cu_file_spec = cu->GetPrimaryFile();
103 std::vector<uint32_t> line_matches;
104 context.target_sp->GetSourceManager().FindLinesMatchingRegex(
105 cu_file_spec, m_regex, 1, UINT32_MAX, line_matches);
106
107 uint32_t num_matches = line_matches.size();
108 for (uint32_t i = 0; i < num_matches; i++) {
109 SymbolContextList sc_list;
110 // TODO: Handle SourceLocationSpec column information
111 SourceLocationSpec location_spec(cu_file_spec, line_matches[i],
112 /*column=*/std::nullopt,
113 /*check_inlines=*/false, m_exact_match);
114 cu->ResolveSymbolContext(location_spec, eSymbolContextEverything, sc_list);
115 // Find all the function names:
116 if (!m_function_names.empty()) {
117 std::vector<size_t> sc_to_remove;
118 for (size_t i = 0; i < sc_list.GetSize(); i++) {
119 SymbolContext sc_ctx;
120 sc_list.GetContextAtIndex(i, sc_ctx);
121 std::string name(
122 sc_ctx
123 .GetFunctionName(
124 Mangled::NamePreference::ePreferDemangledWithoutArguments)
125 .AsCString());
126 if (!m_function_names.count(name)) {
127 sc_to_remove.push_back(i);
128 }
129 }
130
131 if (!sc_to_remove.empty()) {
132 std::vector<size_t>::reverse_iterator iter;
133 std::vector<size_t>::reverse_iterator rend = sc_to_remove.rend();
134 for (iter = sc_to_remove.rbegin(); iter != rend; iter++) {
135 sc_list.RemoveContextAtIndex(*iter);
136 }
137 }
138 }
139
140 const bool skip_prologue = true;
141
142 BreakpointResolver::SetSCMatchesByLine(filter, sc_list, skip_prologue,
143 m_regex.GetText());
144 }
145
147}
148
151}
152
154 s->Printf("source regex = \"%s\", exact_match = %d",
155 m_regex.GetText().str().c_str(), m_exact_match);
156}
157
159
160lldb::BreakpointResolverSP
162 lldb::BreakpointResolverSP ret_sp(new BreakpointResolverFileRegex(
163 breakpoint, m_regex, m_function_names, m_exact_match));
164 return ret_sp;
165}
166
168 m_function_names.insert(func_name);
169}
static llvm::raw_ostream & error(Stream &strm)
A section + offset based address class.
Definition: Address.h:59
"lldb/Breakpoint/BreakpointResolverFileRegex.h" This class sets breakpoints by file and line.
StructuredData::ObjectSP SerializeToStructuredData() override
void GetDescription(Stream *s) override
Prints a canonical description for the breakpoint to the stream s.
Searcher::CallbackReturn SearchCallback(SearchFilter &filter, SymbolContext &context, Address *addr) override
std::unordered_set< std::string > m_function_names
static BreakpointResolver * CreateFromStructuredData(const lldb::BreakpointSP &bkpt, const StructuredData::Dictionary &options_dict, Status &error)
void Dump(Stream *s) const override
Standard "Dump" method. At present it does nothing.
BreakpointResolverFileRegex(const lldb::BreakpointSP &bkpt, RegularExpression regex, const std::unordered_set< std::string > &func_name_set, bool exact_match)
lldb::BreakpointResolverSP CopyForBreakpoint(lldb::BreakpointSP &breakpoint) override
General Outline: The BreakpointResolver is a Searcher.
static const char * GetKey(OptionNames enum_value)
StructuredData::DictionarySP WrapOptionsDict(StructuredData::DictionarySP options_dict_sp)
void SetSCMatchesByLine(SearchFilter &filter, SymbolContextList &sc_list, bool skip_prologue, llvm::StringRef log_ident, uint32_t line=0, std::optional< uint16_t > column=std::nullopt)
Takes a symbol context list of matches which supposedly represent the same file and line number in a ...
A class that describes a compilation unit.
Definition: CompileUnit.h:41
const FileSpec & GetPrimaryFile() const
Return the primary source file associated with this compile unit.
Definition: CompileUnit.h:227
void ResolveSymbolContext(const SourceLocationSpec &src_location_spec, lldb::SymbolContextItem resolve_scope, SymbolContextList &sc_list)
Resolve symbol contexts by file and line.
A file utility class.
Definition: FileSpec.h:56
llvm::StringRef GetText() const
Access the regular expression text.
General Outline: Provides the callback and search depth for the SearchFilter search.
Definition: SearchFilter.h:83
"lldb/Core/SourceLocationSpec.h" A source location specifier class.
An error handling class.
Definition: Status.h:44
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: Stream.cpp:107
bool GetItemAtIndexAsString(size_t idx, llvm::StringRef &result) const
bool GetValueForKeyAsString(llvm::StringRef key, llvm::StringRef &result) const
bool GetValueForKeyAsBoolean(llvm::StringRef key, bool &result) const
bool GetValueForKeyAsArray(llvm::StringRef key, Array *&result) const
std::shared_ptr< Dictionary > DictionarySP
std::shared_ptr< Object > ObjectSP
std::shared_ptr< String > StringSP
std::shared_ptr< Array > ArraySP
Defines a list of symbol context objects.
bool GetContextAtIndex(size_t idx, SymbolContext &sc) const
Get accessor for a symbol context at index idx.
uint32_t GetSize() const
Get accessor for a symbol context list size.
Defines a symbol context baton that can be handed other debug core functions.
Definition: SymbolContext.h:33
CompileUnit * comp_unit
The CompileUnit for a given query.
lldb::TargetSP target_sp
The Target for a given query.
#define UINT32_MAX
Definition: lldb-defines.h:19
A class that represents a running process on the host machine.
Definition: SBAddress.h:15
@ eSearchDepthCompUnit