jak-project/decompiler/ObjectFile/ObjectFileDB.cpp

797 lines
26 KiB
C++
Raw Normal View History

2020-08-22 23:30:17 -04:00
/*!
* @file ObjectFileDB.cpp
* A "database" of object files found in DGO files.
* Eliminates duplicate object files, and also assigns unique names to all object files
* (there may be different object files with the same name sometimes)
*/
#include "ObjectFileDB.h"
#include <algorithm>
2020-09-03 20:11:31 -04:00
#include <set>
2020-08-22 23:30:17 -04:00
#include <cstring>
#include <map>
#include "common/link_types.h"
#include "common/util/dgo_util.h"
#include "common/util/BitUtils.h"
#include "decompiler/data/tpage.h"
#include "decompiler/data/game_text.h"
#include "decompiler/data/StrFileReader.h"
#include "decompiler/data/dir_tpages.h"
#include "decompiler/data/game_count.h"
2020-08-22 23:30:17 -04:00
#include "LinkedObjectFileCreation.h"
#include "decompiler/config.h"
#include "common/util/BinaryReader.h"
#include "common/util/Timer.h"
#include "common/util/FileUtil.h"
2020-08-22 23:30:17 -04:00
#include "decompiler/Function/BasicBlocks.h"
#include "common/log/log.h"
#include "common/util/json_util.h"
2020-08-22 23:30:17 -04:00
namespace decompiler {
namespace {
std::string strip_dgo_extension(const std::string& x) {
auto ext = x.substr(x.length() - 4, 4);
if (ext == ".CGO" || ext == ".cgo" || ext == ".DGO" || ext == ".dgo") {
return x.substr(0, x.length() - 4);
}
return x;
2020-08-22 23:30:17 -04:00
}
/*!
* Get an object name from a file name.
* Strips off the file extension and anything before the last slash.
*/
std::string obj_filename_to_name(const std::string& x) {
auto end = x.length();
// find last dot
auto last_dot = end;
for (; last_dot-- > 0;) {
if (x.at(last_dot) == '.') {
break;
}
}
if (last_dot == 0) {
last_dot = end;
}
auto last_slash = end;
for (; last_slash-- > 0;) {
if (x.at(last_slash) == '\\' || x.at(last_slash) == '/') {
break;
}
}
ASSERT(last_dot > last_slash + 1);
ASSERT(last_slash + 1 < x.length());
return x.substr(last_slash + 1, last_dot - last_slash - 1);
}
} // namespace
2020-08-22 23:30:17 -04:00
2020-09-03 20:11:31 -04:00
std::string ObjectFileData::to_unique_name() const {
if (!name_from_map.empty()) {
return name_from_map;
}
2020-09-03 20:11:31 -04:00
if (has_multiple_versions) {
std::string result = record.name + "-";
auto dgo_names_sorted = dgo_names;
std::sort(dgo_names_sorted.begin(), dgo_names_sorted.end());
for (auto x : dgo_names_sorted) {
x = strip_dgo_extension(x);
2020-09-03 20:11:31 -04:00
result += x + "-";
}
result.pop_back();
return result;
} else {
return record.name;
}
}
ObjectFileData& ObjectFileDB::lookup_record(const ObjectFileRecord& rec) {
2020-09-03 20:11:31 -04:00
ObjectFileData* result = nullptr;
for (auto& x : obj_files_by_name[rec.name]) {
if (x.record.version == rec.version) {
ASSERT(x.record.hash == rec.hash);
ASSERT(!result);
2020-09-03 20:11:31 -04:00
result = &x;
}
}
ASSERT(result);
2020-09-03 20:11:31 -04:00
return *result;
}
2020-08-22 23:30:17 -04:00
/*!
* Build an object file DB for the given list of DGOs.
*/
ObjectFileDB::ObjectFileDB(const std::vector<std::string>& _dgos,
const std::string& obj_file_name_map_file,
const std::vector<std::string>& object_files,
const std::vector<std::string>& str_files,
const Config& config) {
2020-08-22 23:30:17 -04:00
Timer timer;
lg::info("-Loading types...");
dts.parse_type_defs({"decompiler", "config", "all-types.gc"});
2020-08-22 23:30:17 -04:00
if (!obj_file_name_map_file.empty()) {
lg::info("-Loading obj name map file...");
load_map_file(file_util::read_text_file(file_util::get_file_path({obj_file_name_map_file})));
} else {
lg::warn(
"Not using an obj name map file! The decompiler will automatically generate object file "
"names and write them to out/objs.txt. It is recommended to reuse this map file to get "
"consistent naming when doing a partial decompilation.");
}
lg::info("-Loading {} DGOs...", _dgos.size());
2020-08-22 23:30:17 -04:00
for (auto& dgo : _dgos) {
try {
get_objs_from_dgo(dgo, config);
} catch (std::runtime_error& e) {
2022-04-09 11:46:56 -04:00
lg::warn("Error when reading DGOs: {} on {}", e.what(), dgo);
}
2020-08-22 23:30:17 -04:00
}
lg::info("-Loading {} plain object files...", object_files.size());
for (auto& obj : object_files) {
auto data = file_util::read_binary_file(obj);
auto name = obj_filename_to_name(obj);
add_obj_from_dgo(name, name, data.data(), data.size(), "NO-XGO", config);
}
lg::info("-Loading {} streaming object files...", str_files.size());
for (auto& obj : str_files) {
StrFileReader reader(obj);
// name from the file name
std::string base_name = obj_filename_to_name(obj);
// name from inside the file (this does a lot of sanity checking)
auto obj_name = reader.get_full_name(base_name + ".STR");
for (int i = 0; i < reader.chunk_count(); i++) {
// append the chunk ID to the full name
std::string name = obj_name + fmt::format("+{}", i);
auto& data = reader.get_chunk(i);
add_obj_from_dgo(name, name, data.data(), data.size(), "NO-XGO", config);
}
}
lg::info("ObjectFileDB Initialized\n");
if (obj_files_by_name.empty()) {
lg::error(
"No object files have been added. Check that there are input files and the allowed_objects "
"list.");
}
dts.bad_format_strings = config.bad_format_strings;
dts.format_ops_with_dynamic_string_by_func_name =
config.hacks.format_ops_with_dynamic_string_by_func_name;
2020-08-22 23:30:17 -04:00
}
void ObjectFileDB::load_map_file(const std::string& map_data) {
auto j = parse_commented_json(map_data, "ObjectFileDB Map File");
for (auto& x : j) {
auto mapped_name = x[0].get<std::string>();
auto game_name = x[1].get<std::string>();
auto dgo_names = x[3].get<std::vector<std::string>>();
bool is_ag = mapped_name.find("-ag") != std::string::npos;
auto game_name_with_ag = game_name;
if (is_ag) {
game_name_with_ag += "-ag";
}
// add dgo
for (auto& dgo : dgo_names) {
auto kv = dgo_obj_name_map[dgo].find(game_name_with_ag);
if (kv != dgo_obj_name_map[dgo].end()) {
lg::error("Object {} in dgo {} occurs more than one time.", game_name_with_ag, dgo);
ASSERT(false);
}
dgo_obj_name_map[dgo][game_name_with_ag] = mapped_name;
}
}
}
2020-08-22 23:30:17 -04:00
/*!
* Load the objects stored in the given DGO into the ObjectFileDB
*/
void ObjectFileDB::get_objs_from_dgo(const std::string& filename, const Config& config) {
auto dgo_data = file_util::read_binary_file(filename);
2020-08-22 23:30:17 -04:00
stats.total_dgo_bytes += dgo_data.size();
if (file_util::dgo_header_is_compressed(dgo_data)) {
dgo_data = file_util::decompress_dgo(dgo_data);
2020-08-22 23:30:17 -04:00
}
BinaryReader reader(dgo_data);
auto header = reader.read<DgoHeader>();
auto dgo_base_name = file_util::base_name(filename);
ASSERT(header.name == dgo_base_name);
2020-08-22 23:30:17 -04:00
assert_string_empty_after(header.name, 60);
// get all obj files...
for (uint32_t i = 0; i < header.object_count; i++) {
2020-08-22 23:30:17 -04:00
auto obj_header = reader.read<DgoHeader>();
assert_string_empty_after(obj_header.name, 60);
if (i == header.object_count - 1) {
if (reader.bytes_left() == obj_header.object_count - 0x30) {
if (config.is_pal) {
lg::warn("Skipping {} because it is a broken PAL object", obj_header.name);
reader.ffwd(reader.bytes_left());
continue;
} else {
ASSERT(false);
}
}
} else {
ASSERT(reader.bytes_left() >= obj_header.object_count);
}
2020-08-22 23:30:17 -04:00
if (std::string(obj_header.name).find("-ag") != std::string::npos) {
lg::error(
"Object file {} has \"-ag\" in its name. This will break any tools which use this to "
"detect an art group",
obj_header.name);
ASSERT(false);
}
auto name = get_object_file_name(obj_header.name, reader.here(), obj_header.object_count);
2020-09-03 20:11:31 -04:00
add_obj_from_dgo(name, obj_header.name, reader.here(), obj_header.object_count, dgo_base_name,
config);
reader.ffwd(align16(obj_header.object_count));
2020-08-22 23:30:17 -04:00
}
// check we're at the end
ASSERT(0 == reader.bytes_left());
2020-08-22 23:30:17 -04:00
}
/*!
* Add an object file to the ObjectFileDB
*/
void ObjectFileDB::add_obj_from_dgo(const std::string& obj_name,
2020-09-03 20:11:31 -04:00
const std::string& name_in_dgo,
const uint8_t* obj_data,
2020-08-22 23:30:17 -04:00
uint32_t obj_size,
const std::string& dgo_name,
const Config& config) {
if (config.banned_objects.find(obj_name) != config.banned_objects.end()) {
return;
}
if (!config.allowed_objects.empty()) {
if (config.allowed_objects.find(obj_name) == config.allowed_objects.end()) {
return;
}
}
2020-08-22 23:30:17 -04:00
stats.total_obj_files++;
ASSERT(obj_size > 128);
uint16_t version = *(const uint16_t*)(obj_data + 8);
auto hash = file_util::crc32(obj_data, obj_size);
2020-08-22 23:30:17 -04:00
2020-09-03 20:11:31 -04:00
bool duplicated = false;
2020-08-22 23:30:17 -04:00
// first, check to see if we already got it...
for (auto& e : obj_files_by_name[obj_name]) {
if (e.data.size() == obj_size && e.record.hash == hash) {
2020-09-03 20:11:31 -04:00
// just to make sure we don't have a hash collision.
ASSERT(!memcmp(obj_data, e.data.data(), obj_size));
2020-09-03 20:11:31 -04:00
2020-08-22 23:30:17 -04:00
// already got it!
e.reference_count++;
2020-09-03 20:11:31 -04:00
auto& rec = e.record;
ASSERT(name_in_dgo == e.name_in_dgo);
2020-09-03 20:11:31 -04:00
e.dgo_names.push_back(dgo_name);
2020-08-22 23:30:17 -04:00
obj_files_by_dgo[dgo_name].push_back(rec);
2020-09-03 20:11:31 -04:00
duplicated = true;
break;
} else {
e.has_multiple_versions = true;
2020-08-22 23:30:17 -04:00
}
}
2020-09-03 20:11:31 -04:00
if (duplicated) {
return;
}
2020-08-22 23:30:17 -04:00
// nope, have to add a new one.
ObjectFileData data;
data.data.resize(obj_size);
memcpy(data.data.data(), obj_data, obj_size);
data.record.hash = hash;
data.record.name = obj_name;
2020-09-03 20:11:31 -04:00
data.dgo_names.push_back(dgo_name);
2020-08-22 23:30:17 -04:00
if (obj_files_by_name[obj_name].empty()) {
// if this is the first time we've seen this object file name, add it in the order.
obj_file_order.push_back(obj_name);
}
data.record.version = obj_files_by_name[obj_name].size();
2020-09-03 20:11:31 -04:00
data.name_in_dgo = name_in_dgo;
data.obj_version = version;
if (!dgo_obj_name_map.empty()) {
auto dgo_kv = dgo_obj_name_map.find(strip_dgo_extension(dgo_name));
if (dgo_kv == dgo_obj_name_map.end()) {
lg::error("Object {} is from DGO {}, but this DGO was not in the map.", obj_name, dgo_name);
ASSERT(false);
}
auto name_kv = dgo_kv->second.find(obj_name);
if (name_kv == dgo_kv->second.end()) {
lg::error("Object {} from DGO {} was not found in the name map.", obj_name, dgo_name);
ASSERT(false);
}
data.name_from_map = name_kv->second;
}
2020-08-22 23:30:17 -04:00
obj_files_by_dgo[dgo_name].push_back(data.record);
obj_files_by_name[obj_name].emplace_back(std::move(data));
stats.unique_obj_files++;
stats.unique_obj_bytes += obj_size;
2020-09-03 20:11:31 -04:00
if (obj_files_by_name[obj_name].size() > 1) {
for (auto& e : obj_files_by_name[obj_name]) {
e.has_multiple_versions = true;
}
}
2020-08-22 23:30:17 -04:00
}
/*!
* Generate a listing of what object files go in which dgos
*/
std::string ObjectFileDB::generate_dgo_listing() {
std::string result = ";; DGO File Listing\n\n";
std::vector<std::string> dgo_names;
for (auto& kv : obj_files_by_dgo) {
dgo_names.push_back(kv.first);
}
std::sort(dgo_names.begin(), dgo_names.end());
for (const auto& name : dgo_names) {
result += "(\"" + name + "\"\n";
2020-09-03 20:11:31 -04:00
for (auto& obj_rec : obj_files_by_dgo[name]) {
auto& obj = lookup_record(obj_rec);
2020-09-03 20:11:31 -04:00
std::string extension = ".o";
if (obj.obj_version == 4 || obj.obj_version == 2) {
extension = ".go";
}
result += " (\"" + obj.to_unique_name() + extension + "\" \"" + obj.name_in_dgo + "\")\n";
2020-08-22 23:30:17 -04:00
}
result += " )\n\n";
}
return result;
}
2020-09-03 22:32:16 -04:00
namespace {
std::string pad_string(const std::string& in, size_t length) {
if (in.length() < length) {
return in + std::string(length - in.length(), ' ');
} else {
return in;
}
2020-09-03 22:32:16 -04:00
}
} // namespace
std::string ObjectFileDB::generate_obj_listing(const std::unordered_set<std::string>& merged_objs) {
std::string result = "[";
2020-09-03 20:11:31 -04:00
std::set<std::string> all_unique_names;
int unique_count = 0;
for (auto& obj_file : obj_file_order) {
for (auto& x : obj_files_by_name.at(obj_file)) {
2020-09-03 22:32:16 -04:00
std::string dgos = "[";
for (auto& y : x.dgo_names) {
ASSERT(y.length() >= 5);
std::string new_str = y == "NO-XGO" ? y : y.substr(0, y.length() - 4);
dgos += "\"" + new_str + "\", ";
2020-09-03 22:32:16 -04:00
}
dgos.pop_back();
dgos.pop_back();
dgos += "]";
auto name = x.to_unique_name();
result += "[\"" + pad_string(name + "\", ", 50) + "\"" +
pad_string(x.name_in_dgo + "\", ", 50) + std::to_string(x.obj_version) + ", " +
2020-09-03 22:32:16 -04:00
dgos + ", \"\"],\n";
2020-09-03 20:11:31 -04:00
unique_count++;
if (all_unique_names.find(name) != all_unique_names.end() &&
merged_objs.find(name) == merged_objs.end()) {
lg::error("Object file {} appears multiple times with the same name.", name);
}
all_unique_names.insert(name);
}
2020-09-03 20:11:31 -04:00
}
// this check is extremely important. It makes sure we don't have any repeat names. This could
// be caused by two files with the same name, in the same DGOs, but different data.
if (int(all_unique_names.size()) != unique_count) {
lg::error("Object files are not named properly, data will be lost!");
}
2020-09-03 20:11:31 -04:00
if (unique_count > 0) {
result.pop_back(); // kill last new line
result.pop_back(); // kill last comma
}
return result + "]";
2020-09-03 20:11:31 -04:00
}
2020-08-22 23:30:17 -04:00
/*!
* Process all of the linking data of all objects.
*/
void ObjectFileDB::process_link_data(const Config& config) {
lg::info("Processing Link Data...");
2020-08-22 23:30:17 -04:00
Timer process_link_timer;
LinkedObjectFile::Stats combined_stats;
for_each_obj([&](ObjectFileData& obj) {
obj.linked_data = to_linked_object_file(obj.data, obj.record.name, dts, config.game_version);
2020-08-22 23:30:17 -04:00
combined_stats.add(obj.linked_data.stats);
});
lg::info("Processed Link Data");
lg::info(" Total {:.2f} ms\n", process_link_timer.getMs());
// printf("\n");
2020-08-22 23:30:17 -04:00
}
/*!
* Process all of the labels generated from linking and give them reasonable names.
*/
void ObjectFileDB::process_labels() {
lg::info("Processing Labels...");
2020-08-22 23:30:17 -04:00
Timer process_label_timer;
uint32_t total = 0;
for_each_obj([&](ObjectFileData& obj) { total += obj.linked_data.set_ordered_label_names(); });
lg::info("Processed Labels:");
lg::info(" Total {} labels", total);
lg::info(" Total {:.2f} ms\n", process_label_timer.getMs());
2020-08-22 23:30:17 -04:00
}
/*!
* Dump object files and their linking data to text files for debugging
*/
2021-05-11 19:19:23 -04:00
void ObjectFileDB::write_object_file_words(const std::string& output_dir,
bool dump_data,
bool dump_code) {
lg::info("- Writing object file dumps (code? {} data? {})...", dump_code, dump_data);
2020-08-22 23:30:17 -04:00
Timer timer;
uint32_t total_bytes = 0, total_files = 0;
for_each_obj([&](ObjectFileData& obj) {
2021-05-11 19:19:23 -04:00
if ((obj.linked_data.segments == 3 && dump_code) ||
(obj.linked_data.segments != 3 && dump_data)) {
2020-08-22 23:30:17 -04:00
auto file_text = obj.linked_data.print_words();
auto file_name = file_util::combine_path(output_dir, obj.to_unique_name() + ".txt");
2020-08-22 23:30:17 -04:00
total_bytes += file_text.size();
file_util::write_text_file(file_name, file_text);
2020-08-22 23:30:17 -04:00
total_files++;
}
});
lg::info("Wrote object file dumps:");
lg::info(" Total {} files", total_files);
lg::info(" Total {:.3f} MB", total_bytes / ((float)(1u << 20u)));
lg::info(" Total {} ms ({:.3f} MB/sec)", timer.getMs(),
total_bytes / ((1u << 20u) * timer.getSeconds()));
2020-08-22 23:30:17 -04:00
}
/*!
* Dump disassembly for object files containing code. Data zones will also be dumped.
*/
void ObjectFileDB::write_disassembly(const std::string& output_dir,
2021-05-11 19:19:23 -04:00
bool disassemble_data,
bool disassemble_code,
bool print_hex) {
lg::info("- Writing functions...");
2020-08-22 23:30:17 -04:00
Timer timer;
uint32_t total_bytes = 0, total_files = 0;
std::string asm_functions;
2020-08-22 23:30:17 -04:00
for_each_obj([&](ObjectFileData& obj) {
2021-05-11 19:19:23 -04:00
if ((obj.obj_version == 3 && disassemble_code) || (obj.obj_version != 3 && disassemble_data)) {
auto file_text = obj.linked_data.print_disassembly(print_hex);
asm_functions += obj.linked_data.print_asm_function_disassembly(obj.to_unique_name());
2021-05-11 19:19:23 -04:00
auto file_name = file_util::combine_path(output_dir, obj.to_unique_name() + ".asm");
total_bytes += file_text.size();
file_util::write_text_file(file_name, file_text);
total_files++;
2020-08-22 23:30:17 -04:00
}
});
total_bytes += asm_functions.size();
total_files++;
file_util::write_text_file(file_util::combine_path(output_dir, "asm_functions.func"),
asm_functions);
lg::info("Wrote functions dumps:");
lg::info(" Total {} files", total_files);
lg::info(" Total {} MB", total_bytes / ((float)(1u << 20u)));
lg::info(" Total {} ms ({:.3f} MB/sec)", timer.getMs(),
total_bytes / ((1u << 20u) * timer.getSeconds()));
2020-08-22 23:30:17 -04:00
}
/*!
* Find code/data zones, identify functions, and disassemble
*/
void ObjectFileDB::find_code(const Config& config) {
lg::info("Finding code in object files...");
2020-08-22 23:30:17 -04:00
LinkedObjectFile::Stats combined_stats;
Timer timer;
for_each_obj([&](ObjectFileData& obj) {
// printf("fc %s\n", obj.record.to_unique_name().c_str());
obj.linked_data.find_code();
obj.linked_data.find_functions();
obj.linked_data.disassemble_functions();
if (config.game_version == 1 || obj.to_unique_name() != "effect-control-v0") {
2020-08-22 23:30:17 -04:00
obj.linked_data.process_fp_relative_links();
} else {
lg::warn("Skipping process_fp_relative_links in {}", obj.to_unique_name().c_str());
2020-08-22 23:30:17 -04:00
}
auto& obj_stats = obj.linked_data.stats;
if (obj_stats.code_bytes / 4 > obj_stats.decoded_ops) {
lg::warn("Failed to decode all in {} ({} / {})", obj.to_unique_name().c_str(),
obj_stats.decoded_ops, obj_stats.code_bytes / 4);
2020-08-22 23:30:17 -04:00
}
combined_stats.add(obj.linked_data.stats);
});
lg::info("Found code:");
lg::info(" Code {:.3f} MB", combined_stats.code_bytes / (float)(1 << 20));
lg::info(" Data {:.3f} MB", combined_stats.data_bytes / (float)(1 << 20));
lg::info(" Functions: {}", combined_stats.function_count);
lg::info(" fp uses resolved: {} / {} ({:.3f} %)", combined_stats.n_fp_reg_use_resolved,
combined_stats.n_fp_reg_use,
100.f * (float)combined_stats.n_fp_reg_use_resolved / combined_stats.n_fp_reg_use);
2020-08-22 23:30:17 -04:00
auto total_ops = combined_stats.code_bytes / 4;
lg::info(" Decoded {} / {} ({:.3f} %)", combined_stats.decoded_ops, total_ops,
100.f * (float)combined_stats.decoded_ops / total_ops);
lg::info(" Total {:.3f} ms\n", timer.getMs());
2020-08-22 23:30:17 -04:00
}
/*!
* Finds and writes all scripts into a file named all_scripts.lisp.
* Doesn't change any state in ObjectFileDB.
*/
void ObjectFileDB::find_and_write_scripts(const std::string& output_dir) {
lg::info("- Finding scripts in object files...");
2020-08-22 23:30:17 -04:00
Timer timer;
std::string all_scripts;
for_each_obj([&](ObjectFileData& obj) {
auto scripts = obj.linked_data.print_scripts();
if (!scripts.empty()) {
all_scripts += ";--------------------------------------\n";
all_scripts += "; " + obj.to_unique_name() + "\n";
2020-08-22 23:30:17 -04:00
all_scripts += ";---------------------------------------\n";
all_scripts += scripts;
}
});
auto file_name = file_util::combine_path(output_dir, "all_scripts.lisp");
file_util::write_text_file(file_name, all_scripts);
2020-08-22 23:30:17 -04:00
lg::info("Found scripts:");
lg::info(" Total {:.3f} ms\n", timer.getMs());
2020-08-22 23:30:17 -04:00
}
std::string ObjectFileDB::process_tpages(TextureDB& tex_db) {
lg::info("- Finding textures in tpages...");
std::string tpage_string = "tpage-";
int total = 0, success = 0;
int tpage_dir_count = 0;
u64 total_px = 0;
Timer timer;
std::string result;
for_each_obj([&](ObjectFileData& data) {
if (data.name_in_dgo.substr(0, tpage_string.length()) == tpage_string) {
auto statistics = process_tpage(data, tex_db);
total += statistics.total_textures;
success += statistics.successful_textures;
total_px += statistics.num_px;
} else if (data.name_in_dgo == "dir-tpages") {
result = process_dir_tpages(data).to_source();
tpage_dir_count++;
}
});
ASSERT(tpage_dir_count <= 1);
lg::info("Processed {} / {} textures ({} px) {:.2f}% in {:.2f} ms", success, total, total_px,
100.f * float(success) / float(total), timer.getMs());
if (tpage_dir_count == 0) {
lg::warn("Did not find tpage-dir.");
return {};
}
return result;
}
std::string ObjectFileDB::process_game_text_files(const Config& cfg) {
lg::info("- Finding game text...");
std::string text_string = "COMMON";
Timer timer;
int file_count = 0;
int string_count = 0;
int char_count = 0;
std::unordered_map<int, std::unordered_map<int, std::string>> text_by_language_by_id;
for_each_obj([&](ObjectFileData& data) {
if (data.name_in_dgo.substr(1) == text_string) {
file_count++;
auto statistics = process_game_text(data, cfg.text_version);
string_count += statistics.total_text;
char_count += statistics.total_chars;
if (text_by_language_by_id.find(statistics.language) != text_by_language_by_id.end()) {
ASSERT(false);
}
text_by_language_by_id[statistics.language] = std::move(statistics.text);
}
});
lg::info("Processed {} text files ({} strings, {} characters) in {:.2f} ms", file_count,
string_count, char_count, timer.getMs());
if (text_by_language_by_id.empty()) {
return {};
}
return write_game_text(cfg, text_by_language_by_id);
}
std::string ObjectFileDB::process_game_count_file() {
lg::info("- Finding game count file...");
bool found = false;
std::string result;
for_each_obj([&](ObjectFileData& data) {
if (data.name_in_dgo == "game-cnt") {
ASSERT(!found);
found = true;
result = write_game_count(process_game_count(data));
}
});
if (!found) {
lg::warn("did not find game-cnt file");
}
return result;
}
2020-11-27 16:38:36 -05:00
/*!
* This is the main decompiler routine which runs after we've identified functions.
*/
void ObjectFileDB::analyze_functions_ir1(const Config& config) {
lg::info("- Analyzing Functions...");
2020-08-22 23:30:17 -04:00
Timer timer;
int total_functions = 0;
2020-11-27 16:38:36 -05:00
// Step 1 - analyze the "top level" or "login" code for each object file.
// this will give us type definitions, method definitions, and function definitions...
lg::info(" - Processing top levels...");
2020-11-27 16:38:36 -05:00
timer.start();
for_each_obj([&](ObjectFileData& data) {
if (data.linked_data.segments == 3) {
// the top level segment should have a single function
ASSERT(data.linked_data.functions_by_seg.at(2).size() == 1);
2020-11-27 16:38:36 -05:00
auto& func = data.linked_data.functions_by_seg.at(2).front();
ASSERT(func.guessed_name.empty());
func.guessed_name.set_as_top_level(data.to_unique_name());
2020-11-27 16:38:36 -05:00
func.find_global_function_defs(data.linked_data, dts);
func.find_type_defs(data.linked_data, dts);
func.find_method_defs(data.linked_data, dts);
}
});
2020-08-22 23:30:17 -04:00
2020-11-27 16:38:36 -05:00
// check for function uniqueness.
std::unordered_set<std::string> unique_names;
std::unordered_map<std::string, std::unordered_set<std::string>> duplicated_functions;
2020-08-22 23:30:17 -04:00
2020-11-27 16:38:36 -05:00
int uid = 1;
for_each_obj([&](ObjectFileData& data) {
int func_in_obj = 0;
for (int segment_id = 0; segment_id < int(data.linked_data.segments); segment_id++) {
for (auto& func : data.linked_data.functions_by_seg.at(segment_id)) {
func.guessed_name.unique_id = uid++;
func.guessed_name.id_in_object = func_in_obj++;
func.guessed_name.object_name = data.to_unique_name();
auto name = func.name();
2020-11-27 16:38:36 -05:00
if (unique_names.find(name) != unique_names.end()) {
duplicated_functions[name].insert(data.to_unique_name());
}
2020-08-22 23:30:17 -04:00
2020-11-27 16:38:36 -05:00
unique_names.insert(name);
if (config.hacks.asm_functions_by_name.find(name) !=
config.hacks.asm_functions_by_name.end()) {
func.warnings.info("Flagged as asm by config");
2020-11-27 16:38:36 -05:00
func.suspected_asm = true;
}
2020-08-26 01:21:33 -04:00
}
2020-11-27 16:38:36 -05:00
}
});
for_each_function([&](Function& func, int segment_id, ObjectFileData& data) {
(void)segment_id;
auto name = func.name();
2020-11-27 16:38:36 -05:00
if (duplicated_functions.find(name) != duplicated_functions.end()) {
duplicated_functions[name].insert(data.to_unique_name());
func.warnings.info("Exists in multiple non-identical object files");
2020-11-27 16:38:36 -05:00
}
});
2020-08-22 23:30:17 -04:00
int total_trivial_cfg_functions = 0;
2020-08-22 23:30:17 -04:00
int total_named_functions = 0;
int asm_funcs = 0;
2020-08-22 23:30:17 -04:00
std::map<int, std::vector<std::string>> unresolved_by_length;
timer.start();
int total_basic_blocks = 0;
2020-11-27 16:38:36 -05:00
// Main Pass over each function...
for_each_function_def_order([&](Function& func, int segment_id, ObjectFileData& data) {
2020-11-27 16:38:36 -05:00
total_functions++;
// first, find basic blocks.
auto blocks = find_blocks_in_function(data.linked_data, segment_id, func);
total_basic_blocks += blocks.size();
func.basic_blocks = blocks;
2020-11-27 16:38:36 -05:00
// analyze the proluge
if (!func.suspected_asm) {
// first, find the prologue/epilogue
func.analyze_prologue(data.linked_data);
}
if (!func.suspected_asm) {
// run analysis
2020-11-27 16:38:36 -05:00
// build a control flow graph, just looking at branch instructions.
func.cfg = build_cfg(data.linked_data, segment_id, func, {}, {});
// convert individual basic blocks to sequences of IR Basic Ops
for (auto& block : func.basic_blocks) {
if (block.end_word > block.start_word) {
2020-11-27 16:38:36 -05:00
auto label_id =
data.linked_data.get_label_at(segment_id, (func.start_word + block.start_word) * 4);
if (label_id != -1) {
block.label_name = data.linked_data.get_label_name(label_id);
}
}
}
} else {
asm_funcs++;
}
});
lg::info("Found {} functions ({} with no control flow)", total_functions,
total_trivial_cfg_functions);
lg::info("Named {}/{} functions ({:.3f}%)", total_named_functions, total_functions,
100.f * float(total_named_functions) / float(total_functions));
lg::info("Excluding {} asm functions", asm_funcs);
}
void ObjectFileDB::dump_raw_objects(const std::string& output_dir) {
for_each_obj([&](ObjectFileData& data) {
auto dest = output_dir + "/" + data.to_unique_name();
if (data.obj_version != 3) {
dest += ".go";
}
file_util::write_binary_file(dest, data.data.data(), data.data.size());
});
}
} // namespace decompiler