1e0f8f574SDaniel Malea //===-- PlatformPOSIX.cpp ---------------------------------------*- C++ -*-===//
2e0f8f574SDaniel Malea //
3e0f8f574SDaniel Malea //                     The LLVM Compiler Infrastructure
4e0f8f574SDaniel Malea //
5e0f8f574SDaniel Malea // This file is distributed under the University of Illinois Open Source
6e0f8f574SDaniel Malea // License. See LICENSE.TXT for details.
7e0f8f574SDaniel Malea //
8e0f8f574SDaniel Malea //===----------------------------------------------------------------------===//
9e0f8f574SDaniel Malea 
10e0f8f574SDaniel Malea #include "PlatformPOSIX.h"
11e0f8f574SDaniel Malea 
12e0f8f574SDaniel Malea // C Includes
13e0f8f574SDaniel Malea // C++ Includes
14e0f8f574SDaniel Malea // Other libraries and framework includes
15e0f8f574SDaniel Malea // Project includes
16e0f8f574SDaniel Malea 
17348fb385STodd Fiala #include "lldb/Core/Debugger.h"
18348fb385STodd Fiala #include "lldb/Core/Module.h"
19fc89bbccSPavel Labath #include "lldb/Core/ModuleSpec.h"
203cb132a0STamas Berghammer #include "lldb/Core/ValueObject.h"
211ecb34f4SJim Ingham #include "lldb/Expression/DiagnosticManager.h"
221ecb34f4SJim Ingham #include "lldb/Expression/FunctionCaller.h"
233cb132a0STamas Berghammer #include "lldb/Expression/UserExpression.h"
241ecb34f4SJim Ingham #include "lldb/Expression/UtilityFunction.h"
25e0f8f574SDaniel Malea #include "lldb/Host/File.h"
26c00cf4a0SZachary Turner #include "lldb/Host/FileCache.h"
27c00cf4a0SZachary Turner #include "lldb/Host/FileSystem.h"
28e0f8f574SDaniel Malea #include "lldb/Host/Host.h"
29fc89bbccSPavel Labath #include "lldb/Host/HostInfo.h"
301ecb34f4SJim Ingham #include "lldb/Symbol/ClangASTContext.h"
313cb132a0STamas Berghammer #include "lldb/Target/DynamicLoader.h"
323cb132a0STamas Berghammer #include "lldb/Target/ExecutionContext.h"
33a78bd7ffSZachary Turner #include "lldb/Target/Process.h"
34015d818bSTodd Fiala #include "lldb/Target/ProcessLaunchInfo.h"
353cb132a0STamas Berghammer #include "lldb/Target/Thread.h"
361ecb34f4SJim Ingham #include "lldb/Utility/CleanUp.h"
37666cc0b2SZachary Turner #include "lldb/Utility/DataBufferHeap.h"
385713a05bSZachary Turner #include "lldb/Utility/FileSpec.h"
396f9e6901SZachary Turner #include "lldb/Utility/Log.h"
40bf9a7730SZachary Turner #include "lldb/Utility/StreamString.h"
41e0f8f574SDaniel Malea 
42e0f8f574SDaniel Malea using namespace lldb;
43e0f8f574SDaniel Malea using namespace lldb_private;
44e0f8f574SDaniel Malea 
45e0f8f574SDaniel Malea //------------------------------------------------------------------
46e0f8f574SDaniel Malea /// Default Constructor
47e0f8f574SDaniel Malea //------------------------------------------------------------------
48b9c1b51eSKate Stone PlatformPOSIX::PlatformPOSIX(bool is_host)
49b9c1b51eSKate Stone     : Platform(is_host), // This is the local host platform
500a66e2f1SEnrico Granata       m_option_group_platform_rsync(new OptionGroupPlatformRSync()),
510a66e2f1SEnrico Granata       m_option_group_platform_ssh(new OptionGroupPlatformSSH()),
520a66e2f1SEnrico Granata       m_option_group_platform_caching(new OptionGroupPlatformCaching()),
53b9c1b51eSKate Stone       m_remote_platform_sp() {}
54e0f8f574SDaniel Malea 
55e0f8f574SDaniel Malea //------------------------------------------------------------------
56e0f8f574SDaniel Malea /// Destructor.
57e0f8f574SDaniel Malea ///
58e0f8f574SDaniel Malea /// The destructor is virtual since this class is designed to be
59e0f8f574SDaniel Malea /// inherited from by the plug-in instance.
60e0f8f574SDaniel Malea //------------------------------------------------------------------
61b9c1b51eSKate Stone PlatformPOSIX::~PlatformPOSIX() {}
62e0f8f574SDaniel Malea 
63b9c1b51eSKate Stone bool PlatformPOSIX::GetModuleSpec(const FileSpec &module_file_spec,
6463acdfdeSOleksiy Vyalov                                   const ArchSpec &arch,
65b9c1b51eSKate Stone                                   ModuleSpec &module_spec) {
6663acdfdeSOleksiy Vyalov   if (m_remote_platform_sp)
67b9c1b51eSKate Stone     return m_remote_platform_sp->GetModuleSpec(module_file_spec, arch,
68b9c1b51eSKate Stone                                                module_spec);
6963acdfdeSOleksiy Vyalov 
7063acdfdeSOleksiy Vyalov   return Platform::GetModuleSpec(module_file_spec, arch, module_spec);
7163acdfdeSOleksiy Vyalov }
7263acdfdeSOleksiy Vyalov 
73b9c1b51eSKate Stone lldb_private::OptionGroupOptions *PlatformPOSIX::GetConnectionOptions(
74b9c1b51eSKate Stone     lldb_private::CommandInterpreter &interpreter) {
750a66e2f1SEnrico Granata   auto iter = m_options.find(&interpreter), end = m_options.end();
76b9c1b51eSKate Stone   if (iter == end) {
77b9c1b51eSKate Stone     std::unique_ptr<lldb_private::OptionGroupOptions> options(
78b9c1b51eSKate Stone         new OptionGroupOptions());
790a66e2f1SEnrico Granata     options->Append(m_option_group_platform_rsync.get());
800a66e2f1SEnrico Granata     options->Append(m_option_group_platform_ssh.get());
810a66e2f1SEnrico Granata     options->Append(m_option_group_platform_caching.get());
820a66e2f1SEnrico Granata     m_options[&interpreter] = std::move(options);
83e0f8f574SDaniel Malea   }
840a66e2f1SEnrico Granata 
850a66e2f1SEnrico Granata   return m_options.at(&interpreter).get();
86e0f8f574SDaniel Malea }
87e0f8f574SDaniel Malea 
88b9c1b51eSKate Stone bool PlatformPOSIX::IsConnected() const {
89015d818bSTodd Fiala   if (IsHost())
90015d818bSTodd Fiala     return true;
91015d818bSTodd Fiala   else if (m_remote_platform_sp)
92015d818bSTodd Fiala     return m_remote_platform_sp->IsConnected();
93015d818bSTodd Fiala   return false;
94015d818bSTodd Fiala }
95015d818bSTodd Fiala 
9697206d57SZachary Turner lldb_private::Status PlatformPOSIX::RunShellCommand(
97b9c1b51eSKate Stone     const char *command, // Shouldn't be NULL
98b9c1b51eSKate Stone     const FileSpec &
99b9c1b51eSKate Stone         working_dir, // Pass empty FileSpec to use the current working directory
100e0f8f574SDaniel Malea     int *status_ptr, // Pass NULL if you don't want the process exit status
101b9c1b51eSKate Stone     int *signo_ptr,  // Pass NULL if you don't want the signal that caused the
102b9c1b51eSKate Stone                      // process to exit
103b9c1b51eSKate Stone     std::string
104b9c1b51eSKate Stone         *command_output, // Pass NULL if you don't want the command output
10519dd1a0eSPavel Labath     const Timeout<std::micro> &timeout) {
106e0f8f574SDaniel Malea   if (IsHost())
107b9c1b51eSKate Stone     return Host::RunShellCommand(command, working_dir, status_ptr, signo_ptr,
10819dd1a0eSPavel Labath                                  command_output, timeout);
109b9c1b51eSKate Stone   else {
110e0f8f574SDaniel Malea     if (m_remote_platform_sp)
11119dd1a0eSPavel Labath       return m_remote_platform_sp->RunShellCommand(
11219dd1a0eSPavel Labath           command, working_dir, status_ptr, signo_ptr, command_output, timeout);
113e0f8f574SDaniel Malea     else
11497206d57SZachary Turner       return Status("unable to run a remote command without a platform");
115e0f8f574SDaniel Malea   }
116e0f8f574SDaniel Malea }
117e0f8f574SDaniel Malea 
11897206d57SZachary Turner Status
11997206d57SZachary Turner PlatformPOSIX::ResolveExecutable(const ModuleSpec &module_spec,
120fc89bbccSPavel Labath                                  lldb::ModuleSP &exe_module_sp,
121fc89bbccSPavel Labath                                  const FileSpecList *module_search_paths_ptr) {
12297206d57SZachary Turner   Status error;
123fc89bbccSPavel Labath   // Nothing special to do here, just use the actual file and architecture
124fc89bbccSPavel Labath 
125fc89bbccSPavel Labath   char exe_path[PATH_MAX];
126fc89bbccSPavel Labath   ModuleSpec resolved_module_spec(module_spec);
127fc89bbccSPavel Labath 
128fc89bbccSPavel Labath   if (IsHost()) {
12905097246SAdrian Prantl     // If we have "ls" as the exe_file, resolve the executable location based
13005097246SAdrian Prantl     // on the current path variables
131fc89bbccSPavel Labath     if (!resolved_module_spec.GetFileSpec().Exists()) {
132fc89bbccSPavel Labath       resolved_module_spec.GetFileSpec().GetPath(exe_path, sizeof(exe_path));
133937348cdSJonas Devlieghere       resolved_module_spec.GetFileSpec().SetFile(exe_path, true,
134937348cdSJonas Devlieghere                                                  FileSpec::Style::native);
135fc89bbccSPavel Labath     }
136fc89bbccSPavel Labath 
137fc89bbccSPavel Labath     if (!resolved_module_spec.GetFileSpec().Exists())
138*2c22c800SJonas Devlieghere       FileSystem::Instance().ResolveExecutableLocation(
139*2c22c800SJonas Devlieghere           resolved_module_spec.GetFileSpec());
140fc89bbccSPavel Labath 
141fc89bbccSPavel Labath     // Resolve any executable within a bundle on MacOSX
142fc89bbccSPavel Labath     Host::ResolveExecutableInBundle(resolved_module_spec.GetFileSpec());
143fc89bbccSPavel Labath 
144fc89bbccSPavel Labath     if (resolved_module_spec.GetFileSpec().Exists())
145fc89bbccSPavel Labath       error.Clear();
146fc89bbccSPavel Labath     else {
1477c5310bbSJonas Devlieghere       const uint32_t permissions = FileSystem::Instance().GetPermissions(
1487c5310bbSJonas Devlieghere           resolved_module_spec.GetFileSpec());
149fc89bbccSPavel Labath       if (permissions && (permissions & eFilePermissionsEveryoneR) == 0)
150fc89bbccSPavel Labath         error.SetErrorStringWithFormat(
151fc89bbccSPavel Labath             "executable '%s' is not readable",
152fc89bbccSPavel Labath             resolved_module_spec.GetFileSpec().GetPath().c_str());
153fc89bbccSPavel Labath       else
154fc89bbccSPavel Labath         error.SetErrorStringWithFormat(
155fc89bbccSPavel Labath             "unable to find executable for '%s'",
156fc89bbccSPavel Labath             resolved_module_spec.GetFileSpec().GetPath().c_str());
157fc89bbccSPavel Labath     }
158fc89bbccSPavel Labath   } else {
159fc89bbccSPavel Labath     if (m_remote_platform_sp) {
160fc89bbccSPavel Labath       error =
161fc89bbccSPavel Labath           GetCachedExecutable(resolved_module_spec, exe_module_sp,
162fc89bbccSPavel Labath                               module_search_paths_ptr, *m_remote_platform_sp);
163fc89bbccSPavel Labath     } else {
164fc89bbccSPavel Labath       // We may connect to a process and use the provided executable (Don't use
165fc89bbccSPavel Labath       // local $PATH).
166fc89bbccSPavel Labath 
167fc89bbccSPavel Labath       // Resolve any executable within a bundle on MacOSX
168fc89bbccSPavel Labath       Host::ResolveExecutableInBundle(resolved_module_spec.GetFileSpec());
169fc89bbccSPavel Labath 
170fc89bbccSPavel Labath       if (resolved_module_spec.GetFileSpec().Exists())
171fc89bbccSPavel Labath         error.Clear();
172fc89bbccSPavel Labath       else
173fc89bbccSPavel Labath         error.SetErrorStringWithFormat("the platform is not currently "
174fc89bbccSPavel Labath                                        "connected, and '%s' doesn't exist in "
175fc89bbccSPavel Labath                                        "the system root.",
176fc89bbccSPavel Labath                                        exe_path);
177fc89bbccSPavel Labath     }
178fc89bbccSPavel Labath   }
179fc89bbccSPavel Labath 
180fc89bbccSPavel Labath   if (error.Success()) {
181fc89bbccSPavel Labath     if (resolved_module_spec.GetArchitecture().IsValid()) {
182fc89bbccSPavel Labath       error = ModuleList::GetSharedModule(resolved_module_spec, exe_module_sp,
183fc89bbccSPavel Labath                                           module_search_paths_ptr, nullptr, nullptr);
184fc89bbccSPavel Labath       if (error.Fail()) {
185fc89bbccSPavel Labath         // If we failed, it may be because the vendor and os aren't known. If
186fc89bbccSPavel Labath 	// that is the case, try setting them to the host architecture and give
187fc89bbccSPavel Labath 	// it another try.
188fc89bbccSPavel Labath         llvm::Triple &module_triple =
189fc89bbccSPavel Labath             resolved_module_spec.GetArchitecture().GetTriple();
190fc89bbccSPavel Labath         bool is_vendor_specified =
191fc89bbccSPavel Labath             (module_triple.getVendor() != llvm::Triple::UnknownVendor);
192fc89bbccSPavel Labath         bool is_os_specified =
193fc89bbccSPavel Labath             (module_triple.getOS() != llvm::Triple::UnknownOS);
194fc89bbccSPavel Labath         if (!is_vendor_specified || !is_os_specified) {
195fc89bbccSPavel Labath           const llvm::Triple &host_triple =
196fc89bbccSPavel Labath               HostInfo::GetArchitecture(HostInfo::eArchKindDefault).GetTriple();
197fc89bbccSPavel Labath 
198fc89bbccSPavel Labath           if (!is_vendor_specified)
199fc89bbccSPavel Labath             module_triple.setVendorName(host_triple.getVendorName());
200fc89bbccSPavel Labath           if (!is_os_specified)
201fc89bbccSPavel Labath             module_triple.setOSName(host_triple.getOSName());
202fc89bbccSPavel Labath 
203fc89bbccSPavel Labath           error = ModuleList::GetSharedModule(resolved_module_spec,
204fc89bbccSPavel Labath                                               exe_module_sp, module_search_paths_ptr, nullptr, nullptr);
205fc89bbccSPavel Labath         }
206fc89bbccSPavel Labath       }
207fc89bbccSPavel Labath 
208fc89bbccSPavel Labath       // TODO find out why exe_module_sp might be NULL
209fc89bbccSPavel Labath       if (error.Fail() || !exe_module_sp || !exe_module_sp->GetObjectFile()) {
210fc89bbccSPavel Labath         exe_module_sp.reset();
211fc89bbccSPavel Labath         error.SetErrorStringWithFormat(
212fc89bbccSPavel Labath             "'%s' doesn't contain the architecture %s",
213fc89bbccSPavel Labath             resolved_module_spec.GetFileSpec().GetPath().c_str(),
214fc89bbccSPavel Labath             resolved_module_spec.GetArchitecture().GetArchitectureName());
215fc89bbccSPavel Labath       }
216fc89bbccSPavel Labath     } else {
21705097246SAdrian Prantl       // No valid architecture was specified, ask the platform for the
21805097246SAdrian Prantl       // architectures that we should be using (in the correct order) and see
21905097246SAdrian Prantl       // if we can find a match that way
220fc89bbccSPavel Labath       StreamString arch_names;
221fc89bbccSPavel Labath       for (uint32_t idx = 0; GetSupportedArchitectureAtIndex(
222fc89bbccSPavel Labath                idx, resolved_module_spec.GetArchitecture());
223fc89bbccSPavel Labath            ++idx) {
224fc89bbccSPavel Labath         error = ModuleList::GetSharedModule(resolved_module_spec, exe_module_sp,
225fc89bbccSPavel Labath                                             module_search_paths_ptr, nullptr, nullptr);
226fc89bbccSPavel Labath         // Did we find an executable using one of the
227fc89bbccSPavel Labath         if (error.Success()) {
228fc89bbccSPavel Labath           if (exe_module_sp && exe_module_sp->GetObjectFile())
229fc89bbccSPavel Labath             break;
230fc89bbccSPavel Labath           else
231fc89bbccSPavel Labath             error.SetErrorToGenericError();
232fc89bbccSPavel Labath         }
233fc89bbccSPavel Labath 
234fc89bbccSPavel Labath         if (idx > 0)
235fc89bbccSPavel Labath           arch_names.PutCString(", ");
236fc89bbccSPavel Labath         arch_names.PutCString(
237fc89bbccSPavel Labath             resolved_module_spec.GetArchitecture().GetArchitectureName());
238fc89bbccSPavel Labath       }
239fc89bbccSPavel Labath 
240fc89bbccSPavel Labath       if (error.Fail() || !exe_module_sp) {
2417c5310bbSJonas Devlieghere         if (FileSystem::Instance().Readable(
2427c5310bbSJonas Devlieghere                 resolved_module_spec.GetFileSpec())) {
243fc89bbccSPavel Labath           error.SetErrorStringWithFormat(
244fc89bbccSPavel Labath               "'%s' doesn't contain any '%s' platform architectures: %s",
245fc89bbccSPavel Labath               resolved_module_spec.GetFileSpec().GetPath().c_str(),
246fc89bbccSPavel Labath               GetPluginName().GetCString(), arch_names.GetData());
247fc89bbccSPavel Labath         } else {
248fc89bbccSPavel Labath           error.SetErrorStringWithFormat(
249fc89bbccSPavel Labath               "'%s' is not readable",
250fc89bbccSPavel Labath               resolved_module_spec.GetFileSpec().GetPath().c_str());
251fc89bbccSPavel Labath         }
252fc89bbccSPavel Labath       }
253fc89bbccSPavel Labath     }
254fc89bbccSPavel Labath   }
255fc89bbccSPavel Labath 
256fc89bbccSPavel Labath   return error;
257fc89bbccSPavel Labath }
258fc89bbccSPavel Labath 
25997206d57SZachary Turner Status PlatformPOSIX::GetFileWithUUID(const FileSpec &platform_file,
260ec9bc8ccSPavel Labath                                       const UUID *uuid_ptr,
261ec9bc8ccSPavel Labath                                       FileSpec &local_file) {
262ec9bc8ccSPavel Labath   if (IsRemote() && m_remote_platform_sp)
263ec9bc8ccSPavel Labath       return m_remote_platform_sp->GetFileWithUUID(platform_file, uuid_ptr,
264ec9bc8ccSPavel Labath                                                    local_file);
265ec9bc8ccSPavel Labath 
266ec9bc8ccSPavel Labath   // Default to the local case
267ec9bc8ccSPavel Labath   local_file = platform_file;
26897206d57SZachary Turner   return Status();
269ec9bc8ccSPavel Labath }
270ec9bc8ccSPavel Labath 
271ec9bc8ccSPavel Labath bool PlatformPOSIX::GetProcessInfo(lldb::pid_t pid,
272ec9bc8ccSPavel Labath                                      ProcessInstanceInfo &process_info) {
273ec9bc8ccSPavel Labath   if (IsHost())
274ec9bc8ccSPavel Labath     return Platform::GetProcessInfo(pid, process_info);
275ec9bc8ccSPavel Labath   if (m_remote_platform_sp)
276ec9bc8ccSPavel Labath     return m_remote_platform_sp->GetProcessInfo(pid, process_info);
277ec9bc8ccSPavel Labath   return false;
278ec9bc8ccSPavel Labath }
279ec9bc8ccSPavel Labath 
280ec9bc8ccSPavel Labath uint32_t
281ec9bc8ccSPavel Labath PlatformPOSIX::FindProcesses(const ProcessInstanceInfoMatch &match_info,
282ec9bc8ccSPavel Labath                                ProcessInstanceInfoList &process_infos) {
283ec9bc8ccSPavel Labath   if (IsHost())
284ec9bc8ccSPavel Labath     return Platform::FindProcesses(match_info, process_infos);
285ec9bc8ccSPavel Labath   if (m_remote_platform_sp)
286ec9bc8ccSPavel Labath     return
287ec9bc8ccSPavel Labath       m_remote_platform_sp->FindProcesses(match_info, process_infos);
288ec9bc8ccSPavel Labath   return 0;
289ec9bc8ccSPavel Labath }
290ec9bc8ccSPavel Labath 
29197206d57SZachary Turner Status PlatformPOSIX::MakeDirectory(const FileSpec &file_spec,
292b9c1b51eSKate Stone                                     uint32_t file_permissions) {
293fbb76349SGreg Clayton   if (m_remote_platform_sp)
294d3173f34SChaoren Lin     return m_remote_platform_sp->MakeDirectory(file_spec, file_permissions);
295fbb76349SGreg Clayton   else
296d3173f34SChaoren Lin     return Platform::MakeDirectory(file_spec, file_permissions);
297e0f8f574SDaniel Malea }
298fbb76349SGreg Clayton 
29997206d57SZachary Turner Status PlatformPOSIX::GetFilePermissions(const FileSpec &file_spec,
300b9c1b51eSKate Stone                                          uint32_t &file_permissions) {
301fbb76349SGreg Clayton   if (m_remote_platform_sp)
302b9c1b51eSKate Stone     return m_remote_platform_sp->GetFilePermissions(file_spec,
303b9c1b51eSKate Stone                                                     file_permissions);
304fbb76349SGreg Clayton   else
305d3173f34SChaoren Lin     return Platform::GetFilePermissions(file_spec, file_permissions);
306fbb76349SGreg Clayton }
307fbb76349SGreg Clayton 
30897206d57SZachary Turner Status PlatformPOSIX::SetFilePermissions(const FileSpec &file_spec,
309b9c1b51eSKate Stone                                          uint32_t file_permissions) {
310fbb76349SGreg Clayton   if (m_remote_platform_sp)
311b9c1b51eSKate Stone     return m_remote_platform_sp->SetFilePermissions(file_spec,
312b9c1b51eSKate Stone                                                     file_permissions);
313fbb76349SGreg Clayton   else
314d3173f34SChaoren Lin     return Platform::SetFilePermissions(file_spec, file_permissions);
315e0f8f574SDaniel Malea }
316e0f8f574SDaniel Malea 
317b9c1b51eSKate Stone lldb::user_id_t PlatformPOSIX::OpenFile(const FileSpec &file_spec,
318b9c1b51eSKate Stone                                         uint32_t flags, uint32_t mode,
31997206d57SZachary Turner                                         Status &error) {
320e0f8f574SDaniel Malea   if (IsHost())
321c00cf4a0SZachary Turner     return FileCache::GetInstance().OpenFile(file_spec, flags, mode, error);
322fbb76349SGreg Clayton   else if (m_remote_platform_sp)
323e0f8f574SDaniel Malea     return m_remote_platform_sp->OpenFile(file_spec, flags, mode, error);
324fbb76349SGreg Clayton   else
325e0f8f574SDaniel Malea     return Platform::OpenFile(file_spec, flags, mode, error);
326e0f8f574SDaniel Malea }
327e0f8f574SDaniel Malea 
32897206d57SZachary Turner bool PlatformPOSIX::CloseFile(lldb::user_id_t fd, Status &error) {
329e0f8f574SDaniel Malea   if (IsHost())
330c00cf4a0SZachary Turner     return FileCache::GetInstance().CloseFile(fd, error);
331fbb76349SGreg Clayton   else if (m_remote_platform_sp)
332e0f8f574SDaniel Malea     return m_remote_platform_sp->CloseFile(fd, error);
333fbb76349SGreg Clayton   else
334e0f8f574SDaniel Malea     return Platform::CloseFile(fd, error);
335e0f8f574SDaniel Malea }
336e0f8f574SDaniel Malea 
337b9c1b51eSKate Stone uint64_t PlatformPOSIX::ReadFile(lldb::user_id_t fd, uint64_t offset, void *dst,
33897206d57SZachary Turner                                  uint64_t dst_len, Status &error) {
339e0f8f574SDaniel Malea   if (IsHost())
340c00cf4a0SZachary Turner     return FileCache::GetInstance().ReadFile(fd, offset, dst, dst_len, error);
341fbb76349SGreg Clayton   else if (m_remote_platform_sp)
342e0f8f574SDaniel Malea     return m_remote_platform_sp->ReadFile(fd, offset, dst, dst_len, error);
343fbb76349SGreg Clayton   else
344e0f8f574SDaniel Malea     return Platform::ReadFile(fd, offset, dst, dst_len, error);
345e0f8f574SDaniel Malea }
346e0f8f574SDaniel Malea 
347b9c1b51eSKate Stone uint64_t PlatformPOSIX::WriteFile(lldb::user_id_t fd, uint64_t offset,
348b9c1b51eSKate Stone                                   const void *src, uint64_t src_len,
34997206d57SZachary Turner                                   Status &error) {
350e0f8f574SDaniel Malea   if (IsHost())
351c00cf4a0SZachary Turner     return FileCache::GetInstance().WriteFile(fd, offset, src, src_len, error);
352fbb76349SGreg Clayton   else if (m_remote_platform_sp)
353e0f8f574SDaniel Malea     return m_remote_platform_sp->WriteFile(fd, offset, src, src_len, error);
354fbb76349SGreg Clayton   else
355e0f8f574SDaniel Malea     return Platform::WriteFile(fd, offset, src, src_len, error);
356e0f8f574SDaniel Malea }
357e0f8f574SDaniel Malea 
358b9c1b51eSKate Stone static uint32_t chown_file(Platform *platform, const char *path,
359e0f8f574SDaniel Malea                            uint32_t uid = UINT32_MAX,
360b9c1b51eSKate Stone                            uint32_t gid = UINT32_MAX) {
361e0f8f574SDaniel Malea   if (!platform || !path || *path == 0)
362e0f8f574SDaniel Malea     return UINT32_MAX;
363e0f8f574SDaniel Malea 
364e0f8f574SDaniel Malea   if (uid == UINT32_MAX && gid == UINT32_MAX)
365e0f8f574SDaniel Malea     return 0; // pretend I did chown correctly - actually I just didn't care
366e0f8f574SDaniel Malea 
367e0f8f574SDaniel Malea   StreamString command;
368e0f8f574SDaniel Malea   command.PutCString("chown ");
369e0f8f574SDaniel Malea   if (uid != UINT32_MAX)
370e0f8f574SDaniel Malea     command.Printf("%d", uid);
371e0f8f574SDaniel Malea   if (gid != UINT32_MAX)
372e0f8f574SDaniel Malea     command.Printf(":%d", gid);
373e0f8f574SDaniel Malea   command.Printf("%s", path);
374e0f8f574SDaniel Malea   int status;
37519dd1a0eSPavel Labath   platform->RunShellCommand(command.GetData(), NULL, &status, NULL, NULL,
37619dd1a0eSPavel Labath                             std::chrono::seconds(10));
377e0f8f574SDaniel Malea   return status;
378e0f8f574SDaniel Malea }
379e0f8f574SDaniel Malea 
38097206d57SZachary Turner lldb_private::Status
381e0f8f574SDaniel Malea PlatformPOSIX::PutFile(const lldb_private::FileSpec &source,
382b9c1b51eSKate Stone                        const lldb_private::FileSpec &destination, uint32_t uid,
383b9c1b51eSKate Stone                        uint32_t gid) {
384fbb76349SGreg Clayton   Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM));
385fbb76349SGreg Clayton 
386b9c1b51eSKate Stone   if (IsHost()) {
387e0f8f574SDaniel Malea     if (FileSpec::Equal(source, destination, true))
38897206d57SZachary Turner       return Status();
389e0f8f574SDaniel Malea     // cp src dst
390e0f8f574SDaniel Malea     // chown uid:gid dst
391e0f8f574SDaniel Malea     std::string src_path(source.GetPath());
392e0f8f574SDaniel Malea     if (src_path.empty())
39397206d57SZachary Turner       return Status("unable to get file path for source");
394e0f8f574SDaniel Malea     std::string dst_path(destination.GetPath());
395e0f8f574SDaniel Malea     if (dst_path.empty())
39697206d57SZachary Turner       return Status("unable to get file path for destination");
397e0f8f574SDaniel Malea     StreamString command;
398e0f8f574SDaniel Malea     command.Printf("cp %s %s", src_path.c_str(), dst_path.c_str());
399e0f8f574SDaniel Malea     int status;
40019dd1a0eSPavel Labath     RunShellCommand(command.GetData(), NULL, &status, NULL, NULL,
40119dd1a0eSPavel Labath                     std::chrono::seconds(10));
402e0f8f574SDaniel Malea     if (status != 0)
40397206d57SZachary Turner       return Status("unable to perform copy");
404e0f8f574SDaniel Malea     if (uid == UINT32_MAX && gid == UINT32_MAX)
40597206d57SZachary Turner       return Status();
406e0f8f574SDaniel Malea     if (chown_file(this, dst_path.c_str(), uid, gid) != 0)
40797206d57SZachary Turner       return Status("unable to perform chown");
40897206d57SZachary Turner     return Status();
409b9c1b51eSKate Stone   } else if (m_remote_platform_sp) {
410b9c1b51eSKate Stone     if (GetSupportsRSync()) {
411e0f8f574SDaniel Malea       std::string src_path(source.GetPath());
412e0f8f574SDaniel Malea       if (src_path.empty())
41397206d57SZachary Turner         return Status("unable to get file path for source");
414e0f8f574SDaniel Malea       std::string dst_path(destination.GetPath());
415e0f8f574SDaniel Malea       if (dst_path.empty())
41697206d57SZachary Turner         return Status("unable to get file path for destination");
417e0f8f574SDaniel Malea       StreamString command;
418b9c1b51eSKate Stone       if (GetIgnoresRemoteHostname()) {
419e0f8f574SDaniel Malea         if (!GetRSyncPrefix())
420b9c1b51eSKate Stone           command.Printf("rsync %s %s %s", GetRSyncOpts(), src_path.c_str(),
421e0f8f574SDaniel Malea                          dst_path.c_str());
422e0f8f574SDaniel Malea         else
423b9c1b51eSKate Stone           command.Printf("rsync %s %s %s%s", GetRSyncOpts(), src_path.c_str(),
424b9c1b51eSKate Stone                          GetRSyncPrefix(), dst_path.c_str());
425b9c1b51eSKate Stone       } else
426b9c1b51eSKate Stone         command.Printf("rsync %s %s %s:%s", GetRSyncOpts(), src_path.c_str(),
427b9c1b51eSKate Stone                        GetHostname(), dst_path.c_str());
428e0f8f574SDaniel Malea       if (log)
429e0f8f574SDaniel Malea         log->Printf("[PutFile] Running command: %s\n", command.GetData());
430e0f8f574SDaniel Malea       int retcode;
43119dd1a0eSPavel Labath       Host::RunShellCommand(command.GetData(), NULL, &retcode, NULL, NULL,
43219dd1a0eSPavel Labath                             std::chrono::minutes(1));
433b9c1b51eSKate Stone       if (retcode == 0) {
434e0f8f574SDaniel Malea         // Don't chown a local file for a remote system
435e0f8f574SDaniel Malea         //                if (chown_file(this,dst_path.c_str(),uid,gid) != 0)
43697206d57SZachary Turner         //                    return Status("unable to perform chown");
43797206d57SZachary Turner         return Status();
438e0f8f574SDaniel Malea       }
439b9c1b51eSKate Stone       // if we are still here rsync has failed - let's try the slow way before
440b9c1b51eSKate Stone       // giving up
441e0f8f574SDaniel Malea     }
442e0f8f574SDaniel Malea   }
443e0f8f574SDaniel Malea   return Platform::PutFile(source, destination, uid, gid);
444e0f8f574SDaniel Malea }
445e0f8f574SDaniel Malea 
446b9c1b51eSKate Stone lldb::user_id_t PlatformPOSIX::GetFileSize(const FileSpec &file_spec) {
44707db3f7eSZachary Turner   if (IsHost()) {
44807db3f7eSZachary Turner     uint64_t Size;
44907db3f7eSZachary Turner     if (llvm::sys::fs::file_size(file_spec.GetPath(), Size))
45007db3f7eSZachary Turner       return 0;
45107db3f7eSZachary Turner     return Size;
45207db3f7eSZachary Turner   } else if (m_remote_platform_sp)
453e0f8f574SDaniel Malea     return m_remote_platform_sp->GetFileSize(file_spec);
454fbb76349SGreg Clayton   else
455e0f8f574SDaniel Malea     return Platform::GetFileSize(file_spec);
456e0f8f574SDaniel Malea }
457e0f8f574SDaniel Malea 
45897206d57SZachary Turner Status PlatformPOSIX::CreateSymlink(const FileSpec &src, const FileSpec &dst) {
459fbb76349SGreg Clayton   if (IsHost())
46046376966SJonas Devlieghere     return FileSystem::Instance().Symlink(src, dst);
461fbb76349SGreg Clayton   else if (m_remote_platform_sp)
462fbb76349SGreg Clayton     return m_remote_platform_sp->CreateSymlink(src, dst);
463fbb76349SGreg Clayton   else
464fbb76349SGreg Clayton     return Platform::CreateSymlink(src, dst);
465fbb76349SGreg Clayton }
466fbb76349SGreg Clayton 
467b9c1b51eSKate Stone bool PlatformPOSIX::GetFileExists(const FileSpec &file_spec) {
468e0f8f574SDaniel Malea   if (IsHost())
469e0f8f574SDaniel Malea     return file_spec.Exists();
470fbb76349SGreg Clayton   else if (m_remote_platform_sp)
471e0f8f574SDaniel Malea     return m_remote_platform_sp->GetFileExists(file_spec);
472fbb76349SGreg Clayton   else
473e0f8f574SDaniel Malea     return Platform::GetFileExists(file_spec);
474e0f8f574SDaniel Malea }
475e0f8f574SDaniel Malea 
47697206d57SZachary Turner Status PlatformPOSIX::Unlink(const FileSpec &file_spec) {
477e0f8f574SDaniel Malea   if (IsHost())
47807db3f7eSZachary Turner     return llvm::sys::fs::remove(file_spec.GetPath());
479fbb76349SGreg Clayton   else if (m_remote_platform_sp)
480d3173f34SChaoren Lin     return m_remote_platform_sp->Unlink(file_spec);
481fbb76349SGreg Clayton   else
482d3173f34SChaoren Lin     return Platform::Unlink(file_spec);
483e0f8f574SDaniel Malea }
484e0f8f574SDaniel Malea 
48597206d57SZachary Turner lldb_private::Status PlatformPOSIX::GetFile(
486b9c1b51eSKate Stone     const lldb_private::FileSpec &source,      // remote file path
487d3173f34SChaoren Lin     const lldb_private::FileSpec &destination) // local file path
488e0f8f574SDaniel Malea {
489fbb76349SGreg Clayton   Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM));
490fbb76349SGreg Clayton 
491e0f8f574SDaniel Malea   // Check the args, first.
492e0f8f574SDaniel Malea   std::string src_path(source.GetPath());
493e0f8f574SDaniel Malea   if (src_path.empty())
49497206d57SZachary Turner     return Status("unable to get file path for source");
495e0f8f574SDaniel Malea   std::string dst_path(destination.GetPath());
496e0f8f574SDaniel Malea   if (dst_path.empty())
49797206d57SZachary Turner     return Status("unable to get file path for destination");
498b9c1b51eSKate Stone   if (IsHost()) {
499e0f8f574SDaniel Malea     if (FileSpec::Equal(source, destination, true))
50097206d57SZachary Turner       return Status("local scenario->source and destination are the same file "
501b9c1b51eSKate Stone                     "path: no operation performed");
502e0f8f574SDaniel Malea     // cp src dst
503e0f8f574SDaniel Malea     StreamString cp_command;
504e0f8f574SDaniel Malea     cp_command.Printf("cp %s %s", src_path.c_str(), dst_path.c_str());
505e0f8f574SDaniel Malea     int status;
50619dd1a0eSPavel Labath     RunShellCommand(cp_command.GetData(), NULL, &status, NULL, NULL,
50719dd1a0eSPavel Labath                     std::chrono::seconds(10));
508e0f8f574SDaniel Malea     if (status != 0)
50997206d57SZachary Turner       return Status("unable to perform copy");
51097206d57SZachary Turner     return Status();
511b9c1b51eSKate Stone   } else if (m_remote_platform_sp) {
512b9c1b51eSKate Stone     if (GetSupportsRSync()) {
513e0f8f574SDaniel Malea       StreamString command;
514b9c1b51eSKate Stone       if (GetIgnoresRemoteHostname()) {
515e0f8f574SDaniel Malea         if (!GetRSyncPrefix())
516b9c1b51eSKate Stone           command.Printf("rsync %s %s %s", GetRSyncOpts(), src_path.c_str(),
517e0f8f574SDaniel Malea                          dst_path.c_str());
518e0f8f574SDaniel Malea         else
519b9c1b51eSKate Stone           command.Printf("rsync %s %s%s %s", GetRSyncOpts(), GetRSyncPrefix(),
520b9c1b51eSKate Stone                          src_path.c_str(), dst_path.c_str());
521b9c1b51eSKate Stone       } else
522b9c1b51eSKate Stone         command.Printf("rsync %s %s:%s %s", GetRSyncOpts(),
523b9c1b51eSKate Stone                        m_remote_platform_sp->GetHostname(), src_path.c_str(),
524e0f8f574SDaniel Malea                        dst_path.c_str());
525e0f8f574SDaniel Malea       if (log)
526e0f8f574SDaniel Malea         log->Printf("[GetFile] Running command: %s\n", command.GetData());
527e0f8f574SDaniel Malea       int retcode;
52819dd1a0eSPavel Labath       Host::RunShellCommand(command.GetData(), NULL, &retcode, NULL, NULL,
52919dd1a0eSPavel Labath                             std::chrono::minutes(1));
530e0f8f574SDaniel Malea       if (retcode == 0)
53197206d57SZachary Turner         return Status();
53205097246SAdrian Prantl       // If we are here, rsync has failed - let's try the slow way before
53305097246SAdrian Prantl       // giving up
534e0f8f574SDaniel Malea     }
535e0f8f574SDaniel Malea     // open src and dst
536e0f8f574SDaniel Malea     // read/write, read/write, read/write, ...
537e0f8f574SDaniel Malea     // close src
538e0f8f574SDaniel Malea     // close dst
539e0f8f574SDaniel Malea     if (log)
540e0f8f574SDaniel Malea       log->Printf("[GetFile] Using block by block transfer....\n");
54197206d57SZachary Turner     Status error;
542b9c1b51eSKate Stone     user_id_t fd_src = OpenFile(source, File::eOpenOptionRead,
543b9c1b51eSKate Stone                                 lldb::eFilePermissionsFileDefault, error);
544e0f8f574SDaniel Malea 
545e0f8f574SDaniel Malea     if (fd_src == UINT64_MAX)
54697206d57SZachary Turner       return Status("unable to open source file");
547e0f8f574SDaniel Malea 
548fbb76349SGreg Clayton     uint32_t permissions = 0;
549d3173f34SChaoren Lin     error = GetFilePermissions(source, permissions);
550e0f8f574SDaniel Malea 
551e0f8f574SDaniel Malea     if (permissions == 0)
552fbb76349SGreg Clayton       permissions = lldb::eFilePermissionsFileDefault;
553e0f8f574SDaniel Malea 
554c00cf4a0SZachary Turner     user_id_t fd_dst = FileCache::GetInstance().OpenFile(
555b9c1b51eSKate Stone         destination, File::eOpenOptionCanCreate | File::eOpenOptionWrite |
556b9c1b51eSKate Stone                          File::eOpenOptionTruncate,
557b9c1b51eSKate Stone         permissions, error);
558e0f8f574SDaniel Malea 
559b9c1b51eSKate Stone     if (fd_dst == UINT64_MAX) {
560e0f8f574SDaniel Malea       if (error.Success())
561e0f8f574SDaniel Malea         error.SetErrorString("unable to open destination file");
562e0f8f574SDaniel Malea     }
563e0f8f574SDaniel Malea 
564b9c1b51eSKate Stone     if (error.Success()) {
565e0f8f574SDaniel Malea       lldb::DataBufferSP buffer_sp(new DataBufferHeap(1024, 0));
566e0f8f574SDaniel Malea       uint64_t offset = 0;
567e0f8f574SDaniel Malea       error.Clear();
568b9c1b51eSKate Stone       while (error.Success()) {
569b9c1b51eSKate Stone         const uint64_t n_read = ReadFile(fd_src, offset, buffer_sp->GetBytes(),
570b9c1b51eSKate Stone                                          buffer_sp->GetByteSize(), error);
571e0f8f574SDaniel Malea         if (error.Fail())
572e0f8f574SDaniel Malea           break;
573e0f8f574SDaniel Malea         if (n_read == 0)
574e0f8f574SDaniel Malea           break;
575b9c1b51eSKate Stone         if (FileCache::GetInstance().WriteFile(fd_dst, offset,
576b9c1b51eSKate Stone                                                buffer_sp->GetBytes(), n_read,
577b9c1b51eSKate Stone                                                error) != n_read) {
578e0f8f574SDaniel Malea           if (!error.Fail())
579e0f8f574SDaniel Malea             error.SetErrorString("unable to write to destination file");
580e0f8f574SDaniel Malea           break;
581e0f8f574SDaniel Malea         }
582e0f8f574SDaniel Malea         offset += n_read;
583e0f8f574SDaniel Malea       }
584e0f8f574SDaniel Malea     }
585e0f8f574SDaniel Malea     // Ignore the close error of src.
586e0f8f574SDaniel Malea     if (fd_src != UINT64_MAX)
587e0f8f574SDaniel Malea       CloseFile(fd_src, error);
588e0f8f574SDaniel Malea     // And close the dst file descriptot.
589b9c1b51eSKate Stone     if (fd_dst != UINT64_MAX &&
590b9c1b51eSKate Stone         !FileCache::GetInstance().CloseFile(fd_dst, error)) {
591e0f8f574SDaniel Malea       if (!error.Fail())
592e0f8f574SDaniel Malea         error.SetErrorString("unable to close destination file");
593e0f8f574SDaniel Malea     }
594e0f8f574SDaniel Malea     return error;
595e0f8f574SDaniel Malea   }
596e0f8f574SDaniel Malea   return Platform::GetFile(source, destination);
597e0f8f574SDaniel Malea }
598e0f8f574SDaniel Malea 
599b9c1b51eSKate Stone std::string PlatformPOSIX::GetPlatformSpecificConnectionInformation() {
600e0f8f574SDaniel Malea   StreamString stream;
601b9c1b51eSKate Stone   if (GetSupportsRSync()) {
602e0f8f574SDaniel Malea     stream.PutCString("rsync");
603e0f8f574SDaniel Malea     if ((GetRSyncOpts() && *GetRSyncOpts()) ||
604b9c1b51eSKate Stone         (GetRSyncPrefix() && *GetRSyncPrefix()) || GetIgnoresRemoteHostname()) {
605e0f8f574SDaniel Malea       stream.Printf(", options: ");
606e0f8f574SDaniel Malea       if (GetRSyncOpts() && *GetRSyncOpts())
607e0f8f574SDaniel Malea         stream.Printf("'%s' ", GetRSyncOpts());
608e0f8f574SDaniel Malea       stream.Printf(", prefix: ");
609e0f8f574SDaniel Malea       if (GetRSyncPrefix() && *GetRSyncPrefix())
610e0f8f574SDaniel Malea         stream.Printf("'%s' ", GetRSyncPrefix());
611e0f8f574SDaniel Malea       if (GetIgnoresRemoteHostname())
612e0f8f574SDaniel Malea         stream.Printf("ignore remote-hostname ");
613e0f8f574SDaniel Malea     }
614e0f8f574SDaniel Malea   }
615b9c1b51eSKate Stone   if (GetSupportsSSH()) {
616e0f8f574SDaniel Malea     stream.PutCString("ssh");
617e0f8f574SDaniel Malea     if (GetSSHOpts() && *GetSSHOpts())
618e0f8f574SDaniel Malea       stream.Printf(", options: '%s' ", GetSSHOpts());
619e0f8f574SDaniel Malea   }
620e0f8f574SDaniel Malea   if (GetLocalCacheDirectory() && *GetLocalCacheDirectory())
621e0f8f574SDaniel Malea     stream.Printf("cache dir: %s", GetLocalCacheDirectory());
622e0f8f574SDaniel Malea   if (stream.GetSize())
623c156427dSZachary Turner     return stream.GetString();
624e0f8f574SDaniel Malea   else
625e0f8f574SDaniel Malea     return "";
626e0f8f574SDaniel Malea }
627e0f8f574SDaniel Malea 
628b9c1b51eSKate Stone bool PlatformPOSIX::CalculateMD5(const FileSpec &file_spec, uint64_t &low,
629b9c1b51eSKate Stone                                  uint64_t &high) {
630e0f8f574SDaniel Malea   if (IsHost())
631e0f8f574SDaniel Malea     return Platform::CalculateMD5(file_spec, low, high);
632e0f8f574SDaniel Malea   if (m_remote_platform_sp)
633e0f8f574SDaniel Malea     return m_remote_platform_sp->CalculateMD5(file_spec, low, high);
634e0f8f574SDaniel Malea   return false;
635e0f8f574SDaniel Malea }
636fbb76349SGreg Clayton 
637b9c1b51eSKate Stone const lldb::UnixSignalsSP &PlatformPOSIX::GetRemoteUnixSignals() {
63898d0a4b3SChaoren Lin   if (IsRemote() && m_remote_platform_sp)
63998d0a4b3SChaoren Lin     return m_remote_platform_sp->GetRemoteUnixSignals();
64098d0a4b3SChaoren Lin   return Platform::GetRemoteUnixSignals();
64198d0a4b3SChaoren Lin }
64298d0a4b3SChaoren Lin 
643b9c1b51eSKate Stone FileSpec PlatformPOSIX::GetRemoteWorkingDirectory() {
644fbb76349SGreg Clayton   if (IsRemote() && m_remote_platform_sp)
645fbb76349SGreg Clayton     return m_remote_platform_sp->GetRemoteWorkingDirectory();
646fbb76349SGreg Clayton   else
647fbb76349SGreg Clayton     return Platform::GetRemoteWorkingDirectory();
648fbb76349SGreg Clayton }
649fbb76349SGreg Clayton 
650b9c1b51eSKate Stone bool PlatformPOSIX::SetRemoteWorkingDirectory(const FileSpec &working_dir) {
651fbb76349SGreg Clayton   if (IsRemote() && m_remote_platform_sp)
652d3173f34SChaoren Lin     return m_remote_platform_sp->SetRemoteWorkingDirectory(working_dir);
653fbb76349SGreg Clayton   else
654d3173f34SChaoren Lin     return Platform::SetRemoteWorkingDirectory(working_dir);
655fbb76349SGreg Clayton }
656fbb76349SGreg Clayton 
657b9c1b51eSKate Stone bool PlatformPOSIX::GetRemoteOSVersion() {
6582272c481SPavel Labath   if (m_remote_platform_sp) {
6592272c481SPavel Labath     m_os_version = m_remote_platform_sp->GetOSVersion();
6602272c481SPavel Labath     return !m_os_version.empty();
6612272c481SPavel Labath   }
662015d818bSTodd Fiala   return false;
663015d818bSTodd Fiala }
664015d818bSTodd Fiala 
665b9c1b51eSKate Stone bool PlatformPOSIX::GetRemoteOSBuildString(std::string &s) {
666015d818bSTodd Fiala   if (m_remote_platform_sp)
667015d818bSTodd Fiala     return m_remote_platform_sp->GetRemoteOSBuildString(s);
668015d818bSTodd Fiala   s.clear();
669015d818bSTodd Fiala   return false;
670015d818bSTodd Fiala }
671015d818bSTodd Fiala 
67262930e57SPavel Labath Environment PlatformPOSIX::GetEnvironment() {
673b9c1b51eSKate Stone   if (IsRemote()) {
674e15fcaa2STodd Fiala     if (m_remote_platform_sp)
67562930e57SPavel Labath       return m_remote_platform_sp->GetEnvironment();
67662930e57SPavel Labath     return Environment();
677e15fcaa2STodd Fiala   }
67862930e57SPavel Labath   return Host::GetEnvironment();
679e15fcaa2STodd Fiala }
680e15fcaa2STodd Fiala 
681b9c1b51eSKate Stone bool PlatformPOSIX::GetRemoteOSKernelDescription(std::string &s) {
682015d818bSTodd Fiala   if (m_remote_platform_sp)
683015d818bSTodd Fiala     return m_remote_platform_sp->GetRemoteOSKernelDescription(s);
684015d818bSTodd Fiala   s.clear();
685015d818bSTodd Fiala   return false;
686015d818bSTodd Fiala }
687015d818bSTodd Fiala 
688015d818bSTodd Fiala // Remote Platform subclasses need to override this function
689b9c1b51eSKate Stone ArchSpec PlatformPOSIX::GetRemoteSystemArchitecture() {
690015d818bSTodd Fiala   if (m_remote_platform_sp)
691015d818bSTodd Fiala     return m_remote_platform_sp->GetRemoteSystemArchitecture();
692015d818bSTodd Fiala   return ArchSpec();
693015d818bSTodd Fiala }
694015d818bSTodd Fiala 
695b9c1b51eSKate Stone const char *PlatformPOSIX::GetHostname() {
696015d818bSTodd Fiala   if (IsHost())
697015d818bSTodd Fiala     return Platform::GetHostname();
698015d818bSTodd Fiala 
699015d818bSTodd Fiala   if (m_remote_platform_sp)
700015d818bSTodd Fiala     return m_remote_platform_sp->GetHostname();
701015d818bSTodd Fiala   return NULL;
702015d818bSTodd Fiala }
703015d818bSTodd Fiala 
704b9c1b51eSKate Stone const char *PlatformPOSIX::GetUserName(uint32_t uid) {
705015d818bSTodd Fiala   // Check the cache in Platform in case we have already looked this uid up
706015d818bSTodd Fiala   const char *user_name = Platform::GetUserName(uid);
707015d818bSTodd Fiala   if (user_name)
708015d818bSTodd Fiala     return user_name;
709015d818bSTodd Fiala 
710015d818bSTodd Fiala   if (IsRemote() && m_remote_platform_sp)
711015d818bSTodd Fiala     return m_remote_platform_sp->GetUserName(uid);
712015d818bSTodd Fiala   return NULL;
713015d818bSTodd Fiala }
714015d818bSTodd Fiala 
715b9c1b51eSKate Stone const char *PlatformPOSIX::GetGroupName(uint32_t gid) {
716015d818bSTodd Fiala   const char *group_name = Platform::GetGroupName(gid);
717015d818bSTodd Fiala   if (group_name)
718015d818bSTodd Fiala     return group_name;
719015d818bSTodd Fiala 
720015d818bSTodd Fiala   if (IsRemote() && m_remote_platform_sp)
721015d818bSTodd Fiala     return m_remote_platform_sp->GetGroupName(gid);
722015d818bSTodd Fiala   return NULL;
723015d818bSTodd Fiala }
724015d818bSTodd Fiala 
72597206d57SZachary Turner Status PlatformPOSIX::ConnectRemote(Args &args) {
72697206d57SZachary Turner   Status error;
727b9c1b51eSKate Stone   if (IsHost()) {
728b9c1b51eSKate Stone     error.SetErrorStringWithFormat(
729b9c1b51eSKate Stone         "can't connect to the host platform '%s', always connected",
730b9c1b51eSKate Stone         GetPluginName().GetCString());
731b9c1b51eSKate Stone   } else {
732015d818bSTodd Fiala     if (!m_remote_platform_sp)
733b9c1b51eSKate Stone       m_remote_platform_sp =
734b9c1b51eSKate Stone           Platform::Create(ConstString("remote-gdb-server"), error);
735015d818bSTodd Fiala 
736015d818bSTodd Fiala     if (m_remote_platform_sp && error.Success())
737015d818bSTodd Fiala       error = m_remote_platform_sp->ConnectRemote(args);
738015d818bSTodd Fiala     else
739015d818bSTodd Fiala       error.SetErrorString("failed to create a 'remote-gdb-server' platform");
740015d818bSTodd Fiala 
741015d818bSTodd Fiala     if (error.Fail())
742015d818bSTodd Fiala       m_remote_platform_sp.reset();
743015d818bSTodd Fiala   }
744015d818bSTodd Fiala 
745b9c1b51eSKate Stone   if (error.Success() && m_remote_platform_sp) {
746b9c1b51eSKate Stone     if (m_option_group_platform_rsync.get() &&
747b9c1b51eSKate Stone         m_option_group_platform_ssh.get() &&
748b9c1b51eSKate Stone         m_option_group_platform_caching.get()) {
749b9c1b51eSKate Stone       if (m_option_group_platform_rsync->m_rsync) {
750015d818bSTodd Fiala         SetSupportsRSync(true);
7510a66e2f1SEnrico Granata         SetRSyncOpts(m_option_group_platform_rsync->m_rsync_opts.c_str());
7520a66e2f1SEnrico Granata         SetRSyncPrefix(m_option_group_platform_rsync->m_rsync_prefix.c_str());
753b9c1b51eSKate Stone         SetIgnoresRemoteHostname(
754b9c1b51eSKate Stone             m_option_group_platform_rsync->m_ignores_remote_hostname);
755015d818bSTodd Fiala       }
756b9c1b51eSKate Stone       if (m_option_group_platform_ssh->m_ssh) {
757015d818bSTodd Fiala         SetSupportsSSH(true);
7580a66e2f1SEnrico Granata         SetSSHOpts(m_option_group_platform_ssh->m_ssh_opts.c_str());
759015d818bSTodd Fiala       }
760b9c1b51eSKate Stone       SetLocalCacheDirectory(
761b9c1b51eSKate Stone           m_option_group_platform_caching->m_cache_dir.c_str());
762015d818bSTodd Fiala     }
763015d818bSTodd Fiala   }
764015d818bSTodd Fiala 
765015d818bSTodd Fiala   return error;
766015d818bSTodd Fiala }
767015d818bSTodd Fiala 
76897206d57SZachary Turner Status PlatformPOSIX::DisconnectRemote() {
76997206d57SZachary Turner   Status error;
770015d818bSTodd Fiala 
771b9c1b51eSKate Stone   if (IsHost()) {
772b9c1b51eSKate Stone     error.SetErrorStringWithFormat(
773b9c1b51eSKate Stone         "can't disconnect from the host platform '%s', always connected",
774b9c1b51eSKate Stone         GetPluginName().GetCString());
775b9c1b51eSKate Stone   } else {
776015d818bSTodd Fiala     if (m_remote_platform_sp)
777015d818bSTodd Fiala       error = m_remote_platform_sp->DisconnectRemote();
778015d818bSTodd Fiala     else
779015d818bSTodd Fiala       error.SetErrorString("the platform is not currently connected");
780015d818bSTodd Fiala   }
781015d818bSTodd Fiala   return error;
782015d818bSTodd Fiala }
783015d818bSTodd Fiala 
78497206d57SZachary Turner Status PlatformPOSIX::LaunchProcess(ProcessLaunchInfo &launch_info) {
78597206d57SZachary Turner   Status error;
786348fb385STodd Fiala 
787b9c1b51eSKate Stone   if (IsHost()) {
788348fb385STodd Fiala     error = Platform::LaunchProcess(launch_info);
789b9c1b51eSKate Stone   } else {
790348fb385STodd Fiala     if (m_remote_platform_sp)
791348fb385STodd Fiala       error = m_remote_platform_sp->LaunchProcess(launch_info);
792348fb385STodd Fiala     else
793348fb385STodd Fiala       error.SetErrorString("the platform is not currently connected");
794348fb385STodd Fiala   }
795348fb385STodd Fiala   return error;
796348fb385STodd Fiala }
797348fb385STodd Fiala 
79897206d57SZachary Turner lldb_private::Status PlatformPOSIX::KillProcess(const lldb::pid_t pid) {
79909daa881SOleksiy Vyalov   if (IsHost())
80009daa881SOleksiy Vyalov     return Platform::KillProcess(pid);
80109daa881SOleksiy Vyalov 
80209daa881SOleksiy Vyalov   if (m_remote_platform_sp)
80309daa881SOleksiy Vyalov     return m_remote_platform_sp->KillProcess(pid);
80409daa881SOleksiy Vyalov 
80597206d57SZachary Turner   return Status("the platform is not currently connected");
80609daa881SOleksiy Vyalov }
80709daa881SOleksiy Vyalov 
808b9c1b51eSKate Stone lldb::ProcessSP PlatformPOSIX::Attach(ProcessAttachInfo &attach_info,
809b9c1b51eSKate Stone                                       Debugger &debugger, Target *target,
81097206d57SZachary Turner                                       Status &error) {
811348fb385STodd Fiala   lldb::ProcessSP process_sp;
812348fb385STodd Fiala   Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM));
813348fb385STodd Fiala 
814b9c1b51eSKate Stone   if (IsHost()) {
815b9c1b51eSKate Stone     if (target == NULL) {
816348fb385STodd Fiala       TargetSP new_target_sp;
817348fb385STodd Fiala 
818f9a07e9fSJonas Devlieghere       error = debugger.GetTargetList().CreateTarget(
819f9a07e9fSJonas Devlieghere           debugger, "", "", eLoadDependentsNo, NULL, new_target_sp);
820348fb385STodd Fiala       target = new_target_sp.get();
821348fb385STodd Fiala       if (log)
822348fb385STodd Fiala         log->Printf("PlatformPOSIX::%s created new target", __FUNCTION__);
823b9c1b51eSKate Stone     } else {
824348fb385STodd Fiala       error.Clear();
825348fb385STodd Fiala       if (log)
826b9c1b51eSKate Stone         log->Printf("PlatformPOSIX::%s target already existed, setting target",
827b9c1b51eSKate Stone                     __FUNCTION__);
828348fb385STodd Fiala     }
829348fb385STodd Fiala 
830b9c1b51eSKate Stone     if (target && error.Success()) {
831348fb385STodd Fiala       debugger.GetTargetList().SetSelectedTarget(target);
832b9c1b51eSKate Stone       if (log) {
833348fb385STodd Fiala         ModuleSP exe_module_sp = target->GetExecutableModule();
834b9c1b51eSKate Stone         log->Printf("PlatformPOSIX::%s set selected target to %p %s",
835b9c1b51eSKate Stone                     __FUNCTION__, (void *)target,
836b9c1b51eSKate Stone                     exe_module_sp
837b9c1b51eSKate Stone                         ? exe_module_sp->GetFileSpec().GetPath().c_str()
838b9c1b51eSKate Stone                         : "<null>");
839348fb385STodd Fiala       }
840348fb385STodd Fiala 
841b9c1b51eSKate Stone       process_sp =
842b9c1b51eSKate Stone           target->CreateProcess(attach_info.GetListenerForProcess(debugger),
843b9c1b51eSKate Stone                                 attach_info.GetProcessPluginName(), NULL);
844348fb385STodd Fiala 
845b9c1b51eSKate Stone       if (process_sp) {
846583bbb1dSJim Ingham         ListenerSP listener_sp = attach_info.GetHijackListener();
847b9c1b51eSKate Stone         if (listener_sp == nullptr) {
848b9c1b51eSKate Stone           listener_sp =
849b9c1b51eSKate Stone               Listener::MakeListener("lldb.PlatformPOSIX.attach.hijack");
850348fb385STodd Fiala           attach_info.SetHijackListener(listener_sp);
851926af0cdSOleksiy Vyalov         }
852583bbb1dSJim Ingham         process_sp->HijackProcessEvents(listener_sp);
853348fb385STodd Fiala         error = process_sp->Attach(attach_info);
854348fb385STodd Fiala       }
855348fb385STodd Fiala     }
856b9c1b51eSKate Stone   } else {
857348fb385STodd Fiala     if (m_remote_platform_sp)
858b9c1b51eSKate Stone       process_sp =
859b9c1b51eSKate Stone           m_remote_platform_sp->Attach(attach_info, debugger, target, error);
860348fb385STodd Fiala     else
861348fb385STodd Fiala       error.SetErrorString("the platform is not currently connected");
862348fb385STodd Fiala   }
863348fb385STodd Fiala   return process_sp;
864348fb385STodd Fiala }
865348fb385STodd Fiala 
866015d818bSTodd Fiala lldb::ProcessSP
867b9c1b51eSKate Stone PlatformPOSIX::DebugProcess(ProcessLaunchInfo &launch_info, Debugger &debugger,
868b9c1b51eSKate Stone                             Target *target, // Can be NULL, if NULL create a new
869b9c1b51eSKate Stone                                             // target, else use existing one
87097206d57SZachary Turner                             Status &error) {
871015d818bSTodd Fiala   ProcessSP process_sp;
872015d818bSTodd Fiala 
873b9c1b51eSKate Stone   if (IsHost()) {
874b9c1b51eSKate Stone     // We are going to hand this process off to debugserver which will be in
875245dd2e0SPavel Labath     // charge of setting the exit status.  However, we still need to reap it
876245dd2e0SPavel Labath     // from lldb. So, make sure we use a exit callback which does not set exit
877245dd2e0SPavel Labath     // status.
878245dd2e0SPavel Labath     const bool monitor_signals = false;
879245dd2e0SPavel Labath     launch_info.SetMonitorProcessCallback(
880245dd2e0SPavel Labath         &ProcessLaunchInfo::NoOpMonitorCallback, monitor_signals);
8818012cadbSGreg Clayton     process_sp = Platform::DebugProcess(launch_info, debugger, target, error);
882b9c1b51eSKate Stone   } else {
883015d818bSTodd Fiala     if (m_remote_platform_sp)
884b9c1b51eSKate Stone       process_sp = m_remote_platform_sp->DebugProcess(launch_info, debugger,
885b9c1b51eSKate Stone                                                       target, error);
886015d818bSTodd Fiala     else
887015d818bSTodd Fiala       error.SetErrorString("the platform is not currently connected");
888015d818bSTodd Fiala   }
889015d818bSTodd Fiala   return process_sp;
890015d818bSTodd Fiala }
891015d818bSTodd Fiala 
892b9c1b51eSKate Stone void PlatformPOSIX::CalculateTrapHandlerSymbolNames() {
8932094dbf4SJason Molenda   m_trap_handlers.push_back(ConstString("_sigtramp"));
8942094dbf4SJason Molenda }
8953cb132a0STamas Berghammer 
89697206d57SZachary Turner Status PlatformPOSIX::EvaluateLibdlExpression(
897b9c1b51eSKate Stone     lldb_private::Process *process, const char *expr_cstr,
898d37c9469SPavel Labath     llvm::StringRef expr_prefix, lldb::ValueObjectSP &result_valobj_sp) {
8993cb132a0STamas Berghammer   DynamicLoader *loader = process->GetDynamicLoader();
900b9c1b51eSKate Stone   if (loader) {
90197206d57SZachary Turner     Status error = loader->CanLoadImage();
9023cb132a0STamas Berghammer     if (error.Fail())
9033cb132a0STamas Berghammer       return error;
9043cb132a0STamas Berghammer   }
9053cb132a0STamas Berghammer 
9068d94ba0fSJim Ingham   ThreadSP thread_sp(process->GetThreadList().GetExpressionExecutionThread());
9073cb132a0STamas Berghammer   if (!thread_sp)
90897206d57SZachary Turner     return Status("Selected thread isn't valid");
9093cb132a0STamas Berghammer 
9103cb132a0STamas Berghammer   StackFrameSP frame_sp(thread_sp->GetStackFrameAtIndex(0));
9113cb132a0STamas Berghammer   if (!frame_sp)
91297206d57SZachary Turner     return Status("Frame 0 isn't valid");
9133cb132a0STamas Berghammer 
9143cb132a0STamas Berghammer   ExecutionContext exe_ctx;
9153cb132a0STamas Berghammer   frame_sp->CalculateExecutionContext(exe_ctx);
9163cb132a0STamas Berghammer   EvaluateExpressionOptions expr_options;
9173cb132a0STamas Berghammer   expr_options.SetUnwindOnError(true);
9183cb132a0STamas Berghammer   expr_options.SetIgnoreBreakpoints(true);
9193cb132a0STamas Berghammer   expr_options.SetExecutionPolicy(eExecutionPolicyAlways);
9203cb132a0STamas Berghammer   expr_options.SetLanguage(eLanguageTypeC_plus_plus);
921b9c1b51eSKate Stone   expr_options.SetTrapExceptions(false); // dlopen can't throw exceptions, so
922b9c1b51eSKate Stone                                          // don't do the work to trap them.
92343d35418SPavel Labath   expr_options.SetTimeout(std::chrono::seconds(2));
9243cb132a0STamas Berghammer 
92597206d57SZachary Turner   Status expr_error;
92602980825SJim Ingham   ExpressionResults result =
927b9c1b51eSKate Stone       UserExpression::Evaluate(exe_ctx, expr_options, expr_cstr, expr_prefix,
928b9c1b51eSKate Stone                                result_valobj_sp, expr_error);
92902980825SJim Ingham   if (result != eExpressionCompleted)
93002980825SJim Ingham     return expr_error;
93102980825SJim Ingham 
9323cb132a0STamas Berghammer   if (result_valobj_sp->GetError().Fail())
9333cb132a0STamas Berghammer     return result_valobj_sp->GetError();
93497206d57SZachary Turner   return Status();
9353cb132a0STamas Berghammer }
9363cb132a0STamas Berghammer 
937d10d3795SFrederic Riss std::unique_ptr<UtilityFunction>
9381ecb34f4SJim Ingham PlatformPOSIX::MakeLoadImageUtilityFunction(ExecutionContext &exe_ctx,
939d10d3795SFrederic Riss                                             Status &error) {
94005097246SAdrian Prantl   // Remember to prepend this with the prefix from
94105097246SAdrian Prantl   // GetLibdlFunctionDeclarations. The returned values are all in
94205097246SAdrian Prantl   // __lldb_dlopen_result for consistency. The wrapper returns a void * but
94305097246SAdrian Prantl   // doesn't use it because UtilityFunctions don't work with void returns at
94405097246SAdrian Prantl   // present.
9451ecb34f4SJim Ingham   static const char *dlopen_wrapper_code = R"(
9461ecb34f4SJim Ingham   struct __lldb_dlopen_result {
9471ecb34f4SJim Ingham     void *image_ptr;
9481ecb34f4SJim Ingham     const char *error_str;
9491ecb34f4SJim Ingham   };
9501ecb34f4SJim Ingham 
95103856dd9SJim Ingham   extern void *memcpy(void *, const void *, size_t size);
9520d231f71SJim Ingham   extern size_t strlen(const char *);
9530d231f71SJim Ingham 
9540d231f71SJim Ingham 
9550d231f71SJim Ingham   void * __lldb_dlopen_wrapper (const char *name,
9560d231f71SJim Ingham                                 const char *path_strings,
9570d231f71SJim Ingham                                 char *buffer,
9581ecb34f4SJim Ingham                                 __lldb_dlopen_result *result_ptr)
9591ecb34f4SJim Ingham   {
9600d231f71SJim Ingham     // This is the case where the name is the full path:
96103856dd9SJim Ingham     if (!path_strings) {
9620d231f71SJim Ingham       result_ptr->image_ptr = dlopen(name, 2);
96303856dd9SJim Ingham       if (result_ptr->image_ptr)
9640d231f71SJim Ingham         result_ptr->error_str = nullptr;
9650d231f71SJim Ingham       return nullptr;
9660d231f71SJim Ingham     }
9670d231f71SJim Ingham 
9680d231f71SJim Ingham     // This is the case where we have a list of paths:
9690d231f71SJim Ingham     size_t name_len = strlen(name);
97003856dd9SJim Ingham     while (path_strings && path_strings[0] != '\0') {
9710d231f71SJim Ingham       size_t path_len = strlen(path_strings);
9720d231f71SJim Ingham       memcpy((void *) buffer, (void *) path_strings, path_len);
9730d231f71SJim Ingham       buffer[path_len] = '/';
9740d231f71SJim Ingham       char *target_ptr = buffer+path_len+1;
9750d231f71SJim Ingham       memcpy((void *) target_ptr, (void *) name, name_len + 1);
9760d231f71SJim Ingham       result_ptr->image_ptr = dlopen(buffer, 2);
97703856dd9SJim Ingham       if (result_ptr->image_ptr) {
9780d231f71SJim Ingham         result_ptr->error_str = nullptr;
9790d231f71SJim Ingham         break;
9800d231f71SJim Ingham       }
9811ecb34f4SJim Ingham       result_ptr->error_str = dlerror();
9820d231f71SJim Ingham       path_strings = path_strings + path_len + 1;
9830d231f71SJim Ingham     }
9841ecb34f4SJim Ingham     return nullptr;
9851ecb34f4SJim Ingham   }
9861ecb34f4SJim Ingham   )";
9871ecb34f4SJim Ingham 
9881ecb34f4SJim Ingham   static const char *dlopen_wrapper_name = "__lldb_dlopen_wrapper";
9891ecb34f4SJim Ingham   Process *process = exe_ctx.GetProcessSP().get();
9901ecb34f4SJim Ingham   // Insert the dlopen shim defines into our generic expression:
9911ecb34f4SJim Ingham   std::string expr(GetLibdlFunctionDeclarations(process));
9921ecb34f4SJim Ingham   expr.append(dlopen_wrapper_code);
9931ecb34f4SJim Ingham   Status utility_error;
9941ecb34f4SJim Ingham   DiagnosticManager diagnostics;
9951ecb34f4SJim Ingham 
9961ecb34f4SJim Ingham   std::unique_ptr<UtilityFunction> dlopen_utility_func_up(process
9971ecb34f4SJim Ingham       ->GetTarget().GetUtilityFunctionForLanguage(expr.c_str(),
9981ecb34f4SJim Ingham                                                   eLanguageTypeObjC,
9991ecb34f4SJim Ingham                                                   dlopen_wrapper_name,
10001ecb34f4SJim Ingham                                                   utility_error));
10011ecb34f4SJim Ingham   if (utility_error.Fail()) {
10021ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not make utility"
10031ecb34f4SJim Ingham                                    "function: %s", utility_error.AsCString());
10041ecb34f4SJim Ingham     return nullptr;
10051ecb34f4SJim Ingham   }
10061ecb34f4SJim Ingham   if (!dlopen_utility_func_up->Install(diagnostics, exe_ctx)) {
10071ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not install utility"
10081ecb34f4SJim Ingham                                    "function: %s",
10091ecb34f4SJim Ingham                                    diagnostics.GetString().c_str());
10101ecb34f4SJim Ingham     return nullptr;
10111ecb34f4SJim Ingham   }
10121ecb34f4SJim Ingham 
10131ecb34f4SJim Ingham   Value value;
10141ecb34f4SJim Ingham   ValueList arguments;
10151ecb34f4SJim Ingham   FunctionCaller *do_dlopen_function = nullptr;
10161ecb34f4SJim Ingham 
10171ecb34f4SJim Ingham   // Fetch the clang types we will need:
10181ecb34f4SJim Ingham   ClangASTContext *ast = process->GetTarget().GetScratchClangASTContext();
10191ecb34f4SJim Ingham 
10201ecb34f4SJim Ingham   CompilerType clang_void_pointer_type
10211ecb34f4SJim Ingham       = ast->GetBasicType(eBasicTypeVoid).GetPointerType();
10221ecb34f4SJim Ingham   CompilerType clang_char_pointer_type
10231ecb34f4SJim Ingham         = ast->GetBasicType(eBasicTypeChar).GetPointerType();
10241ecb34f4SJim Ingham 
10250d231f71SJim Ingham   // We are passing four arguments, the basename, the list of places to look,
10260d231f71SJim Ingham   // a buffer big enough for all the path + name combos, and
10270d231f71SJim Ingham   // a pointer to the storage we've made for the result:
10281ecb34f4SJim Ingham   value.SetValueType(Value::eValueTypeScalar);
10291ecb34f4SJim Ingham   value.SetCompilerType(clang_void_pointer_type);
10301ecb34f4SJim Ingham   arguments.PushValue(value);
10311ecb34f4SJim Ingham   value.SetCompilerType(clang_char_pointer_type);
10321ecb34f4SJim Ingham   arguments.PushValue(value);
10330d231f71SJim Ingham   arguments.PushValue(value);
10340d231f71SJim Ingham   arguments.PushValue(value);
10351ecb34f4SJim Ingham 
10361ecb34f4SJim Ingham   do_dlopen_function = dlopen_utility_func_up->MakeFunctionCaller(
10371ecb34f4SJim Ingham       clang_void_pointer_type, arguments, exe_ctx.GetThreadSP(), utility_error);
10381ecb34f4SJim Ingham   if (utility_error.Fail()) {
10391ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not make function"
10401ecb34f4SJim Ingham                                    "caller: %s", utility_error.AsCString());
10411ecb34f4SJim Ingham     return nullptr;
10421ecb34f4SJim Ingham   }
10431ecb34f4SJim Ingham 
10441ecb34f4SJim Ingham   do_dlopen_function = dlopen_utility_func_up->GetFunctionCaller();
10451ecb34f4SJim Ingham   if (!do_dlopen_function) {
10461ecb34f4SJim Ingham     error.SetErrorString("dlopen error: could not get function caller.");
10471ecb34f4SJim Ingham     return nullptr;
10481ecb34f4SJim Ingham   }
10491ecb34f4SJim Ingham 
10501ecb34f4SJim Ingham   // We made a good utility function, so cache it in the process:
1051d10d3795SFrederic Riss   return dlopen_utility_func_up;
10521ecb34f4SJim Ingham }
10531ecb34f4SJim Ingham 
1054b9c1b51eSKate Stone uint32_t PlatformPOSIX::DoLoadImage(lldb_private::Process *process,
10554fbd67acSTamas Berghammer                                     const lldb_private::FileSpec &remote_file,
10560d231f71SJim Ingham                                     const std::vector<std::string> *paths,
10570d231f71SJim Ingham                                     lldb_private::Status &error,
10580d231f71SJim Ingham                                     lldb_private::FileSpec *loaded_image) {
10590d231f71SJim Ingham   if (loaded_image)
10600d231f71SJim Ingham     loaded_image->Clear();
10610d231f71SJim Ingham 
10621ecb34f4SJim Ingham   std::string path;
10631ecb34f4SJim Ingham   path = remote_file.GetPath();
10643cb132a0STamas Berghammer 
10651ecb34f4SJim Ingham   ThreadSP thread_sp = process->GetThreadList().GetExpressionExecutionThread();
10661ecb34f4SJim Ingham   if (!thread_sp) {
10671ecb34f4SJim Ingham     error.SetErrorString("dlopen error: no thread available to call dlopen.");
10683cb132a0STamas Berghammer     return LLDB_INVALID_IMAGE_TOKEN;
10693cb132a0STamas Berghammer   }
10703cb132a0STamas Berghammer 
10711ecb34f4SJim Ingham   DiagnosticManager diagnostics;
10723cb132a0STamas Berghammer 
10731ecb34f4SJim Ingham   ExecutionContext exe_ctx;
10741ecb34f4SJim Ingham   thread_sp->CalculateExecutionContext(exe_ctx);
10751ecb34f4SJim Ingham 
10761ecb34f4SJim Ingham   Status utility_error;
1077d10d3795SFrederic Riss   UtilityFunction *dlopen_utility_func;
10781ecb34f4SJim Ingham   ValueList arguments;
10791ecb34f4SJim Ingham   FunctionCaller *do_dlopen_function = nullptr;
10801ecb34f4SJim Ingham 
1081d10d3795SFrederic Riss   // The UtilityFunction is held in the Process.  Platforms don't track the
1082d10d3795SFrederic Riss   // lifespan of the Targets that use them, we can't put this in the Platform.
1083d10d3795SFrederic Riss   dlopen_utility_func = process->GetLoadImageUtilityFunction(
1084d10d3795SFrederic Riss       this, [&]() -> std::unique_ptr<UtilityFunction> {
1085d10d3795SFrederic Riss         return MakeLoadImageUtilityFunction(exe_ctx, error);
1086d10d3795SFrederic Riss       });
10871ecb34f4SJim Ingham   // If we couldn't make it, the error will be in error, so we can exit here.
10881ecb34f4SJim Ingham   if (!dlopen_utility_func)
10891ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
10901ecb34f4SJim Ingham 
10911ecb34f4SJim Ingham   do_dlopen_function = dlopen_utility_func->GetFunctionCaller();
10921ecb34f4SJim Ingham   if (!do_dlopen_function) {
10931ecb34f4SJim Ingham     error.SetErrorString("dlopen error: could not get function caller.");
10941ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
10951ecb34f4SJim Ingham   }
10961ecb34f4SJim Ingham   arguments = do_dlopen_function->GetArgumentValues();
10971ecb34f4SJim Ingham 
109805097246SAdrian Prantl   // Now insert the path we are searching for and the result structure into the
109905097246SAdrian Prantl   // target.
11001ecb34f4SJim Ingham   uint32_t permissions = ePermissionsReadable|ePermissionsWritable;
11011ecb34f4SJim Ingham   size_t path_len = path.size() + 1;
11021ecb34f4SJim Ingham   lldb::addr_t path_addr = process->AllocateMemory(path_len,
11031ecb34f4SJim Ingham                                                    permissions,
11041ecb34f4SJim Ingham                                                    utility_error);
11051ecb34f4SJim Ingham   if (path_addr == LLDB_INVALID_ADDRESS) {
11061ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not allocate memory"
11071ecb34f4SJim Ingham                                     "for path: %s", utility_error.AsCString());
11081ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
11091ecb34f4SJim Ingham   }
11101ecb34f4SJim Ingham 
11111ecb34f4SJim Ingham   // Make sure we deallocate the input string memory:
11121ecb34f4SJim Ingham   CleanUp path_cleanup([process, path_addr] {
11131ecb34f4SJim Ingham       process->DeallocateMemory(path_addr);
11141ecb34f4SJim Ingham   });
11151ecb34f4SJim Ingham 
11161ecb34f4SJim Ingham   process->WriteMemory(path_addr, path.c_str(), path_len, utility_error);
11171ecb34f4SJim Ingham   if (utility_error.Fail()) {
11181ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not write path string:"
11191ecb34f4SJim Ingham                                     " %s", utility_error.AsCString());
11201ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
11211ecb34f4SJim Ingham   }
11221ecb34f4SJim Ingham 
112305097246SAdrian Prantl   // Make space for our return structure.  It is two pointers big: the token
112405097246SAdrian Prantl   // and the error string.
11251ecb34f4SJim Ingham   const uint32_t addr_size = process->GetAddressByteSize();
11261ecb34f4SJim Ingham   lldb::addr_t return_addr = process->CallocateMemory(2*addr_size,
11271ecb34f4SJim Ingham                                                       permissions,
11281ecb34f4SJim Ingham                                                       utility_error);
11291ecb34f4SJim Ingham   if (utility_error.Fail()) {
11301ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not allocate memory"
11311ecb34f4SJim Ingham                                     "for path: %s", utility_error.AsCString());
11321ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
11331ecb34f4SJim Ingham   }
11341ecb34f4SJim Ingham 
11351ecb34f4SJim Ingham   // Make sure we deallocate the result structure memory
11361ecb34f4SJim Ingham   CleanUp return_cleanup([process, return_addr] {
11371ecb34f4SJim Ingham       process->DeallocateMemory(return_addr);
11381ecb34f4SJim Ingham   });
11391ecb34f4SJim Ingham 
11400d231f71SJim Ingham   // This will be the address of the storage for paths, if we are using them,
11410d231f71SJim Ingham   // or nullptr to signal we aren't.
11420d231f71SJim Ingham   lldb::addr_t path_array_addr = 0x0;
11430d231f71SJim Ingham   llvm::Optional<CleanUp> path_array_cleanup;
11440d231f71SJim Ingham 
11450d231f71SJim Ingham   // This is the address to a buffer large enough to hold the largest path
11460d231f71SJim Ingham   // conjoined with the library name we're passing in.  This is a convenience
11470d231f71SJim Ingham   // to avoid having to call malloc in the dlopen function.
11480d231f71SJim Ingham   lldb::addr_t buffer_addr = 0x0;
11490d231f71SJim Ingham   llvm::Optional<CleanUp> buffer_cleanup;
11500d231f71SJim Ingham 
11511ecb34f4SJim Ingham   // Set the values into our args and write them to the target:
11520d231f71SJim Ingham   if (paths != nullptr) {
11530d231f71SJim Ingham     // First insert the paths into the target.  This is expected to be a
11540d231f71SJim Ingham     // continuous buffer with the strings laid out null terminated and
11550d231f71SJim Ingham     // end to end with an empty string terminating the buffer.
11560d231f71SJim Ingham     // We also compute the buffer's required size as we go.
11570d231f71SJim Ingham     size_t buffer_size = 0;
11580d231f71SJim Ingham     std::string path_array;
11590d231f71SJim Ingham     for (auto path : *paths) {
116040fa4a1aSJim Ingham       // Don't insert empty paths, they will make us abort the path
116140fa4a1aSJim Ingham       // search prematurely.
116240fa4a1aSJim Ingham       if (path.empty())
116340fa4a1aSJim Ingham         continue;
11640d231f71SJim Ingham       size_t path_size = path.size();
11650d231f71SJim Ingham       path_array.append(path);
11660d231f71SJim Ingham       path_array.push_back('\0');
11670d231f71SJim Ingham       if (path_size > buffer_size)
11680d231f71SJim Ingham         buffer_size = path_size;
11690d231f71SJim Ingham     }
11700d231f71SJim Ingham     path_array.push_back('\0');
11710d231f71SJim Ingham 
11720d231f71SJim Ingham     path_array_addr = process->AllocateMemory(path_array.size(),
11730d231f71SJim Ingham                                               permissions,
11740d231f71SJim Ingham                                               utility_error);
11750d231f71SJim Ingham     if (path_array_addr == LLDB_INVALID_ADDRESS) {
11760d231f71SJim Ingham       error.SetErrorStringWithFormat("dlopen error: could not allocate memory"
11770d231f71SJim Ingham                                       "for path array: %s",
11780d231f71SJim Ingham                                       utility_error.AsCString());
11790d231f71SJim Ingham       return LLDB_INVALID_IMAGE_TOKEN;
11800d231f71SJim Ingham     }
11810d231f71SJim Ingham 
11820d231f71SJim Ingham     // Make sure we deallocate the paths array.
11830d231f71SJim Ingham     path_array_cleanup.emplace([process, path_array_addr] {
11840d231f71SJim Ingham         process->DeallocateMemory(path_array_addr);
11850d231f71SJim Ingham     });
11860d231f71SJim Ingham 
11870d231f71SJim Ingham     process->WriteMemory(path_array_addr, path_array.data(),
11880d231f71SJim Ingham                          path_array.size(), utility_error);
11890d231f71SJim Ingham 
11900d231f71SJim Ingham     if (utility_error.Fail()) {
11910d231f71SJim Ingham       error.SetErrorStringWithFormat("dlopen error: could not write path array:"
11920d231f71SJim Ingham                                      " %s", utility_error.AsCString());
11930d231f71SJim Ingham       return LLDB_INVALID_IMAGE_TOKEN;
11940d231f71SJim Ingham     }
11950d231f71SJim Ingham     // Now make spaces in the target for the buffer.  We need to add one for
11960d231f71SJim Ingham     // the '/' that the utility function will insert and one for the '\0':
11970d231f71SJim Ingham     buffer_size += path.size() + 2;
11980d231f71SJim Ingham 
11990d231f71SJim Ingham     buffer_addr = process->AllocateMemory(buffer_size,
12000d231f71SJim Ingham                                           permissions,
12010d231f71SJim Ingham                                           utility_error);
12020d231f71SJim Ingham     if (buffer_addr == LLDB_INVALID_ADDRESS) {
12030d231f71SJim Ingham       error.SetErrorStringWithFormat("dlopen error: could not allocate memory"
12040d231f71SJim Ingham                                       "for buffer: %s",
12050d231f71SJim Ingham                                       utility_error.AsCString());
12060d231f71SJim Ingham       return LLDB_INVALID_IMAGE_TOKEN;
12070d231f71SJim Ingham     }
12080d231f71SJim Ingham 
12090d231f71SJim Ingham     // Make sure we deallocate the buffer memory:
12100d231f71SJim Ingham     buffer_cleanup.emplace([process, buffer_addr] {
12110d231f71SJim Ingham         process->DeallocateMemory(buffer_addr);
12120d231f71SJim Ingham     });
12130d231f71SJim Ingham   }
12140d231f71SJim Ingham 
12151ecb34f4SJim Ingham   arguments.GetValueAtIndex(0)->GetScalar() = path_addr;
12160d231f71SJim Ingham   arguments.GetValueAtIndex(1)->GetScalar() = path_array_addr;
12170d231f71SJim Ingham   arguments.GetValueAtIndex(2)->GetScalar() = buffer_addr;
12180d231f71SJim Ingham   arguments.GetValueAtIndex(3)->GetScalar() = return_addr;
12191ecb34f4SJim Ingham 
12201ecb34f4SJim Ingham   lldb::addr_t func_args_addr = LLDB_INVALID_ADDRESS;
12211ecb34f4SJim Ingham 
12221ecb34f4SJim Ingham   diagnostics.Clear();
12231ecb34f4SJim Ingham   if (!do_dlopen_function->WriteFunctionArguments(exe_ctx,
12241ecb34f4SJim Ingham                                                  func_args_addr,
12251ecb34f4SJim Ingham                                                  arguments,
12261ecb34f4SJim Ingham                                                  diagnostics)) {
12271ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not write function "
12281ecb34f4SJim Ingham                                    "arguments: %s",
12291ecb34f4SJim Ingham                                    diagnostics.GetString().c_str());
12301ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
12311ecb34f4SJim Ingham   }
12321ecb34f4SJim Ingham 
12331ecb34f4SJim Ingham   // Make sure we clean up the args structure.  We can't reuse it because the
12341ecb34f4SJim Ingham   // Platform lives longer than the process and the Platforms don't get a
12351ecb34f4SJim Ingham   // signal to clean up cached data when a process goes away.
12361ecb34f4SJim Ingham   CleanUp args_cleanup([do_dlopen_function, &exe_ctx, func_args_addr] {
12371ecb34f4SJim Ingham     do_dlopen_function->DeallocateFunctionResults(exe_ctx, func_args_addr);
12381ecb34f4SJim Ingham   });
12391ecb34f4SJim Ingham 
12401ecb34f4SJim Ingham   // Now run the caller:
12411ecb34f4SJim Ingham   EvaluateExpressionOptions options;
12421ecb34f4SJim Ingham   options.SetExecutionPolicy(eExecutionPolicyAlways);
12431ecb34f4SJim Ingham   options.SetLanguage(eLanguageTypeC_plus_plus);
12441ecb34f4SJim Ingham   options.SetIgnoreBreakpoints(true);
12451ecb34f4SJim Ingham   options.SetUnwindOnError(true);
12461ecb34f4SJim Ingham   options.SetTrapExceptions(false); // dlopen can't throw exceptions, so
12471ecb34f4SJim Ingham                                     // don't do the work to trap them.
12481ecb34f4SJim Ingham   options.SetTimeout(std::chrono::seconds(2));
1249c01783a8SRaphael Isemann   options.SetIsForUtilityExpr(true);
12501ecb34f4SJim Ingham 
12511ecb34f4SJim Ingham   Value return_value;
12521ecb34f4SJim Ingham   // Fetch the clang types we will need:
12531ecb34f4SJim Ingham   ClangASTContext *ast = process->GetTarget().GetScratchClangASTContext();
12541ecb34f4SJim Ingham 
12551ecb34f4SJim Ingham   CompilerType clang_void_pointer_type
12561ecb34f4SJim Ingham       = ast->GetBasicType(eBasicTypeVoid).GetPointerType();
12571ecb34f4SJim Ingham 
12581ecb34f4SJim Ingham   return_value.SetCompilerType(clang_void_pointer_type);
12591ecb34f4SJim Ingham 
12601ecb34f4SJim Ingham   ExpressionResults results = do_dlopen_function->ExecuteFunction(
12611ecb34f4SJim Ingham       exe_ctx, &func_args_addr, options, diagnostics, return_value);
12621ecb34f4SJim Ingham   if (results != eExpressionCompleted) {
12630d231f71SJim Ingham     error.SetErrorStringWithFormat("dlopen error: failed executing "
12641ecb34f4SJim Ingham                                    "dlopen wrapper function: %s",
12651ecb34f4SJim Ingham                                    diagnostics.GetString().c_str());
12661ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
12671ecb34f4SJim Ingham   }
12681ecb34f4SJim Ingham 
12691ecb34f4SJim Ingham   // Read the dlopen token from the return area:
12701ecb34f4SJim Ingham   lldb::addr_t token = process->ReadPointerFromMemory(return_addr,
12711ecb34f4SJim Ingham                                                       utility_error);
12721ecb34f4SJim Ingham   if (utility_error.Fail()) {
12731ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not read the return "
12741ecb34f4SJim Ingham                                     "struct: %s", utility_error.AsCString());
12751ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
12761ecb34f4SJim Ingham   }
12771ecb34f4SJim Ingham 
12781ecb34f4SJim Ingham   // The dlopen succeeded!
12790d231f71SJim Ingham   if (token != 0x0) {
12800d231f71SJim Ingham     if (loaded_image && buffer_addr != 0x0)
12810d231f71SJim Ingham     {
12820d231f71SJim Ingham       // Capture the image which was loaded.  We leave it in the buffer on
12830d231f71SJim Ingham       // exit from the dlopen function, so we can just read it from there:
12840d231f71SJim Ingham       std::string name_string;
12850d231f71SJim Ingham       process->ReadCStringFromMemory(buffer_addr, name_string, utility_error);
12860d231f71SJim Ingham       if (utility_error.Success())
12870d231f71SJim Ingham         loaded_image->SetFile(name_string, false,
12880d231f71SJim Ingham                               llvm::sys::path::Style::posix);
12890d231f71SJim Ingham     }
12901ecb34f4SJim Ingham     return process->AddImageToken(token);
12910d231f71SJim Ingham   }
12921ecb34f4SJim Ingham 
12931ecb34f4SJim Ingham   // We got an error, lets read in the error string:
12941ecb34f4SJim Ingham   std::string dlopen_error_str;
12951ecb34f4SJim Ingham   lldb::addr_t error_addr
12961ecb34f4SJim Ingham     = process->ReadPointerFromMemory(return_addr + addr_size, utility_error);
12971ecb34f4SJim Ingham   if (utility_error.Fail()) {
12981ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not read error string: "
12991ecb34f4SJim Ingham                                     "%s", utility_error.AsCString());
13001ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
13011ecb34f4SJim Ingham   }
13021ecb34f4SJim Ingham 
13031ecb34f4SJim Ingham   size_t num_chars = process->ReadCStringFromMemory(error_addr + addr_size,
13041ecb34f4SJim Ingham                                                     dlopen_error_str,
13051ecb34f4SJim Ingham                                                     utility_error);
13061ecb34f4SJim Ingham   if (utility_error.Success() && num_chars > 0)
1307b9c1b51eSKate Stone     error.SetErrorStringWithFormat("dlopen error: %s",
13081ecb34f4SJim Ingham                                    dlopen_error_str.c_str());
13093cb132a0STamas Berghammer   else
13103cb132a0STamas Berghammer     error.SetErrorStringWithFormat("dlopen failed for unknown reasons.");
13111ecb34f4SJim Ingham 
13123cb132a0STamas Berghammer   return LLDB_INVALID_IMAGE_TOKEN;
13133cb132a0STamas Berghammer }
13143cb132a0STamas Berghammer 
131597206d57SZachary Turner Status PlatformPOSIX::UnloadImage(lldb_private::Process *process,
1316b9c1b51eSKate Stone                                   uint32_t image_token) {
13173cb132a0STamas Berghammer   const addr_t image_addr = process->GetImagePtrFromToken(image_token);
13183cb132a0STamas Berghammer   if (image_addr == LLDB_INVALID_ADDRESS)
131997206d57SZachary Turner     return Status("Invalid image token");
13203cb132a0STamas Berghammer 
13213cb132a0STamas Berghammer   StreamString expr;
13223cb132a0STamas Berghammer   expr.Printf("dlclose((void *)0x%" PRIx64 ")", image_addr);
1323f7a5851dSNitesh Jain   llvm::StringRef prefix = GetLibdlFunctionDeclarations(process);
13243cb132a0STamas Berghammer   lldb::ValueObjectSP result_valobj_sp;
132597206d57SZachary Turner   Status error = EvaluateLibdlExpression(process, expr.GetData(), prefix,
1326b9c1b51eSKate Stone                                          result_valobj_sp);
13273cb132a0STamas Berghammer   if (error.Fail())
13283cb132a0STamas Berghammer     return error;
13293cb132a0STamas Berghammer 
13303cb132a0STamas Berghammer   if (result_valobj_sp->GetError().Fail())
13313cb132a0STamas Berghammer     return result_valobj_sp->GetError();
13323cb132a0STamas Berghammer 
13333cb132a0STamas Berghammer   Scalar scalar;
1334b9c1b51eSKate Stone   if (result_valobj_sp->ResolveValue(scalar)) {
13353cb132a0STamas Berghammer     if (scalar.UInt(1))
133697206d57SZachary Turner       return Status("expression failed: \"%s\"", expr.GetData());
13373cb132a0STamas Berghammer     process->ResetImageToken(image_token);
13383cb132a0STamas Berghammer   }
133997206d57SZachary Turner   return Status();
13403cb132a0STamas Berghammer }
1341fcdde63fSTamas Berghammer 
13423165945aSZachary Turner lldb::ProcessSP PlatformPOSIX::ConnectProcess(llvm::StringRef connect_url,
13433165945aSZachary Turner                                               llvm::StringRef plugin_name,
1344ccd6cffbSTamas Berghammer                                               lldb_private::Debugger &debugger,
1345ccd6cffbSTamas Berghammer                                               lldb_private::Target *target,
134697206d57SZachary Turner                                               lldb_private::Status &error) {
1347ccd6cffbSTamas Berghammer   if (m_remote_platform_sp)
1348b9c1b51eSKate Stone     return m_remote_platform_sp->ConnectProcess(connect_url, plugin_name,
1349b9c1b51eSKate Stone                                                 debugger, target, error);
1350ccd6cffbSTamas Berghammer 
1351b9c1b51eSKate Stone   return Platform::ConnectProcess(connect_url, plugin_name, debugger, target,
1352b9c1b51eSKate Stone                                   error);
1353ccd6cffbSTamas Berghammer }
1354ccd6cffbSTamas Berghammer 
1355f7a5851dSNitesh Jain llvm::StringRef
1356f7a5851dSNitesh Jain PlatformPOSIX::GetLibdlFunctionDeclarations(lldb_private::Process *process) {
1357fcdde63fSTamas Berghammer   return R"(
1358fcdde63fSTamas Berghammer               extern "C" void* dlopen(const char*, int);
1359fcdde63fSTamas Berghammer               extern "C" void* dlsym(void*, const char*);
1360fcdde63fSTamas Berghammer               extern "C" int   dlclose(void*);
1361fcdde63fSTamas Berghammer               extern "C" char* dlerror(void);
1362fcdde63fSTamas Berghammer              )";
1363fcdde63fSTamas Berghammer }
1364ccd6cffbSTamas Berghammer 
1365b9c1b51eSKate Stone size_t PlatformPOSIX::ConnectToWaitingProcesses(Debugger &debugger,
136697206d57SZachary Turner                                                 Status &error) {
1367ccd6cffbSTamas Berghammer   if (m_remote_platform_sp)
1368ccd6cffbSTamas Berghammer     return m_remote_platform_sp->ConnectToWaitingProcesses(debugger, error);
1369ccd6cffbSTamas Berghammer   return Platform::ConnectToWaitingProcesses(debugger, error);
1370ccd6cffbSTamas Berghammer }
1371ec9bc8ccSPavel Labath 
1372ec9bc8ccSPavel Labath ConstString PlatformPOSIX::GetFullNameForDylib(ConstString basename) {
1373ec9bc8ccSPavel Labath   if (basename.IsEmpty())
1374ec9bc8ccSPavel Labath     return basename;
1375ec9bc8ccSPavel Labath 
1376ec9bc8ccSPavel Labath   StreamString stream;
1377ec9bc8ccSPavel Labath   stream.Printf("lib%s.so", basename.GetCString());
1378ec9bc8ccSPavel Labath   return ConstString(stream.GetString());
1379ec9bc8ccSPavel Labath }
1380