GBA code unit testing front-end (#2411)

src/platform/test/CMakeLists.txt

@@ -46,3 +46,10 @@ if(BUILD_CINEMA)
 	add_test(cinema ${BINARY_NAME}-cinema -v)
 	install(TARGETS ${BINARY_NAME}-cinema DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT ${BINARY_NAME}-test)
 endif()
+
+if(BUILD_ROM_TEST)
+	add_executable(${BINARY_NAME}-rom-test ${CMAKE_CURRENT_SOURCE_DIR}/rom-test-main.c)
+	target_link_libraries(${BINARY_NAME}-rom-test ${BINARY_NAME})
+	target_compile_definitions(${BINARY_NAME}-rom-test PRIVATE "${OS_DEFINES};${FEATURE_DEFINES};${FUNCTION_DEFINES}")
+	install(TARGETS ${BINARY_NAME}-rom-test DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT ${BINARY_NAME}-test)
+endif()

src/platform/test/rom-test-main.c

@@ -0,0 +1,220 @@
+/* Copyright (c) 2013-2022 Jeffrey Pfau
+*  Copyright (c) 2022 Felix Jones
+*
+* This Source Code Form is subject to the terms of the Mozilla Public
+* License, v. 2.0. If a copy of the MPL was not distributed with this
+* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include <mgba/core/cheats.h>
+#include <mgba/core/config.h>
+#include <mgba/core/core.h>
+#include <mgba/core/serialize.h>
+#include <mgba/internal/gba/gba.h>
+
+#include <mgba/feature/commandline.h>
+#include <mgba-util/vfs.h>
+
+#include <signal.h>
+
+#define ROM_TEST_OPTIONS "S:R:"
+#define ROM_TEST_USAGE \
+	"\nAdditional options:\n" \
+	"  -S SWI           Run until specified SWI call before exiting\n" \
+	"  -R REGISTER      General purpose register to return as exit code\n" \
+
+struct RomTestOpts {
+	int exitSwiImmediate;
+	unsigned int returnCodeRegister;
+};
+
+static void _romTestShutdown(int signal);
+static bool _parseRomTestOpts(struct mSubParser* parser, int option, const char* arg);
+static bool _parseSwi(const char* regStr, int* oSwi);
+static bool _parseNamedRegister(const char* regStr, unsigned int* oRegister);
+
+static bool _dispatchExiting = false;
+static int _exitCode = 0;
+
+#ifdef M_CORE_GBA
+static void _romTestSwi3Callback(void* context);
+
+static void _romTestSwi16(struct ARMCore* cpu, int immediate);
+static void _romTestSwi32(struct ARMCore* cpu, int immediate);
+
+static int _exitSwiImmediate;
+static unsigned int _returnCodeRegister;
+
+void (*_armSwi16)(struct ARMCore* cpu, int immediate);
+void (*_armSwi32)(struct ARMCore* cpu, int immediate);
+#endif
+
+int main(int argc, char * argv[]) {
+	signal(SIGINT, _romTestShutdown);
+
+	struct RomTestOpts romTestOpts = { 3, 0 };
+	struct mSubParser subparser = {
+		.usage = ROM_TEST_USAGE,
+		.parse = _parseRomTestOpts,
+		.extraOptions = ROM_TEST_OPTIONS,
+		.opts = &romTestOpts
+	};
+
+	struct mArguments args;
+	bool parsed = parseArguments(&args, argc, argv, &subparser);
+	if (!args.fname) {
+		parsed = false;
+	}
+	if (!parsed || args.showHelp) {
+		usage(argv[0], ROM_TEST_USAGE);
+		return !parsed;
+	}
+	if (args.showVersion) {
+		version(argv[0]);
+		return 0;
+	}
+	struct mCore* core = mCoreFind(args.fname);
+	if (!core) {
+		return 1;
+	}
+	core->init(core);
+	mCoreInitConfig(core, "romTest");
+	applyArguments(&args, NULL, &core->config);
+
+	mCoreConfigSetDefaultValue(&core->config, "idleOptimization", "remove");
+
+#ifdef M_CORE_GBA
+	if (core->platform(core) == mPLATFORM_GBA) {
+		((struct GBA*) core->board)->hardCrash = false;
+
+		_exitSwiImmediate = romTestOpts.exitSwiImmediate;
+		_returnCodeRegister = romTestOpts.returnCodeRegister;
+
+		if (_exitSwiImmediate == 3) {
+			// Hook into SWI 3 (shutdown)
+			struct mCoreCallbacks callbacks = {0};
+			callbacks.context = core;
+			callbacks.shutdown = _romTestSwi3Callback;
+			core->addCoreCallbacks(core, &callbacks);
+		} else {
+			// Custom SWI hooks
+			_armSwi16 = ((struct GBA*) core->board)->cpu->irqh.swi16;
+			((struct GBA*) core->board)->cpu->irqh.swi16 = _romTestSwi16;
+			_armSwi32 = ((struct GBA*) core->board)->cpu->irqh.swi32;
+			((struct GBA*) core->board)->cpu->irqh.swi32 = _romTestSwi32;
+		}
+	}
+#endif
+
+	bool cleanExit = true;
+	if (!mCoreLoadFile(core, args.fname)) {
+		cleanExit = false;
+		goto loadError;
+	}
+	if (args.patch) {
+		core->loadPatch(core, VFileOpen(args.patch, O_RDONLY));
+	}
+
+	struct VFile* savestate = NULL;
+
+	if (args.savestate) {
+		savestate = VFileOpen(args.savestate, O_RDONLY);
+	}
+
+	core->reset(core);
+
+	struct mCheatDevice* device;
+	if (args.cheatsFile && (device = core->cheatDevice(core))) {
+		struct VFile* vf = VFileOpen(args.cheatsFile, O_RDONLY);
+		if (vf) {
+			mCheatDeviceClear(device);
+			mCheatParseFile(device, vf);
+			vf->close(vf);
+		}
+	}
+
+	if (savestate) {
+		mCoreLoadStateNamed(core, savestate, 0);
+		savestate->close(savestate);
+	}
+
+	do {
+		core->runLoop(core);
+	} while (!_dispatchExiting);
+
+	core->unloadROM(core);
+
+loadError:
+	freeArguments(&args);
+	mCoreConfigDeinit(&core->config);
+	core->deinit(core);
+
+	return cleanExit ? _exitCode : 1;
+}
+
+static void _romTestShutdown(int signal) {
+	UNUSED(signal);
+	_dispatchExiting = true;
+}
+
+#ifdef M_CORE_GBA
+static void _romTestSwi3Callback(void* context) {
+	struct mCore* core = context;
+	_exitCode = ((struct GBA*) core->board)->cpu->regs.gprs[_returnCodeRegister];
+	_dispatchExiting = true;
+}
+
+static void _romTestSwi16(struct ARMCore* cpu, int immediate) {
+	if (immediate == _exitSwiImmediate) {
+		_exitCode = cpu->regs.gprs[_returnCodeRegister];
+		_dispatchExiting = true;
+		return;
+	}
+	_armSwi16(cpu, immediate);
+}
+
+static void _romTestSwi32(struct ARMCore* cpu, int immediate) {
+	if (immediate == _exitSwiImmediate) {
+		_exitCode = cpu->regs.gprs[_returnCodeRegister];
+		_dispatchExiting = true;
+		return;
+	}
+	_armSwi32(cpu, immediate);
+}
+#endif
+
+static bool _parseRomTestOpts(struct mSubParser* parser, int option, const char* arg) {
+	struct RomTestOpts* opts = parser->opts;
+	errno = 0;
+	switch (option) {
+	case 'S':
+		return _parseSwi(arg, &opts->exitSwiImmediate);
+	case 'R':
+		return _parseNamedRegister(arg, &opts->returnCodeRegister);
+	default:
+		return false;
+	}
+}
+
+static bool _parseSwi(const char* swiStr, int* oSwi) {
+	char* parseEnd;
+	long swi = strtol(swiStr, &parseEnd, 0);
+	if (errno || swi > UINT8_MAX || *parseEnd) {
+		return false;
+	}
+	*oSwi = swi;
+	return true;
+}
+
+static bool _parseNamedRegister(const char* regStr, unsigned int* oRegister) {
+	if (regStr[0] == 'r' || regStr[0] == 'R') {
+		++regStr;
+	}
+
+	char* parseEnd;
+	unsigned long regId = strtoul(regStr, &parseEnd, 10);
+	if (errno || regId > 15 || *parseEnd) {
+		return false;
+	}
+	*oRegister = regId;
+	return true;
+}