19dba64beSDimitry Andric //===-- GDBRemote.cpp -----------------------------------------------------===// 29dba64beSDimitry Andric // 39dba64beSDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 49dba64beSDimitry Andric // See https://llvm.org/LICENSE.txt for license information. 59dba64beSDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 69dba64beSDimitry Andric // 79dba64beSDimitry Andric //===----------------------------------------------------------------------===// 89dba64beSDimitry Andric 99dba64beSDimitry Andric #include "lldb/Utility/GDBRemote.h" 109dba64beSDimitry Andric 119dba64beSDimitry Andric #include "lldb/Utility/Flags.h" 129dba64beSDimitry Andric #include "lldb/Utility/Stream.h" 139dba64beSDimitry Andric 14*fe6060f1SDimitry Andric #include <cstdio> 159dba64beSDimitry Andric 169dba64beSDimitry Andric using namespace lldb; 17480093f4SDimitry Andric using namespace lldb_private::repro; 189dba64beSDimitry Andric using namespace lldb_private; 199dba64beSDimitry Andric using namespace llvm; 209dba64beSDimitry Andric 219dba64beSDimitry Andric StreamGDBRemote::StreamGDBRemote() : StreamString() {} 229dba64beSDimitry Andric 239dba64beSDimitry Andric StreamGDBRemote::StreamGDBRemote(uint32_t flags, uint32_t addr_size, 249dba64beSDimitry Andric ByteOrder byte_order) 259dba64beSDimitry Andric : StreamString(flags, addr_size, byte_order) {} 269dba64beSDimitry Andric 27*fe6060f1SDimitry Andric StreamGDBRemote::~StreamGDBRemote() = default; 289dba64beSDimitry Andric 299dba64beSDimitry Andric int StreamGDBRemote::PutEscapedBytes(const void *s, size_t src_len) { 309dba64beSDimitry Andric int bytes_written = 0; 319dba64beSDimitry Andric const uint8_t *src = static_cast<const uint8_t *>(s); 329dba64beSDimitry Andric bool binary_is_set = m_flags.Test(eBinary); 339dba64beSDimitry Andric m_flags.Clear(eBinary); 349dba64beSDimitry Andric while (src_len) { 359dba64beSDimitry Andric uint8_t byte = *src; 369dba64beSDimitry Andric src++; 379dba64beSDimitry Andric src_len--; 389dba64beSDimitry Andric if (byte == 0x23 || byte == 0x24 || byte == 0x7d || byte == 0x2a) { 399dba64beSDimitry Andric bytes_written += PutChar(0x7d); 409dba64beSDimitry Andric byte ^= 0x20; 419dba64beSDimitry Andric } 429dba64beSDimitry Andric bytes_written += PutChar(byte); 439dba64beSDimitry Andric }; 449dba64beSDimitry Andric if (binary_is_set) 459dba64beSDimitry Andric m_flags.Set(eBinary); 469dba64beSDimitry Andric return bytes_written; 479dba64beSDimitry Andric } 489dba64beSDimitry Andric 499dba64beSDimitry Andric llvm::StringRef GDBRemotePacket::GetTypeStr() const { 509dba64beSDimitry Andric switch (type) { 519dba64beSDimitry Andric case GDBRemotePacket::ePacketTypeSend: 529dba64beSDimitry Andric return "send"; 539dba64beSDimitry Andric case GDBRemotePacket::ePacketTypeRecv: 549dba64beSDimitry Andric return "read"; 559dba64beSDimitry Andric case GDBRemotePacket::ePacketTypeInvalid: 569dba64beSDimitry Andric return "invalid"; 579dba64beSDimitry Andric } 589dba64beSDimitry Andric llvm_unreachable("All enum cases should be handled"); 599dba64beSDimitry Andric } 609dba64beSDimitry Andric 619dba64beSDimitry Andric void GDBRemotePacket::Dump(Stream &strm) const { 629dba64beSDimitry Andric strm.Printf("tid=0x%4.4" PRIx64 " <%4u> %s packet: %s\n", tid, 639dba64beSDimitry Andric bytes_transmitted, GetTypeStr().data(), packet.data.c_str()); 649dba64beSDimitry Andric } 659dba64beSDimitry Andric 669dba64beSDimitry Andric void yaml::ScalarEnumerationTraits<GDBRemotePacket::Type>::enumeration( 679dba64beSDimitry Andric IO &io, GDBRemotePacket::Type &value) { 689dba64beSDimitry Andric io.enumCase(value, "Invalid", GDBRemotePacket::ePacketTypeInvalid); 699dba64beSDimitry Andric io.enumCase(value, "Send", GDBRemotePacket::ePacketTypeSend); 709dba64beSDimitry Andric io.enumCase(value, "Recv", GDBRemotePacket::ePacketTypeRecv); 719dba64beSDimitry Andric } 729dba64beSDimitry Andric 739dba64beSDimitry Andric void yaml::ScalarTraits<GDBRemotePacket::BinaryData>::output( 749dba64beSDimitry Andric const GDBRemotePacket::BinaryData &Val, void *, raw_ostream &Out) { 759dba64beSDimitry Andric Out << toHex(Val.data); 769dba64beSDimitry Andric } 779dba64beSDimitry Andric 789dba64beSDimitry Andric StringRef yaml::ScalarTraits<GDBRemotePacket::BinaryData>::input( 799dba64beSDimitry Andric StringRef Scalar, void *, GDBRemotePacket::BinaryData &Val) { 809dba64beSDimitry Andric Val.data = fromHex(Scalar); 819dba64beSDimitry Andric return {}; 829dba64beSDimitry Andric } 839dba64beSDimitry Andric 849dba64beSDimitry Andric void yaml::MappingTraits<GDBRemotePacket>::mapping(IO &io, 859dba64beSDimitry Andric GDBRemotePacket &Packet) { 869dba64beSDimitry Andric io.mapRequired("packet", Packet.packet); 879dba64beSDimitry Andric io.mapRequired("type", Packet.type); 889dba64beSDimitry Andric io.mapRequired("bytes", Packet.bytes_transmitted); 899dba64beSDimitry Andric io.mapRequired("index", Packet.packet_idx); 909dba64beSDimitry Andric io.mapRequired("tid", Packet.tid); 919dba64beSDimitry Andric } 929dba64beSDimitry Andric 939dba64beSDimitry Andric StringRef 949dba64beSDimitry Andric yaml::MappingTraits<GDBRemotePacket>::validate(IO &io, 959dba64beSDimitry Andric GDBRemotePacket &Packet) { 969dba64beSDimitry Andric return {}; 979dba64beSDimitry Andric } 98480093f4SDimitry Andric 99480093f4SDimitry Andric void GDBRemoteProvider::Keep() { 100480093f4SDimitry Andric std::vector<std::string> files; 101480093f4SDimitry Andric for (auto &recorder : m_packet_recorders) { 102480093f4SDimitry Andric files.push_back(recorder->GetFilename().GetPath()); 103480093f4SDimitry Andric } 104480093f4SDimitry Andric 105480093f4SDimitry Andric FileSpec file = GetRoot().CopyByAppendingPathComponent(Info::file); 106480093f4SDimitry Andric std::error_code ec; 107*fe6060f1SDimitry Andric llvm::raw_fd_ostream os(file.GetPath(), ec, llvm::sys::fs::OF_TextWithCRLF); 108480093f4SDimitry Andric if (ec) 109480093f4SDimitry Andric return; 110480093f4SDimitry Andric yaml::Output yout(os); 111480093f4SDimitry Andric yout << files; 112480093f4SDimitry Andric } 113480093f4SDimitry Andric 114480093f4SDimitry Andric void GDBRemoteProvider::Discard() { m_packet_recorders.clear(); } 115480093f4SDimitry Andric 116480093f4SDimitry Andric llvm::Expected<std::unique_ptr<PacketRecorder>> 117480093f4SDimitry Andric PacketRecorder::Create(const FileSpec &filename) { 118480093f4SDimitry Andric std::error_code ec; 119480093f4SDimitry Andric auto recorder = std::make_unique<PacketRecorder>(std::move(filename), ec); 120480093f4SDimitry Andric if (ec) 121480093f4SDimitry Andric return llvm::errorCodeToError(ec); 122480093f4SDimitry Andric return std::move(recorder); 123480093f4SDimitry Andric } 124480093f4SDimitry Andric 125480093f4SDimitry Andric PacketRecorder *GDBRemoteProvider::GetNewPacketRecorder() { 126480093f4SDimitry Andric std::size_t i = m_packet_recorders.size() + 1; 127480093f4SDimitry Andric std::string filename = (llvm::Twine(Info::name) + llvm::Twine("-") + 128480093f4SDimitry Andric llvm::Twine(i) + llvm::Twine(".yaml")) 129480093f4SDimitry Andric .str(); 130480093f4SDimitry Andric auto recorder_or_error = 131480093f4SDimitry Andric PacketRecorder::Create(GetRoot().CopyByAppendingPathComponent(filename)); 132480093f4SDimitry Andric if (!recorder_or_error) { 133480093f4SDimitry Andric llvm::consumeError(recorder_or_error.takeError()); 134480093f4SDimitry Andric return nullptr; 135480093f4SDimitry Andric } 136480093f4SDimitry Andric 137480093f4SDimitry Andric m_packet_recorders.push_back(std::move(*recorder_or_error)); 138480093f4SDimitry Andric return m_packet_recorders.back().get(); 139480093f4SDimitry Andric } 140480093f4SDimitry Andric 141480093f4SDimitry Andric void PacketRecorder::Record(const GDBRemotePacket &packet) { 142480093f4SDimitry Andric if (!m_record) 143480093f4SDimitry Andric return; 144480093f4SDimitry Andric yaml::Output yout(m_os); 145480093f4SDimitry Andric yout << const_cast<GDBRemotePacket &>(packet); 146480093f4SDimitry Andric m_os.flush(); 147480093f4SDimitry Andric } 148480093f4SDimitry Andric 149480093f4SDimitry Andric llvm::raw_ostream *GDBRemoteProvider::GetHistoryStream() { 150480093f4SDimitry Andric FileSpec history_file = GetRoot().CopyByAppendingPathComponent(Info::file); 151480093f4SDimitry Andric 152480093f4SDimitry Andric std::error_code EC; 153*fe6060f1SDimitry Andric m_stream_up = std::make_unique<raw_fd_ostream>( 154*fe6060f1SDimitry Andric history_file.GetPath(), EC, sys::fs::OpenFlags::OF_TextWithCRLF); 155480093f4SDimitry Andric return m_stream_up.get(); 156480093f4SDimitry Andric } 157480093f4SDimitry Andric 158480093f4SDimitry Andric char GDBRemoteProvider::ID = 0; 159480093f4SDimitry Andric const char *GDBRemoteProvider::Info::file = "gdb-remote.yaml"; 160480093f4SDimitry Andric const char *GDBRemoteProvider::Info::name = "gdb-remote"; 161