mirror of
https://github.com/PCSX2/pcsx2.git
synced 2026-01-31 01:15:24 +01:00
44b50bee26
This new class uses the CCC library I added in the last commit and parses the symbol tables on a worker thread.
561 lines
15 KiB
C++
561 lines
15 KiB
C++
// SPDX-FileCopyrightText: 2002-2024 PCSX2 Dev Team
|
|
// SPDX-License-Identifier: GPL-3.0+
|
|
|
|
#include "SymbolGuardian.h"
|
|
|
|
#include <ccc/ast.h>
|
|
#include <ccc/elf.h>
|
|
#include <ccc/importer_flags.h>
|
|
#include <ccc/symbol_file.h>
|
|
|
|
#include "common/Console.h"
|
|
#include "common/FileSystem.h"
|
|
#include "common/StringUtil.h"
|
|
#include "common/Threading.h"
|
|
|
|
#include "DebugInterface.h"
|
|
#include "MIPSAnalyst.h"
|
|
#include "Host.h"
|
|
#include "VMManager.h"
|
|
|
|
SymbolGuardian R5900SymbolGuardian;
|
|
SymbolGuardian R3000SymbolGuardian;
|
|
|
|
struct DefaultBuiltInType
|
|
{
|
|
const char* name;
|
|
ccc::ast::BuiltInClass bclass;
|
|
};
|
|
|
|
static const std::vector<DefaultBuiltInType> DEFAULT_BUILT_IN_TYPES = {
|
|
{"char", ccc::ast::BuiltInClass::UNQUALIFIED_8},
|
|
{"signed char", ccc::ast::BuiltInClass::SIGNED_8},
|
|
{"unsigned char", ccc::ast::BuiltInClass::UNSIGNED_8},
|
|
{"short", ccc::ast::BuiltInClass::SIGNED_16},
|
|
{"unsigned short", ccc::ast::BuiltInClass::UNSIGNED_16},
|
|
{"int", ccc::ast::BuiltInClass::SIGNED_32},
|
|
{"unsigned int", ccc::ast::BuiltInClass::UNSIGNED_32},
|
|
{"unsigned", ccc::ast::BuiltInClass::UNSIGNED_32},
|
|
{"long", ccc::ast::BuiltInClass::SIGNED_64},
|
|
{"unsigned long", ccc::ast::BuiltInClass::UNSIGNED_64},
|
|
{"long long", ccc::ast::BuiltInClass::SIGNED_64},
|
|
{"unsigned long long", ccc::ast::BuiltInClass::UNSIGNED_64},
|
|
{"bool", ccc::ast::BuiltInClass::BOOL_8},
|
|
{"float", ccc::ast::BuiltInClass::FLOAT_32},
|
|
{"double", ccc::ast::BuiltInClass::FLOAT_64},
|
|
{"void", ccc::ast::BuiltInClass::VOID_TYPE},
|
|
{"s8", ccc::ast::BuiltInClass::SIGNED_8},
|
|
{"u8", ccc::ast::BuiltInClass::UNSIGNED_8},
|
|
{"s16", ccc::ast::BuiltInClass::SIGNED_16},
|
|
{"u16", ccc::ast::BuiltInClass::UNSIGNED_16},
|
|
{"s32", ccc::ast::BuiltInClass::SIGNED_32},
|
|
{"u32", ccc::ast::BuiltInClass::UNSIGNED_32},
|
|
{"s64", ccc::ast::BuiltInClass::SIGNED_64},
|
|
{"u64", ccc::ast::BuiltInClass::UNSIGNED_64},
|
|
{"s128", ccc::ast::BuiltInClass::SIGNED_128},
|
|
{"u128", ccc::ast::BuiltInClass::UNSIGNED_128},
|
|
{"f32", ccc::ast::BuiltInClass::FLOAT_32},
|
|
{"f64", ccc::ast::BuiltInClass::FLOAT_64},
|
|
};
|
|
|
|
static void error_callback(const ccc::Error& error, ccc::ErrorLevel level)
|
|
{
|
|
switch (level)
|
|
{
|
|
case ccc::ERROR_LEVEL_ERROR:
|
|
Console.Error("Error while importing symbol table: %s", error.message.c_str());
|
|
break;
|
|
case ccc::ERROR_LEVEL_WARNING:
|
|
Console.Warning("Warning while importing symbol table: %s", error.message.c_str());
|
|
break;
|
|
}
|
|
}
|
|
|
|
SymbolGuardian::SymbolGuardian()
|
|
{
|
|
ccc::set_custom_error_callback(error_callback);
|
|
}
|
|
|
|
SymbolGuardian::~SymbolGuardian()
|
|
{
|
|
}
|
|
|
|
void SymbolGuardian::Read(ReadCallback callback) const noexcept
|
|
{
|
|
m_big_symbol_lock.lock_shared();
|
|
callback(m_database);
|
|
m_big_symbol_lock.unlock_shared();
|
|
}
|
|
|
|
void SymbolGuardian::ReadWrite(ReadWriteCallback callback) noexcept
|
|
{
|
|
m_big_symbol_lock.lock();
|
|
callback(m_database);
|
|
m_big_symbol_lock.unlock();
|
|
}
|
|
|
|
void SymbolGuardian::Reset()
|
|
{
|
|
ShutdownWorkerThread();
|
|
|
|
ReadWrite([&](ccc::SymbolDatabase& database) {
|
|
database.clear();
|
|
|
|
ccc::Result<ccc::SymbolSourceHandle> source = database.get_symbol_source("Built-in");
|
|
if (!source.success())
|
|
return;
|
|
|
|
// Create some built-in data type symbols so that users still have some
|
|
// types to use even if there isn't a symbol table loaded. Maybe in the
|
|
// future we could add PS2-specific types like DMA tags here too.
|
|
for (const DefaultBuiltInType& default_type : DEFAULT_BUILT_IN_TYPES)
|
|
{
|
|
ccc::Result<ccc::DataType*> symbol = database.data_types.create_symbol(default_type.name, *source, nullptr);
|
|
if (!symbol.success())
|
|
return;
|
|
|
|
std::unique_ptr<ccc::ast::BuiltIn> type = std::make_unique<ccc::ast::BuiltIn>();
|
|
type->name = default_type.name;
|
|
type->size_bytes = ccc::ast::builtin_class_size(default_type.bclass);
|
|
type->bclass = default_type.bclass;
|
|
(*symbol)->set_type(std::move(type));
|
|
}
|
|
});
|
|
}
|
|
|
|
static void CreateBuiltInDataType(
|
|
ccc::SymbolDatabase& database, ccc::SymbolSourceHandle source, const char* name, ccc::ast::BuiltInClass bclass)
|
|
{
|
|
ccc::Result<ccc::DataType*> symbol = database.data_types.create_symbol(name, source, nullptr);
|
|
if (!symbol.success())
|
|
return;
|
|
|
|
std::unique_ptr<ccc::ast::BuiltIn> type = std::make_unique<ccc::ast::BuiltIn>();
|
|
type->name = name;
|
|
type->size_bytes = ccc::ast::builtin_class_size(bclass);
|
|
type->bclass = bclass;
|
|
(*symbol)->set_type(std::move(type));
|
|
}
|
|
|
|
void SymbolGuardian::ImportElf(std::vector<u8> elf, std::string elf_file_name, const std::string& nocash_path)
|
|
{
|
|
ccc::Result<ccc::ElfFile> parsed_elf = ccc::ElfFile::parse(std::move(elf));
|
|
if (!parsed_elf.success())
|
|
{
|
|
ccc::report_error(parsed_elf.error());
|
|
return;
|
|
}
|
|
|
|
std::unique_ptr<ccc::ElfSymbolFile> symbol_file =
|
|
std::make_unique<ccc::ElfSymbolFile>(std::move(*parsed_elf), std::move(elf_file_name));
|
|
|
|
ShutdownWorkerThread();
|
|
|
|
m_import_thread = std::thread([this, nocash_path, file = std::move(symbol_file)]() {
|
|
Threading::SetNameOfCurrentThread("Symbol Worker");
|
|
|
|
ccc::SymbolDatabase temp_database;
|
|
ImportSymbolTables(temp_database, *file, &m_interrupt_import_thread);
|
|
|
|
if (m_interrupt_import_thread)
|
|
return;
|
|
|
|
ImportNocashSymbols(temp_database, nocash_path);
|
|
|
|
if (m_interrupt_import_thread)
|
|
return;
|
|
|
|
ComputeOriginalFunctionHashes(temp_database, file->elf());
|
|
|
|
if (m_interrupt_import_thread)
|
|
return;
|
|
|
|
// Wait for the ELF to be loaded into memory, otherwise the call to
|
|
// ScanForFunctions below won't work.
|
|
while (true)
|
|
{
|
|
bool has_booted_elf = false;
|
|
Host::RunOnCPUThread([&]() {
|
|
has_booted_elf = VMManager::Internal::HasBootedELF();
|
|
},
|
|
true);
|
|
|
|
if (has_booted_elf)
|
|
break;
|
|
|
|
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
|
|
|
if (m_interrupt_import_thread)
|
|
return;
|
|
}
|
|
|
|
Host::RunOnCPUThread([this, &temp_database, &file, nocash_path]() {
|
|
ReadWrite([&](ccc::SymbolDatabase& database) {
|
|
database.merge_from(temp_database);
|
|
|
|
const ccc::ElfProgramHeader* entry_segment = file->elf().entry_point_segment();
|
|
if (entry_segment)
|
|
MIPSAnalyst::ScanForFunctions(database, entry_segment->vaddr, entry_segment->vaddr + entry_segment->filesz);
|
|
});
|
|
},
|
|
true);
|
|
});
|
|
}
|
|
|
|
void SymbolGuardian::ShutdownWorkerThread()
|
|
{
|
|
m_interrupt_import_thread = true;
|
|
if (m_import_thread.joinable())
|
|
m_import_thread.join();
|
|
m_interrupt_import_thread = false;
|
|
}
|
|
|
|
|
|
ccc::ModuleHandle SymbolGuardian::ImportSymbolTables(
|
|
ccc::SymbolDatabase& database, const ccc::SymbolFile& symbol_file, const std::atomic_bool* interrupt)
|
|
{
|
|
ccc::Result<std::vector<std::unique_ptr<ccc::SymbolTable>>> symbol_tables = symbol_file.get_all_symbol_tables();
|
|
if (!symbol_tables.success())
|
|
{
|
|
ccc::report_error(symbol_tables.error());
|
|
return ccc::ModuleHandle();
|
|
}
|
|
|
|
ccc::DemanglerFunctions demangler;
|
|
|
|
u32 importer_flags =
|
|
ccc::DEMANGLE_PARAMETERS |
|
|
ccc::DEMANGLE_RETURN_TYPE |
|
|
ccc::NO_MEMBER_FUNCTIONS |
|
|
ccc::NO_OPTIMIZED_OUT_FUNCTIONS |
|
|
ccc::UNIQUE_FUNCTIONS;
|
|
|
|
ccc::Result<ccc::ModuleHandle> module_handle = ccc::import_symbol_tables(
|
|
database, symbol_file.name(), *symbol_tables, importer_flags, demangler, interrupt);
|
|
if (!module_handle.success())
|
|
{
|
|
ccc::report_error(module_handle.error());
|
|
return ccc::ModuleHandle();
|
|
}
|
|
|
|
Console.WriteLn("Imported %d symbols.", database.symbol_count());
|
|
|
|
return *module_handle;
|
|
}
|
|
|
|
bool SymbolGuardian::ImportNocashSymbols(ccc::SymbolDatabase& database, const std::string& file_name)
|
|
{
|
|
ccc::Result<ccc::SymbolSourceHandle> source = database.get_symbol_source("Nocash Symbols");
|
|
if (!source.success())
|
|
return false;
|
|
|
|
FILE* f = FileSystem::OpenCFile(file_name.c_str(), "r");
|
|
if (!f)
|
|
return false;
|
|
|
|
while (!feof(f))
|
|
{
|
|
char line[256], value[256] = {0};
|
|
char* p = fgets(line, 256, f);
|
|
if (p == NULL)
|
|
break;
|
|
|
|
if (char* end = strchr(line, '\n'))
|
|
*end = '\0';
|
|
|
|
u32 address;
|
|
if (sscanf(line, "%08x %255s", &address, value) != 2)
|
|
continue;
|
|
if (address == 0 && strcmp(value, "0") == 0)
|
|
continue;
|
|
|
|
if (value[0] == '.')
|
|
{
|
|
// data directives
|
|
char* s = strchr(value, ':');
|
|
if (s != NULL)
|
|
{
|
|
*s = 0;
|
|
|
|
u32 size = 0;
|
|
if (sscanf(s + 1, "%04x", &size) != 1)
|
|
continue;
|
|
|
|
std::unique_ptr<ccc::ast::BuiltIn> scalar_type = std::make_unique<ccc::ast::BuiltIn>();
|
|
if (StringUtil::Strcasecmp(value, ".byt") == 0)
|
|
{
|
|
scalar_type->size_bytes = 1;
|
|
scalar_type->bclass = ccc::ast::BuiltInClass::UNSIGNED_8;
|
|
}
|
|
else if (StringUtil::Strcasecmp(value, ".wrd") == 0)
|
|
{
|
|
scalar_type->size_bytes = 2;
|
|
scalar_type->bclass = ccc::ast::BuiltInClass::UNSIGNED_16;
|
|
}
|
|
else if (StringUtil::Strcasecmp(value, ".dbl") == 0)
|
|
{
|
|
scalar_type->size_bytes = 4;
|
|
scalar_type->bclass = ccc::ast::BuiltInClass::UNSIGNED_32;
|
|
}
|
|
else if (StringUtil::Strcasecmp(value, ".asc") == 0)
|
|
{
|
|
scalar_type->size_bytes = 1;
|
|
scalar_type->bclass = ccc::ast::BuiltInClass::UNQUALIFIED_8;
|
|
}
|
|
else
|
|
{
|
|
continue;
|
|
}
|
|
|
|
ccc::Result<ccc::GlobalVariable*> global_variable = database.global_variables.create_symbol(
|
|
line, address, *source, nullptr);
|
|
if (!global_variable.success())
|
|
{
|
|
fclose(f);
|
|
return false;
|
|
}
|
|
|
|
if (scalar_type->size_bytes == (s32)size)
|
|
{
|
|
(*global_variable)->set_type(std::move(scalar_type));
|
|
}
|
|
else
|
|
{
|
|
std::unique_ptr<ccc::ast::Array> array = std::make_unique<ccc::ast::Array>();
|
|
array->size_bytes = (s32)size;
|
|
array->element_type = std::move(scalar_type);
|
|
array->element_count = size / array->element_type->size_bytes;
|
|
(*global_variable)->set_type(std::move(array));
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{ // labels
|
|
u32 size = 1;
|
|
char* seperator = strchr(value, ',');
|
|
if (seperator != NULL)
|
|
{
|
|
*seperator = 0;
|
|
sscanf(seperator + 1, "%08x", &size);
|
|
}
|
|
|
|
if (size != 1)
|
|
{
|
|
ccc::Result<ccc::Function*> function = database.functions.create_symbol(value, address, *source, nullptr);
|
|
if (!function.success())
|
|
{
|
|
fclose(f);
|
|
return false;
|
|
}
|
|
|
|
(*function)->set_size(size);
|
|
}
|
|
else
|
|
{
|
|
ccc::Result<ccc::Label*> label = database.labels.create_symbol(value, address, *source, nullptr);
|
|
if (!label.success())
|
|
{
|
|
fclose(f);
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
fclose(f);
|
|
return true;
|
|
}
|
|
|
|
void SymbolGuardian::ComputeOriginalFunctionHashes(ccc::SymbolDatabase& database, const ccc::ElfFile& elf)
|
|
{
|
|
for (ccc::Function& function : database.functions)
|
|
{
|
|
if (!function.address().valid())
|
|
continue;
|
|
|
|
if (function.size() == 0)
|
|
continue;
|
|
|
|
ccc::Result<std::span<const u32>> text = elf.get_array_virtual<u32>(
|
|
function.address().value, function.size() / 4);
|
|
if (!text.success())
|
|
{
|
|
ccc::report_warning(text.error());
|
|
break;
|
|
}
|
|
|
|
ccc::FunctionHash hash;
|
|
for (u32 instruction : *text)
|
|
hash.update(instruction);
|
|
|
|
function.set_original_hash(hash.get());
|
|
}
|
|
}
|
|
|
|
void SymbolGuardian::UpdateFunctionHashes(DebugInterface& cpu)
|
|
{
|
|
ReadWrite([&](ccc::SymbolDatabase& database) {
|
|
for (ccc::Function& function : database.functions)
|
|
{
|
|
if (!function.address().valid())
|
|
continue;
|
|
|
|
if (function.size() == 0)
|
|
continue;
|
|
|
|
ccc::FunctionHash hash;
|
|
for (u32 i = 0; i < function.size() / 4; i++)
|
|
hash.update(cpu.read32(function.address().value + i * 4));
|
|
|
|
function.set_current_hash(hash);
|
|
}
|
|
|
|
for (ccc::SourceFile& source_file : database.source_files)
|
|
source_file.check_functions_match(database);
|
|
});
|
|
}
|
|
|
|
void SymbolGuardian::ClearIrxModules()
|
|
{
|
|
ReadWrite([&](ccc::SymbolDatabase& database) {
|
|
std::vector<ccc::ModuleHandle> irx_modules;
|
|
for (const ccc::Module& module : m_database.modules)
|
|
if (module.is_irx)
|
|
irx_modules.emplace_back(module.handle());
|
|
|
|
for (ccc::ModuleHandle module : irx_modules)
|
|
m_database.destroy_symbols_from_module(module, false);
|
|
});
|
|
}
|
|
|
|
SymbolInfo SymbolGuardian::SymbolStartingAtAddress(
|
|
u32 address, u32 descriptors) const
|
|
{
|
|
SymbolInfo info;
|
|
Read([&](const ccc::SymbolDatabase& database) {
|
|
ccc::SymbolDescriptor descriptor;
|
|
const ccc::Symbol* symbol = database.symbol_starting_at_address(address, descriptors, &descriptor);
|
|
if (!symbol)
|
|
return;
|
|
|
|
info.descriptor = descriptor;
|
|
info.handle = symbol->raw_handle();
|
|
info.name = symbol->name();
|
|
info.address = symbol->address();
|
|
info.size = symbol->size();
|
|
});
|
|
return info;
|
|
}
|
|
|
|
SymbolInfo SymbolGuardian::SymbolAfterAddress(
|
|
u32 address, u32 descriptors) const
|
|
{
|
|
SymbolInfo info;
|
|
Read([&](const ccc::SymbolDatabase& database) {
|
|
ccc::SymbolDescriptor descriptor;
|
|
const ccc::Symbol* symbol = database.symbol_after_address(address, descriptors, &descriptor);
|
|
if (!symbol)
|
|
return;
|
|
|
|
info.descriptor = descriptor;
|
|
info.handle = symbol->raw_handle();
|
|
info.name = symbol->name();
|
|
info.address = symbol->address();
|
|
info.size = symbol->size();
|
|
});
|
|
return info;
|
|
}
|
|
|
|
SymbolInfo SymbolGuardian::SymbolOverlappingAddress(
|
|
u32 address, u32 descriptors) const
|
|
{
|
|
SymbolInfo info;
|
|
Read([&](const ccc::SymbolDatabase& database) {
|
|
ccc::SymbolDescriptor descriptor;
|
|
const ccc::Symbol* symbol = database.symbol_overlapping_address(address, descriptors, &descriptor);
|
|
if (!symbol)
|
|
return;
|
|
|
|
info.descriptor = descriptor;
|
|
info.handle = symbol->raw_handle();
|
|
info.name = symbol->name();
|
|
info.address = symbol->address();
|
|
info.size = symbol->size();
|
|
});
|
|
return info;
|
|
}
|
|
|
|
SymbolInfo SymbolGuardian::SymbolWithName(
|
|
const std::string& name, u32 descriptors) const
|
|
{
|
|
SymbolInfo info;
|
|
Read([&](const ccc::SymbolDatabase& database) {
|
|
ccc::SymbolDescriptor descriptor;
|
|
const ccc::Symbol* symbol = database.symbol_with_name(name, descriptors, &descriptor);
|
|
if (!symbol)
|
|
return;
|
|
|
|
info.descriptor = descriptor;
|
|
info.handle = symbol->raw_handle();
|
|
info.name = symbol->name();
|
|
info.address = symbol->address();
|
|
info.size = symbol->size();
|
|
});
|
|
return info;
|
|
}
|
|
|
|
bool SymbolGuardian::FunctionExistsWithStartingAddress(u32 address) const
|
|
{
|
|
bool exists = false;
|
|
Read([&](const ccc::SymbolDatabase& database) {
|
|
ccc::FunctionHandle handle = database.functions.first_handle_from_starting_address(address);
|
|
exists = handle.valid();
|
|
});
|
|
return exists;
|
|
}
|
|
|
|
bool SymbolGuardian::FunctionExistsThatOverlapsAddress(u32 address) const
|
|
{
|
|
bool exists = false;
|
|
Read([&](const ccc::SymbolDatabase& database) {
|
|
const ccc::Function* function = database.functions.symbol_overlapping_address(address);
|
|
exists = function != nullptr;
|
|
});
|
|
return exists;
|
|
}
|
|
|
|
FunctionInfo SymbolGuardian::FunctionStartingAtAddress(u32 address) const
|
|
{
|
|
FunctionInfo info;
|
|
Read([&](const ccc::SymbolDatabase& database) {
|
|
ccc::FunctionHandle handle = database.functions.first_handle_from_starting_address(address);
|
|
const ccc::Function* function = database.functions.symbol_from_handle(handle);
|
|
if (!function)
|
|
return;
|
|
|
|
info.handle = function->handle();
|
|
info.name = function->name();
|
|
info.address = function->address();
|
|
info.size = function->size();
|
|
info.is_no_return = function->is_no_return;
|
|
});
|
|
return info;
|
|
}
|
|
|
|
FunctionInfo SymbolGuardian::FunctionOverlappingAddress(u32 address) const
|
|
{
|
|
FunctionInfo info;
|
|
Read([&](const ccc::SymbolDatabase& database) {
|
|
const ccc::Function* function = database.functions.symbol_overlapping_address(address);
|
|
if (!function)
|
|
return;
|
|
|
|
info.handle = function->handle();
|
|
info.name = function->name();
|
|
info.address = function->address();
|
|
info.size = function->size();
|
|
info.is_no_return = function->is_no_return;
|
|
});
|
|
return info;
|
|
}
|