mirror of https://github.com/zeldaret/tp.git
406 lines
12 KiB
Python
406 lines
12 KiB
Python
"""
|
|
|
|
lcf.py
|
|
|
|
Generates the .lcf file used for the linker. This will auto force actives missing functions and data
|
|
and apply some fixes which makes it easier to decompile.
|
|
|
|
"""
|
|
|
|
import importlib
|
|
import io
|
|
import sys
|
|
|
|
from pathlib import Path
|
|
|
|
try:
|
|
import click
|
|
import libelf
|
|
import libar
|
|
import dol2asm_settings
|
|
except ImportError as e:
|
|
MISSING_PREREQUISITES = (
|
|
f"Missing prerequisite python module {e}.\n"
|
|
f"Run `python3 -m pip install --user -r tools/requirements.txt` to install prerequisites."
|
|
)
|
|
|
|
print(MISSING_PREREQUISITES, file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
VERSION = "1.0"
|
|
|
|
# load the symbol definition file for main.dol
|
|
sys.path.append("defs")
|
|
|
|
|
|
def lcf_generate(output_path):
|
|
"""Script for generating .lcf files"""
|
|
|
|
import module0
|
|
|
|
# load symbols from compiled files
|
|
symbols = []
|
|
for archive in ARCHIVES:
|
|
symbols.extend(load_archive(archive))
|
|
|
|
# load object files from the 'build/o_files', this way we need no list of
|
|
# object files in the python code.
|
|
with open("build/o_files", "r") as content_file:
|
|
o_files = content_file.read().strip().split(" ")
|
|
|
|
for o_file in o_files:
|
|
with open(o_file, "rb") as file:
|
|
obj = libelf.load_object_from_file(None, o_file, file)
|
|
symbols.extend(get_symbols_from_object_file(obj))
|
|
|
|
# write the file
|
|
with output_path.open("w") as file:
|
|
file.write("MEMORY {\n")
|
|
file.write("\ttext: origin = 0x80003100\n")
|
|
file.write("}\n")
|
|
file.write("\n")
|
|
|
|
file.write("SECTIONS {\n")
|
|
file.write("\tGROUP:{\n")
|
|
|
|
for name, align in SECTIONS:
|
|
file.write("\t\t%s ALIGN(0x%X):{}\n" % (name, align))
|
|
|
|
# strip .dead section
|
|
file.write("\t\t/DISCARD/ : { *(.dead) }\n")
|
|
|
|
file.write("\t} > text\n")
|
|
file.write(
|
|
"\t_stack_addr = (_f_sbss2 + SIZEOF(.sbss2) + 65536 + 0x7) & ~0x7;\n"
|
|
)
|
|
file.write("\t_stack_end = _f_sbss2 + SIZEOF(.sbss2);\n")
|
|
file.write("\t_db_stack_addr = (_stack_addr + 0x2000);\n")
|
|
file.write("\t_db_stack_end = _stack_addr;\n")
|
|
file.write("\t__ArenaLo = (_db_stack_addr + 0x1f) & ~0x1f;\n")
|
|
file.write("\t__ArenaHi = 0x81700000;\n")
|
|
file.write("\n")
|
|
file.write("\t/* missing symbols */\n")
|
|
|
|
# improve decompilation workflow by making so that function
|
|
# which, for what ever reason, cannot be named the same as
|
|
# the expected name to work. This will happen for all symbols
|
|
# with weird characters.
|
|
base_names = set(module0.SYMBOL_NAMES.keys())
|
|
main_names = set([sym.name for sym in symbols])
|
|
names = base_names - main_names
|
|
for name in names:
|
|
symbol = module0.SYMBOLS[module0.SYMBOL_NAMES[name]]
|
|
if symbol["type"] == "StringBase": # @stringBase0 is handled below
|
|
continue
|
|
if symbol["type"] == "LinkerGenerated": # linker handles these symbols
|
|
continue
|
|
|
|
file.write(f"\t\"{symbol['label']}\" = 0x{symbol['addr']:08X};\n")
|
|
file.write("\n")
|
|
|
|
# @stringBase0 is generated by the compiler. The dol2asm is using a trick to
|
|
# simulate the stringBase0 by creating another symbol (at the same location)
|
|
# that is used instead, as it is impossible to reference the "@stringBase0" (because of the @).
|
|
# So all references will be to the new symbol, thus the linker will think
|
|
# that the @stringBase0 symbol is never used and strip it.
|
|
file.write("\t/* @stringBase0 */\n")
|
|
for x in module0.SYMBOLS:
|
|
if x["type"] == "StringBase":
|
|
file.write('\t"%s" = 0x%08X;\n' % (x["label"], x["addr"]))
|
|
|
|
file.write("}\n")
|
|
file.write("\n")
|
|
|
|
file.write("FORCEACTIVE {\n")
|
|
for f in FORCE_ACTIVE:
|
|
file.write('\t"%s"\n' % f)
|
|
file.write("\n")
|
|
|
|
file.write("\t/* unreferenced symbols */\n")
|
|
for x in module0.SYMBOLS:
|
|
k = x["label"]
|
|
if x["type"] == "StringBase":
|
|
continue
|
|
|
|
require_force_active = False
|
|
|
|
# if the symbol is not reachable from the __start add it as forceactive
|
|
if not x["is_reachable"] or sum(x["r"]) == 0:
|
|
require_force_active = True
|
|
|
|
if require_force_active:
|
|
file.write(f"\t\"{x['label']}\"\n")
|
|
if not x["label"] in main_names:
|
|
file.write(f"\t\"{x['name']}\"\n")
|
|
|
|
for x in module0.SYMBOLS:
|
|
if x["type"] == "StringBase":
|
|
continue
|
|
|
|
if x["is_reachable"]:
|
|
if x["label"] != x["name"]:
|
|
file.write(f"\t\"{x['name']}\"\n")
|
|
|
|
for symbol in symbols:
|
|
if not symbol.name:
|
|
continue
|
|
|
|
if "__template" in symbol.name:
|
|
file.write('\t"%s"\n' % (symbol.name))
|
|
|
|
file.write("\n")
|
|
file.write("}\n")
|
|
file.write("\n")
|
|
|
|
|
|
def rel_lcf_generate(module_index, output_path):
|
|
|
|
module = importlib.import_module(f"module{module_index}")
|
|
base = dol2asm_settings.REL_TEMP_LOCATION[
|
|
module.LIBRARIES[0].split("/")[-1] + ".rel"
|
|
]
|
|
|
|
# load object files from the 'build/o_files', this way we need no list of
|
|
# object files in the python code.
|
|
with open(f"build/M{module_index}_ofiles", "r") as content_file:
|
|
all_files = content_file.read().strip().split(" ")
|
|
|
|
path = f"build/dolzel2/rel/{module.LIBRARIES[0]}"
|
|
|
|
archives = [path for path in all_files if path.endswith(".a")]
|
|
|
|
o_files = [path for path in all_files if path.endswith(".o")]
|
|
|
|
# load symbols from compiled files
|
|
symbols = []
|
|
for archive in archives:
|
|
symbols.extend(load_archive(archive))
|
|
|
|
for o_file in o_files:
|
|
with open(o_file, "rb") as file:
|
|
obj = libelf.load_object_from_file(None, o_file, file)
|
|
symbols.extend(get_symbols_from_object_file(obj))
|
|
|
|
# write rel ldscript file
|
|
with output_path.open("w") as file:
|
|
file.write("SECTIONS {\n")
|
|
file.write(f"\t__rel_base = .;\n")
|
|
file.write("\tGROUP:{\n")
|
|
for name, align in REL_SECTIONS:
|
|
file.write(f"\t\t{name} :{{}}\n")
|
|
|
|
# file.write("\t\t/DISCARD/ : { *(.dead) }\n")
|
|
|
|
file.write("\t}\n")
|
|
|
|
file.write("\n")
|
|
file.write("\t/* missing symbols */\n")
|
|
|
|
# improve decompilation workflow by making so that function
|
|
# which, for what ever reason, cannot be named the same as
|
|
# the expected name to work. This will happen for all symbols
|
|
# with weird characters.
|
|
base_names = set(module.SYMBOL_NAMES.keys())
|
|
main_names = set([sym.name for sym in symbols])
|
|
names = base_names - main_names
|
|
for name in names:
|
|
symbol = module.SYMBOLS[module.SYMBOL_NAMES[name]]
|
|
if symbol["type"] == "StringBase": # @stringBase0 is handled below
|
|
continue
|
|
if symbol["type"] == "LinkerGenerated": # linker handles these symbols
|
|
continue
|
|
|
|
file.write(
|
|
f"\t\"{symbol['label']}\" = __rel_base + 0x{symbol['addr'] - base:08X}; /* 0x{symbol['addr']:08X} */\n"
|
|
)
|
|
file.write("\n")
|
|
|
|
file.write("}\n")
|
|
file.write("\n")
|
|
|
|
file.write("FORCEACTIVE {\n")
|
|
file.write("\t_prolog\n")
|
|
file.write("\t_epilog\n")
|
|
file.write("\t_unresolved\n")
|
|
file.write("\n")
|
|
|
|
file.write("\t/* unreferenced symbols */\n")
|
|
for x in module.SYMBOLS:
|
|
k = x["label"]
|
|
if x["type"] == "StringBase":
|
|
continue
|
|
|
|
require_force_active = False
|
|
|
|
# if the symbol is not reachable from the __start add it as forceactive
|
|
if not x["is_reachable"] and not x["static"]:
|
|
require_force_active = True
|
|
|
|
if require_force_active:
|
|
file.write(f"\t\"{x['label']}\"\n")
|
|
if not x["label"] in main_names:
|
|
file.write(f"\t\"{x['name']}\"\n")
|
|
|
|
for x in module.SYMBOLS:
|
|
if x["type"] == "StringBase":
|
|
continue
|
|
|
|
if x["is_reachable"]:
|
|
if x["label"] != x["name"] and x["name"]:
|
|
file.write(f"\t\"{x['name']}\"\n")
|
|
|
|
for symbol in symbols:
|
|
if not symbol.name:
|
|
continue
|
|
|
|
if "__template" in symbol.name:
|
|
file.write('\t"%s"\n' % (symbol.name))
|
|
|
|
file.write("\n")
|
|
file.write("}\n")
|
|
file.write("\n")
|
|
|
|
|
|
def get_symbols_from_object_file(obj):
|
|
symbols = []
|
|
for sym in obj.symbols:
|
|
if not isinstance(sym, libelf.OffsetSymbol):
|
|
continue
|
|
symbols.append(sym)
|
|
return symbols
|
|
|
|
|
|
def load_archive(ar_path):
|
|
symbols = []
|
|
|
|
print(ar_path)
|
|
archive = libar.read(ar_path)
|
|
for path, data in archive.files:
|
|
obj = libelf.load_object_from_file(None, path, io.BytesIO(data))
|
|
symbols.extend(get_symbols_from_object_file(obj))
|
|
|
|
return symbols
|
|
|
|
|
|
SECTIONS = [
|
|
(".init", 0x20),
|
|
("extab_", 0x20),
|
|
("extabindex_", 0x20),
|
|
(".text", 0x20),
|
|
(".ctors", 0x20),
|
|
(".dtors", 0x20),
|
|
(".rodata", 0x20),
|
|
(".data", 0x20),
|
|
(".bss", 0x20),
|
|
(".sdata", 0x20),
|
|
(".sbss", 0x20),
|
|
(".sdata2", 0x20),
|
|
(".sbss2", 0x20),
|
|
(".stack", 0x100),
|
|
# (".dead", 0x100),
|
|
]
|
|
|
|
REL_SECTIONS = [
|
|
(".init", 0x4),
|
|
(".text", 0x4),
|
|
(".ctors", 0x4),
|
|
(".dtors", 0x4),
|
|
(".rodata", 0x4),
|
|
(".data", 0x8),
|
|
(".bss", 0x8),
|
|
(".dead", 0x8),
|
|
]
|
|
|
|
|
|
# custom force actives
|
|
FORCE_ACTIVE = []
|
|
|
|
ARCHIVES = [
|
|
"build/dolzel2/libSComponent.a",
|
|
"build/dolzel2/libSStandard.a",
|
|
"build/dolzel2/libJFramework.a",
|
|
"build/dolzel2/libJ3DU.a",
|
|
"build/dolzel2/libJParticle.a",
|
|
"build/dolzel2/libJStage.a",
|
|
"build/dolzel2/libJStudio.a",
|
|
"build/dolzel2/libJStudio_JStage.a",
|
|
"build/dolzel2/libJStudio_JAudio2.a",
|
|
"build/dolzel2/libJStudio_JParticle.a",
|
|
"build/dolzel2/libJAudio2.a",
|
|
"build/dolzel2/libJMessage.a",
|
|
"build/dolzel2/libZ2AudioLib.a",
|
|
"build/dolzel2/libgf.a",
|
|
"build/dolzel2/libJKernel.a",
|
|
"build/dolzel2/libJSupport.a",
|
|
"build/dolzel2/libJGadget.a",
|
|
"build/dolzel2/libJUtility.a",
|
|
"build/dolzel2/libJ2DGraph.a",
|
|
"build/dolzel2/libJ3DGraphBase.a",
|
|
"build/dolzel2/libJ3DGraphAnimator.a",
|
|
"build/dolzel2/libJ3DGraphLoader.a",
|
|
"build/dolzel2/libJMath.a",
|
|
"build/dolzel2/libbase.a",
|
|
"build/dolzel2/libos.a",
|
|
"build/dolzel2/libexi.a",
|
|
"build/dolzel2/libsi.a",
|
|
"build/dolzel2/libdb.a",
|
|
"build/dolzel2/libmtx.a",
|
|
"build/dolzel2/libdvd.a",
|
|
"build/dolzel2/libvi.a",
|
|
"build/dolzel2/libpad.a",
|
|
"build/dolzel2/libai.a",
|
|
"build/dolzel2/libar.a",
|
|
"build/dolzel2/libdsp.a",
|
|
"build/dolzel2/libcard.a",
|
|
"build/dolzel2/libgx.a",
|
|
"build/dolzel2/libgd.a",
|
|
"build/dolzel2/libRuntime.PPCEABI.H.a",
|
|
"build/dolzel2/libMSL_C.PPCEABI.bare.H.a",
|
|
"build/dolzel2/libTRK_MINNOW_DOLPHIN.a",
|
|
"build/dolzel2/libamcstubs.a",
|
|
"build/dolzel2/libodemuexi2.a",
|
|
"build/dolzel2/libodenotstub.a",
|
|
]
|
|
|
|
|
|
class PathPath(click.Path):
|
|
def convert(self, value, param, ctx):
|
|
return Path(super().convert(value, param, ctx))
|
|
|
|
|
|
@click.group()
|
|
@click.version_option(VERSION)
|
|
def lcf():
|
|
pass
|
|
|
|
|
|
@lcf.command(name="dol")
|
|
@click.option(
|
|
"--output",
|
|
"-o",
|
|
"output_path",
|
|
required=False,
|
|
type=PathPath(file_okay=True, dir_okay=False),
|
|
default="build/dolzel2/ldscript.lcf",
|
|
)
|
|
def dol(output_path):
|
|
lcf_generate(output_path)
|
|
|
|
|
|
@lcf.command(name="rel")
|
|
@click.option(
|
|
"--output",
|
|
"-o",
|
|
"output_path",
|
|
required=False,
|
|
type=PathPath(file_okay=True, dir_okay=False),
|
|
default="build/dolzel2/ldscript.lcf",
|
|
)
|
|
@click.argument("module", metavar="<MODULE>", nargs=1)
|
|
def rel(output_path, module):
|
|
rel_lcf_generate(module, output_path)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
lcf()
|