aboutsummaryrefslogtreecommitdiff
path: root/lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleThreadPlanStepThroughObjCTrampoline.h
blob: 89aed89f1ab15ee326100812350d6ab7ab9eb20a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
//===-- AppleThreadPlanStepThroughObjCTrampoline.h --------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef LLDB_SOURCE_PLUGINS_LANGUAGERUNTIME_OBJC_APPLEOBJCRUNTIME_APPLETHREADPLANSTEPTHROUGHOBJCTRAMPOLINE_H
#define LLDB_SOURCE_PLUGINS_LANGUAGERUNTIME_OBJC_APPLEOBJCRUNTIME_APPLETHREADPLANSTEPTHROUGHOBJCTRAMPOLINE_H

#include "AppleObjCTrampolineHandler.h"
#include "lldb/Core/Value.h"
#include "lldb/Target/ThreadPlan.h"
#include "lldb/Target/ThreadPlanStepInRange.h"
#include "lldb/Target/ThreadPlanStepOut.h"
#include "lldb/Target/ThreadPlanShouldStopHere.h"
#include "lldb/lldb-enumerations.h"
#include "lldb/lldb-types.h"

namespace lldb_private {

class AppleThreadPlanStepThroughObjCTrampoline : public ThreadPlan {
public:
  AppleThreadPlanStepThroughObjCTrampoline(
      Thread &thread, AppleObjCTrampolineHandler &trampoline_handler,
      ValueList &values, lldb::addr_t isa_addr, lldb::addr_t sel_addr,
      bool stop_others);

  ~AppleThreadPlanStepThroughObjCTrampoline() override;

  static bool PreResumeInitializeFunctionCaller(void *myself);

  void GetDescription(Stream *s, lldb::DescriptionLevel level) override;

  bool ValidatePlan(Stream *error) override;

  lldb::StateType GetPlanRunState() override;

  bool ShouldStop(Event *event_ptr) override;

  bool StopOthers() override { return m_stop_others; }

  // The base class MischiefManaged does some cleanup - so you have to call it
  // in your MischiefManaged derived class.
  bool MischiefManaged() override;

  void DidPush() override;

  bool WillStop() override;

protected:
  bool DoPlanExplainsStop(Event *event_ptr) override;

private:
  bool InitializeFunctionCaller();

  AppleObjCTrampolineHandler &m_trampoline_handler; /// The handler itself.
  lldb::addr_t m_args_addr; /// Stores the address for our step through function
                            /// result structure.
  ValueList m_input_values;
  lldb::addr_t m_isa_addr; /// isa_addr and sel_addr are the keys we will use to
                           /// cache the implementation.
  lldb::addr_t m_sel_addr;
  lldb::ThreadPlanSP m_func_sp; /// This is the function call plan.  We fill it
                                /// at start, then set it to NULL when this plan
                                /// is done.  That way we know to go on to:
  lldb::ThreadPlanSP m_run_to_sp;  /// The plan that runs to the target.
  FunctionCaller *m_impl_function; /// This is a pointer to a impl function that
                                   /// is owned by the client that pushes this
                                   /// plan.
  bool m_stop_others;  /// Whether we should stop other threads.
};

class AppleThreadPlanStepThroughDirectDispatch: public ThreadPlanStepOut {
public:
  AppleThreadPlanStepThroughDirectDispatch(
      Thread &thread, AppleObjCTrampolineHandler &handler,
      llvm::StringRef dispatch_func_name, bool stop_others,
      LazyBool step_in_avoids_code_without_debug_info);

  ~AppleThreadPlanStepThroughDirectDispatch() override;

  void GetDescription(Stream *s, lldb::DescriptionLevel level) override;

  bool ShouldStop(Event *event_ptr) override;

  bool StopOthers() override { return m_stop_others; }

  bool MischiefManaged() override;

  bool DoWillResume(lldb::StateType resume_state, bool current_plan) override;

  void SetFlagsToDefault() override {
          GetFlags().Set(ThreadPlanStepInRange::GetDefaultFlagsValue());
  }

protected:
  bool DoPlanExplainsStop(Event *event_ptr) override;

  AppleObjCTrampolineHandler &m_trampoline_handler;
  std::string m_dispatch_func_name;  /// Which dispatch function we're stepping
                                     /// through.
  lldb::ThreadPlanSP m_objc_step_through_sp; /// When we hit an objc_msgSend,
                                             /// we'll use this plan to get to
                                             /// its target.
  std::vector<lldb::BreakpointSP> m_msgSend_bkpts; /// Breakpoints on the objc
                                                   /// dispatch functions.
  bool m_at_msg_send;  /// Are we currently handling an msg_send
  bool m_stop_others;  /// Whether we should stop other threads.

};

} // namespace lldb_private

#endif // LLDB_SOURCE_PLUGINS_LANGUAGERUNTIME_OBJC_APPLEOBJCRUNTIME_APPLETHREADPLANSTEPTHROUGHOBJCTRAMPOLINE_H