| //===-- DWARFExpressionTest.cpp -------------------------------------------===// |
| // |
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| // See https://llvm.org/LICENSE.txt for license information. |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| // |
| //===----------------------------------------------------------------------===// |
| #include "lldb/Expression/DWARFExpression.h" |
| #include "ValueMatcher.h" |
| #include <unordered_map> |
| #ifdef ARCH_AARCH64 |
| #include "Plugins/ABI/AArch64/ABISysV_arm64.h" |
| #endif |
| #include "Plugins/ObjectFile/wasm/ObjectFileWasm.h" |
| #include "Plugins/Platform/Linux/PlatformLinux.h" |
| #include "Plugins/SymbolFile/DWARF/DWARFDebugInfo.h" |
| #include "Plugins/SymbolFile/DWARF/SymbolFileDWARFDwo.h" |
| #include "Plugins/SymbolFile/DWARF/SymbolFileWasm.h" |
| #include "Plugins/SymbolVendor/wasm/SymbolVendorWasm.h" |
| #include "Plugins/TypeSystem/Clang/TypeSystemClang.h" |
| #include "TestingSupport/Symbol/YAMLModuleTester.h" |
| #include "lldb/Core/Debugger.h" |
| #include "lldb/Core/PluginManager.h" |
| #include "lldb/Core/Value.h" |
| #include "lldb/Core/dwarf.h" |
| #include "lldb/Host/HostInfo.h" |
| #include "lldb/Symbol/ObjectFile.h" |
| #include "lldb/Target/ABI.h" |
| #include "lldb/Target/RegisterContext.h" |
| #include "lldb/Utility/RegisterValue.h" |
| #include "lldb/Utility/StreamString.h" |
| #include "llvm/ADT/StringExtras.h" |
| #include "llvm/Support/TargetSelect.h" |
| #include "llvm/Testing/Support/Error.h" |
| #include "gtest/gtest.h" |
| |
| using namespace lldb_private::plugin::dwarf; |
| using namespace lldb_private::wasm; |
| using namespace lldb_private; |
| using namespace llvm::dwarf; |
| |
| namespace { |
| /// A mock implementation of DWARFExpression::Delegate for testing. |
| /// This class provides default implementations of all delegate methods, |
| /// with the DWARF version being configurable via the constructor. |
| class MockDwarfDelegate : public DWARFExpression::Delegate { |
| public: |
| static constexpr uint16_t DEFAULT_DWARF_VERSION = 5; |
| static MockDwarfDelegate Dwarf5() { return MockDwarfDelegate(5); } |
| static MockDwarfDelegate Dwarf2() { return MockDwarfDelegate(2); } |
| |
| MockDwarfDelegate() : MockDwarfDelegate(DEFAULT_DWARF_VERSION) {} |
| explicit MockDwarfDelegate(uint16_t version) : m_dwarf_version(version) {} |
| |
| uint16_t GetVersion() const override { return m_dwarf_version; } |
| |
| dw_addr_t GetBaseAddress() const override { return 0; } |
| |
| uint8_t GetAddressByteSize() const override { return 4; } |
| |
| llvm::Expected<std::pair<uint64_t, bool>> |
| GetDIEBitSizeAndSign(uint64_t relative_die_offset) const override { |
| return llvm::createStringError(llvm::inconvertibleErrorCode(), |
| "GetDIEBitSizeAndSign not implemented"); |
| } |
| |
| dw_addr_t ReadAddressFromDebugAddrSection(uint32_t index) const override { |
| return 0; |
| } |
| |
| lldb::offset_t GetVendorDWARFOpcodeSize(const DataExtractor &data, |
| const lldb::offset_t data_offset, |
| const uint8_t op) const override { |
| return LLDB_INVALID_OFFSET; |
| } |
| |
| bool ParseVendorDWARFOpcode(uint8_t op, const DataExtractor &opcodes, |
| lldb::offset_t &offset, RegisterContext *reg_ctx, |
| lldb::RegisterKind reg_kind, |
| DWARFExpression::Stack &stack) const override { |
| return false; |
| } |
| |
| private: |
| uint16_t m_dwarf_version; |
| }; |
| |
| /// Mock memory implementation for testing. |
| /// Stores predefined memory contents indexed by {address, size} pairs. |
| class MockMemory { |
| public: |
| /// Represents a memory read request with an address and size. |
| /// Used as a key in the memory map to look up predefined test data. |
| struct Request { |
| lldb::addr_t addr; |
| size_t size; |
| |
| bool operator==(const Request &other) const { |
| return addr == other.addr && size == other.size; |
| } |
| |
| /// Hash function for Request to enable its use in unordered_map. |
| struct Hash { |
| size_t operator()(const Request &req) const { |
| size_t h1 = std::hash<lldb::addr_t>{}(req.addr); |
| size_t h2 = std::hash<size_t>{}(req.size); |
| return h1 ^ (h2 << 1); |
| } |
| }; |
| }; |
| |
| typedef std::unordered_map<Request, std::vector<uint8_t>, Request::Hash> Map; |
| MockMemory() = default; |
| MockMemory(Map memory) : m_memory(std::move(memory)) { |
| // Make sure the requested memory size matches the returned value. |
| for ([[maybe_unused]] auto &[req, bytes] : m_memory) { |
| assert(bytes.size() == req.size); |
| } |
| } |
| |
| llvm::Expected<std::vector<uint8_t>> ReadMemory(lldb::addr_t addr, |
| size_t size) { |
| if (!m_memory.count({addr, size})) { |
| return llvm::createStringError( |
| llvm::inconvertibleErrorCode(), |
| "MockMemory::ReadMemory {address=0x%" PRIx64 ", size=%zu} not found", |
| addr, size); |
| } |
| return m_memory[{addr, size}]; |
| } |
| |
| private: |
| std::unordered_map<Request, std::vector<uint8_t>, Request::Hash> m_memory; |
| }; |
| |
| /// A Process whose `ReadMemory` override queries MockMemory. |
| struct MockProcess : Process { |
| using addr_t = lldb::addr_t; |
| |
| MockMemory m_memory; |
| |
| MockProcess(lldb::TargetSP target_sp, lldb::ListenerSP listener_sp, |
| MockMemory memory) |
| : Process(target_sp, listener_sp), m_memory(std::move(memory)) {} |
| size_t DoReadMemory(addr_t vm_addr, void *buf, size_t size, |
| Status &error) override { |
| auto expected_memory = m_memory.ReadMemory(vm_addr, size); |
| if (!expected_memory) { |
| error = Status::FromError(expected_memory.takeError()); |
| return 0; |
| } |
| assert(expected_memory->size() == size); |
| std::memcpy(buf, expected_memory->data(), expected_memory->size()); |
| return size; |
| } |
| size_t ReadMemory(addr_t addr, void *buf, size_t size, |
| Status &status) override { |
| return DoReadMemory(addr, buf, size, status); |
| } |
| bool CanDebug(lldb::TargetSP, bool) override { return true; } |
| Status DoDestroy() override { return Status(); } |
| llvm::StringRef GetPluginName() override { return ""; } |
| void RefreshStateAfterStop() override {} |
| bool DoUpdateThreadList(ThreadList &, ThreadList &) override { return false; } |
| }; |
| |
| class MockThread : public Thread { |
| public: |
| MockThread(Process &process) : Thread(process, /*tid=*/1), m_reg_ctx_sp() {} |
| ~MockThread() override { DestroyThread(); } |
| |
| void RefreshStateAfterStop() override {} |
| |
| lldb::RegisterContextSP GetRegisterContext() override { return m_reg_ctx_sp; } |
| |
| lldb::RegisterContextSP |
| CreateRegisterContextForFrame(StackFrame *frame) override { |
| return m_reg_ctx_sp; |
| } |
| |
| bool CalculateStopInfo() override { return false; } |
| |
| void SetRegisterContext(lldb::RegisterContextSP reg_ctx_sp) { |
| m_reg_ctx_sp = reg_ctx_sp; |
| } |
| |
| private: |
| lldb::RegisterContextSP m_reg_ctx_sp; |
| }; |
| |
| class MockRegisterContext : public RegisterContext { |
| public: |
| MockRegisterContext(Thread &thread, const RegisterValue ®_value) |
| : RegisterContext(thread, 0 /*concrete_frame_idx*/), |
| m_reg_value(reg_value) {} |
| |
| void InvalidateAllRegisters() override {} |
| |
| size_t GetRegisterCount() override { return 0; } |
| |
| const RegisterInfo *GetRegisterInfoAtIndex(size_t reg) override { |
| return &m_reg_info; |
| } |
| |
| size_t GetRegisterSetCount() override { return 0; } |
| |
| const RegisterSet *GetRegisterSet(size_t reg_set) override { return nullptr; } |
| |
| lldb::ByteOrder GetByteOrder() override { |
| return lldb::ByteOrder::eByteOrderLittle; |
| } |
| |
| bool ReadRegister(const RegisterInfo *reg_info, |
| RegisterValue ®_value) override { |
| reg_value = m_reg_value; |
| return true; |
| } |
| |
| bool WriteRegister(const RegisterInfo *reg_info, |
| const RegisterValue ®_value) override { |
| return false; |
| } |
| |
| uint32_t ConvertRegisterKindToRegisterNumber(lldb::RegisterKind kind, |
| uint32_t num) override { |
| return num; |
| } |
| |
| private: |
| RegisterInfo m_reg_info{}; |
| RegisterValue m_reg_value{}; |
| }; |
| } // namespace |
| |
| static llvm::Expected<Value> Evaluate(llvm::ArrayRef<uint8_t> expr, |
| lldb::ModuleSP module_sp = {}, |
| DWARFExpression::Delegate *unit = nullptr, |
| ExecutionContext *exe_ctx = nullptr, |
| RegisterContext *reg_ctx = nullptr) { |
| DataExtractor extractor( |
| expr.data(), expr.size(), lldb::eByteOrderLittle, |
| /*addr_size*/ exe_ctx ? exe_ctx->GetAddressByteSize() : 4); |
| |
| return DWARFExpression::Evaluate(exe_ctx, reg_ctx, module_sp, extractor, unit, |
| lldb::eRegisterKindLLDB, |
| /*initial_value_ptr=*/nullptr, |
| /*object_address_ptr=*/nullptr); |
| } |
| |
| class DWARFExpressionTester : public YAMLModuleTester { |
| public: |
| DWARFExpressionTester(llvm::StringRef yaml_data, size_t cu_index) |
| : YAMLModuleTester(yaml_data, cu_index) {} |
| |
| using YAMLModuleTester::YAMLModuleTester; |
| llvm::Expected<Value> Eval(llvm::ArrayRef<uint8_t> expr) { |
| return ::Evaluate(expr, m_module_sp, m_dwarf_unit); |
| } |
| }; |
| |
| /// This is needed for the tests that use a mock process. |
| class DWARFExpressionMockProcessTest : public ::testing::Test { |
| public: |
| void SetUp() override { |
| FileSystem::Initialize(); |
| HostInfo::Initialize(); |
| platform_linux::PlatformLinux::Initialize(); |
| } |
| void TearDown() override { |
| platform_linux::PlatformLinux::Terminate(); |
| HostInfo::Terminate(); |
| FileSystem::Terminate(); |
| } |
| }; |
| |
| /// Mock target implementation for testing. |
| /// Provides predefined memory contents via MockMemory instead of reading from |
| /// a real process. |
| class MockTarget : public Target { |
| public: |
| MockTarget(Debugger &debugger, const ArchSpec &target_arch, |
| const lldb::PlatformSP &platform_sp, MockMemory memory) |
| : Target(debugger, target_arch, platform_sp, true), |
| m_memory(std::move(memory)) {} |
| |
| size_t ReadMemory(const Address &addr, void *dst, size_t dst_len, |
| Status &error, bool force_live_memory = false, |
| lldb::addr_t *load_addr_ptr = nullptr, |
| bool *did_read_live_memory = nullptr) override { |
| auto expected_memory = m_memory.ReadMemory(addr.GetOffset(), dst_len); |
| if (!expected_memory) { |
| error = Status::FromError(expected_memory.takeError()); |
| return 0; |
| } |
| const size_t bytes_read = expected_memory->size(); |
| assert(bytes_read <= dst_len); |
| std::memcpy(dst, expected_memory->data(), bytes_read); |
| return bytes_read; |
| } |
| |
| private: |
| MockMemory m_memory; |
| }; |
| |
| struct TestContext { |
| lldb::PlatformSP platform_sp; |
| lldb::TargetSP target_sp; |
| lldb::DebuggerSP debugger_sp; |
| lldb::ProcessSP process_sp; |
| lldb::ThreadSP thread_sp; |
| lldb::RegisterContextSP reg_ctx_sp; |
| }; |
| |
| /// A helper function to create TestContext objects with the |
| /// given triple, memory, and register contents. |
| static bool CreateTestContext(TestContext *ctx, llvm::StringRef triple, |
| std::optional<RegisterValue> reg_value = {}, |
| std::optional<MockMemory> process_memory = {}, |
| std::optional<MockMemory> target_memory = {}) { |
| ArchSpec arch(triple); |
| lldb::PlatformSP platform_sp = |
| platform_linux::PlatformLinux::CreateInstance(true, &arch); |
| Platform::SetHostPlatform(platform_sp); |
| lldb::TargetSP target_sp; |
| lldb::DebuggerSP debugger_sp = Debugger::CreateInstance(); |
| |
| Status status; |
| if (target_memory) |
| target_sp = std::make_shared<MockTarget>(*debugger_sp, arch, platform_sp, |
| std::move(*target_memory)); |
| else |
| status = debugger_sp->GetTargetList().CreateTarget( |
| *debugger_sp, "", arch, eLoadDependentsNo, platform_sp, target_sp); |
| |
| EXPECT_TRUE(status.Success()); |
| if (!status.Success()) |
| return false; |
| |
| lldb::ProcessSP process_sp; |
| if (!process_memory) |
| process_memory = MockMemory(); |
| process_sp = std::make_shared<MockProcess>( |
| target_sp, Listener::MakeListener("dummy"), std::move(*process_memory)); |
| |
| auto thread_sp = std::make_shared<MockThread>(*process_sp); |
| |
| process_sp->GetThreadList().AddThread(thread_sp); |
| |
| lldb::RegisterContextSP reg_ctx_sp; |
| if (reg_value) { |
| reg_ctx_sp = std::make_shared<MockRegisterContext>(*thread_sp, *reg_value); |
| thread_sp->SetRegisterContext(reg_ctx_sp); |
| } |
| |
| *ctx = TestContext{platform_sp, target_sp, debugger_sp, |
| process_sp, thread_sp, reg_ctx_sp}; |
| return true; |
| } |
| |
| TEST(DWARFExpression, DW_OP_pick) { |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_lit1, DW_OP_lit0, DW_OP_pick, 0}), |
| ExpectScalar(0)); |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_lit1, DW_OP_lit0, DW_OP_pick, 1}), |
| ExpectScalar(1)); |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_lit1, DW_OP_lit0, DW_OP_pick, 2}), |
| llvm::Failed()); |
| } |
| |
| TEST(DWARFExpression, DW_OP_const) { |
| // Extend to address size. |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_const1u, 0x88}), ExpectScalar(0x88)); |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_const1s, 0x88}), |
| ExpectScalar(0xffffff88)); |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_const2u, 0x47, 0x88}), |
| ExpectScalar(0x8847)); |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_const2s, 0x47, 0x88}), |
| ExpectScalar(0xffff8847)); |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_const4u, 0x44, 0x42, 0x47, 0x88}), |
| ExpectScalar(0x88474244)); |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_const4s, 0x44, 0x42, 0x47, 0x88}), |
| ExpectScalar(0x88474244)); |
| |
| // Truncate to address size. |
| EXPECT_THAT_EXPECTED( |
| Evaluate({DW_OP_const8u, 0x00, 0x11, 0x22, 0x33, 0x44, 0x42, 0x47, 0x88}), |
| ExpectScalar(0x33221100)); |
| EXPECT_THAT_EXPECTED( |
| Evaluate({DW_OP_const8s, 0x00, 0x11, 0x22, 0x33, 0x44, 0x42, 0x47, 0x88}), |
| ExpectScalar(0x33221100)); |
| |
| // Don't truncate to address size for compatibility with clang (pr48087). |
| EXPECT_THAT_EXPECTED( |
| Evaluate({DW_OP_constu, 0x81, 0x82, 0x84, 0x88, 0x90, 0xa0, 0x40}), |
| ExpectScalar(0x01010101010101)); |
| EXPECT_THAT_EXPECTED( |
| Evaluate({DW_OP_consts, 0x81, 0x82, 0x84, 0x88, 0x90, 0xa0, 0x40}), |
| ExpectScalar(0xffff010101010101)); |
| } |
| |
| TEST(DWARFExpression, DW_OP_skip) { |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_const1u, 0x42, DW_OP_skip, 0x02, 0x00, |
| DW_OP_const1u, 0xff}), |
| ExpectScalar(0x42)); |
| } |
| |
| TEST(DWARFExpression, DW_OP_bra) { |
| EXPECT_THAT_EXPECTED( |
| // clang-format off |
| Evaluate({ |
| DW_OP_const1u, 0x42, // push 0x42 |
| DW_OP_const1u, 0x1, // push 0x1 |
| DW_OP_bra, 0x02, 0x00, // if 0x1 > 0, then skip 0x0002 opcodes |
| DW_OP_const1u, 0xff, // push 0xff |
| }), |
| // clang-format on |
| ExpectScalar(0x42)); |
| |
| EXPECT_THAT_ERROR(Evaluate({DW_OP_bra, 0x01, 0x00}).takeError(), |
| llvm::Failed()); |
| } |
| |
| TEST(DWARFExpression, DW_OP_convert) { |
| /// Auxiliary debug info. |
| const char *yamldata = R"( |
| --- !ELF |
| FileHeader: |
| Class: ELFCLASS64 |
| Data: ELFDATA2LSB |
| Type: ET_EXEC |
| Machine: EM_386 |
| DWARF: |
| debug_abbrev: |
| - Table: |
| - Code: 0x00000001 |
| Tag: DW_TAG_compile_unit |
| Children: DW_CHILDREN_yes |
| Attributes: |
| - Attribute: DW_AT_language |
| Form: DW_FORM_data2 |
| - Code: 0x00000002 |
| Tag: DW_TAG_base_type |
| Children: DW_CHILDREN_no |
| Attributes: |
| - Attribute: DW_AT_encoding |
| Form: DW_FORM_data1 |
| - Attribute: DW_AT_byte_size |
| Form: DW_FORM_data1 |
| debug_info: |
| - Version: 4 |
| AddrSize: 8 |
| AbbrevTableID: 0 |
| AbbrOffset: 0x0 |
| Entries: |
| - AbbrCode: 0x00000001 |
| Values: |
| - Value: 0x000000000000000C |
| - AbbrCode: 0x00000000 |
| - Version: 4 |
| AddrSize: 8 |
| AbbrevTableID: 0 |
| AbbrOffset: 0x0 |
| Entries: |
| - AbbrCode: 0x00000001 |
| Values: |
| - Value: 0x000000000000000C |
| # 0x0000000e: |
| - AbbrCode: 0x00000002 |
| Values: |
| - Value: 0x0000000000000007 # DW_ATE_unsigned |
| - Value: 0x0000000000000004 |
| # 0x00000011: |
| - AbbrCode: 0x00000002 |
| Values: |
| - Value: 0x0000000000000007 # DW_ATE_unsigned |
| - Value: 0x0000000000000008 |
| # 0x00000014: |
| - AbbrCode: 0x00000002 |
| Values: |
| - Value: 0x0000000000000005 # DW_ATE_signed |
| - Value: 0x0000000000000008 |
| # 0x00000017: |
| - AbbrCode: 0x00000002 |
| Values: |
| - Value: 0x0000000000000008 # DW_ATE_unsigned_char |
| - Value: 0x0000000000000001 |
| # 0x0000001a: |
| - AbbrCode: 0x00000002 |
| Values: |
| - Value: 0x0000000000000006 # DW_ATE_signed_char |
| - Value: 0x0000000000000001 |
| # 0x0000001d: |
| - AbbrCode: 0x00000002 |
| Values: |
| - Value: 0x000000000000000b # DW_ATE_numeric_string |
| - Value: 0x0000000000000001 |
| - AbbrCode: 0x00000000 |
| |
| )"; |
| // Compile unit relative offsets to each DW_TAG_base_type |
| uint8_t offs_uint32_t = 0x0000000e; |
| uint8_t offs_uint64_t = 0x00000011; |
| uint8_t offs_sint64_t = 0x00000014; |
| uint8_t offs_uchar = 0x00000017; |
| uint8_t offs_schar = 0x0000001a; |
| |
| DWARFExpressionTester t(yamldata, /*cu_index=*/1); |
| ASSERT_TRUE((bool)t.GetDwarfUnit()); |
| |
| // Constant is given as little-endian. |
| bool is_signed = true; |
| bool not_signed = false; |
| |
| // |
| // Positive tests. |
| // |
| |
| // Leave as is. |
| EXPECT_THAT_EXPECTED( |
| t.Eval({DW_OP_const4u, 0x11, 0x22, 0x33, 0x44, // |
| DW_OP_convert, offs_uint32_t, DW_OP_stack_value}), |
| ExpectScalar(64, 0x44332211, not_signed)); |
| |
| // Zero-extend to 64 bits. |
| EXPECT_THAT_EXPECTED( |
| t.Eval({DW_OP_const4u, 0x11, 0x22, 0x33, 0x44, // |
| DW_OP_convert, offs_uint64_t, DW_OP_stack_value}), |
| ExpectScalar(64, 0x44332211, not_signed)); |
| |
| // Sign-extend to 64 bits. |
| EXPECT_THAT_EXPECTED( |
| t.Eval({DW_OP_const4s, 0xcc, 0xdd, 0xee, 0xff, // |
| DW_OP_convert, offs_sint64_t, DW_OP_stack_value}), |
| ExpectScalar(64, 0xffffffffffeeddcc, is_signed)); |
| |
| // Sign-extend, then truncate. |
| EXPECT_THAT_EXPECTED( |
| t.Eval({DW_OP_const4s, 0xcc, 0xdd, 0xee, 0xff, // |
| DW_OP_convert, offs_sint64_t, // |
| DW_OP_convert, offs_uint32_t, DW_OP_stack_value}), |
| ExpectScalar(32, 0xffeeddcc, not_signed)); |
| |
| // Truncate to default unspecified (pointer-sized) type. |
| EXPECT_THAT_EXPECTED(t.Eval({DW_OP_const4s, 0xcc, 0xdd, 0xee, 0xff, // |
| DW_OP_convert, offs_sint64_t, // |
| DW_OP_convert, 0x00, DW_OP_stack_value}), |
| ExpectScalar(32, 0xffeeddcc, not_signed)); |
| |
| // Truncate to 8 bits. |
| EXPECT_THAT_EXPECTED(t.Eval({DW_OP_const4s, 'A', 'B', 'C', 'D', DW_OP_convert, |
| offs_uchar, DW_OP_stack_value}), |
| ExpectScalar(8, 'A', not_signed)); |
| |
| // Also truncate to 8 bits. |
| EXPECT_THAT_EXPECTED(t.Eval({DW_OP_const4s, 'A', 'B', 'C', 'D', DW_OP_convert, |
| offs_schar, DW_OP_stack_value}), |
| ExpectScalar(8, 'A', is_signed)); |
| |
| // |
| // Errors. |
| // |
| |
| // No Module. |
| EXPECT_THAT_ERROR(Evaluate({DW_OP_const1s, 'X', DW_OP_convert, 0x00}, nullptr, |
| t.GetDwarfUnit()) |
| .takeError(), |
| llvm::Failed()); |
| |
| // No DIE. |
| EXPECT_THAT_ERROR( |
| t.Eval({DW_OP_const1s, 'X', DW_OP_convert, 0x01}).takeError(), |
| llvm::Failed()); |
| |
| // Unsupported. |
| EXPECT_THAT_ERROR( |
| t.Eval({DW_OP_const1s, 'X', DW_OP_convert, 0x1d}).takeError(), |
| llvm::Failed()); |
| } |
| |
| TEST(DWARFExpression, DW_OP_stack_value) { |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_stack_value}), llvm::Failed()); |
| } |
| |
| // This test shows that the dwarf version is used by the expression evaluation. |
| // Note that the different behavior tested here is not meant to imply that this |
| // is the correct interpretation of dwarf2 vs. dwarf5, but rather it was picked |
| // as an easy example that evaluates differently based on the dwarf version. |
| TEST(DWARFExpression, dwarf_version) { |
| MockDwarfDelegate dwarf2 = MockDwarfDelegate::Dwarf2(); |
| MockDwarfDelegate dwarf5 = MockDwarfDelegate::Dwarf5(); |
| |
| // In dwarf2 the constant on top of the stack is treated as a value. |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_lit1}, {}, &dwarf2), ExpectScalar(1)); |
| |
| // In dwarf5 the constant on top of the stack is implicitly converted to an |
| // address. |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_lit1}, {}, &dwarf5), |
| ExpectLoadAddress(1)); |
| } |
| |
| TEST(DWARFExpression, DW_OP_piece) { |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_const2u, 0x11, 0x22, DW_OP_piece, 2, |
| DW_OP_const2u, 0x33, 0x44, DW_OP_piece, 2}), |
| ExpectHostAddress({0x11, 0x22, 0x33, 0x44})); |
| EXPECT_THAT_EXPECTED( |
| Evaluate({DW_OP_piece, 1, DW_OP_const1u, 0xff, DW_OP_piece, 1}), |
| // Note that the "00" should really be "undef", but we can't |
| // represent that yet. |
| ExpectHostAddress({0x00, 0xff})); |
| |
| // This tests if ap_int is extended to the right width. |
| // expect 40*8 = 320 bits size. |
| std::vector<uint8_t> expected_host_buffer(40, 0); |
| expected_host_buffer[0] = 2; |
| |
| EXPECT_THAT_EXPECTED( |
| Evaluate({{DW_OP_lit2, DW_OP_stack_value, DW_OP_piece, 40}}), |
| ExpectHostAddress(expected_host_buffer)); |
| } |
| |
| TEST(DWARFExpression, DW_OP_implicit_value) { |
| unsigned char bytes = 4; |
| |
| EXPECT_THAT_EXPECTED( |
| Evaluate({DW_OP_implicit_value, bytes, 0x11, 0x22, 0x33, 0x44}), |
| ExpectHostAddress({0x11, 0x22, 0x33, 0x44})); |
| } |
| |
| TEST(DWARFExpression, DW_OP_unknown) { |
| EXPECT_THAT_EXPECTED( |
| Evaluate({0xff}), |
| llvm::FailedWithMessage( |
| "Unhandled opcode DW_OP_unknown_ff in DWARFExpression")); |
| } |
| |
| TEST_F(DWARFExpressionMockProcessTest, DW_OP_deref) { |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_lit0, DW_OP_deref}), llvm::Failed()); |
| |
| // Set up a mock process. |
| MockMemory::Map memory = { |
| {{0x4, 4}, {0x4, 0x5, 0x6, 0x7}}, |
| }; |
| TestContext test_ctx; |
| ASSERT_TRUE( |
| CreateTestContext(&test_ctx, "i386-pc-linux", {}, std::move(memory))); |
| |
| ExecutionContext exe_ctx(test_ctx.process_sp); |
| // Implicit location: *0x4. |
| EXPECT_THAT_EXPECTED( |
| Evaluate({DW_OP_lit4, DW_OP_deref, DW_OP_stack_value}, {}, {}, &exe_ctx), |
| ExpectScalar(32, 0x07060504, false)); |
| // Memory location: *(*0x4). |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_lit4, DW_OP_deref}, {}, {}, &exe_ctx), |
| ExpectLoadAddress(0x07060504)); |
| // Memory location: *0x4. |
| EXPECT_THAT_EXPECTED(Evaluate({DW_OP_lit4}, {}, {}, &exe_ctx), |
| ExpectScalar(Scalar(4))); |
| } |
| |
| TEST_F(DWARFExpressionMockProcessTest, WASM_DW_OP_addr) { |
| // Set up a wasm target |
| TestContext test_ctx; |
| ASSERT_TRUE(CreateTestContext(&test_ctx, "wasm32-unknown-unknown-wasm")); |
| |
| ExecutionContext exe_ctx(test_ctx.target_sp, false); |
| // DW_OP_addr takes a single operand of address size width: |
| EXPECT_THAT_EXPECTED( |
| Evaluate({DW_OP_addr, 0x40, 0x0, 0x0, 0x0}, {}, {}, &exe_ctx), |
| ExpectLoadAddress(0x40)); |
| } |
| |
| TEST_F(DWARFExpressionMockProcessTest, WASM_DW_OP_addr_index) { |
| const char *yamldata = R"( |
| --- !ELF |
| FileHeader: |
| Class: ELFCLASS64 |
| Data: ELFDATA2LSB |
| Type: ET_EXEC |
| Machine: EM_386 |
| DWARF: |
| debug_abbrev: |
| - Table: |
| - Code: 0x00000001 |
| Tag: DW_TAG_compile_unit |
| Children: DW_CHILDREN_no |
| Attributes: |
| - Attribute: DW_AT_addr_base |
| Form: DW_FORM_sec_offset |
| |
| debug_info: |
| - Version: 5 |
| AddrSize: 4 |
| UnitType: DW_UT_compile |
| Entries: |
| - AbbrCode: 0x00000001 |
| Values: |
| - Value: 0x8 # Offset of the first Address past the header |
| - AbbrCode: 0x0 |
| |
| debug_addr: |
| - Version: 5 |
| AddressSize: 4 |
| Entries: |
| - Address: 0x1234 |
| - Address: 0x5678 |
| )"; |
| |
| // Can't use DWARFExpressionTester from above because subsystems overlap with |
| // the fixture. |
| SubsystemRAII<ObjectFileELF, SymbolFileDWARF> subsystems; |
| llvm::Expected<TestFile> file = TestFile::fromYaml(yamldata); |
| EXPECT_THAT_EXPECTED(file, llvm::Succeeded()); |
| auto module_sp = std::make_shared<Module>(file->moduleSpec()); |
| auto *dwarf_cu = llvm::cast<SymbolFileDWARF>(module_sp->GetSymbolFile()) |
| ->DebugInfo() |
| .GetUnitAtIndex(0); |
| ASSERT_TRUE(dwarf_cu); |
| dwarf_cu->ExtractDIEsIfNeeded(); |
| |
| // Set up a wasm target |
| TestContext test_ctx; |
| ASSERT_TRUE(CreateTestContext(&test_ctx, "wasm32-unknown-unknown-wasm")); |
| ExecutionContext exe_ctx(test_ctx.target_sp, false); |
| |
| auto evaluate = [&](DWARFExpression &expr) -> llvm::Expected<Value> { |
| DataExtractor extractor; |
| expr.GetExpressionData(extractor); |
| return DWARFExpression::Evaluate(&exe_ctx, /*reg_ctx*/ nullptr, |
| /*module_sp*/ {}, extractor, dwarf_cu, |
| lldb::eRegisterKindLLDB, |
| /*initial_value_ptr*/ nullptr, |
| /*object_address_ptr*/ nullptr); |
| }; |
| |
| // DW_OP_addrx takes a single leb128 operand, the index in the addr table: |
| uint8_t expr_data[] = {DW_OP_addrx, 0x01}; |
| DataExtractor extractor(expr_data, sizeof(expr_data), lldb::eByteOrderLittle, |
| /*addr_size*/ 4); |
| DWARFExpression expr(extractor); |
| |
| llvm::Expected<Value> result = evaluate(expr); |
| EXPECT_THAT_EXPECTED(result, ExpectLoadAddress(0x5678u)); |
| |
| ASSERT_TRUE(expr.Update_DW_OP_addr(dwarf_cu, 0xdeadbeef)); |
| result = evaluate(expr); |
| EXPECT_THAT_EXPECTED(result, ExpectLoadAddress(0xdeadbeefu)); |
| } |
| |
| class CustomSymbolFileDWARF : public SymbolFileDWARF { |
| static char ID; |
| |
| public: |
| using SymbolFileDWARF::SymbolFileDWARF; |
| |
| bool isA(const void *ClassID) const override { |
| return ClassID == &ID || SymbolFile::isA(ClassID); |
| } |
| static bool classof(const SymbolFile *obj) { return obj->isA(&ID); } |
| |
| static llvm::StringRef GetPluginNameStatic() { return "custom_dwarf"; } |
| |
| static llvm::StringRef GetPluginDescriptionStatic() { |
| return "Symbol file reader with expression extensions."; |
| } |
| |
| static void Initialize() { |
| PluginManager::RegisterPlugin(GetPluginNameStatic(), |
| GetPluginDescriptionStatic(), CreateInstance, |
| SymbolFileDWARF::DebuggerInitialize); |
| } |
| |
| static void Terminate() { PluginManager::UnregisterPlugin(CreateInstance); } |
| |
| static lldb_private::SymbolFile * |
| CreateInstance(lldb::ObjectFileSP objfile_sp) { |
| return new CustomSymbolFileDWARF(std::move(objfile_sp), |
| /*dwo_section_list*/ nullptr); |
| } |
| |
| lldb::offset_t |
| GetVendorDWARFOpcodeSize(const lldb_private::DataExtractor &data, |
| const lldb::offset_t data_offset, |
| const uint8_t op) const final { |
| auto offset = data_offset; |
| if (op != DW_OP_WASM_location) { |
| return LLDB_INVALID_OFFSET; |
| } |
| |
| // DW_OP_WASM_location WASM_GLOBAL:0x03 index:u32 |
| // Called with "arguments" 0x03 and 0x04 |
| // Location type: |
| if (data.GetU8(&offset) != /* global */ 0x03) { |
| return LLDB_INVALID_OFFSET; |
| } |
| |
| // Index |
| if (data.GetU32(&offset) != 0x04) { |
| return LLDB_INVALID_OFFSET; |
| } |
| |
| // Report the skipped distance: |
| return offset - data_offset; |
| } |
| |
| virtual bool ParseVendorDWARFOpcode( |
| uint8_t op, const lldb_private::DataExtractor &opcodes, |
| lldb::offset_t &offset, |
| |
| RegisterContext *reg_ctx, lldb::RegisterKind reg_kind, |
| std::vector<lldb_private::Value> &stack) const override { |
| if (op != DW_OP_WASM_location) { |
| return false; |
| } |
| |
| // DW_OP_WASM_location WASM_GLOBAL:0x03 index:u32 |
| // Called with "arguments" 0x03 and 0x04 |
| // Location type: |
| if (opcodes.GetU8(&offset) != /* global */ 0x03) { |
| return false; |
| } |
| |
| // Index: |
| if (opcodes.GetU32(&offset) != 0x04) { |
| return false; |
| } |
| |
| // Return some value: |
| stack.push_back({GetScalar(32, 42, false)}); |
| return true; |
| } |
| }; |
| |
| char CustomSymbolFileDWARF::ID; |
| |
| static auto testExpressionVendorExtensions(lldb::ModuleSP module_sp, |
| DWARFUnit &dwarf_unit, |
| RegisterContext *reg_ctx) { |
| // Test that expression extensions can be evaluated, for example |
| // DW_OP_WASM_location which is not currently handled by DWARFExpression: |
| EXPECT_THAT_EXPECTED( |
| Evaluate({DW_OP_WASM_location, 0x03, // WASM_GLOBAL:0x03 |
| 0x04, 0x00, 0x00, // index:u32 |
| 0x00, DW_OP_stack_value}, |
| module_sp, &dwarf_unit, nullptr, reg_ctx), |
| ExpectScalar(32, 42, false, Value::ContextType::RegisterInfo)); |
| |
| // Test that searches for opcodes work in the presence of extensions: |
| uint8_t expr[] = {DW_OP_WASM_location, 0x03, 0x04, 0x00, 0x00, 0x00, |
| DW_OP_form_tls_address}; |
| DataExtractor extractor(expr, sizeof(expr), lldb::eByteOrderLittle, |
| /*addr_size*/ 4); |
| DWARFExpression dwarf_expr(extractor); |
| ASSERT_TRUE(dwarf_expr.ContainsThreadLocalStorage(&dwarf_unit)); |
| } |
| |
| TEST(DWARFExpression, Extensions) { |
| const char *yamldata = R"( |
| --- !WASM |
| FileHeader: |
| Version: 0x1 |
| Sections: |
| - Type: TYPE |
| Signatures: |
| - Index: 0 |
| ParamTypes: |
| - I32 |
| ReturnTypes: |
| - I32 |
| - Type: FUNCTION |
| FunctionTypes: [ 0 ] |
| - Type: TABLE |
| Tables: |
| - Index: 0 |
| ElemType: FUNCREF |
| Limits: |
| Flags: [ HAS_MAX ] |
| Minimum: 0x1 |
| Maximum: 0x1 |
| - Type: MEMORY |
| Memories: |
| - Flags: [ HAS_MAX ] |
| Minimum: 0x100 |
| Maximum: 0x100 |
| - Type: GLOBAL |
| Globals: |
| - Index: 0 |
| Type: I32 |
| Mutable: true |
| InitExpr: |
| Opcode: I32_CONST |
| Value: 65536 |
| - Type: EXPORT |
| Exports: |
| - Name: memory |
| Kind: MEMORY |
| Index: 0 |
| - Name: square |
| Kind: FUNCTION |
| Index: 0 |
| - Name: __indirect_function_table |
| Kind: TABLE |
| Index: 0 |
| - Type: CODE |
| Functions: |
| - Index: 0 |
| Locals: |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| Body: 2300210141102102200120026B21032003200036020C200328020C2104200328020C2105200420056C210620060F0B |
| - Type: CUSTOM |
| Name: name |
| FunctionNames: |
| - Index: 0 |
| Name: square |
| GlobalNames: |
| - Index: 0 |
| Name: __stack_pointer |
| - Type: CUSTOM |
| Name: .debug_abbrev |
| Payload: 011101250E1305030E10171B0E110112060000022E01110112064018030E3A0B3B0B271949133F1900000305000218030E3A0B3B0B49130000042400030E3E0B0B0B000000 |
| - Type: CUSTOM |
| Name: .debug_info |
| Payload: 510000000400000000000401670000001D005E000000000000000A000000020000003C00000002020000003C00000004ED00039F5700000001014D0000000302910C0400000001014D000000000400000000050400 |
| - Type: CUSTOM |
| Name: .debug_str |
| Payload: 696E740076616C756500513A5C70616F6C6F7365764D5346545C6C6C766D2D70726F6A6563745C6C6C64625C746573745C4150495C66756E6374696F6E616C69746965735C6764625F72656D6F74655F636C69656E745C737175617265007371756172652E6300636C616E672076657273696F6E2031382E302E30202868747470733A2F2F6769746875622E636F6D2F6C6C766D2F6C6C766D2D70726F6A65637420373535303166353336323464653932616166636532663164613639386232343961373239336463372900 |
| - Type: CUSTOM |
| Name: .debug_line |
| Payload: 64000000040020000000010101FB0E0D000101010100000001000001007371756172652E6300000000000005020200000001000502250000000301050A0A010005022C00000005120601000502330000000510010005023A0000000503010005023E000000000101 |
| )"; |
| |
| SubsystemRAII<FileSystem, HostInfo, ObjectFileWasm, SymbolVendorWasm> |
| subsystems; |
| |
| // Set up a wasm target. |
| TestContext test_ctx; |
| const uint32_t kExpectedValue = 42; |
| ASSERT_TRUE(CreateTestContext(&test_ctx, "wasm32-unknown-unknown-wasm", |
| RegisterValue(kExpectedValue))); |
| |
| llvm::Expected<TestFile> file = TestFile::fromYaml(yamldata); |
| EXPECT_THAT_EXPECTED(file, llvm::Succeeded()); |
| auto module_sp = std::make_shared<Module>(file->moduleSpec()); |
| auto obj_file_sp = module_sp->GetObjectFile()->shared_from_this(); |
| SymbolFileWasm sym_file_wasm(obj_file_sp, nullptr); |
| auto *dwarf_unit = sym_file_wasm.DebugInfo().GetUnitAtIndex(0); |
| |
| testExpressionVendorExtensions(module_sp, *dwarf_unit, |
| test_ctx.reg_ctx_sp.get()); |
| } |
| |
| TEST(DWARFExpression, ExtensionsSplitSymbols) { |
| const char *skeleton_yamldata = R"( |
| --- !WASM |
| FileHeader: |
| Version: 0x1 |
| Sections: |
| - Type: TYPE |
| Signatures: |
| - Index: 0 |
| ParamTypes: |
| - I32 |
| ReturnTypes: |
| - I32 |
| - Type: FUNCTION |
| FunctionTypes: [ 0 ] |
| - Type: TABLE |
| Tables: |
| - Index: 0 |
| ElemType: FUNCREF |
| Limits: |
| Flags: [ HAS_MAX ] |
| Minimum: 0x1 |
| Maximum: 0x1 |
| - Type: MEMORY |
| Memories: |
| - Flags: [ HAS_MAX ] |
| Minimum: 0x100 |
| Maximum: 0x100 |
| - Type: GLOBAL |
| Globals: |
| - Index: 0 |
| Type: I32 |
| Mutable: true |
| InitExpr: |
| Opcode: I32_CONST |
| Value: 65536 |
| - Type: EXPORT |
| Exports: |
| - Name: memory |
| Kind: MEMORY |
| Index: 0 |
| - Name: square |
| Kind: FUNCTION |
| Index: 0 |
| - Name: __indirect_function_table |
| Kind: TABLE |
| Index: 0 |
| - Type: CODE |
| Functions: |
| - Index: 0 |
| Locals: |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| Body: 2300210141102102200120026B21032003200036020C200328020C2104200328020C2105200420056C210620060F0B |
| - Type: CUSTOM |
| Name: name |
| FunctionNames: |
| - Index: 0 |
| Name: square |
| GlobalNames: |
| - Index: 0 |
| Name: __stack_pointer |
| - Type: CUSTOM |
| Name: external_debug_info |
| Payload: 167371756172652E7761736D2E64656275672E7761736D |
| )"; |
| |
| const char *sym_yamldata = R"( |
| --- !WASM |
| FileHeader: |
| Version: 0x1 |
| Sections: |
| - Type: TYPE |
| Signatures: |
| - Index: 0 |
| ParamTypes: |
| - I32 |
| ReturnTypes: |
| - I32 |
| - Type: FUNCTION |
| FunctionTypes: [ 0 ] |
| - Type: TABLE |
| Tables: |
| - Index: 0 |
| ElemType: FUNCREF |
| Limits: |
| Flags: [ HAS_MAX ] |
| Minimum: 0x1 |
| Maximum: 0x1 |
| - Type: MEMORY |
| Memories: |
| - Flags: [ HAS_MAX ] |
| Minimum: 0x100 |
| Maximum: 0x100 |
| - Type: GLOBAL |
| Globals: |
| - Index: 0 |
| Type: I32 |
| Mutable: true |
| InitExpr: |
| Opcode: I32_CONST |
| Value: 65536 |
| - Type: EXPORT |
| Exports: |
| - Name: memory |
| Kind: MEMORY |
| Index: 0 |
| - Name: square |
| Kind: FUNCTION |
| Index: 0 |
| - Name: __indirect_function_table |
| Kind: TABLE |
| Index: 0 |
| - Type: CODE |
| Functions: |
| - Index: 0 |
| Locals: |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| - Type: I32 |
| Count: 1 |
| Body: 2300210141102102200120026B21032003200036020C200328020C2104200328020C2105200420056C210620060F0B |
| - Type: CUSTOM |
| Name: name |
| FunctionNames: |
| - Index: 0 |
| Name: square |
| GlobalNames: |
| - Index: 0 |
| Name: __stack_pointer |
| - Type: CUSTOM |
| Name: .debug_abbrev |
| Payload: 011101250E1305030E10171B0E110112060000022E01110112064018030E3A0B3B0B271949133F1900000305000218030E3A0B3B0B49130000042400030E3E0B0B0B000000 |
| - Type: CUSTOM |
| Name: .debug_info |
| Payload: 510000000400000000000401670000001D005E0000000000000004000000020000003C00000002020000003C00000004ED00039F5700000001014D0000000302910C5100000001014D000000000400000000050400 |
| - Type: CUSTOM |
| Name: .debug_str |
| Payload: 696E7400513A5C70616F6C6F7365764D5346545C6C6C766D2D70726F6A6563745C6C6C64625C746573745C4150495C66756E6374696F6E616C69746965735C6764625F72656D6F74655F636C69656E740076616C756500737175617265007371756172652E6300636C616E672076657273696F6E2031382E302E30202868747470733A2F2F6769746875622E636F6D2F6C6C766D2F6C6C766D2D70726F6A65637420373535303166353336323464653932616166636532663164613639386232343961373239336463372900 |
| - Type: CUSTOM |
| Name: .debug_line |
| Payload: 64000000040020000000010101FB0E0D000101010100000001000001007371756172652E6300000000000005020200000001000502250000000301050A0A010005022C00000005120601000502330000000510010005023A0000000503010005023E000000000101 |
| )"; |
| |
| SubsystemRAII<FileSystem, HostInfo, ObjectFileWasm, SymbolVendorWasm> |
| subsystems; |
| |
| // Set up a wasm target. |
| TestContext test_ctx; |
| const uint32_t kExpectedValue = 42; |
| ASSERT_TRUE(CreateTestContext(&test_ctx, "wasm32-unknown-unknown-wasm", |
| RegisterValue(kExpectedValue))); |
| |
| llvm::Expected<TestFile> skeleton_file = |
| TestFile::fromYaml(skeleton_yamldata); |
| EXPECT_THAT_EXPECTED(skeleton_file, llvm::Succeeded()); |
| auto skeleton_module_sp = |
| std::make_shared<Module>(skeleton_file->moduleSpec()); |
| |
| llvm::Expected<TestFile> sym_file = TestFile::fromYaml(sym_yamldata); |
| EXPECT_THAT_EXPECTED(sym_file, llvm::Succeeded()); |
| auto sym_module_sp = std::make_shared<Module>(sym_file->moduleSpec()); |
| |
| auto obj_file_sp = sym_module_sp->GetObjectFile()->shared_from_this(); |
| SymbolFileWasm sym_file_wasm(obj_file_sp, nullptr); |
| auto *dwarf_unit = sym_file_wasm.DebugInfo().GetUnitAtIndex(0); |
| |
| testExpressionVendorExtensions(sym_module_sp, *dwarf_unit, |
| test_ctx.reg_ctx_sp.get()); |
| } |
| |
| TEST_F(DWARFExpressionMockProcessTest, DW_OP_piece_file_addr) { |
| using ::testing::ByMove; |
| using ::testing::ElementsAre; |
| using ::testing::Return; |
| |
| // Set up a mock process. |
| TestContext test_ctx; |
| MockMemory::Map memory = { |
| {{0x40, 1}, {0x11}}, |
| {{0x50, 1}, {0x22}}, |
| }; |
| ASSERT_TRUE( |
| CreateTestContext(&test_ctx, "i386-pc-linux", {}, {}, std::move(memory))); |
| ASSERT_TRUE(test_ctx.target_sp->GetArchitecture().IsValid()); |
| |
| ExecutionContext exe_ctx(test_ctx.target_sp, false); |
| |
| uint8_t expr[] = {DW_OP_addr, 0x40, 0x0, 0x0, 0x0, DW_OP_piece, 1, |
| DW_OP_addr, 0x50, 0x0, 0x0, 0x0, DW_OP_piece, 1}; |
| EXPECT_THAT_EXPECTED(Evaluate(expr, {}, {}, &exe_ctx), |
| ExpectHostAddress({0x11, 0x22})); |
| } |
| |
| class DWARFExpressionMockProcessTestWithAArch |
| : public DWARFExpressionMockProcessTest { |
| public: |
| void SetUp() override { |
| DWARFExpressionMockProcessTest::SetUp(); |
| #ifdef ARCH_AARCH64 |
| LLVMInitializeAArch64TargetInfo(); |
| LLVMInitializeAArch64TargetMC(); |
| ABISysV_arm64::Initialize(); |
| #endif |
| } |
| void TearDown() override { |
| DWARFExpressionMockProcessTest::TearDown(); |
| #ifdef ARCH_AARCH64 |
| ABISysV_arm64::Terminate(); |
| #endif |
| } |
| }; |
| |
| /// Sets the value of register x22 to "42". |
| /// Creates a process whose memory address 42 contains the value |
| /// memory[42] = ((0xffULL) << 56) | 0xabcdef; |
| /// The expression DW_OP_breg22, 0, DW_OP_deref should produce that same value, |
| /// without clearing the top byte 0xff. |
| TEST_F(DWARFExpressionMockProcessTestWithAArch, DW_op_deref_no_ptr_fixing) { |
| constexpr lldb::addr_t expected_value = ((0xffULL) << 56) | 0xabcdefULL; |
| constexpr lldb::addr_t addr = 42; |
| MockMemory::Map memory = { |
| {{addr, sizeof(addr)}, {0xef, 0xcd, 0xab, 0x00, 0x00, 0x00, 0x00, 0xff}}}; |
| |
| TestContext test_ctx; |
| ASSERT_TRUE(CreateTestContext(&test_ctx, "aarch64-pc-linux", |
| RegisterValue(addr), std::move(memory))); |
| |
| auto evaluate_expr = [&](auto &expr_data) { |
| ExecutionContext exe_ctx(test_ctx.process_sp); |
| return Evaluate(expr_data, {}, {}, &exe_ctx, test_ctx.reg_ctx_sp.get()); |
| }; |
| |
| uint8_t expr_reg[] = {DW_OP_breg22, 0}; |
| llvm::Expected<Value> result_reg = evaluate_expr(expr_reg); |
| EXPECT_THAT_EXPECTED(result_reg, ExpectLoadAddress(addr)); |
| |
| uint8_t expr_deref[] = {DW_OP_breg22, 0, DW_OP_deref}; |
| llvm::Expected<Value> result_deref = evaluate_expr(expr_deref); |
| EXPECT_THAT_EXPECTED(result_deref, ExpectLoadAddress(expected_value)); |
| } |
| |
| TEST_F(DWARFExpressionMockProcessTest, deref_register) { |
| TestContext test_ctx; |
| constexpr uint32_t reg_r0 = 0x504; |
| MockMemory::Map memory = { |
| {{0x004, 4}, {0x1, 0x2, 0x3, 0x4}}, |
| {{0x504, 4}, {0xa, 0xb, 0xc, 0xd}}, |
| {{0x505, 4}, {0x5, 0x6, 0x7, 0x8}}, |
| }; |
| ASSERT_TRUE(CreateTestContext(&test_ctx, "i386-pc-linux", |
| RegisterValue(reg_r0), memory, memory)); |
| |
| ExecutionContext exe_ctx(test_ctx.process_sp); |
| MockDwarfDelegate delegate = MockDwarfDelegate::Dwarf5(); |
| auto Eval = [&](llvm::ArrayRef<uint8_t> expr_data) { |
| ExecutionContext exe_ctx(test_ctx.process_sp); |
| return Evaluate(expr_data, {}, &delegate, &exe_ctx, |
| test_ctx.reg_ctx_sp.get()); |
| }; |
| |
| // Reads from the register r0. |
| // Sets the context to RegisterInfo so we know this is a register location. |
| EXPECT_THAT_EXPECTED(Eval({DW_OP_reg0}), |
| ExpectScalar(reg_r0, Value::ContextType::RegisterInfo)); |
| |
| // Reads from the location(register r0). |
| // Clears the context so we know this is a value not a location. |
| EXPECT_THAT_EXPECTED(Eval({DW_OP_reg0, DW_OP_deref}), |
| ExpectLoadAddress(reg_r0, Value::ContextType::Invalid)); |
| |
| // Reads from the location(register r0) and adds the value to the host buffer. |
| // The evaluator should implicitly convert it to a memory location when |
| // added to a composite value and should add the contents of memory[r0] |
| // to the host buffer. |
| EXPECT_THAT_EXPECTED(Eval({DW_OP_reg0, DW_OP_deref, DW_OP_piece, 4}), |
| ExpectHostAddress({0xa, 0xb, 0xc, 0xd})); |
| |
| // Reads from the location(register r0) and truncates the value to one byte. |
| // Clears the context so we know this is a value not a location. |
| EXPECT_THAT_EXPECTED( |
| Eval({DW_OP_reg0, DW_OP_deref_size, 1}), |
| ExpectLoadAddress(reg_r0 & 0xff, Value::ContextType::Invalid)); |
| |
| // Reads from the location(register r0) and truncates to one byte then adds |
| // the value to the host buffer. The evaluator should implicitly convert it to |
| // a memory location when added to a composite value and should add the |
| // contents of memory[r0 & 0xff] to the host buffer. |
| EXPECT_THAT_EXPECTED(Eval({DW_OP_reg0, DW_OP_deref_size, 1, DW_OP_piece, 4}), |
| ExpectHostAddress({0x1, 0x2, 0x3, 0x4})); |
| |
| // Reads from the register r0 + 1. |
| EXPECT_THAT_EXPECTED( |
| Eval({DW_OP_breg0, 1}), |
| ExpectLoadAddress(reg_r0 + 1, Value::ContextType::Invalid)); |
| |
| // Reads from address r0 + 1, which contains the bytes [5,6,7,8]. |
| EXPECT_THAT_EXPECTED( |
| Eval({DW_OP_breg0, 1, DW_OP_deref}), |
| ExpectLoadAddress(0x08070605, Value::ContextType::Invalid)); |
| } |
| |
| TEST_F(DWARFExpressionMockProcessTest, deref_implicit_value) { |
| TestContext test_ctx; |
| MockMemory::Map memory = { |
| {{0x4, 1}, {0x1}}, |
| {{0x4, 4}, {0x1, 0x2, 0x3, 0x4}}, |
| }; |
| ASSERT_TRUE(CreateTestContext(&test_ctx, "i386-pc-linux", {}, memory)); |
| |
| ExecutionContext exe_ctx(test_ctx.process_sp); |
| MockDwarfDelegate delegate = MockDwarfDelegate::Dwarf5(); |
| auto Eval = [&](llvm::ArrayRef<uint8_t> expr_data) { |
| ExecutionContext exe_ctx(test_ctx.process_sp); |
| return Evaluate(expr_data, {}, &delegate, &exe_ctx, |
| test_ctx.reg_ctx_sp.get()); |
| }; |
| |
| // Creates an implicit location with a value of 4. |
| EXPECT_THAT_EXPECTED(Eval({DW_OP_lit4, DW_OP_stack_value}), |
| ExpectScalar(0x4)); |
| |
| // Creates an implicit location with a value of 4. The deref reads the value |
| // out of the location and implicitly converts it to a load address. |
| EXPECT_THAT_EXPECTED(Eval({DW_OP_lit4, DW_OP_stack_value, DW_OP_deref}), |
| ExpectLoadAddress(0x4)); |
| |
| // Creates an implicit location with a value of 0x504 (uleb128(0x504) = |
| // 0xa84). The deref reads the low byte out of the location and implicitly |
| // converts it to a load address. |
| EXPECT_THAT_EXPECTED( |
| Eval({DW_OP_constu, 0x84, 0xa, DW_OP_stack_value, DW_OP_deref_size, 1}), |
| ExpectLoadAddress(0x4)); |
| |
| // The tests below are similar to the ones above, but there is no implicit |
| // location created by a stack_value operation. They are provided here as a |
| // reference to contrast with the above tests. |
| EXPECT_THAT_EXPECTED(Eval({DW_OP_lit4}), ExpectLoadAddress(0x4)); |
| |
| EXPECT_THAT_EXPECTED(Eval({DW_OP_lit4, DW_OP_deref}), |
| ExpectLoadAddress(0x04030201)); |
| |
| EXPECT_THAT_EXPECTED(Eval({DW_OP_lit4, DW_OP_deref_size, 1}), |
| ExpectLoadAddress(0x01)); |
| } |
