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::GetFile (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());
269 m_gdb_client.TestPacketSpeed(10000);
274 m_gdb_client.Disconnect();
276 error.SetErrorString("handshake failed");
282 error.SetErrorString ("\"platform connect\" takes a single argument: <connect-url>");
290 PlatformRemoteGDBServer::DisconnectRemote ()
293 m_gdb_client.Disconnect(&error);
298 PlatformRemoteGDBServer::GetHostname ()
300 m_gdb_client.GetHostname (m_name);
303 return m_name.c_str();
307 PlatformRemoteGDBServer::GetUserName (uint32_t uid)
309 // Try and get a cache user name first
310 const char *cached_user_name = Platform::GetUserName(uid);
311 if (cached_user_name)
312 return cached_user_name;
314 if (m_gdb_client.GetUserName(uid, name))
315 return SetCachedUserName(uid, name.c_str(), name.size());
317 SetUserNameNotFound(uid); // Negative cache so we don't keep sending packets
322 PlatformRemoteGDBServer::GetGroupName (uint32_t gid)
324 const char *cached_group_name = Platform::GetGroupName(gid);
325 if (cached_group_name)
326 return cached_group_name;
328 if (m_gdb_client.GetGroupName(gid, name))
329 return SetCachedGroupName(gid, name.c_str(), name.size());
331 SetGroupNameNotFound(gid); // Negative cache so we don't keep sending packets
336 PlatformRemoteGDBServer::FindProcesses (const ProcessInstanceInfoMatch &match_info,
337 ProcessInstanceInfoList &process_infos)
339 return m_gdb_client.FindProcesses (match_info, process_infos);
343 PlatformRemoteGDBServer::GetProcessInfo (lldb::pid_t pid, ProcessInstanceInfo &process_info)
345 return m_gdb_client.GetProcessInfo (pid, process_info);
350 PlatformRemoteGDBServer::LaunchProcess (ProcessLaunchInfo &launch_info)
353 lldb::pid_t pid = LLDB_INVALID_PROCESS_ID;
355 m_gdb_client.SetSTDIN ("/dev/null");
356 m_gdb_client.SetSTDOUT ("/dev/null");
357 m_gdb_client.SetSTDERR ("/dev/null");
358 m_gdb_client.SetDisableASLR (launch_info.GetFlags().Test (eLaunchFlagDisableASLR));
360 const char *working_dir = launch_info.GetWorkingDirectory();
361 if (working_dir && working_dir[0])
363 m_gdb_client.SetWorkingDir (working_dir);
366 // Send the environment and the program + arguments after we connect
367 const char **envp = launch_info.GetEnvironmentEntries().GetConstArgumentVector();
371 const char *env_entry;
372 for (int i=0; (env_entry = envp[i]); ++i)
374 if (m_gdb_client.SendEnvironmentPacket(env_entry) != 0)
379 ArchSpec arch_spec = launch_info.GetArchitecture();
380 const char *arch_triple = arch_spec.GetTriple().str().c_str();
382 m_gdb_client.SendLaunchArchPacket(arch_triple);
384 const uint32_t old_packet_timeout = m_gdb_client.SetPacketTimeout (5);
385 int arg_packet_err = m_gdb_client.SendArgumentsPacket (launch_info);
386 m_gdb_client.SetPacketTimeout (old_packet_timeout);
387 if (arg_packet_err == 0)
389 std::string error_str;
390 if (m_gdb_client.GetLaunchSuccess (error_str))
392 pid = m_gdb_client.GetCurrentProcessID ();
393 if (pid != LLDB_INVALID_PROCESS_ID)
394 launch_info.SetProcessID (pid);
398 error.SetErrorString (error_str.c_str());
403 error.SetErrorStringWithFormat("'A' packet returned an error: %i", arg_packet_err);
409 PlatformRemoteGDBServer::DebugProcess (lldb_private::ProcessLaunchInfo &launch_info,
410 lldb_private::Debugger &debugger,
411 lldb_private::Target *target, // Can be NULL, if NULL create a new target, else use existing one
412 lldb_private::Listener &listener,
413 lldb_private::Error &error)
415 lldb::ProcessSP process_sp;
420 lldb::pid_t debugserver_pid = LLDB_INVALID_PROCESS_ID;
421 uint16_t port = m_gdb_client.LaunchGDBserverAndGetPort(debugserver_pid);
425 error.SetErrorStringWithFormat ("unable to launch a GDB server on '%s'", GetHostname ());
431 TargetSP new_target_sp;
433 error = debugger.GetTargetList().CreateTarget (debugger,
439 target = new_target_sp.get();
444 if (target && error.Success())
446 debugger.GetTargetList().SetSelectedTarget(target);
448 // The darwin always currently uses the GDB remote debugger plug-in
449 // so even when debugging locally we are debugging remotely!
450 process_sp = target->CreateProcess (listener, "gdb-remote", NULL);
454 char connect_url[256];
455 const char *override_hostname = getenv("LLDB_PLATFORM_REMOTE_GDB_SERVER_HOSTNAME");
456 const char *port_offset_c_str = getenv("LLDB_PLATFORM_REMOTE_GDB_SERVER_PORT_OFFSET");
457 int port_offset = port_offset_c_str ? ::atoi(port_offset_c_str) : 0;
458 const int connect_url_len = ::snprintf (connect_url,
461 override_hostname ? override_hostname : GetHostname (),
463 assert (connect_url_len < (int)sizeof(connect_url));
464 error = process_sp->ConnectRemote (NULL, connect_url);
466 error = process_sp->Launch(launch_info);
467 else if (debugserver_pid != LLDB_INVALID_PROCESS_ID)
468 m_gdb_client.KillSpawnedProcess(debugserver_pid);
475 error.SetErrorString("not connected to remote gdb server");
483 PlatformRemoteGDBServer::Attach (lldb_private::ProcessAttachInfo &attach_info,
485 Target *target, // Can be NULL, if NULL create a new target, else use existing one
489 lldb::ProcessSP process_sp;
494 lldb::pid_t debugserver_pid = LLDB_INVALID_PROCESS_ID;
495 uint16_t port = m_gdb_client.LaunchGDBserverAndGetPort(debugserver_pid);
499 error.SetErrorStringWithFormat ("unable to launch a GDB server on '%s'", GetHostname ());
505 TargetSP new_target_sp;
507 error = debugger.GetTargetList().CreateTarget (debugger,
513 target = new_target_sp.get();
518 if (target && error.Success())
520 debugger.GetTargetList().SetSelectedTarget(target);
522 // The darwin always currently uses the GDB remote debugger plug-in
523 // so even when debugging locally we are debugging remotely!
524 process_sp = target->CreateProcess (listener, "gdb-remote", NULL);
528 char connect_url[256];
529 const char *override_hostname = getenv("LLDB_PLATFORM_REMOTE_GDB_SERVER_HOSTNAME");
530 const char *port_offset_c_str = getenv("LLDB_PLATFORM_REMOTE_GDB_SERVER_PORT_OFFSET");
531 int port_offset = port_offset_c_str ? ::atoi(port_offset_c_str) : 0;
532 const int connect_url_len = ::snprintf (connect_url,
535 override_hostname ? override_hostname : GetHostname (),
537 assert (connect_url_len < (int)sizeof(connect_url));
538 error = process_sp->ConnectRemote (NULL, connect_url);
540 error = process_sp->Attach(attach_info);
541 else if (debugserver_pid != LLDB_INVALID_PROCESS_ID)
543 m_gdb_client.KillSpawnedProcess(debugserver_pid);
551 error.SetErrorString("not connected to remote gdb server");
558 PlatformRemoteGDBServer::MakeDirectory (const char *path, uint32_t mode)
560 Error error = m_gdb_client.MakeDirectory(path,mode);
561 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM);
563 log->Printf ("PlatformRemoteGDBServer::MakeDirectory(path='%s', mode=%o) error = %u (%s)", path, mode, error.GetError(), error.AsCString());
569 PlatformRemoteGDBServer::GetFilePermissions (const char *path, uint32_t &file_permissions)
571 Error error = m_gdb_client.GetFilePermissions(path, file_permissions);
572 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM);
574 log->Printf ("PlatformRemoteGDBServer::GetFilePermissions(path='%s', file_permissions=%o) error = %u (%s)", path, file_permissions, error.GetError(), error.AsCString());
579 PlatformRemoteGDBServer::SetFilePermissions (const char *path, uint32_t file_permissions)
581 Error error = m_gdb_client.SetFilePermissions(path, file_permissions);
582 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM);
584 log->Printf ("PlatformRemoteGDBServer::SetFilePermissions(path='%s', file_permissions=%o) error = %u (%s)", path, file_permissions, error.GetError(), error.AsCString());
590 PlatformRemoteGDBServer::OpenFile (const lldb_private::FileSpec& file_spec,
595 return m_gdb_client.OpenFile (file_spec, flags, mode, error);
599 PlatformRemoteGDBServer::CloseFile (lldb::user_id_t fd, Error &error)
601 return m_gdb_client.CloseFile (fd, error);
605 PlatformRemoteGDBServer::GetFileSize (const lldb_private::FileSpec& file_spec)
607 return m_gdb_client.GetFileSize(file_spec);
611 PlatformRemoteGDBServer::ReadFile (lldb::user_id_t fd,
617 return m_gdb_client.ReadFile (fd, offset, dst, dst_len, error);
621 PlatformRemoteGDBServer::WriteFile (lldb::user_id_t fd,
627 return m_gdb_client.WriteFile (fd, offset, src, src_len, error);
631 PlatformRemoteGDBServer::PutFile (const lldb_private::FileSpec& source,
632 const lldb_private::FileSpec& destination,
636 return Platform::PutFile(source,destination,uid,gid);
640 PlatformRemoteGDBServer::CreateSymlink (const char *src, // The name of the link is in src
641 const char *dst) // The symlink points to dst
643 Error error = m_gdb_client.CreateSymlink (src, dst);
644 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM);
646 log->Printf ("PlatformRemoteGDBServer::CreateSymlink(src='%s', dst='%s') error = %u (%s)", src, dst, error.GetError(), error.AsCString());
651 PlatformRemoteGDBServer::Unlink (const char *path)
653 Error error = m_gdb_client.Unlink (path);
654 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM);
656 log->Printf ("PlatformRemoteGDBServer::Unlink(path='%s') error = %u (%s)", path, error.GetError(), error.AsCString());
661 PlatformRemoteGDBServer::GetFileExists (const lldb_private::FileSpec& file_spec)
663 return m_gdb_client.GetFileExists (file_spec);
667 PlatformRemoteGDBServer::RunShellCommand (const char *command, // Shouldn't be NULL
668 const char *working_dir, // Pass NULL to use the current working directory
669 int *status_ptr, // Pass NULL if you don't want the process exit status
670 int *signo_ptr, // Pass NULL if you don't want the signal that caused the process to exit
671 std::string *command_output, // Pass NULL if you don't want the command output
672 uint32_t timeout_sec) // Timeout in seconds to wait for shell program to finish
674 return m_gdb_client.RunShellCommand (command, working_dir, status_ptr, signo_ptr, command_output, timeout_sec);