1e0f8f574SDaniel Malea //===-- PlatformPOSIX.cpp ---------------------------------------*- C++ -*-===//
2e0f8f574SDaniel Malea //
32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information.
52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6e0f8f574SDaniel Malea //
7e0f8f574SDaniel Malea //===----------------------------------------------------------------------===//
8e0f8f574SDaniel Malea 
9e0f8f574SDaniel Malea #include "PlatformPOSIX.h"
10e0f8f574SDaniel Malea 
11348fb385STodd Fiala #include "lldb/Core/Debugger.h"
12348fb385STodd Fiala #include "lldb/Core/Module.h"
13fc89bbccSPavel Labath #include "lldb/Core/ModuleSpec.h"
143cb132a0STamas Berghammer #include "lldb/Core/ValueObject.h"
151ecb34f4SJim Ingham #include "lldb/Expression/DiagnosticManager.h"
161ecb34f4SJim Ingham #include "lldb/Expression/FunctionCaller.h"
173cb132a0STamas Berghammer #include "lldb/Expression/UserExpression.h"
181ecb34f4SJim Ingham #include "lldb/Expression/UtilityFunction.h"
19e0f8f574SDaniel Malea #include "lldb/Host/File.h"
20c00cf4a0SZachary Turner #include "lldb/Host/FileCache.h"
21c00cf4a0SZachary Turner #include "lldb/Host/FileSystem.h"
22e0f8f574SDaniel Malea #include "lldb/Host/Host.h"
23fc89bbccSPavel Labath #include "lldb/Host/HostInfo.h"
24*eef758e9SPavel Labath #include "lldb/Host/ProcessLaunchInfo.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"
293cb132a0STamas Berghammer #include "lldb/Target/Thread.h"
301ecb34f4SJim Ingham #include "lldb/Utility/CleanUp.h"
31666cc0b2SZachary Turner #include "lldb/Utility/DataBufferHeap.h"
325713a05bSZachary Turner #include "lldb/Utility/FileSpec.h"
336f9e6901SZachary Turner #include "lldb/Utility/Log.h"
34bf9a7730SZachary Turner #include "lldb/Utility/StreamString.h"
35e0f8f574SDaniel Malea 
36e0f8f574SDaniel Malea using namespace lldb;
37e0f8f574SDaniel Malea using namespace lldb_private;
38e0f8f574SDaniel Malea 
39e0f8f574SDaniel Malea //------------------------------------------------------------------
40e0f8f574SDaniel Malea /// Default Constructor
41e0f8f574SDaniel Malea //------------------------------------------------------------------
42b9c1b51eSKate Stone PlatformPOSIX::PlatformPOSIX(bool is_host)
43b9c1b51eSKate Stone     : Platform(is_host), // This is the local host platform
440a66e2f1SEnrico Granata       m_option_group_platform_rsync(new OptionGroupPlatformRSync()),
450a66e2f1SEnrico Granata       m_option_group_platform_ssh(new OptionGroupPlatformSSH()),
460a66e2f1SEnrico Granata       m_option_group_platform_caching(new OptionGroupPlatformCaching()),
47b9c1b51eSKate Stone       m_remote_platform_sp() {}
48e0f8f574SDaniel Malea 
49e0f8f574SDaniel Malea //------------------------------------------------------------------
50e0f8f574SDaniel Malea /// Destructor.
51e0f8f574SDaniel Malea ///
52e0f8f574SDaniel Malea /// The destructor is virtual since this class is designed to be
53e0f8f574SDaniel Malea /// inherited from by the plug-in instance.
54e0f8f574SDaniel Malea //------------------------------------------------------------------
55b9c1b51eSKate Stone PlatformPOSIX::~PlatformPOSIX() {}
56e0f8f574SDaniel Malea 
57b9c1b51eSKate Stone bool PlatformPOSIX::GetModuleSpec(const FileSpec &module_file_spec,
5863acdfdeSOleksiy Vyalov                                   const ArchSpec &arch,
59b9c1b51eSKate Stone                                   ModuleSpec &module_spec) {
6063acdfdeSOleksiy Vyalov   if (m_remote_platform_sp)
61b9c1b51eSKate Stone     return m_remote_platform_sp->GetModuleSpec(module_file_spec, arch,
62b9c1b51eSKate Stone                                                module_spec);
6363acdfdeSOleksiy Vyalov 
6463acdfdeSOleksiy Vyalov   return Platform::GetModuleSpec(module_file_spec, arch, module_spec);
6563acdfdeSOleksiy Vyalov }
6663acdfdeSOleksiy Vyalov 
67b9c1b51eSKate Stone lldb_private::OptionGroupOptions *PlatformPOSIX::GetConnectionOptions(
68b9c1b51eSKate Stone     lldb_private::CommandInterpreter &interpreter) {
690a66e2f1SEnrico Granata   auto iter = m_options.find(&interpreter), end = m_options.end();
70b9c1b51eSKate Stone   if (iter == end) {
71b9c1b51eSKate Stone     std::unique_ptr<lldb_private::OptionGroupOptions> options(
72b9c1b51eSKate Stone         new OptionGroupOptions());
730a66e2f1SEnrico Granata     options->Append(m_option_group_platform_rsync.get());
740a66e2f1SEnrico Granata     options->Append(m_option_group_platform_ssh.get());
750a66e2f1SEnrico Granata     options->Append(m_option_group_platform_caching.get());
760a66e2f1SEnrico Granata     m_options[&interpreter] = std::move(options);
77e0f8f574SDaniel Malea   }
780a66e2f1SEnrico Granata 
790a66e2f1SEnrico Granata   return m_options.at(&interpreter).get();
80e0f8f574SDaniel Malea }
81e0f8f574SDaniel Malea 
82b9c1b51eSKate Stone bool PlatformPOSIX::IsConnected() const {
83015d818bSTodd Fiala   if (IsHost())
84015d818bSTodd Fiala     return true;
85015d818bSTodd Fiala   else if (m_remote_platform_sp)
86015d818bSTodd Fiala     return m_remote_platform_sp->IsConnected();
87015d818bSTodd Fiala   return false;
88015d818bSTodd Fiala }
89015d818bSTodd Fiala 
9097206d57SZachary Turner lldb_private::Status PlatformPOSIX::RunShellCommand(
91b9c1b51eSKate Stone     const char *command, // Shouldn't be NULL
92b9c1b51eSKate Stone     const FileSpec &
93b9c1b51eSKate Stone         working_dir, // Pass empty FileSpec to use the current working directory
94e0f8f574SDaniel Malea     int *status_ptr, // Pass NULL if you don't want the process exit status
95b9c1b51eSKate Stone     int *signo_ptr,  // Pass NULL if you don't want the signal that caused the
96b9c1b51eSKate Stone                      // process to exit
97b9c1b51eSKate Stone     std::string
98b9c1b51eSKate Stone         *command_output, // Pass NULL if you don't want the command output
9919dd1a0eSPavel Labath     const Timeout<std::micro> &timeout) {
100e0f8f574SDaniel Malea   if (IsHost())
101b9c1b51eSKate Stone     return Host::RunShellCommand(command, working_dir, status_ptr, signo_ptr,
10219dd1a0eSPavel Labath                                  command_output, timeout);
103b9c1b51eSKate Stone   else {
104e0f8f574SDaniel Malea     if (m_remote_platform_sp)
10519dd1a0eSPavel Labath       return m_remote_platform_sp->RunShellCommand(
10619dd1a0eSPavel Labath           command, working_dir, status_ptr, signo_ptr, command_output, timeout);
107e0f8f574SDaniel Malea     else
10897206d57SZachary Turner       return Status("unable to run a remote command without a platform");
109e0f8f574SDaniel Malea   }
110e0f8f574SDaniel Malea }
111e0f8f574SDaniel Malea 
11297206d57SZachary Turner Status
11397206d57SZachary Turner PlatformPOSIX::ResolveExecutable(const ModuleSpec &module_spec,
114fc89bbccSPavel Labath                                  lldb::ModuleSP &exe_module_sp,
115fc89bbccSPavel Labath                                  const FileSpecList *module_search_paths_ptr) {
11697206d57SZachary Turner   Status error;
117fc89bbccSPavel Labath   // Nothing special to do here, just use the actual file and architecture
118fc89bbccSPavel Labath 
119fc89bbccSPavel Labath   char exe_path[PATH_MAX];
120fc89bbccSPavel Labath   ModuleSpec resolved_module_spec(module_spec);
121fc89bbccSPavel Labath 
122fc89bbccSPavel Labath   if (IsHost()) {
12305097246SAdrian Prantl     // If we have "ls" as the exe_file, resolve the executable location based
12405097246SAdrian Prantl     // on the current path variables
125dbd7fabaSJonas Devlieghere     if (!FileSystem::Instance().Exists(resolved_module_spec.GetFileSpec())) {
126fc89bbccSPavel Labath       resolved_module_spec.GetFileSpec().GetPath(exe_path, sizeof(exe_path));
1278f3be7a3SJonas Devlieghere       resolved_module_spec.GetFileSpec().SetFile(exe_path,
128937348cdSJonas Devlieghere                                                  FileSpec::Style::native);
1298f3be7a3SJonas Devlieghere       FileSystem::Instance().Resolve(resolved_module_spec.GetFileSpec());
130fc89bbccSPavel Labath     }
131fc89bbccSPavel Labath 
132dbd7fabaSJonas Devlieghere     if (!FileSystem::Instance().Exists(resolved_module_spec.GetFileSpec()))
1332c22c800SJonas Devlieghere       FileSystem::Instance().ResolveExecutableLocation(
1342c22c800SJonas Devlieghere           resolved_module_spec.GetFileSpec());
135fc89bbccSPavel Labath 
136fc89bbccSPavel Labath     // Resolve any executable within a bundle on MacOSX
137fc89bbccSPavel Labath     Host::ResolveExecutableInBundle(resolved_module_spec.GetFileSpec());
138fc89bbccSPavel Labath 
139dbd7fabaSJonas Devlieghere     if (FileSystem::Instance().Exists(resolved_module_spec.GetFileSpec()))
140fc89bbccSPavel Labath       error.Clear();
141fc89bbccSPavel Labath     else {
1427c5310bbSJonas Devlieghere       const uint32_t permissions = FileSystem::Instance().GetPermissions(
1437c5310bbSJonas Devlieghere           resolved_module_spec.GetFileSpec());
144fc89bbccSPavel Labath       if (permissions && (permissions & eFilePermissionsEveryoneR) == 0)
145fc89bbccSPavel Labath         error.SetErrorStringWithFormat(
146fc89bbccSPavel Labath             "executable '%s' is not readable",
147fc89bbccSPavel Labath             resolved_module_spec.GetFileSpec().GetPath().c_str());
148fc89bbccSPavel Labath       else
149fc89bbccSPavel Labath         error.SetErrorStringWithFormat(
150fc89bbccSPavel Labath             "unable to find executable for '%s'",
151fc89bbccSPavel Labath             resolved_module_spec.GetFileSpec().GetPath().c_str());
152fc89bbccSPavel Labath     }
153fc89bbccSPavel Labath   } else {
154fc89bbccSPavel Labath     if (m_remote_platform_sp) {
155fc89bbccSPavel Labath       error =
156fc89bbccSPavel Labath           GetCachedExecutable(resolved_module_spec, exe_module_sp,
157fc89bbccSPavel Labath                               module_search_paths_ptr, *m_remote_platform_sp);
158fc89bbccSPavel Labath     } else {
159fc89bbccSPavel Labath       // We may connect to a process and use the provided executable (Don't use
160fc89bbccSPavel Labath       // local $PATH).
161fc89bbccSPavel Labath 
162fc89bbccSPavel Labath       // Resolve any executable within a bundle on MacOSX
163fc89bbccSPavel Labath       Host::ResolveExecutableInBundle(resolved_module_spec.GetFileSpec());
164fc89bbccSPavel Labath 
165dbd7fabaSJonas Devlieghere       if (FileSystem::Instance().Exists(resolved_module_spec.GetFileSpec()))
166fc89bbccSPavel Labath         error.Clear();
167fc89bbccSPavel Labath       else
168fc89bbccSPavel Labath         error.SetErrorStringWithFormat("the platform is not currently "
169fc89bbccSPavel Labath                                        "connected, and '%s' doesn't exist in "
170fc89bbccSPavel Labath                                        "the system root.",
171fc89bbccSPavel Labath                                        exe_path);
172fc89bbccSPavel Labath     }
173fc89bbccSPavel Labath   }
174fc89bbccSPavel Labath 
175fc89bbccSPavel Labath   if (error.Success()) {
176fc89bbccSPavel Labath     if (resolved_module_spec.GetArchitecture().IsValid()) {
177fc89bbccSPavel Labath       error = ModuleList::GetSharedModule(resolved_module_spec, exe_module_sp,
178fc89bbccSPavel Labath                                           module_search_paths_ptr, nullptr, nullptr);
179fc89bbccSPavel Labath       if (error.Fail()) {
180fc89bbccSPavel Labath         // If we failed, it may be because the vendor and os aren't known. If
181fc89bbccSPavel Labath 	// that is the case, try setting them to the host architecture and give
182fc89bbccSPavel Labath 	// it another try.
183fc89bbccSPavel Labath         llvm::Triple &module_triple =
184fc89bbccSPavel Labath             resolved_module_spec.GetArchitecture().GetTriple();
185fc89bbccSPavel Labath         bool is_vendor_specified =
186fc89bbccSPavel Labath             (module_triple.getVendor() != llvm::Triple::UnknownVendor);
187fc89bbccSPavel Labath         bool is_os_specified =
188fc89bbccSPavel Labath             (module_triple.getOS() != llvm::Triple::UnknownOS);
189fc89bbccSPavel Labath         if (!is_vendor_specified || !is_os_specified) {
190fc89bbccSPavel Labath           const llvm::Triple &host_triple =
191fc89bbccSPavel Labath               HostInfo::GetArchitecture(HostInfo::eArchKindDefault).GetTriple();
192fc89bbccSPavel Labath 
193fc89bbccSPavel Labath           if (!is_vendor_specified)
194fc89bbccSPavel Labath             module_triple.setVendorName(host_triple.getVendorName());
195fc89bbccSPavel Labath           if (!is_os_specified)
196fc89bbccSPavel Labath             module_triple.setOSName(host_triple.getOSName());
197fc89bbccSPavel Labath 
198fc89bbccSPavel Labath           error = ModuleList::GetSharedModule(resolved_module_spec,
199fc89bbccSPavel Labath                                               exe_module_sp, module_search_paths_ptr, nullptr, nullptr);
200fc89bbccSPavel Labath         }
201fc89bbccSPavel Labath       }
202fc89bbccSPavel Labath 
203fc89bbccSPavel Labath       // TODO find out why exe_module_sp might be NULL
204fc89bbccSPavel Labath       if (error.Fail() || !exe_module_sp || !exe_module_sp->GetObjectFile()) {
205fc89bbccSPavel Labath         exe_module_sp.reset();
206fc89bbccSPavel Labath         error.SetErrorStringWithFormat(
207fc89bbccSPavel Labath             "'%s' doesn't contain the architecture %s",
208fc89bbccSPavel Labath             resolved_module_spec.GetFileSpec().GetPath().c_str(),
209fc89bbccSPavel Labath             resolved_module_spec.GetArchitecture().GetArchitectureName());
210fc89bbccSPavel Labath       }
211fc89bbccSPavel Labath     } else {
21205097246SAdrian Prantl       // No valid architecture was specified, ask the platform for the
21305097246SAdrian Prantl       // architectures that we should be using (in the correct order) and see
21405097246SAdrian Prantl       // if we can find a match that way
215fc89bbccSPavel Labath       StreamString arch_names;
216fc89bbccSPavel Labath       for (uint32_t idx = 0; GetSupportedArchitectureAtIndex(
217fc89bbccSPavel Labath                idx, resolved_module_spec.GetArchitecture());
218fc89bbccSPavel Labath            ++idx) {
219fc89bbccSPavel Labath         error = ModuleList::GetSharedModule(resolved_module_spec, exe_module_sp,
220fc89bbccSPavel Labath                                             module_search_paths_ptr, nullptr, nullptr);
221fc89bbccSPavel Labath         // Did we find an executable using one of the
222fc89bbccSPavel Labath         if (error.Success()) {
223fc89bbccSPavel Labath           if (exe_module_sp && exe_module_sp->GetObjectFile())
224fc89bbccSPavel Labath             break;
225fc89bbccSPavel Labath           else
226fc89bbccSPavel Labath             error.SetErrorToGenericError();
227fc89bbccSPavel Labath         }
228fc89bbccSPavel Labath 
229fc89bbccSPavel Labath         if (idx > 0)
230fc89bbccSPavel Labath           arch_names.PutCString(", ");
231fc89bbccSPavel Labath         arch_names.PutCString(
232fc89bbccSPavel Labath             resolved_module_spec.GetArchitecture().GetArchitectureName());
233fc89bbccSPavel Labath       }
234fc89bbccSPavel Labath 
235fc89bbccSPavel Labath       if (error.Fail() || !exe_module_sp) {
2367c5310bbSJonas Devlieghere         if (FileSystem::Instance().Readable(
2377c5310bbSJonas Devlieghere                 resolved_module_spec.GetFileSpec())) {
238fc89bbccSPavel Labath           error.SetErrorStringWithFormat(
239fc89bbccSPavel Labath               "'%s' doesn't contain any '%s' platform architectures: %s",
240fc89bbccSPavel Labath               resolved_module_spec.GetFileSpec().GetPath().c_str(),
241fc89bbccSPavel Labath               GetPluginName().GetCString(), arch_names.GetData());
242fc89bbccSPavel Labath         } else {
243fc89bbccSPavel Labath           error.SetErrorStringWithFormat(
244fc89bbccSPavel Labath               "'%s' is not readable",
245fc89bbccSPavel Labath               resolved_module_spec.GetFileSpec().GetPath().c_str());
246fc89bbccSPavel Labath         }
247fc89bbccSPavel Labath       }
248fc89bbccSPavel Labath     }
249fc89bbccSPavel Labath   }
250fc89bbccSPavel Labath 
251fc89bbccSPavel Labath   return error;
252fc89bbccSPavel Labath }
253fc89bbccSPavel Labath 
25497206d57SZachary Turner Status PlatformPOSIX::GetFileWithUUID(const FileSpec &platform_file,
255ec9bc8ccSPavel Labath                                       const UUID *uuid_ptr,
256ec9bc8ccSPavel Labath                                       FileSpec &local_file) {
257ec9bc8ccSPavel Labath   if (IsRemote() && m_remote_platform_sp)
258ec9bc8ccSPavel Labath       return m_remote_platform_sp->GetFileWithUUID(platform_file, uuid_ptr,
259ec9bc8ccSPavel Labath                                                    local_file);
260ec9bc8ccSPavel Labath 
261ec9bc8ccSPavel Labath   // Default to the local case
262ec9bc8ccSPavel Labath   local_file = platform_file;
26397206d57SZachary Turner   return Status();
264ec9bc8ccSPavel Labath }
265ec9bc8ccSPavel Labath 
266ec9bc8ccSPavel Labath bool PlatformPOSIX::GetProcessInfo(lldb::pid_t pid,
267ec9bc8ccSPavel Labath                                      ProcessInstanceInfo &process_info) {
268ec9bc8ccSPavel Labath   if (IsHost())
269ec9bc8ccSPavel Labath     return Platform::GetProcessInfo(pid, process_info);
270ec9bc8ccSPavel Labath   if (m_remote_platform_sp)
271ec9bc8ccSPavel Labath     return m_remote_platform_sp->GetProcessInfo(pid, process_info);
272ec9bc8ccSPavel Labath   return false;
273ec9bc8ccSPavel Labath }
274ec9bc8ccSPavel Labath 
275ec9bc8ccSPavel Labath uint32_t
276ec9bc8ccSPavel Labath PlatformPOSIX::FindProcesses(const ProcessInstanceInfoMatch &match_info,
277ec9bc8ccSPavel Labath                                ProcessInstanceInfoList &process_infos) {
278ec9bc8ccSPavel Labath   if (IsHost())
279ec9bc8ccSPavel Labath     return Platform::FindProcesses(match_info, process_infos);
280ec9bc8ccSPavel Labath   if (m_remote_platform_sp)
281ec9bc8ccSPavel Labath     return
282ec9bc8ccSPavel Labath       m_remote_platform_sp->FindProcesses(match_info, process_infos);
283ec9bc8ccSPavel Labath   return 0;
284ec9bc8ccSPavel Labath }
285ec9bc8ccSPavel Labath 
28697206d57SZachary Turner Status PlatformPOSIX::MakeDirectory(const FileSpec &file_spec,
287b9c1b51eSKate Stone                                     uint32_t file_permissions) {
288fbb76349SGreg Clayton   if (m_remote_platform_sp)
289d3173f34SChaoren Lin     return m_remote_platform_sp->MakeDirectory(file_spec, file_permissions);
290fbb76349SGreg Clayton   else
291d3173f34SChaoren Lin     return Platform::MakeDirectory(file_spec, file_permissions);
292e0f8f574SDaniel Malea }
293fbb76349SGreg Clayton 
29497206d57SZachary Turner Status PlatformPOSIX::GetFilePermissions(const FileSpec &file_spec,
295b9c1b51eSKate Stone                                          uint32_t &file_permissions) {
296fbb76349SGreg Clayton   if (m_remote_platform_sp)
297b9c1b51eSKate Stone     return m_remote_platform_sp->GetFilePermissions(file_spec,
298b9c1b51eSKate Stone                                                     file_permissions);
299fbb76349SGreg Clayton   else
300d3173f34SChaoren Lin     return Platform::GetFilePermissions(file_spec, file_permissions);
301fbb76349SGreg Clayton }
302fbb76349SGreg Clayton 
30397206d57SZachary Turner Status PlatformPOSIX::SetFilePermissions(const FileSpec &file_spec,
304b9c1b51eSKate Stone                                          uint32_t file_permissions) {
305fbb76349SGreg Clayton   if (m_remote_platform_sp)
306b9c1b51eSKate Stone     return m_remote_platform_sp->SetFilePermissions(file_spec,
307b9c1b51eSKate Stone                                                     file_permissions);
308fbb76349SGreg Clayton   else
309d3173f34SChaoren Lin     return Platform::SetFilePermissions(file_spec, file_permissions);
310e0f8f574SDaniel Malea }
311e0f8f574SDaniel Malea 
312b9c1b51eSKate Stone lldb::user_id_t PlatformPOSIX::OpenFile(const FileSpec &file_spec,
313b9c1b51eSKate Stone                                         uint32_t flags, uint32_t mode,
31497206d57SZachary Turner                                         Status &error) {
315e0f8f574SDaniel Malea   if (IsHost())
316c00cf4a0SZachary Turner     return FileCache::GetInstance().OpenFile(file_spec, flags, mode, error);
317fbb76349SGreg Clayton   else if (m_remote_platform_sp)
318e0f8f574SDaniel Malea     return m_remote_platform_sp->OpenFile(file_spec, flags, mode, error);
319fbb76349SGreg Clayton   else
320e0f8f574SDaniel Malea     return Platform::OpenFile(file_spec, flags, mode, error);
321e0f8f574SDaniel Malea }
322e0f8f574SDaniel Malea 
32397206d57SZachary Turner bool PlatformPOSIX::CloseFile(lldb::user_id_t fd, Status &error) {
324e0f8f574SDaniel Malea   if (IsHost())
325c00cf4a0SZachary Turner     return FileCache::GetInstance().CloseFile(fd, error);
326fbb76349SGreg Clayton   else if (m_remote_platform_sp)
327e0f8f574SDaniel Malea     return m_remote_platform_sp->CloseFile(fd, error);
328fbb76349SGreg Clayton   else
329e0f8f574SDaniel Malea     return Platform::CloseFile(fd, error);
330e0f8f574SDaniel Malea }
331e0f8f574SDaniel Malea 
332b9c1b51eSKate Stone uint64_t PlatformPOSIX::ReadFile(lldb::user_id_t fd, uint64_t offset, void *dst,
33397206d57SZachary Turner                                  uint64_t dst_len, Status &error) {
334e0f8f574SDaniel Malea   if (IsHost())
335c00cf4a0SZachary Turner     return FileCache::GetInstance().ReadFile(fd, offset, dst, dst_len, error);
336fbb76349SGreg Clayton   else if (m_remote_platform_sp)
337e0f8f574SDaniel Malea     return m_remote_platform_sp->ReadFile(fd, offset, dst, dst_len, error);
338fbb76349SGreg Clayton   else
339e0f8f574SDaniel Malea     return Platform::ReadFile(fd, offset, dst, dst_len, error);
340e0f8f574SDaniel Malea }
341e0f8f574SDaniel Malea 
342b9c1b51eSKate Stone uint64_t PlatformPOSIX::WriteFile(lldb::user_id_t fd, uint64_t offset,
343b9c1b51eSKate Stone                                   const void *src, uint64_t src_len,
34497206d57SZachary Turner                                   Status &error) {
345e0f8f574SDaniel Malea   if (IsHost())
346c00cf4a0SZachary Turner     return FileCache::GetInstance().WriteFile(fd, offset, src, src_len, error);
347fbb76349SGreg Clayton   else if (m_remote_platform_sp)
348e0f8f574SDaniel Malea     return m_remote_platform_sp->WriteFile(fd, offset, src, src_len, error);
349fbb76349SGreg Clayton   else
350e0f8f574SDaniel Malea     return Platform::WriteFile(fd, offset, src, src_len, error);
351e0f8f574SDaniel Malea }
352e0f8f574SDaniel Malea 
353b9c1b51eSKate Stone static uint32_t chown_file(Platform *platform, const char *path,
354e0f8f574SDaniel Malea                            uint32_t uid = UINT32_MAX,
355b9c1b51eSKate Stone                            uint32_t gid = UINT32_MAX) {
356e0f8f574SDaniel Malea   if (!platform || !path || *path == 0)
357e0f8f574SDaniel Malea     return UINT32_MAX;
358e0f8f574SDaniel Malea 
359e0f8f574SDaniel Malea   if (uid == UINT32_MAX && gid == UINT32_MAX)
360e0f8f574SDaniel Malea     return 0; // pretend I did chown correctly - actually I just didn't care
361e0f8f574SDaniel Malea 
362e0f8f574SDaniel Malea   StreamString command;
363e0f8f574SDaniel Malea   command.PutCString("chown ");
364e0f8f574SDaniel Malea   if (uid != UINT32_MAX)
365e0f8f574SDaniel Malea     command.Printf("%d", uid);
366e0f8f574SDaniel Malea   if (gid != UINT32_MAX)
367e0f8f574SDaniel Malea     command.Printf(":%d", gid);
368e0f8f574SDaniel Malea   command.Printf("%s", path);
369e0f8f574SDaniel Malea   int status;
37019dd1a0eSPavel Labath   platform->RunShellCommand(command.GetData(), NULL, &status, NULL, NULL,
37119dd1a0eSPavel Labath                             std::chrono::seconds(10));
372e0f8f574SDaniel Malea   return status;
373e0f8f574SDaniel Malea }
374e0f8f574SDaniel Malea 
37597206d57SZachary Turner lldb_private::Status
376e0f8f574SDaniel Malea PlatformPOSIX::PutFile(const lldb_private::FileSpec &source,
377b9c1b51eSKate Stone                        const lldb_private::FileSpec &destination, uint32_t uid,
378b9c1b51eSKate Stone                        uint32_t gid) {
379fbb76349SGreg Clayton   Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM));
380fbb76349SGreg Clayton 
381b9c1b51eSKate Stone   if (IsHost()) {
382e0f8f574SDaniel Malea     if (FileSpec::Equal(source, destination, true))
38397206d57SZachary Turner       return Status();
384e0f8f574SDaniel Malea     // cp src dst
385e0f8f574SDaniel Malea     // chown uid:gid dst
386e0f8f574SDaniel Malea     std::string src_path(source.GetPath());
387e0f8f574SDaniel Malea     if (src_path.empty())
38897206d57SZachary Turner       return Status("unable to get file path for source");
389e0f8f574SDaniel Malea     std::string dst_path(destination.GetPath());
390e0f8f574SDaniel Malea     if (dst_path.empty())
39197206d57SZachary Turner       return Status("unable to get file path for destination");
392e0f8f574SDaniel Malea     StreamString command;
393e0f8f574SDaniel Malea     command.Printf("cp %s %s", src_path.c_str(), dst_path.c_str());
394e0f8f574SDaniel Malea     int status;
39519dd1a0eSPavel Labath     RunShellCommand(command.GetData(), NULL, &status, NULL, NULL,
39619dd1a0eSPavel Labath                     std::chrono::seconds(10));
397e0f8f574SDaniel Malea     if (status != 0)
39897206d57SZachary Turner       return Status("unable to perform copy");
399e0f8f574SDaniel Malea     if (uid == UINT32_MAX && gid == UINT32_MAX)
40097206d57SZachary Turner       return Status();
401e0f8f574SDaniel Malea     if (chown_file(this, dst_path.c_str(), uid, gid) != 0)
40297206d57SZachary Turner       return Status("unable to perform chown");
40397206d57SZachary Turner     return Status();
404b9c1b51eSKate Stone   } else if (m_remote_platform_sp) {
405b9c1b51eSKate Stone     if (GetSupportsRSync()) {
406e0f8f574SDaniel Malea       std::string src_path(source.GetPath());
407e0f8f574SDaniel Malea       if (src_path.empty())
40897206d57SZachary Turner         return Status("unable to get file path for source");
409e0f8f574SDaniel Malea       std::string dst_path(destination.GetPath());
410e0f8f574SDaniel Malea       if (dst_path.empty())
41197206d57SZachary Turner         return Status("unable to get file path for destination");
412e0f8f574SDaniel Malea       StreamString command;
413b9c1b51eSKate Stone       if (GetIgnoresRemoteHostname()) {
414e0f8f574SDaniel Malea         if (!GetRSyncPrefix())
415b9c1b51eSKate Stone           command.Printf("rsync %s %s %s", GetRSyncOpts(), src_path.c_str(),
416e0f8f574SDaniel Malea                          dst_path.c_str());
417e0f8f574SDaniel Malea         else
418b9c1b51eSKate Stone           command.Printf("rsync %s %s %s%s", GetRSyncOpts(), src_path.c_str(),
419b9c1b51eSKate Stone                          GetRSyncPrefix(), dst_path.c_str());
420b9c1b51eSKate Stone       } else
421b9c1b51eSKate Stone         command.Printf("rsync %s %s %s:%s", GetRSyncOpts(), src_path.c_str(),
422b9c1b51eSKate Stone                        GetHostname(), dst_path.c_str());
423e0f8f574SDaniel Malea       if (log)
424e0f8f574SDaniel Malea         log->Printf("[PutFile] Running command: %s\n", command.GetData());
425e0f8f574SDaniel Malea       int retcode;
42619dd1a0eSPavel Labath       Host::RunShellCommand(command.GetData(), NULL, &retcode, NULL, NULL,
42719dd1a0eSPavel Labath                             std::chrono::minutes(1));
428b9c1b51eSKate Stone       if (retcode == 0) {
429e0f8f574SDaniel Malea         // Don't chown a local file for a remote system
430e0f8f574SDaniel Malea         //                if (chown_file(this,dst_path.c_str(),uid,gid) != 0)
43197206d57SZachary Turner         //                    return Status("unable to perform chown");
43297206d57SZachary Turner         return Status();
433e0f8f574SDaniel Malea       }
434b9c1b51eSKate Stone       // if we are still here rsync has failed - let's try the slow way before
435b9c1b51eSKate Stone       // giving up
436e0f8f574SDaniel Malea     }
437e0f8f574SDaniel Malea   }
438e0f8f574SDaniel Malea   return Platform::PutFile(source, destination, uid, gid);
439e0f8f574SDaniel Malea }
440e0f8f574SDaniel Malea 
441b9c1b51eSKate Stone lldb::user_id_t PlatformPOSIX::GetFileSize(const FileSpec &file_spec) {
44207db3f7eSZachary Turner   if (IsHost()) {
44307db3f7eSZachary Turner     uint64_t Size;
44407db3f7eSZachary Turner     if (llvm::sys::fs::file_size(file_spec.GetPath(), Size))
44507db3f7eSZachary Turner       return 0;
44607db3f7eSZachary Turner     return Size;
44707db3f7eSZachary Turner   } else if (m_remote_platform_sp)
448e0f8f574SDaniel Malea     return m_remote_platform_sp->GetFileSize(file_spec);
449fbb76349SGreg Clayton   else
450e0f8f574SDaniel Malea     return Platform::GetFileSize(file_spec);
451e0f8f574SDaniel Malea }
452e0f8f574SDaniel Malea 
45397206d57SZachary Turner Status PlatformPOSIX::CreateSymlink(const FileSpec &src, const FileSpec &dst) {
454fbb76349SGreg Clayton   if (IsHost())
45546376966SJonas Devlieghere     return FileSystem::Instance().Symlink(src, dst);
456fbb76349SGreg Clayton   else if (m_remote_platform_sp)
457fbb76349SGreg Clayton     return m_remote_platform_sp->CreateSymlink(src, dst);
458fbb76349SGreg Clayton   else
459fbb76349SGreg Clayton     return Platform::CreateSymlink(src, dst);
460fbb76349SGreg Clayton }
461fbb76349SGreg Clayton 
462b9c1b51eSKate Stone bool PlatformPOSIX::GetFileExists(const FileSpec &file_spec) {
463e0f8f574SDaniel Malea   if (IsHost())
464dbd7fabaSJonas Devlieghere     return FileSystem::Instance().Exists(file_spec);
465fbb76349SGreg Clayton   else if (m_remote_platform_sp)
466e0f8f574SDaniel Malea     return m_remote_platform_sp->GetFileExists(file_spec);
467fbb76349SGreg Clayton   else
468e0f8f574SDaniel Malea     return Platform::GetFileExists(file_spec);
469e0f8f574SDaniel Malea }
470e0f8f574SDaniel Malea 
47197206d57SZachary Turner Status PlatformPOSIX::Unlink(const FileSpec &file_spec) {
472e0f8f574SDaniel Malea   if (IsHost())
47307db3f7eSZachary Turner     return llvm::sys::fs::remove(file_spec.GetPath());
474fbb76349SGreg Clayton   else if (m_remote_platform_sp)
475d3173f34SChaoren Lin     return m_remote_platform_sp->Unlink(file_spec);
476fbb76349SGreg Clayton   else
477d3173f34SChaoren Lin     return Platform::Unlink(file_spec);
478e0f8f574SDaniel Malea }
479e0f8f574SDaniel Malea 
48097206d57SZachary Turner lldb_private::Status PlatformPOSIX::GetFile(
481b9c1b51eSKate Stone     const lldb_private::FileSpec &source,      // remote file path
482d3173f34SChaoren Lin     const lldb_private::FileSpec &destination) // local file path
483e0f8f574SDaniel Malea {
484fbb76349SGreg Clayton   Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM));
485fbb76349SGreg Clayton 
486e0f8f574SDaniel Malea   // Check the args, first.
487e0f8f574SDaniel Malea   std::string src_path(source.GetPath());
488e0f8f574SDaniel Malea   if (src_path.empty())
48997206d57SZachary Turner     return Status("unable to get file path for source");
490e0f8f574SDaniel Malea   std::string dst_path(destination.GetPath());
491e0f8f574SDaniel Malea   if (dst_path.empty())
49297206d57SZachary Turner     return Status("unable to get file path for destination");
493b9c1b51eSKate Stone   if (IsHost()) {
494e0f8f574SDaniel Malea     if (FileSpec::Equal(source, destination, true))
49597206d57SZachary Turner       return Status("local scenario->source and destination are the same file "
496b9c1b51eSKate Stone                     "path: no operation performed");
497e0f8f574SDaniel Malea     // cp src dst
498e0f8f574SDaniel Malea     StreamString cp_command;
499e0f8f574SDaniel Malea     cp_command.Printf("cp %s %s", src_path.c_str(), dst_path.c_str());
500e0f8f574SDaniel Malea     int status;
50119dd1a0eSPavel Labath     RunShellCommand(cp_command.GetData(), NULL, &status, NULL, NULL,
50219dd1a0eSPavel Labath                     std::chrono::seconds(10));
503e0f8f574SDaniel Malea     if (status != 0)
50497206d57SZachary Turner       return Status("unable to perform copy");
50597206d57SZachary Turner     return Status();
506b9c1b51eSKate Stone   } else if (m_remote_platform_sp) {
507b9c1b51eSKate Stone     if (GetSupportsRSync()) {
508e0f8f574SDaniel Malea       StreamString command;
509b9c1b51eSKate Stone       if (GetIgnoresRemoteHostname()) {
510e0f8f574SDaniel Malea         if (!GetRSyncPrefix())
511b9c1b51eSKate Stone           command.Printf("rsync %s %s %s", GetRSyncOpts(), src_path.c_str(),
512e0f8f574SDaniel Malea                          dst_path.c_str());
513e0f8f574SDaniel Malea         else
514b9c1b51eSKate Stone           command.Printf("rsync %s %s%s %s", GetRSyncOpts(), GetRSyncPrefix(),
515b9c1b51eSKate Stone                          src_path.c_str(), dst_path.c_str());
516b9c1b51eSKate Stone       } else
517b9c1b51eSKate Stone         command.Printf("rsync %s %s:%s %s", GetRSyncOpts(),
518b9c1b51eSKate Stone                        m_remote_platform_sp->GetHostname(), src_path.c_str(),
519e0f8f574SDaniel Malea                        dst_path.c_str());
520e0f8f574SDaniel Malea       if (log)
521e0f8f574SDaniel Malea         log->Printf("[GetFile] Running command: %s\n", command.GetData());
522e0f8f574SDaniel Malea       int retcode;
52319dd1a0eSPavel Labath       Host::RunShellCommand(command.GetData(), NULL, &retcode, NULL, NULL,
52419dd1a0eSPavel Labath                             std::chrono::minutes(1));
525e0f8f574SDaniel Malea       if (retcode == 0)
52697206d57SZachary Turner         return Status();
52705097246SAdrian Prantl       // If we are here, rsync has failed - let's try the slow way before
52805097246SAdrian Prantl       // giving up
529e0f8f574SDaniel Malea     }
530e0f8f574SDaniel Malea     // open src and dst
531e0f8f574SDaniel Malea     // read/write, read/write, read/write, ...
532e0f8f574SDaniel Malea     // close src
533e0f8f574SDaniel Malea     // close dst
534e0f8f574SDaniel Malea     if (log)
535e0f8f574SDaniel Malea       log->Printf("[GetFile] Using block by block transfer....\n");
53697206d57SZachary Turner     Status error;
537b9c1b51eSKate Stone     user_id_t fd_src = OpenFile(source, File::eOpenOptionRead,
538b9c1b51eSKate Stone                                 lldb::eFilePermissionsFileDefault, error);
539e0f8f574SDaniel Malea 
540e0f8f574SDaniel Malea     if (fd_src == UINT64_MAX)
54197206d57SZachary Turner       return Status("unable to open source file");
542e0f8f574SDaniel Malea 
543fbb76349SGreg Clayton     uint32_t permissions = 0;
544d3173f34SChaoren Lin     error = GetFilePermissions(source, permissions);
545e0f8f574SDaniel Malea 
546e0f8f574SDaniel Malea     if (permissions == 0)
547fbb76349SGreg Clayton       permissions = lldb::eFilePermissionsFileDefault;
548e0f8f574SDaniel Malea 
549c00cf4a0SZachary Turner     user_id_t fd_dst = FileCache::GetInstance().OpenFile(
550b9c1b51eSKate Stone         destination, File::eOpenOptionCanCreate | File::eOpenOptionWrite |
551b9c1b51eSKate Stone                          File::eOpenOptionTruncate,
552b9c1b51eSKate Stone         permissions, error);
553e0f8f574SDaniel Malea 
554b9c1b51eSKate Stone     if (fd_dst == UINT64_MAX) {
555e0f8f574SDaniel Malea       if (error.Success())
556e0f8f574SDaniel Malea         error.SetErrorString("unable to open destination file");
557e0f8f574SDaniel Malea     }
558e0f8f574SDaniel Malea 
559b9c1b51eSKate Stone     if (error.Success()) {
560e0f8f574SDaniel Malea       lldb::DataBufferSP buffer_sp(new DataBufferHeap(1024, 0));
561e0f8f574SDaniel Malea       uint64_t offset = 0;
562e0f8f574SDaniel Malea       error.Clear();
563b9c1b51eSKate Stone       while (error.Success()) {
564b9c1b51eSKate Stone         const uint64_t n_read = ReadFile(fd_src, offset, buffer_sp->GetBytes(),
565b9c1b51eSKate Stone                                          buffer_sp->GetByteSize(), error);
566e0f8f574SDaniel Malea         if (error.Fail())
567e0f8f574SDaniel Malea           break;
568e0f8f574SDaniel Malea         if (n_read == 0)
569e0f8f574SDaniel Malea           break;
570b9c1b51eSKate Stone         if (FileCache::GetInstance().WriteFile(fd_dst, offset,
571b9c1b51eSKate Stone                                                buffer_sp->GetBytes(), n_read,
572b9c1b51eSKate Stone                                                error) != n_read) {
573e0f8f574SDaniel Malea           if (!error.Fail())
574e0f8f574SDaniel Malea             error.SetErrorString("unable to write to destination file");
575e0f8f574SDaniel Malea           break;
576e0f8f574SDaniel Malea         }
577e0f8f574SDaniel Malea         offset += n_read;
578e0f8f574SDaniel Malea       }
579e0f8f574SDaniel Malea     }
580e0f8f574SDaniel Malea     // Ignore the close error of src.
581e0f8f574SDaniel Malea     if (fd_src != UINT64_MAX)
582e0f8f574SDaniel Malea       CloseFile(fd_src, error);
583e0f8f574SDaniel Malea     // And close the dst file descriptot.
584b9c1b51eSKate Stone     if (fd_dst != UINT64_MAX &&
585b9c1b51eSKate Stone         !FileCache::GetInstance().CloseFile(fd_dst, error)) {
586e0f8f574SDaniel Malea       if (!error.Fail())
587e0f8f574SDaniel Malea         error.SetErrorString("unable to close destination file");
588e0f8f574SDaniel Malea     }
589e0f8f574SDaniel Malea     return error;
590e0f8f574SDaniel Malea   }
591e0f8f574SDaniel Malea   return Platform::GetFile(source, destination);
592e0f8f574SDaniel Malea }
593e0f8f574SDaniel Malea 
594b9c1b51eSKate Stone std::string PlatformPOSIX::GetPlatformSpecificConnectionInformation() {
595e0f8f574SDaniel Malea   StreamString stream;
596b9c1b51eSKate Stone   if (GetSupportsRSync()) {
597e0f8f574SDaniel Malea     stream.PutCString("rsync");
598e0f8f574SDaniel Malea     if ((GetRSyncOpts() && *GetRSyncOpts()) ||
599b9c1b51eSKate Stone         (GetRSyncPrefix() && *GetRSyncPrefix()) || GetIgnoresRemoteHostname()) {
600e0f8f574SDaniel Malea       stream.Printf(", options: ");
601e0f8f574SDaniel Malea       if (GetRSyncOpts() && *GetRSyncOpts())
602e0f8f574SDaniel Malea         stream.Printf("'%s' ", GetRSyncOpts());
603e0f8f574SDaniel Malea       stream.Printf(", prefix: ");
604e0f8f574SDaniel Malea       if (GetRSyncPrefix() && *GetRSyncPrefix())
605e0f8f574SDaniel Malea         stream.Printf("'%s' ", GetRSyncPrefix());
606e0f8f574SDaniel Malea       if (GetIgnoresRemoteHostname())
607e0f8f574SDaniel Malea         stream.Printf("ignore remote-hostname ");
608e0f8f574SDaniel Malea     }
609e0f8f574SDaniel Malea   }
610b9c1b51eSKate Stone   if (GetSupportsSSH()) {
611e0f8f574SDaniel Malea     stream.PutCString("ssh");
612e0f8f574SDaniel Malea     if (GetSSHOpts() && *GetSSHOpts())
613e0f8f574SDaniel Malea       stream.Printf(", options: '%s' ", GetSSHOpts());
614e0f8f574SDaniel Malea   }
615e0f8f574SDaniel Malea   if (GetLocalCacheDirectory() && *GetLocalCacheDirectory())
616e0f8f574SDaniel Malea     stream.Printf("cache dir: %s", GetLocalCacheDirectory());
617e0f8f574SDaniel Malea   if (stream.GetSize())
618c156427dSZachary Turner     return stream.GetString();
619e0f8f574SDaniel Malea   else
620e0f8f574SDaniel Malea     return "";
621e0f8f574SDaniel Malea }
622e0f8f574SDaniel Malea 
623b9c1b51eSKate Stone bool PlatformPOSIX::CalculateMD5(const FileSpec &file_spec, uint64_t &low,
624b9c1b51eSKate Stone                                  uint64_t &high) {
625e0f8f574SDaniel Malea   if (IsHost())
626e0f8f574SDaniel Malea     return Platform::CalculateMD5(file_spec, low, high);
627e0f8f574SDaniel Malea   if (m_remote_platform_sp)
628e0f8f574SDaniel Malea     return m_remote_platform_sp->CalculateMD5(file_spec, low, high);
629e0f8f574SDaniel Malea   return false;
630e0f8f574SDaniel Malea }
631fbb76349SGreg Clayton 
632b9c1b51eSKate Stone const lldb::UnixSignalsSP &PlatformPOSIX::GetRemoteUnixSignals() {
63398d0a4b3SChaoren Lin   if (IsRemote() && m_remote_platform_sp)
63498d0a4b3SChaoren Lin     return m_remote_platform_sp->GetRemoteUnixSignals();
63598d0a4b3SChaoren Lin   return Platform::GetRemoteUnixSignals();
63698d0a4b3SChaoren Lin }
63798d0a4b3SChaoren Lin 
638b9c1b51eSKate Stone FileSpec PlatformPOSIX::GetRemoteWorkingDirectory() {
639fbb76349SGreg Clayton   if (IsRemote() && m_remote_platform_sp)
640fbb76349SGreg Clayton     return m_remote_platform_sp->GetRemoteWorkingDirectory();
641fbb76349SGreg Clayton   else
642fbb76349SGreg Clayton     return Platform::GetRemoteWorkingDirectory();
643fbb76349SGreg Clayton }
644fbb76349SGreg Clayton 
645b9c1b51eSKate Stone bool PlatformPOSIX::SetRemoteWorkingDirectory(const FileSpec &working_dir) {
646fbb76349SGreg Clayton   if (IsRemote() && m_remote_platform_sp)
647d3173f34SChaoren Lin     return m_remote_platform_sp->SetRemoteWorkingDirectory(working_dir);
648fbb76349SGreg Clayton   else
649d3173f34SChaoren Lin     return Platform::SetRemoteWorkingDirectory(working_dir);
650fbb76349SGreg Clayton }
651fbb76349SGreg Clayton 
652b9c1b51eSKate Stone bool PlatformPOSIX::GetRemoteOSVersion() {
6532272c481SPavel Labath   if (m_remote_platform_sp) {
6542272c481SPavel Labath     m_os_version = m_remote_platform_sp->GetOSVersion();
6552272c481SPavel Labath     return !m_os_version.empty();
6562272c481SPavel Labath   }
657015d818bSTodd Fiala   return false;
658015d818bSTodd Fiala }
659015d818bSTodd Fiala 
660b9c1b51eSKate Stone bool PlatformPOSIX::GetRemoteOSBuildString(std::string &s) {
661015d818bSTodd Fiala   if (m_remote_platform_sp)
662015d818bSTodd Fiala     return m_remote_platform_sp->GetRemoteOSBuildString(s);
663015d818bSTodd Fiala   s.clear();
664015d818bSTodd Fiala   return false;
665015d818bSTodd Fiala }
666015d818bSTodd Fiala 
66762930e57SPavel Labath Environment PlatformPOSIX::GetEnvironment() {
668b9c1b51eSKate Stone   if (IsRemote()) {
669e15fcaa2STodd Fiala     if (m_remote_platform_sp)
67062930e57SPavel Labath       return m_remote_platform_sp->GetEnvironment();
67162930e57SPavel Labath     return Environment();
672e15fcaa2STodd Fiala   }
67362930e57SPavel Labath   return Host::GetEnvironment();
674e15fcaa2STodd Fiala }
675e15fcaa2STodd Fiala 
676b9c1b51eSKate Stone bool PlatformPOSIX::GetRemoteOSKernelDescription(std::string &s) {
677015d818bSTodd Fiala   if (m_remote_platform_sp)
678015d818bSTodd Fiala     return m_remote_platform_sp->GetRemoteOSKernelDescription(s);
679015d818bSTodd Fiala   s.clear();
680015d818bSTodd Fiala   return false;
681015d818bSTodd Fiala }
682015d818bSTodd Fiala 
683015d818bSTodd Fiala // Remote Platform subclasses need to override this function
684b9c1b51eSKate Stone ArchSpec PlatformPOSIX::GetRemoteSystemArchitecture() {
685015d818bSTodd Fiala   if (m_remote_platform_sp)
686015d818bSTodd Fiala     return m_remote_platform_sp->GetRemoteSystemArchitecture();
687015d818bSTodd Fiala   return ArchSpec();
688015d818bSTodd Fiala }
689015d818bSTodd Fiala 
690b9c1b51eSKate Stone const char *PlatformPOSIX::GetHostname() {
691015d818bSTodd Fiala   if (IsHost())
692015d818bSTodd Fiala     return Platform::GetHostname();
693015d818bSTodd Fiala 
694015d818bSTodd Fiala   if (m_remote_platform_sp)
695015d818bSTodd Fiala     return m_remote_platform_sp->GetHostname();
696015d818bSTodd Fiala   return NULL;
697015d818bSTodd Fiala }
698015d818bSTodd Fiala 
699b9c1b51eSKate Stone const char *PlatformPOSIX::GetUserName(uint32_t uid) {
700015d818bSTodd Fiala   // Check the cache in Platform in case we have already looked this uid up
701015d818bSTodd Fiala   const char *user_name = Platform::GetUserName(uid);
702015d818bSTodd Fiala   if (user_name)
703015d818bSTodd Fiala     return user_name;
704015d818bSTodd Fiala 
705015d818bSTodd Fiala   if (IsRemote() && m_remote_platform_sp)
706015d818bSTodd Fiala     return m_remote_platform_sp->GetUserName(uid);
707015d818bSTodd Fiala   return NULL;
708015d818bSTodd Fiala }
709015d818bSTodd Fiala 
710b9c1b51eSKate Stone const char *PlatformPOSIX::GetGroupName(uint32_t gid) {
711015d818bSTodd Fiala   const char *group_name = Platform::GetGroupName(gid);
712015d818bSTodd Fiala   if (group_name)
713015d818bSTodd Fiala     return group_name;
714015d818bSTodd Fiala 
715015d818bSTodd Fiala   if (IsRemote() && m_remote_platform_sp)
716015d818bSTodd Fiala     return m_remote_platform_sp->GetGroupName(gid);
717015d818bSTodd Fiala   return NULL;
718015d818bSTodd Fiala }
719015d818bSTodd Fiala 
72097206d57SZachary Turner Status PlatformPOSIX::ConnectRemote(Args &args) {
72197206d57SZachary Turner   Status error;
722b9c1b51eSKate Stone   if (IsHost()) {
723b9c1b51eSKate Stone     error.SetErrorStringWithFormat(
724b9c1b51eSKate Stone         "can't connect to the host platform '%s', always connected",
725b9c1b51eSKate Stone         GetPluginName().GetCString());
726b9c1b51eSKate Stone   } else {
727015d818bSTodd Fiala     if (!m_remote_platform_sp)
728b9c1b51eSKate Stone       m_remote_platform_sp =
729b9c1b51eSKate Stone           Platform::Create(ConstString("remote-gdb-server"), error);
730015d818bSTodd Fiala 
731015d818bSTodd Fiala     if (m_remote_platform_sp && error.Success())
732015d818bSTodd Fiala       error = m_remote_platform_sp->ConnectRemote(args);
733015d818bSTodd Fiala     else
734015d818bSTodd Fiala       error.SetErrorString("failed to create a 'remote-gdb-server' platform");
735015d818bSTodd Fiala 
736015d818bSTodd Fiala     if (error.Fail())
737015d818bSTodd Fiala       m_remote_platform_sp.reset();
738015d818bSTodd Fiala   }
739015d818bSTodd Fiala 
740b9c1b51eSKate Stone   if (error.Success() && m_remote_platform_sp) {
741b9c1b51eSKate Stone     if (m_option_group_platform_rsync.get() &&
742b9c1b51eSKate Stone         m_option_group_platform_ssh.get() &&
743b9c1b51eSKate Stone         m_option_group_platform_caching.get()) {
744b9c1b51eSKate Stone       if (m_option_group_platform_rsync->m_rsync) {
745015d818bSTodd Fiala         SetSupportsRSync(true);
7460a66e2f1SEnrico Granata         SetRSyncOpts(m_option_group_platform_rsync->m_rsync_opts.c_str());
7470a66e2f1SEnrico Granata         SetRSyncPrefix(m_option_group_platform_rsync->m_rsync_prefix.c_str());
748b9c1b51eSKate Stone         SetIgnoresRemoteHostname(
749b9c1b51eSKate Stone             m_option_group_platform_rsync->m_ignores_remote_hostname);
750015d818bSTodd Fiala       }
751b9c1b51eSKate Stone       if (m_option_group_platform_ssh->m_ssh) {
752015d818bSTodd Fiala         SetSupportsSSH(true);
7530a66e2f1SEnrico Granata         SetSSHOpts(m_option_group_platform_ssh->m_ssh_opts.c_str());
754015d818bSTodd Fiala       }
755b9c1b51eSKate Stone       SetLocalCacheDirectory(
756b9c1b51eSKate Stone           m_option_group_platform_caching->m_cache_dir.c_str());
757015d818bSTodd Fiala     }
758015d818bSTodd Fiala   }
759015d818bSTodd Fiala 
760015d818bSTodd Fiala   return error;
761015d818bSTodd Fiala }
762015d818bSTodd Fiala 
76397206d57SZachary Turner Status PlatformPOSIX::DisconnectRemote() {
76497206d57SZachary Turner   Status error;
765015d818bSTodd Fiala 
766b9c1b51eSKate Stone   if (IsHost()) {
767b9c1b51eSKate Stone     error.SetErrorStringWithFormat(
768b9c1b51eSKate Stone         "can't disconnect from the host platform '%s', always connected",
769b9c1b51eSKate Stone         GetPluginName().GetCString());
770b9c1b51eSKate Stone   } else {
771015d818bSTodd Fiala     if (m_remote_platform_sp)
772015d818bSTodd Fiala       error = m_remote_platform_sp->DisconnectRemote();
773015d818bSTodd Fiala     else
774015d818bSTodd Fiala       error.SetErrorString("the platform is not currently connected");
775015d818bSTodd Fiala   }
776015d818bSTodd Fiala   return error;
777015d818bSTodd Fiala }
778015d818bSTodd Fiala 
77997206d57SZachary Turner Status PlatformPOSIX::LaunchProcess(ProcessLaunchInfo &launch_info) {
78097206d57SZachary Turner   Status error;
781348fb385STodd Fiala 
782b9c1b51eSKate Stone   if (IsHost()) {
783348fb385STodd Fiala     error = Platform::LaunchProcess(launch_info);
784b9c1b51eSKate Stone   } else {
785348fb385STodd Fiala     if (m_remote_platform_sp)
786348fb385STodd Fiala       error = m_remote_platform_sp->LaunchProcess(launch_info);
787348fb385STodd Fiala     else
788348fb385STodd Fiala       error.SetErrorString("the platform is not currently connected");
789348fb385STodd Fiala   }
790348fb385STodd Fiala   return error;
791348fb385STodd Fiala }
792348fb385STodd Fiala 
79397206d57SZachary Turner lldb_private::Status PlatformPOSIX::KillProcess(const lldb::pid_t pid) {
79409daa881SOleksiy Vyalov   if (IsHost())
79509daa881SOleksiy Vyalov     return Platform::KillProcess(pid);
79609daa881SOleksiy Vyalov 
79709daa881SOleksiy Vyalov   if (m_remote_platform_sp)
79809daa881SOleksiy Vyalov     return m_remote_platform_sp->KillProcess(pid);
79909daa881SOleksiy Vyalov 
80097206d57SZachary Turner   return Status("the platform is not currently connected");
80109daa881SOleksiy Vyalov }
80209daa881SOleksiy Vyalov 
803b9c1b51eSKate Stone lldb::ProcessSP PlatformPOSIX::Attach(ProcessAttachInfo &attach_info,
804b9c1b51eSKate Stone                                       Debugger &debugger, Target *target,
80597206d57SZachary Turner                                       Status &error) {
806348fb385STodd Fiala   lldb::ProcessSP process_sp;
807348fb385STodd Fiala   Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM));
808348fb385STodd Fiala 
809b9c1b51eSKate Stone   if (IsHost()) {
810b9c1b51eSKate Stone     if (target == NULL) {
811348fb385STodd Fiala       TargetSP new_target_sp;
812348fb385STodd Fiala 
813f9a07e9fSJonas Devlieghere       error = debugger.GetTargetList().CreateTarget(
814f9a07e9fSJonas Devlieghere           debugger, "", "", eLoadDependentsNo, NULL, new_target_sp);
815348fb385STodd Fiala       target = new_target_sp.get();
816348fb385STodd Fiala       if (log)
817348fb385STodd Fiala         log->Printf("PlatformPOSIX::%s created new target", __FUNCTION__);
818b9c1b51eSKate Stone     } else {
819348fb385STodd Fiala       error.Clear();
820348fb385STodd Fiala       if (log)
821b9c1b51eSKate Stone         log->Printf("PlatformPOSIX::%s target already existed, setting target",
822b9c1b51eSKate Stone                     __FUNCTION__);
823348fb385STodd Fiala     }
824348fb385STodd Fiala 
825b9c1b51eSKate Stone     if (target && error.Success()) {
826348fb385STodd Fiala       debugger.GetTargetList().SetSelectedTarget(target);
827b9c1b51eSKate Stone       if (log) {
828348fb385STodd Fiala         ModuleSP exe_module_sp = target->GetExecutableModule();
829b9c1b51eSKate Stone         log->Printf("PlatformPOSIX::%s set selected target to %p %s",
830b9c1b51eSKate Stone                     __FUNCTION__, (void *)target,
831b9c1b51eSKate Stone                     exe_module_sp
832b9c1b51eSKate Stone                         ? exe_module_sp->GetFileSpec().GetPath().c_str()
833b9c1b51eSKate Stone                         : "<null>");
834348fb385STodd Fiala       }
835348fb385STodd Fiala 
836b9c1b51eSKate Stone       process_sp =
837b9c1b51eSKate Stone           target->CreateProcess(attach_info.GetListenerForProcess(debugger),
838b9c1b51eSKate Stone                                 attach_info.GetProcessPluginName(), NULL);
839348fb385STodd Fiala 
840b9c1b51eSKate Stone       if (process_sp) {
841583bbb1dSJim Ingham         ListenerSP listener_sp = attach_info.GetHijackListener();
842b9c1b51eSKate Stone         if (listener_sp == nullptr) {
843b9c1b51eSKate Stone           listener_sp =
844b9c1b51eSKate Stone               Listener::MakeListener("lldb.PlatformPOSIX.attach.hijack");
845348fb385STodd Fiala           attach_info.SetHijackListener(listener_sp);
846926af0cdSOleksiy Vyalov         }
847583bbb1dSJim Ingham         process_sp->HijackProcessEvents(listener_sp);
848348fb385STodd Fiala         error = process_sp->Attach(attach_info);
849348fb385STodd Fiala       }
850348fb385STodd Fiala     }
851b9c1b51eSKate Stone   } else {
852348fb385STodd Fiala     if (m_remote_platform_sp)
853b9c1b51eSKate Stone       process_sp =
854b9c1b51eSKate Stone           m_remote_platform_sp->Attach(attach_info, debugger, target, error);
855348fb385STodd Fiala     else
856348fb385STodd Fiala       error.SetErrorString("the platform is not currently connected");
857348fb385STodd Fiala   }
858348fb385STodd Fiala   return process_sp;
859348fb385STodd Fiala }
860348fb385STodd Fiala 
861015d818bSTodd Fiala lldb::ProcessSP
862b9c1b51eSKate Stone PlatformPOSIX::DebugProcess(ProcessLaunchInfo &launch_info, Debugger &debugger,
863b9c1b51eSKate Stone                             Target *target, // Can be NULL, if NULL create a new
864b9c1b51eSKate Stone                                             // target, else use existing one
86597206d57SZachary Turner                             Status &error) {
866015d818bSTodd Fiala   ProcessSP process_sp;
867015d818bSTodd Fiala 
868b9c1b51eSKate Stone   if (IsHost()) {
869b9c1b51eSKate Stone     // We are going to hand this process off to debugserver which will be in
870245dd2e0SPavel Labath     // charge of setting the exit status.  However, we still need to reap it
871245dd2e0SPavel Labath     // from lldb. So, make sure we use a exit callback which does not set exit
872245dd2e0SPavel Labath     // status.
873245dd2e0SPavel Labath     const bool monitor_signals = false;
874245dd2e0SPavel Labath     launch_info.SetMonitorProcessCallback(
875245dd2e0SPavel Labath         &ProcessLaunchInfo::NoOpMonitorCallback, monitor_signals);
8768012cadbSGreg Clayton     process_sp = Platform::DebugProcess(launch_info, debugger, target, error);
877b9c1b51eSKate Stone   } else {
878015d818bSTodd Fiala     if (m_remote_platform_sp)
879b9c1b51eSKate Stone       process_sp = m_remote_platform_sp->DebugProcess(launch_info, debugger,
880b9c1b51eSKate Stone                                                       target, error);
881015d818bSTodd Fiala     else
882015d818bSTodd Fiala       error.SetErrorString("the platform is not currently connected");
883015d818bSTodd Fiala   }
884015d818bSTodd Fiala   return process_sp;
885015d818bSTodd Fiala }
886015d818bSTodd Fiala 
887b9c1b51eSKate Stone void PlatformPOSIX::CalculateTrapHandlerSymbolNames() {
8882094dbf4SJason Molenda   m_trap_handlers.push_back(ConstString("_sigtramp"));
8892094dbf4SJason Molenda }
8903cb132a0STamas Berghammer 
89197206d57SZachary Turner Status PlatformPOSIX::EvaluateLibdlExpression(
892b9c1b51eSKate Stone     lldb_private::Process *process, const char *expr_cstr,
893d37c9469SPavel Labath     llvm::StringRef expr_prefix, lldb::ValueObjectSP &result_valobj_sp) {
8943cb132a0STamas Berghammer   DynamicLoader *loader = process->GetDynamicLoader();
895b9c1b51eSKate Stone   if (loader) {
89697206d57SZachary Turner     Status error = loader->CanLoadImage();
8973cb132a0STamas Berghammer     if (error.Fail())
8983cb132a0STamas Berghammer       return error;
8993cb132a0STamas Berghammer   }
9003cb132a0STamas Berghammer 
9018d94ba0fSJim Ingham   ThreadSP thread_sp(process->GetThreadList().GetExpressionExecutionThread());
9023cb132a0STamas Berghammer   if (!thread_sp)
90397206d57SZachary Turner     return Status("Selected thread isn't valid");
9043cb132a0STamas Berghammer 
9053cb132a0STamas Berghammer   StackFrameSP frame_sp(thread_sp->GetStackFrameAtIndex(0));
9063cb132a0STamas Berghammer   if (!frame_sp)
90797206d57SZachary Turner     return Status("Frame 0 isn't valid");
9083cb132a0STamas Berghammer 
9093cb132a0STamas Berghammer   ExecutionContext exe_ctx;
9103cb132a0STamas Berghammer   frame_sp->CalculateExecutionContext(exe_ctx);
9113cb132a0STamas Berghammer   EvaluateExpressionOptions expr_options;
9123cb132a0STamas Berghammer   expr_options.SetUnwindOnError(true);
9133cb132a0STamas Berghammer   expr_options.SetIgnoreBreakpoints(true);
9143cb132a0STamas Berghammer   expr_options.SetExecutionPolicy(eExecutionPolicyAlways);
9153cb132a0STamas Berghammer   expr_options.SetLanguage(eLanguageTypeC_plus_plus);
916b9c1b51eSKate Stone   expr_options.SetTrapExceptions(false); // dlopen can't throw exceptions, so
917b9c1b51eSKate Stone                                          // don't do the work to trap them.
91843d35418SPavel Labath   expr_options.SetTimeout(std::chrono::seconds(2));
9193cb132a0STamas Berghammer 
92097206d57SZachary Turner   Status expr_error;
92102980825SJim Ingham   ExpressionResults result =
922b9c1b51eSKate Stone       UserExpression::Evaluate(exe_ctx, expr_options, expr_cstr, expr_prefix,
923b9c1b51eSKate Stone                                result_valobj_sp, expr_error);
92402980825SJim Ingham   if (result != eExpressionCompleted)
92502980825SJim Ingham     return expr_error;
92602980825SJim Ingham 
9273cb132a0STamas Berghammer   if (result_valobj_sp->GetError().Fail())
9283cb132a0STamas Berghammer     return result_valobj_sp->GetError();
92997206d57SZachary Turner   return Status();
9303cb132a0STamas Berghammer }
9313cb132a0STamas Berghammer 
932d10d3795SFrederic Riss std::unique_ptr<UtilityFunction>
9331ecb34f4SJim Ingham PlatformPOSIX::MakeLoadImageUtilityFunction(ExecutionContext &exe_ctx,
934d10d3795SFrederic Riss                                             Status &error) {
93505097246SAdrian Prantl   // Remember to prepend this with the prefix from
93605097246SAdrian Prantl   // GetLibdlFunctionDeclarations. The returned values are all in
93705097246SAdrian Prantl   // __lldb_dlopen_result for consistency. The wrapper returns a void * but
93805097246SAdrian Prantl   // doesn't use it because UtilityFunctions don't work with void returns at
93905097246SAdrian Prantl   // present.
9401ecb34f4SJim Ingham   static const char *dlopen_wrapper_code = R"(
9411ecb34f4SJim Ingham   struct __lldb_dlopen_result {
9421ecb34f4SJim Ingham     void *image_ptr;
9431ecb34f4SJim Ingham     const char *error_str;
9441ecb34f4SJim Ingham   };
9451ecb34f4SJim Ingham 
94603856dd9SJim Ingham   extern void *memcpy(void *, const void *, size_t size);
9470d231f71SJim Ingham   extern size_t strlen(const char *);
9480d231f71SJim Ingham 
9490d231f71SJim Ingham 
9500d231f71SJim Ingham   void * __lldb_dlopen_wrapper (const char *name,
9510d231f71SJim Ingham                                 const char *path_strings,
9520d231f71SJim Ingham                                 char *buffer,
9531ecb34f4SJim Ingham                                 __lldb_dlopen_result *result_ptr)
9541ecb34f4SJim Ingham   {
9550d231f71SJim Ingham     // This is the case where the name is the full path:
95603856dd9SJim Ingham     if (!path_strings) {
9570d231f71SJim Ingham       result_ptr->image_ptr = dlopen(name, 2);
95803856dd9SJim Ingham       if (result_ptr->image_ptr)
9590d231f71SJim Ingham         result_ptr->error_str = nullptr;
9600d231f71SJim Ingham       return nullptr;
9610d231f71SJim Ingham     }
9620d231f71SJim Ingham 
9630d231f71SJim Ingham     // This is the case where we have a list of paths:
9640d231f71SJim Ingham     size_t name_len = strlen(name);
96503856dd9SJim Ingham     while (path_strings && path_strings[0] != '\0') {
9660d231f71SJim Ingham       size_t path_len = strlen(path_strings);
9670d231f71SJim Ingham       memcpy((void *) buffer, (void *) path_strings, path_len);
9680d231f71SJim Ingham       buffer[path_len] = '/';
9690d231f71SJim Ingham       char *target_ptr = buffer+path_len+1;
9700d231f71SJim Ingham       memcpy((void *) target_ptr, (void *) name, name_len + 1);
9710d231f71SJim Ingham       result_ptr->image_ptr = dlopen(buffer, 2);
97203856dd9SJim Ingham       if (result_ptr->image_ptr) {
9730d231f71SJim Ingham         result_ptr->error_str = nullptr;
9740d231f71SJim Ingham         break;
9750d231f71SJim Ingham       }
9761ecb34f4SJim Ingham       result_ptr->error_str = dlerror();
9770d231f71SJim Ingham       path_strings = path_strings + path_len + 1;
9780d231f71SJim Ingham     }
9791ecb34f4SJim Ingham     return nullptr;
9801ecb34f4SJim Ingham   }
9811ecb34f4SJim Ingham   )";
9821ecb34f4SJim Ingham 
9831ecb34f4SJim Ingham   static const char *dlopen_wrapper_name = "__lldb_dlopen_wrapper";
9841ecb34f4SJim Ingham   Process *process = exe_ctx.GetProcessSP().get();
9851ecb34f4SJim Ingham   // Insert the dlopen shim defines into our generic expression:
9861ecb34f4SJim Ingham   std::string expr(GetLibdlFunctionDeclarations(process));
9871ecb34f4SJim Ingham   expr.append(dlopen_wrapper_code);
9881ecb34f4SJim Ingham   Status utility_error;
9891ecb34f4SJim Ingham   DiagnosticManager diagnostics;
9901ecb34f4SJim Ingham 
9911ecb34f4SJim Ingham   std::unique_ptr<UtilityFunction> dlopen_utility_func_up(process
9921ecb34f4SJim Ingham       ->GetTarget().GetUtilityFunctionForLanguage(expr.c_str(),
9931ecb34f4SJim Ingham                                                   eLanguageTypeObjC,
9941ecb34f4SJim Ingham                                                   dlopen_wrapper_name,
9951ecb34f4SJim Ingham                                                   utility_error));
9961ecb34f4SJim Ingham   if (utility_error.Fail()) {
9971ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not make utility"
9981ecb34f4SJim Ingham                                    "function: %s", utility_error.AsCString());
9991ecb34f4SJim Ingham     return nullptr;
10001ecb34f4SJim Ingham   }
10011ecb34f4SJim Ingham   if (!dlopen_utility_func_up->Install(diagnostics, exe_ctx)) {
10021ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not install utility"
10031ecb34f4SJim Ingham                                    "function: %s",
10041ecb34f4SJim Ingham                                    diagnostics.GetString().c_str());
10051ecb34f4SJim Ingham     return nullptr;
10061ecb34f4SJim Ingham   }
10071ecb34f4SJim Ingham 
10081ecb34f4SJim Ingham   Value value;
10091ecb34f4SJim Ingham   ValueList arguments;
10101ecb34f4SJim Ingham   FunctionCaller *do_dlopen_function = nullptr;
10111ecb34f4SJim Ingham 
10121ecb34f4SJim Ingham   // Fetch the clang types we will need:
10131ecb34f4SJim Ingham   ClangASTContext *ast = process->GetTarget().GetScratchClangASTContext();
10141ecb34f4SJim Ingham 
10151ecb34f4SJim Ingham   CompilerType clang_void_pointer_type
10161ecb34f4SJim Ingham       = ast->GetBasicType(eBasicTypeVoid).GetPointerType();
10171ecb34f4SJim Ingham   CompilerType clang_char_pointer_type
10181ecb34f4SJim Ingham         = ast->GetBasicType(eBasicTypeChar).GetPointerType();
10191ecb34f4SJim Ingham 
10200d231f71SJim Ingham   // We are passing four arguments, the basename, the list of places to look,
10210d231f71SJim Ingham   // a buffer big enough for all the path + name combos, and
10220d231f71SJim Ingham   // a pointer to the storage we've made for the result:
10231ecb34f4SJim Ingham   value.SetValueType(Value::eValueTypeScalar);
10241ecb34f4SJim Ingham   value.SetCompilerType(clang_void_pointer_type);
10251ecb34f4SJim Ingham   arguments.PushValue(value);
10261ecb34f4SJim Ingham   value.SetCompilerType(clang_char_pointer_type);
10271ecb34f4SJim Ingham   arguments.PushValue(value);
10280d231f71SJim Ingham   arguments.PushValue(value);
10290d231f71SJim Ingham   arguments.PushValue(value);
10301ecb34f4SJim Ingham 
10311ecb34f4SJim Ingham   do_dlopen_function = dlopen_utility_func_up->MakeFunctionCaller(
10321ecb34f4SJim Ingham       clang_void_pointer_type, arguments, exe_ctx.GetThreadSP(), utility_error);
10331ecb34f4SJim Ingham   if (utility_error.Fail()) {
10341ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not make function"
10351ecb34f4SJim Ingham                                    "caller: %s", utility_error.AsCString());
10361ecb34f4SJim Ingham     return nullptr;
10371ecb34f4SJim Ingham   }
10381ecb34f4SJim Ingham 
10391ecb34f4SJim Ingham   do_dlopen_function = dlopen_utility_func_up->GetFunctionCaller();
10401ecb34f4SJim Ingham   if (!do_dlopen_function) {
10411ecb34f4SJim Ingham     error.SetErrorString("dlopen error: could not get function caller.");
10421ecb34f4SJim Ingham     return nullptr;
10431ecb34f4SJim Ingham   }
10441ecb34f4SJim Ingham 
10451ecb34f4SJim Ingham   // We made a good utility function, so cache it in the process:
1046d10d3795SFrederic Riss   return dlopen_utility_func_up;
10471ecb34f4SJim Ingham }
10481ecb34f4SJim Ingham 
1049b9c1b51eSKate Stone uint32_t PlatformPOSIX::DoLoadImage(lldb_private::Process *process,
10504fbd67acSTamas Berghammer                                     const lldb_private::FileSpec &remote_file,
10510d231f71SJim Ingham                                     const std::vector<std::string> *paths,
10520d231f71SJim Ingham                                     lldb_private::Status &error,
10530d231f71SJim Ingham                                     lldb_private::FileSpec *loaded_image) {
10540d231f71SJim Ingham   if (loaded_image)
10550d231f71SJim Ingham     loaded_image->Clear();
10560d231f71SJim Ingham 
10571ecb34f4SJim Ingham   std::string path;
10581ecb34f4SJim Ingham   path = remote_file.GetPath();
10593cb132a0STamas Berghammer 
10601ecb34f4SJim Ingham   ThreadSP thread_sp = process->GetThreadList().GetExpressionExecutionThread();
10611ecb34f4SJim Ingham   if (!thread_sp) {
10621ecb34f4SJim Ingham     error.SetErrorString("dlopen error: no thread available to call dlopen.");
10633cb132a0STamas Berghammer     return LLDB_INVALID_IMAGE_TOKEN;
10643cb132a0STamas Berghammer   }
10653cb132a0STamas Berghammer 
10661ecb34f4SJim Ingham   DiagnosticManager diagnostics;
10673cb132a0STamas Berghammer 
10681ecb34f4SJim Ingham   ExecutionContext exe_ctx;
10691ecb34f4SJim Ingham   thread_sp->CalculateExecutionContext(exe_ctx);
10701ecb34f4SJim Ingham 
10711ecb34f4SJim Ingham   Status utility_error;
1072d10d3795SFrederic Riss   UtilityFunction *dlopen_utility_func;
10731ecb34f4SJim Ingham   ValueList arguments;
10741ecb34f4SJim Ingham   FunctionCaller *do_dlopen_function = nullptr;
10751ecb34f4SJim Ingham 
1076d10d3795SFrederic Riss   // The UtilityFunction is held in the Process.  Platforms don't track the
1077d10d3795SFrederic Riss   // lifespan of the Targets that use them, we can't put this in the Platform.
1078d10d3795SFrederic Riss   dlopen_utility_func = process->GetLoadImageUtilityFunction(
1079d10d3795SFrederic Riss       this, [&]() -> std::unique_ptr<UtilityFunction> {
1080d10d3795SFrederic Riss         return MakeLoadImageUtilityFunction(exe_ctx, error);
1081d10d3795SFrederic Riss       });
10821ecb34f4SJim Ingham   // If we couldn't make it, the error will be in error, so we can exit here.
10831ecb34f4SJim Ingham   if (!dlopen_utility_func)
10841ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
10851ecb34f4SJim Ingham 
10861ecb34f4SJim Ingham   do_dlopen_function = dlopen_utility_func->GetFunctionCaller();
10871ecb34f4SJim Ingham   if (!do_dlopen_function) {
10881ecb34f4SJim Ingham     error.SetErrorString("dlopen error: could not get function caller.");
10891ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
10901ecb34f4SJim Ingham   }
10911ecb34f4SJim Ingham   arguments = do_dlopen_function->GetArgumentValues();
10921ecb34f4SJim Ingham 
109305097246SAdrian Prantl   // Now insert the path we are searching for and the result structure into the
109405097246SAdrian Prantl   // target.
10951ecb34f4SJim Ingham   uint32_t permissions = ePermissionsReadable|ePermissionsWritable;
10961ecb34f4SJim Ingham   size_t path_len = path.size() + 1;
10971ecb34f4SJim Ingham   lldb::addr_t path_addr = process->AllocateMemory(path_len,
10981ecb34f4SJim Ingham                                                    permissions,
10991ecb34f4SJim Ingham                                                    utility_error);
11001ecb34f4SJim Ingham   if (path_addr == LLDB_INVALID_ADDRESS) {
11011ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not allocate memory"
11021ecb34f4SJim Ingham                                     "for path: %s", utility_error.AsCString());
11031ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
11041ecb34f4SJim Ingham   }
11051ecb34f4SJim Ingham 
11061ecb34f4SJim Ingham   // Make sure we deallocate the input string memory:
11071ecb34f4SJim Ingham   CleanUp path_cleanup([process, path_addr] {
11081ecb34f4SJim Ingham       process->DeallocateMemory(path_addr);
11091ecb34f4SJim Ingham   });
11101ecb34f4SJim Ingham 
11111ecb34f4SJim Ingham   process->WriteMemory(path_addr, path.c_str(), path_len, utility_error);
11121ecb34f4SJim Ingham   if (utility_error.Fail()) {
11131ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not write path string:"
11141ecb34f4SJim Ingham                                     " %s", utility_error.AsCString());
11151ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
11161ecb34f4SJim Ingham   }
11171ecb34f4SJim Ingham 
111805097246SAdrian Prantl   // Make space for our return structure.  It is two pointers big: the token
111905097246SAdrian Prantl   // and the error string.
11201ecb34f4SJim Ingham   const uint32_t addr_size = process->GetAddressByteSize();
11211ecb34f4SJim Ingham   lldb::addr_t return_addr = process->CallocateMemory(2*addr_size,
11221ecb34f4SJim Ingham                                                       permissions,
11231ecb34f4SJim Ingham                                                       utility_error);
11241ecb34f4SJim Ingham   if (utility_error.Fail()) {
11251ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not allocate memory"
11261ecb34f4SJim Ingham                                     "for path: %s", utility_error.AsCString());
11271ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
11281ecb34f4SJim Ingham   }
11291ecb34f4SJim Ingham 
11301ecb34f4SJim Ingham   // Make sure we deallocate the result structure memory
11311ecb34f4SJim Ingham   CleanUp return_cleanup([process, return_addr] {
11321ecb34f4SJim Ingham       process->DeallocateMemory(return_addr);
11331ecb34f4SJim Ingham   });
11341ecb34f4SJim Ingham 
11350d231f71SJim Ingham   // This will be the address of the storage for paths, if we are using them,
11360d231f71SJim Ingham   // or nullptr to signal we aren't.
11370d231f71SJim Ingham   lldb::addr_t path_array_addr = 0x0;
11380d231f71SJim Ingham   llvm::Optional<CleanUp> path_array_cleanup;
11390d231f71SJim Ingham 
11400d231f71SJim Ingham   // This is the address to a buffer large enough to hold the largest path
11410d231f71SJim Ingham   // conjoined with the library name we're passing in.  This is a convenience
11420d231f71SJim Ingham   // to avoid having to call malloc in the dlopen function.
11430d231f71SJim Ingham   lldb::addr_t buffer_addr = 0x0;
11440d231f71SJim Ingham   llvm::Optional<CleanUp> buffer_cleanup;
11450d231f71SJim Ingham 
11461ecb34f4SJim Ingham   // Set the values into our args and write them to the target:
11470d231f71SJim Ingham   if (paths != nullptr) {
11480d231f71SJim Ingham     // First insert the paths into the target.  This is expected to be a
11490d231f71SJim Ingham     // continuous buffer with the strings laid out null terminated and
11500d231f71SJim Ingham     // end to end with an empty string terminating the buffer.
11510d231f71SJim Ingham     // We also compute the buffer's required size as we go.
11520d231f71SJim Ingham     size_t buffer_size = 0;
11530d231f71SJim Ingham     std::string path_array;
11540d231f71SJim Ingham     for (auto path : *paths) {
115540fa4a1aSJim Ingham       // Don't insert empty paths, they will make us abort the path
115640fa4a1aSJim Ingham       // search prematurely.
115740fa4a1aSJim Ingham       if (path.empty())
115840fa4a1aSJim Ingham         continue;
11590d231f71SJim Ingham       size_t path_size = path.size();
11600d231f71SJim Ingham       path_array.append(path);
11610d231f71SJim Ingham       path_array.push_back('\0');
11620d231f71SJim Ingham       if (path_size > buffer_size)
11630d231f71SJim Ingham         buffer_size = path_size;
11640d231f71SJim Ingham     }
11650d231f71SJim Ingham     path_array.push_back('\0');
11660d231f71SJim Ingham 
11670d231f71SJim Ingham     path_array_addr = process->AllocateMemory(path_array.size(),
11680d231f71SJim Ingham                                               permissions,
11690d231f71SJim Ingham                                               utility_error);
11700d231f71SJim Ingham     if (path_array_addr == LLDB_INVALID_ADDRESS) {
11710d231f71SJim Ingham       error.SetErrorStringWithFormat("dlopen error: could not allocate memory"
11720d231f71SJim Ingham                                       "for path array: %s",
11730d231f71SJim Ingham                                       utility_error.AsCString());
11740d231f71SJim Ingham       return LLDB_INVALID_IMAGE_TOKEN;
11750d231f71SJim Ingham     }
11760d231f71SJim Ingham 
11770d231f71SJim Ingham     // Make sure we deallocate the paths array.
11780d231f71SJim Ingham     path_array_cleanup.emplace([process, path_array_addr] {
11790d231f71SJim Ingham         process->DeallocateMemory(path_array_addr);
11800d231f71SJim Ingham     });
11810d231f71SJim Ingham 
11820d231f71SJim Ingham     process->WriteMemory(path_array_addr, path_array.data(),
11830d231f71SJim Ingham                          path_array.size(), utility_error);
11840d231f71SJim Ingham 
11850d231f71SJim Ingham     if (utility_error.Fail()) {
11860d231f71SJim Ingham       error.SetErrorStringWithFormat("dlopen error: could not write path array:"
11870d231f71SJim Ingham                                      " %s", utility_error.AsCString());
11880d231f71SJim Ingham       return LLDB_INVALID_IMAGE_TOKEN;
11890d231f71SJim Ingham     }
11900d231f71SJim Ingham     // Now make spaces in the target for the buffer.  We need to add one for
11910d231f71SJim Ingham     // the '/' that the utility function will insert and one for the '\0':
11920d231f71SJim Ingham     buffer_size += path.size() + 2;
11930d231f71SJim Ingham 
11940d231f71SJim Ingham     buffer_addr = process->AllocateMemory(buffer_size,
11950d231f71SJim Ingham                                           permissions,
11960d231f71SJim Ingham                                           utility_error);
11970d231f71SJim Ingham     if (buffer_addr == LLDB_INVALID_ADDRESS) {
11980d231f71SJim Ingham       error.SetErrorStringWithFormat("dlopen error: could not allocate memory"
11990d231f71SJim Ingham                                       "for buffer: %s",
12000d231f71SJim Ingham                                       utility_error.AsCString());
12010d231f71SJim Ingham       return LLDB_INVALID_IMAGE_TOKEN;
12020d231f71SJim Ingham     }
12030d231f71SJim Ingham 
12040d231f71SJim Ingham     // Make sure we deallocate the buffer memory:
12050d231f71SJim Ingham     buffer_cleanup.emplace([process, buffer_addr] {
12060d231f71SJim Ingham         process->DeallocateMemory(buffer_addr);
12070d231f71SJim Ingham     });
12080d231f71SJim Ingham   }
12090d231f71SJim Ingham 
12101ecb34f4SJim Ingham   arguments.GetValueAtIndex(0)->GetScalar() = path_addr;
12110d231f71SJim Ingham   arguments.GetValueAtIndex(1)->GetScalar() = path_array_addr;
12120d231f71SJim Ingham   arguments.GetValueAtIndex(2)->GetScalar() = buffer_addr;
12130d231f71SJim Ingham   arguments.GetValueAtIndex(3)->GetScalar() = return_addr;
12141ecb34f4SJim Ingham 
12151ecb34f4SJim Ingham   lldb::addr_t func_args_addr = LLDB_INVALID_ADDRESS;
12161ecb34f4SJim Ingham 
12171ecb34f4SJim Ingham   diagnostics.Clear();
12181ecb34f4SJim Ingham   if (!do_dlopen_function->WriteFunctionArguments(exe_ctx,
12191ecb34f4SJim Ingham                                                  func_args_addr,
12201ecb34f4SJim Ingham                                                  arguments,
12211ecb34f4SJim Ingham                                                  diagnostics)) {
12221ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not write function "
12231ecb34f4SJim Ingham                                    "arguments: %s",
12241ecb34f4SJim Ingham                                    diagnostics.GetString().c_str());
12251ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
12261ecb34f4SJim Ingham   }
12271ecb34f4SJim Ingham 
12281ecb34f4SJim Ingham   // Make sure we clean up the args structure.  We can't reuse it because the
12291ecb34f4SJim Ingham   // Platform lives longer than the process and the Platforms don't get a
12301ecb34f4SJim Ingham   // signal to clean up cached data when a process goes away.
12311ecb34f4SJim Ingham   CleanUp args_cleanup([do_dlopen_function, &exe_ctx, func_args_addr] {
12321ecb34f4SJim Ingham     do_dlopen_function->DeallocateFunctionResults(exe_ctx, func_args_addr);
12331ecb34f4SJim Ingham   });
12341ecb34f4SJim Ingham 
12351ecb34f4SJim Ingham   // Now run the caller:
12361ecb34f4SJim Ingham   EvaluateExpressionOptions options;
12371ecb34f4SJim Ingham   options.SetExecutionPolicy(eExecutionPolicyAlways);
12381ecb34f4SJim Ingham   options.SetLanguage(eLanguageTypeC_plus_plus);
12391ecb34f4SJim Ingham   options.SetIgnoreBreakpoints(true);
12401ecb34f4SJim Ingham   options.SetUnwindOnError(true);
12411ecb34f4SJim Ingham   options.SetTrapExceptions(false); // dlopen can't throw exceptions, so
12421ecb34f4SJim Ingham                                     // don't do the work to trap them.
12431ecb34f4SJim Ingham   options.SetTimeout(std::chrono::seconds(2));
1244c01783a8SRaphael Isemann   options.SetIsForUtilityExpr(true);
12451ecb34f4SJim Ingham 
12461ecb34f4SJim Ingham   Value return_value;
12471ecb34f4SJim Ingham   // Fetch the clang types we will need:
12481ecb34f4SJim Ingham   ClangASTContext *ast = process->GetTarget().GetScratchClangASTContext();
12491ecb34f4SJim Ingham 
12501ecb34f4SJim Ingham   CompilerType clang_void_pointer_type
12511ecb34f4SJim Ingham       = ast->GetBasicType(eBasicTypeVoid).GetPointerType();
12521ecb34f4SJim Ingham 
12531ecb34f4SJim Ingham   return_value.SetCompilerType(clang_void_pointer_type);
12541ecb34f4SJim Ingham 
12551ecb34f4SJim Ingham   ExpressionResults results = do_dlopen_function->ExecuteFunction(
12561ecb34f4SJim Ingham       exe_ctx, &func_args_addr, options, diagnostics, return_value);
12571ecb34f4SJim Ingham   if (results != eExpressionCompleted) {
12580d231f71SJim Ingham     error.SetErrorStringWithFormat("dlopen error: failed executing "
12591ecb34f4SJim Ingham                                    "dlopen wrapper function: %s",
12601ecb34f4SJim Ingham                                    diagnostics.GetString().c_str());
12611ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
12621ecb34f4SJim Ingham   }
12631ecb34f4SJim Ingham 
12641ecb34f4SJim Ingham   // Read the dlopen token from the return area:
12651ecb34f4SJim Ingham   lldb::addr_t token = process->ReadPointerFromMemory(return_addr,
12661ecb34f4SJim Ingham                                                       utility_error);
12671ecb34f4SJim Ingham   if (utility_error.Fail()) {
12681ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not read the return "
12691ecb34f4SJim Ingham                                     "struct: %s", utility_error.AsCString());
12701ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
12711ecb34f4SJim Ingham   }
12721ecb34f4SJim Ingham 
12731ecb34f4SJim Ingham   // The dlopen succeeded!
12740d231f71SJim Ingham   if (token != 0x0) {
12750d231f71SJim Ingham     if (loaded_image && buffer_addr != 0x0)
12760d231f71SJim Ingham     {
12770d231f71SJim Ingham       // Capture the image which was loaded.  We leave it in the buffer on
12780d231f71SJim Ingham       // exit from the dlopen function, so we can just read it from there:
12790d231f71SJim Ingham       std::string name_string;
12800d231f71SJim Ingham       process->ReadCStringFromMemory(buffer_addr, name_string, utility_error);
12810d231f71SJim Ingham       if (utility_error.Success())
12828f3be7a3SJonas Devlieghere         loaded_image->SetFile(name_string, llvm::sys::path::Style::posix);
12830d231f71SJim Ingham     }
12841ecb34f4SJim Ingham     return process->AddImageToken(token);
12850d231f71SJim Ingham   }
12861ecb34f4SJim Ingham 
12871ecb34f4SJim Ingham   // We got an error, lets read in the error string:
12881ecb34f4SJim Ingham   std::string dlopen_error_str;
12891ecb34f4SJim Ingham   lldb::addr_t error_addr
12901ecb34f4SJim Ingham     = process->ReadPointerFromMemory(return_addr + addr_size, utility_error);
12911ecb34f4SJim Ingham   if (utility_error.Fail()) {
12921ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not read error string: "
12931ecb34f4SJim Ingham                                     "%s", utility_error.AsCString());
12941ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
12951ecb34f4SJim Ingham   }
12961ecb34f4SJim Ingham 
12971ecb34f4SJim Ingham   size_t num_chars = process->ReadCStringFromMemory(error_addr + addr_size,
12981ecb34f4SJim Ingham                                                     dlopen_error_str,
12991ecb34f4SJim Ingham                                                     utility_error);
13001ecb34f4SJim Ingham   if (utility_error.Success() && num_chars > 0)
1301b9c1b51eSKate Stone     error.SetErrorStringWithFormat("dlopen error: %s",
13021ecb34f4SJim Ingham                                    dlopen_error_str.c_str());
13033cb132a0STamas Berghammer   else
13043cb132a0STamas Berghammer     error.SetErrorStringWithFormat("dlopen failed for unknown reasons.");
13051ecb34f4SJim Ingham 
13063cb132a0STamas Berghammer   return LLDB_INVALID_IMAGE_TOKEN;
13073cb132a0STamas Berghammer }
13083cb132a0STamas Berghammer 
130997206d57SZachary Turner Status PlatformPOSIX::UnloadImage(lldb_private::Process *process,
1310b9c1b51eSKate Stone                                   uint32_t image_token) {
13113cb132a0STamas Berghammer   const addr_t image_addr = process->GetImagePtrFromToken(image_token);
13123cb132a0STamas Berghammer   if (image_addr == LLDB_INVALID_ADDRESS)
131397206d57SZachary Turner     return Status("Invalid image token");
13143cb132a0STamas Berghammer 
13153cb132a0STamas Berghammer   StreamString expr;
13163cb132a0STamas Berghammer   expr.Printf("dlclose((void *)0x%" PRIx64 ")", image_addr);
1317f7a5851dSNitesh Jain   llvm::StringRef prefix = GetLibdlFunctionDeclarations(process);
13183cb132a0STamas Berghammer   lldb::ValueObjectSP result_valobj_sp;
131997206d57SZachary Turner   Status error = EvaluateLibdlExpression(process, expr.GetData(), prefix,
1320b9c1b51eSKate Stone                                          result_valobj_sp);
13213cb132a0STamas Berghammer   if (error.Fail())
13223cb132a0STamas Berghammer     return error;
13233cb132a0STamas Berghammer 
13243cb132a0STamas Berghammer   if (result_valobj_sp->GetError().Fail())
13253cb132a0STamas Berghammer     return result_valobj_sp->GetError();
13263cb132a0STamas Berghammer 
13273cb132a0STamas Berghammer   Scalar scalar;
1328b9c1b51eSKate Stone   if (result_valobj_sp->ResolveValue(scalar)) {
13293cb132a0STamas Berghammer     if (scalar.UInt(1))
133097206d57SZachary Turner       return Status("expression failed: \"%s\"", expr.GetData());
13313cb132a0STamas Berghammer     process->ResetImageToken(image_token);
13323cb132a0STamas Berghammer   }
133397206d57SZachary Turner   return Status();
13343cb132a0STamas Berghammer }
1335fcdde63fSTamas Berghammer 
13363165945aSZachary Turner lldb::ProcessSP PlatformPOSIX::ConnectProcess(llvm::StringRef connect_url,
13373165945aSZachary Turner                                               llvm::StringRef plugin_name,
1338ccd6cffbSTamas Berghammer                                               lldb_private::Debugger &debugger,
1339ccd6cffbSTamas Berghammer                                               lldb_private::Target *target,
134097206d57SZachary Turner                                               lldb_private::Status &error) {
1341ccd6cffbSTamas Berghammer   if (m_remote_platform_sp)
1342b9c1b51eSKate Stone     return m_remote_platform_sp->ConnectProcess(connect_url, plugin_name,
1343b9c1b51eSKate Stone                                                 debugger, target, error);
1344ccd6cffbSTamas Berghammer 
1345b9c1b51eSKate Stone   return Platform::ConnectProcess(connect_url, plugin_name, debugger, target,
1346b9c1b51eSKate Stone                                   error);
1347ccd6cffbSTamas Berghammer }
1348ccd6cffbSTamas Berghammer 
1349f7a5851dSNitesh Jain llvm::StringRef
1350f7a5851dSNitesh Jain PlatformPOSIX::GetLibdlFunctionDeclarations(lldb_private::Process *process) {
1351fcdde63fSTamas Berghammer   return R"(
1352fcdde63fSTamas Berghammer               extern "C" void* dlopen(const char*, int);
1353fcdde63fSTamas Berghammer               extern "C" void* dlsym(void*, const char*);
1354fcdde63fSTamas Berghammer               extern "C" int   dlclose(void*);
1355fcdde63fSTamas Berghammer               extern "C" char* dlerror(void);
1356fcdde63fSTamas Berghammer              )";
1357fcdde63fSTamas Berghammer }
1358ccd6cffbSTamas Berghammer 
1359b9c1b51eSKate Stone size_t PlatformPOSIX::ConnectToWaitingProcesses(Debugger &debugger,
136097206d57SZachary Turner                                                 Status &error) {
1361ccd6cffbSTamas Berghammer   if (m_remote_platform_sp)
1362ccd6cffbSTamas Berghammer     return m_remote_platform_sp->ConnectToWaitingProcesses(debugger, error);
1363ccd6cffbSTamas Berghammer   return Platform::ConnectToWaitingProcesses(debugger, error);
1364ccd6cffbSTamas Berghammer }
1365ec9bc8ccSPavel Labath 
1366ec9bc8ccSPavel Labath ConstString PlatformPOSIX::GetFullNameForDylib(ConstString basename) {
1367ec9bc8ccSPavel Labath   if (basename.IsEmpty())
1368ec9bc8ccSPavel Labath     return basename;
1369ec9bc8ccSPavel Labath 
1370ec9bc8ccSPavel Labath   StreamString stream;
1371ec9bc8ccSPavel Labath   stream.Printf("lib%s.so", basename.GetCString());
1372ec9bc8ccSPavel Labath   return ConstString(stream.GetString());
1373ec9bc8ccSPavel Labath }
1374