xref: /llvm-project/lldb/source/Utility/StringExtractorGDBRemote.cpp (revision 98d0a4b39a89ad4d667d9150a008a0c36be94f1f)
1 //===-- StringExtractorGDBRemote.cpp ----------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 // C Includes
11 #include <string.h>
12 
13 // C++ Includes
14 // Other libraries and framework includes
15 // Project includes
16 #include "Utility/StringExtractorGDBRemote.h"
17 
18 
19 
20 StringExtractorGDBRemote::ResponseType
21 StringExtractorGDBRemote::GetResponseType () const
22 {
23     if (m_packet.empty())
24         return eUnsupported;
25 
26     switch (m_packet[0])
27     {
28     case 'E':
29         if (m_packet.size() == 3 &&
30             isxdigit(m_packet[1]) &&
31             isxdigit(m_packet[2]))
32             return eError;
33         break;
34 
35     case 'O':
36         if (m_packet.size() == 2 && m_packet[1] == 'K')
37             return eOK;
38         break;
39 
40     case '+':
41         if (m_packet.size() == 1)
42             return eAck;
43         break;
44 
45     case '-':
46         if (m_packet.size() == 1)
47             return eNack;
48         break;
49     }
50     return eResponse;
51 }
52 
53 StringExtractorGDBRemote::ServerPacketType
54 StringExtractorGDBRemote::GetServerPacketType () const
55 {
56 #define PACKET_MATCHES(s) ((packet_size == (sizeof(s)-1)) && (strcmp((packet_cstr),(s)) == 0))
57 #define PACKET_STARTS_WITH(s) ((packet_size >= (sizeof(s)-1)) && ::strncmp(packet_cstr, s, (sizeof(s)-1))==0)
58 
59     // Empty is not a supported packet...
60     if (m_packet.empty())
61         return eServerPacketType_invalid;
62 
63     const size_t packet_size = m_packet.size();
64     const char *packet_cstr = m_packet.c_str();
65     switch (m_packet[0])
66     {
67 
68     case '%':
69         return eServerPacketType_notify;
70 
71     case '\x03':
72         if (packet_size == 1) return eServerPacketType_interrupt;
73         break;
74 
75     case '-':
76         if (packet_size == 1) return eServerPacketType_nack;
77         break;
78 
79     case '+':
80         if (packet_size == 1) return eServerPacketType_ack;
81         break;
82 
83     case 'A':
84         return eServerPacketType_A;
85 
86     case 'Q':
87 
88         switch (packet_cstr[1])
89         {
90         case 'E':
91             if (PACKET_STARTS_WITH ("QEnvironment:"))           return eServerPacketType_QEnvironment;
92             if (PACKET_STARTS_WITH ("QEnvironmentHexEncoded:")) return eServerPacketType_QEnvironmentHexEncoded;
93             break;
94 
95         case 'S':
96             if (PACKET_MATCHES ("QStartNoAckMode"))               return eServerPacketType_QStartNoAckMode;
97             if (PACKET_STARTS_WITH ("QSaveRegisterState"))        return eServerPacketType_QSaveRegisterState;
98             if (PACKET_STARTS_WITH ("QSetDisableASLR:"))          return eServerPacketType_QSetDisableASLR;
99             if (PACKET_STARTS_WITH ("QSetDetachOnError:"))        return eServerPacketType_QSetDetachOnError;
100             if (PACKET_STARTS_WITH ("QSetSTDIN:"))                return eServerPacketType_QSetSTDIN;
101             if (PACKET_STARTS_WITH ("QSetSTDOUT:"))               return eServerPacketType_QSetSTDOUT;
102             if (PACKET_STARTS_WITH ("QSetSTDERR:"))               return eServerPacketType_QSetSTDERR;
103             if (PACKET_STARTS_WITH ("QSetWorkingDir:"))           return eServerPacketType_QSetWorkingDir;
104             if (PACKET_STARTS_WITH ("QSetLogging:"))              return eServerPacketType_QSetLogging;
105             if (PACKET_STARTS_WITH ("QSetMaxPacketSize:"))        return eServerPacketType_QSetMaxPacketSize;
106             if (PACKET_STARTS_WITH ("QSetMaxPayloadSize:"))       return eServerPacketType_QSetMaxPayloadSize;
107             if (PACKET_STARTS_WITH ("QSetEnableAsyncProfiling;")) return eServerPacketType_QSetEnableAsyncProfiling;
108             if (PACKET_STARTS_WITH ("QSyncThreadState:"))         return eServerPacketType_QSyncThreadState;
109             break;
110 
111         case 'L':
112             if (PACKET_STARTS_WITH ("QLaunchArch:"))              return eServerPacketType_QLaunchArch;
113             if (PACKET_MATCHES("QListThreadsInStopReply"))        return eServerPacketType_QListThreadsInStopReply;
114             break;
115 
116         case 'R':
117             if (PACKET_STARTS_WITH ("QRestoreRegisterState:"))    return eServerPacketType_QRestoreRegisterState;
118             break;
119 
120         case 'T':
121             if (PACKET_MATCHES ("QThreadSuffixSupported"))        return eServerPacketType_QThreadSuffixSupported;
122             break;
123         }
124         break;
125 
126     case 'q':
127         switch (packet_cstr[1])
128         {
129         case 's':
130             if (PACKET_MATCHES ("qsProcessInfo"))               return eServerPacketType_qsProcessInfo;
131             if (PACKET_MATCHES ("qsThreadInfo"))                return eServerPacketType_qsThreadInfo;
132             break;
133 
134         case 'f':
135             if (PACKET_STARTS_WITH ("qfProcessInfo"))           return eServerPacketType_qfProcessInfo;
136             if (PACKET_STARTS_WITH ("qfThreadInfo"))            return eServerPacketType_qfThreadInfo;
137             break;
138 
139         case 'C':
140             if (packet_size == 2)                               return eServerPacketType_qC;
141             break;
142 
143         case 'E':
144             if (PACKET_STARTS_WITH ("qEcho:"))                  return eServerPacketType_qEcho;
145             break;
146 
147         case 'F':
148             if (PACKET_STARTS_WITH ("qFileLoadAddress:"))       return eServerPacketType_qFileLoadAddress;
149             break;
150 
151         case 'G':
152             if (PACKET_STARTS_WITH ("qGroupName:"))             return eServerPacketType_qGroupName;
153             if (PACKET_MATCHES ("qGetWorkingDir"))              return eServerPacketType_qGetWorkingDir;
154             if (PACKET_MATCHES ("qGetPid"))                     return eServerPacketType_qGetPid;
155             if (PACKET_STARTS_WITH ("qGetProfileData;"))        return eServerPacketType_qGetProfileData;
156             if (PACKET_MATCHES ("qGDBServerVersion"))           return eServerPacketType_qGDBServerVersion;
157             break;
158 
159         case 'H':
160             if (PACKET_MATCHES ("qHostInfo"))                   return eServerPacketType_qHostInfo;
161             break;
162 
163         case 'K':
164             if (PACKET_STARTS_WITH ("qKillSpawnedProcess"))     return eServerPacketType_qKillSpawnedProcess;
165             break;
166 
167         case 'L':
168             if (PACKET_STARTS_WITH ("qLaunchGDBServer"))        return eServerPacketType_qLaunchGDBServer;
169             if (PACKET_MATCHES ("qLaunchSuccess"))              return eServerPacketType_qLaunchSuccess;
170             break;
171 
172         case 'M':
173             if (PACKET_STARTS_WITH ("qMemoryRegionInfo:"))      return eServerPacketType_qMemoryRegionInfo;
174             if (PACKET_MATCHES ("qMemoryRegionInfo"))           return eServerPacketType_qMemoryRegionInfoSupported;
175             if (PACKET_STARTS_WITH ("qModuleInfo:"))             return eServerPacketType_qModuleInfo;
176             break;
177 
178         case 'P':
179             if (PACKET_STARTS_WITH ("qProcessInfoPID:"))        return eServerPacketType_qProcessInfoPID;
180             if (PACKET_STARTS_WITH ("qPlatform_shell:"))        return eServerPacketType_qPlatform_shell;
181             if (PACKET_STARTS_WITH ("qPlatform_mkdir:"))        return eServerPacketType_qPlatform_mkdir;
182             if (PACKET_STARTS_WITH ("qPlatform_chmod:"))        return eServerPacketType_qPlatform_chmod;
183             if (PACKET_MATCHES ("qProcessInfo"))                return eServerPacketType_qProcessInfo;
184             break;
185 
186         case 'R':
187             if (PACKET_STARTS_WITH ("qRcmd,"))                  return eServerPacketType_qRcmd;
188             if (PACKET_STARTS_WITH ("qRegisterInfo"))           return eServerPacketType_qRegisterInfo;
189             break;
190 
191         case 'S':
192             if (PACKET_STARTS_WITH ("qSpeedTest:"))             return eServerPacketType_qSpeedTest;
193             if (PACKET_MATCHES ("qShlibInfoAddr"))              return eServerPacketType_qShlibInfoAddr;
194             if (PACKET_MATCHES ("qStepPacketSupported"))        return eServerPacketType_qStepPacketSupported;
195             if (PACKET_STARTS_WITH ("qSupported"))              return eServerPacketType_qSupported;
196             if (PACKET_MATCHES ("qSyncThreadStateSupported"))   return eServerPacketType_qSyncThreadStateSupported;
197             break;
198 
199         case 'T':
200             if (PACKET_STARTS_WITH ("qThreadExtraInfo,"))       return eServerPacketType_qThreadExtraInfo;
201             if (PACKET_STARTS_WITH ("qThreadStopInfo"))         return eServerPacketType_qThreadStopInfo;
202             break;
203 
204         case 'U':
205             if (PACKET_STARTS_WITH ("qUserName:"))              return eServerPacketType_qUserName;
206             break;
207 
208         case 'V':
209             if (PACKET_MATCHES ("qVAttachOrWaitSupported"))     return eServerPacketType_qVAttachOrWaitSupported;
210             break;
211 
212         case 'W':
213             if (PACKET_STARTS_WITH ("qWatchpointSupportInfo:")) return eServerPacketType_qWatchpointSupportInfo;
214             if (PACKET_MATCHES ("qWatchpointSupportInfo"))      return eServerPacketType_qWatchpointSupportInfoSupported;
215             break;
216 
217         case 'X':
218             if (PACKET_STARTS_WITH ("qXfer:auxv:read::"))       return eServerPacketType_qXfer_auxv_read;
219             break;
220         }
221         break;
222 
223     case 'j':
224         if (PACKET_MATCHES("jSignalInfo")) return eServerPacketType_jSignalsInfo;
225 
226     case 'v':
227             if (PACKET_STARTS_WITH("vFile:"))
228             {
229                 if (PACKET_STARTS_WITH("vFile:open:"))          return eServerPacketType_vFile_open;
230                 else if (PACKET_STARTS_WITH("vFile:close:"))    return eServerPacketType_vFile_close;
231                 else if (PACKET_STARTS_WITH("vFile:pread"))     return eServerPacketType_vFile_pread;
232                 else if (PACKET_STARTS_WITH("vFile:pwrite"))    return eServerPacketType_vFile_pwrite;
233                 else if (PACKET_STARTS_WITH("vFile:size"))      return eServerPacketType_vFile_size;
234                 else if (PACKET_STARTS_WITH("vFile:exists"))    return eServerPacketType_vFile_exists;
235                 else if (PACKET_STARTS_WITH("vFile:stat"))      return eServerPacketType_vFile_stat;
236                 else if (PACKET_STARTS_WITH("vFile:mode"))      return eServerPacketType_vFile_mode;
237                 else if (PACKET_STARTS_WITH("vFile:MD5"))       return eServerPacketType_vFile_md5;
238                 else if (PACKET_STARTS_WITH("vFile:symlink"))   return eServerPacketType_vFile_symlink;
239                 else if (PACKET_STARTS_WITH("vFile:unlink"))    return eServerPacketType_vFile_unlink;
240 
241             } else {
242               if (PACKET_STARTS_WITH ("vAttach;"))              return eServerPacketType_vAttach;
243               if (PACKET_STARTS_WITH ("vAttachWait;"))          return eServerPacketType_vAttachWait;
244               if (PACKET_STARTS_WITH ("vAttachOrWait;"))        return eServerPacketType_vAttachOrWait;
245               if (PACKET_STARTS_WITH ("vAttachName;"))          return eServerPacketType_vAttachName;
246               if (PACKET_STARTS_WITH("vCont;"))                 return eServerPacketType_vCont;
247               if (PACKET_MATCHES ("vCont?"))                    return eServerPacketType_vCont_actions;
248             }
249             break;
250       case '_':
251         switch (packet_cstr[1])
252         {
253         case 'M':
254             return eServerPacketType__M;
255 
256         case 'm':
257             return eServerPacketType__m;
258         }
259         break;
260 
261       case '?':
262         if (packet_size == 1) return eServerPacketType_stop_reason;
263         break;
264 
265       case 'c':
266         return eServerPacketType_c;
267 
268       case 'C':
269         return eServerPacketType_C;
270 
271       case 'D':
272         if (packet_size == 1) return eServerPacketType_D;
273         break;
274 
275       case 'g':
276         if (packet_size == 1) return eServerPacketType_g;
277         break;
278 
279       case 'G':
280         return eServerPacketType_G;
281 
282       case 'H':
283         return eServerPacketType_H;
284 
285       case 'I':
286         return eServerPacketType_I;
287 
288       case 'k':
289         if (packet_size == 1) return eServerPacketType_k;
290         break;
291 
292       case 'm':
293         return eServerPacketType_m;
294 
295       case 'M':
296         return eServerPacketType_M;
297 
298       case 'p':
299         return eServerPacketType_p;
300 
301       case 'P':
302         return eServerPacketType_P;
303 
304       case 's':
305         if (packet_size == 1) return eServerPacketType_s;
306         break;
307 
308       case 'S':
309         return eServerPacketType_S;
310 
311       case 'T':
312         return eServerPacketType_T;
313 
314       case 'z':
315         if (packet_cstr[1] >= '0' && packet_cstr[1] <= '4')
316           return eServerPacketType_z;
317         break;
318 
319       case 'Z':
320         if (packet_cstr[1] >= '0' && packet_cstr[1] <= '4')
321           return eServerPacketType_Z;
322         break;
323     }
324     return eServerPacketType_unimplemented;
325 }
326 
327 bool
328 StringExtractorGDBRemote::IsOKResponse() const
329 {
330     return GetResponseType () == eOK;
331 }
332 
333 
334 bool
335 StringExtractorGDBRemote::IsUnsupportedResponse() const
336 {
337     return GetResponseType () == eUnsupported;
338 }
339 
340 bool
341 StringExtractorGDBRemote::IsNormalResponse() const
342 {
343     return GetResponseType () == eResponse;
344 }
345 
346 bool
347 StringExtractorGDBRemote::IsErrorResponse() const
348 {
349     return GetResponseType () == eError &&
350            m_packet.size() == 3 &&
351            isxdigit(m_packet[1]) &&
352            isxdigit(m_packet[2]);
353 }
354 
355 uint8_t
356 StringExtractorGDBRemote::GetError ()
357 {
358     if (GetResponseType() == eError)
359     {
360         SetFilePos(1);
361         return GetHexU8(255);
362     }
363     return 0;
364 }
365 
366 size_t
367 StringExtractorGDBRemote::GetEscapedBinaryData (std::string &str)
368 {
369     // Just get the data bytes in the string as GDBRemoteCommunication::CheckForPacket()
370     // already removes any 0x7d escaped characters. If any 0x7d characters are left in
371     // the packet, then they are supposed to be there...
372     str.clear();
373     const size_t bytes_left = GetBytesLeft();
374     if (bytes_left > 0)
375     {
376         str.assign(m_packet, m_index, bytes_left);
377         m_index += bytes_left;
378     }
379     return str.size();
380 }
381 
382