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 'G':
144             if (PACKET_STARTS_WITH ("qGroupName:"))             return eServerPacketType_qGroupName;
145             if (PACKET_MATCHES ("qGetWorkingDir"))              return eServerPacketType_qGetWorkingDir;
146             if (PACKET_MATCHES ("qGetPid"))                     return eServerPacketType_qGetPid;
147             if (PACKET_STARTS_WITH ("qGetProfileData;"))        return eServerPacketType_qGetProfileData;
148             if (PACKET_MATCHES ("qGDBServerVersion"))           return eServerPacketType_qGDBServerVersion;
149             break;
150 
151         case 'H':
152             if (PACKET_MATCHES ("qHostInfo"))                   return eServerPacketType_qHostInfo;
153             break;
154 
155         case 'K':
156             if (PACKET_STARTS_WITH ("qKillSpawnedProcess"))     return eServerPacketType_qKillSpawnedProcess;
157             break;
158 
159         case 'L':
160             if (PACKET_STARTS_WITH ("qLaunchGDBServer"))        return eServerPacketType_qLaunchGDBServer;
161             if (PACKET_MATCHES ("qLaunchSuccess"))              return eServerPacketType_qLaunchSuccess;
162             break;
163 
164         case 'M':
165             if (PACKET_STARTS_WITH ("qMemoryRegionInfo:"))      return eServerPacketType_qMemoryRegionInfo;
166             if (PACKET_MATCHES ("qMemoryRegionInfo"))           return eServerPacketType_qMemoryRegionInfoSupported;
167             if (PACKET_STARTS_WITH ("qModuleInfo:"))             return eServerPacketType_qModuleInfo;
168             break;
169 
170         case 'P':
171             if (PACKET_STARTS_WITH ("qProcessInfoPID:"))        return eServerPacketType_qProcessInfoPID;
172             if (PACKET_STARTS_WITH ("qPlatform_shell:"))        return eServerPacketType_qPlatform_shell;
173             if (PACKET_STARTS_WITH ("qPlatform_mkdir:"))        return eServerPacketType_qPlatform_mkdir;
174             if (PACKET_STARTS_WITH ("qPlatform_chmod:"))        return eServerPacketType_qPlatform_chmod;
175             if (PACKET_MATCHES ("qProcessInfo"))                return eServerPacketType_qProcessInfo;
176             break;
177 
178         case 'R':
179             if (PACKET_STARTS_WITH ("qRcmd,"))                  return eServerPacketType_qRcmd;
180             if (PACKET_STARTS_WITH ("qRegisterInfo"))           return eServerPacketType_qRegisterInfo;
181             break;
182 
183         case 'S':
184             if (PACKET_STARTS_WITH ("qSpeedTest:"))             return eServerPacketType_qSpeedTest;
185             if (PACKET_MATCHES ("qShlibInfoAddr"))              return eServerPacketType_qShlibInfoAddr;
186             if (PACKET_MATCHES ("qStepPacketSupported"))        return eServerPacketType_qStepPacketSupported;
187             if (PACKET_STARTS_WITH ("qSupported"))              return eServerPacketType_qSupported;
188             if (PACKET_MATCHES ("qSyncThreadStateSupported"))   return eServerPacketType_qSyncThreadStateSupported;
189             break;
190 
191         case 'T':
192             if (PACKET_STARTS_WITH ("qThreadExtraInfo,"))       return eServerPacketType_qThreadExtraInfo;
193             if (PACKET_STARTS_WITH ("qThreadStopInfo"))         return eServerPacketType_qThreadStopInfo;
194             break;
195 
196         case 'U':
197             if (PACKET_STARTS_WITH ("qUserName:"))              return eServerPacketType_qUserName;
198             break;
199 
200         case 'V':
201             if (PACKET_MATCHES ("qVAttachOrWaitSupported"))     return eServerPacketType_qVAttachOrWaitSupported;
202             break;
203 
204         case 'W':
205             if (PACKET_STARTS_WITH ("qWatchpointSupportInfo:")) return eServerPacketType_qWatchpointSupportInfo;
206             if (PACKET_MATCHES ("qWatchpointSupportInfo"))      return eServerPacketType_qWatchpointSupportInfoSupported;
207             break;
208 
209         case 'X':
210             if (PACKET_STARTS_WITH ("qXfer:auxv:read::"))       return eServerPacketType_qXfer_auxv_read;
211             break;
212         }
213         break;
214     case 'v':
215             if (PACKET_STARTS_WITH("vFile:"))
216             {
217                 if (PACKET_STARTS_WITH("vFile:open:"))          return eServerPacketType_vFile_open;
218                 else if (PACKET_STARTS_WITH("vFile:close:"))    return eServerPacketType_vFile_close;
219                 else if (PACKET_STARTS_WITH("vFile:pread"))     return eServerPacketType_vFile_pread;
220                 else if (PACKET_STARTS_WITH("vFile:pwrite"))    return eServerPacketType_vFile_pwrite;
221                 else if (PACKET_STARTS_WITH("vFile:size"))      return eServerPacketType_vFile_size;
222                 else if (PACKET_STARTS_WITH("vFile:exists"))    return eServerPacketType_vFile_exists;
223                 else if (PACKET_STARTS_WITH("vFile:stat"))      return eServerPacketType_vFile_stat;
224                 else if (PACKET_STARTS_WITH("vFile:mode"))      return eServerPacketType_vFile_mode;
225                 else if (PACKET_STARTS_WITH("vFile:MD5"))       return eServerPacketType_vFile_md5;
226                 else if (PACKET_STARTS_WITH("vFile:symlink"))   return eServerPacketType_vFile_symlink;
227                 else if (PACKET_STARTS_WITH("vFile:unlink"))    return eServerPacketType_vFile_unlink;
228 
229             } else {
230               if (PACKET_STARTS_WITH ("vAttach;"))              return eServerPacketType_vAttach;
231               if (PACKET_STARTS_WITH ("vAttachWait;"))          return eServerPacketType_vAttachWait;
232               if (PACKET_STARTS_WITH ("vAttachOrWait;"))        return eServerPacketType_vAttachOrWait;
233               if (PACKET_STARTS_WITH ("vAttachName;"))          return eServerPacketType_vAttachName;
234               if (PACKET_STARTS_WITH("vCont;"))                 return eServerPacketType_vCont;
235               if (PACKET_MATCHES ("vCont?"))                    return eServerPacketType_vCont_actions;
236             }
237             break;
238       case '_':
239         switch (packet_cstr[1])
240         {
241         case 'M':
242             return eServerPacketType__M;
243 
244         case 'm':
245             return eServerPacketType__m;
246         }
247         break;
248 
249       case '?':
250         if (packet_size == 1) return eServerPacketType_stop_reason;
251         break;
252 
253       case 'c':
254         return eServerPacketType_c;
255 
256       case 'C':
257         return eServerPacketType_C;
258 
259       case 'D':
260         if (packet_size == 1) return eServerPacketType_D;
261         break;
262 
263       case 'g':
264         if (packet_size == 1) return eServerPacketType_g;
265         break;
266 
267       case 'G':
268         return eServerPacketType_G;
269 
270       case 'H':
271         return eServerPacketType_H;
272 
273       case 'I':
274         return eServerPacketType_I;
275 
276       case 'k':
277         if (packet_size == 1) return eServerPacketType_k;
278         break;
279 
280       case 'm':
281         return eServerPacketType_m;
282 
283       case 'M':
284         return eServerPacketType_M;
285 
286       case 'p':
287         return eServerPacketType_p;
288 
289       case 'P':
290         return eServerPacketType_P;
291 
292       case 's':
293         if (packet_size == 1) return eServerPacketType_s;
294         break;
295 
296       case 'S':
297         return eServerPacketType_S;
298 
299       case 'T':
300         return eServerPacketType_T;
301 
302       case 'z':
303         if (packet_cstr[1] >= '0' && packet_cstr[1] <= '4')
304           return eServerPacketType_z;
305         break;
306 
307       case 'Z':
308         if (packet_cstr[1] >= '0' && packet_cstr[1] <= '4')
309           return eServerPacketType_Z;
310         break;
311     }
312     return eServerPacketType_unimplemented;
313 }
314 
315 bool
316 StringExtractorGDBRemote::IsOKResponse() const
317 {
318     return GetResponseType () == eOK;
319 }
320 
321 
322 bool
323 StringExtractorGDBRemote::IsUnsupportedResponse() const
324 {
325     return GetResponseType () == eUnsupported;
326 }
327 
328 bool
329 StringExtractorGDBRemote::IsNormalResponse() const
330 {
331     return GetResponseType () == eResponse;
332 }
333 
334 bool
335 StringExtractorGDBRemote::IsErrorResponse() const
336 {
337     return GetResponseType () == eError &&
338            m_packet.size() == 3 &&
339            isxdigit(m_packet[1]) &&
340            isxdigit(m_packet[2]);
341 }
342 
343 uint8_t
344 StringExtractorGDBRemote::GetError ()
345 {
346     if (GetResponseType() == eError)
347     {
348         SetFilePos(1);
349         return GetHexU8(255);
350     }
351     return 0;
352 }
353 
354 size_t
355 StringExtractorGDBRemote::GetEscapedBinaryData (std::string &str)
356 {
357     // Just get the data bytes in the string as GDBRemoteCommunication::CheckForPacket()
358     // already removes any 0x7d escaped characters. If any 0x7d characters are left in
359     // the packet, then they are supposed to be there...
360     str.clear();
361     const size_t bytes_left = GetBytesLeft();
362     if (bytes_left > 0)
363     {
364         str.assign(m_packet, m_index, bytes_left);
365         m_index += bytes_left;
366     }
367     return str.size();
368 }
369 
370