Files
NX2navi/tests/frame_step_check.py
chrg6 a74503cd86 Add physics_steps = 2: at least a 60 fps frame's solver steps in every update on 1.1.1.
Link is carried by the Deku Tree's floating platform fully at 60 fps, about a tenth at 160 and not at all at 240,
which follows the solver steps an update (4, 2, 1 with physics_steps = 1) rather than those a second. The new set
osolverfull raises the rounded-up count to the 60 Hz frame's 4 in every update; physics_steps = 2 switches it on and
osolver off at start, and the mode is logged. 60 and 30 fps keep the game's 4 and 8. It costs more physics time above
60 fps: 576 solver steps a second at 144 fps and 960 at 240, against 288 and 240 with 1, the default, which stays
until a run confirms the carry. frame_step_check runs the lifted words of all three counts.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 06:26:39 -05:00

114 lines
5.2 KiB
Python

"""Build and run tests/frame_step_check.c: the step runtime/frame_rate.c gives Ocarina, with the rest of the runtime
stubbed. No game files: the module layout the runtime includes is a stand-in written to the test's build folder.
Usage: frame_step_check.py
"""
import os
import shutil
import subprocess
import sys
from pathlib import Path
ROOT = Path(__file__).resolve().parents[1]
MSYS_BIN = Path(r'C:\msys64\ucrt64\bin')
sys.path[:0] = [str(ROOT), str(ROOT / 'recomp')]
from lifter import Lifter # noqa: E402
from patches import load # noqa: E402
from tools.check_content import GENERATED_MARKER # noqa: E402
PAGE = 0x4ea0000 # the patch page of 1.1.1, main+0x4ea0000
# The sites that call frame_rate.c's hosts, as recomp/patches-v111.txt has them: set, module offset, the original word,
# the words before the bl (the original's own, where the host comes after it), the page offset the bl reaches.
FDIV = 0x1e201900 # fdiv s0, s8, s0
HOST_SITES = [('ostep', 0x3cdfc0, 0x1e380008, [], 0xf60), ('ostep', 0x475f8, 0x1e380009, [], 0xf50),
('owater', 0x3876014, FDIV, [FDIV], 0xf20), ('owater', 0x38827f8, FDIV, [FDIV], 0xf20),
('owater', 0x632cfc, FDIV, [FDIV], 0xf20),
('osound', 0x41531c, 0x910083fd, [0x910083fd], 0xf10), ('osound', 0x415334, 0xbd401100, [0xbd401100], 0xf00)]
def compiler():
if os.environ.get('CC'):
return os.environ['CC']
if os.name == 'nt' and (MSYS_BIN / 'clang.exe').exists():
return str(MSYS_BIN / 'clang.exe')
return shutil.which('clang') or 'clang'
LAYOUT = '''// A stand-in for the generated layout.h (tests/frame_step_check.py).
#pragma once
#define MOD_MAIN_BASE 0x7000000000ull
#define MOD_MAIN_SIZE 0x4ea0000ull
'''
def check_sites():
"""Each host site is its listed words and one bl to its page slot, over its original word."""
table = load(ROOT / 'recomp/patches-v111.txt', [('main', 0x7000000000, PAGE)])
bad = 0
for name, site, original, before, slot in HOST_SITES:
(key, words, have), = table.sites['main'][site]
bl = words[-1] if isinstance(words[-1], int) else 0
target = site + (((bl & 0x3ffffff) ^ 0x2000000) - 0x2000000) * 4
ok = (table.sets[key][0] == name and have == original and words[:-1] == before and bl >> 26 == 0x25 and
target == PAGE + slot)
if not ok:
print(f'FAIL: the site main+{site:#x} of set {name} is {words} over {have:#x}')
bad += 1
return bad
# The solver step count's words at the step setup's first copy (main+0x38aebe4..0x38aebf4; the second copy at
# main+0x38afd10 has the same words): the original's, the set osolver's and the set osolverfull's, lifted as the
# generator lifts them into one C function each, with the scvtf between them (main+0x38aebec) that every variant keeps.
SOLVER_SITES = (0x38aebe4, 0x38aebf0, 0x38aebf4)
SOLVER_COPY = (0x38afd10, 0x38afd1c, 0x38afd20)
SCVTF = 0x5e21d821 # scvtf s1, s1
def solver_functions():
table = load(ROOT / 'recomp/patches-v111.txt', [('main', 0x7000000000, PAGE)])
names = {i: t[0] for i, t in enumerate(table.sets)}
variants = {'game': [], 'osolver': [], 'osolverfull': []}
for site, copy in zip(SOLVER_SITES, SOLVER_COPY):
alts = {names[key]: (words, have) for key, words, have in table.sites['main'][site]}
copies = {names[key]: (words, have) for key, words, have in table.sites['main'][copy]}
assert set(alts) == {'osolver', 'osolverfull'} and alts == copies, (hex(site), alts, copies)
original = alts['osolver'][1]
variants['game'].append([original])
for name in ('osolver', 'osolverfull'):
variants[name].append(alts[name][0])
lift = Lifter(0, simd='c')
out = [f'// {GENERATED_MARKER}: the solver step count words lifted by tests/frame_step_check.py.',
'#include "cpu.h"', '#include "simd.h"', '']
for name, sites in variants.items():
body = []
for k, words in enumerate(sites):
for w in words:
insn = lift.lift(w, 0x7000000000 + SOLVER_SITES[k])
assert insn.kind == 'op', (name, hex(w), insn.kind)
body.append(' ' + insn.code)
if k == 0:
body.append(' ' + lift.lift(SCVTF, 0x70038aebec).code)
out.append(f'void solver_{name}(Cpu *c) {{\n' + '\n'.join(body) + '\n}\n')
return '\n'.join(out)
def main():
work = ROOT / 'build' / 'test' / 'frame_step'
work.mkdir(parents=True, exist_ok=True)
(work / 'layout.h').write_text(LAYOUT)
exe = work / ('frame_step_check.exe' if os.name == 'nt' else 'frame_step_check')
solver = work / 'solver_sites.c'
solver.write_text(solver_functions())
env = dict(os.environ)
if os.name == 'nt' and MSYS_BIN.exists():
env['PATH'] = str(MSYS_BIN) + os.pathsep + env.get('PATH', '')
subprocess.check_call([compiler(), '-O1', '-Wall', '-Wno-unused-function', '-fno-strict-aliasing',
'-I', str(ROOT / 'runtime'), '-I', str(work),
str(ROOT / 'tests' / 'frame_step_check.c'), str(solver), '-o', str(exe), '-lm'], env=env)
rc = subprocess.run([str(exe)], env=env).returncode
return subprocess.run([str(exe), 'mean'], env=env).returncode or rc or check_sites()
if __name__ == '__main__':
sys.exit(main())