blob: be5c3b552c85b7c18a3856f860b356cee532b91c [file] [log] [blame]
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001//===-- ProcessGDBRemote.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
Eugene Zelenko0722f082015-10-24 01:28:05 +000010#include "lldb/Host/Config.h"
11
Chris Lattner30fdc8d2010-06-08 16:52:24 +000012// C Includes
13#include <errno.h>
Stephen Wilsona78867b2011-03-25 18:16:28 +000014#include <stdlib.h>
Virgile Bellob2f1fb22013-08-23 12:44:05 +000015#ifndef LLDB_DISABLE_POSIX
Sean Callanan224f6f52012-07-19 18:07:36 +000016#include <netinet/in.h>
Greg Clayton2a48f522011-05-14 01:50:35 +000017#include <sys/mman.h> // for mmap
Greg Claytonc6c420f2016-08-12 16:46:18 +000018#include <sys/socket.h>
Zachary Turnerbd22bf22016-08-12 16:52:31 +000019#endif
Chris Lattner30fdc8d2010-06-08 16:52:24 +000020#include <sys/stat.h>
Greg Clayton2a48f522011-05-14 01:50:35 +000021#include <sys/types.h>
Stephen Wilsondc916862011-03-30 00:12:40 +000022#include <time.h>
Chris Lattner30fdc8d2010-06-08 16:52:24 +000023
24// C++ Includes
25#include <algorithm>
26#include <map>
Benjamin Kramer3f69fa62015-04-03 10:55:00 +000027#include <mutex>
Pavel Labath8c1b6bd2016-08-09 12:04:46 +000028#include <sstream>
Chris Lattner30fdc8d2010-06-08 16:52:24 +000029
Johnny Chen01a67862011-10-14 00:42:25 +000030#include "lldb/Breakpoint/Watchpoint.h"
Jim Ingham40af72e2010-06-15 19:49:27 +000031#include "lldb/Interpreter/Args.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000032#include "lldb/Core/ArchSpec.h"
33#include "lldb/Core/Debugger.h"
Zachary Turner93a66fc2014-10-06 21:22:36 +000034#include "lldb/Host/ConnectionFileDescriptor.h"
Greg Clayton53239f02011-02-08 05:05:52 +000035#include "lldb/Host/FileSpec.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000036#include "lldb/Core/Module.h"
Greg Clayton1f746072012-08-29 21:13:06 +000037#include "lldb/Core/ModuleSpec.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000038#include "lldb/Core/PluginManager.h"
39#include "lldb/Core/State.h"
Greg Claytond451c1a2012-04-13 21:24:18 +000040#include "lldb/Core/StreamFile.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000041#include "lldb/Core/StreamString.h"
42#include "lldb/Core/Timer.h"
Greg Clayton70b57652011-05-15 01:25:55 +000043#include "lldb/Core/Value.h"
Greg Claytond04f0ed2015-05-26 18:00:51 +000044#include "lldb/DataFormatters/FormatManager.h"
Zachary Turner4eff2d32015-10-14 21:37:36 +000045#include "lldb/Host/FileSystem.h"
Zachary Turner39de3112014-09-09 20:54:56 +000046#include "lldb/Host/HostThread.h"
Vince Harron5275aaa2015-01-15 20:08:35 +000047#include "lldb/Host/StringConvert.h"
Jason Molendad1fae142012-09-29 08:03:33 +000048#include "lldb/Host/Symbols.h"
Zachary Turner39de3112014-09-09 20:54:56 +000049#include "lldb/Host/ThreadLauncher.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000050#include "lldb/Host/TimeValue.h"
Greg Claytond04f0ed2015-05-26 18:00:51 +000051#include "lldb/Host/XML.h"
Greg Clayton02686b82012-10-15 22:42:16 +000052#include "lldb/Interpreter/CommandInterpreter.h"
Greg Clayton1d19a2f2012-10-19 22:22:57 +000053#include "lldb/Interpreter/CommandObject.h"
54#include "lldb/Interpreter/CommandObjectMultiword.h"
Greg Clayton02686b82012-10-15 22:42:16 +000055#include "lldb/Interpreter/CommandReturnObject.h"
Zachary Turner633a29c2015-03-04 01:58:01 +000056#include "lldb/Interpreter/OptionValueProperties.h"
Greg Claytone034a042015-05-21 20:52:06 +000057#include "lldb/Interpreter/Options.h"
58#include "lldb/Interpreter/OptionGroupBoolean.h"
59#include "lldb/Interpreter/OptionGroupUInt64.h"
Zachary Turner633a29c2015-03-04 01:58:01 +000060#include "lldb/Interpreter/Property.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000061#include "lldb/Symbol/ObjectFile.h"
Jason Molenda21586c82015-09-09 03:36:24 +000062#include "lldb/Target/ABI.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000063#include "lldb/Target/DynamicLoader.h"
64#include "lldb/Target/Target.h"
65#include "lldb/Target/TargetList.h"
Greg Clayton2a48f522011-05-14 01:50:35 +000066#include "lldb/Target/ThreadPlanCallFunction.h"
Jason Molenda705b1802014-06-13 02:37:02 +000067#include "lldb/Target/SystemRuntime.h"
Greg Claytonc6c420f2016-08-12 16:46:18 +000068#include "lldb/Utility/CleanUp.h"
Jason Molendaa34a0c62010-06-09 21:28:42 +000069#include "lldb/Utility/PseudoTerminal.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000070
Eugene Zelenko0722f082015-10-24 01:28:05 +000071// Project includes
Chris Lattner30fdc8d2010-06-08 16:52:24 +000072#include "lldb/Host/Host.h"
Chaoren Lin98d0a4b2015-07-14 01:09:28 +000073#include "Plugins/Process/Utility/GDBRemoteSignals.h"
Peter Collingbourne99f9aa02011-06-03 20:40:38 +000074#include "Plugins/Process/Utility/InferiorCallPOSIX.h"
Jason Molendac42d2432012-07-25 03:40:06 +000075#include "Plugins/Process/Utility/StopInfoMachException.h"
Jim Ingham43c555d2012-07-04 00:35:43 +000076#include "Plugins/Platform/MacOSX/PlatformRemoteiOS.h"
Greg Claytonc982c762010-07-09 20:39:50 +000077#include "Utility/StringExtractorGDBRemote.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000078#include "GDBRemoteRegisterContext.h"
79#include "ProcessGDBRemote.h"
80#include "ProcessGDBRemoteLog.h"
81#include "ThreadGDBRemote.h"
Greg Claytonf4b47e12010-08-04 01:40:35 +000082
Tamas Berghammerdb264a62015-03-31 09:52:22 +000083#define DEBUGSERVER_BASENAME "debugserver"
84using namespace lldb;
85using namespace lldb_private;
86using namespace lldb_private::process_gdb_remote;
Jason Molenda5e8534e2012-10-03 01:29:34 +000087
Greg Claytonc1422c12012-04-09 22:46:21 +000088namespace lldb
89{
90 // Provide a function that can easily dump the packet history if we know a
91 // ProcessGDBRemote * value (which we can get from logs or from debugging).
92 // We need the function in the lldb namespace so it makes it into the final
93 // executable since the LLDB shared library only exports stuff in the lldb
94 // namespace. This allows you to attach with a debugger and call this
95 // function and get the packet history dumped to a file.
96 void
97 DumpProcessGDBRemotePacketHistory (void *p, const char *path)
98 {
Tamas Berghammerdb264a62015-03-31 09:52:22 +000099 StreamFile strm;
100 Error error (strm.GetFile().Open(path, File::eOpenOptionWrite | File::eOpenOptionCanCreate));
Greg Claytond451c1a2012-04-13 21:24:18 +0000101 if (error.Success())
102 ((ProcessGDBRemote *)p)->GetGDBRemote().DumpHistory (strm);
Greg Claytonc1422c12012-04-09 22:46:21 +0000103 }
Eugene Zelenko0722f082015-10-24 01:28:05 +0000104}
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000105
Greg Clayton7f982402013-07-15 22:54:20 +0000106namespace {
Steve Pucci5ec012d2014-01-16 22:18:14 +0000107
Greg Clayton7f982402013-07-15 22:54:20 +0000108 static PropertyDefinition
109 g_properties[] =
110 {
111 { "packet-timeout" , OptionValue::eTypeUInt64 , true , 1, NULL, NULL, "Specify the default packet timeout in seconds." },
Greg Claytonef8180a2013-10-15 00:14:28 +0000112 { "target-definition-file" , OptionValue::eTypeFileSpec , true, 0 , NULL, NULL, "The file that provides the description for remote target registers." },
Greg Clayton7f982402013-07-15 22:54:20 +0000113 { NULL , OptionValue::eTypeInvalid, false, 0, NULL, NULL, NULL }
114 };
Ed Maste81b4c5f2016-01-04 01:43:47 +0000115
Greg Clayton7f982402013-07-15 22:54:20 +0000116 enum
117 {
Greg Claytonef8180a2013-10-15 00:14:28 +0000118 ePropertyPacketTimeout,
119 ePropertyTargetDefinitionFile
Greg Clayton7f982402013-07-15 22:54:20 +0000120 };
Ed Maste81b4c5f2016-01-04 01:43:47 +0000121
Greg Clayton7f982402013-07-15 22:54:20 +0000122 class PluginProperties : public Properties
123 {
124 public:
Ed Maste81b4c5f2016-01-04 01:43:47 +0000125
Greg Clayton7f982402013-07-15 22:54:20 +0000126 static ConstString
127 GetSettingName ()
128 {
129 return ProcessGDBRemote::GetPluginNameStatic();
130 }
Ed Maste81b4c5f2016-01-04 01:43:47 +0000131
Greg Clayton7f982402013-07-15 22:54:20 +0000132 PluginProperties() :
133 Properties ()
134 {
135 m_collection_sp.reset (new OptionValueProperties(GetSettingName()));
136 m_collection_sp->Initialize(g_properties);
137 }
Ed Maste81b4c5f2016-01-04 01:43:47 +0000138
Eugene Zelenko0722f082015-10-24 01:28:05 +0000139 virtual
140 ~PluginProperties()
141 {
142 }
Ed Maste81b4c5f2016-01-04 01:43:47 +0000143
Greg Clayton7f982402013-07-15 22:54:20 +0000144 uint64_t
145 GetPacketTimeout()
146 {
147 const uint32_t idx = ePropertyPacketTimeout;
148 return m_collection_sp->GetPropertyAtIndexAsUInt64(NULL, idx, g_properties[idx].default_uint_value);
149 }
Greg Clayton9ac6d2d2013-10-25 18:13:17 +0000150
151 bool
152 SetPacketTimeout(uint64_t timeout)
153 {
154 const uint32_t idx = ePropertyPacketTimeout;
155 return m_collection_sp->SetPropertyAtIndexAsUInt64(NULL, idx, timeout);
156 }
157
Greg Claytonef8180a2013-10-15 00:14:28 +0000158 FileSpec
159 GetTargetDefinitionFile () const
160 {
161 const uint32_t idx = ePropertyTargetDefinitionFile;
162 return m_collection_sp->GetPropertyAtIndexAsFileSpec (NULL, idx);
163 }
Greg Clayton7f982402013-07-15 22:54:20 +0000164 };
Ed Maste81b4c5f2016-01-04 01:43:47 +0000165
Greg Clayton7f982402013-07-15 22:54:20 +0000166 typedef std::shared_ptr<PluginProperties> ProcessKDPPropertiesSP;
Ed Maste81b4c5f2016-01-04 01:43:47 +0000167
Greg Clayton7f982402013-07-15 22:54:20 +0000168 static const ProcessKDPPropertiesSP &
169 GetGlobalPluginProperties()
170 {
171 static ProcessKDPPropertiesSP g_settings_sp;
172 if (!g_settings_sp)
173 g_settings_sp.reset (new PluginProperties ());
174 return g_settings_sp;
175 }
Ed Maste81b4c5f2016-01-04 01:43:47 +0000176
Eugene Zelenko0722f082015-10-24 01:28:05 +0000177} // anonymous namespace end
Greg Clayton7f982402013-07-15 22:54:20 +0000178
Greg Claytonfda4fab2014-01-10 22:24:11 +0000179// TODO Randomly assigning a port is unsafe. We should get an unused
180// ephemeral port from the kernel and make sure we reserve it before passing
181// it to debugserver.
182
183#if defined (__APPLE__)
184#define LOW_PORT (IPPORT_RESERVED)
185#define HIGH_PORT (IPPORT_HIFIRSTAUTO)
186#else
187#define LOW_PORT (1024u)
188#define HIGH_PORT (49151u)
189#endif
190
Todd Fiala013434e2014-07-09 01:29:05 +0000191#if defined(__APPLE__) && (defined(__arm__) || defined(__arm64__) || defined(__aarch64__))
Saleem Abdulrasoola68f7b62014-03-20 06:08:36 +0000192static bool rand_initialized = false;
193
Greg Claytonfda4fab2014-01-10 22:24:11 +0000194static inline uint16_t
195get_random_port ()
196{
197 if (!rand_initialized)
198 {
199 time_t seed = time(NULL);
Saleem Abdulrasoola68f7b62014-03-20 06:08:36 +0000200
Greg Claytonfda4fab2014-01-10 22:24:11 +0000201 rand_initialized = true;
202 srand(seed);
203 }
204 return (rand() % (HIGH_PORT - LOW_PORT)) + LOW_PORT;
205}
Saleem Abdulrasoola68f7b62014-03-20 06:08:36 +0000206#endif
Greg Claytonfda4fab2014-01-10 22:24:11 +0000207
Tamas Berghammerdb264a62015-03-31 09:52:22 +0000208ConstString
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000209ProcessGDBRemote::GetPluginNameStatic()
210{
Greg Clayton57abc5d2013-05-10 21:47:16 +0000211 static ConstString g_name("gdb-remote");
212 return g_name;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000213}
214
215const char *
216ProcessGDBRemote::GetPluginDescriptionStatic()
217{
218 return "GDB Remote protocol based debugging plug-in.";
219}
220
221void
222ProcessGDBRemote::Terminate()
223{
224 PluginManager::UnregisterPlugin (ProcessGDBRemote::CreateInstance);
225}
226
Eugene Zelenko0722f082015-10-24 01:28:05 +0000227
Greg Claytonc3776bf2012-02-09 06:16:32 +0000228lldb::ProcessSP
Jim Ingham583bbb12016-03-07 21:50:25 +0000229ProcessGDBRemote::CreateInstance (lldb::TargetSP target_sp, ListenerSP listener_sp, const FileSpec *crash_file_path)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000230{
Greg Claytonc3776bf2012-02-09 06:16:32 +0000231 lldb::ProcessSP process_sp;
232 if (crash_file_path == NULL)
Jim Ingham583bbb12016-03-07 21:50:25 +0000233 process_sp.reset (new ProcessGDBRemote (target_sp, listener_sp));
Greg Claytonc3776bf2012-02-09 06:16:32 +0000234 return process_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000235}
236
237bool
Zachary Turner7529df92015-09-01 20:02:29 +0000238ProcessGDBRemote::CanDebug (lldb::TargetSP target_sp, bool plugin_specified_by_name)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000239{
Greg Clayton596ed242011-10-21 21:41:45 +0000240 if (plugin_specified_by_name)
241 return true;
242
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000243 // For now we are just making sure the file exists for a given module
Zachary Turner7529df92015-09-01 20:02:29 +0000244 Module *exe_module = target_sp->GetExecutableModulePointer();
Greg Claytonaa149cb2011-08-11 02:48:45 +0000245 if (exe_module)
Greg Claytonc3776bf2012-02-09 06:16:32 +0000246 {
247 ObjectFile *exe_objfile = exe_module->GetObjectFile();
248 // We can't debug core files...
249 switch (exe_objfile->GetType())
250 {
251 case ObjectFile::eTypeInvalid:
252 case ObjectFile::eTypeCoreFile:
253 case ObjectFile::eTypeDebugInfo:
254 case ObjectFile::eTypeObjectFile:
255 case ObjectFile::eTypeSharedLibrary:
256 case ObjectFile::eTypeStubLibrary:
Greg Clayton23f8c952014-03-24 23:10:19 +0000257 case ObjectFile::eTypeJIT:
Greg Claytonc3776bf2012-02-09 06:16:32 +0000258 return false;
259 case ObjectFile::eTypeExecutable:
260 case ObjectFile::eTypeDynamicLinker:
261 case ObjectFile::eTypeUnknown:
262 break;
263 }
Greg Claytonaa149cb2011-08-11 02:48:45 +0000264 return exe_module->GetFileSpec().Exists();
Greg Claytonc3776bf2012-02-09 06:16:32 +0000265 }
Jim Ingham5aee1622010-08-09 23:31:02 +0000266 // However, if there is no executable module, we return true since we might be preparing to attach.
267 return true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000268}
269
Eugene Zelenko0722f082015-10-24 01:28:05 +0000270//----------------------------------------------------------------------
271// ProcessGDBRemote constructor
272//----------------------------------------------------------------------
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +0000273ProcessGDBRemote::ProcessGDBRemote(lldb::TargetSP target_sp, ListenerSP listener_sp)
274 : Process(target_sp, listener_sp),
275 m_flags(0),
276 m_gdb_comm(),
277 m_debugserver_pid(LLDB_INVALID_PROCESS_ID),
278 m_last_stop_packet_mutex(),
279 m_register_info(),
280 m_async_broadcaster(NULL, "lldb.process.gdb-remote.async-broadcaster"),
281 m_async_listener_sp(Listener::MakeListener("lldb.process.gdb-remote.async-listener")),
282 m_async_thread_state_mutex(),
283 m_thread_ids(),
284 m_thread_pcs(),
285 m_jstopinfo_sp(),
286 m_jthreadsinfo_sp(),
287 m_continue_c_tids(),
288 m_continue_C_tids(),
289 m_continue_s_tids(),
290 m_continue_S_tids(),
291 m_max_memory_size(0),
292 m_remote_stub_max_memory_size(0),
293 m_addr_to_mmap_size(),
294 m_thread_create_bp_sp(),
295 m_waiting_for_attach(false),
296 m_destroy_tried_resuming(false),
297 m_command_sp(),
298 m_breakpoint_pc_offset(0),
299 m_initial_tid(LLDB_INVALID_THREAD_ID)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000300{
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +0000301 m_async_broadcaster.SetEventName(eBroadcastBitAsyncThreadShouldExit, "async thread should exit");
302 m_async_broadcaster.SetEventName(eBroadcastBitAsyncContinue, "async thread continue");
303 m_async_broadcaster.SetEventName(eBroadcastBitAsyncThreadDidExit, "async thread did exit");
Pavel Labath50556852015-09-03 09:36:22 +0000304
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +0000305 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_ASYNC));
Pavel Labath50556852015-09-03 09:36:22 +0000306
307 const uint32_t async_event_mask = eBroadcastBitAsyncContinue | eBroadcastBitAsyncThreadShouldExit;
308
Jim Ingham583bbb12016-03-07 21:50:25 +0000309 if (m_async_listener_sp->StartListeningForEvents(&m_async_broadcaster, async_event_mask) != async_event_mask)
Pavel Labath50556852015-09-03 09:36:22 +0000310 {
311 if (log)
312 log->Printf("ProcessGDBRemote::%s failed to listen for m_async_broadcaster events", __FUNCTION__);
313 }
314
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +0000315 const uint32_t gdb_event_mask =
316 Communication::eBroadcastBitReadThreadDidExit | GDBRemoteCommunication::eBroadcastBitGdbReadThreadGotNotify;
Jim Ingham583bbb12016-03-07 21:50:25 +0000317 if (m_async_listener_sp->StartListeningForEvents(&m_gdb_comm, gdb_event_mask) != gdb_event_mask)
Pavel Labath50556852015-09-03 09:36:22 +0000318 {
319 if (log)
320 log->Printf("ProcessGDBRemote::%s failed to listen for m_gdb_comm events", __FUNCTION__);
321 }
322
Greg Clayton7f982402013-07-15 22:54:20 +0000323 const uint64_t timeout_seconds = GetGlobalPluginProperties()->GetPacketTimeout();
324 if (timeout_seconds > 0)
325 m_gdb_comm.SetPacketTimeout(timeout_seconds);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000326}
327
Eugene Zelenko0722f082015-10-24 01:28:05 +0000328//----------------------------------------------------------------------
329// Destructor
330//----------------------------------------------------------------------
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000331ProcessGDBRemote::~ProcessGDBRemote()
332{
333 // m_mach_process.UnregisterNotificationCallbacks (this);
334 Clear();
Greg Clayton1ed54f52011-10-01 00:45:15 +0000335 // We need to call finalize on the process before destroying ourselves
336 // to make sure all of the broadcaster cleanup goes as planned. If we
337 // destruct this class, then Process::~Process() might have problems
338 // trying to fully destroy the broadcaster.
339 Finalize();
Ed Maste81b4c5f2016-01-04 01:43:47 +0000340
Jim Ingham455fa5c2012-11-01 01:15:33 +0000341 // The general Finalize is going to try to destroy the process and that SHOULD
342 // shut down the async thread. However, if we don't kill it it will get stranded and
343 // its connection will go away so when it wakes up it will crash. So kill it for sure here.
344 StopAsyncThread();
345 KillDebugserverProcess();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000346}
347
348//----------------------------------------------------------------------
349// PluginInterface
350//----------------------------------------------------------------------
Greg Clayton57abc5d2013-05-10 21:47:16 +0000351ConstString
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000352ProcessGDBRemote::GetPluginName()
353{
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000354 return GetPluginNameStatic();
355}
356
357uint32_t
358ProcessGDBRemote::GetPluginVersion()
359{
360 return 1;
361}
362
Greg Claytonef8180a2013-10-15 00:14:28 +0000363bool
364ProcessGDBRemote::ParsePythonTargetDefinition(const FileSpec &target_definition_fspec)
365{
366 ScriptInterpreter *interpreter = GetTarget().GetDebugger().GetCommandInterpreter().GetScriptInterpreter();
367 Error error;
Zachary Turner0641ca12015-03-17 20:04:04 +0000368 StructuredData::ObjectSP module_object_sp(interpreter->LoadPluginModule(target_definition_fspec, error));
Greg Claytonef8180a2013-10-15 00:14:28 +0000369 if (module_object_sp)
370 {
Zachary Turner0641ca12015-03-17 20:04:04 +0000371 StructuredData::DictionarySP target_definition_sp(
372 interpreter->GetDynamicSettings(module_object_sp, &GetTarget(), "gdb-server-target-definition", error));
Greg Claytonef8180a2013-10-15 00:14:28 +0000373
Zachary Turner0641ca12015-03-17 20:04:04 +0000374 if (target_definition_sp)
Greg Claytonef8180a2013-10-15 00:14:28 +0000375 {
Zachary Turner0641ca12015-03-17 20:04:04 +0000376 StructuredData::ObjectSP target_object(target_definition_sp->GetValueForKey("host-info"));
377 if (target_object)
Greg Clayton312bcbe2013-10-17 01:10:23 +0000378 {
Zachary Turner0641ca12015-03-17 20:04:04 +0000379 if (auto host_info_dict = target_object->GetAsDictionary())
Greg Clayton312bcbe2013-10-17 01:10:23 +0000380 {
Zachary Turner0641ca12015-03-17 20:04:04 +0000381 StructuredData::ObjectSP triple_value = host_info_dict->GetValueForKey("triple");
382 if (auto triple_string_value = triple_value->GetAsString())
383 {
384 std::string triple_string = triple_string_value->GetValue();
385 ArchSpec host_arch(triple_string.c_str());
386 if (!host_arch.IsCompatibleMatch(GetTarget().GetArchitecture()))
387 {
388 GetTarget().SetArchitecture(host_arch);
389 }
390 }
Greg Clayton312bcbe2013-10-17 01:10:23 +0000391 }
Greg Clayton312bcbe2013-10-17 01:10:23 +0000392 }
Zachary Turner0641ca12015-03-17 20:04:04 +0000393 m_breakpoint_pc_offset = 0;
394 StructuredData::ObjectSP breakpoint_pc_offset_value = target_definition_sp->GetValueForKey("breakpoint-pc-offset");
395 if (breakpoint_pc_offset_value)
396 {
397 if (auto breakpoint_pc_int_value = breakpoint_pc_offset_value->GetAsInteger())
398 m_breakpoint_pc_offset = breakpoint_pc_int_value->GetValue();
399 }
Hafiz Abid Qadeer85a4daf2013-10-18 10:04:33 +0000400
Greg Claytond04f0ed2015-05-26 18:00:51 +0000401 if (m_register_info.SetRegisterInfo(*target_definition_sp, GetTarget().GetArchitecture()) > 0)
Greg Claytonef8180a2013-10-15 00:14:28 +0000402 {
403 return true;
404 }
405 }
406 }
407 return false;
408}
409
Jason Molenda21586c82015-09-09 03:36:24 +0000410// If the remote stub didn't give us eh_frame or DWARF register numbers for a register,
411// see if the ABI can provide them.
412// DWARF and eh_frame register numbers are defined as a part of the ABI.
413static void
414AugmentRegisterInfoViaABI (RegisterInfo &reg_info, ConstString reg_name, ABISP abi_sp)
415{
416 if (reg_info.kinds[eRegisterKindEHFrame] == LLDB_INVALID_REGNUM
417 || reg_info.kinds[eRegisterKindDWARF] == LLDB_INVALID_REGNUM)
418 {
419 if (abi_sp)
420 {
421 RegisterInfo abi_reg_info;
422 if (abi_sp->GetRegisterInfoByName (reg_name, abi_reg_info))
423 {
Greg Claytonb1583dc2015-12-04 18:37:48 +0000424 if (reg_info.kinds[eRegisterKindEHFrame] == LLDB_INVALID_REGNUM &&
425 abi_reg_info.kinds[eRegisterKindEHFrame] != LLDB_INVALID_REGNUM)
Jason Molenda21586c82015-09-09 03:36:24 +0000426 {
427 reg_info.kinds[eRegisterKindEHFrame] = abi_reg_info.kinds[eRegisterKindEHFrame];
428 }
Greg Claytonb1583dc2015-12-04 18:37:48 +0000429 if (reg_info.kinds[eRegisterKindDWARF] == LLDB_INVALID_REGNUM &&
430 abi_reg_info.kinds[eRegisterKindDWARF] != LLDB_INVALID_REGNUM)
Jason Molenda21586c82015-09-09 03:36:24 +0000431 {
432 reg_info.kinds[eRegisterKindDWARF] = abi_reg_info.kinds[eRegisterKindDWARF];
433 }
Greg Claytonb1583dc2015-12-04 18:37:48 +0000434 if (reg_info.kinds[eRegisterKindGeneric] == LLDB_INVALID_REGNUM &&
435 abi_reg_info.kinds[eRegisterKindGeneric] != LLDB_INVALID_REGNUM)
436 {
437 reg_info.kinds[eRegisterKindGeneric] = abi_reg_info.kinds[eRegisterKindGeneric];
438 }
Jason Molenda21586c82015-09-09 03:36:24 +0000439 }
440 }
441 }
442}
443
Greg Claytond04f0ed2015-05-26 18:00:51 +0000444static size_t
445SplitCommaSeparatedRegisterNumberString(const llvm::StringRef &comma_separated_regiter_numbers, std::vector<uint32_t> &regnums, int base)
446{
447 regnums.clear();
448 std::pair<llvm::StringRef, llvm::StringRef> value_pair;
449 value_pair.second = comma_separated_regiter_numbers;
450 do
451 {
452 value_pair = value_pair.second.split(',');
453 if (!value_pair.first.empty())
454 {
455 uint32_t reg = StringConvert::ToUInt32 (value_pair.first.str().c_str(), LLDB_INVALID_REGNUM, base);
456 if (reg != LLDB_INVALID_REGNUM)
457 regnums.push_back (reg);
458 }
459 } while (!value_pair.second.empty());
460 return regnums.size();
461}
462
Eugene Zelenko0722f082015-10-24 01:28:05 +0000463
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000464void
Greg Clayton513c26c2011-01-29 07:10:55 +0000465ProcessGDBRemote::BuildDynamicRegisterInfo (bool force)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000466{
Greg Clayton513c26c2011-01-29 07:10:55 +0000467 if (!force && m_register_info.GetNumRegisters() > 0)
468 return;
469
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000470 m_register_info.Clear();
Greg Claytond04f0ed2015-05-26 18:00:51 +0000471
472 // Check if qHostInfo specified a specific packet timeout for this connection.
473 // If so then lets update our setting so the user knows what the timeout is
474 // and can see it.
475 const uint32_t host_packet_timeout = m_gdb_comm.GetHostDefaultPacketTimeout();
476 if (host_packet_timeout)
477 {
478 GetGlobalPluginProperties()->SetPacketTimeout(host_packet_timeout);
479 }
480
Ed Maste81b4c5f2016-01-04 01:43:47 +0000481 // Register info search order:
Ewan Crawford0c996a92015-06-30 13:08:44 +0000482 // 1 - Use the target definition python file if one is specified.
483 // 2 - If the target definition doesn't have any of the info from the target.xml (registers) then proceed to read the target.xml.
484 // 3 - Fall back on the qRegisterInfo packets.
485
486 FileSpec target_definition_fspec = GetGlobalPluginProperties()->GetTargetDefinitionFile ();
Jason Molenda91e468c2015-08-20 04:29:46 +0000487 if (!target_definition_fspec.Exists())
488 {
489 // If the filename doesn't exist, it may be a ~ not having been expanded - try to resolve it.
490 target_definition_fspec.ResolvePath();
491 }
Ewan Crawford0c996a92015-06-30 13:08:44 +0000492 if (target_definition_fspec)
493 {
494 // See if we can get register definitions from a python file
495 if (ParsePythonTargetDefinition (target_definition_fspec))
Jason Molenda5543abb2015-08-20 03:05:09 +0000496 {
Ewan Crawford0c996a92015-06-30 13:08:44 +0000497 return;
Jason Molenda5543abb2015-08-20 03:05:09 +0000498 }
499 else
500 {
501 StreamSP stream_sp = GetTarget().GetDebugger().GetAsyncOutputStream();
502 stream_sp->Printf ("ERROR: target description file %s failed to parse.\n", target_definition_fspec.GetPath().c_str());
503 }
Ewan Crawford0c996a92015-06-30 13:08:44 +0000504 }
505
Jim Ingham7b71c0b2016-02-18 23:58:45 +0000506 const ArchSpec &target_arch = GetTarget().GetArchitecture();
507 const ArchSpec &remote_host_arch = m_gdb_comm.GetHostArchitecture();
508 const ArchSpec &remote_process_arch = m_gdb_comm.GetProcessArchitecture();
509
510 // Use the process' architecture instead of the host arch, if available
511 ArchSpec arch_to_use;
512 if (remote_process_arch.IsValid ())
513 arch_to_use = remote_process_arch;
514 else
515 arch_to_use = remote_host_arch;
516
517 if (!arch_to_use.IsValid())
518 arch_to_use = target_arch;
519
520 if (GetGDBServerRegisterInfo (arch_to_use))
Greg Claytond04f0ed2015-05-26 18:00:51 +0000521 return;
Ed Maste81b4c5f2016-01-04 01:43:47 +0000522
Greg Claytond04f0ed2015-05-26 18:00:51 +0000523 char packet[128];
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000524 uint32_t reg_offset = 0;
525 uint32_t reg_num = 0;
Greg Clayton23f59502012-07-17 03:23:13 +0000526 for (StringExtractorGDBRemote::ResponseType response_type = StringExtractorGDBRemote::eResponse;
Ed Maste81b4c5f2016-01-04 01:43:47 +0000527 response_type == StringExtractorGDBRemote::eResponse;
Greg Clayton576d8832011-03-22 04:00:09 +0000528 ++reg_num)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000529 {
Greg Clayton513c26c2011-01-29 07:10:55 +0000530 const int packet_len = ::snprintf (packet, sizeof(packet), "qRegisterInfo%x", reg_num);
Andy Gibbsa297a972013-06-19 19:04:53 +0000531 assert (packet_len < (int)sizeof(packet));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000532 StringExtractorGDBRemote response;
Greg Clayton3dedae12013-12-06 21:45:27 +0000533 if (m_gdb_comm.SendPacketAndWaitForResponse(packet, packet_len, response, false) == GDBRemoteCommunication::PacketResult::Success)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000534 {
Greg Clayton576d8832011-03-22 04:00:09 +0000535 response_type = response.GetResponseType();
536 if (response_type == StringExtractorGDBRemote::eResponse)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000537 {
538 std::string name;
539 std::string value;
540 ConstString reg_name;
541 ConstString alt_name;
542 ConstString set_name;
Greg Claytonce1ffcf2013-01-21 22:17:50 +0000543 std::vector<uint32_t> value_regs;
544 std::vector<uint32_t> invalidate_regs;
Nitesh Jain52b6cc52016-08-01 13:45:51 +0000545 std::vector<uint8_t> dwarf_opcode_bytes;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000546 RegisterInfo reg_info = { NULL, // Name
547 NULL, // Alt name
548 0, // byte size
549 reg_offset, // offset
550 eEncodingUint, // encoding
Jason Molendabf67a302015-09-01 05:17:01 +0000551 eFormatHex, // format
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000552 {
Jason Molendabf67a302015-09-01 05:17:01 +0000553 LLDB_INVALID_REGNUM, // eh_frame reg num
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000554 LLDB_INVALID_REGNUM, // DWARF reg num
555 LLDB_INVALID_REGNUM, // generic reg num
Jason Molenda63bd0db2015-09-15 23:20:34 +0000556 reg_num, // process plugin reg num
Jason Molendafbcb7f22010-09-10 07:49:16 +0000557 reg_num // native register number
Greg Clayton435d85a2012-02-29 19:27:27 +0000558 },
559 NULL,
Nitesh Jain52b6cc52016-08-01 13:45:51 +0000560 NULL,
561 NULL, // Dwarf expression opcode bytes pointer
562 0 // Dwarf expression opcode bytes length
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000563 };
564
565 while (response.GetNameColonValue(name, value))
566 {
567 if (name.compare("name") == 0)
568 {
569 reg_name.SetCString(value.c_str());
570 }
571 else if (name.compare("alt-name") == 0)
572 {
573 alt_name.SetCString(value.c_str());
574 }
575 else if (name.compare("bitsize") == 0)
576 {
Vince Harron5275aaa2015-01-15 20:08:35 +0000577 reg_info.byte_size = StringConvert::ToUInt32(value.c_str(), 0, 0) / CHAR_BIT;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000578 }
579 else if (name.compare("offset") == 0)
580 {
Vince Harron5275aaa2015-01-15 20:08:35 +0000581 uint32_t offset = StringConvert::ToUInt32(value.c_str(), UINT32_MAX, 0);
Jason Molenda743e86a2010-06-11 23:44:18 +0000582 if (reg_offset != offset)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000583 {
584 reg_offset = offset;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000585 }
586 }
587 else if (name.compare("encoding") == 0)
588 {
Greg Clayton2443cbd2012-08-24 01:42:50 +0000589 const Encoding encoding = Args::StringToEncoding (value.c_str());
590 if (encoding != eEncodingInvalid)
591 reg_info.encoding = encoding;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000592 }
593 else if (name.compare("format") == 0)
594 {
Greg Clayton2443cbd2012-08-24 01:42:50 +0000595 Format format = eFormatInvalid;
596 if (Args::StringToFormat (value.c_str(), format, NULL).Success())
597 reg_info.format = format;
598 else if (value.compare("binary") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000599 reg_info.format = eFormatBinary;
600 else if (value.compare("decimal") == 0)
601 reg_info.format = eFormatDecimal;
602 else if (value.compare("hex") == 0)
603 reg_info.format = eFormatHex;
604 else if (value.compare("float") == 0)
605 reg_info.format = eFormatFloat;
606 else if (value.compare("vector-sint8") == 0)
607 reg_info.format = eFormatVectorOfSInt8;
608 else if (value.compare("vector-uint8") == 0)
609 reg_info.format = eFormatVectorOfUInt8;
610 else if (value.compare("vector-sint16") == 0)
611 reg_info.format = eFormatVectorOfSInt16;
612 else if (value.compare("vector-uint16") == 0)
613 reg_info.format = eFormatVectorOfUInt16;
614 else if (value.compare("vector-sint32") == 0)
615 reg_info.format = eFormatVectorOfSInt32;
616 else if (value.compare("vector-uint32") == 0)
617 reg_info.format = eFormatVectorOfUInt32;
618 else if (value.compare("vector-float32") == 0)
619 reg_info.format = eFormatVectorOfFloat32;
620 else if (value.compare("vector-uint128") == 0)
621 reg_info.format = eFormatVectorOfUInt128;
622 }
623 else if (name.compare("set") == 0)
624 {
625 set_name.SetCString(value.c_str());
626 }
Jason Molendaa18f7072015-08-15 01:21:01 +0000627 else if (name.compare("gcc") == 0 || name.compare("ehframe") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000628 {
Jason Molendaa18f7072015-08-15 01:21:01 +0000629 reg_info.kinds[eRegisterKindEHFrame] = StringConvert::ToUInt32(value.c_str(), LLDB_INVALID_REGNUM, 0);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000630 }
631 else if (name.compare("dwarf") == 0)
632 {
Vince Harron5275aaa2015-01-15 20:08:35 +0000633 reg_info.kinds[eRegisterKindDWARF] = StringConvert::ToUInt32(value.c_str(), LLDB_INVALID_REGNUM, 0);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000634 }
635 else if (name.compare("generic") == 0)
636 {
Greg Clayton2443cbd2012-08-24 01:42:50 +0000637 reg_info.kinds[eRegisterKindGeneric] = Args::StringToGenericRegister (value.c_str());
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000638 }
Greg Claytonce1ffcf2013-01-21 22:17:50 +0000639 else if (name.compare("container-regs") == 0)
640 {
Greg Claytond04f0ed2015-05-26 18:00:51 +0000641 SplitCommaSeparatedRegisterNumberString(value, value_regs, 16);
Greg Claytonce1ffcf2013-01-21 22:17:50 +0000642 }
643 else if (name.compare("invalidate-regs") == 0)
644 {
Greg Claytond04f0ed2015-05-26 18:00:51 +0000645 SplitCommaSeparatedRegisterNumberString(value, invalidate_regs, 16);
Greg Claytonce1ffcf2013-01-21 22:17:50 +0000646 }
Nitesh Jain52b6cc52016-08-01 13:45:51 +0000647 else if (name.compare("dynamic_size_dwarf_expr_bytes") == 0)
648 {
649 size_t dwarf_opcode_len = value.length () / 2;
650 assert (dwarf_opcode_len > 0);
651
652 dwarf_opcode_bytes.resize (dwarf_opcode_len);
653 StringExtractor opcode_extractor;
654 reg_info.dynamic_size_dwarf_len = dwarf_opcode_len;
655
656 // Swap "value" over into "opcode_extractor"
657 opcode_extractor.GetStringRef ().swap (value);
658 uint32_t ret_val = opcode_extractor.GetHexBytesAvail (dwarf_opcode_bytes.data (),
659 dwarf_opcode_len);
660 assert (dwarf_opcode_len == ret_val);
661
662 reg_info.dynamic_size_dwarf_expr_bytes = dwarf_opcode_bytes.data ();
663 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000664 }
665
Jason Molenda743e86a2010-06-11 23:44:18 +0000666 reg_info.byte_offset = reg_offset;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000667 assert (reg_info.byte_size != 0);
668 reg_offset += reg_info.byte_size;
Greg Claytonce1ffcf2013-01-21 22:17:50 +0000669 if (!value_regs.empty())
670 {
671 value_regs.push_back(LLDB_INVALID_REGNUM);
672 reg_info.value_regs = value_regs.data();
673 }
674 if (!invalidate_regs.empty())
675 {
676 invalidate_regs.push_back(LLDB_INVALID_REGNUM);
677 reg_info.invalidate_regs = invalidate_regs.data();
678 }
679
Jim Ingham7b71c0b2016-02-18 23:58:45 +0000680 // We have to make a temporary ABI here, and not use the GetABI because this code
681 // gets called in DidAttach, when the target architecture (and consequently the ABI we'll get from
682 // the process) may be wrong.
683 ABISP abi_to_use = ABI::FindPlugin(arch_to_use);
684
685 AugmentRegisterInfoViaABI (reg_info, reg_name, abi_to_use);
Jason Molenda21586c82015-09-09 03:36:24 +0000686
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000687 m_register_info.AddRegister(reg_info, reg_name, alt_name, set_name);
688 }
Todd Fiala1a634402014-01-08 07:52:40 +0000689 else
690 {
691 break; // ensure exit before reg_num is incremented
692 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000693 }
694 else
695 {
Greg Clayton32e0a752011-03-30 18:16:51 +0000696 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000697 }
698 }
699
Greg Claytond04f0ed2015-05-26 18:00:51 +0000700 if (m_register_info.GetNumRegisters() > 0)
Greg Clayton9ac6d2d2013-10-25 18:13:17 +0000701 {
Greg Claytond04f0ed2015-05-26 18:00:51 +0000702 m_register_info.Finalize(GetTarget().GetArchitecture());
703 return;
Greg Clayton9ac6d2d2013-10-25 18:13:17 +0000704 }
Greg Clayton9ac6d2d2013-10-25 18:13:17 +0000705
Johnny Chen2fa9de12012-05-14 18:44:23 +0000706 // We didn't get anything if the accumulated reg_num is zero. See if we are
707 // debugging ARM and fill with a hard coded register set until we can get an
708 // updated debugserver down on the devices.
709 // On the other hand, if the accumulated reg_num is positive, see if we can
710 // add composite registers to the existing primordial ones.
Greg Claytond04f0ed2015-05-26 18:00:51 +0000711 bool from_scratch = (m_register_info.GetNumRegisters() == 0);
Johnny Chen2fa9de12012-05-14 18:44:23 +0000712
Johnny Chen2fa9de12012-05-14 18:44:23 +0000713 if (!target_arch.IsValid())
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000714 {
Jim Ingham7b71c0b2016-02-18 23:58:45 +0000715 if (arch_to_use.IsValid()
716 && (arch_to_use.GetMachine() == llvm::Triple::arm || arch_to_use.GetMachine() == llvm::Triple::thumb)
717 && arch_to_use.GetTriple().getVendor() == llvm::Triple::Apple)
Johnny Chen2fa9de12012-05-14 18:44:23 +0000718 m_register_info.HardcodeARMRegisters(from_scratch);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000719 }
Jason Molenda6d9fe8c2015-08-21 00:13:37 +0000720 else if (target_arch.GetMachine() == llvm::Triple::arm
721 || target_arch.GetMachine() == llvm::Triple::thumb)
Johnny Chen2fa9de12012-05-14 18:44:23 +0000722 {
723 m_register_info.HardcodeARMRegisters(from_scratch);
724 }
725
726 // At this point, we can finalize our register info.
Greg Claytond04f0ed2015-05-26 18:00:51 +0000727 m_register_info.Finalize (GetTarget().GetArchitecture());
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000728}
729
730Error
731ProcessGDBRemote::WillLaunch (Module* module)
732{
733 return WillLaunchOrAttach ();
734}
735
736Error
Greg Clayton3af9ea52010-11-18 05:57:03 +0000737ProcessGDBRemote::WillAttachToProcessWithID (lldb::pid_t pid)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000738{
739 return WillLaunchOrAttach ();
740}
741
742Error
Greg Clayton3af9ea52010-11-18 05:57:03 +0000743ProcessGDBRemote::WillAttachToProcessWithName (const char *process_name, bool wait_for_launch)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000744{
745 return WillLaunchOrAttach ();
746}
747
748Error
Jason Molenda4bd4e7e2012-09-29 04:02:01 +0000749ProcessGDBRemote::DoConnectRemote (Stream *strm, const char *remote_url)
Greg Claytonb766a732011-02-04 01:58:07 +0000750{
Todd Fialaaf245d12014-06-30 21:05:18 +0000751 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
Greg Claytonb766a732011-02-04 01:58:07 +0000752 Error error (WillLaunchOrAttach ());
Ed Maste81b4c5f2016-01-04 01:43:47 +0000753
Greg Claytonb766a732011-02-04 01:58:07 +0000754 if (error.Fail())
755 return error;
756
Greg Clayton2289fa42011-04-30 01:09:13 +0000757 error = ConnectToDebugserver (remote_url);
Greg Claytonb766a732011-02-04 01:58:07 +0000758
759 if (error.Fail())
760 return error;
761 StartAsyncThread ();
762
Greg Claytonc574ede2011-03-10 02:26:48 +0000763 lldb::pid_t pid = m_gdb_comm.GetCurrentProcessID ();
Greg Claytonb766a732011-02-04 01:58:07 +0000764 if (pid == LLDB_INVALID_PROCESS_ID)
765 {
766 // We don't have a valid process ID, so note that we are connected
Ed Maste81b4c5f2016-01-04 01:43:47 +0000767 // and could now request to launch or attach, or get remote process
Greg Claytonb766a732011-02-04 01:58:07 +0000768 // listings...
769 SetPrivateState (eStateConnected);
770 }
771 else
772 {
773 // We have a valid process
774 SetID (pid);
Greg Clayton56d9a1b2011-08-22 02:49:39 +0000775 GetThreadList();
Ewan Crawford9aa2da002015-05-27 14:12:34 +0000776 StringExtractorGDBRemote response;
777 if (m_gdb_comm.GetStopReply(response))
Greg Claytonb766a732011-02-04 01:58:07 +0000778 {
Ewan Crawford9aa2da002015-05-27 14:12:34 +0000779 SetLastStopPacket(response);
Ewan Crawford78baa192015-05-13 09:18:18 +0000780
781 // '?' Packets must be handled differently in non-stop mode
782 if (GetTarget().GetNonStopModeEnabled())
783 HandleStopReplySequence();
784
Zachary Turner7529df92015-09-01 20:02:29 +0000785 Target &target = GetTarget();
Ed Maste81b4c5f2016-01-04 01:43:47 +0000786 if (!target.GetArchitecture().IsValid())
Jason Molendac62bd7b2013-12-21 05:20:36 +0000787 {
788 if (m_gdb_comm.GetProcessArchitecture().IsValid())
789 {
Zachary Turner7529df92015-09-01 20:02:29 +0000790 target.SetArchitecture(m_gdb_comm.GetProcessArchitecture());
Jason Molendac62bd7b2013-12-21 05:20:36 +0000791 }
792 else
793 {
Zachary Turner7529df92015-09-01 20:02:29 +0000794 target.SetArchitecture(m_gdb_comm.GetHostArchitecture());
Jason Molendac62bd7b2013-12-21 05:20:36 +0000795 }
Carlo Kok74389122013-10-14 07:09:13 +0000796 }
797
Ewan Crawford9aa2da002015-05-27 14:12:34 +0000798 const StateType state = SetThreadStopInfo (response);
Greg Clayton2e309072015-07-17 23:42:28 +0000799 if (state != eStateInvalid)
Greg Claytonb766a732011-02-04 01:58:07 +0000800 {
801 SetPrivateState (state);
802 }
803 else
Daniel Malead01b2952012-11-29 21:49:15 +0000804 error.SetErrorStringWithFormat ("Process %" PRIu64 " was reported after connecting to '%s', but state was not stopped: %s", pid, remote_url, StateAsCString (state));
Greg Claytonb766a732011-02-04 01:58:07 +0000805 }
806 else
Daniel Malead01b2952012-11-29 21:49:15 +0000807 error.SetErrorStringWithFormat ("Process %" PRIu64 " was reported after connecting to '%s', but no stop reply packet was received", pid, remote_url);
Greg Claytonb766a732011-02-04 01:58:07 +0000808 }
Jason Molenda16d127c2012-05-03 22:37:30 +0000809
Todd Fialaaf245d12014-06-30 21:05:18 +0000810 if (log)
811 log->Printf ("ProcessGDBRemote::%s pid %" PRIu64 ": normalizing target architecture initial triple: %s (GetTarget().GetArchitecture().IsValid() %s, m_gdb_comm.GetHostArchitecture().IsValid(): %s)", __FUNCTION__, GetID (), GetTarget ().GetArchitecture ().GetTriple ().getTriple ().c_str (), GetTarget ().GetArchitecture ().IsValid () ? "true" : "false", m_gdb_comm.GetHostArchitecture ().IsValid () ? "true" : "false");
812
813
814 if (error.Success()
Jason Molenda16d127c2012-05-03 22:37:30 +0000815 && !GetTarget().GetArchitecture().IsValid()
816 && m_gdb_comm.GetHostArchitecture().IsValid())
817 {
Jason Molendaf17b5ac2012-12-19 02:54:03 +0000818 // Prefer the *process'* architecture over that of the *host*, if available.
819 if (m_gdb_comm.GetProcessArchitecture().IsValid())
820 GetTarget().SetArchitecture(m_gdb_comm.GetProcessArchitecture());
821 else
822 GetTarget().SetArchitecture(m_gdb_comm.GetHostArchitecture());
Jason Molenda16d127c2012-05-03 22:37:30 +0000823 }
824
Todd Fialaaf245d12014-06-30 21:05:18 +0000825 if (log)
826 log->Printf ("ProcessGDBRemote::%s pid %" PRIu64 ": normalized target architecture triple: %s", __FUNCTION__, GetID (), GetTarget ().GetArchitecture ().GetTriple ().getTriple ().c_str ());
827
Chaoren Lin98d0a4b2015-07-14 01:09:28 +0000828 if (error.Success())
Jaydeep Patil6fc590d2015-07-30 05:06:51 +0000829 {
830 PlatformSP platform_sp = GetTarget().GetPlatform();
831 if (platform_sp && platform_sp->IsConnected())
832 SetUnixSignals(platform_sp->GetUnixSignals());
833 else
834 SetUnixSignals(UnixSignals::Create(GetTarget().GetArchitecture()));
835 }
Todd Fialaaf245d12014-06-30 21:05:18 +0000836
Greg Claytonb766a732011-02-04 01:58:07 +0000837 return error;
838}
839
840Error
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000841ProcessGDBRemote::WillLaunchOrAttach ()
842{
843 Error error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000844 m_stdio_communication.Clear ();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000845 return error;
846}
847
848//----------------------------------------------------------------------
849// Process Control
850//----------------------------------------------------------------------
851Error
Jean-Daniel Dupas7782de92013-12-09 22:52:50 +0000852ProcessGDBRemote::DoLaunch (Module *exe_module, ProcessLaunchInfo &launch_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000853{
Todd Fiala75f47c32014-10-11 21:42:09 +0000854 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
Greg Clayton4957bf62010-09-30 21:49:03 +0000855 Error error;
Greg Clayton982c9762011-11-03 21:22:33 +0000856
Todd Fiala75f47c32014-10-11 21:42:09 +0000857 if (log)
858 log->Printf ("ProcessGDBRemote::%s() entered", __FUNCTION__);
859
Greg Clayton982c9762011-11-03 21:22:33 +0000860 uint32_t launch_flags = launch_info.GetFlags().Get();
Chaoren Lind3173f32015-05-29 19:52:29 +0000861 FileSpec stdin_file_spec{};
862 FileSpec stdout_file_spec{};
863 FileSpec stderr_file_spec{};
864 FileSpec working_dir = launch_info.GetWorkingDirectory();
Greg Clayton982c9762011-11-03 21:22:33 +0000865
Zachary Turner696b5282014-08-14 16:01:25 +0000866 const FileAction *file_action;
Greg Clayton982c9762011-11-03 21:22:33 +0000867 file_action = launch_info.GetFileActionForFD (STDIN_FILENO);
868 if (file_action)
869 {
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000870 if (file_action->GetAction() == FileAction::eFileActionOpen)
Chaoren Lind3173f32015-05-29 19:52:29 +0000871 stdin_file_spec = file_action->GetFileSpec();
Greg Clayton982c9762011-11-03 21:22:33 +0000872 }
873 file_action = launch_info.GetFileActionForFD (STDOUT_FILENO);
874 if (file_action)
875 {
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000876 if (file_action->GetAction() == FileAction::eFileActionOpen)
Chaoren Lind3173f32015-05-29 19:52:29 +0000877 stdout_file_spec = file_action->GetFileSpec();
Greg Clayton982c9762011-11-03 21:22:33 +0000878 }
879 file_action = launch_info.GetFileActionForFD (STDERR_FILENO);
880 if (file_action)
881 {
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000882 if (file_action->GetAction() == FileAction::eFileActionOpen)
Chaoren Lind3173f32015-05-29 19:52:29 +0000883 stderr_file_spec = file_action->GetFileSpec();
Greg Clayton982c9762011-11-03 21:22:33 +0000884 }
885
Todd Fiala75f47c32014-10-11 21:42:09 +0000886 if (log)
887 {
Chaoren Lind3173f32015-05-29 19:52:29 +0000888 if (stdin_file_spec || stdout_file_spec || stderr_file_spec)
Vince Harron4a8abd32015-02-13 19:15:24 +0000889 log->Printf ("ProcessGDBRemote::%s provided with STDIO paths via launch_info: stdin=%s, stdout=%s, stderr=%s",
Todd Fiala75f47c32014-10-11 21:42:09 +0000890 __FUNCTION__,
Chaoren Lind3173f32015-05-29 19:52:29 +0000891 stdin_file_spec ? stdin_file_spec.GetCString() : "<null>",
892 stdout_file_spec ? stdout_file_spec.GetCString() : "<null>",
893 stderr_file_spec ? stderr_file_spec.GetCString() : "<null>");
Todd Fiala75f47c32014-10-11 21:42:09 +0000894 else
895 log->Printf ("ProcessGDBRemote::%s no STDIO paths given via launch_info", __FUNCTION__);
896 }
897
Vince Harrondf3f00f2015-02-10 21:09:04 +0000898 const bool disable_stdio = (launch_flags & eLaunchFlagDisableSTDIO) != 0;
Chaoren Lind3173f32015-05-29 19:52:29 +0000899 if (stdin_file_spec || disable_stdio)
Vince Harrondf3f00f2015-02-10 21:09:04 +0000900 {
901 // the inferior will be reading stdin from the specified file
902 // or stdio is completely disabled
903 m_stdin_forward = false;
904 }
905 else
906 {
907 m_stdin_forward = true;
908 }
909
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000910 // ::LogSetBitMask (GDBR_LOG_DEFAULT);
911 // ::LogSetOptions (LLDB_LOG_OPTION_THREADSAFE | LLDB_LOG_OPTION_PREPEND_TIMESTAMP | LLDB_LOG_OPTION_PREPEND_PROC_AND_THREAD);
912 // ::LogSetLogFile ("/dev/stdout");
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000913
Greg Clayton982c9762011-11-03 21:22:33 +0000914 ObjectFile * object_file = exe_module->GetObjectFile();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000915 if (object_file)
916 {
Oleksiy Vyalovafd6ce42015-11-23 19:32:24 +0000917 error = EstablishConnectionIfNeeded (launch_info);
Greg Clayton71337622011-02-24 22:24:29 +0000918 if (error.Success())
919 {
920 lldb_utility::PseudoTerminal pty;
921 const bool disable_stdio = (launch_flags & eLaunchFlagDisableSTDIO) != 0;
Greg Clayton5f2a4f92011-03-02 21:34:46 +0000922
Zachary Turner7529df92015-09-01 20:02:29 +0000923 PlatformSP platform_sp (GetTarget().GetPlatform());
Vince Harrondf3f00f2015-02-10 21:09:04 +0000924 if (disable_stdio)
Greg Clayton71337622011-02-24 22:24:29 +0000925 {
Vince Harrondf3f00f2015-02-10 21:09:04 +0000926 // set to /dev/null unless redirected to a file above
Chaoren Lind3173f32015-05-29 19:52:29 +0000927 if (!stdin_file_spec)
Zachary Turner4eff2d32015-10-14 21:37:36 +0000928 stdin_file_spec.SetFile(FileSystem::DEV_NULL, false);
Chaoren Lind3173f32015-05-29 19:52:29 +0000929 if (!stdout_file_spec)
Zachary Turner4eff2d32015-10-14 21:37:36 +0000930 stdout_file_spec.SetFile(FileSystem::DEV_NULL, false);
Chaoren Lind3173f32015-05-29 19:52:29 +0000931 if (!stderr_file_spec)
Zachary Turner4eff2d32015-10-14 21:37:36 +0000932 stderr_file_spec.SetFile(FileSystem::DEV_NULL, false);
Vince Harrondf3f00f2015-02-10 21:09:04 +0000933 }
934 else if (platform_sp && platform_sp->IsHost())
935 {
936 // If the debugserver is local and we aren't disabling STDIO, lets use
937 // a pseudo terminal to instead of relying on the 'O' packets for stdio
938 // since 'O' packets can really slow down debugging if the inferior
939 // does a lot of output.
Chaoren Lind3173f32015-05-29 19:52:29 +0000940 if ((!stdin_file_spec || !stdout_file_spec || !stderr_file_spec) &&
941 pty.OpenFirstAvailableMaster(O_RDWR|O_NOCTTY, NULL, 0))
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000942 {
Chaoren Lind3173f32015-05-29 19:52:29 +0000943 FileSpec slave_name{pty.GetSlaveName(NULL, 0), false};
944
945 if (!stdin_file_spec)
946 stdin_file_spec = slave_name;
947
948 if (!stdout_file_spec)
949 stdout_file_spec = slave_name;
950
951 if (!stderr_file_spec)
952 stderr_file_spec = slave_name;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000953 }
Todd Fiala75f47c32014-10-11 21:42:09 +0000954 if (log)
Vince Harron4a8abd32015-02-13 19:15:24 +0000955 log->Printf ("ProcessGDBRemote::%s adjusted STDIO paths for local platform (IsHost() is true) using slave: stdin=%s, stdout=%s, stderr=%s",
Todd Fiala75f47c32014-10-11 21:42:09 +0000956 __FUNCTION__,
Chaoren Lind3173f32015-05-29 19:52:29 +0000957 stdin_file_spec ? stdin_file_spec.GetCString() : "<null>",
958 stdout_file_spec ? stdout_file_spec.GetCString() : "<null>",
959 stderr_file_spec ? stderr_file_spec.GetCString() : "<null>");
Greg Clayton71337622011-02-24 22:24:29 +0000960 }
961
Todd Fiala75f47c32014-10-11 21:42:09 +0000962 if (log)
Vince Harron4a8abd32015-02-13 19:15:24 +0000963 log->Printf ("ProcessGDBRemote::%s final STDIO paths after all adjustments: stdin=%s, stdout=%s, stderr=%s",
Todd Fiala75f47c32014-10-11 21:42:09 +0000964 __FUNCTION__,
Chaoren Lind3173f32015-05-29 19:52:29 +0000965 stdin_file_spec ? stdin_file_spec.GetCString() : "<null>",
966 stdout_file_spec ? stdout_file_spec.GetCString() : "<null>",
967 stderr_file_spec ? stderr_file_spec.GetCString() : "<null>");
Todd Fiala75f47c32014-10-11 21:42:09 +0000968
Chaoren Lind3173f32015-05-29 19:52:29 +0000969 if (stdin_file_spec)
970 m_gdb_comm.SetSTDIN(stdin_file_spec);
971 if (stdout_file_spec)
972 m_gdb_comm.SetSTDOUT(stdout_file_spec);
973 if (stderr_file_spec)
974 m_gdb_comm.SetSTDERR(stderr_file_spec);
Greg Clayton71337622011-02-24 22:24:29 +0000975
976 m_gdb_comm.SetDisableASLR (launch_flags & eLaunchFlagDisableASLR);
Jim Ingham106d0282014-06-25 02:32:56 +0000977 m_gdb_comm.SetDetachOnError (launch_flags & eLaunchFlagDetachOnError);
Greg Clayton71337622011-02-24 22:24:29 +0000978
Zachary Turner7529df92015-09-01 20:02:29 +0000979 m_gdb_comm.SendLaunchArchPacket (GetTarget().GetArchitecture().GetArchitectureName());
Ed Maste81b4c5f2016-01-04 01:43:47 +0000980
Jason Molendaa3329782014-03-29 18:54:20 +0000981 const char * launch_event_data = launch_info.GetLaunchEventData();
982 if (launch_event_data != NULL && *launch_event_data != '\0')
983 m_gdb_comm.SendLaunchEventDataPacket (launch_event_data);
Ed Maste81b4c5f2016-01-04 01:43:47 +0000984
Chaoren Lind3173f32015-05-29 19:52:29 +0000985 if (working_dir)
Greg Clayton71337622011-02-24 22:24:29 +0000986 {
987 m_gdb_comm.SetWorkingDir (working_dir);
988 }
989
990 // Send the environment and the program + arguments after we connect
Greg Clayton982c9762011-11-03 21:22:33 +0000991 const Args &environment = launch_info.GetEnvironmentEntries();
992 if (environment.GetArgumentCount())
Greg Clayton71337622011-02-24 22:24:29 +0000993 {
Greg Clayton982c9762011-11-03 21:22:33 +0000994 size_t num_environment_entries = environment.GetArgumentCount();
995 for (size_t i=0; i<num_environment_entries; ++i)
Greg Claytonb0b9fe62010-08-03 00:35:52 +0000996 {
Greg Clayton982c9762011-11-03 21:22:33 +0000997 const char *env_entry = environment.GetArgumentAtIndex(i);
998 if (env_entry == NULL || m_gdb_comm.SendEnvironmentPacket(env_entry) != 0)
Greg Clayton71337622011-02-24 22:24:29 +0000999 break;
Greg Claytonb0b9fe62010-08-03 00:35:52 +00001000 }
Greg Clayton71337622011-02-24 22:24:29 +00001001 }
Greg Claytonb0b9fe62010-08-03 00:35:52 +00001002
Greg Clayton71337622011-02-24 22:24:29 +00001003 {
Tamas Berghammer912800c2015-02-24 10:23:39 +00001004 // Scope for the scoped timeout object
1005 GDBRemoteCommunication::ScopedTimeout timeout (m_gdb_comm, 10);
1006
1007 int arg_packet_err = m_gdb_comm.SendArgumentsPacket (launch_info);
1008 if (arg_packet_err == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001009 {
Tamas Berghammer912800c2015-02-24 10:23:39 +00001010 std::string error_str;
1011 if (m_gdb_comm.GetLaunchSuccess (error_str))
1012 {
1013 SetID (m_gdb_comm.GetCurrentProcessID ());
1014 }
1015 else
1016 {
1017 error.SetErrorString (error_str.c_str());
1018 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001019 }
1020 else
1021 {
Tamas Berghammer912800c2015-02-24 10:23:39 +00001022 error.SetErrorStringWithFormat("'A' packet returned an error: %i", arg_packet_err);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001023 }
Greg Clayton71337622011-02-24 22:24:29 +00001024 }
Tamas Berghammer912800c2015-02-24 10:23:39 +00001025
Greg Clayton71337622011-02-24 22:24:29 +00001026 if (GetID() == LLDB_INVALID_PROCESS_ID)
1027 {
Johnny Chen4c1e9202011-08-09 18:56:45 +00001028 if (log)
1029 log->Printf("failed to connect to debugserver: %s", error.AsCString());
Greg Clayton71337622011-02-24 22:24:29 +00001030 KillDebugserverProcess ();
1031 return error;
1032 }
1033
Ewan Crawford9aa2da002015-05-27 14:12:34 +00001034 StringExtractorGDBRemote response;
1035 if (m_gdb_comm.GetStopReply(response))
Greg Clayton71337622011-02-24 22:24:29 +00001036 {
Ewan Crawford9aa2da002015-05-27 14:12:34 +00001037 SetLastStopPacket(response);
Ewan Crawford78baa192015-05-13 09:18:18 +00001038 // '?' Packets must be handled differently in non-stop mode
1039 if (GetTarget().GetNonStopModeEnabled())
1040 HandleStopReplySequence();
1041
Tamas Berghammere9f4dfe2015-03-13 10:32:42 +00001042 const ArchSpec &process_arch = m_gdb_comm.GetProcessArchitecture();
1043
1044 if (process_arch.IsValid())
Jason Molendac62bd7b2013-12-21 05:20:36 +00001045 {
Zachary Turner7529df92015-09-01 20:02:29 +00001046 GetTarget().MergeArchitecture(process_arch);
Tamas Berghammere9f4dfe2015-03-13 10:32:42 +00001047 }
1048 else
1049 {
1050 const ArchSpec &host_arch = m_gdb_comm.GetHostArchitecture();
1051 if (host_arch.IsValid())
Zachary Turner7529df92015-09-01 20:02:29 +00001052 GetTarget().MergeArchitecture(host_arch);
Carlo Kok74389122013-10-14 07:09:13 +00001053 }
1054
Ewan Crawford9aa2da002015-05-27 14:12:34 +00001055 SetPrivateState (SetThreadStopInfo (response));
Ed Maste81b4c5f2016-01-04 01:43:47 +00001056
Greg Clayton71337622011-02-24 22:24:29 +00001057 if (!disable_stdio)
1058 {
1059 if (pty.GetMasterFileDescriptor() != lldb_utility::PseudoTerminal::invalid_fd)
Greg Claytonee95ed52011-11-17 22:14:31 +00001060 SetSTDIOFileDescriptor (pty.ReleaseMasterFileDescriptor());
Greg Clayton71337622011-02-24 22:24:29 +00001061 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001062 }
1063 }
Greg Claytonc235ac72011-08-09 05:20:29 +00001064 else
1065 {
Johnny Chen4c1e9202011-08-09 18:56:45 +00001066 if (log)
1067 log->Printf("failed to connect to debugserver: %s", error.AsCString());
Greg Claytonc235ac72011-08-09 05:20:29 +00001068 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001069 }
1070 else
1071 {
1072 // Set our user ID to an invalid process ID.
1073 SetID(LLDB_INVALID_PROCESS_ID);
Ed Maste81b4c5f2016-01-04 01:43:47 +00001074 error.SetErrorStringWithFormat ("failed to get object file from '%s' for arch %s",
1075 exe_module->GetFileSpec().GetFilename().AsCString(),
Greg Clayton982c9762011-11-03 21:22:33 +00001076 exe_module->GetArchitecture().GetArchitectureName());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001077 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001078 return error;
Eugene Zelenko0722f082015-10-24 01:28:05 +00001079
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001080}
1081
Eugene Zelenko0722f082015-10-24 01:28:05 +00001082
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001083Error
Greg Claytonb766a732011-02-04 01:58:07 +00001084ProcessGDBRemote::ConnectToDebugserver (const char *connect_url)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001085{
1086 Error error;
Greg Clayton00fe87b2013-12-05 22:58:22 +00001087 // Only connect if we have a valid connect URL
Vince Harron1b5a74e2015-01-21 22:42:49 +00001088 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Ed Maste81b4c5f2016-01-04 01:43:47 +00001089
Greg Clayton00fe87b2013-12-05 22:58:22 +00001090 if (connect_url && connect_url[0])
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001091 {
Vince Harron1b5a74e2015-01-21 22:42:49 +00001092 if (log)
1093 log->Printf("ProcessGDBRemote::%s Connecting to %s", __FUNCTION__, connect_url);
Greg Clayton00fe87b2013-12-05 22:58:22 +00001094 std::unique_ptr<ConnectionFileDescriptor> conn_ap(new ConnectionFileDescriptor());
1095 if (conn_ap.get())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001096 {
Greg Clayton00fe87b2013-12-05 22:58:22 +00001097 const uint32_t max_retry_count = 50;
1098 uint32_t retry_count = 0;
1099 while (!m_gdb_comm.IsConnected())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001100 {
Greg Clayton00fe87b2013-12-05 22:58:22 +00001101 if (conn_ap->Connect(connect_url, &error) == eConnectionStatusSuccess)
1102 {
1103 m_gdb_comm.SetConnection (conn_ap.release());
1104 break;
1105 }
1106 else if (error.WasInterrupted())
1107 {
1108 // If we were interrupted, don't keep retrying.
1109 break;
1110 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001111
Greg Clayton00fe87b2013-12-05 22:58:22 +00001112 retry_count++;
Ed Maste81b4c5f2016-01-04 01:43:47 +00001113
Greg Clayton00fe87b2013-12-05 22:58:22 +00001114 if (retry_count >= max_retry_count)
1115 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001116
Greg Clayton00fe87b2013-12-05 22:58:22 +00001117 usleep (100000);
1118 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001119 }
1120 }
1121
1122 if (!m_gdb_comm.IsConnected())
1123 {
1124 if (error.Success())
1125 error.SetErrorString("not connected to remote gdb server");
1126 return error;
1127 }
1128
Eugene Zelenko0722f082015-10-24 01:28:05 +00001129
Ewan Crawfordfab40d32015-06-16 15:50:18 +00001130 // Start the communications read thread so all incoming data can be
1131 // parsed into packets and queued as they arrive.
1132 if (GetTarget().GetNonStopModeEnabled())
1133 m_gdb_comm.StartReadThread();
1134
Greg Clayton32e0a752011-03-30 18:16:51 +00001135 // We always seem to be able to open a connection to a local port
1136 // so we need to make sure we can then send data to it. If we can't
1137 // then we aren't actually connected to anything, so try and do the
Ed Maste81b4c5f2016-01-04 01:43:47 +00001138 // handshake with the remote GDB server and make sure that goes
Greg Clayton32e0a752011-03-30 18:16:51 +00001139 // alright.
Greg Claytonfb909312013-11-23 01:58:15 +00001140 if (!m_gdb_comm.HandshakeWithServer (&error))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001141 {
Greg Clayton32e0a752011-03-30 18:16:51 +00001142 m_gdb_comm.Disconnect();
1143 if (error.Success())
1144 error.SetErrorString("not connected to remote gdb server");
1145 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001146 }
Ewan Crawford78baa192015-05-13 09:18:18 +00001147
1148 // Send $QNonStop:1 packet on startup if required
1149 if (GetTarget().GetNonStopModeEnabled())
Ewan Crawfordaa7eda72015-06-24 15:14:26 +00001150 GetTarget().SetNonStopModeEnabled (m_gdb_comm.SetNonStopMode(true));
Ewan Crawford78baa192015-05-13 09:18:18 +00001151
Greg Claytonb30c50c2015-05-29 00:01:55 +00001152 m_gdb_comm.GetEchoSupported ();
Greg Clayton32e0a752011-03-30 18:16:51 +00001153 m_gdb_comm.GetThreadSuffixSupported ();
Greg Clayton44633992012-04-10 03:22:03 +00001154 m_gdb_comm.GetListThreadsInStopReplySupported ();
Greg Clayton32e0a752011-03-30 18:16:51 +00001155 m_gdb_comm.GetHostInfo ();
1156 m_gdb_comm.GetVContSupported ('c');
Jim Inghamcd16df92012-07-20 21:37:13 +00001157 m_gdb_comm.GetVAttachOrWaitSupported();
Ewan Crawford78baa192015-05-13 09:18:18 +00001158
1159 // Ask the remote server for the default thread id
1160 if (GetTarget().GetNonStopModeEnabled())
1161 m_gdb_comm.GetDefaultThreadId(m_initial_tid);
1162
1163
Jim Ingham03afad82012-07-02 05:40:07 +00001164 size_t num_cmds = GetExtraStartupCommands().GetArgumentCount();
1165 for (size_t idx = 0; idx < num_cmds; idx++)
1166 {
1167 StringExtractorGDBRemote response;
Jim Ingham03afad82012-07-02 05:40:07 +00001168 m_gdb_comm.SendPacketAndWaitForResponse (GetExtraStartupCommands().GetArgumentAtIndex(idx), response, false);
1169 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001170 return error;
1171}
1172
1173void
Jim Inghambb006ce2014-08-02 00:33:35 +00001174ProcessGDBRemote::DidLaunchOrAttach (ArchSpec& process_arch)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001175{
Greg Clayton5160ce52013-03-27 23:08:40 +00001176 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
Greg Clayton6d093452011-02-05 02:25:06 +00001177 if (log)
Todd Fiala75930012016-08-19 04:21:48 +00001178 log->Printf ("ProcessGDBRemote::%s()", __FUNCTION__);
Greg Clayton93d3c8332011-02-16 04:46:07 +00001179 if (GetID() != LLDB_INVALID_PROCESS_ID)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001180 {
Greg Clayton513c26c2011-01-29 07:10:55 +00001181 BuildDynamicRegisterInfo (false);
Greg Clayton3af9ea52010-11-18 05:57:03 +00001182
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001183 // See if the GDB server supports the qHostInfo information
Greg Clayton0d0c12a2011-02-09 03:09:55 +00001184
Jason Molendaf17b5ac2012-12-19 02:54:03 +00001185
1186 // See if the GDB server supports the qProcessInfo packet, if so
1187 // prefer that over the Host information as it will be more specific
1188 // to our process.
1189
Todd Fiala75f47c32014-10-11 21:42:09 +00001190 const ArchSpec &remote_process_arch = m_gdb_comm.GetProcessArchitecture();
1191 if (remote_process_arch.IsValid())
1192 {
1193 process_arch = remote_process_arch;
1194 if (log)
1195 log->Printf ("ProcessGDBRemote::%s gdb-remote had process architecture, using %s %s",
1196 __FUNCTION__,
1197 process_arch.GetArchitectureName () ? process_arch.GetArchitectureName () : "<null>",
1198 process_arch.GetTriple().getTriple ().c_str() ? process_arch.GetTriple().getTriple ().c_str() : "<null>");
1199 }
Jim Inghambb006ce2014-08-02 00:33:35 +00001200 else
Todd Fiala75f47c32014-10-11 21:42:09 +00001201 {
Jim Inghambb006ce2014-08-02 00:33:35 +00001202 process_arch = m_gdb_comm.GetHostArchitecture();
Todd Fiala75f47c32014-10-11 21:42:09 +00001203 if (log)
1204 log->Printf ("ProcessGDBRemote::%s gdb-remote did not have process architecture, using gdb-remote host architecture %s %s",
1205 __FUNCTION__,
1206 process_arch.GetArchitectureName () ? process_arch.GetArchitectureName () : "<null>",
1207 process_arch.GetTriple().getTriple ().c_str() ? process_arch.GetTriple().getTriple ().c_str() : "<null>");
1208 }
Jason Molendaf17b5ac2012-12-19 02:54:03 +00001209
Jim Inghambb006ce2014-08-02 00:33:35 +00001210 if (process_arch.IsValid())
Greg Clayton0d0c12a2011-02-09 03:09:55 +00001211 {
Tamas Berghammere724af12015-03-13 10:32:37 +00001212 const ArchSpec &target_arch = GetTarget().GetArchitecture();
Greg Claytond314e812011-03-23 00:09:55 +00001213 if (target_arch.IsValid())
1214 {
Todd Fiala75f47c32014-10-11 21:42:09 +00001215 if (log)
1216 log->Printf ("ProcessGDBRemote::%s analyzing target arch, currently %s %s",
1217 __FUNCTION__,
1218 target_arch.GetArchitectureName () ? target_arch.GetArchitectureName () : "<null>",
1219 target_arch.GetTriple().getTriple ().c_str() ? target_arch.GetTriple().getTriple ().c_str() : "<null>");
1220
1221 // If the remote host is ARM and we have apple as the vendor, then
Greg Claytond314e812011-03-23 00:09:55 +00001222 // ARM executables and shared libraries can have mixed ARM architectures.
1223 // You can have an armv6 executable, and if the host is armv7, then the
1224 // system will load the best possible architecture for all shared libraries
1225 // it has, so we really need to take the remote host architecture as our
1226 // defacto architecture in this case.
1227
Jason Molenda6d9fe8c2015-08-21 00:13:37 +00001228 if ((process_arch.GetMachine() == llvm::Triple::arm || process_arch.GetMachine() == llvm::Triple::thumb)
1229 && process_arch.GetTriple().getVendor() == llvm::Triple::Apple)
Greg Claytond314e812011-03-23 00:09:55 +00001230 {
Jason Molenda921c01b2014-08-03 21:42:52 +00001231 GetTarget().SetArchitecture (process_arch);
Todd Fiala75f47c32014-10-11 21:42:09 +00001232 if (log)
1233 log->Printf ("ProcessGDBRemote::%s remote process is ARM/Apple, setting target arch to %s %s",
1234 __FUNCTION__,
1235 process_arch.GetArchitectureName () ? process_arch.GetArchitectureName () : "<null>",
1236 process_arch.GetTriple().getTriple ().c_str() ? process_arch.GetTriple().getTriple ().c_str() : "<null>");
Greg Claytond314e812011-03-23 00:09:55 +00001237 }
1238 else
1239 {
1240 // Fill in what is missing in the triple
Jim Inghambb006ce2014-08-02 00:33:35 +00001241 const llvm::Triple &remote_triple = process_arch.GetTriple();
Tamas Berghammere724af12015-03-13 10:32:37 +00001242 llvm::Triple new_target_triple = target_arch.GetTriple();
1243 if (new_target_triple.getVendorName().size() == 0)
Greg Clayton70b57652011-05-15 01:25:55 +00001244 {
Tamas Berghammere724af12015-03-13 10:32:37 +00001245 new_target_triple.setVendor (remote_triple.getVendor());
Greg Claytond314e812011-03-23 00:09:55 +00001246
Tamas Berghammere724af12015-03-13 10:32:37 +00001247 if (new_target_triple.getOSName().size() == 0)
Greg Clayton70b57652011-05-15 01:25:55 +00001248 {
Tamas Berghammere724af12015-03-13 10:32:37 +00001249 new_target_triple.setOS (remote_triple.getOS());
Greg Claytond314e812011-03-23 00:09:55 +00001250
Tamas Berghammere724af12015-03-13 10:32:37 +00001251 if (new_target_triple.getEnvironmentName().size() == 0)
1252 new_target_triple.setEnvironment (remote_triple.getEnvironment());
Greg Clayton70b57652011-05-15 01:25:55 +00001253 }
Todd Fiala75f47c32014-10-11 21:42:09 +00001254
Tamas Berghammere724af12015-03-13 10:32:37 +00001255 ArchSpec new_target_arch = target_arch;
1256 new_target_arch.SetTriple(new_target_triple);
1257 GetTarget().SetArchitecture(new_target_arch);
1258 }
Greg Claytond314e812011-03-23 00:09:55 +00001259 }
Todd Fiala75f47c32014-10-11 21:42:09 +00001260
1261 if (log)
1262 log->Printf ("ProcessGDBRemote::%s final target arch after adjustments for remote architecture: %s %s",
1263 __FUNCTION__,
1264 target_arch.GetArchitectureName () ? target_arch.GetArchitectureName () : "<null>",
1265 target_arch.GetTriple().getTriple ().c_str() ? target_arch.GetTriple().getTriple ().c_str() : "<null>");
Greg Claytond314e812011-03-23 00:09:55 +00001266 }
1267 else
1268 {
1269 // The target doesn't have a valid architecture yet, set it from
1270 // the architecture we got from the remote GDB server
Jason Molenda921c01b2014-08-03 21:42:52 +00001271 GetTarget().SetArchitecture (process_arch);
Greg Claytond314e812011-03-23 00:09:55 +00001272 }
Greg Clayton0d0c12a2011-02-09 03:09:55 +00001273 }
Todd Fiala75930012016-08-19 04:21:48 +00001274
1275 // Find out which StructuredDataPlugins are supported by the
1276 // debug monitor. These plugins transmit data over async $J packets.
1277 auto supported_packets_array =
1278 m_gdb_comm.GetSupportedStructuredDataPlugins();
1279 if (supported_packets_array)
1280 MapSupportedStructuredDataPlugins(*supported_packets_array);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001281 }
1282}
1283
1284void
1285ProcessGDBRemote::DidLaunch ()
1286{
Jim Inghambb006ce2014-08-02 00:33:35 +00001287 ArchSpec process_arch;
1288 DidLaunchOrAttach (process_arch);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001289}
1290
1291Error
Han Ming Ong84647042012-02-25 01:07:38 +00001292ProcessGDBRemote::DoAttachToProcessWithID (lldb::pid_t attach_pid, const ProcessAttachInfo &attach_info)
1293{
Todd Fiala75f47c32014-10-11 21:42:09 +00001294 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001295 Error error;
Todd Fiala75f47c32014-10-11 21:42:09 +00001296
1297 if (log)
1298 log->Printf ("ProcessGDBRemote::%s()", __FUNCTION__);
1299
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001300 // Clear out and clean up from any current state
1301 Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001302 if (attach_pid != LLDB_INVALID_PROCESS_ID)
1303 {
Oleksiy Vyalovafd6ce42015-11-23 19:32:24 +00001304 error = EstablishConnectionIfNeeded (attach_info);
Greg Clayton71337622011-02-24 22:24:29 +00001305 if (error.Success())
1306 {
Jim Ingham106d0282014-06-25 02:32:56 +00001307 m_gdb_comm.SetDetachOnError(attach_info.GetDetachOnError());
Todd Fiala75f47c32014-10-11 21:42:09 +00001308
Greg Clayton71337622011-02-24 22:24:29 +00001309 char packet[64];
Daniel Malead01b2952012-11-29 21:49:15 +00001310 const int packet_len = ::snprintf (packet, sizeof(packet), "vAttach;%" PRIx64, attach_pid);
Ed Maste81b4c5f2016-01-04 01:43:47 +00001311 SetID (attach_pid);
Greg Clayton71337622011-02-24 22:24:29 +00001312 m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncContinue, new EventDataBytes (packet, packet_len));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001313 }
Oleksiy Vyalovafd6ce42015-11-23 19:32:24 +00001314 else
1315 SetExitStatus (-1, error.AsCString());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001316 }
Todd Fiala75f47c32014-10-11 21:42:09 +00001317
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001318 return error;
1319}
1320
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001321Error
Jean-Daniel Dupas9c517c02013-12-23 22:32:54 +00001322ProcessGDBRemote::DoAttachToProcessWithName (const char *process_name, const ProcessAttachInfo &attach_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001323{
1324 Error error;
1325 // Clear out and clean up from any current state
1326 Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001327
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001328 if (process_name && process_name[0])
1329 {
Oleksiy Vyalovafd6ce42015-11-23 19:32:24 +00001330 error = EstablishConnectionIfNeeded (attach_info);
Greg Clayton71337622011-02-24 22:24:29 +00001331 if (error.Success())
1332 {
1333 StreamString packet;
Ed Maste81b4c5f2016-01-04 01:43:47 +00001334
Jim Ingham106d0282014-06-25 02:32:56 +00001335 m_gdb_comm.SetDetachOnError(attach_info.GetDetachOnError());
Ed Maste81b4c5f2016-01-04 01:43:47 +00001336
Jean-Daniel Dupas9c517c02013-12-23 22:32:54 +00001337 if (attach_info.GetWaitForLaunch())
Jim Inghamcd16df92012-07-20 21:37:13 +00001338 {
1339 if (!m_gdb_comm.GetVAttachOrWaitSupported())
1340 {
1341 packet.PutCString ("vAttachWait");
1342 }
1343 else
1344 {
1345 if (attach_info.GetIgnoreExisting())
1346 packet.PutCString("vAttachWait");
1347 else
1348 packet.PutCString ("vAttachOrWait");
1349 }
1350 }
Greg Clayton71337622011-02-24 22:24:29 +00001351 else
1352 packet.PutCString("vAttachName");
1353 packet.PutChar(';');
Bruce Mitchener9ccb9702015-11-07 04:40:13 +00001354 packet.PutBytesAsRawHex8(process_name, strlen(process_name), endian::InlHostByteOrder(), endian::InlHostByteOrder());
Ed Maste81b4c5f2016-01-04 01:43:47 +00001355
Greg Clayton71337622011-02-24 22:24:29 +00001356 m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncContinue, new EventDataBytes (packet.GetData(), packet.GetSize()));
1357
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001358 }
Oleksiy Vyalovafd6ce42015-11-23 19:32:24 +00001359 else
1360 SetExitStatus (-1, error.AsCString());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001361 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001362 return error;
1363}
1364
Greg Clayton5df78fa2015-05-23 03:54:53 +00001365void
1366ProcessGDBRemote::DidExit ()
Greg Claytonfbb76342013-11-20 21:07:01 +00001367{
Greg Clayton5df78fa2015-05-23 03:54:53 +00001368 // When we exit, disconnect from the GDB server communications
Greg Claytonfbb76342013-11-20 21:07:01 +00001369 m_gdb_comm.Disconnect();
Greg Claytonfbb76342013-11-20 21:07:01 +00001370}
1371
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001372void
Jim Inghambb006ce2014-08-02 00:33:35 +00001373ProcessGDBRemote::DidAttach (ArchSpec &process_arch)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001374{
Jim Inghambb006ce2014-08-02 00:33:35 +00001375 // If you can figure out what the architecture is, fill it in here.
1376 process_arch.Clear();
1377 DidLaunchOrAttach (process_arch);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001378}
1379
Eugene Zelenko0722f082015-10-24 01:28:05 +00001380
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001381Error
1382ProcessGDBRemote::WillResume ()
1383{
Greg Clayton71fc2a32011-02-12 06:28:37 +00001384 m_continue_c_tids.clear();
1385 m_continue_C_tids.clear();
1386 m_continue_s_tids.clear();
1387 m_continue_S_tids.clear();
Greg Clayton2e309072015-07-17 23:42:28 +00001388 m_jstopinfo_sp.reset();
1389 m_jthreadsinfo_sp.reset();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001390 return Error();
1391}
1392
1393Error
1394ProcessGDBRemote::DoResume ()
1395{
Jim Ingham0d8bcc72010-11-17 02:32:00 +00001396 Error error;
Greg Clayton5160ce52013-03-27 23:08:40 +00001397 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
Greg Clayton6d093452011-02-05 02:25:06 +00001398 if (log)
1399 log->Printf ("ProcessGDBRemote::Resume()");
Ed Maste81b4c5f2016-01-04 01:43:47 +00001400
Jim Ingham583bbb12016-03-07 21:50:25 +00001401 ListenerSP listener_sp (Listener::MakeListener("gdb-remote.resume-packet-sent"));
1402 if (listener_sp->StartListeningForEvents (&m_gdb_comm, GDBRemoteCommunication::eBroadcastBitRunPacketSent))
Greg Claytone5219662010-12-03 06:02:24 +00001403 {
Jim Ingham583bbb12016-03-07 21:50:25 +00001404 listener_sp->StartListeningForEvents (&m_async_broadcaster, ProcessGDBRemote::eBroadcastBitAsyncThreadDidExit);
Ed Maste81b4c5f2016-01-04 01:43:47 +00001405
Greg Claytond1d06e42013-04-20 00:27:58 +00001406 const size_t num_threads = GetThreadList().GetSize();
1407
Greg Clayton71fc2a32011-02-12 06:28:37 +00001408 StreamString continue_packet;
1409 bool continue_packet_error = false;
1410 if (m_gdb_comm.HasAnyVContSupport ())
1411 {
Ewan Crawford78baa192015-05-13 09:18:18 +00001412 if (!GetTarget().GetNonStopModeEnabled() &&
1413 (m_continue_c_tids.size() == num_threads ||
Greg Claytone98008c2014-02-13 23:34:38 +00001414 (m_continue_c_tids.empty() &&
1415 m_continue_C_tids.empty() &&
1416 m_continue_s_tids.empty() &&
Ewan Crawford78baa192015-05-13 09:18:18 +00001417 m_continue_S_tids.empty())))
Greg Clayton71fc2a32011-02-12 06:28:37 +00001418 {
Greg Claytond1d06e42013-04-20 00:27:58 +00001419 // All threads are continuing, just send a "c" packet
1420 continue_packet.PutCString ("c");
Greg Clayton71fc2a32011-02-12 06:28:37 +00001421 }
Greg Claytond1d06e42013-04-20 00:27:58 +00001422 else
1423 {
1424 continue_packet.PutCString ("vCont");
Ed Maste81b4c5f2016-01-04 01:43:47 +00001425
Greg Claytond1d06e42013-04-20 00:27:58 +00001426 if (!m_continue_c_tids.empty())
Greg Clayton71fc2a32011-02-12 06:28:37 +00001427 {
Greg Claytond1d06e42013-04-20 00:27:58 +00001428 if (m_gdb_comm.GetVContSupported ('c'))
1429 {
1430 for (tid_collection::const_iterator t_pos = m_continue_c_tids.begin(), t_end = m_continue_c_tids.end(); t_pos != t_end; ++t_pos)
1431 continue_packet.Printf(";c:%4.4" PRIx64, *t_pos);
1432 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001433 else
Greg Claytond1d06e42013-04-20 00:27:58 +00001434 continue_packet_error = true;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001435 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001436
Greg Claytond1d06e42013-04-20 00:27:58 +00001437 if (!continue_packet_error && !m_continue_C_tids.empty())
1438 {
1439 if (m_gdb_comm.GetVContSupported ('C'))
1440 {
1441 for (tid_sig_collection::const_iterator s_pos = m_continue_C_tids.begin(), s_end = m_continue_C_tids.end(); s_pos != s_end; ++s_pos)
1442 continue_packet.Printf(";C%2.2x:%4.4" PRIx64, s_pos->second, s_pos->first);
1443 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001444 else
Greg Claytond1d06e42013-04-20 00:27:58 +00001445 continue_packet_error = true;
1446 }
Greg Claytone5219662010-12-03 06:02:24 +00001447
Greg Claytond1d06e42013-04-20 00:27:58 +00001448 if (!continue_packet_error && !m_continue_s_tids.empty())
Greg Clayton71fc2a32011-02-12 06:28:37 +00001449 {
Greg Claytond1d06e42013-04-20 00:27:58 +00001450 if (m_gdb_comm.GetVContSupported ('s'))
1451 {
1452 for (tid_collection::const_iterator t_pos = m_continue_s_tids.begin(), t_end = m_continue_s_tids.end(); t_pos != t_end; ++t_pos)
1453 continue_packet.Printf(";s:%4.4" PRIx64, *t_pos);
1454 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001455 else
Greg Claytond1d06e42013-04-20 00:27:58 +00001456 continue_packet_error = true;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001457 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001458
Greg Claytond1d06e42013-04-20 00:27:58 +00001459 if (!continue_packet_error && !m_continue_S_tids.empty())
Greg Clayton71fc2a32011-02-12 06:28:37 +00001460 {
Greg Claytond1d06e42013-04-20 00:27:58 +00001461 if (m_gdb_comm.GetVContSupported ('S'))
1462 {
1463 for (tid_sig_collection::const_iterator s_pos = m_continue_S_tids.begin(), s_end = m_continue_S_tids.end(); s_pos != s_end; ++s_pos)
1464 continue_packet.Printf(";S%2.2x:%4.4" PRIx64, s_pos->second, s_pos->first);
1465 }
1466 else
1467 continue_packet_error = true;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001468 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001469
Greg Claytond1d06e42013-04-20 00:27:58 +00001470 if (continue_packet_error)
1471 continue_packet.GetString().clear();
Greg Clayton71fc2a32011-02-12 06:28:37 +00001472 }
Greg Clayton71fc2a32011-02-12 06:28:37 +00001473 }
1474 else
1475 continue_packet_error = true;
Ed Maste81b4c5f2016-01-04 01:43:47 +00001476
Greg Clayton71fc2a32011-02-12 06:28:37 +00001477 if (continue_packet_error)
1478 {
Greg Clayton71fc2a32011-02-12 06:28:37 +00001479 // Either no vCont support, or we tried to use part of the vCont
1480 // packet that wasn't supported by the remote GDB server.
1481 // We need to try and make a simple packet that can do our continue
Greg Clayton71fc2a32011-02-12 06:28:37 +00001482 const size_t num_continue_c_tids = m_continue_c_tids.size();
1483 const size_t num_continue_C_tids = m_continue_C_tids.size();
1484 const size_t num_continue_s_tids = m_continue_s_tids.size();
1485 const size_t num_continue_S_tids = m_continue_S_tids.size();
1486 if (num_continue_c_tids > 0)
1487 {
1488 if (num_continue_c_tids == num_threads)
1489 {
1490 // All threads are resuming...
Greg Clayton8b82f082011-04-12 05:54:46 +00001491 m_gdb_comm.SetCurrentThreadForRun (-1);
Ed Maste81b4c5f2016-01-04 01:43:47 +00001492 continue_packet.PutChar ('c');
Greg Clayton0c74e782011-06-24 03:21:43 +00001493 continue_packet_error = false;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001494 }
1495 else if (num_continue_c_tids == 1 &&
Ed Maste81b4c5f2016-01-04 01:43:47 +00001496 num_continue_C_tids == 0 &&
1497 num_continue_s_tids == 0 &&
Greg Clayton71fc2a32011-02-12 06:28:37 +00001498 num_continue_S_tids == 0 )
1499 {
1500 // Only one thread is continuing
Greg Clayton8b82f082011-04-12 05:54:46 +00001501 m_gdb_comm.SetCurrentThreadForRun (m_continue_c_tids.front());
Ed Maste81b4c5f2016-01-04 01:43:47 +00001502 continue_packet.PutChar ('c');
Greg Clayton0c74e782011-06-24 03:21:43 +00001503 continue_packet_error = false;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001504 }
1505 }
1506
Greg Clayton0c74e782011-06-24 03:21:43 +00001507 if (continue_packet_error && num_continue_C_tids > 0)
Greg Clayton71fc2a32011-02-12 06:28:37 +00001508 {
Ed Maste81b4c5f2016-01-04 01:43:47 +00001509 if ((num_continue_C_tids + num_continue_c_tids) == num_threads &&
1510 num_continue_C_tids > 0 &&
1511 num_continue_s_tids == 0 &&
Greg Clayton0c74e782011-06-24 03:21:43 +00001512 num_continue_S_tids == 0 )
Greg Clayton71fc2a32011-02-12 06:28:37 +00001513 {
1514 const int continue_signo = m_continue_C_tids.front().second;
Greg Clayton0c74e782011-06-24 03:21:43 +00001515 // Only one thread is continuing
Greg Clayton71fc2a32011-02-12 06:28:37 +00001516 if (num_continue_C_tids > 1)
1517 {
Ed Maste81b4c5f2016-01-04 01:43:47 +00001518 // More that one thread with a signal, yet we don't have
Greg Clayton0c74e782011-06-24 03:21:43 +00001519 // vCont support and we are being asked to resume each
1520 // thread with a signal, we need to make sure they are
1521 // all the same signal, or we can't issue the continue
1522 // accurately with the current support...
1523 if (num_continue_C_tids > 1)
Greg Clayton71fc2a32011-02-12 06:28:37 +00001524 {
Greg Clayton0c74e782011-06-24 03:21:43 +00001525 continue_packet_error = false;
1526 for (size_t i=1; i<m_continue_C_tids.size(); ++i)
1527 {
1528 if (m_continue_C_tids[i].second != continue_signo)
1529 continue_packet_error = true;
1530 }
Greg Clayton71fc2a32011-02-12 06:28:37 +00001531 }
Greg Clayton0c74e782011-06-24 03:21:43 +00001532 if (!continue_packet_error)
1533 m_gdb_comm.SetCurrentThreadForRun (-1);
1534 }
1535 else
1536 {
1537 // Set the continue thread ID
1538 continue_packet_error = false;
1539 m_gdb_comm.SetCurrentThreadForRun (m_continue_C_tids.front().first);
Greg Clayton71fc2a32011-02-12 06:28:37 +00001540 }
1541 if (!continue_packet_error)
1542 {
1543 // Add threads continuing with the same signo...
Greg Clayton71fc2a32011-02-12 06:28:37 +00001544 continue_packet.Printf("C%2.2x", continue_signo);
1545 }
1546 }
Greg Clayton71fc2a32011-02-12 06:28:37 +00001547 }
1548
Greg Clayton0c74e782011-06-24 03:21:43 +00001549 if (continue_packet_error && num_continue_s_tids > 0)
Greg Clayton71fc2a32011-02-12 06:28:37 +00001550 {
1551 if (num_continue_s_tids == num_threads)
1552 {
1553 // All threads are resuming...
Greg Clayton8b82f082011-04-12 05:54:46 +00001554 m_gdb_comm.SetCurrentThreadForRun (-1);
Ewan Crawford76df2882015-06-23 12:32:06 +00001555
1556 // If in Non-Stop-Mode use vCont when stepping
1557 if (GetTarget().GetNonStopModeEnabled())
1558 {
1559 if (m_gdb_comm.GetVContSupported('s'))
1560 continue_packet.PutCString("vCont;s");
1561 else
1562 continue_packet.PutChar('s');
1563 }
1564 else
1565 continue_packet.PutChar('s');
1566
Greg Clayton0c74e782011-06-24 03:21:43 +00001567 continue_packet_error = false;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001568 }
1569 else if (num_continue_c_tids == 0 &&
Ed Maste81b4c5f2016-01-04 01:43:47 +00001570 num_continue_C_tids == 0 &&
1571 num_continue_s_tids == 1 &&
Greg Clayton71fc2a32011-02-12 06:28:37 +00001572 num_continue_S_tids == 0 )
1573 {
1574 // Only one thread is stepping
Greg Clayton8b82f082011-04-12 05:54:46 +00001575 m_gdb_comm.SetCurrentThreadForRun (m_continue_s_tids.front());
Ed Maste81b4c5f2016-01-04 01:43:47 +00001576 continue_packet.PutChar ('s');
Greg Clayton0c74e782011-06-24 03:21:43 +00001577 continue_packet_error = false;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001578 }
1579 }
1580
1581 if (!continue_packet_error && num_continue_S_tids > 0)
1582 {
1583 if (num_continue_S_tids == num_threads)
1584 {
1585 const int step_signo = m_continue_S_tids.front().second;
1586 // Are all threads trying to step with the same signal?
Greg Clayton0c74e782011-06-24 03:21:43 +00001587 continue_packet_error = false;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001588 if (num_continue_S_tids > 1)
1589 {
1590 for (size_t i=1; i<num_threads; ++i)
1591 {
1592 if (m_continue_S_tids[i].second != step_signo)
1593 continue_packet_error = true;
1594 }
1595 }
1596 if (!continue_packet_error)
1597 {
1598 // Add threads stepping with the same signo...
Greg Clayton8b82f082011-04-12 05:54:46 +00001599 m_gdb_comm.SetCurrentThreadForRun (-1);
Greg Clayton71fc2a32011-02-12 06:28:37 +00001600 continue_packet.Printf("S%2.2x", step_signo);
1601 }
1602 }
1603 else if (num_continue_c_tids == 0 &&
Ed Maste81b4c5f2016-01-04 01:43:47 +00001604 num_continue_C_tids == 0 &&
1605 num_continue_s_tids == 0 &&
Greg Clayton71fc2a32011-02-12 06:28:37 +00001606 num_continue_S_tids == 1 )
1607 {
1608 // Only one thread is stepping with signal
Greg Clayton8b82f082011-04-12 05:54:46 +00001609 m_gdb_comm.SetCurrentThreadForRun (m_continue_S_tids.front().first);
Greg Clayton71fc2a32011-02-12 06:28:37 +00001610 continue_packet.Printf("S%2.2x", m_continue_S_tids.front().second);
Greg Clayton0c74e782011-06-24 03:21:43 +00001611 continue_packet_error = false;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001612 }
1613 }
1614 }
1615
1616 if (continue_packet_error)
1617 {
1618 error.SetErrorString ("can't make continue packet for this resume");
1619 }
1620 else
1621 {
1622 EventSP event_sp;
Zachary Turneracee96a2014-09-23 18:32:09 +00001623 if (!m_async_thread.IsJoinable())
Jim Inghamb1e2e842012-04-12 18:49:31 +00001624 {
1625 error.SetErrorString ("Trying to resume but the async thread is dead.");
1626 if (log)
1627 log->Printf ("ProcessGDBRemote::DoResume: Trying to resume but the async thread is dead.");
1628 return error;
1629 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001630
Greg Clayton71fc2a32011-02-12 06:28:37 +00001631 m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncContinue, new EventDataBytes (continue_packet.GetData(), continue_packet.GetSize()));
1632
Saleem Abdulrasool2d6a9ec2016-07-28 17:32:20 +00001633 if (listener_sp->WaitForEvent(std::chrono::seconds(5), event_sp) == false)
Jim Inghamb1e2e842012-04-12 18:49:31 +00001634 {
Greg Clayton71fc2a32011-02-12 06:28:37 +00001635 error.SetErrorString("Resume timed out.");
Jim Inghamb1e2e842012-04-12 18:49:31 +00001636 if (log)
1637 log->Printf ("ProcessGDBRemote::DoResume: Resume timed out.");
1638 }
1639 else if (event_sp->BroadcasterIs (&m_async_broadcaster))
1640 {
1641 error.SetErrorString ("Broadcast continue, but the async thread was killed before we got an ack back.");
1642 if (log)
1643 log->Printf ("ProcessGDBRemote::DoResume: Broadcast continue, but the async thread was killed before we got an ack back.");
1644 return error;
1645 }
Greg Clayton71fc2a32011-02-12 06:28:37 +00001646 }
Greg Claytone5219662010-12-03 06:02:24 +00001647 }
1648
Jim Ingham0d8bcc72010-11-17 02:32:00 +00001649 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001650}
1651
Greg Clayton9e920902012-04-10 02:25:43 +00001652void
Ewan Crawford78baa192015-05-13 09:18:18 +00001653ProcessGDBRemote::HandleStopReplySequence ()
1654{
1655 while(true)
1656 {
1657 // Send vStopped
1658 StringExtractorGDBRemote response;
1659 m_gdb_comm.SendPacketAndWaitForResponse("vStopped", response, false);
1660
1661 // OK represents end of signal list
1662 if (response.IsOKResponse())
1663 break;
1664
1665 // If not OK or a normal packet we have a problem
1666 if (!response.IsNormalResponse())
1667 break;
1668
1669 SetLastStopPacket(response);
1670 }
1671}
1672
1673void
Greg Clayton9e920902012-04-10 02:25:43 +00001674ProcessGDBRemote::ClearThreadIDList ()
1675{
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00001676 std::lock_guard<std::recursive_mutex> guard(m_thread_list_real.GetMutex());
Greg Clayton9e920902012-04-10 02:25:43 +00001677 m_thread_ids.clear();
Jason Molenda545304d2015-12-18 00:45:35 +00001678 m_thread_pcs.clear();
Greg Clayton9e920902012-04-10 02:25:43 +00001679}
1680
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001681size_t
1682ProcessGDBRemote::UpdateThreadIDsFromStopReplyThreadsValue (std::string &value)
1683{
1684 m_thread_ids.clear();
Jason Molenda545304d2015-12-18 00:45:35 +00001685 m_thread_pcs.clear();
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001686 size_t comma_pos;
1687 lldb::tid_t tid;
1688 while ((comma_pos = value.find(',')) != std::string::npos)
1689 {
1690 value[comma_pos] = '\0';
1691 // thread in big endian hex
1692 tid = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_THREAD_ID, 16);
1693 if (tid != LLDB_INVALID_THREAD_ID)
1694 m_thread_ids.push_back (tid);
1695 value.erase(0, comma_pos + 1);
1696 }
1697 tid = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_THREAD_ID, 16);
1698 if (tid != LLDB_INVALID_THREAD_ID)
1699 m_thread_ids.push_back (tid);
1700 return m_thread_ids.size();
1701}
1702
Jason Molenda545304d2015-12-18 00:45:35 +00001703size_t
1704ProcessGDBRemote::UpdateThreadPCsFromStopReplyThreadsValue (std::string &value)
1705{
1706 m_thread_pcs.clear();
1707 size_t comma_pos;
1708 lldb::addr_t pc;
1709 while ((comma_pos = value.find(',')) != std::string::npos)
1710 {
1711 value[comma_pos] = '\0';
1712 pc = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_ADDRESS, 16);
1713 if (pc != LLDB_INVALID_ADDRESS)
1714 m_thread_pcs.push_back (pc);
1715 value.erase(0, comma_pos + 1);
1716 }
1717 pc = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_ADDRESS, 16);
1718 if (pc != LLDB_INVALID_THREAD_ID)
1719 m_thread_pcs.push_back (pc);
1720 return m_thread_pcs.size();
1721}
1722
Greg Clayton9e920902012-04-10 02:25:43 +00001723bool
1724ProcessGDBRemote::UpdateThreadIDList ()
1725{
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00001726 std::lock_guard<std::recursive_mutex> guard(m_thread_list_real.GetMutex());
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001727
Greg Clayton2e309072015-07-17 23:42:28 +00001728 if (m_jthreadsinfo_sp)
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001729 {
1730 // If we have the JSON threads info, we can get the thread list from that
Greg Clayton2e309072015-07-17 23:42:28 +00001731 StructuredData::Array *thread_infos = m_jthreadsinfo_sp->GetAsArray();
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001732 if (thread_infos && thread_infos->GetSize() > 0)
1733 {
1734 m_thread_ids.clear();
Jason Molenda545304d2015-12-18 00:45:35 +00001735 m_thread_pcs.clear();
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001736 thread_infos->ForEach([this](StructuredData::Object* object) -> bool {
1737 StructuredData::Dictionary *thread_dict = object->GetAsDictionary();
1738 if (thread_dict)
1739 {
1740 // Set the thread stop info from the JSON dictionary
1741 SetThreadStopInfo (thread_dict);
1742 lldb::tid_t tid = LLDB_INVALID_THREAD_ID;
1743 if (thread_dict->GetValueForKeyAsInteger<lldb::tid_t>("tid", tid))
1744 m_thread_ids.push_back(tid);
1745 }
1746 return true; // Keep iterating through all thread_info objects
1747 });
1748 }
1749 if (!m_thread_ids.empty())
1750 return true;
1751 }
1752 else
1753 {
1754 // See if we can get the thread IDs from the current stop reply packets
1755 // that might contain a "threads" key/value pair
1756
1757 // Lock the thread stack while we access it
Greg Claytonfc1e77a982015-11-03 22:42:04 +00001758 //Mutex::Locker stop_stack_lock(m_last_stop_packet_mutex);
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +00001759 std::unique_lock<std::recursive_mutex> stop_stack_lock(m_last_stop_packet_mutex, std::defer_lock);
1760 if (stop_stack_lock.try_lock())
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001761 {
Greg Claytonfc1e77a982015-11-03 22:42:04 +00001762 // Get the number of stop packets on the stack
1763 int nItems = m_stop_packet_stack.size();
1764 // Iterate over them
1765 for (int i = 0; i < nItems; i++)
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001766 {
Greg Claytonfc1e77a982015-11-03 22:42:04 +00001767 // Get the thread stop info
1768 StringExtractorGDBRemote &stop_info = m_stop_packet_stack[i];
1769 const std::string &stop_info_str = stop_info.GetStringRef();
Jason Molenda545304d2015-12-18 00:45:35 +00001770
1771 m_thread_pcs.clear();
1772 const size_t thread_pcs_pos = stop_info_str.find(";thread-pcs:");
1773 if (thread_pcs_pos != std::string::npos)
1774 {
1775 const size_t start = thread_pcs_pos + strlen(";thread-pcs:");
1776 const size_t end = stop_info_str.find(';', start);
1777 if (end != std::string::npos)
1778 {
1779 std::string value = stop_info_str.substr(start, end - start);
1780 UpdateThreadPCsFromStopReplyThreadsValue(value);
1781 }
1782 }
1783
Greg Claytonfc1e77a982015-11-03 22:42:04 +00001784 const size_t threads_pos = stop_info_str.find(";threads:");
1785 if (threads_pos != std::string::npos)
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001786 {
Greg Claytonfc1e77a982015-11-03 22:42:04 +00001787 const size_t start = threads_pos + strlen(";threads:");
1788 const size_t end = stop_info_str.find(';', start);
1789 if (end != std::string::npos)
1790 {
1791 std::string value = stop_info_str.substr(start, end - start);
1792 if (UpdateThreadIDsFromStopReplyThreadsValue(value))
1793 return true;
1794 }
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001795 }
1796 }
1797 }
1798 }
1799
Greg Clayton9e920902012-04-10 02:25:43 +00001800 bool sequence_mutex_unavailable = false;
1801 m_gdb_comm.GetCurrentThreadIDs (m_thread_ids, sequence_mutex_unavailable);
1802 if (sequence_mutex_unavailable)
1803 {
Greg Clayton9e920902012-04-10 02:25:43 +00001804 return false; // We just didn't get the list
1805 }
1806 return true;
1807}
1808
Greg Clayton9fc13552012-04-10 00:18:59 +00001809bool
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001810ProcessGDBRemote::UpdateThreadList (ThreadList &old_thread_list, ThreadList &new_thread_list)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001811{
1812 // locker will keep a mutex locked until it goes out of scope
Greg Clayton5160ce52013-03-27 23:08:40 +00001813 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_THREAD));
Greg Clayton73b472d2010-10-27 03:32:59 +00001814 if (log && log->GetMask().Test(GDBR_LOG_VERBOSE))
Daniel Malead01b2952012-11-29 21:49:15 +00001815 log->Printf ("ProcessGDBRemote::%s (pid = %" PRIu64 ")", __FUNCTION__, GetID());
Ed Maste81b4c5f2016-01-04 01:43:47 +00001816
Greg Clayton9e920902012-04-10 02:25:43 +00001817 size_t num_thread_ids = m_thread_ids.size();
1818 // The "m_thread_ids" thread ID list should always be updated after each stop
1819 // reply packet, but in case it isn't, update it here.
1820 if (num_thread_ids == 0)
1821 {
1822 if (!UpdateThreadIDList ())
1823 return false;
1824 num_thread_ids = m_thread_ids.size();
1825 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001826
Han Ming Ongc2c423e2013-01-08 22:10:01 +00001827 ThreadList old_thread_list_copy(old_thread_list);
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001828 if (num_thread_ids > 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001829 {
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001830 for (size_t i=0; i<num_thread_ids; ++i)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001831 {
Greg Clayton9e920902012-04-10 02:25:43 +00001832 tid_t tid = m_thread_ids[i];
Greg Clayton160c9d82013-05-01 21:54:04 +00001833 ThreadSP thread_sp (old_thread_list_copy.RemoveThreadByProtocolID(tid, false));
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001834 if (!thread_sp)
Jim Inghamdee1bc92013-06-22 00:27:45 +00001835 {
Jim Ingham4f465cf2012-10-10 18:32:14 +00001836 thread_sp.reset (new ThreadGDBRemote (*this, tid));
Jim Inghamdee1bc92013-06-22 00:27:45 +00001837 if (log && log->GetMask().Test(GDBR_LOG_VERBOSE))
1838 log->Printf(
1839 "ProcessGDBRemote::%s Making new thread: %p for thread ID: 0x%" PRIx64 ".\n",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001840 __FUNCTION__, static_cast<void*>(thread_sp.get()),
Jim Inghamdee1bc92013-06-22 00:27:45 +00001841 thread_sp->GetID());
1842 }
1843 else
1844 {
1845 if (log && log->GetMask().Test(GDBR_LOG_VERBOSE))
1846 log->Printf(
1847 "ProcessGDBRemote::%s Found old thread: %p for thread ID: 0x%" PRIx64 ".\n",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001848 __FUNCTION__, static_cast<void*>(thread_sp.get()),
Jim Inghamdee1bc92013-06-22 00:27:45 +00001849 thread_sp->GetID());
1850 }
Jason Molenda545304d2015-12-18 00:45:35 +00001851 // The m_thread_pcs vector has pc values in big-endian order, not target-endian, unlike most
Ed Maste81b4c5f2016-01-04 01:43:47 +00001852 // of the register read/write packets in gdb-remote protocol.
Jason Molenda545304d2015-12-18 00:45:35 +00001853 // Early in the process startup, we may not yet have set the process ByteOrder so we ignore these;
1854 // they are a performance improvement over fetching thread register values individually, the
1855 // method we will fall back to if needed.
1856 if (m_thread_ids.size() == m_thread_pcs.size() && thread_sp.get() && GetByteOrder() != eByteOrderInvalid)
1857 {
1858 ThreadGDBRemote *gdb_thread = static_cast<ThreadGDBRemote *> (thread_sp.get());
1859 RegisterContextSP reg_ctx_sp (thread_sp->GetRegisterContext());
1860 if (reg_ctx_sp)
1861 {
Ed Maste81b4c5f2016-01-04 01:43:47 +00001862 uint32_t pc_regnum = reg_ctx_sp->ConvertRegisterKindToRegisterNumber
Jason Molenda545304d2015-12-18 00:45:35 +00001863 (eRegisterKindGeneric, LLDB_REGNUM_GENERIC_PC);
1864 if (pc_regnum != LLDB_INVALID_REGNUM)
1865 {
1866 gdb_thread->PrivateSetRegisterValue (pc_regnum, m_thread_pcs[i]);
1867 }
1868 }
1869 }
Greg Clayton88f86b62016-06-10 23:23:34 +00001870 new_thread_list.AddThreadSortedByIndexID (thread_sp);
Greg Claytonadc00cb2011-05-20 23:38:13 +00001871 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001872 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001873
Han Ming Ongc2c423e2013-01-08 22:10:01 +00001874 // Whatever that is left in old_thread_list_copy are not
1875 // present in new_thread_list. Remove non-existent threads from internal id table.
1876 size_t old_num_thread_ids = old_thread_list_copy.GetSize(false);
1877 for (size_t i=0; i<old_num_thread_ids; i++)
1878 {
1879 ThreadSP old_thread_sp(old_thread_list_copy.GetThreadAtIndex (i, false));
1880 if (old_thread_sp)
1881 {
Greg Clayton160c9d82013-05-01 21:54:04 +00001882 lldb::tid_t old_thread_id = old_thread_sp->GetProtocolID();
Han Ming Ongc2c423e2013-01-08 22:10:01 +00001883 m_thread_id_to_index_id_map.erase(old_thread_id);
1884 }
1885 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001886
Greg Clayton9fc13552012-04-10 00:18:59 +00001887 return true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001888}
1889
Eugene Zelenko0722f082015-10-24 01:28:05 +00001890
Greg Clayton358cf1e2015-06-25 21:46:34 +00001891bool
Greg Clayton2e309072015-07-17 23:42:28 +00001892ProcessGDBRemote::GetThreadStopInfoFromJSON (ThreadGDBRemote *thread, const StructuredData::ObjectSP &thread_infos_sp)
Greg Clayton358cf1e2015-06-25 21:46:34 +00001893{
1894 // See if we got thread stop infos for all threads via the "jThreadsInfo" packet
Greg Clayton2e309072015-07-17 23:42:28 +00001895 if (thread_infos_sp)
Greg Clayton358cf1e2015-06-25 21:46:34 +00001896 {
Greg Clayton2e309072015-07-17 23:42:28 +00001897 StructuredData::Array *thread_infos = thread_infos_sp->GetAsArray();
Greg Clayton358cf1e2015-06-25 21:46:34 +00001898 if (thread_infos)
1899 {
1900 lldb::tid_t tid;
1901 const size_t n = thread_infos->GetSize();
1902 for (size_t i=0; i<n; ++i)
1903 {
1904 StructuredData::Dictionary *thread_dict = thread_infos->GetItemAtIndex(i)->GetAsDictionary();
1905 if (thread_dict)
1906 {
1907 if (thread_dict->GetValueForKeyAsInteger<lldb::tid_t>("tid", tid, LLDB_INVALID_THREAD_ID))
1908 {
1909 if (tid == thread->GetID())
Greg Clayton2e309072015-07-17 23:42:28 +00001910 return (bool)SetThreadStopInfo(thread_dict);
Greg Clayton358cf1e2015-06-25 21:46:34 +00001911 }
1912 }
1913 }
1914 }
1915 }
Greg Clayton2e309072015-07-17 23:42:28 +00001916 return false;
1917}
1918
1919bool
1920ProcessGDBRemote::CalculateThreadStopInfo (ThreadGDBRemote *thread)
1921{
1922 // See if we got thread stop infos for all threads via the "jThreadsInfo" packet
1923 if (GetThreadStopInfoFromJSON (thread, m_jthreadsinfo_sp))
1924 return true;
1925
1926 // See if we got thread stop info for any threads valid stop info reasons threads
1927 // via the "jstopinfo" packet stop reply packet key/value pair?
1928 if (m_jstopinfo_sp)
1929 {
1930 // If we have "jstopinfo" then we have stop descriptions for all threads
1931 // that have stop reasons, and if there is no entry for a thread, then
1932 // it has no stop reason.
1933 thread->GetRegisterContext()->InvalidateIfNeeded(true);
1934 if (!GetThreadStopInfoFromJSON (thread, m_jstopinfo_sp))
1935 {
1936 thread->SetStopInfo (StopInfoSP());
1937 }
1938 return true;
1939 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00001940
1941 // Fall back to using the qThreadStopInfo packet
1942 StringExtractorGDBRemote stop_packet;
1943 if (GetGDBRemote().GetThreadStopInfo(thread->GetProtocolID(), stop_packet))
1944 return SetThreadStopInfo (stop_packet) == eStateStopped;
1945 return false;
1946}
1947
Eugene Zelenko0722f082015-10-24 01:28:05 +00001948
Greg Clayton358cf1e2015-06-25 21:46:34 +00001949ThreadSP
1950ProcessGDBRemote::SetThreadStopInfo (lldb::tid_t tid,
1951 ExpeditedRegisterMap &expedited_register_map,
1952 uint8_t signo,
1953 const std::string &thread_name,
1954 const std::string &reason,
1955 const std::string &description,
1956 uint32_t exc_type,
1957 const std::vector<addr_t> &exc_data,
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001958 addr_t thread_dispatch_qaddr,
1959 bool queue_vars_valid, // Set to true if queue_name, queue_kind and queue_serial are valid
Jason Molenda77f89352016-01-12 07:09:16 +00001960 LazyBool associated_with_dispatch_queue,
1961 addr_t dispatch_queue_t,
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001962 std::string &queue_name,
1963 QueueKind queue_kind,
1964 uint64_t queue_serial)
Greg Clayton358cf1e2015-06-25 21:46:34 +00001965{
1966 ThreadSP thread_sp;
1967 if (tid != LLDB_INVALID_THREAD_ID)
1968 {
1969 // Scope for "locker" below
1970 {
1971 // m_thread_list_real does have its own mutex, but we need to
1972 // hold onto the mutex between the call to m_thread_list_real.FindThreadByID(...)
1973 // and the m_thread_list_real.AddThread(...) so it doesn't change on us
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00001974 std::lock_guard<std::recursive_mutex> guard(m_thread_list_real.GetMutex());
Greg Clayton358cf1e2015-06-25 21:46:34 +00001975 thread_sp = m_thread_list_real.FindThreadByProtocolID(tid, false);
1976
1977 if (!thread_sp)
1978 {
1979 // Create the thread if we need to
1980 thread_sp.reset (new ThreadGDBRemote (*this, tid));
1981 m_thread_list_real.AddThread(thread_sp);
1982 }
1983 }
1984
1985 if (thread_sp)
1986 {
1987 ThreadGDBRemote *gdb_thread = static_cast<ThreadGDBRemote *> (thread_sp.get());
1988 gdb_thread->GetRegisterContext()->InvalidateIfNeeded(true);
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001989
Greg Clayton358cf1e2015-06-25 21:46:34 +00001990 for (const auto &pair : expedited_register_map)
1991 {
1992 StringExtractor reg_value_extractor;
1993 reg_value_extractor.GetStringRef() = pair.second;
1994 gdb_thread->PrivateSetRegisterValue (pair.first, reg_value_extractor);
1995 }
1996
Greg Clayton358cf1e2015-06-25 21:46:34 +00001997 thread_sp->SetName (thread_name.empty() ? NULL : thread_name.c_str());
1998
1999 gdb_thread->SetThreadDispatchQAddr (thread_dispatch_qaddr);
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002000 // Check if the GDB server was able to provide the queue name, kind and serial number
2001 if (queue_vars_valid)
Jason Molenda77f89352016-01-12 07:09:16 +00002002 gdb_thread->SetQueueInfo(std::move(queue_name), queue_kind, queue_serial, dispatch_queue_t, associated_with_dispatch_queue);
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002003 else
2004 gdb_thread->ClearQueueInfo();
2005
Jason Molenda77f89352016-01-12 07:09:16 +00002006 gdb_thread->SetAssociatedWithLibdispatchQueue (associated_with_dispatch_queue);
2007
2008 if (dispatch_queue_t != LLDB_INVALID_ADDRESS)
2009 gdb_thread->SetQueueLibdispatchQueueAddress (dispatch_queue_t);
2010
Greg Clayton2e309072015-07-17 23:42:28 +00002011 // Make sure we update our thread stop reason just once
2012 if (!thread_sp->StopInfoIsUpToDate())
Greg Clayton358cf1e2015-06-25 21:46:34 +00002013 {
Greg Clayton2e309072015-07-17 23:42:28 +00002014 thread_sp->SetStopInfo (StopInfoSP());
Ryan Brown65d4d5c2015-09-16 21:20:44 +00002015 // If there's a memory thread backed by this thread, we need to use it to calcualte StopInfo.
2016 ThreadSP memory_thread_sp = m_thread_list.FindThreadByProtocolID(thread_sp->GetProtocolID());
2017 if (memory_thread_sp)
2018 thread_sp = memory_thread_sp;
Greg Clayton358cf1e2015-06-25 21:46:34 +00002019
Greg Clayton2e309072015-07-17 23:42:28 +00002020 if (exc_type != 0)
Greg Clayton358cf1e2015-06-25 21:46:34 +00002021 {
Greg Clayton2e309072015-07-17 23:42:28 +00002022 const size_t exc_data_size = exc_data.size();
2023
2024 thread_sp->SetStopInfo (StopInfoMachException::CreateStopReasonWithMachException (*thread_sp,
2025 exc_type,
2026 exc_data_size,
2027 exc_data_size >= 1 ? exc_data[0] : 0,
2028 exc_data_size >= 2 ? exc_data[1] : 0,
2029 exc_data_size >= 3 ? exc_data[2] : 0));
Greg Clayton358cf1e2015-06-25 21:46:34 +00002030 }
Greg Clayton2e309072015-07-17 23:42:28 +00002031 else
Greg Clayton358cf1e2015-06-25 21:46:34 +00002032 {
Greg Clayton2e309072015-07-17 23:42:28 +00002033 bool handled = false;
2034 bool did_exec = false;
2035 if (!reason.empty())
Greg Clayton358cf1e2015-06-25 21:46:34 +00002036 {
Greg Clayton2e309072015-07-17 23:42:28 +00002037 if (reason.compare("trace") == 0)
Greg Clayton358cf1e2015-06-25 21:46:34 +00002038 {
Pavel Labathef409122016-04-07 08:16:10 +00002039 addr_t pc = thread_sp->GetRegisterContext()->GetPC();
2040 lldb::BreakpointSiteSP bp_site_sp = thread_sp->GetProcess()->GetBreakpointSiteList().FindByAddress(pc);
2041
2042 // If the current pc is a breakpoint site then the StopInfo should be set to Breakpoint
2043 // Otherwise, it will be set to Trace.
2044 if (bp_site_sp && bp_site_sp->ValidForThisThread(thread_sp.get()))
2045 {
2046 thread_sp->SetStopInfo(
2047 StopInfo::CreateStopReasonWithBreakpointSiteID(*thread_sp, bp_site_sp->GetID()));
2048 }
2049 else
2050 thread_sp->SetStopInfo (StopInfo::CreateStopReasonToTrace (*thread_sp));
Greg Clayton2e309072015-07-17 23:42:28 +00002051 handled = true;
2052 }
2053 else if (reason.compare("breakpoint") == 0)
2054 {
Pavel Labathef409122016-04-07 08:16:10 +00002055 addr_t pc = thread_sp->GetRegisterContext()->GetPC();
2056 lldb::BreakpointSiteSP bp_site_sp = thread_sp->GetProcess()->GetBreakpointSiteList().FindByAddress(pc);
2057 if (bp_site_sp)
2058 {
2059 // If the breakpoint is for this thread, then we'll report the hit, but if it is for another thread,
2060 // we can just report no reason. We don't need to worry about stepping over the breakpoint here, that
2061 // will be taken care of when the thread resumes and notices that there's a breakpoint under the pc.
2062 handled = true;
2063 if (bp_site_sp->ValidForThisThread (thread_sp.get()))
2064 {
2065 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithBreakpointSiteID (*thread_sp, bp_site_sp->GetID()));
2066 }
2067 else
2068 {
2069 StopInfoSP invalid_stop_info_sp;
2070 thread_sp->SetStopInfo (invalid_stop_info_sp);
2071 }
2072 }
Greg Clayton2e309072015-07-17 23:42:28 +00002073 }
2074 else if (reason.compare("trap") == 0)
2075 {
2076 // Let the trap just use the standard signal stop reason below...
2077 }
2078 else if (reason.compare("watchpoint") == 0)
2079 {
2080 StringExtractor desc_extractor(description.c_str());
2081 addr_t wp_addr = desc_extractor.GetU64(LLDB_INVALID_ADDRESS);
2082 uint32_t wp_index = desc_extractor.GetU32(LLDB_INVALID_INDEX32);
Jaydeep Patil83143502015-08-13 03:44:09 +00002083 addr_t wp_hit_addr = desc_extractor.GetU64(LLDB_INVALID_ADDRESS);
Greg Clayton2e309072015-07-17 23:42:28 +00002084 watch_id_t watch_id = LLDB_INVALID_WATCH_ID;
2085 if (wp_addr != LLDB_INVALID_ADDRESS)
2086 {
Mohit K. Bhakkad6846bc82015-12-02 17:45:02 +00002087 WatchpointSP wp_sp;
2088 ArchSpec::Core core = GetTarget().GetArchitecture().GetCore();
Omair Javaid43507f52016-06-16 16:41:22 +00002089 if ((core >= ArchSpec::kCore_mips_first && core <= ArchSpec::kCore_mips_last) ||
Omair Javaidc6dc90e2016-06-27 11:18:23 +00002090 (core >= ArchSpec::eCore_arm_generic && core <= ArchSpec::eCore_arm_aarch64))
Mohit K. Bhakkad6846bc82015-12-02 17:45:02 +00002091 wp_sp = GetTarget().GetWatchpointList().FindByAddress(wp_hit_addr);
2092 if (!wp_sp)
2093 wp_sp = GetTarget().GetWatchpointList().FindByAddress(wp_addr);
Greg Clayton2e309072015-07-17 23:42:28 +00002094 if (wp_sp)
2095 {
2096 wp_sp->SetHardwareIndex(wp_index);
2097 watch_id = wp_sp->GetID();
2098 }
2099 }
2100 if (watch_id == LLDB_INVALID_WATCH_ID)
2101 {
2102 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_WATCHPOINTS));
2103 if (log) log->Printf ("failed to find watchpoint");
2104 }
Jaydeep Patil83143502015-08-13 03:44:09 +00002105 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithWatchpointID (*thread_sp, watch_id, wp_hit_addr));
Greg Clayton2e309072015-07-17 23:42:28 +00002106 handled = true;
2107 }
2108 else if (reason.compare("exception") == 0)
2109 {
2110 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithException(*thread_sp, description.c_str()));
2111 handled = true;
2112 }
2113 else if (reason.compare("exec") == 0)
2114 {
2115 did_exec = true;
2116 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithExec(*thread_sp));
2117 handled = true;
2118 }
2119 }
Pavel Labath3ce324a2016-04-06 09:10:29 +00002120 else if (!signo)
2121 {
Pavel Labathef409122016-04-07 08:16:10 +00002122 addr_t pc = thread_sp->GetRegisterContext()->GetPC();
2123 lldb::BreakpointSiteSP bp_site_sp =
2124 thread_sp->GetProcess()->GetBreakpointSiteList().FindByAddress(pc);
2125
Pavel Labath3ce324a2016-04-06 09:10:29 +00002126 // If the current pc is a breakpoint site then the StopInfo should be set to Breakpoint
2127 // even though the remote stub did not set it as such. This can happen when
2128 // the thread is involuntarily interrupted (e.g. due to stops on other
2129 // threads) just as it is about to execute the breakpoint instruction.
Pavel Labathef409122016-04-07 08:16:10 +00002130 if (bp_site_sp && bp_site_sp->ValidForThisThread(thread_sp.get()))
2131 {
2132 thread_sp->SetStopInfo(
2133 StopInfo::CreateStopReasonWithBreakpointSiteID(*thread_sp, bp_site_sp->GetID()));
Pavel Labath3ce324a2016-04-06 09:10:29 +00002134 handled = true;
Pavel Labathef409122016-04-07 08:16:10 +00002135 }
Pavel Labath3ce324a2016-04-06 09:10:29 +00002136 }
Greg Clayton2e309072015-07-17 23:42:28 +00002137
2138 if (!handled && signo && did_exec == false)
2139 {
2140 if (signo == SIGTRAP)
2141 {
2142 // Currently we are going to assume SIGTRAP means we are either
2143 // hitting a breakpoint or hardware single stepping.
2144 handled = true;
2145 addr_t pc = thread_sp->GetRegisterContext()->GetPC() + m_breakpoint_pc_offset;
2146 lldb::BreakpointSiteSP bp_site_sp = thread_sp->GetProcess()->GetBreakpointSiteList().FindByAddress(pc);
2147
2148 if (bp_site_sp)
2149 {
2150 // If the breakpoint is for this thread, then we'll report the hit, but if it is for another thread,
2151 // we can just report no reason. We don't need to worry about stepping over the breakpoint here, that
2152 // will be taken care of when the thread resumes and notices that there's a breakpoint under the pc.
2153 if (bp_site_sp->ValidForThisThread (thread_sp.get()))
2154 {
2155 if(m_breakpoint_pc_offset != 0)
2156 thread_sp->GetRegisterContext()->SetPC(pc);
2157 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithBreakpointSiteID (*thread_sp, bp_site_sp->GetID()));
2158 }
2159 else
2160 {
2161 StopInfoSP invalid_stop_info_sp;
2162 thread_sp->SetStopInfo (invalid_stop_info_sp);
2163 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002164 }
2165 else
2166 {
Greg Clayton2e309072015-07-17 23:42:28 +00002167 // If we were stepping then assume the stop was the result of the trace. If we were
2168 // not stepping then report the SIGTRAP.
2169 // FIXME: We are still missing the case where we single step over a trap instruction.
2170 if (thread_sp->GetTemporaryResumeState() == eStateStepping)
2171 thread_sp->SetStopInfo (StopInfo::CreateStopReasonToTrace (*thread_sp));
2172 else
2173 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithSignal(*thread_sp, signo, description.c_str()));
Greg Clayton358cf1e2015-06-25 21:46:34 +00002174 }
2175 }
Greg Clayton2e309072015-07-17 23:42:28 +00002176 if (!handled)
2177 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithSignal (*thread_sp, signo, description.c_str()));
2178 }
2179
2180 if (!description.empty())
2181 {
2182 lldb::StopInfoSP stop_info_sp (thread_sp->GetStopInfo ());
2183 if (stop_info_sp)
2184 {
2185 const char *stop_info_desc = stop_info_sp->GetDescription();
2186 if (!stop_info_desc || !stop_info_desc[0])
2187 stop_info_sp->SetDescription (description.c_str());
2188 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002189 else
2190 {
Greg Clayton2e309072015-07-17 23:42:28 +00002191 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithException (*thread_sp, description.c_str()));
Greg Clayton358cf1e2015-06-25 21:46:34 +00002192 }
2193 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002194 }
2195 }
2196 }
2197 }
2198 return thread_sp;
2199}
2200
Greg Clayton2e309072015-07-17 23:42:28 +00002201lldb::ThreadSP
Greg Clayton358cf1e2015-06-25 21:46:34 +00002202ProcessGDBRemote::SetThreadStopInfo (StructuredData::Dictionary *thread_dict)
2203{
2204 static ConstString g_key_tid("tid");
2205 static ConstString g_key_name("name");
2206 static ConstString g_key_reason("reason");
2207 static ConstString g_key_metype("metype");
2208 static ConstString g_key_medata("medata");
2209 static ConstString g_key_qaddr("qaddr");
Jason Molenda77f89352016-01-12 07:09:16 +00002210 static ConstString g_key_dispatch_queue_t("dispatch_queue_t");
2211 static ConstString g_key_associated_with_dispatch_queue("associated_with_dispatch_queue");
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002212 static ConstString g_key_queue_name("qname");
2213 static ConstString g_key_queue_kind("qkind");
Jason Molenda26d84e82016-01-08 00:20:48 +00002214 static ConstString g_key_queue_serial_number("qserialnum");
Greg Clayton358cf1e2015-06-25 21:46:34 +00002215 static ConstString g_key_registers("registers");
2216 static ConstString g_key_memory("memory");
2217 static ConstString g_key_address("address");
2218 static ConstString g_key_bytes("bytes");
2219 static ConstString g_key_description("description");
Pavel Labath4a4bb122015-07-16 14:14:35 +00002220 static ConstString g_key_signal("signal");
Greg Clayton358cf1e2015-06-25 21:46:34 +00002221
2222 // Stop with signal and thread info
2223 lldb::tid_t tid = LLDB_INVALID_THREAD_ID;
2224 uint8_t signo = 0;
2225 std::string value;
2226 std::string thread_name;
2227 std::string reason;
2228 std::string description;
2229 uint32_t exc_type = 0;
2230 std::vector<addr_t> exc_data;
2231 addr_t thread_dispatch_qaddr = LLDB_INVALID_ADDRESS;
2232 ExpeditedRegisterMap expedited_register_map;
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002233 bool queue_vars_valid = false;
Jason Molenda77f89352016-01-12 07:09:16 +00002234 addr_t dispatch_queue_t = LLDB_INVALID_ADDRESS;
2235 LazyBool associated_with_dispatch_queue = eLazyBoolCalculate;
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002236 std::string queue_name;
2237 QueueKind queue_kind = eQueueKindUnknown;
Jason Molenda26d84e82016-01-08 00:20:48 +00002238 uint64_t queue_serial_number = 0;
Greg Clayton358cf1e2015-06-25 21:46:34 +00002239 // Iterate through all of the thread dictionary key/value pairs from the structured data dictionary
2240
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002241 thread_dict->ForEach([this,
2242 &tid,
2243 &expedited_register_map,
2244 &thread_name,
2245 &signo,
2246 &reason,
2247 &description,
2248 &exc_type,
2249 &exc_data,
2250 &thread_dispatch_qaddr,
2251 &queue_vars_valid,
Jason Molenda77f89352016-01-12 07:09:16 +00002252 &associated_with_dispatch_queue,
2253 &dispatch_queue_t,
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002254 &queue_name,
2255 &queue_kind,
Jason Molenda26d84e82016-01-08 00:20:48 +00002256 &queue_serial_number]
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002257 (ConstString key, StructuredData::Object* object) -> bool
Greg Clayton358cf1e2015-06-25 21:46:34 +00002258 {
2259 if (key == g_key_tid)
2260 {
2261 // thread in big endian hex
2262 tid = object->GetIntegerValue(LLDB_INVALID_THREAD_ID);
2263 }
2264 else if (key == g_key_metype)
2265 {
2266 // exception type in big endian hex
2267 exc_type = object->GetIntegerValue(0);
2268 }
2269 else if (key == g_key_medata)
2270 {
2271 // exception data in big endian hex
2272 StructuredData::Array *array = object->GetAsArray();
2273 if (array)
2274 {
2275 array->ForEach([&exc_data](StructuredData::Object* object) -> bool {
2276 exc_data.push_back(object->GetIntegerValue());
2277 return true; // Keep iterating through all array items
2278 });
2279 }
2280 }
2281 else if (key == g_key_name)
2282 {
Pavel Labath3a29f8b2015-07-28 09:18:32 +00002283 thread_name = object->GetStringValue();
Greg Clayton358cf1e2015-06-25 21:46:34 +00002284 }
2285 else if (key == g_key_qaddr)
2286 {
2287 thread_dispatch_qaddr = object->GetIntegerValue(LLDB_INVALID_ADDRESS);
2288 }
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002289 else if (key == g_key_queue_name)
2290 {
2291 queue_vars_valid = true;
Pavel Labath3a29f8b2015-07-28 09:18:32 +00002292 queue_name = object->GetStringValue();
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002293 }
2294 else if (key == g_key_queue_kind)
2295 {
2296 std::string queue_kind_str = object->GetStringValue();
2297 if (queue_kind_str == "serial")
2298 {
2299 queue_vars_valid = true;
2300 queue_kind = eQueueKindSerial;
2301 }
2302 else if (queue_kind_str == "concurrent")
2303 {
2304 queue_vars_valid = true;
2305 queue_kind = eQueueKindConcurrent;
2306 }
2307 }
Jason Molenda26d84e82016-01-08 00:20:48 +00002308 else if (key == g_key_queue_serial_number)
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002309 {
Jason Molenda26d84e82016-01-08 00:20:48 +00002310 queue_serial_number = object->GetIntegerValue(0);
2311 if (queue_serial_number != 0)
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002312 queue_vars_valid = true;
2313 }
Jason Molenda77f89352016-01-12 07:09:16 +00002314 else if (key == g_key_dispatch_queue_t)
2315 {
2316 dispatch_queue_t = object->GetIntegerValue(0);
2317 if (dispatch_queue_t != 0 && dispatch_queue_t != LLDB_INVALID_ADDRESS)
2318 queue_vars_valid = true;
2319 }
2320 else if (key == g_key_associated_with_dispatch_queue)
2321 {
2322 queue_vars_valid = true;
2323 bool associated = object->GetBooleanValue ();
2324 if (associated)
2325 associated_with_dispatch_queue = eLazyBoolYes;
2326 else
2327 associated_with_dispatch_queue = eLazyBoolNo;
2328 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002329 else if (key == g_key_reason)
2330 {
Pavel Labath3a29f8b2015-07-28 09:18:32 +00002331 reason = object->GetStringValue();
Greg Clayton358cf1e2015-06-25 21:46:34 +00002332 }
2333 else if (key == g_key_description)
2334 {
Pavel Labath3a29f8b2015-07-28 09:18:32 +00002335 description = object->GetStringValue();
Greg Clayton358cf1e2015-06-25 21:46:34 +00002336 }
2337 else if (key == g_key_registers)
2338 {
2339 StructuredData::Dictionary *registers_dict = object->GetAsDictionary();
2340
2341 if (registers_dict)
2342 {
2343 registers_dict->ForEach([&expedited_register_map](ConstString key, StructuredData::Object* object) -> bool {
2344 const uint32_t reg = StringConvert::ToUInt32 (key.GetCString(), UINT32_MAX, 10);
2345 if (reg != UINT32_MAX)
Pavel Labath3a29f8b2015-07-28 09:18:32 +00002346 expedited_register_map[reg] = object->GetStringValue();
Greg Clayton358cf1e2015-06-25 21:46:34 +00002347 return true; // Keep iterating through all array items
2348 });
2349 }
2350 }
2351 else if (key == g_key_memory)
2352 {
2353 StructuredData::Array *array = object->GetAsArray();
2354 if (array)
2355 {
2356 array->ForEach([this](StructuredData::Object* object) -> bool {
2357 StructuredData::Dictionary *mem_cache_dict = object->GetAsDictionary();
2358 if (mem_cache_dict)
2359 {
2360 lldb::addr_t mem_cache_addr = LLDB_INVALID_ADDRESS;
2361 if (mem_cache_dict->GetValueForKeyAsInteger<lldb::addr_t>("address", mem_cache_addr))
2362 {
2363 if (mem_cache_addr != LLDB_INVALID_ADDRESS)
2364 {
2365 StringExtractor bytes;
2366 if (mem_cache_dict->GetValueForKeyAsString("bytes", bytes.GetStringRef()))
2367 {
2368 bytes.SetFilePos(0);
2369
2370 const size_t byte_size = bytes.GetStringRef().size()/2;
2371 DataBufferSP data_buffer_sp(new DataBufferHeap(byte_size, 0));
2372 const size_t bytes_copied = bytes.GetHexBytes (data_buffer_sp->GetBytes(), byte_size, 0);
2373 if (bytes_copied == byte_size)
2374 m_memory_cache.AddL1CacheData(mem_cache_addr, data_buffer_sp);
2375 }
2376 }
2377 }
2378 }
2379 return true; // Keep iterating through all array items
2380 });
2381 }
Eugene Zelenko0722f082015-10-24 01:28:05 +00002382
Greg Clayton358cf1e2015-06-25 21:46:34 +00002383 }
Pavel Labath4a4bb122015-07-16 14:14:35 +00002384 else if (key == g_key_signal)
2385 signo = object->GetIntegerValue(LLDB_INVALID_SIGNAL_NUMBER);
Greg Clayton358cf1e2015-06-25 21:46:34 +00002386 return true; // Keep iterating through all dictionary key/value pairs
2387 });
2388
Greg Clayton2e309072015-07-17 23:42:28 +00002389 return SetThreadStopInfo (tid,
2390 expedited_register_map,
2391 signo,
2392 thread_name,
2393 reason,
2394 description,
2395 exc_type,
2396 exc_data,
2397 thread_dispatch_qaddr,
2398 queue_vars_valid,
Jason Molenda77f89352016-01-12 07:09:16 +00002399 associated_with_dispatch_queue,
2400 dispatch_queue_t,
Greg Clayton2e309072015-07-17 23:42:28 +00002401 queue_name,
2402 queue_kind,
Jason Molenda26d84e82016-01-08 00:20:48 +00002403 queue_serial_number);
Greg Clayton358cf1e2015-06-25 21:46:34 +00002404}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002405
2406StateType
2407ProcessGDBRemote::SetThreadStopInfo (StringExtractor& stop_packet)
2408{
Greg Claytondd0e5a52011-06-02 22:22:38 +00002409 stop_packet.SetFilePos (0);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002410 const char stop_type = stop_packet.GetChar();
2411 switch (stop_type)
2412 {
2413 case 'T':
2414 case 'S':
2415 {
Greg Clayton15fc2be2013-05-21 01:00:52 +00002416 // This is a bit of a hack, but is is required. If we did exec, we
2417 // need to clear our thread lists and also know to rebuild our dynamic
2418 // register info before we lookup and threads and populate the expedited
2419 // register values so we need to know this right away so we can cleanup
2420 // and update our registers.
Greg Clayton8cda7f02013-05-21 21:55:59 +00002421 const uint32_t stop_id = GetStopID();
2422 if (stop_id == 0)
Greg Claytone576ab22011-02-15 00:19:15 +00002423 {
2424 // Our first stop, make sure we have a process ID, and also make
2425 // sure we know about our registers
2426 if (GetID() == LLDB_INVALID_PROCESS_ID)
2427 {
Greg Claytonc574ede2011-03-10 02:26:48 +00002428 lldb::pid_t pid = m_gdb_comm.GetCurrentProcessID ();
Greg Claytone576ab22011-02-15 00:19:15 +00002429 if (pid != LLDB_INVALID_PROCESS_ID)
2430 SetID (pid);
2431 }
2432 BuildDynamicRegisterInfo (true);
2433 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002434 // Stop with signal and thread info
Greg Clayton358cf1e2015-06-25 21:46:34 +00002435 lldb::tid_t tid = LLDB_INVALID_THREAD_ID;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002436 const uint8_t signo = stop_packet.GetHexU8();
Greg Clayton358cf1e2015-06-25 21:46:34 +00002437 std::string key;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002438 std::string value;
2439 std::string thread_name;
Greg Claytona658fd22011-06-04 01:26:29 +00002440 std::string reason;
2441 std::string description;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002442 uint32_t exc_type = 0;
Greg Clayton896dff62010-07-23 16:45:51 +00002443 std::vector<addr_t> exc_data;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002444 addr_t thread_dispatch_qaddr = LLDB_INVALID_ADDRESS;
Greg Clayton0b90be12015-06-23 21:27:50 +00002445 bool queue_vars_valid = false; // says if locals below that start with "queue_" are valid
Jason Molenda77f89352016-01-12 07:09:16 +00002446 addr_t dispatch_queue_t = LLDB_INVALID_ADDRESS;
2447 LazyBool associated_with_dispatch_queue = eLazyBoolCalculate;
Greg Clayton0b90be12015-06-23 21:27:50 +00002448 std::string queue_name;
2449 QueueKind queue_kind = eQueueKindUnknown;
Jason Molenda26d84e82016-01-08 00:20:48 +00002450 uint64_t queue_serial_number = 0;
Greg Clayton358cf1e2015-06-25 21:46:34 +00002451 ExpeditedRegisterMap expedited_register_map;
2452 while (stop_packet.GetNameColonValue(key, value))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002453 {
Greg Clayton358cf1e2015-06-25 21:46:34 +00002454 if (key.compare("metype") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002455 {
2456 // exception type in big endian hex
Vince Harron5275aaa2015-01-15 20:08:35 +00002457 exc_type = StringConvert::ToUInt32 (value.c_str(), 0, 16);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002458 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002459 else if (key.compare("medata") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002460 {
2461 // exception data in big endian hex
Vince Harron5275aaa2015-01-15 20:08:35 +00002462 exc_data.push_back(StringConvert::ToUInt64 (value.c_str(), 0, 16));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002463 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002464 else if (key.compare("thread") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002465 {
2466 // thread in big endian hex
Greg Clayton358cf1e2015-06-25 21:46:34 +00002467 tid = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_THREAD_ID, 16);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002468 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002469 else if (key.compare("threads") == 0)
Greg Clayton9e920902012-04-10 02:25:43 +00002470 {
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00002471 std::lock_guard<std::recursive_mutex> guard(m_thread_list_real.GetMutex());
2472
Greg Clayton9e920902012-04-10 02:25:43 +00002473 m_thread_ids.clear();
Greg Clayton44633992012-04-10 03:22:03 +00002474 // A comma separated list of all threads in the current
2475 // process that includes the thread for this stop reply
2476 // packet
Greg Clayton9e920902012-04-10 02:25:43 +00002477 size_t comma_pos;
2478 lldb::tid_t tid;
2479 while ((comma_pos = value.find(',')) != std::string::npos)
2480 {
2481 value[comma_pos] = '\0';
2482 // thread in big endian hex
Vince Harron5275aaa2015-01-15 20:08:35 +00002483 tid = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_THREAD_ID, 16);
Greg Clayton9e920902012-04-10 02:25:43 +00002484 if (tid != LLDB_INVALID_THREAD_ID)
2485 m_thread_ids.push_back (tid);
2486 value.erase(0, comma_pos + 1);
Greg Clayton9e920902012-04-10 02:25:43 +00002487 }
Vince Harron5275aaa2015-01-15 20:08:35 +00002488 tid = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_THREAD_ID, 16);
Greg Clayton9e920902012-04-10 02:25:43 +00002489 if (tid != LLDB_INVALID_THREAD_ID)
2490 m_thread_ids.push_back (tid);
2491 }
Jason Molenda545304d2015-12-18 00:45:35 +00002492 else if (key.compare("thread-pcs") == 0)
2493 {
2494 m_thread_pcs.clear();
2495 // A comma separated list of all threads in the current
2496 // process that includes the thread for this stop reply
2497 // packet
2498 size_t comma_pos;
2499 lldb::addr_t pc;
2500 while ((comma_pos = value.find(',')) != std::string::npos)
2501 {
2502 value[comma_pos] = '\0';
2503 // thread in big endian hex
2504 pc = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_ADDRESS, 16);
2505 if (pc != LLDB_INVALID_ADDRESS)
2506 m_thread_pcs.push_back (pc);
2507 value.erase(0, comma_pos + 1);
2508 }
2509 pc = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_ADDRESS, 16);
2510 if (pc != LLDB_INVALID_ADDRESS)
2511 m_thread_pcs.push_back (pc);
2512 }
Greg Clayton2e309072015-07-17 23:42:28 +00002513 else if (key.compare("jstopinfo") == 0)
Greg Claytona5801ad2015-07-15 22:59:03 +00002514 {
2515 StringExtractor json_extractor;
2516 // Swap "value" over into "name_extractor"
2517 json_extractor.GetStringRef().swap(value);
2518 // Now convert the HEX bytes into a string value
2519 json_extractor.GetHexByteString (value);
2520
2521 // This JSON contains thread IDs and thread stop info for all threads.
2522 // It doesn't contain expedited registers, memory or queue info.
Greg Clayton2e309072015-07-17 23:42:28 +00002523 m_jstopinfo_sp = StructuredData::ParseJSON (value);
Greg Claytona5801ad2015-07-15 22:59:03 +00002524 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002525 else if (key.compare("hexname") == 0)
Greg Claytonde9d0492011-01-08 03:17:57 +00002526 {
2527 StringExtractor name_extractor;
2528 // Swap "value" over into "name_extractor"
2529 name_extractor.GetStringRef().swap(value);
2530 // Now convert the HEX bytes into a string value
2531 name_extractor.GetHexByteString (value);
2532 thread_name.swap (value);
2533 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002534 else if (key.compare("name") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002535 {
2536 thread_name.swap (value);
2537 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002538 else if (key.compare("qaddr") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002539 {
Vince Harron5275aaa2015-01-15 20:08:35 +00002540 thread_dispatch_qaddr = StringConvert::ToUInt64 (value.c_str(), 0, 16);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002541 }
Jason Molenda77f89352016-01-12 07:09:16 +00002542 else if (key.compare("dispatch_queue_t") == 0)
2543 {
2544 queue_vars_valid = true;
2545 dispatch_queue_t = StringConvert::ToUInt64 (value.c_str(), 0, 16);
2546 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002547 else if (key.compare("qname") == 0)
Greg Clayton0b90be12015-06-23 21:27:50 +00002548 {
2549 queue_vars_valid = true;
2550 StringExtractor name_extractor;
2551 // Swap "value" over into "name_extractor"
2552 name_extractor.GetStringRef().swap(value);
2553 // Now convert the HEX bytes into a string value
2554 name_extractor.GetHexByteString (value);
2555 queue_name.swap (value);
2556 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002557 else if (key.compare("qkind") == 0)
Greg Clayton0b90be12015-06-23 21:27:50 +00002558 {
Greg Clayton0b90be12015-06-23 21:27:50 +00002559 if (value == "serial")
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002560 {
2561 queue_vars_valid = true;
Greg Clayton0b90be12015-06-23 21:27:50 +00002562 queue_kind = eQueueKindSerial;
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002563 }
Greg Clayton0b90be12015-06-23 21:27:50 +00002564 else if (value == "concurrent")
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002565 {
2566 queue_vars_valid = true;
Greg Clayton0b90be12015-06-23 21:27:50 +00002567 queue_kind = eQueueKindConcurrent;
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002568 }
Greg Clayton0b90be12015-06-23 21:27:50 +00002569 }
Jason Molenda26d84e82016-01-08 00:20:48 +00002570 else if (key.compare("qserialnum") == 0)
Greg Clayton0b90be12015-06-23 21:27:50 +00002571 {
Jason Molenda26d84e82016-01-08 00:20:48 +00002572 queue_serial_number = StringConvert::ToUInt64 (value.c_str(), 0, 0);
2573 if (queue_serial_number != 0)
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002574 queue_vars_valid = true;
Greg Clayton0b90be12015-06-23 21:27:50 +00002575 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002576 else if (key.compare("reason") == 0)
Greg Claytona658fd22011-06-04 01:26:29 +00002577 {
2578 reason.swap(value);
2579 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002580 else if (key.compare("description") == 0)
Greg Claytona658fd22011-06-04 01:26:29 +00002581 {
2582 StringExtractor desc_extractor;
2583 // Swap "value" over into "name_extractor"
2584 desc_extractor.GetStringRef().swap(value);
2585 // Now convert the HEX bytes into a string value
Chaoren Lin28e57422015-02-03 01:51:25 +00002586 desc_extractor.GetHexByteString (value);
2587 description.swap(value);
Greg Claytona658fd22011-06-04 01:26:29 +00002588 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002589 else if (key.compare("memory") == 0)
Greg Clayton3e06bd92011-01-09 21:07:35 +00002590 {
Greg Clayton358cf1e2015-06-25 21:46:34 +00002591 // Expedited memory. GDB servers can choose to send back expedited memory
2592 // that can populate the L1 memory cache in the process so that things like
2593 // the frame pointer backchain can be expedited. This will help stack
2594 // backtracing be more efficient by not having to send as many memory read
2595 // requests down the remote GDB server.
Chaoren Lin7a306082015-06-23 03:17:01 +00002596
Greg Clayton358cf1e2015-06-25 21:46:34 +00002597 // Key/value pair format: memory:<addr>=<bytes>;
2598 // <addr> is a number whose base will be interpreted by the prefix:
2599 // "0x[0-9a-fA-F]+" for hex
2600 // "0[0-7]+" for octal
2601 // "[1-9]+" for decimal
2602 // <bytes> is native endian ASCII hex bytes just like the register values
2603 llvm::StringRef value_ref(value);
2604 std::pair<llvm::StringRef, llvm::StringRef> pair;
2605 pair = value_ref.split('=');
2606 if (!pair.first.empty() && !pair.second.empty())
2607 {
2608 std::string addr_str(pair.first.str());
2609 const lldb::addr_t mem_cache_addr = StringConvert::ToUInt64(addr_str.c_str(), LLDB_INVALID_ADDRESS, 0);
2610 if (mem_cache_addr != LLDB_INVALID_ADDRESS)
Greg Clayton3e06bd92011-01-09 21:07:35 +00002611 {
Greg Clayton358cf1e2015-06-25 21:46:34 +00002612 StringExtractor bytes;
Pavel Labath3a29f8b2015-07-28 09:18:32 +00002613 bytes.GetStringRef() = pair.second.str();
Greg Clayton358cf1e2015-06-25 21:46:34 +00002614 const size_t byte_size = bytes.GetStringRef().size()/2;
2615 DataBufferSP data_buffer_sp(new DataBufferHeap(byte_size, 0));
2616 const size_t bytes_copied = bytes.GetHexBytes (data_buffer_sp->GetBytes(), byte_size, 0);
2617 if (bytes_copied == byte_size)
2618 m_memory_cache.AddL1CacheData(mem_cache_addr, data_buffer_sp);
Greg Clayton3e06bd92011-01-09 21:07:35 +00002619 }
2620 }
2621 }
Jaydeep Patil725666c2015-08-13 03:46:01 +00002622 else if (key.compare("watch") == 0 || key.compare("rwatch") == 0 || key.compare("awatch") == 0)
2623 {
2624 // Support standard GDB remote stop reply packet 'TAAwatch:addr'
2625 lldb::addr_t wp_addr = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_ADDRESS, 16);
2626 WatchpointSP wp_sp = GetTarget().GetWatchpointList().FindByAddress(wp_addr);
2627 uint32_t wp_index = LLDB_INVALID_INDEX32;
2628
2629 if (wp_sp)
2630 wp_index = wp_sp->GetHardwareIndex();
2631
2632 reason = "watchpoint";
2633 StreamString ostr;
2634 ostr.Printf("%" PRIu64 " %" PRIu32, wp_addr, wp_index);
2635 description = ostr.GetString().c_str();
2636 }
Stephane Sezer2618e912015-08-21 16:51:56 +00002637 else if (key.compare("library") == 0)
2638 {
2639 LoadModules();
2640 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002641 else if (key.size() == 2 && ::isxdigit(key[0]) && ::isxdigit(key[1]))
2642 {
2643 uint32_t reg = StringConvert::ToUInt32 (key.c_str(), UINT32_MAX, 16);
2644 if (reg != UINT32_MAX)
2645 expedited_register_map[reg] = std::move(value);
2646 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002647 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002648
Bhushan D. Attarde1e271df2015-07-24 04:06:20 +00002649 if (tid == LLDB_INVALID_THREAD_ID)
2650 {
Ed Maste81b4c5f2016-01-04 01:43:47 +00002651 // A thread id may be invalid if the response is old style 'S' packet which does not provide the
Bhushan D. Attarde1e271df2015-07-24 04:06:20 +00002652 // thread information. So update the thread list and choose the first one.
2653 UpdateThreadIDList ();
Ed Maste81b4c5f2016-01-04 01:43:47 +00002654
Bhushan D. Attarde1e271df2015-07-24 04:06:20 +00002655 if (!m_thread_ids.empty ())
2656 {
2657 tid = m_thread_ids.front ();
2658 }
2659 }
2660
Greg Clayton358cf1e2015-06-25 21:46:34 +00002661 ThreadSP thread_sp = SetThreadStopInfo (tid,
2662 expedited_register_map,
2663 signo,
2664 thread_name,
2665 reason,
2666 description,
2667 exc_type,
2668 exc_data,
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002669 thread_dispatch_qaddr,
2670 queue_vars_valid,
Jason Molenda77f89352016-01-12 07:09:16 +00002671 associated_with_dispatch_queue,
2672 dispatch_queue_t,
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002673 queue_name,
2674 queue_kind,
Jason Molenda26d84e82016-01-08 00:20:48 +00002675 queue_serial_number);
Greg Clayton358cf1e2015-06-25 21:46:34 +00002676
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002677 return eStateStopped;
2678 }
2679 break;
2680
2681 case 'W':
Todd Fialaff6131a2014-05-19 04:57:23 +00002682 case 'X':
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002683 // process exited
2684 return eStateExited;
2685
2686 default:
2687 break;
2688 }
2689 return eStateInvalid;
2690}
2691
2692void
2693ProcessGDBRemote::RefreshStateAfterStop ()
2694{
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00002695 std::lock_guard<std::recursive_mutex> guard(m_thread_list_real.GetMutex());
2696
Greg Clayton9e920902012-04-10 02:25:43 +00002697 m_thread_ids.clear();
Jason Molenda545304d2015-12-18 00:45:35 +00002698 m_thread_pcs.clear();
Greg Clayton9e920902012-04-10 02:25:43 +00002699 // Set the thread stop info. It might have a "threads" key whose value is
2700 // a list of all thread IDs in the current process, so m_thread_ids might
2701 // get set.
Ewan Crawford9aa2da002015-05-27 14:12:34 +00002702
2703 // Scope for the lock
2704 {
2705 // Lock the thread stack while we access it
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +00002706 std::lock_guard<std::recursive_mutex> guard(m_last_stop_packet_mutex);
Ewan Crawford9aa2da002015-05-27 14:12:34 +00002707 // Get the number of stop packets on the stack
2708 int nItems = m_stop_packet_stack.size();
2709 // Iterate over them
2710 for (int i = 0; i < nItems; i++)
2711 {
2712 // Get the thread stop info
2713 StringExtractorGDBRemote stop_info = m_stop_packet_stack[i];
2714 // Process thread stop info
2715 SetThreadStopInfo(stop_info);
2716 }
2717 // Clear the thread stop stack
2718 m_stop_packet_stack.clear();
2719 }
2720
Greg Clayton9e920902012-04-10 02:25:43 +00002721 // Check to see if SetThreadStopInfo() filled in m_thread_ids?
2722 if (m_thread_ids.empty())
2723 {
2724 // No, we need to fetch the thread list manually
2725 UpdateThreadIDList();
2726 }
2727
Ewan Crawford78baa192015-05-13 09:18:18 +00002728 // If we have queried for a default thread id
2729 if (m_initial_tid != LLDB_INVALID_THREAD_ID)
2730 {
2731 m_thread_list.SetSelectedThreadByID(m_initial_tid);
2732 m_initial_tid = LLDB_INVALID_THREAD_ID;
2733 }
2734
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002735 // Let all threads recover from stopping and do any clean up based
2736 // on the previous thread state (if any).
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00002737 m_thread_list_real.RefreshStateAfterStop();
Ed Maste81b4c5f2016-01-04 01:43:47 +00002738
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002739}
2740
2741Error
Jim Ingham0d8bcc72010-11-17 02:32:00 +00002742ProcessGDBRemote::DoHalt (bool &caused_stop)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002743{
2744 Error error;
Jim Ingham0d8bcc72010-11-17 02:32:00 +00002745
Greg Clayton513c26c2011-01-29 07:10:55 +00002746 if (m_public_state.GetValue() == eStateAttaching)
Greg Clayton3af9ea52010-11-18 05:57:03 +00002747 {
Greg Clayton513c26c2011-01-29 07:10:55 +00002748 // We are being asked to halt during an attach. We need to just close
2749 // our file handle and debugserver will go away, and we can be done...
2750 m_gdb_comm.Disconnect();
Greg Clayton3af9ea52010-11-18 05:57:03 +00002751 }
Greg Clayton513c26c2011-01-29 07:10:55 +00002752 else
Pavel Labath8c1b6bd2016-08-09 12:04:46 +00002753 caused_stop = m_gdb_comm.Interrupt();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002754 return error;
2755}
2756
2757Error
Jim Inghamacff8952013-05-02 00:27:30 +00002758ProcessGDBRemote::DoDetach(bool keep_stopped)
Greg Clayton594e5ed2010-09-27 21:07:38 +00002759{
2760 Error error;
Greg Clayton5160ce52013-03-27 23:08:40 +00002761 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Greg Clayton594e5ed2010-09-27 21:07:38 +00002762 if (log)
Jim Inghamacff8952013-05-02 00:27:30 +00002763 log->Printf ("ProcessGDBRemote::DoDetach(keep_stopped: %i)", keep_stopped);
Ed Maste81b4c5f2016-01-04 01:43:47 +00002764
Jim Inghamacff8952013-05-02 00:27:30 +00002765 error = m_gdb_comm.Detach (keep_stopped);
Greg Clayton58d1c9a2010-10-18 04:14:23 +00002766 if (log)
Greg Clayton594e5ed2010-09-27 21:07:38 +00002767 {
Jim Inghamacff8952013-05-02 00:27:30 +00002768 if (error.Success())
Greg Clayton58d1c9a2010-10-18 04:14:23 +00002769 log->PutCString ("ProcessGDBRemote::DoDetach() detach packet sent successfully");
2770 else
Jim Inghamacff8952013-05-02 00:27:30 +00002771 log->Printf ("ProcessGDBRemote::DoDetach() detach packet send failed: %s", error.AsCString() ? error.AsCString() : "<unknown error>");
Greg Clayton594e5ed2010-09-27 21:07:38 +00002772 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00002773
Jim Inghamacff8952013-05-02 00:27:30 +00002774 if (!error.Success())
2775 return error;
2776
Greg Clayton58d1c9a2010-10-18 04:14:23 +00002777 // Sleep for one second to let the process get all detached...
Greg Clayton594e5ed2010-09-27 21:07:38 +00002778 StopAsyncThread ();
Greg Clayton58d1c9a2010-10-18 04:14:23 +00002779
Greg Clayton58d1c9a2010-10-18 04:14:23 +00002780 SetPrivateState (eStateDetached);
2781 ResumePrivateStateThread();
2782
2783 //KillDebugserverProcess ();
Greg Clayton594e5ed2010-09-27 21:07:38 +00002784 return error;
2785}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002786
Eugene Zelenko0722f082015-10-24 01:28:05 +00002787
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002788Error
2789ProcessGDBRemote::DoDestroy ()
2790{
2791 Error error;
Greg Clayton5160ce52013-03-27 23:08:40 +00002792 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002793 if (log)
2794 log->Printf ("ProcessGDBRemote::DoDestroy()");
2795
Jim Ingham43c555d2012-07-04 00:35:43 +00002796 // There is a bug in older iOS debugservers where they don't shut down the process
2797 // they are debugging properly. If the process is sitting at a breakpoint or an exception,
2798 // this can cause problems with restarting. So we check to see if any of our threads are stopped
2799 // at a breakpoint, and if so we remove all the breakpoints, resume the process, and THEN
2800 // destroy it again.
2801 //
2802 // Note, we don't have a good way to test the version of debugserver, but I happen to know that
2803 // the set of all the iOS debugservers which don't support GetThreadSuffixSupported() and that of
2804 // the debugservers with this bug are equal. There really should be a better way to test this!
2805 //
2806 // We also use m_destroy_tried_resuming to make sure we only do this once, if we resume and then halt and
2807 // get called here to destroy again and we're still at a breakpoint or exception, then we should
2808 // just do the straight-forward kill.
2809 //
2810 // And of course, if we weren't able to stop the process by the time we get here, it isn't
2811 // necessary (or helpful) to do any of this.
2812
2813 if (!m_gdb_comm.GetThreadSuffixSupported() && m_public_state.GetValue() != eStateRunning)
2814 {
2815 PlatformSP platform_sp = GetTarget().GetPlatform();
Ed Maste81b4c5f2016-01-04 01:43:47 +00002816
Jim Ingham43c555d2012-07-04 00:35:43 +00002817 // FIXME: These should be ConstStrings so we aren't doing strcmp'ing.
2818 if (platform_sp
2819 && platform_sp->GetName()
Greg Clayton57abc5d2013-05-10 21:47:16 +00002820 && platform_sp->GetName() == PlatformRemoteiOS::GetPluginNameStatic())
Jim Ingham43c555d2012-07-04 00:35:43 +00002821 {
2822 if (m_destroy_tried_resuming)
2823 {
2824 if (log)
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00002825 log->PutCString ("ProcessGDBRemote::DoDestroy() - Tried resuming to destroy once already, not doing it again.");
Jim Ingham43c555d2012-07-04 00:35:43 +00002826 }
2827 else
Ed Maste81b4c5f2016-01-04 01:43:47 +00002828 {
Jim Ingham43c555d2012-07-04 00:35:43 +00002829 // At present, the plans are discarded and the breakpoints disabled Process::Destroy,
2830 // but we really need it to happen here and it doesn't matter if we do it twice.
2831 m_thread_list.DiscardThreadPlans();
2832 DisableAllBreakpointSites();
Ed Maste81b4c5f2016-01-04 01:43:47 +00002833
Jim Ingham43c555d2012-07-04 00:35:43 +00002834 bool stop_looks_like_crash = false;
2835 ThreadList &threads = GetThreadList();
Ed Maste81b4c5f2016-01-04 01:43:47 +00002836
Jim Ingham43c555d2012-07-04 00:35:43 +00002837 {
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00002838 std::lock_guard<std::recursive_mutex> guard(threads.GetMutex());
Ed Maste81b4c5f2016-01-04 01:43:47 +00002839
Jim Ingham43c555d2012-07-04 00:35:43 +00002840 size_t num_threads = threads.GetSize();
2841 for (size_t i = 0; i < num_threads; i++)
2842 {
2843 ThreadSP thread_sp = threads.GetThreadAtIndex(i);
Greg Clayton6e0ff1a2013-05-09 01:55:29 +00002844 StopInfoSP stop_info_sp = thread_sp->GetPrivateStopInfo();
Jim Ingham43c555d2012-07-04 00:35:43 +00002845 StopReason reason = eStopReasonInvalid;
2846 if (stop_info_sp)
2847 reason = stop_info_sp->GetStopReason();
2848 if (reason == eStopReasonBreakpoint
2849 || reason == eStopReasonException)
2850 {
2851 if (log)
Greg Clayton160c9d82013-05-01 21:54:04 +00002852 log->Printf ("ProcessGDBRemote::DoDestroy() - thread: 0x%4.4" PRIx64 " stopped with reason: %s.",
2853 thread_sp->GetProtocolID(),
Jim Ingham43c555d2012-07-04 00:35:43 +00002854 stop_info_sp->GetDescription());
2855 stop_looks_like_crash = true;
2856 break;
2857 }
2858 }
2859 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00002860
Jim Ingham43c555d2012-07-04 00:35:43 +00002861 if (stop_looks_like_crash)
2862 {
2863 if (log)
2864 log->PutCString ("ProcessGDBRemote::DoDestroy() - Stopped at a breakpoint, continue and then kill.");
2865 m_destroy_tried_resuming = true;
Ed Maste81b4c5f2016-01-04 01:43:47 +00002866
2867 // If we are going to run again before killing, it would be good to suspend all the threads
Jim Ingham43c555d2012-07-04 00:35:43 +00002868 // before resuming so they won't get into more trouble. Sadly, for the threads stopped with
2869 // the breakpoint or exception, the exception doesn't get cleared if it is suspended, so we do
2870 // have to run the risk of letting those threads proceed a bit.
Ed Maste81b4c5f2016-01-04 01:43:47 +00002871
Jim Ingham43c555d2012-07-04 00:35:43 +00002872 {
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00002873 std::lock_guard<std::recursive_mutex> guard(threads.GetMutex());
Ed Maste81b4c5f2016-01-04 01:43:47 +00002874
Jim Ingham43c555d2012-07-04 00:35:43 +00002875 size_t num_threads = threads.GetSize();
2876 for (size_t i = 0; i < num_threads; i++)
2877 {
2878 ThreadSP thread_sp = threads.GetThreadAtIndex(i);
Greg Clayton6e0ff1a2013-05-09 01:55:29 +00002879 StopInfoSP stop_info_sp = thread_sp->GetPrivateStopInfo();
Jim Ingham43c555d2012-07-04 00:35:43 +00002880 StopReason reason = eStopReasonInvalid;
2881 if (stop_info_sp)
2882 reason = stop_info_sp->GetStopReason();
2883 if (reason != eStopReasonBreakpoint
2884 && reason != eStopReasonException)
2885 {
2886 if (log)
Greg Clayton160c9d82013-05-01 21:54:04 +00002887 log->Printf ("ProcessGDBRemote::DoDestroy() - Suspending thread: 0x%4.4" PRIx64 " before running.",
2888 thread_sp->GetProtocolID());
Jim Ingham43c555d2012-07-04 00:35:43 +00002889 thread_sp->SetResumeState(eStateSuspended);
2890 }
2891 }
2892 }
2893 Resume ();
Jason Molendaede31932015-04-17 05:01:58 +00002894 return Destroy(false);
Jim Ingham43c555d2012-07-04 00:35:43 +00002895 }
2896 }
2897 }
2898 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00002899
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002900 // Interrupt if our inferior is running...
Jim Inghambabfc382012-06-06 00:32:39 +00002901 int exit_status = SIGABRT;
2902 std::string exit_string;
2903
Greg Clayton6ed95942011-01-22 07:12:45 +00002904 if (m_gdb_comm.IsConnected())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002905 {
Jim Inghamaab78372011-10-28 01:11:35 +00002906 if (m_public_state.GetValue() != eStateAttaching)
Greg Clayton6779606a2011-01-22 23:43:18 +00002907 {
Greg Clayton513c26c2011-01-29 07:10:55 +00002908 StringExtractorGDBRemote response;
2909 bool send_async = true;
Tamas Berghammer912800c2015-02-24 10:23:39 +00002910 GDBRemoteCommunication::ScopedTimeout (m_gdb_comm, 3);
Filipe Cabecinhas9e106052012-08-22 13:25:58 +00002911
Greg Clayton3dedae12013-12-06 21:45:27 +00002912 if (m_gdb_comm.SendPacketAndWaitForResponse("k", 1, response, send_async) == GDBRemoteCommunication::PacketResult::Success)
Greg Clayton513c26c2011-01-29 07:10:55 +00002913 {
2914 char packet_cmd = response.GetChar(0);
2915
2916 if (packet_cmd == 'W' || packet_cmd == 'X')
2917 {
Jim Inghameac0aa42014-02-21 22:36:11 +00002918#if defined(__APPLE__)
Jason Molenda17b45392016-06-23 04:24:16 +00002919 // For Native processes on Mac OS X, we launch through the Host Platform, then hand the process off
Jim Ingham9d67cc52014-02-21 22:35:29 +00002920 // to debugserver, which becomes the parent process through "PT_ATTACH". Then when we go to kill
Jason Molenda17b45392016-06-23 04:24:16 +00002921 // the process on Mac OS X we call ptrace(PT_KILL) to kill it, then we call waitpid which returns
Jim Ingham9d67cc52014-02-21 22:35:29 +00002922 // with no error and the correct status. But amusingly enough that doesn't seem to actually reap
2923 // the process, but instead it is left around as a Zombie. Probably the kernel is in the process of
2924 // switching ownership back to lldb which was the original parent, and gets confused in the handoff.
2925 // Anyway, so call waitpid here to finally reap it.
2926 PlatformSP platform_sp(GetTarget().GetPlatform());
2927 if (platform_sp && platform_sp->IsHost())
2928 {
2929 int status;
2930 ::pid_t reap_pid;
2931 reap_pid = waitpid (GetID(), &status, WNOHANG);
2932 if (log)
2933 log->Printf ("Reaped pid: %d, status: %d.\n", reap_pid, status);
2934 }
2935#endif
Greg Clayton09c3e3d2011-12-06 04:51:14 +00002936 SetLastStopPacket (response);
Greg Clayton9e920902012-04-10 02:25:43 +00002937 ClearThreadIDList ();
Jim Inghambabfc382012-06-06 00:32:39 +00002938 exit_status = response.GetHexU8();
2939 }
2940 else
2941 {
2942 if (log)
2943 log->Printf ("ProcessGDBRemote::DoDestroy - got unexpected response to k packet: %s", response.GetStringRef().c_str());
2944 exit_string.assign("got unexpected response to k packet: ");
2945 exit_string.append(response.GetStringRef());
Greg Clayton513c26c2011-01-29 07:10:55 +00002946 }
2947 }
2948 else
2949 {
Jim Inghambabfc382012-06-06 00:32:39 +00002950 if (log)
2951 log->Printf ("ProcessGDBRemote::DoDestroy - failed to send k packet");
2952 exit_string.assign("failed to send the k packet");
Greg Clayton513c26c2011-01-29 07:10:55 +00002953 }
Greg Clayton6779606a2011-01-22 23:43:18 +00002954 }
Jim Inghambabfc382012-06-06 00:32:39 +00002955 else
2956 {
2957 if (log)
Ed Masteb3a53332014-03-17 17:05:22 +00002958 log->Printf ("ProcessGDBRemote::DoDestroy - killed or interrupted while attaching");
Jim Inghamcfc09352012-07-27 23:57:19 +00002959 exit_string.assign ("killed or interrupted while attaching.");
Jim Inghambabfc382012-06-06 00:32:39 +00002960 }
Greg Clayton6779606a2011-01-22 23:43:18 +00002961 }
Jim Inghambabfc382012-06-06 00:32:39 +00002962 else
2963 {
2964 // If we missed setting the exit status on the way out, do it here.
2965 // NB set exit status can be called multiple times, the first one sets the status.
2966 exit_string.assign("destroying when not connected to debugserver");
2967 }
2968
2969 SetExitStatus(exit_status, exit_string.c_str());
2970
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002971 StopAsyncThread ();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002972 KillDebugserverProcess ();
2973 return error;
2974}
2975
Greg Clayton8cda7f02013-05-21 21:55:59 +00002976void
2977ProcessGDBRemote::SetLastStopPacket (const StringExtractorGDBRemote &response)
2978{
Greg Clayton8cda7f02013-05-21 21:55:59 +00002979 const bool did_exec = response.GetStringRef().find(";reason:exec;") != std::string::npos;
2980 if (did_exec)
2981 {
2982 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
2983 if (log)
2984 log->Printf ("ProcessGDBRemote::SetLastStopPacket () - detected exec");
2985
2986 m_thread_list_real.Clear();
2987 m_thread_list.Clear();
2988 BuildDynamicRegisterInfo (true);
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002989 m_gdb_comm.ResetDiscoverableSettings (did_exec);
Greg Clayton8cda7f02013-05-21 21:55:59 +00002990 }
Ewan Crawford9aa2da002015-05-27 14:12:34 +00002991
2992 // Scope the lock
2993 {
2994 // Lock the thread stack while we access it
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +00002995 std::lock_guard<std::recursive_mutex> guard(m_last_stop_packet_mutex);
Greg Clayton2e309072015-07-17 23:42:28 +00002996
2997 // We are are not using non-stop mode, there can only be one last stop
2998 // reply packet, so clear the list.
2999 if (GetTarget().GetNonStopModeEnabled() == false)
3000 m_stop_packet_stack.clear();
3001
Ewan Crawford9aa2da002015-05-27 14:12:34 +00003002 // Add this stop packet to the stop packet stack
3003 // This stack will get popped and examined when we switch to the
3004 // Stopped state
3005 m_stop_packet_stack.push_back(response);
3006 }
Greg Clayton8cda7f02013-05-21 21:55:59 +00003007}
3008
Chaoren Linc963a222015-09-01 16:58:45 +00003009void
3010ProcessGDBRemote::SetUnixSignals(const UnixSignalsSP &signals_sp)
3011{
3012 Process::SetUnixSignals(std::make_shared<GDBRemoteSignals>(signals_sp));
3013}
3014
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003015//------------------------------------------------------------------
3016// Process Queries
3017//------------------------------------------------------------------
3018
3019bool
3020ProcessGDBRemote::IsAlive ()
3021{
Jason Molenda1d3b3562015-11-05 23:54:29 +00003022 return m_gdb_comm.IsConnected() && Process::IsAlive();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003023}
3024
3025addr_t
3026ProcessGDBRemote::GetImageInfoAddress()
3027{
Aidan Doddsc0c83852015-05-08 09:36:31 +00003028 // request the link map address via the $qShlibInfoAddr packet
3029 lldb::addr_t addr = m_gdb_comm.GetShlibInfoAddr();
3030
3031 // the loaded module list can also provides a link map address
3032 if (addr == LLDB_INVALID_ADDRESS)
3033 {
Stephane Sezer87b0fe02016-01-12 19:02:41 +00003034 LoadedModuleInfoList list;
Aidan Doddsc0c83852015-05-08 09:36:31 +00003035 if (GetLoadedModuleList (list).Success())
3036 addr = list.m_link_map;
3037 }
3038
3039 return addr;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003040}
3041
Greg Clayton2e309072015-07-17 23:42:28 +00003042void
3043ProcessGDBRemote::WillPublicStop ()
3044{
3045 // See if the GDB remote client supports the JSON threads info.
3046 // If so, we gather stop info for all threads, expedited registers,
3047 // expedited memory, runtime queue information (iOS and MacOSX only),
3048 // and more. Expediting memory will help stack backtracing be much
3049 // faster. Expediting registers will make sure we don't have to read
3050 // the thread registers for GPRs.
3051 m_jthreadsinfo_sp = m_gdb_comm.GetThreadsInfo();
3052
3053 if (m_jthreadsinfo_sp)
3054 {
3055 // Now set the stop info for each thread and also expedite any registers
3056 // and memory that was in the jThreadsInfo response.
3057 StructuredData::Array *thread_infos = m_jthreadsinfo_sp->GetAsArray();
3058 if (thread_infos)
3059 {
3060 const size_t n = thread_infos->GetSize();
3061 for (size_t i=0; i<n; ++i)
3062 {
3063 StructuredData::Dictionary *thread_dict = thread_infos->GetItemAtIndex(i)->GetAsDictionary();
3064 if (thread_dict)
3065 SetThreadStopInfo(thread_dict);
3066 }
3067 }
3068 }
3069}
3070
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003071//------------------------------------------------------------------
3072// Process Memory
3073//------------------------------------------------------------------
3074size_t
3075ProcessGDBRemote::DoReadMemory (addr_t addr, void *buf, size_t size, Error &error)
3076{
Jason Molenda6076bf42014-05-06 04:34:52 +00003077 GetMaxMemorySize ();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003078 if (size > m_max_memory_size)
3079 {
3080 // Keep memory read sizes down to a sane limit. This function will be
Ed Maste81b4c5f2016-01-04 01:43:47 +00003081 // called multiple times in order to complete the task by
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003082 // lldb_private::Process so it is ok to do this.
3083 size = m_max_memory_size;
3084 }
3085
3086 char packet[64];
Jason Molenda6076bf42014-05-06 04:34:52 +00003087 int packet_len;
3088 bool binary_memory_read = m_gdb_comm.GetxPacketSupported();
Pavel Labath3bf11252015-10-14 12:59:37 +00003089 packet_len = ::snprintf(packet, sizeof(packet), "%c%" PRIx64 ",%" PRIx64,
3090 binary_memory_read ? 'x' : 'm', (uint64_t)addr, (uint64_t)size);
Andy Gibbsa297a972013-06-19 19:04:53 +00003091 assert (packet_len + 1 < (int)sizeof(packet));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003092 StringExtractorGDBRemote response;
Greg Clayton3dedae12013-12-06 21:45:27 +00003093 if (m_gdb_comm.SendPacketAndWaitForResponse(packet, packet_len, response, true) == GDBRemoteCommunication::PacketResult::Success)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003094 {
Greg Clayton576d8832011-03-22 04:00:09 +00003095 if (response.IsNormalResponse())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003096 {
3097 error.Clear();
Jason Molenda6076bf42014-05-06 04:34:52 +00003098 if (binary_memory_read)
3099 {
3100 // The lower level GDBRemoteCommunication packet receive layer has already de-quoted any
3101 // 0x7d character escaping that was present in the packet
3102
3103 size_t data_received_size = response.GetBytesLeft();
3104 if (data_received_size > size)
3105 {
3106 // Don't write past the end of BUF if the remote debug server gave us too
3107 // much data for some reason.
3108 data_received_size = size;
3109 }
3110 memcpy (buf, response.GetStringRef().data(), data_received_size);
3111 return data_received_size;
3112 }
3113 else
3114 {
3115 return response.GetHexBytes(buf, size, '\xdd');
3116 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003117 }
Greg Clayton576d8832011-03-22 04:00:09 +00003118 else if (response.IsErrorResponse())
Greg Claytonb9d5df52012-12-06 22:49:16 +00003119 error.SetErrorStringWithFormat("memory read failed for 0x%" PRIx64, addr);
Greg Clayton576d8832011-03-22 04:00:09 +00003120 else if (response.IsUnsupportedResponse())
Greg Clayton9944cd72012-09-19 01:46:31 +00003121 error.SetErrorStringWithFormat("GDB server does not support reading memory");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003122 else
Greg Clayton9944cd72012-09-19 01:46:31 +00003123 error.SetErrorStringWithFormat("unexpected response to GDB server memory read packet '%s': '%s'", packet, response.GetStringRef().c_str());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003124 }
3125 else
3126 {
Jim Ingham35579dd2013-06-03 19:34:01 +00003127 error.SetErrorStringWithFormat("failed to send packet: '%s'", packet);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003128 }
3129 return 0;
3130}
3131
3132size_t
3133ProcessGDBRemote::DoWriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
3134{
Jason Molenda6076bf42014-05-06 04:34:52 +00003135 GetMaxMemorySize ();
Greg Claytonb4aaf2e2011-05-16 02:35:02 +00003136 if (size > m_max_memory_size)
3137 {
3138 // Keep memory read sizes down to a sane limit. This function will be
Ed Maste81b4c5f2016-01-04 01:43:47 +00003139 // called multiple times in order to complete the task by
Greg Claytonb4aaf2e2011-05-16 02:35:02 +00003140 // lldb_private::Process so it is ok to do this.
3141 size = m_max_memory_size;
3142 }
3143
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003144 StreamString packet;
Daniel Malead01b2952012-11-29 21:49:15 +00003145 packet.Printf("M%" PRIx64 ",%" PRIx64 ":", addr, (uint64_t)size);
Bruce Mitchener9ccb9702015-11-07 04:40:13 +00003146 packet.PutBytesAsRawHex8(buf, size, endian::InlHostByteOrder(), endian::InlHostByteOrder());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003147 StringExtractorGDBRemote response;
Greg Clayton3dedae12013-12-06 21:45:27 +00003148 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetData(), packet.GetSize(), response, true) == GDBRemoteCommunication::PacketResult::Success)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003149 {
Greg Clayton576d8832011-03-22 04:00:09 +00003150 if (response.IsOKResponse())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003151 {
3152 error.Clear();
3153 return size;
3154 }
Greg Clayton576d8832011-03-22 04:00:09 +00003155 else if (response.IsErrorResponse())
Greg Claytonb9d5df52012-12-06 22:49:16 +00003156 error.SetErrorStringWithFormat("memory write failed for 0x%" PRIx64, addr);
Greg Clayton576d8832011-03-22 04:00:09 +00003157 else if (response.IsUnsupportedResponse())
Greg Clayton9944cd72012-09-19 01:46:31 +00003158 error.SetErrorStringWithFormat("GDB server does not support writing memory");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003159 else
Greg Clayton9944cd72012-09-19 01:46:31 +00003160 error.SetErrorStringWithFormat("unexpected response to GDB server memory write packet '%s': '%s'", packet.GetString().c_str(), response.GetStringRef().c_str());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003161 }
3162 else
3163 {
Jim Ingham35579dd2013-06-03 19:34:01 +00003164 error.SetErrorStringWithFormat("failed to send packet: '%s'", packet.GetString().c_str());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003165 }
3166 return 0;
3167}
3168
3169lldb::addr_t
3170ProcessGDBRemote::DoAllocateMemory (size_t size, uint32_t permissions, Error &error)
3171{
Tamas Berghammerdb264a62015-03-31 09:52:22 +00003172 Log *log (GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS|LIBLLDB_LOG_EXPRESSIONS));
Greg Clayton2a48f522011-05-14 01:50:35 +00003173 addr_t allocated_addr = LLDB_INVALID_ADDRESS;
Ed Maste81b4c5f2016-01-04 01:43:47 +00003174
Greg Claytoncec91ef2016-02-26 01:20:20 +00003175 if (m_gdb_comm.SupportsAllocDeallocMemory() != eLazyBoolNo)
Greg Clayton2a48f522011-05-14 01:50:35 +00003176 {
Greg Claytoncec91ef2016-02-26 01:20:20 +00003177 allocated_addr = m_gdb_comm.AllocateMemory (size, permissions);
3178 if (allocated_addr != LLDB_INVALID_ADDRESS || m_gdb_comm.SupportsAllocDeallocMemory() == eLazyBoolYes)
3179 return allocated_addr;
3180 }
Greg Clayton2a48f522011-05-14 01:50:35 +00003181
Greg Claytoncec91ef2016-02-26 01:20:20 +00003182 if (m_gdb_comm.SupportsAllocDeallocMemory() == eLazyBoolNo)
3183 {
3184 // Call mmap() to create memory in the inferior..
3185 unsigned prot = 0;
3186 if (permissions & lldb::ePermissionsReadable)
3187 prot |= eMmapProtRead;
3188 if (permissions & lldb::ePermissionsWritable)
3189 prot |= eMmapProtWrite;
3190 if (permissions & lldb::ePermissionsExecutable)
3191 prot |= eMmapProtExec;
Greg Clayton2a48f522011-05-14 01:50:35 +00003192
Greg Claytoncec91ef2016-02-26 01:20:20 +00003193 if (InferiorCallMmap(this, allocated_addr, 0, size, prot,
3194 eMmapFlagsAnon | eMmapFlagsPrivate, -1, 0))
3195 m_addr_to_mmap_size[allocated_addr] = size;
3196 else
3197 {
3198 allocated_addr = LLDB_INVALID_ADDRESS;
3199 if (log)
3200 log->Printf ("ProcessGDBRemote::%s no direct stub support for memory allocation, and InferiorCallMmap also failed - is stub missing register context save/restore capability?", __FUNCTION__);
3201 }
Greg Clayton2a48f522011-05-14 01:50:35 +00003202 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00003203
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003204 if (allocated_addr == LLDB_INVALID_ADDRESS)
Daniel Malead01b2952012-11-29 21:49:15 +00003205 error.SetErrorStringWithFormat("unable to allocate %" PRIu64 " bytes of memory with permissions %s", (uint64_t)size, GetPermissionsAsCString (permissions));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003206 else
3207 error.Clear();
3208 return allocated_addr;
3209}
3210
3211Error
Ed Maste81b4c5f2016-01-04 01:43:47 +00003212ProcessGDBRemote::GetMemoryRegionInfo (addr_t load_addr,
Greg Clayton46fb5582011-11-18 07:03:08 +00003213 MemoryRegionInfo &region_info)
3214{
Ed Maste81b4c5f2016-01-04 01:43:47 +00003215
Greg Clayton46fb5582011-11-18 07:03:08 +00003216 Error error (m_gdb_comm.GetMemoryRegionInfo (load_addr, region_info));
3217 return error;
3218}
3219
3220Error
Johnny Chen64637202012-05-23 21:09:52 +00003221ProcessGDBRemote::GetWatchpointSupportInfo (uint32_t &num)
3222{
Ed Maste81b4c5f2016-01-04 01:43:47 +00003223
Johnny Chen64637202012-05-23 21:09:52 +00003224 Error error (m_gdb_comm.GetWatchpointSupportInfo (num));
3225 return error;
3226}
3227
3228Error
Enrico Granataf04a2192012-07-13 23:18:48 +00003229ProcessGDBRemote::GetWatchpointSupportInfo (uint32_t &num, bool& after)
3230{
Jaydeep Patil725666c2015-08-13 03:46:01 +00003231 Error error (m_gdb_comm.GetWatchpointSupportInfo (num, after, GetTarget().GetArchitecture()));
Enrico Granataf04a2192012-07-13 23:18:48 +00003232 return error;
3233}
3234
3235Error
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003236ProcessGDBRemote::DoDeallocateMemory (lldb::addr_t addr)
3237{
Ed Maste81b4c5f2016-01-04 01:43:47 +00003238 Error error;
Greg Clayton70b57652011-05-15 01:25:55 +00003239 LazyBool supported = m_gdb_comm.SupportsAllocDeallocMemory();
3240
3241 switch (supported)
3242 {
3243 case eLazyBoolCalculate:
Ed Maste81b4c5f2016-01-04 01:43:47 +00003244 // We should never be deallocating memory without allocating memory
Greg Clayton70b57652011-05-15 01:25:55 +00003245 // first so we should never get eLazyBoolCalculate
3246 error.SetErrorString ("tried to deallocate memory without ever allocating memory");
3247 break;
3248
3249 case eLazyBoolYes:
3250 if (!m_gdb_comm.DeallocateMemory (addr))
Daniel Malead01b2952012-11-29 21:49:15 +00003251 error.SetErrorStringWithFormat("unable to deallocate memory at 0x%" PRIx64, addr);
Greg Clayton70b57652011-05-15 01:25:55 +00003252 break;
Ed Maste81b4c5f2016-01-04 01:43:47 +00003253
Greg Clayton70b57652011-05-15 01:25:55 +00003254 case eLazyBoolNo:
Peter Collingbourne99f9aa02011-06-03 20:40:38 +00003255 // Call munmap() to deallocate memory in the inferior..
Greg Clayton70b57652011-05-15 01:25:55 +00003256 {
3257 MMapMap::iterator pos = m_addr_to_mmap_size.find(addr);
Peter Collingbourne99f9aa02011-06-03 20:40:38 +00003258 if (pos != m_addr_to_mmap_size.end() &&
3259 InferiorCallMunmap(this, addr, pos->second))
3260 m_addr_to_mmap_size.erase (pos);
3261 else
Daniel Malead01b2952012-11-29 21:49:15 +00003262 error.SetErrorStringWithFormat("unable to deallocate memory at 0x%" PRIx64, addr);
Greg Clayton70b57652011-05-15 01:25:55 +00003263 }
3264 break;
3265 }
3266
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003267 return error;
3268}
3269
Eugene Zelenko0722f082015-10-24 01:28:05 +00003270
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003271//------------------------------------------------------------------
3272// Process STDIO
3273//------------------------------------------------------------------
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003274size_t
3275ProcessGDBRemote::PutSTDIN (const char *src, size_t src_len, Error &error)
3276{
3277 if (m_stdio_communication.IsConnected())
3278 {
3279 ConnectionStatus status;
3280 m_stdio_communication.Write(src, src_len, status, NULL);
3281 }
Vince Harrondf3f00f2015-02-10 21:09:04 +00003282 else if (m_stdin_forward)
Vince Harrone0be4252015-02-06 18:32:57 +00003283 {
3284 m_gdb_comm.SendStdinNotification(src, src_len);
3285 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003286 return 0;
3287}
3288
3289Error
Jim Ingham299c0c12013-02-15 02:06:30 +00003290ProcessGDBRemote::EnableBreakpointSite (BreakpointSite *bp_site)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003291{
3292 Error error;
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003293 assert(bp_site != NULL);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003294
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003295 // Get logging info
3296 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_BREAKPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003297 user_id_t site_id = bp_site->GetID();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003298
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003299 // Get the breakpoint address
3300 const addr_t addr = bp_site->GetLoadAddress();
3301
3302 // Log that a breakpoint was requested
3303 if (log)
3304 log->Printf("ProcessGDBRemote::EnableBreakpointSite (size_id = %" PRIu64 ") address = 0x%" PRIx64, site_id, (uint64_t)addr);
3305
3306 // Breakpoint already exists and is enabled
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003307 if (bp_site->IsEnabled())
3308 {
3309 if (log)
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003310 log->Printf("ProcessGDBRemote::EnableBreakpointSite (size_id = %" PRIu64 ") address = 0x%" PRIx64 " -- SUCCESS (already enabled)", site_id, (uint64_t)addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003311 return error;
3312 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003313
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003314 // Get the software breakpoint trap opcode size
3315 const size_t bp_op_size = GetSoftwareBreakpointTrapOpcode(bp_site);
3316
3317 // SupportsGDBStoppointPacket() simply checks a boolean, indicating if this breakpoint type
3318 // is supported by the remote stub. These are set to true by default, and later set to false
3319 // only after we receive an unimplemented response when sending a breakpoint packet. This means
3320 // initially that unless we were specifically instructed to use a hardware breakpoint, LLDB will
3321 // attempt to set a software breakpoint. HardwareRequired() also queries a boolean variable which
3322 // indicates if the user specifically asked for hardware breakpoints. If true then we will
3323 // skip over software breakpoints.
3324 if (m_gdb_comm.SupportsGDBStoppointPacket(eBreakpointSoftware) && (!bp_site->HardwareRequired()))
3325 {
3326 // Try to send off a software breakpoint packet ($Z0)
Jim Ingham906d91e2016-05-19 02:13:44 +00003327 uint8_t error_no = m_gdb_comm.SendGDBStoppointTypePacket(eBreakpointSoftware, true, addr, bp_op_size);
3328 if (error_no == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003329 {
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003330 // The breakpoint was placed successfully
3331 bp_site->SetEnabled(true);
3332 bp_site->SetType(BreakpointSite::eExternal);
Greg Claytoneb023e72013-10-11 19:48:25 +00003333 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003334 }
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003335
3336 // SendGDBStoppointTypePacket() will return an error if it was unable to set this
3337 // breakpoint. We need to differentiate between a error specific to placing this breakpoint
3338 // or if we have learned that this breakpoint type is unsupported. To do this, we
3339 // must test the support boolean for this breakpoint type to see if it now indicates that
3340 // this breakpoint type is unsupported. If they are still supported then we should return
3341 // with the error code. If they are now unsupported, then we would like to fall through
3342 // and try another form of breakpoint.
3343 if (m_gdb_comm.SupportsGDBStoppointPacket(eBreakpointSoftware))
Jim Ingham906d91e2016-05-19 02:13:44 +00003344 {
3345 if (error_no != UINT8_MAX)
3346 error.SetErrorStringWithFormat("error: %d sending the breakpoint request", errno);
3347 else
3348 error.SetErrorString("error sending the breakpoint request");
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003349 return error;
Jim Ingham906d91e2016-05-19 02:13:44 +00003350 }
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003351
3352 // We reach here when software breakpoints have been found to be unsupported. For future
3353 // calls to set a breakpoint, we will not attempt to set a breakpoint with a type that is
3354 // known not to be supported.
3355 if (log)
3356 log->Printf("Software breakpoints are unsupported");
3357
3358 // So we will fall through and try a hardware breakpoint
3359 }
3360
3361 // The process of setting a hardware breakpoint is much the same as above. We check the
3362 // supported boolean for this breakpoint type, and if it is thought to be supported then we
3363 // will try to set this breakpoint with a hardware breakpoint.
3364 if (m_gdb_comm.SupportsGDBStoppointPacket(eBreakpointHardware))
3365 {
3366 // Try to send off a hardware breakpoint packet ($Z1)
Jim Ingham906d91e2016-05-19 02:13:44 +00003367 uint8_t error_no = m_gdb_comm.SendGDBStoppointTypePacket(eBreakpointHardware, true, addr, bp_op_size);
3368 if (error_no == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003369 {
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003370 // The breakpoint was placed successfully
3371 bp_site->SetEnabled(true);
3372 bp_site->SetType(BreakpointSite::eHardware);
3373 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003374 }
Greg Clayton8b82f082011-04-12 05:54:46 +00003375
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003376 // Check if the error was something other then an unsupported breakpoint type
3377 if (m_gdb_comm.SupportsGDBStoppointPacket(eBreakpointHardware))
3378 {
3379 // Unable to set this hardware breakpoint
Jim Ingham906d91e2016-05-19 02:13:44 +00003380 if (error_no != UINT8_MAX)
3381 error.SetErrorStringWithFormat("error: %d sending the hardware breakpoint request "
3382 "(hardware breakpoint resources might be exhausted or unavailable)",
3383 error_no);
3384 else
3385 error.SetErrorString("error sending the hardware breakpoint request (hardware breakpoint resources "
3386 "might be exhausted or unavailable)");
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003387 return error;
3388 }
3389
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00003390 // We will reach here when the stub gives an unsupported response to a hardware breakpoint
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003391 if (log)
3392 log->Printf("Hardware breakpoints are unsupported");
3393
3394 // Finally we will falling through to a #trap style breakpoint
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003395 }
3396
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003397 // Don't fall through when hardware breakpoints were specifically requested
3398 if (bp_site->HardwareRequired())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003399 {
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003400 error.SetErrorString("hardware breakpoints are not supported");
3401 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003402 }
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003403
3404 // As a last resort we want to place a manual breakpoint. An instruction
3405 // is placed into the process memory using memory write packets.
3406 return EnableSoftwareBreakpoint(bp_site);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003407}
3408
3409Error
Jim Ingham299c0c12013-02-15 02:06:30 +00003410ProcessGDBRemote::DisableBreakpointSite (BreakpointSite *bp_site)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003411{
3412 Error error;
3413 assert (bp_site != NULL);
3414 addr_t addr = bp_site->GetLoadAddress();
3415 user_id_t site_id = bp_site->GetID();
Greg Clayton5160ce52013-03-27 23:08:40 +00003416 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_BREAKPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003417 if (log)
Jim Ingham299c0c12013-02-15 02:06:30 +00003418 log->Printf ("ProcessGDBRemote::DisableBreakpointSite (site_id = %" PRIu64 ") addr = 0x%8.8" PRIx64, site_id, (uint64_t)addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003419
3420 if (bp_site->IsEnabled())
3421 {
3422 const size_t bp_op_size = GetSoftwareBreakpointTrapOpcode (bp_site);
3423
Greg Clayton8b82f082011-04-12 05:54:46 +00003424 BreakpointSite::Type bp_type = bp_site->GetType();
3425 switch (bp_type)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003426 {
Greg Clayton8b82f082011-04-12 05:54:46 +00003427 case BreakpointSite::eSoftware:
3428 error = DisableSoftwareBreakpoint (bp_site);
3429 break;
3430
3431 case BreakpointSite::eHardware:
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003432 if (m_gdb_comm.SendGDBStoppointTypePacket(eBreakpointHardware, false, addr, bp_op_size))
Greg Clayton8b82f082011-04-12 05:54:46 +00003433 error.SetErrorToGenericError();
3434 break;
3435
3436 case BreakpointSite::eExternal:
Jim Inghama04ef752014-03-07 11:18:02 +00003437 {
3438 GDBStoppointType stoppoint_type;
3439 if (bp_site->IsHardware())
3440 stoppoint_type = eBreakpointHardware;
3441 else
3442 stoppoint_type = eBreakpointSoftware;
Ed Maste81b4c5f2016-01-04 01:43:47 +00003443
Jim Inghama04ef752014-03-07 11:18:02 +00003444 if (m_gdb_comm.SendGDBStoppointTypePacket(stoppoint_type, false, addr, bp_op_size))
Greg Clayton8b82f082011-04-12 05:54:46 +00003445 error.SetErrorToGenericError();
Jim Inghama04ef752014-03-07 11:18:02 +00003446 }
Greg Clayton8b82f082011-04-12 05:54:46 +00003447 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003448 }
Greg Clayton8b82f082011-04-12 05:54:46 +00003449 if (error.Success())
3450 bp_site->SetEnabled(false);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003451 }
3452 else
3453 {
3454 if (log)
Jim Ingham299c0c12013-02-15 02:06:30 +00003455 log->Printf ("ProcessGDBRemote::DisableBreakpointSite (site_id = %" PRIu64 ") addr = 0x%8.8" PRIx64 " -- SUCCESS (already disabled)", site_id, (uint64_t)addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003456 return error;
3457 }
3458
3459 if (error.Success())
3460 error.SetErrorToGenericError();
3461 return error;
3462}
3463
Johnny Chen11309a32011-09-06 22:38:36 +00003464// Pre-requisite: wp != NULL.
3465static GDBStoppointType
Johnny Chen01a67862011-10-14 00:42:25 +00003466GetGDBStoppointType (Watchpoint *wp)
Johnny Chen11309a32011-09-06 22:38:36 +00003467{
3468 assert(wp);
3469 bool watch_read = wp->WatchpointRead();
3470 bool watch_write = wp->WatchpointWrite();
3471
3472 // watch_read and watch_write cannot both be false.
3473 assert(watch_read || watch_write);
3474 if (watch_read && watch_write)
3475 return eWatchpointReadWrite;
Johnny Chen6d487a92011-09-09 20:35:15 +00003476 else if (watch_read)
Johnny Chen11309a32011-09-06 22:38:36 +00003477 return eWatchpointRead;
Johnny Chen6d487a92011-09-09 20:35:15 +00003478 else // Must be watch_write, then.
Johnny Chen11309a32011-09-06 22:38:36 +00003479 return eWatchpointWrite;
3480}
3481
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003482Error
Jim Ingham1b5792e2012-12-18 02:03:49 +00003483ProcessGDBRemote::EnableWatchpoint (Watchpoint *wp, bool notify)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003484{
3485 Error error;
3486 if (wp)
3487 {
3488 user_id_t watchID = wp->GetID();
3489 addr_t addr = wp->GetLoadAddress();
Greg Clayton5160ce52013-03-27 23:08:40 +00003490 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_WATCHPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003491 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00003492 log->Printf ("ProcessGDBRemote::EnableWatchpoint(watchID = %" PRIu64 ")", watchID);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003493 if (wp->IsEnabled())
3494 {
3495 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00003496 log->Printf("ProcessGDBRemote::EnableWatchpoint(watchID = %" PRIu64 ") addr = 0x%8.8" PRIx64 ": watchpoint already enabled.", watchID, (uint64_t)addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003497 return error;
3498 }
Johnny Chen11309a32011-09-06 22:38:36 +00003499
3500 GDBStoppointType type = GetGDBStoppointType(wp);
3501 // Pass down an appropriate z/Z packet...
3502 if (m_gdb_comm.SupportsGDBStoppointPacket (type))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003503 {
Johnny Chen11309a32011-09-06 22:38:36 +00003504 if (m_gdb_comm.SendGDBStoppointTypePacket(type, true, addr, wp->GetByteSize()) == 0)
3505 {
Jim Ingham1b5792e2012-12-18 02:03:49 +00003506 wp->SetEnabled(true, notify);
Johnny Chen11309a32011-09-06 22:38:36 +00003507 return error;
3508 }
3509 else
3510 error.SetErrorString("sending gdb watchpoint packet failed");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003511 }
Johnny Chen11309a32011-09-06 22:38:36 +00003512 else
3513 error.SetErrorString("watchpoints not supported");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003514 }
3515 else
3516 {
Johnny Chen01a67862011-10-14 00:42:25 +00003517 error.SetErrorString("Watchpoint argument was NULL.");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003518 }
3519 if (error.Success())
3520 error.SetErrorToGenericError();
3521 return error;
3522}
3523
3524Error
Jim Ingham1b5792e2012-12-18 02:03:49 +00003525ProcessGDBRemote::DisableWatchpoint (Watchpoint *wp, bool notify)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003526{
3527 Error error;
3528 if (wp)
3529 {
3530 user_id_t watchID = wp->GetID();
3531
Greg Clayton5160ce52013-03-27 23:08:40 +00003532 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_WATCHPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003533
3534 addr_t addr = wp->GetLoadAddress();
Jim Ingham1b5792e2012-12-18 02:03:49 +00003535
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003536 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00003537 log->Printf ("ProcessGDBRemote::DisableWatchpoint (watchID = %" PRIu64 ") addr = 0x%8.8" PRIx64, watchID, (uint64_t)addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003538
Johnny Chen11309a32011-09-06 22:38:36 +00003539 if (!wp->IsEnabled())
3540 {
3541 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00003542 log->Printf ("ProcessGDBRemote::DisableWatchpoint (watchID = %" PRIu64 ") addr = 0x%8.8" PRIx64 " -- SUCCESS (already disabled)", watchID, (uint64_t)addr);
Johnny Chen892943f2012-08-23 22:28:26 +00003543 // See also 'class WatchpointSentry' within StopInfo.cpp.
3544 // This disabling attempt might come from the user-supplied actions, we'll route it in order for
3545 // the watchpoint object to intelligently process this action.
Jim Ingham1b5792e2012-12-18 02:03:49 +00003546 wp->SetEnabled(false, notify);
Johnny Chen11309a32011-09-06 22:38:36 +00003547 return error;
3548 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00003549
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003550 if (wp->IsHardware())
3551 {
Johnny Chen11309a32011-09-06 22:38:36 +00003552 GDBStoppointType type = GetGDBStoppointType(wp);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003553 // Pass down an appropriate z/Z packet...
Johnny Chen11309a32011-09-06 22:38:36 +00003554 if (m_gdb_comm.SendGDBStoppointTypePacket(type, false, addr, wp->GetByteSize()) == 0)
3555 {
Jim Ingham1b5792e2012-12-18 02:03:49 +00003556 wp->SetEnabled(false, notify);
Johnny Chen11309a32011-09-06 22:38:36 +00003557 return error;
3558 }
3559 else
Ed Maste81b4c5f2016-01-04 01:43:47 +00003560 error.SetErrorString("sending gdb watchpoint packet failed");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003561 }
3562 // TODO: clear software watchpoints if we implement them
3563 }
3564 else
3565 {
Johnny Chen01a67862011-10-14 00:42:25 +00003566 error.SetErrorString("Watchpoint argument was NULL.");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003567 }
3568 if (error.Success())
3569 error.SetErrorToGenericError();
3570 return error;
3571}
3572
3573void
3574ProcessGDBRemote::Clear()
3575{
3576 m_flags = 0;
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00003577 m_thread_list_real.Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003578 m_thread_list.Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003579}
3580
3581Error
3582ProcessGDBRemote::DoSignal (int signo)
3583{
3584 Error error;
Greg Clayton5160ce52013-03-27 23:08:40 +00003585 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003586 if (log)
3587 log->Printf ("ProcessGDBRemote::DoSignal (signal = %d)", signo);
3588
3589 if (!m_gdb_comm.SendAsyncSignal (signo))
3590 error.SetErrorStringWithFormat("failed to send signal %i", signo);
3591 return error;
3592}
3593
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003594Error
Oleksiy Vyalovafd6ce42015-11-23 19:32:24 +00003595ProcessGDBRemote::EstablishConnectionIfNeeded (const ProcessInfo &process_info)
3596{
3597 // Make sure we aren't already connected?
3598 if (m_gdb_comm.IsConnected())
3599 return Error();
3600
3601 PlatformSP platform_sp (GetTarget ().GetPlatform ());
3602 if (platform_sp && !platform_sp->IsHost ())
3603 return Error("Lost debug server connection");
3604
3605 auto error = LaunchAndConnectToDebugserver (process_info);
3606 if (error.Fail())
3607 {
3608 const char *error_string = error.AsCString();
3609 if (error_string == nullptr)
3610 error_string = "unable to launch " DEBUGSERVER_BASENAME;
3611 }
3612 return error;
3613}
Greg Claytonc6c420f2016-08-12 16:46:18 +00003614#if defined (__APPLE__)
3615#define USE_SOCKETPAIR_FOR_LOCAL_CONNECTION 1
3616#endif
3617
3618#ifdef USE_SOCKETPAIR_FOR_LOCAL_CONNECTION
3619static bool SetCloexecFlag(int fd)
3620{
3621#if defined(FD_CLOEXEC)
3622 int flags = ::fcntl(fd, F_GETFD);
3623 if (flags == -1)
3624 return false;
3625 return (::fcntl(fd, F_SETFD, flags | FD_CLOEXEC) == 0);
3626#else
3627 return false;
3628#endif
3629}
3630#endif
Oleksiy Vyalovafd6ce42015-11-23 19:32:24 +00003631
3632Error
Greg Clayton91a9b2472013-12-04 19:19:12 +00003633ProcessGDBRemote::LaunchAndConnectToDebugserver (const ProcessInfo &process_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003634{
Pavel Labath998bdc52016-05-11 16:59:04 +00003635 using namespace std::placeholders; // For _1, _2, etc.
3636
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003637 Error error;
3638 if (m_debugserver_pid == LLDB_INVALID_PROCESS_ID)
3639 {
3640 // If we locate debugserver, keep that located version around
3641 static FileSpec g_debugserver_file_spec;
3642
Han Ming Ong84647042012-02-25 01:07:38 +00003643 ProcessLaunchInfo debugserver_launch_info;
Oleksiy Vyalovf8ce61c2015-01-28 17:36:59 +00003644 // Make debugserver run in its own session so signals generated by
3645 // special terminal key sequences (^C) don't affect debugserver.
3646 debugserver_launch_info.SetLaunchInSeparateProcessGroup(true);
3647
Pavel Labath194357c2016-05-12 11:10:01 +00003648 const std::weak_ptr<ProcessGDBRemote> this_wp = std::static_pointer_cast<ProcessGDBRemote>(shared_from_this());
3649 debugserver_launch_info.SetMonitorProcessCallback(std::bind(MonitorDebugserverProcess, this_wp, _1, _2, _3, _4),
Pavel Labath998bdc52016-05-11 16:59:04 +00003650 false);
Greg Clayton91a9b2472013-12-04 19:19:12 +00003651 debugserver_launch_info.SetUserID(process_info.GetUserID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003652
Greg Claytonfda4fab2014-01-10 22:24:11 +00003653
Greg Claytonc6c420f2016-08-12 16:46:18 +00003654 int communication_fd = -1;
3655#ifdef USE_SOCKETPAIR_FOR_LOCAL_CONNECTION
3656 // Auto close the sockets we might open up unless everything goes OK. This
3657 // helps us not leak file descriptors when things go wrong.
3658 lldb_utility::CleanUp <int, int> our_socket(-1, -1, close);
3659 lldb_utility::CleanUp <int, int> gdb_socket(-1, -1, close);
3660
3661 // Use a socketpair on Apple for now until other platforms can verify it
3662 // works and is fast enough
Oleksiy Vyalov9fe526c2015-10-21 19:34:26 +00003663 {
Greg Claytonc6c420f2016-08-12 16:46:18 +00003664 int sockets[2]; /* the pair of socket descriptors */
3665 if (socketpair(AF_UNIX, SOCK_STREAM, 0, sockets) == -1)
3666 {
3667 error.SetErrorToErrno();
3668 return error;
3669 }
3670
3671 our_socket.set(sockets[0]);
3672 gdb_socket.set(sockets[1]);
Oleksiy Vyalov9fe526c2015-10-21 19:34:26 +00003673 }
3674
Greg Claytonc6c420f2016-08-12 16:46:18 +00003675 // Don't let any child processes inherit our communication socket
3676 SetCloexecFlag(our_socket.get());
3677 communication_fd = gdb_socket.get();
3678#endif
3679
3680 error = m_gdb_comm.StartDebugserverProcess(nullptr, GetTarget().GetPlatform().get(), debugserver_launch_info, nullptr, nullptr, communication_fd);
Greg Clayton91a9b2472013-12-04 19:19:12 +00003681
3682 if (error.Success ())
3683 m_debugserver_pid = debugserver_launch_info.GetProcessID();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003684 else
Greg Clayton91a9b2472013-12-04 19:19:12 +00003685 m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003686
3687 if (m_debugserver_pid != LLDB_INVALID_PROCESS_ID)
Greg Claytonc6c420f2016-08-12 16:46:18 +00003688 {
3689#ifdef USE_SOCKETPAIR_FOR_LOCAL_CONNECTION
3690 // Our process spawned correctly, we can now set our connection to use our
3691 // end of the socket pair
3692 m_gdb_comm.SetConnection(new ConnectionFileDescriptor(our_socket.release(), true));
3693#endif
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003694 StartAsyncThread ();
Greg Claytonc6c420f2016-08-12 16:46:18 +00003695 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00003696
Greg Clayton91a9b2472013-12-04 19:19:12 +00003697 if (error.Fail())
3698 {
3699 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
3700
3701 if (log)
3702 log->Printf("failed to start debugserver process: %s", error.AsCString());
3703 return error;
3704 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00003705
Greg Clayton00fe87b2013-12-05 22:58:22 +00003706 if (m_gdb_comm.IsConnected())
3707 {
3708 // Finish the connection process by doing the handshake without connecting (send NULL URL)
Greg Claytonc6c420f2016-08-12 16:46:18 +00003709 ConnectToDebugserver(NULL);
Greg Clayton00fe87b2013-12-05 22:58:22 +00003710 }
3711 else
3712 {
Greg Claytonc6c420f2016-08-12 16:46:18 +00003713 error.SetErrorString("connection failed");
Greg Clayton00fe87b2013-12-05 22:58:22 +00003714 }
Greg Clayton91a9b2472013-12-04 19:19:12 +00003715
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003716 }
3717 return error;
3718}
3719
3720bool
Pavel Labath194357c2016-05-12 11:10:01 +00003721ProcessGDBRemote::MonitorDebugserverProcess(std::weak_ptr<ProcessGDBRemote> process_wp, lldb::pid_t debugserver_pid,
Pavel Labath998bdc52016-05-11 16:59:04 +00003722 bool exited, // True if the process did exit
3723 int signo, // Zero for no signal
3724 int exit_status // Exit value of process if signal is zero
3725 )
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003726{
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003727 // "debugserver_pid" argument passed in is the process ID for
3728 // debugserver that we are tracking...
Greg Clayton5160ce52013-03-27 23:08:40 +00003729 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Pavel Labath194357c2016-05-12 11:10:01 +00003730 const bool handled = true;
Greg Claytone4e45922011-11-16 05:37:56 +00003731
Greg Clayton6779606a2011-01-22 23:43:18 +00003732 if (log)
Pavel Labath194357c2016-05-12 11:10:01 +00003733 log->Printf("ProcessGDBRemote::%s(process_wp, pid=%" PRIu64 ", signo=%i (0x%x), exit_status=%i)", __FUNCTION__,
3734 debugserver_pid, signo, signo, exit_status);
Greg Clayton6779606a2011-01-22 23:43:18 +00003735
Pavel Labath194357c2016-05-12 11:10:01 +00003736 std::shared_ptr<ProcessGDBRemote> process_sp = process_wp.lock();
3737 if (log)
Saleem Abdulrasoolabdfc212016-05-15 18:18:13 +00003738 log->Printf("ProcessGDBRemote::%s(process = %p)", __FUNCTION__, static_cast<void *>(process_sp.get()));
Pavel Labath194357c2016-05-12 11:10:01 +00003739 if (!process_sp || process_sp->m_debugserver_pid != debugserver_pid)
3740 return handled;
3741
3742 // Sleep for a half a second to make sure our inferior process has
3743 // time to set its exit status before we set it incorrectly when
3744 // both the debugserver and the inferior process shut down.
3745 usleep(500000);
3746 // If our process hasn't yet exited, debugserver might have died.
3747 // If the process did exit, then we are reaping it.
3748 const StateType state = process_sp->GetState();
3749
3750 if (state != eStateInvalid && state != eStateUnloaded && state != eStateExited && state != eStateDetached)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003751 {
Pavel Labath194357c2016-05-12 11:10:01 +00003752 char error_str[1024];
3753 if (signo)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003754 {
Pavel Labath194357c2016-05-12 11:10:01 +00003755 const char *signal_cstr = process_sp->GetUnixSignals()->GetSignalAsCString(signo);
3756 if (signal_cstr)
3757 ::snprintf(error_str, sizeof(error_str), DEBUGSERVER_BASENAME " died with signal %s", signal_cstr);
3758 else
3759 ::snprintf(error_str, sizeof(error_str), DEBUGSERVER_BASENAME " died with signal %i", signo);
Greg Clayton0b76a2c2010-08-21 02:22:51 +00003760 }
Pavel Labath194357c2016-05-12 11:10:01 +00003761 else
3762 {
3763 ::snprintf(error_str, sizeof(error_str), DEBUGSERVER_BASENAME " died with an exit status of 0x%8.8x",
3764 exit_status);
3765 }
3766
3767 process_sp->SetExitStatus(-1, error_str);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003768 }
Pavel Labath194357c2016-05-12 11:10:01 +00003769 // Debugserver has exited we need to let our ProcessGDBRemote
3770 // know that it no longer has a debugserver instance
3771 process_sp->m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
3772 return handled;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003773}
3774
3775void
3776ProcessGDBRemote::KillDebugserverProcess ()
3777{
Greg Claytonfbb76342013-11-20 21:07:01 +00003778 m_gdb_comm.Disconnect();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003779 if (m_debugserver_pid != LLDB_INVALID_PROCESS_ID)
3780 {
Virgile Bellob2f1fb22013-08-23 12:44:05 +00003781 Host::Kill (m_debugserver_pid, SIGINT);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003782 m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
3783 }
3784}
3785
3786void
3787ProcessGDBRemote::Initialize()
3788{
Davide Italianoc8d69822015-04-03 04:24:32 +00003789 static std::once_flag g_once_flag;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003790
Davide Italianoc8d69822015-04-03 04:24:32 +00003791 std::call_once(g_once_flag, []()
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003792 {
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003793 PluginManager::RegisterPlugin (GetPluginNameStatic(),
3794 GetPluginDescriptionStatic(),
Greg Clayton7f982402013-07-15 22:54:20 +00003795 CreateInstance,
3796 DebuggerInitialize);
Davide Italianoc8d69822015-04-03 04:24:32 +00003797 });
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003798}
3799
Greg Clayton7f982402013-07-15 22:54:20 +00003800void
Tamas Berghammerdb264a62015-03-31 09:52:22 +00003801ProcessGDBRemote::DebuggerInitialize (Debugger &debugger)
Greg Clayton7f982402013-07-15 22:54:20 +00003802{
3803 if (!PluginManager::GetSettingForProcessPlugin(debugger, PluginProperties::GetSettingName()))
3804 {
3805 const bool is_global_setting = true;
3806 PluginManager::CreateSettingForProcessPlugin (debugger,
3807 GetGlobalPluginProperties()->GetValueProperties(),
3808 ConstString ("Properties for the gdb-remote process plug-in."),
3809 is_global_setting);
3810 }
3811}
3812
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003813bool
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003814ProcessGDBRemote::StartAsyncThread ()
3815{
Greg Clayton5160ce52013-03-27 23:08:40 +00003816 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003817
3818 if (log)
3819 log->Printf ("ProcessGDBRemote::%s ()", __FUNCTION__);
Ed Maste81b4c5f2016-01-04 01:43:47 +00003820
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +00003821 std::lock_guard<std::recursive_mutex> guard(m_async_thread_state_mutex);
Zachary Turneracee96a2014-09-23 18:32:09 +00003822 if (!m_async_thread.IsJoinable())
Jim Ingham455fa5c2012-11-01 01:15:33 +00003823 {
3824 // Create a thread that watches our internal state and controls which
3825 // events make it to clients (into the DCProcess event queue).
Zachary Turner39de3112014-09-09 20:54:56 +00003826
3827 m_async_thread = ThreadLauncher::LaunchThread("<lldb.process.gdb-remote.async>", ProcessGDBRemote::AsyncThread, this, NULL);
Jim Ingham455fa5c2012-11-01 01:15:33 +00003828 }
Zachary Turneracee96a2014-09-23 18:32:09 +00003829 else if (log)
3830 log->Printf("ProcessGDBRemote::%s () - Called when Async thread was already running.", __FUNCTION__);
Zachary Turner39de3112014-09-09 20:54:56 +00003831
Zachary Turneracee96a2014-09-23 18:32:09 +00003832 return m_async_thread.IsJoinable();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003833}
3834
3835void
3836ProcessGDBRemote::StopAsyncThread ()
3837{
Greg Clayton5160ce52013-03-27 23:08:40 +00003838 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003839
3840 if (log)
3841 log->Printf ("ProcessGDBRemote::%s ()", __FUNCTION__);
3842
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +00003843 std::lock_guard<std::recursive_mutex> guard(m_async_thread_state_mutex);
Zachary Turneracee96a2014-09-23 18:32:09 +00003844 if (m_async_thread.IsJoinable())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003845 {
Jim Ingham455fa5c2012-11-01 01:15:33 +00003846 m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncThreadShouldExit);
Ed Maste81b4c5f2016-01-04 01:43:47 +00003847
Jim Ingham455fa5c2012-11-01 01:15:33 +00003848 // This will shut down the async thread.
3849 m_gdb_comm.Disconnect(); // Disconnect from the debug server.
3850
3851 // Stop the stdio thread
Zachary Turner39de3112014-09-09 20:54:56 +00003852 m_async_thread.Join(nullptr);
Pavel Labatha55a9532015-03-11 09:53:42 +00003853 m_async_thread.Reset();
Jim Ingham455fa5c2012-11-01 01:15:33 +00003854 }
Zachary Turneracee96a2014-09-23 18:32:09 +00003855 else if (log)
3856 log->Printf("ProcessGDBRemote::%s () - Called when Async thread was not running.", __FUNCTION__);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003857}
3858
Ewan Crawford76df2882015-06-23 12:32:06 +00003859bool
3860ProcessGDBRemote::HandleNotifyPacket (StringExtractorGDBRemote &packet)
3861{
3862 // get the packet at a string
3863 const std::string &pkt = packet.GetStringRef();
3864 // skip %stop:
3865 StringExtractorGDBRemote stop_info(pkt.c_str() + 5);
3866
3867 // pass as a thread stop info packet
3868 SetLastStopPacket(stop_info);
3869
3870 // check for more stop reasons
3871 HandleStopReplySequence();
3872
3873 // if the process is stopped then we need to fake a resume
3874 // so that we can stop properly with the new break. This
3875 // is possible due to SetPrivateState() broadcasting the
3876 // state change as a side effect.
3877 if (GetPrivateState() == lldb::StateType::eStateStopped)
3878 {
3879 SetPrivateState(lldb::StateType::eStateRunning);
3880 }
3881
3882 // since we have some stopped packets we can halt the process
3883 SetPrivateState(lldb::StateType::eStateStopped);
3884
3885 return true;
3886}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003887
Virgile Bellob2f1fb22013-08-23 12:44:05 +00003888thread_result_t
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003889ProcessGDBRemote::AsyncThread (void *arg)
3890{
3891 ProcessGDBRemote *process = (ProcessGDBRemote*) arg;
3892
Greg Clayton5160ce52013-03-27 23:08:40 +00003893 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003894 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00003895 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") thread starting...", __FUNCTION__, arg, process->GetID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003896
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003897 EventSP event_sp;
Pavel Labath50556852015-09-03 09:36:22 +00003898 bool done = false;
3899 while (!done)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003900 {
Pavel Labath50556852015-09-03 09:36:22 +00003901 if (log)
3902 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") listener.WaitForEvent (NULL, event_sp)...", __FUNCTION__, arg, process->GetID());
Saleem Abdulrasool2d6a9ec2016-07-28 17:32:20 +00003903 if (process->m_async_listener_sp->WaitForEvent(std::chrono::microseconds(0), event_sp))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003904 {
Pavel Labath50556852015-09-03 09:36:22 +00003905 const uint32_t event_type = event_sp->GetType();
3906 if (event_sp->BroadcasterIs (&process->m_async_broadcaster))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003907 {
3908 if (log)
Pavel Labath50556852015-09-03 09:36:22 +00003909 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") Got an event of type: %d...", __FUNCTION__, arg, process->GetID(), event_type);
3910
3911 switch (event_type)
3912 {
3913 case eBroadcastBitAsyncContinue:
3914 {
3915 const EventDataBytes *continue_packet = EventDataBytes::GetEventDataFromEvent(event_sp.get());
3916
3917 if (continue_packet)
3918 {
3919 const char *continue_cstr = (const char *)continue_packet->GetBytes ();
3920 const size_t continue_cstr_len = continue_packet->GetByteSize ();
3921 if (log)
3922 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") got eBroadcastBitAsyncContinue: %s", __FUNCTION__, arg, process->GetID(), continue_cstr);
3923
3924 if (::strstr (continue_cstr, "vAttach") == NULL)
3925 process->SetPrivateState(eStateRunning);
3926 StringExtractorGDBRemote response;
3927
3928 // If in Non-Stop-Mode
3929 if (process->GetTarget().GetNonStopModeEnabled())
3930 {
3931 // send the vCont packet
Pavel Labath8c1b6bd2016-08-09 12:04:46 +00003932 if (!process->GetGDBRemote().SendvContPacket(
3933 llvm::StringRef(continue_cstr, continue_cstr_len), response))
Pavel Labath50556852015-09-03 09:36:22 +00003934 {
3935 // Something went wrong
3936 done = true;
3937 break;
3938 }
3939 }
3940 // If in All-Stop-Mode
3941 else
3942 {
Pavel Labath8c1b6bd2016-08-09 12:04:46 +00003943 StateType stop_state = process->GetGDBRemote().SendContinuePacketAndWaitForResponse(
3944 *process, *process->GetUnixSignals(),
3945 llvm::StringRef(continue_cstr, continue_cstr_len), response);
Pavel Labath50556852015-09-03 09:36:22 +00003946
3947 // We need to immediately clear the thread ID list so we are sure to get a valid list of threads.
3948 // The thread ID list might be contained within the "response", or the stop reply packet that
3949 // caused the stop. So clear it now before we give the stop reply packet to the process
3950 // using the process->SetLastStopPacket()...
3951 process->ClearThreadIDList ();
3952
3953 switch (stop_state)
3954 {
3955 case eStateStopped:
3956 case eStateCrashed:
3957 case eStateSuspended:
3958 process->SetLastStopPacket (response);
3959 process->SetPrivateState (stop_state);
3960 break;
3961
3962 case eStateExited:
3963 {
3964 process->SetLastStopPacket (response);
3965 process->ClearThreadIDList();
3966 response.SetFilePos(1);
Ed Maste81b4c5f2016-01-04 01:43:47 +00003967
Pavel Labath50556852015-09-03 09:36:22 +00003968 int exit_status = response.GetHexU8();
3969 const char *desc_cstr = NULL;
3970 StringExtractor extractor;
3971 std::string desc_string;
3972 if (response.GetBytesLeft() > 0 && response.GetChar('-') == ';')
3973 {
3974 std::string desc_token;
3975 while (response.GetNameColonValue (desc_token, desc_string))
3976 {
3977 if (desc_token == "description")
3978 {
3979 extractor.GetStringRef().swap(desc_string);
3980 extractor.SetFilePos(0);
3981 extractor.GetHexByteString (desc_string);
3982 desc_cstr = desc_string.c_str();
3983 }
3984 }
3985 }
3986 process->SetExitStatus(exit_status, desc_cstr);
3987 done = true;
3988 break;
3989 }
3990 case eStateInvalid:
3991 {
3992 // Check to see if we were trying to attach and if we got back
3993 // the "E87" error code from debugserver -- this indicates that
3994 // the process is not debuggable. Return a slightly more helpful
3995 // error message about why the attach failed.
3996 if (::strstr (continue_cstr, "vAttach") != NULL
3997 && response.GetError() == 0x87)
3998 {
3999 process->SetExitStatus(-1, "cannot attach to process due to System Integrity Protection");
4000 }
4001 // E01 code from vAttach means that the attach failed
4002 if (::strstr (continue_cstr, "vAttach") != NULL
4003 && response.GetError() == 0x1)
4004 {
4005 process->SetExitStatus(-1, "unable to attach");
4006 }
4007 else
4008 {
4009 process->SetExitStatus(-1, "lost connection");
4010 }
4011 break;
4012 }
4013
4014 default:
4015 process->SetPrivateState (stop_state);
4016 break;
4017 } // switch(stop_state)
4018 } // else // if in All-stop-mode
4019 } // if (continue_packet)
4020 } // case eBroadcastBitAysncContinue
4021 break;
4022
4023 case eBroadcastBitAsyncThreadShouldExit:
4024 if (log)
4025 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") got eBroadcastBitAsyncThreadShouldExit...", __FUNCTION__, arg, process->GetID());
4026 done = true;
4027 break;
4028
4029 default:
4030 if (log)
4031 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") got unknown event 0x%8.8x", __FUNCTION__, arg, process->GetID(), event_type);
4032 done = true;
4033 break;
4034 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004035 }
Pavel Labath50556852015-09-03 09:36:22 +00004036 else if (event_sp->BroadcasterIs (&process->m_gdb_comm))
4037 {
4038 switch (event_type)
4039 {
4040 case Communication::eBroadcastBitReadThreadDidExit:
4041 process->SetExitStatus (-1, "lost connection");
4042 done = true;
4043 break;
4044
4045 case GDBRemoteCommunication::eBroadcastBitGdbReadThreadGotNotify:
4046 {
4047 lldb_private::Event *event = event_sp.get();
4048 const EventDataBytes *continue_packet = EventDataBytes::GetEventDataFromEvent(event);
4049 StringExtractorGDBRemote notify((const char*)continue_packet->GetBytes());
4050 // Hand this over to the process to handle
4051 process->HandleNotifyPacket(notify);
4052 break;
4053 }
4054
4055 default:
4056 if (log)
4057 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") got unknown event 0x%8.8x", __FUNCTION__, arg, process->GetID(), event_type);
4058 done = true;
4059 break;
4060 }
4061 }
4062 }
4063 else
4064 {
4065 if (log)
4066 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") listener.WaitForEvent (NULL, event_sp) => false", __FUNCTION__, arg, process->GetID());
4067 done = true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004068 }
4069 }
4070
4071 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00004072 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") thread exiting...", __FUNCTION__, arg, process->GetID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004073
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004074 return NULL;
4075}
4076
Greg Claytone996fd32011-03-08 22:40:15 +00004077//uint32_t
4078//ProcessGDBRemote::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
4079//{
4080// // If we are planning to launch the debugserver remotely, then we need to fire up a debugserver
4081// // process and ask it for the list of processes. But if we are local, we can let the Host do it.
4082// if (m_local_debugserver)
4083// {
4084// return Host::ListProcessesMatchingName (name, matches, pids);
4085// }
Ed Maste81b4c5f2016-01-04 01:43:47 +00004086// else
Greg Claytone996fd32011-03-08 22:40:15 +00004087// {
4088// // FIXME: Implement talking to the remote debugserver.
4089// return 0;
4090// }
4091//
4092//}
4093//
Jim Ingham1c823b42011-01-22 01:33:44 +00004094bool
4095ProcessGDBRemote::NewThreadNotifyBreakpointHit (void *baton,
Tamas Berghammerdb264a62015-03-31 09:52:22 +00004096 StoppointCallbackContext *context,
Jim Ingham1c823b42011-01-22 01:33:44 +00004097 lldb::user_id_t break_id,
4098 lldb::user_id_t break_loc_id)
4099{
Ed Maste81b4c5f2016-01-04 01:43:47 +00004100 // I don't think I have to do anything here, just make sure I notice the new thread when it starts to
Jim Ingham1c823b42011-01-22 01:33:44 +00004101 // run so I can stop it if that's what I want to do.
Tamas Berghammerdb264a62015-03-31 09:52:22 +00004102 Log *log (GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
Jim Ingham1c823b42011-01-22 01:33:44 +00004103 if (log)
4104 log->Printf("Hit New Thread Notification breakpoint.");
4105 return false;
4106}
4107
Eugene Zelenko0722f082015-10-24 01:28:05 +00004108
Jim Ingham1c823b42011-01-22 01:33:44 +00004109bool
4110ProcessGDBRemote::StartNoticingNewThreads()
4111{
Tamas Berghammerdb264a62015-03-31 09:52:22 +00004112 Log *log (GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
Greg Clayton4116e932012-05-15 02:33:01 +00004113 if (m_thread_create_bp_sp)
Jim Ingham1c823b42011-01-22 01:33:44 +00004114 {
Greg Clayton4116e932012-05-15 02:33:01 +00004115 if (log && log->GetVerbose())
4116 log->Printf("Enabled noticing new thread breakpoint.");
4117 m_thread_create_bp_sp->SetEnabled(true);
Jim Ingham1c823b42011-01-22 01:33:44 +00004118 }
Greg Clayton4116e932012-05-15 02:33:01 +00004119 else
Jim Ingham1c823b42011-01-22 01:33:44 +00004120 {
Zachary Turner7529df92015-09-01 20:02:29 +00004121 PlatformSP platform_sp (GetTarget().GetPlatform());
Greg Clayton4116e932012-05-15 02:33:01 +00004122 if (platform_sp)
Jim Ingham1c823b42011-01-22 01:33:44 +00004123 {
Zachary Turner7529df92015-09-01 20:02:29 +00004124 m_thread_create_bp_sp = platform_sp->SetThreadCreationBreakpoint(GetTarget());
Greg Clayton4116e932012-05-15 02:33:01 +00004125 if (m_thread_create_bp_sp)
Jim Ingham1c823b42011-01-22 01:33:44 +00004126 {
Jim Ingham37cfeab2011-10-15 00:21:37 +00004127 if (log && log->GetVerbose())
Greg Clayton4116e932012-05-15 02:33:01 +00004128 log->Printf("Successfully created new thread notification breakpoint %i", m_thread_create_bp_sp->GetID());
4129 m_thread_create_bp_sp->SetCallback (ProcessGDBRemote::NewThreadNotifyBreakpointHit, this, true);
Jim Ingham1c823b42011-01-22 01:33:44 +00004130 }
4131 else
4132 {
4133 if (log)
4134 log->Printf("Failed to create new thread notification breakpoint.");
Jim Ingham1c823b42011-01-22 01:33:44 +00004135 }
4136 }
4137 }
Greg Clayton4116e932012-05-15 02:33:01 +00004138 return m_thread_create_bp_sp.get() != NULL;
Jim Ingham1c823b42011-01-22 01:33:44 +00004139}
4140
4141bool
4142ProcessGDBRemote::StopNoticingNewThreads()
Ed Maste81b4c5f2016-01-04 01:43:47 +00004143{
Tamas Berghammerdb264a62015-03-31 09:52:22 +00004144 Log *log (GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
Jim Ingham37cfeab2011-10-15 00:21:37 +00004145 if (log && log->GetVerbose())
Jim Ingham0e97cbc2011-02-08 05:19:01 +00004146 log->Printf ("Disabling new thread notification breakpoint.");
Greg Clayton4116e932012-05-15 02:33:01 +00004147
4148 if (m_thread_create_bp_sp)
4149 m_thread_create_bp_sp->SetEnabled(false);
4150
Jim Ingham1c823b42011-01-22 01:33:44 +00004151 return true;
4152}
Ed Maste81b4c5f2016-01-04 01:43:47 +00004153
Tamas Berghammerdb264a62015-03-31 09:52:22 +00004154DynamicLoader *
Jason Molenda5e8534e2012-10-03 01:29:34 +00004155ProcessGDBRemote::GetDynamicLoader ()
4156{
4157 if (m_dyld_ap.get() == NULL)
Jason Molenda2e56a252013-05-11 03:09:05 +00004158 m_dyld_ap.reset (DynamicLoader::FindPlugin(this, NULL));
Jason Molenda5e8534e2012-10-03 01:29:34 +00004159 return m_dyld_ap.get();
4160}
Jim Ingham1c823b42011-01-22 01:33:44 +00004161
Jason Molendaa3329782014-03-29 18:54:20 +00004162Error
4163ProcessGDBRemote::SendEventData(const char *data)
4164{
4165 int return_value;
4166 bool was_supported;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004167
Jason Molendaa3329782014-03-29 18:54:20 +00004168 Error error;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004169
Jason Molendaa3329782014-03-29 18:54:20 +00004170 return_value = m_gdb_comm.SendLaunchEventDataPacket (data, &was_supported);
4171 if (return_value != 0)
4172 {
4173 if (!was_supported)
4174 error.SetErrorString("Sending events is not supported for this process.");
4175 else
4176 error.SetErrorStringWithFormat("Error sending event data: %d.", return_value);
4177 }
4178 return error;
4179}
4180
Steve Pucci03904ac2014-03-04 23:18:46 +00004181const DataBufferSP
4182ProcessGDBRemote::GetAuxvData()
4183{
4184 DataBufferSP buf;
4185 if (m_gdb_comm.GetQXferAuxvReadSupported())
4186 {
4187 std::string response_string;
4188 if (m_gdb_comm.SendPacketsAndConcatenateResponses("qXfer:auxv:read::", response_string) == GDBRemoteCommunication::PacketResult::Success)
4189 buf.reset(new DataBufferHeap(response_string.c_str(), response_string.length()));
4190 }
4191 return buf;
4192}
4193
Jason Molenda705b1802014-06-13 02:37:02 +00004194StructuredData::ObjectSP
4195ProcessGDBRemote::GetExtendedInfoForThread (lldb::tid_t tid)
4196{
4197 StructuredData::ObjectSP object_sp;
4198
4199 if (m_gdb_comm.GetThreadExtendedInfoSupported())
4200 {
4201 StructuredData::ObjectSP args_dict(new StructuredData::Dictionary());
4202 SystemRuntime *runtime = GetSystemRuntime();
4203 if (runtime)
4204 {
4205 runtime->AddThreadExtendedInfoPacketHints (args_dict);
4206 }
4207 args_dict->GetAsDictionary()->AddIntegerItem ("thread", tid);
4208
4209 StreamString packet;
4210 packet << "jThreadExtendedInfo:";
Jason Molenda9ab5dc22016-07-21 08:30:55 +00004211 args_dict->Dump (packet, false);
Jason Molenda705b1802014-06-13 02:37:02 +00004212
4213 // FIXME the final character of a JSON dictionary, '}', is the escape
4214 // character in gdb-remote binary mode. lldb currently doesn't escape
4215 // these characters in its packet output -- so we add the quoted version
4216 // of the } character here manually in case we talk to a debugserver which
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00004217 // un-escapes the characters at packet read time.
Jason Molenda705b1802014-06-13 02:37:02 +00004218 packet << (char) (0x7d ^ 0x20);
4219
4220 StringExtractorGDBRemote response;
Greg Clayton830c81d2016-04-01 00:41:29 +00004221 response.SetResponseValidatorToJSON();
Jason Molenda705b1802014-06-13 02:37:02 +00004222 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetData(), packet.GetSize(), response, false) == GDBRemoteCommunication::PacketResult::Success)
4223 {
4224 StringExtractorGDBRemote::ResponseType response_type = response.GetResponseType();
4225 if (response_type == StringExtractorGDBRemote::eResponse)
4226 {
4227 if (!response.Empty())
4228 {
Jason Molenda20ee21b2015-07-10 23:15:22 +00004229 object_sp = StructuredData::ParseJSON (response.GetStringRef());
4230 }
4231 }
4232 }
4233 }
4234 return object_sp;
4235}
4236
4237StructuredData::ObjectSP
4238ProcessGDBRemote::GetLoadedDynamicLibrariesInfos (lldb::addr_t image_list_address, lldb::addr_t image_count)
4239{
Jason Molenda9ab5dc22016-07-21 08:30:55 +00004240
4241 StructuredData::ObjectSP args_dict(new StructuredData::Dictionary());
4242 args_dict->GetAsDictionary()->AddIntegerItem ("image_list_address", image_list_address);
4243 args_dict->GetAsDictionary()->AddIntegerItem ("image_count", image_count);
4244
4245 return GetLoadedDynamicLibrariesInfos_sender (args_dict);
4246}
4247
4248StructuredData::ObjectSP
4249ProcessGDBRemote::GetLoadedDynamicLibrariesInfos ()
4250{
4251 StructuredData::ObjectSP args_dict(new StructuredData::Dictionary());
4252
4253 args_dict->GetAsDictionary()->AddBooleanItem ("fetch_all_solibs", true);
4254
4255 return GetLoadedDynamicLibrariesInfos_sender (args_dict);
4256}
4257
4258StructuredData::ObjectSP
4259ProcessGDBRemote::GetLoadedDynamicLibrariesInfos (const std::vector<lldb::addr_t> &load_addresses)
4260{
4261 StructuredData::ObjectSP args_dict(new StructuredData::Dictionary());
4262 StructuredData::ArraySP addresses(new StructuredData::Array);
4263
4264 for (auto addr : load_addresses)
4265 {
4266 StructuredData::ObjectSP addr_sp (new StructuredData::Integer (addr));
4267 addresses->AddItem (addr_sp);
4268 }
4269
4270 args_dict->GetAsDictionary()->AddItem ("solib_addresses", addresses);
4271
4272 return GetLoadedDynamicLibrariesInfos_sender (args_dict);
4273}
4274
4275StructuredData::ObjectSP
4276ProcessGDBRemote::GetLoadedDynamicLibrariesInfos_sender (StructuredData::ObjectSP args_dict)
4277{
Jason Molenda20ee21b2015-07-10 23:15:22 +00004278 StructuredData::ObjectSP object_sp;
4279
4280 if (m_gdb_comm.GetLoadedDynamicLibrariesInfosSupported())
4281 {
Jason Molenda1d3b3562015-11-05 23:54:29 +00004282 // Scope for the scoped timeout object
4283 GDBRemoteCommunication::ScopedTimeout timeout (m_gdb_comm, 10);
4284
Jason Molenda20ee21b2015-07-10 23:15:22 +00004285 StreamString packet;
4286 packet << "jGetLoadedDynamicLibrariesInfos:";
Jason Molenda9ab5dc22016-07-21 08:30:55 +00004287 args_dict->Dump (packet, false);
Jason Molenda20ee21b2015-07-10 23:15:22 +00004288
4289 // FIXME the final character of a JSON dictionary, '}', is the escape
4290 // character in gdb-remote binary mode. lldb currently doesn't escape
4291 // these characters in its packet output -- so we add the quoted version
4292 // of the } character here manually in case we talk to a debugserver which
4293 // un-escapes the characters at packet read time.
4294 packet << (char) (0x7d ^ 0x20);
4295
4296 StringExtractorGDBRemote response;
Greg Clayton830c81d2016-04-01 00:41:29 +00004297 response.SetResponseValidatorToJSON();
Jason Molenda20ee21b2015-07-10 23:15:22 +00004298 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetData(), packet.GetSize(), response, false) == GDBRemoteCommunication::PacketResult::Success)
4299 {
4300 StringExtractorGDBRemote::ResponseType response_type = response.GetResponseType();
4301 if (response_type == StringExtractorGDBRemote::eResponse)
4302 {
4303 if (!response.Empty())
4304 {
Jason Molenda705b1802014-06-13 02:37:02 +00004305 object_sp = StructuredData::ParseJSON (response.GetStringRef());
4306 }
4307 }
4308 }
4309 }
4310 return object_sp;
4311}
4312
Jason Molenda9ab5dc22016-07-21 08:30:55 +00004313
4314
4315
Jason Molenda37397352016-07-22 00:17:55 +00004316StructuredData::ObjectSP
4317ProcessGDBRemote::GetSharedCacheInfo ()
4318{
4319 StructuredData::ObjectSP object_sp;
4320 StructuredData::ObjectSP args_dict(new StructuredData::Dictionary());
4321
4322 if (m_gdb_comm.GetSharedCacheInfoSupported())
4323 {
4324 StreamString packet;
4325 packet << "jGetSharedCacheInfo:";
4326 args_dict->Dump (packet, false);
4327
4328 // FIXME the final character of a JSON dictionary, '}', is the escape
4329 // character in gdb-remote binary mode. lldb currently doesn't escape
4330 // these characters in its packet output -- so we add the quoted version
4331 // of the } character here manually in case we talk to a debugserver which
4332 // un-escapes the characters at packet read time.
4333 packet << (char) (0x7d ^ 0x20);
4334
4335 StringExtractorGDBRemote response;
4336 response.SetResponseValidatorToJSON();
4337 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetData(), packet.GetSize(), response, false) == GDBRemoteCommunication::PacketResult::Success)
4338 {
4339 StringExtractorGDBRemote::ResponseType response_type = response.GetResponseType();
4340 if (response_type == StringExtractorGDBRemote::eResponse)
4341 {
4342 if (!response.Empty())
4343 {
4344 object_sp = StructuredData::ParseJSON (response.GetStringRef());
4345 }
4346 }
4347 }
4348 }
4349 return object_sp;
4350}
4351
Todd Fiala75930012016-08-19 04:21:48 +00004352Error
4353ProcessGDBRemote::ConfigureStructuredData(const ConstString &type_name,
4354 const StructuredData::ObjectSP
4355 &config_sp)
4356{
4357 return m_gdb_comm.ConfigureRemoteStructuredData(type_name, config_sp);
4358}
Jason Molenda37397352016-07-22 00:17:55 +00004359
Jason Molenda6076bf42014-05-06 04:34:52 +00004360// Establish the largest memory read/write payloads we should use.
4361// If the remote stub has a max packet size, stay under that size.
Ed Maste81b4c5f2016-01-04 01:43:47 +00004362//
4363// If the remote stub's max packet size is crazy large, use a
Jason Molenda6076bf42014-05-06 04:34:52 +00004364// reasonable largeish default.
4365//
4366// If the remote stub doesn't advertise a max packet size, use a
4367// conservative default.
4368
4369void
4370ProcessGDBRemote::GetMaxMemorySize()
4371{
4372 const uint64_t reasonable_largeish_default = 128 * 1024;
4373 const uint64_t conservative_default = 512;
4374
4375 if (m_max_memory_size == 0)
4376 {
4377 uint64_t stub_max_size = m_gdb_comm.GetRemoteMaxPacketSize();
4378 if (stub_max_size != UINT64_MAX && stub_max_size != 0)
4379 {
4380 // Save the stub's claimed maximum packet size
4381 m_remote_stub_max_memory_size = stub_max_size;
4382
4383 // Even if the stub says it can support ginormous packets,
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00004384 // don't exceed our reasonable largeish default packet size.
Jason Molenda6076bf42014-05-06 04:34:52 +00004385 if (stub_max_size > reasonable_largeish_default)
4386 {
4387 stub_max_size = reasonable_largeish_default;
4388 }
4389
4390 m_max_memory_size = stub_max_size;
4391 }
4392 else
4393 {
4394 m_max_memory_size = conservative_default;
4395 }
4396 }
4397}
4398
4399void
4400ProcessGDBRemote::SetUserSpecifiedMaxMemoryTransferSize (uint64_t user_specified_max)
4401{
4402 if (user_specified_max != 0)
4403 {
4404 GetMaxMemorySize ();
4405
4406 if (m_remote_stub_max_memory_size != 0)
4407 {
4408 if (m_remote_stub_max_memory_size < user_specified_max)
4409 {
4410 m_max_memory_size = m_remote_stub_max_memory_size; // user specified a packet size too big, go as big
4411 // as the remote stub says we can go.
4412 }
4413 else
4414 {
4415 m_max_memory_size = user_specified_max; // user's packet size is good
4416 }
4417 }
4418 else
4419 {
4420 m_max_memory_size = user_specified_max; // user's packet size is probably fine
4421 }
4422 }
4423}
4424
Tamas Berghammer7cb18bf2015-03-24 11:15:23 +00004425bool
4426ProcessGDBRemote::GetModuleSpec(const FileSpec& module_file_spec,
4427 const ArchSpec& arch,
4428 ModuleSpec &module_spec)
4429{
4430 Log *log = GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PLATFORM);
4431
4432 if (!m_gdb_comm.GetModuleInfo (module_file_spec, arch, module_spec))
4433 {
4434 if (log)
4435 log->Printf ("ProcessGDBRemote::%s - failed to get module info for %s:%s",
4436 __FUNCTION__, module_file_spec.GetPath ().c_str (),
4437 arch.GetTriple ().getTriple ().c_str ());
4438 return false;
4439 }
4440
4441 if (log)
4442 {
4443 StreamString stream;
4444 module_spec.Dump (stream);
4445 log->Printf ("ProcessGDBRemote::%s - got module info for (%s:%s) : %s",
4446 __FUNCTION__, module_file_spec.GetPath ().c_str (),
4447 arch.GetTriple ().getTriple ().c_str (), stream.GetString ().c_str ());
4448 }
4449
4450 return true;
4451}
4452
Jim Ingham13c30d22015-11-05 22:33:17 +00004453bool
4454ProcessGDBRemote::GetHostOSVersion(uint32_t &major,
4455 uint32_t &minor,
4456 uint32_t &update)
4457{
4458 if (m_gdb_comm.GetOSVersion(major, minor, update))
4459 return true;
4460 // We failed to get the host OS version, defer to the base
4461 // implementation to correctly invalidate the arguments.
4462 return Process::GetHostOSVersion(major, minor, update);
4463}
4464
Colin Rileyc3c95b22015-04-16 15:51:33 +00004465namespace {
4466
4467typedef std::vector<std::string> stringVec;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004468
4469typedef std::vector<struct GdbServerRegisterInfo> GDBServerRegisterVec;
Greg Claytond04f0ed2015-05-26 18:00:51 +00004470struct RegisterSetInfo
4471{
4472 ConstString name;
4473};
Colin Rileyc3c95b22015-04-16 15:51:33 +00004474
Greg Claytond04f0ed2015-05-26 18:00:51 +00004475typedef std::map<uint32_t, RegisterSetInfo> RegisterSetMap;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004476
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004477struct GdbServerTargetInfo
4478{
Greg Claytond04f0ed2015-05-26 18:00:51 +00004479 std::string arch;
4480 std::string osabi;
4481 stringVec includes;
4482 RegisterSetMap reg_set_map;
4483 XMLNode feature_node;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004484};
Ed Maste81b4c5f2016-01-04 01:43:47 +00004485
Colin Rileyc3c95b22015-04-16 15:51:33 +00004486bool
Francis Ricci55954ae2016-04-25 21:03:55 +00004487ParseRegisters (XMLNode feature_node, GdbServerTargetInfo &target_info, GDBRemoteDynamicRegisterInfo &dyn_reg_info, ABISP abi_sp, uint32_t &cur_reg_num, uint32_t &reg_offset)
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004488{
Greg Claytond04f0ed2015-05-26 18:00:51 +00004489 if (!feature_node)
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004490 return false;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004491
Jason Molenda63bd0db2015-09-15 23:20:34 +00004492 feature_node.ForEachChildElementWithName("reg", [&target_info, &dyn_reg_info, &cur_reg_num, &reg_offset, &abi_sp](const XMLNode &reg_node) -> bool {
Greg Claytond04f0ed2015-05-26 18:00:51 +00004493 std::string gdb_group;
4494 std::string gdb_type;
4495 ConstString reg_name;
4496 ConstString alt_name;
4497 ConstString set_name;
4498 std::vector<uint32_t> value_regs;
4499 std::vector<uint32_t> invalidate_regs;
Nitesh Jain52b6cc52016-08-01 13:45:51 +00004500 std::vector<uint8_t> dwarf_opcode_bytes;
Greg Claytond04f0ed2015-05-26 18:00:51 +00004501 bool encoding_set = false;
4502 bool format_set = false;
4503 RegisterInfo reg_info = { NULL, // Name
4504 NULL, // Alt name
4505 0, // byte size
4506 reg_offset, // offset
4507 eEncodingUint, // encoding
Jason Molendabf67a302015-09-01 05:17:01 +00004508 eFormatHex, // format
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004509 {
Jason Molendabf67a302015-09-01 05:17:01 +00004510 LLDB_INVALID_REGNUM, // eh_frame reg num
Greg Claytond04f0ed2015-05-26 18:00:51 +00004511 LLDB_INVALID_REGNUM, // DWARF reg num
4512 LLDB_INVALID_REGNUM, // generic reg num
Jason Molenda63bd0db2015-09-15 23:20:34 +00004513 cur_reg_num, // process plugin reg num
4514 cur_reg_num // native register number
Greg Claytond04f0ed2015-05-26 18:00:51 +00004515 },
4516 NULL,
Nitesh Jain52b6cc52016-08-01 13:45:51 +00004517 NULL,
4518 NULL, // Dwarf Expression opcode bytes pointer
4519 0 // Dwarf Expression opcode bytes length
Greg Claytond04f0ed2015-05-26 18:00:51 +00004520 };
Ed Maste81b4c5f2016-01-04 01:43:47 +00004521
Nitesh Jain52b6cc52016-08-01 13:45:51 +00004522 reg_node.ForEachAttribute([&target_info, &gdb_group, &gdb_type, &reg_name, &alt_name, &set_name, &value_regs, &invalidate_regs, &encoding_set, &format_set, &reg_info, &cur_reg_num, &reg_offset, &dwarf_opcode_bytes](const llvm::StringRef &name, const llvm::StringRef &value) -> bool {
Greg Claytond04f0ed2015-05-26 18:00:51 +00004523 if (name == "name")
4524 {
4525 reg_name.SetString(value);
4526 }
4527 else if (name == "bitsize")
4528 {
4529 reg_info.byte_size = StringConvert::ToUInt32(value.data(), 0, 0) / CHAR_BIT;
4530 }
4531 else if (name == "type")
4532 {
4533 gdb_type = value.str();
4534 }
4535 else if (name == "group")
4536 {
4537 gdb_group = value.str();
4538 }
4539 else if (name == "regnum")
4540 {
4541 const uint32_t regnum = StringConvert::ToUInt32(value.data(), LLDB_INVALID_REGNUM, 0);
4542 if (regnum != LLDB_INVALID_REGNUM)
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004543 {
Jason Molenda63bd0db2015-09-15 23:20:34 +00004544 reg_info.kinds[eRegisterKindProcessPlugin] = regnum;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004545 }
4546 }
Greg Claytond04f0ed2015-05-26 18:00:51 +00004547 else if (name == "offset")
4548 {
4549 reg_offset = StringConvert::ToUInt32(value.data(), UINT32_MAX, 0);
4550 }
4551 else if (name == "altname")
4552 {
4553 alt_name.SetString(value);
4554 }
4555 else if (name == "encoding")
4556 {
4557 encoding_set = true;
4558 reg_info.encoding = Args::StringToEncoding (value.data(), eEncodingUint);
4559 }
4560 else if (name == "format")
4561 {
4562 format_set = true;
4563 Format format = eFormatInvalid;
4564 if (Args::StringToFormat (value.data(), format, NULL).Success())
4565 reg_info.format = format;
4566 else if (value == "vector-sint8")
4567 reg_info.format = eFormatVectorOfSInt8;
4568 else if (value == "vector-uint8")
4569 reg_info.format = eFormatVectorOfUInt8;
4570 else if (value == "vector-sint16")
4571 reg_info.format = eFormatVectorOfSInt16;
4572 else if (value == "vector-uint16")
4573 reg_info.format = eFormatVectorOfUInt16;
4574 else if (value == "vector-sint32")
4575 reg_info.format = eFormatVectorOfSInt32;
4576 else if (value == "vector-uint32")
4577 reg_info.format = eFormatVectorOfUInt32;
4578 else if (value == "vector-float32")
4579 reg_info.format = eFormatVectorOfFloat32;
4580 else if (value == "vector-uint128")
4581 reg_info.format = eFormatVectorOfUInt128;
4582 }
4583 else if (name == "group_id")
4584 {
4585 const uint32_t set_id = StringConvert::ToUInt32(value.data(), UINT32_MAX, 0);
4586 RegisterSetMap::const_iterator pos = target_info.reg_set_map.find(set_id);
4587 if (pos != target_info.reg_set_map.end())
4588 set_name = pos->second.name;
4589 }
Jason Molendaa18f7072015-08-15 01:21:01 +00004590 else if (name == "gcc_regnum" || name == "ehframe_regnum")
Greg Claytond04f0ed2015-05-26 18:00:51 +00004591 {
Jason Molendaa18f7072015-08-15 01:21:01 +00004592 reg_info.kinds[eRegisterKindEHFrame] = StringConvert::ToUInt32(value.data(), LLDB_INVALID_REGNUM, 0);
Greg Claytond04f0ed2015-05-26 18:00:51 +00004593 }
4594 else if (name == "dwarf_regnum")
4595 {
4596 reg_info.kinds[eRegisterKindDWARF] = StringConvert::ToUInt32(value.data(), LLDB_INVALID_REGNUM, 0);
4597 }
4598 else if (name == "generic")
4599 {
4600 reg_info.kinds[eRegisterKindGeneric] = Args::StringToGenericRegister(value.data());
4601 }
4602 else if (name == "value_regnums")
4603 {
4604 SplitCommaSeparatedRegisterNumberString(value, value_regs, 0);
4605 }
4606 else if (name == "invalidate_regnums")
4607 {
4608 SplitCommaSeparatedRegisterNumberString(value, invalidate_regs, 0);
4609 }
Nitesh Jain52b6cc52016-08-01 13:45:51 +00004610 else if (name == "dynamic_size_dwarf_expr_bytes")
4611 {
4612 StringExtractor opcode_extractor;
4613 std::string opcode_string = value.str ();
4614 size_t dwarf_opcode_len = opcode_string.length () / 2;
4615 assert (dwarf_opcode_len > 0);
4616
4617 dwarf_opcode_bytes.resize (dwarf_opcode_len);
4618 reg_info.dynamic_size_dwarf_len = dwarf_opcode_len;
4619 opcode_extractor.GetStringRef ().swap (opcode_string);
4620 uint32_t ret_val = opcode_extractor.GetHexBytesAvail (dwarf_opcode_bytes.data (),
4621 dwarf_opcode_len);
4622 assert (dwarf_opcode_len == ret_val);
4623
4624 reg_info.dynamic_size_dwarf_expr_bytes = dwarf_opcode_bytes.data ();
4625 }
Greg Claytond04f0ed2015-05-26 18:00:51 +00004626 else
4627 {
4628 printf("unhandled attribute %s = %s\n", name.data(), value.data());
4629 }
4630 return true; // Keep iterating through all attributes
4631 });
Ed Maste81b4c5f2016-01-04 01:43:47 +00004632
Greg Claytond04f0ed2015-05-26 18:00:51 +00004633 if (!gdb_type.empty() && !(encoding_set || format_set))
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004634 {
Greg Claytond04f0ed2015-05-26 18:00:51 +00004635 if (gdb_type.find("int") == 0)
4636 {
4637 reg_info.format = eFormatHex;
4638 reg_info.encoding = eEncodingUint;
4639 }
4640 else if (gdb_type == "data_ptr" || gdb_type == "code_ptr")
4641 {
4642 reg_info.format = eFormatAddressInfo;
4643 reg_info.encoding = eEncodingUint;
4644 }
4645 else if (gdb_type == "i387_ext" || gdb_type == "float")
4646 {
4647 reg_info.format = eFormatFloat;
4648 reg_info.encoding = eEncodingIEEE754;
4649 }
Colin Rileyc3c95b22015-04-16 15:51:33 +00004650 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00004651
Greg Claytond04f0ed2015-05-26 18:00:51 +00004652 // Only update the register set name if we didn't get a "reg_set" attribute.
4653 // "set_name" will be empty if we didn't have a "reg_set" attribute.
4654 if (!set_name && !gdb_group.empty())
4655 set_name.SetCString(gdb_group.c_str());
Ed Maste81b4c5f2016-01-04 01:43:47 +00004656
Greg Claytond04f0ed2015-05-26 18:00:51 +00004657 reg_info.byte_offset = reg_offset;
4658 assert (reg_info.byte_size != 0);
4659 reg_offset += reg_info.byte_size;
4660 if (!value_regs.empty())
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004661 {
Greg Claytond04f0ed2015-05-26 18:00:51 +00004662 value_regs.push_back(LLDB_INVALID_REGNUM);
4663 reg_info.value_regs = value_regs.data();
Colin Rileyc3c95b22015-04-16 15:51:33 +00004664 }
Greg Claytond04f0ed2015-05-26 18:00:51 +00004665 if (!invalidate_regs.empty())
4666 {
4667 invalidate_regs.push_back(LLDB_INVALID_REGNUM);
4668 reg_info.invalidate_regs = invalidate_regs.data();
4669 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00004670
Jason Molenda63bd0db2015-09-15 23:20:34 +00004671 ++cur_reg_num;
Jason Molenda21586c82015-09-09 03:36:24 +00004672 AugmentRegisterInfoViaABI (reg_info, reg_name, abi_sp);
Greg Claytond04f0ed2015-05-26 18:00:51 +00004673 dyn_reg_info.AddRegister(reg_info, reg_name, alt_name, set_name);
Ed Maste81b4c5f2016-01-04 01:43:47 +00004674
Greg Claytond04f0ed2015-05-26 18:00:51 +00004675 return true; // Keep iterating through all "reg" elements
4676 });
Colin Rileyc3c95b22015-04-16 15:51:33 +00004677 return true;
4678}
Ed Maste81b4c5f2016-01-04 01:43:47 +00004679
Eugene Zelenko0722f082015-10-24 01:28:05 +00004680} // namespace {}
Colin Rileyc3c95b22015-04-16 15:51:33 +00004681
Colin Rileyc3c95b22015-04-16 15:51:33 +00004682
4683// query the target of gdb-remote for extended target information
4684// return: 'true' on success
4685// 'false' on failure
4686bool
Jim Ingham7b71c0b2016-02-18 23:58:45 +00004687ProcessGDBRemote::GetGDBServerRegisterInfo (ArchSpec &arch_to_use)
Colin Rileyc3c95b22015-04-16 15:51:33 +00004688{
Greg Claytond04f0ed2015-05-26 18:00:51 +00004689 // Make sure LLDB has an XML parser it can use first
4690 if (!XMLDocument::XMLEnabled())
4691 return false;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004692
4693 // redirect libxml2's error handler since the default prints to stdout
Colin Rileyc3c95b22015-04-16 15:51:33 +00004694
4695 GDBRemoteCommunicationClient & comm = m_gdb_comm;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004696
4697 // check that we have extended feature read support
4698 if ( !comm.GetQXferFeaturesReadSupported( ) )
4699 return false;
4700
4701 // request the target xml file
4702 std::string raw;
4703 lldb_private::Error lldberr;
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004704 if (!comm.ReadExtFeature(ConstString("features"),
4705 ConstString("target.xml"),
4706 raw,
4707 lldberr))
4708 {
Colin Rileyc3c95b22015-04-16 15:51:33 +00004709 return false;
4710 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00004711
Colin Rileyc3c95b22015-04-16 15:51:33 +00004712
Greg Claytond04f0ed2015-05-26 18:00:51 +00004713 XMLDocument xml_document;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004714
Greg Claytond04f0ed2015-05-26 18:00:51 +00004715 if (xml_document.ParseMemory(raw.c_str(), raw.size(), "target.xml"))
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004716 {
Greg Claytond04f0ed2015-05-26 18:00:51 +00004717 GdbServerTargetInfo target_info;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004718
Greg Claytond04f0ed2015-05-26 18:00:51 +00004719 XMLNode target_node = xml_document.GetRootElement("target");
4720 if (target_node)
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004721 {
Greg Claytond04f0ed2015-05-26 18:00:51 +00004722 XMLNode feature_node;
4723 target_node.ForEachChildElement([&target_info, this, &feature_node](const XMLNode &node) -> bool
4724 {
4725 llvm::StringRef name = node.GetName();
4726 if (name == "architecture")
4727 {
4728 node.GetElementText(target_info.arch);
4729 }
4730 else if (name == "osabi")
4731 {
4732 node.GetElementText(target_info.osabi);
4733 }
Ewan Crawford682e8422015-06-26 09:38:27 +00004734 else if (name == "xi:include" || name == "include")
Greg Claytond04f0ed2015-05-26 18:00:51 +00004735 {
4736 llvm::StringRef href = node.GetAttributeValue("href");
4737 if (!href.empty())
4738 target_info.includes.push_back(href.str());
4739 }
4740 else if (name == "feature")
4741 {
4742 feature_node = node;
4743 }
4744 else if (name == "groups")
4745 {
4746 node.ForEachChildElementWithName("group", [&target_info](const XMLNode &node) -> bool {
4747 uint32_t set_id = UINT32_MAX;
4748 RegisterSetInfo set_info;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004749
Greg Claytond04f0ed2015-05-26 18:00:51 +00004750 node.ForEachAttribute([&set_id, &set_info](const llvm::StringRef &name, const llvm::StringRef &value) -> bool {
4751 if (name == "id")
4752 set_id = StringConvert::ToUInt32(value.data(), UINT32_MAX, 0);
4753 if (name == "name")
4754 set_info.name = ConstString(value);
4755 return true; // Keep iterating through all attributes
4756 });
Ed Maste81b4c5f2016-01-04 01:43:47 +00004757
Greg Claytond04f0ed2015-05-26 18:00:51 +00004758 if (set_id != UINT32_MAX)
4759 target_info.reg_set_map[set_id] = set_info;
4760 return true; // Keep iterating through all "group" elements
4761 });
4762 }
4763 return true; // Keep iterating through all children of the target_node
4764 });
Ed Maste81b4c5f2016-01-04 01:43:47 +00004765
Francis Ricci55954ae2016-04-25 21:03:55 +00004766 // Initialize these outside of ParseRegisters, since they should not be reset inside each include feature
4767 uint32_t cur_reg_num = 0;
4768 uint32_t reg_offset = 0;
4769
Jim Ingham7b71c0b2016-02-18 23:58:45 +00004770 // Don't use Process::GetABI, this code gets called from DidAttach, and in that context we haven't
4771 // set the Target's architecture yet, so the ABI is also potentially incorrect.
4772 ABISP abi_to_use_sp = ABI::FindPlugin(arch_to_use);
Greg Claytond04f0ed2015-05-26 18:00:51 +00004773 if (feature_node)
4774 {
Francis Ricci55954ae2016-04-25 21:03:55 +00004775 ParseRegisters(feature_node, target_info, this->m_register_info, abi_to_use_sp, cur_reg_num, reg_offset);
Greg Claytond04f0ed2015-05-26 18:00:51 +00004776 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00004777
Greg Claytond04f0ed2015-05-26 18:00:51 +00004778 for (const auto &include : target_info.includes)
4779 {
4780 // request register file
4781 std::string xml_data;
4782 if (!comm.ReadExtFeature(ConstString("features"),
4783 ConstString(include),
4784 xml_data,
4785 lldberr))
4786 continue;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004787
Greg Claytond04f0ed2015-05-26 18:00:51 +00004788 XMLDocument include_xml_document;
4789 include_xml_document.ParseMemory(xml_data.data(), xml_data.size(), include.c_str());
4790 XMLNode include_feature_node = include_xml_document.GetRootElement("feature");
4791 if (include_feature_node)
4792 {
Francis Ricci55954ae2016-04-25 21:03:55 +00004793 ParseRegisters(include_feature_node, target_info, this->m_register_info, abi_to_use_sp, cur_reg_num, reg_offset);
Greg Claytond04f0ed2015-05-26 18:00:51 +00004794 }
4795 }
Jim Ingham7b71c0b2016-02-18 23:58:45 +00004796 this->m_register_info.Finalize(arch_to_use);
Colin Rileyc3c95b22015-04-16 15:51:33 +00004797 }
4798 }
4799
Greg Claytond04f0ed2015-05-26 18:00:51 +00004800 return m_register_info.GetNumRegisters() > 0;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004801}
4802
Aidan Doddsc0c83852015-05-08 09:36:31 +00004803Error
Stephane Sezer87b0fe02016-01-12 19:02:41 +00004804ProcessGDBRemote::GetLoadedModuleList (LoadedModuleInfoList & list)
Aidan Doddsc0c83852015-05-08 09:36:31 +00004805{
Greg Claytond04f0ed2015-05-26 18:00:51 +00004806 // Make sure LLDB has an XML parser it can use first
4807 if (!XMLDocument::XMLEnabled())
4808 return Error (0, ErrorType::eErrorTypeGeneric);
4809
Aidan Doddsc0c83852015-05-08 09:36:31 +00004810 Log *log = GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS);
4811 if (log)
4812 log->Printf ("ProcessGDBRemote::%s", __FUNCTION__);
4813
Aidan Doddsc0c83852015-05-08 09:36:31 +00004814 GDBRemoteCommunicationClient & comm = m_gdb_comm;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004815
4816 // check that we have extended feature read support
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004817 if (comm.GetQXferLibrariesSVR4ReadSupported ()) {
4818 list.clear ();
Aidan Doddsc0c83852015-05-08 09:36:31 +00004819
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004820 // request the loaded library list
4821 std::string raw;
4822 lldb_private::Error lldberr;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004823
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004824 if (!comm.ReadExtFeature (ConstString ("libraries-svr4"), ConstString (""), raw, lldberr))
4825 return Error (0, ErrorType::eErrorTypeGeneric);
Aidan Doddsc0c83852015-05-08 09:36:31 +00004826
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004827 // parse the xml file in memory
4828 if (log)
4829 log->Printf ("parsing: %s", raw.c_str());
4830 XMLDocument doc;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004831
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004832 if (!doc.ParseMemory(raw.c_str(), raw.size(), "noname.xml"))
4833 return Error (0, ErrorType::eErrorTypeGeneric);
Aidan Doddsc0c83852015-05-08 09:36:31 +00004834
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004835 XMLNode root_element = doc.GetRootElement("library-list-svr4");
4836 if (!root_element)
4837 return Error();
Aidan Doddsc0c83852015-05-08 09:36:31 +00004838
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004839 // main link map structure
4840 llvm::StringRef main_lm = root_element.GetAttributeValue("main-lm");
4841 if (!main_lm.empty())
4842 {
4843 list.m_link_map = StringConvert::ToUInt64(main_lm.data(), LLDB_INVALID_ADDRESS, 0);
4844 }
Aidan Doddsc0c83852015-05-08 09:36:31 +00004845
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004846 root_element.ForEachChildElementWithName("library", [log, &list](const XMLNode &library) -> bool {
Aidan Doddsc0c83852015-05-08 09:36:31 +00004847
Stephane Sezer87b0fe02016-01-12 19:02:41 +00004848 LoadedModuleInfoList::LoadedModuleInfo module;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004849
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004850 library.ForEachAttribute([log, &module](const llvm::StringRef &name, const llvm::StringRef &value) -> bool {
Ed Maste81b4c5f2016-01-04 01:43:47 +00004851
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004852 if (name == "name")
4853 module.set_name (value.str());
4854 else if (name == "lm")
4855 {
4856 // the address of the link_map struct.
4857 module.set_link_map(StringConvert::ToUInt64(value.data(), LLDB_INVALID_ADDRESS, 0));
4858 }
4859 else if (name == "l_addr")
4860 {
4861 // the displacement as read from the field 'l_addr' of the link_map struct.
4862 module.set_base(StringConvert::ToUInt64(value.data(), LLDB_INVALID_ADDRESS, 0));
Stephane Sezerc6845a02015-08-20 22:07:48 +00004863 // base address is always a displacement, not an absolute value.
4864 module.set_base_is_offset(true);
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004865 }
4866 else if (name == "l_ld")
4867 {
4868 // the memory address of the libraries PT_DYAMIC section.
4869 module.set_dynamic(StringConvert::ToUInt64(value.data(), LLDB_INVALID_ADDRESS, 0));
4870 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00004871
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004872 return true; // Keep iterating over all properties of "library"
4873 });
4874
4875 if (log)
Aidan Doddsc0c83852015-05-08 09:36:31 +00004876 {
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004877 std::string name;
4878 lldb::addr_t lm=0, base=0, ld=0;
Stephane Sezerc6845a02015-08-20 22:07:48 +00004879 bool base_is_offset;
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004880
4881 module.get_name (name);
4882 module.get_link_map (lm);
4883 module.get_base (base);
Stephane Sezerc6845a02015-08-20 22:07:48 +00004884 module.get_base_is_offset (base_is_offset);
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004885 module.get_dynamic (ld);
4886
Stephane Sezerc6845a02015-08-20 22:07:48 +00004887 log->Printf ("found (link_map:0x%08" PRIx64 ", base:0x%08" PRIx64 "[%s], ld:0x%08" PRIx64 ", name:'%s')", lm, base, (base_is_offset ? "offset" : "absolute"), ld, name.c_str());
Aidan Doddsc0c83852015-05-08 09:36:31 +00004888 }
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004889
4890 list.add (module);
4891 return true; // Keep iterating over all "library" elements in the root node
Greg Claytond04f0ed2015-05-26 18:00:51 +00004892 });
Aidan Doddsc0c83852015-05-08 09:36:31 +00004893
4894 if (log)
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004895 log->Printf ("found %" PRId32 " modules in total", (int) list.m_list.size());
4896 } else if (comm.GetQXferLibrariesReadSupported ()) {
4897 list.clear ();
Aidan Doddsc0c83852015-05-08 09:36:31 +00004898
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004899 // request the loaded library list
4900 std::string raw;
4901 lldb_private::Error lldberr;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004902
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004903 if (!comm.ReadExtFeature (ConstString ("libraries"), ConstString (""), raw, lldberr))
4904 return Error (0, ErrorType::eErrorTypeGeneric);
Aidan Doddsc0c83852015-05-08 09:36:31 +00004905
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004906 if (log)
4907 log->Printf ("parsing: %s", raw.c_str());
4908 XMLDocument doc;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004909
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004910 if (!doc.ParseMemory(raw.c_str(), raw.size(), "noname.xml"))
4911 return Error (0, ErrorType::eErrorTypeGeneric);
4912
4913 XMLNode root_element = doc.GetRootElement("library-list");
4914 if (!root_element)
4915 return Error();
4916
4917 root_element.ForEachChildElementWithName("library", [log, &list](const XMLNode &library) -> bool {
Stephane Sezer87b0fe02016-01-12 19:02:41 +00004918 LoadedModuleInfoList::LoadedModuleInfo module;
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004919
4920 llvm::StringRef name = library.GetAttributeValue("name");
4921 module.set_name(name.str());
4922
4923 // The base address of a given library will be the address of its
4924 // first section. Most remotes send only one section for Windows
4925 // targets for example.
4926 const XMLNode &section = library.FindFirstChildElementWithName("section");
4927 llvm::StringRef address = section.GetAttributeValue("address");
4928 module.set_base(StringConvert::ToUInt64(address.data(), LLDB_INVALID_ADDRESS, 0));
Stephane Sezerc6845a02015-08-20 22:07:48 +00004929 // These addresses are absolute values.
4930 module.set_base_is_offset(false);
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004931
4932 if (log)
4933 {
4934 std::string name;
4935 lldb::addr_t base = 0;
Stephane Sezerc6845a02015-08-20 22:07:48 +00004936 bool base_is_offset;
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004937 module.get_name (name);
4938 module.get_base (base);
Stephane Sezerc6845a02015-08-20 22:07:48 +00004939 module.get_base_is_offset (base_is_offset);
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004940
Stephane Sezerc6845a02015-08-20 22:07:48 +00004941 log->Printf ("found (base:0x%08" PRIx64 "[%s], name:'%s')", base, (base_is_offset ? "offset" : "absolute"), name.c_str());
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004942 }
4943
4944 list.add (module);
4945 return true; // Keep iterating over all "library" elements in the root node
4946 });
4947
4948 if (log)
4949 log->Printf ("found %" PRId32 " modules in total", (int) list.m_list.size());
4950 } else {
4951 return Error (0, ErrorType::eErrorTypeGeneric);
4952 }
Aidan Doddsc0c83852015-05-08 09:36:31 +00004953
4954 return Error();
4955}
4956
Aidan Doddsc0c83852015-05-08 09:36:31 +00004957lldb::ModuleSP
Stephane Sezer3553c0e2016-04-05 17:25:32 +00004958ProcessGDBRemote::LoadModuleAtAddress (const FileSpec &file, lldb::addr_t link_map,
4959 lldb::addr_t base_addr, bool value_is_offset)
Aidan Doddsc0c83852015-05-08 09:36:31 +00004960{
Stephane Sezer3553c0e2016-04-05 17:25:32 +00004961 DynamicLoader *loader = GetDynamicLoader();
4962 if (!loader)
4963 return nullptr;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004964
Stephane Sezer3553c0e2016-04-05 17:25:32 +00004965 return loader->LoadModuleAtAddress(file, link_map, base_addr, value_is_offset);
Aidan Doddsc0c83852015-05-08 09:36:31 +00004966}
4967
4968size_t
Stephane Sezer87b0fe02016-01-12 19:02:41 +00004969ProcessGDBRemote::LoadModules (LoadedModuleInfoList &module_list)
Aidan Doddsc0c83852015-05-08 09:36:31 +00004970{
4971 using lldb_private::process_gdb_remote::ProcessGDBRemote;
4972
4973 // request a list of loaded libraries from GDBServer
Aidan Doddsc0c83852015-05-08 09:36:31 +00004974 if (GetLoadedModuleList (module_list).Fail())
4975 return 0;
4976
4977 // get a list of all the modules
4978 ModuleList new_modules;
4979
Stephane Sezer87b0fe02016-01-12 19:02:41 +00004980 for (LoadedModuleInfoList::LoadedModuleInfo & modInfo : module_list.m_list)
Aidan Doddsc0c83852015-05-08 09:36:31 +00004981 {
4982 std::string mod_name;
4983 lldb::addr_t mod_base;
Stephane Sezer3553c0e2016-04-05 17:25:32 +00004984 lldb::addr_t link_map;
Stephane Sezerc6845a02015-08-20 22:07:48 +00004985 bool mod_base_is_offset;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004986
4987 bool valid = true;
4988 valid &= modInfo.get_name (mod_name);
4989 valid &= modInfo.get_base (mod_base);
Stephane Sezerc6845a02015-08-20 22:07:48 +00004990 valid &= modInfo.get_base_is_offset (mod_base_is_offset);
Aidan Doddsc0c83852015-05-08 09:36:31 +00004991 if (!valid)
4992 continue;
4993
Stephane Sezer3553c0e2016-04-05 17:25:32 +00004994 if (!modInfo.get_link_map (link_map))
4995 link_map = LLDB_INVALID_ADDRESS;
4996
Francis Riccia0300612016-04-27 17:10:15 +00004997 FileSpec file (mod_name.c_str(), true);
Stephane Sezer3553c0e2016-04-05 17:25:32 +00004998 lldb::ModuleSP module_sp = LoadModuleAtAddress (file, link_map, mod_base,
4999 mod_base_is_offset);
Aidan Doddsc0c83852015-05-08 09:36:31 +00005000
5001 if (module_sp.get())
5002 new_modules.Append (module_sp);
5003 }
5004
5005 if (new_modules.GetSize() > 0)
5006 {
Francis Riccibe8cab72016-04-25 21:02:24 +00005007 ModuleList removed_modules;
Zachary Turner7529df92015-09-01 20:02:29 +00005008 Target &target = GetTarget();
Francis Riccibe8cab72016-04-25 21:02:24 +00005009 ModuleList &loaded_modules = m_process->GetTarget().GetImages();
5010
5011 for (size_t i = 0; i < loaded_modules.GetSize(); ++i)
5012 {
5013 const lldb::ModuleSP loaded_module = loaded_modules.GetModuleAtIndex(i);
5014
5015 bool found = false;
5016 for (size_t j = 0; j < new_modules.GetSize(); ++j)
5017 {
5018 if (new_modules.GetModuleAtIndex(j).get() == loaded_module.get())
5019 found = true;
5020 }
5021
Francis Ricci80dbd152016-06-06 15:00:50 +00005022 // The main executable will never be included in libraries-svr4, don't remove it
5023 if (!found && loaded_module.get() != target.GetExecutableModulePointer())
Francis Riccibe8cab72016-04-25 21:02:24 +00005024 {
Francis Ricci80dbd152016-06-06 15:00:50 +00005025 removed_modules.Append (loaded_module);
Francis Riccibe8cab72016-04-25 21:02:24 +00005026 }
5027 }
5028
5029 loaded_modules.Remove (removed_modules);
5030 m_process->GetTarget().ModulesDidUnload (removed_modules, false);
Aidan Doddsc0c83852015-05-08 09:36:31 +00005031
5032 new_modules.ForEach ([&target](const lldb::ModuleSP module_sp) -> bool
5033 {
5034 lldb_private::ObjectFile * obj = module_sp->GetObjectFile ();
5035 if (!obj)
5036 return true;
5037
5038 if (obj->GetType () != ObjectFile::Type::eTypeExecutable)
5039 return true;
5040
5041 lldb::ModuleSP module_copy_sp = module_sp;
5042 target.SetExecutableModule (module_copy_sp, false);
5043 return false;
5044 });
5045
Aidan Doddsc0c83852015-05-08 09:36:31 +00005046 loaded_modules.AppendIfNeeded (new_modules);
5047 m_process->GetTarget().ModulesDidLoad (new_modules);
5048 }
5049
5050 return new_modules.GetSize();
Stephane Sezer87b0fe02016-01-12 19:02:41 +00005051}
5052
5053size_t
5054ProcessGDBRemote::LoadModules ()
5055{
5056 LoadedModuleInfoList module_list;
5057 return LoadModules (module_list);
Aidan Doddsc0c83852015-05-08 09:36:31 +00005058}
Colin Rileyc3c95b22015-04-16 15:51:33 +00005059
Tamas Berghammer783bfc82015-06-18 20:43:56 +00005060Error
5061ProcessGDBRemote::GetFileLoadAddress(const FileSpec& file, bool& is_loaded, lldb::addr_t& load_addr)
5062{
5063 is_loaded = false;
5064 load_addr = LLDB_INVALID_ADDRESS;
5065
5066 std::string file_path = file.GetPath(false);
5067 if (file_path.empty ())
5068 return Error("Empty file name specified");
5069
5070 StreamString packet;
5071 packet.PutCString("qFileLoadAddress:");
5072 packet.PutCStringAsRawHex8(file_path.c_str());
5073
5074 StringExtractorGDBRemote response;
5075 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetString().c_str(), response, false) != GDBRemoteCommunication::PacketResult::Success)
5076 return Error("Sending qFileLoadAddress packet failed");
5077
5078 if (response.IsErrorResponse())
5079 {
5080 if (response.GetError() == 1)
5081 {
5082 // The file is not loaded into the inferior
5083 is_loaded = false;
5084 load_addr = LLDB_INVALID_ADDRESS;
5085 return Error();
5086 }
5087
5088 return Error("Fetching file load address from remote server returned an error");
5089 }
5090
5091 if (response.IsNormalResponse())
5092 {
5093 is_loaded = true;
5094 load_addr = response.GetHexMaxU64(false, LLDB_INVALID_ADDRESS);
5095 return Error();
5096 }
5097
5098 return Error("Unknown error happened during sending the load address packet");
5099}
5100
Eugene Zelenko0722f082015-10-24 01:28:05 +00005101
Greg Clayton0b90be12015-06-23 21:27:50 +00005102void
5103ProcessGDBRemote::ModulesDidLoad (ModuleList &module_list)
5104{
5105 // We must call the lldb_private::Process::ModulesDidLoad () first before we do anything
5106 Process::ModulesDidLoad (module_list);
5107
5108 // After loading shared libraries, we can ask our remote GDB server if
5109 // it needs any symbols.
5110 m_gdb_comm.ServeSymbolLookups(this);
5111}
5112
Pavel Labath8c1b6bd2016-08-09 12:04:46 +00005113void
5114ProcessGDBRemote::HandleAsyncStdout(llvm::StringRef out)
5115{
5116 AppendSTDOUT(out.data(), out.size());
5117}
5118
5119static const char *end_delimiter = "--end--;";
5120static const int end_delimiter_len = 8;
5121
5122void
5123ProcessGDBRemote::HandleAsyncMisc(llvm::StringRef data)
5124{
5125 std::string input = data.str(); // '1' to move beyond 'A'
5126 if (m_partial_profile_data.length() > 0)
5127 {
5128 m_partial_profile_data.append(input);
5129 input = m_partial_profile_data;
5130 m_partial_profile_data.clear();
5131 }
5132
5133 size_t found, pos = 0, len = input.length();
5134 while ((found = input.find(end_delimiter, pos)) != std::string::npos)
5135 {
5136 StringExtractorGDBRemote profileDataExtractor(input.substr(pos, found).c_str());
5137 std::string profile_data = HarmonizeThreadIdsForProfileData(profileDataExtractor);
5138 BroadcastAsyncProfileData(profile_data);
5139
5140 pos = found + end_delimiter_len;
5141 }
5142
5143 if (pos < len)
5144 {
5145 // Last incomplete chunk.
5146 m_partial_profile_data = input.substr(pos);
5147 }
5148}
5149
5150std::string
5151ProcessGDBRemote::HarmonizeThreadIdsForProfileData(StringExtractorGDBRemote &profileDataExtractor)
5152{
5153 std::map<uint64_t, uint32_t> new_thread_id_to_used_usec_map;
5154 std::stringstream final_output;
5155 std::string name, value;
5156
5157 // Going to assuming thread_used_usec comes first, else bail out.
5158 while (profileDataExtractor.GetNameColonValue(name, value))
5159 {
5160 if (name.compare("thread_used_id") == 0)
5161 {
5162 StringExtractor threadIDHexExtractor(value.c_str());
5163 uint64_t thread_id = threadIDHexExtractor.GetHexMaxU64(false, 0);
5164
5165 bool has_used_usec = false;
5166 uint32_t curr_used_usec = 0;
5167 std::string usec_name, usec_value;
5168 uint32_t input_file_pos = profileDataExtractor.GetFilePos();
5169 if (profileDataExtractor.GetNameColonValue(usec_name, usec_value))
5170 {
5171 if (usec_name.compare("thread_used_usec") == 0)
5172 {
5173 has_used_usec = true;
5174 curr_used_usec = strtoull(usec_value.c_str(), NULL, 0);
5175 }
5176 else
5177 {
5178 // We didn't find what we want, it is probably
5179 // an older version. Bail out.
5180 profileDataExtractor.SetFilePos(input_file_pos);
5181 }
5182 }
5183
5184 if (has_used_usec)
5185 {
5186 uint32_t prev_used_usec = 0;
5187 std::map<uint64_t, uint32_t>::iterator iterator = m_thread_id_to_used_usec_map.find(thread_id);
5188 if (iterator != m_thread_id_to_used_usec_map.end())
5189 {
5190 prev_used_usec = m_thread_id_to_used_usec_map[thread_id];
5191 }
5192
5193 uint32_t real_used_usec = curr_used_usec - prev_used_usec;
5194 // A good first time record is one that runs for at least 0.25 sec
5195 bool good_first_time = (prev_used_usec == 0) && (real_used_usec > 250000);
5196 bool good_subsequent_time =
5197 (prev_used_usec > 0) && ((real_used_usec > 0) || (HasAssignedIndexIDToThread(thread_id)));
5198
5199 if (good_first_time || good_subsequent_time)
5200 {
5201 // We try to avoid doing too many index id reservation,
5202 // resulting in fast increase of index ids.
5203
5204 final_output << name << ":";
5205 int32_t index_id = AssignIndexIDToThread(thread_id);
5206 final_output << index_id << ";";
5207
5208 final_output << usec_name << ":" << usec_value << ";";
5209 }
5210 else
5211 {
5212 // Skip past 'thread_used_name'.
5213 std::string local_name, local_value;
5214 profileDataExtractor.GetNameColonValue(local_name, local_value);
5215 }
5216
5217 // Store current time as previous time so that they can be compared later.
5218 new_thread_id_to_used_usec_map[thread_id] = curr_used_usec;
5219 }
5220 else
5221 {
5222 // Bail out and use old string.
5223 final_output << name << ":" << value << ";";
5224 }
5225 }
5226 else
5227 {
5228 final_output << name << ":" << value << ";";
5229 }
5230 }
5231 final_output << end_delimiter;
5232 m_thread_id_to_used_usec_map = new_thread_id_to_used_usec_map;
5233
5234 return final_output.str();
5235}
5236
5237void
5238ProcessGDBRemote::HandleStopReply()
5239{
5240 if (GetStopID() != 0)
5241 return;
5242
5243 if (GetID() == LLDB_INVALID_PROCESS_ID)
5244 {
5245 lldb::pid_t pid = m_gdb_comm.GetCurrentProcessID();
5246 if (pid != LLDB_INVALID_PROCESS_ID)
5247 SetID(pid);
5248 }
5249 BuildDynamicRegisterInfo(true);
5250}
Eugene Zelenko0722f082015-10-24 01:28:05 +00005251
Todd Fiala75930012016-08-19 04:21:48 +00005252bool
5253ProcessGDBRemote::HandleAsyncStructuredData(const StructuredData::ObjectSP
5254 &object_sp)
5255{
5256 return RouteAsyncStructuredData(object_sp);
5257}
5258
Greg Claytone034a042015-05-21 20:52:06 +00005259class CommandObjectProcessGDBRemoteSpeedTest: public CommandObjectParsed
5260{
5261public:
5262 CommandObjectProcessGDBRemoteSpeedTest(CommandInterpreter &interpreter) :
5263 CommandObjectParsed (interpreter,
5264 "process plugin packet speed-test",
5265 "Tests packet speeds of various sizes to determine the performance characteristics of the GDB remote connection. ",
5266 NULL),
Todd Fialae1cfbc72016-08-11 23:51:28 +00005267 m_option_group (),
Greg Claytone034a042015-05-21 20:52:06 +00005268 m_num_packets (LLDB_OPT_SET_1, false, "count", 'c', 0, eArgTypeCount, "The number of packets to send of each varying size (default is 1000).", 1000),
5269 m_max_send (LLDB_OPT_SET_1, false, "max-send", 's', 0, eArgTypeCount, "The maximum number of bytes to send in a packet. Sizes increase in powers of 2 while the size is less than or equal to this option value. (default 1024).", 1024),
5270 m_max_recv (LLDB_OPT_SET_1, false, "max-receive", 'r', 0, eArgTypeCount, "The maximum number of bytes to receive in a packet. Sizes increase in powers of 2 while the size is less than or equal to this option value. (default 1024).", 1024),
5271 m_json (LLDB_OPT_SET_1, false, "json", 'j', "Print the output as JSON data for easy parsing.", false, true)
5272 {
5273 m_option_group.Append (&m_num_packets, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
5274 m_option_group.Append (&m_max_send, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
5275 m_option_group.Append (&m_max_recv, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
5276 m_option_group.Append (&m_json, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
5277 m_option_group.Finalize();
5278 }
5279
Eugene Zelenko0722f082015-10-24 01:28:05 +00005280 ~CommandObjectProcessGDBRemoteSpeedTest ()
5281 {
5282 }
5283
Greg Claytone034a042015-05-21 20:52:06 +00005284
5285 Options *
5286 GetOptions () override
5287 {
5288 return &m_option_group;
5289 }
5290
5291 bool
5292 DoExecute (Args& command, CommandReturnObject &result) override
5293 {
5294 const size_t argc = command.GetArgumentCount();
5295 if (argc == 0)
5296 {
5297 ProcessGDBRemote *process = (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
5298 if (process)
5299 {
5300 StreamSP output_stream_sp (m_interpreter.GetDebugger().GetAsyncOutputStream());
5301 result.SetImmediateOutputStream (output_stream_sp);
5302
5303 const uint32_t num_packets = (uint32_t)m_num_packets.GetOptionValue().GetCurrentValue();
5304 const uint64_t max_send = m_max_send.GetOptionValue().GetCurrentValue();
5305 const uint64_t max_recv = m_max_recv.GetOptionValue().GetCurrentValue();
5306 const bool json = m_json.GetOptionValue().GetCurrentValue();
5307 if (output_stream_sp)
5308 process->GetGDBRemote().TestPacketSpeed (num_packets, max_send, max_recv, json, *output_stream_sp);
5309 else
5310 {
5311 process->GetGDBRemote().TestPacketSpeed (num_packets, max_send, max_recv, json, result.GetOutputStream());
5312 }
5313 result.SetStatus (eReturnStatusSuccessFinishResult);
5314 return true;
5315 }
5316 }
5317 else
5318 {
5319 result.AppendErrorWithFormat ("'%s' takes no arguments", m_cmd_name.c_str());
5320 }
5321 result.SetStatus (eReturnStatusFailed);
5322 return false;
5323 }
5324protected:
5325 OptionGroupOptions m_option_group;
5326 OptionGroupUInt64 m_num_packets;
5327 OptionGroupUInt64 m_max_send;
5328 OptionGroupUInt64 m_max_recv;
5329 OptionGroupBoolean m_json;
Eugene Zelenko0722f082015-10-24 01:28:05 +00005330
Greg Claytone034a042015-05-21 20:52:06 +00005331};
5332
Greg Clayton02686b82012-10-15 22:42:16 +00005333class CommandObjectProcessGDBRemotePacketHistory : public CommandObjectParsed
Greg Clayton998255b2012-10-13 02:07:45 +00005334{
Eugene Zelenko0722f082015-10-24 01:28:05 +00005335private:
Ed Maste81b4c5f2016-01-04 01:43:47 +00005336
Greg Clayton998255b2012-10-13 02:07:45 +00005337public:
Greg Clayton02686b82012-10-15 22:42:16 +00005338 CommandObjectProcessGDBRemotePacketHistory(CommandInterpreter &interpreter) :
Greg Clayton998255b2012-10-13 02:07:45 +00005339 CommandObjectParsed (interpreter,
Greg Clayton02686b82012-10-15 22:42:16 +00005340 "process plugin packet history",
5341 "Dumps the packet history buffer. ",
Greg Clayton998255b2012-10-13 02:07:45 +00005342 NULL)
5343 {
5344 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005345
Eugene Zelenko0722f082015-10-24 01:28:05 +00005346 ~CommandObjectProcessGDBRemotePacketHistory ()
5347 {
5348 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005349
Greg Clayton998255b2012-10-13 02:07:45 +00005350 bool
Tamas Berghammer30b8cd32015-03-23 15:50:03 +00005351 DoExecute (Args& command, CommandReturnObject &result) override
Greg Clayton998255b2012-10-13 02:07:45 +00005352 {
Greg Clayton02686b82012-10-15 22:42:16 +00005353 const size_t argc = command.GetArgumentCount();
5354 if (argc == 0)
5355 {
5356 ProcessGDBRemote *process = (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
5357 if (process)
5358 {
5359 process->GetGDBRemote().DumpHistory(result.GetOutputStream());
5360 result.SetStatus (eReturnStatusSuccessFinishResult);
5361 return true;
5362 }
5363 }
5364 else
5365 {
5366 result.AppendErrorWithFormat ("'%s' takes no arguments", m_cmd_name.c_str());
5367 }
5368 result.SetStatus (eReturnStatusFailed);
5369 return false;
5370 }
5371};
5372
Jason Molenda6076bf42014-05-06 04:34:52 +00005373class CommandObjectProcessGDBRemotePacketXferSize : public CommandObjectParsed
5374{
Eugene Zelenko0722f082015-10-24 01:28:05 +00005375private:
Ed Maste81b4c5f2016-01-04 01:43:47 +00005376
Jason Molenda6076bf42014-05-06 04:34:52 +00005377public:
5378 CommandObjectProcessGDBRemotePacketXferSize(CommandInterpreter &interpreter) :
5379 CommandObjectParsed (interpreter,
5380 "process plugin packet xfer-size",
5381 "Maximum size that lldb will try to read/write one one chunk.",
5382 NULL)
5383 {
5384 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005385
Eugene Zelenko0722f082015-10-24 01:28:05 +00005386 ~CommandObjectProcessGDBRemotePacketXferSize ()
5387 {
5388 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005389
Jason Molenda6076bf42014-05-06 04:34:52 +00005390 bool
Tamas Berghammer30b8cd32015-03-23 15:50:03 +00005391 DoExecute (Args& command, CommandReturnObject &result) override
Jason Molenda6076bf42014-05-06 04:34:52 +00005392 {
5393 const size_t argc = command.GetArgumentCount();
5394 if (argc == 0)
5395 {
5396 result.AppendErrorWithFormat ("'%s' takes an argument to specify the max amount to be transferred when reading/writing", m_cmd_name.c_str());
5397 result.SetStatus (eReturnStatusFailed);
5398 return false;
5399 }
5400
5401 ProcessGDBRemote *process = (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
5402 if (process)
5403 {
5404 const char *packet_size = command.GetArgumentAtIndex(0);
5405 errno = 0;
5406 uint64_t user_specified_max = strtoul (packet_size, NULL, 10);
5407 if (errno == 0 && user_specified_max != 0)
5408 {
5409 process->SetUserSpecifiedMaxMemoryTransferSize (user_specified_max);
5410 result.SetStatus (eReturnStatusSuccessFinishResult);
5411 return true;
5412 }
5413 }
5414 result.SetStatus (eReturnStatusFailed);
5415 return false;
5416 }
5417};
5418
Eugene Zelenko0722f082015-10-24 01:28:05 +00005419
Greg Clayton02686b82012-10-15 22:42:16 +00005420class CommandObjectProcessGDBRemotePacketSend : public CommandObjectParsed
5421{
Eugene Zelenko0722f082015-10-24 01:28:05 +00005422private:
Ed Maste81b4c5f2016-01-04 01:43:47 +00005423
Greg Clayton02686b82012-10-15 22:42:16 +00005424public:
5425 CommandObjectProcessGDBRemotePacketSend(CommandInterpreter &interpreter) :
5426 CommandObjectParsed (interpreter,
5427 "process plugin packet send",
5428 "Send a custom packet through the GDB remote protocol and print the answer. "
5429 "The packet header and footer will automatically be added to the packet prior to sending and stripped from the result.",
5430 NULL)
5431 {
5432 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005433
Eugene Zelenko0722f082015-10-24 01:28:05 +00005434 ~CommandObjectProcessGDBRemotePacketSend ()
5435 {
5436 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005437
Greg Clayton02686b82012-10-15 22:42:16 +00005438 bool
Tamas Berghammer30b8cd32015-03-23 15:50:03 +00005439 DoExecute (Args& command, CommandReturnObject &result) override
Greg Clayton02686b82012-10-15 22:42:16 +00005440 {
5441 const size_t argc = command.GetArgumentCount();
5442 if (argc == 0)
5443 {
5444 result.AppendErrorWithFormat ("'%s' takes a one or more packet content arguments", m_cmd_name.c_str());
5445 result.SetStatus (eReturnStatusFailed);
5446 return false;
5447 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005448
Greg Clayton02686b82012-10-15 22:42:16 +00005449 ProcessGDBRemote *process = (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
5450 if (process)
5451 {
Han Ming Ong84145852012-11-26 20:42:03 +00005452 for (size_t i=0; i<argc; ++ i)
Greg Clayton02686b82012-10-15 22:42:16 +00005453 {
Han Ming Ong84145852012-11-26 20:42:03 +00005454 const char *packet_cstr = command.GetArgumentAtIndex(0);
5455 bool send_async = true;
5456 StringExtractorGDBRemote response;
5457 process->GetGDBRemote().SendPacketAndWaitForResponse(packet_cstr, response, send_async);
5458 result.SetStatus (eReturnStatusSuccessFinishResult);
5459 Stream &output_strm = result.GetOutputStream();
5460 output_strm.Printf (" packet: %s\n", packet_cstr);
Han Ming Ong4b6459f2013-01-18 23:11:53 +00005461 std::string &response_str = response.GetStringRef();
Ed Maste81b4c5f2016-01-04 01:43:47 +00005462
Han Ming Ong399289e2013-06-21 19:56:59 +00005463 if (strstr(packet_cstr, "qGetProfileData") != NULL)
Han Ming Ong4b6459f2013-01-18 23:11:53 +00005464 {
Pavel Labath8c1b6bd2016-08-09 12:04:46 +00005465 response_str = process->HarmonizeThreadIdsForProfileData(response);
Han Ming Ong4b6459f2013-01-18 23:11:53 +00005466 }
5467
Han Ming Ong84145852012-11-26 20:42:03 +00005468 if (response_str.empty())
5469 output_strm.PutCString ("response: \nerror: UNIMPLEMENTED\n");
5470 else
5471 output_strm.Printf ("response: %s\n", response.GetStringRef().c_str());
Greg Clayton02686b82012-10-15 22:42:16 +00005472 }
Greg Clayton02686b82012-10-15 22:42:16 +00005473 }
Greg Clayton998255b2012-10-13 02:07:45 +00005474 return true;
5475 }
5476};
5477
Greg Claytonba4a0a52013-02-01 23:03:47 +00005478class CommandObjectProcessGDBRemotePacketMonitor : public CommandObjectRaw
5479{
Eugene Zelenko0722f082015-10-24 01:28:05 +00005480private:
Ed Maste81b4c5f2016-01-04 01:43:47 +00005481
Greg Claytonba4a0a52013-02-01 23:03:47 +00005482public:
5483 CommandObjectProcessGDBRemotePacketMonitor(CommandInterpreter &interpreter) :
5484 CommandObjectRaw (interpreter,
5485 "process plugin packet monitor",
Greg Claytoneee5e982013-02-14 18:39:30 +00005486 "Send a qRcmd packet through the GDB remote protocol and print the response."
5487 "The argument passed to this command will be hex encoded into a valid 'qRcmd' packet, sent and the response will be printed.",
Greg Claytonba4a0a52013-02-01 23:03:47 +00005488 NULL)
5489 {
5490 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005491
Eugene Zelenko0722f082015-10-24 01:28:05 +00005492 ~CommandObjectProcessGDBRemotePacketMonitor ()
5493 {
5494 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005495
Greg Claytonba4a0a52013-02-01 23:03:47 +00005496 bool
Tamas Berghammer30b8cd32015-03-23 15:50:03 +00005497 DoExecute (const char *command, CommandReturnObject &result) override
Greg Claytonba4a0a52013-02-01 23:03:47 +00005498 {
5499 if (command == NULL || command[0] == '\0')
5500 {
5501 result.AppendErrorWithFormat ("'%s' takes a command string argument", m_cmd_name.c_str());
5502 result.SetStatus (eReturnStatusFailed);
5503 return false;
5504 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005505
Greg Claytonba4a0a52013-02-01 23:03:47 +00005506 ProcessGDBRemote *process = (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
5507 if (process)
5508 {
5509 StreamString packet;
Greg Claytoneee5e982013-02-14 18:39:30 +00005510 packet.PutCString("qRcmd,");
Greg Claytonba4a0a52013-02-01 23:03:47 +00005511 packet.PutBytesAsRawHex8(command, strlen(command));
5512 const char *packet_cstr = packet.GetString().c_str();
Ed Maste81b4c5f2016-01-04 01:43:47 +00005513
Greg Claytonba4a0a52013-02-01 23:03:47 +00005514 bool send_async = true;
5515 StringExtractorGDBRemote response;
5516 process->GetGDBRemote().SendPacketAndWaitForResponse(packet_cstr, response, send_async);
5517 result.SetStatus (eReturnStatusSuccessFinishResult);
5518 Stream &output_strm = result.GetOutputStream();
5519 output_strm.Printf (" packet: %s\n", packet_cstr);
5520 const std::string &response_str = response.GetStringRef();
Ed Maste81b4c5f2016-01-04 01:43:47 +00005521
Greg Claytonba4a0a52013-02-01 23:03:47 +00005522 if (response_str.empty())
5523 output_strm.PutCString ("response: \nerror: UNIMPLEMENTED\n");
5524 else
5525 output_strm.Printf ("response: %s\n", response.GetStringRef().c_str());
5526 }
5527 return true;
5528 }
5529};
5530
Greg Clayton02686b82012-10-15 22:42:16 +00005531class CommandObjectProcessGDBRemotePacket : public CommandObjectMultiword
5532{
Eugene Zelenko0722f082015-10-24 01:28:05 +00005533private:
Ed Maste81b4c5f2016-01-04 01:43:47 +00005534
Greg Clayton02686b82012-10-15 22:42:16 +00005535public:
5536 CommandObjectProcessGDBRemotePacket(CommandInterpreter &interpreter) :
5537 CommandObjectMultiword (interpreter,
5538 "process plugin packet",
5539 "Commands that deal with GDB remote packets.",
5540 NULL)
5541 {
5542 LoadSubCommand ("history", CommandObjectSP (new CommandObjectProcessGDBRemotePacketHistory (interpreter)));
5543 LoadSubCommand ("send", CommandObjectSP (new CommandObjectProcessGDBRemotePacketSend (interpreter)));
Greg Claytonba4a0a52013-02-01 23:03:47 +00005544 LoadSubCommand ("monitor", CommandObjectSP (new CommandObjectProcessGDBRemotePacketMonitor (interpreter)));
Jason Molenda6076bf42014-05-06 04:34:52 +00005545 LoadSubCommand ("xfer-size", CommandObjectSP (new CommandObjectProcessGDBRemotePacketXferSize (interpreter)));
Greg Claytone034a042015-05-21 20:52:06 +00005546 LoadSubCommand ("speed-test", CommandObjectSP (new CommandObjectProcessGDBRemoteSpeedTest (interpreter)));
Greg Clayton02686b82012-10-15 22:42:16 +00005547 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005548
Eugene Zelenko0722f082015-10-24 01:28:05 +00005549 ~CommandObjectProcessGDBRemotePacket ()
5550 {
Ed Maste81b4c5f2016-01-04 01:43:47 +00005551 }
Greg Clayton02686b82012-10-15 22:42:16 +00005552};
Greg Clayton998255b2012-10-13 02:07:45 +00005553
5554class CommandObjectMultiwordProcessGDBRemote : public CommandObjectMultiword
5555{
5556public:
Kate Stone7428a182016-07-14 22:03:10 +00005557 CommandObjectMultiwordProcessGDBRemote(CommandInterpreter &interpreter)
5558 : CommandObjectMultiword(interpreter, "process plugin", "Commands for operating on a ProcessGDBRemote process.",
5559 "process plugin <subcommand> [<subcommand-options>]")
Greg Clayton998255b2012-10-13 02:07:45 +00005560 {
5561 LoadSubCommand ("packet", CommandObjectSP (new CommandObjectProcessGDBRemotePacket (interpreter)));
5562 }
5563
Eugene Zelenko0722f082015-10-24 01:28:05 +00005564 ~CommandObjectMultiwordProcessGDBRemote ()
5565 {
5566 }
Greg Clayton998255b2012-10-13 02:07:45 +00005567};
5568
Greg Clayton998255b2012-10-13 02:07:45 +00005569CommandObject *
5570ProcessGDBRemote::GetPluginCommandObject()
5571{
5572 if (!m_command_sp)
5573 m_command_sp.reset (new CommandObjectMultiwordProcessGDBRemote (GetTarget().GetDebugger().GetCommandInterpreter()));
5574 return m_command_sp.get();
5575}