LLDB mainline
windows/Host.cpp
Go to the documentation of this file.
1//===-- source/Host/windows/Host.cpp --------------------------------------===//
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
11#include <cstdio>
12
14#include "lldb/Host/Host.h"
15#include "lldb/Host/HostInfo.h"
19#include "lldb/Utility/Log.h"
21#include "lldb/Utility/Status.h"
24
25#include "llvm/Support/ConvertUTF.h"
26
27// Windows includes
28#include <tlhelp32.h>
29
30using namespace lldb;
31using namespace lldb_private;
32
33static bool GetTripleForProcess(const FileSpec &executable,
34 llvm::Triple &triple) {
35 // Open the PE File as a binary file, and parse just enough information to
36 // determine the machine type.
37 auto imageBinaryP = FileSystem::Instance().Open(
38 executable, File::eOpenOptionReadOnly, lldb::eFilePermissionsUserRead);
39 if (!imageBinaryP)
40 return llvm::errorToBool(imageBinaryP.takeError());
41 File &imageBinary = *imageBinaryP.get();
42 imageBinary.SeekFromStart(0x3c);
43 int32_t peOffset = 0;
44 uint32_t peHead = 0;
45 uint16_t machineType = 0;
46 size_t readSize = sizeof(peOffset);
47 imageBinary.Read(&peOffset, readSize);
48 imageBinary.SeekFromStart(peOffset);
49 imageBinary.Read(&peHead, readSize);
50 if (peHead != 0x00004550) // "PE\0\0", little-endian
51 return false; // Status: Can't find PE header
52 readSize = 2;
53 imageBinary.Read(&machineType, readSize);
54 triple.setVendor(llvm::Triple::PC);
55 triple.setOS(llvm::Triple::Win32);
56 triple.setArch(llvm::Triple::UnknownArch);
57 if (machineType == 0x8664)
58 triple.setArch(llvm::Triple::x86_64);
59 else if (machineType == 0x14c)
60 triple.setArch(llvm::Triple::x86);
61 else if (machineType == 0x1c4)
62 triple.setArch(llvm::Triple::arm);
63 else if (machineType == 0xaa64)
64 triple.setArch(llvm::Triple::aarch64);
65
66 return true;
67}
68
69static bool GetExecutableForProcess(const AutoHandle &handle,
70 std::string &path) {
71 // Get the process image path. MAX_PATH isn't long enough, paths can
72 // actually be up to 32KB.
73 std::vector<wchar_t> buffer(PATH_MAX);
74 DWORD dwSize = buffer.size();
75 if (!::QueryFullProcessImageNameW(handle.get(), 0, &buffer[0], &dwSize))
76 return false;
77 return llvm::convertWideToUTF8(buffer.data(), path);
78}
79
80static void GetProcessExecutableAndTriple(const AutoHandle &handle,
81 ProcessInstanceInfo &process) {
82 // We may not have permissions to read the path from the process. So start
83 // off by setting the executable file to whatever Toolhelp32 gives us, and
84 // then try to enhance this with more detailed information, but fail
85 // gracefully.
86 std::string executable;
87 llvm::Triple triple;
88 triple.setVendor(llvm::Triple::PC);
89 triple.setOS(llvm::Triple::Win32);
90 triple.setArch(llvm::Triple::UnknownArch);
91 if (GetExecutableForProcess(handle, executable)) {
92 FileSpec executableFile(executable.c_str());
93 process.SetExecutableFile(executableFile, true);
94 GetTripleForProcess(executableFile, triple);
95 }
96 process.SetArchitecture(ArchSpec(triple));
97
98 // TODO(zturner): Add the ability to get the process user name.
99}
100
103}
104
105void Host::Kill(lldb::pid_t pid, int signo) {
106 TerminateProcess((HANDLE)pid, 1);
107}
108
109const char *Host::GetSignalAsCString(int signo) { return NULL; }
110
111FileSpec Host::GetModuleFileSpecForHostAddress(const void *host_addr) {
112 FileSpec module_filespec;
113
114 HMODULE hmodule = NULL;
115 if (!::GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
116 (LPCTSTR)host_addr, &hmodule))
117 return module_filespec;
118
119 std::vector<wchar_t> buffer(PATH_MAX);
120 DWORD chars_copied = 0;
121 do {
122 chars_copied = ::GetModuleFileNameW(hmodule, &buffer[0], buffer.size());
123 if (chars_copied == buffer.size() &&
124 ::GetLastError() == ERROR_INSUFFICIENT_BUFFER)
125 buffer.resize(buffer.size() * 2);
126 } while (chars_copied >= buffer.size());
127 std::string path;
128 if (!llvm::convertWideToUTF8(buffer.data(), path))
129 return module_filespec;
130 module_filespec.SetFile(path, FileSpec::Style::native);
131 return module_filespec;
132}
133
134uint32_t Host::FindProcessesImpl(const ProcessInstanceInfoMatch &match_info,
135 ProcessInstanceInfoList &process_infos) {
136 process_infos.clear();
137
138 AutoHandle snapshot(CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0));
139 if (!snapshot.IsValid())
140 return 0;
141
142 PROCESSENTRY32W pe = {};
143 pe.dwSize = sizeof(PROCESSENTRY32W);
144 if (Process32FirstW(snapshot.get(), &pe)) {
145 do {
146 AutoHandle handle(::OpenProcess(PROCESS_QUERY_LIMITED_INFORMATION, FALSE,
147 pe.th32ProcessID),
148 nullptr);
149
150 ProcessInstanceInfo process;
151 std::string exeFile;
152 llvm::convertWideToUTF8(pe.szExeFile, exeFile);
153 process.SetExecutableFile(FileSpec(exeFile), true);
154 process.SetProcessID(pe.th32ProcessID);
155 process.SetParentProcessID(pe.th32ParentProcessID);
156 GetProcessExecutableAndTriple(handle, process);
157
158 if (match_info.MatchAllProcesses() || match_info.Matches(process))
159 process_infos.push_back(process);
160 } while (Process32NextW(snapshot.get(), &pe));
161 }
162 return process_infos.size();
163}
164
166 process_info.Clear();
167
168 AutoHandle handle(
169 ::OpenProcess(PROCESS_QUERY_INFORMATION | PROCESS_VM_READ, FALSE, pid),
170 nullptr);
171 if (!handle.IsValid())
172 return false;
173
174 process_info.SetProcessID(pid);
175 GetProcessExecutableAndTriple(handle, process_info);
176
177 // Need to read the PEB to get parent process and command line arguments.
178
179 AutoHandle snapshot(CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0));
180 if (!snapshot.IsValid())
181 return false;
182
183 PROCESSENTRY32W pe;
184 pe.dwSize = sizeof(PROCESSENTRY32W);
185 if (Process32FirstW(snapshot.get(), &pe)) {
186 do {
187 if (pe.th32ProcessID == pid) {
188 process_info.SetParentProcessID(pe.th32ParentProcessID);
189 return true;
190 }
191 } while (Process32NextW(snapshot.get(), &pe));
192 }
193
194 return false;
195}
196
197llvm::Expected<HostThread> Host::StartMonitoringChildProcess(
198 const Host::MonitorChildProcessCallback &callback, lldb::pid_t pid) {
199 return HostThread();
200}
201
204 if (launch_info.GetFlags().Test(eLaunchFlagShellExpandArguments)) {
205 FileSpec expand_tool_spec = HostInfo::GetSupportExeDir();
206 if (!expand_tool_spec) {
207 error.SetErrorString("could not find support executable directory for "
208 "the lldb-argdumper tool");
209 return error;
210 }
211 expand_tool_spec.AppendPathComponent("lldb-argdumper.exe");
212 if (!FileSystem::Instance().Exists(expand_tool_spec)) {
213 error.SetErrorString("could not find the lldb-argdumper tool");
214 return error;
215 }
216
217 std::string quoted_cmd_string;
218 launch_info.GetArguments().GetQuotedCommandString(quoted_cmd_string);
219 std::replace(quoted_cmd_string.begin(), quoted_cmd_string.end(), '\\', '/');
220 StreamString expand_command;
221
222 expand_command.Printf("\"%s\" %s", expand_tool_spec.GetPath().c_str(),
223 quoted_cmd_string.c_str());
224
225 int status;
226 std::string output;
227 std::string command = expand_command.GetString().str();
228 Status e =
229 RunShellCommand(command.c_str(), launch_info.GetWorkingDirectory(),
230 &status, nullptr, &output, std::chrono::seconds(10));
231
232 if (e.Fail())
233 return e;
234
235 if (status != 0) {
236 error.SetErrorStringWithFormat("lldb-argdumper exited with error %d",
237 status);
238 return error;
239 }
240
241 auto data_sp = StructuredData::ParseJSON(output);
242 if (!data_sp) {
243 error.SetErrorString("invalid JSON");
244 return error;
245 }
246
247 auto dict_sp = data_sp->GetAsDictionary();
248 if (!dict_sp) {
249 error.SetErrorString("invalid JSON");
250 return error;
251 }
252
253 auto args_sp = dict_sp->GetObjectForDotSeparatedPath("arguments");
254 if (!args_sp) {
255 error.SetErrorString("invalid JSON");
256 return error;
257 }
258
259 auto args_array_sp = args_sp->GetAsArray();
260 if (!args_array_sp) {
261 error.SetErrorString("invalid JSON");
262 return error;
263 }
264
265 launch_info.GetArguments().Clear();
266
267 for (size_t i = 0; i < args_array_sp->GetSize(); i++) {
268 auto item_sp = args_array_sp->GetItemAtIndex(i);
269 if (!item_sp)
270 continue;
271 auto str_sp = item_sp->GetAsString();
272 if (!str_sp)
273 continue;
274
275 launch_info.GetArguments().AppendArgument(str_sp->GetValue());
276 }
277 }
278
279 return error;
280}
281
283 Environment env;
284 // The environment block on Windows is a contiguous buffer of NULL terminated
285 // strings, where the end of the environment block is indicated by two
286 // consecutive NULLs.
287 LPWCH environment_block = ::GetEnvironmentStringsW();
288 while (*environment_block != L'\0') {
289 std::string current_var;
290 auto current_var_size = wcslen(environment_block) + 1;
291 if (!llvm::convertWideToUTF8(environment_block, current_var)) {
292 environment_block += current_var_size;
293 continue;
294 }
295 if (current_var[0] != '=')
296 env.insert(current_var);
297
298 environment_block += current_var_size;
299 }
300 return env;
301}
static llvm::raw_ostream & error(Stream &strm)
An architecture specification class.
Definition: ArchSpec.h:31
void AppendArgument(llvm::StringRef arg_str, char quote_char='\0')
Appends a new argument to the end of the list argument list.
Definition: Args.cpp:322
bool GetQuotedCommandString(std::string &command) const
Definition: Args.cpp:228
void Clear()
Clear the arguments.
Definition: Args.cpp:378
HANDLE get() const
Definition: AutoHandle.h:28
std::pair< iterator, bool > insert(llvm::StringRef KeyEqValue)
Definition: Environment.h:71
A file utility class.
Definition: FileSpec.h:56
void SetFile(llvm::StringRef path, Style style)
Change the file specified with a new path.
Definition: FileSpec.cpp:174
void AppendPathComponent(llvm::StringRef component)
Definition: FileSpec.cpp:447
size_t GetPath(char *path, size_t max_path_length, bool denormalize=true) const
Extract the full path to the file.
Definition: FileSpec.cpp:367
int Open(const char *path, int flags, int mode=0600)
Wraps ::open in a platform-independent way.
static FileSystem & Instance()
An abstract base class for files.
Definition: File.h:36
Status Read(void *buf, size_t &num_bytes) override
Read bytes from a file from the current file position into buf.
Definition: File.cpp:106
virtual off_t SeekFromStart(off_t offset, Status *error_ptr=nullptr)
Seek to an offset relative to the beginning of the file.
Definition: File.cpp:130
@ eOpenOptionReadOnly
Definition: File.h:51
bool Test(ValueType bit) const
Test a single flag bit.
Definition: Flags.h:96
static Status ShellExpandArguments(ProcessLaunchInfo &launch_info)
Perform expansion of the command-line for this launch info This can potentially involve wildcard expa...
static Status RunShellCommand(llvm::StringRef command, const FileSpec &working_dir, int *status_ptr, int *signo_ptr, std::string *command_output, const Timeout< std::micro > &timeout, bool run_in_shell=true, bool hide_stderr=false)
Run a shell command.
static lldb::thread_t GetCurrentThread()
Get the thread token (the one returned by ThreadCreate when the thread was created) for the calling t...
static Environment GetEnvironment()
static uint32_t FindProcessesImpl(const ProcessInstanceInfoMatch &match_info, ProcessInstanceInfoList &proc_infos)
static bool GetProcessInfo(lldb::pid_t pid, ProcessInstanceInfo &proc_info)
static FileSpec GetModuleFileSpecForHostAddress(const void *host_addr)
Given an address in the current process (the process that is running the LLDB code),...
std::function< void(lldb::pid_t pid, int signal, int status)> MonitorChildProcessCallback
Definition: Host.h:69
static llvm::Expected< HostThread > StartMonitoringChildProcess(const MonitorChildProcessCallback &callback, lldb::pid_t pid)
Start monitoring a child process.
static void Kill(lldb::pid_t pid, int signo)
static const char * GetSignalAsCString(int signo)
void SetExecutableFile(const FileSpec &exe_file, bool add_exe_file_as_first_arg)
Definition: ProcessInfo.cpp:65
void SetArchitecture(const ArchSpec &arch)
Definition: ProcessInfo.h:65
void SetProcessID(lldb::pid_t pid)
Definition: ProcessInfo.h:69
bool Matches(const ProcessInstanceInfo &proc_info) const
void SetParentProcessID(lldb::pid_t pid)
Definition: ProcessInfo.h:174
const FileSpec & GetWorkingDirectory() const
An error handling class.
Definition: Status.h:44
bool Fail() const
Test for error condition.
Definition: Status.cpp:180
llvm::StringRef GetString() const
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: Stream.cpp:134
static ObjectSP ParseJSON(llvm::StringRef json_text)
A class that represents a running process on the host machine.
std::vector< ProcessInstanceInfo > ProcessInstanceInfoList
Definition: Host.h:32
Definition: SBAddress.h:15
pthread_t thread_t
Definition: lldb-types.h:58
uint64_t pid_t
Definition: lldb-types.h:83
static void GetProcessExecutableAndTriple(const AutoHandle &handle, ProcessInstanceInfo &process)
static bool GetTripleForProcess(const FileSpec &executable, llvm::Triple &triple)
static bool GetExecutableForProcess(const AutoHandle &handle, std::string &path)
#define PATH_MAX