Initial commit

backends/plugins/psp2/plugin.cpp

@@ -0,0 +1,113 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+// Disable symbol overrides so that we can use system headers.
+#define FORBIDDEN_SYMBOL_ALLOW_ALL
+
+#include "common/scummsys.h"
+
+#if defined(DYNAMIC_MODULES) && defined(PSP2)
+
+#include <cxxabi.h>
+#include <psp2/kernel/modulemgr.h>
+
+#include "base/plugins.h"
+#include "backends/plugins/psp2/psp2-plugin.h"
+
+extern "C" {
+
+int32 PLUGIN_getVersion();
+int32 PLUGIN_getType();
+int32 PLUGIN_getTypeVersion();
+PluginObject *PLUGIN_getObject();
+
+static PSP2FunctionPointers PSP2Functions = {
+	PSP2FunctionPointers_VERSION,
+	PLUGIN_getVersion,
+	PLUGIN_getType,
+	PLUGIN_getTypeVersion,
+	PLUGIN_getObject,
+};
+
+// hacks to make libc work
+//void* __dso_handle = (void*) &__dso_handle;
+extern void *__dso_handle __attribute__((weak));
+
+/* These magic symbols are provided by the linker.  */
+extern void (*__preinit_array_start []) (void) __attribute__((weak));
+extern void (*__preinit_array_end []) (void) __attribute__((weak));
+extern void (*__init_array_start []) (void) __attribute__((weak));
+extern void (*__init_array_end []) (void) __attribute__((weak));
+extern void (*__fini_array_start [])(void) __attribute__((weak));
+extern void (*__fini_array_end [])(void) __attribute__((weak));
+
+static void __libc_init_array(void) {
+	size_t count, i;
+
+	count = __preinit_array_end - __preinit_array_start;
+	for (i = 0; i < count; i++) {
+		__preinit_array_start[i]();
+	}
+
+	count = __init_array_end - __init_array_start;
+	for (i = 0; i < count; i++) {
+		__init_array_start[i]();
+	}
+}
+
+static void __libc_fini_array(void) {
+	size_t count, i;
+
+	count = __fini_array_end - __fini_array_start;
+	for (i = count; i > 0; i--) {
+		__fini_array_start[i-1]();
+	}
+}
+
+int module_stop(SceSize argc, const void *args) {
+	if (&__dso_handle != nullptr) {
+		__cxxabiv1::__cxa_finalize(&__dso_handle);
+	}
+	__libc_fini_array();
+	return SCE_KERNEL_STOP_SUCCESS;
+}
+
+int module_exit() {
+	if (&__dso_handle != nullptr) {
+		__cxxabiv1::__cxa_finalize(&__dso_handle);
+	}
+	__libc_fini_array();
+	return SCE_KERNEL_STOP_SUCCESS;
+}
+
+int _start(SceSize argc, void *args) __attribute__ ((weak, alias ("module_start")));
+int module_start(SceSize argc, void *args) {
+	PSP2FunctionPointers **arg = *(PSP2FunctionPointers ***)args;
+
+	__libc_init_array();
+
+	*arg = &PSP2Functions;
+
+	return SCE_KERNEL_START_SUCCESS;
+}
+
+}
+#endif // defined(DYNAMIC_MODULES) && defined(PSP2)

backends/plugins/psp2/plugin.yml

@@ -0,0 +1,9 @@
+plugin:
+  attributes: 0
+  version:
+    major: 1
+    minor: 1
+  main:
+    start: module_start
+    stop: module_stop
+    exit: module_exit

backends/plugins/psp2/psp2-plugin.h

@@ -0,0 +1,41 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef BACKENDS_PLUGINS_PSP2_PLUGIN_H
+#define BACKENDS_PLUGINS_PSP2_PLUGIN_H
+
+#if defined(DYNAMIC_MODULES) && defined(PSP2)
+
+struct PSP2FunctionPointers {
+	uint32 version;
+	int32 (*PLUGIN_getVersion)();
+	int32 (*PLUGIN_getType)();
+	int32 (*PLUGIN_getTypeVersion)();
+	PluginObject *(*PLUGIN_getObject)();
+};
+
+// Increment this when modifying the structure above
+#define PSP2FunctionPointers_VERSION 1
+
+#endif // defined(DYNAMIC_MODULES) && defined(PSP2)
+
+#endif
+

backends/plugins/psp2/psp2-provider.cpp

