LLDB  mainline
DynamicLoaderMacOSXDYLD.h
Go to the documentation of this file.
1 //===-- DynamicLoaderMacOSXDYLD.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 // This is the DynamicLoader plugin for Darwin (macOS / iPhoneOS / tvOS /
10 // watchOS / BridgeOS)
11 // platforms earlier than 2016, where lldb would read the "dyld_all_image_infos"
12 // dyld internal structure to understand where things were loaded and the
13 // solib loaded/unloaded notification function we put a breakpoint on gives us
14 // an array of (load address, mod time, file path) tuples.
15 //
16 // As of late 2016, the new DynamicLoaderMacOS plugin should be used, which uses
17 // dyld SPI functions to get the same information without reading internal dyld
18 // data structures.
19 
20 #ifndef LLDB_SOURCE_PLUGINS_DYNAMICLOADER_MACOSX_DYLD_DYNAMICLOADERMACOSXDYLD_H
21 #define LLDB_SOURCE_PLUGINS_DYNAMICLOADER_MACOSX_DYLD_DYNAMICLOADERMACOSXDYLD_H
22 
23 #include <mutex>
24 #include <vector>
25 
26 #include "lldb/Host/SafeMachO.h"
28 #include "lldb/Target/Process.h"
29 #include "lldb/Utility/FileSpec.h"
31 #include "lldb/Utility/UUID.h"
32 
33 #include "DynamicLoaderDarwin.h"
34 
36 public:
38 
39  ~DynamicLoaderMacOSXDYLD() override;
40 
41  // Static Functions
42  static void Initialize();
43 
44  static void Terminate();
45 
47 
48  static const char *GetPluginDescriptionStatic();
49 
51  CreateInstance(lldb_private::Process *process, bool force);
52 
53  /// Called after attaching a process.
54  ///
55  /// Allow DynamicLoader plug-ins to execute some code after
56  /// attaching to a process.
57  bool ProcessDidExec() override;
58 
60 
62  lldb::addr_t &base_address, lldb_private::UUID &uuid,
63  lldb_private::LazyBool &using_shared_cache,
64  lldb_private::LazyBool &private_shared_cache) override;
65 
66  // PluginInterface protocol
68 
69  bool IsFullyInitialized() override;
70 
71 protected:
72  void PutToLog(lldb_private::Log *log) const;
73 
74  void DoInitialImageFetch() override;
75 
76  bool NeedToDoInitialImageFetch() override;
77 
78  bool DidSetNotificationBreakpoint() override;
79 
80  void DoClear() override;
81 
83 
84  static bool
85  NotifyBreakpointHit(void *baton,
87  lldb::user_id_t break_id, lldb::user_id_t break_loc_id);
88 
90 
91  bool ReadMachHeader(lldb::addr_t addr, llvm::MachO::mach_header *header,
92  lldb_private::DataExtractor *load_command_data);
93 
95  ImageInfo &dylib_info,
96  lldb_private::FileSpec *lc_id_dylinker);
97 
100  uint32_t dylib_info_count = 0; // Version >= 1
103  bool processDetachedFromSharedRegion = false; // Version >= 1
104  bool libSystemInitialized = false; // Version >= 2
106 
107  DYLDAllImageInfos() = default;
108 
109  void Clear() {
110  version = 0;
111  dylib_info_count = 0;
115  libSystemInitialized = false;
117  }
118 
119  bool IsValid() const { return version >= 1 && version <= 6; }
120  };
121 
123 
124  bool SetNotificationBreakpoint() override;
125 
126  void ClearNotificationBreakpoint() override;
127 
128  // There is a little tricky bit where you might initially attach while dyld is
129  // updating
130  // the all_image_infos, and you can't read the infos, so you have to continue
131  // and pick it
132  // up when you hit the update breakpoint. At that point, you need to run this
133  // initialize
134  // function, but when you do it that way you DON'T need to do the extra work
135  // you would at
136  // the breakpoint.
137  // So this function will only do actual work if the image infos haven't been
138  // read yet.
139  // If it does do any work, then it will return true, and false otherwise.
140  // That way you can
141  // call it in the breakpoint action, and if it returns true you're done.
143 
145 
146  bool AddModulesUsingImageInfosAddress(lldb::addr_t image_infos_addr,
147  uint32_t image_infos_count);
148 
150  uint32_t image_infos_count);
151 
153  uint32_t infos_count,
154  bool update_executable);
155 
156  bool ReadImageInfos(lldb::addr_t image_infos_addr, uint32_t image_infos_count,
157  ImageInfo::collection &image_infos);
158 
163  mutable std::recursive_mutex m_mutex;
165 
166 private:
169  operator=(const DynamicLoaderMacOSXDYLD &) = delete;
170 };
171 
172 #endif // LLDB_SOURCE_PLUGINS_DYNAMICLOADER_MACOSX_DYLD_DYNAMICLOADERMACOSXDYLD_H
lldb_private::UUID
Definition: UUID.h:23
DynamicLoaderMacOSXDYLD::m_break_id
lldb::user_id_t m_break_id
Definition: DynamicLoaderMacOSXDYLD.h:162
DynamicLoaderMacOSXDYLD::DYLDAllImageInfos::IsValid
bool IsValid() const
Definition: DynamicLoaderMacOSXDYLD.h:119
DynamicLoaderMacOSXDYLD::ReadImageInfos
bool ReadImageInfos(lldb::addr_t image_infos_addr, uint32_t image_infos_count, ImageInfo::collection &image_infos)
Definition: DynamicLoaderMacOSXDYLD.cpp:659
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
DynamicLoaderMacOSXDYLD::ProcessDidExec
bool ProcessDidExec() override
Called after attaching a process.
Definition: DynamicLoaderMacOSXDYLD.cpp:110
StructuredData.h
UUID.h
lldb_private::DynamicLoaderDarwin::ImageInfo::collection
std::vector< ImageInfo > collection
Definition: DynamicLoaderDarwin.h:168
DynamicLoaderMacOSXDYLD::AddModulesUsingImageInfosAddress
bool AddModulesUsingImageInfosAddress(lldb::addr_t image_infos_addr, uint32_t image_infos_count)
Definition: DynamicLoaderMacOSXDYLD.cpp:534
lldb_private::Process
Definition: Process.h:342
DynamicLoaderDarwin.h
DynamicLoaderMacOSXDYLD::UpdateImageInfosHeaderAndLoadCommands
void UpdateImageInfosHeaderAndLoadCommands(ImageInfo::collection &image_infos, uint32_t infos_count, bool update_executable)
Definition: DynamicLoaderMacOSXDYLD.cpp:917
DynamicLoaderMacOSXDYLD::DynamicLoaderMacOSXDYLD
DynamicLoaderMacOSXDYLD(lldb_private::Process *process)
Definition: DynamicLoaderMacOSXDYLD.cpp:97
DynamicLoaderMacOSXDYLD::GetByteOrderFromMagic
static lldb::ByteOrder GetByteOrderFromMagic(uint32_t magic)
Definition: DynamicLoaderMacOSXDYLD.cpp:1172
DynamicLoaderMacOSXDYLD::GetPluginNameStatic
static lldb_private::ConstString GetPluginNameStatic()
Definition: DynamicLoaderMacOSXDYLD.cpp:1139
DynamicLoaderMacOSXDYLD::PutToLog
void PutToLog(lldb_private::Log *log) const
Definition: DynamicLoaderMacOSXDYLD.cpp:975
lldb::addr_t
uint64_t addr_t
Definition: lldb-types.h:83
lldb_private::LazyBool
LazyBool
Definition: lldb-private-enumerations.h:115
lldb_private::DynamicLoaderDarwin::ImageInfo
Definition: DynamicLoaderDarwin.h:95
DynamicLoaderMacOSXDYLD::DYLDAllImageInfos::notification
lldb::addr_t notification
Definition: DynamicLoaderMacOSXDYLD.h:102
DynamicLoaderMacOSXDYLD::DYLDAllImageInfos::dylib_info_addr
lldb::addr_t dylib_info_addr
Definition: DynamicLoaderMacOSXDYLD.h:101
Process.h
DynamicLoaderMacOSXDYLD::NotifyBreakpointHit
static bool NotifyBreakpointHit(void *baton, lldb_private::StoppointCallbackContext *context, lldb::user_id_t break_id, lldb::user_id_t break_loc_id)
Definition: DynamicLoaderMacOSXDYLD.cpp:313
SafeMachO.h
DynamicLoaderMacOSXDYLD::operator=
const DynamicLoaderMacOSXDYLD & operator=(const DynamicLoaderMacOSXDYLD &)=delete
DynamicLoaderMacOSXDYLD::m_mutex
std::recursive_mutex m_mutex
Definition: DynamicLoaderMacOSXDYLD.h:163
lldb_private::FileSpec
Definition: FileSpec.h:56
DynamicLoaderMacOSXDYLD::InitializeFromAllImageInfos
bool InitializeFromAllImageInfos()
Definition: DynamicLoaderMacOSXDYLD.cpp:701
DynamicLoaderMacOSXDYLD::m_dyld_all_image_infos_addr
lldb::addr_t m_dyld_all_image_infos_addr
Definition: DynamicLoaderMacOSXDYLD.h:159
DynamicLoaderMacOSXDYLD::DoInitialImageFetch
void DoInitialImageFetch() override
Definition: DynamicLoaderMacOSXDYLD.cpp:184
DynamicLoaderMacOSXDYLD::ReadAllImageInfosStructure
bool ReadAllImageInfosStructure()
Definition: DynamicLoaderMacOSXDYLD.cpp:413
DynamicLoaderMacOSXDYLD::DYLDAllImageInfos::DYLDAllImageInfos
DYLDAllImageInfos()=default
lldb_private::DataExtractor
Definition: DataExtractor.h:48
DynamicLoaderMacOSXDYLD::ParseLoadCommands
uint32_t ParseLoadCommands(const lldb_private::DataExtractor &data, ImageInfo &dylib_info, lldb_private::FileSpec *lc_id_dylinker)
Definition: DynamicLoaderMacOSXDYLD.cpp:828
DynamicLoaderMacOSXDYLD::DYLDAllImageInfos::Clear
void Clear()
Definition: DynamicLoaderMacOSXDYLD.h:109
DynamicLoaderMacOSXDYLD::GetSharedCacheInformation
bool GetSharedCacheInformation(lldb::addr_t &base_address, lldb_private::UUID &uuid, lldb_private::LazyBool &using_shared_cache, lldb_private::LazyBool &private_shared_cache) override
Get information about the shared cache for a process, if possible.
Definition: DynamicLoaderMacOSXDYLD.cpp:1050
lldb_private::ConstString
Definition: ConstString.h:40
DynamicLoaderMacOSXDYLD::~DynamicLoaderMacOSXDYLD
~DynamicLoaderMacOSXDYLD() override
Definition: DynamicLoaderMacOSXDYLD.cpp:105
lldb_private::DynamicLoader
Definition: DynamicLoader.h:52
DynamicLoaderMacOSXDYLD::m_dyld_all_image_infos_stop_id
uint32_t m_dyld_all_image_infos_stop_id
Definition: DynamicLoaderMacOSXDYLD.h:161
DynamicLoaderMacOSXDYLD::DYLDAllImageInfos
Definition: DynamicLoaderMacOSXDYLD.h:98
DynamicLoaderMacOSXDYLD::DYLDAllImageInfos::processDetachedFromSharedRegion
bool processDetachedFromSharedRegion
Definition: DynamicLoaderMacOSXDYLD.h:103
lldb_private::DynamicLoaderDarwin
Definition: DynamicLoaderDarwin.h:27
DynamicLoaderMacOSXDYLD::m_process_image_addr_is_all_images_infos
bool m_process_image_addr_is_all_images_infos
Definition: DynamicLoaderMacOSXDYLD.h:164
DynamicLoaderMacOSXDYLD::m_dyld_all_image_infos
DYLDAllImageInfos m_dyld_all_image_infos
Definition: DynamicLoaderMacOSXDYLD.h:160
DynamicLoaderMacOSXDYLD::NeedToDoInitialImageFetch
bool NeedToDoInitialImageFetch() override
Definition: DynamicLoaderMacOSXDYLD.cpp:305
DynamicLoaderMacOSXDYLD::DYLDAllImageInfos::dylib_info_count
uint32_t dylib_info_count
Definition: DynamicLoaderMacOSXDYLD.h:100
lldb_private::Status
Definition: Status.h:44
uint32_t
DynamicLoaderMacOSXDYLD::AddrByteSize
uint32_t AddrByteSize()
Definition: DynamicLoaderMacOSXDYLD.cpp:1154
DynamicLoaderMacOSXDYLD::CreateInstance
static lldb_private::DynamicLoader * CreateInstance(lldb_private::Process *process, bool force)
Definition: DynamicLoaderMacOSXDYLD.cpp:55
DynamicLoaderMacOSXDYLD::DYLDAllImageInfos::libSystemInitialized
bool libSystemInitialized
Definition: DynamicLoaderMacOSXDYLD.h:104
DynamicLoaderMacOSXDYLD::GetPluginDescriptionStatic
static const char * GetPluginDescriptionStatic()
Definition: DynamicLoaderMacOSXDYLD.cpp:1144
LLDB_INVALID_ADDRESS
#define LLDB_INVALID_ADDRESS
Definition: lldb-defines.h:86
DynamicLoaderMacOSXDYLD::ClearNotificationBreakpoint
void ClearNotificationBreakpoint() override
Definition: DynamicLoaderMacOSXDYLD.cpp:174
DynamicLoaderMacOSXDYLD::ReadDYLDInfoFromMemoryAndSetNotificationCallback
bool ReadDYLDInfoFromMemoryAndSetNotificationCallback(lldb::addr_t addr)
Definition: DynamicLoaderMacOSXDYLD.cpp:249
lldb::user_id_t
uint64_t user_id_t
Definition: lldb-types.h:84
DynamicLoaderMacOSXDYLD::DYLDAllImageInfos::dyldImageLoadAddress
lldb::addr_t dyldImageLoadAddress
Definition: DynamicLoaderMacOSXDYLD.h:105
DynamicLoaderMacOSXDYLD::ReadMachHeader
bool ReadMachHeader(lldb::addr_t addr, llvm::MachO::mach_header *header, lldb_private::DataExtractor *load_command_data)
Definition: DynamicLoaderMacOSXDYLD.cpp:761
FileSpec.h
lldb_private::Log
Definition: Log.h:49
DynamicLoaderMacOSXDYLD::IsFullyInitialized
bool IsFullyInitialized() override
Return whether the dynamic loader is fully initialized and it's safe to call its APIs.
Definition: DynamicLoaderMacOSXDYLD.cpp:1122
DynamicLoaderMacOSXDYLD::DYLDAllImageInfos::version
uint32_t version
Definition: DynamicLoaderMacOSXDYLD.h:99
DynamicLoaderMacOSXDYLD::DidSetNotificationBreakpoint
bool DidSetNotificationBreakpoint() override
Definition: DynamicLoaderMacOSXDYLD.cpp:170
DynamicLoader.h
DynamicLoaderMacOSXDYLD::Terminate
static void Terminate()
Definition: DynamicLoaderMacOSXDYLD.cpp:1134
DynamicLoaderMacOSXDYLD::GetPluginName
lldb_private::ConstString GetPluginName() override
Definition: DynamicLoaderMacOSXDYLD.cpp:1150
DynamicLoaderMacOSXDYLD::Initialize
static void Initialize()
Definition: DynamicLoaderMacOSXDYLD.cpp:1128
DynamicLoaderMacOSXDYLD::RemoveModulesUsingImageInfosAddress
bool RemoveModulesUsingImageInfosAddress(lldb::addr_t image_infos_addr, uint32_t image_infos_count)
Definition: DynamicLoaderMacOSXDYLD.cpp:575
DynamicLoaderMacOSXDYLD::DoClear
void DoClear() override
Definition: DynamicLoaderMacOSXDYLD.cpp:158
lldb::ByteOrder
ByteOrder
Byte ordering definitions.
Definition: lldb-enumerations.h:138
DynamicLoaderMacOSXDYLD::SetNotificationBreakpoint
bool SetNotificationBreakpoint() override
Definition: DynamicLoaderMacOSXDYLD.cpp:997
DynamicLoaderMacOSXDYLD
Definition: DynamicLoaderMacOSXDYLD.h:35
DynamicLoaderMacOSXDYLD::CanLoadImage
lldb_private::Status CanLoadImage() override
Ask if it is ok to try and load or unload an shared library (image).
Definition: DynamicLoaderMacOSXDYLD.cpp:1032