mirror of
https://github.com/KytyPS5/KytyPS5.git
synced 2026-10-21 03:16:54 +02:00
loader: add support for etaHEN cheats
This commit is contained in:
nmzik
+211
-139
@@ -8,207 +8,235 @@
|
||||
#include "loader/systemContent.h"
|
||||
|
||||
#include <algorithm>
|
||||
#include <charconv>
|
||||
#include <cstdio>
|
||||
#include <cstring>
|
||||
#include <fstream>
|
||||
#include <memory>
|
||||
#include <nlohmann/json.hpp>
|
||||
#include <string>
|
||||
#include <string_view>
|
||||
#include <system_error>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
|
||||
namespace Loader::GamePatch {
|
||||
|
||||
namespace {
|
||||
|
||||
constexpr uint64_t kPageSize = 0x4000;
|
||||
|
||||
struct Write {
|
||||
std::string patch_name;
|
||||
uint64_t address = 0;
|
||||
std::vector<uint8_t> expected;
|
||||
std::vector<uint8_t> replacement;
|
||||
uint64_t source_address = 0;
|
||||
uint64_t target_address = 0;
|
||||
std::vector<uint8_t> off;
|
||||
std::vector<uint8_t> on;
|
||||
};
|
||||
|
||||
struct Plan {
|
||||
std::string title_id;
|
||||
std::string game_version;
|
||||
std::string version;
|
||||
std::string process;
|
||||
std::vector<Write> writes;
|
||||
std::vector<std::string> patch_names;
|
||||
std::vector<std::string> mod_names;
|
||||
std::vector<uint64_t> cave_pages;
|
||||
};
|
||||
|
||||
using Json = nlohmann::json;
|
||||
|
||||
std::unique_ptr<Plan> g_pending_plan;
|
||||
std::vector<uint64_t> g_applied_cave_pages;
|
||||
|
||||
bool Fail(std::string* error, std::string message) {
|
||||
*error = std::move(message);
|
||||
return false;
|
||||
}
|
||||
|
||||
const Json::string_t* StringField(const Json& object, const char* name) {
|
||||
const auto value = object.find(name);
|
||||
return value == object.end() ? nullptr : value->get_ptr<const Json::string_t*>();
|
||||
}
|
||||
|
||||
const Json::array_t* ArrayField(const Json& object, const char* name) {
|
||||
const auto value = object.find(name);
|
||||
return value == object.end() ? nullptr : value->get_ptr<const Json::array_t*>();
|
||||
}
|
||||
|
||||
bool ParseBytes(std::string_view text, std::vector<uint8_t>* bytes) {
|
||||
bool ParseBytes(const std::string& text, std::vector<uint8_t>* bytes) {
|
||||
if (text.empty() || (text.size() % 2) != 0) {
|
||||
return false;
|
||||
}
|
||||
|
||||
bytes->resize(text.size() / 2);
|
||||
for (size_t index = 0; index < bytes->size(); index++) {
|
||||
unsigned int value = 0;
|
||||
const char* begin = text.data() + index * 2;
|
||||
const auto [end, error] = std::from_chars(begin, begin + 2, value, 16);
|
||||
if (error != std::errc {} || end != begin + 2) {
|
||||
return false;
|
||||
}
|
||||
(*bytes)[index] = static_cast<uint8_t>(value);
|
||||
(*bytes)[index] = static_cast<uint8_t>(std::stoul(text.substr(index * 2, 2), nullptr, 16));
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool ReadJson(const std::filesystem::path& path, Json* root, std::string* error) {
|
||||
bool LoadPlan(const std::filesystem::path& path, Plan* plan, std::string* error) {
|
||||
std::ifstream file(path, std::ios::binary);
|
||||
if (!file) {
|
||||
return Fail(error, "could not read patch plan");
|
||||
return Fail(error, "could not read cheat file");
|
||||
}
|
||||
|
||||
*root = Json::parse(file, nullptr, false);
|
||||
return root->is_object() || Fail(error, "patch plan is not valid JSON");
|
||||
}
|
||||
|
||||
bool LoadPlan(const std::filesystem::path& path, Plan* plan, std::string* error) {
|
||||
Json root;
|
||||
if (!ReadJson(path, &root, error)) {
|
||||
return false;
|
||||
const auto root = Json::parse(file, nullptr, false);
|
||||
if (!root.is_object() || !root.contains("id") || !root.contains("version") ||
|
||||
!root.contains("process") || !root.contains("mods")) {
|
||||
return Fail(error, "expected a GoldHEN-style mods JSON file");
|
||||
}
|
||||
plan->title_id = root["id"].get<std::string>();
|
||||
plan->version = root["version"].get<std::string>();
|
||||
plan->process = root["process"].get<std::string>();
|
||||
|
||||
const auto* title_id = StringField(root, "title_id");
|
||||
const auto* game_version = StringField(root, "game_version");
|
||||
const auto* process = StringField(root, "process");
|
||||
const auto* patches = ArrayField(root, "patches");
|
||||
if (title_id == nullptr || game_version == nullptr || process == nullptr ||
|
||||
patches == nullptr) {
|
||||
return Fail(error, "invalid patch plan");
|
||||
}
|
||||
|
||||
plan->title_id = *title_id;
|
||||
plan->game_version = *game_version;
|
||||
plan->process = *process;
|
||||
|
||||
for (const auto& patch_json: *patches) {
|
||||
const auto enabled = patch_json.find("enabled");
|
||||
if (enabled != patch_json.end() && enabled->is_boolean() && !enabled->get<bool>()) {
|
||||
for (const auto& mod: root["mods"]) {
|
||||
if (!mod.value("enabled", true)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const auto* name = StringField(patch_json, "name");
|
||||
const auto* writes = ArrayField(patch_json, "writes");
|
||||
if (name == nullptr || writes == nullptr) {
|
||||
return Fail(error, "invalid patch entry");
|
||||
}
|
||||
|
||||
plan->patch_names.push_back(*name);
|
||||
for (const auto& write_json: *writes) {
|
||||
const auto* expected = StringField(write_json, "expected");
|
||||
const auto* replacement = StringField(write_json, "replacement");
|
||||
if (expected == nullptr || replacement == nullptr) {
|
||||
return Fail(error, "invalid patch write");
|
||||
const auto name = mod["name"].get<std::string>();
|
||||
plan->mod_names.push_back(name);
|
||||
for (const auto& entry: mod["memory"]) {
|
||||
Write write;
|
||||
write.source_address = std::stoull(entry["offset"].get<std::string>(), nullptr, 16);
|
||||
if (!ParseBytes(entry["off"].get<std::string>(), &write.off) ||
|
||||
!ParseBytes(entry["on"].get<std::string>(), &write.on) ||
|
||||
write.off.size() != write.on.size()) {
|
||||
return Fail(error, "invalid mod memory bytes");
|
||||
}
|
||||
|
||||
Write write {
|
||||
.patch_name = *name,
|
||||
};
|
||||
if (!ParseBytes(*expected, &write.expected) ||
|
||||
!ParseBytes(*replacement, &write.replacement) ||
|
||||
write.expected.size() != write.replacement.size()) {
|
||||
return Fail(error, "invalid patch bytes");
|
||||
}
|
||||
|
||||
plan->writes.push_back(std::move(write));
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool ValidateTarget(const Plan& plan, const Program* program, std::string* error) {
|
||||
if (program == nullptr || program->elf == nullptr || program->base_vaddr == 0) {
|
||||
bool ValidateGame(const Plan& plan, const Program* main_program, std::string* error) {
|
||||
if (main_program == nullptr || main_program->base_vaddr == 0) {
|
||||
return Fail(error, "main executable is not loaded");
|
||||
}
|
||||
|
||||
std::string title_id;
|
||||
std::string game_version;
|
||||
std::string version;
|
||||
if (!SystemContentParamSfoGetString("TITLE_ID", &title_id) ||
|
||||
!SystemContentParamSfoGetString("APP_VER", &game_version)) {
|
||||
return Fail(error, "game metadata is incomplete");
|
||||
}
|
||||
if (!Common::EqualNoCase(program->file_name.filename().string(), plan.process) ||
|
||||
!Common::EqualNoCase(title_id, plan.title_id) || game_version != plan.game_version) {
|
||||
return Fail(error, "patch plan does not match the loaded game");
|
||||
!SystemContentParamSfoGetString("APP_VER", &version) ||
|
||||
!Common::EqualNoCase(main_program->file_name.filename().string(), plan.process) ||
|
||||
!Common::EqualNoCase(title_id, plan.title_id) || version != plan.version) {
|
||||
return Fail(error, "cheat file does not match the loaded game");
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool ResolveWrite(const Program& program, Write* write, std::string* error) {
|
||||
const auto* ehdr = program.elf->GetEhdr();
|
||||
const auto* phdr = program.elf->GetPhdr();
|
||||
|
||||
uint64_t match = 0;
|
||||
size_t match_count = 0;
|
||||
for (Elf64_Half index = 0; index < ehdr->e_phnum; index++) {
|
||||
const auto& segment = phdr[index];
|
||||
const bool loaded = segment.p_type == PT_LOAD || segment.p_type == PT_OS_RELRO;
|
||||
if (!loaded || segment.p_filesz < write->expected.size()) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const auto segment_address = program.base_vaddr + segment.p_vaddr;
|
||||
const auto* begin = reinterpret_cast<const uint8_t*>(segment_address);
|
||||
const auto* end = begin + segment.p_filesz;
|
||||
for (auto* current = begin; current < end;) {
|
||||
const auto* found =
|
||||
std::search(current, end, write->expected.begin(), write->expected.end());
|
||||
if (found == end) {
|
||||
break;
|
||||
}
|
||||
|
||||
const auto address = reinterpret_cast<uint64_t>(found);
|
||||
if (match == 0) {
|
||||
match = address;
|
||||
}
|
||||
match_count++;
|
||||
current = found + 1;
|
||||
}
|
||||
void Translate(const Program& program, uint64_t source_base, uint64_t source_address,
|
||||
uint64_t* target_address) {
|
||||
if (source_address >= source_base) {
|
||||
*target_address = program.base_vaddr + source_address - source_base;
|
||||
return;
|
||||
}
|
||||
|
||||
::printf("Game patch: found %zu entries for '%s'\n", match_count, write->patch_name.c_str());
|
||||
if (match == 0) {
|
||||
return Fail(error, "original bytes not found for '" + write->patch_name + "'");
|
||||
}
|
||||
write->address = match;
|
||||
return true;
|
||||
*target_address = program.base_vaddr - (source_base - source_address);
|
||||
}
|
||||
|
||||
bool PrepareWrites(Plan* plan, const Program& program, std::string* error) {
|
||||
bool IsInsideProgram(const Program& program, uint64_t address, size_t size) {
|
||||
return size != 0 && address >= program.base_vaddr &&
|
||||
address + size <= program.base_vaddr + program.mapped_size;
|
||||
}
|
||||
|
||||
bool IsZero(const std::vector<uint8_t>& bytes) {
|
||||
return std::all_of(bytes.begin(), bytes.end(), [](uint8_t byte) { return byte == 0; });
|
||||
}
|
||||
|
||||
bool TranslateAndValidate(Plan* plan, const Program& program, uint64_t source_base) {
|
||||
for (auto& write: plan->writes) {
|
||||
if (!ResolveWrite(program, &write, error)) {
|
||||
Translate(program, source_base, write.source_address, &write.target_address);
|
||||
if (!IsZero(write.off) &&
|
||||
(!IsInsideProgram(program, write.target_address, write.off.size()) ||
|
||||
std::memcmp(reinterpret_cast<const void*>(write.target_address), write.off.data(),
|
||||
write.off.size()) != 0)) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool ApplyWrites(Plan* plan, std::string* error) {
|
||||
for (auto& write: plan->writes) {
|
||||
const auto size = write.replacement.size();
|
||||
std::memcpy(reinterpret_cast<void*>(write.address), write.replacement.data(), size);
|
||||
if (!Common::VirtualMemory::FlushInstructionCache(write.address, size)) {
|
||||
return Fail(error, "could not finalize patch");
|
||||
bool Matches(Plan* plan, const Program& program, uint64_t* source_base) {
|
||||
const auto anchor = std::find_if(plan->writes.begin(), plan->writes.end(),
|
||||
[](const Write& write) { return !IsZero(write.off); });
|
||||
if (anchor == plan->writes.end() || program.mapped_size < anchor->off.size()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const auto* ehdr = program.elf->GetEhdr();
|
||||
const auto* phdr = program.elf->GetPhdr();
|
||||
for (Elf64_Half index = 0; index < ehdr->e_phnum; index++) {
|
||||
const auto& segment = phdr[index];
|
||||
if ((segment.p_type != PT_LOAD && segment.p_type != PT_OS_RELRO) ||
|
||||
segment.p_filesz < anchor->off.size()) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const auto* begin = reinterpret_cast<const uint8_t*>(program.base_vaddr + segment.p_vaddr);
|
||||
const auto* end = begin + segment.p_filesz;
|
||||
for (auto* current = begin; current < end;) {
|
||||
const auto* found = std::search(current, end, anchor->off.begin(), anchor->off.end());
|
||||
if (found == end) {
|
||||
break;
|
||||
}
|
||||
const auto rva = static_cast<uint64_t>(found - begin) + segment.p_vaddr;
|
||||
if (anchor->source_address >= rva) {
|
||||
*source_base = anchor->source_address - rva;
|
||||
if (TranslateAndValidate(plan, program, *source_base)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
current = found + 1;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
void ReleaseCaves(std::vector<uint64_t>* cave_pages) {
|
||||
for (auto page = cave_pages->rbegin(); page != cave_pages->rend(); ++page) {
|
||||
EXIT_IF(!Libs::LibKernel::Memory::FreeGuestMemory(*page, kPageSize));
|
||||
}
|
||||
cave_pages->clear();
|
||||
}
|
||||
|
||||
bool AllocateCave(Plan* plan, const Program& program, std::string* error) {
|
||||
std::vector<uint64_t> pages;
|
||||
for (const auto& write: plan->writes) {
|
||||
if (IsInsideProgram(program, write.target_address, write.off.size())) {
|
||||
continue;
|
||||
}
|
||||
if (!IsZero(write.off)) {
|
||||
return Fail(error, "non-zero write is outside the matched module");
|
||||
}
|
||||
|
||||
const auto write_end = write.target_address + write.off.size();
|
||||
for (auto page = write.target_address & ~(kPageSize - 1); page < write_end;
|
||||
page += kPageSize) {
|
||||
if (std::find(pages.begin(), pages.end(), page) == pages.end()) {
|
||||
pages.push_back(page);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for (const auto page: pages) {
|
||||
const auto allocated = Libs::LibKernel::Memory::AllocateRuntimeMemory(
|
||||
page, kPageSize, Common::VirtualMemory::Mode::ExecuteReadWrite, "game_cheat_code_cave",
|
||||
true);
|
||||
if (allocated != page) {
|
||||
if (allocated != 0) {
|
||||
Libs::LibKernel::Memory::FreeGuestMemory(allocated, kPageSize);
|
||||
}
|
||||
ReleaseCaves(&plan->cave_pages);
|
||||
return Fail(error, "could not allocate code-cave page");
|
||||
}
|
||||
plan->cave_pages.push_back(page);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool ApplyWrites(Plan* plan, const Program& program, std::string* error) {
|
||||
if (!AllocateCave(plan, program, error)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
for (int external = 1; external >= 0; external--) {
|
||||
for (const auto& write: plan->writes) {
|
||||
if (static_cast<int>(
|
||||
!IsInsideProgram(program, write.target_address, write.on.size())) != external) {
|
||||
continue;
|
||||
}
|
||||
std::memcpy(reinterpret_cast<void*>(write.target_address), write.on.data(),
|
||||
write.on.size());
|
||||
if (!Common::VirtualMemory::FlushInstructionCache(write.target_address,
|
||||
write.on.size())) {
|
||||
return Fail(error, "could not finalize cheat write");
|
||||
}
|
||||
}
|
||||
}
|
||||
return true;
|
||||
@@ -216,19 +244,63 @@ bool ApplyWrites(Plan* plan, std::string* error) {
|
||||
|
||||
} // namespace
|
||||
|
||||
bool Apply(const std::filesystem::path& plan_path, Program* program) {
|
||||
bool Apply(const std::filesystem::path& plan_path, Program* main_program,
|
||||
const std::vector<Program*>& programs) {
|
||||
Plan plan;
|
||||
std::string error;
|
||||
if (LoadPlan(plan_path, &plan, &error) && ValidateTarget(plan, program, &error) &&
|
||||
PrepareWrites(&plan, *program, &error) && ApplyWrites(&plan, &error)) {
|
||||
for (const auto& name: plan.patch_names) {
|
||||
::printf("Successfully applied patch: %s\n", name.c_str());
|
||||
}
|
||||
if (!LoadPlan(plan_path, &plan, &error) || !ValidateGame(plan, main_program, &error)) {
|
||||
::printf("Game cheat error: %s\n", error.c_str());
|
||||
return false;
|
||||
}
|
||||
if (plan.writes.empty()) {
|
||||
return true;
|
||||
}
|
||||
|
||||
::printf("Game patch error: %s\n", error.c_str());
|
||||
return false;
|
||||
g_pending_plan = std::make_unique<Plan>(std::move(plan));
|
||||
for (auto* program: programs) {
|
||||
if (!ApplyPending(program)) {
|
||||
return false;
|
||||
}
|
||||
if (g_pending_plan == nullptr) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
::printf("Game cheat: waiting for the matching module\n");
|
||||
return true;
|
||||
}
|
||||
|
||||
bool ApplyPending(Program* program) {
|
||||
uint64_t source_base = 0;
|
||||
if (g_pending_plan == nullptr || program == nullptr || program->elf == nullptr ||
|
||||
!Matches(g_pending_plan.get(), *program, &source_base)) {
|
||||
return true;
|
||||
}
|
||||
::printf("Game cheat: matched %s with source base 0x%llx\n",
|
||||
program->file_name.filename().string().c_str(),
|
||||
static_cast<unsigned long long>(source_base));
|
||||
|
||||
std::string error;
|
||||
if (!ApplyWrites(g_pending_plan.get(), *program, &error)) {
|
||||
ReleaseCaves(&g_pending_plan->cave_pages);
|
||||
g_pending_plan.reset();
|
||||
::printf("Game cheat error: %s\n", error.c_str());
|
||||
return false;
|
||||
}
|
||||
|
||||
for (const auto& name: g_pending_plan->mod_names) {
|
||||
::printf("Successfully applied cheat: %s\n", name.c_str());
|
||||
}
|
||||
g_applied_cave_pages = std::move(g_pending_plan->cave_pages);
|
||||
g_pending_plan.reset();
|
||||
return true;
|
||||
}
|
||||
|
||||
void Clear() {
|
||||
if (g_pending_plan != nullptr) {
|
||||
ReleaseCaves(&g_pending_plan->cave_pages);
|
||||
}
|
||||
g_pending_plan.reset();
|
||||
ReleaseCaves(&g_applied_cave_pages);
|
||||
}
|
||||
|
||||
} // namespace Loader::GamePatch
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
#include "common/common.h"
|
||||
|
||||
#include <filesystem>
|
||||
#include <vector>
|
||||
|
||||
namespace Loader {
|
||||
|
||||
@@ -11,7 +12,10 @@ struct Program;
|
||||
|
||||
namespace GamePatch {
|
||||
|
||||
bool Apply(const std::filesystem::path& plan_path, Program* program);
|
||||
bool Apply(const std::filesystem::path& plan_path, Program* main_program,
|
||||
const std::vector<Program*>& programs);
|
||||
bool ApplyPending(Program* program);
|
||||
void Clear();
|
||||
|
||||
} // namespace GamePatch
|
||||
|
||||
|
||||
@@ -1289,6 +1289,9 @@ void RuntimeLinker::RelocateProgram(Program* program) {
|
||||
EXIT_IF(std::find(m_programs.begin(), m_programs.end(), program) == m_programs.end());
|
||||
|
||||
Relocate(program);
|
||||
if (!GamePatch::ApplyPending(program)) {
|
||||
EXIT("Failed to apply pending game cheat\n");
|
||||
}
|
||||
}
|
||||
|
||||
void RuntimeLinker::UnloadProgram(Program* program) {
|
||||
@@ -1412,7 +1415,10 @@ void RuntimeLinker::Execute(const std::filesystem::path& game_patch) {
|
||||
RelocateAll();
|
||||
|
||||
if (!game_patch.empty()) {
|
||||
GamePatch::Apply(game_patch, m_programs.empty() ? nullptr : m_programs.front());
|
||||
if (!GamePatch::Apply(game_patch, m_programs.empty() ? nullptr : m_programs.front(),
|
||||
m_programs)) {
|
||||
EXIT("Failed to apply game cheat\n");
|
||||
}
|
||||
}
|
||||
StartAllModules();
|
||||
|
||||
@@ -1436,6 +1442,7 @@ void RuntimeLinker::Clear() {
|
||||
// EXIT_NOT_IMPLEMENTED(!Common::Thread::IsMainThread());
|
||||
|
||||
Common::LockGuard lock(m_mutex);
|
||||
GamePatch::Clear();
|
||||
|
||||
for (auto* p: m_programs) {
|
||||
DeleteProgram(p);
|
||||
|
||||
Reference in New Issue
Block a user