LLDB  mainline
StoppointSite.h
Go to the documentation of this file.
1 //===-- StoppointSite.h -----------------------------------------*- C++ -*-===//
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 #ifndef LLDB_BREAKPOINT_STOPPOINTSITE_H
10 #define LLDB_BREAKPOINT_STOPPOINTSITE_H
11 
13 #include "lldb/Utility/UserID.h"
14 #include "lldb/lldb-private.h"
15 
16 namespace lldb_private {
17 
19 public:
21 
23  uint32_t byte_size, bool hardware);
24 
25  virtual ~StoppointSite() = default;
26 
27  virtual lldb::addr_t GetLoadAddress() const { return m_addr; }
28 
29  virtual void SetLoadAddress(lldb::addr_t addr) { m_addr = addr; }
30 
31  uint32_t GetByteSize() const { return m_byte_size; }
32 
34 
36 
37  bool HardwareRequired() const { return m_is_hardware_required; }
38 
39  virtual bool IsHardware() const = 0;
40 
42 
43  void SetHardwareIndex(uint32_t index) { m_hardware_index = index; }
44 
45  virtual bool ShouldStop(StoppointCallbackContext* context) = 0;
46 
47  virtual void Dump(Stream* stream) const = 0;
48 
49  lldb::break_id_t GetID() const { return m_id; }
50 
51 protected:
52  /// Stoppoint site ID.
54 
55  /// The load address of this stop point.
57 
58  /// True if this point is required to use hardware (which may fail due to
59  /// the lack of resources).
61 
62  /// The hardware resource index for this breakpoint/watchpoint.
64 
65  /// The size in bytes of stoppoint, e.g. the length of the trap opcode for
66  /// software breakpoints, or the optional length in bytes for hardware
67  /// breakpoints, or the length of the watchpoint.
69 
70  /// Number of times this breakpoint/watchpoint has been hit.
72 
73 private:
74  StoppointSite(const StoppointSite &) = delete;
75  const StoppointSite &operator=(const StoppointSite &) = delete;
76  StoppointSite() = delete;
77 };
78 
79 } // namespace lldb_private
80 
81 #endif // LLDB_BREAKPOINT_STOPPOINTSITE_H
lldb_private::StoppointSite::GetLoadAddress
virtual lldb::addr_t GetLoadAddress() const
Definition: StoppointSite.h:27
lldb_private::StoppointSite::m_id
lldb::break_id_t m_id
Stoppoint site ID.
Definition: StoppointSite.h:53
lldb_private::StoppointCallbackContext
General Outline: When we hit a breakpoint we need to package up whatever information is needed to eva...
Definition: StoppointCallbackContext.h:26
lldb_private::StoppointSite::operator=
const StoppointSite & operator=(const StoppointSite &)=delete
lldb_private::StoppointHitCounter::Reset
void Reset()
Definition: StoppointHitCounter.h:34
lldb_private::StoppointSite::Dump
virtual void Dump(Stream *stream) const =0
lldb_private::StoppointSite::GetByteSize
uint32_t GetByteSize() const
Definition: StoppointSite.h:31
lldb_private::Stream
Definition: Stream.h:28
lldb_private::StoppointSite::GetID
lldb::break_id_t GetID() const
Definition: StoppointSite.h:49
lldb_private::StoppointSite::GetHitCount
uint32_t GetHitCount() const
Definition: StoppointSite.h:33
lldb::addr_t
uint64_t addr_t
Definition: lldb-types.h:83
lldb_private::StoppointSite::SetHardwareIndex
void SetHardwareIndex(uint32_t index)
Definition: StoppointSite.h:43
lldb_private::StoppointSite::~StoppointSite
virtual ~StoppointSite()=default
lldb_private::StoppointHitCounter::GetValue
uint32_t GetValue() const
Definition: StoppointHitCounter.h:22
lldb_private::StoppointSite::ShouldStop
virtual bool ShouldStop(StoppointCallbackContext *context)=0
lldb_private::StoppointSite::m_is_hardware_required
bool m_is_hardware_required
True if this point is required to use hardware (which may fail due to the lack of resources).
Definition: StoppointSite.h:60
lldb_private::StoppointHitCounter
Definition: StoppointHitCounter.h:20
lldb_private::StoppointSite::HardwareRequired
bool HardwareRequired() const
Definition: StoppointSite.h:37
lldb::break_id_t
int32_t break_id_t
Definition: lldb-types.h:88
lldb_private::StoppointSite::m_hardware_index
uint32_t m_hardware_index
The hardware resource index for this breakpoint/watchpoint.
Definition: StoppointSite.h:63
lldb_private::StoppointSite::m_byte_size
uint32_t m_byte_size
The size in bytes of stoppoint, e.g.
Definition: StoppointSite.h:68
UserID.h
lldb-private.h
lldb_private::StoppointSite::GetHardwareIndex
uint32_t GetHardwareIndex() const
Definition: StoppointSite.h:41
lldb_private::StoppointSite::IsHardware
virtual bool IsHardware() const =0
StoppointHitCounter.h
lldb_private::StoppointSite::SetLoadAddress
virtual void SetLoadAddress(lldb::addr_t addr)
Definition: StoppointSite.h:29
uint32_t
lldb_private::StoppointSite::ResetHitCount
void ResetHitCount()
Definition: StoppointSite.h:35
lldb_private::StoppointSite::m_hit_counter
StoppointHitCounter m_hit_counter
Number of times this breakpoint/watchpoint has been hit.
Definition: StoppointSite.h:71
lldb_private::StoppointSite::m_addr
lldb::addr_t m_addr
The load address of this stop point.
Definition: StoppointSite.h:56
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
lldb_private::StoppointSite::StoppointSite
StoppointSite()=delete
lldb_private::StoppointSite
Definition: StoppointSite.h:18