LLDB  mainline
Breakpoint.h
Go to the documentation of this file.
1 //===-- Breakpoint.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_BREAKPOINT_H
10 #define LLDB_BREAKPOINT_BREAKPOINT_H
11 
12 #include <memory>
13 #include <string>
14 #include <unordered_set>
15 #include <vector>
16 
24 #include "lldb/Core/SearchFilter.h"
25 #include "lldb/Target/Statistics.h"
26 #include "lldb/Utility/Event.h"
29 
30 namespace lldb_private {
31 
32 /// \class Breakpoint Breakpoint.h "lldb/Breakpoint/Breakpoint.h" Class that
33 /// manages logical breakpoint setting.
34 
35 /// General Outline:
36 /// A breakpoint has four main parts, a filter, a resolver, the list of
37 /// breakpoint
38 /// locations that have been determined for the filter/resolver pair, and
39 /// finally a set of options for the breakpoint.
40 ///
41 /// \b Filter:
42 /// This is an object derived from SearchFilter. It manages the search for
43 /// breakpoint location matches through the symbols in the module list of the
44 /// target that owns it. It also filters out locations based on whatever
45 /// logic it wants.
46 ///
47 /// \b Resolver:
48 /// This is an object derived from BreakpointResolver. It provides a callback
49 /// to the filter that will find breakpoint locations. How it does this is
50 /// determined by what kind of resolver it is.
51 ///
52 /// The Breakpoint class also provides constructors for the common breakpoint
53 /// cases which make the appropriate filter and resolver for you.
54 ///
55 /// \b Location List:
56 /// This stores the breakpoint locations that have been determined to date.
57 /// For a given breakpoint, there will be only one location with a given
58 /// address. Adding a location at an already taken address will just return
59 /// the location already at that address. Locations can be looked up by ID,
60 /// or by address.
61 ///
62 /// \b Options:
63 /// This includes:
64 /// \b Enabled/Disabled
65 /// \b Ignore Count
66 /// \b Callback
67 /// \b Condition
68 /// Note, these options can be set on the breakpoint, and they can also be set
69 /// on the individual locations. The options set on the breakpoint take
70 /// precedence over the options set on the individual location. So for
71 /// instance disabling the breakpoint will cause NONE of the locations to get
72 /// hit. But if the breakpoint is enabled, then the location's enabled state
73 /// will be checked to determine whether to insert that breakpoint location.
74 /// Similarly, if the breakpoint condition says "stop", we won't check the
75 /// location's condition. But if the breakpoint condition says "continue",
76 /// then we will check the location for whether to actually stop or not. One
77 /// subtle point worth observing here is that you don't actually stop at a
78 /// Breakpoint, you always stop at one of its locations. So the "should stop"
79 /// tests are done by the location, not by the breakpoint.
80 class Breakpoint : public std::enable_shared_from_this<Breakpoint>,
81  public Stoppoint {
82 public:
84 
85  /// An enum specifying the match style for breakpoint settings. At present
86  /// only used for function name style breakpoints.
87  enum MatchType { Exact, Regexp, Glob };
88 
89 private:
91 
92  static const char
94 
95  static const char *GetKey(OptionNames enum_value) {
96  return g_option_names[static_cast<uint32_t>(enum_value)];
97  }
98 
99 public:
101  public:
102  BreakpointEventData(lldb::BreakpointEventType sub_type,
103  const lldb::BreakpointSP &new_breakpoint_sp);
104 
105  ~BreakpointEventData() override;
106 
107  static ConstString GetFlavorString();
108 
109  ConstString GetFlavor() const override;
110 
111  lldb::BreakpointEventType GetBreakpointEventType() const;
112 
113  lldb::BreakpointSP &GetBreakpoint();
114 
116  return m_locations;
117  }
118 
119  void Dump(Stream *s) const override;
120 
121  static lldb::BreakpointEventType
122  GetBreakpointEventTypeFromEvent(const lldb::EventSP &event_sp);
123 
124  static lldb::BreakpointSP
125  GetBreakpointFromEvent(const lldb::EventSP &event_sp);
126 
127  static lldb::BreakpointLocationSP
128  GetBreakpointLocationAtIndexFromEvent(const lldb::EventSP &event_sp,
129  uint32_t loc_idx);
130 
131  static size_t
132  GetNumBreakpointLocationsFromEvent(const lldb::EventSP &event_sp);
133 
134  static const BreakpointEventData *
135  GetEventDataFromEvent(const Event *event_sp);
136 
137  private:
138  lldb::BreakpointEventType m_breakpoint_event;
139  lldb::BreakpointSP m_new_breakpoint_sp;
141 
142  BreakpointEventData(const BreakpointEventData &) = delete;
143  const BreakpointEventData &operator=(const BreakpointEventData &) = delete;
144  };
145 
146  // Saving & restoring breakpoints:
147  static lldb::BreakpointSP CreateFromStructuredData(
148  lldb::TargetSP target_sp, StructuredData::ObjectSP &data_object_sp,
149  Status &error);
150 
151  static bool
153  std::vector<std::string> &names);
154 
156 
157  static const char *GetSerializationKey() { return "Breakpoint"; }
158  /// Destructor.
159  ///
160  /// The destructor is not virtual since there should be no reason to
161  /// subclass breakpoints. The varieties of breakpoints are specified
162  /// instead by providing different resolvers & filters.
163  ~Breakpoint() override;
164 
165  // Methods
166 
167  /// Tell whether this breakpoint is an "internal" breakpoint. \return
168  /// Returns \b true if this is an internal breakpoint, \b false otherwise.
169  bool IsInternal() const;
170 
171  /// Standard "Dump" method. At present it does nothing.
172  void Dump(Stream *s) override;
173 
174  // The next set of methods provide ways to tell the breakpoint to update it's
175  // location list - usually done when modules appear or disappear.
176 
177  /// Tell this breakpoint to clear all its breakpoint sites. Done when the
178  /// process holding the breakpoint sites is destroyed.
180 
181  /// Tell this breakpoint to scan it's target's module list and resolve any
182  /// new locations that match the breakpoint's specifications.
183  void ResolveBreakpoint();
184 
185  /// Tell this breakpoint to scan a given module list and resolve any new
186  /// locations that match the breakpoint's specifications.
187  ///
188  /// \param[in] module_list
189  /// The list of modules to look in for new locations.
190  ///
191  /// \param[in] send_event
192  /// If \b true, send a breakpoint location added event for non-internal
193  /// breakpoints.
194  void ResolveBreakpointInModules(ModuleList &module_list,
195  bool send_event = true);
196 
197  /// Tell this breakpoint to scan a given module list and resolve any new
198  /// locations that match the breakpoint's specifications.
199  ///
200  /// \param[in] module_list
201  /// The list of modules to look in for new locations.
202  ///
203  /// \param[in] new_locations
204  /// Fills new_locations with the new locations that were made.
205  void ResolveBreakpointInModules(ModuleList &module_list,
206  BreakpointLocationCollection &new_locations);
207 
208  /// Like ResolveBreakpointInModules, but allows for "unload" events, in
209  /// which case we will remove any locations that are in modules that got
210  /// unloaded.
211  ///
212  /// \param[in] changed_modules
213  /// The list of modules to look in for new locations.
214  /// \param[in] load_event
215  /// If \b true then the modules were loaded, if \b false, unloaded.
216  /// \param[in] delete_locations
217  /// If \b true then the modules were unloaded delete any locations in the
218  /// changed modules.
219  void ModulesChanged(ModuleList &changed_modules, bool load_event,
220  bool delete_locations = false);
221 
222  /// Tells the breakpoint the old module \a old_module_sp has been replaced
223  /// by new_module_sp (usually because the underlying file has been rebuilt,
224  /// and the old version is gone.)
225  ///
226  /// \param[in] old_module_sp
227  /// The old module that is going away.
228  /// \param[in] new_module_sp
229  /// The new module that is replacing it.
230  void ModuleReplaced(lldb::ModuleSP old_module_sp,
231  lldb::ModuleSP new_module_sp);
232 
233  // The next set of methods provide access to the breakpoint locations for
234  // this breakpoint.
235 
236  /// Add a location to the breakpoint's location list. This is only meant to
237  /// be called by the breakpoint's resolver. FIXME: how do I ensure that?
238  ///
239  /// \param[in] addr
240  /// The Address specifying the new location.
241  /// \param[out] new_location
242  /// Set to \b true if a new location was created, to \b false if there
243  /// already was a location at this Address.
244  /// \return
245  /// Returns a pointer to the new location.
246  lldb::BreakpointLocationSP AddLocation(const Address &addr,
247  bool *new_location = nullptr);
248 
249  /// Find a breakpoint location by Address.
250  ///
251  /// \param[in] addr
252  /// The Address specifying the location.
253  /// \return
254  /// Returns a shared pointer to the location at \a addr. The pointer
255  /// in the shared pointer will be nullptr if there is no location at that
256  /// address.
257  lldb::BreakpointLocationSP FindLocationByAddress(const Address &addr);
258 
259  /// Find a breakpoint location ID by Address.
260  ///
261  /// \param[in] addr
262  /// The Address specifying the location.
263  /// \return
264  /// Returns the UID of the location at \a addr, or \b LLDB_INVALID_ID if
265  /// there is no breakpoint location at that address.
267 
268  /// Find a breakpoint location for a given breakpoint location ID.
269  ///
270  /// \param[in] bp_loc_id
271  /// The ID specifying the location.
272  /// \return
273  /// Returns a shared pointer to the location with ID \a bp_loc_id. The
274  /// pointer
275  /// in the shared pointer will be nullptr if there is no location with that
276  /// ID.
277  lldb::BreakpointLocationSP FindLocationByID(lldb::break_id_t bp_loc_id);
278 
279  /// Get breakpoint locations by index.
280  ///
281  /// \param[in] index
282  /// The location index.
283  ///
284  /// \return
285  /// Returns a shared pointer to the location with index \a
286  /// index. The shared pointer might contain nullptr if \a index is
287  /// greater than then number of actual locations.
288  lldb::BreakpointLocationSP GetLocationAtIndex(size_t index);
289 
290  /// Removes all invalid breakpoint locations.
291  ///
292  /// Removes all breakpoint locations with architectures that aren't
293  /// compatible with \a arch. Also remove any breakpoint locations with whose
294  /// locations have address where the section has been deleted (module and
295  /// object files no longer exist).
296  ///
297  /// This is typically used after the process calls exec, or anytime the
298  /// architecture of the target changes.
299  ///
300  /// \param[in] arch
301  /// If valid, check the module in each breakpoint to make sure
302  /// they are compatible, otherwise, ignore architecture.
303  void RemoveInvalidLocations(const ArchSpec &arch);
304 
305  // The next section deals with various breakpoint options.
306 
307  /// If \a enable is \b true, enable the breakpoint, if \b false disable it.
308  void SetEnabled(bool enable) override;
309 
310  /// Check the Enable/Disable state.
311  /// \return
312  /// \b true if the breakpoint is enabled, \b false if disabled.
313  bool IsEnabled() override;
314 
315  /// Set the breakpoint to ignore the next \a count breakpoint hits.
316  /// \param[in] count
317  /// The number of breakpoint hits to ignore.
318  void SetIgnoreCount(uint32_t count);
319 
320  /// Return the current ignore count/
321  /// \return
322  /// The number of breakpoint hits to be ignored.
323  uint32_t GetIgnoreCount() const;
324 
325  /// Return the current hit count for all locations. \return
326  /// The current hit count for all locations.
327  uint32_t GetHitCount() const;
328 
329  /// If \a one_shot is \b true, breakpoint will be deleted on first hit.
330  void SetOneShot(bool one_shot);
331 
332  /// Check the OneShot state.
333  /// \return
334  /// \b true if the breakpoint is one shot, \b false otherwise.
335  bool IsOneShot() const;
336 
337  /// If \a auto_continue is \b true, breakpoint will auto-continue when on
338  /// hit.
339  void SetAutoContinue(bool auto_continue);
340 
341  /// Check the AutoContinue state.
342  /// \return
343  /// \b true if the breakpoint is set to auto-continue, \b false otherwise.
344  bool IsAutoContinue() const;
345 
346  /// Set the valid thread to be checked when the breakpoint is hit.
347  /// \param[in] thread_id
348  /// If this thread hits the breakpoint, we stop, otherwise not.
349  void SetThreadID(lldb::tid_t thread_id);
350 
351  /// Return the current stop thread value.
352  /// \return
353  /// The thread id for which the breakpoint hit will stop,
354  /// LLDB_INVALID_THREAD_ID for all threads.
355  lldb::tid_t GetThreadID() const;
356 
357  void SetThreadIndex(uint32_t index);
358 
359  uint32_t GetThreadIndex() const;
360 
361  void SetThreadName(const char *thread_name);
362 
363  const char *GetThreadName() const;
364 
365  void SetQueueName(const char *queue_name);
366 
367  const char *GetQueueName() const;
368 
369  /// Set the callback action invoked when the breakpoint is hit.
370  ///
371  /// \param[in] callback
372  /// The method that will get called when the breakpoint is hit.
373  /// \param[in] baton
374  /// A void * pointer that will get passed back to the callback function.
375  /// \param[in] is_synchronous
376  /// If \b true the callback will be run on the private event thread
377  /// before the stop event gets reported. If false, the callback will get
378  /// handled on the public event thread after the stop has been posted.
379  void SetCallback(BreakpointHitCallback callback, void *baton,
380  bool is_synchronous = false);
381 
382  void SetCallback(BreakpointHitCallback callback,
383  const lldb::BatonSP &callback_baton_sp,
384  bool is_synchronous = false);
385 
386  void ClearCallback();
387 
388  /// Set the breakpoint's condition.
389  ///
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);
394 
395  /// Return a pointer to the text of the condition expression.
396  ///
397  /// \return
398  /// A pointer to the condition expression text, or nullptr if no
399  // condition has been set.
400  const char *GetConditionText() const;
401 
402  // The next section are various utility functions.
403 
404  /// Return the number of breakpoint locations that have resolved to actual
405  /// breakpoint sites.
406  ///
407  /// \return
408  /// The number locations resolved breakpoint sites.
409  size_t GetNumResolvedLocations() const;
410 
411  /// Return whether this breakpoint has any resolved locations.
412  ///
413  /// \return
414  /// True if GetNumResolvedLocations > 0
415  bool HasResolvedLocations() const;
416 
417  /// Return the number of breakpoint locations.
418  ///
419  /// \return
420  /// The number breakpoint locations.
421  size_t GetNumLocations() const;
422 
423  /// Put a description of this breakpoint into the stream \a s.
424  ///
425  /// \param[in] s
426  /// Stream into which to dump the description.
427  ///
428  /// \param[in] level
429  /// The description level that indicates the detail level to
430  /// provide.
431  ///
432  /// \see lldb::DescriptionLevel
434  bool show_locations = false);
435 
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.
440  ///
441  /// \param[in] kind
442  /// New "kind" description.
443  void SetBreakpointKind(const char *kind) { m_kind_description.assign(kind); }
444 
445  /// Return the "kind" description for a breakpoint.
446  ///
447  /// \return
448  /// The breakpoint kind, or nullptr if none is set.
449  const char *GetBreakpointKind() const { return m_kind_description.c_str(); }
450 
451  /// Accessor for the breakpoint Target.
452  /// \return
453  /// This breakpoint's Target.
454  Target &GetTarget() { return m_target; }
455 
456  const Target &GetTarget() const { return m_target; }
457 
458  const lldb::TargetSP GetTargetSP();
459 
461 
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
465  /// client.
466  ///
467  /// \return
468  /// True if there is a match
469  ///
470  /// The locations which match the filename and line_number in loc_coll.
471  /// If its
472  /// size is 0 and true is returned, it means the breakpoint fully matches
473  /// the
474  /// description.
475  bool GetMatchingFileLine(ConstString filename, uint32_t line_number,
476  BreakpointLocationCollection &loc_coll);
477 
478  void GetFilterDescription(Stream *s);
479 
480  /// Returns the BreakpointOptions structure set at the breakpoint level.
481  ///
482  /// Meant to be used by the BreakpointLocation class.
483  ///
484  /// \return
485  /// A reference to this breakpoint's BreakpointOptions.
487 
488  /// Returns the BreakpointOptions structure set at the breakpoint level.
489  ///
490  /// Meant to be used by the BreakpointLocation class.
491  ///
492  /// \return
493  /// A reference to this breakpoint's BreakpointOptions.
494  const BreakpointOptions &GetOptions() const;
495 
496  /// Invoke the callback action when the breakpoint is hit.
497  ///
498  /// Meant to be used by the BreakpointLocation class.
499  ///
500  /// \param[in] context
501  /// Described the breakpoint event.
502  ///
503  /// \param[in] bp_loc_id
504  /// Which breakpoint location hit this breakpoint.
505  ///
506  /// \return
507  /// \b true if the target should stop at this breakpoint and \b false not.
509  lldb::break_id_t bp_loc_id);
510 
511  bool IsHardware() const { return m_hardware; }
512 
513  lldb::BreakpointResolverSP GetResolver() { return m_resolver_sp; }
514 
515  lldb::SearchFilterSP GetSearchFilter() { return m_filter_sp; }
516 
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);
520 
521  void RemoveName(const char *name_to_remove) {
522  if (name_to_remove)
523  m_name_list.erase(name_to_remove);
524  }
525 
526 public:
527  bool MatchesName(const char *name) {
528  return m_name_list.find(name) != m_name_list.end();
529  }
530 
531  void GetNames(std::vector<std::string> &names) {
532  names.clear();
533  for (auto name : m_name_list) {
534  names.push_back(name);
535  }
536  }
537 
538  /// Set a pre-condition filter that overrides all user provided
539  /// filters/callbacks etc.
540  ///
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
543  /// anyway...
544  ///
545  /// The Precondition should not continue the target, it should return true
546  /// if the condition says to stop and false otherwise.
547  ///
548  void SetPrecondition(lldb::BreakpointPreconditionSP precondition_sp) {
549  m_precondition_sp = std::move(precondition_sp);
550  }
551 
553 
554  lldb::BreakpointPreconditionSP GetPrecondition() { return m_precondition_sp; }
555 
556  // Produces the OR'ed values for all the names assigned to this breakpoint.
558  return m_permissions;
559  }
560 
562  return m_permissions;
563  }
564 
565  bool AllowList() const {
566  return GetPermissions().GetAllowList();
567  }
568  bool AllowDisable() const {
569  return GetPermissions().GetAllowDisable();
570  }
571  bool AllowDelete() const {
572  return GetPermissions().GetAllowDelete();
573  }
574 
575  // This one should only be used by Target to copy breakpoints from target to
576  // target - primarily from the dummy target to prime new targets.
577  static lldb::BreakpointSP CopyFromBreakpoint(lldb::TargetSP new_target,
578  const Breakpoint &bp_to_copy_from);
579 
580  /// Get statistics associated with this breakpoint in JSON format.
581  llvm::json::Value GetStatistics();
582 
583  /// Get the time it took to resolve all locations in this breakpoint.
585 
586 protected:
587  friend class Target;
588  // Protected Methods
589 
590  /// Constructors and Destructors
591  /// Only the Target can make a breakpoint, and it owns the breakpoint
592  /// lifespans. The constructor takes a filter and a resolver. Up in Target
593  /// there are convenience variants that make breakpoints for some common
594  /// cases.
595  ///
596  /// \param[in] target
597  /// The target in which the breakpoint will be set.
598  ///
599  /// \param[in] filter_sp
600  /// Shared pointer to the search filter that restricts the search domain of
601  /// the breakpoint.
602  ///
603  /// \param[in] resolver_sp
604  /// Shared pointer to the resolver object that will determine breakpoint
605  /// matches.
606  ///
607  /// \param hardware
608  /// If true, request a hardware breakpoint to be used to implement the
609  /// breakpoint locations.
610  ///
611  /// \param resolve_indirect_symbols
612  /// If true, and the address of a given breakpoint location in this
613  /// breakpoint is set on an
614  /// indirect symbol (i.e. Symbol::IsIndirect returns true) then the actual
615  /// breakpoint site will
616  /// be set on the target of the indirect symbol.
617  // This is the generic constructor
618  Breakpoint(Target &target, lldb::SearchFilterSP &filter_sp,
619  lldb::BreakpointResolverSP &resolver_sp, bool hardware,
620  bool resolve_indirect_symbols = true);
621 
622  friend class BreakpointLocation; // To call the following two when determining
623  // whether to stop.
624 
625  void DecrementIgnoreCount();
626 
627 private:
628  // To call from CopyFromBreakpoint.
629  Breakpoint(Target &new_target, const Breakpoint &bp_to_copy_from);
630 
631  // For Breakpoint only
633  bool
634  m_hardware; // If this breakpoint is required to use a hardware breakpoint
635  Target &m_target; // The target that holds this breakpoint.
636  std::unordered_set<std::string> m_name_list; // If not empty, this is the name
637  // of this breakpoint (many
638  // breakpoints can share the same
639  // name.)
640  lldb::SearchFilterSP
641  m_filter_sp; // The filter that constrains the breakpoint's domain.
642  lldb::BreakpointResolverSP
643  m_resolver_sp; // The resolver that defines this breakpoint.
644  lldb::BreakpointPreconditionSP m_precondition_sp; // The precondition is a
645  // breakpoint-level hit
646  // filter that can be used
647  // to skip certain breakpoint hits. For instance, exception breakpoints use
648  // this to limit the stop to certain exception classes, while leaving the
649  // condition & callback free for user specification.
650  BreakpointOptions m_options; // Settable breakpoint options
652  m_locations; // The list of locations currently found for this breakpoint.
655 
656  /// Number of times this breakpoint has been hit. This is kept separately
657  /// from the locations hit counts, since locations can go away when their
658  /// backing library gets unloaded, and we would lose hit counts.
660 
662 
664 
665  void SendBreakpointChangedEvent(lldb::BreakpointEventType eventKind);
666 
667  void SendBreakpointChangedEvent(BreakpointEventData *data);
668 
669  Breakpoint(const Breakpoint &) = delete;
670  const Breakpoint &operator=(const Breakpoint &) = delete;
671 };
672 
673 } // namespace lldb_private
674 
675 #endif // LLDB_BREAKPOINT_BREAKPOINT_H
lldb_private::Breakpoint::GetOptions
BreakpointOptions & GetOptions()
Returns the BreakpointOptions structure set at the breakpoint level.
Definition: Breakpoint.cpp:437
lldb_private::Breakpoint::GetEventIdentifier
static ConstString GetEventIdentifier()
Definition: Breakpoint.cpp:39
lldb_private::Breakpoint::m_precondition_sp
lldb::BreakpointPreconditionSP m_precondition_sp
Definition: Breakpoint.h:644
lldb_private::Breakpoint::HasResolvedLocations
bool HasResolvedLocations() const
Return whether this breakpoint has any resolved locations.
Definition: Breakpoint.cpp:837
lldb_private::Breakpoint::BreakpointEventData::GetBreakpoint
lldb::BreakpointSP & GetBreakpoint()
Definition: Breakpoint.cpp:1028
lldb_private::Breakpoint::m_kind_description
std::string m_kind_description
Definition: Breakpoint.h:653
lldb_private::Breakpoint::GetStatistics
llvm::json::Value GetStatistics()
Get statistics associated with this breakpoint in JSON format.
Definition: Breakpoint.cpp:1094
lldb_private::Breakpoint::ClearAllBreakpointSites
void ClearAllBreakpointSites()
Tell this breakpoint to clear all its breakpoint sites.
Definition: Breakpoint.cpp:482
lldb_private::Breakpoint::GetPermissions
BreakpointName::Permissions & GetPermissions()
Definition: Breakpoint.h:561
lldb_private::Breakpoint::GetConditionText
const char * GetConditionText() const
Return a pointer to the text of the condition expression.
Definition: Breakpoint.cpp:407
BreakpointName.h
lldb_private::Breakpoint::SendBreakpointChangedEvent
void SendBreakpointChangedEvent(lldb::BreakpointEventType eventKind)
Definition: Breakpoint.cpp:989
lldb_private::ArchSpec
Definition: ArchSpec.h:33
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::Breakpoint::GetMatchingFileLine
bool GetMatchingFileLine(ConstString filename, uint32_t line_number, BreakpointLocationCollection &loc_coll)
Find breakpoint locations which match the (filename, line_number) description.
Definition: Breakpoint.cpp:955
lldb_private::Breakpoint::SetOneShot
void SetOneShot(bool one_shot)
If one_shot is true, breakpoint will be deleted on first hit.
Definition: Breakpoint.cpp:332
lldb_private::Event
Definition: Event.h:180
lldb_private::Breakpoint::m_target
Target & m_target
Definition: Breakpoint.h:635
lldb_private::Breakpoint::~Breakpoint
~Breakpoint() override
Destructor.
lldb_private::Breakpoint::GetKey
static const char * GetKey(OptionNames enum_value)
Definition: Breakpoint.h:95
lldb_private::Breakpoint::operator=
const Breakpoint & operator=(const Breakpoint &)=delete
StructuredData.h
lldb_private::Breakpoint::GetIgnoreCount
uint32_t GetIgnoreCount() const
Return the current ignore count/.
Definition: Breakpoint.cpp:324
lldb_private::Breakpoint::IsOneShot
bool IsOneShot() const
Check the OneShot state.
Definition: Breakpoint.cpp:330
lldb_private::Breakpoint::GetDescription
void GetDescription(Stream *s, lldb::DescriptionLevel level, bool show_locations=false)
Put a description of this breakpoint into the stream s.
Definition: Breakpoint.cpp:848
lldb_private::Breakpoint::SetBreakpointKind
void SetBreakpointKind(const char *kind)
Set the "kind" description for a breakpoint.
Definition: Breakpoint.h:443
lldb_private::Breakpoint::SetAutoContinue
void SetAutoContinue(bool auto_continue)
If auto_continue is true, breakpoint will auto-continue when on hit.
Definition: Breakpoint.cpp:336
lldb_private::Breakpoint::GetThreadName
const char * GetThreadName() const
Definition: Breakpoint.cpp:379
lldb_private::BreakpointName::Permissions::GetAllowDelete
bool GetAllowDelete() const
Definition: BreakpointName.h:90
lldb_private::Breakpoint::GetResolverDescription
void GetResolverDescription(Stream *s)
Definition: Breakpoint.cpp:950
lldb_private::Breakpoint::SetCondition
void SetCondition(const char *condition)
Set the breakpoint's condition.
Definition: Breakpoint.cpp:402
lldb_private::EventData
Definition: Event.h:36
lldb_private::Breakpoint::FindLocationIDByAddress
lldb::break_id_t FindLocationIDByAddress(const Address &addr)
Find a breakpoint location ID by Address.
Definition: Breakpoint.cpp:270
lldb_private::Breakpoint::m_resolver_sp
lldb::BreakpointResolverSP m_resolver_sp
Definition: Breakpoint.h:643
lldb_private::Breakpoint::AllowList
bool AllowList() const
Definition: Breakpoint.h:565
lldb_private::Breakpoint::SetPrecondition
void SetPrecondition(lldb::BreakpointPreconditionSP precondition_sp)
Set a pre-condition filter that overrides all user provided filters/callbacks etc.
Definition: Breakpoint.h:548
lldb_private::Breakpoint::m_resolve_indirect_symbols
bool m_resolve_indirect_symbols
Definition: Breakpoint.h:654
lldb_private::Breakpoint::BreakpointEventData::GetBreakpointEventTypeFromEvent
static lldb::BreakpointEventType GetBreakpointEventTypeFromEvent(const lldb::EventSP &event_sp)
Definition: Breakpoint.cpp:1051
lldb_private::Breakpoint::AllowDelete
bool AllowDelete() const
Definition: Breakpoint.h:571
lldb_private::Breakpoint::BreakpointEventData::GetBreakpointEventType
lldb::BreakpointEventType GetBreakpointEventType() const
Definition: Breakpoint.cpp:1033
lldb_private::Breakpoint::GetFilterDescription
void GetFilterDescription(Stream *s)
Definition: Breakpoint.cpp:978
lldb_private::Stream
Definition: Stream.h:28
lldb_private::Breakpoint::EvaluatePrecondition
bool EvaluatePrecondition(StoppointCallbackContext &context)
Definition: Breakpoint.cpp:982
lldb_private::Breakpoint::BreakpointEventData::GetBreakpointLocationCollection
BreakpointLocationCollection & GetBreakpointLocationCollection()
Definition: Breakpoint.h:115
lldb_private::Breakpoint::BreakpointEventData
Definition: Breakpoint.h:100
lldb_private::Breakpoint::SerializeToStructuredData
virtual StructuredData::ObjectSP SerializeToStructuredData()
Definition: Breakpoint.cpp:81
lldb_private::Target
Definition: Target.h:451
lldb_private::Breakpoint::BreakpointEventData::GetEventDataFromEvent
static const BreakpointEventData * GetEventDataFromEvent(const Event *event_sp)
Definition: Breakpoint.cpp:1040
lldb_private::Breakpoint::OptionNames::Hardware
@ Hardware
lldb_private::Breakpoint::BreakpointEventData::GetFlavorString
static ConstString GetFlavorString()
Definition: Breakpoint.cpp:1019
lldb_private::BreakpointLocation
General Outline: A breakpoint location is defined by the breakpoint that produces it,...
Definition: BreakpointLocation.h:37
lldb_private::Breakpoint::BreakpointEventData::Dump
void Dump(Stream *s) const override
Definition: Breakpoint.cpp:1037
lldb_private::Breakpoint::m_hardware
bool m_hardware
Definition: Breakpoint.h:634
lldb_private::Breakpoint::m_permissions
BreakpointName::Permissions m_permissions
Definition: Breakpoint.h:661
lldb_private::Breakpoint::BreakpointEventData::GetNumBreakpointLocationsFromEvent
static size_t GetNumBreakpointLocationsFromEvent(const lldb::EventSP &event_sp)
Definition: Breakpoint.cpp:1072
lldb_private::Breakpoint::SetQueueName
void SetQueueName(const char *queue_name)
Definition: Breakpoint.cpp:386
lldb_private::Breakpoint::m_name_list
std::unordered_set< std::string > m_name_list
Definition: Breakpoint.h:636
lldb_private::Breakpoint::AllowDisable
bool AllowDisable() const
Definition: Breakpoint.h:568
error
static llvm::raw_ostream & error(Stream &strm)
Definition: CommandReturnObject.cpp:17
lldb_private::Breakpoint::GetTarget
const Target & GetTarget() const
Definition: Breakpoint.h:456
lldb_private::Breakpoint::m_locations
BreakpointLocationList m_locations
Definition: Breakpoint.h:652
lldb_private::Breakpoint::BreakpointEventData::~BreakpointEventData
~BreakpointEventData() override
lldb_private::ModuleList
Definition: ModuleList.h:72
lldb_private::StoppointHitCounter
Definition: StoppointHitCounter.h:20
lldb_private::Breakpoint::MatchesName
bool MatchesName(const char *name)
Definition: Breakpoint.h:527
lldb_private::Breakpoint::BreakpointEventData::m_new_breakpoint_sp
lldb::BreakpointSP m_new_breakpoint_sp
Definition: Breakpoint.h:139
lldb_private::Breakpoint::m_filter_sp
lldb::SearchFilterSP m_filter_sp
Definition: Breakpoint.h:641
SearchFilter.h
lldb_private::Breakpoint::GetLocationAtIndex
lldb::BreakpointLocationSP GetLocationAtIndex(size_t index)
Get breakpoint locations by index.
Definition: Breakpoint.cpp:278
lldb_private::Breakpoint::IsInternal
bool IsInternal() const
Tell whether this breakpoint is an "internal" breakpoint.
Definition: Breakpoint.cpp:258
lldb_private::Breakpoint::MatchType
MatchType
An enum specifying the match style for breakpoint settings.
Definition: Breakpoint.h:87
lldb_private::Breakpoint::GetBreakpointKind
const char * GetBreakpointKind() const
Return the "kind" description for a breakpoint.
Definition: Breakpoint.h:449
lldb_private::StructuredData::ObjectSP
std::shared_ptr< Object > ObjectSP
Definition: StructuredData.h:59
lldb_private::Breakpoint::GetQueueName
const char * GetQueueName() const
Definition: Breakpoint.cpp:395
lldb_private::Breakpoint::SetIgnoreCount
void SetIgnoreCount(uint32_t count)
Set the breakpoint to ignore the next count breakpoint hits.
Definition: Breakpoint.cpp:310
lldb_private::Breakpoint::Exact
@ Exact
Definition: Breakpoint.h:87
lldb::break_id_t
int32_t break_id_t
Definition: lldb-types.h:88
lldb_private::BreakpointName::Permissions
Definition: BreakpointName.h:32
lldb_private::ConstString
Definition: ConstString.h:40
lldb_private::BreakpointOptions
Definition: BreakpointOptions.h:27
lldb_private::Breakpoint::Glob
@ Glob
Definition: Breakpoint.h:87
lldb_private::BreakpointName::Permissions::GetAllowList
bool GetAllowList() const
Definition: BreakpointName.h:87
lldb_private::Breakpoint::Breakpoint
Breakpoint(Target &target, lldb::SearchFilterSP &filter_sp, lldb::BreakpointResolverSP &resolver_sp, bool hardware, bool resolve_indirect_symbols=true)
Constructors and Destructors Only the Target can make a breakpoint, and it owns the breakpoint lifesp...
lldb_private::Breakpoint::InvokeCallback
bool InvokeCallback(StoppointCallbackContext *context, lldb::break_id_t bp_loc_id)
Invoke the callback action when the breakpoint is hit.
Definition: Breakpoint.cpp:432
lldb_private::Breakpoint::GetResolver
lldb::BreakpointResolverSP GetResolver()
Definition: Breakpoint.h:513
lldb_private::Breakpoint::BreakpointEventData::GetFlavor
ConstString GetFlavor() const override
Definition: Breakpoint.cpp:1024
lldb_private::Breakpoint::m_being_created
bool m_being_created
Definition: Breakpoint.h:632
lldb_private::Breakpoint::OptionNames
OptionNames
Definition: Breakpoint.h:90
string
string(SUBSTRING ${p} 10 -1 pStripped) if($
Definition: Plugins/CMakeLists.txt:40
lldb_private::Breakpoint::GetNumResolvedLocations
size_t GetNumResolvedLocations() const
Return the number of breakpoint locations that have resolved to actual breakpoint sites.
Definition: Breakpoint.cpp:831
StringList.h
lldb_private::Breakpoint::GetThreadIndex
uint32_t GetThreadIndex() const
Definition: Breakpoint.cpp:363
lldb_private::Breakpoint::BreakpointEventData::m_breakpoint_event
lldb::BreakpointEventType m_breakpoint_event
Definition: Breakpoint.h:138
lldb_private::Breakpoint::m_options
BreakpointOptions m_options
Definition: Breakpoint.h:650
lldb_private::Breakpoint::SetThreadID
void SetThreadID(lldb::tid_t thread_id)
Set the valid thread to be checked when the breakpoint is hit.
Definition: Breakpoint.cpp:340
Event.h
lldb_private::BreakpointLocationCollection
Definition: BreakpointLocationCollection.h:20
lldb_private::StatsDuration
std::chrono::duration< double > StatsDuration
Definition: Statistics.h:23
lldb_private::Breakpoint::GetResolveTime
StatsDuration GetResolveTime() const
Get the time it took to resolve all locations in this breakpoint.
Definition: Breakpoint.h:584
BreakpointOptions.h
lldb_private::Breakpoint::SetThreadIndex
void SetThreadIndex(uint32_t index)
Definition: Breakpoint.cpp:355
lldb_private::Breakpoint::RemoveInvalidLocations
void RemoveInvalidLocations(const ArchSpec &arch)
Removes all invalid breakpoint locations.
Definition: Breakpoint.cpp:282
lldb_private::Breakpoint::GetThreadID
lldb::tid_t GetThreadID() const
Return the current stop thread value.
Definition: Breakpoint.cpp:348
lldb_private::Breakpoint::CopyFromBreakpoint
static lldb::BreakpointSP CopyFromBreakpoint(lldb::TargetSP new_target, const Breakpoint &bp_to_copy_from)
Definition: Breakpoint.cpp:68
lldb_private::Breakpoint::ModulesChanged
void ModulesChanged(ModuleList &changed_modules, bool load_event, bool delete_locations=false)
Like ResolveBreakpointInModules, but allows for "unload" events, in which case we will remove any loc...
Definition: Breakpoint.cpp:488
lldb_private::Breakpoint::SetEnabled
void SetEnabled(bool enable) override
If enable is true, enable the breakpoint, if false disable it.
Definition: Breakpoint.cpp:294
StoppointHitCounter.h
lldb_private::Status
Definition: Status.h:44
lldb_private::Breakpoint::g_option_names
static const char * g_option_names[static_cast< uint32_t >(OptionNames::LastOptionName)]
Definition: Breakpoint.h:93
lldb_private::Breakpoint::ClearCallback
void ClearCallback()
Definition: Breakpoint.cpp:430
lldb_private::Breakpoint::ModuleReplaced
void ModuleReplaced(lldb::ModuleSP old_module_sp, lldb::ModuleSP new_module_sp)
Tells the breakpoint the old module old_module_sp has been replaced by new_module_sp (usually because...
Definition: Breakpoint.cpp:647
uint32_t
lldb_private::Address
Definition: Address.h:59
BreakpointLocationList.h
lldb_private::Breakpoint::AddLocation
lldb::BreakpointLocationSP AddLocation(const Address &addr, bool *new_location=nullptr)
Add a location to the breakpoint's location list.
Definition: Breakpoint.cpp:260
lldb_private::Stoppoint
Definition: Stoppoint.h:17
lldb_private::Breakpoint::BreakpointEventData::GetBreakpointLocationAtIndexFromEvent
static lldb::BreakpointLocationSP GetBreakpointLocationAtIndexFromEvent(const lldb::EventSP &event_sp, uint32_t loc_idx)
Definition: Breakpoint.cpp:1082
lldb_private::Breakpoint::SetCallback
void SetCallback(BreakpointHitCallback callback, void *baton, bool is_synchronous=false)
Set the callback action invoked when the breakpoint is hit.
Definition: Breakpoint.cpp:412
lldb_private::Breakpoint::BreakpointEventData::operator=
const BreakpointEventData & operator=(const BreakpointEventData &)=delete
lldb_private::Breakpoint::GetPrecondition
lldb::BreakpointPreconditionSP GetPrecondition()
Definition: Breakpoint.h:554
lldb_private::Breakpoint::GetSearchFilter
lldb::SearchFilterSP GetSearchFilter()
Definition: Breakpoint.h:515
lldb_private::Breakpoint::AddName
bool AddName(llvm::StringRef new_name)
Definition: Breakpoint.cpp:843
lldb_private::Breakpoint::Dump
void Dump(Stream *s) override
Standard "Dump" method. At present it does nothing.
Definition: Breakpoint.cpp:829
lldb_private::Breakpoint::ResolveBreakpointInModules
void ResolveBreakpointInModules(ModuleList &module_list, bool send_event=true)
Tell this breakpoint to scan a given module list and resolve any new locations that match the breakpo...
Definition: Breakpoint.cpp:458
lldb_private::Breakpoint::m_resolve_time
StatsDuration m_resolve_time
Definition: Breakpoint.h:663
BreakpointID.h
BreakpointLocationCollection.h
Statistics.h
lldb_private::Breakpoint::SerializedBreakpointMatchesNames
static bool SerializedBreakpointMatchesNames(StructuredData::ObjectSP &bkpt_object_sp, std::vector< std::string > &names)
Definition: Breakpoint.cpp:222
lldb_private::Breakpoint::ResolveBreakpoint
void ResolveBreakpoint()
Tell this breakpoint to scan it's target's module list and resolve any new locations that match the b...
Definition: Breakpoint.cpp:441
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
lldb_private::Breakpoint::BreakpointEventData::m_locations
BreakpointLocationCollection m_locations
Definition: Breakpoint.h:140
lldb_private::BreakpointLocationList
Definition: BreakpointLocationList.h:26
lldb_private::Breakpoint::FindLocationByAddress
lldb::BreakpointLocationSP FindLocationByAddress(const Address &addr)
Find a breakpoint location by Address.
Definition: Breakpoint.cpp:266
lldb_private::Breakpoint::IsHardware
bool IsHardware() const
Definition: Breakpoint.h:511
lldb_private::Breakpoint::BreakpointEventData::GetBreakpointFromEvent
static lldb::BreakpointSP GetBreakpointFromEvent(const lldb::EventSP &event_sp)
Definition: Breakpoint.cpp:1061
lldb_private::Breakpoint::m_hit_counter
StoppointHitCounter m_hit_counter
Number of times this breakpoint has been hit.
Definition: Breakpoint.h:659
lldb_private::Breakpoint::GetTarget
Target & GetTarget()
Accessor for the breakpoint Target.
Definition: Breakpoint.h:454
lldb_private::Breakpoint::GetNumLocations
size_t GetNumLocations() const
Return the number of breakpoint locations.
Definition: Breakpoint.cpp:841
lldb_private::Breakpoint::RemoveName
void RemoveName(const char *name_to_remove)
Definition: Breakpoint.h:521
lldb_private::Breakpoint::OptionNames::LastOptionName
@ LastOptionName
lldb_private::Breakpoint::GetTargetSP
const lldb::TargetSP GetTargetSP()
Definition: Breakpoint.cpp:254
lldb_private::Breakpoint::DecrementIgnoreCount
void DecrementIgnoreCount()
Definition: Breakpoint.cpp:318
lldb_private::BreakpointName::Permissions::GetAllowDisable
bool GetAllowDisable() const
Definition: BreakpointName.h:93
lldb_private::Breakpoint::BreakpointEventData::BreakpointEventData
BreakpointEventData(lldb::BreakpointEventType sub_type, const lldb::BreakpointSP &new_breakpoint_sp)
lldb_private::Breakpoint::GetSerializationKey
static const char * GetSerializationKey()
Definition: Breakpoint.h:157
Stoppoint.h
lldb_private::Breakpoint::IsEnabled
bool IsEnabled() override
Check the Enable/Disable state.
Definition: Breakpoint.cpp:308
lldb_private::Breakpoint::CreateFromStructuredData
static lldb::BreakpointSP CreateFromStructuredData(lldb::TargetSP target_sp, StructuredData::ObjectSP &data_object_sp, Status &error)
Definition: Breakpoint.cpp:129
lldb_private::Breakpoint::GetPermissions
const BreakpointName::Permissions & GetPermissions() const
Definition: Breakpoint.h:557
lldb_private::Breakpoint::OptionNames::Names
@ Names
lldb_private::Breakpoint::GetNames
void GetNames(std::vector< std::string > &names)
Definition: Breakpoint.h:531
lldb_private::Breakpoint::FindLocationByID
lldb::BreakpointLocationSP FindLocationByID(lldb::break_id_t bp_loc_id)
Find a breakpoint location for a given breakpoint location ID.
Definition: Breakpoint.cpp:274
lldb_private::Breakpoint::IsAutoContinue
bool IsAutoContinue() const
Check the AutoContinue state.
Definition: Breakpoint.cpp:334
lldb::DescriptionLevel
DescriptionLevel
Description levels for "void GetDescription(Stream *, DescriptionLevel)" calls.
Definition: lldb-enumerations.h:207
lldb_private::Breakpoint
General Outline: A breakpoint has four main parts, a filter, a resolver, the list of breakpoint locat...
Definition: Breakpoint.h:80
lldb_private::Breakpoint::Regexp
@ Regexp
Definition: Breakpoint.h:87
lldb::tid_t
uint64_t tid_t
Definition: lldb-types.h:86
lldb_private::Breakpoint::GetHitCount
uint32_t GetHitCount() const
Return the current hit count for all locations.
Definition: Breakpoint.cpp:328
lldb_private::Breakpoint::SetThreadName
void SetThreadName(const char *thread_name)
Definition: Breakpoint.cpp:370