1 //===-- StringExtractorGDBRemote.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 "lldb/Utility/StringExtractorGDBRemote.h" 10 11 #include <cctype> 12 #include <cstring> 13 14 constexpr lldb::pid_t StringExtractorGDBRemote::AllProcesses; 15 constexpr lldb::tid_t StringExtractorGDBRemote::AllThreads; 16 17 StringExtractorGDBRemote::ResponseType 18 StringExtractorGDBRemote::GetResponseType() const { 19 if (m_packet.empty()) 20 return eUnsupported; 21 22 switch (m_packet[0]) { 23 case 'E': 24 if (isxdigit(m_packet[1]) && isxdigit(m_packet[2])) { 25 if (m_packet.size() == 3) 26 return eError; 27 llvm::StringRef packet_ref(m_packet); 28 if (packet_ref[3] == ';') { 29 auto err_string = packet_ref.substr(4); 30 for (auto e : err_string) 31 if (!isxdigit(e)) 32 return eResponse; 33 return eError; 34 } 35 } 36 break; 37 38 case 'O': 39 if (m_packet.size() == 2 && m_packet[1] == 'K') 40 return eOK; 41 break; 42 43 case '+': 44 if (m_packet.size() == 1) 45 return eAck; 46 break; 47 48 case '-': 49 if (m_packet.size() == 1) 50 return eNack; 51 break; 52 } 53 return eResponse; 54 } 55 56 StringExtractorGDBRemote::ServerPacketType 57 StringExtractorGDBRemote::GetServerPacketType() const { 58 #define PACKET_MATCHES(s) \ 59 ((packet_size == (sizeof(s) - 1)) && (strcmp((packet_cstr), (s)) == 0)) 60 #define PACKET_STARTS_WITH(s) \ 61 ((packet_size >= (sizeof(s) - 1)) && \ 62 ::strncmp(packet_cstr, s, (sizeof(s) - 1)) == 0) 63 64 // Empty is not a supported packet... 65 if (m_packet.empty()) 66 return eServerPacketType_invalid; 67 68 const size_t packet_size = m_packet.size(); 69 const char *packet_cstr = m_packet.c_str(); 70 switch (m_packet[0]) { 71 72 case '%': 73 return eServerPacketType_notify; 74 75 case '\x03': 76 if (packet_size == 1) 77 return eServerPacketType_interrupt; 78 break; 79 80 case '-': 81 if (packet_size == 1) 82 return eServerPacketType_nack; 83 break; 84 85 case '+': 86 if (packet_size == 1) 87 return eServerPacketType_ack; 88 break; 89 90 case 'A': 91 return eServerPacketType_A; 92 93 case 'Q': 94 95 switch (packet_cstr[1]) { 96 case 'E': 97 if (PACKET_STARTS_WITH("QEnvironment:")) 98 return eServerPacketType_QEnvironment; 99 if (PACKET_STARTS_WITH("QEnvironmentHexEncoded:")) 100 return eServerPacketType_QEnvironmentHexEncoded; 101 if (PACKET_STARTS_WITH("QEnableErrorStrings")) 102 return eServerPacketType_QEnableErrorStrings; 103 break; 104 105 case 'P': 106 if (PACKET_STARTS_WITH("QPassSignals:")) 107 return eServerPacketType_QPassSignals; 108 break; 109 110 case 'S': 111 if (PACKET_MATCHES("QStartNoAckMode")) 112 return eServerPacketType_QStartNoAckMode; 113 if (PACKET_STARTS_WITH("QSaveRegisterState")) 114 return eServerPacketType_QSaveRegisterState; 115 if (PACKET_STARTS_WITH("QSetDisableASLR:")) 116 return eServerPacketType_QSetDisableASLR; 117 if (PACKET_STARTS_WITH("QSetDetachOnError:")) 118 return eServerPacketType_QSetDetachOnError; 119 if (PACKET_STARTS_WITH("QSetSTDIN:")) 120 return eServerPacketType_QSetSTDIN; 121 if (PACKET_STARTS_WITH("QSetSTDOUT:")) 122 return eServerPacketType_QSetSTDOUT; 123 if (PACKET_STARTS_WITH("QSetSTDERR:")) 124 return eServerPacketType_QSetSTDERR; 125 if (PACKET_STARTS_WITH("QSetWorkingDir:")) 126 return eServerPacketType_QSetWorkingDir; 127 if (PACKET_STARTS_WITH("QSetLogging:")) 128 return eServerPacketType_QSetLogging; 129 if (PACKET_STARTS_WITH("QSetMaxPacketSize:")) 130 return eServerPacketType_QSetMaxPacketSize; 131 if (PACKET_STARTS_WITH("QSetMaxPayloadSize:")) 132 return eServerPacketType_QSetMaxPayloadSize; 133 if (PACKET_STARTS_WITH("QSetEnableAsyncProfiling;")) 134 return eServerPacketType_QSetEnableAsyncProfiling; 135 if (PACKET_STARTS_WITH("QSyncThreadState:")) 136 return eServerPacketType_QSyncThreadState; 137 break; 138 139 case 'L': 140 if (PACKET_STARTS_WITH("QLaunchArch:")) 141 return eServerPacketType_QLaunchArch; 142 if (PACKET_MATCHES("QListThreadsInStopReply")) 143 return eServerPacketType_QListThreadsInStopReply; 144 break; 145 146 case 'R': 147 if (PACKET_STARTS_WITH("QRestoreRegisterState:")) 148 return eServerPacketType_QRestoreRegisterState; 149 break; 150 151 case 'T': 152 if (PACKET_MATCHES("QThreadSuffixSupported")) 153 return eServerPacketType_QThreadSuffixSupported; 154 break; 155 } 156 break; 157 158 case 'q': 159 switch (packet_cstr[1]) { 160 case 's': 161 if (PACKET_MATCHES("qsProcessInfo")) 162 return eServerPacketType_qsProcessInfo; 163 if (PACKET_MATCHES("qsThreadInfo")) 164 return eServerPacketType_qsThreadInfo; 165 break; 166 167 case 'f': 168 if (PACKET_STARTS_WITH("qfProcessInfo")) 169 return eServerPacketType_qfProcessInfo; 170 if (PACKET_STARTS_WITH("qfThreadInfo")) 171 return eServerPacketType_qfThreadInfo; 172 break; 173 174 case 'C': 175 if (packet_size == 2) 176 return eServerPacketType_qC; 177 break; 178 179 case 'E': 180 if (PACKET_STARTS_WITH("qEcho:")) 181 return eServerPacketType_qEcho; 182 break; 183 184 case 'F': 185 if (PACKET_STARTS_WITH("qFileLoadAddress:")) 186 return eServerPacketType_qFileLoadAddress; 187 break; 188 189 case 'G': 190 if (PACKET_STARTS_WITH("qGroupName:")) 191 return eServerPacketType_qGroupName; 192 if (PACKET_MATCHES("qGetWorkingDir")) 193 return eServerPacketType_qGetWorkingDir; 194 if (PACKET_MATCHES("qGetPid")) 195 return eServerPacketType_qGetPid; 196 if (PACKET_STARTS_WITH("qGetProfileData;")) 197 return eServerPacketType_qGetProfileData; 198 if (PACKET_MATCHES("qGDBServerVersion")) 199 return eServerPacketType_qGDBServerVersion; 200 break; 201 202 case 'H': 203 if (PACKET_MATCHES("qHostInfo")) 204 return eServerPacketType_qHostInfo; 205 break; 206 207 case 'K': 208 if (PACKET_STARTS_WITH("qKillSpawnedProcess")) 209 return eServerPacketType_qKillSpawnedProcess; 210 break; 211 212 case 'L': 213 if (PACKET_STARTS_WITH("qLaunchGDBServer")) 214 return eServerPacketType_qLaunchGDBServer; 215 if (PACKET_MATCHES("qLaunchSuccess")) 216 return eServerPacketType_qLaunchSuccess; 217 break; 218 219 case 'M': 220 if (PACKET_STARTS_WITH("qMemoryRegionInfo:")) 221 return eServerPacketType_qMemoryRegionInfo; 222 if (PACKET_MATCHES("qMemoryRegionInfo")) 223 return eServerPacketType_qMemoryRegionInfoSupported; 224 if (PACKET_STARTS_WITH("qModuleInfo:")) 225 return eServerPacketType_qModuleInfo; 226 break; 227 228 case 'P': 229 if (PACKET_STARTS_WITH("qProcessInfoPID:")) 230 return eServerPacketType_qProcessInfoPID; 231 if (PACKET_STARTS_WITH("qPlatform_shell:")) 232 return eServerPacketType_qPlatform_shell; 233 if (PACKET_STARTS_WITH("qPlatform_mkdir:")) 234 return eServerPacketType_qPlatform_mkdir; 235 if (PACKET_STARTS_WITH("qPlatform_chmod:")) 236 return eServerPacketType_qPlatform_chmod; 237 if (PACKET_MATCHES("qProcessInfo")) 238 return eServerPacketType_qProcessInfo; 239 if (PACKET_STARTS_WITH("qPathComplete:")) 240 return eServerPacketType_qPathComplete; 241 break; 242 243 case 'Q': 244 if (PACKET_MATCHES("qQueryGDBServer")) 245 return eServerPacketType_qQueryGDBServer; 246 break; 247 248 case 'R': 249 if (PACKET_STARTS_WITH("qRcmd,")) 250 return eServerPacketType_qRcmd; 251 if (PACKET_STARTS_WITH("qRegisterInfo")) 252 return eServerPacketType_qRegisterInfo; 253 break; 254 255 case 'S': 256 if (PACKET_STARTS_WITH("qSpeedTest:")) 257 return eServerPacketType_qSpeedTest; 258 if (PACKET_MATCHES("qShlibInfoAddr")) 259 return eServerPacketType_qShlibInfoAddr; 260 if (PACKET_MATCHES("qStepPacketSupported")) 261 return eServerPacketType_qStepPacketSupported; 262 if (PACKET_STARTS_WITH("qSupported")) 263 return eServerPacketType_qSupported; 264 if (PACKET_MATCHES("qSyncThreadStateSupported")) 265 return eServerPacketType_qSyncThreadStateSupported; 266 break; 267 268 case 'T': 269 if (PACKET_STARTS_WITH("qThreadExtraInfo,")) 270 return eServerPacketType_qThreadExtraInfo; 271 if (PACKET_STARTS_WITH("qThreadStopInfo")) 272 return eServerPacketType_qThreadStopInfo; 273 break; 274 275 case 'U': 276 if (PACKET_STARTS_WITH("qUserName:")) 277 return eServerPacketType_qUserName; 278 break; 279 280 case 'V': 281 if (PACKET_MATCHES("qVAttachOrWaitSupported")) 282 return eServerPacketType_qVAttachOrWaitSupported; 283 break; 284 285 case 'W': 286 if (PACKET_STARTS_WITH("qWatchpointSupportInfo:")) 287 return eServerPacketType_qWatchpointSupportInfo; 288 if (PACKET_MATCHES("qWatchpointSupportInfo")) 289 return eServerPacketType_qWatchpointSupportInfoSupported; 290 break; 291 292 case 'X': 293 if (PACKET_STARTS_WITH("qXfer:")) 294 return eServerPacketType_qXfer; 295 break; 296 } 297 break; 298 299 case 'j': 300 if (PACKET_STARTS_WITH("jModulesInfo:")) 301 return eServerPacketType_jModulesInfo; 302 if (PACKET_MATCHES("jSignalsInfo")) 303 return eServerPacketType_jSignalsInfo; 304 if (PACKET_MATCHES("jThreadsInfo")) 305 return eServerPacketType_jThreadsInfo; 306 307 if (PACKET_MATCHES("jLLDBTraceSupported")) 308 return eServerPacketType_jLLDBTraceSupported; 309 if (PACKET_STARTS_WITH("jLLDBTraceStop:")) 310 return eServerPacketType_jLLDBTraceStop; 311 if (PACKET_STARTS_WITH("jLLDBTraceStart:")) 312 return eServerPacketType_jLLDBTraceStart; 313 if (PACKET_STARTS_WITH("jLLDBTraceGetState:")) 314 return eServerPacketType_jLLDBTraceGetState; 315 if (PACKET_STARTS_WITH("jLLDBTraceGetBinaryData:")) 316 return eServerPacketType_jLLDBTraceGetBinaryData; 317 break; 318 319 case 'v': 320 if (PACKET_STARTS_WITH("vFile:")) { 321 if (PACKET_STARTS_WITH("vFile:open:")) 322 return eServerPacketType_vFile_open; 323 else if (PACKET_STARTS_WITH("vFile:close:")) 324 return eServerPacketType_vFile_close; 325 else if (PACKET_STARTS_WITH("vFile:pread")) 326 return eServerPacketType_vFile_pread; 327 else if (PACKET_STARTS_WITH("vFile:pwrite")) 328 return eServerPacketType_vFile_pwrite; 329 else if (PACKET_STARTS_WITH("vFile:size")) 330 return eServerPacketType_vFile_size; 331 else if (PACKET_STARTS_WITH("vFile:exists")) 332 return eServerPacketType_vFile_exists; 333 else if (PACKET_STARTS_WITH("vFile:stat")) 334 return eServerPacketType_vFile_stat; 335 else if (PACKET_STARTS_WITH("vFile:mode")) 336 return eServerPacketType_vFile_mode; 337 else if (PACKET_STARTS_WITH("vFile:MD5")) 338 return eServerPacketType_vFile_md5; 339 else if (PACKET_STARTS_WITH("vFile:symlink")) 340 return eServerPacketType_vFile_symlink; 341 else if (PACKET_STARTS_WITH("vFile:unlink")) 342 return eServerPacketType_vFile_unlink; 343 344 } else { 345 if (PACKET_STARTS_WITH("vAttach;")) 346 return eServerPacketType_vAttach; 347 if (PACKET_STARTS_WITH("vAttachWait;")) 348 return eServerPacketType_vAttachWait; 349 if (PACKET_STARTS_WITH("vAttachOrWait;")) 350 return eServerPacketType_vAttachOrWait; 351 if (PACKET_STARTS_WITH("vAttachName;")) 352 return eServerPacketType_vAttachName; 353 if (PACKET_STARTS_WITH("vCont;")) 354 return eServerPacketType_vCont; 355 if (PACKET_MATCHES("vCont?")) 356 return eServerPacketType_vCont_actions; 357 } 358 break; 359 case '_': 360 switch (packet_cstr[1]) { 361 case 'M': 362 return eServerPacketType__M; 363 364 case 'm': 365 return eServerPacketType__m; 366 } 367 break; 368 369 case '?': 370 if (packet_size == 1) 371 return eServerPacketType_stop_reason; 372 break; 373 374 case 'c': 375 return eServerPacketType_c; 376 377 case 'C': 378 return eServerPacketType_C; 379 380 case 'D': 381 return eServerPacketType_D; 382 383 case 'g': 384 return eServerPacketType_g; 385 386 case 'G': 387 return eServerPacketType_G; 388 389 case 'H': 390 return eServerPacketType_H; 391 392 case 'I': 393 return eServerPacketType_I; 394 395 case 'k': 396 if (packet_size == 1) 397 return eServerPacketType_k; 398 break; 399 400 case 'm': 401 return eServerPacketType_m; 402 403 case 'M': 404 return eServerPacketType_M; 405 406 case 'p': 407 return eServerPacketType_p; 408 409 case 'P': 410 return eServerPacketType_P; 411 412 case 's': 413 if (packet_size == 1) 414 return eServerPacketType_s; 415 break; 416 417 case 'S': 418 return eServerPacketType_S; 419 420 case 'x': 421 return eServerPacketType_x; 422 423 case 'X': 424 return eServerPacketType_X; 425 426 case 'T': 427 return eServerPacketType_T; 428 429 case 'z': 430 if (packet_cstr[1] >= '0' && packet_cstr[1] <= '4') 431 return eServerPacketType_z; 432 break; 433 434 case 'Z': 435 if (packet_cstr[1] >= '0' && packet_cstr[1] <= '4') 436 return eServerPacketType_Z; 437 break; 438 } 439 return eServerPacketType_unimplemented; 440 } 441 442 bool StringExtractorGDBRemote::IsOKResponse() const { 443 return GetResponseType() == eOK; 444 } 445 446 bool StringExtractorGDBRemote::IsUnsupportedResponse() const { 447 return GetResponseType() == eUnsupported; 448 } 449 450 bool StringExtractorGDBRemote::IsNormalResponse() const { 451 return GetResponseType() == eResponse; 452 } 453 454 bool StringExtractorGDBRemote::IsErrorResponse() const { 455 return GetResponseType() == eError && isxdigit(m_packet[1]) && 456 isxdigit(m_packet[2]); 457 } 458 459 uint8_t StringExtractorGDBRemote::GetError() { 460 if (GetResponseType() == eError) { 461 SetFilePos(1); 462 return GetHexU8(255); 463 } 464 return 0; 465 } 466 467 lldb_private::Status StringExtractorGDBRemote::GetStatus() { 468 lldb_private::Status error; 469 if (GetResponseType() == eError) { 470 SetFilePos(1); 471 uint8_t errc = GetHexU8(255); 472 error.SetError(errc, lldb::eErrorTypeGeneric); 473 474 error.SetErrorStringWithFormat("Error %u", errc); 475 std::string error_messg; 476 if (GetChar() == ';') { 477 GetHexByteString(error_messg); 478 error.SetErrorString(error_messg); 479 } 480 } 481 return error; 482 } 483 484 size_t StringExtractorGDBRemote::GetEscapedBinaryData(std::string &str) { 485 // Just get the data bytes in the string as 486 // GDBRemoteCommunication::CheckForPacket() already removes any 0x7d escaped 487 // characters. If any 0x7d characters are left in the packet, then they are 488 // supposed to be there... 489 str.clear(); 490 const size_t bytes_left = GetBytesLeft(); 491 if (bytes_left > 0) { 492 str.assign(m_packet, m_index, bytes_left); 493 m_index += bytes_left; 494 } 495 return str.size(); 496 } 497 498 static bool 499 OKErrorNotSupportedResponseValidator(void *, 500 const StringExtractorGDBRemote &response) { 501 switch (response.GetResponseType()) { 502 case StringExtractorGDBRemote::eOK: 503 case StringExtractorGDBRemote::eError: 504 case StringExtractorGDBRemote::eUnsupported: 505 return true; 506 507 case StringExtractorGDBRemote::eAck: 508 case StringExtractorGDBRemote::eNack: 509 case StringExtractorGDBRemote::eResponse: 510 break; 511 } 512 return false; 513 } 514 515 static bool JSONResponseValidator(void *, 516 const StringExtractorGDBRemote &response) { 517 switch (response.GetResponseType()) { 518 case StringExtractorGDBRemote::eUnsupported: 519 case StringExtractorGDBRemote::eError: 520 return true; // Accept unsupported or EXX as valid responses 521 522 case StringExtractorGDBRemote::eOK: 523 case StringExtractorGDBRemote::eAck: 524 case StringExtractorGDBRemote::eNack: 525 break; 526 527 case StringExtractorGDBRemote::eResponse: 528 // JSON that is returned in from JSON query packets is currently always 529 // either a dictionary which starts with a '{', or an array which starts 530 // with a '['. This is a quick validator to just make sure the response 531 // could be valid JSON without having to validate all of the 532 // JSON content. 533 switch (response.GetStringRef()[0]) { 534 case '{': 535 return true; 536 case '[': 537 return true; 538 default: 539 break; 540 } 541 break; 542 } 543 return false; 544 } 545 546 static bool 547 ASCIIHexBytesResponseValidator(void *, 548 const StringExtractorGDBRemote &response) { 549 switch (response.GetResponseType()) { 550 case StringExtractorGDBRemote::eUnsupported: 551 case StringExtractorGDBRemote::eError: 552 return true; // Accept unsupported or EXX as valid responses 553 554 case StringExtractorGDBRemote::eOK: 555 case StringExtractorGDBRemote::eAck: 556 case StringExtractorGDBRemote::eNack: 557 break; 558 559 case StringExtractorGDBRemote::eResponse: { 560 uint32_t valid_count = 0; 561 for (const char ch : response.GetStringRef()) { 562 if (!isxdigit(ch)) { 563 return false; 564 } 565 if (++valid_count >= 16) 566 break; // Don't validate all the characters in case the packet is very 567 // large 568 } 569 return true; 570 } break; 571 } 572 return false; 573 } 574 575 void StringExtractorGDBRemote::CopyResponseValidator( 576 const StringExtractorGDBRemote &rhs) { 577 m_validator = rhs.m_validator; 578 m_validator_baton = rhs.m_validator_baton; 579 } 580 581 void StringExtractorGDBRemote::SetResponseValidator( 582 ResponseValidatorCallback callback, void *baton) { 583 m_validator = callback; 584 m_validator_baton = baton; 585 } 586 587 void StringExtractorGDBRemote::SetResponseValidatorToOKErrorNotSupported() { 588 m_validator = OKErrorNotSupportedResponseValidator; 589 m_validator_baton = nullptr; 590 } 591 592 void StringExtractorGDBRemote::SetResponseValidatorToASCIIHexBytes() { 593 m_validator = ASCIIHexBytesResponseValidator; 594 m_validator_baton = nullptr; 595 } 596 597 void StringExtractorGDBRemote::SetResponseValidatorToJSON() { 598 m_validator = JSONResponseValidator; 599 m_validator_baton = nullptr; 600 } 601 602 bool StringExtractorGDBRemote::ValidateResponse() const { 603 // If we have a validator callback, try to validate the callback 604 if (m_validator) 605 return m_validator(m_validator_baton, *this); 606 else 607 return true; // No validator, so response is valid 608 } 609 610 llvm::Optional<std::pair<lldb::pid_t, lldb::tid_t>> 611 StringExtractorGDBRemote::GetPidTid(lldb::pid_t default_pid) { 612 llvm::StringRef view = llvm::StringRef(m_packet).substr(m_index); 613 size_t initial_length = view.size(); 614 lldb::pid_t pid = default_pid; 615 lldb::tid_t tid; 616 617 if (view.consume_front("p")) { 618 // process identifier 619 if (view.consume_front("-1")) { 620 // -1 is a special case 621 pid = AllProcesses; 622 } else if (view.consumeInteger(16, pid) || pid == 0) { 623 // not a valid hex integer OR unsupported pid 0 624 m_index = UINT64_MAX; 625 return llvm::None; 626 } 627 628 // "." must follow if we expect TID too; otherwise, we assume -1 629 if (!view.consume_front(".")) { 630 // update m_index 631 m_index += initial_length - view.size(); 632 633 return {{pid, AllThreads}}; 634 } 635 } 636 637 // thread identifier 638 if (view.consume_front("-1")) { 639 // -1 is a special case 640 tid = AllThreads; 641 } else if (view.consumeInteger(16, tid) || tid == 0 || pid == AllProcesses) { 642 // not a valid hex integer OR tid 0 OR pid -1 + a specific tid 643 m_index = UINT64_MAX; 644 return llvm::None; 645 } 646 647 // update m_index 648 m_index += initial_length - view.size(); 649 650 return {{pid, tid}}; 651 } 652