dolphin/Source/Core/Common/SymbolDB.cpp

// Copyright 2009 Dolphin Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later

#include "Common/SymbolDB.h"

#include <cstring>
#include <map>
#include <mutex>
#include <string>
#include <utility>

#include "Common/CommonTypes.h"
#include "Common/Logging/Log.h"

namespace Common
{
static std::string GetStrippedFunctionName(const std::string& symbol_name)
{
  std::string name = symbol_name.substr(0, symbol_name.find('('));
  size_t position = name.find(' ');
  if (position != std::string::npos)
    name.erase(position);
  return name;
}

SymbolDB::SymbolDB() = default;

SymbolDB::~SymbolDB() = default;

void Symbol::Rename(const std::string& symbol_name)
{
  this->name = symbol_name;
  this->function_name = GetStrippedFunctionName(symbol_name);
}

void SymbolDB::List()
{
  std::lock_guard lock(m_mutex);
  for (const auto& func : m_functions)
  {
    DEBUG_LOG_FMT(OSHLE, "{} @ {:08x}: {} bytes (hash {:08x}) : {} calls", func.second.name,
                  func.second.address, func.second.size, func.second.hash, func.second.num_calls);
  }
  INFO_LOG_FMT(OSHLE, "{} functions known in this program above.", m_functions.size());
}

bool SymbolDB::IsEmpty() const
{
  std::lock_guard lock(m_mutex);
  return m_functions.empty() && m_notes.empty();
}

bool SymbolDB::Clear(const char* prefix)
{
  std::lock_guard lock(m_mutex);

  // TODO: honor prefix
  m_map_name.clear();
  if (IsEmpty())
    return false;

  m_functions.clear();
  m_notes.clear();
  m_checksum_to_function.clear();
  return true;
}

void SymbolDB::Index()
{
  std::lock_guard lock(m_mutex);
  Index(&m_functions);
}

void SymbolDB::Index(XFuncMap* functions)
{
  int i = 0;
  for (auto& func : *functions)
  {
    func.second.index = i++;
  }
}

const Symbol* SymbolDB::GetSymbolFromName(std::string_view name) const
{
  std::lock_guard lock(m_mutex);

  for (auto& func : m_functions)
  {
    if (func.second.function_name == name)
      return &func.second;
  }

  return nullptr;
}

std::vector<const Symbol*> SymbolDB::GetSymbolsFromName(std::string_view name) const
{
  std::lock_guard lock(m_mutex);
  std::vector<const Symbol*> symbols;

  for (auto& func : m_functions)
  {
    if (func.second.function_name == name)
      symbols.push_back(&func.second);
  }

  return symbols;
}

const Symbol* SymbolDB::GetSymbolFromHash(u32 hash) const
{
  std::lock_guard lock(m_mutex);

  auto iter = m_checksum_to_function.find(hash);
  if (iter == m_checksum_to_function.end())
    return nullptr;

  return *iter->second.begin();
}

std::vector<const Symbol*> SymbolDB::GetSymbolsFromHash(u32 hash) const
{
  std::lock_guard lock(m_mutex);

  const auto iter = m_checksum_to_function.find(hash);

  if (iter == m_checksum_to_function.cend())
    return {};

  return {iter->second.cbegin(), iter->second.cend()};
}

void SymbolDB::AddCompleteSymbol(const Symbol& symbol)
{
  std::lock_guard lock(m_mutex);
  m_functions[symbol.address] = symbol;
}

bool SymbolDB::RenameSymbol(const Symbol& symbol, const std::string& symbol_name)
{
  std::lock_guard lock(m_mutex);

  auto it = m_functions.find(symbol.address);
  if (it == m_functions.end())
    return false;

  it->second.Rename(symbol_name);
  return true;
}

bool SymbolDB::RenameSymbol(const Symbol& symbol, const std::string& symbol_name,
                            const std::string& object_name)
{
  std::lock_guard lock(m_mutex);

  auto it = m_functions.find(symbol.address);
  if (it == m_functions.end())
    return false;

  it->second.Rename(symbol_name);
  it->second.object_name = object_name;
  return true;
}

}  // namespace Common