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