Files
clang-p2996/lldb/source/Plugins/Platform/MacOSX/PlatformRemoteiOS.cpp
Greg Clayton 3f24d36160 <rdar://problem/11259893>
Fixed an issue where iOS debugging would trust the first file it found in the SDK regardless of the UUID not matching. Now we actually get smart and can find modules in ANY of the installed SDKs and remember which SDK is our fallback SDK.

llvm-svn: 155184
2012-04-20 02:02:02 +00:00

763 lines
27 KiB
C++

//===-- PlatformRemoteiOS.cpp -----------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "PlatformRemoteiOS.h"
// C Includes
// C++ Includes
// Other libraries and framework includes
// Project includes
#include "lldb/Breakpoint/BreakpointLocation.h"
#include "lldb/Core/ArchSpec.h"
#include "lldb/Core/Error.h"
#include "lldb/Core/Module.h"
#include "lldb/Core/ModuleList.h"
#include "lldb/Core/PluginManager.h"
#include "lldb/Core/StreamString.h"
#include "lldb/Host/FileSpec.h"
#include "lldb/Host/Host.h"
#include "lldb/Target/Process.h"
#include "lldb/Target/Target.h"
using namespace lldb;
using namespace lldb_private;
PlatformRemoteiOS::SDKDirectoryInfo::SDKDirectoryInfo (const lldb_private::FileSpec &sdk_dir) :
directory(sdk_dir),
build(),
version_major(0),
version_minor(0),
version_update(0),
user_cached(false)
{
const char *dirname_cstr = sdk_dir.GetFilename().GetCString();
const char *pos = Args::StringToVersion (dirname_cstr,
version_major,
version_minor,
version_update);
if (pos && pos[0] == ' ' && pos[1] == '(')
{
const char *build_start = pos + 2;
const char *end_paren = strchr (build_start, ')');
if (end_paren && build_start < end_paren)
build.SetCStringWithLength(build_start, end_paren - build_start);
}
}
//------------------------------------------------------------------
// Static Variables
//------------------------------------------------------------------
static uint32_t g_initialize_count = 0;
//------------------------------------------------------------------
// Static Functions
//------------------------------------------------------------------
void
PlatformRemoteiOS::Initialize ()
{
if (g_initialize_count++ == 0)
{
PluginManager::RegisterPlugin (PlatformRemoteiOS::GetShortPluginNameStatic(),
PlatformRemoteiOS::GetDescriptionStatic(),
PlatformRemoteiOS::CreateInstance);
}
}
void
PlatformRemoteiOS::Terminate ()
{
if (g_initialize_count > 0)
{
if (--g_initialize_count == 0)
{
PluginManager::UnregisterPlugin (PlatformRemoteiOS::CreateInstance);
}
}
}
Platform*
PlatformRemoteiOS::CreateInstance (bool force, const ArchSpec *arch)
{
bool create = force;
if (create == false && arch && arch->IsValid())
{
switch (arch->GetMachine())
{
case llvm::Triple::arm:
case llvm::Triple::thumb:
{
const llvm::Triple &triple = arch->GetTriple();
const llvm::Triple::OSType os = triple.getOS();
const llvm::Triple::VendorType vendor = triple.getVendor();
if (os == llvm::Triple::Darwin && vendor == llvm::Triple::Apple)
create = true;
}
break;
default:
break;
}
}
if (create)
return new PlatformRemoteiOS ();
return NULL;
}
const char *
PlatformRemoteiOS::GetPluginNameStatic ()
{
return "PlatformRemoteiOS";
}
const char *
PlatformRemoteiOS::GetShortPluginNameStatic()
{
return "remote-ios";
}
const char *
PlatformRemoteiOS::GetDescriptionStatic()
{
return "Remote iOS platform plug-in.";
}
//------------------------------------------------------------------
/// Default Constructor
//------------------------------------------------------------------
PlatformRemoteiOS::PlatformRemoteiOS () :
PlatformDarwin (false), // This is a remote platform
m_sdk_directory_infos(),
m_device_support_directory(),
m_device_support_directory_for_os_version (),
m_build_update(),
m_last_module_sdk_idx(UINT32_MAX)
{
}
//------------------------------------------------------------------
/// Destructor.
///
/// The destructor is virtual since this class is designed to be
/// inherited from by the plug-in instance.
//------------------------------------------------------------------
PlatformRemoteiOS::~PlatformRemoteiOS()
{
}
void
PlatformRemoteiOS::GetStatus (Stream &strm)
{
Platform::GetStatus (strm);
const char *sdk_directory = GetDeviceSupportDirectoryForOSVersion();
if (sdk_directory)
strm.Printf (" SDK Path: \"%s\"\n", sdk_directory);
else
strm.PutCString (" SDK Path: error: unable to locate SDK\n");
const uint32_t num_sdk_infos = m_sdk_directory_infos.size();
for (uint32_t i=0; i<num_sdk_infos; ++i)
{
const SDKDirectoryInfo &sdk_dir_info = m_sdk_directory_infos[i];
strm.Printf (" SDK Roots: [%2u] \"%s/%s\"\n",
i,
sdk_dir_info.directory.GetDirectory().GetCString(),
sdk_dir_info.directory.GetFilename().GetCString());
}
}
Error
PlatformRemoteiOS::ResolveExecutable (const FileSpec &exe_file,
const ArchSpec &exe_arch,
lldb::ModuleSP &exe_module_sp,
const FileSpecList *module_search_paths_ptr)
{
Error error;
// Nothing special to do here, just use the actual file and architecture
FileSpec resolved_exe_file (exe_file);
// If we have "ls" as the exe_file, resolve the executable loation based on
// the current path variables
// TODO: resolve bare executables in the Platform SDK
// if (!resolved_exe_file.Exists())
// resolved_exe_file.ResolveExecutableLocation ();
// Resolve any executable within a bundle on MacOSX
// TODO: verify that this handles shallow bundles, if not then implement one ourselves
Host::ResolveExecutableInBundle (resolved_exe_file);
if (resolved_exe_file.Exists())
{
if (exe_arch.IsValid())
{
ModuleSpec module_spec (resolved_exe_file, exe_arch);
error = ModuleList::GetSharedModule (module_spec,
exe_module_sp,
NULL,
NULL,
NULL);
if (exe_module_sp && exe_module_sp->GetObjectFile())
return error;
exe_module_sp.reset();
}
// No valid architecture was specified or the exact ARM slice wasn't
// found so ask the platform for the architectures that we should be
// using (in the correct order) and see if we can find a match that way
StreamString arch_names;
ArchSpec platform_arch;
for (uint32_t idx = 0; GetSupportedArchitectureAtIndex (idx, platform_arch); ++idx)
{
ModuleSpec module_spec (resolved_exe_file, platform_arch);
error = ModuleList::GetSharedModule (module_spec,
exe_module_sp,
NULL,
NULL,
NULL);
// Did we find an executable using one of the
if (error.Success())
{
if (exe_module_sp && exe_module_sp->GetObjectFile())
break;
else
error.SetErrorToGenericError();
}
if (idx > 0)
arch_names.PutCString (", ");
arch_names.PutCString (platform_arch.GetArchitectureName());
}
if (error.Fail() || !exe_module_sp)
{
error.SetErrorStringWithFormat ("'%s%s%s' doesn't contain any '%s' platform architectures: %s",
exe_file.GetDirectory().AsCString(""),
exe_file.GetDirectory() ? "/" : "",
exe_file.GetFilename().AsCString(""),
GetShortPluginName(),
arch_names.GetString().c_str());
}
}
else
{
error.SetErrorStringWithFormat ("'%s%s%s' does not exist",
exe_file.GetDirectory().AsCString(""),
exe_file.GetDirectory() ? "/" : "",
exe_file.GetFilename().AsCString(""));
}
return error;
}
FileSpec::EnumerateDirectoryResult
PlatformRemoteiOS::GetContainedFilesIntoVectorOfStringsCallback (void *baton,
FileSpec::FileType file_type,
const FileSpec &file_spec)
{
((PlatformRemoteiOS::SDKDirectoryInfoCollection *)baton)->push_back(PlatformRemoteiOS::SDKDirectoryInfo(file_spec));
return FileSpec::eEnumerateDirectoryResultNext;
}
bool
PlatformRemoteiOS::UpdateSDKDirectoryInfosInNeeded()
{
if (m_sdk_directory_infos.empty())
{
const char *device_support_dir = GetDeviceSupportDirectory();
if (device_support_dir)
{
const bool find_directories = true;
const bool find_files = false;
const bool find_other = false;
FileSpec::EnumerateDirectory (m_device_support_directory.c_str(),
find_directories,
find_files,
find_other,
GetContainedFilesIntoVectorOfStringsCallback,
&m_sdk_directory_infos);
const uint32_t num_installed = m_sdk_directory_infos.size();
FileSpec local_sdk_cache("~/Library/Developer/Xcode/iOS DeviceSupport", true);
if (local_sdk_cache.Exists())
{
char path[PATH_MAX];
if (local_sdk_cache.GetPath(path, sizeof(path)))
{
FileSpec::EnumerateDirectory (path,
find_directories,
find_files,
find_other,
GetContainedFilesIntoVectorOfStringsCallback,
&m_sdk_directory_infos);
const uint32_t num_sdk_infos = m_sdk_directory_infos.size();
// First try for an exact match of major, minor and update
for (uint32_t i=num_installed; i<num_sdk_infos; ++i)
{
m_sdk_directory_infos[i].user_cached = true;
}
}
}
}
}
return !m_sdk_directory_infos.empty();
}
const PlatformRemoteiOS::SDKDirectoryInfo *
PlatformRemoteiOS::GetSDKDirectoryForCurrentOSVersion ()
{
uint32_t i;
if (UpdateSDKDirectoryInfosInNeeded())
{
const uint32_t num_sdk_infos = m_sdk_directory_infos.size();
// Check to see if the user specified a build string. If they did, then
// be sure to match it.
std::vector<bool> check_sdk_info(num_sdk_infos, true);
ConstString build(m_sdk_build);
if (build)
{
for (i=0; i<num_sdk_infos; ++i)
check_sdk_info[i] = m_sdk_directory_infos[i].build == build;
}
// If we are connected we can find the version of the OS the platform
// us running on and select the right SDK
uint32_t major, minor, update;
if (GetOSVersion(major, minor, update))
{
if (UpdateSDKDirectoryInfosInNeeded())
{
// First try for an exact match of major, minor and update
for (i=0; i<num_sdk_infos; ++i)
{
if (check_sdk_info[i])
{
if (m_sdk_directory_infos[i].version_major == major &&
m_sdk_directory_infos[i].version_minor == minor &&
m_sdk_directory_infos[i].version_update == update)
{
return &m_sdk_directory_infos[i];
}
}
}
// First try for an exact match of major and minor
for (i=0; i<num_sdk_infos; ++i)
{
if (check_sdk_info[i])
{
if (m_sdk_directory_infos[i].version_major == major &&
m_sdk_directory_infos[i].version_minor == minor)
{
return &m_sdk_directory_infos[i];
}
}
}
// Lastly try to match of major version only..
for (i=0; i<num_sdk_infos; ++i)
{
if (check_sdk_info[i])
{
if (m_sdk_directory_infos[i].version_major == major)
{
return &m_sdk_directory_infos[i];
}
}
}
}
}
else if (build)
{
// No version, just a build number, search for the first one that matches
for (i=0; i<num_sdk_infos; ++i)
if (check_sdk_info[i])
return &m_sdk_directory_infos[i];
}
}
return NULL;
}
const PlatformRemoteiOS::SDKDirectoryInfo *
PlatformRemoteiOS::GetSDKDirectoryForLatestOSVersion ()
{
const PlatformRemoteiOS::SDKDirectoryInfo *result = NULL;
if (UpdateSDKDirectoryInfosInNeeded())
{
const uint32_t num_sdk_infos = m_sdk_directory_infos.size();
// First try for an exact match of major, minor and update
for (uint32_t i=0; i<num_sdk_infos; ++i)
{
const SDKDirectoryInfo &sdk_dir_info = m_sdk_directory_infos[i];
if (sdk_dir_info.version_major != UINT32_MAX)
{
if (result == NULL || sdk_dir_info.version_major > result->version_major)
{
result = &sdk_dir_info;
}
else if (sdk_dir_info.version_major == result->version_major)
{
if (sdk_dir_info.version_minor > result->version_minor)
{
result = &sdk_dir_info;
}
else if (sdk_dir_info.version_minor == result->version_minor)
{
if (sdk_dir_info.version_update > result->version_update)
{
result = &sdk_dir_info;
}
}
}
}
}
}
return result;
}
const char *
PlatformRemoteiOS::GetDeviceSupportDirectory()
{
if (m_device_support_directory.empty())
{
const char *device_support_dir = GetDeveloperDirectory();
if (device_support_dir)
{
m_device_support_directory.assign (device_support_dir);
m_device_support_directory.append ("/Platforms/iPhoneOS.platform/DeviceSupport");
}
else
{
// Assign a single NULL character so we know we tried to find the device
// support directory and we don't keep trying to find it over and over.
m_device_support_directory.assign (1, '\0');
}
}
// We should have put a single NULL character into m_device_support_directory
// or it should have a valid path if the code gets here
assert (m_device_support_directory.empty() == false);
if (m_device_support_directory[0])
return m_device_support_directory.c_str();
return NULL;
}
const char *
PlatformRemoteiOS::GetDeviceSupportDirectoryForOSVersion()
{
if (m_sdk_sysroot)
return m_sdk_sysroot.GetCString();
if (m_device_support_directory_for_os_version.empty())
{
const PlatformRemoteiOS::SDKDirectoryInfo *sdk_dir_info = GetSDKDirectoryForCurrentOSVersion ();
if (sdk_dir_info == NULL)
sdk_dir_info = GetSDKDirectoryForLatestOSVersion ();
if (sdk_dir_info)
{
char path[PATH_MAX];
if (sdk_dir_info->directory.GetPath(path, sizeof(path)))
{
m_device_support_directory_for_os_version = path;
return m_device_support_directory_for_os_version.c_str();
}
}
else
{
// Assign a single NULL character so we know we tried to find the device
// support directory and we don't keep trying to find it over and over.
m_device_support_directory_for_os_version.assign (1, '\0');
}
}
// We should have put a single NULL character into m_device_support_directory_for_os_version
// or it should have a valid path if the code gets here
assert (m_device_support_directory_for_os_version.empty() == false);
if (m_device_support_directory_for_os_version[0])
return m_device_support_directory_for_os_version.c_str();
return NULL;
}
uint32_t
PlatformRemoteiOS::FindFileInAllSDKs (const char *platform_file_path,
FileSpecList &file_list)
{
if (platform_file_path && platform_file_path[0] && UpdateSDKDirectoryInfosInNeeded())
{
const uint32_t num_sdk_infos = m_sdk_directory_infos.size();
lldb_private::FileSpec local_file;
// First try for an exact match of major, minor and update
for (uint32_t sdk_idx=0; sdk_idx<num_sdk_infos; ++sdk_idx)
{
if (GetFileInSDK (platform_file_path,
sdk_idx,
local_file))
{
file_list.Append(local_file);
}
}
}
return file_list.GetSize();
}
bool
PlatformRemoteiOS::GetFileInSDK (const char *platform_file_path,
uint32_t sdk_idx,
lldb_private::FileSpec &local_file)
{
if (sdk_idx < m_sdk_directory_infos.size())
{
char sdkroot_path[PATH_MAX];
const SDKDirectoryInfo &sdk_dir_info = m_sdk_directory_infos[sdk_idx];
if (sdk_dir_info.directory.GetPath(sdkroot_path, sizeof(sdkroot_path)))
{
const bool symbols_dirs_only = true;
return GetFileInSDKRoot (platform_file_path,
sdkroot_path,
symbols_dirs_only,
local_file);
}
}
return false;
}
bool
PlatformRemoteiOS::GetFileInSDKRoot (const char *platform_file_path,
const char *sdkroot_path,
bool symbols_dirs_only,
lldb_private::FileSpec &local_file)
{
if (sdkroot_path && sdkroot_path[0] && platform_file_path && platform_file_path[0])
{
char resolved_path[PATH_MAX];
if (!symbols_dirs_only)
{
::snprintf (resolved_path,
sizeof(resolved_path),
"%s/%s",
sdkroot_path,
platform_file_path);
local_file.SetFile(resolved_path, true);
if (local_file.Exists())
return true;
}
::snprintf (resolved_path,
sizeof(resolved_path),
"%s/Symbols.Internal/%s",
sdkroot_path,
platform_file_path);
local_file.SetFile(resolved_path, true);
if (local_file.Exists())
return true;
::snprintf (resolved_path,
sizeof(resolved_path),
"%s/Symbols/%s",
sdkroot_path,
platform_file_path);
local_file.SetFile(resolved_path, true);
if (local_file.Exists())
return true;
}
return false;
}
Error
PlatformRemoteiOS::GetFile (const FileSpec &platform_file,
const UUID *uuid_ptr,
FileSpec &local_file)
{
Error error;
char platform_file_path[PATH_MAX];
if (platform_file.GetPath(platform_file_path, sizeof(platform_file_path)))
{
char resolved_path[PATH_MAX];
const char * os_version_dir = GetDeviceSupportDirectoryForOSVersion();
if (os_version_dir)
{
::snprintf (resolved_path,
sizeof(resolved_path),
"%s/%s",
os_version_dir,
platform_file_path);
local_file.SetFile(resolved_path, true);
if (local_file.Exists())
return error;
::snprintf (resolved_path,
sizeof(resolved_path),
"%s/Symbols.Internal/%s",
os_version_dir,
platform_file_path);
local_file.SetFile(resolved_path, true);
if (local_file.Exists())
return error;
::snprintf (resolved_path,
sizeof(resolved_path),
"%s/Symbols/%s",
os_version_dir,
platform_file_path);
local_file.SetFile(resolved_path, true);
if (local_file.Exists())
return error;
}
local_file = platform_file;
if (local_file.Exists())
return error;
error.SetErrorStringWithFormat ("unable to locate a platform file for '%s' in platform '%s'",
platform_file_path,
GetPluginName());
}
else
{
error.SetErrorString ("invalid platform file argument");
}
return error;
}
Error
PlatformRemoteiOS::GetSharedModule (const ModuleSpec &module_spec,
ModuleSP &module_sp,
const FileSpecList *module_search_paths_ptr,
ModuleSP *old_module_sp_ptr,
bool *did_create_ptr)
{
// For iOS, the SDK files are all cached locally on the host
// system. So first we ask for the file in the cached SDK,
// then we attempt to get a shared module for the right architecture
// with the right UUID.
const FileSpec &platform_file = module_spec.GetFileSpec();
FileSpec local_file;
const UUID *module_uuid_ptr = module_spec.GetUUIDPtr();
Error error (GetFile (platform_file, module_uuid_ptr, local_file));
if (error.Success())
{
error = ResolveExecutable (local_file, module_spec.GetArchitecture(), module_sp, NULL);
if (module_sp && ((module_uuid_ptr == NULL) || (module_sp->GetUUID() == *module_uuid_ptr)))
{
//printf ("found in user specified SDK\n");
error.Clear();
return error;
}
char platform_file_path[PATH_MAX];
if (platform_file.GetPath(platform_file_path, sizeof(platform_file_path)))
{
FileSpec local_file;
const uint32_t num_sdk_infos = m_sdk_directory_infos.size();
// Try the last SDK index if it is set as most files from an SDK
// will tend to be valid in that same SDK.
if (m_last_module_sdk_idx < num_sdk_infos)
{
if (GetFileInSDK (platform_file_path, m_last_module_sdk_idx, local_file))
{
//printf ("sdk[%u] last: '%s/%s'\n", m_last_module_sdk_idx, local_file.GetDirectory().GetCString(), local_file.GetFilename().GetCString());
module_sp.reset();
error = ResolveExecutable (local_file,
module_spec.GetArchitecture(),
module_sp,
NULL);
if (module_sp && module_sp->GetUUID() == *module_uuid_ptr)
{
//printf ("sdk[%u] last found\n", m_last_module_sdk_idx);
error.Clear();
return error;
}
}
}
// First try for an exact match of major, minor and update
for (uint32_t sdk_idx=0; sdk_idx<num_sdk_infos; ++sdk_idx)
{
if (m_last_module_sdk_idx == sdk_idx)
{
// Skip the last module SDK index if we already searched
// it above
continue;
}
if (GetFileInSDK (platform_file_path, sdk_idx, local_file))
{
//printf ("sdk[%u]: '%s/%s'\n", sdk_idx, local_file.GetDirectory().GetCString(), local_file.GetFilename().GetCString());
error = ResolveExecutable (local_file,
module_spec.GetArchitecture(),
module_sp,
NULL);
if (module_sp && module_sp->GetUUID() == *module_uuid_ptr)
{
// Remember the index of the last SDK that we found a file
// in in case the wrong SDK was selected.
m_last_module_sdk_idx = sdk_idx;
//printf ("sdk[%u]: found (setting last to %u)\n", sdk_idx, m_last_module_sdk_idx);
error.Clear();
return error;
}
}
}
}
// Not the module we are looking for... Nothing to see here...
module_sp.reset();
}
const bool always_create = false;
error = ModuleList::GetSharedModule (module_spec,
module_sp,
module_search_paths_ptr,
old_module_sp_ptr,
did_create_ptr,
always_create);
if (module_sp)
module_sp->SetPlatformFileSpec(platform_file);
return error;
}
uint32_t
PlatformRemoteiOS::FindProcesses (const ProcessInstanceInfoMatch &match_info,
ProcessInstanceInfoList &process_infos)
{
// TODO: if connected, send a packet to get the remote process infos by name
process_infos.Clear();
return 0;
}
bool
PlatformRemoteiOS::GetProcessInfo (lldb::pid_t pid, ProcessInstanceInfo &process_info)
{
// TODO: if connected, send a packet to get the remote process info
process_info.Clear();
return false;
}
bool
PlatformRemoteiOS::GetSupportedArchitectureAtIndex (uint32_t idx, ArchSpec &arch)
{
return ARMGetSupportedArchitectureAtIndex (idx, arch);
}