LLDB mainline
BreakpointSite.cpp
Go to the documentation of this file.
1//===-- BreakpointSite.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
9#include <cinttypes>
10
12
16#include "lldb/Utility/Stream.h"
17
18using namespace lldb;
19using namespace lldb_private;
20
22 const BreakpointLocationSP &owner,
23 lldb::addr_t addr, bool use_hardware)
24 : StoppointSite(GetNextID(), addr, 0, use_hardware),
25 m_type(eSoftware), // Process subclasses need to set this correctly using
26 // SetType()
27 m_saved_opcode(), m_trap_opcode(),
28 m_enabled(false) // Need to create it disabled, so the first enable turns
29 // it on.
30{
31 m_owners.Add(owner);
32}
33
35 BreakpointLocationSP bp_loc_sp;
36 const size_t owner_count = m_owners.GetSize();
37 for (size_t i = 0; i < owner_count; i++) {
38 m_owners.GetByIndex(i)->ClearBreakpointSite();
39 }
40}
41
43 static break_id_t g_next_id = 0;
44 return ++g_next_id;
45}
46
47// RETURNS - true if we should stop at this breakpoint, false if we
48// should continue.
49
52 // ShouldStop can do a lot of work, and might even come come back and hit
53 // this breakpoint site again. So don't hold the m_owners_mutex the whole
54 // while. Instead make a local copy of the collection and call ShouldStop on
55 // the copy.
57 {
58 std::lock_guard<std::recursive_mutex> guard(m_owners_mutex);
59 owners_copy = m_owners;
60 }
61 return owners_copy.ShouldStop(context);
62}
63
65 std::lock_guard<std::recursive_mutex> guard(m_owners_mutex);
66 const size_t owner_count = m_owners.GetSize();
67 for (size_t i = 0; i < owner_count; i++) {
68 if (m_owners.GetByIndex(i)->GetBreakpoint().GetID() == bp_id)
69 return true;
70 }
71 return false;
72}
73
75 if (s == nullptr)
76 return;
77
78 s->Printf("BreakpointSite %u: addr = 0x%8.8" PRIx64
79 " type = %s breakpoint hw_index = %i hit_count = %-4u",
80 GetID(), (uint64_t)m_addr, IsHardware() ? "hardware" : "software",
82}
83
85 std::lock_guard<std::recursive_mutex> guard(m_owners_mutex);
87 s->Printf("breakpoint site: %d at 0x%8.8" PRIx64, GetID(),
89 m_owners.GetDescription(s, level);
90}
91
93
95
96const uint8_t *BreakpointSite::GetTrapOpcodeBytes() const {
97 return &m_trap_opcode[0];
98}
99
101 return sizeof(m_trap_opcode);
102}
103
104bool BreakpointSite::SetTrapOpcode(const uint8_t *trap_opcode,
105 uint32_t trap_opcode_size) {
106 if (trap_opcode_size > 0 && trap_opcode_size <= sizeof(m_trap_opcode)) {
107 m_byte_size = trap_opcode_size;
108 ::memcpy(m_trap_opcode, trap_opcode, trap_opcode_size);
109 return true;
110 }
111 m_byte_size = 0;
112 return false;
113}
114
116
118 return &m_saved_opcode[0];
119}
120
121bool BreakpointSite::IsEnabled() const { return m_enabled; }
122
123void BreakpointSite::SetEnabled(bool enabled) { m_enabled = enabled; }
124
125void BreakpointSite::AddOwner(const BreakpointLocationSP &owner) {
126 std::lock_guard<std::recursive_mutex> guard(m_owners_mutex);
127 m_owners.Add(owner);
128}
129
131 lldb::break_id_t break_loc_id) {
132 std::lock_guard<std::recursive_mutex> guard(m_owners_mutex);
133 m_owners.Remove(break_id, break_loc_id);
134 return m_owners.GetSize();
135}
136
138 std::lock_guard<std::recursive_mutex> guard(m_owners_mutex);
139 return m_owners.GetSize();
140}
141
142BreakpointLocationSP BreakpointSite::GetOwnerAtIndex(size_t index) {
143 std::lock_guard<std::recursive_mutex> guard(m_owners_mutex);
144 return m_owners.GetByIndex(index);
145}
146
148 std::lock_guard<std::recursive_mutex> guard(m_owners_mutex);
149 return m_owners.ValidForThisThread(thread);
150}
151
153 std::lock_guard<std::recursive_mutex> guard(m_owners_mutex);
154 for (BreakpointLocationSP loc_sp : m_owners.BreakpointLocations()) {
155 loc_sp->BumpHitCount();
156 }
157}
158
160 lldb::addr_t *intersect_addr,
161 size_t *intersect_size,
162 size_t *opcode_offset) const {
163 // The function should be called only for software breakpoints.
165
166 if (m_byte_size == 0)
167 return false;
168
169 const lldb::addr_t bp_end_addr = m_addr + m_byte_size;
170 const lldb::addr_t end_addr = addr + size;
171 // Is the breakpoint end address before the passed in start address?
172 if (bp_end_addr <= addr)
173 return false;
174
175 // Is the breakpoint start address after passed in end address?
176 if (end_addr <= m_addr)
177 return false;
178
179 if (intersect_addr || intersect_size || opcode_offset) {
180 if (m_addr < addr) {
181 if (intersect_addr)
182 *intersect_addr = addr;
183 if (intersect_size)
184 *intersect_size =
185 std::min<lldb::addr_t>(bp_end_addr, end_addr) - addr;
186 if (opcode_offset)
187 *opcode_offset = addr - m_addr;
188 } else {
189 if (intersect_addr)
190 *intersect_addr = m_addr;
191 if (intersect_size)
192 *intersect_size =
193 std::min<lldb::addr_t>(bp_end_addr, end_addr) - m_addr;
194 if (opcode_offset)
195 *opcode_offset = 0;
196 }
197 }
198 return true;
199}
200
201size_t
203 std::lock_guard<std::recursive_mutex> guard(m_owners_mutex);
204 for (BreakpointLocationSP loc_sp : m_owners.BreakpointLocations()) {
205 out_collection.Add(loc_sp);
206 }
207 return out_collection.GetSize();
208}
#define lldbassert(x)
Definition: LLDBAssert.h:15
void GetDescription(Stream *s, lldb::DescriptionLevel level)
Print a description of the breakpoint locations in this list to the stream s.
bool IsInternal() const
Tell whether ALL the breakpoints in the location collection are internal.
bool ValidForThisThread(Thread &thread)
Check whether this collection of breakpoint locations have any thread specifiers, and if yes,...
bool ShouldStop(StoppointCallbackContext *context)
Enquires of all the breakpoint locations in this list whether we should stop at a hit at breakID.
BreakpointLocationCollectionIterable BreakpointLocations()
lldb::BreakpointLocationSP GetByIndex(size_t i)
Returns a shared pointer to the breakpoint location with index i.
void Add(const lldb::BreakpointLocationSP &bp_loc_sp)
Add the breakpoint bp_loc_sp to the list.
bool Remove(lldb::break_id_t break_id, lldb::break_id_t break_loc_id)
Removes the breakpoint location given by breakID from this list.
size_t GetSize() const
Returns the number of elements in this breakpoint location list.
"lldb/Breakpoint/BreakpointSiteList.h" Class that manages lists of BreakpointSite shared pointers.
bool SetTrapOpcode(const uint8_t *trap_opcode, uint32_t trap_opcode_size)
Sets the trap opcode.
static lldb::break_id_t GetNextID()
void Dump(Stream *s) const override
Standard Dump method.
bool ShouldStop(StoppointCallbackContext *context) override
Enquires of the breakpoint locations that produced this breakpoint site whether we should stop at thi...
size_t GetTrapOpcodeMaxByteSize() const
Get the size of the trap opcode for this address.
BreakpointSite::Type GetType() const
bool IntersectsRange(lldb::addr_t addr, size_t size, lldb::addr_t *intersect_addr, size_t *intersect_size, size_t *opcode_offset) const
Says whether addr and size size intersects with the address intersect_addr.
void AddOwner(const lldb::BreakpointLocationSP &owner)
The "Owners" are the breakpoint locations that share this breakpoint site.
bool IsBreakpointAtThisSite(lldb::break_id_t bp_id)
Tell whether a breakpoint has a location at this site.
uint8_t * GetTrapOpcodeBytes()
Returns the Opcode Bytes for this breakpoint.
bool IsInternal() const
Tell whether ALL the breakpoints in the location collection are internal.
bool ValidForThisThread(Thread &thread)
Check whether the owners of this breakpoint site have any thread specifiers, and if yes,...
void GetDescription(Stream *s, lldb::DescriptionLevel level)
Print a description of this breakpoint site to the stream s.
size_t CopyOwnersList(BreakpointLocationCollection &out_collection)
This method copies the breakpoint site's owners into a new collection.
BreakpointLocationCollection m_owners
This has the BreakpointLocations that share this breakpoint site.
uint8_t m_trap_opcode[8]
The opcode that was used to create the breakpoint if it is a software breakpoint site.
uint8_t * GetSavedOpcodeBytes()
Gets the original instruction bytes that were overwritten by the trap.
bool IsHardware() const override
lldb::BreakpointLocationSP GetOwnerAtIndex(size_t idx)
This method returns the breakpoint location at index index located at this breakpoint site.
bool m_enabled
Boolean indicating if this breakpoint site enabled or not.
uint8_t m_saved_opcode[8]
The saved opcode bytes if this breakpoint site uses trap opcodes.
size_t GetNumberOfOwners()
This method returns the number of breakpoint locations currently located at this breakpoint site.
bool IsEnabled() const
Tells whether the current breakpoint site is enabled or not.
BreakpointSite(BreakpointSiteList *list, const lldb::BreakpointLocationSP &owner, lldb::addr_t m_addr, bool use_hardware)
std::recursive_mutex m_owners_mutex
This mutex protects the owners collection.
size_t RemoveOwner(lldb::break_id_t break_id, lldb::break_id_t break_loc_id)
The method removes the owner at break_loc_id from this breakpoint list.
void SetEnabled(bool enabled)
Sets whether the current breakpoint site is enabled or not.
General Outline: When we hit a breakpoint we need to package up whatever information is needed to eva...
void Increment(uint32_t difference=1)
uint32_t GetHardwareIndex() const
Definition: StoppointSite.h:41
lldb::addr_t m_addr
The load address of this stop point.
Definition: StoppointSite.h:56
lldb::break_id_t GetID() const
Definition: StoppointSite.h:49
uint32_t GetHitCount() const
Definition: StoppointSite.h:33
StoppointHitCounter m_hit_counter
Number of times this breakpoint/watchpoint has been hit.
Definition: StoppointSite.h:71
virtual lldb::addr_t GetLoadAddress() const
Definition: StoppointSite.h:27
uint32_t m_byte_size
The size in bytes of stoppoint, e.g.
Definition: StoppointSite.h:68
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
A class that represents a running process on the host machine.
Definition: SBAddress.h:15
DescriptionLevel
Description levels for "void GetDescription(Stream *, DescriptionLevel)" calls.
@ eDescriptionLevelBrief
int32_t break_id_t
Definition: lldb-types.h:88
uint64_t addr_t
Definition: lldb-types.h:83