libbacktrace/unwind_dex_test.cpp

/*
 * Copyright (C) 2018 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 <sys/types.h>
#include <unistd.h>

#include <unordered_map>

#include <android-base/test_utils.h>

#include <unwindstack/MapInfo.h>
#include <unwindstack/Memory.h>

#include <dex/code_item_accessors-no_art-inl.h>
#include <dex/standard_dex_file.h>

#include <gtest/gtest.h>

#include "UnwindDexFile.h"

class MemoryFake : public unwindstack::Memory {
 public:
  MemoryFake() = default;
  virtual ~MemoryFake() = default;

  size_t Read(uint64_t addr, void* buffer, size_t size) override;

  void SetMemory(uint64_t addr, const void* memory, size_t length);

  void Clear() { data_.clear(); }

 private:
  std::unordered_map<uint64_t, uint8_t> data_;
};

void MemoryFake::SetMemory(uint64_t addr, const void* memory, size_t length) {
  const uint8_t* src = reinterpret_cast<const uint8_t*>(memory);
  for (size_t i = 0; i < length; i++, addr++) {
    auto value = data_.find(addr);
    if (value != data_.end()) {
      value->second = src[i];
    } else {
      data_.insert({addr, src[i]});
    }
  }
}

size_t MemoryFake::Read(uint64_t addr, void* memory, size_t size) {
  uint8_t* dst = reinterpret_cast<uint8_t*>(memory);
  for (size_t i = 0; i < size; i++, addr++) {
    auto value = data_.find(addr);
    if (value == data_.end()) {
      return i;
    }
    dst[i] = value->second;
  }
  return size;
}

// Borrowed from art/dex/dex_file_test.cc.
static constexpr uint32_t kDexData[] = {
    0x0a786564, 0x00383330, 0xc98b3ab8, 0xf3749d94, 0xaecca4d8, 0xffc7b09a, 0xdca9ca7f, 0x5be5deab,
    0x00000220, 0x00000070, 0x12345678, 0x00000000, 0x00000000, 0x0000018c, 0x00000008, 0x00000070,
    0x00000004, 0x00000090, 0x00000002, 0x000000a0, 0x00000000, 0x00000000, 0x00000003, 0x000000b8,
    0x00000001, 0x000000d0, 0x00000130, 0x000000f0, 0x00000122, 0x0000012a, 0x00000132, 0x00000146,
    0x00000151, 0x00000154, 0x00000158, 0x0000016d, 0x00000001, 0x00000002, 0x00000004, 0x00000006,
    0x00000004, 0x00000002, 0x00000000, 0x00000005, 0x00000002, 0x0000011c, 0x00000000, 0x00000000,
    0x00010000, 0x00000007, 0x00000001, 0x00000000, 0x00000000, 0x00000001, 0x00000001, 0x00000000,
    0x00000003, 0x00000000, 0x0000017e, 0x00000000, 0x00010001, 0x00000001, 0x00000173, 0x00000004,
    0x00021070, 0x000e0000, 0x00010001, 0x00000000, 0x00000178, 0x00000001, 0x0000000e, 0x00000001,
    0x3c060003, 0x74696e69, 0x4c06003e, 0x6e69614d, 0x4c12003b, 0x6176616a, 0x6e616c2f, 0x624f2f67,
    0x7463656a, 0x4d09003b, 0x2e6e6961, 0x6176616a, 0x00560100, 0x004c5602, 0x6a4c5b13, 0x2f617661,
    0x676e616c, 0x7274532f, 0x3b676e69, 0x616d0400, 0x01006e69, 0x000e0700, 0x07000103, 0x0000000e,
    0x81000002, 0x01f00480, 0x02880901, 0x0000000c, 0x00000000, 0x00000001, 0x00000000, 0x00000001,
    0x00000008, 0x00000070, 0x00000002, 0x00000004, 0x00000090, 0x00000003, 0x00000002, 0x000000a0,
    0x00000005, 0x00000003, 0x000000b8, 0x00000006, 0x00000001, 0x000000d0, 0x00002001, 0x00000002,
    0x000000f0, 0x00001001, 0x00000001, 0x0000011c, 0x00002002, 0x00000008, 0x00000122, 0x00002003,
    0x00000002, 0x00000173, 0x00002000, 0x00000001, 0x0000017e, 0x00001000, 0x00000001, 0x0000018c,
};

TEST(UnwindDexTest, from_file_open_non_exist) {
  UnwindDexFileFromFile dex_file;
  ASSERT_FALSE(dex_file.Open(0, "/file/does/not/exist"));
}

TEST(UnwindDexTest, from_file_open_too_small) {
  TemporaryFile tf;
  ASSERT_TRUE(tf.fd != -1);

  ASSERT_EQ(sizeof(art::DexFile::Header) - 2,
            static_cast<size_t>(
                TEMP_FAILURE_RETRY(write(tf.fd, kDexData, sizeof(art::DexFile::Header)) - 2)));

  // Header too small.
  UnwindDexFileFromFile dex_file;
  ASSERT_FALSE(dex_file.Open(0, tf.path));

  // Header correct, file too small.
  ASSERT_EQ(0, lseek(tf.fd, 0, SEEK_SET));
  ASSERT_EQ(sizeof(art::DexFile::Header), static_cast<size_t>(TEMP_FAILURE_RETRY(write(
                                              tf.fd, kDexData, sizeof(art::DexFile::Header)))));
  ASSERT_FALSE(dex_file.Open(0, tf.path));
}

TEST(UnwindDexTest, from_file_open) {
  TemporaryFile tf;
  ASSERT_TRUE(tf.fd != -1);

  ASSERT_EQ(sizeof(kDexData),
            static_cast<size_t>(TEMP_FAILURE_RETRY(write(tf.fd, kDexData, sizeof(kDexData)))));

  UnwindDexFileFromFile dex_file;
  ASSERT_TRUE(dex_file.Open(0, tf.path));
}

TEST(UnwindDexTest, from_file_open_non_zero_offset) {
  TemporaryFile tf;
  ASSERT_TRUE(tf.fd != -1);

  ASSERT_EQ(0x100, lseek(tf.fd, 0x100, SEEK_SET));
  ASSERT_EQ(sizeof(kDexData),
            static_cast<size_t>(TEMP_FAILURE_RETRY(write(tf.fd, kDexData, sizeof(kDexData)))));

  UnwindDexFileFromFile dex_file;
  ASSERT_TRUE(dex_file.Open(0x100, tf.path));
}

TEST(UnwindDexTest, from_memory_fail_too_small_for_header) {
  MemoryFake memory;

  memory.SetMemory(0x1000, kDexData, sizeof(art::DexFile::Header) - 1);
  UnwindDexFileFromMemory dex_file;

  ASSERT_FALSE(dex_file.Open(0x1000, &memory));
}

TEST(UnwindDexTest, from_memory_fail_too_small_for_data) {
  MemoryFake memory;

  memory.SetMemory(0x1000, kDexData, sizeof(kDexData) - 2);
  UnwindDexFileFromMemory dex_file;

  ASSERT_FALSE(dex_file.Open(0x1000, &memory));
}

TEST(UnwindDexTest, from_memory_open) {
  MemoryFake memory;

  memory.SetMemory(0x1000, kDexData, sizeof(kDexData));
  UnwindDexFileFromMemory dex_file;

  ASSERT_TRUE(dex_file.Open(0x1000, &memory));
}

TEST(UnwindDexTest, create_using_file) {
  TemporaryFile tf;
  ASSERT_TRUE(tf.fd != -1);

  ASSERT_EQ(0x500, lseek(tf.fd, 0x500, SEEK_SET));
  ASSERT_EQ(sizeof(kDexData),
            static_cast<size_t>(TEMP_FAILURE_RETRY(write(tf.fd, kDexData, sizeof(kDexData)))));

  MemoryFake memory;
  unwindstack::MapInfo info(0, 0x10000, 0, 0x5, tf.path);
  std::unique_ptr<UnwindDexFile> dex_file(UnwindDexFile::Create(0x500, &memory, &info));
  ASSERT_TRUE(dex_file != nullptr);
}

TEST(UnwindDexTest, create_using_file_non_zero_start) {
  TemporaryFile tf;
  ASSERT_TRUE(tf.fd != -1);

  ASSERT_EQ(0x500, lseek(tf.fd, 0x500, SEEK_SET));
  ASSERT_EQ(sizeof(kDexData),
            static_cast<size_t>(TEMP_FAILURE_RETRY(write(tf.fd, kDexData, sizeof(kDexData)))));

  MemoryFake memory;
  unwindstack::MapInfo info(0x100, 0x10000, 0, 0x5, tf.path);
  std::unique_ptr<UnwindDexFile> dex_file(UnwindDexFile::Create(0x600, &memory, &info));
  ASSERT_TRUE(dex_file != nullptr);
}

TEST(UnwindDexTest, create_using_file_non_zero_offset) {
  TemporaryFile tf;
  ASSERT_TRUE(tf.fd != -1);

  ASSERT_EQ(0x500, lseek(tf.fd, 0x500, SEEK_SET));
  ASSERT_EQ(sizeof(kDexData),
            static_cast<size_t>(TEMP_FAILURE_RETRY(write(tf.fd, kDexData, sizeof(kDexData)))));

  MemoryFake memory;
  unwindstack::MapInfo info(0x100, 0x10000, 0x200, 0x5, tf.path);
  std::unique_ptr<UnwindDexFile> dex_file(UnwindDexFile::Create(0x400, &memory, &info));
  ASSERT_TRUE(dex_file != nullptr);
}

TEST(UnwindDexTest, create_using_memory_empty_file) {
  MemoryFake memory;
  memory.SetMemory(0x4000, kDexData, sizeof(kDexData));
  unwindstack::MapInfo info(0x100, 0x10000, 0x200, 0x5, "");
  std::unique_ptr<UnwindDexFile> dex_file(UnwindDexFile::Create(0x4000, &memory, &info));
  ASSERT_TRUE(dex_file != nullptr);
}

TEST(UnwindDexTest, create_using_memory_file_does_not_exist) {
  MemoryFake memory;
  memory.SetMemory(0x4000, kDexData, sizeof(kDexData));
  unwindstack::MapInfo info(0x100, 0x10000, 0x200, 0x5, "/does/not/exist");
  std::unique_ptr<UnwindDexFile> dex_file(UnwindDexFile::Create(0x4000, &memory, &info));
  ASSERT_TRUE(dex_file != nullptr);
}

TEST(UnwindDexTest, create_using_memory_file_is_malformed) {
  TemporaryFile tf;
  ASSERT_TRUE(tf.fd != -1);

  ASSERT_EQ(sizeof(kDexData) - 10,
            static_cast<size_t>(TEMP_FAILURE_RETRY(write(tf.fd, kDexData, sizeof(kDexData) - 10))));

  MemoryFake memory;
  memory.SetMemory(0x4000, kDexData, sizeof(kDexData));
  unwindstack::MapInfo info(0x4000, 0x10000, 0x200, 0x5, "/does/not/exist");
  std::unique_ptr<UnwindDexFile> dex_file(UnwindDexFile::Create(0x4000, &memory, &info));
  ASSERT_TRUE(dex_file != nullptr);

  // Check it came from memory by clearing memory and verifying it fails.
  memory.Clear();
  dex_file.reset(UnwindDexFile::Create(0x4000, &memory, &info));
  ASSERT_TRUE(dex_file == nullptr);
}

TEST(UnwindDexTest, get_method_not_opened) {
  std::string method("something");
  uint64_t method_offset = 100;
  UnwindDexFile dex_file;
  dex_file.GetMethodInformation(0x100, &method, &method_offset);
  EXPECT_EQ("something", method);
  EXPECT_EQ(100U, method_offset);
}

TEST(UnwindDexTest, get_method) {
  MemoryFake memory;
  memory.SetMemory(0x4000, kDexData, sizeof(kDexData));
  unwindstack::MapInfo info(0x100, 0x10000, 0x200, 0x5, "");
  std::unique_ptr<UnwindDexFile> dex_file(UnwindDexFile::Create(0x4000, &memory, &info));
  ASSERT_TRUE(dex_file != nullptr);

  std::string method;
  uint64_t method_offset;
  dex_file->GetMethodInformation(0x102, &method, &method_offset);
  EXPECT_EQ("Main.<init>", method);
  EXPECT_EQ(2U, method_offset);

  method = "not_in_a_method";
  method_offset = 0x123;
  dex_file->GetMethodInformation(0x100000, &method, &method_offset);
  EXPECT_EQ("not_in_a_method", method);
  EXPECT_EQ(0x123U, method_offset);
}