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" 16 #include "Plugins/Process/Utility/AuxVector.h" 17 #include "lldb/Breakpoint/StoppointCallbackContext.h" 18 #include "lldb/Core/ModuleList.h" 19 #include "lldb/Target/DynamicLoader.h" 20 21 class AuxVector; 22 23 class DynamicLoaderPOSIXDYLD : public lldb_private::DynamicLoader { 24 public: 25 DynamicLoaderPOSIXDYLD(lldb_private::Process *process); 26 27 ~DynamicLoaderPOSIXDYLD() override; 28 29 static void Initialize(); 30 31 static void Terminate(); 32 33 static llvm::StringRef GetPluginNameStatic() { return "posix-dyld"; } 34 35 static llvm::StringRef GetPluginDescriptionStatic(); 36 37 static lldb_private::DynamicLoader * 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 49 lldb_private::Status CanLoadImage() override; 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 { return GetPluginNameStatic(); } 57 58 lldb::ModuleSP LoadModuleAtAddress(const lldb_private::FileSpec &file, 59 lldb::addr_t link_map_addr, 60 lldb::addr_t base_addr, 61 bool base_addr_is_offset) override; 62 63 void CalculateDynamicSaveCoreRanges( 64 lldb_private::Process &process, 65 std::vector<lldb_private::MemoryRegionInfo> &ranges, 66 llvm::function_ref<bool(const lldb_private::Thread &)> 67 save_thread_predicate) override; 68 69 protected: 70 /// Runtime linker rendezvous structure. 71 DYLDRendezvous m_rendezvous; 72 73 /// Virtual load address of the inferior process. 74 lldb::addr_t m_load_offset; 75 76 /// Virtual entry address of the inferior process. 77 lldb::addr_t m_entry_point; 78 79 /// Auxiliary vector of the inferior process. 80 std::unique_ptr<AuxVector> m_auxv; 81 82 /// Rendezvous breakpoint. 83 lldb::break_id_t m_dyld_bid; 84 85 /// Contains AT_SYSINFO_EHDR, which means a vDSO has been 86 /// mapped to the address space 87 lldb::addr_t m_vdso_base; 88 89 /// Contains AT_BASE, which means a dynamic loader has been 90 /// mapped to the address space 91 lldb::addr_t m_interpreter_base; 92 93 /// Contains the pointer to the interpret module, if loaded. 94 std::weak_ptr<lldb_private::Module> m_interpreter_module; 95 96 /// Loaded module list. (link map for each module) 97 std::map<lldb::ModuleWP, lldb::addr_t, std::owner_less<lldb::ModuleWP>> 98 m_loaded_modules; 99 100 /// Returns true if the process is for a core file. 101 bool IsCoreFile() const; 102 103 /// If possible sets a breakpoint on a function called by the runtime 104 /// linker each time a module is loaded or unloaded. 105 bool SetRendezvousBreakpoint(); 106 107 /// Callback routine which updates the current list of loaded modules based 108 /// on the information supplied by the runtime linker. 109 static bool RendezvousBreakpointHit( 110 void *baton, lldb_private::StoppointCallbackContext *context, 111 lldb::user_id_t break_id, lldb::user_id_t break_loc_id); 112 113 /// Indicates whether the initial set of modules was reported added. 114 bool m_initial_modules_added; 115 116 /// Helper method for RendezvousBreakpointHit. Updates LLDB's current set 117 /// of loaded modules. 118 void RefreshModules(); 119 120 /// Updates the load address of every allocatable section in \p module. 121 /// 122 /// \param module The module to traverse. 123 /// 124 /// \param link_map_addr The virtual address of the link map for the @p 125 /// module. 126 /// 127 /// \param base_addr The virtual base address \p module is loaded at. 128 void UpdateLoadedSections(lldb::ModuleSP module, lldb::addr_t link_map_addr, 129 lldb::addr_t base_addr, 130 bool base_addr_is_offset) override; 131 132 /// Removes the loaded sections from the target in \p module. 133 /// 134 /// \param module The module to traverse. 135 void UnloadSections(const lldb::ModuleSP module) override; 136 137 /// Resolves the entry point for the current inferior process and sets a 138 /// breakpoint at that address. 139 void ProbeEntry(); 140 141 /// Callback routine invoked when we hit the breakpoint on process entry. 142 /// 143 /// This routine is responsible for resolving the load addresses of all 144 /// dependent modules required by the inferior and setting up the rendezvous 145 /// breakpoint. 146 static bool 147 EntryBreakpointHit(void *baton, 148 lldb_private::StoppointCallbackContext *context, 149 lldb::user_id_t break_id, lldb::user_id_t break_loc_id); 150 151 /// Helper for the entry breakpoint callback. Resolves the load addresses 152 /// of all dependent modules. 153 virtual void LoadAllCurrentModules(); 154 155 void LoadVDSO(); 156 157 // Loading an interpreter module (if present) assuming m_interpreter_base 158 // already points to its base address. 159 lldb::ModuleSP LoadInterpreterModule(); 160 161 /// Computes a value for m_load_offset returning the computed address on 162 /// success and LLDB_INVALID_ADDRESS on failure. 163 lldb::addr_t ComputeLoadOffset(); 164 165 /// Computes a value for m_entry_point returning the computed address on 166 /// success and LLDB_INVALID_ADDRESS on failure. 167 lldb::addr_t GetEntryPoint(); 168 169 /// Evaluate if Aux vectors contain vDSO and LD information 170 /// in case they do, read and assign the address to m_vdso_base 171 /// and m_interpreter_base. 172 void EvalSpecialModulesStatus(); 173 174 /// Loads Module from inferior process. 175 void ResolveExecutableModule(lldb::ModuleSP &module_sp); 176 177 bool AlwaysRelyOnEHUnwindInfo(lldb_private::SymbolContext &sym_ctx) override; 178 179 private: 180 DynamicLoaderPOSIXDYLD(const DynamicLoaderPOSIXDYLD &) = delete; 181 const DynamicLoaderPOSIXDYLD & 182 operator=(const DynamicLoaderPOSIXDYLD &) = delete; 183 }; 184 185 #endif // LLDB_SOURCE_PLUGINS_DYNAMICLOADER_POSIX_DYLD_DYNAMICLOADERPOSIXDYLD_H 186