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 StructuredData::Dictionary &options_dict, Status &error) {
31 bool success;
32
33 llvm::StringRef regex_string;
34 success = options_dict.GetValueForKeyAsString(
35 GetKey(OptionNames::RegexString), regex_string);
36 if (!success) {
37 error.SetErrorString("BRFR::CFSD: Couldn't find regex entry.");
38 return nullptr;
39 }
40 RegularExpression regex(regex_string);
41
42 bool exact_match;
43 success = options_dict.GetValueForKeyAsBoolean(
44 GetKey(OptionNames::ExactMatch), exact_match);
45 if (!success) {
46 error.SetErrorString("BRFL::CFSD: Couldn't find exact match entry.");
47 return nullptr;
48 }
49
50 // The names array is optional:
51 std::unordered_set<std::string> names_set;
52 StructuredData::Array *names_array;
53 success = options_dict.GetValueForKeyAsArray(
55 if (success && names_array) {
56 size_t num_names = names_array->GetSize();
57 for (size_t i = 0; i < num_names; i++) {
58 std::optional<llvm::StringRef> maybe_name =
59 names_array->GetItemAtIndexAsString(i);
60 if (!maybe_name) {
61 error.SetErrorStringWithFormat(
62 "BRFR::CFSD: Malformed element %zu in the names array.", i);
63 return nullptr;
64 }
65 names_set.insert(std::string(*maybe_name));
66 }
67 }
68
69 return std::make_shared<BreakpointResolverFileRegex>(
70 nullptr, std::move(regex), names_set, exact_match);
71}
72
75 StructuredData::DictionarySP options_dict_sp(
77
78 options_dict_sp->AddStringItem(GetKey(OptionNames::RegexString),
80 options_dict_sp->AddBooleanItem(GetKey(OptionNames::ExactMatch),
82 if (!m_function_names.empty()) {
84 for (std::string name : m_function_names) {
86 names_array_sp->AddItem(item);
87 }
88 options_dict_sp->AddItem(GetKey(OptionNames::LineNumber), names_array_sp);
89 }
90
91 return WrapOptionsDict(options_dict_sp);
92}
93
95 SearchFilter &filter, SymbolContext &context, Address *addr) {
96
97 if (!context.target_sp)
99
100 CompileUnit *cu = context.comp_unit;
101 FileSpec cu_file_spec = cu->GetPrimaryFile();
102 std::vector<uint32_t> line_matches;
103 context.target_sp->GetSourceManager().FindLinesMatchingRegex(
104 cu_file_spec, m_regex, 1, UINT32_MAX, line_matches);
105
106 uint32_t num_matches = line_matches.size();
107 for (uint32_t i = 0; i < num_matches; i++) {
108 SymbolContextList sc_list;
109 // TODO: Handle SourceLocationSpec column information
110 SourceLocationSpec location_spec(cu_file_spec, line_matches[i],
111 /*column=*/std::nullopt,
112 /*check_inlines=*/false, m_exact_match);
113 cu->ResolveSymbolContext(location_spec, eSymbolContextEverything, sc_list);
114 // Find all the function names:
115 if (!m_function_names.empty()) {
116 std::vector<size_t> sc_to_remove;
117 for (size_t i = 0; i < sc_list.GetSize(); i++) {
118 SymbolContext sc_ctx;
119 sc_list.GetContextAtIndex(i, sc_ctx);
120 std::string name(
121 sc_ctx
122 .GetFunctionName(
124 .AsCString());
125 if (!m_function_names.count(name)) {
126 sc_to_remove.push_back(i);
127 }
128 }
129
130 if (!sc_to_remove.empty()) {
131 std::vector<size_t>::reverse_iterator iter;
132 std::vector<size_t>::reverse_iterator rend = sc_to_remove.rend();
133 for (iter = sc_to_remove.rbegin(); iter != rend; iter++) {
134 sc_list.RemoveContextAtIndex(*iter);
135 }
136 }
137 }
138
139 const bool skip_prologue = true;
140
141 BreakpointResolver::SetSCMatchesByLine(filter, sc_list, skip_prologue,
142 m_regex.GetText());
143 }
144
146}
147
150}
151
153 s->Printf("source regex = \"%s\", exact_match = %d",
154 m_regex.GetText().str().c_str(), m_exact_match);
155}
156
158
162 breakpoint, m_regex, m_function_names, m_exact_match));
163 return ret_sp;
164}
165
167 m_function_names.insert(func_name);
168}
static llvm::raw_ostream & error(Stream &strm)
A section + offset based address class.
Definition: Address.h:62
"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
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
static lldb::BreakpointResolverSP CreateFromStructuredData(const StructuredData::Dictionary &options_dict, Status &error)
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:43
const FileSpec & GetPrimaryFile() const
Return the primary source spec associated with this compile unit.
Definition: CompileUnit.h:232
void ResolveSymbolContext(const SourceLocationSpec &src_location_spec, lldb::SymbolContextItem resolve_scope, SymbolContextList &sc_list, RealpathPrefixes *realpath_prefixes=nullptr)
Resolve symbol contexts by file and line.
A file utility class.
Definition: FileSpec.h:56
@ ePreferDemangledWithoutArguments
Definition: Mangled.h:38
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:134
std::optional< llvm::StringRef > GetItemAtIndexAsString(size_t idx) 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:34
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
std::shared_ptr< lldb_private::BreakpointResolver > BreakpointResolverSP
Definition: lldb-forward.h:326
std::shared_ptr< lldb_private::Breakpoint > BreakpointSP
Definition: lldb-forward.h:319
@ eSearchDepthCompUnit