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 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
|
//===-- DynamicLoaderMacOSXDYLD.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
//
//===----------------------------------------------------------------------===//
// This is the DynamicLoader plugin for Darwin (macOS / iPhoneOS / tvOS /
// watchOS / BridgeOS)
// platforms earlier than 2016, where lldb would read the "dyld_all_image_infos"
// dyld internal structure to understand where things were loaded and the
// solib loaded/unloaded notification function we put a breakpoint on gives us
// an array of (load address, mod time, file path) tuples.
//
// As of late 2016, the new DynamicLoaderMacOS plugin should be used, which uses
// dyld SPI functions to get the same information without reading internal dyld
// data structures.
#ifndef LLDB_SOURCE_PLUGINS_DYNAMICLOADER_MACOSX_DYLD_DYNAMICLOADERMACOSXDYLD_H
#define LLDB_SOURCE_PLUGINS_DYNAMICLOADER_MACOSX_DYLD_DYNAMICLOADERMACOSXDYLD_H
#include <mutex>
#include <vector>
#include "lldb/Host/SafeMachO.h"
#include "lldb/Target/DynamicLoader.h"
#include "lldb/Target/Process.h"
#include "lldb/Utility/FileSpec.h"
#include "lldb/Utility/StructuredData.h"
#include "lldb/Utility/UUID.h"
#include "DynamicLoaderDarwin.h"
class DynamicLoaderMacOSXDYLD : public lldb_private::DynamicLoaderDarwin {
public:
DynamicLoaderMacOSXDYLD(lldb_private::Process *process);
~DynamicLoaderMacOSXDYLD() override;
// Static Functions
static void Initialize();
static void Terminate();
static lldb_private::ConstString GetPluginNameStatic();
static const char *GetPluginDescriptionStatic();
static lldb_private::DynamicLoader *
CreateInstance(lldb_private::Process *process, bool force);
/// Called after attaching a process.
///
/// Allow DynamicLoader plug-ins to execute some code after
/// attaching to a process.
bool ProcessDidExec() override;
lldb_private::Status CanLoadImage() override;
bool GetSharedCacheInformation(
lldb::addr_t &base_address, lldb_private::UUID &uuid,
lldb_private::LazyBool &using_shared_cache,
lldb_private::LazyBool &private_shared_cache) override;
// PluginInterface protocol
lldb_private::ConstString GetPluginName() override;
uint32_t GetPluginVersion() override;
protected:
void PutToLog(lldb_private::Log *log) const;
void DoInitialImageFetch() override;
bool NeedToDoInitialImageFetch() override;
bool DidSetNotificationBreakpoint() override;
void DoClear() override;
bool ReadDYLDInfoFromMemoryAndSetNotificationCallback(lldb::addr_t addr);
static bool
NotifyBreakpointHit(void *baton,
lldb_private::StoppointCallbackContext *context,
lldb::user_id_t break_id, lldb::user_id_t break_loc_id);
uint32_t AddrByteSize();
bool ReadMachHeader(lldb::addr_t addr, llvm::MachO::mach_header *header,
lldb_private::DataExtractor *load_command_data);
uint32_t ParseLoadCommands(const lldb_private::DataExtractor &data,
ImageInfo &dylib_info,
lldb_private::FileSpec *lc_id_dylinker);
struct DYLDAllImageInfos {
uint32_t version;
uint32_t dylib_info_count; // Version >= 1
lldb::addr_t dylib_info_addr; // Version >= 1
lldb::addr_t notification; // Version >= 1
bool processDetachedFromSharedRegion; // Version >= 1
bool libSystemInitialized; // Version >= 2
lldb::addr_t dyldImageLoadAddress; // Version >= 2
DYLDAllImageInfos()
: version(0), dylib_info_count(0),
dylib_info_addr(LLDB_INVALID_ADDRESS),
notification(LLDB_INVALID_ADDRESS),
processDetachedFromSharedRegion(false), libSystemInitialized(false),
dyldImageLoadAddress(LLDB_INVALID_ADDRESS) {}
void Clear() {
version = 0;
dylib_info_count = 0;
dylib_info_addr = LLDB_INVALID_ADDRESS;
notification = LLDB_INVALID_ADDRESS;
processDetachedFromSharedRegion = false;
libSystemInitialized = false;
dyldImageLoadAddress = LLDB_INVALID_ADDRESS;
}
bool IsValid() const { return version >= 1 && version <= 6; }
};
static lldb::ByteOrder GetByteOrderFromMagic(uint32_t magic);
bool SetNotificationBreakpoint() override;
void ClearNotificationBreakpoint() override;
// There is a little tricky bit where you might initially attach while dyld is
// updating
// the all_image_infos, and you can't read the infos, so you have to continue
// and pick it
// up when you hit the update breakpoint. At that point, you need to run this
// initialize
// function, but when you do it that way you DON'T need to do the extra work
// you would at
// the breakpoint.
// So this function will only do actual work if the image infos haven't been
// read yet.
// If it does do any work, then it will return true, and false otherwise.
// That way you can
// call it in the breakpoint action, and if it returns true you're done.
bool InitializeFromAllImageInfos();
bool ReadAllImageInfosStructure();
bool AddModulesUsingImageInfosAddress(lldb::addr_t image_infos_addr,
uint32_t image_infos_count);
bool RemoveModulesUsingImageInfosAddress(lldb::addr_t image_infos_addr,
uint32_t image_infos_count);
void UpdateImageInfosHeaderAndLoadCommands(ImageInfo::collection &image_infos,
uint32_t infos_count,
bool update_executable);
bool ReadImageInfos(lldb::addr_t image_infos_addr, uint32_t image_infos_count,
ImageInfo::collection &image_infos);
lldb::addr_t m_dyld_all_image_infos_addr;
DYLDAllImageInfos m_dyld_all_image_infos;
uint32_t m_dyld_all_image_infos_stop_id;
lldb::user_id_t m_break_id;
mutable std::recursive_mutex m_mutex;
bool m_process_image_addr_is_all_images_infos;
private:
DynamicLoaderMacOSXDYLD(const DynamicLoaderMacOSXDYLD &) = delete;
const DynamicLoaderMacOSXDYLD &
operator=(const DynamicLoaderMacOSXDYLD &) = delete;
};
#endif // LLDB_SOURCE_PLUGINS_DYNAMICLOADER_MACOSX_DYLD_DYNAMICLOADERMACOSXDYLD_H
|