blob: f1212aeb7d91b66819cc977f33da1155b2ac8c55 [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
Virgile Bellob2f1fb22013-08-23 12:44:05 +000018#endif
Chris Lattner30fdc8d2010-06-08 16:52:24 +000019#include <sys/stat.h>
Greg Clayton2a48f522011-05-14 01:50:35 +000020#include <sys/types.h>
Stephen Wilsondc916862011-03-30 00:12:40 +000021#include <time.h>
Chris Lattner30fdc8d2010-06-08 16:52:24 +000022
23// C++ Includes
24#include <algorithm>
25#include <map>
Benjamin Kramer3f69fa62015-04-03 10:55:00 +000026#include <mutex>
Chris Lattner30fdc8d2010-06-08 16:52:24 +000027
Johnny Chen01a67862011-10-14 00:42:25 +000028#include "lldb/Breakpoint/Watchpoint.h"
Jim Ingham40af72e2010-06-15 19:49:27 +000029#include "lldb/Interpreter/Args.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000030#include "lldb/Core/ArchSpec.h"
31#include "lldb/Core/Debugger.h"
Zachary Turner93a66fc2014-10-06 21:22:36 +000032#include "lldb/Host/ConnectionFileDescriptor.h"
Greg Clayton53239f02011-02-08 05:05:52 +000033#include "lldb/Host/FileSpec.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000034#include "lldb/Core/Module.h"
Greg Clayton1f746072012-08-29 21:13:06 +000035#include "lldb/Core/ModuleSpec.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000036#include "lldb/Core/PluginManager.h"
37#include "lldb/Core/State.h"
Greg Claytond451c1a2012-04-13 21:24:18 +000038#include "lldb/Core/StreamFile.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000039#include "lldb/Core/StreamString.h"
40#include "lldb/Core/Timer.h"
Greg Clayton70b57652011-05-15 01:25:55 +000041#include "lldb/Core/Value.h"
Greg Claytond04f0ed2015-05-26 18:00:51 +000042#include "lldb/DataFormatters/FormatManager.h"
Zachary Turner4eff2d32015-10-14 21:37:36 +000043#include "lldb/Host/FileSystem.h"
Zachary Turner39de3112014-09-09 20:54:56 +000044#include "lldb/Host/HostThread.h"
Vince Harron5275aaa2015-01-15 20:08:35 +000045#include "lldb/Host/StringConvert.h"
Jason Molendad1fae142012-09-29 08:03:33 +000046#include "lldb/Host/Symbols.h"
Zachary Turner39de3112014-09-09 20:54:56 +000047#include "lldb/Host/ThreadLauncher.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000048#include "lldb/Host/TimeValue.h"
Greg Claytond04f0ed2015-05-26 18:00:51 +000049#include "lldb/Host/XML.h"
Greg Clayton02686b82012-10-15 22:42:16 +000050#include "lldb/Interpreter/CommandInterpreter.h"
Greg Clayton1d19a2f2012-10-19 22:22:57 +000051#include "lldb/Interpreter/CommandObject.h"
52#include "lldb/Interpreter/CommandObjectMultiword.h"
Greg Clayton02686b82012-10-15 22:42:16 +000053#include "lldb/Interpreter/CommandReturnObject.h"
Zachary Turner633a29c2015-03-04 01:58:01 +000054#include "lldb/Interpreter/OptionValueProperties.h"
Greg Claytone034a042015-05-21 20:52:06 +000055#include "lldb/Interpreter/Options.h"
56#include "lldb/Interpreter/OptionGroupBoolean.h"
57#include "lldb/Interpreter/OptionGroupUInt64.h"
Zachary Turner633a29c2015-03-04 01:58:01 +000058#include "lldb/Interpreter/Property.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000059#include "lldb/Symbol/ObjectFile.h"
Jason Molenda21586c82015-09-09 03:36:24 +000060#include "lldb/Target/ABI.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000061#include "lldb/Target/DynamicLoader.h"
62#include "lldb/Target/Target.h"
63#include "lldb/Target/TargetList.h"
Greg Clayton2a48f522011-05-14 01:50:35 +000064#include "lldb/Target/ThreadPlanCallFunction.h"
Jason Molenda705b1802014-06-13 02:37:02 +000065#include "lldb/Target/SystemRuntime.h"
Jason Molendaa34a0c62010-06-09 21:28:42 +000066#include "lldb/Utility/PseudoTerminal.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000067
Eugene Zelenko0722f082015-10-24 01:28:05 +000068// Project includes
Chris Lattner30fdc8d2010-06-08 16:52:24 +000069#include "lldb/Host/Host.h"
Chaoren Lin98d0a4b2015-07-14 01:09:28 +000070#include "Plugins/Process/Utility/GDBRemoteSignals.h"
Peter Collingbourne99f9aa02011-06-03 20:40:38 +000071#include "Plugins/Process/Utility/InferiorCallPOSIX.h"
Jason Molendac42d2432012-07-25 03:40:06 +000072#include "Plugins/Process/Utility/StopInfoMachException.h"
Jim Ingham43c555d2012-07-04 00:35:43 +000073#include "Plugins/Platform/MacOSX/PlatformRemoteiOS.h"
Greg Claytonc982c762010-07-09 20:39:50 +000074#include "Utility/StringExtractorGDBRemote.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000075#include "GDBRemoteRegisterContext.h"
76#include "ProcessGDBRemote.h"
77#include "ProcessGDBRemoteLog.h"
78#include "ThreadGDBRemote.h"
Greg Claytonf4b47e12010-08-04 01:40:35 +000079
Tamas Berghammerdb264a62015-03-31 09:52:22 +000080#define DEBUGSERVER_BASENAME "debugserver"
81using namespace lldb;
82using namespace lldb_private;
83using namespace lldb_private::process_gdb_remote;
Jason Molenda5e8534e2012-10-03 01:29:34 +000084
Greg Claytonc1422c12012-04-09 22:46:21 +000085namespace lldb
86{
87 // Provide a function that can easily dump the packet history if we know a
88 // ProcessGDBRemote * value (which we can get from logs or from debugging).
89 // We need the function in the lldb namespace so it makes it into the final
90 // executable since the LLDB shared library only exports stuff in the lldb
91 // namespace. This allows you to attach with a debugger and call this
92 // function and get the packet history dumped to a file.
93 void
94 DumpProcessGDBRemotePacketHistory (void *p, const char *path)
95 {
Tamas Berghammerdb264a62015-03-31 09:52:22 +000096 StreamFile strm;
97 Error error (strm.GetFile().Open(path, File::eOpenOptionWrite | File::eOpenOptionCanCreate));
Greg Claytond451c1a2012-04-13 21:24:18 +000098 if (error.Success())
99 ((ProcessGDBRemote *)p)->GetGDBRemote().DumpHistory (strm);
Greg Claytonc1422c12012-04-09 22:46:21 +0000100 }
Eugene Zelenko0722f082015-10-24 01:28:05 +0000101}
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000102
Greg Clayton7f982402013-07-15 22:54:20 +0000103namespace {
Steve Pucci5ec012d2014-01-16 22:18:14 +0000104
Greg Clayton7f982402013-07-15 22:54:20 +0000105 static PropertyDefinition
106 g_properties[] =
107 {
108 { "packet-timeout" , OptionValue::eTypeUInt64 , true , 1, NULL, NULL, "Specify the default packet timeout in seconds." },
Greg Claytonef8180a2013-10-15 00:14:28 +0000109 { "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 +0000110 { NULL , OptionValue::eTypeInvalid, false, 0, NULL, NULL, NULL }
111 };
Ed Maste81b4c5f2016-01-04 01:43:47 +0000112
Greg Clayton7f982402013-07-15 22:54:20 +0000113 enum
114 {
Greg Claytonef8180a2013-10-15 00:14:28 +0000115 ePropertyPacketTimeout,
116 ePropertyTargetDefinitionFile
Greg Clayton7f982402013-07-15 22:54:20 +0000117 };
Ed Maste81b4c5f2016-01-04 01:43:47 +0000118
Greg Clayton7f982402013-07-15 22:54:20 +0000119 class PluginProperties : public Properties
120 {
121 public:
Ed Maste81b4c5f2016-01-04 01:43:47 +0000122
Greg Clayton7f982402013-07-15 22:54:20 +0000123 static ConstString
124 GetSettingName ()
125 {
126 return ProcessGDBRemote::GetPluginNameStatic();
127 }
Ed Maste81b4c5f2016-01-04 01:43:47 +0000128
Greg Clayton7f982402013-07-15 22:54:20 +0000129 PluginProperties() :
130 Properties ()
131 {
132 m_collection_sp.reset (new OptionValueProperties(GetSettingName()));
133 m_collection_sp->Initialize(g_properties);
134 }
Ed Maste81b4c5f2016-01-04 01:43:47 +0000135
Eugene Zelenko0722f082015-10-24 01:28:05 +0000136 virtual
137 ~PluginProperties()
138 {
139 }
Ed Maste81b4c5f2016-01-04 01:43:47 +0000140
Greg Clayton7f982402013-07-15 22:54:20 +0000141 uint64_t
142 GetPacketTimeout()
143 {
144 const uint32_t idx = ePropertyPacketTimeout;
145 return m_collection_sp->GetPropertyAtIndexAsUInt64(NULL, idx, g_properties[idx].default_uint_value);
146 }
Greg Clayton9ac6d2d2013-10-25 18:13:17 +0000147
148 bool
149 SetPacketTimeout(uint64_t timeout)
150 {
151 const uint32_t idx = ePropertyPacketTimeout;
152 return m_collection_sp->SetPropertyAtIndexAsUInt64(NULL, idx, timeout);
153 }
154
Greg Claytonef8180a2013-10-15 00:14:28 +0000155 FileSpec
156 GetTargetDefinitionFile () const
157 {
158 const uint32_t idx = ePropertyTargetDefinitionFile;
159 return m_collection_sp->GetPropertyAtIndexAsFileSpec (NULL, idx);
160 }
Greg Clayton7f982402013-07-15 22:54:20 +0000161 };
Ed Maste81b4c5f2016-01-04 01:43:47 +0000162
Greg Clayton7f982402013-07-15 22:54:20 +0000163 typedef std::shared_ptr<PluginProperties> ProcessKDPPropertiesSP;
Ed Maste81b4c5f2016-01-04 01:43:47 +0000164
Greg Clayton7f982402013-07-15 22:54:20 +0000165 static const ProcessKDPPropertiesSP &
166 GetGlobalPluginProperties()
167 {
168 static ProcessKDPPropertiesSP g_settings_sp;
169 if (!g_settings_sp)
170 g_settings_sp.reset (new PluginProperties ());
171 return g_settings_sp;
172 }
Ed Maste81b4c5f2016-01-04 01:43:47 +0000173
Eugene Zelenko0722f082015-10-24 01:28:05 +0000174} // anonymous namespace end
Greg Clayton7f982402013-07-15 22:54:20 +0000175
Greg Claytonfda4fab2014-01-10 22:24:11 +0000176// TODO Randomly assigning a port is unsafe. We should get an unused
177// ephemeral port from the kernel and make sure we reserve it before passing
178// it to debugserver.
179
180#if defined (__APPLE__)
181#define LOW_PORT (IPPORT_RESERVED)
182#define HIGH_PORT (IPPORT_HIFIRSTAUTO)
183#else
184#define LOW_PORT (1024u)
185#define HIGH_PORT (49151u)
186#endif
187
Todd Fiala013434e2014-07-09 01:29:05 +0000188#if defined(__APPLE__) && (defined(__arm__) || defined(__arm64__) || defined(__aarch64__))
Saleem Abdulrasoola68f7b62014-03-20 06:08:36 +0000189static bool rand_initialized = false;
190
Greg Claytonfda4fab2014-01-10 22:24:11 +0000191static inline uint16_t
192get_random_port ()
193{
194 if (!rand_initialized)
195 {
196 time_t seed = time(NULL);
Saleem Abdulrasoola68f7b62014-03-20 06:08:36 +0000197
Greg Claytonfda4fab2014-01-10 22:24:11 +0000198 rand_initialized = true;
199 srand(seed);
200 }
201 return (rand() % (HIGH_PORT - LOW_PORT)) + LOW_PORT;
202}
Saleem Abdulrasoola68f7b62014-03-20 06:08:36 +0000203#endif
Greg Claytonfda4fab2014-01-10 22:24:11 +0000204
Tamas Berghammerdb264a62015-03-31 09:52:22 +0000205ConstString
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000206ProcessGDBRemote::GetPluginNameStatic()
207{
Greg Clayton57abc5d2013-05-10 21:47:16 +0000208 static ConstString g_name("gdb-remote");
209 return g_name;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000210}
211
212const char *
213ProcessGDBRemote::GetPluginDescriptionStatic()
214{
215 return "GDB Remote protocol based debugging plug-in.";
216}
217
218void
219ProcessGDBRemote::Terminate()
220{
221 PluginManager::UnregisterPlugin (ProcessGDBRemote::CreateInstance);
222}
223
Eugene Zelenko0722f082015-10-24 01:28:05 +0000224
Greg Claytonc3776bf2012-02-09 06:16:32 +0000225lldb::ProcessSP
Jim Ingham583bbb12016-03-07 21:50:25 +0000226ProcessGDBRemote::CreateInstance (lldb::TargetSP target_sp, ListenerSP listener_sp, const FileSpec *crash_file_path)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000227{
Greg Claytonc3776bf2012-02-09 06:16:32 +0000228 lldb::ProcessSP process_sp;
229 if (crash_file_path == NULL)
Jim Ingham583bbb12016-03-07 21:50:25 +0000230 process_sp.reset (new ProcessGDBRemote (target_sp, listener_sp));
Greg Claytonc3776bf2012-02-09 06:16:32 +0000231 return process_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000232}
233
234bool
Zachary Turner7529df92015-09-01 20:02:29 +0000235ProcessGDBRemote::CanDebug (lldb::TargetSP target_sp, bool plugin_specified_by_name)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000236{
Greg Clayton596ed242011-10-21 21:41:45 +0000237 if (plugin_specified_by_name)
238 return true;
239
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000240 // For now we are just making sure the file exists for a given module
Zachary Turner7529df92015-09-01 20:02:29 +0000241 Module *exe_module = target_sp->GetExecutableModulePointer();
Greg Claytonaa149cb2011-08-11 02:48:45 +0000242 if (exe_module)
Greg Claytonc3776bf2012-02-09 06:16:32 +0000243 {
244 ObjectFile *exe_objfile = exe_module->GetObjectFile();
245 // We can't debug core files...
246 switch (exe_objfile->GetType())
247 {
248 case ObjectFile::eTypeInvalid:
249 case ObjectFile::eTypeCoreFile:
250 case ObjectFile::eTypeDebugInfo:
251 case ObjectFile::eTypeObjectFile:
252 case ObjectFile::eTypeSharedLibrary:
253 case ObjectFile::eTypeStubLibrary:
Greg Clayton23f8c952014-03-24 23:10:19 +0000254 case ObjectFile::eTypeJIT:
Greg Claytonc3776bf2012-02-09 06:16:32 +0000255 return false;
256 case ObjectFile::eTypeExecutable:
257 case ObjectFile::eTypeDynamicLinker:
258 case ObjectFile::eTypeUnknown:
259 break;
260 }
Greg Claytonaa149cb2011-08-11 02:48:45 +0000261 return exe_module->GetFileSpec().Exists();
Greg Claytonc3776bf2012-02-09 06:16:32 +0000262 }
Jim Ingham5aee1622010-08-09 23:31:02 +0000263 // However, if there is no executable module, we return true since we might be preparing to attach.
264 return true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000265}
266
Eugene Zelenko0722f082015-10-24 01:28:05 +0000267//----------------------------------------------------------------------
268// ProcessGDBRemote constructor
269//----------------------------------------------------------------------
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +0000270ProcessGDBRemote::ProcessGDBRemote(lldb::TargetSP target_sp, ListenerSP listener_sp)
271 : Process(target_sp, listener_sp),
272 m_flags(0),
273 m_gdb_comm(),
274 m_debugserver_pid(LLDB_INVALID_PROCESS_ID),
275 m_last_stop_packet_mutex(),
276 m_register_info(),
277 m_async_broadcaster(NULL, "lldb.process.gdb-remote.async-broadcaster"),
278 m_async_listener_sp(Listener::MakeListener("lldb.process.gdb-remote.async-listener")),
279 m_async_thread_state_mutex(),
280 m_thread_ids(),
281 m_thread_pcs(),
282 m_jstopinfo_sp(),
283 m_jthreadsinfo_sp(),
284 m_continue_c_tids(),
285 m_continue_C_tids(),
286 m_continue_s_tids(),
287 m_continue_S_tids(),
288 m_max_memory_size(0),
289 m_remote_stub_max_memory_size(0),
290 m_addr_to_mmap_size(),
291 m_thread_create_bp_sp(),
292 m_waiting_for_attach(false),
293 m_destroy_tried_resuming(false),
294 m_command_sp(),
295 m_breakpoint_pc_offset(0),
296 m_initial_tid(LLDB_INVALID_THREAD_ID)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000297{
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +0000298 m_async_broadcaster.SetEventName(eBroadcastBitAsyncThreadShouldExit, "async thread should exit");
299 m_async_broadcaster.SetEventName(eBroadcastBitAsyncContinue, "async thread continue");
300 m_async_broadcaster.SetEventName(eBroadcastBitAsyncThreadDidExit, "async thread did exit");
Pavel Labath50556852015-09-03 09:36:22 +0000301
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +0000302 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_ASYNC));
Pavel Labath50556852015-09-03 09:36:22 +0000303
304 const uint32_t async_event_mask = eBroadcastBitAsyncContinue | eBroadcastBitAsyncThreadShouldExit;
305
Jim Ingham583bbb12016-03-07 21:50:25 +0000306 if (m_async_listener_sp->StartListeningForEvents(&m_async_broadcaster, async_event_mask) != async_event_mask)
Pavel Labath50556852015-09-03 09:36:22 +0000307 {
308 if (log)
309 log->Printf("ProcessGDBRemote::%s failed to listen for m_async_broadcaster events", __FUNCTION__);
310 }
311
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +0000312 const uint32_t gdb_event_mask =
313 Communication::eBroadcastBitReadThreadDidExit | GDBRemoteCommunication::eBroadcastBitGdbReadThreadGotNotify;
Jim Ingham583bbb12016-03-07 21:50:25 +0000314 if (m_async_listener_sp->StartListeningForEvents(&m_gdb_comm, gdb_event_mask) != gdb_event_mask)
Pavel Labath50556852015-09-03 09:36:22 +0000315 {
316 if (log)
317 log->Printf("ProcessGDBRemote::%s failed to listen for m_gdb_comm events", __FUNCTION__);
318 }
319
Greg Clayton7f982402013-07-15 22:54:20 +0000320 const uint64_t timeout_seconds = GetGlobalPluginProperties()->GetPacketTimeout();
321 if (timeout_seconds > 0)
322 m_gdb_comm.SetPacketTimeout(timeout_seconds);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000323}
324
Eugene Zelenko0722f082015-10-24 01:28:05 +0000325//----------------------------------------------------------------------
326// Destructor
327//----------------------------------------------------------------------
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000328ProcessGDBRemote::~ProcessGDBRemote()
329{
330 // m_mach_process.UnregisterNotificationCallbacks (this);
331 Clear();
Greg Clayton1ed54f52011-10-01 00:45:15 +0000332 // We need to call finalize on the process before destroying ourselves
333 // to make sure all of the broadcaster cleanup goes as planned. If we
334 // destruct this class, then Process::~Process() might have problems
335 // trying to fully destroy the broadcaster.
336 Finalize();
Ed Maste81b4c5f2016-01-04 01:43:47 +0000337
Jim Ingham455fa5c2012-11-01 01:15:33 +0000338 // The general Finalize is going to try to destroy the process and that SHOULD
339 // shut down the async thread. However, if we don't kill it it will get stranded and
340 // its connection will go away so when it wakes up it will crash. So kill it for sure here.
341 StopAsyncThread();
342 KillDebugserverProcess();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000343}
344
345//----------------------------------------------------------------------
346// PluginInterface
347//----------------------------------------------------------------------
Greg Clayton57abc5d2013-05-10 21:47:16 +0000348ConstString
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000349ProcessGDBRemote::GetPluginName()
350{
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000351 return GetPluginNameStatic();
352}
353
354uint32_t
355ProcessGDBRemote::GetPluginVersion()
356{
357 return 1;
358}
359
Greg Claytonef8180a2013-10-15 00:14:28 +0000360bool
361ProcessGDBRemote::ParsePythonTargetDefinition(const FileSpec &target_definition_fspec)
362{
363 ScriptInterpreter *interpreter = GetTarget().GetDebugger().GetCommandInterpreter().GetScriptInterpreter();
364 Error error;
Zachary Turner0641ca12015-03-17 20:04:04 +0000365 StructuredData::ObjectSP module_object_sp(interpreter->LoadPluginModule(target_definition_fspec, error));
Greg Claytonef8180a2013-10-15 00:14:28 +0000366 if (module_object_sp)
367 {
Zachary Turner0641ca12015-03-17 20:04:04 +0000368 StructuredData::DictionarySP target_definition_sp(
369 interpreter->GetDynamicSettings(module_object_sp, &GetTarget(), "gdb-server-target-definition", error));
Greg Claytonef8180a2013-10-15 00:14:28 +0000370
Zachary Turner0641ca12015-03-17 20:04:04 +0000371 if (target_definition_sp)
Greg Claytonef8180a2013-10-15 00:14:28 +0000372 {
Zachary Turner0641ca12015-03-17 20:04:04 +0000373 StructuredData::ObjectSP target_object(target_definition_sp->GetValueForKey("host-info"));
374 if (target_object)
Greg Clayton312bcbe2013-10-17 01:10:23 +0000375 {
Zachary Turner0641ca12015-03-17 20:04:04 +0000376 if (auto host_info_dict = target_object->GetAsDictionary())
Greg Clayton312bcbe2013-10-17 01:10:23 +0000377 {
Zachary Turner0641ca12015-03-17 20:04:04 +0000378 StructuredData::ObjectSP triple_value = host_info_dict->GetValueForKey("triple");
379 if (auto triple_string_value = triple_value->GetAsString())
380 {
381 std::string triple_string = triple_string_value->GetValue();
382 ArchSpec host_arch(triple_string.c_str());
383 if (!host_arch.IsCompatibleMatch(GetTarget().GetArchitecture()))
384 {
385 GetTarget().SetArchitecture(host_arch);
386 }
387 }
Greg Clayton312bcbe2013-10-17 01:10:23 +0000388 }
Greg Clayton312bcbe2013-10-17 01:10:23 +0000389 }
Zachary Turner0641ca12015-03-17 20:04:04 +0000390 m_breakpoint_pc_offset = 0;
391 StructuredData::ObjectSP breakpoint_pc_offset_value = target_definition_sp->GetValueForKey("breakpoint-pc-offset");
392 if (breakpoint_pc_offset_value)
393 {
394 if (auto breakpoint_pc_int_value = breakpoint_pc_offset_value->GetAsInteger())
395 m_breakpoint_pc_offset = breakpoint_pc_int_value->GetValue();
396 }
Hafiz Abid Qadeer85a4daf2013-10-18 10:04:33 +0000397
Greg Claytond04f0ed2015-05-26 18:00:51 +0000398 if (m_register_info.SetRegisterInfo(*target_definition_sp, GetTarget().GetArchitecture()) > 0)
Greg Claytonef8180a2013-10-15 00:14:28 +0000399 {
400 return true;
401 }
402 }
403 }
404 return false;
405}
406
Jason Molenda21586c82015-09-09 03:36:24 +0000407// If the remote stub didn't give us eh_frame or DWARF register numbers for a register,
408// see if the ABI can provide them.
409// DWARF and eh_frame register numbers are defined as a part of the ABI.
410static void
411AugmentRegisterInfoViaABI (RegisterInfo &reg_info, ConstString reg_name, ABISP abi_sp)
412{
413 if (reg_info.kinds[eRegisterKindEHFrame] == LLDB_INVALID_REGNUM
414 || reg_info.kinds[eRegisterKindDWARF] == LLDB_INVALID_REGNUM)
415 {
416 if (abi_sp)
417 {
418 RegisterInfo abi_reg_info;
419 if (abi_sp->GetRegisterInfoByName (reg_name, abi_reg_info))
420 {
Greg Claytonb1583dc2015-12-04 18:37:48 +0000421 if (reg_info.kinds[eRegisterKindEHFrame] == LLDB_INVALID_REGNUM &&
422 abi_reg_info.kinds[eRegisterKindEHFrame] != LLDB_INVALID_REGNUM)
Jason Molenda21586c82015-09-09 03:36:24 +0000423 {
424 reg_info.kinds[eRegisterKindEHFrame] = abi_reg_info.kinds[eRegisterKindEHFrame];
425 }
Greg Claytonb1583dc2015-12-04 18:37:48 +0000426 if (reg_info.kinds[eRegisterKindDWARF] == LLDB_INVALID_REGNUM &&
427 abi_reg_info.kinds[eRegisterKindDWARF] != LLDB_INVALID_REGNUM)
Jason Molenda21586c82015-09-09 03:36:24 +0000428 {
429 reg_info.kinds[eRegisterKindDWARF] = abi_reg_info.kinds[eRegisterKindDWARF];
430 }
Greg Claytonb1583dc2015-12-04 18:37:48 +0000431 if (reg_info.kinds[eRegisterKindGeneric] == LLDB_INVALID_REGNUM &&
432 abi_reg_info.kinds[eRegisterKindGeneric] != LLDB_INVALID_REGNUM)
433 {
434 reg_info.kinds[eRegisterKindGeneric] = abi_reg_info.kinds[eRegisterKindGeneric];
435 }
Jason Molenda21586c82015-09-09 03:36:24 +0000436 }
437 }
438 }
439}
440
Greg Claytond04f0ed2015-05-26 18:00:51 +0000441static size_t
442SplitCommaSeparatedRegisterNumberString(const llvm::StringRef &comma_separated_regiter_numbers, std::vector<uint32_t> &regnums, int base)
443{
444 regnums.clear();
445 std::pair<llvm::StringRef, llvm::StringRef> value_pair;
446 value_pair.second = comma_separated_regiter_numbers;
447 do
448 {
449 value_pair = value_pair.second.split(',');
450 if (!value_pair.first.empty())
451 {
452 uint32_t reg = StringConvert::ToUInt32 (value_pair.first.str().c_str(), LLDB_INVALID_REGNUM, base);
453 if (reg != LLDB_INVALID_REGNUM)
454 regnums.push_back (reg);
455 }
456 } while (!value_pair.second.empty());
457 return regnums.size();
458}
459
Eugene Zelenko0722f082015-10-24 01:28:05 +0000460
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000461void
Greg Clayton513c26c2011-01-29 07:10:55 +0000462ProcessGDBRemote::BuildDynamicRegisterInfo (bool force)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000463{
Greg Clayton513c26c2011-01-29 07:10:55 +0000464 if (!force && m_register_info.GetNumRegisters() > 0)
465 return;
466
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000467 m_register_info.Clear();
Greg Claytond04f0ed2015-05-26 18:00:51 +0000468
469 // Check if qHostInfo specified a specific packet timeout for this connection.
470 // If so then lets update our setting so the user knows what the timeout is
471 // and can see it.
472 const uint32_t host_packet_timeout = m_gdb_comm.GetHostDefaultPacketTimeout();
473 if (host_packet_timeout)
474 {
475 GetGlobalPluginProperties()->SetPacketTimeout(host_packet_timeout);
476 }
477
Ed Maste81b4c5f2016-01-04 01:43:47 +0000478 // Register info search order:
Ewan Crawford0c996a92015-06-30 13:08:44 +0000479 // 1 - Use the target definition python file if one is specified.
480 // 2 - If the target definition doesn't have any of the info from the target.xml (registers) then proceed to read the target.xml.
481 // 3 - Fall back on the qRegisterInfo packets.
482
483 FileSpec target_definition_fspec = GetGlobalPluginProperties()->GetTargetDefinitionFile ();
Jason Molenda91e468c2015-08-20 04:29:46 +0000484 if (!target_definition_fspec.Exists())
485 {
486 // If the filename doesn't exist, it may be a ~ not having been expanded - try to resolve it.
487 target_definition_fspec.ResolvePath();
488 }
Ewan Crawford0c996a92015-06-30 13:08:44 +0000489 if (target_definition_fspec)
490 {
491 // See if we can get register definitions from a python file
492 if (ParsePythonTargetDefinition (target_definition_fspec))
Jason Molenda5543abb2015-08-20 03:05:09 +0000493 {
Ewan Crawford0c996a92015-06-30 13:08:44 +0000494 return;
Jason Molenda5543abb2015-08-20 03:05:09 +0000495 }
496 else
497 {
498 StreamSP stream_sp = GetTarget().GetDebugger().GetAsyncOutputStream();
499 stream_sp->Printf ("ERROR: target description file %s failed to parse.\n", target_definition_fspec.GetPath().c_str());
500 }
Ewan Crawford0c996a92015-06-30 13:08:44 +0000501 }
502
Jim Ingham7b71c0b2016-02-18 23:58:45 +0000503 const ArchSpec &target_arch = GetTarget().GetArchitecture();
504 const ArchSpec &remote_host_arch = m_gdb_comm.GetHostArchitecture();
505 const ArchSpec &remote_process_arch = m_gdb_comm.GetProcessArchitecture();
506
507 // Use the process' architecture instead of the host arch, if available
508 ArchSpec arch_to_use;
509 if (remote_process_arch.IsValid ())
510 arch_to_use = remote_process_arch;
511 else
512 arch_to_use = remote_host_arch;
513
514 if (!arch_to_use.IsValid())
515 arch_to_use = target_arch;
516
517 if (GetGDBServerRegisterInfo (arch_to_use))
Greg Claytond04f0ed2015-05-26 18:00:51 +0000518 return;
Ed Maste81b4c5f2016-01-04 01:43:47 +0000519
Greg Claytond04f0ed2015-05-26 18:00:51 +0000520 char packet[128];
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000521 uint32_t reg_offset = 0;
522 uint32_t reg_num = 0;
Greg Clayton23f59502012-07-17 03:23:13 +0000523 for (StringExtractorGDBRemote::ResponseType response_type = StringExtractorGDBRemote::eResponse;
Ed Maste81b4c5f2016-01-04 01:43:47 +0000524 response_type == StringExtractorGDBRemote::eResponse;
Greg Clayton576d8832011-03-22 04:00:09 +0000525 ++reg_num)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000526 {
Greg Clayton513c26c2011-01-29 07:10:55 +0000527 const int packet_len = ::snprintf (packet, sizeof(packet), "qRegisterInfo%x", reg_num);
Andy Gibbsa297a972013-06-19 19:04:53 +0000528 assert (packet_len < (int)sizeof(packet));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000529 StringExtractorGDBRemote response;
Greg Clayton3dedae12013-12-06 21:45:27 +0000530 if (m_gdb_comm.SendPacketAndWaitForResponse(packet, packet_len, response, false) == GDBRemoteCommunication::PacketResult::Success)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000531 {
Greg Clayton576d8832011-03-22 04:00:09 +0000532 response_type = response.GetResponseType();
533 if (response_type == StringExtractorGDBRemote::eResponse)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000534 {
535 std::string name;
536 std::string value;
537 ConstString reg_name;
538 ConstString alt_name;
539 ConstString set_name;
Greg Claytonce1ffcf2013-01-21 22:17:50 +0000540 std::vector<uint32_t> value_regs;
541 std::vector<uint32_t> invalidate_regs;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000542 RegisterInfo reg_info = { NULL, // Name
543 NULL, // Alt name
544 0, // byte size
545 reg_offset, // offset
546 eEncodingUint, // encoding
Jason Molendabf67a302015-09-01 05:17:01 +0000547 eFormatHex, // format
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000548 {
Jason Molendabf67a302015-09-01 05:17:01 +0000549 LLDB_INVALID_REGNUM, // eh_frame reg num
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000550 LLDB_INVALID_REGNUM, // DWARF reg num
551 LLDB_INVALID_REGNUM, // generic reg num
Jason Molenda63bd0db2015-09-15 23:20:34 +0000552 reg_num, // process plugin reg num
Jason Molendafbcb7f22010-09-10 07:49:16 +0000553 reg_num // native register number
Greg Clayton435d85a2012-02-29 19:27:27 +0000554 },
555 NULL,
556 NULL
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000557 };
558
559 while (response.GetNameColonValue(name, value))
560 {
561 if (name.compare("name") == 0)
562 {
563 reg_name.SetCString(value.c_str());
564 }
565 else if (name.compare("alt-name") == 0)
566 {
567 alt_name.SetCString(value.c_str());
568 }
569 else if (name.compare("bitsize") == 0)
570 {
Vince Harron5275aaa2015-01-15 20:08:35 +0000571 reg_info.byte_size = StringConvert::ToUInt32(value.c_str(), 0, 0) / CHAR_BIT;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000572 }
573 else if (name.compare("offset") == 0)
574 {
Vince Harron5275aaa2015-01-15 20:08:35 +0000575 uint32_t offset = StringConvert::ToUInt32(value.c_str(), UINT32_MAX, 0);
Jason Molenda743e86a2010-06-11 23:44:18 +0000576 if (reg_offset != offset)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000577 {
578 reg_offset = offset;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000579 }
580 }
581 else if (name.compare("encoding") == 0)
582 {
Greg Clayton2443cbd2012-08-24 01:42:50 +0000583 const Encoding encoding = Args::StringToEncoding (value.c_str());
584 if (encoding != eEncodingInvalid)
585 reg_info.encoding = encoding;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000586 }
587 else if (name.compare("format") == 0)
588 {
Greg Clayton2443cbd2012-08-24 01:42:50 +0000589 Format format = eFormatInvalid;
590 if (Args::StringToFormat (value.c_str(), format, NULL).Success())
591 reg_info.format = format;
592 else if (value.compare("binary") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000593 reg_info.format = eFormatBinary;
594 else if (value.compare("decimal") == 0)
595 reg_info.format = eFormatDecimal;
596 else if (value.compare("hex") == 0)
597 reg_info.format = eFormatHex;
598 else if (value.compare("float") == 0)
599 reg_info.format = eFormatFloat;
600 else if (value.compare("vector-sint8") == 0)
601 reg_info.format = eFormatVectorOfSInt8;
602 else if (value.compare("vector-uint8") == 0)
603 reg_info.format = eFormatVectorOfUInt8;
604 else if (value.compare("vector-sint16") == 0)
605 reg_info.format = eFormatVectorOfSInt16;
606 else if (value.compare("vector-uint16") == 0)
607 reg_info.format = eFormatVectorOfUInt16;
608 else if (value.compare("vector-sint32") == 0)
609 reg_info.format = eFormatVectorOfSInt32;
610 else if (value.compare("vector-uint32") == 0)
611 reg_info.format = eFormatVectorOfUInt32;
612 else if (value.compare("vector-float32") == 0)
613 reg_info.format = eFormatVectorOfFloat32;
614 else if (value.compare("vector-uint128") == 0)
615 reg_info.format = eFormatVectorOfUInt128;
616 }
617 else if (name.compare("set") == 0)
618 {
619 set_name.SetCString(value.c_str());
620 }
Jason Molendaa18f7072015-08-15 01:21:01 +0000621 else if (name.compare("gcc") == 0 || name.compare("ehframe") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000622 {
Jason Molendaa18f7072015-08-15 01:21:01 +0000623 reg_info.kinds[eRegisterKindEHFrame] = StringConvert::ToUInt32(value.c_str(), LLDB_INVALID_REGNUM, 0);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000624 }
625 else if (name.compare("dwarf") == 0)
626 {
Vince Harron5275aaa2015-01-15 20:08:35 +0000627 reg_info.kinds[eRegisterKindDWARF] = StringConvert::ToUInt32(value.c_str(), LLDB_INVALID_REGNUM, 0);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000628 }
629 else if (name.compare("generic") == 0)
630 {
Greg Clayton2443cbd2012-08-24 01:42:50 +0000631 reg_info.kinds[eRegisterKindGeneric] = Args::StringToGenericRegister (value.c_str());
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000632 }
Greg Claytonce1ffcf2013-01-21 22:17:50 +0000633 else if (name.compare("container-regs") == 0)
634 {
Greg Claytond04f0ed2015-05-26 18:00:51 +0000635 SplitCommaSeparatedRegisterNumberString(value, value_regs, 16);
Greg Claytonce1ffcf2013-01-21 22:17:50 +0000636 }
637 else if (name.compare("invalidate-regs") == 0)
638 {
Greg Claytond04f0ed2015-05-26 18:00:51 +0000639 SplitCommaSeparatedRegisterNumberString(value, invalidate_regs, 16);
Greg Claytonce1ffcf2013-01-21 22:17:50 +0000640 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000641 }
642
Jason Molenda743e86a2010-06-11 23:44:18 +0000643 reg_info.byte_offset = reg_offset;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000644 assert (reg_info.byte_size != 0);
645 reg_offset += reg_info.byte_size;
Greg Claytonce1ffcf2013-01-21 22:17:50 +0000646 if (!value_regs.empty())
647 {
648 value_regs.push_back(LLDB_INVALID_REGNUM);
649 reg_info.value_regs = value_regs.data();
650 }
651 if (!invalidate_regs.empty())
652 {
653 invalidate_regs.push_back(LLDB_INVALID_REGNUM);
654 reg_info.invalidate_regs = invalidate_regs.data();
655 }
656
Jim Ingham7b71c0b2016-02-18 23:58:45 +0000657 // We have to make a temporary ABI here, and not use the GetABI because this code
658 // gets called in DidAttach, when the target architecture (and consequently the ABI we'll get from
659 // the process) may be wrong.
660 ABISP abi_to_use = ABI::FindPlugin(arch_to_use);
661
662 AugmentRegisterInfoViaABI (reg_info, reg_name, abi_to_use);
Jason Molenda21586c82015-09-09 03:36:24 +0000663
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000664 m_register_info.AddRegister(reg_info, reg_name, alt_name, set_name);
665 }
Todd Fiala1a634402014-01-08 07:52:40 +0000666 else
667 {
668 break; // ensure exit before reg_num is incremented
669 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000670 }
671 else
672 {
Greg Clayton32e0a752011-03-30 18:16:51 +0000673 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000674 }
675 }
676
Greg Claytond04f0ed2015-05-26 18:00:51 +0000677 if (m_register_info.GetNumRegisters() > 0)
Greg Clayton9ac6d2d2013-10-25 18:13:17 +0000678 {
Greg Claytond04f0ed2015-05-26 18:00:51 +0000679 m_register_info.Finalize(GetTarget().GetArchitecture());
680 return;
Greg Clayton9ac6d2d2013-10-25 18:13:17 +0000681 }
Greg Clayton9ac6d2d2013-10-25 18:13:17 +0000682
Johnny Chen2fa9de12012-05-14 18:44:23 +0000683 // We didn't get anything if the accumulated reg_num is zero. See if we are
684 // debugging ARM and fill with a hard coded register set until we can get an
685 // updated debugserver down on the devices.
686 // On the other hand, if the accumulated reg_num is positive, see if we can
687 // add composite registers to the existing primordial ones.
Greg Claytond04f0ed2015-05-26 18:00:51 +0000688 bool from_scratch = (m_register_info.GetNumRegisters() == 0);
Johnny Chen2fa9de12012-05-14 18:44:23 +0000689
Johnny Chen2fa9de12012-05-14 18:44:23 +0000690 if (!target_arch.IsValid())
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000691 {
Jim Ingham7b71c0b2016-02-18 23:58:45 +0000692 if (arch_to_use.IsValid()
693 && (arch_to_use.GetMachine() == llvm::Triple::arm || arch_to_use.GetMachine() == llvm::Triple::thumb)
694 && arch_to_use.GetTriple().getVendor() == llvm::Triple::Apple)
Johnny Chen2fa9de12012-05-14 18:44:23 +0000695 m_register_info.HardcodeARMRegisters(from_scratch);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000696 }
Jason Molenda6d9fe8c2015-08-21 00:13:37 +0000697 else if (target_arch.GetMachine() == llvm::Triple::arm
698 || target_arch.GetMachine() == llvm::Triple::thumb)
Johnny Chen2fa9de12012-05-14 18:44:23 +0000699 {
700 m_register_info.HardcodeARMRegisters(from_scratch);
701 }
702
703 // At this point, we can finalize our register info.
Greg Claytond04f0ed2015-05-26 18:00:51 +0000704 m_register_info.Finalize (GetTarget().GetArchitecture());
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000705}
706
707Error
708ProcessGDBRemote::WillLaunch (Module* module)
709{
710 return WillLaunchOrAttach ();
711}
712
713Error
Greg Clayton3af9ea52010-11-18 05:57:03 +0000714ProcessGDBRemote::WillAttachToProcessWithID (lldb::pid_t pid)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000715{
716 return WillLaunchOrAttach ();
717}
718
719Error
Greg Clayton3af9ea52010-11-18 05:57:03 +0000720ProcessGDBRemote::WillAttachToProcessWithName (const char *process_name, bool wait_for_launch)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000721{
722 return WillLaunchOrAttach ();
723}
724
725Error
Jason Molenda4bd4e7e2012-09-29 04:02:01 +0000726ProcessGDBRemote::DoConnectRemote (Stream *strm, const char *remote_url)
Greg Claytonb766a732011-02-04 01:58:07 +0000727{
Todd Fialaaf245d12014-06-30 21:05:18 +0000728 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
Greg Claytonb766a732011-02-04 01:58:07 +0000729 Error error (WillLaunchOrAttach ());
Ed Maste81b4c5f2016-01-04 01:43:47 +0000730
Greg Claytonb766a732011-02-04 01:58:07 +0000731 if (error.Fail())
732 return error;
733
Greg Clayton2289fa42011-04-30 01:09:13 +0000734 error = ConnectToDebugserver (remote_url);
Greg Claytonb766a732011-02-04 01:58:07 +0000735
736 if (error.Fail())
737 return error;
738 StartAsyncThread ();
739
Greg Claytonc574ede2011-03-10 02:26:48 +0000740 lldb::pid_t pid = m_gdb_comm.GetCurrentProcessID ();
Greg Claytonb766a732011-02-04 01:58:07 +0000741 if (pid == LLDB_INVALID_PROCESS_ID)
742 {
743 // We don't have a valid process ID, so note that we are connected
Ed Maste81b4c5f2016-01-04 01:43:47 +0000744 // and could now request to launch or attach, or get remote process
Greg Claytonb766a732011-02-04 01:58:07 +0000745 // listings...
746 SetPrivateState (eStateConnected);
747 }
748 else
749 {
750 // We have a valid process
751 SetID (pid);
Greg Clayton56d9a1b2011-08-22 02:49:39 +0000752 GetThreadList();
Ewan Crawford9aa2da002015-05-27 14:12:34 +0000753 StringExtractorGDBRemote response;
754 if (m_gdb_comm.GetStopReply(response))
Greg Claytonb766a732011-02-04 01:58:07 +0000755 {
Ewan Crawford9aa2da002015-05-27 14:12:34 +0000756 SetLastStopPacket(response);
Ewan Crawford78baa192015-05-13 09:18:18 +0000757
758 // '?' Packets must be handled differently in non-stop mode
759 if (GetTarget().GetNonStopModeEnabled())
760 HandleStopReplySequence();
761
Zachary Turner7529df92015-09-01 20:02:29 +0000762 Target &target = GetTarget();
Ed Maste81b4c5f2016-01-04 01:43:47 +0000763 if (!target.GetArchitecture().IsValid())
Jason Molendac62bd7b2013-12-21 05:20:36 +0000764 {
765 if (m_gdb_comm.GetProcessArchitecture().IsValid())
766 {
Zachary Turner7529df92015-09-01 20:02:29 +0000767 target.SetArchitecture(m_gdb_comm.GetProcessArchitecture());
Jason Molendac62bd7b2013-12-21 05:20:36 +0000768 }
769 else
770 {
Zachary Turner7529df92015-09-01 20:02:29 +0000771 target.SetArchitecture(m_gdb_comm.GetHostArchitecture());
Jason Molendac62bd7b2013-12-21 05:20:36 +0000772 }
Carlo Kok74389122013-10-14 07:09:13 +0000773 }
774
Ewan Crawford9aa2da002015-05-27 14:12:34 +0000775 const StateType state = SetThreadStopInfo (response);
Greg Clayton2e309072015-07-17 23:42:28 +0000776 if (state != eStateInvalid)
Greg Claytonb766a732011-02-04 01:58:07 +0000777 {
778 SetPrivateState (state);
779 }
780 else
Daniel Malead01b2952012-11-29 21:49:15 +0000781 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 +0000782 }
783 else
Daniel Malead01b2952012-11-29 21:49:15 +0000784 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 +0000785 }
Jason Molenda16d127c2012-05-03 22:37:30 +0000786
Todd Fialaaf245d12014-06-30 21:05:18 +0000787 if (log)
788 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");
789
790
791 if (error.Success()
Jason Molenda16d127c2012-05-03 22:37:30 +0000792 && !GetTarget().GetArchitecture().IsValid()
793 && m_gdb_comm.GetHostArchitecture().IsValid())
794 {
Jason Molendaf17b5ac2012-12-19 02:54:03 +0000795 // Prefer the *process'* architecture over that of the *host*, if available.
796 if (m_gdb_comm.GetProcessArchitecture().IsValid())
797 GetTarget().SetArchitecture(m_gdb_comm.GetProcessArchitecture());
798 else
799 GetTarget().SetArchitecture(m_gdb_comm.GetHostArchitecture());
Jason Molenda16d127c2012-05-03 22:37:30 +0000800 }
801
Todd Fialaaf245d12014-06-30 21:05:18 +0000802 if (log)
803 log->Printf ("ProcessGDBRemote::%s pid %" PRIu64 ": normalized target architecture triple: %s", __FUNCTION__, GetID (), GetTarget ().GetArchitecture ().GetTriple ().getTriple ().c_str ());
804
Chaoren Lin98d0a4b2015-07-14 01:09:28 +0000805 if (error.Success())
Jaydeep Patil6fc590d2015-07-30 05:06:51 +0000806 {
807 PlatformSP platform_sp = GetTarget().GetPlatform();
808 if (platform_sp && platform_sp->IsConnected())
809 SetUnixSignals(platform_sp->GetUnixSignals());
810 else
811 SetUnixSignals(UnixSignals::Create(GetTarget().GetArchitecture()));
812 }
Todd Fialaaf245d12014-06-30 21:05:18 +0000813
Greg Claytonb766a732011-02-04 01:58:07 +0000814 return error;
815}
816
817Error
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000818ProcessGDBRemote::WillLaunchOrAttach ()
819{
820 Error error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000821 m_stdio_communication.Clear ();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000822 return error;
823}
824
825//----------------------------------------------------------------------
826// Process Control
827//----------------------------------------------------------------------
828Error
Jean-Daniel Dupas7782de92013-12-09 22:52:50 +0000829ProcessGDBRemote::DoLaunch (Module *exe_module, ProcessLaunchInfo &launch_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000830{
Todd Fiala75f47c32014-10-11 21:42:09 +0000831 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
Greg Clayton4957bf62010-09-30 21:49:03 +0000832 Error error;
Greg Clayton982c9762011-11-03 21:22:33 +0000833
Todd Fiala75f47c32014-10-11 21:42:09 +0000834 if (log)
835 log->Printf ("ProcessGDBRemote::%s() entered", __FUNCTION__);
836
Greg Clayton982c9762011-11-03 21:22:33 +0000837 uint32_t launch_flags = launch_info.GetFlags().Get();
Chaoren Lind3173f32015-05-29 19:52:29 +0000838 FileSpec stdin_file_spec{};
839 FileSpec stdout_file_spec{};
840 FileSpec stderr_file_spec{};
841 FileSpec working_dir = launch_info.GetWorkingDirectory();
Greg Clayton982c9762011-11-03 21:22:33 +0000842
Zachary Turner696b5282014-08-14 16:01:25 +0000843 const FileAction *file_action;
Greg Clayton982c9762011-11-03 21:22:33 +0000844 file_action = launch_info.GetFileActionForFD (STDIN_FILENO);
845 if (file_action)
846 {
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000847 if (file_action->GetAction() == FileAction::eFileActionOpen)
Chaoren Lind3173f32015-05-29 19:52:29 +0000848 stdin_file_spec = file_action->GetFileSpec();
Greg Clayton982c9762011-11-03 21:22:33 +0000849 }
850 file_action = launch_info.GetFileActionForFD (STDOUT_FILENO);
851 if (file_action)
852 {
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000853 if (file_action->GetAction() == FileAction::eFileActionOpen)
Chaoren Lind3173f32015-05-29 19:52:29 +0000854 stdout_file_spec = file_action->GetFileSpec();
Greg Clayton982c9762011-11-03 21:22:33 +0000855 }
856 file_action = launch_info.GetFileActionForFD (STDERR_FILENO);
857 if (file_action)
858 {
Zachary Turnerc00cf4a2014-08-15 22:04:21 +0000859 if (file_action->GetAction() == FileAction::eFileActionOpen)
Chaoren Lind3173f32015-05-29 19:52:29 +0000860 stderr_file_spec = file_action->GetFileSpec();
Greg Clayton982c9762011-11-03 21:22:33 +0000861 }
862
Todd Fiala75f47c32014-10-11 21:42:09 +0000863 if (log)
864 {
Chaoren Lind3173f32015-05-29 19:52:29 +0000865 if (stdin_file_spec || stdout_file_spec || stderr_file_spec)
Vince Harron4a8abd32015-02-13 19:15:24 +0000866 log->Printf ("ProcessGDBRemote::%s provided with STDIO paths via launch_info: stdin=%s, stdout=%s, stderr=%s",
Todd Fiala75f47c32014-10-11 21:42:09 +0000867 __FUNCTION__,
Chaoren Lind3173f32015-05-29 19:52:29 +0000868 stdin_file_spec ? stdin_file_spec.GetCString() : "<null>",
869 stdout_file_spec ? stdout_file_spec.GetCString() : "<null>",
870 stderr_file_spec ? stderr_file_spec.GetCString() : "<null>");
Todd Fiala75f47c32014-10-11 21:42:09 +0000871 else
872 log->Printf ("ProcessGDBRemote::%s no STDIO paths given via launch_info", __FUNCTION__);
873 }
874
Vince Harrondf3f00f2015-02-10 21:09:04 +0000875 const bool disable_stdio = (launch_flags & eLaunchFlagDisableSTDIO) != 0;
Chaoren Lind3173f32015-05-29 19:52:29 +0000876 if (stdin_file_spec || disable_stdio)
Vince Harrondf3f00f2015-02-10 21:09:04 +0000877 {
878 // the inferior will be reading stdin from the specified file
879 // or stdio is completely disabled
880 m_stdin_forward = false;
881 }
882 else
883 {
884 m_stdin_forward = true;
885 }
886
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000887 // ::LogSetBitMask (GDBR_LOG_DEFAULT);
888 // ::LogSetOptions (LLDB_LOG_OPTION_THREADSAFE | LLDB_LOG_OPTION_PREPEND_TIMESTAMP | LLDB_LOG_OPTION_PREPEND_PROC_AND_THREAD);
889 // ::LogSetLogFile ("/dev/stdout");
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000890
Greg Clayton982c9762011-11-03 21:22:33 +0000891 ObjectFile * object_file = exe_module->GetObjectFile();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000892 if (object_file)
893 {
Oleksiy Vyalovafd6ce42015-11-23 19:32:24 +0000894 error = EstablishConnectionIfNeeded (launch_info);
Greg Clayton71337622011-02-24 22:24:29 +0000895 if (error.Success())
896 {
897 lldb_utility::PseudoTerminal pty;
898 const bool disable_stdio = (launch_flags & eLaunchFlagDisableSTDIO) != 0;
Greg Clayton5f2a4f92011-03-02 21:34:46 +0000899
Zachary Turner7529df92015-09-01 20:02:29 +0000900 PlatformSP platform_sp (GetTarget().GetPlatform());
Vince Harrondf3f00f2015-02-10 21:09:04 +0000901 if (disable_stdio)
Greg Clayton71337622011-02-24 22:24:29 +0000902 {
Vince Harrondf3f00f2015-02-10 21:09:04 +0000903 // set to /dev/null unless redirected to a file above
Chaoren Lind3173f32015-05-29 19:52:29 +0000904 if (!stdin_file_spec)
Zachary Turner4eff2d32015-10-14 21:37:36 +0000905 stdin_file_spec.SetFile(FileSystem::DEV_NULL, false);
Chaoren Lind3173f32015-05-29 19:52:29 +0000906 if (!stdout_file_spec)
Zachary Turner4eff2d32015-10-14 21:37:36 +0000907 stdout_file_spec.SetFile(FileSystem::DEV_NULL, false);
Chaoren Lind3173f32015-05-29 19:52:29 +0000908 if (!stderr_file_spec)
Zachary Turner4eff2d32015-10-14 21:37:36 +0000909 stderr_file_spec.SetFile(FileSystem::DEV_NULL, false);
Vince Harrondf3f00f2015-02-10 21:09:04 +0000910 }
911 else if (platform_sp && platform_sp->IsHost())
912 {
913 // If the debugserver is local and we aren't disabling STDIO, lets use
914 // a pseudo terminal to instead of relying on the 'O' packets for stdio
915 // since 'O' packets can really slow down debugging if the inferior
916 // does a lot of output.
Chaoren Lind3173f32015-05-29 19:52:29 +0000917 if ((!stdin_file_spec || !stdout_file_spec || !stderr_file_spec) &&
918 pty.OpenFirstAvailableMaster(O_RDWR|O_NOCTTY, NULL, 0))
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000919 {
Chaoren Lind3173f32015-05-29 19:52:29 +0000920 FileSpec slave_name{pty.GetSlaveName(NULL, 0), false};
921
922 if (!stdin_file_spec)
923 stdin_file_spec = slave_name;
924
925 if (!stdout_file_spec)
926 stdout_file_spec = slave_name;
927
928 if (!stderr_file_spec)
929 stderr_file_spec = slave_name;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000930 }
Todd Fiala75f47c32014-10-11 21:42:09 +0000931 if (log)
Vince Harron4a8abd32015-02-13 19:15:24 +0000932 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 +0000933 __FUNCTION__,
Chaoren Lind3173f32015-05-29 19:52:29 +0000934 stdin_file_spec ? stdin_file_spec.GetCString() : "<null>",
935 stdout_file_spec ? stdout_file_spec.GetCString() : "<null>",
936 stderr_file_spec ? stderr_file_spec.GetCString() : "<null>");
Greg Clayton71337622011-02-24 22:24:29 +0000937 }
938
Todd Fiala75f47c32014-10-11 21:42:09 +0000939 if (log)
Vince Harron4a8abd32015-02-13 19:15:24 +0000940 log->Printf ("ProcessGDBRemote::%s final STDIO paths after all adjustments: stdin=%s, stdout=%s, stderr=%s",
Todd Fiala75f47c32014-10-11 21:42:09 +0000941 __FUNCTION__,
Chaoren Lind3173f32015-05-29 19:52:29 +0000942 stdin_file_spec ? stdin_file_spec.GetCString() : "<null>",
943 stdout_file_spec ? stdout_file_spec.GetCString() : "<null>",
944 stderr_file_spec ? stderr_file_spec.GetCString() : "<null>");
Todd Fiala75f47c32014-10-11 21:42:09 +0000945
Chaoren Lind3173f32015-05-29 19:52:29 +0000946 if (stdin_file_spec)
947 m_gdb_comm.SetSTDIN(stdin_file_spec);
948 if (stdout_file_spec)
949 m_gdb_comm.SetSTDOUT(stdout_file_spec);
950 if (stderr_file_spec)
951 m_gdb_comm.SetSTDERR(stderr_file_spec);
Greg Clayton71337622011-02-24 22:24:29 +0000952
953 m_gdb_comm.SetDisableASLR (launch_flags & eLaunchFlagDisableASLR);
Jim Ingham106d0282014-06-25 02:32:56 +0000954 m_gdb_comm.SetDetachOnError (launch_flags & eLaunchFlagDetachOnError);
Greg Clayton71337622011-02-24 22:24:29 +0000955
Zachary Turner7529df92015-09-01 20:02:29 +0000956 m_gdb_comm.SendLaunchArchPacket (GetTarget().GetArchitecture().GetArchitectureName());
Ed Maste81b4c5f2016-01-04 01:43:47 +0000957
Jason Molendaa3329782014-03-29 18:54:20 +0000958 const char * launch_event_data = launch_info.GetLaunchEventData();
959 if (launch_event_data != NULL && *launch_event_data != '\0')
960 m_gdb_comm.SendLaunchEventDataPacket (launch_event_data);
Ed Maste81b4c5f2016-01-04 01:43:47 +0000961
Chaoren Lind3173f32015-05-29 19:52:29 +0000962 if (working_dir)
Greg Clayton71337622011-02-24 22:24:29 +0000963 {
964 m_gdb_comm.SetWorkingDir (working_dir);
965 }
966
967 // Send the environment and the program + arguments after we connect
Greg Clayton982c9762011-11-03 21:22:33 +0000968 const Args &environment = launch_info.GetEnvironmentEntries();
969 if (environment.GetArgumentCount())
Greg Clayton71337622011-02-24 22:24:29 +0000970 {
Greg Clayton982c9762011-11-03 21:22:33 +0000971 size_t num_environment_entries = environment.GetArgumentCount();
972 for (size_t i=0; i<num_environment_entries; ++i)
Greg Claytonb0b9fe62010-08-03 00:35:52 +0000973 {
Greg Clayton982c9762011-11-03 21:22:33 +0000974 const char *env_entry = environment.GetArgumentAtIndex(i);
975 if (env_entry == NULL || m_gdb_comm.SendEnvironmentPacket(env_entry) != 0)
Greg Clayton71337622011-02-24 22:24:29 +0000976 break;
Greg Claytonb0b9fe62010-08-03 00:35:52 +0000977 }
Greg Clayton71337622011-02-24 22:24:29 +0000978 }
Greg Claytonb0b9fe62010-08-03 00:35:52 +0000979
Greg Clayton71337622011-02-24 22:24:29 +0000980 {
Tamas Berghammer912800c2015-02-24 10:23:39 +0000981 // Scope for the scoped timeout object
982 GDBRemoteCommunication::ScopedTimeout timeout (m_gdb_comm, 10);
983
984 int arg_packet_err = m_gdb_comm.SendArgumentsPacket (launch_info);
985 if (arg_packet_err == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000986 {
Tamas Berghammer912800c2015-02-24 10:23:39 +0000987 std::string error_str;
988 if (m_gdb_comm.GetLaunchSuccess (error_str))
989 {
990 SetID (m_gdb_comm.GetCurrentProcessID ());
991 }
992 else
993 {
994 error.SetErrorString (error_str.c_str());
995 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000996 }
997 else
998 {
Tamas Berghammer912800c2015-02-24 10:23:39 +0000999 error.SetErrorStringWithFormat("'A' packet returned an error: %i", arg_packet_err);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001000 }
Greg Clayton71337622011-02-24 22:24:29 +00001001 }
Tamas Berghammer912800c2015-02-24 10:23:39 +00001002
Greg Clayton71337622011-02-24 22:24:29 +00001003 if (GetID() == LLDB_INVALID_PROCESS_ID)
1004 {
Johnny Chen4c1e9202011-08-09 18:56:45 +00001005 if (log)
1006 log->Printf("failed to connect to debugserver: %s", error.AsCString());
Greg Clayton71337622011-02-24 22:24:29 +00001007 KillDebugserverProcess ();
1008 return error;
1009 }
1010
Ewan Crawford9aa2da002015-05-27 14:12:34 +00001011 StringExtractorGDBRemote response;
1012 if (m_gdb_comm.GetStopReply(response))
Greg Clayton71337622011-02-24 22:24:29 +00001013 {
Ewan Crawford9aa2da002015-05-27 14:12:34 +00001014 SetLastStopPacket(response);
Ewan Crawford78baa192015-05-13 09:18:18 +00001015 // '?' Packets must be handled differently in non-stop mode
1016 if (GetTarget().GetNonStopModeEnabled())
1017 HandleStopReplySequence();
1018
Tamas Berghammere9f4dfe2015-03-13 10:32:42 +00001019 const ArchSpec &process_arch = m_gdb_comm.GetProcessArchitecture();
1020
1021 if (process_arch.IsValid())
Jason Molendac62bd7b2013-12-21 05:20:36 +00001022 {
Zachary Turner7529df92015-09-01 20:02:29 +00001023 GetTarget().MergeArchitecture(process_arch);
Tamas Berghammere9f4dfe2015-03-13 10:32:42 +00001024 }
1025 else
1026 {
1027 const ArchSpec &host_arch = m_gdb_comm.GetHostArchitecture();
1028 if (host_arch.IsValid())
Zachary Turner7529df92015-09-01 20:02:29 +00001029 GetTarget().MergeArchitecture(host_arch);
Carlo Kok74389122013-10-14 07:09:13 +00001030 }
1031
Ewan Crawford9aa2da002015-05-27 14:12:34 +00001032 SetPrivateState (SetThreadStopInfo (response));
Ed Maste81b4c5f2016-01-04 01:43:47 +00001033
Greg Clayton71337622011-02-24 22:24:29 +00001034 if (!disable_stdio)
1035 {
1036 if (pty.GetMasterFileDescriptor() != lldb_utility::PseudoTerminal::invalid_fd)
Greg Claytonee95ed52011-11-17 22:14:31 +00001037 SetSTDIOFileDescriptor (pty.ReleaseMasterFileDescriptor());
Greg Clayton71337622011-02-24 22:24:29 +00001038 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001039 }
1040 }
Greg Claytonc235ac72011-08-09 05:20:29 +00001041 else
1042 {
Johnny Chen4c1e9202011-08-09 18:56:45 +00001043 if (log)
1044 log->Printf("failed to connect to debugserver: %s", error.AsCString());
Greg Claytonc235ac72011-08-09 05:20:29 +00001045 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001046 }
1047 else
1048 {
1049 // Set our user ID to an invalid process ID.
1050 SetID(LLDB_INVALID_PROCESS_ID);
Ed Maste81b4c5f2016-01-04 01:43:47 +00001051 error.SetErrorStringWithFormat ("failed to get object file from '%s' for arch %s",
1052 exe_module->GetFileSpec().GetFilename().AsCString(),
Greg Clayton982c9762011-11-03 21:22:33 +00001053 exe_module->GetArchitecture().GetArchitectureName());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001054 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001055 return error;
Eugene Zelenko0722f082015-10-24 01:28:05 +00001056
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001057}
1058
Eugene Zelenko0722f082015-10-24 01:28:05 +00001059
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001060Error
Greg Claytonb766a732011-02-04 01:58:07 +00001061ProcessGDBRemote::ConnectToDebugserver (const char *connect_url)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001062{
1063 Error error;
Greg Clayton00fe87b2013-12-05 22:58:22 +00001064 // Only connect if we have a valid connect URL
Vince Harron1b5a74e2015-01-21 22:42:49 +00001065 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Ed Maste81b4c5f2016-01-04 01:43:47 +00001066
Greg Clayton00fe87b2013-12-05 22:58:22 +00001067 if (connect_url && connect_url[0])
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001068 {
Vince Harron1b5a74e2015-01-21 22:42:49 +00001069 if (log)
1070 log->Printf("ProcessGDBRemote::%s Connecting to %s", __FUNCTION__, connect_url);
Greg Clayton00fe87b2013-12-05 22:58:22 +00001071 std::unique_ptr<ConnectionFileDescriptor> conn_ap(new ConnectionFileDescriptor());
1072 if (conn_ap.get())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001073 {
Greg Clayton00fe87b2013-12-05 22:58:22 +00001074 const uint32_t max_retry_count = 50;
1075 uint32_t retry_count = 0;
1076 while (!m_gdb_comm.IsConnected())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001077 {
Greg Clayton00fe87b2013-12-05 22:58:22 +00001078 if (conn_ap->Connect(connect_url, &error) == eConnectionStatusSuccess)
1079 {
1080 m_gdb_comm.SetConnection (conn_ap.release());
1081 break;
1082 }
1083 else if (error.WasInterrupted())
1084 {
1085 // If we were interrupted, don't keep retrying.
1086 break;
1087 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001088
Greg Clayton00fe87b2013-12-05 22:58:22 +00001089 retry_count++;
Ed Maste81b4c5f2016-01-04 01:43:47 +00001090
Greg Clayton00fe87b2013-12-05 22:58:22 +00001091 if (retry_count >= max_retry_count)
1092 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001093
Greg Clayton00fe87b2013-12-05 22:58:22 +00001094 usleep (100000);
1095 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001096 }
1097 }
1098
1099 if (!m_gdb_comm.IsConnected())
1100 {
1101 if (error.Success())
1102 error.SetErrorString("not connected to remote gdb server");
1103 return error;
1104 }
1105
Eugene Zelenko0722f082015-10-24 01:28:05 +00001106
Ewan Crawfordfab40d32015-06-16 15:50:18 +00001107 // Start the communications read thread so all incoming data can be
1108 // parsed into packets and queued as they arrive.
1109 if (GetTarget().GetNonStopModeEnabled())
1110 m_gdb_comm.StartReadThread();
1111
Greg Clayton32e0a752011-03-30 18:16:51 +00001112 // We always seem to be able to open a connection to a local port
1113 // so we need to make sure we can then send data to it. If we can't
1114 // then we aren't actually connected to anything, so try and do the
Ed Maste81b4c5f2016-01-04 01:43:47 +00001115 // handshake with the remote GDB server and make sure that goes
Greg Clayton32e0a752011-03-30 18:16:51 +00001116 // alright.
Greg Claytonfb909312013-11-23 01:58:15 +00001117 if (!m_gdb_comm.HandshakeWithServer (&error))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001118 {
Greg Clayton32e0a752011-03-30 18:16:51 +00001119 m_gdb_comm.Disconnect();
1120 if (error.Success())
1121 error.SetErrorString("not connected to remote gdb server");
1122 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001123 }
Ewan Crawford78baa192015-05-13 09:18:18 +00001124
1125 // Send $QNonStop:1 packet on startup if required
1126 if (GetTarget().GetNonStopModeEnabled())
Ewan Crawfordaa7eda72015-06-24 15:14:26 +00001127 GetTarget().SetNonStopModeEnabled (m_gdb_comm.SetNonStopMode(true));
Ewan Crawford78baa192015-05-13 09:18:18 +00001128
Greg Claytonb30c50c2015-05-29 00:01:55 +00001129 m_gdb_comm.GetEchoSupported ();
Greg Clayton32e0a752011-03-30 18:16:51 +00001130 m_gdb_comm.GetThreadSuffixSupported ();
Greg Clayton44633992012-04-10 03:22:03 +00001131 m_gdb_comm.GetListThreadsInStopReplySupported ();
Greg Clayton32e0a752011-03-30 18:16:51 +00001132 m_gdb_comm.GetHostInfo ();
1133 m_gdb_comm.GetVContSupported ('c');
Jim Inghamcd16df92012-07-20 21:37:13 +00001134 m_gdb_comm.GetVAttachOrWaitSupported();
Ewan Crawford78baa192015-05-13 09:18:18 +00001135
1136 // Ask the remote server for the default thread id
1137 if (GetTarget().GetNonStopModeEnabled())
1138 m_gdb_comm.GetDefaultThreadId(m_initial_tid);
1139
1140
Jim Ingham03afad82012-07-02 05:40:07 +00001141 size_t num_cmds = GetExtraStartupCommands().GetArgumentCount();
1142 for (size_t idx = 0; idx < num_cmds; idx++)
1143 {
1144 StringExtractorGDBRemote response;
Jim Ingham03afad82012-07-02 05:40:07 +00001145 m_gdb_comm.SendPacketAndWaitForResponse (GetExtraStartupCommands().GetArgumentAtIndex(idx), response, false);
1146 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001147 return error;
1148}
1149
1150void
Jim Inghambb006ce2014-08-02 00:33:35 +00001151ProcessGDBRemote::DidLaunchOrAttach (ArchSpec& process_arch)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001152{
Greg Clayton5160ce52013-03-27 23:08:40 +00001153 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
Greg Clayton6d093452011-02-05 02:25:06 +00001154 if (log)
1155 log->Printf ("ProcessGDBRemote::DidLaunch()");
Greg Clayton93d3c8332011-02-16 04:46:07 +00001156 if (GetID() != LLDB_INVALID_PROCESS_ID)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001157 {
Greg Clayton513c26c2011-01-29 07:10:55 +00001158 BuildDynamicRegisterInfo (false);
Greg Clayton3af9ea52010-11-18 05:57:03 +00001159
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001160 // See if the GDB server supports the qHostInfo information
Greg Clayton0d0c12a2011-02-09 03:09:55 +00001161
Jason Molendaf17b5ac2012-12-19 02:54:03 +00001162
1163 // See if the GDB server supports the qProcessInfo packet, if so
1164 // prefer that over the Host information as it will be more specific
1165 // to our process.
1166
Todd Fiala75f47c32014-10-11 21:42:09 +00001167 const ArchSpec &remote_process_arch = m_gdb_comm.GetProcessArchitecture();
1168 if (remote_process_arch.IsValid())
1169 {
1170 process_arch = remote_process_arch;
1171 if (log)
1172 log->Printf ("ProcessGDBRemote::%s gdb-remote had process architecture, using %s %s",
1173 __FUNCTION__,
1174 process_arch.GetArchitectureName () ? process_arch.GetArchitectureName () : "<null>",
1175 process_arch.GetTriple().getTriple ().c_str() ? process_arch.GetTriple().getTriple ().c_str() : "<null>");
1176 }
Jim Inghambb006ce2014-08-02 00:33:35 +00001177 else
Todd Fiala75f47c32014-10-11 21:42:09 +00001178 {
Jim Inghambb006ce2014-08-02 00:33:35 +00001179 process_arch = m_gdb_comm.GetHostArchitecture();
Todd Fiala75f47c32014-10-11 21:42:09 +00001180 if (log)
1181 log->Printf ("ProcessGDBRemote::%s gdb-remote did not have process architecture, using gdb-remote host architecture %s %s",
1182 __FUNCTION__,
1183 process_arch.GetArchitectureName () ? process_arch.GetArchitectureName () : "<null>",
1184 process_arch.GetTriple().getTriple ().c_str() ? process_arch.GetTriple().getTriple ().c_str() : "<null>");
1185 }
Jason Molendaf17b5ac2012-12-19 02:54:03 +00001186
Jim Inghambb006ce2014-08-02 00:33:35 +00001187 if (process_arch.IsValid())
Greg Clayton0d0c12a2011-02-09 03:09:55 +00001188 {
Tamas Berghammere724af12015-03-13 10:32:37 +00001189 const ArchSpec &target_arch = GetTarget().GetArchitecture();
Greg Claytond314e812011-03-23 00:09:55 +00001190 if (target_arch.IsValid())
1191 {
Todd Fiala75f47c32014-10-11 21:42:09 +00001192 if (log)
1193 log->Printf ("ProcessGDBRemote::%s analyzing target arch, currently %s %s",
1194 __FUNCTION__,
1195 target_arch.GetArchitectureName () ? target_arch.GetArchitectureName () : "<null>",
1196 target_arch.GetTriple().getTriple ().c_str() ? target_arch.GetTriple().getTriple ().c_str() : "<null>");
1197
1198 // If the remote host is ARM and we have apple as the vendor, then
Greg Claytond314e812011-03-23 00:09:55 +00001199 // ARM executables and shared libraries can have mixed ARM architectures.
1200 // You can have an armv6 executable, and if the host is armv7, then the
1201 // system will load the best possible architecture for all shared libraries
1202 // it has, so we really need to take the remote host architecture as our
1203 // defacto architecture in this case.
1204
Jason Molenda6d9fe8c2015-08-21 00:13:37 +00001205 if ((process_arch.GetMachine() == llvm::Triple::arm || process_arch.GetMachine() == llvm::Triple::thumb)
1206 && process_arch.GetTriple().getVendor() == llvm::Triple::Apple)
Greg Claytond314e812011-03-23 00:09:55 +00001207 {
Jason Molenda921c01b2014-08-03 21:42:52 +00001208 GetTarget().SetArchitecture (process_arch);
Todd Fiala75f47c32014-10-11 21:42:09 +00001209 if (log)
1210 log->Printf ("ProcessGDBRemote::%s remote process is ARM/Apple, setting target arch to %s %s",
1211 __FUNCTION__,
1212 process_arch.GetArchitectureName () ? process_arch.GetArchitectureName () : "<null>",
1213 process_arch.GetTriple().getTriple ().c_str() ? process_arch.GetTriple().getTriple ().c_str() : "<null>");
Greg Claytond314e812011-03-23 00:09:55 +00001214 }
1215 else
1216 {
1217 // Fill in what is missing in the triple
Jim Inghambb006ce2014-08-02 00:33:35 +00001218 const llvm::Triple &remote_triple = process_arch.GetTriple();
Tamas Berghammere724af12015-03-13 10:32:37 +00001219 llvm::Triple new_target_triple = target_arch.GetTriple();
1220 if (new_target_triple.getVendorName().size() == 0)
Greg Clayton70b57652011-05-15 01:25:55 +00001221 {
Tamas Berghammere724af12015-03-13 10:32:37 +00001222 new_target_triple.setVendor (remote_triple.getVendor());
Greg Claytond314e812011-03-23 00:09:55 +00001223
Tamas Berghammere724af12015-03-13 10:32:37 +00001224 if (new_target_triple.getOSName().size() == 0)
Greg Clayton70b57652011-05-15 01:25:55 +00001225 {
Tamas Berghammere724af12015-03-13 10:32:37 +00001226 new_target_triple.setOS (remote_triple.getOS());
Greg Claytond314e812011-03-23 00:09:55 +00001227
Tamas Berghammere724af12015-03-13 10:32:37 +00001228 if (new_target_triple.getEnvironmentName().size() == 0)
1229 new_target_triple.setEnvironment (remote_triple.getEnvironment());
Greg Clayton70b57652011-05-15 01:25:55 +00001230 }
Todd Fiala75f47c32014-10-11 21:42:09 +00001231
Tamas Berghammere724af12015-03-13 10:32:37 +00001232 ArchSpec new_target_arch = target_arch;
1233 new_target_arch.SetTriple(new_target_triple);
1234 GetTarget().SetArchitecture(new_target_arch);
1235 }
Greg Claytond314e812011-03-23 00:09:55 +00001236 }
Todd Fiala75f47c32014-10-11 21:42:09 +00001237
1238 if (log)
1239 log->Printf ("ProcessGDBRemote::%s final target arch after adjustments for remote architecture: %s %s",
1240 __FUNCTION__,
1241 target_arch.GetArchitectureName () ? target_arch.GetArchitectureName () : "<null>",
1242 target_arch.GetTriple().getTriple ().c_str() ? target_arch.GetTriple().getTriple ().c_str() : "<null>");
Greg Claytond314e812011-03-23 00:09:55 +00001243 }
1244 else
1245 {
1246 // The target doesn't have a valid architecture yet, set it from
1247 // the architecture we got from the remote GDB server
Jason Molenda921c01b2014-08-03 21:42:52 +00001248 GetTarget().SetArchitecture (process_arch);
Greg Claytond314e812011-03-23 00:09:55 +00001249 }
Greg Clayton0d0c12a2011-02-09 03:09:55 +00001250 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001251 }
1252}
1253
1254void
1255ProcessGDBRemote::DidLaunch ()
1256{
Jim Inghambb006ce2014-08-02 00:33:35 +00001257 ArchSpec process_arch;
1258 DidLaunchOrAttach (process_arch);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001259}
1260
1261Error
Han Ming Ong84647042012-02-25 01:07:38 +00001262ProcessGDBRemote::DoAttachToProcessWithID (lldb::pid_t attach_pid, const ProcessAttachInfo &attach_info)
1263{
Todd Fiala75f47c32014-10-11 21:42:09 +00001264 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001265 Error error;
Todd Fiala75f47c32014-10-11 21:42:09 +00001266
1267 if (log)
1268 log->Printf ("ProcessGDBRemote::%s()", __FUNCTION__);
1269
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001270 // Clear out and clean up from any current state
1271 Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001272 if (attach_pid != LLDB_INVALID_PROCESS_ID)
1273 {
Oleksiy Vyalovafd6ce42015-11-23 19:32:24 +00001274 error = EstablishConnectionIfNeeded (attach_info);
Greg Clayton71337622011-02-24 22:24:29 +00001275 if (error.Success())
1276 {
Jim Ingham106d0282014-06-25 02:32:56 +00001277 m_gdb_comm.SetDetachOnError(attach_info.GetDetachOnError());
Todd Fiala75f47c32014-10-11 21:42:09 +00001278
Greg Clayton71337622011-02-24 22:24:29 +00001279 char packet[64];
Daniel Malead01b2952012-11-29 21:49:15 +00001280 const int packet_len = ::snprintf (packet, sizeof(packet), "vAttach;%" PRIx64, attach_pid);
Ed Maste81b4c5f2016-01-04 01:43:47 +00001281 SetID (attach_pid);
Greg Clayton71337622011-02-24 22:24:29 +00001282 m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncContinue, new EventDataBytes (packet, packet_len));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001283 }
Oleksiy Vyalovafd6ce42015-11-23 19:32:24 +00001284 else
1285 SetExitStatus (-1, error.AsCString());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001286 }
Todd Fiala75f47c32014-10-11 21:42:09 +00001287
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001288 return error;
1289}
1290
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001291Error
Jean-Daniel Dupas9c517c02013-12-23 22:32:54 +00001292ProcessGDBRemote::DoAttachToProcessWithName (const char *process_name, const ProcessAttachInfo &attach_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001293{
1294 Error error;
1295 // Clear out and clean up from any current state
1296 Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001297
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001298 if (process_name && process_name[0])
1299 {
Oleksiy Vyalovafd6ce42015-11-23 19:32:24 +00001300 error = EstablishConnectionIfNeeded (attach_info);
Greg Clayton71337622011-02-24 22:24:29 +00001301 if (error.Success())
1302 {
1303 StreamString packet;
Ed Maste81b4c5f2016-01-04 01:43:47 +00001304
Jim Ingham106d0282014-06-25 02:32:56 +00001305 m_gdb_comm.SetDetachOnError(attach_info.GetDetachOnError());
Ed Maste81b4c5f2016-01-04 01:43:47 +00001306
Jean-Daniel Dupas9c517c02013-12-23 22:32:54 +00001307 if (attach_info.GetWaitForLaunch())
Jim Inghamcd16df92012-07-20 21:37:13 +00001308 {
1309 if (!m_gdb_comm.GetVAttachOrWaitSupported())
1310 {
1311 packet.PutCString ("vAttachWait");
1312 }
1313 else
1314 {
1315 if (attach_info.GetIgnoreExisting())
1316 packet.PutCString("vAttachWait");
1317 else
1318 packet.PutCString ("vAttachOrWait");
1319 }
1320 }
Greg Clayton71337622011-02-24 22:24:29 +00001321 else
1322 packet.PutCString("vAttachName");
1323 packet.PutChar(';');
Bruce Mitchener9ccb9702015-11-07 04:40:13 +00001324 packet.PutBytesAsRawHex8(process_name, strlen(process_name), endian::InlHostByteOrder(), endian::InlHostByteOrder());
Ed Maste81b4c5f2016-01-04 01:43:47 +00001325
Greg Clayton71337622011-02-24 22:24:29 +00001326 m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncContinue, new EventDataBytes (packet.GetData(), packet.GetSize()));
1327
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001328 }
Oleksiy Vyalovafd6ce42015-11-23 19:32:24 +00001329 else
1330 SetExitStatus (-1, error.AsCString());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001331 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001332 return error;
1333}
1334
Greg Clayton5df78fa2015-05-23 03:54:53 +00001335void
1336ProcessGDBRemote::DidExit ()
Greg Claytonfbb76342013-11-20 21:07:01 +00001337{
Greg Clayton5df78fa2015-05-23 03:54:53 +00001338 // When we exit, disconnect from the GDB server communications
Greg Claytonfbb76342013-11-20 21:07:01 +00001339 m_gdb_comm.Disconnect();
Greg Claytonfbb76342013-11-20 21:07:01 +00001340}
1341
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001342void
Jim Inghambb006ce2014-08-02 00:33:35 +00001343ProcessGDBRemote::DidAttach (ArchSpec &process_arch)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001344{
Jim Inghambb006ce2014-08-02 00:33:35 +00001345 // If you can figure out what the architecture is, fill it in here.
1346 process_arch.Clear();
1347 DidLaunchOrAttach (process_arch);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001348}
1349
Eugene Zelenko0722f082015-10-24 01:28:05 +00001350
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001351Error
1352ProcessGDBRemote::WillResume ()
1353{
Greg Clayton71fc2a32011-02-12 06:28:37 +00001354 m_continue_c_tids.clear();
1355 m_continue_C_tids.clear();
1356 m_continue_s_tids.clear();
1357 m_continue_S_tids.clear();
Greg Clayton2e309072015-07-17 23:42:28 +00001358 m_jstopinfo_sp.reset();
1359 m_jthreadsinfo_sp.reset();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001360 return Error();
1361}
1362
1363Error
1364ProcessGDBRemote::DoResume ()
1365{
Jim Ingham0d8bcc72010-11-17 02:32:00 +00001366 Error error;
Greg Clayton5160ce52013-03-27 23:08:40 +00001367 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
Greg Clayton6d093452011-02-05 02:25:06 +00001368 if (log)
1369 log->Printf ("ProcessGDBRemote::Resume()");
Ed Maste81b4c5f2016-01-04 01:43:47 +00001370
Jim Ingham583bbb12016-03-07 21:50:25 +00001371 ListenerSP listener_sp (Listener::MakeListener("gdb-remote.resume-packet-sent"));
1372 if (listener_sp->StartListeningForEvents (&m_gdb_comm, GDBRemoteCommunication::eBroadcastBitRunPacketSent))
Greg Claytone5219662010-12-03 06:02:24 +00001373 {
Jim Ingham583bbb12016-03-07 21:50:25 +00001374 listener_sp->StartListeningForEvents (&m_async_broadcaster, ProcessGDBRemote::eBroadcastBitAsyncThreadDidExit);
Ed Maste81b4c5f2016-01-04 01:43:47 +00001375
Greg Claytond1d06e42013-04-20 00:27:58 +00001376 const size_t num_threads = GetThreadList().GetSize();
1377
Greg Clayton71fc2a32011-02-12 06:28:37 +00001378 StreamString continue_packet;
1379 bool continue_packet_error = false;
1380 if (m_gdb_comm.HasAnyVContSupport ())
1381 {
Ewan Crawford78baa192015-05-13 09:18:18 +00001382 if (!GetTarget().GetNonStopModeEnabled() &&
1383 (m_continue_c_tids.size() == num_threads ||
Greg Claytone98008c2014-02-13 23:34:38 +00001384 (m_continue_c_tids.empty() &&
1385 m_continue_C_tids.empty() &&
1386 m_continue_s_tids.empty() &&
Ewan Crawford78baa192015-05-13 09:18:18 +00001387 m_continue_S_tids.empty())))
Greg Clayton71fc2a32011-02-12 06:28:37 +00001388 {
Greg Claytond1d06e42013-04-20 00:27:58 +00001389 // All threads are continuing, just send a "c" packet
1390 continue_packet.PutCString ("c");
Greg Clayton71fc2a32011-02-12 06:28:37 +00001391 }
Greg Claytond1d06e42013-04-20 00:27:58 +00001392 else
1393 {
1394 continue_packet.PutCString ("vCont");
Ed Maste81b4c5f2016-01-04 01:43:47 +00001395
Greg Claytond1d06e42013-04-20 00:27:58 +00001396 if (!m_continue_c_tids.empty())
Greg Clayton71fc2a32011-02-12 06:28:37 +00001397 {
Greg Claytond1d06e42013-04-20 00:27:58 +00001398 if (m_gdb_comm.GetVContSupported ('c'))
1399 {
1400 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)
1401 continue_packet.Printf(";c:%4.4" PRIx64, *t_pos);
1402 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001403 else
Greg Claytond1d06e42013-04-20 00:27:58 +00001404 continue_packet_error = true;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001405 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001406
Greg Claytond1d06e42013-04-20 00:27:58 +00001407 if (!continue_packet_error && !m_continue_C_tids.empty())
1408 {
1409 if (m_gdb_comm.GetVContSupported ('C'))
1410 {
1411 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)
1412 continue_packet.Printf(";C%2.2x:%4.4" PRIx64, s_pos->second, s_pos->first);
1413 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001414 else
Greg Claytond1d06e42013-04-20 00:27:58 +00001415 continue_packet_error = true;
1416 }
Greg Claytone5219662010-12-03 06:02:24 +00001417
Greg Claytond1d06e42013-04-20 00:27:58 +00001418 if (!continue_packet_error && !m_continue_s_tids.empty())
Greg Clayton71fc2a32011-02-12 06:28:37 +00001419 {
Greg Claytond1d06e42013-04-20 00:27:58 +00001420 if (m_gdb_comm.GetVContSupported ('s'))
1421 {
1422 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)
1423 continue_packet.Printf(";s:%4.4" PRIx64, *t_pos);
1424 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001425 else
Greg Claytond1d06e42013-04-20 00:27:58 +00001426 continue_packet_error = true;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001427 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001428
Greg Claytond1d06e42013-04-20 00:27:58 +00001429 if (!continue_packet_error && !m_continue_S_tids.empty())
Greg Clayton71fc2a32011-02-12 06:28:37 +00001430 {
Greg Claytond1d06e42013-04-20 00:27:58 +00001431 if (m_gdb_comm.GetVContSupported ('S'))
1432 {
1433 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)
1434 continue_packet.Printf(";S%2.2x:%4.4" PRIx64, s_pos->second, s_pos->first);
1435 }
1436 else
1437 continue_packet_error = true;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001438 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001439
Greg Claytond1d06e42013-04-20 00:27:58 +00001440 if (continue_packet_error)
1441 continue_packet.GetString().clear();
Greg Clayton71fc2a32011-02-12 06:28:37 +00001442 }
Greg Clayton71fc2a32011-02-12 06:28:37 +00001443 }
1444 else
1445 continue_packet_error = true;
Ed Maste81b4c5f2016-01-04 01:43:47 +00001446
Greg Clayton71fc2a32011-02-12 06:28:37 +00001447 if (continue_packet_error)
1448 {
Greg Clayton71fc2a32011-02-12 06:28:37 +00001449 // Either no vCont support, or we tried to use part of the vCont
1450 // packet that wasn't supported by the remote GDB server.
1451 // We need to try and make a simple packet that can do our continue
Greg Clayton71fc2a32011-02-12 06:28:37 +00001452 const size_t num_continue_c_tids = m_continue_c_tids.size();
1453 const size_t num_continue_C_tids = m_continue_C_tids.size();
1454 const size_t num_continue_s_tids = m_continue_s_tids.size();
1455 const size_t num_continue_S_tids = m_continue_S_tids.size();
1456 if (num_continue_c_tids > 0)
1457 {
1458 if (num_continue_c_tids == num_threads)
1459 {
1460 // All threads are resuming...
Greg Clayton8b82f082011-04-12 05:54:46 +00001461 m_gdb_comm.SetCurrentThreadForRun (-1);
Ed Maste81b4c5f2016-01-04 01:43:47 +00001462 continue_packet.PutChar ('c');
Greg Clayton0c74e782011-06-24 03:21:43 +00001463 continue_packet_error = false;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001464 }
1465 else if (num_continue_c_tids == 1 &&
Ed Maste81b4c5f2016-01-04 01:43:47 +00001466 num_continue_C_tids == 0 &&
1467 num_continue_s_tids == 0 &&
Greg Clayton71fc2a32011-02-12 06:28:37 +00001468 num_continue_S_tids == 0 )
1469 {
1470 // Only one thread is continuing
Greg Clayton8b82f082011-04-12 05:54:46 +00001471 m_gdb_comm.SetCurrentThreadForRun (m_continue_c_tids.front());
Ed Maste81b4c5f2016-01-04 01:43:47 +00001472 continue_packet.PutChar ('c');
Greg Clayton0c74e782011-06-24 03:21:43 +00001473 continue_packet_error = false;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001474 }
1475 }
1476
Greg Clayton0c74e782011-06-24 03:21:43 +00001477 if (continue_packet_error && num_continue_C_tids > 0)
Greg Clayton71fc2a32011-02-12 06:28:37 +00001478 {
Ed Maste81b4c5f2016-01-04 01:43:47 +00001479 if ((num_continue_C_tids + num_continue_c_tids) == num_threads &&
1480 num_continue_C_tids > 0 &&
1481 num_continue_s_tids == 0 &&
Greg Clayton0c74e782011-06-24 03:21:43 +00001482 num_continue_S_tids == 0 )
Greg Clayton71fc2a32011-02-12 06:28:37 +00001483 {
1484 const int continue_signo = m_continue_C_tids.front().second;
Greg Clayton0c74e782011-06-24 03:21:43 +00001485 // Only one thread is continuing
Greg Clayton71fc2a32011-02-12 06:28:37 +00001486 if (num_continue_C_tids > 1)
1487 {
Ed Maste81b4c5f2016-01-04 01:43:47 +00001488 // More that one thread with a signal, yet we don't have
Greg Clayton0c74e782011-06-24 03:21:43 +00001489 // vCont support and we are being asked to resume each
1490 // thread with a signal, we need to make sure they are
1491 // all the same signal, or we can't issue the continue
1492 // accurately with the current support...
1493 if (num_continue_C_tids > 1)
Greg Clayton71fc2a32011-02-12 06:28:37 +00001494 {
Greg Clayton0c74e782011-06-24 03:21:43 +00001495 continue_packet_error = false;
1496 for (size_t i=1; i<m_continue_C_tids.size(); ++i)
1497 {
1498 if (m_continue_C_tids[i].second != continue_signo)
1499 continue_packet_error = true;
1500 }
Greg Clayton71fc2a32011-02-12 06:28:37 +00001501 }
Greg Clayton0c74e782011-06-24 03:21:43 +00001502 if (!continue_packet_error)
1503 m_gdb_comm.SetCurrentThreadForRun (-1);
1504 }
1505 else
1506 {
1507 // Set the continue thread ID
1508 continue_packet_error = false;
1509 m_gdb_comm.SetCurrentThreadForRun (m_continue_C_tids.front().first);
Greg Clayton71fc2a32011-02-12 06:28:37 +00001510 }
1511 if (!continue_packet_error)
1512 {
1513 // Add threads continuing with the same signo...
Greg Clayton71fc2a32011-02-12 06:28:37 +00001514 continue_packet.Printf("C%2.2x", continue_signo);
1515 }
1516 }
Greg Clayton71fc2a32011-02-12 06:28:37 +00001517 }
1518
Greg Clayton0c74e782011-06-24 03:21:43 +00001519 if (continue_packet_error && num_continue_s_tids > 0)
Greg Clayton71fc2a32011-02-12 06:28:37 +00001520 {
1521 if (num_continue_s_tids == num_threads)
1522 {
1523 // All threads are resuming...
Greg Clayton8b82f082011-04-12 05:54:46 +00001524 m_gdb_comm.SetCurrentThreadForRun (-1);
Ewan Crawford76df2882015-06-23 12:32:06 +00001525
1526 // If in Non-Stop-Mode use vCont when stepping
1527 if (GetTarget().GetNonStopModeEnabled())
1528 {
1529 if (m_gdb_comm.GetVContSupported('s'))
1530 continue_packet.PutCString("vCont;s");
1531 else
1532 continue_packet.PutChar('s');
1533 }
1534 else
1535 continue_packet.PutChar('s');
1536
Greg Clayton0c74e782011-06-24 03:21:43 +00001537 continue_packet_error = false;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001538 }
1539 else if (num_continue_c_tids == 0 &&
Ed Maste81b4c5f2016-01-04 01:43:47 +00001540 num_continue_C_tids == 0 &&
1541 num_continue_s_tids == 1 &&
Greg Clayton71fc2a32011-02-12 06:28:37 +00001542 num_continue_S_tids == 0 )
1543 {
1544 // Only one thread is stepping
Greg Clayton8b82f082011-04-12 05:54:46 +00001545 m_gdb_comm.SetCurrentThreadForRun (m_continue_s_tids.front());
Ed Maste81b4c5f2016-01-04 01:43:47 +00001546 continue_packet.PutChar ('s');
Greg Clayton0c74e782011-06-24 03:21:43 +00001547 continue_packet_error = false;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001548 }
1549 }
1550
1551 if (!continue_packet_error && num_continue_S_tids > 0)
1552 {
1553 if (num_continue_S_tids == num_threads)
1554 {
1555 const int step_signo = m_continue_S_tids.front().second;
1556 // Are all threads trying to step with the same signal?
Greg Clayton0c74e782011-06-24 03:21:43 +00001557 continue_packet_error = false;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001558 if (num_continue_S_tids > 1)
1559 {
1560 for (size_t i=1; i<num_threads; ++i)
1561 {
1562 if (m_continue_S_tids[i].second != step_signo)
1563 continue_packet_error = true;
1564 }
1565 }
1566 if (!continue_packet_error)
1567 {
1568 // Add threads stepping with the same signo...
Greg Clayton8b82f082011-04-12 05:54:46 +00001569 m_gdb_comm.SetCurrentThreadForRun (-1);
Greg Clayton71fc2a32011-02-12 06:28:37 +00001570 continue_packet.Printf("S%2.2x", step_signo);
1571 }
1572 }
1573 else if (num_continue_c_tids == 0 &&
Ed Maste81b4c5f2016-01-04 01:43:47 +00001574 num_continue_C_tids == 0 &&
1575 num_continue_s_tids == 0 &&
Greg Clayton71fc2a32011-02-12 06:28:37 +00001576 num_continue_S_tids == 1 )
1577 {
1578 // Only one thread is stepping with signal
Greg Clayton8b82f082011-04-12 05:54:46 +00001579 m_gdb_comm.SetCurrentThreadForRun (m_continue_S_tids.front().first);
Greg Clayton71fc2a32011-02-12 06:28:37 +00001580 continue_packet.Printf("S%2.2x", m_continue_S_tids.front().second);
Greg Clayton0c74e782011-06-24 03:21:43 +00001581 continue_packet_error = false;
Greg Clayton71fc2a32011-02-12 06:28:37 +00001582 }
1583 }
1584 }
1585
1586 if (continue_packet_error)
1587 {
1588 error.SetErrorString ("can't make continue packet for this resume");
1589 }
1590 else
1591 {
1592 EventSP event_sp;
1593 TimeValue timeout;
1594 timeout = TimeValue::Now();
1595 timeout.OffsetWithSeconds (5);
Zachary Turneracee96a2014-09-23 18:32:09 +00001596 if (!m_async_thread.IsJoinable())
Jim Inghamb1e2e842012-04-12 18:49:31 +00001597 {
1598 error.SetErrorString ("Trying to resume but the async thread is dead.");
1599 if (log)
1600 log->Printf ("ProcessGDBRemote::DoResume: Trying to resume but the async thread is dead.");
1601 return error;
1602 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001603
Greg Clayton71fc2a32011-02-12 06:28:37 +00001604 m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncContinue, new EventDataBytes (continue_packet.GetData(), continue_packet.GetSize()));
1605
Jim Ingham583bbb12016-03-07 21:50:25 +00001606 if (listener_sp->WaitForEvent (&timeout, event_sp) == false)
Jim Inghamb1e2e842012-04-12 18:49:31 +00001607 {
Greg Clayton71fc2a32011-02-12 06:28:37 +00001608 error.SetErrorString("Resume timed out.");
Jim Inghamb1e2e842012-04-12 18:49:31 +00001609 if (log)
1610 log->Printf ("ProcessGDBRemote::DoResume: Resume timed out.");
1611 }
1612 else if (event_sp->BroadcasterIs (&m_async_broadcaster))
1613 {
1614 error.SetErrorString ("Broadcast continue, but the async thread was killed before we got an ack back.");
1615 if (log)
1616 log->Printf ("ProcessGDBRemote::DoResume: Broadcast continue, but the async thread was killed before we got an ack back.");
1617 return error;
1618 }
Greg Clayton71fc2a32011-02-12 06:28:37 +00001619 }
Greg Claytone5219662010-12-03 06:02:24 +00001620 }
1621
Jim Ingham0d8bcc72010-11-17 02:32:00 +00001622 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001623}
1624
Greg Clayton9e920902012-04-10 02:25:43 +00001625void
Ewan Crawford78baa192015-05-13 09:18:18 +00001626ProcessGDBRemote::HandleStopReplySequence ()
1627{
1628 while(true)
1629 {
1630 // Send vStopped
1631 StringExtractorGDBRemote response;
1632 m_gdb_comm.SendPacketAndWaitForResponse("vStopped", response, false);
1633
1634 // OK represents end of signal list
1635 if (response.IsOKResponse())
1636 break;
1637
1638 // If not OK or a normal packet we have a problem
1639 if (!response.IsNormalResponse())
1640 break;
1641
1642 SetLastStopPacket(response);
1643 }
1644}
1645
1646void
Greg Clayton9e920902012-04-10 02:25:43 +00001647ProcessGDBRemote::ClearThreadIDList ()
1648{
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00001649 std::lock_guard<std::recursive_mutex> guard(m_thread_list_real.GetMutex());
Greg Clayton9e920902012-04-10 02:25:43 +00001650 m_thread_ids.clear();
Jason Molenda545304d2015-12-18 00:45:35 +00001651 m_thread_pcs.clear();
Greg Clayton9e920902012-04-10 02:25:43 +00001652}
1653
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001654size_t
1655ProcessGDBRemote::UpdateThreadIDsFromStopReplyThreadsValue (std::string &value)
1656{
1657 m_thread_ids.clear();
Jason Molenda545304d2015-12-18 00:45:35 +00001658 m_thread_pcs.clear();
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001659 size_t comma_pos;
1660 lldb::tid_t tid;
1661 while ((comma_pos = value.find(',')) != std::string::npos)
1662 {
1663 value[comma_pos] = '\0';
1664 // thread in big endian hex
1665 tid = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_THREAD_ID, 16);
1666 if (tid != LLDB_INVALID_THREAD_ID)
1667 m_thread_ids.push_back (tid);
1668 value.erase(0, comma_pos + 1);
1669 }
1670 tid = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_THREAD_ID, 16);
1671 if (tid != LLDB_INVALID_THREAD_ID)
1672 m_thread_ids.push_back (tid);
1673 return m_thread_ids.size();
1674}
1675
Jason Molenda545304d2015-12-18 00:45:35 +00001676size_t
1677ProcessGDBRemote::UpdateThreadPCsFromStopReplyThreadsValue (std::string &value)
1678{
1679 m_thread_pcs.clear();
1680 size_t comma_pos;
1681 lldb::addr_t pc;
1682 while ((comma_pos = value.find(',')) != std::string::npos)
1683 {
1684 value[comma_pos] = '\0';
1685 pc = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_ADDRESS, 16);
1686 if (pc != LLDB_INVALID_ADDRESS)
1687 m_thread_pcs.push_back (pc);
1688 value.erase(0, comma_pos + 1);
1689 }
1690 pc = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_ADDRESS, 16);
1691 if (pc != LLDB_INVALID_THREAD_ID)
1692 m_thread_pcs.push_back (pc);
1693 return m_thread_pcs.size();
1694}
1695
Greg Clayton9e920902012-04-10 02:25:43 +00001696bool
1697ProcessGDBRemote::UpdateThreadIDList ()
1698{
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00001699 std::lock_guard<std::recursive_mutex> guard(m_thread_list_real.GetMutex());
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001700
Greg Clayton2e309072015-07-17 23:42:28 +00001701 if (m_jthreadsinfo_sp)
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001702 {
1703 // If we have the JSON threads info, we can get the thread list from that
Greg Clayton2e309072015-07-17 23:42:28 +00001704 StructuredData::Array *thread_infos = m_jthreadsinfo_sp->GetAsArray();
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001705 if (thread_infos && thread_infos->GetSize() > 0)
1706 {
1707 m_thread_ids.clear();
Jason Molenda545304d2015-12-18 00:45:35 +00001708 m_thread_pcs.clear();
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001709 thread_infos->ForEach([this](StructuredData::Object* object) -> bool {
1710 StructuredData::Dictionary *thread_dict = object->GetAsDictionary();
1711 if (thread_dict)
1712 {
1713 // Set the thread stop info from the JSON dictionary
1714 SetThreadStopInfo (thread_dict);
1715 lldb::tid_t tid = LLDB_INVALID_THREAD_ID;
1716 if (thread_dict->GetValueForKeyAsInteger<lldb::tid_t>("tid", tid))
1717 m_thread_ids.push_back(tid);
1718 }
1719 return true; // Keep iterating through all thread_info objects
1720 });
1721 }
1722 if (!m_thread_ids.empty())
1723 return true;
1724 }
1725 else
1726 {
1727 // See if we can get the thread IDs from the current stop reply packets
1728 // that might contain a "threads" key/value pair
1729
1730 // Lock the thread stack while we access it
Greg Claytonfc1e77a982015-11-03 22:42:04 +00001731 //Mutex::Locker stop_stack_lock(m_last_stop_packet_mutex);
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +00001732 std::unique_lock<std::recursive_mutex> stop_stack_lock(m_last_stop_packet_mutex, std::defer_lock);
1733 if (stop_stack_lock.try_lock())
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001734 {
Greg Claytonfc1e77a982015-11-03 22:42:04 +00001735 // Get the number of stop packets on the stack
1736 int nItems = m_stop_packet_stack.size();
1737 // Iterate over them
1738 for (int i = 0; i < nItems; i++)
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001739 {
Greg Claytonfc1e77a982015-11-03 22:42:04 +00001740 // Get the thread stop info
1741 StringExtractorGDBRemote &stop_info = m_stop_packet_stack[i];
1742 const std::string &stop_info_str = stop_info.GetStringRef();
Jason Molenda545304d2015-12-18 00:45:35 +00001743
1744 m_thread_pcs.clear();
1745 const size_t thread_pcs_pos = stop_info_str.find(";thread-pcs:");
1746 if (thread_pcs_pos != std::string::npos)
1747 {
1748 const size_t start = thread_pcs_pos + strlen(";thread-pcs:");
1749 const size_t end = stop_info_str.find(';', start);
1750 if (end != std::string::npos)
1751 {
1752 std::string value = stop_info_str.substr(start, end - start);
1753 UpdateThreadPCsFromStopReplyThreadsValue(value);
1754 }
1755 }
1756
Greg Claytonfc1e77a982015-11-03 22:42:04 +00001757 const size_t threads_pos = stop_info_str.find(";threads:");
1758 if (threads_pos != std::string::npos)
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001759 {
Greg Claytonfc1e77a982015-11-03 22:42:04 +00001760 const size_t start = threads_pos + strlen(";threads:");
1761 const size_t end = stop_info_str.find(';', start);
1762 if (end != std::string::npos)
1763 {
1764 std::string value = stop_info_str.substr(start, end - start);
1765 if (UpdateThreadIDsFromStopReplyThreadsValue(value))
1766 return true;
1767 }
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001768 }
1769 }
1770 }
1771 }
1772
Greg Clayton9e920902012-04-10 02:25:43 +00001773 bool sequence_mutex_unavailable = false;
1774 m_gdb_comm.GetCurrentThreadIDs (m_thread_ids, sequence_mutex_unavailable);
1775 if (sequence_mutex_unavailable)
1776 {
Greg Clayton9e920902012-04-10 02:25:43 +00001777 return false; // We just didn't get the list
1778 }
1779 return true;
1780}
1781
Greg Clayton9fc13552012-04-10 00:18:59 +00001782bool
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001783ProcessGDBRemote::UpdateThreadList (ThreadList &old_thread_list, ThreadList &new_thread_list)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001784{
1785 // locker will keep a mutex locked until it goes out of scope
Greg Clayton5160ce52013-03-27 23:08:40 +00001786 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_THREAD));
Greg Clayton73b472d2010-10-27 03:32:59 +00001787 if (log && log->GetMask().Test(GDBR_LOG_VERBOSE))
Daniel Malead01b2952012-11-29 21:49:15 +00001788 log->Printf ("ProcessGDBRemote::%s (pid = %" PRIu64 ")", __FUNCTION__, GetID());
Ed Maste81b4c5f2016-01-04 01:43:47 +00001789
Greg Clayton9e920902012-04-10 02:25:43 +00001790 size_t num_thread_ids = m_thread_ids.size();
1791 // The "m_thread_ids" thread ID list should always be updated after each stop
1792 // reply packet, but in case it isn't, update it here.
1793 if (num_thread_ids == 0)
1794 {
1795 if (!UpdateThreadIDList ())
1796 return false;
1797 num_thread_ids = m_thread_ids.size();
1798 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001799
Han Ming Ongc2c423e2013-01-08 22:10:01 +00001800 ThreadList old_thread_list_copy(old_thread_list);
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001801 if (num_thread_ids > 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001802 {
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001803 for (size_t i=0; i<num_thread_ids; ++i)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001804 {
Greg Clayton9e920902012-04-10 02:25:43 +00001805 tid_t tid = m_thread_ids[i];
Greg Clayton160c9d82013-05-01 21:54:04 +00001806 ThreadSP thread_sp (old_thread_list_copy.RemoveThreadByProtocolID(tid, false));
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001807 if (!thread_sp)
Jim Inghamdee1bc92013-06-22 00:27:45 +00001808 {
Jim Ingham4f465cf2012-10-10 18:32:14 +00001809 thread_sp.reset (new ThreadGDBRemote (*this, tid));
Jim Inghamdee1bc92013-06-22 00:27:45 +00001810 if (log && log->GetMask().Test(GDBR_LOG_VERBOSE))
1811 log->Printf(
1812 "ProcessGDBRemote::%s Making new thread: %p for thread ID: 0x%" PRIx64 ".\n",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001813 __FUNCTION__, static_cast<void*>(thread_sp.get()),
Jim Inghamdee1bc92013-06-22 00:27:45 +00001814 thread_sp->GetID());
1815 }
1816 else
1817 {
1818 if (log && log->GetMask().Test(GDBR_LOG_VERBOSE))
1819 log->Printf(
1820 "ProcessGDBRemote::%s Found old thread: %p for thread ID: 0x%" PRIx64 ".\n",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001821 __FUNCTION__, static_cast<void*>(thread_sp.get()),
Jim Inghamdee1bc92013-06-22 00:27:45 +00001822 thread_sp->GetID());
1823 }
Jason Molenda545304d2015-12-18 00:45:35 +00001824 // The m_thread_pcs vector has pc values in big-endian order, not target-endian, unlike most
Ed Maste81b4c5f2016-01-04 01:43:47 +00001825 // of the register read/write packets in gdb-remote protocol.
Jason Molenda545304d2015-12-18 00:45:35 +00001826 // Early in the process startup, we may not yet have set the process ByteOrder so we ignore these;
1827 // they are a performance improvement over fetching thread register values individually, the
1828 // method we will fall back to if needed.
1829 if (m_thread_ids.size() == m_thread_pcs.size() && thread_sp.get() && GetByteOrder() != eByteOrderInvalid)
1830 {
1831 ThreadGDBRemote *gdb_thread = static_cast<ThreadGDBRemote *> (thread_sp.get());
1832 RegisterContextSP reg_ctx_sp (thread_sp->GetRegisterContext());
1833 if (reg_ctx_sp)
1834 {
Ed Maste81b4c5f2016-01-04 01:43:47 +00001835 uint32_t pc_regnum = reg_ctx_sp->ConvertRegisterKindToRegisterNumber
Jason Molenda545304d2015-12-18 00:45:35 +00001836 (eRegisterKindGeneric, LLDB_REGNUM_GENERIC_PC);
1837 if (pc_regnum != LLDB_INVALID_REGNUM)
1838 {
1839 gdb_thread->PrivateSetRegisterValue (pc_regnum, m_thread_pcs[i]);
1840 }
1841 }
1842 }
Greg Clayton88f86b62016-06-10 23:23:34 +00001843 new_thread_list.AddThreadSortedByIndexID (thread_sp);
Greg Claytonadc00cb2011-05-20 23:38:13 +00001844 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001845 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001846
Han Ming Ongc2c423e2013-01-08 22:10:01 +00001847 // Whatever that is left in old_thread_list_copy are not
1848 // present in new_thread_list. Remove non-existent threads from internal id table.
1849 size_t old_num_thread_ids = old_thread_list_copy.GetSize(false);
1850 for (size_t i=0; i<old_num_thread_ids; i++)
1851 {
1852 ThreadSP old_thread_sp(old_thread_list_copy.GetThreadAtIndex (i, false));
1853 if (old_thread_sp)
1854 {
Greg Clayton160c9d82013-05-01 21:54:04 +00001855 lldb::tid_t old_thread_id = old_thread_sp->GetProtocolID();
Han Ming Ongc2c423e2013-01-08 22:10:01 +00001856 m_thread_id_to_index_id_map.erase(old_thread_id);
1857 }
1858 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00001859
Greg Clayton9fc13552012-04-10 00:18:59 +00001860 return true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001861}
1862
Eugene Zelenko0722f082015-10-24 01:28:05 +00001863
Greg Clayton358cf1e2015-06-25 21:46:34 +00001864bool
Greg Clayton2e309072015-07-17 23:42:28 +00001865ProcessGDBRemote::GetThreadStopInfoFromJSON (ThreadGDBRemote *thread, const StructuredData::ObjectSP &thread_infos_sp)
Greg Clayton358cf1e2015-06-25 21:46:34 +00001866{
1867 // See if we got thread stop infos for all threads via the "jThreadsInfo" packet
Greg Clayton2e309072015-07-17 23:42:28 +00001868 if (thread_infos_sp)
Greg Clayton358cf1e2015-06-25 21:46:34 +00001869 {
Greg Clayton2e309072015-07-17 23:42:28 +00001870 StructuredData::Array *thread_infos = thread_infos_sp->GetAsArray();
Greg Clayton358cf1e2015-06-25 21:46:34 +00001871 if (thread_infos)
1872 {
1873 lldb::tid_t tid;
1874 const size_t n = thread_infos->GetSize();
1875 for (size_t i=0; i<n; ++i)
1876 {
1877 StructuredData::Dictionary *thread_dict = thread_infos->GetItemAtIndex(i)->GetAsDictionary();
1878 if (thread_dict)
1879 {
1880 if (thread_dict->GetValueForKeyAsInteger<lldb::tid_t>("tid", tid, LLDB_INVALID_THREAD_ID))
1881 {
1882 if (tid == thread->GetID())
Greg Clayton2e309072015-07-17 23:42:28 +00001883 return (bool)SetThreadStopInfo(thread_dict);
Greg Clayton358cf1e2015-06-25 21:46:34 +00001884 }
1885 }
1886 }
1887 }
1888 }
Greg Clayton2e309072015-07-17 23:42:28 +00001889 return false;
1890}
1891
1892bool
1893ProcessGDBRemote::CalculateThreadStopInfo (ThreadGDBRemote *thread)
1894{
1895 // See if we got thread stop infos for all threads via the "jThreadsInfo" packet
1896 if (GetThreadStopInfoFromJSON (thread, m_jthreadsinfo_sp))
1897 return true;
1898
1899 // See if we got thread stop info for any threads valid stop info reasons threads
1900 // via the "jstopinfo" packet stop reply packet key/value pair?
1901 if (m_jstopinfo_sp)
1902 {
1903 // If we have "jstopinfo" then we have stop descriptions for all threads
1904 // that have stop reasons, and if there is no entry for a thread, then
1905 // it has no stop reason.
1906 thread->GetRegisterContext()->InvalidateIfNeeded(true);
1907 if (!GetThreadStopInfoFromJSON (thread, m_jstopinfo_sp))
1908 {
1909 thread->SetStopInfo (StopInfoSP());
1910 }
1911 return true;
1912 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00001913
1914 // Fall back to using the qThreadStopInfo packet
1915 StringExtractorGDBRemote stop_packet;
1916 if (GetGDBRemote().GetThreadStopInfo(thread->GetProtocolID(), stop_packet))
1917 return SetThreadStopInfo (stop_packet) == eStateStopped;
1918 return false;
1919}
1920
Eugene Zelenko0722f082015-10-24 01:28:05 +00001921
Greg Clayton358cf1e2015-06-25 21:46:34 +00001922ThreadSP
1923ProcessGDBRemote::SetThreadStopInfo (lldb::tid_t tid,
1924 ExpeditedRegisterMap &expedited_register_map,
1925 uint8_t signo,
1926 const std::string &thread_name,
1927 const std::string &reason,
1928 const std::string &description,
1929 uint32_t exc_type,
1930 const std::vector<addr_t> &exc_data,
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001931 addr_t thread_dispatch_qaddr,
1932 bool queue_vars_valid, // Set to true if queue_name, queue_kind and queue_serial are valid
Jason Molenda77f89352016-01-12 07:09:16 +00001933 LazyBool associated_with_dispatch_queue,
1934 addr_t dispatch_queue_t,
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001935 std::string &queue_name,
1936 QueueKind queue_kind,
1937 uint64_t queue_serial)
Greg Clayton358cf1e2015-06-25 21:46:34 +00001938{
1939 ThreadSP thread_sp;
1940 if (tid != LLDB_INVALID_THREAD_ID)
1941 {
1942 // Scope for "locker" below
1943 {
1944 // m_thread_list_real does have its own mutex, but we need to
1945 // hold onto the mutex between the call to m_thread_list_real.FindThreadByID(...)
1946 // and the m_thread_list_real.AddThread(...) so it doesn't change on us
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00001947 std::lock_guard<std::recursive_mutex> guard(m_thread_list_real.GetMutex());
Greg Clayton358cf1e2015-06-25 21:46:34 +00001948 thread_sp = m_thread_list_real.FindThreadByProtocolID(tid, false);
1949
1950 if (!thread_sp)
1951 {
1952 // Create the thread if we need to
1953 thread_sp.reset (new ThreadGDBRemote (*this, tid));
1954 m_thread_list_real.AddThread(thread_sp);
1955 }
1956 }
1957
1958 if (thread_sp)
1959 {
1960 ThreadGDBRemote *gdb_thread = static_cast<ThreadGDBRemote *> (thread_sp.get());
1961 gdb_thread->GetRegisterContext()->InvalidateIfNeeded(true);
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001962
Greg Clayton358cf1e2015-06-25 21:46:34 +00001963 for (const auto &pair : expedited_register_map)
1964 {
1965 StringExtractor reg_value_extractor;
1966 reg_value_extractor.GetStringRef() = pair.second;
1967 gdb_thread->PrivateSetRegisterValue (pair.first, reg_value_extractor);
1968 }
1969
Greg Clayton358cf1e2015-06-25 21:46:34 +00001970 thread_sp->SetName (thread_name.empty() ? NULL : thread_name.c_str());
1971
1972 gdb_thread->SetThreadDispatchQAddr (thread_dispatch_qaddr);
Greg Clayton2e59d4f2015-06-29 20:08:51 +00001973 // Check if the GDB server was able to provide the queue name, kind and serial number
1974 if (queue_vars_valid)
Jason Molenda77f89352016-01-12 07:09:16 +00001975 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 +00001976 else
1977 gdb_thread->ClearQueueInfo();
1978
Jason Molenda77f89352016-01-12 07:09:16 +00001979 gdb_thread->SetAssociatedWithLibdispatchQueue (associated_with_dispatch_queue);
1980
1981 if (dispatch_queue_t != LLDB_INVALID_ADDRESS)
1982 gdb_thread->SetQueueLibdispatchQueueAddress (dispatch_queue_t);
1983
Greg Clayton2e309072015-07-17 23:42:28 +00001984 // Make sure we update our thread stop reason just once
1985 if (!thread_sp->StopInfoIsUpToDate())
Greg Clayton358cf1e2015-06-25 21:46:34 +00001986 {
Greg Clayton2e309072015-07-17 23:42:28 +00001987 thread_sp->SetStopInfo (StopInfoSP());
Ryan Brown65d4d5c2015-09-16 21:20:44 +00001988 // If there's a memory thread backed by this thread, we need to use it to calcualte StopInfo.
1989 ThreadSP memory_thread_sp = m_thread_list.FindThreadByProtocolID(thread_sp->GetProtocolID());
1990 if (memory_thread_sp)
1991 thread_sp = memory_thread_sp;
Greg Clayton358cf1e2015-06-25 21:46:34 +00001992
Greg Clayton2e309072015-07-17 23:42:28 +00001993 if (exc_type != 0)
Greg Clayton358cf1e2015-06-25 21:46:34 +00001994 {
Greg Clayton2e309072015-07-17 23:42:28 +00001995 const size_t exc_data_size = exc_data.size();
1996
1997 thread_sp->SetStopInfo (StopInfoMachException::CreateStopReasonWithMachException (*thread_sp,
1998 exc_type,
1999 exc_data_size,
2000 exc_data_size >= 1 ? exc_data[0] : 0,
2001 exc_data_size >= 2 ? exc_data[1] : 0,
2002 exc_data_size >= 3 ? exc_data[2] : 0));
Greg Clayton358cf1e2015-06-25 21:46:34 +00002003 }
Greg Clayton2e309072015-07-17 23:42:28 +00002004 else
Greg Clayton358cf1e2015-06-25 21:46:34 +00002005 {
Greg Clayton2e309072015-07-17 23:42:28 +00002006 bool handled = false;
2007 bool did_exec = false;
2008 if (!reason.empty())
Greg Clayton358cf1e2015-06-25 21:46:34 +00002009 {
Greg Clayton2e309072015-07-17 23:42:28 +00002010 if (reason.compare("trace") == 0)
Greg Clayton358cf1e2015-06-25 21:46:34 +00002011 {
Pavel Labathef409122016-04-07 08:16:10 +00002012 addr_t pc = thread_sp->GetRegisterContext()->GetPC();
2013 lldb::BreakpointSiteSP bp_site_sp = thread_sp->GetProcess()->GetBreakpointSiteList().FindByAddress(pc);
2014
2015 // If the current pc is a breakpoint site then the StopInfo should be set to Breakpoint
2016 // Otherwise, it will be set to Trace.
2017 if (bp_site_sp && bp_site_sp->ValidForThisThread(thread_sp.get()))
2018 {
2019 thread_sp->SetStopInfo(
2020 StopInfo::CreateStopReasonWithBreakpointSiteID(*thread_sp, bp_site_sp->GetID()));
2021 }
2022 else
2023 thread_sp->SetStopInfo (StopInfo::CreateStopReasonToTrace (*thread_sp));
Greg Clayton2e309072015-07-17 23:42:28 +00002024 handled = true;
2025 }
2026 else if (reason.compare("breakpoint") == 0)
2027 {
Pavel Labathef409122016-04-07 08:16:10 +00002028 addr_t pc = thread_sp->GetRegisterContext()->GetPC();
2029 lldb::BreakpointSiteSP bp_site_sp = thread_sp->GetProcess()->GetBreakpointSiteList().FindByAddress(pc);
2030 if (bp_site_sp)
2031 {
2032 // If the breakpoint is for this thread, then we'll report the hit, but if it is for another thread,
2033 // we can just report no reason. We don't need to worry about stepping over the breakpoint here, that
2034 // will be taken care of when the thread resumes and notices that there's a breakpoint under the pc.
2035 handled = true;
2036 if (bp_site_sp->ValidForThisThread (thread_sp.get()))
2037 {
2038 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithBreakpointSiteID (*thread_sp, bp_site_sp->GetID()));
2039 }
2040 else
2041 {
2042 StopInfoSP invalid_stop_info_sp;
2043 thread_sp->SetStopInfo (invalid_stop_info_sp);
2044 }
2045 }
Greg Clayton2e309072015-07-17 23:42:28 +00002046 }
2047 else if (reason.compare("trap") == 0)
2048 {
2049 // Let the trap just use the standard signal stop reason below...
2050 }
2051 else if (reason.compare("watchpoint") == 0)
2052 {
2053 StringExtractor desc_extractor(description.c_str());
2054 addr_t wp_addr = desc_extractor.GetU64(LLDB_INVALID_ADDRESS);
2055 uint32_t wp_index = desc_extractor.GetU32(LLDB_INVALID_INDEX32);
Jaydeep Patil83143502015-08-13 03:44:09 +00002056 addr_t wp_hit_addr = desc_extractor.GetU64(LLDB_INVALID_ADDRESS);
Greg Clayton2e309072015-07-17 23:42:28 +00002057 watch_id_t watch_id = LLDB_INVALID_WATCH_ID;
2058 if (wp_addr != LLDB_INVALID_ADDRESS)
2059 {
Mohit K. Bhakkad6846bc82015-12-02 17:45:02 +00002060 WatchpointSP wp_sp;
2061 ArchSpec::Core core = GetTarget().GetArchitecture().GetCore();
2062 if (core >= ArchSpec::kCore_mips_first && core <= ArchSpec::kCore_mips_last)
2063 wp_sp = GetTarget().GetWatchpointList().FindByAddress(wp_hit_addr);
2064 if (!wp_sp)
2065 wp_sp = GetTarget().GetWatchpointList().FindByAddress(wp_addr);
Greg Clayton2e309072015-07-17 23:42:28 +00002066 if (wp_sp)
2067 {
2068 wp_sp->SetHardwareIndex(wp_index);
2069 watch_id = wp_sp->GetID();
2070 }
2071 }
2072 if (watch_id == LLDB_INVALID_WATCH_ID)
2073 {
2074 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_WATCHPOINTS));
2075 if (log) log->Printf ("failed to find watchpoint");
2076 }
Jaydeep Patil83143502015-08-13 03:44:09 +00002077 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithWatchpointID (*thread_sp, watch_id, wp_hit_addr));
Greg Clayton2e309072015-07-17 23:42:28 +00002078 handled = true;
2079 }
2080 else if (reason.compare("exception") == 0)
2081 {
2082 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithException(*thread_sp, description.c_str()));
2083 handled = true;
2084 }
2085 else if (reason.compare("exec") == 0)
2086 {
2087 did_exec = true;
2088 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithExec(*thread_sp));
2089 handled = true;
2090 }
2091 }
Pavel Labath3ce324a2016-04-06 09:10:29 +00002092 else if (!signo)
2093 {
Pavel Labathef409122016-04-07 08:16:10 +00002094 addr_t pc = thread_sp->GetRegisterContext()->GetPC();
2095 lldb::BreakpointSiteSP bp_site_sp =
2096 thread_sp->GetProcess()->GetBreakpointSiteList().FindByAddress(pc);
2097
Pavel Labath3ce324a2016-04-06 09:10:29 +00002098 // If the current pc is a breakpoint site then the StopInfo should be set to Breakpoint
2099 // even though the remote stub did not set it as such. This can happen when
2100 // the thread is involuntarily interrupted (e.g. due to stops on other
2101 // threads) just as it is about to execute the breakpoint instruction.
Pavel Labathef409122016-04-07 08:16:10 +00002102 if (bp_site_sp && bp_site_sp->ValidForThisThread(thread_sp.get()))
2103 {
2104 thread_sp->SetStopInfo(
2105 StopInfo::CreateStopReasonWithBreakpointSiteID(*thread_sp, bp_site_sp->GetID()));
Pavel Labath3ce324a2016-04-06 09:10:29 +00002106 handled = true;
Pavel Labathef409122016-04-07 08:16:10 +00002107 }
Pavel Labath3ce324a2016-04-06 09:10:29 +00002108 }
Greg Clayton2e309072015-07-17 23:42:28 +00002109
2110 if (!handled && signo && did_exec == false)
2111 {
2112 if (signo == SIGTRAP)
2113 {
2114 // Currently we are going to assume SIGTRAP means we are either
2115 // hitting a breakpoint or hardware single stepping.
2116 handled = true;
2117 addr_t pc = thread_sp->GetRegisterContext()->GetPC() + m_breakpoint_pc_offset;
2118 lldb::BreakpointSiteSP bp_site_sp = thread_sp->GetProcess()->GetBreakpointSiteList().FindByAddress(pc);
2119
2120 if (bp_site_sp)
2121 {
2122 // If the breakpoint is for this thread, then we'll report the hit, but if it is for another thread,
2123 // we can just report no reason. We don't need to worry about stepping over the breakpoint here, that
2124 // will be taken care of when the thread resumes and notices that there's a breakpoint under the pc.
2125 if (bp_site_sp->ValidForThisThread (thread_sp.get()))
2126 {
2127 if(m_breakpoint_pc_offset != 0)
2128 thread_sp->GetRegisterContext()->SetPC(pc);
2129 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithBreakpointSiteID (*thread_sp, bp_site_sp->GetID()));
2130 }
2131 else
2132 {
2133 StopInfoSP invalid_stop_info_sp;
2134 thread_sp->SetStopInfo (invalid_stop_info_sp);
2135 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002136 }
2137 else
2138 {
Greg Clayton2e309072015-07-17 23:42:28 +00002139 // If we were stepping then assume the stop was the result of the trace. If we were
2140 // not stepping then report the SIGTRAP.
2141 // FIXME: We are still missing the case where we single step over a trap instruction.
2142 if (thread_sp->GetTemporaryResumeState() == eStateStepping)
2143 thread_sp->SetStopInfo (StopInfo::CreateStopReasonToTrace (*thread_sp));
2144 else
2145 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithSignal(*thread_sp, signo, description.c_str()));
Greg Clayton358cf1e2015-06-25 21:46:34 +00002146 }
2147 }
Greg Clayton2e309072015-07-17 23:42:28 +00002148 if (!handled)
2149 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithSignal (*thread_sp, signo, description.c_str()));
2150 }
2151
2152 if (!description.empty())
2153 {
2154 lldb::StopInfoSP stop_info_sp (thread_sp->GetStopInfo ());
2155 if (stop_info_sp)
2156 {
2157 const char *stop_info_desc = stop_info_sp->GetDescription();
2158 if (!stop_info_desc || !stop_info_desc[0])
2159 stop_info_sp->SetDescription (description.c_str());
2160 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002161 else
2162 {
Greg Clayton2e309072015-07-17 23:42:28 +00002163 thread_sp->SetStopInfo (StopInfo::CreateStopReasonWithException (*thread_sp, description.c_str()));
Greg Clayton358cf1e2015-06-25 21:46:34 +00002164 }
2165 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002166 }
2167 }
2168 }
2169 }
2170 return thread_sp;
2171}
2172
Greg Clayton2e309072015-07-17 23:42:28 +00002173lldb::ThreadSP
Greg Clayton358cf1e2015-06-25 21:46:34 +00002174ProcessGDBRemote::SetThreadStopInfo (StructuredData::Dictionary *thread_dict)
2175{
2176 static ConstString g_key_tid("tid");
2177 static ConstString g_key_name("name");
2178 static ConstString g_key_reason("reason");
2179 static ConstString g_key_metype("metype");
2180 static ConstString g_key_medata("medata");
2181 static ConstString g_key_qaddr("qaddr");
Jason Molenda77f89352016-01-12 07:09:16 +00002182 static ConstString g_key_dispatch_queue_t("dispatch_queue_t");
2183 static ConstString g_key_associated_with_dispatch_queue("associated_with_dispatch_queue");
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002184 static ConstString g_key_queue_name("qname");
2185 static ConstString g_key_queue_kind("qkind");
Jason Molenda26d84e82016-01-08 00:20:48 +00002186 static ConstString g_key_queue_serial_number("qserialnum");
Greg Clayton358cf1e2015-06-25 21:46:34 +00002187 static ConstString g_key_registers("registers");
2188 static ConstString g_key_memory("memory");
2189 static ConstString g_key_address("address");
2190 static ConstString g_key_bytes("bytes");
2191 static ConstString g_key_description("description");
Pavel Labath4a4bb122015-07-16 14:14:35 +00002192 static ConstString g_key_signal("signal");
Greg Clayton358cf1e2015-06-25 21:46:34 +00002193
2194 // Stop with signal and thread info
2195 lldb::tid_t tid = LLDB_INVALID_THREAD_ID;
2196 uint8_t signo = 0;
2197 std::string value;
2198 std::string thread_name;
2199 std::string reason;
2200 std::string description;
2201 uint32_t exc_type = 0;
2202 std::vector<addr_t> exc_data;
2203 addr_t thread_dispatch_qaddr = LLDB_INVALID_ADDRESS;
2204 ExpeditedRegisterMap expedited_register_map;
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002205 bool queue_vars_valid = false;
Jason Molenda77f89352016-01-12 07:09:16 +00002206 addr_t dispatch_queue_t = LLDB_INVALID_ADDRESS;
2207 LazyBool associated_with_dispatch_queue = eLazyBoolCalculate;
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002208 std::string queue_name;
2209 QueueKind queue_kind = eQueueKindUnknown;
Jason Molenda26d84e82016-01-08 00:20:48 +00002210 uint64_t queue_serial_number = 0;
Greg Clayton358cf1e2015-06-25 21:46:34 +00002211 // Iterate through all of the thread dictionary key/value pairs from the structured data dictionary
2212
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002213 thread_dict->ForEach([this,
2214 &tid,
2215 &expedited_register_map,
2216 &thread_name,
2217 &signo,
2218 &reason,
2219 &description,
2220 &exc_type,
2221 &exc_data,
2222 &thread_dispatch_qaddr,
2223 &queue_vars_valid,
Jason Molenda77f89352016-01-12 07:09:16 +00002224 &associated_with_dispatch_queue,
2225 &dispatch_queue_t,
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002226 &queue_name,
2227 &queue_kind,
Jason Molenda26d84e82016-01-08 00:20:48 +00002228 &queue_serial_number]
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002229 (ConstString key, StructuredData::Object* object) -> bool
Greg Clayton358cf1e2015-06-25 21:46:34 +00002230 {
2231 if (key == g_key_tid)
2232 {
2233 // thread in big endian hex
2234 tid = object->GetIntegerValue(LLDB_INVALID_THREAD_ID);
2235 }
2236 else if (key == g_key_metype)
2237 {
2238 // exception type in big endian hex
2239 exc_type = object->GetIntegerValue(0);
2240 }
2241 else if (key == g_key_medata)
2242 {
2243 // exception data in big endian hex
2244 StructuredData::Array *array = object->GetAsArray();
2245 if (array)
2246 {
2247 array->ForEach([&exc_data](StructuredData::Object* object) -> bool {
2248 exc_data.push_back(object->GetIntegerValue());
2249 return true; // Keep iterating through all array items
2250 });
2251 }
2252 }
2253 else if (key == g_key_name)
2254 {
Pavel Labath3a29f8b2015-07-28 09:18:32 +00002255 thread_name = object->GetStringValue();
Greg Clayton358cf1e2015-06-25 21:46:34 +00002256 }
2257 else if (key == g_key_qaddr)
2258 {
2259 thread_dispatch_qaddr = object->GetIntegerValue(LLDB_INVALID_ADDRESS);
2260 }
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002261 else if (key == g_key_queue_name)
2262 {
2263 queue_vars_valid = true;
Pavel Labath3a29f8b2015-07-28 09:18:32 +00002264 queue_name = object->GetStringValue();
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002265 }
2266 else if (key == g_key_queue_kind)
2267 {
2268 std::string queue_kind_str = object->GetStringValue();
2269 if (queue_kind_str == "serial")
2270 {
2271 queue_vars_valid = true;
2272 queue_kind = eQueueKindSerial;
2273 }
2274 else if (queue_kind_str == "concurrent")
2275 {
2276 queue_vars_valid = true;
2277 queue_kind = eQueueKindConcurrent;
2278 }
2279 }
Jason Molenda26d84e82016-01-08 00:20:48 +00002280 else if (key == g_key_queue_serial_number)
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002281 {
Jason Molenda26d84e82016-01-08 00:20:48 +00002282 queue_serial_number = object->GetIntegerValue(0);
2283 if (queue_serial_number != 0)
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002284 queue_vars_valid = true;
2285 }
Jason Molenda77f89352016-01-12 07:09:16 +00002286 else if (key == g_key_dispatch_queue_t)
2287 {
2288 dispatch_queue_t = object->GetIntegerValue(0);
2289 if (dispatch_queue_t != 0 && dispatch_queue_t != LLDB_INVALID_ADDRESS)
2290 queue_vars_valid = true;
2291 }
2292 else if (key == g_key_associated_with_dispatch_queue)
2293 {
2294 queue_vars_valid = true;
2295 bool associated = object->GetBooleanValue ();
2296 if (associated)
2297 associated_with_dispatch_queue = eLazyBoolYes;
2298 else
2299 associated_with_dispatch_queue = eLazyBoolNo;
2300 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002301 else if (key == g_key_reason)
2302 {
Pavel Labath3a29f8b2015-07-28 09:18:32 +00002303 reason = object->GetStringValue();
Greg Clayton358cf1e2015-06-25 21:46:34 +00002304 }
2305 else if (key == g_key_description)
2306 {
Pavel Labath3a29f8b2015-07-28 09:18:32 +00002307 description = object->GetStringValue();
Greg Clayton358cf1e2015-06-25 21:46:34 +00002308 }
2309 else if (key == g_key_registers)
2310 {
2311 StructuredData::Dictionary *registers_dict = object->GetAsDictionary();
2312
2313 if (registers_dict)
2314 {
2315 registers_dict->ForEach([&expedited_register_map](ConstString key, StructuredData::Object* object) -> bool {
2316 const uint32_t reg = StringConvert::ToUInt32 (key.GetCString(), UINT32_MAX, 10);
2317 if (reg != UINT32_MAX)
Pavel Labath3a29f8b2015-07-28 09:18:32 +00002318 expedited_register_map[reg] = object->GetStringValue();
Greg Clayton358cf1e2015-06-25 21:46:34 +00002319 return true; // Keep iterating through all array items
2320 });
2321 }
2322 }
2323 else if (key == g_key_memory)
2324 {
2325 StructuredData::Array *array = object->GetAsArray();
2326 if (array)
2327 {
2328 array->ForEach([this](StructuredData::Object* object) -> bool {
2329 StructuredData::Dictionary *mem_cache_dict = object->GetAsDictionary();
2330 if (mem_cache_dict)
2331 {
2332 lldb::addr_t mem_cache_addr = LLDB_INVALID_ADDRESS;
2333 if (mem_cache_dict->GetValueForKeyAsInteger<lldb::addr_t>("address", mem_cache_addr))
2334 {
2335 if (mem_cache_addr != LLDB_INVALID_ADDRESS)
2336 {
2337 StringExtractor bytes;
2338 if (mem_cache_dict->GetValueForKeyAsString("bytes", bytes.GetStringRef()))
2339 {
2340 bytes.SetFilePos(0);
2341
2342 const size_t byte_size = bytes.GetStringRef().size()/2;
2343 DataBufferSP data_buffer_sp(new DataBufferHeap(byte_size, 0));
2344 const size_t bytes_copied = bytes.GetHexBytes (data_buffer_sp->GetBytes(), byte_size, 0);
2345 if (bytes_copied == byte_size)
2346 m_memory_cache.AddL1CacheData(mem_cache_addr, data_buffer_sp);
2347 }
2348 }
2349 }
2350 }
2351 return true; // Keep iterating through all array items
2352 });
2353 }
Eugene Zelenko0722f082015-10-24 01:28:05 +00002354
Greg Clayton358cf1e2015-06-25 21:46:34 +00002355 }
Pavel Labath4a4bb122015-07-16 14:14:35 +00002356 else if (key == g_key_signal)
2357 signo = object->GetIntegerValue(LLDB_INVALID_SIGNAL_NUMBER);
Greg Clayton358cf1e2015-06-25 21:46:34 +00002358 return true; // Keep iterating through all dictionary key/value pairs
2359 });
2360
Greg Clayton2e309072015-07-17 23:42:28 +00002361 return SetThreadStopInfo (tid,
2362 expedited_register_map,
2363 signo,
2364 thread_name,
2365 reason,
2366 description,
2367 exc_type,
2368 exc_data,
2369 thread_dispatch_qaddr,
2370 queue_vars_valid,
Jason Molenda77f89352016-01-12 07:09:16 +00002371 associated_with_dispatch_queue,
2372 dispatch_queue_t,
Greg Clayton2e309072015-07-17 23:42:28 +00002373 queue_name,
2374 queue_kind,
Jason Molenda26d84e82016-01-08 00:20:48 +00002375 queue_serial_number);
Greg Clayton358cf1e2015-06-25 21:46:34 +00002376}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002377
2378StateType
2379ProcessGDBRemote::SetThreadStopInfo (StringExtractor& stop_packet)
2380{
Greg Claytondd0e5a52011-06-02 22:22:38 +00002381 stop_packet.SetFilePos (0);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002382 const char stop_type = stop_packet.GetChar();
2383 switch (stop_type)
2384 {
2385 case 'T':
2386 case 'S':
2387 {
Greg Clayton15fc2be2013-05-21 01:00:52 +00002388 // This is a bit of a hack, but is is required. If we did exec, we
2389 // need to clear our thread lists and also know to rebuild our dynamic
2390 // register info before we lookup and threads and populate the expedited
2391 // register values so we need to know this right away so we can cleanup
2392 // and update our registers.
Greg Clayton8cda7f02013-05-21 21:55:59 +00002393 const uint32_t stop_id = GetStopID();
2394 if (stop_id == 0)
Greg Claytone576ab22011-02-15 00:19:15 +00002395 {
2396 // Our first stop, make sure we have a process ID, and also make
2397 // sure we know about our registers
2398 if (GetID() == LLDB_INVALID_PROCESS_ID)
2399 {
Greg Claytonc574ede2011-03-10 02:26:48 +00002400 lldb::pid_t pid = m_gdb_comm.GetCurrentProcessID ();
Greg Claytone576ab22011-02-15 00:19:15 +00002401 if (pid != LLDB_INVALID_PROCESS_ID)
2402 SetID (pid);
2403 }
2404 BuildDynamicRegisterInfo (true);
2405 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002406 // Stop with signal and thread info
Greg Clayton358cf1e2015-06-25 21:46:34 +00002407 lldb::tid_t tid = LLDB_INVALID_THREAD_ID;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002408 const uint8_t signo = stop_packet.GetHexU8();
Greg Clayton358cf1e2015-06-25 21:46:34 +00002409 std::string key;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002410 std::string value;
2411 std::string thread_name;
Greg Claytona658fd22011-06-04 01:26:29 +00002412 std::string reason;
2413 std::string description;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002414 uint32_t exc_type = 0;
Greg Clayton896dff62010-07-23 16:45:51 +00002415 std::vector<addr_t> exc_data;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002416 addr_t thread_dispatch_qaddr = LLDB_INVALID_ADDRESS;
Greg Clayton0b90be12015-06-23 21:27:50 +00002417 bool queue_vars_valid = false; // says if locals below that start with "queue_" are valid
Jason Molenda77f89352016-01-12 07:09:16 +00002418 addr_t dispatch_queue_t = LLDB_INVALID_ADDRESS;
2419 LazyBool associated_with_dispatch_queue = eLazyBoolCalculate;
Greg Clayton0b90be12015-06-23 21:27:50 +00002420 std::string queue_name;
2421 QueueKind queue_kind = eQueueKindUnknown;
Jason Molenda26d84e82016-01-08 00:20:48 +00002422 uint64_t queue_serial_number = 0;
Greg Clayton358cf1e2015-06-25 21:46:34 +00002423 ExpeditedRegisterMap expedited_register_map;
2424 while (stop_packet.GetNameColonValue(key, value))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002425 {
Greg Clayton358cf1e2015-06-25 21:46:34 +00002426 if (key.compare("metype") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002427 {
2428 // exception type in big endian hex
Vince Harron5275aaa2015-01-15 20:08:35 +00002429 exc_type = StringConvert::ToUInt32 (value.c_str(), 0, 16);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002430 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002431 else if (key.compare("medata") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002432 {
2433 // exception data in big endian hex
Vince Harron5275aaa2015-01-15 20:08:35 +00002434 exc_data.push_back(StringConvert::ToUInt64 (value.c_str(), 0, 16));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002435 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002436 else if (key.compare("thread") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002437 {
2438 // thread in big endian hex
Greg Clayton358cf1e2015-06-25 21:46:34 +00002439 tid = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_THREAD_ID, 16);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002440 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002441 else if (key.compare("threads") == 0)
Greg Clayton9e920902012-04-10 02:25:43 +00002442 {
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00002443 std::lock_guard<std::recursive_mutex> guard(m_thread_list_real.GetMutex());
2444
Greg Clayton9e920902012-04-10 02:25:43 +00002445 m_thread_ids.clear();
Greg Clayton44633992012-04-10 03:22:03 +00002446 // A comma separated list of all threads in the current
2447 // process that includes the thread for this stop reply
2448 // packet
Greg Clayton9e920902012-04-10 02:25:43 +00002449 size_t comma_pos;
2450 lldb::tid_t tid;
2451 while ((comma_pos = value.find(',')) != std::string::npos)
2452 {
2453 value[comma_pos] = '\0';
2454 // thread in big endian hex
Vince Harron5275aaa2015-01-15 20:08:35 +00002455 tid = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_THREAD_ID, 16);
Greg Clayton9e920902012-04-10 02:25:43 +00002456 if (tid != LLDB_INVALID_THREAD_ID)
2457 m_thread_ids.push_back (tid);
2458 value.erase(0, comma_pos + 1);
Greg Clayton9e920902012-04-10 02:25:43 +00002459 }
Vince Harron5275aaa2015-01-15 20:08:35 +00002460 tid = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_THREAD_ID, 16);
Greg Clayton9e920902012-04-10 02:25:43 +00002461 if (tid != LLDB_INVALID_THREAD_ID)
2462 m_thread_ids.push_back (tid);
2463 }
Jason Molenda545304d2015-12-18 00:45:35 +00002464 else if (key.compare("thread-pcs") == 0)
2465 {
2466 m_thread_pcs.clear();
2467 // A comma separated list of all threads in the current
2468 // process that includes the thread for this stop reply
2469 // packet
2470 size_t comma_pos;
2471 lldb::addr_t pc;
2472 while ((comma_pos = value.find(',')) != std::string::npos)
2473 {
2474 value[comma_pos] = '\0';
2475 // thread in big endian hex
2476 pc = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_ADDRESS, 16);
2477 if (pc != LLDB_INVALID_ADDRESS)
2478 m_thread_pcs.push_back (pc);
2479 value.erase(0, comma_pos + 1);
2480 }
2481 pc = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_ADDRESS, 16);
2482 if (pc != LLDB_INVALID_ADDRESS)
2483 m_thread_pcs.push_back (pc);
2484 }
Greg Clayton2e309072015-07-17 23:42:28 +00002485 else if (key.compare("jstopinfo") == 0)
Greg Claytona5801ad2015-07-15 22:59:03 +00002486 {
2487 StringExtractor json_extractor;
2488 // Swap "value" over into "name_extractor"
2489 json_extractor.GetStringRef().swap(value);
2490 // Now convert the HEX bytes into a string value
2491 json_extractor.GetHexByteString (value);
2492
2493 // This JSON contains thread IDs and thread stop info for all threads.
2494 // It doesn't contain expedited registers, memory or queue info.
Greg Clayton2e309072015-07-17 23:42:28 +00002495 m_jstopinfo_sp = StructuredData::ParseJSON (value);
Greg Claytona5801ad2015-07-15 22:59:03 +00002496 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002497 else if (key.compare("hexname") == 0)
Greg Claytonde9d0492011-01-08 03:17:57 +00002498 {
2499 StringExtractor name_extractor;
2500 // Swap "value" over into "name_extractor"
2501 name_extractor.GetStringRef().swap(value);
2502 // Now convert the HEX bytes into a string value
2503 name_extractor.GetHexByteString (value);
2504 thread_name.swap (value);
2505 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002506 else if (key.compare("name") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002507 {
2508 thread_name.swap (value);
2509 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002510 else if (key.compare("qaddr") == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002511 {
Vince Harron5275aaa2015-01-15 20:08:35 +00002512 thread_dispatch_qaddr = StringConvert::ToUInt64 (value.c_str(), 0, 16);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002513 }
Jason Molenda77f89352016-01-12 07:09:16 +00002514 else if (key.compare("dispatch_queue_t") == 0)
2515 {
2516 queue_vars_valid = true;
2517 dispatch_queue_t = StringConvert::ToUInt64 (value.c_str(), 0, 16);
2518 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002519 else if (key.compare("qname") == 0)
Greg Clayton0b90be12015-06-23 21:27:50 +00002520 {
2521 queue_vars_valid = true;
2522 StringExtractor name_extractor;
2523 // Swap "value" over into "name_extractor"
2524 name_extractor.GetStringRef().swap(value);
2525 // Now convert the HEX bytes into a string value
2526 name_extractor.GetHexByteString (value);
2527 queue_name.swap (value);
2528 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002529 else if (key.compare("qkind") == 0)
Greg Clayton0b90be12015-06-23 21:27:50 +00002530 {
Greg Clayton0b90be12015-06-23 21:27:50 +00002531 if (value == "serial")
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002532 {
2533 queue_vars_valid = true;
Greg Clayton0b90be12015-06-23 21:27:50 +00002534 queue_kind = eQueueKindSerial;
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002535 }
Greg Clayton0b90be12015-06-23 21:27:50 +00002536 else if (value == "concurrent")
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002537 {
2538 queue_vars_valid = true;
Greg Clayton0b90be12015-06-23 21:27:50 +00002539 queue_kind = eQueueKindConcurrent;
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002540 }
Greg Clayton0b90be12015-06-23 21:27:50 +00002541 }
Jason Molenda26d84e82016-01-08 00:20:48 +00002542 else if (key.compare("qserialnum") == 0)
Greg Clayton0b90be12015-06-23 21:27:50 +00002543 {
Jason Molenda26d84e82016-01-08 00:20:48 +00002544 queue_serial_number = StringConvert::ToUInt64 (value.c_str(), 0, 0);
2545 if (queue_serial_number != 0)
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002546 queue_vars_valid = true;
Greg Clayton0b90be12015-06-23 21:27:50 +00002547 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002548 else if (key.compare("reason") == 0)
Greg Claytona658fd22011-06-04 01:26:29 +00002549 {
2550 reason.swap(value);
2551 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002552 else if (key.compare("description") == 0)
Greg Claytona658fd22011-06-04 01:26:29 +00002553 {
2554 StringExtractor desc_extractor;
2555 // Swap "value" over into "name_extractor"
2556 desc_extractor.GetStringRef().swap(value);
2557 // Now convert the HEX bytes into a string value
Chaoren Lin28e57422015-02-03 01:51:25 +00002558 desc_extractor.GetHexByteString (value);
2559 description.swap(value);
Greg Claytona658fd22011-06-04 01:26:29 +00002560 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002561 else if (key.compare("memory") == 0)
Greg Clayton3e06bd92011-01-09 21:07:35 +00002562 {
Greg Clayton358cf1e2015-06-25 21:46:34 +00002563 // Expedited memory. GDB servers can choose to send back expedited memory
2564 // that can populate the L1 memory cache in the process so that things like
2565 // the frame pointer backchain can be expedited. This will help stack
2566 // backtracing be more efficient by not having to send as many memory read
2567 // requests down the remote GDB server.
Chaoren Lin7a306082015-06-23 03:17:01 +00002568
Greg Clayton358cf1e2015-06-25 21:46:34 +00002569 // Key/value pair format: memory:<addr>=<bytes>;
2570 // <addr> is a number whose base will be interpreted by the prefix:
2571 // "0x[0-9a-fA-F]+" for hex
2572 // "0[0-7]+" for octal
2573 // "[1-9]+" for decimal
2574 // <bytes> is native endian ASCII hex bytes just like the register values
2575 llvm::StringRef value_ref(value);
2576 std::pair<llvm::StringRef, llvm::StringRef> pair;
2577 pair = value_ref.split('=');
2578 if (!pair.first.empty() && !pair.second.empty())
2579 {
2580 std::string addr_str(pair.first.str());
2581 const lldb::addr_t mem_cache_addr = StringConvert::ToUInt64(addr_str.c_str(), LLDB_INVALID_ADDRESS, 0);
2582 if (mem_cache_addr != LLDB_INVALID_ADDRESS)
Greg Clayton3e06bd92011-01-09 21:07:35 +00002583 {
Greg Clayton358cf1e2015-06-25 21:46:34 +00002584 StringExtractor bytes;
Pavel Labath3a29f8b2015-07-28 09:18:32 +00002585 bytes.GetStringRef() = pair.second.str();
Greg Clayton358cf1e2015-06-25 21:46:34 +00002586 const size_t byte_size = bytes.GetStringRef().size()/2;
2587 DataBufferSP data_buffer_sp(new DataBufferHeap(byte_size, 0));
2588 const size_t bytes_copied = bytes.GetHexBytes (data_buffer_sp->GetBytes(), byte_size, 0);
2589 if (bytes_copied == byte_size)
2590 m_memory_cache.AddL1CacheData(mem_cache_addr, data_buffer_sp);
Greg Clayton3e06bd92011-01-09 21:07:35 +00002591 }
2592 }
2593 }
Jaydeep Patil725666c2015-08-13 03:46:01 +00002594 else if (key.compare("watch") == 0 || key.compare("rwatch") == 0 || key.compare("awatch") == 0)
2595 {
2596 // Support standard GDB remote stop reply packet 'TAAwatch:addr'
2597 lldb::addr_t wp_addr = StringConvert::ToUInt64 (value.c_str(), LLDB_INVALID_ADDRESS, 16);
2598 WatchpointSP wp_sp = GetTarget().GetWatchpointList().FindByAddress(wp_addr);
2599 uint32_t wp_index = LLDB_INVALID_INDEX32;
2600
2601 if (wp_sp)
2602 wp_index = wp_sp->GetHardwareIndex();
2603
2604 reason = "watchpoint";
2605 StreamString ostr;
2606 ostr.Printf("%" PRIu64 " %" PRIu32, wp_addr, wp_index);
2607 description = ostr.GetString().c_str();
2608 }
Stephane Sezer2618e912015-08-21 16:51:56 +00002609 else if (key.compare("library") == 0)
2610 {
2611 LoadModules();
2612 }
Greg Clayton358cf1e2015-06-25 21:46:34 +00002613 else if (key.size() == 2 && ::isxdigit(key[0]) && ::isxdigit(key[1]))
2614 {
2615 uint32_t reg = StringConvert::ToUInt32 (key.c_str(), UINT32_MAX, 16);
2616 if (reg != UINT32_MAX)
2617 expedited_register_map[reg] = std::move(value);
2618 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002619 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002620
Bhushan D. Attarde1e271df2015-07-24 04:06:20 +00002621 if (tid == LLDB_INVALID_THREAD_ID)
2622 {
Ed Maste81b4c5f2016-01-04 01:43:47 +00002623 // 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 +00002624 // thread information. So update the thread list and choose the first one.
2625 UpdateThreadIDList ();
Ed Maste81b4c5f2016-01-04 01:43:47 +00002626
Bhushan D. Attarde1e271df2015-07-24 04:06:20 +00002627 if (!m_thread_ids.empty ())
2628 {
2629 tid = m_thread_ids.front ();
2630 }
2631 }
2632
Greg Clayton358cf1e2015-06-25 21:46:34 +00002633 ThreadSP thread_sp = SetThreadStopInfo (tid,
2634 expedited_register_map,
2635 signo,
2636 thread_name,
2637 reason,
2638 description,
2639 exc_type,
2640 exc_data,
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002641 thread_dispatch_qaddr,
2642 queue_vars_valid,
Jason Molenda77f89352016-01-12 07:09:16 +00002643 associated_with_dispatch_queue,
2644 dispatch_queue_t,
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002645 queue_name,
2646 queue_kind,
Jason Molenda26d84e82016-01-08 00:20:48 +00002647 queue_serial_number);
Greg Clayton358cf1e2015-06-25 21:46:34 +00002648
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002649 return eStateStopped;
2650 }
2651 break;
2652
2653 case 'W':
Todd Fialaff6131a2014-05-19 04:57:23 +00002654 case 'X':
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002655 // process exited
2656 return eStateExited;
2657
2658 default:
2659 break;
2660 }
2661 return eStateInvalid;
2662}
2663
2664void
2665ProcessGDBRemote::RefreshStateAfterStop ()
2666{
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00002667 std::lock_guard<std::recursive_mutex> guard(m_thread_list_real.GetMutex());
2668
Greg Clayton9e920902012-04-10 02:25:43 +00002669 m_thread_ids.clear();
Jason Molenda545304d2015-12-18 00:45:35 +00002670 m_thread_pcs.clear();
Greg Clayton9e920902012-04-10 02:25:43 +00002671 // Set the thread stop info. It might have a "threads" key whose value is
2672 // a list of all thread IDs in the current process, so m_thread_ids might
2673 // get set.
Ewan Crawford9aa2da002015-05-27 14:12:34 +00002674
2675 // Scope for the lock
2676 {
2677 // Lock the thread stack while we access it
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +00002678 std::lock_guard<std::recursive_mutex> guard(m_last_stop_packet_mutex);
Ewan Crawford9aa2da002015-05-27 14:12:34 +00002679 // Get the number of stop packets on the stack
2680 int nItems = m_stop_packet_stack.size();
2681 // Iterate over them
2682 for (int i = 0; i < nItems; i++)
2683 {
2684 // Get the thread stop info
2685 StringExtractorGDBRemote stop_info = m_stop_packet_stack[i];
2686 // Process thread stop info
2687 SetThreadStopInfo(stop_info);
2688 }
2689 // Clear the thread stop stack
2690 m_stop_packet_stack.clear();
2691 }
2692
Greg Clayton9e920902012-04-10 02:25:43 +00002693 // Check to see if SetThreadStopInfo() filled in m_thread_ids?
2694 if (m_thread_ids.empty())
2695 {
2696 // No, we need to fetch the thread list manually
2697 UpdateThreadIDList();
2698 }
2699
Ewan Crawford78baa192015-05-13 09:18:18 +00002700 // If we have queried for a default thread id
2701 if (m_initial_tid != LLDB_INVALID_THREAD_ID)
2702 {
2703 m_thread_list.SetSelectedThreadByID(m_initial_tid);
2704 m_initial_tid = LLDB_INVALID_THREAD_ID;
2705 }
2706
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002707 // Let all threads recover from stopping and do any clean up based
2708 // on the previous thread state (if any).
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00002709 m_thread_list_real.RefreshStateAfterStop();
Ed Maste81b4c5f2016-01-04 01:43:47 +00002710
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002711}
2712
2713Error
Jim Ingham0d8bcc72010-11-17 02:32:00 +00002714ProcessGDBRemote::DoHalt (bool &caused_stop)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002715{
2716 Error error;
Jim Ingham0d8bcc72010-11-17 02:32:00 +00002717
Greg Clayton6ed95942011-01-22 07:12:45 +00002718 bool timed_out = false;
2719 Mutex::Locker locker;
Ed Maste81b4c5f2016-01-04 01:43:47 +00002720
Greg Clayton513c26c2011-01-29 07:10:55 +00002721 if (m_public_state.GetValue() == eStateAttaching)
Greg Clayton3af9ea52010-11-18 05:57:03 +00002722 {
Greg Clayton513c26c2011-01-29 07:10:55 +00002723 // We are being asked to halt during an attach. We need to just close
2724 // our file handle and debugserver will go away, and we can be done...
2725 m_gdb_comm.Disconnect();
Greg Clayton3af9ea52010-11-18 05:57:03 +00002726 }
Greg Clayton513c26c2011-01-29 07:10:55 +00002727 else
2728 {
Greg Clayton2687cd12012-03-29 01:55:41 +00002729 if (!m_gdb_comm.SendInterrupt (locker, 2, timed_out))
Greg Clayton513c26c2011-01-29 07:10:55 +00002730 {
2731 if (timed_out)
2732 error.SetErrorString("timed out sending interrupt packet");
2733 else
2734 error.SetErrorString("unknown error sending interrupt packet");
2735 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00002736
Greg Clayton2687cd12012-03-29 01:55:41 +00002737 caused_stop = m_gdb_comm.GetInterruptWasSent ();
Greg Clayton513c26c2011-01-29 07:10:55 +00002738 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002739 return error;
2740}
2741
2742Error
Jim Inghamacff8952013-05-02 00:27:30 +00002743ProcessGDBRemote::DoDetach(bool keep_stopped)
Greg Clayton594e5ed2010-09-27 21:07:38 +00002744{
2745 Error error;
Greg Clayton5160ce52013-03-27 23:08:40 +00002746 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Greg Clayton594e5ed2010-09-27 21:07:38 +00002747 if (log)
Jim Inghamacff8952013-05-02 00:27:30 +00002748 log->Printf ("ProcessGDBRemote::DoDetach(keep_stopped: %i)", keep_stopped);
Ed Maste81b4c5f2016-01-04 01:43:47 +00002749
Jim Inghamacff8952013-05-02 00:27:30 +00002750 error = m_gdb_comm.Detach (keep_stopped);
Greg Clayton58d1c9a2010-10-18 04:14:23 +00002751 if (log)
Greg Clayton594e5ed2010-09-27 21:07:38 +00002752 {
Jim Inghamacff8952013-05-02 00:27:30 +00002753 if (error.Success())
Greg Clayton58d1c9a2010-10-18 04:14:23 +00002754 log->PutCString ("ProcessGDBRemote::DoDetach() detach packet sent successfully");
2755 else
Jim Inghamacff8952013-05-02 00:27:30 +00002756 log->Printf ("ProcessGDBRemote::DoDetach() detach packet send failed: %s", error.AsCString() ? error.AsCString() : "<unknown error>");
Greg Clayton594e5ed2010-09-27 21:07:38 +00002757 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00002758
Jim Inghamacff8952013-05-02 00:27:30 +00002759 if (!error.Success())
2760 return error;
2761
Greg Clayton58d1c9a2010-10-18 04:14:23 +00002762 // Sleep for one second to let the process get all detached...
Greg Clayton594e5ed2010-09-27 21:07:38 +00002763 StopAsyncThread ();
Greg Clayton58d1c9a2010-10-18 04:14:23 +00002764
Greg Clayton58d1c9a2010-10-18 04:14:23 +00002765 SetPrivateState (eStateDetached);
2766 ResumePrivateStateThread();
2767
2768 //KillDebugserverProcess ();
Greg Clayton594e5ed2010-09-27 21:07:38 +00002769 return error;
2770}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002771
Eugene Zelenko0722f082015-10-24 01:28:05 +00002772
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002773Error
2774ProcessGDBRemote::DoDestroy ()
2775{
2776 Error error;
Greg Clayton5160ce52013-03-27 23:08:40 +00002777 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002778 if (log)
2779 log->Printf ("ProcessGDBRemote::DoDestroy()");
2780
Jim Ingham43c555d2012-07-04 00:35:43 +00002781 // There is a bug in older iOS debugservers where they don't shut down the process
2782 // they are debugging properly. If the process is sitting at a breakpoint or an exception,
2783 // this can cause problems with restarting. So we check to see if any of our threads are stopped
2784 // at a breakpoint, and if so we remove all the breakpoints, resume the process, and THEN
2785 // destroy it again.
2786 //
2787 // Note, we don't have a good way to test the version of debugserver, but I happen to know that
2788 // the set of all the iOS debugservers which don't support GetThreadSuffixSupported() and that of
2789 // the debugservers with this bug are equal. There really should be a better way to test this!
2790 //
2791 // We also use m_destroy_tried_resuming to make sure we only do this once, if we resume and then halt and
2792 // get called here to destroy again and we're still at a breakpoint or exception, then we should
2793 // just do the straight-forward kill.
2794 //
2795 // And of course, if we weren't able to stop the process by the time we get here, it isn't
2796 // necessary (or helpful) to do any of this.
2797
2798 if (!m_gdb_comm.GetThreadSuffixSupported() && m_public_state.GetValue() != eStateRunning)
2799 {
2800 PlatformSP platform_sp = GetTarget().GetPlatform();
Ed Maste81b4c5f2016-01-04 01:43:47 +00002801
Jim Ingham43c555d2012-07-04 00:35:43 +00002802 // FIXME: These should be ConstStrings so we aren't doing strcmp'ing.
2803 if (platform_sp
2804 && platform_sp->GetName()
Greg Clayton57abc5d2013-05-10 21:47:16 +00002805 && platform_sp->GetName() == PlatformRemoteiOS::GetPluginNameStatic())
Jim Ingham43c555d2012-07-04 00:35:43 +00002806 {
2807 if (m_destroy_tried_resuming)
2808 {
2809 if (log)
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00002810 log->PutCString ("ProcessGDBRemote::DoDestroy() - Tried resuming to destroy once already, not doing it again.");
Jim Ingham43c555d2012-07-04 00:35:43 +00002811 }
2812 else
Ed Maste81b4c5f2016-01-04 01:43:47 +00002813 {
Jim Ingham43c555d2012-07-04 00:35:43 +00002814 // At present, the plans are discarded and the breakpoints disabled Process::Destroy,
2815 // but we really need it to happen here and it doesn't matter if we do it twice.
2816 m_thread_list.DiscardThreadPlans();
2817 DisableAllBreakpointSites();
Ed Maste81b4c5f2016-01-04 01:43:47 +00002818
Jim Ingham43c555d2012-07-04 00:35:43 +00002819 bool stop_looks_like_crash = false;
2820 ThreadList &threads = GetThreadList();
Ed Maste81b4c5f2016-01-04 01:43:47 +00002821
Jim Ingham43c555d2012-07-04 00:35:43 +00002822 {
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00002823 std::lock_guard<std::recursive_mutex> guard(threads.GetMutex());
Ed Maste81b4c5f2016-01-04 01:43:47 +00002824
Jim Ingham43c555d2012-07-04 00:35:43 +00002825 size_t num_threads = threads.GetSize();
2826 for (size_t i = 0; i < num_threads; i++)
2827 {
2828 ThreadSP thread_sp = threads.GetThreadAtIndex(i);
Greg Clayton6e0ff1a2013-05-09 01:55:29 +00002829 StopInfoSP stop_info_sp = thread_sp->GetPrivateStopInfo();
Jim Ingham43c555d2012-07-04 00:35:43 +00002830 StopReason reason = eStopReasonInvalid;
2831 if (stop_info_sp)
2832 reason = stop_info_sp->GetStopReason();
2833 if (reason == eStopReasonBreakpoint
2834 || reason == eStopReasonException)
2835 {
2836 if (log)
Greg Clayton160c9d82013-05-01 21:54:04 +00002837 log->Printf ("ProcessGDBRemote::DoDestroy() - thread: 0x%4.4" PRIx64 " stopped with reason: %s.",
2838 thread_sp->GetProtocolID(),
Jim Ingham43c555d2012-07-04 00:35:43 +00002839 stop_info_sp->GetDescription());
2840 stop_looks_like_crash = true;
2841 break;
2842 }
2843 }
2844 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00002845
Jim Ingham43c555d2012-07-04 00:35:43 +00002846 if (stop_looks_like_crash)
2847 {
2848 if (log)
2849 log->PutCString ("ProcessGDBRemote::DoDestroy() - Stopped at a breakpoint, continue and then kill.");
2850 m_destroy_tried_resuming = true;
Ed Maste81b4c5f2016-01-04 01:43:47 +00002851
2852 // 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 +00002853 // before resuming so they won't get into more trouble. Sadly, for the threads stopped with
2854 // the breakpoint or exception, the exception doesn't get cleared if it is suspended, so we do
2855 // have to run the risk of letting those threads proceed a bit.
Ed Maste81b4c5f2016-01-04 01:43:47 +00002856
Jim Ingham43c555d2012-07-04 00:35:43 +00002857 {
Saleem Abdulrasoolbb19a132016-05-19 05:13:57 +00002858 std::lock_guard<std::recursive_mutex> guard(threads.GetMutex());
Ed Maste81b4c5f2016-01-04 01:43:47 +00002859
Jim Ingham43c555d2012-07-04 00:35:43 +00002860 size_t num_threads = threads.GetSize();
2861 for (size_t i = 0; i < num_threads; i++)
2862 {
2863 ThreadSP thread_sp = threads.GetThreadAtIndex(i);
Greg Clayton6e0ff1a2013-05-09 01:55:29 +00002864 StopInfoSP stop_info_sp = thread_sp->GetPrivateStopInfo();
Jim Ingham43c555d2012-07-04 00:35:43 +00002865 StopReason reason = eStopReasonInvalid;
2866 if (stop_info_sp)
2867 reason = stop_info_sp->GetStopReason();
2868 if (reason != eStopReasonBreakpoint
2869 && reason != eStopReasonException)
2870 {
2871 if (log)
Greg Clayton160c9d82013-05-01 21:54:04 +00002872 log->Printf ("ProcessGDBRemote::DoDestroy() - Suspending thread: 0x%4.4" PRIx64 " before running.",
2873 thread_sp->GetProtocolID());
Jim Ingham43c555d2012-07-04 00:35:43 +00002874 thread_sp->SetResumeState(eStateSuspended);
2875 }
2876 }
2877 }
2878 Resume ();
Jason Molendaede31932015-04-17 05:01:58 +00002879 return Destroy(false);
Jim Ingham43c555d2012-07-04 00:35:43 +00002880 }
2881 }
2882 }
2883 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00002884
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002885 // Interrupt if our inferior is running...
Jim Inghambabfc382012-06-06 00:32:39 +00002886 int exit_status = SIGABRT;
2887 std::string exit_string;
2888
Greg Clayton6ed95942011-01-22 07:12:45 +00002889 if (m_gdb_comm.IsConnected())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002890 {
Jim Inghamaab78372011-10-28 01:11:35 +00002891 if (m_public_state.GetValue() != eStateAttaching)
Greg Clayton6779606a2011-01-22 23:43:18 +00002892 {
Greg Clayton513c26c2011-01-29 07:10:55 +00002893 StringExtractorGDBRemote response;
2894 bool send_async = true;
Tamas Berghammer912800c2015-02-24 10:23:39 +00002895 GDBRemoteCommunication::ScopedTimeout (m_gdb_comm, 3);
Filipe Cabecinhas9e106052012-08-22 13:25:58 +00002896
Greg Clayton3dedae12013-12-06 21:45:27 +00002897 if (m_gdb_comm.SendPacketAndWaitForResponse("k", 1, response, send_async) == GDBRemoteCommunication::PacketResult::Success)
Greg Clayton513c26c2011-01-29 07:10:55 +00002898 {
2899 char packet_cmd = response.GetChar(0);
2900
2901 if (packet_cmd == 'W' || packet_cmd == 'X')
2902 {
Jim Inghameac0aa42014-02-21 22:36:11 +00002903#if defined(__APPLE__)
Jim Ingham9d67cc52014-02-21 22:35:29 +00002904 // For Native processes on Mac OS X, we launch through the Host Platform, then hand the process off
2905 // to debugserver, which becomes the parent process through "PT_ATTACH". Then when we go to kill
2906 // the process on Mac OS X we call ptrace(PT_KILL) to kill it, then we call waitpid which returns
2907 // with no error and the correct status. But amusingly enough that doesn't seem to actually reap
2908 // the process, but instead it is left around as a Zombie. Probably the kernel is in the process of
2909 // switching ownership back to lldb which was the original parent, and gets confused in the handoff.
2910 // Anyway, so call waitpid here to finally reap it.
2911 PlatformSP platform_sp(GetTarget().GetPlatform());
2912 if (platform_sp && platform_sp->IsHost())
2913 {
2914 int status;
2915 ::pid_t reap_pid;
2916 reap_pid = waitpid (GetID(), &status, WNOHANG);
2917 if (log)
2918 log->Printf ("Reaped pid: %d, status: %d.\n", reap_pid, status);
2919 }
2920#endif
Greg Clayton09c3e3d2011-12-06 04:51:14 +00002921 SetLastStopPacket (response);
Greg Clayton9e920902012-04-10 02:25:43 +00002922 ClearThreadIDList ();
Jim Inghambabfc382012-06-06 00:32:39 +00002923 exit_status = response.GetHexU8();
2924 }
2925 else
2926 {
2927 if (log)
2928 log->Printf ("ProcessGDBRemote::DoDestroy - got unexpected response to k packet: %s", response.GetStringRef().c_str());
2929 exit_string.assign("got unexpected response to k packet: ");
2930 exit_string.append(response.GetStringRef());
Greg Clayton513c26c2011-01-29 07:10:55 +00002931 }
2932 }
2933 else
2934 {
Jim Inghambabfc382012-06-06 00:32:39 +00002935 if (log)
2936 log->Printf ("ProcessGDBRemote::DoDestroy - failed to send k packet");
2937 exit_string.assign("failed to send the k packet");
Greg Clayton513c26c2011-01-29 07:10:55 +00002938 }
Greg Clayton6779606a2011-01-22 23:43:18 +00002939 }
Jim Inghambabfc382012-06-06 00:32:39 +00002940 else
2941 {
2942 if (log)
Ed Masteb3a53332014-03-17 17:05:22 +00002943 log->Printf ("ProcessGDBRemote::DoDestroy - killed or interrupted while attaching");
Jim Inghamcfc09352012-07-27 23:57:19 +00002944 exit_string.assign ("killed or interrupted while attaching.");
Jim Inghambabfc382012-06-06 00:32:39 +00002945 }
Greg Clayton6779606a2011-01-22 23:43:18 +00002946 }
Jim Inghambabfc382012-06-06 00:32:39 +00002947 else
2948 {
2949 // If we missed setting the exit status on the way out, do it here.
2950 // NB set exit status can be called multiple times, the first one sets the status.
2951 exit_string.assign("destroying when not connected to debugserver");
2952 }
2953
2954 SetExitStatus(exit_status, exit_string.c_str());
2955
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002956 StopAsyncThread ();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002957 KillDebugserverProcess ();
2958 return error;
2959}
2960
Greg Clayton8cda7f02013-05-21 21:55:59 +00002961void
2962ProcessGDBRemote::SetLastStopPacket (const StringExtractorGDBRemote &response)
2963{
Greg Clayton8cda7f02013-05-21 21:55:59 +00002964 const bool did_exec = response.GetStringRef().find(";reason:exec;") != std::string::npos;
2965 if (did_exec)
2966 {
2967 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
2968 if (log)
2969 log->Printf ("ProcessGDBRemote::SetLastStopPacket () - detected exec");
2970
2971 m_thread_list_real.Clear();
2972 m_thread_list.Clear();
2973 BuildDynamicRegisterInfo (true);
Greg Clayton2e59d4f2015-06-29 20:08:51 +00002974 m_gdb_comm.ResetDiscoverableSettings (did_exec);
Greg Clayton8cda7f02013-05-21 21:55:59 +00002975 }
Ewan Crawford9aa2da002015-05-27 14:12:34 +00002976
2977 // Scope the lock
2978 {
2979 // Lock the thread stack while we access it
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +00002980 std::lock_guard<std::recursive_mutex> guard(m_last_stop_packet_mutex);
Greg Clayton2e309072015-07-17 23:42:28 +00002981
2982 // We are are not using non-stop mode, there can only be one last stop
2983 // reply packet, so clear the list.
2984 if (GetTarget().GetNonStopModeEnabled() == false)
2985 m_stop_packet_stack.clear();
2986
Ewan Crawford9aa2da002015-05-27 14:12:34 +00002987 // Add this stop packet to the stop packet stack
2988 // This stack will get popped and examined when we switch to the
2989 // Stopped state
2990 m_stop_packet_stack.push_back(response);
2991 }
Greg Clayton8cda7f02013-05-21 21:55:59 +00002992}
2993
Chaoren Linc963a222015-09-01 16:58:45 +00002994void
2995ProcessGDBRemote::SetUnixSignals(const UnixSignalsSP &signals_sp)
2996{
2997 Process::SetUnixSignals(std::make_shared<GDBRemoteSignals>(signals_sp));
2998}
2999
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003000//------------------------------------------------------------------
3001// Process Queries
3002//------------------------------------------------------------------
3003
3004bool
3005ProcessGDBRemote::IsAlive ()
3006{
Jason Molenda1d3b3562015-11-05 23:54:29 +00003007 return m_gdb_comm.IsConnected() && Process::IsAlive();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003008}
3009
3010addr_t
3011ProcessGDBRemote::GetImageInfoAddress()
3012{
Aidan Doddsc0c83852015-05-08 09:36:31 +00003013 // request the link map address via the $qShlibInfoAddr packet
3014 lldb::addr_t addr = m_gdb_comm.GetShlibInfoAddr();
3015
3016 // the loaded module list can also provides a link map address
3017 if (addr == LLDB_INVALID_ADDRESS)
3018 {
Stephane Sezer87b0fe02016-01-12 19:02:41 +00003019 LoadedModuleInfoList list;
Aidan Doddsc0c83852015-05-08 09:36:31 +00003020 if (GetLoadedModuleList (list).Success())
3021 addr = list.m_link_map;
3022 }
3023
3024 return addr;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003025}
3026
Greg Clayton2e309072015-07-17 23:42:28 +00003027void
3028ProcessGDBRemote::WillPublicStop ()
3029{
3030 // See if the GDB remote client supports the JSON threads info.
3031 // If so, we gather stop info for all threads, expedited registers,
3032 // expedited memory, runtime queue information (iOS and MacOSX only),
3033 // and more. Expediting memory will help stack backtracing be much
3034 // faster. Expediting registers will make sure we don't have to read
3035 // the thread registers for GPRs.
3036 m_jthreadsinfo_sp = m_gdb_comm.GetThreadsInfo();
3037
3038 if (m_jthreadsinfo_sp)
3039 {
3040 // Now set the stop info for each thread and also expedite any registers
3041 // and memory that was in the jThreadsInfo response.
3042 StructuredData::Array *thread_infos = m_jthreadsinfo_sp->GetAsArray();
3043 if (thread_infos)
3044 {
3045 const size_t n = thread_infos->GetSize();
3046 for (size_t i=0; i<n; ++i)
3047 {
3048 StructuredData::Dictionary *thread_dict = thread_infos->GetItemAtIndex(i)->GetAsDictionary();
3049 if (thread_dict)
3050 SetThreadStopInfo(thread_dict);
3051 }
3052 }
3053 }
3054}
3055
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003056//------------------------------------------------------------------
3057// Process Memory
3058//------------------------------------------------------------------
3059size_t
3060ProcessGDBRemote::DoReadMemory (addr_t addr, void *buf, size_t size, Error &error)
3061{
Jason Molenda6076bf42014-05-06 04:34:52 +00003062 GetMaxMemorySize ();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003063 if (size > m_max_memory_size)
3064 {
3065 // Keep memory read sizes down to a sane limit. This function will be
Ed Maste81b4c5f2016-01-04 01:43:47 +00003066 // called multiple times in order to complete the task by
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003067 // lldb_private::Process so it is ok to do this.
3068 size = m_max_memory_size;
3069 }
3070
3071 char packet[64];
Jason Molenda6076bf42014-05-06 04:34:52 +00003072 int packet_len;
3073 bool binary_memory_read = m_gdb_comm.GetxPacketSupported();
Pavel Labath3bf11252015-10-14 12:59:37 +00003074 packet_len = ::snprintf(packet, sizeof(packet), "%c%" PRIx64 ",%" PRIx64,
3075 binary_memory_read ? 'x' : 'm', (uint64_t)addr, (uint64_t)size);
Andy Gibbsa297a972013-06-19 19:04:53 +00003076 assert (packet_len + 1 < (int)sizeof(packet));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003077 StringExtractorGDBRemote response;
Greg Clayton3dedae12013-12-06 21:45:27 +00003078 if (m_gdb_comm.SendPacketAndWaitForResponse(packet, packet_len, response, true) == GDBRemoteCommunication::PacketResult::Success)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003079 {
Greg Clayton576d8832011-03-22 04:00:09 +00003080 if (response.IsNormalResponse())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003081 {
3082 error.Clear();
Jason Molenda6076bf42014-05-06 04:34:52 +00003083 if (binary_memory_read)
3084 {
3085 // The lower level GDBRemoteCommunication packet receive layer has already de-quoted any
3086 // 0x7d character escaping that was present in the packet
3087
3088 size_t data_received_size = response.GetBytesLeft();
3089 if (data_received_size > size)
3090 {
3091 // Don't write past the end of BUF if the remote debug server gave us too
3092 // much data for some reason.
3093 data_received_size = size;
3094 }
3095 memcpy (buf, response.GetStringRef().data(), data_received_size);
3096 return data_received_size;
3097 }
3098 else
3099 {
3100 return response.GetHexBytes(buf, size, '\xdd');
3101 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003102 }
Greg Clayton576d8832011-03-22 04:00:09 +00003103 else if (response.IsErrorResponse())
Greg Claytonb9d5df52012-12-06 22:49:16 +00003104 error.SetErrorStringWithFormat("memory read failed for 0x%" PRIx64, addr);
Greg Clayton576d8832011-03-22 04:00:09 +00003105 else if (response.IsUnsupportedResponse())
Greg Clayton9944cd72012-09-19 01:46:31 +00003106 error.SetErrorStringWithFormat("GDB server does not support reading memory");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003107 else
Greg Clayton9944cd72012-09-19 01:46:31 +00003108 error.SetErrorStringWithFormat("unexpected response to GDB server memory read packet '%s': '%s'", packet, response.GetStringRef().c_str());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003109 }
3110 else
3111 {
Jim Ingham35579dd2013-06-03 19:34:01 +00003112 error.SetErrorStringWithFormat("failed to send packet: '%s'", packet);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003113 }
3114 return 0;
3115}
3116
3117size_t
3118ProcessGDBRemote::DoWriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
3119{
Jason Molenda6076bf42014-05-06 04:34:52 +00003120 GetMaxMemorySize ();
Greg Claytonb4aaf2e2011-05-16 02:35:02 +00003121 if (size > m_max_memory_size)
3122 {
3123 // Keep memory read sizes down to a sane limit. This function will be
Ed Maste81b4c5f2016-01-04 01:43:47 +00003124 // called multiple times in order to complete the task by
Greg Claytonb4aaf2e2011-05-16 02:35:02 +00003125 // lldb_private::Process so it is ok to do this.
3126 size = m_max_memory_size;
3127 }
3128
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003129 StreamString packet;
Daniel Malead01b2952012-11-29 21:49:15 +00003130 packet.Printf("M%" PRIx64 ",%" PRIx64 ":", addr, (uint64_t)size);
Bruce Mitchener9ccb9702015-11-07 04:40:13 +00003131 packet.PutBytesAsRawHex8(buf, size, endian::InlHostByteOrder(), endian::InlHostByteOrder());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003132 StringExtractorGDBRemote response;
Greg Clayton3dedae12013-12-06 21:45:27 +00003133 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetData(), packet.GetSize(), response, true) == GDBRemoteCommunication::PacketResult::Success)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003134 {
Greg Clayton576d8832011-03-22 04:00:09 +00003135 if (response.IsOKResponse())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003136 {
3137 error.Clear();
3138 return size;
3139 }
Greg Clayton576d8832011-03-22 04:00:09 +00003140 else if (response.IsErrorResponse())
Greg Claytonb9d5df52012-12-06 22:49:16 +00003141 error.SetErrorStringWithFormat("memory write failed for 0x%" PRIx64, addr);
Greg Clayton576d8832011-03-22 04:00:09 +00003142 else if (response.IsUnsupportedResponse())
Greg Clayton9944cd72012-09-19 01:46:31 +00003143 error.SetErrorStringWithFormat("GDB server does not support writing memory");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003144 else
Greg Clayton9944cd72012-09-19 01:46:31 +00003145 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 +00003146 }
3147 else
3148 {
Jim Ingham35579dd2013-06-03 19:34:01 +00003149 error.SetErrorStringWithFormat("failed to send packet: '%s'", packet.GetString().c_str());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003150 }
3151 return 0;
3152}
3153
3154lldb::addr_t
3155ProcessGDBRemote::DoAllocateMemory (size_t size, uint32_t permissions, Error &error)
3156{
Tamas Berghammerdb264a62015-03-31 09:52:22 +00003157 Log *log (GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS|LIBLLDB_LOG_EXPRESSIONS));
Greg Clayton2a48f522011-05-14 01:50:35 +00003158 addr_t allocated_addr = LLDB_INVALID_ADDRESS;
Ed Maste81b4c5f2016-01-04 01:43:47 +00003159
Greg Claytoncec91ef2016-02-26 01:20:20 +00003160 if (m_gdb_comm.SupportsAllocDeallocMemory() != eLazyBoolNo)
Greg Clayton2a48f522011-05-14 01:50:35 +00003161 {
Greg Claytoncec91ef2016-02-26 01:20:20 +00003162 allocated_addr = m_gdb_comm.AllocateMemory (size, permissions);
3163 if (allocated_addr != LLDB_INVALID_ADDRESS || m_gdb_comm.SupportsAllocDeallocMemory() == eLazyBoolYes)
3164 return allocated_addr;
3165 }
Greg Clayton2a48f522011-05-14 01:50:35 +00003166
Greg Claytoncec91ef2016-02-26 01:20:20 +00003167 if (m_gdb_comm.SupportsAllocDeallocMemory() == eLazyBoolNo)
3168 {
3169 // Call mmap() to create memory in the inferior..
3170 unsigned prot = 0;
3171 if (permissions & lldb::ePermissionsReadable)
3172 prot |= eMmapProtRead;
3173 if (permissions & lldb::ePermissionsWritable)
3174 prot |= eMmapProtWrite;
3175 if (permissions & lldb::ePermissionsExecutable)
3176 prot |= eMmapProtExec;
Greg Clayton2a48f522011-05-14 01:50:35 +00003177
Greg Claytoncec91ef2016-02-26 01:20:20 +00003178 if (InferiorCallMmap(this, allocated_addr, 0, size, prot,
3179 eMmapFlagsAnon | eMmapFlagsPrivate, -1, 0))
3180 m_addr_to_mmap_size[allocated_addr] = size;
3181 else
3182 {
3183 allocated_addr = LLDB_INVALID_ADDRESS;
3184 if (log)
3185 log->Printf ("ProcessGDBRemote::%s no direct stub support for memory allocation, and InferiorCallMmap also failed - is stub missing register context save/restore capability?", __FUNCTION__);
3186 }
Greg Clayton2a48f522011-05-14 01:50:35 +00003187 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00003188
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003189 if (allocated_addr == LLDB_INVALID_ADDRESS)
Daniel Malead01b2952012-11-29 21:49:15 +00003190 error.SetErrorStringWithFormat("unable to allocate %" PRIu64 " bytes of memory with permissions %s", (uint64_t)size, GetPermissionsAsCString (permissions));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003191 else
3192 error.Clear();
3193 return allocated_addr;
3194}
3195
3196Error
Ed Maste81b4c5f2016-01-04 01:43:47 +00003197ProcessGDBRemote::GetMemoryRegionInfo (addr_t load_addr,
Greg Clayton46fb5582011-11-18 07:03:08 +00003198 MemoryRegionInfo &region_info)
3199{
Ed Maste81b4c5f2016-01-04 01:43:47 +00003200
Greg Clayton46fb5582011-11-18 07:03:08 +00003201 Error error (m_gdb_comm.GetMemoryRegionInfo (load_addr, region_info));
3202 return error;
3203}
3204
3205Error
Johnny Chen64637202012-05-23 21:09:52 +00003206ProcessGDBRemote::GetWatchpointSupportInfo (uint32_t &num)
3207{
Ed Maste81b4c5f2016-01-04 01:43:47 +00003208
Johnny Chen64637202012-05-23 21:09:52 +00003209 Error error (m_gdb_comm.GetWatchpointSupportInfo (num));
3210 return error;
3211}
3212
3213Error
Enrico Granataf04a2192012-07-13 23:18:48 +00003214ProcessGDBRemote::GetWatchpointSupportInfo (uint32_t &num, bool& after)
3215{
Jaydeep Patil725666c2015-08-13 03:46:01 +00003216 Error error (m_gdb_comm.GetWatchpointSupportInfo (num, after, GetTarget().GetArchitecture()));
Enrico Granataf04a2192012-07-13 23:18:48 +00003217 return error;
3218}
3219
3220Error
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003221ProcessGDBRemote::DoDeallocateMemory (lldb::addr_t addr)
3222{
Ed Maste81b4c5f2016-01-04 01:43:47 +00003223 Error error;
Greg Clayton70b57652011-05-15 01:25:55 +00003224 LazyBool supported = m_gdb_comm.SupportsAllocDeallocMemory();
3225
3226 switch (supported)
3227 {
3228 case eLazyBoolCalculate:
Ed Maste81b4c5f2016-01-04 01:43:47 +00003229 // We should never be deallocating memory without allocating memory
Greg Clayton70b57652011-05-15 01:25:55 +00003230 // first so we should never get eLazyBoolCalculate
3231 error.SetErrorString ("tried to deallocate memory without ever allocating memory");
3232 break;
3233
3234 case eLazyBoolYes:
3235 if (!m_gdb_comm.DeallocateMemory (addr))
Daniel Malead01b2952012-11-29 21:49:15 +00003236 error.SetErrorStringWithFormat("unable to deallocate memory at 0x%" PRIx64, addr);
Greg Clayton70b57652011-05-15 01:25:55 +00003237 break;
Ed Maste81b4c5f2016-01-04 01:43:47 +00003238
Greg Clayton70b57652011-05-15 01:25:55 +00003239 case eLazyBoolNo:
Peter Collingbourne99f9aa02011-06-03 20:40:38 +00003240 // Call munmap() to deallocate memory in the inferior..
Greg Clayton70b57652011-05-15 01:25:55 +00003241 {
3242 MMapMap::iterator pos = m_addr_to_mmap_size.find(addr);
Peter Collingbourne99f9aa02011-06-03 20:40:38 +00003243 if (pos != m_addr_to_mmap_size.end() &&
3244 InferiorCallMunmap(this, addr, pos->second))
3245 m_addr_to_mmap_size.erase (pos);
3246 else
Daniel Malead01b2952012-11-29 21:49:15 +00003247 error.SetErrorStringWithFormat("unable to deallocate memory at 0x%" PRIx64, addr);
Greg Clayton70b57652011-05-15 01:25:55 +00003248 }
3249 break;
3250 }
3251
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003252 return error;
3253}
3254
Eugene Zelenko0722f082015-10-24 01:28:05 +00003255
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003256//------------------------------------------------------------------
3257// Process STDIO
3258//------------------------------------------------------------------
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003259size_t
3260ProcessGDBRemote::PutSTDIN (const char *src, size_t src_len, Error &error)
3261{
3262 if (m_stdio_communication.IsConnected())
3263 {
3264 ConnectionStatus status;
3265 m_stdio_communication.Write(src, src_len, status, NULL);
3266 }
Vince Harrondf3f00f2015-02-10 21:09:04 +00003267 else if (m_stdin_forward)
Vince Harrone0be4252015-02-06 18:32:57 +00003268 {
3269 m_gdb_comm.SendStdinNotification(src, src_len);
3270 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003271 return 0;
3272}
3273
3274Error
Jim Ingham299c0c12013-02-15 02:06:30 +00003275ProcessGDBRemote::EnableBreakpointSite (BreakpointSite *bp_site)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003276{
3277 Error error;
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003278 assert(bp_site != NULL);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003279
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003280 // Get logging info
3281 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_BREAKPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003282 user_id_t site_id = bp_site->GetID();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003283
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003284 // Get the breakpoint address
3285 const addr_t addr = bp_site->GetLoadAddress();
3286
3287 // Log that a breakpoint was requested
3288 if (log)
3289 log->Printf("ProcessGDBRemote::EnableBreakpointSite (size_id = %" PRIu64 ") address = 0x%" PRIx64, site_id, (uint64_t)addr);
3290
3291 // Breakpoint already exists and is enabled
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003292 if (bp_site->IsEnabled())
3293 {
3294 if (log)
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003295 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 +00003296 return error;
3297 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003298
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003299 // Get the software breakpoint trap opcode size
3300 const size_t bp_op_size = GetSoftwareBreakpointTrapOpcode(bp_site);
3301
3302 // SupportsGDBStoppointPacket() simply checks a boolean, indicating if this breakpoint type
3303 // is supported by the remote stub. These are set to true by default, and later set to false
3304 // only after we receive an unimplemented response when sending a breakpoint packet. This means
3305 // initially that unless we were specifically instructed to use a hardware breakpoint, LLDB will
3306 // attempt to set a software breakpoint. HardwareRequired() also queries a boolean variable which
3307 // indicates if the user specifically asked for hardware breakpoints. If true then we will
3308 // skip over software breakpoints.
3309 if (m_gdb_comm.SupportsGDBStoppointPacket(eBreakpointSoftware) && (!bp_site->HardwareRequired()))
3310 {
3311 // Try to send off a software breakpoint packet ($Z0)
Jim Ingham906d91e2016-05-19 02:13:44 +00003312 uint8_t error_no = m_gdb_comm.SendGDBStoppointTypePacket(eBreakpointSoftware, true, addr, bp_op_size);
3313 if (error_no == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003314 {
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003315 // The breakpoint was placed successfully
3316 bp_site->SetEnabled(true);
3317 bp_site->SetType(BreakpointSite::eExternal);
Greg Claytoneb023e72013-10-11 19:48:25 +00003318 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003319 }
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003320
3321 // SendGDBStoppointTypePacket() will return an error if it was unable to set this
3322 // breakpoint. We need to differentiate between a error specific to placing this breakpoint
3323 // or if we have learned that this breakpoint type is unsupported. To do this, we
3324 // must test the support boolean for this breakpoint type to see if it now indicates that
3325 // this breakpoint type is unsupported. If they are still supported then we should return
3326 // with the error code. If they are now unsupported, then we would like to fall through
3327 // and try another form of breakpoint.
3328 if (m_gdb_comm.SupportsGDBStoppointPacket(eBreakpointSoftware))
Jim Ingham906d91e2016-05-19 02:13:44 +00003329 {
3330 if (error_no != UINT8_MAX)
3331 error.SetErrorStringWithFormat("error: %d sending the breakpoint request", errno);
3332 else
3333 error.SetErrorString("error sending the breakpoint request");
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003334 return error;
Jim Ingham906d91e2016-05-19 02:13:44 +00003335 }
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003336
3337 // We reach here when software breakpoints have been found to be unsupported. For future
3338 // calls to set a breakpoint, we will not attempt to set a breakpoint with a type that is
3339 // known not to be supported.
3340 if (log)
3341 log->Printf("Software breakpoints are unsupported");
3342
3343 // So we will fall through and try a hardware breakpoint
3344 }
3345
3346 // The process of setting a hardware breakpoint is much the same as above. We check the
3347 // supported boolean for this breakpoint type, and if it is thought to be supported then we
3348 // will try to set this breakpoint with a hardware breakpoint.
3349 if (m_gdb_comm.SupportsGDBStoppointPacket(eBreakpointHardware))
3350 {
3351 // Try to send off a hardware breakpoint packet ($Z1)
Jim Ingham906d91e2016-05-19 02:13:44 +00003352 uint8_t error_no = m_gdb_comm.SendGDBStoppointTypePacket(eBreakpointHardware, true, addr, bp_op_size);
3353 if (error_no == 0)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003354 {
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003355 // The breakpoint was placed successfully
3356 bp_site->SetEnabled(true);
3357 bp_site->SetType(BreakpointSite::eHardware);
3358 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003359 }
Greg Clayton8b82f082011-04-12 05:54:46 +00003360
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003361 // Check if the error was something other then an unsupported breakpoint type
3362 if (m_gdb_comm.SupportsGDBStoppointPacket(eBreakpointHardware))
3363 {
3364 // Unable to set this hardware breakpoint
Jim Ingham906d91e2016-05-19 02:13:44 +00003365 if (error_no != UINT8_MAX)
3366 error.SetErrorStringWithFormat("error: %d sending the hardware breakpoint request "
3367 "(hardware breakpoint resources might be exhausted or unavailable)",
3368 error_no);
3369 else
3370 error.SetErrorString("error sending the hardware breakpoint request (hardware breakpoint resources "
3371 "might be exhausted or unavailable)");
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003372 return error;
3373 }
3374
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00003375 // We will reach here when the stub gives an unsupported response to a hardware breakpoint
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003376 if (log)
3377 log->Printf("Hardware breakpoints are unsupported");
3378
3379 // Finally we will falling through to a #trap style breakpoint
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003380 }
3381
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003382 // Don't fall through when hardware breakpoints were specifically requested
3383 if (bp_site->HardwareRequired())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003384 {
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003385 error.SetErrorString("hardware breakpoints are not supported");
3386 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003387 }
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003388
3389 // As a last resort we want to place a manual breakpoint. An instruction
3390 // is placed into the process memory using memory write packets.
3391 return EnableSoftwareBreakpoint(bp_site);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003392}
3393
3394Error
Jim Ingham299c0c12013-02-15 02:06:30 +00003395ProcessGDBRemote::DisableBreakpointSite (BreakpointSite *bp_site)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003396{
3397 Error error;
3398 assert (bp_site != NULL);
3399 addr_t addr = bp_site->GetLoadAddress();
3400 user_id_t site_id = bp_site->GetID();
Greg Clayton5160ce52013-03-27 23:08:40 +00003401 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_BREAKPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003402 if (log)
Jim Ingham299c0c12013-02-15 02:06:30 +00003403 log->Printf ("ProcessGDBRemote::DisableBreakpointSite (site_id = %" PRIu64 ") addr = 0x%8.8" PRIx64, site_id, (uint64_t)addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003404
3405 if (bp_site->IsEnabled())
3406 {
3407 const size_t bp_op_size = GetSoftwareBreakpointTrapOpcode (bp_site);
3408
Greg Clayton8b82f082011-04-12 05:54:46 +00003409 BreakpointSite::Type bp_type = bp_site->GetType();
3410 switch (bp_type)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003411 {
Greg Clayton8b82f082011-04-12 05:54:46 +00003412 case BreakpointSite::eSoftware:
3413 error = DisableSoftwareBreakpoint (bp_site);
3414 break;
3415
3416 case BreakpointSite::eHardware:
Deepak Panickalb98a2bb2014-02-24 11:50:46 +00003417 if (m_gdb_comm.SendGDBStoppointTypePacket(eBreakpointHardware, false, addr, bp_op_size))
Greg Clayton8b82f082011-04-12 05:54:46 +00003418 error.SetErrorToGenericError();
3419 break;
3420
3421 case BreakpointSite::eExternal:
Jim Inghama04ef752014-03-07 11:18:02 +00003422 {
3423 GDBStoppointType stoppoint_type;
3424 if (bp_site->IsHardware())
3425 stoppoint_type = eBreakpointHardware;
3426 else
3427 stoppoint_type = eBreakpointSoftware;
Ed Maste81b4c5f2016-01-04 01:43:47 +00003428
Jim Inghama04ef752014-03-07 11:18:02 +00003429 if (m_gdb_comm.SendGDBStoppointTypePacket(stoppoint_type, false, addr, bp_op_size))
Greg Clayton8b82f082011-04-12 05:54:46 +00003430 error.SetErrorToGenericError();
Jim Inghama04ef752014-03-07 11:18:02 +00003431 }
Greg Clayton8b82f082011-04-12 05:54:46 +00003432 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003433 }
Greg Clayton8b82f082011-04-12 05:54:46 +00003434 if (error.Success())
3435 bp_site->SetEnabled(false);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003436 }
3437 else
3438 {
3439 if (log)
Jim Ingham299c0c12013-02-15 02:06:30 +00003440 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 +00003441 return error;
3442 }
3443
3444 if (error.Success())
3445 error.SetErrorToGenericError();
3446 return error;
3447}
3448
Johnny Chen11309a32011-09-06 22:38:36 +00003449// Pre-requisite: wp != NULL.
3450static GDBStoppointType
Johnny Chen01a67862011-10-14 00:42:25 +00003451GetGDBStoppointType (Watchpoint *wp)
Johnny Chen11309a32011-09-06 22:38:36 +00003452{
3453 assert(wp);
3454 bool watch_read = wp->WatchpointRead();
3455 bool watch_write = wp->WatchpointWrite();
3456
3457 // watch_read and watch_write cannot both be false.
3458 assert(watch_read || watch_write);
3459 if (watch_read && watch_write)
3460 return eWatchpointReadWrite;
Johnny Chen6d487a92011-09-09 20:35:15 +00003461 else if (watch_read)
Johnny Chen11309a32011-09-06 22:38:36 +00003462 return eWatchpointRead;
Johnny Chen6d487a92011-09-09 20:35:15 +00003463 else // Must be watch_write, then.
Johnny Chen11309a32011-09-06 22:38:36 +00003464 return eWatchpointWrite;
3465}
3466
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003467Error
Jim Ingham1b5792e2012-12-18 02:03:49 +00003468ProcessGDBRemote::EnableWatchpoint (Watchpoint *wp, bool notify)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003469{
3470 Error error;
3471 if (wp)
3472 {
3473 user_id_t watchID = wp->GetID();
3474 addr_t addr = wp->GetLoadAddress();
Greg Clayton5160ce52013-03-27 23:08:40 +00003475 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_WATCHPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003476 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00003477 log->Printf ("ProcessGDBRemote::EnableWatchpoint(watchID = %" PRIu64 ")", watchID);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003478 if (wp->IsEnabled())
3479 {
3480 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00003481 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 +00003482 return error;
3483 }
Johnny Chen11309a32011-09-06 22:38:36 +00003484
3485 GDBStoppointType type = GetGDBStoppointType(wp);
3486 // Pass down an appropriate z/Z packet...
3487 if (m_gdb_comm.SupportsGDBStoppointPacket (type))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003488 {
Johnny Chen11309a32011-09-06 22:38:36 +00003489 if (m_gdb_comm.SendGDBStoppointTypePacket(type, true, addr, wp->GetByteSize()) == 0)
3490 {
Jim Ingham1b5792e2012-12-18 02:03:49 +00003491 wp->SetEnabled(true, notify);
Johnny Chen11309a32011-09-06 22:38:36 +00003492 return error;
3493 }
3494 else
3495 error.SetErrorString("sending gdb watchpoint packet failed");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003496 }
Johnny Chen11309a32011-09-06 22:38:36 +00003497 else
3498 error.SetErrorString("watchpoints not supported");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003499 }
3500 else
3501 {
Johnny Chen01a67862011-10-14 00:42:25 +00003502 error.SetErrorString("Watchpoint argument was NULL.");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003503 }
3504 if (error.Success())
3505 error.SetErrorToGenericError();
3506 return error;
3507}
3508
3509Error
Jim Ingham1b5792e2012-12-18 02:03:49 +00003510ProcessGDBRemote::DisableWatchpoint (Watchpoint *wp, bool notify)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003511{
3512 Error error;
3513 if (wp)
3514 {
3515 user_id_t watchID = wp->GetID();
3516
Greg Clayton5160ce52013-03-27 23:08:40 +00003517 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_WATCHPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003518
3519 addr_t addr = wp->GetLoadAddress();
Jim Ingham1b5792e2012-12-18 02:03:49 +00003520
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003521 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00003522 log->Printf ("ProcessGDBRemote::DisableWatchpoint (watchID = %" PRIu64 ") addr = 0x%8.8" PRIx64, watchID, (uint64_t)addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003523
Johnny Chen11309a32011-09-06 22:38:36 +00003524 if (!wp->IsEnabled())
3525 {
3526 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00003527 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 +00003528 // See also 'class WatchpointSentry' within StopInfo.cpp.
3529 // This disabling attempt might come from the user-supplied actions, we'll route it in order for
3530 // the watchpoint object to intelligently process this action.
Jim Ingham1b5792e2012-12-18 02:03:49 +00003531 wp->SetEnabled(false, notify);
Johnny Chen11309a32011-09-06 22:38:36 +00003532 return error;
3533 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00003534
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003535 if (wp->IsHardware())
3536 {
Johnny Chen11309a32011-09-06 22:38:36 +00003537 GDBStoppointType type = GetGDBStoppointType(wp);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003538 // Pass down an appropriate z/Z packet...
Johnny Chen11309a32011-09-06 22:38:36 +00003539 if (m_gdb_comm.SendGDBStoppointTypePacket(type, false, addr, wp->GetByteSize()) == 0)
3540 {
Jim Ingham1b5792e2012-12-18 02:03:49 +00003541 wp->SetEnabled(false, notify);
Johnny Chen11309a32011-09-06 22:38:36 +00003542 return error;
3543 }
3544 else
Ed Maste81b4c5f2016-01-04 01:43:47 +00003545 error.SetErrorString("sending gdb watchpoint packet failed");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003546 }
3547 // TODO: clear software watchpoints if we implement them
3548 }
3549 else
3550 {
Johnny Chen01a67862011-10-14 00:42:25 +00003551 error.SetErrorString("Watchpoint argument was NULL.");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003552 }
3553 if (error.Success())
3554 error.SetErrorToGenericError();
3555 return error;
3556}
3557
3558void
3559ProcessGDBRemote::Clear()
3560{
3561 m_flags = 0;
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00003562 m_thread_list_real.Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003563 m_thread_list.Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003564}
3565
3566Error
3567ProcessGDBRemote::DoSignal (int signo)
3568{
3569 Error error;
Greg Clayton5160ce52013-03-27 23:08:40 +00003570 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003571 if (log)
3572 log->Printf ("ProcessGDBRemote::DoSignal (signal = %d)", signo);
3573
3574 if (!m_gdb_comm.SendAsyncSignal (signo))
3575 error.SetErrorStringWithFormat("failed to send signal %i", signo);
3576 return error;
3577}
3578
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003579Error
Oleksiy Vyalovafd6ce42015-11-23 19:32:24 +00003580ProcessGDBRemote::EstablishConnectionIfNeeded (const ProcessInfo &process_info)
3581{
3582 // Make sure we aren't already connected?
3583 if (m_gdb_comm.IsConnected())
3584 return Error();
3585
3586 PlatformSP platform_sp (GetTarget ().GetPlatform ());
3587 if (platform_sp && !platform_sp->IsHost ())
3588 return Error("Lost debug server connection");
3589
3590 auto error = LaunchAndConnectToDebugserver (process_info);
3591 if (error.Fail())
3592 {
3593 const char *error_string = error.AsCString();
3594 if (error_string == nullptr)
3595 error_string = "unable to launch " DEBUGSERVER_BASENAME;
3596 }
3597 return error;
3598}
3599
3600Error
Greg Clayton91a9b2472013-12-04 19:19:12 +00003601ProcessGDBRemote::LaunchAndConnectToDebugserver (const ProcessInfo &process_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003602{
Pavel Labath998bdc52016-05-11 16:59:04 +00003603 using namespace std::placeholders; // For _1, _2, etc.
3604
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003605 Error error;
3606 if (m_debugserver_pid == LLDB_INVALID_PROCESS_ID)
3607 {
3608 // If we locate debugserver, keep that located version around
3609 static FileSpec g_debugserver_file_spec;
3610
Han Ming Ong84647042012-02-25 01:07:38 +00003611 ProcessLaunchInfo debugserver_launch_info;
Oleksiy Vyalovf8ce61c2015-01-28 17:36:59 +00003612 // Make debugserver run in its own session so signals generated by
3613 // special terminal key sequences (^C) don't affect debugserver.
3614 debugserver_launch_info.SetLaunchInSeparateProcessGroup(true);
3615
Pavel Labath194357c2016-05-12 11:10:01 +00003616 const std::weak_ptr<ProcessGDBRemote> this_wp = std::static_pointer_cast<ProcessGDBRemote>(shared_from_this());
3617 debugserver_launch_info.SetMonitorProcessCallback(std::bind(MonitorDebugserverProcess, this_wp, _1, _2, _3, _4),
Pavel Labath998bdc52016-05-11 16:59:04 +00003618 false);
Greg Clayton91a9b2472013-12-04 19:19:12 +00003619 debugserver_launch_info.SetUserID(process_info.GetUserID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003620
Todd Fiala013434e2014-07-09 01:29:05 +00003621#if defined (__APPLE__) && (defined (__arm__) || defined (__arm64__) || defined (__aarch64__))
Greg Claytonfda4fab2014-01-10 22:24:11 +00003622 // On iOS, still do a local connection using a random port
Greg Clayton16810922014-02-27 19:38:18 +00003623 const char *hostname = "127.0.0.1";
Greg Claytonfda4fab2014-01-10 22:24:11 +00003624 uint16_t port = get_random_port ();
3625#else
3626 // Set hostname being NULL to do the reverse connect where debugserver
3627 // will bind to port zero and it will communicate back to us the port
3628 // that we will connect to
Oleksiy Vyalov9fe526c2015-10-21 19:34:26 +00003629 const char *hostname = nullptr;
Greg Claytonfda4fab2014-01-10 22:24:11 +00003630 uint16_t port = 0;
3631#endif
3632
Oleksiy Vyalov9fe526c2015-10-21 19:34:26 +00003633 StreamString url_str;
3634 const char* url = nullptr;
3635 if (hostname != nullptr)
3636 {
3637 url_str.Printf("%s:%u", hostname, port);
3638 url = url_str.GetData();
3639 }
3640
3641 error = m_gdb_comm.StartDebugserverProcess (url,
Greg Clayton6988abc2015-10-19 20:44:01 +00003642 GetTarget().GetPlatform().get(),
Greg Clayton00fe87b2013-12-05 22:58:22 +00003643 debugserver_launch_info,
Oleksiy Vyalov9fe526c2015-10-21 19:34:26 +00003644 &port);
Greg Clayton91a9b2472013-12-04 19:19:12 +00003645
3646 if (error.Success ())
3647 m_debugserver_pid = debugserver_launch_info.GetProcessID();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003648 else
Greg Clayton91a9b2472013-12-04 19:19:12 +00003649 m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003650
3651 if (m_debugserver_pid != LLDB_INVALID_PROCESS_ID)
3652 StartAsyncThread ();
Ed Maste81b4c5f2016-01-04 01:43:47 +00003653
Greg Clayton91a9b2472013-12-04 19:19:12 +00003654 if (error.Fail())
3655 {
3656 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
3657
3658 if (log)
3659 log->Printf("failed to start debugserver process: %s", error.AsCString());
3660 return error;
3661 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00003662
Greg Clayton00fe87b2013-12-05 22:58:22 +00003663 if (m_gdb_comm.IsConnected())
3664 {
3665 // Finish the connection process by doing the handshake without connecting (send NULL URL)
3666 ConnectToDebugserver (NULL);
3667 }
3668 else
3669 {
Greg Claytonfda4fab2014-01-10 22:24:11 +00003670 StreamString connect_url;
3671 connect_url.Printf("connect://%s:%u", hostname, port);
3672 error = ConnectToDebugserver (connect_url.GetString().c_str());
Greg Clayton00fe87b2013-12-05 22:58:22 +00003673 }
Greg Clayton91a9b2472013-12-04 19:19:12 +00003674
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003675 }
3676 return error;
3677}
3678
3679bool
Pavel Labath194357c2016-05-12 11:10:01 +00003680ProcessGDBRemote::MonitorDebugserverProcess(std::weak_ptr<ProcessGDBRemote> process_wp, lldb::pid_t debugserver_pid,
Pavel Labath998bdc52016-05-11 16:59:04 +00003681 bool exited, // True if the process did exit
3682 int signo, // Zero for no signal
3683 int exit_status // Exit value of process if signal is zero
3684 )
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003685{
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003686 // "debugserver_pid" argument passed in is the process ID for
3687 // debugserver that we are tracking...
Greg Clayton5160ce52013-03-27 23:08:40 +00003688 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Pavel Labath194357c2016-05-12 11:10:01 +00003689 const bool handled = true;
Greg Claytone4e45922011-11-16 05:37:56 +00003690
Greg Clayton6779606a2011-01-22 23:43:18 +00003691 if (log)
Pavel Labath194357c2016-05-12 11:10:01 +00003692 log->Printf("ProcessGDBRemote::%s(process_wp, pid=%" PRIu64 ", signo=%i (0x%x), exit_status=%i)", __FUNCTION__,
3693 debugserver_pid, signo, signo, exit_status);
Greg Clayton6779606a2011-01-22 23:43:18 +00003694
Pavel Labath194357c2016-05-12 11:10:01 +00003695 std::shared_ptr<ProcessGDBRemote> process_sp = process_wp.lock();
3696 if (log)
Saleem Abdulrasoolabdfc212016-05-15 18:18:13 +00003697 log->Printf("ProcessGDBRemote::%s(process = %p)", __FUNCTION__, static_cast<void *>(process_sp.get()));
Pavel Labath194357c2016-05-12 11:10:01 +00003698 if (!process_sp || process_sp->m_debugserver_pid != debugserver_pid)
3699 return handled;
3700
3701 // Sleep for a half a second to make sure our inferior process has
3702 // time to set its exit status before we set it incorrectly when
3703 // both the debugserver and the inferior process shut down.
3704 usleep(500000);
3705 // If our process hasn't yet exited, debugserver might have died.
3706 // If the process did exit, then we are reaping it.
3707 const StateType state = process_sp->GetState();
3708
3709 if (state != eStateInvalid && state != eStateUnloaded && state != eStateExited && state != eStateDetached)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003710 {
Pavel Labath194357c2016-05-12 11:10:01 +00003711 char error_str[1024];
3712 if (signo)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003713 {
Pavel Labath194357c2016-05-12 11:10:01 +00003714 const char *signal_cstr = process_sp->GetUnixSignals()->GetSignalAsCString(signo);
3715 if (signal_cstr)
3716 ::snprintf(error_str, sizeof(error_str), DEBUGSERVER_BASENAME " died with signal %s", signal_cstr);
3717 else
3718 ::snprintf(error_str, sizeof(error_str), DEBUGSERVER_BASENAME " died with signal %i", signo);
Greg Clayton0b76a2c2010-08-21 02:22:51 +00003719 }
Pavel Labath194357c2016-05-12 11:10:01 +00003720 else
3721 {
3722 ::snprintf(error_str, sizeof(error_str), DEBUGSERVER_BASENAME " died with an exit status of 0x%8.8x",
3723 exit_status);
3724 }
3725
3726 process_sp->SetExitStatus(-1, error_str);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003727 }
Pavel Labath194357c2016-05-12 11:10:01 +00003728 // Debugserver has exited we need to let our ProcessGDBRemote
3729 // know that it no longer has a debugserver instance
3730 process_sp->m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
3731 return handled;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003732}
3733
3734void
3735ProcessGDBRemote::KillDebugserverProcess ()
3736{
Greg Claytonfbb76342013-11-20 21:07:01 +00003737 m_gdb_comm.Disconnect();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003738 if (m_debugserver_pid != LLDB_INVALID_PROCESS_ID)
3739 {
Virgile Bellob2f1fb22013-08-23 12:44:05 +00003740 Host::Kill (m_debugserver_pid, SIGINT);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003741 m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
3742 }
3743}
3744
3745void
3746ProcessGDBRemote::Initialize()
3747{
Davide Italianoc8d69822015-04-03 04:24:32 +00003748 static std::once_flag g_once_flag;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003749
Davide Italianoc8d69822015-04-03 04:24:32 +00003750 std::call_once(g_once_flag, []()
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003751 {
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003752 PluginManager::RegisterPlugin (GetPluginNameStatic(),
3753 GetPluginDescriptionStatic(),
Greg Clayton7f982402013-07-15 22:54:20 +00003754 CreateInstance,
3755 DebuggerInitialize);
Davide Italianoc8d69822015-04-03 04:24:32 +00003756 });
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003757}
3758
Greg Clayton7f982402013-07-15 22:54:20 +00003759void
Tamas Berghammerdb264a62015-03-31 09:52:22 +00003760ProcessGDBRemote::DebuggerInitialize (Debugger &debugger)
Greg Clayton7f982402013-07-15 22:54:20 +00003761{
3762 if (!PluginManager::GetSettingForProcessPlugin(debugger, PluginProperties::GetSettingName()))
3763 {
3764 const bool is_global_setting = true;
3765 PluginManager::CreateSettingForProcessPlugin (debugger,
3766 GetGlobalPluginProperties()->GetValueProperties(),
3767 ConstString ("Properties for the gdb-remote process plug-in."),
3768 is_global_setting);
3769 }
3770}
3771
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003772bool
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003773ProcessGDBRemote::StartAsyncThread ()
3774{
Greg Clayton5160ce52013-03-27 23:08:40 +00003775 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003776
3777 if (log)
3778 log->Printf ("ProcessGDBRemote::%s ()", __FUNCTION__);
Ed Maste81b4c5f2016-01-04 01:43:47 +00003779
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +00003780 std::lock_guard<std::recursive_mutex> guard(m_async_thread_state_mutex);
Zachary Turneracee96a2014-09-23 18:32:09 +00003781 if (!m_async_thread.IsJoinable())
Jim Ingham455fa5c2012-11-01 01:15:33 +00003782 {
3783 // Create a thread that watches our internal state and controls which
3784 // events make it to clients (into the DCProcess event queue).
Zachary Turner39de3112014-09-09 20:54:56 +00003785
3786 m_async_thread = ThreadLauncher::LaunchThread("<lldb.process.gdb-remote.async>", ProcessGDBRemote::AsyncThread, this, NULL);
Jim Ingham455fa5c2012-11-01 01:15:33 +00003787 }
Zachary Turneracee96a2014-09-23 18:32:09 +00003788 else if (log)
3789 log->Printf("ProcessGDBRemote::%s () - Called when Async thread was already running.", __FUNCTION__);
Zachary Turner39de3112014-09-09 20:54:56 +00003790
Zachary Turneracee96a2014-09-23 18:32:09 +00003791 return m_async_thread.IsJoinable();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003792}
3793
3794void
3795ProcessGDBRemote::StopAsyncThread ()
3796{
Greg Clayton5160ce52013-03-27 23:08:40 +00003797 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003798
3799 if (log)
3800 log->Printf ("ProcessGDBRemote::%s ()", __FUNCTION__);
3801
Saleem Abdulrasool16ff8602016-05-18 01:59:10 +00003802 std::lock_guard<std::recursive_mutex> guard(m_async_thread_state_mutex);
Zachary Turneracee96a2014-09-23 18:32:09 +00003803 if (m_async_thread.IsJoinable())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003804 {
Jim Ingham455fa5c2012-11-01 01:15:33 +00003805 m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncThreadShouldExit);
Ed Maste81b4c5f2016-01-04 01:43:47 +00003806
Jim Ingham455fa5c2012-11-01 01:15:33 +00003807 // This will shut down the async thread.
3808 m_gdb_comm.Disconnect(); // Disconnect from the debug server.
3809
3810 // Stop the stdio thread
Zachary Turner39de3112014-09-09 20:54:56 +00003811 m_async_thread.Join(nullptr);
Pavel Labatha55a9532015-03-11 09:53:42 +00003812 m_async_thread.Reset();
Jim Ingham455fa5c2012-11-01 01:15:33 +00003813 }
Zachary Turneracee96a2014-09-23 18:32:09 +00003814 else if (log)
3815 log->Printf("ProcessGDBRemote::%s () - Called when Async thread was not running.", __FUNCTION__);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003816}
3817
Ewan Crawford76df2882015-06-23 12:32:06 +00003818bool
3819ProcessGDBRemote::HandleNotifyPacket (StringExtractorGDBRemote &packet)
3820{
3821 // get the packet at a string
3822 const std::string &pkt = packet.GetStringRef();
3823 // skip %stop:
3824 StringExtractorGDBRemote stop_info(pkt.c_str() + 5);
3825
3826 // pass as a thread stop info packet
3827 SetLastStopPacket(stop_info);
3828
3829 // check for more stop reasons
3830 HandleStopReplySequence();
3831
3832 // if the process is stopped then we need to fake a resume
3833 // so that we can stop properly with the new break. This
3834 // is possible due to SetPrivateState() broadcasting the
3835 // state change as a side effect.
3836 if (GetPrivateState() == lldb::StateType::eStateStopped)
3837 {
3838 SetPrivateState(lldb::StateType::eStateRunning);
3839 }
3840
3841 // since we have some stopped packets we can halt the process
3842 SetPrivateState(lldb::StateType::eStateStopped);
3843
3844 return true;
3845}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003846
Virgile Bellob2f1fb22013-08-23 12:44:05 +00003847thread_result_t
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003848ProcessGDBRemote::AsyncThread (void *arg)
3849{
3850 ProcessGDBRemote *process = (ProcessGDBRemote*) arg;
3851
Greg Clayton5160ce52013-03-27 23:08:40 +00003852 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003853 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00003854 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") thread starting...", __FUNCTION__, arg, process->GetID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003855
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003856 EventSP event_sp;
Pavel Labath50556852015-09-03 09:36:22 +00003857 bool done = false;
3858 while (!done)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003859 {
Pavel Labath50556852015-09-03 09:36:22 +00003860 if (log)
3861 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") listener.WaitForEvent (NULL, event_sp)...", __FUNCTION__, arg, process->GetID());
Jim Ingham583bbb12016-03-07 21:50:25 +00003862 if (process->m_async_listener_sp->WaitForEvent (NULL, event_sp))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003863 {
Pavel Labath50556852015-09-03 09:36:22 +00003864 const uint32_t event_type = event_sp->GetType();
3865 if (event_sp->BroadcasterIs (&process->m_async_broadcaster))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003866 {
3867 if (log)
Pavel Labath50556852015-09-03 09:36:22 +00003868 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") Got an event of type: %d...", __FUNCTION__, arg, process->GetID(), event_type);
3869
3870 switch (event_type)
3871 {
3872 case eBroadcastBitAsyncContinue:
3873 {
3874 const EventDataBytes *continue_packet = EventDataBytes::GetEventDataFromEvent(event_sp.get());
3875
3876 if (continue_packet)
3877 {
3878 const char *continue_cstr = (const char *)continue_packet->GetBytes ();
3879 const size_t continue_cstr_len = continue_packet->GetByteSize ();
3880 if (log)
3881 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") got eBroadcastBitAsyncContinue: %s", __FUNCTION__, arg, process->GetID(), continue_cstr);
3882
3883 if (::strstr (continue_cstr, "vAttach") == NULL)
3884 process->SetPrivateState(eStateRunning);
3885 StringExtractorGDBRemote response;
3886
3887 // If in Non-Stop-Mode
3888 if (process->GetTarget().GetNonStopModeEnabled())
3889 {
3890 // send the vCont packet
3891 if (!process->GetGDBRemote().SendvContPacket(process, continue_cstr, continue_cstr_len, response))
3892 {
3893 // Something went wrong
3894 done = true;
3895 break;
3896 }
3897 }
3898 // If in All-Stop-Mode
3899 else
3900 {
3901 StateType stop_state = process->GetGDBRemote().SendContinuePacketAndWaitForResponse (process, continue_cstr, continue_cstr_len, response);
3902
3903 // We need to immediately clear the thread ID list so we are sure to get a valid list of threads.
3904 // The thread ID list might be contained within the "response", or the stop reply packet that
3905 // caused the stop. So clear it now before we give the stop reply packet to the process
3906 // using the process->SetLastStopPacket()...
3907 process->ClearThreadIDList ();
3908
3909 switch (stop_state)
3910 {
3911 case eStateStopped:
3912 case eStateCrashed:
3913 case eStateSuspended:
3914 process->SetLastStopPacket (response);
3915 process->SetPrivateState (stop_state);
3916 break;
3917
3918 case eStateExited:
3919 {
3920 process->SetLastStopPacket (response);
3921 process->ClearThreadIDList();
3922 response.SetFilePos(1);
Ed Maste81b4c5f2016-01-04 01:43:47 +00003923
Pavel Labath50556852015-09-03 09:36:22 +00003924 int exit_status = response.GetHexU8();
3925 const char *desc_cstr = NULL;
3926 StringExtractor extractor;
3927 std::string desc_string;
3928 if (response.GetBytesLeft() > 0 && response.GetChar('-') == ';')
3929 {
3930 std::string desc_token;
3931 while (response.GetNameColonValue (desc_token, desc_string))
3932 {
3933 if (desc_token == "description")
3934 {
3935 extractor.GetStringRef().swap(desc_string);
3936 extractor.SetFilePos(0);
3937 extractor.GetHexByteString (desc_string);
3938 desc_cstr = desc_string.c_str();
3939 }
3940 }
3941 }
3942 process->SetExitStatus(exit_status, desc_cstr);
3943 done = true;
3944 break;
3945 }
3946 case eStateInvalid:
3947 {
3948 // Check to see if we were trying to attach and if we got back
3949 // the "E87" error code from debugserver -- this indicates that
3950 // the process is not debuggable. Return a slightly more helpful
3951 // error message about why the attach failed.
3952 if (::strstr (continue_cstr, "vAttach") != NULL
3953 && response.GetError() == 0x87)
3954 {
3955 process->SetExitStatus(-1, "cannot attach to process due to System Integrity Protection");
3956 }
3957 // E01 code from vAttach means that the attach failed
3958 if (::strstr (continue_cstr, "vAttach") != NULL
3959 && response.GetError() == 0x1)
3960 {
3961 process->SetExitStatus(-1, "unable to attach");
3962 }
3963 else
3964 {
3965 process->SetExitStatus(-1, "lost connection");
3966 }
3967 break;
3968 }
3969
3970 default:
3971 process->SetPrivateState (stop_state);
3972 break;
3973 } // switch(stop_state)
3974 } // else // if in All-stop-mode
3975 } // if (continue_packet)
3976 } // case eBroadcastBitAysncContinue
3977 break;
3978
3979 case eBroadcastBitAsyncThreadShouldExit:
3980 if (log)
3981 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") got eBroadcastBitAsyncThreadShouldExit...", __FUNCTION__, arg, process->GetID());
3982 done = true;
3983 break;
3984
3985 default:
3986 if (log)
3987 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") got unknown event 0x%8.8x", __FUNCTION__, arg, process->GetID(), event_type);
3988 done = true;
3989 break;
3990 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003991 }
Pavel Labath50556852015-09-03 09:36:22 +00003992 else if (event_sp->BroadcasterIs (&process->m_gdb_comm))
3993 {
3994 switch (event_type)
3995 {
3996 case Communication::eBroadcastBitReadThreadDidExit:
3997 process->SetExitStatus (-1, "lost connection");
3998 done = true;
3999 break;
4000
4001 case GDBRemoteCommunication::eBroadcastBitGdbReadThreadGotNotify:
4002 {
4003 lldb_private::Event *event = event_sp.get();
4004 const EventDataBytes *continue_packet = EventDataBytes::GetEventDataFromEvent(event);
4005 StringExtractorGDBRemote notify((const char*)continue_packet->GetBytes());
4006 // Hand this over to the process to handle
4007 process->HandleNotifyPacket(notify);
4008 break;
4009 }
4010
4011 default:
4012 if (log)
4013 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") got unknown event 0x%8.8x", __FUNCTION__, arg, process->GetID(), event_type);
4014 done = true;
4015 break;
4016 }
4017 }
4018 }
4019 else
4020 {
4021 if (log)
4022 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") listener.WaitForEvent (NULL, event_sp) => false", __FUNCTION__, arg, process->GetID());
4023 done = true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004024 }
4025 }
4026
4027 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00004028 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64 ") thread exiting...", __FUNCTION__, arg, process->GetID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004029
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004030 return NULL;
4031}
4032
Greg Claytone996fd32011-03-08 22:40:15 +00004033//uint32_t
4034//ProcessGDBRemote::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
4035//{
4036// // If we are planning to launch the debugserver remotely, then we need to fire up a debugserver
4037// // process and ask it for the list of processes. But if we are local, we can let the Host do it.
4038// if (m_local_debugserver)
4039// {
4040// return Host::ListProcessesMatchingName (name, matches, pids);
4041// }
Ed Maste81b4c5f2016-01-04 01:43:47 +00004042// else
Greg Claytone996fd32011-03-08 22:40:15 +00004043// {
4044// // FIXME: Implement talking to the remote debugserver.
4045// return 0;
4046// }
4047//
4048//}
4049//
Jim Ingham1c823b42011-01-22 01:33:44 +00004050bool
4051ProcessGDBRemote::NewThreadNotifyBreakpointHit (void *baton,
Tamas Berghammerdb264a62015-03-31 09:52:22 +00004052 StoppointCallbackContext *context,
Jim Ingham1c823b42011-01-22 01:33:44 +00004053 lldb::user_id_t break_id,
4054 lldb::user_id_t break_loc_id)
4055{
Ed Maste81b4c5f2016-01-04 01:43:47 +00004056 // 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 +00004057 // run so I can stop it if that's what I want to do.
Tamas Berghammerdb264a62015-03-31 09:52:22 +00004058 Log *log (GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
Jim Ingham1c823b42011-01-22 01:33:44 +00004059 if (log)
4060 log->Printf("Hit New Thread Notification breakpoint.");
4061 return false;
4062}
4063
Eugene Zelenko0722f082015-10-24 01:28:05 +00004064
Jim Ingham1c823b42011-01-22 01:33:44 +00004065bool
4066ProcessGDBRemote::StartNoticingNewThreads()
4067{
Tamas Berghammerdb264a62015-03-31 09:52:22 +00004068 Log *log (GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
Greg Clayton4116e932012-05-15 02:33:01 +00004069 if (m_thread_create_bp_sp)
Jim Ingham1c823b42011-01-22 01:33:44 +00004070 {
Greg Clayton4116e932012-05-15 02:33:01 +00004071 if (log && log->GetVerbose())
4072 log->Printf("Enabled noticing new thread breakpoint.");
4073 m_thread_create_bp_sp->SetEnabled(true);
Jim Ingham1c823b42011-01-22 01:33:44 +00004074 }
Greg Clayton4116e932012-05-15 02:33:01 +00004075 else
Jim Ingham1c823b42011-01-22 01:33:44 +00004076 {
Zachary Turner7529df92015-09-01 20:02:29 +00004077 PlatformSP platform_sp (GetTarget().GetPlatform());
Greg Clayton4116e932012-05-15 02:33:01 +00004078 if (platform_sp)
Jim Ingham1c823b42011-01-22 01:33:44 +00004079 {
Zachary Turner7529df92015-09-01 20:02:29 +00004080 m_thread_create_bp_sp = platform_sp->SetThreadCreationBreakpoint(GetTarget());
Greg Clayton4116e932012-05-15 02:33:01 +00004081 if (m_thread_create_bp_sp)
Jim Ingham1c823b42011-01-22 01:33:44 +00004082 {
Jim Ingham37cfeab2011-10-15 00:21:37 +00004083 if (log && log->GetVerbose())
Greg Clayton4116e932012-05-15 02:33:01 +00004084 log->Printf("Successfully created new thread notification breakpoint %i", m_thread_create_bp_sp->GetID());
4085 m_thread_create_bp_sp->SetCallback (ProcessGDBRemote::NewThreadNotifyBreakpointHit, this, true);
Jim Ingham1c823b42011-01-22 01:33:44 +00004086 }
4087 else
4088 {
4089 if (log)
4090 log->Printf("Failed to create new thread notification breakpoint.");
Jim Ingham1c823b42011-01-22 01:33:44 +00004091 }
4092 }
4093 }
Greg Clayton4116e932012-05-15 02:33:01 +00004094 return m_thread_create_bp_sp.get() != NULL;
Jim Ingham1c823b42011-01-22 01:33:44 +00004095}
4096
4097bool
4098ProcessGDBRemote::StopNoticingNewThreads()
Ed Maste81b4c5f2016-01-04 01:43:47 +00004099{
Tamas Berghammerdb264a62015-03-31 09:52:22 +00004100 Log *log (GetLogIfAllCategoriesSet (LIBLLDB_LOG_STEP));
Jim Ingham37cfeab2011-10-15 00:21:37 +00004101 if (log && log->GetVerbose())
Jim Ingham0e97cbc2011-02-08 05:19:01 +00004102 log->Printf ("Disabling new thread notification breakpoint.");
Greg Clayton4116e932012-05-15 02:33:01 +00004103
4104 if (m_thread_create_bp_sp)
4105 m_thread_create_bp_sp->SetEnabled(false);
4106
Jim Ingham1c823b42011-01-22 01:33:44 +00004107 return true;
4108}
Ed Maste81b4c5f2016-01-04 01:43:47 +00004109
Tamas Berghammerdb264a62015-03-31 09:52:22 +00004110DynamicLoader *
Jason Molenda5e8534e2012-10-03 01:29:34 +00004111ProcessGDBRemote::GetDynamicLoader ()
4112{
4113 if (m_dyld_ap.get() == NULL)
Jason Molenda2e56a252013-05-11 03:09:05 +00004114 m_dyld_ap.reset (DynamicLoader::FindPlugin(this, NULL));
Jason Molenda5e8534e2012-10-03 01:29:34 +00004115 return m_dyld_ap.get();
4116}
Jim Ingham1c823b42011-01-22 01:33:44 +00004117
Jason Molendaa3329782014-03-29 18:54:20 +00004118Error
4119ProcessGDBRemote::SendEventData(const char *data)
4120{
4121 int return_value;
4122 bool was_supported;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004123
Jason Molendaa3329782014-03-29 18:54:20 +00004124 Error error;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004125
Jason Molendaa3329782014-03-29 18:54:20 +00004126 return_value = m_gdb_comm.SendLaunchEventDataPacket (data, &was_supported);
4127 if (return_value != 0)
4128 {
4129 if (!was_supported)
4130 error.SetErrorString("Sending events is not supported for this process.");
4131 else
4132 error.SetErrorStringWithFormat("Error sending event data: %d.", return_value);
4133 }
4134 return error;
4135}
4136
Steve Pucci03904ac2014-03-04 23:18:46 +00004137const DataBufferSP
4138ProcessGDBRemote::GetAuxvData()
4139{
4140 DataBufferSP buf;
4141 if (m_gdb_comm.GetQXferAuxvReadSupported())
4142 {
4143 std::string response_string;
4144 if (m_gdb_comm.SendPacketsAndConcatenateResponses("qXfer:auxv:read::", response_string) == GDBRemoteCommunication::PacketResult::Success)
4145 buf.reset(new DataBufferHeap(response_string.c_str(), response_string.length()));
4146 }
4147 return buf;
4148}
4149
Jason Molenda705b1802014-06-13 02:37:02 +00004150StructuredData::ObjectSP
4151ProcessGDBRemote::GetExtendedInfoForThread (lldb::tid_t tid)
4152{
4153 StructuredData::ObjectSP object_sp;
4154
4155 if (m_gdb_comm.GetThreadExtendedInfoSupported())
4156 {
4157 StructuredData::ObjectSP args_dict(new StructuredData::Dictionary());
4158 SystemRuntime *runtime = GetSystemRuntime();
4159 if (runtime)
4160 {
4161 runtime->AddThreadExtendedInfoPacketHints (args_dict);
4162 }
4163 args_dict->GetAsDictionary()->AddIntegerItem ("thread", tid);
4164
4165 StreamString packet;
4166 packet << "jThreadExtendedInfo:";
4167 args_dict->Dump (packet);
4168
4169 // FIXME the final character of a JSON dictionary, '}', is the escape
4170 // character in gdb-remote binary mode. lldb currently doesn't escape
4171 // these characters in its packet output -- so we add the quoted version
4172 // of the } character here manually in case we talk to a debugserver which
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00004173 // un-escapes the characters at packet read time.
Jason Molenda705b1802014-06-13 02:37:02 +00004174 packet << (char) (0x7d ^ 0x20);
4175
4176 StringExtractorGDBRemote response;
Greg Clayton830c81d2016-04-01 00:41:29 +00004177 response.SetResponseValidatorToJSON();
Jason Molenda705b1802014-06-13 02:37:02 +00004178 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetData(), packet.GetSize(), response, false) == GDBRemoteCommunication::PacketResult::Success)
4179 {
4180 StringExtractorGDBRemote::ResponseType response_type = response.GetResponseType();
4181 if (response_type == StringExtractorGDBRemote::eResponse)
4182 {
4183 if (!response.Empty())
4184 {
Jason Molenda20ee21b2015-07-10 23:15:22 +00004185 object_sp = StructuredData::ParseJSON (response.GetStringRef());
4186 }
4187 }
4188 }
4189 }
4190 return object_sp;
4191}
4192
4193StructuredData::ObjectSP
4194ProcessGDBRemote::GetLoadedDynamicLibrariesInfos (lldb::addr_t image_list_address, lldb::addr_t image_count)
4195{
4196 StructuredData::ObjectSP object_sp;
4197
4198 if (m_gdb_comm.GetLoadedDynamicLibrariesInfosSupported())
4199 {
Jason Molenda1d3b3562015-11-05 23:54:29 +00004200 // Scope for the scoped timeout object
4201 GDBRemoteCommunication::ScopedTimeout timeout (m_gdb_comm, 10);
4202
Jason Molenda20ee21b2015-07-10 23:15:22 +00004203 StructuredData::ObjectSP args_dict(new StructuredData::Dictionary());
4204 args_dict->GetAsDictionary()->AddIntegerItem ("image_list_address", image_list_address);
4205 args_dict->GetAsDictionary()->AddIntegerItem ("image_count", image_count);
4206
4207 StreamString packet;
4208 packet << "jGetLoadedDynamicLibrariesInfos:";
4209 args_dict->Dump (packet);
4210
4211 // FIXME the final character of a JSON dictionary, '}', is the escape
4212 // character in gdb-remote binary mode. lldb currently doesn't escape
4213 // these characters in its packet output -- so we add the quoted version
4214 // of the } character here manually in case we talk to a debugserver which
4215 // un-escapes the characters at packet read time.
4216 packet << (char) (0x7d ^ 0x20);
4217
4218 StringExtractorGDBRemote response;
Greg Clayton830c81d2016-04-01 00:41:29 +00004219 response.SetResponseValidatorToJSON();
Jason Molenda20ee21b2015-07-10 23:15:22 +00004220 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetData(), packet.GetSize(), response, false) == GDBRemoteCommunication::PacketResult::Success)
4221 {
4222 StringExtractorGDBRemote::ResponseType response_type = response.GetResponseType();
4223 if (response_type == StringExtractorGDBRemote::eResponse)
4224 {
4225 if (!response.Empty())
4226 {
Jason Molenda705b1802014-06-13 02:37:02 +00004227 object_sp = StructuredData::ParseJSON (response.GetStringRef());
4228 }
4229 }
4230 }
4231 }
4232 return object_sp;
4233}
4234
Jason Molenda6076bf42014-05-06 04:34:52 +00004235// Establish the largest memory read/write payloads we should use.
4236// If the remote stub has a max packet size, stay under that size.
Ed Maste81b4c5f2016-01-04 01:43:47 +00004237//
4238// If the remote stub's max packet size is crazy large, use a
Jason Molenda6076bf42014-05-06 04:34:52 +00004239// reasonable largeish default.
4240//
4241// If the remote stub doesn't advertise a max packet size, use a
4242// conservative default.
4243
4244void
4245ProcessGDBRemote::GetMaxMemorySize()
4246{
4247 const uint64_t reasonable_largeish_default = 128 * 1024;
4248 const uint64_t conservative_default = 512;
4249
4250 if (m_max_memory_size == 0)
4251 {
4252 uint64_t stub_max_size = m_gdb_comm.GetRemoteMaxPacketSize();
4253 if (stub_max_size != UINT64_MAX && stub_max_size != 0)
4254 {
4255 // Save the stub's claimed maximum packet size
4256 m_remote_stub_max_memory_size = stub_max_size;
4257
4258 // Even if the stub says it can support ginormous packets,
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00004259 // don't exceed our reasonable largeish default packet size.
Jason Molenda6076bf42014-05-06 04:34:52 +00004260 if (stub_max_size > reasonable_largeish_default)
4261 {
4262 stub_max_size = reasonable_largeish_default;
4263 }
4264
4265 m_max_memory_size = stub_max_size;
4266 }
4267 else
4268 {
4269 m_max_memory_size = conservative_default;
4270 }
4271 }
4272}
4273
4274void
4275ProcessGDBRemote::SetUserSpecifiedMaxMemoryTransferSize (uint64_t user_specified_max)
4276{
4277 if (user_specified_max != 0)
4278 {
4279 GetMaxMemorySize ();
4280
4281 if (m_remote_stub_max_memory_size != 0)
4282 {
4283 if (m_remote_stub_max_memory_size < user_specified_max)
4284 {
4285 m_max_memory_size = m_remote_stub_max_memory_size; // user specified a packet size too big, go as big
4286 // as the remote stub says we can go.
4287 }
4288 else
4289 {
4290 m_max_memory_size = user_specified_max; // user's packet size is good
4291 }
4292 }
4293 else
4294 {
4295 m_max_memory_size = user_specified_max; // user's packet size is probably fine
4296 }
4297 }
4298}
4299
Tamas Berghammer7cb18bf2015-03-24 11:15:23 +00004300bool
4301ProcessGDBRemote::GetModuleSpec(const FileSpec& module_file_spec,
4302 const ArchSpec& arch,
4303 ModuleSpec &module_spec)
4304{
4305 Log *log = GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PLATFORM);
4306
4307 if (!m_gdb_comm.GetModuleInfo (module_file_spec, arch, module_spec))
4308 {
4309 if (log)
4310 log->Printf ("ProcessGDBRemote::%s - failed to get module info for %s:%s",
4311 __FUNCTION__, module_file_spec.GetPath ().c_str (),
4312 arch.GetTriple ().getTriple ().c_str ());
4313 return false;
4314 }
4315
4316 if (log)
4317 {
4318 StreamString stream;
4319 module_spec.Dump (stream);
4320 log->Printf ("ProcessGDBRemote::%s - got module info for (%s:%s) : %s",
4321 __FUNCTION__, module_file_spec.GetPath ().c_str (),
4322 arch.GetTriple ().getTriple ().c_str (), stream.GetString ().c_str ());
4323 }
4324
4325 return true;
4326}
4327
Jim Ingham13c30d22015-11-05 22:33:17 +00004328bool
4329ProcessGDBRemote::GetHostOSVersion(uint32_t &major,
4330 uint32_t &minor,
4331 uint32_t &update)
4332{
4333 if (m_gdb_comm.GetOSVersion(major, minor, update))
4334 return true;
4335 // We failed to get the host OS version, defer to the base
4336 // implementation to correctly invalidate the arguments.
4337 return Process::GetHostOSVersion(major, minor, update);
4338}
4339
Colin Rileyc3c95b22015-04-16 15:51:33 +00004340namespace {
4341
4342typedef std::vector<std::string> stringVec;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004343
4344typedef std::vector<struct GdbServerRegisterInfo> GDBServerRegisterVec;
Greg Claytond04f0ed2015-05-26 18:00:51 +00004345struct RegisterSetInfo
4346{
4347 ConstString name;
4348};
Colin Rileyc3c95b22015-04-16 15:51:33 +00004349
Greg Claytond04f0ed2015-05-26 18:00:51 +00004350typedef std::map<uint32_t, RegisterSetInfo> RegisterSetMap;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004351
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004352struct GdbServerTargetInfo
4353{
Greg Claytond04f0ed2015-05-26 18:00:51 +00004354 std::string arch;
4355 std::string osabi;
4356 stringVec includes;
4357 RegisterSetMap reg_set_map;
4358 XMLNode feature_node;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004359};
Ed Maste81b4c5f2016-01-04 01:43:47 +00004360
Colin Rileyc3c95b22015-04-16 15:51:33 +00004361bool
Francis Ricci55954ae2016-04-25 21:03:55 +00004362ParseRegisters (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 +00004363{
Greg Claytond04f0ed2015-05-26 18:00:51 +00004364 if (!feature_node)
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004365 return false;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004366
Jason Molenda63bd0db2015-09-15 23:20:34 +00004367 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 +00004368 std::string gdb_group;
4369 std::string gdb_type;
4370 ConstString reg_name;
4371 ConstString alt_name;
4372 ConstString set_name;
4373 std::vector<uint32_t> value_regs;
4374 std::vector<uint32_t> invalidate_regs;
4375 bool encoding_set = false;
4376 bool format_set = false;
4377 RegisterInfo reg_info = { NULL, // Name
4378 NULL, // Alt name
4379 0, // byte size
4380 reg_offset, // offset
4381 eEncodingUint, // encoding
Jason Molendabf67a302015-09-01 05:17:01 +00004382 eFormatHex, // format
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004383 {
Jason Molendabf67a302015-09-01 05:17:01 +00004384 LLDB_INVALID_REGNUM, // eh_frame reg num
Greg Claytond04f0ed2015-05-26 18:00:51 +00004385 LLDB_INVALID_REGNUM, // DWARF reg num
4386 LLDB_INVALID_REGNUM, // generic reg num
Jason Molenda63bd0db2015-09-15 23:20:34 +00004387 cur_reg_num, // process plugin reg num
4388 cur_reg_num // native register number
Greg Claytond04f0ed2015-05-26 18:00:51 +00004389 },
4390 NULL,
4391 NULL
4392 };
Ed Maste81b4c5f2016-01-04 01:43:47 +00004393
Jason Molenda63bd0db2015-09-15 23:20:34 +00004394 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](const llvm::StringRef &name, const llvm::StringRef &value) -> bool {
Greg Claytond04f0ed2015-05-26 18:00:51 +00004395 if (name == "name")
4396 {
4397 reg_name.SetString(value);
4398 }
4399 else if (name == "bitsize")
4400 {
4401 reg_info.byte_size = StringConvert::ToUInt32(value.data(), 0, 0) / CHAR_BIT;
4402 }
4403 else if (name == "type")
4404 {
4405 gdb_type = value.str();
4406 }
4407 else if (name == "group")
4408 {
4409 gdb_group = value.str();
4410 }
4411 else if (name == "regnum")
4412 {
4413 const uint32_t regnum = StringConvert::ToUInt32(value.data(), LLDB_INVALID_REGNUM, 0);
4414 if (regnum != LLDB_INVALID_REGNUM)
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004415 {
Jason Molenda63bd0db2015-09-15 23:20:34 +00004416 reg_info.kinds[eRegisterKindProcessPlugin] = regnum;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004417 }
4418 }
Greg Claytond04f0ed2015-05-26 18:00:51 +00004419 else if (name == "offset")
4420 {
4421 reg_offset = StringConvert::ToUInt32(value.data(), UINT32_MAX, 0);
4422 }
4423 else if (name == "altname")
4424 {
4425 alt_name.SetString(value);
4426 }
4427 else if (name == "encoding")
4428 {
4429 encoding_set = true;
4430 reg_info.encoding = Args::StringToEncoding (value.data(), eEncodingUint);
4431 }
4432 else if (name == "format")
4433 {
4434 format_set = true;
4435 Format format = eFormatInvalid;
4436 if (Args::StringToFormat (value.data(), format, NULL).Success())
4437 reg_info.format = format;
4438 else if (value == "vector-sint8")
4439 reg_info.format = eFormatVectorOfSInt8;
4440 else if (value == "vector-uint8")
4441 reg_info.format = eFormatVectorOfUInt8;
4442 else if (value == "vector-sint16")
4443 reg_info.format = eFormatVectorOfSInt16;
4444 else if (value == "vector-uint16")
4445 reg_info.format = eFormatVectorOfUInt16;
4446 else if (value == "vector-sint32")
4447 reg_info.format = eFormatVectorOfSInt32;
4448 else if (value == "vector-uint32")
4449 reg_info.format = eFormatVectorOfUInt32;
4450 else if (value == "vector-float32")
4451 reg_info.format = eFormatVectorOfFloat32;
4452 else if (value == "vector-uint128")
4453 reg_info.format = eFormatVectorOfUInt128;
4454 }
4455 else if (name == "group_id")
4456 {
4457 const uint32_t set_id = StringConvert::ToUInt32(value.data(), UINT32_MAX, 0);
4458 RegisterSetMap::const_iterator pos = target_info.reg_set_map.find(set_id);
4459 if (pos != target_info.reg_set_map.end())
4460 set_name = pos->second.name;
4461 }
Jason Molendaa18f7072015-08-15 01:21:01 +00004462 else if (name == "gcc_regnum" || name == "ehframe_regnum")
Greg Claytond04f0ed2015-05-26 18:00:51 +00004463 {
Jason Molendaa18f7072015-08-15 01:21:01 +00004464 reg_info.kinds[eRegisterKindEHFrame] = StringConvert::ToUInt32(value.data(), LLDB_INVALID_REGNUM, 0);
Greg Claytond04f0ed2015-05-26 18:00:51 +00004465 }
4466 else if (name == "dwarf_regnum")
4467 {
4468 reg_info.kinds[eRegisterKindDWARF] = StringConvert::ToUInt32(value.data(), LLDB_INVALID_REGNUM, 0);
4469 }
4470 else if (name == "generic")
4471 {
4472 reg_info.kinds[eRegisterKindGeneric] = Args::StringToGenericRegister(value.data());
4473 }
4474 else if (name == "value_regnums")
4475 {
4476 SplitCommaSeparatedRegisterNumberString(value, value_regs, 0);
4477 }
4478 else if (name == "invalidate_regnums")
4479 {
4480 SplitCommaSeparatedRegisterNumberString(value, invalidate_regs, 0);
4481 }
4482 else
4483 {
4484 printf("unhandled attribute %s = %s\n", name.data(), value.data());
4485 }
4486 return true; // Keep iterating through all attributes
4487 });
Ed Maste81b4c5f2016-01-04 01:43:47 +00004488
Greg Claytond04f0ed2015-05-26 18:00:51 +00004489 if (!gdb_type.empty() && !(encoding_set || format_set))
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004490 {
Greg Claytond04f0ed2015-05-26 18:00:51 +00004491 if (gdb_type.find("int") == 0)
4492 {
4493 reg_info.format = eFormatHex;
4494 reg_info.encoding = eEncodingUint;
4495 }
4496 else if (gdb_type == "data_ptr" || gdb_type == "code_ptr")
4497 {
4498 reg_info.format = eFormatAddressInfo;
4499 reg_info.encoding = eEncodingUint;
4500 }
4501 else if (gdb_type == "i387_ext" || gdb_type == "float")
4502 {
4503 reg_info.format = eFormatFloat;
4504 reg_info.encoding = eEncodingIEEE754;
4505 }
Colin Rileyc3c95b22015-04-16 15:51:33 +00004506 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00004507
Greg Claytond04f0ed2015-05-26 18:00:51 +00004508 // Only update the register set name if we didn't get a "reg_set" attribute.
4509 // "set_name" will be empty if we didn't have a "reg_set" attribute.
4510 if (!set_name && !gdb_group.empty())
4511 set_name.SetCString(gdb_group.c_str());
Ed Maste81b4c5f2016-01-04 01:43:47 +00004512
Greg Claytond04f0ed2015-05-26 18:00:51 +00004513 reg_info.byte_offset = reg_offset;
4514 assert (reg_info.byte_size != 0);
4515 reg_offset += reg_info.byte_size;
4516 if (!value_regs.empty())
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004517 {
Greg Claytond04f0ed2015-05-26 18:00:51 +00004518 value_regs.push_back(LLDB_INVALID_REGNUM);
4519 reg_info.value_regs = value_regs.data();
Colin Rileyc3c95b22015-04-16 15:51:33 +00004520 }
Greg Claytond04f0ed2015-05-26 18:00:51 +00004521 if (!invalidate_regs.empty())
4522 {
4523 invalidate_regs.push_back(LLDB_INVALID_REGNUM);
4524 reg_info.invalidate_regs = invalidate_regs.data();
4525 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00004526
Jason Molenda63bd0db2015-09-15 23:20:34 +00004527 ++cur_reg_num;
Jason Molenda21586c82015-09-09 03:36:24 +00004528 AugmentRegisterInfoViaABI (reg_info, reg_name, abi_sp);
Greg Claytond04f0ed2015-05-26 18:00:51 +00004529 dyn_reg_info.AddRegister(reg_info, reg_name, alt_name, set_name);
Ed Maste81b4c5f2016-01-04 01:43:47 +00004530
Greg Claytond04f0ed2015-05-26 18:00:51 +00004531 return true; // Keep iterating through all "reg" elements
4532 });
Colin Rileyc3c95b22015-04-16 15:51:33 +00004533 return true;
4534}
Ed Maste81b4c5f2016-01-04 01:43:47 +00004535
Eugene Zelenko0722f082015-10-24 01:28:05 +00004536} // namespace {}
Colin Rileyc3c95b22015-04-16 15:51:33 +00004537
Colin Rileyc3c95b22015-04-16 15:51:33 +00004538
4539// query the target of gdb-remote for extended target information
4540// return: 'true' on success
4541// 'false' on failure
4542bool
Jim Ingham7b71c0b2016-02-18 23:58:45 +00004543ProcessGDBRemote::GetGDBServerRegisterInfo (ArchSpec &arch_to_use)
Colin Rileyc3c95b22015-04-16 15:51:33 +00004544{
Greg Claytond04f0ed2015-05-26 18:00:51 +00004545 // Make sure LLDB has an XML parser it can use first
4546 if (!XMLDocument::XMLEnabled())
4547 return false;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004548
4549 // redirect libxml2's error handler since the default prints to stdout
Colin Rileyc3c95b22015-04-16 15:51:33 +00004550
4551 GDBRemoteCommunicationClient & comm = m_gdb_comm;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004552
4553 // check that we have extended feature read support
4554 if ( !comm.GetQXferFeaturesReadSupported( ) )
4555 return false;
4556
4557 // request the target xml file
4558 std::string raw;
4559 lldb_private::Error lldberr;
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004560 if (!comm.ReadExtFeature(ConstString("features"),
4561 ConstString("target.xml"),
4562 raw,
4563 lldberr))
4564 {
Colin Rileyc3c95b22015-04-16 15:51:33 +00004565 return false;
4566 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00004567
Colin Rileyc3c95b22015-04-16 15:51:33 +00004568
Greg Claytond04f0ed2015-05-26 18:00:51 +00004569 XMLDocument xml_document;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004570
Greg Claytond04f0ed2015-05-26 18:00:51 +00004571 if (xml_document.ParseMemory(raw.c_str(), raw.size(), "target.xml"))
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004572 {
Greg Claytond04f0ed2015-05-26 18:00:51 +00004573 GdbServerTargetInfo target_info;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004574
Greg Claytond04f0ed2015-05-26 18:00:51 +00004575 XMLNode target_node = xml_document.GetRootElement("target");
4576 if (target_node)
Jason Molenda6ae1aab2015-04-17 19:15:02 +00004577 {
Greg Claytond04f0ed2015-05-26 18:00:51 +00004578 XMLNode feature_node;
4579 target_node.ForEachChildElement([&target_info, this, &feature_node](const XMLNode &node) -> bool
4580 {
4581 llvm::StringRef name = node.GetName();
4582 if (name == "architecture")
4583 {
4584 node.GetElementText(target_info.arch);
4585 }
4586 else if (name == "osabi")
4587 {
4588 node.GetElementText(target_info.osabi);
4589 }
Ewan Crawford682e8422015-06-26 09:38:27 +00004590 else if (name == "xi:include" || name == "include")
Greg Claytond04f0ed2015-05-26 18:00:51 +00004591 {
4592 llvm::StringRef href = node.GetAttributeValue("href");
4593 if (!href.empty())
4594 target_info.includes.push_back(href.str());
4595 }
4596 else if (name == "feature")
4597 {
4598 feature_node = node;
4599 }
4600 else if (name == "groups")
4601 {
4602 node.ForEachChildElementWithName("group", [&target_info](const XMLNode &node) -> bool {
4603 uint32_t set_id = UINT32_MAX;
4604 RegisterSetInfo set_info;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004605
Greg Claytond04f0ed2015-05-26 18:00:51 +00004606 node.ForEachAttribute([&set_id, &set_info](const llvm::StringRef &name, const llvm::StringRef &value) -> bool {
4607 if (name == "id")
4608 set_id = StringConvert::ToUInt32(value.data(), UINT32_MAX, 0);
4609 if (name == "name")
4610 set_info.name = ConstString(value);
4611 return true; // Keep iterating through all attributes
4612 });
Ed Maste81b4c5f2016-01-04 01:43:47 +00004613
Greg Claytond04f0ed2015-05-26 18:00:51 +00004614 if (set_id != UINT32_MAX)
4615 target_info.reg_set_map[set_id] = set_info;
4616 return true; // Keep iterating through all "group" elements
4617 });
4618 }
4619 return true; // Keep iterating through all children of the target_node
4620 });
Ed Maste81b4c5f2016-01-04 01:43:47 +00004621
Francis Ricci55954ae2016-04-25 21:03:55 +00004622 // Initialize these outside of ParseRegisters, since they should not be reset inside each include feature
4623 uint32_t cur_reg_num = 0;
4624 uint32_t reg_offset = 0;
4625
Jim Ingham7b71c0b2016-02-18 23:58:45 +00004626 // Don't use Process::GetABI, this code gets called from DidAttach, and in that context we haven't
4627 // set the Target's architecture yet, so the ABI is also potentially incorrect.
4628 ABISP abi_to_use_sp = ABI::FindPlugin(arch_to_use);
Greg Claytond04f0ed2015-05-26 18:00:51 +00004629 if (feature_node)
4630 {
Francis Ricci55954ae2016-04-25 21:03:55 +00004631 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 +00004632 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00004633
Greg Claytond04f0ed2015-05-26 18:00:51 +00004634 for (const auto &include : target_info.includes)
4635 {
4636 // request register file
4637 std::string xml_data;
4638 if (!comm.ReadExtFeature(ConstString("features"),
4639 ConstString(include),
4640 xml_data,
4641 lldberr))
4642 continue;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004643
Greg Claytond04f0ed2015-05-26 18:00:51 +00004644 XMLDocument include_xml_document;
4645 include_xml_document.ParseMemory(xml_data.data(), xml_data.size(), include.c_str());
4646 XMLNode include_feature_node = include_xml_document.GetRootElement("feature");
4647 if (include_feature_node)
4648 {
Francis Ricci55954ae2016-04-25 21:03:55 +00004649 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 +00004650 }
4651 }
Jim Ingham7b71c0b2016-02-18 23:58:45 +00004652 this->m_register_info.Finalize(arch_to_use);
Colin Rileyc3c95b22015-04-16 15:51:33 +00004653 }
4654 }
4655
Greg Claytond04f0ed2015-05-26 18:00:51 +00004656 return m_register_info.GetNumRegisters() > 0;
Colin Rileyc3c95b22015-04-16 15:51:33 +00004657}
4658
Aidan Doddsc0c83852015-05-08 09:36:31 +00004659Error
Stephane Sezer87b0fe02016-01-12 19:02:41 +00004660ProcessGDBRemote::GetLoadedModuleList (LoadedModuleInfoList & list)
Aidan Doddsc0c83852015-05-08 09:36:31 +00004661{
Greg Claytond04f0ed2015-05-26 18:00:51 +00004662 // Make sure LLDB has an XML parser it can use first
4663 if (!XMLDocument::XMLEnabled())
4664 return Error (0, ErrorType::eErrorTypeGeneric);
4665
Aidan Doddsc0c83852015-05-08 09:36:31 +00004666 Log *log = GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS);
4667 if (log)
4668 log->Printf ("ProcessGDBRemote::%s", __FUNCTION__);
4669
Aidan Doddsc0c83852015-05-08 09:36:31 +00004670 GDBRemoteCommunicationClient & comm = m_gdb_comm;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004671
4672 // check that we have extended feature read support
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004673 if (comm.GetQXferLibrariesSVR4ReadSupported ()) {
4674 list.clear ();
Aidan Doddsc0c83852015-05-08 09:36:31 +00004675
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004676 // request the loaded library list
4677 std::string raw;
4678 lldb_private::Error lldberr;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004679
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004680 if (!comm.ReadExtFeature (ConstString ("libraries-svr4"), ConstString (""), raw, lldberr))
4681 return Error (0, ErrorType::eErrorTypeGeneric);
Aidan Doddsc0c83852015-05-08 09:36:31 +00004682
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004683 // parse the xml file in memory
4684 if (log)
4685 log->Printf ("parsing: %s", raw.c_str());
4686 XMLDocument doc;
Ed Maste81b4c5f2016-01-04 01:43:47 +00004687
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004688 if (!doc.ParseMemory(raw.c_str(), raw.size(), "noname.xml"))
4689 return Error (0, ErrorType::eErrorTypeGeneric);
Aidan Doddsc0c83852015-05-08 09:36:31 +00004690
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004691 XMLNode root_element = doc.GetRootElement("library-list-svr4");
4692 if (!root_element)
4693 return Error();
Aidan Doddsc0c83852015-05-08 09:36:31 +00004694
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004695 // main link map structure
4696 llvm::StringRef main_lm = root_element.GetAttributeValue("main-lm");
4697 if (!main_lm.empty())
4698 {
4699 list.m_link_map = StringConvert::ToUInt64(main_lm.data(), LLDB_INVALID_ADDRESS, 0);
4700 }
Aidan Doddsc0c83852015-05-08 09:36:31 +00004701
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004702 root_element.ForEachChildElementWithName("library", [log, &list](const XMLNode &library) -> bool {
Aidan Doddsc0c83852015-05-08 09:36:31 +00004703
Stephane Sezer87b0fe02016-01-12 19:02:41 +00004704 LoadedModuleInfoList::LoadedModuleInfo module;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004705
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004706 library.ForEachAttribute([log, &module](const llvm::StringRef &name, const llvm::StringRef &value) -> bool {
Ed Maste81b4c5f2016-01-04 01:43:47 +00004707
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004708 if (name == "name")
4709 module.set_name (value.str());
4710 else if (name == "lm")
4711 {
4712 // the address of the link_map struct.
4713 module.set_link_map(StringConvert::ToUInt64(value.data(), LLDB_INVALID_ADDRESS, 0));
4714 }
4715 else if (name == "l_addr")
4716 {
4717 // the displacement as read from the field 'l_addr' of the link_map struct.
4718 module.set_base(StringConvert::ToUInt64(value.data(), LLDB_INVALID_ADDRESS, 0));
Stephane Sezerc6845a02015-08-20 22:07:48 +00004719 // base address is always a displacement, not an absolute value.
4720 module.set_base_is_offset(true);
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004721 }
4722 else if (name == "l_ld")
4723 {
4724 // the memory address of the libraries PT_DYAMIC section.
4725 module.set_dynamic(StringConvert::ToUInt64(value.data(), LLDB_INVALID_ADDRESS, 0));
4726 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00004727
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004728 return true; // Keep iterating over all properties of "library"
4729 });
4730
4731 if (log)
Aidan Doddsc0c83852015-05-08 09:36:31 +00004732 {
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004733 std::string name;
4734 lldb::addr_t lm=0, base=0, ld=0;
Stephane Sezerc6845a02015-08-20 22:07:48 +00004735 bool base_is_offset;
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004736
4737 module.get_name (name);
4738 module.get_link_map (lm);
4739 module.get_base (base);
Stephane Sezerc6845a02015-08-20 22:07:48 +00004740 module.get_base_is_offset (base_is_offset);
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004741 module.get_dynamic (ld);
4742
Stephane Sezerc6845a02015-08-20 22:07:48 +00004743 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 +00004744 }
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004745
4746 list.add (module);
4747 return true; // Keep iterating over all "library" elements in the root node
Greg Claytond04f0ed2015-05-26 18:00:51 +00004748 });
Aidan Doddsc0c83852015-05-08 09:36:31 +00004749
4750 if (log)
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004751 log->Printf ("found %" PRId32 " modules in total", (int) list.m_list.size());
4752 } else if (comm.GetQXferLibrariesReadSupported ()) {
4753 list.clear ();
Aidan Doddsc0c83852015-05-08 09:36:31 +00004754
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004755 // request the loaded library list
4756 std::string raw;
4757 lldb_private::Error lldberr;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004758
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004759 if (!comm.ReadExtFeature (ConstString ("libraries"), ConstString (""), raw, lldberr))
4760 return Error (0, ErrorType::eErrorTypeGeneric);
Aidan Doddsc0c83852015-05-08 09:36:31 +00004761
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004762 if (log)
4763 log->Printf ("parsing: %s", raw.c_str());
4764 XMLDocument doc;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004765
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004766 if (!doc.ParseMemory(raw.c_str(), raw.size(), "noname.xml"))
4767 return Error (0, ErrorType::eErrorTypeGeneric);
4768
4769 XMLNode root_element = doc.GetRootElement("library-list");
4770 if (!root_element)
4771 return Error();
4772
4773 root_element.ForEachChildElementWithName("library", [log, &list](const XMLNode &library) -> bool {
Stephane Sezer87b0fe02016-01-12 19:02:41 +00004774 LoadedModuleInfoList::LoadedModuleInfo module;
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004775
4776 llvm::StringRef name = library.GetAttributeValue("name");
4777 module.set_name(name.str());
4778
4779 // The base address of a given library will be the address of its
4780 // first section. Most remotes send only one section for Windows
4781 // targets for example.
4782 const XMLNode &section = library.FindFirstChildElementWithName("section");
4783 llvm::StringRef address = section.GetAttributeValue("address");
4784 module.set_base(StringConvert::ToUInt64(address.data(), LLDB_INVALID_ADDRESS, 0));
Stephane Sezerc6845a02015-08-20 22:07:48 +00004785 // These addresses are absolute values.
4786 module.set_base_is_offset(false);
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004787
4788 if (log)
4789 {
4790 std::string name;
4791 lldb::addr_t base = 0;
Stephane Sezerc6845a02015-08-20 22:07:48 +00004792 bool base_is_offset;
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004793 module.get_name (name);
4794 module.get_base (base);
Stephane Sezerc6845a02015-08-20 22:07:48 +00004795 module.get_base_is_offset (base_is_offset);
Stephane Sezer9a7cacb2015-07-08 19:14:03 +00004796
Stephane Sezerc6845a02015-08-20 22:07:48 +00004797 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 +00004798 }
4799
4800 list.add (module);
4801 return true; // Keep iterating over all "library" elements in the root node
4802 });
4803
4804 if (log)
4805 log->Printf ("found %" PRId32 " modules in total", (int) list.m_list.size());
4806 } else {
4807 return Error (0, ErrorType::eErrorTypeGeneric);
4808 }
Aidan Doddsc0c83852015-05-08 09:36:31 +00004809
4810 return Error();
4811}
4812
Aidan Doddsc0c83852015-05-08 09:36:31 +00004813lldb::ModuleSP
Stephane Sezer3553c0e2016-04-05 17:25:32 +00004814ProcessGDBRemote::LoadModuleAtAddress (const FileSpec &file, lldb::addr_t link_map,
4815 lldb::addr_t base_addr, bool value_is_offset)
Aidan Doddsc0c83852015-05-08 09:36:31 +00004816{
Stephane Sezer3553c0e2016-04-05 17:25:32 +00004817 DynamicLoader *loader = GetDynamicLoader();
4818 if (!loader)
4819 return nullptr;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004820
Stephane Sezer3553c0e2016-04-05 17:25:32 +00004821 return loader->LoadModuleAtAddress(file, link_map, base_addr, value_is_offset);
Aidan Doddsc0c83852015-05-08 09:36:31 +00004822}
4823
4824size_t
Stephane Sezer87b0fe02016-01-12 19:02:41 +00004825ProcessGDBRemote::LoadModules (LoadedModuleInfoList &module_list)
Aidan Doddsc0c83852015-05-08 09:36:31 +00004826{
4827 using lldb_private::process_gdb_remote::ProcessGDBRemote;
4828
4829 // request a list of loaded libraries from GDBServer
Aidan Doddsc0c83852015-05-08 09:36:31 +00004830 if (GetLoadedModuleList (module_list).Fail())
4831 return 0;
4832
4833 // get a list of all the modules
4834 ModuleList new_modules;
4835
Stephane Sezer87b0fe02016-01-12 19:02:41 +00004836 for (LoadedModuleInfoList::LoadedModuleInfo & modInfo : module_list.m_list)
Aidan Doddsc0c83852015-05-08 09:36:31 +00004837 {
4838 std::string mod_name;
4839 lldb::addr_t mod_base;
Stephane Sezer3553c0e2016-04-05 17:25:32 +00004840 lldb::addr_t link_map;
Stephane Sezerc6845a02015-08-20 22:07:48 +00004841 bool mod_base_is_offset;
Aidan Doddsc0c83852015-05-08 09:36:31 +00004842
4843 bool valid = true;
4844 valid &= modInfo.get_name (mod_name);
4845 valid &= modInfo.get_base (mod_base);
Stephane Sezerc6845a02015-08-20 22:07:48 +00004846 valid &= modInfo.get_base_is_offset (mod_base_is_offset);
Aidan Doddsc0c83852015-05-08 09:36:31 +00004847 if (!valid)
4848 continue;
4849
Stephane Sezer3553c0e2016-04-05 17:25:32 +00004850 if (!modInfo.get_link_map (link_map))
4851 link_map = LLDB_INVALID_ADDRESS;
4852
Francis Riccia0300612016-04-27 17:10:15 +00004853 FileSpec file (mod_name.c_str(), true);
Stephane Sezer3553c0e2016-04-05 17:25:32 +00004854 lldb::ModuleSP module_sp = LoadModuleAtAddress (file, link_map, mod_base,
4855 mod_base_is_offset);
Aidan Doddsc0c83852015-05-08 09:36:31 +00004856
4857 if (module_sp.get())
4858 new_modules.Append (module_sp);
4859 }
4860
4861 if (new_modules.GetSize() > 0)
4862 {
Francis Riccibe8cab72016-04-25 21:02:24 +00004863 ModuleList removed_modules;
Zachary Turner7529df92015-09-01 20:02:29 +00004864 Target &target = GetTarget();
Francis Riccibe8cab72016-04-25 21:02:24 +00004865 ModuleList &loaded_modules = m_process->GetTarget().GetImages();
4866
4867 for (size_t i = 0; i < loaded_modules.GetSize(); ++i)
4868 {
4869 const lldb::ModuleSP loaded_module = loaded_modules.GetModuleAtIndex(i);
4870
4871 bool found = false;
4872 for (size_t j = 0; j < new_modules.GetSize(); ++j)
4873 {
4874 if (new_modules.GetModuleAtIndex(j).get() == loaded_module.get())
4875 found = true;
4876 }
4877
Francis Ricci80dbd152016-06-06 15:00:50 +00004878 // The main executable will never be included in libraries-svr4, don't remove it
4879 if (!found && loaded_module.get() != target.GetExecutableModulePointer())
Francis Riccibe8cab72016-04-25 21:02:24 +00004880 {
Francis Ricci80dbd152016-06-06 15:00:50 +00004881 removed_modules.Append (loaded_module);
Francis Riccibe8cab72016-04-25 21:02:24 +00004882 }
4883 }
4884
4885 loaded_modules.Remove (removed_modules);
4886 m_process->GetTarget().ModulesDidUnload (removed_modules, false);
Aidan Doddsc0c83852015-05-08 09:36:31 +00004887
4888 new_modules.ForEach ([&target](const lldb::ModuleSP module_sp) -> bool
4889 {
4890 lldb_private::ObjectFile * obj = module_sp->GetObjectFile ();
4891 if (!obj)
4892 return true;
4893
4894 if (obj->GetType () != ObjectFile::Type::eTypeExecutable)
4895 return true;
4896
4897 lldb::ModuleSP module_copy_sp = module_sp;
4898 target.SetExecutableModule (module_copy_sp, false);
4899 return false;
4900 });
4901
Aidan Doddsc0c83852015-05-08 09:36:31 +00004902 loaded_modules.AppendIfNeeded (new_modules);
4903 m_process->GetTarget().ModulesDidLoad (new_modules);
4904 }
4905
4906 return new_modules.GetSize();
Stephane Sezer87b0fe02016-01-12 19:02:41 +00004907}
4908
4909size_t
4910ProcessGDBRemote::LoadModules ()
4911{
4912 LoadedModuleInfoList module_list;
4913 return LoadModules (module_list);
Aidan Doddsc0c83852015-05-08 09:36:31 +00004914}
Colin Rileyc3c95b22015-04-16 15:51:33 +00004915
Tamas Berghammer783bfc82015-06-18 20:43:56 +00004916Error
4917ProcessGDBRemote::GetFileLoadAddress(const FileSpec& file, bool& is_loaded, lldb::addr_t& load_addr)
4918{
4919 is_loaded = false;
4920 load_addr = LLDB_INVALID_ADDRESS;
4921
4922 std::string file_path = file.GetPath(false);
4923 if (file_path.empty ())
4924 return Error("Empty file name specified");
4925
4926 StreamString packet;
4927 packet.PutCString("qFileLoadAddress:");
4928 packet.PutCStringAsRawHex8(file_path.c_str());
4929
4930 StringExtractorGDBRemote response;
4931 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetString().c_str(), response, false) != GDBRemoteCommunication::PacketResult::Success)
4932 return Error("Sending qFileLoadAddress packet failed");
4933
4934 if (response.IsErrorResponse())
4935 {
4936 if (response.GetError() == 1)
4937 {
4938 // The file is not loaded into the inferior
4939 is_loaded = false;
4940 load_addr = LLDB_INVALID_ADDRESS;
4941 return Error();
4942 }
4943
4944 return Error("Fetching file load address from remote server returned an error");
4945 }
4946
4947 if (response.IsNormalResponse())
4948 {
4949 is_loaded = true;
4950 load_addr = response.GetHexMaxU64(false, LLDB_INVALID_ADDRESS);
4951 return Error();
4952 }
4953
4954 return Error("Unknown error happened during sending the load address packet");
4955}
4956
Eugene Zelenko0722f082015-10-24 01:28:05 +00004957
Greg Clayton0b90be12015-06-23 21:27:50 +00004958void
4959ProcessGDBRemote::ModulesDidLoad (ModuleList &module_list)
4960{
4961 // We must call the lldb_private::Process::ModulesDidLoad () first before we do anything
4962 Process::ModulesDidLoad (module_list);
4963
4964 // After loading shared libraries, we can ask our remote GDB server if
4965 // it needs any symbols.
4966 m_gdb_comm.ServeSymbolLookups(this);
4967}
4968
Eugene Zelenko0722f082015-10-24 01:28:05 +00004969
Greg Claytone034a042015-05-21 20:52:06 +00004970class CommandObjectProcessGDBRemoteSpeedTest: public CommandObjectParsed
4971{
4972public:
4973 CommandObjectProcessGDBRemoteSpeedTest(CommandInterpreter &interpreter) :
4974 CommandObjectParsed (interpreter,
4975 "process plugin packet speed-test",
4976 "Tests packet speeds of various sizes to determine the performance characteristics of the GDB remote connection. ",
4977 NULL),
4978 m_option_group (interpreter),
4979 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),
4980 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),
4981 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),
4982 m_json (LLDB_OPT_SET_1, false, "json", 'j', "Print the output as JSON data for easy parsing.", false, true)
4983 {
4984 m_option_group.Append (&m_num_packets, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
4985 m_option_group.Append (&m_max_send, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
4986 m_option_group.Append (&m_max_recv, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
4987 m_option_group.Append (&m_json, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
4988 m_option_group.Finalize();
4989 }
4990
Eugene Zelenko0722f082015-10-24 01:28:05 +00004991 ~CommandObjectProcessGDBRemoteSpeedTest ()
4992 {
4993 }
4994
Greg Claytone034a042015-05-21 20:52:06 +00004995
4996 Options *
4997 GetOptions () override
4998 {
4999 return &m_option_group;
5000 }
5001
5002 bool
5003 DoExecute (Args& command, CommandReturnObject &result) override
5004 {
5005 const size_t argc = command.GetArgumentCount();
5006 if (argc == 0)
5007 {
5008 ProcessGDBRemote *process = (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
5009 if (process)
5010 {
5011 StreamSP output_stream_sp (m_interpreter.GetDebugger().GetAsyncOutputStream());
5012 result.SetImmediateOutputStream (output_stream_sp);
5013
5014 const uint32_t num_packets = (uint32_t)m_num_packets.GetOptionValue().GetCurrentValue();
5015 const uint64_t max_send = m_max_send.GetOptionValue().GetCurrentValue();
5016 const uint64_t max_recv = m_max_recv.GetOptionValue().GetCurrentValue();
5017 const bool json = m_json.GetOptionValue().GetCurrentValue();
5018 if (output_stream_sp)
5019 process->GetGDBRemote().TestPacketSpeed (num_packets, max_send, max_recv, json, *output_stream_sp);
5020 else
5021 {
5022 process->GetGDBRemote().TestPacketSpeed (num_packets, max_send, max_recv, json, result.GetOutputStream());
5023 }
5024 result.SetStatus (eReturnStatusSuccessFinishResult);
5025 return true;
5026 }
5027 }
5028 else
5029 {
5030 result.AppendErrorWithFormat ("'%s' takes no arguments", m_cmd_name.c_str());
5031 }
5032 result.SetStatus (eReturnStatusFailed);
5033 return false;
5034 }
5035protected:
5036 OptionGroupOptions m_option_group;
5037 OptionGroupUInt64 m_num_packets;
5038 OptionGroupUInt64 m_max_send;
5039 OptionGroupUInt64 m_max_recv;
5040 OptionGroupBoolean m_json;
Eugene Zelenko0722f082015-10-24 01:28:05 +00005041
Greg Claytone034a042015-05-21 20:52:06 +00005042};
5043
Greg Clayton02686b82012-10-15 22:42:16 +00005044class CommandObjectProcessGDBRemotePacketHistory : public CommandObjectParsed
Greg Clayton998255b2012-10-13 02:07:45 +00005045{
Eugene Zelenko0722f082015-10-24 01:28:05 +00005046private:
Ed Maste81b4c5f2016-01-04 01:43:47 +00005047
Greg Clayton998255b2012-10-13 02:07:45 +00005048public:
Greg Clayton02686b82012-10-15 22:42:16 +00005049 CommandObjectProcessGDBRemotePacketHistory(CommandInterpreter &interpreter) :
Greg Clayton998255b2012-10-13 02:07:45 +00005050 CommandObjectParsed (interpreter,
Greg Clayton02686b82012-10-15 22:42:16 +00005051 "process plugin packet history",
5052 "Dumps the packet history buffer. ",
Greg Clayton998255b2012-10-13 02:07:45 +00005053 NULL)
5054 {
5055 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005056
Eugene Zelenko0722f082015-10-24 01:28:05 +00005057 ~CommandObjectProcessGDBRemotePacketHistory ()
5058 {
5059 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005060
Greg Clayton998255b2012-10-13 02:07:45 +00005061 bool
Tamas Berghammer30b8cd32015-03-23 15:50:03 +00005062 DoExecute (Args& command, CommandReturnObject &result) override
Greg Clayton998255b2012-10-13 02:07:45 +00005063 {
Greg Clayton02686b82012-10-15 22:42:16 +00005064 const size_t argc = command.GetArgumentCount();
5065 if (argc == 0)
5066 {
5067 ProcessGDBRemote *process = (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
5068 if (process)
5069 {
5070 process->GetGDBRemote().DumpHistory(result.GetOutputStream());
5071 result.SetStatus (eReturnStatusSuccessFinishResult);
5072 return true;
5073 }
5074 }
5075 else
5076 {
5077 result.AppendErrorWithFormat ("'%s' takes no arguments", m_cmd_name.c_str());
5078 }
5079 result.SetStatus (eReturnStatusFailed);
5080 return false;
5081 }
5082};
5083
Jason Molenda6076bf42014-05-06 04:34:52 +00005084class CommandObjectProcessGDBRemotePacketXferSize : public CommandObjectParsed
5085{
Eugene Zelenko0722f082015-10-24 01:28:05 +00005086private:
Ed Maste81b4c5f2016-01-04 01:43:47 +00005087
Jason Molenda6076bf42014-05-06 04:34:52 +00005088public:
5089 CommandObjectProcessGDBRemotePacketXferSize(CommandInterpreter &interpreter) :
5090 CommandObjectParsed (interpreter,
5091 "process plugin packet xfer-size",
5092 "Maximum size that lldb will try to read/write one one chunk.",
5093 NULL)
5094 {
5095 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005096
Eugene Zelenko0722f082015-10-24 01:28:05 +00005097 ~CommandObjectProcessGDBRemotePacketXferSize ()
5098 {
5099 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005100
Jason Molenda6076bf42014-05-06 04:34:52 +00005101 bool
Tamas Berghammer30b8cd32015-03-23 15:50:03 +00005102 DoExecute (Args& command, CommandReturnObject &result) override
Jason Molenda6076bf42014-05-06 04:34:52 +00005103 {
5104 const size_t argc = command.GetArgumentCount();
5105 if (argc == 0)
5106 {
5107 result.AppendErrorWithFormat ("'%s' takes an argument to specify the max amount to be transferred when reading/writing", m_cmd_name.c_str());
5108 result.SetStatus (eReturnStatusFailed);
5109 return false;
5110 }
5111
5112 ProcessGDBRemote *process = (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
5113 if (process)
5114 {
5115 const char *packet_size = command.GetArgumentAtIndex(0);
5116 errno = 0;
5117 uint64_t user_specified_max = strtoul (packet_size, NULL, 10);
5118 if (errno == 0 && user_specified_max != 0)
5119 {
5120 process->SetUserSpecifiedMaxMemoryTransferSize (user_specified_max);
5121 result.SetStatus (eReturnStatusSuccessFinishResult);
5122 return true;
5123 }
5124 }
5125 result.SetStatus (eReturnStatusFailed);
5126 return false;
5127 }
5128};
5129
Eugene Zelenko0722f082015-10-24 01:28:05 +00005130
Greg Clayton02686b82012-10-15 22:42:16 +00005131class CommandObjectProcessGDBRemotePacketSend : public CommandObjectParsed
5132{
Eugene Zelenko0722f082015-10-24 01:28:05 +00005133private:
Ed Maste81b4c5f2016-01-04 01:43:47 +00005134
Greg Clayton02686b82012-10-15 22:42:16 +00005135public:
5136 CommandObjectProcessGDBRemotePacketSend(CommandInterpreter &interpreter) :
5137 CommandObjectParsed (interpreter,
5138 "process plugin packet send",
5139 "Send a custom packet through the GDB remote protocol and print the answer. "
5140 "The packet header and footer will automatically be added to the packet prior to sending and stripped from the result.",
5141 NULL)
5142 {
5143 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005144
Eugene Zelenko0722f082015-10-24 01:28:05 +00005145 ~CommandObjectProcessGDBRemotePacketSend ()
5146 {
5147 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005148
Greg Clayton02686b82012-10-15 22:42:16 +00005149 bool
Tamas Berghammer30b8cd32015-03-23 15:50:03 +00005150 DoExecute (Args& command, CommandReturnObject &result) override
Greg Clayton02686b82012-10-15 22:42:16 +00005151 {
5152 const size_t argc = command.GetArgumentCount();
5153 if (argc == 0)
5154 {
5155 result.AppendErrorWithFormat ("'%s' takes a one or more packet content arguments", m_cmd_name.c_str());
5156 result.SetStatus (eReturnStatusFailed);
5157 return false;
5158 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005159
Greg Clayton02686b82012-10-15 22:42:16 +00005160 ProcessGDBRemote *process = (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
5161 if (process)
5162 {
Han Ming Ong84145852012-11-26 20:42:03 +00005163 for (size_t i=0; i<argc; ++ i)
Greg Clayton02686b82012-10-15 22:42:16 +00005164 {
Han Ming Ong84145852012-11-26 20:42:03 +00005165 const char *packet_cstr = command.GetArgumentAtIndex(0);
5166 bool send_async = true;
5167 StringExtractorGDBRemote response;
5168 process->GetGDBRemote().SendPacketAndWaitForResponse(packet_cstr, response, send_async);
5169 result.SetStatus (eReturnStatusSuccessFinishResult);
5170 Stream &output_strm = result.GetOutputStream();
5171 output_strm.Printf (" packet: %s\n", packet_cstr);
Han Ming Ong4b6459f2013-01-18 23:11:53 +00005172 std::string &response_str = response.GetStringRef();
Ed Maste81b4c5f2016-01-04 01:43:47 +00005173
Han Ming Ong399289e2013-06-21 19:56:59 +00005174 if (strstr(packet_cstr, "qGetProfileData") != NULL)
Han Ming Ong4b6459f2013-01-18 23:11:53 +00005175 {
5176 response_str = process->GetGDBRemote().HarmonizeThreadIdsForProfileData(process, response);
5177 }
5178
Han Ming Ong84145852012-11-26 20:42:03 +00005179 if (response_str.empty())
5180 output_strm.PutCString ("response: \nerror: UNIMPLEMENTED\n");
5181 else
5182 output_strm.Printf ("response: %s\n", response.GetStringRef().c_str());
Greg Clayton02686b82012-10-15 22:42:16 +00005183 }
Greg Clayton02686b82012-10-15 22:42:16 +00005184 }
Greg Clayton998255b2012-10-13 02:07:45 +00005185 return true;
5186 }
5187};
5188
Greg Claytonba4a0a52013-02-01 23:03:47 +00005189class CommandObjectProcessGDBRemotePacketMonitor : public CommandObjectRaw
5190{
Eugene Zelenko0722f082015-10-24 01:28:05 +00005191private:
Ed Maste81b4c5f2016-01-04 01:43:47 +00005192
Greg Claytonba4a0a52013-02-01 23:03:47 +00005193public:
5194 CommandObjectProcessGDBRemotePacketMonitor(CommandInterpreter &interpreter) :
5195 CommandObjectRaw (interpreter,
5196 "process plugin packet monitor",
Greg Claytoneee5e982013-02-14 18:39:30 +00005197 "Send a qRcmd packet through the GDB remote protocol and print the response."
5198 "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 +00005199 NULL)
5200 {
5201 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005202
Eugene Zelenko0722f082015-10-24 01:28:05 +00005203 ~CommandObjectProcessGDBRemotePacketMonitor ()
5204 {
5205 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005206
Greg Claytonba4a0a52013-02-01 23:03:47 +00005207 bool
Tamas Berghammer30b8cd32015-03-23 15:50:03 +00005208 DoExecute (const char *command, CommandReturnObject &result) override
Greg Claytonba4a0a52013-02-01 23:03:47 +00005209 {
5210 if (command == NULL || command[0] == '\0')
5211 {
5212 result.AppendErrorWithFormat ("'%s' takes a command string argument", m_cmd_name.c_str());
5213 result.SetStatus (eReturnStatusFailed);
5214 return false;
5215 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005216
Greg Claytonba4a0a52013-02-01 23:03:47 +00005217 ProcessGDBRemote *process = (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
5218 if (process)
5219 {
5220 StreamString packet;
Greg Claytoneee5e982013-02-14 18:39:30 +00005221 packet.PutCString("qRcmd,");
Greg Claytonba4a0a52013-02-01 23:03:47 +00005222 packet.PutBytesAsRawHex8(command, strlen(command));
5223 const char *packet_cstr = packet.GetString().c_str();
Ed Maste81b4c5f2016-01-04 01:43:47 +00005224
Greg Claytonba4a0a52013-02-01 23:03:47 +00005225 bool send_async = true;
5226 StringExtractorGDBRemote response;
5227 process->GetGDBRemote().SendPacketAndWaitForResponse(packet_cstr, response, send_async);
5228 result.SetStatus (eReturnStatusSuccessFinishResult);
5229 Stream &output_strm = result.GetOutputStream();
5230 output_strm.Printf (" packet: %s\n", packet_cstr);
5231 const std::string &response_str = response.GetStringRef();
Ed Maste81b4c5f2016-01-04 01:43:47 +00005232
Greg Claytonba4a0a52013-02-01 23:03:47 +00005233 if (response_str.empty())
5234 output_strm.PutCString ("response: \nerror: UNIMPLEMENTED\n");
5235 else
5236 output_strm.Printf ("response: %s\n", response.GetStringRef().c_str());
5237 }
5238 return true;
5239 }
5240};
5241
Greg Clayton02686b82012-10-15 22:42:16 +00005242class CommandObjectProcessGDBRemotePacket : public CommandObjectMultiword
5243{
Eugene Zelenko0722f082015-10-24 01:28:05 +00005244private:
Ed Maste81b4c5f2016-01-04 01:43:47 +00005245
Greg Clayton02686b82012-10-15 22:42:16 +00005246public:
5247 CommandObjectProcessGDBRemotePacket(CommandInterpreter &interpreter) :
5248 CommandObjectMultiword (interpreter,
5249 "process plugin packet",
5250 "Commands that deal with GDB remote packets.",
5251 NULL)
5252 {
5253 LoadSubCommand ("history", CommandObjectSP (new CommandObjectProcessGDBRemotePacketHistory (interpreter)));
5254 LoadSubCommand ("send", CommandObjectSP (new CommandObjectProcessGDBRemotePacketSend (interpreter)));
Greg Claytonba4a0a52013-02-01 23:03:47 +00005255 LoadSubCommand ("monitor", CommandObjectSP (new CommandObjectProcessGDBRemotePacketMonitor (interpreter)));
Jason Molenda6076bf42014-05-06 04:34:52 +00005256 LoadSubCommand ("xfer-size", CommandObjectSP (new CommandObjectProcessGDBRemotePacketXferSize (interpreter)));
Greg Claytone034a042015-05-21 20:52:06 +00005257 LoadSubCommand ("speed-test", CommandObjectSP (new CommandObjectProcessGDBRemoteSpeedTest (interpreter)));
Greg Clayton02686b82012-10-15 22:42:16 +00005258 }
Ed Maste81b4c5f2016-01-04 01:43:47 +00005259
Eugene Zelenko0722f082015-10-24 01:28:05 +00005260 ~CommandObjectProcessGDBRemotePacket ()
5261 {
Ed Maste81b4c5f2016-01-04 01:43:47 +00005262 }
Greg Clayton02686b82012-10-15 22:42:16 +00005263};
Greg Clayton998255b2012-10-13 02:07:45 +00005264
5265class CommandObjectMultiwordProcessGDBRemote : public CommandObjectMultiword
5266{
5267public:
5268 CommandObjectMultiwordProcessGDBRemote (CommandInterpreter &interpreter) :
5269 CommandObjectMultiword (interpreter,
5270 "process plugin",
5271 "A set of commands for operating on a ProcessGDBRemote process.",
5272 "process plugin <subcommand> [<subcommand-options>]")
5273 {
5274 LoadSubCommand ("packet", CommandObjectSP (new CommandObjectProcessGDBRemotePacket (interpreter)));
5275 }
5276
Eugene Zelenko0722f082015-10-24 01:28:05 +00005277 ~CommandObjectMultiwordProcessGDBRemote ()
5278 {
5279 }
Greg Clayton998255b2012-10-13 02:07:45 +00005280};
5281
Greg Clayton998255b2012-10-13 02:07:45 +00005282CommandObject *
5283ProcessGDBRemote::GetPluginCommandObject()
5284{
5285 if (!m_command_sp)
5286 m_command_sp.reset (new CommandObjectMultiwordProcessGDBRemote (GetTarget().GetDebugger().GetCommandInterpreter()));
5287 return m_command_sp.get();
5288}