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())
138fc89bbccSPavel Labath       resolved_module_spec.GetFileSpec().ResolveExecutableLocation();
139fc89bbccSPavel Labath 
140fc89bbccSPavel Labath     // Resolve any executable within a bundle on MacOSX
141fc89bbccSPavel Labath     Host::ResolveExecutableInBundle(resolved_module_spec.GetFileSpec());
142fc89bbccSPavel Labath 
143fc89bbccSPavel Labath     if (resolved_module_spec.GetFileSpec().Exists())
144fc89bbccSPavel Labath       error.Clear();
145fc89bbccSPavel Labath     else {
146*7c5310bbSJonas Devlieghere       const uint32_t permissions = FileSystem::Instance().GetPermissions(
147*7c5310bbSJonas Devlieghere           resolved_module_spec.GetFileSpec());
148fc89bbccSPavel Labath       if (permissions && (permissions & eFilePermissionsEveryoneR) == 0)
149fc89bbccSPavel Labath         error.SetErrorStringWithFormat(
150fc89bbccSPavel Labath             "executable '%s' is not readable",
151fc89bbccSPavel Labath             resolved_module_spec.GetFileSpec().GetPath().c_str());
152fc89bbccSPavel Labath       else
153fc89bbccSPavel Labath         error.SetErrorStringWithFormat(
154fc89bbccSPavel Labath             "unable to find executable for '%s'",
155fc89bbccSPavel Labath             resolved_module_spec.GetFileSpec().GetPath().c_str());
156fc89bbccSPavel Labath     }
157fc89bbccSPavel Labath   } else {
158fc89bbccSPavel Labath     if (m_remote_platform_sp) {
159fc89bbccSPavel Labath       error =
160fc89bbccSPavel Labath           GetCachedExecutable(resolved_module_spec, exe_module_sp,
161fc89bbccSPavel Labath                               module_search_paths_ptr, *m_remote_platform_sp);
162fc89bbccSPavel Labath     } else {
163fc89bbccSPavel Labath       // We may connect to a process and use the provided executable (Don't use
164fc89bbccSPavel Labath       // local $PATH).
165fc89bbccSPavel Labath 
166fc89bbccSPavel Labath       // Resolve any executable within a bundle on MacOSX
167fc89bbccSPavel Labath       Host::ResolveExecutableInBundle(resolved_module_spec.GetFileSpec());
168fc89bbccSPavel Labath 
169fc89bbccSPavel Labath       if (resolved_module_spec.GetFileSpec().Exists())
170fc89bbccSPavel Labath         error.Clear();
171fc89bbccSPavel Labath       else
172fc89bbccSPavel Labath         error.SetErrorStringWithFormat("the platform is not currently "
173fc89bbccSPavel Labath                                        "connected, and '%s' doesn't exist in "
174fc89bbccSPavel Labath                                        "the system root.",
175fc89bbccSPavel Labath                                        exe_path);
176fc89bbccSPavel Labath     }
177fc89bbccSPavel Labath   }
178fc89bbccSPavel Labath 
179fc89bbccSPavel Labath   if (error.Success()) {
180fc89bbccSPavel Labath     if (resolved_module_spec.GetArchitecture().IsValid()) {
181fc89bbccSPavel Labath       error = ModuleList::GetSharedModule(resolved_module_spec, exe_module_sp,
182fc89bbccSPavel Labath                                           module_search_paths_ptr, nullptr, nullptr);
183fc89bbccSPavel Labath       if (error.Fail()) {
184fc89bbccSPavel Labath         // If we failed, it may be because the vendor and os aren't known. If
185fc89bbccSPavel Labath 	// that is the case, try setting them to the host architecture and give
186fc89bbccSPavel Labath 	// it another try.
187fc89bbccSPavel Labath         llvm::Triple &module_triple =
188fc89bbccSPavel Labath             resolved_module_spec.GetArchitecture().GetTriple();
189fc89bbccSPavel Labath         bool is_vendor_specified =
190fc89bbccSPavel Labath             (module_triple.getVendor() != llvm::Triple::UnknownVendor);
191fc89bbccSPavel Labath         bool is_os_specified =
192fc89bbccSPavel Labath             (module_triple.getOS() != llvm::Triple::UnknownOS);
193fc89bbccSPavel Labath         if (!is_vendor_specified || !is_os_specified) {
194fc89bbccSPavel Labath           const llvm::Triple &host_triple =
195fc89bbccSPavel Labath               HostInfo::GetArchitecture(HostInfo::eArchKindDefault).GetTriple();
196fc89bbccSPavel Labath 
197fc89bbccSPavel Labath           if (!is_vendor_specified)
198fc89bbccSPavel Labath             module_triple.setVendorName(host_triple.getVendorName());
199fc89bbccSPavel Labath           if (!is_os_specified)
200fc89bbccSPavel Labath             module_triple.setOSName(host_triple.getOSName());
201fc89bbccSPavel Labath 
202fc89bbccSPavel Labath           error = ModuleList::GetSharedModule(resolved_module_spec,
203fc89bbccSPavel Labath                                               exe_module_sp, module_search_paths_ptr, nullptr, nullptr);
204fc89bbccSPavel Labath         }
205fc89bbccSPavel Labath       }
206fc89bbccSPavel Labath 
207fc89bbccSPavel Labath       // TODO find out why exe_module_sp might be NULL
208fc89bbccSPavel Labath       if (error.Fail() || !exe_module_sp || !exe_module_sp->GetObjectFile()) {
209fc89bbccSPavel Labath         exe_module_sp.reset();
210fc89bbccSPavel Labath         error.SetErrorStringWithFormat(
211fc89bbccSPavel Labath             "'%s' doesn't contain the architecture %s",
212fc89bbccSPavel Labath             resolved_module_spec.GetFileSpec().GetPath().c_str(),
213fc89bbccSPavel Labath             resolved_module_spec.GetArchitecture().GetArchitectureName());
214fc89bbccSPavel Labath       }
215fc89bbccSPavel Labath     } else {
21605097246SAdrian Prantl       // No valid architecture was specified, ask the platform for the
21705097246SAdrian Prantl       // architectures that we should be using (in the correct order) and see
21805097246SAdrian Prantl       // if we can find a match that way
219fc89bbccSPavel Labath       StreamString arch_names;
220fc89bbccSPavel Labath       for (uint32_t idx = 0; GetSupportedArchitectureAtIndex(
221fc89bbccSPavel Labath                idx, resolved_module_spec.GetArchitecture());
222fc89bbccSPavel Labath            ++idx) {
223fc89bbccSPavel Labath         error = ModuleList::GetSharedModule(resolved_module_spec, exe_module_sp,
224fc89bbccSPavel Labath                                             module_search_paths_ptr, nullptr, nullptr);
225fc89bbccSPavel Labath         // Did we find an executable using one of the
226fc89bbccSPavel Labath         if (error.Success()) {
227fc89bbccSPavel Labath           if (exe_module_sp && exe_module_sp->GetObjectFile())
228fc89bbccSPavel Labath             break;
229fc89bbccSPavel Labath           else
230fc89bbccSPavel Labath             error.SetErrorToGenericError();
231fc89bbccSPavel Labath         }
232fc89bbccSPavel Labath 
233fc89bbccSPavel Labath         if (idx > 0)
234fc89bbccSPavel Labath           arch_names.PutCString(", ");
235fc89bbccSPavel Labath         arch_names.PutCString(
236fc89bbccSPavel Labath             resolved_module_spec.GetArchitecture().GetArchitectureName());
237fc89bbccSPavel Labath       }
238fc89bbccSPavel Labath 
239fc89bbccSPavel Labath       if (error.Fail() || !exe_module_sp) {
240*7c5310bbSJonas Devlieghere         if (FileSystem::Instance().Readable(
241*7c5310bbSJonas Devlieghere                 resolved_module_spec.GetFileSpec())) {
242fc89bbccSPavel Labath           error.SetErrorStringWithFormat(
243fc89bbccSPavel Labath               "'%s' doesn't contain any '%s' platform architectures: %s",
244fc89bbccSPavel Labath               resolved_module_spec.GetFileSpec().GetPath().c_str(),
245fc89bbccSPavel Labath               GetPluginName().GetCString(), arch_names.GetData());
246fc89bbccSPavel Labath         } else {
247fc89bbccSPavel Labath           error.SetErrorStringWithFormat(
248fc89bbccSPavel Labath               "'%s' is not readable",
249fc89bbccSPavel Labath               resolved_module_spec.GetFileSpec().GetPath().c_str());
250fc89bbccSPavel Labath         }
251fc89bbccSPavel Labath       }
252fc89bbccSPavel Labath     }
253fc89bbccSPavel Labath   }
254fc89bbccSPavel Labath 
255fc89bbccSPavel Labath   return error;
256fc89bbccSPavel Labath }
257fc89bbccSPavel Labath 
25897206d57SZachary Turner Status PlatformPOSIX::GetFileWithUUID(const FileSpec &platform_file,
259ec9bc8ccSPavel Labath                                       const UUID *uuid_ptr,
260ec9bc8ccSPavel Labath                                       FileSpec &local_file) {
261ec9bc8ccSPavel Labath   if (IsRemote() && m_remote_platform_sp)
262ec9bc8ccSPavel Labath       return m_remote_platform_sp->GetFileWithUUID(platform_file, uuid_ptr,
263ec9bc8ccSPavel Labath                                                    local_file);
264ec9bc8ccSPavel Labath 
265ec9bc8ccSPavel Labath   // Default to the local case
266ec9bc8ccSPavel Labath   local_file = platform_file;
26797206d57SZachary Turner   return Status();
268ec9bc8ccSPavel Labath }
269ec9bc8ccSPavel Labath 
270ec9bc8ccSPavel Labath bool PlatformPOSIX::GetProcessInfo(lldb::pid_t pid,
271ec9bc8ccSPavel Labath                                      ProcessInstanceInfo &process_info) {
272ec9bc8ccSPavel Labath   if (IsHost())
273ec9bc8ccSPavel Labath     return Platform::GetProcessInfo(pid, process_info);
274ec9bc8ccSPavel Labath   if (m_remote_platform_sp)
275ec9bc8ccSPavel Labath     return m_remote_platform_sp->GetProcessInfo(pid, process_info);
276ec9bc8ccSPavel Labath   return false;
277ec9bc8ccSPavel Labath }
278ec9bc8ccSPavel Labath 
279ec9bc8ccSPavel Labath uint32_t
280ec9bc8ccSPavel Labath PlatformPOSIX::FindProcesses(const ProcessInstanceInfoMatch &match_info,
281ec9bc8ccSPavel Labath                                ProcessInstanceInfoList &process_infos) {
282ec9bc8ccSPavel Labath   if (IsHost())
283ec9bc8ccSPavel Labath     return Platform::FindProcesses(match_info, process_infos);
284ec9bc8ccSPavel Labath   if (m_remote_platform_sp)
285ec9bc8ccSPavel Labath     return
286ec9bc8ccSPavel Labath       m_remote_platform_sp->FindProcesses(match_info, process_infos);
287ec9bc8ccSPavel Labath   return 0;
288ec9bc8ccSPavel Labath }
289ec9bc8ccSPavel Labath 
29097206d57SZachary Turner Status PlatformPOSIX::MakeDirectory(const FileSpec &file_spec,
291b9c1b51eSKate Stone                                     uint32_t file_permissions) {
292fbb76349SGreg Clayton   if (m_remote_platform_sp)
293d3173f34SChaoren Lin     return m_remote_platform_sp->MakeDirectory(file_spec, file_permissions);
294fbb76349SGreg Clayton   else
295d3173f34SChaoren Lin     return Platform::MakeDirectory(file_spec, file_permissions);
296e0f8f574SDaniel Malea }
297fbb76349SGreg Clayton 
29897206d57SZachary Turner Status PlatformPOSIX::GetFilePermissions(const FileSpec &file_spec,
299b9c1b51eSKate Stone                                          uint32_t &file_permissions) {
300fbb76349SGreg Clayton   if (m_remote_platform_sp)
301b9c1b51eSKate Stone     return m_remote_platform_sp->GetFilePermissions(file_spec,
302b9c1b51eSKate Stone                                                     file_permissions);
303fbb76349SGreg Clayton   else
304d3173f34SChaoren Lin     return Platform::GetFilePermissions(file_spec, file_permissions);
305fbb76349SGreg Clayton }
306fbb76349SGreg Clayton 
30797206d57SZachary Turner Status PlatformPOSIX::SetFilePermissions(const FileSpec &file_spec,
308b9c1b51eSKate Stone                                          uint32_t file_permissions) {
309fbb76349SGreg Clayton   if (m_remote_platform_sp)
310b9c1b51eSKate Stone     return m_remote_platform_sp->SetFilePermissions(file_spec,
311b9c1b51eSKate Stone                                                     file_permissions);
312fbb76349SGreg Clayton   else
313d3173f34SChaoren Lin     return Platform::SetFilePermissions(file_spec, file_permissions);
314e0f8f574SDaniel Malea }
315e0f8f574SDaniel Malea 
316b9c1b51eSKate Stone lldb::user_id_t PlatformPOSIX::OpenFile(const FileSpec &file_spec,
317b9c1b51eSKate Stone                                         uint32_t flags, uint32_t mode,
31897206d57SZachary Turner                                         Status &error) {
319e0f8f574SDaniel Malea   if (IsHost())
320c00cf4a0SZachary Turner     return FileCache::GetInstance().OpenFile(file_spec, flags, mode, error);
321fbb76349SGreg Clayton   else if (m_remote_platform_sp)
322e0f8f574SDaniel Malea     return m_remote_platform_sp->OpenFile(file_spec, flags, mode, error);
323fbb76349SGreg Clayton   else
324e0f8f574SDaniel Malea     return Platform::OpenFile(file_spec, flags, mode, error);
325e0f8f574SDaniel Malea }
326e0f8f574SDaniel Malea 
32797206d57SZachary Turner bool PlatformPOSIX::CloseFile(lldb::user_id_t fd, Status &error) {
328e0f8f574SDaniel Malea   if (IsHost())
329c00cf4a0SZachary Turner     return FileCache::GetInstance().CloseFile(fd, error);
330fbb76349SGreg Clayton   else if (m_remote_platform_sp)
331e0f8f574SDaniel Malea     return m_remote_platform_sp->CloseFile(fd, error);
332fbb76349SGreg Clayton   else
333e0f8f574SDaniel Malea     return Platform::CloseFile(fd, error);
334e0f8f574SDaniel Malea }
335e0f8f574SDaniel Malea 
336b9c1b51eSKate Stone uint64_t PlatformPOSIX::ReadFile(lldb::user_id_t fd, uint64_t offset, void *dst,
33797206d57SZachary Turner                                  uint64_t dst_len, Status &error) {
338e0f8f574SDaniel Malea   if (IsHost())
339c00cf4a0SZachary Turner     return FileCache::GetInstance().ReadFile(fd, offset, dst, dst_len, error);
340fbb76349SGreg Clayton   else if (m_remote_platform_sp)
341e0f8f574SDaniel Malea     return m_remote_platform_sp->ReadFile(fd, offset, dst, dst_len, error);
342fbb76349SGreg Clayton   else
343e0f8f574SDaniel Malea     return Platform::ReadFile(fd, offset, dst, dst_len, error);
344e0f8f574SDaniel Malea }
345e0f8f574SDaniel Malea 
346b9c1b51eSKate Stone uint64_t PlatformPOSIX::WriteFile(lldb::user_id_t fd, uint64_t offset,
347b9c1b51eSKate Stone                                   const void *src, uint64_t src_len,
34897206d57SZachary Turner                                   Status &error) {
349e0f8f574SDaniel Malea   if (IsHost())
350c00cf4a0SZachary Turner     return FileCache::GetInstance().WriteFile(fd, offset, src, src_len, error);
351fbb76349SGreg Clayton   else if (m_remote_platform_sp)
352e0f8f574SDaniel Malea     return m_remote_platform_sp->WriteFile(fd, offset, src, src_len, error);
353fbb76349SGreg Clayton   else
354e0f8f574SDaniel Malea     return Platform::WriteFile(fd, offset, src, src_len, error);
355e0f8f574SDaniel Malea }
356e0f8f574SDaniel Malea 
357b9c1b51eSKate Stone static uint32_t chown_file(Platform *platform, const char *path,
358e0f8f574SDaniel Malea                            uint32_t uid = UINT32_MAX,
359b9c1b51eSKate Stone                            uint32_t gid = UINT32_MAX) {
360e0f8f574SDaniel Malea   if (!platform || !path || *path == 0)
361e0f8f574SDaniel Malea     return UINT32_MAX;
362e0f8f574SDaniel Malea 
363e0f8f574SDaniel Malea   if (uid == UINT32_MAX && gid == UINT32_MAX)
364e0f8f574SDaniel Malea     return 0; // pretend I did chown correctly - actually I just didn't care
365e0f8f574SDaniel Malea 
366e0f8f574SDaniel Malea   StreamString command;
367e0f8f574SDaniel Malea   command.PutCString("chown ");
368e0f8f574SDaniel Malea   if (uid != UINT32_MAX)
369e0f8f574SDaniel Malea     command.Printf("%d", uid);
370e0f8f574SDaniel Malea   if (gid != UINT32_MAX)
371e0f8f574SDaniel Malea     command.Printf(":%d", gid);
372e0f8f574SDaniel Malea   command.Printf("%s", path);
373e0f8f574SDaniel Malea   int status;
37419dd1a0eSPavel Labath   platform->RunShellCommand(command.GetData(), NULL, &status, NULL, NULL,
37519dd1a0eSPavel Labath                             std::chrono::seconds(10));
376e0f8f574SDaniel Malea   return status;
377e0f8f574SDaniel Malea }
378e0f8f574SDaniel Malea 
37997206d57SZachary Turner lldb_private::Status
380e0f8f574SDaniel Malea PlatformPOSIX::PutFile(const lldb_private::FileSpec &source,
381b9c1b51eSKate Stone                        const lldb_private::FileSpec &destination, uint32_t uid,
382b9c1b51eSKate Stone                        uint32_t gid) {
383fbb76349SGreg Clayton   Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM));
384fbb76349SGreg Clayton 
385b9c1b51eSKate Stone   if (IsHost()) {
386e0f8f574SDaniel Malea     if (FileSpec::Equal(source, destination, true))
38797206d57SZachary Turner       return Status();
388e0f8f574SDaniel Malea     // cp src dst
389e0f8f574SDaniel Malea     // chown uid:gid dst
390e0f8f574SDaniel Malea     std::string src_path(source.GetPath());
391e0f8f574SDaniel Malea     if (src_path.empty())
39297206d57SZachary Turner       return Status("unable to get file path for source");
393e0f8f574SDaniel Malea     std::string dst_path(destination.GetPath());
394e0f8f574SDaniel Malea     if (dst_path.empty())
39597206d57SZachary Turner       return Status("unable to get file path for destination");
396e0f8f574SDaniel Malea     StreamString command;
397e0f8f574SDaniel Malea     command.Printf("cp %s %s", src_path.c_str(), dst_path.c_str());
398e0f8f574SDaniel Malea     int status;
39919dd1a0eSPavel Labath     RunShellCommand(command.GetData(), NULL, &status, NULL, NULL,
40019dd1a0eSPavel Labath                     std::chrono::seconds(10));
401e0f8f574SDaniel Malea     if (status != 0)
40297206d57SZachary Turner       return Status("unable to perform copy");
403e0f8f574SDaniel Malea     if (uid == UINT32_MAX && gid == UINT32_MAX)
40497206d57SZachary Turner       return Status();
405e0f8f574SDaniel Malea     if (chown_file(this, dst_path.c_str(), uid, gid) != 0)
40697206d57SZachary Turner       return Status("unable to perform chown");
40797206d57SZachary Turner     return Status();
408b9c1b51eSKate Stone   } else if (m_remote_platform_sp) {
409b9c1b51eSKate Stone     if (GetSupportsRSync()) {
410e0f8f574SDaniel Malea       std::string src_path(source.GetPath());
411e0f8f574SDaniel Malea       if (src_path.empty())
41297206d57SZachary Turner         return Status("unable to get file path for source");
413e0f8f574SDaniel Malea       std::string dst_path(destination.GetPath());
414e0f8f574SDaniel Malea       if (dst_path.empty())
41597206d57SZachary Turner         return Status("unable to get file path for destination");
416e0f8f574SDaniel Malea       StreamString command;
417b9c1b51eSKate Stone       if (GetIgnoresRemoteHostname()) {
418e0f8f574SDaniel Malea         if (!GetRSyncPrefix())
419b9c1b51eSKate Stone           command.Printf("rsync %s %s %s", GetRSyncOpts(), src_path.c_str(),
420e0f8f574SDaniel Malea                          dst_path.c_str());
421e0f8f574SDaniel Malea         else
422b9c1b51eSKate Stone           command.Printf("rsync %s %s %s%s", GetRSyncOpts(), src_path.c_str(),
423b9c1b51eSKate Stone                          GetRSyncPrefix(), dst_path.c_str());
424b9c1b51eSKate Stone       } else
425b9c1b51eSKate Stone         command.Printf("rsync %s %s %s:%s", GetRSyncOpts(), src_path.c_str(),
426b9c1b51eSKate Stone                        GetHostname(), dst_path.c_str());
427e0f8f574SDaniel Malea       if (log)
428e0f8f574SDaniel Malea         log->Printf("[PutFile] Running command: %s\n", command.GetData());
429e0f8f574SDaniel Malea       int retcode;
43019dd1a0eSPavel Labath       Host::RunShellCommand(command.GetData(), NULL, &retcode, NULL, NULL,
43119dd1a0eSPavel Labath                             std::chrono::minutes(1));
432b9c1b51eSKate Stone       if (retcode == 0) {
433e0f8f574SDaniel Malea         // Don't chown a local file for a remote system
434e0f8f574SDaniel Malea         //                if (chown_file(this,dst_path.c_str(),uid,gid) != 0)
43597206d57SZachary Turner         //                    return Status("unable to perform chown");
43697206d57SZachary Turner         return Status();
437e0f8f574SDaniel Malea       }
438b9c1b51eSKate Stone       // if we are still here rsync has failed - let's try the slow way before
439b9c1b51eSKate Stone       // giving up
440e0f8f574SDaniel Malea     }
441e0f8f574SDaniel Malea   }
442e0f8f574SDaniel Malea   return Platform::PutFile(source, destination, uid, gid);
443e0f8f574SDaniel Malea }
444e0f8f574SDaniel Malea 
445b9c1b51eSKate Stone lldb::user_id_t PlatformPOSIX::GetFileSize(const FileSpec &file_spec) {
44607db3f7eSZachary Turner   if (IsHost()) {
44707db3f7eSZachary Turner     uint64_t Size;
44807db3f7eSZachary Turner     if (llvm::sys::fs::file_size(file_spec.GetPath(), Size))
44907db3f7eSZachary Turner       return 0;
45007db3f7eSZachary Turner     return Size;
45107db3f7eSZachary Turner   } else if (m_remote_platform_sp)
452e0f8f574SDaniel Malea     return m_remote_platform_sp->GetFileSize(file_spec);
453fbb76349SGreg Clayton   else
454e0f8f574SDaniel Malea     return Platform::GetFileSize(file_spec);
455e0f8f574SDaniel Malea }
456e0f8f574SDaniel Malea 
45797206d57SZachary Turner Status PlatformPOSIX::CreateSymlink(const FileSpec &src, const FileSpec &dst) {
458fbb76349SGreg Clayton   if (IsHost())
45946376966SJonas Devlieghere     return FileSystem::Instance().Symlink(src, dst);
460fbb76349SGreg Clayton   else if (m_remote_platform_sp)
461fbb76349SGreg Clayton     return m_remote_platform_sp->CreateSymlink(src, dst);
462fbb76349SGreg Clayton   else
463fbb76349SGreg Clayton     return Platform::CreateSymlink(src, dst);
464fbb76349SGreg Clayton }
465fbb76349SGreg Clayton 
466b9c1b51eSKate Stone bool PlatformPOSIX::GetFileExists(const FileSpec &file_spec) {
467e0f8f574SDaniel Malea   if (IsHost())
468e0f8f574SDaniel Malea     return file_spec.Exists();
469fbb76349SGreg Clayton   else if (m_remote_platform_sp)
470e0f8f574SDaniel Malea     return m_remote_platform_sp->GetFileExists(file_spec);
471fbb76349SGreg Clayton   else
472e0f8f574SDaniel Malea     return Platform::GetFileExists(file_spec);
473e0f8f574SDaniel Malea }
474e0f8f574SDaniel Malea 
47597206d57SZachary Turner Status PlatformPOSIX::Unlink(const FileSpec &file_spec) {
476e0f8f574SDaniel Malea   if (IsHost())
47707db3f7eSZachary Turner     return llvm::sys::fs::remove(file_spec.GetPath());
478fbb76349SGreg Clayton   else if (m_remote_platform_sp)
479d3173f34SChaoren Lin     return m_remote_platform_sp->Unlink(file_spec);
480fbb76349SGreg Clayton   else
481d3173f34SChaoren Lin     return Platform::Unlink(file_spec);
482e0f8f574SDaniel Malea }
483e0f8f574SDaniel Malea 
48497206d57SZachary Turner lldb_private::Status PlatformPOSIX::GetFile(
485b9c1b51eSKate Stone     const lldb_private::FileSpec &source,      // remote file path
486d3173f34SChaoren Lin     const lldb_private::FileSpec &destination) // local file path
487e0f8f574SDaniel Malea {
488fbb76349SGreg Clayton   Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM));
489fbb76349SGreg Clayton 
490e0f8f574SDaniel Malea   // Check the args, first.
491e0f8f574SDaniel Malea   std::string src_path(source.GetPath());
492e0f8f574SDaniel Malea   if (src_path.empty())
49397206d57SZachary Turner     return Status("unable to get file path for source");
494e0f8f574SDaniel Malea   std::string dst_path(destination.GetPath());
495e0f8f574SDaniel Malea   if (dst_path.empty())
49697206d57SZachary Turner     return Status("unable to get file path for destination");
497b9c1b51eSKate Stone   if (IsHost()) {
498e0f8f574SDaniel Malea     if (FileSpec::Equal(source, destination, true))
49997206d57SZachary Turner       return Status("local scenario->source and destination are the same file "
500b9c1b51eSKate Stone                     "path: no operation performed");
501e0f8f574SDaniel Malea     // cp src dst
502e0f8f574SDaniel Malea     StreamString cp_command;
503e0f8f574SDaniel Malea     cp_command.Printf("cp %s %s", src_path.c_str(), dst_path.c_str());
504e0f8f574SDaniel Malea     int status;
50519dd1a0eSPavel Labath     RunShellCommand(cp_command.GetData(), NULL, &status, NULL, NULL,
50619dd1a0eSPavel Labath                     std::chrono::seconds(10));
507e0f8f574SDaniel Malea     if (status != 0)
50897206d57SZachary Turner       return Status("unable to perform copy");
50997206d57SZachary Turner     return Status();
510b9c1b51eSKate Stone   } else if (m_remote_platform_sp) {
511b9c1b51eSKate Stone     if (GetSupportsRSync()) {
512e0f8f574SDaniel Malea       StreamString command;
513b9c1b51eSKate Stone       if (GetIgnoresRemoteHostname()) {
514e0f8f574SDaniel Malea         if (!GetRSyncPrefix())
515b9c1b51eSKate Stone           command.Printf("rsync %s %s %s", GetRSyncOpts(), src_path.c_str(),
516e0f8f574SDaniel Malea                          dst_path.c_str());
517e0f8f574SDaniel Malea         else
518b9c1b51eSKate Stone           command.Printf("rsync %s %s%s %s", GetRSyncOpts(), GetRSyncPrefix(),
519b9c1b51eSKate Stone                          src_path.c_str(), dst_path.c_str());
520b9c1b51eSKate Stone       } else
521b9c1b51eSKate Stone         command.Printf("rsync %s %s:%s %s", GetRSyncOpts(),
522b9c1b51eSKate Stone                        m_remote_platform_sp->GetHostname(), src_path.c_str(),
523e0f8f574SDaniel Malea                        dst_path.c_str());
524e0f8f574SDaniel Malea       if (log)
525e0f8f574SDaniel Malea         log->Printf("[GetFile] Running command: %s\n", command.GetData());
526e0f8f574SDaniel Malea       int retcode;
52719dd1a0eSPavel Labath       Host::RunShellCommand(command.GetData(), NULL, &retcode, NULL, NULL,
52819dd1a0eSPavel Labath                             std::chrono::minutes(1));
529e0f8f574SDaniel Malea       if (retcode == 0)
53097206d57SZachary Turner         return Status();
53105097246SAdrian Prantl       // If we are here, rsync has failed - let's try the slow way before
53205097246SAdrian Prantl       // giving up
533e0f8f574SDaniel Malea     }
534e0f8f574SDaniel Malea     // open src and dst
535e0f8f574SDaniel Malea     // read/write, read/write, read/write, ...
536e0f8f574SDaniel Malea     // close src
537e0f8f574SDaniel Malea     // close dst
538e0f8f574SDaniel Malea     if (log)
539e0f8f574SDaniel Malea       log->Printf("[GetFile] Using block by block transfer....\n");
54097206d57SZachary Turner     Status error;
541b9c1b51eSKate Stone     user_id_t fd_src = OpenFile(source, File::eOpenOptionRead,
542b9c1b51eSKate Stone                                 lldb::eFilePermissionsFileDefault, error);
543e0f8f574SDaniel Malea 
544e0f8f574SDaniel Malea     if (fd_src == UINT64_MAX)
54597206d57SZachary Turner       return Status("unable to open source file");
546e0f8f574SDaniel Malea 
547fbb76349SGreg Clayton     uint32_t permissions = 0;
548d3173f34SChaoren Lin     error = GetFilePermissions(source, permissions);
549e0f8f574SDaniel Malea 
550e0f8f574SDaniel Malea     if (permissions == 0)
551fbb76349SGreg Clayton       permissions = lldb::eFilePermissionsFileDefault;
552e0f8f574SDaniel Malea 
553c00cf4a0SZachary Turner     user_id_t fd_dst = FileCache::GetInstance().OpenFile(
554b9c1b51eSKate Stone         destination, File::eOpenOptionCanCreate | File::eOpenOptionWrite |
555b9c1b51eSKate Stone                          File::eOpenOptionTruncate,
556b9c1b51eSKate Stone         permissions, error);
557e0f8f574SDaniel Malea 
558b9c1b51eSKate Stone     if (fd_dst == UINT64_MAX) {
559e0f8f574SDaniel Malea       if (error.Success())
560e0f8f574SDaniel Malea         error.SetErrorString("unable to open destination file");
561e0f8f574SDaniel Malea     }
562e0f8f574SDaniel Malea 
563b9c1b51eSKate Stone     if (error.Success()) {
564e0f8f574SDaniel Malea       lldb::DataBufferSP buffer_sp(new DataBufferHeap(1024, 0));
565e0f8f574SDaniel Malea       uint64_t offset = 0;
566e0f8f574SDaniel Malea       error.Clear();
567b9c1b51eSKate Stone       while (error.Success()) {
568b9c1b51eSKate Stone         const uint64_t n_read = ReadFile(fd_src, offset, buffer_sp->GetBytes(),
569b9c1b51eSKate Stone                                          buffer_sp->GetByteSize(), error);
570e0f8f574SDaniel Malea         if (error.Fail())
571e0f8f574SDaniel Malea           break;
572e0f8f574SDaniel Malea         if (n_read == 0)
573e0f8f574SDaniel Malea           break;
574b9c1b51eSKate Stone         if (FileCache::GetInstance().WriteFile(fd_dst, offset,
575b9c1b51eSKate Stone                                                buffer_sp->GetBytes(), n_read,
576b9c1b51eSKate Stone                                                error) != n_read) {
577e0f8f574SDaniel Malea           if (!error.Fail())
578e0f8f574SDaniel Malea             error.SetErrorString("unable to write to destination file");
579e0f8f574SDaniel Malea           break;
580e0f8f574SDaniel Malea         }
581e0f8f574SDaniel Malea         offset += n_read;
582e0f8f574SDaniel Malea       }
583e0f8f574SDaniel Malea     }
584e0f8f574SDaniel Malea     // Ignore the close error of src.
585e0f8f574SDaniel Malea     if (fd_src != UINT64_MAX)
586e0f8f574SDaniel Malea       CloseFile(fd_src, error);
587e0f8f574SDaniel Malea     // And close the dst file descriptot.
588b9c1b51eSKate Stone     if (fd_dst != UINT64_MAX &&
589b9c1b51eSKate Stone         !FileCache::GetInstance().CloseFile(fd_dst, error)) {
590e0f8f574SDaniel Malea       if (!error.Fail())
591e0f8f574SDaniel Malea         error.SetErrorString("unable to close destination file");
592e0f8f574SDaniel Malea     }
593e0f8f574SDaniel Malea     return error;
594e0f8f574SDaniel Malea   }
595e0f8f574SDaniel Malea   return Platform::GetFile(source, destination);
596e0f8f574SDaniel Malea }
597e0f8f574SDaniel Malea 
598b9c1b51eSKate Stone std::string PlatformPOSIX::GetPlatformSpecificConnectionInformation() {
599e0f8f574SDaniel Malea   StreamString stream;
600b9c1b51eSKate Stone   if (GetSupportsRSync()) {
601e0f8f574SDaniel Malea     stream.PutCString("rsync");
602e0f8f574SDaniel Malea     if ((GetRSyncOpts() && *GetRSyncOpts()) ||
603b9c1b51eSKate Stone         (GetRSyncPrefix() && *GetRSyncPrefix()) || GetIgnoresRemoteHostname()) {
604e0f8f574SDaniel Malea       stream.Printf(", options: ");
605e0f8f574SDaniel Malea       if (GetRSyncOpts() && *GetRSyncOpts())
606e0f8f574SDaniel Malea         stream.Printf("'%s' ", GetRSyncOpts());
607e0f8f574SDaniel Malea       stream.Printf(", prefix: ");
608e0f8f574SDaniel Malea       if (GetRSyncPrefix() && *GetRSyncPrefix())
609e0f8f574SDaniel Malea         stream.Printf("'%s' ", GetRSyncPrefix());
610e0f8f574SDaniel Malea       if (GetIgnoresRemoteHostname())
611e0f8f574SDaniel Malea         stream.Printf("ignore remote-hostname ");
612e0f8f574SDaniel Malea     }
613e0f8f574SDaniel Malea   }
614b9c1b51eSKate Stone   if (GetSupportsSSH()) {
615e0f8f574SDaniel Malea     stream.PutCString("ssh");
616e0f8f574SDaniel Malea     if (GetSSHOpts() && *GetSSHOpts())
617e0f8f574SDaniel Malea       stream.Printf(", options: '%s' ", GetSSHOpts());
618e0f8f574SDaniel Malea   }
619e0f8f574SDaniel Malea   if (GetLocalCacheDirectory() && *GetLocalCacheDirectory())
620e0f8f574SDaniel Malea     stream.Printf("cache dir: %s", GetLocalCacheDirectory());
621e0f8f574SDaniel Malea   if (stream.GetSize())
622c156427dSZachary Turner     return stream.GetString();
623e0f8f574SDaniel Malea   else
624e0f8f574SDaniel Malea     return "";
625e0f8f574SDaniel Malea }
626e0f8f574SDaniel Malea 
627b9c1b51eSKate Stone bool PlatformPOSIX::CalculateMD5(const FileSpec &file_spec, uint64_t &low,
628b9c1b51eSKate Stone                                  uint64_t &high) {
629e0f8f574SDaniel Malea   if (IsHost())
630e0f8f574SDaniel Malea     return Platform::CalculateMD5(file_spec, low, high);
631e0f8f574SDaniel Malea   if (m_remote_platform_sp)
632e0f8f574SDaniel Malea     return m_remote_platform_sp->CalculateMD5(file_spec, low, high);
633e0f8f574SDaniel Malea   return false;
634e0f8f574SDaniel Malea }
635fbb76349SGreg Clayton 
636b9c1b51eSKate Stone const lldb::UnixSignalsSP &PlatformPOSIX::GetRemoteUnixSignals() {
63798d0a4b3SChaoren Lin   if (IsRemote() && m_remote_platform_sp)
63898d0a4b3SChaoren Lin     return m_remote_platform_sp->GetRemoteUnixSignals();
63998d0a4b3SChaoren Lin   return Platform::GetRemoteUnixSignals();
64098d0a4b3SChaoren Lin }
64198d0a4b3SChaoren Lin 
642b9c1b51eSKate Stone FileSpec PlatformPOSIX::GetRemoteWorkingDirectory() {
643fbb76349SGreg Clayton   if (IsRemote() && m_remote_platform_sp)
644fbb76349SGreg Clayton     return m_remote_platform_sp->GetRemoteWorkingDirectory();
645fbb76349SGreg Clayton   else
646fbb76349SGreg Clayton     return Platform::GetRemoteWorkingDirectory();
647fbb76349SGreg Clayton }
648fbb76349SGreg Clayton 
649b9c1b51eSKate Stone bool PlatformPOSIX::SetRemoteWorkingDirectory(const FileSpec &working_dir) {
650fbb76349SGreg Clayton   if (IsRemote() && m_remote_platform_sp)
651d3173f34SChaoren Lin     return m_remote_platform_sp->SetRemoteWorkingDirectory(working_dir);
652fbb76349SGreg Clayton   else
653d3173f34SChaoren Lin     return Platform::SetRemoteWorkingDirectory(working_dir);
654fbb76349SGreg Clayton }
655fbb76349SGreg Clayton 
656b9c1b51eSKate Stone bool PlatformPOSIX::GetRemoteOSVersion() {
6572272c481SPavel Labath   if (m_remote_platform_sp) {
6582272c481SPavel Labath     m_os_version = m_remote_platform_sp->GetOSVersion();
6592272c481SPavel Labath     return !m_os_version.empty();
6602272c481SPavel Labath   }
661015d818bSTodd Fiala   return false;
662015d818bSTodd Fiala }
663015d818bSTodd Fiala 
664b9c1b51eSKate Stone bool PlatformPOSIX::GetRemoteOSBuildString(std::string &s) {
665015d818bSTodd Fiala   if (m_remote_platform_sp)
666015d818bSTodd Fiala     return m_remote_platform_sp->GetRemoteOSBuildString(s);
667015d818bSTodd Fiala   s.clear();
668015d818bSTodd Fiala   return false;
669015d818bSTodd Fiala }
670015d818bSTodd Fiala 
67162930e57SPavel Labath Environment PlatformPOSIX::GetEnvironment() {
672b9c1b51eSKate Stone   if (IsRemote()) {
673e15fcaa2STodd Fiala     if (m_remote_platform_sp)
67462930e57SPavel Labath       return m_remote_platform_sp->GetEnvironment();
67562930e57SPavel Labath     return Environment();
676e15fcaa2STodd Fiala   }
67762930e57SPavel Labath   return Host::GetEnvironment();
678e15fcaa2STodd Fiala }
679e15fcaa2STodd Fiala 
680b9c1b51eSKate Stone bool PlatformPOSIX::GetRemoteOSKernelDescription(std::string &s) {
681015d818bSTodd Fiala   if (m_remote_platform_sp)
682015d818bSTodd Fiala     return m_remote_platform_sp->GetRemoteOSKernelDescription(s);
683015d818bSTodd Fiala   s.clear();
684015d818bSTodd Fiala   return false;
685015d818bSTodd Fiala }
686015d818bSTodd Fiala 
687015d818bSTodd Fiala // Remote Platform subclasses need to override this function
688b9c1b51eSKate Stone ArchSpec PlatformPOSIX::GetRemoteSystemArchitecture() {
689015d818bSTodd Fiala   if (m_remote_platform_sp)
690015d818bSTodd Fiala     return m_remote_platform_sp->GetRemoteSystemArchitecture();
691015d818bSTodd Fiala   return ArchSpec();
692015d818bSTodd Fiala }
693015d818bSTodd Fiala 
694b9c1b51eSKate Stone const char *PlatformPOSIX::GetHostname() {
695015d818bSTodd Fiala   if (IsHost())
696015d818bSTodd Fiala     return Platform::GetHostname();
697015d818bSTodd Fiala 
698015d818bSTodd Fiala   if (m_remote_platform_sp)
699015d818bSTodd Fiala     return m_remote_platform_sp->GetHostname();
700015d818bSTodd Fiala   return NULL;
701015d818bSTodd Fiala }
702015d818bSTodd Fiala 
703b9c1b51eSKate Stone const char *PlatformPOSIX::GetUserName(uint32_t uid) {
704015d818bSTodd Fiala   // Check the cache in Platform in case we have already looked this uid up
705015d818bSTodd Fiala   const char *user_name = Platform::GetUserName(uid);
706015d818bSTodd Fiala   if (user_name)
707015d818bSTodd Fiala     return user_name;
708015d818bSTodd Fiala 
709015d818bSTodd Fiala   if (IsRemote() && m_remote_platform_sp)
710015d818bSTodd Fiala     return m_remote_platform_sp->GetUserName(uid);
711015d818bSTodd Fiala   return NULL;
712015d818bSTodd Fiala }
713015d818bSTodd Fiala 
714b9c1b51eSKate Stone const char *PlatformPOSIX::GetGroupName(uint32_t gid) {
715015d818bSTodd Fiala   const char *group_name = Platform::GetGroupName(gid);
716015d818bSTodd Fiala   if (group_name)
717015d818bSTodd Fiala     return group_name;
718015d818bSTodd Fiala 
719015d818bSTodd Fiala   if (IsRemote() && m_remote_platform_sp)
720015d818bSTodd Fiala     return m_remote_platform_sp->GetGroupName(gid);
721015d818bSTodd Fiala   return NULL;
722015d818bSTodd Fiala }
723015d818bSTodd Fiala 
72497206d57SZachary Turner Status PlatformPOSIX::ConnectRemote(Args &args) {
72597206d57SZachary Turner   Status error;
726b9c1b51eSKate Stone   if (IsHost()) {
727b9c1b51eSKate Stone     error.SetErrorStringWithFormat(
728b9c1b51eSKate Stone         "can't connect to the host platform '%s', always connected",
729b9c1b51eSKate Stone         GetPluginName().GetCString());
730b9c1b51eSKate Stone   } else {
731015d818bSTodd Fiala     if (!m_remote_platform_sp)
732b9c1b51eSKate Stone       m_remote_platform_sp =
733b9c1b51eSKate Stone           Platform::Create(ConstString("remote-gdb-server"), error);
734015d818bSTodd Fiala 
735015d818bSTodd Fiala     if (m_remote_platform_sp && error.Success())
736015d818bSTodd Fiala       error = m_remote_platform_sp->ConnectRemote(args);
737015d818bSTodd Fiala     else
738015d818bSTodd Fiala       error.SetErrorString("failed to create a 'remote-gdb-server' platform");
739015d818bSTodd Fiala 
740015d818bSTodd Fiala     if (error.Fail())
741015d818bSTodd Fiala       m_remote_platform_sp.reset();
742015d818bSTodd Fiala   }
743015d818bSTodd Fiala 
744b9c1b51eSKate Stone   if (error.Success() && m_remote_platform_sp) {
745b9c1b51eSKate Stone     if (m_option_group_platform_rsync.get() &&
746b9c1b51eSKate Stone         m_option_group_platform_ssh.get() &&
747b9c1b51eSKate Stone         m_option_group_platform_caching.get()) {
748b9c1b51eSKate Stone       if (m_option_group_platform_rsync->m_rsync) {
749015d818bSTodd Fiala         SetSupportsRSync(true);
7500a66e2f1SEnrico Granata         SetRSyncOpts(m_option_group_platform_rsync->m_rsync_opts.c_str());
7510a66e2f1SEnrico Granata         SetRSyncPrefix(m_option_group_platform_rsync->m_rsync_prefix.c_str());
752b9c1b51eSKate Stone         SetIgnoresRemoteHostname(
753b9c1b51eSKate Stone             m_option_group_platform_rsync->m_ignores_remote_hostname);
754015d818bSTodd Fiala       }
755b9c1b51eSKate Stone       if (m_option_group_platform_ssh->m_ssh) {
756015d818bSTodd Fiala         SetSupportsSSH(true);
7570a66e2f1SEnrico Granata         SetSSHOpts(m_option_group_platform_ssh->m_ssh_opts.c_str());
758015d818bSTodd Fiala       }
759b9c1b51eSKate Stone       SetLocalCacheDirectory(
760b9c1b51eSKate Stone           m_option_group_platform_caching->m_cache_dir.c_str());
761015d818bSTodd Fiala     }
762015d818bSTodd Fiala   }
763015d818bSTodd Fiala 
764015d818bSTodd Fiala   return error;
765015d818bSTodd Fiala }
766015d818bSTodd Fiala 
76797206d57SZachary Turner Status PlatformPOSIX::DisconnectRemote() {
76897206d57SZachary Turner   Status error;
769015d818bSTodd Fiala 
770b9c1b51eSKate Stone   if (IsHost()) {
771b9c1b51eSKate Stone     error.SetErrorStringWithFormat(
772b9c1b51eSKate Stone         "can't disconnect from the host platform '%s', always connected",
773b9c1b51eSKate Stone         GetPluginName().GetCString());
774b9c1b51eSKate Stone   } else {
775015d818bSTodd Fiala     if (m_remote_platform_sp)
776015d818bSTodd Fiala       error = m_remote_platform_sp->DisconnectRemote();
777015d818bSTodd Fiala     else
778015d818bSTodd Fiala       error.SetErrorString("the platform is not currently connected");
779015d818bSTodd Fiala   }
780015d818bSTodd Fiala   return error;
781015d818bSTodd Fiala }
782015d818bSTodd Fiala 
78397206d57SZachary Turner Status PlatformPOSIX::LaunchProcess(ProcessLaunchInfo &launch_info) {
78497206d57SZachary Turner   Status error;
785348fb385STodd Fiala 
786b9c1b51eSKate Stone   if (IsHost()) {
787348fb385STodd Fiala     error = Platform::LaunchProcess(launch_info);
788b9c1b51eSKate Stone   } else {
789348fb385STodd Fiala     if (m_remote_platform_sp)
790348fb385STodd Fiala       error = m_remote_platform_sp->LaunchProcess(launch_info);
791348fb385STodd Fiala     else
792348fb385STodd Fiala       error.SetErrorString("the platform is not currently connected");
793348fb385STodd Fiala   }
794348fb385STodd Fiala   return error;
795348fb385STodd Fiala }
796348fb385STodd Fiala 
79797206d57SZachary Turner lldb_private::Status PlatformPOSIX::KillProcess(const lldb::pid_t pid) {
79809daa881SOleksiy Vyalov   if (IsHost())
79909daa881SOleksiy Vyalov     return Platform::KillProcess(pid);
80009daa881SOleksiy Vyalov 
80109daa881SOleksiy Vyalov   if (m_remote_platform_sp)
80209daa881SOleksiy Vyalov     return m_remote_platform_sp->KillProcess(pid);
80309daa881SOleksiy Vyalov 
80497206d57SZachary Turner   return Status("the platform is not currently connected");
80509daa881SOleksiy Vyalov }
80609daa881SOleksiy Vyalov 
807b9c1b51eSKate Stone lldb::ProcessSP PlatformPOSIX::Attach(ProcessAttachInfo &attach_info,
808b9c1b51eSKate Stone                                       Debugger &debugger, Target *target,
80997206d57SZachary Turner                                       Status &error) {
810348fb385STodd Fiala   lldb::ProcessSP process_sp;
811348fb385STodd Fiala   Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM));
812348fb385STodd Fiala 
813b9c1b51eSKate Stone   if (IsHost()) {
814b9c1b51eSKate Stone     if (target == NULL) {
815348fb385STodd Fiala       TargetSP new_target_sp;
816348fb385STodd Fiala 
817f9a07e9fSJonas Devlieghere       error = debugger.GetTargetList().CreateTarget(
818f9a07e9fSJonas Devlieghere           debugger, "", "", eLoadDependentsNo, NULL, new_target_sp);
819348fb385STodd Fiala       target = new_target_sp.get();
820348fb385STodd Fiala       if (log)
821348fb385STodd Fiala         log->Printf("PlatformPOSIX::%s created new target", __FUNCTION__);
822b9c1b51eSKate Stone     } else {
823348fb385STodd Fiala       error.Clear();
824348fb385STodd Fiala       if (log)
825b9c1b51eSKate Stone         log->Printf("PlatformPOSIX::%s target already existed, setting target",
826b9c1b51eSKate Stone                     __FUNCTION__);
827348fb385STodd Fiala     }
828348fb385STodd Fiala 
829b9c1b51eSKate Stone     if (target && error.Success()) {
830348fb385STodd Fiala       debugger.GetTargetList().SetSelectedTarget(target);
831b9c1b51eSKate Stone       if (log) {
832348fb385STodd Fiala         ModuleSP exe_module_sp = target->GetExecutableModule();
833b9c1b51eSKate Stone         log->Printf("PlatformPOSIX::%s set selected target to %p %s",
834b9c1b51eSKate Stone                     __FUNCTION__, (void *)target,
835b9c1b51eSKate Stone                     exe_module_sp
836b9c1b51eSKate Stone                         ? exe_module_sp->GetFileSpec().GetPath().c_str()
837b9c1b51eSKate Stone                         : "<null>");
838348fb385STodd Fiala       }
839348fb385STodd Fiala 
840b9c1b51eSKate Stone       process_sp =
841b9c1b51eSKate Stone           target->CreateProcess(attach_info.GetListenerForProcess(debugger),
842b9c1b51eSKate Stone                                 attach_info.GetProcessPluginName(), NULL);
843348fb385STodd Fiala 
844b9c1b51eSKate Stone       if (process_sp) {
845583bbb1dSJim Ingham         ListenerSP listener_sp = attach_info.GetHijackListener();
846b9c1b51eSKate Stone         if (listener_sp == nullptr) {
847b9c1b51eSKate Stone           listener_sp =
848b9c1b51eSKate Stone               Listener::MakeListener("lldb.PlatformPOSIX.attach.hijack");
849348fb385STodd Fiala           attach_info.SetHijackListener(listener_sp);
850926af0cdSOleksiy Vyalov         }
851583bbb1dSJim Ingham         process_sp->HijackProcessEvents(listener_sp);
852348fb385STodd Fiala         error = process_sp->Attach(attach_info);
853348fb385STodd Fiala       }
854348fb385STodd Fiala     }
855b9c1b51eSKate Stone   } else {
856348fb385STodd Fiala     if (m_remote_platform_sp)
857b9c1b51eSKate Stone       process_sp =
858b9c1b51eSKate Stone           m_remote_platform_sp->Attach(attach_info, debugger, target, error);
859348fb385STodd Fiala     else
860348fb385STodd Fiala       error.SetErrorString("the platform is not currently connected");
861348fb385STodd Fiala   }
862348fb385STodd Fiala   return process_sp;
863348fb385STodd Fiala }
864348fb385STodd Fiala 
865015d818bSTodd Fiala lldb::ProcessSP
866b9c1b51eSKate Stone PlatformPOSIX::DebugProcess(ProcessLaunchInfo &launch_info, Debugger &debugger,
867b9c1b51eSKate Stone                             Target *target, // Can be NULL, if NULL create a new
868b9c1b51eSKate Stone                                             // target, else use existing one
86997206d57SZachary Turner                             Status &error) {
870015d818bSTodd Fiala   ProcessSP process_sp;
871015d818bSTodd Fiala 
872b9c1b51eSKate Stone   if (IsHost()) {
873b9c1b51eSKate Stone     // We are going to hand this process off to debugserver which will be in
874245dd2e0SPavel Labath     // charge of setting the exit status.  However, we still need to reap it
875245dd2e0SPavel Labath     // from lldb. So, make sure we use a exit callback which does not set exit
876245dd2e0SPavel Labath     // status.
877245dd2e0SPavel Labath     const bool monitor_signals = false;
878245dd2e0SPavel Labath     launch_info.SetMonitorProcessCallback(
879245dd2e0SPavel Labath         &ProcessLaunchInfo::NoOpMonitorCallback, monitor_signals);
8808012cadbSGreg Clayton     process_sp = Platform::DebugProcess(launch_info, debugger, target, error);
881b9c1b51eSKate Stone   } else {
882015d818bSTodd Fiala     if (m_remote_platform_sp)
883b9c1b51eSKate Stone       process_sp = m_remote_platform_sp->DebugProcess(launch_info, debugger,
884b9c1b51eSKate Stone                                                       target, error);
885015d818bSTodd Fiala     else
886015d818bSTodd Fiala       error.SetErrorString("the platform is not currently connected");
887015d818bSTodd Fiala   }
888015d818bSTodd Fiala   return process_sp;
889015d818bSTodd Fiala }
890015d818bSTodd Fiala 
891b9c1b51eSKate Stone void PlatformPOSIX::CalculateTrapHandlerSymbolNames() {
8922094dbf4SJason Molenda   m_trap_handlers.push_back(ConstString("_sigtramp"));
8932094dbf4SJason Molenda }
8943cb132a0STamas Berghammer 
89597206d57SZachary Turner Status PlatformPOSIX::EvaluateLibdlExpression(
896b9c1b51eSKate Stone     lldb_private::Process *process, const char *expr_cstr,
897d37c9469SPavel Labath     llvm::StringRef expr_prefix, lldb::ValueObjectSP &result_valobj_sp) {
8983cb132a0STamas Berghammer   DynamicLoader *loader = process->GetDynamicLoader();
899b9c1b51eSKate Stone   if (loader) {
90097206d57SZachary Turner     Status error = loader->CanLoadImage();
9013cb132a0STamas Berghammer     if (error.Fail())
9023cb132a0STamas Berghammer       return error;
9033cb132a0STamas Berghammer   }
9043cb132a0STamas Berghammer 
9058d94ba0fSJim Ingham   ThreadSP thread_sp(process->GetThreadList().GetExpressionExecutionThread());
9063cb132a0STamas Berghammer   if (!thread_sp)
90797206d57SZachary Turner     return Status("Selected thread isn't valid");
9083cb132a0STamas Berghammer 
9093cb132a0STamas Berghammer   StackFrameSP frame_sp(thread_sp->GetStackFrameAtIndex(0));
9103cb132a0STamas Berghammer   if (!frame_sp)
91197206d57SZachary Turner     return Status("Frame 0 isn't valid");
9123cb132a0STamas Berghammer 
9133cb132a0STamas Berghammer   ExecutionContext exe_ctx;
9143cb132a0STamas Berghammer   frame_sp->CalculateExecutionContext(exe_ctx);
9153cb132a0STamas Berghammer   EvaluateExpressionOptions expr_options;
9163cb132a0STamas Berghammer   expr_options.SetUnwindOnError(true);
9173cb132a0STamas Berghammer   expr_options.SetIgnoreBreakpoints(true);
9183cb132a0STamas Berghammer   expr_options.SetExecutionPolicy(eExecutionPolicyAlways);
9193cb132a0STamas Berghammer   expr_options.SetLanguage(eLanguageTypeC_plus_plus);
920b9c1b51eSKate Stone   expr_options.SetTrapExceptions(false); // dlopen can't throw exceptions, so
921b9c1b51eSKate Stone                                          // don't do the work to trap them.
92243d35418SPavel Labath   expr_options.SetTimeout(std::chrono::seconds(2));
9233cb132a0STamas Berghammer 
92497206d57SZachary Turner   Status expr_error;
92502980825SJim Ingham   ExpressionResults result =
926b9c1b51eSKate Stone       UserExpression::Evaluate(exe_ctx, expr_options, expr_cstr, expr_prefix,
927b9c1b51eSKate Stone                                result_valobj_sp, expr_error);
92802980825SJim Ingham   if (result != eExpressionCompleted)
92902980825SJim Ingham     return expr_error;
93002980825SJim Ingham 
9313cb132a0STamas Berghammer   if (result_valobj_sp->GetError().Fail())
9323cb132a0STamas Berghammer     return result_valobj_sp->GetError();
93397206d57SZachary Turner   return Status();
9343cb132a0STamas Berghammer }
9353cb132a0STamas Berghammer 
936d10d3795SFrederic Riss std::unique_ptr<UtilityFunction>
9371ecb34f4SJim Ingham PlatformPOSIX::MakeLoadImageUtilityFunction(ExecutionContext &exe_ctx,
938d10d3795SFrederic Riss                                             Status &error) {
93905097246SAdrian Prantl   // Remember to prepend this with the prefix from
94005097246SAdrian Prantl   // GetLibdlFunctionDeclarations. The returned values are all in
94105097246SAdrian Prantl   // __lldb_dlopen_result for consistency. The wrapper returns a void * but
94205097246SAdrian Prantl   // doesn't use it because UtilityFunctions don't work with void returns at
94305097246SAdrian Prantl   // present.
9441ecb34f4SJim Ingham   static const char *dlopen_wrapper_code = R"(
9451ecb34f4SJim Ingham   struct __lldb_dlopen_result {
9461ecb34f4SJim Ingham     void *image_ptr;
9471ecb34f4SJim Ingham     const char *error_str;
9481ecb34f4SJim Ingham   };
9491ecb34f4SJim Ingham 
95003856dd9SJim Ingham   extern void *memcpy(void *, const void *, size_t size);
9510d231f71SJim Ingham   extern size_t strlen(const char *);
9520d231f71SJim Ingham 
9530d231f71SJim Ingham 
9540d231f71SJim Ingham   void * __lldb_dlopen_wrapper (const char *name,
9550d231f71SJim Ingham                                 const char *path_strings,
9560d231f71SJim Ingham                                 char *buffer,
9571ecb34f4SJim Ingham                                 __lldb_dlopen_result *result_ptr)
9581ecb34f4SJim Ingham   {
9590d231f71SJim Ingham     // This is the case where the name is the full path:
96003856dd9SJim Ingham     if (!path_strings) {
9610d231f71SJim Ingham       result_ptr->image_ptr = dlopen(name, 2);
96203856dd9SJim Ingham       if (result_ptr->image_ptr)
9630d231f71SJim Ingham         result_ptr->error_str = nullptr;
9640d231f71SJim Ingham       return nullptr;
9650d231f71SJim Ingham     }
9660d231f71SJim Ingham 
9670d231f71SJim Ingham     // This is the case where we have a list of paths:
9680d231f71SJim Ingham     size_t name_len = strlen(name);
96903856dd9SJim Ingham     while (path_strings && path_strings[0] != '\0') {
9700d231f71SJim Ingham       size_t path_len = strlen(path_strings);
9710d231f71SJim Ingham       memcpy((void *) buffer, (void *) path_strings, path_len);
9720d231f71SJim Ingham       buffer[path_len] = '/';
9730d231f71SJim Ingham       char *target_ptr = buffer+path_len+1;
9740d231f71SJim Ingham       memcpy((void *) target_ptr, (void *) name, name_len + 1);
9750d231f71SJim Ingham       result_ptr->image_ptr = dlopen(buffer, 2);
97603856dd9SJim Ingham       if (result_ptr->image_ptr) {
9770d231f71SJim Ingham         result_ptr->error_str = nullptr;
9780d231f71SJim Ingham         break;
9790d231f71SJim Ingham       }
9801ecb34f4SJim Ingham       result_ptr->error_str = dlerror();
9810d231f71SJim Ingham       path_strings = path_strings + path_len + 1;
9820d231f71SJim Ingham     }
9831ecb34f4SJim Ingham     return nullptr;
9841ecb34f4SJim Ingham   }
9851ecb34f4SJim Ingham   )";
9861ecb34f4SJim Ingham 
9871ecb34f4SJim Ingham   static const char *dlopen_wrapper_name = "__lldb_dlopen_wrapper";
9881ecb34f4SJim Ingham   Process *process = exe_ctx.GetProcessSP().get();
9891ecb34f4SJim Ingham   // Insert the dlopen shim defines into our generic expression:
9901ecb34f4SJim Ingham   std::string expr(GetLibdlFunctionDeclarations(process));
9911ecb34f4SJim Ingham   expr.append(dlopen_wrapper_code);
9921ecb34f4SJim Ingham   Status utility_error;
9931ecb34f4SJim Ingham   DiagnosticManager diagnostics;
9941ecb34f4SJim Ingham 
9951ecb34f4SJim Ingham   std::unique_ptr<UtilityFunction> dlopen_utility_func_up(process
9961ecb34f4SJim Ingham       ->GetTarget().GetUtilityFunctionForLanguage(expr.c_str(),
9971ecb34f4SJim Ingham                                                   eLanguageTypeObjC,
9981ecb34f4SJim Ingham                                                   dlopen_wrapper_name,
9991ecb34f4SJim Ingham                                                   utility_error));
10001ecb34f4SJim Ingham   if (utility_error.Fail()) {
10011ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not make utility"
10021ecb34f4SJim Ingham                                    "function: %s", utility_error.AsCString());
10031ecb34f4SJim Ingham     return nullptr;
10041ecb34f4SJim Ingham   }
10051ecb34f4SJim Ingham   if (!dlopen_utility_func_up->Install(diagnostics, exe_ctx)) {
10061ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not install utility"
10071ecb34f4SJim Ingham                                    "function: %s",
10081ecb34f4SJim Ingham                                    diagnostics.GetString().c_str());
10091ecb34f4SJim Ingham     return nullptr;
10101ecb34f4SJim Ingham   }
10111ecb34f4SJim Ingham 
10121ecb34f4SJim Ingham   Value value;
10131ecb34f4SJim Ingham   ValueList arguments;
10141ecb34f4SJim Ingham   FunctionCaller *do_dlopen_function = nullptr;
10151ecb34f4SJim Ingham 
10161ecb34f4SJim Ingham   // Fetch the clang types we will need:
10171ecb34f4SJim Ingham   ClangASTContext *ast = process->GetTarget().GetScratchClangASTContext();
10181ecb34f4SJim Ingham 
10191ecb34f4SJim Ingham   CompilerType clang_void_pointer_type
10201ecb34f4SJim Ingham       = ast->GetBasicType(eBasicTypeVoid).GetPointerType();
10211ecb34f4SJim Ingham   CompilerType clang_char_pointer_type
10221ecb34f4SJim Ingham         = ast->GetBasicType(eBasicTypeChar).GetPointerType();
10231ecb34f4SJim Ingham 
10240d231f71SJim Ingham   // We are passing four arguments, the basename, the list of places to look,
10250d231f71SJim Ingham   // a buffer big enough for all the path + name combos, and
10260d231f71SJim Ingham   // a pointer to the storage we've made for the result:
10271ecb34f4SJim Ingham   value.SetValueType(Value::eValueTypeScalar);
10281ecb34f4SJim Ingham   value.SetCompilerType(clang_void_pointer_type);
10291ecb34f4SJim Ingham   arguments.PushValue(value);
10301ecb34f4SJim Ingham   value.SetCompilerType(clang_char_pointer_type);
10311ecb34f4SJim Ingham   arguments.PushValue(value);
10320d231f71SJim Ingham   arguments.PushValue(value);
10330d231f71SJim Ingham   arguments.PushValue(value);
10341ecb34f4SJim Ingham 
10351ecb34f4SJim Ingham   do_dlopen_function = dlopen_utility_func_up->MakeFunctionCaller(
10361ecb34f4SJim Ingham       clang_void_pointer_type, arguments, exe_ctx.GetThreadSP(), utility_error);
10371ecb34f4SJim Ingham   if (utility_error.Fail()) {
10381ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not make function"
10391ecb34f4SJim Ingham                                    "caller: %s", utility_error.AsCString());
10401ecb34f4SJim Ingham     return nullptr;
10411ecb34f4SJim Ingham   }
10421ecb34f4SJim Ingham 
10431ecb34f4SJim Ingham   do_dlopen_function = dlopen_utility_func_up->GetFunctionCaller();
10441ecb34f4SJim Ingham   if (!do_dlopen_function) {
10451ecb34f4SJim Ingham     error.SetErrorString("dlopen error: could not get function caller.");
10461ecb34f4SJim Ingham     return nullptr;
10471ecb34f4SJim Ingham   }
10481ecb34f4SJim Ingham 
10491ecb34f4SJim Ingham   // We made a good utility function, so cache it in the process:
1050d10d3795SFrederic Riss   return dlopen_utility_func_up;
10511ecb34f4SJim Ingham }
10521ecb34f4SJim Ingham 
1053b9c1b51eSKate Stone uint32_t PlatformPOSIX::DoLoadImage(lldb_private::Process *process,
10544fbd67acSTamas Berghammer                                     const lldb_private::FileSpec &remote_file,
10550d231f71SJim Ingham                                     const std::vector<std::string> *paths,
10560d231f71SJim Ingham                                     lldb_private::Status &error,
10570d231f71SJim Ingham                                     lldb_private::FileSpec *loaded_image) {
10580d231f71SJim Ingham   if (loaded_image)
10590d231f71SJim Ingham     loaded_image->Clear();
10600d231f71SJim Ingham 
10611ecb34f4SJim Ingham   std::string path;
10621ecb34f4SJim Ingham   path = remote_file.GetPath();
10633cb132a0STamas Berghammer 
10641ecb34f4SJim Ingham   ThreadSP thread_sp = process->GetThreadList().GetExpressionExecutionThread();
10651ecb34f4SJim Ingham   if (!thread_sp) {
10661ecb34f4SJim Ingham     error.SetErrorString("dlopen error: no thread available to call dlopen.");
10673cb132a0STamas Berghammer     return LLDB_INVALID_IMAGE_TOKEN;
10683cb132a0STamas Berghammer   }
10693cb132a0STamas Berghammer 
10701ecb34f4SJim Ingham   DiagnosticManager diagnostics;
10713cb132a0STamas Berghammer 
10721ecb34f4SJim Ingham   ExecutionContext exe_ctx;
10731ecb34f4SJim Ingham   thread_sp->CalculateExecutionContext(exe_ctx);
10741ecb34f4SJim Ingham 
10751ecb34f4SJim Ingham   Status utility_error;
1076d10d3795SFrederic Riss   UtilityFunction *dlopen_utility_func;
10771ecb34f4SJim Ingham   ValueList arguments;
10781ecb34f4SJim Ingham   FunctionCaller *do_dlopen_function = nullptr;
10791ecb34f4SJim Ingham 
1080d10d3795SFrederic Riss   // The UtilityFunction is held in the Process.  Platforms don't track the
1081d10d3795SFrederic Riss   // lifespan of the Targets that use them, we can't put this in the Platform.
1082d10d3795SFrederic Riss   dlopen_utility_func = process->GetLoadImageUtilityFunction(
1083d10d3795SFrederic Riss       this, [&]() -> std::unique_ptr<UtilityFunction> {
1084d10d3795SFrederic Riss         return MakeLoadImageUtilityFunction(exe_ctx, error);
1085d10d3795SFrederic Riss       });
10861ecb34f4SJim Ingham   // If we couldn't make it, the error will be in error, so we can exit here.
10871ecb34f4SJim Ingham   if (!dlopen_utility_func)
10881ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
10891ecb34f4SJim Ingham 
10901ecb34f4SJim Ingham   do_dlopen_function = dlopen_utility_func->GetFunctionCaller();
10911ecb34f4SJim Ingham   if (!do_dlopen_function) {
10921ecb34f4SJim Ingham     error.SetErrorString("dlopen error: could not get function caller.");
10931ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
10941ecb34f4SJim Ingham   }
10951ecb34f4SJim Ingham   arguments = do_dlopen_function->GetArgumentValues();
10961ecb34f4SJim Ingham 
109705097246SAdrian Prantl   // Now insert the path we are searching for and the result structure into the
109805097246SAdrian Prantl   // target.
10991ecb34f4SJim Ingham   uint32_t permissions = ePermissionsReadable|ePermissionsWritable;
11001ecb34f4SJim Ingham   size_t path_len = path.size() + 1;
11011ecb34f4SJim Ingham   lldb::addr_t path_addr = process->AllocateMemory(path_len,
11021ecb34f4SJim Ingham                                                    permissions,
11031ecb34f4SJim Ingham                                                    utility_error);
11041ecb34f4SJim Ingham   if (path_addr == LLDB_INVALID_ADDRESS) {
11051ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not allocate memory"
11061ecb34f4SJim Ingham                                     "for path: %s", utility_error.AsCString());
11071ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
11081ecb34f4SJim Ingham   }
11091ecb34f4SJim Ingham 
11101ecb34f4SJim Ingham   // Make sure we deallocate the input string memory:
11111ecb34f4SJim Ingham   CleanUp path_cleanup([process, path_addr] {
11121ecb34f4SJim Ingham       process->DeallocateMemory(path_addr);
11131ecb34f4SJim Ingham   });
11141ecb34f4SJim Ingham 
11151ecb34f4SJim Ingham   process->WriteMemory(path_addr, path.c_str(), path_len, utility_error);
11161ecb34f4SJim Ingham   if (utility_error.Fail()) {
11171ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not write path string:"
11181ecb34f4SJim Ingham                                     " %s", utility_error.AsCString());
11191ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
11201ecb34f4SJim Ingham   }
11211ecb34f4SJim Ingham 
112205097246SAdrian Prantl   // Make space for our return structure.  It is two pointers big: the token
112305097246SAdrian Prantl   // and the error string.
11241ecb34f4SJim Ingham   const uint32_t addr_size = process->GetAddressByteSize();
11251ecb34f4SJim Ingham   lldb::addr_t return_addr = process->CallocateMemory(2*addr_size,
11261ecb34f4SJim Ingham                                                       permissions,
11271ecb34f4SJim Ingham                                                       utility_error);
11281ecb34f4SJim Ingham   if (utility_error.Fail()) {
11291ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not allocate memory"
11301ecb34f4SJim Ingham                                     "for path: %s", utility_error.AsCString());
11311ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
11321ecb34f4SJim Ingham   }
11331ecb34f4SJim Ingham 
11341ecb34f4SJim Ingham   // Make sure we deallocate the result structure memory
11351ecb34f4SJim Ingham   CleanUp return_cleanup([process, return_addr] {
11361ecb34f4SJim Ingham       process->DeallocateMemory(return_addr);
11371ecb34f4SJim Ingham   });
11381ecb34f4SJim Ingham 
11390d231f71SJim Ingham   // This will be the address of the storage for paths, if we are using them,
11400d231f71SJim Ingham   // or nullptr to signal we aren't.
11410d231f71SJim Ingham   lldb::addr_t path_array_addr = 0x0;
11420d231f71SJim Ingham   llvm::Optional<CleanUp> path_array_cleanup;
11430d231f71SJim Ingham 
11440d231f71SJim Ingham   // This is the address to a buffer large enough to hold the largest path
11450d231f71SJim Ingham   // conjoined with the library name we're passing in.  This is a convenience
11460d231f71SJim Ingham   // to avoid having to call malloc in the dlopen function.
11470d231f71SJim Ingham   lldb::addr_t buffer_addr = 0x0;
11480d231f71SJim Ingham   llvm::Optional<CleanUp> buffer_cleanup;
11490d231f71SJim Ingham 
11501ecb34f4SJim Ingham   // Set the values into our args and write them to the target:
11510d231f71SJim Ingham   if (paths != nullptr) {
11520d231f71SJim Ingham     // First insert the paths into the target.  This is expected to be a
11530d231f71SJim Ingham     // continuous buffer with the strings laid out null terminated and
11540d231f71SJim Ingham     // end to end with an empty string terminating the buffer.
11550d231f71SJim Ingham     // We also compute the buffer's required size as we go.
11560d231f71SJim Ingham     size_t buffer_size = 0;
11570d231f71SJim Ingham     std::string path_array;
11580d231f71SJim Ingham     for (auto path : *paths) {
115940fa4a1aSJim Ingham       // Don't insert empty paths, they will make us abort the path
116040fa4a1aSJim Ingham       // search prematurely.
116140fa4a1aSJim Ingham       if (path.empty())
116240fa4a1aSJim Ingham         continue;
11630d231f71SJim Ingham       size_t path_size = path.size();
11640d231f71SJim Ingham       path_array.append(path);
11650d231f71SJim Ingham       path_array.push_back('\0');
11660d231f71SJim Ingham       if (path_size > buffer_size)
11670d231f71SJim Ingham         buffer_size = path_size;
11680d231f71SJim Ingham     }
11690d231f71SJim Ingham     path_array.push_back('\0');
11700d231f71SJim Ingham 
11710d231f71SJim Ingham     path_array_addr = process->AllocateMemory(path_array.size(),
11720d231f71SJim Ingham                                               permissions,
11730d231f71SJim Ingham                                               utility_error);
11740d231f71SJim Ingham     if (path_array_addr == LLDB_INVALID_ADDRESS) {
11750d231f71SJim Ingham       error.SetErrorStringWithFormat("dlopen error: could not allocate memory"
11760d231f71SJim Ingham                                       "for path array: %s",
11770d231f71SJim Ingham                                       utility_error.AsCString());
11780d231f71SJim Ingham       return LLDB_INVALID_IMAGE_TOKEN;
11790d231f71SJim Ingham     }
11800d231f71SJim Ingham 
11810d231f71SJim Ingham     // Make sure we deallocate the paths array.
11820d231f71SJim Ingham     path_array_cleanup.emplace([process, path_array_addr] {
11830d231f71SJim Ingham         process->DeallocateMemory(path_array_addr);
11840d231f71SJim Ingham     });
11850d231f71SJim Ingham 
11860d231f71SJim Ingham     process->WriteMemory(path_array_addr, path_array.data(),
11870d231f71SJim Ingham                          path_array.size(), utility_error);
11880d231f71SJim Ingham 
11890d231f71SJim Ingham     if (utility_error.Fail()) {
11900d231f71SJim Ingham       error.SetErrorStringWithFormat("dlopen error: could not write path array:"
11910d231f71SJim Ingham                                      " %s", utility_error.AsCString());
11920d231f71SJim Ingham       return LLDB_INVALID_IMAGE_TOKEN;
11930d231f71SJim Ingham     }
11940d231f71SJim Ingham     // Now make spaces in the target for the buffer.  We need to add one for
11950d231f71SJim Ingham     // the '/' that the utility function will insert and one for the '\0':
11960d231f71SJim Ingham     buffer_size += path.size() + 2;
11970d231f71SJim Ingham 
11980d231f71SJim Ingham     buffer_addr = process->AllocateMemory(buffer_size,
11990d231f71SJim Ingham                                           permissions,
12000d231f71SJim Ingham                                           utility_error);
12010d231f71SJim Ingham     if (buffer_addr == LLDB_INVALID_ADDRESS) {
12020d231f71SJim Ingham       error.SetErrorStringWithFormat("dlopen error: could not allocate memory"
12030d231f71SJim Ingham                                       "for buffer: %s",
12040d231f71SJim Ingham                                       utility_error.AsCString());
12050d231f71SJim Ingham       return LLDB_INVALID_IMAGE_TOKEN;
12060d231f71SJim Ingham     }
12070d231f71SJim Ingham 
12080d231f71SJim Ingham     // Make sure we deallocate the buffer memory:
12090d231f71SJim Ingham     buffer_cleanup.emplace([process, buffer_addr] {
12100d231f71SJim Ingham         process->DeallocateMemory(buffer_addr);
12110d231f71SJim Ingham     });
12120d231f71SJim Ingham   }
12130d231f71SJim Ingham 
12141ecb34f4SJim Ingham   arguments.GetValueAtIndex(0)->GetScalar() = path_addr;
12150d231f71SJim Ingham   arguments.GetValueAtIndex(1)->GetScalar() = path_array_addr;
12160d231f71SJim Ingham   arguments.GetValueAtIndex(2)->GetScalar() = buffer_addr;
12170d231f71SJim Ingham   arguments.GetValueAtIndex(3)->GetScalar() = return_addr;
12181ecb34f4SJim Ingham 
12191ecb34f4SJim Ingham   lldb::addr_t func_args_addr = LLDB_INVALID_ADDRESS;
12201ecb34f4SJim Ingham 
12211ecb34f4SJim Ingham   diagnostics.Clear();
12221ecb34f4SJim Ingham   if (!do_dlopen_function->WriteFunctionArguments(exe_ctx,
12231ecb34f4SJim Ingham                                                  func_args_addr,
12241ecb34f4SJim Ingham                                                  arguments,
12251ecb34f4SJim Ingham                                                  diagnostics)) {
12261ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not write function "
12271ecb34f4SJim Ingham                                    "arguments: %s",
12281ecb34f4SJim Ingham                                    diagnostics.GetString().c_str());
12291ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
12301ecb34f4SJim Ingham   }
12311ecb34f4SJim Ingham 
12321ecb34f4SJim Ingham   // Make sure we clean up the args structure.  We can't reuse it because the
12331ecb34f4SJim Ingham   // Platform lives longer than the process and the Platforms don't get a
12341ecb34f4SJim Ingham   // signal to clean up cached data when a process goes away.
12351ecb34f4SJim Ingham   CleanUp args_cleanup([do_dlopen_function, &exe_ctx, func_args_addr] {
12361ecb34f4SJim Ingham     do_dlopen_function->DeallocateFunctionResults(exe_ctx, func_args_addr);
12371ecb34f4SJim Ingham   });
12381ecb34f4SJim Ingham 
12391ecb34f4SJim Ingham   // Now run the caller:
12401ecb34f4SJim Ingham   EvaluateExpressionOptions options;
12411ecb34f4SJim Ingham   options.SetExecutionPolicy(eExecutionPolicyAlways);
12421ecb34f4SJim Ingham   options.SetLanguage(eLanguageTypeC_plus_plus);
12431ecb34f4SJim Ingham   options.SetIgnoreBreakpoints(true);
12441ecb34f4SJim Ingham   options.SetUnwindOnError(true);
12451ecb34f4SJim Ingham   options.SetTrapExceptions(false); // dlopen can't throw exceptions, so
12461ecb34f4SJim Ingham                                     // don't do the work to trap them.
12471ecb34f4SJim Ingham   options.SetTimeout(std::chrono::seconds(2));
1248c01783a8SRaphael Isemann   options.SetIsForUtilityExpr(true);
12491ecb34f4SJim Ingham 
12501ecb34f4SJim Ingham   Value return_value;
12511ecb34f4SJim Ingham   // Fetch the clang types we will need:
12521ecb34f4SJim Ingham   ClangASTContext *ast = process->GetTarget().GetScratchClangASTContext();
12531ecb34f4SJim Ingham 
12541ecb34f4SJim Ingham   CompilerType clang_void_pointer_type
12551ecb34f4SJim Ingham       = ast->GetBasicType(eBasicTypeVoid).GetPointerType();
12561ecb34f4SJim Ingham 
12571ecb34f4SJim Ingham   return_value.SetCompilerType(clang_void_pointer_type);
12581ecb34f4SJim Ingham 
12591ecb34f4SJim Ingham   ExpressionResults results = do_dlopen_function->ExecuteFunction(
12601ecb34f4SJim Ingham       exe_ctx, &func_args_addr, options, diagnostics, return_value);
12611ecb34f4SJim Ingham   if (results != eExpressionCompleted) {
12620d231f71SJim Ingham     error.SetErrorStringWithFormat("dlopen error: failed executing "
12631ecb34f4SJim Ingham                                    "dlopen wrapper function: %s",
12641ecb34f4SJim Ingham                                    diagnostics.GetString().c_str());
12651ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
12661ecb34f4SJim Ingham   }
12671ecb34f4SJim Ingham 
12681ecb34f4SJim Ingham   // Read the dlopen token from the return area:
12691ecb34f4SJim Ingham   lldb::addr_t token = process->ReadPointerFromMemory(return_addr,
12701ecb34f4SJim Ingham                                                       utility_error);
12711ecb34f4SJim Ingham   if (utility_error.Fail()) {
12721ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not read the return "
12731ecb34f4SJim Ingham                                     "struct: %s", utility_error.AsCString());
12741ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
12751ecb34f4SJim Ingham   }
12761ecb34f4SJim Ingham 
12771ecb34f4SJim Ingham   // The dlopen succeeded!
12780d231f71SJim Ingham   if (token != 0x0) {
12790d231f71SJim Ingham     if (loaded_image && buffer_addr != 0x0)
12800d231f71SJim Ingham     {
12810d231f71SJim Ingham       // Capture the image which was loaded.  We leave it in the buffer on
12820d231f71SJim Ingham       // exit from the dlopen function, so we can just read it from there:
12830d231f71SJim Ingham       std::string name_string;
12840d231f71SJim Ingham       process->ReadCStringFromMemory(buffer_addr, name_string, utility_error);
12850d231f71SJim Ingham       if (utility_error.Success())
12860d231f71SJim Ingham         loaded_image->SetFile(name_string, false,
12870d231f71SJim Ingham                               llvm::sys::path::Style::posix);
12880d231f71SJim Ingham     }
12891ecb34f4SJim Ingham     return process->AddImageToken(token);
12900d231f71SJim Ingham   }
12911ecb34f4SJim Ingham 
12921ecb34f4SJim Ingham   // We got an error, lets read in the error string:
12931ecb34f4SJim Ingham   std::string dlopen_error_str;
12941ecb34f4SJim Ingham   lldb::addr_t error_addr
12951ecb34f4SJim Ingham     = process->ReadPointerFromMemory(return_addr + addr_size, utility_error);
12961ecb34f4SJim Ingham   if (utility_error.Fail()) {
12971ecb34f4SJim Ingham     error.SetErrorStringWithFormat("dlopen error: could not read error string: "
12981ecb34f4SJim Ingham                                     "%s", utility_error.AsCString());
12991ecb34f4SJim Ingham     return LLDB_INVALID_IMAGE_TOKEN;
13001ecb34f4SJim Ingham   }
13011ecb34f4SJim Ingham 
13021ecb34f4SJim Ingham   size_t num_chars = process->ReadCStringFromMemory(error_addr + addr_size,
13031ecb34f4SJim Ingham                                                     dlopen_error_str,
13041ecb34f4SJim Ingham                                                     utility_error);
13051ecb34f4SJim Ingham   if (utility_error.Success() && num_chars > 0)
1306b9c1b51eSKate Stone     error.SetErrorStringWithFormat("dlopen error: %s",
13071ecb34f4SJim Ingham                                    dlopen_error_str.c_str());
13083cb132a0STamas Berghammer   else
13093cb132a0STamas Berghammer     error.SetErrorStringWithFormat("dlopen failed for unknown reasons.");
13101ecb34f4SJim Ingham 
13113cb132a0STamas Berghammer   return LLDB_INVALID_IMAGE_TOKEN;
13123cb132a0STamas Berghammer }
13133cb132a0STamas Berghammer 
131497206d57SZachary Turner Status PlatformPOSIX::UnloadImage(lldb_private::Process *process,
1315b9c1b51eSKate Stone                                   uint32_t image_token) {
13163cb132a0STamas Berghammer   const addr_t image_addr = process->GetImagePtrFromToken(image_token);
13173cb132a0STamas Berghammer   if (image_addr == LLDB_INVALID_ADDRESS)
131897206d57SZachary Turner     return Status("Invalid image token");
13193cb132a0STamas Berghammer 
13203cb132a0STamas Berghammer   StreamString expr;
13213cb132a0STamas Berghammer   expr.Printf("dlclose((void *)0x%" PRIx64 ")", image_addr);
1322f7a5851dSNitesh Jain   llvm::StringRef prefix = GetLibdlFunctionDeclarations(process);
13233cb132a0STamas Berghammer   lldb::ValueObjectSP result_valobj_sp;
132497206d57SZachary Turner   Status error = EvaluateLibdlExpression(process, expr.GetData(), prefix,
1325b9c1b51eSKate Stone                                          result_valobj_sp);
13263cb132a0STamas Berghammer   if (error.Fail())
13273cb132a0STamas Berghammer     return error;
13283cb132a0STamas Berghammer 
13293cb132a0STamas Berghammer   if (result_valobj_sp->GetError().Fail())
13303cb132a0STamas Berghammer     return result_valobj_sp->GetError();
13313cb132a0STamas Berghammer 
13323cb132a0STamas Berghammer   Scalar scalar;
1333b9c1b51eSKate Stone   if (result_valobj_sp->ResolveValue(scalar)) {
13343cb132a0STamas Berghammer     if (scalar.UInt(1))
133597206d57SZachary Turner       return Status("expression failed: \"%s\"", expr.GetData());
13363cb132a0STamas Berghammer     process->ResetImageToken(image_token);
13373cb132a0STamas Berghammer   }
133897206d57SZachary Turner   return Status();
13393cb132a0STamas Berghammer }
1340fcdde63fSTamas Berghammer 
13413165945aSZachary Turner lldb::ProcessSP PlatformPOSIX::ConnectProcess(llvm::StringRef connect_url,
13423165945aSZachary Turner                                               llvm::StringRef plugin_name,
1343ccd6cffbSTamas Berghammer                                               lldb_private::Debugger &debugger,
1344ccd6cffbSTamas Berghammer                                               lldb_private::Target *target,
134597206d57SZachary Turner                                               lldb_private::Status &error) {
1346ccd6cffbSTamas Berghammer   if (m_remote_platform_sp)
1347b9c1b51eSKate Stone     return m_remote_platform_sp->ConnectProcess(connect_url, plugin_name,
1348b9c1b51eSKate Stone                                                 debugger, target, error);
1349ccd6cffbSTamas Berghammer 
1350b9c1b51eSKate Stone   return Platform::ConnectProcess(connect_url, plugin_name, debugger, target,
1351b9c1b51eSKate Stone                                   error);
1352ccd6cffbSTamas Berghammer }
1353ccd6cffbSTamas Berghammer 
1354f7a5851dSNitesh Jain llvm::StringRef
1355f7a5851dSNitesh Jain PlatformPOSIX::GetLibdlFunctionDeclarations(lldb_private::Process *process) {
1356fcdde63fSTamas Berghammer   return R"(
1357fcdde63fSTamas Berghammer               extern "C" void* dlopen(const char*, int);
1358fcdde63fSTamas Berghammer               extern "C" void* dlsym(void*, const char*);
1359fcdde63fSTamas Berghammer               extern "C" int   dlclose(void*);
1360fcdde63fSTamas Berghammer               extern "C" char* dlerror(void);
1361fcdde63fSTamas Berghammer              )";
1362fcdde63fSTamas Berghammer }
1363ccd6cffbSTamas Berghammer 
1364b9c1b51eSKate Stone size_t PlatformPOSIX::ConnectToWaitingProcesses(Debugger &debugger,
136597206d57SZachary Turner                                                 Status &error) {
1366ccd6cffbSTamas Berghammer   if (m_remote_platform_sp)
1367ccd6cffbSTamas Berghammer     return m_remote_platform_sp->ConnectToWaitingProcesses(debugger, error);
1368ccd6cffbSTamas Berghammer   return Platform::ConnectToWaitingProcesses(debugger, error);
1369ccd6cffbSTamas Berghammer }
1370ec9bc8ccSPavel Labath 
1371ec9bc8ccSPavel Labath ConstString PlatformPOSIX::GetFullNameForDylib(ConstString basename) {
1372ec9bc8ccSPavel Labath   if (basename.IsEmpty())
1373ec9bc8ccSPavel Labath     return basename;
1374ec9bc8ccSPavel Labath 
1375ec9bc8ccSPavel Labath   StreamString stream;
1376ec9bc8ccSPavel Labath   stream.Printf("lib%s.so", basename.GetCString());
1377ec9bc8ccSPavel Labath   return ConstString(stream.GetString());
1378ec9bc8ccSPavel Labath }
1379