1 //===-- ThreadPlanStepOut.h -------------------------------------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #ifndef LLDB_TARGET_THREADPLANSTEPOUT_H 10 #define LLDB_TARGET_THREADPLANSTEPOUT_H 11 12 #include "lldb/Target/Thread.h" 13 #include "lldb/Target/ThreadPlan.h" 14 #include "lldb/Target/ThreadPlanShouldStopHere.h" 15 16 namespace lldb_private { 17 18 class ThreadPlanStepOut : public ThreadPlan, public ThreadPlanShouldStopHere { 19 public: 20 ThreadPlanStepOut(Thread &thread, SymbolContext *addr_context, 21 bool first_insn, bool stop_others, Vote report_stop_vote, 22 Vote report_run_vote, uint32_t frame_idx, 23 LazyBool step_out_avoids_code_without_debug_info, 24 bool continue_to_next_branch = false, 25 bool gather_return_value = true); 26 27 ~ThreadPlanStepOut() override; 28 29 void GetDescription(Stream *s, lldb::DescriptionLevel level) override; 30 bool ValidatePlan(Stream *error) override; 31 bool ShouldStop(Event *event_ptr) override; 32 bool StopOthers() override; SetStopOthers(bool new_value)33 void SetStopOthers(bool new_value) override { m_stop_others = new_value; } 34 lldb::StateType GetPlanRunState() override; 35 bool WillStop() override; 36 bool MischiefManaged() override; 37 void DidPush() override; 38 bool IsPlanStale() override; 39 GetReturnValueObject()40 lldb::ValueObjectSP GetReturnValueObject() override { 41 return m_return_valobj_sp; 42 } 43 44 protected: SetFlagsToDefault()45 void SetFlagsToDefault() override { 46 GetFlags().Set(ThreadPlanStepOut::s_default_flag_values); 47 } 48 49 bool DoPlanExplainsStop(Event *event_ptr) override; 50 bool DoWillResume(lldb::StateType resume_state, bool current_plan) override; 51 bool QueueInlinedStepPlan(bool queue_now); 52 53 private: 54 static uint32_t s_default_flag_values; // These are the default flag values 55 // for the ThreadPlanStepThrough. 56 57 lldb::addr_t m_step_from_insn; 58 StackID m_step_out_to_id; 59 StackID m_immediate_step_from_id; 60 lldb::break_id_t m_return_bp_id; 61 lldb::addr_t m_return_addr; 62 bool m_stop_others; 63 lldb::ThreadPlanSP m_step_out_to_inline_plan_sp; // This plan implements step 64 // out to the real function 65 // containing 66 // an inlined frame so we can then step out of that. 67 lldb::ThreadPlanSP m_step_through_inline_plan_sp; // This plan then steps past 68 // the inlined frame(s). 69 lldb::ThreadPlanSP m_step_out_further_plan_sp; // This plan keeps stepping out 70 // if ShouldStopHere told us 71 // to. 72 Function *m_immediate_step_from_function; 73 std::vector<lldb::StackFrameSP> m_stepped_past_frames; 74 lldb::ValueObjectSP m_return_valobj_sp; 75 bool m_calculate_return_value; 76 StreamString m_constructor_errors; 77 78 friend lldb::ThreadPlanSP Thread::QueueThreadPlanForStepOut( 79 bool abort_other_plans, SymbolContext *addr_context, bool first_insn, 80 bool stop_others, Vote report_stop_vote, Vote report_run_vote, 81 uint32_t frame_idx, Status &status, 82 LazyBool step_out_avoids_code_without_debug_info); 83 84 void SetupAvoidNoDebug(LazyBool step_out_avoids_code_without_debug_info); 85 // Need an appropriate marker for the current stack so we can tell step out 86 // from step in. 87 88 void CalculateReturnValue(); 89 90 ThreadPlanStepOut(const ThreadPlanStepOut &) = delete; 91 const ThreadPlanStepOut &operator=(const ThreadPlanStepOut &) = delete; 92 }; 93 94 } // namespace lldb_private 95 96 #endif // LLDB_TARGET_THREADPLANSTEPOUT_H 97