1 //===-- ThreadPlanStepInstruction.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 //===----------------------------------------------------------------------===//
12 // Other libraries and framework includes
14 #include "lldb/Target/ThreadPlanStepInstruction.h"
15 #include "lldb/Target/Process.h"
16 #include "lldb/Target/RegisterContext.h"
17 #include "lldb/Target/RegisterContext.h"
18 #include "lldb/Target/StopInfo.h"
19 #include "lldb/Target/Target.h"
20 #include "lldb/Utility/Log.h"
21 #include "lldb/Utility/Stream.h"
24 using namespace lldb_private;
26 //----------------------------------------------------------------------
27 // ThreadPlanStepInstruction: Step over the current instruction
28 //----------------------------------------------------------------------
30 ThreadPlanStepInstruction::ThreadPlanStepInstruction(Thread &thread,
32 bool stop_other_threads,
35 : ThreadPlan(ThreadPlan::eKindStepInstruction,
36 "Step over single instruction", thread, stop_vote, run_vote),
37 m_instruction_addr(0), m_stop_other_threads(stop_other_threads),
38 m_step_over(step_over) {
39 m_takes_iteration_count = true;
43 ThreadPlanStepInstruction::~ThreadPlanStepInstruction() = default;
45 void ThreadPlanStepInstruction::SetUpState() {
46 m_instruction_addr = m_thread.GetRegisterContext()->GetPC(0);
47 StackFrameSP start_frame_sp(m_thread.GetStackFrameAtIndex(0));
48 m_stack_id = start_frame_sp->GetStackID();
51 start_frame_sp->GetSymbolContext(eSymbolContextSymbol).symbol != nullptr;
53 StackFrameSP parent_frame_sp = m_thread.GetStackFrameAtIndex(1);
55 m_parent_frame_id = parent_frame_sp->GetStackID();
58 void ThreadPlanStepInstruction::GetDescription(Stream *s,
59 lldb::DescriptionLevel level) {
60 if (level == lldb::eDescriptionLevelBrief) {
62 s->Printf("instruction step over");
64 s->Printf("instruction step into");
66 s->Printf("Stepping one instruction past ");
67 s->Address(m_instruction_addr, sizeof(addr_t));
68 if (!m_start_has_symbol)
69 s->Printf(" which has no symbol");
72 s->Printf(" stepping over calls");
74 s->Printf(" stepping into calls");
78 bool ThreadPlanStepInstruction::ValidatePlan(Stream *error) {
79 // Since we read the instruction we're stepping over from the thread,
80 // this plan will always work.
84 bool ThreadPlanStepInstruction::DoPlanExplainsStop(Event *event_ptr) {
85 StopInfoSP stop_info_sp = GetPrivateStopInfo();
87 StopReason reason = stop_info_sp->GetStopReason();
88 return (reason == eStopReasonTrace || reason == eStopReasonNone);
93 bool ThreadPlanStepInstruction::IsPlanStale() {
94 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP));
95 StackID cur_frame_id = m_thread.GetStackFrameAtIndex(0)->GetStackID();
96 if (cur_frame_id == m_stack_id) {
97 // Set plan Complete when we reach next instruction
98 uint64_t pc = m_thread.GetRegisterContext()->GetPC(0);
99 uint32_t max_opcode_size = m_thread.CalculateTarget()
100 ->GetArchitecture().GetMaximumOpcodeByteSize();
101 bool next_instruction_reached = (pc > m_instruction_addr) &&
102 (pc <= m_instruction_addr + max_opcode_size);
103 if (next_instruction_reached) {
106 return (m_thread.GetRegisterContext()->GetPC(0) != m_instruction_addr);
107 } else if (cur_frame_id < m_stack_id) {
108 // If the current frame is younger than the start frame and we are stepping
109 // over, then we need to continue,
110 // but if we are doing just one step, we're done.
114 log->Printf("ThreadPlanStepInstruction::IsPlanStale - Current frame is "
115 "older than start frame, plan is stale.");
121 bool ThreadPlanStepInstruction::ShouldStop(Event *event_ptr) {
123 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP));
125 StackFrameSP cur_frame_sp = m_thread.GetStackFrameAtIndex(0);
129 "ThreadPlanStepInstruction couldn't get the 0th frame, stopping.");
134 StackID cur_frame_zero_id = cur_frame_sp->GetStackID();
136 if (cur_frame_zero_id == m_stack_id || m_stack_id < cur_frame_zero_id) {
137 if (m_thread.GetRegisterContext()->GetPC(0) != m_instruction_addr) {
138 if (--m_iteration_count <= 0) {
142 // We are still stepping, reset the start pc, and in case we've
144 // reset the current stack id.
151 // We've stepped in, step back out again:
152 StackFrame *return_frame = m_thread.GetStackFrameAtIndex(1).get();
154 if (return_frame->GetStackID() != m_parent_frame_id ||
155 m_start_has_symbol) {
156 // next-instruction shouldn't step out of inlined functions. But we
157 // may have stepped into a
158 // real function that starts with an inlined function, and we do want
159 // to step out of that...
161 if (cur_frame_sp->IsInlined()) {
162 StackFrameSP parent_frame_sp =
163 m_thread.GetFrameWithStackID(m_stack_id);
165 if (parent_frame_sp &&
166 parent_frame_sp->GetConcreteFrameIndex() ==
167 cur_frame_sp->GetConcreteFrameIndex()) {
170 log->Printf("Frame we stepped into is inlined into the frame "
171 "we were stepping from, stopping.");
179 s.PutCString("Stepped in to: ");
181 m_thread.GetStackFrameAtIndex(0)->GetRegisterContext()->GetPC();
182 s.Address(stop_addr, m_thread.CalculateTarget()
184 .GetAddressByteSize());
185 s.PutCString(" stepping out to: ");
186 addr_t return_addr = return_frame->GetRegisterContext()->GetPC();
187 s.Address(return_addr, m_thread.CalculateTarget()
189 .GetAddressByteSize());
190 log->Printf("%s.", s.GetData());
193 // StepInstruction should probably have the tri-state RunMode, but for
194 // now it is safer to
196 const bool stop_others = false;
197 m_thread.QueueThreadPlanForStepOutNoShouldStop(
198 false, nullptr, true, stop_others, eVoteNo, eVoteNoOpinion, 0);
203 "The stack id we are stepping in changed, but our parent frame "
204 "did not when stepping from code with no symbols. "
205 "We are probably just confused about where we are, stopping.");
212 log->Printf("Could not find previous frame, stopping.");
218 lldb::addr_t pc_addr = m_thread.GetRegisterContext()->GetPC(0);
219 if (pc_addr != m_instruction_addr) {
220 if (--m_iteration_count <= 0) {
224 // We are still stepping, reset the start pc, and in case we've stepped
226 // reset the current stack id.
235 bool ThreadPlanStepInstruction::StopOthers() { return m_stop_other_threads; }
237 StateType ThreadPlanStepInstruction::GetPlanRunState() {
238 return eStateStepping;
241 bool ThreadPlanStepInstruction::WillStop() { return true; }
243 bool ThreadPlanStepInstruction::MischiefManaged() {
244 if (IsPlanComplete()) {
245 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP));
247 log->Printf("Completed single instruction step plan.");
248 ThreadPlan::MischiefManaged();