mirror of
https://github.com/zeldaret/botw
synced 2026-05-23 15:01:35 -04:00
Léo Lam
f4740f07e7
This project is not going to decompile libcurl and NEX. It's just not the main focus of the project and it's unlikely to yield any kind of interesting information. PosTrackerUploader and possibly the network save transfer stuff do use NEX but those are secondary, possibly debug-only features. Furthermore decompiling those two systems does not require actually implementing the entirely of libcurl+NEX (~1MB); we just have to write "API stubs" (headers) for the few parts of NEX that are used by BotW code.
129 lines
3.7 KiB
Python
129 lines
3.7 KiB
Python
import io
|
|
|
|
from colorama import Fore, Style
|
|
import csv
|
|
import warnings
|
|
import enum
|
|
from pathlib import Path
|
|
import sys
|
|
import typing as tp
|
|
|
|
try:
|
|
import cxxfilt
|
|
except:
|
|
# cxxfilt cannot be used on Windows.
|
|
warnings.warn("cxxfilt could not be imported; demangling functions will fail")
|
|
|
|
|
|
class FunctionStatus(enum.Enum):
|
|
Matching = 0
|
|
Equivalent = 1 # semantically equivalent but not perfectly matching
|
|
NonMatching = 2
|
|
Wip = 3
|
|
NotDecompiled = 4
|
|
|
|
|
|
class FunctionInfo(tp.NamedTuple):
|
|
addr: int # without the 0x7100000000 base
|
|
name: str
|
|
size: int
|
|
decomp_name: str
|
|
status: FunctionStatus
|
|
raw_row: tp.List[str]
|
|
|
|
|
|
_markers = {
|
|
"?": FunctionStatus.Equivalent,
|
|
"!": FunctionStatus.NonMatching,
|
|
"|": FunctionStatus.Wip,
|
|
}
|
|
|
|
|
|
def parse_function_csv_entry(row) -> FunctionInfo:
|
|
ea, name, size, decomp_name = row
|
|
if decomp_name:
|
|
status = FunctionStatus.Matching
|
|
|
|
for marker, new_status in _markers.items():
|
|
if decomp_name[-1] == marker:
|
|
status = new_status
|
|
decomp_name = decomp_name[:-1]
|
|
break
|
|
else:
|
|
status = FunctionStatus.NotDecompiled
|
|
|
|
addr = int(ea, 16) - 0x7100000000
|
|
return FunctionInfo(addr, name, int(size, 0), decomp_name, status, row)
|
|
|
|
|
|
def get_functions_csv_path() -> Path:
|
|
return get_repo_root() / "data" / "uking_functions.csv"
|
|
|
|
|
|
def get_functions(path: tp.Optional[Path] = None) -> tp.Iterable[FunctionInfo]:
|
|
if path is None:
|
|
path = get_functions_csv_path()
|
|
with path.open() as f:
|
|
reader = csv.reader(f)
|
|
for row in reader:
|
|
try:
|
|
entry = parse_function_csv_entry(row)
|
|
# excluded library function
|
|
if entry.decomp_name == "l":
|
|
continue
|
|
yield entry
|
|
except ValueError as e:
|
|
raise Exception(f"Failed to parse line {reader.line_num}") from e
|
|
|
|
|
|
def add_decompiled_functions(new_matches: tp.Dict[int, str],
|
|
new_orig_names: tp.Optional[tp.Dict[int, str]] = None) -> None:
|
|
buffer = io.StringIO()
|
|
writer = csv.writer(buffer, lineterminator="\n")
|
|
for func in get_functions():
|
|
if new_orig_names is not None and func.status == FunctionStatus.NotDecompiled and func.addr in new_orig_names:
|
|
func.raw_row[1] = new_orig_names[func.addr]
|
|
if func.status == FunctionStatus.NotDecompiled and func.addr in new_matches:
|
|
func.raw_row[3] = new_matches[func.addr]
|
|
writer.writerow(func.raw_row)
|
|
get_functions_csv_path().write_text(buffer.getvalue())
|
|
|
|
|
|
def format_symbol_name(name: str) -> str:
|
|
try:
|
|
return f"{cxxfilt.demangle(name)} {Style.DIM}({name}){Style.RESET_ALL}"
|
|
except:
|
|
return name
|
|
|
|
|
|
def format_symbol_name_for_msg(name: str) -> str:
|
|
try:
|
|
return f"{Fore.BLUE}{cxxfilt.demangle(name)}{Fore.RESET} {Style.DIM}({name}){Style.RESET_ALL}{Style.BRIGHT}"
|
|
except:
|
|
return name
|
|
|
|
|
|
def are_demangled_names_equal(name1: str, name2: str):
|
|
return cxxfilt.demangle(name1) == cxxfilt.demangle(name2)
|
|
|
|
|
|
def print_note(msg: str, prefix: str = ""):
|
|
sys.stderr.write(f"{Style.BRIGHT}{prefix}{Fore.CYAN}note:{Fore.RESET} {msg}{Style.RESET_ALL}\n")
|
|
|
|
|
|
def warn(msg: str, prefix: str = ""):
|
|
sys.stderr.write(f"{Style.BRIGHT}{prefix}{Fore.MAGENTA}warning:{Fore.RESET} {msg}{Style.RESET_ALL}\n")
|
|
|
|
|
|
def print_error(msg: str, prefix: str = ""):
|
|
sys.stderr.write(f"{Style.BRIGHT}{prefix}{Fore.RED}error:{Fore.RESET} {msg}{Style.RESET_ALL}\n")
|
|
|
|
|
|
def fail(msg: str, prefix: str = ""):
|
|
print_error(msg, prefix)
|
|
sys.exit(1)
|
|
|
|
|
|
def get_repo_root() -> Path:
|
|
return Path(__file__).parent.parent.parent
|