LLDB  mainline
BreakpointResolver.cpp
Go to the documentation of this file.
1 //===-- BreakpointResolver.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 
13 // Have to include the other breakpoint resolver types here so the static
14 // create from StructuredData can call them.
20 #include "lldb/Core/Address.h"
21 #include "lldb/Core/ModuleList.h"
22 #include "lldb/Core/SearchFilter.h"
24 #include "lldb/Symbol/Function.h"
26 #include "lldb/Target/Target.h"
27 #include "lldb/Utility/LLDBLog.h"
28 #include "lldb/Utility/Log.h"
29 #include "lldb/Utility/Stream.h"
31 
32 using namespace lldb_private;
33 using namespace lldb;
34 
35 // BreakpointResolver:
36 const char *BreakpointResolver::g_ty_to_name[] = {"FileAndLine", "Address",
37  "SymbolName", "SourceRegex",
38  "Python", "Exception",
39  "Unknown"};
40 
41 const char *BreakpointResolver::g_option_names[static_cast<uint32_t>(
43  "AddressOffset", "Exact", "FileName", "Inlines", "Language",
44  "LineNumber", "Column", "ModuleName", "NameMask", "Offset",
45  "PythonClass", "Regex", "ScriptArgs", "SectionName", "SearchDepth",
46  "SkipPrologue", "SymbolNames"};
47 
49  if (type > LastKnownResolverType)
50  return g_ty_to_name[UnknownResolver];
51 
52  return g_ty_to_name[type];
53 }
54 
56 BreakpointResolver::NameToResolverTy(llvm::StringRef name) {
57  for (size_t i = 0; i < LastKnownResolverType; i++) {
58  if (name == g_ty_to_name[i])
59  return (ResolverTy)i;
60  }
61  return UnknownResolver;
62 }
63 
64 BreakpointResolver::BreakpointResolver(const BreakpointSP &bkpt,
65  const unsigned char resolverTy,
66  lldb::addr_t offset)
67  : m_breakpoint(bkpt), m_offset(offset), SubclassID(resolverTy) {}
68 
70 
72  const StructuredData::Dictionary &resolver_dict, Status &error) {
73  BreakpointResolverSP result_sp;
74  if (!resolver_dict.IsValid()) {
75  error.SetErrorString("Can't deserialize from an invalid data object.");
76  return result_sp;
77  }
78 
79  llvm::StringRef subclass_name;
80 
81  bool success = resolver_dict.GetValueForKeyAsString(
82  GetSerializationSubclassKey(), subclass_name);
83 
84  if (!success) {
85  error.SetErrorString("Resolver data missing subclass resolver key");
86  return result_sp;
87  }
88 
89  ResolverTy resolver_type = NameToResolverTy(subclass_name);
90  if (resolver_type == UnknownResolver) {
91  error.SetErrorStringWithFormatv("Unknown resolver type: {0}.",
92  subclass_name);
93  return result_sp;
94  }
95 
96  StructuredData::Dictionary *subclass_options = nullptr;
97  success = resolver_dict.GetValueForKeyAsDictionary(
98  GetSerializationSubclassOptionsKey(), subclass_options);
99  if (!success || !subclass_options || !subclass_options->IsValid()) {
100  error.SetErrorString("Resolver data missing subclass options key.");
101  return result_sp;
102  }
103 
104  lldb::addr_t offset;
105  success = subclass_options->GetValueForKeyAsInteger(
106  GetKey(OptionNames::Offset), offset);
107  if (!success) {
108  error.SetErrorString("Resolver data missing offset options key.");
109  return result_sp;
110  }
111 
112  BreakpointResolver *resolver = nullptr;
113  switch (resolver_type) {
114  case FileLineResolver:
116  nullptr, *subclass_options, error);
117  break;
118  case AddressResolver:
120  nullptr, *subclass_options, error);
121  break;
122  case NameResolver:
124  nullptr, *subclass_options, error);
125  break;
126  case FileRegexResolver:
128  nullptr, *subclass_options, error);
129  break;
130  case PythonResolver:
132  nullptr, *subclass_options, error);
133  break;
134  case ExceptionResolver:
135  error.SetErrorString("Exception resolvers are hard.");
136  break;
137  default:
138  llvm_unreachable("Should never get an unresolvable resolver type.");
139  }
140 
141  if (!resolver || error.Fail())
142  return result_sp;
143 
144  // Add on the global offset option:
145  resolver->SetOffset(offset);
146  return BreakpointResolverSP(resolver);
147 }
148 
150  StructuredData::DictionarySP options_dict_sp) {
151  if (!options_dict_sp || !options_dict_sp->IsValid())
153 
155  type_dict_sp->AddStringItem(GetSerializationSubclassKey(), GetResolverName());
156  type_dict_sp->AddItem(GetSerializationSubclassOptionsKey(), options_dict_sp);
157 
158  // Add the m_offset to the dictionary:
159  options_dict_sp->AddIntegerItem(GetKey(OptionNames::Offset), m_offset);
160 
161  return type_dict_sp;
162 }
163 
164 void BreakpointResolver::SetBreakpoint(const BreakpointSP &bkpt) {
165  assert(bkpt);
166  m_breakpoint = bkpt;
168 }
169 
171  ModuleList &modules) {
172  filter.SearchInModuleList(*this, modules);
173 }
174 
176  filter.Search(*this);
177 }
178 
179 namespace {
180 struct SourceLoc {
181  uint32_t line = UINT32_MAX;
182  uint16_t column;
183  SourceLoc(uint32_t l, llvm::Optional<uint16_t> c)
184  : line(l), column(c ? *c : LLDB_INVALID_COLUMN_NUMBER) {}
185  SourceLoc(const SymbolContext &sc)
186  : line(sc.line_entry.line),
187  column(sc.line_entry.column ? sc.line_entry.column
189 };
190 
191 bool operator<(const SourceLoc lhs, const SourceLoc rhs) {
192  if (lhs.line < rhs.line)
193  return true;
194  if (lhs.line > rhs.line)
195  return false;
196  // uint32_t a_col = lhs.column ? lhs.column : LLDB_INVALID_COLUMN_NUMBER;
197  // uint32_t b_col = rhs.column ? rhs.column : LLDB_INVALID_COLUMN_NUMBER;
198  return lhs.column < rhs.column;
199 }
200 } // namespace
201 
203  SearchFilter &filter, SymbolContextList &sc_list, bool skip_prologue,
204  llvm::StringRef log_ident, uint32_t line, llvm::Optional<uint16_t> column) {
205  llvm::SmallVector<SymbolContext, 16> all_scs;
206  for (uint32_t i = 0; i < sc_list.GetSize(); ++i)
207  all_scs.push_back(sc_list[i]);
208 
209  while (all_scs.size()) {
210  uint32_t closest_line = UINT32_MAX;
211 
212  // Move all the elements with a matching file spec to the end.
213  auto &match = all_scs[0];
214  auto worklist_begin = std::partition(
215  all_scs.begin(), all_scs.end(), [&](const SymbolContext &sc) {
216  if (sc.line_entry.file == match.line_entry.file ||
217  sc.line_entry.original_file == match.line_entry.original_file) {
218  // When a match is found, keep track of the smallest line number.
219  closest_line = std::min(closest_line, sc.line_entry.line);
220  return false;
221  }
222  return true;
223  });
224 
225  // (worklist_begin, worklist_end) now contains all entries for one filespec.
226  auto worklist_end = all_scs.end();
227 
228  if (column) {
229  // If a column was requested, do a more precise match and only
230  // return the first location that comes before or at the
231  // requested location.
232  SourceLoc requested(line, *column);
233  // First, filter out all entries left of the requested column.
234  worklist_end = std::remove_if(
235  worklist_begin, worklist_end,
236  [&](const SymbolContext &sc) { return requested < SourceLoc(sc); });
237  // Sort the remaining entries by (line, column).
238  llvm::sort(worklist_begin, worklist_end,
239  [](const SymbolContext &a, const SymbolContext &b) {
240  return SourceLoc(a) < SourceLoc(b);
241  });
242 
243  // Filter out all locations with a source location after the closest match.
244  if (worklist_begin != worklist_end)
245  worklist_end = std::remove_if(
246  worklist_begin, worklist_end, [&](const SymbolContext &sc) {
247  return SourceLoc(*worklist_begin) < SourceLoc(sc);
248  });
249  } else {
250  // Remove all entries with a larger line number.
251  // ResolveSymbolContext will always return a number that is >=
252  // the line number you pass in. So the smaller line number is
253  // always better.
254  worklist_end = std::remove_if(worklist_begin, worklist_end,
255  [&](const SymbolContext &sc) {
256  return closest_line != sc.line_entry.line;
257  });
258  }
259 
260  // Sort by file address.
261  llvm::sort(worklist_begin, worklist_end,
262  [](const SymbolContext &a, const SymbolContext &b) {
263  return a.line_entry.range.GetBaseAddress().GetFileAddress() <
265  });
266 
267  // Go through and see if there are line table entries that are
268  // contiguous, and if so keep only the first of the contiguous range.
269  // We do this by picking the first location in each lexical block.
270  llvm::SmallDenseSet<Block *, 8> blocks_with_breakpoints;
271  for (auto first = worklist_begin; first != worklist_end; ++first) {
272  assert(!blocks_with_breakpoints.count(first->block));
273  blocks_with_breakpoints.insert(first->block);
274  worklist_end =
275  std::remove_if(std::next(first), worklist_end,
276  [&](const SymbolContext &sc) {
277  return blocks_with_breakpoints.count(sc.block);
278  });
279  }
280 
281  // Make breakpoints out of the closest line number match.
282  for (auto &sc : llvm::make_range(worklist_begin, worklist_end))
283  AddLocation(filter, sc, skip_prologue, log_ident);
284 
285  // Remove all contexts processed by this iteration.
286  all_scs.erase(worklist_begin, all_scs.end());
287  }
288 }
289 
290 void BreakpointResolver::AddLocation(SearchFilter &filter,
291  const SymbolContext &sc,
292  bool skip_prologue,
293  llvm::StringRef log_ident) {
295  Address line_start = sc.line_entry.range.GetBaseAddress();
296  if (!line_start.IsValid()) {
297  LLDB_LOGF(log,
298  "error: Unable to set breakpoint %s at file address "
299  "0x%" PRIx64 "\n",
300  log_ident.str().c_str(), line_start.GetFileAddress());
301  return;
302  }
303 
304  if (!filter.AddressPasses(line_start)) {
305  LLDB_LOGF(log,
306  "Breakpoint %s at file address 0x%" PRIx64
307  " didn't pass the filter.\n",
308  log_ident.str().c_str(), line_start.GetFileAddress());
309  }
310 
311  // If the line number is before the prologue end, move it there...
312  bool skipped_prologue = false;
313  if (skip_prologue && sc.function) {
314  Address prologue_addr(sc.function->GetAddressRange().GetBaseAddress());
315  if (prologue_addr.IsValid() && (line_start == prologue_addr)) {
316  const uint32_t prologue_byte_size = sc.function->GetPrologueByteSize();
317  if (prologue_byte_size) {
318  prologue_addr.Slide(prologue_byte_size);
319 
320  if (filter.AddressPasses(prologue_addr)) {
321  skipped_prologue = true;
322  line_start = prologue_addr;
323  }
324  }
325  }
326  }
327 
328  BreakpointLocationSP bp_loc_sp(AddLocation(line_start));
329  if (log && bp_loc_sp && !GetBreakpoint()->IsInternal()) {
330  StreamString s;
331  bp_loc_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose);
332  LLDB_LOGF(log, "Added location (skipped prologue: %s): %s \n",
333  skipped_prologue ? "yes" : "no", s.GetData());
334  }
335 }
336 
337 BreakpointLocationSP BreakpointResolver::AddLocation(Address loc_addr,
338  bool *new_location) {
339  loc_addr.Slide(m_offset);
340  return GetBreakpoint()->AddLocation(loc_addr, new_location);
341 }
342 
344  // There may already be an offset, so we are actually adjusting location
345  // addresses by the difference.
346  // lldb::addr_t slide = offset - m_offset;
347  // FIXME: We should go fix up all the already set locations for the new
348  // slide.
349 
350  m_offset = offset;
351 }
lldb_private::BreakpointResolver::NameToResolverTy
static ResolverTy NameToResolverTy(llvm::StringRef name)
Definition: BreakpointResolver.cpp:56
lldb_private::AddressRange::GetBaseAddress
Address & GetBaseAddress()
Get accessor for the base address of the range.
Definition: AddressRange.h:209
lldb_private::BreakpointResolver::~BreakpointResolver
~BreakpointResolver() override
The Destructor is virtual, all significant breakpoint resolvers derive from this class.
lldb_private::SymbolContext::block
Block * block
The Block for a given query.
Definition: SymbolContext.h:321
lldb_private::BreakpointResolver::ResolverTy
ResolverTy
An enumeration for keeping track of the concrete subclass that is actually instantiated.
Definition: BreakpointResolver.h:127
lldb_private::StructuredData::Dictionary
Definition: StructuredData.h:352
lldb_private::BreakpointResolverFileLine::CreateFromStructuredData
static BreakpointResolver * CreateFromStructuredData(const lldb::BreakpointSP &bkpt, const StructuredData::Dictionary &data_dict, Status &error)
Definition: BreakpointResolverFileLine.cpp:29
lldb_private::StructuredData::Object::IsValid
virtual bool IsValid() const
Definition: StructuredData.h:77
lldb_private::Address::IsValid
bool IsValid() const
Check if the object state is valid.
Definition: Address.h:345
lldb_private::SearchFilter::AddressPasses
virtual bool AddressPasses(Address &addr)
Call this method with a Address to see if address passes the filter.
Definition: SearchFilter.cpp:141
CompileUnit.h
lldb_private::Function::GetAddressRange
const AddressRange & GetAddressRange()
Definition: Function.h:457
lldb_private::BreakpointResolver::m_breakpoint
lldb::BreakpointWP m_breakpoint
Definition: BreakpointResolver.h:220
LLDB_INVALID_COLUMN_NUMBER
#define LLDB_INVALID_COLUMN_NUMBER
Definition: lldb-defines.h:87
BreakpointResolverFileRegex.h
lldb_private::BreakpointResolver::g_option_names
static const char * g_option_names[static_cast< uint32_t >(OptionNames::LastOptionName)]
Definition: BreakpointResolver.h:188
lldb_private::BreakpointResolver::AddressResolver
@ AddressResolver
Definition: BreakpointResolver.h:129
LLDB_LOGF
#define LLDB_LOGF(log,...)
Definition: Log.h:343
lldb_private::SearchFilter::SearchInModuleList
virtual void SearchInModuleList(Searcher &searcher, ModuleList &modules)
Call this method to do the search using the Searcher in the module list modules.
Definition: SearchFilter.cpp:219
BreakpointLocation.h
BreakpointResolver.h
lldb_private::SymbolContextList
Definition: SymbolContext.h:379
lldb_private::SearchFilter::Search
virtual void Search(Searcher &searcher)
Call this method to do the search using the Searcher.
Definition: SearchFilter.cpp:204
lldb::addr_t
uint64_t addr_t
Definition: lldb-types.h:83
lldb_private::SymbolContext
Definition: SymbolContext.h:33
lldb_private::BreakpointResolver::PythonResolver
@ PythonResolver
Definition: BreakpointResolver.h:132
lldb_private::BreakpointResolverAddress::CreateFromStructuredData
static BreakpointResolver * CreateFromStructuredData(const lldb::BreakpointSP &bkpt, const StructuredData::Dictionary &options_dict, Status &error)
Definition: BreakpointResolverAddress.cpp:33
lldb_private::StructuredData::Dictionary::GetValueForKeyAsInteger
bool GetValueForKeyAsInteger(llvm::StringRef key, IntType &result) const
Definition: StructuredData.h:413
Target.h
error
static llvm::raw_ostream & error(Stream &strm)
Definition: CommandReturnObject.cpp:17
lldb_private::BreakpointResolver::ResolveBreakpointInModules
virtual void ResolveBreakpointInModules(SearchFilter &filter, ModuleList &modules)
In response to this method the resolver scans the modules in the module list modules,...
Definition: BreakpointResolver.cpp:170
lldb_private::BreakpointResolver::OptionNames::LastOptionName
@ LastOptionName
lldb_private::BreakpointResolver::CreateFromStructuredData
static lldb::BreakpointResolverSP CreateFromStructuredData(const StructuredData::Dictionary &resolver_dict, Status &error)
This section handles serializing and deserializing from StructuredData objects.
Definition: BreakpointResolver.cpp:71
ModuleList.h
lldb_private::BreakpointResolver::NotifyBreakpointSet
virtual void NotifyBreakpointSet()
Definition: BreakpointResolver.h:190
lldb_private::BreakpointResolver::BreakpointResolver
BreakpointResolver(const lldb::BreakpointSP &bkpt, unsigned char resolverType, lldb::addr_t offset=0)
The breakpoint resolver need to have a breakpoint for "ResolveBreakpoint to make sense.
lldb_private::ModuleList
Definition: ModuleList.h:81
lldb_private::SearchFilter
General Outline: Provides the callback and search depth for the SearchFilter search.
Definition: SearchFilter.h:83
Log.h
lldb_private::BreakpointResolver::NameResolver
@ NameResolver
Definition: BreakpointResolver.h:130
SearchFilter.h
lldb_private::BreakpointResolver::FileLineResolver
@ FileLineResolver
Definition: BreakpointResolver.h:128
lldb_private::StreamString::GetData
const char * GetData() const
Definition: StreamString.h:43
lldb_private::BreakpointResolver::ExceptionResolver
@ ExceptionResolver
Definition: BreakpointResolver.h:133
lldb_private::SymbolContext::function
Function * function
The Function for a given query.
Definition: SymbolContext.h:320
StreamString.h
lldb_private::Address::GetFileAddress
lldb::addr_t GetFileAddress() const
Get the file address.
Definition: Address.cpp:291
lldb_private::BreakpointResolver::ResolverTyToName
static const char * ResolverTyToName(enum ResolverTy)
Definition: BreakpointResolver.cpp:48
lldb_private::SymbolContextList::GetSize
uint32_t GetSize() const
Get accessor for a symbol context list size.
Definition: SymbolContext.cpp:1274
lldb_private::StreamString
Definition: StreamString.h:23
lldb_private::BreakpointResolver::GetResolverName
const char * GetResolverName()
Definition: BreakpointResolver.h:154
lldb_private::BreakpointResolver::UnknownResolver
@ UnknownResolver
Definition: BreakpointResolver.h:135
lldb_private::LLDBLog::Breakpoints
@ Breakpoints
lldb_private::StructuredData::DictionarySP
std::shared_ptr< Dictionary > DictionarySP
Definition: StructuredData.h:67
lldb_private::BreakpointResolver::SetBreakpoint
void SetBreakpoint(const lldb::BreakpointSP &bkpt)
This sets the breakpoint for this resolver.
Definition: BreakpointResolver.cpp:164
Address.h
lldb_private::BreakpointResolver::AddLocation
lldb::BreakpointLocationSP AddLocation(Address loc_addr, bool *new_location=nullptr)
Definition: BreakpointResolver.cpp:337
lldb_private::LineEntry::line
uint32_t line
The source line number, or zero if there is no line number information.
Definition: LineEntry.h:143
lldb_private::BreakpointResolver
General Outline: The BreakpointResolver is a Searcher.
Definition: BreakpointResolver.h:35
lldb_private::BreakpointResolver::WrapOptionsDict
StructuredData::DictionarySP WrapOptionsDict(StructuredData::DictionarySP options_dict_sp)
Definition: BreakpointResolver.cpp:149
lldb_private::BreakpointResolver::OptionNames::Offset
@ Offset
lldb_private::Status
Definition: Status.h:44
lldb_private::BreakpointResolver::g_ty_to_name
static const char * g_ty_to_name[LastKnownResolverType+2]
Definition: BreakpointResolver.h:140
lldb_private::BreakpointResolver::FileRegexResolver
@ FileRegexResolver
Definition: BreakpointResolver.h:131
lldb_private::BreakpointResolverFileRegex::CreateFromStructuredData
static BreakpointResolver * CreateFromStructuredData(const lldb::BreakpointSP &bkpt, const StructuredData::Dictionary &options_dict, Status &error)
Definition: BreakpointResolverFileRegex.cpp:29
uint32_t
lldb_private::Address
Definition: Address.h:59
lldb_private::BreakpointResolver::SetSCMatchesByLine
void SetSCMatchesByLine(SearchFilter &filter, SymbolContextList &sc_list, bool skip_prologue, llvm::StringRef log_ident, uint32_t line=0, llvm::Optional< uint16_t > column=llvm::None)
Takes a symbol context list of matches which supposedly represent the same file and line number in a ...
Definition: BreakpointResolver.cpp:202
lldb_private::BreakpointResolver::GetKey
static const char * GetKey(OptionNames enum_value)
Definition: BreakpointResolver.h:193
lldb_private::Function::GetPrologueByteSize
uint32_t GetPrologueByteSize()
Get the size of the prologue instructions for this function.
Definition: Function.cpp:528
lldb_private::BreakpointResolver::GetSerializationSubclassOptionsKey
static const char * GetSerializationSubclassOptionsKey()
Definition: BreakpointResolver.h:118
UINT32_MAX
#define UINT32_MAX
Definition: lldb-defines.h:19
lldb_private::LineEntry::range
AddressRange range
The section offset address range for this line entry.
Definition: LineEntry.h:139
lldb_private::operator<
bool operator<(const Address &lhs, const Address &rhs)
Definition: Address.cpp:985
uint16_t
lldb_private::BreakpointResolver::SetOffset
void SetOffset(lldb::addr_t offset)
This updates the offset for this breakpoint.
Definition: BreakpointResolver.cpp:343
Function.h
lldb_private::BreakpointResolver::ResolveBreakpoint
virtual void ResolveBreakpoint(SearchFilter &filter)
In response to this method the resolver scans all the modules in the breakpoint's target,...
Definition: BreakpointResolver.cpp:175
SymbolContext.h
lldb_private::BreakpointResolverScripted::CreateFromStructuredData
static BreakpointResolver * CreateFromStructuredData(const lldb::BreakpointSP &bkpt, const StructuredData::Dictionary &options_dict, Status &error)
Definition: BreakpointResolverScripted.cpp:62
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
lldb::eDescriptionLevelVerbose
@ eDescriptionLevelVerbose
Definition: lldb-enumerations.h:210
BreakpointResolverName.h
lldb_private::StructuredData::Dictionary::GetValueForKeyAsDictionary
bool GetValueForKeyAsDictionary(llvm::StringRef key, Dictionary *&result) const
Definition: StructuredData.h:477
lldb_private::BreakpointResolverName::CreateFromStructuredData
static BreakpointResolver * CreateFromStructuredData(const lldb::BreakpointSP &bkpt, const StructuredData::Dictionary &data_dict, Status &error)
Definition: BreakpointResolverName.cpp:91
Breakpoint.h
lldb_private::BreakpointResolver::GetSerializationSubclassKey
static const char * GetSerializationSubclassKey()
Definition: BreakpointResolver.h:116
Stream.h
lldb_private::Log
Definition: Log.h:115
lldb_private::StructuredData::Dictionary::GetValueForKeyAsString
bool GetValueForKeyAsString(llvm::StringRef key, llvm::StringRef &result) const
Definition: StructuredData.h:433
lldb_private::SymbolContext::line_entry
LineEntry line_entry
The LineEntry for a given query.
Definition: SymbolContext.h:322
BreakpointResolverScripted.h
lldb_private::GetLog
Log * GetLog(Cat mask)
Retrieve the Log object for the channel associated with the given log enum.
Definition: Log.h:308
BreakpointResolverAddress.h
lldb_private::Address::Slide
bool Slide(int64_t offset)
Definition: Address.h:449
lldb
Definition: SBAddress.h:15
lldb_private::BreakpointResolver::GetBreakpoint
lldb::BreakpointSP GetBreakpoint() const
This gets the breakpoint for this resolver.
Definition: BreakpointResolver.h:62
BreakpointResolverFileLine.h
LLDBLog.h
lldb_private::BreakpointResolver::m_offset
lldb::addr_t m_offset
Definition: BreakpointResolver.h:221