xref: /aosp_15_r20/system/unwinding/libunwindstack/tests/DwarfEhFrameTest.cpp (revision eb293b8f56ee8303637c5595cfcdeef8039e85c6)

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <stdint.h>

#include <memory>

#include <gtest/gtest.h>

#include <unwindstack/DwarfError.h>

#include "DwarfEhFrame.h"
#include "DwarfEncoding.h"

#include "LogFake.h"
#include "utils/MemoryFake.h"

namespace unwindstack {

template <typename TypeParam>
class DwarfEhFrameTest : public ::testing::Test {
 protected:
  void SetUp() override {
    fake_memory_ = new MemoryFake;
    std::shared_ptr<Memory> memory(fake_memory_);
    eh_frame_.reset(new DwarfEhFrame<TypeParam>(memory));
    ResetLogs();
  }

  MemoryFake* fake_memory_;
  std::unique_ptr<DwarfEhFrame<TypeParam>> eh_frame_;
};
TYPED_TEST_SUITE_P(DwarfEhFrameTest);

// NOTE: All test class variables need to be referenced as this->.

// Only verify different cie/fde format. All other DwarfSection corner
// cases are tested in DwarfDebugFrameTest.cpp.

TYPED_TEST_P(DwarfEhFrameTest, GetFdeCieFromOffset32) {
  // CIE 32 information.
  this->fake_memory_->SetData32(0x5000, 0xfc);
  // Indicates this is a cie for eh_frame.
  this->fake_memory_->SetData32(0x5004, 0);
  this->fake_memory_->SetMemory(0x5008, std::vector<uint8_t>{1, '\0', 16, 32, 1});

  // FDE 32 information.
  this->fake_memory_->SetData32(0x5100, 0xfc);
  this->fake_memory_->SetData32(0x5104, 0x104);
  this->fake_memory_->SetData32(0x5108, 0x1500);
  this->fake_memory_->SetData32(0x510c, 0x200);

  const DwarfFde* fde = this->eh_frame_->GetFdeFromOffset(0x5100);
  ASSERT_TRUE(fde != nullptr);
  EXPECT_EQ(0x5000U, fde->cie_offset);
  EXPECT_EQ(0x5110U, fde->cfa_instructions_offset);
  EXPECT_EQ(0x5200U, fde->cfa_instructions_end);
  EXPECT_EQ(0x6608U, fde->pc_start);
  EXPECT_EQ(0x6808U, fde->pc_end);
  EXPECT_EQ(0U, fde->lsda_address);

  const DwarfCie* cie = fde->cie;
  ASSERT_TRUE(cie != nullptr);
  EXPECT_EQ(1U, cie->version);
  EXPECT_EQ(DW_EH_PE_udata4, cie->fde_address_encoding);
  EXPECT_EQ(DW_EH_PE_omit, cie->lsda_encoding);
  EXPECT_EQ(0U, cie->segment_size);
  EXPECT_EQ('\0', cie->augmentation_string[0]);
  EXPECT_EQ(0U, cie->personality_handler);
  EXPECT_EQ(0x500dU, cie->cfa_instructions_offset);
  EXPECT_EQ(0x5100U, cie->cfa_instructions_end);
  EXPECT_EQ(16U, cie->code_alignment_factor);
  EXPECT_EQ(32U, cie->data_alignment_factor);
  EXPECT_EQ(1U, cie->return_address_register);
}

TYPED_TEST_P(DwarfEhFrameTest, GetFdeCieFromOffset64) {
  // CIE 64 information.
  this->fake_memory_->SetData32(0x5000, 0xffffffff);
  this->fake_memory_->SetData64(0x5004, 0xfc);
  // Indicates this is a cie for eh_frame.
  this->fake_memory_->SetData64(0x500c, 0);
  this->fake_memory_->SetMemory(0x5014, std::vector<uint8_t>{1, '\0', 16, 32, 1});

  // FDE 64 information.
  this->fake_memory_->SetData32(0x5100, 0xffffffff);
  this->fake_memory_->SetData64(0x5104, 0xfc);
  this->fake_memory_->SetData64(0x510c, 0x10c);
  this->fake_memory_->SetData64(0x5114, 0x1500);
  this->fake_memory_->SetData64(0x511c, 0x200);

  const DwarfFde* fde = this->eh_frame_->GetFdeFromOffset(0x5100);
  ASSERT_TRUE(fde != nullptr);
  EXPECT_EQ(0x5000U, fde->cie_offset);
  EXPECT_EQ(0x5124U, fde->cfa_instructions_offset);
  EXPECT_EQ(0x5208U, fde->cfa_instructions_end);
  EXPECT_EQ(0x6618U, fde->pc_start);
  EXPECT_EQ(0x6818U, fde->pc_end);
  EXPECT_EQ(0U, fde->lsda_address);

  const DwarfCie* cie = fde->cie;
  ASSERT_TRUE(cie != nullptr);
  EXPECT_EQ(1U, cie->version);
  EXPECT_EQ(DW_EH_PE_udata8, cie->fde_address_encoding);
  EXPECT_EQ(DW_EH_PE_omit, cie->lsda_encoding);
  EXPECT_EQ(0U, cie->segment_size);
  EXPECT_EQ('\0', cie->augmentation_string[0]);
  EXPECT_EQ(0U, cie->personality_handler);
  EXPECT_EQ(0x5019U, cie->cfa_instructions_offset);
  EXPECT_EQ(0x5108U, cie->cfa_instructions_end);
  EXPECT_EQ(16U, cie->code_alignment_factor);
  EXPECT_EQ(32U, cie->data_alignment_factor);
  EXPECT_EQ(1U, cie->return_address_register);
}

REGISTER_TYPED_TEST_SUITE_P(DwarfEhFrameTest, GetFdeCieFromOffset32, GetFdeCieFromOffset64);

typedef ::testing::Types<uint32_t, uint64_t> DwarfEhFrameTestTypes;
INSTANTIATE_TYPED_TEST_SUITE_P(Libunwindstack, DwarfEhFrameTest, DwarfEhFrameTestTypes);

}  // namespace unwindstack