LLDB mainline
BreakpointLocationList.cpp
Go to the documentation of this file.
1//===-- BreakpointLocationList.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#include "lldb/Core/Module.h"
14#include "lldb/Core/Section.h"
16#include "lldb/Target/Target.h"
19#include "lldb/Utility/Log.h"
20
21using namespace lldb;
22using namespace lldb_private;
23
26
28
31 bool resolve_indirect_symbols) {
32 std::lock_guard<std::recursive_mutex> guard(m_mutex);
33 // The location ID is just the size of the location list + 1
34 lldb::break_id_t bp_loc_id = ++m_next_id;
35 BreakpointLocationSP bp_loc_sp(
37 resolve_indirect_symbols));
38 m_locations.push_back(bp_loc_sp);
39 m_address_to_location[addr] = bp_loc_sp;
40 return bp_loc_sp;
41}
42
44 lldb::break_id_t break_id) {
45 BreakpointLocationSP bp = FindByID(break_id);
46 if (bp) {
47 // Let the BreakpointLocation decide if it should stop here (could not have
48 // reached it's target hit count yet, or it could have a callback that
49 // decided it shouldn't stop (shared library loads/unloads).
50 return bp->ShouldStop(context);
51 }
52 // We should stop here since this BreakpointLocation isn't valid anymore or
53 // it doesn't exist.
54 return true;
55}
56
58 BreakpointLocationSP bp_loc_sp = FindByAddress(addr);
59 if (bp_loc_sp) {
60 return bp_loc_sp->GetID();
61 }
63}
64
66 return lhs->GetID() < val;
67}
68
71 std::lock_guard<std::recursive_mutex> guard(m_mutex);
72 collection::const_iterator end = m_locations.end();
73 collection::const_iterator pos =
74 llvm::lower_bound(m_locations, break_id, Compare);
75 if (pos != end && (*pos)->GetID() == break_id)
76 return *(pos);
77 return BreakpointLocationSP();
78}
79
81 Module *module, BreakpointLocationCollection &bp_loc_list) {
82 std::lock_guard<std::recursive_mutex> guard(m_mutex);
83 const size_t orig_size = bp_loc_list.GetSize();
84 collection::iterator pos, end = m_locations.end();
85
86 for (pos = m_locations.begin(); pos != end; ++pos) {
87 BreakpointLocationSP break_loc = (*pos);
88 SectionSP section_sp(break_loc->GetAddress().GetSection());
89 if (section_sp && section_sp->GetModule().get() == module) {
90 bp_loc_list.Add(break_loc);
91 }
92 }
93 return bp_loc_list.GetSize() - orig_size;
94}
95
98 std::lock_guard<std::recursive_mutex> guard(m_mutex);
99 BreakpointLocationSP bp_loc_sp;
100 if (!m_locations.empty()) {
101 Address so_addr;
102
103 if (addr.IsSectionOffset()) {
104 so_addr = addr;
105 } else {
106 // Try and resolve as a load address if possible.
107 m_owner.GetTarget().ResolveLoadAddress(addr.GetOffset(), so_addr);
108 if (!so_addr.IsValid()) {
109 // The address didn't resolve, so just set to passed in addr.
110 so_addr = addr;
111 }
112 }
113
114 addr_map::const_iterator pos = m_address_to_location.find(so_addr);
115 if (pos != m_address_to_location.end())
116 bp_loc_sp = pos->second;
117 }
118
119 return bp_loc_sp;
120}
121
123 s->Printf("%p: ", static_cast<const void *>(this));
124 // s->Indent();
125 std::lock_guard<std::recursive_mutex> guard(m_mutex);
126 s->Printf("BreakpointLocationList with %" PRIu64 " BreakpointLocations:\n",
127 (uint64_t)m_locations.size());
128 s->IndentMore();
129 collection::const_iterator pos, end = m_locations.end();
130 for (pos = m_locations.begin(); pos != end; ++pos)
131 (*pos)->Dump(s);
132 s->IndentLess();
133}
134
136 std::lock_guard<std::recursive_mutex> guard(m_mutex);
137 BreakpointLocationSP bp_loc_sp;
138 if (i < m_locations.size())
139 bp_loc_sp = m_locations[i];
140
141 return bp_loc_sp;
142}
143
145 std::lock_guard<std::recursive_mutex> guard(m_mutex);
146 BreakpointLocationSP bp_loc_sp;
147 if (i < m_locations.size())
148 bp_loc_sp = m_locations[i];
149
150 return bp_loc_sp;
151}
152
154 std::lock_guard<std::recursive_mutex> guard(m_mutex);
155 collection::iterator pos, end = m_locations.end();
157
158 for (pos = m_locations.begin(); pos != end; ++pos) {
159 if (llvm::Error error = (*pos)->ClearBreakpointSite())
160 LLDB_LOG_ERROR(log, std::move(error), "{0}");
161 }
162}
163
165 std::lock_guard<std::recursive_mutex> guard(m_mutex);
166 collection::iterator pos, end = m_locations.end();
168
169 for (pos = m_locations.begin(); pos != end; ++pos) {
170 if ((*pos)->IsEnabled()) {
171 if (llvm::Error error = (*pos)->ResolveBreakpointSite())
172 LLDB_LOG_ERROR(log, std::move(error), "{0}");
173 }
174 }
175}
176
178 uint32_t hit_count = 0;
179 std::lock_guard<std::recursive_mutex> guard(m_mutex);
180 collection::const_iterator pos, end = m_locations.end();
181 for (pos = m_locations.begin(); pos != end; ++pos)
182 hit_count += (*pos)->GetHitCount();
183 return hit_count;
184}
185
187 std::lock_guard<std::recursive_mutex> guard(m_mutex);
188 for (auto &loc : m_locations)
189 loc->ResetHitCount();
190}
191
193 std::lock_guard<std::recursive_mutex> guard(m_mutex);
194 size_t resolve_count = 0;
195 collection::const_iterator pos, end = m_locations.end();
196 for (pos = m_locations.begin(); pos != end; ++pos) {
197 if ((*pos)->IsResolved())
198 ++resolve_count;
199 }
200 return resolve_count;
201}
202
205 std::lock_guard<std::recursive_mutex> guard(m_mutex);
206 collection::iterator pos, end = m_locations.end();
207
208 for (pos = m_locations.begin(); pos != end; ++pos) {
209 s->Printf(" ");
210 (*pos)->GetDescription(s, level);
211 }
212}
213
215 const Address &addr, bool resolve_indirect_symbols, bool *new_location) {
216 std::lock_guard<std::recursive_mutex> guard(m_mutex);
217
218 if (new_location)
219 *new_location = false;
220 BreakpointLocationSP bp_loc_sp(FindByAddress(addr));
221 if (!bp_loc_sp) {
222 bp_loc_sp = Create(addr, resolve_indirect_symbols);
223 if (bp_loc_sp) {
224 if (llvm::Error error = bp_loc_sp->ResolveBreakpointSite())
225 LLDB_LOG_ERROR(GetLog(LLDBLog::Breakpoints), std::move(error), "{0}");
226
227 if (new_location)
228 *new_location = true;
230 m_new_location_recorder->Add(bp_loc_sp);
231 }
232 }
233 }
234 return bp_loc_sp;
235}
236
238 BreakpointLocationSP to_location_sp,
239 BreakpointLocationSP from_location_sp) {
240 if (!from_location_sp || !to_location_sp)
241 return;
242
243 m_address_to_location.erase(to_location_sp->GetAddress());
244 to_location_sp->SwapLocation(from_location_sp);
245 RemoveLocation(from_location_sp);
246 m_address_to_location[to_location_sp->GetAddress()] = to_location_sp;
247 llvm::consumeError(to_location_sp->ResolveBreakpointSite());
248}
249
251 const lldb::BreakpointLocationSP &bp_loc_sp) {
252 if (bp_loc_sp) {
253 std::lock_guard<std::recursive_mutex> guard(m_mutex);
254
255 m_address_to_location.erase(bp_loc_sp->GetAddress());
256
257 size_t num_locations = m_locations.size();
258 for (size_t idx = 0; idx < num_locations; idx++) {
259 if (m_locations[idx].get() == bp_loc_sp.get()) {
261 return true;
262 }
263 }
264 }
265 return false;
266}
267
269 assert (idx < m_locations.size());
270 m_address_to_location.erase(m_locations[idx]->GetAddress());
271 m_locations.erase(m_locations.begin() + idx);
272}
273
275 std::lock_guard<std::recursive_mutex> guard(m_mutex);
276 size_t idx = 0;
277 // Don't cache m_location.size() as it will change since we might remove
278 // locations from our vector...
279 while (idx < m_locations.size()) {
280 BreakpointLocation *bp_loc = m_locations[idx].get();
281 if (bp_loc->GetAddress().SectionWasDeleted()) {
282 // Section was deleted which means this breakpoint comes from a module
283 // that is no longer valid, so we should remove it.
285 continue;
286 }
287 if (arch.IsValid()) {
288 ModuleSP module_sp(bp_loc->GetAddress().GetModule());
289 if (module_sp) {
290 if (!arch.IsCompatibleMatch(module_sp->GetArchitecture())) {
291 // The breakpoint was in a module whose architecture is no longer
292 // compatible with "arch", so we need to remove it
294 continue;
295 }
296 }
297 }
298 // Only increment the index if we didn't remove the locations at index
299 // "idx"
300 ++idx;
301 }
302}
303
305 BreakpointLocationCollection &new_locations) {
306 std::lock_guard<std::recursive_mutex> guard(m_mutex);
307 assert(m_new_location_recorder == nullptr);
308 m_new_location_recorder = &new_locations;
309}
310
312 std::lock_guard<std::recursive_mutex> guard(m_mutex);
313 m_new_location_recorder = nullptr;
314}
315
317 lldb::break_id_t highest_id = 0;
318
319 for (BreakpointLocationSP loc_sp : m_locations) {
320 lldb::break_id_t cur_id = loc_sp->GetID();
321 if (cur_id > highest_id)
322 highest_id = cur_id;
323 }
324 m_next_id = highest_id;
325}
static bool Compare(BreakpointLocationSP lhs, lldb::break_id_t val)
static llvm::raw_ostream & error(Stream &strm)
#define LLDB_LOG_ERROR(log, error,...)
Definition Log.h:392
A section + offset based address class.
Definition Address.h:62
bool SectionWasDeleted() const
Definition Address.cpp:800
lldb::ModuleSP GetModule() const
Get accessor for the module for this address.
Definition Address.cpp:273
lldb::addr_t GetOffset() const
Get the section relative offset value.
Definition Address.h:329
bool IsValid() const
Check if the object state is valid.
Definition Address.h:355
bool IsSectionOffset() const
Check if an address is section offset.
Definition Address.h:342
An architecture specification class.
Definition ArchSpec.h:31
bool IsValid() const
Tests if this ArchSpec is valid.
Definition ArchSpec.h:366
bool IsCompatibleMatch(const ArchSpec &rhs) const
Shorthand for IsMatch(rhs, CompatibleMatch).
Definition ArchSpec.h:520
void Add(const lldb::BreakpointLocationSP &bp_loc_sp)
Add the breakpoint bp_loc_sp to the list.
size_t GetSize() const
Returns the number of elements in this breakpoint location list.
void ResetHitCount()
Resets the hit count of all locations in this list.
void GetDescription(Stream *s, lldb::DescriptionLevel level)
Print a description of the breakpoint locations in this list to the stream s.
void RemoveInvalidLocations(const ArchSpec &arch)
lldb::BreakpointLocationSP GetByIndex(size_t i)
Returns a shared pointer to the breakpoint location with index i.
bool RemoveLocation(const lldb::BreakpointLocationSP &bp_loc_sp)
void Dump(Stream *s) const
Standard "Dump" method. At present it does nothing.
void ClearAllBreakpointSites()
Removes all the locations in this list from their breakpoint site owners list.
uint32_t GetHitCount() const
Returns the number hit count of all locations in this list.
const lldb::BreakpointLocationSP FindByAddress(const Address &addr) const
Returns a shared pointer to the breakpoint location at address addr - const version.
void ResolveAllBreakpointSites()
Tells all the breakpoint locations in this list to attempt to resolve any possible breakpoint sites.
size_t FindInModule(Module *module, BreakpointLocationCollection &bp_loc_list)
Returns a breakpoint location list of the breakpoint locations in the module module.
BreakpointLocationList(Breakpoint &owner)
This is the standard constructor.
bool ShouldStop(StoppointCallbackContext *context, lldb::break_id_t breakID)
Enquires of the breakpoint location in this list with ID breakID whether we should stop.
BreakpointLocationCollection * m_new_location_recorder
lldb::BreakpointLocationSP FindByID(lldb::break_id_t breakID) const
Returns a shared pointer to the breakpoint location with id breakID, const version.
lldb::BreakpointLocationSP Create(const Address &addr, bool resolve_indirect_symbols)
lldb::BreakpointLocationSP AddLocation(const Address &addr, bool resolve_indirect_symbols, bool *new_location=nullptr)
void StartRecordingNewLocations(BreakpointLocationCollection &new_locations)
lldb::break_id_t FindIDByAddress(const Address &addr)
Returns the breakpoint location id to the breakpoint location at address addr.
size_t GetNumResolvedLocations() const
Returns the number of breakpoint locations in this list with resolved breakpoints.
void SwapLocation(lldb::BreakpointLocationSP to_location_sp, lldb::BreakpointLocationSP from_location_sp)
General Outline: A breakpoint location is defined by the breakpoint that produces it,...
Address & GetAddress()
Gets the Address for this breakpoint location.
A class that describes an executable image and its associated object and symbol files.
Definition Module.h:90
General Outline: When we hit a breakpoint we need to package up whatever information is needed to eva...
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
void IndentLess(unsigned amount=2)
Decrement the current indentation level.
Definition Stream.cpp:198
void IndentMore(unsigned amount=2)
Increment the current indentation level.
Definition Stream.cpp:195
#define LLDB_INVALID_BREAK_ID
#define LLDB_INVALID_THREAD_ID
A class that represents a running process on the host machine.
Log * GetLog(Cat mask)
Retrieve the Log object for the channel associated with the given log enum.
Definition Log.h:332
std::shared_ptr< lldb_private::BreakpointLocation > BreakpointLocationSP
DescriptionLevel
Description levels for "void GetDescription(Stream *, DescriptionLevel)" calls.
int32_t break_id_t
Definition lldb-types.h:86
std::shared_ptr< lldb_private::Section > SectionSP
std::shared_ptr< lldb_private::Module > ModuleSP