blob: c11de4fd8bd4017183b47531e8f0f875c33e5e0c [file] [log] [blame]
Chris Lattner24943d22010-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
10// C Includes
11#include <errno.h>
Chris Lattner24943d22010-06-08 16:52:24 +000012#include <spawn.h>
Chris Lattner24943d22010-06-08 16:52:24 +000013#include <sys/types.h>
Chris Lattner24943d22010-06-08 16:52:24 +000014#include <sys/stat.h>
Chris Lattner24943d22010-06-08 16:52:24 +000015
16// C++ Includes
17#include <algorithm>
18#include <map>
19
20// Other libraries and framework includes
21
22#include "lldb/Breakpoint/WatchpointLocation.h"
Jim Ingham84cdc152010-06-15 19:49:27 +000023#include "lldb/Interpreter/Args.h"
Chris Lattner24943d22010-06-08 16:52:24 +000024#include "lldb/Core/ArchSpec.h"
25#include "lldb/Core/Debugger.h"
26#include "lldb/Core/ConnectionFileDescriptor.h"
27#include "lldb/Core/FileSpec.h"
28#include "lldb/Core/InputReader.h"
29#include "lldb/Core/Module.h"
30#include "lldb/Core/PluginManager.h"
31#include "lldb/Core/State.h"
32#include "lldb/Core/StreamString.h"
33#include "lldb/Core/Timer.h"
34#include "lldb/Host/TimeValue.h"
35#include "lldb/Symbol/ObjectFile.h"
36#include "lldb/Target/DynamicLoader.h"
37#include "lldb/Target/Target.h"
38#include "lldb/Target/TargetList.h"
Jason Molendadea5ea72010-06-09 21:28:42 +000039#include "lldb/Utility/PseudoTerminal.h"
Chris Lattner24943d22010-06-08 16:52:24 +000040
41// Project includes
42#include "lldb/Host/Host.h"
Greg Clayton54e7afa2010-07-09 20:39:50 +000043#include "Utility/StringExtractorGDBRemote.h"
Chris Lattner24943d22010-06-08 16:52:24 +000044#include "GDBRemoteRegisterContext.h"
45#include "ProcessGDBRemote.h"
46#include "ProcessGDBRemoteLog.h"
47#include "ThreadGDBRemote.h"
Chris Lattner24943d22010-06-08 16:52:24 +000048#include "MacOSXLibunwindCallbacks.h"
Greg Clayton643ee732010-08-04 01:40:35 +000049#include "StopInfoMachException.h"
50
Chris Lattner24943d22010-06-08 16:52:24 +000051
Chris Lattner24943d22010-06-08 16:52:24 +000052
53#define DEBUGSERVER_BASENAME "debugserver"
54using namespace lldb;
55using namespace lldb_private;
56
57static inline uint16_t
58get_random_port ()
59{
60 return (arc4random() % (UINT16_MAX - 1000u)) + 1000u;
61}
62
63
64const char *
65ProcessGDBRemote::GetPluginNameStatic()
66{
67 return "process.gdb-remote";
68}
69
70const char *
71ProcessGDBRemote::GetPluginDescriptionStatic()
72{
73 return "GDB Remote protocol based debugging plug-in.";
74}
75
76void
77ProcessGDBRemote::Terminate()
78{
79 PluginManager::UnregisterPlugin (ProcessGDBRemote::CreateInstance);
80}
81
82
83Process*
84ProcessGDBRemote::CreateInstance (Target &target, Listener &listener)
85{
86 return new ProcessGDBRemote (target, listener);
87}
88
89bool
90ProcessGDBRemote::CanDebug(Target &target)
91{
92 // For now we are just making sure the file exists for a given module
93 ModuleSP exe_module_sp(target.GetExecutableModule());
94 if (exe_module_sp.get())
95 return exe_module_sp->GetFileSpec().Exists();
Jim Ingham7508e732010-08-09 23:31:02 +000096 // However, if there is no executable module, we return true since we might be preparing to attach.
97 return true;
Chris Lattner24943d22010-06-08 16:52:24 +000098}
99
100//----------------------------------------------------------------------
101// ProcessGDBRemote constructor
102//----------------------------------------------------------------------
103ProcessGDBRemote::ProcessGDBRemote(Target& target, Listener &listener) :
104 Process (target, listener),
105 m_dynamic_loader_ap (),
Chris Lattner24943d22010-06-08 16:52:24 +0000106 m_flags (0),
107 m_stdio_communication ("gdb-remote.stdio"),
108 m_stdio_mutex (Mutex::eMutexTypeRecursive),
109 m_stdout_data (),
Greg Clayton54e7afa2010-07-09 20:39:50 +0000110 m_byte_order (eByteOrderHost),
Chris Lattner24943d22010-06-08 16:52:24 +0000111 m_gdb_comm(),
112 m_debugserver_pid (LLDB_INVALID_PROCESS_ID),
Greg Clayton75ccf502010-08-21 02:22:51 +0000113 m_debugserver_thread (LLDB_INVALID_HOST_THREAD),
Greg Clayton54e7afa2010-07-09 20:39:50 +0000114 m_last_stop_packet (),
Chris Lattner24943d22010-06-08 16:52:24 +0000115 m_register_info (),
Chris Lattner24943d22010-06-08 16:52:24 +0000116 m_async_broadcaster ("lldb.process.gdb-remote.async-broadcaster"),
117 m_async_thread (LLDB_INVALID_HOST_THREAD),
Greg Clayton54e7afa2010-07-09 20:39:50 +0000118 m_curr_tid (LLDB_INVALID_THREAD_ID),
119 m_curr_tid_run (LLDB_INVALID_THREAD_ID),
Chris Lattner24943d22010-06-08 16:52:24 +0000120 m_z0_supported (1),
121 m_continue_packet(),
122 m_dispatch_queue_offsets_addr (LLDB_INVALID_ADDRESS),
Greg Clayton54e7afa2010-07-09 20:39:50 +0000123 m_packet_timeout (1),
124 m_max_memory_size (512),
Chris Lattner24943d22010-06-08 16:52:24 +0000125 m_libunwind_target_type (UNW_TARGET_UNSPECIFIED),
126 m_libunwind_addr_space (NULL),
Jim Ingham7508e732010-08-09 23:31:02 +0000127 m_waiting_for_attach (false),
128 m_local_debugserver (true)
Chris Lattner24943d22010-06-08 16:52:24 +0000129{
130}
131
132//----------------------------------------------------------------------
133// Destructor
134//----------------------------------------------------------------------
135ProcessGDBRemote::~ProcessGDBRemote()
136{
Greg Clayton75ccf502010-08-21 02:22:51 +0000137 if (m_debugserver_thread != LLDB_INVALID_HOST_THREAD)
138 {
139 Host::ThreadCancel (m_debugserver_thread, NULL);
140 thread_result_t thread_result;
141 Host::ThreadJoin (m_debugserver_thread, &thread_result, NULL);
142 m_debugserver_thread = LLDB_INVALID_HOST_THREAD;
143 }
Chris Lattner24943d22010-06-08 16:52:24 +0000144 // m_mach_process.UnregisterNotificationCallbacks (this);
145 Clear();
146}
147
148//----------------------------------------------------------------------
149// PluginInterface
150//----------------------------------------------------------------------
151const char *
152ProcessGDBRemote::GetPluginName()
153{
154 return "Process debugging plug-in that uses the GDB remote protocol";
155}
156
157const char *
158ProcessGDBRemote::GetShortPluginName()
159{
160 return GetPluginNameStatic();
161}
162
163uint32_t
164ProcessGDBRemote::GetPluginVersion()
165{
166 return 1;
167}
168
169void
170ProcessGDBRemote::GetPluginCommandHelp (const char *command, Stream *strm)
171{
172 strm->Printf("TODO: fill this in\n");
173}
174
175Error
176ProcessGDBRemote::ExecutePluginCommand (Args &command, Stream *strm)
177{
178 Error error;
179 error.SetErrorString("No plug-in commands are currently supported.");
180 return error;
181}
182
183Log *
184ProcessGDBRemote::EnablePluginLogging (Stream *strm, Args &command)
185{
186 return NULL;
187}
188
189void
190ProcessGDBRemote::BuildDynamicRegisterInfo ()
191{
192 char register_info_command[64];
193 m_register_info.Clear();
194 StringExtractorGDBRemote::Type packet_type = StringExtractorGDBRemote::eResponse;
195 uint32_t reg_offset = 0;
196 uint32_t reg_num = 0;
197 for (; packet_type == StringExtractorGDBRemote::eResponse; ++reg_num)
198 {
199 ::snprintf (register_info_command, sizeof(register_info_command), "qRegisterInfo%x", reg_num);
200 StringExtractorGDBRemote response;
201 if (m_gdb_comm.SendPacketAndWaitForResponse(register_info_command, response, 2, false))
202 {
203 packet_type = response.GetType();
204 if (packet_type == StringExtractorGDBRemote::eResponse)
205 {
206 std::string name;
207 std::string value;
208 ConstString reg_name;
209 ConstString alt_name;
210 ConstString set_name;
211 RegisterInfo reg_info = { NULL, // Name
212 NULL, // Alt name
213 0, // byte size
214 reg_offset, // offset
215 eEncodingUint, // encoding
216 eFormatHex, // formate
Chris Lattner24943d22010-06-08 16:52:24 +0000217 {
218 LLDB_INVALID_REGNUM, // GCC reg num
219 LLDB_INVALID_REGNUM, // DWARF reg num
220 LLDB_INVALID_REGNUM, // generic reg num
Jason Molenda3a4ea242010-09-10 07:49:16 +0000221 reg_num, // GDB reg num
222 reg_num // native register number
Chris Lattner24943d22010-06-08 16:52:24 +0000223 }
224 };
225
226 while (response.GetNameColonValue(name, value))
227 {
228 if (name.compare("name") == 0)
229 {
230 reg_name.SetCString(value.c_str());
231 }
232 else if (name.compare("alt-name") == 0)
233 {
234 alt_name.SetCString(value.c_str());
235 }
236 else if (name.compare("bitsize") == 0)
237 {
238 reg_info.byte_size = Args::StringToUInt32(value.c_str(), 0, 0) / CHAR_BIT;
239 }
240 else if (name.compare("offset") == 0)
241 {
242 uint32_t offset = Args::StringToUInt32(value.c_str(), UINT32_MAX, 0);
Jason Molenda53d96862010-06-11 23:44:18 +0000243 if (reg_offset != offset)
Chris Lattner24943d22010-06-08 16:52:24 +0000244 {
245 reg_offset = offset;
Chris Lattner24943d22010-06-08 16:52:24 +0000246 }
247 }
248 else if (name.compare("encoding") == 0)
249 {
250 if (value.compare("uint") == 0)
251 reg_info.encoding = eEncodingUint;
252 else if (value.compare("sint") == 0)
253 reg_info.encoding = eEncodingSint;
254 else if (value.compare("ieee754") == 0)
255 reg_info.encoding = eEncodingIEEE754;
256 else if (value.compare("vector") == 0)
257 reg_info.encoding = eEncodingVector;
258 }
259 else if (name.compare("format") == 0)
260 {
261 if (value.compare("binary") == 0)
262 reg_info.format = eFormatBinary;
263 else if (value.compare("decimal") == 0)
264 reg_info.format = eFormatDecimal;
265 else if (value.compare("hex") == 0)
266 reg_info.format = eFormatHex;
267 else if (value.compare("float") == 0)
268 reg_info.format = eFormatFloat;
269 else if (value.compare("vector-sint8") == 0)
270 reg_info.format = eFormatVectorOfSInt8;
271 else if (value.compare("vector-uint8") == 0)
272 reg_info.format = eFormatVectorOfUInt8;
273 else if (value.compare("vector-sint16") == 0)
274 reg_info.format = eFormatVectorOfSInt16;
275 else if (value.compare("vector-uint16") == 0)
276 reg_info.format = eFormatVectorOfUInt16;
277 else if (value.compare("vector-sint32") == 0)
278 reg_info.format = eFormatVectorOfSInt32;
279 else if (value.compare("vector-uint32") == 0)
280 reg_info.format = eFormatVectorOfUInt32;
281 else if (value.compare("vector-float32") == 0)
282 reg_info.format = eFormatVectorOfFloat32;
283 else if (value.compare("vector-uint128") == 0)
284 reg_info.format = eFormatVectorOfUInt128;
285 }
286 else if (name.compare("set") == 0)
287 {
288 set_name.SetCString(value.c_str());
289 }
290 else if (name.compare("gcc") == 0)
291 {
292 reg_info.kinds[eRegisterKindGCC] = Args::StringToUInt32(value.c_str(), LLDB_INVALID_REGNUM, 0);
293 }
294 else if (name.compare("dwarf") == 0)
295 {
296 reg_info.kinds[eRegisterKindDWARF] = Args::StringToUInt32(value.c_str(), LLDB_INVALID_REGNUM, 0);
297 }
298 else if (name.compare("generic") == 0)
299 {
300 if (value.compare("pc") == 0)
301 reg_info.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_PC;
302 else if (value.compare("sp") == 0)
303 reg_info.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_SP;
304 else if (value.compare("fp") == 0)
305 reg_info.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_FP;
306 else if (value.compare("ra") == 0)
307 reg_info.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_RA;
308 else if (value.compare("flags") == 0)
309 reg_info.kinds[eRegisterKindGeneric] = LLDB_REGNUM_GENERIC_FLAGS;
310 }
311 }
312
Jason Molenda53d96862010-06-11 23:44:18 +0000313 reg_info.byte_offset = reg_offset;
Chris Lattner24943d22010-06-08 16:52:24 +0000314 assert (reg_info.byte_size != 0);
315 reg_offset += reg_info.byte_size;
316 m_register_info.AddRegister(reg_info, reg_name, alt_name, set_name);
317 }
318 }
319 else
320 {
321 packet_type = StringExtractorGDBRemote::eError;
322 }
323 }
324
325 if (reg_num == 0)
326 {
327 // We didn't get anything. See if we are debugging ARM and fill with
328 // a hard coded register set until we can get an updated debugserver
329 // down on the devices.
330 ArchSpec arm_arch ("arm");
331 if (GetTarget().GetArchitecture() == arm_arch)
332 m_register_info.HardcodeARMRegisters();
333 }
334 m_register_info.Finalize ();
335}
336
337Error
338ProcessGDBRemote::WillLaunch (Module* module)
339{
340 return WillLaunchOrAttach ();
341}
342
343Error
344ProcessGDBRemote::WillAttach (lldb::pid_t pid)
345{
346 return WillLaunchOrAttach ();
347}
348
349Error
350ProcessGDBRemote::WillAttach (const char *process_name, bool wait_for_launch)
351{
352 return WillLaunchOrAttach ();
353}
354
355Error
356ProcessGDBRemote::WillLaunchOrAttach ()
357{
358 Error error;
359 // TODO: this is hardcoded for macosx right now. We need this to be more dynamic
360 m_dynamic_loader_ap.reset(DynamicLoader::FindPlugin(this, "dynamic-loader.macosx-dyld"));
361
362 if (m_dynamic_loader_ap.get() == NULL)
363 error.SetErrorString("unable to find the dynamic loader named 'dynamic-loader.macosx-dyld'");
364 m_stdio_communication.Clear ();
365
366 return error;
367}
368
369//----------------------------------------------------------------------
370// Process Control
371//----------------------------------------------------------------------
372Error
373ProcessGDBRemote::DoLaunch
374(
375 Module* module,
376 char const *argv[],
377 char const *envp[],
Greg Clayton452bf612010-08-31 18:35:14 +0000378 uint32_t launch_flags,
Chris Lattner24943d22010-06-08 16:52:24 +0000379 const char *stdin_path,
380 const char *stdout_path,
381 const char *stderr_path
382)
383{
384 // ::LogSetBitMask (GDBR_LOG_DEFAULT);
385 // ::LogSetOptions (LLDB_LOG_OPTION_THREADSAFE | LLDB_LOG_OPTION_PREPEND_TIMESTAMP | LLDB_LOG_OPTION_PREPEND_PROC_AND_THREAD);
386 // ::LogSetLogFile ("/dev/stdout");
387 Error error;
388
389 ObjectFile * object_file = module->GetObjectFile();
390 if (object_file)
391 {
392 ArchSpec inferior_arch(module->GetArchitecture());
393 char host_port[128];
394 snprintf (host_port, sizeof(host_port), "localhost:%u", get_random_port ());
395
396 bool start_debugserver_with_inferior_args = false;
397 if (start_debugserver_with_inferior_args)
398 {
399 // We want to launch debugserver with the inferior program and its
400 // arguments on the command line. We should only do this if we
401 // the GDB server we are talking to doesn't support the 'A' packet.
402 error = StartDebugserverProcess (host_port,
403 argv,
404 envp,
405 NULL, //stdin_path,
406 LLDB_INVALID_PROCESS_ID,
407 NULL, false,
Benjamin Kramer2653be92010-09-03 18:20:07 +0000408 (launch_flags & eLaunchFlagDisableASLR) != 0,
Chris Lattner24943d22010-06-08 16:52:24 +0000409 inferior_arch);
410 if (error.Fail())
411 return error;
412
413 error = ConnectToDebugserver (host_port);
414 if (error.Success())
415 {
416 SetID (m_gdb_comm.GetCurrentProcessID (m_packet_timeout));
417 }
418 }
419 else
420 {
421 error = StartDebugserverProcess (host_port,
422 NULL,
423 NULL,
424 NULL, //stdin_path,
425 LLDB_INVALID_PROCESS_ID,
426 NULL, false,
Benjamin Kramer2653be92010-09-03 18:20:07 +0000427 (launch_flags & eLaunchFlagDisableASLR) != 0,
Chris Lattner24943d22010-06-08 16:52:24 +0000428 inferior_arch);
429 if (error.Fail())
430 return error;
431
432 error = ConnectToDebugserver (host_port);
433 if (error.Success())
434 {
435 // Send the environment and the program + arguments after we connect
436 if (envp)
437 {
438 const char *env_entry;
439 for (int i=0; (env_entry = envp[i]); ++i)
440 {
441 if (m_gdb_comm.SendEnvironmentPacket(env_entry, m_packet_timeout) != 0)
442 break;
443 }
444 }
445
Greg Clayton960d6a42010-08-03 00:35:52 +0000446 // FIXME: convert this to use the new set/show variables when they are available
447#if 0
448 if (::getenv ("LLDB_DEBUG_DEBUGSERVER"))
449 {
450 const uint32_t attach_debugserver_secs = 10;
451 ::printf ("attach to debugserver (pid = %i)\n", m_debugserver_pid);
452 for (uint32_t i=0; i<attach_debugserver_secs; ++i)
453 {
454 printf ("%i\n", attach_debugserver_secs - i);
455 sleep (1);
456 }
457 }
458#endif
459
Chris Lattner24943d22010-06-08 16:52:24 +0000460 const uint32_t arg_timeout_seconds = 10;
461 int arg_packet_err = m_gdb_comm.SendArgumentsPacket (argv, arg_timeout_seconds);
462 if (arg_packet_err == 0)
463 {
464 std::string error_str;
465 if (m_gdb_comm.GetLaunchSuccess (m_packet_timeout, error_str))
466 {
467 SetID (m_gdb_comm.GetCurrentProcessID (m_packet_timeout));
468 }
469 else
470 {
471 error.SetErrorString (error_str.c_str());
472 }
473 }
474 else
475 {
476 error.SetErrorStringWithFormat("'A' packet returned an error: %i.\n", arg_packet_err);
477 }
478
479 SetID (m_gdb_comm.GetCurrentProcessID (m_packet_timeout));
480 }
481 }
482
483 if (GetID() == LLDB_INVALID_PROCESS_ID)
484 {
485 KillDebugserverProcess ();
486 return error;
487 }
488
489 StringExtractorGDBRemote response;
490 if (m_gdb_comm.SendPacketAndWaitForResponse("?", 1, response, m_packet_timeout, false))
491 SetPrivateState (SetThreadStopInfo (response));
492
493 }
494 else
495 {
496 // Set our user ID to an invalid process ID.
497 SetID(LLDB_INVALID_PROCESS_ID);
498 error.SetErrorStringWithFormat("Failed to get object file from '%s' for arch %s.\n", module->GetFileSpec().GetFilename().AsCString(), module->GetArchitecture().AsCString());
499 }
500
501 // Return the process ID we have
502 return error;
503}
504
505
506Error
507ProcessGDBRemote::ConnectToDebugserver (const char *host_port)
508{
509 Error error;
510 // Sleep and wait a bit for debugserver to start to listen...
511 std::auto_ptr<ConnectionFileDescriptor> conn_ap(new ConnectionFileDescriptor());
512 if (conn_ap.get())
513 {
514 std::string connect_url("connect://");
515 connect_url.append (host_port);
516 const uint32_t max_retry_count = 50;
517 uint32_t retry_count = 0;
518 while (!m_gdb_comm.IsConnected())
519 {
520 if (conn_ap->Connect(connect_url.c_str(), &error) == eConnectionStatusSuccess)
521 {
522 m_gdb_comm.SetConnection (conn_ap.release());
523 break;
524 }
525 retry_count++;
526
527 if (retry_count >= max_retry_count)
528 break;
529
530 usleep (100000);
531 }
532 }
533
534 if (!m_gdb_comm.IsConnected())
535 {
536 if (error.Success())
537 error.SetErrorString("not connected to remote gdb server");
538 return error;
539 }
540
541 m_gdb_comm.SetAckMode (true);
542 if (m_gdb_comm.StartReadThread(&error))
543 {
544 // Send an initial ack
545 m_gdb_comm.SendAck('+');
546
547 if (m_debugserver_pid != LLDB_INVALID_PROCESS_ID)
Greg Clayton75ccf502010-08-21 02:22:51 +0000548 m_debugserver_thread = Host::StartMonitoringChildProcess (MonitorDebugserverProcess,
549 this,
550 m_debugserver_pid,
551 false);
552
Chris Lattner24943d22010-06-08 16:52:24 +0000553 StringExtractorGDBRemote response;
554 if (m_gdb_comm.SendPacketAndWaitForResponse("QStartNoAckMode", response, 1, false))
555 {
556 if (response.IsOKPacket())
557 m_gdb_comm.SetAckMode (false);
558 }
559
560 BuildDynamicRegisterInfo ();
561 }
562 return error;
563}
564
565void
566ProcessGDBRemote::DidLaunchOrAttach ()
567{
568 ProcessGDBRemoteLog::LogIf (GDBR_LOG_PROCESS, "ProcessGDBRemote::DidLaunch()");
569 if (GetID() == LLDB_INVALID_PROCESS_ID)
570 {
571 m_dynamic_loader_ap.reset();
572 }
573 else
574 {
575 m_dispatch_queue_offsets_addr = LLDB_INVALID_ADDRESS;
576
Jim Ingham7508e732010-08-09 23:31:02 +0000577 Module * exe_module = GetTarget().GetExecutableModule ().get();
Chris Lattner24943d22010-06-08 16:52:24 +0000578 assert(exe_module);
579
Chris Lattner24943d22010-06-08 16:52:24 +0000580 ObjectFile *exe_objfile = exe_module->GetObjectFile();
581 assert(exe_objfile);
582
583 m_byte_order = exe_objfile->GetByteOrder();
584 assert (m_byte_order != eByteOrderInvalid);
585
586 StreamString strm;
587
588 ArchSpec inferior_arch;
589 // See if the GDB server supports the qHostInfo information
590 const char *vendor = m_gdb_comm.GetVendorString().AsCString();
591 const char *os_type = m_gdb_comm.GetOSString().AsCString();
Jim Ingham7508e732010-08-09 23:31:02 +0000592 ArchSpec arch_spec = GetTarget().GetArchitecture();
Chris Lattner24943d22010-06-08 16:52:24 +0000593
Jim Ingham7508e732010-08-09 23:31:02 +0000594 if (arch_spec.IsValid() && arch_spec == ArchSpec ("arm"))
Chris Lattner24943d22010-06-08 16:52:24 +0000595 {
596 // For ARM we can't trust the arch of the process as it could
597 // have an armv6 object file, but be running on armv7 kernel.
598 inferior_arch = m_gdb_comm.GetHostArchitecture();
599 }
600
601 if (!inferior_arch.IsValid())
Jim Ingham7508e732010-08-09 23:31:02 +0000602 inferior_arch = arch_spec;
Chris Lattner24943d22010-06-08 16:52:24 +0000603
604 if (vendor == NULL)
605 vendor = Host::GetVendorString().AsCString("apple");
606
607 if (os_type == NULL)
608 os_type = Host::GetOSString().AsCString("darwin");
609
610 strm.Printf ("%s-%s-%s", inferior_arch.AsCString(), vendor, os_type);
611
612 std::transform (strm.GetString().begin(),
613 strm.GetString().end(),
614 strm.GetString().begin(),
615 ::tolower);
616
617 m_target_triple.SetCString(strm.GetString().c_str());
618 }
619}
620
621void
622ProcessGDBRemote::DidLaunch ()
623{
624 DidLaunchOrAttach ();
625 if (m_dynamic_loader_ap.get())
626 m_dynamic_loader_ap->DidLaunch();
627}
628
629Error
Greg Clayton54e7afa2010-07-09 20:39:50 +0000630ProcessGDBRemote::DoAttachToProcessWithID (lldb::pid_t attach_pid)
Chris Lattner24943d22010-06-08 16:52:24 +0000631{
632 Error error;
633 // Clear out and clean up from any current state
634 Clear();
Jim Ingham7508e732010-08-09 23:31:02 +0000635 ArchSpec arch_spec = GetTarget().GetArchitecture();
636
Chris Lattner24943d22010-06-08 16:52:24 +0000637 //Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS);
Jim Ingham7508e732010-08-09 23:31:02 +0000638
639
Chris Lattner24943d22010-06-08 16:52:24 +0000640 if (attach_pid != LLDB_INVALID_PROCESS_ID)
641 {
642 SetPrivateState (eStateAttaching);
643 char host_port[128];
644 snprintf (host_port, sizeof(host_port), "localhost:%u", get_random_port ());
Greg Clayton452bf612010-08-31 18:35:14 +0000645 error = StartDebugserverProcess (host_port, // debugserver_url
646 NULL, // inferior_argv
647 NULL, // inferior_envp
648 NULL, // stdin_path
649 LLDB_INVALID_PROCESS_ID, // attach_pid
650 NULL, // attach_pid_name
651 false, // wait_for_launch
652 false, // disable_aslr
Jim Ingham7508e732010-08-09 23:31:02 +0000653 arch_spec);
Chris Lattner24943d22010-06-08 16:52:24 +0000654
655 if (error.Fail())
656 {
657 const char *error_string = error.AsCString();
658 if (error_string == NULL)
659 error_string = "unable to launch " DEBUGSERVER_BASENAME;
660
661 SetExitStatus (-1, error_string);
662 }
663 else
664 {
665 error = ConnectToDebugserver (host_port);
666 if (error.Success())
667 {
668 char packet[64];
669 const int packet_len = ::snprintf (packet, sizeof(packet), "vAttach;%x", attach_pid);
670 StringExtractorGDBRemote response;
671 StateType stop_state = m_gdb_comm.SendContinuePacketAndWaitForResponse (this,
672 packet,
673 packet_len,
674 response);
675 switch (stop_state)
676 {
677 case eStateStopped:
678 case eStateCrashed:
679 case eStateSuspended:
680 SetID (attach_pid);
681 m_last_stop_packet = response;
682 m_last_stop_packet.SetFilePos (0);
683 SetPrivateState (stop_state);
684 break;
685
686 case eStateExited:
687 m_last_stop_packet = response;
688 m_last_stop_packet.SetFilePos (0);
689 response.SetFilePos(1);
690 SetExitStatus(response.GetHexU8(), NULL);
691 break;
692
693 default:
694 SetExitStatus(-1, "unable to attach to process");
695 break;
696 }
697
698 }
699 }
700 }
701
702 lldb::pid_t pid = GetID();
703 if (pid == LLDB_INVALID_PROCESS_ID)
704 {
705 KillDebugserverProcess();
706 }
707 return error;
708}
709
710size_t
711ProcessGDBRemote::AttachInputReaderCallback
712(
713 void *baton,
714 InputReader *reader,
715 lldb::InputReaderAction notification,
716 const char *bytes,
717 size_t bytes_len
718)
719{
720 if (notification == eInputReaderGotToken)
721 {
722 ProcessGDBRemote *gdb_process = (ProcessGDBRemote *)baton;
723 if (gdb_process->m_waiting_for_attach)
724 gdb_process->m_waiting_for_attach = false;
725 reader->SetIsDone(true);
726 return 1;
727 }
728 return 0;
729}
730
731Error
Greg Clayton54e7afa2010-07-09 20:39:50 +0000732ProcessGDBRemote::DoAttachToProcessWithName (const char *process_name, bool wait_for_launch)
Chris Lattner24943d22010-06-08 16:52:24 +0000733{
734 Error error;
735 // Clear out and clean up from any current state
736 Clear();
737 // HACK: require arch be set correctly at the target level until we can
738 // figure out a good way to determine the arch of what we are attaching to
Chris Lattner24943d22010-06-08 16:52:24 +0000739
740 //Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS);
741 if (process_name && process_name[0])
742 {
743
744 SetPrivateState (eStateAttaching);
745 char host_port[128];
Jim Ingham7508e732010-08-09 23:31:02 +0000746 ArchSpec arch_spec = GetTarget().GetArchitecture();
Chris Lattner24943d22010-06-08 16:52:24 +0000747 snprintf (host_port, sizeof(host_port), "localhost:%u", get_random_port ());
Greg Clayton452bf612010-08-31 18:35:14 +0000748 error = StartDebugserverProcess (host_port, // debugserver_url
749 NULL, // inferior_argv
750 NULL, // inferior_envp
751 NULL, // stdin_path
752 LLDB_INVALID_PROCESS_ID, // attach_pid
753 NULL, // attach_pid_name
754 false, // wait_for_launch
755 false, // disable_aslr
Jim Ingham7508e732010-08-09 23:31:02 +0000756 arch_spec);
Chris Lattner24943d22010-06-08 16:52:24 +0000757 if (error.Fail())
758 {
759 const char *error_string = error.AsCString();
760 if (error_string == NULL)
761 error_string = "unable to launch " DEBUGSERVER_BASENAME;
762
763 SetExitStatus (-1, error_string);
764 }
765 else
766 {
767 error = ConnectToDebugserver (host_port);
768 if (error.Success())
769 {
770 StreamString packet;
771
772 packet.PutCString("vAttach");
773 if (wait_for_launch)
774 packet.PutCString("Wait");
775 packet.PutChar(';');
776 packet.PutBytesAsRawHex8(process_name, strlen(process_name), eByteOrderHost, eByteOrderHost);
777 StringExtractorGDBRemote response;
778 StateType stop_state = m_gdb_comm.SendContinuePacketAndWaitForResponse (this,
779 packet.GetData(),
780 packet.GetSize(),
781 response);
782 switch (stop_state)
783 {
784 case eStateStopped:
785 case eStateCrashed:
786 case eStateSuspended:
787 SetID (m_gdb_comm.GetCurrentProcessID(m_packet_timeout));
788 m_last_stop_packet = response;
789 m_last_stop_packet.SetFilePos (0);
790 SetPrivateState (stop_state);
791 break;
792
793 case eStateExited:
794 m_last_stop_packet = response;
795 m_last_stop_packet.SetFilePos (0);
796 response.SetFilePos(1);
797 SetExitStatus(response.GetHexU8(), NULL);
798 break;
799
800 default:
801 SetExitStatus(-1, "unable to attach to process");
802 break;
803 }
804 }
805 }
806 }
807
808 lldb::pid_t pid = GetID();
809 if (pid == LLDB_INVALID_PROCESS_ID)
810 {
811 KillDebugserverProcess();
812 }
813 return error;
814}
815
816//
817// if (wait_for_launch)
818// {
819// InputReaderSP reader_sp (new InputReader());
820// StreamString instructions;
821// instructions.Printf("Hit any key to cancel waiting for '%s' to launch...", process_name);
822// error = reader_sp->Initialize (AttachInputReaderCallback, // callback
823// this, // baton
824// eInputReaderGranularityByte,
825// NULL, // End token
826// false);
827//
828// StringExtractorGDBRemote response;
829// m_waiting_for_attach = true;
830// FILE *reader_out_fh = reader_sp->GetOutputFileHandle();
831// while (m_waiting_for_attach)
832// {
833// // Wait for one second for the stop reply packet
834// if (m_gdb_comm.WaitForPacket(response, 1))
835// {
836// // Got some sort of packet, see if it is the stop reply packet?
837// char ch = response.GetChar(0);
838// if (ch == 'T')
839// {
840// m_waiting_for_attach = false;
841// }
842// }
843// else
844// {
845// // Put a period character every second
846// fputc('.', reader_out_fh);
847// }
848// }
849// }
850// }
851// return GetID();
852//}
853
854void
855ProcessGDBRemote::DidAttach ()
856{
Jim Ingham7508e732010-08-09 23:31:02 +0000857 // If we haven't got an executable module yet, then we should make a dynamic loader, and
858 // see if it can find the executable module for us. If we do have an executable module,
859 // make sure it matches the process we've just attached to.
860
861 ModuleSP exe_module_sp = GetTarget().GetExecutableModule();
862 if (!m_dynamic_loader_ap.get())
863 {
864 m_dynamic_loader_ap.reset(DynamicLoader::FindPlugin(this, "dynamic-loader.macosx-dyld"));
865 }
866
Chris Lattner24943d22010-06-08 16:52:24 +0000867 if (m_dynamic_loader_ap.get())
868 m_dynamic_loader_ap->DidAttach();
Jim Ingham7508e732010-08-09 23:31:02 +0000869
870 Module * new_exe_module = GetTarget().GetExecutableModule().get();
871 if (new_exe_module == NULL)
872 {
873
874 }
875
876 DidLaunchOrAttach ();
Chris Lattner24943d22010-06-08 16:52:24 +0000877}
878
879Error
880ProcessGDBRemote::WillResume ()
881{
882 m_continue_packet.Clear();
883 // Start the continue packet we will use to run the target. Each thread
884 // will append what it is supposed to be doing to this packet when the
885 // ThreadList::WillResume() is called. If a thread it supposed
886 // to stay stopped, then don't append anything to this string.
887 m_continue_packet.Printf("vCont");
888 return Error();
889}
890
891Error
892ProcessGDBRemote::DoResume ()
893{
894 ProcessGDBRemoteLog::LogIf (GDBR_LOG_PROCESS, "ProcessGDBRemote::Resume()");
895 m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncContinue, new EventDataBytes (m_continue_packet.GetData(), m_continue_packet.GetSize()));
896 return Error();
897}
898
899size_t
900ProcessGDBRemote::GetSoftwareBreakpointTrapOpcode (BreakpointSite* bp_site)
901{
902 const uint8_t *trap_opcode = NULL;
903 uint32_t trap_opcode_size = 0;
904
905 static const uint8_t g_arm_breakpoint_opcode[] = { 0xFE, 0xDE, 0xFF, 0xE7 };
906 //static const uint8_t g_thumb_breakpooint_opcode[] = { 0xFE, 0xDE };
907 static const uint8_t g_ppc_breakpoint_opcode[] = { 0x7F, 0xC0, 0x00, 0x08 };
908 static const uint8_t g_i386_breakpoint_opcode[] = { 0xCC };
909
Jim Ingham7508e732010-08-09 23:31:02 +0000910 ArchSpec::CPU arch_cpu = GetTarget().GetArchitecture().GetGenericCPUType();
Greg Claytoncf015052010-06-11 03:25:34 +0000911 switch (arch_cpu)
Chris Lattner24943d22010-06-08 16:52:24 +0000912 {
Greg Claytoncf015052010-06-11 03:25:34 +0000913 case ArchSpec::eCPU_i386:
914 case ArchSpec::eCPU_x86_64:
915 trap_opcode = g_i386_breakpoint_opcode;
916 trap_opcode_size = sizeof(g_i386_breakpoint_opcode);
917 break;
918
919 case ArchSpec::eCPU_arm:
920 // TODO: fill this in for ARM. We need to dig up the symbol for
921 // the address in the breakpoint locaiton and figure out if it is
922 // an ARM or Thumb breakpoint.
923 trap_opcode = g_arm_breakpoint_opcode;
924 trap_opcode_size = sizeof(g_arm_breakpoint_opcode);
925 break;
926
927 case ArchSpec::eCPU_ppc:
928 case ArchSpec::eCPU_ppc64:
929 trap_opcode = g_ppc_breakpoint_opcode;
930 trap_opcode_size = sizeof(g_ppc_breakpoint_opcode);
931 break;
Chris Lattner24943d22010-06-08 16:52:24 +0000932
Greg Claytoncf015052010-06-11 03:25:34 +0000933 default:
934 assert(!"Unhandled architecture in ProcessMacOSX::GetSoftwareBreakpointTrapOpcode()");
935 break;
Chris Lattner24943d22010-06-08 16:52:24 +0000936 }
937
938 if (trap_opcode && trap_opcode_size)
939 {
940 if (bp_site->SetTrapOpcode(trap_opcode, trap_opcode_size))
941 return trap_opcode_size;
942 }
943 return 0;
944}
945
946uint32_t
947ProcessGDBRemote::UpdateThreadListIfNeeded ()
948{
949 // locker will keep a mutex locked until it goes out of scope
950 Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_THREAD);
951 if (log && log->GetMask().IsSet(GDBR_LOG_VERBOSE))
952 log->Printf ("ProcessGDBRemote::%s (pid = %i)", __FUNCTION__, GetID());
953
Greg Clayton5205f0b2010-09-03 17:10:42 +0000954 Mutex::Locker locker (m_thread_list.GetMutex ());
Chris Lattner24943d22010-06-08 16:52:24 +0000955 const uint32_t stop_id = GetStopID();
956 if (m_thread_list.GetSize(false) == 0 || stop_id != m_thread_list.GetStopID())
957 {
958 // Update the thread list's stop id immediately so we don't recurse into this function.
959 ThreadList curr_thread_list (this);
960 curr_thread_list.SetStopID(stop_id);
961
962 Error err;
963 StringExtractorGDBRemote response;
964 for (m_gdb_comm.SendPacketAndWaitForResponse("qfThreadInfo", response, 1, false);
965 response.IsNormalPacket();
966 m_gdb_comm.SendPacketAndWaitForResponse("qsThreadInfo", response, 1, false))
967 {
968 char ch = response.GetChar();
969 if (ch == 'l')
970 break;
971 if (ch == 'm')
972 {
973 do
974 {
975 tid_t tid = response.GetHexMaxU32(false, LLDB_INVALID_THREAD_ID);
976
977 if (tid != LLDB_INVALID_THREAD_ID)
978 {
979 ThreadSP thread_sp (GetThreadList().FindThreadByID (tid, false));
980 if (thread_sp)
981 thread_sp->GetRegisterContext()->Invalidate();
982 else
983 thread_sp.reset (new ThreadGDBRemote (*this, tid));
984 curr_thread_list.AddThread(thread_sp);
985 }
986
987 ch = response.GetChar();
988 } while (ch == ',');
989 }
990 }
991
992 m_thread_list = curr_thread_list;
993
994 SetThreadStopInfo (m_last_stop_packet);
995 }
996 return GetThreadList().GetSize(false);
997}
998
999
1000StateType
1001ProcessGDBRemote::SetThreadStopInfo (StringExtractor& stop_packet)
1002{
1003 const char stop_type = stop_packet.GetChar();
1004 switch (stop_type)
1005 {
1006 case 'T':
1007 case 'S':
1008 {
1009 // Stop with signal and thread info
1010 const uint8_t signo = stop_packet.GetHexU8();
1011 std::string name;
1012 std::string value;
1013 std::string thread_name;
1014 uint32_t exc_type = 0;
Greg Clayton7661a982010-07-23 16:45:51 +00001015 std::vector<addr_t> exc_data;
Chris Lattner24943d22010-06-08 16:52:24 +00001016 uint32_t tid = LLDB_INVALID_THREAD_ID;
1017 addr_t thread_dispatch_qaddr = LLDB_INVALID_ADDRESS;
1018 uint32_t exc_data_count = 0;
1019 while (stop_packet.GetNameColonValue(name, value))
1020 {
1021 if (name.compare("metype") == 0)
1022 {
1023 // exception type in big endian hex
1024 exc_type = Args::StringToUInt32 (value.c_str(), 0, 16);
1025 }
1026 else if (name.compare("mecount") == 0)
1027 {
1028 // exception count in big endian hex
1029 exc_data_count = Args::StringToUInt32 (value.c_str(), 0, 16);
1030 }
1031 else if (name.compare("medata") == 0)
1032 {
1033 // exception data in big endian hex
1034 exc_data.push_back(Args::StringToUInt64 (value.c_str(), 0, 16));
1035 }
1036 else if (name.compare("thread") == 0)
1037 {
1038 // thread in big endian hex
1039 tid = Args::StringToUInt32 (value.c_str(), 0, 16);
1040 }
1041 else if (name.compare("name") == 0)
1042 {
1043 thread_name.swap (value);
1044 }
Greg Clayton0a7f75f2010-09-09 06:32:46 +00001045 else if (name.compare("qaddr") == 0)
Chris Lattner24943d22010-06-08 16:52:24 +00001046 {
1047 thread_dispatch_qaddr = Args::StringToUInt64 (value.c_str(), 0, 16);
1048 }
1049 }
1050 ThreadSP thread_sp (m_thread_list.FindThreadByID(tid, false));
1051
1052 if (thread_sp)
1053 {
1054 ThreadGDBRemote *gdb_thread = static_cast<ThreadGDBRemote *> (thread_sp.get());
1055
1056 gdb_thread->SetThreadDispatchQAddr (thread_dispatch_qaddr);
1057 gdb_thread->SetName (thread_name.empty() ? thread_name.c_str() : NULL);
Chris Lattner24943d22010-06-08 16:52:24 +00001058 if (exc_type != 0)
1059 {
Greg Clayton643ee732010-08-04 01:40:35 +00001060 const size_t exc_data_count = exc_data.size();
1061
1062 gdb_thread->SetStopInfo (StopInfoMachException::CreateStopReasonWithMachException (*thread_sp,
1063 exc_type,
1064 exc_data_count,
1065 exc_data_count >= 1 ? exc_data[0] : 0,
1066 exc_data_count >= 2 ? exc_data[1] : 0));
Chris Lattner24943d22010-06-08 16:52:24 +00001067 }
1068 else if (signo)
1069 {
Greg Clayton643ee732010-08-04 01:40:35 +00001070 gdb_thread->SetStopInfo (StopInfo::CreateStopReasonWithSignal (*thread_sp, signo));
Chris Lattner24943d22010-06-08 16:52:24 +00001071 }
1072 else
1073 {
Greg Clayton643ee732010-08-04 01:40:35 +00001074 StopInfoSP invalid_stop_info_sp;
1075 gdb_thread->SetStopInfo (invalid_stop_info_sp);
Chris Lattner24943d22010-06-08 16:52:24 +00001076 }
1077 }
1078 return eStateStopped;
1079 }
1080 break;
1081
1082 case 'W':
1083 // process exited
1084 return eStateExited;
1085
1086 default:
1087 break;
1088 }
1089 return eStateInvalid;
1090}
1091
1092void
1093ProcessGDBRemote::RefreshStateAfterStop ()
1094{
Jim Ingham7508e732010-08-09 23:31:02 +00001095 // FIXME - add a variable to tell that we're in the middle of attaching if we
1096 // need to know that.
Chris Lattner24943d22010-06-08 16:52:24 +00001097 // We must be attaching if we don't already have a valid architecture
Jim Ingham7508e732010-08-09 23:31:02 +00001098// if (!GetTarget().GetArchitecture().IsValid())
1099// {
1100// Module *exe_module = GetTarget().GetExecutableModule().get();
1101// if (exe_module)
1102// m_arch_spec = exe_module->GetArchitecture();
1103// }
1104
Chris Lattner24943d22010-06-08 16:52:24 +00001105 // Let all threads recover from stopping and do any clean up based
1106 // on the previous thread state (if any).
1107 m_thread_list.RefreshStateAfterStop();
1108
1109 // Discover new threads:
1110 UpdateThreadListIfNeeded ();
1111}
1112
1113Error
1114ProcessGDBRemote::DoHalt ()
1115{
1116 Error error;
1117 if (m_gdb_comm.IsRunning())
1118 {
1119 bool timed_out = false;
Greg Clayton1a679462010-09-03 19:15:43 +00001120 Mutex::Locker locker;
1121 if (!m_gdb_comm.SendInterrupt (locker, 2, &timed_out))
Chris Lattner24943d22010-06-08 16:52:24 +00001122 {
1123 if (timed_out)
1124 error.SetErrorString("timed out sending interrupt packet");
1125 else
1126 error.SetErrorString("unknown error sending interrupt packet");
1127 }
1128 }
1129 return error;
1130}
1131
1132Error
1133ProcessGDBRemote::WillDetach ()
1134{
1135 Error error;
1136 const StateType state = m_private_state.GetValue();
1137
1138 if (IsRunning(state))
1139 error.SetErrorString("Process must be stopped in order to detach.");
1140
1141 return error;
1142}
1143
1144
1145Error
1146ProcessGDBRemote::DoDestroy ()
1147{
1148 Error error;
1149 Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS);
1150 if (log)
1151 log->Printf ("ProcessGDBRemote::DoDestroy()");
1152
1153 // Interrupt if our inferior is running...
Greg Clayton1a679462010-09-03 19:15:43 +00001154 Mutex::Locker locker;
1155 m_gdb_comm.SendInterrupt (locker, 1);
Chris Lattner24943d22010-06-08 16:52:24 +00001156 DisableAllBreakpointSites ();
1157 SetExitStatus(-1, "process killed");
1158
1159 StringExtractorGDBRemote response;
1160 if (m_gdb_comm.SendPacketAndWaitForResponse("k", response, 2, false))
1161 {
1162 if (log)
1163 {
1164 if (response.IsOKPacket())
1165 log->Printf ("ProcessGDBRemote::DoDestroy() kill was successful");
1166 else
1167 log->Printf ("ProcessGDBRemote::DoDestroy() kill failed: %s", response.GetStringRef().c_str());
1168 }
1169 }
1170
1171 StopAsyncThread ();
1172 m_gdb_comm.StopReadThread();
1173 KillDebugserverProcess ();
Johnny Chenc5b15db2010-09-03 22:35:47 +00001174 m_gdb_comm.Disconnect(); // Disconnect from the debug server.
Chris Lattner24943d22010-06-08 16:52:24 +00001175 return error;
1176}
1177
1178ByteOrder
1179ProcessGDBRemote::GetByteOrder () const
1180{
1181 return m_byte_order;
1182}
1183
1184//------------------------------------------------------------------
1185// Process Queries
1186//------------------------------------------------------------------
1187
1188bool
1189ProcessGDBRemote::IsAlive ()
1190{
1191 return m_gdb_comm.IsConnected();
1192}
1193
1194addr_t
1195ProcessGDBRemote::GetImageInfoAddress()
1196{
1197 if (!m_gdb_comm.IsRunning())
1198 {
1199 StringExtractorGDBRemote response;
1200 if (m_gdb_comm.SendPacketAndWaitForResponse("qShlibInfoAddr", ::strlen ("qShlibInfoAddr"), response, 2, false))
1201 {
1202 if (response.IsNormalPacket())
1203 return response.GetHexMaxU64(false, LLDB_INVALID_ADDRESS);
1204 }
1205 }
1206 return LLDB_INVALID_ADDRESS;
1207}
1208
1209DynamicLoader *
1210ProcessGDBRemote::GetDynamicLoader()
1211{
1212 return m_dynamic_loader_ap.get();
1213}
1214
1215//------------------------------------------------------------------
1216// Process Memory
1217//------------------------------------------------------------------
1218size_t
1219ProcessGDBRemote::DoReadMemory (addr_t addr, void *buf, size_t size, Error &error)
1220{
1221 if (size > m_max_memory_size)
1222 {
1223 // Keep memory read sizes down to a sane limit. This function will be
1224 // called multiple times in order to complete the task by
1225 // lldb_private::Process so it is ok to do this.
1226 size = m_max_memory_size;
1227 }
1228
1229 char packet[64];
1230 const int packet_len = ::snprintf (packet, sizeof(packet), "m%llx,%zx", (uint64_t)addr, size);
1231 assert (packet_len + 1 < sizeof(packet));
1232 StringExtractorGDBRemote response;
1233 if (m_gdb_comm.SendPacketAndWaitForResponse(packet, packet_len, response, 2, true))
1234 {
1235 if (response.IsNormalPacket())
1236 {
1237 error.Clear();
1238 return response.GetHexBytes(buf, size, '\xdd');
1239 }
1240 else if (response.IsErrorPacket())
1241 error.SetErrorStringWithFormat("gdb remote returned an error: %s", response.GetStringRef().c_str());
1242 else if (response.IsUnsupportedPacket())
1243 error.SetErrorStringWithFormat("'%s' packet unsupported", packet);
1244 else
1245 error.SetErrorStringWithFormat("unexpected response to '%s': '%s'", packet, response.GetStringRef().c_str());
1246 }
1247 else
1248 {
1249 error.SetErrorStringWithFormat("failed to sent packet: '%s'", packet);
1250 }
1251 return 0;
1252}
1253
1254size_t
1255ProcessGDBRemote::DoWriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
1256{
1257 StreamString packet;
1258 packet.Printf("M%llx,%zx:", addr, size);
1259 packet.PutBytesAsRawHex8(buf, size, eByteOrderHost, eByteOrderHost);
1260 StringExtractorGDBRemote response;
1261 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetData(), packet.GetSize(), response, 2, true))
1262 {
1263 if (response.IsOKPacket())
1264 {
1265 error.Clear();
1266 return size;
1267 }
1268 else if (response.IsErrorPacket())
1269 error.SetErrorStringWithFormat("gdb remote returned an error: %s", response.GetStringRef().c_str());
1270 else if (response.IsUnsupportedPacket())
1271 error.SetErrorStringWithFormat("'%s' packet unsupported", packet.GetString().c_str());
1272 else
1273 error.SetErrorStringWithFormat("unexpected response to '%s': '%s'", packet.GetString().c_str(), response.GetStringRef().c_str());
1274 }
1275 else
1276 {
1277 error.SetErrorStringWithFormat("failed to sent packet: '%s'", packet.GetString().c_str());
1278 }
1279 return 0;
1280}
1281
1282lldb::addr_t
1283ProcessGDBRemote::DoAllocateMemory (size_t size, uint32_t permissions, Error &error)
1284{
1285 addr_t allocated_addr = m_gdb_comm.AllocateMemory (size, permissions, m_packet_timeout);
1286 if (allocated_addr == LLDB_INVALID_ADDRESS)
1287 error.SetErrorStringWithFormat("unable to allocate %zu bytes of memory with permissions %u", size, permissions);
1288 else
1289 error.Clear();
1290 return allocated_addr;
1291}
1292
1293Error
1294ProcessGDBRemote::DoDeallocateMemory (lldb::addr_t addr)
1295{
1296 Error error;
1297 if (!m_gdb_comm.DeallocateMemory (addr, m_packet_timeout))
1298 error.SetErrorStringWithFormat("unable to deallocate memory at 0x%llx", addr);
1299 return error;
1300}
1301
1302
1303//------------------------------------------------------------------
1304// Process STDIO
1305//------------------------------------------------------------------
1306
1307size_t
1308ProcessGDBRemote::GetSTDOUT (char *buf, size_t buf_size, Error &error)
1309{
1310 Mutex::Locker locker(m_stdio_mutex);
1311 size_t bytes_available = m_stdout_data.size();
1312 if (bytes_available > 0)
1313 {
1314 ProcessGDBRemoteLog::LogIf (GDBR_LOG_PROCESS, "ProcessGDBRemote::%s (&%p[%u]) ...", __FUNCTION__, buf, buf_size);
1315 if (bytes_available > buf_size)
1316 {
Greg Clayton53d68e72010-07-20 22:52:08 +00001317 memcpy(buf, m_stdout_data.c_str(), buf_size);
Chris Lattner24943d22010-06-08 16:52:24 +00001318 m_stdout_data.erase(0, buf_size);
1319 bytes_available = buf_size;
1320 }
1321 else
1322 {
Greg Clayton53d68e72010-07-20 22:52:08 +00001323 memcpy(buf, m_stdout_data.c_str(), bytes_available);
Chris Lattner24943d22010-06-08 16:52:24 +00001324 m_stdout_data.clear();
1325
1326 //ResetEventBits(eBroadcastBitSTDOUT);
1327 }
1328 }
1329 return bytes_available;
1330}
1331
1332size_t
1333ProcessGDBRemote::GetSTDERR (char *buf, size_t buf_size, Error &error)
1334{
1335 // Can we get STDERR through the remote protocol?
1336 return 0;
1337}
1338
1339size_t
1340ProcessGDBRemote::PutSTDIN (const char *src, size_t src_len, Error &error)
1341{
1342 if (m_stdio_communication.IsConnected())
1343 {
1344 ConnectionStatus status;
1345 m_stdio_communication.Write(src, src_len, status, NULL);
1346 }
1347 return 0;
1348}
1349
1350Error
1351ProcessGDBRemote::EnableBreakpoint (BreakpointSite *bp_site)
1352{
1353 Error error;
1354 assert (bp_site != NULL);
1355
1356 Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_BREAKPOINTS);
1357 user_id_t site_id = bp_site->GetID();
1358 const addr_t addr = bp_site->GetLoadAddress();
1359 if (log)
1360 log->Printf ("ProcessGDBRemote::EnableBreakpoint (size_id = %d) address = 0x%llx", site_id, (uint64_t)addr);
1361
1362 if (bp_site->IsEnabled())
1363 {
1364 if (log)
1365 log->Printf ("ProcessGDBRemote::EnableBreakpoint (size_id = %d) address = 0x%llx -- SUCCESS (already enabled)", site_id, (uint64_t)addr);
1366 return error;
1367 }
1368 else
1369 {
1370 const size_t bp_op_size = GetSoftwareBreakpointTrapOpcode (bp_site);
1371
1372 if (bp_site->HardwarePreferred())
1373 {
1374 // Try and set hardware breakpoint, and if that fails, fall through
1375 // and set a software breakpoint?
1376 }
1377
1378 if (m_z0_supported)
1379 {
1380 char packet[64];
1381 const int packet_len = ::snprintf (packet, sizeof(packet), "Z0,%llx,%zx", addr, bp_op_size);
1382 assert (packet_len + 1 < sizeof(packet));
1383 StringExtractorGDBRemote response;
1384 if (m_gdb_comm.SendPacketAndWaitForResponse(packet, packet_len, response, 2, true))
1385 {
1386 if (response.IsUnsupportedPacket())
1387 {
1388 // Disable z packet support and try again
1389 m_z0_supported = 0;
1390 return EnableBreakpoint (bp_site);
1391 }
1392 else if (response.IsOKPacket())
1393 {
1394 bp_site->SetEnabled(true);
1395 bp_site->SetType (BreakpointSite::eExternal);
1396 return error;
1397 }
1398 else
1399 {
1400 uint8_t error_byte = response.GetError();
1401 if (error_byte)
1402 error.SetErrorStringWithFormat("%x packet failed with error: %i (0x%2.2x).\n", packet, error_byte, error_byte);
1403 }
1404 }
1405 }
1406 else
1407 {
1408 return EnableSoftwareBreakpoint (bp_site);
1409 }
1410 }
1411
1412 if (log)
1413 {
1414 const char *err_string = error.AsCString();
1415 log->Printf ("ProcessGDBRemote::EnableBreakpoint() error for breakpoint at 0x%8.8llx: %s",
1416 bp_site->GetLoadAddress(),
1417 err_string ? err_string : "NULL");
1418 }
1419 // We shouldn't reach here on a successful breakpoint enable...
1420 if (error.Success())
1421 error.SetErrorToGenericError();
1422 return error;
1423}
1424
1425Error
1426ProcessGDBRemote::DisableBreakpoint (BreakpointSite *bp_site)
1427{
1428 Error error;
1429 assert (bp_site != NULL);
1430 addr_t addr = bp_site->GetLoadAddress();
1431 user_id_t site_id = bp_site->GetID();
1432 Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_BREAKPOINTS);
1433 if (log)
1434 log->Printf ("ProcessGDBRemote::DisableBreakpoint (site_id = %d) addr = 0x%8.8llx", site_id, (uint64_t)addr);
1435
1436 if (bp_site->IsEnabled())
1437 {
1438 const size_t bp_op_size = GetSoftwareBreakpointTrapOpcode (bp_site);
1439
1440 if (bp_site->IsHardware())
1441 {
1442 // TODO: disable hardware breakpoint...
1443 }
1444 else
1445 {
1446 if (m_z0_supported)
1447 {
1448 char packet[64];
1449 const int packet_len = ::snprintf (packet, sizeof(packet), "z0,%llx,%zx", addr, bp_op_size);
1450 assert (packet_len + 1 < sizeof(packet));
1451 StringExtractorGDBRemote response;
1452 if (m_gdb_comm.SendPacketAndWaitForResponse(packet, packet_len, response, 2, true))
1453 {
1454 if (response.IsUnsupportedPacket())
1455 {
1456 error.SetErrorString("Breakpoint site was set with Z packet, yet remote debugserver states z packets are not supported.");
1457 }
1458 else if (response.IsOKPacket())
1459 {
1460 if (log)
1461 log->Printf ("ProcessGDBRemote::DisableBreakpoint (site_id = %d) addr = 0x%8.8llx -- SUCCESS", site_id, (uint64_t)addr);
1462 bp_site->SetEnabled(false);
1463 return error;
1464 }
1465 else
1466 {
1467 uint8_t error_byte = response.GetError();
1468 if (error_byte)
1469 error.SetErrorStringWithFormat("%x packet failed with error: %i (0x%2.2x).\n", packet, error_byte, error_byte);
1470 }
1471 }
1472 }
1473 else
1474 {
1475 return DisableSoftwareBreakpoint (bp_site);
1476 }
1477 }
1478 }
1479 else
1480 {
1481 if (log)
1482 log->Printf ("ProcessGDBRemote::DisableBreakpoint (site_id = %d) addr = 0x%8.8llx -- SUCCESS (already disabled)", site_id, (uint64_t)addr);
1483 return error;
1484 }
1485
1486 if (error.Success())
1487 error.SetErrorToGenericError();
1488 return error;
1489}
1490
1491Error
1492ProcessGDBRemote::EnableWatchpoint (WatchpointLocation *wp)
1493{
1494 Error error;
1495 if (wp)
1496 {
1497 user_id_t watchID = wp->GetID();
1498 addr_t addr = wp->GetLoadAddress();
1499 Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_WATCHPOINTS);
1500 if (log)
1501 log->Printf ("ProcessGDBRemote::EnableWatchpoint(watchID = %d)", watchID);
1502 if (wp->IsEnabled())
1503 {
1504 if (log)
1505 log->Printf("ProcessGDBRemote::EnableWatchpoint(watchID = %d) addr = 0x%8.8llx: watchpoint already enabled.", watchID, (uint64_t)addr);
1506 return error;
1507 }
1508 else
1509 {
1510 // Pass down an appropriate z/Z packet...
1511 error.SetErrorString("watchpoints not supported");
1512 }
1513 }
1514 else
1515 {
1516 error.SetErrorString("Watchpoint location argument was NULL.");
1517 }
1518 if (error.Success())
1519 error.SetErrorToGenericError();
1520 return error;
1521}
1522
1523Error
1524ProcessGDBRemote::DisableWatchpoint (WatchpointLocation *wp)
1525{
1526 Error error;
1527 if (wp)
1528 {
1529 user_id_t watchID = wp->GetID();
1530
1531 Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_WATCHPOINTS);
1532
1533 addr_t addr = wp->GetLoadAddress();
1534 if (log)
1535 log->Printf ("ProcessGDBRemote::DisableWatchpoint (watchID = %d) addr = 0x%8.8llx", watchID, (uint64_t)addr);
1536
1537 if (wp->IsHardware())
1538 {
1539 // Pass down an appropriate z/Z packet...
1540 error.SetErrorString("watchpoints not supported");
1541 }
1542 // TODO: clear software watchpoints if we implement them
1543 }
1544 else
1545 {
1546 error.SetErrorString("Watchpoint location argument was NULL.");
1547 }
1548 if (error.Success())
1549 error.SetErrorToGenericError();
1550 return error;
1551}
1552
1553void
1554ProcessGDBRemote::Clear()
1555{
1556 m_flags = 0;
1557 m_thread_list.Clear();
1558 {
1559 Mutex::Locker locker(m_stdio_mutex);
1560 m_stdout_data.clear();
1561 }
1562 DestoryLibUnwindAddressSpace();
1563}
1564
1565Error
1566ProcessGDBRemote::DoSignal (int signo)
1567{
1568 Error error;
1569 Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS);
1570 if (log)
1571 log->Printf ("ProcessGDBRemote::DoSignal (signal = %d)", signo);
1572
1573 if (!m_gdb_comm.SendAsyncSignal (signo))
1574 error.SetErrorStringWithFormat("failed to send signal %i", signo);
1575 return error;
1576}
1577
1578
1579Error
1580ProcessGDBRemote::DoDetach()
1581{
1582 Error error;
1583 Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS);
1584 if (log)
1585 log->Printf ("ProcessGDBRemote::DoDetach()");
1586
1587 // if (DoSIGSTOP (true))
1588 // {
1589 // CloseChildFileDescriptors ();
1590 //
1591 // // Scope for "locker" so we can reply to all of our exceptions (the SIGSTOP
1592 // // exception).
1593 // {
1594 // Mutex::Locker locker(m_exception_messages_mutex);
1595 // ReplyToAllExceptions();
1596 // }
1597 //
1598 // // Shut down the exception thread and cleanup our exception remappings
1599 // Task().ShutDownExceptionThread();
1600 //
1601 // pid_t pid = GetID();
1602 //
1603 // // Detach from our process while we are stopped.
1604 // errno = 0;
1605 //
1606 // // Detach from our process
1607 // ::ptrace (PT_DETACH, pid, (caddr_t)1, 0);
1608 //
1609 // error.SetErrorToErrno();
1610 //
1611 // if (log || error.Fail())
1612 // error.PutToLog(log, "::ptrace (PT_DETACH, %u, (caddr_t)1, 0)", pid);
1613 //
1614 // // Resume our task
1615 // Task().Resume();
1616 //
1617 // // NULL our task out as we have already retored all exception ports
1618 // Task().Clear();
1619 //
1620 // // Clear out any notion of the process we once were
1621 // Clear();
1622 //
1623 // SetPrivateState (eStateDetached);
1624 // return true;
1625 // }
1626 return error;
1627}
1628
1629void
1630ProcessGDBRemote::STDIOReadThreadBytesReceived (void *baton, const void *src, size_t src_len)
1631{
1632 ProcessGDBRemote *process = (ProcessGDBRemote *)baton;
1633 process->AppendSTDOUT(static_cast<const char *>(src), src_len);
1634}
1635
1636void
1637ProcessGDBRemote::AppendSTDOUT (const char* s, size_t len)
1638{
1639 ProcessGDBRemoteLog::LogIf (GDBR_LOG_PROCESS, "ProcessGDBRemote::%s (<%d> %s) ...", __FUNCTION__, len, s);
1640 Mutex::Locker locker(m_stdio_mutex);
1641 m_stdout_data.append(s, len);
1642
1643 // FIXME: Make a real data object for this and put it out.
1644 BroadcastEventIfUnique (eBroadcastBitSTDOUT);
1645}
1646
1647
1648Error
1649ProcessGDBRemote::StartDebugserverProcess
1650(
1651 const char *debugserver_url, // The connection string to use in the spawned debugserver ("localhost:1234" or "/dev/tty...")
1652 char const *inferior_argv[], // Arguments for the inferior program including the path to the inferior itself as the first argument
1653 char const *inferior_envp[], // Environment to pass along to the inferior program
1654 char const *stdio_path,
1655 lldb::pid_t attach_pid, // If inferior inferior_argv == NULL, and attach_pid != LLDB_INVALID_PROCESS_ID then attach to this attach_pid
1656 const char *attach_name, // Wait for the next process to launch whose basename matches "attach_name"
1657 bool wait_for_launch, // Wait for the process named "attach_name" to launch
Greg Clayton452bf612010-08-31 18:35:14 +00001658 bool disable_aslr, // Disable ASLR
Chris Lattner24943d22010-06-08 16:52:24 +00001659 ArchSpec& inferior_arch // The arch of the inferior that we will launch
1660)
1661{
1662 Error error;
1663 if (m_debugserver_pid == LLDB_INVALID_PROCESS_ID)
1664 {
1665 // If we locate debugserver, keep that located version around
1666 static FileSpec g_debugserver_file_spec;
1667
1668 FileSpec debugserver_file_spec;
1669 char debugserver_path[PATH_MAX];
1670
1671 // Always check to see if we have an environment override for the path
1672 // to the debugserver to use and use it if we do.
1673 const char *env_debugserver_path = getenv("LLDB_DEBUGSERVER_PATH");
1674 if (env_debugserver_path)
1675 debugserver_file_spec.SetFile (env_debugserver_path);
1676 else
1677 debugserver_file_spec = g_debugserver_file_spec;
1678 bool debugserver_exists = debugserver_file_spec.Exists();
1679 if (!debugserver_exists)
1680 {
1681 // The debugserver binary is in the LLDB.framework/Resources
1682 // directory.
1683 FileSpec framework_file_spec (Host::GetModuleFileSpecForHostAddress ((void *)lldb_private::Initialize));
1684 const char *framework_dir = framework_file_spec.GetDirectory().AsCString();
1685 const char *lldb_framework = ::strstr (framework_dir, "/LLDB.framework");
1686
1687 if (lldb_framework)
1688 {
1689 int len = lldb_framework - framework_dir + strlen ("/LLDB.framework");
1690 ::snprintf (debugserver_path,
1691 sizeof(debugserver_path),
1692 "%.*s/Resources/%s",
1693 len,
1694 framework_dir,
1695 DEBUGSERVER_BASENAME);
1696 debugserver_file_spec.SetFile (debugserver_path);
1697 debugserver_exists = debugserver_file_spec.Exists();
1698 }
1699
1700 if (debugserver_exists)
1701 {
1702 g_debugserver_file_spec = debugserver_file_spec;
1703 }
1704 else
1705 {
1706 g_debugserver_file_spec.Clear();
1707 debugserver_file_spec.Clear();
1708 }
1709 }
1710
1711 if (debugserver_exists)
1712 {
1713 debugserver_file_spec.GetPath (debugserver_path, sizeof(debugserver_path));
1714
1715 m_stdio_communication.Clear();
1716 posix_spawnattr_t attr;
1717
1718 Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS);
1719
1720 Error local_err; // Errors that don't affect the spawning.
1721 if (log)
1722 log->Printf ("%s ( path='%s', argv=%p, envp=%p, arch=%s )", __FUNCTION__, debugserver_path, inferior_argv, inferior_envp, inferior_arch.AsCString());
1723 error.SetError( ::posix_spawnattr_init (&attr), eErrorTypePOSIX);
1724 if (error.Fail() || log)
1725 error.PutToLog(log, "::posix_spawnattr_init ( &attr )");
1726 if (error.Fail())
1727 return error;;
1728
1729#if !defined (__arm__)
1730
1731 // We don't need to do this for ARM, and we really shouldn't now that we
1732 // have multiple CPU subtypes and no posix_spawnattr call that allows us
1733 // to set which CPU subtype to launch...
Greg Claytoncf015052010-06-11 03:25:34 +00001734 if (inferior_arch.GetType() == eArchTypeMachO)
Chris Lattner24943d22010-06-08 16:52:24 +00001735 {
Greg Claytoncf015052010-06-11 03:25:34 +00001736 cpu_type_t cpu = inferior_arch.GetCPUType();
1737 if (cpu != 0 && cpu != UINT32_MAX && cpu != LLDB_INVALID_CPUTYPE)
1738 {
1739 size_t ocount = 0;
1740 error.SetError( ::posix_spawnattr_setbinpref_np (&attr, 1, &cpu, &ocount), eErrorTypePOSIX);
1741 if (error.Fail() || log)
1742 error.PutToLog(log, "::posix_spawnattr_setbinpref_np ( &attr, 1, cpu_type = 0x%8.8x, count => %zu )", cpu, ocount);
Chris Lattner24943d22010-06-08 16:52:24 +00001743
Greg Claytoncf015052010-06-11 03:25:34 +00001744 if (error.Fail() != 0 || ocount != 1)
1745 return error;
1746 }
Chris Lattner24943d22010-06-08 16:52:24 +00001747 }
1748
1749#endif
1750
1751 Args debugserver_args;
1752 char arg_cstr[PATH_MAX];
1753 bool launch_process = true;
1754
1755 if (inferior_argv == NULL && attach_pid != LLDB_INVALID_PROCESS_ID)
1756 launch_process = false;
1757 else if (attach_name)
1758 launch_process = false; // Wait for a process whose basename matches that in inferior_argv[0]
1759
1760 bool pass_stdio_path_to_debugserver = true;
1761 lldb_utility::PseudoTerminal pty;
1762 if (stdio_path == NULL)
1763 {
1764 pass_stdio_path_to_debugserver = false;
1765 if (pty.OpenFirstAvailableMaster(O_RDWR|O_NOCTTY, NULL, 0))
1766 {
1767 struct termios stdin_termios;
1768 if (::tcgetattr (pty.GetMasterFileDescriptor(), &stdin_termios) == 0)
1769 {
1770 stdin_termios.c_lflag &= ~ECHO; // Turn off echoing
1771 stdin_termios.c_lflag &= ~ICANON; // Get one char at a time
1772 ::tcsetattr (pty.GetMasterFileDescriptor(), TCSANOW, &stdin_termios);
1773 }
1774 stdio_path = pty.GetSlaveName (NULL, 0);
1775 }
1776 }
1777
1778 // Start args with "debugserver /file/path -r --"
1779 debugserver_args.AppendArgument(debugserver_path);
1780 debugserver_args.AppendArgument(debugserver_url);
1781 debugserver_args.AppendArgument("--native-regs"); // use native registers, not the GDB registers
1782 debugserver_args.AppendArgument("--setsid"); // make debugserver run in its own session so
1783 // signals generated by special terminal key
1784 // sequences (^C) don't affect debugserver
1785
Greg Clayton452bf612010-08-31 18:35:14 +00001786 if (disable_aslr)
1787 debugserver_args.AppendArguments("--disable-aslr");
1788
Chris Lattner24943d22010-06-08 16:52:24 +00001789 // Only set the inferior
1790 if (launch_process)
1791 {
1792 if (stdio_path && pass_stdio_path_to_debugserver)
1793 {
1794 debugserver_args.AppendArgument("-s"); // short for --stdio-path
1795 StreamString strm;
1796 strm.Printf("'%s'", stdio_path);
1797 debugserver_args.AppendArgument(strm.GetData()); // path to file to have inferior open as it's STDIO
1798 }
1799 }
1800
1801 const char *env_debugserver_log_file = getenv("LLDB_DEBUGSERVER_LOG_FILE");
1802 if (env_debugserver_log_file)
1803 {
1804 ::snprintf (arg_cstr, sizeof(arg_cstr), "--log-file=%s", env_debugserver_log_file);
1805 debugserver_args.AppendArgument(arg_cstr);
1806 }
1807
1808 const char *env_debugserver_log_flags = getenv("LLDB_DEBUGSERVER_LOG_FLAGS");
1809 if (env_debugserver_log_flags)
1810 {
1811 ::snprintf (arg_cstr, sizeof(arg_cstr), "--log-flags=%s", env_debugserver_log_flags);
1812 debugserver_args.AppendArgument(arg_cstr);
1813 }
1814// debugserver_args.AppendArgument("--log-file=/tmp/debugserver.txt");
1815// debugserver_args.AppendArgument("--log-flags=0x800e0e");
1816
1817 // Now append the program arguments
1818 if (launch_process)
1819 {
1820 if (inferior_argv)
1821 {
1822 // Terminate the debugserver args so we can now append the inferior args
1823 debugserver_args.AppendArgument("--");
1824
1825 for (int i = 0; inferior_argv[i] != NULL; ++i)
1826 debugserver_args.AppendArgument (inferior_argv[i]);
1827 }
1828 else
1829 {
1830 // Will send environment entries with the 'QEnvironment:' packet
1831 // Will send arguments with the 'A' packet
1832 }
1833 }
1834 else if (attach_pid != LLDB_INVALID_PROCESS_ID)
1835 {
1836 ::snprintf (arg_cstr, sizeof(arg_cstr), "--attach=%u", attach_pid);
1837 debugserver_args.AppendArgument (arg_cstr);
1838 }
1839 else if (attach_name && attach_name[0])
1840 {
1841 if (wait_for_launch)
1842 debugserver_args.AppendArgument ("--waitfor");
1843 else
1844 debugserver_args.AppendArgument ("--attach");
1845 debugserver_args.AppendArgument (attach_name);
1846 }
1847
1848 Error file_actions_err;
1849 posix_spawn_file_actions_t file_actions;
1850#if DONT_CLOSE_DEBUGSERVER_STDIO
1851 file_actions_err.SetErrorString ("Remove this after uncommenting the code block below.");
1852#else
1853 file_actions_err.SetError( ::posix_spawn_file_actions_init (&file_actions), eErrorTypePOSIX);
1854 if (file_actions_err.Success())
1855 {
1856 ::posix_spawn_file_actions_addclose (&file_actions, STDIN_FILENO);
1857 ::posix_spawn_file_actions_addclose (&file_actions, STDOUT_FILENO);
1858 ::posix_spawn_file_actions_addclose (&file_actions, STDERR_FILENO);
1859 }
1860#endif
1861
1862 if (log)
1863 {
1864 StreamString strm;
1865 debugserver_args.Dump (&strm);
1866 log->Printf("%s arguments:\n%s", debugserver_args.GetArgumentAtIndex(0), strm.GetData());
1867 }
1868
1869 error.SetError(::posix_spawnp (&m_debugserver_pid,
1870 debugserver_path,
1871 file_actions_err.Success() ? &file_actions : NULL,
1872 &attr,
1873 debugserver_args.GetArgumentVector(),
1874 (char * const*)inferior_envp),
1875 eErrorTypePOSIX);
1876
Greg Claytone9d0df42010-07-02 01:29:13 +00001877
1878 ::posix_spawnattr_destroy (&attr);
1879
Chris Lattner24943d22010-06-08 16:52:24 +00001880 if (file_actions_err.Success())
1881 ::posix_spawn_file_actions_destroy (&file_actions);
1882
1883 // We have seen some cases where posix_spawnp was returning a valid
1884 // looking pid even when an error was returned, so clear it out
1885 if (error.Fail())
1886 m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
1887
1888 if (error.Fail() || log)
1889 error.PutToLog(log, "::posix_spawnp ( pid => %i, path = '%s', file_actions = %p, attr = %p, argv = %p, envp = %p )", m_debugserver_pid, debugserver_path, NULL, &attr, inferior_argv, inferior_envp);
1890
1891// if (m_debugserver_pid != LLDB_INVALID_PROCESS_ID)
1892// {
1893// std::auto_ptr<ConnectionFileDescriptor> conn_ap(new ConnectionFileDescriptor (pty.ReleaseMasterFileDescriptor(), true));
1894// if (conn_ap.get())
1895// {
1896// m_stdio_communication.SetConnection(conn_ap.release());
1897// if (m_stdio_communication.IsConnected())
1898// {
1899// m_stdio_communication.SetReadThreadBytesReceivedCallback (STDIOReadThreadBytesReceived, this);
1900// m_stdio_communication.StartReadThread();
1901// }
1902// }
1903// }
1904 }
1905 else
1906 {
1907 error.SetErrorStringWithFormat ("Unable to locate " DEBUGSERVER_BASENAME ".\n");
1908 }
1909
1910 if (m_debugserver_pid != LLDB_INVALID_PROCESS_ID)
1911 StartAsyncThread ();
1912 }
1913 return error;
1914}
1915
1916bool
1917ProcessGDBRemote::MonitorDebugserverProcess
1918(
1919 void *callback_baton,
1920 lldb::pid_t debugserver_pid,
1921 int signo, // Zero for no signal
1922 int exit_status // Exit value of process if signal is zero
1923)
1924{
1925 // We pass in the ProcessGDBRemote inferior process it and name it
1926 // "gdb_remote_pid". The process ID is passed in the "callback_baton"
1927 // pointer value itself, thus we need the double cast...
1928
1929 // "debugserver_pid" argument passed in is the process ID for
1930 // debugserver that we are tracking...
1931
Greg Clayton75ccf502010-08-21 02:22:51 +00001932 ProcessGDBRemote *process = (ProcessGDBRemote *)callback_baton;
1933
1934 if (process)
Chris Lattner24943d22010-06-08 16:52:24 +00001935 {
Greg Clayton75ccf502010-08-21 02:22:51 +00001936 // Sleep for a half a second to make sure our inferior process has
1937 // time to set its exit status before we set it incorrectly when
1938 // both the debugserver and the inferior process shut down.
1939 usleep (500000);
1940 // If our process hasn't yet exited, debugserver might have died.
1941 // If the process did exit, the we are reaping it.
1942 if (process->GetState() != eStateExited)
Chris Lattner24943d22010-06-08 16:52:24 +00001943 {
Greg Clayton75ccf502010-08-21 02:22:51 +00001944 char error_str[1024];
1945 if (signo)
Chris Lattner24943d22010-06-08 16:52:24 +00001946 {
Greg Clayton75ccf502010-08-21 02:22:51 +00001947 const char *signal_cstr = process->GetUnixSignals().GetSignalAsCString (signo);
1948 if (signal_cstr)
1949 ::snprintf (error_str, sizeof (error_str), DEBUGSERVER_BASENAME " died with signal %s", signal_cstr);
Chris Lattner24943d22010-06-08 16:52:24 +00001950 else
Greg Clayton75ccf502010-08-21 02:22:51 +00001951 ::snprintf (error_str, sizeof (error_str), DEBUGSERVER_BASENAME " died with signal %i", signo);
Chris Lattner24943d22010-06-08 16:52:24 +00001952 }
1953 else
1954 {
Greg Clayton75ccf502010-08-21 02:22:51 +00001955 ::snprintf (error_str, sizeof (error_str), DEBUGSERVER_BASENAME " died with an exit status of 0x%8.8x", exit_status);
Chris Lattner24943d22010-06-08 16:52:24 +00001956 }
Greg Clayton75ccf502010-08-21 02:22:51 +00001957
1958 process->SetExitStatus (-1, error_str);
1959 }
1960 else
1961 {
1962 // Debugserver has exited we need to let our ProcessGDBRemote
1963 // know that it no longer has a debugserver instance
1964 process->m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
1965 // We are returning true to this function below, so we can
1966 // forget about the monitor handle.
1967 process->m_debugserver_thread = LLDB_INVALID_HOST_THREAD;
Chris Lattner24943d22010-06-08 16:52:24 +00001968 }
1969 }
1970 return true;
1971}
1972
1973void
1974ProcessGDBRemote::KillDebugserverProcess ()
1975{
1976 if (m_debugserver_pid != LLDB_INVALID_PROCESS_ID)
1977 {
1978 ::kill (m_debugserver_pid, SIGINT);
1979 m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
1980 }
1981}
1982
1983void
1984ProcessGDBRemote::Initialize()
1985{
1986 static bool g_initialized = false;
1987
1988 if (g_initialized == false)
1989 {
1990 g_initialized = true;
1991 PluginManager::RegisterPlugin (GetPluginNameStatic(),
1992 GetPluginDescriptionStatic(),
1993 CreateInstance);
1994
1995 Log::Callbacks log_callbacks = {
1996 ProcessGDBRemoteLog::DisableLog,
1997 ProcessGDBRemoteLog::EnableLog,
1998 ProcessGDBRemoteLog::ListLogCategories
1999 };
2000
2001 Log::RegisterLogChannel (ProcessGDBRemote::GetPluginNameStatic(), log_callbacks);
2002 }
2003}
2004
2005bool
2006ProcessGDBRemote::SetCurrentGDBRemoteThread (int tid)
2007{
2008 if (m_curr_tid == tid)
2009 return true;
2010
2011 char packet[32];
2012 const int packet_len = ::snprintf (packet, sizeof(packet), "Hg%x", tid);
2013 assert (packet_len + 1 < sizeof(packet));
2014 StringExtractorGDBRemote response;
2015 if (m_gdb_comm.SendPacketAndWaitForResponse(packet, packet_len, response, 2, false))
2016 {
2017 if (response.IsOKPacket())
2018 {
2019 m_curr_tid = tid;
2020 return true;
2021 }
2022 }
2023 return false;
2024}
2025
2026bool
2027ProcessGDBRemote::SetCurrentGDBRemoteThreadForRun (int tid)
2028{
2029 if (m_curr_tid_run == tid)
2030 return true;
2031
2032 char packet[32];
2033 const int packet_len = ::snprintf (packet, sizeof(packet), "Hg%x", tid);
2034 assert (packet_len + 1 < sizeof(packet));
2035 StringExtractorGDBRemote response;
2036 if (m_gdb_comm.SendPacketAndWaitForResponse(packet, packet_len, response, 2, false))
2037 {
2038 if (response.IsOKPacket())
2039 {
2040 m_curr_tid_run = tid;
2041 return true;
2042 }
2043 }
2044 return false;
2045}
2046
2047void
2048ProcessGDBRemote::ResetGDBRemoteState ()
2049{
2050 // Reset and GDB remote state
2051 m_curr_tid = LLDB_INVALID_THREAD_ID;
2052 m_curr_tid_run = LLDB_INVALID_THREAD_ID;
2053 m_z0_supported = 1;
2054}
2055
2056
2057bool
2058ProcessGDBRemote::StartAsyncThread ()
2059{
2060 ResetGDBRemoteState ();
2061
2062 Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS);
2063
2064 if (log)
2065 log->Printf ("ProcessGDBRemote::%s ()", __FUNCTION__);
2066
2067 // Create a thread that watches our internal state and controls which
2068 // events make it to clients (into the DCProcess event queue).
2069 m_async_thread = Host::ThreadCreate ("<lldb.process.gdb-remote.async>", ProcessGDBRemote::AsyncThread, this, NULL);
2070 return m_async_thread != LLDB_INVALID_HOST_THREAD;
2071}
2072
2073void
2074ProcessGDBRemote::StopAsyncThread ()
2075{
2076 Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS);
2077
2078 if (log)
2079 log->Printf ("ProcessGDBRemote::%s ()", __FUNCTION__);
2080
2081 m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncThreadShouldExit);
2082
2083 // Stop the stdio thread
2084 if (m_async_thread != LLDB_INVALID_HOST_THREAD)
2085 {
2086 Host::ThreadJoin (m_async_thread, NULL, NULL);
2087 }
2088}
2089
2090
2091void *
2092ProcessGDBRemote::AsyncThread (void *arg)
2093{
2094 ProcessGDBRemote *process = (ProcessGDBRemote*) arg;
2095
2096 Log *log = ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS);
2097 if (log)
2098 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %i) thread starting...", __FUNCTION__, arg, process->GetID());
2099
2100 Listener listener ("ProcessGDBRemote::AsyncThread");
2101 EventSP event_sp;
2102 const uint32_t desired_event_mask = eBroadcastBitAsyncContinue |
2103 eBroadcastBitAsyncThreadShouldExit;
2104
2105 if (listener.StartListeningForEvents (&process->m_async_broadcaster, desired_event_mask) == desired_event_mask)
2106 {
2107 bool done = false;
2108 while (!done)
2109 {
2110 if (log)
2111 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %i) listener.WaitForEvent (NULL, event_sp)...", __FUNCTION__, arg, process->GetID());
2112 if (listener.WaitForEvent (NULL, event_sp))
2113 {
2114 const uint32_t event_type = event_sp->GetType();
2115 switch (event_type)
2116 {
2117 case eBroadcastBitAsyncContinue:
2118 {
2119 const EventDataBytes *continue_packet = EventDataBytes::GetEventDataFromEvent(event_sp.get());
2120
2121 if (continue_packet)
2122 {
2123 const char *continue_cstr = (const char *)continue_packet->GetBytes ();
2124 const size_t continue_cstr_len = continue_packet->GetByteSize ();
2125 if (log)
2126 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %i) got eBroadcastBitAsyncContinue: %s", __FUNCTION__, arg, process->GetID(), continue_cstr);
2127
2128 process->SetPrivateState(eStateRunning);
2129 StringExtractorGDBRemote response;
2130 StateType stop_state = process->GetGDBRemote().SendContinuePacketAndWaitForResponse (process, continue_cstr, continue_cstr_len, response);
2131
2132 switch (stop_state)
2133 {
2134 case eStateStopped:
2135 case eStateCrashed:
2136 case eStateSuspended:
2137 process->m_last_stop_packet = response;
2138 process->m_last_stop_packet.SetFilePos (0);
2139 process->SetPrivateState (stop_state);
2140 break;
2141
2142 case eStateExited:
2143 process->m_last_stop_packet = response;
2144 process->m_last_stop_packet.SetFilePos (0);
2145 response.SetFilePos(1);
2146 process->SetExitStatus(response.GetHexU8(), NULL);
2147 done = true;
2148 break;
2149
2150 case eStateInvalid:
2151 break;
2152
2153 default:
2154 process->SetPrivateState (stop_state);
2155 break;
2156 }
2157 }
2158 }
2159 break;
2160
2161 case eBroadcastBitAsyncThreadShouldExit:
2162 if (log)
2163 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %i) got eBroadcastBitAsyncThreadShouldExit...", __FUNCTION__, arg, process->GetID());
2164 done = true;
2165 break;
2166
2167 default:
2168 if (log)
2169 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %i) got unknown event 0x%8.8x", __FUNCTION__, arg, process->GetID(), event_type);
2170 done = true;
2171 break;
2172 }
2173 }
2174 else
2175 {
2176 if (log)
2177 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %i) listener.WaitForEvent (NULL, event_sp) => false", __FUNCTION__, arg, process->GetID());
2178 done = true;
2179 }
2180 }
2181 }
2182
2183 if (log)
2184 log->Printf ("ProcessGDBRemote::%s (arg = %p, pid = %i) thread exiting...", __FUNCTION__, arg, process->GetID());
2185
2186 process->m_async_thread = LLDB_INVALID_HOST_THREAD;
2187 return NULL;
2188}
2189
2190lldb_private::unw_addr_space_t
2191ProcessGDBRemote::GetLibUnwindAddressSpace ()
2192{
2193 unw_targettype_t target_type = UNW_TARGET_UNSPECIFIED;
Greg Claytoncf015052010-06-11 03:25:34 +00002194
2195 ArchSpec::CPU arch_cpu = m_target.GetArchitecture().GetGenericCPUType();
2196 if (arch_cpu == ArchSpec::eCPU_i386)
Chris Lattner24943d22010-06-08 16:52:24 +00002197 target_type = UNW_TARGET_I386;
Greg Claytoncf015052010-06-11 03:25:34 +00002198 else if (arch_cpu == ArchSpec::eCPU_x86_64)
Chris Lattner24943d22010-06-08 16:52:24 +00002199 target_type = UNW_TARGET_X86_64;
2200
2201 if (m_libunwind_addr_space)
2202 {
2203 if (m_libunwind_target_type != target_type)
2204 DestoryLibUnwindAddressSpace();
2205 else
2206 return m_libunwind_addr_space;
2207 }
2208 unw_accessors_t callbacks = get_macosx_libunwind_callbacks ();
2209 m_libunwind_addr_space = unw_create_addr_space (&callbacks, target_type);
2210 if (m_libunwind_addr_space)
2211 m_libunwind_target_type = target_type;
2212 else
2213 m_libunwind_target_type = UNW_TARGET_UNSPECIFIED;
2214 return m_libunwind_addr_space;
2215}
2216
2217void
2218ProcessGDBRemote::DestoryLibUnwindAddressSpace ()
2219{
2220 if (m_libunwind_addr_space)
2221 {
2222 unw_destroy_addr_space (m_libunwind_addr_space);
2223 m_libunwind_addr_space = NULL;
2224 }
2225 m_libunwind_target_type = UNW_TARGET_UNSPECIFIED;
2226}
2227
2228
2229const char *
2230ProcessGDBRemote::GetDispatchQueueNameForThread
2231(
2232 addr_t thread_dispatch_qaddr,
2233 std::string &dispatch_queue_name
2234)
2235{
2236 dispatch_queue_name.clear();
2237 if (thread_dispatch_qaddr != 0 && thread_dispatch_qaddr != LLDB_INVALID_ADDRESS)
2238 {
2239 // Cache the dispatch_queue_offsets_addr value so we don't always have
2240 // to look it up
2241 if (m_dispatch_queue_offsets_addr == LLDB_INVALID_ADDRESS)
2242 {
2243 ModuleSP module_sp(GetTarget().GetImages().FindFirstModuleForFileSpec (FileSpec("libSystem.B.dylib")));
2244 if (module_sp.get() == NULL)
2245 return NULL;
2246
2247 const Symbol *dispatch_queue_offsets_symbol = module_sp->FindFirstSymbolWithNameAndType (ConstString("dispatch_queue_offsets"), eSymbolTypeData);
2248 if (dispatch_queue_offsets_symbol)
2249 m_dispatch_queue_offsets_addr = dispatch_queue_offsets_symbol->GetValue().GetLoadAddress(this);
2250
2251 if (m_dispatch_queue_offsets_addr == LLDB_INVALID_ADDRESS)
2252 return NULL;
2253 }
2254
2255 uint8_t memory_buffer[8];
2256 DataExtractor data(memory_buffer, sizeof(memory_buffer), GetByteOrder(), GetAddressByteSize());
2257
2258 // Excerpt from src/queue_private.h
2259 struct dispatch_queue_offsets_s
2260 {
2261 uint16_t dqo_version;
2262 uint16_t dqo_label;
2263 uint16_t dqo_label_size;
2264 } dispatch_queue_offsets;
2265
2266
2267 Error error;
2268 if (ReadMemory (m_dispatch_queue_offsets_addr, memory_buffer, sizeof(dispatch_queue_offsets), error) == sizeof(dispatch_queue_offsets))
2269 {
2270 uint32_t data_offset = 0;
2271 if (data.GetU16(&data_offset, &dispatch_queue_offsets.dqo_version, sizeof(dispatch_queue_offsets)/sizeof(uint16_t)))
2272 {
2273 if (ReadMemory (thread_dispatch_qaddr, &memory_buffer, data.GetAddressByteSize(), error) == data.GetAddressByteSize())
2274 {
2275 data_offset = 0;
2276 lldb::addr_t queue_addr = data.GetAddress(&data_offset);
2277 lldb::addr_t label_addr = queue_addr + dispatch_queue_offsets.dqo_label;
2278 dispatch_queue_name.resize(dispatch_queue_offsets.dqo_label_size, '\0');
2279 size_t bytes_read = ReadMemory (label_addr, &dispatch_queue_name[0], dispatch_queue_offsets.dqo_label_size, error);
2280 if (bytes_read < dispatch_queue_offsets.dqo_label_size)
2281 dispatch_queue_name.erase (bytes_read);
2282 }
2283 }
2284 }
2285 }
2286 if (dispatch_queue_name.empty())
2287 return NULL;
2288 return dispatch_queue_name.c_str();
2289}
2290
Jim Ingham7508e732010-08-09 23:31:02 +00002291uint32_t
2292ProcessGDBRemote::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
2293{
2294 // If we are planning to launch the debugserver remotely, then we need to fire up a debugserver
2295 // process and ask it for the list of processes. But if we are local, we can let the Host do it.
2296 if (m_local_debugserver)
2297 {
2298 return Host::ListProcessesMatchingName (name, matches, pids);
2299 }
2300 else
2301 {
2302 // FIXME: Implement talking to the remote debugserver.
2303 return 0;
2304 }
2305
2306}