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 
12 #include "lldb/Breakpoint/StoppointHitCounter.h"
13 #include "lldb/Utility/UserID.h"
14 #include "lldb/lldb-private.h"
15 
16 namespace lldb_private {
17 
18 class StoppointSite {
19 public:
20   StoppointSite(lldb::break_id_t bid, lldb::addr_t m_addr, bool hardware);
21 
22   StoppointSite(lldb::break_id_t bid, lldb::addr_t m_addr,
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 
33   uint32_t GetHitCount() const { return m_hit_counter.GetValue(); }
34 
35   void ResetHitCount() { m_hit_counter.Reset(); }
36 
37   bool HardwareRequired() const { return m_is_hardware_required; }
38 
39   virtual bool IsHardware() const = 0;
40 
41   virtual bool ShouldStop(StoppointCallbackContext* context) = 0;
42 
43   virtual void Dump(Stream* stream) const = 0;
44 
45   lldb::break_id_t GetID() const { return m_id; }
46 
47 protected:
48   /// Stoppoint site ID.
49   lldb::break_id_t m_id;
50 
51   /// The load address of this stop point.
52   lldb::addr_t m_addr;
53 
54   /// True if this point is required to use hardware (which may fail due to
55   /// the lack of resources).
56   bool m_is_hardware_required;
57 
58   /// The size in bytes of stoppoint, e.g. the length of the trap opcode for
59   /// software breakpoints, or the optional length in bytes for hardware
60   /// breakpoints, or the length of the watchpoint.
61   uint32_t m_byte_size;
62 
63   /// Number of times this breakpoint/watchpoint has been hit.
64   StoppointHitCounter m_hit_counter;
65 
66 private:
67   StoppointSite(const StoppointSite &) = delete;
68   const StoppointSite &operator=(const StoppointSite &) = delete;
69   StoppointSite() = delete;
70 };
71 
72 } // namespace lldb_private
73 
74 #endif // LLDB_BREAKPOINT_STOPPOINTSITE_H
75