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 
18 using namespace lldb;
19 using namespace lldb_private;
20 
21 // BreakpointResolverFileRegex:
22 BreakpointResolverFileRegex::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(
55  GetKey(OptionNames::SymbolNameArray), names_array);
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) {
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),
80  m_regex.GetText());
81  options_dict_sp->AddBooleanItem(GetKey(OptionNames::ExactMatch),
83  if (!m_function_names.empty()) {
84  StructuredData::ArraySP names_array_sp(new StructuredData::Array());
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  const bool search_inlines = false;
111 
112  cu->ResolveSymbolContext(cu_file_spec, line_matches[i], search_inlines,
113  m_exact_match, 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(
123  Mangled::NamePreference::ePreferDemangledWithoutArguments)
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 
159 lldb::BreakpointResolverSP
161  lldb::BreakpointResolverSP ret_sp(new BreakpointResolverFileRegex(
162  breakpoint, m_regex, m_function_names, m_exact_match));
163  return ret_sp;
164 }
165 
166 void BreakpointResolverFileRegex::AddFunctionName(const char *func_name) {
167  m_function_names.insert(func_name);
168 }
lldb::TargetSP target_sp
The Target for a given query.
Defines a list of symbol context objects.
A class that represents a running process on the host machine.
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
std::shared_ptr< Array > ArraySP
Defines a symbol context baton that can be handed other debug core functions.
Definition: SymbolContext.h:33
A file utility class.
Definition: FileSpec.h:56
BreakpointResolverFileRegex(const lldb::BreakpointSP &bkpt, RegularExpression regex, const std::unordered_set< std::string > &func_name_set, bool exact_match)
CompileUnit * comp_unit
The CompileUnit for a given query.
std::unordered_set< std::string > m_function_names
void Dump(Stream *s) const override
Standard "Dump" method. At present it does nothing.
A class that describes a compilation unit.
Definition: CompileUnit.h:37
uint32_t GetSize() const
Get accessor for a symbol context list size.
std::shared_ptr< Dictionary > DictionarySP
#define UINT32_MAX
Definition: lldb-defines.h:31
llvm::StringRef GetText() const
Access the regular expression text.
bool GetValueForKeyAsArray(llvm::StringRef key, Array *&result) const
lldb::BreakpointResolverSP CopyForBreakpoint(lldb::BreakpointSP &breakpoint) override
void SetSCMatchesByLine(SearchFilter &filter, SymbolContextList &sc_list, bool skip_prologue, llvm::StringRef log_ident, uint32_t line=0, uint32_t column=0)
Takes a symbol context list of matches which supposedly represent the same file and line number in a ...
General Outline: The BreakpointResolver is a Searcher.
void ResolveSymbolContext(const FileSpec &file_spec, uint32_t line, bool check_inlines, bool exact, lldb::SymbolContextItem resolve_scope, SymbolContextList &sc_list)
Resolve symbol contexts by file and line.
General Outline: Provides the callback and search depth for the SearchFilter search.
Definition: SearchFilter.h:83
void SetErrorString(llvm::StringRef err_str)
Set the current error string to err_str.
Definition: Status.cpp:242
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: Stream.cpp:106
StructuredData::ObjectSP SerializeToStructuredData() override
A section + offset based address class.
Definition: Address.h:59
bool GetItemAtIndexAsString(size_t idx, llvm::StringRef &result) const
std::shared_ptr< String > StringSP
bool GetContextAtIndex(size_t idx, SymbolContext &sc) const
Get accessor for a symbol context at index idx.
Searcher::CallbackReturn SearchCallback(SearchFilter &filter, SymbolContext &context, Address *addr) override
Definition: SBAddress.h:15
std::shared_ptr< Object > ObjectSP
const FileSpec & GetPrimaryFile() const
Return the primary source file associated with this compile unit.
Definition: CompileUnit.h:226
bool GetValueForKeyAsBoolean(llvm::StringRef key, bool &result) const
int SetErrorStringWithFormat(const char *format,...) __attribute__((format(printf
Set the current error string to a formatted error string.
Definition: Status.cpp:256
void GetDescription(Stream *s) override
Prints a canonical description for the breakpoint to the stream s.
StructuredData::DictionarySP WrapOptionsDict(StructuredData::DictionarySP options_dict_sp)
static const char * GetKey(OptionNames enum_value)
bool GetValueForKeyAsString(llvm::StringRef key, llvm::StringRef &result) const
static BreakpointResolver * CreateFromStructuredData(const lldb::BreakpointSP &bkpt, const StructuredData::Dictionary &options_dict, Status &error)
An error handling class.
Definition: Status.h:44