ThreadPlanStepOut.cpp revision 090f83176695d86197b0e86b67dee4160ec5003d
17935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert//===-- ThreadPlanStepOut.cpp -----------------------------------*- C++ -*-===// 27935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert// 3aacdd6f022693689b3bf76f70670711f3254a441Fredrik Roubert// The LLVM Compiler Infrastructure 4aacdd6f022693689b3bf76f70670711f3254a441Fredrik Roubert// 57935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert// This file is distributed under the University of Illinois Open Source 67935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert// License. See LICENSE.TXT for details. 77935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert// 87935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert//===----------------------------------------------------------------------===// 97935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 107935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/Target/ThreadPlanStepOut.h" 117935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 127935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert// C Includes 137935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert// C++ Includes 147935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert// Other libraries and framework includes 157935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert// Project includes 167935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/Breakpoint/Breakpoint.h" 177935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/lldb-private-log.h" 187935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/Core/Log.h" 197935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/Core/Value.h" 207935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/Core/ValueObjectConstResult.h" 217935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/Symbol/Block.h" 227935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/Symbol/Function.h" 237935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/Symbol/Type.h" 247935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/Target/Process.h" 257935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/Target/RegisterContext.h" 267935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/Target/StopInfo.h" 277935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/Target/Target.h" 287935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert#include "lldb/Target/ThreadPlanStepOverRange.h" 297935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 307935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubertusing namespace lldb; 317935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubertusing namespace lldb_private; 327935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 337935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert//---------------------------------------------------------------------- 347935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert// ThreadPlanStepOut: Step out of the current frame 357935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert//---------------------------------------------------------------------- 367935b1839a081ed19ae0d33029ad3c09632a2caaFredrik RoubertThreadPlanStepOut::ThreadPlanStepOut 377935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert( 387935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert Thread &thread, 397935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert SymbolContext *context, 407935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert bool first_insn, 417935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert bool stop_others, 427935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert Vote stop_vote, 437935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert Vote run_vote, 447935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert uint32_t frame_idx 457935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert) : 467935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert ThreadPlan (ThreadPlan::eKindStepOut, "Step out", thread, stop_vote, run_vote), 477935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_step_from_context (context), 487935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_step_from_insn (LLDB_INVALID_ADDRESS), 497935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_return_bp_id (LLDB_INVALID_BREAK_ID), 507935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_return_addr (LLDB_INVALID_ADDRESS), 517935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_first_insn (first_insn), 527935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_stop_others (stop_others), 537935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_step_through_inline_plan_sp(), 547935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_step_out_plan_sp (), 557935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_immediate_step_from_function(NULL) 567935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 577935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert{ 587935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_step_from_insn = m_thread.GetRegisterContext()->GetPC(0); 597935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 607935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert StackFrameSP return_frame_sp (m_thread.GetStackFrameAtIndex(frame_idx + 1)); 617935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert StackFrameSP immediate_return_from_sp (m_thread.GetStackFrameAtIndex (frame_idx)); 627935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 637935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (!return_frame_sp || !immediate_return_from_sp) 647935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert return; // we can't do anything here. ValidatePlan() will return false. 657935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 667935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_step_out_to_id = return_frame_sp->GetStackID(); 677935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_immediate_step_from_id = immediate_return_from_sp->GetStackID(); 687935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 697935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert StackID frame_zero_id = m_thread.GetStackFrameAtIndex(0)->GetStackID(); 707935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 717935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // If the frame directly below the one we are returning to is inlined, we have to be 727935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // a little more careful. It is non-trivial to determine the real "return code address" for 737935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // an inlined frame, so we have to work our way to that frame and then step out. 747935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (immediate_return_from_sp && immediate_return_from_sp->IsInlined()) 757935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 767935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (frame_idx > 0) 777935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 787935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // First queue a plan that gets us to this inlined frame, and when we get there we'll queue a second 797935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // plan that walks us out of this frame. 807935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_step_out_plan_sp.reset (new ThreadPlanStepOut(m_thread, 817935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert NULL, 827935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert false, 837935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert stop_others, 847935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert eVoteNoOpinion, 857935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert eVoteNoOpinion, 867935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert frame_idx - 1)); 877935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 887935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert else 897935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 907935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // If we're already at the inlined frame we're stepping through, then just do that now. 917935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert QueueInlinedStepPlan(false); 927935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 937935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 947935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 957935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert else if (return_frame_sp) 967935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 977935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // Find the return address and set a breakpoint there: 987935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // FIXME - can we do this more securely if we know first_insn? 997935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 1007935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_return_addr = return_frame_sp->GetFrameCodeAddress().GetLoadAddress(&m_thread.GetProcess()->GetTarget()); 1017935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 1027935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (m_return_addr == LLDB_INVALID_ADDRESS) 1037935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert return; 1047935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 1057935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert Breakpoint *return_bp = m_thread.CalculateTarget()->CreateBreakpoint (m_return_addr, true).get(); 1067935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (return_bp != NULL) 1077935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 1087935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert return_bp->SetThreadID(m_thread.GetID()); 1097935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_return_bp_id = return_bp->GetID(); 1107935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert return_bp->SetBreakpointKind ("step-out"); 1117935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 1127935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 1137935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (immediate_return_from_sp) 1147935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 1157935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert const SymbolContext &sc = immediate_return_from_sp->GetSymbolContext(eSymbolContextFunction); 1167935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (sc.function) 1177935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 1187935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_immediate_step_from_function = sc.function; 1197935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 1207935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 1217935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 1227935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 1237935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert} 1247935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 1257935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubertvoid 1267935b1839a081ed19ae0d33029ad3c09632a2caaFredrik RoubertThreadPlanStepOut::DidPush() 1277935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert{ 1287935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (m_step_out_plan_sp) 1297935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_thread.QueueThreadPlan(m_step_out_plan_sp, false); 1307935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert else if (m_step_through_inline_plan_sp) 1317935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_thread.QueueThreadPlan(m_step_through_inline_plan_sp, false); 1327935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert} 1337935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 1347935b1839a081ed19ae0d33029ad3c09632a2caaFredrik RoubertThreadPlanStepOut::~ThreadPlanStepOut () 1357935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert{ 1367935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (m_return_bp_id != LLDB_INVALID_BREAK_ID) 1377935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_thread.CalculateTarget()->RemoveBreakpointByID(m_return_bp_id); 1387935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert} 1397935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 1407935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubertvoid 1417935b1839a081ed19ae0d33029ad3c09632a2caaFredrik RoubertThreadPlanStepOut::GetDescription (Stream *s, lldb::DescriptionLevel level) 1427935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert{ 1437935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (level == lldb::eDescriptionLevelBrief) 1447935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert s->Printf ("step out"); 1457935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert else 1467935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 1477935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (m_step_out_plan_sp) 1487935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert s->Printf ("Stepping out to inlined frame so we can walk through it."); 1497935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert else if (m_step_through_inline_plan_sp) 1507935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert s->Printf ("Stepping out by stepping through inlined function."); 1517935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert else 1527935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert s->Printf ("Stepping out from address 0x%" PRIx64 " to return address 0x%" PRIx64 " using breakpoint site %d", 1537935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert (uint64_t)m_step_from_insn, 1547935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert (uint64_t)m_return_addr, 1557935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert m_return_bp_id); 1567935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 1577935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert} 1587935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 1597935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubertbool 1607935b1839a081ed19ae0d33029ad3c09632a2caaFredrik RoubertThreadPlanStepOut::ValidatePlan (Stream *error) 1617935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert{ 1627935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (m_step_out_plan_sp) 1637935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert return m_step_out_plan_sp->ValidatePlan (error); 1647935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert else if (m_step_through_inline_plan_sp) 1657935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert return m_step_through_inline_plan_sp->ValidatePlan (error); 1667935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert else if (m_return_bp_id == LLDB_INVALID_BREAK_ID) 1677935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 1687935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (error) 1697935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert error->PutCString("Could not create return address breakpoint."); 1707935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert return false; 1717935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 1727935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert else 173aacdd6f022693689b3bf76f70670711f3254a441Fredrik Roubert return true; 174aacdd6f022693689b3bf76f70670711f3254a441Fredrik Roubert} 175aacdd6f022693689b3bf76f70670711f3254a441Fredrik Roubert 176aacdd6f022693689b3bf76f70670711f3254a441Fredrik Roubertbool 177aacdd6f022693689b3bf76f70670711f3254a441Fredrik RoubertThreadPlanStepOut::PlanExplainsStop () 178aacdd6f022693689b3bf76f70670711f3254a441Fredrik Roubert{ 1797935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // If one of our child plans just finished, then we do explain the stop. 1807935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (m_step_out_plan_sp) 1817935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 1827935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (m_step_out_plan_sp->MischiefManaged()) 1837935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 1847935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // If this one is done, then we are all done. 1857935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert CalculateReturnValue(); 1867935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert SetPlanComplete(); 1877935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert return true; 1887935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 1897935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert else 1907935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert return false; 1917935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 1927935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert else if (m_step_through_inline_plan_sp) 1937935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 1947935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (m_step_through_inline_plan_sp->MischiefManaged()) 1957935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert return true; 1967935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert else 1977935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert return false; 1987935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert } 1997935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 2007935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // We don't explain signals or breakpoints (breakpoints that handle stepping in or 2017935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // out will be handled by a child plan. 2027935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 2037935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert StopInfoSP stop_info_sp = GetPrivateStopReason(); 2047935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (stop_info_sp) 2057935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 2067935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert StopReason reason = stop_info_sp->GetStopReason(); 2077935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert switch (reason) 2087935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 2097935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert case eStopReasonBreakpoint: 2107935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 2117935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert // If this is OUR breakpoint, we're fine, otherwise we don't know why this happened... 2127935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert BreakpointSiteSP site_sp (m_thread.GetProcess()->GetBreakpointSiteList().FindByID (stop_info_sp->GetValue())); 2137935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (site_sp && site_sp->IsBreakpointAtThisSite (m_return_bp_id)) 2147935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 2157935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert bool done; 2167935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 2177935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert StackID frame_zero_id = m_thread.GetStackFrameAtIndex(0)->GetStackID(); 2187935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert 2197935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert if (m_step_out_to_id == frame_zero_id) 2207935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert done = true; 2217935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert else if (m_step_out_to_id < frame_zero_id) 2227935b1839a081ed19ae0d33029ad3c09632a2caaFredrik Roubert { 223 // Either we stepped past the breakpoint, or the stack ID calculation 224 // was incorrect and we should probably stop. 225 done = true; 226 } 227 else 228 { 229 if (m_immediate_step_from_id < frame_zero_id) 230 done = true; 231 else 232 done = false; 233 } 234 235 if (done) 236 { 237 CalculateReturnValue(); 238 SetPlanComplete(); 239 } 240 241 // If there was only one owner, then we're done. But if we also hit some 242 // user breakpoint on our way out, we should mark ourselves as done, but 243 // also not claim to explain the stop, since it is more important to report 244 // the user breakpoint than the step out completion. 245 246 if (site_sp->GetNumberOfOwners() == 1) 247 return true; 248 249 } 250 return false; 251 } 252 case eStopReasonWatchpoint: 253 case eStopReasonSignal: 254 case eStopReasonException: 255 case eStopReasonExec: 256 case eStopReasonThreadExiting: 257 return false; 258 259 default: 260 return true; 261 } 262 } 263 return true; 264} 265 266bool 267ThreadPlanStepOut::ShouldStop (Event *event_ptr) 268{ 269 if (IsPlanComplete()) 270 return true; 271 272 bool done; 273 274 StackID frame_zero_id = m_thread.GetStackFrameAtIndex(0)->GetStackID(); 275 if (frame_zero_id < m_step_out_to_id) 276 done = false; 277 else 278 done = true; 279 280 if (done) 281 { 282 CalculateReturnValue(); 283 SetPlanComplete(); 284 return true; 285 } 286 else 287 { 288 if (m_step_out_plan_sp) 289 { 290 if (m_step_out_plan_sp->MischiefManaged()) 291 { 292 // Now step through the inlined stack we are in: 293 if (QueueInlinedStepPlan(true)) 294 { 295 return false; 296 } 297 else 298 { 299 CalculateReturnValue(); 300 SetPlanComplete (); 301 return true; 302 } 303 } 304 else 305 return m_step_out_plan_sp->ShouldStop(event_ptr); 306 } 307 else if (m_step_through_inline_plan_sp) 308 { 309 if (m_step_through_inline_plan_sp->MischiefManaged()) 310 { 311 // We don't calculate the return value here because we don't know how to. 312 // But in case we had a return value sitting around from our process in 313 // getting here, let's clear it out. 314 m_return_valobj_sp.reset(); 315 SetPlanComplete(); 316 return true; 317 } 318 else 319 return m_step_through_inline_plan_sp->ShouldStop(event_ptr); 320 } 321 else 322 return false; 323 } 324} 325 326bool 327ThreadPlanStepOut::StopOthers () 328{ 329 return m_stop_others; 330} 331 332StateType 333ThreadPlanStepOut::GetPlanRunState () 334{ 335 return eStateRunning; 336} 337 338bool 339ThreadPlanStepOut::WillResume (StateType resume_state, bool current_plan) 340{ 341 ThreadPlan::WillResume (resume_state, current_plan); 342 if (m_step_out_plan_sp || m_step_through_inline_plan_sp) 343 return true; 344 345 if (m_return_bp_id == LLDB_INVALID_BREAK_ID) 346 return false; 347 348 if (current_plan) 349 { 350 Breakpoint *return_bp = m_thread.CalculateTarget()->GetBreakpointByID(m_return_bp_id).get(); 351 if (return_bp != NULL) 352 return_bp->SetEnabled (true); 353 } 354 return true; 355} 356 357bool 358ThreadPlanStepOut::WillStop () 359{ 360 if (m_return_bp_id != LLDB_INVALID_BREAK_ID) 361 { 362 Breakpoint *return_bp = m_thread.CalculateTarget()->GetBreakpointByID(m_return_bp_id).get(); 363 if (return_bp != NULL) 364 return_bp->SetEnabled (false); 365 } 366 367 return true; 368} 369 370bool 371ThreadPlanStepOut::MischiefManaged () 372{ 373 if (IsPlanComplete()) 374 { 375 // Did I reach my breakpoint? If so I'm done. 376 // 377 // I also check the stack depth, since if we've blown past the breakpoint for some 378 // reason and we're now stopping for some other reason altogether, then we're done 379 // with this step out operation. 380 381 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP)); 382 if (log) 383 log->Printf("Completed step out plan."); 384 if (m_return_bp_id != LLDB_INVALID_BREAK_ID) 385 { 386 m_thread.CalculateTarget()->RemoveBreakpointByID (m_return_bp_id); 387 m_return_bp_id = LLDB_INVALID_BREAK_ID; 388 } 389 390 ThreadPlan::MischiefManaged (); 391 return true; 392 } 393 else 394 { 395 return false; 396 } 397} 398 399bool 400ThreadPlanStepOut::QueueInlinedStepPlan (bool queue_now) 401{ 402 // Now figure out the range of this inlined block, and set up a "step through range" 403 // plan for that. If we've been provided with a context, then use the block in that 404 // context. 405 StackFrameSP immediate_return_from_sp (m_thread.GetStackFrameAtIndex (0)); 406 if (!immediate_return_from_sp) 407 return false; 408 409 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP)); 410 if (log) 411 { 412 StreamString s; 413 immediate_return_from_sp->Dump(&s, true, false); 414 log->Printf("Queuing inlined frame to step past: %s.", s.GetData()); 415 } 416 417 Block *from_block = immediate_return_from_sp->GetFrameBlock(); 418 if (from_block) 419 { 420 Block *inlined_block = from_block->GetContainingInlinedBlock(); 421 if (inlined_block) 422 { 423 size_t num_ranges = inlined_block->GetNumRanges(); 424 AddressRange inline_range; 425 if (inlined_block->GetRangeAtIndex(0, inline_range)) 426 { 427 SymbolContext inlined_sc; 428 inlined_block->CalculateSymbolContext(&inlined_sc); 429 inlined_sc.target_sp = GetTarget().shared_from_this(); 430 RunMode run_mode = m_stop_others ? lldb::eOnlyThisThread : lldb::eAllThreads; 431 ThreadPlanStepOverRange *step_through_inline_plan_ptr = new ThreadPlanStepOverRange(m_thread, 432 inline_range, 433 inlined_sc, 434 run_mode); 435 step_through_inline_plan_ptr->SetOkayToDiscard(true); 436 StreamString errors; 437 if (!step_through_inline_plan_ptr->ValidatePlan(&errors)) 438 { 439 //FIXME: Log this failure. 440 delete step_through_inline_plan_ptr; 441 return false; 442 } 443 444 for (size_t i = 1; i < num_ranges; i++) 445 { 446 if (inlined_block->GetRangeAtIndex (i, inline_range)) 447 step_through_inline_plan_ptr->AddRange (inline_range); 448 } 449 m_step_through_inline_plan_sp.reset (step_through_inline_plan_ptr); 450 if (queue_now) 451 m_thread.QueueThreadPlan (m_step_through_inline_plan_sp, false); 452 return true; 453 } 454 } 455 } 456 457 return false; 458} 459 460void 461ThreadPlanStepOut::CalculateReturnValue () 462{ 463 if (m_return_valobj_sp) 464 return; 465 466 if (m_immediate_step_from_function != NULL) 467 { 468 Type *return_type = m_immediate_step_from_function->GetType(); 469 lldb::clang_type_t return_clang_type = m_immediate_step_from_function->GetReturnClangType(); 470 if (return_type && return_clang_type) 471 { 472 ClangASTType ast_type (return_type->GetClangAST(), return_clang_type); 473 474 lldb::ABISP abi_sp = m_thread.GetProcess()->GetABI(); 475 if (abi_sp) 476 { 477 m_return_valobj_sp = abi_sp->GetReturnValueObject(m_thread, ast_type); 478 } 479 } 480 } 481} 482 483bool 484ThreadPlanStepOut::IsPlanStale() 485{ 486 // If we are still lower on the stack than the frame we are returning to, then 487 // there's something for us to do. Otherwise, we're stale. 488 489 StackID frame_zero_id = m_thread.GetStackFrameAtIndex(0)->GetStackID(); 490 if (frame_zero_id < m_step_out_to_id) 491 return false; 492 else 493 return true; 494} 495 496