LLDB  mainline
DynamicLoaderPOSIXDYLD.h
Go to the documentation of this file.
1 //===-- DynamicLoaderPOSIXDYLD.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_SOURCE_PLUGINS_DYNAMICLOADER_POSIX_DYLD_DYNAMICLOADERPOSIXDYLD_H
10 #define LLDB_SOURCE_PLUGINS_DYNAMICLOADER_POSIX_DYLD_DYNAMICLOADERPOSIXDYLD_H
11 
12 #include <map>
13 #include <memory>
14 
15 #include "DYLDRendezvous.h"
18 #include "lldb/Core/ModuleList.h"
20 
21 class AuxVector;
22 
24 public:
26 
27  ~DynamicLoaderPOSIXDYLD() override;
28 
29  static void Initialize();
30 
31  static void Terminate();
32 
34 
35  static const char *GetPluginDescriptionStatic();
36 
38  CreateInstance(lldb_private::Process *process, bool force);
39 
40  // DynamicLoader protocol
41 
42  void DidAttach() override;
43 
44  void DidLaunch() override;
45 
46  lldb::ThreadPlanSP GetStepThroughTrampolinePlan(lldb_private::Thread &thread,
47  bool stop_others) override;
48 
50 
51  lldb::addr_t GetThreadLocalData(const lldb::ModuleSP module,
52  const lldb::ThreadSP thread,
53  lldb::addr_t tls_file_addr) override;
54 
55  // PluginInterface protocol
56  llvm::StringRef GetPluginName() override {
58  }
59 
60 protected:
61  /// Runtime linker rendezvous structure.
63 
64  /// Virtual load address of the inferior process.
66 
67  /// Virtual entry address of the inferior process.
69 
70  /// Auxiliary vector of the inferior process.
71  std::unique_ptr<AuxVector> m_auxv;
72 
73  /// Rendezvous breakpoint.
75 
76  /// Contains AT_SYSINFO_EHDR, which means a vDSO has been
77  /// mapped to the address space
79 
80  /// Contains AT_BASE, which means a dynamic loader has been
81  /// mapped to the address space
83 
84  /// Contains the pointer to the interpret module, if loaded.
85  std::weak_ptr<lldb_private::Module> m_interpreter_module;
86 
87  /// Loaded module list. (link map for each module)
88  std::map<lldb::ModuleWP, lldb::addr_t, std::owner_less<lldb::ModuleWP>>
90 
91  /// If possible sets a breakpoint on a function called by the runtime
92  /// linker each time a module is loaded or unloaded.
94 
95  /// Callback routine which updates the current list of loaded modules based
96  /// on the information supplied by the runtime linker.
97  static bool RendezvousBreakpointHit(
98  void *baton, lldb_private::StoppointCallbackContext *context,
99  lldb::user_id_t break_id, lldb::user_id_t break_loc_id);
100 
101  /// Indicates whether the initial set of modules was reported added.
103 
104  /// Helper method for RendezvousBreakpointHit. Updates LLDB's current set
105  /// of loaded modules.
106  void RefreshModules();
107 
108  /// Updates the load address of every allocatable section in \p module.
109  ///
110  /// \param module The module to traverse.
111  ///
112  /// \param link_map_addr The virtual address of the link map for the @p
113  /// module.
114  ///
115  /// \param base_addr The virtual base address \p module is loaded at.
116  void UpdateLoadedSections(lldb::ModuleSP module, lldb::addr_t link_map_addr,
117  lldb::addr_t base_addr,
118  bool base_addr_is_offset) override;
119 
120  /// Removes the loaded sections from the target in \p module.
121  ///
122  /// \param module The module to traverse.
123  void UnloadSections(const lldb::ModuleSP module) override;
124 
125  /// Resolves the entry point for the current inferior process and sets a
126  /// breakpoint at that address.
127  void ProbeEntry();
128 
129  /// Callback routine invoked when we hit the breakpoint on process entry.
130  ///
131  /// This routine is responsible for resolving the load addresses of all
132  /// dependent modules required by the inferior and setting up the rendezvous
133  /// breakpoint.
134  static bool
135  EntryBreakpointHit(void *baton,
137  lldb::user_id_t break_id, lldb::user_id_t break_loc_id);
138 
139  /// Helper for the entry breakpoint callback. Resolves the load addresses
140  /// of all dependent modules.
141  virtual void LoadAllCurrentModules();
142 
143  void LoadVDSO();
144 
145  // Loading an interpreter module (if present) assuming m_interpreter_base
146  // already points to its base address.
147  lldb::ModuleSP LoadInterpreterModule();
148 
149  /// Computes a value for m_load_offset returning the computed address on
150  /// success and LLDB_INVALID_ADDRESS on failure.
152 
153  /// Computes a value for m_entry_point returning the computed address on
154  /// success and LLDB_INVALID_ADDRESS on failure.
156 
157  /// Evaluate if Aux vectors contain vDSO and LD information
158  /// in case they do, read and assign the address to m_vdso_base
159  /// and m_interpreter_base.
161 
162  /// Loads Module from inferior process.
163  void ResolveExecutableModule(lldb::ModuleSP &module_sp);
164 
166 
167 private:
169  const DynamicLoaderPOSIXDYLD &
170  operator=(const DynamicLoaderPOSIXDYLD &) = delete;
171 };
172 
173 #endif // LLDB_SOURCE_PLUGINS_DYNAMICLOADER_POSIX_DYLD_DYNAMICLOADERPOSIXDYLD_H
DynamicLoaderPOSIXDYLD::DidLaunch
void DidLaunch() override
Called after launching a process.
Definition: DynamicLoaderPOSIXDYLD.cpp:173
lldb_private::StoppointCallbackContext
General Outline: When we hit a breakpoint we need to package up whatever information is needed to eva...
Definition: StoppointCallbackContext.h:26
DynamicLoaderPOSIXDYLD::m_initial_modules_added
bool m_initial_modules_added
Indicates whether the initial set of modules was reported added.
Definition: DynamicLoaderPOSIXDYLD.h:102
DynamicLoaderPOSIXDYLD::Terminate
static void Terminate()
Definition: DynamicLoaderPOSIXDYLD.cpp:39
DynamicLoaderPOSIXDYLD::GetEntryPoint
lldb::addr_t GetEntryPoint()
Computes a value for m_entry_point returning the computed address on success and LLDB_INVALID_ADDRESS...
Definition: DynamicLoaderPOSIXDYLD.cpp:669
DynamicLoaderPOSIXDYLD::m_load_offset
lldb::addr_t m_load_offset
Virtual load address of the inferior process.
Definition: DynamicLoaderPOSIXDYLD.h:65
lldb_private::Process
Definition: Process.h:340
StoppointCallbackContext.h
DynamicLoaderPOSIXDYLD
Definition: DynamicLoaderPOSIXDYLD.h:23
lldb::addr_t
uint64_t addr_t
Definition: lldb-types.h:83
DynamicLoaderPOSIXDYLD::RefreshModules
void RefreshModules()
Helper method for RendezvousBreakpointHit.
Definition: DynamicLoaderPOSIXDYLD.cpp:417
lldb_private::SymbolContext
Definition: SymbolContext.h:33
DynamicLoaderPOSIXDYLD::LoadVDSO
void LoadVDSO()
Definition: DynamicLoaderPOSIXDYLD.cpp:538
ModuleList.h
lldb_private::ConstString::GetStringRef
llvm::StringRef GetStringRef() const
Get the string value as a llvm::StringRef.
Definition: ConstString.h:202
AuxVector
Definition: AuxVector.h:16
lldb_private::Thread
Definition: Thread.h:60
AuxVector.h
DynamicLoaderPOSIXDYLD::m_loaded_modules
std::map< lldb::ModuleWP, lldb::addr_t, std::owner_less< lldb::ModuleWP > > m_loaded_modules
Loaded module list. (link map for each module)
Definition: DynamicLoaderPOSIXDYLD.h:89
DynamicLoaderPOSIXDYLD::m_interpreter_base
lldb::addr_t m_interpreter_base
Contains AT_BASE, which means a dynamic loader has been mapped to the address space.
Definition: DynamicLoaderPOSIXDYLD.h:82
DynamicLoaderPOSIXDYLD::operator=
const DynamicLoaderPOSIXDYLD & operator=(const DynamicLoaderPOSIXDYLD &)=delete
lldb::break_id_t
int32_t break_id_t
Definition: lldb-types.h:88
DynamicLoaderPOSIXDYLD::m_vdso_base
lldb::addr_t m_vdso_base
Contains AT_SYSINFO_EHDR, which means a vDSO has been mapped to the address space.
Definition: DynamicLoaderPOSIXDYLD.h:78
lldb_private::ConstString
Definition: ConstString.h:40
DynamicLoaderPOSIXDYLD::EntryBreakpointHit
static bool EntryBreakpointHit(void *baton, lldb_private::StoppointCallbackContext *context, lldb::user_id_t break_id, lldb::user_id_t break_loc_id)
Callback routine invoked when we hit the breakpoint on process entry.
Definition: DynamicLoaderPOSIXDYLD.cpp:258
DynamicLoaderPOSIXDYLD::Initialize
static void Initialize()
Definition: DynamicLoaderPOSIXDYLD.cpp:34
DynamicLoaderPOSIXDYLD::DynamicLoaderPOSIXDYLD
DynamicLoaderPOSIXDYLD(lldb_private::Process *process)
Definition: DynamicLoaderPOSIXDYLD.cpp:68
lldb_private::DynamicLoader
Definition: DynamicLoader.h:52
DYLDRendezvous.h
DynamicLoaderPOSIXDYLD::RendezvousBreakpointHit
static bool RendezvousBreakpointHit(void *baton, lldb_private::StoppointCallbackContext *context, lldb::user_id_t break_id, lldb::user_id_t break_loc_id)
Callback routine which updates the current list of loaded modules based on the information supplied b...
Definition: DynamicLoaderPOSIXDYLD.cpp:388
DynamicLoaderPOSIXDYLD::ComputeLoadOffset
lldb::addr_t ComputeLoadOffset()
Computes a value for m_load_offset returning the computed address on success and LLDB_INVALID_ADDRESS...
Definition: DynamicLoaderPOSIXDYLD.cpp:633
DynamicLoaderPOSIXDYLD::ResolveExecutableModule
void ResolveExecutableModule(lldb::ModuleSP &module_sp)
Loads Module from inferior process.
Definition: DynamicLoaderPOSIXDYLD.cpp:744
DynamicLoaderPOSIXDYLD::GetPluginName
llvm::StringRef GetPluginName() override
Definition: DynamicLoaderPOSIXDYLD.h:56
lldb_private::Status
Definition: Status.h:44
DynamicLoaderPOSIXDYLD::SetRendezvousBreakpoint
bool SetRendezvousBreakpoint()
If possible sets a breakpoint on a function called by the runtime linker each time a module is loaded...
Definition: DynamicLoaderPOSIXDYLD.cpp:306
DynamicLoaderPOSIXDYLD::GetPluginDescriptionStatic
static const char * GetPluginDescriptionStatic()
Definition: DynamicLoaderPOSIXDYLD.cpp:46
DynamicLoaderPOSIXDYLD::GetStepThroughTrampolinePlan
lldb::ThreadPlanSP GetStepThroughTrampolinePlan(lldb_private::Thread &thread, bool stop_others) override
Provides a plan to step through the dynamic loader trampoline for the current state of thread.
Definition: DynamicLoaderPOSIXDYLD.cpp:488
DynamicLoaderPOSIXDYLD::AlwaysRelyOnEHUnwindInfo
bool AlwaysRelyOnEHUnwindInfo(lldb_private::SymbolContext &sym_ctx) override
Ask if the eh_frame information for the given SymbolContext should be relied on even when it's the fi...
Definition: DynamicLoaderPOSIXDYLD.cpp:791
DynamicLoaderPOSIXDYLD::EvalSpecialModulesStatus
void EvalSpecialModulesStatus()
Evaluate if Aux vectors contain vDSO and LD information in case they do, read and assign the address ...
Definition: DynamicLoaderPOSIXDYLD.cpp:659
DynamicLoaderPOSIXDYLD::m_auxv
std::unique_ptr< AuxVector > m_auxv
Auxiliary vector of the inferior process.
Definition: DynamicLoaderPOSIXDYLD.h:71
DYLDRendezvous
Definition: DYLDRendezvous.h:34
DynamicLoaderPOSIXDYLD::UnloadSections
void UnloadSections(const lldb::ModuleSP module) override
Removes the loaded sections from the target in module.
Definition: DynamicLoaderPOSIXDYLD.cpp:215
DynamicLoaderPOSIXDYLD::GetPluginNameStatic
static lldb_private::ConstString GetPluginNameStatic()
Definition: DynamicLoaderPOSIXDYLD.cpp:41
DynamicLoaderPOSIXDYLD::m_entry_point
lldb::addr_t m_entry_point
Virtual entry address of the inferior process.
Definition: DynamicLoaderPOSIXDYLD.h:68
DynamicLoaderPOSIXDYLD::CreateInstance
static lldb_private::DynamicLoader * CreateInstance(lldb_private::Process *process, bool force)
Definition: DynamicLoaderPOSIXDYLD.cpp:51
DynamicLoaderPOSIXDYLD::m_rendezvous
DYLDRendezvous m_rendezvous
Runtime linker rendezvous structure.
Definition: DynamicLoaderPOSIXDYLD.h:62
lldb::user_id_t
uint64_t user_id_t
Definition: lldb-types.h:84
DynamicLoaderPOSIXDYLD::UpdateLoadedSections
void UpdateLoadedSections(lldb::ModuleSP module, lldb::addr_t link_map_addr, lldb::addr_t base_addr, bool base_addr_is_offset) override
Updates the load address of every allocatable section in module.
Definition: DynamicLoaderPOSIXDYLD.cpp:207
DynamicLoaderPOSIXDYLD::CanLoadImage
lldb_private::Status CanLoadImage() override
Ask if it is ok to try and load or unload an shared library (image).
Definition: DynamicLoaderPOSIXDYLD.cpp:205
DynamicLoaderPOSIXDYLD::LoadInterpreterModule
lldb::ModuleSP LoadInterpreterModule()
Definition: DynamicLoaderPOSIXDYLD.cpp:559
DynamicLoaderPOSIXDYLD::LoadAllCurrentModules
virtual void LoadAllCurrentModules()
Helper for the entry breakpoint callback.
Definition: DynamicLoaderPOSIXDYLD.cpp:586
DynamicLoaderPOSIXDYLD::~DynamicLoaderPOSIXDYLD
~DynamicLoaderPOSIXDYLD() override
Definition: DynamicLoaderPOSIXDYLD.cpp:76
DynamicLoaderPOSIXDYLD::m_dyld_bid
lldb::break_id_t m_dyld_bid
Rendezvous breakpoint.
Definition: DynamicLoaderPOSIXDYLD.h:74
DynamicLoaderPOSIXDYLD::ProbeEntry
void ProbeEntry()
Resolves the entry point for the current inferior process and sets a breakpoint at that address.
Definition: DynamicLoaderPOSIXDYLD.cpp:221
DynamicLoaderPOSIXDYLD::DidAttach
void DidAttach() override
Called after attaching a process.
Definition: DynamicLoaderPOSIXDYLD.cpp:83
DynamicLoader.h
DynamicLoaderPOSIXDYLD::GetThreadLocalData
lldb::addr_t GetThreadLocalData(const lldb::ModuleSP module, const lldb::ThreadSP thread, lldb::addr_t tls_file_addr) override
Retrieves the per-module TLS block for a given thread.
Definition: DynamicLoaderPOSIXDYLD.cpp:693
DynamicLoaderPOSIXDYLD::m_interpreter_module
std::weak_ptr< lldb_private::Module > m_interpreter_module
Contains the pointer to the interpret module, if loaded.
Definition: DynamicLoaderPOSIXDYLD.h:85