Coverage Report

Created: 2022-01-18 06:27

/Users/buildslave/jenkins/workspace/coverage/llvm-project/lldb/include/lldb/Target/ThreadPlanStepOut.h
Line
Count
Source
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;
33
  lldb::StateType GetPlanRunState() override;
34
  bool WillStop() override;
35
  bool MischiefManaged() override;
36
  void DidPush() override;
37
  bool IsPlanStale() override;
38
39
203
  lldb::ValueObjectSP GetReturnValueObject() override {
40
203
    return m_return_valobj_sp;
41
203
  }
42
43
protected:
44
331
  void SetFlagsToDefault() override {
45
331
    GetFlags().Set(ThreadPlanStepOut::s_default_flag_values);
46
331
  }
47
48
  bool DoPlanExplainsStop(Event *event_ptr) override;
49
  bool DoWillResume(lldb::StateType resume_state, bool current_plan) override;
50
  bool QueueInlinedStepPlan(bool queue_now);
51
52
private:
53
  static uint32_t s_default_flag_values; // These are the default flag values
54
                                         // for the ThreadPlanStepThrough.
55
56
  lldb::addr_t m_step_from_insn;
57
  StackID m_step_out_to_id;
58
  StackID m_immediate_step_from_id;
59
  lldb::break_id_t m_return_bp_id;
60
  lldb::addr_t m_return_addr;
61
  bool m_stop_others;
62
  lldb::ThreadPlanSP m_step_out_to_inline_plan_sp; // This plan implements step
63
                                                   // out to the real function
64
                                                   // containing
65
  // an inlined frame so we can then step out of that.
66
  lldb::ThreadPlanSP m_step_through_inline_plan_sp; // This plan then steps past
67
                                                    // the inlined frame(s).
68
  lldb::ThreadPlanSP m_step_out_further_plan_sp; // This plan keeps stepping out
69
                                                 // if ShouldStopHere told us
70
                                                 // to.
71
  Function *m_immediate_step_from_function;
72
  std::vector<lldb::StackFrameSP> m_stepped_past_frames;
73
  lldb::ValueObjectSP m_return_valobj_sp;
74
  bool m_calculate_return_value;
75
  StreamString m_constructor_errors;
76
77
  friend lldb::ThreadPlanSP Thread::QueueThreadPlanForStepOut(
78
      bool abort_other_plans, SymbolContext *addr_context, bool first_insn,
79
      bool stop_others, Vote report_stop_vote, Vote report_run_vote,
80
      uint32_t frame_idx, Status &status,
81
      LazyBool step_out_avoids_code_without_debug_info);
82
83
  void SetupAvoidNoDebug(LazyBool step_out_avoids_code_without_debug_info);
84
  // Need an appropriate marker for the current stack so we can tell step out
85
  // from step in.
86
87
  void CalculateReturnValue();
88
89
  ThreadPlanStepOut(const ThreadPlanStepOut &) = delete;
90
  const ThreadPlanStepOut &operator=(const ThreadPlanStepOut &) = delete;
91
};
92
93
} // namespace lldb_private
94
95
#endif // LLDB_TARGET_THREADPLANSTEPOUT_H