Files
AnyPS5/core/relinker/cli/src/CliArgs.cpp
T
Ishmam Ahmed 78634fb0a9 feat(relinker): support --trace-imports for Linux output
The Linux entry stub now passes each traced import through libc.prx's
TraceImport_nid_no_patch before it calls the guest entry, and stores the
returned thunk in the import's slot. The same imports are traced as on
Windows: functions bound through a PLT slot or a GOT slot, without an
addend, and not weak. TraceImport_nid_no_patch is bound eagerly through
an added GLOB_DAT relocation, so a libc.prx without it fails at load.
Each slot's page is made writable with mprotect first, so slots inside a
PT_GNU_RELRO range can be replaced.

--trace-imports now requires libc.prx among the libraries on Linux too,
and is refused with --macos.
2026-10-19 22:56:03 +01:00

221 lines
12 KiB
C++

#include <Cli.hpp>
#include <io/NativePath.hpp>
#include <charconv>
#include <filesystem>
#include <iostream>
#include <stdexcept>
#include <string>
#include <algorithm>
#include <iterator>
#include <string_view>
#include <system_error>
namespace Cli {
const char* Usage() {
return "Usage: relinker [--help] [--windows | --macos] [--windows-diagnostics] [--windows-gui] [--trace-imports] [--windows-fixed-base <address>] [--linux-fixed-base <address>] [--macos-fixed-base <address>] [--skip-syscall-check | --trap-sdk-syscall-stubs] [--skip-sce-module | --sce-module-path <path>] [--exclude-sce-module <file>]... [--module-dir <dir>]... [--executable <path>]... [--to-intel] [--to-rosetta] [unused-filter=0|1|2] [--registry] [--rpath <path>] [--lazy-binding] [--autorun] [--patches <file> | --no-patches] <input.elf> <output.elf>\n"
" relinker --verify-patches <file> [--verify-output] [--skip-sce-module | --sce-module-path <path>] [--exclude-sce-module <file>]... [--module-dir <dir>]... [--executable <path>]... <path>\n"
"Example: relinker input.elf output.elf";
}
namespace {
constexpr std::string_view kVerifyRejectedOptions[] = {
"--windows", "--macos", "--windows-gui", "--windows-diagnostics", "--windows-fixed-base", "--trace-imports", "--linux-fixed-base", "--macos-fixed-base",
"--to-intel", "--to-rosetta", "--skip-syscall-check", "--trap-sdk-syscall-stubs", "unused-filter=",
"--rpath", "--registry", "--lazy-binding", "--autorun", "--patches", "--no-patches",
};
constexpr std::string_view kModuleDiscoveryOptions[] = {"--sce-module-path", "--module-dir", "--exclude-sce-module", "--skip-sce-module"};
template<std::size_t Count>
bool IsOneOf(const std::string& option, const std::string_view (&names)[Count]) {
return std::find(std::begin(names), std::end(names), option) != std::end(names);
}
}
static std::uint64_t ParseFixedBase(std::string_view value, const std::uint64_t lowest, const char* error) {
constexpr std::uint64_t highest = 0x7fffffff0000;
constexpr std::uint64_t alignment = 0x10000;
const bool hexadecimal = value.starts_with("0x") || value.starts_with("0X");
if (hexadecimal) value.remove_prefix(2);
std::uint64_t address = 0;
const auto parsed = std::from_chars(value.data(), value.data() + value.size(), address, hexadecimal ? 16 : 10);
if (value.empty() || parsed.ec != std::errc{} || parsed.ptr != value.data() + value.size() || address < lowest || address > highest || address % alignment != 0)
throw std::runtime_error(error);
return address;
}
Args ParseArgs(int argc, char* argv[]) {
Args args;
bool unusedFilterSpecified = false;
bool sceModulePathSpecified = false;
std::vector<std::string> givenOptions;
for (int i = 1; i < argc; ++i) {
const std::string arg = argv[i];
if (arg.rfind("--", 0) == 0) givenOptions.push_back(arg);
else if (arg.rfind("unused-filter=", 0) == 0) givenOptions.push_back("unused-filter=");
if (arg == "--help") {
args.showHelp = true;
} else if (arg == "--windows-fixed-base") {
if (args.windowsFixedBase) throw std::runtime_error("--windows-fixed-base cannot be repeated");
if (i + 1 >= argc || std::string(argv[i + 1]).empty() || std::string(argv[i + 1]).starts_with("--"))
throw std::runtime_error("--windows-fixed-base requires an address");
std::string_view value(argv[++i]);
const bool hexadecimal = value.starts_with("0x") || value.starts_with("0X");
if (hexadecimal) value.remove_prefix(2);
std::uint64_t address = 0;
const auto parsed = std::from_chars(value.data(), value.data() + value.size(), address, hexadecimal ? 16 : 10);
if (parsed.ec != std::errc{} || parsed.ptr != value.data() + value.size() || address < 0x20000 || address > 0x7fffffff0000 || (address & 0xffff) != 0)
throw std::runtime_error("--windows-fixed-base requires a 64 KiB-aligned address from 0x20000 through 0x7fffffff0000");
args.windowsFixedBase = address;
} else if (arg == "--linux-fixed-base") {
if (args.linuxFixedBase) throw std::runtime_error("--linux-fixed-base cannot be repeated");
if (i + 1 >= argc || std::string_view(argv[i + 1]).empty() || std::string_view(argv[i + 1]).starts_with("--"))
throw std::runtime_error("--linux-fixed-base requires an address");
args.linuxFixedBase = ParseFixedBase(argv[++i], 0x10000, "--linux-fixed-base requires a 64 KiB-aligned address from 0x10000 through 0x7fffffff0000");
} else if (arg == "--macos-fixed-base") {
if (args.macosFixedBase) throw std::runtime_error("--macos-fixed-base cannot be repeated");
if (i + 1 >= argc || std::string_view(argv[i + 1]).empty() || std::string_view(argv[i + 1]).starts_with("--"))
throw std::runtime_error("--macos-fixed-base requires an address");
args.macosFixedBase = ParseFixedBase(argv[++i], 0x20000, "--macos-fixed-base requires a 64 KiB-aligned address from 0x20000 through 0x7fffffff0000");
} else if (arg == "--skip-syscall-check") {
args.skipSyscallCheck = true;
} else if (arg == "--trap-sdk-syscall-stubs") {
args.trapSdkSyscallStubs = true;
} else if (arg == "--skip-sce-module") {
args.skipSceModule = true;
} else if (arg == "--sce-module-path") {
if (sceModulePathSpecified) throw std::runtime_error("--sce-module-path must be specified once");
if (i + 1 >= argc || std::string(argv[i + 1]).empty() || std::string(argv[i + 1]).starts_with("--")) throw std::runtime_error("--sce-module-path requires a nonempty path");
args.sceModulePath = argv[++i];
sceModulePathSpecified = true;
} else if (arg == "--exclude-sce-module") {
if (i + 1 >= argc)
throw std::runtime_error("--exclude-sce-module requires a file name");
args.excludedSceModules.insert(argv[++i]);
} else if (arg == "--module-dir") {
if (i + 1 >= argc)
throw std::runtime_error("--module-dir requires a directory");
args.moduleDirectories.push_back(argv[++i]);
} else if (arg == "--executable") {
if (i + 1 >= argc || std::string(argv[i + 1]).empty() || std::string(argv[i + 1]).starts_with("--")) throw std::runtime_error("--executable requires a nonempty path");
args.executables.push_back(argv[++i]);
} else if (arg == "--to-intel") {
args.toIntel = true;
} else if (arg == "--to-rosetta") {
args.toRosetta = true;
args.toIntel = true;
} else if (arg.rfind("unused-filter=", 0) == 0) {
const std::string value = arg.substr(14);
if (unusedFilterSpecified || value.size() != 1 || value[0] < '0' || value[0] > '2')
throw std::runtime_error("unused-filter must be specified once with a value of 0, 1 or 2");
args.unusedFilterLevel = static_cast<std::uint32_t>(value[0] - '0');
unusedFilterSpecified = true;
} else if (arg == "--patches") {
if (!args.patchesPath.empty()) throw std::runtime_error("--patches cannot be repeated");
if (i + 1 >= argc || std::string(argv[i + 1]).empty() || std::string(argv[i + 1]).starts_with("--")) throw std::runtime_error("--patches requires a file");
args.patchesPath = argv[++i];
} else if (arg == "--no-patches") {
args.noPatches = true;
} else if (arg == "--verify-patches") {
if (!args.verifyPatchesPath.empty()) throw std::runtime_error("--verify-patches cannot be repeated");
if (i + 1 >= argc || std::string(argv[i + 1]).empty() || std::string(argv[i + 1]).starts_with("--")) throw std::runtime_error("--verify-patches requires a file");
args.verifyPatchesPath = argv[++i];
} else if (arg == "--verify-output") {
args.verifyOutput = true;
} else if (arg == "--registry") {
args.writeRegistry = true;
} else if (arg == "--rpath") {
if (i + 1 >= argc)
throw std::runtime_error("--rpath requires a value");
args.runPath = argv[++i];
} else if (arg == "--windows") {
args.toWindows = true;
} else if (arg == "--macos") {
args.toMacos = true;
} else if (arg == "--lazy-binding") {
args.lazyBinding = true;
} else if (arg == "--autorun") {
args.autorun = true;
} else if (arg == "--windows-diagnostics") {
args.windowsDiagnostics = true;
} else if (arg == "--windows-gui") {
args.windowsGui = true;
} else if (arg == "--trace-imports") {
args.traceImports = true;
} else if (arg.rfind("--", 0) == 0 || arg == "unused-filter") {
throw std::runtime_error("unknown option: " + arg);
} else if (arg.empty()) {
throw std::runtime_error("input and output paths must be nonempty");
} else if (args.inputPath.empty()) {
args.inputPath = arg;
} else if (args.outputPath.empty()) {
args.outputPath = arg;
} else {
throw std::runtime_error("unexpected argument: " + arg);
}
}
const bool verifying = !args.verifyPatchesPath.empty();
if (args.verifyOutput && !verifying) throw std::runtime_error("--verify-output requires --verify-patches");
if (!args.patchesPath.empty() && args.noPatches) throw std::runtime_error("--patches conflicts with --no-patches");
if (verifying) {
for (const auto& option : givenOptions) {
if (IsOneOf(option, kVerifyRejectedOptions))
throw std::runtime_error(option + " cannot be used with --verify-patches");
if (args.verifyOutput && IsOneOf(option, kModuleDiscoveryOptions))
throw std::runtime_error("module discovery options have no effect with --verify-output");
}
if (!args.outputPath.empty()) throw std::runtime_error("unexpected argument: " + args.outputPath);
}
if (args.skipSceModule && sceModulePathSpecified) throw std::runtime_error("--sce-module-path conflicts with --skip-sce-module");
if (args.skipSyscallCheck && args.trapSdkSyscallStubs) throw std::runtime_error("--skip-syscall-check conflicts with --trap-sdk-syscall-stubs");
if (args.skipSceModule && !args.excludedSceModules.empty())
throw std::runtime_error("--exclude-sce-module conflicts with --skip-sce-module");
if (args.skipSceModule && !args.moduleDirectories.empty())
throw std::runtime_error("--module-dir conflicts with --skip-sce-module");
if (args.skipSceModule && !args.executables.empty())
throw std::runtime_error("--executable conflicts with --skip-sce-module");
if (args.toWindows && args.toMacos)
throw std::runtime_error("--windows conflicts with --macos");
if (args.toRosetta && args.toWindows)
throw std::runtime_error("--to-rosetta conflicts with --windows");
if (args.windowsDiagnostics && !args.toWindows)
throw std::runtime_error("--windows-diagnostics requires --windows");
if (args.windowsGui && !args.toWindows)
throw std::runtime_error("--windows-gui requires --windows");
if (args.windowsFixedBase && !args.toWindows)
throw std::runtime_error("--windows-fixed-base requires --windows");
if (args.traceImports && args.toMacos)
throw std::runtime_error("--trace-imports cannot be used with --macos");
if (args.traceImports && args.lazyBinding)
throw std::runtime_error("--trace-imports conflicts with --lazy-binding");
if (args.linuxFixedBase && (args.toWindows || args.toMacos))
throw std::runtime_error("--linux-fixed-base cannot be used with --windows or --macos");
if (args.linuxFixedBase && args.lazyBinding)
throw std::runtime_error("--linux-fixed-base conflicts with --lazy-binding");
if (args.macosFixedBase && !args.toMacos)
throw std::runtime_error("--macos-fixed-base requires --macos");
if (!args.showHelp && (args.inputPath.empty() || (!verifying && args.outputPath.empty())))
throw std::runtime_error(Usage());
if (!sceModulePathSpecified && !args.skipSceModule && !args.inputPath.empty() && !args.verifyOutput) args.sceModulePath = Io::Utf8Path(std::filesystem::absolute(Io::NativePath(args.inputPath)).parent_path());
return args;
}
}