1e0f8f574SDaniel Malea //===-- PlatformPOSIX.cpp ---------------------------------------*- C++ -*-===// 2e0f8f574SDaniel Malea // 3*2946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4*2946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information. 5*2946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6e0f8f574SDaniel Malea // 7e0f8f574SDaniel Malea //===----------------------------------------------------------------------===// 8e0f8f574SDaniel Malea 9e0f8f574SDaniel Malea #include "PlatformPOSIX.h" 10e0f8f574SDaniel Malea 11e0f8f574SDaniel Malea 12348fb385STodd Fiala #include "lldb/Core/Debugger.h" 13348fb385STodd Fiala #include "lldb/Core/Module.h" 14fc89bbccSPavel Labath #include "lldb/Core/ModuleSpec.h" 153cb132a0STamas Berghammer #include "lldb/Core/ValueObject.h" 161ecb34f4SJim Ingham #include "lldb/Expression/DiagnosticManager.h" 171ecb34f4SJim Ingham #include "lldb/Expression/FunctionCaller.h" 183cb132a0STamas Berghammer #include "lldb/Expression/UserExpression.h" 191ecb34f4SJim Ingham #include "lldb/Expression/UtilityFunction.h" 20e0f8f574SDaniel Malea #include "lldb/Host/File.h" 21c00cf4a0SZachary Turner #include "lldb/Host/FileCache.h" 22c00cf4a0SZachary Turner #include "lldb/Host/FileSystem.h" 23e0f8f574SDaniel Malea #include "lldb/Host/Host.h" 24fc89bbccSPavel Labath #include "lldb/Host/HostInfo.h" 251ecb34f4SJim Ingham #include "lldb/Symbol/ClangASTContext.h" 263cb132a0STamas Berghammer #include "lldb/Target/DynamicLoader.h" 273cb132a0STamas Berghammer #include "lldb/Target/ExecutionContext.h" 28a78bd7ffSZachary Turner #include "lldb/Target/Process.h" 29015d818bSTodd Fiala #include "lldb/Target/ProcessLaunchInfo.h" 303cb132a0STamas Berghammer #include "lldb/Target/Thread.h" 311ecb34f4SJim Ingham #include "lldb/Utility/CleanUp.h" 32666cc0b2SZachary Turner #include "lldb/Utility/DataBufferHeap.h" 335713a05bSZachary Turner #include "lldb/Utility/FileSpec.h" 346f9e6901SZachary Turner #include "lldb/Utility/Log.h" 35bf9a7730SZachary Turner #include "lldb/Utility/StreamString.h" 36e0f8f574SDaniel Malea 37e0f8f574SDaniel Malea using namespace lldb; 38e0f8f574SDaniel Malea using namespace lldb_private; 39e0f8f574SDaniel Malea 40e0f8f574SDaniel Malea //------------------------------------------------------------------ 41e0f8f574SDaniel Malea /// Default Constructor 42e0f8f574SDaniel Malea //------------------------------------------------------------------ 43b9c1b51eSKate Stone PlatformPOSIX::PlatformPOSIX(bool is_host) 44b9c1b51eSKate Stone : Platform(is_host), // This is the local host platform 450a66e2f1SEnrico Granata m_option_group_platform_rsync(new OptionGroupPlatformRSync()), 460a66e2f1SEnrico Granata m_option_group_platform_ssh(new OptionGroupPlatformSSH()), 470a66e2f1SEnrico Granata m_option_group_platform_caching(new OptionGroupPlatformCaching()), 48b9c1b51eSKate Stone m_remote_platform_sp() {} 49e0f8f574SDaniel Malea 50e0f8f574SDaniel Malea //------------------------------------------------------------------ 51e0f8f574SDaniel Malea /// Destructor. 52e0f8f574SDaniel Malea /// 53e0f8f574SDaniel Malea /// The destructor is virtual since this class is designed to be 54e0f8f574SDaniel Malea /// inherited from by the plug-in instance. 55e0f8f574SDaniel Malea //------------------------------------------------------------------ 56b9c1b51eSKate Stone PlatformPOSIX::~PlatformPOSIX() {} 57e0f8f574SDaniel Malea 58b9c1b51eSKate Stone bool PlatformPOSIX::GetModuleSpec(const FileSpec &module_file_spec, 5963acdfdeSOleksiy Vyalov const ArchSpec &arch, 60b9c1b51eSKate Stone ModuleSpec &module_spec) { 6163acdfdeSOleksiy Vyalov if (m_remote_platform_sp) 62b9c1b51eSKate Stone return m_remote_platform_sp->GetModuleSpec(module_file_spec, arch, 63b9c1b51eSKate Stone module_spec); 6463acdfdeSOleksiy Vyalov 6563acdfdeSOleksiy Vyalov return Platform::GetModuleSpec(module_file_spec, arch, module_spec); 6663acdfdeSOleksiy Vyalov } 6763acdfdeSOleksiy Vyalov 68b9c1b51eSKate Stone lldb_private::OptionGroupOptions *PlatformPOSIX::GetConnectionOptions( 69b9c1b51eSKate Stone lldb_private::CommandInterpreter &interpreter) { 700a66e2f1SEnrico Granata auto iter = m_options.find(&interpreter), end = m_options.end(); 71b9c1b51eSKate Stone if (iter == end) { 72b9c1b51eSKate Stone std::unique_ptr<lldb_private::OptionGroupOptions> options( 73b9c1b51eSKate Stone new OptionGroupOptions()); 740a66e2f1SEnrico Granata options->Append(m_option_group_platform_rsync.get()); 750a66e2f1SEnrico Granata options->Append(m_option_group_platform_ssh.get()); 760a66e2f1SEnrico Granata options->Append(m_option_group_platform_caching.get()); 770a66e2f1SEnrico Granata m_options[&interpreter] = std::move(options); 78e0f8f574SDaniel Malea } 790a66e2f1SEnrico Granata 800a66e2f1SEnrico Granata return m_options.at(&interpreter).get(); 81e0f8f574SDaniel Malea } 82e0f8f574SDaniel Malea 83b9c1b51eSKate Stone bool PlatformPOSIX::IsConnected() const { 84015d818bSTodd Fiala if (IsHost()) 85015d818bSTodd Fiala return true; 86015d818bSTodd Fiala else if (m_remote_platform_sp) 87015d818bSTodd Fiala return m_remote_platform_sp->IsConnected(); 88015d818bSTodd Fiala return false; 89015d818bSTodd Fiala } 90015d818bSTodd Fiala 9197206d57SZachary Turner lldb_private::Status PlatformPOSIX::RunShellCommand( 92b9c1b51eSKate Stone const char *command, // Shouldn't be NULL 93b9c1b51eSKate Stone const FileSpec & 94b9c1b51eSKate Stone working_dir, // Pass empty FileSpec to use the current working directory 95e0f8f574SDaniel Malea int *status_ptr, // Pass NULL if you don't want the process exit status 96b9c1b51eSKate Stone int *signo_ptr, // Pass NULL if you don't want the signal that caused the 97b9c1b51eSKate Stone // process to exit 98b9c1b51eSKate Stone std::string 99b9c1b51eSKate Stone *command_output, // Pass NULL if you don't want the command output 10019dd1a0eSPavel Labath const Timeout<std::micro> &timeout) { 101e0f8f574SDaniel Malea if (IsHost()) 102b9c1b51eSKate Stone return Host::RunShellCommand(command, working_dir, status_ptr, signo_ptr, 10319dd1a0eSPavel Labath command_output, timeout); 104b9c1b51eSKate Stone else { 105e0f8f574SDaniel Malea if (m_remote_platform_sp) 10619dd1a0eSPavel Labath return m_remote_platform_sp->RunShellCommand( 10719dd1a0eSPavel Labath command, working_dir, status_ptr, signo_ptr, command_output, timeout); 108e0f8f574SDaniel Malea else 10997206d57SZachary Turner return Status("unable to run a remote command without a platform"); 110e0f8f574SDaniel Malea } 111e0f8f574SDaniel Malea } 112e0f8f574SDaniel Malea 11397206d57SZachary Turner Status 11497206d57SZachary Turner PlatformPOSIX::ResolveExecutable(const ModuleSpec &module_spec, 115fc89bbccSPavel Labath lldb::ModuleSP &exe_module_sp, 116fc89bbccSPavel Labath const FileSpecList *module_search_paths_ptr) { 11797206d57SZachary Turner Status error; 118fc89bbccSPavel Labath // Nothing special to do here, just use the actual file and architecture 119fc89bbccSPavel Labath 120fc89bbccSPavel Labath char exe_path[PATH_MAX]; 121fc89bbccSPavel Labath ModuleSpec resolved_module_spec(module_spec); 122fc89bbccSPavel Labath 123fc89bbccSPavel Labath if (IsHost()) { 12405097246SAdrian Prantl // If we have "ls" as the exe_file, resolve the executable location based 12505097246SAdrian Prantl // on the current path variables 126dbd7fabaSJonas Devlieghere if (!FileSystem::Instance().Exists(resolved_module_spec.GetFileSpec())) { 127fc89bbccSPavel Labath resolved_module_spec.GetFileSpec().GetPath(exe_path, sizeof(exe_path)); 1288f3be7a3SJonas Devlieghere resolved_module_spec.GetFileSpec().SetFile(exe_path, 129937348cdSJonas Devlieghere FileSpec::Style::native); 1308f3be7a3SJonas Devlieghere FileSystem::Instance().Resolve(resolved_module_spec.GetFileSpec()); 131fc89bbccSPavel Labath } 132fc89bbccSPavel Labath 133dbd7fabaSJonas Devlieghere if (!FileSystem::Instance().Exists(resolved_module_spec.GetFileSpec())) 1342c22c800SJonas Devlieghere FileSystem::Instance().ResolveExecutableLocation( 1352c22c800SJonas Devlieghere resolved_module_spec.GetFileSpec()); 136fc89bbccSPavel Labath 137fc89bbccSPavel Labath // Resolve any executable within a bundle on MacOSX 138fc89bbccSPavel Labath Host::ResolveExecutableInBundle(resolved_module_spec.GetFileSpec()); 139fc89bbccSPavel Labath 140dbd7fabaSJonas Devlieghere if (FileSystem::Instance().Exists(resolved_module_spec.GetFileSpec())) 141fc89bbccSPavel Labath error.Clear(); 142fc89bbccSPavel Labath else { 1437c5310bbSJonas Devlieghere const uint32_t permissions = FileSystem::Instance().GetPermissions( 1447c5310bbSJonas Devlieghere resolved_module_spec.GetFileSpec()); 145fc89bbccSPavel Labath if (permissions && (permissions & eFilePermissionsEveryoneR) == 0) 146fc89bbccSPavel Labath error.SetErrorStringWithFormat( 147fc89bbccSPavel Labath "executable '%s' is not readable", 148fc89bbccSPavel Labath resolved_module_spec.GetFileSpec().GetPath().c_str()); 149fc89bbccSPavel Labath else 150fc89bbccSPavel Labath error.SetErrorStringWithFormat( 151fc89bbccSPavel Labath "unable to find executable for '%s'", 152fc89bbccSPavel Labath resolved_module_spec.GetFileSpec().GetPath().c_str()); 153fc89bbccSPavel Labath } 154fc89bbccSPavel Labath } else { 155fc89bbccSPavel Labath if (m_remote_platform_sp) { 156fc89bbccSPavel Labath error = 157fc89bbccSPavel Labath GetCachedExecutable(resolved_module_spec, exe_module_sp, 158fc89bbccSPavel Labath module_search_paths_ptr, *m_remote_platform_sp); 159fc89bbccSPavel Labath } else { 160fc89bbccSPavel Labath // We may connect to a process and use the provided executable (Don't use 161fc89bbccSPavel Labath // local $PATH). 162fc89bbccSPavel Labath 163fc89bbccSPavel Labath // Resolve any executable within a bundle on MacOSX 164fc89bbccSPavel Labath Host::ResolveExecutableInBundle(resolved_module_spec.GetFileSpec()); 165fc89bbccSPavel Labath 166dbd7fabaSJonas Devlieghere if (FileSystem::Instance().Exists(resolved_module_spec.GetFileSpec())) 167fc89bbccSPavel Labath error.Clear(); 168fc89bbccSPavel Labath else 169fc89bbccSPavel Labath error.SetErrorStringWithFormat("the platform is not currently " 170fc89bbccSPavel Labath "connected, and '%s' doesn't exist in " 171fc89bbccSPavel Labath "the system root.", 172fc89bbccSPavel Labath exe_path); 173fc89bbccSPavel Labath } 174fc89bbccSPavel Labath } 175fc89bbccSPavel Labath 176fc89bbccSPavel Labath if (error.Success()) { 177fc89bbccSPavel Labath if (resolved_module_spec.GetArchitecture().IsValid()) { 178fc89bbccSPavel Labath error = ModuleList::GetSharedModule(resolved_module_spec, exe_module_sp, 179fc89bbccSPavel Labath module_search_paths_ptr, nullptr, nullptr); 180fc89bbccSPavel Labath if (error.Fail()) { 181fc89bbccSPavel Labath // If we failed, it may be because the vendor and os aren't known. If 182fc89bbccSPavel Labath // that is the case, try setting them to the host architecture and give 183fc89bbccSPavel Labath // it another try. 184fc89bbccSPavel Labath llvm::Triple &module_triple = 185fc89bbccSPavel Labath resolved_module_spec.GetArchitecture().GetTriple(); 186fc89bbccSPavel Labath bool is_vendor_specified = 187fc89bbccSPavel Labath (module_triple.getVendor() != llvm::Triple::UnknownVendor); 188fc89bbccSPavel Labath bool is_os_specified = 189fc89bbccSPavel Labath (module_triple.getOS() != llvm::Triple::UnknownOS); 190fc89bbccSPavel Labath if (!is_vendor_specified || !is_os_specified) { 191fc89bbccSPavel Labath const llvm::Triple &host_triple = 192fc89bbccSPavel Labath HostInfo::GetArchitecture(HostInfo::eArchKindDefault).GetTriple(); 193fc89bbccSPavel Labath 194fc89bbccSPavel Labath if (!is_vendor_specified) 195fc89bbccSPavel Labath module_triple.setVendorName(host_triple.getVendorName()); 196fc89bbccSPavel Labath if (!is_os_specified) 197fc89bbccSPavel Labath module_triple.setOSName(host_triple.getOSName()); 198fc89bbccSPavel Labath 199fc89bbccSPavel Labath error = ModuleList::GetSharedModule(resolved_module_spec, 200fc89bbccSPavel Labath exe_module_sp, module_search_paths_ptr, nullptr, nullptr); 201fc89bbccSPavel Labath } 202fc89bbccSPavel Labath } 203fc89bbccSPavel Labath 204fc89bbccSPavel Labath // TODO find out why exe_module_sp might be NULL 205fc89bbccSPavel Labath if (error.Fail() || !exe_module_sp || !exe_module_sp->GetObjectFile()) { 206fc89bbccSPavel Labath exe_module_sp.reset(); 207fc89bbccSPavel Labath error.SetErrorStringWithFormat( 208fc89bbccSPavel Labath "'%s' doesn't contain the architecture %s", 209fc89bbccSPavel Labath resolved_module_spec.GetFileSpec().GetPath().c_str(), 210fc89bbccSPavel Labath resolved_module_spec.GetArchitecture().GetArchitectureName()); 211fc89bbccSPavel Labath } 212fc89bbccSPavel Labath } else { 21305097246SAdrian Prantl // No valid architecture was specified, ask the platform for the 21405097246SAdrian Prantl // architectures that we should be using (in the correct order) and see 21505097246SAdrian Prantl // if we can find a match that way 216fc89bbccSPavel Labath StreamString arch_names; 217fc89bbccSPavel Labath for (uint32_t idx = 0; GetSupportedArchitectureAtIndex( 218fc89bbccSPavel Labath idx, resolved_module_spec.GetArchitecture()); 219fc89bbccSPavel Labath ++idx) { 220fc89bbccSPavel Labath error = ModuleList::GetSharedModule(resolved_module_spec, exe_module_sp, 221fc89bbccSPavel Labath module_search_paths_ptr, nullptr, nullptr); 222fc89bbccSPavel Labath // Did we find an executable using one of the 223fc89bbccSPavel Labath if (error.Success()) { 224fc89bbccSPavel Labath if (exe_module_sp && exe_module_sp->GetObjectFile()) 225fc89bbccSPavel Labath break; 226fc89bbccSPavel Labath else 227fc89bbccSPavel Labath error.SetErrorToGenericError(); 228fc89bbccSPavel Labath } 229fc89bbccSPavel Labath 230fc89bbccSPavel Labath if (idx > 0) 231fc89bbccSPavel Labath arch_names.PutCString(", "); 232fc89bbccSPavel Labath arch_names.PutCString( 233fc89bbccSPavel Labath resolved_module_spec.GetArchitecture().GetArchitectureName()); 234fc89bbccSPavel Labath } 235fc89bbccSPavel Labath 236fc89bbccSPavel Labath if (error.Fail() || !exe_module_sp) { 2377c5310bbSJonas Devlieghere if (FileSystem::Instance().Readable( 2387c5310bbSJonas Devlieghere resolved_module_spec.GetFileSpec())) { 239fc89bbccSPavel Labath error.SetErrorStringWithFormat( 240fc89bbccSPavel Labath "'%s' doesn't contain any '%s' platform architectures: %s", 241fc89bbccSPavel Labath resolved_module_spec.GetFileSpec().GetPath().c_str(), 242fc89bbccSPavel Labath GetPluginName().GetCString(), arch_names.GetData()); 243fc89bbccSPavel Labath } else { 244fc89bbccSPavel Labath error.SetErrorStringWithFormat( 245fc89bbccSPavel Labath "'%s' is not readable", 246fc89bbccSPavel Labath resolved_module_spec.GetFileSpec().GetPath().c_str()); 247fc89bbccSPavel Labath } 248fc89bbccSPavel Labath } 249fc89bbccSPavel Labath } 250fc89bbccSPavel Labath } 251fc89bbccSPavel Labath 252fc89bbccSPavel Labath return error; 253fc89bbccSPavel Labath } 254fc89bbccSPavel Labath 25597206d57SZachary Turner Status PlatformPOSIX::GetFileWithUUID(const FileSpec &platform_file, 256ec9bc8ccSPavel Labath const UUID *uuid_ptr, 257ec9bc8ccSPavel Labath FileSpec &local_file) { 258ec9bc8ccSPavel Labath if (IsRemote() && m_remote_platform_sp) 259ec9bc8ccSPavel Labath return m_remote_platform_sp->GetFileWithUUID(platform_file, uuid_ptr, 260ec9bc8ccSPavel Labath local_file); 261ec9bc8ccSPavel Labath 262ec9bc8ccSPavel Labath // Default to the local case 263ec9bc8ccSPavel Labath local_file = platform_file; 26497206d57SZachary Turner return Status(); 265ec9bc8ccSPavel Labath } 266ec9bc8ccSPavel Labath 267ec9bc8ccSPavel Labath bool PlatformPOSIX::GetProcessInfo(lldb::pid_t pid, 268ec9bc8ccSPavel Labath ProcessInstanceInfo &process_info) { 269ec9bc8ccSPavel Labath if (IsHost()) 270ec9bc8ccSPavel Labath return Platform::GetProcessInfo(pid, process_info); 271ec9bc8ccSPavel Labath if (m_remote_platform_sp) 272ec9bc8ccSPavel Labath return m_remote_platform_sp->GetProcessInfo(pid, process_info); 273ec9bc8ccSPavel Labath return false; 274ec9bc8ccSPavel Labath } 275ec9bc8ccSPavel Labath 276ec9bc8ccSPavel Labath uint32_t 277ec9bc8ccSPavel Labath PlatformPOSIX::FindProcesses(const ProcessInstanceInfoMatch &match_info, 278ec9bc8ccSPavel Labath ProcessInstanceInfoList &process_infos) { 279ec9bc8ccSPavel Labath if (IsHost()) 280ec9bc8ccSPavel Labath return Platform::FindProcesses(match_info, process_infos); 281ec9bc8ccSPavel Labath if (m_remote_platform_sp) 282ec9bc8ccSPavel Labath return 283ec9bc8ccSPavel Labath m_remote_platform_sp->FindProcesses(match_info, process_infos); 284ec9bc8ccSPavel Labath return 0; 285ec9bc8ccSPavel Labath } 286ec9bc8ccSPavel Labath 28797206d57SZachary Turner Status PlatformPOSIX::MakeDirectory(const FileSpec &file_spec, 288b9c1b51eSKate Stone uint32_t file_permissions) { 289fbb76349SGreg Clayton if (m_remote_platform_sp) 290d3173f34SChaoren Lin return m_remote_platform_sp->MakeDirectory(file_spec, file_permissions); 291fbb76349SGreg Clayton else 292d3173f34SChaoren Lin return Platform::MakeDirectory(file_spec, file_permissions); 293e0f8f574SDaniel Malea } 294fbb76349SGreg Clayton 29597206d57SZachary Turner Status PlatformPOSIX::GetFilePermissions(const FileSpec &file_spec, 296b9c1b51eSKate Stone uint32_t &file_permissions) { 297fbb76349SGreg Clayton if (m_remote_platform_sp) 298b9c1b51eSKate Stone return m_remote_platform_sp->GetFilePermissions(file_spec, 299b9c1b51eSKate Stone file_permissions); 300fbb76349SGreg Clayton else 301d3173f34SChaoren Lin return Platform::GetFilePermissions(file_spec, file_permissions); 302fbb76349SGreg Clayton } 303fbb76349SGreg Clayton 30497206d57SZachary Turner Status PlatformPOSIX::SetFilePermissions(const FileSpec &file_spec, 305b9c1b51eSKate Stone uint32_t file_permissions) { 306fbb76349SGreg Clayton if (m_remote_platform_sp) 307b9c1b51eSKate Stone return m_remote_platform_sp->SetFilePermissions(file_spec, 308b9c1b51eSKate Stone file_permissions); 309fbb76349SGreg Clayton else 310d3173f34SChaoren Lin return Platform::SetFilePermissions(file_spec, file_permissions); 311e0f8f574SDaniel Malea } 312e0f8f574SDaniel Malea 313b9c1b51eSKate Stone lldb::user_id_t PlatformPOSIX::OpenFile(const FileSpec &file_spec, 314b9c1b51eSKate Stone uint32_t flags, uint32_t mode, 31597206d57SZachary Turner Status &error) { 316e0f8f574SDaniel Malea if (IsHost()) 317c00cf4a0SZachary Turner return FileCache::GetInstance().OpenFile(file_spec, flags, mode, error); 318fbb76349SGreg Clayton else if (m_remote_platform_sp) 319e0f8f574SDaniel Malea return m_remote_platform_sp->OpenFile(file_spec, flags, mode, error); 320fbb76349SGreg Clayton else 321e0f8f574SDaniel Malea return Platform::OpenFile(file_spec, flags, mode, error); 322e0f8f574SDaniel Malea } 323e0f8f574SDaniel Malea 32497206d57SZachary Turner bool PlatformPOSIX::CloseFile(lldb::user_id_t fd, Status &error) { 325e0f8f574SDaniel Malea if (IsHost()) 326c00cf4a0SZachary Turner return FileCache::GetInstance().CloseFile(fd, error); 327fbb76349SGreg Clayton else if (m_remote_platform_sp) 328e0f8f574SDaniel Malea return m_remote_platform_sp->CloseFile(fd, error); 329fbb76349SGreg Clayton else 330e0f8f574SDaniel Malea return Platform::CloseFile(fd, error); 331e0f8f574SDaniel Malea } 332e0f8f574SDaniel Malea 333b9c1b51eSKate Stone uint64_t PlatformPOSIX::ReadFile(lldb::user_id_t fd, uint64_t offset, void *dst, 33497206d57SZachary Turner uint64_t dst_len, Status &error) { 335e0f8f574SDaniel Malea if (IsHost()) 336c00cf4a0SZachary Turner return FileCache::GetInstance().ReadFile(fd, offset, dst, dst_len, error); 337fbb76349SGreg Clayton else if (m_remote_platform_sp) 338e0f8f574SDaniel Malea return m_remote_platform_sp->ReadFile(fd, offset, dst, dst_len, error); 339fbb76349SGreg Clayton else 340e0f8f574SDaniel Malea return Platform::ReadFile(fd, offset, dst, dst_len, error); 341e0f8f574SDaniel Malea } 342e0f8f574SDaniel Malea 343b9c1b51eSKate Stone uint64_t PlatformPOSIX::WriteFile(lldb::user_id_t fd, uint64_t offset, 344b9c1b51eSKate Stone const void *src, uint64_t src_len, 34597206d57SZachary Turner Status &error) { 346e0f8f574SDaniel Malea if (IsHost()) 347c00cf4a0SZachary Turner return FileCache::GetInstance().WriteFile(fd, offset, src, src_len, error); 348fbb76349SGreg Clayton else if (m_remote_platform_sp) 349e0f8f574SDaniel Malea return m_remote_platform_sp->WriteFile(fd, offset, src, src_len, error); 350fbb76349SGreg Clayton else 351e0f8f574SDaniel Malea return Platform::WriteFile(fd, offset, src, src_len, error); 352e0f8f574SDaniel Malea } 353e0f8f574SDaniel Malea 354b9c1b51eSKate Stone static uint32_t chown_file(Platform *platform, const char *path, 355e0f8f574SDaniel Malea uint32_t uid = UINT32_MAX, 356b9c1b51eSKate Stone uint32_t gid = UINT32_MAX) { 357e0f8f574SDaniel Malea if (!platform || !path || *path == 0) 358e0f8f574SDaniel Malea return UINT32_MAX; 359e0f8f574SDaniel Malea 360e0f8f574SDaniel Malea if (uid == UINT32_MAX && gid == UINT32_MAX) 361e0f8f574SDaniel Malea return 0; // pretend I did chown correctly - actually I just didn't care 362e0f8f574SDaniel Malea 363e0f8f574SDaniel Malea StreamString command; 364e0f8f574SDaniel Malea command.PutCString("chown "); 365e0f8f574SDaniel Malea if (uid != UINT32_MAX) 366e0f8f574SDaniel Malea command.Printf("%d", uid); 367e0f8f574SDaniel Malea if (gid != UINT32_MAX) 368e0f8f574SDaniel Malea command.Printf(":%d", gid); 369e0f8f574SDaniel Malea command.Printf("%s", path); 370e0f8f574SDaniel Malea int status; 37119dd1a0eSPavel Labath platform->RunShellCommand(command.GetData(), NULL, &status, NULL, NULL, 37219dd1a0eSPavel Labath std::chrono::seconds(10)); 373e0f8f574SDaniel Malea return status; 374e0f8f574SDaniel Malea } 375e0f8f574SDaniel Malea 37697206d57SZachary Turner lldb_private::Status 377e0f8f574SDaniel Malea PlatformPOSIX::PutFile(const lldb_private::FileSpec &source, 378b9c1b51eSKate Stone const lldb_private::FileSpec &destination, uint32_t uid, 379b9c1b51eSKate Stone uint32_t gid) { 380fbb76349SGreg Clayton Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM)); 381fbb76349SGreg Clayton 382b9c1b51eSKate Stone if (IsHost()) { 383e0f8f574SDaniel Malea if (FileSpec::Equal(source, destination, true)) 38497206d57SZachary Turner return Status(); 385e0f8f574SDaniel Malea // cp src dst 386e0f8f574SDaniel Malea // chown uid:gid dst 387e0f8f574SDaniel Malea std::string src_path(source.GetPath()); 388e0f8f574SDaniel Malea if (src_path.empty()) 38997206d57SZachary Turner return Status("unable to get file path for source"); 390e0f8f574SDaniel Malea std::string dst_path(destination.GetPath()); 391e0f8f574SDaniel Malea if (dst_path.empty()) 39297206d57SZachary Turner return Status("unable to get file path for destination"); 393e0f8f574SDaniel Malea StreamString command; 394e0f8f574SDaniel Malea command.Printf("cp %s %s", src_path.c_str(), dst_path.c_str()); 395e0f8f574SDaniel Malea int status; 39619dd1a0eSPavel Labath RunShellCommand(command.GetData(), NULL, &status, NULL, NULL, 39719dd1a0eSPavel Labath std::chrono::seconds(10)); 398e0f8f574SDaniel Malea if (status != 0) 39997206d57SZachary Turner return Status("unable to perform copy"); 400e0f8f574SDaniel Malea if (uid == UINT32_MAX && gid == UINT32_MAX) 40197206d57SZachary Turner return Status(); 402e0f8f574SDaniel Malea if (chown_file(this, dst_path.c_str(), uid, gid) != 0) 40397206d57SZachary Turner return Status("unable to perform chown"); 40497206d57SZachary Turner return Status(); 405b9c1b51eSKate Stone } else if (m_remote_platform_sp) { 406b9c1b51eSKate Stone if (GetSupportsRSync()) { 407e0f8f574SDaniel Malea std::string src_path(source.GetPath()); 408e0f8f574SDaniel Malea if (src_path.empty()) 40997206d57SZachary Turner return Status("unable to get file path for source"); 410e0f8f574SDaniel Malea std::string dst_path(destination.GetPath()); 411e0f8f574SDaniel Malea if (dst_path.empty()) 41297206d57SZachary Turner return Status("unable to get file path for destination"); 413e0f8f574SDaniel Malea StreamString command; 414b9c1b51eSKate Stone if (GetIgnoresRemoteHostname()) { 415e0f8f574SDaniel Malea if (!GetRSyncPrefix()) 416b9c1b51eSKate Stone command.Printf("rsync %s %s %s", GetRSyncOpts(), src_path.c_str(), 417e0f8f574SDaniel Malea dst_path.c_str()); 418e0f8f574SDaniel Malea else 419b9c1b51eSKate Stone command.Printf("rsync %s %s %s%s", GetRSyncOpts(), src_path.c_str(), 420b9c1b51eSKate Stone GetRSyncPrefix(), dst_path.c_str()); 421b9c1b51eSKate Stone } else 422b9c1b51eSKate Stone command.Printf("rsync %s %s %s:%s", GetRSyncOpts(), src_path.c_str(), 423b9c1b51eSKate Stone GetHostname(), dst_path.c_str()); 424e0f8f574SDaniel Malea if (log) 425e0f8f574SDaniel Malea log->Printf("[PutFile] Running command: %s\n", command.GetData()); 426e0f8f574SDaniel Malea int retcode; 42719dd1a0eSPavel Labath Host::RunShellCommand(command.GetData(), NULL, &retcode, NULL, NULL, 42819dd1a0eSPavel Labath std::chrono::minutes(1)); 429b9c1b51eSKate Stone if (retcode == 0) { 430e0f8f574SDaniel Malea // Don't chown a local file for a remote system 431e0f8f574SDaniel Malea // if (chown_file(this,dst_path.c_str(),uid,gid) != 0) 43297206d57SZachary Turner // return Status("unable to perform chown"); 43397206d57SZachary Turner return Status(); 434e0f8f574SDaniel Malea } 435b9c1b51eSKate Stone // if we are still here rsync has failed - let's try the slow way before 436b9c1b51eSKate Stone // giving up 437e0f8f574SDaniel Malea } 438e0f8f574SDaniel Malea } 439e0f8f574SDaniel Malea return Platform::PutFile(source, destination, uid, gid); 440e0f8f574SDaniel Malea } 441e0f8f574SDaniel Malea 442b9c1b51eSKate Stone lldb::user_id_t PlatformPOSIX::GetFileSize(const FileSpec &file_spec) { 44307db3f7eSZachary Turner if (IsHost()) { 44407db3f7eSZachary Turner uint64_t Size; 44507db3f7eSZachary Turner if (llvm::sys::fs::file_size(file_spec.GetPath(), Size)) 44607db3f7eSZachary Turner return 0; 44707db3f7eSZachary Turner return Size; 44807db3f7eSZachary Turner } else if (m_remote_platform_sp) 449e0f8f574SDaniel Malea return m_remote_platform_sp->GetFileSize(file_spec); 450fbb76349SGreg Clayton else 451e0f8f574SDaniel Malea return Platform::GetFileSize(file_spec); 452e0f8f574SDaniel Malea } 453e0f8f574SDaniel Malea 45497206d57SZachary Turner Status PlatformPOSIX::CreateSymlink(const FileSpec &src, const FileSpec &dst) { 455fbb76349SGreg Clayton if (IsHost()) 45646376966SJonas Devlieghere return FileSystem::Instance().Symlink(src, dst); 457fbb76349SGreg Clayton else if (m_remote_platform_sp) 458fbb76349SGreg Clayton return m_remote_platform_sp->CreateSymlink(src, dst); 459fbb76349SGreg Clayton else 460fbb76349SGreg Clayton return Platform::CreateSymlink(src, dst); 461fbb76349SGreg Clayton } 462fbb76349SGreg Clayton 463b9c1b51eSKate Stone bool PlatformPOSIX::GetFileExists(const FileSpec &file_spec) { 464e0f8f574SDaniel Malea if (IsHost()) 465dbd7fabaSJonas Devlieghere return FileSystem::Instance().Exists(file_spec); 466fbb76349SGreg Clayton else if (m_remote_platform_sp) 467e0f8f574SDaniel Malea return m_remote_platform_sp->GetFileExists(file_spec); 468fbb76349SGreg Clayton else 469e0f8f574SDaniel Malea return Platform::GetFileExists(file_spec); 470e0f8f574SDaniel Malea } 471e0f8f574SDaniel Malea 47297206d57SZachary Turner Status PlatformPOSIX::Unlink(const FileSpec &file_spec) { 473e0f8f574SDaniel Malea if (IsHost()) 47407db3f7eSZachary Turner return llvm::sys::fs::remove(file_spec.GetPath()); 475fbb76349SGreg Clayton else if (m_remote_platform_sp) 476d3173f34SChaoren Lin return m_remote_platform_sp->Unlink(file_spec); 477fbb76349SGreg Clayton else 478d3173f34SChaoren Lin return Platform::Unlink(file_spec); 479e0f8f574SDaniel Malea } 480e0f8f574SDaniel Malea 48197206d57SZachary Turner lldb_private::Status PlatformPOSIX::GetFile( 482b9c1b51eSKate Stone const lldb_private::FileSpec &source, // remote file path 483d3173f34SChaoren Lin const lldb_private::FileSpec &destination) // local file path 484e0f8f574SDaniel Malea { 485fbb76349SGreg Clayton Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM)); 486fbb76349SGreg Clayton 487e0f8f574SDaniel Malea // Check the args, first. 488e0f8f574SDaniel Malea std::string src_path(source.GetPath()); 489e0f8f574SDaniel Malea if (src_path.empty()) 49097206d57SZachary Turner return Status("unable to get file path for source"); 491e0f8f574SDaniel Malea std::string dst_path(destination.GetPath()); 492e0f8f574SDaniel Malea if (dst_path.empty()) 49397206d57SZachary Turner return Status("unable to get file path for destination"); 494b9c1b51eSKate Stone if (IsHost()) { 495e0f8f574SDaniel Malea if (FileSpec::Equal(source, destination, true)) 49697206d57SZachary Turner return Status("local scenario->source and destination are the same file " 497b9c1b51eSKate Stone "path: no operation performed"); 498e0f8f574SDaniel Malea // cp src dst 499e0f8f574SDaniel Malea StreamString cp_command; 500e0f8f574SDaniel Malea cp_command.Printf("cp %s %s", src_path.c_str(), dst_path.c_str()); 501e0f8f574SDaniel Malea int status; 50219dd1a0eSPavel Labath RunShellCommand(cp_command.GetData(), NULL, &status, NULL, NULL, 50319dd1a0eSPavel Labath std::chrono::seconds(10)); 504e0f8f574SDaniel Malea if (status != 0) 50597206d57SZachary Turner return Status("unable to perform copy"); 50697206d57SZachary Turner return Status(); 507b9c1b51eSKate Stone } else if (m_remote_platform_sp) { 508b9c1b51eSKate Stone if (GetSupportsRSync()) { 509e0f8f574SDaniel Malea StreamString command; 510b9c1b51eSKate Stone if (GetIgnoresRemoteHostname()) { 511e0f8f574SDaniel Malea if (!GetRSyncPrefix()) 512b9c1b51eSKate Stone command.Printf("rsync %s %s %s", GetRSyncOpts(), src_path.c_str(), 513e0f8f574SDaniel Malea dst_path.c_str()); 514e0f8f574SDaniel Malea else 515b9c1b51eSKate Stone command.Printf("rsync %s %s%s %s", GetRSyncOpts(), GetRSyncPrefix(), 516b9c1b51eSKate Stone src_path.c_str(), dst_path.c_str()); 517b9c1b51eSKate Stone } else 518b9c1b51eSKate Stone command.Printf("rsync %s %s:%s %s", GetRSyncOpts(), 519b9c1b51eSKate Stone m_remote_platform_sp->GetHostname(), src_path.c_str(), 520e0f8f574SDaniel Malea dst_path.c_str()); 521e0f8f574SDaniel Malea if (log) 522e0f8f574SDaniel Malea log->Printf("[GetFile] Running command: %s\n", command.GetData()); 523e0f8f574SDaniel Malea int retcode; 52419dd1a0eSPavel Labath Host::RunShellCommand(command.GetData(), NULL, &retcode, NULL, NULL, 52519dd1a0eSPavel Labath std::chrono::minutes(1)); 526e0f8f574SDaniel Malea if (retcode == 0) 52797206d57SZachary Turner return Status(); 52805097246SAdrian Prantl // If we are here, rsync has failed - let's try the slow way before 52905097246SAdrian Prantl // giving up 530e0f8f574SDaniel Malea } 531e0f8f574SDaniel Malea // open src and dst 532e0f8f574SDaniel Malea // read/write, read/write, read/write, ... 533e0f8f574SDaniel Malea // close src 534e0f8f574SDaniel Malea // close dst 535e0f8f574SDaniel Malea if (log) 536e0f8f574SDaniel Malea log->Printf("[GetFile] Using block by block transfer....\n"); 53797206d57SZachary Turner Status error; 538b9c1b51eSKate Stone user_id_t fd_src = OpenFile(source, File::eOpenOptionRead, 539b9c1b51eSKate Stone lldb::eFilePermissionsFileDefault, error); 540e0f8f574SDaniel Malea 541e0f8f574SDaniel Malea if (fd_src == UINT64_MAX) 54297206d57SZachary Turner return Status("unable to open source file"); 543e0f8f574SDaniel Malea 544fbb76349SGreg Clayton uint32_t permissions = 0; 545d3173f34SChaoren Lin error = GetFilePermissions(source, permissions); 546e0f8f574SDaniel Malea 547e0f8f574SDaniel Malea if (permissions == 0) 548fbb76349SGreg Clayton permissions = lldb::eFilePermissionsFileDefault; 549e0f8f574SDaniel Malea 550c00cf4a0SZachary Turner user_id_t fd_dst = FileCache::GetInstance().OpenFile( 551b9c1b51eSKate Stone destination, File::eOpenOptionCanCreate | File::eOpenOptionWrite | 552b9c1b51eSKate Stone File::eOpenOptionTruncate, 553b9c1b51eSKate Stone permissions, error); 554e0f8f574SDaniel Malea 555b9c1b51eSKate Stone if (fd_dst == UINT64_MAX) { 556e0f8f574SDaniel Malea if (error.Success()) 557e0f8f574SDaniel Malea error.SetErrorString("unable to open destination file"); 558e0f8f574SDaniel Malea } 559e0f8f574SDaniel Malea 560b9c1b51eSKate Stone if (error.Success()) { 561e0f8f574SDaniel Malea lldb::DataBufferSP buffer_sp(new DataBufferHeap(1024, 0)); 562e0f8f574SDaniel Malea uint64_t offset = 0; 563e0f8f574SDaniel Malea error.Clear(); 564b9c1b51eSKate Stone while (error.Success()) { 565b9c1b51eSKate Stone const uint64_t n_read = ReadFile(fd_src, offset, buffer_sp->GetBytes(), 566b9c1b51eSKate Stone buffer_sp->GetByteSize(), error); 567e0f8f574SDaniel Malea if (error.Fail()) 568e0f8f574SDaniel Malea break; 569e0f8f574SDaniel Malea if (n_read == 0) 570e0f8f574SDaniel Malea break; 571b9c1b51eSKate Stone if (FileCache::GetInstance().WriteFile(fd_dst, offset, 572b9c1b51eSKate Stone buffer_sp->GetBytes(), n_read, 573b9c1b51eSKate Stone error) != n_read) { 574e0f8f574SDaniel Malea if (!error.Fail()) 575e0f8f574SDaniel Malea error.SetErrorString("unable to write to destination file"); 576e0f8f574SDaniel Malea break; 577e0f8f574SDaniel Malea } 578e0f8f574SDaniel Malea offset += n_read; 579e0f8f574SDaniel Malea } 580e0f8f574SDaniel Malea } 581e0f8f574SDaniel Malea // Ignore the close error of src. 582e0f8f574SDaniel Malea if (fd_src != UINT64_MAX) 583e0f8f574SDaniel Malea CloseFile(fd_src, error); 584e0f8f574SDaniel Malea // And close the dst file descriptot. 585b9c1b51eSKate Stone if (fd_dst != UINT64_MAX && 586b9c1b51eSKate Stone !FileCache::GetInstance().CloseFile(fd_dst, error)) { 587e0f8f574SDaniel Malea if (!error.Fail()) 588e0f8f574SDaniel Malea error.SetErrorString("unable to close destination file"); 589e0f8f574SDaniel Malea } 590e0f8f574SDaniel Malea return error; 591e0f8f574SDaniel Malea } 592e0f8f574SDaniel Malea return Platform::GetFile(source, destination); 593e0f8f574SDaniel Malea } 594e0f8f574SDaniel Malea 595b9c1b51eSKate Stone std::string PlatformPOSIX::GetPlatformSpecificConnectionInformation() { 596e0f8f574SDaniel Malea StreamString stream; 597b9c1b51eSKate Stone if (GetSupportsRSync()) { 598e0f8f574SDaniel Malea stream.PutCString("rsync"); 599e0f8f574SDaniel Malea if ((GetRSyncOpts() && *GetRSyncOpts()) || 600b9c1b51eSKate Stone (GetRSyncPrefix() && *GetRSyncPrefix()) || GetIgnoresRemoteHostname()) { 601e0f8f574SDaniel Malea stream.Printf(", options: "); 602e0f8f574SDaniel Malea if (GetRSyncOpts() && *GetRSyncOpts()) 603e0f8f574SDaniel Malea stream.Printf("'%s' ", GetRSyncOpts()); 604e0f8f574SDaniel Malea stream.Printf(", prefix: "); 605e0f8f574SDaniel Malea if (GetRSyncPrefix() && *GetRSyncPrefix()) 606e0f8f574SDaniel Malea stream.Printf("'%s' ", GetRSyncPrefix()); 607e0f8f574SDaniel Malea if (GetIgnoresRemoteHostname()) 608e0f8f574SDaniel Malea stream.Printf("ignore remote-hostname "); 609e0f8f574SDaniel Malea } 610e0f8f574SDaniel Malea } 611b9c1b51eSKate Stone if (GetSupportsSSH()) { 612e0f8f574SDaniel Malea stream.PutCString("ssh"); 613e0f8f574SDaniel Malea if (GetSSHOpts() && *GetSSHOpts()) 614e0f8f574SDaniel Malea stream.Printf(", options: '%s' ", GetSSHOpts()); 615e0f8f574SDaniel Malea } 616e0f8f574SDaniel Malea if (GetLocalCacheDirectory() && *GetLocalCacheDirectory()) 617e0f8f574SDaniel Malea stream.Printf("cache dir: %s", GetLocalCacheDirectory()); 618e0f8f574SDaniel Malea if (stream.GetSize()) 619c156427dSZachary Turner return stream.GetString(); 620e0f8f574SDaniel Malea else 621e0f8f574SDaniel Malea return ""; 622e0f8f574SDaniel Malea } 623e0f8f574SDaniel Malea 624b9c1b51eSKate Stone bool PlatformPOSIX::CalculateMD5(const FileSpec &file_spec, uint64_t &low, 625b9c1b51eSKate Stone uint64_t &high) { 626e0f8f574SDaniel Malea if (IsHost()) 627e0f8f574SDaniel Malea return Platform::CalculateMD5(file_spec, low, high); 628e0f8f574SDaniel Malea if (m_remote_platform_sp) 629e0f8f574SDaniel Malea return m_remote_platform_sp->CalculateMD5(file_spec, low, high); 630e0f8f574SDaniel Malea return false; 631e0f8f574SDaniel Malea } 632fbb76349SGreg Clayton 633b9c1b51eSKate Stone const lldb::UnixSignalsSP &PlatformPOSIX::GetRemoteUnixSignals() { 63498d0a4b3SChaoren Lin if (IsRemote() && m_remote_platform_sp) 63598d0a4b3SChaoren Lin return m_remote_platform_sp->GetRemoteUnixSignals(); 63698d0a4b3SChaoren Lin return Platform::GetRemoteUnixSignals(); 63798d0a4b3SChaoren Lin } 63898d0a4b3SChaoren Lin 639b9c1b51eSKate Stone FileSpec PlatformPOSIX::GetRemoteWorkingDirectory() { 640fbb76349SGreg Clayton if (IsRemote() && m_remote_platform_sp) 641fbb76349SGreg Clayton return m_remote_platform_sp->GetRemoteWorkingDirectory(); 642fbb76349SGreg Clayton else 643fbb76349SGreg Clayton return Platform::GetRemoteWorkingDirectory(); 644fbb76349SGreg Clayton } 645fbb76349SGreg Clayton 646b9c1b51eSKate Stone bool PlatformPOSIX::SetRemoteWorkingDirectory(const FileSpec &working_dir) { 647fbb76349SGreg Clayton if (IsRemote() && m_remote_platform_sp) 648d3173f34SChaoren Lin return m_remote_platform_sp->SetRemoteWorkingDirectory(working_dir); 649fbb76349SGreg Clayton else 650d3173f34SChaoren Lin return Platform::SetRemoteWorkingDirectory(working_dir); 651fbb76349SGreg Clayton } 652fbb76349SGreg Clayton 653b9c1b51eSKate Stone bool PlatformPOSIX::GetRemoteOSVersion() { 6542272c481SPavel Labath if (m_remote_platform_sp) { 6552272c481SPavel Labath m_os_version = m_remote_platform_sp->GetOSVersion(); 6562272c481SPavel Labath return !m_os_version.empty(); 6572272c481SPavel Labath } 658015d818bSTodd Fiala return false; 659015d818bSTodd Fiala } 660015d818bSTodd Fiala 661b9c1b51eSKate Stone bool PlatformPOSIX::GetRemoteOSBuildString(std::string &s) { 662015d818bSTodd Fiala if (m_remote_platform_sp) 663015d818bSTodd Fiala return m_remote_platform_sp->GetRemoteOSBuildString(s); 664015d818bSTodd Fiala s.clear(); 665015d818bSTodd Fiala return false; 666015d818bSTodd Fiala } 667015d818bSTodd Fiala 66862930e57SPavel Labath Environment PlatformPOSIX::GetEnvironment() { 669b9c1b51eSKate Stone if (IsRemote()) { 670e15fcaa2STodd Fiala if (m_remote_platform_sp) 67162930e57SPavel Labath return m_remote_platform_sp->GetEnvironment(); 67262930e57SPavel Labath return Environment(); 673e15fcaa2STodd Fiala } 67462930e57SPavel Labath return Host::GetEnvironment(); 675e15fcaa2STodd Fiala } 676e15fcaa2STodd Fiala 677b9c1b51eSKate Stone bool PlatformPOSIX::GetRemoteOSKernelDescription(std::string &s) { 678015d818bSTodd Fiala if (m_remote_platform_sp) 679015d818bSTodd Fiala return m_remote_platform_sp->GetRemoteOSKernelDescription(s); 680015d818bSTodd Fiala s.clear(); 681015d818bSTodd Fiala return false; 682015d818bSTodd Fiala } 683015d818bSTodd Fiala 684015d818bSTodd Fiala // Remote Platform subclasses need to override this function 685b9c1b51eSKate Stone ArchSpec PlatformPOSIX::GetRemoteSystemArchitecture() { 686015d818bSTodd Fiala if (m_remote_platform_sp) 687015d818bSTodd Fiala return m_remote_platform_sp->GetRemoteSystemArchitecture(); 688015d818bSTodd Fiala return ArchSpec(); 689015d818bSTodd Fiala } 690015d818bSTodd Fiala 691b9c1b51eSKate Stone const char *PlatformPOSIX::GetHostname() { 692015d818bSTodd Fiala if (IsHost()) 693015d818bSTodd Fiala return Platform::GetHostname(); 694015d818bSTodd Fiala 695015d818bSTodd Fiala if (m_remote_platform_sp) 696015d818bSTodd Fiala return m_remote_platform_sp->GetHostname(); 697015d818bSTodd Fiala return NULL; 698015d818bSTodd Fiala } 699015d818bSTodd Fiala 700b9c1b51eSKate Stone const char *PlatformPOSIX::GetUserName(uint32_t uid) { 701015d818bSTodd Fiala // Check the cache in Platform in case we have already looked this uid up 702015d818bSTodd Fiala const char *user_name = Platform::GetUserName(uid); 703015d818bSTodd Fiala if (user_name) 704015d818bSTodd Fiala return user_name; 705015d818bSTodd Fiala 706015d818bSTodd Fiala if (IsRemote() && m_remote_platform_sp) 707015d818bSTodd Fiala return m_remote_platform_sp->GetUserName(uid); 708015d818bSTodd Fiala return NULL; 709015d818bSTodd Fiala } 710015d818bSTodd Fiala 711b9c1b51eSKate Stone const char *PlatformPOSIX::GetGroupName(uint32_t gid) { 712015d818bSTodd Fiala const char *group_name = Platform::GetGroupName(gid); 713015d818bSTodd Fiala if (group_name) 714015d818bSTodd Fiala return group_name; 715015d818bSTodd Fiala 716015d818bSTodd Fiala if (IsRemote() && m_remote_platform_sp) 717015d818bSTodd Fiala return m_remote_platform_sp->GetGroupName(gid); 718015d818bSTodd Fiala return NULL; 719015d818bSTodd Fiala } 720015d818bSTodd Fiala 72197206d57SZachary Turner Status PlatformPOSIX::ConnectRemote(Args &args) { 72297206d57SZachary Turner Status error; 723b9c1b51eSKate Stone if (IsHost()) { 724b9c1b51eSKate Stone error.SetErrorStringWithFormat( 725b9c1b51eSKate Stone "can't connect to the host platform '%s', always connected", 726b9c1b51eSKate Stone GetPluginName().GetCString()); 727b9c1b51eSKate Stone } else { 728015d818bSTodd Fiala if (!m_remote_platform_sp) 729b9c1b51eSKate Stone m_remote_platform_sp = 730b9c1b51eSKate Stone Platform::Create(ConstString("remote-gdb-server"), error); 731015d818bSTodd Fiala 732015d818bSTodd Fiala if (m_remote_platform_sp && error.Success()) 733015d818bSTodd Fiala error = m_remote_platform_sp->ConnectRemote(args); 734015d818bSTodd Fiala else 735015d818bSTodd Fiala error.SetErrorString("failed to create a 'remote-gdb-server' platform"); 736015d818bSTodd Fiala 737015d818bSTodd Fiala if (error.Fail()) 738015d818bSTodd Fiala m_remote_platform_sp.reset(); 739015d818bSTodd Fiala } 740015d818bSTodd Fiala 741b9c1b51eSKate Stone if (error.Success() && m_remote_platform_sp) { 742b9c1b51eSKate Stone if (m_option_group_platform_rsync.get() && 743b9c1b51eSKate Stone m_option_group_platform_ssh.get() && 744b9c1b51eSKate Stone m_option_group_platform_caching.get()) { 745b9c1b51eSKate Stone if (m_option_group_platform_rsync->m_rsync) { 746015d818bSTodd Fiala SetSupportsRSync(true); 7470a66e2f1SEnrico Granata SetRSyncOpts(m_option_group_platform_rsync->m_rsync_opts.c_str()); 7480a66e2f1SEnrico Granata SetRSyncPrefix(m_option_group_platform_rsync->m_rsync_prefix.c_str()); 749b9c1b51eSKate Stone SetIgnoresRemoteHostname( 750b9c1b51eSKate Stone m_option_group_platform_rsync->m_ignores_remote_hostname); 751015d818bSTodd Fiala } 752b9c1b51eSKate Stone if (m_option_group_platform_ssh->m_ssh) { 753015d818bSTodd Fiala SetSupportsSSH(true); 7540a66e2f1SEnrico Granata SetSSHOpts(m_option_group_platform_ssh->m_ssh_opts.c_str()); 755015d818bSTodd Fiala } 756b9c1b51eSKate Stone SetLocalCacheDirectory( 757b9c1b51eSKate Stone m_option_group_platform_caching->m_cache_dir.c_str()); 758015d818bSTodd Fiala } 759015d818bSTodd Fiala } 760015d818bSTodd Fiala 761015d818bSTodd Fiala return error; 762015d818bSTodd Fiala } 763015d818bSTodd Fiala 76497206d57SZachary Turner Status PlatformPOSIX::DisconnectRemote() { 76597206d57SZachary Turner Status error; 766015d818bSTodd Fiala 767b9c1b51eSKate Stone if (IsHost()) { 768b9c1b51eSKate Stone error.SetErrorStringWithFormat( 769b9c1b51eSKate Stone "can't disconnect from the host platform '%s', always connected", 770b9c1b51eSKate Stone GetPluginName().GetCString()); 771b9c1b51eSKate Stone } else { 772015d818bSTodd Fiala if (m_remote_platform_sp) 773015d818bSTodd Fiala error = m_remote_platform_sp->DisconnectRemote(); 774015d818bSTodd Fiala else 775015d818bSTodd Fiala error.SetErrorString("the platform is not currently connected"); 776015d818bSTodd Fiala } 777015d818bSTodd Fiala return error; 778015d818bSTodd Fiala } 779015d818bSTodd Fiala 78097206d57SZachary Turner Status PlatformPOSIX::LaunchProcess(ProcessLaunchInfo &launch_info) { 78197206d57SZachary Turner Status error; 782348fb385STodd Fiala 783b9c1b51eSKate Stone if (IsHost()) { 784348fb385STodd Fiala error = Platform::LaunchProcess(launch_info); 785b9c1b51eSKate Stone } else { 786348fb385STodd Fiala if (m_remote_platform_sp) 787348fb385STodd Fiala error = m_remote_platform_sp->LaunchProcess(launch_info); 788348fb385STodd Fiala else 789348fb385STodd Fiala error.SetErrorString("the platform is not currently connected"); 790348fb385STodd Fiala } 791348fb385STodd Fiala return error; 792348fb385STodd Fiala } 793348fb385STodd Fiala 79497206d57SZachary Turner lldb_private::Status PlatformPOSIX::KillProcess(const lldb::pid_t pid) { 79509daa881SOleksiy Vyalov if (IsHost()) 79609daa881SOleksiy Vyalov return Platform::KillProcess(pid); 79709daa881SOleksiy Vyalov 79809daa881SOleksiy Vyalov if (m_remote_platform_sp) 79909daa881SOleksiy Vyalov return m_remote_platform_sp->KillProcess(pid); 80009daa881SOleksiy Vyalov 80197206d57SZachary Turner return Status("the platform is not currently connected"); 80209daa881SOleksiy Vyalov } 80309daa881SOleksiy Vyalov 804b9c1b51eSKate Stone lldb::ProcessSP PlatformPOSIX::Attach(ProcessAttachInfo &attach_info, 805b9c1b51eSKate Stone Debugger &debugger, Target *target, 80697206d57SZachary Turner Status &error) { 807348fb385STodd Fiala lldb::ProcessSP process_sp; 808348fb385STodd Fiala Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM)); 809348fb385STodd Fiala 810b9c1b51eSKate Stone if (IsHost()) { 811b9c1b51eSKate Stone if (target == NULL) { 812348fb385STodd Fiala TargetSP new_target_sp; 813348fb385STodd Fiala 814f9a07e9fSJonas Devlieghere error = debugger.GetTargetList().CreateTarget( 815f9a07e9fSJonas Devlieghere debugger, "", "", eLoadDependentsNo, NULL, new_target_sp); 816348fb385STodd Fiala target = new_target_sp.get(); 817348fb385STodd Fiala if (log) 818348fb385STodd Fiala log->Printf("PlatformPOSIX::%s created new target", __FUNCTION__); 819b9c1b51eSKate Stone } else { 820348fb385STodd Fiala error.Clear(); 821348fb385STodd Fiala if (log) 822b9c1b51eSKate Stone log->Printf("PlatformPOSIX::%s target already existed, setting target", 823b9c1b51eSKate Stone __FUNCTION__); 824348fb385STodd Fiala } 825348fb385STodd Fiala 826b9c1b51eSKate Stone if (target && error.Success()) { 827348fb385STodd Fiala debugger.GetTargetList().SetSelectedTarget(target); 828b9c1b51eSKate Stone if (log) { 829348fb385STodd Fiala ModuleSP exe_module_sp = target->GetExecutableModule(); 830b9c1b51eSKate Stone log->Printf("PlatformPOSIX::%s set selected target to %p %s", 831b9c1b51eSKate Stone __FUNCTION__, (void *)target, 832b9c1b51eSKate Stone exe_module_sp 833b9c1b51eSKate Stone ? exe_module_sp->GetFileSpec().GetPath().c_str() 834b9c1b51eSKate Stone : "<null>"); 835348fb385STodd Fiala } 836348fb385STodd Fiala 837b9c1b51eSKate Stone process_sp = 838b9c1b51eSKate Stone target->CreateProcess(attach_info.GetListenerForProcess(debugger), 839b9c1b51eSKate Stone attach_info.GetProcessPluginName(), NULL); 840348fb385STodd Fiala 841b9c1b51eSKate Stone if (process_sp) { 842583bbb1dSJim Ingham ListenerSP listener_sp = attach_info.GetHijackListener(); 843b9c1b51eSKate Stone if (listener_sp == nullptr) { 844b9c1b51eSKate Stone listener_sp = 845b9c1b51eSKate Stone Listener::MakeListener("lldb.PlatformPOSIX.attach.hijack"); 846348fb385STodd Fiala attach_info.SetHijackListener(listener_sp); 847926af0cdSOleksiy Vyalov } 848583bbb1dSJim Ingham process_sp->HijackProcessEvents(listener_sp); 849348fb385STodd Fiala error = process_sp->Attach(attach_info); 850348fb385STodd Fiala } 851348fb385STodd Fiala } 852b9c1b51eSKate Stone } else { 853348fb385STodd Fiala if (m_remote_platform_sp) 854b9c1b51eSKate Stone process_sp = 855b9c1b51eSKate Stone m_remote_platform_sp->Attach(attach_info, debugger, target, error); 856348fb385STodd Fiala else 857348fb385STodd Fiala error.SetErrorString("the platform is not currently connected"); 858348fb385STodd Fiala } 859348fb385STodd Fiala return process_sp; 860348fb385STodd Fiala } 861348fb385STodd Fiala 862015d818bSTodd Fiala lldb::ProcessSP 863b9c1b51eSKate Stone PlatformPOSIX::DebugProcess(ProcessLaunchInfo &launch_info, Debugger &debugger, 864b9c1b51eSKate Stone Target *target, // Can be NULL, if NULL create a new 865b9c1b51eSKate Stone // target, else use existing one 86697206d57SZachary Turner Status &error) { 867015d818bSTodd Fiala ProcessSP process_sp; 868015d818bSTodd Fiala 869b9c1b51eSKate Stone if (IsHost()) { 870b9c1b51eSKate Stone // We are going to hand this process off to debugserver which will be in 871245dd2e0SPavel Labath // charge of setting the exit status. However, we still need to reap it 872245dd2e0SPavel Labath // from lldb. So, make sure we use a exit callback which does not set exit 873245dd2e0SPavel Labath // status. 874245dd2e0SPavel Labath const bool monitor_signals = false; 875245dd2e0SPavel Labath launch_info.SetMonitorProcessCallback( 876245dd2e0SPavel Labath &ProcessLaunchInfo::NoOpMonitorCallback, monitor_signals); 8778012cadbSGreg Clayton process_sp = Platform::DebugProcess(launch_info, debugger, target, error); 878b9c1b51eSKate Stone } else { 879015d818bSTodd Fiala if (m_remote_platform_sp) 880b9c1b51eSKate Stone process_sp = m_remote_platform_sp->DebugProcess(launch_info, debugger, 881b9c1b51eSKate Stone target, error); 882015d818bSTodd Fiala else 883015d818bSTodd Fiala error.SetErrorString("the platform is not currently connected"); 884015d818bSTodd Fiala } 885015d818bSTodd Fiala return process_sp; 886015d818bSTodd Fiala } 887015d818bSTodd Fiala 888b9c1b51eSKate Stone void PlatformPOSIX::CalculateTrapHandlerSymbolNames() { 8892094dbf4SJason Molenda m_trap_handlers.push_back(ConstString("_sigtramp")); 8902094dbf4SJason Molenda } 8913cb132a0STamas Berghammer 89297206d57SZachary Turner Status PlatformPOSIX::EvaluateLibdlExpression( 893b9c1b51eSKate Stone lldb_private::Process *process, const char *expr_cstr, 894d37c9469SPavel Labath llvm::StringRef expr_prefix, lldb::ValueObjectSP &result_valobj_sp) { 8953cb132a0STamas Berghammer DynamicLoader *loader = process->GetDynamicLoader(); 896b9c1b51eSKate Stone if (loader) { 89797206d57SZachary Turner Status error = loader->CanLoadImage(); 8983cb132a0STamas Berghammer if (error.Fail()) 8993cb132a0STamas Berghammer return error; 9003cb132a0STamas Berghammer } 9013cb132a0STamas Berghammer 9028d94ba0fSJim Ingham ThreadSP thread_sp(process->GetThreadList().GetExpressionExecutionThread()); 9033cb132a0STamas Berghammer if (!thread_sp) 90497206d57SZachary Turner return Status("Selected thread isn't valid"); 9053cb132a0STamas Berghammer 9063cb132a0STamas Berghammer StackFrameSP frame_sp(thread_sp->GetStackFrameAtIndex(0)); 9073cb132a0STamas Berghammer if (!frame_sp) 90897206d57SZachary Turner return Status("Frame 0 isn't valid"); 9093cb132a0STamas Berghammer 9103cb132a0STamas Berghammer ExecutionContext exe_ctx; 9113cb132a0STamas Berghammer frame_sp->CalculateExecutionContext(exe_ctx); 9123cb132a0STamas Berghammer EvaluateExpressionOptions expr_options; 9133cb132a0STamas Berghammer expr_options.SetUnwindOnError(true); 9143cb132a0STamas Berghammer expr_options.SetIgnoreBreakpoints(true); 9153cb132a0STamas Berghammer expr_options.SetExecutionPolicy(eExecutionPolicyAlways); 9163cb132a0STamas Berghammer expr_options.SetLanguage(eLanguageTypeC_plus_plus); 917b9c1b51eSKate Stone expr_options.SetTrapExceptions(false); // dlopen can't throw exceptions, so 918b9c1b51eSKate Stone // don't do the work to trap them. 91943d35418SPavel Labath expr_options.SetTimeout(std::chrono::seconds(2)); 9203cb132a0STamas Berghammer 92197206d57SZachary Turner Status expr_error; 92202980825SJim Ingham ExpressionResults result = 923b9c1b51eSKate Stone UserExpression::Evaluate(exe_ctx, expr_options, expr_cstr, expr_prefix, 924b9c1b51eSKate Stone result_valobj_sp, expr_error); 92502980825SJim Ingham if (result != eExpressionCompleted) 92602980825SJim Ingham return expr_error; 92702980825SJim Ingham 9283cb132a0STamas Berghammer if (result_valobj_sp->GetError().Fail()) 9293cb132a0STamas Berghammer return result_valobj_sp->GetError(); 93097206d57SZachary Turner return Status(); 9313cb132a0STamas Berghammer } 9323cb132a0STamas Berghammer 933d10d3795SFrederic Riss std::unique_ptr<UtilityFunction> 9341ecb34f4SJim Ingham PlatformPOSIX::MakeLoadImageUtilityFunction(ExecutionContext &exe_ctx, 935d10d3795SFrederic Riss Status &error) { 93605097246SAdrian Prantl // Remember to prepend this with the prefix from 93705097246SAdrian Prantl // GetLibdlFunctionDeclarations. The returned values are all in 93805097246SAdrian Prantl // __lldb_dlopen_result for consistency. The wrapper returns a void * but 93905097246SAdrian Prantl // doesn't use it because UtilityFunctions don't work with void returns at 94005097246SAdrian Prantl // present. 9411ecb34f4SJim Ingham static const char *dlopen_wrapper_code = R"( 9421ecb34f4SJim Ingham struct __lldb_dlopen_result { 9431ecb34f4SJim Ingham void *image_ptr; 9441ecb34f4SJim Ingham const char *error_str; 9451ecb34f4SJim Ingham }; 9461ecb34f4SJim Ingham 94703856dd9SJim Ingham extern void *memcpy(void *, const void *, size_t size); 9480d231f71SJim Ingham extern size_t strlen(const char *); 9490d231f71SJim Ingham 9500d231f71SJim Ingham 9510d231f71SJim Ingham void * __lldb_dlopen_wrapper (const char *name, 9520d231f71SJim Ingham const char *path_strings, 9530d231f71SJim Ingham char *buffer, 9541ecb34f4SJim Ingham __lldb_dlopen_result *result_ptr) 9551ecb34f4SJim Ingham { 9560d231f71SJim Ingham // This is the case where the name is the full path: 95703856dd9SJim Ingham if (!path_strings) { 9580d231f71SJim Ingham result_ptr->image_ptr = dlopen(name, 2); 95903856dd9SJim Ingham if (result_ptr->image_ptr) 9600d231f71SJim Ingham result_ptr->error_str = nullptr; 9610d231f71SJim Ingham return nullptr; 9620d231f71SJim Ingham } 9630d231f71SJim Ingham 9640d231f71SJim Ingham // This is the case where we have a list of paths: 9650d231f71SJim Ingham size_t name_len = strlen(name); 96603856dd9SJim Ingham while (path_strings && path_strings[0] != '\0') { 9670d231f71SJim Ingham size_t path_len = strlen(path_strings); 9680d231f71SJim Ingham memcpy((void *) buffer, (void *) path_strings, path_len); 9690d231f71SJim Ingham buffer[path_len] = '/'; 9700d231f71SJim Ingham char *target_ptr = buffer+path_len+1; 9710d231f71SJim Ingham memcpy((void *) target_ptr, (void *) name, name_len + 1); 9720d231f71SJim Ingham result_ptr->image_ptr = dlopen(buffer, 2); 97303856dd9SJim Ingham if (result_ptr->image_ptr) { 9740d231f71SJim Ingham result_ptr->error_str = nullptr; 9750d231f71SJim Ingham break; 9760d231f71SJim Ingham } 9771ecb34f4SJim Ingham result_ptr->error_str = dlerror(); 9780d231f71SJim Ingham path_strings = path_strings + path_len + 1; 9790d231f71SJim Ingham } 9801ecb34f4SJim Ingham return nullptr; 9811ecb34f4SJim Ingham } 9821ecb34f4SJim Ingham )"; 9831ecb34f4SJim Ingham 9841ecb34f4SJim Ingham static const char *dlopen_wrapper_name = "__lldb_dlopen_wrapper"; 9851ecb34f4SJim Ingham Process *process = exe_ctx.GetProcessSP().get(); 9861ecb34f4SJim Ingham // Insert the dlopen shim defines into our generic expression: 9871ecb34f4SJim Ingham std::string expr(GetLibdlFunctionDeclarations(process)); 9881ecb34f4SJim Ingham expr.append(dlopen_wrapper_code); 9891ecb34f4SJim Ingham Status utility_error; 9901ecb34f4SJim Ingham DiagnosticManager diagnostics; 9911ecb34f4SJim Ingham 9921ecb34f4SJim Ingham std::unique_ptr<UtilityFunction> dlopen_utility_func_up(process 9931ecb34f4SJim Ingham ->GetTarget().GetUtilityFunctionForLanguage(expr.c_str(), 9941ecb34f4SJim Ingham eLanguageTypeObjC, 9951ecb34f4SJim Ingham dlopen_wrapper_name, 9961ecb34f4SJim Ingham utility_error)); 9971ecb34f4SJim Ingham if (utility_error.Fail()) { 9981ecb34f4SJim Ingham error.SetErrorStringWithFormat("dlopen error: could not make utility" 9991ecb34f4SJim Ingham "function: %s", utility_error.AsCString()); 10001ecb34f4SJim Ingham return nullptr; 10011ecb34f4SJim Ingham } 10021ecb34f4SJim Ingham if (!dlopen_utility_func_up->Install(diagnostics, exe_ctx)) { 10031ecb34f4SJim Ingham error.SetErrorStringWithFormat("dlopen error: could not install utility" 10041ecb34f4SJim Ingham "function: %s", 10051ecb34f4SJim Ingham diagnostics.GetString().c_str()); 10061ecb34f4SJim Ingham return nullptr; 10071ecb34f4SJim Ingham } 10081ecb34f4SJim Ingham 10091ecb34f4SJim Ingham Value value; 10101ecb34f4SJim Ingham ValueList arguments; 10111ecb34f4SJim Ingham FunctionCaller *do_dlopen_function = nullptr; 10121ecb34f4SJim Ingham 10131ecb34f4SJim Ingham // Fetch the clang types we will need: 10141ecb34f4SJim Ingham ClangASTContext *ast = process->GetTarget().GetScratchClangASTContext(); 10151ecb34f4SJim Ingham 10161ecb34f4SJim Ingham CompilerType clang_void_pointer_type 10171ecb34f4SJim Ingham = ast->GetBasicType(eBasicTypeVoid).GetPointerType(); 10181ecb34f4SJim Ingham CompilerType clang_char_pointer_type 10191ecb34f4SJim Ingham = ast->GetBasicType(eBasicTypeChar).GetPointerType(); 10201ecb34f4SJim Ingham 10210d231f71SJim Ingham // We are passing four arguments, the basename, the list of places to look, 10220d231f71SJim Ingham // a buffer big enough for all the path + name combos, and 10230d231f71SJim Ingham // a pointer to the storage we've made for the result: 10241ecb34f4SJim Ingham value.SetValueType(Value::eValueTypeScalar); 10251ecb34f4SJim Ingham value.SetCompilerType(clang_void_pointer_type); 10261ecb34f4SJim Ingham arguments.PushValue(value); 10271ecb34f4SJim Ingham value.SetCompilerType(clang_char_pointer_type); 10281ecb34f4SJim Ingham arguments.PushValue(value); 10290d231f71SJim Ingham arguments.PushValue(value); 10300d231f71SJim Ingham arguments.PushValue(value); 10311ecb34f4SJim Ingham 10321ecb34f4SJim Ingham do_dlopen_function = dlopen_utility_func_up->MakeFunctionCaller( 10331ecb34f4SJim Ingham clang_void_pointer_type, arguments, exe_ctx.GetThreadSP(), utility_error); 10341ecb34f4SJim Ingham if (utility_error.Fail()) { 10351ecb34f4SJim Ingham error.SetErrorStringWithFormat("dlopen error: could not make function" 10361ecb34f4SJim Ingham "caller: %s", utility_error.AsCString()); 10371ecb34f4SJim Ingham return nullptr; 10381ecb34f4SJim Ingham } 10391ecb34f4SJim Ingham 10401ecb34f4SJim Ingham do_dlopen_function = dlopen_utility_func_up->GetFunctionCaller(); 10411ecb34f4SJim Ingham if (!do_dlopen_function) { 10421ecb34f4SJim Ingham error.SetErrorString("dlopen error: could not get function caller."); 10431ecb34f4SJim Ingham return nullptr; 10441ecb34f4SJim Ingham } 10451ecb34f4SJim Ingham 10461ecb34f4SJim Ingham // We made a good utility function, so cache it in the process: 1047d10d3795SFrederic Riss return dlopen_utility_func_up; 10481ecb34f4SJim Ingham } 10491ecb34f4SJim Ingham 1050b9c1b51eSKate Stone uint32_t PlatformPOSIX::DoLoadImage(lldb_private::Process *process, 10514fbd67acSTamas Berghammer const lldb_private::FileSpec &remote_file, 10520d231f71SJim Ingham const std::vector<std::string> *paths, 10530d231f71SJim Ingham lldb_private::Status &error, 10540d231f71SJim Ingham lldb_private::FileSpec *loaded_image) { 10550d231f71SJim Ingham if (loaded_image) 10560d231f71SJim Ingham loaded_image->Clear(); 10570d231f71SJim Ingham 10581ecb34f4SJim Ingham std::string path; 10591ecb34f4SJim Ingham path = remote_file.GetPath(); 10603cb132a0STamas Berghammer 10611ecb34f4SJim Ingham ThreadSP thread_sp = process->GetThreadList().GetExpressionExecutionThread(); 10621ecb34f4SJim Ingham if (!thread_sp) { 10631ecb34f4SJim Ingham error.SetErrorString("dlopen error: no thread available to call dlopen."); 10643cb132a0STamas Berghammer return LLDB_INVALID_IMAGE_TOKEN; 10653cb132a0STamas Berghammer } 10663cb132a0STamas Berghammer 10671ecb34f4SJim Ingham DiagnosticManager diagnostics; 10683cb132a0STamas Berghammer 10691ecb34f4SJim Ingham ExecutionContext exe_ctx; 10701ecb34f4SJim Ingham thread_sp->CalculateExecutionContext(exe_ctx); 10711ecb34f4SJim Ingham 10721ecb34f4SJim Ingham Status utility_error; 1073d10d3795SFrederic Riss UtilityFunction *dlopen_utility_func; 10741ecb34f4SJim Ingham ValueList arguments; 10751ecb34f4SJim Ingham FunctionCaller *do_dlopen_function = nullptr; 10761ecb34f4SJim Ingham 1077d10d3795SFrederic Riss // The UtilityFunction is held in the Process. Platforms don't track the 1078d10d3795SFrederic Riss // lifespan of the Targets that use them, we can't put this in the Platform. 1079d10d3795SFrederic Riss dlopen_utility_func = process->GetLoadImageUtilityFunction( 1080d10d3795SFrederic Riss this, [&]() -> std::unique_ptr<UtilityFunction> { 1081d10d3795SFrederic Riss return MakeLoadImageUtilityFunction(exe_ctx, error); 1082d10d3795SFrederic Riss }); 10831ecb34f4SJim Ingham // If we couldn't make it, the error will be in error, so we can exit here. 10841ecb34f4SJim Ingham if (!dlopen_utility_func) 10851ecb34f4SJim Ingham return LLDB_INVALID_IMAGE_TOKEN; 10861ecb34f4SJim Ingham 10871ecb34f4SJim Ingham do_dlopen_function = dlopen_utility_func->GetFunctionCaller(); 10881ecb34f4SJim Ingham if (!do_dlopen_function) { 10891ecb34f4SJim Ingham error.SetErrorString("dlopen error: could not get function caller."); 10901ecb34f4SJim Ingham return LLDB_INVALID_IMAGE_TOKEN; 10911ecb34f4SJim Ingham } 10921ecb34f4SJim Ingham arguments = do_dlopen_function->GetArgumentValues(); 10931ecb34f4SJim Ingham 109405097246SAdrian Prantl // Now insert the path we are searching for and the result structure into the 109505097246SAdrian Prantl // target. 10961ecb34f4SJim Ingham uint32_t permissions = ePermissionsReadable|ePermissionsWritable; 10971ecb34f4SJim Ingham size_t path_len = path.size() + 1; 10981ecb34f4SJim Ingham lldb::addr_t path_addr = process->AllocateMemory(path_len, 10991ecb34f4SJim Ingham permissions, 11001ecb34f4SJim Ingham utility_error); 11011ecb34f4SJim Ingham if (path_addr == LLDB_INVALID_ADDRESS) { 11021ecb34f4SJim Ingham error.SetErrorStringWithFormat("dlopen error: could not allocate memory" 11031ecb34f4SJim Ingham "for path: %s", utility_error.AsCString()); 11041ecb34f4SJim Ingham return LLDB_INVALID_IMAGE_TOKEN; 11051ecb34f4SJim Ingham } 11061ecb34f4SJim Ingham 11071ecb34f4SJim Ingham // Make sure we deallocate the input string memory: 11081ecb34f4SJim Ingham CleanUp path_cleanup([process, path_addr] { 11091ecb34f4SJim Ingham process->DeallocateMemory(path_addr); 11101ecb34f4SJim Ingham }); 11111ecb34f4SJim Ingham 11121ecb34f4SJim Ingham process->WriteMemory(path_addr, path.c_str(), path_len, utility_error); 11131ecb34f4SJim Ingham if (utility_error.Fail()) { 11141ecb34f4SJim Ingham error.SetErrorStringWithFormat("dlopen error: could not write path string:" 11151ecb34f4SJim Ingham " %s", utility_error.AsCString()); 11161ecb34f4SJim Ingham return LLDB_INVALID_IMAGE_TOKEN; 11171ecb34f4SJim Ingham } 11181ecb34f4SJim Ingham 111905097246SAdrian Prantl // Make space for our return structure. It is two pointers big: the token 112005097246SAdrian Prantl // and the error string. 11211ecb34f4SJim Ingham const uint32_t addr_size = process->GetAddressByteSize(); 11221ecb34f4SJim Ingham lldb::addr_t return_addr = process->CallocateMemory(2*addr_size, 11231ecb34f4SJim Ingham permissions, 11241ecb34f4SJim Ingham utility_error); 11251ecb34f4SJim Ingham if (utility_error.Fail()) { 11261ecb34f4SJim Ingham error.SetErrorStringWithFormat("dlopen error: could not allocate memory" 11271ecb34f4SJim Ingham "for path: %s", utility_error.AsCString()); 11281ecb34f4SJim Ingham return LLDB_INVALID_IMAGE_TOKEN; 11291ecb34f4SJim Ingham } 11301ecb34f4SJim Ingham 11311ecb34f4SJim Ingham // Make sure we deallocate the result structure memory 11321ecb34f4SJim Ingham CleanUp return_cleanup([process, return_addr] { 11331ecb34f4SJim Ingham process->DeallocateMemory(return_addr); 11341ecb34f4SJim Ingham }); 11351ecb34f4SJim Ingham 11360d231f71SJim Ingham // This will be the address of the storage for paths, if we are using them, 11370d231f71SJim Ingham // or nullptr to signal we aren't. 11380d231f71SJim Ingham lldb::addr_t path_array_addr = 0x0; 11390d231f71SJim Ingham llvm::Optional<CleanUp> path_array_cleanup; 11400d231f71SJim Ingham 11410d231f71SJim Ingham // This is the address to a buffer large enough to hold the largest path 11420d231f71SJim Ingham // conjoined with the library name we're passing in. This is a convenience 11430d231f71SJim Ingham // to avoid having to call malloc in the dlopen function. 11440d231f71SJim Ingham lldb::addr_t buffer_addr = 0x0; 11450d231f71SJim Ingham llvm::Optional<CleanUp> buffer_cleanup; 11460d231f71SJim Ingham 11471ecb34f4SJim Ingham // Set the values into our args and write them to the target: 11480d231f71SJim Ingham if (paths != nullptr) { 11490d231f71SJim Ingham // First insert the paths into the target. This is expected to be a 11500d231f71SJim Ingham // continuous buffer with the strings laid out null terminated and 11510d231f71SJim Ingham // end to end with an empty string terminating the buffer. 11520d231f71SJim Ingham // We also compute the buffer's required size as we go. 11530d231f71SJim Ingham size_t buffer_size = 0; 11540d231f71SJim Ingham std::string path_array; 11550d231f71SJim Ingham for (auto path : *paths) { 115640fa4a1aSJim Ingham // Don't insert empty paths, they will make us abort the path 115740fa4a1aSJim Ingham // search prematurely. 115840fa4a1aSJim Ingham if (path.empty()) 115940fa4a1aSJim Ingham continue; 11600d231f71SJim Ingham size_t path_size = path.size(); 11610d231f71SJim Ingham path_array.append(path); 11620d231f71SJim Ingham path_array.push_back('\0'); 11630d231f71SJim Ingham if (path_size > buffer_size) 11640d231f71SJim Ingham buffer_size = path_size; 11650d231f71SJim Ingham } 11660d231f71SJim Ingham path_array.push_back('\0'); 11670d231f71SJim Ingham 11680d231f71SJim Ingham path_array_addr = process->AllocateMemory(path_array.size(), 11690d231f71SJim Ingham permissions, 11700d231f71SJim Ingham utility_error); 11710d231f71SJim Ingham if (path_array_addr == LLDB_INVALID_ADDRESS) { 11720d231f71SJim Ingham error.SetErrorStringWithFormat("dlopen error: could not allocate memory" 11730d231f71SJim Ingham "for path array: %s", 11740d231f71SJim Ingham utility_error.AsCString()); 11750d231f71SJim Ingham return LLDB_INVALID_IMAGE_TOKEN; 11760d231f71SJim Ingham } 11770d231f71SJim Ingham 11780d231f71SJim Ingham // Make sure we deallocate the paths array. 11790d231f71SJim Ingham path_array_cleanup.emplace([process, path_array_addr] { 11800d231f71SJim Ingham process->DeallocateMemory(path_array_addr); 11810d231f71SJim Ingham }); 11820d231f71SJim Ingham 11830d231f71SJim Ingham process->WriteMemory(path_array_addr, path_array.data(), 11840d231f71SJim Ingham path_array.size(), utility_error); 11850d231f71SJim Ingham 11860d231f71SJim Ingham if (utility_error.Fail()) { 11870d231f71SJim Ingham error.SetErrorStringWithFormat("dlopen error: could not write path array:" 11880d231f71SJim Ingham " %s", utility_error.AsCString()); 11890d231f71SJim Ingham return LLDB_INVALID_IMAGE_TOKEN; 11900d231f71SJim Ingham } 11910d231f71SJim Ingham // Now make spaces in the target for the buffer. We need to add one for 11920d231f71SJim Ingham // the '/' that the utility function will insert and one for the '\0': 11930d231f71SJim Ingham buffer_size += path.size() + 2; 11940d231f71SJim Ingham 11950d231f71SJim Ingham buffer_addr = process->AllocateMemory(buffer_size, 11960d231f71SJim Ingham permissions, 11970d231f71SJim Ingham utility_error); 11980d231f71SJim Ingham if (buffer_addr == LLDB_INVALID_ADDRESS) { 11990d231f71SJim Ingham error.SetErrorStringWithFormat("dlopen error: could not allocate memory" 12000d231f71SJim Ingham "for buffer: %s", 12010d231f71SJim Ingham utility_error.AsCString()); 12020d231f71SJim Ingham return LLDB_INVALID_IMAGE_TOKEN; 12030d231f71SJim Ingham } 12040d231f71SJim Ingham 12050d231f71SJim Ingham // Make sure we deallocate the buffer memory: 12060d231f71SJim Ingham buffer_cleanup.emplace([process, buffer_addr] { 12070d231f71SJim Ingham process->DeallocateMemory(buffer_addr); 12080d231f71SJim Ingham }); 12090d231f71SJim Ingham } 12100d231f71SJim Ingham 12111ecb34f4SJim Ingham arguments.GetValueAtIndex(0)->GetScalar() = path_addr; 12120d231f71SJim Ingham arguments.GetValueAtIndex(1)->GetScalar() = path_array_addr; 12130d231f71SJim Ingham arguments.GetValueAtIndex(2)->GetScalar() = buffer_addr; 12140d231f71SJim Ingham arguments.GetValueAtIndex(3)->GetScalar() = return_addr; 12151ecb34f4SJim Ingham 12161ecb34f4SJim Ingham lldb::addr_t func_args_addr = LLDB_INVALID_ADDRESS; 12171ecb34f4SJim Ingham 12181ecb34f4SJim Ingham diagnostics.Clear(); 12191ecb34f4SJim Ingham if (!do_dlopen_function->WriteFunctionArguments(exe_ctx, 12201ecb34f4SJim Ingham func_args_addr, 12211ecb34f4SJim Ingham arguments, 12221ecb34f4SJim Ingham diagnostics)) { 12231ecb34f4SJim Ingham error.SetErrorStringWithFormat("dlopen error: could not write function " 12241ecb34f4SJim Ingham "arguments: %s", 12251ecb34f4SJim Ingham diagnostics.GetString().c_str()); 12261ecb34f4SJim Ingham return LLDB_INVALID_IMAGE_TOKEN; 12271ecb34f4SJim Ingham } 12281ecb34f4SJim Ingham 12291ecb34f4SJim Ingham // Make sure we clean up the args structure. We can't reuse it because the 12301ecb34f4SJim Ingham // Platform lives longer than the process and the Platforms don't get a 12311ecb34f4SJim Ingham // signal to clean up cached data when a process goes away. 12321ecb34f4SJim Ingham CleanUp args_cleanup([do_dlopen_function, &exe_ctx, func_args_addr] { 12331ecb34f4SJim Ingham do_dlopen_function->DeallocateFunctionResults(exe_ctx, func_args_addr); 12341ecb34f4SJim Ingham }); 12351ecb34f4SJim Ingham 12361ecb34f4SJim Ingham // Now run the caller: 12371ecb34f4SJim Ingham EvaluateExpressionOptions options; 12381ecb34f4SJim Ingham options.SetExecutionPolicy(eExecutionPolicyAlways); 12391ecb34f4SJim Ingham options.SetLanguage(eLanguageTypeC_plus_plus); 12401ecb34f4SJim Ingham options.SetIgnoreBreakpoints(true); 12411ecb34f4SJim Ingham options.SetUnwindOnError(true); 12421ecb34f4SJim Ingham options.SetTrapExceptions(false); // dlopen can't throw exceptions, so 12431ecb34f4SJim Ingham // don't do the work to trap them. 12441ecb34f4SJim Ingham options.SetTimeout(std::chrono::seconds(2)); 1245c01783a8SRaphael Isemann options.SetIsForUtilityExpr(true); 12461ecb34f4SJim Ingham 12471ecb34f4SJim Ingham Value return_value; 12481ecb34f4SJim Ingham // Fetch the clang types we will need: 12491ecb34f4SJim Ingham ClangASTContext *ast = process->GetTarget().GetScratchClangASTContext(); 12501ecb34f4SJim Ingham 12511ecb34f4SJim Ingham CompilerType clang_void_pointer_type 12521ecb34f4SJim Ingham = ast->GetBasicType(eBasicTypeVoid).GetPointerType(); 12531ecb34f4SJim Ingham 12541ecb34f4SJim Ingham return_value.SetCompilerType(clang_void_pointer_type); 12551ecb34f4SJim Ingham 12561ecb34f4SJim Ingham ExpressionResults results = do_dlopen_function->ExecuteFunction( 12571ecb34f4SJim Ingham exe_ctx, &func_args_addr, options, diagnostics, return_value); 12581ecb34f4SJim Ingham if (results != eExpressionCompleted) { 12590d231f71SJim Ingham error.SetErrorStringWithFormat("dlopen error: failed executing " 12601ecb34f4SJim Ingham "dlopen wrapper function: %s", 12611ecb34f4SJim Ingham diagnostics.GetString().c_str()); 12621ecb34f4SJim Ingham return LLDB_INVALID_IMAGE_TOKEN; 12631ecb34f4SJim Ingham } 12641ecb34f4SJim Ingham 12651ecb34f4SJim Ingham // Read the dlopen token from the return area: 12661ecb34f4SJim Ingham lldb::addr_t token = process->ReadPointerFromMemory(return_addr, 12671ecb34f4SJim Ingham utility_error); 12681ecb34f4SJim Ingham if (utility_error.Fail()) { 12691ecb34f4SJim Ingham error.SetErrorStringWithFormat("dlopen error: could not read the return " 12701ecb34f4SJim Ingham "struct: %s", utility_error.AsCString()); 12711ecb34f4SJim Ingham return LLDB_INVALID_IMAGE_TOKEN; 12721ecb34f4SJim Ingham } 12731ecb34f4SJim Ingham 12741ecb34f4SJim Ingham // The dlopen succeeded! 12750d231f71SJim Ingham if (token != 0x0) { 12760d231f71SJim Ingham if (loaded_image && buffer_addr != 0x0) 12770d231f71SJim Ingham { 12780d231f71SJim Ingham // Capture the image which was loaded. We leave it in the buffer on 12790d231f71SJim Ingham // exit from the dlopen function, so we can just read it from there: 12800d231f71SJim Ingham std::string name_string; 12810d231f71SJim Ingham process->ReadCStringFromMemory(buffer_addr, name_string, utility_error); 12820d231f71SJim Ingham if (utility_error.Success()) 12838f3be7a3SJonas Devlieghere loaded_image->SetFile(name_string, llvm::sys::path::Style::posix); 12840d231f71SJim Ingham } 12851ecb34f4SJim Ingham return process->AddImageToken(token); 12860d231f71SJim Ingham } 12871ecb34f4SJim Ingham 12881ecb34f4SJim Ingham // We got an error, lets read in the error string: 12891ecb34f4SJim Ingham std::string dlopen_error_str; 12901ecb34f4SJim Ingham lldb::addr_t error_addr 12911ecb34f4SJim Ingham = process->ReadPointerFromMemory(return_addr + addr_size, utility_error); 12921ecb34f4SJim Ingham if (utility_error.Fail()) { 12931ecb34f4SJim Ingham error.SetErrorStringWithFormat("dlopen error: could not read error string: " 12941ecb34f4SJim Ingham "%s", utility_error.AsCString()); 12951ecb34f4SJim Ingham return LLDB_INVALID_IMAGE_TOKEN; 12961ecb34f4SJim Ingham } 12971ecb34f4SJim Ingham 12981ecb34f4SJim Ingham size_t num_chars = process->ReadCStringFromMemory(error_addr + addr_size, 12991ecb34f4SJim Ingham dlopen_error_str, 13001ecb34f4SJim Ingham utility_error); 13011ecb34f4SJim Ingham if (utility_error.Success() && num_chars > 0) 1302b9c1b51eSKate Stone error.SetErrorStringWithFormat("dlopen error: %s", 13031ecb34f4SJim Ingham dlopen_error_str.c_str()); 13043cb132a0STamas Berghammer else 13053cb132a0STamas Berghammer error.SetErrorStringWithFormat("dlopen failed for unknown reasons."); 13061ecb34f4SJim Ingham 13073cb132a0STamas Berghammer return LLDB_INVALID_IMAGE_TOKEN; 13083cb132a0STamas Berghammer } 13093cb132a0STamas Berghammer 131097206d57SZachary Turner Status PlatformPOSIX::UnloadImage(lldb_private::Process *process, 1311b9c1b51eSKate Stone uint32_t image_token) { 13123cb132a0STamas Berghammer const addr_t image_addr = process->GetImagePtrFromToken(image_token); 13133cb132a0STamas Berghammer if (image_addr == LLDB_INVALID_ADDRESS) 131497206d57SZachary Turner return Status("Invalid image token"); 13153cb132a0STamas Berghammer 13163cb132a0STamas Berghammer StreamString expr; 13173cb132a0STamas Berghammer expr.Printf("dlclose((void *)0x%" PRIx64 ")", image_addr); 1318f7a5851dSNitesh Jain llvm::StringRef prefix = GetLibdlFunctionDeclarations(process); 13193cb132a0STamas Berghammer lldb::ValueObjectSP result_valobj_sp; 132097206d57SZachary Turner Status error = EvaluateLibdlExpression(process, expr.GetData(), prefix, 1321b9c1b51eSKate Stone result_valobj_sp); 13223cb132a0STamas Berghammer if (error.Fail()) 13233cb132a0STamas Berghammer return error; 13243cb132a0STamas Berghammer 13253cb132a0STamas Berghammer if (result_valobj_sp->GetError().Fail()) 13263cb132a0STamas Berghammer return result_valobj_sp->GetError(); 13273cb132a0STamas Berghammer 13283cb132a0STamas Berghammer Scalar scalar; 1329b9c1b51eSKate Stone if (result_valobj_sp->ResolveValue(scalar)) { 13303cb132a0STamas Berghammer if (scalar.UInt(1)) 133197206d57SZachary Turner return Status("expression failed: \"%s\"", expr.GetData()); 13323cb132a0STamas Berghammer process->ResetImageToken(image_token); 13333cb132a0STamas Berghammer } 133497206d57SZachary Turner return Status(); 13353cb132a0STamas Berghammer } 1336fcdde63fSTamas Berghammer 13373165945aSZachary Turner lldb::ProcessSP PlatformPOSIX::ConnectProcess(llvm::StringRef connect_url, 13383165945aSZachary Turner llvm::StringRef plugin_name, 1339ccd6cffbSTamas Berghammer lldb_private::Debugger &debugger, 1340ccd6cffbSTamas Berghammer lldb_private::Target *target, 134197206d57SZachary Turner lldb_private::Status &error) { 1342ccd6cffbSTamas Berghammer if (m_remote_platform_sp) 1343b9c1b51eSKate Stone return m_remote_platform_sp->ConnectProcess(connect_url, plugin_name, 1344b9c1b51eSKate Stone debugger, target, error); 1345ccd6cffbSTamas Berghammer 1346b9c1b51eSKate Stone return Platform::ConnectProcess(connect_url, plugin_name, debugger, target, 1347b9c1b51eSKate Stone error); 1348ccd6cffbSTamas Berghammer } 1349ccd6cffbSTamas Berghammer 1350f7a5851dSNitesh Jain llvm::StringRef 1351f7a5851dSNitesh Jain PlatformPOSIX::GetLibdlFunctionDeclarations(lldb_private::Process *process) { 1352fcdde63fSTamas Berghammer return R"( 1353fcdde63fSTamas Berghammer extern "C" void* dlopen(const char*, int); 1354fcdde63fSTamas Berghammer extern "C" void* dlsym(void*, const char*); 1355fcdde63fSTamas Berghammer extern "C" int dlclose(void*); 1356fcdde63fSTamas Berghammer extern "C" char* dlerror(void); 1357fcdde63fSTamas Berghammer )"; 1358fcdde63fSTamas Berghammer } 1359ccd6cffbSTamas Berghammer 1360b9c1b51eSKate Stone size_t PlatformPOSIX::ConnectToWaitingProcesses(Debugger &debugger, 136197206d57SZachary Turner Status &error) { 1362ccd6cffbSTamas Berghammer if (m_remote_platform_sp) 1363ccd6cffbSTamas Berghammer return m_remote_platform_sp->ConnectToWaitingProcesses(debugger, error); 1364ccd6cffbSTamas Berghammer return Platform::ConnectToWaitingProcesses(debugger, error); 1365ccd6cffbSTamas Berghammer } 1366ec9bc8ccSPavel Labath 1367ec9bc8ccSPavel Labath ConstString PlatformPOSIX::GetFullNameForDylib(ConstString basename) { 1368ec9bc8ccSPavel Labath if (basename.IsEmpty()) 1369ec9bc8ccSPavel Labath return basename; 1370ec9bc8ccSPavel Labath 1371ec9bc8ccSPavel Labath StreamString stream; 1372ec9bc8ccSPavel Labath stream.Printf("lib%s.so", basename.GetCString()); 1373ec9bc8ccSPavel Labath return ConstString(stream.GetString()); 1374ec9bc8ccSPavel Labath } 1375