19#define PATHCCH_MAX_CCH 0x8000
38#include "llvm/ADT/ScopeExit.h"
39#include "llvm/Support/ConvertUTF.h"
52 const bool is_host =
false;
55 if (!create && arch && arch->IsValid()) {
56 const llvm::Triple &triple = arch->GetTriple();
57 switch (triple.getVendor()) {
58 case llvm::Triple::PC:
62 case llvm::Triple::UnknownVendor:
63 create = !arch->TripleVendorWasSpecified();
71 switch (triple.getOS()) {
72 case llvm::Triple::Win32:
75 case llvm::Triple::UnknownOS:
76 create = arch->TripleOSWasSpecified();
91 return is_host ?
"Local Windows user platform plug-in."
92 :
"Remote Windows user platform plug-in.";
102 default_platform_sp->SetSystemArchitecture(HostInfo::GetArchitecture());
124 const auto &AddArch = [&](
const ArchSpec &spec) {
126 return spec.IsExactMatch(rhs);
132 AddArch(HostInfo::GetArchitecture(HostInfo::eArchKindDefault));
133 AddArch(HostInfo::GetArchitecture(HostInfo::eArchKind32));
134 AddArch(HostInfo::GetArchitecture(HostInfo::eArchKind64));
140 "can't connect to the host platform '{0}', always connected",
150 "failed to create a 'remote-gdb-server' platform");
161 const std::vector<std::string> *paths,
166 loaded_image->
Clear();
171 "LoadLibrary error: no thread available to invoke LoadLibrary");
176 thread->CalculateExecutionContext(context);
183 if (loader ==
nullptr)
189 "LoadLibrary error: could not get function caller");
194 llvm::SmallVector<llvm::UTF16, 261> name;
195 if (!llvm::convertUTF8ToUTF16String(remote_file.
GetPath(), name)) {
197 "LoadLibrary error: could not convert path to UCS2");
200 name.emplace_back(L
'\0');
205 ePermissionsReadable | ePermissionsWritable,
209 "LoadLibrary error: unable to allocate memory for name: %s",
214 llvm::scope_exit name_cleanup(
218 name.size() *
sizeof(llvm::UTF16), status);
221 "LoadLibrary error: unable to write name: %s", status.
AsCString());
227 std::optional<llvm::scope_exit<std::function<void()>>> paths_cleanup;
229 llvm::SmallVector<llvm::UTF16, 261> search_paths;
231 for (
const auto &path : *paths) {
235 llvm::SmallVector<llvm::UTF16, 261> buffer;
236 if (!llvm::convertUTF8ToUTF16String(path, buffer))
239 search_paths.append(std::begin(buffer), std::end(buffer));
240 search_paths.emplace_back(L
'\0');
242 search_paths.emplace_back(L
'\0');
245 process->
AllocateMemory(search_paths.size() *
sizeof(llvm::UTF16),
246 ePermissionsReadable | ePermissionsWritable,
250 "LoadLibrary error: unable to allocate memory for paths: %s",
255 paths_cleanup.emplace([process, injected_paths]() {
259 process->
WriteMemory(injected_paths, search_paths.data(),
260 search_paths.size() *
sizeof(llvm::UTF16), status);
263 "LoadLibrary error: unable to write paths: %s", status.
AsCString());
272 unsigned injected_length =
MAX_PATH;
275 (injected_length + 1) *
sizeof(llvm::UTF16),
276 ePermissionsReadable | ePermissionsWritable, status);
279 "LoadLibrary error: unable to allocate memory for module location: %s",
284 llvm::scope_exit injected_module_path_cleanup(
285 [process, injected_module_path]() {
293 ePermissionsReadable | ePermissionsWritable,
297 "LoadLibrary error: could not allocate memory for result: %s",
302 llvm::scope_exit result_cleanup([process, injected_result]() {
306 std::vector<lldb::addr_t> grown_path_buffers;
307 llvm::scope_exit grown_path_cleanup([&]() {
315 "LoadLibrary error: could not initialize result: %s",
321 injected_module_path, status);
324 "LoadLibrary error: could not initialize result: %s",
331 Scalar{injected_length},
sizeof(unsigned),
335 "LoadLibrary error: could not initialize result: %s",
349 parameters, diagnostics)) {
352 "LoadLibrary error: unable to write function parameters:"));
356 llvm::scope_exit parameter_cleanup(
357 [invocation, &context, injected_parameters]() {
363 if (!scratch_ts_sp) {
365 "LoadLibrary error: unable to get (clang) type system");
395 "LoadLibrary error: failed to execute LoadLibrary helper:"));
403 "LoadLibrary error: could not read the result: %s", status.
AsCString());
410 injected_result + 2 *
word_size +
sizeof(
unsigned),
sizeof(
unsigned), 0,
414 "LoadLibrary error: could not read error status: %s",
425 unsigned capacity = injected_length;
427 injected_result + 2 *
word_size,
sizeof(
unsigned), 0, status);
428 while (status.
Success() && path_length >= capacity &&
432 (capacity + 1) *
sizeof(llvm::UTF16),
433 ePermissionsReadable | ePermissionsWritable, status);
436 grown_path_buffers.push_back(buffer);
442 Scalar{capacity},
sizeof(unsigned), status);
447 if (invocation->
ExecuteFunction(context, &injected_parameters, options,
450 module_path_addr = buffer;
452 injected_result + 2 *
word_size,
sizeof(
unsigned), 0, status);
455 llvm::SmallVector<llvm::UTF16, MAX_PATH> wide_path(path_length);
457 process->
ReadMemory(module_path_addr, wide_path.data(),
458 path_length *
sizeof(llvm::UTF16), status);
461 "LoadLibrary error: could not read module path: %s",
466 std::string module_path;
467 if (!llvm::convertUTF16ToUTF8String(
468 llvm::ArrayRef<llvm::UTF16>(wide_path.data(), wide_path.size()),
471 "LoadLibrary error: could not convert module path to UTF-8");
476 loaded_image->
SetFile(module_path, llvm::sys::path::Style::native);
486 expression.
Printf(
"FreeLibrary((HMODULE)0x%" PRIx64
")", address);
494 if (value->GetError().Fail())
495 return value->GetError().Clone();
498 if (value->ResolveValue(scalar)) {
513 "can't disconnect from the host platform '{0}', always connected",
559 return Attach(attach_info, debugger, &target,
error);
572 error = process_sp->Launch(launch_info);
574 if (
error.Success()) {
575 process_sp->SetPseudoConsoleHandle();
578 LLDB_LOGF(log,
"Platform::%s LaunchProcess() failed: %s", __FUNCTION__,
601 if (target ==
nullptr) {
605 target = new_target_sp.get();
608 if (!target ||
error.Fail())
617 error = process_sp->Attach(attach_info);
626 llvm::VersionTuple version = HostInfo::GetOSVersion();
627 strm <<
" Host: Windows " << version.getAsString() <<
'\n';
647 const uint8_t *trap_opcode =
nullptr;
648 size_t trap_opcode_size = 0;
651 case llvm::Triple::aarch64: {
652 static const uint8_t g_aarch64_opcode[] = {0x00, 0x00, 0x3e, 0xd4};
653 trap_opcode = g_aarch64_opcode;
654 trap_opcode_size =
sizeof(g_aarch64_opcode);
657 return trap_opcode_size;
661 case llvm::Triple::arm:
662 case llvm::Triple::thumb: {
663 static const uint8_t g_thumb_opcode[] = {0xfe, 0xde};
664 trap_opcode = g_thumb_opcode;
665 trap_opcode_size =
sizeof(g_thumb_opcode);
668 return trap_opcode_size;
677std::unique_ptr<UtilityFunction>
681 static constexpr const char kLoaderDecls[] = R
"(
685// `LOAD_LIBRARY_SEARCH_APPLICATION_DIR | LOAD_LIBRARY_SEARCH_SYSTEM32 | LOAD_LIBRARY_SEARCH_USER_DIRS`
687// Directories in the standard search path are not searched. This value cannot
688// be combined with `LOAD_WITH_ALTERED_SEARCH_PATH`.
690// This value represents the recommended maximum number of directories an
691// application should include in its DLL search path.
692#define LOAD_LIBRARY_SEARCH_DEFAULT_DIRS 0x00001000
694// If this value is used, and lpFileName specifies an absolute path, the system
695// uses the alternate file search strategy to find associated executable
697#define LOAD_WITH_ALTERED_SEARCH_PATH 0x00000008
699// WINBASEAPI DWORD WINAPI GetLastError(VOID);
700/* __declspec(dllimport) */ uint32_t __stdcall GetLastError();
704// WINBASEAPI DLL_DIRECTORY_COOKIE WINAPI AddDllDirectory(LPCWSTR);
705/* __declspec(dllimport) */ void * __stdcall AddDllDirectory(const wchar_t *);
707// WINBASEAPI BOOL WINAPI FreeModule(HMODULE);
708/* __declspec(dllimport) */ int __stdcall FreeModule(void *hLibModule);
710// WINBASEAPI DWORD WINAPI GetModuleFileNameW(HMODULE hModule, LPWSTR lpFilename, DWORD nSize);
711/* __declspec(dllimport) */ uint32_t GetModuleFileNameW(void *, wchar_t *, uint32_t);
713// WINBASEAPI HMODULE WINAPI LoadLibraryExW(LPCWSTR, HANDLE, DWORD);
714/* __declspec(dllimport) */ void * __stdcall LoadLibraryExW(const wchar_t *, void *, uint32_t);
718// _ACRTIMP size_t __cdecl wcslen(wchar_t const *_String);
719/* __declspec(dllimport) */ size_t __cdecl wcslen(const wchar_t *);
723struct __lldb_LoadLibraryResult {
730_Static_assert(sizeof(struct __lldb_LoadLibraryResult) <= 3 * sizeof(void *),
731 "__lldb_LoadLibraryResult size mismatch");
733void * __lldb_LoadLibraryHelper(const wchar_t *name, const wchar_t *paths,
734 __lldb_LoadLibraryResult *result) {
735 // When the caller presets ImageBase the module is already loaded and we are
736 // only re-querying its path with a larger buffer. Skip LoadLibrary in that
737 // case so we do not take an extra reference on the module.
738 if (result->ImageBase == nullptr) {
739 for (const wchar_t *path = paths; path && *path; ) {
740 (void)AddDllDirectory(path);
741 path += wcslen(path) + 1;
744 result->ImageBase = LoadLibraryExW(name, nullptr,
745 LOAD_LIBRARY_SEARCH_DEFAULT_DIRS);
747 // Fallback: if the AddDllDirectory + LOAD_LIBRARY_SEARCH_DEFAULT_DIRS path
748 // failed to find the library, iterate the search paths ourselves and
749 // load by absolute path using LOAD_WITH_ALTERED_SEARCH_PATH, which makes
750 // Windows use the loaded DLL's own directory to resolve its sibling imports.
751 if (result->ImageBase == nullptr) {
753 for (const wchar_t *path = paths; path && *path; path += wcslen(path) + 1) {
754 size_t plen = wcslen(path);
755 size_t nlen = wcslen(name);
756 // Need room for: path + '\\' + name + '\0'
757 if (plen + 1 + nlen + 1 > 4096)
760 for (size_t i = 0; i < plen; ++i)
763 for (size_t i = 0; i <= nlen; ++i) // Copy name including trailing '\0'.
765 result->ImageBase = LoadLibraryExW(full, nullptr,
766 LOAD_WITH_ALTERED_SEARCH_PATH);
767 if (result->ImageBase != nullptr)
773 if (result->ImageBase == nullptr)
774 result->ErrorCode = GetLastError();
776 result->Length = GetModuleFileNameW(result->ImageBase, result->ModulePath,
779 return result->ImageBase;
784 static constexpr const char kName[] =
"__lldb_LoadLibraryHelper";
787 Target &target = process->GetTarget();
793 std::string
error = llvm::toString(function.takeError());
795 "LoadLibrary error: could not create utility function: %s",
823 std::unique_ptr<UtilityFunction> utility{std::move(*function)};
824 utility->MakeFunctionCaller(VoidPtrTy, parameters, context.
GetThreadSP(),
828 "LoadLibrary error: could not create function caller: %s",
833 if (!utility->GetFunctionCaller()) {
835 "LoadLibrary error: could not get function caller");
843 const char *expression,
846 static constexpr const char kLoaderDecls[] = R
"(
850// WINBASEAPI DLL_DIRECTORY_COOKIE WINAPI AddDllDirectory(LPCWSTR);
851/* __declspec(dllimport) */ void * __stdcall AddDllDirectory(const wchar_t *);
853// WINBASEAPI BOOL WINAPI FreeModule(HMODULE);
854/* __declspec(dllimport) */ int __stdcall FreeModule(void *);
856// WINBASEAPI DWORD WINAPI GetModuleFileNameW(HMODULE, LPWSTR, DWORD);
857/* __declspec(dllimport) */ uint32_t GetModuleFileNameW(void *, wchar_t *, uint32_t);
859// WINBASEAPI HMODULE WINAPI LoadLibraryExW(LPCWSTR, HANDLE, DWORD);
860/* __declspec(dllimport) */ void * __stdcall LoadLibraryExW(const wchar_t *, void *, uint32_t);
865 Status result = loader->CanLoadImage();
878 ExecutionContext context;
879 frame->CalculateExecutionContext(context);
881 EvaluateExpressionOptions options;
893 context, options, expression, kLoaderDecls, value);
895 return value ? value->GetError().Clone() :
Status(
"unknown error");
897 if (value && value->GetError().Fail())
898 return value->GetError().Clone();
static const size_t word_size
static llvm::raw_ostream & error(Stream &strm)
#define LLDB_LOGF(log,...)
#define LLDB_PLUGIN_DEFINE(PluginName)
static constexpr llvm::StringLiteral kName
An architecture specification class.
bool IsValid() const
Tests if this ArchSpec is valid.
llvm::Triple::ArchType GetMachine() const
Returns a machine family for the current architecture.
A command line argument class.
Class that manages the actual breakpoint that will be inserted into the running program.
bool SetTrapOpcode(const uint8_t *trap_opcode, uint32_t trap_opcode_size)
Sets the trap opcode.
Generic representation of a type in a programming language.
CompilerType GetPointerType() const
Return a new CompilerType that is a pointer to this type.
A uniqued constant string class.
bool IsEmpty() const
Test for empty string.
const char * GetCString() const
Get the string value as a C string.
A class to manage flag bits.
TargetList & GetTargetList()
Get accessor for the target list.
llvm::Error GetAsError(lldb::ExpressionResults result, llvm::Twine message={}) const
Returns an ExpressionError with arg as error code.
void SetUnwindOnError(bool unwind=false)
void SetExecutionPolicy(ExecutionPolicy policy=eExecutionPolicyAlways)
void SetLanguage(lldb::LanguageType language_type)
void SetTrapExceptions(bool b)
void SetTimeout(const Timeout< std::micro > &timeout)
void SetIsForUtilityExpr(bool b)
void SetIgnoreBreakpoints(bool ignore=false)
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
const lldb::ProcessSP & GetProcessSP() const
Get accessor to get the process shared pointer.
const lldb::ThreadSP & GetThreadSP() const
Get accessor to get the thread shared pointer.
void SetFile(llvm::StringRef path, Style style)
Change the file specified with a new path.
size_t GetPath(char *path, size_t max_path_length, bool denormalize=true) const
Extract the full path to the file.
void Clear()
Clears the object state.
ValueType Set(ValueType mask)
Set one or more flags by logical OR'ing mask with the current flags.
Encapsulates a function that can be called.
ValueList GetArgumentValues() const
void DeallocateFunctionResults(ExecutionContext &exe_ctx, lldb::addr_t args_addr)
Deallocate the arguments structure.
lldb::ExpressionResults ExecuteFunction(ExecutionContext &exe_ctx, lldb::addr_t *args_addr_ptr, const EvaluateExpressionOptions &options, DiagnosticManager &diagnostic_manager, Value &results)
Run the function this FunctionCaller was created with.
bool WriteFunctionArguments(ExecutionContext &exe_ctx, lldb::addr_t &args_addr_ref, DiagnosticManager &diagnostic_manager)
Insert the default function argument struct.
static bool RegisterPlugin(llvm::StringRef name, llvm::StringRef description, ABICreateInstance create_callback)
static bool UnregisterPlugin(ABICreateInstance create_callback)
lldb::ListenerSP GetListenerForProcess(Debugger &debugger)
llvm::StringRef GetProcessPluginName() const
lldb::ListenerSP GetHijackListener() const
lldb::pid_t GetProcessID() const
lldb::ListenerSP GetListener() const
llvm::StringRef GetProcessPluginName() const
std::chrono::seconds GetUtilityExpressionTimeout() const
A plug-in interface definition class for debugging a process.
UtilityFunction * GetLoadImageUtilityFunction(Platform *platform, llvm::function_ref< std::unique_ptr< UtilityFunction >()> factory)
Get the cached UtilityFunction that assists in loading binary images into the process.
void ResetImageToken(size_t token)
ThreadList & GetThreadList()
lldb::addr_t AllocateMemory(size_t size, uint32_t permissions, Status &error)
The public interface to allocating memory in the process.
bool WritePointerToMemory(lldb::addr_t vm_addr, lldb::addr_t ptr_value, Status &error)
virtual size_t ReadMemory(lldb::addr_t vm_addr, void *buf, size_t size, Status &error)
Read of memory from a process.
size_t AddImageToken(lldb::addr_t image_ptr)
uint64_t ReadUnsignedIntegerFromMemory(lldb::addr_t load_addr, size_t byte_size, uint64_t fail_value, Status &error)
Reads an unsigned integer of the specified byte size from process memory.
lldb::addr_t ReadPointerFromMemory(lldb::addr_t vm_addr, Status &error)
Status DeallocateMemory(lldb::addr_t ptr)
The public interface to deallocating memory in the process.
lldb::addr_t GetImagePtrFromToken(size_t token) const
uint32_t GetAddressByteSize() const
size_t WriteMemory(lldb::addr_t vm_addr, const void *buf, size_t size, Status &error)
Write memory to a process.
virtual DynamicLoader * GetDynamicLoader()
Get the dynamic loader plug-in for this process.
size_t WriteScalarToMemory(lldb::addr_t vm_addr, const Scalar &scalar, size_t size, Status &error)
Write all or part of a scalar value to memory.
Target & GetTarget()
Get the target object pointer for this module.
unsigned int UInt(unsigned int fail_value=0) const
static lldb::TypeSystemClangSP GetForTarget(Target &target, std::optional< IsolatedASTKind > ast_kind=DefaultAST, bool create_on_demand=true)
Returns the scratch TypeSystemClang for the given target.
static Status FromErrorStringWithFormat(const char *format,...) __attribute__((format(printf
static Status FromErrorString(const char *str)
bool Fail() const
Test for error condition.
const char * AsCString(const char *default_error_str="unknown error") const
Get the error string associated with the current error.
static Status static Status FromErrorStringWithFormatv(const char *format, Args &&...args)
static Status FromError(llvm::Error error)
Avoid using this in new code. Migrate APIs to llvm::Expected instead.
bool Success() const
Test for success condition.
const char * GetData() const
llvm::StringRef GetString() const
A stream class that can stream formatted output to a file.
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Status CreateTarget(Debugger &debugger, llvm::StringRef user_exe_path, llvm::StringRef triple_str, LoadDependentFiles get_dependent_modules, const OptionGroupPlatform *platform_options, lldb::TargetSP &target_sp)
Create a new Target.
const lldb::ProcessSP & CreateProcess(lldb::ListenerSP listener_sp, llvm::StringRef plugin_name, const FileSpec *crash_file, bool can_connect)
llvm::Expected< std::unique_ptr< UtilityFunction > > CreateUtilityFunction(std::string expression, std::string name, lldb::LanguageType language, ExecutionContext &exe_ctx)
Creates and installs a UtilityFunction for the given language.
const ArchSpec & GetArchitecture() const
lldb::ThreadSP GetExpressionExecutionThread()
static lldb::ExpressionResults Evaluate(ExecutionContext &exe_ctx, const EvaluateExpressionOptions &options, llvm::StringRef expr_cstr, llvm::StringRef expr_prefix, lldb::ValueObjectSP &result_valobj_sp, std::string *fixed_expression=nullptr, ValueObject *ctx_obj=nullptr)
Evaluate one expression in the scratch context of the target passed in the exe_ctx and return its res...
"lldb/Expression/UtilityFunction.h" Encapsulates a bit of source code that provides a function that i...
FunctionCaller * GetFunctionCaller()
void PushValue(const Value &value)
Value * GetValueAtIndex(size_t idx)
const Scalar & GetScalar() const
See comment on m_scalar to understand what GetScalar returns.
@ Scalar
A raw scalar value.
void SetCompilerType(const CompilerType &compiler_type)
void SetValueType(ValueType value_type)
#define LLDB_INVALID_IMAGE_TOKEN
#define LLDB_INVALID_ADDRESS
#define LLDB_INVALID_PROCESS_ID
A class that represents a running process on the host machine.
Log * GetLog(Cat mask)
Retrieve the Log object for the channel associated with the given log enum.
std::shared_ptr< lldb_private::StackFrame > StackFrameSP
std::shared_ptr< lldb_private::Thread > ThreadSP
std::shared_ptr< lldb_private::ValueObject > ValueObjectSP
std::shared_ptr< lldb_private::Platform > PlatformSP
@ eLanguageTypeC_plus_plus
ISO C++:1998.
ExpressionResults
The results of expression evaluation.
std::shared_ptr< lldb_private::Process > ProcessSP
std::shared_ptr< lldb_private::TypeSystemClang > TypeSystemClangSP
std::shared_ptr< lldb_private::Target > TargetSP