mirror of
https://github.com/jkdansereau/goldeneye-pc-port.git
synced 2026-10-23 15:52:42 +02:00
Dan Turner
7b08a04f54
Adds a GitHub-hosted macos-15 (Apple Silicon) workflow for pushes and PRs into the macos branch: build with Homebrew GCC, once with PORT_ADDR_STRICT off and once on, then run the ROM-free address-model self-test. - main.c: new --selftest flag, handled right after portAddrInit() and before crashInit/config/ROM/SDL. Exits 0 if the self-test passed, 1 if not. Listed in --help. - port_addr.c/.h: portAddrSelfTest() now returns its result and portAddrSelfTestPassed() exposes it; no change to normal runs. - macos.yml: contents: read only, no secrets, no ROM, persist-credentials off, so it is safe for fork PRs. The strict entry also requires the GE_ADDRSTRICT_SELFTEST report, proving the validator is live. - docs: building.md CI note; plan M4 row no longer lists macOS CI as outstanding (ROM sweeps stay with the self-hosted job in #131).
216 lines
8.7 KiB
C
216 lines
8.7 KiB
C
/*
|
|
* port_addr.c — the N64 address-space window (see port/include/port_addr.h).
|
|
*
|
|
* On macOS/arm64 the whole window is reserved PROT_NONE up front so that the
|
|
* fixed-address carves (cart, DRAM V1/V2, game-thread stacks, in dram.c /
|
|
* romdata.c / libultra.c) land inside a range the process already owns and
|
|
* cannot collide with libmalloc or the dyld shared cache. Reserving is cheap:
|
|
* PROT_NONE pages are not committed.
|
|
*
|
|
* On Windows/Linux PORT_ADDR_BASE is 0 and this is a no-op beyond recording
|
|
* the image base.
|
|
*/
|
|
|
|
#include <stdint.h>
|
|
#include <stdlib.h>
|
|
|
|
#include "platform.h"
|
|
#include "system.h"
|
|
#include "port_addr.h"
|
|
#ifdef PORT_ADDR_STRICT
|
|
#include <execinfo.h>
|
|
#endif
|
|
|
|
#if defined(PLATFORM_MACOS) && defined(PLATFORM_ARM)
|
|
#include <mach/mach.h>
|
|
#include <mach/mach_vm.h>
|
|
#endif
|
|
|
|
uintptr_t g_portImageBase = 0;
|
|
int g_portUseImageRel = 0;
|
|
|
|
/* Defined by port/src/dram_syms*.s; must equal PORT_ADDR_BASE + 0x70000000. */
|
|
extern unsigned char cfb_16[];
|
|
|
|
/* ROM-free verification of the address model: window round-trips for each
|
|
* region, the absolute-symbol base, and the image-relative encoding. Logs
|
|
* PASS/FAIL for each so a run without a ROM still exercises the core. */
|
|
static int portAddrCheck(const char *what, int ok)
|
|
{
|
|
sysLogPrintf(ok ? LOG_INFO : LOG_ERROR, "portAddr: %-26s %s",
|
|
what, ok ? "PASS" : "FAIL");
|
|
return ok;
|
|
}
|
|
|
|
static int portAddrSelfTest(void)
|
|
{
|
|
const uintptr_t B = (uintptr_t)PORT_ADDR_BASE;
|
|
int ok = 1;
|
|
ok &= portAddrCheck("host->n64 DRAM V1",
|
|
portHostToN64((void *)(B + 0x70001234u)) == 0x70001234u);
|
|
ok &= portAddrCheck("n64->host DRAM V1",
|
|
portN64ToHost(0x70001234u) == (void *)(B + 0x70001234u));
|
|
ok &= portAddrCheck("host->n64 DRAM V2",
|
|
portHostToN64((void *)(B + 0x80005678u)) == 0x80005678u);
|
|
ok &= portAddrCheck("host->n64 cart",
|
|
portHostToN64((void *)(B + 0x10456789u)) == 0x10456789u);
|
|
ok &= portAddrCheck("n64->host cart",
|
|
portN64ToHost(0x10456789u) == (void *)(B + 0x10456789u));
|
|
ok &= portAddrCheck("cfb_16 at base+DRAM_V1",
|
|
(uintptr_t)cfb_16 == B + 0x70000000u);
|
|
ok &= portAddrCheck("in-window: NULL rejected",
|
|
!portAddrIsInWindow(NULL));
|
|
ok &= portAddrCheck("in-window: low guard",
|
|
!portAddrIsInWindow((void *)(B + PORT_ADDR_LOW_GUARD - 1u)));
|
|
ok &= portAddrCheck("in-window: DRAM V1",
|
|
portAddrIsInWindow((void *)(B + 0x70001234u)));
|
|
ok &= portAddrCheck("in-window: above window",
|
|
!portAddrIsInWindow((void *)(B + (uintptr_t)PORT_ADDR_WINDOW)));
|
|
if (g_portUseImageRel) {
|
|
ok &= portAddrCheck("host->n64 image",
|
|
portHostToN64((void *)(g_portImageBase + 0x1234u)) == 0x40001234u);
|
|
ok &= portAddrCheck("n64->host image",
|
|
portN64ToHost(0x40001234u) == (void *)(g_portImageBase + 0x1234u));
|
|
}
|
|
sysLogPrintf(ok ? LOG_INFO : LOG_ERROR, "portAddr: selftest %s",
|
|
ok ? "ALL PASS" : "FAILURES");
|
|
return ok;
|
|
}
|
|
|
|
static int g_portAddrSelfTestOk = 0;
|
|
|
|
int portAddrSelfTestPassed(void)
|
|
{
|
|
return g_portAddrSelfTestOk;
|
|
}
|
|
|
|
#ifdef PORT_ADDR_STRICT
|
|
/*
|
|
* Strict address validation (-DPORT_ADDR_STRICT=1, off by default).
|
|
*
|
|
* Every bug in the MACOS-SFX-BOUND through MACOS-TEXALIGN family reaches portN64ToHost() holding a value
|
|
* that is not a real N64 address -- either a host pointer truncated to 32 bits
|
|
* or an address that was never re-based. The fault then happens later, in
|
|
* unrelated code, which is what made these expensive to find. This checks the
|
|
* value against the regions the port actually maps and reports the bad ones
|
|
* at the point of conversion, naming the caller.
|
|
*
|
|
* Regions (see port/include/port_addr.h and port/src/dram.c):
|
|
* 0x10000000..0x1fffffff cart image + pcmodels/pccg sidecars
|
|
* 0x40000000..0x6fffffff image-relative encoding (exe globals)
|
|
* 0x70000000..0x707fffff DRAM V1
|
|
* 0x80000000..0x807fffff DRAM V2 (KSEG0 mirror of V1)
|
|
* 0xa0000000..0xbfffffff game-thread stacks
|
|
* Segmented DL addresses (0x00000000..0x0fffffff) never name host memory and
|
|
* are resolved by fast3d's seg_addr(), not here -- so they are reported too.
|
|
*/
|
|
static int portAddrRegionOk(uint32_t a)
|
|
{
|
|
if (a >= 0x10000000u && a <= 0x1fffffffu) return 1; /* cart + sidecars */
|
|
if (a >= 0x40000000u && a <= 0x6fffffffu) return 1; /* image-relative */
|
|
if (a >= 0x70000000u && a <= 0x707fffffu) return 1; /* DRAM V1 */
|
|
if (a >= 0x80000000u && a <= 0x807fffffu) return 1; /* DRAM V2 */
|
|
if (a >= 0xa0000000u && a <= 0xbfffffffu) return 1; /* thread stacks */
|
|
return 0;
|
|
}
|
|
|
|
/* Negative self-test: GE_ADDRSTRICT_SELFTEST=1 feeds the validator a value
|
|
* that is deliberately not a mapped N64 address, so a run can prove the
|
|
* detector is actually live rather than merely silent. */
|
|
void portAddrStrictSelfTest(void)
|
|
{
|
|
if (getenv("GE_ADDRSTRICT_SELFTEST")) {
|
|
sysLogPrintf(LOG_INFO, "PORT_ADDR_STRICT: self-test, expect one report below");
|
|
portAddrStrictCheck(0x30000000u); /* in the gap between cart and image-rel */
|
|
}
|
|
}
|
|
|
|
void portAddrStrictCheck(uint32_t a)
|
|
{
|
|
/* Report each distinct bad value once -- a bad pointer in a per-frame path
|
|
* would otherwise emit thousands of identical lines and bury the first. */
|
|
enum { SEEN_MAX = 64 };
|
|
static uint32_t seen[SEEN_MAX];
|
|
static int seenCount;
|
|
int i;
|
|
|
|
if (portAddrRegionOk(a)) {
|
|
return;
|
|
}
|
|
|
|
for (i = 0; i < seenCount; i++) {
|
|
if (seen[i] == a) {
|
|
return;
|
|
}
|
|
}
|
|
if (seenCount < SEEN_MAX) {
|
|
seen[seenCount++] = a;
|
|
}
|
|
|
|
sysLogPrintf(LOG_ERROR,
|
|
"PORT_ADDR_STRICT: 0x%08x is not a mapped N64 address "
|
|
"(-> %p). Truncated host pointer, or an address that was "
|
|
"never re-based (MACOS-SFX-BOUND through MACOS-TEXALIGN class).",
|
|
(unsigned)a, (void *)((uintptr_t)PORT_ADDR_BASE + (uintptr_t)a));
|
|
#if defined(PLATFORM_MACOS) || defined(__APPLE__) || defined(__linux__)
|
|
{
|
|
void *bt[24];
|
|
int n = backtrace(bt, (int)(sizeof(bt) / sizeof(bt[0])));
|
|
/* Skip frame 0 (this function); the caller is what matters. */
|
|
if (n > 1) {
|
|
backtrace_symbols_fd(bt + 1, n - 1, 2);
|
|
}
|
|
}
|
|
#endif
|
|
}
|
|
#endif /* PORT_ADDR_STRICT */
|
|
|
|
void portAddrInit(void)
|
|
{
|
|
g_portImageBase = sysImageBase();
|
|
/* The image needs the 0x40000000 encoding iff it lies outside the window,
|
|
* i.e. its address does not survive a u32 truncation. False on Linux
|
|
* (image at 0x20000000, inside the window), true on Windows (0x140000000)
|
|
* and macOS (0x1_00xxxxxx + slide). */
|
|
g_portUseImageRel = (g_portImageBase >= (uintptr_t)PORT_ADDR_WINDOW) ? 1 : 0;
|
|
|
|
#if PORT_ADDR_BASE != 0
|
|
{
|
|
/* Non-clobbering: VM_FLAGS_FIXED without VM_FLAGS_OVERWRITE fails with
|
|
* KERN_NO_SPACE if the range is already in use, rather than silently
|
|
* replacing a live mapping (mmap MAP_FIXED on macOS does the latter). */
|
|
mach_vm_address_t addr = (mach_vm_address_t)PORT_ADDR_BASE;
|
|
kern_return_t kr = mach_vm_map(mach_task_self(), &addr,
|
|
(mach_vm_size_t)PORT_ADDR_WINDOW, 0,
|
|
VM_FLAGS_FIXED, MEMORY_OBJECT_NULL, 0, FALSE,
|
|
VM_PROT_NONE, VM_PROT_ALL, VM_INHERIT_DEFAULT);
|
|
if (kr != KERN_SUCCESS || addr != (mach_vm_address_t)PORT_ADDR_BASE) {
|
|
sysFatalError("portAddr: cannot reserve the 4 GiB N64 window at "
|
|
"0x%llx (%s). See docs/dev/MACOS-ARM64-PLAN.md sec 2.",
|
|
(unsigned long long)PORT_ADDR_BASE, mach_error_string(kr));
|
|
}
|
|
}
|
|
#endif
|
|
|
|
/* The committed .darwin.s absolute symbols must have been generated with
|
|
* the same --base; cfb_16 is a region-independent sentinel for that. */
|
|
if ((uintptr_t)cfb_16 != (uintptr_t)PORT_ADDR_BASE + 0x70000000ULL) {
|
|
sysFatalError("portAddr: dram_syms base mismatch (cfb_16=%p, expected 0x%llx). "
|
|
"Regenerate with: scripts/gen_romassets.py <region> --darwin "
|
|
"--base 0x%llx --rom-size <size> --out ... --dram-out ...",
|
|
(void *)cfb_16,
|
|
(unsigned long long)((uintptr_t)PORT_ADDR_BASE + 0x70000000ULL),
|
|
(unsigned long long)PORT_ADDR_BASE);
|
|
}
|
|
|
|
sysLogPrintf(LOG_INFO, "portAddr: window base=0x%llx image=0x%llx image_rel=%d",
|
|
(unsigned long long)PORT_ADDR_BASE,
|
|
(unsigned long long)g_portImageBase, g_portUseImageRel);
|
|
|
|
g_portAddrSelfTestOk = portAddrSelfTest();
|
|
|
|
#ifdef PORT_ADDR_STRICT
|
|
portAddrStrictSelfTest();
|
|
#endif
|
|
}
|