1 //===-- GDBRemoteCommunication.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 11 #include "GDBRemoteCommunication.h" 12 13 // C Includes 14 #include <limits.h> 15 #include <string.h> 16 #include <sys/stat.h> 17 18 // C++ Includes 19 // Other libraries and framework includes 20 #include "lldb/Core/Log.h" 21 #include "lldb/Core/StreamFile.h" 22 #include "lldb/Core/StreamString.h" 23 #include "lldb/Host/ConnectionFileDescriptor.h" 24 #include "lldb/Host/FileSpec.h" 25 #include "lldb/Host/Host.h" 26 #include "lldb/Host/HostInfo.h" 27 #include "lldb/Host/Pipe.h" 28 #include "lldb/Host/Socket.h" 29 #include "lldb/Host/StringConvert.h" 30 #include "lldb/Host/ThreadLauncher.h" 31 #include "lldb/Host/TimeValue.h" 32 #include "lldb/Target/Process.h" 33 #include "llvm/ADT/SmallString.h" 34 35 // Project includes 36 #include "ProcessGDBRemoteLog.h" 37 38 #if defined(__APPLE__) 39 # define DEBUGSERVER_BASENAME "debugserver" 40 #else 41 # define DEBUGSERVER_BASENAME "lldb-server" 42 #endif 43 44 using namespace lldb; 45 using namespace lldb_private; 46 using namespace lldb_private::process_gdb_remote; 47 48 GDBRemoteCommunication::History::History (uint32_t size) : 49 m_packets(), 50 m_curr_idx (0), 51 m_total_packet_count (0), 52 m_dumped_to_log (false) 53 { 54 m_packets.resize(size); 55 } 56 57 GDBRemoteCommunication::History::~History () 58 { 59 } 60 61 void 62 GDBRemoteCommunication::History::AddPacket (char packet_char, 63 PacketType type, 64 uint32_t bytes_transmitted) 65 { 66 const size_t size = m_packets.size(); 67 if (size > 0) 68 { 69 const uint32_t idx = GetNextIndex(); 70 m_packets[idx].packet.assign (1, packet_char); 71 m_packets[idx].type = type; 72 m_packets[idx].bytes_transmitted = bytes_transmitted; 73 m_packets[idx].packet_idx = m_total_packet_count; 74 m_packets[idx].tid = Host::GetCurrentThreadID(); 75 } 76 } 77 78 void 79 GDBRemoteCommunication::History::AddPacket (const std::string &src, 80 uint32_t src_len, 81 PacketType type, 82 uint32_t bytes_transmitted) 83 { 84 const size_t size = m_packets.size(); 85 if (size > 0) 86 { 87 const uint32_t idx = GetNextIndex(); 88 m_packets[idx].packet.assign (src, 0, src_len); 89 m_packets[idx].type = type; 90 m_packets[idx].bytes_transmitted = bytes_transmitted; 91 m_packets[idx].packet_idx = m_total_packet_count; 92 m_packets[idx].tid = Host::GetCurrentThreadID(); 93 } 94 } 95 96 void 97 GDBRemoteCommunication::History::Dump (Stream &strm) const 98 { 99 const uint32_t size = GetNumPacketsInHistory (); 100 const uint32_t first_idx = GetFirstSavedPacketIndex (); 101 const uint32_t stop_idx = m_curr_idx + size; 102 for (uint32_t i = first_idx; i < stop_idx; ++i) 103 { 104 const uint32_t idx = NormalizeIndex (i); 105 const Entry &entry = m_packets[idx]; 106 if (entry.type == ePacketTypeInvalid || entry.packet.empty()) 107 break; 108 strm.Printf ("history[%u] tid=0x%4.4" PRIx64 " <%4u> %s packet: %s\n", 109 entry.packet_idx, 110 entry.tid, 111 entry.bytes_transmitted, 112 (entry.type == ePacketTypeSend) ? "send" : "read", 113 entry.packet.c_str()); 114 } 115 } 116 117 void 118 GDBRemoteCommunication::History::Dump (Log *log) const 119 { 120 if (log && !m_dumped_to_log) 121 { 122 m_dumped_to_log = true; 123 const uint32_t size = GetNumPacketsInHistory (); 124 const uint32_t first_idx = GetFirstSavedPacketIndex (); 125 const uint32_t stop_idx = m_curr_idx + size; 126 for (uint32_t i = first_idx; i < stop_idx; ++i) 127 { 128 const uint32_t idx = NormalizeIndex (i); 129 const Entry &entry = m_packets[idx]; 130 if (entry.type == ePacketTypeInvalid || entry.packet.empty()) 131 break; 132 log->Printf ("history[%u] tid=0x%4.4" PRIx64 " <%4u> %s packet: %s", 133 entry.packet_idx, 134 entry.tid, 135 entry.bytes_transmitted, 136 (entry.type == ePacketTypeSend) ? "send" : "read", 137 entry.packet.c_str()); 138 } 139 } 140 } 141 142 //---------------------------------------------------------------------- 143 // GDBRemoteCommunication constructor 144 //---------------------------------------------------------------------- 145 GDBRemoteCommunication::GDBRemoteCommunication(const char *comm_name, 146 const char *listener_name) : 147 Communication(comm_name), 148 #ifdef LLDB_CONFIGURATION_DEBUG 149 m_packet_timeout (1000), 150 #else 151 m_packet_timeout (1), 152 #endif 153 m_sequence_mutex (Mutex::eMutexTypeRecursive), 154 m_public_is_running (false), 155 m_private_is_running (false), 156 m_history (512), 157 m_send_acks (true), 158 m_listen_url () 159 { 160 } 161 162 //---------------------------------------------------------------------- 163 // Destructor 164 //---------------------------------------------------------------------- 165 GDBRemoteCommunication::~GDBRemoteCommunication() 166 { 167 if (IsConnected()) 168 { 169 Disconnect(); 170 } 171 } 172 173 char 174 GDBRemoteCommunication::CalculcateChecksum (const char *payload, size_t payload_length) 175 { 176 int checksum = 0; 177 178 for (size_t i = 0; i < payload_length; ++i) 179 checksum += payload[i]; 180 181 return checksum & 255; 182 } 183 184 size_t 185 GDBRemoteCommunication::SendAck () 186 { 187 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PACKETS)); 188 ConnectionStatus status = eConnectionStatusSuccess; 189 char ch = '+'; 190 const size_t bytes_written = Write (&ch, 1, status, NULL); 191 if (log) 192 log->Printf ("<%4" PRIu64 "> send packet: %c", (uint64_t)bytes_written, ch); 193 m_history.AddPacket (ch, History::ePacketTypeSend, bytes_written); 194 return bytes_written; 195 } 196 197 size_t 198 GDBRemoteCommunication::SendNack () 199 { 200 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PACKETS)); 201 ConnectionStatus status = eConnectionStatusSuccess; 202 char ch = '-'; 203 const size_t bytes_written = Write (&ch, 1, status, NULL); 204 if (log) 205 log->Printf("<%4" PRIu64 "> send packet: %c", (uint64_t)bytes_written, ch); 206 m_history.AddPacket (ch, History::ePacketTypeSend, bytes_written); 207 return bytes_written; 208 } 209 210 GDBRemoteCommunication::PacketResult 211 GDBRemoteCommunication::SendPacket (const char *payload, size_t payload_length) 212 { 213 Mutex::Locker locker(m_sequence_mutex); 214 return SendPacketNoLock (payload, payload_length); 215 } 216 217 GDBRemoteCommunication::PacketResult 218 GDBRemoteCommunication::SendPacketNoLock (const char *payload, size_t payload_length) 219 { 220 if (IsConnected()) 221 { 222 StreamString packet(0, 4, eByteOrderBig); 223 224 packet.PutChar('$'); 225 packet.Write (payload, payload_length); 226 packet.PutChar('#'); 227 packet.PutHex8(CalculcateChecksum (payload, payload_length)); 228 229 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PACKETS)); 230 ConnectionStatus status = eConnectionStatusSuccess; 231 const char *packet_data = packet.GetData(); 232 const size_t packet_length = packet.GetSize(); 233 size_t bytes_written = Write (packet_data, packet_length, status, NULL); 234 if (log) 235 { 236 size_t binary_start_offset = 0; 237 if (strncmp(packet_data, "$vFile:pwrite:", strlen("$vFile:pwrite:")) == 0) 238 { 239 const char *first_comma = strchr(packet_data, ','); 240 if (first_comma) 241 { 242 const char *second_comma = strchr(first_comma + 1, ','); 243 if (second_comma) 244 binary_start_offset = second_comma - packet_data + 1; 245 } 246 } 247 248 // If logging was just enabled and we have history, then dump out what 249 // we have to the log so we get the historical context. The Dump() call that 250 // logs all of the packet will set a boolean so that we don't dump this more 251 // than once 252 if (!m_history.DidDumpToLog ()) 253 m_history.Dump (log); 254 255 if (binary_start_offset) 256 { 257 StreamString strm; 258 // Print non binary data header 259 strm.Printf("<%4" PRIu64 "> send packet: %.*s", (uint64_t)bytes_written, (int)binary_start_offset, packet_data); 260 const uint8_t *p; 261 // Print binary data exactly as sent 262 for (p = (const uint8_t*)packet_data + binary_start_offset; *p != '#'; ++p) 263 strm.Printf("\\x%2.2x", *p); 264 // Print the checksum 265 strm.Printf("%*s", (int)3, p); 266 log->PutCString(strm.GetString().c_str()); 267 } 268 else 269 log->Printf("<%4" PRIu64 "> send packet: %.*s", (uint64_t)bytes_written, (int)packet_length, packet_data); 270 } 271 272 m_history.AddPacket (packet.GetString(), packet_length, History::ePacketTypeSend, bytes_written); 273 274 275 if (bytes_written == packet_length) 276 { 277 if (GetSendAcks ()) 278 return GetAck (); 279 else 280 return PacketResult::Success; 281 } 282 else 283 { 284 if (log) 285 log->Printf ("error: failed to send packet: %.*s", (int)packet_length, packet_data); 286 } 287 } 288 return PacketResult::ErrorSendFailed; 289 } 290 291 GDBRemoteCommunication::PacketResult 292 GDBRemoteCommunication::GetAck () 293 { 294 StringExtractorGDBRemote packet; 295 PacketResult result = WaitForPacketWithTimeoutMicroSecondsNoLock (packet, GetPacketTimeoutInMicroSeconds ()); 296 if (result == PacketResult::Success) 297 { 298 if (packet.GetResponseType() == StringExtractorGDBRemote::ResponseType::eAck) 299 return PacketResult::Success; 300 else 301 return PacketResult::ErrorSendAck; 302 } 303 return result; 304 } 305 306 bool 307 GDBRemoteCommunication::GetSequenceMutex (Mutex::Locker& locker, const char *failure_message) 308 { 309 if (IsRunning()) 310 return locker.TryLock (m_sequence_mutex, failure_message); 311 312 locker.Lock (m_sequence_mutex); 313 return true; 314 } 315 316 317 bool 318 GDBRemoteCommunication::WaitForNotRunningPrivate (const TimeValue *timeout_ptr) 319 { 320 return m_private_is_running.WaitForValueEqualTo (false, timeout_ptr, NULL); 321 } 322 323 GDBRemoteCommunication::PacketResult 324 GDBRemoteCommunication::WaitForPacketWithTimeoutMicroSecondsNoLock (StringExtractorGDBRemote &packet, uint32_t timeout_usec) 325 { 326 uint8_t buffer[8192]; 327 Error error; 328 329 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PACKETS | GDBR_LOG_VERBOSE)); 330 331 // Check for a packet from our cache first without trying any reading... 332 if (CheckForPacket (NULL, 0, packet)) 333 return PacketResult::Success; 334 335 bool timed_out = false; 336 bool disconnected = false; 337 while (IsConnected() && !timed_out) 338 { 339 lldb::ConnectionStatus status = eConnectionStatusNoConnection; 340 size_t bytes_read = Read (buffer, sizeof(buffer), timeout_usec, status, &error); 341 342 if (log) 343 log->Printf ("%s: Read (buffer, (sizeof(buffer), timeout_usec = 0x%x, status = %s, error = %s) => bytes_read = %" PRIu64, 344 __PRETTY_FUNCTION__, 345 timeout_usec, 346 Communication::ConnectionStatusAsCString (status), 347 error.AsCString(), 348 (uint64_t)bytes_read); 349 350 if (bytes_read > 0) 351 { 352 if (CheckForPacket (buffer, bytes_read, packet)) 353 return PacketResult::Success; 354 } 355 else 356 { 357 switch (status) 358 { 359 case eConnectionStatusTimedOut: 360 case eConnectionStatusInterrupted: 361 timed_out = true; 362 break; 363 case eConnectionStatusSuccess: 364 //printf ("status = success but error = %s\n", error.AsCString("<invalid>")); 365 break; 366 367 case eConnectionStatusEndOfFile: 368 case eConnectionStatusNoConnection: 369 case eConnectionStatusLostConnection: 370 case eConnectionStatusError: 371 disconnected = true; 372 Disconnect(); 373 break; 374 } 375 } 376 } 377 packet.Clear (); 378 if (disconnected) 379 return PacketResult::ErrorDisconnected; 380 if (timed_out) 381 return PacketResult::ErrorReplyTimeout; 382 else 383 return PacketResult::ErrorReplyFailed; 384 } 385 386 bool 387 GDBRemoteCommunication::CheckForPacket (const uint8_t *src, size_t src_len, StringExtractorGDBRemote &packet) 388 { 389 // Put the packet data into the buffer in a thread safe fashion 390 Mutex::Locker locker(m_bytes_mutex); 391 392 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PACKETS)); 393 394 if (src && src_len > 0) 395 { 396 if (log && log->GetVerbose()) 397 { 398 StreamString s; 399 log->Printf ("GDBRemoteCommunication::%s adding %u bytes: %.*s", 400 __FUNCTION__, 401 (uint32_t)src_len, 402 (uint32_t)src_len, 403 src); 404 } 405 m_bytes.append ((const char *)src, src_len); 406 } 407 408 // Parse up the packets into gdb remote packets 409 if (!m_bytes.empty()) 410 { 411 // end_idx must be one past the last valid packet byte. Start 412 // it off with an invalid value that is the same as the current 413 // index. 414 size_t content_start = 0; 415 size_t content_length = 0; 416 size_t total_length = 0; 417 size_t checksum_idx = std::string::npos; 418 419 switch (m_bytes[0]) 420 { 421 case '+': // Look for ack 422 case '-': // Look for cancel 423 case '\x03': // ^C to halt target 424 content_length = total_length = 1; // The command is one byte long... 425 break; 426 427 case '%': // Async notify packet 428 case '$': 429 // Look for a standard gdb packet? 430 { 431 size_t hash_pos = m_bytes.find('#'); 432 if (hash_pos != std::string::npos) 433 { 434 if (hash_pos + 2 < m_bytes.size()) 435 { 436 checksum_idx = hash_pos + 1; 437 // Skip the dollar sign 438 content_start = 1; 439 // Don't include the # in the content or the $ in the content length 440 content_length = hash_pos - 1; 441 442 total_length = hash_pos + 3; // Skip the # and the two hex checksum bytes 443 } 444 else 445 { 446 // Checksum bytes aren't all here yet 447 content_length = std::string::npos; 448 } 449 } 450 } 451 break; 452 453 default: 454 { 455 // We have an unexpected byte and we need to flush all bad 456 // data that is in m_bytes, so we need to find the first 457 // byte that is a '+' (ACK), '-' (NACK), \x03 (CTRL+C interrupt), 458 // or '$' character (start of packet header) or of course, 459 // the end of the data in m_bytes... 460 const size_t bytes_len = m_bytes.size(); 461 bool done = false; 462 uint32_t idx; 463 for (idx = 1; !done && idx < bytes_len; ++idx) 464 { 465 switch (m_bytes[idx]) 466 { 467 case '+': 468 case '-': 469 case '\x03': 470 case '%': 471 case '$': 472 done = true; 473 break; 474 475 default: 476 break; 477 } 478 } 479 if (log) 480 log->Printf ("GDBRemoteCommunication::%s tossing %u junk bytes: '%.*s'", 481 __FUNCTION__, idx - 1, idx - 1, m_bytes.c_str()); 482 m_bytes.erase(0, idx - 1); 483 } 484 break; 485 } 486 487 if (content_length == std::string::npos) 488 { 489 packet.Clear(); 490 return false; 491 } 492 else if (total_length > 0) 493 { 494 495 // We have a valid packet... 496 assert (content_length <= m_bytes.size()); 497 assert (total_length <= m_bytes.size()); 498 assert (content_length <= total_length); 499 const size_t content_end = content_start + content_length; 500 501 bool success = true; 502 std::string &packet_str = packet.GetStringRef(); 503 504 505 if (log) 506 { 507 // If logging was just enabled and we have history, then dump out what 508 // we have to the log so we get the historical context. The Dump() call that 509 // logs all of the packet will set a boolean so that we don't dump this more 510 // than once 511 if (!m_history.DidDumpToLog ()) 512 m_history.Dump (log); 513 514 bool binary = false; 515 // Only detect binary for packets that start with a '$' and have a '#CC' checksum 516 if (m_bytes[0] == '$' && total_length > 4) 517 { 518 for (size_t i=0; !binary && i<total_length; ++i) 519 { 520 if (isprint(m_bytes[i]) == 0) 521 binary = true; 522 } 523 } 524 if (binary) 525 { 526 StreamString strm; 527 // Packet header... 528 strm.Printf("<%4" PRIu64 "> read packet: %c", (uint64_t)total_length, m_bytes[0]); 529 for (size_t i=content_start; i<content_end; ++i) 530 { 531 // Remove binary escaped bytes when displaying the packet... 532 const char ch = m_bytes[i]; 533 if (ch == 0x7d) 534 { 535 // 0x7d is the escape character. The next character is to 536 // be XOR'd with 0x20. 537 const char escapee = m_bytes[++i] ^ 0x20; 538 strm.Printf("%2.2x", escapee); 539 } 540 else 541 { 542 strm.Printf("%2.2x", (uint8_t)ch); 543 } 544 } 545 // Packet footer... 546 strm.Printf("%c%c%c", m_bytes[total_length-3], m_bytes[total_length-2], m_bytes[total_length-1]); 547 log->PutCString(strm.GetString().c_str()); 548 } 549 else 550 { 551 log->Printf("<%4" PRIu64 "> read packet: %.*s", (uint64_t)total_length, (int)(total_length), m_bytes.c_str()); 552 } 553 } 554 555 m_history.AddPacket (m_bytes.c_str(), total_length, History::ePacketTypeRecv, total_length); 556 557 // Clear packet_str in case there is some existing data in it. 558 packet_str.clear(); 559 // Copy the packet from m_bytes to packet_str expanding the 560 // run-length encoding in the process. 561 // Reserve enough byte for the most common case (no RLE used) 562 packet_str.reserve(m_bytes.length()); 563 for (std::string::const_iterator c = m_bytes.begin() + content_start; c != m_bytes.begin() + content_end; ++c) 564 { 565 if (*c == '*') 566 { 567 // '*' indicates RLE. Next character will give us the 568 // repeat count and previous character is what is to be 569 // repeated. 570 char char_to_repeat = packet_str.back(); 571 // Number of time the previous character is repeated 572 int repeat_count = *++c + 3 - ' '; 573 // We have the char_to_repeat and repeat_count. Now push 574 // it in the packet. 575 for (int i = 0; i < repeat_count; ++i) 576 packet_str.push_back(char_to_repeat); 577 } 578 else if (*c == 0x7d) 579 { 580 // 0x7d is the escape character. The next character is to 581 // be XOR'd with 0x20. 582 char escapee = *++c ^ 0x20; 583 packet_str.push_back(escapee); 584 } 585 else 586 { 587 packet_str.push_back(*c); 588 } 589 } 590 591 if (m_bytes[0] == '$' || m_bytes[0] == '%') 592 { 593 assert (checksum_idx < m_bytes.size()); 594 if (::isxdigit (m_bytes[checksum_idx+0]) || 595 ::isxdigit (m_bytes[checksum_idx+1])) 596 { 597 if (GetSendAcks ()) 598 { 599 const char *packet_checksum_cstr = &m_bytes[checksum_idx]; 600 char packet_checksum = strtol (packet_checksum_cstr, NULL, 16); 601 char actual_checksum = CalculcateChecksum (packet_str.c_str(), packet_str.size()); 602 success = packet_checksum == actual_checksum; 603 if (!success) 604 { 605 if (log) 606 log->Printf ("error: checksum mismatch: %.*s expected 0x%2.2x, got 0x%2.2x", 607 (int)(total_length), 608 m_bytes.c_str(), 609 (uint8_t)packet_checksum, 610 (uint8_t)actual_checksum); 611 } 612 // Send the ack or nack if needed 613 if (!success) 614 SendNack(); 615 else 616 SendAck(); 617 } 618 } 619 else 620 { 621 success = false; 622 if (log) 623 log->Printf ("error: invalid checksum in packet: '%s'\n", m_bytes.c_str()); 624 } 625 } 626 627 m_bytes.erase(0, total_length); 628 packet.SetFilePos(0); 629 return success; 630 } 631 } 632 packet.Clear(); 633 return false; 634 } 635 636 Error 637 GDBRemoteCommunication::StartListenThread (const char *hostname, uint16_t port) 638 { 639 Error error; 640 if (m_listen_thread.IsJoinable()) 641 { 642 error.SetErrorString("listen thread already running"); 643 } 644 else 645 { 646 char listen_url[512]; 647 if (hostname && hostname[0]) 648 snprintf(listen_url, sizeof(listen_url), "listen://%s:%i", hostname, port); 649 else 650 snprintf(listen_url, sizeof(listen_url), "listen://%i", port); 651 m_listen_url = listen_url; 652 SetConnection(new ConnectionFileDescriptor()); 653 m_listen_thread = ThreadLauncher::LaunchThread(listen_url, GDBRemoteCommunication::ListenThread, this, &error); 654 } 655 return error; 656 } 657 658 bool 659 GDBRemoteCommunication::JoinListenThread () 660 { 661 if (m_listen_thread.IsJoinable()) 662 m_listen_thread.Join(nullptr); 663 return true; 664 } 665 666 lldb::thread_result_t 667 GDBRemoteCommunication::ListenThread (lldb::thread_arg_t arg) 668 { 669 GDBRemoteCommunication *comm = (GDBRemoteCommunication *)arg; 670 Error error; 671 ConnectionFileDescriptor *connection = (ConnectionFileDescriptor *)comm->GetConnection (); 672 673 if (connection) 674 { 675 // Do the listen on another thread so we can continue on... 676 if (connection->Connect(comm->m_listen_url.c_str(), &error) != eConnectionStatusSuccess) 677 comm->SetConnection(NULL); 678 } 679 return NULL; 680 } 681 682 Error 683 GDBRemoteCommunication::StartDebugserverProcess (const char *hostname, 684 uint16_t in_port, 685 ProcessLaunchInfo &launch_info, 686 uint16_t &out_port) 687 { 688 Log *log (ProcessGDBRemoteLog::GetLogIfAllCategoriesSet (GDBR_LOG_PROCESS)); 689 if (log) 690 log->Printf ("GDBRemoteCommunication::%s(hostname=%s, in_port=%" PRIu16 ", out_port=%" PRIu16, __FUNCTION__, hostname ? hostname : "<empty>", in_port, out_port); 691 692 out_port = in_port; 693 Error error; 694 // If we locate debugserver, keep that located version around 695 static FileSpec g_debugserver_file_spec; 696 697 char debugserver_path[PATH_MAX]; 698 FileSpec &debugserver_file_spec = launch_info.GetExecutableFile(); 699 700 // Always check to see if we have an environment override for the path 701 // to the debugserver to use and use it if we do. 702 const char *env_debugserver_path = getenv("LLDB_DEBUGSERVER_PATH"); 703 if (env_debugserver_path) 704 { 705 debugserver_file_spec.SetFile (env_debugserver_path, false); 706 if (log) 707 log->Printf ("GDBRemoteCommunication::%s() gdb-remote stub exe path set from environment variable: %s", __FUNCTION__, env_debugserver_path); 708 } 709 else 710 debugserver_file_spec = g_debugserver_file_spec; 711 bool debugserver_exists = debugserver_file_spec.Exists(); 712 if (!debugserver_exists) 713 { 714 // The debugserver binary is in the LLDB.framework/Resources 715 // directory. 716 if (HostInfo::GetLLDBPath(ePathTypeSupportExecutableDir, debugserver_file_spec)) 717 { 718 debugserver_file_spec.AppendPathComponent (DEBUGSERVER_BASENAME); 719 debugserver_exists = debugserver_file_spec.Exists(); 720 if (debugserver_exists) 721 { 722 if (log) 723 log->Printf ("GDBRemoteCommunication::%s() found gdb-remote stub exe '%s'", __FUNCTION__, debugserver_file_spec.GetPath ().c_str ()); 724 725 g_debugserver_file_spec = debugserver_file_spec; 726 } 727 else 728 { 729 if (log) 730 log->Printf ("GDBRemoteCommunication::%s() could not find gdb-remote stub exe '%s'", __FUNCTION__, debugserver_file_spec.GetPath ().c_str ()); 731 732 g_debugserver_file_spec.Clear(); 733 debugserver_file_spec.Clear(); 734 } 735 } 736 } 737 738 if (debugserver_exists) 739 { 740 debugserver_file_spec.GetPath (debugserver_path, sizeof(debugserver_path)); 741 742 Args &debugserver_args = launch_info.GetArguments(); 743 debugserver_args.Clear(); 744 char arg_cstr[PATH_MAX]; 745 746 // Start args with "debugserver /file/path -r --" 747 debugserver_args.AppendArgument(debugserver_path); 748 749 #if !defined(__APPLE__) 750 // First argument to lldb-server must be mode in which to run. 751 debugserver_args.AppendArgument("gdbserver"); 752 #endif 753 754 // If a host and port is supplied then use it 755 char host_and_port[128]; 756 if (hostname) 757 { 758 snprintf (host_and_port, sizeof(host_and_port), "%s:%u", hostname, in_port); 759 debugserver_args.AppendArgument(host_and_port); 760 } 761 else 762 { 763 host_and_port[0] = '\0'; 764 } 765 766 // use native registers, not the GDB registers 767 debugserver_args.AppendArgument("--native-regs"); 768 769 if (launch_info.GetLaunchInSeparateProcessGroup()) 770 { 771 debugserver_args.AppendArgument("--setsid"); 772 } 773 774 llvm::SmallString<PATH_MAX> named_pipe_path; 775 Pipe port_pipe; 776 777 if (host_and_port[0] && in_port == 0) 778 { 779 // Create a temporary file to get the stdout/stderr and redirect the 780 // output of the command into this file. We will later read this file 781 // if all goes well and fill the data into "command_output_ptr" 782 783 // Binding to port zero, we need to figure out what port it ends up 784 // using using a named pipe... 785 error = port_pipe.CreateWithUniqueName("debugserver-named-pipe", false, named_pipe_path); 786 if (error.Success()) 787 { 788 debugserver_args.AppendArgument("--named-pipe"); 789 debugserver_args.AppendArgument(named_pipe_path.c_str()); 790 } 791 else 792 { 793 if (log) 794 log->Printf("GDBRemoteCommunication::%s() " 795 "named pipe creation failed: %s", 796 __FUNCTION__, error.AsCString()); 797 // let's try an unnamed pipe 798 error = port_pipe.CreateNew(true); 799 if (error.Fail()) 800 { 801 if (log) 802 log->Printf("GDBRemoteCommunication::%s() " 803 "unnamed pipe creation failed: %s", 804 __FUNCTION__, error.AsCString()); 805 return error; 806 } 807 int write_fd = port_pipe.GetWriteFileDescriptor(); 808 debugserver_args.AppendArgument("--pipe"); 809 debugserver_args.AppendArgument(std::to_string(write_fd).c_str()); 810 launch_info.AppendCloseFileAction(port_pipe.GetReadFileDescriptor()); 811 } 812 } 813 else 814 { 815 // No host and port given, so lets listen on our end and make the debugserver 816 // connect to us.. 817 error = StartListenThread ("127.0.0.1", 0); 818 if (error.Fail()) 819 { 820 if (log) 821 log->Printf ("GDBRemoteCommunication::%s() unable to start listen thread: %s", __FUNCTION__, error.AsCString()); 822 return error; 823 } 824 825 ConnectionFileDescriptor *connection = (ConnectionFileDescriptor *)GetConnection (); 826 // Wait for 10 seconds to resolve the bound port 827 out_port = connection->GetListeningPort(10); 828 if (out_port > 0) 829 { 830 char port_cstr[32]; 831 snprintf(port_cstr, sizeof(port_cstr), "127.0.0.1:%i", out_port); 832 // Send the host and port down that debugserver and specify an option 833 // so that it connects back to the port we are listening to in this process 834 debugserver_args.AppendArgument("--reverse-connect"); 835 debugserver_args.AppendArgument(port_cstr); 836 } 837 else 838 { 839 error.SetErrorString ("failed to bind to port 0 on 127.0.0.1"); 840 if (log) 841 log->Printf ("GDBRemoteCommunication::%s() failed: %s", __FUNCTION__, error.AsCString()); 842 return error; 843 } 844 } 845 846 const char *env_debugserver_log_file = getenv("LLDB_DEBUGSERVER_LOG_FILE"); 847 if (env_debugserver_log_file) 848 { 849 ::snprintf (arg_cstr, sizeof(arg_cstr), "--log-file=%s", env_debugserver_log_file); 850 debugserver_args.AppendArgument(arg_cstr); 851 } 852 853 #if defined(__APPLE__) 854 const char *env_debugserver_log_flags = getenv("LLDB_DEBUGSERVER_LOG_FLAGS"); 855 if (env_debugserver_log_flags) 856 { 857 ::snprintf (arg_cstr, sizeof(arg_cstr), "--log-flags=%s", env_debugserver_log_flags); 858 debugserver_args.AppendArgument(arg_cstr); 859 } 860 #else 861 const char *env_debugserver_log_channels = getenv("LLDB_SERVER_LOG_CHANNELS"); 862 if (env_debugserver_log_channels) 863 { 864 ::snprintf (arg_cstr, sizeof(arg_cstr), "--log-channels=%s", env_debugserver_log_channels); 865 debugserver_args.AppendArgument(arg_cstr); 866 } 867 #endif 868 869 // Add additional args, starting with LLDB_DEBUGSERVER_EXTRA_ARG_1 until an env var doesn't come back. 870 uint32_t env_var_index = 1; 871 bool has_env_var; 872 do 873 { 874 char env_var_name[64]; 875 snprintf (env_var_name, sizeof (env_var_name), "LLDB_DEBUGSERVER_EXTRA_ARG_%" PRIu32, env_var_index++); 876 const char *extra_arg = getenv(env_var_name); 877 has_env_var = extra_arg != nullptr; 878 879 if (has_env_var) 880 { 881 debugserver_args.AppendArgument (extra_arg); 882 if (log) 883 log->Printf ("GDBRemoteCommunication::%s adding env var %s contents to stub command line (%s)", __FUNCTION__, env_var_name, extra_arg); 884 } 885 } while (has_env_var); 886 887 // Close STDIN, STDOUT and STDERR. 888 launch_info.AppendCloseFileAction (STDIN_FILENO); 889 launch_info.AppendCloseFileAction (STDOUT_FILENO); 890 launch_info.AppendCloseFileAction (STDERR_FILENO); 891 892 // Redirect STDIN, STDOUT and STDERR to "/dev/null". 893 launch_info.AppendSuppressFileAction (STDIN_FILENO, true, false); 894 launch_info.AppendSuppressFileAction (STDOUT_FILENO, false, true); 895 launch_info.AppendSuppressFileAction (STDERR_FILENO, false, true); 896 897 error = Host::LaunchProcess(launch_info); 898 899 if (error.Success() && launch_info.GetProcessID() != LLDB_INVALID_PROCESS_ID) 900 { 901 if (named_pipe_path.size() > 0) 902 { 903 error = port_pipe.OpenAsReader(named_pipe_path, false); 904 if (error.Fail()) 905 if (log) 906 log->Printf("GDBRemoteCommunication::%s() " 907 "failed to open named pipe %s for reading: %s", 908 __FUNCTION__, named_pipe_path.c_str(), error.AsCString()); 909 } 910 911 if (port_pipe.CanWrite()) 912 port_pipe.CloseWriteFileDescriptor(); 913 if (port_pipe.CanRead()) 914 { 915 char port_cstr[256]; 916 port_cstr[0] = '\0'; 917 size_t num_bytes = sizeof(port_cstr); 918 // Read port from pipe with 10 second timeout. 919 error = port_pipe.ReadWithTimeout(port_cstr, num_bytes, 920 std::chrono::seconds{10}, num_bytes); 921 if (error.Success()) 922 { 923 assert(num_bytes > 0 && port_cstr[num_bytes-1] == '\0'); 924 out_port = StringConvert::ToUInt32(port_cstr, 0); 925 if (log) 926 log->Printf("GDBRemoteCommunication::%s() " 927 "debugserver listens %u port", 928 __FUNCTION__, out_port); 929 } 930 else 931 { 932 if (log) 933 log->Printf("GDBRemoteCommunication::%s() " 934 "failed to read a port value from pipe %s: %s", 935 __FUNCTION__, named_pipe_path.c_str(), error.AsCString()); 936 937 } 938 port_pipe.Close(); 939 } 940 941 if (named_pipe_path.size() > 0) 942 { 943 const auto err = port_pipe.Delete(named_pipe_path); 944 if (err.Fail()) 945 { 946 if (log) 947 log->Printf ("GDBRemoteCommunication::%s failed to delete pipe %s: %s", 948 __FUNCTION__, named_pipe_path.c_str(), err.AsCString()); 949 } 950 } 951 952 // Make sure we actually connect with the debugserver... 953 JoinListenThread(); 954 } 955 } 956 else 957 { 958 error.SetErrorStringWithFormat ("unable to locate " DEBUGSERVER_BASENAME ); 959 } 960 961 if (error.Fail()) 962 { 963 if (log) 964 log->Printf ("GDBRemoteCommunication::%s() failed: %s", __FUNCTION__, error.AsCString()); 965 } 966 967 return error; 968 } 969 970 void 971 GDBRemoteCommunication::DumpHistory(Stream &strm) 972 { 973 m_history.Dump (strm); 974 } 975 976 GDBRemoteCommunication::ScopedTimeout::ScopedTimeout (GDBRemoteCommunication& gdb_comm, 977 uint32_t timeout) : 978 m_gdb_comm (gdb_comm) 979 { 980 m_saved_timeout = m_gdb_comm.SetPacketTimeout (timeout); 981 } 982 983 GDBRemoteCommunication::ScopedTimeout::~ScopedTimeout () 984 { 985 m_gdb_comm.SetPacketTimeout (m_saved_timeout); 986 } 987