1 //===-- StopInfo.cpp --------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
14 // Other libraries and framework includes
16 #include "lldb/Breakpoint/Breakpoint.h"
17 #include "lldb/Breakpoint/BreakpointLocation.h"
18 #include "lldb/Breakpoint/StoppointCallbackContext.h"
19 #include "lldb/Breakpoint/Watchpoint.h"
20 #include "lldb/Core/Debugger.h"
21 #include "lldb/Core/ValueObject.h"
22 #include "lldb/Expression/UserExpression.h"
23 #include "lldb/Target/Process.h"
24 #include "lldb/Target/StopInfo.h"
25 #include "lldb/Target/Target.h"
26 #include "lldb/Target/Thread.h"
27 #include "lldb/Target/ThreadPlan.h"
28 #include "lldb/Target/UnixSignals.h"
29 #include "lldb/Utility/Log.h"
30 #include "lldb/Utility/StreamString.h"
33 using namespace lldb_private;
35 StopInfo::StopInfo(Thread &thread, uint64_t value)
36 : m_thread_wp(thread.shared_from_this()),
37 m_stop_id(thread.GetProcess()->GetStopID()),
38 m_resume_id(thread.GetProcess()->GetResumeID()), m_value(value),
39 m_description(), m_override_should_notify(eLazyBoolCalculate),
40 m_override_should_stop(eLazyBoolCalculate), m_extended_info() {}
42 bool StopInfo::IsValid() const {
43 ThreadSP thread_sp(m_thread_wp.lock());
45 return thread_sp->GetProcess()->GetStopID() == m_stop_id;
49 void StopInfo::MakeStopInfoValid() {
50 ThreadSP thread_sp(m_thread_wp.lock());
52 m_stop_id = thread_sp->GetProcess()->GetStopID();
53 m_resume_id = thread_sp->GetProcess()->GetResumeID();
57 bool StopInfo::HasTargetRunSinceMe() {
58 ThreadSP thread_sp(m_thread_wp.lock());
61 lldb::StateType ret_type = thread_sp->GetProcess()->GetPrivateState();
62 if (ret_type == eStateRunning) {
64 } else if (ret_type == eStateStopped) {
65 // This is a little tricky. We want to count "run and stopped again
67 // ask this question as a "TRUE" answer to HasTargetRunSinceMe. But we
69 // include any running of the target done for expressions. So we track
71 // and resumes caused by expressions, and check if there are any resumes
75 uint32_t curr_resume_id = thread_sp->GetProcess()->GetResumeID();
76 uint32_t last_user_expression_id =
77 thread_sp->GetProcess()->GetLastUserExpressionResumeID();
78 if (curr_resume_id == m_resume_id) {
80 } else if (curr_resume_id > last_user_expression_id) {
88 //----------------------------------------------------------------------
90 //----------------------------------------------------------------------
92 namespace lldb_private {
93 class StopInfoBreakpoint : public StopInfo {
95 StopInfoBreakpoint(Thread &thread, break_id_t break_id)
96 : StopInfo(thread, break_id), m_should_stop(false),
97 m_should_stop_is_valid(false), m_should_perform_action(true),
98 m_address(LLDB_INVALID_ADDRESS), m_break_id(LLDB_INVALID_BREAK_ID),
99 m_was_one_shot(false) {
103 StopInfoBreakpoint(Thread &thread, break_id_t break_id, bool should_stop)
104 : StopInfo(thread, break_id), m_should_stop(should_stop),
105 m_should_stop_is_valid(true), m_should_perform_action(true),
106 m_address(LLDB_INVALID_ADDRESS), m_break_id(LLDB_INVALID_BREAK_ID),
107 m_was_one_shot(false) {
111 ~StopInfoBreakpoint() override = default;
114 ThreadSP thread_sp(m_thread_wp.lock());
116 BreakpointSiteSP bp_site_sp(
117 thread_sp->GetProcess()->GetBreakpointSiteList().FindByID(m_value));
119 if (bp_site_sp->GetNumberOfOwners() == 1) {
120 BreakpointLocationSP bp_loc_sp = bp_site_sp->GetOwnerAtIndex(0);
122 m_break_id = bp_loc_sp->GetBreakpoint().GetID();
123 m_was_one_shot = bp_loc_sp->GetBreakpoint().IsOneShot();
126 m_address = bp_site_sp->GetLoadAddress();
131 bool IsValidForOperatingSystemThread(Thread &thread) override {
132 ProcessSP process_sp(thread.GetProcess());
134 BreakpointSiteSP bp_site_sp(
135 process_sp->GetBreakpointSiteList().FindByID(m_value));
137 return bp_site_sp->ValidForThisThread(&thread);
142 StopReason GetStopReason() const override { return eStopReasonBreakpoint; }
144 bool ShouldStopSynchronous(Event *event_ptr) override {
145 ThreadSP thread_sp(m_thread_wp.lock());
147 if (!m_should_stop_is_valid) {
148 // Only check once if we should stop at a breakpoint
149 BreakpointSiteSP bp_site_sp(
150 thread_sp->GetProcess()->GetBreakpointSiteList().FindByID(m_value));
152 ExecutionContext exe_ctx(thread_sp->GetStackFrameAtIndex(0));
153 StoppointCallbackContext context(event_ptr, exe_ctx, true);
154 bp_site_sp->BumpHitCounts();
155 m_should_stop = bp_site_sp->ShouldStop(&context);
157 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
161 "Process::%s could not find breakpoint site id: %" PRId64 "...",
162 __FUNCTION__, m_value);
164 m_should_stop = true;
166 m_should_stop_is_valid = true;
168 return m_should_stop;
173 bool DoShouldNotify(Event *event_ptr) override {
174 ThreadSP thread_sp(m_thread_wp.lock());
176 BreakpointSiteSP bp_site_sp(
177 thread_sp->GetProcess()->GetBreakpointSiteList().FindByID(m_value));
179 bool all_internal = true;
181 for (uint32_t i = 0; i < bp_site_sp->GetNumberOfOwners(); i++) {
182 if (!bp_site_sp->GetOwnerAtIndex(i)->GetBreakpoint().IsInternal()) {
183 all_internal = false;
187 return !all_internal;
193 const char *GetDescription() override {
194 if (m_description.empty()) {
195 ThreadSP thread_sp(m_thread_wp.lock());
197 BreakpointSiteSP bp_site_sp(
198 thread_sp->GetProcess()->GetBreakpointSiteList().FindByID(m_value));
201 // If we have just hit an internal breakpoint, and it has a kind
202 // description, print that instead of the
203 // full breakpoint printing:
204 if (bp_site_sp->IsInternal()) {
205 size_t num_owners = bp_site_sp->GetNumberOfOwners();
206 for (size_t idx = 0; idx < num_owners; idx++) {
207 const char *kind = bp_site_sp->GetOwnerAtIndex(idx)
209 .GetBreakpointKind();
210 if (kind != nullptr) {
211 m_description.assign(kind);
217 strm.Printf("breakpoint ");
218 bp_site_sp->GetDescription(&strm, eDescriptionLevelBrief);
219 m_description = strm.GetString();
222 if (m_break_id != LLDB_INVALID_BREAK_ID) {
223 BreakpointSP break_sp =
224 thread_sp->GetProcess()->GetTarget().GetBreakpointByID(
227 if (break_sp->IsInternal()) {
228 const char *kind = break_sp->GetBreakpointKind();
230 strm.Printf("internal %s breakpoint(%d).", kind, m_break_id);
232 strm.Printf("internal breakpoint(%d).", m_break_id);
234 strm.Printf("breakpoint %d.", m_break_id);
238 strm.Printf("one-shot breakpoint %d", m_break_id);
240 strm.Printf("breakpoint %d which has been deleted.",
243 } else if (m_address == LLDB_INVALID_ADDRESS)
244 strm.Printf("breakpoint site %" PRIi64
245 " which has been deleted - unknown address",
248 strm.Printf("breakpoint site %" PRIi64
249 " which has been deleted - was at 0x%" PRIx64,
252 m_description = strm.GetString();
256 return m_description.c_str();
260 bool ShouldStop(Event *event_ptr) override {
261 // This just reports the work done by PerformAction or the synchronous stop.
263 // only ever get called after they have had a chance to run.
264 assert(m_should_stop_is_valid);
265 return m_should_stop;
268 void PerformAction(Event *event_ptr) override {
269 if (!m_should_perform_action)
271 m_should_perform_action = false;
272 bool internal_breakpoint = true;
274 ThreadSP thread_sp(m_thread_wp.lock());
277 Log *log = lldb_private::GetLogIfAnyCategoriesSet(
278 LIBLLDB_LOG_BREAKPOINTS | LIBLLDB_LOG_STEP);
280 if (!thread_sp->IsValid()) {
281 // This shouldn't ever happen, but just in case, don't do more harm.
283 log->Printf("PerformAction got called with an invalid thread.");
285 m_should_stop = true;
286 m_should_stop_is_valid = true;
290 BreakpointSiteSP bp_site_sp(
291 thread_sp->GetProcess()->GetBreakpointSiteList().FindByID(m_value));
292 std::unordered_set<break_id_t> precondition_breakpoints;
295 // Let's copy the owners list out of the site and store them in a local
297 // one of the breakpoint actions changes the site, then we won't be
298 // operating on a bad list.
299 BreakpointLocationCollection site_locations;
300 size_t num_owners = bp_site_sp->CopyOwnersList(site_locations);
302 if (num_owners == 0) {
303 m_should_stop = true;
305 // We go through each location, and test first its precondition - this
306 // overrides everything. Note,
307 // we only do this once per breakpoint - not once per location...
308 // Then check the condition. If the condition says to stop,
309 // then we run the callback for that location. If that callback says
310 // to stop as well, then
311 // we set m_should_stop to true; we are going to stop.
312 // But we still want to give all the breakpoints whose conditions say
313 // we are going to stop a
314 // chance to run their callbacks.
315 // Of course if any callback restarts the target by putting "continue"
316 // in the callback, then
317 // we're going to restart, without running the rest of the callbacks.
318 // And in this case we will
319 // end up not stopping even if another location said we should stop.
320 // But that's better than not
321 // running all the callbacks.
323 m_should_stop = false;
325 // We don't select threads as we go through them testing breakpoint
326 // conditions and running commands.
327 // So we need to set the thread for expression evaluation here:
328 ThreadList::ExpressionExecutionThreadPusher thread_pusher(thread_sp);
330 ExecutionContext exe_ctx(thread_sp->GetStackFrameAtIndex(0));
331 Process *process = exe_ctx.GetProcessPtr();
332 if (process->GetModIDRef().IsLastResumeForUserExpression()) {
333 // If we are in the middle of evaluating an expression, don't run
334 // asynchronous breakpoint commands or
335 // expressions. That could lead to infinite recursion if the
336 // command or condition re-calls the function
337 // with this breakpoint.
338 // TODO: We can keep a list of the breakpoints we've seen while
339 // running expressions in the nested
340 // PerformAction calls that can arise when the action runs a
341 // function that hits another breakpoint,
342 // and only stop running commands when we see the same breakpoint
343 // hit a second time.
345 m_should_stop_is_valid = true;
347 log->Printf("StopInfoBreakpoint::PerformAction - Hit a "
348 "breakpoint while running an expression,"
349 " not running commands to avoid recursion.");
350 bool ignoring_breakpoints =
351 process->GetIgnoreBreakpointsInExpressions();
352 if (ignoring_breakpoints) {
353 m_should_stop = false;
354 // Internal breakpoints will always stop.
355 for (size_t j = 0; j < num_owners; j++) {
356 lldb::BreakpointLocationSP bp_loc_sp =
357 bp_site_sp->GetOwnerAtIndex(j);
358 if (bp_loc_sp->GetBreakpoint().IsInternal()) {
359 m_should_stop = true;
364 m_should_stop = true;
367 log->Printf("StopInfoBreakpoint::PerformAction - in expression, "
369 m_should_stop ? "true" : "false");
370 process->GetTarget().GetDebugger().GetAsyncOutputStream()->Printf(
371 "Warning: hit breakpoint while "
372 "running function, skipping commands and conditions to prevent "
377 StoppointCallbackContext context(event_ptr, exe_ctx, false);
379 // For safety's sake let's also grab an extra reference to the
380 // breakpoint owners of the locations we're
381 // going to examine, since the locations are going to have to get back
382 // to their breakpoints, and the
383 // locations don't keep their owners alive. I'm just sticking the
384 // BreakpointSP's in a vector since
385 // I'm only using it to locally increment their retain counts.
387 std::vector<lldb::BreakpointSP> location_owners;
389 for (size_t j = 0; j < num_owners; j++) {
390 BreakpointLocationSP loc(site_locations.GetByIndex(j));
391 location_owners.push_back(loc->GetBreakpoint().shared_from_this());
394 for (size_t j = 0; j < num_owners; j++) {
395 lldb::BreakpointLocationSP bp_loc_sp = site_locations.GetByIndex(j);
397 // If another action disabled this breakpoint or its location, then
398 // don't run the actions.
399 if (!bp_loc_sp->IsEnabled() ||
400 !bp_loc_sp->GetBreakpoint().IsEnabled())
403 // The breakpoint site may have many locations associated with it,
404 // not all of them valid for
405 // this thread. Skip the ones that aren't:
406 if (!bp_loc_sp->ValidForThisThread(thread_sp.get())) {
409 bp_loc_sp->GetDescription(&s, eDescriptionLevelBrief);
410 log->Printf("Breakpoint %s hit on thread 0x%llx but it was not "
411 "for this thread, continuing.",
412 s.GetData(), static_cast<unsigned long long>(
413 thread_sp->GetID()));
418 // First run the precondition, but since the precondition is per
419 // breakpoint, only run it once
421 std::pair<std::unordered_set<break_id_t>::iterator, bool> result =
422 precondition_breakpoints.insert(
423 bp_loc_sp->GetBreakpoint().GetID());
427 bool precondition_result =
428 bp_loc_sp->GetBreakpoint().EvaluatePrecondition(context);
429 if (!precondition_result)
432 // Next run the condition for the breakpoint. If that says we
433 // should stop, then we'll run
434 // the callback for the breakpoint. If the callback says we
435 // shouldn't stop that will win.
437 if (bp_loc_sp->GetConditionText() != nullptr) {
438 Status condition_error;
439 bool condition_says_stop =
440 bp_loc_sp->ConditionSaysStop(exe_ctx, condition_error);
442 if (!condition_error.Success()) {
443 Debugger &debugger = exe_ctx.GetTargetRef().GetDebugger();
444 StreamSP error_sp = debugger.GetAsyncErrorStream();
445 error_sp->Printf("Stopped due to an error evaluating condition "
447 bp_loc_sp->GetDescription(error_sp.get(),
448 eDescriptionLevelBrief);
449 error_sp->Printf(": \"%s\"", bp_loc_sp->GetConditionText());
451 const char *err_str =
452 condition_error.AsCString("<Unknown Error>");
454 log->Printf("Error evaluating condition: \"%s\"\n", err_str);
456 error_sp->PutCString(err_str);
462 bp_loc_sp->GetDescription(&s, eDescriptionLevelBrief);
463 log->Printf("Condition evaluated for breakpoint %s on thread "
464 "0x%llx conditon_says_stop: %i.",
465 s.GetData(), static_cast<unsigned long long>(
467 condition_says_stop);
469 if (!condition_says_stop) {
470 // We don't want to increment the hit count of breakpoints if
471 // the condition fails.
472 // We've already bumped it by the time we get here, so undo
474 bp_loc_sp->UndoBumpHitCount();
480 bool callback_says_stop;
482 // FIXME: For now the callbacks have to run in async mode - the
483 // first time we restart we need
484 // to get out of there. So set it here.
485 // When we figure out how to nest breakpoint hits then this will
488 Debugger &debugger = thread_sp->CalculateTarget()->GetDebugger();
489 bool old_async = debugger.GetAsyncExecution();
490 debugger.SetAsyncExecution(true);
492 callback_says_stop = bp_loc_sp->InvokeCallback(&context);
494 debugger.SetAsyncExecution(old_async);
496 if (callback_says_stop)
497 m_should_stop = true;
499 if (m_should_stop && !bp_loc_sp->GetBreakpoint().IsInternal())
500 internal_breakpoint = false;
502 // If we are going to stop for this breakpoint, then remove the
504 if (callback_says_stop && bp_loc_sp &&
505 bp_loc_sp->GetBreakpoint().IsOneShot()) {
506 thread_sp->GetProcess()->GetTarget().RemoveBreakpointByID(
507 bp_loc_sp->GetBreakpoint().GetID());
510 // Also make sure that the callback hasn't continued the target.
511 // If it did, when we'll set m_should_start to false and get out of
513 if (HasTargetRunSinceMe()) {
514 m_should_stop = false;
519 // We've figured out what this stop wants to do, so mark it as valid so
520 // we don't compute it again.
521 m_should_stop_is_valid = true;
523 m_should_stop = true;
524 m_should_stop_is_valid = true;
526 lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
530 "Process::%s could not find breakpoint site id: %" PRId64 "...",
531 __FUNCTION__, m_value);
534 if ((m_should_stop == false || internal_breakpoint)
535 && thread_sp->CompletedPlanOverridesBreakpoint()) {
537 // Override should_stop decision when we have
538 // completed step plan additionally to the breakpoint
539 m_should_stop = true;
541 // Here we clean the preset stop info so the next
542 // GetStopInfo call will find the appropriate stop info,
543 // which should be the stop info related to the completed plan
544 thread_sp->ResetStopInfo();
548 log->Printf("Process::%s returning from action with m_should_stop: %d.",
549 __FUNCTION__, m_should_stop);
555 bool m_should_stop_is_valid;
556 bool m_should_perform_action; // Since we are trying to preserve the "state"
557 // of the system even if we run functions
558 // etc. behind the users backs, we need to make sure we only REALLY perform
560 lldb::addr_t m_address; // We use this to capture the breakpoint site address
561 // when we create the StopInfo,
562 // in case somebody deletes it between the time the StopInfo is made and the
563 // description is asked for.
564 lldb::break_id_t m_break_id;
568 //----------------------------------------------------------------------
569 // StopInfoWatchpoint
570 //----------------------------------------------------------------------
572 class StopInfoWatchpoint : public StopInfo {
574 // Make sure watchpoint is properly disabled and subsequently enabled while
575 // performing watchpoint actions.
576 class WatchpointSentry {
578 WatchpointSentry(ProcessSP p_sp, WatchpointSP w_sp) : process_sp(p_sp),
579 watchpoint_sp(w_sp) {
580 if (process_sp && watchpoint_sp) {
581 const bool notify = false;
582 watchpoint_sp->TurnOnEphemeralMode();
583 process_sp->DisableWatchpoint(watchpoint_sp.get(), notify);
584 process_sp->AddPreResumeAction(SentryPreResumeAction, this);
589 if (process_sp && watchpoint_sp) {
590 bool was_disabled = watchpoint_sp->IsDisabledDuringEphemeralMode();
591 watchpoint_sp->TurnOffEphemeralMode();
592 const bool notify = false;
594 process_sp->DisableWatchpoint(watchpoint_sp.get(), notify);
596 process_sp->EnableWatchpoint(watchpoint_sp.get(), notify);
601 ~WatchpointSentry() {
604 process_sp->ClearPreResumeAction(SentryPreResumeAction, this);
607 static bool SentryPreResumeAction(void *sentry_void) {
608 WatchpointSentry *sentry = (WatchpointSentry *) sentry_void;
609 sentry->DoReenable();
614 ProcessSP process_sp;
615 WatchpointSP watchpoint_sp;
618 StopInfoWatchpoint(Thread &thread, break_id_t watch_id,
619 lldb::addr_t watch_hit_addr)
620 : StopInfo(thread, watch_id), m_should_stop(false),
621 m_should_stop_is_valid(false), m_watch_hit_addr(watch_hit_addr) {}
623 ~StopInfoWatchpoint() override = default;
625 StopReason GetStopReason() const override { return eStopReasonWatchpoint; }
627 const char *GetDescription() override {
628 if (m_description.empty()) {
630 strm.Printf("watchpoint %" PRIi64, m_value);
631 m_description = strm.GetString();
633 return m_description.c_str();
637 bool ShouldStopSynchronous(Event *event_ptr) override {
638 // ShouldStop() method is idempotent and should not affect hit count.
639 // See Process::RunPrivateStateThread()->Process()->HandlePrivateEvent()
640 // -->Process()::ShouldBroadcastEvent()->ThreadList::ShouldStop()->
641 // Thread::ShouldStop()->ThreadPlanBase::ShouldStop()->
642 // StopInfoWatchpoint::ShouldStop() and
643 // Event::DoOnRemoval()->Process::ProcessEventData::DoOnRemoval()->
644 // StopInfoWatchpoint::PerformAction().
645 if (m_should_stop_is_valid)
646 return m_should_stop;
648 ThreadSP thread_sp(m_thread_wp.lock());
651 thread_sp->CalculateTarget()->GetWatchpointList().FindByID(
654 // Check if we should stop at a watchpoint.
655 ExecutionContext exe_ctx(thread_sp->GetStackFrameAtIndex(0));
656 StoppointCallbackContext context(event_ptr, exe_ctx, true);
657 m_should_stop = wp_sp->ShouldStop(&context);
659 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
663 "Process::%s could not find watchpoint location id: %" PRId64
665 __FUNCTION__, GetValue());
667 m_should_stop = true;
670 m_should_stop_is_valid = true;
671 return m_should_stop;
674 bool ShouldStop(Event *event_ptr) override {
675 // This just reports the work done by PerformAction or the synchronous stop.
677 // only ever get called after they have had a chance to run.
678 assert(m_should_stop_is_valid);
679 return m_should_stop;
682 void PerformAction(Event *event_ptr) override {
683 Log *log = lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_WATCHPOINTS);
684 // We're going to calculate if we should stop or not in some way during the
686 // this code. Also by default we're going to stop, so set that here.
687 m_should_stop = true;
690 ThreadSP thread_sp(m_thread_wp.lock());
694 thread_sp->CalculateTarget()->GetWatchpointList().FindByID(
697 ExecutionContext exe_ctx(thread_sp->GetStackFrameAtIndex(0));
698 ProcessSP process_sp = exe_ctx.GetProcessSP();
701 // check if this process is running on an architecture where
702 // watchpoints trigger
703 // before the associated instruction runs. if so, disable the WP,
704 // single-step and then
705 // re-enable the watchpoint
708 bool wp_triggers_after;
710 if (process_sp->GetWatchpointSupportInfo(num, wp_triggers_after)
712 if (!wp_triggers_after) {
713 // We need to preserve the watch_index before watchpoint
714 // is disable. Since Watchpoint::SetEnabled will clear the
716 // This will fix TestWatchpointIter failure
717 Watchpoint *wp = wp_sp.get();
718 uint32_t watch_index = wp->GetHardwareIndex();
719 process_sp->DisableWatchpoint(wp, false);
720 StopInfoSP stored_stop_info_sp = thread_sp->GetStopInfo();
721 assert(stored_stop_info_sp.get() == this);
723 ThreadPlanSP new_plan_sp(
724 thread_sp->QueueThreadPlanForStepSingleInstruction(
726 false, // abort_other_plans
727 true)); // stop_other_threads
728 new_plan_sp->SetIsMasterPlan(true);
729 new_plan_sp->SetOkayToDiscard(false);
730 new_plan_sp->SetPrivate(true);
731 process_sp->GetThreadList().SetSelectedThreadByID(
733 process_sp->ResumeSynchronous(nullptr);
734 process_sp->GetThreadList().SetSelectedThreadByID(
736 thread_sp->SetStopInfo(stored_stop_info_sp);
737 process_sp->EnableWatchpoint(wp, false);
738 wp->SetHardwareIndex(watch_index);
744 // This sentry object makes sure the current watchpoint is disabled
745 // while performing watchpoint actions,
746 // and it is then enabled after we are finished.
747 WatchpointSentry sentry(process_sp, wp_sp);
750 * MIPS: Last 3bits of the watchpoint address are masked by the kernel.
752 * 'n' is at 0x120010d00 and 'm' is 0x120010d04. When a watchpoint is
754 * watch exception is generated even when 'n' is read/written. To handle
756 * server emulates the instruction at PC and finds the base address of
758 * instruction and appends it in the description of the stop-info
759 * packet. If watchpoint
760 * is not set on this address by user then this do not stop.
762 if (m_watch_hit_addr != LLDB_INVALID_ADDRESS) {
763 WatchpointSP wp_hit_sp =
764 thread_sp->CalculateTarget()->GetWatchpointList().FindByAddress(
767 m_should_stop = false;
768 wp_sp->IncrementFalseAlarmsAndReviseHitCount();
772 // TODO: This condition should be checked in the synchronous part of the
774 // (Watchpoint::ShouldStop), so that we avoid pulling an event even if
775 // the watchpoint fails
776 // the ignore count condition. It is moved here temporarily, because for
778 // watchpoint_exceptions_received=before, the code in the previous lines
779 // takes care of moving
780 // the inferior to next PC. We have to check the ignore count condition
781 // after this is done,
782 // otherwise we will hit same watchpoint multiple times until we pass
783 // ignore condition, but we
784 // won't actually be ignoring them.
785 if (wp_sp->GetHitCount() <= wp_sp->GetIgnoreCount())
786 m_should_stop = false;
788 Debugger &debugger = exe_ctx.GetTargetRef().GetDebugger();
790 if (m_should_stop && wp_sp->GetConditionText() != nullptr) {
791 // We need to make sure the user sees any parse errors in their
792 // condition, so we'll hook the constructor errors up to the
793 // debugger's Async I/O.
794 ExpressionResults result_code;
795 EvaluateExpressionOptions expr_options;
796 expr_options.SetUnwindOnError(true);
797 expr_options.SetIgnoreBreakpoints(true);
798 ValueObjectSP result_value_sp;
800 result_code = UserExpression::Evaluate(
801 exe_ctx, expr_options, wp_sp->GetConditionText(),
802 llvm::StringRef(), result_value_sp, error);
804 if (result_code == eExpressionCompleted) {
805 if (result_value_sp) {
807 if (result_value_sp->ResolveValue(scalar_value)) {
808 if (scalar_value.ULongLong(1) == 0) {
809 // We have been vetoed. This takes precedence over querying
810 // the watchpoint whether it should stop (aka ignore count and
811 // friends). See also StopInfoWatchpoint::ShouldStop() as
812 // well as Process::ProcessEventData::DoOnRemoval().
813 m_should_stop = false;
815 m_should_stop = true;
818 "Condition successfully evaluated, result is %s.\n",
819 m_should_stop ? "true" : "false");
821 m_should_stop = true;
824 "Failed to get an integer result from the expression.");
828 StreamSP error_sp = debugger.GetAsyncErrorStream();
830 "Stopped due to an error evaluating condition of watchpoint ");
831 wp_sp->GetDescription(error_sp.get(), eDescriptionLevelBrief);
832 error_sp->Printf(": \"%s\"", wp_sp->GetConditionText());
834 const char *err_str = error.AsCString("<Unknown Error>");
836 log->Printf("Error evaluating condition: \"%s\"\n", err_str);
838 error_sp->PutCString(err_str);
841 // If the condition fails to be parsed or run, we should stop.
842 m_should_stop = true;
846 // If the condition says to stop, we run the callback to further decide
849 // FIXME: For now the callbacks have to run in async mode - the
850 // first time we restart we need
851 // to get out of there. So set it here.
852 // When we figure out how to nest watchpoint hits then this will
855 bool old_async = debugger.GetAsyncExecution();
856 debugger.SetAsyncExecution(true);
858 StoppointCallbackContext context(event_ptr, exe_ctx, false);
859 bool stop_requested = wp_sp->InvokeCallback(&context);
861 debugger.SetAsyncExecution(old_async);
863 // Also make sure that the callback hasn't continued the target.
864 // If it did, when we'll set m_should_stop to false and get out of
866 if (HasTargetRunSinceMe())
867 m_should_stop = false;
869 if (m_should_stop && !stop_requested) {
870 // We have been vetoed by the callback mechanism.
871 m_should_stop = false;
874 // Finally, if we are going to stop, print out the new & old values:
876 wp_sp->CaptureWatchedValue(exe_ctx);
878 Debugger &debugger = exe_ctx.GetTargetRef().GetDebugger();
879 StreamSP output_sp = debugger.GetAsyncOutputStream();
880 wp_sp->DumpSnapshots(output_sp.get());
887 lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
891 "Process::%s could not find watchpoint id: %" PRId64 "...",
892 __FUNCTION__, m_value);
895 log->Printf("Process::%s returning from action with m_should_stop: %d.",
896 __FUNCTION__, m_should_stop);
898 m_should_stop_is_valid = true;
904 bool m_should_stop_is_valid;
905 lldb::addr_t m_watch_hit_addr;
908 //----------------------------------------------------------------------
909 // StopInfoUnixSignal
910 //----------------------------------------------------------------------
912 class StopInfoUnixSignal : public StopInfo {
914 StopInfoUnixSignal(Thread &thread, int signo, const char *description)
915 : StopInfo(thread, signo) {
916 SetDescription(description);
919 ~StopInfoUnixSignal() override = default;
921 StopReason GetStopReason() const override { return eStopReasonSignal; }
923 bool ShouldStopSynchronous(Event *event_ptr) override {
924 ThreadSP thread_sp(m_thread_wp.lock());
926 return thread_sp->GetProcess()->GetUnixSignals()->GetShouldStop(m_value);
930 bool ShouldStop(Event *event_ptr) override {
931 ThreadSP thread_sp(m_thread_wp.lock());
933 return thread_sp->GetProcess()->GetUnixSignals()->GetShouldStop(m_value);
937 // If should stop returns false, check if we should notify of this event
938 bool DoShouldNotify(Event *event_ptr) override {
939 ThreadSP thread_sp(m_thread_wp.lock());
942 thread_sp->GetProcess()->GetUnixSignals()->GetShouldNotify(m_value);
946 "thread %d received signal: %s", thread_sp->GetIndexID(),
947 thread_sp->GetProcess()->GetUnixSignals()->GetSignalAsCString(
949 Process::ProcessEventData::AddRestartedReason(event_ptr,
952 return should_notify;
957 void WillResume(lldb::StateType resume_state) override {
958 ThreadSP thread_sp(m_thread_wp.lock());
960 if (!thread_sp->GetProcess()->GetUnixSignals()->GetShouldSuppress(
962 thread_sp->SetResumeSignal(m_value);
966 const char *GetDescription() override {
967 if (m_description.empty()) {
968 ThreadSP thread_sp(m_thread_wp.lock());
971 const char *signal_name =
972 thread_sp->GetProcess()->GetUnixSignals()->GetSignalAsCString(
975 strm.Printf("signal %s", signal_name);
977 strm.Printf("signal %" PRIi64, m_value);
978 m_description = strm.GetString();
981 return m_description.c_str();
985 //----------------------------------------------------------------------
987 //----------------------------------------------------------------------
989 class StopInfoTrace : public StopInfo {
991 StopInfoTrace(Thread &thread) : StopInfo(thread, LLDB_INVALID_UID) {}
993 ~StopInfoTrace() override = default;
995 StopReason GetStopReason() const override { return eStopReasonTrace; }
997 const char *GetDescription() override {
998 if (m_description.empty())
1001 return m_description.c_str();
1005 //----------------------------------------------------------------------
1006 // StopInfoException
1007 //----------------------------------------------------------------------
1009 class StopInfoException : public StopInfo {
1011 StopInfoException(Thread &thread, const char *description)
1012 : StopInfo(thread, LLDB_INVALID_UID) {
1014 SetDescription(description);
1017 ~StopInfoException() override = default;
1019 StopReason GetStopReason() const override { return eStopReasonException; }
1021 const char *GetDescription() override {
1022 if (m_description.empty())
1025 return m_description.c_str();
1029 //----------------------------------------------------------------------
1030 // StopInfoThreadPlan
1031 //----------------------------------------------------------------------
1033 class StopInfoThreadPlan : public StopInfo {
1035 StopInfoThreadPlan(ThreadPlanSP &plan_sp, ValueObjectSP &return_valobj_sp,
1036 ExpressionVariableSP &expression_variable_sp)
1037 : StopInfo(plan_sp->GetThread(), LLDB_INVALID_UID), m_plan_sp(plan_sp),
1038 m_return_valobj_sp(return_valobj_sp),
1039 m_expression_variable_sp(expression_variable_sp) {}
1041 ~StopInfoThreadPlan() override = default;
1043 StopReason GetStopReason() const override { return eStopReasonPlanComplete; }
1045 const char *GetDescription() override {
1046 if (m_description.empty()) {
1048 m_plan_sp->GetDescription(&strm, eDescriptionLevelBrief);
1049 m_description = strm.GetString();
1051 return m_description.c_str();
1054 ValueObjectSP GetReturnValueObject() { return m_return_valobj_sp; }
1056 ExpressionVariableSP GetExpressionVariable() {
1057 return m_expression_variable_sp;
1061 bool ShouldStop(Event *event_ptr) override {
1063 return m_plan_sp->ShouldStop(event_ptr);
1065 return StopInfo::ShouldStop(event_ptr);
1069 ThreadPlanSP m_plan_sp;
1070 ValueObjectSP m_return_valobj_sp;
1071 ExpressionVariableSP m_expression_variable_sp;
1074 class StopInfoExec : public StopInfo {
1076 StopInfoExec(Thread &thread)
1077 : StopInfo(thread, LLDB_INVALID_UID), m_performed_action(false) {}
1079 ~StopInfoExec() override = default;
1081 StopReason GetStopReason() const override { return eStopReasonExec; }
1083 const char *GetDescription() override { return "exec"; }
1086 void PerformAction(Event *event_ptr) override {
1087 // Only perform the action once
1088 if (m_performed_action)
1090 m_performed_action = true;
1091 ThreadSP thread_sp(m_thread_wp.lock());
1093 thread_sp->GetProcess()->DidExec();
1096 bool m_performed_action;
1099 } // namespace lldb_private
1101 StopInfoSP StopInfo::CreateStopReasonWithBreakpointSiteID(Thread &thread,
1102 break_id_t break_id) {
1103 return StopInfoSP(new StopInfoBreakpoint(thread, break_id));
1106 StopInfoSP StopInfo::CreateStopReasonWithBreakpointSiteID(Thread &thread,
1107 break_id_t break_id,
1109 return StopInfoSP(new StopInfoBreakpoint(thread, break_id, should_stop));
1113 StopInfo::CreateStopReasonWithWatchpointID(Thread &thread, break_id_t watch_id,
1114 lldb::addr_t watch_hit_addr) {
1115 return StopInfoSP(new StopInfoWatchpoint(thread, watch_id, watch_hit_addr));
1118 StopInfoSP StopInfo::CreateStopReasonWithSignal(Thread &thread, int signo,
1119 const char *description) {
1120 return StopInfoSP(new StopInfoUnixSignal(thread, signo, description));
1123 StopInfoSP StopInfo::CreateStopReasonToTrace(Thread &thread) {
1124 return StopInfoSP(new StopInfoTrace(thread));
1127 StopInfoSP StopInfo::CreateStopReasonWithPlan(
1128 ThreadPlanSP &plan_sp, ValueObjectSP return_valobj_sp,
1129 ExpressionVariableSP expression_variable_sp) {
1130 return StopInfoSP(new StopInfoThreadPlan(plan_sp, return_valobj_sp,
1131 expression_variable_sp));
1134 StopInfoSP StopInfo::CreateStopReasonWithException(Thread &thread,
1135 const char *description) {
1136 return StopInfoSP(new StopInfoException(thread, description));
1139 StopInfoSP StopInfo::CreateStopReasonWithExec(Thread &thread) {
1140 return StopInfoSP(new StopInfoExec(thread));
1143 ValueObjectSP StopInfo::GetReturnValueObject(StopInfoSP &stop_info_sp) {
1145 stop_info_sp->GetStopReason() == eStopReasonPlanComplete) {
1146 StopInfoThreadPlan *plan_stop_info =
1147 static_cast<StopInfoThreadPlan *>(stop_info_sp.get());
1148 return plan_stop_info->GetReturnValueObject();
1150 return ValueObjectSP();
1153 ExpressionVariableSP StopInfo::GetExpressionVariable(StopInfoSP &stop_info_sp) {
1155 stop_info_sp->GetStopReason() == eStopReasonPlanComplete) {
1156 StopInfoThreadPlan *plan_stop_info =
1157 static_cast<StopInfoThreadPlan *>(stop_info_sp.get());
1158 return plan_stop_info->GetExpressionVariable();
1160 return ExpressionVariableSP();
1164 StopInfo::GetCrashingDereference(StopInfoSP &stop_info_sp,
1165 lldb::addr_t *crashing_address) {
1166 if (!stop_info_sp) {
1167 return ValueObjectSP();
1170 const char *description = stop_info_sp->GetDescription();
1172 return ValueObjectSP();
1175 ThreadSP thread_sp = stop_info_sp->GetThread();
1177 return ValueObjectSP();
1180 StackFrameSP frame_sp = thread_sp->GetSelectedFrame();
1183 return ValueObjectSP();
1186 const char address_string[] = "address=";
1188 const char *address_loc = strstr(description, address_string);
1190 return ValueObjectSP();
1193 address_loc += (sizeof(address_string) - 1);
1195 uint64_t address = strtoull(address_loc, 0, 0);
1196 if (crashing_address) {
1197 *crashing_address = address;
1200 return frame_sp->GuessValueForAddress(address);