1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
| //===-- WatchpointList.h ----------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef liblldb_WatchpointList_h_
#define liblldb_WatchpointList_h_
#include <list>
#include <mutex>
#include <vector>
#include "lldb/Core/Address.h"
#include "lldb/lldb-private.h"
namespace lldb_private {
/// \class WatchpointList WatchpointList.h "lldb/Breakpoint/WatchpointList.h"
/// This class is used by Watchpoint to manage a list of watchpoints,
// each watchpoint in the list has a unique ID, and is unique by Address as
// well.
class WatchpointList {
// Only Target can make the watchpoint list, or add elements to it. This is
// not just some random collection of watchpoints. Rather, the act of adding
// the watchpoint to this list sets its ID.
friend class Watchpoint;
friend class Target;
public:
/// Default constructor makes an empty list.
WatchpointList();
/// Destructor, currently does nothing.
~WatchpointList();
/// Add a Watchpoint to the list.
///
/// \param[in] wp_sp
/// A shared pointer to a watchpoint being added to the list.
///
/// \return
/// The ID of the Watchpoint in the list.
lldb::watch_id_t Add(const lldb::WatchpointSP &wp_sp, bool notify);
/// Standard "Dump" method.
void Dump(Stream *s) const;
/// Dump with lldb::DescriptionLevel.
void DumpWithLevel(Stream *s, lldb::DescriptionLevel description_level) const;
/// Returns a shared pointer to the watchpoint at address \a addr - const
/// version.
///
/// \param[in] addr
/// The address to look for.
///
/// \result
/// A shared pointer to the watchpoint. May contain a NULL
/// pointer if the watchpoint doesn't exist.
const lldb::WatchpointSP FindByAddress(lldb::addr_t addr) const;
/// Returns a shared pointer to the watchpoint with watchpoint spec \a spec
/// - const version.
///
/// \param[in] spec
/// The watchpoint spec to look for.
///
/// \result
/// A shared pointer to the watchpoint. May contain a NULL
/// pointer if the watchpoint doesn't exist.
const lldb::WatchpointSP FindBySpec(std::string spec) const;
/// Returns a shared pointer to the watchpoint with id \a watchID, const
/// version.
///
/// \param[in] watchID
/// The watchpoint location ID to seek for.
///
/// \result
/// A shared pointer to the watchpoint. May contain a NULL
/// pointer if the watchpoint doesn't exist.
lldb::WatchpointSP FindByID(lldb::watch_id_t watchID) const;
/// Returns the watchpoint id to the watchpoint at address \a addr.
///
/// \param[in] addr
/// The address to match.
///
/// \result
/// The ID of the watchpoint, or LLDB_INVALID_WATCH_ID.
lldb::watch_id_t FindIDByAddress(lldb::addr_t addr);
/// Returns the watchpoint id to the watchpoint with watchpoint spec \a
/// spec.
///
/// \param[in] spec
/// The watchpoint spec to match.
///
/// \result
/// The ID of the watchpoint, or LLDB_INVALID_WATCH_ID.
lldb::watch_id_t FindIDBySpec(std::string spec);
/// Returns a shared pointer to the watchpoint with index \a i.
///
/// \param[in] i
/// The watchpoint index to seek for.
///
/// \result
/// A shared pointer to the watchpoint. May contain a NULL pointer if
/// the watchpoint doesn't exist.
lldb::WatchpointSP GetByIndex(uint32_t i);
/// Returns a shared pointer to the watchpoint with index \a i, const
/// version.
///
/// \param[in] i
/// The watchpoint index to seek for.
///
/// \result
/// A shared pointer to the watchpoint. May contain a NULL pointer if
/// the watchpoint location doesn't exist.
const lldb::WatchpointSP GetByIndex(uint32_t i) const;
/// Removes the watchpoint given by \b watchID from this list.
///
/// \param[in] watchID
/// The watchpoint ID to remove.
///
/// \result
/// \b true if the watchpoint \a watchID was in the list.
bool Remove(lldb::watch_id_t watchID, bool notify);
/// Returns the number hit count of all watchpoints in this list.
///
/// \result
/// Hit count of all watchpoints in this list.
uint32_t GetHitCount() const;
/// Enquires of the watchpoint in this list with ID \a watchID whether we
/// should stop.
///
/// \param[in] context
/// This contains the information about this stop.
///
/// \param[in] watchID
/// This watch ID that we hit.
///
/// \return
/// \b true if we should stop, \b false otherwise.
bool ShouldStop(StoppointCallbackContext *context, lldb::watch_id_t watchID);
/// Returns the number of elements in this watchpoint list.
///
/// \result
/// The number of elements.
size_t GetSize() const {
std::lock_guard<std::recursive_mutex> guard(m_mutex);
return m_watchpoints.size();
}
/// Print a description of the watchpoints in this list to the stream \a s.
///
/// \param[in] s
/// The stream to which to print the description.
///
/// \param[in] level
/// The description level that indicates the detail level to
/// provide.
///
/// \see lldb::DescriptionLevel
void GetDescription(Stream *s, lldb::DescriptionLevel level);
void SetEnabledAll(bool enabled);
void RemoveAll(bool notify);
/// Sets the passed in Locker to hold the Watchpoint List mutex.
///
/// \param[in] locker
/// The locker object that is set.
void GetListMutex(std::unique_lock<std::recursive_mutex> &lock);
protected:
typedef std::list<lldb::WatchpointSP> wp_collection;
typedef std::vector<lldb::watch_id_t> id_vector;
id_vector GetWatchpointIDs() const;
wp_collection::iterator GetIDIterator(lldb::watch_id_t watchID);
wp_collection::const_iterator
GetIDConstIterator(lldb::watch_id_t watchID) const;
wp_collection m_watchpoints;
mutable std::recursive_mutex m_mutex;
lldb::watch_id_t m_next_wp_id;
};
} // namespace lldb_private
#endif // liblldb_WatchpointList_h_
|