Fix reporting of stop reasons when the StepOver & StepIn plans stop because of a crash or breakpoint. Added the ability for a plan to say it is done but doesn't want to be the reason for the stop.
git-svn-id: https://llvm.org/svn/llvm-project/lldb/trunk@155927 91177308-0d34-0410-b5e6-96231b3b80d8
diff --git a/include/lldb/Target/ThreadPlan.h b/include/lldb/Target/ThreadPlan.h
index 090c473..2cb6fea 100644
--- a/include/lldb/Target/ThreadPlan.h
+++ b/include/lldb/Target/ThreadPlan.h
@@ -142,6 +142,16 @@
// all threads will be called, the stop event is placed on the Process's public broadcaster, and
// control returns to the upper layers of the debugger.
//
+// Reporting the stop:
+//
+// When the process stops, the thread is given a StopReason, in the form of a StopInfo object. If there is a completed
+// plan corresponding to the stop, then the "actual" stop reason will be suppressed, and instead a StopInfoThreadPlan
+// object will be cons'ed up from the highest completed plan in the stack. However, if the plan doesn't want to be
+// the stop reason, then it can call SetPlanComplete and pass in "false" for the "success" parameter. In that case,
+// the real stop reason will be used instead. One exapmle of this is the "StepRangeStepIn" thread plan. If it stops
+// because of a crash or breakpoint hit, it wants to unship itself, because it isn't so useful to have step in keep going
+// after a breakpoint hit. But it can't be the reason for the stop or no-one would see that they had hit a breakpoint.
+//
// Automatically Resuming:
//
// If ShouldStop for all threads returns "false", then the target process will resume. This then cycles back to
@@ -396,7 +406,13 @@
IsPlanComplete();
void
- SetPlanComplete ();
+ SetPlanComplete (bool success = true);
+
+ bool
+ PlanSucceeded ()
+ {
+ return m_plan_succeeded;
+ }
virtual bool
IsBasePlan()
@@ -489,6 +505,7 @@
bool m_plan_private;
bool m_okay_to_discard;
bool m_is_master_plan;
+ bool m_plan_succeeded;
lldb::ThreadPlanTracerSP m_tracer_sp;
diff --git a/include/lldb/Target/ThreadPlanStepInRange.h b/include/lldb/Target/ThreadPlanStepInRange.h
index 7eb5717..664cede 100644
--- a/include/lldb/Target/ThreadPlanStepInRange.h
+++ b/include/lldb/Target/ThreadPlanStepInRange.h
@@ -49,6 +49,9 @@
static void
SetDefaultFlagValue (uint32_t new_value);
+ virtual bool
+ PlanExplainsStop ();
+
protected:
virtual void
diff --git a/include/lldb/Target/ThreadPlanStepOverRange.h b/include/lldb/Target/ThreadPlanStepOverRange.h
index 39b1414..23e8e95 100644
--- a/include/lldb/Target/ThreadPlanStepOverRange.h
+++ b/include/lldb/Target/ThreadPlanStepOverRange.h
@@ -35,6 +35,7 @@
virtual void GetDescription (Stream *s, lldb::DescriptionLevel level);
virtual bool ShouldStop (Event *event_ptr);
+ virtual bool PlanExplainsStop ();
protected:
diff --git a/include/lldb/Target/ThreadPlanStepRange.h b/include/lldb/Target/ThreadPlanStepRange.h
index dc1021d..3ca5b3a 100644
--- a/include/lldb/Target/ThreadPlanStepRange.h
+++ b/include/lldb/Target/ThreadPlanStepRange.h
@@ -42,7 +42,6 @@
virtual lldb::StateType GetPlanRunState ();
virtual bool WillStop ();
virtual bool MischiefManaged ();
- virtual bool PlanExplainsStop ();
virtual void DidPush ();
diff --git a/source/Target/Thread.cpp b/source/Target/Thread.cpp
index 7445ffc..aaec665 100644
--- a/source/Target/Thread.cpp
+++ b/source/Target/Thread.cpp
@@ -97,7 +97,7 @@
Thread::GetStopInfo ()
{
ThreadPlanSP plan_sp (GetCompletedPlan());
- if (plan_sp)
+ if (plan_sp && plan_sp->PlanSucceeded())
return StopInfo::CreateStopReasonWithPlan (plan_sp, GetReturnValueObject());
else
{
diff --git a/source/Target/ThreadPlan.cpp b/source/Target/ThreadPlan.cpp
index 5f396d9..22c2fc4 100644
--- a/source/Target/ThreadPlan.cpp
+++ b/source/Target/ThreadPlan.cpp
@@ -37,7 +37,8 @@
m_plan_complete (false),
m_plan_private (false),
m_okay_to_discard (false),
- m_is_master_plan (false)
+ m_is_master_plan (false),
+ m_plan_succeeded(true)
{
SetID (GetNextID());
}
@@ -57,10 +58,11 @@
}
void
-ThreadPlan::SetPlanComplete ()
+ThreadPlan::SetPlanComplete (bool success)
{
Mutex::Locker locker(m_plan_complete_mutex);
m_plan_complete = true;
+ m_plan_succeeded = success;
}
bool
diff --git a/source/Target/ThreadPlanStepInRange.cpp b/source/Target/ThreadPlanStepInRange.cpp
index 9fbca6b..0db23a1 100644
--- a/source/Target/ThreadPlanStepInRange.cpp
+++ b/source/Target/ThreadPlanStepInRange.cpp
@@ -295,3 +295,41 @@
return NULL;
}
+
+bool
+ThreadPlanStepInRange::PlanExplainsStop ()
+{
+ // We always explain a stop. Either we've just done a single step, in which
+ // case we'll do our ordinary processing, or we stopped for some
+ // reason that isn't handled by our sub-plans, in which case we want to just stop right
+ // away.
+ // We also set ourselves complete when we stop for this sort of unintended reason, but mark
+ // success as false so we don't end up being the reason for the stop.
+ //
+ // The only variation is that if we are doing "step by running to next branch" in which case
+ // if we hit our branch breakpoint we don't set the plan to complete.
+
+ LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
+ StopInfoSP stop_info_sp = GetPrivateStopReason();
+ if (stop_info_sp)
+ {
+ StopReason reason = stop_info_sp->GetStopReason();
+
+ switch (reason)
+ {
+ case eStopReasonBreakpoint:
+ if (NextRangeBreakpointExplainsStop(stop_info_sp))
+ return true;
+ case eStopReasonWatchpoint:
+ case eStopReasonSignal:
+ case eStopReasonException:
+ if (log)
+ log->PutCString ("ThreadPlanStepInRange got asked if it explains the stop for some reason other than step.");
+ SetPlanComplete(false);
+ break;
+ default:
+ break;
+ }
+ }
+ return true;
+}
diff --git a/source/Target/ThreadPlanStepOverRange.cpp b/source/Target/ThreadPlanStepOverRange.cpp
index c147e83..933983b 100644
--- a/source/Target/ThreadPlanStepOverRange.cpp
+++ b/source/Target/ThreadPlanStepOverRange.cpp
@@ -170,3 +170,41 @@
else
return false;
}
+
+bool
+ThreadPlanStepOverRange::PlanExplainsStop ()
+{
+ // For crashes, breakpoint hits, signals, etc, let the base plan (or some plan above us)
+ // handle the stop. That way the user can see the stop, step around, and then when they
+ // are done, continue and have their step complete. The exception is if we've hit our
+ // "run to next branch" breakpoint.
+ // Note, unlike the step in range plan, we don't mark ourselves complete if we hit an
+ // unexplained breakpoint/crash.
+
+ LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
+ StopInfoSP stop_info_sp = GetPrivateStopReason();
+ if (stop_info_sp)
+ {
+ StopReason reason = stop_info_sp->GetStopReason();
+
+ switch (reason)
+ {
+ case eStopReasonBreakpoint:
+ if (NextRangeBreakpointExplainsStop(stop_info_sp))
+ return true;
+ else
+ return false;
+ break;
+ case eStopReasonWatchpoint:
+ case eStopReasonSignal:
+ case eStopReasonException:
+ if (log)
+ log->PutCString ("ThreadPlanStepInRange got asked if it explains the stop for some reason other than step.");
+ return false;
+ break;
+ default:
+ break;
+ }
+ }
+ return true;
+}
diff --git a/source/Target/ThreadPlanStepRange.cpp b/source/Target/ThreadPlanStepRange.cpp
index 113e459..91fc998 100644
--- a/source/Target/ThreadPlanStepRange.cpp
+++ b/source/Target/ThreadPlanStepRange.cpp
@@ -350,42 +350,6 @@
}
bool
-ThreadPlanStepRange::PlanExplainsStop ()
-{
- // We always explain a stop. Either we've just done a single step, in which
- // case we'll do our ordinary processing, or we stopped for some
- // reason that isn't handled by our sub-plans, in which case we want to just stop right
- // away.
-
- LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
- StopInfoSP stop_info_sp = GetPrivateStopReason();
- if (stop_info_sp)
- {
- StopReason reason = stop_info_sp->GetStopReason();
-
- switch (reason)
- {
- case eStopReasonBreakpoint:
- if (NextRangeBreakpointExplainsStop(stop_info_sp))
- return true;
- else
- return false;
- break;
- case eStopReasonWatchpoint:
- case eStopReasonSignal:
- case eStopReasonException:
- if (log)
- log->PutCString ("ThreadPlanStepInRange got asked if it explains the stop for some reason other than step.");
- SetPlanComplete();
- break;
- default:
- break;
- }
- }
- return true;
-}
-
-bool
ThreadPlanStepRange::WillStop ()
{
return true;