ThreadPlan.cpp revision 7c79a27b955432dfd3ad9439640f0af2eccf37b8 
1//===-- ThreadPlan.cpp ------------------------------------------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#include "lldb/lldb-python.h"
11
12#include "lldb/Target/ThreadPlan.h"
13
14// C Includes
15// C++ Includes
16// Other libraries and framework includes
17// Project includes
18#include "lldb/Core/Debugger.h"
19#include "lldb/Core/Log.h"
20#include "lldb/Core/State.h"
21#include "lldb/Target/RegisterContext.h"
22#include "lldb/Target/Thread.h"
23#include "lldb/Target/Process.h"
24#include "lldb/Target/Target.h"
25
26using namespace lldb;
27using namespace lldb_private;
28
29//----------------------------------------------------------------------
30// ThreadPlan constructor
31//----------------------------------------------------------------------
32ThreadPlan::ThreadPlan(ThreadPlanKind kind, const char *name, Thread &thread, Vote stop_vote, Vote run_vote) :
33    m_thread (thread),
34    m_stop_vote (stop_vote),
35    m_run_vote (run_vote),
36    m_kind (kind),
37    m_name (name),
38    m_plan_complete_mutex (Mutex::eMutexTypeRecursive),
39    m_cached_plan_explains_stop (eLazyBoolCalculate),
40    m_plan_complete (false),
41    m_plan_private (false),
42    m_okay_to_discard (true),
43    m_is_master_plan (false),
44    m_plan_succeeded(true)
45{
46    SetID (GetNextID());
47}
48
49//----------------------------------------------------------------------
50// Destructor
51//----------------------------------------------------------------------
52ThreadPlan::~ThreadPlan()
53{
54}
55
56bool
57ThreadPlan::PlanExplainsStop (Event *event_ptr)
58{
59    if (m_cached_plan_explains_stop == eLazyBoolCalculate)
60    {
61        bool actual_value = DoPlanExplainsStop(event_ptr);
62        m_cached_plan_explains_stop = actual_value ? eLazyBoolYes : eLazyBoolNo;
63        return actual_value;
64    }
65    else
66    {
67        return m_cached_plan_explains_stop == eLazyBoolYes;
68    }
69}
70
71bool
72ThreadPlan::IsPlanComplete ()
73{
74    Mutex::Locker locker(m_plan_complete_mutex);
75    return m_plan_complete;
76}
77
78void
79ThreadPlan::SetPlanComplete (bool success)
80{
81    Mutex::Locker locker(m_plan_complete_mutex);
82    m_plan_complete = true;
83    m_plan_succeeded = success;
84}
85
86bool
87ThreadPlan::MischiefManaged ()
88{
89    Mutex::Locker locker(m_plan_complete_mutex);
90    // Mark the plan is complete, but don't override the success flag.
91    m_plan_complete = true;
92    return true;
93}
94
95Vote
96ThreadPlan::ShouldReportStop (Event *event_ptr)
97{
98    Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
99
100    if (m_stop_vote == eVoteNoOpinion)
101    {
102        ThreadPlan *prev_plan = GetPreviousPlan ();
103        if (prev_plan)
104        {
105            Vote prev_vote = prev_plan->ShouldReportStop (event_ptr);
106            if (log)
107                log->Printf ("ThreadPlan::ShouldReportStop() returning previous thread plan vote: %s",
108                             GetVoteAsCString (prev_vote));
109            return prev_vote;
110        }
111    }
112    if (log)
113        log->Printf ("ThreadPlan::ShouldReportStop() returning vote: %s", GetVoteAsCString (m_stop_vote));
114    return m_stop_vote;
115}
116
117Vote
118ThreadPlan::ShouldReportRun (Event *event_ptr)
119{
120    if (m_run_vote == eVoteNoOpinion)
121    {
122        ThreadPlan *prev_plan = GetPreviousPlan ();
123        if (prev_plan)
124            return prev_plan->ShouldReportRun (event_ptr);
125    }
126    return m_run_vote;
127}
128
129bool
130ThreadPlan::StopOthers ()
131{
132    ThreadPlan *prev_plan;
133    prev_plan = GetPreviousPlan ();
134    if (prev_plan == NULL)
135        return false;
136    else
137        return prev_plan->StopOthers();
138}
139
140void
141ThreadPlan::SetStopOthers (bool new_value)
142{
143	// SetStopOthers doesn't work up the hierarchy.  You have to set the
144    // explicit ThreadPlan you want to affect.
145}
146
147bool
148ThreadPlan::WillResume (StateType resume_state, bool current_plan)
149{
150    m_cached_plan_explains_stop = eLazyBoolCalculate;
151
152    if (current_plan)
153    {
154        Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
155
156        if (log)
157        {
158            RegisterContext *reg_ctx = m_thread.GetRegisterContext().get();
159            addr_t pc = reg_ctx->GetPC();
160            addr_t sp = reg_ctx->GetSP();
161            addr_t fp = reg_ctx->GetFP();
162            log->Printf("%s Thread #%u: tid = 0x%4.4" PRIx64 ", pc = 0x%8.8" PRIx64 ", sp = 0x%8.8" PRIx64 ", fp = 0x%8.8" PRIx64 ", "
163                        "plan = '%s', state = %s, stop others = %d",
164                        __FUNCTION__,
165                        m_thread.GetIndexID(),
166                        m_thread.GetID(),
167                        (uint64_t)pc,
168                        (uint64_t)sp,
169                        (uint64_t)fp,
170                        m_name.c_str(),
171                        StateAsCString(resume_state),
172                        StopOthers());
173        }
174    }
175    return DoWillResume (resume_state, current_plan);
176}
177
178lldb::user_id_t
179ThreadPlan::GetNextID()
180{
181    static uint32_t g_nextPlanID = 0;
182    return ++g_nextPlanID;
183}
184
185void
186ThreadPlan::DidPush()
187{
188}
189
190void
191ThreadPlan::WillPop()
192{
193}
194
195bool
196ThreadPlan::OkayToDiscard()
197{
198    if (!IsMasterPlan())
199        return true;
200    else
201        return m_okay_to_discard;
202}
203
204lldb::StateType
205ThreadPlan::RunState ()
206{
207    if (m_tracer_sp && m_tracer_sp->TracingEnabled() && m_tracer_sp->SingleStepEnabled())
208        return eStateStepping;
209    else
210        return GetPlanRunState();
211}
212