mirror of
https://github.com/open-goal/jak-project.git
synced 2024-10-20 11:26:18 -04:00
2b6684aa5c
* clean up * before int to float stuff * before trying to eliminate the separate read and write maps * partial fix for register issues * add missing include
553 lines
18 KiB
C++
553 lines
18 KiB
C++
#include <stdexcept>
|
|
#include <unordered_set>
|
|
#include <algorithm>
|
|
#include <decompiler/util/DecompilerTypeSystem.h>
|
|
#include "Env.h"
|
|
#include "Form.h"
|
|
#include "decompiler/analysis/atomic_op_builder.h"
|
|
#include "common/goos/PrettyPrinter.h"
|
|
#include "common/util/math_util.h"
|
|
|
|
namespace decompiler {
|
|
void Env::set_remap_for_function(const TypeSpec& ts) {
|
|
int nargs = ts.arg_count() - 1;
|
|
for (int i = 0; i < nargs; i++) {
|
|
std::string var_name;
|
|
var_name.push_back(i >= 4 ? 't' : 'a');
|
|
var_name.push_back('0' + (i % 4));
|
|
var_name.push_back('-');
|
|
var_name.push_back('0');
|
|
m_var_remap[var_name] = ("arg" + std::to_string(i));
|
|
}
|
|
if (ts.try_get_tag("behavior")) {
|
|
m_var_remap["s6-0"] = "self";
|
|
m_pp_mapped_by_behavior = true;
|
|
} else {
|
|
m_var_remap["s6-0"] = "pp";
|
|
}
|
|
}
|
|
|
|
void Env::set_remap_for_new_method(const TypeSpec& ts) {
|
|
int nargs = ts.arg_count() - 1;
|
|
m_var_remap["a0-0"] = "allocation";
|
|
m_var_remap["a1-0"] = "type-to-make";
|
|
for (int i = 2; i < nargs; i++) {
|
|
std::string var_name;
|
|
var_name.push_back(i >= 4 ? 't' : 'a');
|
|
var_name.push_back('0' + (i % 4));
|
|
var_name.push_back('-');
|
|
var_name.push_back('0');
|
|
m_var_remap[var_name] = ("arg" + std::to_string(i - 2));
|
|
}
|
|
if (ts.try_get_tag("behavior")) {
|
|
m_var_remap["s6-0"] = "self";
|
|
m_pp_mapped_by_behavior = true;
|
|
} else {
|
|
m_var_remap["s6-0"] = "pp";
|
|
}
|
|
}
|
|
|
|
void Env::set_remap_for_method(const TypeSpec& ts) {
|
|
int nargs = ts.arg_count() - 1;
|
|
m_var_remap["a0-0"] = "obj";
|
|
for (int i = 1; i < nargs; i++) {
|
|
std::string var_name;
|
|
var_name.push_back(i >= 4 ? 't' : 'a');
|
|
var_name.push_back('0' + (i % 4));
|
|
var_name.push_back('-');
|
|
var_name.push_back('0');
|
|
m_var_remap[var_name] = ("arg" + std::to_string(i - 1));
|
|
}
|
|
if (ts.try_get_tag("behavior")) {
|
|
m_var_remap["s6-0"] = "self";
|
|
m_pp_mapped_by_behavior = true;
|
|
} else {
|
|
m_var_remap["s6-0"] = "pp";
|
|
}
|
|
}
|
|
|
|
void Env::map_args_from_config(const std::vector<std::string>& args_names,
|
|
const std::unordered_map<std::string, std::string>& var_names) {
|
|
for (size_t i = 0; i < args_names.size(); i++) {
|
|
std::string var_name;
|
|
var_name.push_back(i >= 4 ? 't' : 'a');
|
|
var_name.push_back('0' + (i % 4));
|
|
var_name.push_back('-');
|
|
var_name.push_back('0');
|
|
m_var_remap[var_name] = args_names[i];
|
|
}
|
|
|
|
for (auto& x : var_names) {
|
|
m_var_remap[x.first] = x.second;
|
|
}
|
|
}
|
|
|
|
void Env::map_args_from_config(
|
|
const std::vector<std::string>& args_names,
|
|
const std::unordered_map<std::string, LocalVarOverride>& var_overrides) {
|
|
for (size_t i = 0; i < args_names.size(); i++) {
|
|
std::string var_name;
|
|
var_name.push_back(i >= 4 ? 't' : 'a');
|
|
var_name.push_back('0' + (i % 4));
|
|
var_name.push_back('-');
|
|
var_name.push_back('0');
|
|
m_var_remap[var_name] = args_names[i];
|
|
}
|
|
|
|
for (auto& x : var_overrides) {
|
|
m_var_remap[x.first] = x.second.name;
|
|
}
|
|
}
|
|
|
|
const std::string& Env::remapped_name(const std::string& name) const {
|
|
auto kv = m_var_remap.find(name);
|
|
if (kv != m_var_remap.end()) {
|
|
return kv->second;
|
|
} else {
|
|
return name;
|
|
}
|
|
}
|
|
|
|
goos::Object Env::get_variable_name_with_cast(const RegisterAccess& access) const {
|
|
auto result = get_variable_and_cast(access);
|
|
if (result.cast) {
|
|
return pretty_print::build_list("the-as", result.cast->print(), result.name);
|
|
} else {
|
|
return pretty_print::to_symbol(result.name);
|
|
}
|
|
}
|
|
|
|
std::string Env::get_variable_name(const RegisterAccess& access) const {
|
|
return get_variable_and_cast(access).name;
|
|
}
|
|
|
|
VariableWithCast Env::get_variable_and_cast(const RegisterAccess& access) const {
|
|
if (access.reg().get_kind() == Reg::FPR || access.reg().get_kind() == Reg::GPR) {
|
|
auto& var_info = m_var_names.lookup(access.reg(), access.idx(), access.mode());
|
|
// this is a bit of a confusing process. The first step is to grab the auto-generated name:
|
|
std::string original_name = var_info.name();
|
|
auto lookup_name = original_name;
|
|
|
|
// and then see if there's a user remapping of it
|
|
auto remapped = m_var_remap.find(original_name);
|
|
if (remapped != m_var_remap.end()) {
|
|
lookup_name = remapped->second;
|
|
}
|
|
|
|
if (types_succeeded) {
|
|
// get the type of the variable. This is the type of thing if we do no casts.
|
|
// first, get the type the decompiler found
|
|
auto type_of_var = var_info.type.typespec();
|
|
// and the user's type.
|
|
auto retype_kv = m_var_retype.find(original_name);
|
|
if (retype_kv != m_var_retype.end()) {
|
|
type_of_var = retype_kv->second;
|
|
}
|
|
|
|
// next, we insert type casts that make enforce the user override.
|
|
auto type_kv = m_typecasts.find(access.idx());
|
|
if (type_kv != m_typecasts.end()) {
|
|
for (auto& x : type_kv->second) {
|
|
if (x.reg == access.reg()) {
|
|
// let's make sure the above claim is true
|
|
TypeSpec type_in_reg;
|
|
if (has_type_analysis() && access.mode() == AccessMode::READ) {
|
|
type_in_reg = get_types_for_op_mode(access.idx(), AccessMode::READ)
|
|
.get(access.reg())
|
|
.typespec();
|
|
if (type_in_reg.print() != x.type_name) {
|
|
lg::error(
|
|
"Decompiler type consistency error. There was a typecast for reg {} at idx {} "
|
|
"(var {}) to type {}, but the actual type is {} ({})",
|
|
access.reg().to_charp(), access.idx(), lookup_name, x.type_name,
|
|
type_in_reg.print(), type_in_reg.print());
|
|
assert(false);
|
|
}
|
|
}
|
|
|
|
if (type_of_var != type_in_reg) {
|
|
// TODO - use the when possible?
|
|
VariableWithCast result;
|
|
result.cast = TypeSpec(x.type_name);
|
|
result.name = lookup_name;
|
|
return result;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// type analysis stuff runs before variable types, so we insert casts that account
|
|
// for the changing types due to the lca(uses) that is used to generate variable types.
|
|
auto type_of_reg =
|
|
get_types_for_op_mode(access.idx(), access.mode()).get(access.reg()).typespec();
|
|
if (access.mode() == AccessMode::READ) {
|
|
// note - this may be stricter than needed. but that's ok.
|
|
|
|
if (type_of_var != type_of_reg) {
|
|
// fmt::print("casting {} (reg {}, idx {}): reg type {} var type {} remapped var
|
|
// type
|
|
// {}\n ",
|
|
// lookup_name, reg.to_charp(), atomic_idx, type_of_reg.print(),
|
|
// var_info.type.typespec().print(), type_of_var.print());
|
|
VariableWithCast result;
|
|
result.cast = type_of_reg;
|
|
result.name = lookup_name;
|
|
return result;
|
|
}
|
|
} else {
|
|
// if we're setting a variable, we are a little less strict.
|
|
// let's leave this to set!'s for now. This is tricky with stuff like (if y x) where the
|
|
// move is eliminated so the RegisterAccess points to the "wrong" place.
|
|
// if (!dts->ts.tc(type_of_var, type_of_reg)) {
|
|
// fmt::print("op {} reg {} type {}\n", atomic_idx, reg.to_charp(),
|
|
// get_types_for_op_mode(atomic_idx, mode).get(reg).print()); return
|
|
// pretty_print::build_list("the-as", type_of_reg.print(), lookup_name);
|
|
// }
|
|
}
|
|
}
|
|
|
|
VariableWithCast result;
|
|
result.name = lookup_name;
|
|
return result;
|
|
|
|
} else {
|
|
VariableWithCast result;
|
|
result.name = access.reg().to_charp();
|
|
return result;
|
|
}
|
|
}
|
|
|
|
goos::Object Env::get_variable_name_with_cast(Register reg, int atomic_idx, AccessMode mode) const {
|
|
return get_variable_name_with_cast(RegisterAccess(mode, reg, atomic_idx, true));
|
|
}
|
|
|
|
std::optional<TypeSpec> Env::get_user_cast_for_access(const RegisterAccess& access) const {
|
|
if (access.reg().get_kind() == Reg::FPR || access.reg().get_kind() == Reg::GPR) {
|
|
auto& var_info = m_var_names.lookup(access.reg(), access.idx(), access.mode());
|
|
std::string original_name = var_info.name();
|
|
|
|
auto type_kv = m_typecasts.find(access.idx());
|
|
if (type_kv != m_typecasts.end()) {
|
|
for (auto& x : type_kv->second) {
|
|
if (x.reg == access.reg()) {
|
|
// let's make sure the above claim is true
|
|
TypeSpec type_in_reg;
|
|
if (has_type_analysis() && access.mode() == AccessMode::READ) {
|
|
type_in_reg =
|
|
get_types_for_op_mode(access.idx(), AccessMode::READ).get(access.reg()).typespec();
|
|
if (type_in_reg.print() != x.type_name) {
|
|
lg::error(
|
|
"Decompiler type consistency error. There was a typecast for reg {} at idx {} "
|
|
"(var {}) to type {}, but the actual type is {} ({})",
|
|
access.reg().to_charp(), access.idx(), original_name, x.type_name,
|
|
type_in_reg.print(), type_in_reg.print());
|
|
assert(false);
|
|
}
|
|
}
|
|
|
|
auto cast_type = dts->parse_type_spec(x.type_name);
|
|
return cast_type;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return {};
|
|
}
|
|
|
|
/*!
|
|
* Get the type of the variable currently in the register.
|
|
* NOTE: this is _NOT_ the most specific type known to the decompiler, but instead the type
|
|
* of the variable.
|
|
*/
|
|
TypeSpec Env::get_variable_type(const RegisterAccess& access, bool using_user_var_types) const {
|
|
if (access.reg().get_kind() == Reg::FPR || access.reg().get_kind() == Reg::GPR) {
|
|
auto& var_info = m_var_names.lookup(access.reg(), access.idx(), access.mode());
|
|
std::string original_name = var_info.name();
|
|
|
|
auto type_of_var = var_info.type.typespec();
|
|
if (using_user_var_types) {
|
|
auto retype_kv = m_var_retype.find(original_name);
|
|
if (retype_kv != m_var_retype.end()) {
|
|
type_of_var = retype_kv->second;
|
|
}
|
|
}
|
|
|
|
return type_of_var;
|
|
} else {
|
|
throw std::runtime_error("Types are not supported for this kind of register");
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* Update the Env with the result of the type analysis pass.
|
|
*/
|
|
void Env::set_types(const std::vector<TypeState>& block_init_types,
|
|
const std::vector<TypeState>& op_end_types,
|
|
const FunctionAtomicOps& atomic_ops,
|
|
const TypeSpec& my_type) {
|
|
m_block_init_types = block_init_types;
|
|
m_op_end_types = op_end_types;
|
|
|
|
// cache the init types (this ends up being faster)
|
|
m_op_init_types.resize(op_end_types.size(), nullptr);
|
|
for (int block_idx = 0; block_idx < int(m_block_init_types.size()); block_idx++) {
|
|
int first_op = atomic_ops.block_id_to_first_atomic_op.at(block_idx);
|
|
int end_op = atomic_ops.block_id_to_end_atomic_op.at(block_idx);
|
|
if (end_op > first_op) {
|
|
m_op_init_types.at(first_op) = &m_block_init_types.at(block_idx);
|
|
for (int op_idx = first_op; op_idx < (end_op - 1); op_idx++) {
|
|
m_op_init_types.at(op_idx + 1) = &m_op_end_types.at(op_idx);
|
|
}
|
|
}
|
|
}
|
|
|
|
for (auto x : m_op_init_types) {
|
|
assert(x);
|
|
}
|
|
|
|
m_has_types = true;
|
|
|
|
// check the actual return type:
|
|
if (my_type.last_arg() != TypeSpec("none")) {
|
|
auto as_end = dynamic_cast<const FunctionEndOp*>(atomic_ops.ops.back().get());
|
|
if (as_end) {
|
|
m_type_analysis_return_type = get_types_before_op((int)atomic_ops.ops.size() - 1)
|
|
.get(Register(Reg::GPR, Reg::V0))
|
|
.typespec();
|
|
}
|
|
}
|
|
}
|
|
|
|
std::string Env::print_local_var_types(const Form* top_level_form) const {
|
|
assert(has_local_vars());
|
|
auto var_info = extract_visible_variables(top_level_form);
|
|
std::vector<std::string> entries;
|
|
for (auto x : var_info) {
|
|
entries.push_back(fmt::format("{}: {}", x.name(), x.type.typespec().print()));
|
|
}
|
|
|
|
int max_len = 0;
|
|
for (auto& entry : entries) {
|
|
if (int(entry.length()) > max_len) {
|
|
max_len = entry.length();
|
|
}
|
|
}
|
|
|
|
constexpr int row_len = 100;
|
|
// avoid divide by zero on empty env case.
|
|
int per_row = max_len ? std::max(1, row_len / max_len) : 1;
|
|
int entry_len = 100 / per_row;
|
|
|
|
std::string result;
|
|
|
|
for (int entry_id = 0; entry_id < int(entries.size()); entry_id++) {
|
|
if ((entry_id % per_row) == 0) {
|
|
// onto a new line!
|
|
if (entry_id != 0) {
|
|
result += '\n';
|
|
}
|
|
result += ";; ";
|
|
}
|
|
result += ' ';
|
|
result += entries.at(entry_id);
|
|
result += std::string(std::max(0, entry_len - int(entries.at(entry_id).length())), ' ');
|
|
}
|
|
|
|
result += '\n';
|
|
|
|
return result;
|
|
}
|
|
|
|
std::vector<VariableNames::VarInfo> Env::extract_visible_variables(
|
|
const Form* top_level_form) const {
|
|
assert(has_local_vars());
|
|
std::vector<VariableNames::VarInfo> entries;
|
|
if (top_level_form) {
|
|
RegAccessSet var_set;
|
|
top_level_form->collect_vars(var_set, true);
|
|
|
|
// we want to sort them for easier reading:
|
|
std::vector<std::pair<RegId, RegisterAccess>> vars;
|
|
|
|
for (auto& x : var_set) {
|
|
if (x.reg().get_kind() == Reg::FPR || x.reg().get_kind() == Reg::GPR) {
|
|
vars.push_back(std::make_pair(get_program_var_id(x), x));
|
|
}
|
|
}
|
|
|
|
std::sort(vars.begin(), vars.end(),
|
|
[](const std::pair<RegId, RegisterAccess>& a,
|
|
const std::pair<RegId, RegisterAccess>& b) { return a.first < b.first; });
|
|
|
|
RegId* prev = nullptr;
|
|
for (auto& x : vars) {
|
|
// sorted by ssa var and there are likely duplicates of Variables and SSA vars, only print
|
|
// unique ssa variables.
|
|
if (prev && x.first == *prev) {
|
|
continue;
|
|
}
|
|
prev = &x.first;
|
|
auto& map = x.second.mode() == AccessMode::WRITE ? m_var_names.write_vars.at(x.second.reg())
|
|
: m_var_names.read_vars.at(x.second.reg());
|
|
auto& info = map.at(x.first.id);
|
|
|
|
if (info.initialized) {
|
|
entries.push_back(info);
|
|
} else {
|
|
assert(false);
|
|
}
|
|
}
|
|
} else {
|
|
std::unordered_map<Register, std::unordered_set<int>, Register::hash> printed;
|
|
|
|
for (auto& reg_info : m_var_names.read_vars) {
|
|
auto& reg_printed = printed[reg_info.first];
|
|
for (int var_id = 0; var_id < int(reg_info.second.size()); var_id++) {
|
|
auto& info = reg_info.second.at(var_id);
|
|
if (info.initialized) {
|
|
reg_printed.insert(var_id);
|
|
entries.push_back(info);
|
|
}
|
|
}
|
|
}
|
|
|
|
for (auto& reg_info : m_var_names.write_vars) {
|
|
auto& reg_printed = printed[reg_info.first];
|
|
for (int var_id = 0; var_id < int(reg_info.second.size()); var_id++) {
|
|
auto& info = reg_info.second.at(var_id);
|
|
if (info.initialized) {
|
|
if (reg_printed.find(var_id) == reg_printed.end()) {
|
|
entries.push_back(info);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return entries;
|
|
}
|
|
|
|
FunctionVariableDefinitions Env::local_var_type_list(const Form* top_level_form,
|
|
int nargs_to_ignore) const {
|
|
assert(nargs_to_ignore <= 8);
|
|
auto vars = extract_visible_variables(top_level_form);
|
|
|
|
FunctionVariableDefinitions result;
|
|
std::vector<goos::Object> elts;
|
|
elts.push_back(pretty_print::to_symbol("local-vars"));
|
|
int count = 0;
|
|
for (auto& x : vars) {
|
|
if (x.reg_id.reg.get_kind() == Reg::GPR && x.reg_id.reg.get_gpr() < Reg::A0 + nargs_to_ignore &&
|
|
x.reg_id.reg.get_gpr() >= Reg::A0 && x.reg_id.id == 0) {
|
|
continue;
|
|
}
|
|
|
|
if (x.reg_id.reg == Register(Reg::GPR, Reg::S6)) {
|
|
result.had_pp = true;
|
|
continue;
|
|
}
|
|
|
|
std::string lookup_name = x.name();
|
|
auto remapped = m_var_remap.find(lookup_name);
|
|
if (remapped != m_var_remap.end()) {
|
|
lookup_name = remapped->second;
|
|
}
|
|
|
|
if (m_vars_defined_in_let.find(lookup_name) != m_vars_defined_in_let.end()) {
|
|
continue;
|
|
}
|
|
|
|
count++;
|
|
elts.push_back(pretty_print::build_list(lookup_name, x.type.typespec().print()));
|
|
}
|
|
|
|
// sort in increasing offset.
|
|
// it looks like this is the order the GOAL compiler itself used.
|
|
std::vector<StackSpillEntry> spills;
|
|
for (auto& x : stack_slot_entries) {
|
|
spills.push_back(x.second);
|
|
}
|
|
std::sort(spills.begin(), spills.end(),
|
|
[](const StackSpillEntry& a, const StackSpillEntry& b) { return a.offset < b.offset; });
|
|
for (auto& x : spills) {
|
|
elts.push_back(pretty_print::build_list(x.name(), x.typespec.print()));
|
|
count++;
|
|
}
|
|
|
|
result.count = count;
|
|
if (count > 0) {
|
|
result.local_vars = pretty_print::build_list(elts);
|
|
}
|
|
return result;
|
|
}
|
|
|
|
std::unordered_set<RegId, RegId::hash> Env::get_ssa_var(const RegAccessSet& vars) const {
|
|
std::unordered_set<RegId, RegId::hash> result;
|
|
for (auto& x : vars) {
|
|
result.insert(get_program_var_id(x));
|
|
}
|
|
return result;
|
|
}
|
|
|
|
RegId Env::get_program_var_id(const RegisterAccess& var) const {
|
|
return m_var_names.lookup(var.reg(), var.idx(), var.mode()).reg_id;
|
|
}
|
|
|
|
const UseDefInfo& Env::get_use_def_info(const RegisterAccess& ra) const {
|
|
assert(has_local_vars());
|
|
auto var_id = get_program_var_id(ra);
|
|
return m_var_names.use_def_info.at(var_id);
|
|
}
|
|
|
|
void Env::disable_def(const RegisterAccess& access, DecompWarnings& warnings) {
|
|
if (has_local_vars()) {
|
|
m_var_names.disable_def(access, warnings);
|
|
}
|
|
}
|
|
|
|
void Env::disable_use(const RegisterAccess& access) {
|
|
if (has_local_vars()) {
|
|
m_var_names.disable_use(access);
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* Set the stack hints. This must be done before type analysis.
|
|
* This actually parses the types, so it should be done after the dts is set up.
|
|
*/
|
|
void Env::set_stack_structure_hints(const std::vector<StackStructureHint>& hints) {
|
|
for (auto& hint : hints) {
|
|
StackStructureEntry entry;
|
|
entry.hint = hint;
|
|
// parse the type spec.
|
|
TypeSpec base_typespec = dts->parse_type_spec(hint.element_type);
|
|
auto type_info = dts->ts.lookup_type(base_typespec);
|
|
|
|
switch (hint.container_type) {
|
|
case StackStructureHint::ContainerType::NONE:
|
|
// just a plain object on the stack.
|
|
if (!type_info->is_reference()) {
|
|
throw std::runtime_error(
|
|
fmt::format("Stack variable type {} is not a reference and cannot be stored directly "
|
|
"on the stack. Use an array instead.",
|
|
base_typespec.print()));
|
|
}
|
|
entry.ref_type = base_typespec;
|
|
entry.size = type_info->get_size_in_memory();
|
|
// sanity check the alignment
|
|
if (align(entry.hint.stack_offset, type_info->get_in_memory_alignment()) !=
|
|
entry.hint.stack_offset) {
|
|
lg::error("Misaligned stack variable of type {} offset {} required align {}\n",
|
|
entry.ref_type.print(), entry.hint.stack_offset,
|
|
type_info->get_in_memory_alignment());
|
|
}
|
|
|
|
break;
|
|
default:
|
|
assert(false);
|
|
}
|
|
|
|
m_stack_structures.push_back(entry);
|
|
}
|
|
}
|
|
|
|
} // namespace decompiler
|