xref: /llvm-project/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationServerCommon.cpp (revision dbb0c14d2729d135d9d6bb2d0e858e128129da08)
1 //===-- GDBRemoteCommunicationServerCommon.cpp ----------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "GDBRemoteCommunicationServerCommon.h"
10 
11 #include <cerrno>
12 
13 #ifdef __APPLE__
14 #include <TargetConditionals.h>
15 #endif
16 
17 #include <chrono>
18 #include <cstring>
19 
20 #include "lldb/Core/ModuleSpec.h"
21 #include "lldb/Host/Config.h"
22 #include "lldb/Host/File.h"
23 #include "lldb/Host/FileAction.h"
24 #include "lldb/Host/FileSystem.h"
25 #include "lldb/Host/Host.h"
26 #include "lldb/Host/HostInfo.h"
27 #include "lldb/Host/SafeMachO.h"
28 #include "lldb/Interpreter/OptionArgParser.h"
29 #include "lldb/Symbol/ObjectFile.h"
30 #include "lldb/Target/Platform.h"
31 #include "lldb/Utility/Endian.h"
32 #include "lldb/Utility/GDBRemote.h"
33 #include "lldb/Utility/Log.h"
34 #include "lldb/Utility/StreamString.h"
35 #include "lldb/Utility/StructuredData.h"
36 #include "llvm/ADT/StringSwitch.h"
37 #include "llvm/ADT/Triple.h"
38 #include "llvm/Support/JSON.h"
39 
40 #include "ProcessGDBRemoteLog.h"
41 #include "lldb/Utility/StringExtractorGDBRemote.h"
42 
43 #ifdef __ANDROID__
44 #include "lldb/Host/android/HostInfoAndroid.h"
45 #endif
46 
47 
48 using namespace lldb;
49 using namespace lldb_private::process_gdb_remote;
50 using namespace lldb_private;
51 
52 #ifdef __ANDROID__
53 const static uint32_t g_default_packet_timeout_sec = 20; // seconds
54 #else
55 const static uint32_t g_default_packet_timeout_sec = 0; // not specified
56 #endif
57 
58 // GDBRemoteCommunicationServerCommon constructor
59 GDBRemoteCommunicationServerCommon::GDBRemoteCommunicationServerCommon(
60     const char *comm_name, const char *listener_name)
61     : GDBRemoteCommunicationServer(comm_name, listener_name),
62       m_process_launch_info(), m_process_launch_error(), m_proc_infos(),
63       m_proc_infos_index(0) {
64   RegisterMemberFunctionHandler(StringExtractorGDBRemote::eServerPacketType_A,
65                                 &GDBRemoteCommunicationServerCommon::Handle_A);
66   RegisterMemberFunctionHandler(
67       StringExtractorGDBRemote::eServerPacketType_QEnvironment,
68       &GDBRemoteCommunicationServerCommon::Handle_QEnvironment);
69   RegisterMemberFunctionHandler(
70       StringExtractorGDBRemote::eServerPacketType_QEnvironmentHexEncoded,
71       &GDBRemoteCommunicationServerCommon::Handle_QEnvironmentHexEncoded);
72   RegisterMemberFunctionHandler(
73       StringExtractorGDBRemote::eServerPacketType_qfProcessInfo,
74       &GDBRemoteCommunicationServerCommon::Handle_qfProcessInfo);
75   RegisterMemberFunctionHandler(
76       StringExtractorGDBRemote::eServerPacketType_qGroupName,
77       &GDBRemoteCommunicationServerCommon::Handle_qGroupName);
78   RegisterMemberFunctionHandler(
79       StringExtractorGDBRemote::eServerPacketType_qHostInfo,
80       &GDBRemoteCommunicationServerCommon::Handle_qHostInfo);
81   RegisterMemberFunctionHandler(
82       StringExtractorGDBRemote::eServerPacketType_QLaunchArch,
83       &GDBRemoteCommunicationServerCommon::Handle_QLaunchArch);
84   RegisterMemberFunctionHandler(
85       StringExtractorGDBRemote::eServerPacketType_qLaunchSuccess,
86       &GDBRemoteCommunicationServerCommon::Handle_qLaunchSuccess);
87   RegisterMemberFunctionHandler(
88       StringExtractorGDBRemote::eServerPacketType_qEcho,
89       &GDBRemoteCommunicationServerCommon::Handle_qEcho);
90   RegisterMemberFunctionHandler(
91       StringExtractorGDBRemote::eServerPacketType_qModuleInfo,
92       &GDBRemoteCommunicationServerCommon::Handle_qModuleInfo);
93   RegisterMemberFunctionHandler(
94       StringExtractorGDBRemote::eServerPacketType_jModulesInfo,
95       &GDBRemoteCommunicationServerCommon::Handle_jModulesInfo);
96   RegisterMemberFunctionHandler(
97       StringExtractorGDBRemote::eServerPacketType_qPlatform_chmod,
98       &GDBRemoteCommunicationServerCommon::Handle_qPlatform_chmod);
99   RegisterMemberFunctionHandler(
100       StringExtractorGDBRemote::eServerPacketType_qPlatform_mkdir,
101       &GDBRemoteCommunicationServerCommon::Handle_qPlatform_mkdir);
102   RegisterMemberFunctionHandler(
103       StringExtractorGDBRemote::eServerPacketType_qPlatform_shell,
104       &GDBRemoteCommunicationServerCommon::Handle_qPlatform_shell);
105   RegisterMemberFunctionHandler(
106       StringExtractorGDBRemote::eServerPacketType_qProcessInfoPID,
107       &GDBRemoteCommunicationServerCommon::Handle_qProcessInfoPID);
108   RegisterMemberFunctionHandler(
109       StringExtractorGDBRemote::eServerPacketType_QSetDetachOnError,
110       &GDBRemoteCommunicationServerCommon::Handle_QSetDetachOnError);
111   RegisterMemberFunctionHandler(
112       StringExtractorGDBRemote::eServerPacketType_QSetSTDERR,
113       &GDBRemoteCommunicationServerCommon::Handle_QSetSTDERR);
114   RegisterMemberFunctionHandler(
115       StringExtractorGDBRemote::eServerPacketType_QSetSTDIN,
116       &GDBRemoteCommunicationServerCommon::Handle_QSetSTDIN);
117   RegisterMemberFunctionHandler(
118       StringExtractorGDBRemote::eServerPacketType_QSetSTDOUT,
119       &GDBRemoteCommunicationServerCommon::Handle_QSetSTDOUT);
120   RegisterMemberFunctionHandler(
121       StringExtractorGDBRemote::eServerPacketType_qSpeedTest,
122       &GDBRemoteCommunicationServerCommon::Handle_qSpeedTest);
123   RegisterMemberFunctionHandler(
124       StringExtractorGDBRemote::eServerPacketType_qsProcessInfo,
125       &GDBRemoteCommunicationServerCommon::Handle_qsProcessInfo);
126   RegisterMemberFunctionHandler(
127       StringExtractorGDBRemote::eServerPacketType_QStartNoAckMode,
128       &GDBRemoteCommunicationServerCommon::Handle_QStartNoAckMode);
129   RegisterMemberFunctionHandler(
130       StringExtractorGDBRemote::eServerPacketType_qSupported,
131       &GDBRemoteCommunicationServerCommon::Handle_qSupported);
132   RegisterMemberFunctionHandler(
133       StringExtractorGDBRemote::eServerPacketType_qUserName,
134       &GDBRemoteCommunicationServerCommon::Handle_qUserName);
135   RegisterMemberFunctionHandler(
136       StringExtractorGDBRemote::eServerPacketType_vFile_close,
137       &GDBRemoteCommunicationServerCommon::Handle_vFile_Close);
138   RegisterMemberFunctionHandler(
139       StringExtractorGDBRemote::eServerPacketType_vFile_exists,
140       &GDBRemoteCommunicationServerCommon::Handle_vFile_Exists);
141   RegisterMemberFunctionHandler(
142       StringExtractorGDBRemote::eServerPacketType_vFile_md5,
143       &GDBRemoteCommunicationServerCommon::Handle_vFile_MD5);
144   RegisterMemberFunctionHandler(
145       StringExtractorGDBRemote::eServerPacketType_vFile_mode,
146       &GDBRemoteCommunicationServerCommon::Handle_vFile_Mode);
147   RegisterMemberFunctionHandler(
148       StringExtractorGDBRemote::eServerPacketType_vFile_open,
149       &GDBRemoteCommunicationServerCommon::Handle_vFile_Open);
150   RegisterMemberFunctionHandler(
151       StringExtractorGDBRemote::eServerPacketType_vFile_pread,
152       &GDBRemoteCommunicationServerCommon::Handle_vFile_pRead);
153   RegisterMemberFunctionHandler(
154       StringExtractorGDBRemote::eServerPacketType_vFile_pwrite,
155       &GDBRemoteCommunicationServerCommon::Handle_vFile_pWrite);
156   RegisterMemberFunctionHandler(
157       StringExtractorGDBRemote::eServerPacketType_vFile_size,
158       &GDBRemoteCommunicationServerCommon::Handle_vFile_Size);
159   RegisterMemberFunctionHandler(
160       StringExtractorGDBRemote::eServerPacketType_vFile_fstat,
161       &GDBRemoteCommunicationServerCommon::Handle_vFile_FStat);
162   RegisterMemberFunctionHandler(
163       StringExtractorGDBRemote::eServerPacketType_vFile_stat,
164       &GDBRemoteCommunicationServerCommon::Handle_vFile_Stat);
165   RegisterMemberFunctionHandler(
166       StringExtractorGDBRemote::eServerPacketType_vFile_symlink,
167       &GDBRemoteCommunicationServerCommon::Handle_vFile_symlink);
168   RegisterMemberFunctionHandler(
169       StringExtractorGDBRemote::eServerPacketType_vFile_unlink,
170       &GDBRemoteCommunicationServerCommon::Handle_vFile_unlink);
171 }
172 
173 // Destructor
174 GDBRemoteCommunicationServerCommon::~GDBRemoteCommunicationServerCommon() =
175     default;
176 
177 GDBRemoteCommunication::PacketResult
178 GDBRemoteCommunicationServerCommon::Handle_qHostInfo(
179     StringExtractorGDBRemote &packet) {
180   StreamString response;
181 
182   // $cputype:16777223;cpusubtype:3;ostype:Darwin;vendor:apple;endian:little;ptrsize:8;#00
183 
184   ArchSpec host_arch(HostInfo::GetArchitecture());
185   const llvm::Triple &host_triple = host_arch.GetTriple();
186   response.PutCString("triple:");
187   response.PutStringAsRawHex8(host_triple.getTriple());
188   response.Printf(";ptrsize:%u;", host_arch.GetAddressByteSize());
189 
190   const char *distribution_id = host_arch.GetDistributionId().AsCString();
191   if (distribution_id) {
192     response.PutCString("distribution_id:");
193     response.PutStringAsRawHex8(distribution_id);
194     response.PutCString(";");
195   }
196 
197 #if defined(__APPLE__)
198   // For parity with debugserver, we'll include the vendor key.
199   response.PutCString("vendor:apple;");
200 
201   // Send out MachO info.
202   uint32_t cpu = host_arch.GetMachOCPUType();
203   uint32_t sub = host_arch.GetMachOCPUSubType();
204   if (cpu != LLDB_INVALID_CPUTYPE)
205     response.Printf("cputype:%u;", cpu);
206   if (sub != LLDB_INVALID_CPUTYPE)
207     response.Printf("cpusubtype:%u;", sub);
208 
209   if (cpu == llvm::MachO::CPU_TYPE_ARM || cpu == llvm::MachO::CPU_TYPE_ARM64) {
210 // Indicate the OS type.
211 #if defined(TARGET_OS_TV) && TARGET_OS_TV == 1
212     response.PutCString("ostype:tvos;");
213 #elif defined(TARGET_OS_WATCH) && TARGET_OS_WATCH == 1
214     response.PutCString("ostype:watchos;");
215 #elif defined(TARGET_OS_BRIDGE) && TARGET_OS_BRIDGE == 1
216     response.PutCString("ostype:bridgeos;");
217 #else
218     response.PutCString("ostype:ios;");
219 #endif
220 
221     // On arm, we use "synchronous" watchpoints which means the exception is
222     // delivered before the instruction executes.
223     response.PutCString("watchpoint_exceptions_received:before;");
224   } else {
225     response.PutCString("ostype:macosx;");
226     response.Printf("watchpoint_exceptions_received:after;");
227   }
228 
229 #else
230   if (host_arch.GetMachine() == llvm::Triple::aarch64 ||
231       host_arch.GetMachine() == llvm::Triple::aarch64_32 ||
232       host_arch.GetMachine() == llvm::Triple::aarch64_be ||
233       host_arch.GetMachine() == llvm::Triple::arm ||
234       host_arch.GetMachine() == llvm::Triple::armeb || host_arch.IsMIPS())
235     response.Printf("watchpoint_exceptions_received:before;");
236   else
237     response.Printf("watchpoint_exceptions_received:after;");
238 #endif
239 
240   switch (endian::InlHostByteOrder()) {
241   case eByteOrderBig:
242     response.PutCString("endian:big;");
243     break;
244   case eByteOrderLittle:
245     response.PutCString("endian:little;");
246     break;
247   case eByteOrderPDP:
248     response.PutCString("endian:pdp;");
249     break;
250   default:
251     response.PutCString("endian:unknown;");
252     break;
253   }
254 
255   llvm::VersionTuple version = HostInfo::GetOSVersion();
256   if (!version.empty()) {
257     response.Format("os_version:{0}", version.getAsString());
258     response.PutChar(';');
259   }
260 
261 #if defined(__APPLE__)
262   llvm::VersionTuple maccatalyst_version = HostInfo::GetMacCatalystVersion();
263   if (!maccatalyst_version.empty()) {
264     response.Format("maccatalyst_version:{0}",
265                     maccatalyst_version.getAsString());
266     response.PutChar(';');
267   }
268 #endif
269 
270   std::string s;
271   if (HostInfo::GetOSBuildString(s)) {
272     response.PutCString("os_build:");
273     response.PutStringAsRawHex8(s);
274     response.PutChar(';');
275   }
276   if (HostInfo::GetOSKernelDescription(s)) {
277     response.PutCString("os_kernel:");
278     response.PutStringAsRawHex8(s);
279     response.PutChar(';');
280   }
281 
282 #if defined(__APPLE__)
283 
284 #if defined(__arm__) || defined(__arm64__) || defined(__aarch64__)
285   // For iOS devices, we are connected through a USB Mux so we never pretend to
286   // actually have a hostname as far as the remote lldb that is connecting to
287   // this lldb-platform is concerned
288   response.PutCString("hostname:");
289   response.PutStringAsRawHex8("127.0.0.1");
290   response.PutChar(';');
291 #else  // #if defined(__arm__) || defined(__arm64__) || defined(__aarch64__)
292   if (HostInfo::GetHostname(s)) {
293     response.PutCString("hostname:");
294     response.PutStringAsRawHex8(s);
295     response.PutChar(';');
296   }
297 #endif // #if defined(__arm__) || defined(__arm64__) || defined(__aarch64__)
298 
299 #else  // #if defined(__APPLE__)
300   if (HostInfo::GetHostname(s)) {
301     response.PutCString("hostname:");
302     response.PutStringAsRawHex8(s);
303     response.PutChar(';');
304   }
305 #endif // #if defined(__APPLE__)
306 
307   if (g_default_packet_timeout_sec > 0)
308     response.Printf("default_packet_timeout:%u;", g_default_packet_timeout_sec);
309 
310   return SendPacketNoLock(response.GetString());
311 }
312 
313 GDBRemoteCommunication::PacketResult
314 GDBRemoteCommunicationServerCommon::Handle_qProcessInfoPID(
315     StringExtractorGDBRemote &packet) {
316   // Packet format: "qProcessInfoPID:%i" where %i is the pid
317   packet.SetFilePos(::strlen("qProcessInfoPID:"));
318   lldb::pid_t pid = packet.GetU32(LLDB_INVALID_PROCESS_ID);
319   if (pid != LLDB_INVALID_PROCESS_ID) {
320     ProcessInstanceInfo proc_info;
321     if (Host::GetProcessInfo(pid, proc_info)) {
322       StreamString response;
323       CreateProcessInfoResponse(proc_info, response);
324       return SendPacketNoLock(response.GetString());
325     }
326   }
327   return SendErrorResponse(1);
328 }
329 
330 GDBRemoteCommunication::PacketResult
331 GDBRemoteCommunicationServerCommon::Handle_qfProcessInfo(
332     StringExtractorGDBRemote &packet) {
333   m_proc_infos_index = 0;
334   m_proc_infos.clear();
335 
336   ProcessInstanceInfoMatch match_info;
337   packet.SetFilePos(::strlen("qfProcessInfo"));
338   if (packet.GetChar() == ':') {
339     llvm::StringRef key;
340     llvm::StringRef value;
341     while (packet.GetNameColonValue(key, value)) {
342       bool success = true;
343       if (key.equals("name")) {
344         StringExtractor extractor(value);
345         std::string file;
346         extractor.GetHexByteString(file);
347         match_info.GetProcessInfo().GetExecutableFile().SetFile(
348             file, FileSpec::Style::native);
349       } else if (key.equals("name_match")) {
350         NameMatch name_match = llvm::StringSwitch<NameMatch>(value)
351                                    .Case("equals", NameMatch::Equals)
352                                    .Case("starts_with", NameMatch::StartsWith)
353                                    .Case("ends_with", NameMatch::EndsWith)
354                                    .Case("contains", NameMatch::Contains)
355                                    .Case("regex", NameMatch::RegularExpression)
356                                    .Default(NameMatch::Ignore);
357         match_info.SetNameMatchType(name_match);
358         if (name_match == NameMatch::Ignore)
359           return SendErrorResponse(2);
360       } else if (key.equals("pid")) {
361         lldb::pid_t pid = LLDB_INVALID_PROCESS_ID;
362         if (value.getAsInteger(0, pid))
363           return SendErrorResponse(2);
364         match_info.GetProcessInfo().SetProcessID(pid);
365       } else if (key.equals("parent_pid")) {
366         lldb::pid_t pid = LLDB_INVALID_PROCESS_ID;
367         if (value.getAsInteger(0, pid))
368           return SendErrorResponse(2);
369         match_info.GetProcessInfo().SetParentProcessID(pid);
370       } else if (key.equals("uid")) {
371         uint32_t uid = UINT32_MAX;
372         if (value.getAsInteger(0, uid))
373           return SendErrorResponse(2);
374         match_info.GetProcessInfo().SetUserID(uid);
375       } else if (key.equals("gid")) {
376         uint32_t gid = UINT32_MAX;
377         if (value.getAsInteger(0, gid))
378           return SendErrorResponse(2);
379         match_info.GetProcessInfo().SetGroupID(gid);
380       } else if (key.equals("euid")) {
381         uint32_t uid = UINT32_MAX;
382         if (value.getAsInteger(0, uid))
383           return SendErrorResponse(2);
384         match_info.GetProcessInfo().SetEffectiveUserID(uid);
385       } else if (key.equals("egid")) {
386         uint32_t gid = UINT32_MAX;
387         if (value.getAsInteger(0, gid))
388           return SendErrorResponse(2);
389         match_info.GetProcessInfo().SetEffectiveGroupID(gid);
390       } else if (key.equals("all_users")) {
391         match_info.SetMatchAllUsers(
392             OptionArgParser::ToBoolean(value, false, &success));
393       } else if (key.equals("triple")) {
394         match_info.GetProcessInfo().GetArchitecture() =
395             HostInfo::GetAugmentedArchSpec(value);
396       } else {
397         success = false;
398       }
399 
400       if (!success)
401         return SendErrorResponse(2);
402     }
403   }
404 
405   if (Host::FindProcesses(match_info, m_proc_infos)) {
406     // We found something, return the first item by calling the get subsequent
407     // process info packet handler...
408     return Handle_qsProcessInfo(packet);
409   }
410   return SendErrorResponse(3);
411 }
412 
413 GDBRemoteCommunication::PacketResult
414 GDBRemoteCommunicationServerCommon::Handle_qsProcessInfo(
415     StringExtractorGDBRemote &packet) {
416   if (m_proc_infos_index < m_proc_infos.size()) {
417     StreamString response;
418     CreateProcessInfoResponse(m_proc_infos[m_proc_infos_index], response);
419     ++m_proc_infos_index;
420     return SendPacketNoLock(response.GetString());
421   }
422   return SendErrorResponse(4);
423 }
424 
425 GDBRemoteCommunication::PacketResult
426 GDBRemoteCommunicationServerCommon::Handle_qUserName(
427     StringExtractorGDBRemote &packet) {
428 #if LLDB_ENABLE_POSIX
429   Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS));
430   LLDB_LOGF(log, "GDBRemoteCommunicationServerCommon::%s begin", __FUNCTION__);
431 
432   // Packet format: "qUserName:%i" where %i is the uid
433   packet.SetFilePos(::strlen("qUserName:"));
434   uint32_t uid = packet.GetU32(UINT32_MAX);
435   if (uid != UINT32_MAX) {
436     if (llvm::Optional<llvm::StringRef> name =
437             HostInfo::GetUserIDResolver().GetUserName(uid)) {
438       StreamString response;
439       response.PutStringAsRawHex8(*name);
440       return SendPacketNoLock(response.GetString());
441     }
442   }
443   LLDB_LOGF(log, "GDBRemoteCommunicationServerCommon::%s end", __FUNCTION__);
444 #endif
445   return SendErrorResponse(5);
446 }
447 
448 GDBRemoteCommunication::PacketResult
449 GDBRemoteCommunicationServerCommon::Handle_qGroupName(
450     StringExtractorGDBRemote &packet) {
451 #if LLDB_ENABLE_POSIX
452   // Packet format: "qGroupName:%i" where %i is the gid
453   packet.SetFilePos(::strlen("qGroupName:"));
454   uint32_t gid = packet.GetU32(UINT32_MAX);
455   if (gid != UINT32_MAX) {
456     if (llvm::Optional<llvm::StringRef> name =
457             HostInfo::GetUserIDResolver().GetGroupName(gid)) {
458       StreamString response;
459       response.PutStringAsRawHex8(*name);
460       return SendPacketNoLock(response.GetString());
461     }
462   }
463 #endif
464   return SendErrorResponse(6);
465 }
466 
467 GDBRemoteCommunication::PacketResult
468 GDBRemoteCommunicationServerCommon::Handle_qSpeedTest(
469     StringExtractorGDBRemote &packet) {
470   packet.SetFilePos(::strlen("qSpeedTest:"));
471 
472   llvm::StringRef key;
473   llvm::StringRef value;
474   bool success = packet.GetNameColonValue(key, value);
475   if (success && key.equals("response_size")) {
476     uint32_t response_size = 0;
477     if (!value.getAsInteger(0, response_size)) {
478       if (response_size == 0)
479         return SendOKResponse();
480       StreamString response;
481       uint32_t bytes_left = response_size;
482       response.PutCString("data:");
483       while (bytes_left > 0) {
484         if (bytes_left >= 26) {
485           response.PutCString("ABCDEFGHIJKLMNOPQRSTUVWXYZ");
486           bytes_left -= 26;
487         } else {
488           response.Printf("%*.*s;", bytes_left, bytes_left,
489                           "ABCDEFGHIJKLMNOPQRSTUVWXYZ");
490           bytes_left = 0;
491         }
492       }
493       return SendPacketNoLock(response.GetString());
494     }
495   }
496   return SendErrorResponse(7);
497 }
498 
499 GDBRemoteCommunication::PacketResult
500 GDBRemoteCommunicationServerCommon::Handle_vFile_Open(
501     StringExtractorGDBRemote &packet) {
502   packet.SetFilePos(::strlen("vFile:open:"));
503   std::string path;
504   packet.GetHexByteStringTerminatedBy(path, ',');
505   if (!path.empty()) {
506     if (packet.GetChar() == ',') {
507       auto flags = File::OpenOptions(packet.GetHexMaxU32(false, 0));
508       if (packet.GetChar() == ',') {
509         mode_t mode = packet.GetHexMaxU32(false, 0600);
510         FileSpec path_spec(path);
511         FileSystem::Instance().Resolve(path_spec);
512         // Do not close fd.
513         auto file = FileSystem::Instance().Open(path_spec, flags, mode, false);
514 
515         StreamString response;
516         response.PutChar('F');
517 
518         int descriptor = File::kInvalidDescriptor;
519         if (file) {
520           descriptor = file.get()->GetDescriptor();
521           response.Printf("%x", descriptor);
522         } else {
523           response.PutCString("-1");
524           std::error_code code = errorToErrorCode(file.takeError());
525           if (code.category() == std::system_category()) {
526             response.Printf(",%x", code.value());
527           }
528         }
529 
530         return SendPacketNoLock(response.GetString());
531       }
532     }
533   }
534   return SendErrorResponse(18);
535 }
536 
537 GDBRemoteCommunication::PacketResult
538 GDBRemoteCommunicationServerCommon::Handle_vFile_Close(
539     StringExtractorGDBRemote &packet) {
540   packet.SetFilePos(::strlen("vFile:close:"));
541   int fd = packet.GetS32(-1, 16);
542   int err = -1;
543   int save_errno = 0;
544   if (fd >= 0) {
545     NativeFile file(fd, File::OpenOptions(0), true);
546     Status error = file.Close();
547     err = 0;
548     save_errno = error.GetError();
549   } else {
550     save_errno = EINVAL;
551   }
552   StreamString response;
553   response.PutChar('F');
554   response.Printf("%x", err);
555   if (save_errno)
556     response.Printf(",%x", save_errno);
557   return SendPacketNoLock(response.GetString());
558 }
559 
560 GDBRemoteCommunication::PacketResult
561 GDBRemoteCommunicationServerCommon::Handle_vFile_pRead(
562     StringExtractorGDBRemote &packet) {
563   StreamGDBRemote response;
564   packet.SetFilePos(::strlen("vFile:pread:"));
565   int fd = packet.GetS32(-1, 16);
566   if (packet.GetChar() == ',') {
567     size_t count = packet.GetHexMaxU64(false, SIZE_MAX);
568     if (packet.GetChar() == ',') {
569       off_t offset = packet.GetHexMaxU32(false, UINT32_MAX);
570       if (count == SIZE_MAX) {
571         response.Printf("F-1:%x", EINVAL);
572         return SendPacketNoLock(response.GetString());
573       }
574 
575       std::string buffer(count, 0);
576       NativeFile file(fd, File::eOpenOptionReadOnly, false);
577       Status error = file.Read(static_cast<void *>(&buffer[0]), count, offset);
578       const int save_errno = error.GetError();
579       response.PutChar('F');
580       if (error.Success()) {
581         response.Printf("%zx", count);
582         response.PutChar(';');
583         response.PutEscapedBytes(&buffer[0], count);
584       } else {
585         response.PutCString("-1");
586         if (save_errno)
587           response.Printf(",%x", save_errno);
588       }
589       return SendPacketNoLock(response.GetString());
590     }
591   }
592   return SendErrorResponse(21);
593 }
594 
595 GDBRemoteCommunication::PacketResult
596 GDBRemoteCommunicationServerCommon::Handle_vFile_pWrite(
597     StringExtractorGDBRemote &packet) {
598   packet.SetFilePos(::strlen("vFile:pwrite:"));
599 
600   StreamGDBRemote response;
601   response.PutChar('F');
602 
603   int fd = packet.GetS32(-1, 16);
604   if (packet.GetChar() == ',') {
605     off_t offset = packet.GetHexMaxU32(false, UINT32_MAX);
606     if (packet.GetChar() == ',') {
607       std::string buffer;
608       if (packet.GetEscapedBinaryData(buffer)) {
609         NativeFile file(fd, File::eOpenOptionWriteOnly, false);
610         size_t count = buffer.size();
611         Status error =
612             file.Write(static_cast<const void *>(&buffer[0]), count, offset);
613         const int save_errno = error.GetError();
614         if (error.Success())
615           response.Printf("%zx", count);
616         else {
617           response.PutCString("-1");
618           if (save_errno)
619             response.Printf(",%x", save_errno);
620         }
621       } else {
622         response.Printf("-1,%x", EINVAL);
623       }
624       return SendPacketNoLock(response.GetString());
625     }
626   }
627   return SendErrorResponse(27);
628 }
629 
630 GDBRemoteCommunication::PacketResult
631 GDBRemoteCommunicationServerCommon::Handle_vFile_Size(
632     StringExtractorGDBRemote &packet) {
633   packet.SetFilePos(::strlen("vFile:size:"));
634   std::string path;
635   packet.GetHexByteString(path);
636   if (!path.empty()) {
637     uint64_t Size;
638     if (llvm::sys::fs::file_size(path, Size))
639       return SendErrorResponse(5);
640     StreamString response;
641     response.PutChar('F');
642     response.PutHex64(Size);
643     if (Size == UINT64_MAX) {
644       response.PutChar(',');
645       response.PutHex64(Size); // TODO: replace with Host::GetSyswideErrorCode()
646     }
647     return SendPacketNoLock(response.GetString());
648   }
649   return SendErrorResponse(22);
650 }
651 
652 GDBRemoteCommunication::PacketResult
653 GDBRemoteCommunicationServerCommon::Handle_vFile_Mode(
654     StringExtractorGDBRemote &packet) {
655   packet.SetFilePos(::strlen("vFile:mode:"));
656   std::string path;
657   packet.GetHexByteString(path);
658   if (!path.empty()) {
659     FileSpec file_spec(path);
660     FileSystem::Instance().Resolve(file_spec);
661     std::error_code ec;
662     const uint32_t mode = FileSystem::Instance().GetPermissions(file_spec, ec);
663     StreamString response;
664     if (mode != llvm::sys::fs::perms_not_known)
665       response.Printf("F%x", mode);
666     else
667       response.Printf("F-1,%x", (int)Status(ec).GetError());
668     return SendPacketNoLock(response.GetString());
669   }
670   return SendErrorResponse(23);
671 }
672 
673 GDBRemoteCommunication::PacketResult
674 GDBRemoteCommunicationServerCommon::Handle_vFile_Exists(
675     StringExtractorGDBRemote &packet) {
676   packet.SetFilePos(::strlen("vFile:exists:"));
677   std::string path;
678   packet.GetHexByteString(path);
679   if (!path.empty()) {
680     bool retcode = llvm::sys::fs::exists(path);
681     StreamString response;
682     response.PutChar('F');
683     response.PutChar(',');
684     if (retcode)
685       response.PutChar('1');
686     else
687       response.PutChar('0');
688     return SendPacketNoLock(response.GetString());
689   }
690   return SendErrorResponse(24);
691 }
692 
693 GDBRemoteCommunication::PacketResult
694 GDBRemoteCommunicationServerCommon::Handle_vFile_symlink(
695     StringExtractorGDBRemote &packet) {
696   packet.SetFilePos(::strlen("vFile:symlink:"));
697   std::string dst, src;
698   packet.GetHexByteStringTerminatedBy(dst, ',');
699   packet.GetChar(); // Skip ',' char
700   packet.GetHexByteString(src);
701 
702   FileSpec src_spec(src);
703   FileSystem::Instance().Resolve(src_spec);
704   Status error = FileSystem::Instance().Symlink(src_spec, FileSpec(dst));
705 
706   StreamString response;
707   response.Printf("F%x,%x", error.GetError(), error.GetError());
708   return SendPacketNoLock(response.GetString());
709 }
710 
711 GDBRemoteCommunication::PacketResult
712 GDBRemoteCommunicationServerCommon::Handle_vFile_unlink(
713     StringExtractorGDBRemote &packet) {
714   packet.SetFilePos(::strlen("vFile:unlink:"));
715   std::string path;
716   packet.GetHexByteString(path);
717   Status error(llvm::sys::fs::remove(path));
718   StreamString response;
719   response.Printf("F%x,%x", error.GetError(), error.GetError());
720   return SendPacketNoLock(response.GetString());
721 }
722 
723 GDBRemoteCommunication::PacketResult
724 GDBRemoteCommunicationServerCommon::Handle_qPlatform_shell(
725     StringExtractorGDBRemote &packet) {
726   packet.SetFilePos(::strlen("qPlatform_shell:"));
727   std::string path;
728   std::string working_dir;
729   packet.GetHexByteStringTerminatedBy(path, ',');
730   if (!path.empty()) {
731     if (packet.GetChar() == ',') {
732       // FIXME: add timeout to qPlatform_shell packet
733       // uint32_t timeout = packet.GetHexMaxU32(false, 32);
734       if (packet.GetChar() == ',')
735         packet.GetHexByteString(working_dir);
736       int status, signo;
737       std::string output;
738       FileSpec working_spec(working_dir);
739       FileSystem::Instance().Resolve(working_spec);
740       Status err =
741           Host::RunShellCommand(path.c_str(), working_spec, &status, &signo,
742                                 &output, std::chrono::seconds(10));
743       StreamGDBRemote response;
744       if (err.Fail()) {
745         response.PutCString("F,");
746         response.PutHex32(UINT32_MAX);
747       } else {
748         response.PutCString("F,");
749         response.PutHex32(status);
750         response.PutChar(',');
751         response.PutHex32(signo);
752         response.PutChar(',');
753         response.PutEscapedBytes(output.c_str(), output.size());
754       }
755       return SendPacketNoLock(response.GetString());
756     }
757   }
758   return SendErrorResponse(24);
759 }
760 
761 template <typename T, typename U>
762 static void fill_clamp(T &dest, U src, typename T::value_type fallback) {
763   dest = src <= std::numeric_limits<typename T::value_type>::max() ? src
764                                                                    : fallback;
765 }
766 
767 GDBRemoteCommunication::PacketResult
768 GDBRemoteCommunicationServerCommon::Handle_vFile_FStat(
769     StringExtractorGDBRemote &packet) {
770   StreamGDBRemote response;
771   packet.SetFilePos(::strlen("vFile:fstat:"));
772   int fd = packet.GetS32(-1, 16);
773 
774   struct stat file_stats;
775   if (::fstat(fd, &file_stats) == -1) {
776     const int save_errno = errno;
777     response.Printf("F-1,%x", save_errno);
778     return SendPacketNoLock(response.GetString());
779   }
780 
781   GDBRemoteFStatData data;
782   fill_clamp(data.gdb_st_dev, file_stats.st_dev, 0);
783   fill_clamp(data.gdb_st_ino, file_stats.st_ino, 0);
784   data.gdb_st_mode = file_stats.st_mode;
785   fill_clamp(data.gdb_st_nlink, file_stats.st_nlink, UINT32_MAX);
786   fill_clamp(data.gdb_st_uid, file_stats.st_uid, 0);
787   fill_clamp(data.gdb_st_gid, file_stats.st_gid, 0);
788   fill_clamp(data.gdb_st_rdev, file_stats.st_rdev, 0);
789   data.gdb_st_size = file_stats.st_size;
790 #if !defined(_WIN32)
791   data.gdb_st_blksize = file_stats.st_blksize;
792   data.gdb_st_blocks = file_stats.st_blocks;
793 #else
794   data.gdb_st_blksize = 0;
795   data.gdb_st_blocks = 0;
796 #endif
797   fill_clamp(data.gdb_st_atime, file_stats.st_atime, 0);
798   fill_clamp(data.gdb_st_mtime, file_stats.st_mtime, 0);
799   fill_clamp(data.gdb_st_ctime, file_stats.st_ctime, 0);
800 
801   response.Printf("F%zx;", sizeof(data));
802   response.PutEscapedBytes(&data, sizeof(data));
803   return SendPacketNoLock(response.GetString());
804 }
805 
806 GDBRemoteCommunication::PacketResult
807 GDBRemoteCommunicationServerCommon::Handle_vFile_Stat(
808     StringExtractorGDBRemote &packet) {
809   return SendUnimplementedResponse(
810       "GDBRemoteCommunicationServerCommon::Handle_vFile_Stat() unimplemented");
811 }
812 
813 GDBRemoteCommunication::PacketResult
814 GDBRemoteCommunicationServerCommon::Handle_vFile_MD5(
815     StringExtractorGDBRemote &packet) {
816   packet.SetFilePos(::strlen("vFile:MD5:"));
817   std::string path;
818   packet.GetHexByteString(path);
819   if (!path.empty()) {
820     StreamGDBRemote response;
821     auto Result = llvm::sys::fs::md5_contents(path);
822     if (!Result) {
823       response.PutCString("F,");
824       response.PutCString("x");
825     } else {
826       response.PutCString("F,");
827       response.PutHex64(Result->low());
828       response.PutHex64(Result->high());
829     }
830     return SendPacketNoLock(response.GetString());
831   }
832   return SendErrorResponse(25);
833 }
834 
835 GDBRemoteCommunication::PacketResult
836 GDBRemoteCommunicationServerCommon::Handle_qPlatform_mkdir(
837     StringExtractorGDBRemote &packet) {
838   packet.SetFilePos(::strlen("qPlatform_mkdir:"));
839   mode_t mode = packet.GetHexMaxU32(false, UINT32_MAX);
840   if (packet.GetChar() == ',') {
841     std::string path;
842     packet.GetHexByteString(path);
843     Status error(llvm::sys::fs::create_directory(path, mode));
844 
845     StreamGDBRemote response;
846     response.Printf("F%x", error.GetError());
847 
848     return SendPacketNoLock(response.GetString());
849   }
850   return SendErrorResponse(20);
851 }
852 
853 GDBRemoteCommunication::PacketResult
854 GDBRemoteCommunicationServerCommon::Handle_qPlatform_chmod(
855     StringExtractorGDBRemote &packet) {
856   packet.SetFilePos(::strlen("qPlatform_chmod:"));
857 
858   auto perms =
859       static_cast<llvm::sys::fs::perms>(packet.GetHexMaxU32(false, UINT32_MAX));
860   if (packet.GetChar() == ',') {
861     std::string path;
862     packet.GetHexByteString(path);
863     Status error(llvm::sys::fs::setPermissions(path, perms));
864 
865     StreamGDBRemote response;
866     response.Printf("F%x", error.GetError());
867 
868     return SendPacketNoLock(response.GetString());
869   }
870   return SendErrorResponse(19);
871 }
872 
873 GDBRemoteCommunication::PacketResult
874 GDBRemoteCommunicationServerCommon::Handle_qSupported(
875     StringExtractorGDBRemote &packet) {
876   // Parse client-indicated features.
877   llvm::SmallVector<llvm::StringRef, 4> client_features;
878   packet.GetStringRef().split(client_features, ';');
879   return SendPacketNoLock(llvm::join(HandleFeatures(client_features), ";"));
880 }
881 
882 GDBRemoteCommunication::PacketResult
883 GDBRemoteCommunicationServerCommon::Handle_QSetDetachOnError(
884     StringExtractorGDBRemote &packet) {
885   packet.SetFilePos(::strlen("QSetDetachOnError:"));
886   if (packet.GetU32(0))
887     m_process_launch_info.GetFlags().Set(eLaunchFlagDetachOnError);
888   else
889     m_process_launch_info.GetFlags().Clear(eLaunchFlagDetachOnError);
890   return SendOKResponse();
891 }
892 
893 GDBRemoteCommunication::PacketResult
894 GDBRemoteCommunicationServerCommon::Handle_QStartNoAckMode(
895     StringExtractorGDBRemote &packet) {
896   // Send response first before changing m_send_acks to we ack this packet
897   PacketResult packet_result = SendOKResponse();
898   m_send_acks = false;
899   return packet_result;
900 }
901 
902 GDBRemoteCommunication::PacketResult
903 GDBRemoteCommunicationServerCommon::Handle_QSetSTDIN(
904     StringExtractorGDBRemote &packet) {
905   packet.SetFilePos(::strlen("QSetSTDIN:"));
906   FileAction file_action;
907   std::string path;
908   packet.GetHexByteString(path);
909   const bool read = true;
910   const bool write = false;
911   if (file_action.Open(STDIN_FILENO, FileSpec(path), read, write)) {
912     m_process_launch_info.AppendFileAction(file_action);
913     return SendOKResponse();
914   }
915   return SendErrorResponse(15);
916 }
917 
918 GDBRemoteCommunication::PacketResult
919 GDBRemoteCommunicationServerCommon::Handle_QSetSTDOUT(
920     StringExtractorGDBRemote &packet) {
921   packet.SetFilePos(::strlen("QSetSTDOUT:"));
922   FileAction file_action;
923   std::string path;
924   packet.GetHexByteString(path);
925   const bool read = false;
926   const bool write = true;
927   if (file_action.Open(STDOUT_FILENO, FileSpec(path), read, write)) {
928     m_process_launch_info.AppendFileAction(file_action);
929     return SendOKResponse();
930   }
931   return SendErrorResponse(16);
932 }
933 
934 GDBRemoteCommunication::PacketResult
935 GDBRemoteCommunicationServerCommon::Handle_QSetSTDERR(
936     StringExtractorGDBRemote &packet) {
937   packet.SetFilePos(::strlen("QSetSTDERR:"));
938   FileAction file_action;
939   std::string path;
940   packet.GetHexByteString(path);
941   const bool read = false;
942   const bool write = true;
943   if (file_action.Open(STDERR_FILENO, FileSpec(path), read, write)) {
944     m_process_launch_info.AppendFileAction(file_action);
945     return SendOKResponse();
946   }
947   return SendErrorResponse(17);
948 }
949 
950 GDBRemoteCommunication::PacketResult
951 GDBRemoteCommunicationServerCommon::Handle_qLaunchSuccess(
952     StringExtractorGDBRemote &packet) {
953   if (m_process_launch_error.Success())
954     return SendOKResponse();
955   StreamString response;
956   response.PutChar('E');
957   response.PutCString(m_process_launch_error.AsCString("<unknown error>"));
958   return SendPacketNoLock(response.GetString());
959 }
960 
961 GDBRemoteCommunication::PacketResult
962 GDBRemoteCommunicationServerCommon::Handle_QEnvironment(
963     StringExtractorGDBRemote &packet) {
964   packet.SetFilePos(::strlen("QEnvironment:"));
965   const uint32_t bytes_left = packet.GetBytesLeft();
966   if (bytes_left > 0) {
967     m_process_launch_info.GetEnvironment().insert(packet.Peek());
968     return SendOKResponse();
969   }
970   return SendErrorResponse(12);
971 }
972 
973 GDBRemoteCommunication::PacketResult
974 GDBRemoteCommunicationServerCommon::Handle_QEnvironmentHexEncoded(
975     StringExtractorGDBRemote &packet) {
976   packet.SetFilePos(::strlen("QEnvironmentHexEncoded:"));
977   const uint32_t bytes_left = packet.GetBytesLeft();
978   if (bytes_left > 0) {
979     std::string str;
980     packet.GetHexByteString(str);
981     m_process_launch_info.GetEnvironment().insert(str);
982     return SendOKResponse();
983   }
984   return SendErrorResponse(12);
985 }
986 
987 GDBRemoteCommunication::PacketResult
988 GDBRemoteCommunicationServerCommon::Handle_QLaunchArch(
989     StringExtractorGDBRemote &packet) {
990   packet.SetFilePos(::strlen("QLaunchArch:"));
991   const uint32_t bytes_left = packet.GetBytesLeft();
992   if (bytes_left > 0) {
993     const char *arch_triple = packet.Peek();
994     m_process_launch_info.SetArchitecture(
995         HostInfo::GetAugmentedArchSpec(arch_triple));
996     return SendOKResponse();
997   }
998   return SendErrorResponse(13);
999 }
1000 
1001 GDBRemoteCommunication::PacketResult
1002 GDBRemoteCommunicationServerCommon::Handle_A(StringExtractorGDBRemote &packet) {
1003   // The 'A' packet is the most over designed packet ever here with redundant
1004   // argument indexes, redundant argument lengths and needed hex encoded
1005   // argument string values. Really all that is needed is a comma separated hex
1006   // encoded argument value list, but we will stay true to the documented
1007   // version of the 'A' packet here...
1008 
1009   Log *log(GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS));
1010   int actual_arg_index = 0;
1011 
1012   packet.SetFilePos(1); // Skip the 'A'
1013   bool success = true;
1014   while (success && packet.GetBytesLeft() > 0) {
1015     // Decode the decimal argument string length. This length is the number of
1016     // hex nibbles in the argument string value.
1017     const uint32_t arg_len = packet.GetU32(UINT32_MAX);
1018     if (arg_len == UINT32_MAX)
1019       success = false;
1020     else {
1021       // Make sure the argument hex string length is followed by a comma
1022       if (packet.GetChar() != ',')
1023         success = false;
1024       else {
1025         // Decode the argument index. We ignore this really because who would
1026         // really send down the arguments in a random order???
1027         const uint32_t arg_idx = packet.GetU32(UINT32_MAX);
1028         if (arg_idx == UINT32_MAX)
1029           success = false;
1030         else {
1031           // Make sure the argument index is followed by a comma
1032           if (packet.GetChar() != ',')
1033             success = false;
1034           else {
1035             // Decode the argument string value from hex bytes back into a UTF8
1036             // string and make sure the length matches the one supplied in the
1037             // packet
1038             std::string arg;
1039             if (packet.GetHexByteStringFixedLength(arg, arg_len) !=
1040                 (arg_len / 2))
1041               success = false;
1042             else {
1043               // If there are any bytes left
1044               if (packet.GetBytesLeft()) {
1045                 if (packet.GetChar() != ',')
1046                   success = false;
1047               }
1048 
1049               if (success) {
1050                 if (arg_idx == 0)
1051                   m_process_launch_info.GetExecutableFile().SetFile(
1052                       arg, FileSpec::Style::native);
1053                 m_process_launch_info.GetArguments().AppendArgument(arg);
1054                 LLDB_LOGF(log, "LLGSPacketHandler::%s added arg %d: \"%s\"",
1055                           __FUNCTION__, actual_arg_index, arg.c_str());
1056                 ++actual_arg_index;
1057               }
1058             }
1059           }
1060         }
1061       }
1062     }
1063   }
1064 
1065   if (success) {
1066     m_process_launch_error = LaunchProcess();
1067     if (m_process_launch_error.Success())
1068       return SendOKResponse();
1069     LLDB_LOG(log, "failed to launch exe: {0}", m_process_launch_error);
1070   }
1071   return SendErrorResponse(8);
1072 }
1073 
1074 GDBRemoteCommunication::PacketResult
1075 GDBRemoteCommunicationServerCommon::Handle_qEcho(
1076     StringExtractorGDBRemote &packet) {
1077   // Just echo back the exact same packet for qEcho...
1078   return SendPacketNoLock(packet.GetStringRef());
1079 }
1080 
1081 GDBRemoteCommunication::PacketResult
1082 GDBRemoteCommunicationServerCommon::Handle_qModuleInfo(
1083     StringExtractorGDBRemote &packet) {
1084   packet.SetFilePos(::strlen("qModuleInfo:"));
1085 
1086   std::string module_path;
1087   packet.GetHexByteStringTerminatedBy(module_path, ';');
1088   if (module_path.empty())
1089     return SendErrorResponse(1);
1090 
1091   if (packet.GetChar() != ';')
1092     return SendErrorResponse(2);
1093 
1094   std::string triple;
1095   packet.GetHexByteString(triple);
1096 
1097   ModuleSpec matched_module_spec = GetModuleInfo(module_path, triple);
1098   if (!matched_module_spec.GetFileSpec())
1099     return SendErrorResponse(3);
1100 
1101   const auto file_offset = matched_module_spec.GetObjectOffset();
1102   const auto file_size = matched_module_spec.GetObjectSize();
1103   const auto uuid_str = matched_module_spec.GetUUID().GetAsString("");
1104 
1105   StreamGDBRemote response;
1106 
1107   if (uuid_str.empty()) {
1108     auto Result = llvm::sys::fs::md5_contents(
1109         matched_module_spec.GetFileSpec().GetPath());
1110     if (!Result)
1111       return SendErrorResponse(5);
1112     response.PutCString("md5:");
1113     response.PutStringAsRawHex8(Result->digest());
1114   } else {
1115     response.PutCString("uuid:");
1116     response.PutStringAsRawHex8(uuid_str);
1117   }
1118   response.PutChar(';');
1119 
1120   const auto &module_arch = matched_module_spec.GetArchitecture();
1121   response.PutCString("triple:");
1122   response.PutStringAsRawHex8(module_arch.GetTriple().getTriple());
1123   response.PutChar(';');
1124 
1125   response.PutCString("file_path:");
1126   response.PutStringAsRawHex8(matched_module_spec.GetFileSpec().GetCString());
1127   response.PutChar(';');
1128   response.PutCString("file_offset:");
1129   response.PutHex64(file_offset);
1130   response.PutChar(';');
1131   response.PutCString("file_size:");
1132   response.PutHex64(file_size);
1133   response.PutChar(';');
1134 
1135   return SendPacketNoLock(response.GetString());
1136 }
1137 
1138 GDBRemoteCommunication::PacketResult
1139 GDBRemoteCommunicationServerCommon::Handle_jModulesInfo(
1140     StringExtractorGDBRemote &packet) {
1141   namespace json = llvm::json;
1142 
1143   packet.SetFilePos(::strlen("jModulesInfo:"));
1144 
1145   StructuredData::ObjectSP object_sp = StructuredData::ParseJSON(packet.Peek());
1146   if (!object_sp)
1147     return SendErrorResponse(1);
1148 
1149   StructuredData::Array *packet_array = object_sp->GetAsArray();
1150   if (!packet_array)
1151     return SendErrorResponse(2);
1152 
1153   json::Array response_array;
1154   for (size_t i = 0; i < packet_array->GetSize(); ++i) {
1155     StructuredData::Dictionary *query =
1156         packet_array->GetItemAtIndex(i)->GetAsDictionary();
1157     if (!query)
1158       continue;
1159     llvm::StringRef file, triple;
1160     if (!query->GetValueForKeyAsString("file", file) ||
1161         !query->GetValueForKeyAsString("triple", triple))
1162       continue;
1163 
1164     ModuleSpec matched_module_spec = GetModuleInfo(file, triple);
1165     if (!matched_module_spec.GetFileSpec())
1166       continue;
1167 
1168     const auto file_offset = matched_module_spec.GetObjectOffset();
1169     const auto file_size = matched_module_spec.GetObjectSize();
1170     const auto uuid_str = matched_module_spec.GetUUID().GetAsString("");
1171     if (uuid_str.empty())
1172       continue;
1173     const auto triple_str =
1174         matched_module_spec.GetArchitecture().GetTriple().getTriple();
1175     const auto file_path = matched_module_spec.GetFileSpec().GetPath();
1176 
1177     json::Object response{{"uuid", uuid_str},
1178                           {"triple", triple_str},
1179                           {"file_path", file_path},
1180                           {"file_offset", static_cast<int64_t>(file_offset)},
1181                           {"file_size", static_cast<int64_t>(file_size)}};
1182     response_array.push_back(std::move(response));
1183   }
1184 
1185   StreamString response;
1186   response.AsRawOstream() << std::move(response_array);
1187   StreamGDBRemote escaped_response;
1188   escaped_response.PutEscapedBytes(response.GetString().data(),
1189                                    response.GetSize());
1190   return SendPacketNoLock(escaped_response.GetString());
1191 }
1192 
1193 void GDBRemoteCommunicationServerCommon::CreateProcessInfoResponse(
1194     const ProcessInstanceInfo &proc_info, StreamString &response) {
1195   response.Printf(
1196       "pid:%" PRIu64 ";ppid:%" PRIu64 ";uid:%i;gid:%i;euid:%i;egid:%i;",
1197       proc_info.GetProcessID(), proc_info.GetParentProcessID(),
1198       proc_info.GetUserID(), proc_info.GetGroupID(),
1199       proc_info.GetEffectiveUserID(), proc_info.GetEffectiveGroupID());
1200   response.PutCString("name:");
1201   response.PutStringAsRawHex8(proc_info.GetExecutableFile().GetCString());
1202 
1203   response.PutChar(';');
1204   response.PutCString("args:");
1205   response.PutStringAsRawHex8(proc_info.GetArg0());
1206   for (auto &arg : proc_info.GetArguments()) {
1207     response.PutChar('-');
1208     response.PutStringAsRawHex8(arg.ref());
1209   }
1210 
1211   response.PutChar(';');
1212   const ArchSpec &proc_arch = proc_info.GetArchitecture();
1213   if (proc_arch.IsValid()) {
1214     const llvm::Triple &proc_triple = proc_arch.GetTriple();
1215     response.PutCString("triple:");
1216     response.PutStringAsRawHex8(proc_triple.getTriple());
1217     response.PutChar(';');
1218   }
1219 }
1220 
1221 void GDBRemoteCommunicationServerCommon::
1222     CreateProcessInfoResponse_DebugServerStyle(
1223         const ProcessInstanceInfo &proc_info, StreamString &response) {
1224   response.Printf("pid:%" PRIx64 ";parent-pid:%" PRIx64
1225                   ";real-uid:%x;real-gid:%x;effective-uid:%x;effective-gid:%x;",
1226                   proc_info.GetProcessID(), proc_info.GetParentProcessID(),
1227                   proc_info.GetUserID(), proc_info.GetGroupID(),
1228                   proc_info.GetEffectiveUserID(),
1229                   proc_info.GetEffectiveGroupID());
1230 
1231   const ArchSpec &proc_arch = proc_info.GetArchitecture();
1232   if (proc_arch.IsValid()) {
1233     const llvm::Triple &proc_triple = proc_arch.GetTriple();
1234 #if defined(__APPLE__)
1235     // We'll send cputype/cpusubtype.
1236     const uint32_t cpu_type = proc_arch.GetMachOCPUType();
1237     if (cpu_type != 0)
1238       response.Printf("cputype:%" PRIx32 ";", cpu_type);
1239 
1240     const uint32_t cpu_subtype = proc_arch.GetMachOCPUSubType();
1241     if (cpu_subtype != 0)
1242       response.Printf("cpusubtype:%" PRIx32 ";", cpu_subtype);
1243 
1244     const std::string vendor = proc_triple.getVendorName().str();
1245     if (!vendor.empty())
1246       response.Printf("vendor:%s;", vendor.c_str());
1247 #else
1248     // We'll send the triple.
1249     response.PutCString("triple:");
1250     response.PutStringAsRawHex8(proc_triple.getTriple());
1251     response.PutChar(';');
1252 #endif
1253     std::string ostype = std::string(proc_triple.getOSName());
1254     // Adjust so ostype reports ios for Apple/ARM and Apple/ARM64.
1255     if (proc_triple.getVendor() == llvm::Triple::Apple) {
1256       switch (proc_triple.getArch()) {
1257       case llvm::Triple::arm:
1258       case llvm::Triple::thumb:
1259       case llvm::Triple::aarch64:
1260       case llvm::Triple::aarch64_32:
1261         ostype = "ios";
1262         break;
1263       default:
1264         // No change.
1265         break;
1266       }
1267     }
1268     response.Printf("ostype:%s;", ostype.c_str());
1269 
1270     switch (proc_arch.GetByteOrder()) {
1271     case lldb::eByteOrderLittle:
1272       response.PutCString("endian:little;");
1273       break;
1274     case lldb::eByteOrderBig:
1275       response.PutCString("endian:big;");
1276       break;
1277     case lldb::eByteOrderPDP:
1278       response.PutCString("endian:pdp;");
1279       break;
1280     default:
1281       // Nothing.
1282       break;
1283     }
1284     // In case of MIPS64, pointer size is depend on ELF ABI For N32 the pointer
1285     // size is 4 and for N64 it is 8
1286     std::string abi = proc_arch.GetTargetABI();
1287     if (!abi.empty())
1288       response.Printf("elf_abi:%s;", abi.c_str());
1289     response.Printf("ptrsize:%d;", proc_arch.GetAddressByteSize());
1290   }
1291 }
1292 
1293 FileSpec GDBRemoteCommunicationServerCommon::FindModuleFile(
1294     const std::string &module_path, const ArchSpec &arch) {
1295 #ifdef __ANDROID__
1296   return HostInfoAndroid::ResolveLibraryPath(module_path, arch);
1297 #else
1298   FileSpec file_spec(module_path);
1299   FileSystem::Instance().Resolve(file_spec);
1300   return file_spec;
1301 #endif
1302 }
1303 
1304 ModuleSpec
1305 GDBRemoteCommunicationServerCommon::GetModuleInfo(llvm::StringRef module_path,
1306                                                   llvm::StringRef triple) {
1307   ArchSpec arch(triple);
1308 
1309   FileSpec req_module_path_spec(module_path);
1310   FileSystem::Instance().Resolve(req_module_path_spec);
1311 
1312   const FileSpec module_path_spec =
1313       FindModuleFile(req_module_path_spec.GetPath(), arch);
1314   const ModuleSpec module_spec(module_path_spec, arch);
1315 
1316   ModuleSpecList module_specs;
1317   if (!ObjectFile::GetModuleSpecifications(module_path_spec, 0, 0,
1318                                            module_specs))
1319     return ModuleSpec();
1320 
1321   ModuleSpec matched_module_spec;
1322   if (!module_specs.FindMatchingModuleSpec(module_spec, matched_module_spec))
1323     return ModuleSpec();
1324 
1325   return matched_module_spec;
1326 }
1327 
1328 std::vector<std::string> GDBRemoteCommunicationServerCommon::HandleFeatures(
1329     const llvm::ArrayRef<llvm::StringRef> client_features) {
1330   // 128KBytes is a reasonable max packet size--debugger can always use less.
1331   constexpr uint32_t max_packet_size = 128 * 1024;
1332 
1333   // Features common to platform server and llgs.
1334   return {
1335       llvm::formatv("PacketSize={0}", max_packet_size),
1336       "QStartNoAckMode+",
1337       "qEcho+",
1338   };
1339 }
1340