@@ -0,0 +1,163 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+// Disable symbol overrides so that we can use system headers.
+#define FORBIDDEN_SYMBOL_ALLOW_ALL
+
+#include "common/scummsys.h"
+
+#if defined(DYNAMIC_MODULES) && defined(PSP2)
+
+#include <psp2/kernel/modulemgr.h>
+
+#include "backends/plugins/psp2/psp2-provider.h"
+#include "backends/plugins/psp2/psp2-plugin.h"
+#include "common/debug.h"
+#include "common/fs.h"
+
+// HACK: This is needed so that standard library functions that are only
+// used in plugins can be found in the main executable.
+#include <cxxabi.h>
+void *forceLinkFunctions[] = {
+	// Select the nothrow variant
+	(void *)(void *(*)(std::size_t, std::nothrow_t const&))operator new [],
+	(void *)coshf,
+	(void *)fgetc,
+	(void *)frexpf,
+	(void *)getc,
+	(void *)log2f,
+	(void *)mbstowcs,
+	// Select the double version
+	(void *)(double (*)(double))nearbyint,
+	(void *)rename,
+	(void *)sinhf,
+	(void *)strcoll,
+	(void *)strspn,
+	(void *)tanhf,
+	(void *)vsprintf,
+	(void *)wcstombs,
+	(void *)__cxxabiv1::__cxa_bad_cast,
+	(void *)__cxxabiv1::__cxa_finalize,
+	(void *)__cxxabiv1::__cxa_guard_acquire,
+	(void *)__cxxabiv1::__cxa_guard_release,
+	(void *)__cxxabiv1::__cxa_guard_abort
+};
+
+class PSP2Plugin final : public Plugin {
+protected:
+	SceUID _modId;
+	const Common::Path _filename;
+
+public:
+	PSP2Plugin(const Common::Path &filename)
+		: _filename(filename), _modId(0) {}
+
+	bool loadPlugin() override {
+		assert(!_modId);
+		PSP2FunctionPointers *functions = nullptr;
+		PSP2FunctionPointers **arg = &functions;
+
+		int status = 0;
+		_modId = sceKernelLoadStartModule(_filename.toString(Common::Path::kNativeSeparator).c_str(), sizeof( arg ), &arg, 0, NULL, &status );
+
+		if (!_modId) {
+			debug("Failed loading plugin '%s' (error code %d)", _filename.toString(Common::Path::kNativeSeparator).c_str(), status);
+			return false;
+		} else {
+			debug(1, "Success loading plugin '%s', handle %08x", _filename.toString(Common::Path::kNativeSeparator).c_str(), _modId);
+		}
+
+		// Validate the Vita version
+		if (!functions) {
+			debug("Failed loading plugin '%s': no pointer", _filename.toString(Common::Path::kNativeSeparator).c_str());
+			unloadPlugin();
+			return false;
+		}
+		if (functions->version != PSP2FunctionPointers_VERSION) {
+			debug("Failed loading plugin '%s': unexpected version %d", _filename.toString(Common::Path::kNativeSeparator).c_str(), functions->version);
+			unloadPlugin();
+			return false;
+		}
+
+		// Validate the plugin API version
+		int32 version = functions->PLUGIN_getVersion();
+		if (version != PLUGIN_VERSION) {
+			warning("Plugin uses a different API version (you have: '%d', needed is: '%d')", version, PLUGIN_VERSION);
+			unloadPlugin();
+			return false;
+		}
+
+		// Get the type of the plugin
+		_type = (PluginType)functions->PLUGIN_getType();
+		if (_type >= PLUGIN_TYPE_MAX) {
+			warning("Plugin type unknown: %d", _type);
+			unloadPlugin();
+			return false;
+		}
+
+		// Validate the plugin type API version
+		int32 typeVersion = functions->PLUGIN_getTypeVersion();
+		if (typeVersion != pluginTypeVersions[_type]) {
+			warning("Plugin uses a different type API version (you have: '%d', needed is: '%d')", typeVersion, pluginTypeVersions[_type]);
+			unloadPlugin();
+			return false;
+		}
+
+		// Get the plugin object
+		_pluginObject = functions->PLUGIN_getObject();
+		if (!_pluginObject) {
+			warning("Couldn't get the plugin object");
+			unloadPlugin();
+			return false;
+		}
+
+		debug(1, "Successfully loaded plugin '%s'", _filename.toString(Common::Path::kNativeSeparator).c_str());
+		return true;
+	}
+
+	void unloadPlugin() override {
+		delete _pluginObject;
+
+		if (_modId) {
+			int status = 0;
+			int ret = sceKernelStopUnloadModule(_modId, 0, NULL, 0, NULL, &status);
+			if (ret != SCE_OK) {
+				debug("Failed unloading plugin '%s': %d/%d", _filename.toString(Common::Path::kNativeSeparator).c_str(), ret, status);
+			}
+			_modId = 0;
+		}
+	}
+
+	Common::Path getFileName() const override {
+		return _filename;
+	}
+};
+
+
+Plugin* PSP2PluginProvider::createPlugin(const Common::FSNode &node) const {
+	return new PSP2Plugin(node.getPath());
+}
+
+void PSP2PluginProvider::addCustomDirectories(Common::FSList &dirs) const {
+	dirs.push_back(Common::FSNode("app0:/plugins"));
+}
+
+#endif // defined(DYNAMIC_MODULES) && defined(PSP2)

backends/plugins/psp2/psp2-provider.h

@@ -0,0 +1,37 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef BACKENDS_PLUGINS_PSP2_PROVIDER_H
+#define BACKENDS_PLUGINS_PSP2_PROVIDER_H
+
+#include "base/plugins.h"
+
+#if defined(DYNAMIC_MODULES) && defined(PSP2)
+
+class PSP2PluginProvider final : public FilePluginProvider {
+protected:
+	Plugin* createPlugin(const Common::FSNode &node) const override;
+	void addCustomDirectories(Common::FSList &dirs) const;
+};
+
+#endif // defined(DYNAMIC_MODULES) && defined(PSP2)
+
+#endif