1 //===-- Breakpoint.h --------------------------------------------*- C++ -*-===//
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
7 //===----------------------------------------------------------------------===//
9 #ifndef liblldb_Breakpoint_h_
10 #define liblldb_Breakpoint_h_
14 #include <unordered_set>
17 #include "lldb/Breakpoint/BreakpointID.h"
18 #include "lldb/Breakpoint/BreakpointLocationCollection.h"
19 #include "lldb/Breakpoint/BreakpointLocationList.h"
20 #include "lldb/Breakpoint/BreakpointName.h"
21 #include "lldb/Breakpoint/BreakpointOptions.h"
22 #include "lldb/Breakpoint/Stoppoint.h"
23 #include "lldb/Core/SearchFilter.h"
24 #include "lldb/Utility/Event.h"
25 #include "lldb/Utility/StringList.h"
26 #include "lldb/Utility/StructuredData.h"
28 namespace lldb_private {
30 /// \class Breakpoint Breakpoint.h "lldb/Breakpoint/Breakpoint.h" Class that
31 /// manages logical breakpoint setting.
34 /// A breakpoint has four main parts, a filter, a resolver, the list of
36 /// locations that have been determined for the filter/resolver pair, and
37 /// finally a set of options for the breakpoint.
40 /// This is an object derived from SearchFilter. It manages the search for
41 /// breakpoint location matches through the symbols in the module list of the
42 /// target that owns it. It also filters out locations based on whatever
46 /// This is an object derived from BreakpointResolver. It provides a callback
47 /// to the filter that will find breakpoint locations. How it does this is
48 /// determined by what kind of resolver it is.
50 /// The Breakpoint class also provides constructors for the common breakpoint
51 /// cases which make the appropriate filter and resolver for you.
54 /// This stores the breakpoint locations that have been determined to date.
55 /// For a given breakpoint, there will be only one location with a given
56 /// address. Adding a location at an already taken address will just return
57 /// the location already at that address. Locations can be looked up by ID,
62 /// \b Enabled/Disabled
66 /// Note, these options can be set on the breakpoint, and they can also be set
67 /// on the individual locations. The options set on the breakpoint take
68 /// precedence over the options set on the individual location. So for
69 /// instance disabling the breakpoint will cause NONE of the locations to get
70 /// hit. But if the breakpoint is enabled, then the location's enabled state
71 /// will be checked to determine whether to insert that breakpoint location.
72 /// Similarly, if the breakpoint condition says "stop", we won't check the
73 /// location's condition. But if the breakpoint condition says "continue",
74 /// then we will check the location for whether to actually stop or not. One
75 /// subtle point worth observing here is that you don't actually stop at a
76 /// Breakpoint, you always stop at one of its locations. So the "should stop"
77 /// tests are done by the location, not by the breakpoint.
78 class Breakpoint : public std::enable_shared_from_this<Breakpoint>,
81 static ConstString GetEventIdentifier();
83 /// An enum specifying the match style for breakpoint settings. At present
84 /// only used for function name style breakpoints.
85 enum MatchType { Exact, Regexp, Glob };
88 enum class OptionNames : uint32_t { Names = 0, Hardware, LastOptionName };
91 *g_option_names[static_cast<uint32_t>(OptionNames::LastOptionName)];
93 static const char *GetKey(OptionNames enum_value) {
94 return g_option_names[static_cast<uint32_t>(enum_value)];
98 class BreakpointEventData : public EventData {
100 BreakpointEventData(lldb::BreakpointEventType sub_type,
101 const lldb::BreakpointSP &new_breakpoint_sp);
103 ~BreakpointEventData() override;
105 static ConstString GetFlavorString();
107 ConstString GetFlavor() const override;
109 lldb::BreakpointEventType GetBreakpointEventType() const;
111 lldb::BreakpointSP &GetBreakpoint();
113 BreakpointLocationCollection &GetBreakpointLocationCollection() {
117 void Dump(Stream *s) const override;
119 static lldb::BreakpointEventType
120 GetBreakpointEventTypeFromEvent(const lldb::EventSP &event_sp);
122 static lldb::BreakpointSP
123 GetBreakpointFromEvent(const lldb::EventSP &event_sp);
125 static lldb::BreakpointLocationSP
126 GetBreakpointLocationAtIndexFromEvent(const lldb::EventSP &event_sp,
130 GetNumBreakpointLocationsFromEvent(const lldb::EventSP &event_sp);
132 static const BreakpointEventData *
133 GetEventDataFromEvent(const Event *event_sp);
136 lldb::BreakpointEventType m_breakpoint_event;
137 lldb::BreakpointSP m_new_breakpoint_sp;
138 BreakpointLocationCollection m_locations;
140 DISALLOW_COPY_AND_ASSIGN(BreakpointEventData);
143 // Saving & restoring breakpoints:
144 static lldb::BreakpointSP CreateFromStructuredData(
145 Target &target, StructuredData::ObjectSP &data_object_sp, Status &error);
148 SerializedBreakpointMatchesNames(StructuredData::ObjectSP &bkpt_object_sp,
149 std::vector<std::string> &names);
151 virtual StructuredData::ObjectSP SerializeToStructuredData();
153 static const char *GetSerializationKey() { return "Breakpoint"; }
156 /// The destructor is not virtual since there should be no reason to
157 /// subclass breakpoints. The varieties of breakpoints are specified
158 /// instead by providing different resolvers & filters.
159 ~Breakpoint() override;
163 /// Tell whether this breakpoint is an "internal" breakpoint. \return
164 /// Returns \b true if this is an internal breakpoint, \b false otherwise.
165 bool IsInternal() const;
167 /// Standard "Dump" method. At present it does nothing.
168 void Dump(Stream *s) override;
170 // The next set of methods provide ways to tell the breakpoint to update it's
171 // location list - usually done when modules appear or disappear.
173 /// Tell this breakpoint to clear all its breakpoint sites. Done when the
174 /// process holding the breakpoint sites is destroyed.
175 void ClearAllBreakpointSites();
177 /// Tell this breakpoint to scan it's target's module list and resolve any
178 /// new locations that match the breakpoint's specifications.
179 void ResolveBreakpoint();
181 /// Tell this breakpoint to scan a given module list and resolve any new
182 /// locations that match the breakpoint's specifications.
184 /// \param[in] module_list
185 /// The list of modules to look in for new locations.
187 /// \param[in] send_event
188 /// If \b true, send a breakpoint location added event for non-internal
190 void ResolveBreakpointInModules(ModuleList &module_list,
191 bool send_event = true);
193 /// Tell this breakpoint to scan a given module list and resolve any new
194 /// locations that match the breakpoint's specifications.
196 /// \param[in] changed_modules
197 /// The list of modules to look in for new locations.
199 /// \param[in] new_locations
200 /// Fills new_locations with the new locations that were made.
201 void ResolveBreakpointInModules(ModuleList &module_list,
202 BreakpointLocationCollection &new_locations);
204 /// Like ResolveBreakpointInModules, but allows for "unload" events, in
205 /// which case we will remove any locations that are in modules that got
208 /// \param[in] changedModules
209 /// The list of modules to look in for new locations.
210 /// \param[in] load_event
211 /// If \b true then the modules were loaded, if \b false, unloaded.
212 /// \param[in] delete_locations
213 /// If \b true then the modules were unloaded delete any locations in the
215 void ModulesChanged(ModuleList &changed_modules, bool load_event,
216 bool delete_locations = false);
218 /// Tells the breakpoint the old module \a old_module_sp has been replaced
219 /// by new_module_sp (usually because the underlying file has been rebuilt,
220 /// and the old version is gone.)
222 /// \param[in] old_module_sp
223 /// The old module that is going away.
224 /// \param[in] new_module_sp
225 /// The new module that is replacing it.
226 void ModuleReplaced(lldb::ModuleSP old_module_sp,
227 lldb::ModuleSP new_module_sp);
229 // The next set of methods provide access to the breakpoint locations for
232 /// Add a location to the breakpoint's location list. This is only meant to
233 /// be called by the breakpoint's resolver. FIXME: how do I ensure that?
236 /// The Address specifying the new location.
237 /// \param[out] new_location
238 /// Set to \b true if a new location was created, to \b false if there
239 /// already was a location at this Address.
241 /// Returns a pointer to the new location.
242 lldb::BreakpointLocationSP AddLocation(const Address &addr,
243 bool *new_location = nullptr);
245 /// Find a breakpoint location by Address.
248 /// The Address specifying the location.
250 /// Returns a shared pointer to the location at \a addr. The pointer
251 /// in the shared pointer will be nullptr if there is no location at that
253 lldb::BreakpointLocationSP FindLocationByAddress(const Address &addr);
255 /// Find a breakpoint location ID by Address.
258 /// The Address specifying the location.
260 /// Returns the UID of the location at \a addr, or \b LLDB_INVALID_ID if
261 /// there is no breakpoint location at that address.
262 lldb::break_id_t FindLocationIDByAddress(const Address &addr);
264 /// Find a breakpoint location for a given breakpoint location ID.
266 /// \param[in] bp_loc_id
267 /// The ID specifying the location.
269 /// Returns a shared pointer to the location with ID \a bp_loc_id. The
271 /// in the shared pointer will be nullptr if there is no location with that
273 lldb::BreakpointLocationSP FindLocationByID(lldb::break_id_t bp_loc_id);
275 /// Get breakpoint locations by index.
278 /// The location index.
281 /// Returns a shared pointer to the location with index \a
282 /// index. The shared pointer might contain nullptr if \a index is
283 /// greater than then number of actual locations.
284 lldb::BreakpointLocationSP GetLocationAtIndex(size_t index);
286 /// Removes all invalid breakpoint locations.
288 /// Removes all breakpoint locations with architectures that aren't
289 /// compatible with \a arch. Also remove any breakpoint locations with whose
290 /// locations have address where the section has been deleted (module and
291 /// object files no longer exist).
293 /// This is typically used after the process calls exec, or anytime the
294 /// architecture of the target changes.
297 /// If valid, check the module in each breakpoint to make sure
298 /// they are compatible, otherwise, ignore architecture.
299 void RemoveInvalidLocations(const ArchSpec &arch);
301 // The next section deals with various breakpoint options.
303 /// If \a enable is \b true, enable the breakpoint, if \b false disable it.
304 void SetEnabled(bool enable) override;
306 /// Check the Enable/Disable state.
308 /// \b true if the breakpoint is enabled, \b false if disabled.
309 bool IsEnabled() override;
311 /// Set the breakpoint to ignore the next \a count breakpoint hits.
313 /// The number of breakpoint hits to ignore.
314 void SetIgnoreCount(uint32_t count);
316 /// Return the current ignore count/
318 /// The number of breakpoint hits to be ignored.
319 uint32_t GetIgnoreCount() const;
321 /// Return the current hit count for all locations. \return
322 /// The current hit count for all locations.
323 uint32_t GetHitCount() const;
325 /// If \a one_shot is \b true, breakpoint will be deleted on first hit.
326 void SetOneShot(bool one_shot);
328 /// Check the OneShot state.
330 /// \b true if the breakpoint is one shot, \b false otherwise.
331 bool IsOneShot() const;
333 /// If \a auto_continue is \b true, breakpoint will auto-continue when on
335 void SetAutoContinue(bool auto_continue);
337 /// Check the AutoContinue state.
339 /// \b true if the breakpoint is set to auto-continue, \b false otherwise.
340 bool IsAutoContinue() const;
342 /// Set the valid thread to be checked when the breakpoint is hit.
343 /// \param[in] thread_id
344 /// If this thread hits the breakpoint, we stop, otherwise not.
345 void SetThreadID(lldb::tid_t thread_id);
347 /// Return the current stop thread value.
349 /// The thread id for which the breakpoint hit will stop,
350 /// LLDB_INVALID_THREAD_ID for all threads.
351 lldb::tid_t GetThreadID() const;
353 void SetThreadIndex(uint32_t index);
355 uint32_t GetThreadIndex() const;
357 void SetThreadName(const char *thread_name);
359 const char *GetThreadName() const;
361 void SetQueueName(const char *queue_name);
363 const char *GetQueueName() const;
365 /// Set the callback action invoked when the breakpoint is hit.
367 /// \param[in] callback
368 /// The method that will get called when the breakpoint is hit.
370 /// A void * pointer that will get passed back to the callback function.
371 /// \param[in] is_synchronous
372 /// If \b true the callback will be run on the private event thread
373 /// before the stop event gets reported. If false, the callback will get
374 /// handled on the public event thread after the stop has been posted.
377 /// \b true if the process should stop when you hit the breakpoint.
378 /// \b false if it should continue.
379 void SetCallback(BreakpointHitCallback callback, void *baton,
380 bool is_synchronous = false);
382 void SetCallback(BreakpointHitCallback callback,
383 const lldb::BatonSP &callback_baton_sp,
384 bool is_synchronous = false);
386 void ClearCallback();
388 /// Set the breakpoint's condition.
390 /// \param[in] condition
391 /// The condition expression to evaluate when the breakpoint is hit.
392 /// Pass in nullptr to clear the condition.
393 void SetCondition(const char *condition);
395 /// Return a pointer to the text of the condition expression.
398 /// A pointer to the condition expression text, or nullptr if no
399 // condition has been set.
400 const char *GetConditionText() const;
402 // The next section are various utility functions.
404 /// Return the number of breakpoint locations that have resolved to actual
405 /// breakpoint sites.
408 /// The number locations resolved breakpoint sites.
409 size_t GetNumResolvedLocations() const;
411 /// Return whether this breakpoint has any resolved locations.
414 /// True if GetNumResolvedLocations > 0
415 bool HasResolvedLocations() const;
417 /// Return the number of breakpoint locations.
420 /// The number breakpoint locations.
421 size_t GetNumLocations() const;
423 /// Put a description of this breakpoint into the stream \a s.
426 /// Stream into which to dump the description.
429 /// The description level that indicates the detail level to
432 /// \see lldb::DescriptionLevel
433 void GetDescription(Stream *s, lldb::DescriptionLevel level,
434 bool show_locations = false);
436 /// Set the "kind" description for a breakpoint. If the breakpoint is hit
437 /// the stop info will show this "kind" description instead of the
438 /// breakpoint number. Mostly useful for internal breakpoints, where the
439 /// breakpoint number doesn't have meaning to the user.
442 /// New "kind" description.
443 void SetBreakpointKind(const char *kind) { m_kind_description.assign(kind); }
445 /// Return the "kind" description for a breakpoint.
448 /// The breakpoint kind, or nullptr if none is set.
449 const char *GetBreakpointKind() const { return m_kind_description.c_str(); }
451 /// Accessor for the breakpoint Target.
453 /// This breakpoint's Target.
454 Target &GetTarget() { return m_target; }
456 const Target &GetTarget() const { return m_target; }
458 const lldb::TargetSP GetTargetSP();
460 void GetResolverDescription(Stream *s);
462 /// Find breakpoint locations which match the (filename, line_number)
463 /// description. The breakpoint location collection is to be filled with the
464 /// matching locations. It should be initialized with 0 size by the API
468 /// True if there is a match
470 /// The locations which match the filename and line_number in loc_coll.
472 /// size is 0 and true is returned, it means the breakpoint fully matches
475 bool GetMatchingFileLine(ConstString filename, uint32_t line_number,
476 BreakpointLocationCollection &loc_coll);
478 void GetFilterDescription(Stream *s);
480 /// Returns the BreakpointOptions structure set at the breakpoint level.
482 /// Meant to be used by the BreakpointLocation class.
485 /// A pointer to this breakpoint's BreakpointOptions.
486 BreakpointOptions *GetOptions();
488 /// Returns the BreakpointOptions structure set at the breakpoint level.
490 /// Meant to be used by the BreakpointLocation class.
493 /// A pointer to this breakpoint's BreakpointOptions.
494 const BreakpointOptions *GetOptions() const;
496 /// Invoke the callback action when the breakpoint is hit.
498 /// Meant to be used by the BreakpointLocation class.
500 /// \param[in] context
501 /// Described the breakpoint event.
503 /// \param[in] bp_loc_id
504 /// Which breakpoint location hit this breakpoint.
507 /// \b true if the target should stop at this breakpoint and \b false not.
508 bool InvokeCallback(StoppointCallbackContext *context,
509 lldb::break_id_t bp_loc_id);
511 bool IsHardware() const { return m_hardware; }
513 lldb::BreakpointResolverSP GetResolver() { return m_resolver_sp; }
515 lldb::SearchFilterSP GetSearchFilter() { return m_filter_sp; }
517 private: // The target needs to manage adding & removing names. It will do the
518 // checking for name validity as well.
519 bool AddName(llvm::StringRef new_name);
521 void RemoveName(const char *name_to_remove) {
523 m_name_list.erase(name_to_remove);
527 bool MatchesName(const char *name) {
528 return m_name_list.find(name) != m_name_list.end();
531 void GetNames(std::vector<std::string> &names) {
533 for (auto name : m_name_list) {
534 names.push_back(name);
538 /// Set a pre-condition filter that overrides all user provided
539 /// filters/callbacks etc.
541 /// Used to define fancy breakpoints that can do dynamic hit detection
542 /// without taking up the condition slot - which really belongs to the user
545 /// The Precondition should not continue the target, it should return true
546 /// if the condition says to stop and false otherwise.
548 void SetPrecondition(lldb::BreakpointPreconditionSP precondition_sp) {
549 m_precondition_sp = precondition_sp;
552 bool EvaluatePrecondition(StoppointCallbackContext &context);
554 lldb::BreakpointPreconditionSP GetPrecondition() { return m_precondition_sp; }
556 // Produces the OR'ed values for all the names assigned to this breakpoint.
557 const BreakpointName::Permissions &GetPermissions() const {
558 return m_permissions;
561 BreakpointName::Permissions &GetPermissions() {
562 return m_permissions;
565 bool AllowList() const {
566 return GetPermissions().GetAllowList();
568 bool AllowDisable() const {
569 return GetPermissions().GetAllowDisable();
571 bool AllowDelete() const {
572 return GetPermissions().GetAllowDelete();
579 /// Constructors and Destructors
580 /// Only the Target can make a breakpoint, and it owns the breakpoint
581 /// lifespans. The constructor takes a filter and a resolver. Up in Target
582 /// there are convenience variants that make breakpoints for some common
585 /// \param[in] target
586 /// The target in which the breakpoint will be set.
588 /// \param[in] filter_sp
589 /// Shared pointer to the search filter that restricts the search domain of
592 /// \param[in] resolver_sp
593 /// Shared pointer to the resolver object that will determine breakpoint
597 /// If true, request a hardware breakpoint to be used to implement the
598 /// breakpoint locations.
600 /// \param resolve_indirect_symbols
601 /// If true, and the address of a given breakpoint location in this
602 /// breakpoint is set on an
603 /// indirect symbol (i.e. Symbol::IsIndirect returns true) then the actual
604 /// breakpoint site will
605 /// be set on the target of the indirect symbol.
606 // This is the generic constructor
607 Breakpoint(Target &target, lldb::SearchFilterSP &filter_sp,
608 lldb::BreakpointResolverSP &resolver_sp, bool hardware,
609 bool resolve_indirect_symbols = true);
611 friend class BreakpointLocation; // To call the following two when determining
614 void DecrementIgnoreCount();
616 // BreakpointLocation::IgnoreCountShouldStop &
617 // Breakpoint::IgnoreCountShouldStop can only be called once per stop, and
618 // BreakpointLocation::IgnoreCountShouldStop should be tested first, and if
619 // it returns false we should continue, otherwise we should test
620 // Breakpoint::IgnoreCountShouldStop.
622 bool IgnoreCountShouldStop();
624 void IncrementHitCount() { m_hit_count++; }
626 void DecrementHitCount() {
627 assert(m_hit_count > 0);
632 // This one should only be used by Target to copy breakpoints from target to
633 // target - primarily from the dummy target to prime new targets.
634 Breakpoint(Target &new_target, Breakpoint &bp_to_copy_from);
636 // For Breakpoint only
637 bool m_being_created;
639 m_hardware; // If this breakpoint is required to use a hardware breakpoint
640 Target &m_target; // The target that holds this breakpoint.
641 std::unordered_set<std::string> m_name_list; // If not empty, this is the name
642 // of this breakpoint (many
643 // breakpoints can share the same
646 m_filter_sp; // The filter that constrains the breakpoint's domain.
647 lldb::BreakpointResolverSP
648 m_resolver_sp; // The resolver that defines this breakpoint.
649 lldb::BreakpointPreconditionSP m_precondition_sp; // The precondition is a
650 // breakpoint-level hit
651 // filter that can be used
652 // to skip certain breakpoint hits. For instance, exception breakpoints use
653 // this to limit the stop to certain exception classes, while leaving the
654 // condition & callback free for user specification.
655 std::unique_ptr<BreakpointOptions>
656 m_options_up; // Settable breakpoint options
657 BreakpointLocationList
658 m_locations; // The list of locations currently found for this breakpoint.
659 std::string m_kind_description;
660 bool m_resolve_indirect_symbols;
661 uint32_t m_hit_count; // Number of times this breakpoint/watchpoint has been
663 // separately from the locations hit counts, since locations can go away when
664 // their backing library gets unloaded, and we would lose hit counts.
665 BreakpointName::Permissions m_permissions;
667 void SendBreakpointChangedEvent(lldb::BreakpointEventType eventKind);
669 void SendBreakpointChangedEvent(BreakpointEventData *data);
671 DISALLOW_COPY_AND_ASSIGN(Breakpoint);
674 } // namespace lldb_private
676 #endif // liblldb_Breakpoint_h_