blob: 914d690ad88cbdb37127caf3070fa8c177fc5dc5 [file] [log] [blame]
Todd Fialaaf245d12014-06-30 21:05:18 +00001//===-- NativeProcessLinux.cpp -------------------------------- -*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Todd Fialaaf245d12014-06-30 21:05:18 +000010#include "NativeProcessLinux.h"
11
12// C Includes
13#include <errno.h>
Todd Fialaaf245d12014-06-30 21:05:18 +000014#include <stdint.h>
Kate Stoneb9c1b512016-09-06 20:57:50 +000015#include <string.h>
Todd Fialaaf245d12014-06-30 21:05:18 +000016#include <unistd.h>
Todd Fialaaf245d12014-06-30 21:05:18 +000017
18// C++ Includes
19#include <fstream>
Pavel Labathdf7c6992015-06-17 18:38:49 +000020#include <mutex>
Pavel Labathc0765592015-05-06 10:46:34 +000021#include <sstream>
Todd Fialaaf245d12014-06-30 21:05:18 +000022#include <string>
Pavel Labath5b981ab2015-05-29 12:53:54 +000023#include <unordered_map>
Todd Fialaaf245d12014-06-30 21:05:18 +000024
25// Other libraries and framework includes
Tamas Berghammerd8c338d2015-04-15 09:47:02 +000026#include "lldb/Core/EmulateInstruction.h"
Oleksiy Vyalov6edef202014-11-17 22:16:42 +000027#include "lldb/Core/ModuleSpec.h"
Todd Fialaaf245d12014-06-30 21:05:18 +000028#include "lldb/Core/RegisterValue.h"
Todd Fialaaf245d12014-06-30 21:05:18 +000029#include "lldb/Core/State.h"
30#include "lldb/Host/Host.h"
Pavel Labath5ad891f2016-07-21 14:54:03 +000031#include "lldb/Host/HostProcess.h"
Zachary Turner24ae6292017-02-16 19:38:21 +000032#include "lldb/Host/PseudoTerminal.h"
Zachary Turner39de3112014-09-09 20:54:56 +000033#include "lldb/Host/ThreadLauncher.h"
Pavel Labath2a86b552016-06-14 17:30:52 +000034#include "lldb/Host/common/NativeBreakpoint.h"
35#include "lldb/Host/common/NativeRegisterContext.h"
Pavel Labath4ee1c952017-02-06 18:36:58 +000036#include "lldb/Host/linux/Ptrace.h"
37#include "lldb/Host/linux/Uio.h"
Kamil Rytarowski816ae4b2017-02-01 14:30:40 +000038#include "lldb/Host/posix/ProcessLauncherPosixFork.h"
Pavel Labath2a86b552016-06-14 17:30:52 +000039#include "lldb/Symbol/ObjectFile.h"
Zachary Turner90aff472015-03-03 23:36:51 +000040#include "lldb/Target/Process.h"
Todd Fialaaf245d12014-06-30 21:05:18 +000041#include "lldb/Target/ProcessLaunchInfo.h"
Pavel Labath5b981ab2015-05-29 12:53:54 +000042#include "lldb/Target/Target.h"
Zachary Turnerbf9a7732017-02-02 21:39:50 +000043#include "lldb/Utility/Error.h"
Chaoren Linc16f5dc2015-03-19 23:28:10 +000044#include "lldb/Utility/LLDBAssert.h"
Pavel Labathf805e192015-07-07 10:08:41 +000045#include "lldb/Utility/StringExtractor.h"
Todd Fialaaf245d12014-06-30 21:05:18 +000046
Todd Fialaaf245d12014-06-30 21:05:18 +000047#include "NativeThreadLinux.h"
Kate Stoneb9c1b512016-09-06 20:57:50 +000048#include "Plugins/Process/POSIX/ProcessPOSIXLog.h"
Tamas Berghammer1e209fc2015-03-13 11:36:47 +000049#include "Procfs.h"
Todd Fialacacde7d2014-09-27 16:54:22 +000050
Zachary Turner7d86ee52017-03-08 17:56:08 +000051#include "llvm/Support/FileSystem.h"
Pavel Labath4ee1c952017-02-06 18:36:58 +000052#include "llvm/Support/Threading.h"
53
Tamas Berghammerd8584872015-02-06 10:57:40 +000054#include <linux/unistd.h>
Tamas Berghammerd8584872015-02-06 10:57:40 +000055#include <sys/socket.h>
Pavel Labathdf7c6992015-06-17 18:38:49 +000056#include <sys/syscall.h>
Tamas Berghammerd8584872015-02-06 10:57:40 +000057#include <sys/types.h>
Tamas Berghammerd8584872015-02-06 10:57:40 +000058#include <sys/user.h>
59#include <sys/wait.h>
60
Todd Fialaaf245d12014-06-30 21:05:18 +000061// Support hardware breakpoints in case it has not been defined
62#ifndef TRAP_HWBKPT
Kate Stoneb9c1b512016-09-06 20:57:50 +000063#define TRAP_HWBKPT 4
Todd Fialaaf245d12014-06-30 21:05:18 +000064#endif
65
Tamas Berghammer7cb18bf2015-03-24 11:15:23 +000066using namespace lldb;
67using namespace lldb_private;
Tamas Berghammerdb264a62015-03-31 09:52:22 +000068using namespace lldb_private::process_linux;
Tamas Berghammer7cb18bf2015-03-24 11:15:23 +000069using namespace llvm;
70
Todd Fialaaf245d12014-06-30 21:05:18 +000071// Private bits we only need internally.
Pavel Labathdf7c6992015-06-17 18:38:49 +000072
Kate Stoneb9c1b512016-09-06 20:57:50 +000073static bool ProcessVmReadvSupported() {
74 static bool is_supported;
Kamil Rytarowskic5f28e22017-02-06 17:55:02 +000075 static llvm::once_flag flag;
Pavel Labathdf7c6992015-06-17 18:38:49 +000076
Kamil Rytarowskic5f28e22017-02-06 17:55:02 +000077 llvm::call_once(flag, [] {
Pavel Labatha6321a82017-01-19 15:26:04 +000078 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
Pavel Labath4abe5d62016-07-15 10:18:15 +000079
Kate Stoneb9c1b512016-09-06 20:57:50 +000080 uint32_t source = 0x47424742;
81 uint32_t dest = 0;
Pavel Labath4abe5d62016-07-15 10:18:15 +000082
Kate Stoneb9c1b512016-09-06 20:57:50 +000083 struct iovec local, remote;
84 remote.iov_base = &source;
85 local.iov_base = &dest;
86 remote.iov_len = local.iov_len = sizeof source;
Pavel Labath4abe5d62016-07-15 10:18:15 +000087
Kate Stoneb9c1b512016-09-06 20:57:50 +000088 // We shall try if cross-process-memory reads work by attempting to read a
89 // value from our own process.
90 ssize_t res = process_vm_readv(getpid(), &local, 1, &remote, 1, 0);
91 is_supported = (res == sizeof(source) && source == dest);
Pavel Labatha6321a82017-01-19 15:26:04 +000092 if (is_supported)
93 LLDB_LOG(log,
94 "Detected kernel support for process_vm_readv syscall. "
95 "Fast memory reads enabled.");
96 else
97 LLDB_LOG(log,
98 "syscall process_vm_readv failed (error: {0}). Fast memory "
99 "reads disabled.",
100 strerror(errno));
Kate Stoneb9c1b512016-09-06 20:57:50 +0000101 });
Pavel Labath4abe5d62016-07-15 10:18:15 +0000102
Kate Stoneb9c1b512016-09-06 20:57:50 +0000103 return is_supported;
Pavel Labath4abe5d62016-07-15 10:18:15 +0000104}
105
Kate Stoneb9c1b512016-09-06 20:57:50 +0000106namespace {
107void MaybeLogLaunchInfo(const ProcessLaunchInfo &info) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000108 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
Kate Stoneb9c1b512016-09-06 20:57:50 +0000109 if (!log)
110 return;
111
112 if (const FileAction *action = info.GetFileActionForFD(STDIN_FILENO))
Pavel Labatha6321a82017-01-19 15:26:04 +0000113 LLDB_LOG(log, "setting STDIN to '{0}'", action->GetFileSpec());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000114 else
Pavel Labatha6321a82017-01-19 15:26:04 +0000115 LLDB_LOG(log, "leaving STDIN as is");
Kate Stoneb9c1b512016-09-06 20:57:50 +0000116
117 if (const FileAction *action = info.GetFileActionForFD(STDOUT_FILENO))
Pavel Labatha6321a82017-01-19 15:26:04 +0000118 LLDB_LOG(log, "setting STDOUT to '{0}'", action->GetFileSpec());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000119 else
Pavel Labatha6321a82017-01-19 15:26:04 +0000120 LLDB_LOG(log, "leaving STDOUT as is");
Kate Stoneb9c1b512016-09-06 20:57:50 +0000121
122 if (const FileAction *action = info.GetFileActionForFD(STDERR_FILENO))
Pavel Labatha6321a82017-01-19 15:26:04 +0000123 LLDB_LOG(log, "setting STDERR to '{0}'", action->GetFileSpec());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000124 else
Pavel Labatha6321a82017-01-19 15:26:04 +0000125 LLDB_LOG(log, "leaving STDERR as is");
Kate Stoneb9c1b512016-09-06 20:57:50 +0000126
127 int i = 0;
128 for (const char **args = info.GetArguments().GetConstArgumentVector(); *args;
129 ++args, ++i)
Pavel Labatha6321a82017-01-19 15:26:04 +0000130 LLDB_LOG(log, "arg {0}: '{1}'", i, *args);
Pavel Labath4abe5d62016-07-15 10:18:15 +0000131}
Todd Fialaaf245d12014-06-30 21:05:18 +0000132
Kate Stoneb9c1b512016-09-06 20:57:50 +0000133void DisplayBytes(StreamString &s, void *bytes, uint32_t count) {
134 uint8_t *ptr = (uint8_t *)bytes;
135 const uint32_t loop_count = std::min<uint32_t>(DEBUG_PTRACE_MAXBYTES, count);
136 for (uint32_t i = 0; i < loop_count; i++) {
137 s.Printf("[%x]", *ptr);
138 ptr++;
139 }
140}
Todd Fialaaf245d12014-06-30 21:05:18 +0000141
Kate Stoneb9c1b512016-09-06 20:57:50 +0000142void PtraceDisplayBytes(int &req, void *data, size_t data_size) {
Pavel Labathaafe0532017-02-06 19:31:05 +0000143 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PTRACE));
Pavel Labatha6321a82017-01-19 15:26:04 +0000144 if (!log)
145 return;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000146 StreamString buf;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000147
Pavel Labatha6321a82017-01-19 15:26:04 +0000148 switch (req) {
149 case PTRACE_POKETEXT: {
150 DisplayBytes(buf, &data, 8);
Pavel Labathaafe0532017-02-06 19:31:05 +0000151 LLDB_LOGV(log, "PTRACE_POKETEXT {0}", buf.GetData());
Pavel Labatha6321a82017-01-19 15:26:04 +0000152 break;
153 }
154 case PTRACE_POKEDATA: {
155 DisplayBytes(buf, &data, 8);
Pavel Labathaafe0532017-02-06 19:31:05 +0000156 LLDB_LOGV(log, "PTRACE_POKEDATA {0}", buf.GetData());
Pavel Labatha6321a82017-01-19 15:26:04 +0000157 break;
158 }
159 case PTRACE_POKEUSER: {
160 DisplayBytes(buf, &data, 8);
Pavel Labathaafe0532017-02-06 19:31:05 +0000161 LLDB_LOGV(log, "PTRACE_POKEUSER {0}", buf.GetData());
Pavel Labatha6321a82017-01-19 15:26:04 +0000162 break;
163 }
164 case PTRACE_SETREGS: {
165 DisplayBytes(buf, data, data_size);
Pavel Labathaafe0532017-02-06 19:31:05 +0000166 LLDB_LOGV(log, "PTRACE_SETREGS {0}", buf.GetData());
Pavel Labatha6321a82017-01-19 15:26:04 +0000167 break;
168 }
169 case PTRACE_SETFPREGS: {
170 DisplayBytes(buf, data, data_size);
Pavel Labathaafe0532017-02-06 19:31:05 +0000171 LLDB_LOGV(log, "PTRACE_SETFPREGS {0}", buf.GetData());
Pavel Labatha6321a82017-01-19 15:26:04 +0000172 break;
173 }
174 case PTRACE_SETSIGINFO: {
175 DisplayBytes(buf, data, sizeof(siginfo_t));
Pavel Labathaafe0532017-02-06 19:31:05 +0000176 LLDB_LOGV(log, "PTRACE_SETSIGINFO {0}", buf.GetData());
Pavel Labatha6321a82017-01-19 15:26:04 +0000177 break;
178 }
179 case PTRACE_SETREGSET: {
180 // Extract iov_base from data, which is a pointer to the struct IOVEC
181 DisplayBytes(buf, *(void **)data, data_size);
Pavel Labathaafe0532017-02-06 19:31:05 +0000182 LLDB_LOGV(log, "PTRACE_SETREGSET {0}", buf.GetData());
Pavel Labatha6321a82017-01-19 15:26:04 +0000183 break;
184 }
185 default: {}
Kate Stoneb9c1b512016-09-06 20:57:50 +0000186 }
187}
Todd Fialaaf245d12014-06-30 21:05:18 +0000188
Kate Stoneb9c1b512016-09-06 20:57:50 +0000189static constexpr unsigned k_ptrace_word_size = sizeof(void *);
190static_assert(sizeof(long) >= k_ptrace_word_size,
191 "Size of long must be larger than ptrace word size");
Pavel Labath1107b5a2015-04-17 14:07:49 +0000192} // end of anonymous namespace
193
Pavel Labathbd7cbc52015-04-20 13:53:49 +0000194// Simple helper function to ensure flags are enabled on the given file
195// descriptor.
Kate Stoneb9c1b512016-09-06 20:57:50 +0000196static Error EnsureFDFlags(int fd, int flags) {
197 Error error;
Pavel Labathbd7cbc52015-04-20 13:53:49 +0000198
Kate Stoneb9c1b512016-09-06 20:57:50 +0000199 int status = fcntl(fd, F_GETFL);
200 if (status == -1) {
201 error.SetErrorToErrno();
Pavel Labathbd7cbc52015-04-20 13:53:49 +0000202 return error;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000203 }
204
205 if (fcntl(fd, F_SETFL, status | flags) == -1) {
206 error.SetErrorToErrno();
207 return error;
208 }
209
210 return error;
Pavel Labathbd7cbc52015-04-20 13:53:49 +0000211}
212
Todd Fialaaf245d12014-06-30 21:05:18 +0000213// -----------------------------------------------------------------------------
214// Public Static Methods
215// -----------------------------------------------------------------------------
216
Kate Stoneb9c1b512016-09-06 20:57:50 +0000217Error NativeProcessProtocol::Launch(
Tamas Berghammerdb264a62015-03-31 09:52:22 +0000218 ProcessLaunchInfo &launch_info,
Kate Stoneb9c1b512016-09-06 20:57:50 +0000219 NativeProcessProtocol::NativeDelegate &native_delegate, MainLoop &mainloop,
220 NativeProcessProtocolSP &native_process_sp) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000221 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
Todd Fialaaf245d12014-06-30 21:05:18 +0000222
Kate Stoneb9c1b512016-09-06 20:57:50 +0000223 Error error;
Todd Fialaaf245d12014-06-30 21:05:18 +0000224
Kate Stoneb9c1b512016-09-06 20:57:50 +0000225 // Verify the working directory is valid if one was specified.
226 FileSpec working_dir{launch_info.GetWorkingDirectory()};
Zachary Turner7d86ee52017-03-08 17:56:08 +0000227 if (working_dir && (!working_dir.ResolvePath() ||
228 !llvm::sys::fs::is_directory(working_dir.GetPath()))) {
Kate Stoneb9c1b512016-09-06 20:57:50 +0000229 error.SetErrorStringWithFormat("No such file or directory: %s",
230 working_dir.GetCString());
Todd Fialaaf245d12014-06-30 21:05:18 +0000231 return error;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000232 }
233
234 // Create the NativeProcessLinux in launch mode.
235 native_process_sp.reset(new NativeProcessLinux());
236
237 if (!native_process_sp->RegisterNativeDelegate(native_delegate)) {
238 native_process_sp.reset();
239 error.SetErrorStringWithFormat("failed to register the native delegate");
240 return error;
241 }
242
243 error = std::static_pointer_cast<NativeProcessLinux>(native_process_sp)
244 ->LaunchInferior(mainloop, launch_info);
245
246 if (error.Fail()) {
247 native_process_sp.reset();
Pavel Labatha6321a82017-01-19 15:26:04 +0000248 LLDB_LOG(log, "failed to launch process: {0}", error);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000249 return error;
250 }
251
252 launch_info.SetProcessID(native_process_sp->GetID());
253
254 return error;
Todd Fialaaf245d12014-06-30 21:05:18 +0000255}
256
Kate Stoneb9c1b512016-09-06 20:57:50 +0000257Error NativeProcessProtocol::Attach(
258 lldb::pid_t pid, NativeProcessProtocol::NativeDelegate &native_delegate,
259 MainLoop &mainloop, NativeProcessProtocolSP &native_process_sp) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000260 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
261 LLDB_LOG(log, "pid = {0:x}", pid);
Todd Fialaaf245d12014-06-30 21:05:18 +0000262
Kate Stoneb9c1b512016-09-06 20:57:50 +0000263 // Retrieve the architecture for the running process.
264 ArchSpec process_arch;
265 Error error = ResolveProcessArchitecture(pid, process_arch);
266 if (!error.Success())
Todd Fialaaf245d12014-06-30 21:05:18 +0000267 return error;
Kate Stoneb9c1b512016-09-06 20:57:50 +0000268
269 std::shared_ptr<NativeProcessLinux> native_process_linux_sp(
270 new NativeProcessLinux());
271
272 if (!native_process_linux_sp->RegisterNativeDelegate(native_delegate)) {
273 error.SetErrorStringWithFormat("failed to register the native delegate");
274 return error;
275 }
276
277 native_process_linux_sp->AttachToInferior(mainloop, pid, error);
278 if (!error.Success())
279 return error;
280
281 native_process_sp = native_process_linux_sp;
282 return error;
Todd Fialaaf245d12014-06-30 21:05:18 +0000283}
284
285// -----------------------------------------------------------------------------
286// Public Instance Methods
287// -----------------------------------------------------------------------------
288
Kate Stoneb9c1b512016-09-06 20:57:50 +0000289NativeProcessLinux::NativeProcessLinux()
290 : NativeProcessProtocol(LLDB_INVALID_PROCESS_ID), m_arch(),
291 m_supports_mem_region(eLazyBoolCalculate), m_mem_region_cache(),
292 m_pending_notification_tid(LLDB_INVALID_THREAD_ID) {}
293
294void NativeProcessLinux::AttachToInferior(MainLoop &mainloop, lldb::pid_t pid,
295 Error &error) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000296 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
297 LLDB_LOG(log, "pid = {0:x}", pid);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000298
299 m_sigchld_handle = mainloop.RegisterSignal(
300 SIGCHLD, [this](MainLoopBase &) { SigchldHandler(); }, error);
301 if (!m_sigchld_handle)
302 return;
303
304 error = ResolveProcessArchitecture(pid, m_arch);
305 if (!error.Success())
306 return;
307
308 // Set the architecture to the exe architecture.
Pavel Labatha6321a82017-01-19 15:26:04 +0000309 LLDB_LOG(log, "pid = {0:x}, detected architecture {1}", pid,
310 m_arch.GetArchitectureName());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000311 m_pid = pid;
312 SetState(eStateAttaching);
313
314 Attach(pid, error);
Todd Fialaaf245d12014-06-30 21:05:18 +0000315}
316
Kate Stoneb9c1b512016-09-06 20:57:50 +0000317Error NativeProcessLinux::LaunchInferior(MainLoop &mainloop,
318 ProcessLaunchInfo &launch_info) {
319 Error error;
320 m_sigchld_handle = mainloop.RegisterSignal(
321 SIGCHLD, [this](MainLoopBase &) { SigchldHandler(); }, error);
322 if (!m_sigchld_handle)
323 return error;
324
325 SetState(eStateLaunching);
326
327 MaybeLogLaunchInfo(launch_info);
328
329 ::pid_t pid =
Kamil Rytarowski816ae4b2017-02-01 14:30:40 +0000330 ProcessLauncherPosixFork().LaunchProcess(launch_info, error).GetProcessId();
Kate Stoneb9c1b512016-09-06 20:57:50 +0000331 if (error.Fail())
332 return error;
333
Pavel Labatha6321a82017-01-19 15:26:04 +0000334 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
Kate Stoneb9c1b512016-09-06 20:57:50 +0000335
336 // Wait for the child process to trap on its call to execve.
337 ::pid_t wpid;
338 int status;
339 if ((wpid = waitpid(pid, &status, 0)) < 0) {
340 error.SetErrorToErrno();
Pavel Labatha6321a82017-01-19 15:26:04 +0000341 LLDB_LOG(log, "waitpid for inferior failed with %s", error);
Todd Fialaaf245d12014-06-30 21:05:18 +0000342
Kate Stoneb9c1b512016-09-06 20:57:50 +0000343 // Mark the inferior as invalid.
344 // FIXME this could really use a new state - eStateLaunchFailure. For now,
345 // using eStateInvalid.
346 SetState(StateType::eStateInvalid);
Pavel Labath19cbe962015-07-21 13:20:32 +0000347
Kate Stoneb9c1b512016-09-06 20:57:50 +0000348 return error;
349 }
350 assert(WIFSTOPPED(status) && (wpid == static_cast<::pid_t>(pid)) &&
351 "Could not sync with inferior process.");
Todd Fialaaf245d12014-06-30 21:05:18 +0000352
Pavel Labatha6321a82017-01-19 15:26:04 +0000353 LLDB_LOG(log, "inferior started, now in stopped state");
Kate Stoneb9c1b512016-09-06 20:57:50 +0000354 error = SetDefaultPtraceOpts(pid);
355 if (error.Fail()) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000356 LLDB_LOG(log, "failed to set default ptrace options: {0}", error);
Todd Fialaaf245d12014-06-30 21:05:18 +0000357
Kate Stoneb9c1b512016-09-06 20:57:50 +0000358 // Mark the inferior as invalid.
359 // FIXME this could really use a new state - eStateLaunchFailure. For now,
360 // using eStateInvalid.
361 SetState(StateType::eStateInvalid);
Todd Fialaaf245d12014-06-30 21:05:18 +0000362
Kate Stoneb9c1b512016-09-06 20:57:50 +0000363 return error;
364 }
Todd Fialaaf245d12014-06-30 21:05:18 +0000365
Kate Stoneb9c1b512016-09-06 20:57:50 +0000366 // Release the master terminal descriptor and pass it off to the
367 // NativeProcessLinux instance. Similarly stash the inferior pid.
368 m_terminal_fd = launch_info.GetPTY().ReleaseMasterFileDescriptor();
369 m_pid = pid;
370 launch_info.SetProcessID(pid);
Pavel Labath4abe5d62016-07-15 10:18:15 +0000371
Kate Stoneb9c1b512016-09-06 20:57:50 +0000372 if (m_terminal_fd != -1) {
373 error = EnsureFDFlags(m_terminal_fd, O_NONBLOCK);
374 if (error.Fail()) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000375 LLDB_LOG(log,
376 "inferior EnsureFDFlags failed for ensuring terminal "
377 "O_NONBLOCK setting: {0}",
378 error);
Todd Fialaaf245d12014-06-30 21:05:18 +0000379
Kate Stoneb9c1b512016-09-06 20:57:50 +0000380 // Mark the inferior as invalid.
381 // FIXME this could really use a new state - eStateLaunchFailure. For
382 // now, using eStateInvalid.
383 SetState(StateType::eStateInvalid);
Todd Fialaaf245d12014-06-30 21:05:18 +0000384
Kate Stoneb9c1b512016-09-06 20:57:50 +0000385 return error;
Todd Fialaaf245d12014-06-30 21:05:18 +0000386 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000387 }
Todd Fialaaf245d12014-06-30 21:05:18 +0000388
Pavel Labatha6321a82017-01-19 15:26:04 +0000389 LLDB_LOG(log, "adding pid = {0}", pid);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000390 ResolveProcessArchitecture(m_pid, m_arch);
391 NativeThreadLinuxSP thread_sp = AddThread(pid);
392 assert(thread_sp && "AddThread() returned a nullptr thread");
393 thread_sp->SetStoppedBySignal(SIGSTOP);
394 ThreadWasCreated(*thread_sp);
Todd Fialaaf245d12014-06-30 21:05:18 +0000395
Kate Stoneb9c1b512016-09-06 20:57:50 +0000396 // Let our process instance know the thread has stopped.
397 SetCurrentThreadID(thread_sp->GetID());
398 SetState(StateType::eStateStopped);
399
Pavel Labatha6321a82017-01-19 15:26:04 +0000400 if (error.Fail())
401 LLDB_LOG(log, "inferior launching failed {0}", error);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000402 return error;
403}
404
405::pid_t NativeProcessLinux::Attach(lldb::pid_t pid, Error &error) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000406 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
Kate Stoneb9c1b512016-09-06 20:57:50 +0000407
408 // Use a map to keep track of the threads which we have attached/need to
409 // attach.
410 Host::TidMap tids_to_attach;
411 if (pid <= 1) {
412 error.SetErrorToGenericError();
413 error.SetErrorString("Attaching to process 1 is not allowed.");
414 return -1;
415 }
416
417 while (Host::FindProcessThreads(pid, tids_to_attach)) {
418 for (Host::TidMap::iterator it = tids_to_attach.begin();
419 it != tids_to_attach.end();) {
420 if (it->second == false) {
421 lldb::tid_t tid = it->first;
422
423 // Attach to the requested process.
424 // An attach will cause the thread to stop with a SIGSTOP.
425 error = PtraceWrapper(PTRACE_ATTACH, tid);
426 if (error.Fail()) {
427 // No such thread. The thread may have exited.
428 // More error handling may be needed.
429 if (error.GetError() == ESRCH) {
430 it = tids_to_attach.erase(it);
431 continue;
432 } else
433 return -1;
434 }
435
436 int status;
437 // Need to use __WALL otherwise we receive an error with errno=ECHLD
438 // At this point we should have a thread stopped if waitpid succeeds.
439 if ((status = waitpid(tid, NULL, __WALL)) < 0) {
440 // No such thread. The thread may have exited.
441 // More error handling may be needed.
442 if (errno == ESRCH) {
443 it = tids_to_attach.erase(it);
444 continue;
445 } else {
446 error.SetErrorToErrno();
447 return -1;
448 }
449 }
450
451 error = SetDefaultPtraceOpts(tid);
452 if (error.Fail())
453 return -1;
454
Pavel Labatha6321a82017-01-19 15:26:04 +0000455 LLDB_LOG(log, "adding tid = {0}", tid);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000456 it->second = true;
457
458 // Create the thread, mark it as stopped.
459 NativeThreadLinuxSP thread_sp(AddThread(static_cast<lldb::tid_t>(tid)));
460 assert(thread_sp && "AddThread() returned a nullptr");
461
462 // This will notify this is a new thread and tell the system it is
463 // stopped.
464 thread_sp->SetStoppedBySignal(SIGSTOP);
465 ThreadWasCreated(*thread_sp);
466 SetCurrentThreadID(thread_sp->GetID());
467 }
468
469 // move the loop forward
470 ++it;
471 }
472 }
473
474 if (tids_to_attach.size() > 0) {
475 m_pid = pid;
Todd Fialaaf245d12014-06-30 21:05:18 +0000476 // Let our process instance know the thread has stopped.
Kate Stoneb9c1b512016-09-06 20:57:50 +0000477 SetState(StateType::eStateStopped);
478 } else {
479 error.SetErrorToGenericError();
480 error.SetErrorString("No such process.");
481 return -1;
482 }
Todd Fialaaf245d12014-06-30 21:05:18 +0000483
Kate Stoneb9c1b512016-09-06 20:57:50 +0000484 return pid;
Todd Fialaaf245d12014-06-30 21:05:18 +0000485}
486
Kate Stoneb9c1b512016-09-06 20:57:50 +0000487Error NativeProcessLinux::SetDefaultPtraceOpts(lldb::pid_t pid) {
488 long ptrace_opts = 0;
Todd Fialaaf245d12014-06-30 21:05:18 +0000489
Kate Stoneb9c1b512016-09-06 20:57:50 +0000490 // Have the child raise an event on exit. This is used to keep the child in
491 // limbo until it is destroyed.
492 ptrace_opts |= PTRACE_O_TRACEEXIT;
Todd Fialaaf245d12014-06-30 21:05:18 +0000493
Kate Stoneb9c1b512016-09-06 20:57:50 +0000494 // Have the tracer trace threads which spawn in the inferior process.
495 // TODO: if we want to support tracing the inferiors' child, add the
496 // appropriate ptrace flags here (PTRACE_O_TRACEFORK, PTRACE_O_TRACEVFORK)
497 ptrace_opts |= PTRACE_O_TRACECLONE;
Todd Fialaaf245d12014-06-30 21:05:18 +0000498
Kate Stoneb9c1b512016-09-06 20:57:50 +0000499 // Have the tracer notify us before execve returns
500 // (needed to disable legacy SIGTRAP generation)
501 ptrace_opts |= PTRACE_O_TRACEEXEC;
Todd Fialaaf245d12014-06-30 21:05:18 +0000502
Kate Stoneb9c1b512016-09-06 20:57:50 +0000503 return PtraceWrapper(PTRACE_SETOPTIONS, pid, nullptr, (void *)ptrace_opts);
Todd Fialaaf245d12014-06-30 21:05:18 +0000504}
505
Kate Stoneb9c1b512016-09-06 20:57:50 +0000506static ExitType convert_pid_status_to_exit_type(int status) {
507 if (WIFEXITED(status))
508 return ExitType::eExitTypeExit;
509 else if (WIFSIGNALED(status))
510 return ExitType::eExitTypeSignal;
511 else if (WIFSTOPPED(status))
512 return ExitType::eExitTypeStop;
513 else {
514 // We don't know what this is.
515 return ExitType::eExitTypeInvalid;
516 }
Todd Fialaaf245d12014-06-30 21:05:18 +0000517}
518
Kate Stoneb9c1b512016-09-06 20:57:50 +0000519static int convert_pid_status_to_return_code(int status) {
520 if (WIFEXITED(status))
521 return WEXITSTATUS(status);
522 else if (WIFSIGNALED(status))
523 return WTERMSIG(status);
524 else if (WIFSTOPPED(status))
525 return WSTOPSIG(status);
526 else {
527 // We don't know what this is.
528 return ExitType::eExitTypeInvalid;
529 }
Todd Fialaaf245d12014-06-30 21:05:18 +0000530}
531
Pavel Labath1107b5a2015-04-17 14:07:49 +0000532// Handles all waitpid events from the inferior process.
Kate Stoneb9c1b512016-09-06 20:57:50 +0000533void NativeProcessLinux::MonitorCallback(lldb::pid_t pid, bool exited,
534 int signal, int status) {
535 Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS));
Todd Fialaaf245d12014-06-30 21:05:18 +0000536
Kate Stoneb9c1b512016-09-06 20:57:50 +0000537 // Certain activities differ based on whether the pid is the tid of the main
538 // thread.
539 const bool is_main_thread = (pid == GetID());
Todd Fialaaf245d12014-06-30 21:05:18 +0000540
Kate Stoneb9c1b512016-09-06 20:57:50 +0000541 // Handle when the thread exits.
542 if (exited) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000543 LLDB_LOG(log, "got exit signal({0}) , tid = {1} ({2} main thread)", signal,
544 pid, is_main_thread ? "is" : "is not");
Kate Stoneb9c1b512016-09-06 20:57:50 +0000545
546 // This is a thread that exited. Ensure we're not tracking it anymore.
547 const bool thread_found = StopTrackingThread(pid);
548
549 if (is_main_thread) {
550 // We only set the exit status and notify the delegate if we haven't
551 // already set the process
552 // state to an exited state. We normally should have received a SIGTRAP |
553 // (PTRACE_EVENT_EXIT << 8)
554 // for the main thread.
555 const bool already_notified = (GetState() == StateType::eStateExited) ||
556 (GetState() == StateType::eStateCrashed);
557 if (!already_notified) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000558 LLDB_LOG(
559 log,
560 "tid = {0} handling main thread exit ({1}), expected exit state "
561 "already set but state was {2} instead, setting exit state now",
562 pid,
563 thread_found ? "stopped tracking thread metadata"
564 : "thread metadata not found",
Pavel Labath8198db32017-01-24 11:48:25 +0000565 GetState());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000566 // The main thread exited. We're done monitoring. Report to delegate.
567 SetExitStatus(convert_pid_status_to_exit_type(status),
568 convert_pid_status_to_return_code(status), nullptr, true);
Todd Fialaaf245d12014-06-30 21:05:18 +0000569
Kate Stoneb9c1b512016-09-06 20:57:50 +0000570 // Notify delegate that our process has exited.
571 SetState(StateType::eStateExited, true);
Pavel Labatha6321a82017-01-19 15:26:04 +0000572 } else
573 LLDB_LOG(log, "tid = {0} main thread now exited (%s)", pid,
574 thread_found ? "stopped tracking thread metadata"
575 : "thread metadata not found");
Kate Stoneb9c1b512016-09-06 20:57:50 +0000576 } else {
577 // Do we want to report to the delegate in this case? I think not. If
Pavel Labatha6321a82017-01-19 15:26:04 +0000578 // this was an orderly thread exit, we would already have received the
579 // SIGTRAP | (PTRACE_EVENT_EXIT << 8) signal, and we would have done an
580 // all-stop then.
581 LLDB_LOG(log, "tid = {0} handling non-main thread exit (%s)", pid,
582 thread_found ? "stopped tracking thread metadata"
583 : "thread metadata not found");
Kate Stoneb9c1b512016-09-06 20:57:50 +0000584 }
585 return;
586 }
Pavel Labathb9cc0c72015-08-24 09:22:04 +0000587
Kate Stoneb9c1b512016-09-06 20:57:50 +0000588 siginfo_t info;
589 const auto info_err = GetSignalInfo(pid, &info);
590 auto thread_sp = GetThreadByID(pid);
Pavel Labathb9cc0c72015-08-24 09:22:04 +0000591
Kate Stoneb9c1b512016-09-06 20:57:50 +0000592 if (!thread_sp) {
593 // Normally, the only situation when we cannot find the thread is if we have
Pavel Labatha6321a82017-01-19 15:26:04 +0000594 // just received a new thread notification. This is indicated by
595 // GetSignalInfo() returning si_code == SI_USER and si_pid == 0
596 LLDB_LOG(log, "received notification about an unknown tid {0}.", pid);
Pavel Labathb9cc0c72015-08-24 09:22:04 +0000597
Kate Stoneb9c1b512016-09-06 20:57:50 +0000598 if (info_err.Fail()) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000599 LLDB_LOG(log,
600 "(tid {0}) GetSignalInfo failed ({1}). "
601 "Ingoring this notification.",
602 pid, info_err);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000603 return;
Pavel Labathb9cc0c72015-08-24 09:22:04 +0000604 }
605
Pavel Labatha6321a82017-01-19 15:26:04 +0000606 LLDB_LOG(log, "tid {0}, si_code: {1}, si_pid: {2}", pid, info.si_code,
607 info.si_pid);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000608
609 auto thread_sp = AddThread(pid);
610 // Resume the newly created thread.
611 ResumeThread(*thread_sp, eStateRunning, LLDB_INVALID_SIGNAL_NUMBER);
612 ThreadWasCreated(*thread_sp);
613 return;
614 }
615
616 // Get details on the signal raised.
617 if (info_err.Success()) {
618 // We have retrieved the signal info. Dispatch appropriately.
619 if (info.si_signo == SIGTRAP)
620 MonitorSIGTRAP(info, *thread_sp);
Chaoren Linfa03ad22015-02-03 01:50:42 +0000621 else
Kate Stoneb9c1b512016-09-06 20:57:50 +0000622 MonitorSignal(info, *thread_sp, exited);
623 } else {
624 if (info_err.GetError() == EINVAL) {
625 // This is a group stop reception for this tid.
626 // We can reach here if we reinject SIGSTOP, SIGSTP, SIGTTIN or SIGTTOU
Pavel Labatha6321a82017-01-19 15:26:04 +0000627 // into the tracee, triggering the group-stop mechanism. Normally
628 // receiving these would stop the process, pending a SIGCONT. Simulating
629 // this state in a debugger is hard and is generally not needed (one use
630 // case is debugging background task being managed by a shell). For
631 // general use, it is sufficient to stop the process in a signal-delivery
Kate Stoneb9c1b512016-09-06 20:57:50 +0000632 // stop which happens before the group stop. This done by MonitorSignal
Pavel Labatha6321a82017-01-19 15:26:04 +0000633 // and works correctly for all signals.
634 LLDB_LOG(log,
635 "received a group stop for pid {0} tid {1}. Transparent "
636 "handling of group stops not supported, resuming the "
637 "thread.",
638 GetID(), pid);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000639 ResumeThread(*thread_sp, thread_sp->GetState(),
640 LLDB_INVALID_SIGNAL_NUMBER);
641 } else {
642 // ptrace(GETSIGINFO) failed (but not due to group-stop).
Todd Fialaaf245d12014-06-30 21:05:18 +0000643
Kate Stoneb9c1b512016-09-06 20:57:50 +0000644 // A return value of ESRCH means the thread/process is no longer on the
Pavel Labatha6321a82017-01-19 15:26:04 +0000645 // system, so it was killed somehow outside of our control. Either way,
646 // we can't do anything with it anymore.
Todd Fialaaf245d12014-06-30 21:05:18 +0000647
Kate Stoneb9c1b512016-09-06 20:57:50 +0000648 // Stop tracking the metadata for the thread since it's entirely off the
649 // system now.
650 const bool thread_found = StopTrackingThread(pid);
Todd Fialaaf245d12014-06-30 21:05:18 +0000651
Pavel Labatha6321a82017-01-19 15:26:04 +0000652 LLDB_LOG(log,
653 "GetSignalInfo failed: {0}, tid = {1}, signal = {2}, "
654 "status = {3}, main_thread = {4}, thread_found: {5}",
655 info_err, pid, signal, status, is_main_thread, thread_found);
Todd Fialaaf245d12014-06-30 21:05:18 +0000656
Kate Stoneb9c1b512016-09-06 20:57:50 +0000657 if (is_main_thread) {
658 // Notify the delegate - our process is not available but appears to
659 // have been killed outside
660 // our control. Is eStateExited the right exit state in this case?
661 SetExitStatus(convert_pid_status_to_exit_type(status),
662 convert_pid_status_to_return_code(status), nullptr, true);
663 SetState(StateType::eStateExited, true);
664 } else {
665 // This thread was pulled out from underneath us. Anything to do here?
666 // Do we want to do an all stop?
Pavel Labatha6321a82017-01-19 15:26:04 +0000667 LLDB_LOG(log,
668 "pid {0} tid {1} non-main thread exit occurred, didn't "
669 "tell delegate anything since thread disappeared out "
670 "from underneath us",
671 GetID(), pid);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000672 }
Todd Fialaaf245d12014-06-30 21:05:18 +0000673 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000674 }
Todd Fialaaf245d12014-06-30 21:05:18 +0000675}
676
Kate Stoneb9c1b512016-09-06 20:57:50 +0000677void NativeProcessLinux::WaitForNewThread(::pid_t tid) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000678 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
Pavel Labath426bdf82015-04-28 07:51:52 +0000679
Kate Stoneb9c1b512016-09-06 20:57:50 +0000680 NativeThreadLinuxSP new_thread_sp = GetThreadByID(tid);
Pavel Labath426bdf82015-04-28 07:51:52 +0000681
Kate Stoneb9c1b512016-09-06 20:57:50 +0000682 if (new_thread_sp) {
683 // We are already tracking the thread - we got the event on the new thread
684 // (see
685 // MonitorSignal) before this one. We are done.
686 return;
687 }
Pavel Labath426bdf82015-04-28 07:51:52 +0000688
Kate Stoneb9c1b512016-09-06 20:57:50 +0000689 // The thread is not tracked yet, let's wait for it to appear.
690 int status = -1;
691 ::pid_t wait_pid;
692 do {
Pavel Labatha6321a82017-01-19 15:26:04 +0000693 LLDB_LOG(log,
694 "received thread creation event for tid {0}. tid not tracked "
695 "yet, waiting for thread to appear...",
696 tid);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000697 wait_pid = waitpid(tid, &status, __WALL);
698 } while (wait_pid == -1 && errno == EINTR);
699 // Since we are waiting on a specific tid, this must be the creation event.
Pavel Labatha6321a82017-01-19 15:26:04 +0000700 // But let's do some checks just in case.
Kate Stoneb9c1b512016-09-06 20:57:50 +0000701 if (wait_pid != tid) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000702 LLDB_LOG(log,
703 "waiting for tid {0} failed. Assuming the thread has "
704 "disappeared in the meantime",
705 tid);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000706 // The only way I know of this could happen is if the whole process was
707 // SIGKILLed in the mean time. In any case, we can't do anything about that
708 // now.
709 return;
710 }
711 if (WIFEXITED(status)) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000712 LLDB_LOG(log,
713 "waiting for tid {0} returned an 'exited' event. Not "
714 "tracking the thread.",
715 tid);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000716 // Also a very improbable event.
717 return;
718 }
Pavel Labath426bdf82015-04-28 07:51:52 +0000719
Pavel Labatha6321a82017-01-19 15:26:04 +0000720 LLDB_LOG(log, "pid = {0}: tracking new thread tid {1}", GetID(), tid);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000721 new_thread_sp = AddThread(tid);
722 ResumeThread(*new_thread_sp, eStateRunning, LLDB_INVALID_SIGNAL_NUMBER);
723 ThreadWasCreated(*new_thread_sp);
Pavel Labath426bdf82015-04-28 07:51:52 +0000724}
725
Kate Stoneb9c1b512016-09-06 20:57:50 +0000726void NativeProcessLinux::MonitorSIGTRAP(const siginfo_t &info,
727 NativeThreadLinux &thread) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000728 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
Kate Stoneb9c1b512016-09-06 20:57:50 +0000729 const bool is_main_thread = (thread.GetID() == GetID());
Todd Fialaaf245d12014-06-30 21:05:18 +0000730
Kate Stoneb9c1b512016-09-06 20:57:50 +0000731 assert(info.si_signo == SIGTRAP && "Unexpected child signal!");
Todd Fialaaf245d12014-06-30 21:05:18 +0000732
Kate Stoneb9c1b512016-09-06 20:57:50 +0000733 switch (info.si_code) {
734 // TODO: these two cases are required if we want to support tracing of the
735 // inferiors' children. We'd need this to debug a monitor.
736 // case (SIGTRAP | (PTRACE_EVENT_FORK << 8)):
737 // case (SIGTRAP | (PTRACE_EVENT_VFORK << 8)):
Todd Fialaaf245d12014-06-30 21:05:18 +0000738
Kate Stoneb9c1b512016-09-06 20:57:50 +0000739 case (SIGTRAP | (PTRACE_EVENT_CLONE << 8)): {
740 // This is the notification on the parent thread which informs us of new
741 // thread
742 // creation.
743 // We don't want to do anything with the parent thread so we just resume it.
744 // In case we
745 // want to implement "break on thread creation" functionality, we would need
746 // to stop
747 // here.
Todd Fialaaf245d12014-06-30 21:05:18 +0000748
Kate Stoneb9c1b512016-09-06 20:57:50 +0000749 unsigned long event_message = 0;
750 if (GetEventMessage(thread.GetID(), &event_message).Fail()) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000751 LLDB_LOG(log,
752 "pid {0} received thread creation event but "
753 "GetEventMessage failed so we don't know the new tid",
754 thread.GetID());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000755 } else
756 WaitForNewThread(event_message);
Todd Fialaaf245d12014-06-30 21:05:18 +0000757
Kate Stoneb9c1b512016-09-06 20:57:50 +0000758 ResumeThread(thread, thread.GetState(), LLDB_INVALID_SIGNAL_NUMBER);
759 break;
760 }
Todd Fialaaf245d12014-06-30 21:05:18 +0000761
Kate Stoneb9c1b512016-09-06 20:57:50 +0000762 case (SIGTRAP | (PTRACE_EVENT_EXEC << 8)): {
763 NativeThreadLinuxSP main_thread_sp;
Pavel Labatha6321a82017-01-19 15:26:04 +0000764 LLDB_LOG(log, "received exec event, code = {0}", info.si_code ^ SIGTRAP);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000765
766 // Exec clears any pending notifications.
767 m_pending_notification_tid = LLDB_INVALID_THREAD_ID;
768
769 // Remove all but the main thread here. Linux fork creates a new process
770 // which only copies the main thread.
Pavel Labatha6321a82017-01-19 15:26:04 +0000771 LLDB_LOG(log, "exec received, stop tracking all but main thread");
Kate Stoneb9c1b512016-09-06 20:57:50 +0000772
773 for (auto thread_sp : m_threads) {
774 const bool is_main_thread = thread_sp && thread_sp->GetID() == GetID();
775 if (is_main_thread) {
776 main_thread_sp = std::static_pointer_cast<NativeThreadLinux>(thread_sp);
Pavel Labatha6321a82017-01-19 15:26:04 +0000777 LLDB_LOG(log, "found main thread with tid {0}, keeping",
778 main_thread_sp->GetID());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000779 } else {
Pavel Labatha6321a82017-01-19 15:26:04 +0000780 LLDB_LOG(log, "discarding non-main-thread tid {0} due to exec",
781 thread_sp->GetID());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000782 }
Todd Fialaa9882ce2014-08-28 15:46:54 +0000783 }
Todd Fialaaf245d12014-06-30 21:05:18 +0000784
Kate Stoneb9c1b512016-09-06 20:57:50 +0000785 m_threads.clear();
Chaoren Linfa03ad22015-02-03 01:50:42 +0000786
Kate Stoneb9c1b512016-09-06 20:57:50 +0000787 if (main_thread_sp) {
788 m_threads.push_back(main_thread_sp);
789 SetCurrentThreadID(main_thread_sp->GetID());
790 main_thread_sp->SetStoppedByExec();
791 } else {
792 SetCurrentThreadID(LLDB_INVALID_THREAD_ID);
Pavel Labatha6321a82017-01-19 15:26:04 +0000793 LLDB_LOG(log,
794 "pid {0} no main thread found, discarded all threads, "
795 "we're in a no-thread state!",
796 GetID());
Todd Fialaaf245d12014-06-30 21:05:18 +0000797 }
798
Kate Stoneb9c1b512016-09-06 20:57:50 +0000799 // Tell coordinator about about the "new" (since exec) stopped main thread.
800 ThreadWasCreated(*main_thread_sp);
Pavel Labathb9cc0c72015-08-24 09:22:04 +0000801
Kate Stoneb9c1b512016-09-06 20:57:50 +0000802 // Let our delegate know we have just exec'd.
803 NotifyDidExec();
804
805 // If we have a main thread, indicate we are stopped.
806 assert(main_thread_sp && "exec called during ptraced process but no main "
807 "thread metadata tracked");
808
809 // Let the process know we're stopped.
810 StopRunningThreads(main_thread_sp->GetID());
811
812 break;
813 }
814
815 case (SIGTRAP | (PTRACE_EVENT_EXIT << 8)): {
816 // The inferior process or one of its threads is about to exit.
817 // We don't want to do anything with the thread so we just resume it. In
818 // case we
819 // want to implement "break on thread exit" functionality, we would need to
820 // stop
821 // here.
822
823 unsigned long data = 0;
824 if (GetEventMessage(thread.GetID(), &data).Fail())
825 data = -1;
826
Pavel Labatha6321a82017-01-19 15:26:04 +0000827 LLDB_LOG(log,
828 "received PTRACE_EVENT_EXIT, data = {0:x}, WIFEXITED={1}, "
829 "WIFSIGNALED={2}, pid = {3}, main_thread = {4}",
830 data, WIFEXITED(data), WIFSIGNALED(data), thread.GetID(),
831 is_main_thread);
Todd Fialaaf245d12014-06-30 21:05:18 +0000832
Kate Stoneb9c1b512016-09-06 20:57:50 +0000833 if (is_main_thread) {
834 SetExitStatus(convert_pid_status_to_exit_type(data),
835 convert_pid_status_to_return_code(data), nullptr, true);
836 }
837
838 StateType state = thread.GetState();
839 if (!StateIsRunningState(state)) {
840 // Due to a kernel bug, we may sometimes get this stop after the inferior
841 // gets a
842 // SIGKILL. This confuses our state tracking logic in ResumeThread(),
843 // since normally,
844 // we should not be receiving any ptrace events while the inferior is
845 // stopped. This
846 // makes sure that the inferior is resumed and exits normally.
847 state = eStateRunning;
848 }
849 ResumeThread(thread, state, LLDB_INVALID_SIGNAL_NUMBER);
850
851 break;
852 }
853
854 case 0:
855 case TRAP_TRACE: // We receive this on single stepping.
856 case TRAP_HWBKPT: // We receive this on watchpoint hit
857 {
858 // If a watchpoint was hit, report it
859 uint32_t wp_index;
860 Error error = thread.GetRegisterContext()->GetWatchpointHitIndex(
861 wp_index, (uintptr_t)info.si_addr);
Pavel Labatha6321a82017-01-19 15:26:04 +0000862 if (error.Fail())
863 LLDB_LOG(log,
864 "received error while checking for watchpoint hits, pid = "
865 "{0}, error = {1}",
866 thread.GetID(), error);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000867 if (wp_index != LLDB_INVALID_INDEX32) {
868 MonitorWatchpoint(thread, wp_index);
869 break;
870 }
871
Omair Javaidd5ffbad2017-02-24 13:27:31 +0000872 // If a breakpoint was hit, report it
873 uint32_t bp_index;
874 error = thread.GetRegisterContext()->GetHardwareBreakHitIndex(
875 bp_index, (uintptr_t)info.si_addr);
876 if (error.Fail())
877 LLDB_LOG(log, "received error while checking for hardware "
878 "breakpoint hits, pid = {0}, error = {1}",
879 thread.GetID(), error);
880 if (bp_index != LLDB_INVALID_INDEX32) {
881 MonitorBreakpoint(thread);
882 break;
883 }
884
Kate Stoneb9c1b512016-09-06 20:57:50 +0000885 // Otherwise, report step over
886 MonitorTrace(thread);
887 break;
888 }
889
890 case SI_KERNEL:
Mohit K. Bhakkad35799962015-06-18 04:53:18 +0000891#if defined __mips__
Kate Stoneb9c1b512016-09-06 20:57:50 +0000892 // For mips there is no special signal for watchpoint
893 // So we check for watchpoint in kernel trap
Pavel Labathb9cc0c72015-08-24 09:22:04 +0000894 {
Kate Stoneb9c1b512016-09-06 20:57:50 +0000895 // If a watchpoint was hit, report it
896 uint32_t wp_index;
897 Error error = thread.GetRegisterContext()->GetWatchpointHitIndex(
898 wp_index, LLDB_INVALID_ADDRESS);
Pavel Labatha6321a82017-01-19 15:26:04 +0000899 if (error.Fail())
900 LLDB_LOG(log,
901 "received error while checking for watchpoint hits, pid = "
902 "{0}, error = {1}",
903 thread.GetID(), error);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000904 if (wp_index != LLDB_INVALID_INDEX32) {
905 MonitorWatchpoint(thread, wp_index);
906 break;
907 }
Pavel Labathb9cc0c72015-08-24 09:22:04 +0000908 }
Kate Stoneb9c1b512016-09-06 20:57:50 +0000909// NO BREAK
Mohit K. Bhakkad35799962015-06-18 04:53:18 +0000910#endif
Kate Stoneb9c1b512016-09-06 20:57:50 +0000911 case TRAP_BRKPT:
912 MonitorBreakpoint(thread);
913 break;
Todd Fialaaf245d12014-06-30 21:05:18 +0000914
Kate Stoneb9c1b512016-09-06 20:57:50 +0000915 case SIGTRAP:
916 case (SIGTRAP | 0x80):
Pavel Labatha6321a82017-01-19 15:26:04 +0000917 LLDB_LOG(
918 log,
919 "received unknown SIGTRAP stop event ({0}, pid {1} tid {2}, resuming",
920 info.si_code, GetID(), thread.GetID());
Chaoren Linfa03ad22015-02-03 01:50:42 +0000921
Kate Stoneb9c1b512016-09-06 20:57:50 +0000922 // Ignore these signals until we know more about them.
923 ResumeThread(thread, thread.GetState(), LLDB_INVALID_SIGNAL_NUMBER);
924 break;
Todd Fialaaf245d12014-06-30 21:05:18 +0000925
Kate Stoneb9c1b512016-09-06 20:57:50 +0000926 default:
Pavel Labatha6321a82017-01-19 15:26:04 +0000927 LLDB_LOG(
928 log,
929 "received unknown SIGTRAP stop event ({0}, pid {1} tid {2}, resuming",
930 info.si_code, GetID(), thread.GetID());
931 llvm_unreachable("Unexpected SIGTRAP code!");
Kate Stoneb9c1b512016-09-06 20:57:50 +0000932 break;
933 }
Todd Fialaaf245d12014-06-30 21:05:18 +0000934}
935
Kate Stoneb9c1b512016-09-06 20:57:50 +0000936void NativeProcessLinux::MonitorTrace(NativeThreadLinux &thread) {
Pavel Labatha6321a82017-01-19 15:26:04 +0000937 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
938 LLDB_LOG(log, "received trace event, pid = {0}", thread.GetID());
Chaoren Linc16f5dc2015-03-19 23:28:10 +0000939
Kate Stoneb9c1b512016-09-06 20:57:50 +0000940 // This thread is currently stopped.
941 thread.SetStoppedByTrace();
942
943 StopRunningThreads(thread.GetID());
944}
945
946void NativeProcessLinux::MonitorBreakpoint(NativeThreadLinux &thread) {
947 Log *log(
948 GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_BREAKPOINTS));
Pavel Labatha6321a82017-01-19 15:26:04 +0000949 LLDB_LOG(log, "received breakpoint event, pid = {0}", thread.GetID());
Kate Stoneb9c1b512016-09-06 20:57:50 +0000950
951 // Mark the thread as stopped at breakpoint.
952 thread.SetStoppedByBreakpoint();
953 Error error = FixupBreakpointPCAsNeeded(thread);
954 if (error.Fail())
Pavel Labatha6321a82017-01-19 15:26:04 +0000955 LLDB_LOG(log, "pid = {0} fixup: {1}", thread.GetID(), error);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000956
957 if (m_threads_stepping_with_breakpoint.find(thread.GetID()) !=
958 m_threads_stepping_with_breakpoint.end())
Pavel Labathb9cc0c72015-08-24 09:22:04 +0000959 thread.SetStoppedByTrace();
Chaoren Linc16f5dc2015-03-19 23:28:10 +0000960
Kate Stoneb9c1b512016-09-06 20:57:50 +0000961 StopRunningThreads(thread.GetID());
Chaoren Linc16f5dc2015-03-19 23:28:10 +0000962}
963
Kate Stoneb9c1b512016-09-06 20:57:50 +0000964void NativeProcessLinux::MonitorWatchpoint(NativeThreadLinux &thread,
965 uint32_t wp_index) {
966 Log *log(
967 GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_WATCHPOINTS));
Pavel Labatha6321a82017-01-19 15:26:04 +0000968 LLDB_LOG(log, "received watchpoint event, pid = {0}, wp_index = {1}",
969 thread.GetID(), wp_index);
Kate Stoneb9c1b512016-09-06 20:57:50 +0000970
971 // Mark the thread as stopped at watchpoint.
972 // The address is at (lldb::addr_t)info->si_addr if we need it.
973 thread.SetStoppedByWatchpoint(wp_index);
974
975 // We need to tell all other running threads before we notify the delegate
976 // about this stop.
977 StopRunningThreads(thread.GetID());
978}
979
980void NativeProcessLinux::MonitorSignal(const siginfo_t &info,
981 NativeThreadLinux &thread, bool exited) {
982 const int signo = info.si_signo;
983 const bool is_from_llgs = info.si_pid == getpid();
984
Pavel Labatha6321a82017-01-19 15:26:04 +0000985 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
Kate Stoneb9c1b512016-09-06 20:57:50 +0000986
987 // POSIX says that process behaviour is undefined after it ignores a SIGFPE,
988 // SIGILL, SIGSEGV, or SIGBUS *unless* that signal was generated by a
989 // kill(2) or raise(3). Similarly for tgkill(2) on Linux.
990 //
991 // IOW, user generated signals never generate what we consider to be a
992 // "crash".
993 //
994 // Similarly, ACK signals generated by this monitor.
995
996 // Handle the signal.
Pavel Labatha6321a82017-01-19 15:26:04 +0000997 LLDB_LOG(log,
998 "received signal {0} ({1}) with code {2}, (siginfo pid = {3}, "
999 "waitpid pid = {4})",
1000 Host::GetSignalAsCString(signo), signo, info.si_code,
1001 thread.GetID());
Chaoren Linc16f5dc2015-03-19 23:28:10 +00001002
Kate Stoneb9c1b512016-09-06 20:57:50 +00001003 // Check for thread stop notification.
1004 if (is_from_llgs && (info.si_code == SI_TKILL) && (signo == SIGSTOP)) {
1005 // This is a tgkill()-based stop.
Pavel Labatha6321a82017-01-19 15:26:04 +00001006 LLDB_LOG(log, "pid {0} tid {1}, thread stopped", GetID(), thread.GetID());
Chaoren Linc16f5dc2015-03-19 23:28:10 +00001007
Kate Stoneb9c1b512016-09-06 20:57:50 +00001008 // Check that we're not already marked with a stop reason.
1009 // Note this thread really shouldn't already be marked as stopped - if we
Pavel Labatha6321a82017-01-19 15:26:04 +00001010 // were, that would imply that the kernel signaled us with the thread
1011 // stopping which we handled and marked as stopped, and that, without an
1012 // intervening resume, we received another stop. It is more likely that we
1013 // are missing the marking of a run state somewhere if we find that the
1014 // thread was marked as stopped.
Kate Stoneb9c1b512016-09-06 20:57:50 +00001015 const StateType thread_state = thread.GetState();
1016 if (!StateIsStoppedState(thread_state, false)) {
1017 // An inferior thread has stopped because of a SIGSTOP we have sent it.
1018 // Generally, these are not important stops and we don't want to report
Pavel Labatha6321a82017-01-19 15:26:04 +00001019 // them as they are just used to stop other threads when one thread (the
1020 // one with the *real* stop reason) hits a breakpoint (watchpoint,
1021 // etc...). However, in the case of an asynchronous Interrupt(), this *is*
1022 // the real stop reason, so we leave the signal intact if this is the
1023 // thread that was chosen as the triggering thread.
Kate Stoneb9c1b512016-09-06 20:57:50 +00001024 if (m_pending_notification_tid != LLDB_INVALID_THREAD_ID) {
1025 if (m_pending_notification_tid == thread.GetID())
1026 thread.SetStoppedBySignal(SIGSTOP, &info);
Pavel Labathb9cc0c72015-08-24 09:22:04 +00001027 else
Kate Stoneb9c1b512016-09-06 20:57:50 +00001028 thread.SetStoppedWithNoReason();
Pavel Labathb9cc0c72015-08-24 09:22:04 +00001029
Kate Stoneb9c1b512016-09-06 20:57:50 +00001030 SetCurrentThreadID(thread.GetID());
1031 SignalIfAllThreadsStopped();
1032 } else {
1033 // We can end up here if stop was initiated by LLGS but by this time a
1034 // thread stop has occurred - maybe initiated by another event.
1035 Error error = ResumeThread(thread, thread.GetState(), 0);
Pavel Labatha6321a82017-01-19 15:26:04 +00001036 if (error.Fail())
1037 LLDB_LOG(log, "failed to resume thread {0}: {1}", thread.GetID(),
1038 error);
Kate Stoneb9c1b512016-09-06 20:57:50 +00001039 }
1040 } else {
Pavel Labatha6321a82017-01-19 15:26:04 +00001041 LLDB_LOG(log,
1042 "pid {0} tid {1}, thread was already marked as a stopped "
1043 "state (state={2}), leaving stop signal as is",
Pavel Labath8198db32017-01-24 11:48:25 +00001044 GetID(), thread.GetID(), thread_state);
Kate Stoneb9c1b512016-09-06 20:57:50 +00001045 SignalIfAllThreadsStopped();
Todd Fialaaf245d12014-06-30 21:05:18 +00001046 }
1047
Kate Stoneb9c1b512016-09-06 20:57:50 +00001048 // Done handling.
1049 return;
1050 }
Todd Fialaaf245d12014-06-30 21:05:18 +00001051
Pavel Labath4a705e72017-02-24 09:29:14 +00001052 // Check if debugger should stop at this signal or just ignore it
1053 // and resume the inferior.
1054 if (m_signals_to_ignore.find(signo) != m_signals_to_ignore.end()) {
1055 ResumeThread(thread, thread.GetState(), signo);
1056 return;
1057 }
1058
Kate Stoneb9c1b512016-09-06 20:57:50 +00001059 // This thread is stopped.
Pavel Labatha6321a82017-01-19 15:26:04 +00001060 LLDB_LOG(log, "received signal {0}", Host::GetSignalAsCString(signo));
Kate Stoneb9c1b512016-09-06 20:57:50 +00001061 thread.SetStoppedBySignal(signo, &info);
1062
1063 // Send a stop to the debugger after we get all other threads to stop.
1064 StopRunningThreads(thread.GetID());
Todd Fialaaf245d12014-06-30 21:05:18 +00001065}
1066
Tamas Berghammere7708682015-04-22 10:00:23 +00001067namespace {
1068
Kate Stoneb9c1b512016-09-06 20:57:50 +00001069struct EmulatorBaton {
1070 NativeProcessLinux *m_process;
1071 NativeRegisterContext *m_reg_context;
Tamas Berghammere7708682015-04-22 10:00:23 +00001072
Kate Stoneb9c1b512016-09-06 20:57:50 +00001073 // eRegisterKindDWARF -> RegsiterValue
1074 std::unordered_map<uint32_t, RegisterValue> m_register_values;
Pavel Labath6648fcc2015-04-27 09:21:14 +00001075
Kate Stoneb9c1b512016-09-06 20:57:50 +00001076 EmulatorBaton(NativeProcessLinux *process, NativeRegisterContext *reg_context)
1077 : m_process(process), m_reg_context(reg_context) {}
Tamas Berghammere7708682015-04-22 10:00:23 +00001078};
1079
1080} // anonymous namespace
1081
Kate Stoneb9c1b512016-09-06 20:57:50 +00001082static size_t ReadMemoryCallback(EmulateInstruction *instruction, void *baton,
1083 const EmulateInstruction::Context &context,
1084 lldb::addr_t addr, void *dst, size_t length) {
1085 EmulatorBaton *emulator_baton = static_cast<EmulatorBaton *>(baton);
Tamas Berghammere7708682015-04-22 10:00:23 +00001086
Kate Stoneb9c1b512016-09-06 20:57:50 +00001087 size_t bytes_read;
1088 emulator_baton->m_process->ReadMemory(addr, dst, length, bytes_read);
1089 return bytes_read;
Tamas Berghammere7708682015-04-22 10:00:23 +00001090}
1091
Kate Stoneb9c1b512016-09-06 20:57:50 +00001092static bool ReadRegisterCallback(EmulateInstruction *instruction, void *baton,
1093 const RegisterInfo *reg_info,
1094 RegisterValue &reg_value) {
1095 EmulatorBaton *emulator_baton = static_cast<EmulatorBaton *>(baton);
Tamas Berghammere7708682015-04-22 10:00:23 +00001096
Kate Stoneb9c1b512016-09-06 20:57:50 +00001097 auto it = emulator_baton->m_register_values.find(
1098 reg_info->kinds[eRegisterKindDWARF]);
1099 if (it != emulator_baton->m_register_values.end()) {
1100 reg_value = it->second;
1101 return true;
1102 }
1103
1104 // The emulator only fill in the dwarf regsiter numbers (and in some case
1105 // the generic register numbers). Get the full register info from the
1106 // register context based on the dwarf register numbers.
1107 const RegisterInfo *full_reg_info =
1108 emulator_baton->m_reg_context->GetRegisterInfo(
1109 eRegisterKindDWARF, reg_info->kinds[eRegisterKindDWARF]);
1110
1111 Error error =
1112 emulator_baton->m_reg_context->ReadRegister(full_reg_info, reg_value);
1113 if (error.Success())
1114 return true;
1115
1116 return false;
1117}
1118
1119static bool WriteRegisterCallback(EmulateInstruction *instruction, void *baton,
1120 const EmulateInstruction::Context &context,
1121 const RegisterInfo *reg_info,
1122 const RegisterValue &reg_value) {
1123 EmulatorBaton *emulator_baton = static_cast<EmulatorBaton *>(baton);
1124 emulator_baton->m_register_values[reg_info->kinds[eRegisterKindDWARF]] =
1125 reg_value;
1126 return true;
1127}
1128
1129static size_t WriteMemoryCallback(EmulateInstruction *instruction, void *baton,
1130 const EmulateInstruction::Context &context,
1131 lldb::addr_t addr, const void *dst,
1132 size_t length) {
1133 return length;
1134}
1135
1136static lldb::addr_t ReadFlags(NativeRegisterContext *regsiter_context) {
1137 const RegisterInfo *flags_info = regsiter_context->GetRegisterInfo(
1138 eRegisterKindGeneric, LLDB_REGNUM_GENERIC_FLAGS);
1139 return regsiter_context->ReadRegisterAsUnsigned(flags_info,
1140 LLDB_INVALID_ADDRESS);
1141}
1142
1143Error NativeProcessLinux::SetupSoftwareSingleStepping(
1144 NativeThreadLinux &thread) {
1145 Error error;
1146 NativeRegisterContextSP register_context_sp = thread.GetRegisterContext();
1147
1148 std::unique_ptr<EmulateInstruction> emulator_ap(
1149 EmulateInstruction::FindPlugin(m_arch, eInstructionTypePCModifying,
1150 nullptr));
1151
1152 if (emulator_ap == nullptr)
1153 return Error("Instruction emulator not found!");
1154
1155 EmulatorBaton baton(this, register_context_sp.get());
1156 emulator_ap->SetBaton(&baton);
1157 emulator_ap->SetReadMemCallback(&ReadMemoryCallback);
1158 emulator_ap->SetReadRegCallback(&ReadRegisterCallback);
1159 emulator_ap->SetWriteMemCallback(&WriteMemoryCallback);
1160 emulator_ap->SetWriteRegCallback(&WriteRegisterCallback);
1161
1162 if (!emulator_ap->ReadInstruction())
1163 return Error("Read instruction failed!");
1164
1165 bool emulation_result =
1166 emulator_ap->EvaluateInstruction(eEmulateInstructionOptionAutoAdvancePC);
1167
1168 const RegisterInfo *reg_info_pc = register_context_sp->GetRegisterInfo(
1169 eRegisterKindGeneric, LLDB_REGNUM_GENERIC_PC);
1170 const RegisterInfo *reg_info_flags = register_context_sp->GetRegisterInfo(
1171 eRegisterKindGeneric, LLDB_REGNUM_GENERIC_FLAGS);
1172
1173 auto pc_it =
1174 baton.m_register_values.find(reg_info_pc->kinds[eRegisterKindDWARF]);
1175 auto flags_it =
1176 baton.m_register_values.find(reg_info_flags->kinds[eRegisterKindDWARF]);
1177
1178 lldb::addr_t next_pc;
1179 lldb::addr_t next_flags;
1180 if (emulation_result) {
1181 assert(pc_it != baton.m_register_values.end() &&
1182 "Emulation was successfull but PC wasn't updated");
1183 next_pc = pc_it->second.GetAsUInt64();
1184
1185 if (flags_it != baton.m_register_values.end())
1186 next_flags = flags_it->second.GetAsUInt64();
1187 else
1188 next_flags = ReadFlags(register_context_sp.get());
1189 } else if (pc_it == baton.m_register_values.end()) {
1190 // Emulate instruction failed and it haven't changed PC. Advance PC
1191 // with the size of the current opcode because the emulation of all
1192 // PC modifying instruction should be successful. The failure most
1193 // likely caused by a not supported instruction which don't modify PC.
1194 next_pc =
1195 register_context_sp->GetPC() + emulator_ap->GetOpcode().GetByteSize();
1196 next_flags = ReadFlags(register_context_sp.get());
1197 } else {
1198 // The instruction emulation failed after it modified the PC. It is an
1199 // unknown error where we can't continue because the next instruction is
1200 // modifying the PC but we don't know how.
1201 return Error("Instruction emulation failed unexpectedly.");
1202 }
1203
1204 if (m_arch.GetMachine() == llvm::Triple::arm) {
1205 if (next_flags & 0x20) {
1206 // Thumb mode
1207 error = SetSoftwareBreakpoint(next_pc, 2);
1208 } else {
1209 // Arm mode
1210 error = SetSoftwareBreakpoint(next_pc, 4);
Pavel Labath6648fcc2015-04-27 09:21:14 +00001211 }
Kate Stoneb9c1b512016-09-06 20:57:50 +00001212 } else if (m_arch.GetMachine() == llvm::Triple::mips64 ||
1213 m_arch.GetMachine() == llvm::Triple::mips64el ||
1214 m_arch.GetMachine() == llvm::Triple::mips ||
1215 m_arch.GetMachine() == llvm::Triple::mipsel)
1216 error = SetSoftwareBreakpoint(next_pc, 4);
1217 else {
1218 // No size hint is given for the next breakpoint
1219 error = SetSoftwareBreakpoint(next_pc, 0);
1220 }
Pavel Labath6648fcc2015-04-27 09:21:14 +00001221
Pavel Labath42eb6902016-10-26 11:13:56 +00001222 // If setting the breakpoint fails because next_pc is out of
1223 // the address space, ignore it and let the debugee segfault.
1224 if (error.GetError() == EIO || error.GetError() == EFAULT) {
Mehdi Amini665be502016-11-11 05:07:57 +00001225 return Error();
Pavel Labath42eb6902016-10-26 11:13:56 +00001226 } else if (error.Fail())
Kate Stoneb9c1b512016-09-06 20:57:50 +00001227 return error;
Tamas Berghammere7708682015-04-22 10:00:23 +00001228
Kate Stoneb9c1b512016-09-06 20:57:50 +00001229 m_threads_stepping_with_breakpoint.insert({thread.GetID(), next_pc});
Mohit K. Bhakkadcdc22a82015-05-07 05:56:27 +00001230
Mehdi Amini665be502016-11-11 05:07:57 +00001231 return Error();
Kate Stoneb9c1b512016-09-06 20:57:50 +00001232}
1233
1234bool NativeProcessLinux::SupportHardwareSingleStepping() const {
1235 if (m_arch.GetMachine() == llvm::Triple::arm ||
1236 m_arch.GetMachine() == llvm::Triple::mips64 ||
1237 m_arch.GetMachine() == llvm::Triple::mips64el ||
1238 m_arch.GetMachine() == llvm::Triple::mips ||
1239 m_arch.GetMachine() == llvm::Triple::mipsel)
Pavel Labath6648fcc2015-04-27 09:21:14 +00001240 return false;
Kate Stoneb9c1b512016-09-06 20:57:50 +00001241 return true;
Tamas Berghammere7708682015-04-22 10:00:23 +00001242}
1243
Kate Stoneb9c1b512016-09-06 20:57:50 +00001244Error NativeProcessLinux::Resume(const ResumeActionList &resume_actions) {
Pavel Labatha6321a82017-01-19 15:26:04 +00001245 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1246 LLDB_LOG(log, "pid {0}", GetID());
Tamas Berghammere7708682015-04-22 10:00:23 +00001247
Kate Stoneb9c1b512016-09-06 20:57:50 +00001248 bool software_single_step = !SupportHardwareSingleStepping();
Tamas Berghammere7708682015-04-22 10:00:23 +00001249
Kate Stoneb9c1b512016-09-06 20:57:50 +00001250 if (software_single_step) {
1251 for (auto thread_sp : m_threads) {
1252 assert(thread_sp && "thread list should not contain NULL threads");
Tamas Berghammere7708682015-04-22 10:00:23 +00001253
Kate Stoneb9c1b512016-09-06 20:57:50 +00001254 const ResumeAction *const action =
1255 resume_actions.GetActionForThread(thread_sp->GetID(), true);
1256 if (action == nullptr)
1257 continue;
Tamas Berghammere7708682015-04-22 10:00:23 +00001258
Kate Stoneb9c1b512016-09-06 20:57:50 +00001259 if (action->state == eStateStepping) {
1260 Error error = SetupSoftwareSingleStepping(
1261 static_cast<NativeThreadLinux &>(*thread_sp));
1262 if (error.Fail())
1263 return error;
1264 }
Tamas Berghammere7708682015-04-22 10:00:23 +00001265 }
Kate Stoneb9c1b512016-09-06 20:57:50 +00001266 }
1267
1268 for (auto thread_sp : m_threads) {
1269 assert(thread_sp && "thread list should not contain NULL threads");
1270
1271 const ResumeAction *const action =
1272 resume_actions.GetActionForThread(thread_sp->GetID(), true);
1273
1274 if (action == nullptr) {
Pavel Labatha6321a82017-01-19 15:26:04 +00001275 LLDB_LOG(log, "no action specified for pid {0} tid {1}", GetID(),
1276 thread_sp->GetID());
Kate Stoneb9c1b512016-09-06 20:57:50 +00001277 continue;
Tamas Berghammere7708682015-04-22 10:00:23 +00001278 }
1279
Pavel Labatha6321a82017-01-19 15:26:04 +00001280 LLDB_LOG(log, "processing resume action state {0} for pid {1} tid {2}",
Pavel Labath8198db32017-01-24 11:48:25 +00001281 action->state, GetID(), thread_sp->GetID());
Tamas Berghammere7708682015-04-22 10:00:23 +00001282
Kate Stoneb9c1b512016-09-06 20:57:50 +00001283 switch (action->state) {
1284 case eStateRunning:
1285 case eStateStepping: {
1286 // Run the thread, possibly feeding it the signal.
1287 const int signo = action->signal;
1288 ResumeThread(static_cast<NativeThreadLinux &>(*thread_sp), action->state,
1289 signo);
1290 break;
1291 }
Tamas Berghammere7708682015-04-22 10:00:23 +00001292
Kate Stoneb9c1b512016-09-06 20:57:50 +00001293 case eStateSuspended:
1294 case eStateStopped:
Pavel Labatha6321a82017-01-19 15:26:04 +00001295 llvm_unreachable("Unexpected state");
Tamas Berghammere7708682015-04-22 10:00:23 +00001296
Kate Stoneb9c1b512016-09-06 20:57:50 +00001297 default:
1298 return Error("NativeProcessLinux::%s (): unexpected state %s specified "
1299 "for pid %" PRIu64 ", tid %" PRIu64,
1300 __FUNCTION__, StateAsCString(action->state), GetID(),
1301 thread_sp->GetID());
1302 }
1303 }
1304
Mehdi Amini665be502016-11-11 05:07:57 +00001305 return Error();
Tamas Berghammere7708682015-04-22 10:00:23 +00001306}
1307
Kate Stoneb9c1b512016-09-06 20:57:50 +00001308Error NativeProcessLinux::Halt() {
1309 Error error;
1310
1311 if (kill(GetID(), SIGSTOP) != 0)
1312 error.SetErrorToErrno();
1313
1314 return error;
Tamas Berghammere7708682015-04-22 10:00:23 +00001315}
1316
Kate Stoneb9c1b512016-09-06 20:57:50 +00001317Error NativeProcessLinux::Detach() {
1318 Error error;
1319
1320 // Stop monitoring the inferior.
1321 m_sigchld_handle.reset();
1322
1323 // Tell ptrace to detach from the process.
1324 if (GetID() == LLDB_INVALID_PROCESS_ID)
1325 return error;
1326
1327 for (auto thread_sp : m_threads) {
1328 Error e = Detach(thread_sp->GetID());
1329 if (e.Fail())
1330 error =
1331 e; // Save the error, but still attempt to detach from other threads.
1332 }
1333
1334 return error;
1335}
1336
1337Error NativeProcessLinux::Signal(int signo) {
1338 Error error;
1339
Pavel Labatha6321a82017-01-19 15:26:04 +00001340 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1341 LLDB_LOG(log, "sending signal {0} ({1}) to pid {1}", signo,
1342 Host::GetSignalAsCString(signo), GetID());
Kate Stoneb9c1b512016-09-06 20:57:50 +00001343
1344 if (kill(GetID(), signo))
1345 error.SetErrorToErrno();
1346
1347 return error;
1348}
1349
1350Error NativeProcessLinux::Interrupt() {
1351 // Pick a running thread (or if none, a not-dead stopped thread) as
1352 // the chosen thread that will be the stop-reason thread.
Pavel Labatha6321a82017-01-19 15:26:04 +00001353 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
Kate Stoneb9c1b512016-09-06 20:57:50 +00001354
1355 NativeThreadProtocolSP running_thread_sp;
1356 NativeThreadProtocolSP stopped_thread_sp;
1357
Pavel Labatha6321a82017-01-19 15:26:04 +00001358 LLDB_LOG(log, "selecting running thread for interrupt target");
Kate Stoneb9c1b512016-09-06 20:57:50 +00001359 for (auto thread_sp : m_threads) {
1360 // The thread shouldn't be null but lets just cover that here.
1361 if (!thread_sp)
1362 continue;
1363
1364 // If we have a running or stepping thread, we'll call that the
1365 // target of the interrupt.
1366 const auto thread_state = thread_sp->GetState();
1367 if (thread_state == eStateRunning || thread_state == eStateStepping) {
1368 running_thread_sp = thread_sp;
1369 break;
1370 } else if (!stopped_thread_sp && StateIsStoppedState(thread_state, true)) {
1371 // Remember the first non-dead stopped thread. We'll use that as a backup
1372 // if there are no running threads.
1373 stopped_thread_sp = thread_sp;
1374 }
1375 }
1376
1377 if (!running_thread_sp && !stopped_thread_sp) {
1378 Error error("found no running/stepping or live stopped threads as target "
1379 "for interrupt");
Pavel Labatha6321a82017-01-19 15:26:04 +00001380 LLDB_LOG(log, "skipping due to error: {0}", error);
Todd Fialaaf245d12014-06-30 21:05:18 +00001381
1382 return error;
Kate Stoneb9c1b512016-09-06 20:57:50 +00001383 }
1384
1385 NativeThreadProtocolSP deferred_signal_thread_sp =
1386 running_thread_sp ? running_thread_sp : stopped_thread_sp;
1387
Pavel Labatha6321a82017-01-19 15:26:04 +00001388 LLDB_LOG(log, "pid {0} {1} tid {2} chosen for interrupt target", GetID(),
1389 running_thread_sp ? "running" : "stopped",
1390 deferred_signal_thread_sp->GetID());
Kate Stoneb9c1b512016-09-06 20:57:50 +00001391
1392 StopRunningThreads(deferred_signal_thread_sp->GetID());
1393
Mehdi Amini665be502016-11-11 05:07:57 +00001394 return Error();
Todd Fialaaf245d12014-06-30 21:05:18 +00001395}
1396
Kate Stoneb9c1b512016-09-06 20:57:50 +00001397Error NativeProcessLinux::Kill() {
Pavel Labatha6321a82017-01-19 15:26:04 +00001398 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1399 LLDB_LOG(log, "pid {0}", GetID());
Todd Fialaaf245d12014-06-30 21:05:18 +00001400
Kate Stoneb9c1b512016-09-06 20:57:50 +00001401 Error error;
Todd Fialaaf245d12014-06-30 21:05:18 +00001402
Kate Stoneb9c1b512016-09-06 20:57:50 +00001403 switch (m_state) {
1404 case StateType::eStateInvalid:
1405 case StateType::eStateExited:
1406 case StateType::eStateCrashed:
1407 case StateType::eStateDetached:
1408 case StateType::eStateUnloaded:
1409 // Nothing to do - the process is already dead.
Pavel Labatha6321a82017-01-19 15:26:04 +00001410 LLDB_LOG(log, "ignored for PID {0} due to current state: {1}", GetID(),
Pavel Labath8198db32017-01-24 11:48:25 +00001411 m_state);
Todd Fialaaf245d12014-06-30 21:05:18 +00001412 return error;
Todd Fialaaf245d12014-06-30 21:05:18 +00001413
Kate Stoneb9c1b512016-09-06 20:57:50 +00001414 case StateType::eStateConnected:
1415 case StateType::eStateAttaching:
1416 case StateType::eStateLaunching:
1417 case StateType::eStateStopped:
1418 case StateType::eStateRunning:
1419 case StateType::eStateStepping:
1420 case StateType::eStateSuspended:
1421 // We can try to kill a process in these states.
1422 break;
1423 }
Todd Fialaaf245d12014-06-30 21:05:18 +00001424
Kate Stoneb9c1b512016-09-06 20:57:50 +00001425 if (kill(GetID(), SIGKILL) != 0) {
1426 error.SetErrorToErrno();
Todd Fialaaf245d12014-06-30 21:05:18 +00001427 return error;
Kate Stoneb9c1b512016-09-06 20:57:50 +00001428 }
Todd Fialaaf245d12014-06-30 21:05:18 +00001429
Kate Stoneb9c1b512016-09-06 20:57:50 +00001430 return error;
Todd Fialaaf245d12014-06-30 21:05:18 +00001431}
1432
1433static Error
Pavel Labath15930862017-03-21 13:49:45 +00001434ParseMemoryRegionInfoFromProcMapsLine(llvm::StringRef &maps_line,
Kate Stoneb9c1b512016-09-06 20:57:50 +00001435 MemoryRegionInfo &memory_region_info) {
1436 memory_region_info.Clear();
Todd Fialaaf245d12014-06-30 21:05:18 +00001437
Pavel Labath15930862017-03-21 13:49:45 +00001438 StringExtractor line_extractor(maps_line);
Todd Fialaaf245d12014-06-30 21:05:18 +00001439
Kate Stoneb9c1b512016-09-06 20:57:50 +00001440 // Format: {address_start_hex}-{address_end_hex} perms offset dev inode
1441 // pathname
1442 // perms: rwxp (letter is present if set, '-' if not, final character is
1443 // p=private, s=shared).
Todd Fialaaf245d12014-06-30 21:05:18 +00001444
Kate Stoneb9c1b512016-09-06 20:57:50 +00001445 // Parse out the starting address
1446 lldb::addr_t start_address = line_extractor.GetHexMaxU64(false, 0);
Todd Fialaaf245d12014-06-30 21:05:18 +00001447
Kate Stoneb9c1b512016-09-06 20:57:50 +00001448 // Parse out hyphen separating start and end address from range.
1449 if (!line_extractor.GetBytesLeft() || (line_extractor.GetChar() != '-'))
1450 return Error(
1451 "malformed /proc/{pid}/maps entry, missing dash between address range");
Todd Fialaaf245d12014-06-30 21:05:18 +00001452
Kate Stoneb9c1b512016-09-06 20:57:50 +00001453 // Parse out the ending address
1454 lldb::addr_t end_address = line_extractor.GetHexMaxU64(false, start_address);
Todd Fialaaf245d12014-06-30 21:05:18 +00001455
Kate Stoneb9c1b512016-09-06 20:57:50 +00001456 // Parse out the space after the address.
1457 if (!line_extractor.GetBytesLeft() || (line_extractor.GetChar() != ' '))
1458 return Error("malformed /proc/{pid}/maps entry, missing space after range");
Todd Fialaaf245d12014-06-30 21:05:18 +00001459
Kate Stoneb9c1b512016-09-06 20:57:50 +00001460 // Save the range.
1461 memory_region_info.GetRange().SetRangeBase(start_address);
1462 memory_region_info.GetRange().SetRangeEnd(end_address);
Todd Fialaaf245d12014-06-30 21:05:18 +00001463
Kate Stoneb9c1b512016-09-06 20:57:50 +00001464 // Any memory region in /proc/{pid}/maps is by definition mapped into the
1465 // process.
1466 memory_region_info.SetMapped(MemoryRegionInfo::OptionalBool::eYes);
Howard Hellyerad007562016-07-07 08:21:28 +00001467
Kate Stoneb9c1b512016-09-06 20:57:50 +00001468 // Parse out each permission entry.
1469 if (line_extractor.GetBytesLeft() < 4)
1470 return Error("malformed /proc/{pid}/maps entry, missing some portion of "
1471 "permissions");
Todd Fialaaf245d12014-06-30 21:05:18 +00001472
Kate Stoneb9c1b512016-09-06 20:57:50 +00001473 // Handle read permission.
1474 const char read_perm_char = line_extractor.GetChar();
1475 if (read_perm_char == 'r')
1476 memory_region_info.SetReadable(MemoryRegionInfo::OptionalBool::eYes);
1477 else if (read_perm_char == '-')
1478 memory_region_info.SetReadable(MemoryRegionInfo::OptionalBool::eNo);
1479 else
1480 return Error("unexpected /proc/{pid}/maps read permission char");
Todd Fialaaf245d12014-06-30 21:05:18 +00001481
Kate Stoneb9c1b512016-09-06 20:57:50 +00001482 // Handle write permission.
1483 const char write_perm_char = line_extractor.GetChar();
1484 if (write_perm_char == 'w')
1485 memory_region_info.SetWritable(MemoryRegionInfo::OptionalBool::eYes);
1486 else if (write_perm_char == '-')
1487 memory_region_info.SetWritable(MemoryRegionInfo::OptionalBool::eNo);
1488 else
1489 return Error("unexpected /proc/{pid}/maps write permission char");
Todd Fialaaf245d12014-06-30 21:05:18 +00001490
Kate Stoneb9c1b512016-09-06 20:57:50 +00001491 // Handle execute permission.
1492 const char exec_perm_char = line_extractor.GetChar();
1493 if (exec_perm_char == 'x')
1494 memory_region_info.SetExecutable(MemoryRegionInfo::OptionalBool::eYes);
1495 else if (exec_perm_char == '-')
1496 memory_region_info.SetExecutable(MemoryRegionInfo::OptionalBool::eNo);
1497 else
1498 return Error("unexpected /proc/{pid}/maps exec permission char");
Todd Fialaaf245d12014-06-30 21:05:18 +00001499
Kate Stoneb9c1b512016-09-06 20:57:50 +00001500 line_extractor.GetChar(); // Read the private bit
1501 line_extractor.SkipSpaces(); // Skip the separator
1502 line_extractor.GetHexMaxU64(false, 0); // Read the offset
1503 line_extractor.GetHexMaxU64(false, 0); // Read the major device number
1504 line_extractor.GetChar(); // Read the device id separator
1505 line_extractor.GetHexMaxU64(false, 0); // Read the major device number
1506 line_extractor.SkipSpaces(); // Skip the separator
1507 line_extractor.GetU64(0, 10); // Read the inode number
Tamas Berghammerd7d69f82016-07-22 12:55:35 +00001508
Kate Stoneb9c1b512016-09-06 20:57:50 +00001509 line_extractor.SkipSpaces();
1510 const char *name = line_extractor.Peek();
1511 if (name)
1512 memory_region_info.SetName(name);
Tamas Berghammerd7d69f82016-07-22 12:55:35 +00001513
Mehdi Amini665be502016-11-11 05:07:57 +00001514 return Error();
Todd Fialaaf245d12014-06-30 21:05:18 +00001515}
1516
Kate Stoneb9c1b512016-09-06 20:57:50 +00001517Error NativeProcessLinux::GetMemoryRegionInfo(lldb::addr_t load_addr,
1518 MemoryRegionInfo &range_info) {
1519 // FIXME review that the final memory region returned extends to the end of
1520 // the virtual address space,
1521 // with no perms if it is not mapped.
Todd Fialaaf245d12014-06-30 21:05:18 +00001522
Kate Stoneb9c1b512016-09-06 20:57:50 +00001523 // Use an approach that reads memory regions from /proc/{pid}/maps.
1524 // Assume proc maps entries are in ascending order.
1525 // FIXME assert if we find differently.
Todd Fialaaf245d12014-06-30 21:05:18 +00001526
Kate Stoneb9c1b512016-09-06 20:57:50 +00001527 if (m_supports_mem_region == LazyBool::eLazyBoolNo) {
1528 // We're done.
Tamas Berghammera6f57952017-01-03 16:29:43 +00001529 return Error("unsupported");
Kate Stoneb9c1b512016-09-06 20:57:50 +00001530 }
Todd Fialaaf245d12014-06-30 21:05:18 +00001531
Tamas Berghammera6f57952017-01-03 16:29:43 +00001532 Error error = PopulateMemoryRegionCache();
1533 if (error.Fail()) {
1534 return error;
Kate Stoneb9c1b512016-09-06 20:57:50 +00001535 }
1536
1537 lldb::addr_t prev_base_address = 0;
1538
1539 // FIXME start by finding the last region that is <= target address using
1540 // binary search. Data is sorted.
1541 // There can be a ton of regions on pthreads apps with lots of threads.
1542 for (auto it = m_mem_region_cache.begin(); it != m_mem_region_cache.end();
1543 ++it) {
Tamas Berghammera6f57952017-01-03 16:29:43 +00001544 MemoryRegionInfo &proc_entry_info = it->first;
Kate Stoneb9c1b512016-09-06 20:57:50 +00001545
1546 // Sanity check assumption that /proc/{pid}/maps entries are ascending.
1547 assert((proc_entry_info.GetRange().GetRangeBase() >= prev_base_address) &&
1548 "descending /proc/pid/maps entries detected, unexpected");
1549 prev_base_address = proc_entry_info.GetRange().GetRangeBase();
Hafiz Abid Qadeerb1554312017-01-20 10:24:03 +00001550 UNUSED_IF_ASSERT_DISABLED(prev_base_address);
Kate Stoneb9c1b512016-09-06 20:57:50 +00001551
1552 // If the target address comes before this entry, indicate distance to next
1553 // region.
1554 if (load_addr < proc_entry_info.GetRange().GetRangeBase()) {
1555 range_info.GetRange().SetRangeBase(load_addr);
1556 range_info.GetRange().SetByteSize(
1557 proc_entry_info.GetRange().GetRangeBase() - load_addr);
1558 range_info.SetReadable(MemoryRegionInfo::OptionalBool::eNo);
1559 range_info.SetWritable(MemoryRegionInfo::OptionalBool::eNo);
1560 range_info.SetExecutable(MemoryRegionInfo::OptionalBool::eNo);
1561 range_info.SetMapped(MemoryRegionInfo::OptionalBool::eNo);
1562
1563 return error;
1564 } else if (proc_entry_info.GetRange().Contains(load_addr)) {
1565 // The target address is within the memory region we're processing here.
1566 range_info = proc_entry_info;
1567 return error;
1568 }
1569
1570 // The target memory address comes somewhere after the region we just
1571 // parsed.
1572 }
1573
1574 // If we made it here, we didn't find an entry that contained the given
1575 // address. Return the
1576 // load_addr as start and the amount of bytes betwwen load address and the end
1577 // of the memory as
1578 // size.
1579 range_info.GetRange().SetRangeBase(load_addr);
1580 range_info.GetRange().SetRangeEnd(LLDB_INVALID_ADDRESS);
1581 range_info.SetReadable(MemoryRegionInfo::OptionalBool::eNo);
1582 range_info.SetWritable(MemoryRegionInfo::OptionalBool::eNo);
1583 range_info.SetExecutable(MemoryRegionInfo::OptionalBool::eNo);
1584 range_info.SetMapped(MemoryRegionInfo::OptionalBool::eNo);
1585 return error;
1586}
1587
Tamas Berghammera6f57952017-01-03 16:29:43 +00001588Error NativeProcessLinux::PopulateMemoryRegionCache() {
Pavel Labatha6321a82017-01-19 15:26:04 +00001589 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
Tamas Berghammera6f57952017-01-03 16:29:43 +00001590
1591 // If our cache is empty, pull the latest. There should always be at least
1592 // one memory region if memory region handling is supported.
1593 if (!m_mem_region_cache.empty()) {
Pavel Labatha6321a82017-01-19 15:26:04 +00001594 LLDB_LOG(log, "reusing {0} cached memory region entries",
1595 m_mem_region_cache.size());
Tamas Berghammera6f57952017-01-03 16:29:43 +00001596 return Error();
1597 }
1598
Pavel Labath15930862017-03-21 13:49:45 +00001599 auto BufferOrError = getProcFile(GetID(), "maps");
1600 if (!BufferOrError) {
Tamas Berghammera6f57952017-01-03 16:29:43 +00001601 m_supports_mem_region = LazyBool::eLazyBoolNo;
Pavel Labath15930862017-03-21 13:49:45 +00001602 return BufferOrError.getError();
1603 }
1604 StringRef Rest = BufferOrError.get()->getBuffer();
1605 while (! Rest.empty()) {
1606 StringRef Line;
1607 std::tie(Line, Rest) = Rest.split('\n');
1608 MemoryRegionInfo info;
1609 const Error parse_error = ParseMemoryRegionInfoFromProcMapsLine(Line, info);
1610 if (parse_error.Fail()) {
1611 LLDB_LOG(log, "failed to parse proc maps line '{0}': {1}", Line,
1612 parse_error);
1613 m_supports_mem_region = LazyBool::eLazyBoolNo;
1614 return parse_error;
1615 }
1616 m_mem_region_cache.emplace_back(
1617 info, FileSpec(info.GetName().GetCString(), true));
1618 }
1619
1620 if (m_mem_region_cache.empty()) {
Tamas Berghammera6f57952017-01-03 16:29:43 +00001621 // No entries after attempting to read them. This shouldn't happen if
1622 // /proc/{pid}/maps is supported. Assume we don't support map entries
1623 // via procfs.
Pavel Labath15930862017-03-21 13:49:45 +00001624 m_supports_mem_region = LazyBool::eLazyBoolNo;
Pavel Labatha6321a82017-01-19 15:26:04 +00001625 LLDB_LOG(log,
1626 "failed to find any procfs maps entries, assuming no support "
1627 "for memory region metadata retrieval");
Pavel Labath15930862017-03-21 13:49:45 +00001628 return Error("not supported");
Tamas Berghammera6f57952017-01-03 16:29:43 +00001629 }
1630
Pavel Labatha6321a82017-01-19 15:26:04 +00001631 LLDB_LOG(log, "read {0} memory region entries from /proc/{1}/maps",
1632 m_mem_region_cache.size(), GetID());
Tamas Berghammera6f57952017-01-03 16:29:43 +00001633
1634 // We support memory retrieval, remember that.
1635 m_supports_mem_region = LazyBool::eLazyBoolYes;
1636 return Error();
1637}
1638
Kate Stoneb9c1b512016-09-06 20:57:50 +00001639void NativeProcessLinux::DoStopIDBumped(uint32_t newBumpId) {
Pavel Labatha6321a82017-01-19 15:26:04 +00001640 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1641 LLDB_LOG(log, "newBumpId={0}", newBumpId);
1642 LLDB_LOG(log, "clearing {0} entries from memory region cache",
1643 m_mem_region_cache.size());
Kate Stoneb9c1b512016-09-06 20:57:50 +00001644 m_mem_region_cache.clear();
1645}
1646
1647Error NativeProcessLinux::AllocateMemory(size_t size, uint32_t permissions,
1648 lldb::addr_t &addr) {
1649// FIXME implementing this requires the equivalent of
1650// InferiorCallPOSIX::InferiorCallMmap, which depends on
1651// functional ThreadPlans working with Native*Protocol.
1652#if 1
1653 return Error("not implemented yet");
1654#else
1655 addr = LLDB_INVALID_ADDRESS;
1656
1657 unsigned prot = 0;
1658 if (permissions & lldb::ePermissionsReadable)
1659 prot |= eMmapProtRead;
1660 if (permissions & lldb::ePermissionsWritable)
1661 prot |= eMmapProtWrite;
1662 if (permissions & lldb::ePermissionsExecutable)
1663 prot |= eMmapProtExec;
1664
1665 // TODO implement this directly in NativeProcessLinux
1666 // (and lift to NativeProcessPOSIX if/when that class is
1667 // refactored out).
1668 if (InferiorCallMmap(this, addr, 0, size, prot,
1669 eMmapFlagsAnon | eMmapFlagsPrivate, -1, 0)) {
1670 m_addr_to_mmap_size[addr] = size;
Mehdi Amini665be502016-11-11 05:07:57 +00001671 return Error();
Kate Stoneb9c1b512016-09-06 20:57:50 +00001672 } else {
1673 addr = LLDB_INVALID_ADDRESS;
1674 return Error("unable to allocate %" PRIu64
1675 " bytes of memory with permissions %s",
1676 size, GetPermissionsAsCString(permissions));
1677 }
Todd Fialaaf245d12014-06-30 21:05:18 +00001678#endif
1679}
1680
Kate Stoneb9c1b512016-09-06 20:57:50 +00001681Error NativeProcessLinux::DeallocateMemory(lldb::addr_t addr) {
1682 // FIXME see comments in AllocateMemory - required lower-level
1683 // bits not in place yet (ThreadPlans)
1684 return Error("not implemented");
Todd Fialaaf245d12014-06-30 21:05:18 +00001685}
1686
Kate Stoneb9c1b512016-09-06 20:57:50 +00001687lldb::addr_t NativeProcessLinux::GetSharedLibraryInfoAddress() {
1688 // punt on this for now
1689 return LLDB_INVALID_ADDRESS;
Todd Fialaaf245d12014-06-30 21:05:18 +00001690}
1691
Kate Stoneb9c1b512016-09-06 20:57:50 +00001692size_t NativeProcessLinux::UpdateThreads() {
1693 // The NativeProcessLinux monitoring threads are always up to date
1694 // with respect to thread state and they keep the thread list
1695 // populated properly. All this method needs to do is return the
1696 // thread count.
1697 return m_threads.size();
Todd Fialaaf245d12014-06-30 21:05:18 +00001698}
1699
Kate Stoneb9c1b512016-09-06 20:57:50 +00001700bool NativeProcessLinux::GetArchitecture(ArchSpec &arch) const {
1701 arch = m_arch;
1702 return true;
Todd Fialaaf245d12014-06-30 21:05:18 +00001703}
1704
Kate Stoneb9c1b512016-09-06 20:57:50 +00001705Error NativeProcessLinux::GetSoftwareBreakpointPCOffset(
1706 uint32_t &actual_opcode_size) {
1707 // FIXME put this behind a breakpoint protocol class that can be
1708 // set per architecture. Need ARM, MIPS support here.
1709 static const uint8_t g_i386_opcode[] = {0xCC};
1710 static const uint8_t g_s390x_opcode[] = {0x00, 0x01};
Todd Fialaaf245d12014-06-30 21:05:18 +00001711
Kate Stoneb9c1b512016-09-06 20:57:50 +00001712 switch (m_arch.GetMachine()) {
1713 case llvm::Triple::x86:
1714 case llvm::Triple::x86_64:
1715 actual_opcode_size = static_cast<uint32_t>(sizeof(g_i386_opcode));
Mehdi Amini665be502016-11-11 05:07:57 +00001716 return Error();
Todd Fialaaf245d12014-06-30 21:05:18 +00001717
Kate Stoneb9c1b512016-09-06 20:57:50 +00001718 case llvm::Triple::systemz:
1719 actual_opcode_size = static_cast<uint32_t>(sizeof(g_s390x_opcode));
Mehdi Amini665be502016-11-11 05:07:57 +00001720 return Error();
Ulrich Weigandbb00d0b2016-04-14 14:28:34 +00001721
Kate Stoneb9c1b512016-09-06 20:57:50 +00001722 case llvm::Triple::arm:
1723 case llvm::Triple::aarch64:
1724 case llvm::Triple::mips64:
1725 case llvm::Triple::mips64el:
1726 case llvm::Triple::mips:
1727 case llvm::Triple::mipsel:
1728 // On these architectures the PC don't get updated for breakpoint hits
1729 actual_opcode_size = 0;
Mehdi Amini665be502016-11-11 05:07:57 +00001730 return Error();
Kate Stoneb9c1b512016-09-06 20:57:50 +00001731
1732 default:
1733 assert(false && "CPU type not supported!");
1734 return Error("CPU type not supported");
1735 }
Todd Fialaaf245d12014-06-30 21:05:18 +00001736}
1737
Kate Stoneb9c1b512016-09-06 20:57:50 +00001738Error NativeProcessLinux::SetBreakpoint(lldb::addr_t addr, uint32_t size,
1739 bool hardware) {
1740 if (hardware)
Omair Javaidd5ffbad2017-02-24 13:27:31 +00001741 return SetHardwareBreakpoint(addr, size);
Kate Stoneb9c1b512016-09-06 20:57:50 +00001742 else
1743 return SetSoftwareBreakpoint(addr, size);
Todd Fialaaf245d12014-06-30 21:05:18 +00001744}
1745
Omair Javaidd5ffbad2017-02-24 13:27:31 +00001746Error NativeProcessLinux::RemoveBreakpoint(lldb::addr_t addr, bool hardware) {
1747 if (hardware)
1748 return RemoveHardwareBreakpoint(addr);
1749 else
1750 return NativeProcessProtocol::RemoveBreakpoint(addr);
1751}
1752
Kate Stoneb9c1b512016-09-06 20:57:50 +00001753Error NativeProcessLinux::GetSoftwareBreakpointTrapOpcode(
1754 size_t trap_opcode_size_hint, size_t &actual_opcode_size,
1755 const uint8_t *&trap_opcode_bytes) {
1756 // FIXME put this behind a breakpoint protocol class that can be set per
1757 // architecture. Need MIPS support here.
1758 static const uint8_t g_aarch64_opcode[] = {0x00, 0x00, 0x20, 0xd4};
1759 // The ARM reference recommends the use of 0xe7fddefe and 0xdefe but the
1760 // linux kernel does otherwise.
1761 static const uint8_t g_arm_breakpoint_opcode[] = {0xf0, 0x01, 0xf0, 0xe7};
1762 static const uint8_t g_i386_opcode[] = {0xCC};
1763 static const uint8_t g_mips64_opcode[] = {0x00, 0x00, 0x00, 0x0d};
1764 static const uint8_t g_mips64el_opcode[] = {0x0d, 0x00, 0x00, 0x00};
1765 static const uint8_t g_s390x_opcode[] = {0x00, 0x01};
1766 static const uint8_t g_thumb_breakpoint_opcode[] = {0x01, 0xde};
Todd Fialaaf245d12014-06-30 21:05:18 +00001767
Kate Stoneb9c1b512016-09-06 20:57:50 +00001768 switch (m_arch.GetMachine()) {
1769 case llvm::Triple::aarch64:
1770 trap_opcode_bytes = g_aarch64_opcode;
1771 actual_opcode_size = sizeof(g_aarch64_opcode);
Mehdi Amini665be502016-11-11 05:07:57 +00001772 return Error();
Todd Fiala2afc5962014-08-21 16:42:31 +00001773
Kate Stoneb9c1b512016-09-06 20:57:50 +00001774 case llvm::Triple::arm:
1775 switch (trap_opcode_size_hint) {
1776 case 2:
1777 trap_opcode_bytes = g_thumb_breakpoint_opcode;
1778 actual_opcode_size = sizeof(g_thumb_breakpoint_opcode);
Mehdi Amini665be502016-11-11 05:07:57 +00001779 return Error();
Kate Stoneb9c1b512016-09-06 20:57:50 +00001780 case 4:
1781 trap_opcode_bytes = g_arm_breakpoint_opcode;
1782 actual_opcode_size = sizeof(g_arm_breakpoint_opcode);
Mehdi Amini665be502016-11-11 05:07:57 +00001783 return Error();
Todd Fialaaf245d12014-06-30 21:05:18 +00001784 default:
Kate Stoneb9c1b512016-09-06 20:57:50 +00001785 assert(false && "Unrecognised trap opcode size hint!");
1786 return Error("Unrecognised trap opcode size hint!");
Todd Fialaaf245d12014-06-30 21:05:18 +00001787 }
Kate Stoneb9c1b512016-09-06 20:57:50 +00001788
1789 case llvm::Triple::x86:
1790 case llvm::Triple::x86_64:
1791 trap_opcode_bytes = g_i386_opcode;
1792 actual_opcode_size = sizeof(g_i386_opcode);
Mehdi Amini665be502016-11-11 05:07:57 +00001793 return Error();
Kate Stoneb9c1b512016-09-06 20:57:50 +00001794
1795 case llvm::Triple::mips:
1796 case llvm::Triple::mips64:
1797 trap_opcode_bytes = g_mips64_opcode;
1798 actual_opcode_size = sizeof(g_mips64_opcode);
Mehdi Amini665be502016-11-11 05:07:57 +00001799 return Error();
Kate Stoneb9c1b512016-09-06 20:57:50 +00001800
1801 case llvm::Triple::mipsel:
1802 case llvm::Triple::mips64el:
1803 trap_opcode_bytes = g_mips64el_opcode;
1804 actual_opcode_size = sizeof(g_mips64el_opcode);
Mehdi Amini665be502016-11-11 05:07:57 +00001805 return Error();
Kate Stoneb9c1b512016-09-06 20:57:50 +00001806
1807 case llvm::Triple::systemz:
1808 trap_opcode_bytes = g_s390x_opcode;
1809 actual_opcode_size = sizeof(g_s390x_opcode);
Mehdi Amini665be502016-11-11 05:07:57 +00001810 return Error();
Kate Stoneb9c1b512016-09-06 20:57:50 +00001811
1812 default:
1813 assert(false && "CPU type not supported!");
1814 return Error("CPU type not supported");
1815 }
Todd Fialaaf245d12014-06-30 21:05:18 +00001816}
1817
1818#if 0
1819ProcessMessage::CrashReason
1820NativeProcessLinux::GetCrashReasonForSIGSEGV(const siginfo_t *info)
1821{
1822 ProcessMessage::CrashReason reason;
1823 assert(info->si_signo == SIGSEGV);
1824
1825 reason = ProcessMessage::eInvalidCrashReason;
1826
1827 switch (info->si_code)
1828 {
1829 default:
1830 assert(false && "unexpected si_code for SIGSEGV");
1831 break;
1832 case SI_KERNEL:
1833 // Linux will occasionally send spurious SI_KERNEL codes.
1834 // (this is poorly documented in sigaction)
1835 // One way to get this is via unaligned SIMD loads.
1836 reason = ProcessMessage::eInvalidAddress; // for lack of anything better
1837 break;
1838 case SEGV_MAPERR:
1839 reason = ProcessMessage::eInvalidAddress;
1840 break;
1841 case SEGV_ACCERR:
1842 reason = ProcessMessage::ePrivilegedAddress;
1843 break;
1844 }
1845
1846 return reason;
1847}
1848#endif
1849
Todd Fialaaf245d12014-06-30 21:05:18 +00001850#if 0
1851ProcessMessage::CrashReason
1852NativeProcessLinux::GetCrashReasonForSIGILL(const siginfo_t *info)
1853{
1854 ProcessMessage::CrashReason reason;
1855 assert(info->si_signo == SIGILL);
1856
1857 reason = ProcessMessage::eInvalidCrashReason;
1858
1859 switch (info->si_code)
1860 {
1861 default:
1862 assert(false && "unexpected si_code for SIGILL");
1863 break;
1864 case ILL_ILLOPC:
1865 reason = ProcessMessage::eIllegalOpcode;
1866 break;
1867 case ILL_ILLOPN:
1868 reason = ProcessMessage::eIllegalOperand;
1869 break;
1870 case ILL_ILLADR:
1871 reason = ProcessMessage::eIllegalAddressingMode;
1872 break;
1873 case ILL_ILLTRP:
1874 reason = ProcessMessage::eIllegalTrap;
1875 break;
1876 case ILL_PRVOPC:
1877 reason = ProcessMessage::ePrivilegedOpcode;
1878 break;
1879 case ILL_PRVREG:
1880 reason = ProcessMessage::ePrivilegedRegister;
1881 break;
1882 case ILL_COPROC:
1883 reason = ProcessMessage::eCoprocessorError;
1884 break;
1885 case ILL_BADSTK:
1886 reason = ProcessMessage::eInternalStackError;
1887 break;
1888 }
1889
1890 return reason;
1891}
1892#endif
1893
1894#if 0
1895ProcessMessage::CrashReason
1896NativeProcessLinux::GetCrashReasonForSIGFPE(const siginfo_t *info)
1897{
1898 ProcessMessage::CrashReason reason;
1899 assert(info->si_signo == SIGFPE);
1900
1901 reason = ProcessMessage::eInvalidCrashReason;
1902
1903 switch (info->si_code)
1904 {
1905 default:
1906 assert(false && "unexpected si_code for SIGFPE");
1907 break;
1908 case FPE_INTDIV:
1909 reason = ProcessMessage::eIntegerDivideByZero;
1910 break;
1911 case FPE_INTOVF:
1912 reason = ProcessMessage::eIntegerOverflow;
1913 break;
1914 case FPE_FLTDIV:
1915 reason = ProcessMessage::eFloatDivideByZero;
1916 break;
1917 case FPE_FLTOVF:
1918 reason = ProcessMessage::eFloatOverflow;
1919 break;
1920 case FPE_FLTUND:
1921 reason = ProcessMessage::eFloatUnderflow;
1922 break;
1923 case FPE_FLTRES:
1924 reason = ProcessMessage::eFloatInexactResult;
1925 break;
1926 case FPE_FLTINV:
1927 reason = ProcessMessage::eFloatInvalidOperation;
1928 break;
1929 case FPE_FLTSUB:
1930 reason = ProcessMessage::eFloatSubscriptRange;
1931 break;
1932 }
1933
1934 return reason;
1935}
1936#endif
1937
1938#if 0
1939ProcessMessage::CrashReason
1940NativeProcessLinux::GetCrashReasonForSIGBUS(const siginfo_t *info)
1941{
1942 ProcessMessage::CrashReason reason;
1943 assert(info->si_signo == SIGBUS);
1944
1945 reason = ProcessMessage::eInvalidCrashReason;
1946
1947 switch (info->si_code)
1948 {
1949 default:
1950 assert(false && "unexpected si_code for SIGBUS");
1951 break;
1952 case BUS_ADRALN:
1953 reason = ProcessMessage::eIllegalAlignment;
1954 break;
1955 case BUS_ADRERR:
1956 reason = ProcessMessage::eIllegalAddress;
1957 break;
1958 case BUS_OBJERR:
1959 reason = ProcessMessage::eHardwareError;
1960 break;
1961 }
1962
1963 return reason;
1964}
1965#endif
1966
Kate Stoneb9c1b512016-09-06 20:57:50 +00001967Error NativeProcessLinux::ReadMemory(lldb::addr_t addr, void *buf, size_t size,
1968 size_t &bytes_read) {
1969 if (ProcessVmReadvSupported()) {
1970 // The process_vm_readv path is about 50 times faster than ptrace api. We
1971 // want to use
1972 // this syscall if it is supported.
Pavel Labathdf7c6992015-06-17 18:38:49 +00001973
Kate Stoneb9c1b512016-09-06 20:57:50 +00001974 const ::pid_t pid = GetID();
Pavel Labathdf7c6992015-06-17 18:38:49 +00001975
Kate Stoneb9c1b512016-09-06 20:57:50 +00001976 struct iovec local_iov, remote_iov;
1977 local_iov.iov_base = buf;
1978 local_iov.iov_len = size;
1979 remote_iov.iov_base = reinterpret_cast<void *>(addr);
1980 remote_iov.iov_len = size;
Pavel Labathdf7c6992015-06-17 18:38:49 +00001981
Kate Stoneb9c1b512016-09-06 20:57:50 +00001982 bytes_read = process_vm_readv(pid, &local_iov, 1, &remote_iov, 1, 0);
1983 const bool success = bytes_read == size;
Pavel Labathdf7c6992015-06-17 18:38:49 +00001984
Pavel Labatha6321a82017-01-19 15:26:04 +00001985 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
1986 LLDB_LOG(log,
1987 "using process_vm_readv to read {0} bytes from inferior "
1988 "address {1:x}: {2}",
1989 size, addr, success ? "Success" : strerror(errno));
Pavel Labath19cbe962015-07-21 13:20:32 +00001990
Kate Stoneb9c1b512016-09-06 20:57:50 +00001991 if (success)
Mehdi Amini665be502016-11-11 05:07:57 +00001992 return Error();
Pavel Labatha6321a82017-01-19 15:26:04 +00001993 // else the call failed for some reason, let's retry the read using ptrace
1994 // api.
Kate Stoneb9c1b512016-09-06 20:57:50 +00001995 }
Pavel Labath19cbe962015-07-21 13:20:32 +00001996
Kate Stoneb9c1b512016-09-06 20:57:50 +00001997 unsigned char *dst = static_cast<unsigned char *>(buf);
1998 size_t remainder;
1999 long data;
Pavel Labath19cbe962015-07-21 13:20:32 +00002000
Pavel Labatha6321a82017-01-19 15:26:04 +00002001 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_MEMORY));
2002 LLDB_LOG(log, "addr = {0}, buf = {1}, size = {2}", addr, buf, size);
Pavel Labath19cbe962015-07-21 13:20:32 +00002003
Kate Stoneb9c1b512016-09-06 20:57:50 +00002004 for (bytes_read = 0; bytes_read < size; bytes_read += remainder) {
2005 Error error = NativeProcessLinux::PtraceWrapper(
2006 PTRACE_PEEKDATA, GetID(), (void *)addr, nullptr, 0, &data);
Pavel Labatha6321a82017-01-19 15:26:04 +00002007 if (error.Fail())
Kate Stoneb9c1b512016-09-06 20:57:50 +00002008 return error;
Kate Stoneb9c1b512016-09-06 20:57:50 +00002009
2010 remainder = size - bytes_read;
2011 remainder = remainder > k_ptrace_word_size ? k_ptrace_word_size : remainder;
2012
2013 // Copy the data into our buffer
2014 memcpy(dst, &data, remainder);
2015
Pavel Labatha6321a82017-01-19 15:26:04 +00002016 LLDB_LOG(log, "[{0:x}]:{1:x}", addr, data);
Kate Stoneb9c1b512016-09-06 20:57:50 +00002017 addr += k_ptrace_word_size;
2018 dst += k_ptrace_word_size;
2019 }
Mehdi Amini665be502016-11-11 05:07:57 +00002020 return Error();
Todd Fialaaf245d12014-06-30 21:05:18 +00002021}
2022
Kate Stoneb9c1b512016-09-06 20:57:50 +00002023Error NativeProcessLinux::ReadMemoryWithoutTrap(lldb::addr_t addr, void *buf,
2024 size_t size,
2025 size_t &bytes_read) {
2026 Error error = ReadMemory(addr, buf, size, bytes_read);
2027 if (error.Fail())
Pavel Labath19cbe962015-07-21 13:20:32 +00002028 return error;
Kate Stoneb9c1b512016-09-06 20:57:50 +00002029 return m_breakpoint_list.RemoveTrapsFromBuffer(addr, buf, size);
Todd Fialaaf245d12014-06-30 21:05:18 +00002030}
2031
Kate Stoneb9c1b512016-09-06 20:57:50 +00002032Error NativeProcessLinux::WriteMemory(lldb::addr_t addr, const void *buf,
2033 size_t size, size_t &bytes_written) {
2034 const unsigned char *src = static_cast<const unsigned char *>(buf);
2035 size_t remainder;
2036 Error error;
Todd Fialaaf245d12014-06-30 21:05:18 +00002037
Pavel Labatha6321a82017-01-19 15:26:04 +00002038 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_MEMORY));
2039 LLDB_LOG(log, "addr = {0}, buf = {1}, size = {2}", addr, buf, size);
Todd Fialaaf245d12014-06-30 21:05:18 +00002040
Kate Stoneb9c1b512016-09-06 20:57:50 +00002041 for (bytes_written = 0; bytes_written < size; bytes_written += remainder) {
2042 remainder = size - bytes_written;
2043 remainder = remainder > k_ptrace_word_size ? k_ptrace_word_size : remainder;
Chaoren Lin97ccc292015-02-03 01:51:12 +00002044
Kate Stoneb9c1b512016-09-06 20:57:50 +00002045 if (remainder == k_ptrace_word_size) {
2046 unsigned long data = 0;
2047 memcpy(&data, src, k_ptrace_word_size);
Todd Fialaaf245d12014-06-30 21:05:18 +00002048
Pavel Labatha6321a82017-01-19 15:26:04 +00002049 LLDB_LOG(log, "[{0:x}]:{1:x}", addr, data);
Kate Stoneb9c1b512016-09-06 20:57:50 +00002050 error = NativeProcessLinux::PtraceWrapper(PTRACE_POKEDATA, GetID(),
2051 (void *)addr, (void *)data);
Pavel Labatha6321a82017-01-19 15:26:04 +00002052 if (error.Fail())
Kate Stoneb9c1b512016-09-06 20:57:50 +00002053 return error;
Kate Stoneb9c1b512016-09-06 20:57:50 +00002054 } else {
2055 unsigned char buff[8];
2056 size_t bytes_read;
2057 error = ReadMemory(addr, buff, k_ptrace_word_size, bytes_read);
Pavel Labatha6321a82017-01-19 15:26:04 +00002058 if (error.Fail())
Kate Stoneb9c1b512016-09-06 20:57:50 +00002059 return error;
Kate Stoneb9c1b512016-09-06 20:57:50 +00002060
2061 memcpy(buff, src, remainder);
2062
2063 size_t bytes_written_rec;
2064 error = WriteMemory(addr, buff, k_ptrace_word_size, bytes_written_rec);
Pavel Labatha6321a82017-01-19 15:26:04 +00002065 if (error.Fail())
Kate Stoneb9c1b512016-09-06 20:57:50 +00002066 return error;
Kate Stoneb9c1b512016-09-06 20:57:50 +00002067
Pavel Labatha6321a82017-01-19 15:26:04 +00002068 LLDB_LOG(log, "[{0:x}]:{1:x} ({2:x})", addr, *(const unsigned long *)src,
2069 *(unsigned long *)buff);
Todd Fialaaf245d12014-06-30 21:05:18 +00002070 }
2071
Kate Stoneb9c1b512016-09-06 20:57:50 +00002072 addr += k_ptrace_word_size;
2073 src += k_ptrace_word_size;
2074 }
Kate Stoneb9c1b512016-09-06 20:57:50 +00002075 return error;
Todd Fialaaf245d12014-06-30 21:05:18 +00002076}
2077
Kate Stoneb9c1b512016-09-06 20:57:50 +00002078Error NativeProcessLinux::GetSignalInfo(lldb::tid_t tid, void *siginfo) {
2079 return PtraceWrapper(PTRACE_GETSIGINFO, tid, nullptr, siginfo);
2080}
Pavel Labath1dbc6c92015-05-12 08:35:33 +00002081
Kate Stoneb9c1b512016-09-06 20:57:50 +00002082Error NativeProcessLinux::GetEventMessage(lldb::tid_t tid,
2083 unsigned long *message) {
2084 return PtraceWrapper(PTRACE_GETEVENTMSG, tid, nullptr, message);
2085}
Pavel Labath1dbc6c92015-05-12 08:35:33 +00002086
Kate Stoneb9c1b512016-09-06 20:57:50 +00002087Error NativeProcessLinux::Detach(lldb::tid_t tid) {
2088 if (tid == LLDB_INVALID_THREAD_ID)
Mehdi Amini665be502016-11-11 05:07:57 +00002089 return Error();
Pavel Labath1dbc6c92015-05-12 08:35:33 +00002090
Kate Stoneb9c1b512016-09-06 20:57:50 +00002091 return PtraceWrapper(PTRACE_DETACH, tid);
2092}
2093
2094bool NativeProcessLinux::HasThreadNoLock(lldb::tid_t thread_id) {
2095 for (auto thread_sp : m_threads) {
2096 assert(thread_sp && "thread list should not contain NULL threads");
2097 if (thread_sp->GetID() == thread_id) {
2098 // We have this thread.
2099 return true;
Todd Fialaaf245d12014-06-30 21:05:18 +00002100 }
Kate Stoneb9c1b512016-09-06 20:57:50 +00002101 }
Todd Fialaaf245d12014-06-30 21:05:18 +00002102
Kate Stoneb9c1b512016-09-06 20:57:50 +00002103 // We don't have this thread.
2104 return false;
Todd Fialaaf245d12014-06-30 21:05:18 +00002105}
2106
Kate Stoneb9c1b512016-09-06 20:57:50 +00002107bool NativeProcessLinux::StopTrackingThread(lldb::tid_t thread_id) {
Pavel Labatha6321a82017-01-19 15:26:04 +00002108 Log *const log = ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_THREAD);
2109 LLDB_LOG(log, "tid: {0})", thread_id);
Kate Stoneb9c1b512016-09-06 20:57:50 +00002110
2111 bool found = false;
Kate Stoneb9c1b512016-09-06 20:57:50 +00002112 for (auto it = m_threads.begin(); it != m_threads.end(); ++it) {
2113 if (*it && ((*it)->GetID() == thread_id)) {
2114 m_threads.erase(it);
2115 found = true;
2116 break;
Todd Fialaaf245d12014-06-30 21:05:18 +00002117 }
Kate Stoneb9c1b512016-09-06 20:57:50 +00002118 }
Todd Fialaaf245d12014-06-30 21:05:18 +00002119
Kate Stoneb9c1b512016-09-06 20:57:50 +00002120 SignalIfAllThreadsStopped();
Kate Stoneb9c1b512016-09-06 20:57:50 +00002121 return found;
Todd Fialaaf245d12014-06-30 21:05:18 +00002122}
2123
Kate Stoneb9c1b512016-09-06 20:57:50 +00002124NativeThreadLinuxSP NativeProcessLinux::AddThread(lldb::tid_t thread_id) {
Pavel Labatha6321a82017-01-19 15:26:04 +00002125 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_THREAD));
2126 LLDB_LOG(log, "pid {0} adding thread with tid {1}", GetID(), thread_id);
Todd Fialaaf245d12014-06-30 21:05:18 +00002127
Kate Stoneb9c1b512016-09-06 20:57:50 +00002128 assert(!HasThreadNoLock(thread_id) &&
2129 "attempted to add a thread by id that already exists");
Todd Fialaaf245d12014-06-30 21:05:18 +00002130
Kate Stoneb9c1b512016-09-06 20:57:50 +00002131 // If this is the first thread, save it as the current thread
2132 if (m_threads.empty())
2133 SetCurrentThreadID(thread_id);
Todd Fialaaf245d12014-06-30 21:05:18 +00002134
Kate Stoneb9c1b512016-09-06 20:57:50 +00002135 auto thread_sp = std::make_shared<NativeThreadLinux>(this, thread_id);
2136 m_threads.push_back(thread_sp);
2137 return thread_sp;
2138}
Todd Fialaaf245d12014-06-30 21:05:18 +00002139
Kate Stoneb9c1b512016-09-06 20:57:50 +00002140Error NativeProcessLinux::FixupBreakpointPCAsNeeded(NativeThreadLinux &thread) {
Pavel Labatha6321a82017-01-19 15:26:04 +00002141 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_BREAKPOINTS));
Todd Fialaaf245d12014-06-30 21:05:18 +00002142
Kate Stoneb9c1b512016-09-06 20:57:50 +00002143 Error error;
Todd Fialaaf245d12014-06-30 21:05:18 +00002144
Kate Stoneb9c1b512016-09-06 20:57:50 +00002145 // Find out the size of a breakpoint (might depend on where we are in the
2146 // code).
2147 NativeRegisterContextSP context_sp = thread.GetRegisterContext();
2148 if (!context_sp) {
2149 error.SetErrorString("cannot get a NativeRegisterContext for the thread");
Pavel Labatha6321a82017-01-19 15:26:04 +00002150 LLDB_LOG(log, "failed: {0}", error);
Todd Fialaaf245d12014-06-30 21:05:18 +00002151 return error;
Kate Stoneb9c1b512016-09-06 20:57:50 +00002152 }
Chaoren Linfa03ad22015-02-03 01:50:42 +00002153
Kate Stoneb9c1b512016-09-06 20:57:50 +00002154 uint32_t breakpoint_size = 0;
2155 error = GetSoftwareBreakpointPCOffset(breakpoint_size);
2156 if (error.Fail()) {
Pavel Labatha6321a82017-01-19 15:26:04 +00002157 LLDB_LOG(log, "GetBreakpointSize() failed: {0}", error);
Kate Stoneb9c1b512016-09-06 20:57:50 +00002158 return error;
Pavel Labatha6321a82017-01-19 15:26:04 +00002159 } else
2160 LLDB_LOG(log, "breakpoint size: {0}", breakpoint_size);
Pavel Labathc0765592015-05-06 10:46:34 +00002161
Kate Stoneb9c1b512016-09-06 20:57:50 +00002162 // First try probing for a breakpoint at a software breakpoint location: PC -
2163 // breakpoint size.
2164 const lldb::addr_t initial_pc_addr =
2165 context_sp->GetPCfromBreakpointLocation();
2166 lldb::addr_t breakpoint_addr = initial_pc_addr;
2167 if (breakpoint_size > 0) {
2168 // Do not allow breakpoint probe to wrap around.
2169 if (breakpoint_addr >= breakpoint_size)
2170 breakpoint_addr -= breakpoint_size;
2171 }
2172
2173 // Check if we stopped because of a breakpoint.
2174 NativeBreakpointSP breakpoint_sp;
2175 error = m_breakpoint_list.GetBreakpoint(breakpoint_addr, breakpoint_sp);
2176 if (!error.Success() || !breakpoint_sp) {
2177 // We didn't find one at a software probe location. Nothing to do.
Pavel Labatha6321a82017-01-19 15:26:04 +00002178 LLDB_LOG(log,
2179 "pid {0} no lldb breakpoint found at current pc with "
2180 "adjustment: {1}",
2181 GetID(), breakpoint_addr);
Mehdi Amini665be502016-11-11 05:07:57 +00002182 return Error();
Kate Stoneb9c1b512016-09-06 20:57:50 +00002183 }
2184
2185 // If the breakpoint is not a software breakpoint, nothing to do.
2186 if (!breakpoint_sp->IsSoftwareBreakpoint()) {
Pavel Labatha6321a82017-01-19 15:26:04 +00002187 LLDB_LOG(
2188 log,
2189 "pid {0} breakpoint found at {1:x}, not software, nothing to adjust",
2190 GetID(), breakpoint_addr);
Mehdi Amini665be502016-11-11 05:07:57 +00002191 return Error();
Kate Stoneb9c1b512016-09-06 20:57:50 +00002192 }
2193
2194 //
2195 // We have a software breakpoint and need to adjust the PC.
2196 //
2197
2198 // Sanity check.
2199 if (breakpoint_size == 0) {
2200 // Nothing to do! How did we get here?
Pavel Labatha6321a82017-01-19 15:26:04 +00002201 LLDB_LOG(log,
2202 "pid {0} breakpoint found at {1:x}, it is software, but the "
2203 "size is zero, nothing to do (unexpected)",
2204 GetID(), breakpoint_addr);
Mehdi Amini665be502016-11-11 05:07:57 +00002205 return Error();
Kate Stoneb9c1b512016-09-06 20:57:50 +00002206 }
2207
2208 // Change the program counter.
Pavel Labatha6321a82017-01-19 15:26:04 +00002209 LLDB_LOG(log, "pid {0} tid {1}: changing PC from {2:x} to {3:x}", GetID(),
2210 thread.GetID(), initial_pc_addr, breakpoint_addr);
Kate Stoneb9c1b512016-09-06 20:57:50 +00002211
2212 error = context_sp->SetPC(breakpoint_addr);
2213 if (error.Fail()) {
Pavel Labatha6321a82017-01-19 15:26:04 +00002214 LLDB_LOG(log, "pid {0} tid {1}: failed to set PC: {2}", GetID(),
2215 thread.GetID(), error);
Kate Stoneb9c1b512016-09-06 20:57:50 +00002216 return error;
2217 }
2218
2219 return error;
2220}
2221
2222Error NativeProcessLinux::GetLoadedModuleFileSpec(const char *module_path,
2223 FileSpec &file_spec) {
Tamas Berghammera6f57952017-01-03 16:29:43 +00002224 Error error = PopulateMemoryRegionCache();
2225 if (error.Fail())
2226 return error;
2227
Kate Stoneb9c1b512016-09-06 20:57:50 +00002228 FileSpec module_file_spec(module_path, true);
2229
Kate Stoneb9c1b512016-09-06 20:57:50 +00002230 file_spec.Clear();
Tamas Berghammera6f57952017-01-03 16:29:43 +00002231 for (const auto &it : m_mem_region_cache) {
2232 if (it.second.GetFilename() == module_file_spec.GetFilename()) {
2233 file_spec = it.second;
2234 return Error();
2235 }
2236 }
2237 return Error("Module file (%s) not found in /proc/%" PRIu64 "/maps file!",
2238 module_file_spec.GetFilename().AsCString(), GetID());
Kate Stoneb9c1b512016-09-06 20:57:50 +00002239}
2240
2241Error NativeProcessLinux::GetFileLoadAddress(const llvm::StringRef &file_name,
2242 lldb::addr_t &load_addr) {
2243 load_addr = LLDB_INVALID_ADDRESS;
Tamas Berghammera6f57952017-01-03 16:29:43 +00002244 Error error = PopulateMemoryRegionCache();
2245 if (error.Fail())
2246 return error;
Kate Stoneb9c1b512016-09-06 20:57:50 +00002247
Tamas Berghammera6f57952017-01-03 16:29:43 +00002248 FileSpec file(file_name, false);
2249 for (const auto &it : m_mem_region_cache) {
2250 if (it.second == file) {
2251 load_addr = it.first.GetRange().GetRangeBase();
2252 return Error();
2253 }
2254 }
2255 return Error("No load address found for specified file.");
Kate Stoneb9c1b512016-09-06 20:57:50 +00002256}
2257
2258NativeThreadLinuxSP NativeProcessLinux::GetThreadByID(lldb::tid_t tid) {
2259 return std::static_pointer_cast<NativeThreadLinux>(
2260 NativeProcessProtocol::GetThreadByID(tid));
2261}
2262
2263Error NativeProcessLinux::ResumeThread(NativeThreadLinux &thread,
2264 lldb::StateType state, int signo) {
Pavel Labatha6321a82017-01-19 15:26:04 +00002265 Log *const log = ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_THREAD);
2266 LLDB_LOG(log, "tid: {0}", thread.GetID());
Kate Stoneb9c1b512016-09-06 20:57:50 +00002267
2268 // Before we do the resume below, first check if we have a pending
2269 // stop notification that is currently waiting for
2270 // all threads to stop. This is potentially a buggy situation since
2271 // we're ostensibly waiting for threads to stop before we send out the
2272 // pending notification, and here we are resuming one before we send
2273 // out the pending stop notification.
Pavel Labatha6321a82017-01-19 15:26:04 +00002274 if (m_pending_notification_tid != LLDB_INVALID_THREAD_ID) {
2275 LLDB_LOG(log,
2276 "about to resume tid {0} per explicit request but we have a "
2277 "pending stop notification (tid {1}) that is actively "
2278 "waiting for this thread to stop. Valid sequence of events?",
2279 thread.GetID(), m_pending_notification_tid);
Kate Stoneb9c1b512016-09-06 20:57:50 +00002280 }
2281
2282 // Request a resume. We expect this to be synchronous and the system
2283 // to reflect it is running after this completes.
2284 switch (state) {
2285 case eStateRunning: {
2286 const auto resume_result = thread.Resume(signo);
2287 if (resume_result.Success())
2288 SetState(eStateRunning, true);
2289 return resume_result;
2290 }
2291 case eStateStepping: {
2292 const auto step_result = thread.SingleStep(signo);
2293 if (step_result.Success())
2294 SetState(eStateRunning, true);
2295 return step_result;
2296 }
2297 default:
Pavel Labath8198db32017-01-24 11:48:25 +00002298 LLDB_LOG(log, "Unhandled state {0}.", state);
Kate Stoneb9c1b512016-09-06 20:57:50 +00002299 llvm_unreachable("Unhandled state for resume");
2300 }
Pavel Labathc0765592015-05-06 10:46:34 +00002301}
2302
2303//===----------------------------------------------------------------------===//
2304
Kate Stoneb9c1b512016-09-06 20:57:50 +00002305void NativeProcessLinux::StopRunningThreads(const lldb::tid_t triggering_tid) {
Pavel Labatha6321a82017-01-19 15:26:04 +00002306 Log *const log = ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_THREAD);
2307 LLDB_LOG(log, "about to process event: (triggering_tid: {0})",
2308 triggering_tid);
Kate Stoneb9c1b512016-09-06 20:57:50 +00002309
2310 m_pending_notification_tid = triggering_tid;
2311
2312 // Request a stop for all the thread stops that need to be stopped
2313 // and are not already known to be stopped.
2314 for (const auto &thread_sp : m_threads) {
2315 if (StateIsRunningState(thread_sp->GetState()))
2316 static_pointer_cast<NativeThreadLinux>(thread_sp)->RequestStop();
2317 }
2318
2319 SignalIfAllThreadsStopped();
Pavel Labatha6321a82017-01-19 15:26:04 +00002320 LLDB_LOG(log, "event processing done");
Kate Stoneb9c1b512016-09-06 20:57:50 +00002321}
2322
2323void NativeProcessLinux::SignalIfAllThreadsStopped() {
2324 if (m_pending_notification_tid == LLDB_INVALID_THREAD_ID)
2325 return; // No pending notification. Nothing to do.
2326
2327 for (const auto &thread_sp : m_threads) {
2328 if (StateIsRunningState(thread_sp->GetState()))
2329 return; // Some threads are still running. Don't signal yet.
2330 }
2331
2332 // We have a pending notification and all threads have stopped.
2333 Log *log(
2334 GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_BREAKPOINTS));
2335
2336 // Clear any temporary breakpoints we used to implement software single
2337 // stepping.
2338 for (const auto &thread_info : m_threads_stepping_with_breakpoint) {
2339 Error error = RemoveBreakpoint(thread_info.second);
2340 if (error.Fail())
Pavel Labatha6321a82017-01-19 15:26:04 +00002341 LLDB_LOG(log, "pid = {0} remove stepping breakpoint: {1}",
2342 thread_info.first, error);
Kate Stoneb9c1b512016-09-06 20:57:50 +00002343 }
2344 m_threads_stepping_with_breakpoint.clear();
2345
2346 // Notify the delegate about the stop
2347 SetCurrentThreadID(m_pending_notification_tid);
2348 SetState(StateType::eStateStopped, true);
2349 m_pending_notification_tid = LLDB_INVALID_THREAD_ID;
2350}
2351
2352void NativeProcessLinux::ThreadWasCreated(NativeThreadLinux &thread) {
Pavel Labatha6321a82017-01-19 15:26:04 +00002353 Log *const log = ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_THREAD);
2354 LLDB_LOG(log, "tid: {0}", thread.GetID());
Kate Stoneb9c1b512016-09-06 20:57:50 +00002355
2356 if (m_pending_notification_tid != LLDB_INVALID_THREAD_ID &&
2357 StateIsRunningState(thread.GetState())) {
2358 // We will need to wait for this new thread to stop as well before firing
2359 // the
2360 // notification.
2361 thread.RequestStop();
2362 }
2363}
2364
2365void NativeProcessLinux::SigchldHandler() {
Pavel Labatha6321a82017-01-19 15:26:04 +00002366 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PROCESS));
Kate Stoneb9c1b512016-09-06 20:57:50 +00002367 // Process all pending waitpid notifications.
2368 while (true) {
2369 int status = -1;
2370 ::pid_t wait_pid = waitpid(-1, &status, __WALL | __WNOTHREAD | WNOHANG);
2371
2372 if (wait_pid == 0)
2373 break; // We are done.
2374
2375 if (wait_pid == -1) {
2376 if (errno == EINTR)
2377 continue;
2378
2379 Error error(errno, eErrorTypePOSIX);
Pavel Labatha6321a82017-01-19 15:26:04 +00002380 LLDB_LOG(log, "waitpid (-1, &status, _) failed: {0}", error);
Kate Stoneb9c1b512016-09-06 20:57:50 +00002381 break;
Pavel Labathc0765592015-05-06 10:46:34 +00002382 }
2383
Kate Stoneb9c1b512016-09-06 20:57:50 +00002384 bool exited = false;
2385 int signal = 0;
2386 int exit_status = 0;
2387 const char *status_cstr = nullptr;
2388 if (WIFSTOPPED(status)) {
2389 signal = WSTOPSIG(status);
2390 status_cstr = "STOPPED";
2391 } else if (WIFEXITED(status)) {
2392 exit_status = WEXITSTATUS(status);
2393 status_cstr = "EXITED";
2394 exited = true;
2395 } else if (WIFSIGNALED(status)) {
2396 signal = WTERMSIG(status);
2397 status_cstr = "SIGNALED";
2398 if (wait_pid == static_cast<::pid_t>(GetID())) {
2399 exited = true;
2400 exit_status = -1;
2401 }
2402 } else
2403 status_cstr = "(\?\?\?)";
Pavel Labathc0765592015-05-06 10:46:34 +00002404
Pavel Labatha6321a82017-01-19 15:26:04 +00002405 LLDB_LOG(log,
2406 "waitpid (-1, &status, _) => pid = {0}, status = {1:x} "
2407 "({2}), signal = {3}, exit_state = {4}",
2408 wait_pid, status, status_cstr, signal, exit_status);
Pavel Labathc0765592015-05-06 10:46:34 +00002409
Kate Stoneb9c1b512016-09-06 20:57:50 +00002410 MonitorCallback(wait_pid, exited, signal, exit_status);
2411 }
Tamas Berghammer068f8a72015-05-26 11:58:52 +00002412}
2413
2414// Wrapper for ptrace to catch errors and log calls.
Kate Stoneb9c1b512016-09-06 20:57:50 +00002415// Note that ptrace sets errno on error because -1 can be a valid result (i.e.
2416// for PTRACE_PEEK*)
2417Error NativeProcessLinux::PtraceWrapper(int req, lldb::pid_t pid, void *addr,
2418 void *data, size_t data_size,
2419 long *result) {
2420 Error error;
2421 long int ret;
Tamas Berghammer068f8a72015-05-26 11:58:52 +00002422
Kate Stoneb9c1b512016-09-06 20:57:50 +00002423 Log *log(ProcessPOSIXLog::GetLogIfAllCategoriesSet(POSIX_LOG_PTRACE));
Tamas Berghammer068f8a72015-05-26 11:58:52 +00002424
Kate Stoneb9c1b512016-09-06 20:57:50 +00002425 PtraceDisplayBytes(req, data, data_size);
Tamas Berghammer068f8a72015-05-26 11:58:52 +00002426
Kate Stoneb9c1b512016-09-06 20:57:50 +00002427 errno = 0;
2428 if (req == PTRACE_GETREGSET || req == PTRACE_SETREGSET)
2429 ret = ptrace(static_cast<__ptrace_request>(req), static_cast<::pid_t>(pid),
2430 *(unsigned int *)addr, data);
2431 else
2432 ret = ptrace(static_cast<__ptrace_request>(req), static_cast<::pid_t>(pid),
2433 addr, data);
Tamas Berghammer068f8a72015-05-26 11:58:52 +00002434
Kate Stoneb9c1b512016-09-06 20:57:50 +00002435 if (ret == -1)
2436 error.SetErrorToErrno();
Tamas Berghammer068f8a72015-05-26 11:58:52 +00002437
Kate Stoneb9c1b512016-09-06 20:57:50 +00002438 if (result)
2439 *result = ret;
Pavel Labath4a9babb2015-06-30 17:04:49 +00002440
Pavel Labath28096202017-02-17 16:09:10 +00002441 LLDB_LOG(log, "ptrace({0}, {1}, {2}, {3}, {4})={5:x}", req, pid, addr, data,
2442 data_size, ret);
Tamas Berghammer068f8a72015-05-26 11:58:52 +00002443
Kate Stoneb9c1b512016-09-06 20:57:50 +00002444 PtraceDisplayBytes(req, data, data_size);
Tamas Berghammer068f8a72015-05-26 11:58:52 +00002445
Pavel Labatha6321a82017-01-19 15:26:04 +00002446 if (error.Fail())
2447 LLDB_LOG(log, "ptrace() failed: {0}", error);
Tamas Berghammer068f8a72015-05-26 11:58:52 +00002448
Kate Stoneb9c1b512016-09-06 20:57:50 +00002449 return error;
Tamas Berghammer068f8a72015-05-26 11:58:52 +00002450}