1 //===-- PlatformRemoteGDBServer.cpp -----------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "lldb/lldb-python.h"
12 #include "PlatformRemoteGDBServer.h"
13 #include "lldb/Host/Config.h"
16 #ifndef LLDB_DISABLE_POSIX
17 #include <sys/sysctl.h>
21 // Other libraries and framework includes
23 #include "lldb/Breakpoint/BreakpointLocation.h"
24 #include "lldb/Core/ConnectionFileDescriptor.h"
25 #include "lldb/Core/Debugger.h"
26 #include "lldb/Core/Error.h"
27 #include "lldb/Core/Module.h"
28 #include "lldb/Core/ModuleList.h"
29 #include "lldb/Core/PluginManager.h"
30 #include "lldb/Core/StreamString.h"
31 #include "lldb/Host/FileSpec.h"
32 #include "lldb/Host/Host.h"
33 #include "lldb/Target/Process.h"
34 #include "lldb/Target/Target.h"
37 using namespace lldb_private;
39 static bool g_initialized = false;
42 PlatformRemoteGDBServer::Initialize ()
44 if (g_initialized == false)
47 PluginManager::RegisterPlugin (PlatformRemoteGDBServer::GetPluginNameStatic(),
48 PlatformRemoteGDBServer::GetDescriptionStatic(),
49 PlatformRemoteGDBServer::CreateInstance);
54 PlatformRemoteGDBServer::Terminate ()
58 g_initialized = false;
59 PluginManager::UnregisterPlugin (PlatformRemoteGDBServer::CreateInstance);
64 PlatformRemoteGDBServer::CreateInstance (bool force, const lldb_private::ArchSpec *arch)
69 create = !arch->TripleVendorWasSpecified() && !arch->TripleOSWasSpecified();
72 return new PlatformRemoteGDBServer ();
77 lldb_private::ConstString
78 PlatformRemoteGDBServer::GetPluginNameStatic()
80 static ConstString g_name("remote-gdb-server");
85 PlatformRemoteGDBServer::GetDescriptionStatic()
87 return "A platform that uses the GDB remote protocol as the communication transport.";
91 PlatformRemoteGDBServer::GetDescription ()
93 if (m_platform_description.empty())
97 // Send the get description packet
101 if (!m_platform_description.empty())
102 return m_platform_description.c_str();
103 return GetDescriptionStatic();
107 PlatformRemoteGDBServer::ResolveExecutable (const FileSpec &exe_file,
108 const ArchSpec &exe_arch,
109 lldb::ModuleSP &exe_module_sp,
110 const FileSpecList *module_search_paths_ptr)
113 //error.SetErrorString ("PlatformRemoteGDBServer::ResolveExecutable() is unimplemented");
114 if (m_gdb_client.GetFileExists(exe_file))
116 // TODO: get the remote end to somehow resolve this file
117 error.SetErrorString("file not found on remote end");
122 PlatformRemoteGDBServer::GetFileWithUUID (const FileSpec &platform_file,
123 const UUID *uuid_ptr,
124 FileSpec &local_file)
126 // Default to the local case
127 local_file = platform_file;
131 //------------------------------------------------------------------
132 /// Default Constructor
133 //------------------------------------------------------------------
134 PlatformRemoteGDBServer::PlatformRemoteGDBServer () :
135 Platform(false), // This is a remote platform
140 //------------------------------------------------------------------
143 /// The destructor is virtual since this class is designed to be
144 /// inherited from by the plug-in instance.
145 //------------------------------------------------------------------
146 PlatformRemoteGDBServer::~PlatformRemoteGDBServer()
151 PlatformRemoteGDBServer::GetSupportedArchitectureAtIndex (uint32_t idx, ArchSpec &arch)
157 PlatformRemoteGDBServer::GetSoftwareBreakpointTrapOpcode (Target &target, BreakpointSite *bp_site)
159 // This isn't needed if the z/Z packets are supported in the GDB remote
160 // server. But we might need a packet to detect this.
165 PlatformRemoteGDBServer::GetRemoteOSVersion ()
167 uint32_t major, minor, update;
168 if (m_gdb_client.GetOSVersion (major, minor, update))
170 m_major_os_version = major;
171 m_minor_os_version = minor;
172 m_update_os_version = update;
179 PlatformRemoteGDBServer::GetRemoteOSBuildString (std::string &s)
181 return m_gdb_client.GetOSBuildString (s);
185 PlatformRemoteGDBServer::GetRemoteOSKernelDescription (std::string &s)
187 return m_gdb_client.GetOSKernelDescription (s);
190 // Remote Platform subclasses need to override this function
192 PlatformRemoteGDBServer::GetRemoteSystemArchitecture ()
194 return m_gdb_client.GetSystemArchitecture();
197 lldb_private::ConstString
198 PlatformRemoteGDBServer::GetRemoteWorkingDirectory()
202 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM);
204 if (m_gdb_client.GetWorkingDir(cwd))
206 ConstString working_dir(cwd.c_str());
208 log->Printf("PlatformRemoteGDBServer::GetRemoteWorkingDirectory() -> '%s'", working_dir.GetCString());
213 return ConstString();
218 return Platform::GetRemoteWorkingDirectory();
223 PlatformRemoteGDBServer::SetRemoteWorkingDirectory(const lldb_private::ConstString &path)
227 // Clear the working directory it case it doesn't get set correctly. This will
228 // for use to re-read it
229 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM);
231 log->Printf("PlatformRemoteGDBServer::SetRemoteWorkingDirectory('%s')", path.GetCString());
232 return m_gdb_client.SetWorkingDir(path.GetCString()) == 0;
235 return Platform::SetRemoteWorkingDirectory(path);
239 PlatformRemoteGDBServer::IsConnected () const
241 return m_gdb_client.IsConnected();
245 PlatformRemoteGDBServer::ConnectRemote (Args& args)
250 error.SetErrorStringWithFormat ("the platform is already connected to '%s', execute 'platform disconnect' to close the current connection",
255 if (args.GetArgumentCount() == 1)
257 const char *url = args.GetArgumentAtIndex(0);
258 m_gdb_client.SetConnection (new ConnectionFileDescriptor());
259 const ConnectionStatus status = m_gdb_client.Connect(url, &error);
260 if (status == eConnectionStatusSuccess)
262 if (m_gdb_client.HandshakeWithServer(&error))
264 m_gdb_client.GetHostInfo();
265 // If a working directory was set prior to connecting, send it down now
267 m_gdb_client.SetWorkingDir(m_working_dir.GetCString());
271 m_gdb_client.Disconnect();
273 error.SetErrorString("handshake failed");
279 error.SetErrorString ("\"platform connect\" takes a single argument: <connect-url>");
287 PlatformRemoteGDBServer::DisconnectRemote ()
290 m_gdb_client.Disconnect(&error);
295 PlatformRemoteGDBServer::GetHostname ()
297 m_gdb_client.GetHostname (m_name);
300 return m_name.c_str();
304 PlatformRemoteGDBServer::GetUserName (uint32_t uid)
306 // Try and get a cache user name first
307 const char *cached_user_name = Platform::GetUserName(uid);
308 if (cached_user_name)
309 return cached_user_name;
311 if (m_gdb_client.GetUserName(uid, name))
312 return SetCachedUserName(uid, name.c_str(), name.size());
314 SetUserNameNotFound(uid); // Negative cache so we don't keep sending packets
319 PlatformRemoteGDBServer::GetGroupName (uint32_t gid)
321 const char *cached_group_name = Platform::GetGroupName(gid);
322 if (cached_group_name)
323 return cached_group_name;
325 if (m_gdb_client.GetGroupName(gid, name))
326 return SetCachedGroupName(gid, name.c_str(), name.size());
328 SetGroupNameNotFound(gid); // Negative cache so we don't keep sending packets
333 PlatformRemoteGDBServer::FindProcesses (const ProcessInstanceInfoMatch &match_info,
334 ProcessInstanceInfoList &process_infos)
336 return m_gdb_client.FindProcesses (match_info, process_infos);
340 PlatformRemoteGDBServer::GetProcessInfo (lldb::pid_t pid, ProcessInstanceInfo &process_info)
342 return m_gdb_client.GetProcessInfo (pid, process_info);
347 PlatformRemoteGDBServer::LaunchProcess (ProcessLaunchInfo &launch_info)
350 lldb::pid_t pid = LLDB_INVALID_PROCESS_ID;
352 m_gdb_client.SetSTDIN ("/dev/null");
353 m_gdb_client.SetSTDOUT ("/dev/null");
354 m_gdb_client.SetSTDERR ("/dev/null");
355 m_gdb_client.SetDisableASLR (launch_info.GetFlags().Test (eLaunchFlagDisableASLR));
357 const char *working_dir = launch_info.GetWorkingDirectory();
358 if (working_dir && working_dir[0])
360 m_gdb_client.SetWorkingDir (working_dir);
363 // Send the environment and the program + arguments after we connect
364 const char **envp = launch_info.GetEnvironmentEntries().GetConstArgumentVector();
368 const char *env_entry;
369 for (int i=0; (env_entry = envp[i]); ++i)
371 if (m_gdb_client.SendEnvironmentPacket(env_entry) != 0)
376 ArchSpec arch_spec = launch_info.GetArchitecture();
377 const char *arch_triple = arch_spec.GetTriple().str().c_str();
379 m_gdb_client.SendLaunchArchPacket(arch_triple);
381 const uint32_t old_packet_timeout = m_gdb_client.SetPacketTimeout (5);
382 int arg_packet_err = m_gdb_client.SendArgumentsPacket (launch_info);
383 m_gdb_client.SetPacketTimeout (old_packet_timeout);
384 if (arg_packet_err == 0)
386 std::string error_str;
387 if (m_gdb_client.GetLaunchSuccess (error_str))
389 pid = m_gdb_client.GetCurrentProcessID ();
390 if (pid != LLDB_INVALID_PROCESS_ID)
391 launch_info.SetProcessID (pid);
395 error.SetErrorString (error_str.c_str());
400 error.SetErrorStringWithFormat("'A' packet returned an error: %i", arg_packet_err);
406 PlatformRemoteGDBServer::DebugProcess (lldb_private::ProcessLaunchInfo &launch_info,
407 lldb_private::Debugger &debugger,
408 lldb_private::Target *target, // Can be NULL, if NULL create a new target, else use existing one
409 lldb_private::Listener &listener,
410 lldb_private::Error &error)
412 lldb::ProcessSP process_sp;
417 lldb::pid_t debugserver_pid = LLDB_INVALID_PROCESS_ID;
418 ArchSpec remote_arch = GetRemoteSystemArchitecture();
419 llvm::Triple &remote_triple = remote_arch.GetTriple();
421 if (remote_triple.getVendor() == llvm::Triple::Apple && remote_triple.getOS() == llvm::Triple::IOS)
423 // When remote debugging to iOS, we use a USB mux that always talks
424 // to localhost, so we will need the remote debugserver to accept connections
425 // only from localhost, no matter what our current hostname is
426 port = m_gdb_client.LaunchGDBserverAndGetPort(debugserver_pid, "localhost");
430 // All other hosts should use their actual hostname
431 port = m_gdb_client.LaunchGDBserverAndGetPort(debugserver_pid, NULL);
436 error.SetErrorStringWithFormat ("unable to launch a GDB server on '%s'", GetHostname ());
442 TargetSP new_target_sp;
444 error = debugger.GetTargetList().CreateTarget (debugger,
450 target = new_target_sp.get();
455 if (target && error.Success())
457 debugger.GetTargetList().SetSelectedTarget(target);
459 // The darwin always currently uses the GDB remote debugger plug-in
460 // so even when debugging locally we are debugging remotely!
461 process_sp = target->CreateProcess (listener, "gdb-remote", NULL);
465 char connect_url[256];
466 const char *override_hostname = getenv("LLDB_PLATFORM_REMOTE_GDB_SERVER_HOSTNAME");
467 const char *port_offset_c_str = getenv("LLDB_PLATFORM_REMOTE_GDB_SERVER_PORT_OFFSET");
468 int port_offset = port_offset_c_str ? ::atoi(port_offset_c_str) : 0;
469 const int connect_url_len = ::snprintf (connect_url,
472 override_hostname ? override_hostname : GetHostname (),
474 assert (connect_url_len < (int)sizeof(connect_url));
475 error = process_sp->ConnectRemote (NULL, connect_url);
477 error = process_sp->Launch(launch_info);
478 else if (debugserver_pid != LLDB_INVALID_PROCESS_ID)
479 m_gdb_client.KillSpawnedProcess(debugserver_pid);
486 error.SetErrorString("not connected to remote gdb server");
494 PlatformRemoteGDBServer::Attach (lldb_private::ProcessAttachInfo &attach_info,
496 Target *target, // Can be NULL, if NULL create a new target, else use existing one
500 lldb::ProcessSP process_sp;
505 lldb::pid_t debugserver_pid = LLDB_INVALID_PROCESS_ID;
506 ArchSpec remote_arch = GetRemoteSystemArchitecture();
507 llvm::Triple &remote_triple = remote_arch.GetTriple();
509 if (remote_triple.getVendor() == llvm::Triple::Apple && remote_triple.getOS() == llvm::Triple::IOS)
511 // When remote debugging to iOS, we use a USB mux that always talks
512 // to localhost, so we will need the remote debugserver to accept connections
513 // only from localhost, no matter what our current hostname is
514 port = m_gdb_client.LaunchGDBserverAndGetPort(debugserver_pid, "localhost");
518 // All other hosts should use their actual hostname
519 port = m_gdb_client.LaunchGDBserverAndGetPort(debugserver_pid, NULL);
524 error.SetErrorStringWithFormat ("unable to launch a GDB server on '%s'", GetHostname ());
530 TargetSP new_target_sp;
532 error = debugger.GetTargetList().CreateTarget (debugger,
538 target = new_target_sp.get();
543 if (target && error.Success())
545 debugger.GetTargetList().SetSelectedTarget(target);
547 // The darwin always currently uses the GDB remote debugger plug-in
548 // so even when debugging locally we are debugging remotely!
549 process_sp = target->CreateProcess (listener, "gdb-remote", NULL);
553 char connect_url[256];
554 const char *override_hostname = getenv("LLDB_PLATFORM_REMOTE_GDB_SERVER_HOSTNAME");
555 const char *port_offset_c_str = getenv("LLDB_PLATFORM_REMOTE_GDB_SERVER_PORT_OFFSET");
556 int port_offset = port_offset_c_str ? ::atoi(port_offset_c_str) : 0;
557 const int connect_url_len = ::snprintf (connect_url,
560 override_hostname ? override_hostname : GetHostname (),
562 assert (connect_url_len < (int)sizeof(connect_url));
563 error = process_sp->ConnectRemote (NULL, connect_url);
565 error = process_sp->Attach(attach_info);
566 else if (debugserver_pid != LLDB_INVALID_PROCESS_ID)
568 m_gdb_client.KillSpawnedProcess(debugserver_pid);
576 error.SetErrorString("not connected to remote gdb server");
583 PlatformRemoteGDBServer::MakeDirectory (const char *path, uint32_t mode)
585 Error error = m_gdb_client.MakeDirectory(path,mode);
586 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM);
588 log->Printf ("PlatformRemoteGDBServer::MakeDirectory(path='%s', mode=%o) error = %u (%s)", path, mode, error.GetError(), error.AsCString());
594 PlatformRemoteGDBServer::GetFilePermissions (const char *path, uint32_t &file_permissions)
596 Error error = m_gdb_client.GetFilePermissions(path, file_permissions);
597 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM);
599 log->Printf ("PlatformRemoteGDBServer::GetFilePermissions(path='%s', file_permissions=%o) error = %u (%s)", path, file_permissions, error.GetError(), error.AsCString());
604 PlatformRemoteGDBServer::SetFilePermissions (const char *path, uint32_t file_permissions)
606 Error error = m_gdb_client.SetFilePermissions(path, file_permissions);
607 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM);
609 log->Printf ("PlatformRemoteGDBServer::SetFilePermissions(path='%s', file_permissions=%o) error = %u (%s)", path, file_permissions, error.GetError(), error.AsCString());
615 PlatformRemoteGDBServer::OpenFile (const lldb_private::FileSpec& file_spec,
620 return m_gdb_client.OpenFile (file_spec, flags, mode, error);
624 PlatformRemoteGDBServer::CloseFile (lldb::user_id_t fd, Error &error)
626 return m_gdb_client.CloseFile (fd, error);
630 PlatformRemoteGDBServer::GetFileSize (const lldb_private::FileSpec& file_spec)
632 return m_gdb_client.GetFileSize(file_spec);
636 PlatformRemoteGDBServer::ReadFile (lldb::user_id_t fd,
642 return m_gdb_client.ReadFile (fd, offset, dst, dst_len, error);
646 PlatformRemoteGDBServer::WriteFile (lldb::user_id_t fd,
652 return m_gdb_client.WriteFile (fd, offset, src, src_len, error);
656 PlatformRemoteGDBServer::PutFile (const lldb_private::FileSpec& source,
657 const lldb_private::FileSpec& destination,
661 return Platform::PutFile(source,destination,uid,gid);
665 PlatformRemoteGDBServer::CreateSymlink (const char *src, // The name of the link is in src
666 const char *dst) // The symlink points to dst
668 Error error = m_gdb_client.CreateSymlink (src, dst);
669 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM);
671 log->Printf ("PlatformRemoteGDBServer::CreateSymlink(src='%s', dst='%s') error = %u (%s)", src, dst, error.GetError(), error.AsCString());
676 PlatformRemoteGDBServer::Unlink (const char *path)
678 Error error = m_gdb_client.Unlink (path);
679 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM);
681 log->Printf ("PlatformRemoteGDBServer::Unlink(path='%s') error = %u (%s)", path, error.GetError(), error.AsCString());
686 PlatformRemoteGDBServer::GetFileExists (const lldb_private::FileSpec& file_spec)
688 return m_gdb_client.GetFileExists (file_spec);
692 PlatformRemoteGDBServer::RunShellCommand (const char *command, // Shouldn't be NULL
693 const char *working_dir, // Pass NULL to use the current working directory
694 int *status_ptr, // Pass NULL if you don't want the process exit status
695 int *signo_ptr, // Pass NULL if you don't want the signal that caused the process to exit
696 std::string *command_output, // Pass NULL if you don't want the command output
697 uint32_t timeout_sec) // Timeout in seconds to wait for shell program to finish
699 return m_gdb_client.RunShellCommand (command, working_dir, status_ptr, signo_ptr, command_output, timeout_sec);
703 PlatformRemoteGDBServer::CalculateTrapHandlerSymbolNames ()
705 m_trap_handlers.push_back (ConstString ("_sigtramp"));